-/* $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-2014. 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. */
#ifndef XBT_MISC_H
#define XBT_MISC_H
+#include <stdarg.h>
+
+#include "simgrid_config.h"
+
+/* Define _GNU_SOURCE for getline, isfinite, etc. */
+#ifndef _GNU_SOURCE
+ #define _GNU_SOURCE
+#endif
+
/* Attributes are only in recent versions of GCC */
-#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
+#if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4))
# define _XBT_GNUC_PRINTF( format_idx, arg_idx ) \
- __attribute__((__format__ (__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)))
+ __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
# define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
-# define _XBT_GNUC_UNUSED __attribute__((unused))
+# define _XBT_GNUC_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
-#else /* !__GNUC__ */
+#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
+# define _XBT_GNUC_CONSTRUCTOR(prio)
+# define _XBT_GNUC_DESTRUCTOR(prio)
+# define _XBT_NEED_INIT_PRAGMA 1
-#endif /* !__GNUC__ */
+#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 */
+# define _XBT_FUNCTION __func__ /* ISO-C99 compliant */
#else
# define _XBT_FUNCTION "function"
#endif
-#ifndef __cplusplus
+#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)
# else
# define XBT_INLINE
# endif
-# else
-# define XBT_INLINE inline
+# else
+# if defined (__VISUALC__)
+# define XBT_INLINE __inline
+# else
+# define XBT_INLINE inline
+# endif
+# endif /* __cplusplus */
+#endif
+
+/* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */
+#ifdef MIN
+# undef MIN
#endif
+#define MIN(a,b) ((a)<(b)?(a):(b))
+
+#ifdef MAX
+# undef MAX
+#endif
+#define MAX(a,b) ((a)>(b)?(a):(b))
+
+/*
+ * 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.
+ */
+#define _XBT_IF_ONE_ARG(one, more, ...) \
+ _XBT_IF_ONE_ARG_(__VA_ARGS__, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, more, \
+ more, more, more, more, more, more, more, one)
+#define _XBT_IF_ONE_ARG_(a64, a63, a62, a61, a60, a59, a58, a57, \
+ a56, a55, a54, a53, a52, a51, a50, a49, \
+ a48, a47, a46, a45, a44, a43, a42, a41, \
+ a40, a39, a38, a37, a36, a35, a34, a33, \
+ a32, a31, a30, a29, a28, a27, a26, a25, \
+ a24, a23, a22, a21, a20, a19, a18, a17, \
+ 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)
*/
-
-#ifdef _WIN32
+
+#ifdef _XBT_WIN32
# ifndef _XBT_CALL
# define _XBT_CALL __cdecl
# endif
-#else
+#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
+ * * 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).
+ *
+ * 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 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 cruft)
+ * * 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.
*
- * 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.
+ * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)
+ * * Symbols which must be imported from the DLL, but not explicitely
+ * exported from it.
+ *
+ * * The root log category is already exported, but not imported explicitely
+ * 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) extern __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)
+
-#ifdef DLL_EXPORT
-# define XBT_PUBLIC(type) __declspec(dllexport) type
-# define XBT_PUBLIC_NO_IMPORT(type) __declspec(dllexport) type
+/* Pack everything up statically */
+#elif defined(DLL_STATIC)
+# define XBT_PUBLIC(type) extern 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
+
+
+/* Link against the DLL */
+#elif (defined(_XBT_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))
+# define XBT_PUBLIC(type) extern __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)
+
+
+/* UNIX build */
#else
-# ifdef DLL_STATIC
-# define XBT_PUBLIC(type) type
-# define XBT_PUBLIC_NO_IMPORT(type) type
-# else
-# ifdef _WIN32
-# define XBT_PUBLIC(type) __declspec(dllimport) type
-# define XBT_PUBLIC_NO_IMPORT(type) type
-# else
-# define XBT_PUBLIC(type) extern type
-# define XBT_PUBLIC_NO_IMPORT(type) type
-# endif
-# endif
-#endif
-
+# define XBT_PUBLIC(type) extern 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
+#endif
+#ifdef _XBT_WIN32
+#define XBT_INTERNAL
+#else
+#define XBT_INTERNAL __attribute__((visibility ("hidden")))
+#endif
-#ifndef max
-# define max(a, b) (((a) > (b))?(a):(b))
+#if !defined (max) && !defined(__cplusplus)
+# define max(a,b) (((a) > (b)) ? (a) : (b))
#endif
-#ifndef min
-# define min(a, b) (((a) < (b))?(a):(b))
+#if !defined (min) && !defined(__cplusplus)
+# define min(a,b) (((a) < (b)) ? (a) : (b))
#endif
#define TRUE 1
#define FALSE 0
-#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()
+# define SG_BEGIN_DECL()
# endif
#endif
-/*! C++ users need love */
#ifndef SG_END_DECL
# ifdef __cplusplus
# define SG_END_DECL() }
# else
-# define SG_END_DECL()
+# define SG_END_DECL()
# endif
#endif
/* End of cruft for C++ */
SG_BEGIN_DECL()
-XBT_PUBLIC(const char *)xbt_procname(void);
+/** Cache the size of a memory page for the current system. */
+XBT_PUBLIC_DATA(int) xbt_pagesize;
-#define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
-
-SG_END_DECL()
+/** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */
+XBT_PUBLIC_DATA(int) xbt_pagebits;
-#endif /* XBT_MISC_H */
+XBT_PUBLIC(const char *) xbt_procname(void);
+/** Retrieves the version numbers of the used dynamic library (so, DLL or dynlib) , while
+ SIMGRID_VERSION_MAJOR and friends give the version numbers of the used header files */
+XBT_PUBLIC(void) sg_version(int *major,int *minor,int *patch);
+typedef struct xbt_dynar_s s_xbt_dynar_t, *xbt_dynar_t;
+/** Contains all the parameters we got from the command line */
+XBT_PUBLIC_DATA(xbt_dynar_t) sg_cmdline;
+
+#define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
+
+/* snprintf related functions */
+/** @addtogroup XBT_str
+ * @{ */
+/** @brief print to allocated string (reimplemented when not provided by the system)
+ *
+ * The functions asprintf() and vasprintf() are analogues of
+ * sprintf() and vsprintf(), except that they allocate a string large
+ * enough to hold the output including the terminating null byte, and
+ * return a pointer to it via the first parameter. This pointer
+ * should be passed to free(3) to release the allocated storage when
+ * it is no longer needed.
+ */
+#if defined(SIMGRID_NEED_ASPRINTF)||defined(DOXYGEN)
+XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt, /*args */
+ ...) _XBT_GNUC_PRINTF(2, 3);
+#endif
+/** @brief print to allocated string (reimplemented when not provided by the system)
+ *
+ * See asprintf()
+ */
+#if defined(SIMGRID_NEED_VASPRINTF)||defined(DOXYGEN)
+XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
+#endif
+
+/** @brief print to allocated string
+ *
+ * Works just like 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
+ *
+ * Works just like asprintf(), but returns a pointer to the newly
+ * created string, or aborts on error.
+ */
+XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
+/** @} */
+
+SG_END_DECL()
+#endif /* XBT_MISC_H */
