1 /* xbt.h - Public interface to the xbt (simgrid's toolbox) */
3 /* Copyright (c) 2004-2015. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include "simgrid_config.h"
14 /* Define _GNU_SOURCE for getline, isfinite, etc. */
19 /* Attributes are only in recent versions of GCC */
20 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4))
21 # define _XBT_GNUC_PRINTF( format_idx, arg_idx ) \
22 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
23 # define _XBT_GNUC_SCANF( format_idx, arg_idx ) \
24 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
25 # define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
26 # define _XBT_GNUC_UNUSED __attribute__((__unused__))
27 /* Constructor priorities exist since gcc 4.3. Apparently, they are however not
28 * supported on Macs. */
29 # if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__)
30 # define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio)))
31 # define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio)))
33 # define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__))
34 # define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__))
36 # undef _XBT_NEED_INIT_PRAGMA
39 # define _XBT_GNUC_PRINTF( format_idx, arg_idx )
40 # define _XBT_GNUC_SCANF( format_idx, arg_idx )
41 # define _XBT_GNUC_NORETURN
42 # define _XBT_GNUC_UNUSED
43 # define _XBT_GNUC_CONSTRUCTOR(prio)
44 # define _XBT_GNUC_DESTRUCTOR(prio)
45 # define _XBT_NEED_INIT_PRAGMA 1
47 #endif /* !__GNUC__ */
49 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
51 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
52 # define _XBT_FUNCTION __FUNCTION__
53 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
54 # define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
56 # define _XBT_FUNCTION "function"
63 # if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
64 # define XBT_INLINE inline
65 # elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
66 # define XBT_INLINE inline
71 # if defined (__VISUALC__)
72 # define XBT_INLINE __inline
74 # define XBT_INLINE inline
76 # endif /* __cplusplus */
79 /* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
83 #define MIN(a,b) ((a)<(b)?(a):(b))
88 #define MAX(a,b) ((a)>(b)?(a):(b))
91 * Expands to `one' if there is only one argument for the variadic part.
92 * Otherwise, expands to `more'.
93 * Works with up to 63 arguments, which is the maximum mandated by the C99
96 #define _XBT_IF_ONE_ARG(one, more, ...) \
97 _XBT_IF_ONE_ARG_(__VA_ARGS__, \
98 more, more, more, more, more, more, more, more, \
99 more, more, more, more, more, more, more, more, \
100 more, more, more, more, more, more, more, more, \
101 more, more, more, more, more, more, more, more, \
102 more, more, more, more, more, more, more, more, \
103 more, more, more, more, more, more, more, more, \
104 more, more, more, more, more, more, more, more, \
105 more, more, more, more, more, more, more, one)
106 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
107 a56, a55, a54, a53, a52, a51, a50, a49, \
108 a48, a47, a46, a45, a44, a43, a42, a41, \
109 a40, a39, a38, a37, a36, a35, a34, a33, \
110 a32, a31, a30, a29, a28, a27, a26, a25, \
111 a24, a23, a22, a21, a20, a19, a18, a17, \
112 a16, a15, a14, a13, a12, a11, a10, a9, \
113 a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
116 * Function calling convention (not used for now)
121 # define _XBT_CALL __cdecl
127 /* Handle import/export stuff
129 * Rational of XBT_PUBLIC:
130 * * This is for library symbols visible from the application-land.
131 * Basically, any symbols defined in the include/directory must be
132 * like this (plus some other globals).
134 * UNIX coders should just think of it as a special way to say "extern".
136 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols
137 * actually get exported by this file.
139 * * If you do a static windows compilation, define DLL_STATIC, both when
140 * compiling the application files and when compiling the library.
142 * * If you link your application against the DLL or if you do a UNIX build,
143 * don't do anything special. This file will do the right thing for you
147 * Rational of XBT_EXPORT_NO_IMPORT: (windows-only cruft)
148 * * Symbols which must be exported in the DLL, but not imported from it.
150 * * This is obviously useful for initialized globals (which cannot be
151 * extern or similar).
152 * * This is also used in the log mecanism where a macro creates the
153 * variable automatically. When the macro is called from within SimGrid,
154 * the symbol must be exported, but when called from within the client
155 * code, it must not try to retrieve the symbol from the DLL since it's
158 * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)
159 * * Symbols which must be imported from the DLL, but not explicitely
162 * * The root log category is already exported, but not imported explicitely
163 * when creating a subcategory since we cannot import the parent category
164 * to deal with the fact that the parent may be in application space, not
169 #if defined(DLL_EXPORT)
170 # define XBT_PUBLIC(type) __declspec(dllexport) type
171 # define XBT_EXPORT_NO_IMPORT(type) __declspec(dllexport) type
172 # define XBT_IMPORT_NO_EXPORT(type) type
173 # define XBT_PUBLIC_DATA(type) extern __declspec(dllexport) type
174 # define XBT_PUBLIC_CLASS class __declspec(dllexport)
177 /* Pack everything up statically */
178 #elif defined(DLL_STATIC)
179 # define XBT_PUBLIC(type) type
180 # define XBT_EXPORT_NO_IMPORT(type) type
181 # define XBT_IMPORT_NO_EXPORT(type) type
182 # define XBT_PUBLIC_DATA(type) extern type
183 # define XBT_PUBLIC_CLASS class
186 /* Link against the DLL */
187 #elif (defined(_XBT_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))
188 # define XBT_PUBLIC(type) __declspec(dllimport) type
189 # define XBT_EXPORT_NO_IMPORT(type) type
190 # define XBT_IMPORT_NO_EXPORT(type) __declspec(dllimport) type
191 # define XBT_PUBLIC_DATA(type) extern __declspec(dllimport) type
192 # define XBT_PUBLIC_CLASS class __declspec(dllimport)
197 # define XBT_PUBLIC(type) type
198 # define XBT_EXPORT_NO_IMPORT(type) type
199 # define XBT_IMPORT_NO_EXPORT(type) type
200 # define XBT_PUBLIC_DATA(type) extern type
201 # define XBT_PUBLIC_CLASS class
208 #define XBT_INTERNAL __attribute__((visibility ("hidden")))
211 #if !defined (max) && !defined(__cplusplus)
212 # define max(a,b) (((a) > (b)) ? (a) : (b))
214 #if !defined (min) && !defined(__cplusplus)
215 # define min(a,b) (((a) < (b)) ? (a) : (b))
221 /*! C++ users need love */
222 #ifndef SG_BEGIN_DECL
224 # define SG_BEGIN_DECL() extern "C" {
226 # define SG_BEGIN_DECL()
232 # define SG_END_DECL() }
234 # define SG_END_DECL()
237 /* End of cruft for C++ */