ef7e15d1bf40c8db63848a2a562bdb9972e5b354
[libsigrokdecode.git] / decoder.c
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
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.
11  *
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.
16  *
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/>.
19  */
20
21 #include "config.h"
22 #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode-internal.h"
24 #include <glib.h>
25
26 /**
27  * @file
28  *
29  * Listing, loading, unloading, and handling protocol decoders.
30  */
31
32 /**
33  * @defgroup grp_decoder Protocol decoders
34  *
35  * Handling protocol decoders.
36  *
37  * @{
38  */
39
40 /** @cond PRIVATE */
41
42 /* The list of protocol decoders. */
43 SRD_PRIV GSList *pd_list = NULL;
44
45 extern GSList *sessions;
46
47 /* module_sigrokdecode.c */
48 extern SRD_PRIV PyObject *mod_sigrokdecode;
49
50 /** @endcond */
51
52 /**
53  * Returns the list of supported/loaded protocol decoders.
54  *
55  * This is a GSList containing the names of the decoders as strings.
56  *
57  * @return List of decoders, NULL if none are supported or loaded.
58  *
59  * @since 0.1.0 (but the API changed in 0.2.0)
60  */
61 SRD_API const GSList *srd_decoder_list(void)
62 {
63         return pd_list;
64 }
65
66 /**
67  * Get the decoder with the specified ID.
68  *
69  * @param id The ID string of the decoder to return.
70  *
71  * @return The decoder with the specified ID, or NULL if not found.
72  *
73  * @since 0.1.0
74  */
75 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
76 {
77         GSList *l;
78         struct srd_decoder *dec;
79
80         for (l = pd_list; l; l = l->next) {
81                 dec = l->data;
82                 if (!strcmp(dec->id, id))
83                         return dec;
84         }
85
86         return NULL;
87 }
88
89 static int get_probes(const struct srd_decoder *d, const char *attr,
90                       GSList **pl)
91 {
92         PyObject *py_probelist, *py_entry;
93         struct srd_probe *p;
94         int ret, num_probes, i;
95
96         if (!PyObject_HasAttrString(d->py_dec, attr))
97                 /* No probes of this type specified. */
98                 return SRD_OK;
99
100         ret = SRD_ERR_PYTHON;
101         py_probelist = py_entry = NULL;
102
103         py_probelist = PyObject_GetAttrString(d->py_dec, attr);
104         if (!PyList_Check(py_probelist)) {
105                 srd_err("Protocol decoder %s %s attribute is not "
106                         "a list.", d->name, attr);
107                 goto err_out;
108         }
109
110         num_probes = PyList_Size(py_probelist);
111         if (num_probes == 0)
112                 /* Empty probelist. */
113                 return SRD_OK;
114
115         for (i = 0; i < num_probes; i++) {
116                 py_entry = PyList_GetItem(py_probelist, i);
117                 if (!PyDict_Check(py_entry)) {
118                         srd_err("Protocol decoder %s %s attribute is not "
119                                 "a list with dict elements.", d->name, attr);
120                         goto err_out;
121                 }
122
123                 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
124                         srd_err("Failed to g_malloc() struct srd_probe.");
125                         ret = SRD_ERR_MALLOC;
126                         goto err_out;
127                 }
128
129                 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
130                         goto err_out;
131                 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
132                         goto err_out;
133                 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
134                         goto err_out;
135                 p->order = i;
136
137                 *pl = g_slist_append(*pl, p);
138         }
139         ret = SRD_OK;
140
141 err_out:
142         Py_DecRef(py_entry);
143         Py_DecRef(py_probelist);
144
145         return ret;
146 }
147
148 static int get_options(struct srd_decoder *d)
149 {
150         PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default;
151         Py_ssize_t i;
152         struct srd_decoder_option *o;
153         gint64 def_long;
154         int num_keys, overflow, ret;
155         char *key, *def_str;
156
157         ret = SRD_ERR_PYTHON;
158         key = NULL;
159
160         if (!PyObject_HasAttrString(d->py_dec, "options"))
161                 /* That's fine. */
162                 return SRD_OK;
163
164         /* If present, options must be a dictionary. */
165         py_opts = PyObject_GetAttrString(d->py_dec, "options");
166         if (!PyDict_Check(py_opts)) {
167                 srd_err("Protocol decoder %s options attribute is not "
168                         "a dictionary.", d->name);
169                 goto err_out;
170         }
171
172         py_keys = PyDict_Keys(py_opts);
173         py_values = PyDict_Values(py_opts);
174         num_keys = PyList_Size(py_keys);
175         for (i = 0; i < num_keys; i++) {
176                 py_str_as_str(PyList_GetItem(py_keys, i), &key);
177                 srd_dbg("option '%s'", key);
178                 py_val = PyList_GetItem(py_values, i);
179                 if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) {
180                         srd_err("Protocol decoder %s option '%s' value must be "
181                                         "a list with two elements.", d->name, key);
182                         goto err_out;
183                 }
184                 py_desc = PyList_GetItem(py_val, 0);
185                 if (!PyUnicode_Check(py_desc)) {
186                         srd_err("Protocol decoder %s option '%s' has no "
187                                         "description.", d->name, key);
188                         goto err_out;
189                 }
190                 py_default = PyList_GetItem(py_val, 1);
191                 if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) {
192                         srd_err("Protocol decoder %s option '%s' has default "
193                                         "of unsupported type '%s'.", d->name, key,
194                                         Py_TYPE(py_default)->tp_name);
195                         goto err_out;
196                 }
197                 if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
198                         srd_err("option malloc failed");
199                         goto err_out;
200                 }
201                 o->id = g_strdup(key);
202                 py_str_as_str(py_desc, &o->desc);
203                 if (PyUnicode_Check(py_default)) {
204                         /* UTF-8 string */
205                         py_str_as_str(py_default, &def_str);
206                         o->def = g_variant_new_string(def_str);
207                         g_free(def_str);
208                 } else {
209                         /* Long */
210                         def_long = PyLong_AsLongAndOverflow(py_default, &overflow);
211                         if (overflow) {
212                                 /* Value is < LONG_MIN or > LONG_MAX */
213                                 PyErr_Clear();
214                                 srd_err("Protocol decoder %s option '%s' has "
215                                                 "invalid default value.", d->name, key);
216                                 goto err_out;
217                         }
218                         o->def = g_variant_new_int64(def_long);
219                 }
220                 g_variant_ref_sink(o->def);
221                 d->options = g_slist_append(d->options, o);
222                 g_free(key);
223                 key = NULL;
224         }
225         Py_DecRef(py_keys);
226         Py_DecRef(py_values);
227
228         ret = SRD_OK;
229
230 err_out:
231         Py_XDECREF(py_opts);
232         g_free(key);
233
234         return ret;
235 }
236
237 /**
238  * Load a protocol decoder module into the embedded Python interpreter.
239  *
240  * @param module_name The module name to be loaded.
241  *
242  * @return SRD_OK upon success, a (negative) error code otherwise.
243  *
244  * @since 0.1.0
245  */
246 SRD_API int srd_decoder_load(const char *module_name)
247 {
248         PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann, \
249                 *py_bin_classes, *py_bin_class;
250         struct srd_decoder *d;
251         int len, ret, i;
252         char **ann, *bin;
253         struct srd_probe *p;
254         GSList *l;
255
256         if (!module_name)
257                 return SRD_ERR_ARG;
258
259         srd_dbg("Loading protocol decoder '%s'.", module_name);
260
261         py_basedec = py_method = py_attr = NULL;
262
263         if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
264                 srd_dbg("Failed to g_malloc() struct srd_decoder.");
265                 ret = SRD_ERR_MALLOC;
266                 goto err_out;
267         }
268
269         ret = SRD_ERR_PYTHON;
270
271         /* Import the Python module. */
272         if (!(d->py_mod = PyImport_ImportModule(module_name))) {
273                 srd_exception_catch("Import of '%s' failed.", module_name);
274                 goto err_out;
275         }
276
277         /* Get the 'Decoder' class as Python object. */
278         if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
279                 /* This generated an AttributeError exception. */
280                 PyErr_Clear();
281                 srd_err("Decoder class not found in protocol decoder %s.",
282                         module_name);
283                 goto err_out;
284         }
285
286         if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
287                 srd_dbg("sigrokdecode module not loaded.");
288                 goto err_out;
289         }
290
291         if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
292                 srd_err("Decoder class in protocol decoder module %s is not "
293                         "a subclass of sigrokdecode.Decoder.", module_name);
294                 goto err_out;
295         }
296         Py_CLEAR(py_basedec);
297
298         /* Check for a proper start() method. */
299         if (!PyObject_HasAttrString(d->py_dec, "start")) {
300                 srd_err("Protocol decoder %s has no start() method Decoder "
301                         "class.", module_name);
302                 goto err_out;
303         }
304         py_method = PyObject_GetAttrString(d->py_dec, "start");
305         if (!PyFunction_Check(py_method)) {
306                 srd_err("Protocol decoder %s Decoder class attribute 'start' "
307                         "is not a method.", module_name);
308                 goto err_out;
309         }
310         Py_CLEAR(py_method);
311
312         /* Check for a proper decode() method. */
313         if (!PyObject_HasAttrString(d->py_dec, "decode")) {
314                 srd_err("Protocol decoder %s has no decode() method Decoder "
315                         "class.", module_name);
316                 goto err_out;
317         }
318         py_method = PyObject_GetAttrString(d->py_dec, "decode");
319         if (!PyFunction_Check(py_method)) {
320                 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
321                         "is not a method.", module_name);
322                 goto err_out;
323         }
324         Py_CLEAR(py_method);
325
326         if (get_options(d) != SRD_OK)
327                 goto err_out;
328
329         /* Check and import required probes. */
330         if (get_probes(d, "probes", &d->probes) != SRD_OK)
331                 goto err_out;
332
333         /* Check and import optional probes. */
334         if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
335                 goto err_out;
336
337         /*
338          * Fix order numbers for the optional probes.
339          *
340          * Example:
341          * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
342          * 'order' fields in the d->probes list = 0, 1, 2.
343          * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
344          */
345         for (l = d->opt_probes; l; l = l->next) {
346                 p = l->data;
347                 p->order += g_slist_length(d->probes);
348         }
349
350         /* Store required fields in newly allocated strings. */
351         if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
352                 goto err_out;
353
354         if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
355                 goto err_out;
356
357         if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
358                 goto err_out;
359
360         if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
361                 goto err_out;
362
363         if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
364                 goto err_out;
365
366         /* Convert annotation class attribute to GSList of char **. */
367         d->annotations = NULL;
368         if (PyObject_HasAttrString(d->py_dec, "annotations")) {
369                 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
370                 if (!PyList_Check(py_annlist)) {
371                         srd_err("Protocol decoder module %s annotations "
372                                 "should be a list.", module_name);
373                         goto err_out;
374                 }
375                 len = PyList_Size(py_annlist);
376                 for (i = 0; i < len; i++) {
377                         py_ann = PyList_GetItem(py_annlist, i);
378                         if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
379                                 srd_err("Protocol decoder module %s "
380                                         "annotation %d should be a list with "
381                                         "two elements.", module_name, i + 1);
382                                 goto err_out;
383                         }
384
385                         if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
386                                 goto err_out;
387                         }
388                         d->annotations = g_slist_append(d->annotations, ann);
389                 }
390         }
391
392         /* Convert binary class to GSList of char *. */
393         d->binary = NULL;
394         if (PyObject_HasAttrString(d->py_dec, "binary")) {
395                 py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary");
396                 if (!PyTuple_Check(py_bin_classes)) {
397                         srd_err("Protocol decoder module %s binary classes "
398                                 "should be a tuple.", module_name);
399                         goto err_out;
400                 }
401                 len = PyTuple_Size(py_bin_classes);
402                 for (i = 0; i < len; i++) {
403                         py_bin_class = PyTuple_GetItem(py_bin_classes, i);
404                         if (!PyUnicode_Check(py_bin_class)) {
405                                 srd_err("Protocol decoder module %s binary "
406                                                 "class should be a string.", module_name);
407                                 goto err_out;
408                         }
409
410                         if (py_str_as_str(py_bin_class, &bin) != SRD_OK) {
411                                 goto err_out;
412                         }
413                         d->binary = g_slist_append(d->binary, bin);
414                 }
415         }
416
417         /* Append it to the list of supported/loaded decoders. */
418         pd_list = g_slist_append(pd_list, d);
419
420         ret = SRD_OK;
421
422 err_out:
423         if (ret != SRD_OK) {
424                 Py_XDECREF(py_method);
425                 Py_XDECREF(py_basedec);
426                 Py_XDECREF(d->py_dec);
427                 Py_XDECREF(d->py_mod);
428                 g_free(d);
429         }
430
431         return ret;
432 }
433
434 /**
435  * Return a protocol decoder's docstring.
436  *
437  * @param dec The loaded protocol decoder.
438  *
439  * @return A newly allocated buffer containing the protocol decoder's
440  *         documentation. The caller is responsible for free'ing the buffer.
441  *
442  * @since 0.1.0
443  */
444 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
445 {
446         PyObject *py_str;
447         char *doc;
448
449         if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
450                 return NULL;
451
452         if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
453                 srd_exception_catch("");
454                 return NULL;
455         }
456
457         doc = NULL;
458         if (py_str != Py_None)
459                 py_str_as_str(py_str, &doc);
460         Py_DecRef(py_str);
461
462         return doc;
463 }
464
465 static void free_probes(GSList *probelist)
466 {
467         GSList *l;
468         struct srd_probe *p;
469
470         if (probelist == NULL)
471                 return;
472
473         for (l = probelist; l; l = l->next) {
474                 p = l->data;
475                 g_free(p->id);
476                 g_free(p->name);
477                 g_free(p->desc);
478                 g_free(p);
479         }
480         g_slist_free(probelist);
481 }
482
483 /**
484  * Unload the specified protocol decoder.
485  *
486  * @param dec The struct srd_decoder to be unloaded.
487  *
488  * @return SRD_OK upon success, a (negative) error code otherwise.
489  *
490  * @since 0.1.0
491  */
492 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
493 {
494         struct srd_decoder_option *o;
495         struct srd_session *sess;
496         GSList *l;
497
498         srd_dbg("Unloading protocol decoder '%s'.", dec->name);
499
500         /*
501          * Since any instances of this decoder need to be released as well,
502          * but they could be anywhere in the stack, just free the entire
503          * stack. A frontend reloading a decoder thus has to restart all
504          * instances, and rebuild the stack.
505          */
506         for (l = sessions; l; l = l->next) {
507                 sess = l->data;
508                 srd_inst_free_all(sess, NULL);
509         }
510
511         for (l = dec->options; l; l = l->next) {
512                 o = l->data;
513                 g_free(o->id);
514                 g_free(o->desc);
515                 g_variant_unref(o->def);
516                 g_free(o);
517         }
518         g_slist_free(dec->options);
519
520         free_probes(dec->probes);
521         free_probes(dec->opt_probes);
522         g_free(dec->id);
523         g_free(dec->name);
524         g_free(dec->longname);
525         g_free(dec->desc);
526         g_free(dec->license);
527
528         /* The module's Decoder class. */
529         Py_XDECREF(dec->py_dec);
530         /* The module itself. */
531         Py_XDECREF(dec->py_mod);
532
533         g_free(dec);
534
535         return SRD_OK;
536 }
537
538 /**
539  * Load all installed protocol decoders.
540  *
541  * @return SRD_OK upon success, a (negative) error code otherwise.
542  *
543  * @since 0.1.0
544  */
545 SRD_API int srd_decoder_load_all(void)
546 {
547         GDir *dir;
548         GError *error;
549         const gchar *direntry;
550
551         if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
552                 srd_err("Unable to open %s for reading.", DECODERS_DIR);
553                 return SRD_ERR_DECODERS_DIR;
554         }
555
556         while ((direntry = g_dir_read_name(dir)) != NULL) {
557                 /* The directory name is the module name (e.g. "i2c"). */
558                 srd_decoder_load(direntry);
559         }
560         g_dir_close(dir);
561
562         return SRD_OK;
563 }
564
565 /**
566  * Unload all loaded protocol decoders.
567  *
568  * @return SRD_OK upon success, a (negative) error code otherwise.
569  *
570  * @since 0.1.0
571  */
572 SRD_API int srd_decoder_unload_all(void)
573 {
574         GSList *l;
575         struct srd_decoder *dec;
576
577         for (l = pd_list; l; l = l->next) {
578                 dec = l->data;
579                 srd_decoder_unload(dec);
580         }
581
582         return SRD_OK;
583 }
584
585 /** @} */