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