前言
VA_LIST 解决变参问题的一组宏，所在头文件：
#include，用于获取不确定个数的参数
比如我们最常用的 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_startva_endva_argva_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 错误捕获等功能）