include/xbt/misc.h

   1 /* xbt.h - Public interface to the xbt (simgrid's toolbox)                     */
   2
   3 /* Copyright (c) 2004-2015. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef XBT_MISC_H
  10 #define XBT_MISC_H
  11
  12 #include "simgrid_config.h"
  13 #include "base.h"
  14 #include "dynar.h"
  15
  16 #include <stdarg.h>
  17
  18 SG_BEGIN_DECL()
  19
  20 /** Cache the size of a memory page for the current system. */
  21 XBT_PUBLIC_DATA(int) xbt_pagesize;
  22
  23 /** Cache the number of bits of addresses inside a given page, log2(xbt_pagesize). */
  24 XBT_PUBLIC_DATA(int) xbt_pagebits;
  25
  26 XBT_PUBLIC(const char *) xbt_procname(void);
  27
  28 /** Retrieves the version numbers of the used dynamic library (so, DLL or dynlib) , while
  29     SIMGRID_VERSION_MAJOR and friends give the version numbers of the used header files */
  30 XBT_PUBLIC(void) sg_version(int *major,int *minor,int *patch);
  31
  32 /** Helps ensuring that header version (SIMGRID_VERSION_MAJOR and friends) and dynamic library version do match. */
  33 XBT_PUBLIC(void) sg_version_check(int lib_version_major,int lib_version_minor,int lib_version_patch);
  34
  35 /** Contains all the parameters we got from the command line */
  36 XBT_PUBLIC_DATA(xbt_dynar_t) sg_cmdline;
  37
  38 /* snprintf related functions */
  39 /** @addtogroup XBT_str
  40   * @{ */
  41
  42 /** @brief print to allocated string
  43  *
  44  * Similar to vasprintf(), but returns a pointer to the newly created string (or aborts on error).
  45  */
  46 XBT_PUBLIC(char *) bvprintf(const char *fmt, va_list ap);
  47 /** @brief print to allocated string
  48  *
  49  * Similar to asprintf(), but returns a pointer to the newly created string (or aborts on error).
  50  */
  51 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) XBT_ATTRIB_PRINTF(1, 2);
  52 /** @} */
  53
  54 SG_END_DECL()
  55
  56 #endif                          /* XBT_MISC_H */