Various code cleanups
[wimlib] / src / list.h
1
2 /*
3  * This file is based on include/linux/list.h in the Linux kernel source code.
4  */
5
6 #ifndef _LINUX_LIST_H
7 #define _LINUX_LIST_H
8
9 #include <stddef.h>
10
11 struct list_head {
12         struct list_head *next, *prev;
13 };
14 struct hlist_head {
15         struct hlist_node *first;
16 };
17
18 struct hlist_node {
19         struct hlist_node *next, **pprev;
20 };
21
22 /*
23  * Simple doubly linked list implementation.
24  *
25  * Some of the internal functions ("__xxx") are useful when
26  * manipulating whole lists rather than single entries, as
27  * sometimes we already know the next/prev entries and we can
28  * generate better code by using them directly rather than
29  * using the generic single-entry routines.
30  */
31
32 #define LIST_HEAD_INIT(name) { &(name), &(name) }
33
34 #ifdef LIST_HEAD /* BSD sys/queue.h defines this... */
35 #undef LIST_HEAD
36 #endif
37
38 #define LIST_HEAD(name) \
39         struct list_head name = LIST_HEAD_INIT(name)
40
41 static inline void INIT_LIST_HEAD(struct list_head *list)
42 {
43         list->next = list;
44         list->prev = list;
45 }
46
47 /*
48  * Insert a new entry between two known consecutive entries.
49  *
50  * This is only for internal list manipulation where we know
51  * the prev/next entries already!
52  */
53 static inline void __list_add(struct list_head *new,
54                               struct list_head *prev,
55                               struct list_head *next)
56 {
57         next->prev = new;
58         new->next = next;
59         new->prev = prev;
60         prev->next = new;
61 }
62
63 /**
64  * list_add - add a new entry
65  * @new: new entry to be added
66  * @head: list head to add it after
67  *
68  * Insert a new entry after the specified head.
69  * This is good for implementing stacks.
70  */
71 static inline void list_add(struct list_head *new, struct list_head *head)
72 {
73         __list_add(new, head, head->next);
74 }
75
76 /**
77  * list_add_tail - add a new entry
78  * @new: new entry to be added
79  * @head: list head to add it before
80  *
81  * Insert a new entry before the specified head.
82  * This is useful for implementing queues.
83  */
84 static inline void list_add_tail(struct list_head *new, struct list_head *head)
85 {
86         __list_add(new, head->prev, head);
87 }
88
89 /*
90  * Delete a list entry by making the prev/next entries
91  * point to each other.
92  *
93  * This is only for internal list manipulation where we know
94  * the prev/next entries already!
95  */
96 static inline void __list_del(struct list_head * prev, struct list_head * next)
97 {
98         next->prev = prev;
99         prev->next = next;
100 }
101
102 /**
103  * list_del - deletes entry from list.
104  * @entry: the element to delete from the list.
105  * Note: list_empty() on entry does not return true after this, the entry is
106  * in an undefined state.
107  */
108 static inline void list_del(struct list_head *entry)
109 {
110         __list_del(entry->prev, entry->next);
111 }
112
113 /**
114  * list_empty - tests whether a list is empty
115  * @head: the list to test.
116  */
117 static inline int list_empty(const struct list_head *head)
118 {
119         return head->next == head;
120 }
121
122 /**
123  * list_entry - get the struct for this entry
124  * @ptr:        the &struct list_head pointer.
125  * @type:       the type of the struct this is embedded in.
126  * @member:     the name of the list_struct within the struct.
127  */
128 #define list_entry(ptr, type, member) \
129         container_of(ptr, type, member)
130
131 /**
132  * list_for_each        -       iterate over a list
133  * @pos:        the &struct list_head to use as a loop cursor.
134  * @head:       the head for your list.
135  */
136 #define list_for_each(pos, head) \
137         for (pos = (head)->next; pos != (head); pos = pos->next)
138
139 /**
140  * list_for_each_safe - iterate over a list safe against removal of list entry
141  * @pos:        the &struct list_head to use as a loop cursor.
142  * @n:          another &struct list_head to use as temporary storage
143  * @head:       the head for your list.
144  */
145 #define list_for_each_safe(pos, n, head) \
146         for (pos = (head)->next, n = pos->next; pos != (head); \
147                 pos = n, n = pos->next)
148
149 /**
150  * list_for_each_entry  -       iterate over list of given type
151  * @pos:        the type * to use as a loop cursor.
152  * @head:       the head for your list.
153  * @member:     the name of the list_struct within the struct.
154  */
155 #define list_for_each_entry(pos, head, member)                          \
156         for (pos = list_entry((head)->next, typeof(*pos), member);      \
157              &pos->member != (head);    \
158              pos = list_entry(pos->member.next, typeof(*pos), member))
159
160 /**
161  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
162  * @pos:        the type * to use as a loop cursor.
163  * @n:          another type * to use as temporary storage
164  * @head:       the head for your list.
165  * @member:     the name of the list_struct within the struct.
166  */
167 #define list_for_each_entry_safe(pos, n, head, member)                  \
168         for (pos = list_entry((head)->next, typeof(*pos), member),      \
169                 n = list_entry(pos->member.next, typeof(*pos), member); \
170              &pos->member != (head);                                    \
171              pos = n, n = list_entry(n->member.next, typeof(*n), member))
172
173 /*
174  * Double linked lists with a single pointer list head.
175  * Mostly useful for hash tables where the two pointer list head is
176  * too wasteful.
177  * You lose the ability to access the tail in O(1).
178  */
179
180 #define HLIST_HEAD_INIT { .first = NULL }
181 #define HLIST_HEAD(name) struct hlist_head name = {  .first = NULL }
182 #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
183 static inline void INIT_HLIST_NODE(struct hlist_node *h)
184 {
185         h->next = NULL;
186         h->pprev = NULL;
187 }
188
189 static inline void hlist_del(struct hlist_node *n)
190 {
191         struct hlist_node *next = n->next;
192         struct hlist_node **pprev = n->pprev;
193         *pprev = next;
194         if (next)
195                 next->pprev = pprev;
196 }
197
198 static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
199 {
200         struct hlist_node *first = h->first;
201         n->next = first;
202         if (first)
203                 first->pprev = &n->next;
204         h->first = n;
205         n->pprev = &h->first;
206 }
207
208 #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
209
210 #define hlist_for_each(pos, head) \
211         for (pos = (head)->first; pos ; pos = pos->next)
212
213 #define hlist_for_each_safe(pos, n, head) \
214         for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
215              pos = n)
216
217 /**
218  * hlist_for_each_entry - iterate over list of given type
219  * @tpos:       the type * to use as a loop cursor.
220  * @pos:        the &struct hlist_node to use as a loop cursor.
221  * @head:       the head for your list.
222  * @member:     the name of the hlist_node within the struct.
223  */
224 #define hlist_for_each_entry(tpos, pos, head, member)                    \
225         for (pos = (head)->first;                                        \
226              pos &&                                                      \
227                 ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
228              pos = pos->next)
229
230 /**
231  * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
232  * @tpos:       the type * to use as a loop cursor.
233  * @pos:        the &struct hlist_node to use as a loop cursor.
234  * @n:          another &struct hlist_node to use as temporary storage
235  * @head:       the head for your list.
236  * @member:     the name of the hlist_node within the struct.
237  */
238 #define hlist_for_each_entry_safe(tpos, pos, n, head, member)            \
239         for (pos = (head)->first;                                        \
240              pos && ({ n = pos->next; 1; }) &&                           \
241                 ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
242              pos = n)
243
244 #endif