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);
276 if (PyErr_Occurred())
277 catch_exception("Stray exception in srd_instance_set_options().");
282 /* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */
283 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
286 return strcmp(a->id, probe_id);
290 * Set probes in a decoder instance.
292 * @param di Decoder instance.
293 * @param probes A GHashTable of probes to set. Key is probe name, value is
294 * the probe number. Samples passed to this instance will be arranged in this
297 * @return SRD_OK upon success, a (negative) error code otherwise.
299 int srd_instance_set_probes(struct srd_decoder_instance *di,
300 GHashTable *new_probes)
305 int *new_probemap, new_probenum;
306 char *probe_id, *probenum_str;
308 srd_dbg("set probes called for instance %s with list of %d probes",
309 di->instance_id, g_hash_table_size(new_probes));
311 if (g_hash_table_size(new_probes) == 0)
312 /* No probes provided. */
315 if(di->dec_num_probes == 0) {
316 /* Decoder has no probes. */
317 srd_err("Protocol decoder %s has no probes to define.",
324 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
325 srd_err("Failed to malloc new probe map.");
326 return SRD_ERR_MALLOC;
329 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
331 probenum_str = g_hash_table_lookup(new_probes, probe_id);
333 /* Probe name was specified without a value. */
334 srd_err("No probe number was specified for %s.", probe_id);
335 g_free(new_probemap);
338 new_probenum = strtol(probenum_str, NULL, 10);
339 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
340 (GCompareFunc)compare_probe_id))) {
341 /* Fall back on optional probes. */
342 if (!(sl = g_slist_find_custom(di->decoder->extra_probes,
343 probe_id, (GCompareFunc)compare_probe_id))) {
344 srd_err("Protocol decoder %s has no probe '%s'.",
345 di->decoder->name, probe_id);
346 g_free(new_probemap);
351 new_probemap[p->order] = new_probenum;
352 srd_dbg("setting probe mapping for %d = probe %d", p->order, new_probenum);
354 g_free(di->dec_probemap);
355 di->dec_probemap = new_probemap;
361 * Create a new protocol decoder instance.
363 * @param id Decoder 'id' field.
364 * @param options GHashtable of options which override the defaults set in
366 * @return Pointer to a newly allocated struct srd_decoder_instance, or
367 * NULL in case of failure.
369 struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
372 struct srd_decoder *dec;
373 struct srd_decoder_instance *di;
377 srd_dbg("Creating new %s instance.", decoder_id);
379 if (!(dec = srd_get_decoder_by_id(decoder_id))) {
380 srd_err("Protocol decoder %s not found.", decoder_id);
384 if (!(di = g_try_malloc0(sizeof(*di)))) {
385 srd_err("Failed to malloc instance.");
389 instance_id = g_hash_table_lookup(options, "id");
391 di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
392 g_hash_table_remove(options, "id");
394 /* Prepare a default probe map, where samples come in the
395 * order in which the decoder class defined them.
397 di->dec_num_probes = g_slist_length(di->decoder->probes) +
398 g_slist_length(di->decoder->extra_probes);
399 if (di->dec_num_probes) {
400 if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
401 srd_err("Failed to malloc probe map.");
405 for (i = 0; i < di->dec_num_probes; i++)
406 di->dec_probemap[i] = i;
409 /* Create a new instance of this decoder class. */
410 if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
411 if (PyErr_Occurred())
412 catch_exception("failed to create %s instance: ", decoder_id);
413 g_free(di->dec_probemap);
418 if (srd_instance_set_options(di, options) != SRD_OK) {
419 g_free(di->dec_probemap);
424 /* Instance takes input from a frontend by default. */
425 di_list = g_slist_append(di_list, di);
430 int srd_instance_stack(struct srd_decoder_instance *di_from,
431 struct srd_decoder_instance *di_to)
434 if (!di_from || !di_to) {
435 srd_err("Invalid from/to instance pair.");
439 if (g_slist_find(di_list, di_to)) {
440 /* Remove from the unstacked list. */
441 di_list = g_slist_remove(di_list, di_to);
444 /* Stack on top of source di. */
445 di_from->next_di = g_slist_append(di_from->next_di, di_to);
451 * Finds a decoder instance by its instance id, but only in the bottom
452 * level of instances -- instances already stacked on top of another one
455 * @param instance_id The instance id to be found.
457 * @return Pointer to struct srd_decoder_instance, or NULL if not found.
459 struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id)
462 struct srd_decoder_instance *tmp, *di;
465 for (l = di_list; l; l = l->next) {
467 if (!strcmp(tmp->instance_id, instance_id)) {
477 * Finds a decoder instance by its python object, i.e. that instance's
478 * instantiation of the sigrokdecode.Decoder class. This will recurse
479 * to find the instance anywhere in the stack tree.
481 * @param stack Pointer to a GSList of struct srd_decoder_instance,
482 * indicating the stack to search. To start searching at the bottom
483 * level of decoder instances, pass NULL.
484 * @param obj The python class instantiation.
486 * @return Pointer to struct srd_decoder_instance, or NULL if not found.
488 struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
492 struct srd_decoder_instance *tmp, *di;
495 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
497 if (tmp->py_instance == obj)
499 else if (tmp->next_di)
500 di = srd_instance_find_by_obj(tmp->next_di, obj);
506 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
508 PyObject *py_name, *py_res;
510 struct srd_decoder_instance *next_di;
512 srd_dbg("Calling start() method on protocol decoder instance %s.",
515 if (!(py_name = PyUnicode_FromString("start"))) {
516 srd_err("Unable to build python object for 'start'.");
517 catch_exception("Protocol decoder instance %s: ", di->instance_id);
518 return SRD_ERR_PYTHON;
521 if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
522 py_name, args, NULL))) {
523 catch_exception("Protocol decoder instance %s: ", di->instance_id);
524 return SRD_ERR_PYTHON;
530 /* Start all the PDs stacked on top of this one. Pass along the
531 * metadata all the way from the bottom PD, even though it's only
532 * applicable to logic data for now.
534 for (l = di->next_di; l; l = l->next) {
536 srd_instance_start(next_di, args);
543 * Run the specified decoder function.
545 * @param start_samplenum The starting sample number for the buffer's sample
546 * set, relative to the start of capture.
547 * @param di The decoder instance to call. Must not be NULL.
548 * @param inbuf The buffer to decode. Must not be NULL.
549 * @param inbuflen Length of the buffer. Must be > 0.
551 * @return SRD_OK upon success, a (negative) error code otherwise.
553 int srd_instance_decode(uint64_t start_samplenum,
554 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
558 uint64_t end_samplenum;
560 srd_dbg("Calling decode() on instance %s with %d bytes starting "
561 "at sample %d.", di->instance_id, inbuflen, start_samplenum);
563 /* Return an error upon unusable input. */
565 srd_dbg("empty decoder instance");
569 srd_dbg("NULL buffer pointer");
573 srd_dbg("empty buffer");
577 /* Create new srd_logic object. Each iteration around the PD's loop
578 * will fill one sample into this object.
580 logic = PyObject_New(srd_logic, &srd_logic_type);
583 logic->start_samplenum = start_samplenum;
585 logic->inbuf = inbuf;
586 logic->inbuflen = inbuflen;
587 logic->sample = PyList_New(2);
588 Py_INCREF(logic->sample);
590 Py_IncRef(di->py_instance);
591 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
592 if (!(py_res = PyObject_CallMethod(di->py_instance, "decode",
593 "KKO", logic->start_samplenum, end_samplenum, logic))) {
594 catch_exception("Protocol decoder instance %s: ", di->instance_id);
595 return SRD_ERR_PYTHON; /* TODO: More specific error? */
603 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
607 struct srd_decoder_instance *di;
610 srd_dbg("Calling start() on all instances with %d probes, "
611 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
613 /* Currently only one item of metadata is passed along to decoders,
614 * samplerate. This can be extended as needed.
616 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
617 srd_err("Unable to build python object for metadata.");
618 return SRD_ERR_PYTHON;
621 /* Run the start() method on all decoders receiving frontend data. */
622 for (d = di_list; d; d = d->next) {
624 di->data_num_probes = num_probes;
625 di->data_unitsize = unitsize;
626 di->data_samplerate = samplerate;
627 if ((ret = srd_instance_start(di, args) != SRD_OK))
636 /* Feed logic samples to decoder session. */
637 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
642 srd_dbg("Calling decode() on all instances with starting sample "
643 "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum,
646 for (d = di_list; d; d = d->next) {
647 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
648 inbuflen)) != SRD_OK)
656 int srd_register_callback(int output_type, void *cb)
658 struct srd_pd_callback *pd_cb;
660 srd_dbg("Registering new callback for output type %d.", output_type);
662 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
663 return SRD_ERR_MALLOC;
665 pd_cb->output_type = output_type;
666 pd_cb->callback = cb;
667 callbacks = g_slist_append(callbacks, pd_cb);
672 void *srd_find_callback(int output_type)
675 struct srd_pd_callback *pd_cb;
679 for (l = callbacks; l; l = l->next) {
681 if (pd_cb->output_type == output_type) {
682 cb = pd_cb->callback;
691 /* This is the backend function to python sigrokdecode.add() call. */
692 int pd_add(struct srd_decoder_instance *di, int output_type, char *proto_id)
694 struct srd_pd_output *pdo;
696 srd_dbg("Instance %s creating new output type %d for %s.",
697 di->instance_id, output_type, proto_id);
699 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
702 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
703 pdo->pdo_id = g_slist_length(di->pd_output);
704 pdo->output_type = output_type;
706 pdo->proto_id = g_strdup(proto_id);
707 di->pd_output = g_slist_append(di->pd_output, pdo);