详细聊聊container_of这个宏定义

 

正文

大家周末好，我是bug菌~ 今天主要是跟大家详细聊聊container_of这个宏定义，非常经典的宏，只是一直没有抽时间细细品味，今天就跟大家一起来看看有何神奇之处:

1offsetof

首先我们需要简单看看offsetof(TYPE, MEMBER) 这个宏定义，它是用于计算一个结构体中某个成员的偏移量。

其第一个参数 TYPE 是一个结构体类型，第二个参数 MEMBER 是 TYPE 中的一个成员变量名。

它将返回类型为 size_t 的整数，表示 MEMBER 相对于 TYPE 起始地址的偏移量。

基本原理是根据 C 语言的数据对齐机制，成员变量在类型定义中的相对位置决定了它的偏移量。

 

#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)

 

该宏定义使用了C语言中的指针运算和类型转换。具体实现步骤如下：

1、(TYPE *)0：将0强制类型转换为指向类型为TYPE的指针，得到了一个结构体TYPE的空指针。

2、&((TYPE *)0)->MEMBER：求出结构体类型TYPE中成员MEMBER的地址。其巧妙之处在于，由于空指针不指向任何对象，因此这个成员的地址就是相对于结构体首地址的偏移量。

3、(size_t)：将偏移量转换为无符号整型数，以满足C语言标准库中对offsetof()返回值的类型要求。

该宏定义可以在编译时就直接计算出偏移量，避免了运行时的计算开销，因此比通过变量名访问成员的方式更为高效，通常用在需要直接访问结构体成员的底层代码中，例如在操作系统内核、嵌入式系统以及一些高性能计算应用中。

 

struct TestStruct {  
    int value1;  
    char value2;  
    double value3;  
};  

size_t offset = offsetof(struct TestStruct, value2);  

 

如上例，offset 变量将会存储 value2 相对于 TestStruct 起始地址的偏移量。在这种情况下，因为 TestStruct 中的 value1 通常占用了 4 个字节，value2 占用了 1 个字节，所以 value2 相对于结构体起始地址的偏移量应该是 4。

2container_of

讲完offsetof，来到今天的主角container_of，container_of()是一个在linux内核中经常使用的宏，用于获取一个结构体成员指针所在它所属的结构体的指针，有点绕口，细细品味。

该宏包括也主要包括三个参数：

ptr：结构体中某个成员的指针；

type：结构体类型名称；

member：结构体中ptr指向的成员名称。

首先，宏container_of()确定了ptr指向的成员在结构体中的偏移(offset)。通过offsetof()宏就可以得到这个偏移，其参数为结构体类型和成员名称。得到偏移后，再通过减去偏移的方式得到指向整个结构体的指针，巧妙吧。

具体实现如下：

 

#define container_of(ptr, type, member) ({ 
          const typeof(((type *)0)->member) *__mptr = (ptr); 
          (type *)((char *)__mptr - offsetof(type, member)); })

 

其中，typeof是GCC的一个扩展关键字，用于返回一个表达式的类型，可惜，大部分非GCC编译器不一定能支持。

假设ptr指向的成员变量的类型为T，__mptr就是一个指向T类型的指针。然后，调用offsetof()即可得到member在type类型中的偏移量，最后返回一个指向type类型的指针。

注意，尖括号不能省略，因为它表示类型转换。此外，container_of()宏使用了一个GCC的语言扩展"statement expression"，即后面的{}，可以在其中包含多条语句。

下面给出一个示例，用于说明container_of()的使用方法：

 

#include 
#include 

#define container_of(ptr, type, member) ({ 
          const typeof(((type *)0)->member) *__mptr = (ptr); 
          (type *)((char *)__mptr - offsetof(type, member)); })

struct student {
    int id;
    char name[20];
};

int main() {
    struct student stu = {10001, "Zhang San"};
    char *pname = stu.name;
    struct student *pstu = container_of(pname, struct student, name);

    printf("ID: %d, Name: %s
", pstu->id, pstu->name);
    return 0;
}

 

如上例，pname指向stu的name成员，通过container_of()宏获得了指向整个struct student结构体的指针pstu，然后就可以访问id和name成员了。

 

 　　审核编辑：汤梓红