1 /*
2  * Copyright 2017 Google
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  */
23 
24 #ifndef MESA_LOG_H
25 #define MESA_LOG_H
26 
27 #include <stdarg.h>
28 #include <stdio.h>
29 
30 #include "util/macros.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 #ifndef MESA_LOG_TAG
37 #define MESA_LOG_TAG "MESA"
38 #endif
39 
40 enum mesa_log_level {
41    MESA_LOG_ERROR,
42    MESA_LOG_WARN,
43    MESA_LOG_INFO,
44    MESA_LOG_DEBUG,
45 };
46 
47 FILE *
48 mesa_log_get_file(void);
49 
50 void PRINTFLIKE(3, 4)
51 mesa_log(enum mesa_log_level, const char *tag, const char *format, ...);
52 
53 void
54 mesa_log_v(enum mesa_log_level, const char *tag, const char *format,
55             va_list va);
56 
57 #define mesa_loge(fmt, ...) mesa_log(MESA_LOG_ERROR, (MESA_LOG_TAG), (fmt), ##__VA_ARGS__)
58 #define mesa_logw(fmt, ...) mesa_log(MESA_LOG_WARN, (MESA_LOG_TAG), (fmt), ##__VA_ARGS__)
59 #define mesa_logi(fmt, ...) mesa_log(MESA_LOG_INFO, (MESA_LOG_TAG), (fmt), ##__VA_ARGS__)
60 #ifdef DEBUG
61 #define mesa_logd(fmt, ...) mesa_log(MESA_LOG_DEBUG, (MESA_LOG_TAG), (fmt), ##__VA_ARGS__)
62 #else
63 #define mesa_logd(fmt, ...) __mesa_log_use_args((fmt), ##__VA_ARGS__)
64 #endif
65 
66 #define mesa_loge_v(fmt, va) mesa_log_v(MESA_LOG_ERROR, (MESA_LOG_TAG), (fmt), (va))
67 #define mesa_logw_v(fmt, va) mesa_log_v(MESA_LOG_WARN, (MESA_LOG_TAG), (fmt), (va))
68 #define mesa_logi_v(fmt, va) mesa_log_v(MESA_LOG_INFO, (MESA_LOG_TAG), (fmt), (va))
69 #ifdef DEBUG
70 #define mesa_logd_v(fmt, va) mesa_log_v(MESA_LOG_DEBUG, (MESA_LOG_TAG), (fmt), (va))
71 #else
72 #define mesa_logd_v(fmt, va) __mesa_log_use_args((fmt), (va))
73 #endif
74 
75 #define mesa_log_once(level, fmt, ...)        \
76    do                                         \
77    {                                          \
78       static bool once;                       \
79       if (!once) {                            \
80          once = true;                         \
81          mesa_log(level, (MESA_LOG_TAG), fmt, ##__VA_ARGS__); \
82       }                                       \
83    } while (0)
84 
85 #define mesa_loge_once(fmt, ...) mesa_log_once(MESA_LOG_ERROR, fmt, ##__VA_ARGS__)
86 #define mesa_logw_once(fmt, ...) mesa_log_once(MESA_LOG_WARN, fmt, ##__VA_ARGS__)
87 #define mesa_logi_once(fmt, ...) mesa_log_once(MESA_LOG_INFO, fmt, ##__VA_ARGS__)
88 #define mesa_logd_once(fmt, ...) mesa_log_once(MESA_LOG_DEBUG, fmt, ##__VA_ARGS__)
89 
90 struct log_stream {
91    char *msg;
92    const char *tag;
93    size_t pos;
94    enum mesa_log_level level;
95 };
96 
97 struct log_stream *_mesa_log_stream_create(enum mesa_log_level level, const char *tag);
98 #define mesa_log_streame() _mesa_log_stream_create(MESA_LOG_ERROR, (MESA_LOG_TAG))
99 #define mesa_log_streamw() _mesa_log_stream_create(MESA_LOG_WARN, (MESA_LOG_TAG))
100 #define mesa_log_streami() _mesa_log_stream_create(MESA_LOG_INFO, (MESA_LOG_TAG))
101 void mesa_log_stream_destroy(struct log_stream *stream);
102 void mesa_log_stream_printf(struct log_stream *stream, const char *format, ...);
103 
104 void _mesa_log_multiline(enum mesa_log_level level, const char *tag, const char *lines);
105 #define mesa_log_multiline(level, lines) _mesa_log_multiline(level, (MESA_LOG_TAG), lines)
106 
107 #ifndef DEBUG
108 /* Suppres -Wunused */
109 static inline void PRINTFLIKE(1, 2)
__mesa_log_use_args(UNUSED const char * format,...)110 __mesa_log_use_args(UNUSED const char *format, ...) { }
111 #endif
112 
113 #ifdef __cplusplus
114 }
115 #endif
116 
117 #endif /* MESA_LOG_H */
118