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