1 /*
2 * Copyright (c) 2018, 2021, 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_SHENANDOAHBARRIERSETC2_HPP
26 #define SHARE_GC_SHENANDOAH_C2_SHENANDOAHBARRIERSETC2_HPP
27
28 #include "gc/shared/c2/barrierSetC2.hpp"
29 #include "gc/shenandoah/c2/shenandoahSupport.hpp"
30 #include "utilities/growableArray.hpp"
31
32 class ShenandoahBarrierSetC2State : public ArenaObj {
33 private:
34 GrowableArray<ShenandoahLoadReferenceBarrierNode*>* _load_reference_barriers;
35
36 public:
37 ShenandoahBarrierSetC2State(Arena* comp_arena);
38
39 int load_reference_barriers_count() const;
40 ShenandoahLoadReferenceBarrierNode* load_reference_barrier(int idx) const;
41 void add_load_reference_barrier(ShenandoahLoadReferenceBarrierNode* n);
42 void remove_load_reference_barrier(ShenandoahLoadReferenceBarrierNode * n);
43 };
44
45 class ShenandoahBarrierSetC2 : public BarrierSetC2 {
46 private:
47 void shenandoah_eliminate_wb_pre(Node* call, PhaseIterGVN* igvn) const;
48
49 bool satb_can_remove_pre_barrier(GraphKit* kit, PhaseValues* phase, Node* adr,
50 BasicType bt, uint adr_idx) const;
51 void satb_write_barrier_pre(GraphKit* kit, bool do_load,
52 Node* obj,
53 Node* adr,
54 uint alias_idx,
55 Node* val,
56 const TypeOopPtr* val_type,
57 Node* pre_val,
58 BasicType bt) const;
59
60 void shenandoah_write_barrier_pre(GraphKit* kit,
61 bool do_load,
62 Node* obj,
63 Node* adr,
64 uint alias_idx,
65 Node* val,
66 const TypeOopPtr* val_type,
67 Node* pre_val,
68 BasicType bt) const;
69
70 Node* byte_map_base_node(GraphKit* kit) const;
71
72 void post_barrier(GraphKit* kit,
73 Node* ctl,
74 Node* store,
75 Node* obj,
76 Node* adr,
77 uint adr_idx,
78 Node* val,
79 BasicType bt,
80 bool use_precise) const;
81
82 void insert_pre_barrier(GraphKit* kit, Node* base_oop, Node* offset,
83 Node* pre_val, bool need_mem_bar) const;
84
85 static bool clone_needs_barrier(Node* src, PhaseGVN& gvn);
86
87 protected:
88 virtual Node* load_at_resolved(C2Access& access, const Type* val_type) const;
89 virtual Node* store_at_resolved(C2Access& access, C2AccessValue& val) const;
90 virtual Node* atomic_cmpxchg_val_at_resolved(C2AtomicParseAccess& access, Node* expected_val,
91 Node* new_val, const Type* val_type) const;
92 virtual Node* atomic_cmpxchg_bool_at_resolved(C2AtomicParseAccess& access, Node* expected_val,
93 Node* new_val, const Type* value_type) const;
94 virtual Node* atomic_xchg_at_resolved(C2AtomicParseAccess& access, Node* new_val, const Type* val_type) const;
95
96 public:
97 static ShenandoahBarrierSetC2* bsc2();
98
99 static bool is_shenandoah_wb_pre_call(Node* call);
100 static bool is_shenandoah_clone_call(Node* call);
101 static bool is_shenandoah_lrb_call(Node* call);
102 static bool is_shenandoah_marking_if(PhaseValues* phase, Node* n);
103 static bool is_shenandoah_state_load(Node* n);
104 static bool has_only_shenandoah_wb_pre_uses(Node* n);
105
106 ShenandoahBarrierSetC2State* state() const;
107
108 static const TypeFunc* write_ref_field_pre_Type();
109 static const TypeFunc* clone_barrier_Type();
110 static const TypeFunc* load_reference_barrier_Type();
111 virtual bool has_load_barrier_nodes() const { return true; }
112
113 // This is the entry-point for the backend to perform accesses through the Access API.
114 virtual void clone_at_expansion(PhaseMacroExpand* phase, ArrayCopyNode* ac) const;
115
116 // These are general helper methods used by C2
117 virtual bool array_copy_requires_gc_barriers(bool tightly_coupled_alloc, BasicType type, bool is_clone, bool is_clone_instance, ArrayCopyPhase phase) const;
118
119 // Support for GC barriers emitted during parsing
120 virtual bool is_gc_pre_barrier_node(Node* node) const;
121 virtual bool is_gc_barrier_node(Node* node) const;
122 virtual Node* step_over_gc_barrier(Node* c) const;
123 virtual bool expand_barriers(Compile* C, PhaseIterGVN& igvn) const;
124 virtual bool optimize_loops(PhaseIdealLoop* phase, LoopOptsMode mode, VectorSet& visited, Node_Stack& nstack, Node_List& worklist) const;
125 virtual bool strip_mined_loops_expanded(LoopOptsMode mode) const { return mode == LoopOptsShenandoahExpand || mode == LoopOptsShenandoahPostExpand; }
126 virtual bool is_gc_specific_loop_opts_pass(LoopOptsMode mode) const { return mode == LoopOptsShenandoahExpand || mode == LoopOptsShenandoahPostExpand; }
127
128 // Support for macro expanded GC barriers
129 virtual void register_potential_barrier_node(Node* node) const;
130 virtual void unregister_potential_barrier_node(Node* node) const;
131 virtual void eliminate_gc_barrier(PhaseMacroExpand* macro, Node* node) const;
132 virtual void enqueue_useful_gc_barrier(PhaseIterGVN* igvn, Node* node) const;
133 virtual void eliminate_useless_gc_barriers(Unique_Node_List &useful, Compile* C) const;
134
135 // Allow barrier sets to have shared state that is preserved across a compilation unit.
136 // This could for example comprise macro nodes to be expanded during macro expansion.
137 virtual void* create_barrier_state(Arena* comp_arena) const;
138 // If the BarrierSetC2 state has kept macro nodes in its compilation unit state to be
139 // expanded later, then now is the time to do so.
140 virtual bool expand_macro_nodes(PhaseMacroExpand* macro) const;
141
142 #ifdef ASSERT
143 virtual void verify_gc_barriers(Compile* compile, CompilePhase phase) const;
144 #endif
145
146 virtual Node* ideal_node(PhaseGVN* phase, Node* n, bool can_reshape) const;
147 virtual bool final_graph_reshaping(Compile* compile, Node* n, uint opcode, Unique_Node_List& dead_nodes) const;
148
149 virtual bool escape_add_to_con_graph(ConnectionGraph* conn_graph, PhaseGVN* gvn, Unique_Node_List* delayed_worklist, Node* n, uint opcode) const;
150 virtual bool escape_add_final_edges(ConnectionGraph* conn_graph, PhaseGVN* gvn, Node* n, uint opcode) const;
151 virtual bool escape_has_out_with_unsafe_object(Node* n) const;
152
153 virtual bool matcher_find_shared_post_visit(Matcher* matcher, Node* n, uint opcode) const;
154 virtual bool matcher_is_store_load_barrier(Node* x, uint xop) const;
155 };
156
157 #endif // SHARE_GC_SHENANDOAH_C2_SHENANDOAHBARRIERSETC2_HPP