1 /*
   2  * Copyright (c) 2003, 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.  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
  43 extern "C" {
  44 #endif
  45 
  46 enum {
  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 
  56 typedef 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 isBootClassPathSupported : 1;
  63   unsigned int isObjectMonitorUsageSupported : 1;
  64   unsigned int isSynchronizerUsageSupported : 1;
  65   unsigned int isThreadAllocatedMemorySupported : 1;
  66   unsigned int isRemoteDiagnosticCommandsSupported : 1;
  67   unsigned int : 22;
  68 } jmmOptionalSupport;
  69 
  70 typedef enum {
  71   JMM_CLASS_LOADED_COUNT             = 1,    /* Total number of loaded classes */
  72   JMM_CLASS_UNLOADED_COUNT           = 2,    /* Total number of unloaded classes */
  73   JMM_THREAD_TOTAL_COUNT             = 3,    /* Total number of threads that have been started */
  74   JMM_THREAD_LIVE_COUNT              = 4,    /* Current number of live threads */
  75   JMM_THREAD_PEAK_COUNT              = 5,    /* Peak number of live threads */
  76   JMM_THREAD_DAEMON_COUNT            = 6,    /* Current number of daemon threads */
  77   JMM_JVM_INIT_DONE_TIME_MS          = 7,    /* Time when the JVM finished initialization */
  78   JMM_COMPILE_TOTAL_TIME_MS          = 8,    /* Total accumulated time spent in compilation */
  79   JMM_GC_TIME_MS                     = 9,    /* Total accumulated time spent in collection */
  80   JMM_GC_COUNT                       = 10,   /* Total number of collections */
  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 
 108 typedef 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 
 117 enum {
 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 
 124 typedef 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 
 133 typedef 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 */
 141 typedef 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 } jmmVMGlobalType;
 147 
 148 typedef enum {
 149   JMM_VMGLOBAL_ORIGIN_DEFAULT      = 1,   /* Default value */
 150   JMM_VMGLOBAL_ORIGIN_COMMAND_LINE = 2,   /* Set at command line (or JNI invocation) */
 151   JMM_VMGLOBAL_ORIGIN_MANAGEMENT   = 3,   /* Set via management interface */
 152   JMM_VMGLOBAL_ORIGIN_ENVIRON_VAR  = 4,   /* Set via environment variables */
 153   JMM_VMGLOBAL_ORIGIN_CONFIG_FILE  = 5,   /* Set via config file (such as .hotspotrc) */
 154   JMM_VMGLOBAL_ORIGIN_ERGONOMIC    = 6,   /* Set via ergonomic */
 155   JMM_VMGLOBAL_ORIGIN_OTHER        = 99   /* Set via some other mechanism */
 156 } jmmVMGlobalOrigin;
 157 
 158 typedef struct {
 159   jstring           name;
 160   jvalue            value;
 161   jmmVMGlobalType   type;           /* Data type */
 162   jmmVMGlobalOrigin origin;         /* Default or non-default value */
 163   unsigned int      writeable : 1;  /* dynamically writeable */
 164   unsigned int      external  : 1;  /* external supported interface */
 165   unsigned int      reserved  : 30;
 166   void *reserved1;
 167   void *reserved2;
 168 } jmmVMGlobal;
 169 
 170 typedef struct {
 171   const char*  name;
 172   char         type;
 173   const char*  description;
 174 } jmmExtAttributeInfo;
 175 
 176 /* Caller has to set the following fields before calling GetLastGCStat
 177  *   o usage_before_gc               - array of MemoryUsage objects
 178  *   o usage_after_gc                - array of MemoryUsage objects
 179  *   o gc_ext_attribute_values_size - size of gc_ext_atttribute_values array
 180  *   o gc_ext_attribtue_values      - array of jvalues
 181  */
 182 typedef struct {
 183   jlong        gc_index;                       /* Index of the collections */
 184   jlong        start_time;                     /* Start time of the GC */
 185   jlong        end_time;                       /* End time of the GC */
 186   jobjectArray usage_before_gc;                /* Memory usage array before GC */
 187   jobjectArray usage_after_gc;                 /* Memory usage array after GC */
 188   jint         gc_ext_attribute_values_size;   /* set by the caller of GetGCStat */
 189   jvalue*      gc_ext_attribute_values;        /* Array of jvalue for GC extension attributes */
 190   jint         num_gc_ext_attributes;          /* number of GC extension attribute values s are filled */
 191                                                /* -1 indicates gc_ext_attribute_values is not big enough */
 192 } jmmGCStat;
 193 
 194 typedef struct {
 195   const char* name;                /* Name of the diagnostic command */
 196   const char* description;         /* Short description */
 197   const char* impact;              /* Impact on the JVM */
 198   const char* permission_class;    /* Class name of the required permission if any */
 199   const char* permission_name;     /* Permission name of the required permission if any */
 200   const char* permission_action;   /* Action name of the required permission if any*/
 201   int         num_arguments;       /* Number of supported options or arguments */
 202   jboolean    enabled;             /* True if the diagnostic command can be invoked, false otherwise*/
 203   
 204 } dcmdInfo;
 205 
 206 typedef struct {
 207   const char* name;                /* Option/Argument name*/
 208   const char* description;         /* Short description */
 209   const char* type;                /* Type: STRING, BOOLEAN, etc. */
 210   const char* default_string;      /* Default value in a parsable string */
 211   jboolean    mandatory;           /* True if the option/argument is mandatory */
 212   jboolean    option;              /* True if it is an option, false if it is an argument */
 213                                    /* (see diagnosticFramework.hpp for option/argument definitions) */
 214   jboolean    multiple;            /* True is the option can be specified several time */
 215   int         position;            /* Expected position for this argument (this field is */
 216                                    /* meaningless for options) */
 217 } dcmdArgInfo;
 218 
 219 typedef struct jmmInterface_1_ {
 220   void*        reserved1;
 221   void*        reserved2;
 222 
 223   jint         (JNICALL *GetVersion)             (JNIEnv *env);
 224 
 225   jint         (JNICALL *GetOptionalSupport)     (JNIEnv *env,
 226                                                   jmmOptionalSupport* support_ptr);
 227 
 228   /* This is used by JDK 6 and earlier.
 229    * For JDK 7 and after, use GetInputArgumentArray.
 230    */
 231   jobject      (JNICALL *GetInputArguments)      (JNIEnv *env);
 232 
 233   jint         (JNICALL *GetThreadInfo)          (JNIEnv *env,
 234                                                   jlongArray ids,
 235                                                   jint maxDepth,
 236                                                   jobjectArray infoArray);
 237   jobjectArray (JNICALL *GetInputArgumentArray)  (JNIEnv *env);
 238 
 239   jobjectArray (JNICALL *GetMemoryPools)         (JNIEnv* env, jobject mgr);
 240 
 241   jobjectArray (JNICALL *GetMemoryManagers)      (JNIEnv* env, jobject pool);
 242 
 243   jobject      (JNICALL *GetMemoryPoolUsage)     (JNIEnv* env, jobject pool);
 244   jobject      (JNICALL *GetPeakMemoryPoolUsage) (JNIEnv* env, jobject pool);
 245 
 246   void         (JNICALL *GetThreadAllocatedMemory)
 247                                                  (JNIEnv *env,
 248                                                   jlongArray ids,
 249                                                   jlongArray sizeArray);
 250 
 251   jobject      (JNICALL *GetMemoryUsage)         (JNIEnv* env, jboolean heap);
 252 
 253   jlong        (JNICALL *GetLongAttribute)       (JNIEnv *env, jobject obj, jmmLongAttribute att);
 254   jboolean     (JNICALL *GetBoolAttribute)       (JNIEnv *env, jmmBoolAttribute att);
 255   jboolean     (JNICALL *SetBoolAttribute)       (JNIEnv *env, jmmBoolAttribute att, jboolean flag);
 256 
 257   jint         (JNICALL *GetLongAttributes)      (JNIEnv *env,
 258                                                   jobject obj,
 259                                                   jmmLongAttribute* atts,
 260                                                   jint count,
 261                                                   jlong* result);
 262 
 263   jobjectArray (JNICALL *FindCircularBlockedThreads) (JNIEnv *env);
 264 
 265   // Not used in JDK 6 or JDK 7
 266   jlong        (JNICALL *GetThreadCpuTime)       (JNIEnv *env, jlong thread_id);
 267 
 268   jobjectArray (JNICALL *GetVMGlobalNames)       (JNIEnv *env);
 269   jint         (JNICALL *GetVMGlobals)           (JNIEnv *env,
 270                                                   jobjectArray names,
 271                                                   jmmVMGlobal *globals,
 272                                                   jint count);
 273 
 274   jint         (JNICALL *GetInternalThreadTimes) (JNIEnv *env,
 275                                                   jobjectArray names,
 276                                                   jlongArray times);
 277 
 278   jboolean     (JNICALL *ResetStatistic)         (JNIEnv *env,
 279                                                   jvalue obj,
 280                                                   jmmStatisticType type);
 281 
 282   void         (JNICALL *SetPoolSensor)          (JNIEnv *env,
 283                                                   jobject pool,
 284                                                   jmmThresholdType type,
 285                                                   jobject sensor);
 286 
 287   jlong        (JNICALL *SetPoolThreshold)       (JNIEnv *env,
 288                                                   jobject pool,
 289                                                   jmmThresholdType type,
 290                                                   jlong threshold);
 291   jobject      (JNICALL *GetPoolCollectionUsage) (JNIEnv* env, jobject pool);
 292 
 293   jint         (JNICALL *GetGCExtAttributeInfo)  (JNIEnv *env,
 294                                                   jobject mgr,
 295                                                   jmmExtAttributeInfo *ext_info,
 296                                                   jint count);
 297   void         (JNICALL *GetLastGCStat)          (JNIEnv *env,
 298                                                   jobject mgr,
 299                                                   jmmGCStat *gc_stat);
 300 
 301   jlong        (JNICALL *GetThreadCpuTimeWithKind)
 302                                                  (JNIEnv *env,
 303                                                   jlong thread_id,
 304                                                   jboolean user_sys_cpu_time);
 305   void         (JNICALL *GetThreadCpuTimesWithKind)
 306                                                  (JNIEnv *env,
 307                                                   jlongArray ids,
 308                                                   jlongArray timeArray,
 309                                                   jboolean user_sys_cpu_time);
 310 
 311   jint         (JNICALL *DumpHeap0)              (JNIEnv *env,
 312                                                   jstring outputfile,
 313                                                   jboolean live);
 314   jobjectArray (JNICALL *FindDeadlocks)          (JNIEnv *env,
 315                                                   jboolean object_monitors_only);
 316   void         (JNICALL *SetVMGlobal)            (JNIEnv *env,
 317                                                   jstring flag_name,
 318                                                   jvalue  new_value);
 319   void*        reserved6;
 320   jobjectArray (JNICALL *DumpThreads)            (JNIEnv *env,
 321                                                   jlongArray ids,
 322                                                   jboolean lockedMonitors,
 323                                                   jboolean lockedSynchronizers);
 324   void         (JNICALL *SetGCNotificationEnabled) (JNIEnv *env,
 325                                                     jobject mgr,
 326                                                     jboolean enabled);
 327   jobjectArray (JNICALL *GetDiagnosticCommands)  (JNIEnv *env);
 328   void         (JNICALL *GetDiagnosticCommandInfo)
 329                                                  (JNIEnv *env,
 330                                                   jobjectArray cmds,
 331                                                   dcmdInfo *infoArray);
 332   void         (JNICALL *GetDiagnosticCommandArgumentsInfo)
 333                                                  (JNIEnv *env,
 334                                                   jstring commandName,
 335                                                   dcmdArgInfo *infoArray);
 336   jstring      (JNICALL *ExecuteDiagnosticCommand)
 337                                                  (JNIEnv *env,
 338                                                   jstring command);
 339   void         (JNICALL *SetDiagnosticFrameworkNotificationEnabled)
 340                                                  (JNIEnv *env,
 341                                                   jboolean enabled);
 342 } JmmInterface;
 343 
 344 #ifdef __cplusplus
 345 } /* extern "C" */
 346 #endif /* __cplusplus */
 347 
 348 #endif /* !_JAVA_JMM_H_ */