如何内联仅用于发布版本的函数

Question

// common.h
// This is foo function. It has a body.
__inline void foo() { /* something */ }

// a.cpp
#include "common.h" // for foo function
// Call foo

// b.cpp
#include "common.h" // for foo function
// Call foo

我只想在构建发布时内联 foo 函数。我不想为 Debug 构建内联函数。

我尝试过，但链接器错误让我很恼火。
在本例中，foo 函数的主体在 common.h 头文件中定义。
所以如果我这样做的话，

//common.h
#if !defined(_DEBUG)
__inline
#endif
void foo() { /* something */ }

它将在 DEBUG 构建中遇到链接错误。因为两个模块试图包含 common.h。
我不知道如何解决它。
是否可以？

Answer 1

“简单”的解决方案是这样的：

#if !defined(_DEBUG) || defined(NDEBUG)
#define INLINE inline
#else
#define INLINE static
#endif

static 对于消除链接错误和绕过单一定义规则是必要的。

一个更好的解决方案是简单地禁用内联项目范围内的调试。 GCC 支持 -wno-inline-functions 和 -fno-inline-small-functions 选项来抵消这些优化，而且它也不为 -O1 或更低版本启用内联（也可能为 -Os）。大多数编译器都有类似的选项。

我称后者为更好的解决方案，因为它应该指示编译器忽略内联提示，从而消除对讨厌的预处理器指令的需要。

Answer 2

需要认识到的基本一点是，inline 关键字（或 Microsoft 的 C 语言 __inline 扩展 - 因为 MSVC 不支持 C99）本质上是违反单一定义规则的通行证。如果您考虑一下 - 这就是它的全部内容，因为编译器没有义务实际执行任何内联。

因此，当您有一个内联函数时，您可以在多个模块中定义该函数。事实上，您有义务在实际使用该函数的任何模块中定义它。

但是，如果您不将该函数声明为内联函数，则必须确保您的定义不超过一个（如果实际使用则只有一个）。对于非成员函数（C 中的所有函数），有几种方法可以解决此问题：

• 将函数声明为 static 以更改其与内部的链接（请注意，您可以使用 static inline< /code> 函数开始）。
• 在 C++ 中，您可以将它们放在匿名名称空间中（其效果类似于声明静态），
• 您可以使用预处理器操作来处理此问题。它有点丑陋，但它有效，而且我已经看到该技术在野外成功使用。是否值得付出努力完全是另一回事——你必须自己决定。

基本上，您需要做的是在单独的 .c 文件中实现该函数，就像您遵循每个模块单个函数编码标准的传统一样（实际上您也可以这样做将几个内联函数放入 .c 模块中 - 但它们应该全部内联或不内联作为一个组，以防止事情变得过于失控）。该函数的实现需要安排为能够包含在标头中 - 因此它需要包含防护，就像任何其他标头一样。然后，当您需要内联函数时，您可以使用预处理器有条件地将实现作为标头的一部分包含在内（因此该实现将可用于所有模块），但如果您不内联，则不要包含它（因此您遵循在这种情况下的定义规则）：

common.h 标头：
// 通用.h
#ifndef COMMON_H
#define COMMON_H

#ifdef RELEASE
#define USE_INLINE
#define INLINE __inline
#else
#define INLINE
#endif

INLINE void foo(void);
#ifdef USE_INLINE
#include "foo.c"
#endif

#endif /* COMMON_H */

foo() 的实现：

// foo.c
#ifndef FOO_C
#define FOO_C

#include <stdio.h>
#include "common.h"


INLINE void foo()
{
    printf("foo\n");
}

#endif /* FOO_C */

以及一个示例程序：

// main.c
#include<stdio.h>
#include "common.h"

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

现在，如果您编译发布：

cl /DRELEASE main.c foo.c

foo() 将是内联 (或__inline（视情况而定）。

如果您编译为非发布：

cl  test.c foo.c

您有一个非内联 foo()。

编译器和链接器在这两种情况下都很满意。

话虽如此，我有点喜欢将 INLINE 重新定义为 static 以便进行调试的建议。

然而，最终我不确定我是否真的看到了这一点 - 现代调试器能够单步执行内联函数，并且如果禁用，调试器可能不会内联函数调用优化。因此，您也可以在内联函数中设置断点，并使其在非优化构建中正常工作。

我不确定你的最终目标到底是什么。在调试/非优化构建中将函数保留为内联有什么缺点？

Answer 3

您不能将仅标头函数声明为非内联。您可以将它们声明为静态（也称为 C 风格静态），但这将在每个翻译单元中生成函数的副本（包括局部静态变量，如果有）。更好的解决方案是将其保留为内联。在调试模式下，当禁用优化时，编译器通常不会内联任何函数。

Answer 4

#ifdef RELEASE
#define INLINE __inline
#else
#define INLINE
#endif

然后

// common.h
INLINE void foo() { /* something */ }

// a.cpp
#include "common.h" // for foo function
// Call foo

// b.cpp
#include "common.h" // for foo function
// Call foo

为发布版本定义RELEASE。当然你可以从这里看到有很多方法可以做到。

Answer 5

在大多数情况下，未定义发布标志。通常会定义调试标志。
_DEBUG是大多数编译器定义的，因此不需要定义发布标志：

更实用：

#ifndef _DEBUG
    __inline void foo() { /* something */ }
#else 
     //some alternative
#endif

Answer 6

使用编译器条件并定义编译时标志。

示例：

#ifdef RELEASE_BUILD_FLAG
  //Run inline function
#else
  //some alternative
#endif