DPDK  20.08.0
rte_log.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2017 Intel Corporation
3  */
4 
5 #ifndef _RTE_LOG_H_
6 #define _RTE_LOG_H_
7 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <stdint.h>
21 #include <stdio.h>
22 #include <stdarg.h>
23 #include <stdbool.h>
24 #include <sys/queue.h>
25 
26 #include <rte_common.h>
27 #include <rte_config.h>
28 #include <rte_compat.h>
29 
30 struct rte_log_dynamic_type;
31 
33 struct rte_logs {
34  uint32_t type;
35  uint32_t level;
36  FILE *file;
37  size_t dynamic_types_len;
38  struct rte_log_dynamic_type *dynamic_types;
39 };
40 
42 extern struct rte_logs rte_logs;
43 
44 /* SDK log type */
45 #define RTE_LOGTYPE_EAL 0
46 #define RTE_LOGTYPE_MALLOC 1
47 #define RTE_LOGTYPE_RING 2
48 #define RTE_LOGTYPE_MEMPOOL 3
49 #define RTE_LOGTYPE_TIMER 4
50 #define RTE_LOGTYPE_PMD 5
51 #define RTE_LOGTYPE_HASH 6
52 #define RTE_LOGTYPE_LPM 7
53 #define RTE_LOGTYPE_KNI 8
54 #define RTE_LOGTYPE_ACL 9
55 #define RTE_LOGTYPE_POWER 10
56 #define RTE_LOGTYPE_METER 11
57 #define RTE_LOGTYPE_SCHED 12
58 #define RTE_LOGTYPE_PORT 13
59 #define RTE_LOGTYPE_TABLE 14
60 #define RTE_LOGTYPE_PIPELINE 15
61 #define RTE_LOGTYPE_MBUF 16
62 #define RTE_LOGTYPE_CRYPTODEV 17
63 #define RTE_LOGTYPE_EFD 18
64 #define RTE_LOGTYPE_EVENTDEV 19
65 #define RTE_LOGTYPE_GSO 20
67 /* these log types can be used in an application */
68 #define RTE_LOGTYPE_USER1 24
69 #define RTE_LOGTYPE_USER2 25
70 #define RTE_LOGTYPE_USER3 26
71 #define RTE_LOGTYPE_USER4 27
72 #define RTE_LOGTYPE_USER5 28
73 #define RTE_LOGTYPE_USER6 29
74 #define RTE_LOGTYPE_USER7 30
75 #define RTE_LOGTYPE_USER8 31
78 #define RTE_LOGTYPE_FIRST_EXT_ID 32
79 
80 /* Can't use 0, as it gives compiler warnings */
81 #define RTE_LOG_EMERG 1U
82 #define RTE_LOG_ALERT 2U
83 #define RTE_LOG_CRIT 3U
84 #define RTE_LOG_ERR 4U
85 #define RTE_LOG_WARNING 5U
86 #define RTE_LOG_NOTICE 6U
87 #define RTE_LOG_INFO 7U
88 #define RTE_LOG_DEBUG 8U
103 int rte_openlog_stream(FILE *f);
104 
115 __rte_experimental
116 FILE *rte_log_get_stream(void);
117 
127 void rte_log_set_global_level(uint32_t level);
128 
135 uint32_t rte_log_get_global_level(void);
136 
145 int rte_log_get_level(uint32_t logtype);
146 
157 __rte_experimental
158 bool rte_log_can_log(uint32_t logtype, uint32_t loglevel);
159 
170 int rte_log_set_level_pattern(const char *pattern, uint32_t level);
171 
182 int rte_log_set_level_regexp(const char *regex, uint32_t level);
183 
194 int rte_log_set_level(uint32_t logtype, uint32_t level);
195 
208 int rte_log_cur_msg_loglevel(void);
209 
222 int rte_log_cur_msg_logtype(void);
223 
236 int rte_log_register(const char *name);
237 
257 __rte_experimental
258 int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def);
259 
268 void rte_log_dump(FILE *f);
269 
293 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
294 #ifdef __GNUC__
295 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
296  __rte_cold
297 #endif
298 #endif
299  __rte_format_printf(3, 4);
300 
327 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
328  __rte_format_printf(3, 0);
329 
349 #define RTE_LOG(l, t, ...) \
350  rte_log(RTE_LOG_ ## l, \
351  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
352 
373 #define RTE_LOG_DP(l, t, ...) \
374  (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
375  rte_log(RTE_LOG_ ## l, \
376  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
377  0)
378 
395 #define RTE_LOG_REGISTER(type, name, level) \
396 int type; \
397 RTE_INIT(__##type) \
398 { \
399  type = rte_log_register_type_and_pick_level(RTE_STR(name), \
400  RTE_LOG_##level); \
401 }
402 
403 #ifdef __cplusplus
404 }
405 #endif
406 
407 #endif /* _RTE_LOG_H_ */
int rte_log_set_level_pattern(const char *pattern, uint32_t level)
uint32_t level
Definition: rte_log.h:35
__rte_experimental FILE * rte_log_get_stream(void)
int rte_log_set_level_regexp(const char *regex, uint32_t level)
__rte_experimental int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def)
#define __rte_cold
Definition: rte_common.h:217
int rte_log_set_level(uint32_t logtype, uint32_t level)
void rte_log_dump(FILE *f)
#define __rte_format_printf(format_index, first_arg)
Definition: rte_common.h:132
uint32_t rte_log_get_global_level(void)
int rte_log(uint32_t level, uint32_t logtype, const char *format,...) __rte_format_printf(3
int rte_log_cur_msg_logtype(void)
uint32_t type
Definition: rte_log.h:34
__rte_experimental bool rte_log_can_log(uint32_t logtype, uint32_t loglevel)
FILE * file
Definition: rte_log.h:36
int rte_log_get_level(uint32_t logtype)
void rte_log_set_global_level(uint32_t level)
int int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap) __rte_format_printf(3
int rte_log_register(const char *name)
int rte_log_cur_msg_loglevel(void)