1 /*
2 * Copyright (c) 2011, 2018, 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 #include "precompiled.hpp"
26 #include "classfile/classLoaderData.inline.hpp"
27 #include "classfile/symbolTable.hpp"
28 #include "jfr/recorder/checkpoint/types/traceid/jfrTraceId.inline.hpp"
29 #include "jfr/utilities/jfrTypes.hpp"
30 #include "oops/arrayKlass.hpp"
31 #include "oops/klass.inline.hpp"
32 #include "oops/instanceKlass.hpp"
33 #include "oops/method.hpp"
34 #include "oops/oop.inline.hpp"
35 #include "runtime/atomic.inline.hpp"
36 #include "runtime/orderAccess.inline.hpp"
37 #include "runtime/vm_version.hpp"
38 #include "runtime/jniHandles.hpp"
39 #include "runtime/thread.inline.hpp"
40 #include "utilities/debug.hpp"
41
42 // returns updated value
43 static traceid atomic_inc(traceid volatile* const dest) {
44 return (traceid) atomic_add_jlong(1, (jlong volatile*) dest);
45 }
46
47 static traceid next_class_id() {
48 static volatile traceid class_id_counter = MaxJfrEventId + 100;
49 return atomic_inc(&class_id_counter) << TRACE_ID_SHIFT;
50 }
51
52 static traceid next_thread_id() {
53 #ifdef _LP64
54 static volatile traceid thread_id_counter = 0;
55 return atomic_inc(&thread_id_counter);
56 #else
57 static volatile jint thread_id_counter = 0;
58 assert(thread_id_counter >= 0 && thread_id_counter < INT_MAX, "thread counter has been overflown");
59 Atomic::inc(&thread_id_counter);
60 return (traceid) thread_id_counter;
61 #endif
62 }
63
64 // XXX
65 // static traceid next_package_id() {
66 // static volatile traceid package_id_counter = 1;
67 // return atomic_inc(&package_id_counter) << TRACE_ID_SHIFT;
68 // }
69
70 static traceid next_class_loader_data_id() {
71 static volatile traceid cld_id_counter = 1;
72 return atomic_inc(&cld_id_counter) << TRACE_ID_SHIFT;
73 }
74
75 static bool found_jdk_jfr_event_klass = false;
76
77 static void check_klass(const Klass* klass) {
78 assert(klass != NULL, "invariant");
79 if (found_jdk_jfr_event_klass) {
80 return;
81 }
82 static const Symbol* jdk_jfr_event_sym = NULL;
83 if (jdk_jfr_event_sym == NULL) {
84 // setup when loading the first TypeArrayKlass (Universe::genesis) hence single threaded invariant
85 jdk_jfr_event_sym = SymbolTable::new_permanent_symbol("jdk/jfr/Event", Thread::current());
86 }
87 assert(jdk_jfr_event_sym != NULL, "invariant");
88 if (jdk_jfr_event_sym == klass->name()/* XXX && klass->class_loader() == NULL*/) {
89 found_jdk_jfr_event_klass = true;
90 JfrTraceId::tag_as_jdk_jfr_event(klass);
91 }
92 }
93
94 void JfrTraceId::assign(const Klass* klass) {
95 assert(klass != NULL, "invariant");
96 klass->set_trace_id(next_class_id());
97 check_klass(klass);
98 const Klass* const super = klass->super();
99 if (super == NULL) {
100 return;
101 }
102 if (IS_EVENT_KLASS(super)) {
103 tag_as_jdk_jfr_event_sub(klass);
104 }
105 }
106
107 // XXX
108 // void JfrTraceId::assign(const PackageEntry* package) {
109 // assert(package != NULL, "invariant");
110 // package->set_trace_id(next_package_id());
111 // }
112
113 void JfrTraceId::assign(const ClassLoaderData* cld) {
114 assert(cld != NULL, "invariant");
115 if (cld->is_anonymous()) {
116 cld->set_trace_id(0);
117 return;
118 }
119 cld->set_trace_id(next_class_loader_data_id());
120 }
121
122 traceid JfrTraceId::assign_thread_id() {
123 return next_thread_id();
124 }
125
126 // used by CDS / APPCDS as part of "remove_unshareable_info"
127 void JfrTraceId::remove(const Klass* k) {
128 assert(k != NULL, "invariant");
129 // Mask off and store the event flags.
130 // This mechanism will retain the event specific flags
131 // in the archive, allowing for event flag restoration
132 // when renewing the traceid on klass revival.
133 k->set_trace_id(EVENT_FLAGS_MASK(k));
134 }
135
136 // used by CDS / APPCDS as part of "restore_unshareable_info"
137 void JfrTraceId::restore(const Klass* k) {
138 assert(k != NULL, "invariant");
139 if (IS_JDK_JFR_EVENT_KLASS(k)) {
140 found_jdk_jfr_event_klass = true;
141 }
142 const traceid event_flags = k->trace_id();
143 // get a fresh traceid and restore the original event flags
144 k->set_trace_id(next_class_id() | event_flags);
145 }
146
147 traceid JfrTraceId::get(jclass jc) {
148 assert(jc != NULL, "invariant");
149 assert(((JavaThread*)Thread::current())->thread_state() == _thread_in_vm, "invariant");
150 const oop my_oop = JNIHandles::resolve(jc);
151 assert(my_oop != NULL, "invariant");
152 return get(java_lang_Class::as_Klass(my_oop));
153 }
154
155 traceid JfrTraceId::use(jclass jc, bool leakp /* false */) {
156 assert(jc != NULL, "invariant");
157 assert(((JavaThread*)Thread::current())->thread_state() == _thread_in_vm, "invariant");
158 const oop my_oop = JNIHandles::resolve(jc);
159 assert(my_oop != NULL, "invariant");
160 return use(java_lang_Class::as_Klass(my_oop), leakp);
161 }
162
163 bool JfrTraceId::in_visible_set(const jclass jc) {
164 assert(jc != NULL, "invariant");
165 assert(((JavaThread*)Thread::current())->thread_state() == _thread_in_vm, "invariant");
166 const oop mirror = JNIHandles::resolve(jc);
167 assert(mirror != NULL, "invariant");
168 return in_visible_set(java_lang_Class::as_Klass(mirror));
169 }
170
171 bool JfrTraceId::in_jdk_jfr_event_hierarchy(const jclass jc) {
172 assert(jc != NULL, "invariant");
173 const oop mirror = JNIHandles::resolve(jc);
174 assert(mirror != NULL, "invariant");
175 return in_jdk_jfr_event_hierarchy(java_lang_Class::as_Klass(mirror));
176 }
177
178 bool JfrTraceId::is_jdk_jfr_event_sub(const jclass jc) {
179 assert(jc != NULL, "invariant");
180 const oop mirror = JNIHandles::resolve(jc);
181 assert(mirror != NULL, "invariant");
182 return is_jdk_jfr_event_sub(java_lang_Class::as_Klass(mirror));
183 }
184
185 bool JfrTraceId::is_jdk_jfr_event(const jclass jc) {
186 assert(jc != NULL, "invariant");
187 const oop mirror = JNIHandles::resolve(jc);
188 assert(mirror != NULL, "invariant");
189 return is_jdk_jfr_event(java_lang_Class::as_Klass(mirror));
190 }
191
192 bool JfrTraceId::is_event_host(const jclass jc) {
193 assert(jc != NULL, "invariant");
194 const oop mirror = JNIHandles::resolve(jc);
195 assert(mirror != NULL, "invariant");
196 return is_event_host(java_lang_Class::as_Klass(mirror));
197 }
198
199 void JfrTraceId::tag_as_jdk_jfr_event_sub(const jclass jc) {
200 assert(jc != NULL, "invariant");
201 const oop mirror = JNIHandles::resolve(jc);
202 assert(mirror != NULL, "invariant");
203 const Klass* const k = java_lang_Class::as_Klass(mirror);
204 tag_as_jdk_jfr_event_sub(k);
205 assert(IS_JDK_JFR_EVENT_SUBKLASS(k), "invariant");
206 }
207
208 void JfrTraceId::tag_as_event_host(const jclass jc) {
209 assert(jc != NULL, "invariant");
210 const oop mirror = JNIHandles::resolve(jc);
211 assert(mirror != NULL, "invariant");
212 const Klass* const k = java_lang_Class::as_Klass(mirror);
213 tag_as_event_host(k);
214 assert(IS_EVENT_HOST_KLASS(k), "invariant");
215 }