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, see <http://www.gnu.org/licenses/>.
23 #include <glib/gprintf.h>
24 #include <libsigrok/libsigrok.h>
25 #include "libsigrok-internal.h"
28 #define LOG_PREFIX "log"
34 * Controlling the libsigrok message logging functionality.
38 * @defgroup grp_logging Logging
40 * Controlling the libsigrok message logging functionality.
45 /* Currently selected libsigrok loglevel. Default: SR_LOG_WARN. */
46 static int cur_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
48 /* Function prototype. */
49 static int sr_logv(void *cb_data, int loglevel, const char *format,
52 /* Pointer to the currently selected log callback. Default: sr_logv(). */
53 static sr_log_callback sr_log_cb = sr_logv;
56 * Pointer to private data that can be passed to the log callback.
57 * This can be used (for example) by C++ GUIs to pass a "this" pointer.
59 static void *sr_log_cb_data = NULL;
62 #define LOGLEVEL_TIMESTAMP SR_LOG_DBG
64 static int64_t sr_log_start_time = 0;
67 * Set the libsigrok loglevel.
69 * This influences the amount of log messages (debug messages, error messages,
70 * and so on) libsigrok will output. Using SR_LOG_NONE disables all messages.
72 * Note that this function itself will also output log messages. After the
73 * loglevel has changed, it will output a debug message with SR_LOG_DBG for
74 * example. Whether this message is shown depends on the (new) loglevel.
76 * @param loglevel The loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN,
77 * SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW).
79 * @return SR_OK upon success, SR_ERR_ARG upon invalid loglevel.
83 SR_API int sr_log_loglevel_set(int loglevel)
85 if (loglevel < SR_LOG_NONE || loglevel > SR_LOG_SPEW) {
86 sr_err("Invalid loglevel %d.", loglevel);
89 /* Output time stamps relative to time at startup */
90 if (loglevel >= LOGLEVEL_TIMESTAMP && sr_log_start_time == 0)
91 sr_log_start_time = g_get_monotonic_time();
93 cur_loglevel = loglevel;
95 sr_dbg("libsigrok loglevel set to %d.", loglevel);
101 * Get the libsigrok loglevel.
103 * @return The currently configured libsigrok loglevel.
107 SR_API int sr_log_loglevel_get(void)
113 * Set the libsigrok log callback to the specified function.
115 * @param cb Function pointer to the log callback function to use.
117 * @param cb_data Pointer to private data to be passed on. This can be used by
118 * the caller to pass arbitrary data to the log functions. This
119 * pointer is only stored or passed on by libsigrok, and is
120 * never used or interpreted in any way. The pointer is allowed
121 * to be NULL if the caller doesn't need/want to pass any data.
123 * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
127 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data)
130 sr_err("%s: cb was NULL", __func__);
134 /* Note: 'cb_data' is allowed to be NULL. */
137 sr_log_cb_data = cb_data;
143 * Set the libsigrok log callback to the default built-in one.
145 * Additionally, the internal 'sr_log_cb_data' pointer is set to NULL.
147 * @return SR_OK upon success, a negative error code otherwise.
151 SR_API int sr_log_callback_set_default(void)
154 * Note: No log output in this function, as it should safely work
155 * even if the currently set log callback is buggy/broken.
158 sr_log_cb_data = NULL;
164 * Get the libsigrok log callback routine and callback data.
166 * @param[out] cb Pointer to a function pointer to receive the log callback
167 * function. Optional, can be NULL.
168 * @param[out] cb_data Pointer to a void pointer to receive the log callback's
169 * additional arguments. Optional, can be NULL.
171 * @return SR_OK upon success.
175 SR_API int sr_log_callback_get(sr_log_callback *cb, void **cb_data)
180 *cb_data = sr_log_cb_data;
185 static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args)
187 uint64_t elapsed_us, minutes;
188 unsigned int rest_us, seconds, microseconds;
189 char *raw_output, *output;
190 int raw_len, raw_idx, idx, ret;
192 /* This specific log callback doesn't need the void pointer data. */
197 if (cur_loglevel >= LOGLEVEL_TIMESTAMP) {
198 elapsed_us = g_get_monotonic_time() - sr_log_start_time;
200 minutes = elapsed_us / G_TIME_SPAN_MINUTE;
201 rest_us = elapsed_us % G_TIME_SPAN_MINUTE;
202 seconds = rest_us / G_TIME_SPAN_SECOND;
203 microseconds = rest_us % G_TIME_SPAN_SECOND;
205 ret = g_fprintf(stderr, "sr: [%.2" PRIu64 ":%.2u.%.6u] ",
206 minutes, seconds, microseconds);
208 ret = fputs("sr: ", stderr);
211 if (ret < 0 || (raw_len = g_vasprintf(&raw_output, format, args)) < 0)
214 output = g_malloc0(raw_len + 1);
216 /* Copy the string without any unwanted newlines. */
218 while (raw_idx < raw_len) {
219 if (raw_output[raw_idx] != '\n') {
220 output[idx] = raw_output[raw_idx];
226 g_fprintf(stderr, "%s\n", output);
235 SR_PRIV int sr_log(int loglevel, const char *format, ...)
240 /* Only output messages of at least the selected loglevel(s). */
241 if (loglevel > cur_loglevel)
244 va_start(args, format);
245 ret = sr_log_cb(sr_log_cb_data, loglevel, format, args);