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