RegisterSet should use a Bitmap instead of a BitVector so that it never allocates...
[WebKit-https.git] / Source / JavaScriptCore / jit / RegisterSet.h
1 /*
2  * Copyright (C) 2013-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 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/Bitmap.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     JS_EXPORT_PRIVATE static RegisterSet macroScratchRegisters();
63     JS_EXPORT_PRIVATE static RegisterSet allGPRs();
64     JS_EXPORT_PRIVATE static RegisterSet allFPRs();
65     static RegisterSet allRegisters();
66     static RegisterSet argumentGPRS();
67
68     static RegisterSet registersToNotSaveForJSCall();
69     static RegisterSet registersToNotSaveForCCall();
70     
71     void set(Reg reg, bool value = true)
72     {
73         ASSERT(!!reg);
74         m_bits.set(reg.index(), value);
75     }
76     
77     void set(JSValueRegs regs, bool value = true)
78     {
79         if (regs.tagGPR() != InvalidGPRReg)
80             set(regs.tagGPR(), value);
81         set(regs.payloadGPR(), value);
82     }
83     
84     void clear(Reg reg)
85     {
86         ASSERT(!!reg);
87         set(reg, false);
88     }
89     
90     bool get(Reg reg) const
91     {
92         ASSERT(!!reg);
93         return m_bits.get(reg.index());
94     }
95     
96     template<typename Iterable>
97     void setAll(const Iterable& iterable)
98     {
99         for (Reg reg : iterable)
100             set(reg);
101     }
102     
103     void merge(const RegisterSet& other) { m_bits.merge(other.m_bits); }
104     void filter(const RegisterSet& other) { m_bits.filter(other.m_bits); }
105     void exclude(const RegisterSet& other) { m_bits.exclude(other.m_bits); }
106     
107     size_t numberOfSetGPRs() const;
108     size_t numberOfSetFPRs() const;
109     size_t numberOfSetRegisters() const { return m_bits.count(); }
110     
111     void dump(PrintStream&) const;
112     
113     enum EmptyValueTag { EmptyValue };
114     enum DeletedValueTag { DeletedValue };
115     
116     RegisterSet(EmptyValueTag)
117     {
118         m_bits.set(hashSpecialBitIndex);
119     }
120     
121     RegisterSet(DeletedValueTag)
122     {
123         m_bits.set(hashSpecialBitIndex);
124         m_bits.set(deletedBitIndex);
125     }
126     
127     bool isEmptyValue() const
128     {
129         return m_bits.get(hashSpecialBitIndex) && !m_bits.get(deletedBitIndex);
130     }
131     
132     bool isDeletedValue() const
133     {
134         return m_bits.get(hashSpecialBitIndex) && m_bits.get(deletedBitIndex);
135     }
136     
137     bool operator==(const RegisterSet& other) const { return m_bits == other.m_bits; }
138     bool operator!=(const RegisterSet& other) const { return m_bits != other.m_bits; }
139     
140     unsigned hash() const { return m_bits.hash(); }
141     
142     template<typename Func>
143     void forEach(const Func& func) const
144     {
145         m_bits.forEachSetBit(
146             [&] (size_t index) {
147                 func(Reg::fromIndex(index));
148             });
149     }
150     
151 private:
152     void setAny(Reg reg) { set(reg); }
153     void setAny(const RegisterSet& set) { merge(set); }
154     void setMany() { }
155     template<typename RegType, typename... Regs>
156     void setMany(RegType reg, Regs... regs)
157     {
158         setAny(reg);
159         setMany(regs...);
160     }
161
162     // These offsets mirror the logic in Reg.h.
163     static const unsigned gprOffset = 0;
164     static const unsigned fprOffset = gprOffset + MacroAssembler::numGPRs;
165     static const unsigned hashSpecialBitIndex = fprOffset + MacroAssembler::numFPRs;
166     static const unsigned deletedBitIndex = 0;
167     
168     Bitmap<MacroAssembler::numGPRs + MacroAssembler::numFPRs + 1> m_bits;
169 };
170
171 struct RegisterSetHash {
172     static unsigned hash(const RegisterSet& set) { return set.hash(); }
173     static bool equal(const RegisterSet& a, const RegisterSet& b) { return a == b; }
174     static const bool safeToCompareToEmptyOrDeleted = false;
175 };
176
177 } // namespace JSC
178
179 namespace WTF {
180
181 template<typename T> struct DefaultHash;
182 template<> struct DefaultHash<JSC::RegisterSet> {
183     typedef JSC::RegisterSetHash Hash;
184 };
185
186 template<typename T> struct HashTraits;
187 template<> struct HashTraits<JSC::RegisterSet> : public CustomHashTraits<JSC::RegisterSet> { };
188
189 } // namespace WTF
190
191 #endif // ENABLE(JIT)
192
193 #endif // RegisterSet_h
194