C 不定長參數

 

• C語言可變參簡介

 

    咱們在C語言編程中會遇到一些參數個數可變的函數,例如printf()這個函數,它的定義是這樣的:
　    　int printf( const char* format, ...);

　　它除了有一個參數format固定之外,後面跟的參數的個數和類型是可變的,例如咱們能夠有如下不一樣的調用方法: 
　　    printf("%d",i); 
　    　printf("%s",s); 
　　    printf("the number is %d ,string is:%s", i, s);

 

 

• 寫一個簡單的可變參數的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函數就是用這個辦法。
      ⑵在預先設定一個特殊的結束標記，就是說多輸入一個可變參數，調用時要將最後一個可變參數的值設置成這個特殊的值，在函數體中根據這個值判斷是否達到參數的結尾。本文前面的代碼就是採用這個辦法.
      不管採用哪一種辦法，程序員都應該在文檔中告訴調用者本身的約定。

   三、實現可變參數的要點就是想辦法取得每一個參數的地址，取得地址的辦法由如下幾個因素決定：
      ①函數棧的生長方向
      ②參數的入棧順序
      ③CPU的對齊方式
      ④內存地址的表達方式
    結合源代碼，咱們能夠看出va_list的實現是由④決定的，_INTSIZEOF(n)的引入則是由③決定的，他和①②又一塊兒決定了va_start的實現，最後va_end的存在則是良好編程風格的體現，將再也不使用的指針設爲NULL,這樣能夠防止之後的誤操做。

   四、取得地址後，再結合參數的類型，程序員就能夠正確的處理參數了。理解了以上要點，相信稍有經驗的讀者就能夠寫出適合於本身機器的實現來。

　　可變參數的函數原理其實很簡單,而va系列是以宏定義來定義的,實現跟堆棧相關.咱們寫一個可變函數的C函數時,有利也有弊,因此在沒必要要的場合,咱們無需用到可變參數.若是在C++裏,咱們應該利用C++的多態性來實現可變參數的功能,儘可能避免用C語言的方式來實現.