X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=15c03ab661b1586efff4447c1de79437564dfa2f;hp=1b0ed2abdd89cdcccc14950c92a4b5a6b056703b;hb=04ff49263b0a462250d2301e6d4d17db5904a8d3;hpb=ea81b49a3ca4fff4994693d30045d51b86181e32 diff --git a/decoder.c b/decoder.c index 1b0ed2a..15c03ab 100644 --- a/decoder.c +++ b/decoder.c @@ -19,8 +19,8 @@ */ #include "config.h" -#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ -#include "libsigrokdecode-internal.h" +#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode.h" #include /** @@ -40,27 +40,37 @@ /** @cond PRIVATE */ /* The list of protocol decoders. */ -SRD_PRIV GSList *pd_list = NULL; +static GSList *pd_list = NULL; /* srd.c */ -extern GSList *searchpaths; +extern SRD_PRIV GSList *searchpaths; /* session.c */ -extern GSList *sessions; +extern SRD_PRIV GSList *sessions; +extern SRD_PRIV int max_session_id; /* module_sigrokdecode.c */ extern SRD_PRIV PyObject *mod_sigrokdecode; /** @endcond */ +static gboolean srd_check_init(void) +{ + if (max_session_id < 0) { + srd_err("Library is not initialized."); + return FALSE; + } else + return TRUE; +} + /** * Returns the list of supported/loaded protocol decoders. * - * This is a GSList containing the names of the decoders as strings. + * This is a GSList of pointers to struct srd_decoder items. * * @return List of decoders, NULL if none are supported or loaded. * - * @since 0.1.0 (but the API changed in 0.2.0) + * @since 0.2.0 */ SRD_API const GSList *srd_decoder_list(void) { @@ -90,31 +100,31 @@ SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id) return NULL; } -static int get_probes(const struct srd_decoder *d, const char *attr, - GSList **pl) +static int get_channels(const struct srd_decoder *d, const char *attr, + GSList **pdchl) { - PyObject *py_probelist, *py_entry; - struct srd_probe *p; - int ret, num_probes, i; + PyObject *py_channellist, *py_entry; + struct srd_channel *pdch; + int ret, num_channels, i; if (!PyObject_HasAttrString(d->py_dec, attr)) - /* No probes of this type specified. */ + /* No channels of this type specified. */ return SRD_OK; - py_probelist = PyObject_GetAttrString(d->py_dec, attr); - if (!PyList_Check(py_probelist)) { - srd_err("Protocol decoder %s %s attribute is not a list.", + py_channellist = PyObject_GetAttrString(d->py_dec, attr); + if (!PyTuple_Check(py_channellist)) { + srd_err("Protocol decoder %s %s attribute is not a tuple.", d->name, attr); return SRD_ERR_PYTHON; } - if ((num_probes = PyList_Size(py_probelist)) == 0) - /* Empty probelist. */ + if ((num_channels = PyTuple_Size(py_channellist)) == 0) + /* Empty channellist. */ return SRD_OK; ret = SRD_OK; - for (i = 0; i < num_probes; i++) { - py_entry = PyList_GetItem(py_probelist, i); + for (i = 0; i < num_channels; i++) { + py_entry = PyTuple_GetItem(py_channellist, i); if (!PyDict_Check(py_entry)) { srd_err("Protocol decoder %s %s attribute is not " "a list with dict elements.", d->name, attr); @@ -122,121 +132,167 @@ static int get_probes(const struct srd_decoder *d, const char *attr, break; } - if (!(p = g_try_malloc(sizeof(struct srd_probe)))) { - srd_err("Failed to g_malloc() struct srd_probe."); + if (!(pdch = g_try_malloc(sizeof(struct srd_channel)))) { + srd_err("Failed to g_malloc() struct srd_channel."); ret = SRD_ERR_MALLOC; break; } - if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK) { + if ((py_dictitem_as_str(py_entry, "id", &pdch->id)) != SRD_OK) { ret = SRD_ERR_PYTHON; break; } - if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK) { + if ((py_dictitem_as_str(py_entry, "name", &pdch->name)) != SRD_OK) { ret = SRD_ERR_PYTHON; break; } - if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK) { + if ((py_dictitem_as_str(py_entry, "desc", &pdch->desc)) != SRD_OK) { ret = SRD_ERR_PYTHON; break; } - p->order = i; + pdch->order = i; - *pl = g_slist_append(*pl, p); + *pdchl = g_slist_append(*pdchl, pdch); } - Py_DecRef(py_probelist); + Py_DecRef(py_channellist); return ret; } static int get_options(struct srd_decoder *d) { - PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default; - Py_ssize_t i; + PyObject *py_opts, *py_opt, *py_val, *py_default, *py_item; + Py_ssize_t opt, i; struct srd_decoder_option *o; - gint64 def_long; - int num_keys, overflow, ret; - char *key, *def_str; - - ret = SRD_ERR_PYTHON; - key = NULL; + GVariant *gvar; + gint64 lval; + double dval; + int overflow; + char *sval; if (!PyObject_HasAttrString(d->py_dec, "options")) - /* That's fine. */ + /* No options, that's fine. */ return SRD_OK; - /* If present, options must be a dictionary. */ + /* If present, options must be a tuple. */ py_opts = PyObject_GetAttrString(d->py_dec, "options"); - if (!PyDict_Check(py_opts)) { - srd_err("Protocol decoder %s options attribute is not " - "a dictionary.", d->name); - goto err_out; + if (!PyTuple_Check(py_opts)) { + srd_err("Protocol decoder %s: options attribute is not " + "a tuple.", d->id); + return SRD_ERR_PYTHON; } - py_keys = PyDict_Keys(py_opts); - py_values = PyDict_Values(py_opts); - num_keys = PyList_Size(py_keys); - for (i = 0; i < num_keys; i++) { - py_str_as_str(PyList_GetItem(py_keys, i), &key); - srd_dbg("option '%s'", key); - py_val = PyList_GetItem(py_values, i); - if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) { - srd_err("Protocol decoder %s option '%s' value must be " - "a list with two elements.", d->name, key); - goto err_out; - } - py_desc = PyList_GetItem(py_val, 0); - if (!PyUnicode_Check(py_desc)) { - srd_err("Protocol decoder %s option '%s' has no " - "description.", d->name, key); - goto err_out; + for (opt = 0; opt < PyTuple_Size(py_opts); opt++) { + py_opt = PyTuple_GetItem(py_opts, opt); + if (!PyDict_Check(py_opt)) { + srd_err("Protocol decoder %s options: each option " + "must consist of a dictionary.", d->name); + return SRD_ERR_PYTHON; } - py_default = PyList_GetItem(py_val, 1); - if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) { - srd_err("Protocol decoder %s option '%s' has default " - "of unsupported type '%s'.", d->name, key, - Py_TYPE(py_default)->tp_name); - goto err_out; + if (!(py_val = PyDict_GetItemString(py_opt, "id"))) { + srd_err("Protocol decoder %s option %d has no " + "id.", d->name); + return SRD_ERR_PYTHON; } - if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) { - srd_err("option malloc failed"); - goto err_out; + o = g_malloc0(sizeof(struct srd_decoder_option)); + py_str_as_str(py_val, &o->id); + + if ((py_val = PyDict_GetItemString(py_opt, "desc"))) + py_str_as_str(py_val, &o->desc); + + if ((py_default = PyDict_GetItemString(py_opt, "default"))) { + if (PyUnicode_Check(py_default)) { + /* UTF-8 string */ + py_str_as_str(py_default, &sval); + o->def = g_variant_new_string(sval); + g_free(sval); + } else if (PyLong_Check(py_default)) { + /* Long */ + lval = PyLong_AsLongAndOverflow(py_default, &overflow); + if (overflow) { + /* Value is < LONG_MIN or > LONG_MAX */ + PyErr_Clear(); + srd_err("Protocol decoder %s option 'default' has " + "invalid default value.", d->name); + return SRD_ERR_PYTHON; + } + o->def = g_variant_new_int64(lval); + } else if (PyFloat_Check(py_default)) { + /* Float */ + if ((dval = PyFloat_AsDouble(py_default)) == -1.0) { + PyErr_Clear(); + srd_err("Protocol decoder %s option 'default' has " + "invalid default value.", d->name); + return SRD_ERR_PYTHON; + } + o->def = g_variant_new_double(dval); + } else { + srd_err("Protocol decoder %s option 'default' has " + "value of unsupported type '%s'.", d->name, + Py_TYPE(py_default)->tp_name); + return SRD_ERR_PYTHON; + } + g_variant_ref_sink(o->def); } - o->id = g_strdup(key); - py_str_as_str(py_desc, &o->desc); - if (PyUnicode_Check(py_default)) { - /* UTF-8 string */ - py_str_as_str(py_default, &def_str); - o->def = g_variant_new_string(def_str); - g_free(def_str); - } else { - /* Long */ - def_long = PyLong_AsLongAndOverflow(py_default, &overflow); - if (overflow) { - /* Value is < LONG_MIN or > LONG_MAX */ - PyErr_Clear(); - srd_err("Protocol decoder %s option '%s' has " - "invalid default value.", d->name, key); - goto err_out; + + if ((py_val = PyDict_GetItemString(py_opt, "values"))) { + /* A default is required if a list of values is + * given, since it's used to verify their type. */ + if (!o->def) { + srd_err("No default for option '%s'", o->id); + return SRD_ERR_PYTHON; + } + if (!PyTuple_Check(py_val)) { + srd_err("Option '%s' values should be a tuple.", o->id); + return SRD_ERR_PYTHON; + } + for (i = 0; i < PyTuple_Size(py_val); i++) { + py_item = PyTuple_GetItem(py_val, i); + if (Py_TYPE(py_default) != Py_TYPE(py_item)) { + srd_err("All values for option '%s' must be " + "of the same type as the default.", + o->id); + return SRD_ERR_PYTHON; + } + if (PyUnicode_Check(py_item)) { + /* UTF-8 string */ + py_str_as_str(py_item, &sval); + gvar = g_variant_new_string(sval); + g_variant_ref_sink(gvar); + g_free(sval); + o->values = g_slist_append(o->values, gvar); + } else if (PyLong_Check(py_item)) { + /* Long */ + lval = PyLong_AsLongAndOverflow(py_item, &overflow); + if (overflow) { + /* Value is < LONG_MIN or > LONG_MAX */ + PyErr_Clear(); + srd_err("Protocol decoder %s option 'values' " + "has invalid value.", d->name); + return SRD_ERR_PYTHON; + } + gvar = g_variant_new_int64(lval); + g_variant_ref_sink(gvar); + o->values = g_slist_append(o->values, gvar); + } else if (PyFloat_Check(py_item)) { + /* Float */ + if ((dval = PyFloat_AsDouble(py_item)) == -1.0) { + PyErr_Clear(); + srd_err("Protocol decoder %s option 'default' has " + "invalid default value.", d->name); + return SRD_ERR_PYTHON; + } + gvar = g_variant_new_double(dval); + g_variant_ref_sink(gvar); + o->values = g_slist_append(o->values, gvar); + } } - o->def = g_variant_new_int64(def_long); } - g_variant_ref_sink(o->def); d->options = g_slist_append(d->options, o); - g_free(key); - key = NULL; } - Py_DecRef(py_keys); - Py_DecRef(py_values); - ret = SRD_OK; - -err_out: - Py_XDECREF(py_opts); - g_free(key); - - return ret; + return SRD_OK; } /** @@ -250,13 +306,15 @@ err_out: */ SRD_API int srd_decoder_load(const char *module_name) { - PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann, \ - *py_bin_classes, *py_bin_class; + PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann; + PyObject *py_bin_classes, *py_bin_class, *py_ann_rows, *py_ann_row; + PyObject *py_ann_classes, *py_long; struct srd_decoder *d; - int len, ret, i; - char **ann, *bin; - struct srd_probe *p; - GSList *l; + int ret, i, j; + char **ann, **bin, *ann_row_id, *ann_row_desc; + struct srd_channel *pdch; + GSList *l, *ann_classes; + struct srd_decoder_annotation_row *ann_row; if (!srd_check_init()) return SRD_ERR; @@ -308,6 +366,17 @@ SRD_API int srd_decoder_load(const char *module_name) } Py_CLEAR(py_basedec); + /* + * Check that thіs decoder has the correct PD API version. + * PDs of different API versions are incompatible and cannot work. + */ + py_long = PyObject_GetAttrString(d->py_dec, "api_version"); + if (PyLong_AsLong(py_long) != 2) { + srd_err("Only PDs of API version 2 are supported."); + goto err_out; + } + Py_CLEAR(py_long); + /* Check for a proper start() method. */ if (!PyObject_HasAttrString(d->py_dec, "start")) { srd_err("Protocol decoder %s has no start() method Decoder " @@ -336,30 +405,6 @@ SRD_API int srd_decoder_load(const char *module_name) } Py_CLEAR(py_method); - if (get_options(d) != SRD_OK) - goto err_out; - - /* Check and import required probes. */ - if (get_probes(d, "probes", &d->probes) != SRD_OK) - goto err_out; - - /* Check and import optional probes. */ - if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK) - goto err_out; - - /* - * Fix order numbers for the optional probes. - * - * Example: - * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4. - * 'order' fields in the d->probes list = 0, 1, 2. - * 'order' fields in the d->opt_probes list = 3, 4, 5, 6. - */ - for (l = d->opt_probes; l; l = l->next) { - p = l->data; - p->order += g_slist_length(d->probes); - } - /* Store required fields in newly allocated strings. */ if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) goto err_out; @@ -376,51 +421,133 @@ SRD_API int srd_decoder_load(const char *module_name) if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) goto err_out; + /* All options and their default values. */ + if (get_options(d) != SRD_OK) + goto err_out; + + /* Check and import required channels. */ + if (get_channels(d, "channels", &d->channels) != SRD_OK) + goto err_out; + + /* Check and import optional channels. */ + if (get_channels(d, "optional_channels", &d->opt_channels) != SRD_OK) + goto err_out; + + /* + * Fix order numbers for the optional channels. + * + * Example: + * Required channels: r1, r2, r3. Optional: o1, o2, o3, o4. + * 'order' fields in the d->channels list = 0, 1, 2. + * 'order' fields in the d->opt_channels list = 3, 4, 5, 6. + */ + for (l = d->opt_channels; l; l = l->next) { + pdch = l->data; + pdch->order += g_slist_length(d->channels); + } + /* Convert annotation class attribute to GSList of char **. */ d->annotations = NULL; if (PyObject_HasAttrString(d->py_dec, "annotations")) { py_annlist = PyObject_GetAttrString(d->py_dec, "annotations"); - if (!PyList_Check(py_annlist)) { - srd_err("Protocol decoder module %s annotations " - "should be a list.", module_name); + if (!PyTuple_Check(py_annlist)) { + srd_err("Protocol decoder %s annotations should " + "be a tuple.", module_name); goto err_out; } - len = PyList_Size(py_annlist); - for (i = 0; i < len; i++) { - py_ann = PyList_GetItem(py_annlist, i); - if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) { - srd_err("Protocol decoder module %s " - "annotation %d should be a list with " - "two elements.", module_name, i + 1); + for (i = 0; i < PyTuple_Size(py_annlist); i++) { + py_ann = PyTuple_GetItem(py_annlist, i); + if (!PyTuple_Check(py_ann) || PyTuple_Size(py_ann) != 2) { + srd_err("Protocol decoder %s annotation %d should " + "be a tuple with two elements.", module_name, i + 1); goto err_out; } - if (py_strlist_to_char(py_ann, &ann) != SRD_OK) { + if (py_strseq_to_char(py_ann, &ann) != SRD_OK) { goto err_out; } d->annotations = g_slist_append(d->annotations, ann); } } + /* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */ + d->annotation_rows = NULL; + if (PyObject_HasAttrString(d->py_dec, "annotation_rows")) { + py_ann_rows = PyObject_GetAttrString(d->py_dec, "annotation_rows"); + if (!PyTuple_Check(py_ann_rows)) { + srd_err("Protocol decoder %s annotation row list " + "must be a tuple.", module_name); + goto err_out; + } + for (i = 0; i < PyTuple_Size(py_ann_rows); i++) { + py_ann_row = PyTuple_GetItem(py_ann_rows, i); + if (!PyTuple_Check(py_ann_row)) { + srd_err("Protocol decoder %s annotation rows " + "must be tuples.", module_name); + goto err_out; + } + if (PyTuple_Size(py_ann_row) != 3 + || !PyUnicode_Check(PyTuple_GetItem(py_ann_row, 0)) + || !PyUnicode_Check(PyTuple_GetItem(py_ann_row, 1)) + || !PyTuple_Check(PyTuple_GetItem(py_ann_row, 2))) { + srd_err("Protocol decoder %s annotation rows " + "must contain tuples containing two " + "strings and a tuple.", module_name); + goto err_out; + } + + if (py_str_as_str(PyTuple_GetItem(py_ann_row, 0), &ann_row_id) != SRD_OK) + goto err_out; + + if (py_str_as_str(PyTuple_GetItem(py_ann_row, 1), &ann_row_desc) != SRD_OK) + goto err_out; + + py_ann_classes = PyTuple_GetItem(py_ann_row, 2); + ann_classes = NULL; + for (j = 0; j < PyTuple_Size(py_ann_classes); j++) { + py_long = PyTuple_GetItem(py_ann_classes, j); + if (!PyLong_Check(py_long)) { + srd_err("Protocol decoder %s annotation row class " + "list must only contain numbers.", module_name); + goto err_out; + } + ann_classes = g_slist_append(ann_classes, + GINT_TO_POINTER(PyLong_AsLong(py_long))); + } + + ann_row = g_malloc0(sizeof(struct srd_decoder_annotation_row)); + ann_row->id = ann_row_id; + ann_row->desc = ann_row_desc; + ann_row->ann_classes = ann_classes; + d->annotation_rows = g_slist_append(d->annotation_rows, ann_row); + } + } + /* Convert binary class to GSList of char *. */ d->binary = NULL; if (PyObject_HasAttrString(d->py_dec, "binary")) { py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary"); if (!PyTuple_Check(py_bin_classes)) { - srd_err("Protocol decoder module %s binary classes " - "should be a tuple.", module_name); + srd_err("Protocol decoder %s binary classes should " + "be a tuple.", module_name); goto err_out; } - len = PyTuple_Size(py_bin_classes); - for (i = 0; i < len; i++) { + for (i = 0; i < PyTuple_Size(py_bin_classes); i++) { py_bin_class = PyTuple_GetItem(py_bin_classes, i); - if (!PyUnicode_Check(py_bin_class)) { - srd_err("Protocol decoder module %s binary " - "class should be a string.", module_name); + if (!PyTuple_Check(py_bin_class)) { + srd_err("Protocol decoder %s binary classes " + "should consist of tuples.", module_name); + goto err_out; + } + if (PyTuple_Size(py_bin_class) != 2 + || !PyUnicode_Check(PyTuple_GetItem(py_bin_class, 0)) + || !PyUnicode_Check(PyTuple_GetItem(py_bin_class, 1))) { + srd_err("Protocol decoder %s binary classes should " + "contain tuples with two strings.", module_name); goto err_out; } - if (py_str_as_str(py_bin_class, &bin) != SRD_OK) { + if (py_strseq_to_char(py_bin_class, &bin) != SRD_OK) { goto err_out; } d->binary = g_slist_append(d->binary, bin); @@ -481,22 +608,22 @@ SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec) return doc; } -static void free_probes(GSList *probelist) +static void free_channels(GSList *channellist) { GSList *l; - struct srd_probe *p; + struct srd_channel *pdch; - if (probelist == NULL) + if (channellist == NULL) return; - for (l = probelist; l; l = l->next) { - p = l->data; - g_free(p->id); - g_free(p->name); - g_free(p->desc); - g_free(p); + for (l = channellist; l; l = l->next) { + pdch = l->data; + g_free(pdch->id); + g_free(pdch->name); + g_free(pdch->desc); + g_free(pdch); } - g_slist_free(probelist); + g_slist_free(channellist); } /** @@ -542,8 +669,8 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec) } g_slist_free(dec->options); - free_probes(dec->probes); - free_probes(dec->opt_probes); + free_channels(dec->channels); + free_channels(dec->opt_channels); g_free(dec->id); g_free(dec->name); g_free(dec->longname); @@ -560,14 +687,98 @@ SRD_API int srd_decoder_unload(struct srd_decoder *dec) return SRD_OK; } +static void srd_decoder_load_all_zip_path(char *path) +{ + PyObject *zipimport_mod, *zipimporter_class, *zipimporter; + PyObject *prefix_obj, *files, *key, *value, *set, *modname; + Py_ssize_t pos = 0; + char *prefix; + size_t prefix_len; + + set = files = prefix_obj = zipimporter = zipimporter_class = NULL; + + zipimport_mod = PyImport_ImportModule("zipimport"); + if (zipimport_mod == NULL) + goto err_out; + + zipimporter_class = PyObject_GetAttrString(zipimport_mod, "zipimporter"); + if (zipimporter_class == NULL) + goto err_out; + + zipimporter = PyObject_CallFunction(zipimporter_class, "s", path); + if (zipimporter == NULL) + goto err_out; + + prefix_obj = PyObject_GetAttrString(zipimporter, "prefix"); + if (prefix_obj == NULL) + goto err_out; + + files = PyObject_GetAttrString(zipimporter, "_files"); + if (files == NULL) + goto err_out; + + set = PySet_New(NULL); + if (set == NULL) + goto err_out; + + if (py_str_as_str(prefix_obj, &prefix) != SRD_OK) + goto err_out; + + prefix_len = strlen(prefix); + + while (PyDict_Next(files, &pos, &key, &value)) { + char *path, *slash; + if (py_str_as_str(key, &path) == SRD_OK) { + if (strlen(path) > prefix_len && + !memcmp(path, prefix, prefix_len) && + (slash = strchr(path+prefix_len, '/'))) { + modname = + PyUnicode_FromStringAndSize(path+prefix_len, + slash-(path+prefix_len)); + if (modname == NULL) { + PyErr_Clear(); + } else { + PySet_Add(set, modname); + Py_XDECREF(modname); + } + } + free(path); + } + } + + free(prefix); + + while ((modname = PySet_Pop(set))) { + char *modname_str; + if (py_str_as_str(modname, &modname_str) == SRD_OK) { + /* The directory name is the module name (e.g. "i2c"). */ + srd_decoder_load(modname_str); + free(modname_str); + } + Py_XDECREF(modname); + } + +err_out: + Py_XDECREF(set); + Py_XDECREF(files); + Py_XDECREF(prefix_obj); + Py_XDECREF(zipimporter); + Py_XDECREF(zipimporter_class); + Py_XDECREF(zipimport_mod); + PyErr_Clear(); +} + static void srd_decoder_load_all_path(char *path) { GDir *dir; const gchar *direntry; - if (!(dir = g_dir_open(path, 0, NULL))) + if (!(dir = g_dir_open(path, 0, NULL))) { /* Not really fatal */ + /* Try zipimport method too */ + srd_decoder_load_all_zip_path(path); return; + } /* This ignores errors returned by srd_decoder_load(). That * function will have logged the cause, but in any case we