1 /*
   2  * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_RUNTIME_VM_OPERATIONS_HPP
  26 #define SHARE_VM_RUNTIME_VM_OPERATIONS_HPP
  27 
  28 #include "classfile/javaClasses.hpp"
  29 #include "memory/allocation.hpp"
  30 #include "oops/oop.hpp"
  31 #include "runtime/thread.hpp"
  32 #include "utilities/top.hpp"
  33 
  34 // The following classes are used for operations
  35 // initiated by a Java thread but that must
  36 // take place in the VMThread.
  37 
  38 #define VM_OP_ENUM(type)   VMOp_##type,
  39 
  40 // Note: When new VM_XXX comes up, add 'XXX' to the template table.
  41 #define VM_OPS_DO(template)                       \
  42   template(Dummy)                                 \
  43   template(ThreadStop)                            \
  44   template(ThreadDump)                            \
  45   template(PrintThreads)                          \
  46   template(FindDeadlocks)                         \
  47   template(ForceSafepoint)                        \
  48   template(ForceAsyncSafepoint)                   \
  49   template(Deoptimize)                            \
  50   template(DeoptimizeFrame)                       \
  51   template(DeoptimizeAll)                         \
  52   template(ZombieAll)                             \
  53   template(UnlinkSymbols)                         \
  54   template(Verify)                                \
  55   template(PrintJNI)                              \
  56   template(HeapDumper)                            \
  57   template(DeoptimizeTheWorld)                    \
  58   template(CollectForMetadataAllocation)          \
  59   template(GC_HeapInspection)                     \
  60   template(GenCollectFull)                        \
  61   template(GenCollectFullConcurrent)              \
  62   template(GenCollectForAllocation)               \
  63   template(ParallelGCFailedAllocation)            \
  64   template(ParallelGCSystemGC)                    \
  65   template(CGC_Operation)                         \
  66   template(CMS_Initial_Mark)                      \
  67   template(CMS_Final_Remark)                      \
  68   template(G1CollectFull)                         \
  69   template(G1CollectForAllocation)                \
  70   template(G1IncCollectionPause)                  \
  71   template(DestroyAllocationContext)              \
  72   template(EnableBiasedLocking)                   \
  73   template(RevokeBias)                            \
  74   template(BulkRevokeBias)                        \
  75   template(PopulateDumpSharedSpace)               \
  76   template(JNIFunctionTableCopier)                \
  77   template(RedefineClasses)                       \
  78   template(UpdateForPopTopFrame)                  \
  79   template(SetFramePop)                           \
  80   template(GetOwnedMonitorInfo)                   \
  81   template(GetObjectMonitorUsage)                 \
  82   template(GetCurrentContendedMonitor)            \
  83   template(GetStackTrace)                         \
  84   template(GetMultipleStackTraces)                \
  85   template(GetAllStackTraces)                     \
  86   template(GetThreadListStackTraces)              \
  87   template(GetFrameCount)                         \
  88   template(GetFrameLocation)                      \
  89   template(ChangeBreakpoints)                     \
  90   template(GetOrSetLocal)                         \
  91   template(GetCurrentLocation)                    \
  92   template(EnterInterpOnlyMode)                   \
  93   template(ChangeSingleStep)                      \
  94   template(HeapWalkOperation)                     \
  95   template(HeapIterateOperation)                  \
  96   template(ReportJavaOutOfMemory)                 \
  97   template(JFRCheckpoint)                         \
  98   template(Exit)                                  \
  99   template(LinuxDllLoad)                          \
 100   template(RotateGCLog)                           \
 101   template(WhiteBoxOperation)                     \
 102   template(ClassLoaderStatsOperation)             \
 103   template(MarkActiveNMethods)                    \
 104   template(PrintCompileQueue)                     \
 105   template(PrintCodeList)                         \
 106   template(PrintCodeCache)                        \
 107 
 108 class VM_Operation: public CHeapObj<mtInternal> {
 109  public:
 110   enum Mode {
 111     _safepoint,       // blocking,        safepoint, vm_op C-heap allocated
 112     _no_safepoint,    // blocking,     no safepoint, vm_op C-Heap allocated
 113     _concurrent,      // non-blocking, no safepoint, vm_op C-Heap allocated
 114     _async_safepoint  // non-blocking,    safepoint, vm_op C-Heap allocated
 115   };
 116 
 117   enum VMOp_Type {
 118     VM_OPS_DO(VM_OP_ENUM)
 119     VMOp_Terminating
 120   };
 121 
 122  private:
 123   Thread*         _calling_thread;
 124   ThreadPriority  _priority;
 125   long            _timestamp;
 126   VM_Operation*   _next;
 127   VM_Operation*   _prev;
 128 
 129   // The VM operation name array
 130   static const char* _names[];
 131 
 132  public:
 133   VM_Operation()  { _calling_thread = NULL; _next = NULL; _prev = NULL; }
 134   virtual ~VM_Operation() {}
 135 
 136   // VM operation support (used by VM thread)
 137   Thread* calling_thread() const                 { return _calling_thread; }
 138   ThreadPriority priority()                      { return _priority; }
 139   void set_calling_thread(Thread* thread, ThreadPriority priority);
 140 
 141   long timestamp() const              { return _timestamp; }
 142   void set_timestamp(long timestamp)  { _timestamp = timestamp; }
 143 
 144   // Called by VM thread - does in turn invoke doit(). Do not override this
 145   void evaluate();
 146 
 147   // evaluate() is called by the VMThread and in turn calls doit().
 148   // If the thread invoking VMThread::execute((VM_Operation*) is a JavaThread,
 149   // doit_prologue() is called in that thread before transferring control to
 150   // the VMThread.
 151   // If doit_prologue() returns true the VM operation will proceed, and
 152   // doit_epilogue() will be called by the JavaThread once the VM operation
 153   // completes. If doit_prologue() returns false the VM operation is cancelled.
 154   virtual void doit()                            = 0;
 155   virtual bool doit_prologue()                   { return true; };
 156   virtual void doit_epilogue()                   {}; // Note: Not called if mode is: _concurrent
 157 
 158   // Type test
 159   virtual bool is_methodCompiler() const         { return false; }
 160 
 161   // Linking
 162   VM_Operation *next() const                     { return _next; }
 163   VM_Operation *prev() const                     { return _prev; }
 164   void set_next(VM_Operation *next)              { _next = next; }
 165   void set_prev(VM_Operation *prev)              { _prev = prev; }
 166 
 167   // Configuration. Override these appropriately in subclasses.
 168   virtual VMOp_Type type() const = 0;
 169   virtual Mode evaluation_mode() const            { return _safepoint; }
 170   virtual bool allow_nested_vm_operations() const { return false; }
 171   virtual bool is_cheap_allocated() const         { return false; }
 172   virtual void oops_do(OopClosure* f)              { /* do nothing */ };
 173 
 174   // CAUTION: <don't hang yourself with following rope>
 175   // If you override these methods, make sure that the evaluation
 176   // of these methods is race-free and non-blocking, since these
 177   // methods may be evaluated either by the mutators or by the
 178   // vm thread, either concurrently with mutators or with the mutators
 179   // stopped. In other words, taking locks is verboten, and if there
 180   // are any races in evaluating the conditions, they'd better be benign.
 181   virtual bool evaluate_at_safepoint() const {
 182     return evaluation_mode() == _safepoint  ||
 183            evaluation_mode() == _async_safepoint;
 184   }
 185   virtual bool evaluate_concurrently() const {
 186     return evaluation_mode() == _concurrent ||
 187            evaluation_mode() == _async_safepoint;
 188   }
 189 
 190   static const char* mode_to_string(Mode mode);
 191 
 192   // Debugging
 193   void print_on_error(outputStream* st) const;
 194   const char* name() const { return _names[type()]; }
 195   static const char* name(int type) {
 196     assert(type >= 0 && type < VMOp_Terminating, "invalid VM operation type");
 197     return _names[type];
 198   }
 199 #ifndef PRODUCT
 200   void print_on(outputStream* st) const { print_on_error(st); }
 201 #endif
 202 };
 203 
 204 class VM_ThreadStop: public VM_Operation {
 205  private:
 206   oop     _thread;        // The Thread that the Throwable is thrown against
 207   oop     _throwable;     // The Throwable thrown at the target Thread
 208  public:
 209   // All oops are passed as JNI handles, since there is no guarantee that a GC might happen before the
 210   // VM operation is executed.
 211   VM_ThreadStop(oop thread, oop throwable) {
 212     _thread    = thread;
 213     _throwable = throwable;
 214   }
 215   VMOp_Type type() const                         { return VMOp_ThreadStop; }
 216   oop target_thread() const                      { return _thread; }
 217   oop throwable() const                          { return _throwable;}
 218   void doit();
 219   // We deoptimize if top-most frame is compiled - this might require a C2I adapter to be generated
 220   bool allow_nested_vm_operations() const        { return true; }
 221   Mode evaluation_mode() const                   { return _async_safepoint; }
 222   bool is_cheap_allocated() const                { return true; }
 223 
 224   // GC support
 225   void oops_do(OopClosure* f) {
 226     f->do_oop(&_thread); f->do_oop(&_throwable);
 227   }
 228 };
 229 
 230 // dummy vm op, evaluated just to force a safepoint
 231 class VM_ForceSafepoint: public VM_Operation {
 232  public:
 233   VM_ForceSafepoint() {}
 234   void doit()         {}
 235   VMOp_Type type() const { return VMOp_ForceSafepoint; }
 236 };
 237 
 238 // dummy vm op, evaluated just to force a safepoint
 239 class VM_ForceAsyncSafepoint: public VM_Operation {
 240  public:
 241   VM_ForceAsyncSafepoint() {}
 242   void doit()              {}
 243   VMOp_Type type() const                         { return VMOp_ForceAsyncSafepoint; }
 244   Mode evaluation_mode() const                   { return _async_safepoint; }
 245   bool is_cheap_allocated() const                { return true; }
 246 };
 247 
 248 class VM_Deoptimize: public VM_Operation {
 249  public:
 250   VM_Deoptimize() {}
 251   VMOp_Type type() const                        { return VMOp_Deoptimize; }
 252   void doit();
 253   bool allow_nested_vm_operations() const        { return true; }
 254 };
 255 
 256 class VM_MarkActiveNMethods: public VM_Operation {
 257  public:
 258   VM_MarkActiveNMethods() {}
 259   VMOp_Type type() const                         { return VMOp_MarkActiveNMethods; }
 260   void doit();
 261   bool allow_nested_vm_operations() const        { return true; }
 262 };
 263 
 264 // Deopt helper that can deoptimize frames in threads other than the
 265 // current thread.  Only used through Deoptimization::deoptimize_frame.
 266 class VM_DeoptimizeFrame: public VM_Operation {
 267   friend class Deoptimization;
 268 
 269  private:
 270   JavaThread* _thread;
 271   intptr_t*   _id;
 272   VM_DeoptimizeFrame(JavaThread* thread, intptr_t* id);
 273 
 274  public:
 275   VMOp_Type type() const                         { return VMOp_DeoptimizeFrame; }
 276   void doit();
 277   bool allow_nested_vm_operations() const        { return true;  }
 278 };
 279 
 280 #ifndef PRODUCT
 281 class VM_DeoptimizeAll: public VM_Operation {
 282  private:
 283   KlassHandle _dependee;
 284  public:
 285   VM_DeoptimizeAll() {}
 286   VMOp_Type type() const                         { return VMOp_DeoptimizeAll; }
 287   void doit();
 288   bool allow_nested_vm_operations() const        { return true; }
 289 };
 290 
 291 
 292 class VM_ZombieAll: public VM_Operation {
 293  public:
 294   VM_ZombieAll() {}
 295   VMOp_Type type() const                         { return VMOp_ZombieAll; }
 296   void doit();
 297   bool allow_nested_vm_operations() const        { return true; }
 298 };
 299 #endif // PRODUCT
 300 
 301 class VM_UnlinkSymbols: public VM_Operation {
 302  public:
 303   VM_UnlinkSymbols() {}
 304   VMOp_Type type() const                         { return VMOp_UnlinkSymbols; }
 305   void doit();
 306   bool allow_nested_vm_operations() const        { return true; }
 307 };
 308 
 309 class VM_Verify: public VM_Operation {
 310  private:
 311   bool _silent;
 312  public:
 313   VM_Verify(bool silent = VerifySilently) : _silent(silent) {}
 314   VMOp_Type type() const { return VMOp_Verify; }
 315   void doit();
 316 };
 317 
 318 
 319 class VM_PrintThreads: public VM_Operation {
 320  private:
 321   outputStream* _out;
 322   bool _print_concurrent_locks;
 323  public:
 324   VM_PrintThreads()                                                { _out = tty; _print_concurrent_locks = PrintConcurrentLocks; }
 325   VM_PrintThreads(outputStream* out, bool print_concurrent_locks)  { _out = out; _print_concurrent_locks = print_concurrent_locks; }
 326   VMOp_Type type() const                                           {  return VMOp_PrintThreads; }
 327   void doit();
 328   bool doit_prologue();
 329   void doit_epilogue();
 330 };
 331 
 332 class VM_PrintJNI: public VM_Operation {
 333  private:
 334   outputStream* _out;
 335  public:
 336   VM_PrintJNI()                         { _out = tty; }
 337   VM_PrintJNI(outputStream* out)        { _out = out; }
 338   VMOp_Type type() const                { return VMOp_PrintJNI; }
 339   void doit();
 340 };
 341 
 342 class DeadlockCycle;
 343 class VM_FindDeadlocks: public VM_Operation {
 344  private:
 345   bool           _concurrent_locks;
 346   DeadlockCycle* _deadlocks;
 347   outputStream*  _out;
 348 
 349  public:
 350   VM_FindDeadlocks(bool concurrent_locks) :  _concurrent_locks(concurrent_locks), _out(NULL), _deadlocks(NULL) {};
 351   VM_FindDeadlocks(outputStream* st) : _concurrent_locks(true), _out(st), _deadlocks(NULL) {};
 352   ~VM_FindDeadlocks();
 353 
 354   DeadlockCycle* result()      { return _deadlocks; };
 355   VMOp_Type type() const       { return VMOp_FindDeadlocks; }
 356   void doit();
 357   bool doit_prologue();
 358 };
 359 
 360 class ThreadDumpResult;
 361 class ThreadSnapshot;
 362 class ThreadConcurrentLocks;
 363 
 364 class VM_ThreadDump : public VM_Operation {
 365  private:
 366   ThreadDumpResult*              _result;
 367   int                            _num_threads;
 368   GrowableArray<instanceHandle>* _threads;
 369   int                            _max_depth;
 370   bool                           _with_locked_monitors;
 371   bool                           _with_locked_synchronizers;
 372 
 373   ThreadSnapshot* snapshot_thread(JavaThread* java_thread, ThreadConcurrentLocks* tcl);
 374 
 375  public:
 376   VM_ThreadDump(ThreadDumpResult* result,
 377                 int max_depth,  // -1 indicates entire stack
 378                 bool with_locked_monitors,
 379                 bool with_locked_synchronizers);
 380 
 381   VM_ThreadDump(ThreadDumpResult* result,
 382                 GrowableArray<instanceHandle>* threads,
 383                 int num_threads, // -1 indicates entire stack
 384                 int max_depth,
 385                 bool with_locked_monitors,
 386                 bool with_locked_synchronizers);
 387 
 388   VMOp_Type type() const { return VMOp_ThreadDump; }
 389   void doit();
 390   bool doit_prologue();
 391   void doit_epilogue();
 392 };
 393 
 394 
 395 class VM_Exit: public VM_Operation {
 396  private:
 397   int  _exit_code;
 398   static volatile bool _vm_exited;
 399   static Thread * _shutdown_thread;
 400   static void wait_if_vm_exited();
 401  public:
 402   VM_Exit(int exit_code) {
 403     _exit_code = exit_code;
 404   }
 405   static int wait_for_threads_in_native_to_block();
 406   static int set_vm_exited();
 407   static bool vm_exited()                      { return _vm_exited; }
 408   static void block_if_vm_exited() {
 409     if (_vm_exited) {
 410       wait_if_vm_exited();
 411     }
 412   }
 413   VMOp_Type type() const { return VMOp_Exit; }
 414   void doit();
 415 };
 416 
 417 
 418 class VM_RotateGCLog: public VM_Operation {
 419  private:
 420   outputStream* _out;
 421 
 422  public:
 423   VM_RotateGCLog(outputStream* st) : _out(st) {}
 424   VMOp_Type type() const { return VMOp_RotateGCLog; }
 425   void doit() { gclog_or_tty->rotate_log(true, _out); }
 426 };
 427 
 428 class VM_PrintCompileQueue: public VM_Operation {
 429  private:
 430   outputStream* _out;
 431 
 432  public:
 433   VM_PrintCompileQueue(outputStream* st) : _out(st) {}
 434   VMOp_Type type() const { return VMOp_PrintCompileQueue; }
 435   Mode evaluation_mode() const { return _no_safepoint; }
 436   void doit();
 437 };
 438 
 439 class VM_PrintCodeList: public VM_Operation {
 440  private:
 441   outputStream* _out;
 442 
 443  public:
 444   VM_PrintCodeList(outputStream* st) : _out(st) {}
 445   VMOp_Type type() const { return VMOp_PrintCodeList; }
 446   void doit();
 447 };
 448 
 449 class VM_PrintCodeCache: public VM_Operation {
 450  private:
 451   outputStream* _out;
 452 
 453  public:
 454   VM_PrintCodeCache(outputStream* st) : _out(st) {}
 455   VMOp_Type type() const { return VMOp_PrintCodeCache; }
 456   void doit();
 457 };
 458 
 459 
 460 #endif // SHARE_VM_RUNTIME_VM_OPERATIONS_HPP