annotate src/share/vm/oops/methodOop.hpp @ 2992:94ec88ca68e2

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