Linux内核中的常用宏container_of

Container_of在Linux内核中是一个常用的宏，用于从包含在某个结构中的指针获得结构本身的指针，通俗地讲就是通过结构体变量中某个成员的首地址进而获得整个结构体变量的首地址。

Container_of的定义如下：

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

其实它的语法很简单，只是一些指针的灵活应用，它分两步：

第一步，首先定义一个临时的数据类型（通过typeof( ((type *)0)->member )获得）与ptr相同的指针变量__mptr，然后用它来保存ptr的值。

第二步，用(char *)__mptr减去member在结构体中的偏移量，得到的值就是整个结构体变量的首地址（整个宏的返回值就是这个首地址）。

其中的语法难点就是如何得出成员相对结构体的偏移量？

通过例子说明，如清单1：

1. /* linux-2.6.38.8/include/linux/compiler-gcc4.h */
2. #define __compiler_offsetof(a,b) __builtin_offsetof(a,b)
3. /* linux-2.6.38.8/include/linux/stddef.h */
4. #undef offsetof
5. #ifdef __compiler_offsetof
6. #define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER)
7. #else
8. #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
9. #endif
10. #include <stdio.h>
11. struct test_struct {
12. int num;
13. char ch;
14. float fl;
15. };
16. int main(void)
17. {
18. printf("offsetof(struct test_struct, num) = %d\n",
19. offsetof(struct test_struct, num));
20. printf("offsetof(struct test_struct,  ch) = %d\n",
21. offsetof(struct test_struct, ch));
22. printf("offsetof(struct test_struct,  fl) = %d\n",
23. offsetof(struct test_struct, fl));
24. return 0;
25. }

说明，__builtin_offsetof(a,b)是GCC的内置函数，可认为它的实现与((size_t) &((TYPE *)0)->MEMBER)这段代码是一致的。

例子输出结果：

1. offsetof(struct test_struct, num) = 0
2. offsetof(struct test_struct,  ch) = 4
3. offsetof(struct test_struct,  fl) = 8

其中代码难以理解的地方就是它灵活地运用了0地址。如果觉得&( (struct test_struct *)0 )->ch这样的代码不好理解，那么我们可以假设在0地址分配了一个结构体变量struct test_struct a，然后定义结构体指针变量p并指向a（struct test_struct *p = &a），如此我们就可以通过&p->ch获得成员ch的地址。由于a的首地址为0x0，所以成员ch的首地址为0x4。

最后通过强制类型转换（size_t）把一个地址值转换为一个整数。

分析完container_of的定义，接下来举两个例子来体会一下它的使用方法。

正确的例子，如清单2：

1. /* linux-2.6.38.8/include/linux/compiler-gcc4.h */
2. #define __compiler_offsetof(a,b) __builtin_offsetof(a,b)
3. /* linux-2.6.38.8/include/linux/stddef.h */
4. #undef offsetof
5. #ifdef __compiler_offsetof
6. #define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER)
7. #else
8. #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
9. #endif
10. /* linux-2.6.38.8/include/linux/kernel.h *
11. * container_of - cast a member of a structure out to the containing structure
12. * @ptr: the pointer to the member.
13. * @type:   the type of the container struct this is embedded in.
14. * @member:    the name of the member within the struct.
15. *
16. */
17. #define container_of(ptr, type, member) ({      \
18. const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
19. (type *)( (char *)__mptr - offsetof(type,member) );})
20. #include <stdio.h>
21. struct test_struct {
22. int num;
23. char ch;
24. float fl;
25. };
26. int main(void)
27. {
28. struct test_struct init_test_struct = { 99, 'C', 59.12 };
29. char *char_ptr = &init_test_struct.ch;
30. struct test_struct *test_struct = container_of(char_ptr, struct test_struct, ch);
31. printf(" test_struct->num = %d\n test_struct->ch = %c\n test_struct->fl = %f\n",
32. test_struct->num, test_struct->ch, test_struct->fl);
33. return 0;
34. }

例子输出结果：

1. test_struct->num = 99
2. test_struct->ch = C
3. test_struct->fl = 59.119999

不适当的例子，如清单3：

1. /* linux-2.6.38.8/include/linux/compiler-gcc4.h */
2. #define __compiler_offsetof(a,b) __builtin_offsetof(a,b)
3. /* linux-2.6.38.8/include/linux/stddef.h */
4. #undef offsetof
5. #ifdef __compiler_offsetof
6. #define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER)
7. #else
8. #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
9. #endif
10. /* linux-2.6.38.8/include/linux/kernel.h *
11. * container_of - cast a member of a structure out to the containing structure
12. * @ptr: the pointer to the member.
13. * @type:   the type of the container struct this is embedded in.
14. * @member:    the name of the member within the struct.
15. *
16. */
17. #define container_of(ptr, type, member) ({      \
18. const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
19. (type *)( (char *)__mptr - offsetof(type,member) );})
20. #include <stdio.h>
21. struct test_struct {
22. int num;
23. char ch;
24. float fl;
25. };
26. int main(void)
27. {
28. char real_ch = 'A';
29. char *char_ptr = &real_ch;
30. struct test_struct *test_struct = container_of(char_ptr, struct test_struct, ch);
31. printf(" char_ptr = %p  test_struct = %p\n\n", char_ptr, test_struct);
32. printf(" test_struct->num = %d\n test_struct->ch = %c\n test_struct->fl = %f\n",
33. test_struct->num, test_struct->ch, test_struct->fl);
34. return 0;
35. }

例子输出结果：

1. char_ptr = 0xbfb72d7f  test_struct = 0xbfb72d7b
2. test_struct->num = -1511000897
3. test_struct->ch = A
4. test_struct->fl = 0.000000

注意，由于这里并没有一个具体的结构体变量，所以成员num和fl的值是不确定的。