1 /*
  2  * Copyright (c) 2003, 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 #include "precompiled.hpp"
 26 #include "cds/cdsConfig.hpp"
 27 #include "classfile/symbolTable.hpp"
 28 #include "classfile/systemDictionary.hpp"
 29 #include "classfile/systemDictionaryShared.hpp"
 30 #include "classfile/verificationType.hpp"
 31 #include "classfile/verifier.hpp"
 32 #include "classfile/vmClasses.hpp"
 33 #include "classfile/vmSymbols.hpp"
 34 #include "logging/log.hpp"
 35 #include "oops/klass.inline.hpp"
 36 #include "runtime/handles.inline.hpp"
 37 
 38 VerificationType VerificationType::from_tag(u1 tag) {
 39   switch (tag) {
 40     case ITEM_Top:     return bogus_type();
 41     case ITEM_Integer: return integer_type();
 42     case ITEM_Float:   return float_type();
 43     case ITEM_Double:  return double_type();
 44     case ITEM_Long:    return long_type();
 45     case ITEM_Null:    return null_type();
 46     default:
 47       ShouldNotReachHere();
 48       return bogus_type();
 49   }
 50 }
 51 
 52 bool VerificationType::resolve_and_check_assignability(InstanceKlass* klass, Symbol* name,
 53          Symbol* from_name, bool from_field_is_protected, bool from_is_array, bool from_is_object, TRAPS) {
 54   HandleMark hm(THREAD);
 55   Klass* this_class;
 56   if (klass->is_hidden() && klass->name() == name) {
 57     this_class = klass;
 58   } else {
 59     this_class = SystemDictionary::resolve_or_fail(
 60       name, Handle(THREAD, klass->class_loader()),
 61       Handle(THREAD, klass->protection_domain()), true, CHECK_false);
 62     if (log_is_enabled(Debug, class, resolve)) {
 63       Verifier::trace_class_resolution(this_class, klass);
 64     }
 65   }
 66 
 67   // Need to do this check when called from CDS.
 68   // if (this_class->access_flags().is_primitive_class()) {
 69   //   Klass* from_class = SystemDictionary::resolve_or_fail(
 70   //     from_name, Handle(THREAD, klass->class_loader()),
 71   //     Handle(THREAD, klass->protection_domain()), true, CHECK_false);
 72   //   return from_class == this_class;
 73   // }
 74   if (this_class->is_interface() && (!from_field_is_protected ||
 75       from_name != vmSymbols::java_lang_Object())) {
 76     // If we are not trying to access a protected field or method in
 77     // java.lang.Object then, for arrays, we only allow assignability
 78     // to interfaces java.lang.Cloneable and java.io.Serializable
 79     // Otherwise, we treat interfaces as java.lang.Object.
 80     return !from_is_array ||
 81       this_class == vmClasses::Cloneable_klass() ||
 82       this_class == vmClasses::Serializable_klass();
 83   } else if (from_is_object) {
 84     Klass* from_class;
 85     if (klass->is_hidden() && klass->name() == from_name) {
 86       from_class = klass;
 87     } else {
 88       from_class = SystemDictionary::resolve_or_fail(
 89         from_name, Handle(THREAD, klass->class_loader()),
 90         Handle(THREAD, klass->protection_domain()), true, CHECK_false);
 91       if (log_is_enabled(Debug, class, resolve)) {
 92         Verifier::trace_class_resolution(from_class, klass);
 93       }
 94     }
 95     return from_class->is_subclass_of(this_class);
 96   }
 97 
 98   return false;
 99 }
100 
101 bool VerificationType::is_reference_assignable_from(
102     const VerificationType& from, ClassVerifier* context,
103     bool from_field_is_protected, TRAPS) const {
104   InstanceKlass* klass = context->current_class();
105   if (from.is_null()) {
106     // null is assignable to any reference
107     return true;
108   } else if (is_null()) {
109     return false;
110   } else if (name() == from.name()) {
111     return true;
112   } else if (is_object()) {
113     // We need check the class hierarchy to check assignability
114     if (name() == vmSymbols::java_lang_Object()) {
115       // any object or array is assignable to java.lang.Object
116       return true;
117     }
118 
119     if (CDSConfig::is_dumping_archive()) {
120       if (SystemDictionaryShared::add_verification_constraint(klass,
121               name(), from.name(), from_field_is_protected, from.is_array(),
122               from.is_object())) {
123         // If add_verification_constraint() returns true, the resolution/check should be
124         // delayed until runtime.
125         return true;
126       }
127     }
128 
129     return resolve_and_check_assignability(klass, name(), from.name(),
130           from_field_is_protected, from.is_array(), from.is_object(), THREAD);
131   } else if (is_array() && from.is_array()) {
132     VerificationType comp_this = get_component(context);
133     VerificationType comp_from = from.get_component(context);
134 
135 /*
136     // This code implements non-covariance between inline type arrays and both
137     // arrays of objects and arrays of interface types.  If covariance is
138     // supported for inline type arrays then this code should be removed.
139     if (comp_from.is_inline_type() && !comp_this.is_null() && comp_this.is_reference()) {
140       // An array of inline types is not assignable to an array of java.lang.Objects.
141       if (comp_this.name() == vmSymbols::java_lang_Object()) {
142         return false;
143       }
144 
145       // Need to load 'comp_this' to see if it is an interface.
146       InstanceKlass* klass = context->current_class();
147       {
148         HandleMark hm(THREAD);
149         Klass* comp_this_class = SystemDictionary::resolve_or_fail(
150             comp_this.name(), Handle(THREAD, klass->class_loader()),
151             Handle(THREAD, klass->protection_domain()), true, CHECK_false);
152         klass->class_loader_data()->record_dependency(comp_this_class);
153         if (log_is_enabled(Debug, class, resolve)) {
154           Verifier::trace_class_resolution(comp_this_class, klass);
155         }
156         // An array of inline types is not assignable to an array of interface types.
157         if (comp_this_class->is_interface()) {
158           return false;
159         }
160       }
161     }
162 */
163     if (!comp_this.is_bogus() && !comp_from.is_bogus()) {
164       return comp_this.is_component_assignable_from(comp_from, context,
165                                                     from_field_is_protected, THREAD);
166     }
167   }
168   return false;
169 }
170 
171 bool VerificationType::is_inline_type_assignable_from(const VerificationType& from) const {
172   // Check that 'from' is not null, is an inline type, and is the same inline type.
173   assert(is_inline_type(), "called with a non-inline type");
174   assert(!is_null(), "inline type is not null");
175   return (!from.is_null() && from.is_inline_type() && name() == from.name());
176 }
177 
178 bool VerificationType::is_ref_assignable_from_inline_type(const VerificationType& from, ClassVerifier* context, TRAPS) const {
179   assert(!from.is_null(), "Inline type should not be null");
180   if (!is_null() && (name()->is_same_fundamental_type(from.name()) ||
181       name() == vmSymbols::java_lang_Object())) {
182     return true;
183   }
184 
185   // Need to load 'this' to see if it is an interface or supertype.
186   InstanceKlass* klass = context->current_class();
187   {
188     HandleMark hm(THREAD);
189     Klass* this_class = SystemDictionary::resolve_or_fail(
190         name(), Handle(THREAD, klass->class_loader()),
191         Handle(THREAD, klass->protection_domain()), true, CHECK_false);
192     klass->class_loader_data()->record_dependency(this_class);
193     if (log_is_enabled(Debug, class, resolve)) {
194       Verifier::trace_class_resolution(this_class, klass);
195     }
196     if (this_class->is_interface()) {
197       return true;
198     } else {
199       Klass* from_class = SystemDictionary::resolve_or_fail(
200         from.name(), Handle(THREAD, klass->class_loader()),
201         Handle(THREAD, klass->protection_domain()), true, CHECK_false);
202       if (log_is_enabled(Debug, class, resolve)) {
203         Verifier::trace_class_resolution(from_class, klass);
204       }
205       return from_class->is_subclass_of(this_class);
206     }
207   }
208 }
209 
210 VerificationType VerificationType::get_component(ClassVerifier *context) const {
211   assert(is_array() && name()->utf8_length() >= 2, "Must be a valid array");
212   SignatureStream ss(name(), false);
213   ss.skip_array_prefix(1);
214   switch (ss.type()) {
215     case T_BOOLEAN: return VerificationType(Boolean);
216     case T_BYTE:    return VerificationType(Byte);
217     case T_CHAR:    return VerificationType(Char);
218     case T_SHORT:   return VerificationType(Short);
219     case T_INT:     return VerificationType(Integer);
220     case T_LONG:    return VerificationType(Long);
221     case T_FLOAT:   return VerificationType(Float);
222     case T_DOUBLE:  return VerificationType(Double);
223     case T_ARRAY:
224     case T_OBJECT: {
225       guarantee(ss.is_reference(), "unchecked verifier input?");
226       Symbol* component = ss.as_symbol();
227       // Create another symbol to save as signature stream unreferences this symbol.
228       Symbol* component_copy = context->create_temporary_symbol(component);
229       assert(component_copy == component, "symbols don't match");
230       return VerificationType::reference_type(component_copy);
231    }
232    default:
233      // Met an invalid type signature, e.g. [X
234      return VerificationType::bogus_type();
235   }
236 }
237 
238 void VerificationType::print_on(outputStream* st) const {
239   switch (_u._data) {
240     case Bogus:            st->print("top"); break;
241     case Category1:        st->print("category1"); break;
242     case Category2:        st->print("category2"); break;
243     case Category2_2nd:    st->print("category2_2nd"); break;
244     case Boolean:          st->print("boolean"); break;
245     case Byte:             st->print("byte"); break;
246     case Short:            st->print("short"); break;
247     case Char:             st->print("char"); break;
248     case Integer:          st->print("integer"); break;
249     case Float:            st->print("float"); break;
250     case Long:             st->print("long"); break;
251     case Double:           st->print("double"); break;
252     case Long_2nd:         st->print("long_2nd"); break;
253     case Double_2nd:       st->print("double_2nd"); break;
254     case Null:             st->print("null"); break;
255     case ReferenceQuery:   st->print("reference type"); break;
256     case InlineTypeQuery:  st->print("inline type"); break;
257     case NonScalarQuery:   st->print("reference or inline type"); break;
258     case Category1Query:   st->print("category1 type"); break;
259     case Category2Query:   st->print("category2 type"); break;
260     case Category2_2ndQuery: st->print("category2_2nd type"); break;
261     default:
262       if (is_uninitialized_this()) {
263         st->print("uninitializedThis");
264       } else if (is_uninitialized()) {
265         st->print("uninitialized %d", bci());
266       } else {
267         if (name() != nullptr) {
268           name()->print_value_on(st);
269         } else {
270           st->print_cr("null");
271         }
272       }
273   }
274 }