1 /* xbt.h - Public interface to the xbt (simgrid's toolbox) */
3 /* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */
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. */
11 /* Define _GNU_SOURCE for getline, isfinite, etc. */
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): */
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))))
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))))
30 #if defined(__cplusplus)
31 #if __cplusplus < 201402L
32 #error C++14 support is needed. Please upgrade your compiler and/or fix your compilation flags.
34 #define XBT_ATTRIB_NORETURN [[noreturn]]
35 #if __cplusplus >= 201703L
36 #define XBT_ATTRIB_UNUSED [[maybe_unused]]
38 #define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]]
39 #elif defined(__STDC_VERSION__)
40 #if __STDC_VERSION__ >= 201112L
41 #define XBT_ATTRIB_NORETURN _Noreturn
45 #ifndef XBT_ATTRIB_NORETURN
46 #define XBT_ATTRIB_NORETURN __attribute__((noreturn))
48 #ifndef XBT_ATTRIB_UNUSED
49 #define XBT_ATTRIB_UNUSED __attribute__((unused))
51 #ifndef XBT_ATTRIB_DEPRECATED
52 #define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg)))
55 #define XBT_ATTRIB_DEPRECATED_v328(mesg) \
56 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.28)")
57 #define XBT_ATTRIB_DEPRECATED_v329(mesg) \
58 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.29)")
59 #define XBT_ATTRIB_DEPRECATED_v330(mesg) \
60 XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.30)")
62 #if !defined(__APPLE__)
63 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio)))
64 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio)))
66 # define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__))
67 # define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__))
70 #ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */
71 # if defined(__GNUC__)
72 # define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline))
74 # define XBT_ALWAYS_INLINE inline
78 /* Stringify argument. */
79 #define _XBT_STRINGIFY(a) #a
81 /* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */
82 #define _XBT_CONCAT(a, b) a##b
83 #define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b)
84 #define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c)
85 #define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d)
88 * Expands to `one' if there is only one argument for the variadic part.
89 * Otherwise, expands to `more'.
90 * Works with up to 63 arguments, which is the maximum mandated by the C99 standard.
92 #define _XBT_IF_ONE_ARG(one, more, ...) \
93 _XBT_IF_ONE_ARG_(__VA_ARGS__, \
94 more, more, more, more, more, more, more, more, \
95 more, more, more, more, more, more, more, more, \
96 more, more, more, more, more, more, more, more, \
97 more, more, more, more, more, more, more, more, \
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, one)
102 #define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
103 a56, a55, a54, a53, a52, a51, a50, a49, \
104 a48, a47, a46, a45, a44, a43, a42, a41, \
105 a40, a39, a38, a37, a36, a35, a34, a33, \
106 a32, a31, a30, a29, a28, a27, a26, a25, \
107 a24, a23, a22, a21, a20, a19, a18, a17, \
108 a16, a15, a14, a13, a12, a11, a10, a9, \
109 a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N
111 /* Handle import/export stuff
113 * Rationale of XBT_PUBLIC:
114 * * This is for library symbols visible from the application-land.
115 * Basically, any symbols defined in the include/directory must be like this (plus some other globals).
117 * UNIX coders should just think of it as a special way to say "extern".
119 * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file.
121 * * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file
122 * will do the right thing for you by default.
124 * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only)
125 * * Symbols which must be exported in the DLL, but not imported from it.
127 * * This is obviously useful for initialized globals (which cannot be extern or similar).
128 * * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is
129 * called from within SimGrid, the symbol must be exported, but when called from within the client code, it must
130 * not try to retrieve the symbol from the DLL since it's not in there.
132 * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only)
133 * * Symbols which must be imported from the DLL, but not explicitly exported from it.
135 * * The root log category is already exported, but not imported explicitly when creating a subcategory since we
136 * cannot import the parent category to deal with the fact that the parent may be in application space, not DLL
141 #if defined(DLL_EXPORT)
142 # define XBT_PUBLIC __declspec(dllexport)
143 # define XBT_EXPORT_NO_IMPORT __declspec(dllexport)
144 # define XBT_IMPORT_NO_EXPORT
145 # define XBT_PUBLIC_DATA extern __declspec(dllexport)
148 /* Link against the DLL */
149 #elif (defined(_WIN32) && !defined(DLL_EXPORT))
150 # define XBT_PUBLIC __declspec(dllimport)
151 # define XBT_EXPORT_NO_IMPORT
152 # define XBT_IMPORT_NO_EXPORT __declspec(dllimport)
153 # define XBT_PUBLIC_DATA extern __declspec(dllimport)
156 #elif defined(__ELF__)
157 # define XBT_PUBLIC __attribute__((visibility("default")))
158 # define XBT_EXPORT_NO_IMPORT __attribute__((visibility("default")))
159 # define XBT_IMPORT_NO_EXPORT __attribute__((visibility("default")))
160 # define XBT_PUBLIC_DATA extern __attribute__((visibility("default")))
161 # define XBT_PRIVATE __attribute__((visibility("hidden")))
164 # define XBT_PUBLIC /* public */
165 # define XBT_EXPORT_NO_IMPORT
166 # define XBT_IMPORT_NO_EXPORT
167 # define XBT_PUBLIC_DATA extern
168 # define XBT_PRIVATE /** @private */
172 /* C++ users need love */
173 #ifndef SG_BEGIN_DECL
175 # define SG_BEGIN_DECL extern "C" {
177 # define SG_BEGIN_DECL
183 # define SG_END_DECL }
188 /* End of cruft for C++ */