linux_list.h File Reference

This graph shows which files directly or indirectly include this file:

Data Structures
struct	list_head
struct	hlist_head
struct	hlist_node

Macros
#define	offsetof(TYPE, MEMBER)   ((size_t) &((TYPE *)0)->MEMBER)
#define	container_of(ptr, type, member)
	container_of - cast a member of a structure out to the containing structure More...
#define	typecheck(type, x)
#define	prefetch(x)   1
#define	smp_wmb()
#define	LIST_POISON1   ((void *) 0x00100100)
#define	LIST_POISON2   ((void *) 0x00200200)
#define	LIST_HEAD_INIT(name)   { &(name), &(name) }
#define	LIST_HEAD(name)   struct list_head name = LIST_HEAD_INIT(name)
#define	INIT_LIST_HEAD(ptr)
#define	list_entry(ptr, type, member)   container_of(ptr, type, member)
	list_entry - get the struct for this entry : the &struct list_head pointer. More...
#define	list_for_each(pos, head)
	list_for_each - iterate over a list : the &struct list_head to use as a loop counter. More...
#define	__list_for_each(pos, head)   for (pos = (head)->next; pos != (head); pos = pos->next)
	__list_for_each - iterate over a list : the &struct list_head to use as a loop counter. More...
#define	list_for_each_prev(pos, head)
	list_for_each_prev - iterate over a list backwards : the &struct list_head to use as a loop counter. More...
#define	list_for_each_safe(pos, n, head)
	list_for_each_safe - iterate over a list safe against removal of list entry : the &struct list_head to use as a loop counter. More...
#define	list_for_each_entry(pos, head, member)
	list_for_each_entry - iterate over list of given type : the type * to use as a loop counter. More...
#define	list_for_each_entry_reverse(pos, head, member)
	list_for_each_entry_reverse - iterate backwards over list of given type. More...
#define	list_prepare_entry(pos, head, member)   ((pos) ? : list_entry(head, typeof(*pos), member))
	list_prepare_entry - prepare a pos entry for use as a start point in list_for_each_entry_continue : the type * to use as a start point : the head of the list : the name of the list_struct within the struct. More...
#define	list_for_each_entry_continue(pos, head, member)
	list_for_each_entry_continue - iterate over list of given type continuing after existing point : the type * to use as a loop counter. More...
#define	list_for_each_entry_safe(pos, n, head, member)
	list_for_each_entry_safe - iterate over list of given type safe against removal of list entry : the type * to use as a loop counter. More...
#define	list_for_each_rcu(pos, head)
	list_for_each_rcu - iterate over an rcu-protected list : the &struct list_head to use as a loop counter. More...
#define	__list_for_each_rcu(pos, head)
#define	list_for_each_safe_rcu(pos, n, head)
	list_for_each_safe_rcu - iterate over an rcu-protected list safe against removal of list entry : the &struct list_head to use as a loop counter. More...
#define	list_for_each_entry_rcu(pos, head, member)
	list_for_each_entry_rcu - iterate over rcu list of given type : the type * to use as a loop counter. More...
#define	list_for_each_continue_rcu(pos, head)
	list_for_each_continue_rcu - iterate over an rcu-protected list continuing after existing point. More...
#define	HLIST_HEAD_INIT   { .first = NULL }
#define	HLIST_HEAD(name)   struct hlist_head name = { .first = NULL }
#define	INIT_HLIST_HEAD(ptr)   ((ptr)->first = NULL)
#define	INIT_HLIST_NODE(ptr)   ((ptr)->next = NULL, (ptr)->pprev = NULL)
#define	hlist_del_rcu_init   hlist_del_init
#define	hlist_entry(ptr, type, member)   container_of(ptr,type,member)
#define	hlist_for_each(pos, head)
#define	hlist_for_each_safe(pos, n, head)
#define	hlist_for_each_entry(tpos, pos, head, member)
	hlist_for_each_entry - iterate over list of given type : the type * to use as a loop counter. More...
