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