rev 55555 : [mq]: nestegg

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