1 /* 2 * Copyright (c) 1997, 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 #ifndef SHARE_VM_RUNTIME_OS_HPP 26 #define SHARE_VM_RUNTIME_OS_HPP 27 28 #include "jvm.h" 29 #include "jvmtifiles/jvmti.h" 30 #include "metaprogramming/isRegisteredEnum.hpp" 31 #include "metaprogramming/integralConstant.hpp" 32 #include "runtime/extendedPC.hpp" 33 #include "utilities/exceptions.hpp" 34 #include "utilities/ostream.hpp" 35 #include "utilities/macros.hpp" 36 #ifndef _WINDOWS 37 # include <setjmp.h> 38 #endif 39 #ifdef __APPLE__ 40 # include <mach/mach_time.h> 41 #endif 42 43 class AgentLibrary; 44 class frame; 45 46 // os defines the interface to operating system; this includes traditional 47 // OS services (time, I/O) as well as other functionality with system- 48 // dependent code. 49 50 typedef void (*dll_func)(...); 51 52 class Thread; 53 class JavaThread; 54 class Event; 55 class DLL; 56 class FileHandle; 57 class NativeCallStack; 58 class methodHandle; 59 60 template<class E> class GrowableArray; 61 62 // %%%%% Moved ThreadState, START_FN, OSThread to new osThread.hpp. -- Rose 63 64 // Platform-independent error return values from OS functions 65 enum OSReturn { 66 OS_OK = 0, // Operation was successful 67 OS_ERR = -1, // Operation failed 68 OS_INTRPT = -2, // Operation was interrupted 69 OS_TIMEOUT = -3, // Operation timed out 70 OS_NOMEM = -5, // Operation failed for lack of memory 71 OS_NORESOURCE = -6 // Operation failed for lack of nonmemory resource 72 }; 73 74 enum ThreadPriority { // JLS 20.20.1-3 75 NoPriority = -1, // Initial non-priority value 76 MinPriority = 1, // Minimum priority 77 NormPriority = 5, // Normal (non-daemon) priority 78 NearMaxPriority = 9, // High priority, used for VMThread 79 MaxPriority = 10, // Highest priority, used for WatcherThread 80 // ensures that VMThread doesn't starve profiler 81 CriticalPriority = 11 // Critical thread priority 82 }; 83 84 // Executable parameter flag for os::commit_memory() and 85 // os::commit_memory_or_exit(). 86 const bool ExecMem = true; 87 88 // Typedef for structured exception handling support 89 typedef void (*java_call_t)(JavaValue* value, const methodHandle& method, JavaCallArguments* args, Thread* thread); 90 91 class MallocTracker; 92 93 class os: AllStatic { 94 friend class VMStructs; 95 friend class JVMCIVMStructs; 96 friend class MallocTracker; 97 public: 98 enum { page_sizes_max = 9 }; // Size of _page_sizes array (8 plus a sentinel) 99 100 private: 101 static OSThread* _starting_thread; 102 static address _polling_page; 103 static volatile int32_t * _mem_serialize_page; 104 static uintptr_t _serialize_page_mask; 105 public: 106 static size_t _page_sizes[page_sizes_max]; 107 108 private: 109 static void init_page_sizes(size_t default_page_size) { 110 _page_sizes[0] = default_page_size; 111 _page_sizes[1] = 0; // sentinel 112 } 113 114 static char* pd_reserve_memory(size_t bytes, char* addr = 0, 115 size_t alignment_hint = 0); 116 static char* pd_attempt_reserve_memory_at(size_t bytes, char* addr); 117 static char* pd_attempt_reserve_memory_at(size_t bytes, char* addr, int file_desc); 118 static void pd_split_reserved_memory(char *base, size_t size, 119 size_t split, bool realloc); 120 static bool pd_commit_memory(char* addr, size_t bytes, bool executable); 121 static bool pd_commit_memory(char* addr, size_t size, size_t alignment_hint, 122 bool executable); 123 // Same as pd_commit_memory() that either succeeds or calls 124 // vm_exit_out_of_memory() with the specified mesg. 125 static void pd_commit_memory_or_exit(char* addr, size_t bytes, 126 bool executable, const char* mesg); 127 static void pd_commit_memory_or_exit(char* addr, size_t size, 128 size_t alignment_hint, 129 bool executable, const char* mesg); 130 static bool pd_uncommit_memory(char* addr, size_t bytes); 131 static bool pd_release_memory(char* addr, size_t bytes); 132 133 static char* pd_map_memory(int fd, const char* file_name, size_t file_offset, 134 char *addr, size_t bytes, bool read_only = false, 135 bool allow_exec = false); 136 static char* pd_remap_memory(int fd, const char* file_name, size_t file_offset, 137 char *addr, size_t bytes, bool read_only, 138 bool allow_exec); 139 static bool pd_unmap_memory(char *addr, size_t bytes); 140 static void pd_free_memory(char *addr, size_t bytes, size_t alignment_hint); 141 static void pd_realign_memory(char *addr, size_t bytes, size_t alignment_hint); 142 143 static size_t page_size_for_region(size_t region_size, size_t min_pages, bool must_be_aligned); 144 145 // Get summary strings for system information in buffer provided 146 static void get_summary_cpu_info(char* buf, size_t buflen); 147 static void get_summary_os_info(char* buf, size_t buflen); 148 149 static void initialize_initial_active_processor_count(); 150 151 LINUX_ONLY(static void pd_init_container_support();) 152 153 public: 154 static void init(void); // Called before command line parsing 155 156 static void init_container_support() { // Called during command line parsing. 157 LINUX_ONLY(pd_init_container_support();) 158 } 159 160 static void init_before_ergo(void); // Called after command line parsing 161 // before VM ergonomics processing. 162 static jint init_2(void); // Called after command line parsing 163 // and VM ergonomics processing 164 static void init_globals(void) { // Called from init_globals() in init.cpp 165 init_globals_ext(); 166 } 167 168 // File names are case-insensitive on windows only 169 // Override me as needed 170 static int file_name_strncmp(const char* s1, const char* s2, size_t num); 171 172 // unset environment variable 173 static bool unsetenv(const char* name); 174 175 static bool have_special_privileges(); 176 177 static jlong javaTimeMillis(); 178 static jlong javaTimeNanos(); 179 static void javaTimeNanos_info(jvmtiTimerInfo *info_ptr); 180 static void javaTimeSystemUTC(jlong &seconds, jlong &nanos); 181 static void run_periodic_checks(); 182 static bool supports_monotonic_clock(); 183 184 // Returns the elapsed time in seconds since the vm started. 185 static double elapsedTime(); 186 187 // Returns real time in seconds since an arbitrary point 188 // in the past. 189 static bool getTimesSecs(double* process_real_time, 190 double* process_user_time, 191 double* process_system_time); 192 193 // Interface to the performance counter 194 static jlong elapsed_counter(); 195 static jlong elapsed_frequency(); 196 197 // The "virtual time" of a thread is the amount of time a thread has 198 // actually run. The first function indicates whether the OS supports 199 // this functionality for the current thread, and if so: 200 // * the second enables vtime tracking (if that is required). 201 // * the third tells whether vtime is enabled. 202 // * the fourth returns the elapsed virtual time for the current 203 // thread. 204 static bool supports_vtime(); 205 static bool enable_vtime(); 206 static bool vtime_enabled(); 207 static double elapsedVTime(); 208 209 // Return current local time in a string (YYYY-MM-DD HH:MM:SS). 210 // It is MT safe, but not async-safe, as reading time zone 211 // information may require a lock on some platforms. 212 static char* local_time_string(char *buf, size_t buflen); 213 static struct tm* localtime_pd (const time_t* clock, struct tm* res); 214 static struct tm* gmtime_pd (const time_t* clock, struct tm* res); 215 // Fill in buffer with current local time as an ISO-8601 string. 216 // E.g., YYYY-MM-DDThh:mm:ss.mmm+zzzz. 217 // Returns buffer, or NULL if it failed. 218 static char* iso8601_time(char* buffer, size_t buffer_length, bool utc = false); 219 220 // Interface for detecting multiprocessor system 221 static inline bool is_MP() { 222 // During bootstrap if _processor_count is not yet initialized 223 // we claim to be MP as that is safest. If any platform has a 224 // stub generator that might be triggered in this phase and for 225 // which being declared MP when in fact not, is a problem - then 226 // the bootstrap routine for the stub generator needs to check 227 // the processor count directly and leave the bootstrap routine 228 // in place until called after initialization has ocurred. 229 return (_processor_count != 1); 230 } 231 232 static julong available_memory(); 233 static julong physical_memory(); 234 static bool has_allocatable_memory_limit(julong* limit); 235 static bool is_server_class_machine(); 236 237 // Returns the id of the processor on which the calling thread is currently executing. 238 // The returned value is guaranteed to be between 0 and (os::processor_count() - 1). 239 static uint processor_id(); 240 241 // number of CPUs 242 static int processor_count() { 243 return _processor_count; 244 } 245 static void set_processor_count(int count) { _processor_count = count; } 246 247 // Returns the number of CPUs this process is currently allowed to run on. 248 // Note that on some OSes this can change dynamically. 249 static int active_processor_count(); 250 251 // At startup the number of active CPUs this process is allowed to run on. 252 // This value does not change dynamically. May be different from active_processor_count(). 253 static int initial_active_processor_count() { 254 assert(_initial_active_processor_count > 0, "Initial active processor count not set yet."); 255 return _initial_active_processor_count; 256 } 257 258 // Bind processes to processors. 259 // This is a two step procedure: 260 // first you generate a distribution of processes to processors, 261 // then you bind processes according to that distribution. 262 // Compute a distribution for number of processes to processors. 263 // Stores the processor id's into the distribution array argument. 264 // Returns true if it worked, false if it didn't. 265 static bool distribute_processes(uint length, uint* distribution); 266 // Binds the current process to a processor. 267 // Returns true if it worked, false if it didn't. 268 static bool bind_to_processor(uint processor_id); 269 270 // Give a name to the current thread. 271 static void set_native_thread_name(const char *name); 272 273 // Interface for stack banging (predetect possible stack overflow for 274 // exception processing) There are guard pages, and above that shadow 275 // pages for stack overflow checking. 276 static bool uses_stack_guard_pages(); 277 static bool must_commit_stack_guard_pages(); 278 static void map_stack_shadow_pages(address sp); 279 static bool stack_shadow_pages_available(Thread *thread, const methodHandle& method, address sp); 280 281 // Find committed memory region within specified range (start, start + size), 282 // return true if found any 283 static bool committed_in_range(address start, size_t size, address& committed_start, size_t& committed_size); 284 285 // OS interface to Virtual Memory 286 287 // Return the default page size. 288 static int vm_page_size(); 289 290 // Returns the page size to use for a region of memory. 291 // region_size / min_pages will always be greater than or equal to the 292 // returned value. The returned value will divide region_size. 293 static size_t page_size_for_region_aligned(size_t region_size, size_t min_pages); 294 295 // Returns the page size to use for a region of memory. 296 // region_size / min_pages will always be greater than or equal to the 297 // returned value. The returned value might not divide region_size. 298 static size_t page_size_for_region_unaligned(size_t region_size, size_t min_pages); 299 300 // Return the largest page size that can be used 301 static size_t max_page_size() { 302 // The _page_sizes array is sorted in descending order. 303 return _page_sizes[0]; 304 } 305 306 // Return a lower bound for page sizes. Also works before os::init completed. 307 static size_t min_page_size() { return 4 * K; } 308 309 // Methods for tracing page sizes returned by the above method. 310 // The region_{min,max}_size parameters should be the values 311 // passed to page_size_for_region() and page_size should be the result of that 312 // call. The (optional) base and size parameters should come from the 313 // ReservedSpace base() and size() methods. 314 static void trace_page_sizes(const char* str, const size_t* page_sizes, int count); 315 static void trace_page_sizes(const char* str, 316 const size_t region_min_size, 317 const size_t region_max_size, 318 const size_t page_size, 319 const char* base, 320 const size_t size); 321 static void trace_page_sizes_for_requested_size(const char* str, 322 const size_t requested_size, 323 const size_t page_size, 324 const size_t alignment, 325 const char* base, 326 const size_t size); 327 328 static int vm_allocation_granularity(); 329 static char* reserve_memory(size_t bytes, char* addr = 0, 330 size_t alignment_hint = 0, int file_desc = -1); 331 static char* reserve_memory(size_t bytes, char* addr, 332 size_t alignment_hint, MEMFLAGS flags); 333 static char* reserve_memory_aligned(size_t size, size_t alignment, int file_desc = -1); 334 static char* attempt_reserve_memory_at(size_t bytes, char* addr, int file_desc = -1); 335 static void split_reserved_memory(char *base, size_t size, 336 size_t split, bool realloc); 337 static bool commit_memory(char* addr, size_t bytes, bool executable); 338 static bool commit_memory(char* addr, size_t size, size_t alignment_hint, 339 bool executable); 340 // Same as commit_memory() that either succeeds or calls 341 // vm_exit_out_of_memory() with the specified mesg. 342 static void commit_memory_or_exit(char* addr, size_t bytes, 343 bool executable, const char* mesg); 344 static void commit_memory_or_exit(char* addr, size_t size, 345 size_t alignment_hint, 346 bool executable, const char* mesg); 347 static bool uncommit_memory(char* addr, size_t bytes); 348 static bool release_memory(char* addr, size_t bytes); 349 350 // Touch memory pages that cover the memory range from start to end (exclusive) 351 // to make the OS back the memory range with actual memory. 352 // Current implementation may not touch the last page if unaligned addresses 353 // are passed. 354 static void pretouch_memory(void* start, void* end, size_t page_size = vm_page_size()); 355 356 enum ProtType { MEM_PROT_NONE, MEM_PROT_READ, MEM_PROT_RW, MEM_PROT_RWX }; 357 static bool protect_memory(char* addr, size_t bytes, ProtType prot, 358 bool is_committed = true); 359 360 static bool guard_memory(char* addr, size_t bytes); 361 static bool unguard_memory(char* addr, size_t bytes); 362 static bool create_stack_guard_pages(char* addr, size_t bytes); 363 static bool pd_create_stack_guard_pages(char* addr, size_t bytes); 364 static bool remove_stack_guard_pages(char* addr, size_t bytes); 365 // Helper function to create a new file with template jvmheap.XXXXXX. 366 // Returns a valid fd on success or else returns -1 367 static int create_file_for_heap(const char* dir); 368 // Map memory to the file referred by fd. This function is slightly different from map_memory() 369 // and is added to be used for implementation of -XX:AllocateHeapAt 370 static char* map_memory_to_file(char* base, size_t size, int fd); 371 // Replace existing reserved memory with file mapping 372 static char* replace_existing_mapping_with_file_mapping(char* base, size_t size, int fd); 373 374 static char* map_memory(int fd, const char* file_name, size_t file_offset, 375 char *addr, size_t bytes, bool read_only = false, 376 bool allow_exec = false); 377 static char* remap_memory(int fd, const char* file_name, size_t file_offset, 378 char *addr, size_t bytes, bool read_only, 379 bool allow_exec); 380 static bool unmap_memory(char *addr, size_t bytes); 381 static void free_memory(char *addr, size_t bytes, size_t alignment_hint); 382 static void realign_memory(char *addr, size_t bytes, size_t alignment_hint); 383 384 // NUMA-specific interface 385 static bool numa_has_static_binding(); 386 static bool numa_has_group_homing(); 387 static void numa_make_local(char *addr, size_t bytes, int lgrp_hint); 388 static void numa_make_global(char *addr, size_t bytes); 389 static size_t numa_get_groups_num(); 390 static size_t numa_get_leaf_groups(int *ids, size_t size); 391 static bool numa_topology_changed(); 392 static int numa_get_group_id(); 393 394 // Page manipulation 395 struct page_info { 396 size_t size; 397 int lgrp_id; 398 }; 399 static bool get_page_info(char *start, page_info* info); 400 static char* scan_pages(char *start, char* end, page_info* page_expected, page_info* page_found); 401 402 static char* non_memory_address_word(); 403 // reserve, commit and pin the entire memory region 404 static char* reserve_memory_special(size_t size, size_t alignment, 405 char* addr, bool executable); 406 static bool release_memory_special(char* addr, size_t bytes); 407 static void large_page_init(); 408 static size_t large_page_size(); 409 static bool can_commit_large_page_memory(); 410 static bool can_execute_large_page_memory(); 411 412 // OS interface to polling page 413 static address get_polling_page() { return _polling_page; } 414 static void set_polling_page(address page) { _polling_page = page; } 415 static bool is_poll_address(address addr) { return addr >= _polling_page && addr < (_polling_page + os::vm_page_size()); } 416 static void make_polling_page_unreadable(); 417 static void make_polling_page_readable(); 418 419 // Check if pointer points to readable memory (by 4-byte read access) 420 static bool is_readable_pointer(const void* p); 421 static bool is_readable_range(const void* from, const void* to); 422 423 // Routines used to serialize the thread state without using membars 424 static void serialize_thread_states(); 425 426 // Since we write to the serialize page from every thread, we 427 // want stores to be on unique cache lines whenever possible 428 // in order to minimize CPU cross talk. We pre-compute the 429 // amount to shift the thread* to make this offset unique to 430 // each thread. 431 static int get_serialize_page_shift_count() { 432 return SerializePageShiftCount; 433 } 434 435 static void set_serialize_page_mask(uintptr_t mask) { 436 _serialize_page_mask = mask; 437 } 438 439 static unsigned int get_serialize_page_mask() { 440 return _serialize_page_mask; 441 } 442 443 static void set_memory_serialize_page(address page); 444 445 static address get_memory_serialize_page() { 446 return (address)_mem_serialize_page; 447 } 448 449 static inline void write_memory_serialize_page(JavaThread *thread) { 450 uintptr_t page_offset = ((uintptr_t)thread >> 451 get_serialize_page_shift_count()) & 452 get_serialize_page_mask(); 453 *(volatile int32_t *)((uintptr_t)_mem_serialize_page+page_offset) = 1; 454 } 455 456 static bool is_memory_serialize_page(JavaThread *thread, address addr) { 457 if (UseMembar) return false; 458 // Previously this function calculated the exact address of this 459 // thread's serialize page, and checked if the faulting address 460 // was equal. However, some platforms mask off faulting addresses 461 // to the page size, so now we just check that the address is 462 // within the page. This makes the thread argument unnecessary, 463 // but we retain the NULL check to preserve existing behavior. 464 if (thread == NULL) return false; 465 address page = (address) _mem_serialize_page; 466 return addr >= page && addr < (page + os::vm_page_size()); 467 } 468 469 static void block_on_serialize_page_trap(); 470 471 // threads 472 473 enum ThreadType { 474 vm_thread, 475 cgc_thread, // Concurrent GC thread 476 pgc_thread, // Parallel GC thread 477 java_thread, // Java, CodeCacheSweeper, JVMTIAgent and Service threads. 478 compiler_thread, 479 watcher_thread, 480 os_thread 481 }; 482 483 static bool create_thread(Thread* thread, 484 ThreadType thr_type, 485 size_t req_stack_size = 0); 486 487 // The "main thread", also known as "starting thread", is the thread 488 // that loads/creates the JVM via JNI_CreateJavaVM. 489 static bool create_main_thread(JavaThread* thread); 490 491 // The primordial thread is the initial process thread. The java 492 // launcher never uses the primordial thread as the main thread, but 493 // applications that host the JVM directly may do so. Some platforms 494 // need special-case handling of the primordial thread if it attaches 495 // to the VM. 496 static bool is_primordial_thread(void) 497 #if defined(_WINDOWS) || defined(BSD) 498 // No way to identify the primordial thread. 499 { return false; } 500 #else 501 ; 502 #endif 503 504 static bool create_attached_thread(JavaThread* thread); 505 static void pd_start_thread(Thread* thread); 506 static void start_thread(Thread* thread); 507 508 static void initialize_thread(Thread* thr); 509 static void free_thread(OSThread* osthread); 510 511 // thread id on Linux/64bit is 64bit, on Windows and Solaris, it's 32bit 512 static intx current_thread_id(); 513 static int current_process_id(); 514 static int sleep(Thread* thread, jlong ms, bool interruptable); 515 // Short standalone OS sleep suitable for slow path spin loop. 516 // Ignores Thread.interrupt() (so keep it short). 517 // ms = 0, will sleep for the least amount of time allowed by the OS. 518 static void naked_short_sleep(jlong ms); 519 static void infinite_sleep(); // never returns, use with CAUTION 520 static void naked_yield () ; 521 static OSReturn set_priority(Thread* thread, ThreadPriority priority); 522 static OSReturn get_priority(const Thread* const thread, ThreadPriority& priority); 523 524 static void interrupt(Thread* thread); 525 static bool is_interrupted(Thread* thread, bool clear_interrupted); 526 527 static int pd_self_suspend_thread(Thread* thread); 528 529 static ExtendedPC fetch_frame_from_context(const void* ucVoid, intptr_t** sp, intptr_t** fp); 530 static frame fetch_frame_from_context(const void* ucVoid); 531 static frame fetch_frame_from_ucontext(Thread* thread, void* ucVoid); 532 533 static void breakpoint(); 534 static bool start_debugging(char *buf, int buflen); 535 536 static address current_stack_pointer(); 537 static address current_stack_base(); 538 static size_t current_stack_size(); 539 540 static void verify_stack_alignment() PRODUCT_RETURN; 541 542 static bool message_box(const char* title, const char* message); 543 static char* do_you_want_to_debug(const char* message); 544 545 // run cmd in a separate process and return its exit code; or -1 on failures 546 static int fork_and_exec(char *cmd, bool use_vfork_if_available = false); 547 548 // Call ::exit() on all platforms but Windows 549 static void exit(int num); 550 551 // Terminate the VM, but don't exit the process 552 static void shutdown(); 553 554 // Terminate with an error. Default is to generate a core file on platforms 555 // that support such things. This calls shutdown() and then aborts. 556 static void abort(bool dump_core, void *siginfo, const void *context); 557 static void abort(bool dump_core = true); 558 559 // Die immediately, no exit hook, no abort hook, no cleanup. 560 static void die(); 561 562 // File i/o operations 563 static const int default_file_open_flags(); 564 static int open(const char *path, int oflag, int mode); 565 static FILE* open(int fd, const char* mode); 566 static FILE* fopen(const char* path, const char* mode); 567 static int close(int fd); 568 static jlong lseek(int fd, jlong offset, int whence); 569 // This function, on Windows, canonicalizes a given path (see os_windows.cpp for details). 570 // On Posix, this function is a noop: it does not change anything and just returns 571 // the input pointer. 572 static char* native_path(char *path); 573 static int ftruncate(int fd, jlong length); 574 static int fsync(int fd); 575 static int available(int fd, jlong *bytes); 576 static int get_fileno(FILE* fp); 577 static void flockfile(FILE* fp); 578 static void funlockfile(FILE* fp); 579 580 static int compare_file_modified_times(const char* file1, const char* file2); 581 582 //File i/o operations 583 584 static size_t read(int fd, void *buf, unsigned int nBytes); 585 static size_t read_at(int fd, void *buf, unsigned int nBytes, jlong offset); 586 static size_t restartable_read(int fd, void *buf, unsigned int nBytes); 587 static size_t write(int fd, const void *buf, unsigned int nBytes); 588 589 // Reading directories. 590 static DIR* opendir(const char* dirname); 591 static struct dirent* readdir(DIR* dirp); 592 static int closedir(DIR* dirp); 593 594 // Dynamic library extension 595 static const char* dll_file_extension(); 596 597 static const char* get_temp_directory(); 598 static const char* get_current_directory(char *buf, size_t buflen); 599 600 // Builds the platform-specific name of a library. 601 // Returns false if the buffer is too small. 602 static bool dll_build_name(char* buffer, size_t size, 603 const char* fname); 604 605 // Builds a platform-specific full library path given an ld path and 606 // unadorned library name. Returns true if the buffer contains a full 607 // path to an existing file, false otherwise. If pathname is empty, 608 // uses the path to the current directory. 609 static bool dll_locate_lib(char* buffer, size_t size, 610 const char* pathname, const char* fname); 611 612 // Symbol lookup, find nearest function name; basically it implements 613 // dladdr() for all platforms. Name of the nearest function is copied 614 // to buf. Distance from its base address is optionally returned as offset. 615 // If function name is not found, buf[0] is set to '\0' and offset is 616 // set to -1 (if offset is non-NULL). 617 static bool dll_address_to_function_name(address addr, char* buf, 618 int buflen, int* offset, 619 bool demangle = true); 620 621 // Locate DLL/DSO. On success, full path of the library is copied to 622 // buf, and offset is optionally set to be the distance between addr 623 // and the library's base address. On failure, buf[0] is set to '\0' 624 // and offset is set to -1 (if offset is non-NULL). 625 static bool dll_address_to_library_name(address addr, char* buf, 626 int buflen, int* offset); 627 628 // Find out whether the pc is in the static code for jvm.dll/libjvm.so. 629 static bool address_is_in_vm(address addr); 630 631 // Loads .dll/.so and 632 // in case of error it checks if .dll/.so was built for the 633 // same architecture as HotSpot is running on 634 static void* dll_load(const char *name, char *ebuf, int ebuflen); 635 636 // lookup symbol in a shared library 637 static void* dll_lookup(void* handle, const char* name); 638 639 // Unload library 640 static void dll_unload(void *lib); 641 642 // Callback for loaded module information 643 // Input parameters: 644 // char* module_file_name, 645 // address module_base_addr, 646 // address module_top_addr, 647 // void* param 648 typedef int (*LoadedModulesCallbackFunc)(const char *, address, address, void *); 649 650 static int get_loaded_modules_info(LoadedModulesCallbackFunc callback, void *param); 651 652 // Return the handle of this process 653 static void* get_default_process_handle(); 654 655 // Check for static linked agent library 656 static bool find_builtin_agent(AgentLibrary *agent_lib, const char *syms[], 657 size_t syms_len); 658 659 // Find agent entry point 660 static void *find_agent_function(AgentLibrary *agent_lib, bool check_lib, 661 const char *syms[], size_t syms_len); 662 663 // Provide C99 compliant versions of these functions, since some versions 664 // of some platforms don't. 665 static int vsnprintf(char* buf, size_t len, const char* fmt, va_list args) ATTRIBUTE_PRINTF(3, 0); 666 static int snprintf(char* buf, size_t len, const char* fmt, ...) ATTRIBUTE_PRINTF(3, 4); 667 668 // Get host name in buffer provided 669 static bool get_host_name(char* buf, size_t buflen); 670 671 // Print out system information; they are called by fatal error handler. 672 // Output format may be different on different platforms. 673 static void print_os_info(outputStream* st); 674 static void print_os_info_brief(outputStream* st); 675 static void print_cpu_info(outputStream* st, char* buf, size_t buflen); 676 static void pd_print_cpu_info(outputStream* st, char* buf, size_t buflen); 677 static void print_summary_info(outputStream* st, char* buf, size_t buflen); 678 static void print_memory_info(outputStream* st); 679 static void print_dll_info(outputStream* st); 680 static void print_environment_variables(outputStream* st, const char** env_list); 681 static void print_context(outputStream* st, const void* context); 682 static void print_register_info(outputStream* st, const void* context); 683 static void print_siginfo(outputStream* st, const void* siginfo); 684 static void print_signal_handlers(outputStream* st, char* buf, size_t buflen); 685 static void print_date_and_time(outputStream* st, char* buf, size_t buflen); 686 687 static void print_location(outputStream* st, intptr_t x, bool verbose = false); 688 static size_t lasterror(char *buf, size_t len); 689 static int get_last_error(); 690 691 // Replacement for strerror(). 692 // Will return the english description of the error (e.g. "File not found", as 693 // suggested in the POSIX standard. 694 // Will return "Unknown error" for an unknown errno value. 695 // Will not attempt to localize the returned string. 696 // Will always return a valid string which is a static constant. 697 // Will not change the value of errno. 698 static const char* strerror(int e); 699 700 // Will return the literalized version of the given errno (e.g. "EINVAL" 701 // for EINVAL). 702 // Will return "Unknown error" for an unknown errno value. 703 // Will always return a valid string which is a static constant. 704 // Will not change the value of errno. 705 static const char* errno_name(int e); 706 707 // Determines whether the calling process is being debugged by a user-mode debugger. 708 static bool is_debugger_attached(); 709 710 // wait for a key press if PauseAtExit is set 711 static void wait_for_keypress_at_exit(void); 712 713 // The following two functions are used by fatal error handler to trace 714 // native (C) frames. They are not part of frame.hpp/frame.cpp because 715 // frame.hpp/cpp assume thread is JavaThread, and also because different 716 // OS/compiler may have different convention or provide different API to 717 // walk C frames. 718 // 719 // We don't attempt to become a debugger, so we only follow frames if that 720 // does not require a lookup in the unwind table, which is part of the binary 721 // file but may be unsafe to read after a fatal error. So on x86, we can 722 // only walk stack if %ebp is used as frame pointer; on ia64, it's not 723 // possible to walk C stack without having the unwind table. 724 static bool is_first_C_frame(frame *fr); 725 static frame get_sender_for_C_frame(frame *fr); 726 727 // return current frame. pc() and sp() are set to NULL on failure. 728 static frame current_frame(); 729 730 static void print_hex_dump(outputStream* st, address start, address end, int unitsize); 731 732 // returns a string to describe the exception/signal; 733 // returns NULL if exception_code is not an OS exception/signal. 734 static const char* exception_name(int exception_code, char* buf, size_t buflen); 735 736 // Returns the signal number (e.g. 11) for a given signal name (SIGSEGV). 737 static int get_signal_number(const char* signal_name); 738 739 // Returns native Java library, loads if necessary 740 static void* native_java_library(); 741 742 // Fills in path to jvm.dll/libjvm.so (used by the Disassembler) 743 static void jvm_path(char *buf, jint buflen); 744 745 // JNI names 746 static void print_jni_name_prefix_on(outputStream* st, int args_size); 747 static void print_jni_name_suffix_on(outputStream* st, int args_size); 748 749 // Init os specific system properties values 750 static void init_system_properties_values(); 751 752 // IO operations, non-JVM_ version. 753 static int stat(const char* path, struct stat* sbuf); 754 static bool dir_is_empty(const char* path); 755 756 // IO operations on binary files 757 static int create_binary_file(const char* path, bool rewrite_existing); 758 static jlong current_file_offset(int fd); 759 static jlong seek_to_file_offset(int fd, jlong offset); 760 761 // Retrieve native stack frames. 762 // Parameter: 763 // stack: an array to storage stack pointers. 764 // frames: size of above array. 765 // toSkip: number of stack frames to skip at the beginning. 766 // Return: number of stack frames captured. 767 static int get_native_stack(address* stack, int size, int toSkip = 0); 768 769 // General allocation (must be MT-safe) 770 static void* malloc (size_t size, MEMFLAGS flags, const NativeCallStack& stack); 771 static void* malloc (size_t size, MEMFLAGS flags); 772 static void* realloc (void *memblock, size_t size, MEMFLAGS flag, const NativeCallStack& stack); 773 static void* realloc (void *memblock, size_t size, MEMFLAGS flag); 774 775 static void free (void *memblock); 776 static char* strdup(const char *, MEMFLAGS flags = mtInternal); // Like strdup 777 // Like strdup, but exit VM when strdup() returns NULL 778 static char* strdup_check_oom(const char*, MEMFLAGS flags = mtInternal); 779 780 #ifndef PRODUCT 781 static julong num_mallocs; // # of calls to malloc/realloc 782 static julong alloc_bytes; // # of bytes allocated 783 static julong num_frees; // # of calls to free 784 static julong free_bytes; // # of bytes freed 785 #endif 786 787 // SocketInterface (ex HPI SocketInterface ) 788 static int socket(int domain, int type, int protocol); 789 static int socket_close(int fd); 790 static int recv(int fd, char* buf, size_t nBytes, uint flags); 791 static int send(int fd, char* buf, size_t nBytes, uint flags); 792 static int raw_send(int fd, char* buf, size_t nBytes, uint flags); 793 static int connect(int fd, struct sockaddr* him, socklen_t len); 794 static struct hostent* get_host_by_name(char* name); 795 796 // Support for signals (see JVM_RaiseSignal, JVM_RegisterSignal) 797 static void initialize_jdk_signal_support(TRAPS); 798 static void signal_notify(int signal_number); 799 static void* signal(int signal_number, void* handler); 800 static void signal_raise(int signal_number); 801 static int signal_wait(); 802 static void* user_handler(); 803 static void terminate_signal_thread(); 804 static int sigexitnum_pd(); 805 806 // random number generation 807 static int random(); // return 32bit pseudorandom number 808 static void init_random(unsigned int initval); // initialize random sequence 809 810 // Structured OS Exception support 811 static void os_exception_wrapper(java_call_t f, JavaValue* value, const methodHandle& method, JavaCallArguments* args, Thread* thread); 812 813 // On Posix compatible OS it will simply check core dump limits while on Windows 814 // it will check if dump file can be created. Check or prepare a core dump to be 815 // taken at a later point in the same thread in os::abort(). Use the caller 816 // provided buffer as a scratch buffer. The status message which will be written 817 // into the error log either is file location or a short error message, depending 818 // on the checking result. 819 static void check_dump_limit(char* buffer, size_t bufferSize); 820 821 // Get the default path to the core file 822 // Returns the length of the string 823 static int get_core_path(char* buffer, size_t bufferSize); 824 825 // JVMTI & JVM monitoring and management support 826 // The thread_cpu_time() and current_thread_cpu_time() are only 827 // supported if is_thread_cpu_time_supported() returns true. 828 // They are not supported on Solaris T1. 829 830 // Thread CPU Time - return the fast estimate on a platform 831 // On Solaris - call gethrvtime (fast) - user time only 832 // On Linux - fast clock_gettime where available - user+sys 833 // - otherwise: very slow /proc fs - user+sys 834 // On Windows - GetThreadTimes - user+sys 835 static jlong current_thread_cpu_time(); 836 static jlong thread_cpu_time(Thread* t); 837 838 // Thread CPU Time with user_sys_cpu_time parameter. 839 // 840 // If user_sys_cpu_time is true, user+sys time is returned. 841 // Otherwise, only user time is returned 842 static jlong current_thread_cpu_time(bool user_sys_cpu_time); 843 static jlong thread_cpu_time(Thread* t, bool user_sys_cpu_time); 844 845 // Return a bunch of info about the timers. 846 // Note that the returned info for these two functions may be different 847 // on some platforms 848 static void current_thread_cpu_time_info(jvmtiTimerInfo *info_ptr); 849 static void thread_cpu_time_info(jvmtiTimerInfo *info_ptr); 850 851 static bool is_thread_cpu_time_supported(); 852 853 // System loadavg support. Returns -1 if load average cannot be obtained. 854 static int loadavg(double loadavg[], int nelem); 855 856 // Hook for os specific jvm options that we don't want to abort on seeing 857 static bool obsolete_option(const JavaVMOption *option); 858 859 // Amount beyond the callee frame size that we bang the stack. 860 static int extra_bang_size_in_bytes(); 861 862 static char** split_path(const char* path, int* n); 863 864 // Extensions 865 #include "runtime/os_ext.hpp" 866 867 public: 868 class CrashProtectionCallback : public StackObj { 869 public: 870 virtual void call() = 0; 871 }; 872 873 // Platform dependent stuff 874 #ifndef _WINDOWS 875 # include "os_posix.hpp" 876 #endif 877 #include OS_CPU_HEADER(os) 878 #include OS_HEADER(os) 879 880 #ifndef OS_NATIVE_THREAD_CREATION_FAILED_MSG 881 #define OS_NATIVE_THREAD_CREATION_FAILED_MSG "unable to create native thread: possibly out of memory or process/resource limits reached" 882 #endif 883 884 public: 885 #ifndef PLATFORM_PRINT_NATIVE_STACK 886 // No platform-specific code for printing the native stack. 887 static bool platform_print_native_stack(outputStream* st, const void* context, 888 char *buf, int buf_size) { 889 return false; 890 } 891 #endif 892 893 // debugging support (mostly used by debug.cpp but also fatal error handler) 894 static bool find(address pc, outputStream* st = tty); // OS specific function to make sense out of an address 895 896 static bool dont_yield(); // when true, JVM_Yield() is nop 897 static void print_statistics(); 898 899 // Thread priority helpers (implemented in OS-specific part) 900 static OSReturn set_native_priority(Thread* thread, int native_prio); 901 static OSReturn get_native_priority(const Thread* const thread, int* priority_ptr); 902 static int java_to_os_priority[CriticalPriority + 1]; 903 // Hint to the underlying OS that a task switch would not be good. 904 // Void return because it's a hint and can fail. 905 static const char* native_thread_creation_failed_msg() { 906 return OS_NATIVE_THREAD_CREATION_FAILED_MSG; 907 } 908 909 // Used at creation if requested by the diagnostic flag PauseAtStartup. 910 // Causes the VM to wait until an external stimulus has been applied 911 // (for Unix, that stimulus is a signal, for Windows, an external 912 // ResumeThread call) 913 static void pause(); 914 915 // Builds a platform dependent Agent_OnLoad_<libname> function name 916 // which is used to find statically linked in agents. 917 static char* build_agent_function_name(const char *sym, const char *cname, 918 bool is_absolute_path); 919 920 class SuspendedThreadTaskContext { 921 public: 922 SuspendedThreadTaskContext(Thread* thread, void *ucontext) : _thread(thread), _ucontext(ucontext) {} 923 Thread* thread() const { return _thread; } 924 void* ucontext() const { return _ucontext; } 925 private: 926 Thread* _thread; 927 void* _ucontext; 928 }; 929 930 class SuspendedThreadTask { 931 public: 932 SuspendedThreadTask(Thread* thread) : _thread(thread), _done(false) {} 933 void run(); 934 bool is_done() { return _done; } 935 virtual void do_task(const SuspendedThreadTaskContext& context) = 0; 936 protected: 937 ~SuspendedThreadTask() {} 938 private: 939 void internal_do_task(); 940 Thread* _thread; 941 bool _done; 942 }; 943 944 #ifndef _WINDOWS 945 // Suspend/resume support 946 // Protocol: 947 // 948 // a thread starts in SR_RUNNING 949 // 950 // SR_RUNNING can go to 951 // * SR_SUSPEND_REQUEST when the WatcherThread wants to suspend it 952 // SR_SUSPEND_REQUEST can go to 953 // * SR_RUNNING if WatcherThread decides it waited for SR_SUSPENDED too long (timeout) 954 // * SR_SUSPENDED if the stopped thread receives the signal and switches state 955 // SR_SUSPENDED can go to 956 // * SR_WAKEUP_REQUEST when the WatcherThread has done the work and wants to resume 957 // SR_WAKEUP_REQUEST can go to 958 // * SR_RUNNING when the stopped thread receives the signal 959 // * SR_WAKEUP_REQUEST on timeout (resend the signal and try again) 960 class SuspendResume { 961 public: 962 enum State { 963 SR_RUNNING, 964 SR_SUSPEND_REQUEST, 965 SR_SUSPENDED, 966 SR_WAKEUP_REQUEST 967 }; 968 969 private: 970 volatile State _state; 971 972 private: 973 /* try to switch state from state "from" to state "to" 974 * returns the state set after the method is complete 975 */ 976 State switch_state(State from, State to); 977 978 public: 979 SuspendResume() : _state(SR_RUNNING) { } 980 981 State state() const { return _state; } 982 983 State request_suspend() { 984 return switch_state(SR_RUNNING, SR_SUSPEND_REQUEST); 985 } 986 987 State cancel_suspend() { 988 return switch_state(SR_SUSPEND_REQUEST, SR_RUNNING); 989 } 990 991 State suspended() { 992 return switch_state(SR_SUSPEND_REQUEST, SR_SUSPENDED); 993 } 994 995 State request_wakeup() { 996 return switch_state(SR_SUSPENDED, SR_WAKEUP_REQUEST); 997 } 998 999 State running() { 1000 return switch_state(SR_WAKEUP_REQUEST, SR_RUNNING); 1001 } 1002 1003 bool is_running() const { 1004 return _state == SR_RUNNING; 1005 } 1006 1007 bool is_suspend_request() const { 1008 return _state == SR_SUSPEND_REQUEST; 1009 } 1010 1011 bool is_suspended() const { 1012 return _state == SR_SUSPENDED; 1013 } 1014 }; 1015 #endif // !WINDOWS 1016 1017 1018 protected: 1019 static volatile unsigned int _rand_seed; // seed for random number generator 1020 static int _processor_count; // number of processors 1021 static int _initial_active_processor_count; // number of active processors during initialization. 1022 1023 static char* format_boot_path(const char* format_string, 1024 const char* home, 1025 int home_len, 1026 char fileSep, 1027 char pathSep); 1028 static bool set_boot_path(char fileSep, char pathSep); 1029 1030 }; 1031 1032 #ifndef _WINDOWS 1033 template<> struct IsRegisteredEnum<os::SuspendResume::State> : public TrueType {}; 1034 #endif // !_WINDOWS 1035 1036 // Note that "PAUSE" is almost always used with synchronization 1037 // so arguably we should provide Atomic::SpinPause() instead 1038 // of the global SpinPause() with C linkage. 1039 // It'd also be eligible for inlining on many platforms. 1040 1041 extern "C" int SpinPause(); 1042 1043 #endif // SHARE_VM_RUNTIME_OS_HPP