annotate src/hotspot/os/posix/os_posix.hpp @ 54304:9807daeb47c4

8216167: Update include guards to reflect correct directories Summary: Use script and some manual fixup to fix directores names in include guards. Reviewed-by: lfoltan, eosterlund, kbarrett
author coleenp
date Thu, 10 Jan 2019 15:13:51 -0500
parents f7f90fddce02
children 08d6edeb3145
rev   line source
nloodin@12735 1 /*
coleenp@54304 2 * Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
nloodin@12735 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
nloodin@12735 4 *
nloodin@12735 5 * This code is free software; you can redistribute it and/or modify it
nloodin@12735 6 * under the terms of the GNU General Public License version 2 only, as
nloodin@12735 7 * published by the Free Software Foundation.
nloodin@12735 8 *
nloodin@12735 9 * This code is distributed in the hope that it will be useful, but WITHOUT
nloodin@12735 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
nloodin@12735 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
nloodin@12735 12 * version 2 for more details (a copy is included in the LICENSE file that
nloodin@12735 13 * accompanied this code).
nloodin@12735 14 *
nloodin@12735 15 * You should have received a copy of the GNU General Public License version
nloodin@12735 16 * 2 along with this work; if not, write to the Free Software Foundation,
nloodin@12735 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
nloodin@12735 18 *
nloodin@12735 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
nloodin@12735 20 * or visit www.oracle.com if you need additional information or have any
nloodin@12735 21 * questions.
nloodin@12735 22 *
nloodin@12735 23 */
nloodin@12735 24
goetz@25468 25 #include "runtime/os.hpp"
goetz@25468 26
coleenp@54304 27 #ifndef OS_POSIX_OS_POSIX_HPP
coleenp@54304 28 #define OS_POSIX_OS_POSIX_HPP
goetz@25468 29
goetz@25468 30 // File conventions
goetz@25468 31 static const char* file_separator() { return "/"; }
goetz@25468 32 static const char* line_separator() { return "\n"; }
goetz@25468 33 static const char* path_separator() { return ":"; }
goetz@25468 34
nloodin@12735 35 class Posix {
nloodin@12735 36 friend class os;
nloodin@12735 37
nloodin@12735 38 protected:
nloodin@12735 39 static void print_distro_info(outputStream* st);
nloodin@12735 40 static void print_rlimit_info(outputStream* st);
nloodin@12735 41 static void print_uname_info(outputStream* st);
nloodin@12735 42 static void print_libversion_info(outputStream* st);
nloodin@12735 43 static void print_load_average(outputStream* st);
nloodin@12735 44
rdurbin@41070 45 // Minimum stack size a thread can be created with (allowing
goetz@42906 46 // the VM to completely create the thread and enter user code).
goetz@42906 47 // The initial values exclude any guard pages (by HotSpot or libc).
goetz@42906 48 // set_minimum_stack_sizes() will add the size required for
goetz@42906 49 // HotSpot guard pages depending on page size and flag settings.
goetz@42906 50 // Libc guard pages are never considered by these values.
rdurbin@41070 51 static size_t _compiler_thread_min_stack_allowed;
rdurbin@41070 52 static size_t _java_thread_min_stack_allowed;
rdurbin@41070 53 static size_t _vm_internal_thread_min_stack_allowed;
rdurbin@41070 54
goetz@22826 55 public:
dholmes@46507 56 static void init(void); // early initialization - no logging available
dholmes@46507 57 static void init_2(void);// later initialization - logging available
dholmes@46507 58
rdurbin@41070 59 // Return default stack size for the specified thread type
rdurbin@41070 60 static size_t default_stack_size(os::ThreadType thr_type);
rdurbin@41070 61 // Check and sets minimum stack sizes
rdurbin@41070 62 static jint set_minimum_stack_sizes();
rdurbin@41070 63 static size_t get_initial_stack_size(ThreadType thr_type, size_t req_stack_size);
goetz@22826 64
goetz@22826 65 // Returns true if signal is valid.
goetz@22826 66 static bool is_valid_signal(int sig);
coleenp@50761 67 static bool is_sig_ignored(int sig);
goetz@22826 68
goetz@22826 69 // Helper function, returns a string (e.g. "SIGILL") for a signal.
goetz@22826 70 // Returned string is a constant. For unknown signals "UNKNOWN" is returned.
goetz@22826 71 static const char* get_signal_name(int sig, char* out, size_t outlen);
goetz@22826 72
stuefe@34621 73 // Helper function, returns a signal number for a given signal name, e.g. 11
stuefe@34621 74 // for "SIGSEGV". Name can be given with or without "SIG" prefix, so both
stuefe@34621 75 // "SEGV" or "SIGSEGV" work. Name must be uppercase.
stuefe@34621 76 // Returns -1 for an unknown signal name.
stuefe@34621 77 static int get_signal_number(const char* signal_name);
stuefe@34621 78
goetz@22826 79 // Returns one-line short description of a signal set in a user provided buffer.
goetz@22826 80 static const char* describe_signal_set_short(const sigset_t* set, char* buffer, size_t size);
goetz@22826 81
goetz@22826 82 // Prints a short one-line description of a signal set.
goetz@22826 83 static void print_signal_set_short(outputStream* st, const sigset_t* set);
goetz@22826 84
sebastian@34305 85 // unblocks the signal masks for current thread
sebastian@34305 86 static int unblock_thread_signal_mask(const sigset_t *set);
sebastian@34305 87
goetz@22826 88 // Writes a one-line description of a combination of sigaction.sa_flags
goetz@22826 89 // into a user provided buffer. Returns that buffer.
goetz@22826 90 static const char* describe_sa_flags(int flags, char* buffer, size_t size);
goetz@22826 91
goetz@22826 92 // Prints a one-line description of a combination of sigaction.sa_flags.
goetz@22826 93 static void print_sa_flags(outputStream* st, int flags);
goetz@22826 94
stuefe@35077 95 static address ucontext_get_pc(const ucontext_t* ctx);
sebastian@34305 96 // Set PC into context. Needed for continuation after signal.
sebastian@34305 97 static void ucontext_set_pc(ucontext_t* ctx, address pc);
stuefe@36355 98
stuefe@36355 99 // Helper function; describes pthread attributes as short string. String is written
stuefe@36355 100 // to buf with len buflen; buf is returned.
stuefe@36355 101 static char* describe_pthread_attr(char* buf, size_t buflen, const pthread_attr_t* attr);
stuefe@36355 102
stuefe@46331 103 // A safe implementation of realpath which will not cause a buffer overflow if the resolved path
stuefe@46331 104 // is longer than PATH_MAX.
stuefe@46331 105 // On success, returns 'outbuf', which now contains the path.
stuefe@46331 106 // On error, it will return NULL and set errno. The content of 'outbuf' is undefined.
stuefe@46331 107 // On truncation error ('outbuf' too small), it will return NULL and set errno to ENAMETOOLONG.
stuefe@46331 108 static char* realpath(const char* filename, char* outbuf, size_t outbuflen);
dtitov@50937 109
dtitov@50937 110 // Returns true if given uid is root.
dtitov@50937 111 static bool is_root(uid_t uid);
dtitov@50937 112
dtitov@50937 113 // Returns true if given uid is effective or root uid.
dtitov@50937 114 static bool matches_effective_uid_or_root(uid_t uid);
dtitov@50937 115
dtitov@50937 116 // Returns true if either given uid is effective uid and given gid is
dtitov@50937 117 // effective gid, or if given uid is root.
dtitov@50937 118 static bool matches_effective_uid_and_gid_or_root(uid_t uid, gid_t gid);
dholmes@52818 119
mbaesken@53553 120 static void print_umask(outputStream* st, mode_t umsk);
mbaesken@53553 121
mbaesken@53553 122 static void print_user_info(outputStream* st);
mbaesken@53553 123
dholmes@52818 124 #ifdef SUPPORTS_CLOCK_MONOTONIC
dholmes@52818 125
dholmes@52818 126 static bool supports_monotonic_clock();
dholmes@52818 127 static int clock_gettime(clockid_t clock_id, struct timespec *tp);
dholmes@52818 128 static int clock_getres(clockid_t clock_id, struct timespec *tp);
dholmes@52818 129
dholmes@52818 130 #else
dholmes@52818 131
dholmes@52818 132 static bool supports_monotonic_clock() { return false; }
dholmes@52818 133
dholmes@52818 134 #endif
nloodin@12735 135 };
nloodin@12735 136
rbackman@18943 137 /*
rbackman@18943 138 * Crash protection for the watcher thread. Wrap the callback
rbackman@18943 139 * with a sigsetjmp and in case of a SIGSEGV/SIGBUS we siglongjmp
rbackman@18943 140 * back.
rbackman@18943 141 * To be able to use this - don't take locks, don't rely on destructors,
rbackman@18943 142 * don't make OS library calls, don't allocate memory, don't print,
rbackman@18943 143 * don't call code that could leave the heap / memory in an inconsistent state,
rbackman@18943 144 * or anything else where we are not in control if we suddenly jump out.
rbackman@18943 145 */
rehn@46644 146 class ThreadCrashProtection : public StackObj {
rbackman@18943 147 public:
rehn@46644 148 static bool is_crash_protected(Thread* thr) {
rehn@46644 149 return _crash_protection != NULL && _protected_thread == thr;
rehn@46644 150 }
rehn@46644 151
rehn@46644 152 ThreadCrashProtection();
rbackman@18943 153 bool call(os::CrashProtectionCallback& cb);
rbackman@18943 154
rbackman@18943 155 static void check_crash_protection(int signal, Thread* thread);
rbackman@18943 156 private:
rehn@46644 157 static Thread* _protected_thread;
rehn@46644 158 static ThreadCrashProtection* _crash_protection;
rehn@46644 159 static volatile intptr_t _crash_mux;
rbackman@18943 160 void restore();
rbackman@18943 161 sigjmp_buf _jmpbuf;
rbackman@18943 162 };
nloodin@12735 163
dholmes@46507 164 #ifndef SOLARIS
dholmes@46507 165
dholmes@46507 166 /*
dholmes@46507 167 * This is the platform-specific implementation underpinning
dholmes@46507 168 * the ParkEvent class, which itself underpins Java-level monitor
dholmes@46507 169 * operations. See park.hpp for details.
dholmes@46507 170 * These event objects are type-stable and immortal - we never delete them.
dholmes@46507 171 * Events are associated with a thread for the lifetime of the thread.
dholmes@46507 172 */
dholmes@46507 173 class PlatformEvent : public CHeapObj<mtInternal> {
dholmes@46507 174 private:
dholmes@46507 175 double cachePad[4]; // Increase odds that _mutex is sole occupant of cache line
dholmes@46507 176 volatile int _event; // Event count/permit: -1, 0 or 1
dholmes@46507 177 volatile int _nParked; // Indicates if associated thread is blocked: 0 or 1
dholmes@46507 178 pthread_mutex_t _mutex[1]; // Native mutex for locking
dholmes@46507 179 pthread_cond_t _cond[1]; // Native condition variable for blocking
dholmes@46507 180 double postPad[2];
dholmes@46507 181
dholmes@46507 182 protected: // TODO-FIXME: make dtor private
dholmes@46507 183 ~PlatformEvent() { guarantee(false, "invariant"); } // immortal so can't delete
dholmes@46507 184
dholmes@46507 185 public:
dholmes@46507 186 PlatformEvent();
dholmes@46507 187 void park();
dholmes@46507 188 int park(jlong millis);
dholmes@46507 189 void unpark();
dholmes@46507 190
dholmes@46507 191 // Use caution with reset() and fired() -- they may require MEMBARs
dholmes@46507 192 void reset() { _event = 0; }
dholmes@46507 193 int fired() { return _event; }
dholmes@46507 194 };
dholmes@46507 195
dholmes@46507 196 // JSR166 support
dholmes@46507 197 // PlatformParker provides the platform dependent base class for the
dholmes@46507 198 // Parker class. It basically provides the internal data structures:
dholmes@46507 199 // - mutex and convars
dholmes@46507 200 // which are then used directly by the Parker methods defined in the OS
dholmes@46507 201 // specific implementation files.
dholmes@46507 202 // There is significant overlap between the funcionality supported in the
dholmes@46507 203 // combination of Parker+PlatformParker and PlatformEvent (above). If Parker
dholmes@46507 204 // were more like ObjectMonitor we could use PlatformEvent in both (with some
dholmes@46507 205 // API updates of course). But Parker methods use fastpaths that break that
dholmes@46507 206 // level of encapsulation - so combining the two remains a future project.
dholmes@46507 207
dholmes@46507 208 class PlatformParker : public CHeapObj<mtInternal> {
dholmes@46507 209 protected:
dholmes@46507 210 enum {
dholmes@46507 211 REL_INDEX = 0,
dholmes@46507 212 ABS_INDEX = 1
dholmes@46507 213 };
dholmes@46507 214 int _cur_index; // which cond is in use: -1, 0, 1
dholmes@46507 215 pthread_mutex_t _mutex[1];
dholmes@46507 216 pthread_cond_t _cond[2]; // one for relative times and one for absolute
dholmes@46507 217
dholmes@46507 218 public: // TODO-FIXME: make dtor private
dholmes@46507 219 ~PlatformParker() { guarantee(false, "invariant"); }
dholmes@46507 220
dholmes@46507 221 public:
dholmes@46507 222 PlatformParker();
dholmes@46507 223 };
dholmes@46507 224
dholmes@46507 225 #endif // !SOLARIS
dholmes@46507 226
coleenp@54304 227 #endif // OS_POSIX_OS_POSIX_HPP