1 /**************************************************************************
3 * Copyright 2008 VMware, Inc.
4 * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
5 * Copyright 2010 LunarG, Inc.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sub license, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
16 * The above copyright notice and this permission notice (including the
17 * next paragraph) shall be included in all copies or substantial portions
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
26 * DEALINGS IN THE SOFTWARE.
28 **************************************************************************/
32 * Logging facility for debug/info messages.
33 * _EGL_FATAL messages are printed to stderr
34 * The EGL_LOG_LEVEL var controls the output of other warning/info/debug msgs.
43 #include "c11/threads.h"
47 #define MAXSTRING 1000
48 #define FALLBACK_LOG_LEVEL _EGL_WARNING
54 EGLBoolean initialized
;
66 static const char *level_strings
[] = {
67 /* the order is important */
77 * Set the function to be called when there is a message to log.
78 * Note that the function will be called with an internal lock held.
79 * Recursive logging is not allowed.
82 _eglSetLogProc(_EGLLogProc logger
)
84 EGLint num_messages
= 0;
86 mtx_lock(&logging
.mutex
);
88 if (logging
.logger
!= logger
) {
89 logging
.logger
= logger
;
91 num_messages
= logging
.num_messages
;
92 logging
.num_messages
= 0;
95 mtx_unlock(&logging
.mutex
);
99 "New logger installed. "
100 "Messages before the new logger might not be available.");
105 * Set the log reporting level.
108 _eglSetLogLevel(EGLint level
)
115 mtx_lock(&logging
.mutex
);
116 logging
.level
= level
;
117 mtx_unlock(&logging
.mutex
);
126 * The default logger. It prints the message to stderr.
129 _eglDefaultLogger(EGLint level
, const char *msg
)
131 fprintf(stderr
, "libEGL %s: %s\n", level_strings
[level
], msg
);
136 * Initialize the logging facility.
142 EGLint i
, level
= -1;
144 if (logging
.initialized
)
147 log_env
= getenv("EGL_LOG_LEVEL");
149 for (i
= 0; level_strings
[i
]; i
++) {
150 if (strcasecmp(log_env
, level_strings
[i
]) == 0) {
157 level
= FALLBACK_LOG_LEVEL
;
160 logging
.logger
= _eglDefaultLogger
;
161 logging
.level
= (level
>= 0) ? level
: FALLBACK_LOG_LEVEL
;
162 logging
.initialized
= EGL_TRUE
;
164 /* it is fine to call _eglLog now */
165 if (log_env
&& level
< 0) {
166 _eglLog(_EGL_WARNING
,
167 "Unrecognized EGL_LOG_LEVEL environment variable value. "
168 "Expected one of \"fatal\", \"warning\", \"info\", \"debug\". "
169 "Got \"%s\". Falling back to \"%s\".",
170 log_env
, level_strings
[FALLBACK_LOG_LEVEL
]);
176 * Log a message with message logger.
177 * \param level one of _EGL_FATAL, _EGL_WARNING, _EGL_INFO, _EGL_DEBUG.
180 _eglLog(EGLint level
, const char *fmtStr
, ...)
186 /* one-time initialization; a little race here is fine */
187 if (!logging
.initialized
)
189 if (level
> logging
.level
|| level
< 0)
192 mtx_lock(&logging
.mutex
);
194 if (logging
.logger
) {
195 va_start(args
, fmtStr
);
196 ret
= vsnprintf(msg
, MAXSTRING
, fmtStr
, args
);
197 if (ret
< 0 || ret
>= MAXSTRING
)
198 strcpy(msg
, "<message truncated>");
201 logging
.logger(level
, msg
);
202 logging
.num_messages
++;
205 mtx_unlock(&logging
.mutex
);
207 if (level
== _EGL_FATAL
)
208 exit(1); /* or abort()? */