1 #ifdef USE_PRAGMA_IDENT_HDR
   2 #pragma ident "@(#)os_solaris.hpp       1.121 07/06/29 04:05:00 JVM"
   3 #endif
   4 /*
   5  * Copyright 1997-2007 Sun Microsystems, Inc.  All Rights Reserved.
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This code is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License version 2 only, as
  10  * published by the Free Software Foundation.
  11  *
  12  * This code is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15  * version 2 for more details (a copy is included in the LICENSE file that
  16  * accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License version
  19  * 2 along with this work; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *  
  26  */
  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 enum lgrp_view {
  73         LGRP_VIEW_CALLER,       /* what's available to the caller */
  74         LGRP_VIEW_OS            /* what's available to operating system */
  75   } lgrp_view_t;
  76 
  77   typedef lgrp_id_t (*lgrp_home_func_t)(idtype_t idtype, id_t id);
  78   typedef lgrp_cookie_t (*lgrp_init_func_t)(lgrp_view_t view);
  79   typedef int (*lgrp_fini_func_t)(lgrp_cookie_t cookie);
  80   typedef lgrp_id_t (*lgrp_root_func_t)(lgrp_cookie_t cookie);
  81   typedef int (*lgrp_children_func_t)(lgrp_cookie_t  cookie,  lgrp_id_t  parent,
  82                                       lgrp_id_t *lgrp_array, uint_t lgrp_array_size);
  83   typedef int (*lgrp_nlgrps_func_t)(lgrp_cookie_t cookie);
  84   typedef int (*lgrp_cookie_stale_func_t)(lgrp_cookie_t cookie);
  85   typedef int (*meminfo_func_t)(const uint64_t inaddr[],   int addr_count,
  86                                 const uint_t  info_req[],  int info_count,
  87                                 uint64_t  outdata[], uint_t validity[]);
  88 
  89   static lgrp_home_func_t _lgrp_home;
  90   static lgrp_init_func_t _lgrp_init;
  91   static lgrp_fini_func_t _lgrp_fini;
  92   static lgrp_root_func_t _lgrp_root;
  93   static lgrp_children_func_t _lgrp_children;
  94   static lgrp_nlgrps_func_t _lgrp_nlgrps;
  95   static lgrp_cookie_stale_func_t _lgrp_cookie_stale;
  96   static lgrp_cookie_t _lgrp_cookie;
  97 
  98   static meminfo_func_t _meminfo;
  99 
 100   // Large Page Support--mpss.
 101   static bool set_mpss_range(caddr_t start, size_t bytes, size_t align);
 102 
 103   static void init_thread_fpu_state(void);
 104 
 105   static void try_enable_extended_io();
 106 
 107   // For signal-chaining
 108   static unsigned long sigs;                 // mask of signals that have
 109                                              // preinstalled signal handlers
 110   static struct sigaction *(*get_signal_action)(int);
 111   static struct sigaction *get_preinstalled_handler(int);
 112   static int (*get_libjsig_version)();
 113   static void save_preinstalled_handler(int, struct sigaction&);
 114   static void check_signal_handler(int sig);
 115 
 116   // For overridable signals
 117   static int _SIGinterrupt;                  // user-overridable INTERRUPT_SIGNAL
 118   static int _SIGasync;                      // user-overridable ASYNC_SIGNAL
 119   static void set_SIGinterrupt(int newsig) { _SIGinterrupt = newsig; }
 120   static void set_SIGasync(int newsig) { _SIGasync = newsig; }
 121 
 122 
 123  public:
 124   // Large Page Support--ISM.
 125   static bool largepage_range(char* addr, size_t size); 
 126 
 127   static int SIGinterrupt() { return _SIGinterrupt; }
 128   static int SIGasync() { return _SIGasync; }
 129   static address handler_start, handler_end; // start and end pc of thr_sighndlrinfo
 130 
 131   static bool valid_stack_address(Thread* thread, address sp);
 132   static bool valid_ucontext(Thread* thread, ucontext_t* valid, ucontext_t* suspect);
 133   static ucontext_t* get_valid_uc_in_signal_handler(Thread* thread,
 134     ucontext_t* uc);
 135 
 136   static ExtendedPC  ucontext_get_ExtendedPC(ucontext_t* uc);
 137   static intptr_t*   ucontext_get_sp(ucontext_t* uc);
 138   // ucontext_get_fp() is only used by Solaris X86 (see note below)
 139   static intptr_t*   ucontext_get_fp(ucontext_t* uc);
 140 
 141   // For Analyzer Forte AsyncGetCallTrace profiling support:
 142   // Parameter ret_fp is only used by Solaris X86.
 143   //
 144   // We should have different declarations of this interface in
 145   // os_solaris_i486.hpp and os_solaris_sparc.hpp, but that file
 146   // provides extensions to the os class and not the Solaris class.
 147   static ExtendedPC fetch_frame_from_ucontext(Thread* thread, ucontext_t* uc,
 148     intptr_t** ret_sp, intptr_t** ret_fp);
 149 
 150   static void hotspot_sigmask(Thread* thread);
 151 
 152  protected:
 153   // Solaris-specific interface goes here
 154   static julong available_memory();
 155   static julong physical_memory() { return _physical_memory; }
 156   static julong _physical_memory;
 157   static void initialize_system_info();
 158   static int _dev_zero_fd;
 159   static int get_dev_zero_fd() { return _dev_zero_fd; }
 160   static void set_dev_zero_fd(int fd) { _dev_zero_fd = fd; }
 161   static char* mmap_chunk(char *addr, size_t size, int flags, int prot);
 162   static bool mpss_sanity_check(bool warn, size_t * page_size);
 163   static bool ism_sanity_check (bool warn, size_t * page_size);
 164 
 165   // Workaround for 4352906. thr_stksegment sometimes returns
 166   // a bad value for the primordial thread's stack base when
 167   // it is called more than one time. 
 168   // Workaround is to cache the initial value to avoid further 
 169   // calls to thr_stksegment. 
 170   // It appears that someone (Hotspot?) is trashing the user's
 171   // proc_t structure (note that this is a system struct).
 172   static address _main_stack_base;
 173 
 174  public:
 175   static void libthread_init();        
 176   static void synchronization_init();  
 177   static void liblgrp_init();  
 178   // Load miscellaneous symbols.
 179   static void misc_sym_init();
 180   // This boolean allows users to forward their own non-matching signals
 181   // to JVM_handle_solaris_signal, harmlessly.
 182   static bool signal_handlers_are_installed;
 183 
 184   static void signal_sets_init();
 185   static void install_signal_handlers();
 186   static void set_signal_handler(int sig, bool set_installed, bool oktochain);
 187   static void init_signal_mem();
 188   static bool is_sig_ignored(int sig);
 189   static void set_our_sigflags(int, int);
 190   static int get_our_sigflags(int);
 191 
 192   // For signal-chaining
 193   static bool libjsig_is_loaded; // libjsig that interposes sigaction(),
 194                                  // signal(), sigset() is loaded
 195   static struct sigaction *get_chained_signal_action(int sig);
 196   static bool chained_handler(int sig, siginfo_t *siginfo, void *context);
 197 
 198   // The following allow us to link against both the old and new libthread (2.8)
 199   // and exploit the new libthread functionality if available.
 200 
 201   static bool T2_libthread()                                { return _T2_libthread; }
 202   static void set_T2_libthread(bool T2_libthread) { _T2_libthread = T2_libthread; }
 203 
 204   static int thr_getstate(thread_t tid, int *flag, unsigned *lwp, stack_t *ss, gregset_t rs)
 205     { return _thr_getstate(tid, flag, lwp, ss, rs); }
 206   static void set_thr_getstate(int_fnP_thread_t_iP_uP_stack_tP_gregset_t func)
 207     { _thr_getstate = func; }
 208 
 209   static int thr_setstate(thread_t tid, int flag, gregset_t rs)   { return _thr_setstate(tid, flag, rs); }
 210   static void set_thr_setstate(int_fnP_thread_t_i_gregset_t func) { _thr_setstate = func; }
 211   
 212   static int thr_setmutator(thread_t tid, int enabled)    { return _thr_setmutator(tid, enabled); }
 213   static void set_thr_setmutator(int_fnP_thread_t_i func) { _thr_setmutator = func; }
 214 
 215   static int  thr_suspend_mutator(thread_t tid)              { return _thr_suspend_mutator(tid); }
 216   static void set_thr_suspend_mutator(int_fnP_thread_t func) { _thr_suspend_mutator = func; }
 217 
 218   static int  thr_continue_mutator(thread_t tid)              { return _thr_continue_mutator(tid); }
 219   static void set_thr_continue_mutator(int_fnP_thread_t func) { _thr_continue_mutator = func; }
 220 
 221   // Allows us to switch between lwp and thread -based synchronization
 222   static int mutex_lock(mutex_t *mx)    { return _mutex_lock(mx); }
 223   static int mutex_trylock(mutex_t *mx) { return _mutex_trylock(mx); }
 224   static int mutex_unlock(mutex_t *mx)  { return _mutex_unlock(mx); }
 225   static int mutex_init(mutex_t *mx)    { return _mutex_init(mx, os::Solaris::mutex_scope(), NULL); }
 226   static int mutex_destroy(mutex_t *mx) { return _mutex_destroy(mx); }
 227   static int mutex_scope()              { return _mutex_scope; }
 228 
 229   static void set_mutex_lock(int_fnP_mutex_tP func)      { _mutex_lock = func; }
 230   static void set_mutex_trylock(int_fnP_mutex_tP func)   { _mutex_trylock = func; }
 231   static void set_mutex_unlock(int_fnP_mutex_tP func)    { _mutex_unlock = func; }
 232   static void set_mutex_init(int_fnP_mutex_tP_i_vP func) { _mutex_init = func; }
 233   static void set_mutex_destroy(int_fnP_mutex_tP func)   { _mutex_destroy = func; }
 234   static void set_mutex_scope(int scope)                 { _mutex_scope = scope; }
 235 
 236   static int cond_timedwait(cond_t *cv, mutex_t *mx, timestruc_t *abst)
 237                                                 { return _cond_timedwait(cv, mx, abst); }
 238   static int cond_wait(cond_t *cv, mutex_t *mx) { return _cond_wait(cv, mx); }
 239   static int cond_signal(cond_t *cv)            { return _cond_signal(cv); }
 240   static int cond_broadcast(cond_t *cv)         { return _cond_broadcast(cv); }
 241   static int cond_init(cond_t *cv)              { return _cond_init(cv, os::Solaris::cond_scope(), NULL); }
 242   static int cond_destroy(cond_t *cv)           { return _cond_destroy(cv); }
 243   static int cond_scope()                       { return _cond_scope; }
 244 
 245   static void set_cond_timedwait(int_fnP_cond_tP_mutex_tP_timestruc_tP func)
 246                                                            { _cond_timedwait = func; }
 247   static void set_cond_wait(int_fnP_cond_tP_mutex_tP func) { _cond_wait = func; }
 248   static void set_cond_signal(int_fnP_cond_tP func)        { _cond_signal = func; }
 249   static void set_cond_broadcast(int_fnP_cond_tP func)     { _cond_broadcast = func; }
 250   static void set_cond_init(int_fnP_cond_tP_i_vP func)     { _cond_init = func; }
 251   static void set_cond_destroy(int_fnP_cond_tP func)       { _cond_destroy = func; }
 252   static void set_cond_scope(int scope)                    { _cond_scope = scope; }
 253 
 254   static void set_lgrp_home(lgrp_home_func_t func) { _lgrp_home = func; }
 255   static void set_lgrp_init(lgrp_init_func_t func) { _lgrp_init = func; }
 256   static void set_lgrp_fini(lgrp_fini_func_t func) { _lgrp_fini = func; }
 257   static void set_lgrp_root(lgrp_root_func_t func) { _lgrp_root = func; }
 258   static void set_lgrp_children(lgrp_children_func_t func) { _lgrp_children = func; }
 259   static void set_lgrp_nlgrps(lgrp_nlgrps_func_t func)     { _lgrp_nlgrps = func; }
 260   static void set_lgrp_cookie_stale(lgrp_cookie_stale_func_t func) { _lgrp_cookie_stale = func; }
 261   static void set_lgrp_cookie(lgrp_cookie_t cookie)  { _lgrp_cookie = cookie; }
 262 
 263   static id_t lgrp_home(idtype_t type, id_t id)      { return _lgrp_home != NULL ? _lgrp_home(type, id) : -1; }
 264   static lgrp_cookie_t lgrp_init(lgrp_view_t view)   { return _lgrp_init != NULL ? _lgrp_init(view) : 0; }
 265   static int lgrp_fini(lgrp_cookie_t cookie)         { return _lgrp_fini != NULL ? _lgrp_fini(cookie) : -1; }
 266   static lgrp_id_t lgrp_root(lgrp_cookie_t cookie)   { return _lgrp_root != NULL ? _lgrp_root(cookie) : -1; };
 267   static int lgrp_children(lgrp_cookie_t  cookie,  lgrp_id_t  parent,
 268                     lgrp_id_t *lgrp_array, uint_t lgrp_array_size) {
 269     return _lgrp_children != NULL ? _lgrp_children(cookie, parent, lgrp_array, lgrp_array_size) : -1;
 270   }
 271   static int lgrp_nlgrps(lgrp_cookie_t cookie)       { return _lgrp_nlgrps != NULL ? _lgrp_nlgrps(cookie) : -1; }
 272   static int lgrp_cookie_stale(lgrp_cookie_t cookie) {
 273     return _lgrp_cookie_stale != NULL ? _lgrp_cookie_stale(cookie) : -1; 
 274   }
 275   static lgrp_cookie_t lgrp_cookie()                 { return _lgrp_cookie; }
 276 
 277   static void set_meminfo(meminfo_func_t func)       { _meminfo = func; }
 278   static int meminfo (const uint64_t inaddr[],   int addr_count,
 279                      const uint_t  info_req[],  int info_count,
 280                      uint64_t  outdata[], uint_t validity[]) {
 281     return _meminfo != NULL ? _meminfo(inaddr, addr_count, info_req, info_count,
 282                                        outdata, validity) : -1;
 283   }
 284 
 285   enum {
 286     clear_interrupted = true
 287   };
 288   static void setup_interruptible(JavaThread* thread);
 289   static void setup_interruptible_already_blocked(JavaThread* thread);
 290   static JavaThread* setup_interruptible();
 291   static void cleanup_interruptible(JavaThread* thread);
 292 
 293   // perf counter incrementers used by _INTERRUPTIBLE 
 294 
 295   static void bump_interrupted_before_count();
 296   static void bump_interrupted_during_count();
 297 
 298 #ifdef ASSERT
 299   static JavaThread* setup_interruptible_native();
 300   static void cleanup_interruptible_native(JavaThread* thread);
 301 #endif
 302 
 303   static sigset_t* unblocked_signals();
 304   static sigset_t* vm_signals();
 305   static sigset_t* allowdebug_blocked_signals();
 306 
 307   // %%% Following should be promoted to os.hpp:
 308   // Trace number of created threads
 309   static          jint  _os_thread_limit;
 310   static volatile jint  _os_thread_count;
 311 
 312   // Minimum stack size a thread can be created with (allowing
 313   // the VM to completely create the thread and enter user code)
 314 
 315   static size_t min_stack_allowed;
 316 
 317   // Stack overflow handling
 318 
 319   static int max_register_window_saves_before_flushing();
 320 
 321   // Stack repair handling
 322 
 323   // none present 
 324 
 325 };
 326 
 327 class PlatformEvent : public CHeapObj {
 328   private:
 329     double CachePad [4] ;   // increase odds that _mutex is sole occupant of cache line
 330     volatile int _Event ;
 331     int _nParked ;
 332     int _pipev [2] ; 
 333     mutex_t _mutex  [1] ;
 334     cond_t  _cond   [1] ;
 335     double PostPad  [2] ;  
 336 
 337   protected:
 338     // Defining a protected ctor effectively gives us an abstract base class.
 339     // That is, a PlatformEvent can never be instantiated "naked" but only
 340     // as a part of a ParkEvent (recall that ParkEvent extends PlatformEvent).  
 341     // TODO-FIXME: make dtor private
 342     ~PlatformEvent() { guarantee (0, "invariant") ; }
 343     PlatformEvent() {
 344       int status;
 345       status = os::Solaris::cond_init(_cond);
 346       assert_status(status == 0, status, "cond_init");
 347       status = os::Solaris::mutex_init(_mutex);
 348       assert_status(status == 0, status, "mutex_init");
 349       _Event   = 0 ;  
 350       _nParked = 0 ;
 351       _pipev[0] = _pipev[1] = -1 ; 
 352     }
 353 
 354   public:
 355     // Exercise caution using reset() and fired() -- they may require MEMBARs
 356     void reset() { _Event = 0 ; } 
 357     int  fired() { return _Event; } 
 358     void park () ; 
 359     int  park (jlong millis) ; 
 360     int  TryPark () ; 
 361     void unpark () ; 
 362 } ; 
 363 
 364 class PlatformParker : public CHeapObj { 
 365   protected:
 366     mutex_t _mutex [1] ; 
 367     cond_t  _cond  [1] ; 
 368 
 369   public:       // TODO-FIXME: make dtor private
 370     ~PlatformParker() { guarantee (0, "invariant") ; }
 371 
 372   public:
 373     PlatformParker() {
 374       int status;
 375       status = os::Solaris::cond_init(_cond);
 376       assert_status(status == 0, status, "cond_init");
 377       status = os::Solaris::mutex_init(_mutex);
 378       assert_status(status == 0, status, "mutex_init");
 379     }
 380 } ; 
 381 
 382 
 383 
 384     
 385 
 386