multipath-tools: add alias_prefix to multipath.conf.5
[multipath-tools/.git] / libmultipath / list.h
1 /*
2  * Copied from the Linux kernel source tree, version 2.6.0-test1.
3  *
4  * Licensed under the GPL v2 as per the whole kernel source tree.
5  *
6  */
7
8 #ifndef _LIST_H
9 #define _LIST_H
10
11 #include <stddef.h>
12
13 /**
14  * container_of - cast a member of a structure out to the containing structure
15  *
16  * @ptr:        the pointer to the member.
17  * @type:       the type of the container struct this is embedded in.
18  * @member:     the name of the member within the struct.
19  *
20  */
21 #define container_of(ptr, type, member) ({                      \
22         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
23         (type *)( (char *)__mptr - offsetof(type,member) );})
24
25 /*
26  * These are non-NULL pointers that will result in page faults
27  * under normal circumstances, used to verify that nobody uses
28  * non-initialized list entries.
29  */
30 #define LIST_POISON1  ((void *) 0x00100100)
31 #define LIST_POISON2  ((void *) 0x00200200)
32
33 /*
34  * Simple doubly linked list implementation.
35  *
36  * Some of the internal functions ("__xxx") are useful when
37  * manipulating whole lists rather than single entries, as
38  * sometimes we already know the next/prev entries and we can
39  * generate better code by using them directly rather than
40  * using the generic single-entry routines.
41  */
42
43 struct list_head {
44         struct list_head *next, *prev;
45 };
46
47 #define LIST_HEAD_INIT(name) { &(name), &(name) }
48
49 #define LIST_HEAD(name) \
50         struct list_head name = LIST_HEAD_INIT(name)
51
52 #define INIT_LIST_HEAD(ptr) do { \
53         (ptr)->next = (ptr); (ptr)->prev = (ptr); \
54 } while (0)
55
56 /*
57  * Insert a new entry between two known consecutive entries.
58  *
59  * This is only for internal list manipulation where we know
60  * the prev/next entries already!
61  */
62 static inline void __list_add(struct list_head *new,
63                               struct list_head *prev,
64                               struct list_head *next)
65 {
66         next->prev = new;
67         new->next = next;
68         new->prev = prev;
69         prev->next = new;
70 }
71
72 /**
73  * list_add - add a new entry
74  * @new: new entry to be added
75  * @head: list head to add it after
76  *
77  * Insert a new entry after the specified head.
78  * This is good for implementing stacks.
79  */
80 static inline void list_add(struct list_head *new, struct list_head *head)
81 {
82         __list_add(new, head, head->next);
83 }
84
85 /**
86  * list_add_tail - add a new entry
87  * @new: new entry to be added
88  * @head: list head to add it before
89  *
90  * Insert a new entry before the specified head.
91  * This is useful for implementing queues.
92  */
93 static inline void list_add_tail(struct list_head *new, struct list_head *head)
94 {
95         __list_add(new, head->prev, head);
96 }
97
98 /*
99  * Delete a list entry by making the prev/next entries
100  * point to each other.
101  *
102  * This is only for internal list manipulation where we know
103  * the prev/next entries already!
104  */
105 static inline void __list_del(struct list_head * prev, struct list_head * next)
106 {
107         next->prev = prev;
108         prev->next = next;
109 }
110
111 /**
112  * list_del - deletes entry from list.
113  * @entry: the element to delete from the list.
114  * Note: list_empty on entry does not return true after this, the entry is
115  * in an undefined state.
116  */
117 static inline void list_del(struct list_head *entry)
118 {
119         __list_del(entry->prev, entry->next);
120         entry->next = LIST_POISON1;
121         entry->prev = LIST_POISON2;
122 }
123
124 /**
125  * list_del_init - deletes entry from list and reinitialize it.
126  * @entry: the element to delete from the list.
127  */
128 static inline void list_del_init(struct list_head *entry)
129 {
130         __list_del(entry->prev, entry->next);
131         INIT_LIST_HEAD(entry);
132 }
133
134 /**
135  * list_move - delete from one list and add as another's head
136  * @list: the entry to move
137  * @head: the head that will precede our entry
138  */
139 static inline void list_move(struct list_head *list, struct list_head *head)
140 {
141         __list_del(list->prev, list->next);
142         list_add(list, head);
143 }
144
145 /**
146  * list_move_tail - delete from one list and add as another's tail
147  * @list: the entry to move
148  * @head: the head that will follow our entry
149  */
150 static inline void list_move_tail(struct list_head *list,
151                                   struct list_head *head)
152 {
153         __list_del(list->prev, list->next);
154         list_add_tail(list, head);
155 }
156
157 /**
158  * list_empty - tests whether a list is empty
159  * @head: the list to test.
160  */
161 static inline int list_empty(struct list_head *head)
162 {
163         return head->next == head;
164 }
165
166 static inline void __list_splice(const struct list_head *list,
167                                  struct list_head *prev,
168                                  struct list_head *next)
169 {
170         struct list_head *first = list->next;
171         struct list_head *last = list->prev;
172
173         first->prev = prev;
174         prev->next = first;
175
176         last->next = next;
177         next->prev = last;
178 }
179
180 /**
181  * list_splice - join two lists
182  * @list: the new list to add.
183  * @head: the place to add it in the first list.
184  */
185 static inline void list_splice(struct list_head *list, struct list_head *head)
186 {
187         if (!list_empty(list))
188                 __list_splice(list, head, head->next);
189 }
190
191 /**
192  * list_splice_tail - join two lists, each list being a queue
193  * @list: the new list to add.
194  * @head: the place to add it in the first list.
195  */
196 static inline void list_splice_tail(struct list_head *list,
197                                     struct list_head *head)
198 {
199         if (!list_empty(list))
200                 __list_splice(list, head->prev, head);
201 }
202
203 /**
204  * list_splice_init - join two lists and reinitialise the emptied list.
205  * @list: the new list to add.
206  * @head: the place to add it in the first list.
207  *
208  * The list at @list is reinitialised
209  */
210 static inline void list_splice_init(struct list_head *list,
211                                     struct list_head *head)
212 {
213         if (!list_empty(list)) {
214                 __list_splice(list, head, head->next);
215                 INIT_LIST_HEAD(list);
216         }
217 }
218
219 /**
220  * list_splice_tail_init - join two lists and reinitialise the emptied list
221  * @list: the new list to add.
222  * @head: the place to add it in the first list.
223  *
224  * Each of the lists is a queue.
225  * The list at @list is reinitialised
226  */
227 static inline void list_splice_tail_init(struct list_head *list,
228                                          struct list_head *head)
229 {
230         if (!list_empty(list)) {
231                 __list_splice(list, head->prev, head);
232                 INIT_LIST_HEAD(list);
233         }
234 }
235
236 /**
237  * list_entry - get the struct for this entry
238  * @ptr:        the &struct list_head pointer.
239  * @type:       the type of the struct this is embedded in.
240  * @member:     the name of the list_struct within the struct.
241  */
242 #define list_entry(ptr, type, member) \
243         container_of(ptr, type, member)
244
245 /**
246  * list_for_each        -       iterate over a list
247  * @pos:        the &struct list_head to use as a loop counter.
248  * @head:       the head for your list.
249  */
250 #define list_for_each(pos, head) \
251         for (pos = (head)->next; pos != (head); \
252                 pos = pos->next)
253
254 /**
255  * __list_for_each      -       iterate over a list
256  * @pos:        the &struct list_head to use as a loop counter.
257  * @head:       the head for your list.
258  *
259  * This variant differs from list_for_each() in that it's the
260  * simplest possible list iteration code.
261  * Use this for code that knows the list to be very short (empty
262  * or 1 entry) most of the time.
263  */
264 #define __list_for_each(pos, head) \
265         for (pos = (head)->next; pos != (head); pos = pos->next)
266
267 /**
268  * list_for_each_prev   -       iterate over a list backwards
269  * @pos:        the &struct list_head to use as a loop counter.
270  * @head:       the head for your list.
271  */
272 #define list_for_each_prev(pos, head) \
273         for (pos = (head)->prev; pos != (head); pos = pos->prev)
274
275 /**
276  * list_for_each_safe   -       iterate over a list safe against removal of list entry
277  * @pos:        the &struct list_head to use as a loop counter.
278  * @n:          another &struct list_head to use as temporary storage
279  * @head:       the head for your list.
280  */
281 #define list_for_each_safe(pos, n, head) \
282         for (pos = (head)->next, n = pos->next; pos != (head); \
283                 pos = n, n = pos->next)
284
285 /**
286  * list_for_each_entry  -       iterate over list of given type
287  * @pos:        the type * to use as a loop counter.
288  * @head:       the head for your list.
289  * @member:     the name of the list_struct within the struct.
290  */
291 #define list_for_each_entry(pos, head, member)                          \
292         for (pos = list_entry((head)->next, typeof(*pos), member);      \
293              &pos->member != (head);                                    \
294              pos = list_entry(pos->member.next, typeof(*pos), member))
295
296 /**
297  * list_for_each_entry_reverse - iterate backwards over list of given type.
298  * @pos:        the type * to use as a loop counter.
299  * @head:       the head for your list.
300  * @member:     the name of the list_struct within the struct.
301  */
302 #define list_for_each_entry_reverse(pos, head, member)                  \
303         for (pos = list_entry((head)->prev, typeof(*pos), member);      \
304              &pos->member != (head);                                    \
305              pos = list_entry(pos->member.prev, typeof(*pos), member))
306
307 /**
308  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
309  * @pos:        the type * to use as a loop counter.
310  * @n:          another type * to use as temporary storage
311  * @head:       the head for your list.
312  * @member:     the name of the list_struct within the struct.
313  */
314 #define list_for_each_entry_safe(pos, n, head, member)                  \
315         for (pos = list_entry((head)->next, typeof(*pos), member),      \
316                 n = list_entry(pos->member.next, typeof(*pos), member); \
317              &pos->member != (head);                                    \
318              pos = n, n = list_entry(n->member.next, typeof(*n), member))
319
320 #endif /* _LIST_H */