Linux基础 -- GCC 工具链的 `-fstack-usage` 用法

最新推荐文章于 2024-10-24 20:30:00 发布

sz66cm

最新推荐文章于 2024-10-24 20:30:00 发布

阅读量630

点赞数 21

文章标签： linux 算法

本文链接：https://blog.youkuaiyun.com/sz66cm/article/details/143186027

版权

GCC 工具链的 `-fstack-usage` 用法

-fstack-usage 是 GCC (GNU Compiler Collection) 提供的一个选项，用于帮助开发人员分析和优化代码的栈内存使用情况。它在编译代码时生成每个函数的栈使用情况报告，并将信息保存到一个 .su 文件中。这个选项对嵌入式系统开发特别有用，因为嵌入式系统中通常栈内存资源有限，需要控制函数的栈使用。

1. `-fstack-usage` 的用法

使用 -fstack-usage 时，可以在编译时为 GCC 添加此选项，具体用法如下：

gcc -fstack-usage -o output_file source_file.c

2. 生成的 `.su` 文件

使用 -fstack-usage 编译代码后，GCC 会为每个源文件生成一个对应的 .su 文件。例如，如果源文件名是 source_file.c，编译后会生成 source_file.su。这个 .su 文件包含每个函数的栈使用量信息。

.su 文件的每一行包含如下字段：

<函数名> <栈使用大小> <文件名>:<行号>

每个字段的含义如下：

<函数名>：函数的名称。
<栈使用大小>：该函数在栈上分配的内存大小（以字节为单位）。
<文件名>:<行号>：函数定义所在的源文件和行号。

例如，source_file.su 可能包含如下内容：

foo 48 source_file.c:10
bar 16 source_file.c:20

这表示 foo 函数在栈上使用了 48 字节，而 bar 函数使用了 16 字节。

3. 应用场景

-fstack-usage 的主要应用场景包括以下几个方面：

嵌入式系统中的栈优化：
- 在嵌入式系统中，栈空间非常有限，因此控制每个函数的栈使用情况至关重要。
- 使用 -fstack-usage 可以了解每个函数的栈使用大小，从而帮助开发人员优化代码，减少栈内存的占用。
检测过度栈使用：
- 通过分析 .su 文件，可以快速找出栈使用过多的函数。
- 如果某些函数栈使用量过大，可以考虑优化这些函数，例如减少局部变量、使用静态内存代替栈内存等。
栈大小估算：
- 对于实时操作系统（RTOS）或裸机程序，开发人员可以使用 -fstack-usage 的输出来计算整个系统的栈需求，合理设置任务栈大小。
- 通过累加任务使用的函数的栈空间，可以估算任务栈的最小需求，避免不必要的内存浪费。

4. 实例说明

假设有一个源代码文件 example.c，其中包含多个函数：

#include <stdio.h>

void foo() {
    int arr[10];  // 栈上分配 10 个整数
    printf("foo\n");
}

void bar() {
    int x = 0;
    int y = 1;
    printf("bar: %d %d\n", x, y);
}

int main() {
    foo();
    bar();
    return 0;
}

使用 GCC 编译这个文件：

gcc -fstack-usage -o example example.c

会生成一个 example.su 文件，内容可能如下：

foo 40 example.c:4
bar 16 example.c:10
main 8 example.c:16

解释：

foo 函数使用了 40 字节的栈，其中包括 arr 数组和函数调用时保存的寄存器等开销。
bar 函数使用了 16 字节。
main 函数使用了 8 字节。

5. 注意事项

编译优化的影响：
栈使用量可能会因为编译器优化级别的不同而有所变化。例如，使用 -O2 或 -O3 进行优化时，编译器可能会对栈上的局部变量进行优化，使得函数的栈使用量减少。因此，建议在使用 -fstack-usage 时明确设置与实际编译一致的优化选项。
递归函数：
对于递归函数，.su 文件显示的是单次调用的栈使用量。如果函数是递归调用，需要额外考虑递归的深度，以估算总的栈使用情况。
多文件项目：
如果项目包含多个源文件，可以使用 make 工具编译，并在 CFLAGS 中添加 -fstack-usage，这样每个源文件都会生成相应的 .su 文件，便于集中分析整个项目的栈使用情况。

6. 结合其他工具

可以结合脚本工具对生成的 .su 文件进行分析，例如 Python 脚本可以解析所有 .su 文件，计算总栈使用量或找出栈使用最多的函数，从而帮助优化和调试。例如：

import glob

total_stack_usage = 0

for filename in glob.glob('*.su'):
    with open(filename, 'r') as file:
        for line in file:
            parts = line.split()
            stack_size = int(parts[1])
            total_stack_usage += stack_size

print(f"Total stack usage: {total_stack_usage} bytes")