1 /*
   2  * Copyright (c) 2014, 2018, 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/classLoader.hpp"
  27 #include "classfile/sharedPathsMiscInfo.hpp"
  28 #include "logging/log.hpp"
  29 #include "logging/logStream.hpp"
  30 #include "memory/allocation.inline.hpp"
  31 #include "memory/filemap.hpp"
  32 #include "memory/metaspaceShared.hpp"
  33 #include "memory/resourceArea.hpp"
  34 #include "runtime/arguments.hpp"
  35 #include "runtime/os.inline.hpp"
  36 #include "utilities/ostream.hpp"
  37 
  38 SharedPathsMiscInfo::SharedPathsMiscInfo() {
  39   _app_offset = 0;
  40   _buf_size = INITIAL_BUF_SIZE;
  41   _cur_ptr = _buf_start = NEW_C_HEAP_ARRAY(char, _buf_size, mtClass);
  42   _allocated = true;
  43 }
  44 
  45 SharedPathsMiscInfo::~SharedPathsMiscInfo() {
  46   if (_allocated) {
  47     FREE_C_HEAP_ARRAY(char, _buf_start);
  48   }
  49 }
  50 
  51 void SharedPathsMiscInfo::add_path(const char* path, int type) {
  52   log_info(class, path)("type=%s ", type_name(type));
  53   ClassLoader::trace_class_path("add misc shared path ", path);
  54   write(path, strlen(path) + 1);
  55   write_jint(jint(type));
  56 }
  57 
  58 void SharedPathsMiscInfo::ensure_size(size_t needed_bytes) {
  59   assert(_allocated, "cannot modify buffer during validation.");
  60   int used = get_used_bytes();
  61   int target = used + int(needed_bytes);
  62   if (target > _buf_size) {
  63     _buf_size = _buf_size * 2 + (int)needed_bytes;
  64     _buf_start = REALLOC_C_HEAP_ARRAY(char, _buf_start, _buf_size, mtClass);
  65     _cur_ptr = _buf_start + used;
  66     _end_ptr = _buf_start + _buf_size;
  67   }
  68 }
  69 
  70 void SharedPathsMiscInfo::write(const void* ptr, size_t size) {
  71   ensure_size(size);
  72   memcpy(_cur_ptr, ptr, size);
  73   _cur_ptr += size;
  74 }
  75 
  76 bool SharedPathsMiscInfo::read(void* ptr, size_t size) {
  77   if (_cur_ptr + size <= _end_ptr) {
  78     memcpy(ptr, _cur_ptr, size);
  79     _cur_ptr += size;
  80     return true;
  81   }
  82   return false;
  83 }
  84 
  85 bool SharedPathsMiscInfo::fail(const char* msg, const char* name) {
  86   ClassLoader::trace_class_path(msg, name);
  87   MetaspaceShared::set_archive_loading_failed();
  88   return false;
  89 }
  90 
  91 void SharedPathsMiscInfo::print_path(outputStream* out, int type, const char* path) {
  92   switch (type) {
  93   case BOOT_PATH:
  94     out->print("Expecting BOOT path=%s", path);
  95     break;
  96   case NON_EXIST:
  97     out->print("Expecting that %s does not exist", path);
  98     break;
  99   case APP_PATH:
 100     ClassLoader::trace_class_path("Expecting -Djava.class.path=", path);
 101     break;
 102   default:
 103     ShouldNotReachHere();
 104   }
 105 }
 106 
 107 bool SharedPathsMiscInfo::check() {
 108   // The whole buffer must be 0 terminated so that we can use strlen and strcmp
 109   // without fear.
 110   _end_ptr -= sizeof(jint);
 111   if (_cur_ptr >= _end_ptr) {
 112     return fail("Truncated archive file header");
 113   }
 114   if (*_end_ptr != 0) {
 115     return fail("Corrupted archive file header");
 116   }
 117 
 118   while (_cur_ptr < _end_ptr) {
 119     jint type;
 120     const char* path = _cur_ptr;
 121     _cur_ptr += strlen(path) + 1;
 122     if (!read_jint(&type)) {
 123       return fail("Corrupted archive file header");
 124     }
 125     LogTarget(Info, class, path) lt;
 126     if (lt.is_enabled()) {
 127       lt.print("type=%s ", type_name(type));
 128       LogStream ls(lt);
 129       print_path(&ls, type, path);
 130       ls.cr();
 131     }
 132     if (!check(type, path)) {
 133       if (!PrintSharedArchiveAndExit) {
 134         return false;
 135       }
 136     } else {
 137       ClassLoader::trace_class_path("ok");
 138     }
 139   }
 140 
 141   return true;
 142 }
 143 
 144 bool SharedPathsMiscInfo::check(jint type, const char* path) {
 145   assert(UseSharedSpaces, "runtime only");
 146   switch (type) {
 147   case BOOT_PATH:
 148     {
 149       //
 150       // - Archive contains boot classes only - relaxed boot path check:
 151       //   Extra path elements appended to the boot path at runtime are allowed.
 152       //
 153       // - Archive contains application or platform classes - strict boot path check:
 154       //   Validate the entire runtime boot path, which must be compactible
 155       //   with the dump time boot path. Appending boot path at runtime is not
 156       //   allowed.
 157       //
 158 
 159       bool relaxed_check = !FileMapInfo::current_info()->header()->has_platform_or_app_classes();
 160       char* runtime_boot_path;
 161       ResourceMark rm;
 162       if (relaxed_check) {
 163         // only check the begining portion of the runtime boot path, up to
 164         // the length of the dump time boot path
 165         size_t len = strlen(path);
 166         runtime_boot_path = NEW_RESOURCE_ARRAY(char, len + 1);
 167         strncpy(runtime_boot_path, Arguments::get_sysclasspath(), len);
 168         runtime_boot_path[len] = '\0';
 169       } else {
 170         // check the full runtime boot path
 171         runtime_boot_path = Arguments::get_sysclasspath();
 172       }
 173 
 174       // Do a quick check first with a simple
 175       // strcmp(dump_time_boot_path, runtime_boot_path). If the paths are the
 176       // same, the check has succeeded.
 177       if (os::file_name_strcmp(path, runtime_boot_path) == 0) {
 178         break; // ok
 179       }
 180 
 181       // The paths are different.
 182       //
 183       // - The first entry in boot path is the modules_image (guaranteed by
 184       //   ClassLoader::setup_boot_search_path()). Skip the first entry. The
 185       //   path of the runtime modules_image may be different from the dump
 186       //   time path (e.g. the JDK image is copied to a different location
 187       //   after generating the shared archive), which is acceptable. For most
 188       //   common cases, the dump time boot path might contain modules_image only.
 189       // - The rest of the 'runtime_boot_path' and 'dump_time_boot_path' strings
 190       //   must be the same.
 191       size_t path_sep_len = strlen(os::path_separator());
 192       char* rp = strstr(runtime_boot_path, os::path_separator());
 193       if (rp != NULL) {
 194         rp += path_sep_len;
 195       }
 196 
 197       char* dp = strstr((char*)path, os::path_separator());
 198       if (dp != NULL) {
 199         dp ++;
 200       }
 201 
 202       if (dp == NULL && rp == NULL) {
 203         break;   // ok, both runtime and dump time boot paths have modules_images only
 204       } else if (dp == NULL && rp != NULL && relaxed_check) {
 205         break;   // ok, relaxed check, runtime has extra boot append path entries
 206       } else if (dp != NULL && rp != NULL) {
 207         if (os::file_name_strcmp(dp, rp) == 0) {
 208           break; // ok, runtime and dump time paths match
 209         }
 210       }
 211 
 212       // The paths are different
 213       return fail("[BOOT classpath mismatch, actual =",
 214                   Arguments::get_sysclasspath());
 215     }
 216     break;
 217   case NON_EXIST:
 218     {
 219       struct stat st;
 220       if (os::stat(path, &st) == 0) {
 221         // The file actually exists
 222         // But we want it to not exist -> fail
 223         return fail("File must not exist");
 224       }
 225     }
 226     break;
 227   case APP_PATH:
 228     {
 229       // Prefix is OK: E.g., dump with -cp foo.jar, but run with -cp foo.jar:bar.jar
 230       size_t len = strlen(path);
 231       const char *appcp = Arguments::get_appclasspath();
 232       assert(appcp != NULL, "NULL app classpath");
 233       size_t appcp_len = strlen(appcp);
 234       if (appcp_len < len) {
 235         return fail("Run time APP classpath is shorter than the one at dump time: ", appcp);
 236       }
 237       ResourceMark rm;
 238       char* tmp_path;
 239       if (len == appcp_len) {
 240         tmp_path = (char*)appcp;
 241       } else {
 242         tmp_path = NEW_RESOURCE_ARRAY(char, len + 1);
 243         strncpy(tmp_path, appcp, len);
 244         tmp_path[len] = 0;
 245       }
 246       if (os::file_name_strcmp(path, tmp_path) != 0) {
 247         return fail("[APP classpath mismatch, actual: -Djava.class.path=", appcp);
 248       }
 249       if (appcp[len] != '\0' && appcp[len] != os::path_separator()[0]) {
 250         return fail("Dump time APP classpath is not a proper prefix of run time APP classpath: ", appcp);
 251       }
 252     }
 253     break;
 254   default:
 255     return fail("Corrupted archive file header");
 256   }
 257 
 258   return true;
 259 }
--- EOF ---