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