diff options
Diffstat (limited to 'udev/lib/list.h')
| -rw-r--r-- | udev/lib/list.h | 163 |
1 files changed, 30 insertions, 133 deletions
diff --git a/udev/lib/list.h b/udev/lib/list.h index 3266e1b124..c679e50ace 100644 --- a/udev/lib/list.h +++ b/udev/lib/list.h @@ -1,17 +1,20 @@ /* - * Based on list.h in the Linux kernel source tree. + * Simple doubly linked list implementation. + * + * Based on list.h in the Linux kernel source tree, licensed under + * the GNU GPL version 2. */ #ifndef _LIST_H #define _LIST_H /** - * container_of - cast a member of a structure out to the containing structure - * + * container_of: * @ptr: the pointer to the member. * @type: the type of the container struct this is embedded in. * @member: the name of the member within the struct. * + * cast a member of a structure out to the containing structure */ #define container_of(ptr, type, member) ({ \ const typeof( ((type *)0)->member ) *__mptr = (ptr); \ @@ -25,16 +28,6 @@ #define LIST_POISON1 ((void *) 0x00100100) #define LIST_POISON2 ((void *) 0x00200200) -/* - * Simple doubly linked list implementation. - * - * Some of the internal functions ("__xxx") are useful when - * manipulating whole lists rather than single entries, as - * sometimes we already know the next/prev entries and we can - * generate better code by using them directly rather than - * using the generic single-entry routines. - */ - struct list_head { struct list_head *next, *prev; }; @@ -48,12 +41,7 @@ struct list_head { (ptr)->next = (ptr); (ptr)->prev = (ptr); \ } while (0) -/* - * Insert a new entry between two known consecutive entries. - * - * This is only for internal list manipulation where we know - * the prev/next entries already! - */ +/* Insert a new entry between two known consecutive entries. */ static inline void __list_add(struct list_head *new, struct list_head *prev, struct list_head *next) @@ -65,7 +53,7 @@ static inline void __list_add(struct list_head *new, } /** - * list_add - add a new entry + * list_add: * @new: new entry to be added * @head: list head to add it after * @@ -78,7 +66,7 @@ static inline void list_add(struct list_head *new, struct list_head *head) } /** - * list_add_tail - add a new entry + * list_add_tail: * @new: new entry to be added * @head: list head to add it before * @@ -93,9 +81,6 @@ static inline void list_add_tail(struct list_head *new, struct list_head *head) /* * Delete a list entry by making the prev/next entries * point to each other. - * - * This is only for internal list manipulation where we know - * the prev/next entries already! */ static inline void __list_del(struct list_head * prev, struct list_head * next) { @@ -104,8 +89,11 @@ static inline void __list_del(struct list_head * prev, struct list_head * next) } /** - * list_del - deletes entry from list. + * list_del: * @entry: the element to delete from the list. + * + * deletes entry from list. + * * Note: list_empty on entry does not return true after this, the entry is * in an undefined state. */ @@ -117,19 +105,10 @@ static inline void list_del(struct list_head *entry) } /** - * list_del_init - deletes entry from list and reinitialize it. - * @entry: the element to delete from the list. - */ -static inline void list_del_init(struct list_head *entry) -{ - __list_del(entry->prev, entry->next); - INIT_LIST_HEAD(entry); -} - -/** - * list_move - delete from one list and add as another's head + * list_move * @list: the entry to move * @head: the head that will precede our entry + * delete from one list and add as another's head */ static inline void list_move(struct list_head *list, struct list_head *head) { @@ -138,9 +117,11 @@ static inline void list_move(struct list_head *list, struct list_head *head) } /** - * list_move_tail - delete from one list and add as another's tail + * list_move_tail * @list: the entry to move * @head: the head that will follow our entry + * + * delete from one list and add as another's tail */ static inline void list_move_tail(struct list_head *list, struct list_head *head) @@ -150,109 +131,34 @@ static inline void list_move_tail(struct list_head *list, } /** - * list_empty - tests whether a list is empty + * list_empty: * @head: the list to test. + * + * tests whether a list is empty */ static inline int list_empty(struct list_head *head) { return head->next == head; } -static inline void __list_splice(struct list_head *list, - struct list_head *head) -{ - struct list_head *first = list->next; - struct list_head *last = list->prev; - struct list_head *at = head->next; - - first->prev = head; - head->next = first; - - last->next = at; - at->prev = last; -} - -/** - * list_splice - join two lists - * @list: the new list to add. - * @head: the place to add it in the first list. - */ -static inline void list_splice(struct list_head *list, struct list_head *head) -{ - if (!list_empty(list)) - __list_splice(list, head); -} - /** - * list_splice_init - join two lists and reinitialise the emptied list. - * @list: the new list to add. - * @head: the place to add it in the first list. - * - * The list at @list is reinitialised - */ -static inline void list_splice_init(struct list_head *list, - struct list_head *head) -{ - if (!list_empty(list)) { - __list_splice(list, head); - INIT_LIST_HEAD(list); - } -} - -/** - * list_entry - get the struct for this entry + * list_entry: * @ptr: the &struct list_head pointer. * @type: the type of the struct this is embedded in. * @member: the name of the list_struct within the struct. + * + * get the struct for this entry */ #define list_entry(ptr, type, member) \ container_of(ptr, type, member) /** - * list_for_each - iterate over a list - * @pos: the &struct list_head to use as a loop counter. - * @head: the head for your list. - */ -#define list_for_each(pos, head) \ - for (pos = (head)->next; pos != (head); \ - pos = pos->next) - -/** - * __list_for_each - iterate over a list - * @pos: the &struct list_head to use as a loop counter. - * @head: the head for your list. - * - * This variant differs from list_for_each() in that it's the - * simplest possible list iteration code. - * Use this for code that knows the list to be very short (empty - * or 1 entry) most of the time. - */ -#define __list_for_each(pos, head) \ - for (pos = (head)->next; pos != (head); pos = pos->next) - -/** - * list_for_each_prev - iterate over a list backwards - * @pos: the &struct list_head to use as a loop counter. - * @head: the head for your list. - */ -#define list_for_each_prev(pos, head) \ - for (pos = (head)->prev; pos != (head); pos = pos->prev) - -/** - * list_for_each_safe - iterate over a list safe against removal of list entry - * @pos: the &struct list_head to use as a loop counter. - * @n: another &struct list_head to use as temporary storage - * @head: the head for your list. - */ -#define list_for_each_safe(pos, n, head) \ - for (pos = (head)->next, n = pos->next; pos != (head); \ - pos = n, n = pos->next) - -/** - * list_for_each_entry - iterate over list of given type + * list_for_each_entry: * @pos: the type * to use as a loop counter. * @head: the head for your list. * @member: the name of the list_struct within the struct. + * + * iterate over list of given type */ #define list_for_each_entry(pos, head, member) \ for (pos = list_entry((head)->next, typeof(*pos), member); \ @@ -260,22 +166,13 @@ static inline void list_splice_init(struct list_head *list, pos = list_entry(pos->member.next, typeof(*pos), member)) /** - * list_for_each_entry_reverse - iterate backwards over list of given type. - * @pos: the type * to use as a loop counter. - * @head: the head for your list. - * @member: the name of the list_struct within the struct. - */ -#define list_for_each_entry_reverse(pos, head, member) \ - for (pos = list_entry((head)->prev, typeof(*pos), member); \ - &pos->member != (head); \ - pos = list_entry(pos->member.prev, typeof(*pos), member)) - -/** - * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry + * list_for_each_entry_safe: * @pos: the type * to use as a loop counter. * @n: another type * to use as temporary storage * @head: the head for your list. * @member: the name of the list_struct within the struct. + * + * iterate over list of given type safe against removal of list entry */ #define list_for_each_entry_safe(pos, n, head, member) \ for (pos = list_entry((head)->next, typeof(*pos), member), \ |