/** @cond PRIVATE */
-/* The list of protocol decoders. */
+/* The list of loaded protocol decoders. */
static GSList *pd_list = NULL;
/* srd.c */
}
/**
- * Returns the list of supported/loaded protocol decoders.
+ * Returns the list of loaded protocol decoders.
*
* This is a GSList of pointers to struct srd_decoder items.
*
static void decoder_free(struct srd_decoder *dec)
{
+ PyGILState_STATE gstate;
+
if (!dec)
return;
+ gstate = PyGILState_Ensure();
Py_XDECREF(dec->py_dec);
Py_XDECREF(dec->py_mod);
+ PyGILState_Release(gstate);
g_slist_free_full(dec->options, &decoder_option_free);
g_slist_free_full(dec->binary, (GDestroyNotify)&g_strfreev);
g_slist_free_full(dec->opt_channels, &channel_free);
g_slist_free_full(dec->channels, &channel_free);
+ g_slist_free_full(dec->outputs, g_free);
+ g_slist_free_full(dec->inputs, g_free);
g_free(dec->license);
g_free(dec->desc);
g_free(dec->longname);
struct srd_channel *pdch;
GSList *pdchl;
ssize_t i;
+ PyGILState_STATE gstate;
+
+ gstate = PyGILState_Ensure();
- if (!PyObject_HasAttrString(d->py_dec, attr))
+ if (!PyObject_HasAttrString(d->py_dec, attr)) {
/* No channels of this type specified. */
+ PyGILState_Release(gstate);
return SRD_OK;
+ }
pdchl = NULL;
"a list of dict elements.", d->name, attr);
goto err_out;
}
- pdch = g_malloc0(sizeof(struct srd_channel));
+ pdch = g_malloc(sizeof(struct srd_channel));
/* Add to list right away so it doesn't get lost. */
pdchl = g_slist_prepend(pdchl, pdch);
Py_DECREF(py_channellist);
*out_pdchl = pdchl;
+ PyGILState_Release(gstate);
+
return SRD_OK;
except_out:
srd_exception_catch("Failed to get %s list of %s decoder",
attr, d->name);
+
err_out:
g_slist_free_full(pdchl, &channel_free);
Py_XDECREF(py_channellist);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
struct srd_decoder_option *o;
GVariant *gvar;
ssize_t opt, i;
+ PyGILState_STATE gstate;
+
+ gstate = PyGILState_Ensure();
- if (!PyObject_HasAttrString(d->py_dec, "options"))
+ if (!PyObject_HasAttrString(d->py_dec, "options")) {
/* No options, that's fine. */
+ PyGILState_Release(gstate);
return SRD_OK;
+ }
options = NULL;
py_str = PyDict_GetItemString(py_opt, "id");
if (!py_str) {
- srd_err("Protocol decoder %s option %zd has no id.",
+ srd_err("Protocol decoder %s option %zd has no ID.",
d->name, opt);
goto err_out;
}
py_values = PyDict_GetItemString(py_opt, "values");
if (py_values) {
- /* A default is required if a list of values is
- * given, since it's used to verify their type. */
+ /*
+ * 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);
goto err_out;
if (!py_item)
goto except_out;
- if (Py_TYPE(py_default) != Py_TYPE(py_item)) {
+ if (py_default && (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);
}
d->options = options;
Py_DECREF(py_opts);
+ PyGILState_Release(gstate);
return SRD_OK;
except_out:
srd_exception_catch("Failed to get %s decoder options", d->name);
+
err_out:
g_slist_free_full(options, &decoder_option_free);
Py_XDECREF(py_opts);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
-/* Convert annotation class attribute to GSList of char **.
- */
+/* Convert annotation class attribute to GSList of char **. */
static int get_annotations(struct srd_decoder *dec)
{
PyObject *py_annlist, *py_ann;
GSList *annotations;
char **annpair;
ssize_t i;
+ PyGILState_STATE gstate;
- if (!PyObject_HasAttrString(dec->py_dec, "annotations"))
+ gstate = PyGILState_Ensure();
+
+ if (!PyObject_HasAttrString(dec->py_dec, "annotations")) {
+ PyGILState_Release(gstate);
return SRD_OK;
+ }
annotations = NULL;
}
dec->annotations = annotations;
Py_DECREF(py_annlist);
+ PyGILState_Release(gstate);
return SRD_OK;
except_out:
srd_exception_catch("Failed to get %s decoder annotations", dec->name);
+
err_out:
g_slist_free_full(annotations, (GDestroyNotify)&g_strfreev);
Py_XDECREF(py_annlist);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
-/* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'.
- */
+/* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */
static int get_annotation_rows(struct srd_decoder *dec)
{
PyObject *py_ann_rows, *py_ann_row, *py_ann_classes, *py_item;
struct srd_decoder_annotation_row *ann_row;
ssize_t i, k;
size_t class_idx;
+ PyGILState_STATE gstate;
+
+ gstate = PyGILState_Ensure();
- if (!PyObject_HasAttrString(dec->py_dec, "annotation_rows"))
+ if (!PyObject_HasAttrString(dec->py_dec, "annotation_rows")) {
+ PyGILState_Release(gstate);
return SRD_OK;
+ }
annotation_rows = NULL;
}
dec->annotation_rows = annotation_rows;
Py_DECREF(py_ann_rows);
+ PyGILState_Release(gstate);
return SRD_OK;
except_out:
srd_exception_catch("Failed to get %s decoder annotation rows",
dec->name);
+
err_out:
g_slist_free_full(annotation_rows, &annotation_row_free);
Py_XDECREF(py_ann_rows);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
-/* Convert binary classes to GSList of char **.
- */
+/* Convert binary classes to GSList of char **. */
static int get_binary_classes(struct srd_decoder *dec)
{
PyObject *py_bin_classes, *py_bin_class;
GSList *bin_classes;
char **bin;
ssize_t i;
+ PyGILState_STATE gstate;
+
+ gstate = PyGILState_Ensure();
- if (!PyObject_HasAttrString(dec->py_dec, "binary"))
+ if (!PyObject_HasAttrString(dec->py_dec, "binary")) {
+ PyGILState_Release(gstate);
return SRD_OK;
+ }
bin_classes = NULL;
}
dec->binary = bin_classes;
Py_DECREF(py_bin_classes);
+ PyGILState_Release(gstate);
return SRD_OK;
except_out:
srd_exception_catch("Failed to get %s decoder binary classes",
dec->name);
+
err_out:
g_slist_free_full(bin_classes, (GDestroyNotify)&g_strfreev);
Py_XDECREF(py_bin_classes);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
-/* Check whether the Decoder class defines the named method.
- */
+/* Check whether the Decoder class defines the named method. */
static int check_method(PyObject *py_dec, const char *mod_name,
const char *method_name)
{
PyObject *py_method;
int is_callable;
+ PyGILState_STATE gstate;
+
+ gstate = PyGILState_Ensure();
py_method = PyObject_GetAttrString(py_dec, method_name);
if (!py_method) {
srd_exception_catch("Protocol decoder %s Decoder class "
"has no %s() method", mod_name, method_name);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
is_callable = PyCallable_Check(py_method);
Py_DECREF(py_method);
+ PyGILState_Release(gstate);
+
if (!is_callable) {
srd_err("Protocol decoder %s Decoder class attribute '%s' "
"is not a method.", mod_name, method_name);
return SRD_OK;
}
+/**
+ * Get the API version of the specified decoder.
+ *
+ * @param d The decoder to use. Must not be NULL.
+ *
+ * @return The API version of the decoder, or 0 upon errors.
+ *
+ * @private
+ */
+SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d)
+{
+ PyObject *py_apiver;
+ long apiver;
+ PyGILState_STATE gstate;
+
+ if (!d)
+ return 0;
+
+ gstate = PyGILState_Ensure();
+
+ py_apiver = PyObject_GetAttrString(d->py_dec, "api_version");
+ apiver = (py_apiver && PyLong_Check(py_apiver))
+ ? PyLong_AsLong(py_apiver) : 0;
+ Py_XDECREF(py_apiver);
+
+ PyGILState_Release(gstate);
+
+ return apiver;
+}
+
/**
* Load a protocol decoder module into the embedded Python interpreter.
*
*/
SRD_API int srd_decoder_load(const char *module_name)
{
- PyObject *py_modname, *py_basedec, *py_apiver;
+ PyObject *py_basedec;
struct srd_decoder *d;
long apiver;
int is_subclass;
+ const char *fail_txt;
+ PyGILState_STATE gstate;
if (!srd_check_init())
return SRD_ERR;
if (!module_name)
return SRD_ERR_ARG;
+ gstate = PyGILState_Ensure();
+
if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) {
/* Module was already imported. */
+ PyGILState_Release(gstate);
return SRD_OK;
}
- srd_dbg("Loading protocol decoder '%s'.", module_name);
-
d = g_malloc0(sizeof(struct srd_decoder));
+ fail_txt = NULL;
- /* Import the Python module. */
- py_modname = PyUnicode_FromString(module_name);
- if (!py_modname)
- goto except_out;
-
- d->py_mod = PyImport_Import(py_modname);
- Py_DECREF(py_modname);
- if (!d->py_mod)
+ d->py_mod = py_import_by_name(module_name);
+ if (!d->py_mod) {
+ fail_txt = "import by name failed";
goto except_out;
+ }
if (!mod_sigrokdecode) {
srd_err("sigrokdecode module not loaded.");
+ fail_txt = "sigrokdecode(3) not loaded";
goto err_out;
}
/* Get the 'Decoder' class as Python object. */
d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder");
- if (!d->py_dec)
+ if (!d->py_dec) {
+ fail_txt = "no 'Decoder' attribute in imported module";
goto except_out;
+ }
py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder");
- if (!py_basedec)
+ if (!py_basedec) {
+ fail_txt = "no 'Decoder' attribute in sigrokdecode(3)";
goto except_out;
+ }
is_subclass = PyObject_IsSubclass(d->py_dec, py_basedec);
Py_DECREF(py_basedec);
if (!is_subclass) {
srd_err("Decoder class in protocol decoder module %s is not "
"a subclass of sigrokdecode.Decoder.", module_name);
+ fail_txt = "not a subclass of sigrokdecode.Decoder";
goto err_out;
}
* Check that this decoder has the correct PD API version.
* PDs of different API versions are incompatible and cannot work.
*/
- py_apiver = PyObject_GetAttrString(d->py_dec, "api_version");
- apiver = (py_apiver && PyLong_Check(py_apiver))
- ? PyLong_AsLong(py_apiver) : 0;
- Py_XDECREF(py_apiver);
-
- if (apiver != 2) {
- srd_exception_catch("Only PDs of API version 2 are supported");
+ apiver = srd_decoder_apiver(d);
+ if (apiver != 3) {
+ srd_exception_catch("Only PD API version 3 is supported, "
+ "decoder %s has version %ld", module_name, apiver);
+ fail_txt = "API version mismatch";
goto err_out;
}
- /* Check Decoder class for required methods.
- */
- if (check_method(d->py_dec, module_name, "start") != SRD_OK)
+ /* Check Decoder class for required methods. */
+
+ if (check_method(d->py_dec, module_name, "start") != SRD_OK) {
+ fail_txt = "no 'start()' method";
goto err_out;
+ }
- if (check_method(d->py_dec, module_name, "decode") != SRD_OK)
+ if (check_method(d->py_dec, module_name, "decode") != SRD_OK) {
+ fail_txt = "no 'decode()' method";
goto err_out;
+ }
/* Store required fields in newly allocated strings. */
- if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
+ if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) {
+ fail_txt = "no 'id' attribute";
+ goto err_out;
+ }
+
+ if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) {
+ fail_txt = "no 'name' attribute";
goto err_out;
+ }
+
+ if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) {
+ fail_txt = "no 'longname' attribute";
+ goto err_out;
+ }
- if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
+ if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) {
+ fail_txt = "no 'desc' attribute";
goto err_out;
+ }
- if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
+ if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) {
+ fail_txt = "no 'license' attribute";
goto err_out;
+ }
- if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
+ if (py_attr_as_strlist(d->py_dec, "inputs", &(d->inputs)) != SRD_OK) {
+ fail_txt = "missing or malformed 'inputs' attribute";
goto err_out;
+ }
- if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
+ if (py_attr_as_strlist(d->py_dec, "outputs", &(d->outputs)) != SRD_OK) {
+ fail_txt = "missing or malformed 'outputs' attribute";
goto err_out;
+ }
/* All options and their default values. */
- if (get_options(d) != SRD_OK)
+ if (get_options(d) != SRD_OK) {
+ fail_txt = "cannot get options";
goto err_out;
+ }
/* Check and import required channels. */
- if (get_channels(d, "channels", &d->channels, 0) != SRD_OK)
+ if (get_channels(d, "channels", &d->channels, 0) != SRD_OK) {
+ fail_txt = "cannot get channels";
goto err_out;
+ }
/* Check and import optional channels. */
if (get_channels(d, "optional_channels", &d->opt_channels,
- g_slist_length(d->channels)) != SRD_OK)
+ g_slist_length(d->channels)) != SRD_OK) {
+ fail_txt = "cannot get optional channels";
goto err_out;
+ }
- if (get_annotations(d) != SRD_OK)
+ if (get_annotations(d) != SRD_OK) {
+ fail_txt = "cannot get annotations";
goto err_out;
+ }
- if (get_annotation_rows(d) != SRD_OK)
+ if (get_annotation_rows(d) != SRD_OK) {
+ fail_txt = "cannot get annotation rows";
goto err_out;
+ }
- if (get_binary_classes(d) != SRD_OK)
+ if (get_binary_classes(d) != SRD_OK) {
+ fail_txt = "cannot get binary classes";
goto err_out;
+ }
+
+ PyGILState_Release(gstate);
- /* Append it to the list of supported/loaded decoders. */
+ /* Append it to the list of loaded decoders. */
pd_list = g_slist_append(pd_list, d);
return SRD_OK;
except_out:
- srd_exception_catch("Failed to load decoder %s", module_name);
+ /* Don't show a message for the "common" directory, it's not a PD. */
+ if (strcmp(module_name, "common")) {
+ srd_exception_catch("Failed to load decoder %s: %s",
+ module_name, fail_txt);
+ }
+ fail_txt = NULL;
+
err_out:
+ if (fail_txt)
+ srd_err("Failed to load decoder %s: %s", module_name, fail_txt);
decoder_free(d);
+ PyGILState_Release(gstate);
return SRD_ERR_PYTHON;
}
{
PyObject *py_str;
char *doc;
+ PyGILState_STATE gstate;
if (!srd_check_init())
return NULL;
if (!dec)
return NULL;
+ gstate = PyGILState_Ensure();
+
if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
- return NULL;
+ goto err;
if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
srd_exception_catch("Failed to get docstring");
- return NULL;
+ goto err;
}
doc = NULL;
py_str_as_str(py_str, &doc);
Py_DECREF(py_str);
+ PyGILState_Release(gstate);
+
return doc;
+
+err:
+ PyGILState_Release(gstate);
+
+ return NULL;
}
/**
if (!dec)
return SRD_ERR_ARG;
- srd_dbg("Unloading protocol 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
*/
for (l = sessions; l; l = l->next) {
sess = l->data;
- srd_inst_free_all(sess, NULL);
+ srd_inst_free_all(sess);
}
+ /* Remove the PD from the list of loaded decoders. */
+ pd_list = g_slist_remove(pd_list, dec);
+
decoder_free(dec);
return SRD_OK;
}
-static void srd_decoder_load_all_zip_path(char *path)
+static void srd_decoder_load_all_zip_path(char *zip_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;
+ PyGILState_STATE gstate;
- zipimport_mod = NULL;
set = files = prefix_obj = zipimporter = zipimporter_class = NULL;
- modname = PyUnicode_FromString("zipimport");
- if (!modname)
- goto err_out;
+ gstate = PyGILState_Ensure();
- zipimport_mod = PyImport_Import(modname);
- Py_DECREF(modname);
+ zipimport_mod = py_import_by_name("zipimport");
if (zipimport_mod == NULL)
goto err_out;
if (zipimporter_class == NULL)
goto err_out;
- zipimporter = PyObject_CallFunction(zipimporter_class, "s", path);
+ zipimporter = PyObject_CallFunction(zipimporter_class, "s", zip_path);
if (zipimporter == NULL)
goto err_out;
Py_XDECREF(zipimporter_class);
Py_XDECREF(zipimport_mod);
PyErr_Clear();
+ PyGILState_Release(gstate);
}
static void srd_decoder_load_all_path(char *path)
const gchar *direntry;
if (!(dir = g_dir_open(path, 0, NULL))) {
- /* Not really fatal */
- /* Try zipimport method too */
+ /* Not really fatal. Try zipimport method too. */
srd_decoder_load_all_zip_path(path);
return;
}
- /* This ignores errors returned by srd_decoder_load(). That
+ /*
+ * This ignores errors returned by srd_decoder_load(). That
* function will have logged the cause, but in any case we
- * want to continue anyway. */
+ * want to continue anyway.
+ */
while ((direntry = g_dir_read_name(dir)) != NULL) {
/* The directory name is the module name (e.g. "i2c"). */
srd_decoder_load(direntry);
}
g_dir_close(dir);
-
}
/**
*/
SRD_API int srd_decoder_unload_all(void)
{
- GSList *l;
- struct srd_decoder *dec;
-
- for (l = pd_list; l; l = l->next) {
- dec = l->data;
- srd_decoder_unload(dec);
- }
+ g_slist_foreach(pd_list, (GFunc)srd_decoder_unload, NULL);
g_slist_free(pd_list);
pd_list = NULL;
projects / libsigrokdecode.git / blobdiff