va_list 可变参数概览

前言

VA_LIST 解决变参问题的一组宏，所在头文件：#include <stdarg.h>，用于获取不确定个数的参数

比如我们最常用的 NSLog方法

NSLog(NSString *format, ...)
// 我们可以这样调用
//NSLog("output %d %d %d", 1, 2, 3)

其中末尾 ... 表明允许输入可变参数，而我们可以使用 va_list 来获取具体参数，本文带大家聊一下可变参数的基本用法.

用法

头文件

#ifndef __STDARG_H
#define __STDARG_H

#ifndef _VA_LIST
typedef __builtin_va_list va_list;
#define _VA_LIST
#endif
#define va_start(ap, param) __builtin_va_start(ap, param)
#define va_end(ap)          __builtin_va_end(ap)
#define va_arg(ap, type)    __builtin_va_arg(ap, type)

/* GCC always defines __va_copy, but does not define va_copy unless in c99 mode
 * or -ansi is not specified, since it was not part of C90.
 */
#define __va_copy(d,s) __builtin_va_copy(d,s)

#if __STDC_VERSION__ >= 199901L || __cplusplus >= 201103L || !defined(__STRICT_ANSI__)
#define va_copy(dest, src)  __builtin_va_copy(dest, src)
#endif

#ifndef __GNUC_VA_LIST
#define __GNUC_VA_LIST 1
typedef __builtin_va_list __gnuc_va_list;
#endif

#endif /* __STDARG_H */

大致就四个函数

va_start
va_end
va_arg
va_copy

接下来我们来实现一个简单的NSLog函数

FOUNDATION_EXTERN void MLog(const char * format, ...)
{
    va_list args;

    va_start(args, format);

    NSString *formatter = [NSString stringWithUTF8String:format];
    NSString *message = [[NSString alloc] initWithFormat:formatter arguments:args];
    
    va_end(args);
    
    NSLog(@"%@", message);
}

...

// 调用
 MLog("打印 %d %d %d", 1, 2, 3);

// 输出
2020-03-26 15:26:16.162584+0800 Supervisor_Example[78378:6787730] 打印 1 2 3

如果我们要逐个获取参数调用对应次数的参数即可

//  对于MLog("打印 %d %d %d", 1, 2, 3); 此次调用，有三个可变参数

FOUNDATION_EXTERN void MLog(const char * format, ...)
{
        
    // 指针指向 format 之后的参数
    va_start(args, format);

    // 获取int型参数，并指向下一个参数
    int a = va_arg(args, int);
    // 获取int型参数，并指向下一个参数
    int b = va_arg(args, int);
    // 获取int型参数，并指向下一个参数
    int c = va_arg(args, int);

    // 清空va_list可变参数列表
    va_end(args);
    ...
}

...

打印a，b, c结果

a   int 1
b   int 2
c   int 3

大致用法就是这样

数据结构

我们已经学会了 va_list 的基本用法，接下来聊一点更深入的

我们在 va_start(args, format)之后打个断点, 控制台打印一下

Printing description of args:
(va_list) args = {
  [0] = (gp_offset = 8, 
        fp_offset = 48, 
        overflow_arg_area = 0x00007ffee59e15a0, 
        reg_save_area = 0x00007ffee59e1480)
}

我们发现 va_list 是一个长度为1的结构体, 如下

typedef struct {
   unsigned int gp_offset; // 表示整形或者指针类型参数相对reg_save_area的偏移量, 最大值为 48 (6 ∗ 8)
   unsigned int fp_offset; // 表示浮点型参数相对 overflow_arg_area 的偏移量，最大值为 224 (6 ∗ 8 + 11 ∗ 16)
   void *overflow_arg_area; // 栈上的参数的起始地址，在被初始化的时候指向栈上的第一个参数
   void *reg_save_area; // 函数参数列表的起始地址
} va_list[1];

取参数的时候，整形或者指针类型, 如果 gp_offset 不到 48 就从 reg_save_area + gp_offset 的位置取值，
并且把 gp_offset 加 8，否则就从 overflow_arg_area 取值并且把 overflow_arg_area 加 8
如果是取浮点参数，如果 fp_offset 不到 176+48 ，就会从reg_save_area + fp_offset的位置取值，并且把fp_offset加16，否则就是从 overflow_arg_area 取值并且把 overflow_arg_area 加16.

我们来验证一下

// 调用代码

MLog("打印 %f %@ %d %f %f %f %f %f %f %f %f %f", 0.1, @"测试", 1, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0);

// 获取参数代码
FOUNDATION_EXTERN void MLog(const char * format, ...)
{
    va_list args;

    va_start(args, format);
    
    float a = va_arg(args, float); // 断点1
    NSString *b = va_arg(args, NSString *);// 断点2
    int c = va_arg(args, int);// 断点3
    float ft = va_arg(args, float);//断点4
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ft = va_arg(args, float);
    ...
}

// 打印 va_list

