1 Star 0 Fork 0

BSCRL / log

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

日志系统

一、依赖的组件模块

二、提高代码灵活性和可移植性

2.1 指定日志输出位置

enum LoggingDestination {
    LOG_TO_NONE             = 0,       // 不记录日志
    LOG_TO_FILE             = 1 << 0,  // 将日志记录到文件
    LOG_TO_SYSTEM_DEBUG_LOG = 1 << 1,  // 将日志记录到系统调试日志

    // 这是一个组合值,表示同时记录到文件和系统调试日志。
    LOG_TO_ALL = LOG_TO_FILE | LOG_TO_SYSTEM_DEBUG_LOG,

    // 在Windows上(OS_WIN),默认是将日志输出到文件(LOG_DEFAULT = LOG_TO_FILE)。
    // 在POSIX兼容的操作系统上(如Linux、Mac等,OS_POSIX),由于可能无法轻松定位到可执行文件的位置,
    // 因此默认是将日志通过 OutputDebugString 输出到系统调试日志(LOG_DEFAULT = LOG_TO_SYSTEM_DEBUG_LOG)。
#if defined(OS_WIN)
    LOG_DEFAULT = LOG_TO_FILE,
#elif defined(OS_POSIX) 
    LOG_DEFAULT = LOG_TO_SYSTEM_DEBUG_LOG,
#endif
};

LoggingDestination枚举类型用于指定日志记录的目标位置。

这样的设计允许在编译时通过定义不同的宏来指定日志记录的目标,提高了代码的灵活性和可移植性。同时,使用位掩码来表示不同的日志目标也允许在运行时通过位运算来动态地组合或修改日志目标。

  • 灵活性: 枚举的定义本身就是一种灵活性的体现,而代码中又通过位运算符的方式来为运行时通过位运算来动态地组合或修改日志目标提供可能。
  • 可移植性: 看到对平台检查的部分,采用#if defined....#elif....#endif的方式而非#if defined ...#else...endif就是为了以后可以更方便的扩展平台。

2.2 通过预编译支持各种平台

#if defined(OS_WIN)
typedef HANDLE PlatformFile;
#elif defined(OS_POSIX)
typedef int PlatformFile;

#if defined(OS_BSD) || defined(OS_MACOSX) || defined(OS_NACL)
typedef struct stat stat_wrapper_t;
#else
typedef struct stat64 stat_wrapper_t;
#endif
#endif  // defined(OS_POSIX)

三、控制日志输出

3.1、解决跨平台情况下ERROR冲突

  1. Windows SDK中的ERROR宏: 在Windows编程中,wingdi.h(或其他Windows SDK头文件) 可能会定义一个名为ERROR的宏,通常用于指示某个函数或操作失败。在这个上下文中,ERROR被定义为0。
  2. 日志记录宏冲突: 假设现有的代码库使用了一个名为LOG(ERROR)的日志记录宏。 当在Windows环境下编译这段代码时,ERROR会被替换为0,因此LOG(ERROR)会被扩展为BAIDU_COMPACK_LOG(0)。 但是,我们自定义的错误级别不是0,而是3
  3. 解决冲突: 为了解决这个问题,代码首先使用#undef ERROR取消了ERROR的原始定义。 然后,它定义了一个新的ERROR宏,其值为0,但这只是为了与Windows SDK保持一致, 而不是为了实际用于日志记录。
  4. 定义新的日志严重性级别: 为了仍然能够使用LOG(ERROR)这种语法,同时确保它映射到正确的日志严重性级别, 代码定义了一个常量BLOG_0,并将其设置为BLOG_ERROR。 这样,当代码尝试使用LOG(ERROR)时,它实际上会映射到BAIDU_COMPACK_LOG(BLOG_ERROR), 而不是BAIDU_COMPACK_LOG(0)。
#undef ERROR
#define ERROR 0
// Needed for LOG_IS_ON(ERROR).
const LogSeverity BLOG_0 = BLOG_ERROR;
#endif

3.2、支持运行时调整哪些日志应该被执行

通过使用 Google 的 gFlags库来定义命令行参数, 在程序运行时通过命令行参数控制哪些日志应该执行

gFlags 是一个用于处理命令行标志(flags)和配置参数的库。 譬如:

