C/C++中用va_start/va_arg/va_end实现可变参数函数的原理与实例详解

2024-01-09 21:58

本文主要是介绍C/C++中用va_start/va_arg/va_end实现可变参数函数的原理与实例详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

        在C/C++中,我们经常会用到可变参数的函数(比如printf/snprintf等),本篇笔记旨在讲解编译器借助va_start/va_arg/va_end这簇宏来实现可变参数函数的原理,并在文末给出简单的实例。
        备注:本文的分析适用于Linux/Windows,其它操作系统平台的可变参数函数的实现原理大体相似。

1. 基础知识
        如果想要真正理解可变参数函数背后的运行机制,建议先理解两部分基础内容:
         1)函数调用栈
         2)函数调用约定
        关于这两个基础知识点,我之前的笔记有详细介绍,感兴趣的童鞋可以移步这里:栈与函数调用惯例—上篇 和栈与函数调用惯例—下篇

2. 三个宏:va_start/va_arg/va_end
        由man va_start可知,这簇宏定义在stdarg.h中,在我的测试机器上,该头文件路径为:/usr/lib/gcc/x86_64-redhat-linux/3.4.5/include/stdarg.h,在gcc源码中,其路径为:gcc/include/stdarg.h。
        在stdarg.h中,宏定义的相关代码如下:

    #define va_start(v,l)  __builtin_va_start(v,l)#define va_end(v)      __builtin_va_end(v)#define va_arg(v,l)    __builtin_va_arg(v,l)#if !defined(__STRICT_ANSI__) || __STDC_VERSION__ + 0 >= 199900L#define va_copy(d,s)    __builtin_va_copy(d,s)#endif#define __va_copy(d,s)  __builtin_va_copy(d,s)
        其中,前3行就是我们所关心的va_start & var_arg & var_end的定义(至于va_copy,man中有所提及,但通常不会用到,想了解的同学可man查看之)。可见,gcc将它们定义为一组builtin函数。
        关于这组builtin函数的实现代码,我曾试图在gcc源码中沿着调用路径往下探索,无奈gcc为实现这组builtin函数引入了很多自定义的数据结构和宏,对非编译器研究者的我来说,实在有点晦涩,最终探索过程无疾而终。在这里,我列出目前跟踪到的调用路径,以便有兴趣的童鞋能继续探索下去或指出我的不足,先在此谢过。
        __builtin_va_start()函数的调用路径:
// file: gcc/builtins.c
/* The "standard" implementation of va_start: just assign `nextarg' to the variable.  */
void std_expand_builtin_va_start (tree valist, rtx nextarg)                        
{                                                                             rtx va_r = expand_expr (valist, NULL_RTX, VOIDmode, EXPAND_WRITE);convert_move (va_r, nextarg, 0);  // definition is in gcc/expr.c
}
// 上述代码中调用了expand_expr()来展开表达式,我猜测该函数调用完后,va_list指向了可变参数list前的最后一个已知类型参数
//  file: gcc/expr.h
/* Generate code for computing expression EXP.An rtx for the computed value is returned.  The value is never null.In the case of a void EXP, const0_rtx is returned.  
*/
static inline rtx expand_expr (tree exp, rtx target, enum machine_mode mode,enum expand_modifier modifier)
{return expand_expr_real (exp, target, mode, modifier, NULL);
}

3. Windows系统VS内置编译器对va_start/va_arg/va_end的实现
        如前所述,我
没能 在gcc源码中 找出va_startva_arg/va_end这3个宏的实现代码(⊙﹏⊙b汗),所幸的是,Windows平台VS2008集成的编译器中,对这三个函数有很明确的实现代码,摘出如下。
/* file path: Microsoft Visual Studio 9.0\VC\include\stdarg.h */
#include <vadefs.h>#define va_start _crt_va_start
#define va_arg _crt_va_arg
#define va_end _crt_va_end
        可见,Windows系统下,仍然将va_start/va_arg/va_end定义为一组宏。他们对应的实现在vadefs.h中:
/* file path: Microsoft Visual Studio 9.0\VC\include\vadefs.h */
#ifdef  __cplusplus
#define _ADDRESSOF(v)   ( &reinterpret_cast<const char &>(v) )
#else
#define _ADDRESSOF(v)   ( &(v) )
#endif#define _INTSIZEOF(n)   ( (sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1) )#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 )
        备注:在VS2008提供的vadefs.h文件中,定义了若干组宏以支持不同的操作系统平台,上面摘出的代码片段是针对IA x86_32的实现。
        下面对上面的代码做个解释:
          a. 宏_ADDRESSOF(v)作用:取参数v的地址。
          b. 宏_INTSIZEOF(n)作用:返回参数n的size并保证4字节对齐(32-bits平台)。这个宏应用了一个 小技巧来实现字节对齐: ~(sizeof(int) - 1)的值对应的2进制值的低k位一定是0,其中sizeof(int) = 2^k,因此,在IA x86_32下,k=2。理解了这一点,那么(sizeof(n) + sizeof(int) - 1) & ~(sizeof(int) - 1)的作用就很直观了,它保证了sizeof(n)的值按sizeof(int)的值做对齐,例如在32-bits平台下,就是按4字节对齐;在64-bits平台下,按8字节对齐。至于为什么要保证对齐,与编译器的底层实现有关,这里不再展开。
          c. _crt_va_start(ap,v)作用:通过v的内存地址来计算ap的起始地址,其中,v是可变参数函数的参数中, 最后一个类型已知的参数,执行的结果是ap指向可变参数列表的第1个参数。以int snprintf(char *str, size_t size, const char *format, ...)为例,其函数参数列表中最后一个已知类型的参数是const char *format,因此,参数format对应的就是_crt_va_start(ap, v)中的v, 而ap则指向传入的第1个可变参数。
        特别需要理解的是:为什么ap = address(v) + sizeof(v),这与 函数栈从高地址向低地址的增长方向函数调用时参数从右向左的压栈顺序有关,这里默认大家已经搞清楚了这些基础知识,不再展开详述。
          d. _crt_va_arg(ap,t)作用:更新指针ap后,取类型为t的变量的值并返回该值。
          e. _crt_va_end(ap)作用:指针ap置0,防止野指针。
        概括来说,可变参数函数的实现原理是:
         1)根据函数参数列表中最后一个已知类型的参数地址,得到可变参数列表的第一个可变参数
         2)根据程序员指定的每个可变参数的类型,通过地址及参数类型的size获取该参数值
         3)遍历,直到访问完所有的可变参数
        从上面的实现过程可以注意到, 可变参数的函数实现严重依赖于函数栈及函数调用约定(主要是参数压栈顺序),同时,依赖于程序员指定的可变参数类型 因此,若指定的参数类型与实际提供的参数类型不符时,程序出core简直就是一定的。

