]>
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 | ||
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" | |
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 | ||
c63f5a87 | 42 | /* The list of loaded protocol decoders. */ |
2060510a | 43 | static GSList *pd_list = NULL; |
b2c19614 | 44 | |
ea81b49a | 45 | /* srd.c */ |
23a29d24 | 46 | extern SRD_PRIV GSList *searchpaths; |
ea81b49a BV |
47 | |
48 | /* session.c */ | |
23a29d24 UH |
49 | extern SRD_PRIV GSList *sessions; |
50 | extern SRD_PRIV int max_session_id; | |
32cfb920 | 51 | |
c9bfccc6 | 52 | /* module_sigrokdecode.c */ |
55c3c5f4 | 53 | extern SRD_PRIV PyObject *mod_sigrokdecode; |
451680f1 | 54 | |
57790bc8 UH |
55 | /** @endcond */ |
56 | ||
f6527cc4 UH |
57 | static gboolean srd_check_init(void) |
58 | { | |
59 | if (max_session_id < 0) { | |
60 | srd_err("Library is not initialized."); | |
61 | return FALSE; | |
62 | } else | |
63 | return TRUE; | |
64 | } | |
65 | ||
b2c19614 | 66 | /** |
c63f5a87 | 67 | * Returns the list of loaded protocol decoders. |
b2c19614 | 68 | * |
3a1501e9 | 69 | * This is a GSList of pointers to struct srd_decoder items. |
b2c19614 BV |
70 | * |
71 | * @return List of decoders, NULL if none are supported or loaded. | |
8c664ca2 | 72 | * |
c57d1013 | 73 | * @since 0.2.0 |
b2c19614 | 74 | */ |
38ff5046 | 75 | SRD_API const GSList *srd_decoder_list(void) |
b2c19614 | 76 | { |
e5080882 | 77 | return pd_list; |
b2c19614 BV |
78 | } |
79 | ||
b2c19614 BV |
80 | /** |
81 | * Get the decoder with the specified ID. | |
82 | * | |
83 | * @param id The ID string of the decoder to return. | |
582c8473 | 84 | * |
b2c19614 | 85 | * @return The decoder with the specified ID, or NULL if not found. |
8c664ca2 UH |
86 | * |
87 | * @since 0.1.0 | |
b2c19614 | 88 | */ |
9d122fd5 | 89 | SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id) |
b2c19614 BV |
90 | { |
91 | GSList *l; | |
92 | struct srd_decoder *dec; | |
93 | ||
38ff5046 | 94 | for (l = pd_list; l; l = l->next) { |
b2c19614 BV |
95 | dec = l->data; |
96 | if (!strcmp(dec->id, id)) | |
97 | return dec; | |
98 | } | |
99 | ||
100 | return NULL; | |
101 | } | |
102 | ||
6d67d057 DE |
103 | static void channel_free(void *data) |
104 | { | |
105 | struct srd_channel *ch = data; | |
106 | ||
107 | if (!ch) | |
108 | return; | |
109 | ||
110 | g_free(ch->desc); | |
111 | g_free(ch->name); | |
112 | g_free(ch->id); | |
113 | g_free(ch); | |
114 | } | |
115 | ||
116 | static void variant_free(void *data) | |
117 | { | |
118 | GVariant *var = data; | |
119 | ||
120 | if (!var) | |
121 | return; | |
122 | ||
123 | g_variant_unref(var); | |
124 | } | |
125 | ||
126 | static void annotation_row_free(void *data) | |
127 | { | |
128 | struct srd_decoder_annotation_row *row = data; | |
129 | ||
130 | if (!row) | |
131 | return; | |
132 | ||
133 | g_slist_free(row->ann_classes); | |
134 | g_free(row->desc); | |
135 | g_free(row->id); | |
136 | g_free(row); | |
137 | } | |
138 | ||
ddcde186 UH |
139 | static void logic_output_channel_free(void *data) |
140 | { | |
141 | struct srd_decoder_logic_output_channel *logic_out_ch = data; | |
142 | ||
143 | if (!logic_out_ch) | |
144 | return; | |
145 | ||
146 | g_free(logic_out_ch->desc); | |
147 | g_free(logic_out_ch->id); | |
148 | g_free(logic_out_ch); | |
149 | } | |
150 | ||
6d67d057 DE |
151 | static void decoder_option_free(void *data) |
152 | { | |
153 | struct srd_decoder_option *opt = data; | |
154 | ||
155 | if (!opt) | |
156 | return; | |
157 | ||
158 | g_slist_free_full(opt->values, &variant_free); | |
159 | variant_free(opt->def); | |
160 | g_free(opt->desc); | |
161 | g_free(opt->id); | |
162 | g_free(opt); | |
163 | } | |
164 | ||
165 | static void decoder_free(struct srd_decoder *dec) | |
166 | { | |
514b2edc UH |
167 | PyGILState_STATE gstate; |
168 | ||
6d67d057 DE |
169 | if (!dec) |
170 | return; | |
171 | ||
514b2edc | 172 | gstate = PyGILState_Ensure(); |
6d67d057 DE |
173 | Py_XDECREF(dec->py_dec); |
174 | Py_XDECREF(dec->py_mod); | |
514b2edc | 175 | PyGILState_Release(gstate); |
6d67d057 DE |
176 | |
177 | g_slist_free_full(dec->options, &decoder_option_free); | |
178 | g_slist_free_full(dec->binary, (GDestroyNotify)&g_strfreev); | |
179 | g_slist_free_full(dec->annotation_rows, &annotation_row_free); | |
180 | g_slist_free_full(dec->annotations, (GDestroyNotify)&g_strfreev); | |
181 | g_slist_free_full(dec->opt_channels, &channel_free); | |
182 | g_slist_free_full(dec->channels, &channel_free); | |
183 | ||
d480174d UH |
184 | g_slist_free_full(dec->outputs, g_free); |
185 | g_slist_free_full(dec->inputs, g_free); | |
4c180223 | 186 | g_slist_free_full(dec->tags, g_free); |
6d67d057 DE |
187 | g_free(dec->license); |
188 | g_free(dec->desc); | |
189 | g_free(dec->longname); | |
190 | g_free(dec->name); | |
191 | g_free(dec->id); | |
192 | ||
193 | g_free(dec); | |
194 | } | |
195 | ||
6a15597a | 196 | static int get_channels(const struct srd_decoder *d, const char *attr, |
6d67d057 | 197 | GSList **out_pdchl, int offset) |
f38ec285 | 198 | { |
6a15597a UH |
199 | PyObject *py_channellist, *py_entry; |
200 | struct srd_channel *pdch; | |
6d67d057 DE |
201 | GSList *pdchl; |
202 | ssize_t i; | |
514b2edc UH |
203 | PyGILState_STATE gstate; |
204 | ||
205 | gstate = PyGILState_Ensure(); | |
f38ec285 | 206 | |
514b2edc | 207 | if (!PyObject_HasAttrString(d->py_dec, attr)) { |
6a15597a | 208 | /* No channels of this type specified. */ |
514b2edc | 209 | PyGILState_Release(gstate); |
f38ec285 | 210 | return SRD_OK; |
514b2edc | 211 | } |
f38ec285 | 212 | |
6d67d057 DE |
213 | pdchl = NULL; |
214 | ||
6a15597a | 215 | py_channellist = PyObject_GetAttrString(d->py_dec, attr); |
6d67d057 DE |
216 | if (!py_channellist) |
217 | goto except_out; | |
218 | ||
6a15597a | 219 | if (!PyTuple_Check(py_channellist)) { |
da9bcbd9 | 220 | srd_err("Protocol decoder %s %s attribute is not a tuple.", |
6d67d057 DE |
221 | d->name, attr); |
222 | goto err_out; | |
f38ec285 BV |
223 | } |
224 | ||
6d67d057 | 225 | for (i = PyTuple_Size(py_channellist) - 1; i >= 0; i--) { |
6a15597a | 226 | py_entry = PyTuple_GetItem(py_channellist, i); |
6d67d057 DE |
227 | if (!py_entry) |
228 | goto except_out; | |
229 | ||
f38ec285 BV |
230 | if (!PyDict_Check(py_entry)) { |
231 | srd_err("Protocol decoder %s %s attribute is not " | |
6d67d057 DE |
232 | "a list of dict elements.", d->name, attr); |
233 | goto err_out; | |
f38ec285 | 234 | } |
35c10c0e | 235 | pdch = g_malloc(sizeof(struct srd_channel)); |
6d67d057 DE |
236 | /* Add to list right away so it doesn't get lost. */ |
237 | pdchl = g_slist_prepend(pdchl, pdch); | |
f38ec285 | 238 | |
6d67d057 DE |
239 | if (py_dictitem_as_str(py_entry, "id", &pdch->id) != SRD_OK) |
240 | goto err_out; | |
241 | if (py_dictitem_as_str(py_entry, "name", &pdch->name) != SRD_OK) | |
242 | goto err_out; | |
243 | if (py_dictitem_as_str(py_entry, "desc", &pdch->desc) != SRD_OK) | |
244 | goto err_out; | |
f38ec285 | 245 | |
6d67d057 | 246 | pdch->order = offset + i; |
f38ec285 | 247 | } |
f38ec285 | 248 | |
6d67d057 DE |
249 | Py_DECREF(py_channellist); |
250 | *out_pdchl = pdchl; | |
251 | ||
514b2edc UH |
252 | PyGILState_Release(gstate); |
253 | ||
6d67d057 | 254 | return SRD_OK; |
f38ec285 | 255 | |
6d67d057 DE |
256 | except_out: |
257 | srd_exception_catch("Failed to get %s list of %s decoder", | |
258 | attr, d->name); | |
7969d803 | 259 | |
6d67d057 DE |
260 | err_out: |
261 | g_slist_free_full(pdchl, &channel_free); | |
262 | Py_XDECREF(py_channellist); | |
514b2edc | 263 | PyGILState_Release(gstate); |
6d67d057 DE |
264 | |
265 | return SRD_ERR_PYTHON; | |
f38ec285 BV |
266 | } |
267 | ||
2f395bff BV |
268 | static int get_options(struct srd_decoder *d) |
269 | { | |
6d67d057 DE |
270 | PyObject *py_opts, *py_opt, *py_str, *py_values, *py_default, *py_item; |
271 | GSList *options; | |
2f395bff | 272 | struct srd_decoder_option *o; |
84c1c0b5 | 273 | GVariant *gvar; |
6d67d057 | 274 | ssize_t opt, i; |
514b2edc | 275 | PyGILState_STATE gstate; |
2f395bff | 276 | |
514b2edc UH |
277 | gstate = PyGILState_Ensure(); |
278 | ||
279 | if (!PyObject_HasAttrString(d->py_dec, "options")) { | |
84c1c0b5 | 280 | /* No options, that's fine. */ |
514b2edc | 281 | PyGILState_Release(gstate); |
2f395bff | 282 | return SRD_OK; |
514b2edc | 283 | } |
2f395bff | 284 | |
6d67d057 DE |
285 | options = NULL; |
286 | ||
84c1c0b5 | 287 | /* If present, options must be a tuple. */ |
2f395bff | 288 | py_opts = PyObject_GetAttrString(d->py_dec, "options"); |
6d67d057 DE |
289 | if (!py_opts) |
290 | goto except_out; | |
291 | ||
84c1c0b5 BV |
292 | if (!PyTuple_Check(py_opts)) { |
293 | srd_err("Protocol decoder %s: options attribute is not " | |
294 | "a tuple.", d->id); | |
6d67d057 | 295 | goto err_out; |
2f395bff BV |
296 | } |
297 | ||
6d67d057 | 298 | for (opt = PyTuple_Size(py_opts) - 1; opt >= 0; opt--) { |
84c1c0b5 | 299 | py_opt = PyTuple_GetItem(py_opts, opt); |
6d67d057 DE |
300 | if (!py_opt) |
301 | goto except_out; | |
302 | ||
84c1c0b5 BV |
303 | if (!PyDict_Check(py_opt)) { |
304 | srd_err("Protocol decoder %s options: each option " | |
305 | "must consist of a dictionary.", d->name); | |
6d67d057 | 306 | goto err_out; |
2f395bff | 307 | } |
6d67d057 | 308 | |
84c1c0b5 | 309 | o = g_malloc0(sizeof(struct srd_decoder_option)); |
6d67d057 DE |
310 | /* Add to list right away so it doesn't get lost. */ |
311 | options = g_slist_prepend(options, o); | |
312 | ||
313 | py_str = PyDict_GetItemString(py_opt, "id"); | |
314 | if (!py_str) { | |
fa168be6 | 315 | srd_err("Protocol decoder %s option %zd has no ID.", |
6d67d057 DE |
316 | d->name, opt); |
317 | goto err_out; | |
318 | } | |
319 | if (py_str_as_str(py_str, &o->id) != SRD_OK) | |
320 | goto err_out; | |
321 | ||
322 | py_str = PyDict_GetItemString(py_opt, "desc"); | |
323 | if (py_str) { | |
324 | if (py_str_as_str(py_str, &o->desc) != SRD_OK) | |
325 | goto err_out; | |
326 | } | |
327 | ||
328 | py_default = PyDict_GetItemString(py_opt, "default"); | |
329 | if (py_default) { | |
330 | gvar = py_obj_to_variant(py_default); | |
331 | if (!gvar) { | |
84c1c0b5 | 332 | srd_err("Protocol decoder %s option 'default' has " |
6d67d057 DE |
333 | "invalid default value.", d->name); |
334 | goto err_out; | |
84c1c0b5 | 335 | } |
6d67d057 | 336 | o->def = g_variant_ref_sink(gvar); |
2f395bff | 337 | } |
84c1c0b5 | 338 | |
6d67d057 DE |
339 | py_values = PyDict_GetItemString(py_opt, "values"); |
340 | if (py_values) { | |
7969d803 UH |
341 | /* |
342 | * A default is required if a list of values is | |
343 | * given, since it's used to verify their type. | |
344 | */ | |
84c1c0b5 | 345 | if (!o->def) { |
6d67d057 DE |
346 | srd_err("No default for option '%s'.", o->id); |
347 | goto err_out; | |
84c1c0b5 | 348 | } |
6d67d057 | 349 | if (!PyTuple_Check(py_values)) { |
84c1c0b5 | 350 | srd_err("Option '%s' values should be a tuple.", o->id); |
6d67d057 | 351 | goto err_out; |
84c1c0b5 | 352 | } |
6d67d057 DE |
353 | |
354 | for (i = PyTuple_Size(py_values) - 1; i >= 0; i--) { | |
355 | py_item = PyTuple_GetItem(py_values, i); | |
356 | if (!py_item) | |
357 | goto except_out; | |
358 | ||
2d661bcb | 359 | if (py_default && (Py_TYPE(py_default) != Py_TYPE(py_item))) { |
84c1c0b5 | 360 | srd_err("All values for option '%s' must be " |
6d67d057 DE |
361 | "of the same type as the default.", |
362 | o->id); | |
363 | goto err_out; | |
84c1c0b5 | 364 | } |
6d67d057 DE |
365 | gvar = py_obj_to_variant(py_item); |
366 | if (!gvar) { | |
367 | srd_err("Protocol decoder %s option 'values' " | |
368 | "contains invalid value.", d->name); | |
369 | goto err_out; | |
84c1c0b5 | 370 | } |
6d67d057 DE |
371 | o->values = g_slist_prepend(o->values, |
372 | g_variant_ref_sink(gvar)); | |
2f395bff | 373 | } |
2f395bff | 374 | } |
6d67d057 DE |
375 | } |
376 | d->options = options; | |
377 | Py_DECREF(py_opts); | |
514b2edc | 378 | PyGILState_Release(gstate); |
6d67d057 DE |
379 | |
380 | return SRD_OK; | |
381 | ||
382 | except_out: | |
383 | srd_exception_catch("Failed to get %s decoder options", d->name); | |
7969d803 | 384 | |
6d67d057 DE |
385 | err_out: |
386 | g_slist_free_full(options, &decoder_option_free); | |
387 | Py_XDECREF(py_opts); | |
514b2edc | 388 | PyGILState_Release(gstate); |
6d67d057 DE |
389 | |
390 | return SRD_ERR_PYTHON; | |
391 | } | |
392 | ||
7969d803 | 393 | /* Convert annotation class attribute to GSList of char **. */ |
6d67d057 DE |
394 | static int get_annotations(struct srd_decoder *dec) |
395 | { | |
396 | PyObject *py_annlist, *py_ann; | |
397 | GSList *annotations; | |
398 | char **annpair; | |
399 | ssize_t i; | |
514b2edc UH |
400 | PyGILState_STATE gstate; |
401 | ||
402 | gstate = PyGILState_Ensure(); | |
6d67d057 | 403 | |
514b2edc UH |
404 | if (!PyObject_HasAttrString(dec->py_dec, "annotations")) { |
405 | PyGILState_Release(gstate); | |
6d67d057 | 406 | return SRD_OK; |
514b2edc | 407 | } |
6d67d057 DE |
408 | |
409 | annotations = NULL; | |
410 | ||
411 | py_annlist = PyObject_GetAttrString(dec->py_dec, "annotations"); | |
412 | if (!py_annlist) | |
413 | goto except_out; | |
414 | ||
415 | if (!PyTuple_Check(py_annlist)) { | |
fdb1a907 GS |
416 | srd_err("Protocol decoder %s annotations should be a tuple.", |
417 | dec->name); | |
6d67d057 DE |
418 | goto err_out; |
419 | } | |
420 | ||
421 | for (i = PyTuple_Size(py_annlist) - 1; i >= 0; i--) { | |
422 | py_ann = PyTuple_GetItem(py_annlist, i); | |
423 | if (!py_ann) | |
424 | goto except_out; | |
425 | ||
426 | if (!PyTuple_Check(py_ann) || PyTuple_Size(py_ann) != 2) { | |
fdb1a907 | 427 | srd_err("Protocol decoder %s annotation %zd should be a tuple with two elements.", |
6d67d057 DE |
428 | dec->name, i + 1); |
429 | goto err_out; | |
430 | } | |
431 | if (py_strseq_to_char(py_ann, &annpair) != SRD_OK) | |
432 | goto err_out; | |
433 | ||
434 | annotations = g_slist_prepend(annotations, annpair); | |
435 | } | |
436 | dec->annotations = annotations; | |
437 | Py_DECREF(py_annlist); | |
514b2edc | 438 | PyGILState_Release(gstate); |
6d67d057 DE |
439 | |
440 | return SRD_OK; | |
441 | ||
442 | except_out: | |
443 | srd_exception_catch("Failed to get %s decoder annotations", dec->name); | |
7969d803 | 444 | |
6d67d057 DE |
445 | err_out: |
446 | g_slist_free_full(annotations, (GDestroyNotify)&g_strfreev); | |
447 | Py_XDECREF(py_annlist); | |
514b2edc | 448 | PyGILState_Release(gstate); |
6d67d057 DE |
449 | |
450 | return SRD_ERR_PYTHON; | |
451 | } | |
452 | ||
7969d803 | 453 | /* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */ |
6d67d057 DE |
454 | static int get_annotation_rows(struct srd_decoder *dec) |
455 | { | |
fdb1a907 GS |
456 | const char *py_member_name = "annotation_rows"; |
457 | ||
6d67d057 DE |
458 | PyObject *py_ann_rows, *py_ann_row, *py_ann_classes, *py_item; |
459 | GSList *annotation_rows; | |
460 | struct srd_decoder_annotation_row *ann_row; | |
461 | ssize_t i, k; | |
462 | size_t class_idx; | |
514b2edc UH |
463 | PyGILState_STATE gstate; |
464 | ||
465 | gstate = PyGILState_Ensure(); | |
6d67d057 | 466 | |
fdb1a907 | 467 | if (!PyObject_HasAttrString(dec->py_dec, py_member_name)) { |
514b2edc | 468 | PyGILState_Release(gstate); |
6d67d057 | 469 | return SRD_OK; |
514b2edc | 470 | } |
6d67d057 DE |
471 | |
472 | annotation_rows = NULL; | |
473 | ||
fdb1a907 | 474 | py_ann_rows = PyObject_GetAttrString(dec->py_dec, py_member_name); |
6d67d057 DE |
475 | if (!py_ann_rows) |
476 | goto except_out; | |
477 | ||
478 | if (!PyTuple_Check(py_ann_rows)) { | |
fdb1a907 GS |
479 | srd_err("Protocol decoder %s %s must be a tuple.", |
480 | dec->name, py_member_name); | |
6d67d057 DE |
481 | goto err_out; |
482 | } | |
483 | ||
484 | for (i = PyTuple_Size(py_ann_rows) - 1; i >= 0; i--) { | |
485 | py_ann_row = PyTuple_GetItem(py_ann_rows, i); | |
486 | if (!py_ann_row) | |
487 | goto except_out; | |
488 | ||
489 | if (!PyTuple_Check(py_ann_row) || PyTuple_Size(py_ann_row) != 3) { | |
fdb1a907 GS |
490 | srd_err("Protocol decoder %s %s must contain only tuples of 3 elements.", |
491 | dec->name, py_member_name); | |
6d67d057 DE |
492 | goto err_out; |
493 | } | |
494 | ann_row = g_malloc0(sizeof(struct srd_decoder_annotation_row)); | |
495 | /* Add to list right away so it doesn't get lost. */ | |
496 | annotation_rows = g_slist_prepend(annotation_rows, ann_row); | |
497 | ||
498 | py_item = PyTuple_GetItem(py_ann_row, 0); | |
499 | if (!py_item) | |
500 | goto except_out; | |
501 | if (py_str_as_str(py_item, &ann_row->id) != SRD_OK) | |
502 | goto err_out; | |
503 | ||
504 | py_item = PyTuple_GetItem(py_ann_row, 1); | |
505 | if (!py_item) | |
506 | goto except_out; | |
507 | if (py_str_as_str(py_item, &ann_row->desc) != SRD_OK) | |
508 | goto err_out; | |
509 | ||
510 | py_ann_classes = PyTuple_GetItem(py_ann_row, 2); | |
511 | if (!py_ann_classes) | |
512 | goto except_out; | |
513 | ||
514 | if (!PyTuple_Check(py_ann_classes)) { | |
fdb1a907 GS |
515 | srd_err("Protocol decoder %s %s tuples must have a tuple of numbers as 3rd element.", |
516 | dec->name, py_member_name); | |
6d67d057 DE |
517 | goto err_out; |
518 | } | |
519 | ||
520 | for (k = PyTuple_Size(py_ann_classes) - 1; k >= 0; k--) { | |
521 | py_item = PyTuple_GetItem(py_ann_classes, k); | |
522 | if (!py_item) | |
523 | goto except_out; | |
524 | ||
525 | if (!PyLong_Check(py_item)) { | |
fdb1a907 | 526 | srd_err("Protocol decoder %s annotation row class tuple must only contain numbers.", |
6d67d057 DE |
527 | dec->name); |
528 | goto err_out; | |
529 | } | |
530 | class_idx = PyLong_AsSize_t(py_item); | |
531 | if (PyErr_Occurred()) | |
532 | goto except_out; | |
533 | ||
534 | ann_row->ann_classes = g_slist_prepend(ann_row->ann_classes, | |
535 | GSIZE_TO_POINTER(class_idx)); | |
536 | } | |
537 | } | |
538 | dec->annotation_rows = annotation_rows; | |
539 | Py_DECREF(py_ann_rows); | |
514b2edc | 540 | PyGILState_Release(gstate); |
6d67d057 DE |
541 | |
542 | return SRD_OK; | |
543 | ||
544 | except_out: | |
545 | srd_exception_catch("Failed to get %s decoder annotation rows", | |
546 | dec->name); | |
7969d803 | 547 | |
6d67d057 DE |
548 | err_out: |
549 | g_slist_free_full(annotation_rows, &annotation_row_free); | |
550 | Py_XDECREF(py_ann_rows); | |
514b2edc | 551 | PyGILState_Release(gstate); |
6d67d057 DE |
552 | |
553 | return SRD_ERR_PYTHON; | |
554 | } | |
555 | ||
7969d803 | 556 | /* Convert binary classes to GSList of char **. */ |
6d67d057 DE |
557 | static int get_binary_classes(struct srd_decoder *dec) |
558 | { | |
559 | PyObject *py_bin_classes, *py_bin_class; | |
560 | GSList *bin_classes; | |
561 | char **bin; | |
562 | ssize_t i; | |
514b2edc | 563 | PyGILState_STATE gstate; |
6d67d057 | 564 | |
514b2edc UH |
565 | gstate = PyGILState_Ensure(); |
566 | ||
567 | if (!PyObject_HasAttrString(dec->py_dec, "binary")) { | |
568 | PyGILState_Release(gstate); | |
6d67d057 | 569 | return SRD_OK; |
514b2edc | 570 | } |
6d67d057 DE |
571 | |
572 | bin_classes = NULL; | |
573 | ||
574 | py_bin_classes = PyObject_GetAttrString(dec->py_dec, "binary"); | |
575 | if (!py_bin_classes) | |
576 | goto except_out; | |
577 | ||
578 | if (!PyTuple_Check(py_bin_classes)) { | |
579 | srd_err("Protocol decoder %s binary classes should " | |
580 | "be a tuple.", dec->name); | |
581 | goto err_out; | |
582 | } | |
583 | ||
584 | for (i = PyTuple_Size(py_bin_classes) - 1; i >= 0; i--) { | |
585 | py_bin_class = PyTuple_GetItem(py_bin_classes, i); | |
586 | if (!py_bin_class) | |
587 | goto except_out; | |
588 | ||
589 | if (!PyTuple_Check(py_bin_class) | |
590 | || PyTuple_Size(py_bin_class) != 2) { | |
591 | srd_err("Protocol decoder %s binary classes should " | |
592 | "consist only of tuples of 2 elements.", | |
593 | dec->name); | |
594 | goto err_out; | |
595 | } | |
596 | if (py_strseq_to_char(py_bin_class, &bin) != SRD_OK) | |
597 | goto err_out; | |
598 | ||
599 | bin_classes = g_slist_prepend(bin_classes, bin); | |
600 | } | |
601 | dec->binary = bin_classes; | |
602 | Py_DECREF(py_bin_classes); | |
514b2edc | 603 | PyGILState_Release(gstate); |
6d67d057 DE |
604 | |
605 | return SRD_OK; | |
606 | ||
607 | except_out: | |
608 | srd_exception_catch("Failed to get %s decoder binary classes", | |
609 | dec->name); | |
7969d803 | 610 | |
6d67d057 DE |
611 | err_out: |
612 | g_slist_free_full(bin_classes, (GDestroyNotify)&g_strfreev); | |
613 | Py_XDECREF(py_bin_classes); | |
514b2edc | 614 | PyGILState_Release(gstate); |
6d67d057 DE |
615 | |
616 | return SRD_ERR_PYTHON; | |
617 | } | |
618 | ||
ddcde186 UH |
619 | /* Convert logic_output_channels to GSList of 'struct srd_decoder_logic_output_channel'. */ |
620 | static int get_logic_output_channels(struct srd_decoder *dec) | |
621 | { | |
460e6cfa | 622 | PyObject *py_logic_out_chs, *py_logic_out_ch, *py_item; |
ddcde186 UH |
623 | GSList *logic_out_chs; |
624 | struct srd_decoder_logic_output_channel *logic_out_ch; | |
625 | ssize_t i; | |
626 | PyGILState_STATE gstate; | |
627 | ||
628 | gstate = PyGILState_Ensure(); | |
629 | ||
630 | if (!PyObject_HasAttrString(dec->py_dec, "logic_output_channels")) { | |
631 | PyGILState_Release(gstate); | |
632 | return SRD_OK; | |
633 | } | |
634 | ||
635 | logic_out_chs = NULL; | |
636 | ||
637 | py_logic_out_chs = PyObject_GetAttrString(dec->py_dec, "logic_output_channels"); | |
638 | if (!py_logic_out_chs) | |
639 | goto except_out; | |
640 | ||
641 | if (!PyTuple_Check(py_logic_out_chs)) { | |
642 | srd_err("Protocol decoder %s logic_output_channels " | |
643 | "must be a tuple.", dec->name); | |
644 | goto err_out; | |
645 | } | |
646 | ||
647 | for (i = PyTuple_Size(py_logic_out_chs) - 1; i >= 0; i--) { | |
648 | py_logic_out_ch = PyTuple_GetItem(py_logic_out_chs, i); | |
649 | if (!py_logic_out_ch) | |
650 | goto except_out; | |
651 | ||
460e6cfa | 652 | if (!PyTuple_Check(py_logic_out_ch) || PyTuple_Size(py_logic_out_ch) != 2) { |
ddcde186 | 653 | srd_err("Protocol decoder %s logic_output_channels " |
460e6cfa | 654 | "must contain only tuples of 2 elements.", |
ddcde186 UH |
655 | dec->name); |
656 | goto err_out; | |
657 | } | |
658 | logic_out_ch = g_malloc0(sizeof(*logic_out_ch)); | |
659 | /* Add to list right away so it doesn't get lost. */ | |
660 | logic_out_chs = g_slist_prepend(logic_out_chs, logic_out_ch); | |
661 | ||
662 | py_item = PyTuple_GetItem(py_logic_out_ch, 0); | |
663 | if (!py_item) | |
664 | goto except_out; | |
665 | if (py_str_as_str(py_item, &logic_out_ch->id) != SRD_OK) | |
666 | goto err_out; | |
667 | ||
668 | py_item = PyTuple_GetItem(py_logic_out_ch, 1); | |
669 | if (!py_item) | |
670 | goto except_out; | |
671 | if (py_str_as_str(py_item, &logic_out_ch->desc) != SRD_OK) | |
672 | goto err_out; | |
ddcde186 UH |
673 | } |
674 | dec->logic_output_channels = logic_out_chs; | |
675 | Py_DECREF(py_logic_out_chs); | |
676 | PyGILState_Release(gstate); | |
677 | ||
678 | return SRD_OK; | |
679 | ||
680 | except_out: | |
681 | srd_exception_catch("Failed to get %s decoder logic output channels", | |
682 | dec->name); | |
683 | ||
684 | err_out: | |
685 | g_slist_free_full(logic_out_chs, &logic_output_channel_free); | |
686 | Py_XDECREF(py_logic_out_chs); | |
687 | PyGILState_Release(gstate); | |
688 | ||
689 | return SRD_ERR_PYTHON; | |
690 | } | |
691 | ||
7969d803 | 692 | /* Check whether the Decoder class defines the named method. */ |
6d67d057 DE |
693 | static int check_method(PyObject *py_dec, const char *mod_name, |
694 | const char *method_name) | |
695 | { | |
696 | PyObject *py_method; | |
697 | int is_callable; | |
514b2edc UH |
698 | PyGILState_STATE gstate; |
699 | ||
700 | gstate = PyGILState_Ensure(); | |
6d67d057 DE |
701 | |
702 | py_method = PyObject_GetAttrString(py_dec, method_name); | |
703 | if (!py_method) { | |
704 | srd_exception_catch("Protocol decoder %s Decoder class " | |
705 | "has no %s() method", mod_name, method_name); | |
514b2edc | 706 | PyGILState_Release(gstate); |
6d67d057 DE |
707 | return SRD_ERR_PYTHON; |
708 | } | |
709 | ||
710 | is_callable = PyCallable_Check(py_method); | |
711 | Py_DECREF(py_method); | |
712 | ||
514b2edc UH |
713 | PyGILState_Release(gstate); |
714 | ||
6d67d057 DE |
715 | if (!is_callable) { |
716 | srd_err("Protocol decoder %s Decoder class attribute '%s' " | |
717 | "is not a method.", mod_name, method_name); | |
718 | return SRD_ERR_PYTHON; | |
2f395bff | 719 | } |
2f395bff | 720 | |
84c1c0b5 | 721 | return SRD_OK; |
2f395bff BV |
722 | } |
723 | ||
40589f25 UH |
724 | /** |
725 | * Get the API version of the specified decoder. | |
726 | * | |
727 | * @param d The decoder to use. Must not be NULL. | |
728 | * | |
729 | * @return The API version of the decoder, or 0 upon errors. | |
c947ab01 UH |
730 | * |
731 | * @private | |
40589f25 UH |
732 | */ |
733 | SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d) | |
734 | { | |
735 | PyObject *py_apiver; | |
736 | long apiver; | |
514b2edc | 737 | PyGILState_STATE gstate; |
40589f25 UH |
738 | |
739 | if (!d) | |
740 | return 0; | |
741 | ||
514b2edc UH |
742 | gstate = PyGILState_Ensure(); |
743 | ||
40589f25 UH |
744 | py_apiver = PyObject_GetAttrString(d->py_dec, "api_version"); |
745 | apiver = (py_apiver && PyLong_Check(py_apiver)) | |
746 | ? PyLong_AsLong(py_apiver) : 0; | |
747 | Py_XDECREF(py_apiver); | |
748 | ||
514b2edc UH |
749 | PyGILState_Release(gstate); |
750 | ||
40589f25 UH |
751 | return apiver; |
752 | } | |
753 | ||
1734f4c2 UH |
754 | static gboolean contains_duplicates(GSList *list) |
755 | { | |
756 | for (GSList *l1 = list; l1; l1 = l1->next) { | |
757 | for (GSList *l2 = l1->next; l2; l2 = l2->next) | |
758 | if (!strcmp(l1->data, l2->data)) | |
759 | return TRUE; | |
760 | } | |
761 | ||
762 | return FALSE; | |
763 | } | |
764 | ||
765 | static gboolean contains_duplicate_ids(GSList *list1, GSList *list2) | |
766 | { | |
767 | for (GSList *l1 = list1; l1; l1 = l1->next) { | |
768 | unsigned int cnt = 0; | |
769 | const char **s1 = l1->data; | |
770 | for (GSList *l2 = list2; l2; l2 = l2->next) { | |
771 | const char **s2 = l2->data; | |
772 | if (!strcmp(s1[0], s2[0])) | |
773 | cnt++; | |
774 | if ((list1 == list2) && cnt > 1) | |
775 | return TRUE; | |
776 | if ((list1 != list2) && cnt > 0) | |
777 | return TRUE; | |
778 | } | |
779 | } | |
780 | ||
781 | return FALSE; | |
782 | } | |
783 | ||
784 | static gboolean contains_duplicate_row_ids(GSList *list1, GSList *list2) | |
785 | { | |
786 | for (GSList *l1 = list1; l1; l1 = l1->next) { | |
787 | unsigned int cnt = 0; | |
788 | const struct srd_decoder_annotation_row *r1 = l1->data; | |
789 | for (GSList *l2 = list2; l2; l2 = l2->next) { | |
790 | const struct srd_decoder_annotation_row *r2 = l2->data; | |
791 | if (!strcmp(r1->id, r2->id)) | |
792 | cnt++; | |
793 | if (cnt > 1) | |
794 | return TRUE; | |
795 | } | |
796 | } | |
797 | ||
798 | return FALSE; | |
799 | } | |
800 | ||
b2c19614 | 801 | /** |
64c29e28 | 802 | * Load a protocol decoder module into the embedded Python interpreter. |
b2c19614 | 803 | * |
38ff5046 | 804 | * @param module_name The module name to be loaded. |
b2c19614 BV |
805 | * |
806 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
807 | * |
808 | * @since 0.1.0 | |
b2c19614 | 809 | */ |
9d122fd5 | 810 | SRD_API int srd_decoder_load(const char *module_name) |
b2c19614 | 811 | { |
40589f25 | 812 | PyObject *py_basedec; |
b2c19614 | 813 | struct srd_decoder *d; |
6d67d057 DE |
814 | long apiver; |
815 | int is_subclass; | |
60697682 | 816 | const char *fail_txt; |
514b2edc | 817 | PyGILState_STATE gstate; |
b2c19614 | 818 | |
e195c025 BV |
819 | if (!srd_check_init()) |
820 | return SRD_ERR; | |
821 | ||
8a014683 BV |
822 | if (!module_name) |
823 | return SRD_ERR_ARG; | |
824 | ||
514b2edc UH |
825 | gstate = PyGILState_Ensure(); |
826 | ||
aac68131 BV |
827 | if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) { |
828 | /* Module was already imported. */ | |
514b2edc | 829 | PyGILState_Release(gstate); |
aac68131 BV |
830 | return SRD_OK; |
831 | } | |
832 | ||
077fa8ac | 833 | d = g_malloc0(sizeof(struct srd_decoder)); |
60697682 | 834 | fail_txt = NULL; |
b2c19614 | 835 | |
e9dd2fea | 836 | d->py_mod = py_import_by_name(module_name); |
60697682 GS |
837 | if (!d->py_mod) { |
838 | fail_txt = "import by name failed"; | |
6d67d057 | 839 | goto except_out; |
60697682 | 840 | } |
6d67d057 DE |
841 | |
842 | if (!mod_sigrokdecode) { | |
843 | srd_err("sigrokdecode module not loaded."); | |
60697682 | 844 | fail_txt = "sigrokdecode(3) not loaded"; |
451680f1 BV |
845 | goto err_out; |
846 | } | |
b2c19614 | 847 | |
451680f1 | 848 | /* Get the 'Decoder' class as Python object. */ |
6d67d057 | 849 | d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"); |
60697682 GS |
850 | if (!d->py_dec) { |
851 | fail_txt = "no 'Decoder' attribute in imported module"; | |
6d67d057 | 852 | goto except_out; |
60697682 | 853 | } |
b2c19614 | 854 | |
6d67d057 | 855 | py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"); |
60697682 GS |
856 | if (!py_basedec) { |
857 | fail_txt = "no 'Decoder' attribute in sigrokdecode(3)"; | |
6d67d057 | 858 | goto except_out; |
60697682 | 859 | } |
6d67d057 DE |
860 | |
861 | is_subclass = PyObject_IsSubclass(d->py_dec, py_basedec); | |
862 | Py_DECREF(py_basedec); | |
b2c19614 | 863 | |
6d67d057 | 864 | if (!is_subclass) { |
451680f1 | 865 | srd_err("Decoder class in protocol decoder module %s is not " |
9b37109d | 866 | "a subclass of sigrokdecode.Decoder.", module_name); |
60697682 | 867 | fail_txt = "not a subclass of sigrokdecode.Decoder"; |
451680f1 BV |
868 | goto err_out; |
869 | } | |
b2c19614 | 870 | |
5c0c9cb3 | 871 | /* |
077fa8ac | 872 | * Check that this decoder has the correct PD API version. |
5c0c9cb3 UH |
873 | * PDs of different API versions are incompatible and cannot work. |
874 | */ | |
40589f25 | 875 | apiver = srd_decoder_apiver(d); |
eb883723 UH |
876 | if (apiver != 3) { |
877 | srd_exception_catch("Only PD API version 3 is supported, " | |
60697682 GS |
878 | "decoder %s has version %ld", module_name, apiver); |
879 | fail_txt = "API version mismatch"; | |
1d552cd3 BV |
880 | goto err_out; |
881 | } | |
1d552cd3 | 882 | |
7969d803 UH |
883 | /* Check Decoder class for required methods. */ |
884 | ||
be760e59 GS |
885 | if (check_method(d->py_dec, module_name, "reset") != SRD_OK) { |
886 | fail_txt = "no 'reset()' method"; | |
887 | goto err_out; | |
888 | } | |
889 | ||
60697682 GS |
890 | if (check_method(d->py_dec, module_name, "start") != SRD_OK) { |
891 | fail_txt = "no 'start()' method"; | |
1d552cd3 | 892 | goto err_out; |
60697682 | 893 | } |
6d67d057 | 894 | |
60697682 GS |
895 | if (check_method(d->py_dec, module_name, "decode") != SRD_OK) { |
896 | fail_txt = "no 'decode()' method"; | |
1d552cd3 | 897 | goto err_out; |
60697682 | 898 | } |
1d552cd3 | 899 | |
84c1c0b5 | 900 | /* Store required fields in newly allocated strings. */ |
60697682 GS |
901 | if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) { |
902 | fail_txt = "no 'id' attribute"; | |
84c1c0b5 | 903 | goto err_out; |
60697682 | 904 | } |
84c1c0b5 | 905 | |
60697682 GS |
906 | if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) { |
907 | fail_txt = "no 'name' attribute"; | |
84c1c0b5 | 908 | goto err_out; |
60697682 | 909 | } |
84c1c0b5 | 910 | |
60697682 GS |
911 | if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) { |
912 | fail_txt = "no 'longname' attribute"; | |
84c1c0b5 | 913 | goto err_out; |
60697682 | 914 | } |
84c1c0b5 | 915 | |
60697682 GS |
916 | if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) { |
917 | fail_txt = "no 'desc' attribute"; | |
84c1c0b5 | 918 | goto err_out; |
60697682 | 919 | } |
84c1c0b5 | 920 | |
60697682 GS |
921 | if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) { |
922 | fail_txt = "no 'license' attribute"; | |
84c1c0b5 | 923 | goto err_out; |
60697682 | 924 | } |
84c1c0b5 | 925 | |
d480174d UH |
926 | if (py_attr_as_strlist(d->py_dec, "inputs", &(d->inputs)) != SRD_OK) { |
927 | fail_txt = "missing or malformed 'inputs' attribute"; | |
928 | goto err_out; | |
929 | } | |
930 | ||
931 | if (py_attr_as_strlist(d->py_dec, "outputs", &(d->outputs)) != SRD_OK) { | |
932 | fail_txt = "missing or malformed 'outputs' attribute"; | |
933 | goto err_out; | |
934 | } | |
935 | ||
4c180223 SA |
936 | if (py_attr_as_strlist(d->py_dec, "tags", &(d->tags)) != SRD_OK) { |
937 | fail_txt = "missing or malformed 'tags' attribute"; | |
938 | goto err_out; | |
939 | } | |
940 | ||
84c1c0b5 | 941 | /* All options and their default values. */ |
60697682 GS |
942 | if (get_options(d) != SRD_OK) { |
943 | fail_txt = "cannot get options"; | |
2f395bff | 944 | goto err_out; |
60697682 | 945 | } |
11ea8ae1 | 946 | |
6a15597a | 947 | /* Check and import required channels. */ |
60697682 GS |
948 | if (get_channels(d, "channels", &d->channels, 0) != SRD_OK) { |
949 | fail_txt = "cannot get channels"; | |
f38ec285 | 950 | goto err_out; |
60697682 | 951 | } |
f38ec285 | 952 | |
6a15597a | 953 | /* Check and import optional channels. */ |
6d67d057 | 954 | if (get_channels(d, "optional_channels", &d->opt_channels, |
60697682 GS |
955 | g_slist_length(d->channels)) != SRD_OK) { |
956 | fail_txt = "cannot get optional channels"; | |
f38ec285 | 957 | goto err_out; |
60697682 | 958 | } |
f38ec285 | 959 | |
60697682 GS |
960 | if (get_annotations(d) != SRD_OK) { |
961 | fail_txt = "cannot get annotations"; | |
6d67d057 | 962 | goto err_out; |
60697682 | 963 | } |
1ce46817 | 964 | |
60697682 GS |
965 | if (get_annotation_rows(d) != SRD_OK) { |
966 | fail_txt = "cannot get annotation rows"; | |
6d67d057 | 967 | goto err_out; |
60697682 | 968 | } |
d75d8a7c | 969 | |
60697682 GS |
970 | if (get_binary_classes(d) != SRD_OK) { |
971 | fail_txt = "cannot get binary classes"; | |
6d67d057 | 972 | goto err_out; |
60697682 | 973 | } |
d75d8a7c | 974 | |
1734f4c2 UH |
975 | if (contains_duplicates(d->inputs)) { |
976 | fail_txt = "duplicate input IDs"; | |
977 | goto err_out; | |
978 | } | |
979 | ||
980 | if (contains_duplicates(d->outputs)) { | |
981 | fail_txt = "duplicate output IDs"; | |
982 | goto err_out; | |
983 | } | |
984 | ||
985 | if (contains_duplicates(d->tags)) { | |
986 | fail_txt = "duplicate tags"; | |
987 | goto err_out; | |
988 | } | |
989 | ||
990 | if (contains_duplicate_ids(d->channels, d->channels)) { | |
991 | fail_txt = "duplicate channel IDs"; | |
992 | goto err_out; | |
993 | } | |
994 | ||
995 | if (contains_duplicate_ids(d->opt_channels, d->opt_channels)) { | |
996 | fail_txt = "duplicate optional channel IDs"; | |
997 | goto err_out; | |
998 | } | |
999 | ||
1000 | if (contains_duplicate_ids(d->channels, d->opt_channels)) { | |
1001 | fail_txt = "channel and optional channel IDs contain duplicates"; | |
1002 | goto err_out; | |
1003 | } | |
1004 | ||
1005 | if (contains_duplicate_ids(d->options, d->options)) { | |
1006 | fail_txt = "duplicate option IDs"; | |
1007 | goto err_out; | |
1008 | } | |
1009 | ||
1010 | if (contains_duplicate_ids(d->annotations, d->annotations)) { | |
1011 | fail_txt = "duplicate annotation class IDs"; | |
1012 | goto err_out; | |
1013 | } | |
1014 | ||
1015 | if (contains_duplicate_row_ids(d->annotation_rows, d->annotation_rows)) { | |
1016 | fail_txt = "duplicate annotation row IDs"; | |
1017 | goto err_out; | |
1018 | } | |
1019 | ||
1020 | if (contains_duplicate_ids(d->annotations, d->annotation_rows)) { | |
1021 | fail_txt = "annotation class/row IDs contain duplicates"; | |
1022 | goto err_out; | |
1023 | } | |
1024 | ||
1025 | if (contains_duplicate_ids(d->binary, d->binary)) { | |
1026 | fail_txt = "duplicate binary class IDs"; | |
1027 | goto err_out; | |
1028 | } | |
1029 | ||
ddcde186 UH |
1030 | if (get_logic_output_channels(d) != SRD_OK) { |
1031 | fail_txt = "cannot get logic output channels"; | |
1032 | goto err_out; | |
1033 | } | |
1034 | ||
514b2edc UH |
1035 | PyGILState_Release(gstate); |
1036 | ||
c63f5a87 | 1037 | /* Append it to the list of loaded decoders. */ |
9b37109d BV |
1038 | pd_list = g_slist_append(pd_list, d); |
1039 | ||
6d67d057 | 1040 | return SRD_OK; |
451680f1 | 1041 | |
6d67d057 | 1042 | except_out: |
e51475ad UH |
1043 | /* Don't show a message for the "common" directory, it's not a PD. */ |
1044 | if (strcmp(module_name, "common")) { | |
1045 | srd_exception_catch("Failed to load decoder %s: %s", | |
1046 | module_name, fail_txt); | |
1047 | } | |
01b60707 | 1048 | fail_txt = NULL; |
7969d803 | 1049 | |
451680f1 | 1050 | err_out: |
60697682 GS |
1051 | if (fail_txt) |
1052 | srd_err("Failed to load decoder %s: %s", module_name, fail_txt); | |
6d67d057 | 1053 | decoder_free(d); |
514b2edc | 1054 | PyGILState_Release(gstate); |
b2c19614 | 1055 | |
6d67d057 | 1056 | return SRD_ERR_PYTHON; |
451680f1 BV |
1057 | } |
1058 | ||
582c8473 BV |
1059 | /** |
1060 | * Return a protocol decoder's docstring. | |
1061 | * | |
f8c24e2e | 1062 | * @param dec The loaded protocol decoder. Must not be NULL. |
582c8473 | 1063 | * |
361fdcaa | 1064 | * @return A newly allocated buffer containing the protocol decoder's |
abeeed8b | 1065 | * documentation. The caller is responsible for free'ing the buffer. |
8c664ca2 UH |
1066 | * |
1067 | * @since 0.1.0 | |
582c8473 | 1068 | */ |
b33b8aa5 | 1069 | SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec) |
451680f1 | 1070 | { |
e7edca07 | 1071 | PyObject *py_str; |
451680f1 | 1072 | char *doc; |
514b2edc | 1073 | PyGILState_STATE gstate; |
451680f1 | 1074 | |
e195c025 BV |
1075 | if (!srd_check_init()) |
1076 | return NULL; | |
1077 | ||
f8c24e2e | 1078 | if (!dec || !dec->py_mod) |
e195c025 BV |
1079 | return NULL; |
1080 | ||
514b2edc UH |
1081 | gstate = PyGILState_Ensure(); |
1082 | ||
e7edca07 | 1083 | if (!PyObject_HasAttrString(dec->py_mod, "__doc__")) |
514b2edc | 1084 | goto err; |
e7edca07 BV |
1085 | |
1086 | if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) { | |
201a85a8 | 1087 | srd_exception_catch("Failed to get docstring"); |
514b2edc | 1088 | goto err; |
e7edca07 BV |
1089 | } |
1090 | ||
451680f1 | 1091 | doc = NULL; |
e7edca07 BV |
1092 | if (py_str != Py_None) |
1093 | py_str_as_str(py_str, &doc); | |
6d67d057 | 1094 | Py_DECREF(py_str); |
451680f1 | 1095 | |
514b2edc UH |
1096 | PyGILState_Release(gstate); |
1097 | ||
451680f1 | 1098 | return doc; |
514b2edc UH |
1099 | |
1100 | err: | |
1101 | PyGILState_Release(gstate); | |
1102 | ||
1103 | return NULL; | |
b2c19614 BV |
1104 | } |
1105 | ||
b2c19614 | 1106 | /** |
4cc0d9fe | 1107 | * Unload the specified protocol decoder. |
451680f1 | 1108 | * |
fa12a21e | 1109 | * @param dec The struct srd_decoder to be unloaded. |
451680f1 BV |
1110 | * |
1111 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
1112 | * |
1113 | * @since 0.1.0 | |
b2c19614 | 1114 | */ |
9d122fd5 | 1115 | SRD_API int srd_decoder_unload(struct srd_decoder *dec) |
b2c19614 | 1116 | { |
32cfb920 | 1117 | struct srd_session *sess; |
2f395bff BV |
1118 | GSList *l; |
1119 | ||
e195c025 BV |
1120 | if (!srd_check_init()) |
1121 | return SRD_ERR; | |
1122 | ||
1123 | if (!dec) | |
1124 | return SRD_ERR_ARG; | |
1125 | ||
361fdcaa UH |
1126 | /* |
1127 | * Since any instances of this decoder need to be released as well, | |
fa12a21e BV |
1128 | * but they could be anywhere in the stack, just free the entire |
1129 | * stack. A frontend reloading a decoder thus has to restart all | |
361fdcaa UH |
1130 | * instances, and rebuild the stack. |
1131 | */ | |
32cfb920 BV |
1132 | for (l = sessions; l; l = l->next) { |
1133 | sess = l->data; | |
3262ef02 | 1134 | srd_inst_free_all(sess); |
32cfb920 | 1135 | } |
fa12a21e | 1136 | |
c63f5a87 UH |
1137 | /* Remove the PD from the list of loaded decoders. */ |
1138 | pd_list = g_slist_remove(pd_list, dec); | |
1139 | ||
6d67d057 | 1140 | decoder_free(dec); |
b2c19614 BV |
1141 | |
1142 | return SRD_OK; | |
1143 | } | |
1144 | ||
1d757906 | 1145 | static void srd_decoder_load_all_zip_path(char *zip_path) |
6a034159 MC |
1146 | { |
1147 | PyObject *zipimport_mod, *zipimporter_class, *zipimporter; | |
1148 | PyObject *prefix_obj, *files, *key, *value, *set, *modname; | |
1149 | Py_ssize_t pos = 0; | |
1150 | char *prefix; | |
1151 | size_t prefix_len; | |
514b2edc | 1152 | PyGILState_STATE gstate; |
6a034159 MC |
1153 | |
1154 | set = files = prefix_obj = zipimporter = zipimporter_class = NULL; | |
1155 | ||
514b2edc UH |
1156 | gstate = PyGILState_Ensure(); |
1157 | ||
e9dd2fea | 1158 | zipimport_mod = py_import_by_name("zipimport"); |
6a034159 MC |
1159 | if (zipimport_mod == NULL) |
1160 | goto err_out; | |
1161 | ||
1162 | zipimporter_class = PyObject_GetAttrString(zipimport_mod, "zipimporter"); | |
1163 | if (zipimporter_class == NULL) | |
1164 | goto err_out; | |
1165 | ||
1d757906 | 1166 | zipimporter = PyObject_CallFunction(zipimporter_class, "s", zip_path); |
6a034159 MC |
1167 | if (zipimporter == NULL) |
1168 | goto err_out; | |
1169 | ||
1170 | prefix_obj = PyObject_GetAttrString(zipimporter, "prefix"); | |
1171 | if (prefix_obj == NULL) | |
1172 | goto err_out; | |
1173 | ||
1174 | files = PyObject_GetAttrString(zipimporter, "_files"); | |
6d67d057 | 1175 | if (files == NULL || !PyDict_Check(files)) |
6a034159 MC |
1176 | goto err_out; |
1177 | ||
1178 | set = PySet_New(NULL); | |
1179 | if (set == NULL) | |
1180 | goto err_out; | |
1181 | ||
1182 | if (py_str_as_str(prefix_obj, &prefix) != SRD_OK) | |
1183 | goto err_out; | |
1184 | ||
1185 | prefix_len = strlen(prefix); | |
1186 | ||
1187 | while (PyDict_Next(files, &pos, &key, &value)) { | |
1188 | char *path, *slash; | |
1189 | if (py_str_as_str(key, &path) == SRD_OK) { | |
6d67d057 DE |
1190 | if (strlen(path) > prefix_len |
1191 | && memcmp(path, prefix, prefix_len) == 0 | |
1192 | && (slash = strchr(path + prefix_len, '/'))) { | |
1193 | ||
1194 | modname = PyUnicode_FromStringAndSize(path + prefix_len, | |
1195 | slash - (path + prefix_len)); | |
6a034159 MC |
1196 | if (modname == NULL) { |
1197 | PyErr_Clear(); | |
1198 | } else { | |
1199 | PySet_Add(set, modname); | |
6d67d057 | 1200 | Py_DECREF(modname); |
6a034159 MC |
1201 | } |
1202 | } | |
6d67d057 | 1203 | g_free(path); |
6a034159 MC |
1204 | } |
1205 | } | |
6d67d057 | 1206 | g_free(prefix); |
6a034159 MC |
1207 | |
1208 | while ((modname = PySet_Pop(set))) { | |
1209 | char *modname_str; | |
1210 | if (py_str_as_str(modname, &modname_str) == SRD_OK) { | |
1211 | /* The directory name is the module name (e.g. "i2c"). */ | |
1212 | srd_decoder_load(modname_str); | |
6d67d057 | 1213 | g_free(modname_str); |
6a034159 | 1214 | } |
6d67d057 | 1215 | Py_DECREF(modname); |
6a034159 MC |
1216 | } |
1217 | ||
1218 | err_out: | |
1219 | Py_XDECREF(set); | |
1220 | Py_XDECREF(files); | |
1221 | Py_XDECREF(prefix_obj); | |
1222 | Py_XDECREF(zipimporter); | |
1223 | Py_XDECREF(zipimporter_class); | |
1224 | Py_XDECREF(zipimport_mod); | |
1225 | PyErr_Clear(); | |
514b2edc | 1226 | PyGILState_Release(gstate); |
6a034159 MC |
1227 | } |
1228 | ||
ea81b49a BV |
1229 | static void srd_decoder_load_all_path(char *path) |
1230 | { | |
1231 | GDir *dir; | |
1232 | const gchar *direntry; | |
1233 | ||
6a034159 | 1234 | if (!(dir = g_dir_open(path, 0, NULL))) { |
7969d803 | 1235 | /* Not really fatal. Try zipimport method too. */ |
6a034159 | 1236 | srd_decoder_load_all_zip_path(path); |
ea81b49a | 1237 | return; |
6a034159 | 1238 | } |
ea81b49a | 1239 | |
7969d803 UH |
1240 | /* |
1241 | * This ignores errors returned by srd_decoder_load(). That | |
ea81b49a | 1242 | * function will have logged the cause, but in any case we |
7969d803 UH |
1243 | * want to continue anyway. |
1244 | */ | |
ea81b49a BV |
1245 | while ((direntry = g_dir_read_name(dir)) != NULL) { |
1246 | /* The directory name is the module name (e.g. "i2c"). */ | |
1247 | srd_decoder_load(direntry); | |
1248 | } | |
1249 | g_dir_close(dir); | |
ea81b49a BV |
1250 | } |
1251 | ||
582c8473 | 1252 | /** |
9b37109d | 1253 | * Load all installed protocol decoders. |
582c8473 BV |
1254 | * |
1255 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
1256 | * |
1257 | * @since 0.1.0 | |
582c8473 | 1258 | */ |
8ad6e500 | 1259 | SRD_API int srd_decoder_load_all(void) |
b2c19614 | 1260 | { |
ea81b49a | 1261 | GSList *l; |
b2c19614 | 1262 | |
e195c025 BV |
1263 | if (!srd_check_init()) |
1264 | return SRD_ERR; | |
1265 | ||
ea81b49a BV |
1266 | for (l = searchpaths; l; l = l->next) |
1267 | srd_decoder_load_all_path(l->data); | |
b2c19614 BV |
1268 | |
1269 | return SRD_OK; | |
1270 | } | |
1271 | ||
611a7340 JB |
1272 | static void srd_decoder_unload_cb(void *arg, void *ignored) |
1273 | { | |
1274 | (void)ignored; | |
1275 | ||
1276 | srd_decoder_unload((struct srd_decoder *)arg); | |
1277 | } | |
1278 | ||
b2c19614 | 1279 | /** |
582c8473 BV |
1280 | * Unload all loaded protocol decoders. |
1281 | * | |
1282 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 UH |
1283 | * |
1284 | * @since 0.1.0 | |
b2c19614 | 1285 | */ |
8ad6e500 | 1286 | SRD_API int srd_decoder_unload_all(void) |
b2c19614 | 1287 | { |
611a7340 | 1288 | g_slist_foreach(pd_list, srd_decoder_unload_cb, NULL); |
820bf448 BV |
1289 | g_slist_free(pd_list); |
1290 | pd_list = NULL; | |
b2c19614 BV |
1291 | |
1292 | return SRD_OK; | |
1293 | } | |
4895418c UH |
1294 | |
1295 | /** @} */ |