1 /* 2 * Copyright (c) 2016, 2025, 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 "gc/shared/c2/barrierSetC2.hpp" 29 #include "opto/connode.hpp" 30 #include "opto/loopnode.hpp" 31 #include "opto/node.hpp" 32 33 class GraphKit; 34 35 //------------------------------InlineTypeNode------------------------------------- 36 // Node representing an inline type in C2 IR 37 class InlineTypeNode : public TypeNode { 38 protected: 39 InlineTypeNode(ciInlineKlass* vk, Node* oop, bool null_free) 40 : TypeNode(TypeInstPtr::make(null_free ? TypePtr::NotNull : TypePtr::BotPTR, vk), Values + vk->nof_declared_nonstatic_fields()) { 41 init_class_id(Class_InlineType); 42 init_req(Oop, oop); 43 Compile::current()->add_inline_type(this); 44 } 45 46 enum { Control, // Control input. 47 Oop, // Oop to heap allocated buffer. 48 IsBuffered, // True if inline type is heap allocated (or nullptr), false otherwise. 49 IsInit, // Needs to be checked for nullptr before using the field values. 50 Values // Nodes corresponding to values of the inline type's fields. 51 // Nodes are connected in increasing order of the index of the field they correspond to. 52 }; 53 54 // Get the klass defining the field layout of the inline type 55 ciInlineKlass* inline_klass() const { return type()->inline_klass(); } 56 57 void make_scalar_in_safepoint(PhaseIterGVN* igvn, Unique_Node_List& worklist, SafePointNode* sfpt); 58 uint add_fields_to_safepoint(Unique_Node_List& worklist, Node_List& null_markers, SafePointNode* sfpt); 59 60 const TypePtr* field_adr_type(Node* base, int offset, ciInstanceKlass* holder, DecoratorSet decorators, PhaseGVN& gvn) const; 61 62 // Checks if the inline type is loaded from memory and if so returns the oop 63 Node* is_loaded(PhaseGVN* phase, ciInlineKlass* vk = nullptr, Node* base = nullptr, int holder_offset = 0); 64 65 // Initialize the inline type fields with the inputs or outputs of a MultiNode 66 void initialize_fields(GraphKit* kit, MultiNode* multi, uint& base_input, bool in, bool null_free, Node* null_check_region, GrowableArray<ciType*>& visited); 67 68 InlineTypeNode* adjust_scalarization_depth_impl(GraphKit* kit, GrowableArray<ciType*>& visited); 69 70 static InlineTypeNode* make_all_zero_impl(PhaseGVN& gvn, ciInlineKlass* vk, GrowableArray<ciType*>& visited); 71 static InlineTypeNode* make_from_oop_impl(GraphKit* kit, Node* oop, ciInlineKlass* vk, GrowableArray<ciType*>& visited); 72 static InlineTypeNode* make_null_impl(PhaseGVN& gvn, ciInlineKlass* vk, GrowableArray<ciType*>& visited, bool transform = true); 73 static InlineTypeNode* make_from_flat_impl(GraphKit* kit, ciInlineKlass* vk, Node* obj, Node* ptr, Node* idx, ciInstanceKlass* holder, int holder_offset, bool atomic, int null_marker_offset, DecoratorSet decorators, GrowableArray<ciType*>& visited); 74 75 void convert_from_payload(GraphKit* kit, BasicType bt, Node* payload, int holder_offset, bool null_free, int null_marker_offset); 76 Node* convert_to_payload(GraphKit* kit, BasicType bt, Node* payload, int holder_offset, bool null_free, int null_marker_offset, int& oop_off_1, int& oop_off_2) const; 77 78 public: 79 // Create with all-zero field values 80 static InlineTypeNode* make_all_zero(PhaseGVN& gvn, ciInlineKlass* vk); 81 // Create uninitialized 82 static InlineTypeNode* make_uninitialized(PhaseGVN& gvn, ciInlineKlass* vk, bool null_free = true); 83 // Create and initialize by loading the field values from an oop 84 static InlineTypeNode* make_from_oop(GraphKit* kit, Node* oop, ciInlineKlass* vk); 85 // Create and initialize by loading the field values from a flat field or array 86 static InlineTypeNode* make_from_flat(GraphKit* kit, ciInlineKlass* vk, Node* obj, Node* ptr, Node* idx, ciInstanceKlass* holder = nullptr, int holder_offset = 0, 87 bool atomic = false, int null_marker_offset = -1, 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, bool transform = true); 92 93 // Support for control flow merges 94 bool has_phi_inputs(Node* region); 95 InlineTypeNode* clone_with_phis(PhaseGVN* gvn, Node* region, SafePointNode* map = nullptr, bool is_init = false); 96 InlineTypeNode* merge_with(PhaseGVN* gvn, const InlineTypeNode* other, int pnum, bool transform); 97 void add_new_path(Node* region); 98 99 // Get oop for heap allocated inline type (may be TypePtr::NULL_PTR) 100 Node* get_oop() const { return in(Oop); } 101 void set_oop(PhaseGVN& gvn, Node* oop) { set_req_X(Oop, oop, &gvn); } 102 Node* get_is_init() const { return in(IsInit); } 103 void set_is_init(PhaseGVN& gvn, bool init = true) { set_req_X(IsInit, gvn.intcon(init ? 1 : 0), &gvn); } 104 Node* get_is_buffered() const { return in(IsBuffered); } 105 void set_is_buffered(PhaseGVN& gvn, bool buffered = true) { set_req_X(IsBuffered, gvn.intcon(buffered ? 1 : 0), &gvn); } 106 107 // Checks if the inline type fields are all set to zero 108 bool is_all_zero(PhaseGVN* gvn, bool flat = false) const; 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) 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 bool field_is_volatile(uint index) const; 122 int field_null_marker_offset(uint index) const; 123 124 // Replace InlineTypeNodes in debug info at safepoints with SafePointScalarObjectNodes 125 void make_scalar_in_safepoints(PhaseIterGVN* igvn, bool allow_oop = true); 126 127 // Store the inline type as a flat (headerless) representation 128 void store_flat(GraphKit* kit, Node* base, Node* ptr, Node* idx, ciInstanceKlass* holder, int holder_offset, bool atomic, int null_marker_offset, DecoratorSet decorators) const; 129 // Store the field values to memory 130 void store(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0, int offset = -1, DecoratorSet decorators = C2_TIGHTLY_COUPLED_ALLOC | IN_HEAP | MO_UNORDERED) const; 131 // Initialize the inline type by loading its field values from memory 132 void load(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, GrowableArray<ciType*>& visited, int holder_offset = 0, DecoratorSet decorators = IN_HEAP | MO_UNORDERED); 133 // Make sure that inline type is fully scalarized 134 InlineTypeNode* adjust_scalarization_depth(GraphKit* kit); 135 136 // Allocates the inline type (if not yet allocated) 137 InlineTypeNode* buffer(GraphKit* kit, bool safe_for_replace = true); 138 bool is_allocated(PhaseGVN* phase) const; 139 140 void replace_call_results(GraphKit* kit, CallNode* call, Compile* C); 141 void replace_field_projs(Compile* C, CallNode* call, uint& proj_idx); 142 143 // Allocate all non-flat inline type fields 144 Node* allocate_fields(GraphKit* kit); 145 146 Node* tagged_klass(PhaseGVN& gvn) { 147 return tagged_klass(inline_klass(), gvn); 148 } 149 static Node* tagged_klass(ciInlineKlass* vk, PhaseGVN& gvn); 150 // Pass inline type as fields at a call or return 151 void pass_fields(GraphKit* kit, Node* n, uint& base_input, bool in, bool null_free = true); 152 153 // Allocation optimizations 154 void remove_redundant_allocations(PhaseIdealLoop* phase); 155 156 InlineTypeNode* clone_if_required(PhaseGVN* gvn, SafePointNode* map, bool safe_for_replace = true); 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