#define	hlist_for_each_entry_continue(tpos, pos, member)
	hlist_for_each_entry_continue - iterate over a hlist continuing after existing point : the type * to use as a loop counter. More...
#define	hlist_for_each_entry_from(tpos, pos, member)
	hlist_for_each_entry_from - iterate over a hlist continuing from existing point : the type * to use as a loop counter. More...
#define	hlist_for_each_entry_safe(tpos, pos, n, head, member)
	hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry : the type * to use as a loop counter. More...
#define	hlist_for_each_entry_rcu(tpos, pos, head, member)
	hlist_for_each_entry_rcu - iterate over rcu list of given type : the type * to use as a loop counter. More...

Macro Definition Documentation

#define __list_for_each	(		pos,
			head
	)		for (pos = (head)->next; pos != (head); pos = pos->next)

__list_for_each - iterate over a list : the &struct list_head to use as a loop counter.

: the head for your list.

This variant differs from list_for_each() in that it's the simplest possible list iteration code, no prefetching is done. Use this for code that knows the list to be very short (empty or 1 entry) most of the time.

#define __list_for_each_rcu	(		pos,
			head
	)

Value:

for (pos = (head)->next; pos != (head); \
        	pos = pos->next, ({ smp_read_barrier_depends(); 0;}))

#define container_of	(		ptr,
			type,
			member
	)

Value:

({          \
        const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
        (type *)( (char *)__mptr - offsetof(type,member) );})

container_of - cast a member of a structure out to the containing structure

: the pointer to the member. : the type of the container struct this is embedded in. : the name of the member within the struct.

#define hlist_del_rcu_init   hlist_del_init

#define hlist_entry	(		ptr,
			type,
			member
	)		container_of(ptr,type,member)

#define hlist_for_each	(		pos,
			head
	)

Value:

for (pos = (head)->first; pos && ({ prefetch(pos->next); 1; }); \
	     pos = pos->next)

#define hlist_for_each_entry	(		tpos,
			pos,
			head,
			member
	)

Value:

for (pos = (head)->first;                    \
	     pos && ({ prefetch(pos->next); 1;}) &&             \
        ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
	     pos = pos->next)

hlist_for_each_entry - iterate over list of given type : the type * to use as a loop counter.

: the &struct hlist_node to use as a loop counter. : the head for your list. : the name of the hlist_node within the struct.

#define hlist_for_each_entry_continue	(		tpos,
			pos,
			member
	)

Value:

for (pos = (pos)->next;                      \
	     pos && ({ prefetch(pos->next); 1;}) &&             \
        ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
	     pos = pos->next)

hlist_for_each_entry_continue - iterate over a hlist continuing after existing point : the type * to use as a loop counter.

: the &struct hlist_node to use as a loop counter. : the name of the hlist_node within the struct.

#define hlist_for_each_entry_from	(		tpos,
			pos,
			member
	)

Value:

for (; pos && ({ prefetch(pos->next); 1;}) &&            \
        ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
	     pos = pos->next)

hlist_for_each_entry_from - iterate over a hlist continuing from existing point : the type * to use as a loop counter.

: the &struct hlist_node to use as a loop counter. : the name of the hlist_node within the struct.

#define hlist_for_each_entry_rcu	(		tpos,
			pos,
			head,
			member
	)

Value:

for (pos = (head)->first;                    \
	     pos && ({ prefetch(pos->next); 1;}) &&             \
        ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
	     pos = pos->next, ({ smp_read_barrier_depends(); 0; }) )

hlist_for_each_entry_rcu - iterate over rcu list of given type : the type * to use as a loop counter.

: the &struct hlist_node to use as a loop counter. : the head for your list. : the name of the hlist_node within the struct.

This list-traversal primitive may safely run concurrently with the _rcu list-mutation primitives such as hlist_add_rcu() as long as the traversal is guarded by rcu_read_lock().

