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