1 /*
   2  * Copyright (c) 2014, 2016, 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/classLoaderData.inline.hpp"
  28 #include "classfile/sharedPathsMiscInfo.hpp"
  29 #include "logging/log.hpp"
  30 #include "memory/allocation.inline.hpp"
  31 #include "memory/metaspaceShared.hpp"
  32 #include "memory/resourceArea.hpp"
  33 #include "runtime/arguments.hpp"
  34 #include "utilities/ostream.hpp"
  35 
  36 void SharedPathsMiscInfo::add_path(const char* path, int type) {
  37   log_info(classpath)("type=%s ", type_name(type));
  38   ClassLoader::trace_class_path("add misc shared path ", path);
  39   write(path, strlen(path) + 1);
  40   write_jint(jint(type));
  41 }
  42 
  43 void SharedPathsMiscInfo::ensure_size(size_t needed_bytes) {
  44   assert(_allocated, "cannot modify buffer during validation.");
  45   int used = get_used_bytes();
  46   int target = used + int(needed_bytes);
  47   if (target > _buf_size) {
  48     _buf_size = _buf_size * 2 + (int)needed_bytes;
  49     _buf_start = REALLOC_C_HEAP_ARRAY(char, _buf_start, _buf_size, mtClass);
  50     _cur_ptr = _buf_start + used;
  51     _end_ptr = _buf_start + _buf_size;
  52   }
  53 }
  54 
  55 void SharedPathsMiscInfo::write(const void* ptr, size_t size) {
  56   ensure_size(size);
  57   memcpy(_cur_ptr, ptr, size);
  58   _cur_ptr += size;
  59 }
  60 
  61 bool SharedPathsMiscInfo::read(void* ptr, size_t size) {
  62   if (_cur_ptr + size <= _end_ptr) {
  63     memcpy(ptr, _cur_ptr, size);
  64     _cur_ptr += size;
  65     return true;
  66   }
  67   return false;
  68 }
  69 
  70 bool SharedPathsMiscInfo::fail(const char* msg, const char* name) {
  71   ClassLoader::trace_class_path(msg, name);
  72   MetaspaceShared::set_archive_loading_failed();
  73   return false;
  74 }
  75 
  76 void SharedPathsMiscInfo::print_path(int type, const char* path) {
  77   ResourceMark rm;
  78   outputStream* out = LogHandle(classpath)::info_stream();
  79   switch (type) {
  80   case BOOT:
  81     out->print("Expecting -Dsun.boot.class.path=%s", path);
  82     break;
  83   case NON_EXIST:
  84     out->print("Expecting that %s does not exist", path);
  85     break;
  86   case REQUIRED:
  87     out->print("Expecting that file %s must exist and is not altered", path);
  88     break;
  89   default:
  90     ShouldNotReachHere();
  91   }
  92 }
  93 
  94 bool SharedPathsMiscInfo::check() {
  95   // The whole buffer must be 0 terminated so that we can use strlen and strcmp
  96   // without fear.
  97   _end_ptr -= sizeof(jint);
  98   if (_cur_ptr >= _end_ptr) {
  99     return fail("Truncated archive file header");
 100   }
 101   if (*_end_ptr != 0) {
 102     return fail("Corrupted archive file header");
 103   }
 104 
 105   while (_cur_ptr < _end_ptr) {
 106     jint type;
 107     const char* path = _cur_ptr;
 108     _cur_ptr += strlen(path) + 1;
 109     if (!read_jint(&type)) {
 110       return fail("Corrupted archive file header");
 111     }
 112     log_info(classpath)("type=%s ", type_name(type));
 113     print_path(type, path);
 114     if (!check(type, path)) {
 115       if (!PrintSharedArchiveAndExit) {
 116         return false;
 117       }
 118     } else {
 119       ClassLoader::trace_class_path("ok");
 120     }
 121   }
 122 
 123   return true;
 124 }
 125 
 126 bool SharedPathsMiscInfo::check(jint type, const char* path) {
 127   switch (type) {
 128   case BOOT:
 129     if (os::file_name_strcmp(path, Arguments::get_sysclasspath()) != 0) {
 130       return fail("[BOOT classpath mismatch, actual: -Dsun.boot.class.path=", Arguments::get_sysclasspath());
 131     }
 132     break;
 133   case NON_EXIST: // fall-through
 134   case REQUIRED:
 135     {
 136       struct stat st;
 137       if (os::stat(path, &st) != 0) {
 138         // The file does not actually exist
 139         if (type == REQUIRED) {
 140           // but we require it to exist -> fail
 141           return fail("Required file doesn't exist");
 142         }
 143       } else {
 144         // The file actually exists
 145         if (type == NON_EXIST) {
 146           // But we want it to not exist -> fail
 147           return fail("File must not exist");
 148         }
 149         time_t    timestamp;
 150         long      filesize;
 151 
 152         if (!read_time(&timestamp) || !read_long(&filesize)) {
 153           return fail("Corrupted archive file header");
 154         }
 155         if (timestamp != st.st_mtime) {
 156           return fail("Timestamp mismatch");
 157         }
 158         if (filesize != st.st_size) {
 159           return fail("File size mismatch");
 160         }
 161       }
 162     }
 163     break;
 164 
 165   default:
 166     return fail("Corrupted archive file header");
 167   }
 168 
 169   return true;
 170 }