C语言可变参数处理

VA_LIST 是C语言中解决变长参数问题的一组宏

 

VA_LIST的用法：

（1）首先在函数里定义一个VA_LIST类型的变量，这个变量是指向参数的指针；

（2）然后用VA_START宏初始化刚定义的VA_LIST变量，这个宏的第二个参数是第一个可变参数的前一个参数，是一个固定的参数；

（3）然后用VA_ARG返回可变的参数，VA_ARG的第二个参数是你要返回的参数的类型，如果函数有多个可变参数的，依次调用VA_ARG获取各个参数；

（4）最后用VA_END宏结束可变参数的获取。

 

VA_LIST在编译器中的处理：

 

（1）在运行VA_START(ap,v)以后，ap指向第一个可变参数在堆栈的地址；

（2）VA_ARG()取得类型t的可变参数值，在这步操作中首先apt = sizeof(t类型)，让ap指向下一个参数的地址。然后返回ap-sizeof(t类型)的t类型*指针，这正是第一个可变参数在堆栈里的地址。然后用*取得这个地址的内容；

（3）VA_END(),X86平台定义为ap = ((char*)0)，使ap不再指向堆栈，而是跟NULL一样，有些直接定义为((void*)0)，这样编译器不会为VA_END产生代码，例如gcc在Linux的X86平台就是这样定义的。

 

要注意的是：由于参数的地址用于VA_START宏，所以参数不能声明为寄存器变量、函数或数组类型。

 

使用VA_LIST应该注意的问题：

（1）因为va_start, va_arg, va_end等定义成宏,所以它显得很愚蠢,可变参数的类型和个数完全在该函数中由程序代码控制,它并不能智能地识别不同参数的个数和类型. 也就是说,你想实现智能识别可变参数的话是要通过在自己的程序里作判断来实现的；

（2）另外有一个问题,因为编译器对可变参数的函数的原型检查不够严格,对编程查错不利.不利于我们写出高质量的代码。

 

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

 

func( Type para1, Type para2,Type para3, ... )

{

     /****** Step 1 ******/

     va_list ap;

     va_start( ap, para3 ); //一定要“...”之前的那个参数**ap指向para后的第一个可变参数

    

     /****** Step 2 ******/

      //此时ap指向第一个可变参数

      //调用va_arg取得里面的值

    

     Type xx = va_arg( ap, Type ); 

    

     //Type一定要相同，如:

      //char*p = va_arg( ap, char *);

     //int i = va_arg( ap, int );

      //如果有多个参数继续调用va_arg

     /****** Step 3 ******/

     va_end(ap); //For robust!

}

 

请问:va_list(), va_start()是何意?

 

(一)写一个简单的可变参数的C函数

 

下面我们来探讨如何写一个简单的可变参数的C函数.写可变参数的

C函数要在程序中用到以下这些宏:

void va_start( va_list arg_ptr,prev_param );

 

type va_arg( va_list arg_ptr,type );

 

void va_end( va_list arg_ptr );

va在这里是variable-argument(可变参数)的意思.

这些宏定义在stdarg.h中,所以用到可变参数的程序应该包含这个

头文件.下面我们写一个简单的可变参数的函数,改函数至少有一个整数

参数,第二个参数也是整数,是可选的.函数只是打印这两个参数的值.

void simple_va_fun(int i, ...)

{

va_list arg_ptr;

int j=0;

 

va_start(arg_ptr, i);

j=va_arg(arg_ptr, int);

va_end(arg_ptr);

printf("%d %d\n", i,j);

return;

}

我们可以在我们的头文件中这样声明我们的函数:

extern void simple_va_fun(int i,...);

我们在程序中可以这样调用:

simple_va_fun(100);

simple_va_fun(100,200);

从这个函数的实现可以看到,我们使用可变参数应该有以下步骤:

1)首先在函数里定义一个va_list型的变量，这里是arg_ptr,这个变量是指向参数的指针；

2)然后用va_start宏初始化变量arg_ptr，这个宏的第二个参数是第一个可变参数的前一个参数,是一个固定的参数；

3)然后用va_arg返回可变的参数,并赋值给整数j，va_arg的第二个参数是你要返回的参数的类型，这里是int型；

4)最后用va_end宏结束可变参数的获取，然后你就可以在函数里使用第二个参数了，如果函数有多个可变参数的，依次调用va_arg获取各个参数。

 

如果我们用下面三种方法调用的话，都是合法的，但结果却不一样：

1)simple_va_fun(100);

结果是:100 -123456789(会变的值)

2)simple_va_fun(100,200);

结果是:100 200

3)simple_va_fun(100,200,300);

结果是:100 200

我们看到第一种调用有错误,第二种调用正确,第三种调用尽管结果

