1 /*
   2  * Copyright (c) 1999, 2018, 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 #include "runtime/os.hpp"
  26 
  27 #ifndef OS_POSIX_VM_OS_POSIX_HPP
  28 #define OS_POSIX_VM_OS_POSIX_HPP
  29 
  30 // File conventions
  31 static const char* file_separator() { return "/"; }
  32 static const char* line_separator() { return "\n"; }
  33 static const char* path_separator() { return ":"; }
  34 
  35 class Posix {
  36   friend class os;
  37 
  38 protected:
  39   static void print_distro_info(outputStream* st);
  40   static void print_rlimit_info(outputStream* st);
  41   static void print_uname_info(outputStream* st);
  42   static void print_libversion_info(outputStream* st);
  43   static void print_load_average(outputStream* st);
  44 
  45   // Minimum stack size a thread can be created with (allowing
  46   // the VM to completely create the thread and enter user code).
  47   // The initial values exclude any guard pages (by HotSpot or libc).
  48   // set_minimum_stack_sizes() will add the size required for
  49   // HotSpot guard pages depending on page size and flag settings.
  50   // Libc guard pages are never considered by these values.
  51   static size_t _compiler_thread_min_stack_allowed;
  52   static size_t _java_thread_min_stack_allowed;
  53   static size_t _vm_internal_thread_min_stack_allowed;
  54 
  55 public:
  56   static void init(void);  // early initialization - no logging available
  57   static void init_2(void);// later initialization - logging available
  58 
  59   // Return default stack size for the specified thread type
  60   static size_t default_stack_size(os::ThreadType thr_type);
  61   // Check and sets minimum stack sizes
  62   static jint set_minimum_stack_sizes();
  63   static size_t get_initial_stack_size(ThreadType thr_type, size_t req_stack_size);
  64 
  65   // Returns true if signal is valid.
  66   static bool is_valid_signal(int sig);
  67   static bool is_sig_ignored(int sig);
  68 
  69   // Helper function, returns a string (e.g. "SIGILL") for a signal.
  70   // Returned string is a constant. For unknown signals "UNKNOWN" is returned.
  71   static const char* get_signal_name(int sig, char* out, size_t outlen);
  72 
  73   // Helper function, returns a signal number for a given signal name, e.g. 11
  74   // for "SIGSEGV". Name can be given with or without "SIG" prefix, so both
  75   // "SEGV" or "SIGSEGV" work. Name must be uppercase.
  76   // Returns -1 for an unknown signal name.
  77   static int get_signal_number(const char* signal_name);
  78 
  79   // Returns one-line short description of a signal set in a user provided buffer.
  80   static const char* describe_signal_set_short(const sigset_t* set, char* buffer, size_t size);
  81 
  82   // Prints a short one-line description of a signal set.
  83   static void print_signal_set_short(outputStream* st, const sigset_t* set);
  84 
  85   // unblocks the signal masks for current thread
  86   static int unblock_thread_signal_mask(const sigset_t *set);
  87 
  88   // Writes a one-line description of a combination of sigaction.sa_flags
  89   // into a user provided buffer. Returns that buffer.
  90   static const char* describe_sa_flags(int flags, char* buffer, size_t size);
  91 
  92   // Prints a one-line description of a combination of sigaction.sa_flags.
  93   static void print_sa_flags(outputStream* st, int flags);
  94 
  95   static address ucontext_get_pc(const ucontext_t* ctx);
  96   // Set PC into context. Needed for continuation after signal.
  97   static void ucontext_set_pc(ucontext_t* ctx, address pc);
  98 
  99   // Helper function; describes pthread attributes as short string. String is written
 100   // to buf with len buflen; buf is returned.
 101   static char* describe_pthread_attr(char* buf, size_t buflen, const pthread_attr_t* attr);
 102 
 103   // A safe implementation of realpath which will not cause a buffer overflow if the resolved path
 104   //   is longer than PATH_MAX.
 105   // On success, returns 'outbuf', which now contains the path.
 106   // On error, it will return NULL and set errno. The content of 'outbuf' is undefined.
 107   // On truncation error ('outbuf' too small), it will return NULL and set errno to ENAMETOOLONG.
 108   static char* realpath(const char* filename, char* outbuf, size_t outbuflen);
 109 };
 110 
 111 // On POSIX platforms the signal handler is global so we just do the write.
 112 static void write_memory_serialize_page_with_handler(JavaThread* thread) {
 113   write_memory_serialize_page(thread);
 114 }
 115 
 116 /*
 117  * Crash protection for the watcher thread. Wrap the callback
 118  * with a sigsetjmp and in case of a SIGSEGV/SIGBUS we siglongjmp
 119  * back.
 120  * To be able to use this - don't take locks, don't rely on destructors,
 121  * don't make OS library calls, don't allocate memory, don't print,
 122  * don't call code that could leave the heap / memory in an inconsistent state,
 123  * or anything else where we are not in control if we suddenly jump out.
 124  */
 125 class ThreadCrashProtection : public StackObj {
 126 public:
 127   static bool is_crash_protected(Thread* thr) {
 128     return _crash_protection != NULL && _protected_thread == thr;
 129   }
 130 
 131   ThreadCrashProtection();
 132   bool call(os::CrashProtectionCallback& cb);
 133 
 134   static void check_crash_protection(int signal, Thread* thread);
 135 private:
 136   static Thread* _protected_thread;
 137   static ThreadCrashProtection* _crash_protection;
 138   static volatile intptr_t _crash_mux;
 139   void restore();
 140   sigjmp_buf _jmpbuf;
 141 };
 142 
 143 #ifndef SOLARIS
 144 
 145 /*
 146  * This is the platform-specific implementation underpinning
 147  * the ParkEvent class, which itself underpins Java-level monitor
 148  * operations. See park.hpp for details.
 149  * These event objects are type-stable and immortal - we never delete them.
 150  * Events are associated with a thread for the lifetime of the thread.
 151  */
 152 class PlatformEvent : public CHeapObj<mtInternal> {
 153  private:
 154   double cachePad[4];        // Increase odds that _mutex is sole occupant of cache line
 155   volatile int _event;       // Event count/permit: -1, 0 or 1
 156   volatile int _nParked;     // Indicates if associated thread is blocked: 0 or 1
 157   pthread_mutex_t _mutex[1]; // Native mutex for locking
 158   pthread_cond_t  _cond[1];  // Native condition variable for blocking
 159   double postPad[2];
 160 
 161  protected:       // TODO-FIXME: make dtor private
 162   ~PlatformEvent() { guarantee(false, "invariant"); } // immortal so can't delete
 163 
 164  public:
 165   PlatformEvent();
 166   void park();
 167   int  park(jlong millis);
 168   void unpark();
 169 
 170   // Use caution with reset() and fired() -- they may require MEMBARs
 171   void reset() { _event = 0; }
 172   int  fired() { return _event; }
 173 };
 174 
 175 // JSR166 support
 176 // PlatformParker provides the platform dependent base class for the
 177 // Parker class. It basically provides the internal data structures:
 178 // - mutex and convars
 179 // which are then used directly by the Parker methods defined in the OS
 180 // specific implementation files.
 181 // There is significant overlap between the funcionality supported in the
 182 // combination of Parker+PlatformParker and PlatformEvent (above). If Parker
 183 // were more like ObjectMonitor we could use PlatformEvent in both (with some
 184 // API updates of course). But Parker methods use fastpaths that break that
 185 // level of encapsulation - so combining the two remains a future project.
 186 
 187 class PlatformParker : public CHeapObj<mtInternal> {
 188  protected:
 189   enum {
 190     REL_INDEX = 0,
 191     ABS_INDEX = 1
 192   };
 193   int _cur_index;  // which cond is in use: -1, 0, 1
 194   pthread_mutex_t _mutex[1];
 195   pthread_cond_t  _cond[2]; // one for relative times and one for absolute
 196 
 197  public:       // TODO-FIXME: make dtor private
 198   ~PlatformParker() { guarantee(false, "invariant"); }
 199 
 200  public:
 201   PlatformParker();
 202 };
 203 
 204 #endif // !SOLARIS
 205 
 206 #endif // OS_POSIX_VM_OS_POSIX_HPP
--- EOF ---