前言:
本文在很大程度上改編自網友kevintz的“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函數
先看例子程序。該函數至少有一個整數參數,其後是佔位符…,表示後面參數的個數不定. 在這個例子裏,所有的輸入參數必須都是整數,函數的功能是打印所有參數的值.
函數代碼如下:
//示例代碼1:可變參數函數的使用
#include "stdio.h "
#include "stdarg.h "
void simple_va_fun(int start, ...)
{
va_list arg_ptr;
int nArgValue =start;
int nArgCout=0; //可變參數的數目
va_start(arg_ptr,start); //以固定參數的地址爲起點確定變參的內存起始地址。
do
{
++nArgCout;
printf( "the %d th arg: %d\n ",nArgCout,nArgValue); //輸出各參數的值
nArgValue = va_arg(arg_ptr,int); //得到下一個可變參數的值
} while(nArgValue != -1);
return;
}
int main(int argc, char* argv[])
{
simple_va_fun(100,-1);
simple_va_fun(100,200,-1);
return 0;
}
從這個函數的實現可以看到,我們使用可變參數應該有以下步驟:
⑴在程序中將用到以下這些宏:
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中,所以用到可變參數的程序應該包含這個頭文件.
⑵函數裏首先定義一個va_list型的變量,這裏是arg_ptr,這個變量是指向參數地址的指針.因爲得到參數的地址之後,再結合參數的類型,才能得到參數的值。
⑶然後用va_start宏初始化⑵中定義的變量arg_ptr,這個宏的第二個參數是可變參數列表的前一個參數,也就是最後一個固定參數。
⑷然後依次用va_arg宏使arg_ptr返回可變參數的地址,得到這個地址之後,結合參數的類型,就可以得到參數的值。然後進行輸出。
⑸設定結束條件,這裏的條件就是判斷參數值是否爲-1。注意被調的函數在調用時是不知道可變參數的正確數目的,程序員必須自己在代碼中指明結束條件。至於爲什麼它不會知道參數的數目,讀者在看完下面這幾個宏的內部實現機制後,自然就會明白。
三、可變參數在編譯器中的處理
我們知道va_start,va_arg,va_end是在stdarg.h中被定義成宏的, 由於1)硬件平臺的不同 2)編譯器的不同,所以定義的宏也有所不同,下面看一下VC++6.0中stdarg.h裏的代碼(文件的路徑爲VC安裝目錄下的\vc98\include\stdarg.h)
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 )
下面我們解釋這些代碼的含義:
1、首先把va_list被定義成char*,這是因爲在我們目前所用的PC機上,字符指針類型可以用來存儲內存單元地址。而在有的機器上va_list是被定義成void*的
2、定義_INTSIZEOF(n)主要是爲了某些需要內存的對齊的系統.這個宏的目的是爲了得到最後一個固定參數的實際內存大小。在我的機器上直接用sizeof運算符來代替,對程序的運行結構也沒有影響。(後文將看到我自己的實現)。
3、va_start的定義爲&v+_INTSIZEOF(v),而&v是最後一個固定參數的起始地址,再加上其大小後,就得到了第一個可變參數的起始內存地址。所以我們運行va_start(ap, v)以後,ap指向第一個可變參數在的內存地址,有了這個地址,以後的事情就簡單了。
這裏要知道兩個事情:
⑴在intel+windows的機器上,函數棧的方向是向下的,棧頂指針的內存地址低於棧底指針,所以先進棧的數據是存放在內存的高地址處。
(2)在VC等絕大多數C編譯器中,參數進棧的順序是由右向左的,因此,
參數進棧以後的內存模型如下圖所示:最後一個固定參數的地址正好位於第一個可變參數之下,並且是連續存儲的。
|—— —————————————|
| 最後一個固定參數 | -> 高內存地址處
|— ——————————————|
........................
|-------------------------------|
| 第N個可變參數 | -> va_arg(arg_ptr,datatype)後arg_ptr所指的地方
|-------------------------------|
...................
|——— ————————————|
| 第一個可變參數 | -> va_start(arg_ptr,start)後arg_ptr所指的地方
| | 即第一個可變參數的地址
|——————————————— |
|————————————— ——|
| |
| 最後一個固定參數 | -> start的起始地址
|—————————————— —|
...............
|——————————————- |
| |
|——————————————— | -> 低內存地址處
(4) va_arg():有了va_start的良好基礎,我們取得了第一個可變參數的地址,在va_arg()裏的任務就是根據指定的參數類型取得本參數的值,並且把指針調到下一個參數的起始地址。
因此,現在再來看va_arg()的實現就應該心中有數了:
#define va_arg(ap,t) ( *(t *)((ap += _INTSIZEOF(t)) - _INTSIZEOF(t)) )
這個宏做了兩個事情,
①用用戶輸入的類型對參數地址進行強制類型轉換,得到用戶所需要的值
②計算出本參數的實際大小,將指針調到本參數的結尾,也就是下一個參數的首地址,以便後續處理。
(5)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 的來獲取可變參數的.也就是說,你想實現智能識別可變參數的話是要通過在自己的程序裏作判斷來實現的. 例如,在C的經典教材《the c programming》的7.3節中就給出了一個printf的可能實現方式,由於篇幅原因這裏不再敘述。
五、小結:
1、標準C庫的中的三個宏的作用只是用來確定可變參數列表中每個參數的內存地址,編譯器是不知道參數的實際數目的。
2、在實際應用的代碼中,程序員必須自己考慮確定參數數目的辦法,如
⑴在固定參數中設標誌—— printf函數就是用這個辦法。後面也有例子。
⑵在預先設定一個特殊的結束標記,就是說多輸入一個可變參數,調用時要將最後一個可變參數的值設置成這個特殊的值,在函數體中根據這個值判斷是否達到參數的結尾。本文前面的代碼就是採用這個辦法——當可變參數的值爲-1時,即認爲得到參數列表的結尾。
無論採用哪種辦法,程序員都應該在文檔中告訴調用者自己的約定。這是一個不太方便
3、實現可變參數的要點就是想辦法取得每個參數的地址,取得地址的辦法由以下幾個因素決定:
①函數棧的生長方向
②參數的入棧順序
③CPU的對齊方式
④內存地址的表達方式
結合源代碼,我們可以看出va_list的實現是由④決定的,_INTSIZEOF(n)的引入則是由③決定的,他和①②又一起決定了va_start的實現,最後va_end的存在則是良好編程風格的體現—將不再使用的指針設爲NULL,這樣可以防止以後的誤操作。
4、取得地址後,再結合參數的類型,程序員就可以正確的處理參數了。理解了以上要點,相信有經驗的讀者就可以寫出適合於自己機器的實現來。下面就是一個例子
六、實踐——自己實現簡單的可變參數的函數。
下面是一個簡單的printf函數的實現,參考了 <The C programming language> 中的156頁的例子,讀者可以結合書上的代碼與本文參照。
#include "stdio.h "
#include "stdlib.h "
void myprintf(char* fmt, ...) //一個簡單的類似於printf的實現,參數必須都是int 類型
{
char* pArg=NULL; //等價於原來的va_list
char c;
pArg = &fmt; //注意不要寫成p = fmt !!因爲這裏要對參數取址,而不是取值
pArg += sizeof(fmt); //等價於原來的va_start
do
{
c =*fmt;
if (c != '% ')
{
putchar(c); //照原樣輸出字符
}
else
{
//按格式字符輸出數據
switch(*++fmt)
{
case 'd ':
printf( "%d ",*((int*)pArg));
break;
case 'x ':
printf( "%#x ",*((int*)pArg));
break;
default:
break;
}
pArg += sizeof(int); //等價於原來的va_arg
}
++fmt;
}while (*fmt != '\0 ');
pArg = NULL; //等價於va_end
return;
}
int main(int argc, char* argv[])
{
int i = 1234;
int j = 5678;
myprintf( "the first test:i=%d\n ",i,j);
myprintf( "the secend test:i=%d; %x;j=%d;\n ",i,0xabcd,j);
system( "pause ");
return 0;
}
在intel+win2k+vc6的機器執行結果如下:
the first test:i=1234
the secend test:i=1234; 0xabcd;j=5678;