1 /*
2 * Copyright (c) 2022, 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/classLoaderData.hpp"
26 #include "classfile/classLoaderDataGraph.hpp"
27 #include "classfile/classPrinter.hpp"
28 #include "memory/iterator.hpp"
29 #include "memory/resourceArea.hpp"
30 #include "oops/instanceKlass.hpp"
31 #include "oops/klass.inline.hpp"
32 #include "oops/method.hpp"
33 #include "oops/symbol.hpp"
34 #include "utilities/ostream.hpp"
35
36 class ClassPrinter::KlassPrintClosure : public LockedClassesDo {
37 const char* _class_name_pattern;
38 const char* _method_name_pattern;
39 const char* _method_signature_pattern;
40 bool _always_print_class_name;
41 int _flags;
42 outputStream* _st;
43 int _num;
44 bool _has_printed_methods;
45 public:
46 KlassPrintClosure(const char* class_name_pattern,
47 const char* method_name_pattern,
48 const char* method_signature_pattern,
49 bool always_print_class_name,
50 int flags, outputStream* st)
51 : _class_name_pattern(class_name_pattern),
52 _method_name_pattern(method_name_pattern),
53 _method_signature_pattern(method_signature_pattern),
54 _always_print_class_name(always_print_class_name),
55 _flags(flags), _st(st), _num(0), _has_printed_methods(false)
56 {
57 _flags |= (PRINT_PROFILE);
58 if (has_mode(_flags, PRINT_METHOD_HANDLE)) {
59 _flags |= (PRINT_METHOD_NAME | PRINT_BYTECODE);
60 }
61 if (has_mode(_flags, PRINT_DYNAMIC)) {
62 _flags |= (PRINT_METHOD_NAME | PRINT_BYTECODE);
63 }
64 if (has_mode(_flags, PRINT_BYTECODE_ADDR)) {
65 _flags |= (PRINT_METHOD_NAME | PRINT_BYTECODE);
66 }
67 if (has_mode(_flags, PRINT_BYTECODE)) {
68 _flags |= (PRINT_METHOD_NAME);
69 }
70 }
71
72 virtual void do_klass(Klass* k) {
73 if (!k->is_instance_klass()) {
74 return;
75 }
76 print_instance_klass(InstanceKlass::cast(k));
77 }
78
79 static bool match(const char* pattern, Symbol* sym) {
80 return (pattern == nullptr || sym->is_star_match(pattern));
81 }
82
83 void print_klass_name(InstanceKlass* ik) {
84 _st->print("[%3d] " INTPTR_FORMAT " class %s mirror: " INTPTR_FORMAT " ", _num++,
85 p2i(ik), ik->name()->as_C_string(), p2i(ik->java_mirror()));
86 ik->class_loader_data()->print_value_on(_st);
87 _st->cr();
88 }
89
90 void print_instance_klass(InstanceKlass* ik) {
91 if (ik->is_loaded() && ik->name()->is_star_match(_class_name_pattern)) {
92 ResourceMark rm;
93 if (_has_printed_methods) {
94 // We have printed some methods in the previous class.
95 // Print a new line to separate the two classes
96 _st->cr();
97 }
98 _has_printed_methods = false;
99 if (_always_print_class_name) {
100 print_klass_name(ik);
101 }
102
103 if (has_mode(_flags, ClassPrinter::PRINT_METHOD_NAME)) {
104 bool print_codes = has_mode(_flags, ClassPrinter::PRINT_BYTECODE);
105 int len = ik->methods()->length();
106 int num_methods_printed = 0;
107
108 for (int index = 0; index < len; index++) {
109 Method* m = ik->methods()->at(index);
110 if (match(_method_name_pattern, m->name()) &&
111 match(_method_signature_pattern, m->signature())) {
112 if (print_codes && num_methods_printed++ > 0) {
113 _st->cr();
114 }
115
116 if (_has_printed_methods == false) {
117 if (!_always_print_class_name) {
118 print_klass_name(ik);
119 }
120 _has_printed_methods = true;
121 }
122 print_method(m);
123 }
124 }
125 }
126 }
127 }
128
129 void print_method(Method* m) {
130 bool print_codes = has_mode(_flags, ClassPrinter::PRINT_BYTECODE);
131 _st->print_cr(INTPTR_FORMAT " %smethod %s : %s", p2i(m),
132 m->is_static() ? "static " : "",
133 m->name()->as_C_string(), m->signature()->as_C_string());
134 if (print_codes) {
135 m->print_codes_on(_st, _flags);
136 }
137 }
138 };
139
140 void ClassPrinter::print_flags_help(outputStream* os) {
141 os->print_cr("flags (bitmask):");
142 os->print_cr(" 0x%02x - print names of methods", PRINT_METHOD_NAME);
143 os->print_cr(" 0x%02x - print bytecodes", PRINT_BYTECODE);
144 os->print_cr(" 0x%02x - print the address of bytecodes", PRINT_BYTECODE_ADDR);
145 os->print_cr(" 0x%02x - print info for invokedynamic", PRINT_DYNAMIC);
146 os->print_cr(" 0x%02x - print info for invokehandle", PRINT_METHOD_HANDLE);
147 os->cr();
148 }
149
150 void ClassPrinter::print_classes(const char* class_name_pattern, int flags, outputStream* os) {
151 KlassPrintClosure closure(class_name_pattern, nullptr, nullptr, true, flags, os);
152 ClassLoaderDataGraph::classes_do(&closure);
153 }
154
155 void ClassPrinter::print_methods(const char* class_name_pattern,
156 const char* method_pattern, int flags, outputStream* os) {
157 ResourceMark rm;
158 const char* method_name_pattern;
159 const char* method_signature_pattern;
160
161 const char* colon = strchr(method_pattern, ':');
162 if (colon == nullptr) {
163 method_name_pattern = method_pattern;
164 method_signature_pattern = nullptr;
165 } else {
166 ptrdiff_t name_pat_len = colon - method_pattern;
167 assert(name_pat_len >= 0, "sanity");
168 char* buf = NEW_RESOURCE_ARRAY(char, name_pat_len + 1);
169 strncpy(buf, method_pattern, name_pat_len);
170 buf[name_pat_len] = 0;
171
172 method_name_pattern = buf;
173 method_signature_pattern = colon + 1;
174 }
175
176 KlassPrintClosure closure(class_name_pattern, method_name_pattern, method_signature_pattern,
177 false, flags | PRINT_METHOD_NAME, os);
178 ClassLoaderDataGraph::classes_do(&closure);
179 }