-/* $Id$ */
+/* xbt.h - Public interface to the xbt (simgrid's toolbox) */
-/* xbt.h - Public interface to the xbt (gras's toolbox) */
-
-/* Authors: Martin Quinson */
-/* Copyright (C) 2004 the OURAGAN project. */
+/* 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef XBT_MISC_H
#define XBT_MISC_H
-#define max(a, b) (((a) > (b))?(a):(b))
-#define min(a, b) (((a) < (b))?(a):(b))
+#include <stdarg.h>
-#define TRUE 1
-#define FALSE 0
+#include "simgrid_config.h"
+#include "base.h"
+#include "dynar.h"
-#define XBT_MAX_CHANNEL 10 /* FIXME: killme */
-/*! C++ users need love */
-#ifndef BEGIN_DECL
-# ifdef __cplusplus
-# define BEGIN_DECL extern "C" {
-# else
-# define BEGIN_DECL
-# endif
-#endif
+SG_BEGIN_DECL()
-/*! C++ users need love */
-#ifndef END_DECL
-# ifdef __cplusplus
-# define END_DECL }
-# else
-# define END_DECL
-# endif
-#endif
-/* End of cruft for C++ */
+/** 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;
+
+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);
-BEGIN_DECL
-/* Dunno where to place this: needed by config and amok */
-typedef struct {
- char *name;
- int port;
-} xbt_host_t;
+/** Helps ensuring that the header version (SIMGRID_VERSION_MAJOR and friends) and the 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;
+
+#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
-/* pointer to a function freeing something */
-typedef void (void_f_ppvoid_t)(void**);
-typedef void (void_f_pvoid_t) (void*);
+/** @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);
+/** @} */
-END_DECL
+SG_END_DECL()
-#endif /* XBT_MISC_H */
+#endif /* XBT_MISC_H */