2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice unmodified, this list of conditions, and the following
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef _LINUX_LIST_H_
32 #define _LINUX_LIST_H_
35 * Since LIST_HEAD conflicts with the linux definition we must include any
36 * FreeBSD header which requires it here so it is resolved with the correct
37 * definition prior to the undef.
39 #include <linux/types.h>
41 #include <sys/param.h>
42 #include <sys/kernel.h>
43 #include <sys/queue.h>
44 #include <sys/cpuset.h>
47 #include <sys/mutex.h>
49 #include <sys/vnode.h>
51 #include <sys/socket.h>
56 #include <net/if_var.h>
57 #include <net/if_types.h>
58 #include <net/if_media.h>
61 #include <netinet/in.h>
62 #include <netinet/in_pcb.h>
63 #include <netinet/in_var.h>
64 #include <netinet/tcp_lro.h>
66 #include <netinet6/in6_var.h>
67 #include <netinet6/nd6.h>
70 #include <vm/vm_object.h>
76 struct list_head *next;
77 struct list_head *prev;
81 INIT_LIST_HEAD(struct list_head *list)
84 list->next = list->prev = list;
88 list_empty(const struct list_head *head)
91 return (head->next == head);
95 list_del(struct list_head *entry)
98 entry->next->prev = entry->prev;
99 entry->prev->next = entry->next;
103 list_replace(struct list_head *old, struct list_head *new)
105 new->next = old->next;
106 new->next->prev = new;
107 new->prev = old->prev;
108 new->prev->next = new;
112 list_replace_init(struct list_head *old, struct list_head *new)
114 list_replace(old, new);
119 linux_list_add(struct list_head *new, struct list_head *prev,
120 struct list_head *next)
130 list_del_init(struct list_head *entry)
134 INIT_LIST_HEAD(entry);
137 #define list_entry(ptr, type, field) container_of(ptr, type, field)
139 #define list_first_entry(ptr, type, member) \
140 list_entry((ptr)->next, type, member)
142 #define list_last_entry(ptr, type, member) \
143 list_entry((ptr)->prev, type, member)
145 #define list_first_entry_or_null(ptr, type, member) \
146 (!list_empty(ptr) ? list_first_entry(ptr, type, member) : NULL)
148 #define list_next_entry(ptr, member) \
149 list_entry(((ptr)->member.next), typeof(*(ptr)), member)
151 #define list_prev_entry(ptr, member) \
152 list_entry(((ptr)->member.prev), typeof(*(ptr)), member)
154 #define list_for_each(p, head) \
155 for (p = (head)->next; p != (head); p = (p)->next)
157 #define list_for_each_safe(p, n, head) \
158 for (p = (head)->next, n = (p)->next; p != (head); p = n, n = (p)->next)
160 #define list_for_each_entry(p, h, field) \
161 for (p = list_entry((h)->next, typeof(*p), field); &(p)->field != (h); \
162 p = list_entry((p)->field.next, typeof(*p), field))
164 #define list_for_each_entry_safe(p, n, h, field) \
165 for (p = list_entry((h)->next, typeof(*p), field), \
166 n = list_entry((p)->field.next, typeof(*p), field); &(p)->field != (h);\
167 p = n, n = list_entry(n->field.next, typeof(*n), field))
169 #define list_for_each_entry_from(p, h, field) \
170 for ( ; &(p)->field != (h); \
171 p = list_entry((p)->field.next, typeof(*p), field))
173 #define list_for_each_entry_continue(p, h, field) \
174 for (p = list_next_entry((p), field); &(p)->field != (h); \
175 p = list_next_entry((p), field))
177 #define list_for_each_entry_safe_from(pos, n, head, member) \
178 for (n = list_entry((pos)->member.next, typeof(*pos), member); \
179 &(pos)->member != (head); \
180 pos = n, n = list_entry(n->member.next, typeof(*n), member))
182 #define list_for_each_entry_reverse(p, h, field) \
183 for (p = list_entry((h)->prev, typeof(*p), field); &(p)->field != (h); \
184 p = list_entry((p)->field.prev, typeof(*p), field))
186 #define list_for_each_entry_continue_reverse(p, h, field) \
187 for (p = list_entry((p)->field.prev, typeof(*p), field); &(p)->field != (h); \
188 p = list_entry((p)->field.prev, typeof(*p), field))
190 #define list_for_each_prev(p, h) for (p = (h)->prev; p != (h); p = (p)->prev)
193 list_add(struct list_head *new, struct list_head *head)
196 linux_list_add(new, head, head->next);
200 list_add_tail(struct list_head *new, struct list_head *head)
203 linux_list_add(new, head->prev, head);
207 list_move(struct list_head *list, struct list_head *head)
211 list_add(list, head);
215 list_move_tail(struct list_head *entry, struct list_head *head)
219 list_add_tail(entry, head);
223 linux_list_splice(const struct list_head *list, struct list_head *prev,
224 struct list_head *next)
226 struct list_head *first;
227 struct list_head *last;
229 if (list_empty(list))
240 list_splice(const struct list_head *list, struct list_head *head)
243 linux_list_splice(list, head, head->next);
247 list_splice_tail(struct list_head *list, struct list_head *head)
250 linux_list_splice(list, head->prev, head);
254 list_splice_init(struct list_head *list, struct list_head *head)
257 linux_list_splice(list, head, head->next);
258 INIT_LIST_HEAD(list);
262 list_splice_tail_init(struct list_head *list, struct list_head *head)
265 linux_list_splice(list, head->prev, head);
266 INIT_LIST_HEAD(list);
270 #define LIST_HEAD(name) struct list_head name = { &(name), &(name) }
274 struct hlist_node *first;
278 struct hlist_node *next, **pprev;
281 #define HLIST_HEAD_INIT { }
282 #define HLIST_HEAD(name) struct hlist_head name = HLIST_HEAD_INIT
283 #define INIT_HLIST_HEAD(head) (head)->first = NULL
284 #define INIT_HLIST_NODE(node) \
286 (node)->next = NULL; \
287 (node)->pprev = NULL; \
291 hlist_unhashed(const struct hlist_node *h)
298 hlist_empty(const struct hlist_head *h)
305 hlist_del(struct hlist_node *n)
309 n->next->pprev = n->pprev;
314 hlist_del_init(struct hlist_node *n)
317 if (hlist_unhashed(n))
324 hlist_add_head(struct hlist_node *n, struct hlist_head *h)
329 h->first->pprev = &n->next;
331 n->pprev = &h->first;
335 hlist_add_before(struct hlist_node *n, struct hlist_node *next)
338 n->pprev = next->pprev;
340 next->pprev = &n->next;
345 hlist_add_after(struct hlist_node *n, struct hlist_node *next)
348 next->next = n->next;
350 next->pprev = &n->next;
352 next->next->pprev = &next->next;
356 hlist_move_list(struct hlist_head *old, struct hlist_head *new)
359 new->first = old->first;
361 new->first->pprev = &new->first;
366 * list_is_singular - tests whether a list has just one entry.
367 * @head: the list to test.
369 static inline int list_is_singular(const struct list_head *head)
371 return !list_empty(head) && (head->next == head->prev);
374 static inline void __list_cut_position(struct list_head *list,
375 struct list_head *head, struct list_head *entry)
377 struct list_head *new_first = entry->next;
378 list->next = head->next;
379 list->next->prev = list;
382 head->next = new_first;
383 new_first->prev = head;
387 * list_cut_position - cut a list into two
388 * @list: a new list to add all removed entries
389 * @head: a list with entries
390 * @entry: an entry within head, could be the head itself
391 * and if so we won't cut the list
393 * This helper moves the initial part of @head, up to and
394 * including @entry, from @head to @list. You should
395 * pass on @entry an element you know is on @head. @list
396 * should be an empty list or a list you do not care about
400 static inline void list_cut_position(struct list_head *list,
401 struct list_head *head, struct list_head *entry)
403 if (list_empty(head))
405 if (list_is_singular(head) &&
406 (head->next != entry && head != entry))
409 INIT_LIST_HEAD(list);
411 __list_cut_position(list, head, entry);
415 * list_is_last - tests whether @list is the last entry in list @head
416 * @list: the entry to test
417 * @head: the head of the list
419 static inline int list_is_last(const struct list_head *list,
420 const struct list_head *head)
422 return list->next == head;
425 #define hlist_entry(ptr, type, field) container_of(ptr, type, field)
427 #define hlist_for_each(p, head) \
428 for (p = (head)->first; p; p = (p)->next)
430 #define hlist_for_each_safe(p, n, head) \
431 for (p = (head)->first; p && ({ n = (p)->next; 1; }); p = n)
433 #define hlist_entry_safe(ptr, type, member) \
434 ((ptr) ? hlist_entry(ptr, type, member) : NULL)
436 #define hlist_for_each_entry(pos, head, member) \
437 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\
439 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
441 #define hlist_for_each_entry_continue(pos, member) \
442 for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member); \
444 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
446 #define hlist_for_each_entry_from(pos, member) \
448 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
450 #define hlist_for_each_entry_safe(pos, n, head, member) \
451 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member); \
452 (pos) && ({ n = (pos)->member.next; 1; }); \
453 pos = hlist_entry_safe(n, typeof(*(pos)), member))
455 extern void list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv,
456 struct list_head *a, struct list_head *b));
458 #endif /* _LINUX_LIST_H_ */