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