3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 /* Warning, this module is done to be efficient and performs tons of
9 cast and dirty things. So avoid using it unless you really know
10 what you are doing. */
12 /* This type should be added to a type that is to be used in such a swag */
14 #include "xbt/sysdep.h"
18 #define PREV(obj,offset) xbt_swag_getPrev(obj,offset)
19 #define NEXT(obj,offset) xbt_swag_getNext(obj,offset)
22 /** Creates a new swag.
23 * \param offset where the hookup is located in the structure
24 * \see xbt_swag_offset
26 * Usage : xbt_swag_new(&obj.setA-&obj);
28 xbt_swag_t xbt_swag_new(size_t offset)
30 xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
34 swag->offset = offset;
41 * \param swag poor victim
43 * kilkil a swag but not it's content. If you do not understand why
44 * xbt_swag_free should not free its content, don't use swags.
46 void xbt_swag_free(xbt_swag_t swag)
51 /** Creates a new swag.
52 * \param swag the swag to initialize
53 * \param offset where the hookup is located in the structure
54 * \see xbt_swag_offset
56 * Usage : xbt_swag_init(swag,&obj.setA-&obj);
58 void xbt_swag_init(xbt_swag_t swag, size_t offset)
62 swag->offset = offset;
68 * \param obj the objet to insert in the swag
71 * insert \a obj in \a swag
73 void xbt_swag_insert(void *obj, xbt_swag_t swag)
76 if (xbt_swag_belongs(obj, swag))
80 if (swag->head == NULL) {
81 xbt_assert0(!(swag->tail), "Inconsistent swag.");
87 PREV(obj, swag->offset) = swag->tail;
88 NEXT(PREV(obj, swag->offset), swag->offset) = obj;
94 * \param obj the objet to insert in the swag
97 * insert (at the head... you probably had a very good reason to do
98 * that, I hope you know what you're doing) \a obj in \a swag
100 void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
103 if (xbt_swag_belongs(obj, swag))
107 if (swag->head == NULL) {
108 xbt_assert0(!(swag->tail), "Inconsistent swag.");
114 NEXT(obj, swag->offset) = swag->head;
115 PREV(NEXT(obj, swag->offset), swag->offset) = obj;
121 * \param obj the objet to insert in the swag
124 * insert (at the tail... you probably had a very good reason to do
125 * that, I hope you know what you're doing) \a obj in \a swag
127 void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
130 if (xbt_swag_belongs(obj, swag))
134 if (swag->head == NULL) {
135 xbt_assert0(!(swag->tail), "Inconsistent swag.");
141 PREV(obj, swag->offset) = swag->tail;
142 NEXT(PREV(obj, swag->offset), swag->offset) = obj;
148 * \param obj the objet to remove from the swag
150 * \return \a obj if it was in the \a swag and NULL otherwise
152 * removes \a obj from \a swag
154 void *xbt_swag_remove(void *obj, xbt_swag_t swag)
156 size_t offset = swag->offset;
158 if ((!obj) || (!swag))
160 if(!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
161 was not in this swag */
164 if (swag->head == swag->tail) { /* special case */
165 if (swag->head != obj) /* Trying to remove an object that was not in this swag */
169 NEXT(obj, offset) = PREV(obj, offset) = NULL;
170 } else if (obj == swag->head) { /* It's the head */
171 swag->head = NEXT(obj, offset);
172 PREV(swag->head, offset) = NULL;
173 NEXT(obj, offset) = NULL;
174 } else if (obj == swag->tail) { /* It's the tail */
175 swag->tail = PREV(obj, offset);
176 NEXT(swag->tail, offset) = NULL;
177 PREV(obj, offset) = NULL;
178 } else { /* It's in the middle */
179 NEXT(PREV(obj, offset), offset) = NEXT(obj, offset);
180 PREV(NEXT(obj, offset), offset) = PREV(obj, offset);
181 PREV(obj, offset) = NEXT(obj, offset) = NULL;
189 * \return an object from the \a swag
191 void *xbt_swag_extract(xbt_swag_t swag)
193 size_t offset = swag->offset;
196 if ((!swag) || (!(swag->head)))
201 if (swag->head == swag->tail) { /* special case */
202 swag->head = swag->tail = NULL;
203 PREV(obj, offset) = NEXT(obj, offset) = NULL;
205 swag->head = NEXT(obj, offset);
206 PREV(swag->head, offset) = NULL;
207 NEXT(obj, offset) = NULL;
215 * \return the number of objects in \a swag
217 int xbt_swag_size(xbt_swag_t swag)
219 return (swag->count);
223 * \param obj an object
225 * \return 1 if \a obj is in the \a swag and 0 otherwise
227 int xbt_swag_belongs(void *obj, xbt_swag_t swag)
229 return ((NEXT(obj, swag->offset)) || (PREV(obj, swag->offset))
230 || (swag->head == obj));
236 XBT_TEST_SUITE("swag","Swag data container");
239 s_xbt_swag_hookup_t setA;
240 s_xbt_swag_hookup_t setB;
242 } shmurtz, s_shmurtz_t, *shmurtz_t;
245 XBT_TEST_UNIT("basic",test_swag_basic,"Basic usage") {
246 shmurtz_t obj1, obj2, obj;
247 xbt_swag_t setA,setB;
249 obj1 = calloc(1,sizeof(s_shmurtz_t));
250 obj2 = calloc(1,sizeof(s_shmurtz_t));
255 xbt_test_add0("Basic usage");
256 xbt_test_log3("%p %p %ld\n",obj1,&(obj1->setB),
257 (long)((char *)&(obj1->setB) - (char *)obj1));
259 setA = xbt_swag_new(xbt_swag_offset(*obj1,setA));
260 setB = xbt_swag_new(xbt_swag_offset(*obj1,setB));
262 xbt_swag_insert(obj1, setA);
263 xbt_swag_insert(obj1, setB);
264 xbt_swag_insert(obj2, setA);
265 xbt_swag_insert(obj2, setB);
267 xbt_swag_remove(obj1, setB);
268 /* xbt_swag_remove(obj2, setB);*/
270 xbt_test_add0("Traverse set A");
271 xbt_swag_foreach(obj,setA) {
272 xbt_test_log1("Saw: %s",obj->name);
275 xbt_test_add0("Traverse set B");
276 xbt_swag_foreach(obj,setB) {
277 xbt_test_log1("Saw: %s",obj->name);
280 xbt_test_add0("Ensure set content and length");
281 xbt_test_assert( xbt_swag_belongs(obj1,setA));
282 xbt_test_assert( xbt_swag_belongs(obj2,setA));
284 xbt_test_assert(! xbt_swag_belongs(obj1,setB));
285 xbt_test_assert( xbt_swag_belongs(obj2,setB));
287 xbt_test_assert(xbt_swag_size(setA) == 2);
288 xbt_test_assert(xbt_swag_size(setB) == 1);
294 #endif /* SIMGRID_TEST */