C 语言函数变长参数

发布于 2021-07-12  0 次阅读


定义

变长参数,顾名思义,就是函数的参数长度(数量)是可变的。比如 C 语言的 printf() 系列的函数,都是参数可变的。

例如下列函数的声明:

int printf(const char* format,...);
void myFunc(int arg1, float arg2, int arg, ...);

可变参数函数声明方式都是类似的。

实现

C 语言可变参数通过三个宏(va_startva_endva_arg)和一个类型(va_list)实现的。

在变长参数函数的实现部分,可以使用 stdarg.h 头文件里面的多个宏来访问各个额外的参数,假设 lastarg 是变长参数函数的最后一个具名参数(例如 printf 里的 format,myFunc 里的 arg)。

  1. 首先定义类型为 va_list 的变量:
    va_list ap;
    

    该变量以后将会依次指向各个额外的变量参数。

  2. 其次 ap 必须用宏 va_start 初始化

    va_start(ap);                 //初始化指针
    

    此时ap指向额外参数的第一个参数。

    void va_start ( va_list ap, paramN ); 有两个参数

    ap: 可变参数列表地址
    paramN: 确定的参数

  3. 使用宏 va_arg 取得当前 ap 指向的参数的值,并使 ap 指向下一个参数

    int next = va_arg(ap);        //假设此时的参数类型为int型
    
  4. 最后使用宏 va_end 将指针 ap 置零
    va_end(ap);                   //指针清零
    

即用 va_start 获取参数列表(的地址)存储到 ap 中,用 va_arg 逐个获取值,最后用 va_end 将 ap 置空。

例子

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

void HandleVarargs(int arg_count, ...) {
  // 1. 定义 va_list 用于获取我们变长参数
  va_list args;

  // 2. 开始遍历
  va_start(args, arg_count);
  for (int i = 0; i < arg_count; ++i) {
    // 3. 取出对应参数,(va_list, type)
    int arg = va_arg(args, int);
    printf("%d: %d\n", i, arg);
  }

  // 4. 结束遍历
  va_end(args);
}

int main(void) {
  printf("Hello World\n");

  HandleVarargs(4, 1, 2, 3.0, 4);
  return 0;
}

/**
 * Hello World
 * 0: 1
 * 1: 2
 * 2: 0
 * 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 之外,其他都很好理解,举个例子吧:

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

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

既然 sizeof 和 _INTSIZEOF 值一样,为什么不直接用 sizeof 呢?干嘛要写的那么复杂?答案是为了字节对齐(无论32位还是64位机器,sizeof(int)永远代表机器的位数,明白了吧!

现在再去看变长参数的实现:其实就是把参数在栈中的地址记录到 ap 中(通过一个确定参数 paramN 确定地址),然后逐个读取值。

此时是否有一种豁然开朗的感觉?至少明白了许多,也清楚了很多。

扩展

简单介绍两种函数调用约定

``__stdcall` (C++默认)

  1. 参数从右向左压入堆栈
  2. 函数被调用者修改堆栈
  3. 函数名(在编译器这个层次)自动加前导的下划线,后面紧跟一个 @ 符号,其后紧跟着参数的尺寸

``__cdecl` (C语言默认)

  1. 参数从右向左压入堆栈
  2. 参数由调用者清楚,手动清栈,被调用函数不会要求调用者传递多少参数,调用者传递过多或者过少的参数,甚至完全不同的参数都不会产生编译阶段的错误。

那么,变参函数的调用方式为(也只能是):__cdecl

参考

  1. 深度探索C语言函数可变长参数

  2. C语言中变长参数类型


大变に气分がいい