libmetal
log.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of Xilinx nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without
16  * specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * @file log.h
33  * @brief Logging support for libmetal.
34  */
35 
36 #ifndef __METAL_METAL_LOG__H__
37 #define __METAL_METAL_LOG__H__
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
56 };
57 
59 typedef void (*metal_log_handler)(enum metal_log_level level,
60  const char *format, ...);
61 
67 extern void metal_set_log_handler(metal_log_handler handler);
68 
74 
79 extern void metal_set_log_level(enum metal_log_level level);
80 
85 extern enum metal_log_level metal_get_log_level(void);
86 
94 extern void metal_default_log_handler(enum metal_log_level level,
95  const char *format, ...);
96 
97 
104 #define metal_log(level, ...) \
105  (void)((level <= _metal.common.log_level && _metal.common.log_handler) \
106  ? _metal.common.log_handler(level, __VA_ARGS__) \
107  : 0)
108 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif /* __METAL_METAL_LOG__H__ */
enum metal_log_level metal_get_log_level(void)
Get the current level for libmetal logging.
Definition: log.c:83
Definition: log.h:50
Definition: log.h:53
void metal_default_log_handler(enum metal_log_level level, const char *format,...)
Default libmetal log handler. This handler prints libmetal log mesages to stderr. ...
Definition: log.c:37
void metal_set_log_level(enum metal_log_level level)
Set the level for libmetal logging.
Definition: log.c:78
void metal_set_log_handler(metal_log_handler handler)
Set libmetal log handler.
Definition: log.c:68
Definition: log.h:51
Definition: log.h:55
Definition: log.h:49
metal_log_level
Definition: log.h:47
Definition: log.h:52
Definition: log.h:48
void(* metal_log_handler)(enum metal_log_level level, const char *format,...)
Definition: log.h:59
Definition: log.h:54
metal_log_handler metal_get_log_handler(void)
Get the current libmetal log handler.
Definition: log.c:73