xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/core/utils/logging/Macros.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_LOGGING_MACROS_H
25 #define ARM_COMPUTE_LOGGING_MACROS_H
26 
27 #include "arm_compute/core/utils/logging/LoggerRegistry.h"
28 
29 #include <sstream>
30 
31 #ifdef ARM_COMPUTE_LOGGING_ENABLED
32 
33 #ifdef __GNUC__
signature_name(const std::string & pretty_func)34 inline std::string signature_name(const std::string &pretty_func)
35 {
36     const auto scope_op = pretty_func.find("::");
37     const auto begin    = pretty_func.substr(0, scope_op).rfind(" ") + 1;
38     const auto end      = pretty_func.rfind("(") - begin;
39 
40     return pretty_func.substr(begin, end) + "()";
41 }
42 #define ARM_COMPUTE_SIGNATURE_NAME signature_name(__PRETTY_FUNCTION__)
43 #else /* __GNUC__ */
44 #define ARM_COMPUTE_SIGNATURE_NAME (__func__)
45 #endif /* __GNUC__ */
46 
47 #define ARM_COMPUTE_LOG_MSG(logger_name, log_level, msg)                                 \
48     do                                                                                   \
49     {                                                                                    \
50         auto __logger = arm_compute::logging::LoggerRegistry::get().logger(logger_name); \
51         if(__logger != nullptr)                                                          \
52         {                                                                                \
53             __logger->log(log_level, msg);                                               \
54         }                                                                                \
55     } while(false)
56 
57 #define ARM_COMPUTE_LOG_MSG_WITH_FUNCNAME(logger_name, log_level, msg)                   \
58     do                                                                                   \
59     {                                                                                    \
60         auto __logger = arm_compute::logging::LoggerRegistry::get().logger(logger_name); \
61         if(__logger != nullptr)                                                          \
62         {                                                                                \
63             std::ostringstream s;                                                        \
64             s << ARM_COMPUTE_SIGNATURE_NAME << " : " << msg;                             \
65             __logger->log(log_level, s.str());                                           \
66         }                                                                                \
67     } while(false)
68 
69 #define ARM_COMPUTE_LOG_MSG_WITH_FORMAT(logger_name, log_level, fmt, ...)                     \
70     do                                                                                        \
71     {                                                                                         \
72         auto __logger = arm_compute::logging::LoggerRegistry::get().logger(logger_name);      \
73         if(__logger != nullptr)                                                               \
74         {                                                                                     \
75             size_t size     = ::snprintf(nullptr, 0, fmt, __VA_ARGS__) + 1;                   \
76             auto   char_str = std::make_unique<char[]>(size);                                 \
77             ::snprintf(char_str.get(), size, fmt, __VA_ARGS__);                               \
78             __logger->log(log_level, std::string(char_str.get(), char_str.get() + size - 1)); \
79         }                                                                                     \
80     } while(false)
81 
82 #define ARM_COMPUTE_LOG_STREAM(logger_name, log_level, stream)                           \
83     do                                                                                   \
84     {                                                                                    \
85         auto __logger = arm_compute::logging::LoggerRegistry::get().logger(logger_name); \
86         if(__logger != nullptr)                                                          \
87         {                                                                                \
88             std::ostringstream s;                                                        \
89             s << stream;                                                                 \
90             __logger->log(log_level, s.str());                                           \
91         }                                                                                \
92     } while(false)
93 
94 #else /* ARM_COMPUTE_LOGGING_ENABLED */
95 
96 #define ARM_COMPUTE_LOG_MSG(logger_name, log_level, msg)
97 #define ARM_COMPUTE_LOG_MSG_WITH_FUNCNAME(logger_name, log_level, msg)
98 #define ARM_COMPUTE_LOG_MSG_WITH_FORMAT(logger_name, log_level, fmt, ...)
99 #define ARM_COMPUTE_LOG_STREAM(logger_name, log_level, stream)
100 
101 #endif /* ARM_COMPUTE_LOGGING_ENABLED */
102 
103 #endif /* ARM_COMPUTE_LOGGING_MACROS_H */
104