2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode.h"
29 * Listing, loading, unloading, and handling protocol decoders.
33 * @defgroup grp_decoder Protocol decoders
35 * Handling protocol decoders.
42 /* The list of loaded protocol decoders. */
43 static GSList *pd_list = NULL;
46 extern SRD_PRIV GSList *searchpaths;
49 extern SRD_PRIV GSList *sessions;
50 extern SRD_PRIV int max_session_id;
52 /* module_sigrokdecode.c */
53 extern SRD_PRIV PyObject *mod_sigrokdecode;
57 static gboolean srd_check_init(void)
59 if (max_session_id < 0) {
60 srd_err("Library is not initialized.");
67 * Returns the list of loaded protocol decoders.
69 * This is a GSList of pointers to struct srd_decoder items.
71 * @return List of decoders, NULL if none are supported or loaded.
75 SRD_API const GSList *srd_decoder_list(void)
81 * Get the decoder with the specified ID.
83 * @param id The ID string of the decoder to return.
85 * @return The decoder with the specified ID, or NULL if not found.
89 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
92 struct srd_decoder *dec;
94 for (l = pd_list; l; l = l->next) {
96 if (!strcmp(dec->id, id))
103 static void channel_free(void *data)
105 struct srd_channel *ch = data;
116 static void variant_free(void *data)
118 GVariant *var = data;
123 g_variant_unref(var);
126 static void annotation_row_free(void *data)
128 struct srd_decoder_annotation_row *row = data;
133 g_slist_free(row->ann_classes);
139 static void logic_output_channel_free(void *data)
141 struct srd_decoder_logic_output_channel *logic_out_ch = data;
146 g_free(logic_out_ch->desc);
147 g_free(logic_out_ch->id);
148 g_free(logic_out_ch);
151 static void decoder_option_free(void *data)
153 struct srd_decoder_option *opt = data;
158 g_slist_free_full(opt->values, &variant_free);
159 variant_free(opt->def);
165 static void decoder_free(struct srd_decoder *dec)
167 PyGILState_STATE gstate;
172 gstate = PyGILState_Ensure();
173 Py_XDECREF(dec->py_dec);
174 Py_XDECREF(dec->py_mod);
175 PyGILState_Release(gstate);
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);
184 g_slist_free_full(dec->outputs, g_free);
185 g_slist_free_full(dec->inputs, g_free);
186 g_slist_free_full(dec->tags, g_free);
187 g_free(dec->license);
189 g_free(dec->longname);
196 static int get_channels(const struct srd_decoder *d, const char *attr,
197 GSList **out_pdchl, int offset)
199 PyObject *py_channellist, *py_entry;
200 struct srd_channel *pdch;
203 PyGILState_STATE gstate;
205 gstate = PyGILState_Ensure();
207 if (!PyObject_HasAttrString(d->py_dec, attr)) {
208 /* No channels of this type specified. */
209 PyGILState_Release(gstate);
215 py_channellist = PyObject_GetAttrString(d->py_dec, attr);
219 if (!PyTuple_Check(py_channellist)) {
220 srd_err("Protocol decoder %s %s attribute is not a tuple.",
225 for (i = PyTuple_Size(py_channellist) - 1; i >= 0; i--) {
226 py_entry = PyTuple_GetItem(py_channellist, i);
230 if (!PyDict_Check(py_entry)) {
231 srd_err("Protocol decoder %s %s attribute is not "
232 "a list of dict elements.", d->name, attr);
235 pdch = g_malloc(sizeof(struct srd_channel));
236 /* Add to list right away so it doesn't get lost. */
237 pdchl = g_slist_prepend(pdchl, pdch);
239 if (py_dictitem_as_str(py_entry, "id", &pdch->id) != SRD_OK)
241 if (py_dictitem_as_str(py_entry, "name", &pdch->name) != SRD_OK)
243 if (py_dictitem_as_str(py_entry, "desc", &pdch->desc) != SRD_OK)
246 pdch->order = offset + i;
249 Py_DECREF(py_channellist);
252 PyGILState_Release(gstate);
257 srd_exception_catch("Failed to get %s list of %s decoder",
261 g_slist_free_full(pdchl, &channel_free);
262 Py_XDECREF(py_channellist);
263 PyGILState_Release(gstate);
265 return SRD_ERR_PYTHON;
268 static int get_options(struct srd_decoder *d)
270 PyObject *py_opts, *py_opt, *py_str, *py_values, *py_default, *py_item;
272 struct srd_decoder_option *o;
275 PyGILState_STATE gstate;
277 gstate = PyGILState_Ensure();
279 if (!PyObject_HasAttrString(d->py_dec, "options")) {
280 /* No options, that's fine. */
281 PyGILState_Release(gstate);
287 /* If present, options must be a tuple. */
288 py_opts = PyObject_GetAttrString(d->py_dec, "options");
292 if (!PyTuple_Check(py_opts)) {
293 srd_err("Protocol decoder %s: options attribute is not "
298 for (opt = PyTuple_Size(py_opts) - 1; opt >= 0; opt--) {
299 py_opt = PyTuple_GetItem(py_opts, opt);
303 if (!PyDict_Check(py_opt)) {
304 srd_err("Protocol decoder %s options: each option "
305 "must consist of a dictionary.", d->name);
309 o = g_malloc0(sizeof(struct srd_decoder_option));
310 /* Add to list right away so it doesn't get lost. */
311 options = g_slist_prepend(options, o);
313 py_str = PyDict_GetItemString(py_opt, "id");
315 srd_err("Protocol decoder %s option %zd has no ID.",
319 if (py_str_as_str(py_str, &o->id) != SRD_OK)
322 py_str = PyDict_GetItemString(py_opt, "desc");
324 if (py_str_as_str(py_str, &o->desc) != SRD_OK)
328 py_default = PyDict_GetItemString(py_opt, "default");
330 gvar = py_obj_to_variant(py_default);
332 srd_err("Protocol decoder %s option 'default' has "
333 "invalid default value.", d->name);
336 o->def = g_variant_ref_sink(gvar);
339 py_values = PyDict_GetItemString(py_opt, "values");
342 * A default is required if a list of values is
343 * given, since it's used to verify their type.
346 srd_err("No default for option '%s'.", o->id);
349 if (!PyTuple_Check(py_values)) {
350 srd_err("Option '%s' values should be a tuple.", o->id);
354 for (i = PyTuple_Size(py_values) - 1; i >= 0; i--) {
355 py_item = PyTuple_GetItem(py_values, i);
359 if (py_default && (Py_TYPE(py_default) != Py_TYPE(py_item))) {
360 srd_err("All values for option '%s' must be "
361 "of the same type as the default.",
365 gvar = py_obj_to_variant(py_item);
367 srd_err("Protocol decoder %s option 'values' "
368 "contains invalid value.", d->name);
371 o->values = g_slist_prepend(o->values,
372 g_variant_ref_sink(gvar));
376 d->options = options;
378 PyGILState_Release(gstate);
383 srd_exception_catch("Failed to get %s decoder options", d->name);
386 g_slist_free_full(options, &decoder_option_free);
388 PyGILState_Release(gstate);
390 return SRD_ERR_PYTHON;
393 /* Convert annotation class attribute to GSList of char **. */
394 static int get_annotations(struct srd_decoder *dec)
396 PyObject *py_annlist, *py_ann;
400 PyGILState_STATE gstate;
402 gstate = PyGILState_Ensure();
404 if (!PyObject_HasAttrString(dec->py_dec, "annotations")) {
405 PyGILState_Release(gstate);
411 py_annlist = PyObject_GetAttrString(dec->py_dec, "annotations");
415 if (!PyTuple_Check(py_annlist)) {
416 srd_err("Protocol decoder %s annotations should "
417 "be a tuple.", dec->name);
421 for (i = PyTuple_Size(py_annlist) - 1; i >= 0; i--) {
422 py_ann = PyTuple_GetItem(py_annlist, i);
426 if (!PyTuple_Check(py_ann) || PyTuple_Size(py_ann) != 2) {
427 srd_err("Protocol decoder %s annotation %zd should "
428 "be a tuple with two elements.",
432 if (py_strseq_to_char(py_ann, &annpair) != SRD_OK)
435 annotations = g_slist_prepend(annotations, annpair);
437 dec->annotations = annotations;
438 Py_DECREF(py_annlist);
439 PyGILState_Release(gstate);
444 srd_exception_catch("Failed to get %s decoder annotations", dec->name);
447 g_slist_free_full(annotations, (GDestroyNotify)&g_strfreev);
448 Py_XDECREF(py_annlist);
449 PyGILState_Release(gstate);
451 return SRD_ERR_PYTHON;
454 /* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */
455 static int get_annotation_rows(struct srd_decoder *dec)
457 PyObject *py_ann_rows, *py_ann_row, *py_ann_classes, *py_item;
458 GSList *annotation_rows;
459 struct srd_decoder_annotation_row *ann_row;
462 PyGILState_STATE gstate;
464 gstate = PyGILState_Ensure();
466 if (!PyObject_HasAttrString(dec->py_dec, "annotation_rows")) {
467 PyGILState_Release(gstate);
471 annotation_rows = NULL;
473 py_ann_rows = PyObject_GetAttrString(dec->py_dec, "annotation_rows");
477 if (!PyTuple_Check(py_ann_rows)) {
478 srd_err("Protocol decoder %s annotation_rows "
479 "must be a tuple.", dec->name);
483 for (i = PyTuple_Size(py_ann_rows) - 1; i >= 0; i--) {
484 py_ann_row = PyTuple_GetItem(py_ann_rows, i);
488 if (!PyTuple_Check(py_ann_row) || PyTuple_Size(py_ann_row) != 3) {
489 srd_err("Protocol decoder %s annotation_rows "
490 "must contain only tuples of 3 elements.",
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);
498 py_item = PyTuple_GetItem(py_ann_row, 0);
501 if (py_str_as_str(py_item, &ann_row->id) != SRD_OK)
504 py_item = PyTuple_GetItem(py_ann_row, 1);
507 if (py_str_as_str(py_item, &ann_row->desc) != SRD_OK)
510 py_ann_classes = PyTuple_GetItem(py_ann_row, 2);
514 if (!PyTuple_Check(py_ann_classes)) {
515 srd_err("Protocol decoder %s annotation_rows tuples "
516 "must have a tuple of numbers as 3rd element.",
521 for (k = PyTuple_Size(py_ann_classes) - 1; k >= 0; k--) {
522 py_item = PyTuple_GetItem(py_ann_classes, k);
526 if (!PyLong_Check(py_item)) {
527 srd_err("Protocol decoder %s annotation row "
528 "class tuple must only contain numbers.",
532 class_idx = PyLong_AsSize_t(py_item);
533 if (PyErr_Occurred())
536 ann_row->ann_classes = g_slist_prepend(ann_row->ann_classes,
537 GSIZE_TO_POINTER(class_idx));
540 dec->annotation_rows = annotation_rows;
541 Py_DECREF(py_ann_rows);
542 PyGILState_Release(gstate);
547 srd_exception_catch("Failed to get %s decoder annotation rows",
551 g_slist_free_full(annotation_rows, &annotation_row_free);
552 Py_XDECREF(py_ann_rows);
553 PyGILState_Release(gstate);
555 return SRD_ERR_PYTHON;
558 /* Convert binary classes to GSList of char **. */
559 static int get_binary_classes(struct srd_decoder *dec)
561 PyObject *py_bin_classes, *py_bin_class;
565 PyGILState_STATE gstate;
567 gstate = PyGILState_Ensure();
569 if (!PyObject_HasAttrString(dec->py_dec, "binary")) {
570 PyGILState_Release(gstate);
576 py_bin_classes = PyObject_GetAttrString(dec->py_dec, "binary");
580 if (!PyTuple_Check(py_bin_classes)) {
581 srd_err("Protocol decoder %s binary classes should "
582 "be a tuple.", dec->name);
586 for (i = PyTuple_Size(py_bin_classes) - 1; i >= 0; i--) {
587 py_bin_class = PyTuple_GetItem(py_bin_classes, i);
591 if (!PyTuple_Check(py_bin_class)
592 || PyTuple_Size(py_bin_class) != 2) {
593 srd_err("Protocol decoder %s binary classes should "
594 "consist only of tuples of 2 elements.",
598 if (py_strseq_to_char(py_bin_class, &bin) != SRD_OK)
601 bin_classes = g_slist_prepend(bin_classes, bin);
603 dec->binary = bin_classes;
604 Py_DECREF(py_bin_classes);
605 PyGILState_Release(gstate);
610 srd_exception_catch("Failed to get %s decoder binary classes",
614 g_slist_free_full(bin_classes, (GDestroyNotify)&g_strfreev);
615 Py_XDECREF(py_bin_classes);
616 PyGILState_Release(gstate);
618 return SRD_ERR_PYTHON;
621 /* Convert logic_output_channels to GSList of 'struct srd_decoder_logic_output_channel'. */
622 static int get_logic_output_channels(struct srd_decoder *dec)
624 PyObject *py_logic_out_chs, *py_logic_out_ch, *py_item;
625 GSList *logic_out_chs;
626 struct srd_decoder_logic_output_channel *logic_out_ch;
628 PyGILState_STATE gstate;
630 gstate = PyGILState_Ensure();
632 if (!PyObject_HasAttrString(dec->py_dec, "logic_output_channels")) {
633 PyGILState_Release(gstate);
637 logic_out_chs = NULL;
639 py_logic_out_chs = PyObject_GetAttrString(dec->py_dec, "logic_output_channels");
640 if (!py_logic_out_chs)
643 if (!PyTuple_Check(py_logic_out_chs)) {
644 srd_err("Protocol decoder %s logic_output_channels "
645 "must be a tuple.", dec->name);
649 for (i = PyTuple_Size(py_logic_out_chs) - 1; i >= 0; i--) {
650 py_logic_out_ch = PyTuple_GetItem(py_logic_out_chs, i);
651 if (!py_logic_out_ch)
654 if (!PyTuple_Check(py_logic_out_ch) || PyTuple_Size(py_logic_out_ch) != 2) {
655 srd_err("Protocol decoder %s logic_output_channels "
656 "must contain only tuples of 2 elements.",
660 logic_out_ch = g_malloc0(sizeof(*logic_out_ch));
661 /* Add to list right away so it doesn't get lost. */
662 logic_out_chs = g_slist_prepend(logic_out_chs, logic_out_ch);
664 py_item = PyTuple_GetItem(py_logic_out_ch, 0);
667 if (py_str_as_str(py_item, &logic_out_ch->id) != SRD_OK)
670 py_item = PyTuple_GetItem(py_logic_out_ch, 1);
673 if (py_str_as_str(py_item, &logic_out_ch->desc) != SRD_OK)
676 dec->logic_output_channels = logic_out_chs;
677 Py_DECREF(py_logic_out_chs);
678 PyGILState_Release(gstate);
683 srd_exception_catch("Failed to get %s decoder logic output channels",
687 g_slist_free_full(logic_out_chs, &logic_output_channel_free);
688 Py_XDECREF(py_logic_out_chs);
689 PyGILState_Release(gstate);
691 return SRD_ERR_PYTHON;
694 /* Check whether the Decoder class defines the named method. */
695 static int check_method(PyObject *py_dec, const char *mod_name,
696 const char *method_name)
700 PyGILState_STATE gstate;
702 gstate = PyGILState_Ensure();
704 py_method = PyObject_GetAttrString(py_dec, method_name);
706 srd_exception_catch("Protocol decoder %s Decoder class "
707 "has no %s() method", mod_name, method_name);
708 PyGILState_Release(gstate);
709 return SRD_ERR_PYTHON;
712 is_callable = PyCallable_Check(py_method);
713 Py_DECREF(py_method);
715 PyGILState_Release(gstate);
718 srd_err("Protocol decoder %s Decoder class attribute '%s' "
719 "is not a method.", mod_name, method_name);
720 return SRD_ERR_PYTHON;
727 * Get the API version of the specified decoder.
729 * @param d The decoder to use. Must not be NULL.
731 * @return The API version of the decoder, or 0 upon errors.
735 SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d)
739 PyGILState_STATE gstate;
744 gstate = PyGILState_Ensure();
746 py_apiver = PyObject_GetAttrString(d->py_dec, "api_version");
747 apiver = (py_apiver && PyLong_Check(py_apiver))
748 ? PyLong_AsLong(py_apiver) : 0;
749 Py_XDECREF(py_apiver);
751 PyGILState_Release(gstate);
756 static gboolean contains_duplicates(GSList *list)
758 for (GSList *l1 = list; l1; l1 = l1->next) {
759 for (GSList *l2 = l1->next; l2; l2 = l2->next)
760 if (!strcmp(l1->data, l2->data))
767 static gboolean contains_duplicate_ids(GSList *list1, GSList *list2)
769 for (GSList *l1 = list1; l1; l1 = l1->next) {
770 unsigned int cnt = 0;
771 const char **s1 = l1->data;
772 for (GSList *l2 = list2; l2; l2 = l2->next) {
773 const char **s2 = l2->data;
774 if (!strcmp(s1[0], s2[0]))
776 if ((list1 == list2) && cnt > 1)
778 if ((list1 != list2) && cnt > 0)
786 static gboolean contains_duplicate_row_ids(GSList *list1, GSList *list2)
788 for (GSList *l1 = list1; l1; l1 = l1->next) {
789 unsigned int cnt = 0;
790 const struct srd_decoder_annotation_row *r1 = l1->data;
791 for (GSList *l2 = list2; l2; l2 = l2->next) {
792 const struct srd_decoder_annotation_row *r2 = l2->data;
793 if (!strcmp(r1->id, r2->id))
804 * Load a protocol decoder module into the embedded Python interpreter.
806 * @param module_name The module name to be loaded.
808 * @return SRD_OK upon success, a (negative) error code otherwise.
812 SRD_API int srd_decoder_load(const char *module_name)
814 PyObject *py_basedec;
815 struct srd_decoder *d;
818 const char *fail_txt;
819 PyGILState_STATE gstate;
821 if (!srd_check_init())
827 gstate = PyGILState_Ensure();
829 if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) {
830 /* Module was already imported. */
831 PyGILState_Release(gstate);
835 d = g_malloc0(sizeof(struct srd_decoder));
838 d->py_mod = py_import_by_name(module_name);
840 fail_txt = "import by name failed";
844 if (!mod_sigrokdecode) {
845 srd_err("sigrokdecode module not loaded.");
846 fail_txt = "sigrokdecode(3) not loaded";
850 /* Get the 'Decoder' class as Python object. */
851 d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder");
853 fail_txt = "no 'Decoder' attribute in imported module";
857 py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder");
859 fail_txt = "no 'Decoder' attribute in sigrokdecode(3)";
863 is_subclass = PyObject_IsSubclass(d->py_dec, py_basedec);
864 Py_DECREF(py_basedec);
867 srd_err("Decoder class in protocol decoder module %s is not "
868 "a subclass of sigrokdecode.Decoder.", module_name);
869 fail_txt = "not a subclass of sigrokdecode.Decoder";
874 * Check that this decoder has the correct PD API version.
875 * PDs of different API versions are incompatible and cannot work.
877 apiver = srd_decoder_apiver(d);
879 srd_exception_catch("Only PD API version 3 is supported, "
880 "decoder %s has version %ld", module_name, apiver);
881 fail_txt = "API version mismatch";
885 /* Check Decoder class for required methods. */
887 if (check_method(d->py_dec, module_name, "reset") != SRD_OK) {
888 fail_txt = "no 'reset()' method";
892 if (check_method(d->py_dec, module_name, "start") != SRD_OK) {
893 fail_txt = "no 'start()' method";
897 if (check_method(d->py_dec, module_name, "decode") != SRD_OK) {
898 fail_txt = "no 'decode()' method";
902 /* Store required fields in newly allocated strings. */
903 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) {
904 fail_txt = "no 'id' attribute";
908 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) {
909 fail_txt = "no 'name' attribute";
913 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) {
914 fail_txt = "no 'longname' attribute";
918 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) {
919 fail_txt = "no 'desc' attribute";
923 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) {
924 fail_txt = "no 'license' attribute";
928 if (py_attr_as_strlist(d->py_dec, "inputs", &(d->inputs)) != SRD_OK) {
929 fail_txt = "missing or malformed 'inputs' attribute";
933 if (py_attr_as_strlist(d->py_dec, "outputs", &(d->outputs)) != SRD_OK) {
934 fail_txt = "missing or malformed 'outputs' attribute";
938 if (py_attr_as_strlist(d->py_dec, "tags", &(d->tags)) != SRD_OK) {
939 fail_txt = "missing or malformed 'tags' attribute";
943 /* All options and their default values. */
944 if (get_options(d) != SRD_OK) {
945 fail_txt = "cannot get options";
949 /* Check and import required channels. */
950 if (get_channels(d, "channels", &d->channels, 0) != SRD_OK) {
951 fail_txt = "cannot get channels";
955 /* Check and import optional channels. */
956 if (get_channels(d, "optional_channels", &d->opt_channels,
957 g_slist_length(d->channels)) != SRD_OK) {
958 fail_txt = "cannot get optional channels";
962 if (get_annotations(d) != SRD_OK) {
963 fail_txt = "cannot get annotations";
967 if (get_annotation_rows(d) != SRD_OK) {
968 fail_txt = "cannot get annotation rows";
972 if (get_binary_classes(d) != SRD_OK) {
973 fail_txt = "cannot get binary classes";
977 if (contains_duplicates(d->inputs)) {
978 fail_txt = "duplicate input IDs";
982 if (contains_duplicates(d->outputs)) {
983 fail_txt = "duplicate output IDs";
987 if (contains_duplicates(d->tags)) {
988 fail_txt = "duplicate tags";
992 if (contains_duplicate_ids(d->channels, d->channels)) {
993 fail_txt = "duplicate channel IDs";
997 if (contains_duplicate_ids(d->opt_channels, d->opt_channels)) {
998 fail_txt = "duplicate optional channel IDs";
1002 if (contains_duplicate_ids(d->channels, d->opt_channels)) {
1003 fail_txt = "channel and optional channel IDs contain duplicates";
1007 if (contains_duplicate_ids(d->options, d->options)) {
1008 fail_txt = "duplicate option IDs";
1012 if (contains_duplicate_ids(d->annotations, d->annotations)) {
1013 fail_txt = "duplicate annotation class IDs";
1017 if (contains_duplicate_row_ids(d->annotation_rows, d->annotation_rows)) {
1018 fail_txt = "duplicate annotation row IDs";
1022 if (contains_duplicate_ids(d->annotations, d->annotation_rows)) {
1023 fail_txt = "annotation class/row IDs contain duplicates";
1027 if (contains_duplicate_ids(d->binary, d->binary)) {
1028 fail_txt = "duplicate binary class IDs";
1032 if (get_logic_output_channels(d) != SRD_OK) {
1033 fail_txt = "cannot get logic output channels";
1037 PyGILState_Release(gstate);
1039 /* Append it to the list of loaded decoders. */
1040 pd_list = g_slist_append(pd_list, d);
1045 /* Don't show a message for the "common" directory, it's not a PD. */
1046 if (strcmp(module_name, "common")) {
1047 srd_exception_catch("Failed to load decoder %s: %s",
1048 module_name, fail_txt);
1054 srd_err("Failed to load decoder %s: %s", module_name, fail_txt);
1056 PyGILState_Release(gstate);
1058 return SRD_ERR_PYTHON;
1062 * Return a protocol decoder's docstring.
1064 * @param dec The loaded protocol decoder. Must not be NULL.
1066 * @return A newly allocated buffer containing the protocol decoder's
1067 * documentation. The caller is responsible for free'ing the buffer.
1071 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
1075 PyGILState_STATE gstate;
1077 if (!srd_check_init())
1080 if (!dec || !dec->py_mod)
1083 gstate = PyGILState_Ensure();
1085 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
1088 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
1089 srd_exception_catch("Failed to get docstring");
1094 if (py_str != Py_None)
1095 py_str_as_str(py_str, &doc);
1098 PyGILState_Release(gstate);
1103 PyGILState_Release(gstate);
1109 * Unload the specified protocol decoder.
1111 * @param dec The struct srd_decoder to be unloaded.
1113 * @return SRD_OK upon success, a (negative) error code otherwise.
1117 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
1119 struct srd_session *sess;
1122 if (!srd_check_init())
1129 * Since any instances of this decoder need to be released as well,
1130 * but they could be anywhere in the stack, just free the entire
1131 * stack. A frontend reloading a decoder thus has to restart all
1132 * instances, and rebuild the stack.
1134 for (l = sessions; l; l = l->next) {
1136 srd_inst_free_all(sess);
1139 /* Remove the PD from the list of loaded decoders. */
1140 pd_list = g_slist_remove(pd_list, dec);
1147 static void srd_decoder_load_all_zip_path(char *zip_path)
1149 PyObject *zipimport_mod, *zipimporter_class, *zipimporter;
1150 PyObject *prefix_obj, *files, *key, *value, *set, *modname;
1154 PyGILState_STATE gstate;
1156 set = files = prefix_obj = zipimporter = zipimporter_class = NULL;
1158 gstate = PyGILState_Ensure();
1160 zipimport_mod = py_import_by_name("zipimport");
1161 if (zipimport_mod == NULL)
1164 zipimporter_class = PyObject_GetAttrString(zipimport_mod, "zipimporter");
1165 if (zipimporter_class == NULL)
1168 zipimporter = PyObject_CallFunction(zipimporter_class, "s", zip_path);
1169 if (zipimporter == NULL)
1172 prefix_obj = PyObject_GetAttrString(zipimporter, "prefix");
1173 if (prefix_obj == NULL)
1176 files = PyObject_GetAttrString(zipimporter, "_files");
1177 if (files == NULL || !PyDict_Check(files))
1180 set = PySet_New(NULL);
1184 if (py_str_as_str(prefix_obj, &prefix) != SRD_OK)
1187 prefix_len = strlen(prefix);
1189 while (PyDict_Next(files, &pos, &key, &value)) {
1191 if (py_str_as_str(key, &path) == SRD_OK) {
1192 if (strlen(path) > prefix_len
1193 && memcmp(path, prefix, prefix_len) == 0
1194 && (slash = strchr(path + prefix_len, '/'))) {
1196 modname = PyUnicode_FromStringAndSize(path + prefix_len,
1197 slash - (path + prefix_len));
1198 if (modname == NULL) {
1201 PySet_Add(set, modname);
1210 while ((modname = PySet_Pop(set))) {
1212 if (py_str_as_str(modname, &modname_str) == SRD_OK) {
1213 /* The directory name is the module name (e.g. "i2c"). */
1214 srd_decoder_load(modname_str);
1215 g_free(modname_str);
1223 Py_XDECREF(prefix_obj);
1224 Py_XDECREF(zipimporter);
1225 Py_XDECREF(zipimporter_class);
1226 Py_XDECREF(zipimport_mod);
1228 PyGILState_Release(gstate);
1231 static void srd_decoder_load_all_path(char *path)
1234 const gchar *direntry;
1236 if (!(dir = g_dir_open(path, 0, NULL))) {
1237 /* Not really fatal. Try zipimport method too. */
1238 srd_decoder_load_all_zip_path(path);
1243 * This ignores errors returned by srd_decoder_load(). That
1244 * function will have logged the cause, but in any case we
1245 * want to continue anyway.
1247 while ((direntry = g_dir_read_name(dir)) != NULL) {
1248 /* The directory name is the module name (e.g. "i2c"). */
1249 srd_decoder_load(direntry);
1255 * Load all installed protocol decoders.
1257 * @return SRD_OK upon success, a (negative) error code otherwise.
1261 SRD_API int srd_decoder_load_all(void)
1265 if (!srd_check_init())
1268 for (l = searchpaths; l; l = l->next)
1269 srd_decoder_load_all_path(l->data);
1274 static void srd_decoder_unload_cb(void *arg, void *ignored)
1278 srd_decoder_unload((struct srd_decoder *)arg);
1282 * Unload all loaded protocol decoders.
1284 * @return SRD_OK upon success, a (negative) error code otherwise.
1288 SRD_API int srd_decoder_unload_all(void)
1290 g_slist_foreach(pd_list, srd_decoder_unload_cb, NULL);
1291 g_slist_free(pd_list);