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