Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mv link map to the engine
[simgrid.git] / include / xbt / misc.h
index 1e8f77f..c04f208 100644 (file)
@@ -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. */
 #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__ */
+#include <simgrid_config.h>
+#include <xbt/base.h>
+#include <xbt/dynar.h>
 
-/* inline and __FUNCTION__ are only in GCC when -ansi is off */
-
-#if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
-# define _XBT_FUNCTION __FUNCTION__
-# define XBT_INLINE inline
-#elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
-# define _XBT_FUNC__ __func__      /* ISO-C99 compliant */
-# define XBT_INLINE inline
-#else
-# define _XBT_FUNCTION "function"
-# define XBT_INLINE 
-#endif
+#include <stdarg.h>
 
+SG_BEGIN_DECL()
 
-#ifndef max
-#  define max(a, b) (((a) > (b))?(a):(b))
-#endif
-#ifndef min
-#  define min(a, b) (((a) < (b))?(a):(b))
-#endif
+/** Cache the size of a memory page for the current system. */
+XBT_PUBLIC_DATA int xbt_pagesize;
 
-#define TRUE  1
-#define FALSE 0
+/** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */
+XBT_PUBLIC_DATA int xbt_pagebits;
 
-#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
+/** 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);
 
-/*! 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++ */
+/** Contains all the parameters we got from the command line */
+XBT_PUBLIC_DATA xbt_dynar_t sg_cmdline;
 
-SG_BEGIN_DECL()
+/* snprintf related functions */
+/** @addtogroup XBT_str
+  * @{ */
 
-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 */