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 #ifndef SHARE_VM_JFR_CHECKPOINT_CONSTANT_TRACEID_JFRTRACEID_HPP 26 #define SHARE_VM_JFR_CHECKPOINT_CONSTANT_TRACEID_JFRTRACEID_HPP 27 28 #include "jni.h" 29 #include "classfile/classLoaderData.hpp" 30 #include "classfile/moduleEntry.hpp" 31 #include "classfile/packageEntry.hpp" 32 #include "jfr/utilities/jfrTypes.hpp" 33 #include "memory/allocation.hpp" 34 #include "oops/arrayKlass.hpp" 35 #include "oops/klass.hpp" 36 #include "oops/instanceKlass.hpp" 37 #include "oops/method.hpp" 38 39 class Thread; 40 41 /* 42 * JfrTraceId is a means of tagging, e.g. marking, specific instances as being actively in-use. 43 * The most common situation is a committed event that has a field that is referring to a specific instance. 44 * Now there exist a relation between an event (field) and an artifact of some kind. 45 * We track this relation during runtime using the JfrTraceId mechanism in order to reify it into the chunk 46 * where the event is finally written. 47 * 48 * It is the event commit mechanism that tags instances as in-use. The tag routines return the untagged traceid 49 * as a mapping key, and the commit mechanism writes the key into the event field. 50 * Consequently, the mechanism is opaque and not something a user needs to know about. 51 * Indeed, the API promotes using well-known JVM concepts directly in events, such as having a Klass* as an event field. 52 * 53 * Tagging allows for many-to-one mappings of constants, lazy evaluation / collection of tags during chunk rotation 54 * and concurrency (by using an epoch relative tagging scheme). 55 * 56 * JfrTraceId(s) have been added to support tagging instances of classes such as: 57 * 58 * Klass (includes Method) 59 * ClassLoaderData 60 * ModuleEntry 61 * PackageEntry 62 * 63 * These classes have been extended to include a _traceid field (64-bits). 64 * 65 * Each instance is uniquely identified by a type-relative monotonic counter that is unique over the VM lifecycle. 66 * "Tagging an instance" essentially means to set contextually determined (by epoch) marker bits in the _traceid field. 67 * The constants associated with a tagged instance is a set of which is determined by a constant type definition, 68 * and these constants are then serialized in an upcoming checkpoint event for the relevant chunk. 69 * 70 * Note that a "tagging" is relative to a chunk. Having serialized the tagged instance, the tag bits are reset (for that epoch). 71 * As mentioned previously, the returned traceid is always the untagged value. 72 * 73 * We also use the _traceid field in Klass to quickly identify (bit check) if a newly loaded klass is of type jdk.jfr.Event. 74 * (see jfr/instrumentation/jfrEventClassTransformer.cpp) 75 * 76 * 77 * _traceid bit layout and description planned to go here 78 * 79 * 80 */ 81 82 class JfrTraceId : public AllStatic { 83 public: 84 static void assign(const Klass* klass); 85 static void assign(const ModuleEntry* module); 86 static void assign(const PackageEntry* package); 87 static void assign(const ClassLoaderData* cld); 88 static traceid assign_thread_id(); 89 90 static traceid get(const Klass* klass); 91 static traceid get(jclass jc); 92 static traceid get(const Thread* thread); 93 94 // tag construct as used, returns pre-tagged traceid 95 static traceid use(const Klass* klass, bool leakp = false); 96 static traceid use(jclass jc, bool leakp = false); 97 static traceid use(const Method* method, bool leakp = false); 98 static traceid use(const ModuleEntry* module, bool leakp = false); 99 static traceid use(const PackageEntry* package, bool leakp = false); 100 static traceid use(const ClassLoaderData* cld, bool leakp = false); 101 102 static void remove(const Klass* klass); 103 static void restore(const Klass* klass); 104 105 // set of event classes made visible to java 106 static bool in_visible_set(const Klass* k); 107 static bool in_visible_set(const jclass jc); 108 109 // jdk.jfr.Event 110 static bool is_jdk_jfr_event(const Klass* k); 111 static bool is_jdk_jfr_event(const jclass jc); 112 static void tag_as_jdk_jfr_event(const Klass* k); 113 114 // jdk.jfr.Event subklasses 115 static bool is_jdk_jfr_event_sub(const Klass* k); 116 static bool is_jdk_jfr_event_sub(const jclass jc); 117 static void tag_as_jdk_jfr_event_sub(const Klass* k); 118 static void tag_as_jdk_jfr_event_sub(const jclass jc); 119 120 static bool in_jdk_jfr_event_hierarchy(const Klass* k); 121 static bool in_jdk_jfr_event_hierarchy(const jclass jc); 122 123 // klasses that host an event 124 static bool is_event_host(const Klass* k); 125 static bool is_event_host(const jclass jc); 126 static void tag_as_event_host(const Klass* k); 127 static void tag_as_event_host(const jclass jc); 128 }; 129 130 #endif // SHARE_VM_JFR_CHECKPOINT_CONSTANT_TRACEID_JFRTRACEID_HPP