【嵌入式】C语言多文件编程与内联函数

0 前言

  最近在研究ARM内核代码时，看到core_cm3.h中有大量的内联函数，为此查阅了很多资料，也和朋友讨论了很久，最后对C语言多文件编程有了一点不一样的体会，对此前很多习以为常的东西也知道了这么做的原因。特写此文以作总结。

1 从C语言编译说起

  在使用gcc或者g++编译时，直接传入c文件即可得到执行程序，看似非常简单，但实际有很多步骤，包括：预处理（Preprocess），编译（Compile），汇编（Assemble），链接（Link）四个步骤。其中，所谓预处理，即对带有#的语句进行处理，如#include, #define以及条件编译语句#if, #ifdef, #ifndef等（当然，这一步也会进行删除注释等操作）；而编译，即是将c语言编译成汇编语言；汇编，是基于汇编语言生成机器码；链接，则是链接具有函数引用关系的不同c文件。

参考链接

  以上这些过程中有一些注意点：

• #include实际上就是将这个文件的内容复制过来，所以预处理之后，得到的仍然是c格式的文本文件，但体积会比原来的文件大很多。
• 既然如此，岂不是理论上可以包含任何文件？是的，include某个c文件其实也是允许的，只要复制过来不会报错就行。
• 那为什么还要建立同名的c和h文件呢？直接一个c文件不行吗？这其实是考虑到C语言不能重复定义函数和变量的特性，以及库文件加调用接口的这种应用场景。一般都是h文件放声明，c文件放定义。至于重复定义错误的相关介绍，参考后面章节。
• 为什么需要链接？简单来说，只要写的代码中引用了其他文件中定义的函数，就需要链接。这里需要理解一个专业名词：编译实体，即每一个c文件都是一个编译实体，是最小的编译单位。各个编译实体在上述前三个阶段都是独立的，互不影响，而最后的链接阶段就是将不同编译实体给“拼接”到一块，组成一个完整的执行程序。

2 重复定义错误（ODR violation）和条件编译

  相信使用过ADC模块的都遇到过重复定义的问题，即在h文件定义一个转换值的变量，int ADC_value = 0; 然后在main.c中包含这个h文件之后直接使用变量ADC_value，这样就会报重复定义的错误。
  所谓条件编译，即在h文件中用这么一段代码括起来：

#ifndef __FILE_H_
#define __FILE_H_

// 中间是头文件的内容

#endif

对于这个东西的作用，网上绝大多数的描述都是防止重复包含。确实，从条件编译的逻辑来看可以实现这个功能，但很多人可能会将这个当作上述描述的重复定义错误的解决办法，这显然是不对的。

  首先需要明确，函数或变量的声明，是可以重复include的，如果h文件中只有声明，那完全可以多次include的，那为什么现在的库文件中h文件中都会有上述的条件编译代码呢？确实是防止重复包含，但最终目的不是避免报错，而是加快编译速度。

参考链接

  举个例子，有一个库（func.c, func.h）包含了stdio.h，然后main.c包含了func.h，但是出于编写习惯，main.c中也会包含stdio.h，也就是说，最后在编译main.c时就包含了两次stdio.h文件，如果stdio.h文件中没有条件编译，那么它就会被包含两次，虽然不会报错，但会影响编译的速度，而且这种库数量越多，影响越大。

  那重复定义到底是怎么回事呢？如果在h文件中定义全局变量，那么包含该h文件的c文件也就定义了一个全局变量（因为include是完全复制），编译器在编译该c文件时，这个变量就会被存放在全局/静态区。同理，假如该h文件也被其他c文件包含，那么其他包含该h文件的c文件也会这么干，因为不同c文件在预处理，编译和汇编这三个阶段（生成目标文件阶段）是独立的。到这各个c文件都可以被正常编译，不会报错，但是在最后链接阶段时，编译器就会发现全局/静态区存在相同的变量定义，由此报错。

  总结来说，防止重复包含是在前三个阶段，是同一个编译单元编译时的考虑；而重复定义，是不同编译实体之间在第四个阶段链接过程中的问题。因此，防止重复包含并不能解决重复定义的问题。

  所以，对于全局变量，建议采用的方式就是头文件中只声明（extern int a;），定义放在同名的c文件中，这样即使有不同的编译实体包含了该头文件，也只是包含了声明，没有变量定义，这样在链接阶段就不会出现重复定义的问题。

