1 /* 2 * Copyright (c) 2003, 2020, 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_PRIMS_JVMTIENVBASE_HPP 26 #define SHARE_PRIMS_JVMTIENVBASE_HPP 27 28 #include "classfile/classLoader.hpp" 29 #include "prims/jvmtiEnvThreadState.hpp" 30 #include "prims/jvmtiEventController.hpp" 31 #include "prims/jvmtiThreadState.hpp" 32 #include "oops/oopHandle.hpp" 33 #include "runtime/atomic.hpp" 34 #include "runtime/fieldDescriptor.hpp" 35 #include "runtime/frame.hpp" 36 #include "runtime/thread.hpp" 37 #include "runtime/vmOperations.hpp" 38 #include "utilities/growableArray.hpp" 39 #include "utilities/macros.hpp" 40 41 // 42 // Forward Declarations 43 // 44 45 class JvmtiEnv; 46 class JvmtiThreadState; 47 class JvmtiRawMonitor; // for jvmtiEnv.hpp 48 class JvmtiEventControllerPrivate; 49 class JvmtiTagMap; 50 51 52 53 // One JvmtiEnv object is created per jvmti attachment; 54 // done via JNI GetEnv() call. Multiple attachments are 55 // allowed in jvmti. 56 57 class JvmtiEnvBase : public CHeapObj<mtInternal> { 58 59 private: 60 61 #if INCLUDE_JVMTI 62 static JvmtiEnvBase* _head_environment; // head of environment list 63 #endif // INCLUDE_JVMTI 64 65 static bool _globally_initialized; 66 static jvmtiPhase _phase; 67 static volatile int _dying_thread_env_iteration_count; 68 69 public: 70 71 enum { 72 JDK15_JVMTI_VERSION = JVMTI_VERSION_1_0 + 33, /* version: 1.0.33 */ 73 JDK16_JVMTI_VERSION = JVMTI_VERSION_1_1 + 102, /* version: 1.1.102 */ 74 JDK17_JVMTI_VERSION = JVMTI_VERSION_1_2 + 2 /* version: 1.2.2 */ 75 }; 76 77 static jvmtiPhase get_phase() { return _phase; } 78 static jvmtiPhase get_phase(jvmtiEnv* env) { return ((JvmtiEnvBase*)JvmtiEnv_from_jvmti_env(env))->phase(); } 79 static void set_phase(jvmtiPhase phase) { _phase = phase; } 80 static bool is_vm_live() { return _phase == JVMTI_PHASE_LIVE; } 81 82 static void entering_dying_thread_env_iteration() { ++_dying_thread_env_iteration_count; } 83 static void leaving_dying_thread_env_iteration() { --_dying_thread_env_iteration_count; } 84 static bool is_inside_dying_thread_env_iteration(){ return _dying_thread_env_iteration_count > 0; } 85 86 private: 87 88 enum { 89 JVMTI_MAGIC = 0x71EE, 90 DISPOSED_MAGIC = 0xDEFC, 91 BAD_MAGIC = 0xDEAD 92 }; 93 94 jvmtiEnv _jvmti_external; 95 jint _magic; 96 jint _version; // version value passed to JNI GetEnv() 97 JvmtiEnvBase* _next; 98 bool _is_retransformable; 99 const void *_env_local_storage; // per env agent allocated data. 100 jvmtiEventCallbacks _event_callbacks; 101 jvmtiExtEventCallbacks _ext_event_callbacks; 102 JvmtiTagMap* volatile _tag_map; 103 JvmtiEnvEventEnable _env_event_enable; 104 jvmtiCapabilities _current_capabilities; 105 jvmtiCapabilities _prohibited_capabilities; 106 volatile bool _class_file_load_hook_ever_enabled; 107 static volatile bool _needs_clean_up; 108 char** _native_method_prefixes; 109 int _native_method_prefix_count; 110 111 protected: 112 JvmtiEnvBase(jint version); 113 ~JvmtiEnvBase(); 114 void dispose(); 115 void env_dispose(); 116 117 void set_env_local_storage(const void* data) { _env_local_storage = data; } 118 const void* get_env_local_storage() { return _env_local_storage; } 119 120 void record_class_file_load_hook_enabled(); 121 void record_first_time_class_file_load_hook_enabled(); 122 123 char** get_native_method_prefixes() { return _native_method_prefixes; } 124 int get_native_method_prefix_count() { return _native_method_prefix_count; } 125 jvmtiError set_native_method_prefixes(jint prefix_count, char** prefixes); 126 127 private: 128 friend class JvmtiEventControllerPrivate; 129 void initialize(); 130 void set_event_callbacks(const jvmtiEventCallbacks* callbacks, jint size_of_callbacks); 131 static void globally_initialize(); 132 static void periodic_clean_up(); 133 134 friend class JvmtiEnvIterator; 135 JvmtiEnv* next_environment() { return (JvmtiEnv*)_next; } 136 void set_next_environment(JvmtiEnvBase* env) { _next = env; } 137 static JvmtiEnv* head_environment() { 138 JVMTI_ONLY(return (JvmtiEnv*)_head_environment); 139 NOT_JVMTI(return NULL); 140 } 141 142 public: 143 144 jvmtiPhase phase(); 145 bool is_valid(); 146 147 bool use_version_1_0_semantics(); // agent asked for version 1.0 148 bool use_version_1_1_semantics(); // agent asked for version 1.1 149 bool use_version_1_2_semantics(); // agent asked for version 1.2 150 151 bool is_retransformable() { return _is_retransformable; } 152 153 static ByteSize jvmti_external_offset() { 154 return byte_offset_of(JvmtiEnvBase, _jvmti_external); 155 }; 156 157 static JvmtiEnv* JvmtiEnv_from_jvmti_env(jvmtiEnv *env) { 158 return (JvmtiEnv*)((intptr_t)env - in_bytes(jvmti_external_offset())); 159 }; 160 161 jvmtiCapabilities *get_capabilities() { return &_current_capabilities; } 162 163 jvmtiCapabilities *get_prohibited_capabilities() { return &_prohibited_capabilities; } 164 165 bool early_class_hook_env() { 166 return get_capabilities()->can_generate_early_class_hook_events != 0 167 && get_capabilities()->can_generate_all_class_hook_events != 0; 168 } 169 170 bool early_vmstart_env() { 171 return get_capabilities()->can_generate_early_vmstart != 0; 172 } 173 174 static char** get_all_native_method_prefixes(int* count_ptr); 175 176 // This test will answer true when all environments have been disposed and some have 177 // not yet been deallocated. As a result, this test should only be used as an 178 // optimization for the no environment case. 179 static bool environments_might_exist() { 180 return head_environment() != NULL; 181 } 182 183 static void check_for_periodic_clean_up(); 184 185 JvmtiEnvEventEnable *env_event_enable() { 186 return &_env_event_enable; 187 } 188 189 jvmtiError allocate(jlong size, unsigned char** mem_ptr) { 190 if (size < 0) { 191 return JVMTI_ERROR_ILLEGAL_ARGUMENT; 192 } 193 if (size == 0) { 194 *mem_ptr = NULL; 195 } else { 196 *mem_ptr = (unsigned char *)os::malloc((size_t)size, mtInternal); 197 if (*mem_ptr == NULL) { 198 return JVMTI_ERROR_OUT_OF_MEMORY; 199 } 200 } 201 return JVMTI_ERROR_NONE; 202 } 203 204 jvmtiError deallocate(unsigned char* mem) { 205 if (mem != NULL) { 206 os::free(mem); 207 } 208 return JVMTI_ERROR_NONE; 209 } 210 211 212 // Memory functions 213 unsigned char* jvmtiMalloc(jlong size); // don't use this - call allocate 214 215 // method to create a local handle 216 jobject jni_reference(Handle hndl); 217 218 // method to create a local handle. 219 // This function allows caller to specify which 220 // threads local handle table to use. 221 jobject jni_reference(JavaThread *thread, Handle hndl); 222 223 // method to destroy a local handle 224 void destroy_jni_reference(jobject jobj); 225 226 // method to destroy a local handle. 227 // This function allows caller to specify which 228 // threads local handle table to use. 229 void destroy_jni_reference(JavaThread *thread, jobject jobj); 230 231 jvmtiEnv* jvmti_external() { return &_jvmti_external; }; 232 233 // Event Dispatch 234 235 bool has_callback(jvmtiEvent event_type) { 236 assert(event_type >= JVMTI_MIN_EVENT_TYPE_VAL && 237 event_type <= JVMTI_MAX_EVENT_TYPE_VAL, "checking"); 238 return ((void**)&_event_callbacks)[event_type-JVMTI_MIN_EVENT_TYPE_VAL] != NULL; 239 } 240 241 jvmtiEventCallbacks* callbacks() { 242 return &_event_callbacks; 243 } 244 245 jvmtiExtEventCallbacks* ext_callbacks() { 246 return &_ext_event_callbacks; 247 } 248 249 void set_tag_map(JvmtiTagMap* tag_map) { 250 _tag_map = tag_map; 251 } 252 253 JvmtiTagMap* tag_map() { 254 return _tag_map; 255 } 256 257 JvmtiTagMap* tag_map_acquire() { 258 return Atomic::load_acquire(&_tag_map); 259 } 260 261 void release_set_tag_map(JvmtiTagMap* tag_map) { 262 Atomic::release_store(&_tag_map, tag_map); 263 } 264 265 // return true if event is enabled globally or for any thread 266 // True only if there is a callback for it. 267 bool is_enabled(jvmtiEvent event_type) { 268 return _env_event_enable.is_enabled(event_type); 269 } 270 271 // Random Utilities 272 273 protected: 274 // helper methods for creating arrays of global JNI Handles from local Handles 275 // allocated into environment specific storage 276 jobject * new_jobjectArray(int length, Handle *handles); 277 jthread * new_jthreadArray(int length, Handle *handles); 278 jthreadGroup * new_jthreadGroupArray(int length, Handle *handles); 279 280 // convert to a jni jclass from a non-null Klass* 281 jclass get_jni_class_non_null(Klass* k); 282 283 jint count_locked_objects(JavaThread *java_thread, Handle hobj); 284 jvmtiError get_locked_objects_in_frame(JavaThread *calling_thread, 285 JavaThread* java_thread, 286 javaVFrame *jvf, 287 GrowableArray<jvmtiMonitorStackDepthInfo*>* owned_monitors_list, 288 jint depth); 289 vframe* vframeFor(JavaThread* java_thread, jint depth); 290 291 public: 292 // get a field descriptor for the specified class and field 293 static bool get_field_descriptor(Klass* k, jfieldID field, fieldDescriptor* fd); 294 295 // JVMTI API helper functions which are called at safepoint or thread is suspended. 296 jvmtiError get_frame_count(JvmtiThreadState *state, jint *count_ptr); 297 jvmtiError get_frame_location(JavaThread* java_thread, jint depth, 298 jmethodID* method_ptr, jlocation* location_ptr); 299 jvmtiError get_object_monitor_usage(JavaThread *calling_thread, 300 jobject object, jvmtiMonitorUsage* info_ptr); 301 jvmtiError get_stack_trace(JavaThread *java_thread, 302 jint stack_depth, jint max_count, 303 jvmtiFrameInfo* frame_buffer, jint* count_ptr); 304 jvmtiError get_current_contended_monitor(JavaThread *java_thread, 305 jobject *monitor_ptr); 306 jvmtiError get_owned_monitors(JavaThread* java_thread, 307 GrowableArray<jvmtiMonitorStackDepthInfo*> *owned_monitors_list); 308 jvmtiError check_top_frame(JavaThread* current_thread, JavaThread* java_thread, 309 jvalue value, TosState tos, Handle* ret_ob_h); 310 jvmtiError force_early_return(JavaThread* java_thread, jvalue value, TosState tos); 311 }; 312 313 // This class is the only safe means of iterating through environments. 314 // Note that this iteratation includes invalid environments pending 315 // deallocation -- in fact, some uses depend on this behavior. 316 317 class JvmtiEnvIterator : public StackObj { 318 private: 319 bool _entry_was_marked; 320 public: 321 JvmtiEnvIterator() { 322 if (Threads::number_of_threads() == 0) { 323 _entry_was_marked = false; // we are single-threaded, no need 324 } else { 325 Thread::current()->entering_jvmti_env_iteration(); 326 _entry_was_marked = true; 327 } 328 } 329 ~JvmtiEnvIterator() { 330 if (_entry_was_marked) { 331 Thread::current()->leaving_jvmti_env_iteration(); 332 } 333 } 334 JvmtiEnv* first() { return JvmtiEnvBase::head_environment(); } 335 JvmtiEnv* next(JvmtiEnvBase* env) { return env->next_environment(); } 336 }; 337 338 // VM operation to update for pop top frame. 339 class VM_UpdateForPopTopFrame : public VM_Operation { 340 private: 341 JvmtiThreadState* _state; 342 jvmtiError _result; 343 344 public: 345 VM_UpdateForPopTopFrame(JvmtiThreadState* state) { 346 _state = state; 347 _result = JVMTI_ERROR_NONE; 348 } 349 VMOp_Type type() const { return VMOp_UpdateForPopTopFrame; } 350 jvmtiError result() { return _result; } 351 void doit(); 352 }; 353 354 // VM operation to set frame pop. 355 class VM_SetFramePop : public VM_Operation { 356 private: 357 JvmtiEnv *_env; 358 JvmtiThreadState* _state; 359 jint _depth; 360 jvmtiError _result; 361 362 public: 363 VM_SetFramePop(JvmtiEnv *env, JvmtiThreadState* state, jint depth) { 364 _env = env; 365 _state = state; 366 _depth = depth; 367 _result = JVMTI_ERROR_NONE; 368 } 369 // Nested operation must be allowed for the VM_EnterInterpOnlyMode that is 370 // called from the JvmtiEventControllerPrivate::recompute_thread_enabled. 371 bool allow_nested_vm_operations() const { return true; } 372 VMOp_Type type() const { return VMOp_SetFramePop; } 373 jvmtiError result() { return _result; } 374 void doit(); 375 }; 376 377 378 // HandshakeClosure to get monitor information with stack depth. 379 class GetOwnedMonitorInfoClosure : public HandshakeClosure { 380 private: 381 JvmtiEnv *_env; 382 jvmtiError _result; 383 GrowableArray<jvmtiMonitorStackDepthInfo*> *_owned_monitors_list; 384 385 public: 386 GetOwnedMonitorInfoClosure(JvmtiEnv* env, 387 GrowableArray<jvmtiMonitorStackDepthInfo*>* owned_monitor_list) 388 : HandshakeClosure("GetOwnedMonitorInfo"), 389 _env(env), _result(JVMTI_ERROR_NONE), _owned_monitors_list(owned_monitor_list) {} 390 void do_thread(Thread *target); 391 jvmtiError result() { return _result; } 392 }; 393 394 395 // VM operation to get object monitor usage. 396 class VM_GetObjectMonitorUsage : public VM_Operation { 397 private: 398 JvmtiEnv *_env; 399 jobject _object; 400 JavaThread* _calling_thread; 401 jvmtiMonitorUsage* _info_ptr; 402 jvmtiError _result; 403 404 public: 405 VM_GetObjectMonitorUsage(JvmtiEnv *env, JavaThread* calling_thread, jobject object, jvmtiMonitorUsage* info_ptr) { 406 _env = env; 407 _object = object; 408 _calling_thread = calling_thread; 409 _info_ptr = info_ptr; 410 } 411 VMOp_Type type() const { return VMOp_GetObjectMonitorUsage; } 412 jvmtiError result() { return _result; } 413 void doit() { 414 _result = ((JvmtiEnvBase*) _env)->get_object_monitor_usage(_calling_thread, _object, _info_ptr); 415 } 416 417 }; 418 419 // HandshakeClosure to get current contended monitor. 420 class GetCurrentContendedMonitorClosure : public HandshakeClosure { 421 private: 422 JvmtiEnv *_env; 423 jobject *_owned_monitor_ptr; 424 jvmtiError _result; 425 426 public: 427 GetCurrentContendedMonitorClosure(JvmtiEnv *env, jobject *mon_ptr) 428 : HandshakeClosure("GetCurrentContendedMonitor"), 429 _env(env), _owned_monitor_ptr(mon_ptr), 430 _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {} 431 jvmtiError result() { return _result; } 432 void do_thread(Thread *target); 433 }; 434 435 // VM operation to get stack trace at safepoint. 436 class VM_GetStackTrace : public VM_Operation { 437 private: 438 JvmtiEnv *_env; 439 JavaThread *_java_thread; 440 jint _start_depth; 441 jint _max_count; 442 jvmtiFrameInfo *_frame_buffer; 443 jint *_count_ptr; 444 jvmtiError _result; 445 446 public: 447 VM_GetStackTrace(JvmtiEnv *env, JavaThread *java_thread, 448 jint start_depth, jint max_count, 449 jvmtiFrameInfo* frame_buffer, jint* count_ptr) { 450 _env = env; 451 _java_thread = java_thread; 452 _start_depth = start_depth; 453 _max_count = max_count; 454 _frame_buffer = frame_buffer; 455 _count_ptr = count_ptr; 456 } 457 jvmtiError result() { return _result; } 458 VMOp_Type type() const { return VMOp_GetStackTrace; } 459 void doit(); 460 }; 461 462 // forward declaration 463 struct StackInfoNode; 464 465 // VM operation to get stack trace at safepoint. 466 class VM_GetMultipleStackTraces : public VM_Operation { 467 private: 468 JvmtiEnv *_env; 469 jint _max_frame_count; 470 jvmtiStackInfo *_stack_info; 471 jvmtiError _result; 472 int _frame_count_total; 473 struct StackInfoNode *_head; 474 475 JvmtiEnvBase *env() { return (JvmtiEnvBase *)_env; } 476 jint max_frame_count() { return _max_frame_count; } 477 struct StackInfoNode *head() { return _head; } 478 void set_head(StackInfoNode *head) { _head = head; } 479 480 protected: 481 void set_result(jvmtiError result) { _result = result; } 482 void fill_frames(jthread jt, JavaThread *thr, oop thread_oop); 483 void allocate_and_fill_stacks(jint thread_count); 484 485 public: 486 VM_GetMultipleStackTraces(JvmtiEnv *env, jint max_frame_count) { 487 _env = env; 488 _max_frame_count = max_frame_count; 489 _frame_count_total = 0; 490 _head = NULL; 491 _result = JVMTI_ERROR_NONE; 492 } 493 VMOp_Type type() const { return VMOp_GetMultipleStackTraces; } 494 jvmtiStackInfo *stack_info() { return _stack_info; } 495 jvmtiError result() { return _result; } 496 }; 497 498 499 // VM operation to get stack trace at safepoint. 500 class VM_GetAllStackTraces : public VM_GetMultipleStackTraces { 501 private: 502 JavaThread *_calling_thread; 503 jint _final_thread_count; 504 505 public: 506 VM_GetAllStackTraces(JvmtiEnv *env, JavaThread *calling_thread, 507 jint max_frame_count) 508 : VM_GetMultipleStackTraces(env, max_frame_count) { 509 _calling_thread = calling_thread; 510 } 511 VMOp_Type type() const { return VMOp_GetAllStackTraces; } 512 void doit(); 513 jint final_thread_count() { return _final_thread_count; } 514 }; 515 516 // VM operation to get stack trace at safepoint. 517 class VM_GetThreadListStackTraces : public VM_GetMultipleStackTraces { 518 private: 519 jint _thread_count; 520 const jthread* _thread_list; 521 522 public: 523 VM_GetThreadListStackTraces(JvmtiEnv *env, jint thread_count, const jthread* thread_list, jint max_frame_count) 524 : VM_GetMultipleStackTraces(env, max_frame_count) { 525 _thread_count = thread_count; 526 _thread_list = thread_list; 527 } 528 VMOp_Type type() const { return VMOp_GetThreadListStackTraces; } 529 void doit(); 530 }; 531 532 533 // VM operation to count stack frames at safepoint. 534 class VM_GetFrameCount : public VM_Operation { 535 private: 536 JvmtiEnv *_env; 537 JvmtiThreadState *_state; 538 jint *_count_ptr; 539 jvmtiError _result; 540 541 public: 542 VM_GetFrameCount(JvmtiEnv *env, JvmtiThreadState *state, jint *count_ptr) { 543 _env = env; 544 _state = state; 545 _count_ptr = count_ptr; 546 } 547 VMOp_Type type() const { return VMOp_GetFrameCount; } 548 jvmtiError result() { return _result; } 549 void doit(); 550 }; 551 552 // VM operation to frame location at safepoint. 553 class VM_GetFrameLocation : public VM_Operation { 554 private: 555 JvmtiEnv *_env; 556 JavaThread* _java_thread; 557 jint _depth; 558 jmethodID* _method_ptr; 559 jlocation* _location_ptr; 560 jvmtiError _result; 561 562 public: 563 VM_GetFrameLocation(JvmtiEnv *env, JavaThread* java_thread, jint depth, 564 jmethodID* method_ptr, jlocation* location_ptr) { 565 _env = env; 566 _java_thread = java_thread; 567 _depth = depth; 568 _method_ptr = method_ptr; 569 _location_ptr = location_ptr; 570 } 571 VMOp_Type type() const { return VMOp_GetFrameLocation; } 572 jvmtiError result() { return _result; } 573 void doit(); 574 }; 575 576 577 // ResourceTracker 578 // 579 // ResourceTracker works a little like a ResourceMark. All allocates 580 // using the resource tracker are recorded. If an allocate using the 581 // resource tracker fails the destructor will free any resources 582 // that were allocated using the tracker. 583 // The motive for this class is to avoid messy error recovery code 584 // in situations where multiple allocations are done in sequence. If 585 // the second or subsequent allocation fails it avoids any code to 586 // release memory allocated in the previous calls. 587 // 588 // Usage :- 589 // ResourceTracker rt(env); 590 // : 591 // err = rt.allocate(1024, &ptr); 592 593 class ResourceTracker : public StackObj { 594 private: 595 JvmtiEnv* _env; 596 GrowableArray<unsigned char*> *_allocations; 597 bool _failed; 598 public: 599 ResourceTracker(JvmtiEnv* env); 600 ~ResourceTracker(); 601 jvmtiError allocate(jlong size, unsigned char** mem_ptr); 602 unsigned char* allocate(jlong size); 603 char* strdup(const char* str); 604 }; 605 606 607 // Jvmti monitor closure to collect off stack monitors. 608 class JvmtiMonitorClosure: public MonitorClosure { 609 private: 610 JavaThread *_java_thread; 611 JavaThread *_calling_thread; 612 GrowableArray<jvmtiMonitorStackDepthInfo*> *_owned_monitors_list; 613 jvmtiError _error; 614 JvmtiEnvBase *_env; 615 616 public: 617 JvmtiMonitorClosure(JavaThread* thread, JavaThread *calling_thread, 618 GrowableArray<jvmtiMonitorStackDepthInfo*> *owned_monitors, 619 JvmtiEnvBase *env) { 620 _java_thread = thread; 621 _calling_thread = calling_thread; 622 _owned_monitors_list = owned_monitors; 623 _error = JVMTI_ERROR_NONE; 624 _env = env; 625 } 626 void do_monitor(ObjectMonitor* mon); 627 jvmtiError error() { return _error;} 628 }; 629 630 631 // Jvmti module closure to collect all modules loaded to the system. 632 class JvmtiModuleClosure : public StackObj { 633 private: 634 static GrowableArray<OopHandle> *_tbl; // Protected with Module_lock 635 636 static void do_module(ModuleEntry* entry); 637 public: 638 jvmtiError get_all_modules(JvmtiEnv* env, jint* module_count_ptr, jobject** modules_ptr); 639 }; 640 641 #endif // SHARE_PRIMS_JVMTIENVBASE_HPP