C- 可变参数的简单版实现

可变参数（variable argument），指的是函数能够接受可变数量的参数。在C语言中，这通过stdarg.h头文件提供的宏来实现。

1. 基本概念

可变参数函数是指那些参数数量和类型不固定的函数。例如，printf()就是一个可变参数函数，因为我们可以传递任意数量和类型的参数给它。

2. 定义可变参数函数

可变参数函数的声明要包含至少一个固定的参数，后跟省略号...。例如：

void my_function(int fixed_arg, ...);
1

3. 使用stdarg.h

stdarg.h定义了一组宏来处理可变参数列表：

• va_list: 用于声明一个变量，该变量将依次引用每个参数。
• va_start(ap, last_arg): 初始化ap变量，使其指向last_arg后的第一个参数。
• va_arg(ap, type): 返回当前参数并将ap移动到下一个参数。type是我们期望的参数类型。
• va_end(ap): 清理ap，在使用完参数后应该调用。

3.1 va_list

va_list 是用于访问可变参数函数中参数的类型。它在 C 和 C++ 中被定义为处理函数可变参数部分的一种类型。为了理解和使用 va_list，首先要理解可变参数函数是如何在内存中保存其参数的。

3.1.1 可变参数在内存中的布局

当调用一个函数时，其参数通常被推送到栈上。对于可变参数函数，固定的参数和可变的参数都被推到同一个栈上。在大多数体系结构中，最后一个固定参数在栈上的位置是已知的。因此，通过获取这个位置，我们可以遍历之后的参数，也就是可变参数。

3.1.2 va_list 的定义和原理

va_list 是一个在 stdarg.h 中定义的类型，通常是一个指针类型，但它的具体实现是特定于体系结构和编译器的。通常，它可能是一个指向栈上当前位置的指针。

3.1.3 使用 va_list

为了使用 va_list，我们首先需要声明一个 va_list 类型的变量。然后，使用 va_start 宏初始化它，这样它就指向了第一个可变参数。随后，可以使用 va_arg 宏来逐个访问可变参数。

3.1.4 示例

假设我们有一个函数，它有一个整数参数和随后的一些浮点数参数。我们可以使用 va_list 来遍历这些浮点数参数：

#include 
#include 

void print_floats(int count, ...) {
    va_list args;
    va_start(args, count);

    for (int i = 0; i < count; i++) {
        double value = va_arg(args, double);
        printf("%f ", value);
    }
    
    va_end(args);
    printf("\n");
}

