1 /*
2 * Copyright (c) 2016, 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/javaClasses.inline.hpp"
27 #include "code/codeBlob.hpp"
28 #include "code/codeCache.hpp"
29 #include "gc/shared/gcCause.hpp"
30 #include "gc/shared/gcName.hpp"
31 #include "gc/shared/gcTrace.hpp"
32 #include "gc/shared/gcWhen.hpp"
33 #include "jfr/leakprofiler/checkpoint/objectSampleCheckpoint.hpp"
34 #include "jfr/leakprofiler/leakProfiler.hpp"
35 #include "jfr/recorder/checkpoint/jfrCheckpointManager.hpp"
36 #include "jfr/recorder/checkpoint/types/jfrType.hpp"
37 #include "jfr/recorder/jfrRecorder.hpp"
38 #include "jfr/recorder/checkpoint/types/jfrThreadGroup.hpp"
39 #include "jfr/recorder/checkpoint/types/jfrThreadState.hpp"
40 #include "jfr/recorder/checkpoint/types/jfrTypeSet.hpp"
41 #include "jfr/support/jfrThreadLocal.hpp"
42 #include "jfr/writers/jfrJavaEventWriter.hpp"
43 #include "memory/metaspaceGCThresholdUpdater.hpp"
44 #include "memory/referenceType.hpp"
45 #include "memory/universe.hpp"
46 #include "runtime/flags/jvmFlag.hpp"
47 #include "runtime/mutexLocker.hpp"
48 #include "runtime/osThread.hpp"
49 #include "runtime/safepoint.hpp"
50 #include "runtime/synchronizer.hpp"
51 #include "runtime/thread.inline.hpp"
52 #include "runtime/vm_operations.hpp"
53
54 #ifdef COMPILER2
55 #include "opto/compile.hpp"
56 #include "opto/node.hpp"
57 #endif
58 #if INCLUDE_G1GC
59 #include "gc/g1/g1HeapRegionTraceType.hpp"
60 #include "gc/g1/g1YCTypes.hpp"
61 #endif
62
63 // implementation for the static registration function exposed in the api
64 bool JfrSerializer::register_serializer(JfrTypeId id, bool require_safepoint, bool permit_cache, JfrSerializer* cs) {
65 assert(cs != NULL, "invariant");
66 return JfrCheckpointManager::register_serializer(id, require_safepoint, permit_cache, cs);
67 }
68
69 class JfrCheckpointThreadCountClosure : public ThreadClosure {
70 private:
71 u4 _total_threads;
72 public:
73 JfrCheckpointThreadCountClosure() : _total_threads(0) {}
74 u4 total_threads() { return _total_threads; }
75 void do_thread(Thread *t) { _total_threads++; }
76 };
77
78 // Requires a ResourceMark for get_thread_name/as_utf8
79 class JfrCheckpointThreadClosure : public ThreadClosure {
80 private:
81 JfrCheckpointWriter& _writer;
82 Thread* _curthread;
83 public:
84 JfrCheckpointThreadClosure(JfrCheckpointWriter& writer) : _writer(writer), _curthread(Thread::current()) {}
85 void do_thread(Thread* t);
86 };
87
88 // Requires a ResourceMark for get_thread_name/as_utf8
89 void JfrCheckpointThreadClosure::do_thread(Thread* t) {
90 assert(t != NULL, "invariant");
91 assert_locked_or_safepoint(Threads_lock);
92 _writer.write_key(t->jfr_thread_local()->thread_id());
93 _writer.write(t->name());
94 const OSThread* const os_thread = t->osthread();
95 _writer.write<traceid>(os_thread != NULL ? os_thread->thread_id() : (u8)0);
96 if (t->is_Java_thread()) {
97 JavaThread* const jt = (JavaThread*)t;
98 _writer.write(jt->name());
99 _writer.write(java_lang_Thread::thread_id(jt->threadObj()));
100 _writer.write(JfrThreadGroup::thread_group_id(jt, _curthread));
101 // since we are iterating threads during a safepoint, also issue notification
102 JfrJavaEventWriter::notify(jt);
103 return;
104 }
105 _writer.write((const char*)NULL); // java name
106 _writer.write<traceid>((traceid)0); // java thread id
107 _writer.write<traceid>((traceid)0); // java thread group
108 }
109
110 void JfrThreadConstantSet::serialize(JfrCheckpointWriter& writer) {
111 assert(SafepointSynchronize::is_at_safepoint(), "invariant");
112 JfrCheckpointThreadCountClosure tcc;
113 Threads::threads_do(&tcc);
114 const u4 total_threads = tcc.total_threads();
115 // THREADS
116 writer.write_count(total_threads);
117 JfrCheckpointThreadClosure tc(writer);
118 Threads::threads_do(&tc);
119 }
120
121 void JfrThreadGroupConstant::serialize(JfrCheckpointWriter& writer) {
122 assert(SafepointSynchronize::is_at_safepoint(), "invariant");
123 JfrThreadGroup::serialize(writer);
124 }
125
126 static const char* flag_value_origin_to_string(JVMFlag::Flags origin) {
127 switch (origin) {
128 case JVMFlag::DEFAULT: return "Default";
129 case JVMFlag::COMMAND_LINE: return "Command line";
130 case JVMFlag::ENVIRON_VAR: return "Environment variable";
131 case JVMFlag::CONFIG_FILE: return "Config file";
132 case JVMFlag::MANAGEMENT: return "Management";
133 case JVMFlag::ERGONOMIC: return "Ergonomic";
134 case JVMFlag::ATTACH_ON_DEMAND: return "Attach on demand";
135 case JVMFlag::INTERNAL: return "Internal";
136 default: ShouldNotReachHere(); return "";
137 }
138 }
139
140 void FlagValueOriginConstant::serialize(JfrCheckpointWriter& writer) {
141 static const u4 nof_entries = JVMFlag::LAST_VALUE_ORIGIN + 1;
142 writer.write_count(nof_entries);
143 for (u4 i = 0; i < nof_entries; ++i) {
144 writer.write_key(i);
145 writer.write(flag_value_origin_to_string((JVMFlag::Flags)i));
146 }
147 }
148
149 void MonitorInflateCauseConstant::serialize(JfrCheckpointWriter& writer) {
150 static const u4 nof_entries = ObjectSynchronizer::inflate_cause_nof;
151 writer.write_count(nof_entries);
152 for (u4 i = 0; i < nof_entries; ++i) {
153 writer.write_key(i);
154 writer.write(ObjectSynchronizer::inflate_cause_name((ObjectSynchronizer::InflateCause)i));
155 }
156 }
157
158 void GCCauseConstant::serialize(JfrCheckpointWriter& writer) {
159 static const u4 nof_entries = GCCause::_last_gc_cause;
160 writer.write_count(nof_entries);
161 for (u4 i = 0; i < nof_entries; ++i) {
162 writer.write_key(i);
163 writer.write(GCCause::to_string((GCCause::Cause)i));
164 }
165 }
166
167 void GCNameConstant::serialize(JfrCheckpointWriter& writer) {
168 static const u4 nof_entries = GCNameEndSentinel;
169 writer.write_count(nof_entries);
170 for (u4 i = 0; i < nof_entries; ++i) {
171 writer.write_key(i);
172 writer.write(GCNameHelper::to_string((GCName)i));
173 }
174 }
175
176 void GCWhenConstant::serialize(JfrCheckpointWriter& writer) {
177 static const u4 nof_entries = GCWhen::GCWhenEndSentinel;
178 writer.write_count(nof_entries);
179 for (u4 i = 0; i < nof_entries; ++i) {
180 writer.write_key(i);
181 writer.write(GCWhen::to_string((GCWhen::Type)i));
182 }
183 }
184
185 void G1HeapRegionTypeConstant::serialize(JfrCheckpointWriter& writer) {
186 static const u4 nof_entries = G1HeapRegionTraceType::G1HeapRegionTypeEndSentinel;
187 writer.write_count(nof_entries);
188 for (u4 i = 0; i < nof_entries; ++i) {
189 writer.write_key(i);
190 writer.write(G1HeapRegionTraceType::to_string((G1HeapRegionTraceType::Type)i));
191 }
192 }
193
194 void GCThresholdUpdaterConstant::serialize(JfrCheckpointWriter& writer) {
195 static const u4 nof_entries = MetaspaceGCThresholdUpdater::Last;
196 writer.write_count(nof_entries);
197 for (u4 i = 0; i < nof_entries; ++i) {
198 writer.write_key(i);
199 writer.write(MetaspaceGCThresholdUpdater::to_string((MetaspaceGCThresholdUpdater::Type)i));
200 }
201 }
202
203 void MetadataTypeConstant::serialize(JfrCheckpointWriter& writer) {
204 static const u4 nof_entries = Metaspace::MetadataTypeCount;
205 writer.write_count(nof_entries);
206 for (u4 i = 0; i < nof_entries; ++i) {
207 writer.write_key(i);
208 writer.write(Metaspace::metadata_type_name((Metaspace::MetadataType)i));
209 }
210 }
211
212 void MetaspaceObjectTypeConstant::serialize(JfrCheckpointWriter& writer) {
213 static const u4 nof_entries = MetaspaceObj::_number_of_types;
214 writer.write_count(nof_entries);
215 for (u4 i = 0; i < nof_entries; ++i) {
216 writer.write_key(i);
217 writer.write(MetaspaceObj::type_name((MetaspaceObj::Type)i));
218 }
219 }
220
221 void G1YCTypeConstant::serialize(JfrCheckpointWriter& writer) {
222 #if INCLUDE_G1GC
223 static const u4 nof_entries = G1YCTypeEndSentinel;
224 writer.write_count(nof_entries);
225 for (u4 i = 0; i < nof_entries; ++i) {
226 writer.write_key(i);
227 writer.write(G1YCTypeHelper::to_string((G1YCType)i));
228 }
229 #endif
230 }
231
232 static const char* reference_type_to_string(ReferenceType rt) {
233 switch (rt) {
234 case REF_NONE: return "None reference";
235 case REF_OTHER: return "Other reference";
236 case REF_SOFT: return "Soft reference";
237 case REF_WEAK: return "Weak reference";
238 case REF_FINAL: return "Final reference";
239 case REF_PHANTOM: return "Phantom reference";
240 default:
241 ShouldNotReachHere();
242 return NULL;
243 }
244 }
245
246 void ReferenceTypeConstant::serialize(JfrCheckpointWriter& writer) {
247 static const u4 nof_entries = REF_PHANTOM + 1;
248 writer.write_count(nof_entries);
249 for (u4 i = 0; i < nof_entries; ++i) {
250 writer.write_key(i);
251 writer.write(reference_type_to_string((ReferenceType)i));
252 }
253 }
254
255 void NarrowOopModeConstant::serialize(JfrCheckpointWriter& writer) {
256 static const u4 nof_entries = Universe::HeapBasedNarrowOop + 1;
257 writer.write_count(nof_entries);
258 for (u4 i = 0; i < nof_entries; ++i) {
259 writer.write_key(i);
260 writer.write(Universe::narrow_oop_mode_to_string((Universe::NARROW_OOP_MODE)i));
261 }
262 }
263
264 void CompilerPhaseTypeConstant::serialize(JfrCheckpointWriter& writer) {
265 #ifdef COMPILER2
266 static const u4 nof_entries = PHASE_NUM_TYPES;
267 writer.write_count(nof_entries);
268 for (u4 i = 0; i < nof_entries; ++i) {
269 writer.write_key(i);
270 writer.write(CompilerPhaseTypeHelper::to_string((CompilerPhaseType)i));
271 }
272 #endif
273 }
274
275 void CodeBlobTypeConstant::serialize(JfrCheckpointWriter& writer) {
276 static const u4 nof_entries = CodeBlobType::NumTypes;
277 writer.write_count(nof_entries);
278 for (u4 i = 0; i < nof_entries; ++i) {
279 writer.write_key(i);
280 writer.write(CodeCache::get_code_heap_name(i));
281 }
282 };
283
284 void VMOperationTypeConstant::serialize(JfrCheckpointWriter& writer) {
285 static const u4 nof_entries = VM_Operation::VMOp_Terminating;
286 writer.write_count(nof_entries);
287 for (u4 i = 0; i < nof_entries; ++i) {
288 writer.write_key(i);
289 writer.write(VM_Operation::name(VM_Operation::VMOp_Type(i)));
290 }
291 }
292
293 class TypeSetSerialization {
294 private:
295 bool _class_unload;
296 public:
297 explicit TypeSetSerialization(bool class_unload) : _class_unload(class_unload) {}
298 void write(JfrCheckpointWriter& writer, JfrCheckpointWriter* leakp_writer) {
299 JfrTypeSet::serialize(&writer, leakp_writer, _class_unload);
300 }
301 };
302
303 void ClassUnloadTypeSet::serialize(JfrCheckpointWriter& writer) {
304 TypeSetSerialization type_set(true);
305 if (LeakProfiler::is_running()) {
306 JfrCheckpointWriter leakp_writer(false, true, Thread::current());
307 type_set.write(writer, &leakp_writer);
308 ObjectSampleCheckpoint::install(leakp_writer, true, true);
309 return;
310 }
311 type_set.write(writer, NULL);
312 };
313
314 void TypeSet::serialize(JfrCheckpointWriter& writer) {
315 TypeSetSerialization type_set(false);
316 if (LeakProfiler::is_suspended()) {
317 JfrCheckpointWriter leakp_writer(false, true, Thread::current());
318 type_set.write(writer, &leakp_writer);
319 ObjectSampleCheckpoint::install(leakp_writer, false, true);
320 return;
321 }
322 type_set.write(writer, NULL);
323 };
324
325 void ThreadStateConstant::serialize(JfrCheckpointWriter& writer) {
326 JfrThreadState::serialize(writer);
327 }
328
329 void JfrThreadConstant::serialize(JfrCheckpointWriter& writer) {
330 assert(_thread != NULL, "invariant");
331 assert(_thread == Thread::current(), "invariant");
332 assert(_thread->is_Java_thread(), "invariant");
333 assert(!_thread->jfr_thread_local()->has_thread_checkpoint(), "invariant");
334 ResourceMark rm(_thread);
335 const oop threadObj = _thread->threadObj();
336 assert(threadObj != NULL, "invariant");
337 const u8 java_lang_thread_id = java_lang_Thread::thread_id(threadObj);
338 const char* const thread_name = _thread->name();
339 const traceid thread_group_id = JfrThreadGroup::thread_group_id(_thread);
340 writer.write_count(1);
341 writer.write_key(_thread->jfr_thread_local()->thread_id());
342 writer.write(thread_name);
343 writer.write((u8)_thread->osthread()->thread_id());
344 writer.write(thread_name);
345 writer.write(java_lang_thread_id);
346 writer.write(thread_group_id);
347 JfrThreadGroup::serialize(&writer, thread_group_id);
348 }