Save and restore callee save registers in WebAssembly
[WebKit-https.git] / Source / JavaScriptCore / jit / RegisterSet.h
1 /*
2  * Copyright (C) 2013, 2014 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     static RegisterSet stackRegisters();
49     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 stubUnavailableRegisters(); // The union of callee saves and special registers.
61     static RegisterSet allGPRs();
62     static RegisterSet allFPRs();
63     static RegisterSet allRegisters();
64     
65     void set(Reg reg, bool value = true)
66     {
67         ASSERT(!!reg);
68         m_vector.set(reg.index(), value);
69     }
70     
71     void set(JSValueRegs regs)
72     {
73         if (regs.tagGPR() != InvalidGPRReg)
74             set(regs.tagGPR());
75         set(regs.payloadGPR());
76     }
77     
78     void clear(Reg reg)
79     {
80         ASSERT(!!reg);
81         set(reg, false);
82     }
83     
84     bool get(Reg reg) const
85     {
86         ASSERT(!!reg);
87         return m_vector.get(reg.index());
88     }
89     
90     void merge(const RegisterSet& other) { m_vector.merge(other.m_vector); }
91     void filter(const RegisterSet& other) { m_vector.filter(other.m_vector); }
92     void exclude(const RegisterSet& other) { m_vector.exclude(other.m_vector); }
93     
94     size_t numberOfSetGPRs() const;
95     size_t numberOfSetFPRs() const;
96     size_t numberOfSetRegisters() const { return m_vector.bitCount(); }
97     
98     void dump(PrintStream&) const;
99     
100     enum EmptyValueTag { EmptyValue };
101     enum DeletedValueTag { DeletedValue };
102     
103     RegisterSet(EmptyValueTag)
104         : m_vector(BitVector::EmptyValue)
105     {
106     }
107     
108     RegisterSet(DeletedValueTag)
109         : m_vector(BitVector::DeletedValue)
110     {
111     }
112     
113     bool isEmptyValue() const { return m_vector.isEmptyValue(); }
114     bool isDeletedValue() const { return m_vector.isDeletedValue(); }
115     
116     bool operator==(const RegisterSet& other) const { return m_vector == other.m_vector; }
117     unsigned hash() const { return m_vector.hash(); }
118     
119 private:
120     void setAny(Reg reg) { set(reg); }
121     void setAny(const RegisterSet& set) { merge(set); }
122     void setMany() { }
123     template<typename RegType, typename... Regs>
124     void setMany(RegType reg, Regs... regs)
125     {
126         setAny(reg);
127         setMany(regs...);
128     }
129
130     BitVector m_vector;
131 };
132
133 struct RegisterSetHash {
134     static unsigned hash(const RegisterSet& set) { return set.hash(); }
135     static bool equal(const RegisterSet& a, const RegisterSet& b) { return a == b; }
136     static const bool safeToCompareToEmptyOrDeleted = false;
137 };
138
139 } // namespace JSC
140
141 namespace WTF {
142
143 template<typename T> struct DefaultHash;
144 template<> struct DefaultHash<JSC::RegisterSet> {
145     typedef JSC::RegisterSetHash Hash;
146 };
147
148 template<typename T> struct HashTraits;
149 template<> struct HashTraits<JSC::RegisterSet> : public CustomHashTraits<JSC::RegisterSet> { };
150
151 } // namespace WTF
152
153 #endif // ENABLE(JIT)
154
155 #endif // RegisterSet_h
156