We should support CreateThis in the FTL
[WebKit-https.git] / Source / JavaScriptCore / dfg / DFGCommonData.h
1 /*
2  * Copyright (C) 2013-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 #if ENABLE(DFG_JIT)
29
30 #include "CodeBlockJettisoningWatchpoint.h"
31 #include "DFGAdaptiveInferredPropertyValueWatchpoint.h"
32 #include "DFGAdaptiveStructureWatchpoint.h"
33 #include "DFGJumpReplacement.h"
34 #include "DFGOSREntry.h"
35 #include "InlineCallFrameSet.h"
36 #include "JSCast.h"
37 #include "ProfilerCompilation.h"
38 #include "RecordedStatuses.h"
39 #include <wtf/Bag.h>
40 #include <wtf/Noncopyable.h>
41
42 namespace JSC {
43
44 class CodeBlock;
45 class Identifier;
46 class TrackedReferences;
47
48 namespace DFG {
49
50 struct Node;
51 struct Plan;
52
53 // CommonData holds the set of data that both DFG and FTL code blocks need to know
54 // about themselves.
55
56 struct WeakReferenceTransition {
57     WeakReferenceTransition() { }
58     
59     WeakReferenceTransition(VM& vm, JSCell* owner, JSCell* codeOrigin, JSCell* from, JSCell* to)
60         : m_from(vm, owner, from)
61         , m_to(vm, owner, to)
62     {
63         if (!!codeOrigin)
64             m_codeOrigin.set(vm, owner, codeOrigin);
65     }
66     
67     WriteBarrier<JSCell> m_codeOrigin;
68     WriteBarrier<JSCell> m_from;
69     WriteBarrier<JSCell> m_to;
70 };
71         
72 class CommonData {
73     WTF_MAKE_NONCOPYABLE(CommonData);
74 public:
75     CommonData()
76         : isStillValid(true)
77         , frameRegisterCount(std::numeric_limits<unsigned>::max())
78         , requiredRegisterCountForExit(std::numeric_limits<unsigned>::max())
79     { }
80     ~CommonData();
81     
82     void notifyCompilingStructureTransition(Plan&, CodeBlock*, Node*);
83     CallSiteIndex addCodeOrigin(CodeOrigin);
84     CallSiteIndex addUniqueCallSiteIndex(CodeOrigin);
85     CallSiteIndex lastCallSite() const;
86     void removeCallSiteIndex(CallSiteIndex);
87     
88     void shrinkToFit();
89     
90     bool invalidate(); // Returns true if we did invalidate, or false if the code block was already invalidated.
91     bool hasInstalledVMTrapsBreakpoints() const { return isStillValid && hasVMTrapsBreakpointsInstalled; }
92     void installVMTrapBreakpoints(CodeBlock* owner);
93     bool isVMTrapBreakpoint(void* address);
94
95     CatchEntrypointData* catchOSREntryDataForBytecodeIndex(unsigned bytecodeIndex)
96     {
97         return tryBinarySearch<CatchEntrypointData, unsigned>(
98             catchEntrypoints, catchEntrypoints.size(), bytecodeIndex,
99             [] (const CatchEntrypointData* item) { return item->bytecodeIndex; });
100     }
101
102     void appendCatchEntrypoint(unsigned bytecodeIndex, MacroAssemblerCodePtr<ExceptionHandlerPtrTag> machineCode, Vector<FlushFormat>&& argumentFormats)
103     {
104         catchEntrypoints.append(CatchEntrypointData { machineCode,  WTFMove(argumentFormats), bytecodeIndex });
105     }
106
107     void finalizeCatchEntrypoints();
108
109     unsigned requiredRegisterCountForExecutionAndExit() const
110     {
111         return std::max(frameRegisterCount, requiredRegisterCountForExit);
112     }
113     
114     void validateReferences(const TrackedReferences&);
115
116     static ptrdiff_t frameRegisterCountOffset() { return OBJECT_OFFSETOF(CommonData, frameRegisterCount); }
117
118     RefPtr<InlineCallFrameSet> inlineCallFrames;
119     Vector<CodeOrigin, 0, UnsafeVectorOverflow> codeOrigins;
120     
121     Vector<Identifier> dfgIdentifiers;
122     Vector<WeakReferenceTransition> transitions;
123     Vector<WriteBarrier<JSCell>> weakReferences;
124     Vector<WriteBarrier<Structure>> weakStructureReferences;
125     Vector<CatchEntrypointData> catchEntrypoints;
126     Bag<CodeBlockJettisoningWatchpoint> watchpoints;
127     Bag<AdaptiveStructureWatchpoint> adaptiveStructureWatchpoints;
128     Bag<AdaptiveInferredPropertyValueWatchpoint> adaptiveInferredPropertyValueWatchpoints;
129     RecordedStatuses recordedStatuses;
130     Vector<JumpReplacement> jumpReplacements;
131     
132     ScratchBuffer* catchOSREntryBuffer;
133     RefPtr<Profiler::Compilation> compilation;
134     bool livenessHasBeenProved; // Initialized and used on every GC.
135     bool allTransitionsHaveBeenMarked; // Initialized and used on every GC.
136     bool isStillValid;
137     bool hasVMTrapsBreakpointsInstalled { false };
138     
139 #if USE(JSVALUE32_64)
140     std::unique_ptr<Bag<double>> doubleConstants;
141 #endif
142     
143     unsigned frameRegisterCount;
144     unsigned requiredRegisterCountForExit;
145
146 private:
147     HashSet<unsigned, WTF::IntHash<unsigned>, WTF::UnsignedWithZeroKeyHashTraits<unsigned>> callSiteIndexFreeList;
148
149 };
150
151 CodeBlock* codeBlockForVMTrapPC(void* pc);
152
153 } } // namespace JSC::DFG
154
155 #endif // ENABLE(DFG_JIT)