Fri, 05 Sep 2014 12:36:37 -0700
8057623: add an extension class for argument handling
Reviewed-by: brutisso, mgerdin, tschatzl
1 /*
2 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #ifndef SHARE_VM_RUNTIME_OS_HPP
26 #define SHARE_VM_RUNTIME_OS_HPP
28 #include "jvmtifiles/jvmti.h"
29 #include "runtime/atomic.hpp"
30 #include "runtime/extendedPC.hpp"
31 #include "runtime/handles.hpp"
32 #include "utilities/top.hpp"
33 #ifdef TARGET_OS_FAMILY_linux
34 # include "jvm_linux.h"
35 # include <setjmp.h>
36 #endif
37 #ifdef TARGET_OS_FAMILY_solaris
38 # include "jvm_solaris.h"
39 # include <setjmp.h>
40 #endif
41 #ifdef TARGET_OS_FAMILY_windows
42 # include "jvm_windows.h"
43 #endif
44 #ifdef TARGET_OS_FAMILY_aix
45 # include "jvm_aix.h"
46 # include <setjmp.h>
47 #endif
48 #ifdef TARGET_OS_FAMILY_bsd
49 # include "jvm_bsd.h"
50 # include <setjmp.h>
51 # ifdef __APPLE__
52 # include <mach/mach_time.h>
53 # endif
54 #endif
56 class AgentLibrary;
58 // os defines the interface to operating system; this includes traditional
59 // OS services (time, I/O) as well as other functionality with system-
60 // dependent code.
62 typedef void (*dll_func)(...);
64 class Thread;
65 class JavaThread;
66 class Event;
67 class DLL;
68 class FileHandle;
69 class NativeCallStack;
71 template<class E> class GrowableArray;
73 // %%%%% Moved ThreadState, START_FN, OSThread to new osThread.hpp. -- Rose
75 // Platform-independent error return values from OS functions
76 enum OSReturn {
77 OS_OK = 0, // Operation was successful
78 OS_ERR = -1, // Operation failed
79 OS_INTRPT = -2, // Operation was interrupted
80 OS_TIMEOUT = -3, // Operation timed out
81 OS_NOMEM = -5, // Operation failed for lack of memory
82 OS_NORESOURCE = -6 // Operation failed for lack of nonmemory resource
83 };
85 enum ThreadPriority { // JLS 20.20.1-3
86 NoPriority = -1, // Initial non-priority value
87 MinPriority = 1, // Minimum priority
88 NormPriority = 5, // Normal (non-daemon) priority
89 NearMaxPriority = 9, // High priority, used for VMThread
90 MaxPriority = 10, // Highest priority, used for WatcherThread
91 // ensures that VMThread doesn't starve profiler
92 CriticalPriority = 11 // Critical thread priority
93 };
95 // Executable parameter flag for os::commit_memory() and
96 // os::commit_memory_or_exit().
97 const bool ExecMem = true;
99 // Typedef for structured exception handling support
100 typedef void (*java_call_t)(JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread);
102 class MallocTracker;
104 class os: AllStatic {
105 friend class VMStructs;
106 friend class MallocTracker;
107 public:
108 enum { page_sizes_max = 9 }; // Size of _page_sizes array (8 plus a sentinel)
110 private:
111 static OSThread* _starting_thread;
112 static address _polling_page;
113 static volatile int32_t * _mem_serialize_page;
114 static uintptr_t _serialize_page_mask;
115 public:
116 static size_t _page_sizes[page_sizes_max];
118 private:
119 static void init_page_sizes(size_t default_page_size) {
120 _page_sizes[0] = default_page_size;
121 _page_sizes[1] = 0; // sentinel
122 }
124 static char* pd_reserve_memory(size_t bytes, char* addr = 0,
125 size_t alignment_hint = 0);
126 static char* pd_attempt_reserve_memory_at(size_t bytes, char* addr);
127 static void pd_split_reserved_memory(char *base, size_t size,
128 size_t split, bool realloc);
129 static bool pd_commit_memory(char* addr, size_t bytes, bool executable);
130 static bool pd_commit_memory(char* addr, size_t size, size_t alignment_hint,
131 bool executable);
132 // Same as pd_commit_memory() that either succeeds or calls
133 // vm_exit_out_of_memory() with the specified mesg.
134 static void pd_commit_memory_or_exit(char* addr, size_t bytes,
135 bool executable, const char* mesg);
136 static void pd_commit_memory_or_exit(char* addr, size_t size,
137 size_t alignment_hint,
138 bool executable, const char* mesg);
139 static bool pd_uncommit_memory(char* addr, size_t bytes);
140 static bool pd_release_memory(char* addr, size_t bytes);
142 static char* pd_map_memory(int fd, const char* file_name, size_t file_offset,
143 char *addr, size_t bytes, bool read_only = false,
144 bool allow_exec = false);
145 static char* pd_remap_memory(int fd, const char* file_name, size_t file_offset,
146 char *addr, size_t bytes, bool read_only,
147 bool allow_exec);
148 static bool pd_unmap_memory(char *addr, size_t bytes);
149 static void pd_free_memory(char *addr, size_t bytes, size_t alignment_hint);
150 static void pd_realign_memory(char *addr, size_t bytes, size_t alignment_hint);
153 public:
154 static void init(void); // Called before command line parsing
155 static void init_before_ergo(void); // Called after command line parsing
156 // before VM ergonomics processing.
157 static jint init_2(void); // Called after command line parsing
158 // and VM ergonomics processing
159 static void init_globals(void) { // Called from init_globals() in init.cpp
160 init_globals_ext();
161 }
162 static void init_3(void); // Called at the end of vm init
164 // File names are case-insensitive on windows only
165 // Override me as needed
166 static int file_name_strcmp(const char* s1, const char* s2);
168 // get/unset environment variable
169 static bool getenv(const char* name, char* buffer, int len);
170 static bool unsetenv(const char* name);
172 static bool have_special_privileges();
174 static jlong javaTimeMillis();
175 static jlong javaTimeNanos();
176 static void javaTimeNanos_info(jvmtiTimerInfo *info_ptr);
177 static void run_periodic_checks();
180 // Returns the elapsed time in seconds since the vm started.
181 static double elapsedTime();
183 // Returns real time in seconds since an arbitrary point
184 // in the past.
185 static bool getTimesSecs(double* process_real_time,
186 double* process_user_time,
187 double* process_system_time);
189 // Interface to the performance counter
190 static jlong elapsed_counter();
191 static jlong elapsed_frequency();
193 // The "virtual time" of a thread is the amount of time a thread has
194 // actually run. The first function indicates whether the OS supports
195 // this functionality for the current thread, and if so:
196 // * the second enables vtime tracking (if that is required).
197 // * the third tells whether vtime is enabled.
198 // * the fourth returns the elapsed virtual time for the current
199 // thread.
200 static bool supports_vtime();
201 static bool enable_vtime();
202 static bool vtime_enabled();
203 static double elapsedVTime();
205 // Return current local time in a string (YYYY-MM-DD HH:MM:SS).
206 // It is MT safe, but not async-safe, as reading time zone
207 // information may require a lock on some platforms.
208 static char* local_time_string(char *buf, size_t buflen);
209 static struct tm* localtime_pd (const time_t* clock, struct tm* res);
210 // Fill in buffer with current local time as an ISO-8601 string.
211 // E.g., YYYY-MM-DDThh:mm:ss.mmm+zzzz.
212 // Returns buffer, or NULL if it failed.
213 static char* iso8601_time(char* buffer, size_t buffer_length);
215 // Interface for detecting multiprocessor system
216 static inline bool is_MP() {
217 #if !INCLUDE_NMT
218 assert(_processor_count > 0, "invalid processor count");
219 return _processor_count > 1 || AssumeMP;
220 #else
221 // NMT needs atomic operations before this initialization.
222 return true;
223 #endif
224 }
225 static julong available_memory();
226 static julong physical_memory();
227 static bool has_allocatable_memory_limit(julong* limit);
228 static bool is_server_class_machine();
230 // number of CPUs
231 static int processor_count() {
232 return _processor_count;
233 }
234 static void set_processor_count(int count) { _processor_count = count; }
236 // Returns the number of CPUs this process is currently allowed to run on.
237 // Note that on some OSes this can change dynamically.
238 static int active_processor_count();
240 // Bind processes to processors.
241 // This is a two step procedure:
242 // first you generate a distribution of processes to processors,
243 // then you bind processes according to that distribution.
244 // Compute a distribution for number of processes to processors.
245 // Stores the processor id's into the distribution array argument.
246 // Returns true if it worked, false if it didn't.
247 static bool distribute_processes(uint length, uint* distribution);
248 // Binds the current process to a processor.
249 // Returns true if it worked, false if it didn't.
250 static bool bind_to_processor(uint processor_id);
252 // Give a name to the current thread.
253 static void set_native_thread_name(const char *name);
255 // Interface for stack banging (predetect possible stack overflow for
256 // exception processing) There are guard pages, and above that shadow
257 // pages for stack overflow checking.
258 static bool uses_stack_guard_pages();
259 static bool allocate_stack_guard_pages();
260 static void bang_stack_shadow_pages();
261 static bool stack_shadow_pages_available(Thread *thread, methodHandle method);
263 // OS interface to Virtual Memory
265 // Return the default page size.
266 static int vm_page_size();
268 // Return the page size to use for a region of memory. The min_pages argument
269 // is a hint intended to limit fragmentation; it says the returned page size
270 // should be <= region_max_size / min_pages. Because min_pages is a hint,
271 // this routine may return a size larger than region_max_size / min_pages.
272 //
273 // The current implementation ignores min_pages if a larger page size is an
274 // exact multiple of both region_min_size and region_max_size. This allows
275 // larger pages to be used when doing so would not cause fragmentation; in
276 // particular, a single page can be used when region_min_size ==
277 // region_max_size == a supported page size.
278 static size_t page_size_for_region(size_t region_min_size,
279 size_t region_max_size,
280 uint min_pages);
281 // Return the largest page size that can be used
282 static size_t max_page_size() {
283 // The _page_sizes array is sorted in descending order.
284 return _page_sizes[0];
285 }
287 // Methods for tracing page sizes returned by the above method; enabled by
288 // TracePageSizes. The region_{min,max}_size parameters should be the values
289 // passed to page_size_for_region() and page_size should be the result of that
290 // call. The (optional) base and size parameters should come from the
291 // ReservedSpace base() and size() methods.
292 static void trace_page_sizes(const char* str, const size_t* page_sizes,
293 int count) PRODUCT_RETURN;
294 static void trace_page_sizes(const char* str, const size_t region_min_size,
295 const size_t region_max_size,
296 const size_t page_size,
297 const char* base = NULL,
298 const size_t size = 0) PRODUCT_RETURN;
300 static int vm_allocation_granularity();
301 static char* reserve_memory(size_t bytes, char* addr = 0,
302 size_t alignment_hint = 0);
303 static char* reserve_memory(size_t bytes, char* addr,
304 size_t alignment_hint, MEMFLAGS flags);
305 static char* reserve_memory_aligned(size_t size, size_t alignment);
306 static char* attempt_reserve_memory_at(size_t bytes, char* addr);
307 static void split_reserved_memory(char *base, size_t size,
308 size_t split, bool realloc);
309 static bool commit_memory(char* addr, size_t bytes, bool executable);
310 static bool commit_memory(char* addr, size_t size, size_t alignment_hint,
311 bool executable);
312 // Same as commit_memory() that either succeeds or calls
313 // vm_exit_out_of_memory() with the specified mesg.
314 static void commit_memory_or_exit(char* addr, size_t bytes,
315 bool executable, const char* mesg);
316 static void commit_memory_or_exit(char* addr, size_t size,
317 size_t alignment_hint,
318 bool executable, const char* mesg);
319 static bool uncommit_memory(char* addr, size_t bytes);
320 static bool release_memory(char* addr, size_t bytes);
322 enum ProtType { MEM_PROT_NONE, MEM_PROT_READ, MEM_PROT_RW, MEM_PROT_RWX };
323 static bool protect_memory(char* addr, size_t bytes, ProtType prot,
324 bool is_committed = true);
326 static bool guard_memory(char* addr, size_t bytes);
327 static bool unguard_memory(char* addr, size_t bytes);
328 static bool create_stack_guard_pages(char* addr, size_t bytes);
329 static bool pd_create_stack_guard_pages(char* addr, size_t bytes);
330 static bool remove_stack_guard_pages(char* addr, size_t bytes);
332 static char* map_memory(int fd, const char* file_name, size_t file_offset,
333 char *addr, size_t bytes, bool read_only = false,
334 bool allow_exec = false);
335 static char* remap_memory(int fd, const char* file_name, size_t file_offset,
336 char *addr, size_t bytes, bool read_only,
337 bool allow_exec);
338 static bool unmap_memory(char *addr, size_t bytes);
339 static void free_memory(char *addr, size_t bytes, size_t alignment_hint);
340 static void realign_memory(char *addr, size_t bytes, size_t alignment_hint);
342 // NUMA-specific interface
343 static bool numa_has_static_binding();
344 static bool numa_has_group_homing();
345 static void numa_make_local(char *addr, size_t bytes, int lgrp_hint);
346 static void numa_make_global(char *addr, size_t bytes);
347 static size_t numa_get_groups_num();
348 static size_t numa_get_leaf_groups(int *ids, size_t size);
349 static bool numa_topology_changed();
350 static int numa_get_group_id();
352 // Page manipulation
353 struct page_info {
354 size_t size;
355 int lgrp_id;
356 };
357 static bool get_page_info(char *start, page_info* info);
358 static char* scan_pages(char *start, char* end, page_info* page_expected, page_info* page_found);
360 static char* non_memory_address_word();
361 // reserve, commit and pin the entire memory region
362 static char* reserve_memory_special(size_t size, size_t alignment,
363 char* addr, bool executable);
364 static bool release_memory_special(char* addr, size_t bytes);
365 static void large_page_init();
366 static size_t large_page_size();
367 static bool can_commit_large_page_memory();
368 static bool can_execute_large_page_memory();
370 // OS interface to polling page
371 static address get_polling_page() { return _polling_page; }
372 static void set_polling_page(address page) { _polling_page = page; }
373 static bool is_poll_address(address addr) { return addr >= _polling_page && addr < (_polling_page + os::vm_page_size()); }
374 static void make_polling_page_unreadable();
375 static void make_polling_page_readable();
377 // Routines used to serialize the thread state without using membars
378 static void serialize_thread_states();
380 // Since we write to the serialize page from every thread, we
381 // want stores to be on unique cache lines whenever possible
382 // in order to minimize CPU cross talk. We pre-compute the
383 // amount to shift the thread* to make this offset unique to
384 // each thread.
385 static int get_serialize_page_shift_count() {
386 return SerializePageShiftCount;
387 }
389 static void set_serialize_page_mask(uintptr_t mask) {
390 _serialize_page_mask = mask;
391 }
393 static unsigned int get_serialize_page_mask() {
394 return _serialize_page_mask;
395 }
397 static void set_memory_serialize_page(address page);
399 static address get_memory_serialize_page() {
400 return (address)_mem_serialize_page;
401 }
403 static inline void write_memory_serialize_page(JavaThread *thread) {
404 uintptr_t page_offset = ((uintptr_t)thread >>
405 get_serialize_page_shift_count()) &
406 get_serialize_page_mask();
407 *(volatile int32_t *)((uintptr_t)_mem_serialize_page+page_offset) = 1;
408 }
410 static bool is_memory_serialize_page(JavaThread *thread, address addr) {
411 if (UseMembar) return false;
412 // Previously this function calculated the exact address of this
413 // thread's serialize page, and checked if the faulting address
414 // was equal. However, some platforms mask off faulting addresses
415 // to the page size, so now we just check that the address is
416 // within the page. This makes the thread argument unnecessary,
417 // but we retain the NULL check to preserve existing behaviour.
418 if (thread == NULL) return false;
419 address page = (address) _mem_serialize_page;
420 return addr >= page && addr < (page + os::vm_page_size());
421 }
423 static void block_on_serialize_page_trap();
425 // threads
427 enum ThreadType {
428 vm_thread,
429 cgc_thread, // Concurrent GC thread
430 pgc_thread, // Parallel GC thread
431 java_thread,
432 compiler_thread,
433 watcher_thread,
434 os_thread
435 };
437 static bool create_thread(Thread* thread,
438 ThreadType thr_type,
439 size_t stack_size = 0);
440 static bool create_main_thread(JavaThread* thread);
441 static bool create_attached_thread(JavaThread* thread);
442 static void pd_start_thread(Thread* thread);
443 static void start_thread(Thread* thread);
445 static void initialize_thread(Thread* thr);
446 static void free_thread(OSThread* osthread);
448 // thread id on Linux/64bit is 64bit, on Windows and Solaris, it's 32bit
449 static intx current_thread_id();
450 static int current_process_id();
451 static int sleep(Thread* thread, jlong ms, bool interruptable);
452 // Short standalone OS sleep suitable for slow path spin loop.
453 // Ignores Thread.interrupt() (so keep it short).
454 // ms = 0, will sleep for the least amount of time allowed by the OS.
455 static void naked_short_sleep(jlong ms);
456 static void infinite_sleep(); // never returns, use with CAUTION
457 static void yield(); // Yields to all threads with same priority
458 enum YieldResult {
459 YIELD_SWITCHED = 1, // caller descheduled, other ready threads exist & ran
460 YIELD_NONEREADY = 0, // No other runnable/ready threads.
461 // platform-specific yield return immediately
462 YIELD_UNKNOWN = -1 // Unknown: platform doesn't support _SWITCHED or _NONEREADY
463 // YIELD_SWITCHED and YIELD_NONREADY imply the platform supports a "strong"
464 // yield that can be used in lieu of blocking.
465 } ;
466 static YieldResult NakedYield () ;
467 static void yield_all(int attempts = 0); // Yields to all other threads including lower priority
468 static void loop_breaker(int attempts); // called from within tight loops to possibly influence time-sharing
469 static OSReturn set_priority(Thread* thread, ThreadPriority priority);
470 static OSReturn get_priority(const Thread* const thread, ThreadPriority& priority);
472 static void interrupt(Thread* thread);
473 static bool is_interrupted(Thread* thread, bool clear_interrupted);
475 static int pd_self_suspend_thread(Thread* thread);
477 static ExtendedPC fetch_frame_from_context(void* ucVoid, intptr_t** sp, intptr_t** fp);
478 static frame fetch_frame_from_context(void* ucVoid);
480 static ExtendedPC get_thread_pc(Thread *thread);
481 static void breakpoint();
483 static address current_stack_pointer();
484 static address current_stack_base();
485 static size_t current_stack_size();
487 static void verify_stack_alignment() PRODUCT_RETURN;
489 static int message_box(const char* title, const char* message);
490 static char* do_you_want_to_debug(const char* message);
492 // run cmd in a separate process and return its exit code; or -1 on failures
493 static int fork_and_exec(char *cmd);
495 // os::exit() is merged with vm_exit()
496 // static void exit(int num);
498 // Terminate the VM, but don't exit the process
499 static void shutdown();
501 // Terminate with an error. Default is to generate a core file on platforms
502 // that support such things. This calls shutdown() and then aborts.
503 static void abort(bool dump_core = true);
505 // Die immediately, no exit hook, no abort hook, no cleanup.
506 static void die();
508 // File i/o operations
509 static const int default_file_open_flags();
510 static int open(const char *path, int oflag, int mode);
511 static FILE* open(int fd, const char* mode);
512 static int close(int fd);
513 static jlong lseek(int fd, jlong offset, int whence);
514 static char* native_path(char *path);
515 static int ftruncate(int fd, jlong length);
516 static int fsync(int fd);
517 static int available(int fd, jlong *bytes);
519 //File i/o operations
521 static size_t read(int fd, void *buf, unsigned int nBytes);
522 static size_t restartable_read(int fd, void *buf, unsigned int nBytes);
523 static size_t write(int fd, const void *buf, unsigned int nBytes);
525 // Reading directories.
526 static DIR* opendir(const char* dirname);
527 static int readdir_buf_size(const char *path);
528 static struct dirent* readdir(DIR* dirp, dirent* dbuf);
529 static int closedir(DIR* dirp);
531 // Dynamic library extension
532 static const char* dll_file_extension();
534 static const char* get_temp_directory();
535 static const char* get_current_directory(char *buf, size_t buflen);
537 // Builds a platform-specific full library path given a ld path and lib name
538 // Returns true if buffer contains full path to existing file, false otherwise
539 static bool dll_build_name(char* buffer, size_t size,
540 const char* pathname, const char* fname);
542 // Symbol lookup, find nearest function name; basically it implements
543 // dladdr() for all platforms. Name of the nearest function is copied
544 // to buf. Distance from its base address is optionally returned as offset.
545 // If function name is not found, buf[0] is set to '\0' and offset is
546 // set to -1 (if offset is non-NULL).
547 static bool dll_address_to_function_name(address addr, char* buf,
548 int buflen, int* offset);
550 // Locate DLL/DSO. On success, full path of the library is copied to
551 // buf, and offset is optionally set to be the distance between addr
552 // and the library's base address. On failure, buf[0] is set to '\0'
553 // and offset is set to -1 (if offset is non-NULL).
554 static bool dll_address_to_library_name(address addr, char* buf,
555 int buflen, int* offset);
557 // Find out whether the pc is in the static code for jvm.dll/libjvm.so.
558 static bool address_is_in_vm(address addr);
560 // Loads .dll/.so and
561 // in case of error it checks if .dll/.so was built for the
562 // same architecture as Hotspot is running on
563 static void* dll_load(const char *name, char *ebuf, int ebuflen);
565 // lookup symbol in a shared library
566 static void* dll_lookup(void* handle, const char* name);
568 // Unload library
569 static void dll_unload(void *lib);
571 // Return the handle of this process
572 static void* get_default_process_handle();
574 // Check for static linked agent library
575 static bool find_builtin_agent(AgentLibrary *agent_lib, const char *syms[],
576 size_t syms_len);
578 // Find agent entry point
579 static void *find_agent_function(AgentLibrary *agent_lib, bool check_lib,
580 const char *syms[], size_t syms_len);
582 // Print out system information; they are called by fatal error handler.
583 // Output format may be different on different platforms.
584 static void print_os_info(outputStream* st);
585 static void print_os_info_brief(outputStream* st);
586 static void print_cpu_info(outputStream* st);
587 static void pd_print_cpu_info(outputStream* st);
588 static void print_memory_info(outputStream* st);
589 static void print_dll_info(outputStream* st);
590 static void print_environment_variables(outputStream* st, const char** env_list, char* buffer, int len);
591 static void print_context(outputStream* st, void* context);
592 static void print_register_info(outputStream* st, void* context);
593 static void print_siginfo(outputStream* st, void* siginfo);
594 static void print_signal_handlers(outputStream* st, char* buf, size_t buflen);
595 static void print_date_and_time(outputStream* st);
597 static void print_location(outputStream* st, intptr_t x, bool verbose = false);
598 static size_t lasterror(char *buf, size_t len);
599 static int get_last_error();
601 // Determines whether the calling process is being debugged by a user-mode debugger.
602 static bool is_debugger_attached();
604 // wait for a key press if PauseAtExit is set
605 static void wait_for_keypress_at_exit(void);
607 // The following two functions are used by fatal error handler to trace
608 // native (C) frames. They are not part of frame.hpp/frame.cpp because
609 // frame.hpp/cpp assume thread is JavaThread, and also because different
610 // OS/compiler may have different convention or provide different API to
611 // walk C frames.
612 //
613 // We don't attempt to become a debugger, so we only follow frames if that
614 // does not require a lookup in the unwind table, which is part of the binary
615 // file but may be unsafe to read after a fatal error. So on x86, we can
616 // only walk stack if %ebp is used as frame pointer; on ia64, it's not
617 // possible to walk C stack without having the unwind table.
618 static bool is_first_C_frame(frame *fr);
619 static frame get_sender_for_C_frame(frame *fr);
621 // return current frame. pc() and sp() are set to NULL on failure.
622 static frame current_frame();
624 static void print_hex_dump(outputStream* st, address start, address end, int unitsize);
626 // returns a string to describe the exception/signal;
627 // returns NULL if exception_code is not an OS exception/signal.
628 static const char* exception_name(int exception_code, char* buf, size_t buflen);
630 // Returns native Java library, loads if necessary
631 static void* native_java_library();
633 // Fills in path to jvm.dll/libjvm.so (used by the Disassembler)
634 static void jvm_path(char *buf, jint buflen);
636 // Returns true if we are running in a headless jre.
637 static bool is_headless_jre();
639 // JNI names
640 static void print_jni_name_prefix_on(outputStream* st, int args_size);
641 static void print_jni_name_suffix_on(outputStream* st, int args_size);
643 // File conventions
644 static const char* file_separator();
645 static const char* line_separator();
646 static const char* path_separator();
648 // Init os specific system properties values
649 static void init_system_properties_values();
651 // IO operations, non-JVM_ version.
652 static int stat(const char* path, struct stat* sbuf);
653 static bool dir_is_empty(const char* path);
655 // IO operations on binary files
656 static int create_binary_file(const char* path, bool rewrite_existing);
657 static jlong current_file_offset(int fd);
658 static jlong seek_to_file_offset(int fd, jlong offset);
660 // Thread Local Storage
661 static int allocate_thread_local_storage();
662 static void thread_local_storage_at_put(int index, void* value);
663 static void* thread_local_storage_at(int index);
664 static void free_thread_local_storage(int index);
666 // Retrieve native stack frames.
667 // Parameter:
668 // stack: an array to storage stack pointers.
669 // frames: size of above array.
670 // toSkip: number of stack frames to skip at the beginning.
671 // Return: number of stack frames captured.
672 static int get_native_stack(address* stack, int size, int toSkip = 0);
674 // General allocation (must be MT-safe)
675 static void* malloc (size_t size, MEMFLAGS flags, const NativeCallStack& stack);
676 static void* malloc (size_t size, MEMFLAGS flags);
677 static void* realloc (void *memblock, size_t size, MEMFLAGS flag, const NativeCallStack& stack);
678 static void* realloc (void *memblock, size_t size, MEMFLAGS flag);
680 static void free (void *memblock, MEMFLAGS flags = mtNone);
681 static bool check_heap(bool force = false); // verify C heap integrity
682 static char* strdup(const char *, MEMFLAGS flags = mtInternal); // Like strdup
684 #ifndef PRODUCT
685 static julong num_mallocs; // # of calls to malloc/realloc
686 static julong alloc_bytes; // # of bytes allocated
687 static julong num_frees; // # of calls to free
688 static julong free_bytes; // # of bytes freed
689 #endif
691 // SocketInterface (ex HPI SocketInterface )
692 static int socket(int domain, int type, int protocol);
693 static int socket_close(int fd);
694 static int socket_shutdown(int fd, int howto);
695 static int recv(int fd, char* buf, size_t nBytes, uint flags);
696 static int send(int fd, char* buf, size_t nBytes, uint flags);
697 static int raw_send(int fd, char* buf, size_t nBytes, uint flags);
698 static int timeout(int fd, long timeout);
699 static int listen(int fd, int count);
700 static int connect(int fd, struct sockaddr* him, socklen_t len);
701 static int bind(int fd, struct sockaddr* him, socklen_t len);
702 static int accept(int fd, struct sockaddr* him, socklen_t* len);
703 static int recvfrom(int fd, char* buf, size_t nbytes, uint flags,
704 struct sockaddr* from, socklen_t* fromlen);
705 static int get_sock_name(int fd, struct sockaddr* him, socklen_t* len);
706 static int sendto(int fd, char* buf, size_t len, uint flags,
707 struct sockaddr* to, socklen_t tolen);
708 static int socket_available(int fd, jint* pbytes);
710 static int get_sock_opt(int fd, int level, int optname,
711 char* optval, socklen_t* optlen);
712 static int set_sock_opt(int fd, int level, int optname,
713 const char* optval, socklen_t optlen);
714 static int get_host_name(char* name, int namelen);
716 static struct hostent* get_host_by_name(char* name);
718 // Support for signals (see JVM_RaiseSignal, JVM_RegisterSignal)
719 static void signal_init();
720 static void signal_init_pd();
721 static void signal_notify(int signal_number);
722 static void* signal(int signal_number, void* handler);
723 static void signal_raise(int signal_number);
724 static int signal_wait();
725 static int signal_lookup();
726 static void* user_handler();
727 static void terminate_signal_thread();
728 static int sigexitnum_pd();
730 // random number generation
731 static long random(); // return 32bit pseudorandom number
732 static void init_random(long initval); // initialize random sequence
734 // Structured OS Exception support
735 static void os_exception_wrapper(java_call_t f, JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread);
737 // On Windows this will create an actual minidump, on Linux/Solaris it will simply check core dump limits
738 static void check_or_create_dump(void* exceptionRecord, void* contextRecord, char* buffer, size_t bufferSize);
740 // Get the default path to the core file
741 // Returns the length of the string
742 static int get_core_path(char* buffer, size_t bufferSize);
744 // JVMTI & JVM monitoring and management support
745 // The thread_cpu_time() and current_thread_cpu_time() are only
746 // supported if is_thread_cpu_time_supported() returns true.
747 // They are not supported on Solaris T1.
749 // Thread CPU Time - return the fast estimate on a platform
750 // On Solaris - call gethrvtime (fast) - user time only
751 // On Linux - fast clock_gettime where available - user+sys
752 // - otherwise: very slow /proc fs - user+sys
753 // On Windows - GetThreadTimes - user+sys
754 static jlong current_thread_cpu_time();
755 static jlong thread_cpu_time(Thread* t);
757 // Thread CPU Time with user_sys_cpu_time parameter.
758 //
759 // If user_sys_cpu_time is true, user+sys time is returned.
760 // Otherwise, only user time is returned
761 static jlong current_thread_cpu_time(bool user_sys_cpu_time);
762 static jlong thread_cpu_time(Thread* t, bool user_sys_cpu_time);
764 // Return a bunch of info about the timers.
765 // Note that the returned info for these two functions may be different
766 // on some platforms
767 static void current_thread_cpu_time_info(jvmtiTimerInfo *info_ptr);
768 static void thread_cpu_time_info(jvmtiTimerInfo *info_ptr);
770 static bool is_thread_cpu_time_supported();
772 // System loadavg support. Returns -1 if load average cannot be obtained.
773 static int loadavg(double loadavg[], int nelem);
775 // Hook for os specific jvm options that we don't want to abort on seeing
776 static bool obsolete_option(const JavaVMOption *option);
778 // Extensions
779 #include "runtime/os_ext.hpp"
781 public:
782 class CrashProtectionCallback : public StackObj {
783 public:
784 virtual void call() = 0;
785 };
787 // Platform dependent stuff
788 #ifdef TARGET_OS_FAMILY_linux
789 # include "os_linux.hpp"
790 # include "os_posix.hpp"
791 #endif
792 #ifdef TARGET_OS_FAMILY_solaris
793 # include "os_solaris.hpp"
794 # include "os_posix.hpp"
795 #endif
796 #ifdef TARGET_OS_FAMILY_windows
797 # include "os_windows.hpp"
798 #endif
799 #ifdef TARGET_OS_FAMILY_aix
800 # include "os_aix.hpp"
801 # include "os_posix.hpp"
802 #endif
803 #ifdef TARGET_OS_FAMILY_bsd
804 # include "os_posix.hpp"
805 # include "os_bsd.hpp"
806 #endif
807 #ifdef TARGET_OS_ARCH_linux_x86
808 # include "os_linux_x86.hpp"
809 #endif
810 #ifdef TARGET_OS_ARCH_linux_sparc
811 # include "os_linux_sparc.hpp"
812 #endif
813 #ifdef TARGET_OS_ARCH_linux_zero
814 # include "os_linux_zero.hpp"
815 #endif
816 #ifdef TARGET_OS_ARCH_solaris_x86
817 # include "os_solaris_x86.hpp"
818 #endif
819 #ifdef TARGET_OS_ARCH_solaris_sparc
820 # include "os_solaris_sparc.hpp"
821 #endif
822 #ifdef TARGET_OS_ARCH_windows_x86
823 # include "os_windows_x86.hpp"
824 #endif
825 #ifdef TARGET_OS_ARCH_linux_arm
826 # include "os_linux_arm.hpp"
827 #endif
828 #ifdef TARGET_OS_ARCH_linux_ppc
829 # include "os_linux_ppc.hpp"
830 #endif
831 #ifdef TARGET_OS_ARCH_aix_ppc
832 # include "os_aix_ppc.hpp"
833 #endif
834 #ifdef TARGET_OS_ARCH_bsd_x86
835 # include "os_bsd_x86.hpp"
836 #endif
837 #ifdef TARGET_OS_ARCH_bsd_zero
838 # include "os_bsd_zero.hpp"
839 #endif
841 public:
842 #ifndef PLATFORM_PRINT_NATIVE_STACK
843 // No platform-specific code for printing the native stack.
844 static bool platform_print_native_stack(outputStream* st, void* context,
845 char *buf, int buf_size) {
846 return false;
847 }
848 #endif
850 // debugging support (mostly used by debug.cpp but also fatal error handler)
851 static bool find(address pc, outputStream* st = tty); // OS specific function to make sense out of an address
853 static bool dont_yield(); // when true, JVM_Yield() is nop
854 static void print_statistics();
856 // Thread priority helpers (implemented in OS-specific part)
857 static OSReturn set_native_priority(Thread* thread, int native_prio);
858 static OSReturn get_native_priority(const Thread* const thread, int* priority_ptr);
859 static int java_to_os_priority[CriticalPriority + 1];
860 // Hint to the underlying OS that a task switch would not be good.
861 // Void return because it's a hint and can fail.
862 static void hint_no_preempt();
864 // Used at creation if requested by the diagnostic flag PauseAtStartup.
865 // Causes the VM to wait until an external stimulus has been applied
866 // (for Unix, that stimulus is a signal, for Windows, an external
867 // ResumeThread call)
868 static void pause();
870 // Builds a platform dependent Agent_OnLoad_<libname> function name
871 // which is used to find statically linked in agents.
872 static char* build_agent_function_name(const char *sym, const char *cname,
873 bool is_absolute_path);
875 class SuspendedThreadTaskContext {
876 public:
877 SuspendedThreadTaskContext(Thread* thread, void *ucontext) : _thread(thread), _ucontext(ucontext) {}
878 Thread* thread() const { return _thread; }
879 void* ucontext() const { return _ucontext; }
880 private:
881 Thread* _thread;
882 void* _ucontext;
883 };
885 class SuspendedThreadTask {
886 public:
887 SuspendedThreadTask(Thread* thread) : _thread(thread), _done(false) {}
888 virtual ~SuspendedThreadTask() {}
889 void run();
890 bool is_done() { return _done; }
891 virtual void do_task(const SuspendedThreadTaskContext& context) = 0;
892 protected:
893 private:
894 void internal_do_task();
895 Thread* _thread;
896 bool _done;
897 };
899 #ifndef TARGET_OS_FAMILY_windows
900 // Suspend/resume support
901 // Protocol:
902 //
903 // a thread starts in SR_RUNNING
904 //
905 // SR_RUNNING can go to
906 // * SR_SUSPEND_REQUEST when the WatcherThread wants to suspend it
907 // SR_SUSPEND_REQUEST can go to
908 // * SR_RUNNING if WatcherThread decides it waited for SR_SUSPENDED too long (timeout)
909 // * SR_SUSPENDED if the stopped thread receives the signal and switches state
910 // SR_SUSPENDED can go to
911 // * SR_WAKEUP_REQUEST when the WatcherThread has done the work and wants to resume
912 // SR_WAKEUP_REQUEST can go to
913 // * SR_RUNNING when the stopped thread receives the signal
914 // * SR_WAKEUP_REQUEST on timeout (resend the signal and try again)
915 class SuspendResume {
916 public:
917 enum State {
918 SR_RUNNING,
919 SR_SUSPEND_REQUEST,
920 SR_SUSPENDED,
921 SR_WAKEUP_REQUEST
922 };
924 private:
925 volatile State _state;
927 private:
928 /* try to switch state from state "from" to state "to"
929 * returns the state set after the method is complete
930 */
931 State switch_state(State from, State to);
933 public:
934 SuspendResume() : _state(SR_RUNNING) { }
936 State state() const { return _state; }
938 State request_suspend() {
939 return switch_state(SR_RUNNING, SR_SUSPEND_REQUEST);
940 }
942 State cancel_suspend() {
943 return switch_state(SR_SUSPEND_REQUEST, SR_RUNNING);
944 }
946 State suspended() {
947 return switch_state(SR_SUSPEND_REQUEST, SR_SUSPENDED);
948 }
950 State request_wakeup() {
951 return switch_state(SR_SUSPENDED, SR_WAKEUP_REQUEST);
952 }
954 State running() {
955 return switch_state(SR_WAKEUP_REQUEST, SR_RUNNING);
956 }
958 bool is_running() const {
959 return _state == SR_RUNNING;
960 }
962 bool is_suspend_request() const {
963 return _state == SR_SUSPEND_REQUEST;
964 }
966 bool is_suspended() const {
967 return _state == SR_SUSPENDED;
968 }
969 };
970 #endif
973 protected:
974 static long _rand_seed; // seed for random number generator
975 static int _processor_count; // number of processors
977 static char* format_boot_path(const char* format_string,
978 const char* home,
979 int home_len,
980 char fileSep,
981 char pathSep);
982 static bool set_boot_path(char fileSep, char pathSep);
983 static char** split_path(const char* path, int* n);
985 };
987 // Note that "PAUSE" is almost always used with synchronization
988 // so arguably we should provide Atomic::SpinPause() instead
989 // of the global SpinPause() with C linkage.
990 // It'd also be eligible for inlining on many platforms.
992 extern "C" int SpinPause();
994 #endif // SHARE_VM_RUNTIME_OS_HPP