include/xbt/swag.h

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved.                */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /* Warning, this module is done to be efficient and performs tons of
   9    cast and dirty things. So avoid using it unless you really know
  10    what you are doing. */
  11
  12 #ifndef _XBT_SWAG_H
  13 #define _XBT_SWAG_H
  14
  15 #include "xbt/misc.h"
  16 #include "xbt/sysdep.h" /* sizeof */
  17
  18 /**
  19  * @addtogroup XBT_swag
  20  * @brief a O(1) set based on linked lists
  21  *
  22  *  Warning, this module is done to be efficient and performs tons of
  23  *  cast and dirty things. So make sure you know what you are doing while using it.
  24  *  It is basically a fifo but with restrictions so that
  25  *  it can be used as a set. Any operation (add, remove, belongs) is O(1) and
  26  *  no call to malloc/free is done.
  27  *
  28  */
  29
  30 /** @defgroup XBT_swag_type Swag types
  31     @ingroup XBT_swag
  32
  33     Specific set.
  34
  35
  36     These typedefs are public so that the compiler can
  37     do his job but believe me, you don't want to try to play with
  38     those structs directly. Use them as an abstract datatype.
  39 */
  40 /* @{ */
  41 typedef struct xbt_swag_hookup {
  42   void *next;
  43   void *prev;
  44 } s_xbt_swag_hookup_t;
  45 /**< This type should be added to a type that is to be used in a swag.
  46  *
  47  *  Whenever a new object with this struct is created, all fields have
  48  *  to be set to NULL
  49  *
  50  * Here is an example like that :
  51
  52 \code
  53 typedef struct foo {
  54   s_xbt_swag_hookup_t set1_hookup;
  55   s_xbt_swag_hookup_t set2_hookup;
  56
  57   double value;
  58 } s_foo_t, *foo_t;
  59 ...
  60 {
  61   s_foo_t elem;
  62   xbt_swag_t set1=NULL;
  63   xbt_swag_t set2=NULL;
  64
  65   set1 = xbt_swag_new(xbt_swag_offset(elem, set1_hookup));
  66   set2 = xbt_swag_new(xbt_swag_offset(elem, set2_hookup));
  67
  68 }
  69 \endcode
  70 */
  71 typedef s_xbt_swag_hookup_t  *xbt_swag_hookup_t;
  72
  73
  74 typedef struct xbt_swag {
  75   void *head;
  76   void *tail;
  77   size_t offset;
  78   int count;
  79 } s_xbt_swag_t, *xbt_swag_t;
  80 /**< A typical swag */
  81 /* @} */
  82
  83 /** @defgroup XBT_swag_func SWAG functions
  84  *  @ingroup XBT_swag
  85
  86  *  @{
  87  */
  88
  89 XBT_PUBLIC(xbt_swag_t) xbt_swag_new(size_t offset);
  90 XBT_PUBLIC(void) xbt_swag_free(xbt_swag_t swag);
  91 XBT_PUBLIC(void) xbt_swag_init(xbt_swag_t swag, size_t offset);
  92 XBT_PUBLIC(void) xbt_swag_insert(void *obj, xbt_swag_t swag);
  93 XBT_PUBLIC(void) xbt_swag_insert_at_head(void *obj, xbt_swag_t swag);
  94 XBT_PUBLIC(void) xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag);
  95 XBT_PUBLIC(void*) xbt_swag_remove(void *obj, xbt_swag_t swag);
  96 XBT_PUBLIC(void*)xbt_swag_extract(xbt_swag_t swag);
  97 XBT_PUBLIC(int) xbt_swag_size(xbt_swag_t swag);
  98 XBT_PUBLIC(int) xbt_swag_belongs(void *obj, xbt_swag_t swag);
  99
 100 static XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag)
 101 {
 102   return (swag->head);
 103 }
 104
 105 #define xbt_swag_getNext(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->prev)
 106 #define xbt_swag_getPrev(obj,offset) (((xbt_swag_hookup_t)(((char *) (obj)) + (offset)))->next)
 107
 108 /**
 109  * \brief Offset computation
 110  * \arg var a variable of type <tt>struct</tt> something
 111  * \arg field a field of <tt>struct</tt> something
 112  * \return the offset of \a field in <tt>struct</tt> something.
 113  * @hideinitializer
 114  *
 115  * It is very similar to offsetof except that is done at runtime and that
 116  * you have to declare a variable. Why defining such a macro then ?
 117  * Because it is portable...
 118  */
 119 #define xbt_swag_offset(var,field) ((char *)&( (var).field ) - (char *)&(var))
 120 /* @} */
 121
 122 /**
 123  * \defgroup XBT_swag_curs Swag cursor
 124  * @ingroup XBT_swag
 125
 126  * Iterates over the whole swag.
 127  *
 128  * @{ */
 129
 130  /** @brief A simple swag iterator
 131   *  @param obj the indice of the loop
 132   *  @param swag what to iterate over
 133   *  @warning you cannot modify the \a swag while using this loop
 134   *  @hideinitializer */
 135 #define xbt_swag_foreach(obj,swag)                            \
 136    for((obj)=xbt_swag_getFirst((swag));                       \
 137        (obj)!=NULL;                                           \
 138        (obj)=xbt_swag_getNext((obj),(swag)->offset))
 139
 140 /**
 141  * @brief A safe swag iterator
 142  * @param obj the indice of the loop
 143  * @param obj_next the object that is right after (if any) \a obj in the swag
 144  * @param swag what to iterate over
 145  * @hideinitializer
 146
 147     You can safely modify the \a swag while using this loop.
 148     Well, safely... Err. You can remove \a obj without having any
 149     trouble at least.  */
 150
 151 #define xbt_swag_foreach_safe(obj,obj_next,swag)                  \
 152    for((obj)=xbt_swag_getFirst((swag)),                           \
 153        ((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)):  \
 154                  (obj_next=NULL));                                \
 155        (obj)!=NULL;                                               \
 156        (obj)=obj_next,                                            \
 157        ((obj)?(obj_next=xbt_swag_getNext((obj),(swag)->offset)):  \
 158                  (obj_next=NULL))     )
 159 /* @} */
 160
 161 #endif    /* _XBT_SWAG_H */