controller.c

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