1 /*
2 * Copyright (c) 2003, 2025, 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 "classfile/classLoaderDataGraph.hpp"
26 #include "classfile/dictionary.hpp"
27 #include "classfile/javaClasses.hpp"
28 #include "gc/shared/collectedHeap.hpp"
29 #include "memory/universe.hpp"
30 #include "oops/inlineKlass.hpp"
31 #include "oops/klass.inline.hpp"
32 #include "prims/jvmtiGetLoadedClasses.hpp"
33 #include "runtime/handles.inline.hpp"
34 #include "runtime/javaThread.hpp"
35 #include "runtime/jniHandles.inline.hpp"
36 #include "utilities/stack.inline.hpp"
37
38 // The closure for GetLoadedClasses
39 class LoadedClassesClosure : public KlassClosure {
40 private:
41 Stack<jclass, mtInternal> _classStack;
42 JvmtiEnv* _env;
43 Thread* _cur_thread;
44 bool _dictionary_walk;
45
46 int extract(jclass* result_list) {
47 // The size of the Stack will be 0 after extract, so get it here
48 int count = (int)_classStack.size();
49 int i = count;
50
51 // Pop all jclasses, fill backwards
52 while (!_classStack.is_empty()) {
53 result_list[--i] = _classStack.pop();
54 }
55
56 // Return the number of elements written
57 return count;
58 }
59
60 // Return current size of the Stack
61 int get_count() const {
62 return (int)_classStack.size();
63 }
64
65 // Some klasses should not be reported by GetLoadedClasses/GetClassLoaderClasses
66 bool exclude_klass(Klass* k) const {
67 // Direct instances of ObjArrayKlass represent the Java types that Java code can see.
68 // RefArrayKlass/FlatArrayKlass describe different implementations of the arrays, filter them out.
69 if (k->is_objArray_klass() && k->kind() != Klass::KlassKind::ObjArrayKlassKind) {
70 return true;
71 }
72 return false;
73 }
74
75 public:
76 LoadedClassesClosure(JvmtiEnv* env, bool dictionary_walk) :
77 _env(env),
78 _cur_thread(Thread::current()),
79 _dictionary_walk(dictionary_walk) {
80 }
81
82 void do_klass(Klass* k) {
83 // Collect all jclasses
84 if (!exclude_klass(k)) {
85 _classStack.push((jclass)_env->jni_reference(Handle(_cur_thread, k->java_mirror())));
86 }
87 if (_dictionary_walk) {
88 // Collect array classes this way when walking the dictionary (because array classes are
89 // not in the dictionary).
90 for (Klass* l = k->array_klass_or_null(); l != nullptr; l = l->array_klass_or_null()) {
91 if (!exclude_klass(l)) {
92 _classStack.push((jclass)_env->jni_reference(Handle(_cur_thread, l->java_mirror())));
93 }
94 }
95 }
96 }
97
98 jvmtiError get_result(JvmtiEnv *env, jint* classCountPtr, jclass** classesPtr) {
99 // Return results by extracting the collected contents into a list
100 // allocated via JvmtiEnv
101 jclass* result_list;
102 jvmtiError error = env->Allocate(get_count() * sizeof(jclass),
103 (unsigned char**)&result_list);
104
105 if (error == JVMTI_ERROR_NONE) {
106 int count = extract(result_list);
107 *classCountPtr = count;
108 *classesPtr = result_list;
109 }
110 return error;
111 }
112 };
113
114 jvmtiError
115 JvmtiGetLoadedClasses::getLoadedClasses(JvmtiEnv *env, jint* classCountPtr, jclass** classesPtr) {
116
117 LoadedClassesClosure closure(env, false);
118 {
119 // Iterate through all classes in ClassLoaderDataGraph
120 // and collect them using the LoadedClassesClosure
121 MutexLocker mcld(ClassLoaderDataGraph_lock);
122 ClassLoaderDataGraph::loaded_classes_do_keepalive(&closure);
123 }
124
125 return closure.get_result(env, classCountPtr, classesPtr);
126 }
127
128 jvmtiError
129 JvmtiGetLoadedClasses::getClassLoaderClasses(JvmtiEnv *env, jobject initiatingLoader,
130 jint* classCountPtr, jclass** classesPtr) {
131
132 LoadedClassesClosure closure(env, true);
133 {
134 // To get a consistent list of classes we need MultiArray_lock to ensure
135 // array classes aren't created by another thread during this walk. This walks through the
136 // InstanceKlass::_array_klasses links.
137 RecursiveLocker ma(MultiArray_lock, Thread::current());
138 MutexLocker sd(SystemDictionary_lock);
139 oop loader = JNIHandles::resolve(initiatingLoader);
140 // All classes loaded from this loader as initiating loader are
141 // requested, so only need to walk this loader's ClassLoaderData
142 // dictionary, or the null ClassLoaderData dictionary for bootstrap loader.
143 if (loader != nullptr) {
144 ClassLoaderData* data = java_lang_ClassLoader::loader_data_acquire(loader);
145 // ClassLoader may not be used yet for loading.
146 if (data != nullptr && data->dictionary() != nullptr) {
147 data->dictionary()->all_entries_do(&closure);
148 }
149 } else {
150 ClassLoaderData::the_null_class_loader_data()->dictionary()->all_entries_do(&closure);
151 }
152 // Get basic arrays for all loaders.
153 Universe::basic_type_classes_do(&closure);
154 }
155
156 return closure.get_result(env, classCountPtr, classesPtr);
157 }