]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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 | |
19 | */ | |
20 | ||
21 | #include <config.h> | |
22 | #include <stdarg.h> | |
23 | #include <stdio.h> | |
24 | #include <glib/gprintf.h> | |
25 | #include <libsigrok/libsigrok.h> | |
26 | #include "libsigrok-internal.h" | |
27 | ||
28 | #define LOG_PREFIX "log" | |
29 | ||
30 | /** | |
31 | * @file | |
32 | * | |
33 | * Controlling the libsigrok message logging functionality. | |
34 | */ | |
35 | ||
36 | /** | |
37 | * @defgroup grp_logging Logging | |
38 | * | |
39 | * Controlling the libsigrok message logging functionality. | |
40 | * | |
41 | * @{ | |
42 | */ | |
43 | ||
44 | /* Currently selected libsigrok loglevel. Default: SR_LOG_WARN. */ | |
45 | static int cur_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */ | |
46 | ||
47 | /* Function prototype. */ | |
48 | static int sr_logv(void *cb_data, int loglevel, const char *format, | |
49 | va_list args); | |
50 | ||
51 | /* Pointer to the currently selected log callback. Default: sr_logv(). */ | |
52 | static sr_log_callback sr_log_cb = sr_logv; | |
53 | ||
54 | /* | |
55 | * Pointer to private data that can be passed to the log callback. | |
56 | * This can be used (for example) by C++ GUIs to pass a "this" pointer. | |
57 | */ | |
58 | static void *sr_log_cb_data = NULL; | |
59 | ||
60 | /** @cond PRIVATE */ | |
61 | #define LOGLEVEL_TIMESTAMP SR_LOG_DBG | |
62 | /** @endcond */ | |
63 | static int64_t sr_log_start_time = 0; | |
64 | ||
65 | /** | |
66 | * Set the libsigrok loglevel. | |
67 | * | |
68 | * This influences the amount of log messages (debug messages, error messages, | |
69 | * and so on) libsigrok will output. Using SR_LOG_NONE disables all messages. | |
70 | * | |
71 | * Note that this function itself will also output log messages. After the | |
72 | * loglevel has changed, it will output a debug message with SR_LOG_DBG for | |
73 | * example. Whether this message is shown depends on the (new) loglevel. | |
74 | * | |
75 | * @param loglevel The loglevel to set (SR_LOG_NONE, SR_LOG_ERR, SR_LOG_WARN, | |
76 | * SR_LOG_INFO, SR_LOG_DBG, or SR_LOG_SPEW). | |
77 | * | |
78 | * @return SR_OK upon success, SR_ERR_ARG upon invalid loglevel. | |
79 | * | |
80 | * @since 0.1.0 | |
81 | */ | |
82 | SR_API int sr_log_loglevel_set(int loglevel) | |
83 | { | |
84 | if (loglevel < SR_LOG_NONE || loglevel > SR_LOG_SPEW) { | |
85 | sr_err("Invalid loglevel %d.", loglevel); | |
86 | return SR_ERR_ARG; | |
87 | } | |
88 | /* Output time stamps relative to time at startup */ | |
89 | if (loglevel >= LOGLEVEL_TIMESTAMP && sr_log_start_time == 0) | |
90 | sr_log_start_time = g_get_monotonic_time(); | |
91 | ||
92 | cur_loglevel = loglevel; | |
93 | ||
94 | sr_dbg("libsigrok loglevel set to %d.", loglevel); | |
95 | ||
96 | return SR_OK; | |
97 | } | |
98 | ||
99 | /** | |
100 | * Get the libsigrok loglevel. | |
101 | * | |
102 | * @return The currently configured libsigrok loglevel. | |
103 | * | |
104 | * @since 0.1.0 | |
105 | */ | |
106 | SR_API int sr_log_loglevel_get(void) | |
107 | { | |
108 | return cur_loglevel; | |
109 | } | |
110 | ||
111 | /** | |
112 | * Set the libsigrok log callback to the specified function. | |
113 | * | |
114 | * @param cb Function pointer to the log callback function to use. | |
115 | * Must not be NULL. | |
116 | * @param cb_data Pointer to private data to be passed on. This can be used by | |
117 | * the caller to pass arbitrary data to the log functions. This | |
118 | * pointer is only stored or passed on by libsigrok, and is | |
119 | * never used or interpreted in any way. The pointer is allowed | |
120 | * to be NULL if the caller doesn't need/want to pass any data. | |
121 | * | |
122 | * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. | |
123 | * | |
124 | * @since 0.3.0 | |
125 | */ | |
126 | SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data) | |
127 | { | |
128 | if (!cb) { | |
129 | sr_err("%s: cb was NULL", __func__); | |
130 | return SR_ERR_ARG; | |
131 | } | |
132 | ||
133 | /* Note: 'cb_data' is allowed to be NULL. */ | |
134 | ||
135 | sr_log_cb = cb; | |
136 | sr_log_cb_data = cb_data; | |
137 | ||
138 | return SR_OK; | |
139 | } | |
140 | ||
141 | /** | |
142 | * Set the libsigrok log callback to the default built-in one. | |
143 | * | |
144 | * Additionally, the internal 'sr_log_cb_data' pointer is set to NULL. | |
145 | * | |
146 | * @return SR_OK upon success, a negative error code otherwise. | |
147 | * | |
148 | * @since 0.1.0 | |
149 | */ | |
150 | SR_API int sr_log_callback_set_default(void) | |
151 | { | |
152 | /* | |
153 | * Note: No log output in this function, as it should safely work | |
154 | * even if the currently set log callback is buggy/broken. | |
155 | */ | |
156 | sr_log_cb = sr_logv; | |
157 | sr_log_cb_data = NULL; | |
158 | ||
159 | return SR_OK; | |
160 | } | |
161 | ||
162 | static int sr_logv(void *cb_data, int loglevel, const char *format, va_list args) | |
163 | { | |
164 | uint64_t elapsed_us, minutes; | |
165 | unsigned int rest_us, seconds, microseconds; | |
166 | int ret; | |
167 | ||
168 | /* This specific log callback doesn't need the void pointer data. */ | |
169 | (void)cb_data; | |
170 | ||
171 | /* Only output messages of at least the selected loglevel(s). */ | |
172 | if (loglevel > cur_loglevel) | |
173 | return SR_OK; | |
174 | ||
175 | if (cur_loglevel >= LOGLEVEL_TIMESTAMP) { | |
176 | elapsed_us = g_get_monotonic_time() - sr_log_start_time; | |
177 | ||
178 | minutes = elapsed_us / G_TIME_SPAN_MINUTE; | |
179 | rest_us = elapsed_us % G_TIME_SPAN_MINUTE; | |
180 | seconds = rest_us / G_TIME_SPAN_SECOND; | |
181 | microseconds = rest_us % G_TIME_SPAN_SECOND; | |
182 | ||
183 | ret = g_fprintf(stderr, "sr: [%.2" PRIu64 ":%.2u.%.6u] ", | |
184 | minutes, seconds, microseconds); | |
185 | } else { | |
186 | ret = fputs("sr: ", stderr); | |
187 | } | |
188 | ||
189 | if (ret < 0 || g_vfprintf(stderr, format, args) < 0 | |
190 | || putc('\n', stderr) < 0) | |
191 | return SR_ERR; | |
192 | ||
193 | return SR_OK; | |
194 | } | |
195 | ||
196 | /** @private */ | |
197 | SR_PRIV int sr_log(int loglevel, const char *format, ...) | |
198 | { | |
199 | int ret; | |
200 | va_list args; | |
201 | ||
202 | va_start(args, format); | |
203 | ret = sr_log_cb(sr_log_cb_data, loglevel, format, args); | |
204 | va_end(args); | |
205 | ||
206 | return ret; | |
207 | } | |
208 | ||
209 | /** @} */ |