open-iscsi源碼分析 -- list-head分析

list-head結構在linux內核中用得非常多,這是一個雙向鏈表結構,可以靈活嵌入其他數據結構中,對於建立鏈表非常方便。在Linux內核中,由於很多數據結構都需要連成一個鏈表進行管理,所以有了list-head將鏈表的管理獨立出來,所以在內核編程不需要自己實現list-head的一些管理函數,可以直接調用。

  在open-iscsi用戶態編程時,將這個文件從內核中拷貝出來了:
#ifndef __LIST_H__
#define __LIST_H__

#include <stddef.h>
/* taken from linux kernel */

#undef offsetof
#ifdef __compiler_offsetof //這是gcc編譯器中定義的,與下面用戶自己定義的性質一樣
#define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER)
#else
//這裏這個&符號取地址非常巧妙,而且->運算符比取地址符&的優先級高
這樣就返回了member在type結構中的便宜量
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
#endif

//根據type數據結構中成員member的地址ptr,返回包含member的數據結構的地址
//因爲member是type結構中的一個成員名,所以這裏爲了取得member的類型,需要通過(type *)0->member,費了半天事
#define list_container_of(ptr, type, member) ({ \
        const typeof( ((type *)0)->member ) *__mptr = (ptr); \
        (type *)( (char *)__mptr - offsetof(type,member) );})

/*list_head 結構原型*/
struct list_head {
struct list_head *next, *prev;
};

/*初始化一個list_head*/
#define LIST_HEAD_INIT(name) { &(name), &(name) }

/*定義一個list_head並初始化*/
#define LIST_HEAD(name) \
struct list_head name = LIST_HEAD_INIT(name)

static inline void INIT_LIST_HEAD(struct list_head *list)
{
list->next = list;
list->prev = list;
}

/*鏈表頭節點不存數據,只存在鏈表頭節點,即爲空*/
static inline int list_empty(const struct list_head *head)
{
return head->next == head;
}

/*返回包含member的結構的地址*/
#define list_entry(ptr, type, member) \
list_container_of(ptr, type, member)

/*遍歷鏈表,頭節點不存放數據*/
#define list_for_each(pos, head) \
for (pos = (head)->next; pos != (head); pos = pos->next)

/*這個一般用於,pos是一個結構體指針,head是頭節點,member是list_head結構在類型pos結構體中的成員名,通過list_head對結構體鏈表進行遍歷*/
#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))

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

/*在pre和next中間插入new*/
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;
}
/*在鏈表頭插入節點*/
static inline void list_add(struct list_head *new, struct list_head *head)
{
__list_add(new, head, head->next);
}

/*在鏈表尾插入節點*/
static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
__list_add(new, head->prev, head);
}
/*將節點摘連*/
static inline void __list_del(struct list_head * prev, struct list_head * next)
{
next->prev = prev;
prev->next = next;
}
/*將一個節點摘連*/
static inline void list_del(struct list_head *entry)
{
__list_del(entry->prev, entry->next);
entry->next = entry->prev = NULL;
}

/*將以個節點摘連,然後初始化爲頭節點*/
static inline void list_del_init(struct list_head *entry)
{
__list_del(entry->prev, entry->next);
INIT_LIST_HEAD(entry);
}

/**
 * list_move_tail - delete from one list and add as another's tail
 * @list: the entry to move
 * @head: the head that will follow our entry
 */、
/*將一個節點摘連後插入鏈表尾*/
static inline void list_move_tail(struct list_head *list,
  struct list_head *head)
{
__list_del(list->prev, list->next);
list_add_tail(list, head);
}

#endif

通過這個list.h文件,發現將雙鏈表的管理操作獨立出來後,對編程中經常用到雙鏈表管理是非常方便的,在分析中發現typeof關鍵字起着至關重要的作用,後面的參考資料對typeof關鍵字進行了詳細分析,而typeof((c)+1)則更有意思。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章