src/xbt/swag.c

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