深度探索C語言函數可變長參數

獨立博客鏈接：http://www.keepsimply.org/2012/08/18/deep-explore-c-va-arg/

作者：獨酌逸醉
時間：2012.08.18

一、基礎部分

1.1 什么是可變長參數

可變長參數：顧名思義，就是函數的參數長度（數量）是可變的。比如 C 語言的 printf 系列的（格式化輸入輸出等）函數，都是參數可變的。下面是 printf 函數的聲明：

int printf ( const char * format, ... );

可變參數函數聲明方式都是類似的。

1.2 如何實現

C語言可變參數通過三個宏（va_start、va_end、va_arg）和一個類型（va_list）實現的，

void va_start ( va_list ap, paramN );
參數：
ap: 可變參數列表地址
paramN: 確定的參數
功能：初始化可變參數列表（把函數在 paramN 之后的參數地址放到 ap 中）。

void va_end ( va_list ap );
功能：關閉初始化列表（將 ap 置空）。

type va_arg ( va_list ap, type );
功能：返回下一個參數的值。

va_list ：存儲參數的類型信息。

好了，綜合上面3個宏和一個類型可以猜出如何實現C語言可變長參數函數：用 va_start 獲取參數列表（的地址）存儲到 ap 中，用 va_arg 逐個獲取值，最后用 va_arg 將 ap 置空。

1.3 舉例

/* 作者：獨酌逸醉
 * 時間：2012.08.18
 * 功能：用C語言實現變長參數小例：求和
 * IDE:  Microsoft Visual Studio 2010
 */

#include <stdio.h>
#include <stdarg.h>

#define END -1

int va_sum (int first_num, ...)
{
    // (1) 定義參數列表
    va_list ap;
    // (2) 初始化參數列表
    va_start(ap, first_num);

    int result = first_num;
    int temp = 0;
    // 獲取參數值
    while ((temp = va_arg(ap, int)) != END)
    {
        result += temp;
    }

    // 關閉參數列表
    va_end(ap);

    return result;
}

int main ()
{
    int sum_val = va_sum(1, 2, 3, 4, 5, END);
    printf ("%d", sum_val);
    return 0;
}

 

1.4 使用注意事項

1. 宏定義在 stdarg.h 中，所以使用時，不要忘了添加頭文件。
2. 設定一個參數結束標志（cplusplus 上說，va_arg 並不能確定哪個參數是最后一個參數）。
3. 類型的匹配
4. 期待您的補充……

---

二、深入原理

“源碼面前，一覽無遺”！

以下源碼，來自“..\Microsoft Visual Studio 10.0\VC\include”

// stdarg.h
#define va_start _crt_va_start
#define va_arg _crt_va_arg
#define va_end _crt_va_end
// vadefs.h
typedef char *  va_list;
#define _crt_va_start(ap,v)  ( ap = (va_list)_ADDRESSOF(v) + _INTSIZEOF(v) )
#define _crt_va_arg(ap,t)    ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )
#define _crt_va_end(ap)      ( ap = (va_list)0 )
#define _ADDRESSOF(v)   ( &(v) )
#define _INTSIZEOF(n)   ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )

除了 _INTSIZEOF 之外，其他都很好理解，舉個例子吧：

/* 作者：獨酌逸醉
 * 時間：2012.08.18
 * 功能：測試 _INTSIZEOF 宏
 * IDE:  CodeBlocks 10.05
 */

#include <stdio.h>
#include <stdarg.h>


int main ()
{
	int i = 1;
	float f = 0.0;
	printf("_INTSIZEOF(i) = %d\n", (int)(_INTSIZEOF(i)));
	printf("_INTSIZEOF(f) = %d\n", (int)(_INTSIZEOF(f)));
	printf("_INTSIZEOF(\"Hello,world\") = %d\n", (int)(_INTSIZEOF("Hello,world")));
	printf("sizeof(\"Hello,world\") = %d\n", sizeof("Hello,world") );
    return 0;
}

輸出結果：

_INTSIZEOF(i) = 4
_INTSIZEOF(f) = 4
_INTSIZEOF("Hello,world") = 12
sizeof("Hello,world") = 12

既然 sizeof 和 _INTSIZEOF 值一樣，為什么不直接用 sizeof 呢？干嘛要寫的那么復雜？答案是為了字節對齊（無論32位還是64位機器，sizeof(int)永遠代表機器的位數，明白了吧！^_^）

現在再去看變長參數的實現：其實就是把參數在棧中的地址記錄到 ap 中（通過一個確定參數 paramN 確定地址），然后逐個讀取值。

此時是否有一種豁然開朗的感覺？至少明白了許多，也清楚了很多。

---

三、知識擴展

可能大家也猜到了，我擴展要擴展什么了？！^_^

簡單介紹兩種函數調用約定

__stdcall （C++默認）

1. 參數從右向左壓入堆棧
2. 函數被調用者修改堆棧
3. 函數名(在編譯器這個層次)自動加前導的下划線，后面緊跟一個@符號，其后緊跟着參數的尺寸

__cdecl （C語言默認）

1. 參數從右向左壓入堆棧
2. 參數由調用者清楚，手動清棧，被調用函數不會要求調用者傳遞多少參數，調用者傳遞過多或者過少的參數，甚至完全不同的參數都不會產生編譯階段的錯誤。

那么，變參函數的調用方式為（也只能是）：__cdecl 。

本來打算多寫一點擴展的，又擔心會文不符題，所以感興趣的朋友可以去看參考資料中的文章，有一些介紹的很詳細。

---

參考資料

1. http://www.cplusplus.com/reference/clibrary/cstdarg/va_start/
2. http://www.cplusplus.com/reference/clibrary/cstdarg/va_end/
3. http://www.cplusplus.com/reference/clibrary/cstdarg/va_list/
4. http://www.cplusplus.com/reference/clibrary/cstdarg/va_arg/
5. http://51hired.com/questions/13278?sort=oldest
6. http://www.cnblogs.com/diyunpeng/archive/2010/01/09/1643160.html
7. http://blog.csdn.net/huanjieshuijing/article/details/5822942
8. http://baike.baidu.com/view/1280676.htm