arm_compute/core/Log.h

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