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.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode-internal.h"
29 * Listing, loading, unloading, and handling protocol decoders.
33 * @defgroup grp_decoder Protocol decoders
35 * Handling protocol decoders.
42 /* The list of protocol decoders. */
43 SRD_PRIV GSList *pd_list = NULL;
45 extern GSList *sessions;
47 /* module_sigrokdecode.c */
48 extern SRD_PRIV PyObject *mod_sigrokdecode;
53 * Returns the list of supported/loaded protocol decoders.
55 * This is a GSList containing the names of the decoders as strings.
57 * @return List of decoders, NULL if none are supported or loaded.
59 * @since 0.1.0 (but the API changed in 0.2.0)
61 SRD_API const GSList *srd_decoder_list(void)
67 * Get the decoder with the specified ID.
69 * @param id The ID string of the decoder to return.
71 * @return The decoder with the specified ID, or NULL if not found.
75 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
78 struct srd_decoder *dec;
80 for (l = pd_list; l; l = l->next) {
82 if (!strcmp(dec->id, id))
89 static int get_probes(const struct srd_decoder *d, const char *attr,
92 PyObject *py_probelist, *py_entry;
94 int ret, num_probes, i;
96 if (!PyObject_HasAttrString(d->py_dec, attr))
97 /* No probes of this type specified. */
100 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
101 if (!PyList_Check(py_probelist)) {
102 srd_err("Protocol decoder %s %s attribute is not a list.",
104 return SRD_ERR_PYTHON;
107 if ((num_probes = PyList_Size(py_probelist)) == 0)
108 /* Empty probelist. */
112 for (i = 0; i < num_probes; i++) {
113 py_entry = PyList_GetItem(py_probelist, i);
114 if (!PyDict_Check(py_entry)) {
115 srd_err("Protocol decoder %s %s attribute is not "
116 "a list with dict elements.", d->name, attr);
117 ret = SRD_ERR_PYTHON;
121 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
122 srd_err("Failed to g_malloc() struct srd_probe.");
123 ret = SRD_ERR_MALLOC;
127 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK) {
128 ret = SRD_ERR_PYTHON;
131 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK) {
132 ret = SRD_ERR_PYTHON;
135 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK) {
136 ret = SRD_ERR_PYTHON;
141 *pl = g_slist_append(*pl, p);
144 Py_DecRef(py_probelist);
149 static int get_options(struct srd_decoder *d)
151 PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default;
153 struct srd_decoder_option *o;
155 int num_keys, overflow, ret;
158 ret = SRD_ERR_PYTHON;
161 if (!PyObject_HasAttrString(d->py_dec, "options"))
165 /* If present, options must be a dictionary. */
166 py_opts = PyObject_GetAttrString(d->py_dec, "options");
167 if (!PyDict_Check(py_opts)) {
168 srd_err("Protocol decoder %s options attribute is not "
169 "a dictionary.", d->name);
173 py_keys = PyDict_Keys(py_opts);
174 py_values = PyDict_Values(py_opts);
175 num_keys = PyList_Size(py_keys);
176 for (i = 0; i < num_keys; i++) {
177 py_str_as_str(PyList_GetItem(py_keys, i), &key);
178 srd_dbg("option '%s'", key);
179 py_val = PyList_GetItem(py_values, i);
180 if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) {
181 srd_err("Protocol decoder %s option '%s' value must be "
182 "a list with two elements.", d->name, key);
185 py_desc = PyList_GetItem(py_val, 0);
186 if (!PyUnicode_Check(py_desc)) {
187 srd_err("Protocol decoder %s option '%s' has no "
188 "description.", d->name, key);
191 py_default = PyList_GetItem(py_val, 1);
192 if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) {
193 srd_err("Protocol decoder %s option '%s' has default "
194 "of unsupported type '%s'.", d->name, key,
195 Py_TYPE(py_default)->tp_name);
198 if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
199 srd_err("option malloc failed");
202 o->id = g_strdup(key);
203 py_str_as_str(py_desc, &o->desc);
204 if (PyUnicode_Check(py_default)) {
206 py_str_as_str(py_default, &def_str);
207 o->def = g_variant_new_string(def_str);
211 def_long = PyLong_AsLongAndOverflow(py_default, &overflow);
213 /* Value is < LONG_MIN or > LONG_MAX */
215 srd_err("Protocol decoder %s option '%s' has "
216 "invalid default value.", d->name, key);
219 o->def = g_variant_new_int64(def_long);
221 g_variant_ref_sink(o->def);
222 d->options = g_slist_append(d->options, o);
227 Py_DecRef(py_values);
239 * Load a protocol decoder module into the embedded Python interpreter.
241 * @param module_name The module name to be loaded.
243 * @return SRD_OK upon success, a (negative) error code otherwise.
247 SRD_API int srd_decoder_load(const char *module_name)
249 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann, \
250 *py_bin_classes, *py_bin_class;
251 struct srd_decoder *d;
257 if (!srd_check_init())
263 if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) {
264 /* Module was already imported. */
268 srd_dbg("Loading protocol decoder '%s'.", module_name);
270 py_basedec = py_method = py_attr = NULL;
272 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
273 srd_dbg("Failed to g_malloc() struct srd_decoder.");
274 ret = SRD_ERR_MALLOC;
278 ret = SRD_ERR_PYTHON;
280 /* Import the Python module. */
281 if (!(d->py_mod = PyImport_ImportModule(module_name))) {
282 srd_exception_catch("Import of '%s' failed.", module_name);
286 /* Get the 'Decoder' class as Python object. */
287 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
288 /* This generated an AttributeError exception. */
290 srd_err("Decoder class not found in protocol decoder %s.",
295 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
296 srd_dbg("sigrokdecode module not loaded.");
300 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
301 srd_err("Decoder class in protocol decoder module %s is not "
302 "a subclass of sigrokdecode.Decoder.", module_name);
305 Py_CLEAR(py_basedec);
307 /* Check for a proper start() method. */
308 if (!PyObject_HasAttrString(d->py_dec, "start")) {
309 srd_err("Protocol decoder %s has no start() method Decoder "
310 "class.", module_name);
313 py_method = PyObject_GetAttrString(d->py_dec, "start");
314 if (!PyFunction_Check(py_method)) {
315 srd_err("Protocol decoder %s Decoder class attribute 'start' "
316 "is not a method.", module_name);
321 /* Check for a proper decode() method. */
322 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
323 srd_err("Protocol decoder %s has no decode() method Decoder "
324 "class.", module_name);
327 py_method = PyObject_GetAttrString(d->py_dec, "decode");
328 if (!PyFunction_Check(py_method)) {
329 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
330 "is not a method.", module_name);
335 if (get_options(d) != SRD_OK)
338 /* Check and import required probes. */
339 if (get_probes(d, "probes", &d->probes) != SRD_OK)
342 /* Check and import optional probes. */
343 if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
347 * Fix order numbers for the optional probes.
350 * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
351 * 'order' fields in the d->probes list = 0, 1, 2.
352 * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
354 for (l = d->opt_probes; l; l = l->next) {
356 p->order += g_slist_length(d->probes);
359 /* Store required fields in newly allocated strings. */
360 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
363 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
366 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
369 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
372 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
375 /* Convert annotation class attribute to GSList of char **. */
376 d->annotations = NULL;
377 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
378 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
379 if (!PyList_Check(py_annlist)) {
380 srd_err("Protocol decoder module %s annotations "
381 "should be a list.", module_name);
384 len = PyList_Size(py_annlist);
385 for (i = 0; i < len; i++) {
386 py_ann = PyList_GetItem(py_annlist, i);
387 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
388 srd_err("Protocol decoder module %s "
389 "annotation %d should be a list with "
390 "two elements.", module_name, i + 1);
394 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
397 d->annotations = g_slist_append(d->annotations, ann);
401 /* Convert binary class to GSList of char *. */
403 if (PyObject_HasAttrString(d->py_dec, "binary")) {
404 py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary");
405 if (!PyTuple_Check(py_bin_classes)) {
406 srd_err("Protocol decoder module %s binary classes "
407 "should be a tuple.", module_name);
410 len = PyTuple_Size(py_bin_classes);
411 for (i = 0; i < len; i++) {
412 py_bin_class = PyTuple_GetItem(py_bin_classes, i);
413 if (!PyUnicode_Check(py_bin_class)) {
414 srd_err("Protocol decoder module %s binary "
415 "class should be a string.", module_name);
419 if (py_str_as_str(py_bin_class, &bin) != SRD_OK) {
422 d->binary = g_slist_append(d->binary, bin);
426 /* Append it to the list of supported/loaded decoders. */
427 pd_list = g_slist_append(pd_list, d);
433 Py_XDECREF(py_method);
434 Py_XDECREF(py_basedec);
435 Py_XDECREF(d->py_dec);
436 Py_XDECREF(d->py_mod);
444 * Return a protocol decoder's docstring.
446 * @param dec The loaded protocol decoder.
448 * @return A newly allocated buffer containing the protocol decoder's
449 * documentation. The caller is responsible for free'ing the buffer.
453 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
458 if (!srd_check_init())
464 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
467 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
468 srd_exception_catch("");
473 if (py_str != Py_None)
474 py_str_as_str(py_str, &doc);
480 static void free_probes(GSList *probelist)
485 if (probelist == NULL)
488 for (l = probelist; l; l = l->next) {
495 g_slist_free(probelist);
499 * Unload the specified protocol decoder.
501 * @param dec The struct srd_decoder to be unloaded.
503 * @return SRD_OK upon success, a (negative) error code otherwise.
507 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
509 struct srd_decoder_option *o;
510 struct srd_session *sess;
513 if (!srd_check_init())
519 srd_dbg("Unloading protocol decoder '%s'.", dec->name);
522 * Since any instances of this decoder need to be released as well,
523 * but they could be anywhere in the stack, just free the entire
524 * stack. A frontend reloading a decoder thus has to restart all
525 * instances, and rebuild the stack.
527 for (l = sessions; l; l = l->next) {
529 srd_inst_free_all(sess, NULL);
532 for (l = dec->options; l; l = l->next) {
536 g_variant_unref(o->def);
539 g_slist_free(dec->options);
541 free_probes(dec->probes);
542 free_probes(dec->opt_probes);
545 g_free(dec->longname);
547 g_free(dec->license);
549 /* The module's Decoder class. */
550 Py_XDECREF(dec->py_dec);
551 /* The module itself. */
552 Py_XDECREF(dec->py_mod);
560 * Load all installed protocol decoders.
562 * @return SRD_OK upon success, a (negative) error code otherwise.
566 SRD_API int srd_decoder_load_all(void)
569 const gchar *direntry;
571 if (!srd_check_init())
574 if (!(dir = g_dir_open(DECODERS_DIR, 0, NULL))) {
575 srd_err("Unable to open %s for reading.", DECODERS_DIR);
576 return SRD_ERR_DECODERS_DIR;
579 while ((direntry = g_dir_read_name(dir)) != NULL) {
580 /* The directory name is the module name (e.g. "i2c"). */
581 srd_decoder_load(direntry);
589 * Unload all loaded protocol decoders.
591 * @return SRD_OK upon success, a (negative) error code otherwise.
595 SRD_API int srd_decoder_unload_all(void)
598 struct srd_decoder *dec;
600 for (l = pd_list; l; l = l->next) {
602 srd_decoder_unload(dec);