c - 头文件中的静态内联函数

Question

最近我一直在尝试阅读更多开源 C 代码。我在业余爱好项目中采用的一种常见模式如下。

在我的 C 文件中，我有静态或导出的函数。只有导出的函数才会放在头文件中。仅在对象范围内使用的全局变量也用作静态全局变量。

我的问题是关于在头文件中包含 static inline 函数的有用性和动机。根据我在网上阅读的内容，不使用 static 关键字会导致多重定义错误，这就是不只是将函数定义为 inline 的原因。

但是，这是否意味着这个函数是导出来供其他对象使用的呢？如果是，那么为什么不直接在 C 文件中定义这个函数并通过头文件导出它呢？如果不是，为什么将它放在头文件中而不是将它放在 C 文件中？

这种编码风格背后有什么原因吗？我错过了什么？

一个这样的例子可以在 hashmap.h 的 git 代码库中找到:

/*
 * Converts a cryptographic hash (e.g. SHA-1) into an int-sized hash code
 * for use in hash tables. Cryptographic hashes are supposed to have
 * uniform distribution, so in contrast to `memhash()`, this just copies
 * the first `sizeof(int)` bytes without shuffling any bits. Note that
 * the results will be different on big-endian and little-endian
 * platforms, so they should not be stored or transferred over the net.
 */
static inline unsigned int sha1hash(const unsigned char *sha1)
{
    /*
     * Equivalent to 'return *(unsigned int *)sha1;', but safe on
     * platforms that don't support unaligned reads.
     */
    unsigned int hash;
    memcpy(&hash, sha1, sizeof(hash));
    return hash;
}

Answer 1

static inline 函数在实践中可能(但不确定)为 inlined由一些优秀的优化编译器(例如 GCC 当它被赋予 -O2 时)在它的大部分调用站点。

它在头文件中定义，因为它可以在大多数调用站点(可能是所有调用站点)内联。如果它只是声明(并且简单地“导出”)，则内联不太可能发生(除非您使用 link-time optimizations 编译并链接，也称为 LTO，例如使用 gcc -flto -O2 进行编译和链接，这会大大增加构建时间)。

在实践中，编译器需要知道函数体才能内联它。所以一个合适的地方是在一些公共(public)头文件中定义它(否则，它只能在定义它的同一个翻译单元中内联，除非你启用 LTO)，这样每个翻译单元都会知道那个可内联函数的主体。

它被声明为 static 以避免在编译器没有内联它的情况下(在链接时)进行多重定义(例如，当您使用它的地址时)。

在实践中，在 C99 或 C11 代码中(除了 LTO，我很少使用)，我总是将我想要内联的短函数作为 static inline 定义放在公共(public)头文件中。

请务必了解 C preprocessor 的方式和时间作品。请注意，原则上您可以(但这将是非常糟糕的做法和令人厌恶的风格)避免在公共(public)头文件中定义一些 static inline 函数，而是将其相同的定义复制并粘贴到多个 中。 c 文件。(但是，这对于生成的 .c 文件可能有意义，例如，如果您设计一个 compiler emitting C code )。

仅供引用 LTO实际上是由最近的 GCC 编译器通过在目标文件中嵌入一些内部编译器表示(一些 GIMPLE )并重做一些“编译”步骤 - using the lto1 frontend 来实现的。 - 在“链接”时间。实际上，整个程序几乎被“编译了两次”。

^{(实际上，我一直想知道为什么 C 标准化委员会没有决定所有显式 inline 函数都是静态的)}