1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
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
11 /* This type should be added to a type that is to be used in such a swag */
13 #include "xbt/sysdep.h"
18 /** Creates a new swag.
19 * \param offset where the hookup is located in the structure
20 * \see xbt_swag_offset
22 * Usage : xbt_swag_new(&obj.setA-&obj);
24 XBT_INLINE xbt_swag_t xbt_swag_new(size_t offset)
26 xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
28 xbt_swag_init(swag, offset);
34 * \param swag poor victim
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.
39 XBT_INLINE void xbt_swag_free(xbt_swag_t swag)
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
49 * Usage : xbt_swag_init(swag,&obj.setA-&obj);
51 XBT_INLINE void xbt_swag_init(xbt_swag_t swag, size_t offset)
55 swag->offset = offset;
61 * \param obj the objet to insert in the swag
64 * insert \a obj in \a swag
66 XBT_INLINE void xbt_swag_insert(void *obj, xbt_swag_t swag)
69 if (xbt_swag_belongs(obj, swag))
73 if (swag->head == NULL) {
74 xbt_assert0(!(swag->tail), "Inconsistent swag.");
80 xbt_swag_getPrev(obj, swag->offset) = swag->tail;
81 xbt_swag_getNext(xbt_swag_getPrev(obj, swag->offset), swag->offset) = obj;
87 * \param obj the objet to insert in the swag
90 * insert (at the head... you probably had a very good reason to do
91 * that, I hope you know what you're doing) \a obj in \a swag
93 XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
96 if (xbt_swag_belongs(obj, swag))
100 if (swag->head == NULL) {
101 xbt_assert0(!(swag->tail), "Inconsistent swag.");
107 xbt_swag_getNext(obj, swag->offset) = swag->head;
108 xbt_swag_getPrev(xbt_swag_getNext(obj, swag->offset), swag->offset) = obj;
114 * \param obj the objet to insert in the swag
117 * insert (at the tail... you probably had a very good reason to do
118 * that, I hope you know what you're doing) \a obj in \a swag
120 XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
123 if (xbt_swag_belongs(obj, swag))
127 if (swag->head == NULL) {
128 xbt_assert0(!(swag->tail), "Inconsistent swag.");
134 xbt_swag_getPrev(obj, swag->offset) = swag->tail;
135 xbt_swag_getNext(xbt_swag_getPrev(obj, swag->offset), swag->offset) = obj;
141 * \param obj the objet to remove from the swag
143 * \return \a obj if it was in the \a swag and NULL otherwise
145 * removes \a obj from \a swag
147 XBT_INLINE void *xbt_swag_remove(void *obj, xbt_swag_t swag)
149 size_t offset = swag->offset;
151 if ((!obj) || (!swag))
153 if (!xbt_swag_belongs(obj, swag)) /* Trying to remove an object that
154 was not in this swag */
157 if (swag->head == swag->tail) { /* special case */
158 if (swag->head != obj) /* Trying to remove an object that was not in this swag */
162 xbt_swag_getNext(obj, offset) = xbt_swag_getPrev(obj, offset) = NULL;
163 } else if (obj == swag->head) { /* It's the head */
164 swag->head = xbt_swag_getNext(obj, offset);
165 xbt_swag_getPrev(swag->head, offset) = NULL;
166 xbt_swag_getNext(obj, offset) = NULL;
167 } else if (obj == swag->tail) { /* It's the tail */
168 swag->tail = xbt_swag_getPrev(obj, offset);
169 xbt_swag_getNext(swag->tail, offset) = NULL;
170 xbt_swag_getPrev(obj, offset) = NULL;
171 } else { /* It's in the middle */
172 xbt_swag_getNext(xbt_swag_getPrev(obj, offset), offset) = xbt_swag_getNext(obj, offset);
173 xbt_swag_getPrev(xbt_swag_getNext(obj, offset), offset) = xbt_swag_getPrev(obj, offset);
174 xbt_swag_getPrev(obj, offset) = xbt_swag_getNext(obj, offset) = NULL;
182 * \return an object from the \a swag
184 void *xbt_swag_extract(xbt_swag_t swag)
186 size_t offset = swag->offset;
189 if ((!swag) || (!(swag->head)))
194 if (swag->head == swag->tail) { /* special case */
195 swag->head = swag->tail = NULL;
196 xbt_swag_getPrev(obj, offset) = xbt_swag_getNext(obj, offset) = NULL;
198 swag->head = xbt_swag_getNext(obj, offset);
199 xbt_swag_getPrev(swag->head, offset) = NULL;
200 xbt_swag_getNext(obj, offset) = NULL;
209 * \return the number of objects in \a swag
211 XBT_INLINE int xbt_swag_size(xbt_swag_t swag)
213 return (swag->count);
219 XBT_TEST_SUITE("swag", "Swag data container");
222 s_xbt_swag_hookup_t setA;
223 s_xbt_swag_hookup_t setB;
225 } shmurtz, s_shmurtz_t, *shmurtz_t;
228 XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
230 shmurtz_t obj1, obj2, obj;
231 xbt_swag_t setA, setB;
233 obj1 = xbt_new0(s_shmurtz_t, 1);
234 obj2 = xbt_new0(s_shmurtz_t, 1);
236 obj1->name = "Obj 1";
237 obj2->name = "Obj 2";
239 xbt_test_add0("Basic usage");
240 xbt_test_log3("%p %p %ld\n", obj1, &(obj1->setB),
241 (long) ((char *) &(obj1->setB) - (char *) obj1));
243 setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
244 setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
246 xbt_swag_insert(obj1, setA);
247 xbt_swag_insert(obj1, setB);
248 xbt_swag_insert(obj2, setA);
249 xbt_swag_insert(obj2, setB);
251 xbt_swag_remove(obj1, setB);
252 /* xbt_swag_remove(obj2, setB); */
254 xbt_test_add0("Traverse set A");
255 xbt_swag_foreach(obj, setA) {
256 xbt_test_log1("Saw: %s", obj->name);
259 xbt_test_add0("Traverse set B");
260 xbt_swag_foreach(obj, setB) {
261 xbt_test_log1("Saw: %s", obj->name);
264 xbt_test_add0("Ensure set content and length");
265 xbt_test_assert(xbt_swag_belongs(obj1, setA));
266 xbt_test_assert(xbt_swag_belongs(obj2, setA));
268 xbt_test_assert(!xbt_swag_belongs(obj1, setB));
269 xbt_test_assert(xbt_swag_belongs(obj2, setB));
271 xbt_test_assert(xbt_swag_size(setA) == 2);
272 xbt_test_assert(xbt_swag_size(setB) == 1);
278 #endif /* SIMGRID_TEST */