理解可變參數va_list、va_start、va_arg、va_end原理及使用方法


參考:

http://www.360doc.com/content/12/0309/10/4025635_192940551.shtml

http://www.cnblogs.com/AnnieKim/archive/2011/11/25/ellipsis.html

http://intijk.com/others/va_list-%E7%9A%84%E7%94%A8%E6%B3%95.html

 

如何獲取函數的變長參數(va_list, va_start, va_arg, va_end)

最近在花時間研讀C++。

函數這章講到了函數的變長參數(ellipsis...),但是primer中講得比較淺,提到了怎么聲明怎么調用,但是沒有寫明在函數內部是如何獲取變長的參數的。

1)省略號(ellipsis)

在無法給出所有傳遞給函數的參數的類型和數目時,可以使用省略號(...)指定函數參數表。有如下幾種形式:

1 void fun1(int a, double b, ...); //給出確定的幾個參數,其他用省略號
2 void fun2(int a ...); //省略號前有或者沒有逗號都是可以的
3 void fun3(...); //也可以不確定任何參數,但和沒有參數是不一樣的

最典型的應用就是printf函數,printf的聲明和調用方法如下:

1 int printf( const char *format [,argument]... );    //官方聲明
2 printf("My name is %s, age %d.", "AnnieKim", 24); //調用

2)通用的工作原理

大多數帶有變長參數的函數都利用顯式聲明的參數中的一些信息,來獲取調用中提供的其他可選實參的類型和數目。

比如printf函數,就是根據第一個參數推導可選實參:如果第一個'%'后有一個's',說明后面要有第二個參數,類型是字符串;如果還有第二個'%',后面跟一個'd',說明還需要第三個參數,是一個整型等等。

所以說,通常情況下,第一個參數是必不可少的。

3)如何獲取變長參數

現在,我們要關注的是函數內部的實現細節。當我看到primer這部分的時候還真是好奇實現細節呢,只怪我孤陋寡聞,以前沒見過⊙﹏⊙b。

為了解決變長參數問題,需要用到以下幾個宏(以下定義來自MSDN),並且使用這幾個宏時必須至少提供一個顯式的參數:

復制代碼
#include <stdarg.h>

type va_arg(
va_list arg_ptr,
type
);
void va_end(
va_list arg_ptr
);
void va_start(
va_list arg_ptr,
prev_param
);
復制代碼

其中,type是指要獲取的參數的類型,比如int,char *等,arg_ptr是指向參數列表的指針(va_list類型),prev_param是指最后一個顯式聲明的參數,以用來獲取第一個變長參數的位置。

使用步驟:

a)定義一個va_list類型的變量,變量是指向參數的指針。

b)va_start初始化剛定義的變量,第二個參數是最后一個顯式聲明的參數。

c)va_arg返回變長參數的值,第二個參數是該變長參數的類型。

d)va_end將a)定義的變量重置為NULL。

注意事項:

a)變長參數的類型和數目不能通過宏來獲取,只能通過自己寫程序控制。

b)編譯器對變長參數函數的原型檢查不夠嚴格,會影響代碼質量。

4)舉個例子

最后舉個例子,是自己寫的printf函數,只能用於處理'%s'和'%d'。為簡單起見,沒有做任何異常處理,理解這些宏的使用方法即可。

復制代碼
 1 #include <iostream>
2 #include <stdarg.h>
3 using namespace std;
4
5 void myprintf(const char *format...)
6 {
7 va_list argptr;
8 va_start(argptr, format); //va_start
9

10 char ch;
11 while (ch = *(format++)) //逐個遍歷format字符串
12 {

13 if (ch == '%')
14 {
15 ch = *(format++);
16 if (ch == 's')
17 {
18 char *name = va_arg(argptr, char *); //va_arg
19 cout<<name;

20 }
21 else if (ch == 'd')
22 {
23 int age = va_arg(argptr, int); //va_arg
24 cout<<age;

25 }
26 }
27 else
28 {
29 cout<<ch;
30 }
31 }
32 cout<<endl;
33 va_end(argptr); //va_end
34 }

