doc/module-xbt.doc

   1 /** @addtogroup XBT_API
   2  *
   3  *  The XBT functionalities fall into several categories:
   4  *   - Portability support.
   5  *     - \ref XBT_syscall
   6  *   - Grounding features
   7  *     - \ref XBT_log
   8  *     - \ref XBT_error
   9  *     - \ref XBT_config
  10  *   - Data structures
  11  *     - \ref XBT_dynar
  12  *     - \ref XBT_dict
  13  *     - \ref XBT_set
  14  *       Data are associated to both an ID (0(1) search) and a name
  15  *     - \ref XBT_fifo
  16  *     - \ref XBT_swag
  17  *     - \ref XBT_heap
  18  *
  19  *  @{
  20  */
  21
  22
  23 /* *************** *
  24  * * PORTABILITY * *
  25  * *************** */
  26
  27     /** @defgroup XBT_syscall Malloc and friends
  28      *  @brief malloc and associated functions, killing the program on error
  29      */
  30
  31 /* ************* *
  32  * * GROUNDING * *
  33  * ************* */
  34     /** @defgroup XBT_log Logging support
  35      *  @brief A generic logging facility in the spirit of log4j (grounding feature)
  36      *  @{
  37      */
  38
  39         /** \defgroup XBT_log_cats Existing log categories
  40          *  \ingroup XBT_log
  41          *  \brief (automatically extracted)
  42          *
  43          *  This is the list of all existing log categories in SimGrid.
  44          *  This list was automatically extracted from the source code by
  45          *  the src/xbt_log_extract_hierarchy utility.
  46          *
  47          *  You can thus be certain that it is uptodate, but it may somehow
  48          *  lack a final manual touch.
  49          *  Anyway, nothing's perfect ;)
  50          */
  51
  52     /** @} */
  53
  54
  55     /** @defgroup XBT_error Error tracking support
  56      *  @brief A set of macros easing the handling of errors (grounding feature)
  57      */
  58
  59     /** @defgroup XBT_config Configuration support
  60      *  @brief Changing the configuration of SimGrid components (grounding feature)
  61      */
  62
  63 /* **************** *
  64  * * DATA STRUCTS * *
  65  * **************** */
  66     /** @defgroup XBT_dynar A generic dynamic array
  67      *  @brief DynArr are dynamically sized vector which may contain any type of variables.
  68      */
  69
  70     /** @defgroup XBT_dict A generic dictionnary
  71      *  @brief The dictionnary data structure (comparable to hash tables)
  72      */
  73
  74     /** \defgroup XBT_set A generic set datatype
  75      * \brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
  76      */
  77
  78 /**       \addtogroup XBT_fifo
  79           \ingroup XBT_API */
  80
  81     /** @defgroup XBT_swag A O(1) set datatype
  82      *  @brief a O(1) set based on linked lists
  83      */
  84
  85 /**       \addtogroup XBT_heap
  86           \ingroup XBT_API */
  87
  88 /* ************************* *
  89  * * PORTABILITY-INTERNALS * *
  90  * ************************* */
  91
  92  /** \defgroup XBT_context Portable context implementation
  93   *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
  94   *  for non-preemptible threads.
  95   *
  96   *  You shouldn't use it directly since it is merly intended to ease the
  97   *  implementation of the serveral programmation environment of the
  98   *  SimGrid toolkit (nammely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
  99   *
 100   *  You should use those mechanism instead.
 101   */