1 /*
2 * Copyright (c) 2015, 2019, Red Hat, Inc. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_GC_SHENANDOAH_C2_SHENANDOAHSUPPORT_HPP
26 #define SHARE_GC_SHENANDOAH_C2_SHENANDOAHSUPPORT_HPP
27
28 #include "memory/allocation.hpp"
29 #include "opto/addnode.hpp"
30 #include "opto/graphKit.hpp"
31 #include "opto/machnode.hpp"
32 #include "opto/memnode.hpp"
33 #include "opto/multnode.hpp"
34 #include "opto/node.hpp"
35
36 class PhaseGVN;
37 class MemoryGraphFixer;
38
39 class ShenandoahBarrierC2Support : public AllStatic {
40 private:
41 #ifdef ASSERT
42 enum verify_type {
43 ShenandoahLoad,
44 ShenandoahStore,
45 ShenandoahValue,
46 ShenandoahOopStore,
47 ShenandoahNone
48 };
49
50 static bool verify_helper(Node* in, Node_Stack& phis, VectorSet& visited, verify_type t, bool trace, Unique_Node_List& barriers_used);
51 static void report_verify_failure(const char* msg, Node* n1 = NULL, Node* n2 = NULL);
52 static void verify_raw_mem(RootNode* root);
53 #endif
54 static Node* dom_mem(Node* mem, Node* ctrl, int alias, Node*& mem_ctrl, PhaseIdealLoop* phase);
55 static Node* no_branches(Node* c, Node* dom, bool allow_one_proj, PhaseIdealLoop* phase);
56 static bool is_heap_state_test(Node* iff, int mask);
57 static bool has_safepoint_between(Node* start, Node* stop, PhaseIdealLoop *phase);
58 static Node* find_bottom_mem(Node* ctrl, PhaseIdealLoop* phase);
59 static void follow_barrier_uses(Node* n, Node* ctrl, Unique_Node_List& uses, PhaseIdealLoop* phase);
60 static void test_null(Node*& ctrl, Node* val, Node*& null_ctrl, PhaseIdealLoop* phase);
61 static void test_heap_state(Node*& ctrl, Node* raw_mem, Node*& heap_stable_ctrl,
62 PhaseIdealLoop* phase, int flags);
63 static void call_lrb_stub(Node*& ctrl, Node*& val, Node* load_addr, Node*& result_mem, Node* raw_mem, bool is_native, PhaseIdealLoop* phase);
64 static void in_cset_fast_test(Node*& ctrl, Node*& not_cset_ctrl, Node* val, Node* raw_mem, PhaseIdealLoop* phase);
65 static void move_heap_stable_test_out_of_loop(IfNode* iff, PhaseIdealLoop* phase);
66 static void merge_back_to_back_tests(Node* n, PhaseIdealLoop* phase);
67 static bool identical_backtoback_ifs(Node *n, PhaseIdealLoop* phase);
68 static void fix_ctrl(Node* barrier, Node* region, const MemoryGraphFixer& fixer, Unique_Node_List& uses, Unique_Node_List& uses_to_ignore, uint last, PhaseIdealLoop* phase);
69 static IfNode* find_unswitching_candidate(const IdealLoopTree *loop, PhaseIdealLoop* phase);
70
71 static Node* get_load_addr(PhaseIdealLoop* phase, VectorSet& visited, Node* lrb);
72 public:
73 static bool is_dominator(Node* d_c, Node* n_c, Node* d, Node* n, PhaseIdealLoop* phase);
74 static bool is_dominator_same_ctrl(Node* c, Node* d, Node* n, PhaseIdealLoop* phase);
75
76 static bool is_gc_state_load(Node* n);
77 static bool is_heap_stable_test(Node* iff);
78
79 static bool expand(Compile* C, PhaseIterGVN& igvn);
80 static void pin_and_expand(PhaseIdealLoop* phase);
81 static void optimize_after_expansion(VectorSet& visited, Node_Stack& nstack, Node_List& old_new, PhaseIdealLoop* phase);
82
83 #ifdef ASSERT
84 static void verify(RootNode* root);
85 #endif
86 };
87
88 class ShenandoahEnqueueBarrierNode : public Node {
89 public:
90 ShenandoahEnqueueBarrierNode(Node* val);
91
92 const Type *bottom_type() const;
93 const Type* Value(PhaseGVN* phase) const;
94 Node* Identity(PhaseGVN* phase);
95
96 int Opcode() const;
97
98 private:
99 enum { Needed, NotNeeded, MaybeNeeded };
100
101 static int needed(Node* n);
102 static Node* next(Node* n);
103 };
104
105 class MemoryGraphFixer : public ResourceObj {
106 private:
107 Node_List _memory_nodes;
108 int _alias;
109 PhaseIdealLoop* _phase;
110 bool _include_lsm;
111
112 void collect_memory_nodes();
113 Node* get_ctrl(Node* n) const;
114 Node* ctrl_or_self(Node* n) const;
115 bool mem_is_valid(Node* m, Node* c) const;
116 MergeMemNode* allocate_merge_mem(Node* mem, Node* rep_proj, Node* rep_ctrl) const;
117 MergeMemNode* clone_merge_mem(Node* u, Node* mem, Node* rep_proj, Node* rep_ctrl, DUIterator& i) const;
118 void fix_memory_uses(Node* mem, Node* replacement, Node* rep_proj, Node* rep_ctrl) const;
119 bool should_process_phi(Node* phi) const;
120 bool has_mem_phi(Node* region) const;
121
122 public:
123 MemoryGraphFixer(int alias, bool include_lsm, PhaseIdealLoop* phase) :
124 _alias(alias), _phase(phase), _include_lsm(include_lsm) {
125 assert(_alias != Compile::AliasIdxBot, "unsupported");
126 collect_memory_nodes();
127 }
128
129 Node* find_mem(Node* ctrl, Node* n) const;
130 void fix_mem(Node* ctrl, Node* region, Node* mem, Node* mem_for_ctrl, Node* mem_phi, Unique_Node_List& uses);
131 int alias() const { return _alias; }
132 };
133
134 class ShenandoahCompareAndSwapPNode : public CompareAndSwapPNode {
135 public:
136 ShenandoahCompareAndSwapPNode(Node *c, Node *mem, Node *adr, Node *val, Node *ex, MemNode::MemOrd mem_ord)
137 : CompareAndSwapPNode(c, mem, adr, val, ex, mem_ord) { }
138
139 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape) {
140 if (in(ExpectedIn) != NULL && phase->type(in(ExpectedIn)) == TypePtr::NULL_PTR) {
141 return new CompareAndSwapPNode(in(MemNode::Control), in(MemNode::Memory), in(MemNode::Address), in(MemNode::ValueIn), in(ExpectedIn), order());
142 }
143 return NULL;
144 }
145
146 virtual int Opcode() const;
147 };
148
149 class ShenandoahCompareAndSwapNNode : public CompareAndSwapNNode {
150 public:
151 ShenandoahCompareAndSwapNNode(Node *c, Node *mem, Node *adr, Node *val, Node *ex, MemNode::MemOrd mem_ord)
152 : CompareAndSwapNNode(c, mem, adr, val, ex, mem_ord) { }
153
154 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape) {
155 if (in(ExpectedIn) != NULL && phase->type(in(ExpectedIn)) == TypeNarrowOop::NULL_PTR) {
156 return new CompareAndSwapNNode(in(MemNode::Control), in(MemNode::Memory), in(MemNode::Address), in(MemNode::ValueIn), in(ExpectedIn), order());
157 }
158 return NULL;
159 }
160
161 virtual int Opcode() const;
162 };
163
164 class ShenandoahWeakCompareAndSwapPNode : public WeakCompareAndSwapPNode {
165 public:
166 ShenandoahWeakCompareAndSwapPNode(Node *c, Node *mem, Node *adr, Node *val, Node *ex, MemNode::MemOrd mem_ord)
167 : WeakCompareAndSwapPNode(c, mem, adr, val, ex, mem_ord) { }
168
169 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape) {
170 if (in(ExpectedIn) != NULL && phase->type(in(ExpectedIn)) == TypePtr::NULL_PTR) {
171 return new WeakCompareAndSwapPNode(in(MemNode::Control), in(MemNode::Memory), in(MemNode::Address), in(MemNode::ValueIn), in(ExpectedIn), order());
172 }
173 return NULL;
174 }
175
176 virtual int Opcode() const;
177 };
178
179 class ShenandoahWeakCompareAndSwapNNode : public WeakCompareAndSwapNNode {
180 public:
181 ShenandoahWeakCompareAndSwapNNode(Node *c, Node *mem, Node *adr, Node *val, Node *ex, MemNode::MemOrd mem_ord)
182 : WeakCompareAndSwapNNode(c, mem, adr, val, ex, mem_ord) { }
183
184 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape) {
185 if (in(ExpectedIn) != NULL && phase->type(in(ExpectedIn)) == TypeNarrowOop::NULL_PTR) {
186 return new WeakCompareAndSwapNNode(in(MemNode::Control), in(MemNode::Memory), in(MemNode::Address), in(MemNode::ValueIn), in(ExpectedIn), order());
187 }
188 return NULL;
189 }
190
191 virtual int Opcode() const;
192 };
193
194 class ShenandoahCompareAndExchangePNode : public CompareAndExchangePNode {
195 public:
196 ShenandoahCompareAndExchangePNode(Node *c, Node *mem, Node *adr, Node *val, Node *ex, const TypePtr* at, const Type* t, MemNode::MemOrd mem_ord)
197 : CompareAndExchangePNode(c, mem, adr, val, ex, at, t, mem_ord) { }
198
199 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape) {
200 if (in(ExpectedIn) != NULL && phase->type(in(ExpectedIn)) == TypePtr::NULL_PTR) {
201 return new CompareAndExchangePNode(in(MemNode::Control), in(MemNode::Memory), in(MemNode::Address), in(MemNode::ValueIn), in(ExpectedIn), adr_type(), bottom_type(), order());
202 }
203 return NULL;
204 }
205
206 virtual int Opcode() const;
207 };
208
209 class ShenandoahCompareAndExchangeNNode : public CompareAndExchangeNNode {
210 public:
211 ShenandoahCompareAndExchangeNNode(Node *c, Node *mem, Node *adr, Node *val, Node *ex, const TypePtr* at, const Type* t, MemNode::MemOrd mem_ord)
212 : CompareAndExchangeNNode(c, mem, adr, val, ex, at, t, mem_ord) { }
213
214 virtual Node *Ideal(PhaseGVN *phase, bool can_reshape) {
215 if (in(ExpectedIn) != NULL && phase->type(in(ExpectedIn)) == TypeNarrowOop::NULL_PTR) {
216 return new CompareAndExchangeNNode(in(MemNode::Control), in(MemNode::Memory), in(MemNode::Address), in(MemNode::ValueIn), in(ExpectedIn), adr_type(), bottom_type(), order());
217 }
218 return NULL;
219 }
220
221 virtual int Opcode() const;
222 };
223
224 class ShenandoahLoadReferenceBarrierNode : public Node {
225 public:
226 enum {
227 Control,
228 ValueIn
229 };
230
231 private:
232 bool _native;
233
234 public:
235 ShenandoahLoadReferenceBarrierNode(Node* ctrl, Node* val, bool native);
236
237 bool is_native() const;
238 virtual int Opcode() const;
239 virtual const Type* bottom_type() const;
240 virtual const Type* Value(PhaseGVN* phase) const;
241 virtual const class TypePtr *adr_type() const { return TypeOopPtr::BOTTOM; }
242 virtual uint match_edge(uint idx) const {
243 return idx >= ValueIn;
244 }
245 virtual uint ideal_reg() const { return Op_RegP; }
246
247 virtual Node* Identity(PhaseGVN* phase);
248
249 virtual uint size_of() const;
250 virtual uint hash() const;
251 virtual bool cmp( const Node &n ) const;
252
253 bool is_redundant();
254
255 private:
256 bool needs_barrier(PhaseGVN* phase, Node* n);
257 bool needs_barrier_impl(PhaseGVN* phase, Node* n, Unique_Node_List &visited);
258 };
259
260
261 #endif // SHARE_GC_SHENANDOAH_C2_SHENANDOAHSUPPORT_HPP