blob: 9e9a6403dbe44229974f87632d18c92322f9ae1c [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef _LINUX_LIST_H
3#define _LINUX_LIST_H
4
Chris Metcalfde5d9bf2010-07-02 13:41:14 -04005#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/stddef.h>
Randy Dunlapc9cf5522006-06-27 02:53:52 -07007#include <linux/poison.h>
Linus Torvaldse66eed62011-05-19 14:15:29 -07008#include <linux/const.h>
Masahiro Yamada8b21d9c2014-10-13 15:51:30 -07009#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * Simple doubly linked list implementation.
13 *
14 * Some of the internal functions ("__xxx") are useful when
15 * manipulating whole lists rather than single entries, as
16 * sometimes we already know the next/prev entries and we can
17 * generate better code by using them directly rather than
18 * using the generic single-entry routines.
19 */
20
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#define LIST_HEAD_INIT(name) { &(name), &(name) }
22
23#define LIST_HEAD(name) \
24 struct list_head name = LIST_HEAD_INIT(name)
25
Zach Brown490d6ab2006-02-03 03:03:56 -080026static inline void INIT_LIST_HEAD(struct list_head *list)
27{
Paul E. McKenney2f073842015-10-12 16:56:42 -070028 WRITE_ONCE(list->next, list);
Zach Brown490d6ab2006-02-03 03:03:56 -080029 list->prev = list;
30}
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Kees Cookd7c81672016-08-17 14:42:08 -070032#ifdef CONFIG_DEBUG_LIST
33extern bool __list_add_valid(struct list_head *new,
34 struct list_head *prev,
35 struct list_head *next);
Kees Cook0cd340d2016-08-17 14:42:10 -070036extern bool __list_del_entry_valid(struct list_head *entry);
Kees Cookd7c81672016-08-17 14:42:08 -070037#else
38static inline bool __list_add_valid(struct list_head *new,
39 struct list_head *prev,
40 struct list_head *next)
41{
42 return true;
43}
Kees Cook0cd340d2016-08-17 14:42:10 -070044static inline bool __list_del_entry_valid(struct list_head *entry)
45{
46 return true;
47}
Kees Cookd7c81672016-08-17 14:42:08 -070048#endif
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
51 * Insert a new entry between two known consecutive entries.
52 *
53 * This is only for internal list manipulation where we know
54 * the prev/next entries already!
55 */
56static inline void __list_add(struct list_head *new,
57 struct list_head *prev,
58 struct list_head *next)
59{
Kees Cookd7c81672016-08-17 14:42:08 -070060 if (!__list_add_valid(new, prev, next))
61 return;
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 next->prev = new;
64 new->next = next;
65 new->prev = prev;
Paul E. McKenney1c97be62015-09-20 22:02:17 -070066 WRITE_ONCE(prev->next, new);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067}
68
69/**
70 * list_add - add a new entry
71 * @new: new entry to be added
72 * @head: list head to add it after
73 *
74 * Insert a new entry after the specified head.
75 * This is good for implementing stacks.
76 */
77static inline void list_add(struct list_head *new, struct list_head *head)
78{
79 __list_add(new, head, head->next);
80}
Dave Jones199a9af2006-09-29 01:59:00 -070081
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/**
84 * list_add_tail - add a new entry
85 * @new: new entry to be added
86 * @head: list head to add it before
87 *
88 * Insert a new entry before the specified head.
89 * This is useful for implementing queues.
90 */
91static inline void list_add_tail(struct list_head *new, struct list_head *head)
92{
93 __list_add(new, head->prev, head);
94}
95
96/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 * Delete a list entry by making the prev/next entries
98 * point to each other.
99 *
100 * This is only for internal list manipulation where we know
101 * the prev/next entries already!
102 */
103static inline void __list_del(struct list_head * prev, struct list_head * next)
104{
105 next->prev = prev;
Paul E. McKenney7f5f8732015-09-18 08:45:22 -0700106 WRITE_ONCE(prev->next, next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107}
108
109/**
110 * list_del - deletes entry from list.
111 * @entry: the element to delete from the list.
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800112 * Note: list_empty() on entry does not return true after this, the entry is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * in an undefined state.
114 */
Linus Torvalds3c18d4d2011-02-18 11:32:28 -0800115static inline void __list_del_entry(struct list_head *entry)
116{
Kees Cook0cd340d2016-08-17 14:42:10 -0700117 if (!__list_del_entry_valid(entry))
118 return;
119
Linus Torvalds3c18d4d2011-02-18 11:32:28 -0800120 __list_del(entry->prev, entry->next);
121}
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123static inline void list_del(struct list_head *entry)
124{
Kees Cook0cd340d2016-08-17 14:42:10 -0700125 __list_del_entry(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 entry->next = LIST_POISON1;
127 entry->prev = LIST_POISON2;
128}
129
130/**
Oleg Nesterov54e73772006-06-23 02:05:54 -0700131 * list_replace - replace old entry by new one
132 * @old : the element to be replaced
133 * @new : the new element to insert
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800134 *
135 * If @old was empty, it will be overwritten.
Oleg Nesterov54e73772006-06-23 02:05:54 -0700136 */
137static inline void list_replace(struct list_head *old,
138 struct list_head *new)
139{
140 new->next = old->next;
141 new->next->prev = new;
142 new->prev = old->prev;
143 new->prev->next = new;
144}
145
146static inline void list_replace_init(struct list_head *old,
147 struct list_head *new)
148{
149 list_replace(old, new);
150 INIT_LIST_HEAD(old);
151}
152
Robert P. J. Day45f8bde2007-01-26 00:57:09 -0800153/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 * list_del_init - deletes entry from list and reinitialize it.
155 * @entry: the element to delete from the list.
156 */
157static inline void list_del_init(struct list_head *entry)
158{
Linus Torvalds3c18d4d2011-02-18 11:32:28 -0800159 __list_del_entry(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 INIT_LIST_HEAD(entry);
161}
162
163/**
164 * list_move - delete from one list and add as another's head
165 * @list: the entry to move
166 * @head: the head that will precede our entry
167 */
168static inline void list_move(struct list_head *list, struct list_head *head)
169{
Linus Torvalds3c18d4d2011-02-18 11:32:28 -0800170 __list_del_entry(list);
Daniel Walker78db2ad2007-05-12 16:28:35 -0700171 list_add(list, head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172}
173
174/**
175 * list_move_tail - delete from one list and add as another's tail
176 * @list: the entry to move
177 * @head: the head that will follow our entry
178 */
179static inline void list_move_tail(struct list_head *list,
180 struct list_head *head)
181{
Linus Torvalds3c18d4d2011-02-18 11:32:28 -0800182 __list_del_entry(list);
Daniel Walker78db2ad2007-05-12 16:28:35 -0700183 list_add_tail(list, head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184}
185
186/**
Christian Königdf2fc432018-09-13 11:17:23 +0200187 * list_bulk_move_tail - move a subsection of a list to its tail
188 * @head: the head that will follow our entry
189 * @first: first entry to move
190 * @last: last entry to move, can be the same as first
191 *
192 * Move all entries between @first and including @last before @head.
193 * All three entries must belong to the same linked list.
194 */
195static inline void list_bulk_move_tail(struct list_head *head,
196 struct list_head *first,
197 struct list_head *last)
198{
199 first->prev->next = last->next;
200 last->next->prev = first->prev;
201
202 head->prev->next = first;
203 first->prev = head->prev;
204
205 last->next = head;
206 head->prev = last;
207}
208
209/**
Randy Dunlapb7365232019-03-28 20:44:05 -0700210 * list_is_first -- tests whether @list is the first entry in list @head
Mel Gorman70b44592019-03-05 15:44:54 -0800211 * @list: the entry to test
212 * @head: the head of the list
213 */
214static inline int list_is_first(const struct list_head *list,
215 const struct list_head *head)
216{
217 return list->prev == head;
218}
219
220/**
Shailabh Nagare8f4d972006-07-14 00:24:35 -0700221 * list_is_last - tests whether @list is the last entry in list @head
222 * @list: the entry to test
223 * @head: the head of the list
224 */
225static inline int list_is_last(const struct list_head *list,
226 const struct list_head *head)
227{
228 return list->next == head;
229}
230
231/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 * list_empty - tests whether a list is empty
233 * @head: the list to test.
234 */
235static inline int list_empty(const struct list_head *head)
236{
Paul E. McKenney1658d352015-09-20 17:03:16 -0700237 return READ_ONCE(head->next) == head;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238}
239
240/**
Randy Dunlapfe96e572006-06-25 05:47:42 -0700241 * list_empty_careful - tests whether a list is empty and not being modified
242 * @head: the list to test
243 *
244 * Description:
245 * tests whether a list is empty _and_ checks that no other CPU might be
246 * in the process of modifying either member (next or prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 *
248 * NOTE: using list_empty_careful() without synchronization
249 * can only be safe if the only activity that can happen
250 * to the list entry is list_del_init(). Eg. it cannot be used
251 * if another CPU could re-list_add() it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 */
253static inline int list_empty_careful(const struct list_head *head)
254{
255 struct list_head *next = head->next;
256 return (next == head) && (next == head->prev);
257}
258
Masami Hiramatsu99602572008-04-28 02:14:27 -0700259/**
Frederic Weisbecker5908cdc2010-01-09 20:53:14 +0100260 * list_rotate_left - rotate the list to the left
261 * @head: the head of the list
262 */
263static inline void list_rotate_left(struct list_head *head)
264{
265 struct list_head *first;
266
267 if (!list_empty(head)) {
268 first = head->next;
269 list_move_tail(first, head);
270 }
271}
272
273/**
Tobin C. Hardinga16b5382019-05-13 17:15:59 -0700274 * list_rotate_to_front() - Rotate list to specific item.
275 * @list: The desired new front of the list.
276 * @head: The head of the list.
277 *
278 * Rotates list so that @list becomes the new front of the list.
279 */
280static inline void list_rotate_to_front(struct list_head *list,
281 struct list_head *head)
282{
283 /*
284 * Deletes the list head from the list denoted by @head and
285 * places it as the tail of @list, this effectively rotates the
286 * list so that @list is at the front.
287 */
288 list_move_tail(head, list);
289}
290
291/**
Masami Hiramatsu99602572008-04-28 02:14:27 -0700292 * list_is_singular - tests whether a list has just one entry.
293 * @head: the list to test.
294 */
295static inline int list_is_singular(const struct list_head *head)
296{
297 return !list_empty(head) && (head->next == head->prev);
298}
299
Luis R. Rodriguez00e8a4d2008-08-06 13:28:54 -0700300static inline void __list_cut_position(struct list_head *list,
301 struct list_head *head, struct list_head *entry)
302{
303 struct list_head *new_first = entry->next;
304 list->next = head->next;
305 list->next->prev = list;
306 list->prev = entry;
307 entry->next = list;
308 head->next = new_first;
309 new_first->prev = head;
310}
311
312/**
313 * list_cut_position - cut a list into two
314 * @list: a new list to add all removed entries
315 * @head: a list with entries
316 * @entry: an entry within head, could be the head itself
317 * and if so we won't cut the list
318 *
319 * This helper moves the initial part of @head, up to and
320 * including @entry, from @head to @list. You should
321 * pass on @entry an element you know is on @head. @list
322 * should be an empty list or a list you do not care about
323 * losing its data.
324 *
325 */
326static inline void list_cut_position(struct list_head *list,
327 struct list_head *head, struct list_head *entry)
328{
329 if (list_empty(head))
330 return;
331 if (list_is_singular(head) &&
332 (head->next != entry && head != entry))
333 return;
334 if (entry == head)
335 INIT_LIST_HEAD(list);
336 else
337 __list_cut_position(list, head, entry);
338}
339
Edward Cree4ce00172018-07-02 16:13:40 +0100340/**
341 * list_cut_before - cut a list into two, before given entry
342 * @list: a new list to add all removed entries
343 * @head: a list with entries
344 * @entry: an entry within head, could be the head itself
345 *
346 * This helper moves the initial part of @head, up to but
347 * excluding @entry, from @head to @list. You should pass
348 * in @entry an element you know is on @head. @list should
349 * be an empty list or a list you do not care about losing
350 * its data.
351 * If @entry == @head, all entries on @head are moved to
352 * @list.
353 */
354static inline void list_cut_before(struct list_head *list,
355 struct list_head *head,
356 struct list_head *entry)
357{
358 if (head->next == entry) {
359 INIT_LIST_HEAD(list);
360 return;
361 }
362 list->next = head->next;
363 list->next->prev = list;
364 list->prev = entry->prev;
365 list->prev->next = list;
366 head->next = entry;
367 entry->prev = head;
368}
369
Robert P. J. Day95d8c362008-04-29 00:59:29 -0700370static inline void __list_splice(const struct list_head *list,
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700371 struct list_head *prev,
372 struct list_head *next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
374 struct list_head *first = list->next;
375 struct list_head *last = list->prev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700377 first->prev = prev;
378 prev->next = first;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700380 last->next = next;
381 next->prev = last;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382}
383
384/**
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700385 * list_splice - join two lists, this is designed for stacks
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 * @list: the new list to add.
387 * @head: the place to add it in the first list.
388 */
Robert P. J. Day95d8c362008-04-29 00:59:29 -0700389static inline void list_splice(const struct list_head *list,
390 struct list_head *head)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391{
392 if (!list_empty(list))
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700393 __list_splice(list, head, head->next);
394}
395
396/**
397 * list_splice_tail - join two lists, each list being a queue
398 * @list: the new list to add.
399 * @head: the place to add it in the first list.
400 */
401static inline void list_splice_tail(struct list_head *list,
402 struct list_head *head)
403{
404 if (!list_empty(list))
405 __list_splice(list, head->prev, head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
408/**
409 * list_splice_init - join two lists and reinitialise the emptied list.
410 * @list: the new list to add.
411 * @head: the place to add it in the first list.
412 *
413 * The list at @list is reinitialised
414 */
415static inline void list_splice_init(struct list_head *list,
416 struct list_head *head)
417{
418 if (!list_empty(list)) {
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700419 __list_splice(list, head, head->next);
420 INIT_LIST_HEAD(list);
421 }
422}
423
424/**
Randy Dunlap6724cce2008-08-08 13:56:20 -0700425 * list_splice_tail_init - join two lists and reinitialise the emptied list
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700426 * @list: the new list to add.
427 * @head: the place to add it in the first list.
428 *
Randy Dunlap6724cce2008-08-08 13:56:20 -0700429 * Each of the lists is a queue.
Luis R. Rodriguez7d283ae2008-08-06 15:21:26 -0700430 * The list at @list is reinitialised
431 */
432static inline void list_splice_tail_init(struct list_head *list,
433 struct list_head *head)
434{
435 if (!list_empty(list)) {
436 __list_splice(list, head->prev, head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 INIT_LIST_HEAD(list);
438 }
439}
440
441/**
442 * list_entry - get the struct for this entry
443 * @ptr: the &struct list_head pointer.
444 * @type: the type of the struct this is embedded in.
Andrey Utkin3943f422014-11-14 05:09:55 +0400445 * @member: the name of the list_head within the struct.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 */
447#define list_entry(ptr, type, member) \
448 container_of(ptr, type, member)
449
450/**
Pavel Emelianovb5e61812007-05-08 00:30:19 -0700451 * list_first_entry - get the first element from a list
452 * @ptr: the list head to take the element from.
453 * @type: the type of the struct this is embedded in.
Andrey Utkin3943f422014-11-14 05:09:55 +0400454 * @member: the name of the list_head within the struct.
Pavel Emelianovb5e61812007-05-08 00:30:19 -0700455 *
456 * Note, that list is expected to be not empty.
457 */
458#define list_first_entry(ptr, type, member) \
459 list_entry((ptr)->next, type, member)
460
461/**
Oleg Nesterov93be3c22013-11-12 15:10:03 -0800462 * list_last_entry - get the last element from a list
463 * @ptr: the list head to take the element from.
464 * @type: the type of the struct this is embedded in.
Andrey Utkin3943f422014-11-14 05:09:55 +0400465 * @member: the name of the list_head within the struct.
Oleg Nesterov93be3c22013-11-12 15:10:03 -0800466 *
467 * Note, that list is expected to be not empty.
468 */
469#define list_last_entry(ptr, type, member) \
470 list_entry((ptr)->prev, type, member)
471
472/**
Jiri Pirko6d7581e2013-05-29 05:02:56 +0000473 * list_first_entry_or_null - get the first element from a list
474 * @ptr: the list head to take the element from.
475 * @type: the type of the struct this is embedded in.
Andrey Utkin3943f422014-11-14 05:09:55 +0400476 * @member: the name of the list_head within the struct.
Jiri Pirko6d7581e2013-05-29 05:02:56 +0000477 *
478 * Note that if the list is empty, it returns NULL.
479 */
Chris Wilson12adfd82016-07-23 19:27:50 +0100480#define list_first_entry_or_null(ptr, type, member) ({ \
481 struct list_head *head__ = (ptr); \
482 struct list_head *pos__ = READ_ONCE(head__->next); \
483 pos__ != head__ ? list_entry(pos__, type, member) : NULL; \
484})
Jiri Pirko6d7581e2013-05-29 05:02:56 +0000485
486/**
Oleg Nesterov008208c2013-11-12 15:10:01 -0800487 * list_next_entry - get the next element in list
488 * @pos: the type * to cursor
Andrey Utkin3943f422014-11-14 05:09:55 +0400489 * @member: the name of the list_head within the struct.
Oleg Nesterov008208c2013-11-12 15:10:01 -0800490 */
491#define list_next_entry(pos, member) \
492 list_entry((pos)->member.next, typeof(*(pos)), member)
493
494/**
495 * list_prev_entry - get the prev element in list
496 * @pos: the type * to cursor
Andrey Utkin3943f422014-11-14 05:09:55 +0400497 * @member: the name of the list_head within the struct.
Oleg Nesterov008208c2013-11-12 15:10:01 -0800498 */
499#define list_prev_entry(pos, member) \
500 list_entry((pos)->member.prev, typeof(*(pos)), member)
501
502/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 * list_for_each - iterate over a list
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700504 * @pos: the &struct list_head to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 * @head: the head for your list.
506 */
507#define list_for_each(pos, head) \
Linus Torvaldse66eed62011-05-19 14:15:29 -0700508 for (pos = (head)->next; pos != (head); pos = pos->next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
510/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 * list_for_each_prev - iterate over a list backwards
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700512 * @pos: the &struct list_head to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 * @head: the head for your list.
514 */
515#define list_for_each_prev(pos, head) \
Linus Torvaldse66eed62011-05-19 14:15:29 -0700516 for (pos = (head)->prev; pos != (head); pos = pos->prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518/**
Randy Dunlapfe96e572006-06-25 05:47:42 -0700519 * list_for_each_safe - iterate over a list safe against removal of list entry
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700520 * @pos: the &struct list_head to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 * @n: another &struct list_head to use as temporary storage
522 * @head: the head for your list.
523 */
524#define list_for_each_safe(pos, n, head) \
525 for (pos = (head)->next, n = pos->next; pos != (head); \
526 pos = n, n = pos->next)
527
528/**
Randy Dunlap8f731f72007-10-18 23:39:28 -0700529 * list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
Denis V. Lunev37c42522007-10-16 23:29:53 -0700530 * @pos: the &struct list_head to use as a loop cursor.
531 * @n: another &struct list_head to use as temporary storage
532 * @head: the head for your list.
533 */
534#define list_for_each_prev_safe(pos, n, head) \
535 for (pos = (head)->prev, n = pos->prev; \
Linus Torvaldse66eed62011-05-19 14:15:29 -0700536 pos != (head); \
Denis V. Lunev37c42522007-10-16 23:29:53 -0700537 pos = n, n = pos->prev)
538
539/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 * list_for_each_entry - iterate over list of given type
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700541 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400543 * @member: the name of the list_head within the struct.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 */
545#define list_for_each_entry(pos, head, member) \
Oleg Nesterov93be3c22013-11-12 15:10:03 -0800546 for (pos = list_first_entry(head, typeof(*pos), member); \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800547 &pos->member != (head); \
548 pos = list_next_entry(pos, member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550/**
551 * list_for_each_entry_reverse - iterate backwards over list of given type.
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700552 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400554 * @member: the name of the list_head within the struct.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 */
556#define list_for_each_entry_reverse(pos, head, member) \
Oleg Nesterov93be3c22013-11-12 15:10:03 -0800557 for (pos = list_last_entry(head, typeof(*pos), member); \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800558 &pos->member != (head); \
559 pos = list_prev_entry(pos, member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800562 * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 * @pos: the type * to use as a start point
564 * @head: the head of the list
Andrey Utkin3943f422014-11-14 05:09:55 +0400565 * @member: the name of the list_head within the struct.
Randy Dunlapfe96e572006-06-25 05:47:42 -0700566 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800567 * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 */
569#define list_prepare_entry(pos, head, member) \
570 ((pos) ? : list_entry(head, typeof(*pos), member))
571
572/**
Randy Dunlapfe96e572006-06-25 05:47:42 -0700573 * list_for_each_entry_continue - continue iteration over list of given type
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700574 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400576 * @member: the name of the list_head within the struct.
Randy Dunlapfe96e572006-06-25 05:47:42 -0700577 *
578 * Continue to iterate over list of given type, continuing after
579 * the current position.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 */
581#define list_for_each_entry_continue(pos, head, member) \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800582 for (pos = list_next_entry(pos, member); \
583 &pos->member != (head); \
584 pos = list_next_entry(pos, member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
586/**
Pavel Emelyanov768f35912007-09-18 13:20:41 -0700587 * list_for_each_entry_continue_reverse - iterate backwards from the given point
588 * @pos: the type * to use as a loop cursor.
589 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400590 * @member: the name of the list_head within the struct.
Pavel Emelyanov768f35912007-09-18 13:20:41 -0700591 *
592 * Start to iterate over list of given type backwards, continuing after
593 * the current position.
594 */
595#define list_for_each_entry_continue_reverse(pos, head, member) \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800596 for (pos = list_prev_entry(pos, member); \
597 &pos->member != (head); \
598 pos = list_prev_entry(pos, member))
Pavel Emelyanov768f35912007-09-18 13:20:41 -0700599
600/**
Randy Dunlapfe96e572006-06-25 05:47:42 -0700601 * list_for_each_entry_from - iterate over list of given type from the current point
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700602 * @pos: the type * to use as a loop cursor.
Arnaldo Carvalho de Meloe229c2f2006-03-20 17:19:17 -0800603 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400604 * @member: the name of the list_head within the struct.
Randy Dunlapfe96e572006-06-25 05:47:42 -0700605 *
606 * Iterate over list of given type, continuing from current position.
Arnaldo Carvalho de Meloe229c2f2006-03-20 17:19:17 -0800607 */
608#define list_for_each_entry_from(pos, head, member) \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800609 for (; &pos->member != (head); \
610 pos = list_next_entry(pos, member))
Arnaldo Carvalho de Meloe229c2f2006-03-20 17:19:17 -0800611
612/**
Jiri Pirkob8628152017-02-03 10:29:05 +0100613 * list_for_each_entry_from_reverse - iterate backwards over list of given type
614 * from the current point
615 * @pos: the type * to use as a loop cursor.
616 * @head: the head for your list.
617 * @member: the name of the list_head within the struct.
618 *
619 * Iterate backwards over list of given type, continuing from current position.
620 */
621#define list_for_each_entry_from_reverse(pos, head, member) \
622 for (; &pos->member != (head); \
623 pos = list_prev_entry(pos, member))
624
625/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700627 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 * @n: another type * to use as temporary storage
629 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400630 * @member: the name of the list_head within the struct.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 */
632#define list_for_each_entry_safe(pos, n, head, member) \
Oleg Nesterov93be3c22013-11-12 15:10:03 -0800633 for (pos = list_first_entry(head, typeof(*pos), member), \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800634 n = list_next_entry(pos, member); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 &pos->member != (head); \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800636 pos = n, n = list_next_entry(n, member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
638/**
Ben Hutchings9a86e2b2010-03-05 13:43:17 -0800639 * list_for_each_entry_safe_continue - continue list iteration safe against removal
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700640 * @pos: the type * to use as a loop cursor.
Arnaldo Carvalho de Melo74459dc2005-08-09 20:15:51 -0700641 * @n: another type * to use as temporary storage
642 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400643 * @member: the name of the list_head within the struct.
Randy Dunlapfe96e572006-06-25 05:47:42 -0700644 *
645 * Iterate over list of given type, continuing after current point,
646 * safe against removal of list entry.
Arnaldo Carvalho de Melo74459dc2005-08-09 20:15:51 -0700647 */
648#define list_for_each_entry_safe_continue(pos, n, head, member) \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800649 for (pos = list_next_entry(pos, member), \
650 n = list_next_entry(pos, member); \
Arnaldo Carvalho de Melo74459dc2005-08-09 20:15:51 -0700651 &pos->member != (head); \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800652 pos = n, n = list_next_entry(n, member))
Arnaldo Carvalho de Melo74459dc2005-08-09 20:15:51 -0700653
654/**
Ben Hutchings9a86e2b2010-03-05 13:43:17 -0800655 * list_for_each_entry_safe_from - iterate over list from current point safe against removal
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700656 * @pos: the type * to use as a loop cursor.
Arnaldo Carvalho de Melod8dcffe2006-03-20 17:18:05 -0800657 * @n: another type * to use as temporary storage
658 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400659 * @member: the name of the list_head within the struct.
Randy Dunlapfe96e572006-06-25 05:47:42 -0700660 *
661 * Iterate over list of given type from current point, safe against
662 * removal of list entry.
Arnaldo Carvalho de Melod8dcffe2006-03-20 17:18:05 -0800663 */
664#define list_for_each_entry_safe_from(pos, n, head, member) \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800665 for (n = list_next_entry(pos, member); \
Arnaldo Carvalho de Melod8dcffe2006-03-20 17:18:05 -0800666 &pos->member != (head); \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800667 pos = n, n = list_next_entry(n, member))
Arnaldo Carvalho de Melod8dcffe2006-03-20 17:18:05 -0800668
669/**
Ben Hutchings9a86e2b2010-03-05 13:43:17 -0800670 * list_for_each_entry_safe_reverse - iterate backwards over list safe against removal
Randy Dunlap8e3a67a2006-06-25 05:47:43 -0700671 * @pos: the type * to use as a loop cursor.
David Howells0ad42352006-01-09 20:51:31 -0800672 * @n: another type * to use as temporary storage
673 * @head: the head for your list.
Andrey Utkin3943f422014-11-14 05:09:55 +0400674 * @member: the name of the list_head within the struct.
Randy Dunlapfe96e572006-06-25 05:47:42 -0700675 *
676 * Iterate backwards over list of given type, safe against removal
677 * of list entry.
David Howells0ad42352006-01-09 20:51:31 -0800678 */
679#define list_for_each_entry_safe_reverse(pos, n, head, member) \
Oleg Nesterov93be3c22013-11-12 15:10:03 -0800680 for (pos = list_last_entry(head, typeof(*pos), member), \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800681 n = list_prev_entry(pos, member); \
David Howells0ad42352006-01-09 20:51:31 -0800682 &pos->member != (head); \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800683 pos = n, n = list_prev_entry(n, member))
David Howells0ad42352006-01-09 20:51:31 -0800684
npiggin@suse.de57439f82010-06-24 13:02:14 +1000685/**
686 * list_safe_reset_next - reset a stale list_for_each_entry_safe loop
687 * @pos: the loop cursor used in the list_for_each_entry_safe loop
688 * @n: temporary storage used in list_for_each_entry_safe
Andrey Utkin3943f422014-11-14 05:09:55 +0400689 * @member: the name of the list_head within the struct.
npiggin@suse.de57439f82010-06-24 13:02:14 +1000690 *
691 * list_safe_reset_next is not safe to use in general if the list may be
692 * modified concurrently (eg. the lock is dropped in the loop body). An
693 * exception to this is if the cursor element (pos) is pinned in the list,
694 * and list_safe_reset_next is called after re-taking the lock and before
695 * completing the current iteration of the loop body.
696 */
697#define list_safe_reset_next(pos, n, member) \
Oleg Nesterov8120e2e2013-11-12 15:10:02 -0800698 n = list_next_entry(pos, member)
npiggin@suse.de57439f82010-06-24 13:02:14 +1000699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700/*
701 * Double linked lists with a single pointer list head.
702 * Mostly useful for hash tables where the two pointer list head is
703 * too wasteful.
704 * You lose the ability to access the tail in O(1).
705 */
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707#define HLIST_HEAD_INIT { .first = NULL }
708#define HLIST_HEAD(name) struct hlist_head name = { .first = NULL }
709#define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
Zach Brown490d6ab2006-02-03 03:03:56 -0800710static inline void INIT_HLIST_NODE(struct hlist_node *h)
711{
712 h->next = NULL;
713 h->pprev = NULL;
714}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716static inline int hlist_unhashed(const struct hlist_node *h)
717{
718 return !h->pprev;
719}
720
721static inline int hlist_empty(const struct hlist_head *h)
722{
Paul E. McKenney1658d352015-09-20 17:03:16 -0700723 return !READ_ONCE(h->first);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724}
725
726static inline void __hlist_del(struct hlist_node *n)
727{
728 struct hlist_node *next = n->next;
729 struct hlist_node **pprev = n->pprev;
Paul E. McKenney7f5f8732015-09-18 08:45:22 -0700730
731 WRITE_ONCE(*pprev, next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 if (next)
733 next->pprev = pprev;
734}
735
736static inline void hlist_del(struct hlist_node *n)
737{
738 __hlist_del(n);
739 n->next = LIST_POISON1;
740 n->pprev = LIST_POISON2;
741}
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743static inline void hlist_del_init(struct hlist_node *n)
744{
Akinobu Mitada753be2006-04-28 15:21:23 -0700745 if (!hlist_unhashed(n)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 __hlist_del(n);
747 INIT_HLIST_NODE(n);
748 }
749}
750
751static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
752{
753 struct hlist_node *first = h->first;
754 n->next = first;
755 if (first)
756 first->pprev = &n->next;
Paul E. McKenney1c97be62015-09-20 22:02:17 -0700757 WRITE_ONCE(h->first, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 n->pprev = &h->first;
759}
760
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761/* next must be != NULL */
762static inline void hlist_add_before(struct hlist_node *n,
763 struct hlist_node *next)
764{
765 n->pprev = next->pprev;
766 n->next = next;
767 next->pprev = &n->next;
Paul E. McKenney1c97be62015-09-20 22:02:17 -0700768 WRITE_ONCE(*(n->pprev), n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769}
770
Ken Helias1d023282014-08-06 16:09:16 -0700771static inline void hlist_add_behind(struct hlist_node *n,
772 struct hlist_node *prev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773{
Ken Heliasbc18dd32014-08-06 16:09:14 -0700774 n->next = prev->next;
Paul E. McKenney1c97be62015-09-20 22:02:17 -0700775 WRITE_ONCE(prev->next, n);
Ken Heliasbc18dd32014-08-06 16:09:14 -0700776 n->pprev = &prev->next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
Ken Heliasbc18dd32014-08-06 16:09:14 -0700778 if (n->next)
779 n->next->pprev = &n->next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780}
781
Al Viro756acc22010-10-23 15:23:40 -0400782/* after that we'll appear to be on some hlist and hlist_del will work */
783static inline void hlist_add_fake(struct hlist_node *n)
784{
785 n->pprev = &n->next;
786}
787
Josef Bacikcbedaac2015-03-12 08:19:11 -0400788static inline bool hlist_fake(struct hlist_node *h)
789{
790 return h->pprev == &h->next;
791}
792
Vegard Nossum673d62cc2008-08-31 23:39:21 +0200793/*
Thomas Gleixner15dba1e2016-07-04 09:50:27 +0000794 * Check whether the node is the only node of the head without
795 * accessing head:
796 */
797static inline bool
798hlist_is_singular_node(struct hlist_node *n, struct hlist_head *h)
799{
800 return !n->next && n->pprev == &h->first;
801}
802
803/*
Vegard Nossum673d62cc2008-08-31 23:39:21 +0200804 * Move a list from one list head to another. Fixup the pprev
805 * reference of the first entry if it exists.
806 */
807static inline void hlist_move_list(struct hlist_head *old,
808 struct hlist_head *new)
809{
810 new->first = old->first;
811 if (new->first)
812 new->first->pprev = &new->first;
813 old->first = NULL;
814}
815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816#define hlist_entry(ptr, type, member) container_of(ptr,type,member)
817
818#define hlist_for_each(pos, head) \
Linus Torvalds75d65a42011-05-19 13:50:07 -0700819 for (pos = (head)->first; pos ; pos = pos->next)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
821#define hlist_for_each_safe(pos, n, head) \
822 for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
823 pos = n)
824
Sasha Levinb67bfe02013-02-27 17:06:00 -0800825#define hlist_entry_safe(ptr, type, member) \
Paul E. McKenneyf65846a2013-03-09 07:38:41 -0800826 ({ typeof(ptr) ____ptr = (ptr); \
827 ____ptr ? hlist_entry(____ptr, type, member) : NULL; \
828 })
Sasha Levinb67bfe02013-02-27 17:06:00 -0800829
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830/**
831 * hlist_for_each_entry - iterate over list of given type
Sasha Levinb67bfe02013-02-27 17:06:00 -0800832 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 * @head: the head for your list.
834 * @member: the name of the hlist_node within the struct.
835 */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800836#define hlist_for_each_entry(pos, head, member) \
837 for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\
838 pos; \
839 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
841/**
Randy Dunlapfe96e572006-06-25 05:47:42 -0700842 * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
Sasha Levinb67bfe02013-02-27 17:06:00 -0800843 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 * @member: the name of the hlist_node within the struct.
845 */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800846#define hlist_for_each_entry_continue(pos, member) \
847 for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member);\
848 pos; \
849 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
851/**
Randy Dunlapfe96e572006-06-25 05:47:42 -0700852 * hlist_for_each_entry_from - iterate over a hlist continuing from current point
Sasha Levinb67bfe02013-02-27 17:06:00 -0800853 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 * @member: the name of the hlist_node within the struct.
855 */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800856#define hlist_for_each_entry_from(pos, member) \
857 for (; pos; \
858 pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
860/**
861 * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
Sasha Levinb67bfe02013-02-27 17:06:00 -0800862 * @pos: the type * to use as a loop cursor.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 * @n: another &struct hlist_node to use as temporary storage
864 * @head: the head for your list.
865 * @member: the name of the hlist_node within the struct.
866 */
Sasha Levinb67bfe02013-02-27 17:06:00 -0800867#define hlist_for_each_entry_safe(pos, n, head, member) \
868 for (pos = hlist_entry_safe((head)->first, typeof(*pos), member);\
869 pos && ({ n = pos->member.next; 1; }); \
870 pos = hlist_entry_safe(n, typeof(*pos), member))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872#endif