int main() {
    print_floats(3, 1.0, 2.5, 3.75);
    return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在上述代码中，print_floats 函数接受一个整数 count 作为其固定参数，后跟 count 个浮点数作为可变参数。va_list 变量 args 用于访问这些浮点数参数。

3.1.5 总结

va_list 是一个为了访问和遍历可变参数而设计的数据类型。它通常是一个指向栈的指针，指向当前可变参数的位置。虽然它在高层次上相对简单，但在底层，其具体实现取决于特定的编译器和体系结构，因此通常隐藏在 stdarg.h 宏后面，为程序员提供一个清晰且跨平台的接口。

3.2 va_start

va_start 是C语言为处理可变参数函数提供的一个宏，定义在 stdarg.h 头文件中。它的主要作用是初始化 va_list 变量以便用来访问可变参数列表。

3.2.1 函数原型

void va_start(va_list ap, last);
1

其中：

• ap 是之前声明的 va_list 类型的变量。
• last 是可变参数列表前面的最后一个固定参数。

3.2.2 工作原理

当我们调用一个函数时，函数的参数通常被压入堆栈中（具体的调用约定和参数传递方式取决于平台和编译器设置）。对于可变参数函数，所有参数（固定参数和可变参数）都按照调用约定压入堆栈。

va_start 宏的主要任务是获取 last 参数在堆栈上的地址，并使用该地址为 va_list 变量 ap 赋值一个合适的初始值。这样，ap 可以用作一个“指针”或“引用”，以遍历随后的可变参数列表。

3.2.3 注意事项

• 在访问任何可变参数之前，必须首先使用 va_start 初始化 va_list。
• 为了避免潜在的未定义行为，我们应当始终在使用完 va_list 后使用 va_end 宏来清理。
• last 参数必须是一个真实存在于函数参数列表中的参数，并且通常是固定参数列表中的最后一个参数。这是因为 va_start 需要一个明确的内存位置来确定可变参数列表的开始位置。

3.2.4 示例

#include 
#include 

void print_numbers(int count, ...) {
    va_list args;
    va_start(args, count);  // Initialize 'args' with the address after 'count'

    for (int i = 0; i < count; i++) {
        int value = va_arg(args, int);  // Fetch the next argument
        printf("%d ", value);
    }

    va_end(args);  // Clean up
    printf("\n");
}

int main() {
    print_numbers(3, 10, 20, 30);
    return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在上述例子中，va_start(args, count) 获取 count 参数后的第一个地址，从而允许随后使用 va_arg 宏来获取后续的可变参数。

3.2.5 结论

va_start 是处理可变参数函数的基础，并为开发者提供了一个跨平台的方式来访问函数的可变参数。虽然它隐藏了与特定平台和体系结构相关的细节，但了解其背后的基本工作原理可以帮助开发者更好地理解和使用可变参数。

3.3 va_arg

va_arg 是 C 语言中用于访问可变参数函数中参数的宏，定义在 stdarg.h 头文件中。当与 va_list 一起使用时，它允许逐一获取可变参数列表中的参数。

3.3.1 函数原型

type va_arg(va_list ap, type);
1

其中：

• ap 是一个 va_list 类型的变量，它已经被 va_start 初始化过。
• type 是我们期望的下一个参数的数据类型。

3.3.2 工作原理

在函数调用时，参数被压入堆栈中。va_arg 的作用是按照指定的类型 type，从当前 va_list 的位置（即 ap 当前指向的位置）获取值，并更新 va_list 以指向堆栈上的下一个参数。

这里要注意的是，va_list 事实上可能是一个指向堆栈的指针（取决于特定的实现和架构），va_arg 宏不仅会从堆栈上提取值，还会更新此指针，以便它指向下一个参数。

3.3.3 注意事项

• 我们必须确切地知道正在尝试获取的参数的类型，否则会导致未定义的行为。
• 不建议多次访问相同的参数或超出参数列表的范围。
• 在使用完可变参数后，应该调用 va_end 宏来进行清理。
• 如果不确定参数的数量，我们可能需要设计函数，使其以某种方式明确地表示参数列表何时结束，例如：字符串函数通常使用空终止符，或者可以约定使用特定的哨兵值。

3.3.4 示例

#include 
#include 

void print_numbers(int count, ...) {
    va_list args;
    va_start(args, count);

    for (int i = 0; i < count; i++) {
        int value = va_arg(args, int);  // Fetch the next argument of type 'int'
        printf("%d ", value);
    }

    va_end(args);
    printf("\n");
}

int main() {
    print_numbers(3, 10, 20, 30);
    return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在上述示例中，va_arg(args, int) 获取 args 当前指向的参数，并将其作为整数类型返回。随后，args 更新为指向下一个参数。

3.3.5 结论

va_arg 是从可变参数函数中逐个提取参数的核心宏。正确使用它需要对函数的参数类型有明确的知识。此外，为了确保正确性和防止未定义的行为，建议在设计和使用可变参数函数时采用谨慎的策略。

3.4 va_end

va_end 是 C 语言用于处理可变参数函数的宏，定义在 stdarg.h 头文件中。与 va_start 和 va_arg 一同使用时，它标记了 va_list 变量的使用结束，并执行所需的清理。

3.4.1 函数原型

void va_end(va_list ap);
1

其中：

• ap 是一个 va_list 类型的变量，它先前已被 va_start 初始化。

3.4.2 工作原理

当调用 va_end 宏时，它清理由 va_start 为 va_list 变量分配的任何资源。在某些实现和体系结构中，va_start 可能只是将 va_list 指向堆栈上的某个位置，而不需要任何特殊的资源分配。但在其他情况下，可能需要更复杂的资源管理。为了确保可移植性，va_end 的调用是必要的。

3.4.3 注意事项

• 使用 va_end 后，不应再次使用与其相关的 va_list 变量，除非该变量已经被重新初始化。
• 对于每次 va_start 的调用，都应该有一个相应的 va_end 调用以确保资源正确清理。
• 虽然在某些体系结构和实现中可能不需要 va_end，但为了代码的跨平台性和正确性，建议始终使用它。

3.4.4 示例

#include 
#include 

void print_numbers(int count, ...) {
    va_list args;
    va_start(args, count);

    for (int i = 0; i < count; i++) {
        int value = va_arg(args, int);
        printf("%d ", value);
    }

    va_end(args);
    printf("\n");
}

int main() {
    print_numbers(3, 10, 20, 30);
    return 0;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

在上述示例中，print_numbers 函数使用 va_start 来初始化 args，然后使用 va_arg 来读取可变参数。函数结束前，使用 va_end 来清理和结束 args 的使用。

3.4.5 结论

va_end 是确保在使用 va_list 后进行适当清理的关键宏。尽管其具体的工作细节可能因实现而异，但为了确保正确性和可移植性，在使用完可变参数后始终调用它是非常重要的。

4. 注意事项

1. 参数类型和顺序的重要性：当我们使用va_arg获取一个参数时，必须知道它的类型。如果猜错了，结果将是未定义的。
2. 平台相关性：不同的编译器和架构可能会有不同的实现细节。因此，应谨慎使用可变参数函数，尤其是跨平台代码中。
3. 性能：使用可变参数可能会使函数调用效率稍微降低，因为必须在运行时解析参数列表。
4. 安全性：当函数期望某种参数列表格式，而调用者没有按照该格式提供参数时，可能会引发安全问题。例如，printf()的格式字符串漏洞就是一个众所周知的问题。

尽管C语言提供了可变参数功能，但在可能的情况下，考虑使用其他设计模式或语言特性来避免它们，这样可以增加代码的清晰度和安全性。