正确,但和我们函数最初的设计有冲突.下面一节我们探讨出现这些结果

的原因和可变参数在编译器中是如何处理的.

 

(二)可变参数在编译器中的处理

 

我们知道va_start,va_arg,va_end是在stdarg.h中被定义成宏的,

由于1)硬件平台的不同 2)编译器的不同,所以定义的宏也有所不同,下

面以VC++中stdarg.h里x86平台的宏定义摘录如下(’\’号表示折行):

 

typedef char * va_list;

 

#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 )

 

定义_INTSIZEOF(n)主要是为了某些需要内存的对齐的系统.C语言的函

数是从右向左压入堆栈的,图(1)是函数的参数在堆栈中的分布位置.我

们看到va_list被定义成char*,有一些平台或操作系统定义为void*.再

看va_start的定义,定义为&v+_INTSIZEOF(v),而&v是固定参数在堆栈的

地址,所以我们运行va_start(ap, v)以后,ap指向第一个可变参数在堆

栈的地址,如图:

 

高地址|-----------------------------|

|函数返回地址 |

|-----------------------------|

|....... |

|-----------------------------|

|第n个参数(第一个可变参数) |

|-----------------------------|<--va_start后ap指向

|第n-1个参数(最后一个固定参数)|

低地址|-----------------------------|<--&v

图( 1 )

 

然后,我们用va_arg()取得类型t的可变参数值,以上例为int型为例,我

们看一下va_arg取int型的返回值:

j= ( *(int*)((ap +=_INTSIZEOF(int))-_INTSIZEOF(int)) );

首先ap+=sizeof(int),已经指向下一个参数的地址了.然后返回

ap-sizeof(int)的int*指针,这正是第一个可变参数在堆栈里的地址

(图2).然后用*取得这个地址的内容(参数值)赋给j.

 

高地址|-----------------------------|

|函数返回地址 |

|-----------------------------|

|....... |

|-----------------------------|<--va_arg后ap指向

|第n个参数(第一个可变参数) |

|-----------------------------|<--va_start后ap指向

|第n-1个参数(最后一个固定参数)|

低地址|-----------------------------|<--&v

图( 2 )

 

最后要说的是va_end宏的意思,x86平台定义为ap=(char*)0;使ap不再

指向堆栈,而是跟NULL一样.有些直接定义为((void*)0),这样编译器不

会为va_end产生代码,例如gcc在linux的x86平台就是这样定义的.

在这里大家要注意一个问题:由于参数的地址用于va_start宏,所

以参数不能声明为寄存器变量或作为函数或数组类型.

关于va_start, va_arg, va_end的描述就是这些了,我们要注意的

是不同的操作系统和硬件平台的定义有些不同,但原理却是相似的.

 

(三)可变参数在编程中要注意的问题

 

因为va_start, va_arg, va_end等定义成宏,所以它显得很愚蠢,

可变参数的类型和个数完全在该函数中由程序代码控制,它并不能智能

地识别不同参数的个数和类型.

有人会问:那么printf中不是实现了智能识别参数吗?那是因为函数

printf是从固定参数format字符串来分析出参数的类型,再调用va_arg

的来获取可变参数的.也就是说,你想实现智能识别可变参数的话是要通

过在自己的程序里作判断来实现的.

另外有一个问题,因为编译器对可变参数的函数的原型检查不够严

格,对编程查错不利.如果simple_va_fun()改为:

void simple_va_fun(int i, ...)

{

va_list arg_ptr;

char *s=NULL;

 

va_start(arg_ptr, i);

s=va_arg(arg_ptr, char*);

va_end(arg_ptr);

printf("%d %s\n", i,s);

return;

}

可变参数为char*型,当我们忘记用两个参数来调用该函数时,就会出现

core dump(Unix) 或者页面非法的错误(window平台).但也有可能不出

错,但错误却是难以发现,不利于我们写出高质量的程序.

以下提一下va系列宏的兼容性.

System V Unix把va_start定义为只有一个参数的宏:

va_start(va_list arg_ptr);

而ANSI C则定义为:

va_start(va_list arg_ptr,prev_param);

如果我们要用system V的定义,应该用vararg.h头文件中所定义的

宏,ANSI C的宏跟system V的宏是不兼容的,我们一般都用ANSI C,所以

用ANSI C的定义就够了,也便于程序的移植.

 

概述

　　C语言中有一种长度不确定的参数，形如："…"，它主要用在参数个数不确定的函数中，我们最容易想到的例子是printf函数。

　　原型：

int printf( const char *format [, argument]... );

　　使用例：

printf("Enjoy yourself everyday!\n");
printf("The value is %d!\n", value);

　　这种可变参数可以说是C语言一个比较难理解的部分，这里会由几个问题引发一些对它的分析。

