Logo AND Algorithmique Numérique Distribuée

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