annotate src/share/vm/trace/traceEvent.hpp @ 10405:f2110083203d

8005849: JEP 167: Event-Based JVM Tracing Reviewed-by: acorn, coleenp, sla Contributed-by: Karen Kinnear <karen.kinnear@oracle.com>, Bengt Rutisson <bengt.rutisson@oracle.com>, Calvin Cheung <calvin.cheung@oracle.com>, Erik Gahlin <erik.gahlin@oracle.com>, Erik Helin <erik.helin@oracle.com>, Jesper Wilhelmsson <jesper.wilhelmsson@oracle.com>, Keith McGuigan <keith.mcguigan@oracle.com>, Mattias Tobiasson <mattias.tobiasson@oracle.com>, Markus Gronlund <markus.gronlund@oracle.com>, Mikael Auno <mikael.auno@oracle.com>, Nils Eliasson <nils.eliasson@oracle.com>, Nils Loodin <nils.loodin@oracle.com>, Rickard Backman <rickard.backman@oracle.com>, Staffan Larsen <staffan.larsen@oracle.com>, Stefan Karlsson <stefan.karlsson@oracle.com>, Yekaterina Kantserova <yekaterina.kantserova@oracle.com>
author sla
date Mon, 10 Jun 2013 11:30:51 +0200
parents
children 86e6d691f2e1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10405
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
1 /*
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
4 *
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
7 * published by the Free Software Foundation.
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
8 *
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
13 * accompanied this code).
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
14 *
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
18 *
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
21 * questions.
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
22 *
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
23 */
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
24
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
25 #ifndef SHARE_VM_TRACE_TRACEEVENT_HPP
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
26 #define SHARE_VM_TRACE_TRACEEVENT_HPP
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
27
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
28 enum EventStartTime {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
29 UNTIMED,
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
30 TIMED
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
31 };
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
32
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
33 #include "utilities/macros.hpp"
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
34
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
35 #if INCLUDE_TRACE
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
36
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
37 #include "trace/traceBackend.hpp"
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
38 #include "trace/tracing.hpp"
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
39 #include "tracefiles/traceEventIds.hpp"
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
40 #include "tracefiles/traceTypes.hpp"
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
41
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
42 template<typename T>
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
43 class TraceEvent : public StackObj {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
44 protected:
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
45 jlong _startTime;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
46 jlong _endTime;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
47
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
48 private:
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
49 bool _started;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
50 #ifdef ASSERT
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
51 bool _committed;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
52 bool _cancelled;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
53 protected:
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
54 bool _ignore_check;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
55 #endif
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
56
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
57 public:
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
58 TraceEvent(EventStartTime timing=TIMED) :
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
59 _startTime(0),
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
60 _endTime(0),
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
61 _started(false)
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
62 #ifdef ASSERT
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
63 ,
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
64 _committed(false),
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
65 _cancelled(false),
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
66 _ignore_check(false)
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
67 #endif
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
68 {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
69 if (T::is_enabled()) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
70 _started = true;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
71 if (timing == TIMED && !T::isInstant) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
72 static_cast<T *>(this)->set_starttime(Tracing::time());
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
73 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
74 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
75 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
76
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
77 static bool is_enabled() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
78 return Tracing::is_event_enabled(T::eventId);
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
79 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
80
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
81 bool should_commit() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
82 return _started;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
83 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
84
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
85 void ignoreCheck() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
86 DEBUG_ONLY(_ignore_check = true);
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
87 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
88
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
89 void commit() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
90 if (!should_commit()) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
91 cancel();
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
92 return;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
93 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
94 if (_endTime == 0) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
95 static_cast<T*>(this)->set_endtime(Tracing::time());
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
96 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
97 if (static_cast<T*>(this)->should_write()) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
98 static_cast<T*>(this)->writeEvent();
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
99 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
100 set_commited();
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
101 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
102
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
103 void set_starttime(jlong time) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
104 _startTime = time;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
105 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
106
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
107 void set_endtime(jlong time) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
108 _endTime = time;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
109 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
110
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
111 TraceEventId id() const {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
112 return T::eventId;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
113 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
114
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
115 bool is_instant() const {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
116 return T::isInstant;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
117 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
118
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
119 bool is_requestable() const {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
120 return T::isRequestable;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
121 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
122
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
123 bool has_thread() const {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
124 return T::hasThread;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
125 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
126
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
127 bool has_stacktrace() const {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
128 return T::hasStackTrace;
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
129 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
130
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
131 void cancel() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
132 assert(!_committed && !_cancelled, "event was already committed/cancelled");
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
133 DEBUG_ONLY(_cancelled = true);
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
134 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
135
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
136 void set_commited() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
137 assert(!_committed, "event has already been committed");
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
138 DEBUG_ONLY(_committed = true);
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
139 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
140
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
141 ~TraceEvent() {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
142 if (_started) {
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
143 assert(_ignore_check || _committed || _cancelled, "event was not committed/cancelled");
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
144 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
145 }
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
146 };
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
147
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
148 #endif /* INCLUDE_TRACE */
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
149
f2110083203d 8005849: JEP 167: Event-Based JVM Tracing
sla
parents:
diff changeset
150 #endif /* SHARE_VM_TRACE_TRACEEVENT_HPP */