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