35
36 int main()
37 {
38 myprintf("My name is %s, age %d.", "AnnieKim", 24);
39 return 0;
40 }
復制代碼

代碼寫得較粗糙,表介意。變長參數問題也就先到這里。

va_list 的用法

相信每個程序員都會用C語言的 printf, scanf 函數, 當時在我學會函數之后, 對這兩個函數感到驚訝, 為什么呢? 他們太不同於我們自己寫的那種接受固定個參數的函數, 而是可以接受任意多個參數.

c 語言允許定義這樣的接受變參的函數, 它的機制就是 va_list , 使用它 , 我們也可以定義自己的變參個數的函數.

首先, 看下 printf 函數的聲明:

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

第一個 char * format 就是我們常寫的帶 %d, %f 這樣轉換單元的格式字符串, 第二個參數是 … ? 這是什么? 對, 這就是變參函數定義時的奧秘了, 記住如下兩點:

  • 1. 變參處的定義或聲明, 用 … 代替參數類型.
  • 2. 變參 … 只能放在參數列表最末尾.

這里我們寫一個小程序, 來演示 va_list 的用法, 定義一個barycentre 函數, 計算 n 個點的重心並返回, 聲明如下:

 
point barycentre(int n , ... );

其中point為描述二維點坐標的結構體:

 
struct {
        double x,y;
}point;

函數體是這樣的:

 
struct point barycentre(int n, ... )
{
    int i;
    struct point t;
    struct point sum={0};
    va_list listPointer;
    va_start(listPointer, n);
    for(i=0;i<n;i++){
        t=va_arg(listPointer,struct point);
        sum.x+=t.x;
        sum.y+=t.y;
    }
    sum.x/=n;
    sum.y/=n;
    va_end(listPointer);
    return sum;
}

在以上函數中, 用到了以下幾個宏:

  • va_list
  • va_start
  • va_arg
  • va_end

va_list 用來定義一個變量列表的指針類型.
va_start(listPointer, n) 的意思是將 listPointer 這個指針綁定到有 n 個變量的傳入參數列表上.
va_arg(listPointer, type) 從參數列表中逐個取出數據, 取出數據的類型由 type 決定, 它返回這個 type 類型的值, 你可以馬上把它賦值給另一個變量.
當函數調用結束的時候, 要記得使用 va_end 來清除 listPointer 指向的空間, 否則會發生內存泄漏問題.

可能你有兩個問題要問:

  • 1. 必須知道傳入參數的個數嗎?
  • 答: 是的, 若沒有參數個數, va_start 的時候就無法綁定.
  • 2. 必須向上面的例子中那樣所有的可變參數都是同一個類型嗎?
  • 答: 不是這樣, 想想 printf 函數, 它通過一個 char * format 格式字符串, 不僅確定了參數個數, 還確定了每個參數的類型(通過 %d 這樣的轉換單元), 這樣只要在 va_arg 的時候采用適當的 type 類型就可讀出各種類型的參數.

以下是程序的完全版, 隨機生成了3個二維點的坐標, 並傳遞給 barycentre 得到它的重心.

#include <stdio.h> #include <stdarg.h> #include <stdlib.h>
struct point{ double x,y; }; struct point barycentre(int n, ... ) { int i; struct point t; struct point sum={0}; va_list listPointer; va_start(listPointer, n); for(i=0;i<n;i++){ t=va_arg(listPointer,struct point); sum.x+=t.x; sum.y+=t.y; } sum.x/=n; sum.y/=n; va_end(listPointer); return sum; } int main() { struct point a,b,c,bc; a.x=rand()%1000/100.0; a.y=rand()%1000/100.0; b.x=rand()%1000/100.0; b.y=rand()%1000/100.0; c.x=rand()%1000/100.0; c.y=rand()%1000/100.0; bc=barycentre(3,a,b,c); printf("The barycentre of the 3 points is (%f,%f).\n",bc.x,bc.y); return 0; }

 

va_list、va_start、va_arg、va_end宏的使用

當你的函數的參數個數不確定時,就可以使用上述宏進行動態處理,這無疑為你的程序增加了靈活性。
 
Example:
 
