Mon, 20 Jun 2016 22:46:28 -0700
8155968: Update command line options
Reviewed-by: gthornbr, hseigel, mschoene
Contributed-by: gerard.ziemski@oracle.com
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);
152 static size_t page_size_for_region(size_t region_size, size_t min_pages, bool must_be_aligned);
154 public:
155 static void init(void); // Called before command line parsing
156 static void init_before_ergo(void); // Called after command line parsing
157 // before VM ergonomics processing.
158 static jint init_2(void); // Called after command line parsing
159 // and VM ergonomics processing
160 static void init_globals(void) { // Called from init_globals() in init.cpp
161 init_globals_ext();
162 }
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 // During bootstrap if _processor_count is not yet initialized
218 // we claim to be MP as that is safest. If any platform has a
219 // stub generator that might be triggered in this phase and for
220 // which being declared MP when in fact not, is a problem - then
221 // the bootstrap routine for the stub generator needs to check
222 // the processor count directly and leave the bootstrap routine
223 // in place until called after initialization has ocurred.
224 return (_processor_count != 1) || AssumeMP;
225 }
226 static julong available_memory();
227 static julong physical_memory();
228 static bool has_allocatable_memory_limit(julong* limit);
229 static bool is_server_class_machine();
231 // number of CPUs
232 static int processor_count() {
233 return _processor_count;
234 }
235 static void set_processor_count(int count) { _processor_count = count; }
237 // Returns the number of CPUs this process is currently allowed to run on.
238 // Note that on some OSes this can change dynamically.
239 static int active_processor_count();
241 // Bind processes to processors.
242 // This is a two step procedure:
243 // first you generate a distribution of processes to processors,
244 // then you bind processes according to that distribution.
245 // Compute a distribution for number of processes to processors.
246 // Stores the processor id's into the distribution array argument.
247 // Returns true if it worked, false if it didn't.
248 static bool distribute_processes(uint length, uint* distribution);
249 // Binds the current process to a processor.
250 // Returns true if it worked, false if it didn't.
251 static bool bind_to_processor(uint processor_id);
253 // Give a name to the current thread.
254 static void set_native_thread_name(const char *name);
256 // Interface for stack banging (predetect possible stack overflow for
257 // exception processing) There are guard pages, and above that shadow
258 // pages for stack overflow checking.
259 static bool uses_stack_guard_pages();
260 static bool allocate_stack_guard_pages();
261 static void bang_stack_shadow_pages();
262 static bool stack_shadow_pages_available(Thread *thread, methodHandle method);
264 // OS interface to Virtual Memory
266 // Return the default page size.
267 static int vm_page_size();
269 // Returns the page size to use for a region of memory.
270 // region_size / min_pages will always be greater than or equal to the
271 // returned value. The returned value will divide region_size.
272 static size_t page_size_for_region_aligned(size_t region_size, size_t min_pages);
274 // Returns the page size to use for a region of memory.
275 // region_size / min_pages will always be greater than or equal to the
276 // returned value. The returned value might not divide region_size.
277 static size_t page_size_for_region_unaligned(size_t region_size, size_t min_pages);
279 // Return the largest page size that can be used
280 static size_t max_page_size() {
281 // The _page_sizes array is sorted in descending order.
282 return _page_sizes[0];
283 }
285 // Methods for tracing page sizes returned by the above method; enabled by
286 // TracePageSizes. The region_{min,max}_size parameters should be the values
287 // passed to page_size_for_region() and page_size should be the result of that
288 // call. The (optional) base and size parameters should come from the
289 // ReservedSpace base() and size() methods.
290 static void trace_page_sizes(const char* str, const size_t* page_sizes,
291 int count) PRODUCT_RETURN;
292 static void trace_page_sizes(const char* str, const size_t region_min_size,
293 const size_t region_max_size,
294 const size_t page_size,
295 const char* base = NULL,
296 const size_t size = 0) PRODUCT_RETURN;
298 static int vm_allocation_granularity();
299 static char* reserve_memory(size_t bytes, char* addr = 0,
300 size_t alignment_hint = 0);
301 static char* reserve_memory(size_t bytes, char* addr,
302 size_t alignment_hint, MEMFLAGS flags);
303 static char* reserve_memory_aligned(size_t size, size_t alignment);
304 static char* attempt_reserve_memory_at(size_t bytes, char* addr);
305 static void split_reserved_memory(char *base, size_t size,
306 size_t split, bool realloc);
307 static bool commit_memory(char* addr, size_t bytes, bool executable);
308 static bool commit_memory(char* addr, size_t size, size_t alignment_hint,
309 bool executable);
310 // Same as commit_memory() that either succeeds or calls
311 // vm_exit_out_of_memory() with the specified mesg.
312 static void commit_memory_or_exit(char* addr, size_t bytes,
313 bool executable, const char* mesg);
314 static void commit_memory_or_exit(char* addr, size_t size,
315 size_t alignment_hint,
316 bool executable, const char* mesg);
317 static bool uncommit_memory(char* addr, size_t bytes);
318 static bool release_memory(char* addr, size_t bytes);
320 // Touch memory pages that cover the memory range from start to end (exclusive)
321 // to make the OS back the memory range with actual memory.
322 // Current implementation may not touch the last page if unaligned addresses
323 // are passed.
324 static void pretouch_memory(char* start, char* end);
326 enum ProtType { MEM_PROT_NONE, MEM_PROT_READ, MEM_PROT_RW, MEM_PROT_RWX };
327 static bool protect_memory(char* addr, size_t bytes, ProtType prot,
328 bool is_committed = true);
330 static bool guard_memory(char* addr, size_t bytes);
331 static bool unguard_memory(char* addr, size_t bytes);
332 static bool create_stack_guard_pages(char* addr, size_t bytes);
333 static bool pd_create_stack_guard_pages(char* addr, size_t bytes);
334 static bool remove_stack_guard_pages(char* addr, size_t bytes);
336 static char* map_memory(int fd, const char* file_name, size_t file_offset,
337 char *addr, size_t bytes, bool read_only = false,
338 bool allow_exec = false);
339 static char* remap_memory(int fd, const char* file_name, size_t file_offset,
340 char *addr, size_t bytes, bool read_only,
341 bool allow_exec);
342 static bool unmap_memory(char *addr, size_t bytes);
343 static void free_memory(char *addr, size_t bytes, size_t alignment_hint);
344 static void realign_memory(char *addr, size_t bytes, size_t alignment_hint);
346 // NUMA-specific interface
347 static bool numa_has_static_binding();
348 static bool numa_has_group_homing();
349 static void numa_make_local(char *addr, size_t bytes, int lgrp_hint);
350 static void numa_make_global(char *addr, size_t bytes);
351 static size_t numa_get_groups_num();
352 static size_t numa_get_leaf_groups(int *ids, size_t size);
353 static bool numa_topology_changed();
354 static int numa_get_group_id();
356 // Page manipulation
357 struct page_info {
358 size_t size;
359 int lgrp_id;
360 };
361 static bool get_page_info(char *start, page_info* info);
362 static char* scan_pages(char *start, char* end, page_info* page_expected, page_info* page_found);
364 static char* non_memory_address_word();
365 // reserve, commit and pin the entire memory region
366 static char* reserve_memory_special(size_t size, size_t alignment,
367 char* addr, bool executable);
368 static bool release_memory_special(char* addr, size_t bytes);
369 static void large_page_init();
370 static size_t large_page_size();
371 static bool can_commit_large_page_memory();
372 static bool can_execute_large_page_memory();
374 // OS interface to polling page
375 static address get_polling_page() { return _polling_page; }
376 static void set_polling_page(address page) { _polling_page = page; }
377 static bool is_poll_address(address addr) { return addr >= _polling_page && addr < (_polling_page + os::vm_page_size()); }
378 static void make_polling_page_unreadable();
379 static void make_polling_page_readable();
381 // Routines used to serialize the thread state without using membars
382 static void serialize_thread_states();
384 // Since we write to the serialize page from every thread, we
385 // want stores to be on unique cache lines whenever possible
386 // in order to minimize CPU cross talk. We pre-compute the
387 // amount to shift the thread* to make this offset unique to
388 // each thread.
389 static int get_serialize_page_shift_count() {
390 return SerializePageShiftCount;
391 }
393 static void set_serialize_page_mask(uintptr_t mask) {
394 _serialize_page_mask = mask;
395 }
397 static unsigned int get_serialize_page_mask() {
398 return _serialize_page_mask;
399 }
401 static void set_memory_serialize_page(address page);
403 static address get_memory_serialize_page() {
404 return (address)_mem_serialize_page;
405 }
407 static inline void write_memory_serialize_page(JavaThread *thread) {
408 uintptr_t page_offset = ((uintptr_t)thread >>
409 get_serialize_page_shift_count()) &
410 get_serialize_page_mask();
411 *(volatile int32_t *)((uintptr_t)_mem_serialize_page+page_offset) = 1;
412 }
414 static bool is_memory_serialize_page(JavaThread *thread, address addr) {
415 if (UseMembar) return false;
416 // Previously this function calculated the exact address of this
417 // thread's serialize page, and checked if the faulting address
418 // was equal. However, some platforms mask off faulting addresses
419 // to the page size, so now we just check that the address is
420 // within the page. This makes the thread argument unnecessary,
421 // but we retain the NULL check to preserve existing behaviour.
422 if (thread == NULL) return false;
423 address page = (address) _mem_serialize_page;
424 return addr >= page && addr < (page + os::vm_page_size());
425 }
427 static void block_on_serialize_page_trap();
429 // threads
431 enum ThreadType {
432 vm_thread,
433 cgc_thread, // Concurrent GC thread
434 pgc_thread, // Parallel GC thread
435 java_thread,
436 compiler_thread,
437 watcher_thread,
438 os_thread
439 };
441 static bool create_thread(Thread* thread,
442 ThreadType thr_type,
443 size_t stack_size = 0);
444 static bool create_main_thread(JavaThread* thread);
445 static bool create_attached_thread(JavaThread* thread);
446 static void pd_start_thread(Thread* thread);
447 static void start_thread(Thread* thread);
449 static void initialize_thread(Thread* thr);
450 static void free_thread(OSThread* osthread);
452 // thread id on Linux/64bit is 64bit, on Windows and Solaris, it's 32bit
453 static intx current_thread_id();
454 static int current_process_id();
455 static int sleep(Thread* thread, jlong ms, bool interruptable);
456 // Short standalone OS sleep suitable for slow path spin loop.
457 // Ignores Thread.interrupt() (so keep it short).
458 // ms = 0, will sleep for the least amount of time allowed by the OS.
459 static void naked_short_sleep(jlong ms);
460 static void infinite_sleep(); // never returns, use with CAUTION
461 static void yield(); // Yields to all threads with same priority
462 enum YieldResult {
463 YIELD_SWITCHED = 1, // caller descheduled, other ready threads exist & ran
464 YIELD_NONEREADY = 0, // No other runnable/ready threads.
465 // platform-specific yield return immediately
466 YIELD_UNKNOWN = -1 // Unknown: platform doesn't support _SWITCHED or _NONEREADY
467 // YIELD_SWITCHED and YIELD_NONREADY imply the platform supports a "strong"
468 // yield that can be used in lieu of blocking.
469 } ;
470 static YieldResult NakedYield () ;
471 static void yield_all(int attempts = 0); // Yields to all other threads including lower priority
472 static void loop_breaker(int attempts); // called from within tight loops to possibly influence time-sharing
473 static OSReturn set_priority(Thread* thread, ThreadPriority priority);
474 static OSReturn get_priority(const Thread* const thread, ThreadPriority& priority);
476 static void interrupt(Thread* thread);
477 static bool is_interrupted(Thread* thread, bool clear_interrupted);
479 static int pd_self_suspend_thread(Thread* thread);
481 static ExtendedPC fetch_frame_from_context(void* ucVoid, intptr_t** sp, intptr_t** fp);
482 static frame fetch_frame_from_context(void* ucVoid);
484 static ExtendedPC get_thread_pc(Thread *thread);
485 static void breakpoint();
487 static address current_stack_pointer();
488 static address current_stack_base();
489 static size_t current_stack_size();
491 static void verify_stack_alignment() PRODUCT_RETURN;
493 static int message_box(const char* title, const char* message);
494 static char* do_you_want_to_debug(const char* message);
496 // run cmd in a separate process and return its exit code; or -1 on failures
497 static int fork_and_exec(char *cmd);
499 // os::exit() is merged with vm_exit()
500 // static void exit(int num);
502 // Terminate the VM, but don't exit the process
503 static void shutdown();
505 // Terminate with an error. Default is to generate a core file on platforms
506 // that support such things. This calls shutdown() and then aborts.
507 static void abort(bool dump_core = true);
509 // Die immediately, no exit hook, no abort hook, no cleanup.
510 static void die();
512 // File i/o operations
513 static const int default_file_open_flags();
514 static int open(const char *path, int oflag, int mode);
515 static FILE* open(int fd, const char* mode);
516 static int close(int fd);
517 static jlong lseek(int fd, jlong offset, int whence);
518 static char* native_path(char *path);
519 static int ftruncate(int fd, jlong length);
520 static int fsync(int fd);
521 static int available(int fd, jlong *bytes);
523 //File i/o operations
525 static size_t read(int fd, void *buf, unsigned int nBytes);
526 static size_t restartable_read(int fd, void *buf, unsigned int nBytes);
527 static size_t write(int fd, const void *buf, unsigned int nBytes);
529 // Reading directories.
530 static DIR* opendir(const char* dirname);
531 static int readdir_buf_size(const char *path);
532 static struct dirent* readdir(DIR* dirp, dirent* dbuf);
533 static int closedir(DIR* dirp);
535 // Dynamic library extension
536 static const char* dll_file_extension();
538 static const char* get_temp_directory();
539 static const char* get_current_directory(char *buf, size_t buflen);
541 // Builds a platform-specific full library path given a ld path and lib name
542 // Returns true if buffer contains full path to existing file, false otherwise
543 static bool dll_build_name(char* buffer, size_t size,
544 const char* pathname, const char* fname);
546 // Symbol lookup, find nearest function name; basically it implements
547 // dladdr() for all platforms. Name of the nearest function is copied
548 // to buf. Distance from its base address is optionally returned as offset.
549 // If function name is not found, buf[0] is set to '\0' and offset is
550 // set to -1 (if offset is non-NULL).
551 static bool dll_address_to_function_name(address addr, char* buf,
552 int buflen, int* offset);
554 // Locate DLL/DSO. On success, full path of the library is copied to
555 // buf, and offset is optionally set to be the distance between addr
556 // and the library's base address. On failure, buf[0] is set to '\0'
557 // and offset is set to -1 (if offset is non-NULL).
558 static bool dll_address_to_library_name(address addr, char* buf,
559 int buflen, int* offset);
561 // Find out whether the pc is in the static code for jvm.dll/libjvm.so.
562 static bool address_is_in_vm(address addr);
564 // Loads .dll/.so and
565 // in case of error it checks if .dll/.so was built for the
566 // same architecture as Hotspot is running on
567 static void* dll_load(const char *name, char *ebuf, int ebuflen);
569 // lookup symbol in a shared library
570 static void* dll_lookup(void* handle, const char* name);
572 // Unload library
573 static void dll_unload(void *lib);
575 // Return the handle of this process
576 static void* get_default_process_handle();
578 // Check for static linked agent library
579 static bool find_builtin_agent(AgentLibrary *agent_lib, const char *syms[],
580 size_t syms_len);
582 // Find agent entry point
583 static void *find_agent_function(AgentLibrary *agent_lib, bool check_lib,
584 const char *syms[], size_t syms_len);
586 // Print out system information; they are called by fatal error handler.
587 // Output format may be different on different platforms.
588 static void print_os_info(outputStream* st);
589 static void print_os_info_brief(outputStream* st);
590 static void print_cpu_info(outputStream* st);
591 static void pd_print_cpu_info(outputStream* st);
592 static void print_memory_info(outputStream* st);
593 static void print_dll_info(outputStream* st);
594 static void print_environment_variables(outputStream* st, const char** env_list, char* buffer, int len);
595 static void print_context(outputStream* st, void* context);
596 static void print_register_info(outputStream* st, void* context);
597 static void print_siginfo(outputStream* st, void* siginfo);
598 static void print_signal_handlers(outputStream* st, char* buf, size_t buflen);
599 static void print_date_and_time(outputStream* st);
601 static void print_location(outputStream* st, intptr_t x, bool verbose = false);
602 static size_t lasterror(char *buf, size_t len);
603 static int get_last_error();
605 // Determines whether the calling process is being debugged by a user-mode debugger.
606 static bool is_debugger_attached();
608 // wait for a key press if PauseAtExit is set
609 static void wait_for_keypress_at_exit(void);
611 // The following two functions are used by fatal error handler to trace
612 // native (C) frames. They are not part of frame.hpp/frame.cpp because
613 // frame.hpp/cpp assume thread is JavaThread, and also because different
614 // OS/compiler may have different convention or provide different API to
615 // walk C frames.
616 //
617 // We don't attempt to become a debugger, so we only follow frames if that
618 // does not require a lookup in the unwind table, which is part of the binary
619 // file but may be unsafe to read after a fatal error. So on x86, we can
620 // only walk stack if %ebp is used as frame pointer; on ia64, it's not
621 // possible to walk C stack without having the unwind table.
622 static bool is_first_C_frame(frame *fr);
623 static frame get_sender_for_C_frame(frame *fr);
625 // return current frame. pc() and sp() are set to NULL on failure.
626 static frame current_frame();
628 static void print_hex_dump(outputStream* st, address start, address end, int unitsize);
630 // returns a string to describe the exception/signal;
631 // returns NULL if exception_code is not an OS exception/signal.
632 static const char* exception_name(int exception_code, char* buf, size_t buflen);
634 // Returns native Java library, loads if necessary
635 static void* native_java_library();
637 // Fills in path to jvm.dll/libjvm.so (used by the Disassembler)
638 static void jvm_path(char *buf, jint buflen);
640 // Returns true if we are running in a headless jre.
641 static bool is_headless_jre();
643 // JNI names
644 static void print_jni_name_prefix_on(outputStream* st, int args_size);
645 static void print_jni_name_suffix_on(outputStream* st, int args_size);
647 // File conventions
648 static const char* file_separator();
649 static const char* line_separator();
650 static const char* path_separator();
652 // Init os specific system properties values
653 static void init_system_properties_values();
655 // IO operations, non-JVM_ version.
656 static int stat(const char* path, struct stat* sbuf);
657 static bool dir_is_empty(const char* path);
659 // IO operations on binary files
660 static int create_binary_file(const char* path, bool rewrite_existing);
661 static jlong current_file_offset(int fd);
662 static jlong seek_to_file_offset(int fd, jlong offset);
664 // Thread Local Storage
665 static int allocate_thread_local_storage();
666 static void thread_local_storage_at_put(int index, void* value);
667 static void* thread_local_storage_at(int index);
668 static void free_thread_local_storage(int index);
670 // Retrieve native stack frames.
671 // Parameter:
672 // stack: an array to storage stack pointers.
673 // frames: size of above array.
674 // toSkip: number of stack frames to skip at the beginning.
675 // Return: number of stack frames captured.
676 static int get_native_stack(address* stack, int size, int toSkip = 0);
678 // General allocation (must be MT-safe)
679 static void* malloc (size_t size, MEMFLAGS flags, const NativeCallStack& stack);
680 static void* malloc (size_t size, MEMFLAGS flags);
681 static void* realloc (void *memblock, size_t size, MEMFLAGS flag, const NativeCallStack& stack);
682 static void* realloc (void *memblock, size_t size, MEMFLAGS flag);
684 static void free (void *memblock, MEMFLAGS flags = mtNone);
685 static bool check_heap(bool force = false); // verify C heap integrity
686 static char* strdup(const char *, MEMFLAGS flags = mtInternal); // Like strdup
688 #ifndef PRODUCT
689 static julong num_mallocs; // # of calls to malloc/realloc
690 static julong alloc_bytes; // # of bytes allocated
691 static julong num_frees; // # of calls to free
692 static julong free_bytes; // # of bytes freed
693 #endif
695 // SocketInterface (ex HPI SocketInterface )
696 static int socket(int domain, int type, int protocol);
697 static int socket_close(int fd);
698 static int socket_shutdown(int fd, int howto);
699 static int recv(int fd, char* buf, size_t nBytes, uint flags);
700 static int send(int fd, char* buf, size_t nBytes, uint flags);
701 static int raw_send(int fd, char* buf, size_t nBytes, uint flags);
702 static int timeout(int fd, long timeout);
703 static int listen(int fd, int count);
704 static int connect(int fd, struct sockaddr* him, socklen_t len);
705 static int bind(int fd, struct sockaddr* him, socklen_t len);
706 static int accept(int fd, struct sockaddr* him, socklen_t* len);
707 static int recvfrom(int fd, char* buf, size_t nbytes, uint flags,
708 struct sockaddr* from, socklen_t* fromlen);
709 static int get_sock_name(int fd, struct sockaddr* him, socklen_t* len);
710 static int sendto(int fd, char* buf, size_t len, uint flags,
711 struct sockaddr* to, socklen_t tolen);
712 static int socket_available(int fd, jint* pbytes);
714 static int get_sock_opt(int fd, int level, int optname,
715 char* optval, socklen_t* optlen);
716 static int set_sock_opt(int fd, int level, int optname,
717 const char* optval, socklen_t optlen);
718 static int get_host_name(char* name, int namelen);
720 static struct hostent* get_host_by_name(char* name);
722 // Support for signals (see JVM_RaiseSignal, JVM_RegisterSignal)
723 static void signal_init();
724 static void signal_init_pd();
725 static void signal_notify(int signal_number);
726 static void* signal(int signal_number, void* handler);
727 static void signal_raise(int signal_number);
728 static int signal_wait();
729 static int signal_lookup();
730 static void* user_handler();
731 static void terminate_signal_thread();
732 static int sigexitnum_pd();
734 // random number generation
735 static long random(); // return 32bit pseudorandom number
736 static void init_random(long initval); // initialize random sequence
738 // Structured OS Exception support
739 static void os_exception_wrapper(java_call_t f, JavaValue* value, methodHandle* method, JavaCallArguments* args, Thread* thread);
741 // On Windows this will create an actual minidump, on Linux/Solaris it will simply check core dump limits
742 static void check_or_create_dump(void* exceptionRecord, void* contextRecord, char* buffer, size_t bufferSize);
744 // Get the default path to the core file
745 // Returns the length of the string
746 static int get_core_path(char* buffer, size_t bufferSize);
748 // JVMTI & JVM monitoring and management support
749 // The thread_cpu_time() and current_thread_cpu_time() are only
750 // supported if is_thread_cpu_time_supported() returns true.
751 // They are not supported on Solaris T1.
753 // Thread CPU Time - return the fast estimate on a platform
754 // On Solaris - call gethrvtime (fast) - user time only
755 // On Linux - fast clock_gettime where available - user+sys
756 // - otherwise: very slow /proc fs - user+sys
757 // On Windows - GetThreadTimes - user+sys
758 static jlong current_thread_cpu_time();
759 static jlong thread_cpu_time(Thread* t);
761 // Thread CPU Time with user_sys_cpu_time parameter.
762 //
763 // If user_sys_cpu_time is true, user+sys time is returned.
764 // Otherwise, only user time is returned
765 static jlong current_thread_cpu_time(bool user_sys_cpu_time);
766 static jlong thread_cpu_time(Thread* t, bool user_sys_cpu_time);
768 // Return a bunch of info about the timers.
769 // Note that the returned info for these two functions may be different
770 // on some platforms
771 static void current_thread_cpu_time_info(jvmtiTimerInfo *info_ptr);
772 static void thread_cpu_time_info(jvmtiTimerInfo *info_ptr);
774 static bool is_thread_cpu_time_supported();
776 // System loadavg support. Returns -1 if load average cannot be obtained.
777 static int loadavg(double loadavg[], int nelem);
779 // Hook for os specific jvm options that we don't want to abort on seeing
780 static bool obsolete_option(const JavaVMOption *option);
782 // Extensions
783 #include "runtime/os_ext.hpp"
785 public:
786 class CrashProtectionCallback : public StackObj {
787 public:
788 virtual void call() = 0;
789 };
791 // Platform dependent stuff
792 #ifdef TARGET_OS_FAMILY_linux
793 # include "os_linux.hpp"
794 # include "os_posix.hpp"
795 #endif
796 #ifdef TARGET_OS_FAMILY_solaris
797 # include "os_solaris.hpp"
798 # include "os_posix.hpp"
799 #endif
800 #ifdef TARGET_OS_FAMILY_windows
801 # include "os_windows.hpp"
802 #endif
803 #ifdef TARGET_OS_FAMILY_aix
804 # include "os_aix.hpp"
805 # include "os_posix.hpp"
806 #endif
807 #ifdef TARGET_OS_FAMILY_bsd
808 # include "os_posix.hpp"
809 # include "os_bsd.hpp"
810 #endif
811 #ifdef TARGET_OS_ARCH_linux_x86
812 # include "os_linux_x86.hpp"
813 #endif
814 #ifdef TARGET_OS_ARCH_linux_sparc
815 # include "os_linux_sparc.hpp"
816 #endif
817 #ifdef TARGET_OS_ARCH_linux_zero
818 # include "os_linux_zero.hpp"
819 #endif
820 #ifdef TARGET_OS_ARCH_solaris_x86
821 # include "os_solaris_x86.hpp"
822 #endif
823 #ifdef TARGET_OS_ARCH_solaris_sparc
824 # include "os_solaris_sparc.hpp"
825 #endif
826 #ifdef TARGET_OS_ARCH_windows_x86
827 # include "os_windows_x86.hpp"
828 #endif
829 #ifdef TARGET_OS_ARCH_linux_arm
830 # include "os_linux_arm.hpp"
831 #endif
832 #ifdef TARGET_OS_ARCH_linux_ppc
833 # include "os_linux_ppc.hpp"
834 #endif
835 #ifdef TARGET_OS_ARCH_aix_ppc
836 # include "os_aix_ppc.hpp"
837 #endif
838 #ifdef TARGET_OS_ARCH_bsd_x86
839 # include "os_bsd_x86.hpp"
840 #endif
841 #ifdef TARGET_OS_ARCH_bsd_zero
842 # include "os_bsd_zero.hpp"
843 #endif
845 public:
846 #ifndef PLATFORM_PRINT_NATIVE_STACK
847 // No platform-specific code for printing the native stack.
848 static bool platform_print_native_stack(outputStream* st, void* context,
849 char *buf, int buf_size) {
850 return false;
851 }
852 #endif
854 // debugging support (mostly used by debug.cpp but also fatal error handler)
855 static bool find(address pc, outputStream* st = tty); // OS specific function to make sense out of an address
857 static bool dont_yield(); // when true, JVM_Yield() is nop
858 static void print_statistics();
860 // Thread priority helpers (implemented in OS-specific part)
861 static OSReturn set_native_priority(Thread* thread, int native_prio);
862 static OSReturn get_native_priority(const Thread* const thread, int* priority_ptr);
863 static int java_to_os_priority[CriticalPriority + 1];
864 // Hint to the underlying OS that a task switch would not be good.
865 // Void return because it's a hint and can fail.
866 static void hint_no_preempt();
868 // Used at creation if requested by the diagnostic flag PauseAtStartup.
869 // Causes the VM to wait until an external stimulus has been applied
870 // (for Unix, that stimulus is a signal, for Windows, an external
871 // ResumeThread call)
872 static void pause();
874 // Builds a platform dependent Agent_OnLoad_<libname> function name
875 // which is used to find statically linked in agents.
876 static char* build_agent_function_name(const char *sym, const char *cname,
877 bool is_absolute_path);
879 class SuspendedThreadTaskContext {
880 public:
881 SuspendedThreadTaskContext(Thread* thread, void *ucontext) : _thread(thread), _ucontext(ucontext) {}
882 Thread* thread() const { return _thread; }
883 void* ucontext() const { return _ucontext; }
884 private:
885 Thread* _thread;
886 void* _ucontext;
887 };
889 class SuspendedThreadTask {
890 public:
891 SuspendedThreadTask(Thread* thread) : _thread(thread), _done(false) {}
892 virtual ~SuspendedThreadTask() {}
893 void run();
894 bool is_done() { return _done; }
895 virtual void do_task(const SuspendedThreadTaskContext& context) = 0;
896 protected:
897 private:
898 void internal_do_task();
899 Thread* _thread;
900 bool _done;
901 };
903 #ifndef TARGET_OS_FAMILY_windows
904 // Suspend/resume support
905 // Protocol:
906 //
907 // a thread starts in SR_RUNNING
908 //
909 // SR_RUNNING can go to
910 // * SR_SUSPEND_REQUEST when the WatcherThread wants to suspend it
911 // SR_SUSPEND_REQUEST can go to
912 // * SR_RUNNING if WatcherThread decides it waited for SR_SUSPENDED too long (timeout)
913 // * SR_SUSPENDED if the stopped thread receives the signal and switches state
914 // SR_SUSPENDED can go to
915 // * SR_WAKEUP_REQUEST when the WatcherThread has done the work and wants to resume
916 // SR_WAKEUP_REQUEST can go to
917 // * SR_RUNNING when the stopped thread receives the signal
918 // * SR_WAKEUP_REQUEST on timeout (resend the signal and try again)
919 class SuspendResume {
920 public:
921 enum State {
922 SR_RUNNING,
923 SR_SUSPEND_REQUEST,
924 SR_SUSPENDED,
925 SR_WAKEUP_REQUEST
926 };
928 private:
929 volatile State _state;
931 private:
932 /* try to switch state from state "from" to state "to"
933 * returns the state set after the method is complete
934 */
935 State switch_state(State from, State to);
937 public:
938 SuspendResume() : _state(SR_RUNNING) { }
940 State state() const { return _state; }
942 State request_suspend() {
943 return switch_state(SR_RUNNING, SR_SUSPEND_REQUEST);
944 }
946 State cancel_suspend() {
947 return switch_state(SR_SUSPEND_REQUEST, SR_RUNNING);
948 }
950 State suspended() {
951 return switch_state(SR_SUSPEND_REQUEST, SR_SUSPENDED);
952 }
954 State request_wakeup() {
955 return switch_state(SR_SUSPENDED, SR_WAKEUP_REQUEST);
956 }
958 State running() {
959 return switch_state(SR_WAKEUP_REQUEST, SR_RUNNING);
960 }
962 bool is_running() const {
963 return _state == SR_RUNNING;
964 }
966 bool is_suspend_request() const {
967 return _state == SR_SUSPEND_REQUEST;
968 }
970 bool is_suspended() const {
971 return _state == SR_SUSPENDED;
972 }
973 };
974 #endif
977 protected:
978 static long _rand_seed; // seed for random number generator
979 static int _processor_count; // number of processors
981 static char* format_boot_path(const char* format_string,
982 const char* home,
983 int home_len,
984 char fileSep,
985 char pathSep);
986 static bool set_boot_path(char fileSep, char pathSep);
987 static char** split_path(const char* path, int* n);
989 };
991 // Note that "PAUSE" is almost always used with synchronization
992 // so arguably we should provide Atomic::SpinPause() instead
993 // of the global SpinPause() with C linkage.
994 // It'd also be eligible for inlining on many platforms.
996 extern "C" int SpinPause();
998 #endif // SHARE_VM_RUNTIME_OS_HPP