include/tdm_log.h

   1 /**************************************************************************
   2  *
   3  * libtdm
   4  *
   5  * Copyright 2015 Samsung Electronics co., Ltd. All Rights Reserved.
   6  *
   7  * Contact: Eunchul Kim <chulspro.kim@samsung.com>,
   8  *          JinYoung Jeon <jy0.jeon@samsung.com>,
   9  *          Taeheon Kim <th908.kim@samsung.com>,
  10  *          YoungJun Cho <yj44.cho@samsung.com>,
  11  *          SooChan Lim <sc1.lim@samsung.com>,
  12  *          Boram Park <sc1.lim@samsung.com>
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a
  15  * copy of this software and associated documentation files (the
  16  * "Software"), to deal in the Software without restriction, including
  17  * without limitation the rights to use, copy, modify, merge, publish,
  18  * distribute, sub license, and/or sell copies of the Software, and to
  19  * permit persons to whom the Software is furnished to do so, subject to
  20  * the following conditions:
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  27  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  29  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  30  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  31  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  32  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33  *
  34 **************************************************************************/
  35
  36 #ifndef _TDM_LOG_H_
  37 #define _TDM_LOG_H_
  38
  39 #include <unistd.h>
  40 #include <sys/syscall.h>
  41 #include <time.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 /**
  48  * @file tdm_log.h
  49  * @brief The header file to print logs in frontend and backend modules
  50  * @details
  51  * The TDM debug log can be enable by setting "TDM_DEBUG" enviroment. And also,
  52  * the TDM dlog can be enable by setting "TDM_DLOG" enviroment.
  53  * @par Example
  54  * @code
  55  *  $ export TDM_DEBUG=1
  56  * @endcode
  57  */
  58
  59 enum {
  60         TDM_LOG_LEVEL_NONE,
  61         TDM_LOG_LEVEL_ERR,
  62         TDM_LOG_LEVEL_WRN,
  63         TDM_LOG_LEVEL_INFO,
  64         TDM_LOG_LEVEL_DBG,
  65 };
  66
  67 void tdm_log_enable_color(unsigned int enable);
  68 void tdm_log_enable_dlog(unsigned int enable);
  69 void tdm_log_set_debug_level(int level);
  70 void tdm_log_set_assert_level(int level);
  71 void tdm_log_set_path(const char *path);
  72 void tdm_log_printf(int level, const char *fmt, ...);
  73 void tdm_log_print(int level, const char *fmt, ...);
  74
  75 void tdm_log_reset(void);
  76
  77 extern unsigned int tdm_log_debug_level;
  78
  79 #define TDM_DBG(fmt, args...) \
  80         do { \
  81                 if (tdm_log_debug_level >= TDM_LOG_LEVEL_DBG) { \
  82                         struct timespec ts; \
  83                         clock_gettime(CLOCK_MONOTONIC, &ts); \
  84                         tdm_log_print(TDM_LOG_LEVEL_DBG, "[%5d.%06d][%d][%s %d]"fmt, \
  85                                                   (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
  86                                                   (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args);  \
  87                 } \
  88         } while (0)
  89 #define TDM_INFO(fmt, args...) \
  90         do { \
  91                 if (tdm_log_debug_level >= TDM_LOG_LEVEL_INFO) { \
  92                         struct timespec ts; \
  93                         clock_gettime(CLOCK_MONOTONIC, &ts); \
  94                         tdm_log_print(TDM_LOG_LEVEL_INFO, "[%5d.%06d][%d][%s %d]"fmt, \
  95                                                   (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
  96                                                   (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args);  \
  97                 } \
  98         } while (0)
  99 #define TDM_WRN(fmt, args...) \
 100         do { \
 101                 if (tdm_log_debug_level >= TDM_LOG_LEVEL_WRN) { \
 102                         struct timespec ts; \
 103                         clock_gettime(CLOCK_MONOTONIC, &ts); \
 104                         tdm_log_print(TDM_LOG_LEVEL_WRN, "[%5d.%06d][%d][%s %d]"fmt, \
 105                                                   (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
 106                                                   (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args);  \
 107                 } \
 108         } while (0)
 109 #define TDM_ERR(fmt, args...) \
 110         do { \
 111                 if (tdm_log_debug_level >= TDM_LOG_LEVEL_ERR) { \
 112                         struct timespec ts; \
 113                         clock_gettime(CLOCK_MONOTONIC, &ts); \
 114                         tdm_log_print(TDM_LOG_LEVEL_ERR, "[%5d.%06d][%d][%s %d]"fmt, \
 115                                                   (int)ts.tv_sec, (int)ts.tv_nsec / 1000, \
 116                                                   (int)syscall(SYS_gettid), __FUNCTION__, __LINE__, ##args);  \
 117                 } \
 118         } while (0)
 119
 120 #define TDM_NEVER_GET_HERE() TDM_WRN("** NEVER GET HERE **")
 121 #define TDM_DEPRECATED(str) \
 122         do { \
 123                 if (str) \
 124                         TDM_WRN("** DEPRECATED: %s **", str); \
 125                 else \
 126                         TDM_WRN("** DEPRECATED **"); \
 127         } while(0)
 128
 129 #ifdef __cplusplus
 130 }
 131 #endif
 132
 133 #endif /* _TDM_LOG_H_ */