DFG::LazyJSValue::tryGetStringImpl() crashes for empty values
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGFrozenValue.h
1 /*
2  * Copyright (C) 2014-2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DFGFrozenValue_h
27 #define DFGFrozenValue_h
28
29 #if ENABLE(DFG_JIT)
30
31 #include "DFGValueStrength.h"
32 #include "JSCell.h"
33 #include "JSCJSValue.h"
34 #include "Structure.h"
35
36 namespace JSC { namespace DFG {
37
38 class Graph;
39
40 class FrozenValue {
41 public:
42     FrozenValue()
43         : m_structure(nullptr)
44         , m_strength(WeakValue)
45     {
46     }
47     
48     FrozenValue(JSValue value)
49         : m_value(value)
50         , m_structure(nullptr)
51         , m_strength(WeakValue)
52     {
53         RELEASE_ASSERT(!value || !value.isCell());
54     }
55     
56     FrozenValue(JSValue value, Structure* structure, ValueStrength strength)
57         : m_value(value)
58         , m_structure(structure)
59         , m_strength(strength)
60     {
61         ASSERT((!!value && value.isCell()) == !!structure);
62         ASSERT(!value || !value.isCell() || value.asCell()->classInfo() == structure->classInfo());
63         ASSERT(!!structure || (strength == WeakValue));
64     }
65     
66     static FrozenValue* emptySingleton();
67     
68     bool operator!() const { return !m_value; }
69     
70     JSValue value() const { return m_value; }
71     JSCell* cell() const { return m_value.asCell(); }
72     
73     template<typename T>
74     T dynamicCast()
75     {
76         JSValue theValue = value();
77         if (!theValue)
78             return nullptr;
79         return jsDynamicCast<T>(theValue);
80     }
81     template<typename T>
82     T cast()
83     {
84         return jsCast<T>(value());
85     }
86     
87     Structure* structure() const { return m_structure; }
88     
89     void strengthenTo(ValueStrength strength)
90     {
91         if (!!m_value && m_value.isCell())
92             m_strength = merge(m_strength, strength);
93     }
94     
95     bool pointsToHeap() const { return !!value() && value().isCell(); }
96     
97     // The strength of the value itself. The structure is almost always weak.
98     ValueStrength strength() const { return m_strength; }
99
100     String tryGetString(Graph&);
101     
102     void dumpInContext(PrintStream& out, DumpContext* context) const;
103     void dump(PrintStream& out) const;
104     
105 private:
106     friend class Graph;
107     
108     // This is a utility method for DFG::Graph::freeze(). You should almost always call
109     // Graph::freeze() directly. Calling this instead of Graph::freeze() can result in
110     // the same constant being viewed as having different structures during the course
111     // of compilation, which can sometimes cause bad things to happen. For example, we
112     // may observe that one version of the constant has an unwatchable structure but
113     // then a later version may start to have a watchable structure due to a transition.
114     // The point of freezing is to ensure that we generally only see one version of
115     // constants, but that requires freezing through the Graph.
116     static FrozenValue freeze(JSValue value)
117     {
118         return FrozenValue(
119             value,
120             (!!value && value.isCell()) ? value.asCell()->structure() : nullptr,
121             WeakValue);
122     }
123
124     JSValue m_value;
125     Structure* m_structure;
126     ValueStrength m_strength;
127 };
128
129 } } // namespace JSC::DFG
130
131 #endif // ENABLE(DFG_JIT)
132
133 #endif // DFGFrozenValue_h
134