889097b5acf36521157178f9d1e0995fce306bcc
[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 static inline void __list_splice(const struct list_head *list,
123                                  struct list_head *prev,
124                                  struct list_head *next)
125 {
126         struct list_head *first = list->next;
127         struct list_head *last = list->prev;
128
129         first->prev = prev;
130         prev->next = first;
131
132         last->next = next;
133         next->prev = last;
134 }
135
136 /**
137  * list_splice - join two lists, this is designed for stacks
138  * @list: the new list to add.
139  * @head: the place to add it in the first list.
140  */
141 static inline void list_splice(const struct list_head *list,
142                                 struct list_head *head)
143 {
144         if (!list_empty(list))
145                 __list_splice(list, head, head->next);
146 }
147
148 /**
149  * list_splice_tail - join two lists, each list being a queue
150  * @list: the new list to add.
151  * @head: the place to add it in the first list.
152  */
153 static inline void list_splice_tail(struct list_head *list,
154                                 struct list_head *head)
155 {
156         if (!list_empty(list))
157                 __list_splice(list, head->prev, head);
158 }
159
160 /**
161  * list_entry - get the struct for this entry
162  * @ptr:        the &struct list_head pointer.
163  * @type:       the type of the struct this is embedded in.
164  * @member:     the name of the list_struct within the struct.
165  */
166 #define list_entry(ptr, type, member) \
167         container_of(ptr, type, member)
168
169 /**
170  * list_for_each        -       iterate over a list
171  * @pos:        the &struct list_head to use as a loop cursor.
172  * @head:       the head for your list.
173  */
174 #define list_for_each(pos, head) \
175         for (pos = (head)->next; pos != (head); pos = pos->next)
176
177 /**
178  * list_for_each_safe - iterate over a list safe against removal of list entry
179  * @pos:        the &struct list_head to use as a loop cursor.
180  * @n:          another &struct list_head to use as temporary storage
181  * @head:       the head for your list.
182  */
183 #define list_for_each_safe(pos, n, head) \
184         for (pos = (head)->next, n = pos->next; pos != (head); \
185                 pos = n, n = pos->next)
186
187 /**
188  * list_for_each_entry  -       iterate over list of given type
189  * @pos:        the type * to use as a loop cursor.
190  * @head:       the head for your list.
191  * @member:     the name of the list_struct within the struct.
192  */
193 #define list_for_each_entry(pos, head, member)                          \
194         for (pos = list_entry((head)->next, typeof(*pos), member);      \
195              &pos->member != (head);    \
196              pos = list_entry(pos->member.next, typeof(*pos), member))
197
198 /**
199  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
200  * @pos:        the type * to use as a loop cursor.
201  * @n:          another type * to use as temporary storage
202  * @head:       the head for your list.
203  * @member:     the name of the list_struct within the struct.
204  */
205 #define list_for_each_entry_safe(pos, n, head, member)                  \
206         for (pos = list_entry((head)->next, typeof(*pos), member),      \
207                 n = list_entry(pos->member.next, typeof(*pos), member); \
208              &pos->member != (head);                                    \
209              pos = n, n = list_entry(n->member.next, typeof(*n), member))
210
211 /*
212  * Double linked lists with a single pointer list head.
213  * Mostly useful for hash tables where the two pointer list head is
214  * too wasteful.
215  * You lose the ability to access the tail in O(1).
216  */
217
218 #define HLIST_HEAD_INIT { .first = NULL }
219 #define HLIST_HEAD(name) struct hlist_head name = {  .first = NULL }
220 #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
221 static inline void INIT_HLIST_NODE(struct hlist_node *h)
222 {
223         h->next = NULL;
224         h->pprev = NULL;
225 }
226
227 static inline void hlist_del(struct hlist_node *n)
228 {
229         struct hlist_node *next = n->next;
230         struct hlist_node **pprev = n->pprev;
231         *pprev = next;
232         if (next)
233                 next->pprev = pprev;
234 }
235
236 static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
237 {
238         struct hlist_node *first = h->first;
239         n->next = first;
240         if (first)
241                 first->pprev = &n->next;
242         h->first = n;
243         n->pprev = &h->first;
244 }
245
246 #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
247
248 #define hlist_for_each(pos, head) \
249         for (pos = (head)->first; pos ; pos = pos->next)
250
251 #define hlist_for_each_safe(pos, n, head) \
252         for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
253              pos = n)
254
255 /**
256  * hlist_for_each_entry - iterate over list of given type
257  * @tpos:       the type * to use as a loop cursor.
258  * @pos:        the &struct hlist_node to use as a loop cursor.
259  * @head:       the head for your list.
260  * @member:     the name of the hlist_node within the struct.
261  */
262 #define hlist_for_each_entry(tpos, pos, head, member)                    \
263         for (pos = (head)->first;                                        \
264              pos &&                                                      \
265                 ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
266              pos = pos->next)
267
268 /**
269  * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
270  * @tpos:       the type * to use as a loop cursor.
271  * @pos:        the &struct hlist_node to use as a loop cursor.
272  * @n:          another &struct hlist_node to use as temporary storage
273  * @head:       the head for your list.
274  * @member:     the name of the hlist_node within the struct.
275  */
276 #define hlist_for_each_entry_safe(tpos, pos, n, head, member)            \
277         for (pos = (head)->first;                                        \
278              pos && ({ n = pos->next; 1; }) &&                           \
279                 ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
280              pos = n)
281
282 #endif