Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Defines the XBT_PUBLIC macro that specify public functions of an API.
[simgrid.git] / src / portable.h
1 /* $Id$ */
2
3 /* portable -- header loading to write portable code                         */
4 /* loads much more stuff than sysdep.h since the latter is in public interface*/
5
6 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                   */
7
8 /* This program is free software; you can redistribute it and/or modify it
9   * under the terms of the license (GNU LGPL) which comes with this package. */
10
11 #ifndef GRAS_PORTABLE_H
12 #define GRAS_PORTABLE_H
13
14 /* 
15  * win32 or win64 (__WIN32 is defined for win32 and win64 applications, __TOS_WIN__ is defined by xlC). 
16 */ 
17 #ifdef _WIN32
18 # include "win32/config.h"
19 #  include <windows.h>
20 #else
21 #  include "gras_config.h"
22 #endif
23
24 #include <stdarg.h>
25
26 #ifdef HAVE_ERRNO_H
27 #  include <errno.h>
28 #endif
29
30 #ifdef HAVE_UNISTD_H
31 #  include <unistd.h>
32 #endif
33
34 /****
35  **** Networking 
36  ****/
37
38
39 #ifdef HAVE_SYS_SOCKET_H
40 #  include <sys/socket.h>
41 #  include <netinet/in.h>   /* sometimes required for #include <arpa/inet.h> */
42 #  include <netinet/tcp.h>  /* TCP_NODELAY */
43 #  include <netdb.h>        /* getprotobyname() */
44 #  include <arpa/inet.h>    /* inet_ntoa() */
45 #  include <sys/types.h>    /* sometimes required for fd_set */
46 # endif
47
48
49 #ifndef HAVE_WINSOCK_H
50 #       define tcp_read( s, buf, len)   read( s, buf, len )
51 #       define tcp_write( s, buf, len)  write( s, buf, len )
52 #       define sock_errno        errno
53 #       define sock_errstr(err)  strerror(err)
54
55 #       ifdef SHUT_RDWR
56 #               define tcp_close( s )   (shutdown( s, SHUT_RDWR ), close( s ))
57 #       else
58 #               define tcp_close( s )   close( s )
59 #       endif
60 #endif /* windows or unix ? */
61
62 /****
63  **** File handling
64  ****/
65
66 #include <fcntl.h>
67
68 #ifdef HAVE_SYS_STAT_H
69 #  include <sys/stat.h>
70 #endif
71
72 #ifndef O_BINARY
73 #  define O_BINARY 0
74 #endif
75
76 /****
77  **** Time handling
78  ****/
79
80 #ifdef TIME_WITH_SYS_TIME
81 # include <sys/time.h>
82 # include <time.h>
83 #else
84 # if HAVE_SYS_TIME_H
85 #  include <sys/time.h>
86 # else
87 #  include <time.h>
88 # endif
89 #endif
90
91 #ifdef _WIN32
92 #define sleep _sleep /* else defined in stdlib.h */
93 #endif
94
95 /****
96  **** Contexts
97  ****/
98
99 #ifdef USE_UCONTEXT
100 # include <ucontext.h>
101 #endif
102
103 #ifdef _WIN32
104 #  include "xbt/context_win32.h" /* Manual reimplementation for prehistoric platforms */
105 #endif
106
107 /****
108  **** Signals
109  ****/
110 #ifdef HAVE_SIGNAL_H
111 # include <signal.h>
112 #endif
113
114 /****
115  **** string handling (parts from http://www.ijs.si/software/snprintf/)
116  ****/
117
118 /* prototype of C99 functions */
119 #ifdef HAVE_SNPRINTF
120 #include <stdio.h>
121 #else
122 extern int snprintf(char *, size_t, const char *, /*args*/ ...);
123 extern int vsnprintf(char *, size_t, const char *, va_list);
124 #endif
125
126 /* use internal functions when OS provided ones are borken */
127 #if defined(HAVE_SNPRINTF) && defined(PREFER_PORTABLE_SNPRINTF)
128 extern int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
129 extern int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
130 #define snprintf  portable_snprintf
131 #define vsnprintf portable_vsnprintf
132 #endif
133
134 /* prototype of GNU functions  */
135 extern int asprintf  (char **ptr, const char *fmt, /*args*/ ...);
136 extern int vasprintf (char **ptr, const char *fmt, va_list ap);
137 extern int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
138 extern int vasnprintf(char **ptr, size_t str_m, const char *fmt, va_list ap);
139
140 /*
141  * That's needed to protect solaris's printf from ever seing NULL associated to a %s format
142  * (without adding an extra check on working platforms :)
143  */
144
145 #ifdef PRINTF_NULL_WORKING
146 #  define PRINTF_STR(a) (a)
147 #else
148 #  define PRINTF_STR(a) (a)?:"(null)"
149 #endif
150
151 /*
152  * What we need to extract the backtrace in exception handling code
153  */
154 #ifdef HAVE_EXECINFO_H
155 #  include <execinfo.h>
156 #endif
157
158 /****
159  **** Some debugging functions. Can't we find a better place for this??
160  ****/
161 void hexa_print(const char*name, unsigned char *data, int size);
162 const char *hexa_str(unsigned char *data, int size, int downside);
163
164 /* Windows __declspec(). */
165 #if defined (_XBT_USE_DECLSPEC) /* using export/import technique */
166
167 #    ifndef _XBT_EXPORT_DECLSPEC
168 #        define _XBT_EXPORT_DECLSPEC
169 #    endif
170
171 #    ifndef _XBT_IMPORT_DECLSPEC
172 #        define _XBT_IMPORT_DECLSPEC
173 #    endif
174
175 #    if defined (_XBT_DESIGNATED_DLL) /* this is a lib which will contain xbt exports */
176 #        define  _XBT_DECLSPEC        _XBT_EXPORT_DECLSPEC 
177 #    else
178 #        define  _XBT_DECLSPEC        _XBT_IMPORT_DECLSPEC   /* other modules, importing xbt exports */
179 #    endif
180
181 #else /* not using DLL export/import specifications */
182
183 #    define _XBT_DECLSPEC
184
185 #endif /* #if defined (_XBT_USE_DECLSPEC) */
186
187 #define XBT_PUBLIC _XBT_DECLSPEC
188
189 #if !defined (_XBT_CALL)
190 #define _XBT_CALL
191 #endif
192
193 #endif /* GRAS_PORTABLE_H */