os.hpp revision 3171:da4be62fb889
1281843Sdteske/*
2222417Sjulian * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3222417Sjulian * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4222417Sjulian *
5222417Sjulian * This code is free software; you can redistribute it and/or modify it
6222417Sjulian * under the terms of the GNU General Public License version 2 only, as
7222417Sjulian * published by the Free Software Foundation.
8222417Sjulian *
9222417Sjulian * This code is distributed in the hope that it will be useful, but WITHOUT
10222417Sjulian * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11222417Sjulian * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12222417Sjulian * version 2 for more details (a copy is included in the LICENSE file that
13222417Sjulian * accompanied this code).
14222417Sjulian *
15222417Sjulian * You should have received a copy of the GNU General Public License version
16222417Sjulian * 2 along with this work; if not, write to the Free Software Foundation,
17222417Sjulian * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18222417Sjulian *
19222417Sjulian * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20222417Sjulian * or visit www.oracle.com if you need additional information or have any
21222417Sjulian * questions.
22222417Sjulian *
23222417Sjulian */
24222417Sjulian
25222417Sjulian#ifndef SHARE_VM_RUNTIME_OS_HPP
26222417Sjulian#define SHARE_VM_RUNTIME_OS_HPP
27222417Sjulian
28222417Sjulian#include "jvmtifiles/jvmti.h"
29242667Sdteske#include "runtime/atomic.hpp"
30242667Sdteske#include "runtime/extendedPC.hpp"
31281843Sdteske#include "runtime/handles.hpp"
32281843Sdteske#include "utilities/top.hpp"
33241523Sdteske#ifdef TARGET_OS_FAMILY_linux
34241523Sdteske# include "jvm_linux.h"
35262701Sdteske#endif
36262701Sdteske#ifdef TARGET_OS_FAMILY_solaris
37241523Sdteske# include "jvm_solaris.h"
38281843Sdteske#endif
39281843Sdteske#ifdef TARGET_OS_FAMILY_windows
40243114Sdteske# include "jvm_windows.h"
41243660Sdteske#endif
42243660Sdteske#ifdef TARGET_OS_FAMILY_bsd
43243660Sdteske# include "jvm_bsd.h"
44243660Sdteske#endif
45243660Sdteske
46243660Sdteske// os defines the interface to operating system; this includes traditional
47243660Sdteske// OS services (time, I/O) as well as other functionality with system-
48243660Sdteske// dependent code.
49243660Sdteske
50243660Sdtesketypedef void (*dll_func)(...);
51243660Sdteske
52243660Sdteskeclass Thread;
53243660Sdteskeclass JavaThread;
54243660Sdteskeclass Event;
55243660Sdteskeclass DLL;
56243660Sdteskeclass FileHandle;
57243660Sdtesketemplate<class E> class GrowableArray;
58243660Sdteske
59243660Sdteske// %%%%% Moved ThreadState, START_FN, OSThread to new osThread.hpp. -- Rose
60243660Sdteske
61243660Sdteske// Platform-independent error return values from OS functions
62243660Sdteskeenum OSReturn {
63243660Sdteske  OS_OK         =  0,        // Operation was successful
64243660Sdteske  OS_ERR        = -1,        // Operation failed
65243660Sdteske  OS_INTRPT     = -2,        // Operation was interrupted
66243660Sdteske  OS_TIMEOUT    = -3,        // Operation timed out
67243660Sdteske  OS_NOMEM      = -5,        // Operation failed for lack of memory
68243660Sdteske  OS_NORESOURCE = -6         // Operation failed for lack of nonmemory resource
69243660Sdteske};
70243660Sdteske
71243660Sdteskeenum ThreadPriority {        // JLS 20.20.1-3
72243660Sdteske  NoPriority       = -1,     // Initial non-priority value
73243660Sdteske  MinPriority      =  1,     // Minimum priority
74281843Sdteske  NormPriority     =  5,     // Normal (non-daemon) priority
75243660Sdteske  NearMaxPriority  =  9,     // High priority, used for VMThread
76243660Sdteske  MaxPriority      = 10,     // Highest priority, used for WatcherThread
77243660Sdteske                             // ensures that VMThread doesn't starve profiler
78243660Sdteske  CriticalPriority = 11      // Critical thread priority
79243660Sdteske};
80243660Sdteske
81243660Sdteske// Typedef for structured exception handling support
82243660Sdtesketypedef void (*java_call_t)(JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread);
83243660Sdteske
84243660Sdteskeclass os: AllStatic {
85243660Sdteske public:
86243114Sdteske  enum { page_sizes_max = 9 }; // Size of _page_sizes array (8 plus a sentinel)
87243114Sdteske
88243114Sdteske private:
89222417Sjulian  static OSThread*          _starting_thread;
90222417Sjulian  static address            _polling_page;
91222417Sjulian  static volatile int32_t * _mem_serialize_page;
92222417Sjulian  static uintptr_t          _serialize_page_mask;
93222417Sjulian public:
94222417Sjulian  static size_t             _page_sizes[page_sizes_max];
95222417Sjulian
96222417Sjulian private:
97222417Sjulian  static void init_page_sizes(size_t default_page_size) {
98222417Sjulian    _page_sizes[0] = default_page_size;
99222417Sjulian    _page_sizes[1] = 0; // sentinel
100222417Sjulian  }
101222417Sjulian
102222417Sjulian public:
103222417Sjulian  static void init(void);                      // Called before command line parsing
104222417Sjulian  static jint init_2(void);                    // Called after command line parsing
105222417Sjulian  static void init_globals(void) {             // Called from init_globals() in init.cpp
106222417Sjulian    init_globals_ext();
107222417Sjulian  }
108222417Sjulian  static void init_3(void);                    // Called at the end of vm init
109222417Sjulian
110222417Sjulian  // File names are case-insensitive on windows only
111222417Sjulian  // Override me as needed
112222417Sjulian  static int    file_name_strcmp(const char* s1, const char* s2);
113222417Sjulian
114222417Sjulian  static bool getenv(const char* name, char* buffer, int len);
115222417Sjulian  static bool have_special_privileges();
116243114Sdteske
117243114Sdteske  static jlong  javaTimeMillis();
118243114Sdteske  static jlong  javaTimeNanos();
119243114Sdteske  static void   javaTimeNanos_info(jvmtiTimerInfo *info_ptr);
120243114Sdteske  static void   run_periodic_checks();
121243114Sdteske
122243114Sdteske
123243114Sdteske  // Returns the elapsed time in seconds since the vm started.
124243114Sdteske  static double elapsedTime();
125243114Sdteske
126243114Sdteske  // Returns real time in seconds since an arbitrary point
127243114Sdteske  // in the past.
128243114Sdteske  static bool getTimesSecs(double* process_real_time,
129243114Sdteske                           double* process_user_time,
130243114Sdteske                           double* process_system_time);
131243114Sdteske
132243114Sdteske  // Interface to the performance counter
133243114Sdteske  static jlong elapsed_counter();
134243114Sdteske  static jlong elapsed_frequency();
135243114Sdteske
136243114Sdteske  // The "virtual time" of a thread is the amount of time a thread has
137243114Sdteske  // actually run.  The first function indicates whether the OS supports
138243114Sdteske  // this functionality for the current thread, and if so:
139243114Sdteske  //   * the second enables vtime tracking (if that is required).
140243114Sdteske  //   * the third tells whether vtime is enabled.
141243114Sdteske  //   * the fourth returns the elapsed virtual time for the current
142243114Sdteske  //     thread.
143243114Sdteske  static bool supports_vtime();
144243114Sdteske  static bool enable_vtime();
145243114Sdteske  static bool vtime_enabled();
146241523Sdteske  static double elapsedVTime();
147243114Sdteske
148241523Sdteske  // Return current local time in a string (YYYY-MM-DD HH:MM:SS).
149241523Sdteske  // It is MT safe, but not async-safe, as reading time zone
150241523Sdteske  // information may require a lock on some platforms.
151241523Sdteske  static char*      local_time_string(char *buf, size_t buflen);
152222417Sjulian  static struct tm* localtime_pd     (const time_t* clock, struct tm*  res);
153222417Sjulian  // Fill in buffer with current local time as an ISO-8601 string.
154222417Sjulian  // E.g., YYYY-MM-DDThh:mm:ss.mmm+zzzz.
155222417Sjulian  // Returns buffer, or NULL if it failed.
156222417Sjulian  static char* iso8601_time(char* buffer, size_t buffer_length);
157243114Sdteske
158243114Sdteske  // Interface for detecting multiprocessor system
159222417Sjulian  static inline bool is_MP() {
160243114Sdteske    assert(_processor_count > 0, "invalid processor count");
161222417Sjulian    return _processor_count > 1;
162222417Sjulian  }
163222417Sjulian  static julong available_memory();
164222417Sjulian  static julong physical_memory();
165222417Sjulian  static julong allocatable_physical_memory(julong size);
166222417Sjulian  static bool is_server_class_machine();
167222417Sjulian
168243114Sdteske  // number of CPUs
169243114Sdteske  static int processor_count() {
170243114Sdteske    return _processor_count;
171243114Sdteske  }
172243114Sdteske  static void set_processor_count(int count) { _processor_count = count; }
173243114Sdteske
174243114Sdteske  // Returns the number of CPUs this process is currently allowed to run on.
175243114Sdteske  // Note that on some OSes this can change dynamically.
176243114Sdteske  static int active_processor_count();
177243114Sdteske
178243114Sdteske  // Bind processes to processors.
179243114Sdteske  //     This is a two step procedure:
180243114Sdteske  //     first you generate a distribution of processes to processors,
181243114Sdteske  //     then you bind processes according to that distribution.
182243114Sdteske  // Compute a distribution for number of processes to processors.
183243114Sdteske  //    Stores the processor id's into the distribution array argument.
184243114Sdteske  //    Returns true if it worked, false if it didn't.
185243114Sdteske  static bool distribute_processes(uint length, uint* distribution);
186241523Sdteske  // Binds the current process to a processor.
187243114Sdteske  //    Returns true if it worked, false if it didn't.
188241523Sdteske  static bool bind_to_processor(uint processor_id);
189241523Sdteske
190241523Sdteske  // Give a name to the current thread.
191241523Sdteske  static void set_native_thread_name(const char *name);
192222417Sjulian
193222417Sjulian  // Interface for stack banging (predetect possible stack overflow for
194222417Sjulian  // exception processing)  There are guard pages, and above that shadow
195222417Sjulian  // pages for stack overflow checking.
196222417Sjulian  static bool uses_stack_guard_pages();
197222417Sjulian  static bool allocate_stack_guard_pages();
198243114Sdteske  static void bang_stack_shadow_pages();
199243114Sdteske  static bool stack_shadow_pages_available(Thread *thread, methodHandle method);
200222417Sjulian
201243114Sdteske  // OS interface to Virtual Memory
202222417Sjulian
203222417Sjulian  // Return the default page size.
204222417Sjulian  static int    vm_page_size();
205222417Sjulian
206222417Sjulian  // Return the page size to use for a region of memory.  The min_pages argument
207243114Sdteske  // is a hint intended to limit fragmentation; it says the returned page size
208243114Sdteske  // should be <= region_max_size / min_pages.  Because min_pages is a hint,
209243114Sdteske  // this routine may return a size larger than region_max_size / min_pages.
210243114Sdteske  //
211243114Sdteske  // The current implementation ignores min_pages if a larger page size is an
212243114Sdteske  // exact multiple of both region_min_size and region_max_size.  This allows
213243114Sdteske  // larger pages to be used when doing so would not cause fragmentation; in
214243114Sdteske  // particular, a single page can be used when region_min_size ==
215243114Sdteske  // region_max_size == a supported page size.
216243114Sdteske  static size_t page_size_for_region(size_t region_min_size,
217243114Sdteske                                     size_t region_max_size,
218243114Sdteske                                     uint min_pages);
219243114Sdteske
220243114Sdteske  // Methods for tracing page sizes returned by the above method; enabled by
221243114Sdteske  // TracePageSizes.  The region_{min,max}_size parameters should be the values
222243114Sdteske  // passed to page_size_for_region() and page_size should be the result of that
223243114Sdteske  // call.  The (optional) base and size parameters should come from the
224243114Sdteske  // ReservedSpace base() and size() methods.
225241523Sdteske  static void trace_page_sizes(const char* str, const size_t* page_sizes,
226243114Sdteske                               int count) PRODUCT_RETURN;
227241523Sdteske  static void trace_page_sizes(const char* str, const size_t region_min_size,
228241523Sdteske                               const size_t region_max_size,
229241523Sdteske                               const size_t page_size,
230241523Sdteske                               const char* base = NULL,
231222417Sjulian                               const size_t size = 0) PRODUCT_RETURN;
232222417Sjulian
233222417Sjulian  static int    vm_allocation_granularity();
234222417Sjulian  static char*  reserve_memory(size_t bytes, char* addr = 0,
235222417Sjulian                               size_t alignment_hint = 0);
236222417Sjulian  static char*  attempt_reserve_memory_at(size_t bytes, char* addr);
237243114Sdteske  static void   split_reserved_memory(char *base, size_t size,
238243114Sdteske                                      size_t split, bool realloc);
239222417Sjulian  static bool   commit_memory(char* addr, size_t bytes,
240243114Sdteske                              bool executable = false);
241222417Sjulian  static bool   commit_memory(char* addr, size_t size, size_t alignment_hint,
242222417Sjulian                              bool executable = false);
243222417Sjulian  static bool   uncommit_memory(char* addr, size_t bytes);
244222417Sjulian  static bool   release_memory(char* addr, size_t bytes);
245222417Sjulian
246243114Sdteske  enum ProtType { MEM_PROT_NONE, MEM_PROT_READ, MEM_PROT_RW, MEM_PROT_RWX };
247243114Sdteske  static bool   protect_memory(char* addr, size_t bytes, ProtType prot,
248243114Sdteske                               bool is_committed = true);
249243114Sdteske
250222417Sjulian  static bool   guard_memory(char* addr, size_t bytes);
251222417Sjulian  static bool   unguard_memory(char* addr, size_t bytes);
252222417Sjulian  static bool   create_stack_guard_pages(char* addr, size_t bytes);
253222417Sjulian  static bool   remove_stack_guard_pages(char* addr, size_t bytes);
254222417Sjulian
255222417Sjulian  static char*  map_memory(int fd, const char* file_name, size_t file_offset,
256222417Sjulian                           char *addr, size_t bytes, bool read_only = false,
257222417Sjulian                           bool allow_exec = false);
258222417Sjulian  static char*  remap_memory(int fd, const char* file_name, size_t file_offset,
259222417Sjulian                             char *addr, size_t bytes, bool read_only,
260222417Sjulian                             bool allow_exec);
261222417Sjulian  static bool   unmap_memory(char *addr, size_t bytes);
262243114Sdteske  static void   free_memory(char *addr, size_t bytes, size_t alignment_hint);
263243114Sdteske  static void   realign_memory(char *addr, size_t bytes, size_t alignment_hint);
264243114Sdteske
265243114Sdteske  // NUMA-specific interface
266241523Sdteske  static bool   numa_has_static_binding();
267243114Sdteske  static bool   numa_has_group_homing();
268241523Sdteske  static void   numa_make_local(char *addr, size_t bytes, int lgrp_hint);
269241523Sdteske  static void   numa_make_global(char *addr, size_t bytes);
270241523Sdteske  static size_t numa_get_groups_num();
271241523Sdteske  static size_t numa_get_leaf_groups(int *ids, size_t size);
272241523Sdteske  static bool   numa_topology_changed();
273241523Sdteske  static int    numa_get_group_id();
274241523Sdteske
275241523Sdteske  // Page manipulation
276241523Sdteske  struct page_info {
277241523Sdteske    size_t size;
278241523Sdteske    int lgrp_id;
279243114Sdteske  };
280243114Sdteske  static bool   get_page_info(char *start, page_info* info);
281243114Sdteske  static char*  scan_pages(char *start, char* end, page_info* page_expected, page_info* page_found);
282243114Sdteske
283241523Sdteske  static char*  non_memory_address_word();
284241523Sdteske  // reserve, commit and pin the entire memory region
285241523Sdteske  static char*  reserve_memory_special(size_t size, char* addr = NULL,
286241523Sdteske                bool executable = false);
287241523Sdteske  static bool   release_memory_special(char* addr, size_t bytes);
288262701Sdteske  static void   large_page_init();
289262701Sdteske  static size_t large_page_size();
290262701Sdteske  static bool   can_commit_large_page_memory();
291262701Sdteske  static bool   can_execute_large_page_memory();
292222417Sjulian
293222417Sjulian  // OS interface to polling page
294262701Sdteske  static address get_polling_page()             { return _polling_page; }
295262701Sdteske  static void    set_polling_page(address page) { _polling_page = page; }
296262701Sdteske  static bool    is_poll_address(address addr)  { return addr >= _polling_page && addr < (_polling_page + os::vm_page_size()); }
297222417Sjulian  static void    make_polling_page_unreadable();
298262701Sdteske  static void    make_polling_page_readable();
299262701Sdteske
300262701Sdteske  // Routines used to serialize the thread state without using membars
301262701Sdteske  static void    serialize_thread_states();
302262701Sdteske
303222417Sjulian  // Since we write to the serialize page from every thread, we
304222417Sjulian  // want stores to be on unique cache lines whenever possible
305243114Sdteske  // in order to minimize CPU cross talk.  We pre-compute the
306243114Sdteske  // amount to shift the thread* to make this offset unique to
307243114Sdteske  // each thread.
308243114Sdteske  static int     get_serialize_page_shift_count() {
309241523Sdteske    return SerializePageShiftCount;
310241523Sdteske  }
311241523Sdteske
312241523Sdteske  static void     set_serialize_page_mask(uintptr_t mask) {
313241523Sdteske    _serialize_page_mask = mask;
314262701Sdteske  }
315262701Sdteske
316262701Sdteske  static unsigned int  get_serialize_page_mask() {
317262701Sdteske    return _serialize_page_mask;
318222417Sjulian  }
319241367Sdteske
320262701Sdteske  static void    set_memory_serialize_page(address page);
321262701Sdteske
322262701Sdteske  static address get_memory_serialize_page() {
323222417Sjulian    return (address)_mem_serialize_page;
324262701Sdteske  }
325262701Sdteske
326262701Sdteske  static inline void write_memory_serialize_page(JavaThread *thread) {
327262701Sdteske    uintptr_t page_offset = ((uintptr_t)thread >>
328262701Sdteske                            get_serialize_page_shift_count()) &
329222417Sjulian                            get_serialize_page_mask();
330242667Sdteske    *(volatile int32_t *)((uintptr_t)_mem_serialize_page+page_offset) = 1;
331243114Sdteske  }
332243114Sdteske
333243114Sdteske  static bool    is_memory_serialize_page(JavaThread *thread, address addr) {
334243114Sdteske    if (UseMembar) return false;
335242667Sdteske    // Previously this function calculated the exact address of this
336242667Sdteske    // thread's serialize page, and checked if the faulting address
337242667Sdteske    // was equal.  However, some platforms mask off faulting addresses
338242667Sdteske    // to the page size, so now we just check that the address is
339242667Sdteske    // within the page.  This makes the thread argument unnecessary,
340242667Sdteske    // but we retain the NULL check to preserve existing behaviour.
341243660Sdteske    if (thread == NULL) return false;
342243660Sdteske    address page = (address) _mem_serialize_page;
343243660Sdteske    return addr >= page && addr < (page + os::vm_page_size());
344243660Sdteske  }
345243660Sdteske
346243660Sdteske  static void block_on_serialize_page_trap();
347243660Sdteske
348243660Sdteske  // threads
349243660Sdteske
350243660Sdteske  enum ThreadType {
351243660Sdteske    vm_thread,
352243660Sdteske    cgc_thread,        // Concurrent GC thread
353281843Sdteske    pgc_thread,        // Parallel GC thread
354281843Sdteske    java_thread,
355    compiler_thread,
356    watcher_thread,
357    os_thread
358  };
359
360  static bool create_thread(Thread* thread,
361                            ThreadType thr_type,
362                            size_t stack_size = 0);
363  static bool create_main_thread(JavaThread* thread);
364  static bool create_attached_thread(JavaThread* thread);
365  static void pd_start_thread(Thread* thread);
366  static void start_thread(Thread* thread);
367
368  static void initialize_thread();
369  static void free_thread(OSThread* osthread);
370
371  // thread id on Linux/64bit is 64bit, on Windows and Solaris, it's 32bit
372  static intx current_thread_id();
373  static int current_process_id();
374  static int sleep(Thread* thread, jlong ms, bool interruptable);
375  static int naked_sleep();
376  static void infinite_sleep(); // never returns, use with CAUTION
377  static void yield();        // Yields to all threads with same priority
378  enum YieldResult {
379    YIELD_SWITCHED = 1,         // caller descheduled, other ready threads exist & ran
380    YIELD_NONEREADY = 0,        // No other runnable/ready threads.
381                                // platform-specific yield return immediately
382    YIELD_UNKNOWN = -1          // Unknown: platform doesn't support _SWITCHED or _NONEREADY
383    // YIELD_SWITCHED and YIELD_NONREADY imply the platform supports a "strong"
384    // yield that can be used in lieu of blocking.
385  } ;
386  static YieldResult NakedYield () ;
387  static void yield_all(int attempts = 0); // Yields to all other threads including lower priority
388  static void loop_breaker(int attempts);  // called from within tight loops to possibly influence time-sharing
389  static OSReturn set_priority(Thread* thread, ThreadPriority priority);
390  static OSReturn get_priority(const Thread* const thread, ThreadPriority& priority);
391
392  static void interrupt(Thread* thread);
393  static bool is_interrupted(Thread* thread, bool clear_interrupted);
394
395  static int pd_self_suspend_thread(Thread* thread);
396
397  static ExtendedPC fetch_frame_from_context(void* ucVoid, intptr_t** sp, intptr_t** fp);
398  static frame      fetch_frame_from_context(void* ucVoid);
399
400  static ExtendedPC get_thread_pc(Thread *thread);
401  static void breakpoint();
402
403  static address current_stack_pointer();
404  static address current_stack_base();
405  static size_t current_stack_size();
406
407  static void verify_stack_alignment() PRODUCT_RETURN;
408
409  static int message_box(const char* title, const char* message);
410  static char* do_you_want_to_debug(const char* message);
411
412  // run cmd in a separate process and return its exit code; or -1 on failures
413  static int fork_and_exec(char *cmd);
414
415  // Set file to send error reports.
416  static void set_error_file(const char *logfile);
417
418  // os::exit() is merged with vm_exit()
419  // static void exit(int num);
420
421  // Terminate the VM, but don't exit the process
422  static void shutdown();
423
424  // Terminate with an error.  Default is to generate a core file on platforms
425  // that support such things.  This calls shutdown() and then aborts.
426  static void abort(bool dump_core = true);
427
428  // Die immediately, no exit hook, no abort hook, no cleanup.
429  static void die();
430
431  // File i/o operations
432  static const int default_file_open_flags();
433  static int open(const char *path, int oflag, int mode);
434  static int close(int fd);
435  static jlong lseek(int fd, jlong offset, int whence);
436  static char* native_path(char *path);
437  static int ftruncate(int fd, jlong length);
438  static int fsync(int fd);
439  static int available(int fd, jlong *bytes);
440
441  //File i/o operations
442
443  static size_t read(int fd, void *buf, unsigned int nBytes);
444  static size_t restartable_read(int fd, void *buf, unsigned int nBytes);
445  static size_t write(int fd, const void *buf, unsigned int nBytes);
446
447  // Reading directories.
448  static DIR*           opendir(const char* dirname);
449  static int            readdir_buf_size(const char *path);
450  static struct dirent* readdir(DIR* dirp, dirent* dbuf);
451  static int            closedir(DIR* dirp);
452
453  // Dynamic library extension
454  static const char*    dll_file_extension();
455
456  static const char*    get_temp_directory();
457  static const char*    get_current_directory(char *buf, int buflen);
458
459  // Builds a platform-specific full library path given a ld path and lib name
460  static void           dll_build_name(char* buffer, size_t size,
461                                       const char* pathname, const char* fname);
462
463  // Symbol lookup, find nearest function name; basically it implements
464  // dladdr() for all platforms. Name of the nearest function is copied
465  // to buf. Distance from its base address is returned as offset.
466  // If function name is not found, buf[0] is set to '\0' and offset is
467  // set to -1.
468  static bool dll_address_to_function_name(address addr, char* buf,
469                                           int buflen, int* offset);
470
471  // Locate DLL/DSO. On success, full path of the library is copied to
472  // buf, and offset is set to be the distance between addr and the
473  // library's base address. On failure, buf[0] is set to '\0' and
474  // offset is set to -1.
475  static bool dll_address_to_library_name(address addr, char* buf,
476                                          int buflen, int* offset);
477
478  // Find out whether the pc is in the static code for jvm.dll/libjvm.so.
479  static bool address_is_in_vm(address addr);
480
481  // Loads .dll/.so and
482  // in case of error it checks if .dll/.so was built for the
483  // same architecture as Hotspot is running on
484  static void* dll_load(const char *name, char *ebuf, int ebuflen);
485
486  // lookup symbol in a shared library
487  static void* dll_lookup(void* handle, const char* name);
488
489  // Unload library
490  static void  dll_unload(void *lib);
491
492  // Print out system information; they are called by fatal error handler.
493  // Output format may be different on different platforms.
494  static void print_os_info(outputStream* st);
495  static void print_cpu_info(outputStream* st);
496  static void pd_print_cpu_info(outputStream* st);
497  static void print_memory_info(outputStream* st);
498  static void print_dll_info(outputStream* st);
499  static void print_environment_variables(outputStream* st, const char** env_list, char* buffer, int len);
500  static void print_context(outputStream* st, void* context);
501  static void print_register_info(outputStream* st, void* context);
502  static void print_siginfo(outputStream* st, void* siginfo);
503  static void print_signal_handlers(outputStream* st, char* buf, size_t buflen);
504  static void print_date_and_time(outputStream* st);
505
506  static void print_location(outputStream* st, intptr_t x, bool verbose = false);
507  static size_t lasterror(char *buf, size_t len);
508  static int get_last_error();
509
510  // Determines whether the calling process is being debugged by a user-mode debugger.
511  static bool is_debugger_attached();
512
513  // wait for a key press if PauseAtExit is set
514  static void wait_for_keypress_at_exit(void);
515
516  // The following two functions are used by fatal error handler to trace
517  // native (C) frames. They are not part of frame.hpp/frame.cpp because
518  // frame.hpp/cpp assume thread is JavaThread, and also because different
519  // OS/compiler may have different convention or provide different API to
520  // walk C frames.
521  //
522  // We don't attempt to become a debugger, so we only follow frames if that
523  // does not require a lookup in the unwind table, which is part of the binary
524  // file but may be unsafe to read after a fatal error. So on x86, we can
525  // only walk stack if %ebp is used as frame pointer; on ia64, it's not
526  // possible to walk C stack without having the unwind table.
527  static bool is_first_C_frame(frame *fr);
528  static frame get_sender_for_C_frame(frame *fr);
529
530  // return current frame. pc() and sp() are set to NULL on failure.
531  static frame      current_frame();
532
533  static void print_hex_dump(outputStream* st, address start, address end, int unitsize);
534
535  // returns a string to describe the exception/signal;
536  // returns NULL if exception_code is not an OS exception/signal.
537  static const char* exception_name(int exception_code, char* buf, size_t buflen);
538
539  // Returns native Java library, loads if necessary
540  static void*    native_java_library();
541
542  // Fills in path to jvm.dll/libjvm.so (used by the Disassembler)
543  static void     jvm_path(char *buf, jint buflen);
544
545  // Returns true if we are running in a headless jre.
546  static bool     is_headless_jre();
547
548  // JNI names
549  static void     print_jni_name_prefix_on(outputStream* st, int args_size);
550  static void     print_jni_name_suffix_on(outputStream* st, int args_size);
551
552  // File conventions
553  static const char* file_separator();
554  static const char* line_separator();
555  static const char* path_separator();
556
557  // Init os specific system properties values
558  static void init_system_properties_values();
559
560  // IO operations, non-JVM_ version.
561  static int stat(const char* path, struct stat* sbuf);
562  static bool dir_is_empty(const char* path);
563
564  // IO operations on binary files
565  static int create_binary_file(const char* path, bool rewrite_existing);
566  static jlong current_file_offset(int fd);
567  static jlong seek_to_file_offset(int fd, jlong offset);
568
569  // Thread Local Storage
570  static int   allocate_thread_local_storage();
571  static void  thread_local_storage_at_put(int index, void* value);
572  static void* thread_local_storage_at(int index);
573  static void  free_thread_local_storage(int index);
574
575  // General allocation (must be MT-safe)
576  static void* malloc  (size_t size);
577  static void* realloc (void *memblock, size_t size);
578  static void  free    (void *memblock);
579  static bool  check_heap(bool force = false);      // verify C heap integrity
580  static char* strdup(const char *);  // Like strdup
581
582#ifndef PRODUCT
583  static julong num_mallocs;         // # of calls to malloc/realloc
584  static julong alloc_bytes;         // # of bytes allocated
585  static julong num_frees;           // # of calls to free
586  static julong free_bytes;          // # of bytes freed
587#endif
588
589  // SocketInterface (ex HPI SocketInterface )
590  static int socket(int domain, int type, int protocol);
591  static int socket_close(int fd);
592  static int socket_shutdown(int fd, int howto);
593  static int recv(int fd, char* buf, size_t nBytes, uint flags);
594  static int send(int fd, char* buf, size_t nBytes, uint flags);
595  static int raw_send(int fd, char* buf, size_t nBytes, uint flags);
596  static int timeout(int fd, long timeout);
597  static int listen(int fd, int count);
598  static int connect(int fd, struct sockaddr* him, socklen_t len);
599  static int bind(int fd, struct sockaddr* him, socklen_t len);
600  static int accept(int fd, struct sockaddr* him, socklen_t* len);
601  static int recvfrom(int fd, char* buf, size_t nbytes, uint flags,
602                      struct sockaddr* from, socklen_t* fromlen);
603  static int get_sock_name(int fd, struct sockaddr* him, socklen_t* len);
604  static int sendto(int fd, char* buf, size_t len, uint flags,
605                    struct sockaddr* to, socklen_t tolen);
606  static int socket_available(int fd, jint* pbytes);
607
608  static int get_sock_opt(int fd, int level, int optname,
609                          char* optval, socklen_t* optlen);
610  static int set_sock_opt(int fd, int level, int optname,
611                          const char* optval, socklen_t optlen);
612  static int get_host_name(char* name, int namelen);
613
614  static struct hostent* get_host_by_name(char* name);
615
616  // Printing 64 bit integers
617  static const char* jlong_format_specifier();
618  static const char* julong_format_specifier();
619
620  // Support for signals (see JVM_RaiseSignal, JVM_RegisterSignal)
621  static void  signal_init();
622  static void  signal_init_pd();
623  static void  signal_notify(int signal_number);
624  static void* signal(int signal_number, void* handler);
625  static void  signal_raise(int signal_number);
626  static int   signal_wait();
627  static int   signal_lookup();
628  static void* user_handler();
629  static void  terminate_signal_thread();
630  static int   sigexitnum_pd();
631
632  // random number generation
633  static long random();                    // return 32bit pseudorandom number
634  static void init_random(long initval);   // initialize random sequence
635
636  // Structured OS Exception support
637  static void os_exception_wrapper(java_call_t f, JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread);
638
639  // On Windows this will create an actual minidump, on Linux/Solaris it will simply check core dump limits
640  static void check_or_create_dump(void* exceptionRecord, void* contextRecord, char* buffer, size_t bufferSize);
641
642  // JVMTI & JVM monitoring and management support
643  // The thread_cpu_time() and current_thread_cpu_time() are only
644  // supported if is_thread_cpu_time_supported() returns true.
645  // They are not supported on Solaris T1.
646
647  // Thread CPU Time - return the fast estimate on a platform
648  // On Solaris - call gethrvtime (fast) - user time only
649  // On Linux   - fast clock_gettime where available - user+sys
650  //            - otherwise: very slow /proc fs - user+sys
651  // On Windows - GetThreadTimes - user+sys
652  static jlong current_thread_cpu_time();
653  static jlong thread_cpu_time(Thread* t);
654
655  // Thread CPU Time with user_sys_cpu_time parameter.
656  //
657  // If user_sys_cpu_time is true, user+sys time is returned.
658  // Otherwise, only user time is returned
659  static jlong current_thread_cpu_time(bool user_sys_cpu_time);
660  static jlong thread_cpu_time(Thread* t, bool user_sys_cpu_time);
661
662  // Return a bunch of info about the timers.
663  // Note that the returned info for these two functions may be different
664  // on some platforms
665  static void current_thread_cpu_time_info(jvmtiTimerInfo *info_ptr);
666  static void thread_cpu_time_info(jvmtiTimerInfo *info_ptr);
667
668  static bool is_thread_cpu_time_supported();
669
670  // System loadavg support.  Returns -1 if load average cannot be obtained.
671  static int loadavg(double loadavg[], int nelem);
672
673  // Hook for os specific jvm options that we don't want to abort on seeing
674  static bool obsolete_option(const JavaVMOption *option);
675
676  // Read file line by line. If line is longer than bsize,
677  // rest of line is skipped. Returns number of bytes read or -1 on EOF
678  static int get_line_chars(int fd, char *buf, const size_t bsize);
679
680  // Extensions
681#include "runtime/os_ext.hpp"
682
683 public:
684
685  // Platform dependent stuff
686#ifdef TARGET_OS_FAMILY_linux
687# include "os_linux.hpp"
688#endif
689#ifdef TARGET_OS_FAMILY_solaris
690# include "os_solaris.hpp"
691#endif
692#ifdef TARGET_OS_FAMILY_windows
693# include "os_windows.hpp"
694#endif
695#ifdef TARGET_OS_FAMILY_bsd
696# include "os_bsd.hpp"
697#endif
698#ifdef TARGET_OS_ARCH_linux_x86
699# include "os_linux_x86.hpp"
700#endif
701#ifdef TARGET_OS_ARCH_linux_sparc
702# include "os_linux_sparc.hpp"
703#endif
704#ifdef TARGET_OS_ARCH_linux_zero
705# include "os_linux_zero.hpp"
706#endif
707#ifdef TARGET_OS_ARCH_solaris_x86
708# include "os_solaris_x86.hpp"
709#endif
710#ifdef TARGET_OS_ARCH_solaris_sparc
711# include "os_solaris_sparc.hpp"
712#endif
713#ifdef TARGET_OS_ARCH_windows_x86
714# include "os_windows_x86.hpp"
715#endif
716#ifdef TARGET_OS_ARCH_linux_arm
717# include "os_linux_arm.hpp"
718#endif
719#ifdef TARGET_OS_ARCH_linux_ppc
720# include "os_linux_ppc.hpp"
721#endif
722#ifdef TARGET_OS_ARCH_bsd_x86
723# include "os_bsd_x86.hpp"
724#endif
725#ifdef TARGET_OS_ARCH_bsd_zero
726# include "os_bsd_zero.hpp"
727#endif
728
729 public:
730  // debugging support (mostly used by debug.cpp but also fatal error handler)
731  static bool find(address pc, outputStream* st = tty); // OS specific function to make sense out of an address
732
733  static bool dont_yield();                     // when true, JVM_Yield() is nop
734  static void print_statistics();
735
736  // Thread priority helpers (implemented in OS-specific part)
737  static OSReturn set_native_priority(Thread* thread, int native_prio);
738  static OSReturn get_native_priority(const Thread* const thread, int* priority_ptr);
739  static int java_to_os_priority[CriticalPriority + 1];
740  // Hint to the underlying OS that a task switch would not be good.
741  // Void return because it's a hint and can fail.
742  static void hint_no_preempt();
743
744  // Used at creation if requested by the diagnostic flag PauseAtStartup.
745  // Causes the VM to wait until an external stimulus has been applied
746  // (for Unix, that stimulus is a signal, for Windows, an external
747  // ResumeThread call)
748  static void pause();
749
750 protected:
751  static long _rand_seed;                   // seed for random number generator
752  static int _processor_count;              // number of processors
753
754  static char* format_boot_path(const char* format_string,
755                                const char* home,
756                                int home_len,
757                                char fileSep,
758                                char pathSep);
759  static bool set_boot_path(char fileSep, char pathSep);
760  static char** split_path(const char* path, int* n);
761};
762
763// Note that "PAUSE" is almost always used with synchronization
764// so arguably we should provide Atomic::SpinPause() instead
765// of the global SpinPause() with C linkage.
766// It'd also be eligible for inlining on many platforms.
767
768extern "C" int SpinPause () ;
769extern "C" int SafeFetch32 (int * adr, int errValue) ;
770extern "C" intptr_t SafeFetchN (intptr_t * adr, intptr_t errValue) ;
771
772#endif // SHARE_VM_RUNTIME_OS_HPP
773