X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/bc48db087894fd960073b3120cebf90e6b2f8c02..8b73eca4934e5648d85c6f61db07e199ea997473:/include/xbt/base.h diff --git a/include/xbt/base.h b/include/xbt/base.h index 9d4ea07042..88deb0f494 100644 --- a/include/xbt/base.h +++ b/include/xbt/base.h @@ -1,7 +1,6 @@ -/* xbt.h - Public interface to the xbt (simgrid's toolbox) */ +/* xbt.h - Public interface to the xbt (simgrid's toolbox) */ -/* Copyright (c) 2004-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -11,62 +10,82 @@ /* Define _GNU_SOURCE for getline, isfinite, etc. */ #ifndef _GNU_SOURCE - #define _GNU_SOURCE +# define _GNU_SOURCE #endif /* On MinGW, stdio.h defines __MINGW_PRINTF_FORMAT and __MINGW_SCANF_FORMAT which are the suitable format style (either gnu_printf or ms_printf) depending on which version is available (__USE_MINGW_ANSI_STDIO): */ #ifdef __MINGW32__ - #include +# include - # define XBT_ATTRIB_PRINTF( format_idx, arg_idx ) \ - __attribute__((__format__ (__MINGW_PRINTF_FORMAT, format_idx, arg_idx))) - # define XBT_ATTRIB_SCANF( format_idx, arg_idx ) \ - __attribute__((__MINGW_SCANF_FORMAT (__scanf__, format_idx, arg_idx))) +#define XBT_ATTRIB_PRINTF(format_idx, arg_idx) \ + __attribute__((__format__(__MINGW_PRINTF_FORMAT, (format_idx), (arg_idx)))) +#define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__MINGW_SCANF_FORMAT(__scanf__, (format_idx), (arg_idx)))) #else - # define XBT_ATTRIB_PRINTF( format_idx, arg_idx ) \ - __attribute__((__format__ (__printf__, format_idx, arg_idx))) - # define XBT_ATTRIB_SCANF( format_idx, arg_idx ) \ - __attribute__((__format__ (__scanf__, format_idx, arg_idx))) +#define XBT_ATTRIB_PRINTF(format_idx, arg_idx) __attribute__((__format__(__printf__, (format_idx), (arg_idx)))) +#define XBT_ATTRIB_SCANF(format_idx, arg_idx) __attribute__((__format__(__scanf__, (format_idx), (arg_idx)))) #endif -# define XBT_ATTRIB_NORETURN __attribute__((__noreturn__)) -# define XBT_ATTRIB_UNUSED __attribute__((__unused__)) - -/* Constructor priorities exist since gcc 4.3. Apparently, they are however not - * supported on Macs. */ -# if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)) && !defined(__APPLE__) -# define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__ (prio))) -# define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__ (prio))) -# else -# define _XBT_GNUC_CONSTRUCTOR(prio) __attribute__((__constructor__)) -# define _XBT_GNUC_DESTRUCTOR(prio) __attribute__((__destructor__)) -# endif -# undef _XBT_NEED_INIT_PRAGMA +#if defined(__cplusplus) +#if __cplusplus >= 201103L +#define XBT_ATTRIB_NORETURN [[noreturn]] +#endif +#if __cplusplus >= 201703L +#define XBT_ATTRIB_UNUSED [[maybe_unused]] +#endif +#if __cplusplus >= 201402L +#define XBT_ATTRIB_DEPRECATED(mesg) [[deprecated(mesg)]] +#endif +#elif defined(__STDC_VERSION__) +#if __STDC_VERSION__ >= 201112L +#define XBT_ATTRIB_NORETURN _Noreturn +#endif +#endif -#if defined(__GNUC__) -# define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline)) -#else -# define XBT_ALWAYS_INLINE inline +#ifndef XBT_ATTRIB_NORETURN +#define XBT_ATTRIB_NORETURN __attribute__((noreturn)) +#endif +#ifndef XBT_ATTRIB_UNUSED +#define XBT_ATTRIB_UNUSED __attribute__((unused)) +#endif +#ifndef XBT_ATTRIB_DEPRECATED +#define XBT_ATTRIB_DEPRECATED(mesg) __attribute__((deprecated(mesg))) #endif -#if defined(__GNUC__) -# define XBT_THREAD_LOCAL __thread +#define XBT_ATTRIB_DEPRECATED_v329(mesg) \ + XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.28)") +#define XBT_ATTRIB_DEPRECATED_v330(mesg) \ + XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.29)") +#define XBT_ATTRIB_DEPRECATED_v331(mesg) \ + XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.30)") +#define XBT_ATTRIB_DEPRECATED_v332(mesg) \ + XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped after v3.31)") + +#if !defined(__APPLE__) +# define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__(prio))) +# define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__(prio))) #else -# define XBT_THREAD_LOCAL No thread local on this architecture +# define XBT_ATTRIB_CONSTRUCTOR(prio) __attribute__((__constructor__)) +# define XBT_ATTRIB_DESTRUCTOR(prio) __attribute__((__destructor__)) #endif -/* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */ -#ifdef MIN -# undef MIN +#ifndef XBT_ALWAYS_INLINE /* defined also in libsosp */ +# if defined(__GNUC__) +# define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline)) +# else +# define XBT_ALWAYS_INLINE inline +# endif #endif -#define MIN(a,b) ((a)<(b)?(a):(b)) -#ifdef MAX -# undef MAX -#endif -#define MAX(a,b) ((a)>(b)?(a):(b)) +/* Stringify argument. */ +#define _XBT_STRINGIFY(a) #a + +/* Concatenate arguments. _XBT_CONCAT2 adds a level of indirection over _XBT_CONCAT. */ +#define _XBT_CONCAT(a, b) a##b +#define _XBT_CONCAT2(a, b) _XBT_CONCAT(a, b) +#define _XBT_CONCAT3(a, b, c) _XBT_CONCAT2(_XBT_CONCAT2(a, b), c) +#define _XBT_CONCAT4(a, b, c, d) _XBT_CONCAT2(_XBT_CONCAT3(a, b, c), d) /* * Expands to `one' if there is only one argument for the variadic part. @@ -92,9 +111,43 @@ a16, a15, a14, a13, a12, a11, a10, a9, \ a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N +/* Expands to number of arguments. */ +#define _XBT_COUNT_ARGS(...) _XBT_IF_ONE_ARG_(__VA_ARGS__, \ + 64, 63, 62, 61, 60, 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, 49, \ + 48, 47, 46, 45, 44, 43, 42, 41, 40, 39, 38, 37, 36, 35, 34, 33, \ + 32, 31, 30, 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, 19, 18, 17, \ + 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1) + +/* Expands to list with each argument rendered as string. Add more cases if needed. */ +#define _XBT_STRINGIFY_ARGS(...) _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_02_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_02_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_03_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_03_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_04_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_04_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_05_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_05_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_06_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_06_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_07_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_07_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_08_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_08_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_09_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_09_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_10_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_10_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_11_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_11_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_12_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_12_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_13_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_13_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_14_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_14_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_15_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_15_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_16_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_16_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_17_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_17_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_18_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_18_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_19_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_19_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_20_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_20_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_21_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_21_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_22_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_22_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_23_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_23_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_24_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_24_(a, ...) #a, _XBT_IF_ONE_ARG(_XBT_STRINGIFY, _XBT_STRINGIFY_A_25_, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_STRINGIFY_A_25_(...) error_maximum_size_of_XBT_STRINGIFY_ARGS_reached + /* Handle import/export stuff * - * Rational of XBT_PUBLIC: + * Rationale of XBT_PUBLIC: * * This is for library symbols visible from the application-land. * Basically, any symbols defined in the include/directory must be like this (plus some other globals). * @@ -105,7 +158,7 @@ * * If you link your application against the DLL or if you do a UNIX build, don't do anything special. This file * will do the right thing for you by default. * - * Rational of XBT_EXPORT_NO_IMPORT: (windows-only) + * Rationale of XBT_EXPORT_NO_IMPORT: (windows-only) * * Symbols which must be exported in the DLL, but not imported from it. * * * This is obviously useful for initialized globals (which cannot be extern or similar). @@ -113,7 +166,7 @@ * called from within SimGrid, the symbol must be exported, but when called from within the client code, it must * not try to retrieve the symbol from the DLL since it's not in there. * - * Rational of XBT_IMPORT_NO_EXPORT: (windows-only) + * Rationale of XBT_IMPORT_NO_EXPORT: (windows-only) * * Symbols which must be imported from the DLL, but not explicitly exported from it. * * * The root log category is already exported, but not imported explicitly when creating a subcategory since we @@ -123,57 +176,50 @@ /* Build the DLL */ #if defined(DLL_EXPORT) -# define XBT_PUBLIC(type) __declspec(dllexport) type -# define XBT_EXPORT_NO_IMPORT(type) __declspec(dllexport) type -# define XBT_IMPORT_NO_EXPORT(type) type -# define XBT_PUBLIC_DATA(type) extern __declspec(dllexport) type -# define XBT_PUBLIC_CLASS class __declspec(dllexport) +# define XBT_PUBLIC __declspec(dllexport) +# define XBT_EXPORT_NO_IMPORT __declspec(dllexport) +# define XBT_IMPORT_NO_EXPORT +# define XBT_PUBLIC_DATA extern __declspec(dllexport) # define XBT_PRIVATE /* Link against the DLL */ #elif (defined(_WIN32) && !defined(DLL_EXPORT)) -# define XBT_PUBLIC(type) __declspec(dllimport) type -# define XBT_EXPORT_NO_IMPORT(type) type -# define XBT_IMPORT_NO_EXPORT(type) __declspec(dllimport) type -# define XBT_PUBLIC_DATA(type) extern __declspec(dllimport) type -# define XBT_PUBLIC_CLASS class __declspec(dllimport) +# define XBT_PUBLIC __declspec(dllimport) +# define XBT_EXPORT_NO_IMPORT +# define XBT_IMPORT_NO_EXPORT __declspec(dllimport) +# define XBT_PUBLIC_DATA extern __declspec(dllimport) # define XBT_PRIVATE -#elif defined(__ELF__) -# define XBT_PUBLIC(type) __attribute__((visibility("default"))) type -# define XBT_EXPORT_NO_IMPORT(type) __attribute__((visibility("default"))) type -# define XBT_IMPORT_NO_EXPORT(type) __attribute__((visibility("default"))) type -# define XBT_PUBLIC_DATA(type) extern __attribute__((visibility("default"))) type -# define XBT_PUBLIC_CLASS class __attribute__((visibility("default"))) -# define XBT_PRIVATE __attribute__((visibility("hidden"))) +#elif defined(__ELF__) +# define XBT_PUBLIC __attribute__((visibility("default"))) +# define XBT_EXPORT_NO_IMPORT __attribute__((visibility("default"))) +# define XBT_IMPORT_NO_EXPORT __attribute__((visibility("default"))) +# define XBT_PUBLIC_DATA extern __attribute__((visibility("default"))) +# define XBT_PRIVATE __attribute__((visibility("hidden"))) #else -# define XBT_PUBLIC(type) type -# define XBT_EXPORT_NO_IMPORT(type) type -# define XBT_IMPORT_NO_EXPORT(type) type -# define XBT_PUBLIC_DATA(type) extern type -# define XBT_PUBLIC_CLASS class -# define XBT_PRIVATE +# define XBT_PUBLIC /* public */ +# define XBT_EXPORT_NO_IMPORT +# define XBT_IMPORT_NO_EXPORT +# define XBT_PUBLIC_DATA extern +# define XBT_PRIVATE /** @private */ #endif -#define TRUE 1 -#define FALSE 0 - -/*! C++ users need love */ +/* C++ users need love */ #ifndef SG_BEGIN_DECL # ifdef __cplusplus -# define SG_BEGIN_DECL() extern "C" { +# define SG_BEGIN_DECL extern "C" { # else -# define SG_BEGIN_DECL() +# define SG_BEGIN_DECL # endif #endif #ifndef SG_END_DECL # ifdef __cplusplus -# define SG_END_DECL() } +# define SG_END_DECL } # else -# define SG_END_DECL() +# define SG_END_DECL # endif #endif /* End of cruft for C++ */