1 /*
2 * Copyright (c) 2016, 2023, Oracle and/or its affiliates. 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_VM_OPTO_INLINETYPENODE_HPP
26 #define SHARE_VM_OPTO_INLINETYPENODE_HPP
27
28 #include "opto/connode.hpp"
29 #include "opto/loopnode.hpp"
30 #include "opto/node.hpp"
31
32 class GraphKit;
33
34 //------------------------------InlineTypeNode-------------------------------------
35 // Node representing an inline type in C2 IR
36 class InlineTypeNode : public TypeNode {
37 protected:
38 InlineTypeNode(ciInlineKlass* vk, Node* oop, bool null_free)
39 : TypeNode(TypeInstPtr::make(null_free ? TypePtr::NotNull : TypePtr::BotPTR, vk), Values + vk->nof_declared_nonstatic_fields()) {
40 init_class_id(Class_InlineType);
41 init_req(Oop, oop);
42 Compile::current()->add_inline_type(this);
43 }
44
45 enum { Control, // Control input.
46 Oop, // Oop to heap allocated buffer.
47 IsBuffered, // True if inline type is heap allocated (or nullptr), false otherwise.
48 IsInit, // Needs to be checked for nullptr before using the field values.
49 Values // Nodes corresponding to values of the inline type's fields.
50 // Nodes are connected in increasing order of the index of the field they correspond to.
51 };
52
53 // Get the klass defining the field layout of the inline type
54 ciInlineKlass* inline_klass() const { return type()->inline_klass(); }
55
56 void make_scalar_in_safepoint(PhaseIterGVN* igvn, Unique_Node_List& worklist, SafePointNode* sfpt);
57
58 const TypePtr* field_adr_type(Node* base, int offset, ciInstanceKlass* holder, DecoratorSet decorators, PhaseGVN& gvn) const;
59
60 // Checks if the inline type fields are all set to default values
61 bool is_default(PhaseGVN* gvn) const;
62
63 // Checks if the inline type oop is an allocated buffer with larval state
64 bool is_larval(PhaseGVN* gvn) const;
65
66 // Checks if the inline type is loaded from memory and if so returns the oop
67 Node* is_loaded(PhaseGVN* phase, ciInlineKlass* vk = nullptr, Node* base = nullptr, int holder_offset = 0);
68
69 // Initialize the inline type fields with the inputs or outputs of a MultiNode
70 void initialize_fields(GraphKit* kit, MultiNode* multi, uint& base_input, bool in, bool null_free, Node* null_check_region, GrowableArray<ciType*>& visited);
71
72 InlineTypeNode* adjust_scalarization_depth_impl(GraphKit* kit, GrowableArray<ciType*>& visited);
73
74 static InlineTypeNode* make_default_impl(PhaseGVN& gvn, ciInlineKlass* vk, GrowableArray<ciType*>& visited);
75 static InlineTypeNode* make_from_oop_impl(GraphKit* kit, Node* oop, ciInlineKlass* vk, bool null_free, GrowableArray<ciType*>& visited);
76 static InlineTypeNode* make_null_impl(PhaseGVN& gvn, ciInlineKlass* vk, GrowableArray<ciType*>& visited);
77 static InlineTypeNode* make_from_flat_impl(GraphKit* kit, ciInlineKlass* vk, Node* obj, Node* ptr, ciInstanceKlass* holder, int holder_offset, DecoratorSet decorators, GrowableArray<ciType*>& visited);
78
79 public:
80 // Create with default field values
81 static InlineTypeNode* make_default(PhaseGVN& gvn, ciInlineKlass* vk);
82 // Create uninitialized
83 static InlineTypeNode* make_uninitialized(PhaseGVN& gvn, ciInlineKlass* vk, bool null_free = true);
84 // Create and initialize by loading the field values from an oop
85 static InlineTypeNode* make_from_oop(GraphKit* kit, Node* oop, ciInlineKlass* vk, bool null_free = true);
86 // Create and initialize by loading the field values from a flat field or array
87 static InlineTypeNode* make_from_flat(GraphKit* kit, ciInlineKlass* vk, Node* obj, Node* ptr, ciInstanceKlass* holder = nullptr, int holder_offset = 0, DecoratorSet decorators = IN_HEAP | MO_UNORDERED);
88 // Create and initialize with the inputs or outputs of a MultiNode (method entry or call)
89 static InlineTypeNode* make_from_multi(GraphKit* kit, MultiNode* multi, ciInlineKlass* vk, uint& base_input, bool in, bool null_free = true);
90 // Create with null field values
91 static InlineTypeNode* make_null(PhaseGVN& gvn, ciInlineKlass* vk);
92
93 // Returns the constant oop of the default inline type allocation
94 static Node* default_oop(PhaseGVN& gvn, ciInlineKlass* vk);
95
96 // Support for control flow merges
97 bool has_phi_inputs(Node* region);
98 InlineTypeNode* clone_with_phis(PhaseGVN* gvn, Node* region, bool is_init = false);
99 InlineTypeNode* merge_with(PhaseGVN* gvn, const InlineTypeNode* other, int pnum, bool transform);
100 void add_new_path(Node* region);
101
102 // Get oop for heap allocated inline type (may be TypePtr::NULL_PTR)
103 Node* get_oop() const { return in(Oop); }
104 void set_oop(Node* oop) { set_req(Oop, oop); }
105 Node* get_is_init() const { return in(IsInit); }
106 void set_is_init(PhaseGVN& gvn, bool init = true) { set_req(IsInit, gvn.intcon(init ? 1 : 0)); }
107 Node* get_is_buffered() const { return in(IsBuffered); }
108 void set_is_buffered(PhaseGVN& gvn, bool buffered = true) { set_req(IsBuffered, gvn.intcon(buffered ? 1 : 0)); }
109
110 // Inline type fields
111 uint field_count() const { return req() - Values; }
112 Node* field_value(uint index) const;
113 Node* field_value_by_offset(int offset, bool recursive = false) const;
114 void set_field_value(uint index, Node* value);
115 void set_field_value_by_offset(int offset, Node* value);
116 int field_offset(uint index) const;
117 uint field_index(int offset) const;
118 ciType* field_type(uint index) const;
119 bool field_is_flat(uint index) const;
120 bool field_is_null_free(uint index) const;
121
122 // Replace InlineTypeNodes in debug info at safepoints with SafePointScalarObjectNodes
123 void make_scalar_in_safepoints(PhaseIterGVN* igvn, bool allow_oop = true);
124
125 // Store the inline type as a flat (headerless) representation
126 void store_flat(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder = nullptr, int holder_offset = 0, DecoratorSet decorators = IN_HEAP | MO_UNORDERED) const;
127 // Store the field values to memory
128 void store(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0, DecoratorSet decorators = IN_HEAP | MO_UNORDERED) const;
129 // Initialize the inline type by loading its field values from memory
130 void load(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, GrowableArray<ciType*>& visited, int holder_offset = 0, DecoratorSet decorators = IN_HEAP | MO_UNORDERED);
131 // Make sure that inline type is fully scalarized
132 InlineTypeNode* adjust_scalarization_depth(GraphKit* kit);
133
134 // Allocates the inline type (if not yet allocated)
135 InlineTypeNode* buffer(GraphKit* kit, bool safe_for_replace = true);
136 bool is_allocated(PhaseGVN* phase) const;
137
138 void replace_call_results(GraphKit* kit, CallNode* call, Compile* C, bool null_free = true);
139
140 // Allocate all non-flat inline type fields
141 Node* allocate_fields(GraphKit* kit);
142
143 Node* tagged_klass(PhaseGVN& gvn) {
144 return tagged_klass(inline_klass(), gvn);
145 }
146 static Node* tagged_klass(ciInlineKlass* vk, PhaseGVN& gvn);
147 // Pass inline type as fields at a call or return
148 void pass_fields(GraphKit* kit, Node* n, uint& base_input, bool in, bool null_free = true);
149
150 InlineTypeNode* make_larval(GraphKit* kit, bool allocate) const;
151 InlineTypeNode* finish_larval(GraphKit* kit) const;
152
153 // Allocation optimizations
154 void remove_redundant_allocations(PhaseIdealLoop* phase);
155
156 virtual Node* Identity(PhaseGVN* phase);
157
158 virtual const Type* Value(PhaseGVN* phase) const;
159
160 virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
161
162 virtual int Opcode() const;
163 };
164
165 #endif // SHARE_VM_OPTO_INLINETYPENODE_HPP