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