探究C/C++可變參數

轉自：http://blog.csdn.net/guanzhongs/archive/2007/04/04/1551747.aspx#550577

C/C++支援可變參數個數的函數定義，這一點與C/C++語言函數參數調用時入棧順序有關，
首先引用其他網友的一段文字，來描述函數調用，及參數入棧：

------------ 引用開始 ------------
C支援可變參數的函數，這裡的意思是C支援函數帶有可變數量的參數，最常見的例子就
是我們十分熟悉的printf()系列函數。我們還知道在函數調用時參數是自右向左壓棧的
。如果可變參數函數的一般形式是：
    f(p1, p2, p3, …)
那麼參數進棧（以及出棧）的順序是：
    …
    push p3
    push p2
    push p1
    call f
    pop p1
    pop p2
    pop p3
    …
我可以得到這樣一個結論：如果支援可變參數的函數，那麼參數進棧的順序幾乎必然是
自右向左的。並且，參數出棧也不能由函數自己完成，而應該由調用者完成。

這個結論的後半部分是不難理解的，因為函數自身不知道調用者傳入了多少參數，但是
調用者知道，所以調用者應該負責將所有參數出棧。

在可變參數函數的一般形式中，左邊是已經確定的參數，右邊省略符號代表未知參數部分
。對於已經確定的參數，它在棧上的位置也必須是確定的。否則意味著已經確定的參數
是不能定位和找到的，這樣是無法保證函數正確執行的。衡量參數在棧上的位置，就是
離開確切的函數調用點（call f）有多遠。已經確定的參數，它在棧上的位置，不應該
依賴參數的具體數量，因為參數的數量是未知的！

所以，選擇只能是，已經確定的參數，離開函數調用點有確定的距離（較近）。滿足這
個條件，只有參數入棧遵從自右向左規則。也就是說，左邊確定的參數後入棧，離函數
調用點有確定的距離（最左邊的參數最後入棧，離函數調用點最近）。

這樣，當函數開始執行後，它能找到所有已經確定的參數。根據函數自己的邏輯，它負
責尋找和解釋後面可變的參數（在離開調用點較遠的地方），通常這依賴於已經確定的
參數的值（典型的如prinf()函數的格式解釋，遺憾的是這樣的方式具有脆弱性）。

據說在pascal中參數是自左向右壓棧的，與C的相反。對於pascal這種只支援固定參數函
數的語言，它沒有可變參數帶來的問題。因此，它選擇哪種參數進棧方式都是可以的。
甚至，其參數出棧是由函數自己完成的，而不是調用者，因為函數的參數的類型和數量
是完全已知的。這種方式比採用C的方式的效率更好，因為佔用更少的代碼量（在C中，
函數每次調用的地方，都產生了參數出棧代碼）。

C++為了相容C，所以仍然支援函數帶有可變的參數。但是在C++中更好的選擇常常是函數
重載。
------------ 引用結束 ------------

根據上文描述，我們查看printf()及sprintf()等函數的定義，可以驗證這一點：
_CRTIMP int __cdecl printf(const char *, ...);
_CRTIMP int __cdecl sprintf(char *, const char *, ...);

這兩個函數定義時，都使用了__cdecl關鍵字，__cdecl關鍵字約定函數調用的規則是：
調用者負責清除呼叫堆疊，參數通過堆棧傳遞，入棧順序是從右至左。

下一步，我們來看看printf()這種函數是如何使用變個數參數的，下面是摘錄MSDN上的例子，
只引用了ANSI系統相容部分的代碼，UNIX系統的代碼請直接參考MSDN。

------------ 例子代碼 ------------
#include <stdio.h>
#include <stdarg.h>
int average( int first, ... );

void main( void )
{
   printf( "Average is: %d"n", average( 2, 3, 4, -1 ) );
}

int average( int first, ... )
{
   int count = 0, sum = 0, i = first;
   va_list marker;

   va_start( marker, first );     /* Initialize variable arguments. */
   while( i != -1 )
   {
      sum += i;
      count++;
      i = va_arg( marker, int);
   }
   va_end( marker );              /* Reset variable arguments.      */
   return( sum ? (sum / count) : 0 );
}
------------ 代碼結束 ------------

上例代碼功能是計算平均數，函數允許使用者輸入多個整型參數，要求作後一個參數必須
是-1，表示參數輸入完畢，然後返回平均數計算結果。

邏輯很簡單，首先定義
   va_list marker;
表示參數列表，然後調用va_start()初始化參數列表。注意va_start()調用時不僅使用了marker
這個參數列表變數，還使用了first這個參數，說明參數列表的初始化與函數給定的第一個
確定參數是有關係的，這一點很關鍵，後續分析會看到原因。

調用va_start()初始化後，即可調用va_arg()函數訪問每一個參數列表中的參數了。注意va_arg()
的第二個參數指定了傳回值的類型（int）。

當程式確定所有參數訪問結束後，調用va_end()函數結束參數列表訪問。

這樣看起來，訪問變個數參數是很容易的，也就是使用va_list,va_start(),va_arg(),va_end()
這樣一個類型與三個函數。但是對於函數變個數參數的機制，感覺仍是一頭霧水。看來需要
繼續深入探究，才能的到確切的答案了。

找到va_list,va_start(),va_arg(),va_end()的定義，在..."VC98"include"stdarg.h檔案中。
.h中代碼如下（只摘錄了ANSI相容部分的代碼，UNIX等其他系統實現略有不同，感興趣的朋友可以
自己研究）：

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 )

