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 when target thread is suspended
 296   // or at safepoint / thread local handshake.
 297   jvmtiError get_frame_count(JvmtiThreadState *state, jint *count_ptr);
 298   jvmtiError get_frame_location(JavaThread* java_thread, jint depth,
 299                                               jmethodID* method_ptr, jlocation* location_ptr);
 300   jvmtiError get_object_monitor_usage(JavaThread *calling_thread,
 301                                                     jobject object, jvmtiMonitorUsage* info_ptr);
 302   jvmtiError get_stack_trace(JavaThread *java_thread,
 303                                            jint stack_depth, jint max_count,
 304                                            jvmtiFrameInfo* frame_buffer, jint* count_ptr);
 305   jvmtiError get_current_contended_monitor(JavaThread *calling_thread, JavaThread *java_thread,
 306                                            jobject *monitor_ptr);
 307   jvmtiError get_owned_monitors(JavaThread *calling_thread, JavaThread* java_thread,
 308                                 GrowableArray<jvmtiMonitorStackDepthInfo*> *owned_monitors_list);
 309   jvmtiError check_top_frame(JavaThread* current_thread, JavaThread* java_thread,
 310                              jvalue value, TosState tos, Handle* ret_ob_h);
 311   jvmtiError force_early_return(JavaThread* java_thread, jvalue value, TosState tos);
 312 };
 313 
 314 // This class is the only safe means of iterating through environments.
 315 // Note that this iteratation includes invalid environments pending
 316 // deallocation -- in fact, some uses depend on this behavior.
 317 
 318 class JvmtiEnvIterator : public StackObj {
 319  private:
 320   bool _entry_was_marked;
 321  public:
 322   JvmtiEnvIterator() {
 323     if (Threads::number_of_threads() == 0) {
 324       _entry_was_marked = false; // we are single-threaded, no need
 325     } else {
 326       Thread::current()->entering_jvmti_env_iteration();
 327       _entry_was_marked = true;
 328     }
 329   }
 330   ~JvmtiEnvIterator() {
 331     if (_entry_was_marked) {
 332       Thread::current()->leaving_jvmti_env_iteration();
 333     }
 334   }
 335   JvmtiEnv* first()                 { return JvmtiEnvBase::head_environment(); }
 336   JvmtiEnv* next(JvmtiEnvBase* env) { return env->next_environment(); }
 337 };
 338 
 339 // HandshakeClosure to update for pop top frame.
 340 class UpdateForPopTopFrameClosure : public HandshakeClosure {
 341 private:
 342   JvmtiThreadState* _state;
 343   jvmtiError _result;
 344 
 345 public:
 346   UpdateForPopTopFrameClosure(JvmtiThreadState* state)
 347     : HandshakeClosure("UpdateForPopTopFrame"),
 348       _state(state),
 349       _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {}
 350   jvmtiError result() { return _result; }
 351   void do_thread(Thread *target);
 352 };
 353 
 354 // HandshakeClosure to set frame pop.
 355 class SetFramePopClosure : public HandshakeClosure {
 356 private:
 357   JvmtiEnv *_env;
 358   JvmtiThreadState* _state;
 359   jint _depth;
 360   jvmtiError _result;
 361 
 362 public:
 363   SetFramePopClosure(JvmtiEnv *env, JvmtiThreadState* state, jint depth)
 364     : HandshakeClosure("SetFramePop"),
 365       _env(env),
 366       _state(state),
 367       _depth(depth),
 368       _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {}
 369   jvmtiError result() { return _result; }
 370   void do_thread(Thread *target);
 371 };
 372 
 373 
 374 // HandshakeClosure to get monitor information with stack depth.
 375 class GetOwnedMonitorInfoClosure : public HandshakeClosure {
 376 private:
 377   JavaThread* _calling_thread;
 378   JvmtiEnv *_env;
 379   jvmtiError _result;
 380   GrowableArray<jvmtiMonitorStackDepthInfo*> *_owned_monitors_list;
 381 
 382 public:
 383   GetOwnedMonitorInfoClosure(JavaThread* calling_thread, JvmtiEnv* env,
 384                              GrowableArray<jvmtiMonitorStackDepthInfo*>* owned_monitor_list)
 385     : HandshakeClosure("GetOwnedMonitorInfo"),
 386       _calling_thread(calling_thread),
 387       _env(env),
 388       _result(JVMTI_ERROR_THREAD_NOT_ALIVE),
 389       _owned_monitors_list(owned_monitor_list) {}
 390   jvmtiError result() { return _result; }
 391   void do_thread(Thread *target);
 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   JavaThread *_calling_thread;
 423   JvmtiEnv *_env;
 424   jobject *_owned_monitor_ptr;
 425   jvmtiError _result;
 426 
 427 public:
 428   GetCurrentContendedMonitorClosure(JavaThread* calling_thread, JvmtiEnv *env, jobject *mon_ptr)
 429     : HandshakeClosure("GetCurrentContendedMonitor"),
 430       _calling_thread(calling_thread),
 431       _env(env),
 432       _owned_monitor_ptr(mon_ptr),
 433       _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {}
 434   jvmtiError result() { return _result; }
 435   void do_thread(Thread *target);
 436 };
 437 
 438 // HandshakeClosure to get stack trace.
 439 class GetStackTraceClosure : public HandshakeClosure {
 440 private:
 441   JvmtiEnv *_env;
 442   jint _start_depth;
 443   jint _max_count;
 444   jvmtiFrameInfo *_frame_buffer;
 445   jint *_count_ptr;
 446   jvmtiError _result;
 447 
 448 public:
 449   GetStackTraceClosure(JvmtiEnv *env, jint start_depth, jint max_count,
 450                        jvmtiFrameInfo* frame_buffer, jint* count_ptr)
 451     : HandshakeClosure("GetStackTrace"),
 452       _env(env),
 453       _start_depth(start_depth),
 454       _max_count(max_count),
 455       _frame_buffer(frame_buffer),
 456       _count_ptr(count_ptr),
 457       _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {
 458   }
 459   jvmtiError result() { return _result; }
 460   void do_thread(Thread *target);
 461 };
 462 
 463 // forward declaration
 464 struct StackInfoNode;
 465 
 466 // Get stack trace at safepoint or at direct handshake.
 467 class MultipleStackTracesCollector {
 468 private:
 469   JvmtiEnv *_env;
 470   jint _max_frame_count;
 471   jvmtiStackInfo *_stack_info;
 472   jvmtiError _result;
 473   int _frame_count_total;
 474   struct StackInfoNode *_head;
 475 
 476   JvmtiEnvBase *env()                 { return (JvmtiEnvBase *)_env; }
 477   jint max_frame_count()              { return _max_frame_count; }
 478   struct StackInfoNode *head()        { return _head; }
 479   void set_head(StackInfoNode *head)  { _head = head; }
 480 
 481 public:
 482   MultipleStackTracesCollector(JvmtiEnv *env, jint max_frame_count)
 483     : _env(env),
 484       _max_frame_count(max_frame_count),
 485       _stack_info(NULL),
 486       _result(JVMTI_ERROR_NONE),
 487       _frame_count_total(0),
 488       _head(NULL) {
 489   }
 490   void set_result(jvmtiError result)  { _result = result; }
 491   void fill_frames(jthread jt, JavaThread *thr, oop thread_oop);
 492   void allocate_and_fill_stacks(jint thread_count);
 493   jvmtiStackInfo *stack_info()       { return _stack_info; }
 494   jvmtiError result()                { return _result; }
 495 };
 496 
 497 
 498 // VM operation to get stack trace at safepoint.
 499 class VM_GetAllStackTraces : public VM_Operation {
 500 private:
 501   JavaThread *_calling_thread;
 502   jint _final_thread_count;
 503   MultipleStackTracesCollector _collector;
 504 
 505 public:
 506   VM_GetAllStackTraces(JvmtiEnv *env, JavaThread *calling_thread,
 507                        jint max_frame_count)
 508       : _calling_thread(calling_thread),
 509         _final_thread_count(0),
 510         _collector(env, max_frame_count) {
 511   }
 512   VMOp_Type type() const          { return VMOp_GetAllStackTraces; }
 513   void doit();
 514   jint final_thread_count()       { return _final_thread_count; }
 515   jvmtiStackInfo *stack_info()    { return _collector.stack_info(); }
 516   jvmtiError result()             { return _collector.result(); }
 517 };
 518 
 519 // VM operation to get stack trace at safepoint.
 520 class VM_GetThreadListStackTraces : public VM_Operation {
 521 private:
 522   jint _thread_count;
 523   const jthread* _thread_list;
 524   MultipleStackTracesCollector _collector;
 525 
 526 public:
 527   VM_GetThreadListStackTraces(JvmtiEnv *env, jint thread_count, const jthread* thread_list, jint max_frame_count)
 528       : _thread_count(thread_count),
 529         _thread_list(thread_list),
 530         _collector(env, max_frame_count) {
 531   }
 532   VMOp_Type type() const { return VMOp_GetThreadListStackTraces; }
 533   void doit();
 534   jvmtiStackInfo *stack_info()    { return _collector.stack_info(); }
 535   jvmtiError result()             { return _collector.result(); }
 536 };
 537 
 538 // HandshakeClosure to get single stack trace.
 539 class GetSingleStackTraceClosure : public HandshakeClosure {
 540 private:
 541   JavaThread *_calling_thread;
 542   jthread _jthread;
 543   MultipleStackTracesCollector _collector;
 544 
 545 public:
 546   GetSingleStackTraceClosure(JvmtiEnv *env, JavaThread *calling_thread,
 547                              jthread thread, jint max_frame_count)
 548     : HandshakeClosure("GetSingleStackTrace"),
 549       _calling_thread(calling_thread),
 550       _jthread(thread),
 551       _collector(env, max_frame_count) {
 552   }
 553   void do_thread(Thread *target);
 554   jvmtiStackInfo *stack_info()    { return _collector.stack_info(); }
 555   jvmtiError result()             { return _collector.result(); }
 556 };
 557 
 558 // HandshakeClosure to count stack frames.
 559 class GetFrameCountClosure : public HandshakeClosure {
 560 private:
 561   JvmtiEnv *_env;
 562   JvmtiThreadState *_state;
 563   jint *_count_ptr;
 564   jvmtiError _result;
 565 
 566 public:
 567   GetFrameCountClosure(JvmtiEnv *env, JvmtiThreadState *state, jint *count_ptr)
 568     : HandshakeClosure("GetFrameCount"),
 569       _env(env),
 570       _state(state),
 571       _count_ptr(count_ptr),
 572       _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {
 573   }
 574   jvmtiError result()    { return _result; }
 575   void do_thread(Thread *target);
 576 };
 577 
 578 // HandshakeClosure to get frame location.
 579 class GetFrameLocationClosure : public HandshakeClosure {
 580 private:
 581   JvmtiEnv *_env;
 582   jint _depth;
 583   jmethodID* _method_ptr;
 584   jlocation* _location_ptr;
 585   jvmtiError _result;
 586 
 587 public:
 588   GetFrameLocationClosure(JvmtiEnv *env, jint depth,
 589                           jmethodID* method_ptr, jlocation* location_ptr)
 590     : HandshakeClosure("GetFrameLocation"),
 591       _env(env),
 592       _depth(depth),
 593       _method_ptr(method_ptr),
 594       _location_ptr(location_ptr),
 595       _result(JVMTI_ERROR_THREAD_NOT_ALIVE) {
 596   }
 597   jvmtiError result()    { return _result; }
 598   void do_thread(Thread *target);
 599 };
 600 
 601 
 602 // ResourceTracker
 603 //
 604 // ResourceTracker works a little like a ResourceMark. All allocates
 605 // using the resource tracker are recorded. If an allocate using the
 606 // resource tracker fails the destructor will free any resources
 607 // that were allocated using the tracker.
 608 // The motive for this class is to avoid messy error recovery code
 609 // in situations where multiple allocations are done in sequence. If
 610 // the second or subsequent allocation fails it avoids any code to
 611 // release memory allocated in the previous calls.
 612 //
 613 // Usage :-
 614 //   ResourceTracker rt(env);
 615 //   :
 616 //   err = rt.allocate(1024, &ptr);
 617 
 618 class ResourceTracker : public StackObj {
 619  private:
 620   JvmtiEnv* _env;
 621   GrowableArray<unsigned char*> *_allocations;
 622   bool _failed;
 623  public:
 624   ResourceTracker(JvmtiEnv* env);
 625   ~ResourceTracker();
 626   jvmtiError allocate(jlong size, unsigned char** mem_ptr);
 627   unsigned char* allocate(jlong size);
 628   char* strdup(const char* str);
 629 };
 630 
 631 
 632 // Jvmti monitor closure to collect off stack monitors.
 633 class JvmtiMonitorClosure: public MonitorClosure {
 634  private:
 635   JavaThread *_java_thread;
 636   JavaThread *_calling_thread;
 637   GrowableArray<jvmtiMonitorStackDepthInfo*> *_owned_monitors_list;
 638   jvmtiError _error;
 639   JvmtiEnvBase *_env;
 640 
 641  public:
 642   JvmtiMonitorClosure(JavaThread* thread, JavaThread *calling_thread,
 643                       GrowableArray<jvmtiMonitorStackDepthInfo*> *owned_monitors,
 644                       JvmtiEnvBase *env) {
 645     _java_thread = thread;
 646     _calling_thread = calling_thread;
 647     _owned_monitors_list = owned_monitors;
 648     _error = JVMTI_ERROR_NONE;
 649     _env = env;
 650   }
 651   void do_monitor(ObjectMonitor* mon);
 652   jvmtiError error() { return _error;}
 653 };
 654 
 655 
 656 // Jvmti module closure to collect all modules loaded to the system.
 657 class JvmtiModuleClosure : public StackObj {
 658 private:
 659   static GrowableArray<OopHandle> *_tbl; // Protected with Module_lock
 660 
 661   static void do_module(ModuleEntry* entry);
 662 public:
 663   jvmtiError get_all_modules(JvmtiEnv* env, jint* module_count_ptr, jobject** modules_ptr);
 664 };
 665 
 666 #endif // SHARE_PRIMS_JVMTIENVBASE_HPP