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", 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的定義就夠了,也便於程式的移植.

小結:
可變參數的函數原理其實很簡單,而va系列是以宏定義來定義的,實
現跟堆棧相關.我們寫一個可變函數的C函數時,有利也有弊,所以在不必
要的場合,我們無需用到可變參數.如果在C++裡,我們應該利用C++的多
態性來實現可變參數的功能,盡量避免用C語言的方式來實現.