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 /* module_sigrokdecode.c */
46 extern SRD_PRIV PyObject *mod_sigrokdecode;
51 * Returns the list of supported/loaded protocol decoders.
53 * This is a GSList containing the names of the decoders as strings.
55 * @return List of decoders, NULL if none are supported or loaded.
57 * @since 0.1.0 (but the API changed in 0.2.0)
59 SRD_API const GSList *srd_decoder_list(void)
65 * Get the decoder with the specified ID.
67 * @param id The ID string of the decoder to return.
69 * @return The decoder with the specified ID, or NULL if not found.
73 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
76 struct srd_decoder *dec;
78 for (l = pd_list; l; l = l->next) {
80 if (!strcmp(dec->id, id))
87 static int get_probes(const struct srd_decoder *d, const char *attr,
90 PyObject *py_probelist, *py_entry;
92 int ret, num_probes, i;
94 if (!PyObject_HasAttrString(d->py_dec, attr))
95 /* No probes of this type specified. */
99 py_probelist = py_entry = NULL;
101 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
102 if (!PyList_Check(py_probelist)) {
103 srd_err("Protocol decoder %s %s attribute is not "
104 "a list.", d->name, attr);
108 num_probes = PyList_Size(py_probelist);
110 /* Empty probelist. */
113 for (i = 0; i < num_probes; i++) {
114 py_entry = PyList_GetItem(py_probelist, i);
115 if (!PyDict_Check(py_entry)) {
116 srd_err("Protocol decoder %s %s attribute is not "
117 "a list with dict elements.", d->name, attr);
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)
129 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
131 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
135 *pl = g_slist_append(*pl, p);
141 Py_DecRef(py_probelist);
146 static int get_options(struct srd_decoder *d)
148 PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default;
150 struct srd_decoder_option *o;
152 int num_keys, overflow, ret;
155 ret = SRD_ERR_PYTHON;
158 if (!PyObject_HasAttrString(d->py_dec, "options"))
162 /* If present, options must be a dictionary. */
163 py_opts = PyObject_GetAttrString(d->py_dec, "options");
164 if (!PyDict_Check(py_opts)) {
165 srd_err("Protocol decoder %s options attribute is not "
166 "a dictionary.", d->name);
170 py_keys = PyDict_Keys(py_opts);
171 py_values = PyDict_Values(py_opts);
172 num_keys = PyList_Size(py_keys);
173 for (i = 0; i < num_keys; i++) {
174 py_str_as_str(PyList_GetItem(py_keys, i), &key);
175 srd_dbg("option '%s'", key);
176 py_val = PyList_GetItem(py_values, i);
177 if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) {
178 srd_err("Protocol decoder %s option '%s' value must be "
179 "a list with two elements.", d->name, key);
182 py_desc = PyList_GetItem(py_val, 0);
183 if (!PyUnicode_Check(py_desc)) {
184 srd_err("Protocol decoder %s option '%s' has no "
185 "description.", d->name, key);
188 py_default = PyList_GetItem(py_val, 1);
189 if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) {
190 srd_err("Protocol decoder %s option '%s' has default "
191 "of unsupported type '%s'.", d->name, key,
192 Py_TYPE(py_default)->tp_name);
195 if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
196 srd_err("option malloc failed");
199 o->id = g_strdup(key);
200 py_str_as_str(py_desc, &o->desc);
201 if (PyUnicode_Check(py_default)) {
203 py_str_as_str(py_default, &def_str);
204 o->def = g_variant_new_string(def_str);
208 def_long = PyLong_AsLongAndOverflow(py_default, &overflow);
210 /* Value is < LONG_MIN or > LONG_MAX */
212 srd_err("Protocol decoder %s option '%s' has "
213 "invalid default value.", d->name, key);
216 o->def = g_variant_new_int64(def_long);
218 g_variant_ref_sink(o->def);
219 d->options = g_slist_append(d->options, o);
223 Py_DecRef(py_values);
235 * Load a protocol decoder module into the embedded Python interpreter.
237 * @param module_name The module name to be loaded.
239 * @return SRD_OK upon success, a (negative) error code otherwise.
243 SRD_API int srd_decoder_load(const char *module_name)
245 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
246 struct srd_decoder *d;
252 srd_dbg("Loading protocol decoder '%s'.", module_name);
254 py_basedec = py_method = py_attr = NULL;
256 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
257 srd_dbg("Failed to g_malloc() struct srd_decoder.");
258 ret = SRD_ERR_MALLOC;
262 ret = SRD_ERR_PYTHON;
264 /* Import the Python module. */
265 if (!(d->py_mod = PyImport_ImportModule(module_name))) {
266 srd_exception_catch("Import of '%s' failed.", module_name);
270 /* Get the 'Decoder' class as Python object. */
271 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
272 /* This generated an AttributeError exception. */
274 srd_err("Decoder class not found in protocol decoder %s.",
279 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
280 srd_dbg("sigrokdecode module not loaded.");
284 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
285 srd_err("Decoder class in protocol decoder module %s is not "
286 "a subclass of sigrokdecode.Decoder.", module_name);
289 Py_CLEAR(py_basedec);
291 /* Check for a proper start() method. */
292 if (!PyObject_HasAttrString(d->py_dec, "start")) {
293 srd_err("Protocol decoder %s has no start() method Decoder "
294 "class.", module_name);
297 py_method = PyObject_GetAttrString(d->py_dec, "start");
298 if (!PyFunction_Check(py_method)) {
299 srd_err("Protocol decoder %s Decoder class attribute 'start' "
300 "is not a method.", module_name);
305 /* Check for a proper decode() method. */
306 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
307 srd_err("Protocol decoder %s has no decode() method Decoder "
308 "class.", module_name);
311 py_method = PyObject_GetAttrString(d->py_dec, "decode");
312 if (!PyFunction_Check(py_method)) {
313 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
314 "is not a method.", module_name);
319 if (get_options(d) != SRD_OK)
322 /* Check and import required probes. */
323 if (get_probes(d, "probes", &d->probes) != SRD_OK)
326 /* Check and import optional probes. */
327 if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
331 * Fix order numbers for the optional probes.
334 * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
335 * 'order' fields in the d->probes list = 0, 1, 2.
336 * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
338 for (l = d->opt_probes; l; l = l->next) {
340 p->order += g_slist_length(d->probes);
343 /* Store required fields in newly allocated strings. */
344 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
347 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
350 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
353 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
356 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
359 /* Convert class annotation attribute to GSList of **char. */
360 d->annotations = NULL;
361 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
362 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
363 if (!PyList_Check(py_annlist)) {
364 srd_err("Protocol decoder module %s annotations "
365 "should be a list.", module_name);
368 alen = PyList_Size(py_annlist);
369 for (i = 0; i < alen; i++) {
370 py_ann = PyList_GetItem(py_annlist, i);
371 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
372 srd_err("Protocol decoder module %s "
373 "annotation %d should be a list with "
374 "two elements.", module_name, i + 1);
378 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
381 d->annotations = g_slist_append(d->annotations, ann);
385 /* Append it to the list of supported/loaded decoders. */
386 pd_list = g_slist_append(pd_list, d);
392 Py_XDECREF(py_method);
393 Py_XDECREF(py_basedec);
394 Py_XDECREF(d->py_dec);
395 Py_XDECREF(d->py_mod);
403 * Return a protocol decoder's docstring.
405 * @param dec The loaded protocol decoder.
407 * @return A newly allocated buffer containing the protocol decoder's
408 * documentation. The caller is responsible for free'ing the buffer.
412 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
417 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
420 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
421 srd_exception_catch("");
426 if (py_str != Py_None)
427 py_str_as_str(py_str, &doc);
433 static void free_probes(GSList *probelist)
438 if (probelist == NULL)
441 for (l = probelist; l; l = l->next) {
448 g_slist_free(probelist);
452 * Unload the specified protocol decoder.
454 * @param dec The struct srd_decoder to be unloaded.
456 * @return SRD_OK upon success, a (negative) error code otherwise.
460 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
462 struct srd_decoder_option *o;
465 srd_dbg("Unloading protocol decoder '%s'.", dec->name);
468 * Since any instances of this decoder need to be released as well,
469 * but they could be anywhere in the stack, just free the entire
470 * stack. A frontend reloading a decoder thus has to restart all
471 * instances, and rebuild the stack.
473 srd_inst_free_all(NULL);
475 for (l = dec->options; l; l = l->next) {
479 g_variant_unref(o->def);
482 g_slist_free(dec->options);
484 free_probes(dec->probes);
485 free_probes(dec->opt_probes);
488 g_free(dec->longname);
490 g_free(dec->license);
492 /* The module's Decoder class. */
493 Py_XDECREF(dec->py_dec);
494 /* The module itself. */
495 Py_XDECREF(dec->py_mod);
503 * Load all installed protocol decoders.
505 * @return SRD_OK upon success, a (negative) error code otherwise.
509 SRD_API int srd_decoder_load_all(void)
513 const gchar *direntry;
515 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
516 srd_err("Unable to open %s for reading.", DECODERS_DIR);
517 return SRD_ERR_DECODERS_DIR;
520 while ((direntry = g_dir_read_name(dir)) != NULL) {
521 /* The directory name is the module name (e.g. "i2c"). */
522 srd_decoder_load(direntry);
530 * Unload all loaded protocol decoders.
532 * @return SRD_OK upon success, a (negative) error code otherwise.
536 SRD_API int srd_decoder_unload_all(void)
539 struct srd_decoder *dec;
541 for (l = pd_list; l; l = l->next) {
543 srd_decoder_unload(dec);