Fri, 27 Feb 2009 13:27:09 -0800
6810672: Comment typos
Summary: I have collected some typos I have found while looking at the code.
Reviewed-by: kvn, never
duke@435 | 1 | /* |
xdono@905 | 2 | * Copyright 1997-2008 Sun Microsystems, Inc. All Rights Reserved. |
duke@435 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@435 | 4 | * |
duke@435 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@435 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@435 | 7 | * published by the Free Software Foundation. |
duke@435 | 8 | * |
duke@435 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@435 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@435 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@435 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@435 | 13 | * accompanied this code). |
duke@435 | 14 | * |
duke@435 | 15 | * You should have received a copy of the GNU General Public License version |
duke@435 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@435 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@435 | 18 | * |
duke@435 | 19 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@435 | 20 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@435 | 21 | * have any questions. |
duke@435 | 22 | * |
duke@435 | 23 | */ |
duke@435 | 24 | |
duke@435 | 25 | // Parser for for .class files |
duke@435 | 26 | // |
duke@435 | 27 | // The bytes describing the class file structure is read from a Stream object |
duke@435 | 28 | |
duke@435 | 29 | class ClassFileParser VALUE_OBJ_CLASS_SPEC { |
duke@435 | 30 | private: |
duke@435 | 31 | bool _need_verify; |
duke@435 | 32 | bool _relax_verify; |
duke@435 | 33 | u2 _major_version; |
duke@435 | 34 | u2 _minor_version; |
duke@435 | 35 | symbolHandle _class_name; |
jrose@866 | 36 | GrowableArray<Handle>* _cp_patches; // overrides for CP entries |
duke@435 | 37 | |
duke@435 | 38 | bool _has_finalizer; |
duke@435 | 39 | bool _has_empty_finalizer; |
duke@435 | 40 | bool _has_vanilla_constructor; |
duke@435 | 41 | |
duke@435 | 42 | enum { fixed_buffer_size = 128 }; |
duke@435 | 43 | u_char linenumbertable_buffer[fixed_buffer_size]; |
duke@435 | 44 | |
duke@435 | 45 | ClassFileStream* _stream; // Actual input stream |
duke@435 | 46 | |
duke@435 | 47 | enum { LegalClass, LegalField, LegalMethod }; // used to verify unqualified names |
duke@435 | 48 | |
duke@435 | 49 | // Accessors |
duke@435 | 50 | ClassFileStream* stream() { return _stream; } |
duke@435 | 51 | void set_stream(ClassFileStream* st) { _stream = st; } |
duke@435 | 52 | |
duke@435 | 53 | // Constant pool parsing |
duke@435 | 54 | void parse_constant_pool_entries(constantPoolHandle cp, int length, TRAPS); |
duke@435 | 55 | |
duke@435 | 56 | constantPoolHandle parse_constant_pool(TRAPS); |
duke@435 | 57 | |
duke@435 | 58 | // Interface parsing |
duke@435 | 59 | objArrayHandle parse_interfaces(constantPoolHandle cp, |
duke@435 | 60 | int length, |
duke@435 | 61 | Handle class_loader, |
duke@435 | 62 | Handle protection_domain, |
duke@435 | 63 | PerfTraceTime* vmtimer, |
duke@435 | 64 | symbolHandle class_name, |
duke@435 | 65 | TRAPS); |
duke@435 | 66 | |
duke@435 | 67 | // Field parsing |
duke@435 | 68 | void parse_field_attributes(constantPoolHandle cp, u2 attributes_count, |
duke@435 | 69 | bool is_static, u2 signature_index, |
duke@435 | 70 | u2* constantvalue_index_addr, |
duke@435 | 71 | bool* is_synthetic_addr, |
duke@435 | 72 | u2* generic_signature_index_addr, |
duke@435 | 73 | typeArrayHandle* field_annotations, TRAPS); |
duke@435 | 74 | typeArrayHandle parse_fields(constantPoolHandle cp, bool is_interface, |
duke@435 | 75 | struct FieldAllocationCount *fac, |
duke@435 | 76 | objArrayHandle* fields_annotations, TRAPS); |
duke@435 | 77 | |
duke@435 | 78 | // Method parsing |
duke@435 | 79 | methodHandle parse_method(constantPoolHandle cp, bool is_interface, |
duke@435 | 80 | AccessFlags* promoted_flags, |
duke@435 | 81 | typeArrayHandle* method_annotations, |
duke@435 | 82 | typeArrayHandle* method_parameter_annotations, |
duke@435 | 83 | typeArrayHandle* method_default_annotations, |
duke@435 | 84 | TRAPS); |
duke@435 | 85 | objArrayHandle parse_methods (constantPoolHandle cp, bool is_interface, |
duke@435 | 86 | AccessFlags* promoted_flags, |
duke@435 | 87 | bool* has_final_method, |
duke@435 | 88 | objArrayOop* methods_annotations_oop, |
duke@435 | 89 | objArrayOop* methods_parameter_annotations_oop, |
duke@435 | 90 | objArrayOop* methods_default_annotations_oop, |
duke@435 | 91 | TRAPS); |
duke@435 | 92 | typeArrayHandle sort_methods (objArrayHandle methods, |
duke@435 | 93 | objArrayHandle methods_annotations, |
duke@435 | 94 | objArrayHandle methods_parameter_annotations, |
duke@435 | 95 | objArrayHandle methods_default_annotations, |
duke@435 | 96 | TRAPS); |
duke@435 | 97 | typeArrayHandle parse_exception_table(u4 code_length, u4 exception_table_length, |
duke@435 | 98 | constantPoolHandle cp, TRAPS); |
duke@435 | 99 | void parse_linenumber_table( |
duke@435 | 100 | u4 code_attribute_length, u4 code_length, |
duke@435 | 101 | CompressedLineNumberWriteStream** write_stream, TRAPS); |
duke@435 | 102 | u2* parse_localvariable_table(u4 code_length, u2 max_locals, u4 code_attribute_length, |
duke@435 | 103 | constantPoolHandle cp, u2* localvariable_table_length, |
duke@435 | 104 | bool isLVTT, TRAPS); |
duke@435 | 105 | u2* parse_checked_exceptions(u2* checked_exceptions_length, u4 method_attribute_length, |
duke@435 | 106 | constantPoolHandle cp, TRAPS); |
duke@435 | 107 | void parse_type_array(u2 array_length, u4 code_length, u4* u1_index, u4* u2_index, |
duke@435 | 108 | u1* u1_array, u2* u2_array, constantPoolHandle cp, TRAPS); |
duke@435 | 109 | typeArrayOop parse_stackmap_table(u4 code_attribute_length, TRAPS); |
duke@435 | 110 | |
duke@435 | 111 | // Classfile attribute parsing |
duke@435 | 112 | void parse_classfile_sourcefile_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS); |
duke@435 | 113 | void parse_classfile_source_debug_extension_attribute(constantPoolHandle cp, |
duke@435 | 114 | instanceKlassHandle k, int length, TRAPS); |
duke@435 | 115 | u2 parse_classfile_inner_classes_attribute(constantPoolHandle cp, |
duke@435 | 116 | instanceKlassHandle k, TRAPS); |
duke@435 | 117 | void parse_classfile_attributes(constantPoolHandle cp, instanceKlassHandle k, TRAPS); |
duke@435 | 118 | void parse_classfile_synthetic_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS); |
duke@435 | 119 | void parse_classfile_signature_attribute(constantPoolHandle cp, instanceKlassHandle k, TRAPS); |
duke@435 | 120 | |
duke@435 | 121 | // Annotations handling |
duke@435 | 122 | typeArrayHandle assemble_annotations(u1* runtime_visible_annotations, |
duke@435 | 123 | int runtime_visible_annotations_length, |
duke@435 | 124 | u1* runtime_invisible_annotations, |
duke@435 | 125 | int runtime_invisible_annotations_length, TRAPS); |
duke@435 | 126 | |
duke@435 | 127 | // Final setup |
duke@435 | 128 | int compute_oop_map_size(instanceKlassHandle super, int nonstatic_oop_count, |
duke@435 | 129 | int first_nonstatic_oop_offset); |
duke@435 | 130 | void fill_oop_maps(instanceKlassHandle k, int nonstatic_oop_map_count, |
duke@435 | 131 | u2* nonstatic_oop_offsets, u2* nonstatic_oop_length); |
duke@435 | 132 | void set_precomputed_flags(instanceKlassHandle k); |
duke@435 | 133 | objArrayHandle compute_transitive_interfaces(instanceKlassHandle super, |
duke@435 | 134 | objArrayHandle local_ifs, TRAPS); |
duke@435 | 135 | |
duke@435 | 136 | // Special handling for certain classes. |
duke@435 | 137 | // Add the "discovered" field to java.lang.ref.Reference if |
duke@435 | 138 | // it does not exist. |
duke@435 | 139 | void java_lang_ref_Reference_fix_pre(typeArrayHandle* fields_ptr, |
duke@435 | 140 | constantPoolHandle cp, FieldAllocationCount *fac_ptr, TRAPS); |
duke@435 | 141 | // Adjust the field allocation counts for java.lang.Class to add |
duke@435 | 142 | // fake fields. |
duke@435 | 143 | void java_lang_Class_fix_pre(objArrayHandle* methods_ptr, |
duke@435 | 144 | FieldAllocationCount *fac_ptr, TRAPS); |
duke@435 | 145 | // Adjust the next_nonstatic_oop_offset to place the fake fields |
duke@435 | 146 | // before any Java fields. |
duke@435 | 147 | void java_lang_Class_fix_post(int* next_nonstatic_oop_offset); |
duke@435 | 148 | |
duke@435 | 149 | // Format checker methods |
duke@435 | 150 | void classfile_parse_error(const char* msg, TRAPS); |
duke@435 | 151 | void classfile_parse_error(const char* msg, int index, TRAPS); |
duke@435 | 152 | void classfile_parse_error(const char* msg, const char *name, TRAPS); |
duke@435 | 153 | void classfile_parse_error(const char* msg, int index, const char *name, TRAPS); |
duke@435 | 154 | inline void guarantee_property(bool b, const char* msg, TRAPS) { |
duke@435 | 155 | if (!b) { classfile_parse_error(msg, CHECK); } |
duke@435 | 156 | } |
duke@435 | 157 | |
duke@435 | 158 | inline void assert_property(bool b, const char* msg, TRAPS) { |
duke@435 | 159 | #ifdef ASSERT |
duke@435 | 160 | if (!b) { fatal(msg); } |
duke@435 | 161 | #endif |
duke@435 | 162 | } |
duke@435 | 163 | |
duke@435 | 164 | inline void check_property(bool property, const char* msg, int index, TRAPS) { |
duke@435 | 165 | if (_need_verify) { |
duke@435 | 166 | guarantee_property(property, msg, index, CHECK); |
duke@435 | 167 | } else { |
duke@435 | 168 | assert_property(property, msg, CHECK); |
duke@435 | 169 | } |
duke@435 | 170 | } |
duke@435 | 171 | |
duke@435 | 172 | inline void check_property(bool property, const char* msg, TRAPS) { |
duke@435 | 173 | if (_need_verify) { |
duke@435 | 174 | guarantee_property(property, msg, CHECK); |
duke@435 | 175 | } else { |
duke@435 | 176 | assert_property(property, msg, CHECK); |
duke@435 | 177 | } |
duke@435 | 178 | } |
duke@435 | 179 | |
duke@435 | 180 | inline void guarantee_property(bool b, const char* msg, int index, TRAPS) { |
duke@435 | 181 | if (!b) { classfile_parse_error(msg, index, CHECK); } |
duke@435 | 182 | } |
duke@435 | 183 | inline void guarantee_property(bool b, const char* msg, const char *name, TRAPS) { |
duke@435 | 184 | if (!b) { classfile_parse_error(msg, name, CHECK); } |
duke@435 | 185 | } |
duke@435 | 186 | inline void guarantee_property(bool b, const char* msg, int index, const char *name, TRAPS) { |
duke@435 | 187 | if (!b) { classfile_parse_error(msg, index, name, CHECK); } |
duke@435 | 188 | } |
duke@435 | 189 | |
duke@435 | 190 | bool is_supported_version(u2 major, u2 minor); |
duke@435 | 191 | bool has_illegal_visibility(jint flags); |
duke@435 | 192 | |
duke@435 | 193 | void verify_constantvalue(int constantvalue_index, int signature_index, constantPoolHandle cp, TRAPS); |
duke@435 | 194 | void verify_legal_utf8(const unsigned char* buffer, int length, TRAPS); |
duke@435 | 195 | void verify_legal_class_name(symbolHandle name, TRAPS); |
duke@435 | 196 | void verify_legal_field_name(symbolHandle name, TRAPS); |
duke@435 | 197 | void verify_legal_method_name(symbolHandle name, TRAPS); |
duke@435 | 198 | void verify_legal_field_signature(symbolHandle fieldname, symbolHandle signature, TRAPS); |
duke@435 | 199 | int verify_legal_method_signature(symbolHandle methodname, symbolHandle signature, TRAPS); |
duke@435 | 200 | void verify_legal_class_modifiers(jint flags, TRAPS); |
duke@435 | 201 | void verify_legal_field_modifiers(jint flags, bool is_interface, TRAPS); |
duke@435 | 202 | void verify_legal_method_modifiers(jint flags, bool is_interface, symbolHandle name, TRAPS); |
duke@435 | 203 | bool verify_unqualified_name(char* name, unsigned int length, int type); |
duke@435 | 204 | char* skip_over_field_name(char* name, bool slash_ok, unsigned int length); |
duke@435 | 205 | char* skip_over_field_signature(char* signature, bool void_ok, unsigned int length, TRAPS); |
duke@435 | 206 | |
jrose@866 | 207 | bool has_cp_patch_at(int index) { |
jrose@866 | 208 | assert(AnonymousClasses, ""); |
jrose@866 | 209 | assert(index >= 0, "oob"); |
jrose@866 | 210 | return (_cp_patches != NULL |
jrose@866 | 211 | && index < _cp_patches->length() |
jrose@866 | 212 | && _cp_patches->adr_at(index)->not_null()); |
jrose@866 | 213 | } |
jrose@866 | 214 | Handle cp_patch_at(int index) { |
jrose@866 | 215 | assert(has_cp_patch_at(index), "oob"); |
jrose@866 | 216 | return _cp_patches->at(index); |
jrose@866 | 217 | } |
jrose@866 | 218 | Handle clear_cp_patch_at(int index) { |
jrose@866 | 219 | Handle patch = cp_patch_at(index); |
jrose@866 | 220 | _cp_patches->at_put(index, Handle()); |
jrose@866 | 221 | assert(!has_cp_patch_at(index), ""); |
jrose@866 | 222 | return patch; |
jrose@866 | 223 | } |
jrose@866 | 224 | void patch_constant_pool(constantPoolHandle cp, int index, Handle patch, TRAPS); |
jrose@866 | 225 | |
jrose@866 | 226 | // Wrapper for constantTag.is_klass_[or_]reference. |
jrose@866 | 227 | // In older versions of the VM, klassOops cannot sneak into early phases of |
jrose@866 | 228 | // constant pool construction, but in later versions they can. |
jrose@866 | 229 | // %%% Let's phase out the old is_klass_reference. |
jrose@866 | 230 | bool is_klass_reference(constantPoolHandle cp, int index) { |
jrose@866 | 231 | return ((LinkWellKnownClasses || AnonymousClasses) |
jrose@866 | 232 | ? cp->tag_at(index).is_klass_or_reference() |
jrose@866 | 233 | : cp->tag_at(index).is_klass_reference()); |
jrose@866 | 234 | } |
jrose@866 | 235 | |
duke@435 | 236 | public: |
duke@435 | 237 | // Constructor |
duke@435 | 238 | ClassFileParser(ClassFileStream* st) { set_stream(st); } |
duke@435 | 239 | |
duke@435 | 240 | // Parse .class file and return new klassOop. The klassOop is not hooked up |
duke@435 | 241 | // to the system dictionary or any other structures, so a .class file can |
duke@435 | 242 | // be loaded several times if desired. |
duke@435 | 243 | // The system dictionary hookup is done by the caller. |
duke@435 | 244 | // |
duke@435 | 245 | // "parsed_name" is updated by this method, and is the name found |
duke@435 | 246 | // while parsing the stream. |
duke@435 | 247 | instanceKlassHandle parseClassFile(symbolHandle name, |
duke@435 | 248 | Handle class_loader, |
duke@435 | 249 | Handle protection_domain, |
duke@435 | 250 | symbolHandle& parsed_name, |
jrose@866 | 251 | TRAPS) { |
jrose@866 | 252 | return parseClassFile(name, class_loader, protection_domain, NULL, parsed_name, THREAD); |
jrose@866 | 253 | } |
jrose@866 | 254 | instanceKlassHandle parseClassFile(symbolHandle name, |
jrose@866 | 255 | Handle class_loader, |
jrose@866 | 256 | Handle protection_domain, |
jrose@866 | 257 | GrowableArray<Handle>* cp_patches, |
jrose@866 | 258 | symbolHandle& parsed_name, |
duke@435 | 259 | TRAPS); |
duke@435 | 260 | |
duke@435 | 261 | // Verifier checks |
duke@435 | 262 | static void check_super_class_access(instanceKlassHandle this_klass, TRAPS); |
duke@435 | 263 | static void check_super_interface_access(instanceKlassHandle this_klass, TRAPS); |
duke@435 | 264 | static void check_final_method_override(instanceKlassHandle this_klass, TRAPS); |
duke@435 | 265 | static void check_illegal_static_method(instanceKlassHandle this_klass, TRAPS); |
duke@435 | 266 | }; |