しょしきカーネルチェーンテーブル

前述したように,void*のポインタ,ゼロ長配列など,汎用タイプのチェーンテーブルをCで実現する方法について述べた.しかし、小菜鳥は結局マスターに追いつかないで、やはりLinuxの内核は巧みで、この中のチェーン時計、チェーン時計の中の“奇抜です”です.
ソースコードのパスはinclude/linux/listです.h
まず簡単なものをいくつか探して読みましょう.

struct list_head {
struct list_head *next, *prev;
};

これはinclude/linux/typesです.hで定義されています.名前はリストだけどヘッドは、ヘッドノードと感じさせますが、実はこれが共通のノードで、ヘッドとは少しも関係ありません.なぜデータドメインがないのか不思議に思うかもしれません.はい、データドメインがありません.データはどうする?後でわかりますが、このノードはユーザーデータに埋め込まれています.

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

ノードの初期化関数は、自分で自分を指します.

#define LIST_HEAD_INIT(name) { &(name), &(name) }

#define LIST_HEAD(name) \
	struct list_head name = LIST_HEAD_INIT(name)

は、ヘッダノードを定義し、初期化する.

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

は、2つのノードの間に新しいノードを挿入します.

static inline void list_add(struct list_head *new, struct list_head *head)
{
	__list_add(new, head, head->next);
}

headがヘッドノードであれば、これがヘッドプラグです.

static inline void list_add_tail(struct list_head *new, struct list_head *head)
{
	__list_add(new, head->prev, head);
}

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

ノードを削除します.

static inline int list_empty(struct list_head *head)
{
	return head->next == head;
}

チェーンテーブルが空であるか否かを判断し、ここでheadはヘッダノードである.

/**
 * list_for_each	-	iterate over a list
 * @pos:	the &struct list_head to use as a loop cursor.
 * @head:	the head for your list.
 */
#define list_for_each(pos, head) \
	for (pos = (head)->next; pos != (head); pos = pos->next)

これは遍歴です.

/**
 * list_for_each_safe - iterate over a list safe against removal of list entry
 * @pos:	the &struct list_head to use as a loop cursor.
 * @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_entry - get the struct for this 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.
 */
#define list_entry(ptr, type, member) \
	container_of(ptr, type, member)

container_についてofマクロ、私は別のブログで説明しました.ここではもう説明しません.実はこのマクロはcontainerにofベストを変えて
list_entry,ptrはlist_を指すheadのポインタ(小ポインタと略称する)は、typeは構造体のタイプで、例えばstruct XXXX、memberはlist_headの構造体の名前である.最後にstruct XXXXを指すポインタ(大ポインタと略称する)が得られる.このマクロを「小ポインタ転大ポインタ」と呼ぶ.

/**
 * list_first_entry - get the first element from a list
 * @ptr:	the list head to take the element from.
 * @type:	the type of the struct this is embedded in.
 * @member:	the name of the list_struct within the struct.
 *
 * Note, that list is expected to be not empty.
 */
#define list_first_entry(ptr, type, member) \
	list_entry((ptr)->next, type, member)

ptrはここでヘッダポインタを表し、このマクロは第1の構造体のアドレス(大きなポインタ)を得る.

/**
 * list_next_entry - get the next element in list
 * @pos:	the type * to cursor
 * @member:	the name of the list_struct within the struct.
 */
#define list_next_entry(pos, member) \
	list_entry((pos)->member.next, typeof(*(pos)), member)

posは、ここでは次の構造体のアドレスを得る構造体のポインタ(大きなポインタ)である.

/**
 * list_for_each_entry	-	iterate over list of given type
 * @pos:	the type * to use as a loop cursor.
 * @head:	the head for your list.
 * @member:	the name of the list_struct within the struct.
 */
#define list_for_each_entry(pos, head, member)				\
	for (pos = list_first_entry(head, typeof(*pos), member);	\
	     &pos->member != (head);					\
	     pos = list_next_entry(pos, member))

は、チェーンテーブル内の各大きなポインタを巡回します.
pos:大きなポインタ、head:ヘッダノード、member:list_headの構造体の名前
基本的にはここまでですが、次に例を書きます.

#include <stdio.h>
#include "list.h"


struct person {
	char name[12];
	struct list_head list;
	char sex;
	unsigned char age;
};


int main()
{
	struct person persons[] = {
		{"Marry", NULL,NULL,'f',20},
		{"Mike",NULL,NULL,'m',23},
		{"Leslie",NULL,NULL,'m', 36},
		{"Ann",NULL,NULL,'f',27}
	};

	LIST_HEAD(head);//   

	int i;
	for (i = 0; i < sizeof(persons)/sizeof(persons[0]); ++i) {
		list_add(&persons[i].list, &head);
	}
	
	struct list_head *cur = NULL;
	struct person *pdata = NULL;

	list_for_each(cur, &head) {
		pdata = container_of(cur, struct person, list);
		printf("%s:%d
", pdata->name, pdata->age);
	}


	printf("list_for_each_entry
");	
	list_for_each_entry(pdata, &head, list) {
		printf("%s:%d
", pdata->name, pdata->age);
	}

	
	
	return 0;
}

実行結果:
Ann:27
Leslie:36
Mike:23
Marry:20
list_for_each_entry
Ann:27
Leslie:36
Mike:23
Marry:20
(完)