1 /*
   2  * Copyright (c) 2015, 2019, 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 "precompiled.hpp"
  26 #include "classfile/classFileParser.hpp"
  27 #include "classfile/classFileStream.hpp"
  28 #include "classfile/classLoader.inline.hpp"
  29 #include "classfile/classLoaderExt.hpp"
  30 #include "classfile/classLoaderData.inline.hpp"
  31 #include "classfile/klassFactory.hpp"
  32 #include "classfile/modules.hpp"
  33 #include "classfile/sharedPathsMiscInfo.hpp"
  34 #include "classfile/systemDictionaryShared.hpp"
  35 #include "classfile/vmSymbols.hpp"
  36 #include "memory/allocation.inline.hpp"
  37 #include "memory/filemap.hpp"
  38 #include "memory/resourceArea.hpp"
  39 #include "oops/instanceKlass.hpp"
  40 #include "oops/oop.inline.hpp"
  41 #include "oops/symbol.hpp"
  42 #include "runtime/arguments.hpp"
  43 #include "runtime/handles.inline.hpp"
  44 #include "runtime/java.hpp"
  45 #include "runtime/javaCalls.hpp"
  46 #include "runtime/os.hpp"
  47 #include "services/threadService.hpp"
  48 #include "utilities/stringUtils.hpp"
  49 
  50 jshort ClassLoaderExt::_app_class_paths_start_index = ClassLoaderExt::max_classpath_index;
  51 jshort ClassLoaderExt::_app_module_paths_start_index = ClassLoaderExt::max_classpath_index;
  52 jshort ClassLoaderExt::_max_used_path_index = 0;
  53 bool ClassLoaderExt::_has_app_classes = false;
  54 bool ClassLoaderExt::_has_platform_classes = false;
  55 
  56 void ClassLoaderExt::append_boot_classpath(ClassPathEntry* new_entry) {
  57   if (UseSharedSpaces) {
  58     warning("Sharing is only supported for boot loader classes because bootstrap classpath has been appended");
  59     FileMapInfo::current_info()->header()->set_has_platform_or_app_classes(false);
  60   }
  61   ClassLoader::add_to_boot_append_entries(new_entry);
  62 }
  63 
  64 void ClassLoaderExt::setup_app_search_path() {
  65   assert(DumpSharedSpaces, "this function is only used with -Xshare:dump");
  66   _app_class_paths_start_index = ClassLoader::num_boot_classpath_entries();
  67   char* app_class_path = os::strdup(Arguments::get_appclasspath());
  68 
  69   if (strcmp(app_class_path, ".") == 0) {
  70     // This doesn't make any sense, even for AppCDS, so let's skip it. We
  71     // don't want to throw an error here because -cp "." is usually assigned
  72     // by the launcher when classpath is not specified.
  73     trace_class_path("app loader class path (skipped)=", app_class_path);
  74   } else {
  75     trace_class_path("app loader class path=", app_class_path);
  76     shared_paths_misc_info()->add_app_classpath(app_class_path);
  77     ClassLoader::setup_app_search_path(app_class_path);
  78   }
  79 }
  80 
  81 void ClassLoaderExt::process_module_table(ModuleEntryTable* met, TRAPS) {
  82   ResourceMark rm(THREAD);
  83   for (int i = 0; i < met->table_size(); i++) {
  84     for (ModuleEntry* m = met->bucket(i); m != NULL;) {
  85       char* path = m->location()->as_C_string();
  86       if (strncmp(path, "file:", 5) == 0) {
  87         path = ClassLoader::skip_uri_protocol(path);
  88         ClassLoader::setup_module_search_path(path, THREAD);
  89       }
  90       m = m->next();
  91     }
  92   }
  93 }
  94 void ClassLoaderExt::setup_module_paths(TRAPS) {
  95   assert(DumpSharedSpaces, "this function is only used with -Xshare:dump");
  96   _app_module_paths_start_index = ClassLoader::num_boot_classpath_entries() +
  97                               ClassLoader::num_app_classpath_entries();
  98   Handle system_class_loader (THREAD, SystemDictionary::java_system_loader());
  99   ModuleEntryTable* met = Modules::get_module_entry_table(system_class_loader);
 100   process_module_table(met, THREAD);
 101 }
 102 
 103 char* ClassLoaderExt::read_manifest(ClassPathEntry* entry, jint *manifest_size, bool clean_text, TRAPS) {
 104   const char* name = "META-INF/MANIFEST.MF";
 105   char* manifest;
 106   jint size;
 107 
 108   assert(entry->is_jar_file(), "must be");
 109   manifest = (char*) ((ClassPathZipEntry*)entry )->open_entry(name, &size, true, CHECK_NULL);
 110 
 111   if (manifest == NULL) { // No Manifest
 112     *manifest_size = 0;
 113     return NULL;
 114   }
 115 
 116 
 117   if (clean_text) {
 118     // See http://docs.oracle.com/javase/6/docs/technotes/guides/jar/jar.html#JAR%20Manifest
 119     // (1): replace all CR/LF and CR with LF
 120     StringUtils::replace_no_expand(manifest, "\r\n", "\n");
 121 
 122     // (2) remove all new-line continuation (remove all "\n " substrings)
 123     StringUtils::replace_no_expand(manifest, "\n ", "");
 124   }
 125 
 126   *manifest_size = (jint)strlen(manifest);
 127   return manifest;
 128 }
 129 
 130 char* ClassLoaderExt::get_class_path_attr(const char* jar_path, char* manifest, jint manifest_size) {
 131   const char* tag = "Class-Path: ";
 132   const int tag_len = (int)strlen(tag);
 133   char* found = NULL;
 134   char* line_start = manifest;
 135   char* end = manifest + manifest_size;
 136 
 137   assert(*end == 0, "must be nul-terminated");
 138 
 139   while (line_start < end) {
 140     char* line_end = strchr(line_start, '\n');
 141     if (line_end == NULL) {
 142       // JAR spec require the manifest file to be terminated by a new line.
 143       break;
 144     }
 145     if (strncmp(tag, line_start, tag_len) == 0) {
 146       if (found != NULL) {
 147         // Same behavior as jdk/src/share/classes/java/util/jar/Attributes.java
 148         // If duplicated entries are found, the last one is used.
 149         tty->print_cr("Warning: Duplicate name in Manifest: %s.\n"
 150                       "Ensure that the manifest does not have duplicate entries, and\n"
 151                       "that blank lines separate individual sections in both your\n"
 152                       "manifest and in the META-INF/MANIFEST.MF entry in the jar file:\n%s\n", tag, jar_path);
 153       }
 154       found = line_start + tag_len;
 155       assert(found <= line_end, "sanity");
 156       *line_end = '\0';
 157     }
 158     line_start = line_end + 1;
 159   }
 160   return found;
 161 }
 162 
 163 void ClassLoaderExt::process_jar_manifest(ClassPathEntry* entry,
 164                                           bool check_for_duplicates) {
 165   Thread* THREAD = Thread::current();
 166   ResourceMark rm(THREAD);
 167   jint manifest_size;
 168   char* manifest = read_manifest(entry, &manifest_size, CHECK);
 169 
 170   if (manifest == NULL) {
 171     return;
 172   }
 173 
 174   if (strstr(manifest, "Extension-List:") != NULL) {
 175     vm_exit_during_cds_dumping(err_msg("-Xshare:dump does not support Extension-List in JAR manifest: %s", entry->name()));
 176   }
 177 
 178   char* cp_attr = get_class_path_attr(entry->name(), manifest, manifest_size);
 179 
 180   if (cp_attr != NULL && strlen(cp_attr) > 0) {
 181     trace_class_path("found Class-Path: ", cp_attr);
 182 
 183     char sep = os::file_separator()[0];
 184     const char* dir_name = entry->name();
 185     const char* dir_tail = strrchr(dir_name, sep);
 186     int dir_len;
 187     if (dir_tail == NULL) {
 188       dir_len = 0;
 189     } else {
 190       dir_len = dir_tail - dir_name + 1;
 191     }
 192 
 193     // Split the cp_attr by spaces, and add each file
 194     char* file_start = cp_attr;
 195     char* end = file_start + strlen(file_start);
 196 
 197     while (file_start < end) {
 198       char* file_end = strchr(file_start, ' ');
 199       if (file_end != NULL) {
 200         *file_end = 0;
 201         file_end += 1;
 202       } else {
 203         file_end = end;
 204       }
 205 
 206       size_t name_len = strlen(file_start);
 207       if (name_len > 0) {
 208         ResourceMark rm(THREAD);
 209         size_t libname_len = dir_len + name_len;
 210         char* libname = NEW_RESOURCE_ARRAY(char, libname_len + 1);
 211         int n = os::snprintf(libname, libname_len + 1, "%.*s%s", dir_len, dir_name, file_start);
 212         assert((size_t)n == libname_len, "Unexpected number of characters in string");
 213         trace_class_path("library = ", libname);
 214         ClassLoader::update_class_path_entry_list(libname, true, false);
 215       }
 216 
 217       file_start = file_end;
 218     }
 219   }
 220 }
 221 
 222 void ClassLoaderExt::setup_search_paths() {
 223   shared_paths_misc_info()->record_app_offset();
 224   ClassLoaderExt::setup_app_search_path();
 225 }
 226 
 227 void ClassLoaderExt::record_result(const s2 classpath_index,
 228                                    InstanceKlass* result,
 229                                    TRAPS) {
 230   assert(DumpSharedSpaces, "Sanity");
 231 
 232   // We need to remember where the class comes from during dumping.
 233   oop loader = result->class_loader();
 234   s2 classloader_type = ClassLoader::BOOT_LOADER;
 235   if (SystemDictionary::is_system_class_loader(loader)) {
 236     classloader_type = ClassLoader::APP_LOADER;
 237     ClassLoaderExt::set_has_app_classes();
 238   } else if (SystemDictionary::is_platform_class_loader(loader)) {
 239     classloader_type = ClassLoader::PLATFORM_LOADER;
 240     ClassLoaderExt::set_has_platform_classes();
 241   }
 242   if (classpath_index > ClassLoaderExt::max_used_path_index()) {
 243     ClassLoaderExt::set_max_used_path_index(classpath_index);
 244   }
 245   result->set_shared_classpath_index(classpath_index);
 246   result->set_class_loader_type(classloader_type);
 247 }
 248 
 249 void ClassLoaderExt::finalize_shared_paths_misc_info() {
 250   if (!_has_app_classes) {
 251     shared_paths_misc_info()->pop_app();
 252   }
 253 }
 254 
 255 // Load the class of the given name from the location given by path. The path is specified by
 256 // the "source:" in the class list file (see classListParser.cpp), and can be a directory or
 257 // a JAR file.
 258 InstanceKlass* ClassLoaderExt::load_class(Symbol* name, const char* path, TRAPS) {
 259   assert(name != NULL, "invariant");
 260   assert(DumpSharedSpaces, "this function is only used with -Xshare:dump");
 261   ResourceMark rm(THREAD);
 262   const char* class_name = name->as_C_string();
 263 
 264   const char* file_name = file_name_for_class_name(class_name,
 265                                                    name->utf8_length());
 266   assert(file_name != NULL, "invariant");
 267 
 268   // Lookup stream for parsing .class file
 269   ClassFileStream* stream = NULL;
 270   ClassPathEntry* e = find_classpath_entry_from_cache(path, CHECK_NULL);
 271   if (e == NULL) {
 272     return NULL;
 273   }
 274   {
 275     PerfClassTraceTime vmtimer(perf_sys_class_lookup_time(),
 276                                ((JavaThread*) THREAD)->get_thread_stat()->perf_timers_addr(),
 277                                PerfClassTraceTime::CLASS_LOAD);
 278     stream = e->open_stream(file_name, CHECK_NULL);
 279   }
 280 
 281   if (NULL == stream) {
 282     tty->print_cr("Preload Warning: Cannot find %s", class_name);
 283     return NULL;
 284   }
 285 
 286   assert(stream != NULL, "invariant");
 287   stream->set_verify(true);
 288 
 289   ClassLoaderData* loader_data = ClassLoaderData::the_null_class_loader_data();
 290   Handle protection_domain;
 291 
 292   InstanceKlass* result = KlassFactory::create_from_stream(stream,
 293                                                            name,
 294                                                            loader_data,
 295                                                            protection_domain,
 296                                                            NULL,  // unsafe_anonymous_host
 297                                                            NULL,  // cp_patches
 298                                                            false, // is_nonfindable
 299                                                            false, // can_access_vm_annotations
 300                                                            NULL,  // dynamic_nest_host
 301                                                            Handle(), // classData
 302                                                            THREAD);
 303 
 304   if (HAS_PENDING_EXCEPTION) {
 305     tty->print_cr("Preload Error: Failed to load %s", class_name);
 306     return NULL;
 307   }
 308   result->set_shared_classpath_index(UNREGISTERED_INDEX);
 309   SystemDictionaryShared::set_shared_class_misc_info(result, stream);
 310   return result;
 311 }
 312 
 313 struct CachedClassPathEntry {
 314   const char* _path;
 315   ClassPathEntry* _entry;
 316 };
 317 
 318 static GrowableArray<CachedClassPathEntry>* cached_path_entries = NULL;
 319 
 320 ClassPathEntry* ClassLoaderExt::find_classpath_entry_from_cache(const char* path, TRAPS) {
 321   // This is called from dump time so it's single threaded and there's no need for a lock.
 322   assert(DumpSharedSpaces, "this function is only used with -Xshare:dump");
 323   if (cached_path_entries == NULL) {
 324     cached_path_entries = new (ResourceObj::C_HEAP, mtClass) GrowableArray<CachedClassPathEntry>(20, /*c heap*/ true);
 325   }
 326   CachedClassPathEntry ccpe;
 327   for (int i=0; i<cached_path_entries->length(); i++) {
 328     ccpe = cached_path_entries->at(i);
 329     if (strcmp(ccpe._path, path) == 0) {
 330       if (i != 0) {
 331         // Put recent entries at the beginning to speed up searches.
 332         cached_path_entries->remove_at(i);
 333         cached_path_entries->insert_before(0, ccpe);
 334       }
 335       return ccpe._entry;
 336     }
 337   }
 338 
 339   struct stat st;
 340   if (os::stat(path, &st) != 0) {
 341     // File or directory not found
 342     return NULL;
 343   }
 344   ClassPathEntry* new_entry = NULL;
 345 
 346   new_entry = create_class_path_entry(path, &st, false, false, CHECK_NULL);
 347   if (new_entry == NULL) {
 348     return NULL;
 349   }
 350   ccpe._path = strdup(path);
 351   ccpe._entry = new_entry;
 352   cached_path_entries->insert_before(0, ccpe);
 353   return new_entry;
 354 }