]> sigrok.org Git - libsigrokdecode.git/blame - srd.c
parallel: implement consistent number formatting
[libsigrokdecode.git] / srd.c
CommitLineData
190b71cf
BV
1/*
2 * This file is part of the libsigrokdecode project.
3 *
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
36784362 21#include <config.h>
f6c7eade
MC
22#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23#include "libsigrokdecode.h"
190b71cf
BV
24#include <glib.h>
25
26/** @cond PRIVATE */
27
ea81b49a
BV
28/* Python module search paths */
29SRD_PRIV GSList *searchpaths = NULL;
30
190b71cf 31/* session.c */
23a29d24
UH
32extern SRD_PRIV GSList *sessions;
33extern SRD_PRIV int max_session_id;
190b71cf 34
190b71cf
BV
35/** @endcond */
36
37/**
38 * @mainpage libsigrokdecode API
39 *
40 * @section sec_intro Introduction
41 *
42 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
43 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
44 * suite that supports various device types (such as logic analyzers,
45 * oscilloscopes, multimeters, and more).
46 *
47 * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a
48 * shared library written in C which provides the basic API for (streaming)
49 * protocol decoding functionality.
50 *
51 * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
52 * are written in Python (>= 3.0).
53 *
54 * @section sec_api API reference
55 *
56 * See the "Modules" page for an introduction to various libsigrokdecode
57 * related topics and the detailed API documentation of the respective
58 * functions.
59 *
60 * You can also browse the API documentation by file, or review all
61 * data structures.
62 *
63 * @section sec_mailinglists Mailing lists
64 *
3b884e85 65 * There is one mailing list for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a>.
190b71cf
BV
66 *
67 * @section sec_irc IRC
68 *
69 * You can find the sigrok developers in the
70 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
71 * IRC channel on Freenode.
72 *
73 * @section sec_website Website
74 *
75 * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
76 */
77
78/**
79 * @file
80 *
81 * Initializing and shutting down libsigrokdecode.
82 */
83
84/**
85 * @defgroup grp_init Initialization
86 *
87 * Initializing and shutting down libsigrokdecode.
88 *
89 * Before using any of the libsigrokdecode functionality, srd_init() must
90 * be called to initialize the library.
91 *
92 * When libsigrokdecode functionality is no longer needed, srd_exit() should
93 * be called.
94 *
95 * @{
96 */
97
40c6ac1d
DE
98static int searchpath_add_xdg_dir(const char *datadir)
99{
100 char *decdir;
101 int ret;
102
103 decdir = g_build_filename(datadir, PACKAGE_TARNAME, "decoders", NULL);
104
105 if (g_file_test(decdir, G_FILE_TEST_IS_DIR))
106 ret = srd_decoder_searchpath_add(decdir);
107 else
108 ret = SRD_OK; /* just ignore non-existing directory */
109
110 g_free(decdir);
111
112 return ret;
113}
114
cdb49509
UH
115static void print_versions(void)
116{
117 GString *s;
118 GSList *l, *l_orig, *m;
119 char *str;
120 const char *lib, *version;
121
122 srd_dbg("libsigrokdecode %s/%s (rt: %s/%s).",
123 SRD_PACKAGE_VERSION_STRING, SRD_LIB_VERSION_STRING,
124 srd_package_version_string_get(), srd_lib_version_string_get());
125
126 s = g_string_sized_new(200);
127 g_string_append(s, "Libs: ");
128 l_orig = srd_buildinfo_libs_get();
129 for (l = l_orig; l; l = l->next) {
130 m = l->data;
131 lib = m->data;
132 version = m->next->data;
133 g_string_append_printf(s, "%s %s, ", lib, version);
134 g_slist_free_full(m, g_free);
135 }
136 g_slist_free(l_orig);
137 s->str[s->len - 2] = '.';
138 s->str[s->len - 1] = '\0';
139 srd_dbg("%s", s->str);
140 g_string_free(s, TRUE);
141
142 str = srd_buildinfo_host_get();
143 srd_dbg("Host: %s.", str);
144 g_free(str);
145}
146
a2860c19
UH
147static int print_searchpaths(void)
148{
149 PyObject *py_paths, *py_path, *py_bytes;
150 PyGILState_STATE gstate;
151 GString *s;
152 int i;
153
154 gstate = PyGILState_Ensure();
155
156 py_paths = PySys_GetObject("path");
157 if (!py_paths)
158 goto err;
159
160 s = g_string_sized_new(500);
161 g_string_append(s, "Decoder search paths:\n");
162 for (i = 0; i < PyList_Size(py_paths); i++) {
163 py_path = PyList_GetItem(py_paths, i);
164 py_bytes = PyUnicode_AsUTF8String(py_path);
165 g_string_append_printf(s, " - %s\n", PyBytes_AsString(py_bytes));
166 }
167 s->str[s->len - 1] = '\0';
168 srd_dbg("%s", s->str);
169 g_string_free(s, TRUE);
170
171 PyGILState_Release(gstate);
172
173 return SRD_OK;
174
175err:
176 srd_err("Unable to query decoder search paths.");
177 PyGILState_Release(gstate);
178
179 return SRD_ERR_PYTHON;
180}
181
190b71cf
BV
182/**
183 * Initialize libsigrokdecode.
184 *
185 * This initializes the Python interpreter, and creates and initializes
186 * a "sigrokdecode" Python module.
187 *
188 * Then, it searches for sigrok protocol decoders in the "decoders"
189 * subdirectory of the the libsigrokdecode installation directory.
190 * All decoders that are found are loaded into memory and added to an
191 * internal list of decoders, which can be queried via srd_decoder_list().
192 *
193 * The caller is responsible for calling the clean-up function srd_exit(),
194 * which will properly shut down libsigrokdecode and free its allocated memory.
195 *
196 * Multiple calls to srd_init(), without calling srd_exit() in between,
197 * are not allowed.
198 *
199 * @param path Path to an extra directory containing protocol decoders
200 * which will be added to the Python sys.path. May be NULL.
201 *
202 * @return SRD_OK upon success, a (negative) error code otherwise.
203 * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
204 * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
205 * If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
206 *
207 * @since 0.1.0
208 */
209SRD_API int srd_init(const char *path)
210{
40c6ac1d
DE
211 const char *const *sys_datadirs;
212 const char *env_path;
213 size_t i;
190b71cf 214 int ret;
190b71cf
BV
215
216 if (max_session_id != -1) {
217 srd_err("libsigrokdecode is already initialized.");
218 return SRD_ERR;
219 }
220
cdb49509
UH
221 print_versions();
222
190b71cf
BV
223 srd_dbg("Initializing libsigrokdecode.");
224
225 /* Add our own module to the list of built-in modules. */
226 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
227
228 /* Initialize the Python interpreter. */
45883c6b 229 Py_InitializeEx(0);
190b71cf 230
40c6ac1d
DE
231 /* Locations relative to the XDG system data directories. */
232 sys_datadirs = g_get_system_data_dirs();
233 for (i = g_strv_length((char **)sys_datadirs); i > 0; i--) {
234 ret = searchpath_add_xdg_dir(sys_datadirs[i-1]);
235 if (ret != SRD_OK) {
236 Py_Finalize();
237 return ret;
238 }
239 }
240#ifdef DECODERS_DIR
241 /* Hardcoded decoders install location, if defined. */
190b71cf
BV
242 if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
243 Py_Finalize();
244 return ret;
245 }
40c6ac1d
DE
246#endif
247 /* Location relative to the XDG user data directory. */
248 ret = searchpath_add_xdg_dir(g_get_user_data_dir());
249 if (ret != SRD_OK) {
250 Py_Finalize();
251 return ret;
252 }
190b71cf
BV
253
254 /* Path specified by the user. */
255 if (path) {
256 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
257 Py_Finalize();
258 return ret;
259 }
260 }
261
262 /* Environment variable overrides everything, for debugging. */
40c6ac1d 263 if ((env_path = g_getenv("SIGROKDECODE_DIR"))) {
190b71cf
BV
264 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
265 Py_Finalize();
266 return ret;
267 }
268 }
269
514b2edc
UH
270 /* Initialize the Python GIL (this also happens to acquire it). */
271 PyEval_InitThreads();
272
273 /* Release the GIL (ignore return value, we don't need it here). */
274 (void)PyEval_SaveThread();
275
190b71cf
BV
276 max_session_id = 0;
277
a2860c19
UH
278 print_searchpaths();
279
190b71cf
BV
280 return SRD_OK;
281}
282
283/**
284 * Shutdown libsigrokdecode.
285 *
286 * This frees all the memory allocated for protocol decoders and shuts down
287 * the Python interpreter.
288 *
289 * This function should only be called if there was a (successful!) invocation
290 * of srd_init() before. Calling this function multiple times in a row, without
291 * any successful srd_init() calls in between, is not allowed.
292 *
293 * @return SRD_OK upon success, a (negative) error code otherwise.
294 *
295 * @since 0.1.0
296 */
297SRD_API int srd_exit(void)
298{
190b71cf
BV
299 srd_dbg("Exiting libsigrokdecode.");
300
95e40a0c 301 g_slist_foreach(sessions, (GFunc)srd_session_destroy, NULL);
190b71cf
BV
302
303 srd_decoder_unload_all();
ea81b49a
BV
304 g_slist_free_full(searchpaths, g_free);
305 searchpaths = NULL;
190b71cf 306
514b2edc
UH
307 /*
308 * Acquire the GIL, otherwise Py_Finalize() might have issues.
309 * Ignore the return value, we don't need it here.
310 */
2071c4d3
UH
311 if (Py_IsInitialized())
312 (void)PyGILState_Ensure();
514b2edc 313
190b71cf
BV
314 /* Py_Finalize() returns void, any finalization errors are ignored. */
315 Py_Finalize();
316
514b2edc
UH
317 /* Note: No need to release the GIL since Python is shut down now. */
318
190b71cf
BV
319 max_session_id = -1;
320
321 return SRD_OK;
322}
323
324/**
325 * Add an additional search directory for the protocol decoders.
326 *
327 * The specified directory is prepended (not appended!) to Python's sys.path,
328 * in order to search for sigrok protocol decoders in the specified
329 * directories first, and in the generic Python module directories (and in
330 * the current working directory) last. This avoids conflicts if there are
331 * Python modules which have the same name as a sigrok protocol decoder in
332 * sys.path or in the current working directory.
333 *
334 * @param path Path to the directory containing protocol decoders which shall
335 * be added to the Python sys.path, or NULL.
336 *
337 * @return SRD_OK upon success, a (negative) error code otherwise.
338 *
339 * @private
340 *
341 * @since 0.1.0
342 */
343SRD_PRIV int srd_decoder_searchpath_add(const char *path)
344{
345 PyObject *py_cur_path, *py_item;
514b2edc 346 PyGILState_STATE gstate;
190b71cf
BV
347
348 srd_dbg("Adding '%s' to module path.", path);
349
514b2edc
UH
350 gstate = PyGILState_Ensure();
351
190b71cf 352 py_cur_path = PySys_GetObject("path");
d8d40959 353 if (!py_cur_path)
514b2edc 354 goto err;
d8d40959
DE
355
356 py_item = PyUnicode_FromString(path);
357 if (!py_item) {
358 srd_exception_catch("Failed to create Unicode object");
514b2edc 359 goto err;
d8d40959
DE
360 }
361 if (PyList_Insert(py_cur_path, 0, py_item) < 0) {
362 srd_exception_catch("Failed to insert path element");
363 Py_DECREF(py_item);
514b2edc 364 goto err;
190b71cf 365 }
d8d40959 366 Py_DECREF(py_item);
190b71cf 367
514b2edc
UH
368 PyGILState_Release(gstate);
369
d8d40959 370 searchpaths = g_slist_prepend(searchpaths, g_strdup(path));
190b71cf
BV
371
372 return SRD_OK;
514b2edc
UH
373
374err:
375 PyGILState_Release(gstate);
376
377 return SRD_ERR_PYTHON;
190b71cf
BV
378}
379
380/** @} */