C语言中可变参数的用法

文章导读：我们在C语言编程中会遇到一些参数个数可变的函数,例如printf()这个函数,它的定义是这样的: int printf( const char* format, ...);

它除了有一个参数format固定以外,后面跟的参数的个数和类型是可变的,例如我们可以有以下不同的调用方法: printf(\"%d\printf(\"%s\

printf(\"the number is %d ,string is:%s\

究竟如何写可变参数的C函数以及这些可变参数的函数编译器是如何实现的呢?本文就这个问题进行一些探讨,希望能对大家有些帮助.会C++的网友知道这些问题在C++里不存在,因为C++具有多态性.但C++是C的一个超集,以下的技术也可以用于C++的程序中.限于本人的水平,文中如果有不当之处,请大家指正.

我们在C语言编程中会遇到一些参数个数可变的函数,例如printf()这个函数,它的定义是这样的: int printf( const char* format, ...);

它除了有一个参数format固定以外,后面跟的参数的个数和类型是可变的,例如我们可以有以下不同的调用方法:

printf(\"%d\ printf(\"%s\

printf(\"the number is %d ,string is:%s\

究竟如何写可变参数的C函数以及这些可变参数的函数编译器是如何实现的呢?本文就这个问题进行一些探讨,希望能对大家有些帮助.会C++的网友知道这些问题在C++里不存在,因为C++具有多态性.但C++是C的一个超集,以下的技术也可以用于C++的程序中.限于本人的水平,文中如果有不当之处,请大家指正. (一)写一个简单的可变参数的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\ 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\ 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的定义就够了,也便于程序的移植. 小结:

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

语言中的可变参数宏/函数，及可变参数在函数中的传递问题全解析

做ScheduleDownload，要做一个logger，这个logger的大致结构如下：

Code: Select all

#ifdef _DEBUG

#define LOGGER(log_level, filename, line, format, ...) \\ logger_action(log_level, filename, line, format, __VA_ARGS__); #else

#define LOGGER #endif /*

* Log the strings. filename should be __FILE__ and line should be __LINE__ */

void logger_action(LOG_LEVEL log_level, LPCTSTR filename, int line, LPCTSTR format, ...);

#define UTILS_RVIF_WITH_LOG(expr, val, log_level, filename, line, format, ...) \\

if (!(expr)) { \\

LOGGER(log_level, filename, line, format, __VA_ARGS__); \\ return val; \\ }

这里很清楚了，真正的函数是logger_action，两个宏分别包装了一下。这里：

1. 在宏定义中，使用__VA_ARGS__来表示可变参数，前面用...即可。如果可变参数为空，那么，理论上就会多产生一个逗号导致编译失败 （format参数后面多一个逗号），此时，__VA_ARGS__会自动消除多余的逗号。这是VC编译器的动作，如果是GNU的编译器，要这样 写##__VA_ARGS__，通过##来将多余的逗号去掉（##一般用来连接字符串的，但是在这里就有去掉前面多余逗号的作用）。 __VA_ARGS__是C99规范中规定出来的关键字，在VC中，要在Visual Studio 2005开始支持。

2. __VA_ARGS__不能出现在函数实现中，只能出现在宏里面。所以这就带来一个问题：在logger_action中，我们其实不是想自己分析 format和后面的可变参数，我们仅仅想把这些都传递给StringCchPrintf而已，于是尝试在logger_action中这样处理：

Code: Select all

// handle format & args va_list args;

va_start(args, format);

UTILS_RETURN_IF_FAIL(SUCCEEDED(StringCchPrintf(log_str_buf + log_str_cur_index, _countof(log_str_buf) - log_str_cur_index, format, args)));

va_end(args);

va_list就是一个char *，va_start是一个宏，它的作用就是将args这个参数设置成format参数地址+format参数的字节数 -- 说白一些就是，将args设置成函数栈中format以后的位置上，这样args就指向了可变参数的开头。接着可以使用va_arg参数将可变参数一个一 个取出，这也是为什么va_arg宏要提供一个参数type的原因：va_arg根据参数type来决定往后取多少字节出来。最后的va_end就是将 args设成NULL。

所以va_list/va_start/va_arg/va_end其实非常简单，就是指针操作，将不确定的参数从函数堆栈中取出。这里我们只需要让StringCchPrintf来处理即可，于是我天真的将args参数传递给了StringCchPrintf。

结 果是：编译不出错，执行出错，StringCchPrintf生成的字符串是一堆乱七八糟的东西。开始Debug，通过观察函数的栈，传入的可变参数是 OK的，证明__VA_ARGS__在一堆宏之间传递没有问题。那为什么StringCchPrintf取不出这些可变参数呢？其实非常简单：

就 像前面说的一样，具有可变参数的函数在处理时，使用的是va_list/va_start...这些宏，这些宏是在本函数的堆栈上进行指针操作，而我们在 调用StringCchPrintf的时候，可变参数部分传入的是args，前面也说了，args其实类型是char *，就是一个地址，根本代表不了那一堆可变参数。StringCchPrintf能取出的唯一参数就是args，里面的值是logger_action函 数format参数之后的堆栈地址！！自然出错了，没crash就不错了。

OK，那应该怎么做呢？结论是：

1. 在logger_action函数中，将可变参数一个一个取出，用汇编将这些参数一个一个的压入StringCchPrintf函数的栈中。这种做法可移植性很差，不同编译器和不同平台上运行都有可能出问题，因为牵扯到汇编。 2. 其实我们相当于在做一个mysprintf，里面调用sprintf。除非用方法1，否则是无法实现的。幸运的是，sprintf有个兄弟叫 vsprintf，这个带v的函数最后不是接收...的参数，而是接受一个va_list类型的参数，也就是说，vsprintf和sprintf不同的 是，它不是在自己的堆栈上找可变参数，而是在我们给定的va_list参数地址上找可变参数。Great!于是查找StringCchPrintf有没有 这样一个兄弟 -- 有！StringCchVPrintf。于是代码只需要修改一个字符就OK了： Code: Select all

// handle format & args

va_list args;

va_start(args, format);

UTILS_RETURN_IF_FAIL(SUCCEEDED(StringCchVPrintf(log_str_buf + log_str_cur_index, _countof(log_str_buf) - log_str_cur_index, format, args))); va_end(args);

这样就OK了！StringCchVPrintf会在args参数指定的地址开始，根据format中的定义，找寻对应的参数。测试通过，程序工作正常。

总结，主要是两点：

1. __VA_ARGS__不能出现在函数中，只能在宏中使用

2. 要将可变参数在函数中传递，要看被传入的函数有没有一个va_list参数的版本，否则就非常麻烦了。