了解Linux内核中的container_of宏


81

当我浏览Linux内核时,我发现了一个container_of定义如下的宏:

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

我了解container_of的作用,但我不明白的是最后一句话,即

(type *)( (char *)__mptr - offsetof(type,member) );})

如果我们按如下方式使用宏:

container_of(dev, struct wifi_device, dev);

最后一句话的相应部分是:

(struct wifi_device *)( (char *)__mptr - offset(struct wifi_device, dev);

看起来什么也没做。有人可以在这里填补空白吗?


这个答案一个使用红黑树的真实直观的示例rb_node
qeatzy

Answers:


86

您的用法示例container_of(dev, struct wifi_device, dev);可能会有点误导,因为您在此处混合了两个名称空间。

虽然dev示例中的第一个引用指针的名称,但是第二个dev引用结构成员的名称。

这种混淆很可能会激起所有人的头痛。实际上member,您引号中的参数是指在容器结构中赋予该成员的名称。

以这个容器为例:

struct container {
  int some_other_data;
  int this_data;
}

还有一个指向int *my_ptrthis_data成员的指针,您可以使用该宏通过以下方式获取指向的成员struct container *my_container

struct container *my_container;
my_container = container_of(my_ptr, struct container, this_data);

考虑this_data到结构开头的偏移量对于获取正确的指针位置至关重要。

实际上,您只需this_data要从指针中减去成员的偏移量my_ptr即可获得正确的位置。

这正是宏的最后一行。


5
对于需要更详细说明的人员:Radek Pazdera他的博客上非常清楚地解释了 container_of macro(include/linux/kernel.h)。顺便说一句list_entry宏()的定义非常相似,但现在定义为。include/linux/list.hcontainer_of
patryk.beza

1
另外,格雷格·克罗阿·哈特曼(Greg Kroah-Hartman)撰写的这篇博文可能也很有用:kroah.com/log/linux/container_of.html
EFraim,

1
原则上,这是一个很好的答案,只是它并不能真正回答相当多的问题?例如,最后一行代码实现了什么以及如何实现?
迈克尔·比尔

当我按照此示例进行操作时,使用GCC可以得到error: initialization from incompatible pointer type。这是由于const此线程在宏定义中引起的吗?stackoverflow.com/a/39963179/1256234
Andy J

18

最后一句话:

(type *)(...)

指向给定的指针type。指针计算为相对于给定指针的偏移量dev

( (char *)__mptr - offsetof(type,member) )

使用cointainer_of宏时,您想要检索包含给定字段的指针的结构。例如:

struct numbers {
    int one;
    int two;
    int three;
} n;

int *ptr = &n.two;
struct numbers *n_ptr;
n_ptr = container_of(ptr, struct numbers, two);

您有一个指向结构中间的指针(并且您知道这是指向已归档的two[结构中的字段名]的指针),但是您想检索整个结构(numbers)。因此,您可以计算two结构中字段的偏移量:

offsetof(type,member)

并从给定的指针中减去此偏移量。结果是指向结构开始的指针。最后,将此指针转换为具有有效变量的结构类型。


10

它是gcc扩展(语句expressions)的一种用法。如果您将宏视为返回值的东西,那么最后一行将是:

return (struct wifi_device *)( (char *)__mptr - offset(struct wifi_device, dev);

有关复合语句的说明,请参见链接页面。这是一个例子:

int main(int argc, char**argv)
{
    int b;
    b = 5;
    b = ({int a; 
            a = b*b; 
            a;});
    printf("b %d\n", b); 
}

输出是

b 25


7

Linux内核中的conatainer_of()宏-

在代码中管理多个数据结构时,几乎总是需要将一个结构嵌入另一个结构中,然后随时检索它们,而不会被问到有关内存偏移量或边界的问题。假设您有一个struct person,定义如下:

 struct person { 
     int age; 
     int salary;
     char *name; 
 } p;

通过仅使用年龄或薪水指针,您可以检索包装(包含)该指针的整个结构。顾名思义,container_of宏用于查找结构给定字段的容器。该宏在include / linux / kernel.h中定义,如下所示:

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

不要害怕指针。如下所示:

container_of(pointer, container_type, container_field); 

以下是上述代码片段的元素:

  • 指针:这是指向结构中字段的指针
  • container_type:这是包装(包含)指针的结构的类型
  • container_field:这是指针指向结构内部的字段的名称

让我们考虑以下容器:

struct person { 
    int age; 
    int salary; 
    char *name; 
}; 

现在,让我们考虑其实例之一,以及指向age成员的指针:

struct person somebody; 
[...] 
int *age_ptr = &somebody.age; 

与指向名称成员(age_ptr)的指针一起,可以使用container_of宏,以便通过使用以下命令来获取包装该成员的整个结构(容器)的指针:

struct person *the_person; 
the_person = container_of(age_ptr, struct person, age); 

container_of考虑了结构开始处的年龄偏移,以获取正确的指针位置。如果从指针age_ptr中减去字段年龄的偏移量,则将获得正确的位置。这是宏的最后一行:

(type *)( (char *)__mptr - offsetof(type,member) ); 

将其应用到一个真实的示例中,将得到以下结果:

struct family { 
    struct person *father; 
    struct person *mother; 
    int number_of_sons; 
    int family_id; 
} f; 

/*   
 * Fill and initialise f somewhere   */      [...]

 /* 
  * pointer to a field of the structure 
  * (could be any (non-pointer) member in the structure) 
  */ 
   int *fam_id_ptr = &f.family_id; 
   struct family *fam_ptr; 

   /* now let us retrieve back its family */ 
   fam_ptr = container_of(fam_id_ptr, struct family, family_id); 

container_of宏主要用于内核中的通用容器。

这就是内核中的container_of宏。


2

一点真实的背景说得更清楚一些,下面以红黑树为例,这就是我的理解方式container_of

作为Documentation/rbtree.txt状态,在linux内核代码中,它不是rb_node包含数据输入,而是

rbtree树中的数据节点是包含struct rb_node成员的结构。

struct vm_area_struct(在file中include/linux/mm_types.h:284)就是这样的结构,

在同一文件中,有一个宏rb_entry定义为

#define rb_entry(ptr, type, member) container_of(ptr, type, member)

显然,rb_entry与相同container_of

mm/mmap.c:299内部函数定义中browse_rb,有以下用途rb_entry

static int browse_rb(struct mm_struct *mm)
{
    /* two line code not matter */
    struct rb_node *nd, *pn = NULL; /*nd, first arg, i.e. ptr. */
    unsigned long prev = 0, pend = 0;

    for (nd = rb_first(root); nd; nd = rb_next(nd)) {
        struct vm_area_struct *vma;
        vma = rb_entry(nd, struct vm_area_struct, vm_rb);   
        /* -- usage of rb_entry (equivalent to container_of) */
        /* more code not matter here */

现在很明显container_of(ptr, type, member)

  • type 是容器结构,在这里 struct vm_area_struct
  • membertype实例成员的名称,在这里vm_rb,类型为rb_node
  • ptr是指向指针member的的type情况下,在这里rb_node *nd

什么container_of做的是,在这个例子中,

  • 给定obj.memberobj.vm_rb的地址),返回的地址obj
  • 由于结构是连续的存储器的块,的地址obj.vm_rb减去 offset between the struct and member将成为容器的地址。

include/linux/kernel.h:858 -的定义 container_of

include/linux/rbtree.h:51 -的定义 rb_entry

mm/mmap.c:299 -使用 rb_entry

include/linux/mm_types.h:284 - struct vm_area_struct

Documentation/rbtree.txt: -红黑树文件

include/linux/rbtree.h:36 -的定义 struct rb_node

聚苯乙烯

以上文件是当前开发版本,即4.13.0-rc7

file:k的第k条平均线file



0

下面是Container _of宏的最简单实现,它减少了类型和工作的所有复杂检查

#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
#define container_of(ptr, type, member) ((type *)((char *)(ptr) - offsetof(type, member))) 

ptr将给出成员的地址,并减去偏移量差,您将获得起始地址。

用法示例

struct sample {
    int mem1;
    char mem2;
    int mem3;
};
int main(void)
{

struct sample sample1;

printf("Address of Structure sample1 (Normal Method) = %p\n", &sample1);
printf("Address of Structure sample1 (container_of Method) = %p\n", 
                        container_of(&sample1.mem3, struct sample, mem3));

return 0;
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.