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