fc6c9b8a00f39445e6948245a39f296dbb7987f8
[dpdk.git] / lib / librte_eal / common / include / rte_log.h
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2012 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
35 #ifndef _RTE_LOG_H_
36 #define _RTE_LOG_H_
37
38 /**
39  * @file
40  *
41  * RTE Logs API
42  *
43  * This file provides a log API to RTE applications.
44  */
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 #include <stdint.h>
51 #include <stdio.h>
52 #include <stdarg.h>
53
54 /** The rte_log structure. */
55 struct rte_logs {
56         uint32_t type;  /**< Bitfield with enabled logs. */
57         uint32_t level; /**< Log level. */
58         FILE *file;     /**< Pointer to current FILE* for logs. */
59 };
60
61 /** Global log informations */
62 extern struct rte_logs rte_logs;
63
64 /* SDK log type */
65 #define RTE_LOGTYPE_EAL     0x00000001 /**< Log related to eal. */
66 #define RTE_LOGTYPE_MALLOC  0x00000002 /**< Log related to malloc. */
67 #define RTE_LOGTYPE_RING    0x00000004 /**< Log related to ring. */
68 #define RTE_LOGTYPE_MEMPOOL 0x00000008 /**< Log related to mempool. */
69 #define RTE_LOGTYPE_TIMER   0x00000010 /**< Log related to timers. */
70 #define RTE_LOGTYPE_PMD     0x00000020 /**< Log related to poll mode driver. */
71 #define RTE_LOGTYPE_HASH    0x00000040 /**< Log related to hash table. */
72 #define RTE_LOGTYPE_LPM     0x00000080 /**< Log related to LPM. */
73 #define RTE_LOGTYPE_KNI     0X00000100 /**< Log related to KNI. */
74 #define RTE_LOGTYPE_PMAC    0x00000200 /**< Log related to PMAC. */
75
76 /* these log types can be used in an application */
77 #define RTE_LOGTYPE_USER1   0x01000000 /**< User-defined log type 1. */
78 #define RTE_LOGTYPE_USER2   0x02000000 /**< User-defined log type 2. */
79 #define RTE_LOGTYPE_USER3   0x04000000 /**< User-defined log type 3. */
80 #define RTE_LOGTYPE_USER4   0x08000000 /**< User-defined log type 4. */
81 #define RTE_LOGTYPE_USER5   0x10000000 /**< User-defined log type 5. */
82 #define RTE_LOGTYPE_USER6   0x20000000 /**< User-defined log type 6. */
83 #define RTE_LOGTYPE_USER7   0x40000000 /**< User-defined log type 7. */
84 #define RTE_LOGTYPE_USER8   0x80000000 /**< User-defined log type 8. */
85
86 /* Can't use 0, as it gives compiler warnings */
87 #define RTE_LOG_EMERG    1U  /**< System is unusable.               */
88 #define RTE_LOG_ALERT    2U  /**< Action must be taken immediately. */
89 #define RTE_LOG_CRIT     3U  /**< Critical conditions.              */
90 #define RTE_LOG_ERR      4U  /**< Error conditions.                 */
91 #define RTE_LOG_WARNING  5U  /**< Warning conditions.               */
92 #define RTE_LOG_NOTICE   6U  /**< Normal but significant condition. */
93 #define RTE_LOG_INFO     7U  /**< Informational.                    */
94 #define RTE_LOG_DEBUG    8U  /**< Debug-level messages.             */
95
96 /** The default log stream. */
97 extern FILE *eal_default_log_stream;
98
99 /**
100  * Change the stream that will be used by the logging system.
101  *
102  * This can be done at any time. The f argument represents the stream
103  * to be used to send the logs. If f is NULL, the default output is
104  * used, which is the serial line in case of bare metal, or directly
105  * sent to syslog in case of linux application.
106  *
107  * @param f
108  *   Pointer to the stream.
109  * @return
110  *   - 0 on success.
111  *   - Negative on error.
112  */
113 int rte_openlog_stream(FILE *f);
114
115 /**
116  * Set the global log level.
117  *
118  * After this call, all logs that are lower or equal than level and
119  * lower or equal than the RTE_LOG_LEVEL configuration option will be
120  * displayed.
121  *
122  * @param level
123  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
124  */
125 void rte_set_log_level(uint32_t level);
126
127 /**
128  * Enable or disable the log type.
129  *
130  * @param type
131  *   Log type, for example, RTE_LOGTYPE_EAL.
132  * @param enable
133  *   True for enable; false for disable.
134  */
135 void rte_set_log_type(uint32_t type, int enable);
136
137 /**
138  * Get the current loglevel for the message being processed.
139  *
140  * Before calling the user-defined stream for logging, the log
141  * subsystem sets a per-lcore variable containing the loglevel and the
142  * logtype of the message being processed. This information can be
143  * accessed by the user-defined log output function through this
144  * function.
145  *
146  * @return
147  *   The loglevel of the message being processed.
148  */
149 int rte_log_cur_msg_loglevel(void);
150
151 /**
152  * Get the current logtype 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 logtype of the message being processed.
162  */
163 int rte_log_cur_msg_logtype(void);
164
165 /**
166  * Enable or disable the history (enabled by default)
167  *
168  * @param enable
169  *   true to enable, or 0 to disable history.
170  */
171 void rte_log_set_history(int enable);
172
173 /**
174  * Dump the log history to the console.
175  */
176 void rte_log_dump_history(void);
177
178 /**
179  * Add a log message to the history.
180  *
181  * This function can be called from a user-defined log stream. It adds
182  * the given message in the history that can be dumped using
183  * rte_log_dump_history().
184  *
185  * @param buf
186  *   A data buffer containing the message to be saved in the history.
187  * @param size
188  *   The length of the data buffer.
189  * @return
190  *   - 0: Success.
191  *   - (-ENOBUFS) if there is no room to store the message.
192  */
193 int rte_log_add_in_history(const char *buf, size_t size);
194
195 /**
196  * Generates a log message.
197  *
198  * The message will be sent in the stream defined by the previous call
199  * to rte_openlog_stream().
200  *
201  * The level argument determines if the log should be displayed or
202  * not, depending on the global rte_logs variable.
203  *
204  * The preferred alternative is the RTE_LOG() function because debug logs may
205  * be removed at compilation time if optimization is enabled. Moreover,
206  * logs are automatically prefixed by type when using the macro.
207  *
208  * @param level
209  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
210  * @param logtype
211  *   The log type, for example, RTE_LOGTYPE_EAL.
212  * @param format
213  *   The format string, as in printf(3), followed by the variable arguments
214  *   required by the format.
215  * @return
216  *   - 0: Success.
217  *   - Negative on error.
218  */
219 int rte_log(uint32_t level, uint32_t logtype, const char *format, ...)
220         __attribute__((format(printf, 3, 4)));
221
222 /**
223  * Generates a log message.
224  *
225  * The message will be sent in the stream defined by the previous call
226  * to rte_openlog_stream().
227  *
228  * The level argument determines if the log should be displayed or
229  * not, depending on the global rte_logs variable. A trailing
230  * newline may be added if needed.
231  *
232  * The preferred alternative is the RTE_LOG() because debug logs may be
233  * removed at compilation time.
234  *
235  * @param level
236  *   Log level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
237  * @param logtype
238  *   The log type, for example, RTE_LOGTYPE_EAL.
239  * @param format
240  *   The format string, as in printf(3), followed by the variable arguments
241  *   required by the format.
242  * @param ap
243  *   The va_list of the variable arguments required by the format.
244  * @return
245  *   - 0: Success.
246  *   - Negative on error.
247  */
248 int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap);
249
250 /**
251  * Generates a log message.
252  *
253  * The RTE_LOG() is equivalent to rte_log() with two differences:
254
255  * - RTE_LOG() can be used to remove debug logs at compilation time,
256  *   depending on RTE_LOG_LEVEL configuration option, and compilation
257  *   optimization level. If optimization is enabled, the tests
258  *   involving constants only are pre-computed. If compilation is done
259  *   with -O0, these tests will be done at run time.
260  * - The log level and log type names are smaller, for example:
261  *   RTE_LOG(INFO, EAL, "this is a %s", "log");
262  *
263  * @param l
264  *   Log level. A value between EMERG (1) and DEBUG (8). The short name is
265  *   expanded by the macro, so it cannot be an integer value.
266  * @param t
267  *   The log type, for example, EAL. The short name is expanded by the
268  *   macro, so it cannot be an integer value.
269  * @param fmt
270  *   The fmt string, as in printf(3), followed by the variable arguments
271  *   required by the format.
272  * @param args
273  *   The variable list of arguments according to the format string.
274  * @return
275  *   - 0: Success.
276  *   - Negative on error.
277  */
278 #define RTE_LOG(l, t, fmt, args...) ({                                  \
279         if ((RTE_LOG_##l <= RTE_LOG_LEVEL) &&                           \
280             (RTE_LOG_##l <= rte_logs.level) &&                          \
281             (RTE_LOGTYPE_##t & rte_logs.type)) {                        \
282                 rte_log(RTE_LOG_##l, RTE_LOGTYPE_##t,                   \
283                           #t ": " fmt, ## args);                        \
284         }                                                               \
285 })
286
287 #ifdef __cplusplus
288 }
289 #endif
290
291 #endif /* _RTE_LOG_H_ */