123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526 |
- #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_OR_LATER_OR_UBDL );
-
- #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) ); \
- } )
-
- /**
- * 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
- */
- #define list_add( new, head ) do { \
- list_check ( (head) ); \
- extern_list_add ( (new), (head) ); \
- list_check ( (head) ); \
- list_check ( (new) ); \
- } while ( 0 )
- static inline void inline_list_add ( struct list_head *new,
- struct list_head *head ) {
- struct list_head *prev = head;
- struct list_head *next = head->next;
- next->prev = (new);
- (new)->next = next;
- (new)->prev = prev;
- prev->next = (new);
- }
- extern void extern_list_add ( struct list_head *new,
- struct list_head *head );
-
- /**
- * 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
- */
- #define list_add_tail( new, head ) do { \
- list_check ( (head) ); \
- extern_list_add_tail ( (new), (head) ); \
- list_check ( (head) ); \
- list_check ( (new) ); \
- } while ( 0 )
- static inline void inline_list_add_tail ( struct list_head *new,
- struct list_head *head ) {
- struct list_head *prev = head->prev;
- struct list_head *next = head;
- next->prev = (new);
- (new)->next = next;
- (new)->prev = prev;
- prev->next = (new);
- }
- extern void extern_list_add_tail ( struct list_head *new,
- struct list_head *head );
-
- /**
- * 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.
- */
- #define list_del( list ) do { \
- list_check ( (list) ); \
- inline_list_del ( (list) ); \
- } while ( 0 )
- static inline void inline_list_del ( struct list_head *list ) {
- struct list_head *next = (list)->next;
- struct list_head *prev = (list)->prev;
- next->prev = prev;
- prev->next = next;
- }
- extern void extern_list_del ( struct list_head *list );
-
- /**
- * Test whether a list is empty
- *
- * @v list List head
- */
- #define list_empty( list ) ( { \
- list_check ( (list) ); \
- inline_list_empty ( (list) ); } )
- static inline int inline_list_empty ( const struct list_head *list ) {
- return ( list->next == list );
- }
- extern int extern_list_empty ( const struct list_head *list );
-
- /**
- * Test whether a list has just one entry
- *
- * @v list List to test
- */
- #define list_is_singular( list ) ( { \
- list_check ( (list) ); \
- inline_list_is_singular ( (list) ); } )
- static inline int inline_list_is_singular ( const struct list_head *list ) {
- return ( ( ! list_empty ( list ) ) && ( list->next == list->prev ) );
- }
- extern int extern_list_is_singular ( const struct list_head *list );
-
- /**
- * Test whether an entry is the last entry in list
- *
- * @v list List entry to test
- * @v head List head
- */
- #define list_is_last( list, head ) ( { \
- list_check ( (list) ); \
- list_check ( (head) ); \
- inline_list_is_last ( (list), (head) ); } )
- static inline int inline_list_is_last ( const struct list_head *list,
- const struct list_head *head ) {
- return ( list->next == head );
- }
- extern int extern_list_is_last ( const struct list_head *list,
- const struct list_head *head );
-
- /**
- * Cut a list into two
- *
- * @v new A new list to contain all removed entries
- * @v list An existing list
- * @v entry An entry within the existing list
- *
- * All entries from @c list up to and including @c entry are moved to
- * @c new, which should be an empty list. @c entry may be equal to @c
- * list, in which case no entries are moved.
- */
- #define list_cut_position( new, list, entry ) do { \
- list_check ( (new) ); \
- assert ( list_empty ( (new) ) ); \
- list_check ( (list) ); \
- list_check ( (entry) ); \
- extern_list_cut_position ( (new), (list), (entry) ); \
- } while ( 0 )
- static inline void inline_list_cut_position ( struct list_head *new,
- struct list_head *list,
- struct list_head *entry ) {
- struct list_head *first = entry->next;
-
- if ( list != entry ) {
- new->next = list->next;
- new->next->prev = new;
- new->prev = entry;
- new->prev->next = new;
- list->next = first;
- list->next->prev = list;
- }
- }
- extern void extern_list_cut_position ( struct list_head *new,
- struct list_head *list,
- struct list_head *entry );
-
- /**
- * Move all entries from one list into another list
- *
- * @v list List of entries to add
- * @v entry Entry after which to add the new entries
- *
- * All entries from @c list are inserted after @c entry. Note that @c
- * list is left in an undefined state; use @c list_splice_init() if
- * you want @c list to become an empty list.
- */
- #define list_splice( list, entry ) do { \
- list_check ( (list) ); \
- list_check ( (entry) ); \
- extern_list_splice ( (list), (entry) ); \
- } while ( 0 )
- static inline void inline_list_splice ( const struct list_head *list,
- struct list_head *entry ) {
- struct list_head *first = list->next;
- struct list_head *last = list->prev;
-
- if ( ! list_empty ( list ) ) {
- last->next = entry->next;
- last->next->prev = last;
- first->prev = entry;
- first->prev->next = first;
- }
- }
- extern void extern_list_splice ( const struct list_head *list,
- struct list_head *entry );
-
- /**
- * Move all entries from one list into another list
- *
- * @v list List of entries to add
- * @v entry Entry before which to add the new entries
- *
- * All entries from @c list are inserted before @c entry. Note that @c
- * list is left in an undefined state; use @c list_splice_tail_init() if
- * you want @c list to become an empty list.
- */
- #define list_splice_tail( list, entry ) do { \
- list_check ( (list) ); \
- list_check ( (entry) ); \
- extern_list_splice_tail ( (list), (entry) ); \
- } while ( 0 )
- static inline void inline_list_splice_tail ( const struct list_head *list,
- struct list_head *entry ) {
- struct list_head *first = list->next;
- struct list_head *last = list->prev;
-
- if ( ! list_empty ( list ) ) {
- first->prev = entry->prev;
- first->prev->next = first;
- last->next = entry;
- last->next->prev = last;
- }
- }
- extern void extern_list_splice_tail ( const struct list_head *list,
- struct list_head *entry );
-
- /**
- * Move all entries from one list into another list and reinitialise empty list
- *
- * @v list List of entries to add
- * @v entry Entry after which to add the new entries
- *
- * All entries from @c list are inserted after @c entry.
- */
- #define list_splice_init( list, entry ) do { \
- list_check ( (list) ); \
- list_check ( (entry) ); \
- extern_list_splice_init ( (list), (entry) ); \
- } while ( 0 )
- static inline void inline_list_splice_init ( struct list_head *list,
- struct list_head *entry ) {
- list_splice ( list, entry );
- INIT_LIST_HEAD ( list );
- }
- extern void extern_list_splice_init ( struct list_head *list,
- struct list_head *entry );
-
- /**
- * Move all entries from one list into another list and reinitialise empty list
- *
- * @v list List of entries to add
- * @v entry Entry before which to add the new entries
- *
- * All entries from @c list are inserted before @c entry.
- */
- #define list_splice_tail_init( list, entry ) do { \
- list_check ( (list) ); \
- list_check ( (entry) ); \
- extern_list_splice_tail_init ( (list), (entry) ); \
- } while ( 0 )
-
- static inline void inline_list_splice_tail_init ( struct list_head *list,
- struct list_head *entry ) {
- list_splice_tail ( list, entry );
- INIT_LIST_HEAD ( list );
- }
- extern void extern_list_splice_tail_init ( struct list_head *list,
- struct list_head *entry );
-
- /**
- * 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 ) )
-
- /**
- * Get the container of the last 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_last_entry( list, type, member ) \
- ( list_empty ( (list) ) ? \
- ( type * ) NULL : \
- list_entry ( (list)->prev, type, member ) )
-
- /**
- * Get the container of the next entry in a list
- *
- * @v pos Current list entry
- * @v head List head
- * @v member Name of list field within iterator's type
- * @ret next Next list entry, or NULL at end of list
- */
- #define list_next_entry( pos, head, member ) ( { \
- typeof (pos) next = list_entry ( (pos)->member.next, \
- typeof ( *(pos) ), \
- member ); \
- ( ( &next->member == (head) ) ? NULL : next ); } )
-
- /**
- * Get the container of the previous entry in a list
- *
- * @v pos Current list entry
- * @v head List head
- * @v member Name of list field within iterator's type
- * @ret next Next list entry, or NULL at end of list
- */
- #define list_prev_entry( pos, head, member ) ( { \
- typeof (pos) prev = list_entry ( (pos)->member.prev, \
- typeof ( *(pos) ), \
- member ); \
- ( ( &prev->member == (head) ) ? NULL : prev ); } )
-
- /**
- * Test if entry is first in a list
- *
- * @v entry List entry
- * @v head List head
- * @v member Name of list field within iterator's type
- * @ret is_first Entry is first in the list
- */
- #define list_is_first_entry( entry, head, member ) \
- ( (head)->next == &(entry)->member )
-
- /**
- * Test if entry is last in a list
- *
- * @v entry List entry
- * @v head List head
- * @v member Name of list field within iterator's type
- * @ret is_last Entry is last in the list
- */
- #define list_is_last_entry( entry, head, member ) \
- ( (head)->prev == &(entry)->member )
-
- /**
- * Iterate over a list
- *
- * @v pos Iterator
- * @v head List head
- */
- #define list_for_each( pos, head ) \
- for ( list_check ( (head) ), \
- pos = (head)->next; \
- pos != (head); \
- pos = (pos)->next )
-
- /**
- * 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 ) )
-
- /**
- * Iterate over entries in a list, starting after current position
- *
- * @v pos Iterator
- * @v head List head
- * @v member Name of list field within iterator's type
- */
- #define list_for_each_entry_continue( pos, head, member ) \
- for ( list_check ( (head) ), \
- pos = list_entry ( pos->member.next, typeof ( *pos ), member ); \
- &pos->member != (head); \
- pos = list_entry ( pos->member.next, typeof ( *pos ), member ) )
-
- /**
- * Iterate over entries in a list in reverse, starting after current position
- *
- * @v pos Iterator
- * @v head List head
- * @v member Name of list field within iterator's type
- */
- #define list_for_each_entry_continue_reverse( pos, head, member ) \
- for ( list_check ( (head) ), \
- pos = list_entry ( pos->member.prev, typeof ( *pos ), member ); \
- &pos->member != (head); \
- pos = list_entry ( pos->member.prev, typeof ( *pos ), member ) )
-
- /**
- * Test if list contains a specified entry
- *
- * @v entry Entry
- * @v head List head
- * @ret present List contains specified entry
- */
- #define list_contains( entry, head ) ( { \
- list_check ( (head) ); \
- list_check ( (entry) ); \
- extern_list_contains ( (entry), (head) ); } )
- static inline int inline_list_contains ( struct list_head *entry,
- struct list_head *head ) {
- struct list_head *tmp;
-
- list_for_each ( tmp, head ) {
- if ( tmp == entry )
- return 1;
- }
- return 0;
- }
- extern int extern_list_contains ( struct list_head *entry,
- struct list_head *head );
-
- /**
- * Test if list contains a specified entry
- *
- * @v entry Entry
- * @v head List head
- * @ret present List contains specified entry
- */
- #define list_contains_entry( entry, head, member ) \
- list_contains ( &(entry)->member, (head) )
-
- /**
- * Check list contains a specified entry
- *
- * @v entry Entry
- * @v head List head
- * @v member Name of list field within iterator's type
- */
- #define list_check_contains_entry( entry, head, member ) do { \
- assert ( list_contains_entry ( (entry), (head), member ) ); \
- } while ( 0 )
-
- #endif /* _IPXE_LIST_H */
|