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 decoder_option_free(void *data)
141 struct srd_decoder_option *opt = data;
146 g_slist_free_full(opt->values, &variant_free);
147 variant_free(opt->def);
153 static void decoder_free(struct srd_decoder *dec)
158 Py_XDECREF(dec->py_dec);
159 Py_XDECREF(dec->py_mod);
161 g_slist_free_full(dec->options, &decoder_option_free);
162 g_slist_free_full(dec->binary, (GDestroyNotify)&g_strfreev);
163 g_slist_free_full(dec->annotation_rows, &annotation_row_free);
164 g_slist_free_full(dec->annotations, (GDestroyNotify)&g_strfreev);
165 g_slist_free_full(dec->opt_channels, &channel_free);
166 g_slist_free_full(dec->channels, &channel_free);
168 g_free(dec->license);
170 g_free(dec->longname);
177 static int get_channels(const struct srd_decoder *d, const char *attr,
178 GSList **out_pdchl, int offset)
180 PyObject *py_channellist, *py_entry;
181 struct srd_channel *pdch;
185 if (!PyObject_HasAttrString(d->py_dec, attr))
186 /* No channels of this type specified. */
191 py_channellist = PyObject_GetAttrString(d->py_dec, attr);
195 if (!PyTuple_Check(py_channellist)) {
196 srd_err("Protocol decoder %s %s attribute is not a tuple.",
201 for (i = PyTuple_Size(py_channellist) - 1; i >= 0; i--) {
202 py_entry = PyTuple_GetItem(py_channellist, i);
206 if (!PyDict_Check(py_entry)) {
207 srd_err("Protocol decoder %s %s attribute is not "
208 "a list of dict elements.", d->name, attr);
211 pdch = g_malloc0(sizeof(struct srd_channel));
212 /* Add to list right away so it doesn't get lost. */
213 pdchl = g_slist_prepend(pdchl, pdch);
215 if (py_dictitem_as_str(py_entry, "id", &pdch->id) != SRD_OK)
217 if (py_dictitem_as_str(py_entry, "name", &pdch->name) != SRD_OK)
219 if (py_dictitem_as_str(py_entry, "desc", &pdch->desc) != SRD_OK)
222 pdch->order = offset + i;
225 Py_DECREF(py_channellist);
231 srd_exception_catch("Failed to get %s list of %s decoder",
234 g_slist_free_full(pdchl, &channel_free);
235 Py_XDECREF(py_channellist);
237 return SRD_ERR_PYTHON;
240 static int get_options(struct srd_decoder *d)
242 PyObject *py_opts, *py_opt, *py_str, *py_values, *py_default, *py_item;
244 struct srd_decoder_option *o;
248 if (!PyObject_HasAttrString(d->py_dec, "options"))
249 /* No options, that's fine. */
254 /* If present, options must be a tuple. */
255 py_opts = PyObject_GetAttrString(d->py_dec, "options");
259 if (!PyTuple_Check(py_opts)) {
260 srd_err("Protocol decoder %s: options attribute is not "
265 for (opt = PyTuple_Size(py_opts) - 1; opt >= 0; opt--) {
266 py_opt = PyTuple_GetItem(py_opts, opt);
270 if (!PyDict_Check(py_opt)) {
271 srd_err("Protocol decoder %s options: each option "
272 "must consist of a dictionary.", d->name);
276 o = g_malloc0(sizeof(struct srd_decoder_option));
277 /* Add to list right away so it doesn't get lost. */
278 options = g_slist_prepend(options, o);
280 py_str = PyDict_GetItemString(py_opt, "id");
282 srd_err("Protocol decoder %s option %zd has no id.",
286 if (py_str_as_str(py_str, &o->id) != SRD_OK)
289 py_str = PyDict_GetItemString(py_opt, "desc");
291 if (py_str_as_str(py_str, &o->desc) != SRD_OK)
295 py_default = PyDict_GetItemString(py_opt, "default");
297 gvar = py_obj_to_variant(py_default);
299 srd_err("Protocol decoder %s option 'default' has "
300 "invalid default value.", d->name);
303 o->def = g_variant_ref_sink(gvar);
306 py_values = PyDict_GetItemString(py_opt, "values");
308 /* A default is required if a list of values is
309 * given, since it's used to verify their type. */
311 srd_err("No default for option '%s'.", o->id);
314 if (!PyTuple_Check(py_values)) {
315 srd_err("Option '%s' values should be a tuple.", o->id);
319 for (i = PyTuple_Size(py_values) - 1; i >= 0; i--) {
320 py_item = PyTuple_GetItem(py_values, i);
324 if (Py_TYPE(py_default) != Py_TYPE(py_item)) {
325 srd_err("All values for option '%s' must be "
326 "of the same type as the default.",
330 gvar = py_obj_to_variant(py_item);
332 srd_err("Protocol decoder %s option 'values' "
333 "contains invalid value.", d->name);
336 o->values = g_slist_prepend(o->values,
337 g_variant_ref_sink(gvar));
341 d->options = options;
347 srd_exception_catch("Failed to get %s decoder options", d->name);
349 g_slist_free_full(options, &decoder_option_free);
352 return SRD_ERR_PYTHON;
355 /* Convert annotation class attribute to GSList of char **.
357 static int get_annotations(struct srd_decoder *dec)
359 PyObject *py_annlist, *py_ann;
364 if (!PyObject_HasAttrString(dec->py_dec, "annotations"))
369 py_annlist = PyObject_GetAttrString(dec->py_dec, "annotations");
373 if (!PyTuple_Check(py_annlist)) {
374 srd_err("Protocol decoder %s annotations should "
375 "be a tuple.", dec->name);
379 for (i = PyTuple_Size(py_annlist) - 1; i >= 0; i--) {
380 py_ann = PyTuple_GetItem(py_annlist, i);
384 if (!PyTuple_Check(py_ann) || PyTuple_Size(py_ann) != 2) {
385 srd_err("Protocol decoder %s annotation %zd should "
386 "be a tuple with two elements.",
390 if (py_strseq_to_char(py_ann, &annpair) != SRD_OK)
393 annotations = g_slist_prepend(annotations, annpair);
395 dec->annotations = annotations;
396 Py_DECREF(py_annlist);
401 srd_exception_catch("Failed to get %s decoder annotations", dec->name);
403 g_slist_free_full(annotations, (GDestroyNotify)&g_strfreev);
404 Py_XDECREF(py_annlist);
406 return SRD_ERR_PYTHON;
409 /* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'.
411 static int get_annotation_rows(struct srd_decoder *dec)
413 PyObject *py_ann_rows, *py_ann_row, *py_ann_classes, *py_item;
414 GSList *annotation_rows;
415 struct srd_decoder_annotation_row *ann_row;
419 if (!PyObject_HasAttrString(dec->py_dec, "annotation_rows"))
422 annotation_rows = NULL;
424 py_ann_rows = PyObject_GetAttrString(dec->py_dec, "annotation_rows");
428 if (!PyTuple_Check(py_ann_rows)) {
429 srd_err("Protocol decoder %s annotation_rows "
430 "must be a tuple.", dec->name);
434 for (i = PyTuple_Size(py_ann_rows) - 1; i >= 0; i--) {
435 py_ann_row = PyTuple_GetItem(py_ann_rows, i);
439 if (!PyTuple_Check(py_ann_row) || PyTuple_Size(py_ann_row) != 3) {
440 srd_err("Protocol decoder %s annotation_rows "
441 "must contain only tuples of 3 elements.",
445 ann_row = g_malloc0(sizeof(struct srd_decoder_annotation_row));
446 /* Add to list right away so it doesn't get lost. */
447 annotation_rows = g_slist_prepend(annotation_rows, ann_row);
449 py_item = PyTuple_GetItem(py_ann_row, 0);
452 if (py_str_as_str(py_item, &ann_row->id) != SRD_OK)
455 py_item = PyTuple_GetItem(py_ann_row, 1);
458 if (py_str_as_str(py_item, &ann_row->desc) != SRD_OK)
461 py_ann_classes = PyTuple_GetItem(py_ann_row, 2);
465 if (!PyTuple_Check(py_ann_classes)) {
466 srd_err("Protocol decoder %s annotation_rows tuples "
467 "must have a tuple of numbers as 3rd element.",
472 for (k = PyTuple_Size(py_ann_classes) - 1; k >= 0; k--) {
473 py_item = PyTuple_GetItem(py_ann_classes, k);
477 if (!PyLong_Check(py_item)) {
478 srd_err("Protocol decoder %s annotation row "
479 "class tuple must only contain numbers.",
483 class_idx = PyLong_AsSize_t(py_item);
484 if (PyErr_Occurred())
487 ann_row->ann_classes = g_slist_prepend(ann_row->ann_classes,
488 GSIZE_TO_POINTER(class_idx));
491 dec->annotation_rows = annotation_rows;
492 Py_DECREF(py_ann_rows);
497 srd_exception_catch("Failed to get %s decoder annotation rows",
500 g_slist_free_full(annotation_rows, &annotation_row_free);
501 Py_XDECREF(py_ann_rows);
503 return SRD_ERR_PYTHON;
506 /* Convert binary classes to GSList of char **.
508 static int get_binary_classes(struct srd_decoder *dec)
510 PyObject *py_bin_classes, *py_bin_class;
515 if (!PyObject_HasAttrString(dec->py_dec, "binary"))
520 py_bin_classes = PyObject_GetAttrString(dec->py_dec, "binary");
524 if (!PyTuple_Check(py_bin_classes)) {
525 srd_err("Protocol decoder %s binary classes should "
526 "be a tuple.", dec->name);
530 for (i = PyTuple_Size(py_bin_classes) - 1; i >= 0; i--) {
531 py_bin_class = PyTuple_GetItem(py_bin_classes, i);
535 if (!PyTuple_Check(py_bin_class)
536 || PyTuple_Size(py_bin_class) != 2) {
537 srd_err("Protocol decoder %s binary classes should "
538 "consist only of tuples of 2 elements.",
542 if (py_strseq_to_char(py_bin_class, &bin) != SRD_OK)
545 bin_classes = g_slist_prepend(bin_classes, bin);
547 dec->binary = bin_classes;
548 Py_DECREF(py_bin_classes);
553 srd_exception_catch("Failed to get %s decoder binary classes",
556 g_slist_free_full(bin_classes, (GDestroyNotify)&g_strfreev);
557 Py_XDECREF(py_bin_classes);
559 return SRD_ERR_PYTHON;
562 /* Check whether the Decoder class defines the named method.
564 static int check_method(PyObject *py_dec, const char *mod_name,
565 const char *method_name)
570 py_method = PyObject_GetAttrString(py_dec, method_name);
572 srd_exception_catch("Protocol decoder %s Decoder class "
573 "has no %s() method", mod_name, method_name);
574 return SRD_ERR_PYTHON;
577 is_callable = PyCallable_Check(py_method);
578 Py_DECREF(py_method);
581 srd_err("Protocol decoder %s Decoder class attribute '%s' "
582 "is not a method.", mod_name, method_name);
583 return SRD_ERR_PYTHON;
590 * Get the API version of the specified decoder.
592 * @param d The decoder to use. Must not be NULL.
594 * @return The API version of the decoder, or 0 upon errors.
596 SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d)
604 py_apiver = PyObject_GetAttrString(d->py_dec, "api_version");
605 apiver = (py_apiver && PyLong_Check(py_apiver))
606 ? PyLong_AsLong(py_apiver) : 0;
607 Py_XDECREF(py_apiver);
613 * Load a protocol decoder module into the embedded Python interpreter.
615 * @param module_name The module name to be loaded.
617 * @return SRD_OK upon success, a (negative) error code otherwise.
621 SRD_API int srd_decoder_load(const char *module_name)
623 PyObject *py_basedec;
624 struct srd_decoder *d;
627 const char *fail_txt;
629 if (!srd_check_init())
635 if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) {
636 /* Module was already imported. */
640 srd_dbg("Loading protocol decoder '%s'.", module_name);
642 d = g_malloc0(sizeof(struct srd_decoder));
645 d->py_mod = py_import_by_name(module_name);
647 fail_txt = "import by name failed";
651 if (!mod_sigrokdecode) {
652 srd_err("sigrokdecode module not loaded.");
653 fail_txt = "sigrokdecode(3) not loaded";
657 /* Get the 'Decoder' class as Python object. */
658 d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder");
660 fail_txt = "no 'Decoder' attribute in imported module";
664 py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder");
666 fail_txt = "no 'Decoder' attribute in sigrokdecode(3)";
670 is_subclass = PyObject_IsSubclass(d->py_dec, py_basedec);
671 Py_DECREF(py_basedec);
674 srd_err("Decoder class in protocol decoder module %s is not "
675 "a subclass of sigrokdecode.Decoder.", module_name);
676 fail_txt = "not a subclass of sigrokdecode.Decoder";
681 * Check that this decoder has the correct PD API version.
682 * PDs of different API versions are incompatible and cannot work.
684 apiver = srd_decoder_apiver(d);
685 if (apiver != 2 && apiver != 3) {
686 srd_exception_catch("Only PD API version 2/3 is supported, "
687 "decoder %s has version %ld", module_name, apiver);
688 fail_txt = "API version mismatch";
692 /* Check Decoder class for required methods.
694 if (check_method(d->py_dec, module_name, "start") != SRD_OK) {
695 fail_txt = "no 'start()' method";
699 if (check_method(d->py_dec, module_name, "decode") != SRD_OK) {
700 fail_txt = "no 'decode()' method";
704 /* Store required fields in newly allocated strings. */
705 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) {
706 fail_txt = "no 'id' attribute";
710 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) {
711 fail_txt = "no 'name' attribute";
715 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) {
716 fail_txt = "no 'longname' attribute";
720 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) {
721 fail_txt = "no 'desc' attribute";
725 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) {
726 fail_txt = "no 'license' attribute";
730 /* All options and their default values. */
731 if (get_options(d) != SRD_OK) {
732 fail_txt = "cannot get options";
736 /* Check and import required channels. */
737 if (get_channels(d, "channels", &d->channels, 0) != SRD_OK) {
738 fail_txt = "cannot get channels";
742 /* Check and import optional channels. */
743 if (get_channels(d, "optional_channels", &d->opt_channels,
744 g_slist_length(d->channels)) != SRD_OK) {
745 fail_txt = "cannot get optional channels";
749 if (get_annotations(d) != SRD_OK) {
750 fail_txt = "cannot get annotations";
754 if (get_annotation_rows(d) != SRD_OK) {
755 fail_txt = "cannot get annotation rows";
759 if (get_binary_classes(d) != SRD_OK) {
760 fail_txt = "cannot get binary classes";
764 /* Append it to the list of loaded decoders. */
765 pd_list = g_slist_append(pd_list, d);
771 srd_exception_catch("Failed to load decoder %s: %s",
772 module_name, fail_txt);
775 srd_exception_catch("Failed to load decoder %s", module_name);
779 srd_err("Failed to load decoder %s: %s", module_name, fail_txt);
782 return SRD_ERR_PYTHON;
786 * Return a protocol decoder's docstring.
788 * @param dec The loaded protocol decoder.
790 * @return A newly allocated buffer containing the protocol decoder's
791 * documentation. The caller is responsible for free'ing the buffer.
795 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
800 if (!srd_check_init())
806 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
809 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
810 srd_exception_catch("Failed to get docstring");
815 if (py_str != Py_None)
816 py_str_as_str(py_str, &doc);
823 * Unload the specified protocol decoder.
825 * @param dec The struct srd_decoder to be unloaded.
827 * @return SRD_OK upon success, a (negative) error code otherwise.
831 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
833 struct srd_session *sess;
836 if (!srd_check_init())
842 srd_dbg("Unloading protocol decoder '%s'.", dec->name);
845 * Since any instances of this decoder need to be released as well,
846 * but they could be anywhere in the stack, just free the entire
847 * stack. A frontend reloading a decoder thus has to restart all
848 * instances, and rebuild the stack.
850 for (l = sessions; l; l = l->next) {
852 srd_inst_free_all(sess, NULL);
855 /* Remove the PD from the list of loaded decoders. */
856 pd_list = g_slist_remove(pd_list, dec);
863 static void srd_decoder_load_all_zip_path(char *path)
865 PyObject *zipimport_mod, *zipimporter_class, *zipimporter;
866 PyObject *prefix_obj, *files, *key, *value, *set, *modname;
871 set = files = prefix_obj = zipimporter = zipimporter_class = NULL;
873 zipimport_mod = py_import_by_name("zipimport");
874 if (zipimport_mod == NULL)
877 zipimporter_class = PyObject_GetAttrString(zipimport_mod, "zipimporter");
878 if (zipimporter_class == NULL)
881 zipimporter = PyObject_CallFunction(zipimporter_class, "s", path);
882 if (zipimporter == NULL)
885 prefix_obj = PyObject_GetAttrString(zipimporter, "prefix");
886 if (prefix_obj == NULL)
889 files = PyObject_GetAttrString(zipimporter, "_files");
890 if (files == NULL || !PyDict_Check(files))
893 set = PySet_New(NULL);
897 if (py_str_as_str(prefix_obj, &prefix) != SRD_OK)
900 prefix_len = strlen(prefix);
902 while (PyDict_Next(files, &pos, &key, &value)) {
904 if (py_str_as_str(key, &path) == SRD_OK) {
905 if (strlen(path) > prefix_len
906 && memcmp(path, prefix, prefix_len) == 0
907 && (slash = strchr(path + prefix_len, '/'))) {
909 modname = PyUnicode_FromStringAndSize(path + prefix_len,
910 slash - (path + prefix_len));
911 if (modname == NULL) {
914 PySet_Add(set, modname);
923 while ((modname = PySet_Pop(set))) {
925 if (py_str_as_str(modname, &modname_str) == SRD_OK) {
926 /* The directory name is the module name (e.g. "i2c"). */
927 srd_decoder_load(modname_str);
936 Py_XDECREF(prefix_obj);
937 Py_XDECREF(zipimporter);
938 Py_XDECREF(zipimporter_class);
939 Py_XDECREF(zipimport_mod);
943 static void srd_decoder_load_all_path(char *path)
946 const gchar *direntry;
948 if (!(dir = g_dir_open(path, 0, NULL))) {
949 /* Not really fatal */
950 /* Try zipimport method too */
951 srd_decoder_load_all_zip_path(path);
955 /* This ignores errors returned by srd_decoder_load(). That
956 * function will have logged the cause, but in any case we
957 * want to continue anyway. */
958 while ((direntry = g_dir_read_name(dir)) != NULL) {
959 /* The directory name is the module name (e.g. "i2c"). */
960 srd_decoder_load(direntry);
967 * Load all installed protocol decoders.
969 * @return SRD_OK upon success, a (negative) error code otherwise.
973 SRD_API int srd_decoder_load_all(void)
977 if (!srd_check_init())
980 for (l = searchpaths; l; l = l->next)
981 srd_decoder_load_all_path(l->data);
987 * Unload all loaded protocol decoders.
989 * @return SRD_OK upon success, a (negative) error code otherwise.
993 SRD_API int srd_decoder_unload_all(void)
995 g_slist_foreach(pd_list, (GFunc)srd_decoder_unload, NULL);
996 g_slist_free(pd_list);