hardlink.c: Fix some error paths
[wimlib] / include / wimlib / 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_del_init - deletes entry from list and reinitialize it.
115  * @entry: the element to delete from the list.
116  */
117 static inline void list_del_init(struct list_head *entry)
118 {
119         list_del(entry);
120         INIT_LIST_HEAD(entry);
121 }
122
123 /**
124  * list_empty - tests whether a list is empty
125  * @head: the list to test.
126  */
127 static inline int list_empty(const struct list_head *head)
128 {
129         return head->next == head;
130 }
131
132 static inline void __list_splice(const struct list_head *list,
133                                  struct list_head *prev,
134                                  struct list_head *next)
135 {
136         struct list_head *first = list->next;
137         struct list_head *last = list->prev;
138
139         first->prev = prev;
140         prev->next = first;
141
142         last->next = next;
143         next->prev = last;
144 }
145
146 /**
147  * list_splice - join two lists, this is designed for stacks
148  * @list: the new list to add.
149  * @head: the place to add it in the first list.
150  */
151 static inline void list_splice(const struct list_head *list,
152                                 struct list_head *head)
153 {
154         if (!list_empty(list))
155                 __list_splice(list, head, head->next);
156 }
157
158 /* Move the entire list @old to the list @new, overwriting it. */
159 static inline void list_transfer(struct list_head *old,
160                                  struct list_head *new)
161 {
162         struct list_head *prev, *next;
163
164         if (list_empty(old)) {
165                 INIT_LIST_HEAD(new);
166         } else {
167                 prev = old->prev;
168                 next = old->next;
169                 new->next = next;
170                 new->prev = prev;
171                 prev->next = new;
172                 next->prev = new;
173         }
174 }
175
176 /**
177  * list_move - delete from one list and add as another's head
178  * @list: the entry to move
179  * @head: the head that will precede our entry
180  */
181 static inline void list_move(struct list_head *list, struct list_head *head)
182 {
183         list_del(list);
184         list_add(list, head);
185 }
186
187 /**
188  * list_move_tail - delete from one list and add as another's tail
189  * @list: the entry to move
190  * @head: the head that will follow our entry
191  */
192 static inline void list_move_tail(struct list_head *list,
193                                   struct list_head *head)
194 {
195         list_del(list);
196         list_add_tail(list, head);
197 }
198
199 /**
200  * list_splice_tail - join two lists, each list being a queue
201  * @list: the new list to add.
202  * @head: the place to add it in the first list.
203  */
204 static inline void list_splice_tail(struct list_head *list,
205                                 struct list_head *head)
206 {
207         if (!list_empty(list))
208                 __list_splice(list, head->prev, head);
209 }
210
211 /**
212  * list_entry - get the struct for this entry
213  * @ptr:        the &struct list_head pointer.
214  * @type:       the type of the struct this is embedded in.
215  * @member:     the name of the list_struct within the struct.
216  */
217 #define list_entry(ptr, type, member) \
218         container_of(ptr, type, member)
219
220 /**
221  * list_for_each        -       iterate over a list
222  * @pos:        the &struct list_head to use as a loop cursor.
223  * @head:       the head for your list.
224  */
225 #define list_for_each(pos, head) \
226         for (pos = (head)->next; pos != (head); pos = pos->next)
227
228 /**
229  * list_for_each_safe - iterate over a list safe against removal of list entry
230  * @pos:        the &struct list_head to use as a loop cursor.
231  * @n:          another &struct list_head to use as temporary storage
232  * @head:       the head for your list.
233  */
234 #define list_for_each_safe(pos, n, head) \
235         for (pos = (head)->next, n = pos->next; pos != (head); \
236                 pos = n, n = pos->next)
237
238 /**
239  * list_for_each_entry  -       iterate over list of given type
240  * @pos:        the type * to use as a loop cursor.
241  * @head:       the head for your list.
242  * @member:     the name of the list_struct within the struct.
243  */
244 #define list_for_each_entry(pos, head, member)                          \
245         for (pos = list_entry((head)->next, typeof(*pos), member);      \
246              &pos->member != (head);    \
247              pos = list_entry(pos->member.next, typeof(*pos), member))
248
249 /**
250  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
251  * @pos:        the type * to use as a loop cursor.
252  * @n:          another type * to use as temporary storage
253  * @head:       the head for your list.
254  * @member:     the name of the list_struct within the struct.
255  */
256 #define list_for_each_entry_safe(pos, n, head, member)                  \
257         for (pos = list_entry((head)->next, typeof(*pos), member),      \
258                 n = list_entry(pos->member.next, typeof(*pos), member); \
259              &pos->member != (head);                                    \
260              pos = n, n = list_entry(n->member.next, typeof(*n), member))
261
262 /*
263  * Double linked lists with a single pointer list head.
264  * Mostly useful for hash tables where the two pointer list head is
265  * too wasteful.
266  * You lose the ability to access the tail in O(1).
267  */
268
269 #define HLIST_HEAD_INIT { .first = NULL }
270 #define HLIST_HEAD(name) struct hlist_head name = {  .first = NULL }
271 #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
272 static inline void INIT_HLIST_NODE(struct hlist_node *h)
273 {
274         h->next = NULL;
275         h->pprev = NULL;
276 }
277
278 static inline int hlist_unhashed(const struct hlist_node *h)
279 {
280         return !h->pprev;
281 }
282
283 static inline int hlist_empty(const struct hlist_head *h)
284 {
285         return !h->first;
286 }
287
288 static inline void __hlist_del(struct hlist_node *n)
289 {
290         struct hlist_node *next = n->next;
291         struct hlist_node **pprev = n->pprev;
292         *pprev = next;
293         if (next)
294                 next->pprev = pprev;
295 }
296
297 static inline void hlist_del(struct hlist_node *n)
298 {
299         __hlist_del(n);
300 #if 0
301         n->next = LIST_POISON1;
302         n->pprev = LIST_POISON2;
303 #endif
304 }
305
306 static inline void hlist_del_init(struct hlist_node *n)
307 {
308         if (!hlist_unhashed(n)) {
309                 __hlist_del(n);
310                 INIT_HLIST_NODE(n);
311         }
312 }
313
314 static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
315 {
316         struct hlist_node *first = h->first;
317         n->next = first;
318         if (first)
319                 first->pprev = &n->next;
320         h->first = n;
321         n->pprev = &h->first;
322 }
323
324 #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
325
326 #define hlist_for_each(pos, head) \
327         for (pos = (head)->first; pos ; pos = pos->next)
328
329 #define hlist_for_each_safe(pos, n, head) \
330         for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
331              pos = n)
332
333 /**
334  * hlist_for_each_entry - iterate over list of given type
335  * @tpos:       the type * to use as a loop cursor.
336  * @pos:        the &struct hlist_node to use as a loop cursor.
337  * @head:       the head for your list.
338  * @member:     the name of the hlist_node within the struct.
339  */
340 #define hlist_for_each_entry(tpos, pos, head, member)                    \
341         for (pos = (head)->first;                                        \
342              pos &&                                                      \
343                 ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
344              pos = pos->next)
345
346 /**
347  * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
348  * @tpos:       the type * to use as a loop cursor.
349  * @pos:        the &struct hlist_node to use as a loop cursor.
350  * @n:          another &struct hlist_node to use as temporary storage
351  * @head:       the head for your list.
352  * @member:     the name of the hlist_node within the struct.
353  */
354 #define hlist_for_each_entry_safe(tpos, pos, n, head, member)            \
355         for (pos = (head)->first;                                        \
356              pos && ({ n = pos->next; 1; }) &&                           \
357                 ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
358              pos = n)
359
360 #endif