X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/cf108868b4eeed4d0d9d343bc68557d7814e18c0..94bbf4f893b0b58419d77d2ebf29b96918489440:/include/xbt/base.h diff --git a/include/xbt/base.h b/include/xbt/base.h index 11800076eb..bd19a3272f 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-2019. 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. */ @@ -9,132 +8,100 @@ #ifndef XBT_BASE_H #define XBT_BASE_H -#include "simgrid_config.h" - /* Define _GNU_SOURCE for getline, isfinite, etc. */ #ifndef _GNU_SOURCE - #define _GNU_SOURCE +# define _GNU_SOURCE #endif -/* Attributes are only in recent versions of GCC */ -#if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)) +// Teach the compiler that some code path is unreachable: +#if defined(__has_builtin) +# if __has_builtin(__builtin_unreachable) +# define XBT_UNREACHABLE() __builtin_unreachable() +# else +# include +# define XBT_UNREACHABLE() abort() +# endif +#elif (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) +# define XBT_UNREACHABLE() __builtin_unreachable() +#else +# include +# define XBT_UNREACHABLE() abort() +#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 -#endif +# include -#if defined(__MINGW32__) && defined(__MINGW_PRINTF_FORMAT) - # define XBT_ATTRIB_PRINTF( format_idx, arg_idx ) \ - __attribute__((__format__ (__MINGW_PRINTF_FORMAT, 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_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 -#if defined(__MINGW32__) && defined(__MINGW_SCANF_FORMAT) - # define XBT_ATTRIB_SCANF( format_idx, arg_idx ) \ - __attribute__((__MINGW_SCANF_FORMAT (__scanf__, format_idx, arg_idx))) -#else - # define XBT_ATTRIB_SCANF( format_idx, arg_idx ) \ - __attribute__((__format__ (__scanf__, format_idx, arg_idx))) +#if defined(__cplusplus) +#if __cplusplus >= 201103L +#define XBT_ATTRIB_NORETURN [[noreturn]] #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 - -#elif defined(_MSC_VER) /* Microsoft Visual Thing */ -# define XBT_ATTRIB_PRINTF( format_idx, arg_idx ) -# define XBT_ATTRIB_SCANF( format_idx, arg_idx ) -# define XBT_ATTRIB_NORETURN __declspec(noreturn) -# define XBT_ATTRIB_UNUSED -# define _XBT_GNUC_CONSTRUCTOR(prio) -# define _XBT_GNUC_DESTRUCTOR(prio) -# define _XBT_NEED_INIT_PRAGMA 1 -#else -# define XBT_ATTRIB_PRINTF( format_idx, arg_idx ) -# define XBT_ATTRIB_SCANF( format_idx, arg_idx ) -# define XBT_ATTRIB_NORETURN -# define XBT_ATTRIB_UNUSED -# define _XBT_GNUC_CONSTRUCTOR(prio) -# define _XBT_GNUC_DESTRUCTOR(prio) -# define _XBT_NEED_INIT_PRAGMA 1 - -#endif /* gcc or MSVC else */ - -/* inline and __FUNCTION__ are only in GCC when -ansi is off */ - -#if defined(__GNUC__) && ! defined(__STRICT_ANSI__) -# define _XBT_FUNCTION __FUNCTION__ -#elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) -# define _XBT_FUNCTION __func__ /* ISO-C99 compliant */ -#else -# define _XBT_FUNCTION "function" +#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 - -#ifdef DOXYGEN -# define XBT_INLINE -#else -# ifndef __cplusplus -# if defined(__GNUC__) && ! defined(__STRICT_ANSI__) -# define XBT_INLINE inline -# elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) -# define XBT_INLINE inline -# else -# define XBT_INLINE -# endif -# else -# if defined (_MSC_VER) -# define XBT_INLINE __inline -# else -# define XBT_INLINE inline -# endif -# endif /* __cplusplus */ #endif -#if defined(__GNUC__) -# define XBT_ALWAYS_INLINE inline __attribute__ ((always_inline)) -#else -# define XBT_ALWAYS_INLINE XBT_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 + +#define XBT_ATTRIB_DEPRECATED_v328(mesg) \ + XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.28)") +#define XBT_ATTRIB_DEPRECATED_v329(mesg) \ + XBT_ATTRIB_DEPRECATED(mesg " (this compatibility wrapper will be dropped in v3.29)") -#if defined(__GNUC__) -# define XBT_THREAD_LOCAL __thread -#elif defined(_MSC_VER) -# define XBT_THREAD_LOCAL __declspec(thread) +#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. * Otherwise, expands to `more'. - * Works with up to 63 arguments, which is the maximum mandated by the C99 - * standard. + * Works with up to 63 arguments, which is the maximum mandated by the C99 standard. */ #define _XBT_IF_ONE_ARG(one, more, ...) \ _XBT_IF_ONE_ARG_(__VA_ARGS__, \ @@ -155,144 +122,81 @@ a16, a15, a14, a13, a12, a11, a10, a9, \ a8, a7, a6, a5, a4, a3, a2, a1, N, ...) N -/* - * Function calling convention (not used for now) - * http://unixwiz.net/techtips/win32-callconv.html <-- good documentation - */ - -#ifdef _XBT_WIN32 -# ifndef _XBT_CALL -# define _XBT_CALL __cdecl -# endif -#else -# define _XBT_CALL -#endif - /* 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). + * Basically, any symbols defined in the include/directory must be like this (plus some other globals). * * UNIX coders should just think of it as a special way to say "extern". * - * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols - * actually get exported by this file. - - * * If you do a static windows compilation, define DLL_STATIC, both when - * compiling the application files and when compiling the library. + * * If you build the DLL, define the DLL_EXPORT symbol so that all symbols actually get exported by this file. * - * * 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. + * * 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). - * * This is also used in the log mechanism where a macro creates the - * variable automatically. When the macro is 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. + * * This is obviously useful for initialized globals (which cannot be extern or similar). + * * This is also used in the log mechanism where a macro creates the variable automatically. When the macro is + * 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) - * * Symbols which must be imported from the DLL, but not explicitly - * exported from it. + * 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 cannot import the parent category - * to deal with the fact that the parent may be in application space, not - * DLL space. + * * The root log category is already exported, but not imported explicitly when creating a subcategory since we + * cannot import the parent category to deal with the fact that the parent may be in application space, not DLL + * space. */ /* 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_PRIVATE - -/* Pack everything up statically */ -#elif defined(DLL_STATIC) -# 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_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(_XBT_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC)) -# 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) +#elif (defined(_WIN32) && !defined(DLL_EXPORT)) +# 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 -#ifdef _MSC_VER /* MSVC has no ssize_t, and I fail to use the SSIZE_T declared in BaseTsd.h */ - #if defined(_WIN64) - typedef __int64 ssize_t; - #else - typedef long ssize_t; - #endif - -/* Microsoft wants to improve the code quality blah blah blah */ -/* See: https://msdn.microsoft.com/en-us/library/8ef0s5kh.aspx */ - /* warning C4996: '_strdup': The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name: _strdup. */ - #define _CRT_NONSTDC_NO_WARNINGS - /* warning C4996: 'fopen': This function or variable may be unsafe. Consider using fopen_s instead. */ - #define _CRT_SECURE_NO_WARNINGS -#endif - -#if !defined (max) && !defined(__cplusplus) -# define max(a,b) (((a) > (b)) ? (a) : (b)) -#endif -#if !defined (min) && !defined(__cplusplus) -# define min(a,b) (((a) < (b)) ? (a) : (b)) -#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++ */