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