os.hpp revision 342:37f87013dfd8
1/* 2 * Copyright 1997-2007 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 20 * CA 95054 USA or visit www.sun.com if you need additional information or 21 * have any questions. 22 * 23 */ 24 25// os defines the interface to operating system; this includes traditional 26// OS services (time, I/O) as well as other functionality with system- 27// dependent code. 28 29typedef void (*dll_func)(...); 30 31class Thread; 32class JavaThread; 33class Event; 34class DLL; 35class FileHandle; 36template<class E> class GrowableArray; 37 38// %%%%% Moved ThreadState, START_FN, OSThread to new osThread.hpp. -- Rose 39 40// Platform-independent error return values from OS functions 41enum OSReturn { 42 OS_OK = 0, // Operation was successful 43 OS_ERR = -1, // Operation failed 44 OS_INTRPT = -2, // Operation was interrupted 45 OS_TIMEOUT = -3, // Operation timed out 46 OS_NOMEM = -5, // Operation failed for lack of memory 47 OS_NORESOURCE = -6 // Operation failed for lack of nonmemory resource 48}; 49 50enum ThreadPriority { // JLS 20.20.1-3 51 NoPriority = -1, // Initial non-priority value 52 MinPriority = 1, // Minimum priority 53 NormPriority = 5, // Normal (non-daemon) priority 54 NearMaxPriority = 9, // High priority, used for VMThread 55 MaxPriority = 10 // Highest priority, used for WatcherThread 56 // ensures that VMThread doesn't starve profiler 57}; 58 59// Typedef for structured exception handling support 60typedef void (*java_call_t)(JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread); 61 62class os: AllStatic { 63 private: 64 enum { page_sizes_max = 9 }; // Size of _page_sizes array (8 plus a sentinel) 65 66 static OSThread* _starting_thread; 67 static address _polling_page; 68 static volatile int32_t * _mem_serialize_page; 69 static uintptr_t _serialize_page_mask; 70 static size_t _page_sizes[page_sizes_max]; 71 72 static void init_page_sizes(size_t default_page_size) { 73 _page_sizes[0] = default_page_size; 74 _page_sizes[1] = 0; // sentinel 75 } 76 77 public: 78 79 static void init(void); // Called before command line parsing 80 static jint init_2(void); // Called after command line parsing 81 82 // File names are case-insensitive on windows only 83 // Override me as needed 84 static int file_name_strcmp(const char* s1, const char* s2); 85 86 static bool getenv(const char* name, char* buffer, int len); 87 static bool have_special_privileges(); 88 89 static jlong javaTimeMillis(); 90 static jlong javaTimeNanos(); 91 static void javaTimeNanos_info(jvmtiTimerInfo *info_ptr); 92 static void run_periodic_checks(); 93 94 95 // Returns the elapsed time in seconds since the vm started. 96 static double elapsedTime(); 97 98 // Returns real time in seconds since an arbitrary point 99 // in the past. 100 static bool getTimesSecs(double* process_real_time, 101 double* process_user_time, 102 double* process_system_time); 103 104 // Interface to the performance counter 105 static jlong elapsed_counter(); 106 static jlong elapsed_frequency(); 107 108 // The "virtual time" of a thread is the amount of time a thread has 109 // actually run. The first function indicates whether the OS supports 110 // this functionality for the current thread, and if so: 111 // * the second enables vtime tracking (if that is required). 112 // * the third tells whether vtime is enabled. 113 // * the fourth returns the elapsed virtual time for the current 114 // thread. 115 static bool supports_vtime(); 116 static bool enable_vtime(); 117 static bool vtime_enabled(); 118 static double elapsedVTime(); 119 120 // Return current local time in a string (YYYY-MM-DD HH:MM:SS). 121 // It is MT safe, but not async-safe, as reading time zone 122 // information may require a lock on some platforms. 123 static char* local_time_string(char *buf, size_t buflen); 124 // Fill in buffer with current local time as an ISO-8601 string. 125 // E.g., YYYY-MM-DDThh:mm:ss.mmm+zzzz. 126 // Returns buffer, or NULL if it failed. 127 static char* iso8601_time(char* buffer, size_t buffer_length); 128 129 // Interface for detecting multiprocessor system 130 static inline bool is_MP() { 131 assert(_processor_count > 0, "invalid processor count"); 132 return _processor_count > 1; 133 } 134 static julong available_memory(); 135 static julong physical_memory(); 136 static julong allocatable_physical_memory(julong size); 137 static bool is_server_class_machine(); 138 139 // number of CPUs 140 static int processor_count() { 141 return _processor_count; 142 } 143 144 // Returns the number of CPUs this process is currently allowed to run on. 145 // Note that on some OSes this can change dynamically. 146 static int active_processor_count(); 147 148 // Bind processes to processors. 149 // This is a two step procedure: 150 // first you generate a distribution of processes to processors, 151 // then you bind processes according to that distribution. 152 // Compute a distribution for number of processes to processors. 153 // Stores the processor id's into the distribution array argument. 154 // Returns true if it worked, false if it didn't. 155 static bool distribute_processes(uint length, uint* distribution); 156 // Binds the current process to a processor. 157 // Returns true if it worked, false if it didn't. 158 static bool bind_to_processor(uint processor_id); 159 160 // Interface for stack banging (predetect possible stack overflow for 161 // exception processing) There are guard pages, and above that shadow 162 // pages for stack overflow checking. 163 static bool uses_stack_guard_pages(); 164 static bool allocate_stack_guard_pages(); 165 static void bang_stack_shadow_pages(); 166 static bool stack_shadow_pages_available(Thread *thread, methodHandle method); 167 168 // OS interface to Virtual Memory 169 170 // Return the default page size. 171 static int vm_page_size(); 172 173 // Return the page size to use for a region of memory. The min_pages argument 174 // is a hint intended to limit fragmentation; it says the returned page size 175 // should be <= region_max_size / min_pages. Because min_pages is a hint, 176 // this routine may return a size larger than region_max_size / min_pages. 177 // 178 // The current implementation ignores min_pages if a larger page size is an 179 // exact multiple of both region_min_size and region_max_size. This allows 180 // larger pages to be used when doing so would not cause fragmentation; in 181 // particular, a single page can be used when region_min_size == 182 // region_max_size == a supported page size. 183 static size_t page_size_for_region(size_t region_min_size, 184 size_t region_max_size, 185 uint min_pages); 186 187 // Method for tracing page sizes returned by the above method; enabled by 188 // TracePageSizes. The region_{min,max}_size parameters should be the values 189 // passed to page_size_for_region() and page_size should be the result of that 190 // call. The (optional) base and size parameters should come from the 191 // ReservedSpace base() and size() methods. 192 static void trace_page_sizes(const char* str, const size_t region_min_size, 193 const size_t region_max_size, 194 const size_t page_size, 195 const char* base = NULL, 196 const size_t size = 0) PRODUCT_RETURN; 197 198 static int vm_allocation_granularity(); 199 static char* reserve_memory(size_t bytes, char* addr = 0, 200 size_t alignment_hint = 0); 201 static char* attempt_reserve_memory_at(size_t bytes, char* addr); 202 static void split_reserved_memory(char *base, size_t size, 203 size_t split, bool realloc); 204 static bool commit_memory(char* addr, size_t bytes); 205 static bool commit_memory(char* addr, size_t size, size_t alignment_hint); 206 static bool uncommit_memory(char* addr, size_t bytes); 207 static bool release_memory(char* addr, size_t bytes); 208 static bool protect_memory(char* addr, size_t bytes); 209 static bool guard_memory(char* addr, size_t bytes); 210 static bool unguard_memory(char* addr, size_t bytes); 211 static char* map_memory(int fd, const char* file_name, size_t file_offset, 212 char *addr, size_t bytes, bool read_only = false, 213 bool allow_exec = false); 214 static char* remap_memory(int fd, const char* file_name, size_t file_offset, 215 char *addr, size_t bytes, bool read_only, 216 bool allow_exec); 217 static bool unmap_memory(char *addr, size_t bytes); 218 static void free_memory(char *addr, size_t bytes); 219 static void realign_memory(char *addr, size_t bytes, size_t alignment_hint); 220 221 // NUMA-specific interface 222 static bool numa_has_static_binding(); 223 static bool numa_has_group_homing(); 224 static void numa_make_local(char *addr, size_t bytes, int lgrp_hint); 225 static void numa_make_global(char *addr, size_t bytes); 226 static size_t numa_get_groups_num(); 227 static size_t numa_get_leaf_groups(int *ids, size_t size); 228 static bool numa_topology_changed(); 229 static int numa_get_group_id(); 230 231 // Page manipulation 232 struct page_info { 233 size_t size; 234 int lgrp_id; 235 }; 236 static bool get_page_info(char *start, page_info* info); 237 static char* scan_pages(char *start, char* end, page_info* page_expected, page_info* page_found); 238 239 static char* non_memory_address_word(); 240 // reserve, commit and pin the entire memory region 241 static char* reserve_memory_special(size_t size); 242 static bool release_memory_special(char* addr, size_t bytes); 243 static bool large_page_init(); 244 static size_t large_page_size(); 245 static bool can_commit_large_page_memory(); 246 static bool can_execute_large_page_memory(); 247 248 // OS interface to polling page 249 static address get_polling_page() { return _polling_page; } 250 static void set_polling_page(address page) { _polling_page = page; } 251 static bool is_poll_address(address addr) { return addr >= _polling_page && addr < (_polling_page + os::vm_page_size()); } 252 static void make_polling_page_unreadable(); 253 static void make_polling_page_readable(); 254 255 // Routines used to serialize the thread state without using membars 256 static void serialize_thread_states(); 257 258 // Since we write to the serialize page from every thread, we 259 // want stores to be on unique cache lines whenever possible 260 // in order to minimize CPU cross talk. We pre-compute the 261 // amount to shift the thread* to make this offset unique to 262 // each thread. 263 static int get_serialize_page_shift_count() { 264 return SerializePageShiftCount; 265 } 266 267 static void set_serialize_page_mask(uintptr_t mask) { 268 _serialize_page_mask = mask; 269 } 270 271 static unsigned int get_serialize_page_mask() { 272 return _serialize_page_mask; 273 } 274 275 static void set_memory_serialize_page(address page); 276 277 static address get_memory_serialize_page() { 278 return (address)_mem_serialize_page; 279 } 280 281 static inline void write_memory_serialize_page(JavaThread *thread) { 282 uintptr_t page_offset = ((uintptr_t)thread >> 283 get_serialize_page_shift_count()) & 284 get_serialize_page_mask(); 285 *(volatile int32_t *)((uintptr_t)_mem_serialize_page+page_offset) = 1; 286 } 287 288 static bool is_memory_serialize_page(JavaThread *thread, address addr) { 289 address thr_addr; 290 if (UseMembar) return false; 291 // Calculate thread specific address 292 if (thread == NULL) return false; 293 // TODO-FIXME: some platforms mask off faulting addresses to the base pagesize. 294 // Instead of using a test for equality we should probably use something 295 // of the form: 296 // return ((_mem_serialize_page ^ addr) & -pagesize) == 0 297 // 298 thr_addr = (address)(((uintptr_t)thread >> 299 get_serialize_page_shift_count()) & 300 get_serialize_page_mask()) + (uintptr_t)_mem_serialize_page; 301 return (thr_addr == addr); 302 } 303 304 static void block_on_serialize_page_trap(); 305 306 // threads 307 308 enum ThreadType { 309 vm_thread, 310 cgc_thread, // Concurrent GC thread 311 pgc_thread, // Parallel GC thread 312 java_thread, 313 compiler_thread, 314 watcher_thread 315 }; 316 317 static bool create_thread(Thread* thread, 318 ThreadType thr_type, 319 size_t stack_size = 0); 320 static bool create_main_thread(JavaThread* thread); 321 static bool create_attached_thread(JavaThread* thread); 322 static void pd_start_thread(Thread* thread); 323 static void start_thread(Thread* thread); 324 325 static void initialize_thread(); 326 static void free_thread(OSThread* osthread); 327 328 // thread id on Linux/64bit is 64bit, on Windows and Solaris, it's 32bit 329 static intx current_thread_id(); 330 static int current_process_id(); 331 // hpi::read for calls from non native state 332 // For performance, hpi::read is only callable from _thread_in_native 333 static size_t read(int fd, void *buf, unsigned int nBytes); 334 static int sleep(Thread* thread, jlong ms, bool interruptable); 335 static int naked_sleep(); 336 static void infinite_sleep(); // never returns, use with CAUTION 337 static void yield(); // Yields to all threads with same priority 338 enum YieldResult { 339 YIELD_SWITCHED = 1, // caller descheduled, other ready threads exist & ran 340 YIELD_NONEREADY = 0, // No other runnable/ready threads. 341 // platform-specific yield return immediately 342 YIELD_UNKNOWN = -1 // Unknown: platform doesn't support _SWITCHED or _NONEREADY 343 // YIELD_SWITCHED and YIELD_NONREADY imply the platform supports a "strong" 344 // yield that can be used in lieu of blocking. 345 } ; 346 static YieldResult NakedYield () ; 347 static void yield_all(int attempts = 0); // Yields to all other threads including lower priority 348 static void loop_breaker(int attempts); // called from within tight loops to possibly influence time-sharing 349 static OSReturn set_priority(Thread* thread, ThreadPriority priority); 350 static OSReturn get_priority(const Thread* const thread, ThreadPriority& priority); 351 352 static void interrupt(Thread* thread); 353 static bool is_interrupted(Thread* thread, bool clear_interrupted); 354 355 static int pd_self_suspend_thread(Thread* thread); 356 357 static ExtendedPC fetch_frame_from_context(void* ucVoid, intptr_t** sp, intptr_t** fp); 358 static frame fetch_frame_from_context(void* ucVoid); 359 360 static ExtendedPC get_thread_pc(Thread *thread); 361 static void breakpoint(); 362 363 static address current_stack_pointer(); 364 static address current_stack_base(); 365 static size_t current_stack_size(); 366 367 static int message_box(const char* title, const char* message); 368 static char* do_you_want_to_debug(const char* message); 369 370 // run cmd in a separate process and return its exit code; or -1 on failures 371 static int fork_and_exec(char *cmd); 372 373 // Set file to send error reports. 374 static void set_error_file(const char *logfile); 375 376 // os::exit() is merged with vm_exit() 377 // static void exit(int num); 378 379 // Terminate the VM, but don't exit the process 380 static void shutdown(); 381 382 // Terminate with an error. Default is to generate a core file on platforms 383 // that support such things. This calls shutdown() and then aborts. 384 static void abort(bool dump_core = true); 385 386 // Die immediately, no exit hook, no abort hook, no cleanup. 387 static void die(); 388 389 // Reading directories. 390 static DIR* opendir(const char* dirname); 391 static int readdir_buf_size(const char *path); 392 static struct dirent* readdir(DIR* dirp, dirent* dbuf); 393 static int closedir(DIR* dirp); 394 395 // Dynamic library extension 396 static const char* dll_file_extension(); 397 398 static const char* get_temp_directory(); 399 static const char* get_current_directory(char *buf, int buflen); 400 401 // Symbol lookup, find nearest function name; basically it implements 402 // dladdr() for all platforms. Name of the nearest function is copied 403 // to buf. Distance from its base address is returned as offset. 404 // If function name is not found, buf[0] is set to '\0' and offset is 405 // set to -1. 406 static bool dll_address_to_function_name(address addr, char* buf, 407 int buflen, int* offset); 408 409 // Locate DLL/DSO. On success, full path of the library is copied to 410 // buf, and offset is set to be the distance between addr and the 411 // library's base address. On failure, buf[0] is set to '\0' and 412 // offset is set to -1. 413 static bool dll_address_to_library_name(address addr, char* buf, 414 int buflen, int* offset); 415 416 // Find out whether the pc is in the static code for jvm.dll/libjvm.so. 417 static bool address_is_in_vm(address addr); 418 419 // Loads .dll/.so and 420 // in case of error it checks if .dll/.so was built for the 421 // same architecture as Hotspot is running on 422 static void* dll_load(const char *name, char *ebuf, int ebuflen); 423 424 // Print out system information; they are called by fatal error handler. 425 // Output format may be different on different platforms. 426 static void print_os_info(outputStream* st); 427 static void print_cpu_info(outputStream* st); 428 static void print_memory_info(outputStream* st); 429 static void print_dll_info(outputStream* st); 430 static void print_environment_variables(outputStream* st, const char** env_list, char* buffer, int len); 431 static void print_context(outputStream* st, void* context); 432 static void print_siginfo(outputStream* st, void* siginfo); 433 static void print_signal_handlers(outputStream* st, char* buf, size_t buflen); 434 static void print_date_and_time(outputStream* st); 435 436 // The following two functions are used by fatal error handler to trace 437 // native (C) frames. They are not part of frame.hpp/frame.cpp because 438 // frame.hpp/cpp assume thread is JavaThread, and also because different 439 // OS/compiler may have different convention or provide different API to 440 // walk C frames. 441 // 442 // We don't attempt to become a debugger, so we only follow frames if that 443 // does not require a lookup in the unwind table, which is part of the binary 444 // file but may be unsafe to read after a fatal error. So on x86, we can 445 // only walk stack if %ebp is used as frame pointer; on ia64, it's not 446 // possible to walk C stack without having the unwind table. 447 static bool is_first_C_frame(frame *fr); 448 static frame get_sender_for_C_frame(frame *fr); 449 450 // return current frame. pc() and sp() are set to NULL on failure. 451 static frame current_frame(); 452 453 static void print_hex_dump(outputStream* st, address start, address end, int unitsize); 454 455 // returns a string to describe the exception/signal; 456 // returns NULL if exception_code is not an OS exception/signal. 457 static const char* exception_name(int exception_code, char* buf, size_t buflen); 458 459 // Returns native Java library, loads if necessary 460 static void* native_java_library(); 461 462 // Fills in path to jvm.dll/libjvm.so (this info used to find hpi). 463 static void jvm_path(char *buf, jint buflen); 464 465 // JNI names 466 static void print_jni_name_prefix_on(outputStream* st, int args_size); 467 static void print_jni_name_suffix_on(outputStream* st, int args_size); 468 469 // File conventions 470 static const char* file_separator(); 471 static const char* line_separator(); 472 static const char* path_separator(); 473 474 // Init os specific system properties values 475 static void init_system_properties_values(); 476 477 // IO operations, non-JVM_ version. 478 static int stat(const char* path, struct stat* sbuf); 479 static bool dir_is_empty(const char* path); 480 481 // IO operations on binary files 482 static int create_binary_file(const char* path, bool rewrite_existing); 483 static jlong current_file_offset(int fd); 484 static jlong seek_to_file_offset(int fd, jlong offset); 485 486 // Thread Local Storage 487 static int allocate_thread_local_storage(); 488 static void thread_local_storage_at_put(int index, void* value); 489 static void* thread_local_storage_at(int index); 490 static void free_thread_local_storage(int index); 491 492 // General allocation (must be MT-safe) 493 static void* malloc (size_t size); 494 static void* realloc (void *memblock, size_t size); 495 static void free (void *memblock); 496 static bool check_heap(bool force = false); // verify C heap integrity 497 static char* strdup(const char *); // Like strdup 498 499#ifndef PRODUCT 500 static int num_mallocs; // # of calls to malloc/realloc 501 static size_t alloc_bytes; // # of bytes allocated 502 static int num_frees; // # of calls to free 503#endif 504 505 // Printing 64 bit integers 506 static const char* jlong_format_specifier(); 507 static const char* julong_format_specifier(); 508 509 // Support for signals (see JVM_RaiseSignal, JVM_RegisterSignal) 510 static void signal_init(); 511 static void signal_init_pd(); 512 static void signal_notify(int signal_number); 513 static void* signal(int signal_number, void* handler); 514 static void signal_raise(int signal_number); 515 static int signal_wait(); 516 static int signal_lookup(); 517 static void* user_handler(); 518 static void terminate_signal_thread(); 519 static int sigexitnum_pd(); 520 521 // random number generation 522 static long random(); // return 32bit pseudorandom number 523 static void init_random(long initval); // initialize random sequence 524 525 // Structured OS Exception support 526 static void os_exception_wrapper(java_call_t f, JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread); 527 528 // JVMTI & JVM monitoring and management support 529 // The thread_cpu_time() and current_thread_cpu_time() are only 530 // supported if is_thread_cpu_time_supported() returns true. 531 // They are not supported on Solaris T1. 532 533 // Thread CPU Time - return the fast estimate on a platform 534 // On Solaris - call gethrvtime (fast) - user time only 535 // On Linux - fast clock_gettime where available - user+sys 536 // - otherwise: very slow /proc fs - user+sys 537 // On Windows - GetThreadTimes - user+sys 538 static jlong current_thread_cpu_time(); 539 static jlong thread_cpu_time(Thread* t); 540 541 // Thread CPU Time with user_sys_cpu_time parameter. 542 // 543 // If user_sys_cpu_time is true, user+sys time is returned. 544 // Otherwise, only user time is returned 545 static jlong current_thread_cpu_time(bool user_sys_cpu_time); 546 static jlong thread_cpu_time(Thread* t, bool user_sys_cpu_time); 547 548 // Return a bunch of info about the timers. 549 // Note that the returned info for these two functions may be different 550 // on some platforms 551 static void current_thread_cpu_time_info(jvmtiTimerInfo *info_ptr); 552 static void thread_cpu_time_info(jvmtiTimerInfo *info_ptr); 553 554 static bool is_thread_cpu_time_supported(); 555 556 // System loadavg support. Returns -1 if load average cannot be obtained. 557 static int loadavg(double loadavg[], int nelem); 558 559 // Hook for os specific jvm options that we don't want to abort on seeing 560 static bool obsolete_option(const JavaVMOption *option); 561 562 // Platform dependent stuff 563 #include "incls/_os_pd.hpp.incl" 564 565 // debugging support (mostly used by debug.cpp) 566 static bool find(address pc) PRODUCT_RETURN0; // OS specific function to make sense out of an address 567 568 static bool dont_yield(); // when true, JVM_Yield() is nop 569 static void print_statistics(); 570 571 // Thread priority helpers (implemented in OS-specific part) 572 static OSReturn set_native_priority(Thread* thread, int native_prio); 573 static OSReturn get_native_priority(const Thread* const thread, int* priority_ptr); 574 static int java_to_os_priority[MaxPriority + 1]; 575 // Hint to the underlying OS that a task switch would not be good. 576 // Void return because it's a hint and can fail. 577 static void hint_no_preempt(); 578 579 // Used at creation if requested by the diagnostic flag PauseAtStartup. 580 // Causes the VM to wait until an external stimulus has been applied 581 // (for Unix, that stimulus is a signal, for Windows, an external 582 // ResumeThread call) 583 static void pause(); 584 585 protected: 586 static long _rand_seed; // seed for random number generator 587 static int _processor_count; // number of processors 588 589 static char* format_boot_path(const char* format_string, 590 const char* home, 591 int home_len, 592 char fileSep, 593 char pathSep); 594 static bool set_boot_path(char fileSep, char pathSep); 595}; 596 597// Note that "PAUSE" is almost always used with synchronization 598// so arguably we should provide Atomic::SpinPause() instead 599// of the global SpinPause() with C linkage. 600// It'd also be eligible for inlining on many platforms. 601 602extern "C" int SpinPause () ; 603extern "C" int SafeFetch32 (int * adr, int errValue) ; 604extern "C" intptr_t SafeFetchN (intptr_t * adr, intptr_t errValue) ; 605