Update to new avl/list iteration macros
[olsrd.git] / src / common / list.h
1 /*
2  * PacketBB handler library (see RFC 5444)
3  * Copyright (c) 2010 Henning Rogge <hrogge@googlemail.com>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  *   notice, this list of conditions and the following disclaimer in
14  *   the documentation and/or other materials provided with the
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its
17  *   contributors may be used to endorse or promote products derived
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org/git for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  */
39
40 #ifndef LIST_H_
41 #define LIST_H_
42
43 #include <stddef.h>
44 #include <stdbool.h>
45
46 #include "container_of.h"
47
48 /**
49  * this struct is used as list head and list elements.
50  * the list-nodes and the list-head contain two rings of
51  * pointers (one forward, one backward), the first/last node
52  * have a link to the head, no NULL element.
53  */
54 struct list_entity {
55   /**
56    * Pointer to next element in list or to list head if last element
57    */
58   struct list_entity *next;
59
60   /**
61    * Pointer to previous element in list or list head if first element
62    */
63   struct list_entity *prev;
64 };
65
66 /**
67  * initialize a list-head
68  * @param pointer to list-head
69  */
70 static inline void list_init_head(struct list_entity *head) {
71   head->next = head->prev = head;
72 }
73
74 /**
75  * initialize a list-node
76  * @param pointer to list-node
77  */
78 static inline void list_init_node(struct list_entity *entity) {
79   entity->next = entity->prev = NULL;
80 }
81
82 /**
83  * internal function to add a new node between two other nodes.
84  * @param prev node before the insertion point
85  * @param next node after the insertion point
86  * @param new node which will be added to the list between 'prev' and 'next'
87  */
88 static inline void __list_add(struct list_entity *prev, struct list_entity *next, struct list_entity *new) {
89   new->next = next;
90   new->prev = prev;
91   next->prev = new;
92   prev->next = new;
93 }
94
95 /**
96  * adds a node at the beginning of a list
97  * @param head pointer to list head
98  * @param new node which will be added to the list
99  */
100 static inline void list_add_head(struct list_entity *head, struct list_entity *new) {
101   __list_add(head, head->next, new);
102 }
103
104 /**
105  * adds a node at the end of a list
106  * @param head pointer to list head
107  * @param new node which will be added to the list
108  */
109 static inline void list_add_tail(struct list_entity *head, struct list_entity *new) {
110   __list_add(head->prev, head, new);
111 }
112
113 /**
114  * adds a node before another node
115  * @param before reference node in the list
116  * @param new node which will be added to the list
117  */
118 static inline void list_add_before(struct list_entity *before, struct list_entity *new) {
119   __list_add(before->prev, before, new);
120 }
121
122 /**
123  * adds a node after another node
124  * @param before reference node in the list
125  * @param new node which will be added to the list
126  */
127 static inline void list_add_after(struct list_entity *after, struct list_entity *new) {
128   __list_add(after, after->next, new);
129 }
130
131 /**
132  * internal function that removes the nodes between two other nodes.
133  * @param prev node before the removed part of the list
134  * @param next node after the removed part of the list
135  */
136 static inline void __list_remove(struct list_entity *prev, struct list_entity *next) {
137   prev->next = next;
138   next->prev = prev;
139 }
140
141 /**
142  * removes a node from a list and clears node pointers
143  * @param entity node to remove from the list
144  */
145 static inline void list_remove(struct list_entity *entity) {
146   __list_remove(entity->prev, entity->next);
147   entity->prev = entity->next = NULL;
148 }
149
150 /**
151  * checks if list is empty
152  * @param head pointer to list head
153  * @return true if list is empty, false otherwise
154  */
155 static inline bool list_is_empty(struct list_entity *head) {
156   return head->next == head && head->prev == head;
157 }
158
159 /**
160  * checks if node has been added to a list
161  * @param node pointer to node
162  * @return true if both pointers of the node are initialized,
163  *   false otherwise
164  */
165 static inline bool list_node_added(struct list_entity *node) {
166   return node->next != NULL && node->prev != NULL;
167 }
168
169 /**
170  * checks if a node is the first element of a list
171  * @param head pointer to list head
172  * @param entity pointer to node
173  * @return true if node is first element of list, false otherwise
174  */
175 static inline bool list_is_first(struct list_entity *head, struct list_entity *entity) {
176   return head->next == entity;
177 }
178
179 /**
180  * checks if node is the last element of a list
181  * @param head pointer to list head
182  * @param entity pointer to node
183  * @return true if node is last element of list, false otherwise
184  */
185 static inline bool list_is_last(struct list_entity *head, struct list_entity *entity) {
186   return head->prev == entity;
187 }
188
189 /**
190  * Merge two lists and clear the second head
191  * @param add_to head of the list which will contain all elements
192  * @param remove_from head of the list which elements will be added after the elements
193  *   of the first one
194  */
195 static inline void list_merge(struct list_entity *add_to, struct list_entity *remove_from) {
196   if (list_is_empty(remove_from)) {
197     return;
198   }
199
200   add_to->next->prev = remove_from->prev;
201   remove_from->prev->next = add_to->next;
202   add_to->next = remove_from->next;
203   remove_from->next->prev = add_to;
204
205   list_init_head(remove_from);
206 }
207
208 /**
209  * @param head pointer to list-head
210  * @param element pointer to a node element
211  *    (don't need to be initialized)
212  * @param list_member name of the list_entity element inside the
213  *    larger struct
214  * @return pointer to the first element of the list
215  *    (automatically converted to type 'element')
216  */
217 #define list_first_element(head, element, list_member) \
218     container_of((head)->next, typeof(*(element)), list_member)
219
220 /**
221  * @param head pointer to list-head
222  * @param element pointer to a node element
223  *    (don't need to be initialized)
224  * @param list_member name of the list_entity element inside the
225  *    larger struct
226  * @return pointer to the last element of the list
227  *    (automatically converted to type 'element')
228  */
229 #define list_last_element(head, element, list_member) \
230     container_of((head)->prev, typeof(*(element)), list_member)
231
232 /**
233  * This function must not be called for the last element of
234  * a list
235  *
236  * @param element pointer to a node of the list
237  * @param list_member name of the list_entity element inside the
238  *    larger struct
239  * @return pointer to the node after 'element'
240  *    (automatically converted to type 'element')
241  */
242 #define list_next_element(element, list_member) \
243   container_of((&(element)->list_member)->next, typeof(*(element)), list_member)
244
245 /**
246  * This function must not be called for the first element of
247  * a list
248  *
249  * @param element pointer to a node of the list
250  * @param list_member name of the list_entity element inside the
251  *    larger struct
252  * @return pointer to the node before 'element'
253  *    (automatically converted to type 'element')
254  */
255 #define list_prev_element(element, list_member) \
256   container_of((&(element)->list_member)->prev, typeof(*(element)), list_member)
257
258 /**
259  * Loop over a block of elements of a list, used similar to a for() command.
260  * This loop should not be used if elements are removed from the list during
261  * the loop.
262  *
263  * @param first_element first element of loop
264  * @param last_element last element of loop
265  * @param element iterator pointer to list element struct
266  * @param list_member name of list_entity within list element struct
267  */
268 #define list_for_element_range(first_element, last_element, element, list_member) \
269   for (element = (first_element); \
270        element->list_member.prev != &(last_element)->list_member; \
271        element = list_next_element(element, list_member))
272
273 /**
274  * Loop over a block of elements of a list backwards, used similar to a for() command.
275  * This loop should not be used if elements are removed from the list during
276  * the loop.
277  *
278  * @param first_element first element of range (will be last returned by the loop)
279  * @param last_element last element of range (will be first returned by the loop)
280  * @param element iterator pointer to list element struct
281  * @param list_member name of list_entity within list element struct
282  */
283 #define list_for_element_range_reverse(first_element, last_element, element, list_member) \
284   for (element = (last_element); \
285        element->list_member.next != &(first_element)->list_member; \
286        element = list_prev_element(element, list_member))
287
288 /**
289  * Loop over all elements of a list, used similar to a for() command.
290  * This loop should not be used if elements are removed from the list during
291  * the loop.
292  *
293  * @param head pointer to list-head
294  * @param element pointer to a node of the list, this element will
295  *    contain the current node of the list during the loop
296  * @param list_member name of the list_entity element inside the
297  *    larger struct
298  */
299 #define list_for_each_element(head, element, list_member) \
300   list_for_element_range(list_first_element(head, element, list_member), \
301                          list_last_element(head, element, list_member), \
302                          element, list_member)
303
304 /**
305  * Loop over all elements of a list backwards, used similar to a for() command.
306  * This loop should not be used if elements are removed from the list during
307  * the loop.
308  *
309  * @param head pointer to list-head
310  * @param element pointer to a node of the list, this element will
311  *    contain the current node of the list during the loop
312  * @param list_member name of the list_entity element inside the
313  *    larger struct
314  */
315 #define list_for_each_element_reverse(head, element, list_member) \
316   list_for_element_range_reverse(list_first_element(head, element, list_member), \
317                                  list_last_element(head, element, list_member), \
318                                  element, list_member)
319
320 /**
321  * Loop over a block of elements of a list, used similar to a for() command.
322  * This loop should not be used if elements are removed from the list during
323  * the loop.
324  * The loop runs from the element 'first' to the end of the list.
325  *
326  * @param head pointer to head of list
327  * @param first pointer to first element of loop
328  * @param element pointer to a node of the list, this element will
329  *    contain the current node of the list during the loop
330  * @param list_member name of the list_entity element inside the
331  *    larger struct
332  */
333 #define list_for_element_to_last(head, first, element, list_member) \
334   list_for_element_range(first, list_last_element(head, element, list_member), element, list_member)
335
336 /**
337  * Loop over a block of elements of a list backwards, used similar to a for() command.
338  * This loop should not be used if elements are removed from the list during
339  * the loop.
340  * The loop runs from the end of the list to the element 'first'.
341  *
342  * @param head pointer to head of list
343  * @param first pointer to first element of loop
344  * @param element pointer to a node of the list, this element will
345  *    contain the current node of the list during the loop
346  * @param list_member name of the list_entity element inside the
347  *    larger struct
348  */
349 #define list_for_element_to_last_reverse(head, first, element, list_member) \
350   list_for_element_range_reverse(first, list_last_element(head, element, list_member), element, list_member)
351
352 /**
353  * Loop over a block of elements of a list, used similar to a for() command.
354  * This loop should not be used if elements are removed from the list during
355  * the loop.
356  * The loop runs from the start of the list to the element 'last'.
357  *
358  * @param head pointer to head of list
359  * @param last pointer to last element of loop
360  * @param element pointer to a node of the list, this element will
361  *    contain the current node of the list during the loop
362  * @param list_member name of the list_entity element inside the
363  *    larger struct
364  */
365 #define list_for_first_to_element(head, last, element, list_member) \
366   list_for_element_range(list_first_element(head, element, list_member), last, element, list_member)
367
368 /**
369  * Loop over a block of elements of a list backwards, used similar to a for() command.
370  * This loop should not be used if elements are removed from the list during
371  * the loop.
372  * The loop runs from the element 'last' to the start of the list.
373  *
374  * @param head pointer to head of list
375  * @param last pointer to last element of loop
376  * @param element pointer to a node of the list, this element will
377  *    contain the current node of the list during the loop
378  * @param list_member name of the list_entity element inside the
379  *    larger struct
380  * @param loop_ptr pointer to an list_entity which is used as the
381  *    internal iterator
382  */
383 #define list_for_first_to_element_reverse(head, last, element, list_member) \
384   list_for_element_range_reverse(list_first_element(head, element, list_member), last, element, list_member)
385
386 /**
387  * Loop over a block of elements of a list, used similar to a for() command.
388  * This loop can be used if the current element might be removed from
389  * the list during the loop. Other elements should not be removed during
390  * the loop.
391  *
392  * @param first_element first element of loop
393  * @param last_element last element of loop
394  * @param element iterator pointer to list element struct
395  * @param list_member name of list_entity within list element struct
396  * @param ptr pointer to list element struct which is used to store
397  *    the next node during the loop
398  */
399 #define list_for_element_range_safe(first_element, last_element, element, list_member, ptr) \
400   for (element = (first_element), ptr = list_next_element(first_element, list_member); \
401        element->list_member.prev != &(last_element)->list_member; \
402        element = ptr, ptr = list_next_element(ptr, list_member))
403
404 /**
405  * Loop over a block of elements of a list backwards, used similar to a for() command.
406  * This loop can be used if the current element might be removed from
407  * the list during the loop. Other elements should not be removed during
408  * the loop.
409  *
410  * @param first_element first element of range (will be last returned by the loop)
411  * @param last_element last element of range (will be first returned by the loop)
412  * @param element iterator pointer to list element struct
413  * @param list_member name of list_entity within list element struct
414  * @param ptr pointer to list element struct which is used to store
415  *    the previous node during the loop
416  */
417 #define list_for_element_range_reverse_safe(first_element, last_element, element, list_member, ptr) \
418   for (element = (last_element), ptr = list_prev_element(last_element, list_member); \
419        element->list_member.next != &(first_element)->list_member; \
420        element = ptr, ptr = list_prev_element(ptr, list_member))
421
422 /**
423  * Loop over all elements of a list, used similar to a for() command.
424  * This loop can be used if the current element might be removed from
425  * the list during the loop. Other elements should not be removed during
426  * the loop.
427  *
428  * @param head pointer to list-head
429  * @param element pointer to a node of the list, this element will
430  *    contain the current node of the list during the loop
431  * @param list_member name of the list_entity element inside the
432  *    larger struct
433  * @param ptr pointer to an list element struct which is used to store
434  *    the next node during the loop
435  */
436 #define list_for_each_element_safe(head, element, list_member, ptr) \
437   list_for_element_range_safe(list_first_element(head, element, list_member), \
438                               list_last_element(head, element, list_member), \
439                               element, list_member, ptr)
440
441 /**
442  * Loop over all elements of a list backwards, used similar to a for() command.
443  * This loop can be used if the current element might be removed from
444  * the list during the loop. Other elements should not be removed during
445  * the loop.
446  *
447  * @param head pointer to list-head
448  * @param element pointer to a node of the list, this element will
449  *    contain the current node of the list during the loop
450  * @param list_member name of the list_entity element inside the
451  *    larger struct
452  * @param ptr pointer to an list element struct which is used to store
453  *    the next node during the loop
454  */
455 #define list_for_each_element_reverse_safe(head, element, list_member, ptr) \
456   list_for_element_range_reverse_safe(list_first_element(head, element, list_member), \
457                                       list_last_element(head, element, list_member), \
458                                       element, list_member, ptr)
459
460 #endif /* LIST_H_ */