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