Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
move a symbol decl to a better header file
[simgrid.git] / include / xbt / misc.h
index 9964ea6..dc19d77 100644 (file)
-/* xbt.h - Public interface to the xbt (gras's toolbox)                     */\r
-/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.\r
- * All rights reserved.                                                     */\r
-\r
-/* This program is free software; you can redistribute it and/or modify it\r
- * under the terms of the license (GNU LGPL) which comes with this package. */\r
-\r
-#include "gras_config.h"\r
-\r
-#ifndef XBT_MISC_H\r
-#define XBT_MISC_H\r
-\r
-/* Attributes are only in recent versions of GCC */\r
-#if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4))\r
-# define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \\r
-          __attribute__((__format__ (__printf__, format_idx, arg_idx)))\r
-# define _XBT_GNUC_SCANF( format_idx, arg_idx )     \\r
-              __attribute__((__format__ (__scanf__, format_idx, arg_idx)))\r
-# define _XBT_GNUC_FORMAT( arg_idx )                \\r
-                  __attribute__((__format_arg__ (arg_idx)))\r
-# define _XBT_GNUC_NORETURN __attribute__((__noreturn__))\r
-# define _XBT_GNUC_UNUSED  __attribute__((unused))\r
-# define _XBT_GNUC_CONSTRUCTOR __attribute__((__constructor__))\r
-# define _XBT_GNUC_DESTRUCTOR __attribute__((__destructor__))\r
-# undef _XBT_NEED_INIT_PRAGMA\r
-\r
-#else /* !__GNUC__ */\r
-# define _XBT_GNUC_PRINTF( format_idx, arg_idx )\r
-# define _XBT_GNUC_SCANF( format_idx, arg_idx )\r
-# define _XBT_GNUC_FORMAT( arg_idx )\r
-# define _XBT_GNUC_NORETURN\r
-# define _XBT_GNUC_UNUSED\r
-# define _XBT_GNUC_CONSTRUCTOR\r
-# define _XBT_GNUC_DESTRUCTOR\r
-# define  _XBT_NEED_INIT_PRAGMA 1\r
-\r
-#endif /* !__GNUC__ */\r
-\r
-/* inline and __FUNCTION__ are only in GCC when -ansi is off */\r
-\r
-#if defined(__GNUC__) && ! defined(__STRICT_ANSI__)\r
-# define _XBT_FUNCTION __FUNCTION__\r
-#elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)\r
-# define _XBT_FUNC__ __func__   /* ISO-C99 compliant */\r
-#else\r
-# define _XBT_FUNCTION "function"\r
-#endif\r
-\r
-#ifndef __cplusplus\r
-#    if defined(__GNUC__) && ! defined(__STRICT_ANSI__)\r
-#        define XBT_INLINE inline\r
-#    elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)\r
-#        define XBT_INLINE inline\r
-#    elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__)\r
-#        define XBT_INLINE __inline\r
-#    else\r
-#        define XBT_INLINE\r
-#    endif\r
-# else\r
-#    define XBT_INLINE  inline\r
-#endif\r
-\r
-/* improvable on gcc (by evaluating arguments only once), but wouldn't be portable */\r
-#ifdef MIN\r
-# undef MIN\r
-#endif\r
-#define MIN(a,b) ((a)<(b)?(a):(b))\r
-\r
-#ifdef MAX\r
-# undef MAX\r
-#endif\r
-#define MAX(a,b) ((a)>(b)?(a):(b))\r
-\r
-\r
-/* \r
- * Function calling convention (not used for now) \r
- */\r
-\r
-#ifdef _WIN32\r
-#  ifndef _XBT_CALL\r
-#    define _XBT_CALL __cdecl\r
-#   endif\r
-#else\r
-#  define _XBT_CALL\r
-#endif\r
-\r
-/* Handle import/export stuff\r
- * \r
- * Rational of XBT_PUBLIC: \r
- *   * This is for library symbols visible from the application-land.\r
- *     Basically, any symbols defined in the include/directory must be \r
- *     like this (plus some other globals). \r
- *\r
- *     UNIX coders should just think of it as a special way to say "extern".\r
- *\r
- *   * If you build the DLL, define the DLL_EXPORT symbol so that all symbols\r
- *     actually get exported by this file.\r
-\r
- *   * If you do a static windows compilation, define DLL_STATIC, both when\r
- *     compiling the application files and when compiling the library.\r
- *\r
- *   * If you link your application against the DLL or if you do a UNIX build,\r
- *     don't do anything special. This file will do the right thing for you \r
- *     by default.\r
- *\r
- * \r
- * Rational of XBT_EXPORT_NO_IMPORT: (windows-only cruft)\r
- *   * Symbols which must be exported in the DLL, but not imported from it.\r
- * \r
- *   * This is obviously useful for initialized globals (which cannot be \r
- *     extern or similar).\r
- *   * This is also used in the log mecanism where a macro creates the \r
- *     variable automatically. When the macro is called from within SimGrid,\r
- *     the symbol must be exported, but when called  from within the client\r
- *     code, it must not try to retrieve the symbol from the DLL since it's\r
- *      not in there.\r
- * \r
- * Rational of XBT_IMPORT_NO_EXPORT: (windows-only cruft)\r
- *   * Symbols which must be imported from the DLL, but not explicitely \r
- *     exported from it.\r
- * \r
- *   * The root log category is already exported, but not imported explicitely \r
- *     when creating a subcategory since we cannot import the parent category \r
- *     to deal with the fact that the parent may be in application space, not \r
- *     DLL space.\r
- */\r
-\r
-\r
-/* Build the DLL */\r
-#if defined(DLL_EXPORT)\r
-#  define XBT_PUBLIC(type)            __declspec(dllexport) type\r
-#  define XBT_EXPORT_NO_IMPORT(type)  __declspec(dllexport) type\r
-#  define XBT_IMPORT_NO_EXPORT(type)  type\r
-#  define XBT_PUBLIC_DATA(type)              __declspec(dllexport) type\r
-\r
-/* Pack everything up statically */\r
-#elif defined(DLL_STATIC)\r
-#  define XBT_PUBLIC(type)           extern type\r
-#  define XBT_EXPORT_NO_IMPORT(type)  type\r
-#  define XBT_IMPORT_NO_EXPORT(type)  type\r
-#  define XBT_PUBLIC_DATA(type)       extern type\r
-\r
-\r
-/* Link against the DLL */\r
-#elif (defined(_WIN32) && !defined(DLL_EXPORT) && !defined(DLL_STATIC))\r
-#  define XBT_PUBLIC(type)             type\r
-#  define XBT_EXPORT_NO_IMPORT(type)   type\r
-#  define XBT_IMPORT_NO_EXPORT(type)   __declspec(dllimport) type\r
-#  define XBT_PUBLIC_DATA(type)                __declspec(dllimport) type\r
-\r
-/* UNIX build */\r
-#else\r
-#  define XBT_PUBLIC(type)            extern type\r
-#  define XBT_EXPORT_NO_IMPORT(type)  type\r
-#  define XBT_IMPORT_NO_EXPORT(type)  type\r
-#  define XBT_PUBLIC_DATA(type)       extern type\r
-#endif\r
-\r
-#if !defined (max) && !defined(__cplusplus)\r
-#  define max(a,b)     (((a) > (b)) ? (a) : (b))\r
-#endif\r
-#if !defined (min) && !defined(__cplusplus)\r
-#  define min(a,b)     (((a) < (b)) ? (a) : (b))\r
-#endif\r
-\r
-#define TRUE  1\r
-#define FALSE 0\r
-\r
-#define XBT_MAX_CHANNEL 10      /* FIXME: killme */\r
-/*! C++ users need love */\r
-#ifndef SG_BEGIN_DECL\r
-# ifdef __cplusplus\r
-#  define SG_BEGIN_DECL() extern "C" {\r
-# else\r
-#  define SG_BEGIN_DECL()\r
-# endif\r
-#endif\r
-\r
-#ifndef SG_END_DECL\r
-# ifdef __cplusplus\r
-#  define SG_END_DECL() }\r
-# else\r
-#  define SG_END_DECL()\r
-# endif\r
-#endif\r
-/* End of cruft for C++ */\r
-\r
-SG_BEGIN_DECL()\r
-\r
-XBT_PUBLIC(const char *) xbt_procname(void);\r
-\r
-#define XBT_BACKTRACE_SIZE 10   /* FIXME: better place? Do document */\r
-\r
-SG_END_DECL()\r
-#endif /* XBT_MISC_H */\r
+/* xbt.h - Public interface to the xbt (simgrid's toolbox)                     */
+
+/* Copyright (c) 2004-2015. 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 "simgrid_config.h"
+#include "base.h"
+#include "dynar.h"
+
+#include <stdarg.h>
+
+SG_BEGIN_DECL()
+
+/** Cache the size of a memory page for the current system. */
+XBT_PUBLIC_DATA(int) xbt_pagesize;
+
+/** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */
+XBT_PUBLIC_DATA(int) xbt_pagebits;
+
+/** 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);
+
+/** Contains all the parameters we got from the command line */
+XBT_PUBLIC_DATA(xbt_dynar_t) sg_cmdline;
+
+/* snprintf related functions */
+/** @addtogroup XBT_str
+  * @{ */
+
+/** @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);
+/** @} */
+
+SG_END_DECL()
+
+#endif                          /* XBT_MISC_H */