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