最近我一直在尝试阅读更多开源C代码.我在业余爱好项目中采用的一种常见模式如下: -
在我的C文件中,我有静态或导出的函数.只有导出的函数才会放在头文件中.仅在对象范围内使用的全局变量也用作静态全局变量.
我的问题涉及在头文件中使用"静态内联"函数的有用性和动机.从我在线阅读的内容来看,不使用static关键字会导致多重定义错误,这就是不仅仅将函数定义为"内联"的原因.
但是,这是否意味着导出此函数以供其他对象使用?如果是,那么为什么不在C文件中定义此函数并通过头文件导出它?如果不是,为什么将它放在头文件中而不是仅仅在C文件中?
这种编码风格背后有原因吗?我错过了什么?
一个这样的例子可以在git代码库里面找到static inline:
/*
* 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;
}
Run Code Online (Sandbox Code Playgroud)
Bas*_*tch 24
一个static inline功能是,在实践中,可能(但不是一定)被内联的一些好的优化编译器(例如,通过GCC时,它被赋予-O2)在其大部分的呼叫站点.
它在头文件中定义,因为它可以在大多数调用站点(也许是所有调用站点)中内联.如果这只是宣布(和简单的"出口")的内联是不可能发生的(除非您编译和链接与链接时优化,又名LTO,也如编译和链接gcc -flto -O2,并增加了大量的编译时间).
实际上,编译器需要知道函数的主体才能内联它.因此,一个合适的位置是在一些公共头文件中定义它(否则,它可以仅在定义它的相同转换单元中内联,除非您启用LTO),以便每个转换单元都知道该无限函数的主体.
static如果编译器没有内联它(例如,当你使用它的地址时),它被声明为避免多个定义(在链接时).
在实践中,在C99或C11代码中(除了LTO,我很少使用),我总是把我想要的短函数作为static inline公共头文件中的定义.
请务必了解C预处理器的工作方式和时间.请注意,原则上你可以(但实践和恶心的风格会很糟糕)避免static inline在公共头文件中定义一些函数,而是将其相同的定义复制并粘贴到多个.c文件中.(但是,这可能对生成的 .c文件有意义,例如,如果您设计一个发出C代码的编译器).
FYI LTO实际上是由最近的GCC编译器实现的,它通过在目标文件中嵌入一些内部编译器表示(一些GIMPLE),并在"链接"时重做一些"编译"步骤 - 使用lto1前端.在实践中,整个程序几乎是"两次"编译.
(实际上,我总是想知道为什么C标准化委员会没有决定所有显式inline函数都是静态的)