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

 

1. 概述
   由于在C语言中没有函数重载,解决不定数目函数参数问题变得比较麻烦;即使采用C++,如果参数个数不能确定,也很难采用函数重载.对这种情况,有些人采用指针参数来解决问题.下面就c语言中处理不定参数数目的问题进行讨论.
2. 定义
   大家先看几宏.
   在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 )                            // 将指针置为无效
   如果对以上几个宏定义不理解,可以略过,接这看后面的内容.
3. 参数在堆栈中分布,位置
   在进程中,堆栈地址是从高到低分配的.当执行一个函数的时候,将参数列表入栈,压入堆栈的高地址部分,然后入栈函数的返回地址,接着入栈函数的执行代码,这个入栈过程,堆栈地址不断递减,一些黑客就是在堆栈中修改函数返回地址,执行自己的代码来达到执行自己插入的代码段的目的.
   总之,函数在堆栈中的分布情况是:地址从高到低,依次是:函数参数列表,函数返回地址,函数执行代码段.
   堆栈中,各个函数的分布情况是倒序的.即最后一个参数在列表中地址最高部分,第一个参数在列表地址的最低部分.参数在堆栈中的分布情况如下:
   最后一个参数
   倒数第二个参数
   ...
   第一个参数
   函数返回地址
   函数代码段
4. 示例代码
   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); 
   }
5. 代码说明:
   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;
   总结:读取可变参数的过程其实就是堆栈中,使用指针,遍历堆栈段中的参数列表,从低地址到高地址一个一个地把参数内容读出来的过程.

6. 在编程中应该注意的问题和解决办法
   虽然可以通过在堆栈中遍历参数列表来读出所有的可变参数,但是由于不知道可变参数有多少个,什么时候应该结束遍历,如果在堆栈中遍历太多,那么很可能读取一些无效的数据.
   解决办法: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;
  }
 }
}

 

 

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是最后一个确定的参数    (开始解析。args指向msg后面的参数,注意理解这句话的含义，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; 
} 

 

来源：

http://www.cppblog.com/qiujian5628/archive/2008/01/21/41562.html

 

 

-----------------------------------------------------------------------------------------------------------------

