include/xbt/misc.h

   1 /* xbt.h - Public interface to the xbt (simgrid's toolbox)                     */
   2
   3 /* Copyright (c) 2004-2014. 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 <stdarg.h>
  13
  14 #include "simgrid_config.h"
  15 #include "base.h"
  16 #include "dynar.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 /** Contains all the parameters we got from the command line */
  33 XBT_PUBLIC_DATA(xbt_dynar_t) sg_cmdline;
  34
  35 #define XBT_BACKTRACE_SIZE 10   /* FIXME: better place? Do document */
  36
  37 /* snprintf related functions */
  38 /** @addtogroup XBT_str
  39   * @{ */
  40 /** @brief print to allocated string (reimplemented when not provided by the system)
  41  *
  42  * The functions asprintf() and vasprintf() are analogues of
  43  * sprintf() and vsprintf(), except that they allocate a string large
  44  * enough to hold the output including the terminating null byte, and
  45  * return a pointer to it via the first parameter.  This pointer
  46  * should be passed to free(3) to release the allocated storage when
  47  * it is no longer needed.
  48  */
  49 #if defined(SIMGRID_NEED_ASPRINTF)||defined(DOXYGEN)
  50 XBT_PUBLIC(int) asprintf(char **ptr, const char *fmt,   /*args */
  51                          ...) _XBT_GNUC_PRINTF(2, 3);
  52 #endif
  53 /** @brief print to allocated string (reimplemented when not provided by the system)
  54  *
  55  * See asprintf()
  56  */
  57 #if defined(SIMGRID_NEED_VASPRINTF)||defined(DOXYGEN)
  58 XBT_PUBLIC(int) vasprintf(char **ptr, const char *fmt, va_list ap);
  59 #endif
  60
  61 /** @brief print to allocated string
  62  *
  63  * Works just like vasprintf(), but returns a pointer to the newly
  64  * created string, or aborts on error.
  65  */
  66 XBT_PUBLIC(char *) bvprintf(const char *fmt, va_list ap);
  67 /** @brief print to allocated string
  68  *
  69  * Works just like asprintf(), but returns a pointer to the newly
  70  * created string, or aborts on error.
  71  */
  72 XBT_PUBLIC(char *) bprintf(const char *fmt, ...) _XBT_GNUC_PRINTF(1, 2);
  73 /** @} */
  74
  75 SG_END_DECL()
  76
  77 #endif                          /* XBT_MISC_H */