1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
#ifndef _IPXE_LIST_H
#define _IPXE_LIST_H
/** @file
*
* Linked lists
*
* This linked list handling code is based on the Linux kernel's
* list.h.
*/
FILE_LICENCE ( GPL2_ONLY );
#include <stddef.h>
#include <assert.h>
/** A doubly-linked list entry (or list head) */
struct list_head {
/** Next list entry */
struct list_head *next;
/** Previous list entry */
struct list_head *prev;
};
/**
* Initialise a static list head
*
* @v list List head
*/
#define LIST_HEAD_INIT( list ) { &(list), &(list) }
/**
* Declare a static list head
*
* @v list List head
*/
#define LIST_HEAD( list ) \
struct list_head list = LIST_HEAD_INIT ( list )
/**
* Initialise a list head
*
* @v list List head
*/
#define INIT_LIST_HEAD( list ) do { \
(list)->next = (list); \
(list)->prev = (list); \
} while ( 0 )
/**
* Check a list entry or list head is valid
*
* @v list List entry or head
*/
#define list_check( list ) ( { \
assert ( (list) != NULL ); \
assert ( (list)->prev != NULL ); \
assert ( (list)->next != NULL ); \
assert ( (list)->next->prev == (list) ); \
assert ( (list)->prev->next == (list) ); \
} )
/**
* Insert a list entry between two known consecutive entries
*
* @v new New list entry
* @v prev Previous list entry
* @v next Next list entry
*/
static inline void __list_add ( struct list_head *new,
struct list_head *prev,
struct list_head *next ) {
next->prev = new;
new->next = next;
new->prev = prev;
prev->next = new;
}
/**
* Add a new entry to the head of a list
*
* @v new New entry to be added
* @v head List head, or entry after which to add the new entry
*/
static inline void list_add ( struct list_head *new, struct list_head *head ) {
__list_add ( new, head, head->next );
}
#define list_add( new, head ) do { \
list_check ( (head) ); \
list_add ( (new), (head) ); \
} while ( 0 )
/**
* Add a new entry to the tail of a list
*
* @v new New entry to be added
* @v head List head, or entry before which to add the new entry
*/
static inline void list_add_tail ( struct list_head *new,
struct list_head *head ) {
__list_add ( new, head->prev, head );
}
#define list_add_tail( new, head ) do { \
list_check ( (head) ); \
list_add_tail ( (new), (head) ); \
} while ( 0 )
/**
* Delete a list entry between two known consecutive entries
*
* @v prev Previous list entry
* @v next Next list entry
*/
static inline void __list_del ( struct list_head *prev,
struct list_head *next ) {
next->prev = prev;
prev->next = next;
}
/**
* Delete an entry from a list
*
* @v list List entry
*
* Note that list_empty() on entry does not return true after this;
* the entry is in an undefined state.
*/
static inline void list_del ( struct list_head *list ) {
__list_del ( list->prev, list->next );
}
#define list_del( list ) do { \
list_check ( (list) ); \
list_del ( (list) ); \
} while ( 0 )
/**
* Test whether a list is empty
*
* @v list List head
*/
static inline int list_empty ( const struct list_head *list ) {
return ( list->next == list );
}
#define list_empty( list ) ( { \
list_check ( (list) ); \
list_empty ( (list) ); } )
/**
* Get the container of a list entry
*
* @v list List entry
* @v type Containing type
* @v member Name of list field within containing type
* @ret container Containing object
*/
#define list_entry( list, type, member ) ( { \
list_check ( (list) ); \
container_of ( list, type, member ); } )
/**
* Get the container of the first entry in a list
*
* @v list List head
* @v type Containing type
* @v member Name of list field within containing type
* @ret first First list entry, or NULL
*/
#define list_first_entry( list, type, member ) \
( list_empty ( (list) ) ? \
( type * ) NULL : \
list_entry ( (list)->next, type, member ) )
/**
* Iterate over entries in a list
*
* @v pos Iterator
* @v head List head
* @v member Name of list field within iterator's type
*/
#define list_for_each_entry( pos, head, member ) \
for ( list_check ( (head) ), \
pos = list_entry ( (head)->next, typeof ( *pos ), member ); \
&pos->member != (head); \
pos = list_entry ( pos->member.next, typeof ( *pos ), member ) )
/**
* Iterate over entries in a list in reverse order
*
* @v pos Iterator
* @v head List head
* @v member Name of list field within iterator's type
*/
#define list_for_each_entry_reverse( pos, head, member ) \
for ( list_check ( (head) ), \
pos = list_entry ( (head)->prev, typeof ( *pos ), member ); \
&pos->member != (head); \
pos = list_entry ( pos->member.prev, typeof ( *pos ), member ) )
/**
* Iterate over entries in a list, safe against deletion of the current entry
*
* @v pos Iterator
* @v tmp Temporary value (of same type as iterator)
* @v head List head
* @v member Name of list field within iterator's type
*/
#define list_for_each_entry_safe( pos, tmp, head, member ) \
for ( list_check ( (head) ), \
pos = list_entry ( (head)->next, typeof ( *pos ), member ), \
tmp = list_entry ( pos->member.next, typeof ( *tmp ), member ); \
&pos->member != (head); \
pos = tmp, \
tmp = list_entry ( tmp->member.next, typeof ( *tmp ), member ) )
#endif /* _IPXE_LIST_H */
|
