如何防止C语言中LOG_DEBUG_ENTERING的调用被编译器/CPU重排序？

我正在开发一款支持C99标准的可移植多线程应用，可运行于嵌入式及非嵌入式系统，适配各类编译器。部分开发平台无调试器，排查Bug难度极大，此时唯一可用的调试工具是应用生成的日志消息。因此我在所有函数中添加了LOG_DEBUG_ENTERING()和LOG_DEBUG_EXITING()宏，用于追踪应用执行流程。

这些宏/函数设计为：执行完成后确保日志消息已输出，或至多将待打印消息排入队列（可能由其他进程处理）以尽快打印，具体实现依赖于平台；无论应用是否因Bug崩溃，所有日志消息都会被输出。

以下是应用中的真实示例代码：

typedef enum {
    A = 0,
    B = 1,
    C = 2
} my_enum;

/**
 * @warning 若random为NULL或blabla无效，此函数行为未定义。
 */
int foo(int *random, my_enum blabla)
{
    //输出：[DBG][<时间戳>][<线程名称>][foo:<行号>]: 进入 - Hello world!
    LOG_DEBUG_ENTERING("%s", "Hello world!");
    int ret_code = 0;
    
    *random = 50;
    ret_code = do_something(*random, blabla);
    
    //输出：[DBG][<时间戳>][<线程名称>][foo:<行号>]: 退出 - <ret_code>
    LOG_DEBUG_EXITING("%d", ret_code);
    return ret_code;
}

若以下列方式调用foo()，应用会崩溃：

int random;
foo(NULL, A); //当foo()尝试给random指向的地址赋值时会崩溃
foo(&random, 1000); //崩溃原因：若blabla超出范围，do_something()行为未定义

原本可通过日志消息轻松定位崩溃位置，但担心编译器可能改变宏的调用顺序，例如将LOG_DEBUG_ENTERING()移到崩溃代码之后：

int foo(int *random, my_enum blabla)
{
    int ret_code = 0;
    
    *random = 50;
    ret_code = do_something(*random, blabla);
    
    //输出：[DBG][<时间戳>][<线程名称>][foo:<行号>]: 进入 - Hello world!
    LOG_DEBUG_ENTERING("%s", "Hello world!");

    //输出：[DBG][<时间戳>][<线程名称>][foo:<行号>]: 退出 - <ret_code>
    LOG_DEBUG_EXITING("%d", ret_code);
    return ret_code;
}

这种情况下，应用会崩溃且无任何日志消息输出。注：我们故意不检查foo()和do_something()的输入参数，理念是不针对不良编码保护应用，但仍希望在必要时捕获这类Bug。

要确保LOG_DEBUG_ENTERING()在函数开头的业务代码之前执行，避免编译器/CPU重排，可采用以下几种兼容C99、可移植的方案：

1. 引入编译器屏障（Compiler Barrier） #

编译器屏障会告诉编译器：屏障前后的内存操作不能被重排。针对不同编译器封装通用的屏障宏，嵌入到日志宏中：

// 可移植的编译器屏障定义
#if defined(__GNUC__) || defined(__clang__)
#define COMPILER_BARRIER() __asm__ __volatile__("" ::: "memory")
#elif defined(_MSC_VER)
#define COMPILER_BARRIER() _ReadWriteBarrier()
#elif defined(__IAR_SYSTEMS_ICC__)
#define COMPILER_BARRIER() __barrier()
#else
// 无内置屏障的编译器，用volatile变量模拟
static volatile int dummy_barrier;
#define COMPILER_BARRIER() (dummy_barrier = 0)
#endif

// 改造后的日志进入宏
#define LOG_DEBUG_ENTERING(fmt, ...) do { \
    /* 原有日志输出逻辑，例如： */ \
    log_debug("[DBG][%s][%s][%s:%d]: 进入 - " fmt, \
              get_timestamp(), get_thread_name(), __func__, __LINE__, ##__VA_ARGS__); \
    COMPILER_BARRIER(); /* 阻止编译器重排后续代码到日志之前 */ \
} while(0)

该方案直接阻止编译器对日志操作和后续业务代码的顺序优化，兼容性覆盖绝大多数主流编译器。

2. 利用volatile变量强制执行顺序 #

如果编译器不支持屏障扩展，可通过volatile变量的读写操作强制顺序——编译器会认为volatile变量的访问具有不可优化的副作用，不会重排其前后的代码：

static volatile int log_sync_flag = 0;

#define LOG_DEBUG_ENTERING(fmt, ...) do { \
    log_debug("[DBG][%s][%s][%s:%d]: 进入 - " fmt, \
              get_timestamp(), get_thread_name(), __func__, __LINE__, ##__VA_ARGS__); \
    log_sync_flag++; /* volatile写操作，阻止后续代码被移到日志之前 */ \
} while(0)

此方案兼容性极强，但相比编译器屏障会有微小的性能开销，适合资源充足的平台或对兼容性要求极高的场景。

3. 将日志宏实现为非内联函数 #

C语言中，函数调用是序列点——序列点保证了调用前的所有表达式副作用已完成，后续代码不会被编译器移到调用之前。将日志逻辑封装为非内联函数，可利用序列点特性阻止重排：

// 用编译器属性标记为非内联
#if defined(__GNUC__) || defined(__clang__)
#define NOINLINE __attribute__((noinline))
#elif defined(_MSC_VER)
#define NOINLINE __declspec(noinline)
#else
#define NOINLINE
#endif

NOINLINE void log_debug_entering(const char *func, int line, const char *fmt, ...) {
    va_list args;
    va_start(args, fmt);
    // 日志输出逻辑
    va_end(args);
    COMPILER_BARRIER(); // 额外加入编译器屏障增强效果
}

#define LOG_DEBUG_ENTERING(fmt, ...) log_debug_entering(__func__, __LINE__, fmt, ##__VA_ARGS__)

非内联函数的调用会强制编译器保留执行顺序，同时结合编译器屏障，可进一步防止CPU层面的指令重排。

4. 加入内存屏障（Memory Fence）防止CPU重排 #

如果目标平台存在CPU指令重排的风险（比如多核心嵌入式系统），需在日志操作后加入内存屏障，确保日志的内存写入（如队列写入）在后续业务代码之前完成：

// 可移植的内存屏障定义
#if defined(__GNUC__) || defined(__clang__)
#define MEMORY_BARRIER() __sync_synchronize()
#elif defined(_MSC_VER)
#define MEMORY_BARRIER() MemoryBarrier()
#else
// 无内存屏障的平台，降级为编译器屏障
#define MEMORY_BARRIER() COMPILER_BARRIER()
#endif

// 改造后的日志宏，同时阻止编译器和CPU重排
#define LOG_DEBUG_ENTERING(fmt, ...) do { \
    log_debug("[DBG][%s][%s][%s:%d]: 进入 - " fmt, \
              get_timestamp(), get_thread_name(), __func__, __LINE__, ##__VA_ARGS__); \
    MEMORY_BARRIER(); \
} while(0)

内存屏障会强制CPU刷新缓存，确保日志操作的副作用对其他核心（或后续指令）可见，彻底避免CPU层面的顺序重排。

内容的提问来源于stack exchange，提问作者Parminder Singh