1 /*
2 * Copyright (c) 1997, 2024, 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_CLASSFILE_CLASSLOADER_HPP
26 #define SHARE_CLASSFILE_CLASSLOADER_HPP
27
28 #include "jimage.hpp"
29 #include "runtime/handles.hpp"
30 #include "runtime/perfDataTypes.hpp"
31 #include "utilities/exceptions.hpp"
32 #include "utilities/macros.hpp"
33 #include "utilities/ostream.hpp"
34 #include "utilities/zipLibrary.hpp"
35
36 // The VM class loader.
37 #include <sys/stat.h>
38
39 // Name of boot "modules" image
40 #define MODULES_IMAGE_NAME "modules"
41
42 // Class path entry (directory or zip file)
43
44 class JImageFile;
45 class ClassFileStream;
46 class PackageEntry;
47 template <typename T> class GrowableArray;
48
49 class ClassPathEntry : public CHeapObj<mtClass> {
50 private:
51 ClassPathEntry* volatile _next;
52 protected:
53 const char* copy_path(const char*path);
54 public:
55 ClassPathEntry* next() const;
56 virtual ~ClassPathEntry() {}
57 void set_next(ClassPathEntry* next);
58
59 virtual bool is_modules_image() const { return false; }
60 virtual bool is_jar_file() const { return false; }
61 // Is this entry created from the "Class-path" attribute from a JAR Manifest?
62 virtual bool from_class_path_attr() const { return false; }
63 virtual const char* name() const = 0;
64 virtual JImageFile* jimage() const { return nullptr; }
65 virtual void close_jimage() {}
66 // Constructor
67 ClassPathEntry() : _next(nullptr) {}
68 // Attempt to locate file_name through this class path entry.
69 // Returns a class file parsing stream if successful.
70 virtual ClassFileStream* open_stream(JavaThread* current, const char* name) = 0;
71 // Open the stream for a specific class loader
72 virtual ClassFileStream* open_stream_for_loader(JavaThread* current, const char* name, ClassLoaderData* loader_data) {
73 return open_stream(current, name);
74 }
75 };
76
77 class ClassPathDirEntry: public ClassPathEntry {
78 private:
79 const char* _dir; // Name of directory
80 public:
81 const char* name() const { return _dir; }
82 ClassPathDirEntry(const char* dir) {
83 _dir = copy_path(dir);
84 }
85 virtual ~ClassPathDirEntry();
86 ClassFileStream* open_stream(JavaThread* current, const char* name);
87 };
88
89 class ClassPathZipEntry: public ClassPathEntry {
90 private:
91 jzfile* _zip; // The zip archive
92 const char* _zip_name; // Name of zip archive
93 bool _from_class_path_attr; // From the "Class-path" attribute of a jar file
94 public:
95 bool is_jar_file() const { return true; }
96 bool from_class_path_attr() const { return _from_class_path_attr; }
97 const char* name() const { return _zip_name; }
98 ClassPathZipEntry(jzfile* zip, const char* zip_name, bool is_boot_append, bool from_class_path_attr);
99 virtual ~ClassPathZipEntry();
100 u1* open_entry(JavaThread* current, const char* name, jint* filesize, bool nul_terminate);
101 ClassFileStream* open_stream(JavaThread* current, const char* name);
102 };
103
104
105 // For java image files
106 class ClassPathImageEntry: public ClassPathEntry {
107 private:
108 const char* _name;
109 DEBUG_ONLY(static ClassPathImageEntry* _singleton;)
110 public:
111 bool is_modules_image() const;
112 const char* name() const { return _name == nullptr ? "" : _name; }
113 JImageFile* jimage() const;
114 JImageFile* jimage_non_null() const;
115 void close_jimage();
116 ClassPathImageEntry(JImageFile* jimage, const char* name);
117 virtual ~ClassPathImageEntry() { ShouldNotReachHere(); }
118 ClassFileStream* open_stream(JavaThread* current, const char* name);
119 ClassFileStream* open_stream_for_loader(JavaThread* current, const char* name, ClassLoaderData* loader_data);
120 };
121
122 // ModuleClassPathList contains a linked list of ClassPathEntry's
123 // that have been specified for a specific module. Currently,
124 // the only way to specify a module/path pair is via the --patch-module
125 // command line option.
126 class ModuleClassPathList : public CHeapObj<mtClass> {
127 private:
128 Symbol* _module_name;
129 // First and last entries of class path entries for a specific module
130 ClassPathEntry* _module_first_entry;
131 ClassPathEntry* _module_last_entry;
132 public:
133 Symbol* module_name() const { return _module_name; }
134 ClassPathEntry* module_first_entry() const { return _module_first_entry; }
135 ModuleClassPathList(Symbol* module_name);
136 ~ModuleClassPathList();
137 void add_to_list(ClassPathEntry* new_entry);
138 };
139
140 class ClassLoader: AllStatic {
141 public:
142 enum ClassLoaderType {
143 OTHER = 0,
144 BOOT_LOADER = 1, /* boot loader */
145 PLATFORM_LOADER = 2, /* PlatformClassLoader */
146 APP_LOADER = 3 /* AppClassLoader */
147 };
148 protected:
149
150 // Performance counters
151 static PerfCounter* _perf_accumulated_time;
152 static PerfCounter* _perf_classes_inited;
153 static PerfCounter* _perf_class_init_time;
154 static PerfCounter* _perf_class_init_selftime;
155 static PerfCounter* _perf_classes_verified;
156 static PerfCounter* _perf_class_verify_time;
157 static PerfCounter* _perf_class_verify_selftime;
158 static PerfCounter* _perf_classes_linked;
159 static PerfCounter* _perf_class_link_time;
160 static PerfCounter* _perf_class_link_selftime;
161 static PerfCounter* _perf_shared_classload_time;
162 static PerfCounter* _perf_sys_classload_time;
163 static PerfCounter* _perf_app_classload_time;
164 static PerfCounter* _perf_app_classload_selftime;
165 static PerfCounter* _perf_app_classload_count;
166 static PerfCounter* _perf_define_appclasses;
167 static PerfCounter* _perf_define_appclass_time;
168 static PerfCounter* _perf_define_appclass_selftime;
169 static PerfCounter* _perf_app_classfile_bytes_read;
170 static PerfCounter* _perf_sys_classfile_bytes_read;
171 static PerfCounter* _perf_ik_link_methods_time;
172 static PerfCounter* _perf_method_adapters_time;
173 static PerfCounter* _perf_ik_link_methods_count;
174 static PerfCounter* _perf_method_adapters_count;
175
176 static PerfCounter* _perf_resolve_indy_time;
177 static PerfCounter* _perf_resolve_invokehandle_time;
178 static PerfCounter* _perf_resolve_mh_time;
179 static PerfCounter* _perf_resolve_mt_time;
180
181 static PerfCounter* _perf_resolve_indy_count;
182 static PerfCounter* _perf_resolve_invokehandle_count;
183 static PerfCounter* _perf_resolve_mh_count;
184 static PerfCounter* _perf_resolve_mt_count;
185
186 static PerfCounter* _unsafe_defineClassCallCounter;
187
188 // Count the time taken to hash the scondary superclass arrays.
189 static PerfCounter* _perf_secondary_hash_time;
190
191 // The boot class path consists of 3 ordered pieces:
192 // 1. the module/path pairs specified to --patch-module
193 // --patch-module=<module>=<file>(<pathsep><file>)*
194 // 2. the base piece
195 // [jimage | build with exploded modules]
196 // 3. boot loader append path
197 // [-Xbootclasspath/a]; [jvmti appended entries]
198 //
199 // The boot loader must obey this order when attempting
200 // to load a class.
201
202 // 1. Contains the module/path pairs specified to --patch-module
203 static GrowableArray<ModuleClassPathList*>* _patch_mod_entries;
204
205 // 2. the base piece
206 // Contains the ClassPathEntry of the modular java runtime image.
207 // If no java runtime image is present, this indicates a
208 // build with exploded modules is being used instead.
209 static ClassPathEntry* _jrt_entry;
210 static GrowableArray<ModuleClassPathList*>* _exploded_entries;
211 enum { EXPLODED_ENTRY_SIZE = 80 }; // Initial number of exploded modules
212
213 // 3. the boot loader's append path
214 // [-Xbootclasspath/a]; [jvmti appended entries]
215 // Note: boot loader append path does not support named modules.
216 static ClassPathEntry* volatile _first_append_entry_list;
217 static ClassPathEntry* first_append_entry() {
218 return Atomic::load_acquire(&_first_append_entry_list);
219 }
220
221 // Last entry in linked list of appended ClassPathEntry instances
222 static ClassPathEntry* volatile _last_append_entry;
223
224 // Info used by CDS
225 CDS_ONLY(static ClassPathEntry* _app_classpath_entries;)
226 CDS_ONLY(static ClassPathEntry* _last_app_classpath_entry;)
227 CDS_ONLY(static ClassPathEntry* _module_path_entries;)
228 CDS_ONLY(static ClassPathEntry* _last_module_path_entry;)
229 CDS_ONLY(static void setup_app_search_path(JavaThread* current, const char* class_path);)
230 CDS_ONLY(static void setup_module_search_path(JavaThread* current, const char* path);)
231 static bool add_to_app_classpath_entries(JavaThread* current,
232 ClassPathEntry* entry,
233 bool check_for_duplicates);
234 CDS_ONLY(static void add_to_module_path_entries(const char* path,
235 ClassPathEntry* entry);)
236
237 public:
238 CDS_ONLY(static ClassPathEntry* app_classpath_entries() {return _app_classpath_entries;})
239 CDS_ONLY(static ClassPathEntry* module_path_entries() {return _module_path_entries;})
240
241 static bool has_bootclasspath_append() { return first_append_entry() != nullptr; }
242
243 protected:
244 // Initialization:
245 // - setup the boot loader's system class path
246 // - setup the boot loader's patch mod entries, if present
247 // - create the ModuleEntry for java.base
248 static void setup_bootstrap_search_path(JavaThread* current);
249 static void setup_bootstrap_search_path_impl(JavaThread* current, const char *class_path);
250 static void setup_patch_mod_entries();
251 static void create_javabase();
252
253 static void* dll_lookup(void* lib, const char* name, const char* path);
254 static void load_java_library();
255 static void load_jimage_library();
256
257 public:
258 static void* zip_library_handle();
259 static jzfile* open_zip_file(const char* canonical_path, char** error_msg, JavaThread* thread);
260 static ClassPathEntry* create_class_path_entry(JavaThread* current,
261 const char *path, const struct stat* st,
262 bool is_boot_append,
263 bool from_class_path_attr);
264
265 // Canonicalizes path names, so strcmp will work properly. This is mainly
266 // to avoid confusing the zip library
267 static char* get_canonical_path(const char* orig, Thread* thread);
268 static const char* file_name_for_class_name(const char* class_name,
269 int class_name_len);
270 static PackageEntry* get_package_entry(Symbol* pkg_name, ClassLoaderData* loader_data);
271 static int crc32(int crc, const char* buf, int len);
272 static bool update_class_path_entry_list(JavaThread* current,
273 const char *path,
274 bool check_for_duplicates,
275 bool is_boot_append,
276 bool from_class_path_attr);
277 static void print_bootclasspath();
278
279 // Timing
280 static PerfCounter* perf_accumulated_time() { return _perf_accumulated_time; }
281 static PerfCounter* perf_classes_inited() { return _perf_classes_inited; }
282 static PerfCounter* perf_class_init_time() { return _perf_class_init_time; }
283 static PerfCounter* perf_class_init_selftime() { return _perf_class_init_selftime; }
284 static PerfCounter* perf_classes_verified() { return _perf_classes_verified; }
285 static PerfCounter* perf_class_verify_time() { return _perf_class_verify_time; }
286 static PerfCounter* perf_class_verify_selftime() { return _perf_class_verify_selftime; }
287 static PerfCounter* perf_classes_linked() { return _perf_classes_linked; }
288 static PerfCounter* perf_class_link_time() { return _perf_class_link_time; }
289 static PerfCounter* perf_class_link_selftime() { return _perf_class_link_selftime; }
290 static PerfCounter* perf_shared_classload_time() { return _perf_shared_classload_time; }
291 static PerfCounter* perf_secondary_hash_time() {
292 return _perf_secondary_hash_time;
293 }
294 static PerfCounter* perf_sys_classload_time() { return _perf_sys_classload_time; }
295 static PerfCounter* perf_app_classload_time() { return _perf_app_classload_time; }
296 static PerfCounter* perf_app_classload_selftime() { return _perf_app_classload_selftime; }
297 static PerfCounter* perf_app_classload_count() { return _perf_app_classload_count; }
298 static PerfCounter* perf_define_appclasses() { return _perf_define_appclasses; }
299 static PerfCounter* perf_define_appclass_time() { return _perf_define_appclass_time; }
300 static PerfCounter* perf_define_appclass_selftime() { return _perf_define_appclass_selftime; }
301 static PerfCounter* perf_app_classfile_bytes_read() { return _perf_app_classfile_bytes_read; }
302 static PerfCounter* perf_sys_classfile_bytes_read() { return _perf_sys_classfile_bytes_read; }
303
304 static PerfCounter* perf_ik_link_methods_time() { return _perf_ik_link_methods_time; }
305 static PerfCounter* perf_method_adapters_time() { return _perf_method_adapters_time; }
306 static PerfCounter* perf_ik_link_methods_count() { return _perf_ik_link_methods_count; }
307 static PerfCounter* perf_method_adapters_count() { return _perf_method_adapters_count; }
308
309 static PerfCounter* perf_resolve_invokedynamic_time() { return _perf_resolve_indy_time; }
310 static PerfCounter* perf_resolve_invokehandle_time() { return _perf_resolve_invokehandle_time; }
311 static PerfCounter* perf_resolve_method_handle_time() { return _perf_resolve_mh_time; }
312 static PerfCounter* perf_resolve_method_type_time() { return _perf_resolve_mt_time; }
313
314 static PerfCounter* perf_resolve_invokedynamic_count() { return _perf_resolve_indy_count; }
315 static PerfCounter* perf_resolve_invokehandle_count() { return _perf_resolve_invokehandle_count; }
316 static PerfCounter* perf_resolve_method_handle_count() { return _perf_resolve_mh_count; }
317 static PerfCounter* perf_resolve_method_type_count() { return _perf_resolve_mt_count; }
318
319 static void print_counters(outputStream *st);
320
321 // Record how many calls to Unsafe_DefineClass
322 static PerfCounter* unsafe_defineClassCallCounter() {
323 return _unsafe_defineClassCallCounter;
324 }
325
326 // Modular java runtime image is present vs. a build with exploded modules
327 static bool has_jrt_entry() { return (_jrt_entry != nullptr); }
328 static ClassPathEntry* get_jrt_entry() { return _jrt_entry; }
329 static void close_jrt_image();
330
331 // Add a module's exploded directory to the boot loader's exploded module build list
332 static void add_to_exploded_build_list(JavaThread* current, Symbol* module_name);
333
334 // Search the module list for the class file stream based on the file name and java package
335 static ClassFileStream* search_module_entries(JavaThread* current,
336 const GrowableArray<ModuleClassPathList*>* const module_list,
337 PackageEntry* pkg_entry, // Java package entry derived from the class name
338 const char* const file_name);
339
340 // Load individual .class file
341 static InstanceKlass* load_class(Symbol* class_name, PackageEntry* pkg_entry, bool search_append_only, TRAPS);
342
343 // If the specified package has been loaded by the system, then returns
344 // the name of the directory or ZIP file that the package was loaded from.
345 // Returns null if the package was not loaded.
346 // Note: The specified name can either be the name of a class or package.
347 // If a package name is specified, then it must be "/"-separator and also
348 // end with a trailing "/".
349 static oop get_system_package(const char* name, TRAPS);
350
351 // Returns an array of Java strings representing all of the currently
352 // loaded system packages.
353 // Note: The package names returned are "/"-separated and end with a
354 // trailing "/".
355 static objArrayOop get_system_packages(TRAPS);
356
357 // Initialization
358 static void initialize(TRAPS);
359 static void classLoader_init2(JavaThread* current);
360 CDS_ONLY(static void initialize_shared_path(JavaThread* current);)
361 CDS_ONLY(static void initialize_module_path(TRAPS);)
362
363 static int compute_Object_vtable();
364
365 static ClassPathEntry* classpath_entry(int n);
366
367 static bool is_in_patch_mod_entries(Symbol* module_name);
368
369 #if INCLUDE_CDS
370 // Sharing dump and restore
371
372 // Helper function used by CDS code to get the number of boot classpath
373 // entries during shared classpath setup time.
374 static int num_boot_classpath_entries();
375
376 static ClassPathEntry* get_next_boot_classpath_entry(ClassPathEntry* e);
377
378 // Helper function used by CDS code to get the number of app classpath
379 // entries during shared classpath setup time.
380 static int num_app_classpath_entries();
381
382 // Helper function used by CDS code to get the number of module path
383 // entries during shared classpath setup time.
384 static int num_module_path_entries();
385 static void exit_with_path_failure(const char* error, const char* message);
386 static char* uri_to_path(const char* uri);
387 static void record_result(JavaThread* current, InstanceKlass* ik,
388 const ClassFileStream* stream, bool redefined);
389 static void record_hidden_class(InstanceKlass* ik);
390 #endif
391
392 static char* lookup_vm_options();
393
394 // Determines if the named module is present in the
395 // modules jimage file or in the exploded modules directory.
396 static bool is_module_observable(const char* module_name);
397
398 static JImageLocationRef jimage_find_resource(JImageFile* jf, const char* module_name,
399 const char* file_name, jlong &size);
400
401 static void trace_class_path(const char* msg, const char* name = nullptr);
402
403 // VM monitoring and management support
404 static jlong classloader_time_ms();
405 static jlong class_method_total_size();
406 static jlong class_init_count();
407 static jlong class_init_time_ms();
408 static jlong class_verify_time_ms();
409 static jlong class_link_count();
410 static jlong class_link_time_ms();
411
412 // adds a class path to the boot append entries
413 static void add_to_boot_append_entries(ClassPathEntry* new_entry);
414
415 // creates a class path zip entry (returns null if JAR file cannot be opened)
416 static ClassPathZipEntry* create_class_path_zip_entry(const char *apath, bool is_boot_append);
417
418 static bool string_ends_with(const char* str, const char* str_to_find);
419
420 // Extract package name from a fully qualified class name
421 // *bad_class_name is set to true if there's a problem with parsing class_name, to
422 // distinguish from a class_name with no package name, as both cases have a null return value
423 static Symbol* package_from_class_name(const Symbol* class_name, bool* bad_class_name = nullptr);
424
425 // Debugging
426 static void verify() PRODUCT_RETURN;
427 };
428
429 // PerfClassTraceTime is used to measure time for class loading related events.
430 // This class tracks cumulative time and exclusive time for specific event types.
431 // During the execution of one event, other event types (e.g. class loading and
432 // resolution) as well as recursive calls of the same event type could happen.
433 // Only one elapsed timer (cumulative) and one thread-local self timer (exclusive)
434 // (i.e. only one event type) are active at a time even multiple PerfClassTraceTime
435 // instances have been created as multiple events are happening.
436 class PerfClassTraceTime {
437 public:
438 enum {
439 CLASS_LOAD = 0,
440 CLASS_LINK = 1,
441 CLASS_VERIFY = 2,
442 CLASS_CLINIT = 3,
443 DEFINE_CLASS = 4,
444 EVENT_TYPE_COUNT = 5
445 };
446 protected:
447 // _t tracks time from initialization to destruction of this timer instance
448 // including time for all other event types, and recursive calls of this type.
449 // When a timer is called recursively, the elapsedTimer _t would not be used.
450 elapsedTimer _t;
451 PerfLongCounter* _timep;
452 PerfLongCounter* _selftimep;
453 PerfLongCounter* _eventp;
454 // pointer to thread-local recursion counter and timer array
455 // The thread_local timers track cumulative time for specific event types
456 // exclusive of time for other event types, but including recursive calls
457 // of the same type.
458 int* _recursion_counters;
459 elapsedTimer* _timers;
460 int _event_type;
461 int _prev_active_event;
462
463 public:
464
465 inline PerfClassTraceTime(PerfLongCounter* timep, /* counter incremented with inclusive time */
466 PerfLongCounter* selftimep, /* counter incremented with exclusive time */
467 PerfLongCounter* eventp, /* event counter */
468 int* recursion_counters, /* thread-local recursion counter array */
469 elapsedTimer* timers, /* thread-local timer array */
470 int type /* event type */ ) :
471 _timep(timep), _selftimep(selftimep), _eventp(eventp), _recursion_counters(recursion_counters), _timers(timers), _event_type(type) {
472 initialize();
473 }
474
475 inline PerfClassTraceTime(PerfLongCounter* timep, /* counter incremented with inclusive time */
476 elapsedTimer* timers, /* thread-local timer array */
477 int type /* event type */ ) :
478 _timep(timep), _selftimep(nullptr), _eventp(nullptr), _recursion_counters(nullptr), _timers(timers), _event_type(type) {
479 initialize();
480 }
481
482 ~PerfClassTraceTime();
483 void initialize();
484 };
485
486 #endif // SHARE_CLASSFILE_CLASSLOADER_HPP