1 /*
   2  * Copyright (c) 2016, 2020, 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 "compiler/compilerDefinitions.hpp"
  30 #include "gc/shared/gcCause.hpp"
  31 #include "gc/shared/gcName.hpp"
  32 #include "gc/shared/gcTrace.hpp"
  33 #include "gc/shared/gcWhen.hpp"
  34 #include "jfr/leakprofiler/leakProfiler.hpp"
  35 #include "jfr/recorder/checkpoint/jfrCheckpointWriter.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/support/jfrThreadLocal.hpp"
  41 #include "jfr/writers/jfrJavaEventWriter.hpp"
  42 #include "jfr/utilities/jfrThreadIterator.hpp"
  43 #include "memory/iterator.hpp"
  44 #include "memory/metaspace.hpp"
  45 #include "memory/referenceType.hpp"
  46 #include "memory/universe.hpp"
  47 #include "oops/compressedOops.hpp"
  48 #include "runtime/flags/jvmFlag.hpp"
  49 #include "runtime/mutexLocker.hpp"
  50 #include "runtime/osThread.hpp"
  51 #include "runtime/safepoint.hpp"
  52 #include "runtime/synchronizer.hpp"
  53 #include "runtime/thread.inline.hpp"
  54 #include "runtime/vmOperations.hpp"
  55 
  56 #ifdef COMPILER2
  57 #include "opto/compile.hpp"
  58 #include "opto/node.hpp"
  59 #endif
  60 
  61 // Requires a ResourceMark for get_thread_name/as_utf8
  62 class JfrCheckpointThreadClosure : public ThreadClosure {
  63  private:
  64   JfrCheckpointWriter& _writer;
  65   JfrCheckpointContext _ctx;
  66   const int64_t _count_position;
  67   Thread* const _curthread;
  68   u4 _count;
  69 
  70  public:
  71   JfrCheckpointThreadClosure(JfrCheckpointWriter& writer) : _writer(writer),
  72                                                             _ctx(writer.context()),
  73                                                             _count_position(writer.reserve(sizeof(u4))),
  74                                                             _curthread(Thread::current()),
  75                                                             _count(0) {
  76   }
  77 
  78   ~JfrCheckpointThreadClosure() {
  79     if (_count == 0) {
  80       // restore
  81       _writer.set_context(_ctx);
  82       return;
  83     }
  84     _writer.write_count(_count, _count_position);
  85   }
  86 
  87   void do_thread(Thread* t);
  88 };
  89 
  90 void JfrCheckpointThreadClosure::do_thread(Thread* t) {
  91   assert(t != NULL, "invariant");
  92   ++_count;
  93   _writer.write_key(JfrThreadId::jfr_id(t));
  94   const char* const name = JfrThreadName::name(t);
  95   assert(name != NULL, "invariant");
  96   _writer.write(name);
  97   _writer.write<traceid>(JfrThreadId::os_id(t));
  98   if (t->is_Java_thread()) {
  99     _writer.write(name);
 100     _writer.write(JfrThreadId::id(t));
 101     _writer.write(JfrThreadGroup::thread_group_id((JavaThread*)t, _curthread));
 102     return;
 103   }
 104   _writer.write((const char*)NULL); // java name
 105   _writer.write((traceid)0); // java thread id
 106   _writer.write((traceid)0); // java thread group
 107 }
 108 
 109 void JfrThreadConstantSet::serialize(JfrCheckpointWriter& writer) {
 110   JfrCheckpointThreadClosure tc(writer);
 111   JfrJavaThreadIterator javathreads(false); // include not yet live threads (_thread_new)
 112   while (javathreads.has_next()) {
 113     tc.do_thread(javathreads.next());
 114   }
 115   JfrNonJavaThreadIterator nonjavathreads;
 116   while (nonjavathreads.has_next()) {
 117     tc.do_thread(nonjavathreads.next());
 118   }
 119 }
 120 
 121 void JfrThreadGroupConstant::serialize(JfrCheckpointWriter& writer) {
 122   JfrThreadGroup::serialize(writer);
 123 }
 124 
 125 static const char* flag_value_origin_to_string(JVMFlag::Flags origin) {
 126   switch (origin) {
 127     case JVMFlag::DEFAULT: return "Default";
 128     case JVMFlag::COMMAND_LINE: return "Command line";
 129     case JVMFlag::ENVIRON_VAR: return "Environment variable";
 130     case JVMFlag::CONFIG_FILE: return "Config file";
 131     case JVMFlag::MANAGEMENT: return "Management";
 132     case JVMFlag::ERGONOMIC: return "Ergonomic";
 133     case JVMFlag::ATTACH_ON_DEMAND: return "Attach on demand";
 134     case JVMFlag::INTERNAL: return "Internal";
 135     case JVMFlag::JIMAGE_RESOURCE: return "JImage resource";
 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 GCThresholdUpdaterConstant::serialize(JfrCheckpointWriter& writer) {
 186   static const u4 nof_entries = MetaspaceGCThresholdUpdater::Last;
 187   writer.write_count(nof_entries);
 188   for (u4 i = 0; i < nof_entries; ++i) {
 189     writer.write_key(i);
 190     writer.write(MetaspaceGCThresholdUpdater::to_string((MetaspaceGCThresholdUpdater::Type)i));
 191   }
 192 }
 193 
 194 void MetadataTypeConstant::serialize(JfrCheckpointWriter& writer) {
 195   static const u4 nof_entries = Metaspace::MetadataTypeCount;
 196   writer.write_count(nof_entries);
 197   for (u4 i = 0; i < nof_entries; ++i) {
 198     writer.write_key(i);
 199     writer.write(Metaspace::metadata_type_name((Metaspace::MetadataType)i));
 200   }
 201 }
 202 
 203 void MetaspaceObjectTypeConstant::serialize(JfrCheckpointWriter& writer) {
 204   static const u4 nof_entries = MetaspaceObj::_number_of_types;
 205   writer.write_count(nof_entries);
 206   for (u4 i = 0; i < nof_entries; ++i) {
 207     writer.write_key(i);
 208     writer.write(MetaspaceObj::type_name((MetaspaceObj::Type)i));
 209   }
 210 }
 211 
 212 static const char* reference_type_to_string(ReferenceType rt) {
 213   switch (rt) {
 214     case REF_NONE: return "None reference";
 215     case REF_OTHER: return "Other reference";
 216     case REF_SOFT: return "Soft reference";
 217     case REF_WEAK: return "Weak reference";
 218     case REF_FINAL: return "Final reference";
 219     case REF_PHANTOM: return "Phantom reference";
 220     default:
 221       ShouldNotReachHere();
 222     return NULL;
 223   }
 224 }
 225 
 226 void ReferenceTypeConstant::serialize(JfrCheckpointWriter& writer) {
 227   static const u4 nof_entries = REF_PHANTOM + 1;
 228   writer.write_count(nof_entries);
 229   for (u4 i = 0; i < nof_entries; ++i) {
 230     writer.write_key(i);
 231     writer.write(reference_type_to_string((ReferenceType)i));
 232   }
 233 }
 234 
 235 void NarrowOopModeConstant::serialize(JfrCheckpointWriter& writer) {
 236   static const u4 nof_entries = CompressedOops::HeapBasedNarrowOop + 1;
 237   writer.write_count(nof_entries);
 238   for (u4 i = 0; i < nof_entries; ++i) {
 239     writer.write_key(i);
 240     writer.write(CompressedOops::mode_to_string((CompressedOops::Mode)i));
 241   }
 242 }
 243 
 244 void CodeBlobTypeConstant::serialize(JfrCheckpointWriter& writer) {
 245   static const u4 nof_entries = CodeBlobType::NumTypes;
 246   writer.write_count(nof_entries);
 247   for (u4 i = 0; i < nof_entries; ++i) {
 248     writer.write_key(i);
 249     writer.write(CodeCache::get_code_heap_name(i));
 250   }
 251 };
 252 
 253 void VMOperationTypeConstant::serialize(JfrCheckpointWriter& writer) {
 254   static const u4 nof_entries = VM_Operation::VMOp_Terminating;
 255   writer.write_count(nof_entries);
 256   for (u4 i = 0; i < nof_entries; ++i) {
 257     writer.write_key(i);
 258     writer.write(VM_Operation::name(VM_Operation::VMOp_Type(i)));
 259   }
 260 }
 261 
 262 void ThreadStateConstant::serialize(JfrCheckpointWriter& writer) {
 263   JfrThreadState::serialize(writer);
 264 }
 265 
 266 void JfrThreadConstant::serialize(JfrCheckpointWriter& writer) {
 267   assert(_thread != NULL, "invariant");
 268   assert(_thread == Thread::current(), "invariant");
 269   writer.write_count(1);
 270   writer.write_key(JfrThreadId::jfr_id(_thread));
 271   const char* const name = JfrThreadName::name(_thread);
 272   writer.write(name);
 273   writer.write(JfrThreadId::os_id(_thread));
 274   if (_thread->is_Java_thread()) {
 275     writer.write(name);
 276     writer.write(JfrThreadId::id(_thread));
 277     JavaThread* const jt = (JavaThread*)_thread;
 278     const traceid thread_group_id = JfrThreadGroup::thread_group_id(jt, jt);
 279     writer.write(thread_group_id);
 280     JfrThreadGroup::serialize(&writer, thread_group_id);
 281     return;
 282   }
 283   writer.write((const char*)NULL); // java name
 284   writer.write((traceid)0); // java thread id
 285   writer.write((traceid)0); // java thread group
 286 }
 287 
 288 void BytecodeConstant::serialize(JfrCheckpointWriter& writer) {
 289   static const u4 nof_entries = Bytecodes::number_of_codes;
 290   writer.write_count(nof_entries);
 291   for (u4 i = 0; i < nof_entries; ++i) {
 292     writer.write_key(i);
 293     writer.write(Bytecodes::name((Bytecodes::Code)i));
 294   }
 295 }
 296 
 297 void CompilerTypeConstant::serialize(JfrCheckpointWriter& writer) {
 298   static const u4 nof_entries = compiler_number_of_types;
 299   writer.write_count(nof_entries);
 300   for (u4 i = 0; i < nof_entries; ++i) {
 301     writer.write_key(i);
 302     writer.write(compilertype2name((CompilerType)i));
 303   }
 304 }