1 /*
2 * Copyright (c) 1997, 2012, 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 #ifndef SHARE_VM_OOPS_METHODOOP_HPP
26 #define SHARE_VM_OOPS_METHODOOP_HPP
27
28 #include "classfile/vmSymbols.hpp"
29 #include "code/compressedStream.hpp"
30 #include "compiler/oopMap.hpp"
31 #include "interpreter/invocationCounter.hpp"
32 #include "oops/constMethodOop.hpp"
33 #include "oops/constantPoolOop.hpp"
34 #include "oops/instanceKlass.hpp"
35 #include "oops/oop.hpp"
36 #include "oops/typeArrayOop.hpp"
37 #include "utilities/accessFlags.hpp"
38 #include "utilities/growableArray.hpp"
39
40 // A methodOop represents a Java method.
41 //
42 // Memory layout (each line represents a word). Note that most applications load thousands of methods,
43 // so keeping the size of this structure small has a big impact on footprint.
44 //
45 // We put all oops and method_size first for better gc cache locality.
46 //
47 // The actual bytecodes are inlined after the end of the methodOopDesc struct.
48 //
49 // There are bits in the access_flags telling whether inlined tables are present.
50 // Note that accessing the line number and local variable tables is not performance critical at all.
51 // Accessing the checked exceptions table is used by reflection, so we put that last to make access
52 // to it fast.
53 //
54 // The line number table is compressed and inlined following the byte codes. It is found as the first
55 // byte following the byte codes. The checked exceptions table and the local variable table are inlined
56 // after the line number table, and indexed from the end of the method. We do not compress the checked
57 // exceptions table since the average length is less than 2, and do not bother to compress the local
58 // variable table either since it is mostly absent.
59 //
60 // Note that native_function and signature_handler has to be at fixed offsets (required by the interpreter)
61 //
62 // |------------------------------------------------------|
63 // | header |
64 // | klass |
65 // |------------------------------------------------------|
66 // | constMethodOop (oop) |
67 // |------------------------------------------------------|
68 // | methodData (oop) |
69 // | interp_invocation_count |
70 // |------------------------------------------------------|
71 // | access_flags |
72 // | vtable_index |
73 // |------------------------------------------------------|
74 // | result_index (C++ interpreter only) |
75 // |------------------------------------------------------|
76 // | method_size | max_stack |
77 // | max_locals | size_of_parameters |
78 // |------------------------------------------------------|
79 // |intrinsic_id| flags | throwout_count |
80 // |------------------------------------------------------|
81 // | num_breakpoints | (unused) |
82 // |------------------------------------------------------|
83 // | invocation_counter |
84 // | backedge_counter |
85 // |------------------------------------------------------|
86 // | prev_time (tiered only, 64 bit wide) |
87 // | |
88 // |------------------------------------------------------|
89 // | rate (tiered) |
90 // |------------------------------------------------------|
91 // | code (pointer) |
92 // | i2i (pointer) |
93 // | adapter (pointer) |
94 // | from_compiled_entry (pointer) |
95 // | from_interpreted_entry (pointer) |
96 // |------------------------------------------------------|
97 // | native_function (present only if native) |
98 // | signature_handler (present only if native) |
99 // |------------------------------------------------------|
100
101
102 class CheckedExceptionElement;
103 class LocalVariableTableElement;
104 class AdapterHandlerEntry;
105 class methodDataOopDesc;
106
107 class methodOopDesc : public oopDesc {
108 friend class methodKlass;
109 friend class VMStructs;
110 private:
111 constMethodOop _constMethod; // Method read-only data.
112 methodDataOop _method_data;
113 int _interpreter_invocation_count; // Count of times invoked (reused as prev_event_count in tiered)
114 AccessFlags _access_flags; // Access flags
115 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
116 // note: can have vtables with >2**16 elements (because of inheritance)
117 #ifdef CC_INTERP
118 int _result_index; // C++ interpreter needs for converting results to/from stack
119 #endif
120 u2 _method_size; // size of this object
121 u2 _max_stack; // Maximum number of entries on the expression stack
122 u2 _max_locals; // Number of local variables used by this method
123 u2 _size_of_parameters; // size of the parameter block (receiver + arguments) in words
124 u1 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
125 u1 _jfr_towrite : 1, // Flags
126 : 7;
127 u2 _interpreter_throwout_count; // Count of times method was exited via exception while interpreting
128 u2 _number_of_breakpoints; // fullspeed debugging support
129 InvocationCounter _invocation_counter; // Incremented before each activation of the method - used to trigger frequency-based optimizations
130 InvocationCounter _backedge_counter; // Incremented before each backedge taken - used to trigger frequencey-based optimizations
131
132 #ifdef TIERED
133 jlong _prev_time; // Previous time the rate was acquired
134 float _rate; // Events (invocation and backedge counter increments) per millisecond
135 #endif
136
137 #ifndef PRODUCT
138 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
139 #endif
140 // Entry point for calling both from and to the interpreter.
141 address _i2i_entry; // All-args-on-stack calling convention
142 // Adapter blob (i2c/c2i) for this methodOop. Set once when method is linked.
143 AdapterHandlerEntry* _adapter;
144 // Entry point for calling from compiled code, to compiled code if it exists
145 // or else the interpreter.
146 volatile address _from_compiled_entry; // Cache of: _code ? _code->entry_point() : _adapter->c2i_entry()
147 // The entry point for calling both from and to compiled code is
148 // "_code->entry_point()". Because of tiered compilation and de-opt, this
149 // field can come and go. It can transition from NULL to not-null at any
150 // time (whenever a compile completes). It can transition from not-null to
151 // NULL only at safepoints (because of a de-opt).
152 nmethod* volatile _code; // Points to the corresponding piece of native code
153 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
154
155 public:
156
157 // accessors for instance variables
158 constMethodOop constMethod() const { return _constMethod; }
159 void set_constMethod(constMethodOop xconst) { oop_store_without_check((oop*)&_constMethod, (oop)xconst); }
160
161
162 static address make_adapters(methodHandle mh, TRAPS);
163 volatile address from_compiled_entry() const { return (address)OrderAccess::load_ptr_acquire(&_from_compiled_entry); }
164 volatile address from_interpreted_entry() const{ return (address)OrderAccess::load_ptr_acquire(&_from_interpreted_entry); }
165
166 // access flag
167 AccessFlags access_flags() const { return _access_flags; }
168 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
169
170 // name
171 Symbol* name() const { return constants()->symbol_at(name_index()); }
172 int name_index() const { return constMethod()->name_index(); }
173 void set_name_index(int index) { constMethod()->set_name_index(index); }
174
175 // signature
176 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
177 int signature_index() const { return constMethod()->signature_index(); }
178 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
179
180 // generics support
181 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
182 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
183 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
184
185 // annotations support
186 typeArrayOop annotations() const { return instanceKlass::cast(method_holder())->get_method_annotations_of(method_idnum()); }
187 typeArrayOop parameter_annotations() const { return instanceKlass::cast(method_holder())->get_method_parameter_annotations_of(method_idnum()); }
188 typeArrayOop annotation_default() const { return instanceKlass::cast(method_holder())->get_method_default_annotations_of(method_idnum()); }
189
190 #ifdef CC_INTERP
191 void set_result_index(BasicType type);
192 int result_index() { return _result_index; }
193 #endif
194
195 // Helper routine: get klass name + "." + method name + signature as
196 // C string, for the purpose of providing more useful NoSuchMethodErrors
197 // and fatal error handling. The string is allocated in resource
198 // area if a buffer is not provided by the caller.
199 char* name_and_sig_as_C_string();
200 char* name_and_sig_as_C_string(char* buf, int size);
201
202 // Static routine in the situations we don't have a methodOop
203 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
204 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
205
206 Bytecodes::Code java_code_at(int bci) const {
207 return Bytecodes::java_code_at(this, bcp_from(bci));
208 }
209 Bytecodes::Code code_at(int bci) const {
210 return Bytecodes::code_at(this, bcp_from(bci));
211 }
212
213 // JVMTI breakpoints
214 Bytecodes::Code orig_bytecode_at(int bci) const;
215 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
216 void set_breakpoint(int bci);
217 void clear_breakpoint(int bci);
218 void clear_all_breakpoints();
219 // Tracking number of breakpoints, for fullspeed debugging.
220 // Only mutated by VM thread.
221 u2 number_of_breakpoints() const { return _number_of_breakpoints; }
222 void incr_number_of_breakpoints() { ++_number_of_breakpoints; }
223 void decr_number_of_breakpoints() { --_number_of_breakpoints; }
224 // Initialization only
225 void clear_number_of_breakpoints() { _number_of_breakpoints = 0; }
226
227 // index into instanceKlass methods() array
228 // note: also used by jfr
229 u2 method_idnum() const { return constMethod()->method_idnum(); }
230 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
231
232 // code size
233 int code_size() const { return constMethod()->code_size(); }
234
235 // method size
236 int method_size() const { return _method_size; }
237 void set_method_size(int size) {
238 assert(0 <= size && size < (1 << 16), "invalid method size");
239 _method_size = size;
240 }
241
242 // constant pool for klassOop holding this method
243 constantPoolOop constants() const { return constMethod()->constants(); }
244 void set_constants(constantPoolOop c) { constMethod()->set_constants(c); }
245
246 // max stack
247 int max_stack() const { return _max_stack; }
248 void set_max_stack(int size) { _max_stack = size; }
249
250 // max locals
251 int max_locals() const { return _max_locals; }
252 void set_max_locals(int size) { _max_locals = size; }
253
254 int highest_comp_level() const;
255 void set_highest_comp_level(int level);
256 int highest_osr_comp_level() const;
257 void set_highest_osr_comp_level(int level);
258
259 // Count of times method was exited via exception while interpreting
260 void interpreter_throwout_increment() {
261 if (_interpreter_throwout_count < 65534) {
262 _interpreter_throwout_count++;
263 }
264 }
265
266 int interpreter_throwout_count() const { return _interpreter_throwout_count; }
267 void set_interpreter_throwout_count(int count) { _interpreter_throwout_count = count; }
268
269 // size of parameters
270 int size_of_parameters() const { return _size_of_parameters; }
271
272 bool has_stackmap_table() const {
273 return constMethod()->has_stackmap_table();
274 }
275
276 typeArrayOop stackmap_data() const {
277 return constMethod()->stackmap_data();
278 }
279
280 void set_stackmap_data(typeArrayOop sd) {
281 constMethod()->set_stackmap_data(sd);
282 }
283
284 // exception handler table
285 typeArrayOop exception_table() const
286 { return constMethod()->exception_table(); }
287 void set_exception_table(typeArrayOop e)
288 { constMethod()->set_exception_table(e); }
289 bool has_exception_handler() const
290 { return constMethod()->has_exception_handler(); }
291
292 // Finds the first entry point bci of an exception handler for an
293 // exception of klass ex_klass thrown at throw_bci. A value of NULL
294 // for ex_klass indicates that the exception klass is not known; in
295 // this case it matches any constraint class. Returns -1 if the
296 // exception cannot be handled in this method. The handler
297 // constraint classes are loaded if necessary. Note that this may
298 // throw an exception if loading of the constraint classes causes
299 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
300 // If an exception is thrown, returns the bci of the
301 // exception handler which caused the exception to be thrown, which
302 // is needed for proper retries. See, for example,
303 // InterpreterRuntime::exception_handler_for_exception.
304 int fast_exception_handler_bci_for(KlassHandle ex_klass, int throw_bci, TRAPS);
305
306 // method data access
307 methodDataOop method_data() const {
308 return _method_data;
309 }
310 void set_method_data(methodDataOop data) {
311 oop_store_without_check((oop*)&_method_data, (oop)data);
312 }
313
314 // invocation counter
315 InvocationCounter* invocation_counter() { return &_invocation_counter; }
316 InvocationCounter* backedge_counter() { return &_backedge_counter; }
317
318 #ifdef TIERED
319 // We are reusing interpreter_invocation_count as a holder for the previous event count!
320 // We can do that since interpreter_invocation_count is not used in tiered.
321 int prev_event_count() const { return _interpreter_invocation_count; }
322 void set_prev_event_count(int count) { _interpreter_invocation_count = count; }
323 jlong prev_time() const { return _prev_time; }
324 void set_prev_time(jlong time) { _prev_time = time; }
325 float rate() const { return _rate; }
326 void set_rate(float rate) { _rate = rate; }
327 #endif
328
329 int invocation_count();
330 int backedge_count();
331
332 bool was_executed_more_than(int n);
333 bool was_never_executed() { return !was_executed_more_than(0); }
334
335 static void build_interpreter_method_data(methodHandle method, TRAPS);
336
337 int interpreter_invocation_count() {
338 if (TieredCompilation) return invocation_count();
339 else return _interpreter_invocation_count;
340 }
341 void set_interpreter_invocation_count(int count) { _interpreter_invocation_count = count; }
342 int increment_interpreter_invocation_count() {
343 if (TieredCompilation) ShouldNotReachHere();
344 return ++_interpreter_invocation_count;
345 }
346
347 #ifndef PRODUCT
348 int compiled_invocation_count() const { return _compiled_invocation_count; }
349 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
350 #endif // not PRODUCT
351
352 // Clear (non-shared space) pointers which could not be relevant
353 // if this (shared) method were mapped into another JVM.
354 void remove_unshareable_info();
355
356 // nmethod/verified compiler entry
357 address verified_code_entry();
358 bool check_code() const; // Not inline to avoid circular ref
359 nmethod* volatile code() const { assert( check_code(), "" ); return (nmethod *)OrderAccess::load_ptr_acquire(&_code); }
360 void clear_code(); // Clear out any compiled code
361 static void set_code(methodHandle mh, nmethod* code);
362 void set_adapter_entry(AdapterHandlerEntry* adapter) { _adapter = adapter; }
363 address get_i2c_entry();
364 address get_c2i_entry();
365 address get_c2i_unverified_entry();
366 AdapterHandlerEntry* adapter() { return _adapter; }
367 // setup entry points
368 void link_method(methodHandle method, TRAPS);
369 // clear entry points. Used by sharing code
370 void unlink_method();
371
372 // vtable index
373 enum VtableIndexFlag {
374 // Valid vtable indexes are non-negative (>= 0).
375 // These few negative values are used as sentinels.
376 highest_unused_vtable_index_value = -5,
377 invalid_vtable_index = -4, // distinct from any valid vtable index
378 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
379 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
380 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
381 };
382 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
383 int vtable_index() const { assert(valid_vtable_index(), "");
384 return _vtable_index; }
385 void set_vtable_index(int index) { _vtable_index = index; }
386
387 // interpreter entry
388 address interpreter_entry() const { return _i2i_entry; }
389 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
390 void set_interpreter_entry(address entry) { _i2i_entry = entry; _from_interpreted_entry = entry; }
391 int interpreter_kind(void) {
392 return constMethod()->interpreter_kind();
393 }
394 void set_interpreter_kind();
395 void set_interpreter_kind(int kind) {
396 constMethod()->set_interpreter_kind(kind);
397 }
398
399 // native function (used for native methods only)
400 enum {
401 native_bind_event_is_interesting = true
402 };
403 address native_function() const { return *(native_function_addr()); }
404 address critical_native_function();
405
406 // Must specify a real function (not NULL).
407 // Use clear_native_function() to unregister.
408 void set_native_function(address function, bool post_event_flag);
409 bool has_native_function() const;
410 void clear_native_function();
411
412 // signature handler (used for native methods only)
413 address signature_handler() const { return *(signature_handler_addr()); }
414 void set_signature_handler(address handler);
415
416 // Interpreter oopmap support
417 void mask_for(int bci, InterpreterOopMap* mask);
418
419 #ifndef PRODUCT
420 // operations on invocation counter
421 void print_invocation_count();
422 #endif
423
424 // byte codes
425 void set_code(address code) { return constMethod()->set_code(code); }
426 address code_base() const { return constMethod()->code_base(); }
427 bool contains(address bcp) const { return constMethod()->contains(bcp); }
428
429 // prints byte codes
430 void print_codes() const { print_codes_on(tty); }
431 void print_codes_on(outputStream* st) const PRODUCT_RETURN;
432 void print_codes_on(int from, int to, outputStream* st) const PRODUCT_RETURN;
433
434 // checked exceptions
435 int checked_exceptions_length() const
436 { return constMethod()->checked_exceptions_length(); }
437 CheckedExceptionElement* checked_exceptions_start() const
438 { return constMethod()->checked_exceptions_start(); }
439
440 // localvariable table
441 bool has_localvariable_table() const
442 { return constMethod()->has_localvariable_table(); }
443 int localvariable_table_length() const
444 { return constMethod()->localvariable_table_length(); }
445 LocalVariableTableElement* localvariable_table_start() const
446 { return constMethod()->localvariable_table_start(); }
447
448 bool has_linenumber_table() const
449 { return constMethod()->has_linenumber_table(); }
450 u_char* compressed_linenumber_table() const
451 { return constMethod()->compressed_linenumber_table(); }
452
453 // method holder (the klassOop holding this method)
454 klassOop method_holder() const { return constants()->pool_holder(); }
455
456 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
457 Symbol* klass_name() const; // returns the name of the method holder
458 BasicType result_type() const; // type of the method result
459 int result_type_index() const; // type index of the method result
460 bool is_returning_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY); }
461 bool is_returning_fp() const { BasicType r = result_type(); return (r == T_FLOAT || r == T_DOUBLE); }
462
463 // Checked exceptions thrown by this method (resolved to mirrors)
464 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
465
466 // Access flags
467 bool is_public() const { return access_flags().is_public(); }
468 bool is_private() const { return access_flags().is_private(); }
469 bool is_protected() const { return access_flags().is_protected(); }
470 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
471 bool is_static() const { return access_flags().is_static(); }
472 bool is_final() const { return access_flags().is_final(); }
473 bool is_synchronized() const { return access_flags().is_synchronized();}
474 bool is_native() const { return access_flags().is_native(); }
475 bool is_abstract() const { return access_flags().is_abstract(); }
476 bool is_strict() const { return access_flags().is_strict(); }
477 bool is_synthetic() const { return access_flags().is_synthetic(); }
478
479 // returns true if contains only return operation
480 bool is_empty_method() const;
481
482 // returns true if this is a vanilla constructor
483 bool is_vanilla_constructor() const;
484
485 // checks method and its method holder
486 bool is_final_method() const;
487 bool is_strict_method() const;
488
489 // true if method needs no dynamic dispatch (final and/or no vtable entry)
490 bool can_be_statically_bound() const;
491
492 // returns true if the method has any backward branches.
493 bool has_loops() {
494 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
495 };
496
497 bool compute_has_loops_flag();
498
499 bool has_jsrs() {
500 return access_flags().has_jsrs();
501 };
502 void set_has_jsrs() {
503 _access_flags.set_has_jsrs();
504 }
505
506 // returns true if the method has any monitors.
507 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
508 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
509
510 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
511
512 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
513 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
514 // has not been computed yet.
515 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
516 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
517
518 // returns true if the method is an accessor function (setter/getter).
519 bool is_accessor() const;
520
521 // returns true if the method is an initializer (<init> or <clinit>).
522 bool is_initializer() const;
523
524 // returns true if the method is static OR if the classfile version < 51
525 bool has_valid_initializer_flags() const;
526
527 // returns true if the method name is <clinit> and the method has
528 // valid static initializer flags.
529 bool is_static_initializer() const;
530
531 // compiled code support
532 // NOTE: code() is inherently racy as deopt can be clearing code
533 // simultaneously. Use with caution.
534 bool has_compiled_code() const { return code() != NULL; }
535
536 // sizing
537 static int object_size(bool is_native);
538 static int header_size() { return sizeof(methodOopDesc)/HeapWordSize; }
539 int object_size() const { return method_size(); }
540
541 bool object_is_parsable() const { return method_size() > 0; }
542
543 // interpreter support
544 static ByteSize const_offset() { return byte_offset_of(methodOopDesc, _constMethod ); }
545 static ByteSize access_flags_offset() { return byte_offset_of(methodOopDesc, _access_flags ); }
546 #ifdef CC_INTERP
547 static ByteSize result_index_offset() { return byte_offset_of(methodOopDesc, _result_index ); }
548 #endif /* CC_INTERP */
549 static ByteSize size_of_locals_offset() { return byte_offset_of(methodOopDesc, _max_locals ); }
550 static ByteSize size_of_parameters_offset() { return byte_offset_of(methodOopDesc, _size_of_parameters); }
551 static ByteSize from_compiled_offset() { return byte_offset_of(methodOopDesc, _from_compiled_entry); }
552 static ByteSize code_offset() { return byte_offset_of(methodOopDesc, _code); }
553 static ByteSize invocation_counter_offset() { return byte_offset_of(methodOopDesc, _invocation_counter); }
554 static ByteSize backedge_counter_offset() { return byte_offset_of(methodOopDesc, _backedge_counter); }
555 static ByteSize method_data_offset() {
556 return byte_offset_of(methodOopDesc, _method_data);
557 }
558 static ByteSize interpreter_invocation_counter_offset() { return byte_offset_of(methodOopDesc, _interpreter_invocation_count); }
559 #ifndef PRODUCT
560 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(methodOopDesc, _compiled_invocation_count); }
561 #endif // not PRODUCT
562 static ByteSize native_function_offset() { return in_ByteSize(sizeof(methodOopDesc)); }
563 static ByteSize from_interpreted_offset() { return byte_offset_of(methodOopDesc, _from_interpreted_entry ); }
564 static ByteSize interpreter_entry_offset() { return byte_offset_of(methodOopDesc, _i2i_entry ); }
565 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(methodOopDesc) + wordSize); }
566 static ByteSize max_stack_offset() { return byte_offset_of(methodOopDesc, _max_stack ); }
567
568 // for code generation
569 static int method_data_offset_in_bytes() { return offset_of(methodOopDesc, _method_data); }
570 static int interpreter_invocation_counter_offset_in_bytes()
571 { return offset_of(methodOopDesc, _interpreter_invocation_count); }
572 static int intrinsic_id_offset_in_bytes() { return offset_of(methodOopDesc, _intrinsic_id); }
573 static int intrinsic_id_size_in_bytes() { return sizeof(u1); }
574
575 // Static methods that are used to implement member methods where an exposed this pointer
576 // is needed due to possible GCs
577 static objArrayHandle resolved_checked_exceptions_impl(methodOop this_oop, TRAPS);
578
579 // Returns the byte code index from the byte code pointer
580 int bci_from(address bcp) const;
581 address bcp_from(int bci) const;
582 int validate_bci_from_bcx(intptr_t bcx) const;
583
584 // Returns the line number for a bci if debugging information for the method is prowided,
585 // -1 is returned otherwise.
586 int line_number_from_bci(int bci) const;
587
588 // Reflection support
589 bool is_overridden_in(klassOop k) const;
590
591 // JSR 292 support
592 bool is_method_handle_invoke() const { return access_flags().is_method_handle_invoke(); }
593 static bool is_method_handle_invoke_name(vmSymbols::SID name_sid);
594 static bool is_method_handle_invoke_name(Symbol* name) {
595 return is_method_handle_invoke_name(vmSymbols::find_sid(name));
596 }
597 // Tests if this method is an internal adapter frame from the
598 // MethodHandleCompiler.
599 bool is_method_handle_adapter() const;
600 static methodHandle make_invoke_method(KlassHandle holder,
601 Symbol* name, //invokeExact or invokeGeneric
602 Symbol* signature, //anything at all
603 Handle method_type,
604 TRAPS);
605 static klassOop check_non_bcp_klass(klassOop klass);
606 // these operate only on invoke methods:
607 oop method_handle_type() const;
608 static jint* method_type_offsets_chain(); // series of pointer-offsets, terminated by -1
609 // presize interpreter frames for extra interpreter stack entries, if needed
610 // method handles want to be able to push a few extra values (e.g., a bound receiver), and
611 // invokedynamic sometimes needs to push a bootstrap method, call site, and arglist,
612 // all without checking for a stack overflow
613 static int extra_stack_entries() { return EnableInvokeDynamic ? (int) MethodHandlePushLimit + 3 : 0; }
614 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize()
615
616 // RedefineClasses() support:
617 bool is_old() const { return access_flags().is_old(); }
618 void set_is_old() { _access_flags.set_is_old(); }
619 bool is_obsolete() const { return access_flags().is_obsolete(); }
620 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
621 // see the definition in methodOop.cpp for the gory details
622 bool should_not_be_cached() const;
623
624 // JVMTI Native method prefixing support:
625 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
626 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
627
628 // Rewriting support
629 static methodHandle clone_with_new_data(methodHandle m, u_char* new_code, int new_code_length,
630 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
631
632 // Get this method's jmethodID -- allocate if it doesn't exist
633 jmethodID jmethod_id() { methodHandle this_h(this);
634 return instanceKlass::get_jmethod_id(method_holder(), this_h); }
635
636 // Lookup the jmethodID for this method. Return NULL if not found.
637 // NOTE that this function can be called from a signal handler
638 // (see AsyncGetCallTrace support for Forte Analyzer) and this
639 // needs to be async-safe. No allocation should be done and
640 // so handles are not used to avoid deadlock.
641 jmethodID find_jmethod_id_or_null() { return instanceKlass::cast(method_holder())->jmethod_id_or_null(this); }
642
643 // JNI static invoke cached itable index accessors
644 int cached_itable_index() { return instanceKlass::cast(method_holder())->cached_itable_index(method_idnum()); }
645 void set_cached_itable_index(int index) { instanceKlass::cast(method_holder())->set_cached_itable_index(method_idnum(), index); }
646
647 // Support for inlining of intrinsic methods
648 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
649 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u1) id; }
650
651 // Helper routines for intrinsic_id() and vmIntrinsics::method().
652 void init_intrinsic_id(); // updates from _none if a match
653 static vmSymbols::SID klass_id_for_intrinsics(klassOop holder);
654
655 bool jfr_towrite() { return _jfr_towrite; }
656 void set_jfr_towrite(bool towrite) { _jfr_towrite = towrite; }
657
658 // On-stack replacement support
659 bool has_osr_nmethod(int level, bool match_level) {
660 return instanceKlass::cast(method_holder())->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
661 }
662
663 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
664 return instanceKlass::cast(method_holder())->lookup_osr_nmethod(this, bci, level, match_level);
665 }
666
667 // Inline cache support
668 void cleanup_inline_caches();
669
670 // Find if klass for method is loaded
671 bool is_klass_loaded_by_klass_index(int klass_index) const;
672 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
673
674 // Indicates whether compilation failed earlier for this method, or
675 // whether it is not compilable for another reason like having a
676 // breakpoint set in it.
677 bool is_not_compilable(int comp_level = CompLevel_any) const;
678 void set_not_compilable(int comp_level = CompLevel_all, bool report = true);
679 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
680 set_not_compilable(comp_level, false);
681 }
682 bool is_not_osr_compilable(int comp_level = CompLevel_any) const {
683 return is_not_compilable(comp_level) || access_flags().is_not_osr_compilable();
684 }
685 void set_not_osr_compilable() { _access_flags.set_not_osr_compilable(); }
686 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
687 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
688 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
689 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
690
691 // Background compilation support
692 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
693 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
694 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
695
696 // Resolve all classes in signature, return 'true' if successful
697 static bool load_signature_classes(methodHandle m, TRAPS);
698
699 // Return if true if not all classes references in signature, including return type, has been loaded
700 static bool has_unloaded_classes_in_signature(methodHandle m, TRAPS);
701
702 // Printing
703 void print_short_name(outputStream* st) /*PRODUCT_RETURN*/; // prints as klassname::methodname; Exposed so field engineers can debug VM
704 void print_name(outputStream* st) PRODUCT_RETURN; // prints as "virtual void foo(int)"
705
706 // Helper routine used for method sorting
707 static void sort_methods(objArrayOop methods,
708 objArrayOop methods_annotations,
709 objArrayOop methods_parameter_annotations,
710 objArrayOop methods_default_annotations,
711 bool idempotent = false);
712
713 // size of parameters
714 void set_size_of_parameters(int size) { _size_of_parameters = size; }
715 private:
716
717 // Inlined elements
718 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
719 address* signature_handler_addr() const { return native_function_addr() + 1; }
720
721 // Garbage collection support
722 oop* adr_constMethod() const { return (oop*)&_constMethod; }
723 oop* adr_method_data() const { return (oop*)&_method_data; }
724 };
725
726
727 // Utility class for compressing line number tables
728
729 class CompressedLineNumberWriteStream: public CompressedWriteStream {
730 private:
731 int _bci;
732 int _line;
733 public:
734 // Constructor
735 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
736 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
737
738 // Write (bci, line number) pair to stream
739 void write_pair_regular(int bci_delta, int line_delta);
740
741 inline void write_pair_inline(int bci, int line) {
742 int bci_delta = bci - _bci;
743 int line_delta = line - _line;
744 _bci = bci;
745 _line = line;
746 // Skip (0,0) deltas - they do not add information and conflict with terminator.
747 if (bci_delta == 0 && line_delta == 0) return;
748 // Check if bci is 5-bit and line number 3-bit unsigned.
749 if (((bci_delta & ~0x1F) == 0) && ((line_delta & ~0x7) == 0)) {
750 // Compress into single byte.
751 jubyte value = ((jubyte) bci_delta << 3) | (jubyte) line_delta;
752 // Check that value doesn't match escape character.
753 if (value != 0xFF) {
754 write_byte(value);
755 return;
756 }
757 }
758 write_pair_regular(bci_delta, line_delta);
759 }
760
761 // Windows AMD64 + Apr 2005 PSDK with /O2 generates bad code for write_pair.
762 // Disabling optimization doesn't work for methods in header files
763 // so we force it to call through the non-optimized version in the .cpp.
764 // It's gross, but it's the only way we can ensure that all callers are
765 // fixed. _MSC_VER is defined by the windows compiler
766 #if defined(_M_AMD64) && _MSC_VER >= 1400
767 void write_pair(int bci, int line);
768 #else
769 void write_pair(int bci, int line) { write_pair_inline(bci, line); }
770 #endif
771
772 // Write end-of-stream marker
773 void write_terminator() { write_byte(0); }
774 };
775
776
777 // Utility class for decompressing line number tables
778
779 class CompressedLineNumberReadStream: public CompressedReadStream {
780 private:
781 int _bci;
782 int _line;
783 public:
784 // Constructor
785 CompressedLineNumberReadStream(u_char* buffer);
786 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
787 bool read_pair();
788 // Accessing bci and line number (after calling read_pair)
789 int bci() const { return _bci; }
790 int line() const { return _line; }
791 };
792
793
794 /// Fast Breakpoints.
795
796 // If this structure gets more complicated (because bpts get numerous),
797 // move it into its own header.
798
799 // There is presently no provision for concurrent access
800 // to breakpoint lists, which is only OK for JVMTI because
801 // breakpoints are written only at safepoints, and are read
802 // concurrently only outside of safepoints.
803
804 class BreakpointInfo : public CHeapObj {
805 friend class VMStructs;
806 private:
807 Bytecodes::Code _orig_bytecode;
808 int _bci;
809 u2 _name_index; // of method
810 u2 _signature_index; // of method
811 BreakpointInfo* _next; // simple storage allocation
812
813 public:
814 BreakpointInfo(methodOop m, int bci);
815
816 // accessors
817 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
818 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
819 int bci() { return _bci; }
820
821 BreakpointInfo* next() const { return _next; }
822 void set_next(BreakpointInfo* n) { _next = n; }
823
824 // helps for searchers
825 bool match(const methodOopDesc* m, int bci) {
826 return bci == _bci && match(m);
827 }
828
829 bool match(const methodOopDesc* m) {
830 return _name_index == m->name_index() &&
831 _signature_index == m->signature_index();
832 }
833
834 void set(methodOop method);
835 void clear(methodOop method);
836 };
837
838 #endif // SHARE_VM_OOPS_METHODOOP_HPP