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(PrintCompileQueue)                     \
 104   template(PrintCodeList)                         \
 105   template(PrintCodeCache)                        \
 106 
 107 class VM_Operation: public CHeapObj<mtInternal> {
 108  public:
 109   enum Mode {
 110     _safepoint,       // blocking,        safepoint, vm_op C-heap allocated
 111     _no_safepoint,    // blocking,     no safepoint, vm_op C-Heap allocated
 112     _concurrent,      // non-blocking, no safepoint, vm_op C-Heap allocated
 113     _async_safepoint  // non-blocking,    safepoint, vm_op C-Heap allocated
 114   };
 115 
 116   enum VMOp_Type {
 117     VM_OPS_DO(VM_OP_ENUM)
 118     VMOp_Terminating
 119   };
 120 
 121  private:
 122   Thread*         _calling_thread;
 123   ThreadPriority  _priority;
 124   long            _timestamp;
 125   VM_Operation*   _next;
 126   VM_Operation*   _prev;
 127 
 128   // The VM operation name array
 129   static const char* _names[];
 130 
 131  public:
 132   VM_Operation()  { _calling_thread = NULL; _next = NULL; _prev = NULL; }
 133   virtual ~VM_Operation() {}
 134 
 135   // VM operation support (used by VM thread)
 136   Thread* calling_thread() const                 { return _calling_thread; }
 137   ThreadPriority priority()                      { return _priority; }
 138   void set_calling_thread(Thread* thread, ThreadPriority priority);
 139 
 140   long timestamp() const              { return _timestamp; }
 141   void set_timestamp(long timestamp)  { _timestamp = timestamp; }
 142 
 143   // Called by VM thread - does in turn invoke doit(). Do not override this
 144   void evaluate();
 145 
 146   // evaluate() is called by the VMThread and in turn calls doit().
 147   // If the thread invoking VMThread::execute((VM_Operation*) is a JavaThread,
 148   // doit_prologue() is called in that thread before transferring control to
 149   // the VMThread.
 150   // If doit_prologue() returns true the VM operation will proceed, and
 151   // doit_epilogue() will be called by the JavaThread once the VM operation
 152   // completes. If doit_prologue() returns false the VM operation is cancelled.
 153   virtual void doit()                            = 0;
 154   virtual bool doit_prologue()                   { return true; };
 155   virtual void doit_epilogue()                   {}; // Note: Not called if mode is: _concurrent
 156 
 157   // Type test
 158   virtual bool is_methodCompiler() const         { return false; }
 159 
 160   // Linking
 161   VM_Operation *next() const                     { return _next; }
 162   VM_Operation *prev() const                     { return _prev; }
 163   void set_next(VM_Operation *next)              { _next = next; }
 164   void set_prev(VM_Operation *prev)              { _prev = prev; }
 165 
 166   // Configuration. Override these appropriately in subclasses.
 167   virtual VMOp_Type type() const = 0;
 168   virtual Mode evaluation_mode() const            { return _safepoint; }
 169   virtual bool allow_nested_vm_operations() const { return false; }
 170   virtual bool is_cheap_allocated() const         { return false; }
 171   virtual void oops_do(OopClosure* f)              { /* do nothing */ };
 172 
 173   // CAUTION: <don't hang yourself with following rope>
 174   // If you override these methods, make sure that the evaluation
 175   // of these methods is race-free and non-blocking, since these
 176   // methods may be evaluated either by the mutators or by the
 177   // vm thread, either concurrently with mutators or with the mutators
 178   // stopped. In other words, taking locks is verboten, and if there
 179   // are any races in evaluating the conditions, they'd better be benign.
 180   virtual bool evaluate_at_safepoint() const {
 181     return evaluation_mode() == _safepoint  ||
 182            evaluation_mode() == _async_safepoint;
 183   }
 184   virtual bool evaluate_concurrently() const {
 185     return evaluation_mode() == _concurrent ||
 186            evaluation_mode() == _async_safepoint;
 187   }
 188 
 189   static const char* mode_to_string(Mode mode);
 190 
 191   // Debugging
 192   void print_on_error(outputStream* st) const;
 193   const char* name() const { return _names[type()]; }
 194   static const char* name(int type) {
 195     assert(type >= 0 && type < VMOp_Terminating, "invalid VM operation type");
 196     return _names[type];
 197   }
 198 #ifndef PRODUCT
 199   void print_on(outputStream* st) const { print_on_error(st); }
 200 #endif
 201 };
 202 
 203 class VM_ThreadStop: public VM_Operation {
 204  private:
 205   oop     _thread;        // The Thread that the Throwable is thrown against
 206   oop     _throwable;     // The Throwable thrown at the target Thread
 207  public:
 208   // All oops are passed as JNI handles, since there is no guarantee that a GC might happen before the
 209   // VM operation is executed.
 210   VM_ThreadStop(oop thread, oop throwable) {
 211     _thread    = thread;
 212     _throwable = throwable;
 213   }
 214   VMOp_Type type() const                         { return VMOp_ThreadStop; }
 215   oop target_thread() const                      { return _thread; }
 216   oop throwable() const                          { return _throwable;}
 217   void doit();
 218   // We deoptimize if top-most frame is compiled - this might require a C2I adapter to be generated
 219   bool allow_nested_vm_operations() const        { return true; }
 220   Mode evaluation_mode() const                   { return _async_safepoint; }
 221   bool is_cheap_allocated() const                { return true; }
 222 
 223   // GC support
 224   void oops_do(OopClosure* f) {
 225     f->do_oop(&_thread); f->do_oop(&_throwable);
 226   }
 227 };
 228 
 229 // dummy vm op, evaluated just to force a safepoint
 230 class VM_ForceSafepoint: public VM_Operation {
 231  public:
 232   VM_ForceSafepoint() {}
 233   void doit()         {}
 234   VMOp_Type type() const { return VMOp_ForceSafepoint; }
 235 };
 236 
 237 // dummy vm op, evaluated just to force a safepoint
 238 class VM_ForceAsyncSafepoint: public VM_Operation {
 239  public:
 240   VM_ForceAsyncSafepoint() {}
 241   void doit()              {}
 242   VMOp_Type type() const                         { return VMOp_ForceAsyncSafepoint; }
 243   Mode evaluation_mode() const                   { return _async_safepoint; }
 244   bool is_cheap_allocated() const                { return true; }
 245 };
 246 
 247 class VM_Deoptimize: public VM_Operation {
 248  public:
 249   VM_Deoptimize() {}
 250   VMOp_Type type() const                        { return VMOp_Deoptimize; }
 251   void doit();
 252   bool allow_nested_vm_operations() const        { return true; }
 253 };
 254 
 255 
 256 // Deopt helper that can deoptimize frames in threads other than the
 257 // current thread.  Only used through Deoptimization::deoptimize_frame.
 258 class VM_DeoptimizeFrame: public VM_Operation {
 259   friend class Deoptimization;
 260 
 261  private:
 262   JavaThread* _thread;
 263   intptr_t*   _id;
 264   VM_DeoptimizeFrame(JavaThread* thread, intptr_t* id);
 265 
 266  public:
 267   VMOp_Type type() const                         { return VMOp_DeoptimizeFrame; }
 268   void doit();
 269   bool allow_nested_vm_operations() const        { return true;  }
 270 };
 271 
 272 #ifndef PRODUCT
 273 class VM_DeoptimizeAll: public VM_Operation {
 274  private:
 275   KlassHandle _dependee;
 276  public:
 277   VM_DeoptimizeAll() {}
 278   VMOp_Type type() const                         { return VMOp_DeoptimizeAll; }
 279   void doit();
 280   bool allow_nested_vm_operations() const        { return true; }
 281 };
 282 
 283 
 284 class VM_ZombieAll: public VM_Operation {
 285  public:
 286   VM_ZombieAll() {}
 287   VMOp_Type type() const                         { return VMOp_ZombieAll; }
 288   void doit();
 289   bool allow_nested_vm_operations() const        { return true; }
 290 };
 291 #endif // PRODUCT
 292 
 293 class VM_UnlinkSymbols: public VM_Operation {
 294  public:
 295   VM_UnlinkSymbols() {}
 296   VMOp_Type type() const                         { return VMOp_UnlinkSymbols; }
 297   void doit();
 298   bool allow_nested_vm_operations() const        { return true; }
 299 };
 300 
 301 class VM_Verify: public VM_Operation {
 302  private:
 303   bool _silent;
 304  public:
 305   VM_Verify(bool silent = VerifySilently) : _silent(silent) {}
 306   VMOp_Type type() const { return VMOp_Verify; }
 307   void doit();
 308 };
 309 
 310 
 311 class VM_PrintThreads: public VM_Operation {
 312  private:
 313   outputStream* _out;
 314   bool _print_concurrent_locks;
 315  public:
 316   VM_PrintThreads()                                                { _out = tty; _print_concurrent_locks = PrintConcurrentLocks; }
 317   VM_PrintThreads(outputStream* out, bool print_concurrent_locks)  { _out = out; _print_concurrent_locks = print_concurrent_locks; }
 318   VMOp_Type type() const                                           {  return VMOp_PrintThreads; }
 319   void doit();
 320   bool doit_prologue();
 321   void doit_epilogue();
 322 };
 323 
 324 class VM_PrintJNI: public VM_Operation {
 325  private:
 326   outputStream* _out;
 327  public:
 328   VM_PrintJNI()                         { _out = tty; }
 329   VM_PrintJNI(outputStream* out)        { _out = out; }
 330   VMOp_Type type() const                { return VMOp_PrintJNI; }
 331   void doit();
 332 };
 333 
 334 class DeadlockCycle;
 335 class VM_FindDeadlocks: public VM_Operation {
 336  private:
 337   bool           _concurrent_locks;
 338   DeadlockCycle* _deadlocks;
 339   outputStream*  _out;
 340 
 341  public:
 342   VM_FindDeadlocks(bool concurrent_locks) :  _concurrent_locks(concurrent_locks), _out(NULL), _deadlocks(NULL) {};
 343   VM_FindDeadlocks(outputStream* st) : _concurrent_locks(true), _out(st), _deadlocks(NULL) {};
 344   ~VM_FindDeadlocks();
 345 
 346   DeadlockCycle* result()      { return _deadlocks; };
 347   VMOp_Type type() const       { return VMOp_FindDeadlocks; }
 348   void doit();
 349   bool doit_prologue();
 350 };
 351 
 352 class ThreadDumpResult;
 353 class ThreadSnapshot;
 354 class ThreadConcurrentLocks;
 355 
 356 class VM_ThreadDump : public VM_Operation {
 357  private:
 358   ThreadDumpResult*              _result;
 359   int                            _num_threads;
 360   GrowableArray<instanceHandle>* _threads;
 361   int                            _max_depth;
 362   bool                           _with_locked_monitors;
 363   bool                           _with_locked_synchronizers;
 364 
 365   ThreadSnapshot* snapshot_thread(JavaThread* java_thread, ThreadConcurrentLocks* tcl);
 366 
 367  public:
 368   VM_ThreadDump(ThreadDumpResult* result,
 369                 int max_depth,  // -1 indicates entire stack
 370                 bool with_locked_monitors,
 371                 bool with_locked_synchronizers);
 372 
 373   VM_ThreadDump(ThreadDumpResult* result,
 374                 GrowableArray<instanceHandle>* threads,
 375                 int num_threads, // -1 indicates entire stack
 376                 int max_depth,
 377                 bool with_locked_monitors,
 378                 bool with_locked_synchronizers);
 379 
 380   VMOp_Type type() const { return VMOp_ThreadDump; }
 381   void doit();
 382   bool doit_prologue();
 383   void doit_epilogue();
 384 };
 385 
 386 
 387 class VM_Exit: public VM_Operation {
 388  private:
 389   int  _exit_code;
 390   static volatile bool _vm_exited;
 391   static Thread * _shutdown_thread;
 392   static void wait_if_vm_exited();
 393  public:
 394   VM_Exit(int exit_code) {
 395     _exit_code = exit_code;
 396   }
 397   static int wait_for_threads_in_native_to_block();
 398   static int set_vm_exited();
 399   static bool vm_exited()                      { return _vm_exited; }
 400   static void block_if_vm_exited() {
 401     if (_vm_exited) {
 402       wait_if_vm_exited();
 403     }
 404   }
 405   VMOp_Type type() const { return VMOp_Exit; }
 406   void doit();
 407 };
 408 
 409 
 410 class VM_RotateGCLog: public VM_Operation {
 411  private:
 412   outputStream* _out;
 413 
 414  public:
 415   VM_RotateGCLog(outputStream* st) : _out(st) {}
 416   VMOp_Type type() const { return VMOp_RotateGCLog; }
 417   void doit() { gclog_or_tty->rotate_log(true, _out); }
 418 };
 419 
 420 class VM_PrintCompileQueue: public VM_Operation {
 421  private:
 422   outputStream* _out;
 423 
 424  public:
 425   VM_PrintCompileQueue(outputStream* st) : _out(st) {}
 426   VMOp_Type type() const { return VMOp_PrintCompileQueue; }
 427   void doit();
 428 };
 429 
 430 class VM_PrintCodeList: public VM_Operation {
 431  private:
 432   outputStream* _out;
 433 
 434  public:
 435   VM_PrintCodeList(outputStream* st) : _out(st) {}
 436   VMOp_Type type() const { return VMOp_PrintCodeList; }
 437   void doit();
 438 };
 439 
 440 class VM_PrintCodeCache: public VM_Operation {
 441  private:
 442   outputStream* _out;
 443 
 444  public:
 445   VM_PrintCodeCache(outputStream* st) : _out(st) {}
 446   VMOp_Type type() const { return VMOp_PrintCodeCache; }
 447   void doit();
 448 };
 449 
 450 
 451 #endif // SHARE_VM_RUNTIME_VM_OPERATIONS_HPP