xref: /freebsd/sys/compat/linuxkpi/common/include/linux/list.h (revision acb1f1269c6f4ff89a0d28ba742f6687e9ef779d)
1 /*-
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.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
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.
17  *
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.
28  *
29  * $FreeBSD$
30  */
31 #ifndef _LINUX_LIST_H_
32 #define _LINUX_LIST_H_
33 
34 #ifndef _STANDALONE
35 /*
36  * Since LIST_HEAD conflicts with the Linux definition we must include any
37  * FreeBSD header which requires it here so it is resolved with the correct
38  * definition prior to the undef.
39  */
40 #include <linux/types.h>
41 
42 #include <sys/param.h>
43 #include <sys/kernel.h>
44 #include <sys/queue.h>
45 #include <sys/cpuset.h>
46 #include <sys/jail.h>
47 #include <sys/lock.h>
48 #include <sys/mutex.h>
49 #include <sys/proc.h>
50 #include <sys/vnode.h>
51 #include <sys/conf.h>
52 #include <sys/socket.h>
53 #include <sys/mbuf.h>
54 
55 #include <net/bpf.h>
56 #include <net/ethernet.h>
57 #include <net/if.h>
58 #include <net/if_var.h>
59 #include <net/if_types.h>
60 #include <net/if_media.h>
61 #include <net/vnet.h>
62 
63 #include <netinet/in.h>
64 #include <netinet/in_pcb.h>
65 #include <netinet/in_var.h>
66 #include <netinet/tcp_lro.h>
67 
68 #include <netinet6/in6_var.h>
69 #include <netinet6/nd6.h>
70 
71 #include <net80211/ieee80211.h>
72 #include <net80211/ieee80211_var.h>
73 #include <net80211/ieee80211_node.h>
74 
75 #include <vm/vm.h>
76 #include <vm/vm_object.h>
77 #include <vm/pmap.h>
78 #endif
79 
80 #ifndef prefetch
81 #define	prefetch(x)
82 #endif
83 
84 #define LINUX_LIST_HEAD_INIT(name) { &(name), &(name) }
85 
86 #define LINUX_LIST_HEAD(name) \
87 	struct list_head name = LINUX_LIST_HEAD_INIT(name)
88 
89 #ifndef LIST_HEAD_DEF
90 #define	LIST_HEAD_DEF
91 struct list_head {
92 	struct list_head *next;
93 	struct list_head *prev;
94 };
95 #endif
96 
97 static inline void
98 INIT_LIST_HEAD(struct list_head *list)
99 {
100 
101 	list->next = list->prev = list;
102 }
103 
104 static inline int
105 list_empty(const struct list_head *head)
106 {
107 
108 	return (head->next == head);
109 }
110 
111 static inline int
112 list_empty_careful(const struct list_head *head)
113 {
114 	struct list_head *next = head->next;
115 
116 	return ((next == head) && (next == head->prev));
117 }
118 
119 static inline void
120 __list_del(struct list_head *prev, struct list_head *next)
121 {
122 	next->prev = prev;
123 	WRITE_ONCE(prev->next, next);
124 }
125 
126 static inline void
127 __list_del_entry(struct list_head *entry)
128 {
129 
130 	__list_del(entry->prev, entry->next);
131 }
132 
133 static inline void
134 list_del(struct list_head *entry)
135 {
136 
137 	__list_del(entry->prev, entry->next);
138 }
139 
140 static inline void
141 list_replace(struct list_head *old, struct list_head *new)
142 {
143 	new->next = old->next;
144 	new->next->prev = new;
145 	new->prev = old->prev;
146 	new->prev->next = new;
147 }
148 
149 static inline void
150 list_replace_init(struct list_head *old, struct list_head *new)
151 {
152 	list_replace(old, new);
153 	INIT_LIST_HEAD(old);
154 }
155 
156 static inline void
157 linux_list_add(struct list_head *new, struct list_head *prev,
158     struct list_head *next)
159 {
160 
161 	next->prev = new;
162 	new->next = next;
163 	new->prev = prev;
164 	prev->next = new;
165 }
166 
167 static inline void
168 list_del_init(struct list_head *entry)
169 {
170 
171 	list_del(entry);
172 	INIT_LIST_HEAD(entry);
173 }
174 
175 #define	list_entry(ptr, type, field)	container_of(ptr, type, field)
176 
177 #define	list_first_entry(ptr, type, member) \
178 	list_entry((ptr)->next, type, member)
179 
180 #define	list_last_entry(ptr, type, member)	\
181 	list_entry((ptr)->prev, type, member)
182 
183 #define	list_first_entry_or_null(ptr, type, member) \
184 	(!list_empty(ptr) ? list_first_entry(ptr, type, member) : NULL)
185 
186 #define	list_next_entry(ptr, member)					\
187 	list_entry(((ptr)->member.next), typeof(*(ptr)), member)
188 
189 #define	list_safe_reset_next(ptr, n, member) \
190 	(n) = list_next_entry(ptr, member)
191 
192 #define	list_prev_entry(ptr, member)					\
193 	list_entry(((ptr)->member.prev), typeof(*(ptr)), member)
194 
195 #define	list_for_each(p, head)						\
196 	for (p = (head)->next; p != (head); p = (p)->next)
197 
198 #define	list_for_each_safe(p, n, head)					\
199 	for (p = (head)->next, n = (p)->next; p != (head); p = n, n = (p)->next)
200 
201 #define list_for_each_entry(p, h, field)				\
202 	for (p = list_entry((h)->next, typeof(*p), field); &(p)->field != (h); \
203 	    p = list_entry((p)->field.next, typeof(*p), field))
204 
205 #define list_for_each_entry_lockless(...) list_for_each_entry(__VA_ARGS__)
206 
207 #define list_for_each_entry_safe(p, n, h, field)			\
208 	for (p = list_entry((h)->next, typeof(*p), field),		\
209 	    n = list_entry((p)->field.next, typeof(*p), field); &(p)->field != (h);\
210 	    p = n, n = list_entry(n->field.next, typeof(*n), field))
211 
212 #define	list_for_each_entry_from(p, h, field) \
213 	for ( ; &(p)->field != (h); \
214 	    p = list_entry((p)->field.next, typeof(*p), field))
215 
216 #define	list_for_each_entry_continue(p, h, field)			\
217 	for (p = list_next_entry((p), field); &(p)->field != (h);	\
218 	    p = list_next_entry((p), field))
219 
220 #define	list_for_each_entry_safe_from(pos, n, head, member)			\
221 	for (n = list_entry((pos)->member.next, typeof(*pos), member);		\
222 	     &(pos)->member != (head);						\
223 	     pos = n, n = list_entry(n->member.next, typeof(*n), member))
224 
225 #define	list_for_each_entry_reverse(p, h, field)			\
226 	for (p = list_entry((h)->prev, typeof(*p), field); &(p)->field != (h); \
227 	    p = list_entry((p)->field.prev, typeof(*p), field))
228 
229 #define	list_for_each_entry_safe_reverse(p, n, h, field)		\
230 	for (p = list_entry((h)->prev, typeof(*p), field),		\
231 	    n = list_entry((p)->field.prev, typeof(*p), field); &(p)->field != (h); \
232 	    p = n, n = list_entry(n->field.prev, typeof(*n), field))
233 
234 #define	list_for_each_entry_continue_reverse(p, h, field) \
235 	for (p = list_entry((p)->field.prev, typeof(*p), field); &(p)->field != (h); \
236 	    p = list_entry((p)->field.prev, typeof(*p), field))
237 
238 #define	list_for_each_prev(p, h) for (p = (h)->prev; p != (h); p = (p)->prev)
239 
240 #define	list_for_each_entry_from_reverse(p, h, field)	\
241 	for (; &p->field != (h);			\
242 	     p = list_prev_entry(p, field))
243 
244 static inline void
245 list_add(struct list_head *new, struct list_head *head)
246 {
247 
248 	linux_list_add(new, head, head->next);
249 }
250 
251 static inline void
252 list_add_tail(struct list_head *new, struct list_head *head)
253 {
254 
255 	linux_list_add(new, head->prev, head);
256 }
257 
258 static inline void
259 list_move(struct list_head *list, struct list_head *head)
260 {
261 
262 	list_del(list);
263 	list_add(list, head);
264 }
265 
266 static inline void
267 list_move_tail(struct list_head *entry, struct list_head *head)
268 {
269 
270 	list_del(entry);
271 	list_add_tail(entry, head);
272 }
273 
274 static inline void
275 list_bulk_move_tail(struct list_head *head, struct list_head *first,
276     struct list_head *last)
277 {
278 	first->prev->next = last->next;
279 	last->next->prev = first->prev;
280 	head->prev->next = first;
281 	first->prev = head->prev;
282 	last->next = head;
283 	head->prev = last;
284 }
285 
286 static inline void
287 linux_list_splice(const struct list_head *list, struct list_head *prev,
288     struct list_head *next)
289 {
290 	struct list_head *first;
291 	struct list_head *last;
292 
293 	if (list_empty(list))
294 		return;
295 	first = list->next;
296 	last = list->prev;
297 	first->prev = prev;
298 	prev->next = first;
299 	last->next = next;
300 	next->prev = last;
301 }
302 
303 static inline void
304 list_splice(const struct list_head *list, struct list_head *head)
305 {
306 
307 	linux_list_splice(list, head, head->next);
308 }
309 
310 static inline void
311 list_splice_tail(struct list_head *list, struct list_head *head)
312 {
313 
314 	linux_list_splice(list, head->prev, head);
315 }
316 
317 static inline void
318 list_splice_init(struct list_head *list, struct list_head *head)
319 {
320 
321 	linux_list_splice(list, head, head->next);
322 	INIT_LIST_HEAD(list);
323 }
324 
325 static inline void
326 list_splice_tail_init(struct list_head *list, struct list_head *head)
327 {
328 
329 	linux_list_splice(list, head->prev, head);
330 	INIT_LIST_HEAD(list);
331 }
332 
333 #undef LIST_HEAD
334 #define LIST_HEAD(name)	struct list_head name = { &(name), &(name) }
335 
336 struct hlist_head {
337 	struct hlist_node *first;
338 };
339 
340 struct hlist_node {
341 	struct hlist_node *next, **pprev;
342 };
343 #define	HLIST_HEAD_INIT { }
344 #define	HLIST_HEAD(name) struct hlist_head name = HLIST_HEAD_INIT
345 #define	INIT_HLIST_HEAD(head) (head)->first = NULL
346 #define	INIT_HLIST_NODE(node)						\
347 do {									\
348 	(node)->next = NULL;						\
349 	(node)->pprev = NULL;						\
350 } while (0)
351 
352 static inline int
353 hlist_unhashed(const struct hlist_node *h)
354 {
355 
356 	return !h->pprev;
357 }
358 
359 static inline int
360 hlist_empty(const struct hlist_head *h)
361 {
362 
363 	return !READ_ONCE(h->first);
364 }
365 
366 static inline void
367 hlist_del(struct hlist_node *n)
368 {
369 
370 	WRITE_ONCE(*(n->pprev), n->next);
371 	if (n->next != NULL)
372 		n->next->pprev = n->pprev;
373 }
374 
375 static inline void
376 hlist_del_init(struct hlist_node *n)
377 {
378 
379 	if (hlist_unhashed(n))
380 		return;
381 	hlist_del(n);
382 	INIT_HLIST_NODE(n);
383 }
384 
385 static inline void
386 hlist_add_head(struct hlist_node *n, struct hlist_head *h)
387 {
388 
389 	n->next = h->first;
390 	if (h->first != NULL)
391 		h->first->pprev = &n->next;
392 	WRITE_ONCE(h->first, n);
393 	n->pprev = &h->first;
394 }
395 
396 static inline void
397 hlist_add_before(struct hlist_node *n, struct hlist_node *next)
398 {
399 
400 	n->pprev = next->pprev;
401 	n->next = next;
402 	next->pprev = &n->next;
403 	WRITE_ONCE(*(n->pprev), n);
404 }
405 
406 static inline void
407 hlist_add_behind(struct hlist_node *n, struct hlist_node *prev)
408 {
409 
410 	n->next = prev->next;
411 	WRITE_ONCE(prev->next, n);
412 	n->pprev = &prev->next;
413 
414 	if (n->next != NULL)
415 		n->next->pprev = &n->next;
416 }
417 
418 static inline void
419 hlist_move_list(struct hlist_head *old, struct hlist_head *new)
420 {
421 
422 	new->first = old->first;
423 	if (new->first)
424 		new->first->pprev = &new->first;
425 	old->first = NULL;
426 }
427 
428 static inline int list_is_singular(const struct list_head *head)
429 {
430 	return !list_empty(head) && (head->next == head->prev);
431 }
432 
433 static inline void __list_cut_position(struct list_head *list,
434 		struct list_head *head, struct list_head *entry)
435 {
436 	struct list_head *new_first = entry->next;
437 	list->next = head->next;
438 	list->next->prev = list;
439 	list->prev = entry;
440 	entry->next = list;
441 	head->next = new_first;
442 	new_first->prev = head;
443 }
444 
445 static inline void list_cut_position(struct list_head *list,
446 		struct list_head *head, struct list_head *entry)
447 {
448 	if (list_empty(head))
449 		return;
450 	if (list_is_singular(head) &&
451 		(head->next != entry && head != entry))
452 		return;
453 	if (entry == head)
454 		INIT_LIST_HEAD(list);
455 	else
456 		__list_cut_position(list, head, entry);
457 }
458 
459 static inline int list_is_first(const struct list_head *list,
460 				const struct list_head *head)
461 {
462 
463 	return (list->prev == head);
464 }
465 
466 static inline int list_is_last(const struct list_head *list,
467 				const struct list_head *head)
468 {
469 	return list->next == head;
470 }
471 
472 #define	hlist_entry(ptr, type, field)	container_of(ptr, type, field)
473 
474 #define	hlist_for_each(p, head)						\
475 	for (p = (head)->first; p; p = (p)->next)
476 
477 #define	hlist_for_each_safe(p, n, head)					\
478 	for (p = (head)->first; p && ({ n = (p)->next; 1; }); p = n)
479 
480 #define	hlist_entry_safe(ptr, type, member) \
481 	((ptr) ? hlist_entry(ptr, type, member) : NULL)
482 
483 #define	hlist_for_each_entry(pos, head, member)				\
484 	for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\
485 	     pos;							\
486 	     pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
487 
488 #define	hlist_for_each_entry_continue(pos, member)			\
489 	for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member); \
490 	     (pos);							\
491 	     pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
492 
493 #define	hlist_for_each_entry_from(pos, member)				\
494 	for (; (pos);								\
495 	     pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
496 
497 #define	hlist_for_each_entry_safe(pos, n, head, member)			\
498 	for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member); \
499 	     (pos) && ({ n = (pos)->member.next; 1; });			\
500 	     pos = hlist_entry_safe(n, typeof(*(pos)), member))
501 
502 extern void list_sort(void *priv, struct list_head *head, int (*cmp)(void *priv,
503     struct list_head *a, struct list_head *b));
504 
505 #endif /* _LINUX_LIST_H_ */
506