Postgresql源码ERROR日志函数简析

╰半夏微凉° 2022-05-29 04:44 492阅读 0赞

## 背景 ##

*  最近在阅读Postgresql 10.3源码时发现，很多函数中打印了`elog(ERROR)`之后并没有明显的return,但从上下文逻辑看，此时必须返回错误、无法继续执行了。难道`elog(ERROR)`自带函数返回功能?带着这个疑问，简单梳理了一下elog的调用流程.

## elog 源码浅析 ##

*  elog 宏定义

/*
     * 如果有可变参数宏,我们将给编译器一个暗示:当elevel>=ERROR时,函数调用不会返回
     * If we have variadic macros, we can give the compiler a hint about the
     * call not returning when elevel >= ERROR.  See comments for ereport().
     * Note that historically elog() has called elog_start (which saves errno)
     * before evaluating "elevel", so we preserve that behavior here.
     */
    #ifdef HAVE__BUILTIN_CONSTANT_P
    #define elog(elevel, ...)  \
        do { \
            elog_start(__FILE__, __LINE__, PG_FUNCNAME_MACRO); \
            elog_finish(elevel, __VA_ARGS__); \
            if (__builtin_constant_p(elevel) && (elevel) >= ERROR) \
                pg_unreachable(); \
        } while(0)
    #else /* !HAVE__BUILTIN_CONSTANT_P */
    #define elog(elevel, ...)  \
        do { \
            int     elevel_; \
            elog_start(__FILE__, __LINE__, PG_FUNCNAME_MACRO); \
            elevel_ = (elevel); \
            elog_finish(elevel_, __VA_ARGS__); \
            if (elevel_ >= ERROR) \
                pg_unreachable(); \
        } while(0)

*  简单分析下上述宏定义：  
    
    
     *  首先是判断下是否支持`__builtin_constant_p`,这是编译器gcc内置函数，用于判断一个值是否为编译时常量，如果是常数，函数返回1 ，否则返回0。如果为常量，可以在代码中做一些优化来减少表达式的复杂度
     *  `elog`处理日志打印，它通常会调用 `write_log`写日志
     *  `elog_finish`最后会调用`errfinish(0)`，对后者的描述如下：  
        
    
    > `errfinish` 结束错误报告循环，它会产生合适的错误报告并对错误栈执行pop操作。  
    > 如果错误等级为ERROR或更严重级别,它将不会返回到调用方。

*  再来看 `errfinish` 的代码：
    
        /*
        * errfinish --- end an error-reporting cycle
        *
        * Produce the appropriate error report(s) and pop the error stack.
        *
        * If elevel is ERROR or worse, control does not return to the caller.
        * See elog.h for the error level definitions.
        */
        void
        errfinish(int dummy,...)
    
     *  `ERROR`,调用`PG_RE_THROW`, 类似于java、C++语言中的抛异常,结束当前调用;
     *  `FATAL`,调用`proc_exit(1)`,会按正常流程清理释放资源并退出进程；
     *  `PANIC`或更严重级别,在控制台打印错误后直接`abort`.
 *  `ereport`和`elog`类似,不过它调用`ereport_domain`实现,该函数允许通过message domain的概念,将某些指定模块的日志打印到一个单独的目录。
 *  ## 总结 ##
    
     *  要慎重评估代码中的日志级别，不要轻易打`elog(ERROR)`、`ereport(ERROR)`或更严重级别的日志
     *  如果出现一些小错误，但当前操作仍可继续的，可以打`WARNING`级别日志
     *  如果出现错误且当前流程无法继续、但不影响其他业务请求的，可打印`ERROR`
     *  如出现可能导致整个服务异常的问题，则打印`FATAL`甚至`PANIC`