1/* 2 * Copyright (c) 2003, 2014, 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. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26#ifndef _JAVA_JMM_H_ 27#define _JAVA_JMM_H_ 28 29/* 30 * This is a private interface used by JDK for JVM monitoring 31 * and management. 32 * 33 * Bump the version number when either of the following happens: 34 * 35 * 1. There is a change in functions in JmmInterface. 36 * 37 * 2. There is a change in the contract between VM and Java classes. 38 */ 39 40#include "jni.h" 41 42#ifdef __cplusplus 43extern "C" { 44#endif 45 46enum { 47 JMM_VERSION_1 = 0x20010000, 48 JMM_VERSION_1_0 = 0x20010000, 49 JMM_VERSION_1_1 = 0x20010100, // JDK 6 50 JMM_VERSION_1_2 = 0x20010200, // JDK 7 51 JMM_VERSION_1_2_1 = 0x20010201, // JDK 7 GA 52 JMM_VERSION_1_2_2 = 0x20010202, 53 JMM_VERSION = 0x20010203 54}; 55 56typedef struct { 57 unsigned int isLowMemoryDetectionSupported : 1; 58 unsigned int isCompilationTimeMonitoringSupported : 1; 59 unsigned int isThreadContentionMonitoringSupported : 1; 60 unsigned int isCurrentThreadCpuTimeSupported : 1; 61 unsigned int isOtherThreadCpuTimeSupported : 1; 62 unsigned int isObjectMonitorUsageSupported : 1; 63 unsigned int isSynchronizerUsageSupported : 1; 64 unsigned int isThreadAllocatedMemorySupported : 1; 65 unsigned int isRemoteDiagnosticCommandsSupported : 1; 66 unsigned int : 22; 67} jmmOptionalSupport; 68 69typedef enum { 70 JMM_CLASS_LOADED_COUNT = 1, /* Total number of loaded classes */ 71 JMM_CLASS_UNLOADED_COUNT = 2, /* Total number of unloaded classes */ 72 JMM_THREAD_TOTAL_COUNT = 3, /* Total number of threads that have been started */ 73 JMM_THREAD_LIVE_COUNT = 4, /* Current number of live threads */ 74 JMM_THREAD_PEAK_COUNT = 5, /* Peak number of live threads */ 75 JMM_THREAD_DAEMON_COUNT = 6, /* Current number of daemon threads */ 76 JMM_JVM_INIT_DONE_TIME_MS = 7, /* Time when the JVM finished initialization */ 77 JMM_COMPILE_TOTAL_TIME_MS = 8, /* Total accumulated time spent in compilation */ 78 JMM_GC_TIME_MS = 9, /* Total accumulated time spent in collection */ 79 JMM_GC_COUNT = 10, /* Total number of collections */ 80 JMM_JVM_UPTIME_MS = 11, /* The JVM uptime in milliseconds */ 81 82 JMM_INTERNAL_ATTRIBUTE_INDEX = 100, 83 JMM_CLASS_LOADED_BYTES = 101, /* Number of bytes loaded instance classes */ 84 JMM_CLASS_UNLOADED_BYTES = 102, /* Number of bytes unloaded instance classes */ 85 JMM_TOTAL_CLASSLOAD_TIME_MS = 103, /* Accumulated VM class loader time (TraceClassLoadingTime) */ 86 JMM_VM_GLOBAL_COUNT = 104, /* Number of VM internal flags */ 87 JMM_SAFEPOINT_COUNT = 105, /* Total number of safepoints */ 88 JMM_TOTAL_SAFEPOINTSYNC_TIME_MS = 106, /* Accumulated time spent getting to safepoints */ 89 JMM_TOTAL_STOPPED_TIME_MS = 107, /* Accumulated time spent at safepoints */ 90 JMM_TOTAL_APP_TIME_MS = 108, /* Accumulated time spent in Java application */ 91 JMM_VM_THREAD_COUNT = 109, /* Current number of VM internal threads */ 92 JMM_CLASS_INIT_TOTAL_COUNT = 110, /* Number of classes for which initializers were run */ 93 JMM_CLASS_INIT_TOTAL_TIME_MS = 111, /* Accumulated time spent in class initializers */ 94 JMM_METHOD_DATA_SIZE_BYTES = 112, /* Size of method data in memory */ 95 JMM_CLASS_VERIFY_TOTAL_TIME_MS = 113, /* Accumulated time spent in class verifier */ 96 JMM_SHARED_CLASS_LOADED_COUNT = 114, /* Number of shared classes loaded */ 97 JMM_SHARED_CLASS_UNLOADED_COUNT = 115, /* Number of shared classes unloaded */ 98 JMM_SHARED_CLASS_LOADED_BYTES = 116, /* Number of bytes loaded shared classes */ 99 JMM_SHARED_CLASS_UNLOADED_BYTES = 117, /* Number of bytes unloaded shared classes */ 100 101 JMM_OS_ATTRIBUTE_INDEX = 200, 102 JMM_OS_PROCESS_ID = 201, /* Process id of the JVM */ 103 JMM_OS_MEM_TOTAL_PHYSICAL_BYTES = 202, /* Physical memory size */ 104 105 JMM_GC_EXT_ATTRIBUTE_INFO_SIZE = 401 /* the size of the GC specific attributes for a given GC memory manager */ 106} jmmLongAttribute; 107 108typedef enum { 109 JMM_VERBOSE_GC = 21, 110 JMM_VERBOSE_CLASS = 22, 111 JMM_THREAD_CONTENTION_MONITORING = 23, 112 JMM_THREAD_CPU_TIME = 24, 113 JMM_THREAD_ALLOCATED_MEMORY = 25 114} jmmBoolAttribute; 115 116 117enum { 118 JMM_THREAD_STATE_FLAG_SUSPENDED = 0x00100000, 119 JMM_THREAD_STATE_FLAG_NATIVE = 0x00400000 120}; 121 122#define JMM_THREAD_STATE_FLAG_MASK 0xFFF00000 123 124typedef enum { 125 JMM_STAT_PEAK_THREAD_COUNT = 801, 126 JMM_STAT_THREAD_CONTENTION_COUNT = 802, 127 JMM_STAT_THREAD_CONTENTION_TIME = 803, 128 JMM_STAT_THREAD_CONTENTION_STAT = 804, 129 JMM_STAT_PEAK_POOL_USAGE = 805, 130 JMM_STAT_GC_STAT = 806 131} jmmStatisticType; 132 133typedef enum { 134 JMM_USAGE_THRESHOLD_HIGH = 901, 135 JMM_USAGE_THRESHOLD_LOW = 902, 136 JMM_COLLECTION_USAGE_THRESHOLD_HIGH = 903, 137 JMM_COLLECTION_USAGE_THRESHOLD_LOW = 904 138} jmmThresholdType; 139 140/* Should match what is allowed in globals.hpp */ 141typedef enum { 142 JMM_VMGLOBAL_TYPE_UNKNOWN = 0, 143 JMM_VMGLOBAL_TYPE_JBOOLEAN = 1, 144 JMM_VMGLOBAL_TYPE_JSTRING = 2, 145 JMM_VMGLOBAL_TYPE_JLONG = 3, 146 JMM_VMGLOBAL_TYPE_JDOUBLE = 4 147} jmmVMGlobalType; 148 149typedef enum { 150 JMM_VMGLOBAL_ORIGIN_DEFAULT = 1, /* Default value */ 151 JMM_VMGLOBAL_ORIGIN_COMMAND_LINE = 2, /* Set at command line (or JNI invocation) */ 152 JMM_VMGLOBAL_ORIGIN_MANAGEMENT = 3, /* Set via management interface */ 153 JMM_VMGLOBAL_ORIGIN_ENVIRON_VAR = 4, /* Set via environment variables */ 154 JMM_VMGLOBAL_ORIGIN_CONFIG_FILE = 5, /* Set via config file (such as .hotspotrc) */ 155 JMM_VMGLOBAL_ORIGIN_ERGONOMIC = 6, /* Set via ergonomic */ 156 JMM_VMGLOBAL_ORIGIN_ATTACH_ON_DEMAND = 7, /* Set via attach */ 157 JMM_VMGLOBAL_ORIGIN_OTHER = 99 /* Set via some other mechanism */ 158} jmmVMGlobalOrigin; 159 160typedef struct { 161 jstring name; 162 jvalue value; 163 jmmVMGlobalType type; /* Data type */ 164 jmmVMGlobalOrigin origin; /* Default or non-default value */ 165 unsigned int writeable : 1; /* dynamically writeable */ 166 unsigned int external : 1; /* external supported interface */ 167 unsigned int reserved : 30; 168 void *reserved1; 169 void *reserved2; 170} jmmVMGlobal; 171 172typedef struct { 173 const char* name; 174 char type; 175 const char* description; 176} jmmExtAttributeInfo; 177 178/* Caller has to set the following fields before calling GetLastGCStat 179 * o usage_before_gc - array of MemoryUsage objects 180 * o usage_after_gc - array of MemoryUsage objects 181 * o gc_ext_attribute_values_size - size of gc_ext_atttribute_values array 182 * o gc_ext_attribtue_values - array of jvalues 183 */ 184typedef struct { 185 jlong gc_index; /* Index of the collections */ 186 jlong start_time; /* Start time of the GC */ 187 jlong end_time; /* End time of the GC */ 188 jobjectArray usage_before_gc; /* Memory usage array before GC */ 189 jobjectArray usage_after_gc; /* Memory usage array after GC */ 190 jint gc_ext_attribute_values_size; /* set by the caller of GetGCStat */ 191 jvalue* gc_ext_attribute_values; /* Array of jvalue for GC extension attributes */ 192 jint num_gc_ext_attributes; /* number of GC extension attribute values s are filled */ 193 /* -1 indicates gc_ext_attribute_values is not big enough */ 194} jmmGCStat; 195 196typedef struct { 197 const char* name; /* Name of the diagnostic command */ 198 const char* description; /* Short description */ 199 const char* impact; /* Impact on the JVM */ 200 const char* permission_class; /* Class name of the required permission if any */ 201 const char* permission_name; /* Permission name of the required permission if any */ 202 const char* permission_action; /* Action name of the required permission if any*/ 203 int num_arguments; /* Number of supported options or arguments */ 204 jboolean enabled; /* True if the diagnostic command can be invoked, false otherwise*/ 205} dcmdInfo; 206 207typedef struct { 208 const char* name; /* Option/Argument name*/ 209 const char* description; /* Short description */ 210 const char* type; /* Type: STRING, BOOLEAN, etc. */ 211 const char* default_string; /* Default value in a parsable string */ 212 jboolean mandatory; /* True if the option/argument is mandatory */ 213 jboolean option; /* True if it is an option, false if it is an argument */ 214 /* (see diagnosticFramework.hpp for option/argument definitions) */ 215 jboolean multiple; /* True is the option can be specified several time */ 216 int position; /* Expected position for this argument (this field is */ 217 /* meaningless for options) */ 218} dcmdArgInfo; 219 220typedef struct jmmInterface_1_ { 221 void* reserved1; 222 void* reserved2; 223 224 jint (JNICALL *GetVersion) (JNIEnv *env); 225 226 jint (JNICALL *GetOptionalSupport) (JNIEnv *env, 227 jmmOptionalSupport* support_ptr); 228 229 jint (JNICALL *GetThreadInfo) (JNIEnv *env, 230 jlongArray ids, 231 jint maxDepth, 232 jobjectArray infoArray); 233 234 jobjectArray (JNICALL *GetMemoryPools) (JNIEnv* env, jobject mgr); 235 236 jobjectArray (JNICALL *GetMemoryManagers) (JNIEnv* env, jobject pool); 237 238 jobject (JNICALL *GetMemoryPoolUsage) (JNIEnv* env, jobject pool); 239 jobject (JNICALL *GetPeakMemoryPoolUsage) (JNIEnv* env, jobject pool); 240 241 void (JNICALL *GetThreadAllocatedMemory) 242 (JNIEnv *env, 243 jlongArray ids, 244 jlongArray sizeArray); 245 246 jobject (JNICALL *GetMemoryUsage) (JNIEnv* env, jboolean heap); 247 248 jlong (JNICALL *GetLongAttribute) (JNIEnv *env, jobject obj, jmmLongAttribute att); 249 jboolean (JNICALL *GetBoolAttribute) (JNIEnv *env, jmmBoolAttribute att); 250 jboolean (JNICALL *SetBoolAttribute) (JNIEnv *env, jmmBoolAttribute att, jboolean flag); 251 252 jint (JNICALL *GetLongAttributes) (JNIEnv *env, 253 jobject obj, 254 jmmLongAttribute* atts, 255 jint count, 256 jlong* result); 257 258 jobjectArray (JNICALL *FindCircularBlockedThreads) (JNIEnv *env); 259 260 // Not used in JDK 6 or JDK 7 261 jlong (JNICALL *GetThreadCpuTime) (JNIEnv *env, jlong thread_id); 262 263 jobjectArray (JNICALL *GetVMGlobalNames) (JNIEnv *env); 264 jint (JNICALL *GetVMGlobals) (JNIEnv *env, 265 jobjectArray names, 266 jmmVMGlobal *globals, 267 jint count); 268 269 jint (JNICALL *GetInternalThreadTimes) (JNIEnv *env, 270 jobjectArray names, 271 jlongArray times); 272 273 jboolean (JNICALL *ResetStatistic) (JNIEnv *env, 274 jvalue obj, 275 jmmStatisticType type); 276 277 void (JNICALL *SetPoolSensor) (JNIEnv *env, 278 jobject pool, 279 jmmThresholdType type, 280 jobject sensor); 281 282 jlong (JNICALL *SetPoolThreshold) (JNIEnv *env, 283 jobject pool, 284 jmmThresholdType type, 285 jlong threshold); 286 jobject (JNICALL *GetPoolCollectionUsage) (JNIEnv* env, jobject pool); 287 288 jint (JNICALL *GetGCExtAttributeInfo) (JNIEnv *env, 289 jobject mgr, 290 jmmExtAttributeInfo *ext_info, 291 jint count); 292 void (JNICALL *GetLastGCStat) (JNIEnv *env, 293 jobject mgr, 294 jmmGCStat *gc_stat); 295 296 jlong (JNICALL *GetThreadCpuTimeWithKind) 297 (JNIEnv *env, 298 jlong thread_id, 299 jboolean user_sys_cpu_time); 300 void (JNICALL *GetThreadCpuTimesWithKind) 301 (JNIEnv *env, 302 jlongArray ids, 303 jlongArray timeArray, 304 jboolean user_sys_cpu_time); 305 306 jint (JNICALL *DumpHeap0) (JNIEnv *env, 307 jstring outputfile, 308 jboolean live); 309 jobjectArray (JNICALL *FindDeadlocks) (JNIEnv *env, 310 jboolean object_monitors_only); 311 void (JNICALL *SetVMGlobal) (JNIEnv *env, 312 jstring flag_name, 313 jvalue new_value); 314 void* reserved6; 315 jobjectArray (JNICALL *DumpThreads) (JNIEnv *env, 316 jlongArray ids, 317 jboolean lockedMonitors, 318 jboolean lockedSynchronizers); 319 void (JNICALL *SetGCNotificationEnabled) (JNIEnv *env, 320 jobject mgr, 321 jboolean enabled); 322 jobjectArray (JNICALL *GetDiagnosticCommands) (JNIEnv *env); 323 void (JNICALL *GetDiagnosticCommandInfo) 324 (JNIEnv *env, 325 jobjectArray cmds, 326 dcmdInfo *infoArray); 327 void (JNICALL *GetDiagnosticCommandArgumentsInfo) 328 (JNIEnv *env, 329 jstring commandName, 330 dcmdArgInfo *infoArray); 331 jstring (JNICALL *ExecuteDiagnosticCommand) 332 (JNIEnv *env, 333 jstring command); 334 void (JNICALL *SetDiagnosticFrameworkNotificationEnabled) 335 (JNIEnv *env, 336 jboolean enabled); 337} JmmInterface; 338 339#ifdef __cplusplus 340} /* extern "C" */ 341#endif /* __cplusplus */ 342 343#endif /* !_JAVA_JMM_H_ */ 344