container_of()宏

╰半橙微兮° 2022-08-27 14:43 103阅读 0赞

from: http://www.cnblogs.com/sdphome/archive/2011/09/14/2176624.html

在学习Linux驱动的过程中，遇到一个宏叫做container\_of。  
该宏定义在include/linux/kernel.h中，首先来贴出它的代码：  
  
/\*\*  
\* container\_of - cast a member of a structure out to the containing structure  
\* @ptr: the pointer to the member.  
\* @type: the type of the container struct this is embedded in.  
\* @member: the name of the member within the struct.  
\* \*/  
  
\#define container\_of(ptr, type, member) (\{ \\  
const typeof( ((type \*)0)->member ) \*\_\_mptr = (ptr); \\  
(type \*)( (char \*)\_\_mptr - offsetof(type,member) );\})  
  
它的作用显而易见，那就是根据一个结构体变量中的一个域成员变量的指针来获取指向整个结构体变量的指针。比如，有一个结构体变量，其定义如下：  
  
struct demo\_struct \{  
type1 member1;  
type2 member2;  
type3 member3;  
type4 member4;  
\};  
struct demo\_struct demo;  
同时，在另一个地方，获得了变量demo中的某一个域成员变量的指针，比如：  
type3 \*memp = get\_member\_pointer\_from\_somewhere();  
此时，如果需要获取指向整个结构体变量的指针，而不仅仅只是其某一个域成员变量的指针，我们就可以这么做：  
struct demo\_struct \*demop = container\_of(memp, struct demo\_struct, member3);  
这样，我们就通过一个结构体变量的一个域成员变量的指针获得了整个结构体变量的指针。  
下面说一说我对于这个container\_of的实现的理解：  
首先，我们将container\_of(memp, struct demo\_struct, type3)根据宏的定义进行展开如下：  
struct demo\_struct \*demop = (\{ \\  
const typeof( ((struct demo\_struct \*)0)->member3 ) \*\_\_mptr = (memp); \\  
(struct demo\_struct \*)( (char \*)\_\_mptr - offsetof(struct demo\_struct, member3) );\})  
其 中，typeof是GNU C对标准C的扩展，它的作用是根据变量获取变量的类型。因此，上述代码中的第2行的作用是首先使用typeof获取结构体域变量member3的类型为 type3，然后定义了一个type3指针类型的临时变量\_\_mptr，并将实际结构体变量中的域变量的指针memp的值赋给临时变量\_\_mptr。  
  
(char \*)\_\_mptr转换为字节型指针。(char \*)\_\_mptr - offsetof(type,member) )用来求出结构体起始地址（为char \*型指针），然后(type \*)( (char \*)\_\_mptr - offsetof(type,member) )在(type \*)作用下进行将字节型的结构体起始指针转换为type \*型的结构体起始指针。  
  
假设结构体变量demo在实际内存中的位置如下图所示：  
demo  
\+-------------+ 0xA000  
| member1 |  
\+-------------+ 0xA004  
| member2 |  
\+-------------+ 0xA010  
| member3 |  
\+-------------+ 0xA018  
| member4 |  
\+-------------+  
  
则，在执行了上述代码的第2行之后\_\_mptr的值即为0xA010。  
再看上述代码的第3行，其中需要说明的是offsetof，它定义在include/linux/stddef.h中，其定义如下：  
\#define offsetof(TYPE, MEMBER) ((size\_t) &((TYPE \*)0)->MEMBER)  
先分析一下这个宏的运行机理：  
一共4步  
1. ( (TYPE \*)0 ) 将零转型为TYPE类型指针;  
2. ((TYPE \*)0)->MEMBER 访问结构中的数据成员;  
3. &( ( (TYPE \*)0 )->MEMBER )取出数据成员的地址;  
4.(size\_t)(&(((TYPE\*)0)->MEMBER))结果转换类型。巧妙之处在于将0转换成(TYPE\*)，结构以内存空间首地址0作为起始地址，则成员地址自然为偏移地址；  
同样，我们将上述的offsetof调用展开，即为：  
(struct demo\_struct \*)( (char \*)\_\_mptr - ((size\_t) &((struct demo\_struct \*)0)->member3) );  
可见，offsetof的实现原理如上所述，就是取结构体中的域成员相对于地址0的偏移地址，也就是域成员变量相对于结构体变量首地址的偏移。  
因 此，offsetof(struct demo\_struct, member3)调用返回的值就是member3相对于demo变量的偏移。结合上述给出的变量地址分布图可知，offsetof(struct demo\_struct, member3)将返回0x10。  
于是，由上述分析可知，此时，\_\_mptr==0xA010，offsetof(struct demo\_struct, member3)==0x10。  
因此， (char \*)\_\_mptr - ((size\_t) &((struct demo\_struct \*)0)->member3) == 0xA010 - 0x10 == 0xA000，也就是结构体变量demo的首地址（如上图所示）。  
这就是从结构体某成员变量指针来求出该结构体的首指针。指针类型从结构体某成员变量类型转换为该结构体类型。  
由此，container\_of实现了根据一个结构体变量中的一个域成员变量的指针来获取指向整个结构体变量的指针的功能。  
  
以上内容载自网络，这篇文章分析的很透彻，顺便说一下，宋宝华的《linux设备驱动开发详解》P132 最后一行当中对该宏的参数解释是错误的！当然了，暇不掩瑜！  
以下是我自己的一些理解：  
首先，我定义了一个字符设备结构体  
struct globalmem\_dev  
\{  
struct cdev my\_cdev; //字符设备之基础结构体  
unsigned char mem\[GLOBALMEM\_SIZE\];  
struct semaphore sem;/  
\};  
接下来我实例化了一个该设备的指针对象  
struct globalmem\_dev \*pdev;  
  
后来在open函数中我是这么来用的  
int globalmem\_open(struct inode \*inode, struct file \*filp)关于filp的产生和消亡参见《驱动详解》P92  
\{  
struct globalmem\_dev \*pdev;  
printk("\\nFunction globalmem\_open Invoked\\n");  
pdev = container\_of(inode->i\_cdev, struct globalmem\_dev, my\_cdev);  
filp->private\_da

ta = pdev;  
if(down\_trylock(&pdev->sem))//获得信号量， 真的我爱 container\_of!!!! 我爱死container\_of 了！！！  
return -EBUSY;  
return 0;  
\}  
对以上用法的说明：  
参数3是参数2这个结构体的一个成员的名字！而不是类型名！参数1是一个指针，它指向参数3这个成员  
inode 中的i\_cdev字段是一个指针，当我们成功insmod了一个设备驱动的时候，我们会通过mknod创建一个设备文件节点并和具体设备（驱动）想关联， 这个设备文件节点所对应的就是struct inode结构体的一个实例，这个结构体有一个字段i\_cdev，是个struct cdev类型的指针，它会指向设备结构体的my\_cdev字段。至此你已经有了一个指向某个 globalmem\_dev的my\_cdev字段的一个指针（在调用open前pdev的内存分配假定已经完成）由此container\_of可以帮你计 算出指向该设备结构体的指针。  
当一个设备驱动对应多个设备（子设备）时，你就知道container\_of发挥的作用了！当你针对每一个设备调用 open时，因为每个设备对应的设备文件节点不一样，那么根据该节点的i\_cdev字段所计算的设备结构体指针也不一样，你就可以找到特定节点所对应的设 备结构体！而不至于对不同的子设备编写大同小异的各自的设备驱动。

转自：http://dev.firnow.com/course/6\_system/linux/linuxjq/20100313/198611.html