Linux内核中list_for_each_entry浅析

向右看齐 2022-06-17 06:25 1005阅读 0赞

**本文的目录结构：**

一、list\_for\_each\_entry的作用与定义

二、list\_for\_each\_entry的简单实现

**一、list\_for\_each\_entry的作用与定义**

在[http://blog.csdn.net/tech\_pro/article/details/70237335][http_blog.csdn.net_tech_pro_article_details_70237335]这篇博文中通过list\_head来构造了链表，虽然方便实用，但也带来了一些额外的问题，比如如何对这些链表进行遍历，因为链表和结点元素是分开的，所以直接进行遍历是不方便的，而且也是不合理的。那么Linux内核当中对这个问题是不是有解决办法呢。

答案肯定是有的，这个就是list\_for\_each\_entry这个宏。这个宏的定义在内核的include\\linux\\list.h这个文件当中，它的定义如下：

/**
     * 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_entry((head)->next, typeof(*pos), member);	\
    	     &pos->member != (head); 	\
    	     pos = list_entry(pos->member.next, typeof(*pos), member))

这个宏的作用就是根据list\_head对链表进行遍历。

pos ：表示每一次遍历是返回的结构体变量的首地址

head : 表示要遍历的链表的头部

member ：表示该链表在结构体中的成员名称

**二、list\_for\_each\_entry的简单实现**

对内核实现的list\_for\_each\_entry进行分析可以看出它的head的第一个结点是不对应具体的结构体变量的，而我编写的代码的第一个结点head是具有和结构体变量的地址连接的，所以这里需要对list\_for\_each\_entry这个宏进行一下修改，修改如下：

/*	功能和list_for_each_entry相同
     *	但是遍历的结点是从head结点开始，而不是从head->next开始
     */
    #define yl_list_for_each_entry(pos, head, member)				\
    		for (pos = list_entry((head), typeof(*pos), member);	\
    			 &pos->member != NULL;	\
    			 pos = list_entry(pos->member.next, typeof(*pos), member))

完整的测试例程如下所示：

#include <stdio.h>
    #include <stdlib.h>
    #include <unistd.h>
    
    /* 找到指定的成员在定义的结构中的偏移的位置 */
    #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)); })
    
    /* 对container_of进行宏的再次定义，作用和container_of一样 */
    #define list_entry(ptr, type, member) \
    	container_of(ptr, type, member)
    
    /*	对一个链表中的所有元素进行遍历:
     *		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))
    
    /*	功能和list_for_each_entry相同
     *	但是遍历的结点是从head结点开始，而不是从head->next开始
     */
    #define yl_list_for_each_entry(pos, head, member)				\
    		for (pos = list_entry((head), typeof(*pos), member);	\
    			 &pos->member != NULL;	\
    			 pos = list_entry(pos->member.next, typeof(*pos), member))
    
    
    /* 链表连接件的结构体定义 */
    struct list_head {
    	struct list_head *next, *prev;	
    };
    
    /* 定义一个student结构体，然后用list_head将这些结构体串起来 */
    struct student{
    	char name[20];			//名字字段
    	struct list_head list;	// 连接件字段
    };
    
    /* 程序的入口函数 */
    int main(int argc, char *argv[])
    {
    	int i;
    	struct student *stu;
    	struct student *p;
    	struct list_head *g_list = NULL;	/* 表示链表头部 */
    	struct list_head *t_list = NULL;	/* 表示临时链表元素指针 */
    
    	/* 动态分配一块内存区域 */
    	stu = malloc(sizeof(struct student) * 10);
    	if(!stu)
    	{
    		printf("malloc error!\n");
    		return -1;
    	}
    
    	/* 对内存区域进行赋值，并将其加入到定义的链表当中 */
    	for(i = 0; i < 10; i++)
    	{
    		sprintf(stu[i].name, "TECH-PRO - %d", i);
    
    		/* 判断链表是否为空 */
    		if(!g_list)		/* 为空 */
    		{
    			g_list = &stu[i].list;
    			g_list->next = NULL;
    		}
    		else			/* 不为空 */
    		{
    			t_list = g_list;
    			while(t_list)	/* 对链表进行遍历 */
    			{
    				if(t_list->next== NULL)
    				{
    					t_list->next = &stu[i].list;
    					stu[i].list.next = NULL;
    				}
    				t_list = t_list->next;
    			}
    		}
    	}
    
    	i = 0;
    
    	/* 对链表进行遍历 */
    	yl_list_for_each_entry(p, g_list, list)
    	{
    		printf("%d : %s\n", i, p->name);
    		i += 1;
    	}
    
    	return 0;
    }

编译并运行，结果如下：

![Center][]

[http_blog.csdn.net_tech_pro_article_details_70237335]: http://blog.csdn.net/tech_pro/article/details/70237335
[Center]: /images/20220617/0a2c45367bbe4db8b3261f61beaa5a7f.png