本文主要介紹可變參數
的函數使用,然後分析它的原理,程式員
自己如何對它們實現和封裝,最後是可能會出現的問題和避免措施。
VA函數(variable argument function
),參數個數可變函數,又稱可變參數函數。C/C++
編程中,系統
提供給編程人員的va函數很少。*printf()/*scanf
()系列函數,用於輸入輸出時格式化
字串
;exec*()系列函數,用於在程式
中執行外部檔案
(main(int
argc, char*
argv[]算不算呢,與其說main()也是一個可變參數函數,倒不如說它是exec*()經過封裝後的具備特殊功能和意義的函數,至少在原理這一級上
有很多相似之處)。由於參數個數的不確定,使va函數具有很大的靈活性,易用性,對沒有使用過可變參數函數的編程人員很有誘惑力;那麼,該如何編寫自己的
va函數,va函數的運用時機、編譯
實現又是如何。作者借本文談談自己關於va函數的一些淺見。
一、 從printf()開始
從大家都很熟悉的格式化字元
串函數開始介紹可變參數函數。
原型:int printf(const char * format, ...);
參數format表示如何來格式字串的指令,…
表示選擇性參數,調用時傳遞給"..."的參數可有可無,根據實際情況而定。
系統提供了vprintf系列格式化字串的函數,用於編程人員封裝自己的I/O函數。
int vprintf / vscanf(const char * format, va_list ap); // 從標準輸入/輸出格式化字串
int vfprintf / vfsacanf(FILE * stream, const char * format, va_list ap); // 從檔案流
int vsprintf / vsscanf(char * s, const char * format, va_list ap); // 從字串
// 例1:格式化到一個檔案流,可用於記錄檔
FILE *logfile;
int WriteLog(const char * format, ...)
{
va_list arg_ptr;
va_start(arg_ptr, format);
int nWrittenBytes = vfprintf(logfile, format, arg_ptr);
va_end(arg_ptr);
return nWrittenBytes;
}
…
// 調用時,與使用printf()沒有區別。
WriteLog("%04d-%02d-%02d %02d:%02d:%02d %s/%04d logged out.",
nYear, nMonth, nDay, nHour, nMinute, szUserName, nUserID);
同理,也可以從檔案中執行格式化輸入;或者對標準輸入輸出,字串執行格式化。
在上面的例1中,WriteLog()函數可以接受參數個數可變的輸入,本質上,它的實現需要vprintf()的支援。如何真正實現屬於自己的可變參數函數,包括控制每一個傳入的選擇性參數。
二、 va函數的定義和va宏
C語言
支援va函數,作為C語言的擴充—C++
同樣支援va函數,但在C++中並不推薦使用,C++引入的多態性同樣可以實現參數
個數可變的函數。不過,C++的重載功能畢竟只能是有限多個可以預見的參數個數。比較而言,C中的va函數則可以定義無窮多個相當於C++的重載函數,這方面C++是無能為力的。va函數的優勢表現在使用的方便性和易用性上,可以使代碼
更簡潔。C編譯器
為了統一在不同的硬體
架構
、硬體平台上的實現,和增加代碼的可移植性,提供了一系列宏來屏蔽硬體環境不同帶來的差異。
ANSI C標準下,va的宏定義在stdarg.h中,它們有:va_list,va_start(),va_arg(),va_end()。
// 例2:求任意個自然數的平方和:
int SqSum(int n1, ...)
{
va_list arg_ptr;
int nSqSum = 0, n = n1;
va_start(arg_ptr, n1);
while (n > 0)
{
nSqSum += (n * n);
n = va_arg(arg_ptr, int);
}
va_end(arg_ptr);
return nSqSum;
}
// 調用時
int nSqSum = SqSum(7, 2, 7, 11, -1);
可變參數函數的原型聲明格式為:
type
VAFunction(type arg1, type arg2, … );
參數可以分為兩部分:個數確定的固定參數和個數可變的選擇性參數。函數至少需要一個固定參數,固定參數的聲明和普通函數一樣;選擇性參數由於個數不確定,聲明時用"…"表示。固定參數和選擇性參數公同構成一個函數的參數列表。
藉助上面這個簡單的例2,來看看各個va_xxx的作用。
va_list arg_ptr:定義一個指向個數可變的參數列表指標
;
va_start(arg_ptr, argN):使參數列表指標arg_ptr指向函數參數列表中的第一個選擇性參數,說明:argN是位於第一個選擇性參數之前的固定參數,(或者說,最後一個固定參數;…之前的一個參數),函數參數列表中參數在記憶體
中的順序與函式宣告時的順序是一致的。如果有一va函數的聲明是void
va_test(char a, char b, char c, …),則它的固定參數依次是a,b,c,最後一個固定參數argN為c,因此就是va_start(arg_ptr, c)。
va_arg(arg_ptr, type):返回參數列表中指標arg_ptr所指的參數,傳回型別
為type,並使指標arg_ptr指向參數列表中下一個參數。
va_copy(dest, src):dest,src的類
型都是va_list,va_copy()用於複製參數列表指標,將dest初始化
為src。
va_end(arg_ptr):清空參數列表,共置參數指標
arg_ptr無效。說明:指標arg_ptr被置無效後,可以通過調用va_start()、va_copy()恢複arg_ptr。每次調用
va_start() /
va_copy()後,必須得有相應的va_end()與之匹配。參數指標可以在參數列表中隨意地來回移動,但必須在va_start() …
va_end()之內。
三、 編譯器
如何?va
例2中調用SqSum(7, 2, 7, 11, -1)來求7, 2, 7, 11的平方和,-1是結束標誌。
簡單地說,va函數的實現就是對參數
指標
的使用和控制。
typedef char * va_list; // x86
平台下va_list的定義
函數的固定參數部分,可以直接從函數定義時的參數名獲得;對於選擇性參數部分,先將指標指向第一個選擇性參數,然後依次後移指標,根據與結束標誌的比較來判斷是否已經獲得全部參數。因此,va函數中結束標誌必須事先約定好,否則,指標會指向無效的記憶體
地址,導致出錯。
這裡,移動指標使其指向下一個參數,那麼移動指標時的位移量是多少呢,沒有具體答案,因為這裡涉及到記憶體對齊(alignment)問題,記憶體對齊跟具體使用的硬體
平台有密切關係,比如大家熟知的32位x86平台規定所有的變數
地址必須是4的倍數(sizeof(int) = 4)。va機制中用宏
_INTSIZEOF(n)來解決這個問題,沒有這些宏,va的可移植性無從談起。
首先介紹宏_INTSIZEOF(n),它求出變數佔用記憶體空間的大小,是va的實現的基礎。
#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 ) // 將指標置為無效
下表是針對函數int TestFunc(int n1, int n2, int n3, …) 參數傳遞時的記憶體堆棧
情況。(C編譯
器預設的參數傳遞方式是__cdecl。)
對該函數的調用為int result = TestFunc(a, b, c, d. e); 其中e為結束標誌。
從中可以很清楚地看出va_xxx宏如此編寫的原因。
1. va_start。為了得到第一個選擇性參數的地址,我們有三種辦法可以做到:
A) = &n3 + _INTSIZEOF(n3)
// 最後一個固定參數的地址 + 該參數佔用記憶體的大小
B) = &n2 + _INTSIZEOF(n3) + _INTSIZEOF(n2)
// 中間某個固定參數的地址 + 該參數之後所有固定參數佔用的記憶體大小之和
C) = &n1 + _INTSIZEOF(n3) + _INTSIZEOF(n2) + _INTSIZEOF(n1)
// 第一個固定參數的地址 + 所有固定參數佔用的記憶體大小之和
從編譯器實現角度來看,方法B),方法C)為了求出地址,編譯器還
需知道有多少個固定參數,以及它們的大小,沒有把問題分解到最簡單,所以不是很聰明的途徑,不予採納;相對來說,方法A)中運算的兩個值則完全可以確定。
va_start()正是採用A)方法,接受最後一個固定參數。調用va_start()的結果總是使指標指向下一個參數的地址,並把它作為第一個可選參
數。在含多個固定參數的函數中,調用va_start()時,如果不是用最後一個固定參數,對於編譯器來說,選擇性參數的個數已經增加,將給程式
帶來一些意想不到的錯誤。(當然如果你認為自己對指標已經知根知底,遊刃有餘,那麼,怎麼用就隨你,你甚至可以用它完成一些很優秀(高效)的代碼
,但是,這樣會大大降低代碼的可讀性。)
注意:宏
va_start是對參數
的地址進行操作的,要求參數地址必須是有效。一些地址無效的類型
不能當作固定參數類
型。比如:寄存器
類型,它的地址不是有效記憶體
地址值;數組
和函數也不允許,他們的長度是個問題。因此,這些類型時不能作為va函數的參數的。
2. va_arg身兼二職:返回當前參數,並使參數指標
指向下一個參數。
初看va_arg宏定義很彆扭,如果把它拆成兩個語句,可以很清楚地看出它完成的兩個職責。
#define va_arg(ap,t) ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) ) //下一個參數地址
// 將( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )拆成:
/* 指標ap指向下一個參數的地址 */
1. ap += _INTSIZEOF(t); // 當前,ap已經指向下一個參數了
/* ap減去當前參數的大小得到當前參數的地址,再強制類型轉換後返回它的值 */
2. return *(t *)( ap - _INTSIZEOF(t))
回想到printf/scanf
系列函數的%d %s之類的格式化
指令,我們不難理解這些它們的用途了- 明示參數強制轉換的類型。
(註:printf/scanf沒有使用va_xxx來實現,但原理是一致的。)
3.va_end很簡單,僅僅是把指標作廢而已。
#define va_end(ap) (ap = (va_list)0) // x86
平台
四、 簡潔、靈活,也有危險
從va的實現可以看出,指標的合理運用,把C語言
簡潔、靈活的特性表現得淋漓盡致,叫人不得不佩服C的強大和高效。不可否認的是,給編程人員太多自由空間必然使程式
的安全
性降低。va中,為了得到所有傳遞給函數的參數,需要用va_arg依次遍曆。其中存在兩個隱患:
1)如何確定參數的類型。 va_arg在類型檢查方面與其說非常靈活,不如說是很不負責,因為是強制類型轉換,va_arg都把當前指標所指向的內容強制轉換到指定類型;
2)結束標誌。如果沒有結束標誌的判斷,va將按預設類型依次返回記憶體中的內容,直到訪問到非法記憶體而出錯退出。例2中SqSum()求的是自然數的平方和,所以我把負數和0作為它的結束標誌。例如scanf把接收到的斷行符號符作為結束標誌,大家熟知的printf()對字串
的處理用""作為結束標誌,無法想象C中的字元
串如果沒有"", 代碼
將會是怎樣一番情景,估計那時最流行的可能是字元數組,或者是malloc/free。
允許對記憶體的隨意訪問,會留給不懷好意者留下攻擊的可能。當處理cracker精心設計好的一串字串後,程式將跳轉到一些惡意代碼地區執行,以使cracker達到其攻擊目的。(常見的exploit攻擊)所以,必需禁止對記憶體的隨意訪問和嚴格控制記憶體訪問邊界。
五、 Unix
System V相容方式的va聲明
上面介紹可變參數
函數的聲明是採用ANSI標準的,Unix System V相容方式的聲明有一點點區別,它增加了兩個宏
:va_alist,va_dcl。而且它們不是定義在stdarg.h中,而是varargs.h中。stdarg.h是ANSI標準的;varargs.h僅僅是為了能與以前的程式
保持相容而出現的,現在的編程中不推薦使用。
va_alist:函式宣告/定義時出現在函數頭,用以接受參數列表。
va_dcl:對va_alist的聲明,其後無需跟分號";"
va_start的定義也不相同。因為System V可變參數函式宣告不區分固定參數和選擇性參數,直接對參數列表操作。所以va_start()不是va_start(ap,v),而是簡化為va_start(ap)。其中,ap是va_list型的參數指標
。
Unix System V相容方式下函數的聲明形式:
type
VAFunction(va_alist)
va_dcl // 這裡無需分號
{
// 函數體內同ANSI標準
}// 例3:猜測execl的實現(Unix System V相容方式),摘自SUS V2
#include
#define MAXARGS 100
/ * execl(file, arg1, arg2, ..., (char *)0); */
execl(va_alist)
va_dcl
{
va_list ap;
char *file;
char *args[MAXARGS];
int argno = 0;
va_start(ap);
file = va_arg(ap, char *);
while ((args[argno++] = va_arg(ap, char *)) != (char *)0)
;
va_end(ap);
return execv(file, args);
}
六、 擴充與思考
個數可變參數在聲明時只需"..."即可;但是,我們在接受這些參數時不能"..."。va函數實現的關鍵就是如何得到參數列表中選擇性參數,包括參數的值和類型
。以上的所有實現都是基於來自stdarg.h的va_xxx的宏定義。 <思考>能不能不藉助於va_xxx,自己實現VA呢?,我想到的方法是彙編
。在C中,我們當然就用C的嵌入彙編來實現,這應該是可以做得到的。至於能做到什麼程度,穩定性和效率怎麼樣,主要要看你對記憶體
和指標的控制了。