#define hlist_for_each_entry_safe	(		tpos,
			pos,
			n,
			head,
			member
	)

Value:

for (pos = (head)->first;                    \
	     pos && ({ n = pos->next; 1; }) &&                  \
        ({ tpos = hlist_entry(pos, typeof(*tpos), member); 1;}); \
	     pos = n)

hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry : the type * to use as a loop counter.

: the &struct hlist_node to use as a loop counter.
: another &struct hlist_node to use as temporary storage : the head for your list. : the name of the hlist_node within the struct.

#define hlist_for_each_safe	(		pos,
			n,
			head
	)

Value:

for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
	     pos = n)

#define HLIST_HEAD

(

name

)

struct hlist_head name = { .first = NULL }

#define HLIST_HEAD_INIT   { .first = NULL }

#define INIT_HLIST_HEAD

(

ptr

)

((ptr)->first = NULL)

#define INIT_HLIST_NODE

(

ptr

)

((ptr)->next = NULL, (ptr)->pprev = NULL)

#define INIT_LIST_HEAD

(

ptr

)

Value:

do { \
    (ptr)->next = (ptr); (ptr)->prev = (ptr); \
} while (0)

#define list_entry	(		ptr,
			type,
			member
	)		container_of(ptr, type, member)

list_entry - get the struct for this entry : the &struct list_head pointer.

: the type of the struct this is embedded in. : the name of the list_struct within the struct.

#define list_for_each	(		pos,
			head
	)

Value:

for (pos = (head)->next, prefetch(pos->next); pos != (head); \
            pos = pos->next, prefetch(pos->next))

list_for_each - iterate over a list : the &struct list_head to use as a loop counter.

: the head for your list.

#define list_for_each_continue_rcu	(		pos,
			head
	)

Value:

for ((pos) = (pos)->next, prefetch((pos)->next); (pos) != (head); \
            (pos) = (pos)->next, ({ smp_read_barrier_depends(); 0;}), prefetch((pos)->next))

list_for_each_continue_rcu - iterate over an rcu-protected list continuing after existing point.

: the &struct list_head to use as a loop counter. : the head for your list.

This list-traversal primitive may safely run concurrently with the _rcu list-mutation primitives such as list_add_rcu() as long as the traversal is guarded by rcu_read_lock().

#define list_for_each_entry	(		pos,
			head,
			member
	)

Value:

for (pos = list_entry((head)->next, typeof(*pos), member),  \
             prefetch(pos->member.next);            \
         &pos->member != (head);                    \
         pos = list_entry(pos->member.next, typeof(*pos), member),  \
             prefetch(pos->member.next))

list_for_each_entry - iterate over list of given type : the type * to use as a loop counter.

: the head for your list. : the name of the list_struct within the struct.

#define list_for_each_entry_continue	(		pos,
			head,
			member
	)

Value:

for (pos = list_entry(pos->member.next, typeof(*pos), member),  \
             prefetch(pos->member.next);            \
         &pos->member != (head);                    \
         pos = list_entry(pos->member.next, typeof(*pos), member),  \
             prefetch(pos->member.next))

list_for_each_entry_continue - iterate over list of given type continuing after existing point : the type * to use as a loop counter.

: the head for your list. : the name of the list_struct within the struct.

#define list_for_each_entry_rcu	(		pos,
			head,
			member
	)

Value:

for (pos = list_entry((head)->next, typeof(*pos), member),  \
             prefetch(pos->member.next);            \
         &pos->member != (head);                    \
         pos = list_entry(pos->member.next, typeof(*pos), member),  \
             ({ smp_read_barrier_depends(); 0;}),       \
             prefetch(pos->member.next))

list_for_each_entry_rcu - iterate over rcu list of given type : the type * to use as a loop counter.

: the head for your list. : the name of the list_struct within the struct.

