X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/023d86f78c882708358c37d7ba9b63aeda514643..41f97f763bc1771fe15e96ffcd4ff3e7c76a9a63:/include/xbt/misc.h diff --git a/include/xbt/misc.h b/include/xbt/misc.h index 256f4ecc3e..c04f2089dc 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-2018. 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,144 +8,42 @@ #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 - -/* - * Function calling convention (not used for now) - */ - -#ifdef _WIN32 -# ifndef _XBT_CALL -# define _XBT_CALL __cdecl -# endif -#else -# define _XBT_CALL -#endif - -/* Handle import/export stuff - * - * Rational of XBT_PUBLIC: - * * If you build the DLL you must pass the right value of XBT_PUBLIC in the project : to do this you must define the DLL_EXPORT macro - * * If you do a static compilation, you must define the macro DLL_STATIC - * * If you link your code against the DLL, this file defines the macro to '__declspec(dllimport)' for you - * * If you compile under unix, this file defines the macro to 'extern', even if it's not mandatory with modern compilers - * - * Rational of XBT_PUBLIC_NO_IMPORT: - * * This is for 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 mecanism 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. - */ - +#include +#include +#include -#ifdef DLL_EXPORT -# define XBT_PUBLIC(type) __declspec(dllexport) type -# define XBT_PUBLIC_NO_IMPORT(type) __declspec(dllexport) type -# define XBT_IMPORT_NO_PUBLIC(type) type -#else -# ifdef DLL_STATIC -# define XBT_PUBLIC(type) type -# define XBT_PUBLIC_NO_IMPORT(type) type -# define XBT_IMPORT_NO_PUBLIC(type) type -# else -# ifdef _WIN32 -# define XBT_PUBLIC(type) __declspec(dllimport) type -# define XBT_PUBLIC_NO_IMPORT(type) type -# define XBT_IMPORT_NO_PUBLIC(type) __declspec(dllimport) type -# else -# define XBT_PUBLIC(type) extern type -# define XBT_PUBLIC_NO_IMPORT(type) type -# define XBT_IMPORT_NO_PUBLIC(type) type -# endif -# endif -#endif - +#include +SG_BEGIN_DECL() +/** Cache the size of a memory page for the current system. */ +XBT_PUBLIC_DATA int xbt_pagesize; -#ifndef max -# define max(a, b) (((a) > (b))?(a):(b)) -#endif -#ifndef min -# define min(a, b) (((a) < (b))?(a):(b)) -#endif +/** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */ +XBT_PUBLIC_DATA int xbt_pagebits; -#define TRUE 1 -#define FALSE 0 +/** 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); -#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 +/** Contains all the parameters we got from the command line */ +XBT_PUBLIC_DATA xbt_dynar_t sg_cmdline; -/*! 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++ */ +/* snprintf related functions */ +/** @addtogroup XBT_str + * @{ */ -SG_BEGIN_DECL() - -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); +/** @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() -#endif /* XBT_MISC_H */ - - - - +#endif /* XBT_MISC_H */