#ifndef _LINUX_LIST_H_
#define _LINUX_LIST_H_

//Linux双向循环链表库文件

//指针域
struct list_head
{
	struct list_head *next,*prev;
};

//两个安全位置
#define LIST_POISON1  ((void *) 0x00100100)
#define LIST_POISON2  ((void *) 0x00200200)

//功能：计算指针域在结构体中的偏移量
//type：结构体数据类型
//member：结构体指针域成员名
//返回值：指针域在结构体中的偏移量
#define offsetof(type, member) ((size_t) &((type *)0)->member)

//功能：由指针域地址计算结构体地址
//ptr：当前指针域地址
//type：结构体数据类型
//member：结构体指针域成员名
//返回值：结构体地址
#define container_of(ptr, type, member) ({			\
	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
	(type *)( (char *)__mptr - offsetof(type,member) );})

//功能：初始化头节点
//name：头节点结构体
#define LIST_HEAD_INIT(name) { &(name), &(name) }
#define LIST_HEAD(name) \
	struct list_head name = LIST_HEAD_INIT(name)
//功能：初始化头节点
//list：头节点地址
static inline void INIT_LIST_HEAD(struct list_head *list)
{
	list->next = list;
	list->prev = list;
}

//功能：插入一个节点
//new：新插入的节点地址
//prev：前一个节点地址
//next：后一个节点地址
#ifndef CONFIG_DEBUG_LIST
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;
}
#else
extern void __list_add(struct list_head *new,
			      struct list_head *prev,
			      struct list_head *next);
#endif

//功能：向表头插入一个节点（向后插入节点）
//new：新插入的节点地址
//head：头节点地址（插入节点地址）
static inline void list_add(struct list_head *new, struct list_head *head)
{
	__list_add(new, head, head->next);
}

//功能：向表尾插入一个节点（向前插入节点）
//new：新插入的节点地址
//head：头节点地址（插入节点地址）
static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
	__list_add(new, head->prev, head);
}

//功能：删除一个节点
//prev：前一个节点地址
//next：后一个节点地址
static inline void __list_del(struct list_head * prev, struct list_head * next)
{
	next->prev = prev;
	prev->next = next;
}

//功能：删除一个节点
//entry：要删除的节点地址
#ifndef CONFIG_DEBUG_LIST
static inline void __list_del_entry(struct list_head *entry)
{
	__list_del(entry->prev, entry->next);
}

//功能：删除一个节点并消除野地址
//entry：要删除的节点地址
static inline void list_del(struct list_head *entry)
{
	__list_del(entry->prev, entry->next);
	entry->next = LIST_POISON1;
	entry->prev = LIST_POISON2;
}
#else
extern void __list_del_entry(struct list_head *entry);
extern void list_del(struct list_head *entry);
#endif

 //功能：替换一个节点
 //old：被替换的节点地址
 //new：新替换的节点地址
static inline void list_replace(struct list_head *old,
				struct list_head *new)
{
	new->next = old->next;
	new->next->prev = new;
	new->prev = old->prev;
	new->prev->next = new;
}

//功能：替换一个节点并初始化被替换的节点
 //old：被替换的节点地址
 //new：新替换的节点地址
static inline void list_replace_init(struct list_head *old,
					struct list_head *new)
{
	list_replace(old, new);
	INIT_LIST_HEAD(old);
}

//功能：删除一个节点并初始化被删除的节点
//entry：要删除的节点地址
static inline void list_del_init(struct list_head *entry)
{
	__list_del_entry(entry);
	INIT_LIST_HEAD(entry);
}

//功能：将一个节点移动至表头（移动至插入点后）
//list：要移动的节点地址
//head：头节点地址（目标节点地址）
static inline void list_move(struct list_head *list, struct list_head *head)
{
	__list_del_entry(list);
	list_add(list, head);
}

//功能：将一个节点移动至表尾（移动至插入点前）
//list：要移动的节点地址
//head：头节点地址（目标节点地址）
static inline void list_move_tail(struct list_head *list,
				  struct list_head *head)
{
	__list_del_entry(list);
	list_add_tail(list, head);
}

//功能：判断是否为尾节点
//list：要判断的节点地址
//head：头节点地址
//返回值：1：是  /  0：否
static inline int list_is_last(const struct list_head *list,
				const struct list_head *head)
{
	return list->next == head;
}

//功能：判断是否为空链表
//head：头节点地址
//返回值：1：是  /  0：否
static inline int list_empty(const struct list_head *head)
{
	return head->next == head;
}

//功能：判断是否为空链表且未被修改
//head：头节点地址
//返回值：1：是  /  0：否
static inline int list_empty_careful(const struct list_head *head)
{
	struct list_head *next = head->next;
	return (next == head) && (next == head->prev);
}

