1 /* Copyright (c) 2004-2014. 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"
17 /** Creates a new swag.
18 * \param offset where the hookup is located in the structure
19 * \see xbt_swag_offset
21 * Usage : xbt_swag_new(&obj.setA-&obj);
23 inline xbt_swag_t xbt_swag_new(size_t offset)
25 xbt_swag_t swag = xbt_new0(s_xbt_swag_t, 1);
27 xbt_swag_init(swag, offset);
33 * \param swag poor victim
35 * kilkil a swag but not it's content. If you do not understand why xbt_swag_free should not free its content,
38 inline void xbt_swag_free(xbt_swag_t swag)
43 /** Creates a new swag.
44 * \param swag the swag to initialize
45 * \param offset where the hookup is located in the structure
46 * \see xbt_swag_offset
48 * Usage : xbt_swag_init(swag,&obj.setA-&obj);
50 inline void xbt_swag_init(xbt_swag_t swag, size_t offset)
54 swag->offset = offset;
59 * \param obj the objet to insert in the swag
62 * insert (at the head... you probably had a very good reason to do that, I hope you know what you're doing) \a obj in
65 inline void xbt_swag_insert_at_head(void *obj, xbt_swag_t swag)
67 xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
68 "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
71 xbt_assert(!(swag->tail), "Inconsistent swag.");
75 } else if (obj != swag->head && !xbt_swag_getPrev(obj, swag->offset)) {
76 xbt_swag_getNext(obj, swag->offset) = swag->head;
77 xbt_swag_getPrev(swag->head, swag->offset) = obj;
84 * \param obj the objet to insert in the swag
87 * insert (at the tail... you probably had a very good reason to do that, I hope you know what you're doing) \a obj in
90 inline void xbt_swag_insert_at_tail(void *obj, xbt_swag_t swag)
92 xbt_assert(!xbt_swag_belongs(obj, swag) || swag->tail,
93 "This object belongs to an empty swag! Did you correctly initialize the object's hookup?");
96 xbt_assert(!(swag->tail), "Inconsistent swag.");
100 } else if (obj != swag->tail && !xbt_swag_getNext(obj, swag->offset)) {
101 xbt_swag_getPrev(obj, swag->offset) = swag->tail;
102 xbt_swag_getNext(swag->tail, swag->offset) = obj;
109 * \param obj the objet to remove from the swag
111 * \return \a obj if it was in the \a swag and NULL otherwise
113 * removes \a obj from \a swag
115 inline void *xbt_swag_remove(void *obj, xbt_swag_t swag)
120 size_t offset = swag->offset;
121 void* prev = xbt_swag_getPrev(obj, offset);
122 void* next = xbt_swag_getNext(obj, offset);
125 xbt_swag_getNext(prev, offset) = next;
126 xbt_swag_getPrev(obj, offset) = NULL;
128 xbt_swag_getPrev(next, offset) = prev;
129 xbt_swag_getNext(obj, offset) = NULL;
135 xbt_swag_getPrev(next, offset) = NULL;
136 xbt_swag_getNext(obj, offset) = NULL;
139 } else if (obj == swag->head) {
140 swag->head = swag->tail = NULL;
149 * \return an object from the \a swag
151 void *xbt_swag_extract(xbt_swag_t swag)
156 size_t offset = swag->offset;
157 void* obj = swag->head;
159 if (obj == swag->tail) { /* special case */
160 swag->head = swag->tail = NULL;
162 swag->head = xbt_swag_getNext(obj, offset);
163 xbt_swag_getPrev(swag->head, offset) = NULL;
164 xbt_swag_getNext(obj, offset) = NULL;
173 * \return the number of objects in \a swag
175 inline int xbt_swag_size(xbt_swag_t swag)
177 return (swag->count);
182 XBT_TEST_SUITE("swag", "Swag data container");
185 s_xbt_swag_hookup_t setA;
186 s_xbt_swag_hookup_t setB;
188 } shmurtz, s_shmurtz_t, *shmurtz_t;
191 XBT_TEST_UNIT("basic", test_swag_basic, "Basic usage")
193 shmurtz_t obj1, obj2, obj;
194 xbt_swag_t setA, setB;
196 obj1 = xbt_new0(s_shmurtz_t, 1);
197 obj2 = xbt_new0(s_shmurtz_t, 1);
199 obj1->name = "Obj 1";
200 obj2->name = "Obj 2";
202 xbt_test_add("Basic usage");
203 xbt_test_log("%p %p %ld\n", obj1, &(obj1->setB), (long) ((char *) &(obj1->setB) - (char *) obj1));
205 setA = xbt_swag_new(xbt_swag_offset(*obj1, setA));
206 setB = xbt_swag_new(xbt_swag_offset(*obj1, setB));
208 xbt_swag_insert(obj1, setA);
209 xbt_swag_insert(obj1, setB);
210 xbt_swag_insert(obj2, setA);
211 xbt_swag_insert(obj2, setB);
213 xbt_test_assert(xbt_swag_remove(NULL, setB) == NULL);
214 xbt_test_assert(xbt_swag_remove(obj1, setB) == obj1);
215 /* xbt_test_assert(xbt_swag_remove(obj2, setB) == obj2); */
217 xbt_test_add("Traverse set A");
218 xbt_swag_foreach(obj, setA) {
219 xbt_test_log("Saw: %s", obj->name);
222 xbt_test_add("Traverse set B");
223 xbt_swag_foreach(obj, setB) {
224 xbt_test_log("Saw: %s", obj->name);
227 xbt_test_add("Ensure set content and length");
228 xbt_test_assert(xbt_swag_belongs(obj1, setA));
229 xbt_test_assert(xbt_swag_belongs(obj2, setA));
231 xbt_test_assert(!xbt_swag_belongs(obj1, setB));
232 xbt_test_assert(xbt_swag_belongs(obj2, setB));
234 xbt_test_assert(xbt_swag_size(setA) == 2);
235 xbt_test_assert(xbt_swag_size(setB) == 1);
243 #endif /* SIMGRID_TEST */