# define BAIDU_VLOG_IS_ON(verbose_level, filepath)                      \
    ({ static const int* vlocal = &::logging::VLOG_UNINITIALIZED;       \
        const int saved_verbose_level = (verbose_level);                \
        (saved_verbose_level >= 0)/*VLOG(-1) is forbidden*/ &&          \
            (*vlocal >= saved_verbose_level) &&                         \
            ((vlocal != &::logging::VLOG_UNINITIALIZED) ||              \
             (::logging::add_vlog_site(&vlocal, filepath, __LINE__,     \
                                       saved_verbose_level))); })
#else
// GNU extensions not available, so we do not support --vmodule.
// Dynamic value of FLAGS_verbose always controls the logging level.
# define BAIDU_VLOG_IS_ON(verbose_level, filepath)      \
    (::logging::FLAGS_v >= (verbose_level))
#endif
#define VLOG_IS_ON(verbose_level) BAIDU_VLOG_IS_ON(verbose_level, __FILE__)

DECLARE_int32(v);
extern const int VLOG_UNINITIALIZED;

DECLARE_int32(v); 这条语句声明了一个名为 v 的整数型(32位)命令行标志。 在运行时决定某个日志调用是否应该执行,这可以帮助优化性能,因为不必要的日志调用可以被避免。 宏允许你在运行时动态地控制日志记录的详细程度,而不必修改和重新编译源代码。

四、日志存储的底层缓冲区设计

给出一个反面案例:

std::ostringstream os;
os<<"first log message";
os<<"second log message";
cout<<os.str();

std::ostringstream 虽然非常方便地允许我们像使用流(stream)一样拼接字符串,但每次我们向其中添加内时,它都可能会重新分配内存来存储更长的字符串。这种动态内存分配在日志记录场景中可能会成为性能瓶颈,尤其是在高频次或大量日志记录的情况下。 为了避免这种开销,可以使用一个底层缓冲区(underlying buffer)来直接存储日志内容。这个缓冲区通常是一个固定大小或动态增长的字符数组(如 char[] 或 std::vector)通过直接在这个数组上操作来避免 std::string 的内存分配。

使用底层缓冲区也需要更多的注意和谨慎,因为你需要手动管理内存和确保缓冲区不会溢出。此外,当你需要将日志内容转换为 std::string 或其他类型时,你可能需要执行额外的复制操作。

在设计日志系统时,一种常见的策略是使用一个循环缓冲区(circular buffer)或类似的机制来存储日志条目。每个日志条目可以有一个固定的最大大小,并且当缓冲区满时,较旧的日志条目可以被新的条目覆盖。这样可以确保在任意时刻,你都有一定数量的最新日志可供查看,而不会无限制地增长内存使用。

五、设计巧思

// 这个宏的主要目的是帮助开发者识别和理解哪些代码路径尚未被实现。
// 当设置为在运行时记录错误日志时,它还可以帮助在测试或生产环境中捕获这些问题。
// 这个宏用于标记尚未实现的代码路径。其实现取决于NOTIMPLEMENTED_POLICY的值:
//   0 -- 不执行任何操作(可能会被编译器优化掉)  
//   1 -- 在编译时发出警告  
//   2 -- 在编译时失败(这通常是通过静态断言或其他编译器特定的技巧实现的) 
//   3 -- 在运行时失败(使用`DCHECK`或其他类似的运行时断言)  
//   4 -- [default]:在运行时记录一个错误日志(使用`LOG(ERROR)`) 
//   5 -- LOG(ERROR) at runtime, 每个调用点只记录一次

#endif // BRPC_WITH_GLOG

#ifndef NOTIMPLEMENTED_POLICY
#if defined(OS_ANDROID) && defined(OFFICIAL_BUILD)
#define NOTIMPLEMENTED_POLICY 0
#else
// Select default policy: LOG(ERROR)
#define NOTIMPLEMENTED_POLICY 4
#endif
#endif


/***********************************
 * 设计巧思:
 * 这样的设计使得当NOTIMPLEMENTED()宏被触发时,日志或错误信息中能够包含更多关于出错位置的上下文信息,
 * 特别是当使用GCC编译时。这对于快速定位和修复问题是非常有帮助的。
 * 例如,如果你在函数void MyClass::MyFunction(int a, double b)中触发了NOTIMPLEMENTED()宏,
 * 并且你的代码是用GCC编译的,那么你将看到的错误信息可能类似于:
 * Not implemented reached in void MyClass::MyFunction(int, double)
 * 而如果你不是用GCC编译的,那么错误信息将简单地是:
 * NOT IMPLEMENTED
 * 这样的设计考虑了跨平台和跨编译器的兼容性,同时尽可能地提供了有用的调试信息。
 * ************************************/
