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