Tue, 08 Aug 2017 15:57:29 +0800
merge
1 /*
2 * Copyright (c) 2003, 2013, 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 */
25 #ifndef SHARE_VM_OOPS_CONSTMETHODOOP_HPP
26 #define SHARE_VM_OOPS_CONSTMETHODOOP_HPP
28 #include "oops/oop.hpp"
30 // An ConstMethod* represents portions of a Java method which
31 // do not vary.
32 //
33 // Memory layout (each line represents a word). Note that most
34 // applications load thousands of methods, so keeping the size of this
35 // structure small has a big impact on footprint.
36 //
37 // |------------------------------------------------------|
38 // | header |
39 // | klass |
40 // |------------------------------------------------------|
41 // | fingerprint 1 |
42 // | fingerprint 2 |
43 // | constants (oop) |
44 // | stackmap_data (oop) |
45 // | constMethod_size |
46 // | interp_kind | flags | code_size |
47 // | name index | signature index |
48 // | method_idnum | max_stack |
49 // | max_locals | size_of_parameters |
50 // |------------------------------------------------------|
51 // | |
52 // | byte codes |
53 // | |
54 // |------------------------------------------------------|
55 // | compressed linenumber table |
56 // | (see class CompressedLineNumberReadStream) |
57 // | (note that length is unknown until decompressed) |
58 // | (access flags bit tells whether table is present) |
59 // | (indexed from start of ConstMethod*) |
60 // | (elements not necessarily sorted!) |
61 // |------------------------------------------------------|
62 // | localvariable table elements + length (length last) |
63 // | (length is u2, elements are 6-tuples of u2) |
64 // | (see class LocalVariableTableElement) |
65 // | (access flags bit tells whether table is present) |
66 // | (indexed from end of ConstMethod*) |
67 // |------------------------------------------------------|
68 // | exception table + length (length last) |
69 // | (length is u2, elements are 4-tuples of u2) |
70 // | (see class ExceptionTableElement) |
71 // | (access flags bit tells whether table is present) |
72 // | (indexed from end of ConstMethod*) |
73 // |------------------------------------------------------|
74 // | checked exceptions elements + length (length last) |
75 // | (length is u2, elements are u2) |
76 // | (see class CheckedExceptionElement) |
77 // | (access flags bit tells whether table is present) |
78 // | (indexed from end of ConstMethod*) |
79 // |------------------------------------------------------|
80 // | method parameters elements + length (length last) |
81 // | (length is u2, elements are u2, u4 structures) |
82 // | (see class MethodParametersElement) |
83 // | (access flags bit tells whether table is present) |
84 // | (indexed from end of ConstMethod*) |
85 // |------------------------------------------------------|
86 // | generic signature index (u2) |
87 // | (indexed from start of constMethodOop) |
88 // |------------------------------------------------------|
89 // | annotations arrays - method, parameter, type, default|
90 // | pointer to Array<u1> if annotation is present |
91 // |------------------------------------------------------|
92 //
93 // IMPORTANT: If anything gets added here, there need to be changes to
94 // ensure that ServicabilityAgent doesn't get broken as a result!
97 // Utility class describing elements in checked exceptions table inlined in Method*.
98 class CheckedExceptionElement VALUE_OBJ_CLASS_SPEC {
99 public:
100 u2 class_cp_index;
101 };
104 // Utility class describing elements in local variable table inlined in Method*.
105 class LocalVariableTableElement VALUE_OBJ_CLASS_SPEC {
106 public:
107 u2 start_bci;
108 u2 length;
109 u2 name_cp_index;
110 u2 descriptor_cp_index;
111 u2 signature_cp_index;
112 u2 slot;
113 };
115 // Utility class describing elements in exception table
116 class ExceptionTableElement VALUE_OBJ_CLASS_SPEC {
117 public:
118 u2 start_pc;
119 u2 end_pc;
120 u2 handler_pc;
121 u2 catch_type_index;
122 };
124 // Utility class describing elements in method parameters
125 class MethodParametersElement VALUE_OBJ_CLASS_SPEC {
126 public:
127 u2 name_cp_index;
128 u2 flags;
129 };
131 class KlassSizeStats;
133 // Class to collect the sizes of ConstMethod inline tables
134 #define INLINE_TABLES_DO(do_element) \
135 do_element(localvariable_table_length) \
136 do_element(compressed_linenumber_size) \
137 do_element(exception_table_length) \
138 do_element(checked_exceptions_length) \
139 do_element(method_parameters_length) \
140 do_element(generic_signature_index) \
141 do_element(method_annotations_length) \
142 do_element(parameter_annotations_length) \
143 do_element(type_annotations_length) \
144 do_element(default_annotations_length)
146 #define INLINE_TABLE_DECLARE(sym) int _##sym;
147 #define INLINE_TABLE_PARAM(sym) int sym,
148 #define INLINE_TABLE_INIT(sym) _##sym(sym),
149 #define INLINE_TABLE_NULL(sym) _##sym(0),
150 #define INLINE_TABLE_ACCESSOR(sym) int sym() const { return _##sym; }
152 class InlineTableSizes : StackObj {
153 // declarations
154 INLINE_TABLES_DO(INLINE_TABLE_DECLARE)
155 int _end;
156 public:
157 InlineTableSizes(
158 INLINE_TABLES_DO(INLINE_TABLE_PARAM)
159 int end) :
160 INLINE_TABLES_DO(INLINE_TABLE_INIT)
161 _end(end) {}
163 // Default constructor for no inlined tables
164 InlineTableSizes() :
165 INLINE_TABLES_DO(INLINE_TABLE_NULL)
166 _end(0) {}
168 // Accessors
169 INLINE_TABLES_DO(INLINE_TABLE_ACCESSOR)
170 };
171 #undef INLINE_TABLE_ACCESSOR
172 #undef INLINE_TABLE_NULL
173 #undef INLINE_TABLE_INIT
174 #undef INLINE_TABLE_PARAM
175 #undef INLINE_TABLE_DECLARE
178 class ConstMethod : public MetaspaceObj {
179 friend class VMStructs;
181 public:
182 typedef enum { NORMAL, OVERPASS } MethodType;
184 private:
185 enum {
186 _has_linenumber_table = 0x0001,
187 _has_checked_exceptions = 0x0002,
188 _has_localvariable_table = 0x0004,
189 _has_exception_table = 0x0008,
190 _has_generic_signature = 0x0010,
191 _has_method_parameters = 0x0020,
192 _is_overpass = 0x0040,
193 _has_method_annotations = 0x0080,
194 _has_parameter_annotations = 0x0100,
195 _has_type_annotations = 0x0200,
196 _has_default_annotations = 0x0400
197 };
199 // Bit vector of signature
200 // Callers interpret 0=not initialized yet and
201 // -1=too many args to fix, must parse the slow way.
202 // The real initial value is special to account for nonatomicity of 64 bit
203 // loads and stores. This value may updated and read without a lock by
204 // multiple threads, so is volatile.
205 volatile uint64_t _fingerprint;
207 ConstantPool* _constants; // Constant pool
209 // Raw stackmap data for the method
210 Array<u1>* _stackmap_data;
212 int _constMethod_size;
213 u2 _flags;
215 // Size of Java bytecodes allocated immediately after Method*.
216 u2 _code_size;
217 u2 _name_index; // Method name (index in constant pool)
218 u2 _signature_index; // Method signature (index in constant pool)
219 u2 _method_idnum; // unique identification number for the method within the class
220 // initially corresponds to the index into the methods array.
221 // but this may change with redefinition
222 u2 _max_stack; // Maximum number of entries on the expression stack
223 u2 _max_locals; // Number of local variables used by this method
224 u2 _size_of_parameters; // size of the parameter block (receiver + arguments) in words
226 // Constructor
227 ConstMethod(int byte_code_size,
228 InlineTableSizes* sizes,
229 MethodType is_overpass,
230 int size);
231 public:
233 static ConstMethod* allocate(ClassLoaderData* loader_data,
234 int byte_code_size,
235 InlineTableSizes* sizes,
236 MethodType mt,
237 TRAPS);
239 bool is_constMethod() const { return true; }
241 // Inlined tables
242 void set_inlined_tables_length(InlineTableSizes* sizes);
244 bool has_generic_signature() const
245 { return (_flags & _has_generic_signature) != 0; }
247 bool has_linenumber_table() const
248 { return (_flags & _has_linenumber_table) != 0; }
250 bool has_checked_exceptions() const
251 { return (_flags & _has_checked_exceptions) != 0; }
253 bool has_localvariable_table() const
254 { return (_flags & _has_localvariable_table) != 0; }
256 bool has_exception_handler() const
257 { return (_flags & _has_exception_table) != 0; }
259 bool has_method_parameters() const
260 { return (_flags & _has_method_parameters) != 0; }
262 MethodType method_type() const {
263 return ((_flags & _is_overpass) == 0) ? NORMAL : OVERPASS;
264 }
266 void set_method_type(MethodType mt) {
267 if (mt == NORMAL) {
268 _flags &= ~(_is_overpass);
269 } else {
270 _flags |= _is_overpass;
271 }
272 }
274 // constant pool
275 ConstantPool* constants() const { return _constants; }
276 void set_constants(ConstantPool* c) { _constants = c; }
278 Method* method() const;
280 // stackmap table data
281 Array<u1>* stackmap_data() const { return _stackmap_data; }
282 void set_stackmap_data(Array<u1>* sd) { _stackmap_data = sd; }
283 void copy_stackmap_data(ClassLoaderData* loader_data, u1* sd, int length, TRAPS);
284 bool has_stackmap_table() const { return _stackmap_data != NULL; }
286 void init_fingerprint() {
287 const uint64_t initval = CONST64(0x8000000000000000);
288 _fingerprint = initval;
289 }
291 uint64_t fingerprint() const {
292 // Since reads aren't atomic for 64 bits, if any of the high or low order
293 // word is the initial value, return 0. See init_fingerprint for initval.
294 uint high_fp = (uint)(_fingerprint >> 32);
295 if ((int) _fingerprint == 0 || high_fp == 0x80000000) {
296 return 0L;
297 } else {
298 return _fingerprint;
299 }
300 }
302 uint64_t set_fingerprint(uint64_t new_fingerprint) {
303 #ifdef ASSERT
304 // Assert only valid if complete/valid 64 bit _fingerprint value is read.
305 uint64_t oldfp = fingerprint();
306 #endif // ASSERT
307 _fingerprint = new_fingerprint;
308 assert(oldfp == 0L || new_fingerprint == oldfp,
309 "fingerprint cannot change");
310 assert(((new_fingerprint >> 32) != 0x80000000) && (int)new_fingerprint !=0,
311 "fingerprint should call init to set initial value");
312 return new_fingerprint;
313 }
315 // name
316 int name_index() const { return _name_index; }
317 void set_name_index(int index) { _name_index = index; }
319 // signature
320 int signature_index() const { return _signature_index; }
321 void set_signature_index(int index) { _signature_index = index; }
323 // generics support
324 int generic_signature_index() const {
325 if (has_generic_signature()) {
326 return *generic_signature_index_addr();
327 } else {
328 return 0;
329 }
330 }
331 void set_generic_signature_index(u2 index) {
332 assert(has_generic_signature(), "");
333 u2* addr = generic_signature_index_addr();
334 *addr = index;
335 }
337 // Sizing
338 static int header_size() {
339 return sizeof(ConstMethod)/HeapWordSize;
340 }
342 // Size needed
343 static int size(int code_size, InlineTableSizes* sizes);
345 int size() const { return _constMethod_size;}
346 void set_constMethod_size(int size) { _constMethod_size = size; }
347 #if INCLUDE_SERVICES
348 void collect_statistics(KlassSizeStats *sz) const;
349 #endif
351 // code size
352 int code_size() const { return _code_size; }
353 void set_code_size(int size) {
354 assert(max_method_code_size < (1 << 16),
355 "u2 is too small to hold method code size in general");
356 assert(0 <= size && size <= max_method_code_size, "invalid code size");
357 _code_size = size;
358 }
360 // linenumber table - note that length is unknown until decompression,
361 // see class CompressedLineNumberReadStream.
362 u_char* compressed_linenumber_table() const; // not preserved by gc
363 u2* generic_signature_index_addr() const;
364 u2* checked_exceptions_length_addr() const;
365 u2* localvariable_table_length_addr() const;
366 u2* exception_table_length_addr() const;
367 u2* method_parameters_length_addr() const;
369 // checked exceptions
370 int checked_exceptions_length() const;
371 CheckedExceptionElement* checked_exceptions_start() const;
373 // localvariable table
374 int localvariable_table_length() const;
375 LocalVariableTableElement* localvariable_table_start() const;
377 // exception table
378 int exception_table_length() const;
379 ExceptionTableElement* exception_table_start() const;
381 // method parameters table
382 int method_parameters_length() const;
383 MethodParametersElement* method_parameters_start() const;
385 // method annotations
386 bool has_method_annotations() const
387 { return (_flags & _has_method_annotations) != 0; }
389 bool has_parameter_annotations() const
390 { return (_flags & _has_parameter_annotations) != 0; }
392 bool has_type_annotations() const
393 { return (_flags & _has_type_annotations) != 0; }
395 bool has_default_annotations() const
396 { return (_flags & _has_default_annotations) != 0; }
399 AnnotationArray** method_annotations_addr() const;
400 AnnotationArray* method_annotations() const {
401 return has_method_annotations() ? *(method_annotations_addr()) : NULL;
402 }
403 void set_method_annotations(AnnotationArray* anno) {
404 *(method_annotations_addr()) = anno;
405 }
407 AnnotationArray** parameter_annotations_addr() const;
408 AnnotationArray* parameter_annotations() const {
409 return has_parameter_annotations() ? *(parameter_annotations_addr()) : NULL;
410 }
411 void set_parameter_annotations(AnnotationArray* anno) {
412 *(parameter_annotations_addr()) = anno;
413 }
415 AnnotationArray** type_annotations_addr() const;
416 AnnotationArray* type_annotations() const {
417 return has_type_annotations() ? *(type_annotations_addr()) : NULL;
418 }
419 void set_type_annotations(AnnotationArray* anno) {
420 *(type_annotations_addr()) = anno;
421 }
423 AnnotationArray** default_annotations_addr() const;
424 AnnotationArray* default_annotations() const {
425 return has_default_annotations() ? *(default_annotations_addr()) : NULL;
426 }
427 void set_default_annotations(AnnotationArray* anno) {
428 *(default_annotations_addr()) = anno;
429 }
431 int method_annotations_length() const {
432 return has_method_annotations() ? method_annotations()->length() : 0;
433 }
434 int parameter_annotations_length() const {
435 return has_parameter_annotations() ? parameter_annotations()->length() : 0;
436 }
437 int type_annotations_length() const {
438 return has_type_annotations() ? type_annotations()->length() : 0;
439 }
440 int default_annotations_length() const {
441 return has_default_annotations() ? default_annotations()->length() : 0;
442 }
444 // Copy annotations from other ConstMethod
445 void copy_annotations_from(ConstMethod* cm);
447 // byte codes
448 void set_code(address code) {
449 if (code_size() > 0) {
450 memcpy(code_base(), code, code_size());
451 }
452 }
453 address code_base() const { return (address) (this+1); }
454 address code_end() const { return code_base() + code_size(); }
455 bool contains(address bcp) const { return code_base() <= bcp
456 && bcp < code_end(); }
457 // Offset to bytecodes
458 static ByteSize codes_offset()
459 { return in_ByteSize(sizeof(ConstMethod)); }
461 static ByteSize constants_offset()
462 { return byte_offset_of(ConstMethod, _constants); }
464 static ByteSize max_stack_offset()
465 { return byte_offset_of(ConstMethod, _max_stack); }
466 static ByteSize size_of_locals_offset()
467 { return byte_offset_of(ConstMethod, _max_locals); }
468 static ByteSize size_of_parameters_offset()
469 { return byte_offset_of(ConstMethod, _size_of_parameters); }
472 // Unique id for the method
473 static const u2 MAX_IDNUM;
474 static const u2 UNSET_IDNUM;
475 u2 method_idnum() const { return _method_idnum; }
476 void set_method_idnum(u2 idnum) { _method_idnum = idnum; }
478 // max stack
479 int max_stack() const { return _max_stack; }
480 void set_max_stack(int size) { _max_stack = size; }
482 // max locals
483 int max_locals() const { return _max_locals; }
484 void set_max_locals(int size) { _max_locals = size; }
486 // size of parameters
487 int size_of_parameters() const { return _size_of_parameters; }
488 void set_size_of_parameters(int size) { _size_of_parameters = size; }
490 // Deallocation for RedefineClasses
491 void deallocate_contents(ClassLoaderData* loader_data);
492 bool is_klass() const { return false; }
493 DEBUG_ONLY(bool on_stack() { return false; })
495 private:
496 // Since the size of the compressed line number table is unknown, the
497 // offsets of the other variable sized sections are computed backwards
498 // from the end of the ConstMethod*.
500 // First byte after ConstMethod*
501 address constMethod_end() const
502 { return (address)((intptr_t*)this + _constMethod_size); }
504 // Last short in ConstMethod*
505 u2* last_u2_element() const;
507 public:
508 // Printing
509 void print_on (outputStream* st) const;
510 void print_value_on(outputStream* st) const;
512 const char* internal_name() const { return "{constMethod}"; }
514 // Verify
515 void verify_on(outputStream* st);
516 };
518 #endif // SHARE_VM_OOPS_CONSTMETHODOOP_HPP