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"
28 /* List of decoder instances. */
29 static GSList *di_list = NULL;
31 /* List of frontend callbacks to receive PD output. */
32 static GSList *callbacks = NULL;
35 extern SRD_PRIV GSList *pd_list;
37 /* module_sigrokdecode.c */
38 extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void);
41 extern SRD_PRIV PyTypeObject srd_logic_type;
44 * Initialize libsigrokdecode.
46 * This initializes the Python interpreter, and creates and initializes
47 * a "sigrok" Python module with a single put() method.
49 * Then, it searches for sigrok protocol decoder files (*.py) in the
50 * "decoders" subdirectory of the the sigrok installation directory.
51 * All decoders that are found are loaded into memory and added to an
52 * internal list of decoders, which can be queried via srd_list_decoders().
54 * The caller is responsible for calling the clean-up function srd_exit(),
55 * which will properly shut down libsigrokdecode and free its allocated memory.
57 * Multiple calls to srd_init(), without calling srd_exit() in between,
60 * @return SRD_OK upon success, a (negative) error code otherwise.
61 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
62 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
63 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
65 SRD_API int srd_init(void)
69 srd_dbg("Initializing libsigrokdecode.");
71 /* Add our own module to the list of built-in modules. */
72 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
74 /* Initialize the python interpreter. */
77 if ((ret = set_modulepath()) != SRD_OK) {
82 if ((ret = srd_load_all_decoders()) != SRD_OK) {
91 * Shutdown libsigrokdecode.
93 * This frees all the memory allocated for protocol decoders and shuts down
94 * the Python interpreter.
96 * This function should only be called if there was a (successful!) invocation
97 * of srd_init() before. Calling this function multiple times in a row, without
98 * any successful srd_init() calls in between, is not allowed.
100 * @return SRD_OK upon success, a (negative) error code otherwise.
102 SRD_API int srd_exit(void)
104 srd_dbg("Exiting libsigrokdecode.");
106 srd_unload_all_decoders();
107 g_slist_free(pd_list);
109 /* Py_Finalize() returns void, any finalization errors are ignored. */
116 * Add an additional search directory for the protocol decoders.
118 * The specified directory is prepended (not appended!) to Python's sys.path,
119 * in order to search for sigrok protocol decoders in the specified
120 * directories first, and in the generic Python module directories (and in
121 * the current working directory) last. This avoids conflicts if there are
122 * Python modules which have the same name as a sigrok protocol decoder in
123 * sys.path or in the current working directory.
125 * TODO: add path from env var SIGROKDECODE_PATH, config etc
126 * TODO: Should take directoryname/path as input.
130 SRD_API int set_modulepath(void)
139 * On Windows/MinGW, Python's sys.path needs entries of the form
140 * 'C:\\foo\\bar' instead of '/foo/bar'.
143 splitted = g_strsplit(DECODERS_DIR, "/", 0);
144 path = g_build_pathv("\\\\", splitted);
145 g_strfreev(splitted);
147 path = g_strdup(DECODERS_DIR);
150 /* TODO: Sanity check on 'path' (length, escape special chars, ...). */
151 s = g_strdup_printf("import sys; sys.path.insert(0, r'%s')", path);
153 ret = PyRun_SimpleString(s);
162 * Set options in a decoder instance.
164 * @param di Decoder instance.
165 * @param options A GHashTable of options to set.
167 * Handled options are removed from the hash.
169 * @return SRD_OK upon success, a (negative) error code otherwise.
171 SRD_API int srd_instance_set_options(struct srd_decoder_instance *di,
174 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
175 PyObject *py_optlist, *py_classval;
177 unsigned long long int val_ull;
178 int num_optkeys, ret, size, i;
181 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
182 /* Decoder has no options. */
183 if (g_hash_table_size(options) == 0) {
184 /* No options provided. */
187 srd_err("Protocol decoder has no options.");
193 ret = SRD_ERR_PYTHON;
195 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
196 py_optlist = py_classval = NULL;
197 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
199 /* All of these are synthesized objects, so they're good. */
200 py_dec_optkeys = PyDict_Keys(py_dec_options);
201 num_optkeys = PyList_Size(py_dec_optkeys);
202 if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options")))
204 for (i = 0; i < num_optkeys; i++) {
205 /* Get the default class value for this option. */
206 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
207 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
209 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
211 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
212 srd_err("Options of type %s are not yet supported.",
213 Py_TYPE(py_classval)->tp_name);
217 if ((value = g_hash_table_lookup(options, key))) {
218 /* An override for this option was provided. */
219 if (PyUnicode_Check(py_classval)) {
220 if (!(py_optval = PyUnicode_FromString(value))) {
221 /* Some UTF-8 encoding error. */
225 } else if (PyLong_Check(py_classval)) {
226 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
227 /* ValueError Exception */
229 srd_err("Option %s has invalid value "
230 "%s: expected integer.",
235 g_hash_table_remove(options, key);
237 /* Use the class default for this option. */
238 if (PyUnicode_Check(py_classval)) {
239 /* Make a brand new copy of the string. */
240 py_ustr = PyUnicode_AS_UNICODE(py_classval);
241 size = PyUnicode_GET_SIZE(py_classval);
242 py_optval = PyUnicode_FromUnicode(py_ustr, size);
243 } else if (PyLong_Check(py_classval)) {
244 /* Make a brand new copy of the integer. */
245 val_ull = PyLong_AsUnsignedLongLong(py_classval);
246 if (val_ull == (unsigned long long)-1) {
247 /* OverFlowError exception */
249 srd_err("Invalid integer value for %s: "
250 "expected integer.", key);
253 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
258 /* If we got here, py_optval holds a known good new reference
259 * to the instance option to set.
261 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
268 Py_XDECREF(py_optlist);
269 Py_XDECREF(py_di_options);
270 Py_XDECREF(py_dec_optkeys);
271 Py_XDECREF(py_dec_options);
273 if (PyErr_Occurred())
274 catch_exception("Stray exception in srd_instance_set_options().");
279 /* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */
280 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
282 return strcmp(a->id, probe_id);
286 * Set probes in a decoder instance.
288 * @param di Decoder instance.
289 * @param probes A GHashTable of probes to set. Key is probe name, value is
290 * the probe number. Samples passed to this instance will be
291 * arranged in this order.
292 * @return SRD_OK upon success, a (negative) error code otherwise.
294 SRD_API int srd_instance_set_probes(struct srd_decoder_instance *di,
295 GHashTable *new_probes)
300 int *new_probemap, new_probenum;
301 char *probe_id, *probenum_str;
303 srd_dbg("set probes called for instance %s with list of %d probes",
304 di->instance_id, g_hash_table_size(new_probes));
306 if (g_hash_table_size(new_probes) == 0)
307 /* No probes provided. */
310 if (di->dec_num_probes == 0) {
311 /* Decoder has no probes. */
312 srd_err("Protocol decoder %s has no probes to define.",
319 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
320 srd_err("Failed to malloc new probe map.");
321 return SRD_ERR_MALLOC;
324 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
326 probenum_str = g_hash_table_lookup(new_probes, probe_id);
328 /* Probe name was specified without a value. */
329 srd_err("No probe number was specified for %s.",
331 g_free(new_probemap);
334 new_probenum = strtol(probenum_str, NULL, 10);
335 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
336 (GCompareFunc)compare_probe_id))) {
337 /* Fall back on optional probes. */
338 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
339 probe_id, (GCompareFunc) compare_probe_id))) {
340 srd_err("Protocol decoder %s has no probe "
341 "'%s'.", di->decoder->name, probe_id);
342 g_free(new_probemap);
347 new_probemap[p->order] = new_probenum;
348 srd_dbg("setting probe mapping for %d = probe %d", p->order,
351 g_free(di->dec_probemap);
352 di->dec_probemap = new_probemap;
358 * Create a new protocol decoder instance.
360 * @param id Decoder 'id' field.
361 * @param options GHashtable of options which override the defaults set in
363 * @return Pointer to a newly allocated struct srd_decoder_instance, or
364 * NULL in case of failure.
366 SRD_API struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
370 struct srd_decoder *dec;
371 struct srd_decoder_instance *di;
374 srd_dbg("Creating new %s instance.", decoder_id);
376 if (!(dec = srd_get_decoder_by_id(decoder_id))) {
377 srd_err("Protocol decoder %s not found.", decoder_id);
381 if (!(di = g_try_malloc0(sizeof(*di)))) {
382 srd_err("Failed to malloc instance.");
386 instance_id = g_hash_table_lookup(options, "id");
388 di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
389 g_hash_table_remove(options, "id");
391 /* Prepare a default probe map, where samples come in the
392 * order in which the decoder class defined them.
394 di->dec_num_probes = g_slist_length(di->decoder->probes) +
395 g_slist_length(di->decoder->opt_probes);
396 if (di->dec_num_probes) {
397 if (!(di->dec_probemap =
398 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
399 srd_err("Failed to malloc probe map.");
403 for (i = 0; i < di->dec_num_probes; i++)
404 di->dec_probemap[i] = i;
407 /* Create a new instance of this decoder class. */
408 if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
409 if (PyErr_Occurred())
410 catch_exception("failed to create %s instance: ",
412 g_free(di->dec_probemap);
417 if (srd_instance_set_options(di, options) != SRD_OK) {
418 g_free(di->dec_probemap);
423 /* Instance takes input from a frontend by default. */
424 di_list = g_slist_append(di_list, di);
429 SRD_API int srd_instance_stack(struct srd_decoder_instance *di_from,
430 struct srd_decoder_instance *di_to)
432 if (!di_from || !di_to) {
433 srd_err("Invalid from/to instance pair.");
437 if (g_slist_find(di_list, di_to)) {
438 /* Remove from the unstacked list. */
439 di_list = g_slist_remove(di_list, di_to);
442 /* Stack on top of source di. */
443 di_from->next_di = g_slist_append(di_from->next_di, di_to);
449 * Finds a decoder instance by its instance id, but only in the bottom
450 * level of instances -- instances already stacked on top of another one
453 * @param instance_id The instance id to be found.
455 * @return Pointer to struct srd_decoder_instance, or NULL if not found.
457 SRD_API struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id)
460 struct srd_decoder_instance *tmp, *di;
463 for (l = di_list; l; l = l->next) {
465 if (!strcmp(tmp->instance_id, instance_id)) {
475 * Finds a decoder instance by its python object, i.e. that instance's
476 * instantiation of the sigrokdecode.Decoder class. This will recurse
477 * to find the instance anywhere in the stack tree.
479 * @param stack Pointer to a GSList of struct srd_decoder_instance,
480 * indicating the stack to search. To start searching at the bottom
481 * level of decoder instances, pass NULL.
482 * @param obj The python class instantiation.
484 * @return Pointer to struct srd_decoder_instance, or NULL if not found.
486 SRD_API struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
490 struct srd_decoder_instance *tmp, *di;
493 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
495 if (tmp->py_instance == obj)
497 else if (tmp->next_di)
498 di = srd_instance_find_by_obj(tmp->next_di, obj);
504 SRD_API int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
506 PyObject *py_name, *py_res;
508 struct srd_decoder_instance *next_di;
510 srd_dbg("Calling start() method on protocol decoder instance %s.",
513 if (!(py_name = PyUnicode_FromString("start"))) {
514 srd_err("Unable to build python object for 'start'.");
515 catch_exception("Protocol decoder instance %s: ",
517 return SRD_ERR_PYTHON;
520 if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
521 py_name, args, NULL))) {
522 catch_exception("Protocol decoder instance %s: ",
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 SRD_API int srd_instance_decode(uint64_t start_samplenum,
554 struct srd_decoder_instance *di,
555 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,
595 end_samplenum, logic))) {
596 catch_exception("Protocol decoder instance %s: ",
598 return SRD_ERR_PYTHON; /* TODO: More specific error? */
605 SRD_API void srd_instance_free(struct srd_decoder_instance *di)
608 struct srd_pd_output *pdo;
610 srd_dbg("Freeing instance %s", di->instance_id);
612 Py_DecRef(di->py_instance);
613 g_free(di->instance_id);
614 g_free(di->dec_probemap);
615 g_slist_free(di->next_di);
616 for (l = di->pd_output; l; l = l->next) {
618 g_free(pdo->proto_id);
621 g_slist_free(di->pd_output);
624 SRD_API void srd_instance_free_all(GSList *stack)
627 struct srd_decoder_instance *di;
630 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
633 srd_instance_free_all(di->next_di);
634 srd_instance_free(di);
637 g_slist_free(di_list);
642 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
646 struct srd_decoder_instance *di;
649 srd_dbg("Calling start() on all instances with %d probes, "
650 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
652 /* Currently only one item of metadata is passed along to decoders,
653 * samplerate. This can be extended as needed.
655 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
656 srd_err("Unable to build python object for metadata.");
657 return SRD_ERR_PYTHON;
660 /* Run the start() method on all decoders receiving frontend data. */
661 for (d = di_list; d; d = d->next) {
663 di->data_num_probes = num_probes;
664 di->data_unitsize = unitsize;
665 di->data_samplerate = samplerate;
666 if ((ret = srd_instance_start(di, args) != SRD_OK))
675 /* Feed logic samples to decoder session. */
676 SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf,
682 srd_dbg("Calling decode() on all instances with starting sample "
683 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
684 start_samplenum, inbuflen, inbuf);
686 for (d = di_list; d; d = d->next) {
687 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
688 inbuflen)) != SRD_OK)
695 SRD_API int srd_register_callback(int output_type, srd_pd_output_callback_t cb)
697 struct srd_pd_callback *pd_cb;
699 srd_dbg("Registering new callback for output type %d.", output_type);
701 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
702 return SRD_ERR_MALLOC;
704 pd_cb->output_type = output_type;
705 pd_cb->callback = cb;
706 callbacks = g_slist_append(callbacks, pd_cb);
711 SRD_API void *srd_find_callback(int output_type)
714 struct srd_pd_callback *pd_cb;
718 for (l = callbacks; l; l = l->next) {
720 if (pd_cb->output_type == output_type) {
721 cb = pd_cb->callback;
729 /* This is the backend function to python sigrokdecode.add() call. */
730 SRD_PRIV int pd_add(struct srd_decoder_instance *di, int output_type,
733 struct srd_pd_output *pdo;
735 srd_dbg("Instance %s creating new output type %d for %s.",
736 di->instance_id, output_type, proto_id);
738 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
741 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
742 pdo->pdo_id = g_slist_length(di->pd_output);
743 pdo->output_type = output_type;
745 pdo->proto_id = g_strdup(proto_id);
746 di->pd_output = g_slist_append(di->pd_output, pdo);