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_INLINE_HPP
  26 #define OS_SOLARIS_VM_OS_SOLARIS_INLINE_HPP
  27 
  28 #include "runtime/atomic.inline.hpp"
  29 #include "runtime/orderAccess.inline.hpp"
  30 #include "runtime/os.hpp"
  31 
  32 // System includes
  33 #include <sys/param.h>
  34 #include <dlfcn.h>
  35 #include <sys/socket.h>
  36 #include <sys/poll.h>
  37 #include <sys/filio.h>
  38 #include <unistd.h>
  39 #include <netdb.h>
  40 #include <setjmp.h>
  41 
  42 inline const char* os::file_separator() { return "/"; }
  43 inline const char* os::line_separator() { return "\n"; }
  44 inline const char* os::path_separator() { return ":"; }
  45 
  46 // File names are case-sensitive on windows only
  47 inline int os::file_name_strcmp(const char* s1, const char* s2) {
  48   return strcmp(s1, s2);
  49 }
  50 
  51 inline bool os::uses_stack_guard_pages() {
  52   return true;
  53 }
  54 
  55 inline bool os::allocate_stack_guard_pages() {
  56   assert(uses_stack_guard_pages(), "sanity check");
  57   int r = thr_main() ;
  58   guarantee (r == 0 || r == 1, "CR6501650 or CR6493689") ;
  59   return r;
  60 }
  61 
  62 
  63 // On Solaris, reservations are made on a page by page basis, nothing to do.
  64 inline void os::pd_split_reserved_memory(char *base, size_t size,
  65                                       size_t split, bool realloc) {
  66 }
  67 
  68 
  69 // Bang the shadow pages if they need to be touched to be mapped.
  70 inline void os::bang_stack_shadow_pages() {
  71 }
  72 inline void os::dll_unload(void *lib) { ::dlclose(lib); }
  73 
  74 inline DIR* os::opendir(const char* dirname) {
  75   assert(dirname != NULL, "just checking");
  76   return ::opendir(dirname);
  77 }
  78 
  79 inline int os::readdir_buf_size(const char *path) {
  80   int size = pathconf(path, _PC_NAME_MAX);
  81   return (size < 0 ? MAXPATHLEN : size) + sizeof(dirent) + 1;
  82 }
  83 
  84 inline struct dirent* os::readdir(DIR* dirp, dirent* dbuf) {
  85   assert(dirp != NULL, "just checking");
  86 #if defined(_LP64) || defined(_GNU_SOURCE) || _FILE_OFFSET_BITS==64
  87   dirent* p;
  88   int status;
  89 
  90   if((status = ::readdir_r(dirp, dbuf, &p)) != 0) {
  91     errno = status;
  92     return NULL;
  93   } else
  94     return p;
  95 #else  // defined(_LP64) || defined(_GNU_SOURCE) || _FILE_OFFSET_BITS==64
  96   return ::readdir_r(dirp, dbuf);
  97 #endif // defined(_LP64) || defined(_GNU_SOURCE) || _FILE_OFFSET_BITS==64
  98 }
  99 
 100 inline int os::closedir(DIR *dirp) {
 101   assert(dirp != NULL, "argument is NULL");
 102   return ::closedir(dirp);
 103 }
 104 
 105 //////////////////////////////////////////////////////////////////////////////
 106 ////////////////////////////////////////////////////////////////////////////////
 107 
 108 // macros for interruptible io and system calls and system call restarting
 109 
 110 #define _INTERRUPTIBLE(_setup, _cmd, _result, _thread, _clear, _before, _after, _int_enable) \
 111 do { \
 112   _setup; \
 113   _before; \
 114   OSThread* _osthread = _thread->osthread(); \
 115   if (_int_enable && _thread->has_last_Java_frame()) { \
 116     /* this is java interruptible io stuff */ \
 117     if (os::is_interrupted(_thread, _clear))  { \
 118       os::Solaris::bump_interrupted_before_count(); \
 119       _result = OS_INTRPT; \
 120     } else { \
 121       /* _cmd always expands to an assignment to _result */ \
 122       if ((_cmd) < 0 && errno == EINTR  \
 123        && os::is_interrupted(_thread, _clear)) { \
 124         os::Solaris::bump_interrupted_during_count(); \
 125         _result = OS_INTRPT; \
 126       } \
 127     } \
 128   } else { \
 129     /* this is normal blocking io stuff */ \
 130     _cmd; \
 131   } \
 132   _after; \
 133 } while(false)
 134 
 135 // Interruptible io support + restarting of interrupted system calls
 136 
 137 #ifndef ASSERT
 138 
 139 #define INTERRUPTIBLE(_cmd, _result, _clear) do { \
 140   _INTERRUPTIBLE( JavaThread* _thread = (JavaThread*)ThreadLocalStorage::thread(),_result = _cmd, _result, _thread, _clear, , , UseVMInterruptibleIO); \
 141 } while((_result == OS_ERR) && (errno == EINTR))
 142 
 143 #else
 144 
 145 // This adds an assertion that it is only called from thread_in_native
 146 // The call overhead is skipped for performance in product mode
 147 #define INTERRUPTIBLE(_cmd, _result, _clear) do { \
 148   _INTERRUPTIBLE(JavaThread* _thread = os::Solaris::setup_interruptible_native(), _result = _cmd, _result, _thread, _clear, , os::Solaris::cleanup_interruptible_native(_thread), UseVMInterruptibleIO ); \
 149 } while((_result == OS_ERR) && (errno == EINTR))
 150 
 151 #endif
 152 
 153 // Used for calls from _thread_in_vm, not from _thread_in_native
 154 #define INTERRUPTIBLE_VM(_cmd, _result, _clear) do { \
 155   _INTERRUPTIBLE(JavaThread* _thread = os::Solaris::setup_interruptible(), _result = _cmd, _result, _thread, _clear, , os::Solaris::cleanup_interruptible(_thread), UseVMInterruptibleIO ); \
 156 } while((_result == OS_ERR) && (errno == EINTR))
 157 
 158 /* Use NORESTART when the system call cannot return EINTR, when something other
 159    than a system call is being invoked, or when the caller must do EINTR
 160    handling. */
 161 
 162 #ifndef ASSERT
 163 
 164 #define INTERRUPTIBLE_NORESTART(_cmd, _result, _clear) \
 165   _INTERRUPTIBLE( JavaThread* _thread = (JavaThread*)ThreadLocalStorage::thread(),_result = _cmd, _result, _thread, _clear, , , UseVMInterruptibleIO)
 166 
 167 #else
 168 
 169 // This adds an assertion that it is only called from thread_in_native
 170 // The call overhead is skipped for performance in product mode
 171 #define INTERRUPTIBLE_NORESTART(_cmd, _result, _clear) \
 172   _INTERRUPTIBLE(JavaThread* _thread = os::Solaris::setup_interruptible_native(), _result = _cmd, _result, _thread, _clear, , os::Solaris::cleanup_interruptible_native(_thread), UseVMInterruptibleIO )
 173 
 174 #endif
 175 
 176 // Don't attend to UseVMInterruptibleIO. Always allow interruption.
 177 // Also assumes that it is called from the _thread_blocked state.
 178 // Used by os_sleep().
 179 
 180 #define INTERRUPTIBLE_NORESTART_VM_ALWAYS(_cmd, _result, _thread, _clear) \
 181   _INTERRUPTIBLE(os::Solaris::setup_interruptible_already_blocked(_thread), _result = _cmd, _result, _thread, _clear, , , true )
 182 
 183 #define INTERRUPTIBLE_RETURN_INT(_cmd, _clear) do { \
 184   int _result; \
 185   do { \
 186     INTERRUPTIBLE(_cmd, _result, _clear); \
 187   } while((_result == OS_ERR) && (errno == EINTR)); \
 188   return _result; \
 189 } while(false)
 190 
 191 #define INTERRUPTIBLE_RETURN_INT_VM(_cmd, _clear) do { \
 192   int _result; \
 193   do { \
 194     INTERRUPTIBLE_VM(_cmd, _result, _clear); \
 195   } while((_result == OS_ERR) && (errno == EINTR)); \
 196   return _result; \
 197 } while(false)
 198 
 199 #define INTERRUPTIBLE_RETURN_INT_NORESTART(_cmd, _clear) do { \
 200   int _result; \
 201   INTERRUPTIBLE_NORESTART(_cmd, _result, _clear); \
 202   return _result; \
 203 } while(false)
 204 
 205 /* Use the RESTARTABLE macros when interruptible io is not needed */
 206 
 207 #define RESTARTABLE(_cmd, _result) do { \
 208   do { \
 209     _result = _cmd; \
 210   } while((_result == OS_ERR) && (errno == EINTR)); \
 211 } while(false)
 212 
 213 #define RESTARTABLE_RETURN_INT(_cmd) do { \
 214   int _result; \
 215   RESTARTABLE(_cmd, _result); \
 216   return _result; \
 217 } while(false)
 218 
 219 inline bool os::numa_has_static_binding()   { return false; }
 220 inline bool os::numa_has_group_homing()     { return true;  }
 221 
 222 inline int    os::socket(int domain, int type, int protocol) {
 223   return ::socket(domain, type, protocol);
 224 }
 225 
 226 inline int    os::listen(int fd, int count) {
 227   if (fd < 0) return OS_ERR;
 228 
 229   return ::listen(fd, count);
 230 }
 231 
 232 inline int os::socket_shutdown(int fd, int howto){
 233   return ::shutdown(fd, howto);
 234 }
 235 
 236 inline int os::get_sock_name(int fd, struct sockaddr* him, socklen_t* len){
 237   return ::getsockname(fd, him, len);
 238 }
 239 
 240 inline int os::get_host_name(char* name, int namelen){
 241   return ::gethostname(name, namelen);
 242 }
 243 
 244 inline struct hostent* os::get_host_by_name(char* name) {
 245   return ::gethostbyname(name);
 246 }
 247 
 248 inline int os::get_sock_opt(int fd, int level, int optname,
 249                             char* optval, socklen_t* optlen) {
 250   return ::getsockopt(fd, level, optname, optval, optlen);
 251 }
 252 
 253 inline int os::set_sock_opt(int fd, int level, int optname,
 254                             const char *optval, socklen_t optlen) {
 255   return ::setsockopt(fd, level, optname, optval, optlen);
 256 }
 257 #endif // OS_SOLARIS_VM_OS_SOLARIS_INLINE_HPP