src/xbt/swag.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 /* Warning, this module is done to be efficient and performs tons of
   8    cast and dirty things. So avoid using it unless you really know
   9    what you are doing. */
  10
  11 /* This type should be added to a type that is to be used in such a swag */
  12
  13 #include "xbt/sysdep.h"
  14 #include "xbt/log.h"
  15 #include "xbt/swag.h"
  16
  17
  18 /** Creates a new swag.
  19  * \param offset where the hookup is located in the structure
  20  * \see xbt_swag_offset
  21  *
  22  * Usage : xbt_swag_new(&obj.setA-&obj);
  23  */
  24 XBT_INLINE xbt_swag_t xbt_swag_new(size_t offset)
  25 {
  26   xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
  27
  28   xbt_swag_init(swag, offset);
  29
  30   return swag;
  31 }
  32
  33 /**
  34  * \param swag poor victim
  35  *
  36  * kilkil a swag but not it's content. If you do not understand why
  37  * xbt_swag_free should not free its content, don't use swags.
  38  */
  39 XBT_INLINE void xbt_swag_free(xbt_swag_t swag)
  40 {
  41   free(swag);
  42 }
  43
  44 /** Creates a new swag.
  45  * \param swag the swag to initialize
  46  * \param offset where the hookup is located in the structure
  47  * \see xbt_swag_offset
  48  *
  49  * Usage : xbt_swag_init(swag,&obj.setA-&obj);
  50  */
  51 XBT_INLINE void xbt_swag_init(xbt_swag_t swag, size_t offset)
  52 {
  53   swag->tail = NULL;
  54   swag->head = NULL;
  55   swag->offset = offset;
  56   swag->count = 0;
  57 }
  58
  59 /**
  60  * \param obj the objet to insert in the swag
  61  * \param swag a swag
  62  *
  63  * insert (at the head... you probably had a very good reason to do
  64  * that, I hope you know what you're doing) \a obj in \a swag
  65  */
  66 XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
  67 {
  68   xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
  69       "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
  70
  71   if (!swag->head) {
  72     xbt_assert(!(swag->tail), "Inconsistent swag.");
  73     swag->head = obj;
  74     swag->tail = obj;
  75     swag->count++;
  76   }
  77   else if (obj != swag->head && !xbt_swag_getPrev(obj, swag->offset)) {
  78     xbt_swag_getNext(obj, swag->offset) = swag->head;
  79     xbt_swag_getPrev(swag->head, swag->offset) = obj;
  80     swag->head = obj;
  81     swag->count++;
  82   }
  83 }
  84
  85 /**
  86  * \param obj the objet to insert in the swag
  87  * \param swag a swag
  88  *
  89  * insert (at the tail... you probably had a very good reason to do
  90  * that, I hope you know what you're doing) \a obj in \a swag
  91  */
  92 XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
  93 {
  94   xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
  95       "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
  96
  97   if (!swag->head) {
  98     xbt_assert(!(swag->tail), "Inconsistent swag.");
  99     swag->head = obj;
 100     swag->tail = obj;
 101     swag->count++;
 102   }
 103   else if (obj != swag->tail && !xbt_swag_getNext(obj, swag->offset)) {
 104     xbt_swag_getPrev(obj, swag->offset) = swag->tail;
 105     xbt_swag_getNext(swag->tail, swag->offset) = obj;
 106     swag->tail = obj;
 107     swag->count++;
 108   }
 109 }
 110
 111 /**
 112  * \param obj the objet to remove from the swag
 113  * \param swag a swag
 114  * \return \a obj if it was in the \a swag and NULL otherwise
 115  *
 116  * removes \a obj from \a swag
 117  */
 118 XBT_INLINE void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 119 {
 120   if (!obj)
 121     return NULL;
 122
 123   size_t offset = swag->offset;
 124   void* prev = xbt_swag_getPrev(obj, offset);
 125   void* next = xbt_swag_getNext(obj, offset);
 126
 127   if (prev) {
 128     xbt_swag_getNext(prev, offset) = next;
 129     xbt_swag_getPrev(obj, offset) = NULL;
 130     if (next) {
 131       xbt_swag_getPrev(next, offset) = prev;
 132       xbt_swag_getNext(obj, offset) = NULL;
 133     }
 134     else {
 135       swag->tail = prev;
 136     }
 137     swag->count--;
 138   }
 139   else if (next) {
 140     xbt_swag_getPrev(next, offset) = NULL;
 141     xbt_swag_getNext(obj, offset) = NULL;
 142     swag->head = next;
 143     swag->count--;
 144   }
 145   else if (obj == swag->head) {
 146     swag->head = swag->tail = NULL;
 147     swag->count--;
 148   }
 149
 150   return obj;
 151 }
 152
 153 /**
 154  * \param swag a swag
 155  * \return an object from the \a swag
 156  */
 157 void *xbt_swag_extract(xbt_swag_t swag)
 158 {
 159   if (!swag->head)
 160     return NULL;
 161
 162   size_t offset = swag->offset;
 163   void* obj = swag->head;
 164
 165   if (obj == swag->tail) {       /* special case */
 166     swag->head = swag->tail = NULL;
 167   } else {
 168     swag->head = xbt_swag_getNext(obj, offset);
 169     xbt_swag_getPrev(swag->head, offset) = NULL;
 170     xbt_swag_getNext(obj, offset) = NULL;
 171   }
 172   (swag->count)--;
 173
 174   return obj;
 175 }
 176
 177 /**
 178  * \param swag a swag
 179  * \return the number of objects in \a swag
 180  */
 181 XBT_INLINE int xbt_swag_size(xbt_swag_t swag)
 182 {
 183   return (swag->count);
 184 }
 185
 186
 187 #ifdef SIMGRID_TEST
 188
 189 XBT_TEST_SUITE("swag", "Swag data container");
 190
 191 typedef struct {
 192   s_xbt_swag_hookup_t setA;
 193   s_xbt_swag_hookup_t setB;
 194   const char *name;
 195 } shmurtz, s_shmurtz_t, *shmurtz_t;
 196
 197
 198 XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
 199 {
 200   shmurtz_t obj1, obj2, obj;
 201   xbt_swag_t setA, setB;
 202
 203   obj1 = xbt_new0(s_shmurtz_t, 1);
 204   obj2 = xbt_new0(s_shmurtz_t, 1);
 205
 206   obj1->name = "Obj 1";
 207   obj2->name = "Obj 2";
 208
 209   xbt_test_add("Basic usage");
 210   xbt_test_log("%p %p %ld\n", obj1, &(obj1->setB),
 211                 (long) ((char *) &(obj1->setB) - (char *) obj1));
 212
 213   setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
 214   setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
 215
 216   xbt_swag_insert(obj1, setA);
 217   xbt_swag_insert(obj1, setB);
 218   xbt_swag_insert(obj2, setA);
 219   xbt_swag_insert(obj2, setB);
 220
 221   xbt_test_assert(xbt_swag_remove(NULL, setB) == NULL);
 222   xbt_test_assert(xbt_swag_remove(obj1, setB) == obj1);
 223   /*  xbt_test_assert(xbt_swag_remove(obj2, setB) == obj2); */
 224
 225   xbt_test_add("Traverse set A");
 226   xbt_swag_foreach(obj, setA) {
 227     xbt_test_log("Saw: %s", obj->name);
 228   }
 229
 230   xbt_test_add("Traverse set B");
 231   xbt_swag_foreach(obj, setB) {
 232     xbt_test_log("Saw: %s", obj->name);
 233   }
 234
 235   xbt_test_add("Ensure set content and length");
 236   xbt_test_assert(xbt_swag_belongs(obj1, setA));
 237   xbt_test_assert(xbt_swag_belongs(obj2, setA));
 238
 239   xbt_test_assert(!xbt_swag_belongs(obj1, setB));
 240   xbt_test_assert(xbt_swag_belongs(obj2, setB));
 241
 242   xbt_test_assert(xbt_swag_size(setA) == 2);
 243   xbt_test_assert(xbt_swag_size(setB) == 1);
 244
 245   xbt_swag_free(setA);
 246   xbt_swag_free(setB);
 247
 248   xbt_free(obj1);
 249   xbt_free(obj2);
 250 }
 251
 252 #endif                          /* SIMGRID_TEST */