[原创]VA_ARG IN EFI

peterhu

VA_ARG IN EFI

1. Introduction

可变参数其实是标准C语言一个内建的功能，它和EFI本身并没有太多关系。但是它在EDK中有重新实现和使用，而且我们家的code base使用频繁，很多oem callback都使用了可变参数以此获得函数格式的统一以及参数传递的灵活性。所以我就提一下可变参数的实现，希望对Legacy BIOS转过来的以及对C不是很熟悉的朋友有所帮助。

2. Function Call Impl
  W& w1 x5 _, q/ q9 f4 }
要想搞明白可变参数的实现，那就肯定不能不提C的运行所必需的一个核心部件stack。离开了stack，C是没法活J，这也是为什么EFI code 只能99%而无法100%用C实现的其中一个原因（sec阶段需要准备好stack然后才可以交棒给C的code）。先看一看函数调用过程中stack的变化状况：

void testq(int a,int b)

{

     int tmp;

0 V! X! C1 ~% K- }: ka = a;

b = b;

  Q' A+ {8 V6 j! atestr();

}

void testp(void)

{

testq(1,2);

}

testp调用testq，这时stack的状况如下图1所示
4 U$ E( P2 R4 `4 ~2 }0 m# f$ p
4 y9 ?' s" c9 m6 z' ]3 T% K
5 L/ r3 h1 `9 D/ L
/ X2 Z. }8 s3 |* Q: u, a通常情况下stack由高地址向低地址增长，压进去一个参数esp就会减小，弹出当然就会增加而且通常会以机器字对齐。一个函数保存局部变量以及调用下一级函数所需要的stack空间被称作一个frame。如上图1所示以ebp所指向的地址为界，ebp上方的为一个frame，下方包括保存的testp的ebp为另一个frame。ebp的存在也方便了函数参数，和局部变量的存取。ebp+n即可取出参数，ebp-n取出局部变量。函数调用参数进栈的顺序与平台和编译器有关，但通常都是从右向左进栈，所以testp会将b先进栈，然后是a接下来保存返回地址(从testq返回时继续执行的位置)。了解了这些知识，就足以揭开可变参数的面纱了，下面就来看看可变参数的实现。

3. VA_START, VA_ARG,VA_END
7 r( Q/ m5 }. {0 p0 ^2 }8 V
) l5 i& n! v8 k  J' k# I8 H- q  t# q
这三个宏就是可变参数的所有秘密所在了，所有的代码一共不超过十行，可是如果不清楚前面所提到到stack的布局，想搞明白这几行代码也不是很容易哦。翠花上codeJ，edk中的实现如下所示：

#define _EFI_INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))

//

// Also support coding convention rules for var arg macros

//

#ifndef VA_START

typedef CHAR8 *VA_LIST;

#define VA_START(ap, v) (ap = (VA_LIST) & (v) + _EFI_INT_SIZE_OF (v))

#define VA_ARG(ap, t)
(*(t *) ((ap += _EFI_INT_SIZE_OF (t)) - _EFI_INT_SIZE_OF (t)))

#define VA_END(ap)
0 n7 v3 C" w" C) P* ]( u(ap = (VA_LIST) 0)

#endif

用一段测试sample code,演示和讲解一下可变参数的使用和原理
2 e) V, I3 C& u4 Z

void OemCallBack(

+ @. A- n) L0 x/ b* AIN OEMCALLBACK
*this,

4 g  o7 b+ j& d" Y% ~IN UINT32
7 c9 M  e" [1 i( T5 N$ J: _& ?NumOfArgs,

...

+ R9 n& F+ D4 x7 Y)

{

7 N& k& y$ Q7 Z# `5 u& J) GVA_LIST
# r$ n: W: G/ n) HMarker;

4 C& p" \) G0 ?$ G! _UINT32
/ m2 B0 D" }2 U& `5 ATmp;

" F# V% K! G. {/ O# A8 N' CUINT32
) a# g) M2 m; M2 c; H6 LCont;

VA_START (Marker, NumOfArgs);

  for(Cont = 0x00; Cont < NumOfArgs; ++Cont)

{

Tmp = VA_ARG (Marker, UINT32);

printf("The value is :%d,",Tmp);

}

5 X( Q, s: _- s4 c3 V% |% N$ G

* @& y& U3 |! k; x# n. T. cprintf("\n");

VA_END (Marker);

  return EFI_SUCCESS;

}

int main (int argc,char** argv)

{

OemCallBack(NULL,3,5,10,33);

     return 0;

}
先来看调用栈长的什么模样，再来分析实现原理吧，调用栈如下图2所示：
( t, i; \! w: g' H$ ]; A' N: [/ u

VA_START展开以后就是(Marker = (VA_LIST) & (NumOfArgs) + _EFI_INT_SIZE_OF (NumOfArgs))也即求出NumOfArgs之后的参数的地址,图中红色部分，也就是可变参数列的首地址。VA_ARG展开以后就有点意思了：(*(UINT32 *) ((Marker += _EFI_INT_SIZE_OF (UINT32)) - _EFI_INT_SIZE_OF (UINT32)))这里就是defrence出当前Marker指向的地址的t类型的值，并且移动Marker指针为下一轮做准备，这就是“Marker += _EFI_INT_SIZE_OF (UINT32)”奥妙所在。这样逐次移动Marker指针就可以遍历出所有的可变参数了。VA_END就没什么好说的了，防止出现野指针：Marker = (VA_LIST) 0。最后一个_EFI_INT_SIZE_OF它是为了特定平台的内存对齐的需要，因为这个UINTN在不同的平台下大小不同，所以使用这个宏会将内存对齐到一个机器字。关于可变参数还有要特别强调的地方就是：一定要有结束标识，否则程序无法识别参数的个数，OemCallBack中的NumOfArgs就给出了参数的个数,另外就是至少要有一个不变的参数J,否则无法获得可变参数的首地址。

2 U. S3 m! N6 k! h) V/ B- M8 [
; g" Y- y  n. s3 w3 I- n. n以上就是可变参数的所有内容了，希望有人能够从中获得帮助，也不枉我一番辛苦。再写要吐血了，闪！
  I# P: P) P& `, d) k
Peter
2009-10-22

adward

沙发～～～！
VA_ARG在code中是会经常遇到的。。。。
楼主剖析了其基本原理及实现方式，可谓拨云见日，受益不小啊！

/ ?  V0 V; {" j6 X6 K+ P" B0 X& I[ 本帖最后由 adward 于 2009-10-23 15:54 编辑 ]

bellid

谢谢楼主总结此功能

peter_hu

楼主辛苦了！thanks!

Andy1990zx

相当清楚
" n3 z9 k) ^) V, G1 m+ h只是还是不明白_EFI_INT_SIZE_OF这个的作用
  O5 |) f% ~7 |4 ]也就是我看不出来_EFI_INT_SIZE_OF(n)和sizeof(n)的区别
" f6 b& A* G4 p1 ~: k  q8 d# w" G楼主能不能再指教一下?