va_list(),va_start()，va_arg(),va_end（）

va_list(),va_start()，va_arg(),va_end（）詳解

(一)寫一個簡單的可變參數的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_listarg_ptr;

    intj=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的宏跟systemV的宏是不相容的,我們一般都用ANSI C,是以用ANSI C的定義就夠了,也便于程式的移植.