Thu, 29 Nov 2012 11:23:15 -0800
Merge
1 /*
2 * Copyright (c) 2003, 2012, 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 */
25 #include "precompiled.hpp"
26 #include "classfile/classLoader.hpp"
27 #include "classfile/symbolTable.hpp"
28 #include "classfile/altHashing.hpp"
29 #include "memory/filemap.hpp"
30 #include "runtime/arguments.hpp"
31 #include "runtime/java.hpp"
32 #include "runtime/os.hpp"
33 #include "services/memTracker.hpp"
34 #include "utilities/defaultStream.hpp"
36 # include <sys/stat.h>
37 # include <errno.h>
39 #ifndef O_BINARY // if defined (Win32) use binary files.
40 #define O_BINARY 0 // otherwise do nothing.
41 #endif
44 extern address JVM_FunctionAtStart();
45 extern address JVM_FunctionAtEnd();
47 // Complain and stop. All error conditions occurring during the writing of
48 // an archive file should stop the process. Unrecoverable errors during
49 // the reading of the archive file should stop the process.
51 static void fail(const char *msg, va_list ap) {
52 // This occurs very early during initialization: tty is not initialized.
53 jio_fprintf(defaultStream::error_stream(),
54 "An error has occurred while processing the"
55 " shared archive file.\n");
56 jio_vfprintf(defaultStream::error_stream(), msg, ap);
57 jio_fprintf(defaultStream::error_stream(), "\n");
58 vm_exit_during_initialization("Unable to use shared archive.", NULL);
59 }
62 void FileMapInfo::fail_stop(const char *msg, ...) {
63 va_list ap;
64 va_start(ap, msg);
65 fail(msg, ap); // Never returns.
66 va_end(ap); // for completeness.
67 }
70 // Complain and continue. Recoverable errors during the reading of the
71 // archive file may continue (with sharing disabled).
72 //
73 // If we continue, then disable shared spaces and close the file.
75 void FileMapInfo::fail_continue(const char *msg, ...) {
76 va_list ap;
77 va_start(ap, msg);
78 if (RequireSharedSpaces) {
79 fail(msg, ap);
80 }
81 va_end(ap);
82 UseSharedSpaces = false;
83 close();
84 }
86 // Fill in the fileMapInfo structure with data about this VM instance.
88 // This method copies the vm version info into header_version. If the version is too
89 // long then a truncated version, which has a hash code appended to it, is copied.
90 //
91 // Using a template enables this method to verify that header_version is an array of
92 // length JVM_IDENT_MAX. This ensures that the code that writes to the CDS file and
93 // the code that reads the CDS file will both use the same size buffer. Hence, will
94 // use identical truncation. This is necessary for matching of truncated versions.
95 template <int N> static void get_header_version(char (&header_version) [N]) {
96 assert(N == JVM_IDENT_MAX, "Bad header_version size");
98 const char *vm_version = VM_Version::internal_vm_info_string();
99 const int version_len = (int)strlen(vm_version);
101 if (version_len < (JVM_IDENT_MAX-1)) {
102 strcpy(header_version, vm_version);
104 } else {
105 // Get the hash value. Use a static seed because the hash needs to return the same
106 // value over multiple jvm invocations.
107 unsigned int hash = AltHashing::murmur3_32(8191, (const jbyte*)vm_version, version_len);
109 // Truncate the ident, saving room for the 8 hex character hash value.
110 strncpy(header_version, vm_version, JVM_IDENT_MAX-9);
112 // Append the hash code as eight hex digits.
113 sprintf(&header_version[JVM_IDENT_MAX-9], "%08x", hash);
114 header_version[JVM_IDENT_MAX-1] = 0; // Null terminate.
115 }
116 }
118 void FileMapInfo::populate_header(size_t alignment) {
119 _header._magic = 0xf00baba2;
120 _header._version = _current_version;
121 _header._alignment = alignment;
123 // The following fields are for sanity checks for whether this archive
124 // will function correctly with this JVM and the bootclasspath it's
125 // invoked with.
127 // JVM version string ... changes on each build.
128 get_header_version(_header._jvm_ident);
130 // Build checks on classpath and jar files
131 _header._num_jars = 0;
132 ClassPathEntry *cpe = ClassLoader::classpath_entry(0);
133 for ( ; cpe != NULL; cpe = cpe->next()) {
135 if (cpe->is_jar_file()) {
136 if (_header._num_jars >= JVM_SHARED_JARS_MAX) {
137 fail_stop("Too many jar files to share.", NULL);
138 }
140 // Jar file - record timestamp and file size.
141 struct stat st;
142 const char *path = cpe->name();
143 if (os::stat(path, &st) != 0) {
144 // If we can't access a jar file in the boot path, then we can't
145 // make assumptions about where classes get loaded from.
146 fail_stop("Unable to open jar file %s.", path);
147 }
148 _header._jar[_header._num_jars]._timestamp = st.st_mtime;
149 _header._jar[_header._num_jars]._filesize = st.st_size;
150 _header._num_jars++;
151 } else {
153 // If directories appear in boot classpath, they must be empty to
154 // avoid having to verify each individual class file.
155 const char* name = ((ClassPathDirEntry*)cpe)->name();
156 if (!os::dir_is_empty(name)) {
157 fail_stop("Boot classpath directory %s is not empty.", name);
158 }
159 }
160 }
161 }
164 // Read the FileMapInfo information from the file.
166 bool FileMapInfo::init_from_file(int fd) {
168 size_t n = read(fd, &_header, sizeof(struct FileMapHeader));
169 if (n != sizeof(struct FileMapHeader)) {
170 fail_continue("Unable to read the file header.");
171 return false;
172 }
173 if (_header._version != current_version()) {
174 fail_continue("The shared archive file has the wrong version.");
175 return false;
176 }
177 _file_offset = (long)n;
178 return true;
179 }
182 // Read the FileMapInfo information from the file.
183 bool FileMapInfo::open_for_read() {
184 _full_path = Arguments::GetSharedArchivePath();
185 int fd = open(_full_path, O_RDONLY | O_BINARY, 0);
186 if (fd < 0) {
187 if (errno == ENOENT) {
188 // Not locating the shared archive is ok.
189 fail_continue("Specified shared archive not found.");
190 } else {
191 fail_continue("Failed to open shared archive file (%s).",
192 strerror(errno));
193 }
194 return false;
195 }
197 _fd = fd;
198 _file_open = true;
199 return true;
200 }
203 // Write the FileMapInfo information to the file.
205 void FileMapInfo::open_for_write() {
206 _full_path = Arguments::GetSharedArchivePath();
207 if (PrintSharedSpaces) {
208 tty->print_cr("Dumping shared data to file: ");
209 tty->print_cr(" %s", _full_path);
210 }
212 // Remove the existing file in case another process has it open.
213 remove(_full_path);
214 int fd = open(_full_path, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0444);
215 if (fd < 0) {
216 fail_stop("Unable to create shared archive file %s.", _full_path);
217 }
218 _fd = fd;
219 _file_offset = 0;
220 _file_open = true;
221 }
224 // Write the header to the file, seek to the next allocation boundary.
226 void FileMapInfo::write_header() {
227 write_bytes_aligned(&_header, sizeof(FileMapHeader));
228 }
231 // Dump shared spaces to file.
233 void FileMapInfo::write_space(int i, Metaspace* space, bool read_only) {
234 align_file_position();
235 size_t used = space->used_words(Metaspace::NonClassType) * BytesPerWord;
236 size_t capacity = space->capacity_words(Metaspace::NonClassType) * BytesPerWord;
237 struct FileMapInfo::FileMapHeader::space_info* si = &_header._space[i];
238 write_region(i, (char*)space->bottom(), used, capacity, read_only, false);
239 }
242 // Dump region to file.
244 void FileMapInfo::write_region(int region, char* base, size_t size,
245 size_t capacity, bool read_only,
246 bool allow_exec) {
247 struct FileMapInfo::FileMapHeader::space_info* si = &_header._space[region];
249 if (_file_open) {
250 guarantee(si->_file_offset == _file_offset, "file offset mismatch.");
251 if (PrintSharedSpaces) {
252 tty->print_cr("Shared file region %d: 0x%6x bytes, addr " INTPTR_FORMAT
253 " file offset 0x%6x", region, size, base, _file_offset);
254 }
255 } else {
256 si->_file_offset = _file_offset;
257 }
258 si->_base = base;
259 si->_used = size;
260 si->_capacity = capacity;
261 si->_read_only = read_only;
262 si->_allow_exec = allow_exec;
263 write_bytes_aligned(base, (int)size);
264 }
267 // Dump bytes to file -- at the current file position.
269 void FileMapInfo::write_bytes(const void* buffer, int nbytes) {
270 if (_file_open) {
271 int n = ::write(_fd, buffer, nbytes);
272 if (n != nbytes) {
273 // It is dangerous to leave the corrupted shared archive file around,
274 // close and remove the file. See bug 6372906.
275 close();
276 remove(_full_path);
277 fail_stop("Unable to write to shared archive file.", NULL);
278 }
279 }
280 _file_offset += nbytes;
281 }
284 // Align file position to an allocation unit boundary.
286 void FileMapInfo::align_file_position() {
287 long new_file_offset = align_size_up(_file_offset, os::vm_allocation_granularity());
288 if (new_file_offset != _file_offset) {
289 _file_offset = new_file_offset;
290 if (_file_open) {
291 // Seek one byte back from the target and write a byte to insure
292 // that the written file is the correct length.
293 _file_offset -= 1;
294 if (lseek(_fd, _file_offset, SEEK_SET) < 0) {
295 fail_stop("Unable to seek.", NULL);
296 }
297 char zero = 0;
298 write_bytes(&zero, 1);
299 }
300 }
301 }
304 // Dump bytes to file -- at the current file position.
306 void FileMapInfo::write_bytes_aligned(const void* buffer, int nbytes) {
307 align_file_position();
308 write_bytes(buffer, nbytes);
309 align_file_position();
310 }
313 // Close the shared archive file. This does NOT unmap mapped regions.
315 void FileMapInfo::close() {
316 if (_file_open) {
317 if (::close(_fd) < 0) {
318 fail_stop("Unable to close the shared archive file.");
319 }
320 _file_open = false;
321 _fd = -1;
322 }
323 }
326 // JVM/TI RedefineClasses() support:
327 // Remap the shared readonly space to shared readwrite, private.
328 bool FileMapInfo::remap_shared_readonly_as_readwrite() {
329 struct FileMapInfo::FileMapHeader::space_info* si = &_header._space[0];
330 if (!si->_read_only) {
331 // the space is already readwrite so we are done
332 return true;
333 }
334 size_t used = si->_used;
335 size_t size = align_size_up(used, os::vm_allocation_granularity());
336 if (!open_for_read()) {
337 return false;
338 }
339 char *base = os::remap_memory(_fd, _full_path, si->_file_offset,
340 si->_base, size, false /* !read_only */,
341 si->_allow_exec);
342 close();
343 if (base == NULL) {
344 fail_continue("Unable to remap shared readonly space (errno=%d).", errno);
345 return false;
346 }
347 if (base != si->_base) {
348 fail_continue("Unable to remap shared readonly space at required address.");
349 return false;
350 }
351 si->_read_only = false;
352 return true;
353 }
355 // Map the whole region at once, assumed to be allocated contiguously.
356 ReservedSpace FileMapInfo::reserve_shared_memory() {
357 struct FileMapInfo::FileMapHeader::space_info* si = &_header._space[0];
358 char* requested_addr = si->_base;
359 size_t alignment = os::vm_allocation_granularity();
361 size_t size = align_size_up(SharedReadOnlySize + SharedReadWriteSize +
362 SharedMiscDataSize + SharedMiscCodeSize,
363 alignment);
365 // Reserve the space first, then map otherwise map will go right over some
366 // other reserved memory (like the code cache).
367 ReservedSpace rs(size, alignment, false, requested_addr);
368 if (!rs.is_reserved()) {
369 fail_continue(err_msg("Unable to reserved shared space at required address " INTPTR_FORMAT, requested_addr));
370 return rs;
371 }
372 // the reserved virtual memory is for mapping class data sharing archive
373 if (MemTracker::is_on()) {
374 MemTracker::record_virtual_memory_type((address)rs.base(), mtClassShared);
375 }
376 return rs;
377 }
379 // Memory map a region in the address space.
380 static const char* shared_region_name[] = { "ReadOnly", "ReadWrite", "MiscData", "MiscCode"};
382 char* FileMapInfo::map_region(int i) {
383 struct FileMapInfo::FileMapHeader::space_info* si = &_header._space[i];
384 size_t used = si->_used;
385 size_t alignment = os::vm_allocation_granularity();
386 size_t size = align_size_up(used, alignment);
387 char *requested_addr = si->_base;
389 // map the contents of the CDS archive in this memory
390 char *base = os::map_memory(_fd, _full_path, si->_file_offset,
391 requested_addr, size, si->_read_only,
392 si->_allow_exec);
393 if (base == NULL || base != si->_base) {
394 fail_continue(err_msg("Unable to map %s shared space at required address.", shared_region_name[i]));
395 return NULL;
396 }
397 return base;
398 }
401 // Unmap a memory region in the address space.
403 void FileMapInfo::unmap_region(int i) {
404 struct FileMapInfo::FileMapHeader::space_info* si = &_header._space[i];
405 size_t used = si->_used;
406 size_t size = align_size_up(used, os::vm_allocation_granularity());
407 if (!os::unmap_memory(si->_base, size)) {
408 fail_stop("Unable to unmap shared space.");
409 }
410 }
413 void FileMapInfo::assert_mark(bool check) {
414 if (!check) {
415 fail_stop("Mark mismatch while restoring from shared file.", NULL);
416 }
417 }
420 FileMapInfo* FileMapInfo::_current_info = NULL;
423 // Open the shared archive file, read and validate the header
424 // information (version, boot classpath, etc.). If initialization
425 // fails, shared spaces are disabled and the file is closed. [See
426 // fail_continue.]
427 bool FileMapInfo::initialize() {
428 assert(UseSharedSpaces, "UseSharedSpaces expected.");
430 if (JvmtiExport::can_modify_any_class() || JvmtiExport::can_walk_any_space()) {
431 fail_continue("Tool agent requires sharing to be disabled.");
432 return false;
433 }
435 if (!open_for_read()) {
436 return false;
437 }
439 init_from_file(_fd);
440 if (!validate()) {
441 return false;
442 }
444 SharedReadOnlySize = _header._space[0]._capacity;
445 SharedReadWriteSize = _header._space[1]._capacity;
446 SharedMiscDataSize = _header._space[2]._capacity;
447 SharedMiscCodeSize = _header._space[3]._capacity;
448 return true;
449 }
452 bool FileMapInfo::validate() {
453 if (_header._version != current_version()) {
454 fail_continue("The shared archive file is the wrong version.");
455 return false;
456 }
457 if (_header._magic != (int)0xf00baba2) {
458 fail_continue("The shared archive file has a bad magic number.");
459 return false;
460 }
461 char header_version[JVM_IDENT_MAX];
462 get_header_version(header_version);
463 if (strncmp(_header._jvm_ident, header_version, JVM_IDENT_MAX-1) != 0) {
464 fail_continue("The shared archive file was created by a different"
465 " version or build of HotSpot.");
466 return false;
467 }
469 // Cannot verify interpreter yet, as it can only be created after the GC
470 // heap has been initialized.
472 if (_header._num_jars >= JVM_SHARED_JARS_MAX) {
473 fail_continue("Too many jar files to share.");
474 return false;
475 }
477 // Build checks on classpath and jar files
478 int num_jars_now = 0;
479 ClassPathEntry *cpe = ClassLoader::classpath_entry(0);
480 for ( ; cpe != NULL; cpe = cpe->next()) {
482 if (cpe->is_jar_file()) {
483 if (num_jars_now < _header._num_jars) {
485 // Jar file - verify timestamp and file size.
486 struct stat st;
487 const char *path = cpe->name();
488 if (os::stat(path, &st) != 0) {
489 fail_continue("Unable to open jar file %s.", path);
490 return false;
491 }
492 if (_header._jar[num_jars_now]._timestamp != st.st_mtime ||
493 _header._jar[num_jars_now]._filesize != st.st_size) {
494 fail_continue("A jar file is not the one used while building"
495 " the shared archive file.");
496 return false;
497 }
498 }
499 ++num_jars_now;
500 } else {
502 // If directories appear in boot classpath, they must be empty to
503 // avoid having to verify each individual class file.
504 const char* name = ((ClassPathDirEntry*)cpe)->name();
505 if (!os::dir_is_empty(name)) {
506 fail_continue("Boot classpath directory %s is not empty.", name);
507 return false;
508 }
509 }
510 }
511 if (num_jars_now < _header._num_jars) {
512 fail_continue("The number of jar files in the boot classpath is"
513 " less than the number the shared archive was created with.");
514 return false;
515 }
517 return true;
518 }
520 // The following method is provided to see whether a given pointer
521 // falls in the mapped shared space.
522 // Param:
523 // p, The given pointer
524 // Return:
525 // True if the p is within the mapped shared space, otherwise, false.
526 bool FileMapInfo::is_in_shared_space(const void* p) {
527 for (int i = 0; i < MetaspaceShared::n_regions; i++) {
528 if (p >= _header._space[i]._base &&
529 p < _header._space[i]._base + _header._space[i]._used) {
530 return true;
531 }
532 }
534 return false;
535 }