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