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;
60 * \param obj the objet to insert in the swag
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
66 XBT_INLINE void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
68 xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
69 "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
72 xbt_assert(!(swag->tail), "Inconsistent swag.");
77 else if (obj != swag->head && !xbt_swag_getPrev(obj, swag->offset)) {
78 xbt_swag_getNext(obj, swag->offset) = swag->head;
79 xbt_swag_getPrev(swag->head, swag->offset) = obj;
86 * \param obj the objet to insert in the swag
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
92 XBT_INLINE void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
94 xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
95 "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
98 xbt_assert(!(swag->tail), "Inconsistent swag.");
103 else if (obj != swag->tail && !xbt_swag_getNext(obj, swag->offset)) {
104 xbt_swag_getPrev(obj, swag->offset) = swag->tail;
105 xbt_swag_getNext(swag->tail, swag->offset) = obj;
112 * \param obj the objet to remove from the swag
114 * \return \a obj if it was in the \a swag and NULL otherwise
116 * removes \a obj from \a swag
118 XBT_INLINE void *xbt_swag_remove(void *obj, xbt_swag_t swag)
123 size_t offset = swag->offset;
124 void* prev = xbt_swag_getPrev(obj, offset);
125 void* next = xbt_swag_getNext(obj, offset);
128 xbt_swag_getNext(prev, offset) = next;
129 xbt_swag_getPrev(obj, offset) = NULL;
131 xbt_swag_getPrev(next, offset) = prev;
132 xbt_swag_getNext(obj, offset) = NULL;
140 xbt_swag_getPrev(next, offset) = NULL;
141 xbt_swag_getNext(obj, offset) = NULL;
145 else if (obj == swag->head) {
146 swag->head = swag->tail = NULL;
155 * \return an object from the \a swag
157 void *xbt_swag_extract(xbt_swag_t swag)
162 size_t offset = swag->offset;
163 void* obj = swag->head;
165 if (obj == swag->tail) { /* special case */
166 swag->head = swag->tail = NULL;
168 swag->head = xbt_swag_getNext(obj, offset);
169 xbt_swag_getPrev(swag->head, offset) = NULL;
170 xbt_swag_getNext(obj, offset) = NULL;
179 * \return the number of objects in \a swag
181 XBT_INLINE int xbt_swag_size(xbt_swag_t swag)
183 return (swag->count);
189 XBT_TEST_SUITE("swag", "Swag data container");
192 s_xbt_swag_hookup_t setA;
193 s_xbt_swag_hookup_t setB;
195 } shmurtz, s_shmurtz_t, *shmurtz_t;
198 XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
200 shmurtz_t obj1, obj2, obj;
201 xbt_swag_t setA, setB;
203 obj1 = xbt_new0(s_shmurtz_t, 1);
204 obj2 = xbt_new0(s_shmurtz_t, 1);
206 obj1->name = "Obj 1";
207 obj2->name = "Obj 2";
209 xbt_test_add("Basic usage");
210 xbt_test_log("%p %p %ld\n", obj1, &(obj1->setB),
211 (long) ((char *) &(obj1->setB) - (char *) obj1));
213 setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
214 setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
216 xbt_swag_insert(obj1, setA);
217 xbt_swag_insert(obj1, setB);
218 xbt_swag_insert(obj2, setA);
219 xbt_swag_insert(obj2, setB);
221 xbt_swag_remove(obj1, setB);
222 /* xbt_swag_remove(obj2, setB); */
224 xbt_test_add("Traverse set A");
225 xbt_swag_foreach(obj, setA) {
226 xbt_test_log("Saw: %s", obj->name);
229 xbt_test_add("Traverse set B");
230 xbt_swag_foreach(obj, setB) {
231 xbt_test_log("Saw: %s", obj->name);
234 xbt_test_add("Ensure set content and length");
235 xbt_test_assert(xbt_swag_belongs(obj1, setA));
236 xbt_test_assert(xbt_swag_belongs(obj2, setA));
238 xbt_test_assert(!xbt_swag_belongs(obj1, setB));
239 xbt_test_assert(xbt_swag_belongs(obj2, setB));
241 xbt_test_assert(xbt_swag_size(setA) == 2);
242 xbt_test_assert(xbt_swag_size(setB) == 1);
251 #endif /* SIMGRID_TEST */