Create a super rough prototype of B3
[WebKit-https.git] / Source / JavaScriptCore / b3 / B3Stackmap.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 B3Stackmap_h
27 #define B3Stackmap_h
28
29 #if ENABLE(B3_JIT)
30
31 #include "B3ValueRep.h"
32 #include "CCallHelpers.h"
33 #include "RegisterSet.h"
34 #include <wtf/SharedTask.h>
35
36 namespace JSC { namespace B3 {
37
38 class CheckSpecial;
39 class StackmapSpecial;
40 class Value;
41
42 class Stackmap {
43 public:
44     struct GenerationParams {
45         // This is the Value containing the stackmap.
46         Value* value;
47
48         // This is the stackmap.
49         Stackmap* stackmap;
50
51         // This tells you the actual value representations that were chosen.
52         Vector<ValueRep> reps;
53
54         // This tells you the registers that were used.
55         RegisterSet usedRegisters;
56     };
57     
58     typedef void GeneratorFunction(CCallHelpers&, const GenerationParams&);
59     typedef SharedTask<GeneratorFunction> Generator;
60     
61     Stackmap();
62     ~Stackmap();
63
64     // Constrain an argument to the Value that uses this Stackmap. In case of a Patchpoint that
65     // returns a value, the first argument is the result value. In all other cases, index zero refers
66     // to the first argument to that Value, even if that argument is not constrainable. For example,
67     // in a CheckAdd value, it would be an error to constrain indices 0 and 1. In a Check value, it
68     // would be an error to constrain index 0. But, when the generation callback is called, you can
69     // depend on the reps for those indices being filled in.
70     void constrain(unsigned index, const ValueRep& rep)
71     {
72         if (index + 1 >= m_reps.size())
73             m_reps.grow(index + 1);
74         m_reps[index] = rep;
75     }
76
77     const Vector<ValueRep>& reps() const { return m_reps; }
78
79     void clobber(const RegisterSet& set)
80     {
81         m_clobbered.merge(set);
82     }
83
84     const RegisterSet& clobbered() const { return m_clobbered; }
85
86     void setGenerator(RefPtr<Generator> generator)
87     {
88         m_generator = generator;
89     }
90
91     template<typename Functor>
92     void setGenerator(const Functor& functor)
93     {
94         m_generator = createSharedTask<GeneratorFunction>(functor);
95     }
96
97     void dump(PrintStream&) const;
98     
99 private:
100     friend class CheckSpecial;
101     friend class PatchpointSpecial;
102     friend class StackmapSpecial;
103     
104     Vector<ValueRep> m_reps;
105     RefPtr<Generator> m_generator;
106     RegisterSet m_clobbered;
107     RegisterSet m_usedRegisters; // Stackmaps could be further duplicated by Air, but that's unlikely, so we just merge the used registers sets if that were to happen.
108 };
109
110 } } // namespace JSC::B3
111
112 #endif // ENABLE(B3_JIT)
113
114 #endif // B3Stackmap_h
115