lib/librte_eal/common/include/rte_log.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 #ifndef _RTE_LOG_H_
  35 #define _RTE_LOG_H_
  36
  37 /**
  38  * @file
  39  *
  40  * RTE Logs API
  41  *
  42  * This file provides a log API to RTE applications.
  43  */
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #include <stdint.h>
  50 #include <stdio.h>
  51 #include <stdarg.h>
  52
  53 /** The rte_log structure. */
  54 struct rte_logs {
  55         uint32_t type;  /**< Bitfield with enabled logs. */
  56         uint32_t level; /**< Log level. */
  57         FILE *file;     /**< Pointer to current FILE* for logs. */
  58 };
  59
  60 /** Global log informations */
  61 extern struct rte_logs rte_logs;
  62
  63 /* SDK log type */
  64 #define RTE_LOGTYPE_EAL     0x00000001 /**< Log related to eal. */
  65 #define RTE_LOGTYPE_MALLOC  0x00000002 /**< Log related to malloc. */
  66 #define RTE_LOGTYPE_RING    0x00000004 /**< Log related to ring. */
  67 #define RTE_LOGTYPE_MEMPOOL 0x00000008 /**< Log related to mempool. */
  68 #define RTE_LOGTYPE_TIMER   0x00000010 /**< Log related to timers. */
  69 #define RTE_LOGTYPE_PMD     0x00000020 /**< Log related to poll mode driver. */
  70 #define RTE_LOGTYPE_HASH    0x00000040 /**< Log related to hash table. */
  71 #define RTE_LOGTYPE_LPM     0x00000080 /**< Log related to LPM. */
  72 #define RTE_LOGTYPE_KNI     0x00000100 /**< Log related to KNI. */
  73 #define RTE_LOGTYPE_ACL     0x00000200 /**< Log related to ACL. */
  74 #define RTE_LOGTYPE_POWER   0x00000400 /**< Log related to power. */
  75 #define RTE_LOGTYPE_METER   0x00000800 /**< Log related to QoS meter. */
  76 #define RTE_LOGTYPE_SCHED   0x00001000 /**< Log related to QoS port scheduler. */
  77
  78 /* these log types can be used in an application */
  79 #define RTE_LOGTYPE_USER1   0x01000000 /**< User-defined log type 1. */
  80 #define RTE_LOGTYPE_USER2   0x02000000 /**< User-defined log type 2. */
  81 #define RTE_LOGTYPE_USER3   0x04000000 /**< User-defined log type 3. */
  82 #define RTE_LOGTYPE_USER4   0x08000000 /**< User-defined log type 4. */
  83 #define RTE_LOGTYPE_USER5   0x10000000 /**< User-defined log type 5. */
  84 #define RTE_LOGTYPE_USER6   0x20000000 /**< User-defined log type 6. */
  85 #define RTE_LOGTYPE_USER7   0x40000000 /**< User-defined log type 7. */
  86 #define RTE_LOGTYPE_USER8   0x80000000 /**< User-defined log type 8. */
  87
  88 /* Can't use 0, as it gives compiler warnings */
  89 #define RTE_LOG_EMERG    1U  /**< System is unusable.               */
  90 #define RTE_LOG_ALERT    2U  /**< Action must be taken immediately. */
  91 #define RTE_LOG_CRIT     3U  /**< Critical conditions.              */
  92 #define RTE_LOG_ERR      4U  /**< Error conditions.                 */
  93 #define RTE_LOG_WARNING  5U  /**< Warning conditions.               */
  94 #define RTE_LOG_NOTICE   6U  /**< Normal but significant condition. */
  95 #define RTE_LOG_INFO     7U  /**< Informational.                    */
  96 #define RTE_LOG_DEBUG    8U  /**< Debug-level messages.             */
  97
  98 /** The default log stream. */
  99 extern FILE *eal_default_log_stream;
 100
 101 /**
 102  * Change the stream that will be used by the logging system.
 103  *
 104  * This can be done at any time. The f argument represents the stream
 105  * to be used to send the logs. If f is NULL, the default output is
 106  * used, which is the serial line in case of bare metal, or directly
 107  * sent to syslog in case of linux application.
 108  *
 109  * @param f
 110  *   Pointer to the stream.
 111  * @return
 112  *   - 0 on success.
 113  *   - Negative on error.
 114  */
 115 int rte_openlog_stream(FILE *f);
 116
 117 /**
 118  * Set the global log level.
 119  *
 120  * After this call, all logs that are lower or equal than level and
 121  * lower or equal than the RTE_LOG_LEVEL configuration option will be
 122  * displayed.
 123  *
 124  * @param level
 125  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 126  */
 127 void rte_set_log_level(uint32_t level);
 128
 129 /**
 130  * Enable or disable the log type.
 131  *
 132  * @param type
 133  *   Log type, for example, RTE_LOGTYPE_EAL.
 134  * @param enable
 135  *   True for enable; false for disable.
 136  */
 137 void rte_set_log_type(uint32_t type, int enable);
 138
 139 /**
 140  * Get the current loglevel for the message being processed.
 141  *
 142  * Before calling the user-defined stream for logging, the log
 143  * subsystem sets a per-lcore variable containing the loglevel and the
 144  * logtype of the message being processed. This information can be
 145  * accessed by the user-defined log output function through this
 146  * function.
 147  *
 148  * @return
 149  *   The loglevel of the message being processed.
 150  */
 151 int rte_log_cur_msg_loglevel(void);
 152
 153 /**
 154  * Get the current logtype for the message being processed.
 155  *
 156  * Before calling the user-defined stream for logging, the log
 157  * subsystem sets a per-lcore variable containing the loglevel and the
 158  * logtype of the message being processed. This information can be
 159  * accessed by the user-defined log output function through this
 160  * function.
 161  *
 162  * @return
 163  *   The logtype of the message being processed.
 164  */
 165 int rte_log_cur_msg_logtype(void);
 166
 167 /**
 168  * Enable or disable the history (enabled by default)
 169  *
 170  * @param enable
 171  *   true to enable, or 0 to disable history.
 172  */
 173 void rte_log_set_history(int enable);
 174
 175 /**
 176  * Dump the log history to a file
 177  *
 178  * @param f
 179  *   A pointer to a file for output
 180  */
 181 void rte_log_dump_history(FILE *f);
 182
 183 /**
 184  * Add a log message to the history.
 185  *
 186  * This function can be called from a user-defined log stream. It adds
 187  * the given message in the history that can be dumped using
 188  * rte_log_dump_history().
 189  *
 190  * @param buf
 191  *   A data buffer containing the message to be saved in the history.
 192  * @param size
 193  *   The length of the data buffer.
 194  * @return
 195  *   - 0: Success.
 196  *   - (-ENOBUFS) if there is no room to store the message.
 197  */
 198 int rte_log_add_in_history(const char *buf, size_t size);
 199
 200 /**
 201  * Generates a log message.
 202  *
 203  * The message will be sent in the stream defined by the previous call
 204  * to rte_openlog_stream().
 205  *
 206  * The level argument determines if the log should be displayed or
 207  * not, depending on the global rte_logs variable.
 208  *
 209  * The preferred alternative is the RTE_LOG() function because debug logs may
 210  * be removed at compilation time if optimization is enabled. Moreover,
 211  * logs are automatically prefixed by type when using the macro.
 212  *
 213  * @param level
 214  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 215  * @param logtype
 216  *   The log type, for example, RTE_LOGTYPE_EAL.
 217  * @param format
 218  *   The format string, as in printf(3), followed by the variable arguments
 219  *   required by the format.
 220  * @return
 221  *   - 0: Success.
 222  *   - Negative on error.
 223  */
 224 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 225 #ifdef __GNUC__
 226 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
 227         __attribute__((cold))
 228 #endif
 229 #endif
 230         __attribute__((format(printf, 3, 4)));
 231
 232 /**
 233  * Generates a log message.
 234  *
 235  * The message will be sent in the stream defined by the previous call
 236  * to rte_openlog_stream().
 237  *
 238  * The level argument determines if the log should be displayed or
 239  * not, depending on the global rte_logs variable. A trailing
 240  * newline may be added if needed.
 241  *
 242  * The preferred alternative is the RTE_LOG() because debug logs may be
 243  * removed at compilation time.
 244  *
 245  * @param level
 246  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 247  * @param logtype
 248  *   The log type, for example, RTE_LOGTYPE_EAL.
 249  * @param format
 250  *   The format string, as in printf(3), followed by the variable arguments
 251  *   required by the format.
 252  * @param ap
 253  *   The va_list of the variable arguments required by the format.
 254  * @return
 255  *   - 0: Success.
 256  *   - Negative on error.
 257  */
 258 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap);
 259
 260 /**
 261  * Generates a log message.
 262  *
 263  * The RTE_LOG() is equivalent to rte_log() with two differences:
 264
 265  * - RTE_LOG() can be used to remove debug logs at compilation time,
 266  *   depending on RTE_LOG_LEVEL configuration option, and compilation
 267  *   optimization level. If optimization is enabled, the tests
 268  *   involving constants only are pre-computed. If compilation is done
 269  *   with -O0, these tests will be done at run time.
 270  * - The log level and log type names are smaller, for example:
 271  *   RTE_LOG(INFO, EAL, "this is a %s", "log");
 272  *
 273  * @param l
 274  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 275  *   expanded by the macro, so it cannot be an integer value.
 276  * @param t
 277  *   The log type, for example, EAL. The short name is expanded by the
 278  *   macro, so it cannot be an integer value.
 279  * @param fmt
 280  *   The fmt string, as in printf(3), followed by the variable arguments
 281  *   required by the format.
 282  * @param args
 283  *   The variable list of arguments according to the format string.
 284  * @return
 285  *   - 0: Success.
 286  *   - Negative on error.
 287  */
 288 #define RTE_LOG(l, t, ...)                                      \
 289         (void)(((RTE_LOG_ ## l <= RTE_LOG_LEVEL) &&                     \
 290           (RTE_LOG_ ## l <= rte_logs.level) &&                  \
 291           (RTE_LOGTYPE_ ## t & rte_logs.type)) ?                \
 292          rte_log(RTE_LOG_ ## l,                                 \
 293                  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) :     \
 294          0)
 295
 296 #ifdef __cplusplus
 297 }
 298 #endif
 299
 300 #endif /* _RTE_LOG_H_ */