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