Some updates to the faq.
[wine/wine64.git] / include / wine / port.h
blob31c0a82d0f7abc5b8e086405734947d953b0b671
1 /*
2 * Wine porting definitions
4 * Copyright 1996 Alexandre Julliard
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __WINE_WINE_PORT_H
22 #define __WINE_WINE_PORT_H
24 #ifndef __WINE_CONFIG_H
25 # error You must include config.h to use this header
26 #endif
28 #define _GNU_SOURCE /* for pread/pwrite */
29 #include <fcntl.h>
30 #include <math.h>
31 #include <sys/types.h>
32 #include <sys/stat.h>
33 #ifdef HAVE_DIRECT_H
34 # include <direct.h>
35 #endif
36 #ifdef HAVE_IO_H
37 # include <io.h>
38 #endif
39 #ifdef HAVE_PROCESS_H
40 # include <process.h>
41 #endif
42 #include <string.h>
43 #ifdef HAVE_UNISTD_H
44 # include <unistd.h>
45 #endif
48 /****************************************************************
49 * Type definitions
52 #ifndef HAVE_MODE_T
53 typedef int mode_t;
54 #endif
55 #ifndef HAVE_OFF_T
56 typedef long off_t;
57 #endif
58 #ifndef HAVE_PID_T
59 typedef int pid_t;
60 #endif
61 #ifndef HAVE_SIZE_T
62 typedef unsigned int size_t;
63 #endif
64 #ifndef HAVE_SSIZE_T
65 typedef int ssize_t;
66 #endif
67 #ifndef HAVE_FSBLKCNT_T
68 typedef unsigned long fsblkcnt_t;
69 #endif
70 #ifndef HAVE_FSFILCNT_T
71 typedef unsigned long fsfilcnt_t;
72 #endif
74 #ifndef HAVE_STRUCT_STATVFS_F_BLOCKS
75 struct statvfs
77 unsigned long f_bsize;
78 unsigned long f_frsize;
79 fsblkcnt_t f_blocks;
80 fsblkcnt_t f_bfree;
81 fsblkcnt_t f_bavail;
82 fsfilcnt_t f_files;
83 fsfilcnt_t f_ffree;
84 fsfilcnt_t f_favail;
85 unsigned long f_fsid;
86 unsigned long f_flag;
87 unsigned long f_namemax;
89 #endif /* HAVE_STRUCT_STATVFS_F_BLOCKS */
92 /****************************************************************
93 * Macro definitions
96 #ifdef HAVE_DLFCN_H
97 #include <dlfcn.h>
98 #else
99 #define RTLD_LAZY 0x001
100 #define RTLD_NOW 0x002
101 #define RTLD_GLOBAL 0x100
102 #endif
104 #if !defined(HAVE_FTRUNCATE) && defined(HAVE_CHSIZE)
105 #define ftruncate chsize
106 #endif
108 #if !defined(HAVE_POPEN) && defined(HAVE__POPEN)
109 #define popen _popen
110 #endif
112 #if !defined(HAVE_PCLOSE) && defined(HAVE__PCLOSE)
113 #define pclose _pclose
114 #endif
116 #if !defined(HAVE_SNPRINTF) && defined(HAVE__SNPRINTF)
117 #define snprintf _snprintf
118 #endif
120 #if !defined(HAVE_VSNPRINTF) && defined(HAVE__VSNPRINTF)
121 #define vsnprintf _vsnprintf
122 #endif
124 #ifndef S_ISLNK
125 # define S_ISLNK(mod) (0)
126 #endif
128 #ifndef S_ISSOCK
129 # define S_ISSOCK(mod) (0)
130 #endif
132 #ifndef S_ISDIR
133 # define S_ISDIR(mod) (((mod) & _S_IFMT) == _S_IFDIR)
134 #endif
136 #ifndef S_ISCHR
137 # define S_ISCHR(mod) (((mod) & _S_IFMT) == _S_IFCHR)
138 #endif
140 #ifndef S_ISFIFO
141 # define S_ISFIFO(mod) (((mod) & _S_IFMT) == _S_IFIFO)
142 #endif
144 #ifndef S_ISREG
145 # define S_ISREG(mod) (((mod) & _S_IFMT) == _S_IFREG)
146 #endif
148 #ifndef S_IWUSR
149 # define S_IWUSR 0
150 #endif
152 /* So we open files in 64 bit access mode on Linux */
153 #ifndef O_LARGEFILE
154 # define O_LARGEFILE 0
155 #endif
157 #ifndef O_NONBLOCK
158 # define O_NONBLOCK 0
159 #endif
161 #ifndef O_BINARY
162 # define O_BINARY 0
163 #endif
165 #if !defined(S_IXUSR) && defined(S_IEXEC)
166 # define S_IXUSR S_IEXEC
167 #endif
168 #if !defined(S_IXGRP) && defined(S_IEXEC)
169 # define S_IXGRP S_IEXEC
170 #endif
171 #if !defined(S_IXOTH) && defined(S_IEXEC)
172 # define S_IXOTH S_IEXEC
173 #endif
175 /****************************************************************
176 * Constants
179 #ifndef M_PI
180 #define M_PI 3.14159265358979323846
181 #endif
183 #ifndef M_PI_2
184 #define M_PI_2 1.570796326794896619
185 #endif
188 /* Macros to define assembler functions somewhat portably */
190 #ifdef __GNUC__
191 # define __ASM_GLOBAL_FUNC(name,code) \
192 __asm__( ".align 4\n\t" \
193 ".globl " __ASM_NAME(#name) "\n\t" \
194 __ASM_FUNC(#name) "\n" \
195 __ASM_NAME(#name) ":\n\t" \
196 code );
197 #else /* __GNUC__ */
198 # define __ASM_GLOBAL_FUNC(name,code) \
199 void __asm_dummy_##name(void) { \
200 asm( ".align 4\n\t" \
201 ".globl " __ASM_NAME(#name) "\n\t" \
202 __ASM_FUNC(#name) "\n" \
203 __ASM_NAME(#name) ":\n\t" \
204 code ); \
206 #endif /* __GNUC__ */
209 /* Constructor functions */
211 #ifdef __GNUC__
212 # define DECL_GLOBAL_CONSTRUCTOR(func) \
213 static void func(void) __attribute__((constructor)); \
214 static void func(void)
215 #elif defined(__i386__)
216 # define DECL_GLOBAL_CONSTRUCTOR(func) \
217 static void __dummy_init_##func(void) { \
218 asm(".section .init,\"ax\"\n\t" \
219 "call " #func "\n\t" \
220 ".previous"); } \
221 static void func(void)
222 #elif defined(__sparc__)
223 # define DECL_GLOBAL_CONSTRUCTOR(func) \
224 static void __dummy_init_##func(void) { \
225 asm("\t.section \".init\",#alloc,#execinstr\n" \
226 "\tcall " #func "\n" \
227 "\tnop\n" \
228 "\t.section \".text\",#alloc,#execinstr\n" ); } \
229 static void func(void)
230 #else
231 # error You must define the DECL_GLOBAL_CONSTRUCTOR macro for your platform
232 #endif
235 /* Register functions */
237 #ifdef __i386__
238 #define DEFINE_REGS_ENTRYPOINT( name, fn, args, pop_args ) \
239 __ASM_GLOBAL_FUNC( name, \
240 "call " __ASM_NAME("__wine_call_from_32_regs") "\n\t" \
241 ".long " __ASM_NAME(#fn) "\n\t" \
242 ".byte " #args "," #pop_args )
243 /* FIXME: add support for other CPUs */
244 #endif /* __i386__ */
247 /****************************************************************
248 * Function definitions (only when using libwine_port)
251 #ifndef NO_LIBWINE_PORT
253 #ifndef HAVE_FSTATVFS
254 int fstatvfs( int fd, struct statvfs *buf );
255 #endif
257 #ifndef HAVE_GETOPT_LONG
258 extern char *optarg;
259 extern int optind;
260 extern int opterr;
261 extern int optopt;
262 struct option;
264 #ifndef HAVE_STRUCT_OPTION_NAME
265 struct option
267 const char *name;
268 int has_arg;
269 int *flag;
270 int val;
272 #endif
274 extern int getopt_long (int ___argc, char *const *___argv,
275 const char *__shortopts,
276 const struct option *__longopts, int *__longind);
277 extern int getopt_long_only (int ___argc, char *const *___argv,
278 const char *__shortopts,
279 const struct option *__longopts, int *__longind);
280 #endif /* HAVE_GETOPT_LONG */
282 #ifndef HAVE_GETPAGESIZE
283 size_t getpagesize(void);
284 #endif /* HAVE_GETPAGESIZE */
286 #ifndef HAVE_GETTID
287 pid_t gettid(void);
288 #endif /* HAVE_GETTID */
290 #ifndef HAVE_LSTAT
291 int lstat(const char *file_name, struct stat *buf);
292 #endif /* HAVE_LSTAT */
294 #ifndef HAVE_MEMMOVE
295 void *memmove(void *dest, const void *src, size_t len);
296 #endif /* !defined(HAVE_MEMMOVE) */
298 #ifndef HAVE_PREAD
299 ssize_t pread( int fd, void *buf, size_t count, off_t offset );
300 #endif /* HAVE_PREAD */
302 #ifndef HAVE_PWRITE
303 ssize_t pwrite( int fd, const void *buf, size_t count, off_t offset );
304 #endif /* HAVE_PWRITE */
306 #ifndef HAVE_READLINK
307 int readlink( const char *path, char *buf, size_t size );
308 #endif /* HAVE_READLINK */
310 #ifndef HAVE_SIGSETJMP
311 # include <setjmp.h>
312 typedef jmp_buf sigjmp_buf;
313 int sigsetjmp( sigjmp_buf buf, int savesigs );
314 void siglongjmp( sigjmp_buf buf, int val );
315 #endif /* HAVE_SIGSETJMP */
317 #ifndef HAVE_STATVFS
318 int statvfs( const char *path, struct statvfs *buf );
319 #endif
321 #ifndef HAVE_STRNCASECMP
322 # ifndef HAVE__STRNICMP
323 int strncasecmp(const char *str1, const char *str2, size_t n);
324 # else
325 # define strncasecmp _strnicmp
326 # endif
327 #endif /* !defined(HAVE_STRNCASECMP) */
329 #ifndef HAVE_STRERROR
330 const char *strerror(int err);
331 #endif /* !defined(HAVE_STRERROR) */
333 #ifndef HAVE_STRCASECMP
334 # ifndef HAVE__STRICMP
335 int strcasecmp(const char *str1, const char *str2);
336 # else
337 # define strcasecmp _stricmp
338 # endif
339 #endif /* !defined(HAVE_STRCASECMP) */
341 #ifndef HAVE_USLEEP
342 int usleep (unsigned int useconds);
343 #endif /* !defined(HAVE_USLEEP) */
345 #ifdef __i386__
346 static inline void *memcpy_unaligned( void *dst, const void *src, size_t size )
348 return memcpy( dst, src, size );
350 #else
351 extern void *memcpy_unaligned( void *dst, const void *src, size_t size );
352 #endif /* __i386__ */
354 extern int mkstemps(char *template, int suffix_len);
356 /* Process creation flags */
357 #ifndef _P_WAIT
358 # define _P_WAIT 0
359 # define _P_NOWAIT 1
360 # define _P_OVERLAY 2
361 # define _P_NOWAITO 3
362 # define _P_DETACH 4
363 #endif
364 #ifndef HAVE_SPAWNVP
365 extern int spawnvp(int mode, const char *cmdname, const char * const argv[]);
366 #endif
368 /* Interlocked functions */
370 #if defined(__i386__) && defined(__GNUC__)
372 extern inline long interlocked_cmpxchg( long *dest, long xchg, long compare )
374 long ret;
375 __asm__ __volatile__( "lock; cmpxchgl %2,(%1)"
376 : "=a" (ret) : "r" (dest), "r" (xchg), "0" (compare) : "memory" );
377 return ret;
380 extern inline void *interlocked_cmpxchg_ptr( void **dest, void *xchg, void *compare )
382 void *ret;
383 __asm__ __volatile__( "lock; cmpxchgl %2,(%1)"
384 : "=a" (ret) : "r" (dest), "r" (xchg), "0" (compare) : "memory" );
385 return ret;
388 extern inline long interlocked_xchg( long *dest, long val )
390 long ret;
391 __asm__ __volatile__( "lock; xchgl %0,(%1)"
392 : "=r" (ret) : "r" (dest), "0" (val) : "memory" );
393 return ret;
396 extern inline void *interlocked_xchg_ptr( void **dest, void *val )
398 void *ret;
399 __asm__ __volatile__( "lock; xchgl %0,(%1)"
400 : "=r" (ret) : "r" (dest), "0" (val) : "memory" );
401 return ret;
404 extern inline long interlocked_xchg_add( long *dest, long incr )
406 long ret;
407 __asm__ __volatile__( "lock; xaddl %0,(%1)"
408 : "=r" (ret) : "r" (dest), "0" (incr) : "memory" );
409 return ret;
412 #else /* __i386___ && __GNUC__ */
414 extern long interlocked_cmpxchg( long *dest, long xchg, long compare );
415 extern void *interlocked_cmpxchg_ptr( void **dest, void *xchg, void *compare );
416 extern long interlocked_xchg( long *dest, long val );
417 extern void *interlocked_xchg_ptr( void **dest, void *val );
418 extern long interlocked_xchg_add( long *dest, long incr );
420 #endif /* __i386___ && __GNUC__ */
422 #else /* NO_LIBWINE_PORT */
424 #define __WINE_NOT_PORTABLE(func) func##_is_not_portable func##_is_not_portable
426 #define fstatvfs __WINE_NOT_PORTABLE(fstatvfs)
427 #define getopt_long __WINE_NOT_PORTABLE(getopt_long)
428 #define getopt_long_only __WINE_NOT_PORTABLE(getopt_long_only)
429 #define getpagesize __WINE_NOT_PORTABLE(getpagesize)
430 #define interlocked_cmpxchg __WINE_NOT_PORTABLE(interlocked_cmpxchg)
431 #define interlocked_cmpxchg_ptr __WINE_NOT_PORTABLE(interlocked_cmpxchg_ptr)
432 #define interlocked_xchg __WINE_NOT_PORTABLE(interlocked_xchg)
433 #define interlocked_xchg_ptr __WINE_NOT_PORTABLE(interlocked_xchg_ptr)
434 #define interlocked_xchg_add __WINE_NOT_PORTABLE(interlocked_xchg_add)
435 #define lstat __WINE_NOT_PORTABLE(lstat)
436 #define memcpy_unaligned __WINE_NOT_PORTABLE(memcpy_unaligned)
437 #define memmove __WINE_NOT_PORTABLE(memmove)
438 #define pread __WINE_NOT_PORTABLE(pread)
439 #define pwrite __WINE_NOT_PORTABLE(pwrite)
440 #define spawnvp __WINE_NOT_PORTABLE(spawnvp)
441 #define statvfs __WINE_NOT_PORTABLE(statvfs)
442 #define strcasecmp __WINE_NOT_PORTABLE(strcasecmp)
443 #define strerror __WINE_NOT_PORTABLE(strerror)
444 #define strncasecmp __WINE_NOT_PORTABLE(strncasecmp)
445 #define usleep __WINE_NOT_PORTABLE(usleep)
447 #endif /* NO_LIBWINE_PORT */
449 #endif /* !defined(__WINE_WINE_PORT_H) */