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