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