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