Merge pull request #27154 from kinchungwong:logging_callback_simple_c

User-defined logger callback, C-style. #27154 This is a competing PR, an alternative to #27140 Both functions accept C-style pointer to static functions. Both functions allow restoring the OpenCV built-in implementation by passing in a nullptr. - replaceWriteLogMessage - replaceWriteLogMessageEx This implementation is not compatible with C++ log handler objects. This implementation has minimal thread safety, in the sense that the function pointer are stored and read atomically. But otherwise, the user-defined static functions must accept calls at all times, even after having been deregistered, because some log calls may have started before deregistering. ### Pull Request Readiness Checklist See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request - [x] I agree to contribute to the project under Apache 2 License. - [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV - [ ] The PR is proposed to the proper branch - [ ] There is a reference to the original bug report and related work - [ ] There is accuracy test, performance test and test data in opencv_extra repository, if applicable Patch to opencv_extra has the same branch name. - [ ] The feature is well documented and sample code can be built with the project CMake
2026-07-29 15:23:05 +04:00 · 2025-03-30 06:17:07 -07:00
parent 767407e711
commit afc7c0a89c
3 changed files with 194 additions and 0 deletions
@@ -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 <atomic>
+#include <opencv2/core/utils/logger.hpp>
+
+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<uint32_t>& getCallFlagger()
+{
+    static std::atomic<uint32_t> callFlagger(0);
+    return callFlagger;
+}
+
+std::atomic<uint32_t>& getCallCounter()
+{
+    static std::atomic<uint32_t> 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