os_solaris.hpp revision 462:85f1b9537f70 
1/*
2 * Copyright 1997-2008 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 */
24
25// Solaris_OS defines the interface to Solaris operating systems
26
27class Solaris {
28  friend class os;
29
30 private:
31
32  // Support for "new" libthread APIs for getting & setting thread context (2.8)
33  #define TRS_VALID       0
34  #define TRS_NONVOLATILE 1
35  #define TRS_LWPID       2
36  #define TRS_INVALID     3
37
38  // _T2_libthread is true if we believe we are running with the newer
39  // SunSoft lib/lwp/libthread: default Solaris 9, available Solaris 8
40  // which is a lightweight libthread that also supports all T1
41  static bool _T2_libthread;
42  // These refer to new libthread interface functions
43  // They get intialized if we dynamically detect new libthread
44  static int_fnP_thread_t_iP_uP_stack_tP_gregset_t _thr_getstate;
45  static int_fnP_thread_t_i_gregset_t _thr_setstate;
46  static int_fnP_thread_t_i _thr_setmutator;
47  static int_fnP_thread_t _thr_suspend_mutator;
48  static int_fnP_thread_t _thr_continue_mutator;
49  // libthread_init sets the above, if the new functionality is detected
50
51  // initialized to libthread or lwp synchronization primitives depending on UseLWPSychronization
52  static int_fnP_mutex_tP _mutex_lock;
53  static int_fnP_mutex_tP _mutex_trylock;
54  static int_fnP_mutex_tP _mutex_unlock;
55  static int_fnP_mutex_tP_i_vP _mutex_init;
56  static int_fnP_mutex_tP _mutex_destroy;
57  static int _mutex_scope;
58
59  static int_fnP_cond_tP_mutex_tP_timestruc_tP _cond_timedwait;
60  static int_fnP_cond_tP_mutex_tP _cond_wait;
61  static int_fnP_cond_tP _cond_signal;
62  static int_fnP_cond_tP _cond_broadcast;
63  static int_fnP_cond_tP_i_vP _cond_init;
64  static int_fnP_cond_tP _cond_destroy;
65  static int _cond_scope;
66
67  typedef uintptr_t       lgrp_cookie_t;
68  typedef id_t            lgrp_id_t;
69  typedef int             lgrp_rsrc_t;
70  typedef enum lgrp_view {
71        LGRP_VIEW_CALLER,       /* what's available to the caller */
72        LGRP_VIEW_OS            /* what's available to operating system */
73  } lgrp_view_t;
74
75  typedef lgrp_id_t (*lgrp_home_func_t)(idtype_t idtype, id_t id);
76  typedef lgrp_cookie_t (*lgrp_init_func_t)(lgrp_view_t view);
77  typedef int (*lgrp_fini_func_t)(lgrp_cookie_t cookie);
78  typedef lgrp_id_t (*lgrp_root_func_t)(lgrp_cookie_t cookie);
79  typedef int (*lgrp_children_func_t)(lgrp_cookie_t  cookie,  lgrp_id_t  parent,
80                                      lgrp_id_t *lgrp_array, uint_t lgrp_array_size);
81  typedef int (*lgrp_resources_func_t)(lgrp_cookie_t  cookie,  lgrp_id_t  lgrp,
82                                      lgrp_id_t *lgrp_array, uint_t lgrp_array_size,
83                                      lgrp_rsrc_t type);
84  typedef int (*lgrp_nlgrps_func_t)(lgrp_cookie_t cookie);
85  typedef int (*lgrp_cookie_stale_func_t)(lgrp_cookie_t cookie);
86  typedef int (*meminfo_func_t)(const uint64_t inaddr[],   int addr_count,
87                                const uint_t  info_req[],  int info_count,
88                                uint64_t  outdata[], uint_t validity[]);
89
90  static lgrp_home_func_t _lgrp_home;
91  static lgrp_init_func_t _lgrp_init;
92  static lgrp_fini_func_t _lgrp_fini;
93  static lgrp_root_func_t _lgrp_root;
94  static lgrp_children_func_t _lgrp_children;
95  static lgrp_resources_func_t _lgrp_resources;
96  static lgrp_nlgrps_func_t _lgrp_nlgrps;
97  static lgrp_cookie_stale_func_t _lgrp_cookie_stale;
98  static lgrp_cookie_t _lgrp_cookie;
99
100  static meminfo_func_t _meminfo;
101
102  // Large Page Support--mpss.
103  static bool set_mpss_range(caddr_t start, size_t bytes, size_t align);
104
105  static void init_thread_fpu_state(void);
106
107  static void try_enable_extended_io();
108
109  // For signal-chaining
110  static unsigned long sigs;                 // mask of signals that have
111                                             // preinstalled signal handlers
112  static struct sigaction *(*get_signal_action)(int);
113  static struct sigaction *get_preinstalled_handler(int);
114  static int (*get_libjsig_version)();
115  static void save_preinstalled_handler(int, struct sigaction&);
116  static void check_signal_handler(int sig);
117  // For overridable signals
118  static int _SIGinterrupt;                  // user-overridable INTERRUPT_SIGNAL
119  static int _SIGasync;                      // user-overridable ASYNC_SIGNAL
120  static void set_SIGinterrupt(int newsig) { _SIGinterrupt = newsig; }
121  static void set_SIGasync(int newsig) { _SIGasync = newsig; }
122
123
124 public:
125  // Large Page Support--ISM.
126  static bool largepage_range(char* addr, size_t size);
127
128  static int SIGinterrupt() { return _SIGinterrupt; }
129  static int SIGasync() { return _SIGasync; }
130  static address handler_start, handler_end; // start and end pc of thr_sighndlrinfo
131
132  static bool valid_stack_address(Thread* thread, address sp);
133  static bool valid_ucontext(Thread* thread, ucontext_t* valid, ucontext_t* suspect);
134  static ucontext_t* get_valid_uc_in_signal_handler(Thread* thread,
135    ucontext_t* uc);
136
137  static ExtendedPC  ucontext_get_ExtendedPC(ucontext_t* uc);
138  static intptr_t*   ucontext_get_sp(ucontext_t* uc);
139  // ucontext_get_fp() is only used by Solaris X86 (see note below)
140  static intptr_t*   ucontext_get_fp(ucontext_t* uc);
141
142  // For Analyzer Forte AsyncGetCallTrace profiling support:
143  // Parameter ret_fp is only used by Solaris X86.
144  //
145  // We should have different declarations of this interface in
146  // os_solaris_i486.hpp and os_solaris_sparc.hpp, but that file
147  // provides extensions to the os class and not the Solaris class.
148  static ExtendedPC fetch_frame_from_ucontext(Thread* thread, ucontext_t* uc,
149    intptr_t** ret_sp, intptr_t** ret_fp);
150
151  static void hotspot_sigmask(Thread* thread);
152
153 protected:
154  // Solaris-specific interface goes here
155  static julong available_memory();
156  static julong physical_memory() { return _physical_memory; }
157  static julong _physical_memory;
158  static void initialize_system_info();
159  static int _dev_zero_fd;
160  static int get_dev_zero_fd() { return _dev_zero_fd; }
161  static void set_dev_zero_fd(int fd) { _dev_zero_fd = fd; }
162  static char* mmap_chunk(char *addr, size_t size, int flags, int prot);
163  static char* anon_mmap(char* requested_addr, size_t bytes, size_t alignment_hint, bool fixed);
164  static bool mpss_sanity_check(bool warn, size_t * page_size);
165  static bool ism_sanity_check (bool warn, size_t * page_size);
166
167  // Workaround for 4352906. thr_stksegment sometimes returns
168  // a bad value for the primordial thread's stack base when
169  // it is called more than one time.
170  // Workaround is to cache the initial value to avoid further
171  // calls to thr_stksegment.
172  // It appears that someone (Hotspot?) is trashing the user's
173  // proc_t structure (note that this is a system struct).
174  static address _main_stack_base;
175
176 public:
177  static void libthread_init();
178  static void synchronization_init();
179  static bool liblgrp_init();
180  // Load miscellaneous symbols.
181  static void misc_sym_init();
182  // This boolean allows users to forward their own non-matching signals
183  // to JVM_handle_solaris_signal, harmlessly.
184  static bool signal_handlers_are_installed;
185
186  static void signal_sets_init();
187  static void install_signal_handlers();
188  static void set_signal_handler(int sig, bool set_installed, bool oktochain);
189  static void init_signal_mem();
190  static bool is_sig_ignored(int sig);
191  static void set_our_sigflags(int, int);
192  static int get_our_sigflags(int);
193
194  // For signal-chaining
195  static bool libjsig_is_loaded; // libjsig that interposes sigaction(),
196                                 // signal(), sigset() is loaded
197  static struct sigaction *get_chained_signal_action(int sig);
198  static bool chained_handler(int sig, siginfo_t *siginfo, void *context);
199
200  // The following allow us to link against both the old and new libthread (2.8)
201  // and exploit the new libthread functionality if available.
202
203  static bool T2_libthread()                                { return _T2_libthread; }
204  static void set_T2_libthread(bool T2_libthread) { _T2_libthread = T2_libthread; }
205
206  static int thr_getstate(thread_t tid, int *flag, unsigned *lwp, stack_t *ss, gregset_t rs)
207    { return _thr_getstate(tid, flag, lwp, ss, rs); }
208  static void set_thr_getstate(int_fnP_thread_t_iP_uP_stack_tP_gregset_t func)
209    { _thr_getstate = func; }
210
211  static int thr_setstate(thread_t tid, int flag, gregset_t rs)   { return _thr_setstate(tid, flag, rs); }
212  static void set_thr_setstate(int_fnP_thread_t_i_gregset_t func) { _thr_setstate = func; }
213
214  static int thr_setmutator(thread_t tid, int enabled)    { return _thr_setmutator(tid, enabled); }
215  static void set_thr_setmutator(int_fnP_thread_t_i func) { _thr_setmutator = func; }
216
217  static int  thr_suspend_mutator(thread_t tid)              { return _thr_suspend_mutator(tid); }
218  static void set_thr_suspend_mutator(int_fnP_thread_t func) { _thr_suspend_mutator = func; }
219
220  static int  thr_continue_mutator(thread_t tid)              { return _thr_continue_mutator(tid); }
221  static void set_thr_continue_mutator(int_fnP_thread_t func) { _thr_continue_mutator = func; }
222
223  // Allows us to switch between lwp and thread -based synchronization
224  static int mutex_lock(mutex_t *mx)    { return _mutex_lock(mx); }
225  static int mutex_trylock(mutex_t *mx) { return _mutex_trylock(mx); }
226  static int mutex_unlock(mutex_t *mx)  { return _mutex_unlock(mx); }
227  static int mutex_init(mutex_t *mx)    { return _mutex_init(mx, os::Solaris::mutex_scope(), NULL); }
228  static int mutex_destroy(mutex_t *mx) { return _mutex_destroy(mx); }
229  static int mutex_scope()              { return _mutex_scope; }
230
231  static void set_mutex_lock(int_fnP_mutex_tP func)      { _mutex_lock = func; }
232  static void set_mutex_trylock(int_fnP_mutex_tP func)   { _mutex_trylock = func; }
233  static void set_mutex_unlock(int_fnP_mutex_tP func)    { _mutex_unlock = func; }
234  static void set_mutex_init(int_fnP_mutex_tP_i_vP func) { _mutex_init = func; }
235  static void set_mutex_destroy(int_fnP_mutex_tP func)   { _mutex_destroy = func; }
236  static void set_mutex_scope(int scope)                 { _mutex_scope = scope; }
237
238  static int cond_timedwait(cond_t *cv, mutex_t *mx, timestruc_t *abst)
239                                                { return _cond_timedwait(cv, mx, abst); }
240  static int cond_wait(cond_t *cv, mutex_t *mx) { return _cond_wait(cv, mx); }
241  static int cond_signal(cond_t *cv)            { return _cond_signal(cv); }
242  static int cond_broadcast(cond_t *cv)         { return _cond_broadcast(cv); }
243  static int cond_init(cond_t *cv)              { return _cond_init(cv, os::Solaris::cond_scope(), NULL); }
244  static int cond_destroy(cond_t *cv)           { return _cond_destroy(cv); }
245  static int cond_scope()                       { return _cond_scope; }
246
247  static void set_cond_timedwait(int_fnP_cond_tP_mutex_tP_timestruc_tP func)
248                                                           { _cond_timedwait = func; }
249  static void set_cond_wait(int_fnP_cond_tP_mutex_tP func) { _cond_wait = func; }
250  static void set_cond_signal(int_fnP_cond_tP func)        { _cond_signal = func; }
251  static void set_cond_broadcast(int_fnP_cond_tP func)     { _cond_broadcast = func; }
252  static void set_cond_init(int_fnP_cond_tP_i_vP func)     { _cond_init = func; }
253  static void set_cond_destroy(int_fnP_cond_tP func)       { _cond_destroy = func; }
254  static void set_cond_scope(int scope)                    { _cond_scope = scope; }
255
256  static void set_lgrp_home(lgrp_home_func_t func) { _lgrp_home = func; }
257  static void set_lgrp_init(lgrp_init_func_t func) { _lgrp_init = func; }
258  static void set_lgrp_fini(lgrp_fini_func_t func) { _lgrp_fini = func; }
259  static void set_lgrp_root(lgrp_root_func_t func) { _lgrp_root = func; }
260  static void set_lgrp_children(lgrp_children_func_t func)   { _lgrp_children = func; }
261  static void set_lgrp_resources(lgrp_resources_func_t func) { _lgrp_resources = func; }
262  static void set_lgrp_nlgrps(lgrp_nlgrps_func_t func)       { _lgrp_nlgrps = func; }
263  static void set_lgrp_cookie_stale(lgrp_cookie_stale_func_t func) { _lgrp_cookie_stale = func; }
264  static void set_lgrp_cookie(lgrp_cookie_t cookie)  { _lgrp_cookie = cookie; }
265
266  static id_t lgrp_home(idtype_t type, id_t id)      { return _lgrp_home != NULL ? _lgrp_home(type, id) : -1; }
267  static lgrp_cookie_t lgrp_init(lgrp_view_t view)   { return _lgrp_init != NULL ? _lgrp_init(view) : 0; }
268  static int lgrp_fini(lgrp_cookie_t cookie)         { return _lgrp_fini != NULL ? _lgrp_fini(cookie) : -1; }
269  static lgrp_id_t lgrp_root(lgrp_cookie_t cookie)   { return _lgrp_root != NULL ? _lgrp_root(cookie) : -1; };
270  static int lgrp_children(lgrp_cookie_t  cookie,  lgrp_id_t  parent,
271                    lgrp_id_t *lgrp_array, uint_t lgrp_array_size) {
272    return _lgrp_children != NULL ? _lgrp_children(cookie, parent, lgrp_array, lgrp_array_size) : -1;
273  }
274  static int lgrp_resources(lgrp_cookie_t  cookie,  lgrp_id_t  lgrp,
275                            lgrp_id_t *lgrp_array, uint_t lgrp_array_size,
276                            lgrp_rsrc_t type) {
277    return _lgrp_resources != NULL ? _lgrp_resources(cookie, lgrp, lgrp_array, lgrp_array_size, type) : -1;
278  }
279
280  static int lgrp_nlgrps(lgrp_cookie_t cookie)       { return _lgrp_nlgrps != NULL ? _lgrp_nlgrps(cookie) : -1; }
281  static int lgrp_cookie_stale(lgrp_cookie_t cookie) {
282    return _lgrp_cookie_stale != NULL ? _lgrp_cookie_stale(cookie) : -1;
283  }
284  static lgrp_cookie_t lgrp_cookie()                 { return _lgrp_cookie; }
285
286  static void set_meminfo(meminfo_func_t func)       { _meminfo = func; }
287  static int meminfo (const uint64_t inaddr[],   int addr_count,
288                     const uint_t  info_req[],  int info_count,
289                     uint64_t  outdata[], uint_t validity[]) {
290    return _meminfo != NULL ? _meminfo(inaddr, addr_count, info_req, info_count,
291                                       outdata, validity) : -1;
292  }
293
294  enum {
295    clear_interrupted = true
296  };
297  static void setup_interruptible(JavaThread* thread);
298  static void setup_interruptible_already_blocked(JavaThread* thread);
299  static JavaThread* setup_interruptible();
300  static void cleanup_interruptible(JavaThread* thread);
301
302  // perf counter incrementers used by _INTERRUPTIBLE
303
304  static void bump_interrupted_before_count();
305  static void bump_interrupted_during_count();
306
307#ifdef ASSERT
308  static JavaThread* setup_interruptible_native();
309  static void cleanup_interruptible_native(JavaThread* thread);
310#endif
311
312  static sigset_t* unblocked_signals();
313  static sigset_t* vm_signals();
314  static sigset_t* allowdebug_blocked_signals();
315
316  // %%% Following should be promoted to os.hpp:
317  // Trace number of created threads
318  static          jint  _os_thread_limit;
319  static volatile jint  _os_thread_count;
320
321  // Minimum stack size a thread can be created with (allowing
322  // the VM to completely create the thread and enter user code)
323
324  static size_t min_stack_allowed;
325
326  // Stack overflow handling
327
328  static int max_register_window_saves_before_flushing();
329
330  // Stack repair handling
331
332  // none present
333
334};
335
336class PlatformEvent : public CHeapObj {
337  private:
338    double CachePad [4] ;   // increase odds that _mutex is sole occupant of cache line
339    volatile int _Event ;
340    int _nParked ;
341    int _pipev [2] ;
342    mutex_t _mutex  [1] ;
343    cond_t  _cond   [1] ;
344    double PostPad  [2] ;
345
346  protected:
347    // Defining a protected ctor effectively gives us an abstract base class.
348    // That is, a PlatformEvent can never be instantiated "naked" but only
349    // as a part of a ParkEvent (recall that ParkEvent extends PlatformEvent).
350    // TODO-FIXME: make dtor private
351    ~PlatformEvent() { guarantee (0, "invariant") ; }
352    PlatformEvent() {
353      int status;
354      status = os::Solaris::cond_init(_cond);
355      assert_status(status == 0, status, "cond_init");
356      status = os::Solaris::mutex_init(_mutex);
357      assert_status(status == 0, status, "mutex_init");
358      _Event   = 0 ;
359      _nParked = 0 ;
360      _pipev[0] = _pipev[1] = -1 ;
361    }
362
363  public:
364    // Exercise caution using reset() and fired() -- they may require MEMBARs
365    void reset() { _Event = 0 ; }
366    int  fired() { return _Event; }
367    void park () ;
368    int  park (jlong millis) ;
369    int  TryPark () ;
370    void unpark () ;
371} ;
372
373class PlatformParker : public CHeapObj {
374  protected:
375    mutex_t _mutex [1] ;
376    cond_t  _cond  [1] ;
377
378  public:       // TODO-FIXME: make dtor private
379    ~PlatformParker() { guarantee (0, "invariant") ; }
380
381  public:
382    PlatformParker() {
383      int status;
384      status = os::Solaris::cond_init(_cond);
385      assert_status(status == 0, status, "cond_init");
386      status = os::Solaris::mutex_init(_mutex);
387      assert_status(status == 0, status, "mutex_init");
388    }
389} ;
390