xref: /rk3399_rockchip-uboot/include/linux/list.h (revision 700a0c648df72f2c8e0589c0d0470b5ffd7cab7b)
1*700a0c64SWolfgang Denk #ifndef _LINUX_LIST_H
2*700a0c64SWolfgang Denk #define _LINUX_LIST_H
3*700a0c64SWolfgang Denk 
4*700a0c64SWolfgang Denk #ifndef ARCH_HAS_PREFETCH
5*700a0c64SWolfgang Denk #define ARCH_HAS_PREFETCH
6*700a0c64SWolfgang Denk static inline void prefetch(const void *x) {;}
7*700a0c64SWolfgang Denk #endif
8*700a0c64SWolfgang Denk 
9*700a0c64SWolfgang Denk /*
10*700a0c64SWolfgang Denk  * Simple doubly linked list implementation.
11*700a0c64SWolfgang Denk  *
12*700a0c64SWolfgang Denk  * Some of the internal functions ("__xxx") are useful when
13*700a0c64SWolfgang Denk  * manipulating whole lists rather than single entries, as
14*700a0c64SWolfgang Denk  * sometimes we already know the next/prev entries and we can
15*700a0c64SWolfgang Denk  * generate better code by using them directly rather than
16*700a0c64SWolfgang Denk  * using the generic single-entry routines.
17*700a0c64SWolfgang Denk  */
18*700a0c64SWolfgang Denk 
19*700a0c64SWolfgang Denk struct list_head {
20*700a0c64SWolfgang Denk 	struct list_head *next, *prev;
21*700a0c64SWolfgang Denk };
22*700a0c64SWolfgang Denk 
23*700a0c64SWolfgang Denk #define LIST_HEAD_INIT(name) { &(name), &(name) }
24*700a0c64SWolfgang Denk 
25*700a0c64SWolfgang Denk #define LIST_HEAD(name) \
26*700a0c64SWolfgang Denk 	struct list_head name = LIST_HEAD_INIT(name)
27*700a0c64SWolfgang Denk 
28*700a0c64SWolfgang Denk #define INIT_LIST_HEAD(ptr) do { \
29*700a0c64SWolfgang Denk 	(ptr)->next = (ptr); (ptr)->prev = (ptr); \
30*700a0c64SWolfgang Denk } while (0)
31*700a0c64SWolfgang Denk 
32*700a0c64SWolfgang Denk /*
33*700a0c64SWolfgang Denk  * Insert a new entry between two known consecutive entries.
34*700a0c64SWolfgang Denk  *
35*700a0c64SWolfgang Denk  * This is only for internal list manipulation where we know
36*700a0c64SWolfgang Denk  * the prev/next entries already!
37*700a0c64SWolfgang Denk  */
38*700a0c64SWolfgang Denk static inline void __list_add(struct list_head *new,
39*700a0c64SWolfgang Denk 			      struct list_head *prev,
40*700a0c64SWolfgang Denk 			      struct list_head *next)
41*700a0c64SWolfgang Denk {
42*700a0c64SWolfgang Denk 	next->prev = new;
43*700a0c64SWolfgang Denk 	new->next = next;
44*700a0c64SWolfgang Denk 	new->prev = prev;
45*700a0c64SWolfgang Denk 	prev->next = new;
46*700a0c64SWolfgang Denk }
47*700a0c64SWolfgang Denk 
48*700a0c64SWolfgang Denk /**
49*700a0c64SWolfgang Denk  * list_add - add a new entry
50*700a0c64SWolfgang Denk  * @new: new entry to be added
51*700a0c64SWolfgang Denk  * @head: list head to add it after
52*700a0c64SWolfgang Denk  *
53*700a0c64SWolfgang Denk  * Insert a new entry after the specified head.
54*700a0c64SWolfgang Denk  * This is good for implementing stacks.
55*700a0c64SWolfgang Denk  */
56*700a0c64SWolfgang Denk static inline void list_add(struct list_head *new, struct list_head *head)
57*700a0c64SWolfgang Denk {
58*700a0c64SWolfgang Denk 	__list_add(new, head, head->next);
59*700a0c64SWolfgang Denk }
60*700a0c64SWolfgang Denk 
61*700a0c64SWolfgang Denk /**
62*700a0c64SWolfgang Denk  * list_add_tail - add a new entry
63*700a0c64SWolfgang Denk  * @new: new entry to be added
64*700a0c64SWolfgang Denk  * @head: list head to add it before
65*700a0c64SWolfgang Denk  *
66*700a0c64SWolfgang Denk  * Insert a new entry before the specified head.
67*700a0c64SWolfgang Denk  * This is useful for implementing queues.
68*700a0c64SWolfgang Denk  */
69*700a0c64SWolfgang Denk static inline void list_add_tail(struct list_head *new, struct list_head *head)
70*700a0c64SWolfgang Denk {
71*700a0c64SWolfgang Denk 	__list_add(new, head->prev, head);
72*700a0c64SWolfgang Denk }
73*700a0c64SWolfgang Denk 
74*700a0c64SWolfgang Denk /*
75*700a0c64SWolfgang Denk  * Delete a list entry by making the prev/next entries
76*700a0c64SWolfgang Denk  * point to each other.
77*700a0c64SWolfgang Denk  *
78*700a0c64SWolfgang Denk  * This is only for internal list manipulation where we know
79*700a0c64SWolfgang Denk  * the prev/next entries already!
80*700a0c64SWolfgang Denk  */
81*700a0c64SWolfgang Denk static inline void __list_del(struct list_head *prev, struct list_head *next)
82*700a0c64SWolfgang Denk {
83*700a0c64SWolfgang Denk 	next->prev = prev;
84*700a0c64SWolfgang Denk 	prev->next = next;
85*700a0c64SWolfgang Denk }
86*700a0c64SWolfgang Denk 
87*700a0c64SWolfgang Denk /**
88*700a0c64SWolfgang Denk  * list_del - deletes entry from list.
89*700a0c64SWolfgang Denk  * @entry: the element to delete from the list.
90*700a0c64SWolfgang Denk  * Note: list_empty on entry does not return true after this, the entry is in an undefined state.
91*700a0c64SWolfgang Denk  */
92*700a0c64SWolfgang Denk static inline void list_del(struct list_head *entry)
93*700a0c64SWolfgang Denk {
94*700a0c64SWolfgang Denk 	__list_del(entry->prev, entry->next);
95*700a0c64SWolfgang Denk 	entry->next = (void *) 0;
96*700a0c64SWolfgang Denk 	entry->prev = (void *) 0;
97*700a0c64SWolfgang Denk }
98*700a0c64SWolfgang Denk 
99*700a0c64SWolfgang Denk /**
100*700a0c64SWolfgang Denk  * list_del_init - deletes entry from list and reinitialize it.
101*700a0c64SWolfgang Denk  * @entry: the element to delete from the list.
102*700a0c64SWolfgang Denk  */
103*700a0c64SWolfgang Denk static inline void list_del_init(struct list_head *entry)
104*700a0c64SWolfgang Denk {
105*700a0c64SWolfgang Denk 	__list_del(entry->prev, entry->next);
106*700a0c64SWolfgang Denk 	INIT_LIST_HEAD(entry);
107*700a0c64SWolfgang Denk }
108*700a0c64SWolfgang Denk 
109*700a0c64SWolfgang Denk /**
110*700a0c64SWolfgang Denk  * list_move - delete from one list and add as another's head
111*700a0c64SWolfgang Denk  * @list: the entry to move
112*700a0c64SWolfgang Denk  * @head: the head that will precede our entry
113*700a0c64SWolfgang Denk  */
114*700a0c64SWolfgang Denk static inline void list_move(struct list_head *list, struct list_head *head)
115*700a0c64SWolfgang Denk {
116*700a0c64SWolfgang Denk         __list_del(list->prev, list->next);
117*700a0c64SWolfgang Denk         list_add(list, head);
118*700a0c64SWolfgang Denk }
119*700a0c64SWolfgang Denk 
120*700a0c64SWolfgang Denk /**
121*700a0c64SWolfgang Denk  * list_move_tail - delete from one list and add as another's tail
122*700a0c64SWolfgang Denk  * @list: the entry to move
123*700a0c64SWolfgang Denk  * @head: the head that will follow our entry
124*700a0c64SWolfgang Denk  */
125*700a0c64SWolfgang Denk static inline void list_move_tail(struct list_head *list,
126*700a0c64SWolfgang Denk 				  struct list_head *head)
127*700a0c64SWolfgang Denk {
128*700a0c64SWolfgang Denk         __list_del(list->prev, list->next);
129*700a0c64SWolfgang Denk         list_add_tail(list, head);
130*700a0c64SWolfgang Denk }
131*700a0c64SWolfgang Denk 
132*700a0c64SWolfgang Denk /**
133*700a0c64SWolfgang Denk  * list_empty - tests whether a list is empty
134*700a0c64SWolfgang Denk  * @head: the list to test.
135*700a0c64SWolfgang Denk  */
136*700a0c64SWolfgang Denk static inline int list_empty(struct list_head *head)
137*700a0c64SWolfgang Denk {
138*700a0c64SWolfgang Denk 	return head->next == head;
139*700a0c64SWolfgang Denk }
140*700a0c64SWolfgang Denk 
141*700a0c64SWolfgang Denk static inline void __list_splice(struct list_head *list,
142*700a0c64SWolfgang Denk 				 struct list_head *head)
143*700a0c64SWolfgang Denk {
144*700a0c64SWolfgang Denk 	struct list_head *first = list->next;
145*700a0c64SWolfgang Denk 	struct list_head *last = list->prev;
146*700a0c64SWolfgang Denk 	struct list_head *at = head->next;
147*700a0c64SWolfgang Denk 
148*700a0c64SWolfgang Denk 	first->prev = head;
149*700a0c64SWolfgang Denk 	head->next = first;
150*700a0c64SWolfgang Denk 
151*700a0c64SWolfgang Denk 	last->next = at;
152*700a0c64SWolfgang Denk 	at->prev = last;
153*700a0c64SWolfgang Denk }
154*700a0c64SWolfgang Denk 
155*700a0c64SWolfgang Denk /**
156*700a0c64SWolfgang Denk  * list_splice - join two lists
157*700a0c64SWolfgang Denk  * @list: the new list to add.
158*700a0c64SWolfgang Denk  * @head: the place to add it in the first list.
159*700a0c64SWolfgang Denk  */
160*700a0c64SWolfgang Denk static inline void list_splice(struct list_head *list, struct list_head *head)
161*700a0c64SWolfgang Denk {
162*700a0c64SWolfgang Denk 	if (!list_empty(list))
163*700a0c64SWolfgang Denk 		__list_splice(list, head);
164*700a0c64SWolfgang Denk }
165*700a0c64SWolfgang Denk 
166*700a0c64SWolfgang Denk /**
167*700a0c64SWolfgang Denk  * list_splice_init - join two lists and reinitialise the emptied list.
168*700a0c64SWolfgang Denk  * @list: the new list to add.
169*700a0c64SWolfgang Denk  * @head: the place to add it in the first list.
170*700a0c64SWolfgang Denk  *
171*700a0c64SWolfgang Denk  * The list at @list is reinitialised
172*700a0c64SWolfgang Denk  */
173*700a0c64SWolfgang Denk static inline void list_splice_init(struct list_head *list,
174*700a0c64SWolfgang Denk 				    struct list_head *head)
175*700a0c64SWolfgang Denk {
176*700a0c64SWolfgang Denk 	if (!list_empty(list)) {
177*700a0c64SWolfgang Denk 		__list_splice(list, head);
178*700a0c64SWolfgang Denk 		INIT_LIST_HEAD(list);
179*700a0c64SWolfgang Denk 	}
180*700a0c64SWolfgang Denk }
181*700a0c64SWolfgang Denk 
182*700a0c64SWolfgang Denk /**
183*700a0c64SWolfgang Denk  * list_entry - get the struct for this entry
184*700a0c64SWolfgang Denk  * @ptr:	the &struct list_head pointer.
185*700a0c64SWolfgang Denk  * @type:	the type of the struct this is embedded in.
186*700a0c64SWolfgang Denk  * @member:	the name of the list_struct within the struct.
187*700a0c64SWolfgang Denk  */
188*700a0c64SWolfgang Denk #define list_entry(ptr, type, member) \
189*700a0c64SWolfgang Denk 	((type *)((char *)(ptr)-(unsigned long)(&((type *)0)->member)))
190*700a0c64SWolfgang Denk 
191*700a0c64SWolfgang Denk /**
192*700a0c64SWolfgang Denk  * list_for_each	-	iterate over a list
193*700a0c64SWolfgang Denk  * @pos:	the &struct list_head to use as a loop counter.
194*700a0c64SWolfgang Denk  * @head:	the head for your list.
195*700a0c64SWolfgang Denk  */
196*700a0c64SWolfgang Denk #define list_for_each(pos, head) \
197*700a0c64SWolfgang Denk 	for (pos = (head)->next, prefetch(pos->next); pos != (head); \
198*700a0c64SWolfgang Denk         	pos = pos->next, prefetch(pos->next))
199*700a0c64SWolfgang Denk /**
200*700a0c64SWolfgang Denk  * list_for_each_prev	-	iterate over a list backwards
201*700a0c64SWolfgang Denk  * @pos:	the &struct list_head to use as a loop counter.
202*700a0c64SWolfgang Denk  * @head:	the head for your list.
203*700a0c64SWolfgang Denk  */
204*700a0c64SWolfgang Denk #define list_for_each_prev(pos, head) \
205*700a0c64SWolfgang Denk 	for (pos = (head)->prev, prefetch(pos->prev); pos != (head); \
206*700a0c64SWolfgang Denk         	pos = pos->prev, prefetch(pos->prev))
207*700a0c64SWolfgang Denk 
208*700a0c64SWolfgang Denk /**
209*700a0c64SWolfgang Denk  * list_for_each_safe	-	iterate over a list safe against removal of list entry
210*700a0c64SWolfgang Denk  * @pos:	the &struct list_head to use as a loop counter.
211*700a0c64SWolfgang Denk  * @n:		another &struct list_head to use as temporary storage
212*700a0c64SWolfgang Denk  * @head:	the head for your list.
213*700a0c64SWolfgang Denk  */
214*700a0c64SWolfgang Denk #define list_for_each_safe(pos, n, head) \
215*700a0c64SWolfgang Denk 	for (pos = (head)->next, n = pos->next; pos != (head); \
216*700a0c64SWolfgang Denk 		pos = n, n = pos->next)
217*700a0c64SWolfgang Denk 
218*700a0c64SWolfgang Denk /**
219*700a0c64SWolfgang Denk  * list_for_each_entry	-	iterate over list of given type
220*700a0c64SWolfgang Denk  * @pos:	the type * to use as a loop counter.
221*700a0c64SWolfgang Denk  * @head:	the head for your list.
222*700a0c64SWolfgang Denk  * @member:	the name of the list_struct within the struct.
223*700a0c64SWolfgang Denk  */
224*700a0c64SWolfgang Denk #define list_for_each_entry(pos, head, member)				\
225*700a0c64SWolfgang Denk 	for (pos = list_entry((head)->next, typeof(*pos), member),	\
226*700a0c64SWolfgang Denk 		     prefetch(pos->member.next);			\
227*700a0c64SWolfgang Denk 	     &pos->member != (head); 					\
228*700a0c64SWolfgang Denk 	     pos = list_entry(pos->member.next, typeof(*pos), member),	\
229*700a0c64SWolfgang Denk 		     prefetch(pos->member.next))
230*700a0c64SWolfgang Denk 
231*700a0c64SWolfgang Denk /**
232*700a0c64SWolfgang Denk  * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
233*700a0c64SWolfgang Denk  * @pos:	the type * to use as a loop counter.
234*700a0c64SWolfgang Denk  * @n:		another type * to use as temporary storage
235*700a0c64SWolfgang Denk  * @head:	the head for your list.
236*700a0c64SWolfgang Denk  * @member:	the name of the list_struct within the struct.
237*700a0c64SWolfgang Denk  */
238*700a0c64SWolfgang Denk #define list_for_each_entry_safe(pos, n, head, member)			\
239*700a0c64SWolfgang Denk 	for (pos = list_entry((head)->next, typeof(*pos), member),	\
240*700a0c64SWolfgang Denk 		n = list_entry(pos->member.next, typeof(*pos), member);	\
241*700a0c64SWolfgang Denk 	     &pos->member != (head); 					\
242*700a0c64SWolfgang Denk 	     pos = n, n = list_entry(n->member.next, typeof(*n), member))
243*700a0c64SWolfgang Denk 
244*700a0c64SWolfgang Denk /**
245*700a0c64SWolfgang Denk  * list_for_each_entry_continue -       iterate over list of given type
246*700a0c64SWolfgang Denk  *                      continuing after existing point
247*700a0c64SWolfgang Denk  * @pos:        the type * to use as a loop counter.
248*700a0c64SWolfgang Denk  * @head:       the head for your list.
249*700a0c64SWolfgang Denk  * @member:     the name of the list_struct within the struct.
250*700a0c64SWolfgang Denk  */
251*700a0c64SWolfgang Denk #define list_for_each_entry_continue(pos, head, member)			\
252*700a0c64SWolfgang Denk 	for (pos = list_entry(pos->member.next, typeof(*pos), member),	\
253*700a0c64SWolfgang Denk 		     prefetch(pos->member.next);			\
254*700a0c64SWolfgang Denk 	     &pos->member != (head);					\
255*700a0c64SWolfgang Denk 	     pos = list_entry(pos->member.next, typeof(*pos), member),	\
256*700a0c64SWolfgang Denk 		     prefetch(pos->member.next))
257*700a0c64SWolfgang Denk 
258*700a0c64SWolfgang Denk #endif
259