Create a super rough prototype of B3
[WebKit-https.git] / Source / JavaScriptCore / b3 / air / AirBasicBlock.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 AirBasicBlock_h
27 #define AirBasicBlock_h
28
29 #if ENABLE(B3_JIT)
30
31 #include "AirFrequentedBlock.h"
32 #include "AirInst.h"
33 #include "B3SuccessorCollection.h"
34 #include <wtf/FastMalloc.h>
35 #include <wtf/NonCopyable.h>
36
37 namespace JSC { namespace B3 { namespace Air {
38
39 class Code;
40 class InsertionSet;
41
42 class BasicBlock {
43     WTF_MAKE_NONCOPYABLE(BasicBlock);
44     WTF_MAKE_FAST_ALLOCATED;
45 public:
46     static const char* const dumpPrefix;
47
48     typedef Vector<Inst> InstList;
49     typedef Vector<BasicBlock*, 2> PredecessorList;
50     typedef Vector<FrequentedBlock, 2> SuccessorList;
51
52     unsigned index() const { return m_index; }
53     
54     unsigned size() const { return m_insts.size(); }
55     InstList::iterator begin() { return m_insts.begin(); }
56     InstList::iterator end() { return m_insts.end(); }
57     InstList::const_iterator begin() const { return m_insts.begin(); }
58     InstList::const_iterator end() const { return m_insts.end(); }
59
60     const Inst& at(size_t index) const { return m_insts[index]; }
61     Inst& at(size_t index) { return m_insts[index]; }
62
63     const Inst& last() const { return m_insts.last(); }
64     Inst& last() { return m_insts.last(); }
65
66     template<typename Inst>
67     void appendInst(Inst&& inst)
68     {
69         m_insts.append(std::forward<Inst>(inst));
70     }
71
72     template<typename... Arguments>
73     void append(Arguments&&... arguments)
74     {
75         m_insts.append(Inst(std::forward<Arguments>(arguments)...));
76     }
77
78     // The "0" case is the case to which the branch jumps, so the "then" case. The "1" case is the
79     // "else" case, and is used to represent the fall-through of a conditional branch.
80     unsigned numSuccessors() const { return m_successors.size(); }
81     FrequentedBlock successor(unsigned index) const { return m_successors[index]; }
82     FrequentedBlock& successor(unsigned index) { return m_successors[index]; }
83     const SuccessorList& successors() const { return m_successors; }
84     SuccessorList& successors() { return m_successors; }
85
86     BasicBlock* successorBlock(unsigned index) const { return successor(index).block(); }
87     BasicBlock*& successorBlock(unsigned index) { return successor(index).block(); }
88     SuccessorCollection<BasicBlock, SuccessorList> successorBlocks()
89     {
90         return SuccessorCollection<BasicBlock, SuccessorList>(m_successors);
91     }
92     SuccessorCollection<const BasicBlock, const SuccessorList> successorBlocks() const
93     {
94         return SuccessorCollection<const BasicBlock, const SuccessorList>(m_successors);
95     }
96
97     unsigned numPredecessors() const { return m_predecessors.size(); }
98     BasicBlock* predecessor(unsigned index) const { return m_predecessors[index]; }
99     BasicBlock*& predecessor(unsigned index) { return m_predecessors[index]; }
100     const PredecessorList& predecessors() const { return m_predecessors; }
101     PredecessorList& predecessors() { return m_predecessors; }
102
103     bool addPredecessor(BasicBlock*);
104     bool removePredecessor(BasicBlock*);
105     bool replacePredecessor(BasicBlock* from, BasicBlock* to);
106
107     void dump(PrintStream&) const;
108     void deepDump(PrintStream&) const;
109
110 private:
111     friend class Code;
112     friend class InsertionSet;
113     
114     BasicBlock(unsigned index, double frequency);
115
116     unsigned m_index;
117     InstList m_insts;
118     SuccessorList m_successors;
119     PredecessorList m_predecessors;
120     double m_frequency;
121 };
122
123 class DeepBasicBlockDump {
124 public:
125     DeepBasicBlockDump(const BasicBlock* block)
126         : m_block(block)
127     {
128     }
129
130     void dump(PrintStream& out) const
131     {
132         if (m_block)
133             m_block->deepDump(out);
134         else
135             out.print("<null>");
136     }
137
138 private:
139     const BasicBlock* m_block;
140 };
141
142 inline DeepBasicBlockDump deepDump(const BasicBlock* block)
143 {
144     return DeepBasicBlockDump(block);
145 }
146
147 } } } // namespace JSC::B3::Air
148
149 #endif // ENABLE(B3_JIT)
150
151 #endif // AirBasicBlock_h
152