instance.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 <config.h>
  22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #include "libsigrokdecode.h"
  24 #include <glib.h>
  25 #include <inttypes.h>
  26 #include <stdlib.h>
  27 #include <stdint.h>
  28
  29 /** @cond PRIVATE */
  30
  31 extern SRD_PRIV GSList *sessions;
  32
  33 static void srd_inst_join_decode_thread(struct srd_decoder_inst *di);
  34 static void srd_inst_reset_state(struct srd_decoder_inst *di);
  35 SRD_PRIV void oldpins_array_seed(struct srd_decoder_inst *di);
  36 SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di);
  37
  38 /** @endcond */
  39
  40 /**
  41  * @file
  42  *
  43  * Decoder instance handling.
  44  */
  45
  46 /**
  47  * @defgroup grp_instances Decoder instances
  48  *
  49  * Decoder instance handling.
  50  *
  51  * @{
  52  */
  53
  54 /**
  55  * Set one or more options in a decoder instance.
  56  *
  57  * Handled options are removed from the hash.
  58  *
  59  * @param di Decoder instance.
  60  * @param options A GHashTable of options to set.
  61  *
  62  * @return SRD_OK upon success, a (negative) error code otherwise.
  63  *
  64  * @since 0.1.0
  65  */
  66 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
  67                 GHashTable *options)
  68 {
  69         struct srd_decoder_option *sdo;
  70         PyObject *py_di_options, *py_optval;
  71         GVariant *value;
  72         GSList *l;
  73         double val_double;
  74         gint64 val_int;
  75         int ret;
  76         const char *val_str;
  77         PyGILState_STATE gstate;
  78
  79         if (!di) {
  80                 srd_err("Invalid decoder instance.");
  81                 return SRD_ERR_ARG;
  82         }
  83
  84         if (!options) {
  85                 srd_err("Invalid options GHashTable.");
  86                 return SRD_ERR_ARG;
  87         }
  88
  89         gstate = PyGILState_Ensure();
  90
  91         if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
  92                 /* Decoder has no options. */
  93                 PyGILState_Release(gstate);
  94                 if (g_hash_table_size(options) == 0) {
  95                         /* No options provided. */
  96                         return SRD_OK;
  97                 } else {
  98                         srd_err("Protocol decoder has no options.");
  99                         return SRD_ERR_ARG;
 100                 }
 101                 return SRD_OK;
 102         }
 103
 104         ret = SRD_ERR_PYTHON;
 105         py_optval = NULL;
 106
 107         /*
 108          * The 'options' tuple is a class variable, but we need to
 109          * change it. Changing it directly will affect the entire class,
 110          * so we need to create a new object for it, and populate that
 111          * instead.
 112          */
 113         if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
 114                 goto err_out;
 115         Py_DECREF(py_di_options);
 116         py_di_options = PyDict_New();
 117         PyObject_SetAttrString(di->py_inst, "options", py_di_options);
 118
 119         for (l = di->decoder->options; l; l = l->next) {
 120                 sdo = l->data;
 121                 if ((value = g_hash_table_lookup(options, sdo->id))) {
 122                         /* A value was supplied for this option. */
 123                         if (!g_variant_type_equal(g_variant_get_type(value),
 124                                   g_variant_get_type(sdo->def))) {
 125                                 srd_err("Option '%s' should have the same type "
 126                                         "as the default value.", sdo->id);
 127                                 goto err_out;
 128                         }
 129                 } else {
 130                         /* Use default for this option. */
 131                         value = sdo->def;
 132                 }
 133                 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
 134                         val_str = g_variant_get_string(value, NULL);
 135                         if (!(py_optval = PyUnicode_FromString(val_str))) {
 136                                 /* Some UTF-8 encoding error. */
 137                                 PyErr_Clear();
 138                                 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
 139                                 goto err_out;
 140                         }
 141                 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
 142                         val_int = g_variant_get_int64(value);
 143                         if (!(py_optval = PyLong_FromLong(val_int))) {
 144                                 /* ValueError Exception */
 145                                 PyErr_Clear();
 146                                 srd_err("Option '%s' has invalid integer value.", sdo->id);
 147                                 goto err_out;
 148                         }
 149                 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
 150                         val_double = g_variant_get_double(value);
 151                         if (!(py_optval = PyFloat_FromDouble(val_double))) {
 152                                 /* ValueError Exception */
 153                                 PyErr_Clear();
 154                                 srd_err("Option '%s' has invalid float value.",
 155                                         sdo->id);
 156                                 goto err_out;
 157                         }
 158                 }
 159                 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
 160                         goto err_out;
 161                 /* Not harmful even if we used the default. */
 162                 g_hash_table_remove(options, sdo->id);
 163         }
 164         if (g_hash_table_size(options) != 0)
 165                 srd_warn("Unknown options specified for '%s'", di->inst_id);
 166
 167         ret = SRD_OK;
 168
 169 err_out:
 170         Py_XDECREF(py_optval);
 171         if (PyErr_Occurred()) {
 172                 srd_exception_catch("Stray exception in srd_inst_option_set()");
 173                 ret = SRD_ERR_PYTHON;
 174         }
 175         PyGILState_Release(gstate);
 176
 177         return ret;
 178 }
 179
 180 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all(). */
 181 static gint compare_channel_id(const struct srd_channel *pdch,
 182                         const char *channel_id)
 183 {
 184         return strcmp(pdch->id, channel_id);
 185 }
 186
 187 /**
 188  * Set all channels in a decoder instance.
 189  *
 190  * This function sets _all_ channels for the specified decoder instance, i.e.,
 191  * it overwrites any channels that were already defined (if any).
 192  *
 193  * @param di Decoder instance.
 194  * @param new_channels A GHashTable of channels to set. Key is channel name,
 195  *                     value is the channel number. Samples passed to this
 196  *                     instance will be arranged in this order.
 197  *
 198  * @return SRD_OK upon success, a (negative) error code otherwise.
 199  *
 200  * @since 0.4.0
 201  */
 202 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
 203                 GHashTable *new_channels)
 204 {
 205         GVariant *channel_val;
 206         GList *l;
 207         GSList *sl;
 208         struct srd_channel *pdch;
 209         int *new_channelmap, new_channelnum, num_required_channels, i;
 210         char *channel_id;
 211
 212         srd_dbg("Setting channels for instance %s with list of %d channels.",
 213                 di->inst_id, g_hash_table_size(new_channels));
 214
 215         if (g_hash_table_size(new_channels) == 0)
 216                 /* No channels provided. */
 217                 return SRD_OK;
 218
 219         if (di->dec_num_channels == 0) {
 220                 /* Decoder has no channels. */
 221                 srd_err("Protocol decoder %s has no channels to define.",
 222                         di->decoder->name);
 223                 return SRD_ERR_ARG;
 224         }
 225
 226         new_channelmap = g_malloc0(sizeof(int) * di->dec_num_channels);
 227
 228         /*
 229          * For now, map all indexes to channel -1 (can be overridden later).
 230          * This -1 is interpreted as an unspecified channel later.
 231          */
 232         for (i = 0; i < di->dec_num_channels; i++)
 233                 new_channelmap[i] = -1;
 234
 235         for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
 236                 channel_id = l->data;
 237                 channel_val = g_hash_table_lookup(new_channels, channel_id);
 238                 if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
 239                         /* Channel name was specified without a value. */
 240                         srd_err("No channel number was specified for %s.",
 241                                         channel_id);
 242                         g_free(new_channelmap);
 243                         return SRD_ERR_ARG;
 244                 }
 245                 new_channelnum = g_variant_get_int32(channel_val);
 246                 if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
 247                                 (GCompareFunc)compare_channel_id))) {
 248                         /* Fall back on optional channels. */
 249                         if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
 250                              channel_id, (GCompareFunc)compare_channel_id))) {
 251                                 srd_err("Protocol decoder %s has no channel "
 252                                         "'%s'.", di->decoder->name, channel_id);
 253                                 g_free(new_channelmap);
 254                                 return SRD_ERR_ARG;
 255                         }
 256                 }
 257                 pdch = sl->data;
 258                 new_channelmap[pdch->order] = new_channelnum;
 259                 srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.",
 260                         pdch->id, pdch->order, new_channelnum);
 261         }
 262
 263         srd_dbg("Final channel map:");
 264         num_required_channels = g_slist_length(di->decoder->channels);
 265         for (i = 0; i < di->dec_num_channels; i++) {
 266                 GSList *ll = g_slist_nth(di->decoder->channels, i);
 267                 if (!ll)
 268                         ll = g_slist_nth(di->decoder->opt_channels,
 269                                 i - num_required_channels);
 270                 pdch = ll->data;
 271                 srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i,
 272                         pdch->id, new_channelmap[i],
 273                         (i < num_required_channels) ? "required" : "optional");
 274         }
 275
 276         /* Report an error if not all required channels were specified. */
 277         for (i = 0; i < num_required_channels; i++) {
 278                 if (new_channelmap[i] != -1)
 279                         continue;
 280                 pdch = g_slist_nth(di->decoder->channels, i)->data;
 281                 srd_err("Required channel '%s' (index %d) was not specified.",
 282                         pdch->id, i);
 283                 g_free(new_channelmap);
 284                 return SRD_ERR;
 285         }
 286
 287         g_free(di->dec_channelmap);
 288         di->dec_channelmap = new_channelmap;
 289
 290         return SRD_OK;
 291 }
 292
 293 /**
 294  * Create a new protocol decoder instance.
 295  *
 296  * @param sess The session holding the protocol decoder instance.
 297  *             Must not be NULL.
 298  * @param decoder_id Decoder 'id' field.
 299  * @param options GHashtable of options which override the defaults set in
 300  *                the decoder class. May be NULL.
 301  *
 302  * @return Pointer to a newly allocated struct srd_decoder_inst, or
 303  *         NULL in case of failure.
 304  *
 305  * @since 0.3.0
 306  */
 307 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
 308                 const char *decoder_id, GHashTable *options)
 309 {
 310         int i;
 311         struct srd_decoder *dec;
 312         struct srd_decoder_inst *di;
 313         char *inst_id;
 314         PyGILState_STATE gstate;
 315
 316         i = 1;
 317         srd_dbg("Creating new %s instance.", decoder_id);
 318
 319         if (!sess)
 320                 return NULL;
 321
 322         if (!(dec = srd_decoder_get_by_id(decoder_id))) {
 323                 srd_err("Protocol decoder %s not found.", decoder_id);
 324                 return NULL;
 325         }
 326
 327         di = g_malloc0(sizeof(struct srd_decoder_inst));
 328
 329         di->decoder = dec;
 330         di->sess = sess;
 331
 332         if (options) {
 333                 inst_id = g_hash_table_lookup(options, "id");
 334                 if (inst_id)
 335                         di->inst_id = g_strdup(inst_id);
 336                 g_hash_table_remove(options, "id");
 337         }
 338
 339         /* Create a unique instance ID (as none was provided). */
 340         if (!di->inst_id) {
 341                 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
 342                 while (srd_inst_find_by_id(sess, di->inst_id)) {
 343                         g_free(di->inst_id);
 344                         di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
 345                 }
 346         }
 347
 348         /*
 349          * Prepare a default channel map, where samples come in the
 350          * order in which the decoder class defined them.
 351          */
 352         di->dec_num_channels = g_slist_length(di->decoder->channels) +
 353                         g_slist_length(di->decoder->opt_channels);
 354         if (di->dec_num_channels) {
 355                 di->dec_channelmap =
 356                                 g_malloc(sizeof(int) * di->dec_num_channels);
 357                 for (i = 0; i < di->dec_num_channels; i++)
 358                         di->dec_channelmap[i] = i;
 359                 /*
 360                  * Will be used to prepare a sample at every iteration
 361                  * of the instance's decode() method.
 362                  */
 363                 di->channel_samples = g_malloc(di->dec_num_channels);
 364         }
 365
 366         /* Default to the initial pins being the same as in sample 0. */
 367         oldpins_array_seed(di);
 368
 369         gstate = PyGILState_Ensure();
 370
 371         /* Create a new instance of this decoder class. */
 372         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
 373                 if (PyErr_Occurred())
 374                         srd_exception_catch("Failed to create %s instance",
 375                                         decoder_id);
 376                 PyGILState_Release(gstate);
 377                 g_free(di->dec_channelmap);
 378                 g_free(di);
 379                 return NULL;
 380         }
 381
 382         PyGILState_Release(gstate);
 383
 384         if (options && srd_inst_option_set(di, options) != SRD_OK) {
 385                 g_free(di->dec_channelmap);
 386                 g_free(di);
 387                 return NULL;
 388         }
 389
 390         di->condition_list = NULL;
 391         di->match_array = NULL;
 392         di->abs_start_samplenum = 0;
 393         di->abs_end_samplenum = 0;
 394         di->inbuf = NULL;
 395         di->inbuflen = 0;
 396         di->abs_cur_samplenum = 0;
 397         di->thread_handle = NULL;
 398         di->got_new_samples = FALSE;
 399         di->handled_all_samples = FALSE;
 400         di->want_wait_terminate = FALSE;
 401
 402         /*
 403          * Strictly speaking initialization of statically allocated
 404          * condition and mutex variables (or variables allocated on the
 405          * stack) is not required, but won't harm either. Explicitly
 406          * running init() will better match subsequent clear() calls.
 407          */
 408         g_cond_init(&di->got_new_samples_cond);
 409         g_cond_init(&di->handled_all_samples_cond);
 410         g_mutex_init(&di->data_mutex);
 411
 412         /* Instance takes input from a frontend by default. */
 413         sess->di_list = g_slist_append(sess->di_list, di);
 414         srd_dbg("Created new %s instance with ID %s.", decoder_id, di->inst_id);
 415
 416         return di;
 417 }
 418
 419 static void srd_inst_join_decode_thread(struct srd_decoder_inst *di)
 420 {
 421         if (!di)
 422                 return;
 423         if (!di->thread_handle)
 424                 return;
 425
 426         srd_dbg("%s: Joining decoder thread.", di->inst_id);
 427
 428         /*
 429          * Terminate potentially running threads which still
 430          * execute the decoder instance's decode() method.
 431          */
 432         srd_dbg("%s: Raising want_term, sending got_new.", di->inst_id);
 433         g_mutex_lock(&di->data_mutex);
 434         di->want_wait_terminate = TRUE;
 435         g_cond_signal(&di->got_new_samples_cond);
 436         g_mutex_unlock(&di->data_mutex);
 437
 438         srd_dbg("%s: Running join().", di->inst_id);
 439         (void)g_thread_join(di->thread_handle);
 440         srd_dbg("%s: Call to join() done.", di->inst_id);
 441         di->thread_handle = NULL;
 442
 443         /*
 444          * Reset condition and mutex variables, such that next
 445          * operations on them will find them in a clean state.
 446          */
 447         g_cond_clear(&di->got_new_samples_cond);
 448         g_cond_init(&di->got_new_samples_cond);
 449         g_cond_clear(&di->handled_all_samples_cond);
 450         g_cond_init(&di->handled_all_samples_cond);
 451         g_mutex_clear(&di->data_mutex);
 452         g_mutex_init(&di->data_mutex);
 453 }
 454
 455 static void srd_inst_reset_state(struct srd_decoder_inst *di)
 456 {
 457         if (!di)
 458                 return;
 459
 460         srd_dbg("%s: Resetting decoder state.", di->inst_id);
 461
 462         /* Reset internal state of the decoder. */
 463         condition_list_free(di);
 464         match_array_free(di);
 465         di->abs_start_samplenum = 0;
 466         di->abs_end_samplenum = 0;
 467         di->inbuf = NULL;
 468         di->inbuflen = 0;
 469         di->abs_cur_samplenum = 0;
 470         oldpins_array_free(di);
 471         di->got_new_samples = FALSE;
 472         di->handled_all_samples = FALSE;
 473         di->want_wait_terminate = FALSE;
 474         /* Conditions and mutex got reset after joining the thread. */
 475 }
 476
 477 /**
 478  * Stack a decoder instance on top of another.
 479  *
 480  * @param sess The session holding the protocol decoder instances.
 481  *             Must not be NULL.
 482  * @param di_bottom The instance on top of which di_top will be stacked.
 483  * @param di_top The instance to go on top.
 484  *
 485  * @return SRD_OK upon success, a (negative) error code otherwise.
 486  *
 487  * @since 0.3.0
 488  */
 489 SRD_API int srd_inst_stack(struct srd_session *sess,
 490                 struct srd_decoder_inst *di_bottom,
 491                 struct srd_decoder_inst *di_top)
 492 {
 493         if (!sess)
 494                 return SRD_ERR_ARG;
 495
 496         if (!di_bottom || !di_top) {
 497                 srd_err("Invalid from/to instance pair.");
 498                 return SRD_ERR_ARG;
 499         }
 500
 501         if (g_slist_find(sess->di_list, di_top)) {
 502                 /* Remove from the unstacked list. */
 503                 sess->di_list = g_slist_remove(sess->di_list, di_top);
 504         }
 505
 506         /* Stack on top of source di. */
 507         di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
 508
 509         srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
 510
 511         return SRD_OK;
 512 }
 513
 514 /**
 515  * Search a decoder instance and its stack for instance ID.
 516  *
 517  * @param[in] inst_id ID to search for.
 518  * @param[in] stack A decoder instance, potentially with stacked instances.
 519  *
 520  * @return The matching instance, or NULL.
 521  */
 522 static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id,
 523                 struct srd_decoder_inst *stack)
 524 {
 525         const GSList *l;
 526         struct srd_decoder_inst *tmp, *di;
 527
 528         if (!strcmp(stack->inst_id, inst_id))
 529                 return stack;
 530
 531         /* Otherwise, look recursively in our stack. */
 532         di = NULL;
 533         if (stack->next_di) {
 534                 for (l = stack->next_di; l; l = l->next) {
 535                         tmp = l->data;
 536                         if (!strcmp(tmp->inst_id, inst_id)) {
 537                                 di = tmp;
 538                                 break;
 539                         }
 540                 }
 541         }
 542
 543         return di;
 544 }
 545
 546 /**
 547  * Find a decoder instance by its instance ID.
 548  *
 549  * This will recurse to find the instance anywhere in the stack tree of the
 550  * given session.
 551  *
 552  * @param sess The session holding the protocol decoder instance.
 553  *             Must not be NULL.
 554  * @param inst_id The instance ID to be found.
 555  *
 556  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
 557  *
 558  * @since 0.3.0
 559  */
 560 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
 561                 const char *inst_id)
 562 {
 563         GSList *l;
 564         struct srd_decoder_inst *tmp, *di;
 565
 566         if (!sess)
 567                 return NULL;
 568
 569         di = NULL;
 570         for (l = sess->di_list; l; l = l->next) {
 571                 tmp = l->data;
 572                 if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL)
 573                         break;
 574         }
 575
 576         return di;
 577 }
 578
 579 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
 580                 struct srd_session *sess, const GSList *stack,
 581                 const PyObject *obj)
 582 {
 583         const GSList *l;
 584         struct srd_decoder_inst *tmp, *di;
 585
 586         if (!sess)
 587                 return NULL;
 588
 589         di = NULL;
 590         for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
 591                 tmp = l->data;
 592                 if (tmp->py_inst == obj)
 593                         di = tmp;
 594                 else if (tmp->next_di)
 595                         di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
 596         }
 597
 598         return di;
 599 }
 600
 601 /**
 602  * Find a decoder instance by its Python object.
 603  *
 604  * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
 605  * This will recurse to find the instance anywhere in the stack tree of all
 606  * sessions.
 607  *
 608  * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
 609  *              stack to search. To start searching at the bottom level of
 610  *              decoder instances, pass NULL.
 611  * @param obj The Python class instantiation.
 612  *
 613  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
 614  *
 615  * @private
 616  *
 617  * @since 0.1.0
 618  */
 619 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
 620                 const PyObject *obj)
 621 {
 622         struct srd_decoder_inst *di;
 623         struct srd_session *sess;
 624         GSList *l;
 625
 626         di = NULL;
 627         for (l = sessions; di == NULL && l != NULL; l = l->next) {
 628                 sess = l->data;
 629                 di = srd_sess_inst_find_by_obj(sess, stack, obj);
 630         }
 631
 632         return di;
 633 }
 634
 635 /**
 636  * Set the list of initial (assumed) pin values.
 637  *
 638  * @param di Decoder instance to use. Must not be NULL.
 639  * @param initial_pins A GArray of uint8_t values. Must not be NULL.
 640  *
 641  * @since 0.5.0
 642  */
 643 SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *initial_pins)
 644 {
 645         int i;
 646         GString *s;
 647
 648         if (!di) {
 649                 srd_err("Invalid decoder instance.");
 650                 return SRD_ERR_ARG;
 651         }
 652
 653         if (!initial_pins)
 654                 return SRD_ERR_ARG;
 655
 656         if (initial_pins->len != (guint)di->dec_num_channels) {
 657                 srd_err("Incorrect number of channels (need %d, got %d).",
 658                         di->dec_num_channels, initial_pins->len);
 659                 return SRD_ERR_ARG;
 660         }
 661
 662         /* Sanity-check initial pin state values. */
 663         for (i = 0; i < di->dec_num_channels; i++) {
 664                 if (initial_pins->data[i] <= 2)
 665                         continue;
 666                 srd_err("Invalid initial channel %d pin state: %d.",
 667                         i, initial_pins->data[i]);
 668                 return SRD_ERR_ARG;
 669         }
 670
 671         s = g_string_sized_new(100);
 672         oldpins_array_seed(di);
 673         for (i = 0; i < di->dec_num_channels; i++) {
 674                 di->old_pins_array->data[i] = initial_pins->data[i];
 675                 g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]);
 676         }
 677         s = g_string_truncate(s, s->len - 2);
 678         srd_dbg("Initial pins: %s.", s->str);
 679         g_string_free(s, TRUE);
 680
 681         return SRD_OK;
 682 }
 683
 684 /** @private */
 685 SRD_PRIV void oldpins_array_seed(struct srd_decoder_inst *di)
 686 {
 687         size_t count;
 688         GArray *arr;
 689
 690         if (!di)
 691                 return;
 692         if (di->old_pins_array)
 693                 return;
 694
 695         srd_dbg("%s: Seeding old pins, %s().", di->inst_id, __func__);
 696         count = di->dec_num_channels;
 697         arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count);
 698         g_array_set_size(arr, count);
 699         memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count);
 700         di->old_pins_array = arr;
 701 }
 702
 703 /** @private */
 704 SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di)
 705 {
 706         if (!di)
 707                 return;
 708         if (!di->old_pins_array)
 709                 return;
 710
 711         srd_dbg("%s: Releasing initial pin state.", di->inst_id);
 712
 713         g_array_free(di->old_pins_array, TRUE);
 714         di->old_pins_array = NULL;
 715 }
 716
 717 /** @private */
 718 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
 719 {
 720         PyObject *py_res;
 721         GSList *l;
 722         struct srd_decoder_inst *next_di;
 723         int ret;
 724         PyGILState_STATE gstate;
 725
 726         srd_dbg("Calling start() method on protocol decoder instance %s.",
 727                         di->inst_id);
 728
 729         gstate = PyGILState_Ensure();
 730
 731         /* Run self.start(). */
 732         if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
 733                 srd_exception_catch("Protocol decoder instance %s",
 734                                 di->inst_id);
 735                 PyGILState_Release(gstate);
 736                 return SRD_ERR_PYTHON;
 737         }
 738         Py_DecRef(py_res);
 739
 740         /* Set self.samplenum to 0. */
 741         PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0));
 742
 743         /* Set self.matched to None. */
 744         PyObject_SetAttrString(di->py_inst, "matched", Py_None);
 745
 746         PyGILState_Release(gstate);
 747
 748         /* Start all the PDs stacked on top of this one. */
 749         for (l = di->next_di; l; l = l->next) {
 750                 next_di = l->data;
 751                 if ((ret = srd_inst_start(next_di)) != SRD_OK)
 752                         return ret;
 753         }
 754
 755         return SRD_OK;
 756 }
 757
 758 /**
 759  * Check whether the specified sample matches the specified term.
 760  *
 761  * In the case of SRD_TERM_SKIP, this function can modify
 762  * term->num_samples_already_skipped.
 763  *
 764  * @param old_sample The value of the previous sample (0/1).
 765  * @param sample The value of the current sample (0/1).
 766  * @param term The term that should be checked for a match. Must not be NULL.
 767  *
 768  * @retval TRUE The current sample matches the specified term.
 769  * @retval FALSE The current sample doesn't match the specified term, or an
 770  *               invalid term was provided.
 771  *
 772  * @private
 773  */
 774 __attribute__((always_inline))
 775 static inline gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
 776 {
 777         /* Caller ensures term != NULL. */
 778
 779         switch (term->type) {
 780         case SRD_TERM_HIGH:
 781                 if (sample == 1)
 782                         return TRUE;
 783                 break;
 784         case SRD_TERM_LOW:
 785                 if (sample == 0)
 786                         return TRUE;
 787                 break;
 788         case SRD_TERM_RISING_EDGE:
 789                 if (old_sample == 0 && sample == 1)
 790                         return TRUE;
 791                 break;
 792         case SRD_TERM_FALLING_EDGE:
 793                 if (old_sample == 1 && sample == 0)
 794                         return TRUE;
 795                 break;
 796         case SRD_TERM_EITHER_EDGE:
 797                 if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1))
 798                         return TRUE;
 799                 break;
 800         case SRD_TERM_NO_EDGE:
 801                 if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1))
 802                         return TRUE;
 803                 break;
 804         case SRD_TERM_SKIP:
 805                 if (term->num_samples_already_skipped == term->num_samples_to_skip)
 806                         return TRUE;
 807                 term->num_samples_already_skipped++;
 808                 break;
 809         default:
 810                 srd_err("Unknown term type %d.", term->type);
 811                 break;
 812         }
 813
 814         return FALSE;
 815 }
 816
 817 /** @private */
 818 SRD_PRIV void match_array_free(struct srd_decoder_inst *di)
 819 {
 820         if (!di || !di->match_array)
 821                 return;
 822
 823         g_array_free(di->match_array, TRUE);
 824         di->match_array = NULL;
 825 }
 826
 827 /** @private */
 828 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di)
 829 {
 830         GSList *l, *ll;
 831
 832         if (!di)
 833                 return;
 834
 835         for (l = di->condition_list; l; l = l->next) {
 836                 ll = l->data;
 837                 if (ll)
 838                         g_slist_free_full(ll, g_free);
 839         }
 840
 841         di->condition_list = NULL;
 842 }
 843
 844 static gboolean have_non_null_conds(const struct srd_decoder_inst *di)
 845 {
 846         GSList *l, *cond;
 847
 848         if (!di)
 849                 return FALSE;
 850
 851         for (l = di->condition_list; l; l = l->next) {
 852                 cond = l->data;
 853                 if (cond)
 854                         return TRUE;
 855         }
 856
 857         return FALSE;
 858 }
 859
 860 static void update_old_pins_array(struct srd_decoder_inst *di,
 861                 const uint8_t *sample_pos)
 862 {
 863         uint8_t sample;
 864         int i, byte_offset, bit_offset;
 865
 866         if (!di || !di->dec_channelmap || !sample_pos)
 867                 return;
 868
 869         oldpins_array_seed(di);
 870         for (i = 0; i < di->dec_num_channels; i++) {
 871                 byte_offset = di->dec_channelmap[i] / 8;
 872                 bit_offset = di->dec_channelmap[i] % 8;
 873                 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
 874                 di->old_pins_array->data[i] = sample;
 875         }
 876 }
 877
 878 static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di)
 879 {
 880         uint8_t sample;
 881         int i, byte_offset, bit_offset;
 882         const uint8_t *sample_pos;
 883
 884         if (!di || !di->dec_channelmap)
 885                 return;
 886
 887         sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
 888
 889         oldpins_array_seed(di);
 890         for (i = 0; i < di->dec_num_channels; i++) {
 891                 if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0)
 892                         continue;
 893                 byte_offset = di->dec_channelmap[i] / 8;
 894                 bit_offset = di->dec_channelmap[i] % 8;
 895                 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
 896                 di->old_pins_array->data[i] = sample;
 897         }
 898 }
 899
 900 static gboolean term_matches(const struct srd_decoder_inst *di,
 901                 struct srd_term *term, const uint8_t *sample_pos)
 902 {
 903         uint8_t old_sample, sample;
 904         int byte_offset, bit_offset, ch;
 905
 906         /* Caller ensures di, di->dec_channelmap, term, sample_pos != NULL. */
 907
 908         if (term->type == SRD_TERM_SKIP)
 909                 return sample_matches(0, 0, term);
 910
 911         ch = term->channel;
 912         byte_offset = di->dec_channelmap[ch] / 8;
 913         bit_offset = di->dec_channelmap[ch] % 8;
 914         sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
 915         old_sample = di->old_pins_array->data[ch];
 916
 917         return sample_matches(old_sample, sample, term);
 918 }
 919
 920 static gboolean all_terms_match(const struct srd_decoder_inst *di,
 921                 const GSList *cond, const uint8_t *sample_pos)
 922 {
 923         const GSList *l;
 924         struct srd_term *term;
 925
 926         /* Caller ensures di, cond, sample_pos != NULL. */
 927
 928         for (l = cond; l; l = l->next) {
 929                 term = l->data;
 930                 if (!term_matches(di, term, sample_pos))
 931                         return FALSE;
 932         }
 933
 934         return TRUE;
 935 }
 936
 937 static gboolean at_least_one_condition_matched(
 938                 const struct srd_decoder_inst *di, unsigned int num_conditions)
 939 {
 940         unsigned int i;
 941
 942         /* Caller ensures di != NULL. */
 943
 944         for (i = 0; i < num_conditions; i++) {
 945                 if (di->match_array->data[i])
 946                         return TRUE;
 947         }
 948
 949         return FALSE;
 950 }
 951
 952 static gboolean find_match(struct srd_decoder_inst *di)
 953 {
 954         uint64_t i, j, num_samples_to_process;
 955         GSList *l, *cond;
 956         const uint8_t *sample_pos;
 957         unsigned int num_conditions;
 958
 959         /* Caller ensures di != NULL. */
 960
 961         /* Check whether the condition list is NULL/empty. */
 962         if (!di->condition_list) {
 963                 srd_dbg("NULL/empty condition list, automatic match.");
 964                 return TRUE;
 965         }
 966
 967         /* Check whether we have any non-NULL conditions. */
 968         if (!have_non_null_conds(di)) {
 969                 srd_dbg("Only NULL conditions in list, automatic match.");
 970                 return TRUE;
 971         }
 972
 973         num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum;
 974         num_conditions = g_slist_length(di->condition_list);
 975
 976         /* di->match_array is NULL here. Create a new GArray. */
 977         di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions);
 978         g_array_set_size(di->match_array, num_conditions);
 979
 980         /* Sample 0: Set di->old_pins_array for SRD_INITIAL_PIN_SAME_AS_SAMPLE0 pins. */
 981         if (di->abs_cur_samplenum == 0)
 982                 update_old_pins_array_initial_pins(di);
 983
 984         for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) {
 985
 986                 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
 987
 988                 /* Check whether the current sample matches at least one of the conditions (logical OR). */
 989                 /* IMPORTANT: We need to check all conditions, even if there was a match already! */
 990                 for (l = di->condition_list, j = 0; l; l = l->next, j++) {
 991                         cond = l->data;
 992                         if (!cond)
 993                                 continue;
 994                         /* All terms in 'cond' must match (logical AND). */
 995                         di->match_array->data[j] = all_terms_match(di, cond, sample_pos);
 996                 }
 997
 998                 update_old_pins_array(di, sample_pos);
 999
1000                 /* If at least one condition matched we're done. */
1001                 if (at_least_one_condition_matched(di, num_conditions))
1002                         return TRUE;
1003         }
1004
1005         return FALSE;
1006 }
1007
1008 /**
1009  * Process available samples and check if they match the defined conditions.
1010  *
1011  * This function returns if there is an error, or when a match is found, or
1012  * when all samples have been processed (whether a match was found or not).
1013  * This function immediately terminates when the decoder's wait() method
1014  * invocation shall get terminated.
1015  *
1016  * @param di The decoder instance to use. Must not be NULL.
1017  * @param found_match Will be set to TRUE if at least one condition matched,
1018  *                    FALSE otherwise. Must not be NULL.
1019  *
1020  * @retval SRD_OK No errors occured, see found_match for the result.
1021  * @retval SRD_ERR_ARG Invalid arguments.
1022  *
1023  * @private
1024  */
1025 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match)
1026 {
1027         if (!di || !found_match)
1028                 return SRD_ERR_ARG;
1029
1030         *found_match = FALSE;
1031         if (di->want_wait_terminate)
1032                 return SRD_OK;
1033
1034         /* Check if any of the current condition(s) match. */
1035         while (TRUE) {
1036                 /* Feed the (next chunk of the) buffer to find_match(). */
1037                 *found_match = find_match(di);
1038
1039                 /* Did we handle all samples yet? */
1040                 if (di->abs_cur_samplenum >= di->abs_end_samplenum) {
1041                         srd_dbg("Done, handled all samples (abs cur %" PRIu64
1042                                 " / abs end %" PRIu64 ").",
1043                                 di->abs_cur_samplenum, di->abs_end_samplenum);
1044                         return SRD_OK;
1045                 }
1046
1047                 /* If we didn't find a match, continue looking. */
1048                 if (!(*found_match))
1049                         continue;
1050
1051                 /* At least one condition matched, return. */
1052                 return SRD_OK;
1053         }
1054
1055         return SRD_OK;
1056 }
1057
1058 /**
1059  * Worker thread (per PD-stack).
1060  *
1061  * @param data Pointer to the lowest-level PD's device instance.
1062  *             Must not be NULL.
1063  *
1064  * @return NULL if there was an error.
1065  */
1066 static gpointer di_thread(gpointer data)
1067 {
1068         PyObject *py_res;
1069         struct srd_decoder_inst *di;
1070         int wanted_term;
1071         PyGILState_STATE gstate;
1072
1073         if (!data)
1074                 return NULL;
1075
1076         di = data;
1077
1078         srd_dbg("%s: Starting thread routine for decoder.", di->inst_id);
1079
1080         gstate = PyGILState_Ensure();
1081
1082         /*
1083          * Call self.decode(). Only returns if the PD throws an exception.
1084          * "Regular" termination of the decode() method is not expected.
1085          */
1086         Py_IncRef(di->py_inst);
1087         srd_dbg("%s: Calling decode() method.", di->inst_id);
1088         py_res = PyObject_CallMethod(di->py_inst, "decode", NULL);
1089         srd_dbg("%s: decode() method terminated.", di->inst_id);
1090
1091         /*
1092          * Make sure to unblock potentially pending srd_inst_decode()
1093          * calls in application threads after the decode() method might
1094          * have terminated, while it neither has processed sample data
1095          * nor has terminated upon request. This happens e.g. when "need
1096          * a samplerate to decode" exception is thrown.
1097          */
1098         g_mutex_lock(&di->data_mutex);
1099         wanted_term = di->want_wait_terminate;
1100         di->want_wait_terminate = TRUE;
1101         di->handled_all_samples = TRUE;
1102         g_cond_signal(&di->handled_all_samples_cond);
1103         g_mutex_unlock(&di->data_mutex);
1104
1105         /*
1106          * Check for the termination cause of the decode() method.
1107          * Though this is mostly for information.
1108          */
1109         if (!py_res && wanted_term) {
1110                 /*
1111                  * Silently ignore errors upon return from decode() calls
1112                  * when termination was requested. Terminate the thread
1113                  * which executed this instance's decode() logic.
1114                  */
1115                 srd_dbg("%s: Thread done (!res, want_term).", di->inst_id);
1116                 PyErr_Clear();
1117                 PyGILState_Release(gstate);
1118                 return NULL;
1119         }
1120         if (!py_res) {
1121                 /*
1122                  * The decode() invocation terminated unexpectedly. Have
1123                  * the back trace printed, and terminate the thread which
1124                  * executed the decode() method.
1125                  */
1126                 srd_dbg("%s: decode() terminated unrequested.", di->inst_id);
1127                 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
1128                 srd_dbg("%s: Thread done (!res, !want_term).", di->inst_id);
1129                 PyGILState_Release(gstate);
1130                 return NULL;
1131         }
1132
1133         /*
1134          * TODO: By design the decode() method is not supposed to terminate.
1135          * Nevertheless we have the thread joined, and srd backend calls to
1136          * decode() will re-start another thread transparently.
1137          */
1138         srd_dbg("%s: decode() terminated (req %d).", di->inst_id, wanted_term);
1139         Py_DecRef(py_res);
1140         PyErr_Clear();
1141
1142         PyGILState_Release(gstate);
1143
1144         srd_dbg("%s: Thread done (with res).", di->inst_id);
1145
1146         return NULL;
1147 }
1148
1149 /**
1150  * Decode a chunk of samples.
1151  *
1152  * The calls to this function must provide the samples that shall be
1153  * used by the protocol decoder
1154  *  - in the correct order ([...]5, 6, 4, 7, 8[...] is a bug),
1155  *  - starting from sample zero (2, 3, 4, 5, 6[...] is a bug),
1156  *  - consecutively, with no gaps (0, 1, 2, 4, 5[...] is a bug).
1157  *
1158  * The start- and end-sample numbers are absolute sample numbers (relative
1159  * to the start of the whole capture/file/stream), i.e. they are not relative
1160  * sample numbers within the chunk specified by 'inbuf' and 'inbuflen'.
1161  *
1162  * Correct example (4096 samples total, 4 chunks @ 1024 samples each):
1163  *   srd_inst_decode(di, 0,    1024, inbuf, 1024, 1);
1164  *   srd_inst_decode(di, 1024, 2048, inbuf, 1024, 1);
1165  *   srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
1166  *   srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
1167  *
1168  * The chunk size ('inbuflen') can be arbitrary and can differ between calls.
1169  *
1170  * Correct example (4096 samples total, 7 chunks @ various samples each):
1171  *   srd_inst_decode(di, 0,    1024, inbuf, 1024, 1);
1172  *   srd_inst_decode(di, 1024, 1124, inbuf,  100, 1);
1173  *   srd_inst_decode(di, 1124, 1424, inbuf,  300, 1);
1174  *   srd_inst_decode(di, 1424, 1643, inbuf,  219, 1);
1175  *   srd_inst_decode(di, 1643, 2048, inbuf,  405, 1);
1176  *   srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
1177  *   srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
1178  *
1179  * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but
1180  * the start- and end-samplenumbers are not absolute):
1181  *   srd_inst_decode(di, 0,    1024, inbuf, 1024, 1);
1182  *   srd_inst_decode(di, 0,    1024, inbuf, 1024, 1);
1183  *   srd_inst_decode(di, 0,    1024, inbuf, 1024, 1);
1184  *   srd_inst_decode(di, 0,    1024, inbuf, 1024, 1);
1185  *
1186  * @param di The decoder instance to call. Must not be NULL.
1187  * @param abs_start_samplenum The absolute starting sample number for the
1188  *              buffer's sample set, relative to the start of capture.
1189  * @param abs_end_samplenum The absolute ending sample number for the
1190  *              buffer's sample set, relative to the start of capture.
1191  * @param inbuf The buffer to decode. Must not be NULL.
1192  * @param inbuflen Length of the buffer. Must be > 0.
1193  * @param unitsize The number of bytes per sample. Must be > 0.
1194  *
1195  * @return SRD_OK upon success, a (negative) error code otherwise.
1196  *
1197  * @private
1198  */
1199 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
1200                 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
1201                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
1202 {
1203         /* Return an error upon unusable input. */
1204         if (!di) {
1205                 srd_dbg("empty decoder instance");
1206                 return SRD_ERR_ARG;
1207         }
1208         if (!inbuf) {
1209                 srd_dbg("NULL buffer pointer");
1210                 return SRD_ERR_ARG;
1211         }
1212         if (inbuflen == 0) {
1213                 srd_dbg("empty buffer");
1214                 return SRD_ERR_ARG;
1215         }
1216         if (unitsize == 0) {
1217                 srd_dbg("unitsize 0");
1218                 return SRD_ERR_ARG;
1219         }
1220
1221         if (abs_start_samplenum != di->abs_cur_samplenum ||
1222             abs_end_samplenum < abs_start_samplenum) {
1223                 srd_dbg("Incorrect sample numbers: start=%" PRIu64 ", cur=%"
1224                         PRIu64 ", end=%" PRIu64 ".", abs_start_samplenum,
1225                         di->abs_cur_samplenum, abs_end_samplenum);
1226                 return SRD_ERR_ARG;
1227         }
1228
1229         di->data_unitsize = unitsize;
1230
1231         srd_dbg("Decoding: abs start sample %" PRIu64 ", abs end sample %"
1232                 PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
1233                 "%d), instance %s.", abs_start_samplenum, abs_end_samplenum,
1234                 abs_end_samplenum - abs_start_samplenum, inbuflen, di->data_unitsize,
1235                 di->inst_id);
1236
1237         /* If this is the first call, start the worker thread. */
1238         if (!di->thread_handle) {
1239                 srd_dbg("No worker thread for this decoder stack "
1240                         "exists yet, creating one: %s.", di->inst_id);
1241                 di->thread_handle = g_thread_new(di->inst_id,
1242                                                  di_thread, di);
1243         }
1244
1245         /* Push the new sample chunk to the worker thread. */
1246         g_mutex_lock(&di->data_mutex);
1247         di->abs_start_samplenum = abs_start_samplenum;
1248         di->abs_end_samplenum = abs_end_samplenum;
1249         di->inbuf = inbuf;
1250         di->inbuflen = inbuflen;
1251         di->got_new_samples = TRUE;
1252         di->handled_all_samples = FALSE;
1253
1254         /* Signal the thread that we have new data. */
1255         g_cond_signal(&di->got_new_samples_cond);
1256         g_mutex_unlock(&di->data_mutex);
1257
1258         /* When all samples in this chunk were handled, return. */
1259         g_mutex_lock(&di->data_mutex);
1260         while (!di->handled_all_samples && !di->want_wait_terminate)
1261                 g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex);
1262         g_mutex_unlock(&di->data_mutex);
1263
1264         if (di->want_wait_terminate)
1265                 return SRD_ERR_TERM_REQ;
1266
1267         return SRD_OK;
1268 }
1269
1270 /**
1271  * Terminate current decoder work, prepare for re-use on new input data.
1272  *
1273  * Terminates all decoder operations in the specified decoder instance
1274  * and the instances stacked on top of it. Resets internal state such
1275  * that the previously constructed stack can process new input data that
1276  * is not related to previously processed input data. This avoids the
1277  * expensive and complex re-construction of decoder stacks.
1278  *
1279  * Callers are expected to follow up with start, metadata, and decode
1280  * calls like they would for newly constructed decoder stacks.
1281  *
1282  * @param di The decoder instance to call. Must not be NULL.
1283  *
1284  * @return SRD_OK upon success, a (negative) error code otherwise.
1285  *
1286  * @private
1287  */
1288 SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di)
1289 {
1290         PyGILState_STATE gstate;
1291         PyObject *py_ret;
1292         GSList *l;
1293         int ret;
1294
1295         if (!di)
1296                 return SRD_ERR_ARG;
1297
1298         /*
1299          * Request termination and wait for previously initiated
1300          * background operation to finish. Reset internal state, but
1301          * do not start releasing resources yet. This shall result in
1302          * decoders' state just like after creation. This block handles
1303          * the C language library side.
1304          */
1305         srd_dbg("Terminating instance %s", di->inst_id);
1306         srd_inst_join_decode_thread(di);
1307         srd_inst_reset_state(di);
1308
1309         /*
1310          * Have the Python side's .reset() method executed (if the PD
1311          * implements it). It's assumed that .reset() assigns variables
1312          * very much like __init__() used to do in the past. Thus memory
1313          * that was allocated in previous calls gets released by Python
1314          * as it's not referenced any longer.
1315          */
1316         gstate = PyGILState_Ensure();
1317         if (PyObject_HasAttrString(di->py_inst, "reset")) {
1318                 srd_dbg("Calling .reset() of instance %s", di->inst_id);
1319                 py_ret = PyObject_CallMethod(di->py_inst, "reset", NULL);
1320                 Py_XDECREF(py_ret);
1321         }
1322         PyGILState_Release(gstate);
1323
1324         /* Pass the "restart" request to all stacked decoders. */
1325         for (l = di->next_di; l; l = l->next) {
1326                 ret = srd_inst_terminate_reset(l->data);
1327                 if (ret != SRD_OK)
1328                         return ret;
1329         }
1330
1331         return SRD_OK;
1332 }
1333
1334 /** @private */
1335 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
1336 {
1337         GSList *l;
1338         struct srd_pd_output *pdo;
1339         PyGILState_STATE gstate;
1340
1341         srd_dbg("Freeing instance %s.", di->inst_id);
1342
1343         srd_inst_join_decode_thread(di);
1344
1345         srd_inst_reset_state(di);
1346
1347         gstate = PyGILState_Ensure();
1348         Py_DecRef(di->py_inst);
1349         PyGILState_Release(gstate);
1350
1351         g_free(di->inst_id);
1352         g_free(di->dec_channelmap);
1353         g_free(di->channel_samples);
1354         g_slist_free(di->next_di);
1355         for (l = di->pd_output; l; l = l->next) {
1356                 pdo = l->data;
1357                 g_free(pdo->proto_id);
1358                 g_free(pdo);
1359         }
1360         g_slist_free(di->pd_output);
1361         g_free(di);
1362 }
1363
1364 /** @private */
1365 SRD_PRIV void srd_inst_free_all(struct srd_session *sess)
1366 {
1367         if (!sess)
1368                 return;
1369
1370         g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free);
1371 }
1372
1373 /** @} */