controller.c

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