FTL lazy slow paths should work with B3
[WebKit-https.git] / Source / JavaScriptCore / jit / RegisterSet.h
1 /*
2  * Copyright (C) 2013-2015 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 RegisterSet_h
27 #define RegisterSet_h
28
29 #if ENABLE(JIT)
30
31 #include "FPRInfo.h"
32 #include "GPRInfo.h"
33 #include "MacroAssembler.h"
34 #include "Reg.h"
35 #include "TempRegisterSet.h"
36 #include <wtf/BitVector.h>
37
38 namespace JSC {
39
40 class RegisterSet {
41 public:
42     template<typename... Regs>
43     explicit RegisterSet(Regs... regs)
44     {
45         setMany(regs...);
46     }
47     
48     JS_EXPORT_PRIVATE static RegisterSet stackRegisters();
49     JS_EXPORT_PRIVATE static RegisterSet reservedHardwareRegisters();
50     static RegisterSet runtimeRegisters();
51     static RegisterSet specialRegisters(); // The union of stack, reserved hardware, and runtime registers.
52     static RegisterSet calleeSaveRegisters();
53     static RegisterSet vmCalleeSaveRegisters(); // Callee save registers that might be saved and used by any tier.
54     static RegisterSet llintBaselineCalleeSaveRegisters(); // Registers saved and used by the LLInt.
55     static RegisterSet dfgCalleeSaveRegisters(); // Registers saved and used by the DFG JIT.
56     static RegisterSet ftlCalleeSaveRegisters(); // Registers that might be saved and used by the FTL JIT.
57 #if ENABLE(WEBASSEMBLY)
58     static RegisterSet webAssemblyCalleeSaveRegisters(); // Registers saved and used by the WebAssembly JIT.
59 #endif
60     static RegisterSet volatileRegistersForJSCall();
61     static RegisterSet stubUnavailableRegisters(); // The union of callee saves and special registers.
62     static RegisterSet macroScratchRegisters();
63     JS_EXPORT_PRIVATE static RegisterSet allGPRs();
64     JS_EXPORT_PRIVATE static RegisterSet allFPRs();
65     static RegisterSet allRegisters();
66
67     static RegisterSet registersToNotSaveForJSCall();
68     static RegisterSet registersToNotSaveForCCall();
69     
70     void set(Reg reg, bool value = true)
71     {
72         ASSERT(!!reg);
73         m_vector.set(reg.index(), value);
74     }
75     
76     void set(JSValueRegs regs, bool value = true)
77     {
78         if (regs.tagGPR() != InvalidGPRReg)
79             set(regs.tagGPR(), value);
80         set(regs.payloadGPR(), value);
81     }
82     
83     void clear(Reg reg)
84     {
85         ASSERT(!!reg);
86         set(reg, false);
87     }
88     
89     bool get(Reg reg) const
90     {
91         ASSERT(!!reg);
92         return m_vector.get(reg.index());
93     }
94     
95     void merge(const RegisterSet& other) { m_vector.merge(other.m_vector); }
96     void filter(const RegisterSet& other) { m_vector.filter(other.m_vector); }
97     void exclude(const RegisterSet& other) { m_vector.exclude(other.m_vector); }
98     
99     size_t numberOfSetGPRs() const;
100     size_t numberOfSetFPRs() const;
101     size_t numberOfSetRegisters() const { return m_vector.bitCount(); }
102     
103     void dump(PrintStream&) const;
104     
105     enum EmptyValueTag { EmptyValue };
106     enum DeletedValueTag { DeletedValue };
107     
108     RegisterSet(EmptyValueTag)
109         : m_vector(BitVector::EmptyValue)
110     {
111     }
112     
113     RegisterSet(DeletedValueTag)
114         : m_vector(BitVector::DeletedValue)
115     {
116     }
117     
118     bool isEmptyValue() const { return m_vector.isEmptyValue(); }
119     bool isDeletedValue() const { return m_vector.isDeletedValue(); }
120     
121     bool operator==(const RegisterSet& other) const { return m_vector == other.m_vector; }
122     unsigned hash() const { return m_vector.hash(); }
123
124     template<typename Functor>
125     void forEach(const Functor& functor) const
126     {
127         for (size_t index : m_vector.setBits())
128             functor(Reg::fromIndex(index));
129     }
130     
131 private:
132     void setAny(Reg reg) { set(reg); }
133     void setAny(const RegisterSet& set) { merge(set); }
134     void setMany() { }
135     template<typename RegType, typename... Regs>
136     void setMany(RegType reg, Regs... regs)
137     {
138         setAny(reg);
139         setMany(regs...);
140     }
141
142     BitVector m_vector;
143 };
144
145 struct RegisterSetHash {
146     static unsigned hash(const RegisterSet& set) { return set.hash(); }
147     static bool equal(const RegisterSet& a, const RegisterSet& b) { return a == b; }
148     static const bool safeToCompareToEmptyOrDeleted = false;
149 };
150
151 } // namespace JSC
152
153 namespace WTF {
154
155 template<typename T> struct DefaultHash;
156 template<> struct DefaultHash<JSC::RegisterSet> {
157     typedef JSC::RegisterSetHash Hash;
158 };
159
160 template<typename T> struct HashTraits;
161 template<> struct HashTraits<JSC::RegisterSet> : public CustomHashTraits<JSC::RegisterSet> { };
162
163 } // namespace WTF
164
165 #endif // ENABLE(JIT)
166
167 #endif // RegisterSet_h
168