/*
* Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*
*/
#ifndef SHARE_RUNTIME_VMOPERATIONS_HPP
#define SHARE_RUNTIME_VMOPERATIONS_HPP
#include "classfile/javaClasses.hpp"
#include "memory/allocation.hpp"
#include "oops/oop.hpp"
#include "runtime/thread.hpp"
#include "runtime/threadSMR.hpp"
#include "code/codeCache.hpp"
// The following classes are used for operations
// initiated by a Java thread but that must
// take place in the VMThread.
#define VM_OP_ENUM(type) VMOp_##type,
// Note: When new VM_XXX comes up, add 'XXX' to the template table.
#define VM_OPS_DO(template) \
template(None) \
template(Cleanup) \
template(ThreadStop) \
template(ThreadDump) \
template(PrintThreads) \
template(FindDeadlocks) \
template(ClearICs) \
template(ForceSafepoint) \
template(ForceAsyncSafepoint) \
template(DeoptimizeFrame) \
template(DeoptimizeAll) \
template(ZombieAll) \
template(Verify) \
template(PrintJNI) \
template(HeapDumper) \
template(DeoptimizeTheWorld) \
template(CollectForMetadataAllocation) \
template(GC_HeapInspection) \
template(GenCollectFull) \
template(GenCollectFullConcurrent) \
template(GenCollectForAllocation) \
template(ParallelGCFailedAllocation) \
template(ParallelGCSystemGC) \
template(G1CollectForAllocation) \
template(G1CollectFull) \
template(G1Concurrent) \
template(G1TryInitiateConcMark) \
template(ZMarkStart) \
template(ZMarkEnd) \
template(ZRelocateStart) \
template(ZVerify) \
template(HandshakeOneThread) \
template(HandshakeAllThreads) \
template(HandshakeFallback) \
template(EnableBiasedLocking) \
template(BulkRevokeBias) \
template(PopulateDumpSharedSpace) \
template(JNIFunctionTableCopier) \
template(RedefineClasses) \
template(UpdateForPopTopFrame) \
template(SetFramePop) \
template(GetOwnedMonitorInfo) \
template(GetObjectMonitorUsage) \
template(GetCurrentContendedMonitor) \
template(GetStackTrace) \
template(GetMultipleStackTraces) \
template(GetAllStackTraces) \
template(GetThreadListStackTraces) \
template(GetFrameCount) \
template(GetFrameLocation) \
template(ChangeBreakpoints) \
template(GetOrSetLocal) \
template(GetCurrentLocation) \
template(EnterInterpOnlyMode) \
template(ChangeSingleStep) \
template(HeapWalkOperation) \
template(HeapIterateOperation) \
template(ReportJavaOutOfMemory) \
template(JFRCheckpoint) \
template(ShenandoahFullGC) \
template(ShenandoahInitMark) \
template(ShenandoahFinalMarkStartEvac) \
template(ShenandoahFinalEvac) \
template(ShenandoahInitTraversalGC) \
template(ShenandoahFinalTraversalGC) \
template(ShenandoahInitUpdateRefs) \
template(ShenandoahFinalUpdateRefs) \
template(ShenandoahDegeneratedGC) \
template(Exit) \
template(LinuxDllLoad) \
template(RotateGCLog) \
template(WhiteBoxOperation) \
template(JVMCIResizeCounters) \
template(ClassLoaderStatsOperation) \
template(ClassLoaderHierarchyOperation) \
template(DumpHashtable) \
template(DumpTouchedMethods) \
template(MarkActiveNMethods) \
template(PrintCompileQueue) \
template(PrintClassHierarchy) \
template(ThreadSuspend) \
template(ThreadsSuspendJVMTI) \
template(ICBufferFull) \
template(ScavengeMonitors) \
template(PrintMetadata) \
template(GTestExecuteAtSafepoint) \
template(JFROldObject) \
class VM_Operation : public StackObj {
public:
enum VMOp_Type {
VM_OPS_DO(VM_OP_ENUM)
VMOp_Terminating
};
private:
Thread* _calling_thread;
long _timestamp;
VM_Operation* _next;
VM_Operation* _prev;
// The VM operation name array
static const char* _names[];
public:
VM_Operation() : _calling_thread(NULL), _timestamp(0), _next(NULL), _prev(NULL) {}
// VM operation support (used by VM thread)
Thread* calling_thread() const { return _calling_thread; }
void set_calling_thread(Thread* thread);
long timestamp() const { return _timestamp; }
void set_timestamp(long timestamp) { _timestamp = timestamp; }
// Called by VM thread - does in turn invoke doit(). Do not override this
void evaluate();
// evaluate() is called by the VMThread and in turn calls doit().
// If the thread invoking VMThread::execute((VM_Operation*) is a JavaThread,
// doit_prologue() is called in that thread before transferring control to
// the VMThread.
// If doit_prologue() returns true the VM operation will proceed, and
// doit_epilogue() will be called by the JavaThread once the VM operation
// completes. If doit_prologue() returns false the VM operation is cancelled.
virtual void doit() = 0;
virtual bool doit_prologue() { return true; };
virtual void doit_epilogue() {};
// Linking
VM_Operation *next() const { return _next; }
VM_Operation *prev() const { return _prev; }
void set_next(VM_Operation *next) { _next = next; }
void set_prev(VM_Operation *prev) { _prev = prev; }
// Configuration. Override these appropriately in subclasses.
virtual VMOp_Type type() const = 0;
virtual bool allow_nested_vm_operations() const { return false; }
virtual void oops_do(OopClosure* f) { /* do nothing */ };
// An operation can either be done inside a safepoint
// or concurrently with Java threads running.
virtual bool evaluate_at_safepoint() const { return true; }
// Debugging
virtual void print_on_error(outputStream* st) const;
virtual const char* name() const { return _names[type()]; }
static const char* name(int type) {
assert(type >= 0 && type < VMOp_Terminating, "invalid VM operation type");
return _names[type];
}
#ifndef PRODUCT
void print_on(outputStream* st) const { print_on_error(st); }
#endif
};
class VM_None: public VM_Operation {
const char* _reason;
public:
VM_None(const char* reason) : _reason(reason) {}
const char* name() const { return _reason; }
VMOp_Type type() const { return VMOp_None; }
void doit() {};
};
class VM_Cleanup: public VM_Operation {
public:
VMOp_Type type() const { return VMOp_Cleanup; }
void doit() {};
};
class VM_ThreadStop: public VM_Operation {
private:
oop _thread; // The Thread that the Throwable is thrown against
oop _throwable; // The Throwable thrown at the target Thread
public:
// All oops are passed as JNI handles, since there is no guarantee that a GC might happen before the
// VM operation is executed.
VM_ThreadStop(oop thread, oop throwable) {
_thread = thread;
_throwable = throwable;
}
VMOp_Type type() const { return VMOp_ThreadStop; }
oop target_thread() const { return _thread; }
oop throwable() const { return _throwable;}
void doit();
// We deoptimize if top-most frame is compiled - this might require a C2I adapter to be generated
bool allow_nested_vm_operations() const { return true; }
// GC support
void oops_do(OopClosure* f) {
f->do_oop(&_thread); f->do_oop(&_throwable);
}
};
class VM_ClearICs: public VM_Operation {
private:
bool _preserve_static_stubs;
public:
VM_ClearICs(bool preserve_static_stubs) { _preserve_static_stubs = preserve_static_stubs; }
void doit();
VMOp_Type type() const { return VMOp_ClearICs; }
};
// empty vm op, evaluated just to force a safepoint
class VM_ForceSafepoint: public VM_Operation {
public:
void doit() {}
VMOp_Type type() const { return VMOp_ForceSafepoint; }
};
// empty vm op, when forcing a safepoint to suspend a thread
class VM_ThreadSuspend: public VM_ForceSafepoint {
public:
VMOp_Type type() const { return VMOp_ThreadSuspend; }
};
// empty vm op, when forcing a safepoint to suspend threads from jvmti
class VM_ThreadsSuspendJVMTI: public VM_ForceSafepoint {
public:
VMOp_Type type() const { return VMOp_ThreadsSuspendJVMTI; }
};
// empty vm op, when forcing a safepoint due to inline cache buffers being full
class VM_ICBufferFull: public VM_ForceSafepoint {
public:
VMOp_Type type() const { return VMOp_ICBufferFull; }
};
// Base class for invoking parts of a gtest in a safepoint.
// Derived classes provide the doit method.
// Typically also need to transition the gtest thread from native to VM.
class VM_GTestExecuteAtSafepoint: public VM_Operation {
public:
VMOp_Type type() const { return VMOp_GTestExecuteAtSafepoint; }
protected:
VM_GTestExecuteAtSafepoint() {}
};
class VM_MarkActiveNMethods: public VM_Operation {
public:
VM_MarkActiveNMethods() {}
VMOp_Type type() const { return VMOp_MarkActiveNMethods; }
void doit();
bool allow_nested_vm_operations() const { return true; }
};
// Deopt helper that can deoptimize frames in threads other than the
// current thread. Only used through Deoptimization::deoptimize_frame.
class VM_DeoptimizeFrame: public VM_Operation {
friend class Deoptimization;
private:
JavaThread* _thread;
intptr_t* _id;
int _reason;
VM_DeoptimizeFrame(JavaThread* thread, intptr_t* id, int reason);
public:
VMOp_Type type() const { return VMOp_DeoptimizeFrame; }
void doit();
bool allow_nested_vm_operations() const { return true; }
};
#ifndef PRODUCT
class VM_DeoptimizeAll: public VM_Operation {
private:
Klass* _dependee;
public:
VM_DeoptimizeAll() {}
VMOp_Type type() const { return VMOp_DeoptimizeAll; }
void doit();
bool allow_nested_vm_operations() const { return true; }
};
class VM_ZombieAll: public VM_Operation {
public:
VM_ZombieAll() {}
VMOp_Type type() const { return VMOp_ZombieAll; }
void doit();
bool allow_nested_vm_operations() const { return true; }
};
#endif // PRODUCT
class VM_Verify: public VM_Operation {
public:
VMOp_Type type() const { return VMOp_Verify; }
void doit();
};
class VM_PrintThreads: public VM_Operation {
private:
outputStream* _out;
bool _print_concurrent_locks;
bool _print_extended_info;
public:
VM_PrintThreads()
: _out(tty), _print_concurrent_locks(PrintConcurrentLocks), _print_extended_info(false)
{}
VM_PrintThreads(outputStream* out, bool print_concurrent_locks, bool print_extended_info)
: _out(out), _print_concurrent_locks(print_concurrent_locks), _print_extended_info(print_extended_info)
{}
VMOp_Type type() const {
return VMOp_PrintThreads;
}
void doit();
bool doit_prologue();
void doit_epilogue();
};
class VM_PrintJNI: public VM_Operation {
private:
outputStream* _out;
public:
VM_PrintJNI() { _out = tty; }
VM_PrintJNI(outputStream* out) { _out = out; }
VMOp_Type type() const { return VMOp_PrintJNI; }
void doit();
};
class VM_PrintMetadata : public VM_Operation {
private:
outputStream* const _out;
const size_t _scale;
const int _flags;
public:
VM_PrintMetadata(outputStream* out, size_t scale, int flags)
: _out(out), _scale(scale), _flags(flags)
{};
VMOp_Type type() const { return VMOp_PrintMetadata; }
void doit();
};
class DeadlockCycle;
class VM_FindDeadlocks: public VM_Operation {
private:
bool _concurrent_locks;
DeadlockCycle* _deadlocks;
outputStream* _out;
ThreadsListSetter _setter; // Helper to set hazard ptr in the originating thread
// which protects the JavaThreads in _deadlocks.
public:
VM_FindDeadlocks(bool concurrent_locks) : _concurrent_locks(concurrent_locks), _deadlocks(NULL), _out(NULL), _setter() {};
VM_FindDeadlocks(outputStream* st) : _concurrent_locks(true), _deadlocks(NULL), _out(st) {};
~VM_FindDeadlocks();
DeadlockCycle* result() { return _deadlocks; };
VMOp_Type type() const { return VMOp_FindDeadlocks; }
void doit();
};
class ThreadDumpResult;
class ThreadSnapshot;
class ThreadConcurrentLocks;
class VM_ThreadDump : public VM_Operation {
private:
ThreadDumpResult* _result;
int _num_threads;
GrowableArray<instanceHandle>* _threads;
int _max_depth;
bool _with_locked_monitors;
bool _with_locked_synchronizers;
void snapshot_thread(JavaThread* java_thread, ThreadConcurrentLocks* tcl);
public:
VM_ThreadDump(ThreadDumpResult* result,
int max_depth, // -1 indicates entire stack
bool with_locked_monitors,
bool with_locked_synchronizers);
VM_ThreadDump(ThreadDumpResult* result,
GrowableArray<instanceHandle>* threads,
int num_threads, // -1 indicates entire stack
int max_depth,
bool with_locked_monitors,
bool with_locked_synchronizers);
VMOp_Type type() const { return VMOp_ThreadDump; }
void doit();
bool doit_prologue();
void doit_epilogue();
};
class VM_Exit: public VM_Operation {
private:
int _exit_code;
static volatile bool _vm_exited;
static Thread * volatile _shutdown_thread;
static void wait_if_vm_exited();
public:
VM_Exit(int exit_code) {
_exit_code = exit_code;
}
static int wait_for_threads_in_native_to_block();
static int set_vm_exited();
static bool vm_exited() { return _vm_exited; }
static Thread * shutdown_thread() { return _shutdown_thread; }
static void block_if_vm_exited() {
if (_vm_exited) {
wait_if_vm_exited();
}
}
VMOp_Type type() const { return VMOp_Exit; }
void doit();
};
class VM_PrintCompileQueue: public VM_Operation {
private:
outputStream* _out;
public:
VM_PrintCompileQueue(outputStream* st) : _out(st) {}
VMOp_Type type() const { return VMOp_PrintCompileQueue; }
void doit();
};
#if INCLUDE_SERVICES
class VM_PrintClassHierarchy: public VM_Operation {
private:
outputStream* _out;
bool _print_interfaces;
bool _print_subclasses;
char* _classname;
public:
VM_PrintClassHierarchy(outputStream* st, bool print_interfaces, bool print_subclasses, char* classname) :
_out(st), _print_interfaces(print_interfaces), _print_subclasses(print_subclasses),
_classname(classname) {}
VMOp_Type type() const { return VMOp_PrintClassHierarchy; }
void doit();
};
#endif // INCLUDE_SERVICES
#endif // SHARE_RUNTIME_VMOPERATIONS_HPP