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