This list-traversal primitive may safely run concurrently with the _rcu list-mutation primitives such as list_add_rcu() as long as the traversal is guarded by rcu_read_lock().

#define list_for_each_entry_reverse	(		pos,
			head,
			member
	)

Value:

for (pos = list_entry((head)->prev, typeof(*pos), member),  \
             prefetch(pos->member.prev);            \
         &pos->member != (head);                    \
         pos = list_entry(pos->member.prev, typeof(*pos), member),  \
             prefetch(pos->member.prev))

list_for_each_entry_reverse - iterate backwards over list of given type.

: the type * to use as a loop counter. : the head for your list. : the name of the list_struct within the struct.

#define list_for_each_entry_safe	(		pos,
			n,
			head,
			member
	)

Value:

for (pos = list_entry((head)->next, typeof(*pos), member),  \
        n = list_entry(pos->member.next, typeof(*pos), member); \
         &pos->member != (head);                    \
	     pos = n, n = list_entry(n->member.next, typeof(*n), member))

list_for_each_entry_safe - iterate over list of given type safe against removal of list entry : the type * to use as a loop counter.

: another type * to use as temporary storage : the head for your list. : the name of the list_struct within the struct.

#define list_for_each_prev	(		pos,
			head
	)

Value:

for (pos = (head)->prev, prefetch(pos->prev); pos != (head); \
            pos = pos->prev, prefetch(pos->prev))

list_for_each_prev - iterate over a list backwards : the &struct list_head to use as a loop counter.

: the head for your list.

#define list_for_each_rcu	(		pos,
			head
	)

Value:

for (pos = (head)->next, prefetch(pos->next); pos != (head); \
            pos = pos->next, ({ smp_read_barrier_depends(); 0;}), prefetch(pos->next))

list_for_each_rcu - iterate over an rcu-protected list : the &struct list_head to use as a loop counter.

: the head for your list.

This list-traversal primitive may safely run concurrently with the _rcu list-mutation primitives such as list_add_rcu() as long as the traversal is guarded by rcu_read_lock().

#define list_for_each_safe	(		pos,
			n,
			head
	)

Value:

for (pos = (head)->next, n = pos->next; pos != (head); \
        pos = n, n = pos->next)

list_for_each_safe - iterate over a list safe against removal of list entry : the &struct list_head to use as a loop counter.

: another &struct list_head to use as temporary storage : the head for your list.

#define list_for_each_safe_rcu	(		pos,
			n,
			head
	)

Value:

for (pos = (head)->next, n = pos->next; pos != (head); \
        pos = n, ({ smp_read_barrier_depends(); 0;}), n = pos->next)

list_for_each_safe_rcu - iterate over an rcu-protected list safe against removal of list entry : the &struct list_head to use as a loop counter.

: another &struct list_head to use as temporary storage : the head for your list.

This list-traversal primitive may safely run concurrently with the _rcu list-mutation primitives such as list_add_rcu() as long as the traversal is guarded by rcu_read_lock().

#define LIST_HEAD

(

name

)

struct list_head name = LIST_HEAD_INIT(name)

#define LIST_HEAD_INIT

(

name

)

{ &(name), &(name) }

#define LIST_POISON1   ((void *) 0x00100100)

#define LIST_POISON2   ((void *) 0x00200200)

#define list_prepare_entry	(		pos,
			head,
			member
	)		((pos) ? : list_entry(head, typeof(*pos), member))

list_prepare_entry - prepare a pos entry for use as a start point in list_for_each_entry_continue : the type * to use as a start point : the head of the list : the name of the list_struct within the struct.

#define offsetof	(		TYPE,
			MEMBER
	)		((size_t) &((TYPE *)0)->MEMBER)

#define prefetch

(

x

)

1

#define smp_wmb

(

)

#define typecheck	(		type,
			x
	)

Value:

({  type __dummy; \
    typeof(x) __dummy2; \
    (void)(&__dummy == &__dummy2); \
    1; \
})