type_decoder.c

   1 /*
   2  * This file is part of the libsigrokdecode project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  22 #include "libsigrokdecode.h"
  23 #include <inttypes.h>
  24
  25 typedef struct {
  26         PyObject_HEAD
  27 } srd_Decoder;
  28
  29 /* This is only used for nicer srd_dbg() output.
  30  */
  31 static const char *output_type_name(unsigned int idx)
  32 {
  33         static const char names[][16] = {
  34                 "OUTPUT_ANN",
  35                 "OUTPUT_PYTHON",
  36                 "OUTPUT_BINARY",
  37                 "OUTPUT_META",
  38                 "(invalid)"
  39         };
  40         return names[MIN(idx, G_N_ELEMENTS(names) - 1)];
  41 }
  42
  43 static void release_annotation(struct srd_proto_data_annotation *pda)
  44 {
  45         if (!pda)
  46                 return;
  47         if (pda->ann_text)
  48                 g_strfreev(pda->ann_text);
  49         g_free(pda);
  50 }
  51
  52 static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
  53                 struct srd_proto_data *pdata)
  54 {
  55         PyObject *py_tmp;
  56         struct srd_pd_output *pdo;
  57         struct srd_proto_data_annotation *pda;
  58         int ann_class;
  59         char **ann_text;
  60         PyGILState_STATE gstate;
  61
  62         gstate = PyGILState_Ensure();
  63
  64         /* Should be a list of [annotation class, [string, ...]]. */
  65         if (!PyList_Check(obj)) {
  66                 srd_err("Protocol decoder %s submitted an annotation that"
  67                         " is not a list", di->decoder->name);
  68                 goto err;
  69         }
  70
  71         /* Should have 2 elements. */
  72         if (PyList_Size(obj) != 2) {
  73                 srd_err("Protocol decoder %s submitted annotation list with "
  74                         "%zd elements instead of 2", di->decoder->name,
  75                         PyList_Size(obj));
  76                 goto err;
  77         }
  78
  79         /*
  80          * The first element should be an integer matching a previously
  81          * registered annotation class.
  82          */
  83         py_tmp = PyList_GetItem(obj, 0);
  84         if (!PyLong_Check(py_tmp)) {
  85                 srd_err("Protocol decoder %s submitted annotation list, but "
  86                         "first element was not an integer.", di->decoder->name);
  87                 goto err;
  88         }
  89         ann_class = PyLong_AsLong(py_tmp);
  90         if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) {
  91                 srd_err("Protocol decoder %s submitted data to unregistered "
  92                         "annotation class %d.", di->decoder->name, ann_class);
  93                 goto err;
  94         }
  95
  96         /* Second element must be a list. */
  97         py_tmp = PyList_GetItem(obj, 1);
  98         if (!PyList_Check(py_tmp)) {
  99                 srd_err("Protocol decoder %s submitted annotation list, but "
 100                         "second element was not a list.", di->decoder->name);
 101                 goto err;
 102         }
 103         if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
 104                 srd_err("Protocol decoder %s submitted annotation list, but "
 105                         "second element was malformed.", di->decoder->name);
 106                 goto err;
 107         }
 108
 109         pda = g_malloc(sizeof(struct srd_proto_data_annotation));
 110         pda->ann_class = ann_class;
 111         pda->ann_text = ann_text;
 112         pdata->data = pda;
 113
 114         PyGILState_Release(gstate);
 115
 116         return SRD_OK;
 117
 118 err:
 119         PyGILState_Release(gstate);
 120
 121         return SRD_ERR_PYTHON;
 122 }
 123
 124 static void release_binary(struct srd_proto_data_binary *pdb)
 125 {
 126         if (!pdb)
 127                 return;
 128         if (pdb->data)
 129                 g_free((void *)pdb->data);
 130         g_free(pdb);
 131 }
 132
 133 static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
 134                 struct srd_proto_data *pdata)
 135 {
 136         struct srd_proto_data_binary *pdb;
 137         PyObject *py_tmp;
 138         Py_ssize_t size;
 139         int bin_class;
 140         char *class_name, *buf;
 141         PyGILState_STATE gstate;
 142
 143         gstate = PyGILState_Ensure();
 144
 145         /* Should be a list of [binary class, bytes]. */
 146         if (!PyList_Check(obj)) {
 147                 srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.",
 148                         di->decoder->name);
 149                 goto err;
 150         }
 151
 152         /* Should have 2 elements. */
 153         if (PyList_Size(obj) != 2) {
 154                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list "
 155                                 "with %zd elements instead of 2", di->decoder->name,
 156                                 PyList_Size(obj));
 157                 goto err;
 158         }
 159
 160         /* The first element should be an integer. */
 161         py_tmp = PyList_GetItem(obj, 0);
 162         if (!PyLong_Check(py_tmp)) {
 163                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
 164                         "but first element was not an integer.", di->decoder->name);
 165                 goto err;
 166         }
 167         bin_class = PyLong_AsLong(py_tmp);
 168         if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
 169                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
 170                         "unregistered binary class %d.", di->decoder->name, bin_class);
 171                 goto err;
 172         }
 173
 174         /* Second element should be bytes. */
 175         py_tmp = PyList_GetItem(obj, 1);
 176         if (!PyBytes_Check(py_tmp)) {
 177                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, "
 178                         "but second element was not bytes.", di->decoder->name);
 179                 goto err;
 180         }
 181
 182         /* Consider an empty set of bytes a bug. */
 183         if (PyBytes_Size(py_tmp) == 0) {
 184                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
 185                                 "with empty data set.", di->decoder->name);
 186                 goto err;
 187         }
 188
 189         pdb = g_malloc(sizeof(struct srd_proto_data_binary));
 190         if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
 191                 goto err;
 192
 193         PyGILState_Release(gstate);
 194
 195         pdb->bin_class = bin_class;
 196         pdb->size = size;
 197         if (!(pdb->data = g_try_malloc(pdb->size)))
 198                 return SRD_ERR_MALLOC;
 199         memcpy((void *)pdb->data, (const void *)buf, pdb->size);
 200         pdata->data = pdb;
 201
 202         return SRD_OK;
 203
 204 err:
 205         PyGILState_Release(gstate);
 206
 207         return SRD_ERR_PYTHON;
 208 }
 209
 210 static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
 211 {
 212         long long intvalue;
 213         double dvalue;
 214         PyGILState_STATE gstate;
 215
 216         gstate = PyGILState_Ensure();
 217
 218         if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) {
 219                 if (!PyLong_Check(obj)) {
 220                         PyErr_Format(PyExc_TypeError, "This output was registered "
 221                                         "as 'int', but something else was passed.");
 222                         goto err;
 223                 }
 224                 intvalue = PyLong_AsLongLong(obj);
 225                 if (PyErr_Occurred())
 226                         goto err;
 227                 pdata->data = g_variant_new_int64(intvalue);
 228         } else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) {
 229                 if (!PyFloat_Check(obj)) {
 230                         PyErr_Format(PyExc_TypeError, "This output was registered "
 231                                         "as 'float', but something else was passed.");
 232                         goto err;
 233                 }
 234                 dvalue = PyFloat_AsDouble(obj);
 235                 if (PyErr_Occurred())
 236                         goto err;
 237                 pdata->data = g_variant_new_double(dvalue);
 238         }
 239
 240         PyGILState_Release(gstate);
 241
 242         return SRD_OK;
 243
 244 err:
 245         PyGILState_Release(gstate);
 246
 247         return SRD_ERR_PYTHON;
 248 }
 249
 250 static void release_meta(GVariant *gvar)
 251 {
 252         if (!gvar)
 253                 return;
 254         g_variant_unref(gvar);
 255 }
 256
 257 static PyObject *Decoder_put(PyObject *self, PyObject *args)
 258 {
 259         GSList *l;
 260         PyObject *py_data, *py_res;
 261         struct srd_decoder_inst *di, *next_di;
 262         struct srd_pd_output *pdo;
 263         struct srd_proto_data pdata;
 264         uint64_t start_sample, end_sample;
 265         int output_id;
 266         struct srd_pd_callback *cb;
 267         PyGILState_STATE gstate;
 268
 269         py_data = NULL;
 270
 271         gstate = PyGILState_Ensure();
 272
 273         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 274                 /* Shouldn't happen. */
 275                 srd_dbg("put(): self instance not found.");
 276                 goto err;
 277         }
 278
 279         if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
 280                 &output_id, &py_data)) {
 281                 /*
 282                  * This throws an exception, but by returning NULL here we let
 283                  * Python raise it. This results in a much better trace in
 284                  * controller.c on the decode() method call.
 285                  */
 286                 goto err;
 287         }
 288
 289         if (!(l = g_slist_nth(di->pd_output, output_id))) {
 290                 srd_err("Protocol decoder %s submitted invalid output ID %d.",
 291                         di->decoder->name, output_id);
 292                 goto err;
 293         }
 294         pdo = l->data;
 295
 296         srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
 297                  di->inst_id, start_sample, end_sample,
 298                  output_type_name(pdo->output_type), output_id);
 299
 300         pdata.start_sample = start_sample;
 301         pdata.end_sample = end_sample;
 302         pdata.pdo = pdo;
 303         pdata.data = NULL;
 304
 305         switch (pdo->output_type) {
 306         case SRD_OUTPUT_ANN:
 307                 /* Annotations are only fed to callbacks. */
 308                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 309                         /* Convert from PyDict to srd_proto_data_annotation. */
 310                         if (convert_annotation(di, py_data, &pdata) != SRD_OK) {
 311                                 /* An error was already logged. */
 312                                 break;
 313                         }
 314                         Py_BEGIN_ALLOW_THREADS
 315                         cb->cb(&pdata, cb->cb_data);
 316                         Py_END_ALLOW_THREADS
 317                         release_annotation(pdata.data);
 318                 }
 319                 break;
 320         case SRD_OUTPUT_PYTHON:
 321                 for (l = di->next_di; l; l = l->next) {
 322                         next_di = l->data;
 323                         srd_spew("Sending %" PRIu64 "-%" PRIu64 " to instance %s",
 324                                  start_sample, end_sample, next_di->inst_id);
 325                         if (!(py_res = PyObject_CallMethod(
 326                                 next_di->py_inst, "decode", "KKO", start_sample,
 327                                 end_sample, py_data))) {
 328                                 srd_exception_catch("Calling %s decode() failed",
 329                                                         next_di->inst_id);
 330                         }
 331                         Py_XDECREF(py_res);
 332                 }
 333                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 334                         /* Frontends aren't really supposed to get Python
 335                          * callbacks, but it's useful for testing. */
 336                         pdata.data = py_data;
 337                         cb->cb(&pdata, cb->cb_data);
 338                 }
 339                 break;
 340         case SRD_OUTPUT_BINARY:
 341                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 342                         /* Convert from PyDict to srd_proto_data_binary. */
 343                         if (convert_binary(di, py_data, &pdata) != SRD_OK) {
 344                                 /* An error was already logged. */
 345                                 break;
 346                         }
 347                         Py_BEGIN_ALLOW_THREADS
 348                         cb->cb(&pdata, cb->cb_data);
 349                         Py_END_ALLOW_THREADS
 350                         release_binary(pdata.data);
 351                 }
 352                 break;
 353         case SRD_OUTPUT_META:
 354                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 355                         /* Annotations need converting from PyObject. */
 356                         if (convert_meta(&pdata, py_data) != SRD_OK) {
 357                                 /* An exception was already set up. */
 358                                 break;
 359                         }
 360                         Py_BEGIN_ALLOW_THREADS
 361                         cb->cb(&pdata, cb->cb_data);
 362                         Py_END_ALLOW_THREADS
 363                         release_meta(pdata.data);
 364                 }
 365                 break;
 366         default:
 367                 srd_err("Protocol decoder %s submitted invalid output type %d.",
 368                         di->decoder->name, pdo->output_type);
 369                 break;
 370         }
 371
 372         PyGILState_Release(gstate);
 373
 374         Py_RETURN_NONE;
 375
 376 err:
 377         PyGILState_Release(gstate);
 378
 379         return NULL;
 380 }
 381
 382 static PyObject *Decoder_register(PyObject *self, PyObject *args,
 383                 PyObject *kwargs)
 384 {
 385         struct srd_decoder_inst *di;
 386         struct srd_pd_output *pdo;
 387         PyObject *py_new_output_id;
 388         PyTypeObject *meta_type_py;
 389         const GVariantType *meta_type_gv;
 390         int output_type;
 391         char *proto_id, *meta_name, *meta_descr;
 392         char *keywords[] = {"output_type", "proto_id", "meta", NULL};
 393         PyGILState_STATE gstate;
 394         gboolean is_meta;
 395         GSList *l;
 396         struct srd_pd_output *cmp;
 397
 398         gstate = PyGILState_Ensure();
 399
 400         meta_type_py = NULL;
 401         meta_type_gv = NULL;
 402         meta_name = meta_descr = NULL;
 403
 404         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 405                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
 406                 goto err;
 407         }
 408
 409         /* Default to instance id, which defaults to class id. */
 410         proto_id = di->inst_id;
 411         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
 412                         &output_type, &proto_id,
 413                         &meta_type_py, &meta_name, &meta_descr)) {
 414                 /* Let Python raise this exception. */
 415                 goto err;
 416         }
 417
 418         /* Check if the meta value's type is supported. */
 419         is_meta = output_type == SRD_OUTPUT_META;
 420         if (is_meta) {
 421                 if (meta_type_py == &PyLong_Type)
 422                         meta_type_gv = G_VARIANT_TYPE_INT64;
 423                 else if (meta_type_py == &PyFloat_Type)
 424                         meta_type_gv = G_VARIANT_TYPE_DOUBLE;
 425                 else {
 426                         PyErr_Format(PyExc_TypeError, "Unsupported type.");
 427                         goto err;
 428                 }
 429         }
 430
 431         pdo = NULL;
 432         for (l = di->pd_output; l; l = l->next) {
 433                 cmp = l->data;
 434                 if (cmp->output_type != output_type)
 435                         continue;
 436                 if (strcmp(cmp->proto_id, proto_id) != 0)
 437                         continue;
 438                 if (is_meta && cmp->meta_type != meta_type_gv)
 439                         continue;
 440                 if (is_meta && strcmp(cmp->meta_name, meta_name) != 0)
 441                         continue;
 442                 if (is_meta && strcmp(cmp->meta_descr, meta_descr) != 0)
 443                         continue;
 444                 pdo = cmp;
 445                 break;
 446         }
 447         if (pdo) {
 448                 py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
 449                 PyGILState_Release(gstate);
 450                 return py_new_output_id;
 451         }
 452
 453         srd_dbg("Instance %s creating new output type %d for %s.",
 454                 di->inst_id, output_type, proto_id);
 455
 456         pdo = g_malloc(sizeof(struct srd_pd_output));
 457
 458         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
 459         pdo->pdo_id = g_slist_length(di->pd_output);
 460         pdo->output_type = output_type;
 461         pdo->di = di;
 462         pdo->proto_id = g_strdup(proto_id);
 463
 464         if (output_type == SRD_OUTPUT_META) {
 465                 pdo->meta_type = meta_type_gv;
 466                 pdo->meta_name = g_strdup(meta_name);
 467                 pdo->meta_descr = g_strdup(meta_descr);
 468         }
 469
 470         di->pd_output = g_slist_append(di->pd_output, pdo);
 471         py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
 472
 473         PyGILState_Release(gstate);
 474
 475         return py_new_output_id;
 476
 477 err:
 478         PyGILState_Release(gstate);
 479
 480         return NULL;
 481 }
 482
 483 static int get_term_type(const char *v)
 484 {
 485         switch (v[0]) {
 486         case 'h':
 487                 return SRD_TERM_HIGH;
 488         case 'l':
 489                 return SRD_TERM_LOW;
 490         case 'r':
 491                 return SRD_TERM_RISING_EDGE;
 492         case 'f':
 493                 return SRD_TERM_FALLING_EDGE;
 494         case 'e':
 495                 return SRD_TERM_EITHER_EDGE;
 496         case 'n':
 497                 return SRD_TERM_NO_EDGE;
 498         }
 499
 500         return -1;
 501 }
 502
 503 /**
 504  * Get the pin values at the current sample number.
 505  *
 506  * @param di The decoder instance to use. Must not be NULL.
 507  *           The number of channels must be >= 1.
 508  *
 509  * @return A newly allocated PyTuple containing the pin values at the
 510  *         current sample number.
 511  */
 512 static PyObject *get_current_pinvalues(const struct srd_decoder_inst *di)
 513 {
 514         int i;
 515         uint8_t sample;
 516         const uint8_t *sample_pos;
 517         int byte_offset, bit_offset;
 518         PyObject *py_pinvalues;
 519         PyGILState_STATE gstate;
 520
 521         gstate = PyGILState_Ensure();
 522
 523         if (!di) {
 524                 srd_err("Invalid decoder instance.");
 525                 PyGILState_Release(gstate);
 526                 return NULL;
 527         }
 528
 529         py_pinvalues = PyTuple_New(di->dec_num_channels);
 530
 531         for (i = 0; i < di->dec_num_channels; i++) {
 532                 /* A channelmap value of -1 means "unused optional channel". */
 533                 if (di->dec_channelmap[i] == -1) {
 534                         /* Value of unused channel is 0xff, instead of 0 or 1. */
 535                         PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(0xff));
 536                 } else {
 537                         sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
 538                         byte_offset = di->dec_channelmap[i] / 8;
 539                         bit_offset = di->dec_channelmap[i] % 8;
 540                         sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
 541                         PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(sample));
 542                 }
 543         }
 544
 545         PyGILState_Release(gstate);
 546
 547         return py_pinvalues;
 548 }
 549
 550 /**
 551  * Create a list of terms in the specified condition.
 552  *
 553  * If there are no terms in the condition, 'term_list' will be NULL.
 554  *
 555  * @param py_dict A Python dict containing terms. Must not be NULL.
 556  * @param term_list Pointer to a GSList which will be set to the newly
 557  *                  created list of terms. Must not be NULL.
 558  *
 559  * @return SRD_OK upon success, a negative error code otherwise.
 560  */
 561 static int create_term_list(PyObject *py_dict, GSList **term_list)
 562 {
 563         Py_ssize_t pos = 0;
 564         PyObject *py_key, *py_value;
 565         struct srd_term *term;
 566         uint64_t num_samples_to_skip;
 567         char *term_str;
 568         PyGILState_STATE gstate;
 569
 570         if (!py_dict || !term_list)
 571                 return SRD_ERR_ARG;
 572
 573         /* "Create" an empty GSList of terms. */
 574         *term_list = NULL;
 575
 576         gstate = PyGILState_Ensure();
 577
 578         /* Iterate over all items in the current dict. */
 579         while (PyDict_Next(py_dict, &pos, &py_key, &py_value)) {
 580                 /* Check whether the current key is a string or a number. */
 581                 if (PyLong_Check(py_key)) {
 582                         /* The key is a number. */
 583                         /* TODO: Check if the number is a valid channel. */
 584                         /* Get the value string. */
 585                         if ((py_pydictitem_as_str(py_dict, py_key, &term_str)) != SRD_OK) {
 586                                 srd_err("Failed to get the value.");
 587                                 goto err;
 588                         }
 589                         term = g_malloc0(sizeof(struct srd_term));
 590                         term->type = get_term_type(term_str);
 591                         term->channel = PyLong_AsLong(py_key);
 592                         g_free(term_str);
 593                 } else if (PyUnicode_Check(py_key)) {
 594                         /* The key is a string. */
 595                         /* TODO: Check if it's "skip". */
 596                         if ((py_pydictitem_as_long(py_dict, py_key, &num_samples_to_skip)) != SRD_OK) {
 597                                 srd_err("Failed to get number of samples to skip.");
 598                                 goto err;
 599                         }
 600                         term = g_malloc0(sizeof(struct srd_term));
 601                         term->type = SRD_TERM_SKIP;
 602                         term->num_samples_to_skip = num_samples_to_skip;
 603                         term->num_samples_already_skipped = 0;
 604                 } else {
 605                         srd_err("Term key is neither a string nor a number.");
 606                         goto err;
 607                 }
 608
 609                 /* Add the term to the list of terms. */
 610                 *term_list = g_slist_append(*term_list, term);
 611         }
 612
 613         PyGILState_Release(gstate);
 614
 615         return SRD_OK;
 616
 617 err:
 618         PyGILState_Release(gstate);
 619
 620         return SRD_ERR;
 621 }
 622
 623 /**
 624  * Replace the current condition list with the new one.
 625  *
 626  * @param self TODO. Must not be NULL.
 627  * @param args TODO. Must not be NULL.
 628  *
 629  * @retval SRD_OK The new condition list was set successfully.
 630  * @retval SRD_ERR There was an error setting the new condition list.
 631  *                 The contents of di->condition_list are undefined.
 632  * @retval 9999 TODO.
 633  */
 634 static int set_new_condition_list(PyObject *self, PyObject *args)
 635 {
 636         struct srd_decoder_inst *di;
 637         GSList *term_list;
 638         PyObject *py_conditionlist, *py_conds, *py_dict;
 639         int i, num_conditions, ret;
 640         PyGILState_STATE gstate;
 641
 642         if (!self || !args)
 643                 return SRD_ERR_ARG;
 644
 645         gstate = PyGILState_Ensure();
 646
 647         /* Get the decoder instance. */
 648         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 649                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
 650                 goto err;
 651         }
 652
 653         /*
 654          * Return an error condition from .wait() when termination is
 655          * requested, such that decode() will terminate.
 656          */
 657         if (di->want_wait_terminate) {
 658                 srd_dbg("%s: %s: Skip (want_term).", di->inst_id, __func__);
 659                 goto err;
 660         }
 661
 662         /*
 663          * Parse the argument of self.wait() into 'py_conds', and check
 664          * the data type. The argument is optional, None is assumed in
 665          * its absence. None or an empty dict or an empty list mean that
 666          * there is no condition, and the next available sample shall
 667          * get returned to the caller.
 668          */
 669         py_conds = Py_None;
 670         if (!PyArg_ParseTuple(args, "|O", &py_conds)) {
 671                 /* Let Python raise this exception. */
 672                 goto err;
 673         }
 674         if (py_conds == Py_None) {
 675                 /* 'py_conds' is None. */
 676                 goto ret_9999;
 677         } else if (PyList_Check(py_conds)) {
 678                 /* 'py_conds' is a list. */
 679                 py_conditionlist = py_conds;
 680                 num_conditions = PyList_Size(py_conditionlist);
 681                 if (num_conditions == 0)
 682                         goto ret_9999; /* The PD invoked self.wait([]). */
 683                 Py_IncRef(py_conditionlist);
 684         } else if (PyDict_Check(py_conds)) {
 685                 /* 'py_conds' is a dict. */
 686                 if (PyDict_Size(py_conds) == 0)
 687                         goto ret_9999; /* The PD invoked self.wait({}). */
 688                 /* Make a list and put the dict in there for convenience. */
 689                 py_conditionlist = PyList_New(1);
 690                 Py_IncRef(py_conds);
 691                 PyList_SetItem(py_conditionlist, 0, py_conds);
 692                 num_conditions = 1;
 693         } else {
 694                 srd_err("Condition list is neither a list nor a dict.");
 695                 goto err;
 696         }
 697
 698         /* Free the old condition list. */
 699         condition_list_free(di);
 700
 701         ret = SRD_OK;
 702
 703         /* Iterate over the conditions, set di->condition_list accordingly. */
 704         for (i = 0; i < num_conditions; i++) {
 705                 /* Get a condition (dict) from the condition list. */
 706                 py_dict = PyList_GetItem(py_conditionlist, i);
 707                 if (!PyDict_Check(py_dict)) {
 708                         srd_err("Condition is not a dict.");
 709                         ret = SRD_ERR;
 710                         break;
 711                 }
 712
 713                 /* Create the list of terms in this condition. */
 714                 if ((ret = create_term_list(py_dict, &term_list)) < 0)
 715                         break;
 716
 717                 /* Add the new condition to the PD instance's condition list. */
 718                 di->condition_list = g_slist_append(di->condition_list, term_list);
 719         }
 720
 721         Py_DecRef(py_conditionlist);
 722
 723         PyGILState_Release(gstate);
 724
 725         return ret;
 726
 727 err:
 728         PyGILState_Release(gstate);
 729
 730         return SRD_ERR;
 731
 732 ret_9999:
 733         PyGILState_Release(gstate);
 734
 735         return 9999;
 736 }
 737
 738 /**
 739  * Create a SKIP condition list for condition-less .wait() calls.
 740  *
 741  * @param di Decoder instance.
 742  * @param count Number of samples to skip.
 743  *
 744  * @retval SRD_OK The new condition list was set successfully.
 745  * @retval SRD_ERR There was an error setting the new condition list.
 746  *                 The contents of di->condition_list are undefined.
 747  *
 748  * This routine is a reduced and specialized version of the @ref
 749  * set_new_condition_list() and @ref create_term_list() routines which
 750  * gets invoked when .wait() was called without specifications for
 751  * conditions. This minor duplication of the SKIP term list creation
 752  * simplifies the logic and avoids the creation of expensive Python
 753  * objects with "constant" values which the caller did not pass in the
 754  * first place. It results in maximum sharing of match handling code
 755  * paths.
 756  */
 757 static int set_skip_condition(struct srd_decoder_inst *di, uint64_t count)
 758 {
 759         struct srd_term *term;
 760         GSList *term_list;
 761
 762         condition_list_free(di);
 763         term = g_malloc0(sizeof(*term));
 764         term->type = SRD_TERM_SKIP;
 765         term->num_samples_to_skip = count;
 766         term->num_samples_already_skipped = 0;
 767         term_list = g_slist_append(NULL, term);
 768         di->condition_list = g_slist_append(di->condition_list, term_list);
 769
 770         return SRD_OK;
 771 }
 772
 773 static PyObject *Decoder_wait(PyObject *self, PyObject *args)
 774 {
 775         int ret;
 776         uint64_t skip_count;
 777         unsigned int i;
 778         gboolean found_match;
 779         struct srd_decoder_inst *di;
 780         PyObject *py_pinvalues, *py_matched;
 781         PyGILState_STATE gstate;
 782
 783         if (!self || !args)
 784                 return NULL;
 785
 786         gstate = PyGILState_Ensure();
 787
 788         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 789                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
 790                 PyGILState_Release(gstate);
 791                 Py_RETURN_NONE;
 792         }
 793
 794         ret = set_new_condition_list(self, args);
 795         if (ret < 0) {
 796                 srd_dbg("%s: %s: Aborting wait().", di->inst_id, __func__);
 797                 goto err;
 798         }
 799         if (ret == 9999) {
 800                 /*
 801                  * Empty condition list, automatic match. Arrange for the
 802                  * execution of regular match handling code paths such that
 803                  * the next available sample is returned to the caller.
 804                  * Make sure to skip one sample when "anywhere within the
 805                  * stream", yet make sure to not skip sample number 0.
 806                  */
 807                 if (di->abs_cur_samplenum)
 808                         skip_count = 1;
 809                 else if (!di->condition_list)
 810                         skip_count = 0;
 811                 else
 812                         skip_count = 1;
 813                 ret = set_skip_condition(di, skip_count);
 814                 if (ret < 0) {
 815                         srd_dbg("%s: %s: Cannot setup condition-less wait().",
 816                                 di->inst_id, __func__);
 817                         goto err;
 818                 }
 819         }
 820
 821         while (1) {
 822
 823                 Py_BEGIN_ALLOW_THREADS
 824
 825                 /* Wait for new samples to process, or termination request. */
 826                 g_mutex_lock(&di->data_mutex);
 827                 while (!di->got_new_samples && !di->want_wait_terminate)
 828                         g_cond_wait(&di->got_new_samples_cond, &di->data_mutex);
 829
 830                 /*
 831                  * Check whether any of the current condition(s) match.
 832                  * Arrange for termination requests to take a code path which
 833                  * won't find new samples to process, pretends to have processed
 834                  * previously stored samples, and returns to the main thread,
 835                  * while the termination request still gets signalled.
 836                  */
 837                 found_match = FALSE;
 838                 ret = process_samples_until_condition_match(di, &found_match);
 839
 840                 Py_END_ALLOW_THREADS
 841
 842                 /* If there's a match, set self.samplenum etc. and return. */
 843                 if (found_match) {
 844                         /* Set self.samplenum to the (absolute) sample number that matched. */
 845                         PyObject_SetAttrString(di->py_inst, "samplenum",
 846                                 PyLong_FromLong(di->abs_cur_samplenum));
 847
 848                         if (di->match_array && di->match_array->len > 0) {
 849                                 py_matched = PyTuple_New(di->match_array->len);
 850                                 for (i = 0; i < di->match_array->len; i++)
 851                                         PyTuple_SetItem(py_matched, i, PyBool_FromLong(di->match_array->data[i]));
 852                                 PyObject_SetAttrString(di->py_inst, "matched", py_matched);
 853                                 match_array_free(di);
 854                         } else {
 855                                 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
 856                         }
 857
 858                         py_pinvalues = get_current_pinvalues(di);
 859
 860                         g_mutex_unlock(&di->data_mutex);
 861
 862                         PyGILState_Release(gstate);
 863
 864                         return py_pinvalues;
 865                 }
 866
 867                 /* No match, reset state for the next chunk. */
 868                 di->got_new_samples = FALSE;
 869                 di->handled_all_samples = TRUE;
 870                 di->abs_start_samplenum = 0;
 871                 di->abs_end_samplenum = 0;
 872                 di->inbuf = NULL;
 873                 di->inbuflen = 0;
 874
 875                 /* Signal the main thread that we handled all samples. */
 876                 g_cond_signal(&di->handled_all_samples_cond);
 877
 878                 /*
 879                  * When termination of wait() and decode() was requested,
 880                  * then exit the loop after releasing the mutex.
 881                  */
 882                 if (di->want_wait_terminate) {
 883                         srd_dbg("%s: %s: Will return from wait().",
 884                                 di->inst_id, __func__);
 885                         g_mutex_unlock(&di->data_mutex);
 886                         goto err;
 887                 }
 888
 889                 g_mutex_unlock(&di->data_mutex);
 890         }
 891
 892         PyGILState_Release(gstate);
 893
 894         Py_RETURN_NONE;
 895
 896 err:
 897         PyGILState_Release(gstate);
 898
 899         return NULL;
 900 }
 901
 902 /**
 903  * Return whether the specified channel was supplied to the decoder.
 904  *
 905  * @param self TODO. Must not be NULL.
 906  * @param args TODO. Must not be NULL.
 907  *
 908  * @retval Py_True The channel has been supplied by the frontend.
 909  * @retval Py_False The channel has been supplied by the frontend.
 910  * @retval NULL An error occurred.
 911  */
 912 static PyObject *Decoder_has_channel(PyObject *self, PyObject *args)
 913 {
 914         int idx, count;
 915         struct srd_decoder_inst *di;
 916         PyGILState_STATE gstate;
 917
 918         if (!self || !args)
 919                 return NULL;
 920
 921         gstate = PyGILState_Ensure();
 922
 923         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 924                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
 925                 goto err;
 926         }
 927
 928         /*
 929          * Get the integer argument of self.has_channel(). Check for
 930          * the range of supported PD input channel numbers.
 931          */
 932         if (!PyArg_ParseTuple(args, "i", &idx)) {
 933                 /* Let Python raise this exception. */
 934                 goto err;
 935         }
 936
 937         count = g_slist_length(di->decoder->channels) +
 938                 g_slist_length(di->decoder->opt_channels);
 939         if (idx < 0 || idx >= count) {
 940                 srd_err("Invalid index %d, PD channel count %d.", idx, count);
 941                 PyErr_SetString(PyExc_IndexError, "invalid channel index");
 942                 goto err;
 943         }
 944
 945         PyGILState_Release(gstate);
 946
 947         return (di->dec_channelmap[idx] == -1) ? Py_False : Py_True;
 948
 949 err:
 950         PyGILState_Release(gstate);
 951
 952         return NULL;
 953 }
 954
 955 static PyMethodDef Decoder_methods[] = {
 956         {"put", Decoder_put, METH_VARARGS,
 957          "Accepts a dictionary with the following keys: startsample, endsample, data"},
 958         {"register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
 959                         "Register a new output stream"},
 960         {"wait", Decoder_wait, METH_VARARGS,
 961                         "Wait for one or more conditions to occur"},
 962         {"has_channel", Decoder_has_channel, METH_VARARGS,
 963                         "Report whether a channel was supplied"},
 964         {NULL, NULL, 0, NULL}
 965 };
 966
 967 /**
 968  * Create the sigrokdecode.Decoder type.
 969  *
 970  * @return The new type object.
 971  *
 972  * @private
 973  */
 974 SRD_PRIV PyObject *srd_Decoder_type_new(void)
 975 {
 976         PyType_Spec spec;
 977         PyType_Slot slots[] = {
 978                 { Py_tp_doc, "sigrok Decoder base class" },
 979                 { Py_tp_methods, Decoder_methods },
 980                 { Py_tp_new, (void *)&PyType_GenericNew },
 981                 { 0, NULL }
 982         };
 983         PyObject *py_obj;
 984         PyGILState_STATE gstate;
 985
 986         gstate = PyGILState_Ensure();
 987
 988         spec.name = "sigrokdecode.Decoder";
 989         spec.basicsize = sizeof(srd_Decoder);
 990         spec.itemsize = 0;
 991         spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE;
 992         spec.slots = slots;
 993
 994         py_obj = PyType_FromSpec(&spec);
 995
 996         PyGILState_Release(gstate);
 997
 998         return py_obj;
 999 }