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