1 /*
   2  * Copyright (c) 2006, 2010, 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 OS_SOLARIS_DTRACE_JVM_DTRACE_H
  26 #define OS_SOLARIS_DTRACE_JVM_DTRACE_H
  27 
  28 #ifndef _JVM_DTRACE_H_
  29 #define _JVM_DTRACE_H_
  30 
  31 /*
  32  * Interface to dynamically turn on probes in Hotspot JVM. Currently,
  33  * this interface can be used to dynamically enable certain DTrace
  34  * probe points that are costly to have "always on".
  35  */
  36 
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40 
  41 #include <sys/types.h>
  42 
  43 
  44 struct _jvm_t;
  45 typedef struct _jvm_t jvm_t;
  46 
  47 
  48 /* Attach to the given JVM process. Returns NULL on failure.
  49    jvm_get_last_error() returns last error message. */
  50 jvm_t* jvm_attach(pid_t pid);
  51 
  52 /* Returns the last error message from this library or NULL if none. */
  53 const char* jvm_get_last_error();
  54 
  55 /* few well-known probe type constants for 'probe_types' param below */
  56 
  57 #define JVM_DTPROBE_METHOD_ENTRY         "method-entry"
  58 #define JVM_DTPROBE_METHOD_RETURN        "method-return"
  59 #define JVM_DTPROBE_MONITOR_ENTER        "monitor-contended-enter"
  60 #define JVM_DTPROBE_MONITOR_ENTERED      "monitor-contended-entered"
  61 #define JVM_DTPROBE_MONITOR_EXIT         "monitor-contended-exit"
  62 #define JVM_DTPROBE_MONITOR_WAIT         "monitor-wait"
  63 #define JVM_DTPROBE_MONITOR_WAITED       "monitor-waited"
  64 #define JVM_DTPROBE_MONITOR_NOTIFY       "monitor-notify"
  65 #define JVM_DTPROBE_MONITOR_NOTIFYALL    "monitor-notifyall"
  66 #define JVM_DTPROBE_OBJECT_ALLOC         "object-alloc"
  67 #define JVM_DTPROBE_ALL                  "*"
  68 
  69 /* Enable the specified DTrace probes of given probe types on
  70  * the specified JVM. Returns >= 0 on success, -1 on failure.
  71  * On success, this returns number of probe_types enabled.
  72  * On failure, jvm_get_last_error() returns the last error message.
  73  */
  74 int jvm_enable_dtprobes(jvm_t* jvm, int num_probe_types, const char** probe_types);
  75 
  76 /* Note: There is no jvm_disable_dtprobes function. Probes are automatically
  77  * disabled when there are no more clients requiring those probes.
  78  */
  79 
  80 /* Detach the given JVM. Returns 0 on success, -1 on failure.
  81  * jvm_get_last_error() returns the last error message.
  82  */
  83 int jvm_detach(jvm_t* jvm);
  84 
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88 
  89 #endif /* _JVM_DTRACE_H_ */
  90 
  91 #endif // OS_SOLARIS_DTRACE_JVM_DTRACE_H