B3 patchpoints should allow specifying output constraints
[WebKit-https.git] / Source / JavaScriptCore / b3 / B3StackmapSpecial.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 B3StackmapSpecial_h
27 #define B3StackmapSpecial_h
28
29 #if ENABLE(B3_JIT)
30
31 #include "AirArg.h"
32 #include "AirSpecial.h"
33 #include "B3ValueRep.h"
34
35 namespace JSC { namespace B3 {
36
37 namespace Air { class Code; }
38
39 // This is a base class for specials that have stackmaps. Note that it can find the Stackmap by
40 // asking for the Inst's origin. Hence, these objects don't need to even hold a reference to the
41 // Stackmap.
42
43 class StackmapSpecial : public Air::Special {
44 public:
45     StackmapSpecial();
46     virtual ~StackmapSpecial();
47
48 protected:
49     void reportUsedRegisters(Air::Inst&, const RegisterSet&) override;
50     const RegisterSet& extraEarlyClobberedRegs(Air::Inst&) override;
51     const RegisterSet& extraClobberedRegs(Air::Inst&) override;
52
53     // Note that this does not override generate() or dumpImpl()/deepDumpImpl(). We have many some
54     // subclasses that implement that.
55
56     void forEachArgImpl(
57         unsigned numIgnoredB3Args, unsigned numIgnoredAirArgs,
58         Air::Inst&, Air::Arg::Role role, const ScopedLambda<Air::Inst::EachArgCallback>&);
59     bool isValidImpl(
60         unsigned numIgnoredB3Args, unsigned numIgnoredAirArgs,
61         Air::Inst&);
62     bool admitsStackImpl(
63         unsigned numIgnoredB3Args, unsigned numIgnoredAirArgs,
64         Air::Inst&, unsigned argIndex);
65
66     // Appends the reps for the Inst's args, starting with numIgnoredArgs, to the given vector.
67     void appendRepsImpl(Air::GenerationContext&, unsigned numIgnoredArgs, Air::Inst&, Vector<ValueRep>&);
68
69     static bool isArgValidForValue(const Air::Arg&, Value*);
70     static bool isArgValidForRep(Air::Code&, const Air::Arg&, const ValueRep&);
71     static ValueRep repForArg(Air::Code&, const Air::Arg&);
72 };
73
74 } } // namespace JSC::B3
75
76 #endif // ENABLE(B3_JIT)
77
78 #endif // B3StackmapSpecial_h
79