276dc2dcc686cca61dbff2f914789fc08282f6cf
[libsigrokdecode.git] / controller.c
1 /*
2  * This file is part of the libsigrokdecode 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 "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode-internal.h"
23 #include "config.h"
24 #include <glib.h>
25 #include <inttypes.h>
26 #include <stdlib.h>
27
28 /**
29  * @mainpage libsigrokdecode API
30  *
31  * @section sec_intro Introduction
32  *
33  * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
34  * portable, cross-platform, Free/Libre/Open-Source signal analysis software
35  * suite that supports various device types (such as logic analyzers,
36  * oscilloscopes, multimeters, and more).
37  *
38  * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a
39  * shared library written in C which provides the basic API for (streaming)
40  * protocol decoding functionality.
41  *
42  * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
43  * are written in Python (>= 3.0).
44  *
45  * @section sec_api API reference
46  *
47  * See the "Modules" page for an introduction to various libsigrokdecode
48  * related topics and the detailed API documentation of the respective
49  * functions.
50  *
51  * You can also browse the API documentation by file, or review all
52  * data structures.
53  *
54  * @section sec_mailinglists Mailing lists
55  *
56  * There are two mailing lists for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
57  *
58  * @section sec_irc IRC
59  *
60  * You can find the sigrok developers in the
61  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
62  * IRC channel on Freenode.
63  *
64  * @section sec_website Website
65  *
66  * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
67  */
68
69 /**
70  * @file
71  *
72  * Initializing and shutting down libsigrokdecode.
73  */
74
75 /**
76  * @defgroup grp_init Initialization
77  *
78  * Initializing and shutting down libsigrokdecode.
79  *
80  * Before using any of the libsigrokdecode functionality, srd_init() must
81  * be called to initialize the library.
82  *
83  * When libsigrokdecode functionality is no longer needed, srd_exit() should
84  * be called.
85  *
86  * @{
87  */
88
89 /* List of decoder instances. */
90 static GSList *di_list = NULL;
91
92 /* List of frontend callbacks to receive decoder output. */
93 static GSList *callbacks = NULL;
94
95 /** @cond PRIVATE */
96
97 /* decoder.c */
98 extern SRD_PRIV GSList *pd_list;
99
100 /* module_sigrokdecode.c */
101 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
102
103 /* type_logic.c */
104 extern SRD_PRIV PyTypeObject srd_logic_type;
105
106 /** @endcond */
107
108 /**
109  * Initialize libsigrokdecode.
110  *
111  * This initializes the Python interpreter, and creates and initializes
112  * a "sigrokdecode" Python module.
113  *
114  * Then, it searches for sigrok protocol decoders in the "decoders"
115  * subdirectory of the the libsigrokdecode installation directory.
116  * All decoders that are found are loaded into memory and added to an
117  * internal list of decoders, which can be queried via srd_decoder_list().
118  *
119  * The caller is responsible for calling the clean-up function srd_exit(),
120  * which will properly shut down libsigrokdecode and free its allocated memory.
121  *
122  * Multiple calls to srd_init(), without calling srd_exit() in between,
123  * are not allowed.
124  *
125  * @param path Path to an extra directory containing protocol decoders
126  *             which will be added to the Python sys.path. May be NULL.
127  *
128  * @return SRD_OK upon success, a (negative) error code otherwise.
129  *         Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
130  *         directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
131  *         If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
132  *
133  * @since 0.1.0
134  */
135 SRD_API int srd_init(const char *path)
136 {
137         int ret;
138         char *env_path;
139
140         srd_dbg("Initializing libsigrokdecode.");
141
142         /* Add our own module to the list of built-in modules. */
143         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
144
145         /* Initialize the Python interpreter. */
146         Py_Initialize();
147
148         /* Installed decoders. */
149         if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
150                 Py_Finalize();
151                 return ret;
152         }
153
154         /* Path specified by the user. */
155         if (path) {
156                 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
157                         Py_Finalize();
158                         return ret;
159                 }
160         }
161
162         /* Environment variable overrides everything, for debugging. */
163         if ((env_path = getenv("SIGROKDECODE_DIR"))) {
164                 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
165                         Py_Finalize();
166                         return ret;
167                 }
168         }
169
170         return SRD_OK;
171 }
172
173 /**
174  * Shutdown libsigrokdecode.
175  *
176  * This frees all the memory allocated for protocol decoders and shuts down
177  * the Python interpreter.
178  *
179  * This function should only be called if there was a (successful!) invocation
180  * of srd_init() before. Calling this function multiple times in a row, without
181  * any successful srd_init() calls in between, is not allowed.
182  *
183  * @return SRD_OK upon success, a (negative) error code otherwise.
184  *
185  * @since 0.1.0
186  */
187 SRD_API int srd_exit(void)
188 {
189         srd_dbg("Exiting libsigrokdecode.");
190
191         srd_decoder_unload_all();
192         g_slist_free(pd_list);
193         pd_list = NULL;
194
195         /* Py_Finalize() returns void, any finalization errors are ignored. */
196         Py_Finalize();
197
198         return SRD_OK;
199 }
200
201 /**
202  * Add an additional search directory for the protocol decoders.
203  *
204  * The specified directory is prepended (not appended!) to Python's sys.path,
205  * in order to search for sigrok protocol decoders in the specified
206  * directories first, and in the generic Python module directories (and in
207  * the current working directory) last. This avoids conflicts if there are
208  * Python modules which have the same name as a sigrok protocol decoder in
209  * sys.path or in the current working directory.
210  *
211  * @param path Path to the directory containing protocol decoders which shall
212  *             be added to the Python sys.path, or NULL.
213  *
214  * @return SRD_OK upon success, a (negative) error code otherwise.
215  *
216  * @private
217  *
218  * @since 0.1.0
219  */
220 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
221 {
222         PyObject *py_cur_path, *py_item;
223         GString *new_path;
224         int wc_len, i;
225         wchar_t *wc_new_path;
226         char *item;
227
228         srd_dbg("Adding '%s' to module path.", path);
229
230         new_path = g_string_sized_new(256);
231         g_string_assign(new_path, path);
232         py_cur_path = PySys_GetObject("path");
233         for (i = 0; i < PyList_Size(py_cur_path); i++) {
234                 g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S);
235                 py_item = PyList_GetItem(py_cur_path, i);
236                 if (!PyUnicode_Check(py_item))
237                         /* Shouldn't happen. */
238                         continue;
239                 if (py_str_as_str(py_item, &item) != SRD_OK)
240                         continue;
241                 g_string_append(new_path, item);
242                 g_free(item);
243         }
244
245         /* Convert to wide chars. */
246         wc_len = sizeof(wchar_t) * (new_path->len + 1);
247         if (!(wc_new_path = g_try_malloc(wc_len))) {
248                 srd_dbg("malloc failed");
249                 return SRD_ERR_MALLOC;
250         }
251         mbstowcs(wc_new_path, new_path->str, wc_len);
252         PySys_SetPath(wc_new_path);
253         g_string_free(new_path, TRUE);
254         g_free(wc_new_path);
255
256         return SRD_OK;
257 }
258
259 /** @} */
260
261 /**
262  * @defgroup grp_instances Decoder instances
263  *
264  * Decoder instance handling.
265  *
266  * @{
267  */
268
269 /**
270  * Set one or more options in a decoder instance.
271  *
272  * Handled options are removed from the hash.
273  *
274  * @param di Decoder instance.
275  * @param options A GHashTable of options to set.
276  *
277  * @return SRD_OK upon success, a (negative) error code otherwise.
278  *
279  * @since 0.1.0
280  */
281 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
282                 GHashTable *options)
283 {
284         PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
285         PyObject *py_optlist, *py_classval;
286         Py_UNICODE *py_ustr;
287         GVariant *value;
288         unsigned long long int val_ull;
289         gint64 val_int;
290         int num_optkeys, ret, size, i;
291         const char *val_str;
292         char *dbg, *key;
293
294         if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
295                 /* Decoder has no options. */
296                 if (g_hash_table_size(options) == 0) {
297                         /* No options provided. */
298                         return SRD_OK;
299                 } else {
300                         srd_err("Protocol decoder has no options.");
301                         return SRD_ERR_ARG;
302                 }
303                 return SRD_OK;
304         }
305
306         ret = SRD_ERR_PYTHON;
307         key = NULL;
308         py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
309         py_optlist = py_classval = NULL;
310         py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
311
312         /* All of these are synthesized objects, so they're good. */
313         py_dec_optkeys = PyDict_Keys(py_dec_options);
314         num_optkeys = PyList_Size(py_dec_optkeys);
315         if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
316                 goto err_out;
317         for (i = 0; i < num_optkeys; i++) {
318                 /* Get the default class value for this option. */
319                 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
320                 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
321                         goto err_out;
322                 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
323                         goto err_out;
324                 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
325                         srd_err("Options of type %s are not yet supported.",
326                                 Py_TYPE(py_classval)->tp_name);
327                         goto err_out;
328                 }
329
330                 if ((value = g_hash_table_lookup(options, key))) {
331                         dbg = g_variant_print(value, TRUE);
332                         srd_dbg("got option '%s' = %s", key, dbg);
333                         g_free(dbg);
334                         /* An override for this option was provided. */
335                         if (PyUnicode_Check(py_classval)) {
336                                 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
337                                         srd_err("Option '%s' requires a string value.", key);
338                                         goto err_out;
339                                 }
340                                 val_str = g_variant_get_string(value, NULL);
341                                 if (!(py_optval = PyUnicode_FromString(val_str))) {
342                                         /* Some UTF-8 encoding error. */
343                                         PyErr_Clear();
344                                         srd_err("Option '%s' requires a UTF-8 string value.", key);
345                                         goto err_out;
346                                 }
347                         } else if (PyLong_Check(py_classval)) {
348                                 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
349                                         srd_err("Option '%s' requires an integer value.", key);
350                                         goto err_out;
351                                 }
352                                 val_int = g_variant_get_int64(value);
353                                 if (!(py_optval = PyLong_FromLong(val_int))) {
354                                         /* ValueError Exception */
355                                         PyErr_Clear();
356                                         srd_err("Option '%s' has invalid integer value.", key);
357                                         goto err_out;
358                                 }
359                         }
360                         g_hash_table_remove(options, key);
361                 } else {
362                         /* Use the class default for this option. */
363                         if (PyUnicode_Check(py_classval)) {
364                                 /* Make a brand new copy of the string. */
365                                 py_ustr = PyUnicode_AS_UNICODE(py_classval);
366                                 size = PyUnicode_GET_SIZE(py_classval);
367                                 py_optval = PyUnicode_FromUnicode(py_ustr, size);
368                         } else if (PyLong_Check(py_classval)) {
369                                 /* Make a brand new copy of the integer. */
370                                 val_ull = PyLong_AsUnsignedLongLong(py_classval);
371                                 if (val_ull == (unsigned long long)-1) {
372                                         /* OverFlowError exception */
373                                         PyErr_Clear();
374                                         srd_err("Invalid integer value for %s: "
375                                                 "expected integer.", key);
376                                         goto err_out;
377                                 }
378                                 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
379                                         goto err_out;
380                         }
381                 }
382
383                 /*
384                  * If we got here, py_optval holds a known good new reference
385                  * to the instance option to set.
386                  */
387                 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
388                         goto err_out;
389                 g_free(key);
390                 key = NULL;
391         }
392
393         ret = SRD_OK;
394
395 err_out:
396         Py_XDECREF(py_optlist);
397         Py_XDECREF(py_di_options);
398         Py_XDECREF(py_dec_optkeys);
399         Py_XDECREF(py_dec_options);
400         g_free(key);
401         if (PyErr_Occurred())
402                 srd_exception_catch("Stray exception in srd_inst_option_set().");
403
404         return ret;
405 }
406
407 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
408 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
409 {
410         return strcmp(a->id, probe_id);
411 }
412
413 /**
414  * Set all probes in a decoder instance.
415  *
416  * This function sets _all_ probes for the specified decoder instance, i.e.,
417  * it overwrites any probes that were already defined (if any).
418  *
419  * @param di Decoder instance.
420  * @param new_probes A GHashTable of probes to set. Key is probe name, value is
421  *                   the probe number. Samples passed to this instance will be
422  *                   arranged in this order.
423  *
424  * @return SRD_OK upon success, a (negative) error code otherwise.
425  *
426  * @since 0.1.0
427  */
428 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
429                 GHashTable *new_probes)
430 {
431         GVariant *probe_val;
432         GList *l;
433         GSList *sl;
434         struct srd_probe *p;
435         int *new_probemap, new_probenum;
436         char *probe_id;
437         int i, num_required_probes;
438
439         srd_dbg("set probes called for instance %s with list of %d probes",
440                 di->inst_id, g_hash_table_size(new_probes));
441
442         if (g_hash_table_size(new_probes) == 0)
443                 /* No probes provided. */
444                 return SRD_OK;
445
446         if (di->dec_num_probes == 0) {
447                 /* Decoder has no probes. */
448                 srd_err("Protocol decoder %s has no probes to define.",
449                         di->decoder->name);
450                 return SRD_ERR_ARG;
451         }
452
453         new_probemap = NULL;
454
455         if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
456                 srd_err("Failed to g_malloc() new probe map.");
457                 return SRD_ERR_MALLOC;
458         }
459
460         /*
461          * For now, map all indexes to probe -1 (can be overridden later).
462          * This -1 is interpreted as an unspecified probe later.
463          */
464         for (i = 0; i < di->dec_num_probes; i++)
465                 new_probemap[i] = -1;
466
467         for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
468                 probe_id = l->data;
469                 probe_val= g_hash_table_lookup(new_probes, probe_id);
470                 if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
471                         /* Probe name was specified without a value. */
472                         srd_err("No probe number was specified for %s.",
473                                         probe_id);
474                         g_free(new_probemap);
475                         return SRD_ERR_ARG;
476                 }
477                 new_probenum = g_variant_get_int32(probe_val);
478                 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
479                                 (GCompareFunc)compare_probe_id))) {
480                         /* Fall back on optional probes. */
481                         if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
482                              probe_id, (GCompareFunc) compare_probe_id))) {
483                                 srd_err("Protocol decoder %s has no probe "
484                                                 "'%s'.", di->decoder->name, probe_id);
485                                 g_free(new_probemap);
486                                 return SRD_ERR_ARG;
487                         }
488                 }
489                 p = sl->data;
490                 new_probemap[p->order] = new_probenum;
491                 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
492                         p->id, p->order, new_probenum);
493         }
494
495         srd_dbg("Final probe map:");
496         num_required_probes = g_slist_length(di->decoder->probes);
497         for (i = 0; i < di->dec_num_probes; i++) {
498                 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
499                         (i < num_required_probes) ? "required" : "optional");
500         }
501
502         g_free(di->dec_probemap);
503         di->dec_probemap = new_probemap;
504
505         return SRD_OK;
506 }
507
508 /**
509  * Create a new protocol decoder instance.
510  *
511  * @param decoder_id Decoder 'id' field.
512  * @param options GHashtable of options which override the defaults set in
513  *                the decoder class. May be NULL.
514  *
515  * @return Pointer to a newly allocated struct srd_decoder_inst, or
516  *         NULL in case of failure.
517  *
518  * @since 0.1.0
519  */
520 SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
521                 GHashTable *options)
522 {
523         int i;
524         struct srd_decoder *dec;
525         struct srd_decoder_inst *di;
526         char *inst_id;
527
528         srd_dbg("Creating new %s instance.", decoder_id);
529
530         if (!(dec = srd_decoder_get_by_id(decoder_id))) {
531                 srd_err("Protocol decoder %s not found.", decoder_id);
532                 return NULL;
533         }
534
535         if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
536                 srd_err("Failed to g_malloc() instance.");
537                 return NULL;
538         }
539
540         di->decoder = dec;
541         if (options) {
542                 inst_id = g_hash_table_lookup(options, "id");
543                 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
544                 g_hash_table_remove(options, "id");
545         } else
546                 di->inst_id = g_strdup(decoder_id);
547
548         /*
549          * Prepare a default probe map, where samples come in the
550          * order in which the decoder class defined them.
551          */
552         di->dec_num_probes = g_slist_length(di->decoder->probes) +
553                              g_slist_length(di->decoder->opt_probes);
554         if (di->dec_num_probes) {
555                 if (!(di->dec_probemap =
556                      g_try_malloc(sizeof(int) * di->dec_num_probes))) {
557                         srd_err("Failed to g_malloc() probe map.");
558                         g_free(di);
559                         return NULL;
560                 }
561                 for (i = 0; i < di->dec_num_probes; i++)
562                         di->dec_probemap[i] = i;
563         }
564
565         /* Create a new instance of this decoder class. */
566         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
567                 if (PyErr_Occurred())
568                         srd_exception_catch("failed to create %s instance: ",
569                                             decoder_id);
570                 g_free(di->dec_probemap);
571                 g_free(di);
572                 return NULL;
573         }
574
575         if (options && srd_inst_option_set(di, options) != SRD_OK) {
576                 g_free(di->dec_probemap);
577                 g_free(di);
578                 return NULL;
579         }
580
581         /* Instance takes input from a frontend by default. */
582         di_list = g_slist_append(di_list, di);
583
584         return di;
585 }
586
587 /**
588  * Stack a decoder instance on top of another.
589  *
590  * @param di_from The instance to move.
591  * @param di_to The instance on top of which di_from will be stacked.
592  *
593  * @return SRD_OK upon success, a (negative) error code otherwise.
594  *
595  * @since 0.1.0
596  */
597 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
598                 struct srd_decoder_inst *di_to)
599 {
600         if (!di_from || !di_to) {
601                 srd_err("Invalid from/to instance pair.");
602                 return SRD_ERR_ARG;
603         }
604
605         if (g_slist_find(di_list, di_to)) {
606                 /* Remove from the unstacked list. */
607                 di_list = g_slist_remove(di_list, di_to);
608         }
609
610         /* Stack on top of source di. */
611         di_from->next_di = g_slist_append(di_from->next_di, di_to);
612
613         return SRD_OK;
614 }
615
616 /**
617  * Find a decoder instance by its instance ID.
618  *
619  * Only the bottom level of instances are searched -- instances already stacked
620  * on top of another one will not be found.
621  *
622  * @param inst_id The instance ID to be found.
623  *
624  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
625  *
626  * @since 0.1.0
627  */
628 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id)
629 {
630         GSList *l;
631         struct srd_decoder_inst *tmp, *di;
632
633         di = NULL;
634         for (l = di_list; l; l = l->next) {
635                 tmp = l->data;
636                 if (!strcmp(tmp->inst_id, inst_id)) {
637                         di = tmp;
638                         break;
639                 }
640         }
641
642         return di;
643 }
644
645 /**
646  * Find a decoder instance by its Python object.
647  *
648  * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
649  * This will recurse to find the instance anywhere in the stack tree.
650  *
651  * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
652  *              stack to search. To start searching at the bottom level of
653  *              decoder instances, pass NULL.
654  * @param obj The Python class instantiation.
655  *
656  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
657  *
658  * @private
659  *
660  * @since 0.1.0
661  */
662 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
663                 const PyObject *obj)
664 {
665         const GSList *l;
666         struct srd_decoder_inst *tmp, *di;
667
668         di = NULL;
669         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
670                 tmp = l->data;
671                 if (tmp->py_inst == obj)
672                         di = tmp;
673                 else if (tmp->next_di)
674                         di = srd_inst_find_by_obj(tmp->next_di, obj);
675         }
676
677         return di;
678 }
679
680 /** @private */
681 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
682 {
683         PyObject *py_name, *py_res;
684         GSList *l;
685         struct srd_decoder_inst *next_di;
686
687         srd_dbg("Calling start() method on protocol decoder instance %s.",
688                 di->inst_id);
689
690         if (!(py_name = PyUnicode_FromString("start"))) {
691                 srd_err("Unable to build Python object for 'start'.");
692                 srd_exception_catch("Protocol decoder instance %s: ",
693                                     di->inst_id);
694                 return SRD_ERR_PYTHON;
695         }
696
697         if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
698                                                   py_name, args, NULL))) {
699                 srd_exception_catch("Protocol decoder instance %s: ",
700                                     di->inst_id);
701                 return SRD_ERR_PYTHON;
702         }
703
704         Py_DecRef(py_res);
705         Py_DecRef(py_name);
706
707         /*
708          * Start all the PDs stacked on top of this one. Pass along the
709          * metadata all the way from the bottom PD, even though it's only
710          * applicable to logic data for now.
711          */
712         for (l = di->next_di; l; l = l->next) {
713                 next_di = l->data;
714                 srd_inst_start(next_di, args);
715         }
716
717         return SRD_OK;
718 }
719
720 /**
721  * Run the specified decoder function.
722  *
723  * @param start_samplenum The starting sample number for the buffer's sample
724  *                        set, relative to the start of capture.
725  * @param di The decoder instance to call. Must not be NULL.
726  * @param inbuf The buffer to decode. Must not be NULL.
727  * @param inbuflen Length of the buffer. Must be > 0.
728  *
729  * @return SRD_OK upon success, a (negative) error code otherwise.
730  *
731  * @private
732  *
733  * @since 0.1.0
734  */
735 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
736                 const struct srd_decoder_inst *di, const uint8_t *inbuf,
737                 uint64_t inbuflen)
738 {
739         PyObject *py_res;
740         srd_logic *logic;
741         uint64_t end_samplenum;
742
743         srd_dbg("Calling decode() on instance %s with %d bytes starting "
744                 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
745
746         /* Return an error upon unusable input. */
747         if (!di) {
748                 srd_dbg("empty decoder instance");
749                 return SRD_ERR_ARG;
750         }
751         if (!inbuf) {
752                 srd_dbg("NULL buffer pointer");
753                 return SRD_ERR_ARG;
754         }
755         if (inbuflen == 0) {
756                 srd_dbg("empty buffer");
757                 return SRD_ERR_ARG;
758         }
759
760         /*
761          * Create new srd_logic object. Each iteration around the PD's loop
762          * will fill one sample into this object.
763          */
764         logic = PyObject_New(srd_logic, &srd_logic_type);
765         Py_INCREF(logic);
766         logic->di = (struct srd_decoder_inst *)di;
767         logic->start_samplenum = start_samplenum;
768         logic->itercnt = 0;
769         logic->inbuf = (uint8_t *)inbuf;
770         logic->inbuflen = inbuflen;
771         logic->sample = PyList_New(2);
772         Py_INCREF(logic->sample);
773
774         Py_IncRef(di->py_inst);
775         end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
776         if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
777                                            "KKO", logic->start_samplenum,
778                                            end_samplenum, logic))) {
779                 srd_exception_catch("Protocol decoder instance %s: ",
780                                     di->inst_id);
781                 return SRD_ERR_PYTHON;
782         }
783         Py_DecRef(py_res);
784
785         return SRD_OK;
786 }
787
788 /** @private */
789 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
790 {
791         GSList *l;
792         struct srd_pd_output *pdo;
793
794         srd_dbg("Freeing instance %s", di->inst_id);
795
796         Py_DecRef(di->py_inst);
797         g_free(di->inst_id);
798         g_free(di->dec_probemap);
799         g_slist_free(di->next_di);
800         for (l = di->pd_output; l; l = l->next) {
801                 pdo = l->data;
802                 g_free(pdo->proto_id);
803                 g_free(pdo);
804         }
805         g_slist_free(di->pd_output);
806         g_free(di);
807 }
808
809 /** @private */
810 SRD_PRIV void srd_inst_free_all(GSList *stack)
811 {
812         GSList *l;
813         struct srd_decoder_inst *di;
814
815         di = NULL;
816         for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
817                 di = l->data;
818                 if (di->next_di)
819                         srd_inst_free_all(di->next_di);
820                 srd_inst_free(di);
821         }
822         if (!stack) {
823                 g_slist_free(di_list);
824                 di_list = NULL;
825         }
826 }
827
828 /** @} */
829
830 /**
831  * @defgroup grp_session Session handling
832  *
833  * Starting and handling decoding sessions.
834  *
835  * @{
836  */
837
838 /**
839  * Start a decoding session.
840  *
841  * Decoders, instances and stack must have been prepared beforehand.
842  *
843  * @param num_probes The number of probes which the incoming feed will contain.
844  * @param unitsize The number of bytes per sample in the incoming feed.
845  * @param samplerate The samplerate of the incoming feed.
846  *
847  * @return SRD_OK upon success, a (negative) error code otherwise.
848  *
849  * @since 0.1.0
850  */
851 SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
852 {
853         PyObject *args;
854         GSList *d;
855         struct srd_decoder_inst *di;
856         int ret;
857
858         ret = SRD_OK;
859
860         srd_dbg("Calling start() on all instances with %d probes, "
861                 "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
862
863         /*
864          * Currently only one item of metadata is passed along to decoders,
865          * samplerate. This can be extended as needed.
866          */
867         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
868                 srd_err("Unable to build Python object for metadata.");
869                 return SRD_ERR_PYTHON;
870         }
871
872         /* Run the start() method on all decoders receiving frontend data. */
873         for (d = di_list; d; d = d->next) {
874                 di = d->data;
875                 di->data_num_probes = num_probes;
876                 di->data_unitsize = unitsize;
877                 di->data_samplerate = samplerate;
878                 if ((ret = srd_inst_start(di, args)) != SRD_OK)
879                         break;
880         }
881
882         Py_DecRef(args);
883
884         return ret;
885 }
886
887 /**
888  * Send a chunk of logic sample data to a running decoder session.
889  *
890  * @param start_samplenum The sample number of the first sample in this chunk.
891  * @param inbuf Pointer to sample data.
892  * @param inbuflen Length in bytes of the buffer.
893  *
894  * @return SRD_OK upon success, a (negative) error code otherwise.
895  *
896  * @since 0.1.0
897  */
898 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
899                 uint64_t inbuflen)
900 {
901         GSList *d;
902         int ret;
903
904         srd_dbg("Calling decode() on all instances with starting sample "
905                 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
906                 start_samplenum, inbuflen, inbuf);
907
908         for (d = di_list; d; d = d->next) {
909                 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
910                                            inbuflen)) != SRD_OK)
911                         return ret;
912         }
913
914         return SRD_OK;
915 }
916
917 /**
918  * Register/add a decoder output callback function.
919  *
920  * The function will be called when a protocol decoder sends output back
921  * to the PD controller (except for Python objects, which only go up the
922  * stack).
923  *
924  * @param output_type The output type this callback will receive. Only one
925  *                    callback per output type can be registered.
926  * @param cb The function to call. Must not be NULL.
927  * @param cb_data Private data for the callback function. Can be NULL.
928  *
929  * @since 0.1.0
930  */
931 SRD_API int srd_pd_output_callback_add(int output_type,
932                 srd_pd_output_callback_t cb, void *cb_data)
933 {
934         struct srd_pd_callback *pd_cb;
935
936         srd_dbg("Registering new callback for output type %d.", output_type);
937
938         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
939                 srd_err("Failed to g_malloc() struct srd_pd_callback.");
940                 return SRD_ERR_MALLOC;
941         }
942
943         pd_cb->output_type = output_type;
944         pd_cb->cb = cb;
945         pd_cb->cb_data = cb_data;
946         callbacks = g_slist_append(callbacks, pd_cb);
947
948         return SRD_OK;
949 }
950
951 /** @private */
952 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(int output_type)
953 {
954         GSList *l;
955         struct srd_pd_callback *tmp, *pd_cb;
956
957         pd_cb = NULL;
958         for (l = callbacks; l; l = l->next) {
959                 tmp = l->data;
960                 if (tmp->output_type == output_type) {
961                         pd_cb = tmp;
962                         break;
963                 }
964         }
965
966         return pd_cb;
967 }
968
969 /* This is the backend function to Python sigrokdecode.add() call. */
970 /** @private */
971 SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
972                                     int output_type, const char *proto_id)
973 {
974         struct srd_pd_output *pdo;
975
976         srd_dbg("Instance %s creating new output type %d for %s.",
977                 di->inst_id, output_type, proto_id);
978
979         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
980                 srd_err("Failed to g_malloc() struct srd_pd_output.");
981                 return -1;
982         }
983
984         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
985         pdo->pdo_id = g_slist_length(di->pd_output);
986         pdo->output_type = output_type;
987         pdo->di = di;
988         pdo->proto_id = g_strdup(proto_id);
989         di->pd_output = g_slist_append(di->pd_output, pdo);
990
991         return pdo->pdo_id;
992 }
993
994 /** @} */