1 /*
   2  * Copyright (c) 2016, 2019, 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 #ifndef SHARE_JFR_RECORDER_CHECKPOINT_TYPES_TRACEID_JFRTRACEID_INLINE_HPP
  26 #define SHARE_JFR_RECORDER_CHECKPOINT_TYPES_TRACEID_JFRTRACEID_INLINE_HPP
  27 
  28 #include "classfile/classLoaderData.hpp"
  29 #include "classfile/moduleEntry.hpp"
  30 #include "classfile/packageEntry.hpp"
  31 #include "jfr/recorder/checkpoint/types/traceid/jfrTraceId.hpp"
  32 #include "jfr/recorder/checkpoint/types/traceid/jfrTraceIdBits.inline.hpp"
  33 #include "jfr/recorder/checkpoint/types/traceid/jfrTraceIdEpoch.hpp"
  34 #include "jfr/recorder/checkpoint/types/traceid/jfrTraceIdMacros.hpp"
  35 #include "jfr/support/jfrKlassExtension.hpp"
  36 #include "oops/arrayKlass.hpp"
  37 #include "oops/klass.hpp"
  38 #include "oops/instanceKlass.hpp"
  39 #include "oops/method.hpp"
  40 #include "runtime/thread.inline.hpp"
  41 #include "utilities/debug.hpp"
  42 
  43 template <typename T>
  44 inline traceid set_used_and_get(const T* type) {
  45   assert(type != NULL, "invariant");
  46   SET_USED_THIS_EPOCH(type);
  47   assert(USED_THIS_EPOCH(type), "invariant");
  48   return TRACE_ID(type);
  49 }
  50 
  51 inline traceid JfrTraceId::get(const Klass* klass) {
  52   assert(klass != NULL, "invariant");
  53   return TRACE_ID(klass);
  54 }
  55 
  56 inline traceid JfrTraceId::get(const Thread* t) {
  57   assert(t != NULL, "invariant");
  58   return TRACE_ID_RAW(t->jfr_thread_local());
  59 }
  60 
  61 inline traceid JfrTraceId::use(const Klass* klass) {
  62   assert(klass != NULL, "invariant");
  63   return set_used_and_get(klass);
  64 }
  65 
  66 inline traceid JfrTraceId::use(const Method* method) {
  67   assert(method != NULL, "invariant");
  68   return use(method->method_holder(), method);
  69 }
  70 
  71 inline traceid JfrTraceId::use(const Klass* klass, const Method* method) {
  72   assert(klass != NULL, "invariant");
  73   assert(method != NULL, "invariant");
  74   SET_METHOD_FLAG_USED_THIS_EPOCH(method);
  75 
  76   SET_METHOD_AND_CLASS_USED_THIS_EPOCH(klass);
  77   assert(METHOD_AND_CLASS_USED_THIS_EPOCH(klass), "invariant");
  78   return (METHOD_ID(klass, method));
  79 }
  80 
  81 inline traceid JfrTraceId::use(const ModuleEntry* module) {
  82   assert(module != NULL, "invariant");
  83   return set_used_and_get(module);
  84 }
  85 
  86 inline traceid JfrTraceId::use(const PackageEntry* package) {
  87   assert(package != NULL, "invariant");
  88   return set_used_and_get(package);
  89 }
  90 
  91 inline traceid JfrTraceId::use(const ClassLoaderData* cld) {
  92   assert(cld != NULL, "invariant");
  93   return cld->is_shortlived() ? 0 : set_used_and_get(cld);
  94 }
  95 
  96 inline void JfrTraceId::set_leakp(const Method* method) {
  97   assert(method != NULL, "invariant");
  98   const Klass* const klass = method->method_holder();
  99   assert(klass != NULL, "invariant");
 100   assert(METHOD_AND_CLASS_USED_THIS_EPOCH(klass), "invariant");
 101   assert(METHOD_FLAG_USED_THIS_EPOCH(method), "invariant");
 102   SET_LEAKP(klass);
 103   SET_METHOD_LEAKP(method);
 104 }
 105 
 106 inline bool JfrTraceId::in_visible_set(const Klass* klass) {
 107   assert(klass != NULL, "invariant");
 108   assert(((JavaThread*)Thread::current())->thread_state() == _thread_in_vm, "invariant");
 109   return (IS_JDK_JFR_EVENT_SUBKLASS(klass) && !klass->is_abstract()) || IS_EVENT_HOST_KLASS(klass);
 110 }
 111 
 112 inline bool JfrTraceId::is_jdk_jfr_event(const Klass* k) {
 113   assert(k != NULL, "invariant");
 114   return IS_JDK_JFR_EVENT_KLASS(k);
 115 }
 116 
 117 inline void JfrTraceId::tag_as_jdk_jfr_event(const Klass* klass) {
 118   assert(klass != NULL, "invariant");
 119   SET_JDK_JFR_EVENT_KLASS(klass);
 120   assert(IS_JDK_JFR_EVENT_KLASS(klass), "invariant");
 121 }
 122 
 123 inline bool JfrTraceId::is_jdk_jfr_event_sub(const Klass* k) {
 124   assert(k != NULL, "invariant");
 125   return IS_JDK_JFR_EVENT_SUBKLASS(k);
 126 }
 127 
 128 inline void JfrTraceId::tag_as_jdk_jfr_event_sub(const Klass* k) {
 129   assert(k != NULL, "invariant");
 130   if (IS_NOT_AN_EVENT_SUB_KLASS(k)) {
 131     SET_JDK_JFR_EVENT_SUBKLASS(k);
 132   }
 133   assert(IS_JDK_JFR_EVENT_SUBKLASS(k), "invariant");
 134 }
 135 
 136 inline bool JfrTraceId::in_jdk_jfr_event_hierarchy(const Klass* klass) {
 137   assert(klass != NULL, "invariant");
 138   if (is_jdk_jfr_event(klass)) {
 139     return true;
 140   }
 141   const Klass* const super = klass->super();
 142   return super != NULL ? IS_EVENT_KLASS(super) : false;
 143 }
 144 
 145 inline bool JfrTraceId::is_event_host(const Klass* k) {
 146   assert(k != NULL, "invariant");
 147   return IS_EVENT_HOST_KLASS(k);
 148 }
 149 
 150 inline void JfrTraceId::tag_as_event_host(const Klass* k) {
 151   assert(k != NULL, "invariant");
 152   SET_EVENT_HOST_KLASS(k);
 153   assert(IS_EVENT_HOST_KLASS(k), "invariant");
 154 }
 155 
 156 #endif // SHARE_JFR_RECORDER_CHECKPOINT_TYPES_TRACEID_JFRTRACEID_INLINE_HPP