Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doc improvement
[simgrid.git] / include / xbt / misc.h
index 33f15d0..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
 
-#ifndef max
-#  define max(a, b) (((a) > (b))?(a):(b))
-#endif
-#ifndef min
-#  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 BEGIN_DECL
-# ifdef __cplusplus
-#  define BEGIN_DECL extern "C" {
-# else
-#  define BEGIN_DECL 
-# endif
-#endif
-
-/*! C++ users need love */
-#ifndef END_DECL
-# ifdef __cplusplus
-#  define END_DECL }
-# else
-#  define END_DECL 
-# endif
-#endif
-/* End of cruft for C++ */
-
-BEGIN_DECL
-/* Dunno where to place this: needed by config and amok */
-typedef struct {  
-   char *name;
-   int port;
-} xbt_host_t;
-
-/* pointer to a function freeing something */
-typedef   void (void_f_ppvoid_t)(void**);
-typedef   void (void_f_pvoid_t) (void*);
-
-END_DECL
-
-#endif /* XBT_MISC_H */
+#include <simgrid_config.h>
+#include <xbt/base.h>
+#include <xbt/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 */