]>
Commit | Line | Data |
---|---|---|
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 "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
22 | #include "sigrokdecode-internal.h" | |
23 | #include "config.h" | |
24 | #include <glib.h> | |
25 | #include <inttypes.h> | |
26 | #include <stdlib.h> | |
27 | ||
28 | ||
29 | static GSList *di_list = NULL; | |
30 | static GSList *callbacks = NULL; | |
31 | ||
32 | /* lives in decoder.c */ | |
33 | extern GSList *pd_list; | |
34 | ||
35 | /* lives in module_sigrokdecode.c */ | |
36 | extern PyMODINIT_FUNC PyInit_sigrokdecode(void); | |
37 | ||
38 | /* lives in type_logic.c */ | |
39 | extern PyTypeObject srd_logic_type; | |
40 | ||
41 | ||
42 | /** | |
43 | * Initialize libsigrokdecode. | |
44 | * | |
45 | * This initializes the Python interpreter, and creates and initializes | |
46 | * a "sigrok" Python module with a single put() method. | |
47 | * | |
48 | * Then, it searches for sigrok protocol decoder files (*.py) in the | |
49 | * "decoders" subdirectory of the the sigrok installation directory. | |
50 | * All decoders that are found are loaded into memory and added to an | |
51 | * internal list of decoders, which can be queried via srd_list_decoders(). | |
52 | * | |
53 | * The caller is responsible for calling the clean-up function srd_exit(), | |
54 | * which will properly shut down libsigrokdecode and free its allocated memory. | |
55 | * | |
56 | * Multiple calls to srd_init(), without calling srd_exit() in between, | |
57 | * are not allowed. | |
58 | * | |
59 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
60 | * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders | |
61 | * directory cannot be accessed, return SRD_ERR_DECODERS_DIR. | |
62 | * If not enough memory could be allocated, return SRD_ERR_MALLOC. | |
63 | */ | |
64 | int srd_init(void) | |
65 | { | |
66 | int ret; | |
67 | ||
68 | PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); | |
69 | ||
70 | /* Py_Initialize() returns void and usually cannot fail. */ | |
71 | Py_Initialize(); | |
72 | ||
73 | if ((ret = set_modulepath()) != SRD_OK) { | |
74 | Py_Finalize(); | |
75 | return ret; | |
76 | } | |
77 | ||
78 | if ((ret = srd_load_all_decoders()) != SRD_OK) { | |
79 | Py_Finalize(); | |
80 | return ret; | |
81 | } | |
82 | ||
83 | return SRD_OK; | |
84 | } | |
85 | ||
86 | ||
87 | /** | |
88 | * Shutdown libsigrokdecode. | |
89 | * | |
90 | * This frees all the memory allocated for protocol decoders and shuts down | |
91 | * the Python interpreter. | |
92 | * | |
93 | * This function should only be called if there was a (successful!) invocation | |
94 | * of srd_init() before. Calling this function multiple times in a row, without | |
95 | * any successful srd_init() calls in between, is not allowed. | |
96 | * | |
97 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
98 | */ | |
99 | int srd_exit(void) | |
100 | { | |
101 | /* Unload/free all decoders, and then the list of decoders itself. */ | |
102 | /* TODO: Error handling. */ | |
103 | srd_unload_all_decoders(); | |
104 | g_slist_free(pd_list); | |
105 | ||
106 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
107 | Py_Finalize(); | |
108 | ||
109 | return SRD_OK; | |
110 | } | |
111 | ||
112 | ||
113 | /** | |
114 | * Add search directories for the protocol decoders. | |
115 | * | |
116 | * TODO: add path from env var SIGROKDECODE_PATH, config etc | |
117 | * TODO: Should take directoryname/path as input. | |
118 | */ | |
119 | int set_modulepath(void) | |
120 | { | |
121 | int ret; | |
122 | gchar *path, *s; | |
123 | ||
124 | #ifdef _WIN32 | |
125 | gchar **splitted; | |
126 | ||
127 | /* | |
128 | * On Windows/MinGW, Python's sys.path needs entries of the form | |
129 | * 'C:\\foo\\bar' instead of '/foo/bar'. | |
130 | */ | |
131 | ||
132 | splitted = g_strsplit(DECODERS_DIR, "/", 0); | |
133 | path = g_build_pathv("\\\\", splitted); | |
134 | g_strfreev(splitted); | |
135 | #else | |
136 | path = g_strdup(DECODERS_DIR); | |
137 | #endif | |
138 | ||
139 | /* TODO: Prepend instead of appending. */ | |
140 | /* TODO: Sanity check on 'path' (length, escape special chars, ...). */ | |
141 | s = g_strdup_printf("import sys; sys.path.append(r'%s')", path); | |
142 | ||
143 | ret = PyRun_SimpleString(s); | |
144 | ||
145 | g_free(path); | |
146 | g_free(s); | |
147 | ||
148 | return ret; | |
149 | } | |
150 | ||
151 | ||
152 | /** | |
153 | * Set options in a decoder instance. | |
154 | * | |
155 | * @param di Decoder instance. | |
156 | * @param options A GHashTable of options to set. | |
157 | * | |
158 | * Handled options are removed from the hash. | |
159 | * | |
160 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
161 | */ | |
162 | int srd_instance_set_options(struct srd_decoder_instance *di, | |
163 | GHashTable *options) | |
164 | { | |
165 | PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; | |
166 | PyObject *py_optlist, *py_classval; | |
167 | Py_UNICODE *py_ustr; | |
168 | unsigned long long int val_ull; | |
169 | int num_optkeys, ret, size, i; | |
170 | char *key, *value; | |
171 | ||
172 | if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) { | |
173 | /* Decoder has no options. */ | |
174 | if (g_hash_table_size(options) == 0) { | |
175 | /* No options provided. */ | |
176 | return SRD_OK; | |
177 | } else { | |
178 | srd_err("Protocol decoder has no options."); | |
179 | return SRD_ERR_ARG; | |
180 | } | |
181 | return SRD_OK; | |
182 | } | |
183 | ||
184 | ret = SRD_ERR_PYTHON; | |
185 | key = NULL; | |
186 | py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; | |
187 | py_optlist = py_classval = NULL; | |
188 | py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); | |
189 | ||
190 | /* All of these are synthesized objects, so they're good. */ | |
191 | py_dec_optkeys = PyDict_Keys(py_dec_options); | |
192 | num_optkeys = PyList_Size(py_dec_optkeys); | |
193 | if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options"))) | |
194 | goto err_out; | |
195 | for (i = 0; i < num_optkeys; i++) { | |
196 | /* Get the default class value for this option. */ | |
197 | py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); | |
198 | if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) | |
199 | goto err_out; | |
200 | if (!(py_classval = PyList_GetItem(py_optlist, 1))) | |
201 | goto err_out; | |
202 | if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { | |
203 | srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name); | |
204 | goto err_out; | |
205 | } | |
206 | ||
207 | if ((value = g_hash_table_lookup(options, key))) { | |
208 | /* An override for this option was provided. */ | |
209 | if (PyUnicode_Check(py_classval)) { | |
210 | if (!(py_optval = PyUnicode_FromString(value))) { | |
211 | /* Some UTF-8 encoding error. */ | |
212 | PyErr_Clear(); | |
213 | goto err_out; | |
214 | } | |
215 | } else if (PyLong_Check(py_classval)) { | |
216 | if (!(py_optval = PyLong_FromString(value, NULL, 0))) { | |
217 | /* ValueError Exception */ | |
218 | PyErr_Clear(); | |
219 | srd_err("Option %s has invalid value %s: expected integer", | |
220 | key, value); | |
221 | goto err_out; | |
222 | } | |
223 | } | |
224 | g_hash_table_remove(options, key); | |
225 | } else { | |
226 | /* Use the class default for this option. */ | |
227 | if (PyUnicode_Check(py_classval)) { | |
228 | /* Make a brand new copy of the string. */ | |
229 | py_ustr = PyUnicode_AS_UNICODE(py_classval); | |
230 | size = PyUnicode_GET_SIZE(py_classval); | |
231 | py_optval = PyUnicode_FromUnicode(py_ustr, size); | |
232 | } else if (PyLong_Check(py_classval)) { | |
233 | /* Make a brand new copy of the integer. */ | |
234 | val_ull = PyLong_AsUnsignedLongLong(py_classval); | |
235 | if (val_ull == (unsigned long long)-1) { | |
236 | /* OverFlowError exception */ | |
237 | PyErr_Clear(); | |
238 | srd_err("Invalid integer value for %s: expected integer", key); | |
239 | goto err_out; | |
240 | } | |
241 | if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) | |
242 | goto err_out; | |
243 | } | |
244 | } | |
245 | ||
246 | /* If we got here, py_optval holds a known good new reference | |
247 | * to the instance option to set. | |
248 | */ | |
249 | if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) | |
250 | goto err_out; | |
251 | } | |
252 | ||
253 | ret = SRD_OK; | |
254 | ||
255 | err_out: | |
256 | Py_XDECREF(py_optlist); | |
257 | Py_XDECREF(py_di_options); | |
258 | Py_XDECREF(py_dec_optkeys); | |
259 | Py_XDECREF(py_dec_options); | |
260 | if (key) | |
261 | g_free(key); | |
262 | if (PyErr_Occurred()) { | |
263 | srd_dbg("stray exception!"); | |
264 | PyErr_Print(); | |
265 | PyErr_Clear(); | |
266 | } | |
267 | ||
268 | return ret; | |
269 | } | |
270 | ||
271 | /** | |
272 | * Set probes in a decoder instance. | |
273 | * | |
274 | * @param di Decoder instance. | |
275 | * @param probes A GHashTable of probes to set. Key is probe name, value is | |
276 | * the probe number. Samples passed to this instance will be arranged in this | |
277 | * order. | |
278 | * | |
279 | * Handled probes are removed from the hash. | |
280 | * | |
281 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
282 | */ | |
283 | int srd_instance_set_probes(struct srd_decoder_instance *di, | |
284 | GHashTable *probes) | |
285 | { | |
286 | int ret; | |
287 | ||
288 | if (g_hash_table_size(probes) == 0) | |
289 | /* No probes provided. */ | |
290 | return SRD_OK; | |
291 | ||
292 | if(!PyObject_HasAttrString(di->decoder->py_dec, "probes")) | |
293 | /* Decoder has no probes. */ | |
294 | return SRD_OK; | |
295 | ||
296 | ret = SRD_ERR_PYTHON; | |
297 | ||
298 | /* TODO */ | |
299 | if (g_hash_table_size(probes) > 0) { | |
300 | srd_err("Setting probes is not yet supported."); | |
301 | return SRD_ERR_PYTHON; | |
302 | } | |
303 | ||
304 | ret = SRD_OK; | |
305 | ||
306 | return ret; | |
307 | } | |
308 | ||
309 | /** | |
310 | * Create a new protocol decoder instance. | |
311 | * | |
312 | * @param id Decoder 'id' field. | |
313 | * @param options GHashtable of options which override the defaults set in | |
314 | * the decoder class. | |
315 | * @return Pointer to a newly allocated struct srd_decoder_instance, or | |
316 | * NULL in case of failure. | |
317 | */ | |
318 | struct srd_decoder_instance *srd_instance_new(const char *decoder_id, | |
319 | GHashTable *options) | |
320 | { | |
321 | struct srd_decoder *dec; | |
322 | struct srd_decoder_instance *di; | |
323 | char *instance_id; | |
324 | ||
325 | srd_dbg("%s: creating new %s instance", __func__, decoder_id); | |
326 | ||
327 | if (!(dec = srd_get_decoder_by_id(decoder_id))) { | |
328 | srd_err("Protocol decoder %s not found.", decoder_id); | |
329 | return NULL; | |
330 | } | |
331 | ||
332 | if (!(di = g_try_malloc0(sizeof(*di)))) { | |
333 | srd_err("Failed to malloc instance."); | |
334 | return NULL; | |
335 | } | |
336 | ||
337 | instance_id = g_hash_table_lookup(options, "id"); | |
338 | di->decoder = dec; | |
339 | di->instance_id = g_strdup(instance_id ? instance_id : decoder_id); | |
340 | g_hash_table_remove(options, "id"); | |
341 | ||
342 | /* Create a new instance of this decoder class. */ | |
343 | if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) { | |
344 | if (PyErr_Occurred()) | |
345 | PyErr_Print(); | |
346 | g_free(di); | |
347 | return NULL; | |
348 | } | |
349 | ||
350 | /* Instance takes input from a frontend by default. */ | |
351 | di_list = g_slist_append(di_list, di); | |
352 | ||
353 | if (srd_instance_set_options(di, options) != SRD_OK) { | |
354 | di_list = g_slist_remove(di_list, di); | |
355 | g_free(di); | |
356 | return NULL; | |
357 | } | |
358 | ||
359 | return di; | |
360 | } | |
361 | ||
362 | int srd_instance_stack(struct srd_decoder_instance *di_from, | |
363 | struct srd_decoder_instance *di_to) | |
364 | { | |
365 | ||
366 | if (!di_from || !di_to) { | |
367 | srd_err("invalid from/to instance pair"); | |
368 | return SRD_ERR_ARG; | |
369 | } | |
370 | ||
371 | if (!g_slist_find(di_list, di_from)) { | |
372 | srd_err("unstacked instance not found"); | |
373 | return SRD_ERR_ARG; | |
374 | } | |
375 | ||
376 | /* Remove from the unstacked list. */ | |
377 | di_list = g_slist_remove(di_list, di_to); | |
378 | ||
379 | /* Stack on top of source di. */ | |
380 | di_from->next_di = g_slist_append(di_from->next_di, di_to); | |
381 | ||
382 | return SRD_OK; | |
383 | } | |
384 | ||
385 | ||
386 | /* TODO: this should go into the PD stack */ | |
387 | struct srd_decoder_instance *srd_instance_find(char *instance_id) | |
388 | { | |
389 | GSList *l; | |
390 | struct srd_decoder_instance *tmp, *di; | |
391 | ||
392 | di = NULL; | |
393 | for (l = di_list; l; l = l->next) { | |
394 | tmp = l->data; | |
395 | if (!strcmp(tmp->instance_id, instance_id)) { | |
396 | di = tmp; | |
397 | break; | |
398 | } | |
399 | } | |
400 | ||
401 | return di; | |
402 | } | |
403 | ||
404 | int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) | |
405 | { | |
406 | PyObject *py_name, *py_res; | |
407 | ||
408 | srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id); | |
409 | ||
410 | if (!(py_name = PyUnicode_FromString("start"))) { | |
411 | srd_err("unable to build python object for 'start'"); | |
412 | if (PyErr_Occurred()) | |
413 | PyErr_Print(); | |
414 | return SRD_ERR_PYTHON; | |
415 | } | |
416 | ||
417 | if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance, | |
418 | py_name, args, NULL))) { | |
419 | if (PyErr_Occurred()) | |
420 | PyErr_Print(); | |
421 | return SRD_ERR_PYTHON; | |
422 | } | |
423 | ||
424 | Py_XDECREF(py_res); | |
425 | Py_DECREF(py_name); | |
426 | ||
427 | return SRD_OK; | |
428 | } | |
429 | ||
430 | /** | |
431 | * Run the specified decoder function. | |
432 | * | |
433 | * @param dec TODO | |
434 | * @param inbuf TODO | |
435 | * @param inbuflen TODO | |
436 | * | |
437 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
438 | */ | |
439 | int srd_instance_decode(uint64_t start_samplenum, | |
440 | struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen) | |
441 | { | |
442 | PyObject *py_instance, *py_res; | |
443 | srd_logic *logic; | |
444 | uint64_t end_samplenum; | |
445 | ||
446 | /* Return an error upon unusable input. */ | |
447 | if (di == NULL) | |
448 | return SRD_ERR_ARG; /* TODO: More specific error? */ | |
449 | if (inbuf == NULL) | |
450 | return SRD_ERR_ARG; /* TODO: More specific error? */ | |
451 | if (inbuflen == 0) /* No point in working on empty buffers. */ | |
452 | return SRD_ERR_ARG; /* TODO: More specific error? */ | |
453 | ||
454 | /* TODO: Error handling. */ | |
455 | py_instance = di->py_instance; | |
456 | Py_XINCREF(py_instance); | |
457 | ||
458 | logic = PyObject_New(srd_logic, &srd_logic_type); | |
459 | Py_INCREF(logic); | |
460 | logic->di = di; | |
461 | logic->start_samplenum = start_samplenum; | |
462 | logic->itercnt = 0; | |
463 | logic->inbuf = inbuf; | |
464 | logic->inbuflen = inbuflen; | |
465 | logic->sample = PyList_New(2); | |
466 | Py_INCREF(logic->sample); | |
467 | ||
468 | end_samplenum = start_samplenum + inbuflen / di->unitsize; | |
469 | if (!(py_res = PyObject_CallMethod(py_instance, "decode", | |
470 | "KKO", logic->start_samplenum, end_samplenum, logic))) { | |
471 | if (PyErr_Occurred()) | |
472 | PyErr_Print(); /* Returns void. */ | |
473 | ||
474 | return SRD_ERR_PYTHON; /* TODO: More specific error? */ | |
475 | } | |
476 | ||
477 | Py_XDECREF(py_res); | |
478 | ||
479 | return SRD_OK; | |
480 | } | |
481 | ||
482 | ||
483 | int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) | |
484 | { | |
485 | PyObject *args; | |
486 | GSList *d, *s; | |
487 | struct srd_decoder_instance *di; | |
488 | int ret; | |
489 | ||
490 | if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { | |
491 | srd_err("unable to build python object for metadata"); | |
492 | return SRD_ERR_PYTHON; | |
493 | } | |
494 | ||
495 | /* Run the start() method on all decoders receiving frontend data. */ | |
496 | for (d = di_list; d; d = d->next) { | |
497 | di = d->data; | |
498 | di->num_probes = num_probes; | |
499 | di->unitsize = unitsize; | |
500 | di->samplerate = samplerate; | |
501 | if ((ret = srd_instance_start(di, args) != SRD_OK)) | |
502 | return ret; | |
503 | ||
504 | /* Run the start() method on all decoders up the stack from this one. */ | |
505 | for (s = di->next_di; s; s = s->next) { | |
506 | /* These don't need probes, unitsize and samplerate. */ | |
507 | di = s->data; | |
508 | if ((ret = srd_instance_start(di, args) != SRD_OK)) | |
509 | return ret; | |
510 | } | |
511 | } | |
512 | ||
513 | Py_DECREF(args); | |
514 | ||
515 | return SRD_OK; | |
516 | } | |
517 | ||
518 | /* Feed logic samples to decoder session. */ | |
519 | int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen) | |
520 | { | |
521 | GSList *d; | |
522 | int ret; | |
523 | ||
524 | for (d = di_list; d; d = d->next) { | |
525 | if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf, | |
526 | inbuflen)) != SRD_OK) | |
527 | return ret; | |
528 | } | |
529 | ||
530 | return SRD_OK; | |
531 | } | |
532 | ||
533 | ||
534 | int pd_add(struct srd_decoder_instance *di, int output_type, | |
535 | char *proto_id) | |
536 | { | |
537 | struct srd_pd_output *pdo; | |
538 | ||
539 | if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) | |
540 | return -1; | |
541 | ||
542 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ | |
543 | pdo->pdo_id = g_slist_length(di->pd_output); | |
544 | pdo->output_type = output_type; | |
545 | pdo->decoder = di->decoder; | |
546 | pdo->proto_id = g_strdup(proto_id); | |
547 | di->pd_output = g_slist_append(di->pd_output, pdo); | |
548 | ||
549 | return pdo->pdo_id; | |
550 | } | |
551 | ||
552 | struct srd_decoder_instance *get_di_by_decobject(void *decobject) | |
553 | { | |
554 | GSList *l, *s; | |
555 | struct srd_decoder_instance *di; | |
556 | ||
557 | for (l = di_list; l; l = l->next) { | |
558 | di = l->data; | |
559 | if (decobject == di->py_instance) | |
560 | return di; | |
561 | /* Check decoders stacked on top of this one. */ | |
562 | for (s = di->next_di; s; s = s->next) { | |
563 | di = s->data; | |
564 | if (decobject == di->py_instance) | |
565 | return di; | |
566 | } | |
567 | } | |
568 | ||
569 | return NULL; | |
570 | } | |
571 | ||
572 | int srd_register_callback(int output_type, void *cb) | |
573 | { | |
574 | struct srd_pd_callback *pd_cb; | |
575 | ||
576 | if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) | |
577 | return SRD_ERR_MALLOC; | |
578 | ||
579 | pd_cb->output_type = output_type; | |
580 | pd_cb->callback = cb; | |
581 | callbacks = g_slist_append(callbacks, pd_cb); | |
582 | ||
583 | return SRD_OK; | |
584 | } | |
585 | ||
586 | void *srd_find_callback(int output_type) | |
587 | { | |
588 | GSList *l; | |
589 | struct srd_pd_callback *pd_cb; | |
590 | void *(cb); | |
591 | ||
592 | cb = NULL; | |
593 | for (l = callbacks; l; l = l->next) { | |
594 | pd_cb = l->data; | |
595 | if (pd_cb->output_type == output_type) { | |
596 | cb = pd_cb->callback; | |
597 | break; | |
598 | } | |
599 | } | |
600 | ||
601 | return cb; | |
602 | } | |
603 |