va_list、va_start、va_arg、va_end的原理与使用

1. 概述
   由于在C语言中没有函数重载,解决不定数目函数参数问题变得比较麻烦;即使采用C++,如果参数个数不能确定,也很难采用函数重载.对这种情况,有些人采用指针参数来解决问题.下面就c语言中处理不定参数数目的问题进行讨论.

2. VA_LIST 是在C语言中解决变参问题的一组宏

   他有这么几个成员：

   1） va_list型变量：

   #ifdef  _M_ALPHA
   typedef struct {
           char *a0;       /* pointer to first homed integer argument */
           int offset;     /* byte offset of next parameter */
   } va_list;
   #else
   typedef char *  va_list;
   #endif

   2）_INTSIZEOF 宏，获取类型占用的空间长度，最小占用长度为int的整数倍：

   #define _INTSIZEOF(n)   ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )

   3）VA_START宏，获取可变参数列表的第一个参数的地址（ap是类型为va_list的指针，v是可变参数最左边的参数）：

   #define va_start(ap,v)  ( ap = (va_list)&v + _INTSIZEOF(v) )

   4）VA_ARG宏，获取可变参数的当前参数，返回指定类型并将指针指向下一参数（t参数描述了当前参数的类型）：

   #define va_arg(ap,t)    ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )

   5）VA_END宏，清空va_list可变参数列表：

   #define va_end(ap)      ( ap = (va_list)0 )

   VA_LIST的用法：      
          （1）首先在函数里定义一具VA_LIST型的变量，这个变量是指向参数的指针；
          （2）然后用VA_START宏初始化变量刚定义的VA_LIST变量；
          （3）然后用VA_ARG返回可变的参数，VA_ARG的第二个参数是你要返回的参数的类型（如果函数有多个可变参数的，依次调用VA_ARG获取各个参数）；
          （4）最后用VA_END宏结束可变参数的获取。
   使用VA_LIST应该注意的问题：
      （1）可变参数的类型和个数完全由程序代码控制,它并不能智能地识别不同参数的个数和类型；
      （2）如果我们不需要一一详解每个参数，只需要将可变列表拷贝至某个缓冲，可用vsprintf函数；
      （3）因为编译器对可变参数的函数的原型检查不够严格,对编程查错不利.不利于我们写出高质量的代码；

   小结：可变参数的函数原理其实很简单，而VA系列是以宏定义来定义的，实现跟堆栈相关。我们写一个可变参数的C函数时，有利也有弊,所 以在不必要的场合，我们无需用到可变参数，如果在C++里，我们应该利用C++多态性来实现可变参数的功能，尽量避免用C语言的方式来实现。

   
   
3. 定义
   大家先看几宏.
   在VC++6.0的include有一个stdarg.h头文件,有如下几个宏定义:
   #define _INTSIZEOF(n)   ((sizeof(n)+sizeof(int)-1)&~(sizeof(int) - 1) ) 
   #define va_start(ap,v) ( ap = (va_list)&v + _INTSIZEOF(v) )           //第一个可选参数地址
   #define va_arg(ap,t) ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) ) //下一个参数地址
   #define va_end(ap)    ( ap = (va_list)0 )                            // 将指针置为无效
   如果对以上几个宏定义不理解,可以略过,接这看后面的内容.
4. 参数在堆栈中分布,位置
   在进程中,堆栈地址是从高到低分配的.当执行一个函数的时候,将参数列表入栈,压入堆栈的高地址部分,然后入栈函数的返回地址,接着入栈函数的执行代码,这个入栈过程,堆栈地址不断递减,一些黑客就是在堆栈中修改函数返回地址,执行自己的代码来达到执行自己插入的代码段的目的.
   总之,函数在堆栈中的分布情况是:地址从高到低,依次是:函数参数列表,函数返回地址,函数执行代码段.
   堆栈中,各个函数的分布情况是倒序的.即最后一个参数在列表中地址最高部分,第一个参数在列表地址的最低部分.参数在堆栈中的分布情况如下:
   最后一个参数
   倒数第二个参数
   ...
   第一个参数
   函数返回地址
   函数代码段
5. 示例代码
   void arg_test(int i, ...);
   int main(int argc,char *argv[]) 
   {
    int int_size = _INTSIZEOF(int);
    printf("int_size=%d\n", int_size);
    arg_test(0, 4);
    
    arg_cnt(4,1,2,3,4);
    return 0;
   }
   void arg_test(int i, ...)
   {
    int j=0; 
    va_list arg_ptr; 
    
    va_start(arg_ptr, i); 
    printf("&i = %p\n", &i);//打印参数i在堆栈中的地址
    printf("arg_ptr = %p\n", arg_ptr);
    //打印va_start之后arg_ptr地址,
    //应该比参数i的地址高sizeof(int)个字节
    //这时arg_ptr指向下一个参数的地址
    
    j=*((int *)arg_ptr);
    printf("%d %d\n", i, j); 
    j=va_arg(arg_ptr, int); 
    printf("arg_ptr = %p\n", arg_ptr);
    //打印va_arg后arg_ptr的地址
    //应该比调用va_arg前高sizeof(int)个字节
    //这时arg_ptr指向下一个参数的地址
    va_end(arg_ptr); 
    printf("%d %d\n", i, j); 
   }
   
   
