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 /**
  61  * \param obj the objet to insert in the swag
  62  * \param swag a swag
  63  *
  64  * insert \a obj in \a swag
  65  */
  66 XBT_INLINE void xbt_swag_insert(void *obj, xbt_swag_t swag)
  67 {
  68
  69   if (xbt_swag_belongs(obj, swag))
  70     return;
  71
  72   (swag->count)++;
  73   if (swag->head == NULL) {
  74     xbt_assert0(!(swag->tail), "Inconsistent swag.");
  75     swag->head = obj;
  76     swag->tail = obj;
  77     return;
  78   }
  79
  80   xbt_swag_getPrev(obj, swag->offset) = swag->tail;
  81   xbt_swag_getNext(xbt_swag_getPrev(obj, swag->offset), swag->offset) =
  82       obj;
  83
  84   swag->tail = obj;
  85 }
  86
  87 /**
  88  * \param obj the objet to insert in the swag
  89  * \param swag a swag
  90  *
  91  * insert (at the head... you probably had a very good reason to do
  92  * that, I hope you know what you're doing) \a obj in \a swag
  93  */
  94 XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
  95 {
  96
  97   if (xbt_swag_belongs(obj, swag))
  98     return;
  99
 100   (swag->count)++;
 101   if (swag->head == NULL) {
 102     xbt_assert0(!(swag->tail), "Inconsistent swag.");
 103     swag->head = obj;
 104     swag->tail = obj;
 105     return;
 106   }
 107
 108   xbt_swag_getNext(obj, swag->offset) = swag->head;
 109   xbt_swag_getPrev(xbt_swag_getNext(obj, swag->offset), swag->offset) =
 110       obj;
 111
 112   swag->head = obj;
 113 }
 114
 115 /**
 116  * \param obj the objet to insert in the swag
 117  * \param swag a swag
 118  *
 119  * insert (at the tail... you probably had a very good reason to do
 120  * that, I hope you know what you're doing) \a obj in \a swag
 121  */
 122 XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
 123 {
 124
 125   if (xbt_swag_belongs(obj, swag))
 126     return;
 127
 128   (swag->count)++;
 129   if (swag->head == NULL) {
 130     xbt_assert0(!(swag->tail), "Inconsistent swag.");
 131     swag->head = obj;
 132     swag->tail = obj;
 133     return;
 134   }
 135
 136   xbt_swag_getPrev(obj, swag->offset) = swag->tail;
 137   xbt_swag_getNext(xbt_swag_getPrev(obj, swag->offset), swag->offset) =
 138       obj;
 139
 140   swag->tail = obj;
 141 }
 142
 143 /**
 144  * \param obj the objet to remove from the swag
 145  * \param swag a swag
 146  * \return \a obj if it was in the \a swag and NULL otherwise
 147  *
 148  * removes \a obj from \a swag
 149  */
 150 XBT_INLINE void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 151 {
 152   size_t offset = swag->offset;
 153
 154   if ((!obj) || (!swag))
 155     return NULL;
 156   if (!xbt_swag_belongs(obj, swag))     /* Trying to remove an object that
 157                                            was not in this swag */
 158     return NULL;
 159
 160   if (swag->head == swag->tail) {       /* special case */
 161     if (swag->head != obj)      /* Trying to remove an object that was not in this swag */
 162       return NULL;
 163     swag->head = NULL;
 164     swag->tail = NULL;
 165     xbt_swag_getNext(obj, offset) = xbt_swag_getPrev(obj, offset) = NULL;
 166   } else if (obj == swag->head) {       /* It's the head */
 167     swag->head = xbt_swag_getNext(obj, offset);
 168     xbt_swag_getPrev(swag->head, offset) = NULL;
 169     xbt_swag_getNext(obj, offset) = NULL;
 170   } else if (obj == swag->tail) {       /* It's the tail */
 171     swag->tail = xbt_swag_getPrev(obj, offset);
 172     xbt_swag_getNext(swag->tail, offset) = NULL;
 173     xbt_swag_getPrev(obj, offset) = NULL;
 174   } else {                      /* It's in the middle */
 175     xbt_swag_getNext(xbt_swag_getPrev(obj, offset), offset) =
 176         xbt_swag_getNext(obj, offset);
 177     xbt_swag_getPrev(xbt_swag_getNext(obj, offset), offset) =
 178         xbt_swag_getPrev(obj, offset);
 179     xbt_swag_getPrev(obj, offset) = xbt_swag_getNext(obj, offset) = NULL;
 180   }
 181   (swag->count)--;
 182   return obj;
 183 }
 184
 185 /**
 186  * \param swag a swag
 187  * \return an object from the \a swag
 188  */
 189 void *xbt_swag_extract(xbt_swag_t swag)
 190 {
 191   size_t offset = swag->offset;
 192   void *obj = NULL;
 193
 194   if ((!swag) || (!(swag->head)))
 195     return NULL;
 196
 197   obj = swag->head;
 198
 199   if (swag->head == swag->tail) {       /* special case */
 200     swag->head = swag->tail = NULL;
 201     xbt_swag_getPrev(obj, offset) = xbt_swag_getNext(obj, offset) = NULL;
 202   } else {
 203     swag->head = xbt_swag_getNext(obj, offset);
 204     xbt_swag_getPrev(swag->head, offset) = NULL;
 205     xbt_swag_getNext(obj, offset) = NULL;
 206   }
 207   (swag->count)--;
 208
 209   return obj;
 210 }
 211
 212 /**
 213  * \param swag a swag
 214  * \return the number of objects in \a swag
 215  */
 216 XBT_INLINE int xbt_swag_size(xbt_swag_t swag)
 217 {
 218   return (swag->count);
 219 }
 220
 221
 222 #ifdef SIMGRID_TEST
 223
 224 XBT_TEST_SUITE("swag", "Swag data container");
 225
 226 typedef struct {
 227   s_xbt_swag_hookup_t setA;
 228   s_xbt_swag_hookup_t setB;
 229   const char *name;
 230 } shmurtz, s_shmurtz_t, *shmurtz_t;
 231
 232
 233 XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
 234 {
 235   shmurtz_t obj1, obj2, obj;
 236   xbt_swag_t setA, setB;
 237
 238   obj1 = xbt_new0(s_shmurtz_t, 1);
 239   obj2 = xbt_new0(s_shmurtz_t, 1);
 240
 241   obj1->name = "Obj 1";
 242   obj2->name = "Obj 2";
 243
 244   xbt_test_add0("Basic usage");
 245   xbt_test_log3("%p %p %ld\n", obj1, &(obj1->setB),
 246                 (long) ((char *) &(obj1->setB) - (char *) obj1));
 247
 248   setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
 249   setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
 250
 251   xbt_swag_insert(obj1, setA);
 252   xbt_swag_insert(obj1, setB);
 253   xbt_swag_insert(obj2, setA);
 254   xbt_swag_insert(obj2, setB);
 255
 256   xbt_swag_remove(obj1, setB);
 257   /*  xbt_swag_remove(obj2, setB); */
 258
 259   xbt_test_add0("Traverse set A");
 260   xbt_swag_foreach(obj, setA) {
 261     xbt_test_log1("Saw: %s", obj->name);
 262   }
 263
 264   xbt_test_add0("Traverse set B");
 265   xbt_swag_foreach(obj, setB) {
 266     xbt_test_log1("Saw: %s", obj->name);
 267   }
 268
 269   xbt_test_add0("Ensure set content and length");
 270   xbt_test_assert(xbt_swag_belongs(obj1, setA));
 271   xbt_test_assert(xbt_swag_belongs(obj2, setA));
 272
 273   xbt_test_assert(!xbt_swag_belongs(obj1, setB));
 274   xbt_test_assert(xbt_swag_belongs(obj2, setB));
 275
 276   xbt_test_assert(xbt_swag_size(setA) == 2);
 277   xbt_test_assert(xbt_swag_size(setB) == 1);
 278
 279   xbt_swag_free(setA);
 280   xbt_swag_free(setB);
 281 }
 282
 283 #endif                          /* SIMGRID_TEST */