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