Create a super rough prototype of B3
[WebKit-https.git] / Source / JavaScriptCore / b3 / air / AirCCallSpecial.h
1 /*
2  * Copyright (C) 2015 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 AirCCallSpecial_h
27 #define AirCCallSpecial_h
28
29 #if ENABLE(B3_JIT)
30
31 #include "AirSpecial.h"
32
33 namespace JSC { namespace B3 { namespace Air {
34
35 // Use this special for constructing a C call. Arg 0 is of course a Special arg that refers to the
36 // CCallSpecial object. Arg 1 is the callee, and it can be an ImmPtr, a register, or an address. The
37 // remaining args are just the set of argument registers used by this call. For arguments that go to
38 // the stack, you have to do the grunt work of doing those stack stores. In fact, the only reason why
39 // we specify the argument registers as arguments to a call is so that the liveness analysis can see
40 // that they get used here. It would be wrong to automagically report all argument registers as being
41 // used because if we had a call that didn't pass them, then they'd appear to be live until some
42 // clobber point or the prologue, whichever happened sooner.
43
44 class CCallSpecial : public Special {
45 public:
46     CCallSpecial();
47     ~CCallSpecial();
48
49     // You cannot use this register to pass arguments. It just so happens that this register is not
50     // used for arguments in the C calling convention. By the way, this is the only thing that causes
51     // this special to be specific to C calls.
52     static const GPRReg scratchRegister = GPRInfo::nonArgGPR0;
53
54 protected:
55     void forEachArg(Inst&, const ScopedLambda<Inst::EachArgCallback>&) override;
56     bool isValid(Inst&) override;
57     bool admitsStack(Inst&, unsigned argIndex) override;
58     void reportUsedRegisters(Inst&, const RegisterSet&) override;
59     CCallHelpers::Jump generate(Inst&, CCallHelpers&, GenerationContext&) override;
60     const RegisterSet& extraClobberedRegs(Inst&) override;
61
62     void dumpImpl(PrintStream&) const override;
63     void deepDumpImpl(PrintStream&) const override;
64
65 private:
66     RegisterSet m_clobberedRegs;
67 };
68
69 } } } // namespace JSC::B3::Air
70
71 #endif // ENABLE(B3_JIT)
72
73 #endif // AirCCallSpecial_h
74