◎用法1:
func( Type para1, Type para2, Type para3, ... )
{
    /****** Step 1 ******/
    va_list ap;
    va_start( ap, para3 ); //一定要“...”之前的那個參數
   
    /****** Step 2 ******/
    //此時ap指向第一個可變參數
    //調用va_arg取得里面的值
    Type xx = va_arg( ap, Type );
   
    //Type一定要相同,如:
    //char *p = va_arg( ap, char *);
    //int i = va_arg( ap, int );
    //如果有多個參數繼續調用va_arg
    /****** Step 3 ******/
    va_end(ap); //For robust!
}
◎用法2:
 
CString AppendString(CString str1,...)//一個連接字符串的函數,參數個數可以動態變化
{
      LPCTSTR str=str1;//str需為指針類型,因為va_arg宏返回的是你的參數的指針,但是如果你的參數為int等簡                       //單類型,則不必為指針,因為變量名實際上即是指針。
      CString res;
      va_list marker;     //你的類型鏈表
      va_start(marker,str1);//初始化你的marker鏈表
 
      while(str!="ListEnd")//ListEnd:參數的結束標志,十分重要,在實際中需自行指定
      {
          res+=str;
          str=va_arg(marker,CString);//取得下一個指針
      }
      va_end(marker);//結束,與va_start合用
      return res;
}
 
int main()
{
      CString    str=AppendString("xu","zhi","hong","ListEnd");
      cout<<str.GetBuffer(str.GetLength())<<endl;
      return 0;
}
 
輸出xuzhihong
CString AppendString(CString str1,...),因為連接字符串的參數可以動態變化,你不知用戶要進行連接的字符串個數是多少,所以你可以用…來代替。但是要注意的是你的函數要有一 個參數作為標志來表示結束,否則會出錯。在上例中用ListEnd作為結束符。還有va_arg返回的是你參數內容的指針。上例在支持MFC程序的 console下運行通過。
 
可變參數函數的原型聲明格式為:
 
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函數的實現就是對參數指針的使用和控制。
 
 
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()對字符串的處理用'\0'作為結束標 志,無法想象C中的字符串如果沒有'\0', 代碼將會是怎樣一番情景,估計那時最流行的可能是字符數組,或者是malloc/free。
 
允許對內存的隨意訪問,會留給不懷好意者留下攻擊的可能。當處理cracker精心設計好的一串字符串后,程序將跳轉到一些惡意代碼區域執行,以使cracker達到其攻擊目的。(常見的exploit攻擊)所以,必需禁止對內存的隨意訪問和嚴格控制內存訪問邊界。
 
有關va_list和vsnprintf輸出函數的問題
來源: ChinaUnix博客  日期:2006.11.16 12:36 (共有0條評論) 我要評論
 
va_list ap;                //聲明一個變量來轉換參數列表
va_start(ap,fmt);             //初始化變量
va_end(ap);                   //結束變量列表,和va_start成對使用
可以根據va_arg(ap,type)取出參數
已經經過調試成功的輸出程序

#include #include #define bufsize 80
char buffer[bufsize]; int vspf(char *fmt, ...) { va_list argptr; int cnt; va_start(argptr, fmt); cnt = vsnprintf(buffer,bufsize ,fmt, argptr); va_end(argptr); return(cnt); } int main(void) { int inumber = 30; float fnumber = 90.0; char string[4] = "abc"; vspf("%d %f %s", inumber, fnumber, string); printf("%s\n", buffer); return 0; } 

 

 

 

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


void myprintf(const char *ptr, ...); int main(int argc, const char *argv[]) { myprintf("%s, %d\n","pengdonglin", 9); return 0; } void myprintf(const char *ptr, ...) { char ch; va_list argptr; va_start(argptr, ptr); while((ch = *ptr++)) { if(ch == '%') { ch = *ptr++; if(ch == 's') { char *p = va_arg(argptr, char *); while(*p) { putchar (*p++); } } else if(ch == 'd') { int p = va_arg(argptr, int); putchar(p +'0'); } } else { putchar(ch); } } va_end(argptr); }

 

 

 

 

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM