X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b7ca16289c913278988d37c1e2e57bdc93eb16e4..a7cc502f224afb96f0203b94759cd0dabebf8de5:/include/xbt/misc.h diff --git a/include/xbt/misc.h b/include/xbt/misc.h index a49fbf0b31..0c45e62926 100644 --- a/include/xbt/misc.h +++ b/include/xbt/misc.h @@ -1,10 +1,6 @@ -/* $Id$ */ +/* xbt.h - Public interface to the xbt (SimGrid's toolbox) */ -/* xbt.h - Public interface to the xbt (gras's toolbox) */ - -/* Copyright (c) 2004 Martin Quinson. */ -/* Copyright (c) 2004 Arnaud Legrand. */ -/* All rights reserved. */ +/* Copyright (c) 2004-2023. 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. */ @@ -12,130 +8,37 @@ #ifndef XBT_MISC_H #define XBT_MISC_H -/* Attributes are only in recent versions of GCC */ -#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4) -# define _XBT_GNUC_PRINTF( format_idx, arg_idx ) \ - __attribute__((__format__ (__printf__, format_idx, arg_idx))) -# define _XBT_GNUC_SCANF( format_idx, arg_idx ) \ - __attribute__((__format__ (__scanf__, format_idx, arg_idx))) -# define _XBT_GNUC_FORMAT( arg_idx ) \ - __attribute__((__format_arg__ (arg_idx))) -# define _XBT_GNUC_NORETURN __attribute__((__noreturn__)) -# define _XBT_GNUC_UNUSED __attribute__((unused)) - -#else /* !__GNUC__ */ -# define _XBT_GNUC_PRINTF( format_idx, arg_idx ) -# define _XBT_GNUC_SCANF( format_idx, arg_idx ) -# define _XBT_GNUC_FORMAT( arg_idx ) -# define _XBT_GNUC_NORETURN -# define _XBT_GNUC_UNUSED - -#endif /* !__GNUC__ */ - -/* 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_FUNC__ __func__ /* ISO-C99 compliant */ -#else -# define _XBT_FUNCTION "function" -#endif - -#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 -# elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__) -# define XBT_INLINE __inline -# else -# define XBT_INLINE -# endif -# else -# define XBT_INLINE inline -#endif - -/* Windows __declspec(). */ -#if defined(_WIN32) && defined(__BORLANDC__) -# if(__BORLANDC__ < 0x540) -# if (defined (__DLL) || defined (_DLL) || defined (_WINDLL) || defined (_RTLDLL) || defined (_XBT_USE_DYNAMIC_LIB) ) && ! defined (_XBT_USE_STAT -# undef _XBT_USE_DECLSPEC -# define _XBT_USE_DECLSPEC -# endif -# else -# if ( defined (__DLL) || defined (_DLL) || defined (_WINDLL) || defined (_RTLDLL) || defined(_AFXDLL) || defined (_XBT_USE_DYNAMIC_LIB) ) -# undef _XBT_USE_DECLSPEC -# define _XBT_USE_DECLSPEC 1 -# endif -# endif -#endif - -#if defined (_XBT_USE_DECLSPEC) /* using export/import technique */ - -# ifndef _XBT_EXPORT_DECLSPEC -# define _XBT_EXPORT_DECLSPEC -# endif - -# ifndef _XBT_IMPORT_DECLSPEC -# define _XBT_IMPORT_DECLSPEC -# endif - -# if defined (_XBT_DESIGNATED_DLL) /* this is a lib which will contain xbt exports */ -# define XBT_PUBLIC _XBT_EXPORT_DECLSPEC -# else -# define XBT_PUBLIC _XBT_IMPORT_DECLSPEC /* other modules, importing xbt exports */ -# endif - -#else /* not using DLL export/import specifications */ - -# define XBT_PUBLIC - -#endif /* #if defined (_XBT_USE_DECLSPEC) */ - -/* Function calling convention (not used for now) */ -#if !defined (_XBT_CALL) -#define _XBT_CALL -#endif - +#include +#include -#ifndef max -# define max(a, b) (((a) > (b))?(a):(b)) -#endif -#ifndef min -# define min(a, b) (((a) < (b))?(a):(b)) -#endif +SG_BEGIN_DECL -#define TRUE 1 -#define FALSE 0 +/** Cache the size of a memory page for the current system. */ +XBT_PUBLIC_DATA const int xbt_pagesize; -#define XBT_MAX_CHANNEL 10 /* FIXME: killme */ -/*! C++ users need love */ -#ifndef SG_BEGIN_DECL -# ifdef __cplusplus -# define SG_BEGIN_DECL() extern "C" { -# else -# define SG_BEGIN_DECL() -# endif -#endif +/** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */ +XBT_PUBLIC_DATA const int xbt_pagebits; -/*! C++ users need love */ -#ifndef SG_END_DECL -# ifdef __cplusplus -# define SG_END_DECL() } -# else -# define SG_END_DECL() -# endif -#endif -/* End of cruft for C++ */ +/** Helps ensuring that header version (SIMGRID_VERSION_MAJOR and friends) and dynamic library version do match. */ +XBT_PUBLIC void sg_version_check(int lib_version_major, int lib_version_minor, int lib_version_patch); -SG_BEGIN_DECL() +/* snprintf related functions */ +/** @addtogroup XBT_str + * @{ */ -XBT_PUBLIC const char *xbt_procname(void); +/** @brief print to allocated string + * + * Similar to vasprintf(), but returns a pointer to the newly created string (or aborts on error). + */ +XBT_PUBLIC char* bvprintf(const char* fmt, va_list ap) XBT_ATTRIB_PRINTF(1, 0); +/** @brief print to allocated string + * + * Similar to asprintf(), but returns a pointer to the newly created string (or aborts on error). + */ +XBT_PUBLIC char* bprintf(const char* fmt, ...) XBT_ATTRIB_PRINTF(1, 2); +/** @} */ -#define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */ - -SG_END_DECL() +SG_END_DECL -#endif /* XBT_MISC_H */ +#endif /* XBT_MISC_H */