Unreviewed, rolling out r223866.
[WebKit-https.git] / Source / JavaScriptCore / jit / RegisterSet.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(JIT)
29
30 #include "GPRInfo.h"
31 #include "MacroAssembler.h"
32 #include "Reg.h"
33 #include "TempRegisterSet.h"
34 #include <wtf/Bitmap.h>
35
36 namespace JSC {
37
38 typedef Bitmap<MacroAssembler::numGPRs + MacroAssembler::numFPRs + 1> RegisterBitmap;
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     JS_EXPORT_PRIVATE 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     JS_EXPORT_PRIVATE 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     // Also allow add/remove/contains terminology, which means the same thing as set/clear/get.
104     bool add(Reg reg)
105     {
106         ASSERT(!!reg);
107         return !m_bits.testAndSet(reg.index());
108     }
109     bool remove(Reg reg)
110     {
111         ASSERT(!!reg);
112         return m_bits.testAndClear(reg.index());
113     }
114     bool contains(Reg reg) const { return get(reg); }
115     
116     void merge(const RegisterSet& other) { m_bits.merge(other.m_bits); }
117     void filter(const RegisterSet& other) { m_bits.filter(other.m_bits); }
118     void exclude(const RegisterSet& other) { m_bits.exclude(other.m_bits); }
119     
120     bool subsumes(const RegisterSet& other) const { return m_bits.subsumes(other.m_bits); }
121     
122     size_t numberOfSetGPRs() const;
123     size_t numberOfSetFPRs() const;
124     size_t numberOfSetRegisters() const { return m_bits.count(); }
125     
126     bool isEmpty() const { return m_bits.isEmpty(); }
127     
128     JS_EXPORT_PRIVATE void dump(PrintStream&) const;
129     
130     enum EmptyValueTag { EmptyValue };
131     enum DeletedValueTag { DeletedValue };
132     
133     RegisterSet(EmptyValueTag)
134     {
135         m_bits.set(hashSpecialBitIndex);
136     }
137     
138     RegisterSet(DeletedValueTag)
139     {
140         m_bits.set(hashSpecialBitIndex);
141         m_bits.set(deletedBitIndex);
142     }
143     
144     bool isEmptyValue() const
145     {
146         return m_bits.get(hashSpecialBitIndex) && !m_bits.get(deletedBitIndex);
147     }
148     
149     bool isDeletedValue() const
150     {
151         return m_bits.get(hashSpecialBitIndex) && m_bits.get(deletedBitIndex);
152     }
153     
154     bool operator==(const RegisterSet& other) const { return m_bits == other.m_bits; }
155     bool operator!=(const RegisterSet& other) const { return m_bits != other.m_bits; }
156     
157     unsigned hash() const { return m_bits.hash(); }
158     
159     template<typename Func>
160     void forEach(const Func& func) const
161     {
162         m_bits.forEachSetBit(
163             [&] (size_t index) {
164                 func(Reg::fromIndex(index));
165             });
166     }
167     
168     class iterator {
169     public:
170         iterator()
171         {
172         }
173         
174         iterator(const RegisterBitmap::iterator& iter)
175             : m_iter(iter)
176         {
177         }
178         
179         Reg operator*() const { return Reg::fromIndex(*m_iter); }
180         
181         iterator& operator++()
182         {
183             ++m_iter;
184             return *this;
185         }
186         
187         bool operator==(const iterator& other)
188         {
189             return m_iter == other.m_iter;
190         }
191         
192         bool operator!=(const iterator& other)
193         {
194             return !(*this == other);
195         }
196         
197     private:
198         RegisterBitmap::iterator m_iter;
199     };
200     
201     iterator begin() const { return iterator(m_bits.begin()); }
202     iterator end() const { return iterator(m_bits.end()); }
203     
204 private:
205     void setAny(Reg reg) { set(reg); }
206     void setAny(const RegisterSet& set) { merge(set); }
207     void setMany() { }
208     template<typename RegType, typename... Regs>
209     void setMany(RegType reg, Regs... regs)
210     {
211         setAny(reg);
212         setMany(regs...);
213     }
214
215     // These offsets mirror the logic in Reg.h.
216     static const unsigned gprOffset = 0;
217     static const unsigned fprOffset = gprOffset + MacroAssembler::numGPRs;
218     static const unsigned hashSpecialBitIndex = fprOffset + MacroAssembler::numFPRs;
219     static const unsigned deletedBitIndex = 0;
220     
221     RegisterBitmap m_bits;
222 };
223
224 struct RegisterSetHash {
225     static unsigned hash(const RegisterSet& set) { return set.hash(); }
226     static bool equal(const RegisterSet& a, const RegisterSet& b) { return a == b; }
227     static const bool safeToCompareToEmptyOrDeleted = false;
228 };
229
230 } // namespace JSC
231
232 namespace WTF {
233
234 template<typename T> struct DefaultHash;
235 template<> struct DefaultHash<JSC::RegisterSet> {
236     typedef JSC::RegisterSetHash Hash;
237 };
238
239 template<typename T> struct HashTraits;
240 template<> struct HashTraits<JSC::RegisterSet> : public CustomHashTraits<JSC::RegisterSet> { };
241
242 } // namespace WTF
243
244 #endif // ENABLE(JIT)