xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/core/Log.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2019 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_LOG_H
25 #define ARM_COMPUTE_LOG_H
26 
27 #include "arm_compute/core/utils/logging/Macros.h"
28 
29 #ifdef ARM_COMPUTE_LOGGING_ENABLED
30 /** Create a default core logger
31  *
32  * @note It will eventually create all default loggers in don't exist
33  */
34 #define ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER()                                   \
35     do                                                                             \
36     {                                                                              \
37         if(arm_compute::logging::LoggerRegistry::get().logger("CORE") == nullptr)  \
38         {                                                                          \
39             arm_compute::logging::LoggerRegistry::get().create_reserved_loggers(); \
40         }                                                                          \
41     } while(false)
42 #else /* ARM_COMPUTE_LOGGING_ENABLED */
43 #define ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER()
44 #endif /* ARM_COMPUTE_LOGGING_ENABLED */
45 
46 /** Log a message to the core system logger
47  *
48  * @param[in] log_level Logging level
49  * @param[in] msg       Message to log
50  */
51 #define ARM_COMPUTE_LOG_MSG_CORE(log_level, msg)     \
52     do                                               \
53     {                                                \
54         ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER();    \
55         ARM_COMPUTE_LOG_MSG("CORE", log_level, msg); \
56     } while(false)
57 
58 /** Log a message with format to the core system logger
59  *
60  * @param[in] log_level Logging level
61  * @param[in] fmt       String format (printf style)
62  * @param[in] ...       Message arguments
63  */
64 #define ARM_COMPUTE_LOG_MSG_WITH_FORMAT_CORE(log_level, fmt, ...)             \
65     do                                                                        \
66     {                                                                         \
67         ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER();                             \
68         ARM_COMPUTE_LOG_MSG_WITH_FORMAT("CORE", log_level, fmt, __VA_ARGS__); \
69     } while(false)
70 
71 /** Log a stream to the core system logger
72  *
73  * @param[in] log_level Logging level
74  * @param[in] ss        Stream to log
75  */
76 #define ARM_COMPUTE_LOG_STREAM_CORE(log_level, ss)     \
77     do                                                 \
78     {                                                  \
79         ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER();      \
80         ARM_COMPUTE_LOG_STREAM("CORE", log_level, ss); \
81     } while(false)
82 
83 /** Log information level message to the core system logger
84  *
85  * @param[in] msg Stream to log
86  */
87 #define ARM_COMPUTE_LOG_INFO_MSG_CORE(msg)                                   \
88     do                                                                       \
89     {                                                                        \
90         ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER();                            \
91         ARM_COMPUTE_LOG_MSG_CORE(arm_compute::logging::LogLevel::INFO, msg); \
92     } while(false)
93 
94 /** Log information level formatted message to the core system logger
95  *
96  * @param[in] fmt String format (printf style)
97  * @param[in] ... Message arguments
98  */
99 #define ARM_COMPUTE_LOG_INFO_MSG_WITH_FORMAT_CORE(fmt, ...)                                            \
100     do                                                                                                 \
101     {                                                                                                  \
102         ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER();                                                      \
103         ARM_COMPUTE_LOG_MSG_WITH_FORMAT_CORE(arm_compute::logging::LogLevel::INFO, #fmt, __VA_ARGS__); \
104     } while(false)
105 
106 /** Log information level stream to the core system logger
107  *
108  * @param[in] ss Message to log
109  */
110 #define ARM_COMPUTE_LOG_INFO_STREAM_CORE(ss)                                   \
111     do                                                                         \
112     {                                                                          \
113         ARM_COMPUTE_CREATE_DEFAULT_CORE_LOGGER();                              \
114         ARM_COMPUTE_LOG_STREAM_CORE(arm_compute::logging::LogLevel::INFO, ss); \
115     } while(false)
116 
117 #endif /* ARM_COMPUTE_LOGGING_MACROS_H */
118