1 /*
2 * Copyright (c) 1997, 2019, 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_OOPS_METHOD_HPP
26 #define SHARE_OOPS_METHOD_HPP
27
28 #include "classfile/vmSymbols.hpp"
29 #include "code/compressedStream.hpp"
30 #include "compiler/compilerDefinitions.hpp"
31 #include "compiler/oopMap.hpp"
32 #include "interpreter/invocationCounter.hpp"
33 #include "oops/annotations.hpp"
34 #include "oops/constantPool.hpp"
35 #include "oops/methodCounters.hpp"
36 #include "oops/instanceKlass.hpp"
37 #include "oops/oop.hpp"
38 #include "oops/typeArrayOop.hpp"
39 #include "utilities/accessFlags.hpp"
40 #include "utilities/align.hpp"
41 #include "utilities/growableArray.hpp"
42 #include "utilities/macros.hpp"
43 #if INCLUDE_JFR
44 #include "jfr/support/jfrTraceIdExtension.hpp"
45 #endif
46
47
48 // A Method represents a Java method.
49 //
50 // Note that most applications load thousands of methods, so keeping the size of this
51 // class small has a big impact on footprint.
52 //
53 // Note that native_function and signature_handler have to be at fixed offsets
54 // (required by the interpreter)
55 //
56 // Method embedded field layout (after declared fields):
57 // [EMBEDDED native_function (present only if native) ]
58 // [EMBEDDED signature_handler (present only if native) ]
59
60 class CheckedExceptionElement;
61 class LocalVariableTableElement;
62 class AdapterHandlerEntry;
63 class MethodData;
64 class MethodCounters;
65 class ConstMethod;
66 class InlineTableSizes;
67 class KlassSizeStats;
68 class CompiledMethod;
69 class InterpreterOopMap;
70
71 class Method : public Metadata {
72 friend class VMStructs;
73 friend class JVMCIVMStructs;
74 private:
75 // If you add a new field that points to any metaspace object, you
76 // must add this field to Method::metaspace_pointers_do().
77 ConstMethod* _constMethod; // Method read-only data.
78 MethodData* _method_data;
79 MethodCounters* _method_counters;
80 AccessFlags _access_flags; // Access flags
81 int _vtable_index; // vtable index of this method (see VtableIndexFlag)
82 // note: can have vtables with >2**16 elements (because of inheritance)
83 u2 _intrinsic_id; // vmSymbols::intrinsic_id (0 == _none)
84
85 // Flags
86 enum Flags {
87 _caller_sensitive = 1 << 0,
88 _force_inline = 1 << 1,
89 _dont_inline = 1 << 2,
90 _hidden = 1 << 3,
91 _has_injected_profile = 1 << 4,
92 _running_emcp = 1 << 5,
93 _intrinsic_candidate = 1 << 6,
94 _reserved_stack_access = 1 << 7,
95 _scalarized_args = 1 << 8,
96 _c1_needs_stack_repair = 1 << 9,
97 _c2_needs_stack_repair = 1 << 10
98 };
99 mutable u2 _flags;
100
101 JFR_ONLY(DEFINE_TRACE_FLAG;)
102
103 #ifndef PRODUCT
104 int _compiled_invocation_count; // Number of nmethod invocations so far (for perf. debugging)
105 #endif
106 // Entry point for calling both from and to the interpreter.
107 address _i2i_entry; // All-args-on-stack calling convention
108 // Entry point for calling from compiled code, to compiled code if it exists
109 // or else the interpreter.
110 volatile address _from_compiled_entry; // Cache of: _code ? _code->verified_entry_point() : _adapter->c2i_entry()
111 volatile address _from_compiled_value_ro_entry; // Cache of: _code ? _code->verified_value_ro_entry_point() : _adapter->c2i_value_ro_entry()
112 volatile address _from_compiled_value_entry; // Cache of: _code ? _code->verified_value_entry_point() : _adapter->c2i_value_entry()
113 // The entry point for calling both from and to compiled code is
114 // "_code->entry_point()". Because of tiered compilation and de-opt, this
115 // field can come and go. It can transition from NULL to not-null at any
116 // time (whenever a compile completes). It can transition from not-null to
117 // NULL only at safepoints (because of a de-opt).
118 CompiledMethod* volatile _code; // Points to the corresponding piece of native code
119 volatile address _from_interpreted_entry; // Cache of _code ? _adapter->i2c_entry() : _i2i_entry
120 int _max_vt_buffer; // max number of VT buffer chunk to use before recycling
121
122 #if INCLUDE_AOT && defined(TIERED)
123 CompiledMethod* _aot_code;
124 #endif
125
126 // Constructor
127 Method(ConstMethod* xconst, AccessFlags access_flags);
128 public:
129
130 static Method* allocate(ClassLoaderData* loader_data,
131 int byte_code_size,
132 AccessFlags access_flags,
133 InlineTableSizes* sizes,
134 ConstMethod::MethodType method_type,
135 TRAPS);
136
137 // CDS and vtbl checking can create an empty Method to get vtbl pointer.
138 Method(){}
139
140 bool is_method() const volatile { return true; }
141
142 void restore_unshareable_info(TRAPS);
143
144 // accessors for instance variables
145
146 ConstMethod* constMethod() const { return _constMethod; }
147 void set_constMethod(ConstMethod* xconst) { _constMethod = xconst; }
148
149
150 static address make_adapters(const methodHandle& mh, TRAPS);
151 address from_compiled_entry() const;
152 address from_compiled_entry_no_trampoline() const;
153 address from_interpreted_entry() const;
154
155 // access flag
156 AccessFlags access_flags() const { return _access_flags; }
157 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
158
159 // name
160 Symbol* name() const { return constants()->symbol_at(name_index()); }
161 int name_index() const { return constMethod()->name_index(); }
162 void set_name_index(int index) { constMethod()->set_name_index(index); }
163
164 // signature
165 Symbol* signature() const { return constants()->symbol_at(signature_index()); }
166 int signature_index() const { return constMethod()->signature_index(); }
167 void set_signature_index(int index) { constMethod()->set_signature_index(index); }
168
169 // generics support
170 Symbol* generic_signature() const { int idx = generic_signature_index(); return ((idx != 0) ? constants()->symbol_at(idx) : (Symbol*)NULL); }
171 int generic_signature_index() const { return constMethod()->generic_signature_index(); }
172 void set_generic_signature_index(int index) { constMethod()->set_generic_signature_index(index); }
173
174 // annotations support
175 AnnotationArray* annotations() const {
176 return constMethod()->method_annotations();
177 }
178 AnnotationArray* parameter_annotations() const {
179 return constMethod()->parameter_annotations();
180 }
181 AnnotationArray* annotation_default() const {
182 return constMethod()->default_annotations();
183 }
184 AnnotationArray* type_annotations() const {
185 return constMethod()->type_annotations();
186 }
187
188 // Helper routine: get klass name + "." + method name + signature as
189 // C string, for the purpose of providing more useful
190 // 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() const;
193 char* name_and_sig_as_C_string(char* buf, int size) const;
194
195 // Static routine in the situations we don't have a Method*
196 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature);
197 static char* name_and_sig_as_C_string(Klass* klass, Symbol* method_name, Symbol* signature, char* buf, int size);
198
199 // Get return type + klass name + "." + method name + ( parameters types )
200 // as a C string or print it to an outputStream.
201 // This is to be used to assemble strings passed to Java, so that
202 // the text more resembles Java code. Used in exception messages.
203 // Memory is allocated in the resource area; the caller needs
204 // a ResourceMark.
205 const char* external_name() const;
206 void print_external_name(outputStream *os) const;
207
208 static const char* external_name( Klass* klass, Symbol* method_name, Symbol* signature);
209 static void print_external_name(outputStream *os, Klass* klass, Symbol* method_name, Symbol* signature);
210
211 Bytecodes::Code java_code_at(int bci) const {
212 return Bytecodes::java_code_at(this, bcp_from(bci));
213 }
214 Bytecodes::Code code_at(int bci) const {
215 return Bytecodes::code_at(this, bcp_from(bci));
216 }
217
218 // JVMTI breakpoints
219 #if !INCLUDE_JVMTI
220 Bytecodes::Code orig_bytecode_at(int bci) const {
221 ShouldNotReachHere();
222 return Bytecodes::_shouldnotreachhere;
223 }
224 void set_orig_bytecode_at(int bci, Bytecodes::Code code) {
225 ShouldNotReachHere();
226 };
227 u2 number_of_breakpoints() const {return 0;}
228 #else // !INCLUDE_JVMTI
229 Bytecodes::Code orig_bytecode_at(int bci) const;
230 void set_orig_bytecode_at(int bci, Bytecodes::Code code);
231 void set_breakpoint(int bci);
232 void clear_breakpoint(int bci);
233 void clear_all_breakpoints();
234 // Tracking number of breakpoints, for fullspeed debugging.
235 // Only mutated by VM thread.
236 u2 number_of_breakpoints() const {
237 MethodCounters* mcs = method_counters();
238 if (mcs == NULL) {
239 return 0;
240 } else {
241 return mcs->number_of_breakpoints();
242 }
243 }
244 void incr_number_of_breakpoints(TRAPS) {
245 MethodCounters* mcs = get_method_counters(CHECK);
246 if (mcs != NULL) {
247 mcs->incr_number_of_breakpoints();
248 }
249 }
250 void decr_number_of_breakpoints(TRAPS) {
251 MethodCounters* mcs = get_method_counters(CHECK);
252 if (mcs != NULL) {
253 mcs->decr_number_of_breakpoints();
254 }
255 }
256 // Initialization only
257 void clear_number_of_breakpoints() {
258 MethodCounters* mcs = method_counters();
259 if (mcs != NULL) {
260 mcs->clear_number_of_breakpoints();
261 }
262 }
263 #endif // !INCLUDE_JVMTI
264
265 // index into InstanceKlass methods() array
266 // note: also used by jfr
267 u2 method_idnum() const { return constMethod()->method_idnum(); }
268 void set_method_idnum(u2 idnum) { constMethod()->set_method_idnum(idnum); }
269
270 u2 orig_method_idnum() const { return constMethod()->orig_method_idnum(); }
271 void set_orig_method_idnum(u2 idnum) { constMethod()->set_orig_method_idnum(idnum); }
272
273 // code size
274 int code_size() const { return constMethod()->code_size(); }
275
276 // method size in words
277 int method_size() const { return sizeof(Method)/wordSize + ( is_native() ? 2 : 0 ); }
278
279 // constant pool for Klass* holding this method
280 ConstantPool* constants() const { return constMethod()->constants(); }
281 void set_constants(ConstantPool* c) { constMethod()->set_constants(c); }
282
283 // max stack
284 // return original max stack size for method verification
285 int verifier_max_stack() const { return constMethod()->max_stack(); }
286 int max_stack() const { return constMethod()->max_stack() + extra_stack_entries(); }
287 void set_max_stack(int size) { constMethod()->set_max_stack(size); }
288
289 // max locals
290 int max_locals() const { return constMethod()->max_locals(); }
291 void set_max_locals(int size) { constMethod()->set_max_locals(size); }
292
293 int highest_comp_level() const;
294 void set_highest_comp_level(int level);
295 int highest_osr_comp_level() const;
296 void set_highest_osr_comp_level(int level);
297
298 #if COMPILER2_OR_JVMCI
299 // Count of times method was exited via exception while interpreting
300 void interpreter_throwout_increment(TRAPS) {
301 MethodCounters* mcs = get_method_counters(CHECK);
302 if (mcs != NULL) {
303 mcs->interpreter_throwout_increment();
304 }
305 }
306 #endif
307
308 int interpreter_throwout_count() const {
309 MethodCounters* mcs = method_counters();
310 if (mcs == NULL) {
311 return 0;
312 } else {
313 return mcs->interpreter_throwout_count();
314 }
315 }
316
317 // size of parameters
318 int size_of_parameters() const { return constMethod()->size_of_parameters(); }
319 void set_size_of_parameters(int size) { constMethod()->set_size_of_parameters(size); }
320
321 bool has_stackmap_table() const {
322 return constMethod()->has_stackmap_table();
323 }
324
325 Array<u1>* stackmap_data() const {
326 return constMethod()->stackmap_data();
327 }
328
329 void set_stackmap_data(Array<u1>* sd) {
330 constMethod()->set_stackmap_data(sd);
331 }
332
333 // exception handler table
334 bool has_exception_handler() const
335 { return constMethod()->has_exception_handler(); }
336 int exception_table_length() const
337 { return constMethod()->exception_table_length(); }
338 ExceptionTableElement* exception_table_start() const
339 { return constMethod()->exception_table_start(); }
340
341 // Finds the first entry point bci of an exception handler for an
342 // exception of klass ex_klass thrown at throw_bci. A value of NULL
343 // for ex_klass indicates that the exception klass is not known; in
344 // this case it matches any constraint class. Returns -1 if the
345 // exception cannot be handled in this method. The handler
346 // constraint classes are loaded if necessary. Note that this may
347 // throw an exception if loading of the constraint classes causes
348 // an IllegalAccessError (bugid 4307310) or an OutOfMemoryError.
349 // If an exception is thrown, returns the bci of the
350 // exception handler which caused the exception to be thrown, which
351 // is needed for proper retries. See, for example,
352 // InterpreterRuntime::exception_handler_for_exception.
353 static int fast_exception_handler_bci_for(const methodHandle& mh, Klass* ex_klass, int throw_bci, TRAPS);
354
355 // method data access
356 MethodData* method_data() const {
357 return _method_data;
358 }
359
360 void set_method_data(MethodData* data);
361
362 MethodCounters* method_counters() const {
363 return _method_counters;
364 }
365
366 void clear_method_counters() {
367 _method_counters = NULL;
368 }
369
370 bool init_method_counters(MethodCounters* counters);
371
372 #ifdef TIERED
373 // We are reusing interpreter_invocation_count as a holder for the previous event count!
374 // We can do that since interpreter_invocation_count is not used in tiered.
375 int prev_event_count() const {
376 if (method_counters() == NULL) {
377 return 0;
378 } else {
379 return method_counters()->interpreter_invocation_count();
380 }
381 }
382 void set_prev_event_count(int count) {
383 MethodCounters* mcs = method_counters();
384 if (mcs != NULL) {
385 mcs->set_interpreter_invocation_count(count);
386 }
387 }
388 jlong prev_time() const {
389 MethodCounters* mcs = method_counters();
390 return mcs == NULL ? 0 : mcs->prev_time();
391 }
392 void set_prev_time(jlong time) {
393 MethodCounters* mcs = method_counters();
394 if (mcs != NULL) {
395 mcs->set_prev_time(time);
396 }
397 }
398 float rate() const {
399 MethodCounters* mcs = method_counters();
400 return mcs == NULL ? 0 : mcs->rate();
401 }
402 void set_rate(float rate) {
403 MethodCounters* mcs = method_counters();
404 if (mcs != NULL) {
405 mcs->set_rate(rate);
406 }
407 }
408
409 #if INCLUDE_AOT
410 void set_aot_code(CompiledMethod* aot_code) {
411 _aot_code = aot_code;
412 }
413
414 CompiledMethod* aot_code() const {
415 return _aot_code;
416 }
417 #else
418 CompiledMethod* aot_code() const { return NULL; }
419 #endif // INCLUDE_AOT
420 #endif // TIERED
421
422 int nmethod_age() const {
423 if (method_counters() == NULL) {
424 return INT_MAX;
425 } else {
426 return method_counters()->nmethod_age();
427 }
428 }
429
430 int invocation_count();
431 int backedge_count();
432
433 bool was_executed_more_than(int n);
434 bool was_never_executed() { return !was_executed_more_than(0); }
435
436 static void build_interpreter_method_data(const methodHandle& method, TRAPS);
437
438 static MethodCounters* build_method_counters(Method* m, TRAPS);
439
440 int interpreter_invocation_count() {
441 if (TieredCompilation) {
442 return invocation_count();
443 } else {
444 MethodCounters* mcs = method_counters();
445 return (mcs == NULL) ? 0 : mcs->interpreter_invocation_count();
446 }
447 }
448 #if COMPILER2_OR_JVMCI
449 int increment_interpreter_invocation_count(TRAPS) {
450 if (TieredCompilation) ShouldNotReachHere();
451 MethodCounters* mcs = get_method_counters(CHECK_0);
452 return (mcs == NULL) ? 0 : mcs->increment_interpreter_invocation_count();
453 }
454 #endif
455
456 #ifndef PRODUCT
457 int compiled_invocation_count() const { return _compiled_invocation_count; }
458 void set_compiled_invocation_count(int count) { _compiled_invocation_count = count; }
459 #else
460 // for PrintMethodData in a product build
461 int compiled_invocation_count() const { return 0; }
462 #endif // not PRODUCT
463
464 // Clear (non-shared space) pointers which could not be relevant
465 // if this (shared) method were mapped into another JVM.
466 void remove_unshareable_info();
467
468 // nmethod/verified compiler entry
469 address verified_code_entry();
470 address verified_value_code_entry();
471 address verified_value_ro_code_entry();
472 bool check_code() const; // Not inline to avoid circular ref
473 CompiledMethod* volatile code() const;
474 void clear_code(bool acquire_lock = true); // Clear out any compiled code
475 static void set_code(const methodHandle& mh, CompiledMethod* code);
476 void set_adapter_entry(AdapterHandlerEntry* adapter) {
477 constMethod()->set_adapter_entry(adapter);
478 }
479 void update_adapter_trampoline(AdapterHandlerEntry* adapter) {
480 constMethod()->update_adapter_trampoline(adapter);
481 }
482
483 address get_i2c_entry();
484 address get_c2i_entry();
485 address get_c2i_value_entry();
486 address get_c2i_unverified_entry();
487 AdapterHandlerEntry* adapter() const {
488 return constMethod()->adapter();
489 }
490 // setup entry points
491 void link_method(const methodHandle& method, TRAPS);
492 // clear entry points. Used by sharing code during dump time
493 void unlink_method() NOT_CDS_RETURN;
494
495 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
496 virtual MetaspaceObj::Type type() const { return MethodType; }
497
498 // vtable index
499 enum VtableIndexFlag {
500 // Valid vtable indexes are non-negative (>= 0).
501 // These few negative values are used as sentinels.
502 itable_index_max = -10, // first itable index, growing downward
503 pending_itable_index = -9, // itable index will be assigned
504 invalid_vtable_index = -4, // distinct from any valid vtable index
505 garbage_vtable_index = -3, // not yet linked; no vtable layout yet
506 nonvirtual_vtable_index = -2 // there is no need for vtable dispatch
507 // 6330203 Note: Do not use -1, which was overloaded with many meanings.
508 };
509 DEBUG_ONLY(bool valid_vtable_index() const { return _vtable_index >= nonvirtual_vtable_index; })
510 bool has_vtable_index() const { return _vtable_index >= 0; }
511 int vtable_index() const { return _vtable_index; }
512 void set_vtable_index(int index);
513 DEBUG_ONLY(bool valid_itable_index() const { return _vtable_index <= pending_itable_index; })
514 bool has_itable_index() const { return _vtable_index <= itable_index_max; }
515 int itable_index() const { assert(valid_itable_index(), "");
516 return itable_index_max - _vtable_index; }
517 void set_itable_index(int index);
518
519 // interpreter entry
520 address interpreter_entry() const { return _i2i_entry; }
521 // Only used when first initialize so we can set _i2i_entry and _from_interpreted_entry
522 void set_interpreter_entry(address entry) {
523 assert(!is_shared(), "shared method's interpreter entry should not be changed at run time");
524 if (_i2i_entry != entry) {
525 _i2i_entry = entry;
526 }
527 if (_from_interpreted_entry != entry) {
528 _from_interpreted_entry = entry;
529 }
530 }
531
532 // native function (used for native methods only)
533 enum {
534 native_bind_event_is_interesting = true
535 };
536 address native_function() const { return *(native_function_addr()); }
537 address critical_native_function();
538
539 // Must specify a real function (not NULL).
540 // Use clear_native_function() to unregister.
541 void set_native_function(address function, bool post_event_flag);
542 bool has_native_function() const;
543 void clear_native_function();
544
545 // signature handler (used for native methods only)
546 address signature_handler() const { return *(signature_handler_addr()); }
547 void set_signature_handler(address handler);
548
549 // Interpreter oopmap support
550 void mask_for(int bci, InterpreterOopMap* mask);
551
552 // operations on invocation counter
553 void print_invocation_count();
554
555 // byte codes
556 void set_code(address code) { return constMethod()->set_code(code); }
557 address code_base() const { return constMethod()->code_base(); }
558 bool contains(address bcp) const { return constMethod()->contains(bcp); }
559
560 // prints byte codes
561 void print_codes() const { print_codes_on(tty); }
562 void print_codes_on(outputStream* st) const;
563 void print_codes_on(int from, int to, outputStream* st) const;
564
565 // method parameters
566 bool has_method_parameters() const
567 { return constMethod()->has_method_parameters(); }
568 int method_parameters_length() const
569 { return constMethod()->method_parameters_length(); }
570 MethodParametersElement* method_parameters_start() const
571 { return constMethod()->method_parameters_start(); }
572
573 // checked exceptions
574 int checked_exceptions_length() const
575 { return constMethod()->checked_exceptions_length(); }
576 CheckedExceptionElement* checked_exceptions_start() const
577 { return constMethod()->checked_exceptions_start(); }
578
579 // localvariable table
580 bool has_localvariable_table() const
581 { return constMethod()->has_localvariable_table(); }
582 int localvariable_table_length() const
583 { return constMethod()->localvariable_table_length(); }
584 LocalVariableTableElement* localvariable_table_start() const
585 { return constMethod()->localvariable_table_start(); }
586
587 bool has_linenumber_table() const
588 { return constMethod()->has_linenumber_table(); }
589 u_char* compressed_linenumber_table() const
590 { return constMethod()->compressed_linenumber_table(); }
591
592 // method holder (the Klass* holding this method)
593 InstanceKlass* method_holder() const { return constants()->pool_holder(); }
594
595 void compute_size_of_parameters(Thread *thread); // word size of parameters (receiver if any + arguments)
596 Symbol* klass_name() const; // returns the name of the method holder
597 BasicType result_type() const; // type of the method result
598 bool may_return_oop() const { BasicType r = result_type(); return (r == T_OBJECT || r == T_ARRAY || r == T_VALUETYPE); }
599 #ifdef ASSERT
600 ValueKlass* returned_value_type(Thread* thread) const;
601 #endif
602
603 // Checked exceptions thrown by this method (resolved to mirrors)
604 objArrayHandle resolved_checked_exceptions(TRAPS) { return resolved_checked_exceptions_impl(this, THREAD); }
605
606 // Access flags
607 bool is_public() const { return access_flags().is_public(); }
608 bool is_private() const { return access_flags().is_private(); }
609 bool is_protected() const { return access_flags().is_protected(); }
610 bool is_package_private() const { return !is_public() && !is_private() && !is_protected(); }
611 bool is_static() const { return access_flags().is_static(); }
612 bool is_final() const { return access_flags().is_final(); }
613 bool is_synchronized() const { return access_flags().is_synchronized();}
614 bool is_native() const { return access_flags().is_native(); }
615 bool is_abstract() const { return access_flags().is_abstract(); }
616 bool is_strict() const { return access_flags().is_strict(); }
617 bool is_synthetic() const { return access_flags().is_synthetic(); }
618
619 // returns true if contains only return operation
620 bool is_empty_method() const;
621
622 // returns true if this is a vanilla constructor
623 bool is_vanilla_constructor() const;
624
625 // checks method and its method holder
626 bool is_final_method() const;
627 bool is_final_method(AccessFlags class_access_flags) const;
628 // interface method declared with 'default' - excludes private interface methods
629 bool is_default_method() const;
630
631 // true if method needs no dynamic dispatch (final and/or no vtable entry)
632 bool can_be_statically_bound() const;
633 bool can_be_statically_bound(InstanceKlass* context) const;
634 bool can_be_statically_bound(AccessFlags class_access_flags) const;
635
636 // returns true if the method has any backward branches.
637 bool has_loops() {
638 return access_flags().loops_flag_init() ? access_flags().has_loops() : compute_has_loops_flag();
639 };
640
641 bool compute_has_loops_flag();
642
643 bool has_jsrs() {
644 return access_flags().has_jsrs();
645 };
646 void set_has_jsrs() {
647 _access_flags.set_has_jsrs();
648 }
649
650 // returns true if the method has any monitors.
651 bool has_monitors() const { return is_synchronized() || access_flags().has_monitor_bytecodes(); }
652 bool has_monitor_bytecodes() const { return access_flags().has_monitor_bytecodes(); }
653
654 void set_has_monitor_bytecodes() { _access_flags.set_has_monitor_bytecodes(); }
655
656 // monitor matching. This returns a conservative estimate of whether the monitorenter/monitorexit bytecodes
657 // propererly nest in the method. It might return false, even though they actually nest properly, since the info.
658 // has not been computed yet.
659 bool guaranteed_monitor_matching() const { return access_flags().is_monitor_matching(); }
660 void set_guaranteed_monitor_matching() { _access_flags.set_monitor_matching(); }
661
662 // returns true if the method is an accessor function (setter/getter).
663 bool is_accessor() const;
664
665 // returns true if the method is a getter
666 bool is_getter() const;
667
668 // returns true if the method is a setter
669 bool is_setter() const;
670
671 // returns true if the method does nothing but return a constant of primitive type
672 bool is_constant_getter() const;
673
674 // returns true if the method name is <clinit> and the method has
675 // valid static initializer flags.
676 bool is_class_initializer() const;
677
678 // returns true if the method name is <init> and the method is not a static factory
679 bool is_object_constructor() const;
680
681 // returns true if the method is an object constructor or class initializer
682 // (non-static <init> or <clinit>), but false for factories (static <init>).
683 bool is_object_constructor_or_class_initializer() const;
684
685 // returns true if the method name is <init> and the method is static
686 bool is_static_init_factory() const;
687
688 // compiled code support
689 // NOTE: code() is inherently racy as deopt can be clearing code
690 // simultaneously. Use with caution.
691 bool has_compiled_code() const;
692
693 #ifdef TIERED
694 bool has_aot_code() const { return aot_code() != NULL; }
695 #endif
696
697 // sizing
698 static int header_size() {
699 return align_up((int)sizeof(Method), wordSize) / wordSize;
700 }
701 static int size(bool is_native);
702 int size() const { return method_size(); }
703 #if INCLUDE_SERVICES
704 void collect_statistics(KlassSizeStats *sz) const;
705 #endif
706 void log_touched(TRAPS);
707 static void print_touched_methods(outputStream* out);
708
709 // interpreter support
710 static ByteSize const_offset() { return byte_offset_of(Method, _constMethod ); }
711 static ByteSize access_flags_offset() { return byte_offset_of(Method, _access_flags ); }
712 static ByteSize from_compiled_offset() { return byte_offset_of(Method, _from_compiled_entry); }
713 static ByteSize from_compiled_value_offset() { return byte_offset_of(Method, _from_compiled_value_entry); }
714 static ByteSize from_compiled_value_ro_offset(){ return byte_offset_of(Method, _from_compiled_value_ro_entry); }
715 static ByteSize code_offset() { return byte_offset_of(Method, _code); }
716 static ByteSize flags_offset() { return byte_offset_of(Method, _flags); }
717 static ByteSize method_data_offset() {
718 return byte_offset_of(Method, _method_data);
719 }
720 static ByteSize method_counters_offset() {
721 return byte_offset_of(Method, _method_counters);
722 }
723 #ifndef PRODUCT
724 static ByteSize compiled_invocation_counter_offset() { return byte_offset_of(Method, _compiled_invocation_count); }
725 #endif // not PRODUCT
726 static ByteSize native_function_offset() { return in_ByteSize(sizeof(Method)); }
727 static ByteSize from_interpreted_offset() { return byte_offset_of(Method, _from_interpreted_entry ); }
728 static ByteSize interpreter_entry_offset() { return byte_offset_of(Method, _i2i_entry ); }
729 static ByteSize signature_handler_offset() { return in_ByteSize(sizeof(Method) + wordSize); }
730 static ByteSize itable_index_offset() { return byte_offset_of(Method, _vtable_index ); }
731
732 // for code generation
733 static int method_data_offset_in_bytes() { return offset_of(Method, _method_data); }
734 static int intrinsic_id_offset_in_bytes() { return offset_of(Method, _intrinsic_id); }
735 static int intrinsic_id_size_in_bytes() { return sizeof(u2); }
736
737 static ByteSize max_vt_buffer_offset() { return byte_offset_of(Method, _max_vt_buffer); }
738
739 // Static methods that are used to implement member methods where an exposed this pointer
740 // is needed due to possible GCs
741 static objArrayHandle resolved_checked_exceptions_impl(Method* method, TRAPS);
742
743 // Returns the byte code index from the byte code pointer
744 int bci_from(address bcp) const;
745 address bcp_from(int bci) const;
746 address bcp_from(address bcp) const;
747 int validate_bci_from_bcp(address bcp) const;
748 int validate_bci(int bci) const;
749
750 // Returns the line number for a bci if debugging information for the method is prowided,
751 // -1 is returned otherwise.
752 int line_number_from_bci(int bci) const;
753
754 // Reflection support
755 bool is_overridden_in(Klass* k) const;
756
757 // Stack walking support
758 bool is_ignored_by_security_stack_walk() const;
759
760 // JSR 292 support
761 bool is_method_handle_intrinsic() const; // MethodHandles::is_signature_polymorphic_intrinsic(intrinsic_id)
762 bool is_compiled_lambda_form() const; // intrinsic_id() == vmIntrinsics::_compiledLambdaForm
763 bool has_member_arg() const; // intrinsic_id() == vmIntrinsics::_linkToSpecial, etc.
764 static methodHandle make_method_handle_intrinsic(vmIntrinsics::ID iid, // _invokeBasic, _linkToVirtual
765 Symbol* signature, //anything at all
766 TRAPS);
767 static Klass* check_non_bcp_klass(Klass* klass);
768
769 enum {
770 // How many extra stack entries for invokedynamic
771 extra_stack_entries_for_jsr292 = 1
772 };
773
774 // this operates only on invoke methods:
775 // presize interpreter frames for extra interpreter stack entries, if needed
776 // Account for the extra appendix argument for invokehandle/invokedynamic
777 static int extra_stack_entries() { return extra_stack_entries_for_jsr292; }
778 static int extra_stack_words(); // = extra_stack_entries() * Interpreter::stackElementSize
779
780 // RedefineClasses() support:
781 bool is_old() const { return access_flags().is_old(); }
782 void set_is_old() { _access_flags.set_is_old(); }
783 bool is_obsolete() const { return access_flags().is_obsolete(); }
784 void set_is_obsolete() { _access_flags.set_is_obsolete(); }
785 bool is_deleted() const { return access_flags().is_deleted(); }
786 void set_is_deleted() { _access_flags.set_is_deleted(); }
787
788 bool is_running_emcp() const {
789 // EMCP methods are old but not obsolete or deleted. Equivalent
790 // Modulo Constant Pool means the method is equivalent except
791 // the constant pool and instructions that access the constant
792 // pool might be different.
793 // If a breakpoint is set in a redefined method, its EMCP methods that are
794 // still running must have a breakpoint also.
795 return (_flags & _running_emcp) != 0;
796 }
797
798 void set_running_emcp(bool x) {
799 _flags = x ? (_flags | _running_emcp) : (_flags & ~_running_emcp);
800 }
801
802 bool on_stack() const { return access_flags().on_stack(); }
803 void set_on_stack(const bool value);
804
805 // see the definition in Method*.cpp for the gory details
806 bool should_not_be_cached() const;
807
808 // JVMTI Native method prefixing support:
809 bool is_prefixed_native() const { return access_flags().is_prefixed_native(); }
810 void set_is_prefixed_native() { _access_flags.set_is_prefixed_native(); }
811
812 // Rewriting support
813 static methodHandle clone_with_new_data(const methodHandle& m, u_char* new_code, int new_code_length,
814 u_char* new_compressed_linenumber_table, int new_compressed_linenumber_size, TRAPS);
815
816 // jmethodID handling
817 // Because the useful life-span of a jmethodID cannot be determined,
818 // once created they are never reclaimed. The methods to which they refer,
819 // however, can be GC'ed away if the class is unloaded or if the method is
820 // made obsolete or deleted -- in these cases, the jmethodID
821 // refers to NULL (as is the case for any weak reference).
822 static jmethodID make_jmethod_id(ClassLoaderData* loader_data, Method* mh);
823 static void destroy_jmethod_id(ClassLoaderData* loader_data, jmethodID mid);
824
825 // Ensure there is enough capacity in the internal tracking data
826 // structures to hold the number of jmethodIDs you plan to generate.
827 // This saves substantial time doing allocations.
828 static void ensure_jmethod_ids(ClassLoaderData* loader_data, int capacity);
829
830 // Use resolve_jmethod_id() in situations where the caller is expected
831 // to provide a valid jmethodID; the only sanity checks are in asserts;
832 // result guaranteed not to be NULL.
833 inline static Method* resolve_jmethod_id(jmethodID mid) {
834 assert(mid != NULL, "JNI method id should not be null");
835 return *((Method**)mid);
836 }
837
838 // Use checked_resolve_jmethod_id() in situations where the caller
839 // should provide a valid jmethodID, but might not. NULL is returned
840 // when the jmethodID does not refer to a valid method.
841 static Method* checked_resolve_jmethod_id(jmethodID mid);
842
843 static void change_method_associated_with_jmethod_id(jmethodID old_jmid_ptr, Method* new_method);
844 static bool is_method_id(jmethodID mid);
845
846 // Clear methods
847 static void clear_jmethod_ids(ClassLoaderData* loader_data);
848 static void print_jmethod_ids(const ClassLoaderData* loader_data, outputStream* out) PRODUCT_RETURN;
849
850 // Get this method's jmethodID -- allocate if it doesn't exist
851 jmethodID jmethod_id() { return method_holder()->get_jmethod_id(this); }
852
853 // Lookup the jmethodID for this method. Return NULL if not found.
854 // NOTE that this function can be called from a signal handler
855 // (see AsyncGetCallTrace support for Forte Analyzer) and this
856 // needs to be async-safe. No allocation should be done and
857 // so handles are not used to avoid deadlock.
858 jmethodID find_jmethod_id_or_null() { return method_holder()->jmethod_id_or_null(this); }
859
860 // Support for inlining of intrinsic methods
861 vmIntrinsics::ID intrinsic_id() const { return (vmIntrinsics::ID) _intrinsic_id; }
862 void set_intrinsic_id(vmIntrinsics::ID id) { _intrinsic_id = (u2) id; }
863
864 // Helper routines for intrinsic_id() and vmIntrinsics::method().
865 void init_intrinsic_id(); // updates from _none if a match
866 static vmSymbols::SID klass_id_for_intrinsics(const Klass* holder);
867
868 bool caller_sensitive() {
869 return (_flags & _caller_sensitive) != 0;
870 }
871 void set_caller_sensitive(bool x) {
872 _flags = x ? (_flags | _caller_sensitive) : (_flags & ~_caller_sensitive);
873 }
874
875 bool force_inline() {
876 return (_flags & _force_inline) != 0;
877 }
878 void set_force_inline(bool x) {
879 _flags = x ? (_flags | _force_inline) : (_flags & ~_force_inline);
880 }
881
882 bool dont_inline() {
883 return (_flags & _dont_inline) != 0;
884 }
885 void set_dont_inline(bool x) {
886 _flags = x ? (_flags | _dont_inline) : (_flags & ~_dont_inline);
887 }
888
889 bool is_hidden() {
890 return (_flags & _hidden) != 0;
891 }
892 void set_hidden(bool x) {
893 _flags = x ? (_flags | _hidden) : (_flags & ~_hidden);
894 }
895
896 bool intrinsic_candidate() {
897 return (_flags & _intrinsic_candidate) != 0;
898 }
899 void set_intrinsic_candidate(bool x) {
900 _flags = x ? (_flags | _intrinsic_candidate) : (_flags & ~_intrinsic_candidate);
901 }
902
903 bool has_injected_profile() {
904 return (_flags & _has_injected_profile) != 0;
905 }
906 void set_has_injected_profile(bool x) {
907 _flags = x ? (_flags | _has_injected_profile) : (_flags & ~_has_injected_profile);
908 }
909
910 bool has_reserved_stack_access() {
911 return (_flags & _reserved_stack_access) != 0;
912 }
913
914 void set_has_reserved_stack_access(bool x) {
915 _flags = x ? (_flags | _reserved_stack_access) : (_flags & ~_reserved_stack_access);
916 }
917
918 bool has_scalarized_args() {
919 return (_flags & _scalarized_args) != 0;
920 }
921
922 void set_has_scalarized_args(bool x) {
923 _flags = x ? (_flags | _scalarized_args) : (_flags & ~_scalarized_args);
924 }
925
926 bool c1_needs_stack_repair() {
927 return (_flags & _c1_needs_stack_repair) != 0;
928 }
929
930 bool c2_needs_stack_repair() {
931 return (_flags & _c2_needs_stack_repair) != 0;
932 }
933
934 void set_c1_needs_stack_repair(bool x) {
935 _flags = x ? (_flags | _c1_needs_stack_repair) : (_flags & ~_c1_needs_stack_repair);
936 }
937
938 void set_c2_needs_stack_repair(bool x) {
939 _flags = x ? (_flags | _c2_needs_stack_repair) : (_flags & ~_c2_needs_stack_repair);
940 }
941
942 JFR_ONLY(DEFINE_TRACE_FLAG_ACCESSOR;)
943
944 ConstMethod::MethodType method_type() const {
945 return _constMethod->method_type();
946 }
947 bool is_overpass() const { return method_type() == ConstMethod::OVERPASS; }
948
949 // On-stack replacement support
950 bool has_osr_nmethod(int level, bool match_level) {
951 return method_holder()->lookup_osr_nmethod(this, InvocationEntryBci, level, match_level) != NULL;
952 }
953
954 int mark_osr_nmethods() {
955 return method_holder()->mark_osr_nmethods(this);
956 }
957
958 nmethod* lookup_osr_nmethod_for(int bci, int level, bool match_level) {
959 return method_holder()->lookup_osr_nmethod(this, bci, level, match_level);
960 }
961
962 // Find if klass for method is loaded
963 bool is_klass_loaded_by_klass_index(int klass_index) const;
964 bool is_klass_loaded(int refinfo_index, bool must_be_resolved = false) const;
965
966 // Indicates whether compilation failed earlier for this method, or
967 // whether it is not compilable for another reason like having a
968 // breakpoint set in it.
969 bool is_not_compilable(int comp_level = CompLevel_any) const;
970 void set_not_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
971 void set_not_compilable_quietly(int comp_level = CompLevel_all) {
972 set_not_compilable(comp_level, false);
973 }
974 bool is_not_osr_compilable(int comp_level = CompLevel_any) const;
975 void set_not_osr_compilable(int comp_level = CompLevel_all, bool report = true, const char* reason = NULL);
976 void set_not_osr_compilable_quietly(int comp_level = CompLevel_all) {
977 set_not_osr_compilable(comp_level, false);
978 }
979 bool is_always_compilable() const;
980
981 private:
982 void print_made_not_compilable(int comp_level, bool is_osr, bool report, const char* reason);
983
984 public:
985 MethodCounters* get_method_counters(TRAPS) {
986 if (_method_counters == NULL) {
987 build_method_counters(this, CHECK_AND_CLEAR_NULL);
988 }
989 return _method_counters;
990 }
991
992 bool is_not_c1_compilable() const { return access_flags().is_not_c1_compilable(); }
993 void set_not_c1_compilable() { _access_flags.set_not_c1_compilable(); }
994 void clear_not_c1_compilable() { _access_flags.clear_not_c1_compilable(); }
995 bool is_not_c2_compilable() const { return access_flags().is_not_c2_compilable(); }
996 void set_not_c2_compilable() { _access_flags.set_not_c2_compilable(); }
997 void clear_not_c2_compilable() { _access_flags.clear_not_c2_compilable(); }
998
999 bool is_not_c1_osr_compilable() const { return is_not_c1_compilable(); } // don't waste an accessFlags bit
1000 void set_not_c1_osr_compilable() { set_not_c1_compilable(); } // don't waste an accessFlags bit
1001 void clear_not_c1_osr_compilable() { clear_not_c1_compilable(); } // don't waste an accessFlags bit
1002 bool is_not_c2_osr_compilable() const { return access_flags().is_not_c2_osr_compilable(); }
1003 void set_not_c2_osr_compilable() { _access_flags.set_not_c2_osr_compilable(); }
1004 void clear_not_c2_osr_compilable() { _access_flags.clear_not_c2_osr_compilable(); }
1005
1006 // Background compilation support
1007 bool queued_for_compilation() const { return access_flags().queued_for_compilation(); }
1008 void set_queued_for_compilation() { _access_flags.set_queued_for_compilation(); }
1009 void clear_queued_for_compilation() { _access_flags.clear_queued_for_compilation(); }
1010
1011 // Resolve all classes in signature, return 'true' if successful
1012 static bool load_signature_classes(const methodHandle& m, TRAPS);
1013
1014 // Return if true if not all classes references in signature, including return type, has been loaded
1015 static bool has_unloaded_classes_in_signature(const methodHandle& m, TRAPS);
1016
1017 // Printing
1018 void print_short_name(outputStream* st = tty); // prints as klassname::methodname; Exposed so field engineers can debug VM
1019 #if INCLUDE_JVMTI
1020 void print_name(outputStream* st = tty); // prints as "virtual void foo(int)"; exposed for TraceRedefineClasses
1021 #else
1022 void print_name(outputStream* st = tty) PRODUCT_RETURN; // prints as "virtual void foo(int)"
1023 #endif
1024
1025 // Helper routine used for method sorting
1026 static void sort_methods(Array<Method*>* methods, bool set_idnums = true);
1027
1028 // Deallocation function for redefine classes or if an error occurs
1029 void deallocate_contents(ClassLoaderData* loader_data);
1030
1031 Method* get_new_method() const {
1032 InstanceKlass* holder = method_holder();
1033 Method* new_method = holder->method_with_idnum(orig_method_idnum());
1034
1035 assert(new_method != NULL, "method_with_idnum() should not be NULL");
1036 assert(this != new_method, "sanity check");
1037 return new_method;
1038 }
1039
1040 // Printing
1041 #ifndef PRODUCT
1042 void print_on(outputStream* st) const;
1043 #endif
1044 void print_value_on(outputStream* st) const;
1045 void print_linkage_flags(outputStream* st) PRODUCT_RETURN;
1046
1047 const char* internal_name() const { return "{method}"; }
1048
1049 // Check for valid method pointer
1050 static bool has_method_vptr(const void* ptr);
1051 static bool is_valid_method(const Method* m);
1052
1053 // Verify
1054 void verify() { verify_on(tty); }
1055 void verify_on(outputStream* st);
1056
1057 private:
1058
1059 // Inlined elements
1060 address* native_function_addr() const { assert(is_native(), "must be native"); return (address*) (this+1); }
1061 address* signature_handler_addr() const { return native_function_addr() + 1; }
1062 };
1063
1064
1065 // Utility class for compressing line number tables
1066
1067 class CompressedLineNumberWriteStream: public CompressedWriteStream {
1068 private:
1069 int _bci;
1070 int _line;
1071 public:
1072 // Constructor
1073 CompressedLineNumberWriteStream(int initial_size) : CompressedWriteStream(initial_size), _bci(0), _line(0) {}
1074 CompressedLineNumberWriteStream(u_char* buffer, int initial_size) : CompressedWriteStream(buffer, initial_size), _bci(0), _line(0) {}
1075
1076 // Write (bci, line number) pair to stream
1077 void write_pair_regular(int bci_delta, int line_delta);
1078
1079 // If (bci delta, line delta) fits in (5-bit unsigned, 3-bit unsigned)
1080 // we save it as one byte, otherwise we write a 0xFF escape character
1081 // and use regular compression. 0x0 is used as end-of-stream terminator.
1082 void write_pair_inline(int bci, int line);
1083
1084 void write_pair(int bci, int line);
1085
1086 // Write end-of-stream marker
1087 void write_terminator() { write_byte(0); }
1088 };
1089
1090
1091 // Utility class for decompressing line number tables
1092
1093 class CompressedLineNumberReadStream: public CompressedReadStream {
1094 private:
1095 int _bci;
1096 int _line;
1097 public:
1098 // Constructor
1099 CompressedLineNumberReadStream(u_char* buffer);
1100 // Read (bci, line number) pair from stream. Returns false at end-of-stream.
1101 bool read_pair();
1102 // Accessing bci and line number (after calling read_pair)
1103 int bci() const { return _bci; }
1104 int line() const { return _line; }
1105 };
1106
1107
1108 #if INCLUDE_JVMTI
1109
1110 /// Fast Breakpoints.
1111
1112 // If this structure gets more complicated (because bpts get numerous),
1113 // move it into its own header.
1114
1115 // There is presently no provision for concurrent access
1116 // to breakpoint lists, which is only OK for JVMTI because
1117 // breakpoints are written only at safepoints, and are read
1118 // concurrently only outside of safepoints.
1119
1120 class BreakpointInfo : public CHeapObj<mtClass> {
1121 friend class VMStructs;
1122 private:
1123 Bytecodes::Code _orig_bytecode;
1124 int _bci;
1125 u2 _name_index; // of method
1126 u2 _signature_index; // of method
1127 BreakpointInfo* _next; // simple storage allocation
1128
1129 public:
1130 BreakpointInfo(Method* m, int bci);
1131
1132 // accessors
1133 Bytecodes::Code orig_bytecode() { return _orig_bytecode; }
1134 void set_orig_bytecode(Bytecodes::Code code) { _orig_bytecode = code; }
1135 int bci() { return _bci; }
1136
1137 BreakpointInfo* next() const { return _next; }
1138 void set_next(BreakpointInfo* n) { _next = n; }
1139
1140 // helps for searchers
1141 bool match(const Method* m, int bci) {
1142 return bci == _bci && match(m);
1143 }
1144
1145 bool match(const Method* m) {
1146 return _name_index == m->name_index() &&
1147 _signature_index == m->signature_index();
1148 }
1149
1150 void set(Method* method);
1151 void clear(Method* method);
1152 };
1153
1154 #endif // INCLUDE_JVMTI
1155
1156 // Utility class for access exception handlers
1157 class ExceptionTable : public StackObj {
1158 private:
1159 ExceptionTableElement* _table;
1160 u2 _length;
1161
1162 public:
1163 ExceptionTable(const Method* m) {
1164 if (m->has_exception_handler()) {
1165 _table = m->exception_table_start();
1166 _length = m->exception_table_length();
1167 } else {
1168 _table = NULL;
1169 _length = 0;
1170 }
1171 }
1172
1173 int length() const {
1174 return _length;
1175 }
1176
1177 u2 start_pc(int idx) const {
1178 assert(idx < _length, "out of bounds");
1179 return _table[idx].start_pc;
1180 }
1181
1182 void set_start_pc(int idx, u2 value) {
1183 assert(idx < _length, "out of bounds");
1184 _table[idx].start_pc = value;
1185 }
1186
1187 u2 end_pc(int idx) const {
1188 assert(idx < _length, "out of bounds");
1189 return _table[idx].end_pc;
1190 }
1191
1192 void set_end_pc(int idx, u2 value) {
1193 assert(idx < _length, "out of bounds");
1194 _table[idx].end_pc = value;
1195 }
1196
1197 u2 handler_pc(int idx) const {
1198 assert(idx < _length, "out of bounds");
1199 return _table[idx].handler_pc;
1200 }
1201
1202 void set_handler_pc(int idx, u2 value) {
1203 assert(idx < _length, "out of bounds");
1204 _table[idx].handler_pc = value;
1205 }
1206
1207 u2 catch_type_index(int idx) const {
1208 assert(idx < _length, "out of bounds");
1209 return _table[idx].catch_type_index;
1210 }
1211
1212 void set_catch_type_index(int idx, u2 value) {
1213 assert(idx < _length, "out of bounds");
1214 _table[idx].catch_type_index = value;
1215 }
1216 };
1217
1218 #endif // SHARE_OOPS_METHOD_HPP