src/slist.h File Reference

#include "prefetch.h"

Include dependency graph for slist.h:

Go to the source code of this file.

Data Structures
struct	list_head
Defines
#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)
#define	list_for_each(pos, head)
#define	__list_for_each(pos, head)   for (pos = (head)->next; pos != (head); pos = pos->next)
#define	list_for_each_prev(pos, head)
#define	list_for_each_safe(pos, n, head)
#define	list_for_each_entry(pos, head, member)
#define	list_for_each_entry_reverse(pos, head, member)
#define	list_prepare_entry(pos, head, member)   ((pos) ? : list_entry(head, typeof(*pos), member))
#define	list_for_each_entry_continue(pos, head, member)
#define	list_for_each_entry_safe(pos, n, head, member)
#define	list_for_each_entry_safe_continue(pos, n, head, member)
Functions
static void	__list_add (struct list_head *new, struct list_head *prev, struct list_head *next)
static void	list_add (struct list_head *new, struct list_head *head)
static void	list_add_tail (struct list_head *new, struct list_head *head)
static void	__list_del (struct list_head *prev, struct list_head *next)
static void	list_del (struct list_head *entry)
static void	list_del_init (struct list_head *entry)
static void	list_move (struct list_head *list, struct list_head *head)
static void	list_move_tail (struct list_head *list, struct list_head *head)
static int	list_empty (const struct list_head *head)
static void	__list_splice (struct list_head *list, struct list_head *head)
static void	list_splice (struct list_head *list, struct list_head *head)
static void	list_splice_init (struct list_head *list, struct list_head *head)

---

Define 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.

Definition at line 207 of file slist.h.

#define INIT_LIST_HEAD

(

ptr

)

Value:

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

Definition at line 24 of file slist.h.

Referenced by list_del_init(), and list_splice_init().

#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.

Definition at line 185 of file slist.h.

#define list_for_each	(	pos,
		head		)

Value:

for (pos = (head)->next; prefetch(pos->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.

Definition at line 193 of file slist.h.

#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))

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.

Definition at line 235 of file slist.h.

#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))

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.

Definition at line 268 of file slist.h.

#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))

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.

Definition at line 246 of file slist.h.

#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.

Definition at line 280 of file slist.h.

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

Value:

for (pos = list_entry(pos->member.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_continue - iterate over list of given type continuing after existing point 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.

Definition at line 294 of file slist.h.

#define list_for_each_prev	(	pos,
		head		)

Value:

for (pos = (head)->prev; prefetch(pos->prev), pos != (head); \
            pos = 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.

Definition at line 215 of file slist.h.

#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.

Definition at line 225 of file slist.h.

#define LIST_HEAD

(

name

)

struct list_head name = LIST_HEAD_INIT(name)

Definition at line 21 of file slist.h.

#define LIST_HEAD_INIT

(

name

)

{ &(name), &(name) }

Definition at line 19 of file slist.h.

#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.

Definition at line 258 of file slist.h.

---

Function Documentation

static void __list_add	(	struct list_head *	new,
		struct list_head *	prev,
		struct list_head *	next
	)			[inline, static]

Definition at line 34 of file slist.h.

References list_head::next, and list_head::prev.

Referenced by list_add(), and list_add_tail().

{
    next->prev = new;
    new->next = next;
    new->prev = prev;
    prev->next = new;
}

static void __list_del	(	struct list_head *	prev,
		struct list_head *	next
	)			[inline, static]

Definition at line 77 of file slist.h.

References list_head::next, and list_head::prev.

Referenced by list_del(), list_del_init(), list_move(), and list_move_tail().

{
    next->prev = prev;
    prev->next = next;
}

static void __list_splice	(	struct list_head *	list,
		struct list_head *	head
	)			[inline, static]

Definition at line 138 of file slist.h.

References list_head::next, and list_head::prev.

Referenced by list_splice(), and list_splice_init().

{
    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;
}

static void list_add	(	struct list_head *	new,
		struct list_head *	head
	)			[inline, static]

list_add - add a new entry : new entry to be added : list head to add it after

Insert a new entry after the specified head. This is good for implementing stacks.

Definition at line 52 of file slist.h.

References __list_add(), and list_head::next.

Referenced by list_move().

{
    __list_add(new, head, head->next);
}

static void list_add_tail	(	struct list_head *	new,
		struct list_head *	head
	)			[inline, static]

list_add_tail - add a new entry : new entry to be added : list head to add it before

Insert a new entry before the specified head. This is useful for implementing queues.

Definition at line 65 of file slist.h.

References __list_add(), and list_head::prev.

Referenced by list_move_tail().

{
    __list_add(new, head->prev, head);
}

static void list_del

(

struct list_head *

entry

)

[inline, static]

list_del - deletes entry from list. : the element to delete from the list. Note: list_empty on entry does not return true after this, the entry is in an undefined state.

Definition at line 89 of file slist.h.

References __list_del(), list_head::next, and list_head::prev.

{
    __list_del(entry->prev, entry->next);
    entry->next = LIST_POISON1;
    entry->prev = LIST_POISON2;
}

static void list_del_init

(

struct list_head *

entry

)

[inline, static]

list_del_init - deletes entry from list and reinitialize it. : the element to delete from the list.

Definition at line 100 of file slist.h.

References __list_del(), INIT_LIST_HEAD, list_head::next, and list_head::prev.

{
    __list_del(entry->prev, entry->next);
    INIT_LIST_HEAD(entry);
}

static int list_empty

(

const struct list_head *

head

)

[inline, static]

list_empty - tests whether a list is empty : the list to test.

Definition at line 133 of file slist.h.

References list_head::next.

Referenced by list_splice(), and list_splice_init().

{
    return head->next == head;
}

static void list_move	(	struct list_head *	list,
		struct list_head *	head
	)			[inline, static]

list_move - delete from one list and add as another's head : the entry to move : the head that will precede our entry

Definition at line 111 of file slist.h.

References __list_del(), list_add(), list_head::next, and list_head::prev.

{
        __list_del(list->prev, list->next);
        list_add(list, head);
}

static void list_move_tail	(	struct list_head *	list,
		struct list_head *	head
	)			[inline, static]

list_move_tail - delete from one list and add as another's tail : the entry to move : the head that will follow our entry

Definition at line 122 of file slist.h.

References __list_del(), list_add_tail(), list_head::next, and list_head::prev.

{
        __list_del(list->prev, list->next);
        list_add_tail(list, head);
}

static void list_splice	(	struct list_head *	list,
		struct list_head *	head
	)			[inline, static]

list_splice - join two lists : the new list to add. : the place to add it in the first list.

Definition at line 157 of file slist.h.

References __list_splice(), and list_empty().

{
    if (!list_empty(list))
        __list_splice(list, head);
}

static void list_splice_init	(	struct list_head *	list,
		struct list_head *	head
	)			[inline, static]

list_splice_init - join two lists and reinitialise the emptied list. : the new list to add. : the place to add it in the first list.

The list at is reinitialised

Definition at line 170 of file slist.h.

References __list_splice(), INIT_LIST_HEAD, and list_empty().

{
    if (!list_empty(list)) {
        __list_splice(list, head);
        INIT_LIST_HEAD(list);
    }
}

---