6. 代码说明:
   int int_size = _INTSIZEOF(int);得到int类型所占字节数
    va_start(arg_ptr, i); 得到第一个可变参数地址,

   根据定义(va_list)&v得到起始参数的地址, 再加上_INTSIZEOF(v) ,就是其实参数下一个参数的地址,即第一个可变参数地址.
   j=va_arg(arg_ptr, int); 得到第一个参参数的值,并且arg_ptr指针上移一个_INTSIZEOF(int),即指向下一个可变参数的地址.
   va_end(arg_ptr);置空arg_ptr,即arg_ptr=0;
   总结:读取可变参数的过程其实就是堆栈中,使用指针,遍历堆栈段中的参数列表,从低地址到高地址一个一个地把参数内容读出来的过程.
   

7. 在编程中应该注意的问题和解决办法
   虽然可以通过在堆栈中遍历参数列表来读出所有的可变参数,但是由于不知道可变参数有多少个,什么时候应该结束遍历,如果在堆栈中遍历太多,那么很可能读取一些无效的数据.
   解决办法:a.可以在第一个起始参数中指定参数个数,那么就可以在循环还中读取所有的可变参数;b.定义一个结束标记,在调用函数的时候,在最后一个参数中传递这个标记,这样在遍历可变参数的时候,可以根据这个标记结束可变参数的遍历;
   下面是一段示例代码:
   //第一个参数定义可选参数个数,用于循环取初参数内容
   void arg_cnt(int cnt, ...);
   int main(int argc,char *argv[]) 
   {
    int int_size = _INTSIZEOF(int);
    printf("int_size=%d\n", int_size);
    arg_cnt(4,1,2,3,4);
    return 0;
   }
   void arg_cnt(int cnt, ...)
   {
    int value=0; 
    int i=0;
    int arg_cnt=cnt; 
    va_list arg_ptr; 
    va_start(arg_ptr, cnt); 
    for(i = 0; i < cnt; i++)
    {
     value = va_arg(arg_ptr,int);
     printf("value%d=%d\n", i+1, value);
    }
   }
   
   虽然可以根据上面两个办法解决读取参数个数的问题,但是如果参数类型都是不定的,该怎么办,如果不知道参数的类型,即使读到了参数也没有办法进行处理.解决办法:可以自定义一些可能出现的参数类型,这样在可变参数列表中,可以可变参数列表中的那类型,然后根据类型,读取可变参数值,并进行准确地转换.传递参数的时候可以这样传递:参数数目,可变参数类型1,可变参数值1,可变参数类型2,可变参数值2,....
   这里给出一个完整的例子:
   #include <stdio.h>
   #include <stdarg.h>
   const int INT_TYPE  = 100000;
   const int STR_TYPE  = 100001;
   const int CHAR_TYPE  = 100002;
   const int LONG_TYPE  = 100003;
   const int FLOAT_TYPE = 100004;
   const int DOUBLE_TYPE = 100005;
   //第一个参数定义可选参数个数,用于循环取初参数内容
   //可变参数采用arg_type,arg_value...的形式传递,以处理不同的可变参数类型
   void arg_type(int cnt, ...);
   //第一个参数定义可选参数个数,用于循环取初参数内容
   void arg_cnt(int cnt, ...);
   //测试va_start,va_arg的使用方法,函数参数在堆栈中的地址分布情况
   void arg_test(int i, ...);
   int main(int argc,char *argv[]) 
   {
    int int_size = _INTSIZEOF(int);
    printf("int_size=%d\n", int_size);
    arg_test(0, 4);
    
    arg_cnt(4,1,2,3,4);
    arg_type(2, INT_TYPE, 222, STR_TYPE, "ok,hello world!");
    return 0;
   }

