1 /*
   2  * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright 2013 SAP AG. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef OS_AIX_VM_OS_AIX_HPP
  27 #define OS_AIX_VM_OS_AIX_HPP
  28 
  29 // Information about the protection of the page at address '0' on this os.
  30 static bool zero_page_read_protected() { return false; }
  31 
  32 // Class Aix defines the interface to the Aix operating systems.
  33 
  34 class Aix {
  35   friend class os;
  36 
  37   // For signal-chaining
  38   // highest so far (AIX 5.2) is SIGSAK (63)
  39 #define MAXSIGNUM 63
  40   // length of strings included in the libperfstat structures
  41 #define IDENTIFIER_LENGTH 64
  42 
  43   static struct sigaction sigact[MAXSIGNUM]; // saved preinstalled sigactions
  44   static unsigned int sigs;             // mask of signals that have
  45                                         // preinstalled signal handlers
  46   static bool libjsig_is_loaded;        // libjsig that interposes sigaction(),
  47                                         // __sigaction(), signal() is loaded
  48   static struct sigaction *(*get_signal_action)(int);
  49   static struct sigaction *get_preinstalled_handler(int);
  50   static void save_preinstalled_handler(int, struct sigaction&);
  51 
  52   static void check_signal_handler(int sig);
  53 
  54   // For signal flags diagnostics
  55   static int sigflags[MAXSIGNUM];
  56 
  57  protected:
  58 
  59   static julong _physical_memory;
  60   static pthread_t _main_thread;
  61   static Mutex* _createThread_lock;
  62   static int _page_size;
  63   static int _logical_cpus;
  64 
  65   // -1 = uninitialized, 0 = AIX, 1 = OS/400 (PASE)
  66   static int _on_pase;
  67 
  68   // -1 = uninitialized, otherwise 16 bit number:
  69   //  lower 8 bit - minor version
  70   //  higher 8 bit - major version
  71   //  For AIX, e.g. 0x0601 for AIX 6.1
  72   //  for OS/400 e.g. 0x0504 for OS/400 V5R4
  73   static int _os_version;
  74 
  75   // -1 = uninitialized,
  76   //  0 - SPEC1170 not requested (XPG_SUS_ENV is OFF or not set)
  77   //  1 - SPEC1170 requested (XPG_SUS_ENV is ON)
  78   static int _xpg_sus_mode;
  79 
  80   // -1 = uninitialized,
  81   //  0 - EXTSHM=OFF or not set
  82   //  1 - EXTSHM=ON
  83   static int _extshm;
  84 
  85   // page sizes on AIX.
  86   //
  87   //  AIX supports four different page sizes - 4K, 64K, 16MB, 16GB. The latter two
  88   //  (16M "large" resp. 16G "huge" pages) require special setup and are normally
  89   //  not available.
  90   //
  91   //  AIX supports multiple page sizes per process, for:
  92   //  - Stack (of the primordial thread, so not relevant for us)
  93   //  - Data - data, bss, heap, for us also pthread stacks
  94   //  - Text - text code
  95   //  - shared memory
  96   //
  97   //  Default page sizes can be set via linker options (-bdatapsize, -bstacksize, ...)
  98   //  and via environment variable LDR_CNTRL (DATAPSIZE, STACKPSIZE, ...)
  99   //
 100   //  For shared memory, page size can be set dynamically via shmctl(). Different shared memory
 101   //  regions can have different page sizes.
 102   //
 103   //  More information can be found at AIBM info center:
 104   //   http://publib.boulder.ibm.com/infocenter/aix/v6r1/index.jsp?topic=/com.ibm.aix.prftungd/doc/prftungd/multiple_page_size_app_support.htm
 105   //
 106   // -----
 107   //  We want to support 4K and 64K and, if the machine is set up correctly, 16MB pages.
 108   //
 109 
 110   // page size of the stack of newly created pthreads
 111   // (should be LDR_CNTRL DATAPSIZE because stack is allocated on heap by pthread lib)
 112   static int _stack_page_size;
 113 
 114   // Default shm page size. Read: what page size shared memory will be backed
 115   // with if no page size was set explicitly using shmctl(SHM_PAGESIZE).
 116   // Should be LDR_CNTRL SHMPSIZE.
 117   static size_t _shm_default_page_size;
 118 
 119   // True if sys V shm can be used with 64K pages dynamically.
 120   // (via shmctl(.. SHM_PAGESIZE..). Should be true for AIX 53 and
 121   // newer / PASE V6R1 and newer. (0 or 1, -1 if not initialized)
 122   static int _can_use_64K_pages;
 123 
 124   // True if sys V shm can be used with 16M pages dynamically.
 125   // (via shmctl(.. SHM_PAGESIZE..). Only true on AIX 5.3 and
 126   // newer, if the system was set up to use 16M pages and the
 127   // jvm has enough user rights. (0 or 1, -1 if not initialized)
 128   static int _can_use_16M_pages;
 129 
 130   static julong available_memory();
 131   static julong physical_memory() { return _physical_memory; }
 132   static void initialize_system_info();
 133 
 134   // OS recognitions (PASE/AIX, OS level) call this before calling any
 135   // one of Aix::on_pase(), Aix::os_version().
 136   static void initialize_os_info();
 137 
 138   static int commit_memory_impl(char* addr, size_t bytes, bool exec);
 139   static int commit_memory_impl(char* addr, size_t bytes,
 140                                 size_t alignment_hint, bool exec);
 141 
 142   // Scan environment for important settings which might effect the
 143   // VM. Trace out settings. Warn about invalid settings and/or
 144   // correct them.
 145   //
 146   // Must run after os::Aix::initialue_os_info().
 147   static void scan_environment();
 148 
 149   // Retrieve information about multipage size support. Will initialize
 150   // _page_size, _stack_page_size, _can_use_64K_pages/_can_use_16M_pages
 151   static void query_multipage_support();
 152 
 153   // Initialize libo4 (on PASE) and libperfstat (on AIX). Call this
 154   // before relying on functions from either lib, e.g. Aix::get_meminfo().
 155   static void initialize_libo4();
 156   static void initialize_libperfstat();
 157 
 158   static bool supports_variable_stack_size();
 159 
 160  public:
 161   static void init_thread_fpu_state();
 162   static pthread_t main_thread(void)                                { return _main_thread; }
 163   // returns kernel thread id (similar to LWP id on Solaris), which can be
 164   // used to access /proc
 165   static pid_t gettid();
 166   static void set_createThread_lock(Mutex* lk)                      { _createThread_lock = lk; }
 167   static Mutex* createThread_lock(void)                             { return _createThread_lock; }
 168   static void hotspot_sigmask(Thread* thread);
 169 
 170   // Given an address, returns the size of the page backing that address
 171   static size_t query_pagesize(void* p);
 172 
 173   // Return `true' if the calling thread is the primordial thread. The
 174   // primordial thread is the thread which contains the main function,
 175   // *not* necessarily the thread which initialized the VM by calling
 176   // JNI_CreateJavaVM.
 177   static bool is_primordial_thread(void);
 178 
 179   static int page_size(void) {
 180     assert(_page_size != -1, "not initialized");
 181     return _page_size;
 182   }
 183 
 184   // Accessor methods for stack page size which may be different from usual page size.
 185   static int stack_page_size(void) {
 186     assert(_stack_page_size != -1, "not initialized");
 187     return _stack_page_size;
 188   }
 189 
 190   // default shm page size. Read: what page size shared memory
 191   // will be backed with if no page size was set explicitly using shmctl(SHM_PAGESIZE).
 192   // Should be LDR_CNTRL SHMPSIZE.
 193   static int shm_default_page_size(void) {
 194     assert(_shm_default_page_size != -1, "not initialized");
 195     return _shm_default_page_size;
 196   }
 197 
 198   // Return true if sys V shm can be used with 64K pages dynamically
 199   // (via shmctl(.. SHM_PAGESIZE..).
 200   static bool can_use_64K_pages () {
 201     assert(_can_use_64K_pages != -1,  "not initialized");
 202     return _can_use_64K_pages == 1 ? true : false;
 203   }
 204 
 205   // Return true if sys V shm can be used with 16M pages dynamically.
 206   // (via shmctl(.. SHM_PAGESIZE..).
 207   static bool can_use_16M_pages () {
 208     assert(_can_use_16M_pages != -1,  "not initialized");
 209     return _can_use_16M_pages == 1 ? true : false;
 210   }
 211 
 212   static address   ucontext_get_pc(ucontext_t* uc);
 213   static intptr_t* ucontext_get_sp(ucontext_t* uc);
 214   static intptr_t* ucontext_get_fp(ucontext_t* uc);
 215   // Set PC into context. Needed for continuation after signal.
 216   static void ucontext_set_pc(ucontext_t* uc, address pc);
 217 
 218   // This boolean allows users to forward their own non-matching signals
 219   // to JVM_handle_aix_signal, harmlessly.
 220   static bool signal_handlers_are_installed;
 221 
 222   static int get_our_sigflags(int);
 223   static void set_our_sigflags(int, int);
 224   static void signal_sets_init();
 225   static void install_signal_handlers();
 226   static void set_signal_handler(int, bool);
 227   static bool is_sig_ignored(int sig);
 228 
 229   static sigset_t* unblocked_signals();
 230   static sigset_t* vm_signals();
 231   static sigset_t* allowdebug_blocked_signals();
 232 
 233   // For signal-chaining
 234   static struct sigaction *get_chained_signal_action(int sig);
 235   static bool chained_handler(int sig, siginfo_t* siginfo, void* context);
 236 
 237   // libpthread version string
 238   static void libpthread_init();
 239 
 240   // Minimum stack size a thread can be created with (allowing
 241   // the VM to completely create the thread and enter user code)
 242   static size_t min_stack_allowed;
 243 
 244   // Return default stack size or guard size for the specified thread type
 245   static size_t default_stack_size(os::ThreadType thr_type);
 246   static size_t default_guard_size(os::ThreadType thr_type);
 247 
 248   // Function returns true if we run on OS/400 (pase), false if we run
 249   // on AIX.
 250   static bool on_pase() {
 251     assert(_on_pase != -1, "not initialized");
 252     return _on_pase ? true : false;
 253   }
 254 
 255   // Function returns true if we run on AIX, false if we run on OS/400
 256   // (pase).
 257   static bool on_aix() {
 258     assert(_on_pase != -1, "not initialized");
 259     return _on_pase ? false : true;
 260   }
 261 
 262   // -1 = uninitialized, otherwise 16 bit number:
 263   // lower 8 bit - minor version
 264   // higher 8 bit - major version
 265   // For AIX, e.g. 0x0601 for AIX 6.1
 266   // for OS/400 e.g. 0x0504 for OS/400 V5R4
 267   static int os_version () {
 268     assert(_os_version != -1, "not initialized");
 269     return _os_version;
 270   }
 271 
 272   // Convenience method: returns true if running on AIX 5.3 or older.
 273   static bool on_aix_53_or_older() {
 274     return on_aix() && os_version() <= 0x0503;
 275   }
 276 
 277   // Returns true if we run in SPEC1170 compliant mode (XPG_SUS_ENV=ON).
 278   static bool xpg_sus_mode() {
 279     assert(_xpg_sus_mode != -1, "not initialized");
 280     return _xpg_sus_mode;
 281   }
 282 
 283   // Returns true if EXTSHM=ON.
 284   static bool extshm() {
 285     assert(_extshm != -1, "not initialized");
 286     return _extshm;
 287   }
 288 
 289   // result struct for get_meminfo()
 290   struct meminfo_t {
 291 
 292     // Amount of virtual memory (in units of 4 KB pages)
 293     unsigned long long virt_total;
 294 
 295     // Amount of real memory, in bytes
 296     unsigned long long real_total;
 297 
 298     // Amount of free real memory, in bytes
 299     unsigned long long real_free;
 300 
 301     // Total amount of paging space, in bytes
 302     unsigned long long pgsp_total;
 303 
 304     // Amount of free paging space, in bytes
 305     unsigned long long pgsp_free;
 306 
 307   };
 308 
 309   // Result struct for get_cpuinfo().
 310   struct cpuinfo_t {
 311     char description[IDENTIFIER_LENGTH];  // processor description (type/official name)
 312     u_longlong_t processorHZ;             // processor speed in Hz
 313     int ncpus;                            // number of active logical processors
 314     double loadavg[3];                    // (1<<SBITS) times the average number of runnables processes during the last 1, 5 and 15 minutes.
 315                                           // To calculate the load average, divide the numbers by (1<<SBITS). SBITS is defined in <sys/proc.h>.
 316     char version[20];                     // processor version from _system_configuration (sys/systemcfg.h)
 317   };
 318 
 319   // Functions to retrieve memory information on AIX, PASE.
 320   // (on AIX, using libperfstat, on PASE with libo4.so).
 321   // Returns true if ok, false if error.
 322   static bool get_meminfo(meminfo_t* pmi);
 323 
 324   // Function to retrieve cpu information on AIX
 325   // (on AIX, using libperfstat)
 326   // Returns true if ok, false if error.
 327   static bool get_cpuinfo(cpuinfo_t* pci);
 328 
 329 }; // os::Aix class
 330 
 331 
 332 class PlatformEvent : public CHeapObj<mtInternal> {
 333   private:
 334     double CachePad [4];   // increase odds that _mutex is sole occupant of cache line
 335     volatile int _Event;
 336     volatile int _nParked;
 337     pthread_mutex_t _mutex  [1];
 338     pthread_cond_t  _cond   [1];
 339     double PostPad  [2];
 340     Thread * _Assoc;
 341 
 342   public:       // TODO-FIXME: make dtor private
 343     ~PlatformEvent() { guarantee (0, "invariant"); }
 344 
 345   public:
 346     PlatformEvent() {
 347       int status;
 348       status = pthread_cond_init (_cond, NULL);
 349       assert_status(status == 0, status, "cond_init");
 350       status = pthread_mutex_init (_mutex, NULL);
 351       assert_status(status == 0, status, "mutex_init");
 352       _Event   = 0;
 353       _nParked = 0;
 354       _Assoc   = NULL;
 355     }
 356 
 357     // Use caution with reset() and fired() -- they may require MEMBARs
 358     void reset() { _Event = 0; }
 359     int  fired() { return _Event; }
 360     void park ();
 361     void unpark ();
 362     int  TryPark ();
 363     int  park (jlong millis);
 364     void SetAssociation (Thread * a) { _Assoc = a; }
 365 };
 366 
 367 class PlatformParker : public CHeapObj<mtInternal> {
 368   protected:
 369     pthread_mutex_t _mutex [1];
 370     pthread_cond_t  _cond  [1];
 371 
 372   public:       // TODO-FIXME: make dtor private
 373     ~PlatformParker() { guarantee (0, "invariant"); }
 374 
 375   public:
 376     PlatformParker() {
 377       int status;
 378       status = pthread_cond_init (_cond, NULL);
 379       assert_status(status == 0, status, "cond_init");
 380       status = pthread_mutex_init (_mutex, NULL);
 381       assert_status(status == 0, status, "mutex_init");
 382     }
 383 };
 384 
 385 #endif // OS_AIX_VM_OS_AIX_HPP