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