void arg_test(int i, ...)
{
 int j=0; 
 va_list arg_ptr; 
 
 va_start(arg_ptr, i); 
 printf("&i = %p\n", &i);//打印参数i在堆栈中的地址
 printf("arg_ptr = %p\n", arg_ptr);
 //打印va_start之后arg_ptr地址,
 //应该比参数i的地址高sizeof(int)个字节
 //这时arg_ptr指向下一个参数的地址
 
 j=*((int *)arg_ptr);
 printf("%d %d\n", i, j); 
 j=va_arg(arg_ptr, int); 
 printf("arg_ptr = %p\n", arg_ptr);
 //打印va_arg后arg_ptr的地址
 //应该比调用va_arg前高sizeof(int)个字节
 //这时arg_ptr指向下一个参数的地址
 va_end(arg_ptr); 
 printf("%d %d\n", i, j); 
}
void arg_cnt(int cnt, ...)
{
 int value=0; 
 int i=0;
 int arg_cnt=cnt; 
 va_list arg_ptr; 
 va_start(arg_ptr, cnt); 
 for(i = 0; i < cnt; i++)
 {
  value = va_arg(arg_ptr,int);
  printf("value%d=%d\n", i+1, value);
 }
}
void arg_type(int cnt, ...)
{
 int arg_type = 0;
 int int_value=0; 
 int i=0;
 int arg_cnt=cnt; 
 char *str_value = NULL;
 va_list arg_ptr; 
 va_start(arg_ptr, cnt); 
 for(i = 0; i < cnt; i++)
 {
  arg_type = va_arg(arg_ptr,int);
  switch(arg_type)
  {
  case INT_TYPE:
   int_value = va_arg(arg_ptr,int);
   printf("value%d=%d\n", i+1, int_value);
   break;
  case STR_TYPE:
   str_value = va_arg(arg_ptr,char*);
   printf("value%d=%d\n", i+1, str_value);
   break;
  default:
   break;
  }
 }
}
以上是我个人的见解,不对的地方希望大家指正,发表看法,我不胜感谢!!!

posted on 2008-01-21 15:30 浪迹天涯 阅读(33070) 评论(12)  编辑 收藏 引用 所属分类: C++

评论

# re: va_list、va_start、va_arg、va_end的原理与使用 2008-01-21 15:30 浪迹天涯

va_start() va_end()函数应用 

1:当无法列出传递函数的所有实参的类型和数目时,可用省略号指定参数表 
void foo(...); 
void foo(parm_list,...); 

2:函数参数的传递原理 
函数参数是以数据结构:栈的形式存取,从右至左入栈.eg: 
#include <iostream> 
void fun(int a, ...) 
{ 
int *temp = &a; 
temp++; 
for (int i = 0; i < a; ++i) 
{ 
cout << *temp << endl; 
temp++; 
} 
} 

int main() 
{ 
int a = 1; 
int b = 2; 
int c = 3; 
int d = 4; 
fun(4, a, b, c, d); 
system("pause"); 
return 0; 
} 
Output:: 
1 
2 
3 
4 

3:获取省略号指定的参数 
在函数体中声明一个va_list，然后用va_start函数来获取参数列表中的参数，使用完毕后调用va_end()结束。像这段代码： 
void TestFun(char* pszDest, int DestLen, const char* pszFormat, ...) 
{ 
va_list args; 
va_start(args, pszFormat); 
_vsnprintf(pszDest, DestLen, pszFormat, args); 
va_end(args); 
} 

4.va_start使argp指向第一个可选参数。va_arg返回参数列表中的当前参数并使argp指向参数列表中的下一个参数。va_end把argp指针清为NULL。函数体内可以多次遍历这些参数，但是都必须以va_start开始，并以va_end结尾。 

　　1).演示如何使用参数个数可变的函数，采用ANSI标准形式 
　　#include 〈stdio.h〉 
　　#include 〈string.h〉 
　　#include 〈stdarg.h〉 
　　/*函数原型声明，至少需要一个确定的参数，注意括号内的省略号*/ 
　　int demo( char, ... ); 
　　void main( void ) 
　　{ 
　　 demo("DEMO", "This", "is", "a", "demo!", ""); 
　　} 
　　/*ANSI标准形式的声明方式，括号内的省略号表示可选参数*/ 
　　int demo( char msg, ... ) 
　　{ 
/*定义保存函数参数的结构*/ 
　　 va_list argp; 
　　 int argno = 0; 
　　 char para; 

　　 /*argp指向传入的第一个可选参数，msg是最后一个确定的参数*/ 
　　 va_start( argp, msg ); 
　　 while (1) 
{ 
　　 para = va_arg( argp, char); 
　　 if ( strcmp( para, "") == 0 ) 
break; 
　　 printf("Parameter #%d is: %s\n", argno, para); 
　　 argno++; 
　　 } 
　　 va_end( argp ); 
　　 /*将argp置为NULL*/ 
　　　return 0; 
　　} 