從代碼可以看出，va_list只是一個類型轉義，其實就是定義成char*類型的指標了，這樣就是為了
以位元組為單位訪問記憶體。
其他三個函數其實只是三個宏定義，且慢，我們先看夾在中間的這個宏定義_INTSIZEOF：

#define _INTSIZEOF(n)   ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )

這個宏的功能是對給定變數或者類型n，計算其按整型位元組長度進行位元組對齊後的長度(size)。在32位系統中
int佔4個位元組，16位系統中佔2位元組。
運算式
(sizeof(n) + sizeof(int) - 1)
的作用是，如果sizeof(n)小於sizeof(int)，則計算後
的結果數值，會比sizeof(n)的值在二進位上向左進一位。
如：sizeof(short) + sizeof(n) - 1 = 5
5的二進位是0x00000101，sizeof(short)的二進位是0x00000010，所以5的二進位值比2的二進位值
向左高一位。
運算式
~(sizeof(int) - 1)
的作用時產生一個蒙版(mask)，以便捨去前面那個計算值的"零頭"部分。
如上例，~(sizeof(int) - 1) = 0x00000011(謝謝glietboys的提醒，此處應該是0xFFFFFF00)
同5的二進位0x00000101做"與"運算得到的是0x00000100，也就是4，而直接計算sizeof(short)應該得到2。
這樣通過_INTSIZEOF(short)這樣的運算式，就可以得到按照整型位元組長度對齊的其他類型位元組長度。
之所以採用int類型的位元組長度進行對齊，是因為C/C++中的指標變數其實就是整型數值，長度與int相同，
而指標的位移量是後面的三個宏進行運算時所需要的。

關於編程中位元組對齊的內容請有興趣的朋友到網上參考其他文章，這裡不再贅述。

繼續，下面這個三個宏定義：

第一：
#define va_start(ap,v) ( ap = (va_list)&v + _INTSIZEOF(v) )

編程中這樣使用
   va_list marker;
   va_start( marker, first );
可以看出va_start宏的作用是使給定的參數列表指標(marker)，根據第一個確定參數(first)所屬類型的
指標長度向後位移相應位置，計算這個位移的時候就用到了前面的_INTSIZEOF(n)宏。

第二：
#define va_arg(ap,t)    ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )

此處乍一看有點費解，(ap += _INTSIZEOF(t)) - _INTSIZEOF(t)運算式的一加一減，對傳回值是不起作用
的啊，也就是傳回值都是ap的值，什麼原因呢？
原來這個計算傳回值是一方面，另一方面，請記住，va_start(),va_arg(),va_end這三個宏的調用是有關聯
性的，ap這個變數是調用va_start()時給定的參數列表指標，所以

(ap += _INTSIZEOF(t)) - _INTSIZEOF(t)

運算式不僅僅是為了返回當前指向的參數的地址，還是為了讓ap指向下一個參數（注意ap跳向下一參數是，
是按照類型t的_INTSIZEOF長度進行計算的）。

第三：
#define va_end(ap)      ( ap = (va_list)0 )

這個很好理解了，不過是將ap指標置為空白，算作參數讀取結束。

至此，C/C++變個數函數參數的機制已經很清晰了。最後還要說一點要注意的問題：
在用va_arg()順序跳轉指標讀取參數的過程中，並沒有方法去判斷所得到的下一個指標是否是有效地址，也
沒有地方能夠明確得知到底要讀取多少個參數，這就是這種變個數參數的危險所在。前面的求平均數的例子
中，要求輸入者必須在參數列表最後提供一個特殊值（-1）來表示參數列表結束，所以可以假設，萬一調用
者沒有遵循這種規則，將導致指標訪問越界。

那麼，可能有朋友會問，printf()函數就沒有提供這樣的特殊值進行標識啊。

別急，printf()使用的是另一種參數個數識別方式，可能比較隱蔽。注意他的第一個確定參數，也就是被我
們用作格式控制的format字串，他的裡面有"%d","%s"這樣的參數描述符，printf()函數在解析format字元
串時，可以根據參數描述符的個數，確定需要讀取後面幾個參數。我們不妨做下面這樣的實驗：

printf("%d,%d,%d,%d"n",1,2,3,4,5);

實際提供的參數多於前面給定的參數描述符，這樣執行的結果是

1,2,3,4

也就是printf()根據format字串認為後面只有4個參數，其他的就不管了。那麼再做一個實驗：

printf("%d,%d,%d,%d"n",1,2,3);

實際提供的參數少於給定的參數描述符，這樣執行的結果是（如果沒有異常的話）

1,2,3,2367460

這個地方，每個人的執行結果可能都不相同，原因是讀取最後一個參數的指標已經指向了非法的地址。這也是
使用printf()這類函數需要特別注意的地方。

總結：
變個數的函數參數在使用時需要注意的地方比較多。我個人建議盡量迴避使用這種模式。比如前面的計算平均
數，寧可使用數組或其他列表作為參數將一系列數值傳遞給函數，也不用寫這樣的變態函數。一方面是容易出
現指標訪問越界，另一方面，在實際的函數調用時，要把所有計算值依次作為參數寫在代碼裡，很齷齪。
雖然這麼說，但有些地方這個功能還是很有用處的，比如字串的格式化合成，像printf()函數；在實際應用
中，我還經常使用一個自己寫的WriteLog()函數，用於記錄檔案日誌，定義與printf()相同，使用起來非常靈
活便利，如：

WriteLog("使用者%s, 登入次數%d","guanzhong",10);

寫在檔案裡的內容就是

使用者guanzhong, 登入次數10

程式設計語言的使用，在遵循基本規則的前提下，是仁者見仁，智者見智。總之，透徹瞭解之後，選擇一個符合自己的好的習慣即可。