// 断点1 初始化
(va_list) args = {
  [0] = (gp_offset = 8, fp_offset = 48, overflow_arg_area = 0x00007ffee3707590, reg_save_area = 0x00007ffee3707470)
}
// 断点2 获取 float型参数  fp_offset + 16
Printing description of args:
(va_list) args = {
  [0] = (gp_offset = 8, fp_offset = 64, overflow_arg_area = 0x00007ffee3707590, reg_save_area = 0x00007ffee3707470)
}
// 断点3  获取 NSString* 指针型参数 gp_offset + 8
Printing description of args:
(va_list) args = {
  [0] = (gp_offset = 16, fp_offset = 64, overflow_arg_area = 0x00007ffee3707590, reg_save_area = 0x00007ffee3707470)
}
// 断点4  获取 int 指针型参数 gp_offset + 8
Printing description of args:
(va_list) args = {
  [0] = (gp_offset = 24, fp_offset = 64, overflow_arg_area = 0x00007ffee3707590, reg_save_area = 0x00007ffee3707470)
}

上文11 * 16 = 176数字是使用模拟器测试出来的, 真机无法打印，可能会不太一样，这里就不做测试了，模拟器测试代码和结果如下

// va_list 结构体
typedef struct {
    
   unsigned int gp_offset;
   unsigned int fp_offset;
   void *overflow_arg_area;
   void *reg_save_area;
} __va_list;

// 打印  __va_list
void PrintVAList(__va_list *va)
{
    NSLog(@"gp_offset: %d fp_offset: %d, overflow_arg_area: %p, reg_save_area: %p", va->gp_offset,
          va->fp_offset,
          va->overflow_arg_area,
          va->reg_save_area);
}

// 执行代码
FOUNDATION_EXTERN void MLog(const char * format, ...)
{
    va_list args;

    va_start(args, format);
    
    float a = va_arg(args, float);
    PrintVAList((__va_list *)args);
    
    NSString *b = va_arg(args, NSString *);
    PrintVAList((__va_list *)args);
    
    int c = va_arg(args, int);
    PrintVAList((__va_list *)args);
    c = va_arg(args, int);
    PrintVAList((__va_list *)args);
    c = va_arg(args, int);
    PrintVAList((__va_list *)args);
    c = va_arg(args, int);
    PrintVAList((__va_list *)args);
    float ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
    ft = va_arg(args, float);
    PrintVAList((__va_list *)args);
}

// 打印代码
MLog("打印 %f %@ %d %d %d %d %f %f %f %f %f %f %f %f %f %f", 0.1, @"测试", 1, 2, 3, 4, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1, 1.1);

// 打印结果
2020-03-26 17:01:29.401398+0800 Supervisor_Example[82578:7119253] gp_offset: 8 fp_offset: 64, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.401506+0800 Supervisor_Example[82578:7119253] gp_offset: 16 fp_offset: 64, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.401601+0800 Supervisor_Example[82578:7119253] gp_offset: 24 fp_offset: 64, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.401674+0800 Supervisor_Example[82578:7119253] gp_offset: 32 fp_offset: 64, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.401736+0800 Supervisor_Example[82578:7119253] gp_offset: 40 fp_offset: 64, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.401798+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 64, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.401856+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 80, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.410604+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 96, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.410707+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 112, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.410779+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 128, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.410852+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 144, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.410932+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 160, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.411010+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 176, overflow_arg_area: 0x7ffee1a23580, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.411087+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 176, overflow_arg_area: 0x7ffee1a23588, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.411159+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 176, overflow_arg_area: 0x7ffee1a23590, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.411233+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 176, overflow_arg_area: 0x7ffee1a23598, reg_save_area: 0x7ffee1a23460
2020-03-26 17:01:29.411360+0800 Supervisor_Example[82578:7119253] gp_offset: 48 fp_offset: 176, overflow_arg_area: 0x7ffee1a235a0, reg_save_area: 0x7ffee1a23460

That is all

感谢

[参考] c/c++ 里面的变长参数的实现
[参考] What is the format of the x86_64 va_list structure?

另外

最近https://github.com/madaoCN/Supervisor
间断的会更新一些代码（已实现hook NSLog，print，fprintf，oc/swift 错误捕获等功能）

最后编辑于：2020.03.26 17:11:57

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 194,088评论 5赞 459
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 81,715评论 2赞 371
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 141,361评论 0赞 319
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 52,099评论 1赞 263
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 60,987评论 4赞 355
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 46,063评论 1赞 272
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 36,486评论 3赞 381
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 35,175评论 0赞 253
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 39,440评论 1赞 290
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 34,518评论 2赞 309
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 36,305评论 1赞 326
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 32,190评论 3赞 312
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 37,550评论 3赞 298
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 28,880评论 0赞 17
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 30,152评论 1赞 250
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 41,451评论 2赞 341
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 40,637评论 2赞 335

va_list 可变参数概览

前言

用法

数据结构

感谢

另外

推荐阅读更多精彩内容