2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "sigrokdecode-internal.h"
29 /* List of decoder instances. */
30 static GSList *di_list = NULL;
32 /* List of frontend callbacks to receive PD output. */
33 static GSList *callbacks = NULL;
35 /* lives in decoder.c */
36 extern GSList *pd_list;
38 /* lives in module_sigrokdecode.c */
39 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
41 /* lives in type_logic.c */
42 extern PyTypeObject srd_logic_type;
46 * Initialize libsigrokdecode.
48 * This initializes the Python interpreter, and creates and initializes
49 * a "sigrok" Python module with a single put() method.
51 * Then, it searches for sigrok protocol decoder files (*.py) in the
52 * "decoders" subdirectory of the the sigrok installation directory.
53 * All decoders that are found are loaded into memory and added to an
54 * internal list of decoders, which can be queried via srd_list_decoders().
56 * The caller is responsible for calling the clean-up function srd_exit(),
57 * which will properly shut down libsigrokdecode and free its allocated memory.
59 * Multiple calls to srd_init(), without calling srd_exit() in between,
62 * @return SRD_OK upon success, a (negative) error code otherwise.
63 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
64 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
65 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
71 srd_dbg("srd: initializing");
73 /* Add our own module to the list of built-in modules. */
74 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
76 /* Initialize the python interpreter. */
79 if ((ret = set_modulepath()) != SRD_OK) {
84 if ((ret = srd_load_all_decoders()) != SRD_OK) {
94 * Shutdown libsigrokdecode.
96 * This frees all the memory allocated for protocol decoders and shuts down
97 * the Python interpreter.
99 * This function should only be called if there was a (successful!) invocation
100 * of srd_init() before. Calling this function multiple times in a row, without
101 * any successful srd_init() calls in between, is not allowed.
103 * @return SRD_OK upon success, a (negative) error code otherwise.
108 srd_dbg("srd: exiting");
110 srd_unload_all_decoders();
111 g_slist_free(pd_list);
113 /* Py_Finalize() returns void, any finalization errors are ignored. */
121 * Add search directories for the protocol decoders.
123 * TODO: add path from env var SIGROKDECODE_PATH, config etc
124 * TODO: Should take directoryname/path as input.
126 int set_modulepath(void)
135 * On Windows/MinGW, Python's sys.path needs entries of the form
136 * 'C:\\foo\\bar' instead of '/foo/bar'.
139 splitted = g_strsplit(DECODERS_DIR, "/", 0);
140 path = g_build_pathv("\\\\", splitted);
141 g_strfreev(splitted);
143 path = g_strdup(DECODERS_DIR);
146 /* TODO: Prepend instead of appending. */
147 /* TODO: Sanity check on 'path' (length, escape special chars, ...). */
148 s = g_strdup_printf("import sys; sys.path.append(r'%s')", path);
150 ret = PyRun_SimpleString(s);
160 * Set options in a decoder instance.
162 * @param di Decoder instance.
163 * @param options A GHashTable of options to set.
165 * Handled options are removed from the hash.
167 * @return SRD_OK upon success, a (negative) error code otherwise.
169 int srd_instance_set_options(struct srd_decoder_instance *di,
172 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
173 PyObject *py_optlist, *py_classval;
175 unsigned long long int val_ull;
176 int num_optkeys, ret, size, i;
179 if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
180 /* Decoder has no options. */
181 if (g_hash_table_size(options) == 0) {
182 /* No options provided. */
185 srd_err("Protocol decoder has no options.");
191 ret = SRD_ERR_PYTHON;
193 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
194 py_optlist = py_classval = NULL;
195 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
197 /* All of these are synthesized objects, so they're good. */
198 py_dec_optkeys = PyDict_Keys(py_dec_options);
199 num_optkeys = PyList_Size(py_dec_optkeys);
200 if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options")))
202 for (i = 0; i < num_optkeys; i++) {
203 /* Get the default class value for this option. */
204 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
205 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
207 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
209 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
210 srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name);
214 if ((value = g_hash_table_lookup(options, key))) {
215 /* An override for this option was provided. */
216 if (PyUnicode_Check(py_classval)) {
217 if (!(py_optval = PyUnicode_FromString(value))) {
218 /* Some UTF-8 encoding error. */
222 } else if (PyLong_Check(py_classval)) {
223 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
224 /* ValueError Exception */
226 srd_err("Option %s has invalid value %s: expected integer.",
231 g_hash_table_remove(options, key);
233 /* Use the class default for this option. */
234 if (PyUnicode_Check(py_classval)) {
235 /* Make a brand new copy of the string. */
236 py_ustr = PyUnicode_AS_UNICODE(py_classval);
237 size = PyUnicode_GET_SIZE(py_classval);
238 py_optval = PyUnicode_FromUnicode(py_ustr, size);
239 } else if (PyLong_Check(py_classval)) {
240 /* Make a brand new copy of the integer. */
241 val_ull = PyLong_AsUnsignedLongLong(py_classval);
242 if (val_ull == (unsigned long long)-1) {
243 /* OverFlowError exception */
245 srd_err("Invalid integer value for %s: expected integer.", key);
248 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
253 /* If we got here, py_optval holds a known good new reference
254 * to the instance option to set.
256 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
263 Py_XDECREF(py_optlist);
264 Py_XDECREF(py_di_options);
265 Py_XDECREF(py_dec_optkeys);
266 Py_XDECREF(py_dec_options);
269 if (PyErr_Occurred())
270 catch_exception("srd: stray exception in srd_instance_set_options()");
275 /* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */
276 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
279 return strcmp(a->id, probe_id);
283 * Set probes in a decoder instance.
285 * @param di Decoder instance.
286 * @param probes A GHashTable of probes to set. Key is probe name, value is
287 * the probe number. Samples passed to this instance will be arranged in this
290 * @return SRD_OK upon success, a (negative) error code otherwise.
292 int srd_instance_set_probes(struct srd_decoder_instance *di,
293 GHashTable *new_probes)
298 int *new_probemap, new_probenum;
299 char *probe_id, *probenum_str;
301 if (g_hash_table_size(new_probes) == 0)
302 /* No probes provided. */
305 if(di->dec_num_probes == 0) {
306 /* Decoder has no probes. */
307 srd_err("Protocol decoder %s has no probes to define.",
314 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
315 srd_err("Failed to malloc new probe map.");
316 return SRD_ERR_MALLOC;
319 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
321 probenum_str = g_hash_table_lookup(new_probes, probe_id);
323 /* Probe name was specified without a value. */
324 srd_err("No probe number was specified for %s.", probe_id);
325 g_free(new_probemap);
328 new_probenum = strtol(probenum_str, NULL, 10);
329 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
330 (GCompareFunc)compare_probe_id))) {
331 /* Fall back on optional probes. */
332 if (!(sl = g_slist_find_custom(di->decoder->extra_probes,
333 probe_id, (GCompareFunc)compare_probe_id))) {
334 srd_err("Protocol decoder %s has no probe '%s'.",
335 di->decoder->name, probe_id);
336 g_free(new_probemap);
341 new_probemap[p->order] = new_probenum;
343 g_free(di->dec_probemap);
344 di->dec_probemap = new_probemap;
350 * Create a new protocol decoder instance.
352 * @param id Decoder 'id' field.
353 * @param options GHashtable of options which override the defaults set in
355 * @return Pointer to a newly allocated struct srd_decoder_instance, or
356 * NULL in case of failure.
358 struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
361 struct srd_decoder *dec;
362 struct srd_decoder_instance *di;
366 srd_dbg("srd: creating new %s instance", decoder_id);
368 if (!(dec = srd_get_decoder_by_id(decoder_id))) {
369 srd_err("Protocol decoder %s not found.", decoder_id);
373 if (!(di = g_try_malloc0(sizeof(*di)))) {
374 srd_err("Failed to malloc instance.");
378 instance_id = g_hash_table_lookup(options, "id");
380 di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
381 g_hash_table_remove(options, "id");
383 /* Prepare a default probe map, where samples come in the
384 * order in which the decoder class defined them.
386 di->dec_num_probes = g_slist_length(di->decoder->probes) +
387 g_slist_length(di->decoder->extra_probes);
388 if (di->dec_num_probes) {
389 if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
390 srd_err("Failed to malloc probe map.");
394 for (i = 0; i < di->dec_num_probes; i++)
395 di->dec_probemap[i] = i;
398 /* Create a new instance of this decoder class. */
399 if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
400 if (PyErr_Occurred())
401 catch_exception("failed to create %s instance: ", decoder_id);
402 g_free(di->dec_probemap);
407 if (srd_instance_set_options(di, options) != SRD_OK) {
408 g_free(di->dec_probemap);
413 /* Instance takes input from a frontend by default. */
414 di_list = g_slist_append(di_list, di);
419 int srd_instance_stack(struct srd_decoder_instance *di_from,
420 struct srd_decoder_instance *di_to)
423 if (!di_from || !di_to) {
424 srd_err("Invalid from/to instance pair.");
428 if (!g_slist_find(di_list, di_from)) {
429 srd_err("Unstacked instance not found.");
433 /* Remove from the unstacked list. */
434 di_list = g_slist_remove(di_list, di_to);
436 /* Stack on top of source di. */
437 di_from->next_di = g_slist_append(di_from->next_di, di_to);
443 /* TODO: this should go into the PD stack */
444 struct srd_decoder_instance *srd_instance_find(char *instance_id)
447 struct srd_decoder_instance *tmp, *di;
450 for (l = di_list; l; l = l->next) {
452 if (!strcmp(tmp->instance_id, instance_id)) {
461 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
463 PyObject *py_name, *py_res;
465 srd_dbg("srd: calling start() method on protocol decoder instance %s",
468 if (!(py_name = PyUnicode_FromString("start"))) {
469 srd_err("Unable to build python object for 'start'.");
470 catch_exception("Protocol decoder instance %s: ", di->instance_id);
471 return SRD_ERR_PYTHON;
474 if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
475 py_name, args, NULL))) {
476 catch_exception("Protocol decoder instance %s: ", di->instance_id);
477 return SRD_ERR_PYTHON;
487 * Run the specified decoder function.
489 * @param start_samplenum The starting sample number for the buffer's sample
490 * set, relative to the start of capture.
491 * @param di The decoder instance to call.
492 * @param inbuf The buffer to decode.
493 * @param inbuflen Length of the buffer.
495 * @return SRD_OK upon success, a (negative) error code otherwise.
497 int srd_instance_decode(uint64_t start_samplenum,
498 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
502 uint64_t end_samplenum;
504 srd_dbg("srd: calling decode() on instance %s with %d bytes starting "
505 "at sample %d", di->instance_id, inbuflen, start_samplenum);
507 /* Return an error upon unusable input. */
509 srd_dbg("srd: empty decoder instance");
513 srd_dbg("srd: NULL buffer pointer");
517 srd_dbg("srd: empty buffer");
521 /* Create new srd_logic object. Each iteration around the PD's loop
522 * will fill one sample into this object.
524 logic = PyObject_New(srd_logic, &srd_logic_type);
527 logic->start_samplenum = start_samplenum;
529 logic->inbuf = inbuf;
530 logic->inbuflen = inbuflen;
531 logic->sample = PyList_New(2);
532 Py_INCREF(logic->sample);
534 Py_IncRef(di->py_instance);
535 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
536 if (!(py_res = PyObject_CallMethod(di->py_instance, "decode",
537 "KKO", logic->start_samplenum, end_samplenum, logic))) {
538 catch_exception("Protocol decoder instance %s: ", di->instance_id);
539 return SRD_ERR_PYTHON; /* TODO: More specific error? */
547 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
551 struct srd_decoder_instance *di;
554 srd_dbg("srd: calling start() on all instances with %d probes, "
555 "unitsize %d samplerate %d", num_probes, unitsize, samplerate);
557 /* Currently only one item of metadata is passed along to decoders,
558 * samplerate. This can be extended as needed.
560 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
561 srd_err("Unable to build python object for metadata.");
562 return SRD_ERR_PYTHON;
565 /* Run the start() method on all decoders receiving frontend data. */
566 for (d = di_list; d; d = d->next) {
568 di->data_num_probes = num_probes;
569 di->data_unitsize = unitsize;
570 di->data_samplerate = samplerate;
571 if ((ret = srd_instance_start(di, args) != SRD_OK))
574 /* Run the start() method on all decoders up the stack from this one. */
575 for (s = di->next_di; s; s = s->next) {
576 /* These don't need probes, unitsize and samplerate. */
578 if ((ret = srd_instance_start(di, args) != SRD_OK))
588 /* Feed logic samples to decoder session. */
589 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
594 srd_dbg("srd: calling decode() on all instances with starting sample "
595 "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum,
598 for (d = di_list; d; d = d->next) {
599 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
600 inbuflen)) != SRD_OK)
608 int srd_register_callback(int output_type, void *cb)
610 struct srd_pd_callback *pd_cb;
612 srd_dbg("srd: registering new callback for output type %d", output_type);
614 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
615 return SRD_ERR_MALLOC;
617 pd_cb->output_type = output_type;
618 pd_cb->callback = cb;
619 callbacks = g_slist_append(callbacks, pd_cb);
624 void *srd_find_callback(int output_type)
627 struct srd_pd_callback *pd_cb;
631 for (l = callbacks; l; l = l->next) {
633 if (pd_cb->output_type == output_type) {
634 cb = pd_cb->callback;
643 /* This is the backend function to python sigrokdecode.add() call. */
644 int pd_add(struct srd_decoder_instance *di, int output_type,
647 struct srd_pd_output *pdo;
649 srd_dbg("srd: instance %s creating new output type %d for %s",
650 di->instance_id, output_type, proto_id);
652 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
655 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
656 pdo->pdo_id = g_slist_length(di->pd_output);
657 pdo->output_type = output_type;
658 pdo->decoder = di->decoder;
659 pdo->proto_id = g_strdup(proto_id);
660 di->pd_output = g_slist_append(di->pd_output, pdo);
665 struct srd_decoder_instance *get_di_by_decobject(void *decobject)
668 struct srd_decoder_instance *di;
670 for (l = di_list; l; l = l->next) {
672 if (decobject == di->py_instance)
674 /* Check decoders stacked on top of this one. */
675 for (s = di->next_di; s; s = s->next) {
677 if (decobject == di->py_instance)