4 #include <linux/stddef.h>
5 #include <linux/poison.h>
7 #ifndef ARCH_HAS_PREFETCH
8 #define ARCH_HAS_PREFETCH
9 static inline void prefetch(const void *x) {;}
13 * Simple doubly linked list implementation.
15 * Some of the internal functions ("__xxx") are useful when
16 * manipulating whole lists rather than single entries, as
17 * sometimes we already know the next/prev entries and we can
18 * generate better code by using them directly rather than
19 * using the generic single-entry routines.
23 struct list_head *next, *prev;
26 #define LIST_HEAD_INIT(name) { &(name), &(name) }
28 #define LIST_HEAD(name) \
29 struct list_head name = LIST_HEAD_INIT(name)
31 static inline void INIT_LIST_HEAD(struct list_head *list)
38 * Insert a new entry between two known consecutive entries.
40 * This is only for internal list manipulation where we know
41 * the prev/next entries already!
43 static inline void __list_add(struct list_head *new,
44 struct list_head *prev,
45 struct list_head *next)
54 * list_add - add a new entry
55 * @new: new entry to be added
56 * @head: list head to add it after
58 * Insert a new entry after the specified head.
59 * This is good for implementing stacks.
61 static inline void list_add(struct list_head *new, struct list_head *head)
63 __list_add(new, head, head->next);
67 * list_add_tail - add a new entry
68 * @new: new entry to be added
69 * @head: list head to add it before
71 * Insert a new entry before the specified head.
72 * This is useful for implementing queues.
74 static inline void list_add_tail(struct list_head *new, struct list_head *head)
76 __list_add(new, head->prev, head);
80 * Delete a list entry by making the prev/next entries
81 * point to each other.
83 * This is only for internal list manipulation where we know
84 * the prev/next entries already!
86 static inline void __list_del(struct list_head *prev, struct list_head *next)
93 * list_del - deletes entry from list.
94 * @entry: the element to delete from the list.
95 * Note: list_empty() on entry does not return true after this, the entry is
96 * in an undefined state.
98 static inline void list_del(struct list_head *entry)
100 __list_del(entry->prev, entry->next);
101 entry->next = LIST_POISON1;
102 entry->prev = LIST_POISON2;
106 * list_replace - replace old entry by new one
107 * @old : the element to be replaced
108 * @new : the new element to insert
110 * If @old was empty, it will be overwritten.
112 static inline void list_replace(struct list_head *old,
113 struct list_head *new)
115 new->next = old->next;
116 new->next->prev = new;
117 new->prev = old->prev;
118 new->prev->next = new;
121 static inline void list_replace_init(struct list_head *old,
122 struct list_head *new)
124 list_replace(old, new);
129 * list_del_init - deletes entry from list and reinitialize it.
130 * @entry: the element to delete from the list.
132 static inline void list_del_init(struct list_head *entry)
134 __list_del(entry->prev, entry->next);
135 INIT_LIST_HEAD(entry);
139 * list_move - delete from one list and add as another's head
140 * @list: the entry to move
141 * @head: the head that will precede our entry
143 static inline void list_move(struct list_head *list, struct list_head *head)
145 __list_del(list->prev, list->next);
146 list_add(list, head);
150 * list_move_tail - delete from one list and add as another's tail
151 * @list: the entry to move
152 * @head: the head that will follow our entry
154 static inline void list_move_tail(struct list_head *list,
155 struct list_head *head)
157 __list_del(list->prev, list->next);
158 list_add_tail(list, head);
162 * list_is_last - tests whether @list is the last entry in list @head
163 * @list: the entry to test
164 * @head: the head of the list
166 static inline int list_is_last(const struct list_head *list,
167 const struct list_head *head)
169 return list->next == head;
173 * list_empty - tests whether a list is empty
174 * @head: the list to test.
176 static inline int list_empty(const struct list_head *head)
178 return head->next == head;
182 * list_empty_careful - tests whether a list is empty and not being modified
183 * @head: the list to test
186 * tests whether a list is empty _and_ checks that no other CPU might be
187 * in the process of modifying either member (next or prev)
189 * NOTE: using list_empty_careful() without synchronization
190 * can only be safe if the only activity that can happen
191 * to the list entry is list_del_init(). Eg. it cannot be used
192 * if another CPU could re-list_add() it.
194 static inline int list_empty_careful(const struct list_head *head)
196 struct list_head *next = head->next;
197 return (next == head) && (next == head->prev);
201 * list_is_singular - tests whether a list has just one entry.
202 * @head: the list to test.
204 static inline int list_is_singular(const struct list_head *head)
206 return !list_empty(head) && (head->next == head->prev);
209 static inline void __list_cut_position(struct list_head *list,
210 struct list_head *head, struct list_head *entry)
212 struct list_head *new_first = entry->next;
213 list->next = head->next;
214 list->next->prev = list;
217 head->next = new_first;
218 new_first->prev = head;
222 * list_cut_position - cut a list into two
223 * @list: a new list to add all removed entries
224 * @head: a list with entries
225 * @entry: an entry within head, could be the head itself
226 * and if so we won't cut the list
228 * This helper moves the initial part of @head, up to and
229 * including @entry, from @head to @list. You should
230 * pass on @entry an element you know is on @head. @list
231 * should be an empty list or a list you do not care about
235 static inline void list_cut_position(struct list_head *list,
236 struct list_head *head, struct list_head *entry)
238 if (list_empty(head))
240 if (list_is_singular(head) &&
241 (head->next != entry && head != entry))
244 INIT_LIST_HEAD(list);
246 __list_cut_position(list, head, entry);
249 static inline void __list_splice(const struct list_head *list,
250 struct list_head *prev,
251 struct list_head *next)
253 struct list_head *first = list->next;
254 struct list_head *last = list->prev;
264 * list_splice - join two lists, this is designed for stacks
265 * @list: the new list to add.
266 * @head: the place to add it in the first list.
268 static inline void list_splice(const struct list_head *list,
269 struct list_head *head)
271 if (!list_empty(list))
272 __list_splice(list, head, head->next);
276 * list_splice_tail - join two lists, each list being a queue
277 * @list: the new list to add.
278 * @head: the place to add it in the first list.
280 static inline void list_splice_tail(struct list_head *list,
281 struct list_head *head)
283 if (!list_empty(list))
284 __list_splice(list, head->prev, head);
288 * list_splice_init - join two lists and reinitialise the emptied list.
289 * @list: the new list to add.
290 * @head: the place to add it in the first list.
292 * The list at @list is reinitialised
294 static inline void list_splice_init(struct list_head *list,
295 struct list_head *head)
297 if (!list_empty(list)) {
298 __list_splice(list, head, head->next);
299 INIT_LIST_HEAD(list);
304 * list_splice_tail_init - join two lists and reinitialise the emptied list
305 * @list: the new list to add.
306 * @head: the place to add it in the first list.
308 * Each of the lists is a queue.
309 * The list at @list is reinitialised
311 static inline void list_splice_tail_init(struct list_head *list,
312 struct list_head *head)
314 if (!list_empty(list)) {
315 __list_splice(list, head->prev, head);
316 INIT_LIST_HEAD(list);
321 * list_entry - get the struct for this entry
322 * @ptr: the &struct list_head pointer.
323 * @type: the type of the struct this is embedded in.
324 * @member: the name of the list_struct within the struct.
326 #define list_entry(ptr, type, member) \
327 container_of(ptr, type, member)
330 * list_first_entry - get the first element from a list
331 * @ptr: the list head to take the element from.
332 * @type: the type of the struct this is embedded in.
333 * @member: the name of the list_struct within the struct.
335 * Note, that list is expected to be not empty.
337 #define list_first_entry(ptr, type, member) \
338 list_entry((ptr)->next, type, member)
341 * list_last_entry - get the last element from a list
342 * @ptr: the list head to take the element from.
343 * @type: the type of the struct this is embedded in.
344 * @member: the name of the list_struct within the struct.
346 * Note, that list is expected to be not empty.
348 #define list_last_entry(ptr, type, member) \
349 list_entry((ptr)->prev, type, member)
352 * list_first_entry_or_null - get the first element from a list
353 * @ptr: the list head to take the element from.
354 * @type: the type of the struct this is embedded in.
355 * @member: the name of the list_head within the struct.
357 * Note that if the list is empty, it returns NULL.
359 #define list_first_entry_or_null(ptr, type, member) ({ \
360 struct list_head *head__ = (ptr); \
361 struct list_head *pos__ = READ_ONCE(head__->next); \
362 pos__ != head__ ? list_entry(pos__, type, member) : NULL; \
366 * list_for_each - iterate over a list
367 * @pos: the &struct list_head to use as a loop cursor.
368 * @head: the head for your list.
370 #define list_for_each(pos, head) \
371 for (pos = (head)->next; prefetch(pos->next), pos != (head); \
375 * __list_for_each - iterate over a list
376 * @pos: the &struct list_head to use as a loop cursor.
377 * @head: the head for your list.
379 * This variant differs from list_for_each() in that it's the
380 * simplest possible list iteration code, no prefetching is done.
381 * Use this for code that knows the list to be very short (empty
382 * or 1 entry) most of the time.
384 #define __list_for_each(pos, head) \
385 for (pos = (head)->next; pos != (head); pos = pos->next)
388 * list_for_each_prev - iterate over a list backwards
389 * @pos: the &struct list_head to use as a loop cursor.
390 * @head: the head for your list.
392 #define list_for_each_prev(pos, head) \
393 for (pos = (head)->prev; prefetch(pos->prev), pos != (head); \
397 * list_for_each_safe - iterate over a list safe against removal of list entry
398 * @pos: the &struct list_head to use as a loop cursor.
399 * @n: another &struct list_head to use as temporary storage
400 * @head: the head for your list.
402 #define list_for_each_safe(pos, n, head) \
403 for (pos = (head)->next, n = pos->next; pos != (head); \
404 pos = n, n = pos->next)
407 * list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
408 * @pos: the &struct list_head to use as a loop cursor.
409 * @n: another &struct list_head to use as temporary storage
410 * @head: the head for your list.
412 #define list_for_each_prev_safe(pos, n, head) \
413 for (pos = (head)->prev, n = pos->prev; \
414 prefetch(pos->prev), pos != (head); \
415 pos = n, n = pos->prev)
418 * list_for_each_entry - iterate over list of given type
419 * @pos: the type * to use as a loop cursor.
420 * @head: the head for your list.
421 * @member: the name of the list_struct within the struct.
423 #define list_for_each_entry(pos, head, member) \
424 for (pos = list_entry((head)->next, typeof(*pos), member); \
425 prefetch(pos->member.next), &pos->member != (head); \
426 pos = list_entry(pos->member.next, typeof(*pos), member))
429 * list_for_each_entry_reverse - iterate backwards over list of given type.
430 * @pos: the type * to use as a loop cursor.
431 * @head: the head for your list.
432 * @member: the name of the list_struct within the struct.
434 #define list_for_each_entry_reverse(pos, head, member) \
435 for (pos = list_entry((head)->prev, typeof(*pos), member); \
436 prefetch(pos->member.prev), &pos->member != (head); \
437 pos = list_entry(pos->member.prev, typeof(*pos), member))
440 * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
441 * @pos: the type * to use as a start point
442 * @head: the head of the list
443 * @member: the name of the list_struct within the struct.
445 * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
447 #define list_prepare_entry(pos, head, member) \
448 ((pos) ? : list_entry(head, typeof(*pos), member))
451 * list_for_each_entry_continue - continue iteration over list of given type
452 * @pos: the type * to use as a loop cursor.
453 * @head: the head for your list.
454 * @member: the name of the list_struct within the struct.
456 * Continue to iterate over list of given type, continuing after
457 * the current position.
459 #define list_for_each_entry_continue(pos, head, member) \
460 for (pos = list_entry(pos->member.next, typeof(*pos), member); \
461 prefetch(pos->member.next), &pos->member != (head); \
462 pos = list_entry(pos->member.next, typeof(*pos), member))
465 * list_for_each_entry_continue_reverse - iterate backwards from the given point
466 * @pos: the type * to use as a loop cursor.
467 * @head: the head for your list.
468 * @member: the name of the list_struct within the struct.
470 * Start to iterate over list of given type backwards, continuing after
471 * the current position.
473 #define list_for_each_entry_continue_reverse(pos, head, member) \
474 for (pos = list_entry(pos->member.prev, typeof(*pos), member); \
475 prefetch(pos->member.prev), &pos->member != (head); \
476 pos = list_entry(pos->member.prev, typeof(*pos), member))
479 * list_for_each_entry_from - iterate over list of given type from the current point
480 * @pos: the type * to use as a loop cursor.
481 * @head: the head for your list.
482 * @member: the name of the list_struct within the struct.
484 * Iterate over list of given type, continuing from current position.
486 #define list_for_each_entry_from(pos, head, member) \
487 for (; prefetch(pos->member.next), &pos->member != (head); \
488 pos = list_entry(pos->member.next, typeof(*pos), member))
491 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
492 * @pos: the type * to use as a loop cursor.
493 * @n: another type * to use as temporary storage
494 * @head: the head for your list.
495 * @member: the name of the list_struct within the struct.
497 #define list_for_each_entry_safe(pos, n, head, member) \
498 for (pos = list_entry((head)->next, typeof(*pos), member), \
499 n = list_entry(pos->member.next, typeof(*pos), member); \
500 &pos->member != (head); \
501 pos = n, n = list_entry(n->member.next, typeof(*n), member))
504 * list_for_each_entry_safe_continue
505 * @pos: the type * to use as a loop cursor.
506 * @n: another type * to use as temporary storage
507 * @head: the head for your list.
508 * @member: the name of the list_struct within the struct.
510 * Iterate over list of given type, continuing after current point,
511 * safe against removal of list entry.
513 #define list_for_each_entry_safe_continue(pos, n, head, member) \
514 for (pos = list_entry(pos->member.next, typeof(*pos), member), \
515 n = list_entry(pos->member.next, typeof(*pos), member); \
516 &pos->member != (head); \
517 pos = n, n = list_entry(n->member.next, typeof(*n), member))
520 * list_for_each_entry_safe_from
521 * @pos: the type * to use as a loop cursor.
522 * @n: another type * to use as temporary storage
523 * @head: the head for your list.
524 * @member: the name of the list_struct within the struct.
526 * Iterate over list of given type from current point, safe against
527 * removal of list entry.
529 #define list_for_each_entry_safe_from(pos, n, head, member) \
530 for (n = list_entry(pos->member.next, typeof(*pos), member); \
531 &pos->member != (head); \
532 pos = n, n = list_entry(n->member.next, typeof(*n), member))
535 * list_for_each_entry_safe_reverse
536 * @pos: the type * to use as a loop cursor.
537 * @n: another type * to use as temporary storage
538 * @head: the head for your list.
539 * @member: the name of the list_struct within the struct.
541 * Iterate backwards over list of given type, safe against removal
544 #define list_for_each_entry_safe_reverse(pos, n, head, member) \
545 for (pos = list_entry((head)->prev, typeof(*pos), member), \
546 n = list_entry(pos->member.prev, typeof(*pos), member); \
547 &pos->member != (head); \
548 pos = n, n = list_entry(n->member.prev, typeof(*n), member))
551 * list_count_nodes - count nodes in the list
552 * @head: the head for your list.
554 static inline size_t list_count_nodes(struct list_head *head)
556 struct list_head *pos;
559 list_for_each(pos, head)
566 * Double linked lists with a single pointer list head.
567 * Mostly useful for hash tables where the two pointer list head is
569 * You lose the ability to access the tail in O(1).
573 struct hlist_node *first;
577 struct hlist_node *next, **pprev;
580 #define HLIST_HEAD_INIT { .first = NULL }
581 #define HLIST_HEAD(name) struct hlist_head name = { .first = NULL }
582 #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
583 static inline void INIT_HLIST_NODE(struct hlist_node *h)
589 static inline int hlist_unhashed(const struct hlist_node *h)
594 static inline int hlist_empty(const struct hlist_head *h)
599 static inline void __hlist_del(struct hlist_node *n)
601 struct hlist_node *next = n->next;
602 struct hlist_node **pprev = n->pprev;
608 static inline void hlist_del(struct hlist_node *n)
611 n->next = LIST_POISON1;
612 n->pprev = LIST_POISON2;
615 static inline void hlist_del_init(struct hlist_node *n)
617 if (!hlist_unhashed(n)) {
623 static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
625 struct hlist_node *first = h->first;
628 first->pprev = &n->next;
630 n->pprev = &h->first;
633 /* next must be != NULL */
634 static inline void hlist_add_before(struct hlist_node *n,
635 struct hlist_node *next)
637 n->pprev = next->pprev;
639 next->pprev = &n->next;
643 static inline void hlist_add_after(struct hlist_node *n,
644 struct hlist_node *next)
646 next->next = n->next;
648 next->pprev = &n->next;
651 next->next->pprev = &next->next;
654 #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
656 #define hlist_for_each(pos, head) \
657 for (pos = (head)->first; pos && ({ prefetch(pos->next); 1; }); \
660 #define hlist_for_each_safe(pos, n, head) \
661 for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
664 #define hlist_entry_safe(ptr, type, member) \
665 ({ typeof(ptr) ____ptr = (ptr); \
666 ____ptr ? hlist_entry(____ptr, type, member) : NULL; \
670 * hlist_for_each_entry - iterate over list of given type
671 * @pos: the type * to use as a loop cursor.
672 * @head: the head for your list.
673 * @member: the name of the hlist_node within the struct.
675 #define hlist_for_each_entry(pos, head, member) \
676 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\
678 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
681 * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
682 * @pos: the type * to use as a loop cursor.
683 * @member: the name of the hlist_node within the struct.
685 #define hlist_for_each_entry_continue(pos, member) \
686 for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member);\
688 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
691 * hlist_for_each_entry_from - iterate over a hlist continuing from current point
692 * @pos: the type * to use as a loop cursor.
693 * @member: the name of the hlist_node within the struct.
695 #define hlist_for_each_entry_from(pos, member) \
697 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
700 * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
701 * @pos: the type * to use as a loop cursor.
702 * @n: a &struct hlist_node to use as temporary storage
703 * @head: the head for your list.
704 * @member: the name of the hlist_node within the struct.
706 #define hlist_for_each_entry_safe(pos, n, head, member) \
707 for (pos = hlist_entry_safe((head)->first, typeof(*pos), member);\
708 pos && ({ n = pos->member.next; 1; }); \
709 pos = hlist_entry_safe(n, typeof(*pos), member))