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