//功能：向左反转链表（将首元素插到尾部）
//head：头节点地址
static inline void list_rotate_left(struct list_head *head)
{
	struct list_head *first;

	if (!list_empty(head)) {
		first = head->next;
		list_move_tail(first, head);
	}
}

//功能：判断是否只有一个节点
//head：头节点地址
//返回值：1：是  /  0：否
static inline int list_is_singular(const struct list_head *head)
{
	return !list_empty(head) && (head->next == head->prev);
}

//将一个链表剪切成两段（内部调用）
//list：剪下来的链表的头节点地址（容器）
//head：被剪切链表的头节点地址
//entry：要剪断节点的地址
static inline void __list_cut_position(struct list_head *list,
		struct list_head *head, struct list_head *entry)
{
	struct list_head *new_first = entry->next;
	list->next = head->next;
	list->next->prev = list;
	list->prev = entry;
	entry->next = list;
	head->next = new_first;
	new_first->prev = head;
}

//将一个链表剪切成两段
//list：剪下来的链表的头节点地址（容器）
//head：被剪切链表的头节点地址
//entry：要剪断节点的地址
static inline void list_cut_position(struct list_head *list,
		struct list_head *head, struct list_head *entry)
{
	if (list_empty(head))
		return;
	if (list_is_singular(head) &&
		(head->next != entry && head != entry))
		return;
	if (entry == head)
		INIT_LIST_HEAD(list);
	else
		__list_cut_position(list, head, entry);
}

//将一个链表插入到另一个链表
//list：要插入的链表的头节点地址
//prev：被插入链表前节点地址
//next：被插入链表后节点地址
static inline void __list_splice(const struct list_head *list,
				 struct list_head *prev,
				 struct list_head *next)
{
	struct list_head *first = list->next;
	struct list_head *last = list->prev;

	first->prev = prev;
	prev->next = first;

	last->next = next;
	next->prev = last;
}

//将一个链表插入到另一个链表表头（向后插入链表）
//list：要插入的链表的头节点地址
//head：被插入链表头节点地址（插入节点地址）
static inline void list_splice(const struct list_head *list,
				struct list_head *head)
{
	if (!list_empty(list))
		__list_splice(list, head, head->next);
}

//将一个链表插入到另一个链表表尾（向前插入链表）
//list：要插入的链表的头节点地址
//head：被插入链表头节点地址（插入节点地址）
static inline void list_splice_tail(struct list_head *list,
				struct list_head *head)
{
	if (!list_empty(list))
		__list_splice(list, head->prev, head);
}

//将一个链表插入到另一个链表表头并初始化剩下的空链表（向后插入链表）
//list：要插入的链表的头节点地址
//head：被插入链表头节点地址（插入节点地址）
static inline void list_splice_init(struct list_head *list,
				    struct list_head *head)
{
	if (!list_empty(list)) {
		__list_splice(list, head, head->next);
		INIT_LIST_HEAD(list);
	}
}

//将一个链表插入到另一个链表表尾并初始化剩下的空链表（向前插入链表）
//list：要插入的链表的头节点地址
//head：被插入链表头节点地址（插入节点地址）
static inline void list_splice_tail_init(struct list_head *list,
					 struct list_head *head)
{
	if (!list_empty(list)) {
		__list_splice(list, head->prev, head);
		INIT_LIST_HEAD(list);
	}
}

//功能：由指针域地址计算结构体地址
//ptr：当前指针域地址
//type：结构体数据类型
//member：结构体指针域成员名
//返回值：结构体地址
#define list_entry(ptr, type, member) \
	container_of(ptr, type, member)

//功能：由头节点指针域地址计算结构体地址
//ptr：指针域头节点地址
//type：结构体数据类型
//member：结构体指针域成员名
#define list_first_entry(ptr, type, member) \
	list_entry((ptr)->next, type, member)

//功能：顺序遍历链表（指针域遍历）
//pos：指针域游标地址
//head：指针域头节点地址
#define list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); pos = pos->next)

//功能：顺序遍历链表（指针域遍历）
//pos：指针域游标地址
//head：指针域头节点地址
//备注：与list_for_each(pos, head)相同
#define __list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); pos = pos->next)

//功能：逆序遍历链表（指针域遍历）
//pos：指针域游标地址
//head：指针域头节点地址
#define list_for_each_prev(pos, head) \
	for (pos = (head)->prev; pos != (head); pos = pos->prev)

//功能：安全顺序遍历链表（指针域遍历）
//pos：指针域游标地址（供数据操作使用）
//n：指针域游标地址（供遍历使用）
//head：指针域头节点地址
 //备注：避免删除节点造成的混乱
#define list_for_each_safe(pos, n, head) \
	for (pos = (head)->next, n = pos->next; pos != (head); \
		pos = n, n = pos->next)

