author | kamg |
Thu, 08 May 2008 09:16:03 -0400 | |
changeset 491 | a394684ccfe6 |
parent 406 | bde3a21bcab0 |
child 5506 | 202f599c92aa |
permissions | -rw-r--r-- |
406
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
1 |
/* |
491
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
2 |
* Copyright 2008 Sun Microsystems, Inc. All Rights Reserved. |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
4 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
7 |
* published by the Free Software Foundation. Sun designates this |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
9 |
* by Sun in the LICENSE file that accompanied this code. |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
10 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
15 |
* accompanied this code). |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
16 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
20 |
* |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
21 |
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
22 |
* CA 95054 USA or visit www.sun.com if you need additional information or |
a394684ccfe6
6697875: Copyright headers need to be upgraded with GPL derivative
kamg
parents:
406
diff
changeset
|
23 |
* have any questions. |
406
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
24 |
*/ |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
25 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
26 |
/** |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
27 |
* This package provides a mechanism for defining and |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
28 |
* inserting tracepoints into Java-technology based applications, which |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
29 |
* can then be monitored by the tracing tools available on the system. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
30 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
31 |
* To add tracepoints to a program, you must first decide where to place the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
32 |
* tracepoints, what the logical names are for these points, what information |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
33 |
* will be available to the tracing mechanisms at each point, and decide upon |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
34 |
* any logical grouping. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
35 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
36 |
* You add instrumentation to a program in three steps: |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
37 |
* <ul> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
38 |
* <li>First, declare tracepoints by creating interfaces to define |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
39 |
* them, and include these interfaces in the program definition. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
40 |
* The declared interfaces are standard Java technology-based |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
41 |
* interfaces and are compiled with the program.</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
42 |
* <li>Second, add code in the application to create an instance of the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
43 |
* interface at some point during the initialization of the application, |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
44 |
* using a factory class provided by the system. The reference to the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
45 |
* instance can be stored as a global static, or passed as context to all |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
46 |
* the places where it is needed.</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
47 |
* <li>Finally, add the actual tracepoints to the desired locations in the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
48 |
* application by inserting a call to one of the methods defined in the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
49 |
* interface, via the factory-created reference.</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
50 |
* </ul> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
51 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
52 |
* The method calls representing the tracepoints have no logical |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
53 |
* impact on the program. The side effect of the call is that any |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
54 |
* activated tracing mechanisms will be notified that the tracepoint has |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
55 |
* been hit, and will take whatever actions are appropriate (for example, |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
56 |
* logging the tracepoint, or triggering a DTrace probe, etc.). In most |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
57 |
* cases, the impact on performance of adding tracepoints to the application |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
58 |
* will be minimal. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
59 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
60 |
* Each logical grouping of tracepoints should be defined in a common |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
61 |
* interface, called a <i>provider</i>. An application can have one or many |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
62 |
* providers. Each provider is independent and can be created whenever |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
63 |
* it is appropriate for that provider, for example, when a subsytem is |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
64 |
* initialized. Providers should be disposed of when they are no longer |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
65 |
* needed, to free up any associated system resources. Each tracepoint |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
66 |
* in a provider is represented by a method in that interface. These methods |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
67 |
* are referred to as <i>probes</i>. The method signature determines the probe |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
68 |
* parameters. A call to the method with the specified parameters triggers |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
69 |
* the probe and makes its parameter values visible to any associated tracing |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
70 |
* mechanism. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
71 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
72 |
* User-defined interfaces which represent providers must extend the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
73 |
* {@code Provider} interface. To activate the system-defined |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
74 |
* tracing mechanisms, you must obtain an instance of the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
75 |
* {@code ProviderFactory} class, and pass the class of the provider to |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
76 |
* the {@code createProvider()} method. The returned instance is then used to |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
77 |
* trigger the probes later in the application. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
78 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
79 |
* In addition to triggering the probes, the provider instance can be used |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
80 |
* to obtain direct references to the {@code Probe} objects, which can be used |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
81 |
* directly for triggering, or can be queried to determine whether the probe is |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
82 |
* currently being traced. The {@code Provider} interface also defines a |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
83 |
* {@code Provider.dispose()} method which is used to free up any resources |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
84 |
* that might be associated with that provider. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
85 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
86 |
* When a probe is triggered, any activated tracing system will be given |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
87 |
* the provider name, the probe name, and the values of the probe arguments. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
88 |
* The tracing system is free to consume this data is whatever way is |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
89 |
* appropriate. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
90 |
* By default, the provider name is the same as the class name of the interface |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
91 |
* that defines the provider. Similarly, the probe name is |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
92 |
* the name of the method that defines the probe. These default values |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
93 |
* can be over-ridden by annotations. The provider definition can be |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
94 |
* annotated with the {@code @ProviderName} annotation, whose value will |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
95 |
* indicate the provider name that the tracing system will use. Similarly, |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
96 |
* the {@code @ProbeName} annotation annotates a declared method and |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
97 |
* indicates the probe name that should be used in the place of the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
98 |
* method name. These annotations can be used to define providers and |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
99 |
* probes with the same name, in cases where the semantics of the Java language |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
100 |
* may prevent this. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
101 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
102 |
* Here is a very small and simple usage example: |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
103 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
104 |
* |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
105 |
<PRE> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
106 |
import com.sun.tracing.Provider; |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
107 |
import com.sun.tracing.ProviderFactory; |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
108 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
109 |
interface MyProvider extends Provider { |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
110 |
void startProbe(); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
111 |
void finishProbe(int value); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
112 |
} |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
113 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
114 |
public class MyApplication { |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
115 |
public static void main(String argv[]) { |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
116 |
ProviderFactory factory = ProviderFactory.getDefaultFactory(); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
117 |
MyProvider trace = factory.createProvider(MyProvider.class); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
118 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
119 |
trace.startProbe(); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
120 |
int result = foo(); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
121 |
trace.finishProbe(result); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
122 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
123 |
trace.dispose(); |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
124 |
} |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
125 |
} |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
126 |
</PRE> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
127 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
128 |
* The Java Development Kit (JDK) currently only includes one system-defined |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
129 |
* tracing framework: DTrace. DTrace is enabled automatically whenever an |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
130 |
* application is run on a system and a JDK release that supports it. When |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
131 |
* DTrace is enabled, probes are made available for listing and matching by |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
132 |
* DTrace scripts as soon as the provider is created. At the tracepoint, an |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
133 |
* associated DTrace script is informed of the creation of the provider, and |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
134 |
* it takes whatever action it is designed to take. Tracepoints in the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
135 |
* program have the following DTrace probe names:<br> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
136 |
* {@code <provider><pid>:<module>:<function>:<probe>} |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
137 |
* Where: |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
138 |
* <ul> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
139 |
* <li>{@code <provider>} the provider name as specified by the application</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
140 |
* <li>{@code <pid>} the operating system process ID</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
141 |
* <li>{@code <module>} undefined, unless specified by the application</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
142 |
* <li>{@code <function>} undefined, unless specified by the application</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
143 |
* <li>{@code <probe>} the probe name as specified by the application</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
144 |
* </ul> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
145 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
146 |
* The {@code com.sun.tracing.dtrace} package contains additional |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
147 |
* annotations that can be used to control the names used for the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
148 |
* <code>module</code> and <code>function</code> fields, as well as annotations |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
149 |
* that can be added to the provider to control probe stability and dependency |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
150 |
* attributes. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
151 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
152 |
* Integer, float and string probe parameters are made available to DTrace |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
153 |
* using |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
154 |
* the built-in argument variables, {@code arg0 ... arg_n}. Integer-types |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
155 |
* are passed by value (boxed values are unboxed), floating-point types are |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
156 |
* passed as encoded integer |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
157 |
* arguments, and {@code java.lang.String} objects are converted |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
158 |
* to UTF8 strings, so they can be read into the DTrace script using the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
159 |
* {@code copyinstr()} intrinsic. Non-string and non-boxed primitive |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
160 |
* reference arguments are only |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
161 |
* placeholders and have no value. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
162 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
163 |
* Using the example above, with a theoretical process ID of 123, these are |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
164 |
* the probes that can be traced from DTrace: |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
165 |
<PRE> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
166 |
MyProvider123:::startProbe |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
167 |
MyProvider123:::finishProbe |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
168 |
</PRE> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
169 |
* When {@code finishProbe} executes, {@code arg0} will contain the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
170 |
* value of {@code result}. |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
171 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
172 |
* The DTrace tracing mechanism is enabled for all providers, apart from in the |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
173 |
* following circumstances: |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
174 |
* <ul> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
175 |
* <li>DTrace is not supported on the underlying system.</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
176 |
* <li>The property {@code com.sun.tracing.dtrace} is set to "disable".</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
177 |
* <li>The RuntimePermission {@code com.sun.tracing.dtrace.createProvider} |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
178 |
* is denied to the process.</li> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
179 |
* </ul> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
180 |
* <p> |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
181 |
*/ |
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
182 |
|
bde3a21bcab0
6690122: Provide a mechanism for specifying Java-level USDT-like dtrace probes
kamg
parents:
diff
changeset
|
183 |
package com.sun.tracing; |