33521c4045e3e297b27103a19b3e333033bd55fc
[libsigrokdecode.git] / decoder.c
1 /*
2  * This file is part of the sigrok 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 "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "sigrokdecode-internal.h"
24 #include <glib.h>
25
26 /* The list of protocol decoders. */
27 SRD_PRIV GSList *pd_list = NULL;
28
29 /* module_sigrokdecode.c */
30 extern SRD_PRIV PyObject *mod_sigrokdecode;
31
32 /**
33  * Returns the list of supported/loaded protocol decoders.
34  *
35  * This is a GSList containing the names of the decoders as strings.
36  *
37  * @return List of decoders, NULL if none are supported or loaded.
38  */
39 SRD_API GSList *srd_list_decoders(void)
40 {
41         return pd_list;
42 }
43
44 /**
45  * Get the decoder with the specified ID.
46  *
47  * @param id The ID string of the decoder to return.
48  *
49  * @return The decoder with the specified ID, or NULL if not found.
50  */
51 SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id)
52 {
53         GSList *l;
54         struct srd_decoder *dec;
55
56         for (l = srd_list_decoders(); l; l = l->next) {
57                 dec = l->data;
58                 if (!strcmp(dec->id, id))
59                         return dec;
60         }
61
62         return NULL;
63 }
64
65 static int get_probes(struct srd_decoder *d, char *attr, GSList **pl)
66 {
67         PyObject *py_probelist, *py_entry;
68         struct srd_probe *p;
69         int ret, num_probes, i;
70
71         if (!PyObject_HasAttrString(d->py_dec, attr))
72                 /* No probes of this type specified. */
73                 return SRD_OK;
74
75         ret = SRD_ERR_PYTHON;
76         py_probelist = py_entry = NULL;
77
78         py_probelist = PyObject_GetAttrString(d->py_dec, attr);
79         if (!PyList_Check(py_probelist)) {
80                 srd_err("Protocol decoder %s %s attribute is not "
81                         "a list.", d->name, attr);
82                 goto err_out;
83         }
84
85         num_probes = PyList_Size(py_probelist);
86         if (num_probes == 0)
87                 /* Empty probelist. */
88                 return SRD_OK;
89
90         for (i = 0; i < num_probes; i++) {
91                 py_entry = PyList_GetItem(py_probelist, i);
92                 if (!PyDict_Check(py_entry)) {
93                         srd_err("Protocol decoder %s %s attribute is not "
94                                 "a list with dict elements.", d->name, attr);
95                         goto err_out;
96                 }
97
98                 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
99                         srd_err("Failed to g_malloc() struct srd_probe.");
100                         ret = SRD_ERR_MALLOC;
101                         goto err_out;
102                 }
103
104                 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
105                         goto err_out;
106                 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
107                         goto err_out;
108                 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
109                         goto err_out;
110                 p->order = i;
111
112                 *pl = g_slist_append(*pl, p);
113         }
114         ret = SRD_OK;
115
116 err_out:
117         Py_DecRef(py_entry);
118         Py_DecRef(py_probelist);
119
120         return ret;
121 }
122
123 /**
124  * Load a protocol decoder module into the embedded Python interpreter.
125  *
126  * @param name The module name to be loaded.
127  *
128  * @return SRD_OK upon success, a (negative) error code otherwise.
129  */
130 SRD_API int srd_load_decoder(const char *module_name)
131 {
132         PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
133         struct srd_decoder *d;
134         int alen, ret, i;
135         char **ann;
136
137         srd_dbg("Loading module '%s'.", module_name);
138
139         py_basedec = py_method = py_attr = NULL;
140
141         if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
142                 srd_dbg("Failed to g_malloc() struct srd_decoder.");
143                 ret = SRD_ERR_MALLOC;
144                 goto err_out;
145         }
146
147         ret = SRD_ERR_PYTHON;
148
149         /* Import the Python module. */
150         if (!(d->py_mod = PyImport_ImportModule(module_name))) {
151                 catch_exception("import of '%s' failed.", module_name);
152                 goto err_out;
153         }
154
155         /* Get the 'Decoder' class as Python object. */
156         if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
157                 /* This generated an AttributeError exception. */
158                 PyErr_Clear();
159                 srd_err("Decoder class not found in protocol decoder %s.", module_name);
160                 goto err_out;
161         }
162
163         if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
164                 srd_dbg("sigrokdecode module not loaded.");
165                 goto err_out;
166         }
167
168         if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
169                 srd_err("Decoder class in protocol decoder module %s is not "
170                         "a subclass of sigrokdecode.Decoder.", module_name);
171                 goto err_out;
172         }
173         Py_CLEAR(py_basedec);
174
175         /* Check for a proper start() method. */
176         if (!PyObject_HasAttrString(d->py_dec, "start")) {
177                 srd_err("Protocol decoder %s has no start() method Decoder "
178                         "class.", module_name);
179                 goto err_out;
180         }
181         py_method = PyObject_GetAttrString(d->py_dec, "start");
182         if (!PyFunction_Check(py_method)) {
183                 srd_err("Protocol decoder %s Decoder class attribute 'start' "
184                         "is not a method.", module_name);
185                 goto err_out;
186         }
187         Py_CLEAR(py_method);
188
189         /* Check for a proper decode() method. */
190         if (!PyObject_HasAttrString(d->py_dec, "decode")) {
191                 srd_err("Protocol decoder %s has no decode() method Decoder "
192                         "class.", module_name);
193                 goto err_out;
194         }
195         py_method = PyObject_GetAttrString(d->py_dec, "decode");
196         if (!PyFunction_Check(py_method)) {
197                 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
198                         "is not a method.", module_name);
199                 goto err_out;
200         }
201         Py_CLEAR(py_method);
202
203         /* If present, options must be a dictionary. */
204         if (PyObject_HasAttrString(d->py_dec, "options")) {
205                 py_attr = PyObject_GetAttrString(d->py_dec, "options");
206                 if (!PyDict_Check(py_attr)) {
207                         srd_err("Protocol decoder %s options attribute is not "
208                                 "a dictionary.", d->name);
209                         Py_DecRef(py_attr);
210                         goto err_out;
211                 }
212                 Py_DecRef(py_attr);
213         }
214
215         /* Check and import required probes. */
216         if (get_probes(d, "probes", &d->probes) != SRD_OK)
217                 goto err_out;
218
219         /* Check and import optional probes. */
220         if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
221                 goto err_out;
222
223         /* Store required fields in newly allocated strings. */
224         if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
225                 goto err_out;
226
227         if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
228                 goto err_out;
229
230         if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
231                 goto err_out;
232
233         if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
234                 goto err_out;
235
236         if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
237                 goto err_out;
238
239         /* TODO: Handle inputformats, outputformats. */
240         d->inputformats = NULL;
241         d->outputformats = NULL;
242
243         /* Convert class annotation attribute to GSList of **char */
244         d->annotations = NULL;
245         if (PyObject_HasAttrString(d->py_dec, "annotations")) {
246                 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
247                 if (!PyList_Check(py_annlist)) {
248                         srd_err("Protocol decoder module %s annotations "
249                                 "should be a list.", module_name);
250                         goto err_out;
251                 }
252                 alen = PyList_Size(py_annlist);
253                 for (i = 0; i < alen; i++) {
254                         py_ann = PyList_GetItem(py_annlist, i);
255                         if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
256                                 srd_err("Protocol decoder module %s "
257                                         "annotation %d should be a list with "
258                                         "two elements.", module_name, i + 1);
259                                 goto err_out;
260                         }
261
262                         if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
263                                 goto err_out;
264                         }
265                         d->annotations = g_slist_append(d->annotations, ann);
266                 }
267         }
268
269         /* Append it to the list of supported/loaded decoders. */
270         pd_list = g_slist_append(pd_list, d);
271
272         ret = SRD_OK;
273
274 err_out:
275         if (ret != SRD_OK) {
276                 Py_XDECREF(py_method);
277                 Py_XDECREF(py_basedec);
278                 Py_XDECREF(d->py_dec);
279                 Py_XDECREF(d->py_mod);
280                 g_free(d);
281         }
282
283         return ret;
284 }
285
286 /**
287  * Return a protocol decoder's docstring.
288  *
289  * @param dec The loaded protocol decoder.
290  *
291  * @return A newly allocated buffer containing the docstring. The caller should
292  * free this after use.
293  */
294 SRD_API char *srd_decoder_doc(struct srd_decoder *dec)
295 {
296         PyObject *py_str;
297         char *doc;
298
299         if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
300                 return NULL;
301
302         if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
303                 catch_exception("");
304                 return NULL;
305         }
306
307         doc = NULL;
308         if (py_str != Py_None)
309                 py_str_as_str(py_str, &doc);
310         Py_DecRef(py_str);
311
312         return doc;
313 }
314
315 static void free_probes(GSList *probelist)
316 {
317         GSList *l;
318         struct srd_probe *p;
319
320         if (probelist == NULL)
321                 return;
322
323         for (l = probelist; l; l = l->next) {
324                 p = l->data;
325                 g_free(p->id);
326                 g_free(p->name);
327                 g_free(p->desc);
328                 g_free(p);
329         }
330         g_slist_free(probelist);
331
332 }
333
334 /**
335  * Unload decoder module.
336  *
337  * @param dec The struct srd_decoder to be unloaded.
338  *
339  * @return SRD_OK upon success, a (negative) error code otherwise.
340  */
341 SRD_API int srd_unload_decoder(struct srd_decoder *dec)
342 {
343         srd_dbg("unloading decoder %s", dec->name);
344
345         /* Since any instances of this decoder need to be released as well,
346          * but they could be anywhere in the stack, just free the entire
347          * stack. A frontend reloading a decoder thus has to restart all
348          * instances, and rebuild the stack. */
349         srd_inst_free_all(NULL);
350
351         free_probes(dec->probes);
352         free_probes(dec->opt_probes);
353         g_free(dec->id);
354         g_free(dec->name);
355         g_free(dec->longname);
356         g_free(dec->desc);
357         g_free(dec->license);
358
359         /* TODO: Free everything in inputformats and outputformats. */
360         if (dec->inputformats != NULL)
361                 g_slist_free(dec->inputformats);
362         if (dec->outputformats != NULL)
363                 g_slist_free(dec->outputformats);
364
365         /* The module's Decoder class. */
366         Py_XDECREF(dec->py_dec);
367         /* The module itself. */
368         Py_XDECREF(dec->py_mod);
369
370         /* TODO: (g_)free dec itself? */
371
372         return SRD_OK;
373 }
374
375 /**
376  * Load all installed protocol decoders.
377  *
378  * @return SRD_OK upon success, a (negative) error code otherwise.
379  */
380 SRD_API int srd_load_all_decoders(void)
381 {
382         GDir *dir;
383         GError *error;
384         const gchar *direntry;
385
386         if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
387                 srd_err("Unable to open %s for reading.", DECODERS_DIR);
388                 return SRD_ERR_DECODERS_DIR;
389         }
390
391         while ((direntry = g_dir_read_name(dir)) != NULL) {
392                 /* The directory name is the module name (e.g. "i2c"). */
393                 srd_load_decoder(direntry);
394         }
395         g_dir_close(dir);
396
397         return SRD_OK;
398 }
399
400 /**
401  * Unload all loaded protocol decoders.
402  *
403  * @return SRD_OK upon success, a (negative) error code otherwise.
404  */
405 SRD_API int srd_unload_all_decoders(void)
406 {
407         GSList *l;
408         struct srd_decoder *dec;
409
410         for (l = srd_list_decoders(); l; l = l->next) {
411                 dec = l->data;
412                 srd_unload_decoder(dec);
413         }
414
415         return SRD_OK;
416 }