Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / include / xbt / misc.h
index 0ec724c..dc19d77 100644 (file)
@@ -1,10 +1,7 @@
-/* $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-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
 
-#ifndef max
-#  define max(a, b) (((a) > (b))?(a):(b))
-#endif
-#ifndef min
-#  define min(a, b) (((a) < (b))?(a):(b))
-#endif
+#include "simgrid_config.h"
+#include "base.h"
+#include "dynar.h"
 
-#define TRUE  1
-#define FALSE 0
+#include <stdarg.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;
 
-BEGIN_DECL
-/* Dunno where to place this: needed by config and amok */
-typedef struct {  
-   char *name;
-   int port;
-} xbt_host_t;
+/** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */
+XBT_PUBLIC_DATA(int) xbt_pagebits;
 
-/* pointer to a function freeing something */
-typedef   void (void_f_ppvoid_t)(void**);
-typedef   void (void_f_pvoid_t) (void*);
+/** 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);
 
-/* The following two definitions concern the type of the keys used for
-   the heaps. That should be handled via configure (FIXME). */
-typedef long double xbt_heap_float_t;
-#define XBT_HEAP_FLOAT_T "%Lg" /* for printing purposes */
+/** Contains all the parameters we got from the command line */
+XBT_PUBLIC_DATA(xbt_dynar_t) sg_cmdline;
 
-typedef long double xbt_maxmin_float_t;
-#define XBT_MAXMIN_FLOAT_T "%Lg"       /* for printing purposes */
+/* 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);
+/** @} */
 
-END_DECL
+SG_END_DECL()
 
-#endif /* XBT_MISC_H */
+#endif                          /* XBT_MISC_H */