在C/C++函数中使用可变参数 
作者转自：http://foggy-elves.blog.sohu.com/
　　下面介绍在C/C++里面使用的可变参数函数。
　　先说明可变参数是什么，先回顾一下C++里面的函数重载，如果重复给出如下声明：
　　int func();
　　int func(int);
　　int func(float);
　　int func(int, int);
　　...
　　这样在调用相同的函数名 func 的时候，编译器会自动识别入参列表的格式，从而调用相对应的函数体。
　　但这样的方法毕竟有限，试想一下我们假如想定义一个函数，我们在调用之前(在运行期之前)根本不知道我到底要调用几个参数，并且不知道这些参数是个什么类型，例如我们想定义一个函数：
　　int max(int n, ...);
　　用来返回一串随意长度输入参数的最大值，例如调用
　　max(3, 10, 20, 30)的时候，可以返回(n=3)个数 10,20,30 的最大值30。
　　并且还可以接受任意个参数的输入，例如：
　　max(6, 20, 40, 10, 50, 30, 40)也应该是被接受的，返回最大值50。
　　这怎么达到呢？
　　其实这样的例子我们肯定见过，最典型的就是 printf 函数，可以看 printf 函数的原形：
　　int printf(char*, ...);
　　它接受一个格式字符串，并且后面跟随任意指定的参数，根据实际需要而确定入参的个数。
　　实际上它的实现要依赖于一个标准 C 库 <stdarg.h>，stdandard argument(标准参数) 的意思。下面先稍为介绍一下 <stdarg.h>，或者在 C++ 中的 <cstdarg> 的功效：
　　这实际上是一组初始化和调用可变参数的宏，下面先介绍一下可变参数表的调用形式以及原理：
　　首先是参数的内存存放格式：参数存放在内存的堆栈段中，在执行函数的时候，从最后一个开始入栈。因此栈底高地址，栈顶低地址，举个例子如下：
　　void func(int x, float y, char z);
　　那么，调用函数的时候，实参 char z 先进栈，然后是 float y，最后是 int x，因此在内存中变量的存放次序是 x->y->z，因此，从理论上说，我们只要探测到任意一个变量的地址，并且知道其他变量的类型，通过指针移位运算，则总可以顺藤摸瓜找到其他的输入变量。
　　然后是可变入参表格式，省略的参数用 ... 代替，但必须注意：
1. 只能有一个 ... 并且它必须是最后一个参数；
2. 不要只用一个 ... 作为所有的参数，因为从后面可以知道，这样你无法确定入参表的地址。
　　举个例子，声明函数如下：
　　void func(int x, int y, ...);
　　然后调用：func(3, 5, 'c', 2.1f, 6);
　　于是在调用参数的时候，编译器则不会检查实际输入的是什么参数，只管把所有参数按照上面描述的方法，变成实参堆放在内存中，在本例中，内存中依次存放 x=3, y=5, 'c', 2.1f, 6
　　但是有一个需要注意的地方，这些东西只是紧挨着堆放在内存中，于是想要正确调用这些参数，必须知道他们确切的类型，并且我们也关心这个参数表实际的长度，然而不幸的是，这些我们无从得知。因此，这个解决办法决不是高明的，从某种程度上说，这甚至是一个严重的漏洞。因此，C++ 很不提倡去使用它。
　　不过缺点归缺点，万不得已的时候我们还是得用，但是我们对里面输入变量的时候，应该对入参的类型有一个清醒的认识，否则这样的操作是很危险的。
　　下面是 <stdarg.h> 对上面这一个思路的实现，里面重要的几个宏定义如下：
　　typedef char* va_list;
　　void va_start ( va_list ap, prev_param ); /* ANSI version */
　　type va_arg ( va_list ap, type ); 
　　void va_end ( va_list ap ); 
　　其中，va_list 是一个字符指针，可以理解为指向当前参数的一个指针，取参必须通过这个指针进行。
<Step 1> 在调用参数表之前，应该定义一个 va_list 类型的变量，以供后用(下面假设这个 va_list 类型变量被定义为ap)；
<Step 2> 然后应该对 ap 进行初始化，让它指向可变参数表里面的第一个参数，这是通过 va_start 来实现的，第一个参数是 ap 本身，第二个参数是在变参表前面紧挨着的一个变量；
<Step 3> 然后是获取参数，调用 va_arg，它的第一个参数是 ap，第二个参数是要获取的参数的指定类型，然后返回这个指定类型的值，并且把 ap 的位置指向变参表的下一个变量位置；
<Step 4> 获取所有的参数之后，我们有必要将这个 ap 指针关掉，以免发生危险，方法是调用 va_end，他是输入的参数 ap 置为 NULL，应该养成获取完参数表之后关闭指针的习惯。
　　例如开始的例子 int max(int n, ...); 其函数内部应该如此实现：
int max(int n, ...) {                   // 定参 n 表示后面变参数量，定界用，输入时切勿搞错
  va_list ap;                            // 定义一个 va_list 指针来访问参数表
  va_start(ap, n);                       // 初始化 ap，让它指向第一个变参
  int maximum = -0x7FFFFFFF;            // 这是一个最小的整数
  int temp;
  for(int i = 0; i < n; i++) {
    temp = va_arg(ap, int);             // 获取一个 int 型参数，并且 ap 指向下一个参数
    if(maximum < temp) maximum = temp;
  }
  va_end(ap);                            // 善后工作，关闭 ap
  return max;
}
// 在主函数中测试 max 函数的行为(C++ 格式)
int main() {
  cout << max(3, 10, 20, 30) << endl;
  cout << max(6, 20, 40, 10, 50, 30, 40) << endl;
}
　　基本用法阐述至此，可以看到，这个方法存在两处极严重的漏洞：其一，输入参数的类型随意性，使得参数很容易以一个不正确的类型获取一个值(譬如输入一个float，却以int型去获取他)，这样做会出现莫名其妙的运行结果；其二，变参表的大小并不能在运行时获取，这样就存在一个访问越界的可能性，导致后果严重的 RUNTIME ERROR。
　　另外，<stdarg.h> 的内部实现形式在这处不再加说明，如果有需要可以参考下面的两个连接(感谢他们的作者)。
　　http://www.cndw.com/tech/program/2006051065821.asp
　　http://blog.youkuaiyun.com/wzwind/archive/2007/06/26/1666518.aspx
　　作为建议，在 C++ 环境中尽量不要使用这种方法，如有需要，尽量先考虑使用类或者重载来代替，这样可以很好地弥补这种方法的漏洞。

 

来源：

http://blog.youkuaiyun.com/wenzuodan/archive/2008/01/31/2075220.aspx