parlib: Add cpu_relax_any()
[akaros.git] / kern / include / list.h
1 /* Linux's list definitions.
2  *
3  * From commit bc208e0ee0f46744aac95c29366144271a6962bb */
4
5 #pragma once
6
7 /*
8  * Architectures might want to move the poison pointer offset
9  * into some well-recognized area such as 0xdead000000000000,
10  * that is also not mappable by user-space exploits:
11  */
12 #ifdef CONFIG_ILLEGAL_POINTER_VALUE
13 # define POISON_POINTER_DELTA _AC(CONFIG_ILLEGAL_POINTER_VALUE, UL)
14 #else
15 # define POISON_POINTER_DELTA 0
16 #endif
17
18 /*
19  * These are non-NULL pointers that will result in page faults
20  * under normal circumstances, used to verify that nobody uses
21  * non-initialized list entries.
22  */
23 #define LIST_POISON1  ((void *) 0x00100100 + POISON_POINTER_DELTA)
24 #define LIST_POISON2  ((void *) 0x00200200 + POISON_POINTER_DELTA)
25
26 struct list_head {
27     struct list_head *next, *prev;
28 };
29
30 struct hlist_head {
31     struct hlist_node *first;
32 };
33
34 struct hlist_node {
35     struct hlist_node *next, **pprev;
36 };
37
38 /*
39  * Simple doubly linked list implementation.
40  *
41  * Some of the internal functions ("__xxx") are useful when
42  * manipulating whole lists rather than single entries, as
43  * sometimes we already know the next/prev entries and we can
44  * generate better code by using them directly rather than
45  * using the generic single-entry routines.
46  */
47
48 #define LIST_HEAD_INIT(name) { &(name), &(name) }
49
50 #define LINUX_LIST_HEAD(name) \
51         struct list_head name = LIST_HEAD_INIT(name)
52
53 static inline void INIT_LIST_HEAD(struct list_head *list)
54 {
55         list->next = list;
56         list->prev = list;
57 }
58
59 /*
60  * Insert a new entry between two known consecutive entries.
61  *
62  * This is only for internal list manipulation where we know
63  * the prev/next entries already!
64  */
65 #ifndef CONFIG_DEBUG_LIST
66 static inline void __list_add(struct list_head *new,
67                               struct list_head *prev,
68                               struct list_head *next)
69 {
70         next->prev = new;
71         new->next = next;
72         new->prev = prev;
73         prev->next = new;
74 }
75 #else
76 extern void __list_add(struct list_head *new,
77                               struct list_head *prev,
78                               struct list_head *next);
79 #endif
80
81 /**
82  * list_add - add a new entry
83  * @new: new entry to be added
84  * @head: list head to add it after
85  *
86  * Insert a new entry after the specified head.
87  * This is good for implementing stacks.
88  */
89 static inline void list_add(struct list_head *new, struct list_head *head)
90 {
91         __list_add(new, head, head->next);
92 }
93
94
95 /**
96  * list_add_tail - add a new entry
97  * @new: new entry to be added
98  * @head: list head to add it before
99  *
100  * Insert a new entry before the specified head.
101  * This is useful for implementing queues.
102  */
103 static inline void list_add_tail(struct list_head *new, struct list_head *head)
104 {
105         __list_add(new, head->prev, head);
106 }
107
108 /*
109  * Delete a list entry by making the prev/next entries
110  * point to each other.
111  *
112  * This is only for internal list manipulation where we know
113  * the prev/next entries already!
114  */
115 static inline void __list_del(struct list_head * prev, struct list_head * next)
116 {
117         next->prev = prev;
118         prev->next = next;
119 }
120
121 /**
122  * list_del - deletes entry from list.
123  * @entry: the element to delete from the list.
124  * Note: list_empty() on entry does not return true after this, the entry is
125  * in an undefined state.
126  */
127 #ifndef CONFIG_DEBUG_LIST
128 static inline void __list_del_entry(struct list_head *entry)
129 {
130         __list_del(entry->prev, entry->next);
131 }
132
133 static inline void list_del(struct list_head *entry)
134 {
135         __list_del(entry->prev, entry->next);
136         entry->next = LIST_POISON1;
137         entry->prev = LIST_POISON2;
138 }
139 #else
140 extern void __list_del_entry(struct list_head *entry);
141 extern void list_del(struct list_head *entry);
142 #endif
143
144 /**
145  * list_replace - replace old entry by new one
146  * @old : the element to be replaced
147  * @new : the new element to insert
148  *
149  * If @old was empty, it will be overwritten.
150  */
151 static inline void list_replace(struct list_head *old,
152                                 struct list_head *new)
153 {
154         new->next = old->next;
155         new->next->prev = new;
156         new->prev = old->prev;
157         new->prev->next = new;
158 }
159
160 static inline void list_replace_init(struct list_head *old,
161                                         struct list_head *new)
162 {
163         list_replace(old, new);
164         INIT_LIST_HEAD(old);
165 }
166
167 /**
168  * list_del_init - deletes entry from list and reinitialize it.
169  * @entry: the element to delete from the list.
170  */
171 static inline void list_del_init(struct list_head *entry)
172 {
173         __list_del_entry(entry);
174         INIT_LIST_HEAD(entry);
175 }
176
177 /**
178  * list_move - delete from one list and add as another's head
179  * @list: the entry to move
180  * @head: the head that will precede our entry
181  */
182 static inline void list_move(struct list_head *list, struct list_head *head)
183 {
184         __list_del_entry(list);
185         list_add(list, head);
186 }
187
188 /**
189  * list_move_tail - delete from one list and add as another's tail
190  * @list: the entry to move
191  * @head: the head that will follow our entry
192  */
193 static inline void list_move_tail(struct list_head *list,
194                                   struct list_head *head)
195 {
196         __list_del_entry(list);
197         list_add_tail(list, head);
198 }
199
200 /**
201  * list_is_last - tests whether @list is the last entry in list @head
202  * @list: the entry to test
203  * @head: the head of the list
204  */
205 static inline int list_is_last(const struct list_head *list,
206                                 const struct list_head *head)
207 {
208         return list->next == head;
209 }
210
211 /**
212  * list_empty - tests whether a list is empty
213  * @head: the list to test.
214  */
215 static inline int list_empty(const struct list_head *head)
216 {
217         return head->next == head;
218 }
219
220 /**
221  * list_empty_careful - tests whether a list is empty and not being modified
222  * @head: the list to test
223  *
224  * Description:
225  * tests whether a list is empty _and_ checks that no other CPU might be
226  * in the process of modifying either member (next or prev)
227  *
228  * NOTE: using list_empty_careful() without synchronization
229  * can only be safe if the only activity that can happen
230  * to the list entry is list_del_init(). Eg. it cannot be used
231  * if another CPU could re-list_add() it.
232  */
233 static inline int list_empty_careful(const struct list_head *head)
234 {
235         struct list_head *next = head->next;
236         return (next == head) && (next == head->prev);
237 }
238
239 /**
240  * list_rotate_left - rotate the list to the left
241  * @head: the head of the list
242  */
243 static inline void list_rotate_left(struct list_head *head)
244 {
245         struct list_head *first;
246
247         if (!list_empty(head)) {
248                 first = head->next;
249                 list_move_tail(first, head);
250         }
251 }
252
253 /**
254  * list_is_singular - tests whether a list has just one entry.
255  * @head: the list to test.
256  */
257 static inline int list_is_singular(const struct list_head *head)
258 {
259         return !list_empty(head) && (head->next == head->prev);
260 }
261
262 static inline void __list_cut_position(struct list_head *list,
263                 struct list_head *head, struct list_head *entry)
264 {
265         struct list_head *new_first = entry->next;
266         list->next = head->next;
267         list->next->prev = list;
268         list->prev = entry;
269         entry->next = list;
270         head->next = new_first;
271         new_first->prev = head;
272 }
273
274 /**
275  * list_cut_position - cut a list into two
276  * @list: a new list to add all removed entries
277  * @head: a list with entries
278  * @entry: an entry within head, could be the head itself
279  *      and if so we won't cut the list
280  *
281  * This helper moves the initial part of @head, up to and
282  * including @entry, from @head to @list. You should
283  * pass on @entry an element you know is on @head. @list
284  * should be an empty list or a list you do not care about
285  * losing its data.
286  *
287  */
288 static inline void list_cut_position(struct list_head *list,
289                 struct list_head *head, struct list_head *entry)
290 {
291         if (list_empty(head))
292                 return;
293         if (list_is_singular(head) &&
294                 (head->next != entry && head != entry))
295                 return;
296         if (entry == head)
297                 INIT_LIST_HEAD(list);
298         else
299                 __list_cut_position(list, head, entry);
300 }
301
302 static inline void __list_splice(const struct list_head *list,
303                                  struct list_head *prev,
304                                  struct list_head *next)
305 {
306         struct list_head *first = list->next;
307         struct list_head *last = list->prev;
308
309         first->prev = prev;
310         prev->next = first;
311
312         last->next = next;
313         next->prev = last;
314 }
315
316 /**
317  * list_splice - join two lists, this is designed for stacks
318  * @list: the new list to add.
319  * @head: the place to add it in the first list.
320  */
321 static inline void list_splice(const struct list_head *list,
322                                 struct list_head *head)
323 {
324         if (!list_empty(list))
325                 __list_splice(list, head, head->next);
326 }
327
328 /**
329  * list_splice_tail - join two lists, each list being a queue
330  * @list: the new list to add.
331  * @head: the place to add it in the first list.
332  */
333 static inline void list_splice_tail(struct list_head *list,
334                                 struct list_head *head)
335 {
336         if (!list_empty(list))
337                 __list_splice(list, head->prev, head);
338 }
339
340 /**
341  * list_splice_init - join two lists and reinitialise the emptied list.
342  * @list: the new list to add.
343  * @head: the place to add it in the first list.
344  *
345  * The list at @list is reinitialised
346  */
347 static inline void list_splice_init(struct list_head *list,
348                                     struct list_head *head)
349 {
350         if (!list_empty(list)) {
351                 __list_splice(list, head, head->next);
352                 INIT_LIST_HEAD(list);
353         }
354 }
355
356 /**
357  * list_splice_tail_init - join two lists and reinitialise the emptied list
358  * @list: the new list to add.
359  * @head: the place to add it in the first list.
360  *
361  * Each of the lists is a queue.
362  * The list at @list is reinitialised
363  */
364 static inline void list_splice_tail_init(struct list_head *list,
365                                          struct list_head *head)
366 {
367         if (!list_empty(list)) {
368                 __list_splice(list, head->prev, head);
369                 INIT_LIST_HEAD(list);
370         }
371 }
372
373 /**
374  * list_entry - get the struct for this entry
375  * @ptr:        the &struct list_head pointer.
376  * @type:       the type of the struct this is embedded in.
377  * @member:     the name of the list_head within the struct.
378  */
379 #define list_entry(ptr, type, member) \
380         container_of(ptr, type, member)
381
382 /**
383  * list_first_entry - get the first element from a list
384  * @ptr:        the list head to take the element from.
385  * @type:       the type of the struct this is embedded in.
386  * @member:     the name of the list_head within the struct.
387  *
388  * Note, that list is expected to be not empty.
389  */
390 #define list_first_entry(ptr, type, member) \
391         list_entry((ptr)->next, type, member)
392
393 /**
394  * list_last_entry - get the last element from a list
395  * @ptr:        the list head to take the element from.
396  * @type:       the type of the struct this is embedded in.
397  * @member:     the name of the list_head within the struct.
398  *
399  * Note, that list is expected to be not empty.
400  */
401 #define list_last_entry(ptr, type, member) \
402         list_entry((ptr)->prev, type, member)
403
404 /**
405  * list_first_entry_or_null - get the first element from a list
406  * @ptr:        the list head to take the element from.
407  * @type:       the type of the struct this is embedded in.
408  * @member:     the name of the list_head within the struct.
409  *
410  * Note that if the list is empty, it returns NULL.
411  */
412 #define list_first_entry_or_null(ptr, type, member) \
413         (!list_empty(ptr) ? list_first_entry(ptr, type, member) : NULL)
414
415 /**
416  * list_next_entry - get the next element in list
417  * @pos:        the type * to cursor
418  * @member:     the name of the list_head within the struct.
419  */
420 #define list_next_entry(pos, member) \
421         list_entry((pos)->member.next, typeof(*(pos)), member)
422
423 /**
424  * list_prev_entry - get the prev element in list
425  * @pos:        the type * to cursor
426  * @member:     the name of the list_head within the struct.
427  */
428 #define list_prev_entry(pos, member) \
429         list_entry((pos)->member.prev, typeof(*(pos)), member)
430
431 /**
432  * list_for_each        -       iterate over a list
433  * @pos:        the &struct list_head to use as a loop cursor.
434  * @head:       the head for your list.
435  */
436 #define list_for_each(pos, head) \
437         for (pos = (head)->next; pos != (head); pos = pos->next)
438
439 /**
440  * list_for_each_prev   -       iterate over a list backwards
441  * @pos:        the &struct list_head to use as a loop cursor.
442  * @head:       the head for your list.
443  */
444 #define list_for_each_prev(pos, head) \
445         for (pos = (head)->prev; pos != (head); pos = pos->prev)
446
447 /**
448  * list_for_each_safe - iterate over a list safe against removal of list entry
449  * @pos:        the &struct list_head to use as a loop cursor.
450  * @n:          another &struct list_head to use as temporary storage
451  * @head:       the head for your list.
452  */
453 #define list_for_each_safe(pos, n, head) \
454         for (pos = (head)->next, n = pos->next; pos != (head); \
455                 pos = n, n = pos->next)
456
457 /**
458  * list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
459  * @pos:        the &struct list_head to use as a loop cursor.
460  * @n:          another &struct list_head to use as temporary storage
461  * @head:       the head for your list.
462  */
463 #define list_for_each_prev_safe(pos, n, head) \
464         for (pos = (head)->prev, n = pos->prev; \
465              pos != (head); \
466              pos = n, n = pos->prev)
467
468 /**
469  * list_for_each_entry  -       iterate over list of given type
470  * @pos:        the type * to use as a loop cursor.
471  * @head:       the head for your list.
472  * @member:     the name of the list_head within the struct.
473  */
474 #define list_for_each_entry(pos, head, member)                          \
475         for (pos = list_first_entry(head, typeof(*pos), member);        \
476              &pos->member != (head);                                    \
477              pos = list_next_entry(pos, member))
478
479 /**
480  * list_for_each_entry_reverse - iterate backwards over list of given type.
481  * @pos:        the type * to use as a loop cursor.
482  * @head:       the head for your list.
483  * @member:     the name of the list_head within the struct.
484  */
485 #define list_for_each_entry_reverse(pos, head, member)                  \
486         for (pos = list_last_entry(head, typeof(*pos), member);         \
487              &pos->member != (head);                                    \
488              pos = list_prev_entry(pos, member))
489
490 /**
491  * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
492  * @pos:        the type * to use as a start point
493  * @head:       the head of the list
494  * @member:     the name of the list_head within the struct.
495  *
496  * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
497  */
498 #define list_prepare_entry(pos, head, member) \
499         ((pos) ? : list_entry(head, typeof(*pos), member))
500
501 /**
502  * list_for_each_entry_continue - continue iteration over list of given type
503  * @pos:        the type * to use as a loop cursor.
504  * @head:       the head for your list.
505  * @member:     the name of the list_head within the struct.
506  *
507  * Continue to iterate over list of given type, continuing after
508  * the current position.
509  */
510 #define list_for_each_entry_continue(pos, head, member)                 \
511         for (pos = list_next_entry(pos, member);                        \
512              &pos->member != (head);                                    \
513              pos = list_next_entry(pos, member))
514
515 /**
516  * list_for_each_entry_continue_reverse - iterate backwards from the given point
517  * @pos:        the type * to use as a loop cursor.
518  * @head:       the head for your list.
519  * @member:     the name of the list_head within the struct.
520  *
521  * Start to iterate over list of given type backwards, continuing after
522  * the current position.
523  */
524 #define list_for_each_entry_continue_reverse(pos, head, member)         \
525         for (pos = list_prev_entry(pos, member);                        \
526              &pos->member != (head);                                    \
527              pos = list_prev_entry(pos, member))
528
529 /**
530  * list_for_each_entry_from - iterate over list of given type from the current point
531  * @pos:        the type * to use as a loop cursor.
532  * @head:       the head for your list.
533  * @member:     the name of the list_head within the struct.
534  *
535  * Iterate over list of given type, continuing from current position.
536  */
537 #define list_for_each_entry_from(pos, head, member)                     \
538         for (; &pos->member != (head);                                  \
539              pos = list_next_entry(pos, member))
540
541 /**
542  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
543  * @pos:        the type * to use as a loop cursor.
544  * @n:          another type * to use as temporary storage
545  * @head:       the head for your list.
546  * @member:     the name of the list_head within the struct.
547  */
548 #define list_for_each_entry_safe(pos, n, head, member)                  \
549         for (pos = list_first_entry(head, typeof(*pos), member),        \
550                 n = list_next_entry(pos, member);                       \
551              &pos->member != (head);                                    \
552              pos = n, n = list_next_entry(n, member))
553
554 /**
555  * list_for_each_entry_safe_continue - continue list iteration safe against removal
556  * @pos:        the type * to use as a loop cursor.
557  * @n:          another type * to use as temporary storage
558  * @head:       the head for your list.
559  * @member:     the name of the list_head within the struct.
560  *
561  * Iterate over list of given type, continuing after current point,
562  * safe against removal of list entry.
563  */
564 #define list_for_each_entry_safe_continue(pos, n, head, member)                 \
565         for (pos = list_next_entry(pos, member),                                \
566                 n = list_next_entry(pos, member);                               \
567              &pos->member != (head);                                            \
568              pos = n, n = list_next_entry(n, member))
569
570 /**
571  * list_for_each_entry_safe_from - iterate over list from current point safe against removal
572  * @pos:        the type * to use as a loop cursor.
573  * @n:          another type * to use as temporary storage
574  * @head:       the head for your list.
575  * @member:     the name of the list_head within the struct.
576  *
577  * Iterate over list of given type from current point, safe against
578  * removal of list entry.
579  */
580 #define list_for_each_entry_safe_from(pos, n, head, member)                     \
581         for (n = list_next_entry(pos, member);                                  \
582              &pos->member != (head);                                            \
583              pos = n, n = list_next_entry(n, member))
584
585 /**
586  * list_for_each_entry_safe_reverse - iterate backwards over list safe against removal
587  * @pos:        the type * to use as a loop cursor.
588  * @n:          another type * to use as temporary storage
589  * @head:       the head for your list.
590  * @member:     the name of the list_head within the struct.
591  *
592  * Iterate backwards over list of given type, safe against removal
593  * of list entry.
594  */
595 #define list_for_each_entry_safe_reverse(pos, n, head, member)          \
596         for (pos = list_last_entry(head, typeof(*pos), member),         \
597                 n = list_prev_entry(pos, member);                       \
598              &pos->member != (head);                                    \
599              pos = n, n = list_prev_entry(n, member))
600
601 /**
602  * list_safe_reset_next - reset a stale list_for_each_entry_safe loop
603  * @pos:        the loop cursor used in the list_for_each_entry_safe loop
604  * @n:          temporary storage used in list_for_each_entry_safe
605  * @member:     the name of the list_head within the struct.
606  *
607  * list_safe_reset_next is not safe to use in general if the list may be
608  * modified concurrently (eg. the lock is dropped in the loop body). An
609  * exception to this is if the cursor element (pos) is pinned in the list,
610  * and list_safe_reset_next is called after re-taking the lock and before
611  * completing the current iteration of the loop body.
612  */
613 #define list_safe_reset_next(pos, n, member)                            \
614         n = list_next_entry(pos, member)
615
616 /*
617  * Double linked lists with a single pointer list head.
618  * Mostly useful for hash tables where the two pointer list head is
619  * too wasteful.
620  * You lose the ability to access the tail in O(1).
621  */
622
623 #define HLIST_HEAD_INIT { .first = NULL }
624 #define HLIST_HEAD(name) struct hlist_head name = {  .first = NULL }
625 #define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
626 static inline void INIT_HLIST_NODE(struct hlist_node *h)
627 {
628         h->next = NULL;
629         h->pprev = NULL;
630 }
631
632 static inline int hlist_unhashed(const struct hlist_node *h)
633 {
634         return !h->pprev;
635 }
636
637 static inline int hlist_empty(const struct hlist_head *h)
638 {
639         return !h->first;
640 }
641
642 static inline void __hlist_del(struct hlist_node *n)
643 {
644         struct hlist_node *next = n->next;
645         struct hlist_node **pprev = n->pprev;
646         *pprev = next;
647         if (next)
648                 next->pprev = pprev;
649 }
650
651 static inline void hlist_del(struct hlist_node *n)
652 {
653         __hlist_del(n);
654         n->next = LIST_POISON1;
655         n->pprev = LIST_POISON2;
656 }
657
658 static inline void hlist_del_init(struct hlist_node *n)
659 {
660         if (!hlist_unhashed(n)) {
661                 __hlist_del(n);
662                 INIT_HLIST_NODE(n);
663         }
664 }
665
666 static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
667 {
668         struct hlist_node *first = h->first;
669         n->next = first;
670         if (first)
671                 first->pprev = &n->next;
672         h->first = n;
673         n->pprev = &h->first;
674 }
675
676 /* next must be != NULL */
677 static inline void hlist_add_before(struct hlist_node *n,
678                                         struct hlist_node *next)
679 {
680         n->pprev = next->pprev;
681         n->next = next;
682         next->pprev = &n->next;
683         *(n->pprev) = n;
684 }
685
686 static inline void hlist_add_behind(struct hlist_node *n,
687                                     struct hlist_node *prev)
688 {
689         n->next = prev->next;
690         prev->next = n;
691         n->pprev = &prev->next;
692
693         if (n->next)
694                 n->next->pprev  = &n->next;
695 }
696
697 /* after that we'll appear to be on some hlist and hlist_del will work */
698 static inline void hlist_add_fake(struct hlist_node *n)
699 {
700         n->pprev = &n->next;
701 }
702
703 /*
704  * Move a list from one list head to another. Fixup the pprev
705  * reference of the first entry if it exists.
706  */
707 static inline void hlist_move_list(struct hlist_head *old,
708                                    struct hlist_head *new)
709 {
710         new->first = old->first;
711         if (new->first)
712                 new->first->pprev = &new->first;
713         old->first = NULL;
714 }
715
716 #define hlist_entry(ptr, type, member) container_of(ptr,type,member)
717
718 #define hlist_for_each(pos, head) \
719         for (pos = (head)->first; pos ; pos = pos->next)
720
721 #define hlist_for_each_safe(pos, n, head) \
722         for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
723              pos = n)
724
725 #define hlist_entry_safe(ptr, type, member) \
726         ({ typeof(ptr) ____ptr = (ptr); \
727            ____ptr ? hlist_entry(____ptr, type, member) : NULL; \
728         })
729
730 /**
731  * hlist_for_each_entry - iterate over list of given type
732  * @pos:        the type * to use as a loop cursor.
733  * @head:       the head for your list.
734  * @member:     the name of the hlist_node within the struct.
735  */
736 #define hlist_for_each_entry(pos, head, member)                         \
737         for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\
738              pos;                                                       \
739              pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
740
741 /**
742  * hlist_for_each_entry_continue - iterate over a hlist continuing after current point
743  * @pos:        the type * to use as a loop cursor.
744  * @member:     the name of the hlist_node within the struct.
745  */
746 #define hlist_for_each_entry_continue(pos, member)                      \
747         for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member);\
748              pos;                                                       \
749              pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
750
751 /**
752  * hlist_for_each_entry_from - iterate over a hlist continuing from current point
753  * @pos:        the type * to use as a loop cursor.
754  * @member:     the name of the hlist_node within the struct.
755  */
756 #define hlist_for_each_entry_from(pos, member)                          \
757         for (; pos;                                                     \
758              pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
759
760 /**
761  * hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
762  * @pos:        the type * to use as a loop cursor.
763  * @n:          another &struct hlist_node to use as temporary storage
764  * @head:       the head for your list.
765  * @member:     the name of the hlist_node within the struct.
766  */
767 #define hlist_for_each_entry_safe(pos, n, head, member)                 \
768         for (pos = hlist_entry_safe((head)->first, typeof(*pos), member);\
769              pos && ({ n = pos->member.next; 1; });                     \
770              pos = hlist_entry_safe(n, typeof(*pos), member))