diff --git a/modules/core/include/opencv2/core/utils/logger.hpp b/modules/core/include/opencv2/core/utils/logger.hpp index accb860ada..e5bf455125 100644 --- a/modules/core/include/opencv2/core/utils/logger.hpp +++ b/modules/core/include/opencv2/core/utils/logger.hpp @@ -43,6 +43,44 @@ CV_EXPORTS void writeLogMessage(LogLevel logLevel, const char* message); /** Write log message */ CV_EXPORTS void writeLogMessageEx(LogLevel logLevel, const char* tag, const char* file, int line, const char* func, const char* message); +/** + * @brief Function pointer type for writeLogMessage. Used by replaceWriteLogMessage. + */ +typedef void (*WriteLogMessageFuncType)(LogLevel, const char*); + +/** + * @brief Function pointer type for writeLogMessageEx. Used by replaceWriteLogMessageEx. + */ +typedef void (*WriteLogMessageExFuncType)(LogLevel, const char*, const char*, int, const char*, const char*); + +/** + * @brief Replaces the OpenCV writeLogMessage function with a user-defined function. + * @note The user-defined function must have the same signature as writeLogMessage. + * @note The user-defined function must accept arguments that can be potentially null. + * @note The user-defined function must be thread-safe, as OpenCV logging may be called + * from multiple threads. + * @note The user-defined function must not perform any action that can trigger + * deadlocks or infinite loop. Many OpenCV functions are not re-entrant. + * @note Once replaced, logs will not go through the OpenCV writeLogMessage function. + * @note To restore, call this function with a nullptr. + */ +CV_EXPORTS void replaceWriteLogMessage(WriteLogMessageFuncType f); + +/** + * @brief Replaces the OpenCV writeLogMessageEx function with a user-defined function. + * @note The user-defined function must have the same signature as writeLogMessage. + * @note The user-defined function must accept arguments that can be potentially null. + * @note The user-defined function must be thread-safe, as OpenCV logging may be called + * from multiple threads. + * @note The user-defined function must not perform any action that can trigger + * deadlocks or infinite loop. Many OpenCV functions are not re-entrant. + * @note Once replaced, logs will not go through any of the OpenCV logging functions + * such as writeLogMessage or writeLogMessageEx, until their respective restore + * methods are called. + * @note To restore, call this function with a nullptr. + */ +CV_EXPORTS void replaceWriteLogMessageEx(WriteLogMessageExFuncType f); + } // namespace struct LogTagAuto diff --git a/modules/core/src/logger.cpp b/modules/core/src/logger.cpp index 7e3f8aa29d..32183a59a0 100644 --- a/modules/core/src/logger.cpp +++ b/modules/core/src/logger.cpp @@ -12,6 +12,7 @@ #include #include #include +#include #ifdef __ANDROID__ # include @@ -181,6 +182,12 @@ LogLevel getLogLevel() namespace internal { +namespace //unnamed +{ + std::atomic stc_userWriteLogMessageFunc{}; + std::atomic stc_userWriteLogMessageExFunc{}; +} //unnamed + static int getShowTimestampMode() { static bool param_timestamp_enable = utils::getConfigurationParameterBool("OPENCV_LOG_TIMESTAMP", true); @@ -190,6 +197,13 @@ static int getShowTimestampMode() void writeLogMessage(LogLevel logLevel, const char* message) { + WriteLogMessageFuncType userFunc = stc_userWriteLogMessageFunc.load(); + if (userFunc && userFunc != writeLogMessage) + { + (*userFunc)(logLevel, message); + return; + } + const int threadID = cv::utils::getThreadID(); std::string message_id; @@ -230,7 +244,9 @@ void writeLogMessage(LogLevel logLevel, const char* message) std::ostream* out = (logLevel <= LOG_LEVEL_WARNING) ? &std::cerr : &std::cout; (*out) << ss.str(); if (logLevel <= LOG_LEVEL_WARNING) + { (*out) << std::flush; + } } static const char* stripSourceFilePathPrefix(const char* file) @@ -252,6 +268,13 @@ static const char* stripSourceFilePathPrefix(const char* file) void writeLogMessageEx(LogLevel logLevel, const char* tag, const char* file, int line, const char* func, const char* message) { + WriteLogMessageExFuncType userFunc = stc_userWriteLogMessageExFunc.load(); + if (userFunc && userFunc != writeLogMessageEx) + { + (*userFunc)(logLevel, tag, file, line, func, message); + return; + } + std::ostringstream strm; if (tag) { @@ -274,6 +297,24 @@ void writeLogMessageEx(LogLevel logLevel, const char* tag, const char* file, int writeLogMessage(logLevel, strm.str().c_str()); } +void replaceWriteLogMessage(WriteLogMessageFuncType f) +{ + if (f == writeLogMessage) + { + f = nullptr; + } + stc_userWriteLogMessageFunc.store(f); +} + +void replaceWriteLogMessageEx(WriteLogMessageExFuncType f) +{ + if (f == writeLogMessageEx) + { + f = nullptr; + } + stc_userWriteLogMessageExFunc.store(f); +} + } // namespace }}} // namespace diff --git a/modules/core/test/test_logger_replace.cpp b/modules/core/test/test_logger_replace.cpp new file mode 100644 index 0000000000..d3c4a0308d --- /dev/null +++ b/modules/core/test/test_logger_replace.cpp @@ -0,0 +1,115 @@ +// This file is part of OpenCV project. +// It is subject to the license terms in the LICENSE file found in the top-level directory +// of this distribution and at http://opencv.org/license.html. + +#include "test_precomp.hpp" +#include +#include + +namespace opencv_test { +namespace { + +using namespace cv::utils::logging; +using namespace cv::utils::logging::internal; + +TEST(Core_Logger_Replace, WriteLogMessageRestoreCallWithNullOk) +{ + replaceWriteLogMessage(nullptr); + writeLogMessage(cv::utils::logging::LOG_LEVEL_DEBUG, "msg"); + SUCCEED(); +} + +TEST(Core_Logger_Replace, WriteLogMessageExRestoreCallWithNullOk) +{ + replaceWriteLogMessageEx(nullptr); + writeLogMessageEx(cv::utils::logging::LOG_LEVEL_DEBUG, "tag", "file", 1000, "func", "msg"); + SUCCEED(); +} + +std::atomic& getCallFlagger() +{ + static std::atomic callFlagger(0); + return callFlagger; +} + +std::atomic& getCallCounter() +{ + static std::atomic callCounter(0); + return callCounter; +} + +void myWriteLogMessage(LogLevel, const char*) +{ + getCallFlagger().fetch_or(1024u); + getCallCounter().fetch_add(1u); +} + +void myWriteLogMessageEx(LogLevel, const char*, const char*, int, const char*, const char*) +{ + getCallFlagger().fetch_or(2048u); + getCallCounter().fetch_add(1u); +} + +TEST(Core_Logger_Replace, WriteLogMessageReplaceRestore) +{ + uint32_t step_0 = getCallCounter().load(); + writeLogMessage(cv::utils::logging::LOG_LEVEL_DEBUG, "msg"); + uint32_t step_1 = getCallCounter().load(); + EXPECT_EQ(step_0, step_1); + replaceWriteLogMessage(nullptr); + uint32_t step_2 = getCallCounter().load(); + EXPECT_EQ(step_1, step_2); + writeLogMessage(cv::utils::logging::LOG_LEVEL_DEBUG, "msg"); + uint32_t step_3 = getCallCounter().load(); + EXPECT_EQ(step_2, step_3); + replaceWriteLogMessage(myWriteLogMessage); + uint32_t step_4 = getCallCounter().load(); + EXPECT_EQ(step_3, step_4); + writeLogMessage(cv::utils::logging::LOG_LEVEL_DEBUG, "msg"); + uint32_t step_5 = getCallCounter().load(); + EXPECT_EQ(step_4 + 1, step_5); + writeLogMessage(cv::utils::logging::LOG_LEVEL_DEBUG, "msg"); + uint32_t step_6 = getCallCounter().load(); + EXPECT_EQ(step_5 + 1, step_6); + replaceWriteLogMessage(nullptr); + uint32_t step_7 = getCallCounter().load(); + EXPECT_EQ(step_6, step_7); + writeLogMessage(cv::utils::logging::LOG_LEVEL_DEBUG, "msg"); + uint32_t step_8 = getCallCounter().load(); + EXPECT_EQ(step_7, step_8); + uint32_t flags = getCallFlagger().load(); + EXPECT_NE(flags & 1024u, 0u); +} + +TEST(Core_Logger_Replace, WriteLogMessageExReplaceRestore) +{ + uint32_t step_0 = getCallCounter().load(); + writeLogMessageEx(cv::utils::logging::LOG_LEVEL_DEBUG, "tag", "file", 0, "func", "msg"); + uint32_t step_1 = getCallCounter().load(); + EXPECT_EQ(step_0, step_1); + replaceWriteLogMessageEx(nullptr); + uint32_t step_2 = getCallCounter().load(); + EXPECT_EQ(step_1, step_2); + writeLogMessageEx(cv::utils::logging::LOG_LEVEL_DEBUG, "tag", "file", 0, "func", "msg"); + uint32_t step_3 = getCallCounter().load(); + EXPECT_EQ(step_2, step_3); + replaceWriteLogMessageEx(myWriteLogMessageEx); + uint32_t step_4 = getCallCounter().load(); + EXPECT_EQ(step_3, step_4); + writeLogMessageEx(cv::utils::logging::LOG_LEVEL_DEBUG, "tag", "file", 0, "func", "msg"); + uint32_t step_5 = getCallCounter().load(); + EXPECT_EQ(step_4 + 1, step_5); + writeLogMessageEx(cv::utils::logging::LOG_LEVEL_DEBUG, "tag", "file", 0, "func", "msg"); + uint32_t step_6 = getCallCounter().load(); + EXPECT_EQ(step_5 + 1, step_6); + replaceWriteLogMessageEx(nullptr); + uint32_t step_7 = getCallCounter().load(); + EXPECT_EQ(step_6, step_7); + writeLogMessageEx(cv::utils::logging::LOG_LEVEL_DEBUG, "tag", "file", 0, "func", "msg"); + uint32_t step_8 = getCallCounter().load(); + EXPECT_EQ(step_7, step_8); + uint32_t flags = getCallFlagger().load(); + EXPECT_NE(flags & 2048u, 0u); +} + +}} // namespace \ No newline at end of file