include/wine/port.h

   1 /*
   2  * Wine porting definitions
   3  *
   4  * Copyright 1996 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __WINE_WINE_PORT_H
  22 #define __WINE_WINE_PORT_H
  23
  24 #ifndef __WINE_CONFIG_H
  25 # error You must include config.h to use this header
  26 #endif
  27
  28 #ifdef __WINE_BASETSD_H
  29 # error You must include port.h before all other headers
  30 #endif
  31
  32 #ifndef _GNU_SOURCE
  33 # define _GNU_SOURCE  /* for pread/pwrite, isfinite */
  34 #endif
  35 #include <fcntl.h>
  36 #include <math.h>
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #ifdef HAVE_DIRECT_H
  40 # include <direct.h>
  41 #endif
  42 #ifdef HAVE_IO_H
  43 # include <io.h>
  44 #endif
  45 #ifdef HAVE_PROCESS_H
  46 # include <process.h>
  47 #endif
  48 #include <string.h>
  49 #include <stdlib.h>
  50 #ifdef HAVE_UNISTD_H
  51 # include <unistd.h>
  52 #endif
  53
  54
  55 /****************************************************************
  56  * Type definitions
  57  */
  58
  59 #if !defined(_MSC_VER) && !defined(__int64)
  60 #  if defined(__x86_64__) || defined(__aarch64__) || defined(_WIN64)
  61 #    define __int64 long
  62 #  else
  63 #    define __int64 long long
  64 #  endif
  65 #endif
  66
  67 #ifndef HAVE_MODE_T
  68 typedef int mode_t;
  69 #endif
  70 #ifndef HAVE_OFF_T
  71 typedef long off_t;
  72 #endif
  73 #ifndef HAVE_PID_T
  74 typedef int pid_t;
  75 #endif
  76 #ifndef HAVE_SIZE_T
  77 typedef unsigned int size_t;
  78 #endif
  79 #ifndef HAVE_SSIZE_T
  80 typedef int ssize_t;
  81 #endif
  82 #ifndef HAVE_FSBLKCNT_T
  83 typedef unsigned long fsblkcnt_t;
  84 #endif
  85 #ifndef HAVE_FSFILCNT_T
  86 typedef unsigned long fsfilcnt_t;
  87 #endif
  88
  89 #ifndef HAVE_STRUCT_STATVFS_F_BLOCKS
  90 struct statvfs
  91 {
  92     unsigned long f_bsize;
  93     unsigned long f_frsize;
  94     fsblkcnt_t    f_blocks;
  95     fsblkcnt_t    f_bfree;
  96     fsblkcnt_t    f_bavail;
  97     fsfilcnt_t    f_files;
  98     fsfilcnt_t    f_ffree;
  99     fsfilcnt_t    f_favail;
 100     unsigned long f_fsid;
 101     unsigned long f_flag;
 102     unsigned long f_namemax;
 103 };
 104 #endif /* HAVE_STRUCT_STATVFS_F_BLOCKS */
 105
 106
 107 /****************************************************************
 108  * Macro definitions
 109  */
 110
 111 #ifdef HAVE_DLFCN_H
 112 #include <dlfcn.h>
 113 #else
 114 #define RTLD_LAZY    0x001
 115 #define RTLD_NOW     0x002
 116 #define RTLD_GLOBAL  0x100
 117 #endif
 118
 119 #ifdef HAVE_ONE_ARG_MKDIR
 120 #define mkdir(path,mode) mkdir(path)
 121 #endif
 122
 123 #if !defined(HAVE_FTRUNCATE) && defined(HAVE_CHSIZE)
 124 #define ftruncate chsize
 125 #endif
 126
 127 #if !defined(HAVE_POPEN) && defined(HAVE__POPEN)
 128 #define popen _popen
 129 #endif
 130
 131 #if !defined(HAVE_PCLOSE) && defined(HAVE__PCLOSE)
 132 #define pclose _pclose
 133 #endif
 134
 135 #if !defined(HAVE_STRDUP) && defined(HAVE__STRDUP)
 136 #define strdup _strdup
 137 #endif
 138
 139 #if !defined(HAVE_SNPRINTF) && defined(HAVE__SNPRINTF)
 140 #define snprintf _snprintf
 141 #endif
 142
 143 #if !defined(HAVE_VSNPRINTF) && defined(HAVE__VSNPRINTF)
 144 #define vsnprintf _vsnprintf
 145 #endif
 146
 147 #if !defined(HAVE_STRTOLL) && defined(HAVE__STRTOI64)
 148 #define strtoll _strtoi64
 149 #endif
 150
 151 #if !defined(HAVE_STRTOULL) && defined(HAVE__STRTOUI64)
 152 #define strtoull _strtoui64
 153 #endif
 154
 155 #ifndef S_ISLNK
 156 # define S_ISLNK(mod) (0)
 157 #endif
 158
 159 #ifndef S_ISSOCK
 160 # define S_ISSOCK(mod) (0)
 161 #endif
 162
 163 #ifndef S_ISDIR
 164 # define S_ISDIR(mod) (((mod) & _S_IFMT) == _S_IFDIR)
 165 #endif
 166
 167 #ifndef S_ISCHR
 168 # define S_ISCHR(mod) (((mod) & _S_IFMT) == _S_IFCHR)
 169 #endif
 170
 171 #ifndef S_ISFIFO
 172 # define S_ISFIFO(mod) (((mod) & _S_IFMT) == _S_IFIFO)
 173 #endif
 174
 175 #ifndef S_ISREG
 176 # define S_ISREG(mod) (((mod) & _S_IFMT) == _S_IFREG)
 177 #endif
 178
 179 /* So we open files in 64 bit access mode on Linux */
 180 #ifndef O_LARGEFILE
 181 # define O_LARGEFILE 0
 182 #endif
 183
 184 #ifndef O_NONBLOCK
 185 # define O_NONBLOCK 0
 186 #endif
 187
 188 #ifndef O_BINARY
 189 # define O_BINARY 0
 190 #endif
 191
 192
 193 /****************************************************************
 194  * Constants
 195  */
 196
 197 #ifndef M_PI
 198 #define M_PI 3.14159265358979323846
 199 #endif
 200
 201 #ifndef M_PI_2
 202 #define M_PI_2 1.570796326794896619
 203 #endif
 204
 205 #ifndef INFINITY
 206 static inline float __port_infinity(void)
 207 {
 208     static const unsigned __inf_bytes = 0x7f800000;
 209     return *(const float *)&__inf_bytes;
 210 }
 211 #define INFINITY __port_infinity()
 212 #endif
 213
 214 #ifndef NAN
 215 static inline float __port_nan(void)
 216 {
 217     static const unsigned __nan_bytes = 0x7fc00000;
 218     return *(const float *)&__nan_bytes;
 219 }
 220 #define NAN __port_nan()
 221 #endif
 222
 223
 224 /****************************************************************
 225  * Function definitions (only when using libwine_port)
 226  */
 227
 228 #ifndef NO_LIBWINE_PORT
 229
 230 #ifndef HAVE_FSTATVFS
 231 int fstatvfs( int fd, struct statvfs *buf );
 232 #endif
 233
 234 #ifndef HAVE_GETOPT_LONG_ONLY
 235 extern char *optarg;
 236 extern int optind;
 237 extern int opterr;
 238 extern int optopt;
 239 struct option;
 240
 241 #ifndef HAVE_STRUCT_OPTION_NAME
 242 struct option
 243 {
 244     const char *name;
 245     int has_arg;
 246     int *flag;
 247     int val;
 248 };
 249 #endif
 250
 251 extern int getopt_long (int ___argc, char *const *___argv,
 252                         const char *__shortopts,
 253                         const struct option *__longopts, int *__longind);
 254 extern int getopt_long_only (int ___argc, char *const *___argv,
 255                              const char *__shortopts,
 256                              const struct option *__longopts, int *__longind);
 257 #endif  /* HAVE_GETOPT_LONG_ONLY */
 258
 259 #ifndef HAVE_FFS
 260 int ffs( int x );
 261 #endif
 262
 263 #ifndef HAVE_ISFINITE
 264 int isfinite(double x);
 265 #endif
 266
 267 #ifndef HAVE_ISINF
 268 int isinf(double x);
 269 #endif
 270
 271 #ifndef HAVE_ISNAN
 272 int isnan(double x);
 273 #endif
 274
 275 #ifndef HAVE_LSTAT
 276 int lstat(const char *file_name, struct stat *buf);
 277 #endif /* HAVE_LSTAT */
 278
 279 #ifndef HAVE_MEMMOVE
 280 void *memmove(void *dest, const void *src, size_t len);
 281 #endif /* !defined(HAVE_MEMMOVE) */
 282
 283 #ifndef HAVE_POLL
 284 struct pollfd
 285 {
 286     int fd;
 287     short events;
 288     short revents;
 289 };
 290 #define POLLIN   0x01
 291 #define POLLPRI  0x02
 292 #define POLLOUT  0x04
 293 #define POLLERR  0x08
 294 #define POLLHUP  0x10
 295 #define POLLNVAL 0x20
 296 int poll( struct pollfd *fds, unsigned int count, int timeout );
 297 #endif /* HAVE_POLL */
 298
 299 #ifndef HAVE_PREAD
 300 ssize_t pread( int fd, void *buf, size_t count, off_t offset );
 301 #endif /* HAVE_PREAD */
 302
 303 #ifndef HAVE_PWRITE
 304 ssize_t pwrite( int fd, const void *buf, size_t count, off_t offset );
 305 #endif /* HAVE_PWRITE */
 306
 307 #ifndef HAVE_READLINK
 308 int readlink( const char *path, char *buf, size_t size );
 309 #endif /* HAVE_READLINK */
 310
 311 #ifndef HAVE_STATVFS
 312 int statvfs( const char *path, struct statvfs *buf );
 313 #endif
 314
 315 #ifndef HAVE_STRNCASECMP
 316 # ifndef HAVE__STRNICMP
 317 int strncasecmp(const char *str1, const char *str2, size_t n);
 318 # else
 319 # define strncasecmp _strnicmp
 320 # endif
 321 #endif /* !defined(HAVE_STRNCASECMP) */
 322
 323 #ifndef HAVE_STRERROR
 324 const char *strerror(int err);
 325 #endif /* !defined(HAVE_STRERROR) */
 326
 327 #ifndef HAVE_STRCASECMP
 328 # ifndef HAVE__STRICMP
 329 int strcasecmp(const char *str1, const char *str2);
 330 # else
 331 # define strcasecmp _stricmp
 332 # endif
 333 #endif /* !defined(HAVE_STRCASECMP) */
 334
 335 #ifndef HAVE_SYMLINK
 336 int symlink(const char *from, const char *to);
 337 #endif
 338
 339 #ifndef HAVE_USLEEP
 340 int usleep (unsigned int useconds);
 341 #endif /* !defined(HAVE_USLEEP) */
 342
 343 #ifdef __i386__
 344 static inline void *memcpy_unaligned( void *dst, const void *src, size_t size )
 345 {
 346     return memcpy( dst, src, size );
 347 }
 348 #else
 349 extern void *memcpy_unaligned( void *dst, const void *src, size_t size );
 350 #endif /* __i386__ */
 351
 352 extern int mkstemps(char *template, int suffix_len);
 353
 354 /* Process creation flags */
 355 #ifndef _P_WAIT
 356 # define _P_WAIT    0
 357 # define _P_NOWAIT  1
 358 # define _P_OVERLAY 2
 359 # define _P_NOWAITO 3
 360 # define _P_DETACH  4
 361 #endif
 362 #ifndef HAVE__SPAWNVP
 363 extern int _spawnvp(int mode, const char *cmdname, const char * const argv[]);
 364 #endif
 365
 366 /* Interlocked functions */
 367
 368 #if defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
 369
 370 static inline int interlocked_cmpxchg( int *dest, int xchg, int compare )
 371 {
 372     int ret;
 373     __asm__ __volatile__( "lock; cmpxchgl %2,(%1)"
 374                           : "=a" (ret) : "r" (dest), "r" (xchg), "0" (compare) : "memory" );
 375     return ret;
 376 }
 377
 378 static inline void *interlocked_cmpxchg_ptr( void **dest, void *xchg, void *compare )
 379 {
 380     void *ret;
 381 #ifdef __x86_64__
 382     __asm__ __volatile__( "lock; cmpxchgq %2,(%1)"
 383                           : "=a" (ret) : "r" (dest), "r" (xchg), "0" (compare) : "memory" );
 384 #else
 385     __asm__ __volatile__( "lock; cmpxchgl %2,(%1)"
 386                           : "=a" (ret) : "r" (dest), "r" (xchg), "0" (compare) : "memory" );
 387 #endif
 388     return ret;
 389 }
 390
 391 static inline int interlocked_xchg( int *dest, int val )
 392 {
 393     int ret;
 394     __asm__ __volatile__( "lock; xchgl %0,(%1)"
 395                           : "=r" (ret) : "r" (dest), "0" (val) : "memory" );
 396     return ret;
 397 }
 398
 399 static inline void *interlocked_xchg_ptr( void **dest, void *val )
 400 {
 401     void *ret;
 402 #ifdef __x86_64__
 403     __asm__ __volatile__( "lock; xchgq %0,(%1)"
 404                           : "=r" (ret) :"r" (dest), "0" (val) : "memory" );
 405 #else
 406     __asm__ __volatile__( "lock; xchgl %0,(%1)"
 407                           : "=r" (ret) : "r" (dest), "0" (val) : "memory" );
 408 #endif
 409     return ret;
 410 }
 411
 412 static inline int interlocked_xchg_add( int *dest, int incr )
 413 {
 414     int ret;
 415     __asm__ __volatile__( "lock; xaddl %0,(%1)"
 416                           : "=r" (ret) : "r" (dest), "0" (incr) : "memory" );
 417     return ret;
 418 }
 419
 420 #ifdef __x86_64__
 421 static inline unsigned char interlocked_cmpxchg128( __int64 *dest, __int64 xchg_high,
 422                                                     __int64 xchg_low, __int64 *compare )
 423 {
 424     unsigned char ret;
 425     __asm__ __volatile__( "lock cmpxchg16b %0; setz %b2"
 426                           : "=m" (dest[0]), "=m" (dest[1]), "=r" (ret),
 427                             "=a" (compare[0]), "=d" (compare[1])
 428                           : "m" (dest[0]), "m" (dest[1]), "3" (compare[0]), "4" (compare[1]),
 429                             "c" (xchg_high), "b" (xchg_low) );
 430     return ret;
 431 }
 432 #endif
 433
 434 #else  /* __GNUC__ */
 435
 436 #ifdef __GCC_HAVE_SYNC_COMPARE_AND_SWAP_4
 437 static inline int interlocked_cmpxchg( int *dest, int xchg, int compare )
 438 {
 439     return __sync_val_compare_and_swap( dest, compare, xchg );
 440 }
 441
 442 static inline int interlocked_xchg_add( int *dest, int incr )
 443 {
 444     return __sync_fetch_and_add( dest, incr );
 445 }
 446
 447 static inline int interlocked_xchg( int *dest, int val )
 448 {
 449     int ret;
 450     do ret = *dest; while (!__sync_bool_compare_and_swap( dest, ret, val ));
 451     return ret;
 452 }
 453 #else
 454 extern int interlocked_cmpxchg( int *dest, int xchg, int compare );
 455 extern int interlocked_xchg_add( int *dest, int incr );
 456 extern int interlocked_xchg( int *dest, int val );
 457 #endif
 458
 459 #if (defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4) && __SIZEOF_POINTER__ == 4) \
 460  || (defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_8) && __SIZEOF_POINTER__ == 8)
 461 static inline void *interlocked_cmpxchg_ptr( void **dest, void *xchg, void *compare )
 462 {
 463     return __sync_val_compare_and_swap( dest, compare, xchg );
 464 }
 465
 466 static inline void *interlocked_xchg_ptr( void **dest, void *val )
 467 {
 468     void *ret;
 469     do ret = *dest; while (!__sync_bool_compare_and_swap( dest, ret, val ));
 470     return ret;
 471 }
 472 #else
 473 extern void *interlocked_cmpxchg_ptr( void **dest, void *xchg, void *compare );
 474 extern void *interlocked_xchg_ptr( void **dest, void *val );
 475 #endif
 476
 477 #if defined(__x86_64__) || defined(__aarch64__) || defined(_WIN64)
 478 extern unsigned char interlocked_cmpxchg128( __int64 *dest, __int64 xchg_high,
 479                                              __int64 xchg_low, __int64 *compare );
 480 #endif
 481
 482 #endif  /* __GNUC__ */
 483
 484 #ifdef __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8
 485 static inline __int64 interlocked_cmpxchg64( __int64 *dest, __int64 xchg, __int64 compare )
 486 {
 487     return __sync_val_compare_and_swap( dest, compare, xchg );
 488 }
 489 #else
 490 extern __int64 interlocked_cmpxchg64( __int64 *dest, __int64 xchg, __int64 compare );
 491 #endif
 492
 493 #else /* NO_LIBWINE_PORT */
 494
 495 #define __WINE_NOT_PORTABLE(func) func##_is_not_portable func##_is_not_portable
 496
 497 #define ffs                     __WINE_NOT_PORTABLE(ffs)
 498 #define fstatvfs                __WINE_NOT_PORTABLE(fstatvfs)
 499 #define getopt_long             __WINE_NOT_PORTABLE(getopt_long)
 500 #define getopt_long_only        __WINE_NOT_PORTABLE(getopt_long_only)
 501 #define interlocked_cmpxchg     __WINE_NOT_PORTABLE(interlocked_cmpxchg)
 502 #define interlocked_cmpxchg_ptr __WINE_NOT_PORTABLE(interlocked_cmpxchg_ptr)
 503 #define interlocked_xchg        __WINE_NOT_PORTABLE(interlocked_xchg)
 504 #define interlocked_xchg_ptr    __WINE_NOT_PORTABLE(interlocked_xchg_ptr)
 505 #define interlocked_xchg_add    __WINE_NOT_PORTABLE(interlocked_xchg_add)
 506 #define lstat                   __WINE_NOT_PORTABLE(lstat)
 507 #define memcpy_unaligned        __WINE_NOT_PORTABLE(memcpy_unaligned)
 508 #undef memmove
 509 #define memmove                 __WINE_NOT_PORTABLE(memmove)
 510 #define pread                   __WINE_NOT_PORTABLE(pread)
 511 #define pwrite                  __WINE_NOT_PORTABLE(pwrite)
 512 #define spawnvp                 __WINE_NOT_PORTABLE(spawnvp)
 513 #define statvfs                 __WINE_NOT_PORTABLE(statvfs)
 514 #define strcasecmp              __WINE_NOT_PORTABLE(strcasecmp)
 515 #define strerror                __WINE_NOT_PORTABLE(strerror)
 516 #define strncasecmp             __WINE_NOT_PORTABLE(strncasecmp)
 517 #define usleep                  __WINE_NOT_PORTABLE(usleep)
 518
 519 #endif /* NO_LIBWINE_PORT */
 520
 521 #endif /* !defined(__WINE_WINE_PORT_H) */