　　注意：在C++中有函数重载（overload）可以用来区别不同函数参数的调用，但它还是不能表示任意数量的函数参数。

　　问题：printf的实现

　　请问，如何自己实现printf函数，如何处理其中的可变参数问题？ 答案与分析：

　　在标准C语言中定义了一个头文件<stdarg.h>专门用来对付可变参数列表，它包含了一组宏，和一个va_list的typedef声明。一个典型实现如下：

typedef char* va_list;
#define va_start(list) list = (char*)&va_alist
#define va_end(list)
#define va_arg(list, mode)\
((mode*) (list += sizeof(mode)))[-1]
自己实现printf：
#include <stdarg.h>
int printf(char* format, …)
{
va_list ap;
va_start(ap, format);
int n = vprintf(format, ap);
va_end(ap);
return n;
}

　　问题：运行时才确定的参数

　　有没有办法写一个函数，这个函数参数的具体形式可以在运行时才确定？

　　答案与分析：

　　目前没有"正规"的解决办法，不过独门偏方倒是有一个，因为有一个函数已经给我们做出了这方面的榜样，那就是main()，它的原型是:

int main(int argc,char *argv[]);

　　函数的参数是argc和argv。

　　深入想一下，"只能在运行时确定参数形式"，也就是说你没办法从声明中看到所接受的参数，也即是参数根本就没有固定的形式。常用的办法是你可以通过定义一个void *类型的参数，用它来指向实际的参数区，然后在函数中根据根据需要任意解释它们的含义。这就是main函数中argv的含义，而argc，则用来表明实际的参数个数，这为我们使用提供了进一步的方便，当然，这个参数不是必需的。

　　虽然参数没有固定形式，但我们必然要在函数中解析参数的意义，因此，理所当然会有一个要求，就是调用者和被调者之间要对参数区内容的格式，大小，有效性等所有方面达成一致，否则南辕北辙各说各话就惨了。

　　问题：可变长参数的传递

　　有时候，需要编写一个函数，将它的可变长参数直接传递给另外的函数，请问，这个要求能否实现？

　　答案与分析：

　　目前，你尚无办法直接做到这一点，但是我们可以迂回前进，首先，我们定义被调用函数的参数为va_list类型，同时在调用函数中将可变长参数列表转换为va_list，这样就可以进行变长参数的传递了。看如下所示：

void subfunc (char *fmt, va_list argp)
{
...
arg = va_arg (fmt, argp); /* 从argp中逐一取出所要的参数 */
...
}

void mainfunc (char *fmt, ...)
{
va_list argp;
va_start (argp, fmt); /* 将可变长参数转换为va_list */
subfunc (fmt, argp); /* 将va_list传递给子函数 */
va_end (argp);
...
}

　　问题：可变长参数中类型为函数指针

　　我想使用va_arg来提取出可变长参数中类型为函数指针的参数，结果却总是不正确，为什么？

　　答案与分析：

　　这个与va_arg的实现有关。一个简单的、演示版的va_arg实现如下：

#define va_arg(argp, type) \
(*(type *)(((argp) += sizeof(type)) - sizeof(type)))

　　其中，argp的类型是char *。

　　如果你想用va_arg从可变参数列表中提取出函数指针类型的参数，例如

int (*)()，则va_arg(argp, int (*)())被扩展为：
(*(int (*)() *)(((argp) += sizeof (int (*)())) -sizeof (int (*)())))

　　显然，（int (*)() *）是无意义的。

　　解决这个问题的办法是将函数指针用typedef定义成一个独立的数据类型，例如：

typedef int (*funcptr)()；

　　这时候再调用va_arg(argp,funcptr)将被扩展为：

(* (funcptr *)(((argp) += sizeof (funcptr)) - sizeof (funcptr)))

　　这样就可以通过编译检查了。

　　问题：可变长参数的获取

　　有这样一个具有可变长参数的函数，其中有下列代码用来获取类型为float的实参：

va_arg (argp, float);

　　这样做可以吗？

　　答案与分析：

　　不可以。在可变长参数中，应用的是"加宽"原则。也就是float类型被扩展成double；char, short被扩展成int。因此，如果你要去可变长参数列表中原来为float类型的参数，需要用va_arg(argp,double)。对char和short类型的则用va_arg(argp,int)。

　　问题：定义可变长参数的一个限制

　　为什么我的编译器不允许我定义如下的函数，也就是可变长参数，但是没有任何的固定参数？

int f (...)
{
...
}

　　答案与分析：

　　不可以。这是ANSI C 所要求的，你至少得定义一个固定参数。

　　这个参数将被传递给va_start()，然后用va_arg()和va_end()来确定所有实际调用时可变长参数的类型和值。