X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=e3f847d205ea7db534ad9e93b2372fb7bf057774;hp=d0e5734a14971058d1e27224afa2dad30b68418e;hb=582c8473ffd456dfb0796974ef2c0b1b78de38a8;hpb=f38ec2855ce41154bc1035dd7f1ab9a21f411f0d diff --git a/decoder.c b/decoder.c index d0e5734..e3f847d 100644 --- a/decoder.c +++ b/decoder.c @@ -2,7 +2,7 @@ * This file is part of the sigrok project. * * Copyright (C) 2010 Uwe Hermann - * Copyright (C) 2011 Bert Vermeulen + * Copyright (C) 2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -24,11 +24,10 @@ #include /* The list of protocol decoders. */ -GSList *pd_list = NULL; - -/* lives in module_sigrokdecode.c */ -extern PyObject *mod_sigrokdecode; +SRD_PRIV GSList *pd_list = NULL; +/* module_sigrokdecode.c */ +extern SRD_PRIV PyObject *mod_sigrokdecode; /** * Returns the list of supported/loaded protocol decoders. @@ -37,20 +36,19 @@ extern PyObject *mod_sigrokdecode; * * @return List of decoders, NULL if none are supported or loaded. */ -GSList *srd_list_decoders(void) +SRD_API GSList *srd_list_decoders(void) { - return pd_list; } - /** * Get the decoder with the specified ID. * * @param id The ID string of the decoder to return. + * * @return The decoder with the specified ID, or NULL if not found. */ -struct srd_decoder *srd_get_decoder_by_id(const char *id) +SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id) { GSList *l; struct srd_decoder *dec; @@ -64,7 +62,6 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id) return NULL; } - static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) { PyObject *py_probelist, *py_entry; @@ -81,7 +78,7 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) py_probelist = PyObject_GetAttrString(d->py_dec, attr); if (!PyList_Check(py_probelist)) { srd_err("Protocol decoder %s %s attribute is not " - "a list.", d->name, attr); + "a list.", d->name, attr); goto err_out; } @@ -94,11 +91,12 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) py_entry = PyList_GetItem(py_probelist, i); if (!PyDict_Check(py_entry)) { srd_err("Protocol decoder %s %s attribute is not " - "a list with dict elements.", d->name, attr); + "a list with dict elements.", d->name, attr); goto err_out; } if (!(p = g_try_malloc(sizeof(struct srd_probe)))) { + srd_err("Failed to g_malloc() struct srd_probe."); ret = SRD_ERR_MALLOC; goto err_out; } @@ -130,19 +128,19 @@ err_out: * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_load_decoder(const char *name, struct srd_decoder **dec) +SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec) { PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann; struct srd_decoder *d; int alen, ret, i; char **ann; - py_basedec = py_method = py_attr = NULL; + srd_dbg("Loading module '%s'.", name); - srd_dbg("decoder: %s: loading module '%s'", __func__, name); + py_basedec = py_method = py_attr = NULL; if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) { - srd_err("decoder: %s: d malloc failed", __func__); + srd_dbg("Failed to g_malloc() struct srd_decoder."); ret = SRD_ERR_MALLOC; goto err_out; } @@ -151,68 +149,65 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) /* Import the Python module. */ if (!(d->py_mod = PyImport_ImportModule(name))) { - /* TODO: Report exception message/traceback to err/dbg. */ - srd_warn("decoder: %s: import of '%s' failed", __func__, name); - PyErr_Print(); - PyErr_Clear(); + catch_exception("import of '%s' failed.", name); goto err_out; } /* Get the 'Decoder' class as Python object. */ if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) { /* This generated an AttributeError exception. */ - PyErr_Print(); PyErr_Clear(); - srd_err("Decoder class not found in protocol decoder %s", name); + srd_err("Decoder class not found in protocol decoder %s.", name); goto err_out; } if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) { - srd_dbg("sigrokdecode module not loaded"); + srd_dbg("sigrokdecode module not loaded."); goto err_out; } if (!PyObject_IsSubclass(d->py_dec, py_basedec)) { srd_err("Decoder class in protocol decoder module %s is not " - "a subclass of sigrokdecode.Decoder", name); + "a subclass of sigrokdecode.Decoder.", name); goto err_out; } - Py_DecRef(py_basedec); + Py_CLEAR(py_basedec); /* Check for a proper start() method. */ if (!PyObject_HasAttrString(d->py_dec, "start")) { srd_err("Protocol decoder %s has no start() method Decoder " - "class.", name); + "class.", name); goto err_out; } py_method = PyObject_GetAttrString(d->py_dec, "start"); if (!PyFunction_Check(py_method)) { - srd_err("Protocol decoder %s Decoder class attribute 'start'" - "is not a method.", name); + srd_err("Protocol decoder %s Decoder class attribute 'start' " + "is not a method.", name); goto err_out; } - Py_DecRef(py_method); + Py_CLEAR(py_method); /* Check for a proper decode() method. */ if (!PyObject_HasAttrString(d->py_dec, "decode")) { srd_err("Protocol decoder %s has no decode() method Decoder " - "class.", name); + "class.", name); goto err_out; } py_method = PyObject_GetAttrString(d->py_dec, "decode"); if (!PyFunction_Check(py_method)) { srd_err("Protocol decoder %s Decoder class attribute 'decode' " - "is not a method.", name); + "is not a method.", name); goto err_out; } - Py_DecRef(py_method); + Py_CLEAR(py_method); /* If present, options must be a dictionary. */ if (PyObject_HasAttrString(d->py_dec, "options")) { py_attr = PyObject_GetAttrString(d->py_dec, "options"); if (!PyDict_Check(py_attr)) { srd_err("Protocol decoder %s options attribute is not " - "a dictionary.", d->name); + "a dictionary.", d->name); + Py_DecRef(py_attr); goto err_out; } Py_DecRef(py_attr); @@ -223,7 +218,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) goto err_out; /* Check and import optional probes. */ - if (get_probes(d, "extra_probes", &d->extra_probes) != SRD_OK) + if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK) goto err_out; /* Store required fields in newly allocated strings. */ @@ -251,15 +246,17 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) 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", name); + srd_err("Protocol decoder module %s annotations " + "should be a list.", name); goto err_out; } alen = PyList_Size(py_annlist); for (i = 0; i < alen; 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", - name, i+1); + srd_err("Protocol decoder module %s " + "annotation %d should be a list with " + "two elements.", name, i + 1); goto err_out; } @@ -285,7 +282,15 @@ err_out: return ret; } -char *srd_decoder_doc(struct srd_decoder *dec) +/** + * Return a protocol decoder's docstring. + * + * @param dec The loaded protocol decoder. + * + * @return A newly allocated buffer containing the docstring. The caller should + * free this after use. + */ +SRD_API char *srd_decoder_doc(struct srd_decoder *dec) { PyObject *py_str; char *doc; @@ -294,7 +299,7 @@ char *srd_decoder_doc(struct srd_decoder *dec) return NULL; if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) { - PyErr_Clear(); + catch_exception(""); return NULL; } @@ -306,17 +311,44 @@ char *srd_decoder_doc(struct srd_decoder *dec) return doc; } +static void free_probes(GSList *probelist) +{ + GSList *l; + struct srd_probe *p; + + if (probelist == 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); + } + g_slist_free(probelist); + +} /** * Unload decoder module. * - * @param dec The decoder struct to be unloaded. + * @param dec The struct srd_decoder to be unloaded. * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_unload_decoder(struct srd_decoder *dec) +SRD_API int srd_unload_decoder(struct srd_decoder *dec) { + srd_dbg("unloading decoder %s", dec->name); + /* Since any instances of this decoder need to be released as well, + * but they could be anywhere in the stack, just free the entire + * stack. A frontend reloading a decoder thus has to restart all + * instances, and rebuild the stack. */ + srd_inst_free_all(NULL); + + free_probes(dec->probes); + free_probes(dec->opt_probes); g_free(dec->id); g_free(dec->name); g_free(dec->longname); @@ -329,7 +361,9 @@ int srd_unload_decoder(struct srd_decoder *dec) if (dec->outputformats != NULL) g_slist_free(dec->outputformats); + /* The module's Decoder class. */ Py_XDECREF(dec->py_dec); + /* The module itself. */ Py_XDECREF(dec->py_mod); /* TODO: (g_)free dec itself? */ @@ -337,7 +371,12 @@ int srd_unload_decoder(struct srd_decoder *dec) return SRD_OK; } -int srd_load_all_decoders(void) +/** + * Load all protocol decoders libsigrokdecode knows about. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + */ +SRD_API int srd_load_all_decoders(void) { GDir *dir; GError *error; @@ -354,14 +393,6 @@ int srd_load_all_decoders(void) /* The decoder name is the PD directory name (e.g. "i2c"). */ decodername = g_strdup(direntry); - /* TODO: Error handling. Use g_try_malloc(). */ - if (!(dec = malloc(sizeof(struct srd_decoder)))) { - Py_Finalize(); /* Returns void. */ - return SRD_ERR_MALLOC; - } - - /* Load the decoder. */ - /* TODO: Warning if loading fails for a decoder. */ if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) { /* Append it to the list of supported/loaded decoders. */ pd_list = g_slist_append(pd_list, dec); @@ -373,21 +404,19 @@ int srd_load_all_decoders(void) } /** - * TODO + * Unload all loaded protocol decoders. + * + * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_unload_all_decoders(void) +SRD_API int srd_unload_all_decoders(void) { GSList *l; struct srd_decoder *dec; for (l = srd_list_decoders(); l; l = l->next) { dec = l->data; - /* TODO: Error handling. */ srd_unload_decoder(dec); } return SRD_OK; } - - -