srd: fix SIGROKDECODE_DIR env variable brokenness
[libsigrokdecode.git] / controller.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
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.
11  *
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.
16  *
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/>.
19  */
20
21 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "sigrokdecode-internal.h"
23 #include "config.h"
24 #include <glib.h>
25 #include <inttypes.h>
26 #include <stdlib.h>
27
28 /* List of decoder instances. */
29 static GSList *di_list = NULL;
30
31 /* List of frontend callbacks to receive PD output. */
32 static GSList *callbacks = NULL;
33
34 /* decoder.c */
35 extern SRD_PRIV GSList *pd_list;
36
37 /* module_sigrokdecode.c */
38 extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void);
39
40 /* type_logic.c */
41 extern SRD_PRIV PyTypeObject srd_logic_type;
42
43 /**
44  * Initialize libsigrokdecode.
45  *
46  * This initializes the Python interpreter, and creates and initializes
47  * a "sigrok" Python module with a single put() method.
48  *
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_decoders_list().
53  *
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.
56  *
57  * Multiple calls to srd_init(), without calling srd_exit() in between,
58  * are not allowed.
59  *
60  * @param path Path to an extra directory containing protocol decoders
61  *              which will be added to the python sys.path, or NULL.
62  *
63  * @return SRD_OK upon success, a (negative) error code otherwise.
64  *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
65  *         directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
66  *         If not enough memory could be allocated, return SRD_ERR_MALLOC.
67  */
68 SRD_API int srd_init(char *path)
69 {
70         int ret;
71         char *env_path;
72
73         srd_dbg("Initializing libsigrokdecode.");
74
75         /* Add our own module to the list of built-in modules. */
76         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
77
78         /* Initialize the Python interpreter. */
79         Py_Initialize();
80
81         /* Installed decoders. */
82         if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) {
83                 Py_Finalize();
84                 return ret;
85         }
86
87         /* Path specified by the user. */
88         if (path) {
89                 if ((ret = add_modulepath(path)) != SRD_OK) {
90                         Py_Finalize();
91                         return ret;
92                 }
93         }
94
95         /* Environment variable overrides everything, for debugging. */
96         if ((env_path = getenv("SIGROKDECODE_DIR"))) {
97                 if ((ret = add_modulepath(env_path)) != SRD_OK) {
98                         Py_Finalize();
99                         return ret;
100                 }
101         }
102
103         return SRD_OK;
104 }
105
106 /**
107  * Shutdown libsigrokdecode.
108  *
109  * This frees all the memory allocated for protocol decoders and shuts down
110  * the Python interpreter.
111  *
112  * This function should only be called if there was a (successful!) invocation
113  * of srd_init() before. Calling this function multiple times in a row, without
114  * any successful srd_init() calls in between, is not allowed.
115  *
116  * @return SRD_OK upon success, a (negative) error code otherwise.
117  */
118 SRD_API int srd_exit(void)
119 {
120         srd_dbg("Exiting libsigrokdecode.");
121
122         srd_decoders_unload_all();
123         g_slist_free(pd_list);
124
125         /* Py_Finalize() returns void, any finalization errors are ignored. */
126         Py_Finalize();
127
128         return SRD_OK;
129 }
130
131 /**
132  * Add an additional search directory for the protocol decoders.
133  *
134  * The specified directory is prepended (not appended!) to Python's sys.path,
135  * in order to search for sigrok protocol decoders in the specified
136  * directories first, and in the generic Python module directories (and in
137  * the current working directory) last. This avoids conflicts if there are
138  * Python modules which have the same name as a sigrok protocol decoder in
139  * sys.path or in the current working directory.
140  *
141  * @param path Path to an extra directory containing protocol decoders
142  *              which will be added to the python sys.path, or NULL.
143  *
144  * @return SRD_OK upon success, a (negative) error code otherwise.
145  */
146 SRD_PRIV int add_modulepath(const char *path)
147 {
148         PyObject *py_cur_path, *py_item;
149         GString *new_path;
150         int wc_len, i;
151         wchar_t *wc_new_path;
152         char *item;
153
154         srd_dbg("adding %s to module path", path);
155
156         new_path = g_string_sized_new(256);
157         g_string_assign(new_path, g_strdup(path));
158         py_cur_path = PySys_GetObject("path");
159         for (i = 0; i < PyList_Size(py_cur_path); i++) {
160                 g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S));
161                 py_item = PyList_GetItem(py_cur_path, i);
162                 if (!PyUnicode_Check(py_item))
163                         /* Shouldn't happen. */
164                         continue;
165                 if (py_str_as_str(py_item, &item) != SRD_OK)
166                         continue;
167                 g_string_append(new_path, item);
168         }
169
170         /* Convert to wide chars. */
171         wc_len = sizeof(wchar_t) * (new_path->len + 1);
172         if (!(wc_new_path = g_try_malloc(wc_len))) {
173                 srd_dbg("malloc failed");
174                 return SRD_ERR_MALLOC;
175         }
176         mbstowcs(wc_new_path, new_path->str, wc_len);
177         PySys_SetPath(wc_new_path);
178         g_string_free(new_path, TRUE);
179         g_free(wc_new_path);
180
181 //#ifdef _WIN32
182 //      gchar **splitted;
183 //
184 //      /*
185 //       * On Windows/MinGW, Python's sys.path needs entries of the form
186 //       * 'C:\\foo\\bar' instead of '/foo/bar'.
187 //       */
188 //
189 //      splitted = g_strsplit(DECODERS_DIR, "/", 0);
190 //      path = g_build_pathv("\\\\", splitted);
191 //      g_strfreev(splitted);
192 //#else
193 //      path = g_strdup(DECODERS_DIR);
194 //#endif
195
196         return SRD_OK;
197 }
198
199 /**
200  * Set options in a decoder instance.
201  *
202  * @param di Decoder instance.
203  * @param options A GHashTable of options to set.
204  *
205  * Handled options are removed from the hash.
206  *
207  * @return SRD_OK upon success, a (negative) error code otherwise.
208  */
209 SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
210                                      GHashTable *options)
211 {
212         PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
213         PyObject *py_optlist, *py_classval;
214         Py_UNICODE *py_ustr;
215         unsigned long long int val_ull;
216         int num_optkeys, ret, size, i;
217         char *key, *value;
218
219         if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
220                 /* Decoder has no options. */
221                 if (g_hash_table_size(options) == 0) {
222                         /* No options provided. */
223                         return SRD_OK;
224                 } else {
225                         srd_err("Protocol decoder has no options.");
226                         return SRD_ERR_ARG;
227                 }
228                 return SRD_OK;
229         }
230
231         ret = SRD_ERR_PYTHON;
232         key = NULL;
233         py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
234         py_optlist = py_classval = NULL;
235         py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
236
237         /* All of these are synthesized objects, so they're good. */
238         py_dec_optkeys = PyDict_Keys(py_dec_options);
239         num_optkeys = PyList_Size(py_dec_optkeys);
240         if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
241                 goto err_out;
242         for (i = 0; i < num_optkeys; i++) {
243                 /* Get the default class value for this option. */
244                 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
245                 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
246                         goto err_out;
247                 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
248                         goto err_out;
249                 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
250                         srd_err("Options of type %s are not yet supported.",
251                                 Py_TYPE(py_classval)->tp_name);
252                         goto err_out;
253                 }
254
255                 if ((value = g_hash_table_lookup(options, key))) {
256                         /* An override for this option was provided. */
257                         if (PyUnicode_Check(py_classval)) {
258                                 if (!(py_optval = PyUnicode_FromString(value))) {
259                                         /* Some UTF-8 encoding error. */
260                                         PyErr_Clear();
261                                         goto err_out;
262                                 }
263                         } else if (PyLong_Check(py_classval)) {
264                                 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
265                                         /* ValueError Exception */
266                                         PyErr_Clear();
267                                         srd_err("Option %s has invalid value "
268                                                 "%s: expected integer.",
269                                                 key, value);
270                                         goto err_out;
271                                 }
272                         }
273                         g_hash_table_remove(options, key);
274                 } else {
275                         /* Use the class default for this option. */
276                         if (PyUnicode_Check(py_classval)) {
277                                 /* Make a brand new copy of the string. */
278                                 py_ustr = PyUnicode_AS_UNICODE(py_classval);
279                                 size = PyUnicode_GET_SIZE(py_classval);
280                                 py_optval = PyUnicode_FromUnicode(py_ustr, size);
281                         } else if (PyLong_Check(py_classval)) {
282                                 /* Make a brand new copy of the integer. */
283                                 val_ull = PyLong_AsUnsignedLongLong(py_classval);
284                                 if (val_ull == (unsigned long long)-1) {
285                                         /* OverFlowError exception */
286                                         PyErr_Clear();
287                                         srd_err("Invalid integer value for %s: "
288                                                 "expected integer.", key);
289                                         goto err_out;
290                                 }
291                                 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
292                                         goto err_out;
293                         }
294                 }
295
296                 /* If we got here, py_optval holds a known good new reference
297                  * to the instance option to set.
298                  */
299                 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
300                         goto err_out;
301         }
302
303         ret = SRD_OK;
304
305 err_out:
306         Py_XDECREF(py_optlist);
307         Py_XDECREF(py_di_options);
308         Py_XDECREF(py_dec_optkeys);
309         Py_XDECREF(py_dec_options);
310         g_free(key);
311         if (PyErr_Occurred())
312                 catch_exception("Stray exception in srd_inst_set_options().");
313
314         return ret;
315 }
316
317 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */
318 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
319 {
320         return strcmp(a->id, probe_id);
321 }
322
323 /**
324  * Set probes in a decoder instance.
325  *
326  * @param di Decoder instance.
327  * @param probes A GHashTable of probes to set. Key is probe name, value is
328  *               the probe number. Samples passed to this instance will be
329  *               arranged in this order.
330  *
331  * @return SRD_OK upon success, a (negative) error code otherwise.
332  */
333 SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
334                                     GHashTable *new_probes)
335 {
336         GList *l;
337         GSList *sl;
338         struct srd_probe *p;
339         int *new_probemap, new_probenum;
340         char *probe_id, *probenum_str;
341
342         srd_dbg("set probes called for instance %s with list of %d probes",
343                 di->inst_id, g_hash_table_size(new_probes));
344
345         if (g_hash_table_size(new_probes) == 0)
346                 /* No probes provided. */
347                 return SRD_OK;
348
349         if (di->dec_num_probes == 0) {
350                 /* Decoder has no probes. */
351                 srd_err("Protocol decoder %s has no probes to define.",
352                         di->decoder->name);
353                 return SRD_ERR_ARG;
354         }
355
356         new_probemap = NULL;
357
358         if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
359                 srd_err("Failed to g_malloc() new probe map.");
360                 return SRD_ERR_MALLOC;
361         }
362
363         for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
364                 probe_id = l->data;
365                 probenum_str = g_hash_table_lookup(new_probes, probe_id);
366                 if (!probenum_str) {
367                         /* Probe name was specified without a value. */
368                         srd_err("No probe number was specified for %s.",
369                                 probe_id);
370                         g_free(new_probemap);
371                         return SRD_ERR_ARG;
372                 }
373                 new_probenum = strtol(probenum_str, NULL, 10);
374                 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
375                                 (GCompareFunc)compare_probe_id))) {
376                         /* Fall back on optional probes. */
377                         if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
378                              probe_id, (GCompareFunc) compare_probe_id))) {
379                                 srd_err("Protocol decoder %s has no probe "
380                                         "'%s'.", di->decoder->name, probe_id);
381                                 g_free(new_probemap);
382                                 return SRD_ERR_ARG;
383                         }
384                 }
385                 p = sl->data;
386                 new_probemap[p->order] = new_probenum;
387                 srd_dbg("setting probe mapping for %d = probe %d", p->order,
388                         new_probenum);
389         }
390         g_free(di->dec_probemap);
391         di->dec_probemap = new_probemap;
392
393         return SRD_OK;
394 }
395
396 /**
397  * Create a new protocol decoder instance.
398  *
399  * @param id Decoder 'id' field.
400  * @param options GHashtable of options which override the defaults set in
401  *                the decoder class.
402  *
403  * @return Pointer to a newly allocated struct srd_decoder_inst, or
404  *         NULL in case of failure.
405  */
406 SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
407                                                       GHashTable *options)
408 {
409         int i;
410         struct srd_decoder *dec;
411         struct srd_decoder_inst *di;
412         char *inst_id;
413
414         srd_dbg("Creating new %s instance.", decoder_id);
415
416         if (!(dec = srd_decoder_get_by_id(decoder_id))) {
417                 srd_err("Protocol decoder %s not found.", decoder_id);
418                 return NULL;
419         }
420
421         if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
422                 srd_err("Failed to g_malloc() instance.");
423                 return NULL;
424         }
425
426         inst_id = g_hash_table_lookup(options, "id");
427         di->decoder = dec;
428         di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
429         g_hash_table_remove(options, "id");
430
431         /* Prepare a default probe map, where samples come in the
432          * order in which the decoder class defined them.
433          */
434         di->dec_num_probes = g_slist_length(di->decoder->probes) +
435                              g_slist_length(di->decoder->opt_probes);
436         if (di->dec_num_probes) {
437                 if (!(di->dec_probemap =
438                      g_try_malloc(sizeof(int) * di->dec_num_probes))) {
439                         srd_err("Failed to g_malloc() probe map.");
440                         g_free(di);
441                         return NULL;
442                 }
443                 for (i = 0; i < di->dec_num_probes; i++)
444                         di->dec_probemap[i] = i;
445         }
446
447         /* Create a new instance of this decoder class. */
448         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
449                 if (PyErr_Occurred())
450                         catch_exception("failed to create %s instance: ",
451                                         decoder_id);
452                 g_free(di->dec_probemap);
453                 g_free(di);
454                 return NULL;
455         }
456
457         if (srd_inst_options_set(di, options) != SRD_OK) {
458                 g_free(di->dec_probemap);
459                 g_free(di);
460                 return NULL;
461         }
462
463         /* Instance takes input from a frontend by default. */
464         di_list = g_slist_append(di_list, di);
465
466         return di;
467 }
468
469 /**
470  * Stack a decoder instance on top of another.
471  *
472  * @param di_from The instance to move.
473  * @param di_to The instance on top of which di_from will be stacked.
474  *
475  * @return SRD_OK upon success, a (negative) error code otherwise.
476  */
477 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
478                                struct srd_decoder_inst *di_to)
479 {
480         if (!di_from || !di_to) {
481                 srd_err("Invalid from/to instance pair.");
482                 return SRD_ERR_ARG;
483         }
484
485         if (g_slist_find(di_list, di_to)) {
486                 /* Remove from the unstacked list. */
487                 di_list = g_slist_remove(di_list, di_to);
488         }
489
490         /* Stack on top of source di. */
491         di_from->next_di = g_slist_append(di_from->next_di, di_to);
492
493         return SRD_OK;
494 }
495
496 /**
497  * Finds a decoder instance by its instance id, but only in the bottom
498  * level of instances -- instances already stacked on top of another one
499  * will not be found.
500  *
501  * @param inst_id The instance id to be found.
502  *
503  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
504  */
505 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id)
506 {
507         GSList *l;
508         struct srd_decoder_inst *tmp, *di;
509
510         di = NULL;
511         for (l = di_list; l; l = l->next) {
512                 tmp = l->data;
513                 if (!strcmp(tmp->inst_id, inst_id)) {
514                         di = tmp;
515                         break;
516                 }
517         }
518
519         return di;
520 }
521
522 /**
523  * Finds a decoder instance by its Python object, i.e. that instance's
524  * instantiation of the sigrokdecode.Decoder class. This will recurse
525  * to find the instance anywhere in the stack tree.
526  *
527  * @param stack Pointer to a GSList of struct srd_decoder_inst,
528  *              indicating the stack to search. To start searching at the bottom
529  *              level of decoder instances, pass NULL.
530  * @param obj The Python class instantiation.
531  *
532  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
533  */
534 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack,
535                                                               PyObject *obj)
536 {
537         GSList *l;
538         struct srd_decoder_inst *tmp, *di;
539
540         di = NULL;
541         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
542                 tmp = l->data;
543                 if (tmp->py_inst == obj)
544                         di = tmp;
545                 else if (tmp->next_di)
546                         di = srd_inst_find_by_obj(tmp->next_di, obj);
547         }
548
549         return di;
550 }
551
552 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
553 {
554         PyObject *py_name, *py_res;
555         GSList *l;
556         struct srd_decoder_inst *next_di;
557
558         srd_dbg("Calling start() method on protocol decoder instance %s.",
559                 di->inst_id);
560
561         if (!(py_name = PyUnicode_FromString("start"))) {
562                 srd_err("Unable to build Python object for 'start'.");
563                 catch_exception("Protocol decoder instance %s: ",
564                                 di->inst_id);
565                 return SRD_ERR_PYTHON;
566         }
567
568         if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
569                                                   py_name, args, NULL))) {
570                 catch_exception("Protocol decoder instance %s: ",
571                                 di->inst_id);
572                 return SRD_ERR_PYTHON;
573         }
574
575         Py_DecRef(py_res);
576         Py_DecRef(py_name);
577
578         /* Start all the PDs stacked on top of this one. Pass along the
579          * metadata all the way from the bottom PD, even though it's only
580          * applicable to logic data for now.
581          */
582         for (l = di->next_di; l; l = l->next) {
583                 next_di = l->data;
584                 srd_inst_start(next_di, args);
585         }
586
587         return SRD_OK;
588 }
589
590 /**
591  * Run the specified decoder function.
592  *
593  * @param start_samplenum The starting sample number for the buffer's sample
594  *                        set, relative to the start of capture.
595  * @param di The decoder instance to call. Must not be NULL.
596  * @param inbuf The buffer to decode. Must not be NULL.
597  * @param inbuflen Length of the buffer. Must be > 0.
598  *
599  * @return SRD_OK upon success, a (negative) error code otherwise.
600  */
601 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
602                                 struct srd_decoder_inst *di,
603                                 uint8_t *inbuf, uint64_t inbuflen)
604 {
605         PyObject *py_res;
606         srd_logic *logic;
607         uint64_t end_samplenum;
608
609         srd_dbg("Calling decode() on instance %s with %d bytes starting "
610                 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
611
612         /* Return an error upon unusable input. */
613         if (!di) {
614                 srd_dbg("empty decoder instance");
615                 return SRD_ERR_ARG;
616         }
617         if (!inbuf) {
618                 srd_dbg("NULL buffer pointer");
619                 return SRD_ERR_ARG;
620         }
621         if (inbuflen == 0) {
622                 srd_dbg("empty buffer");
623                 return SRD_ERR_ARG;
624         }
625
626         /* Create new srd_logic object. Each iteration around the PD's loop
627          * will fill one sample into this object.
628          */
629         logic = PyObject_New(srd_logic, &srd_logic_type);
630         Py_INCREF(logic);
631         logic->di = di;
632         logic->start_samplenum = start_samplenum;
633         logic->itercnt = 0;
634         logic->inbuf = inbuf;
635         logic->inbuflen = inbuflen;
636         logic->sample = PyList_New(2);
637         Py_INCREF(logic->sample);
638
639         Py_IncRef(di->py_inst);
640         end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
641         if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
642                                            "KKO", logic->start_samplenum,
643                                            end_samplenum, logic))) {
644                 catch_exception("Protocol decoder instance %s: ",
645                                 di->inst_id);
646                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
647         }
648         Py_DecRef(py_res);
649
650         return SRD_OK;
651 }
652
653 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
654 {
655         GSList *l;
656         struct srd_pd_output *pdo;
657
658         srd_dbg("Freeing instance %s", di->inst_id);
659
660         Py_DecRef(di->py_inst);
661         g_free(di->inst_id);
662         g_free(di->dec_probemap);
663         g_slist_free(di->next_di);
664         for (l = di->pd_output; l; l = l->next) {
665                 pdo = l->data;
666                 g_free(pdo->proto_id);
667                 g_free(pdo);
668         }
669         g_slist_free(di->pd_output);
670 }
671
672 SRD_PRIV void srd_inst_free_all(GSList *stack)
673 {
674         GSList *l;
675         struct srd_decoder_inst *di;
676
677         di = NULL;
678         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
679                 di = l->data;
680                 if (di->next_di)
681                         srd_inst_free_all(di->next_di);
682                 srd_inst_free(di);
683         }
684         if (!stack) {
685                 g_slist_free(di_list);
686                 di_list = NULL;
687         }
688 }
689
690 /**
691  * Start a decoding session.
692  *
693  * Decoders, instances and stack must have been prepared beforehand.
694  *
695  * @param num_probes The number of probes which the incoming feed will contain.
696  * @param unitsize The number of bytes per sample in the incoming feed.
697  * @param The samplerate of the incoming feed.
698  *
699  * @return SRD_OK upon success, a (negative) error code otherwise.
700  */
701 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
702 {
703         PyObject *args;
704         GSList *d;
705         struct srd_decoder_inst *di;
706         int ret;
707
708         srd_dbg("Calling start() on all instances with %d probes, "
709                 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
710
711         /* Currently only one item of metadata is passed along to decoders,
712          * samplerate. This can be extended as needed.
713          */
714         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
715                 srd_err("Unable to build Python object for metadata.");
716                 return SRD_ERR_PYTHON;
717         }
718
719         /* Run the start() method on all decoders receiving frontend data. */
720         for (d = di_list; d; d = d->next) {
721                 di = d->data;
722                 di->data_num_probes = num_probes;
723                 di->data_unitsize = unitsize;
724                 di->data_samplerate = samplerate;
725                 if ((ret = srd_inst_start(di, args) != SRD_OK))
726                         break;
727         }
728
729         Py_DecRef(args);
730
731         return ret;
732 }
733
734 /**
735  * Feed a chunk of logic sample data to a running decoder session.
736  *
737  * @param start_samplenum The sample number of the first sample in this chunk.
738  * @param inbuf Pointer to sample data.
739  * @param inbuf Length in bytes of the buffer.
740  *
741  * @return SRD_OK upon success, a (negative) error code otherwise.
742  */
743 SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf,
744                              uint64_t inbuflen)
745 {
746         GSList *d;
747         int ret;
748
749         srd_dbg("Calling decode() on all instances with starting sample "
750                 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
751                 start_samplenum, inbuflen, inbuf);
752
753         for (d = di_list; d; d = d->next) {
754                 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
755                                                inbuflen)) != SRD_OK)
756                         return ret;
757         }
758
759         return SRD_OK;
760 }
761
762 /**
763  * Register a decoder output callback function.
764  *
765  * The function will be called when a protocol decoder sends output back
766  * to the PD controller (except for Python objects, which only go up the
767  * stack).
768  *
769  * @param output_type The output type this callback will receive. Only one
770  * callback per output type can be registered.
771  * @param cb The function to call.
772  * @param user_data Unused.
773  */
774 SRD_API int srd_register_callback(int output_type,
775                                   srd_pd_output_callback_t cb, void *user_data)
776 {
777         struct srd_pd_callback *pd_cb;
778
779         srd_dbg("Registering new callback for output type %d.", output_type);
780
781         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
782                 srd_err("Failed to g_malloc() struct srd_pd_callback.");
783                 return SRD_ERR_MALLOC;
784         }
785
786         pd_cb->output_type = output_type;
787         pd_cb->callback = cb;
788         pd_cb->user_data = user_data;
789         callbacks = g_slist_append(callbacks, pd_cb);
790
791         return SRD_OK;
792 }
793
794 SRD_PRIV void *srd_find_callback(int output_type)
795 {
796         GSList *l;
797         struct srd_pd_callback *pd_cb;
798         void *(cb);
799
800         cb = NULL;
801         for (l = callbacks; l; l = l->next) {
802                 pd_cb = l->data;
803                 if (pd_cb->output_type == output_type) {
804                         cb = pd_cb->callback;
805                         break;
806                 }
807         }
808
809         return cb;
810 }
811
812 /* This is the backend function to Python sigrokdecode.add() call. */
813 SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
814                     char *proto_id)
815 {
816         struct srd_pd_output *pdo;
817
818         srd_dbg("Instance %s creating new output type %d for %s.",
819                 di->inst_id, output_type, proto_id);
820
821         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
822                 srd_err("Failed to g_malloc() struct srd_pd_output.");
823                 return -1;
824         }
825
826         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
827         pdo->pdo_id = g_slist_length(di->pd_output);
828         pdo->output_type = output_type;
829         pdo->di = di;
830         pdo->proto_id = g_strdup(proto_id);
831         di->pd_output = g_slist_append(di->pd_output, pdo);
832
833         return pdo->pdo_id;
834 }