2)//示例代码1：可变参数函数的使用 
#include "stdio.h" 
#include "stdarg.h" 
void simple_va_fun(int start, ...) 
{ 
va_list arg_ptr; 
int nArgValue =start; 
int nArgCout=0; //可变参数的数目 
va_start(arg_ptr,start); //以固定参数的地址为起点确定变参的内存起始地址。 
do 
{ 
++nArgCout; 
printf("the %d th arg: %d\n",nArgCout,nArgValue); //输出各参数的值 
nArgValue = va_arg(arg_ptr,int); //得到下一个可变参数的值 
} while(nArgValue != -1); 
return; 
} 
int main(int argc, char* argv[]) 
{ 
simple_va_fun(100,-1); 
simple_va_fun(100,200,-1); 
return 0; 
} 

3)//示例代码2:扩展——自己实现简单的可变参数的函数。 
下面是一个简单的printf函数的实现，参考了<The C Programming Language>中的例子 
#include "stdio.h" 
#include "stdlib.h" 
void myprintf(char* fmt, ...) //一个简单的类似于printf的实现，//参数必须都是int 类型 
{ 
char* pArg=NULL; //等价于原来的va_list 
char c; 

pArg = (char*) &fmt; //注意不要写成p = fmt !!因为这里要对//参数取址，而不是取值 
pArg += sizeof(fmt); //等价于原来的va_start 

do 
{ 
c =*fmt; 
if (c != '%') 
{ 
putchar(c); //照原样输出字符 
} 
else 
{ 
//按格式字符输出数据 
switch(*++fmt) 
{ 
case'd': 
printf("%d",*((int*)pArg)); 
break; 
case'x': 
printf("%#x",*((int*)pArg)); 
break; 
default: 
break; 
} 
pArg += sizeof(int); //等价于原来的va_arg 
} 
++fmt; 
}while (*fmt != '\0'); 
pArg = NULL; //等价于va_end 
return; 
} 
int main(int argc, char* argv[]) 
{ 
int i = 1234; 
int j = 5678; 

myprintf("the first test:i=%d\n",i,j); 
myprintf("the secend test:i=%d; %x;j=%d;\n",i,0xabcd,j); 
system("pause"); 
return 0; 
} 
  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2009-05-14 08:05 ForE

多谢! 
描述上有点问题 
----------------------- 
堆栈中,各个函数的分布情况是倒序的.即最后一个参数在列表中地址最高部分,第一个参数在列表地址的最低部分.参数在堆栈中的分布情况如下: 
最后一个参数 
倒数第二个参数 
... 
第一个参数 
函数返回地址 
函数代码段 
--------------------- 
stdcall才是这种情况... 
  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2009-06-09 13:53 code c

经典！！！  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2009-06-09 14:07 code c

int demo( char msg, ... ) 
这个函数有个小问题（应该是char *，而不是char ），应改为： 
/*ANSI标准形式的声明方式，括号内的省略号表示可选参数*/ 
int demo(char* msg, ...) 
{ 
/*定义保存函数参数的结构*/ 
va_list argp; 
int argno = 0; 
char* para; 

/*argp指向传入的第一个可选参数，msg是最后一个确定的参数*/ 
va_start(argp, msg); 
while (1) 
{ 
para = va_arg(argp, char*); 
if (strcmp(para, "") == 0) 
break; 
printf("Parameter #%d is: %s\n", argno, para); 
argno++; 
} 
va_end(argp); 
/*将argp置为NULL*/ 
return 0; 
} 
  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2010-02-08 21:05 chhaya

好！  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2010-04-15 11:29 某某

谢谢分享，很详细 
也是，参数压栈顺序好像有两种啊  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2010-05-14 17:43 Delacroix

函数的代码段是不放在堆栈里的。所有的执行代码都是放在统一的代码段里的。  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2010-07-01 16:09 suohd

@Delacroix
这点我同意。  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2010-07-08 13:39 leobupt

@code c
demo()函数有几处错误，修改如下：

int demo( char *msg, ... )
{
/*定义保存函数参数的结构*/
va_list argp;
int argno = 0;
char *para; //char para;

/*argp指向传入的第一个可选参数，msg是最后一个确定的参数*/
va_start( argp, msg );
while (1)
{
para = va_arg( argp, char*);//para = va_arg( argp, char);
if (strcmp(para, "") == 0 )
break;
printf("Parameter #%d is: %s\n", argno, para);
argno++;
}
va_end(argp);
//va_end( argp ); 　　 
/*将argp置为NULL*/
return 0;
}   回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2011-03-08 16:35 cxm240

最后一个参数
倒数第二个参数
...
第一个参数
函数返回地址
函数代码段 


最后压栈的不是函数代码段，而是该函数的栈帧ebp  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用[未登录] 2011-03-25 08:34 liu

TC中typedef void *va_list; 为什么不能用*va_list代替void  回复  更多评论   

# re: va_list、va_start、va_arg、va_end的原理与使用 2012-02-01 09:50 liny

楼主讲的很详细， 懂了， 谢谢...  回复  更多评论