3 内联函数inline和static inline

  inline这个关键词比较复杂，它在不同C语言版本，不同编译器，c和c++中的含义都不尽相同，所以在使用前一定要了解编译环境。

  所谓内联函数，指调用时没有普通函数调用时的堆栈压入和弹出的步骤，而是将函数展开，直接执行内部的代码。内联函数的好处在于减少了函数出入栈的操作，代码执行效率更高，但同样也有缺点，那就是每调用一次，都需要复制一遍函数的代码，空间成本更高，所以内联函数一般只适用于比较简短的代码。

  另外，inline关键词只能建议该函数内联调用，但最终是否调用仍然取决于编译器，所以就有可能会内联失败。对于这个问题，在c++中，一般编译器会将该函数自动转换成普通函数，且只保留一份定义，然后正常调用，从而保证不会出错。比如，在func.h文件中定义一个内联函数，但由于函数内容太长或者其他原因，内联失败了，那么编译器可能会自动创建一个func.c文件（原来没有，不一定是这个名字），然后在这个文件中生成该内联函数的定义，原func.h文件中的定义就只有声明的作用，从而转换成普通函数。

参考链接

  但是，以上是c++的处理方式，可以保证内联的函数有且仅有一份定义，但这并不适用于C语言。先来看一个vscode中的例子：

test.c

#include "stdio.h"

inline void func()
{
    printf("Hello World!\n");
}

int main(void)
{
    func();
    return 0;
}

点击编译运行，发现会报错：undefined reference to 'func' ... error: ld returned 1 exit status 但是如果将文件改成cpp，同样的代码就不会报错。这看起来好像是C语言编译器的问题？在这篇博客中，介绍了一种办法，就是在函数前再加上static关键词进行修饰，这也就是后面要提到的static inline联合使用的问题，暂且按下不表。

  为解决这个问题，尝试在编译时开启优化，执行gcc -O1 test.c -o run_c; ./run_c，结果发现竟然正常输出了Hello World！换成O2，O3，也都正常。（默认为O0，不开启优化）

由此可知，如果有inline函数，必须要考虑编译优化等级的问题。

static inline

  再来看看这个static inline，在介绍之前，首先介绍一下static关键词。

  对于static关键词，在我之前的一篇博客中有详细介绍。简单来说，修饰变量时，表示该变量为静态变量，存放在静态区，比如函数中如果使用了静态变量，那么它在内存中的地址就是固定的，全局变量加不加static修饰其实差别不大；修饰函数时，表示该函数只能被当前文件访问，不能被其他文件访问，常用于库的内部函数，不开放对外接口。

  对于修饰函数的情况，static可以起到隔绝作用域的功能。比如，在两个c文件中定义同名函数，且都用static修饰，如下所示：

这样是可以正常编译运行的。两个test函数虽然一样，但由于被限制在各自的文件中，所以不会造成冲突。

  那为什么inline还要加上static呢？如前所述，inline关键词只能建议编译器将该函数内联展开，如果成功，那么即使内联函数定义所在的文件被多次包含，也可以正常编译运行，举个例子：

这个例子中，io.h中定义了一个内联函数，另外有两个c文件包含了该h文件，且调用了该内联函数，可以正常编译运行。

  但考虑到inline可能会失败，而且C语言的编译器在这方面又没有c++那么智能，可以自动实现只保留一份定义，避免ODR Violation。那么就需要加上static，这样每次调用都相当于是内部函数，只在该编译实体下可调用，且允许不同编译实体中存在重复定义，这样就能正常编译运行了。总结来说，static起到的是一个安全保障功能。

参考链接

4 总结

  本文从研究内联函数出发，分析了C语言多文件编程的具体流程，并基于次对内联函数的含义和性质、inline和static两个关键词及其组合等内容进行了详细的介绍，对于阅读ARM内核代码有一定的帮助。