#if defined(COMPILER_GCC)
// __PRETTY_FUNCTION__是GCC提供的一个宏,
// 它可以展开为当前函数的签名,包括函数名、返回类型以及参数类型,这使得在调试或记录日志时能够提供更详细的信息。
#define NOTIMPLEMENTED_MSG "Not implemented reached in " << __PRETTY_FUNCTION__
#else
#define NOTIMPLEMENTED_MSG "NOT IMPLEMENTED"
#endif

#if NOTIMPLEMENTED_POLICY == 0
#define NOTIMPLEMENTED() BAIDU_EAT_STREAM_PARAMS
#elif NOTIMPLEMENTED_POLICY == 1
// TODO, figure out how to generate a warning
#define NOTIMPLEMENTED() COMPILE_ASSERT(false, NOT_IMPLEMENTED)
#elif NOTIMPLEMENTED_POLICY == 2
#define NOTIMPLEMENTED() COMPILE_ASSERT(false, NOT_IMPLEMENTED)
#elif NOTIMPLEMENTED_POLICY == 3
#define NOTIMPLEMENTED() NOTREACHED()
#elif NOTIMPLEMENTED_POLICY == 4
#define NOTIMPLEMENTED() LOG(ERROR) << NOTIMPLEMENTED_MSG
#elif NOTIMPLEMENTED_POLICY == 5
#define NOTIMPLEMENTED() do {                                   \
        static bool logged_once = false;                        \
        LOG_IF(ERROR, !logged_once) << NOTIMPLEMENTED_MSG;      \
        logged_once = true;                                     \
    } while(0);                                                 \
    BAIDU_EAT_STREAM_PARAMS
#endif

#if defined(NDEBUG) && defined(OS_CHROMEOS)
#define NOTREACHED() LOG(ERROR) << "NOTREACHED() hit in "       \
    << __FUNCTION__ << ". "
#else
#define NOTREACHED() DCHECK(false)
#endif

这段代码定义了一个名为NOTIMPLEMENTED()的宏,用于标记尚未实现的代码路径。它的实现受NOTIMPLEMENTED_POLICY控制,该策略定义了当NOTIMPLEMENTED()宏被触发时应该执行的操作。

以下是NOTIMPLEMENTED_POLICY各值的含义和相应的NOTIMPLEMENTED()宏的行为:

0: 什么也不做(被编译器优化掉)。 1: 在编译时发出警告。但注意,这里的COMPILE_ASSERT实际上并不在GCC中产生编译时警告,而是编译时错误(因为COMPILE_ASSERT通常用于在编译时检查某个条件是否为真)。 2: 在编译时失败(使用COMPILE_ASSERT)。 3: 在运行时失败(使用NOTREACHED(),这通常是DCHECK失败时的一个宏)。 4: 在运行时记录一个错误日志(使用LOG(ERROR)),这是默认行为。 5: 在运行时记录一个错误日志,但每个调用点只记录一次。 注意,这里还定义了一个NOTIMPLEMENTED_MSG宏,它包含当前函数名的去混淆版本(在GCC编译器下)或一个简单的字符串"NOT IMPLEMENTED"。

另外,BAIDU_EAT_STREAM_PARAMS这个宏在代码中被使用,但它在这段代码中没有定义。我猜测它可能是一个用于处理或忽略任何传递给NOTIMPLEMENTED()宏的额外参数(比如流操作符<<后面的内容)的宏。

在代码的最后,有一个条件编译块,它特定于NDEBUG(非调试模式)和OS_CHROMEOS(Chrome OS操作系统)。在这个条件下,NOTREACHED()宏被定义为一个记录日志的宏,类似于NOTIMPLEMENTED_POLICY为4时的行为,但日志消息略有不同。

但是,需要注意的是,代码中的NOTREACHED()宏在条件编译块的末尾被切断了,这可能导致编译错误。你应该确保这个宏的完整定义包含在你的代码库中。

这段代码提供了一种灵活的方式来处理未实现的代码路径,允许开发者根据他们的需要选择不同的处理策略。

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

日志组件 展开 收起
C++ 等 4 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/bscrl/log.git
git@gitee.com:bscrl/log.git
bscrl
log
log
master

搜索帮助