container_of宏剖析

container_of宏剖析
//该宏位于include/linux/kernel.h

1.定义格式

/**

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

}

struct demo_struct demo1,*pdemo;

type2 * demo_member2=demo1.member2;

如果要得到demo1的指针，可以使用该宏：

pdemo=container_of(demo_member2,struct demo_struct,member2);

2.宏运行机理解析

typeof是GNU C对标准C的扩展，它的作用是根据变量获取变量的类型。将上例中的宏按照宏定义进行展开，如下：

1 pdemo=({\

2 const typeof(((struct demo_struct *)0)->member2) *__mptr=(demo_member2); \

3 (struct demo_struct *)((char *)__mptr-offsetof(struct demo_struct, member2));\

4 })

从上面定义来看，代码中的第2行的作用是首先使用typeof获取结构体域变量member2的类型为type2，然后定义了一个type2指针类型的临时变量__mptr，并将实际结构体变量中的域变量的指针demo_member2的值赋给临时变量__mptr。

第2行代码实际上类似下面定义：

const type2 * __mptr=demo_member2;

这里((struct demo_struct *)0)比较巧妙，它指的是struct demo_struct型变量地址为基地址，偏移量为0的地址，实际上就是struct demo_struct型变量地址。

第3行代码中，(char *)__mptr转换为字节型指针。(char *)__mptr - offsetof(type,member) )用来求出结构体起始地址（为char *型指针），然后(type *)( (char *)__mptr - offsetof(type,member) )在(type *)作用下进行将字节型的结构体起始指针转换为type *型的结构体起始指针。

其中，offsetof宏定义如下：

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

可以看出，该宏就是计算出TYPE变量中MEMBER成员基地址。该宏运行机理如下:

l ( (TYPE *)0 )将零转型为TYPE类型指针;

l ((TYPE *)0)->MEMBER访问结构中的数据成员;

l &( ( (TYPE *)0 )->MEMBER )取出数据成员的地址;

l (size_t)(&(((TYPE*)0)->MEMBER))结果转换类型。

该宏巧妙之处在于将0转换成(TYPE*)，如果结构体以内存空间首地址0作为起始地址，则成员地址自然为偏移地址；

__mptr - offsetof(struct demo_struct, member2)

type1 member1

type2 member2

type3 member3

offsetof(type,member)__mptr

__mptr - offsetof(struct demo_struct, member2)

type1 member1

type2 member2

type3 member3

offsetof(type,member)__mptr

还有一篇文章

在linux内核中经常可以看到container_of的身影，也是linux引以为豪的地方之一了。《linux设备驱动开发详解》132页对container_of的作用作了说明——通过结构体成员的指针找到这个成员所在结构体的指针。但没有具体分析它是怎么实现的。

下面我们先看看这个宏的定义：

/**

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

参数ptr是结构体typ的成员member的指针，我们很多时候希望得到结构体type的起始地址，也就是type的指针。

假设这个type在内存中的存储模型如下：

type
|----------|
| |
| |
|----------|

ptr->| member --|
|----------|
| |
| |
|----------|

这里，我们拆开来就好理解了：

首先，(type *)0)是把0地址转化为TYPE结构的指针（这里把0换成其它值也是一样的）；

((type *)0)->member type结构体中的member成员；

typeof( ((type *)0)->member ) 返回member的类型；

const typeof( ((type *)0)->member ) *__mptr = (ptr); 用上面这个类型定义一个指针__mptr，并把ptr赋值给它；

(char *)__mptr 把__mptr转化成char型指针；

offsetof宏定义在[include/linux/stddef.h]中定义为：
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
这里，说明一下这个宏，((size_t) &((TYPE *)0)->MEMBER)把0地址转化为TYPE结构的指针，然后获取该结构中MEMBER成员的指针，并将其强制转换为size_t类型。于是，由于结构从0地址开始定义，因此，这样求出的MEMBER成员地址，实际上就是它在结构中的偏移量。这也显示出了C语言中指针的强大。因为，在某个体系结构下实现的libc，结构中各个成员的偏移总是可以预见的。

现在有了member成员在type结构体中的偏移量，又有了指向member的指针__mptr，自然就可以计算出type结构的起始地址了。
小小一个宏就包括了这么多精华，可见linux的博大。