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