]>
Commit | Line | Data |
---|---|---|
b2c19614 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
b2c19614 BV |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
4fadb128 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
b2c19614 BV |
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 | ||
21 | #include "config.h" | |
c1f86f02 UH |
22 | #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
23 | #include "libsigrokdecode-internal.h" | |
eb2bbd66 | 24 | #include <glib.h> |
b2c19614 | 25 | |
54fdeeef UH |
26 | /** |
27 | * @file | |
28 | * | |
29 | * Listing, loading, unloading, and handling protocol decoders. | |
30 | */ | |
31 | ||
4895418c UH |
32 | /** |
33 | * @defgroup grp_decoder Protocol decoders | |
34 | * | |
35 | * Handling protocol decoders. | |
36 | * | |
37 | * @{ | |
38 | */ | |
39 | ||
57790bc8 UH |
40 | /** @cond PRIVATE */ |
41 | ||
b2c19614 | 42 | /* The list of protocol decoders. */ |
55c3c5f4 | 43 | SRD_PRIV GSList *pd_list = NULL; |
b2c19614 | 44 | |
ea81b49a BV |
45 | /* srd.c */ |
46 | extern GSList *searchpaths; | |
47 | ||
48 | /* session.c */ | |
32cfb920 BV |
49 | extern GSList *sessions; |
50 | ||
c9bfccc6 | 51 | /* module_sigrokdecode.c */ |
55c3c5f4 | 52 | extern SRD_PRIV PyObject *mod_sigrokdecode; |
451680f1 | 53 | |
57790bc8 UH |
54 | /** @endcond */ |
55 | ||
b2c19614 BV |
56 | /** |
57 | * Returns the list of supported/loaded protocol decoders. | |
58 | * | |
59 | * This is a GSList containing the names of the decoders as strings. | |
60 | * | |
61 | * @return List of decoders, NULL if none are supported or loaded. | |
8c664ca2 UH |
62 | * |
63 | * @since 0.1.0 (but the API changed in 0.2.0) | |
b2c19614 | 64 | */ |
38ff5046 | 65 | SRD_API const GSList *srd_decoder_list(void) |
b2c19614 | 66 | { |
e5080882 | 67 | return pd_list; |
b2c19614 BV |
68 | } |
69 | ||
b2c19614 BV |
70 | /** |
71 | * Get the decoder with the specified ID. | |
72 | * | |
73 | * @param id The ID string of the decoder to return. | |
582c8473 | 74 | * |
b2c19614 | 75 | * @return The decoder with the specified ID, or NULL if not found. |
8c664ca2 UH |
76 | * |
77 | * @since 0.1.0 | |
b2c19614 | 78 | */ |
9d122fd5 | 79 | SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id) |
b2c19614 BV |
80 | { |
81 | GSList *l; | |
82 | struct srd_decoder *dec; | |
83 | ||
38ff5046 | 84 | for (l = pd_list; l; l = l->next) { |
b2c19614 BV |
85 | dec = l->data; |
86 | if (!strcmp(dec->id, id)) | |
87 | return dec; | |
88 | } | |
89 | ||
90 | return NULL; | |
91 | } | |
92 | ||
5a2c4dc4 | 93 | static int get_probes(const struct srd_decoder *d, const char *attr, |
22c9bc2a | 94 | GSList **pl) |
f38ec285 BV |
95 | { |
96 | PyObject *py_probelist, *py_entry; | |
97 | struct srd_probe *p; | |
98 | int ret, num_probes, i; | |
99 | ||
100 | if (!PyObject_HasAttrString(d->py_dec, attr)) | |
101 | /* No probes of this type specified. */ | |
102 | return SRD_OK; | |
103 | ||
f38ec285 BV |
104 | py_probelist = PyObject_GetAttrString(d->py_dec, attr); |
105 | if (!PyList_Check(py_probelist)) { | |
22c9bc2a BV |
106 | srd_err("Protocol decoder %s %s attribute is not a list.", |
107 | d->name, attr); | |
108 | return SRD_ERR_PYTHON; | |
f38ec285 BV |
109 | } |
110 | ||
22c9bc2a | 111 | if ((num_probes = PyList_Size(py_probelist)) == 0) |
f38ec285 BV |
112 | /* Empty probelist. */ |
113 | return SRD_OK; | |
114 | ||
22c9bc2a | 115 | ret = SRD_OK; |
f38ec285 BV |
116 | for (i = 0; i < num_probes; i++) { |
117 | py_entry = PyList_GetItem(py_probelist, i); | |
118 | if (!PyDict_Check(py_entry)) { | |
119 | srd_err("Protocol decoder %s %s attribute is not " | |
c9bfccc6 | 120 | "a list with dict elements.", d->name, attr); |
22c9bc2a BV |
121 | ret = SRD_ERR_PYTHON; |
122 | break; | |
f38ec285 BV |
123 | } |
124 | ||
125 | if (!(p = g_try_malloc(sizeof(struct srd_probe)))) { | |
a61ece20 | 126 | srd_err("Failed to g_malloc() struct srd_probe."); |
f38ec285 | 127 | ret = SRD_ERR_MALLOC; |
22c9bc2a | 128 | break; |
f38ec285 BV |
129 | } |
130 | ||
22c9bc2a BV |
131 | if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK) { |
132 | ret = SRD_ERR_PYTHON; | |
133 | break; | |
134 | } | |
135 | if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK) { | |
136 | ret = SRD_ERR_PYTHON; | |
137 | break; | |
138 | } | |
139 | if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK) { | |
140 | ret = SRD_ERR_PYTHON; | |
141 | break; | |
142 | } | |
f38ec285 BV |
143 | p->order = i; |
144 | ||
145 | *pl = g_slist_append(*pl, p); | |
146 | } | |
f38ec285 | 147 | |
f38ec285 BV |
148 | Py_DecRef(py_probelist); |
149 | ||
150 | return ret; | |
151 | } | |
152 | ||
2f395bff BV |
153 | static int get_options(struct srd_decoder *d) |
154 | { | |
155 | PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default; | |
156 | Py_ssize_t i; | |
157 | struct srd_decoder_option *o; | |
158 | gint64 def_long; | |
159 | int num_keys, overflow, ret; | |
160 | char *key, *def_str; | |
161 | ||
162 | ret = SRD_ERR_PYTHON; | |
163 | key = NULL; | |
164 | ||
165 | if (!PyObject_HasAttrString(d->py_dec, "options")) | |
166 | /* That's fine. */ | |
167 | return SRD_OK; | |
168 | ||
169 | /* If present, options must be a dictionary. */ | |
170 | py_opts = PyObject_GetAttrString(d->py_dec, "options"); | |
171 | if (!PyDict_Check(py_opts)) { | |
172 | srd_err("Protocol decoder %s options attribute is not " | |
173 | "a dictionary.", d->name); | |
174 | goto err_out; | |
175 | } | |
176 | ||
177 | py_keys = PyDict_Keys(py_opts); | |
178 | py_values = PyDict_Values(py_opts); | |
179 | num_keys = PyList_Size(py_keys); | |
180 | for (i = 0; i < num_keys; i++) { | |
181 | py_str_as_str(PyList_GetItem(py_keys, i), &key); | |
182 | srd_dbg("option '%s'", key); | |
183 | py_val = PyList_GetItem(py_values, i); | |
184 | if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) { | |
185 | srd_err("Protocol decoder %s option '%s' value must be " | |
186 | "a list with two elements.", d->name, key); | |
187 | goto err_out; | |
188 | } | |
189 | py_desc = PyList_GetItem(py_val, 0); | |
190 | if (!PyUnicode_Check(py_desc)) { | |
191 | srd_err("Protocol decoder %s option '%s' has no " | |
192 | "description.", d->name, key); | |
193 | goto err_out; | |
194 | } | |
195 | py_default = PyList_GetItem(py_val, 1); | |
196 | if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) { | |
197 | srd_err("Protocol decoder %s option '%s' has default " | |
198 | "of unsupported type '%s'.", d->name, key, | |
199 | Py_TYPE(py_default)->tp_name); | |
200 | goto err_out; | |
201 | } | |
202 | if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) { | |
203 | srd_err("option malloc failed"); | |
204 | goto err_out; | |
205 | } | |
206 | o->id = g_strdup(key); | |
207 | py_str_as_str(py_desc, &o->desc); | |
208 | if (PyUnicode_Check(py_default)) { | |
209 | /* UTF-8 string */ | |
210 | py_str_as_str(py_default, &def_str); | |
211 | o->def = g_variant_new_string(def_str); | |
212 | g_free(def_str); | |
213 | } else { | |
214 | /* Long */ | |
215 | def_long = PyLong_AsLongAndOverflow(py_default, &overflow); | |
216 | if (overflow) { | |
217 | /* Value is < LONG_MIN or > LONG_MAX */ | |
218 | PyErr_Clear(); | |
219 | srd_err("Protocol decoder %s option '%s' has " | |
220 | "invalid default value.", d->name, key); | |
221 | goto err_out; | |
222 | } | |
223 | o->def = g_variant_new_int64(def_long); | |
224 | } | |
225 | g_variant_ref_sink(o->def); | |
226 | d->options = g_slist_append(d->options, o); | |
e592ac89 | 227 | g_free(key); |
ca3fc3c0 | 228 | key = NULL; |
2f395bff BV |
229 | } |
230 | Py_DecRef(py_keys); | |
231 | Py_DecRef(py_values); | |
232 | ||
233 | ret = SRD_OK; | |
234 | ||
235 | err_out: | |
236 | Py_XDECREF(py_opts); | |
237 | g_free(key); | |
238 | ||
239 | return ret; | |
240 | } | |
241 | ||
b2c19614 | 242 | /** |
64c29e28 | 243 | * Load a protocol decoder module into the embedded Python interpreter. |
b2c19614 | 244 | * |
38ff5046 | 245 | * @param module_name The module name to be loaded. |
b2c19614 BV |
246 | * |
247 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
248 | * |
249 | * @since 0.1.0 | |
b2c19614 | 250 | */ |
9d122fd5 | 251 | SRD_API int srd_decoder_load(const char *module_name) |
b2c19614 | 252 | { |
1ce46817 UH |
253 | PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann; |
254 | PyObject *py_bin_classes, *py_bin_class, *py_ann_rows, *py_ann_row; | |
255 | PyObject *py_ann_classes, *py_long; | |
b2c19614 | 256 | struct srd_decoder *d; |
1ce46817 UH |
257 | int ret, i, j; |
258 | char **ann, **bin, *ann_row_id, *ann_row_desc; | |
38ff5046 | 259 | struct srd_probe *p; |
1ce46817 UH |
260 | GSList *l, *ann_classes; |
261 | struct srd_decoder_annotation_row *ann_row; | |
b2c19614 | 262 | |
e195c025 BV |
263 | if (!srd_check_init()) |
264 | return SRD_ERR; | |
265 | ||
8a014683 BV |
266 | if (!module_name) |
267 | return SRD_ERR_ARG; | |
268 | ||
aac68131 BV |
269 | if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) { |
270 | /* Module was already imported. */ | |
271 | return SRD_OK; | |
272 | } | |
273 | ||
8ad6e500 | 274 | srd_dbg("Loading protocol decoder '%s'.", module_name); |
64c29e28 | 275 | |
d906d3f9 | 276 | py_basedec = py_method = py_attr = NULL; |
b2c19614 | 277 | |
451680f1 | 278 | if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) { |
a61ece20 | 279 | srd_dbg("Failed to g_malloc() struct srd_decoder."); |
451680f1 BV |
280 | ret = SRD_ERR_MALLOC; |
281 | goto err_out; | |
b2c19614 BV |
282 | } |
283 | ||
21481b66 BV |
284 | ret = SRD_ERR_PYTHON; |
285 | ||
451680f1 | 286 | /* Import the Python module. */ |
9b37109d | 287 | if (!(d->py_mod = PyImport_ImportModule(module_name))) { |
aafeeaea | 288 | srd_exception_catch("Import of '%s' failed.", module_name); |
451680f1 BV |
289 | goto err_out; |
290 | } | |
b2c19614 | 291 | |
451680f1 BV |
292 | /* Get the 'Decoder' class as Python object. */ |
293 | if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) { | |
294 | /* This generated an AttributeError exception. */ | |
295 | PyErr_Clear(); | |
361fdcaa UH |
296 | srd_err("Decoder class not found in protocol decoder %s.", |
297 | module_name); | |
451680f1 BV |
298 | goto err_out; |
299 | } | |
b2c19614 | 300 | |
451680f1 | 301 | if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) { |
7a1712c4 | 302 | srd_dbg("sigrokdecode module not loaded."); |
451680f1 BV |
303 | goto err_out; |
304 | } | |
b2c19614 | 305 | |
451680f1 BV |
306 | if (!PyObject_IsSubclass(d->py_dec, py_basedec)) { |
307 | srd_err("Decoder class in protocol decoder module %s is not " | |
9b37109d | 308 | "a subclass of sigrokdecode.Decoder.", module_name); |
451680f1 BV |
309 | goto err_out; |
310 | } | |
ad022d94 | 311 | Py_CLEAR(py_basedec); |
b2c19614 | 312 | |
1d552cd3 BV |
313 | /* Check for a proper start() method. */ |
314 | if (!PyObject_HasAttrString(d->py_dec, "start")) { | |
315 | srd_err("Protocol decoder %s has no start() method Decoder " | |
9b37109d | 316 | "class.", module_name); |
1d552cd3 BV |
317 | goto err_out; |
318 | } | |
319 | py_method = PyObject_GetAttrString(d->py_dec, "start"); | |
320 | if (!PyFunction_Check(py_method)) { | |
d906d3f9 | 321 | srd_err("Protocol decoder %s Decoder class attribute 'start' " |
9b37109d | 322 | "is not a method.", module_name); |
1d552cd3 BV |
323 | goto err_out; |
324 | } | |
ad022d94 | 325 | Py_CLEAR(py_method); |
1d552cd3 BV |
326 | |
327 | /* Check for a proper decode() method. */ | |
328 | if (!PyObject_HasAttrString(d->py_dec, "decode")) { | |
329 | srd_err("Protocol decoder %s has no decode() method Decoder " | |
9b37109d | 330 | "class.", module_name); |
1d552cd3 BV |
331 | goto err_out; |
332 | } | |
333 | py_method = PyObject_GetAttrString(d->py_dec, "decode"); | |
334 | if (!PyFunction_Check(py_method)) { | |
335 | srd_err("Protocol decoder %s Decoder class attribute 'decode' " | |
9b37109d | 336 | "is not a method.", module_name); |
1d552cd3 BV |
337 | goto err_out; |
338 | } | |
ad022d94 | 339 | Py_CLEAR(py_method); |
1d552cd3 | 340 | |
2f395bff BV |
341 | if (get_options(d) != SRD_OK) |
342 | goto err_out; | |
11ea8ae1 | 343 | |
f38ec285 BV |
344 | /* Check and import required probes. */ |
345 | if (get_probes(d, "probes", &d->probes) != SRD_OK) | |
346 | goto err_out; | |
347 | ||
348 | /* Check and import optional probes. */ | |
dcdf4883 | 349 | if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK) |
f38ec285 BV |
350 | goto err_out; |
351 | ||
38ff5046 UH |
352 | /* |
353 | * Fix order numbers for the optional probes. | |
354 | * | |
355 | * Example: | |
356 | * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4. | |
357 | * 'order' fields in the d->probes list = 0, 1, 2. | |
358 | * 'order' fields in the d->opt_probes list = 3, 4, 5, 6. | |
359 | */ | |
360 | for (l = d->opt_probes; l; l = l->next) { | |
361 | p = l->data; | |
362 | p->order += g_slist_length(d->probes); | |
363 | } | |
364 | ||
f38ec285 | 365 | /* Store required fields in newly allocated strings. */ |
21481b66 | 366 | if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) |
451680f1 | 367 | goto err_out; |
b2c19614 | 368 | |
21481b66 | 369 | if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) |
451680f1 | 370 | goto err_out; |
b2c19614 | 371 | |
21481b66 | 372 | if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) |
451680f1 | 373 | goto err_out; |
b2c19614 | 374 | |
21481b66 | 375 | if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) |
451680f1 | 376 | goto err_out; |
b2c19614 | 377 | |
21481b66 | 378 | if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) |
451680f1 | 379 | goto err_out; |
b2c19614 | 380 | |
d75d8a7c | 381 | /* Convert annotation class attribute to GSList of char **. */ |
e97b6ef5 | 382 | d->annotations = NULL; |
451680f1 BV |
383 | if (PyObject_HasAttrString(d->py_dec, "annotations")) { |
384 | py_annlist = PyObject_GetAttrString(d->py_dec, "annotations"); | |
15969949 | 385 | if (!PyList_Check(py_annlist)) { |
1f2275dd BV |
386 | srd_err("Protocol decoder %s annotations should " |
387 | "be a list.", module_name); | |
451680f1 | 388 | goto err_out; |
15969949 | 389 | } |
1ce46817 | 390 | for (i = 0; i < PyList_Size(py_annlist); i++) { |
15969949 BV |
391 | py_ann = PyList_GetItem(py_annlist, i); |
392 | if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) { | |
1f2275dd BV |
393 | srd_err("Protocol decoder %s annotation %d should " |
394 | "be a list with two elements.", module_name, i + 1); | |
451680f1 | 395 | goto err_out; |
15969949 BV |
396 | } |
397 | ||
62a2b15c | 398 | if (py_strseq_to_char(py_ann, &ann) != SRD_OK) { |
451680f1 BV |
399 | goto err_out; |
400 | } | |
e97b6ef5 | 401 | d->annotations = g_slist_append(d->annotations, ann); |
15969949 BV |
402 | } |
403 | } | |
404 | ||
1ce46817 UH |
405 | /* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */ |
406 | d->annotation_rows = NULL; | |
407 | if (PyObject_HasAttrString(d->py_dec, "annotation_rows")) { | |
408 | py_ann_rows = PyObject_GetAttrString(d->py_dec, "annotation_rows"); | |
409 | if (!PyTuple_Check(py_ann_rows)) { | |
410 | srd_err("Protocol decoder %s annotation row list " | |
411 | "must be a tuple.", module_name); | |
412 | goto err_out; | |
413 | } | |
414 | for (i = 0; i < PyTuple_Size(py_ann_rows); i++) { | |
415 | py_ann_row = PyTuple_GetItem(py_ann_rows, i); | |
416 | if (!PyTuple_Check(py_ann_row)) { | |
417 | srd_err("Protocol decoder %s annotation rows " | |
418 | "must be tuples.", module_name); | |
419 | goto err_out; | |
420 | } | |
421 | if (PyTuple_Size(py_ann_row) != 3 | |
422 | || !PyUnicode_Check(PyTuple_GetItem(py_ann_row, 0)) | |
423 | || !PyUnicode_Check(PyTuple_GetItem(py_ann_row, 1)) | |
424 | || !PyTuple_Check(PyTuple_GetItem(py_ann_row, 2))) { | |
425 | srd_err("Protocol decoder %s annotation rows " | |
426 | "must contain tuples containing two " | |
427 | "strings and a tuple.", module_name); | |
428 | goto err_out; | |
429 | } | |
430 | ||
431 | if (py_str_as_str(PyTuple_GetItem(py_ann_row, 0), &ann_row_id) != SRD_OK) | |
432 | goto err_out; | |
433 | ||
434 | if (py_str_as_str(PyTuple_GetItem(py_ann_row, 1), &ann_row_desc) != SRD_OK) | |
435 | goto err_out; | |
436 | ||
437 | py_ann_classes = PyTuple_GetItem(py_ann_row, 2); | |
438 | ann_classes = NULL; | |
439 | for (j = 0; j < PyTuple_Size(py_ann_classes); j++) { | |
440 | py_long = PyTuple_GetItem(py_ann_classes, j); | |
441 | if (!PyLong_Check(py_long)) { | |
442 | srd_err("Protocol decoder %s annotation row class " | |
443 | "list must only contain numbers.", module_name); | |
444 | goto err_out; | |
445 | } | |
446 | ann_classes = g_slist_append(ann_classes, | |
447 | GINT_TO_POINTER(PyLong_AsLong(py_long))); | |
448 | } | |
449 | ||
450 | ann_row = g_malloc0(sizeof(struct srd_decoder_annotation_row)); | |
451 | ann_row->id = ann_row_id; | |
452 | ann_row->desc = ann_row_desc; | |
453 | ann_row->ann_classes = ann_classes; | |
454 | d->annotation_rows = g_slist_append(d->annotation_rows, ann_row); | |
455 | } | |
456 | } | |
457 | ||
d75d8a7c BV |
458 | /* Convert binary class to GSList of char *. */ |
459 | d->binary = NULL; | |
460 | if (PyObject_HasAttrString(d->py_dec, "binary")) { | |
461 | py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary"); | |
462 | if (!PyTuple_Check(py_bin_classes)) { | |
1f2275dd BV |
463 | srd_err("Protocol decoder %s binary classes should " |
464 | "be a tuple.", module_name); | |
d75d8a7c BV |
465 | goto err_out; |
466 | } | |
1ce46817 | 467 | for (i = 0; i < PyTuple_Size(py_bin_classes); i++) { |
d75d8a7c | 468 | py_bin_class = PyTuple_GetItem(py_bin_classes, i); |
1f2275dd BV |
469 | if (!PyTuple_Check(py_bin_class)) { |
470 | srd_err("Protocol decoder %s binary classes " | |
471 | "should consist of tuples.", module_name); | |
472 | goto err_out; | |
473 | } | |
474 | if (PyTuple_Size(py_bin_class) != 2 | |
475 | || !PyUnicode_Check(PyTuple_GetItem(py_bin_class, 0)) | |
476 | || !PyUnicode_Check(PyTuple_GetItem(py_bin_class, 1))) { | |
477 | srd_err("Protocol decoder %s binary classes should " | |
478 | "contain tuples with two strings.", module_name); | |
d75d8a7c BV |
479 | goto err_out; |
480 | } | |
481 | ||
1f2275dd | 482 | if (py_strseq_to_char(py_bin_class, &bin) != SRD_OK) { |
d75d8a7c BV |
483 | goto err_out; |
484 | } | |
485 | d->binary = g_slist_append(d->binary, bin); | |
486 | } | |
487 | } | |
488 | ||
9b37109d BV |
489 | /* Append it to the list of supported/loaded decoders. */ |
490 | pd_list = g_slist_append(pd_list, d); | |
491 | ||
451680f1 BV |
492 | ret = SRD_OK; |
493 | ||
494 | err_out: | |
495 | if (ret != SRD_OK) { | |
1d552cd3 | 496 | Py_XDECREF(py_method); |
451680f1 BV |
497 | Py_XDECREF(py_basedec); |
498 | Py_XDECREF(d->py_dec); | |
499 | Py_XDECREF(d->py_mod); | |
500 | g_free(d); | |
501 | } | |
b2c19614 | 502 | |
451680f1 BV |
503 | return ret; |
504 | } | |
505 | ||
582c8473 BV |
506 | /** |
507 | * Return a protocol decoder's docstring. | |
508 | * | |
509 | * @param dec The loaded protocol decoder. | |
510 | * | |
361fdcaa | 511 | * @return A newly allocated buffer containing the protocol decoder's |
abeeed8b | 512 | * documentation. The caller is responsible for free'ing the buffer. |
8c664ca2 UH |
513 | * |
514 | * @since 0.1.0 | |
582c8473 | 515 | */ |
b33b8aa5 | 516 | SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec) |
451680f1 | 517 | { |
e7edca07 | 518 | PyObject *py_str; |
451680f1 BV |
519 | char *doc; |
520 | ||
e195c025 BV |
521 | if (!srd_check_init()) |
522 | return NULL; | |
523 | ||
524 | if (!dec) | |
525 | return NULL; | |
526 | ||
e7edca07 BV |
527 | if (!PyObject_HasAttrString(dec->py_mod, "__doc__")) |
528 | return NULL; | |
529 | ||
530 | if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) { | |
aafeeaea | 531 | srd_exception_catch(""); |
e7edca07 BV |
532 | return NULL; |
533 | } | |
534 | ||
451680f1 | 535 | doc = NULL; |
e7edca07 BV |
536 | if (py_str != Py_None) |
537 | py_str_as_str(py_str, &doc); | |
538 | Py_DecRef(py_str); | |
451680f1 BV |
539 | |
540 | return doc; | |
b2c19614 BV |
541 | } |
542 | ||
fa12a21e BV |
543 | static void free_probes(GSList *probelist) |
544 | { | |
545 | GSList *l; | |
546 | struct srd_probe *p; | |
547 | ||
548 | if (probelist == NULL) | |
549 | return; | |
550 | ||
551 | for (l = probelist; l; l = l->next) { | |
552 | p = l->data; | |
553 | g_free(p->id); | |
554 | g_free(p->name); | |
555 | g_free(p->desc); | |
556 | g_free(p); | |
557 | } | |
558 | g_slist_free(probelist); | |
fa12a21e BV |
559 | } |
560 | ||
b2c19614 | 561 | /** |
4cc0d9fe | 562 | * Unload the specified protocol decoder. |
451680f1 | 563 | * |
fa12a21e | 564 | * @param dec The struct srd_decoder to be unloaded. |
451680f1 BV |
565 | * |
566 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
567 | * |
568 | * @since 0.1.0 | |
b2c19614 | 569 | */ |
9d122fd5 | 570 | SRD_API int srd_decoder_unload(struct srd_decoder *dec) |
b2c19614 | 571 | { |
2f395bff | 572 | struct srd_decoder_option *o; |
32cfb920 | 573 | struct srd_session *sess; |
2f395bff BV |
574 | GSList *l; |
575 | ||
e195c025 BV |
576 | if (!srd_check_init()) |
577 | return SRD_ERR; | |
578 | ||
579 | if (!dec) | |
580 | return SRD_ERR_ARG; | |
581 | ||
8ad6e500 | 582 | srd_dbg("Unloading protocol decoder '%s'.", dec->name); |
fa12a21e | 583 | |
361fdcaa UH |
584 | /* |
585 | * Since any instances of this decoder need to be released as well, | |
fa12a21e BV |
586 | * but they could be anywhere in the stack, just free the entire |
587 | * stack. A frontend reloading a decoder thus has to restart all | |
361fdcaa UH |
588 | * instances, and rebuild the stack. |
589 | */ | |
32cfb920 BV |
590 | for (l = sessions; l; l = l->next) { |
591 | sess = l->data; | |
592 | srd_inst_free_all(sess, NULL); | |
593 | } | |
fa12a21e | 594 | |
2f395bff BV |
595 | for (l = dec->options; l; l = l->next) { |
596 | o = l->data; | |
597 | g_free(o->id); | |
598 | g_free(o->desc); | |
599 | g_variant_unref(o->def); | |
600 | g_free(o); | |
601 | } | |
602 | g_slist_free(dec->options); | |
603 | ||
fa12a21e | 604 | free_probes(dec->probes); |
dcdf4883 | 605 | free_probes(dec->opt_probes); |
b2c19614 BV |
606 | g_free(dec->id); |
607 | g_free(dec->name); | |
b231546d | 608 | g_free(dec->longname); |
b2c19614 | 609 | g_free(dec->desc); |
b231546d | 610 | g_free(dec->license); |
b2c19614 | 611 | |
fa12a21e | 612 | /* The module's Decoder class. */ |
451680f1 | 613 | Py_XDECREF(dec->py_dec); |
fa12a21e | 614 | /* The module itself. */ |
b2c19614 BV |
615 | Py_XDECREF(dec->py_mod); |
616 | ||
e592ac89 | 617 | g_free(dec); |
b2c19614 BV |
618 | |
619 | return SRD_OK; | |
620 | } | |
621 | ||
ea81b49a BV |
622 | static void srd_decoder_load_all_path(char *path) |
623 | { | |
624 | GDir *dir; | |
625 | const gchar *direntry; | |
626 | ||
627 | if (!(dir = g_dir_open(path, 0, NULL))) | |
628 | /* Not really fatal */ | |
629 | return; | |
630 | ||
631 | /* This ignores errors returned by srd_decoder_load(). That | |
632 | * function will have logged the cause, but in any case we | |
633 | * want to continue anyway. */ | |
634 | while ((direntry = g_dir_read_name(dir)) != NULL) { | |
635 | /* The directory name is the module name (e.g. "i2c"). */ | |
636 | srd_decoder_load(direntry); | |
637 | } | |
638 | g_dir_close(dir); | |
639 | ||
640 | } | |
641 | ||
582c8473 | 642 | /** |
9b37109d | 643 | * Load all installed protocol decoders. |
582c8473 BV |
644 | * |
645 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
646 | * |
647 | * @since 0.1.0 | |
582c8473 | 648 | */ |
8ad6e500 | 649 | SRD_API int srd_decoder_load_all(void) |
b2c19614 | 650 | { |
ea81b49a | 651 | GSList *l; |
b2c19614 | 652 | |
e195c025 BV |
653 | if (!srd_check_init()) |
654 | return SRD_ERR; | |
655 | ||
ea81b49a BV |
656 | for (l = searchpaths; l; l = l->next) |
657 | srd_decoder_load_all_path(l->data); | |
b2c19614 BV |
658 | |
659 | return SRD_OK; | |
660 | } | |
661 | ||
b2c19614 | 662 | /** |
582c8473 BV |
663 | * Unload all loaded protocol decoders. |
664 | * | |
665 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
666 | * |
667 | * @since 0.1.0 | |
b2c19614 | 668 | */ |
8ad6e500 | 669 | SRD_API int srd_decoder_unload_all(void) |
b2c19614 BV |
670 | { |
671 | GSList *l; | |
672 | struct srd_decoder *dec; | |
673 | ||
38ff5046 | 674 | for (l = pd_list; l; l = l->next) { |
b2c19614 | 675 | dec = l->data; |
9d122fd5 | 676 | srd_decoder_unload(dec); |
b2c19614 | 677 | } |
820bf448 BV |
678 | g_slist_free(pd_list); |
679 | pd_list = NULL; | |
b2c19614 BV |
680 | |
681 | return SRD_OK; | |
682 | } | |
4895418c UH |
683 | |
684 | /** @} */ |