container_of()宏
功能:获得“包含某个结构成员的结构”的指针。即根据一个结构体变量中的一个域成员变量的指针来获取指向整个结构体变量的指针。
位置:include/linux/kernel.h
用法:
例如,已经定义了一个结构体变量:
struct test_struct {
type1 mem1;
type2 mem2;
type3 mem3;
type4 mem4;
};
struct test_struct exm;
然后,在另一个位置,获取到结构体变量exm中的某一个域成员变量的指针,比如:
type3 *memptr = get_mem_pointer();
此时,如果需要获取指向整个结构体变量exm的指针,就可以这么做:
struct test_struct *exmp = container_of(memptr, struct test_struct, mem3);
这样,就可以通过一个结构体变量的一个域成员变量的指针获得了整个结构体变量的指针。
实现思路:
#define offsetof(TYPE, MEM) ((size_t) &((TYPE *)0)->MEM)
#define container_of(ptr, type, mem)
({ \
const typeof( ((type *)0)->mem ) *__mptr = (ptr); \
(type *)( (char *)__mptr - offsetof(type, mem) );
})
可见,__mptr指向的是一个type结构里typeof(((type *)0)->mem)类型mem成员的指针,offsetof(type, mem)是这个成员在结构中的偏移,单位是字节,为了计算type结构的起始地址,__mptr减去它自己的偏移量。
实现详解:
首先,将container_of(memptr, struct test_struct, type3)根据宏的定义进行展开如下:
1) struct test_struct *exmp = ({ \
2) const typeof( ((struct test_struct *)0)->mem3 ) *__mptr = (memptr); \
3) (struct test_struct *)( (char *)__mptr - offsetof(struct test_struct, mem3) );})
其中,typeof的作用是根据变量获取变量的类型。因此,上述代码中的第2)行的作用是首先使用typeof获取结构体域变量mem3的类型为 type3,然后定义了一个type3指针类型的临时变量__mptr,并将实际结构体变量中的域变量的指针memptr的值赋给临时变量__mptr。
(char *)__mptr转换为字节型指针.
(char *)__mptr - offsetof(type, mem) )用来求出结构体起始地址(为char *型指针),然后(type *)( (char *)__mptr - offsetof(type,mem) )在(type *)作用下进行将字节型的结构体起始指针转换为type *型的结构体起始指针。
假设结构体变量exm在实际内存中的位置如下图所示:
exm
| mem1 | +-------------+ 0xA000
| mem2 | +-------------+ 0xA004
| mem3 | +-------------+ 0xA010
| mem4 | +-------------+ 0xA018
则在执行了上述代码的第2行之后__mptr的值即为0xA010。再看上述代码的第3行,其中需要说明的是offsetof,它定义在include/linux/stddef.h中,其定义如下:
#define offsetof(TYPE, MEM) ((size_t) &((TYPE *)0)->MEM)
先分析一下这个宏的运行机制,一共4步:
A. ( (TYPE *)0 ) 将零转型为TYPE类型指针;
B. ((TYPE *)0)->MEM 访问结构中的数据成员;
C. &( ( (TYPE *)0 )->MEM ) 取出数据成员的地址;
D. (size_t)(&(((TYPE*)0)->MEM)) 结果转换类型。
offsetof的实现原理,就是取结构体中的域成员相对于地址0的偏移地址(也就是域成员变量相对于结构体变量首地址的偏移)。巧妙之处就在于此,即将0转换成(TYPE*),结构体以内存空间首地址0作为起始地址,那么成员地址自然为偏移地址。
因此,offsetof(struct test_struct, mem3)调用返回的值就是mem3相对于exm变量的偏移。结合上述给出的变量地址分布图可知,offsetof(struct test_struct, mem3)将返回0x10。
于是,由上述分析可知,此时,__mptr==0xA010,offsetof(struct test_struct, mem3)==0x10。因此, (char *)__mptr - ((size_t) &((struct test_struct *)0)->mem3) == 0xA010 - 0x10 == 0xA000,也就是结构体变量exm的首地址(如上图所示)。
这就是从结构体某成员变量指针来求出该结构体的首指针。指针类型从结构体某成员变量类型转换为该结构体类型。由此,container_of实现了根据一个结构体变量中的一个域成员变量的指针来获取指向整个结构体变量的指针的功能。