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 decoder output. */
32 static GSList *callbacks = NULL;
35 extern SRD_PRIV GSList *pd_list;
37 /* module_sigrokdecode.c */
38 /* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */
39 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
42 extern SRD_PRIV PyTypeObject srd_logic_type;
45 * Initialize libsigrokdecode.
47 * This initializes the Python interpreter, and creates and initializes
48 * a "sigrokdecode" Python module.
50 * Then, it searches for sigrok protocol decoder files (*.py) in the
51 * "decoders" subdirectory of the the sigrok installation directory.
52 * All decoders that are found are loaded into memory and added to an
53 * internal list of decoders, which can be queried via srd_decoders_list().
55 * The caller is responsible for calling the clean-up function srd_exit(),
56 * which will properly shut down libsigrokdecode and free its allocated memory.
58 * Multiple calls to srd_init(), without calling srd_exit() in between,
61 * @param path Path to an extra directory containing protocol decoders
62 * which will be added to the Python sys.path, or NULL.
64 * @return SRD_OK upon success, a (negative) error code otherwise.
65 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
66 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
67 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
69 SRD_API int srd_init(const char *path)
74 srd_dbg("Initializing libsigrokdecode.");
76 /* Add our own module to the list of built-in modules. */
77 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
79 /* Initialize the Python interpreter. */
82 /* Installed decoders. */
83 if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
88 /* Path specified by the user. */
90 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
96 /* Environment variable overrides everything, for debugging. */
97 if ((env_path = getenv("SIGROKDECODE_DIR"))) {
98 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
108 * Shutdown libsigrokdecode.
110 * This frees all the memory allocated for protocol decoders and shuts down
111 * the Python interpreter.
113 * This function should only be called if there was a (successful!) invocation
114 * of srd_init() before. Calling this function multiple times in a row, without
115 * any successful srd_init() calls in between, is not allowed.
117 * @return SRD_OK upon success, a (negative) error code otherwise.
119 SRD_API int srd_exit(void)
121 srd_dbg("Exiting libsigrokdecode.");
123 srd_decoder_unload_all();
124 g_slist_free(pd_list);
127 /* Py_Finalize() returns void, any finalization errors are ignored. */
134 * Add an additional search directory for the protocol decoders.
136 * The specified directory is prepended (not appended!) to Python's sys.path,
137 * in order to search for sigrok protocol decoders in the specified
138 * directories first, and in the generic Python module directories (and in
139 * the current working directory) last. This avoids conflicts if there are
140 * Python modules which have the same name as a sigrok protocol decoder in
141 * sys.path or in the current working directory.
143 * @param path Path to the directory containing protocol decoders which shall
144 * be added to the Python sys.path, or NULL.
146 * @return SRD_OK upon success, a (negative) error code otherwise.
148 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
150 PyObject *py_cur_path, *py_item;
153 wchar_t *wc_new_path;
156 srd_dbg("Adding '%s' to module path.", path);
158 new_path = g_string_sized_new(256);
159 g_string_assign(new_path, g_strdup(path));
160 py_cur_path = PySys_GetObject("path");
161 for (i = 0; i < PyList_Size(py_cur_path); i++) {
162 g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S));
163 py_item = PyList_GetItem(py_cur_path, i);
164 if (!PyUnicode_Check(py_item))
165 /* Shouldn't happen. */
167 if (py_str_as_str(py_item, &item) != SRD_OK)
169 g_string_append(new_path, item);
172 /* Convert to wide chars. */
173 wc_len = sizeof(wchar_t) * (new_path->len + 1);
174 if (!(wc_new_path = g_try_malloc(wc_len))) {
175 srd_dbg("malloc failed");
176 return SRD_ERR_MALLOC;
178 mbstowcs(wc_new_path, new_path->str, wc_len);
179 PySys_SetPath(wc_new_path);
180 g_string_free(new_path, TRUE);
187 // * On Windows/MinGW, Python's sys.path needs entries of the form
188 // * 'C:\\foo\\bar' instead of '/foo/bar'.
191 // splitted = g_strsplit(DECODERS_DIR, "/", 0);
192 // path = g_build_pathv("\\\\", splitted);
193 // g_strfreev(splitted);
195 // path = g_strdup(DECODERS_DIR);
202 * Set one or more options in a decoder instance.
204 * Handled options are removed from the hash.
206 * @param di Decoder instance.
207 * @param options A GHashTable of options to set.
209 * @return SRD_OK upon success, a (negative) error code otherwise.
211 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
214 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
215 PyObject *py_optlist, *py_classval;
217 unsigned long long int val_ull;
218 int num_optkeys, ret, size, i;
221 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
222 /* Decoder has no options. */
223 if (g_hash_table_size(options) == 0) {
224 /* No options provided. */
227 srd_err("Protocol decoder has no options.");
233 ret = SRD_ERR_PYTHON;
235 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
236 py_optlist = py_classval = NULL;
237 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
239 /* All of these are synthesized objects, so they're good. */
240 py_dec_optkeys = PyDict_Keys(py_dec_options);
241 num_optkeys = PyList_Size(py_dec_optkeys);
242 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
244 for (i = 0; i < num_optkeys; i++) {
245 /* Get the default class value for this option. */
246 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
247 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
249 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
251 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
252 srd_err("Options of type %s are not yet supported.",
253 Py_TYPE(py_classval)->tp_name);
257 if ((value = g_hash_table_lookup(options, key))) {
258 /* An override for this option was provided. */
259 if (PyUnicode_Check(py_classval)) {
260 if (!(py_optval = PyUnicode_FromString(value))) {
261 /* Some UTF-8 encoding error. */
265 } else if (PyLong_Check(py_classval)) {
266 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
267 /* ValueError Exception */
269 srd_err("Option %s has invalid value "
270 "%s: expected integer.",
275 g_hash_table_remove(options, key);
277 /* Use the class default for this option. */
278 if (PyUnicode_Check(py_classval)) {
279 /* Make a brand new copy of the string. */
280 py_ustr = PyUnicode_AS_UNICODE(py_classval);
281 size = PyUnicode_GET_SIZE(py_classval);
282 py_optval = PyUnicode_FromUnicode(py_ustr, size);
283 } else if (PyLong_Check(py_classval)) {
284 /* Make a brand new copy of the integer. */
285 val_ull = PyLong_AsUnsignedLongLong(py_classval);
286 if (val_ull == (unsigned long long)-1) {
287 /* OverFlowError exception */
289 srd_err("Invalid integer value for %s: "
290 "expected integer.", key);
293 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
299 * If we got here, py_optval holds a known good new reference
300 * to the instance option to set.
302 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
309 Py_XDECREF(py_optlist);
310 Py_XDECREF(py_di_options);
311 Py_XDECREF(py_dec_optkeys);
312 Py_XDECREF(py_dec_options);
314 if (PyErr_Occurred())
315 srd_exception_catch("Stray exception in srd_inst_option_set().");
320 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
321 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
323 return strcmp(a->id, probe_id);
327 * Set all probes in a decoder instance.
329 * This function sets _all_ probes for the specified decoder instance, i.e.,
330 * it overwrites any probes that were already defined (if any).
332 * @param di Decoder instance.
333 * @param new_probes A GHashTable of probes to set. Key is probe name, value is
334 * the probe number. Samples passed to this instance will be
335 * arranged in this order.
337 * @return SRD_OK upon success, a (negative) error code otherwise.
339 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
340 GHashTable *new_probes)
345 int *new_probemap, new_probenum;
346 char *probe_id, *probenum_str;
347 int i, num_required_probes;
349 srd_dbg("set probes called for instance %s with list of %d probes",
350 di->inst_id, g_hash_table_size(new_probes));
352 if (g_hash_table_size(new_probes) == 0)
353 /* No probes provided. */
356 if (di->dec_num_probes == 0) {
357 /* Decoder has no probes. */
358 srd_err("Protocol decoder %s has no probes to define.",
365 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
366 srd_err("Failed to g_malloc() new probe map.");
367 return SRD_ERR_MALLOC;
371 * For now, map all indexes to probe -1 (can be overridden later).
372 * This -1 is interpreted as an unspecified probe later.
374 for (i = 0; i < di->dec_num_probes; i++)
375 new_probemap[i] = -1;
377 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
379 probenum_str = g_hash_table_lookup(new_probes, probe_id);
381 /* Probe name was specified without a value. */
382 srd_err("No probe number was specified for %s.",
384 g_free(new_probemap);
387 new_probenum = strtol(probenum_str, NULL, 10);
388 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
389 (GCompareFunc)compare_probe_id))) {
390 /* Fall back on optional probes. */
391 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
392 probe_id, (GCompareFunc) compare_probe_id))) {
393 srd_err("Protocol decoder %s has no probe "
394 "'%s'.", di->decoder->name, probe_id);
395 g_free(new_probemap);
400 new_probemap[p->order] = new_probenum;
401 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
402 p->id, p->order, new_probenum);
405 srd_dbg("Final probe map:");
406 num_required_probes = g_slist_length(di->decoder->probes);
407 for (i = 0; i < di->dec_num_probes; i++) {
408 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
409 (i < num_required_probes) ? "required" : "optional");
412 g_free(di->dec_probemap);
413 di->dec_probemap = new_probemap;
419 * Create a new protocol decoder instance.
421 * @param decoder_id Decoder 'id' field.
422 * @param options GHashtable of options which override the defaults set in
425 * @return Pointer to a newly allocated struct srd_decoder_inst, or
426 * NULL in case of failure.
428 SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
432 struct srd_decoder *dec;
433 struct srd_decoder_inst *di;
436 srd_dbg("Creating new %s instance.", decoder_id);
438 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
439 srd_err("Protocol decoder %s not found.", decoder_id);
443 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
444 srd_err("Failed to g_malloc() instance.");
448 inst_id = g_hash_table_lookup(options, "id");
450 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
451 g_hash_table_remove(options, "id");
454 * Prepare a default probe map, where samples come in the
455 * order in which the decoder class defined them.
457 di->dec_num_probes = g_slist_length(di->decoder->probes) +
458 g_slist_length(di->decoder->opt_probes);
459 if (di->dec_num_probes) {
460 if (!(di->dec_probemap =
461 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
462 srd_err("Failed to g_malloc() probe map.");
466 for (i = 0; i < di->dec_num_probes; i++)
467 di->dec_probemap[i] = i;
470 /* Create a new instance of this decoder class. */
471 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
472 if (PyErr_Occurred())
473 srd_exception_catch("failed to create %s instance: ",
475 g_free(di->dec_probemap);
480 if (srd_inst_option_set(di, options) != SRD_OK) {
481 g_free(di->dec_probemap);
486 /* Instance takes input from a frontend by default. */
487 di_list = g_slist_append(di_list, di);
493 * Stack a decoder instance on top of another.
495 * @param di_from The instance to move.
496 * @param di_to The instance on top of which di_from will be stacked.
498 * @return SRD_OK upon success, a (negative) error code otherwise.
500 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
501 struct srd_decoder_inst *di_to)
503 if (!di_from || !di_to) {
504 srd_err("Invalid from/to instance pair.");
508 if (g_slist_find(di_list, di_to)) {
509 /* Remove from the unstacked list. */
510 di_list = g_slist_remove(di_list, di_to);
513 /* Stack on top of source di. */
514 di_from->next_di = g_slist_append(di_from->next_di, di_to);
520 * Find a decoder instance by its instance ID.
522 * Only the bottom level of instances are searched -- instances already stacked
523 * on top of another one will not be found.
525 * @param inst_id The instance ID to be found.
527 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
529 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id)
532 struct srd_decoder_inst *tmp, *di;
535 for (l = di_list; l; l = l->next) {
537 if (!strcmp(tmp->inst_id, inst_id)) {
547 * Find a decoder instance by its Python object.
549 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
550 * This will recurse to find the instance anywhere in the stack tree.
552 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
553 * stack to search. To start searching at the bottom level of
554 * decoder instances, pass NULL.
555 * @param obj The Python class instantiation.
557 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
559 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
564 struct srd_decoder_inst *tmp, *di;
567 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
569 if (tmp->py_inst == obj)
571 else if (tmp->next_di)
572 di = srd_inst_find_by_obj(tmp->next_di, obj);
578 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
580 PyObject *py_name, *py_res;
582 struct srd_decoder_inst *next_di;
584 srd_dbg("Calling start() method on protocol decoder instance %s.",
587 if (!(py_name = PyUnicode_FromString("start"))) {
588 srd_err("Unable to build Python object for 'start'.");
589 srd_exception_catch("Protocol decoder instance %s: ",
591 return SRD_ERR_PYTHON;
594 if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
595 py_name, args, NULL))) {
596 srd_exception_catch("Protocol decoder instance %s: ",
598 return SRD_ERR_PYTHON;
605 * Start all the PDs stacked on top of this one. Pass along the
606 * metadata all the way from the bottom PD, even though it's only
607 * applicable to logic data for now.
609 for (l = di->next_di; l; l = l->next) {
611 srd_inst_start(next_di, args);
618 * Run the specified decoder function.
620 * @param start_samplenum The starting sample number for the buffer's sample
621 * set, relative to the start of capture.
622 * @param di The decoder instance to call. Must not be NULL.
623 * @param inbuf The buffer to decode. Must not be NULL.
624 * @param inbuflen Length of the buffer. Must be > 0.
626 * @return SRD_OK upon success, a (negative) error code otherwise.
628 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
629 const struct srd_decoder_inst *di,
630 const uint8_t *inbuf, uint64_t inbuflen)
634 uint64_t end_samplenum;
636 srd_dbg("Calling decode() on instance %s with %d bytes starting "
637 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
639 /* Return an error upon unusable input. */
641 srd_dbg("empty decoder instance");
645 srd_dbg("NULL buffer pointer");
649 srd_dbg("empty buffer");
654 * Create new srd_logic object. Each iteration around the PD's loop
655 * will fill one sample into this object.
657 logic = PyObject_New(srd_logic, &srd_logic_type);
659 logic->di = (struct srd_decoder_inst *)di;
660 logic->start_samplenum = start_samplenum;
662 logic->inbuf = (uint8_t *)inbuf;
663 logic->inbuflen = inbuflen;
664 logic->sample = PyList_New(2);
665 Py_INCREF(logic->sample);
667 Py_IncRef(di->py_inst);
668 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
669 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
670 "KKO", logic->start_samplenum,
671 end_samplenum, logic))) {
672 srd_exception_catch("Protocol decoder instance %s: ",
674 return SRD_ERR_PYTHON; /* TODO: More specific error? */
681 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
684 struct srd_pd_output *pdo;
686 srd_dbg("Freeing instance %s", di->inst_id);
688 Py_DecRef(di->py_inst);
690 g_free(di->dec_probemap);
691 g_slist_free(di->next_di);
692 for (l = di->pd_output; l; l = l->next) {
694 g_free(pdo->proto_id);
697 g_slist_free(di->pd_output);
700 SRD_PRIV void srd_inst_free_all(GSList *stack)
703 struct srd_decoder_inst *di;
706 for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
709 srd_inst_free_all(di->next_di);
713 g_slist_free(di_list);
719 * Start a decoding session.
721 * Decoders, instances and stack must have been prepared beforehand.
723 * @param num_probes The number of probes which the incoming feed will contain.
724 * @param unitsize The number of bytes per sample in the incoming feed.
725 * @param samplerate The samplerate of the incoming feed.
727 * @return SRD_OK upon success, a (negative) error code otherwise.
729 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
733 struct srd_decoder_inst *di;
736 srd_dbg("Calling start() on all instances with %d probes, "
737 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
740 * Currently only one item of metadata is passed along to decoders,
741 * samplerate. This can be extended as needed.
743 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
744 srd_err("Unable to build Python object for metadata.");
745 return SRD_ERR_PYTHON;
748 /* Run the start() method on all decoders receiving frontend data. */
749 for (d = di_list; d; d = d->next) {
751 di->data_num_probes = num_probes;
752 di->data_unitsize = unitsize;
753 di->data_samplerate = samplerate;
754 if ((ret = srd_inst_start(di, args)) != SRD_OK)
764 * Send a chunk of logic sample data to a running decoder session.
766 * @param start_samplenum The sample number of the first sample in this chunk.
767 * @param inbuf Pointer to sample data.
768 * @param inbuflen Length in bytes of the buffer.
770 * @return SRD_OK upon success, a (negative) error code otherwise.
772 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
778 srd_dbg("Calling decode() on all instances with starting sample "
779 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
780 start_samplenum, inbuflen, inbuf);
782 for (d = di_list; d; d = d->next) {
783 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
784 inbuflen)) != SRD_OK)
792 * Register/add a decoder output callback function.
794 * The function will be called when a protocol decoder sends output back
795 * to the PD controller (except for Python objects, which only go up the
798 * @param output_type The output type this callback will receive. Only one
799 * callback per output type can be registered.
800 * @param cb The function to call. Must not be NULL.
801 * @param cb_data Private data for the callback function. Can be NULL.
803 SRD_API int srd_pd_output_callback_add(int output_type,
804 srd_pd_output_callback_t cb, void *cb_data)
806 struct srd_pd_callback *pd_cb;
808 srd_dbg("Registering new callback for output type %d.", output_type);
810 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
811 srd_err("Failed to g_malloc() struct srd_pd_callback.");
812 return SRD_ERR_MALLOC;
815 pd_cb->output_type = output_type;
817 pd_cb->cb_data = cb_data;
818 callbacks = g_slist_append(callbacks, pd_cb);
823 SRD_PRIV void *srd_pd_output_callback_find(int output_type)
826 struct srd_pd_callback *pd_cb;
830 for (l = callbacks; l; l = l->next) {
832 if (pd_cb->output_type == output_type) {
841 /* This is the backend function to Python sigrokdecode.add() call. */
842 SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
843 int output_type, const char *proto_id)
845 struct srd_pd_output *pdo;
847 srd_dbg("Instance %s creating new output type %d for %s.",
848 di->inst_id, output_type, proto_id);
850 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
851 srd_err("Failed to g_malloc() struct srd_pd_output.");
855 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
856 pdo->pdo_id = g_slist_length(di->pd_output);
857 pdo->output_type = output_type;
859 pdo->proto_id = g_strdup(proto_id);
860 di->pd_output = g_slist_append(di->pd_output, pdo);