4. 程序实例
        经过上面对可变参数函数实现机制的分析,很容易实现一个带可变参数的函数。程序实例如下:

#include <stdio.h>
#include <stdarg.h>void foo(char *fmt, ...) 
{va_list ap;int d;char c, *p, *s;va_start(ap, fmt);while (*fmt) {if('%' == *fmt) {switch(*(++fmt)) {case 's': /* string */s = va_arg(ap, char *);printf("%s", s);break;case 'd': /* int */d = va_arg(ap, int);printf("%d", d);break;case 'c': /* char *//* need a cast here since va_arg only takes fully promoted types */c = (char) va_arg(ap, int);printf("%c", c);break;default:c = *fmt;printf("%c", c);}  // end of switch}  else {c = *fmt;printf("%c", c);}++fmt;}va_end(ap);
}int main(int argc, char * argv[])
{foo("sdccds%%, string=%s, int=%d, char=%c\n", "hello world", 211, 'k');return 0;
}

        上面的代码很简单,旨在抛砖引玉,只要真正搞清楚了可变参数函数的原理,相信各位会写出更加复杂精细的可变参函数。
         ^_^

【参考资料】
1. linux man : va_start
2. wikipedia - x86 calling conventions
3. VS2008头文件:stdarg.h和vadefs.h的源码

================== EOF =================


这篇关于C/C++中用va_start/va_arg/va_end实现可变参数函数的原理与实例详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/588560

相关文章

MySQL 中的 JSON 查询案例详解

《MySQL中的JSON查询案例详解》:本文主要介绍MySQL的JSON查询的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录mysql 的 jsON 路径格式基本结构路径组件详解特殊语法元素实际示例简单路径复杂路径简写操作符注意MySQL 的 J

pandas中位数填充空值的实现示例

《pandas中位数填充空值的实现示例》中位数填充是一种简单而有效的方法,用于填充数据集中缺失的值,本文就来介绍一下pandas中位数填充空值的实现,具有一定的参考价值,感兴趣的可以了解一下... 目录什么是中位数填充?为什么选择中位数填充?示例数据结果分析完整代码总结在数据分析和机器学习过程中,处理缺失数

Golang HashMap实现原理解析

《GolangHashMap实现原理解析》HashMap是一种基于哈希表实现的键值对存储结构,它通过哈希函数将键映射到数组的索引位置,支持高效的插入、查找和删除操作,:本文主要介绍GolangH... 目录HashMap是一种基于哈希表实现的键值对存储结构,它通过哈希函数将键映射到数组的索引位置,支持

Pandas使用AdaBoost进行分类的实现

《Pandas使用AdaBoost进行分类的实现》Pandas和AdaBoost分类算法,可以高效地进行数据预处理和分类任务,本文主要介绍了Pandas使用AdaBoost进行分类的实现,具有一定的参... 目录什么是 AdaBoost?使用 AdaBoost 的步骤安装必要的库步骤一:数据准备步骤二:模型

使用Pandas进行均值填充的实现

《使用Pandas进行均值填充的实现》缺失数据(NaN值)是一个常见的问题,我们可以通过多种方法来处理缺失数据,其中一种常用的方法是均值填充,本文主要介绍了使用Pandas进行均值填充的实现,感兴趣的... 目录什么是均值填充?为什么选择均值填充?均值填充的步骤实际代码示例总结在数据分析和处理过程中,缺失数

Java对象转换的实现方式汇总

《Java对象转换的实现方式汇总》:本文主要介绍Java对象转换的多种实现方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Java对象转换的多种实现方式1. 手动映射(Manual Mapping)2. Builder模式3. 工具类辅助映

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

Go语言开发实现查询IP信息的MCP服务器

《Go语言开发实现查询IP信息的MCP服务器》随着MCP的快速普及和广泛应用,MCP服务器也层出不穷,本文将详细介绍如何在Go语言中使用go-mcp库来开发一个查询IP信息的MCP... 目录前言mcp-ip-geo 服务器目录结构说明查询 IP 信息功能实现工具实现工具管理查询单个 IP 信息工具的实现服

Python的time模块一些常用功能(各种与时间相关的函数)

《Python的time模块一些常用功能(各种与时间相关的函数)》Python的time模块提供了各种与时间相关的函数,包括获取当前时间、处理时间间隔、执行时间测量等,:本文主要介绍Python的... 目录1. 获取当前时间2. 时间格式化3. 延时执行4. 时间戳运算5. 计算代码执行时间6. 转换为指

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商(如阿里云、腾讯云、华为云)后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置(application.yml)配置类绑定短信发送策略接口示例:阿里云 & 腾