2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
26 #define LOG_PREFIX "log"
31 * Controlling the libsigrok message logging functionality.
35 * @defgroup grp_logging Logging
37 * Controlling the libsigrok message logging functionality.
42 /* Currently selected libsigrok loglevel. Default: SR_LOG_WARN. */
43 static int cur_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
45 /* Function prototype. */
46 static int sr_logv(void *cb_data, int loglevel, const char *format,
49 /* Pointer to the currently selected log callback. Default: sr_logv(). */
50 static sr_log_callback sr_log_cb = sr_logv;
53 * Pointer to private data that can be passed to the log callback.
54 * This can be used (for example) by C++ GUIs to pass a "this" pointer.
56 static void *sr_log_cb_data = NULL;
58 /* Log domain (a short string that is used as prefix for all messages). */
60 #define LOGDOMAIN_MAXLEN 30
61 #define LOGDOMAIN_DEFAULT "sr: "
63 static char sr_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_DEFAULT;
66 #define LOGLEVEL_TIMESTAMP SR_LOG_DBG
68 static int64_t sr_log_start_time = 0;
71 * Set the libsigrok loglevel.
73 * This influences the amount of log messages (debug messages, error messages,
74 * and so on) libsigrok will output. Using SR_LOG_NONE disables all messages.
76 * Note that this function itself will also output log messages. After the
77 * loglevel has changed, it will output a debug message with SR_LOG_DBG for
78 * example. Whether this message is shown depends on the (new) loglevel.
80 * @param loglevel The loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN,
81 * SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW).
83 * @return SR_OK upon success, SR_ERR_ARG upon invalid loglevel.
87 SR_API int sr_log_loglevel_set(int loglevel)
89 if (loglevel < SR_LOG_NONE || loglevel > SR_LOG_SPEW) {
90 sr_err("Invalid loglevel %d.", loglevel);
93 /* Output time stamps relative to time at startup */
94 if (loglevel >= LOGLEVEL_TIMESTAMP && sr_log_start_time == 0)
95 sr_log_start_time = g_get_monotonic_time();
97 cur_loglevel = loglevel;
99 sr_dbg("libsigrok loglevel set to %d.", loglevel);
105 * Get the libsigrok loglevel.
107 * @return The currently configured libsigrok loglevel.
111 SR_API int sr_log_loglevel_get(void)
117 * Set the libsigrok logdomain string.
119 * @param logdomain The string to use as logdomain for libsigrok log
120 * messages from now on. Must not be NULL. The maximum
121 * length of the string is 30 characters (this does not
122 * include the trailing NUL-byte). Longer strings are
124 * In order to not use a logdomain, pass an empty string.
125 * The function makes its own copy of the input string, i.e.
126 * the caller does not need to keep it around.
128 * @retval SR_OK upon success.
129 * @retval SR_ERR_ARG @a logdomain was NULL.
130 * @retval SR_ERR @a logdomain was truncated.
134 SR_API int sr_log_logdomain_set(const char *logdomain)
139 sr_err("%s: logdomain was NULL", __func__);
143 len = g_strlcpy(sr_log_domain, logdomain, sizeof sr_log_domain);
145 sr_dbg("Log domain set to '%s'.", sr_log_domain);
147 return (len < sizeof sr_log_domain) ? SR_OK : SR_ERR;
151 * Get the currently configured libsigrok logdomain.
153 * @return A copy of the currently configured libsigrok logdomain
154 * string. The caller is responsible for g_free()ing the string when
155 * it is no longer needed.
159 SR_API char *sr_log_logdomain_get(void)
161 return g_strdup(sr_log_domain);
165 * Set the libsigrok log callback to the specified function.
167 * @param cb Function pointer to the log callback function to use.
169 * @param cb_data Pointer to private data to be passed on. This can be used by
170 * the caller to pass arbitrary data to the log functions. This
171 * pointer is only stored or passed on by libsigrok, and is
172 * never used or interpreted in any way. The pointer is allowed
173 * to be NULL if the caller doesn't need/want to pass any data.
175 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
179 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data)
182 sr_err("%s: cb was NULL", __func__);
186 /* Note: 'cb_data' is allowed to be NULL. */
189 sr_log_cb_data = cb_data;
195 * Set the libsigrok log callback to the default built-in one.
197 * Additionally, the internal 'sr_log_cb_data' pointer is set to NULL.
199 * @return SR_OK upon success, a negative error code otherwise.
203 SR_API int sr_log_callback_set_default(void)
206 * Note: No log output in this function, as it should safely work
207 * even if the currently set log callback is buggy/broken.
210 sr_log_cb_data = NULL;
215 static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args)
217 uint64_t elapsed_us, minutes;
218 unsigned int rest_us, seconds, microseconds;
220 /* This specific log callback doesn't need the void pointer data. */
223 /* Only output messages of at least the selected loglevel(s). */
224 if (loglevel > cur_loglevel)
227 if (cur_loglevel >= LOGLEVEL_TIMESTAMP) {
228 elapsed_us = g_get_monotonic_time() - sr_log_start_time;
230 minutes = elapsed_us / G_TIME_SPAN_MINUTE;
231 rest_us = elapsed_us % G_TIME_SPAN_MINUTE;
232 seconds = rest_us / G_TIME_SPAN_SECOND;
233 microseconds = rest_us % G_TIME_SPAN_SECOND;
235 if (fprintf(stderr, "[%.2" PRIu64 ":%.2u.%.6u] ",
236 minutes, seconds, microseconds) < 0)
239 if (sr_log_domain[0] != '\0' && fputs(sr_log_domain, stderr) < 0)
241 if (vfprintf(stderr, format, args) < 0)
243 if (putc('\n', stderr) < 0)
250 SR_PRIV int sr_log(int loglevel, const char *format, ...)
255 va_start(args, format);
256 ret = sr_log_cb(sr_log_cb_data, loglevel, format, args);