DPDK  18.05.1
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 <sys/queue.h>
24 
25 #include <rte_common.h>
26 #include <rte_config.h>
27 
28 struct rte_log_dynamic_type;
29 
31 struct rte_logs {
32  uint32_t type;
33  uint32_t level;
34  FILE *file;
35  size_t dynamic_types_len;
36  struct rte_log_dynamic_type *dynamic_types;
37 };
38 
40 extern struct rte_logs rte_logs;
41 
42 /* SDK log type */
43 #define RTE_LOGTYPE_EAL 0
44 #define RTE_LOGTYPE_MALLOC 1
45 #define RTE_LOGTYPE_RING 2
46 #define RTE_LOGTYPE_MEMPOOL 3
47 #define RTE_LOGTYPE_TIMER 4
48 #define RTE_LOGTYPE_PMD 5
49 #define RTE_LOGTYPE_HASH 6
50 #define RTE_LOGTYPE_LPM 7
51 #define RTE_LOGTYPE_KNI 8
52 #define RTE_LOGTYPE_ACL 9
53 #define RTE_LOGTYPE_POWER 10
54 #define RTE_LOGTYPE_METER 11
55 #define RTE_LOGTYPE_SCHED 12
56 #define RTE_LOGTYPE_PORT 13
57 #define RTE_LOGTYPE_TABLE 14
58 #define RTE_LOGTYPE_PIPELINE 15
59 #define RTE_LOGTYPE_MBUF 16
60 #define RTE_LOGTYPE_CRYPTODEV 17
61 #define RTE_LOGTYPE_EFD 18
62 #define RTE_LOGTYPE_EVENTDEV 19
63 #define RTE_LOGTYPE_GSO 20
65 /* these log types can be used in an application */
66 #define RTE_LOGTYPE_USER1 24
67 #define RTE_LOGTYPE_USER2 25
68 #define RTE_LOGTYPE_USER3 26
69 #define RTE_LOGTYPE_USER4 27
70 #define RTE_LOGTYPE_USER5 28
71 #define RTE_LOGTYPE_USER6 29
72 #define RTE_LOGTYPE_USER7 30
73 #define RTE_LOGTYPE_USER8 31
76 #define RTE_LOGTYPE_FIRST_EXT_ID 32
77 
78 /* Can't use 0, as it gives compiler warnings */
79 #define RTE_LOG_EMERG 1U
80 #define RTE_LOG_ALERT 2U
81 #define RTE_LOG_CRIT 3U
82 #define RTE_LOG_ERR 4U
83 #define RTE_LOG_WARNING 5U
84 #define RTE_LOG_NOTICE 6U
85 #define RTE_LOG_INFO 7U
86 #define RTE_LOG_DEBUG 8U
101 int rte_openlog_stream(FILE *f);
102 
112 void rte_log_set_global_level(uint32_t level);
113 
120 uint32_t rte_log_get_global_level(void);
121 
130 int rte_log_get_level(uint32_t logtype);
131 
142 int rte_log_set_level_pattern(const char *pattern, uint32_t level);
143 
154 int rte_log_set_level_regexp(const char *regex, uint32_t level);
155 
166 int rte_log_set_level(uint32_t logtype, uint32_t level);
167 
180 int rte_log_cur_msg_loglevel(void);
181 
194 int rte_log_cur_msg_logtype(void);
195 
208 int rte_log_register(const char *name);
209 
229 int rte_log_register_type_and_pick_level(const char *name, uint32_t level_def);
230 
239 void rte_log_dump(FILE *f);
240 
264 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
265 #ifdef __GNUC__
266 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ > 2))
267  __attribute__((cold))
268 #endif
269 #endif
270  __attribute__((format(printf, 3, 4)));
271 
298 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
299  __attribute__((format(printf,3,0)));
300 
320 #define RTE_LOG(l, t, ...) \
321  rte_log(RTE_LOG_ ## l, \
322  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)
323 
344 #define RTE_LOG_DP(l, t, ...) \
345  (void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
346  rte_log(RTE_LOG_ ## l, \
347  RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
348  0)
349 
350 #ifdef __cplusplus
351 }
352 #endif
353 
354 #endif /* _RTE_LOG_H_ */