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 "code/codeCache.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(ClearICs) \ 48 template(ForceSafepoint) \ 49 template(ForceAsyncSafepoint) \ 50 template(Deoptimize) \ 51 template(DeoptimizeFrame) \ 52 template(DeoptimizeAll) \ 53 template(ZombieAll) \ 54 template(UnlinkSymbols) \ 55 template(Verify) \ 56 template(PrintJNI) \ 57 template(HeapDumper) \ 58 template(DeoptimizeTheWorld) \ 59 template(CollectForMetadataAllocation) \ 60 template(GC_HeapInspection) \ 61 template(GenCollectFull) \ 62 template(GenCollectFullConcurrent) \ 63 template(GenCollectForAllocation) \ 64 template(ParallelGCFailedAllocation) \ 65 template(ParallelGCSystemGC) \ 66 template(CGC_Operation) \ 67 template(CMS_Initial_Mark) \ 68 template(CMS_Final_Remark) \ 69 template(G1CollectFull) \ 70 template(G1CollectForAllocation) \ 71 template(G1IncCollectionPause) \ 72 template(HandshakeOneThread) \ 73 template(HandshakeAllThreads) \ 74 template(HandshakeFallback) \ 75 template(DestroyAllocationContext) \ 76 template(EnableBiasedLocking) \ 77 template(RevokeBias) \ 78 template(BulkRevokeBias) \ 79 template(PopulateDumpSharedSpace) \ 80 template(JNIFunctionTableCopier) \ 81 template(RedefineClasses) \ 82 template(UpdateForPopTopFrame) \ 83 template(SetFramePop) \ 84 template(GetOwnedMonitorInfo) \ 85 template(GetObjectMonitorUsage) \ 86 template(GetCurrentContendedMonitor) \ 87 template(GetStackTrace) \ 88 template(GetMultipleStackTraces) \ 89 template(GetAllStackTraces) \ 90 template(GetThreadListStackTraces) \ 91 template(GetFrameCount) \ 92 template(GetFrameLocation) \ 93 template(ChangeBreakpoints) \ 94 template(GetOrSetLocal) \ 95 template(GetCurrentLocation) \ 96 template(EnterInterpOnlyMode) \ 97 template(ChangeSingleStep) \ 98 template(HeapWalkOperation) \ 99 template(HeapIterateOperation) \ 100 template(ReportJavaOutOfMemory) \ 101 template(JFRCheckpoint) \ 102 template(Exit) \ 103 template(LinuxDllLoad) \ 104 template(RotateGCLog) \ 105 template(WhiteBoxOperation) \ 106 template(ClassLoaderStatsOperation) \ 107 template(DumpHashtable) \ 108 template(DumpTouchedMethods) \ 109 template(MarkActiveNMethods) \ 110 template(PrintCompileQueue) \ 111 template(PrintClassHierarchy) \ 112 template(ThreadSuspend) \ 113 template(CTWThreshold) \ 114 template(ThreadsSuspendJVMTI) \ 115 template(ICBufferFull) \ 116 template(ScavengeMonitors) \ 117 template(PrintMetadata) \ 118 119 class VM_Operation: public CHeapObj<mtInternal> { 120 public: 121 enum Mode { 122 _safepoint, // blocking, safepoint, vm_op C-heap allocated 123 _no_safepoint, // blocking, no safepoint, vm_op C-Heap allocated 124 _concurrent, // non-blocking, no safepoint, vm_op C-Heap allocated 125 _async_safepoint // non-blocking, safepoint, vm_op C-Heap allocated 126 }; 127 128 enum VMOp_Type { 129 VM_OPS_DO(VM_OP_ENUM) 130 VMOp_Terminating 131 }; 132 133 private: 134 Thread* _calling_thread; 135 ThreadPriority _priority; 136 long _timestamp; 137 VM_Operation* _next; 138 VM_Operation* _prev; 139 140 // The VM operation name array 141 static const char* _names[]; 142 143 public: 144 VM_Operation() { _calling_thread = NULL; _next = NULL; _prev = NULL; } 145 virtual ~VM_Operation() {} 146 147 // VM operation support (used by VM thread) 148 Thread* calling_thread() const { return _calling_thread; } 149 ThreadPriority priority() { return _priority; } 150 void set_calling_thread(Thread* thread, ThreadPriority priority); 151 152 long timestamp() const { return _timestamp; } 153 void set_timestamp(long timestamp) { _timestamp = timestamp; } 154 155 // Called by VM thread - does in turn invoke doit(). Do not override this 156 void evaluate(); 157 158 // evaluate() is called by the VMThread and in turn calls doit(). 159 // If the thread invoking VMThread::execute((VM_Operation*) is a JavaThread, 160 // doit_prologue() is called in that thread before transferring control to 161 // the VMThread. 162 // If doit_prologue() returns true the VM operation will proceed, and 163 // doit_epilogue() will be called by the JavaThread once the VM operation 164 // completes. If doit_prologue() returns false the VM operation is cancelled. 165 virtual void doit() = 0; 166 virtual bool doit_prologue() { return true; }; 167 virtual void doit_epilogue() {}; // Note: Not called if mode is: _concurrent 168 169 // Type test 170 virtual bool is_methodCompiler() const { return false; } 171 172 // Linking 173 VM_Operation *next() const { return _next; } 174 VM_Operation *prev() const { return _prev; } 175 void set_next(VM_Operation *next) { _next = next; } 176 void set_prev(VM_Operation *prev) { _prev = prev; } 177 178 // Configuration. Override these appropriately in subclasses. 179 virtual VMOp_Type type() const = 0; 180 virtual Mode evaluation_mode() const { return _safepoint; } 181 virtual bool allow_nested_vm_operations() const { return false; } 182 virtual bool is_cheap_allocated() const { return false; } 183 virtual void oops_do(OopClosure* f) { /* do nothing */ }; 184 185 // CAUTION: <don't hang yourself with following rope> 186 // If you override these methods, make sure that the evaluation 187 // of these methods is race-free and non-blocking, since these 188 // methods may be evaluated either by the mutators or by the 189 // vm thread, either concurrently with mutators or with the mutators 190 // stopped. In other words, taking locks is verboten, and if there 191 // are any races in evaluating the conditions, they'd better be benign. 192 virtual bool evaluate_at_safepoint() const { 193 return evaluation_mode() == _safepoint || 194 evaluation_mode() == _async_safepoint; 195 } 196 virtual bool evaluate_concurrently() const { 197 return evaluation_mode() == _concurrent || 198 evaluation_mode() == _async_safepoint; 199 } 200 201 static const char* mode_to_string(Mode mode); 202 203 // Debugging 204 virtual void print_on_error(outputStream* st) const; 205 const char* name() const { return _names[type()]; } 206 static const char* name(int type) { 207 assert(type >= 0 && type < VMOp_Terminating, "invalid VM operation type"); 208 return _names[type]; 209 } 210 #ifndef PRODUCT 211 void print_on(outputStream* st) const { print_on_error(st); } 212 #endif 213 }; 214 215 class VM_ThreadStop: public VM_Operation { 216 private: 217 oop _thread; // The Thread that the Throwable is thrown against 218 oop _throwable; // The Throwable thrown at the target Thread 219 public: 220 // All oops are passed as JNI handles, since there is no guarantee that a GC might happen before the 221 // VM operation is executed. 222 VM_ThreadStop(oop thread, oop throwable) { 223 _thread = thread; 224 _throwable = throwable; 225 } 226 VMOp_Type type() const { return VMOp_ThreadStop; } 227 oop target_thread() const { return _thread; } 228 oop throwable() const { return _throwable;} 229 void doit(); 230 // We deoptimize if top-most frame is compiled - this might require a C2I adapter to be generated 231 bool allow_nested_vm_operations() const { return true; } 232 Mode evaluation_mode() const { return _async_safepoint; } 233 bool is_cheap_allocated() const { return true; } 234 235 // GC support 236 void oops_do(OopClosure* f) { 237 f->do_oop(&_thread); f->do_oop(&_throwable); 238 } 239 }; 240 241 class VM_ClearICs: public VM_Operation { 242 private: 243 bool _preserve_static_stubs; 244 public: 245 VM_ClearICs(bool preserve_static_stubs) { _preserve_static_stubs = preserve_static_stubs; } 246 void doit(); 247 VMOp_Type type() const { return VMOp_ClearICs; } 248 }; 249 250 // empty vm op, evaluated just to force a safepoint 251 class VM_ForceSafepoint: public VM_Operation { 252 public: 253 void doit() {} 254 VMOp_Type type() const { return VMOp_ForceSafepoint; } 255 }; 256 257 // empty vm op, when forcing a safepoint to suspend a thread 258 class VM_ThreadSuspend: public VM_ForceSafepoint { 259 public: 260 VMOp_Type type() const { return VMOp_ThreadSuspend; } 261 }; 262 263 // empty vm op, when forcing a safepoint due to ctw threshold is reached for the sweeper 264 class VM_CTWThreshold: public VM_ForceSafepoint { 265 public: 266 VMOp_Type type() const { return VMOp_CTWThreshold; } 267 }; 268 269 // empty vm op, when forcing a safepoint to suspend threads from jvmti 270 class VM_ThreadsSuspendJVMTI: public VM_ForceSafepoint { 271 public: 272 VMOp_Type type() const { return VMOp_ThreadsSuspendJVMTI; } 273 }; 274 275 // empty vm op, when forcing a safepoint due to inline cache buffers being full 276 class VM_ICBufferFull: public VM_ForceSafepoint { 277 public: 278 VMOp_Type type() const { return VMOp_ICBufferFull; } 279 }; 280 281 // empty asynchronous vm op, when forcing a safepoint to scavenge monitors 282 class VM_ScavengeMonitors: public VM_ForceSafepoint { 283 public: 284 VMOp_Type type() const { return VMOp_ScavengeMonitors; } 285 Mode evaluation_mode() const { return _async_safepoint; } 286 bool is_cheap_allocated() const { return true; } 287 }; 288 289 class VM_Deoptimize: public VM_Operation { 290 public: 291 VM_Deoptimize() {} 292 VMOp_Type type() const { return VMOp_Deoptimize; } 293 void doit(); 294 bool allow_nested_vm_operations() const { return true; } 295 }; 296 297 class VM_MarkActiveNMethods: public VM_Operation { 298 public: 299 VM_MarkActiveNMethods() {} 300 VMOp_Type type() const { return VMOp_MarkActiveNMethods; } 301 void doit(); 302 bool allow_nested_vm_operations() const { return true; } 303 }; 304 305 // Deopt helper that can deoptimize frames in threads other than the 306 // current thread. Only used through Deoptimization::deoptimize_frame. 307 class VM_DeoptimizeFrame: public VM_Operation { 308 friend class Deoptimization; 309 310 private: 311 JavaThread* _thread; 312 intptr_t* _id; 313 int _reason; 314 VM_DeoptimizeFrame(JavaThread* thread, intptr_t* id, int reason); 315 316 public: 317 VMOp_Type type() const { return VMOp_DeoptimizeFrame; } 318 void doit(); 319 bool allow_nested_vm_operations() const { return true; } 320 }; 321 322 #ifndef PRODUCT 323 class VM_DeoptimizeAll: public VM_Operation { 324 private: 325 Klass* _dependee; 326 public: 327 VM_DeoptimizeAll() {} 328 VMOp_Type type() const { return VMOp_DeoptimizeAll; } 329 void doit(); 330 bool allow_nested_vm_operations() const { return true; } 331 }; 332 333 334 class VM_ZombieAll: public VM_Operation { 335 public: 336 VM_ZombieAll() {} 337 VMOp_Type type() const { return VMOp_ZombieAll; } 338 void doit(); 339 bool allow_nested_vm_operations() const { return true; } 340 }; 341 #endif // PRODUCT 342 343 class VM_UnlinkSymbols: public VM_Operation { 344 public: 345 VM_UnlinkSymbols() {} 346 VMOp_Type type() const { return VMOp_UnlinkSymbols; } 347 void doit(); 348 bool allow_nested_vm_operations() const { return true; } 349 }; 350 351 class VM_Verify: public VM_Operation { 352 public: 353 VMOp_Type type() const { return VMOp_Verify; } 354 void doit(); 355 }; 356 357 358 class VM_PrintThreads: public VM_Operation { 359 private: 360 outputStream* _out; 361 bool _print_concurrent_locks; 362 public: 363 VM_PrintThreads() { _out = tty; _print_concurrent_locks = PrintConcurrentLocks; } 364 VM_PrintThreads(outputStream* out, bool print_concurrent_locks) { _out = out; _print_concurrent_locks = print_concurrent_locks; } 365 VMOp_Type type() const { return VMOp_PrintThreads; } 366 void doit(); 367 bool doit_prologue(); 368 void doit_epilogue(); 369 }; 370 371 class VM_PrintJNI: public VM_Operation { 372 private: 373 outputStream* _out; 374 public: 375 VM_PrintJNI() { _out = tty; } 376 VM_PrintJNI(outputStream* out) { _out = out; } 377 VMOp_Type type() const { return VMOp_PrintJNI; } 378 void doit(); 379 }; 380 381 class VM_PrintMetadata : public VM_Operation { 382 private: 383 outputStream* _out; 384 size_t _scale; 385 public: 386 VM_PrintMetadata(outputStream* out, size_t scale) : _out(out), _scale(scale) {}; 387 388 VMOp_Type type() const { return VMOp_PrintMetadata; } 389 void doit(); 390 }; 391 392 class DeadlockCycle; 393 class VM_FindDeadlocks: public VM_Operation { 394 private: 395 bool _concurrent_locks; 396 DeadlockCycle* _deadlocks; 397 outputStream* _out; 398 ThreadsListSetter _setter; // Helper to set hazard ptr in the originating thread 399 // which protects the JavaThreads in _deadlocks. 400 401 public: 402 VM_FindDeadlocks(bool concurrent_locks) : _concurrent_locks(concurrent_locks), _out(NULL), _deadlocks(NULL), _setter() {}; 403 VM_FindDeadlocks(outputStream* st) : _concurrent_locks(true), _out(st), _deadlocks(NULL) {}; 404 ~VM_FindDeadlocks(); 405 406 DeadlockCycle* result() { return _deadlocks; }; 407 VMOp_Type type() const { return VMOp_FindDeadlocks; } 408 void doit(); 409 bool doit_prologue(); 410 }; 411 412 class ThreadDumpResult; 413 class ThreadSnapshot; 414 class ThreadConcurrentLocks; 415 416 class VM_ThreadDump : public VM_Operation { 417 private: 418 ThreadDumpResult* _result; 419 int _num_threads; 420 GrowableArray<instanceHandle>* _threads; 421 int _max_depth; 422 bool _with_locked_monitors; 423 bool _with_locked_synchronizers; 424 425 ThreadSnapshot* snapshot_thread(JavaThread* java_thread, ThreadConcurrentLocks* tcl); 426 427 public: 428 VM_ThreadDump(ThreadDumpResult* result, 429 int max_depth, // -1 indicates entire stack 430 bool with_locked_monitors, 431 bool with_locked_synchronizers); 432 433 VM_ThreadDump(ThreadDumpResult* result, 434 GrowableArray<instanceHandle>* threads, 435 int num_threads, // -1 indicates entire stack 436 int max_depth, 437 bool with_locked_monitors, 438 bool with_locked_synchronizers); 439 440 VMOp_Type type() const { return VMOp_ThreadDump; } 441 void doit(); 442 bool doit_prologue(); 443 void doit_epilogue(); 444 }; 445 446 447 class VM_Exit: public VM_Operation { 448 private: 449 int _exit_code; 450 static volatile bool _vm_exited; 451 static Thread * _shutdown_thread; 452 static void wait_if_vm_exited(); 453 public: 454 VM_Exit(int exit_code) { 455 _exit_code = exit_code; 456 } 457 static int wait_for_threads_in_native_to_block(); 458 static int set_vm_exited(); 459 static bool vm_exited() { return _vm_exited; } 460 static void block_if_vm_exited() { 461 if (_vm_exited) { 462 wait_if_vm_exited(); 463 } 464 } 465 VMOp_Type type() const { return VMOp_Exit; } 466 void doit(); 467 }; 468 469 class VM_PrintCompileQueue: public VM_Operation { 470 private: 471 outputStream* _out; 472 473 public: 474 VM_PrintCompileQueue(outputStream* st) : _out(st) {} 475 VMOp_Type type() const { return VMOp_PrintCompileQueue; } 476 Mode evaluation_mode() const { return _safepoint; } 477 void doit(); 478 }; 479 480 #if INCLUDE_SERVICES 481 class VM_PrintClassHierarchy: public VM_Operation { 482 private: 483 outputStream* _out; 484 bool _print_interfaces; 485 bool _print_subclasses; 486 char* _classname; 487 488 public: 489 VM_PrintClassHierarchy(outputStream* st, bool print_interfaces, bool print_subclasses, char* classname) : 490 _out(st), _print_interfaces(print_interfaces), _print_subclasses(print_subclasses), 491 _classname(classname) {} 492 VMOp_Type type() const { return VMOp_PrintClassHierarchy; } 493 void doit(); 494 }; 495 #endif // INCLUDE_SERVICES 496 497 #endif // SHARE_VM_RUNTIME_VM_OPERATIONS_HPP