src/xbt/swag.c

   1 /* Copyright (c) 2004-2017. 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 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 xbt_swag_free should not free its content,
  36  * don't use swags.
  37  */
  38 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 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 that, I hope you know what you're doing) \a obj in
  63  * \a swag
  64  */
  65 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   } else if (obj != swag->head && !xbt_swag_getPrev(obj, swag->offset)) {
  76     xbt_swag_getNext(obj, swag->offset) = swag->head;
  77     xbt_swag_getPrev(swag->head, swag->offset) = obj;
  78     swag->head = obj;
  79     swag->count++;
  80   }
  81 }
  82
  83 /**
  84  * \param obj the objet to insert in the swag
  85  * \param swag a swag
  86  *
  87  * insert (at the tail... you probably had a very good reason to do that, I hope you know what you're doing) \a obj in
  88  * \a swag
  89  */
  90 inline void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
  91 {
  92   xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
  93       "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
  94
  95   if (!swag->head) {
  96     xbt_assert(!(swag->tail), "Inconsistent swag.");
  97     swag->head = obj;
  98     swag->tail = obj;
  99     swag->count++;
 100   } else if (obj != swag->tail && !xbt_swag_getNext(obj, swag->offset)) {
 101     xbt_swag_getPrev(obj, swag->offset) = swag->tail;
 102     xbt_swag_getNext(swag->tail, swag->offset) = obj;
 103     swag->tail = obj;
 104     swag->count++;
 105   }
 106 }
 107
 108 /**
 109  * \param obj the objet to remove from the swag
 110  * \param swag a swag
 111  * \return \a obj if it was in the \a swag and NULL otherwise
 112  *
 113  * removes \a obj from \a swag
 114  */
 115 inline void *xbt_swag_remove(void *obj, xbt_swag_t swag)
 116 {
 117   if (!obj)
 118     return NULL;
 119
 120   size_t offset = swag->offset;
 121   void* prev = xbt_swag_getPrev(obj, offset);
 122   void* next = xbt_swag_getNext(obj, offset);
 123
 124   if (prev) {
 125     xbt_swag_getNext(prev, offset) = next;
 126     xbt_swag_getPrev(obj, offset) = NULL;
 127     if (next) {
 128       xbt_swag_getPrev(next, offset) = prev;
 129       xbt_swag_getNext(obj, offset) = NULL;
 130     } else {
 131       swag->tail = prev;
 132     }
 133     swag->count--;
 134   } else if (next) {
 135     xbt_swag_getPrev(next, offset) = NULL;
 136     xbt_swag_getNext(obj, offset) = NULL;
 137     swag->head = next;
 138     swag->count--;
 139   } else if (obj == swag->head) {
 140     swag->head = swag->tail = NULL;
 141     swag->count--;
 142   }
 143
 144   return obj;
 145 }
 146
 147 /**
 148  * \param swag a swag
 149  * \return an object from the \a swag
 150  */
 151 void *xbt_swag_extract(xbt_swag_t swag)
 152 {
 153   if (!swag->head)
 154     return NULL;
 155
 156   size_t offset = swag->offset;
 157   void* obj = swag->head;
 158
 159   if (obj == swag->tail) {       /* special case */
 160     swag->head = swag->tail = NULL;
 161   } else {
 162     swag->head = xbt_swag_getNext(obj, offset);
 163     xbt_swag_getPrev(swag->head, offset) = NULL;
 164     xbt_swag_getNext(obj, offset) = NULL;
 165   }
 166   (swag->count)--;
 167
 168   return obj;
 169 }
 170
 171 /**
 172  * \param swag a swag
 173  * \return the number of objects in \a swag
 174  */
 175 inline int xbt_swag_size(xbt_swag_t swag)
 176 {
 177   return (swag->count);
 178 }
 179
 180 #ifdef SIMGRID_TEST
 181
 182 XBT_TEST_SUITE("swag", "Swag data container");
 183
 184 typedef struct {
 185   s_xbt_swag_hookup_t setA;
 186   s_xbt_swag_hookup_t setB;
 187   const char *name;
 188 } shmurtz, s_shmurtz_t, *shmurtz_t;
 189
 190
 191 XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
 192 {
 193   shmurtz_t obj1, obj2, obj;
 194   xbt_swag_t setA, setB;
 195
 196   obj1 = xbt_new0(s_shmurtz_t, 1);
 197   obj2 = xbt_new0(s_shmurtz_t, 1);
 198
 199   obj1->name = "Obj 1";
 200   obj2->name = "Obj 2";
 201
 202   xbt_test_add("Basic usage");
 203   xbt_test_log("%p %p %ld\n", obj1, &(obj1->setB), (long) ((char *) &(obj1->setB) - (char *) obj1));
 204
 205   setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
 206   setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
 207
 208   xbt_swag_insert(obj1, setA);
 209   xbt_swag_insert(obj1, setB);
 210   xbt_swag_insert(obj2, setA);
 211   xbt_swag_insert(obj2, setB);
 212
 213   xbt_test_assert(xbt_swag_remove(NULL, setB) == NULL);
 214   xbt_test_assert(xbt_swag_remove(obj1, setB) == obj1);
 215
 216   xbt_test_add("Traverse set A");
 217   xbt_swag_foreach(obj, setA) {
 218     xbt_test_log("Saw: %s", obj->name);
 219   }
 220
 221   xbt_test_add("Traverse set B");
 222   xbt_swag_foreach(obj, setB) {
 223     xbt_test_log("Saw: %s", obj->name);
 224   }
 225
 226   xbt_test_add("Ensure set content and length");
 227   xbt_test_assert(xbt_swag_belongs(obj1, setA));
 228   xbt_test_assert(xbt_swag_belongs(obj2, setA));
 229
 230   xbt_test_assert(!xbt_swag_belongs(obj1, setB));
 231   xbt_test_assert(xbt_swag_belongs(obj2, setB));
 232
 233   xbt_test_assert(xbt_swag_size(setA) == 2);
 234   xbt_test_assert(xbt_swag_size(setB) == 1);
 235
 236   xbt_swag_free(setA);
 237   xbt_swag_free(setB);
 238
 239   xbt_free(obj1);
 240   xbt_free(obj2);
 241 }
 242 #endif                          /* SIMGRID_TEST */