1d662c9decfbcec06437b5c9a3ad76527c5d6f5d
[WebKit-https.git] / Source / JavaScriptCore / bytecode / GetByIdStatus.h
1 /*
2  * Copyright (C) 2012-2018 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 #pragma once
27
28 #include "CallLinkStatus.h"
29 #include "CodeOrigin.h"
30 #include "ConcurrentJSLock.h"
31 #include "GetByIdVariant.h"
32 #include "ScopeOffset.h"
33
34 namespace JSC {
35
36 class AccessCase;
37 class CodeBlock;
38 class JSModuleEnvironment;
39 class JSModuleNamespaceObject;
40 class ModuleNamespaceAccessCase;
41 class StructureStubInfo;
42
43 typedef HashMap<CodeOrigin, StructureStubInfo*, CodeOriginApproximateHash> StubInfoMap;
44
45 class GetByIdStatus {
46 public:
47     enum State {
48         // It's uncached so we have no information.
49         NoInformation,
50         // It's cached for a simple access to a known object property with
51         // a possible structure chain and a possible specific value.
52         Simple,
53         // It's cached for a custom accessor with a possible structure chain.
54         Custom,
55         // It's cached for an access to a module namespace object's binding.
56         ModuleNamespace,
57         // It's known to often take slow path.
58         TakesSlowPath,
59         // It's known to take paths that make calls.
60         MakesCalls,
61     };
62
63     GetByIdStatus()
64         : m_state(NoInformation)
65     {
66     }
67     
68     explicit GetByIdStatus(State state)
69         : m_state(state)
70     {
71         ASSERT(state == NoInformation || state == TakesSlowPath || state == MakesCalls);
72     }
73
74     
75     GetByIdStatus(
76         State state, bool wasSeenInJIT, const GetByIdVariant& variant = GetByIdVariant())
77         : m_state(state)
78         , m_wasSeenInJIT(wasSeenInJIT)
79     {
80         ASSERT((state == Simple || state == Custom) == variant.isSet());
81         m_variants.append(variant);
82     }
83     
84     static GetByIdStatus computeFor(CodeBlock*, StubInfoMap&, unsigned bytecodeIndex, UniquedStringImpl* uid);
85     static GetByIdStatus computeFor(const StructureSet&, UniquedStringImpl* uid);
86     
87     static GetByIdStatus computeFor(CodeBlock* baselineBlock, CodeBlock* dfgBlock, StubInfoMap& baselineMap, StubInfoMap& dfgMap, CodeOrigin, UniquedStringImpl* uid);
88
89 #if ENABLE(DFG_JIT)
90     static GetByIdStatus computeForStubInfo(const ConcurrentJSLocker&, CodeBlock* baselineBlock, StructureStubInfo*, CodeOrigin, UniquedStringImpl* uid);
91 #endif
92
93     State state() const { return m_state; }
94     
95     bool isSet() const { return m_state != NoInformation; }
96     bool operator!() const { return !isSet(); }
97     bool isSimple() const { return m_state == Simple; }
98     bool isCustom() const { return m_state == Custom; }
99     bool isModuleNamespace() const { return m_state == ModuleNamespace; }
100
101     size_t numVariants() const { return m_variants.size(); }
102     const Vector<GetByIdVariant, 1>& variants() const { return m_variants; }
103     const GetByIdVariant& at(size_t index) const { return m_variants[index]; }
104     const GetByIdVariant& operator[](size_t index) const { return at(index); }
105
106     bool takesSlowPath() const { return m_state == TakesSlowPath || m_state == MakesCalls || m_state == Custom || m_state == ModuleNamespace; }
107     bool makesCalls() const;
108     
109     bool wasSeenInJIT() const { return m_wasSeenInJIT; }
110     
111     // Attempts to reduce the set of variants to fit the given structure set. This may be approximate.
112     void filter(const StructureSet&);
113
114     JSModuleNamespaceObject* moduleNamespaceObject() const { return m_moduleNamespaceObject; }
115     JSModuleEnvironment* moduleEnvironment() const { return m_moduleEnvironment; }
116     ScopeOffset scopeOffset() const { return m_scopeOffset; }
117     
118     void dump(PrintStream&) const;
119     
120 private:
121 #if ENABLE(DFG_JIT)
122     static bool hasExitSite(CodeBlock*, unsigned bytecodeIndex);
123 #endif
124 #if ENABLE(JIT)
125     GetByIdStatus(const ModuleNamespaceAccessCase&);
126     static GetByIdStatus computeForStubInfoWithoutExitSiteFeedback(
127         const ConcurrentJSLocker&, CodeBlock* profiledBlock, StructureStubInfo*,
128         UniquedStringImpl* uid, CallLinkStatus::ExitSiteData);
129 #endif
130     static GetByIdStatus computeFromLLInt(CodeBlock*, unsigned bytecodeIndex, UniquedStringImpl* uid);
131     
132     bool appendVariant(const GetByIdVariant&);
133     
134     State m_state;
135     Vector<GetByIdVariant, 1> m_variants;
136     bool m_wasSeenInJIT;
137     JSModuleNamespaceObject* m_moduleNamespaceObject { nullptr };
138     JSModuleEnvironment* m_moduleEnvironment { nullptr };
139     ScopeOffset m_scopeOffset { };
140 };
141
142 } // namespace JSC