1 /* 2 * Copyright (c) 1999, 2018, 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 #include "precompiled.hpp" 26 #include "ci/ciField.hpp" 27 #include "ci/ciInstanceKlass.hpp" 28 #include "ci/ciUtilities.inline.hpp" 29 #include "classfile/systemDictionary.hpp" 30 #include "gc/shared/collectedHeap.inline.hpp" 31 #include "interpreter/linkResolver.hpp" 32 #include "memory/universe.hpp" 33 #include "oops/oop.inline.hpp" 34 #include "runtime/fieldDescriptor.hpp" 35 #include "runtime/handles.inline.hpp" 36 37 // ciField 38 // 39 // This class represents the result of a field lookup in the VM. 40 // The lookup may not succeed, in which case the information in 41 // the ciField will be incomplete. 42 43 // The ciObjectFactory cannot create circular data structures in one query. 44 // To avoid vicious circularities, we initialize ciField::_type to NULL 45 // for reference types and derive it lazily from the ciField::_signature. 46 // Primitive types are eagerly initialized, and basic layout queries 47 // can succeed without initialization, using only the BasicType of the field. 48 49 // Notes on bootstrapping and shared CI objects: A field is shared if and 50 // only if it is (a) non-static and (b) declared by a shared instance klass. 51 // This allows non-static field lists to be cached on shared types. 52 // Because the _type field is lazily initialized, however, there is a 53 // special restriction that a shared field cannot cache an unshared type. 54 // This puts a small performance penalty on shared fields with unshared 55 // types, such as StackTraceElement[] Throwable.stackTrace. 56 // (Throwable is shared because ClassCastException is shared, but 57 // StackTraceElement is not presently shared.) 58 59 // It is not a vicious circularity for a ciField to recursively create 60 // the ciSymbols necessary to represent its name and signature. 61 // Therefore, these items are created eagerly, and the name and signature 62 // of a shared field are themselves shared symbols. This somewhat 63 // pollutes the set of shared CI objects: It grows from 50 to 93 items, 64 // with all of the additional 43 being uninteresting shared ciSymbols. 65 // This adds at most one step to the binary search, an amount which 66 // decreases for complex compilation tasks. 67 68 // ------------------------------------------------------------------ 69 // ciField::ciField 70 ciField::ciField(ciInstanceKlass* klass, int index) : 71 _known_to_link_with_put(NULL), _known_to_link_with_get(NULL) { 72 ASSERT_IN_VM; 73 CompilerThread *thread = CompilerThread::current(); 74 75 assert(ciObjectFactory::is_initialized(), "not a shared field"); 76 77 assert(klass->get_instanceKlass()->is_linked(), "must be linked before using its constant-pool"); 78 79 constantPoolHandle cpool(thread, klass->get_instanceKlass()->constants()); 80 81 // Get the field's name, signature, and type. 82 Symbol* name = cpool->name_ref_at(index); 83 _name = ciEnv::current(thread)->get_symbol(name); 84 85 int nt_index = cpool->name_and_type_ref_index_at(index); 86 int sig_index = cpool->signature_ref_index_at(nt_index); 87 Symbol* signature = cpool->symbol_at(sig_index); 88 _signature = ciEnv::current(thread)->get_symbol(signature); 89 90 BasicType field_type = FieldType::basic_type(signature); 91 92 // If the field is a pointer type, get the klass of the 93 // field. 94 if (field_type == T_OBJECT || field_type == T_ARRAY) { 95 bool ignore; 96 // This is not really a class reference; the index always refers to the 97 // field's type signature, as a symbol. Linkage checks do not apply. 98 _type = ciEnv::current(thread)->get_klass_by_index(cpool, sig_index, ignore, klass); 99 } else { 100 _type = ciType::make(field_type); 101 } 102 103 _name = (ciSymbol*)ciEnv::current(thread)->get_symbol(name); 104 105 // Get the field's declared holder. 106 // 107 // Note: we actually create a ciInstanceKlass for this klass, 108 // even though we may not need to. 109 int holder_index = cpool->klass_ref_index_at(index); 110 bool holder_is_accessible; 111 112 ciKlass* generic_declared_holder = ciEnv::current(thread)->get_klass_by_index(cpool, holder_index, 113 holder_is_accessible, 114 klass); 115 116 if (generic_declared_holder->is_array_klass()) { 117 // If the declared holder of the field is an array class, assume that 118 // the canonical holder of that field is java.lang.Object. Arrays 119 // do not have fields; java.lang.Object is the only supertype of an 120 // array type that can declare fields and is therefore the canonical 121 // holder of the array type. 122 // 123 // Furthermore, the compilers assume that java.lang.Object does not 124 // have any fields. Therefore, the field is not looked up. Instead, 125 // the method returns partial information that will trigger special 126 // handling in ciField::will_link and will result in a 127 // java.lang.NoSuchFieldError exception being thrown by the compiled 128 // code (the expected behavior in this case). 129 _holder = ciEnv::current(thread)->Object_klass(); 130 _offset = -1; 131 _is_constant = false; 132 return; 133 } 134 135 ciInstanceKlass* declared_holder = generic_declared_holder->as_instance_klass(); 136 137 // The declared holder of this field may not have been loaded. 138 // Bail out with partial field information. 139 if (!holder_is_accessible) { 140 // _type has already been set. 141 // The default values for _flags and _constant_value will suffice. 142 // We need values for _holder, _offset, and _is_constant, 143 _holder = declared_holder; 144 _offset = -1; 145 _is_constant = false; 146 return; 147 } 148 149 InstanceKlass* loaded_decl_holder = declared_holder->get_instanceKlass(); 150 151 // Perform the field lookup. 152 fieldDescriptor field_desc; 153 Klass* canonical_holder = 154 loaded_decl_holder->find_field(name, signature, &field_desc); 155 if (canonical_holder == NULL) { 156 // Field lookup failed. Will be detected by will_link. 157 _holder = declared_holder; 158 _offset = -1; 159 _is_constant = false; 160 return; 161 } 162 163 // Access check based on declared_holder. canonical_holder should not be used 164 // to check access because it can erroneously succeed. If this check fails, 165 // propagate the declared holder to will_link() which in turn will bail out 166 // compilation for this field access. 167 if (!Reflection::verify_field_access(klass->get_Klass(), declared_holder->get_Klass(), canonical_holder, field_desc.access_flags(), true)) { 168 _holder = declared_holder; 169 _offset = -1; 170 _is_constant = false; 171 return; 172 } 173 174 assert(canonical_holder == field_desc.field_holder(), "just checking"); 175 initialize_from(&field_desc); 176 } 177 178 ciField::ciField(fieldDescriptor *fd) : 179 _known_to_link_with_put(NULL), _known_to_link_with_get(NULL) { 180 ASSERT_IN_VM; 181 182 // Get the field's name, signature, and type. 183 ciEnv* env = CURRENT_ENV; 184 _name = env->get_symbol(fd->name()); 185 _signature = env->get_symbol(fd->signature()); 186 187 BasicType field_type = fd->field_type(); 188 189 // If the field is a pointer type, get the klass of the 190 // field. 191 if (field_type == T_OBJECT || field_type == T_ARRAY) { 192 _type = NULL; // must call compute_type on first access 193 } else { 194 _type = ciType::make(field_type); 195 } 196 197 initialize_from(fd); 198 199 // Either (a) it is marked shared, or else (b) we are done bootstrapping. 200 assert(is_shared() || ciObjectFactory::is_initialized(), 201 "bootstrap classes must not create & cache unshared fields"); 202 } 203 204 static bool trust_final_non_static_fields(ciInstanceKlass* holder) { 205 if (holder == NULL) 206 return false; 207 if (holder->name() == ciSymbol::java_lang_System()) 208 // Never trust strangely unstable finals: System.out, etc. 209 return false; 210 // Even if general trusting is disabled, trust system-built closures in these packages. 211 if (holder->is_in_package("java/lang/invoke") || holder->is_in_package("sun/invoke")) 212 return true; 213 // Trust VM anonymous classes. They are private API (sun.misc.Unsafe) and can't be serialized, 214 // so there is no hacking of finals going on with them. 215 if (holder->is_anonymous()) 216 return true; 217 // Trust final fields in all boxed classes 218 if (holder->is_box_klass()) 219 return true; 220 // Trust final fields in String 221 if (holder->name() == ciSymbol::java_lang_String()) 222 return true; 223 // Trust Atomic*FieldUpdaters: they are very important for performance, and make up one 224 // more reason not to use Unsafe, if their final fields are trusted. See more in JDK-8140483. 225 if (holder->name() == ciSymbol::java_util_concurrent_atomic_AtomicIntegerFieldUpdater_Impl() || 226 holder->name() == ciSymbol::java_util_concurrent_atomic_AtomicLongFieldUpdater_CASUpdater() || 227 holder->name() == ciSymbol::java_util_concurrent_atomic_AtomicLongFieldUpdater_LockedUpdater() || 228 holder->name() == ciSymbol::java_util_concurrent_atomic_AtomicReferenceFieldUpdater_Impl()) { 229 return true; 230 } 231 return TrustFinalNonStaticFields; 232 } 233 234 void ciField::initialize_from(fieldDescriptor* fd) { 235 // Get the flags, offset, and canonical holder of the field. 236 _flags = ciFlags(fd->access_flags()); 237 _offset = fd->offset(); 238 Klass* field_holder = fd->field_holder(); 239 assert(field_holder != NULL, "null field_holder"); 240 _holder = CURRENT_ENV->get_instance_klass(field_holder); 241 242 // Check to see if the field is constant. 243 Klass* k = _holder->get_Klass(); 244 bool is_stable_field = FoldStableValues && is_stable(); 245 if ((is_final() && !has_initialized_final_update()) || is_stable_field) { 246 if (is_static()) { 247 // This field just may be constant. The only case where it will 248 // not be constant is when the field is a *special* static & final field 249 // whose value may change. The three examples are java.lang.System.in, 250 // java.lang.System.out, and java.lang.System.err. 251 assert(SystemDictionary::System_klass() != NULL, "Check once per vm"); 252 if (k == SystemDictionary::System_klass()) { 253 // Check offsets for case 2: System.in, System.out, or System.err 254 if( _offset == java_lang_System::in_offset_in_bytes() || 255 _offset == java_lang_System::out_offset_in_bytes() || 256 _offset == java_lang_System::err_offset_in_bytes() ) { 257 _is_constant = false; 258 return; 259 } 260 } 261 _is_constant = true; 262 } else { 263 // An instance field can be constant if it's a final static field or if 264 // it's a final non-static field of a trusted class (classes in 265 // java.lang.invoke and sun.invoke packages and subpackages). 266 _is_constant = is_stable_field || trust_final_non_static_fields(_holder); 267 } 268 } else { 269 // For CallSite objects treat the target field as a compile time constant. 270 assert(SystemDictionary::CallSite_klass() != NULL, "should be already initialized"); 271 if (k == SystemDictionary::CallSite_klass() && 272 _offset == java_lang_invoke_CallSite::target_offset_in_bytes()) { 273 assert(!has_initialized_final_update(), "CallSite is not supposed to have writes to final fields outside initializers"); 274 _is_constant = true; 275 } else { 276 // Non-final & non-stable fields are not constants. 277 _is_constant = false; 278 } 279 } 280 } 281 282 // ------------------------------------------------------------------ 283 // ciField::constant_value 284 // Get the constant value of a this static field. 285 ciConstant ciField::constant_value() { 286 assert(is_static() && is_constant(), "illegal call to constant_value()"); 287 if (!_holder->is_initialized()) { 288 return ciConstant(); // Not initialized yet 289 } 290 if (_constant_value.basic_type() == T_ILLEGAL) { 291 // Static fields are placed in mirror objects. 292 VM_ENTRY_MARK; 293 ciInstance* mirror = CURRENT_ENV->get_instance(_holder->get_Klass()->java_mirror()); 294 _constant_value = mirror->field_value_impl(type()->basic_type(), offset()); 295 } 296 if (FoldStableValues && is_stable() && _constant_value.is_null_or_zero()) { 297 return ciConstant(); 298 } 299 return _constant_value; 300 } 301 302 // ------------------------------------------------------------------ 303 // ciField::constant_value_of 304 // Get the constant value of non-static final field in the given object. 305 ciConstant ciField::constant_value_of(ciObject* object) { 306 assert(!is_static() && is_constant(), "only if field is non-static constant"); 307 assert(object->is_instance(), "must be instance"); 308 ciConstant field_value = object->as_instance()->field_value(this); 309 if (FoldStableValues && is_stable() && field_value.is_null_or_zero()) { 310 return ciConstant(); 311 } 312 return field_value; 313 } 314 315 // ------------------------------------------------------------------ 316 // ciField::compute_type 317 // 318 // Lazily compute the type, if it is an instance klass. 319 ciType* ciField::compute_type() { 320 GUARDED_VM_ENTRY(return compute_type_impl();) 321 } 322 323 ciType* ciField::compute_type_impl() { 324 ciKlass* type = CURRENT_ENV->get_klass_by_name_impl(_holder, constantPoolHandle(), _signature, false); 325 if (!type->is_primitive_type() && is_shared()) { 326 // We must not cache a pointer to an unshared type, in a shared field. 327 bool type_is_also_shared = false; 328 if (type->is_type_array_klass()) { 329 type_is_also_shared = true; // int[] etc. are explicitly bootstrapped 330 } else if (type->is_instance_klass()) { 331 type_is_also_shared = type->as_instance_klass()->is_shared(); 332 } else { 333 // Currently there is no 'shared' query for array types. 334 type_is_also_shared = !ciObjectFactory::is_initialized(); 335 } 336 if (!type_is_also_shared) 337 return type; // Bummer. 338 } 339 _type = type; 340 return type; 341 } 342 343 344 // ------------------------------------------------------------------ 345 // ciField::will_link 346 // 347 // Can a specific access to this field be made without causing 348 // link errors? 349 bool ciField::will_link(ciMethod* accessing_method, 350 Bytecodes::Code bc) { 351 VM_ENTRY_MARK; 352 assert(bc == Bytecodes::_getstatic || bc == Bytecodes::_putstatic || 353 bc == Bytecodes::_getfield || bc == Bytecodes::_putfield, 354 "unexpected bytecode"); 355 356 if (_offset == -1) { 357 // at creation we couldn't link to our holder so we need to 358 // maintain that stance, otherwise there's no safe way to use this 359 // ciField. 360 return false; 361 } 362 363 // Check for static/nonstatic mismatch 364 bool is_static = (bc == Bytecodes::_getstatic || bc == Bytecodes::_putstatic); 365 if (is_static != this->is_static()) { 366 return false; 367 } 368 369 // Get and put can have different accessibility rules 370 bool is_put = (bc == Bytecodes::_putfield || bc == Bytecodes::_putstatic); 371 if (is_put) { 372 if (_known_to_link_with_put == accessing_method) { 373 return true; 374 } 375 } else { 376 if (_known_to_link_with_get == accessing_method->holder()) { 377 return true; 378 } 379 } 380 381 LinkInfo link_info(_holder->get_instanceKlass(), 382 _name->get_symbol(), _signature->get_symbol(), 383 accessing_method->get_Method()); 384 fieldDescriptor result; 385 LinkResolver::resolve_field(result, link_info, bc, false, KILL_COMPILE_ON_FATAL_(false)); 386 387 // update the hit-cache, unless there is a problem with memory scoping: 388 if (accessing_method->holder()->is_shared() || !is_shared()) { 389 if (is_put) { 390 _known_to_link_with_put = accessing_method; 391 } else { 392 _known_to_link_with_get = accessing_method->holder(); 393 } 394 } 395 396 return true; 397 } 398 399 // ------------------------------------------------------------------ 400 // ciField::print 401 void ciField::print() { 402 tty->print("<ciField name="); 403 _holder->print_name(); 404 tty->print("."); 405 _name->print_symbol(); 406 tty->print(" signature="); 407 _signature->print_symbol(); 408 tty->print(" offset=%d type=", _offset); 409 if (_type != NULL) 410 _type->print_name(); 411 else 412 tty->print("(reference)"); 413 tty->print(" flags=%04x", flags().as_int()); 414 tty->print(" is_constant=%s", bool_to_str(_is_constant)); 415 if (_is_constant && is_static()) { 416 tty->print(" constant_value="); 417 _constant_value.print(); 418 } 419 tty->print(">"); 420 } 421 422 // ------------------------------------------------------------------ 423 // ciField::print_name_on 424 // 425 // Print the name of this field 426 void ciField::print_name_on(outputStream* st) { 427 name()->print_symbol_on(st); 428 }