We should be able to inline getter/setter calls inside an inline cache even when...
[WebKit-https.git] / Source / JavaScriptCore / jit / ScratchRegisterAllocator.h
1 /*
2  * Copyright (C) 2012, 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 ScratchRegisterAllocator_h
27 #define ScratchRegisterAllocator_h
28
29 #if ENABLE(JIT)
30
31 #include "MacroAssembler.h"
32 #include "RegisterSet.h"
33 #include "TempRegisterSet.h"
34
35 namespace JSC {
36
37 struct ScratchBuffer;
38
39 // This class provides a low-level register allocator for use in stubs.
40
41 class ScratchRegisterAllocator {
42 public:
43     ScratchRegisterAllocator() { }
44     ScratchRegisterAllocator(const RegisterSet& usedRegisters);
45     ~ScratchRegisterAllocator();
46
47     void lock(GPRReg);
48     void lock(FPRReg);
49     void lock(JSValueRegs);
50     
51     template<typename BankInfo>
52     typename BankInfo::RegisterType allocateScratch();
53     
54     GPRReg allocateScratchGPR();
55     FPRReg allocateScratchFPR();
56     
57     bool didReuseRegisters() const
58     {
59         return !!m_numberOfReusedRegisters;
60     }
61     
62     unsigned numberOfReusedRegisters() const
63     {
64         return m_numberOfReusedRegisters;
65     }
66
67     RegisterSet usedRegisters() const { return m_usedRegisters; }
68     
69     // preserveReusedRegistersByPushing() returns the number of padding bytes used to keep the stack
70     // pointer properly aligned and to reserve room for calling a C helper. This number of padding
71     // bytes must be provided to restoreReusedRegistersByPopping() in order to reverse the work done
72     // by preserveReusedRegistersByPushing().
73     unsigned preserveReusedRegistersByPushing(MacroAssembler& jit);
74     void restoreReusedRegistersByPopping(MacroAssembler& jit, unsigned numberOfBytesUsedToPreserveReusedRegisters);
75     
76     RegisterSet usedRegistersForCall() const;
77     
78     unsigned desiredScratchBufferSizeForCall() const;
79     
80     void preserveUsedRegistersToScratchBufferForCall(MacroAssembler& jit, ScratchBuffer* scratchBuffer, GPRReg scratchGPR = InvalidGPRReg);
81     void restoreUsedRegistersFromScratchBufferForCall(MacroAssembler& jit, ScratchBuffer* scratchBuffer, GPRReg scratchGPR = InvalidGPRReg);
82
83     static unsigned preserveRegistersToStackForCall(MacroAssembler& jit, const RegisterSet& usedRegisters, unsigned extraPaddingInBytes);
84     static void restoreRegistersFromStackForCall(MacroAssembler& jit, const RegisterSet& usedRegisters, const RegisterSet& ignore, unsigned numberOfStackBytesUsedForRegisterPreservation, unsigned extraPaddingInBytes);
85
86 private:
87     RegisterSet m_usedRegisters;
88     TempRegisterSet m_lockedRegisters;
89     TempRegisterSet m_scratchRegisters;
90     unsigned m_numberOfReusedRegisters;
91 };
92
93 } // namespace JSC
94
95 #endif // ENABLE(JIT)
96
97 #endif // ScratchRegisterAllocator_h