Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix previous fix.
[simgrid.git] / include / xbt / base.h
1 /* xbt.h - Public interface to the xbt (simgrid's toolbox)                  */
2
3 /* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef XBT_BASE_H
9 #define XBT_BASE_H
10
11 /* Define _GNU_SOURCE for getline, isfinite, etc. */
12 #ifndef _GNU_SOURCE
13 #  define _GNU_SOURCE
14 #endif
15
16 /* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT
17    which are the suitable format style (either gnu_printf or ms_printf)
18    depending on which version is available (__USE_MINGW_ANSI_STDIO): */
19 #ifdef __MINGW32__
20 #  include <stdio.h>
21
22 #define XBT_ATTRIB_PRINTF(format_idx, arg_idx)                                                                         \
23   __attribute__((__format__(__MINGW_PRINTF_FORMAT, (format_idx), (arg_idx))))
24 #define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__MINGW_SCANF_FORMAT(__scanf__, (format_idx), (arg_idx))))
25 #else
26 #define XBT_ATTRIB_PRINTF(format_idx, arg_idx) __attribute__((__format__(__printf__, (format_idx), (arg_idx))))
27 #define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__format__(__scanf__, (format_idx), (arg_idx))))
28 #endif
29
30 #if defined(__cplusplus)
31 #if __cplusplus >= 201103L
32 #define XBT_ATTRIB_NORETURN [[noreturn]]
33 #endif
34 #if __cplusplus >= 201703L
35 #define XBT_ATTRIB_UNUSED [[maybe_unused]]
36 #endif
37 #if __cplusplus >= 201402L
38 #define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
39 #endif
40 #elif defined(__STDC_VERSION__)
41 #if __STDC_VERSION__ >= 201112L
42 #define XBT_ATTRIB_NORETURN _Noreturn
43 #endif
44 #endif
45
46 #ifndef XBT_ATTRIB_NORETURN
47 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
48 #endif
49 #ifndef XBT_ATTRIB_UNUSED
50 #define XBT_ATTRIB_UNUSED  __attribute__((unused))
51 #endif
52 #ifndef XBT_ATTRIB_DEPRECATED
53 #define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
54 #endif
55
56 #define XBT_ATTRIB_DEPRECATED_v329(mesg)                                                                               \
57   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.28)")
58 #define XBT_ATTRIB_DEPRECATED_v330(mesg)                                                                               \
59   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.29)")
60 #define XBT_ATTRIB_DEPRECATED_v331(mesg)                                                                               \
61   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.30)")
62 #define XBT_ATTRIB_DEPRECATED_v332(mesg)                                                                               \
63   XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.31)")
64
65 /* Work around https://github.com/microsoft/vscode-cpptools/issues/4503 */
66 #ifdef __INTELLISENSE__
67 #pragma diag_suppress 1094
68 #endif
69
70 #if !defined(__APPLE__)
71 #  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
72 #  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
73 #else
74 #  define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
75 #  define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
76 #endif
77
78 #ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */
79 #  if defined(__GNUC__)
80 #    define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
81 #  else
82 #    define XBT_ALWAYS_INLINE inline
83 #  endif
84 #endif
85
86 /* Stringify argument. */
87 #define _XBT_STRINGIFY(a) #a
88
89 /* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
90 #define _XBT_CONCAT(a, b) a##b
91 #define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
92 #define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c)
93 #define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
94
95 /*
96  * Expands to `one' if there is only one argument for the variadic part.
97  * Otherwise, expands to `more'.
98  * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
99  */
100 #define _XBT_IF_ONE_ARG(one, more, ...)                                 \
101     _XBT_IF_ONE_ARG_(__VA_ARGS__,                                       \
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, more,    \
106                      more, more, more, more, more, more, more, more,    \
107                      more, more, more, more, more, more, more, more,    \
108                      more, more, more, more, more, more, more, more,    \
109                      more, more, more, more, more, more, more, one)
110 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57,        \
111                          a56, a55, a54, a53, a52, a51, a50, a49,        \
112                          a48, a47, a46, a45, a44, a43, a42, a41,        \
113                          a40, a39, a38, a37, a36, a35, a34, a33,        \
114                          a32, a31, a30, a29, a28, a27, a26, a25,        \
115                          a24, a23, a22, a21, a20, a19, a18, a17,        \
116                          a16, a15, a14, a13, a12, a11, a10, a9,         \
117                          a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
118
119 /* Expands to number of arguments. */
120 #define _XBT_COUNT_ARGS(...) _XBT_IF_ONE_ARG_(__VA_ARGS__,              \
121                                               64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \
122                                               48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \
123                                               32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \
124                                               16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1)
125
126 /* Expands to list with each argument rendered as string. Add more cases if needed. */
127 #define _XBT_STRINGIFY_ARGS(...) _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_02_, __VA_ARGS__)(__VA_ARGS__)
128 #define _XBT_STRINGIFY_A_02_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_03_, __VA_ARGS__)(__VA_ARGS__)
129 #define _XBT_STRINGIFY_A_03_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_04_, __VA_ARGS__)(__VA_ARGS__)
130 #define _XBT_STRINGIFY_A_04_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_05_, __VA_ARGS__)(__VA_ARGS__)
131 #define _XBT_STRINGIFY_A_05_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_06_, __VA_ARGS__)(__VA_ARGS__)
132 #define _XBT_STRINGIFY_A_06_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_07_, __VA_ARGS__)(__VA_ARGS__)
133 #define _XBT_STRINGIFY_A_07_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_08_, __VA_ARGS__)(__VA_ARGS__)
134 #define _XBT_STRINGIFY_A_08_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_09_, __VA_ARGS__)(__VA_ARGS__)
135 #define _XBT_STRINGIFY_A_09_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_10_, __VA_ARGS__)(__VA_ARGS__)
136 #define _XBT_STRINGIFY_A_10_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_11_, __VA_ARGS__)(__VA_ARGS__)
137 #define _XBT_STRINGIFY_A_11_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_12_, __VA_ARGS__)(__VA_ARGS__)
138 #define _XBT_STRINGIFY_A_12_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_13_, __VA_ARGS__)(__VA_ARGS__)
139 #define _XBT_STRINGIFY_A_13_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_14_, __VA_ARGS__)(__VA_ARGS__)
140 #define _XBT_STRINGIFY_A_14_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_15_, __VA_ARGS__)(__VA_ARGS__)
141 #define _XBT_STRINGIFY_A_15_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_16_, __VA_ARGS__)(__VA_ARGS__)
142 #define _XBT_STRINGIFY_A_16_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_17_, __VA_ARGS__)(__VA_ARGS__)
143 #define _XBT_STRINGIFY_A_17_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_18_, __VA_ARGS__)(__VA_ARGS__)
144 #define _XBT_STRINGIFY_A_18_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_19_, __VA_ARGS__)(__VA_ARGS__)
145 #define _XBT_STRINGIFY_A_19_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_20_, __VA_ARGS__)(__VA_ARGS__)
146 #define _XBT_STRINGIFY_A_20_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_21_, __VA_ARGS__)(__VA_ARGS__)
147 #define _XBT_STRINGIFY_A_21_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_22_, __VA_ARGS__)(__VA_ARGS__)
148 #define _XBT_STRINGIFY_A_22_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_23_, __VA_ARGS__)(__VA_ARGS__)
149 #define _XBT_STRINGIFY_A_23_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_24_, __VA_ARGS__)(__VA_ARGS__)
150 #define _XBT_STRINGIFY_A_24_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_25_, __VA_ARGS__)(__VA_ARGS__)
151 #define _XBT_STRINGIFY_A_25_(...) error_maximum_size_of_XBT_STRINGIFY_ARGS_reached
152
153 /* Handle import/export stuff
154  *
155  * Rationale of XBT_PUBLIC:
156  *   * This is for library symbols visible from the application-land.
157  *     Basically, any symbols defined in the include/directory must be like this (plus some other globals).
158  *
159  *     UNIX coders should just think of it as a special way to say "extern".
160  *
161  *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
162  *
163  *   * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
164  *     will do the right thing for you by default.
165  *
166  * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
167  *   * Symbols which must be exported in the DLL, but not imported from it.
168  *
169  *   * This is obviously useful for initialized globals (which cannot be  extern or similar).
170  *   * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
171  *     called from within SimGrid, the symbol must be exported, but when called  from within the client code, it must
172  *     not try to retrieve the symbol from the DLL since it's not in there.
173  *
174  * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
175  *   * Symbols which must be imported from the DLL, but not explicitly  exported from it.
176  *
177  *   * The root log category is already exported, but not imported explicitly when creating a subcategory since we
178  *     cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
179  *     space.
180  */
181
182 /* Build the DLL */
183 #if defined(DLL_EXPORT)
184 #  define XBT_PUBLIC            __declspec(dllexport)
185 #  define XBT_EXPORT_NO_IMPORT  __declspec(dllexport)
186 #  define XBT_IMPORT_NO_EXPORT
187 #  define XBT_PUBLIC_DATA       extern __declspec(dllexport)
188 #  define XBT_PRIVATE
189
190 /* Link against the DLL */
191 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
192 #  define XBT_PUBLIC            __declspec(dllimport)
193 #  define XBT_EXPORT_NO_IMPORT
194 #  define XBT_IMPORT_NO_EXPORT  __declspec(dllimport)
195 #  define XBT_PUBLIC_DATA       extern __declspec(dllimport)
196 #  define XBT_PRIVATE
197
198 #elif defined(__ELF__)
199 #  define XBT_PUBLIC            __attribute__((visibility("default")))
200 #  define XBT_EXPORT_NO_IMPORT  __attribute__((visibility("default")))
201 #  define XBT_IMPORT_NO_EXPORT  __attribute__((visibility("default")))
202 #  define XBT_PUBLIC_DATA       extern __attribute__((visibility("default")))
203 #  define XBT_PRIVATE           __attribute__((visibility("hidden")))
204
205 #else
206 #  define XBT_PUBLIC            /* public */
207 #  define XBT_EXPORT_NO_IMPORT
208 #  define XBT_IMPORT_NO_EXPORT
209 #  define XBT_PUBLIC_DATA       extern
210 #  define XBT_PRIVATE           /** @private */
211
212 #endif
213
214 /* C++ users need love */
215 #ifndef SG_BEGIN_DECL
216 # ifdef __cplusplus
217 #  define SG_BEGIN_DECL extern "C" {
218 # else
219 #  define SG_BEGIN_DECL
220 # endif
221 #endif
222
223 #ifndef SG_END_DECL
224 # ifdef __cplusplus
225 #  define SG_END_DECL }
226 # else
227 #  define SG_END_DECL
228 # endif
229 #endif
230 /* End of cruft for C++ */
231
232 #endif