lib/librte_eal/common/include/rte_log.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _RTE_LOG_H_
  36 #define _RTE_LOG_H_
  37
  38 /**
  39  * @file
  40  *
  41  * RTE Logs API
  42  *
  43  * This file provides a log API to RTE applications.
  44  */
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 #include <stdint.h>
  51 #include <stdio.h>
  52 #include <stdarg.h>
  53
  54 /** The rte_log structure. */
  55 struct rte_logs {
  56         uint32_t type;  /**< Bitfield with enabled logs. */
  57         uint32_t level; /**< Log level. */
  58         FILE *file;     /**< Pointer to current FILE* for logs. */
  59 };
  60
  61 /** Global log informations */
  62 extern struct rte_logs rte_logs;
  63
  64 /* SDK log type */
  65 #define RTE_LOGTYPE_EAL     0x00000001 /**< Log related to eal. */
  66 #define RTE_LOGTYPE_MALLOC  0x00000002 /**< Log related to malloc. */
  67 #define RTE_LOGTYPE_RING    0x00000004 /**< Log related to ring. */
  68 #define RTE_LOGTYPE_MEMPOOL 0x00000008 /**< Log related to mempool. */
  69 #define RTE_LOGTYPE_TIMER   0x00000010 /**< Log related to timers. */
  70 #define RTE_LOGTYPE_PMD     0x00000020 /**< Log related to poll mode driver. */
  71 #define RTE_LOGTYPE_HASH    0x00000040 /**< Log related to hash table. */
  72 #define RTE_LOGTYPE_LPM     0x00000080 /**< Log related to LPM. */
  73
  74 /* these log types can be used in an application */
  75 #define RTE_LOGTYPE_USER1   0x01000000 /**< User-defined log type 1. */
  76 #define RTE_LOGTYPE_USER2   0x02000000 /**< User-defined log type 2. */
  77 #define RTE_LOGTYPE_USER3   0x04000000 /**< User-defined log type 3. */
  78 #define RTE_LOGTYPE_USER4   0x08000000 /**< User-defined log type 4. */
  79 #define RTE_LOGTYPE_USER5   0x10000000 /**< User-defined log type 5. */
  80 #define RTE_LOGTYPE_USER6   0x20000000 /**< User-defined log type 6. */
  81 #define RTE_LOGTYPE_USER7   0x40000000 /**< User-defined log type 7. */
  82 #define RTE_LOGTYPE_USER8   0x80000000 /**< User-defined log type 8. */
  83
  84 /* Can't use 0, as it gives compiler warnings */
  85 #define RTE_LOG_EMERG    1U  /**< System is unusable.               */
  86 #define RTE_LOG_ALERT    2U  /**< Action must be taken immediately. */
  87 #define RTE_LOG_CRIT     3U  /**< Critical conditions.              */
  88 #define RTE_LOG_ERR      4U  /**< Error conditions.                 */
  89 #define RTE_LOG_WARNING  5U  /**< Warning conditions.               */
  90 #define RTE_LOG_NOTICE   6U  /**< Normal but significant condition. */
  91 #define RTE_LOG_INFO     7U  /**< Informational.                    */
  92 #define RTE_LOG_DEBUG    8U  /**< Debug-level messages.             */
  93
  94 /** The default log stream. */
  95 extern FILE *eal_default_log_stream;
  96
  97 /**
  98  * Change the stream that will be used by the logging system.
  99  *
 100  * This can be done at any time. The f argument represents the stream
 101  * to be used to send the logs. If f is NULL, the default output is
 102  * used, which is the serial line in case of bare metal, or directly
 103  * sent to syslog in case of linux application.
 104  *
 105  * @param f
 106  *   Pointer to the stream.
 107  * @return
 108  *   - 0 on success.
 109  *   - Negative on error.
 110  */
 111 int rte_openlog_stream(FILE *f);
 112
 113 /**
 114  * Set the global log level.
 115  *
 116  * After this call, all logs that are lower or equal than level and
 117  * lower or equal than the RTE_LOG_LEVEL configuration option will be
 118  * displayed.
 119  *
 120  * @param level
 121  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 122  */
 123 void rte_set_log_level(uint32_t level);
 124
 125 /**
 126  * Enable or disable the log type.
 127  *
 128  * @param type
 129  *   Log type, for example, RTE_LOGTYPE_EAL.
 130  * @param enable
 131  *   True for enable; false for disable.
 132  */
 133 void rte_set_log_type(uint32_t type, int enable);
 134
 135 /**
 136  * Get the current loglevel for the message being processed.
 137  *
 138  * Before calling the user-defined stream for logging, the log
 139  * subsystem sets a per-lcore variable containing the loglevel and the
 140  * logtype of the message being processed. This information can be
 141  * accessed by the user-defined log output function through this
 142  * function.
 143  *
 144  * @return
 145  *   The loglevel of the message being processed.
 146  */
 147 int rte_log_cur_msg_loglevel(void);
 148
 149 /**
 150  * Get the current logtype for the message being processed.
 151  *
 152  * Before calling the user-defined stream for logging, the log
 153  * subsystem sets a per-lcore variable containing the loglevel and the
 154  * logtype of the message being processed. This information can be
 155  * accessed by the user-defined log output function through this
 156  * function.
 157  *
 158  * @return
 159  *   The logtype of the message being processed.
 160  */
 161 int rte_log_cur_msg_logtype(void);
 162
 163 /**
 164  * Enable or disable the history (enabled by default)
 165  *
 166  * @param enable
 167  *   true to enable, or 0 to disable history.
 168  */
 169 void rte_log_set_history(int enable);
 170
 171 /**
 172  * Dump the log history to the console.
 173  */
 174 void rte_log_dump_history(void);
 175
 176 /**
 177  * Add a log message to the history.
 178  *
 179  * This function can be called from a user-defined log stream. It adds
 180  * the given message in the history that can be dumped using
 181  * rte_log_dump_history().
 182  *
 183  * @param buf
 184  *   A data buffer containing the message to be saved in the history.
 185  * @param size
 186  *   The length of the data buffer.
 187  * @return
 188  *   - 0: Success.
 189  *   - (-ENOBUFS) if there is no room to store the message.
 190  */
 191 int rte_log_add_in_history(const char *buf, size_t size);
 192
 193 /**
 194  * Generates a log message.
 195  *
 196  * The message will be sent in the stream defined by the previous call
 197  * to rte_openlog_stream().
 198  *
 199  * The level argument determines if the log should be displayed or
 200  * not, depending on the global rte_logs variable.
 201  *
 202  * The preferred alternative is the RTE_LOG() function because debug logs may
 203  * be removed at compilation time if optimization is enabled. Moreover,
 204  * logs are automatically prefixed by type when using the macro.
 205  *
 206  * @param level
 207  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 208  * @param logtype
 209  *   The log type, for example, RTE_LOGTYPE_EAL.
 210  * @param format
 211  *   The format string, as in printf(3), followed by the variable arguments
 212  *   required by the format.
 213  * @return
 214  *   - 0: Success.
 215  *   - Negative on error.
 216  */
 217 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 218         __attribute__((format(printf, 3, 4)));
 219
 220 /**
 221  * Generates a log message.
 222  *
 223  * The message will be sent in the stream defined by the previous call
 224  * to rte_openlog_stream().
 225  *
 226  * The level argument determines if the log should be displayed or
 227  * not, depending on the global rte_logs variable. A trailing
 228  * newline may be added if needed.
 229  *
 230  * The preferred alternative is the RTE_LOG() because debug logs may be
 231  * removed at compilation time.
 232  *
 233  * @param level
 234  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 235  * @param logtype
 236  *   The log type, for example, RTE_LOGTYPE_EAL.
 237  * @param format
 238  *   The format string, as in printf(3), followed by the variable arguments
 239  *   required by the format.
 240  * @param ap
 241  *   The va_list of the variable arguments required by the format.
 242  * @return
 243  *   - 0: Success.
 244  *   - Negative on error.
 245  */
 246 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap);
 247
 248 /**
 249  * Generates a log message.
 250  *
 251  * The RTE_LOG() is equivalent to rte_log() with two differences:
 252
 253  * - RTE_LOG() can be used to remove debug logs at compilation time,
 254  *   depending on RTE_LOG_LEVEL configuration option, and compilation
 255  *   optimization level. If optimization is enabled, the tests
 256  *   involving constants only are pre-computed. If compilation is done
 257  *   with -O0, these tests will be done at run time.
 258  * - The log level and log type names are smaller, for example:
 259  *   RTE_LOG(INFO, EAL, "this is a %s", "log");
 260  *
 261  * @param l
 262  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 263  *   expanded by the macro, so it cannot be an integer value.
 264  * @param t
 265  *   The log type, for example, EAL. The short name is expanded by the
 266  *   macro, so it cannot be an integer value.
 267  * @param fmt
 268  *   The fmt string, as in printf(3), followed by the variable arguments
 269  *   required by the format.
 270  * @param args
 271  *   The variable list of arguments according to the format string.
 272  * @return
 273  *   - 0: Success.
 274  *   - Negative on error.
 275  */
 276 #define RTE_LOG(l, t, fmt, args...) ({                                  \
 277         if ((RTE_LOG_##l <= RTE_LOG_LEVEL) &&                           \
 278             (RTE_LOG_##l <= rte_logs.level) &&                          \
 279             (RTE_LOGTYPE_##t & rte_logs.type)) {                        \
 280                 rte_log(RTE_LOG_##l, RTE_LOGTYPE_##t,                   \
 281                           #t ": " fmt, ## args);                        \
 282         }                                                               \
 283 })
 284
 285 #ifdef __cplusplus
 286 }
 287 #endif
 288
 289 #endif /* _RTE_LOG_H_ */