lib/librte_eal/common/include/rte_log.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2017 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 #include <rte_common.h>
  54
  55 struct rte_log_dynamic_type;
  56
  57 /** The rte_log structure. */
  58 struct rte_logs {
  59         uint32_t type;  /**< Bitfield with enabled logs. */
  60         uint32_t level; /**< Log level. */
  61         FILE *file;     /**< Output file set by rte_openlog_stream, or NULL. */
  62         size_t dynamic_types_len;
  63         struct rte_log_dynamic_type *dynamic_types;
  64 };
  65
  66 /** Global log informations */
  67 extern struct rte_logs rte_logs;
  68
  69 /* SDK log type */
  70 #define RTE_LOGTYPE_EAL        0 /**< Log related to eal. */
  71 #define RTE_LOGTYPE_MALLOC     1 /**< Log related to malloc. */
  72 #define RTE_LOGTYPE_RING       2 /**< Log related to ring. */
  73 #define RTE_LOGTYPE_MEMPOOL    3 /**< Log related to mempool. */
  74 #define RTE_LOGTYPE_TIMER      4 /**< Log related to timers. */
  75 #define RTE_LOGTYPE_PMD        5 /**< Log related to poll mode driver. */
  76 #define RTE_LOGTYPE_HASH       6 /**< Log related to hash table. */
  77 #define RTE_LOGTYPE_LPM        7 /**< Log related to LPM. */
  78 #define RTE_LOGTYPE_KNI        8 /**< Log related to KNI. */
  79 #define RTE_LOGTYPE_ACL        9 /**< Log related to ACL. */
  80 #define RTE_LOGTYPE_POWER     10 /**< Log related to power. */
  81 #define RTE_LOGTYPE_METER     11 /**< Log related to QoS meter. */
  82 #define RTE_LOGTYPE_SCHED     12 /**< Log related to QoS port scheduler. */
  83 #define RTE_LOGTYPE_PORT      13 /**< Log related to port. */
  84 #define RTE_LOGTYPE_TABLE     14 /**< Log related to table. */
  85 #define RTE_LOGTYPE_PIPELINE  15 /**< Log related to pipeline. */
  86 #define RTE_LOGTYPE_MBUF      16 /**< Log related to mbuf. */
  87 #define RTE_LOGTYPE_CRYPTODEV 17 /**< Log related to cryptodev. */
  88 #define RTE_LOGTYPE_EFD       18 /**< Log related to EFD. */
  89 #define RTE_LOGTYPE_EVENTDEV  19 /**< Log related to eventdev. */
  90 #define RTE_LOGTYPE_GSO       20 /**< Log related to GSO. */
  91
  92 /* these log types can be used in an application */
  93 #define RTE_LOGTYPE_USER1     24 /**< User-defined log type 1. */
  94 #define RTE_LOGTYPE_USER2     25 /**< User-defined log type 2. */
  95 #define RTE_LOGTYPE_USER3     26 /**< User-defined log type 3. */
  96 #define RTE_LOGTYPE_USER4     27 /**< User-defined log type 4. */
  97 #define RTE_LOGTYPE_USER5     28 /**< User-defined log type 5. */
  98 #define RTE_LOGTYPE_USER6     29 /**< User-defined log type 6. */
  99 #define RTE_LOGTYPE_USER7     30 /**< User-defined log type 7. */
 100 #define RTE_LOGTYPE_USER8     31 /**< User-defined log type 8. */
 101
 102 /** First identifier for extended logs */
 103 #define RTE_LOGTYPE_FIRST_EXT_ID 32
 104
 105 /* Can't use 0, as it gives compiler warnings */
 106 #define RTE_LOG_EMERG    1U  /**< System is unusable.               */
 107 #define RTE_LOG_ALERT    2U  /**< Action must be taken immediately. */
 108 #define RTE_LOG_CRIT     3U  /**< Critical conditions.              */
 109 #define RTE_LOG_ERR      4U  /**< Error conditions.                 */
 110 #define RTE_LOG_WARNING  5U  /**< Warning conditions.               */
 111 #define RTE_LOG_NOTICE   6U  /**< Normal but significant condition. */
 112 #define RTE_LOG_INFO     7U  /**< Informational.                    */
 113 #define RTE_LOG_DEBUG    8U  /**< Debug-level messages.             */
 114
 115 /**
 116  * Change the stream that will be used by the logging system.
 117  *
 118  * This can be done at any time. The f argument represents the stream
 119  * to be used to send the logs. If f is NULL, the default output is
 120  * used (stderr).
 121  *
 122  * @param f
 123  *   Pointer to the stream.
 124  * @return
 125  *   - 0 on success.
 126  *   - Negative on error.
 127  */
 128 int rte_openlog_stream(FILE *f);
 129
 130 /**
 131  * Set the global log level.
 132  *
 133  * After this call, logs with a level lower or equal than the level
 134  * passed as argument will be displayed.
 135  *
 136  * @param level
 137  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 138  */
 139 void rte_log_set_global_level(uint32_t level);
 140
 141 /**
 142  * Get the global log level.
 143  *
 144  * @return
 145  *   The current global log level.
 146  */
 147 uint32_t rte_log_get_global_level(void);
 148
 149 /**
 150  * Get the log level for a given type.
 151  *
 152  * @param logtype
 153  *   The log type identifier.
 154  * @return
 155  *   0 on success, a negative value if logtype is invalid.
 156  */
 157 int rte_log_get_level(uint32_t logtype);
 158
 159 /**
 160  * Set the log level for a given type.
 161  *
 162  * @param pattern
 163  *   The regexp identifying the log type.
 164  * @param level
 165  *   The level to be set.
 166  * @return
 167  *   0 on success, a negative value if level is invalid.
 168  */
 169 int rte_log_set_level_regexp(const char *pattern, uint32_t level);
 170
 171 /**
 172  * Set the log level for a given type.
 173  *
 174  * @param logtype
 175  *   The log type identifier.
 176  * @param level
 177  *   The level to be set.
 178  * @return
 179  *   0 on success, a negative value if logtype or level is invalid.
 180  */
 181 int rte_log_set_level(uint32_t logtype, uint32_t level);
 182
 183 /**
 184  * Get the current loglevel for the message being processed.
 185  *
 186  * Before calling the user-defined stream for logging, the log
 187  * subsystem sets a per-lcore variable containing the loglevel and the
 188  * logtype of the message being processed. This information can be
 189  * accessed by the user-defined log output function through this
 190  * function.
 191  *
 192  * @return
 193  *   The loglevel of the message being processed.
 194  */
 195 int rte_log_cur_msg_loglevel(void);
 196
 197 /**
 198  * Get the current logtype for the message being processed.
 199  *
 200  * Before calling the user-defined stream for logging, the log
 201  * subsystem sets a per-lcore variable containing the loglevel and the
 202  * logtype of the message being processed. This information can be
 203  * accessed by the user-defined log output function through this
 204  * function.
 205  *
 206  * @return
 207  *   The logtype of the message being processed.
 208  */
 209 int rte_log_cur_msg_logtype(void);
 210
 211 /**
 212  * Register a dynamic log type
 213  *
 214  * If a log is already registered with the same type, the returned value
 215  * is the same than the previous one.
 216  *
 217  * @param name
 218  *   The string identifying the log type.
 219  * @return
 220  *   - >0: success, the returned value is the log type identifier.
 221  *   - (-ENOMEM): cannot allocate memory.
 222  */
 223 int rte_log_register(const char *name);
 224
 225 /**
 226  * Dump log information.
 227  *
 228  * Dump the global level and the registered log types.
 229  *
 230  * @param f
 231  *   The output stream where the dump should be sent.
 232  */
 233 void rte_log_dump(FILE *f);
 234
 235 /**
 236  * Generates a log message.
 237  *
 238  * The message will be sent in the stream defined by the previous call
 239  * to rte_openlog_stream().
 240  *
 241  * The level argument determines if the log should be displayed or
 242  * not, depending on the global rte_logs variable.
 243  *
 244  * The preferred alternative is the RTE_LOG() because it adds the
 245  * level and type in the logged string.
 246  *
 247  * @param level
 248  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 249  * @param logtype
 250  *   The log type, for example, RTE_LOGTYPE_EAL.
 251  * @param format
 252  *   The format string, as in printf(3), followed by the variable arguments
 253  *   required by the format.
 254  * @return
 255  *   - 0: Success.
 256  *   - Negative on error.
 257  */
 258 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
 259 #ifdef __GNUC__
 260 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
 261         __attribute__((cold))
 262 #endif
 263 #endif
 264         __attribute__((format(printf, 3, 4)));
 265
 266 /**
 267  * Generates a log message.
 268  *
 269  * The message will be sent in the stream defined by the previous call
 270  * to rte_openlog_stream().
 271  *
 272  * The level argument determines if the log should be displayed or
 273  * not, depending on the global rte_logs variable. A trailing
 274  * newline may be added if needed.
 275  *
 276  * The preferred alternative is the RTE_LOG() because it adds the
 277  * level and type in the logged string.
 278  *
 279  * @param level
 280  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
 281  * @param logtype
 282  *   The log type, for example, RTE_LOGTYPE_EAL.
 283  * @param format
 284  *   The format string, as in printf(3), followed by the variable arguments
 285  *   required by the format.
 286  * @param ap
 287  *   The va_list of the variable arguments required by the format.
 288  * @return
 289  *   - 0: Success.
 290  *   - Negative on error.
 291  */
 292 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
 293         __attribute__((format(printf,3,0)));
 294
 295 /**
 296  * Generates a log message.
 297  *
 298  * The RTE_LOG() is a helper that prefixes the string with the log level
 299  * and type, and call rte_log().
 300  *
 301  * @param l
 302  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 303  *   expanded by the macro, so it cannot be an integer value.
 304  * @param t
 305  *   The log type, for example, EAL. The short name is expanded by the
 306  *   macro, so it cannot be an integer value.
 307  * @param ...
 308  *   The fmt string, as in printf(3), followed by the variable arguments
 309  *   required by the format.
 310  * @return
 311  *   - 0: Success.
 312  *   - Negative on error.
 313  */
 314 #define RTE_LOG(l, t, ...)                                      \
 315          rte_log(RTE_LOG_ ## l,                                 \
 316                  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
 317
 318 /**
 319  * Generates a log message for data path.
 320  *
 321  * Similar to RTE_LOG(), except that it is removed at compilation time
 322  * if the RTE_LOG_DP_LEVEL configuration option is lower than the log
 323  * level argument.
 324  *
 325  * @param l
 326  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
 327  *   expanded by the macro, so it cannot be an integer value.
 328  * @param t
 329  *   The log type, for example, EAL. The short name is expanded by the
 330  *   macro, so it cannot be an integer value.
 331  * @param ...
 332  *   The fmt string, as in printf(3), followed by the variable arguments
 333  *   required by the format.
 334  * @return
 335  *   - 0: Success.
 336  *   - Negative on error.
 337  */
 338 #define RTE_LOG_DP(l, t, ...)                                   \
 339         (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ?            \
 340          rte_log(RTE_LOG_ ## l,                                 \
 341                  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) :     \
 342          0)
 343
 344 #ifdef __cplusplus
 345 }
 346 #endif
 347
 348 #endif /* _RTE_LOG_H_ */