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("Initializing libsigrokdecode.");
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("Exiting libsigrokdecode.");
110 srd_unload_all_decoders();
111 g_slist_free(pd_list);
113 /* Py_Finalize() returns void, any finalization errors are ignored. */
121 * Add an additional search directory for the protocol decoders.
123 * The specified directory is prepended (not appended!) to Python's sys.path,
124 * in order to search for sigrok protocol decoders in the specified
125 * directories first, and in the generic Python module directories (and in
126 * the current working directory) last. This avoids conflicts if there are
127 * Python modules which have the same name as a sigrok protocol decoder in
128 * sys.path or in the current working directory.
130 * TODO: add path from env var SIGROKDECODE_PATH, config etc
131 * TODO: Should take directoryname/path as input.
135 int set_modulepath(void)
144 * On Windows/MinGW, Python's sys.path needs entries of the form
145 * 'C:\\foo\\bar' instead of '/foo/bar'.
148 splitted = g_strsplit(DECODERS_DIR, "/", 0);
149 path = g_build_pathv("\\\\", splitted);
150 g_strfreev(splitted);
152 path = g_strdup(DECODERS_DIR);
155 /* TODO: Sanity check on 'path' (length, escape special chars, ...). */
156 s = g_strdup_printf("import sys; sys.path.insert(0, r'%s')", path);
158 ret = PyRun_SimpleString(s);
168 * Set options in a decoder instance.
170 * @param di Decoder instance.
171 * @param options A GHashTable of options to set.
173 * Handled options are removed from the hash.
175 * @return SRD_OK upon success, a (negative) error code otherwise.
177 int srd_instance_set_options(struct srd_decoder_instance *di,
180 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
181 PyObject *py_optlist, *py_classval;
183 unsigned long long int val_ull;
184 int num_optkeys, ret, size, i;
187 if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
188 /* Decoder has no options. */
189 if (g_hash_table_size(options) == 0) {
190 /* No options provided. */
193 srd_err("Protocol decoder has no options.");
199 ret = SRD_ERR_PYTHON;
201 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
202 py_optlist = py_classval = NULL;
203 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
205 /* All of these are synthesized objects, so they're good. */
206 py_dec_optkeys = PyDict_Keys(py_dec_options);
207 num_optkeys = PyList_Size(py_dec_optkeys);
208 if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options")))
210 for (i = 0; i < num_optkeys; i++) {
211 /* Get the default class value for this option. */
212 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
213 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
215 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
217 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
218 srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name);
222 if ((value = g_hash_table_lookup(options, key))) {
223 /* An override for this option was provided. */
224 if (PyUnicode_Check(py_classval)) {
225 if (!(py_optval = PyUnicode_FromString(value))) {
226 /* Some UTF-8 encoding error. */
230 } else if (PyLong_Check(py_classval)) {
231 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
232 /* ValueError Exception */
234 srd_err("Option %s has invalid value %s: expected integer.",
239 g_hash_table_remove(options, key);
241 /* Use the class default for this option. */
242 if (PyUnicode_Check(py_classval)) {
243 /* Make a brand new copy of the string. */
244 py_ustr = PyUnicode_AS_UNICODE(py_classval);
245 size = PyUnicode_GET_SIZE(py_classval);
246 py_optval = PyUnicode_FromUnicode(py_ustr, size);
247 } else if (PyLong_Check(py_classval)) {
248 /* Make a brand new copy of the integer. */
249 val_ull = PyLong_AsUnsignedLongLong(py_classval);
250 if (val_ull == (unsigned long long)-1) {
251 /* OverFlowError exception */
253 srd_err("Invalid integer value for %s: expected integer.", key);
256 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
261 /* If we got here, py_optval holds a known good new reference
262 * to the instance option to set.
264 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
271 Py_XDECREF(py_optlist);
272 Py_XDECREF(py_di_options);
273 Py_XDECREF(py_dec_optkeys);
274 Py_XDECREF(py_dec_options);
277 if (PyErr_Occurred())
278 catch_exception("Stray exception in srd_instance_set_options().");
283 /* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */
284 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
287 return strcmp(a->id, probe_id);
291 * Set probes in a decoder instance.
293 * @param di Decoder instance.
294 * @param probes A GHashTable of probes to set. Key is probe name, value is
295 * the probe number. Samples passed to this instance will be arranged in this
298 * @return SRD_OK upon success, a (negative) error code otherwise.
300 int srd_instance_set_probes(struct srd_decoder_instance *di,
301 GHashTable *new_probes)
306 int *new_probemap, new_probenum;
307 char *probe_id, *probenum_str;
309 srd_dbg("set probes called for instance %s with list of %d probes",
310 di->instance_id, g_hash_table_size(new_probes));
312 if (g_hash_table_size(new_probes) == 0)
313 /* No probes provided. */
316 if(di->dec_num_probes == 0) {
317 /* Decoder has no probes. */
318 srd_err("Protocol decoder %s has no probes to define.",
325 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
326 srd_err("Failed to malloc new probe map.");
327 return SRD_ERR_MALLOC;
330 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
332 probenum_str = g_hash_table_lookup(new_probes, probe_id);
334 /* Probe name was specified without a value. */
335 srd_err("No probe number was specified for %s.", probe_id);
336 g_free(new_probemap);
339 new_probenum = strtol(probenum_str, NULL, 10);
340 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
341 (GCompareFunc)compare_probe_id))) {
342 /* Fall back on optional probes. */
343 if (!(sl = g_slist_find_custom(di->decoder->extra_probes,
344 probe_id, (GCompareFunc)compare_probe_id))) {
345 srd_err("Protocol decoder %s has no probe '%s'.",
346 di->decoder->name, probe_id);
347 g_free(new_probemap);
352 new_probemap[p->order] = new_probenum;
353 srd_dbg("setting probe mapping for %d = probe %d", p->order, new_probenum);
355 g_free(di->dec_probemap);
356 di->dec_probemap = new_probemap;
362 * Create a new protocol decoder instance.
364 * @param id Decoder 'id' field.
365 * @param options GHashtable of options which override the defaults set in
367 * @return Pointer to a newly allocated struct srd_decoder_instance, or
368 * NULL in case of failure.
370 struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
373 struct srd_decoder *dec;
374 struct srd_decoder_instance *di;
378 srd_dbg("Creating new %s instance.", decoder_id);
380 if (!(dec = srd_get_decoder_by_id(decoder_id))) {
381 srd_err("Protocol decoder %s not found.", decoder_id);
385 if (!(di = g_try_malloc0(sizeof(*di)))) {
386 srd_err("Failed to malloc instance.");
390 instance_id = g_hash_table_lookup(options, "id");
392 di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
393 g_hash_table_remove(options, "id");
395 /* Prepare a default probe map, where samples come in the
396 * order in which the decoder class defined them.
398 di->dec_num_probes = g_slist_length(di->decoder->probes) +
399 g_slist_length(di->decoder->extra_probes);
400 if (di->dec_num_probes) {
401 if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
402 srd_err("Failed to malloc probe map.");
406 for (i = 0; i < di->dec_num_probes; i++)
407 di->dec_probemap[i] = i;
410 /* Create a new instance of this decoder class. */
411 if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
412 if (PyErr_Occurred())
413 catch_exception("failed to create %s instance: ", decoder_id);
414 g_free(di->dec_probemap);
419 if (srd_instance_set_options(di, options) != SRD_OK) {
420 g_free(di->dec_probemap);
425 /* Instance takes input from a frontend by default. */
426 di_list = g_slist_append(di_list, di);
431 int srd_instance_stack(struct srd_decoder_instance *di_from,
432 struct srd_decoder_instance *di_to)
435 if (!di_from || !di_to) {
436 srd_err("Invalid from/to instance pair.");
440 if (g_slist_find(di_list, di_to)) {
441 /* Remove from the unstacked list. */
442 di_list = g_slist_remove(di_list, di_to);
445 /* Stack on top of source di. */
446 di_from->next_di = g_slist_append(di_from->next_di, di_to);
452 * Finds a decoder instance by its instance id, but only in the bottom
453 * level of instances -- instances already stacked on top of another one
456 * @param instance_id The instance id to be found.
458 * @return Pointer to struct srd_decoder_instance, or NULL if not found.
460 struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id)
463 struct srd_decoder_instance *tmp, *di;
466 for (l = di_list; l; l = l->next) {
468 if (!strcmp(tmp->instance_id, instance_id)) {
478 * Finds a decoder instance by its python object, i.e. that instance's
479 * instantiation of the sigrokdecode.Decoder class. This will recurse
480 * to find the instance anywhere in the stack tree.
482 * @param stack Pointer to a GSList of struct srd_decoder_instance,
483 * indicating the stack to search. To start searching at the bottom
484 * level of decoder instances, pass NULL.
485 * @param obj The python class instantiation.
487 * @return Pointer to struct srd_decoder_instance, or NULL if not found.
489 struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
493 struct srd_decoder_instance *tmp, *di;
496 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
498 if (tmp->py_instance == obj)
500 else if (tmp->next_di)
501 di = srd_instance_find_by_obj(tmp->next_di, obj);
507 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
509 PyObject *py_name, *py_res;
511 struct srd_decoder_instance *next_di;
513 srd_dbg("Calling start() method on protocol decoder instance %s.",
516 if (!(py_name = PyUnicode_FromString("start"))) {
517 srd_err("Unable to build python object for 'start'.");
518 catch_exception("Protocol decoder instance %s: ", di->instance_id);
519 return SRD_ERR_PYTHON;
522 if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
523 py_name, args, NULL))) {
524 catch_exception("Protocol decoder instance %s: ", di->instance_id);
525 return SRD_ERR_PYTHON;
531 /* Start all the PDs stacked on top of this one. Pass along the
532 * metadata all the way from the bottom PD, even though it's only
533 * applicable to logic data for now.
535 for (l = di->next_di; l; l = l->next) {
537 srd_instance_start(next_di, args);
544 * Run the specified decoder function.
546 * @param start_samplenum The starting sample number for the buffer's sample
547 * set, relative to the start of capture.
548 * @param di The decoder instance to call. Must not be NULL.
549 * @param inbuf The buffer to decode. Must not be NULL.
550 * @param inbuflen Length of the buffer. Must be > 0.
552 * @return SRD_OK upon success, a (negative) error code otherwise.
554 int srd_instance_decode(uint64_t start_samplenum,
555 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
559 uint64_t end_samplenum;
561 srd_dbg("Calling decode() on instance %s with %d bytes starting "
562 "at sample %d.", di->instance_id, inbuflen, start_samplenum);
564 /* Return an error upon unusable input. */
566 srd_dbg("empty decoder instance");
570 srd_dbg("NULL buffer pointer");
574 srd_dbg("empty buffer");
578 /* Create new srd_logic object. Each iteration around the PD's loop
579 * will fill one sample into this object.
581 logic = PyObject_New(srd_logic, &srd_logic_type);
584 logic->start_samplenum = start_samplenum;
586 logic->inbuf = inbuf;
587 logic->inbuflen = inbuflen;
588 logic->sample = PyList_New(2);
589 Py_INCREF(logic->sample);
591 Py_IncRef(di->py_instance);
592 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
593 if (!(py_res = PyObject_CallMethod(di->py_instance, "decode",
594 "KKO", logic->start_samplenum, end_samplenum, logic))) {
595 catch_exception("Protocol decoder instance %s: ", di->instance_id);
596 return SRD_ERR_PYTHON; /* TODO: More specific error? */
604 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
608 struct srd_decoder_instance *di;
611 srd_dbg("Calling start() on all instances with %d probes, "
612 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
614 /* Currently only one item of metadata is passed along to decoders,
615 * samplerate. This can be extended as needed.
617 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
618 srd_err("Unable to build python object for metadata.");
619 return SRD_ERR_PYTHON;
622 /* Run the start() method on all decoders receiving frontend data. */
623 for (d = di_list; d; d = d->next) {
625 di->data_num_probes = num_probes;
626 di->data_unitsize = unitsize;
627 di->data_samplerate = samplerate;
628 if ((ret = srd_instance_start(di, args) != SRD_OK))
637 /* Feed logic samples to decoder session. */
638 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
643 srd_dbg("Calling decode() on all instances with starting sample "
644 "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum,
647 for (d = di_list; d; d = d->next) {
648 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
649 inbuflen)) != SRD_OK)
657 int srd_register_callback(int output_type, void *cb)
659 struct srd_pd_callback *pd_cb;
661 srd_dbg("Registering new callback for output type %d.", output_type);
663 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
664 return SRD_ERR_MALLOC;
666 pd_cb->output_type = output_type;
667 pd_cb->callback = cb;
668 callbacks = g_slist_append(callbacks, pd_cb);
673 void *srd_find_callback(int output_type)
676 struct srd_pd_callback *pd_cb;
680 for (l = callbacks; l; l = l->next) {
682 if (pd_cb->output_type == output_type) {
683 cb = pd_cb->callback;
692 /* This is the backend function to python sigrokdecode.add() call. */
693 int pd_add(struct srd_decoder_instance *di, int output_type, char *proto_id)
695 struct srd_pd_output *pdo;
697 srd_dbg("Instance %s creating new output type %d for %s.",
698 di->instance_id, output_type, proto_id);
700 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
703 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
704 pdo->pdo_id = g_slist_length(di->pd_output);
705 pdo->output_type = output_type;
707 pdo->proto_id = g_strdup(proto_id);
708 di->pd_output = g_slist_append(di->pd_output, pdo);