//功能：安全逆序遍历链表（指针域遍历）
//pos：指针域游标地址（供数据操作使用）
//n：指针域游标地址（供遍历使用）
//head：指针域头节点地址
 //备注：避免删除节点造成的混乱
#define list_for_each_prev_safe(pos, n, head) \
	for (pos = (head)->prev, n = pos->prev; \
	     pos != (head); \
	     pos = n, n = pos->prev)

//功能：表头开始顺序遍历链表（结构体遍历）
//pos：结构体游标地址
//head：指针域头节点地址
//member：结构体指针域成员名
#define list_for_each_entry(pos, head, member)				\
	for (pos = list_entry((head)->next, typeof(*pos), member);	\
	     &pos->member != (head); 	\
	     pos = list_entry(pos->member.next, typeof(*pos), member))

//功能：表头开始逆序遍历链表（结构体遍历）
//pos：结构体游标地址
//head：指针域头节点地址
//member：结构体指针域成员名
#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_continue()函数准备一个pos
//pos：结构体游标地址
//head：指针域头节点地址
//member：结构体指针域成员名
//返回值：空：无   非空：结构体地址
#define list_prepare_entry(pos, head, member) \
	((pos) ? : list_entry(head, typeof(*pos), member))

//功能：继续开始顺序遍历链表（结构体遍历）
//pos：结构体游标地址
//head：指针域头节点地址
//member：结构体指针域成员名
#define list_for_each_entry_continue(pos, head, member) 		\
	for (pos = list_entry(pos->member.next, typeof(*pos), member);	\
	     &pos->member != (head);	\
	     pos = list_entry(pos->member.next, typeof(*pos), member))

//功能：继续开始逆序遍历链表（结构体遍历）
//pos：结构体游标地址
//head：指针域头节点地址
//member：结构体指针域成员名
#define list_for_each_entry_continue_reverse(pos, head, member)		\
	for (pos = list_entry(pos->member.prev, typeof(*pos), member);	\
	     &pos->member != (head);	\
	     pos = list_entry(pos->member.prev, typeof(*pos), member))

//功能：当前点开始顺序遍历链表（结构体遍历）
//pos：结构体游标地址
//head：指针域头节点地址
//member：结构体指针域成员名
#define list_for_each_entry_from(pos, head, member) 			\
	for (; &pos->member != (head);	\
	     pos = list_entry(pos->member.next, typeof(*pos), member))

//功能：表头开始安全顺序遍历链表（结构体遍历）
//pos：结构体游标地址（供数据操作使用）
//n：结构体游标地址（供遍历使用）
//head：指针域头节点地址
//member：结构体指针域成员名
//备注：避免删除节点造成的混乱
#define list_for_each_entry_safe(pos, n, head, member)			\
	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))

//功能：继续开始安全顺序遍历链表（结构体遍历）
//pos：结构体游标地址（供数据操作使用）
//n：结构体游标地址（供遍历使用）
//head：指针域头节点地址
//member：结构体指针域成员名
//备注：避免删除节点造成的混乱
#define list_for_each_entry_safe_continue(pos, n, head, member) 		\
	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))

//功能：当前点开始安全顺序遍历链表（结构体遍历）
//pos：结构体游标地址（供数据操作使用）
//n：结构体游标地址（供遍历使用）
//head：指针域头节点地址
//member：结构体指针域成员名
//备注：避免删除节点造成的混乱
#define list_for_each_entry_safe_from(pos, n, head, member) 			\
	for (n = list_entry(pos->member.next, typeof(*pos), member);		\
	     &pos->member != (head);						\
	     pos = n, n = list_entry(n->member.next, typeof(*n), member))

//功能：表头开始安全逆序遍历链表（结构体遍历）
//pos：结构体游标地址（供数据操作使用）
//n：结构体游标地址（供遍历使用）
//head：指针域头节点地址
//member：结构体指针域成员名
//备注：避免删除节点造成的混乱
#define list_for_each_entry_safe_reverse(pos, n, head, member)		\
	for (pos = list_entry((head)->prev, typeof(*pos), member),	\
		n = list_entry(pos->member.prev, typeof(*pos), member);	\
	     &pos->member != (head); 					\
	     pos = n, n = list_entry(n->member.prev, typeof(*n), member))

 //功能：重置一个list_for_each_entry_safe()循环
//pos：结构体游标地址（供数据操作使用）
//n：结构体游标地址（供遍历使用）
//member：结构体指针域成员名
//一般说来，如果列表可以被并发修改(例如锁被丢弃在
//循环主体中)，那么本指令是不安全的。
//这方面的一个例外情况是，如果将游标元素(pos)固定
//在列表中，并且在重新获取锁之后并在完成循环主体的
//当前迭代之前调用本指令。
#define list_safe_reset_next(pos, n, member)				\
	n = list_entry(pos->member.next, typeof(*pos), member)

#endif