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;     /**< Output file set by rte_openlog_stream, or NULL. */
  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 #define RTE_LOGTYPE_MBUF    0x00010000 /**< Log related to mbuf. */
  81 #define RTE_LOGTYPE_CRYPTODEV 0x00020000 /**< Log related to cryptodev. */
  82
  83 /* these log types can be used in an application */
  84 #define RTE_LOGTYPE_USER1   0x01000000 /**< User-defined log type 1. */
  85 #define RTE_LOGTYPE_USER2   0x02000000 /**< User-defined log type 2. */
  86 #define RTE_LOGTYPE_USER3   0x04000000 /**< User-defined log type 3. */
  87 #define RTE_LOGTYPE_USER4   0x08000000 /**< User-defined log type 4. */
  88 #define RTE_LOGTYPE_USER5   0x10000000 /**< User-defined log type 5. */
  89 #define RTE_LOGTYPE_USER6   0x20000000 /**< User-defined log type 6. */
  90 #define RTE_LOGTYPE_USER7   0x40000000 /**< User-defined log type 7. */
  91 #define RTE_LOGTYPE_USER8   0x80000000 /**< User-defined log type 8. */
  92
  93 /* Can't use 0, as it gives compiler warnings */
  94 #define RTE_LOG_EMERG    1U  /**< System is unusable.               */
  95 #define RTE_LOG_ALERT    2U  /**< Action must be taken immediately. */
  96 #define RTE_LOG_CRIT     3U  /**< Critical conditions.              */
  97 #define RTE_LOG_ERR      4U  /**< Error conditions.                 */
  98 #define RTE_LOG_WARNING  5U  /**< Warning conditions.               */
  99 #define RTE_LOG_NOTICE   6U  /**< Normal but significant condition. */
 100 #define RTE_LOG_INFO     7U  /**< Informational.                    */
 101 #define RTE_LOG_DEBUG    8U  /**< Debug-level messages.             */
 102
 103 /**
 104  * Change the stream that will be used by the logging system.
 105  *
 106  * This can be done at any time. The f argument represents the stream
 107  * to be used to send the logs. If f is NULL, the default output is
 108  * used (stderr).
 109  *
 110  * @param f
 111  *   Pointer to the stream.
 112  * @return
 113  *   - 0 on success.
 114  *   - Negative on error.
 115  */
 116 int rte_openlog_stream(FILE *f);
 117
 118 /**
 119  * Set the global log level.
 120  *
 121  * After this call, logs with a level lower or equal than the level
 122  * passed as argument will be 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  * Get the global log level.
 131  */
 132 uint32_t rte_get_log_level(void);
 133
 134 /**
 135  * Enable or disable the log type.
 136  *
 137  * @param type
 138  *   Log type, for example, RTE_LOGTYPE_EAL.
 139  * @param enable
 140  *   True for enable; false for disable.
 141  */
 142 void rte_set_log_type(uint32_t type, int enable);
 143
 144 /**
 145  * Get the global log type.
 146  */
 147 uint32_t rte_get_log_type(void);
 148
 149 /**
 150  * Get the current loglevel 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 loglevel of the message being processed.
 160  */
 161 int rte_log_cur_msg_loglevel(void);
 162
 163 /**
 164  * Get the current logtype for the message being processed.
 165  *
 166  * Before calling the user-defined stream for logging, the log
 167  * subsystem sets a per-lcore variable containing the loglevel and the
 168  * logtype of the message being processed. This information can be
 169  * accessed by the user-defined log output function through this
 170  * function.
 171  *
 172  * @return
 173  *   The logtype of the message being processed.
 174  */
 175 int rte_log_cur_msg_logtype(void);
 176
 177 /**
 178  * Generates a log message.
 179  *
 180  * The message will be sent in the stream defined by the previous call
 181  * to rte_openlog_stream().
 182  *
 183  * The level argument determines if the log should be displayed or
 184  * not, depending on the global rte_logs variable.
 185  *
 186  * The preferred alternative is the RTE_LOG() because it adds the
 187  * level and type in the logged string.
 188  *
 189  * @param level
 190  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 191  * @param logtype
 192  *   The log type, for example, RTE_LOGTYPE_EAL.
 193  * @param format
 194  *   The format string, as in printf(3), followed by the variable arguments
 195  *   required by the format.
 196  * @return
 197  *   - 0: Success.
 198  *   - Negative on error.
 199  */
 200 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 201 #ifdef __GNUC__
 202 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
 203         __attribute__((cold))
 204 #endif
 205 #endif
 206         __attribute__((format(printf, 3, 4)));
 207
 208 /**
 209  * Generates a log message.
 210  *
 211  * The message will be sent in the stream defined by the previous call
 212  * to rte_openlog_stream().
 213  *
 214  * The level argument determines if the log should be displayed or
 215  * not, depending on the global rte_logs variable. A trailing
 216  * newline may be added if needed.
 217  *
 218  * The preferred alternative is the RTE_LOG() because it adds the
 219  * level and type in the logged string.
 220  *
 221  * @param level
 222  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 223  * @param logtype
 224  *   The log type, for example, RTE_LOGTYPE_EAL.
 225  * @param format
 226  *   The format string, as in printf(3), followed by the variable arguments
 227  *   required by the format.
 228  * @param ap
 229  *   The va_list of the variable arguments required by the format.
 230  * @return
 231  *   - 0: Success.
 232  *   - Negative on error.
 233  */
 234 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 235         __attribute__((format(printf,3,0)));
 236
 237 /**
 238  * Generates a log message.
 239  *
 240  * The RTE_LOG() is a helper that prefixes the string with the log level
 241  * and type, and call rte_log().
 242  *
 243  * @param l
 244  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 245  *   expanded by the macro, so it cannot be an integer value.
 246  * @param t
 247  *   The log type, for example, EAL. The short name is expanded by the
 248  *   macro, so it cannot be an integer value.
 249  * @param ...
 250  *   The fmt string, as in printf(3), followed by the variable arguments
 251  *   required by the format.
 252  * @return
 253  *   - 0: Success.
 254  *   - Negative on error.
 255  */
 256 #define RTE_LOG(l, t, ...)                                      \
 257          rte_log(RTE_LOG_ ## l,                                 \
 258                  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
 259
 260 /**
 261  * Generates a log message for data path.
 262  *
 263  * Similar to RTE_LOG(), except that it is removed at compilation time
 264  * if the RTE_LOG_DP_LEVEL configuration option is lower than the log
 265  * level argument.
 266  *
 267  * @param l
 268  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 269  *   expanded by the macro, so it cannot be an integer value.
 270  * @param t
 271  *   The log type, for example, EAL. The short name is expanded by the
 272  *   macro, so it cannot be an integer value.
 273  * @param ...
 274  *   The fmt string, as in printf(3), followed by the variable arguments
 275  *   required by the format.
 276  * @return
 277  *   - 0: Success.
 278  *   - Negative on error.
 279  */
 280 #define RTE_LOG_DP(l, t, ...)                                   \
 281         (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ?            \
 282          rte_log(RTE_LOG_ ## l,                                 \
 283                  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) :     \
 284          0)
 285
 286 #ifdef __cplusplus
 287 }
 288 #endif
 289
 290 #endif /* _RTE_LOG_H_ */