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