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