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 #define RTE_LOGTYPE_PORT    0x00002000 /**< Log related to port. */
  78 #define RTE_LOGTYPE_TABLE   0x00004000 /**< Log related to table. */
  79 #define RTE_LOGTYPE_PIPELINE 0x00008000 /**< Log related to pipeline. */
  80
  81 /* these log types can be used in an application */
  82 #define RTE_LOGTYPE_USER1   0x01000000 /**< User-defined log type 1. */
  83 #define RTE_LOGTYPE_USER2   0x02000000 /**< User-defined log type 2. */
  84 #define RTE_LOGTYPE_USER3   0x04000000 /**< User-defined log type 3. */
  85 #define RTE_LOGTYPE_USER4   0x08000000 /**< User-defined log type 4. */
  86 #define RTE_LOGTYPE_USER5   0x10000000 /**< User-defined log type 5. */
  87 #define RTE_LOGTYPE_USER6   0x20000000 /**< User-defined log type 6. */
  88 #define RTE_LOGTYPE_USER7   0x40000000 /**< User-defined log type 7. */
  89 #define RTE_LOGTYPE_USER8   0x80000000 /**< User-defined log type 8. */
  90
  91 /* Can't use 0, as it gives compiler warnings */
  92 #define RTE_LOG_EMERG    1U  /**< System is unusable.               */
  93 #define RTE_LOG_ALERT    2U  /**< Action must be taken immediately. */
  94 #define RTE_LOG_CRIT     3U  /**< Critical conditions.              */
  95 #define RTE_LOG_ERR      4U  /**< Error conditions.                 */
  96 #define RTE_LOG_WARNING  5U  /**< Warning conditions.               */
  97 #define RTE_LOG_NOTICE   6U  /**< Normal but significant condition. */
  98 #define RTE_LOG_INFO     7U  /**< Informational.                    */
  99 #define RTE_LOG_DEBUG    8U  /**< Debug-level messages.             */
 100
 101 /** The default log stream. */
 102 extern FILE *eal_default_log_stream;
 103
 104 /**
 105  * Change the stream that will be used by the logging system.
 106  *
 107  * This can be done at any time. The f argument represents the stream
 108  * to be used to send the logs. If f is NULL, the default output is
 109  * used (stderr).
 110  *
 111  * @param f
 112  *   Pointer to the stream.
 113  * @return
 114  *   - 0 on success.
 115  *   - Negative on error.
 116  */
 117 int rte_openlog_stream(FILE *f);
 118
 119 /**
 120  * Set the global log level.
 121  *
 122  * After this call, all logs that are lower or equal than level and
 123  * lower or equal than the RTE_LOG_LEVEL configuration option will be
 124  * displayed.
 125  *
 126  * @param level
 127  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 128  */
 129 void rte_set_log_level(uint32_t level);
 130
 131 /**
 132  * Get the global log level.
 133  */
 134 uint32_t rte_get_log_level(void);
 135
 136 /**
 137  * Enable or disable the log type.
 138  *
 139  * @param type
 140  *   Log type, for example, RTE_LOGTYPE_EAL.
 141  * @param enable
 142  *   True for enable; false for disable.
 143  */
 144 void rte_set_log_type(uint32_t type, int enable);
 145
 146 /**
 147  * Get the global log type.
 148  */
 149 uint32_t rte_get_log_type(void);
 150
 151 /**
 152  * Get the current loglevel for the message being processed.
 153  *
 154  * Before calling the user-defined stream for logging, the log
 155  * subsystem sets a per-lcore variable containing the loglevel and the
 156  * logtype of the message being processed. This information can be
 157  * accessed by the user-defined log output function through this
 158  * function.
 159  *
 160  * @return
 161  *   The loglevel of the message being processed.
 162  */
 163 int rte_log_cur_msg_loglevel(void);
 164
 165 /**
 166  * Get the current logtype for the message being processed.
 167  *
 168  * Before calling the user-defined stream for logging, the log
 169  * subsystem sets a per-lcore variable containing the loglevel and the
 170  * logtype of the message being processed. This information can be
 171  * accessed by the user-defined log output function through this
 172  * function.
 173  *
 174  * @return
 175  *   The logtype of the message being processed.
 176  */
 177 int rte_log_cur_msg_logtype(void);
 178
 179 /**
 180  * Enable or disable the history (enabled by default)
 181  *
 182  * @param enable
 183  *   true to enable, or 0 to disable history.
 184  */
 185 void rte_log_set_history(int enable);
 186
 187 /**
 188  * Dump the log history to a file
 189  *
 190  * @param f
 191  *   A pointer to a file for output
 192  */
 193 void rte_log_dump_history(FILE *f);
 194
 195 /**
 196  * Add a log message to the history.
 197  *
 198  * This function can be called from a user-defined log stream. It adds
 199  * the given message in the history that can be dumped using
 200  * rte_log_dump_history().
 201  *
 202  * @param buf
 203  *   A data buffer containing the message to be saved in the history.
 204  * @param size
 205  *   The length of the data buffer.
 206  * @return
 207  *   - 0: Success.
 208  *   - (-ENOBUFS) if there is no room to store the message.
 209  */
 210 int rte_log_add_in_history(const char *buf, size_t size);
 211
 212 /**
 213  * Generates a log message.
 214  *
 215  * The message will be sent in the stream defined by the previous call
 216  * to rte_openlog_stream().
 217  *
 218  * The level argument determines if the log should be displayed or
 219  * not, depending on the global rte_logs variable.
 220  *
 221  * The preferred alternative is the RTE_LOG() function because debug logs may
 222  * be removed at compilation time if optimization is enabled. Moreover,
 223  * logs are automatically prefixed by type when using the macro.
 224  *
 225  * @param level
 226  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 227  * @param logtype
 228  *   The log type, for example, RTE_LOGTYPE_EAL.
 229  * @param format
 230  *   The format string, as in printf(3), followed by the variable arguments
 231  *   required by the format.
 232  * @return
 233  *   - 0: Success.
 234  *   - Negative on error.
 235  */
 236 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 237 #ifdef __GNUC__
 238 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
 239         __attribute__((cold))
 240 #endif
 241 #endif
 242         __attribute__((format(printf, 3, 4)));
 243
 244 /**
 245  * Generates a log message.
 246  *
 247  * The message will be sent in the stream defined by the previous call
 248  * to rte_openlog_stream().
 249  *
 250  * The level argument determines if the log should be displayed or
 251  * not, depending on the global rte_logs variable. A trailing
 252  * newline may be added if needed.
 253  *
 254  * The preferred alternative is the RTE_LOG() because debug logs may be
 255  * removed at compilation time.
 256  *
 257  * @param level
 258  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 259  * @param logtype
 260  *   The log type, for example, RTE_LOGTYPE_EAL.
 261  * @param format
 262  *   The format string, as in printf(3), followed by the variable arguments
 263  *   required by the format.
 264  * @param ap
 265  *   The va_list of the variable arguments required by the format.
 266  * @return
 267  *   - 0: Success.
 268  *   - Negative on error.
 269  */
 270 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 271         __attribute__((format(printf,3,0)));
 272
 273 /**
 274  * Generates a log message.
 275  *
 276  * The RTE_LOG() is equivalent to rte_log() with two differences:
 277
 278  * - RTE_LOG() can be used to remove debug logs at compilation time,
 279  *   depending on RTE_LOG_LEVEL configuration option, and compilation
 280  *   optimization level. If optimization is enabled, the tests
 281  *   involving constants only are pre-computed. If compilation is done
 282  *   with -O0, these tests will be done at run time.
 283  * - The log level and log type names are smaller, for example:
 284  *   RTE_LOG(INFO, EAL, "this is a %s", "log");
 285  *
 286  * @param l
 287  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 288  *   expanded by the macro, so it cannot be an integer value.
 289  * @param t
 290  *   The log type, for example, EAL. The short name is expanded by the
 291  *   macro, so it cannot be an integer value.
 292  * @param ...
 293  *   The fmt string, as in printf(3), followed by the variable arguments
 294  *   required by the format.
 295  * @return
 296  *   - 0: Success.
 297  *   - Negative on error.
 298  */
 299 #define RTE_LOG(l, t, ...)                                      \
 300         (void)((RTE_LOG_ ## l <= RTE_LOG_LEVEL) ?               \
 301          rte_log(RTE_LOG_ ## l,                                 \
 302                  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) :     \
 303          0)
 304
 305 #ifdef __cplusplus
 306 }
 307 #endif
 308
 309 #endif /* _RTE_LOG_H_ */