最近我一直在尝试阅读更多的开源 C 代码。我在业余爱好项目中采用的常见模式如下。
在我的 C 文件中,我有静态或导出的函数。只有导出的函数才会放置在头文件中。仅在对象范围内使用的全局变量也用作静态全局变量。
我的问题涉及在头文件中使用静态内联
函数的有用性和动机。根据我在网上阅读的内容,不使用 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;
}
最佳答案
实际上,静态内联
函数可能(但不确定)是inlined通过一些良好的优化编译器(例如,当给定 -O2
时,通过 GCC)在其大多数调用站点上进行优化。
它是在头文件中定义的,因为它可以在大多数调用站点(也许是所有调用站点)内联。如果它只是声明(并且简单地“导出”),则内联不太可能发生(除非您编译并链接 link-time optimizations ,也称为 LTO,例如使用 gcc -flto -O2
进行编译和链接,这会增加很多构建时间。
实际上,编译器需要知道函数体才能内联它。因此,一个合适的位置是将其定义在某个公共(public)头文件中(否则,它只能在定义它的同一翻译单元中内联,除非启用 LTO),以便每个翻译单元都知道该可内联函数的主体。
它被声明为static
以避免多重定义(在链接时),以防编译器没有内联它(例如,当您使用它的地址时)。
实际上,在 C99 或 C11 代码中(除了我很少使用的 LTO),我总是将我想要内联的短函数作为 static inline
定义放在公共(public)头文件中。
请务必了解 C preprocessor 如何以及何时作品。请注意,原则上您可以(但这将是非常糟糕的做法和令人厌恶的风格)避免在公共(public)头文件中定义某些静态内联
函数,而是将其相同的定义复制并粘贴到多个中。 c
文件。
(但是,这对于生成 .c
文件可能有意义,例如,如果您设计 compiler emitting C code )。
仅供引用LTO实际上是由最近的 GCC 编译器通过在目标文件中嵌入一些内部编译器表示(一些 GIMPLE )并重做一些“编译”步骤 - using the lto1
frontend 来实现的。 - 在“链接”时间。实际上,整个程序几乎被编译了“两次”。
(实际上,我一直想知道为什么 C 标准化委员会没有决定所有显式内联
函数都是静态的)
关于c - 头文件中的静态内联函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/57812718/