1 /*
  2  * Copyright (c) 2014, 2021, 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_CLASSLOADEREXT_HPP
 26 #define SHARE_CLASSFILE_CLASSLOADEREXT_HPP
 27 
 28 #include "classfile/classLoader.hpp"
 29 #include "classfile/moduleEntry.hpp"
 30 #include "utilities/macros.hpp"
 31 
 32 class ClassListParser;
 33 
 34 class ClassLoaderExt: public ClassLoader { // AllStatic
 35 public:
 36   static bool should_verify(int classpath_index) {
 37     CDS_ONLY(return (classpath_index >= _app_class_paths_start_index);)
 38     NOT_CDS(return false;)
 39   }
 40 
 41 #if INCLUDE_CDS
 42 private:
 43   enum SomeConstants {
 44     max_classpath_index = 0x7fff
 45   };
 46 
 47   static char* get_class_path_attr(const char* jar_path, char* manifest, jint manifest_size);
 48   static void setup_app_search_path(JavaThread* current); // Only when -Xshare:dump
 49   static void process_module_table(JavaThread* current, ModuleEntryTable* met);
 50   // index of first app JAR in shared classpath entry table
 51   static jshort _app_class_paths_start_index;
 52   // index of first modular JAR in shared modulepath entry table
 53   static jshort _app_module_paths_start_index;
 54   // the largest path index being used during CDS dump time
 55   static jshort _max_used_path_index;
 56   // number of module paths
 57   static int _num_module_paths;
 58 
 59   static bool _has_app_classes;
 60   static bool _has_platform_classes;
 61   static bool _has_non_jar_in_classpath;
 62 
 63   static char* read_manifest(JavaThread* current, ClassPathEntry* entry, jint *manifest_size, bool clean_text);
 64   static bool has_jar_suffix(const char* filename);
 65 
 66 public:
 67   static void process_jar_manifest(JavaThread* current, ClassPathEntry* entry);
 68 
 69   // Called by JVMTI code to add boot classpath
 70   static void append_boot_classpath(ClassPathEntry* new_entry);
 71 
 72   static void setup_search_paths(JavaThread* current);
 73   static void setup_module_paths(JavaThread* current);
 74   static void extract_jar_files_from_path(const char* path, GrowableArray<const char*>* module_paths);
 75   static int compare_module_path_by_name(const char** p1, const char** p2);
 76 
 77   static char* read_manifest(JavaThread* current, ClassPathEntry* entry, jint *manifest_size) {
 78     // Remove all the new-line continuations (which wrap long lines at 72 characters, see
 79     // http://docs.oracle.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Manifest), so
 80     // that the manifest is easier to parse.
 81     return read_manifest(current, entry, manifest_size, true);
 82   }
 83   static char* read_raw_manifest(JavaThread* current, ClassPathEntry* entry, jint *manifest_size) {
 84     // Do not remove new-line continuations, so we can easily pass it as an argument to
 85     // java.util.jar.Manifest.getManifest() at run-time.
 86     return read_manifest(current, entry, manifest_size, false);
 87   }
 88 
 89   static jshort app_class_paths_start_index() { return _app_class_paths_start_index; }
 90 
 91   static jshort app_module_paths_start_index() { return _app_module_paths_start_index; }
 92 
 93   static jshort max_used_path_index() { return _max_used_path_index; }
 94 
 95   static int num_module_paths() { return _num_module_paths; }
 96 
 97   static void set_max_used_path_index(jshort used_index) {
 98     _max_used_path_index = used_index;
 99   }
100 
101   static void init_paths_start_index(jshort app_start) {
102     _app_class_paths_start_index = app_start;
103   }
104 
105   static void init_app_module_paths_start_index(jshort module_start) {
106     _app_module_paths_start_index = module_start;
107   }
108 
109   static void init_num_module_paths(int num_module_paths) {
110     _num_module_paths = num_module_paths;
111   }
112 
113   static bool is_boot_classpath(int classpath_index) {
114     return classpath_index < _app_class_paths_start_index;
115   }
116 
117   static bool has_platform_or_app_classes() {
118     return _has_app_classes || _has_platform_classes;
119   }
120 
121   static bool has_non_jar_in_classpath() {
122     return _has_non_jar_in_classpath;
123   }
124 
125   static void record_result(const s2 classpath_index, InstanceKlass* result, bool redefined);
126   static void set_has_app_classes() {
127     _has_app_classes = true;
128   }
129   static void set_has_platform_classes() {
130     _has_platform_classes = true;
131   }
132   static void set_has_non_jar_in_classpath() {
133     _has_non_jar_in_classpath = true;
134   }
135 #endif // INCLUDE_CDS
136 };
137 
138 #endif // SHARE_CLASSFILE_CLASSLOADEREXT_HPP