Remove the olsr-specific duplicated types
[olsrd.git] / src / common / list.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
4  * IPv4 performance optimization (c) 2006, sven-ola(gmx.de)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without 
8  * modification, are permitted provided that the following conditions 
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright 
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright 
14  *   notice, this list of conditions and the following disclaimer in 
15  *   the documentation and/or other materials provided with the 
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its 
18  *   contributors may be used to endorse or promote products derived 
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef _LIST_H
43 #define _LIST_H
44
45 #include "defs.h"
46
47 #include <stddef.h>
48 #include <stdlib.h>
49
50 struct list_node {
51   struct list_node *next;
52   struct list_node *prev;
53 };
54
55 /* init a circular list  */
56 static INLINE void list_head_init(struct list_node *node) \
57 { node->prev = node->next = node; }
58
59 /* clear a node  */
60 static INLINE void list_node_init(struct list_node *node) \
61 { node->prev = node->next = NULL; }
62
63 /* test if a node is on a list */
64 static INLINE int list_node_on_list(const struct list_node *node) \
65 { return node->prev != NULL || node->next != NULL; }
66
67 /* test if a list is empty */
68 static INLINE int list_is_empty(const struct list_node *node) \
69 { return node->prev == node && node->next == node; }
70
71 /* Insert at the top of the list */
72 static INLINE void list_add_after(struct list_node *pos_node, struct list_node *new_node) { \
73   new_node->next = pos_node->next; \
74   new_node->prev = pos_node; \
75  \
76   pos_node->next->prev = new_node; \
77   pos_node->next = new_node; \
78 }
79
80 /* Insert at the tail of the list */
81 static INLINE void list_add_before(struct list_node *pos_node, struct list_node *new_node) { \
82   new_node->prev = pos_node->prev; \
83   new_node->next = pos_node; \
84  \
85   pos_node->prev->next = new_node; \
86   pos_node->prev = new_node; \
87 }
88
89 static INLINE void list_remove(struct list_node *del_node) { \
90   del_node->next->prev = del_node->prev; \
91   del_node->prev->next = del_node->next; \
92  \
93   list_node_init(del_node); \
94 }
95
96 /*
97  * Merge elements of list_head2 at the end of list_head1.
98  * list_head2 will be left empty.
99  */
100 static INLINE void list_merge(struct list_node *list_head1, struct list_node *list_head2) \
101 { \
102   if (!list_is_empty(list_head2)) {  \
103      list_head1->next->prev = list_head2->prev; \
104      list_head2->prev->next = list_head1->next; \
105      list_head1->next = list_head2->next; \
106      list_head2->next->prev = list_head1; \
107      list_head2->next = list_head2->prev = list_head2; \
108   } \
109 }
110
111 /*
112  * Macro to define an inline function to map from a list_node offset back to the
113  * base of the datastructure. That way you save an extra data pointer.
114  */
115 #define LISTNODE2STRUCT(funcname, structname, listnodename) \
116 static INLINE structname * funcname (struct list_node *ptr)\
117 {\
118   return( \
119     ptr ? \
120       (structname *) (((uint8_t *) ptr) - offsetof(structname, listnodename)) : \
121       NULL); \
122 }
123
124 #endif /* _LIST_H */
125
126 /*
127  * Local Variables:
128  * c-basic-offset: 2
129  * indent-tabs-mode: nil
130  * End:
131  */