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