[原创]CONTAINING_RECORD IN EFI

peterhu

CONTAINING_RECORD IN EFI

+ G+ _9 t4 n& |4 g& f
EFI BIOS几乎全部用C完成，它几乎将C语言的各种技巧发挥到了极致。C的精髓泰半是指针，另外宏也是非常值得称道的。程序员对于宏的评价可谓褒贬不一，有人说它是万恶之源，有人则赞其为一把利刃。我个人觉得运用之妙，存乎一心，宏不是万能的，但是有一些场合使用宏确实可以大大的提高程序的可读性，有些跨平台的特性离开了宏还真是不行。_CR是EFI之中经常会被用的宏，我们来看看它的庐山真面目吧：

//

* q& L9 `) y* z# }: F) _; K

//
CONTAINING_RECORD - returns a pointer to the structure

% j. w' h, E+ r* X: R  [

//
from one of it's elements.

3 N' T! u& [# @! F( A, m

//

+ l8 ~2 R0 l/ a#define _CR(Record, TYPE, Field)
((TYPE *) ((CHAR8 *) (Record) - (CHAR8 *) &(((TYPE *) 0)->Field)))
这个宏的作用是根据一个结构体成员变量的的地址获得该结构体基地址。举例如下：
struct _Test
/ }: m( Z8 j. [  E7 h: Y{
5 p$ g3 X( x. nCHAR8 t0;

UINT16 t1;

- c5 F# R4 ]. a$ l( c) bUINT8   t2;

) w; M% T$ O# \& a# KUINT32  t3;
};
4 {& O! s& n; g. j6 T
我们在某一个地方获得了t2的地址t2Ptr，这时如果要得到t2所在结构体的基地址就可以这样做：struct _Test* bPtr = _CR(t2Ptr,struct _Test,t2);预处理展开之后就是这副样子 struct _Test* bPtr = ((struct _Test*)((CHAR8*)(t2Ptr)-(CHAR8*)&((struct _Test *)0)->t2)，其实我觉得关键的部分在这句“(TYPE *) 0)->Field”，它其实就是获得该成员在结构体中的偏移位置（offset），该成员变量的地址减去它在结构体中的偏移也就获得了基地址了。

2 i0 n, ?' U, ~: [7 E
) C8 V& b) P: s' S) [一图胜千言，如上图所示，假设t2的地址是0x1005,那么bPtr应该是多少呢？我们只要用t2-t2的offset（0x03）即可，也就是0x1002。是不是很简单?

大概是英雄所见略同吧，这种形式的宏在Linux kernel 和 Windows Kernel中也都有存在，只不过名字叫的不一样罢了。先看看Linux下长的什么样子吧：

/**

+ b  I6 G  p6 ?* R' W  j

$ x3 b1 o8 e! T6 r" ]5 G+ R; C* container_of - cast a member of a structure out to the containing structure

+ R0 M$ m5 w  {5 [! b! {8 z

*

+ m, d# j$ a) z0 w3 ]

* @ptr:
: W2 @8 g0 W+ w6 g0 X5 N& Zthe pointer to the member.

4 n- Z6 a3 S- G9 r* @type:
the type of the container struct this is embedded in.

  a' i% C8 G. v! n  A  ]) E

$ K1 n  E( Q" D# |. m7 ~  [; ~; k. W  R* @member:
; ^. J8 R* V. q& Ythe name of the member within the struct.

*

*/

% r! v. E+ a. U& z* m' l* X2 G! D#define
; Z1 ?! c9 \# `" n5 X; S; ?container_of(ptr, type, member) ({
  |* g) Q5 i# z' M8 Y5 X\

const typeof( ((type *)0)->member ) *__mptr = (ptr);
\
5 j/ d/ T' r0 ^( s6 ?; v
(type *)( (char *)__mptr - offsetof(type,member) );})
! f, w3 ?) N# _2 l8 z3 p
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)

再来看看它在Windows Kernel中的小模样J:
3 n; a' t) K' I! k2 d+ ^$ A#define
CONTAININT_RECORD(address, type, field) \
             ((type*)((PCHAR)(address) - (PCHAR)(&((type*)0)->field)))
0 |2 w9 v  m' `9 t  H! B- I* B他们的作用都是一样的，是不是有点天下文章一大抄的感觉啊,呵呵…
& r* j! r2 h2 ~3 H


5 u. j( C) o+ J+ I9 W$ p+ u' {Peter

2009-10-6

bellid

顺楼主者昌,逆楼主者亡.

adward

象这样的宏挺绕人的，但又经常会碰到。
楼主将其重点突出，从而问题变得很直接很明了了。。顶一个哈

xxxxxxxx

崇拜中。。。。。。。