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 "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  21 #include "libsigrokdecode.h"
  22 #include "config.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 static const char *OUTPUT_TYPES[] = {
  31         "OUTPUT_ANN",
  32         "OUTPUT_PYTHON",
  33         "OUTPUT_BINARY",
  34         "OUTPUT_META",
  35 };
  36
  37 static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj,
  38                 struct srd_proto_data *pdata)
  39 {
  40         PyObject *py_tmp;
  41         struct srd_pd_output *pdo;
  42         struct srd_proto_data_annotation *pda;
  43         int ann_format;
  44         char **ann_text;
  45
  46         /* Should be a list of [annotation format, [string, ...]]. */
  47         if (!PyList_Check(obj) && !PyTuple_Check(obj)) {
  48                 srd_err("Protocol decoder %s submitted %s instead of list.",
  49                         di->decoder->name, obj->ob_type->tp_name);
  50                 return SRD_ERR_PYTHON;
  51         }
  52
  53         /* Should have 2 elements. */
  54         if (PyList_Size(obj) != 2) {
  55                 srd_err("Protocol decoder %s submitted annotation list with "
  56                         "%d elements instead of 2", di->decoder->name,
  57                         PyList_Size(obj));
  58                 return SRD_ERR_PYTHON;
  59         }
  60
  61         /*
  62          * The first element should be an integer matching a previously
  63          * registered annotation format.
  64          */
  65         py_tmp = PyList_GetItem(obj, 0);
  66         if (!PyLong_Check(py_tmp)) {
  67                 srd_err("Protocol decoder %s submitted annotation list, but "
  68                         "first element was not an integer.", di->decoder->name);
  69                 return SRD_ERR_PYTHON;
  70         }
  71         ann_format = PyLong_AsLong(py_tmp);
  72         if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_format))) {
  73                 srd_err("Protocol decoder %s submitted data to unregistered "
  74                         "annotation format %d.", di->decoder->name, ann_format);
  75                 return SRD_ERR_PYTHON;
  76         }
  77
  78         /* Second element must be a list. */
  79         py_tmp = PyList_GetItem(obj, 1);
  80         if (!PyList_Check(py_tmp)) {
  81                 srd_err("Protocol decoder %s submitted annotation list, but "
  82                         "second element was not a list.", di->decoder->name);
  83                 return SRD_ERR_PYTHON;
  84         }
  85         if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) {
  86                 srd_err("Protocol decoder %s submitted annotation list, but "
  87                         "second element was malformed.", di->decoder->name);
  88                 return SRD_ERR_PYTHON;
  89         }
  90
  91         if (!(pda = g_try_malloc(sizeof(struct srd_proto_data_annotation))))
  92                 return SRD_ERR_MALLOC;
  93         pda->ann_format = ann_format;
  94         pda->ann_text = ann_text;
  95         pdata->data = pda;
  96
  97         return SRD_OK;
  98 }
  99
 100 static int convert_binary(struct srd_decoder_inst *di, PyObject *obj,
 101                 struct srd_proto_data *pdata)
 102 {
 103         struct srd_proto_data_binary *pdb;
 104         PyObject *py_tmp;
 105         Py_ssize_t size;
 106         int bin_class;
 107         char *class_name, *buf;
 108
 109         /* Should be a tuple of (binary class, bytes). */
 110         if (!PyTuple_Check(obj)) {
 111                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
 112                                 "%s instead of tuple.", di->decoder->name,
 113                                 obj->ob_type->tp_name);
 114                 return SRD_ERR_PYTHON;
 115         }
 116
 117         /* Should have 2 elements. */
 118         if (PyTuple_Size(obj) != 2) {
 119                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple "
 120                                 "with %d elements instead of 2", di->decoder->name,
 121                                 PyList_Size(obj));
 122                 return SRD_ERR_PYTHON;
 123         }
 124
 125         /* The first element should be an integer. */
 126         py_tmp = PyTuple_GetItem(obj, 0);
 127         if (!PyLong_Check(py_tmp)) {
 128                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple, "
 129                         "but first element was not an integer.", di->decoder->name);
 130                 return SRD_ERR_PYTHON;
 131         }
 132         bin_class = PyLong_AsLong(py_tmp);
 133         if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) {
 134                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with "
 135                         "unregistered binary class %d.", di->decoder->name, bin_class);
 136                 return SRD_ERR_PYTHON;
 137         }
 138
 139         /* Second element should be bytes. */
 140         py_tmp = PyTuple_GetItem(obj, 1);
 141         if (!PyBytes_Check(py_tmp)) {
 142                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY tuple, "
 143                         "but second element was not bytes.", di->decoder->name);
 144                 return SRD_ERR_PYTHON;
 145         }
 146
 147         /* Consider an empty set of bytes a bug. */
 148         if (PyBytes_Size(py_tmp) == 0) {
 149                 srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY "
 150                                 "with empty data set.", di->decoder->name);
 151                 return SRD_ERR_PYTHON;
 152         }
 153
 154         if (!(pdb = g_try_malloc(sizeof(struct srd_proto_data_binary))))
 155                 return SRD_ERR_MALLOC;
 156         if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1)
 157                 return SRD_ERR_PYTHON;
 158         pdb->bin_class = bin_class;
 159         pdb->size = size;
 160         if (!(pdb->data = g_try_malloc(pdb->size)))
 161                 return SRD_ERR_MALLOC;
 162         memcpy((void *)pdb->data, (const void *)buf, pdb->size);
 163         pdata->data = pdb;
 164
 165         return SRD_OK;
 166 }
 167
 168 static int convert_meta(struct srd_proto_data *pdata, PyObject *obj)
 169 {
 170         long long intvalue;
 171         double dvalue;
 172
 173         if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) {
 174                 if (!PyLong_Check(obj)) {
 175                         PyErr_Format(PyExc_TypeError, "This output was registered "
 176                                         "as 'int', but '%s' was passed.", obj->ob_type->tp_name);
 177                         return SRD_ERR_PYTHON;
 178                 }
 179                 intvalue = PyLong_AsLongLong(obj);
 180                 if (PyErr_Occurred())
 181                         return SRD_ERR_PYTHON;
 182                 pdata->data = g_variant_new_int64(intvalue);
 183         } else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) {
 184                 if (!PyFloat_Check(obj)) {
 185                         PyErr_Format(PyExc_TypeError, "This output was registered "
 186                                         "as 'float', but '%s' was passed.", obj->ob_type->tp_name);
 187                         return SRD_ERR_PYTHON;
 188                 }
 189                 dvalue = PyFloat_AsDouble(obj);
 190                 if (PyErr_Occurred())
 191                         return SRD_ERR_PYTHON;
 192                 pdata->data = g_variant_new_double(dvalue);
 193         }
 194
 195         return SRD_OK;
 196 }
 197
 198 static PyObject *Decoder_put(PyObject *self, PyObject *args)
 199 {
 200         GSList *l;
 201         PyObject *py_data, *py_res;
 202         struct srd_decoder_inst *di, *next_di;
 203         struct srd_pd_output *pdo;
 204         struct srd_proto_data *pdata;
 205         uint64_t start_sample, end_sample;
 206         int output_id;
 207         struct srd_pd_callback *cb;
 208
 209         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 210                 /* Shouldn't happen. */
 211                 srd_dbg("put(): self instance not found.");
 212                 return NULL;
 213         }
 214
 215         if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample,
 216                 &output_id, &py_data)) {
 217                 /*
 218                  * This throws an exception, but by returning NULL here we let
 219                  * Python raise it. This results in a much better trace in
 220                  * controller.c on the decode() method call.
 221                  */
 222                 return NULL;
 223         }
 224
 225         if (!(l = g_slist_nth(di->pd_output, output_id))) {
 226                 srd_err("Protocol decoder %s submitted invalid output ID %d.",
 227                         di->decoder->name, output_id);
 228                 return NULL;
 229         }
 230         pdo = l->data;
 231
 232         srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.",
 233                  di->inst_id, start_sample, end_sample,
 234                  OUTPUT_TYPES[pdo->output_type], output_id);
 235
 236         if (!(pdata = g_try_malloc0(sizeof(struct srd_proto_data)))) {
 237                 srd_err("Failed to g_malloc() struct srd_proto_data.");
 238                 return NULL;
 239         }
 240         pdata->start_sample = start_sample;
 241         pdata->end_sample = end_sample;
 242         pdata->pdo = pdo;
 243
 244         switch (pdo->output_type) {
 245         case SRD_OUTPUT_ANN:
 246                 /* Annotations are only fed to callbacks. */
 247                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 248                         /* Convert from PyDict to srd_proto_data_annotation. */
 249                         if (convert_annotation(di, py_data, pdata) != SRD_OK) {
 250                                 /* An error was already logged. */
 251                                 break;
 252                         }
 253                         cb->cb(pdata, cb->cb_data);
 254                 }
 255                 break;
 256         case SRD_OUTPUT_PYTHON:
 257                 for (l = di->next_di; l; l = l->next) {
 258                         next_di = l->data;
 259                         srd_spew("Sending %d-%d to instance %s",
 260                                  start_sample, end_sample, next_di->inst_id);
 261                         if (!(py_res = PyObject_CallMethod(
 262                                 next_di->py_inst, "decode", "KKO", start_sample,
 263                                 end_sample, py_data))) {
 264                                 srd_exception_catch("Calling %s decode(): ",
 265                                                         next_di->inst_id);
 266                         }
 267                         Py_XDECREF(py_res);
 268                 }
 269                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 270                         /* Frontends aren't really supposed to get Python
 271                          * callbacks, but it's useful for testing. */
 272                         pdata->data = py_data;
 273                         cb->cb(pdata, cb->cb_data);
 274                 }
 275                 break;
 276         case SRD_OUTPUT_BINARY:
 277                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 278                         /* Convert from PyDict to srd_proto_data_binary. */
 279                         if (convert_binary(di, py_data, pdata) != SRD_OK) {
 280                                 /* An error was already logged. */
 281                                 break;
 282                         }
 283                         cb->cb(pdata, cb->cb_data);
 284                 }
 285                 break;
 286         case SRD_OUTPUT_META:
 287                 if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) {
 288                         /* Annotations need converting from PyObject. */
 289                         if (convert_meta(pdata, py_data) != SRD_OK) {
 290                                 /* An exception was already set up. */
 291                                 break;
 292                         }
 293                         cb->cb(pdata, cb->cb_data);
 294                 }
 295                 break;
 296         default:
 297                 srd_err("Protocol decoder %s submitted invalid output type %d.",
 298                         di->decoder->name, pdo->output_type);
 299                 break;
 300         }
 301
 302         g_free(pdata);
 303
 304         Py_RETURN_NONE;
 305 }
 306
 307 static PyObject *Decoder_register(PyObject *self, PyObject *args,
 308                 PyObject *kwargs)
 309 {
 310         struct srd_decoder_inst *di;
 311         struct srd_pd_output *pdo;
 312         PyObject *py_new_output_id;
 313         PyTypeObject *meta_type_py;
 314         const GVariantType *meta_type_gv;
 315         int output_type;
 316         char *proto_id, *meta_name, *meta_descr;
 317         char *keywords[] = {"output_type", "proto_id", "meta", NULL};
 318
 319         meta_type_py = NULL;
 320         meta_type_gv = NULL;
 321         meta_name = meta_descr = NULL;
 322
 323         if (!(di = srd_inst_find_by_obj(NULL, self))) {
 324                 PyErr_SetString(PyExc_Exception, "decoder instance not found");
 325                 return NULL;
 326         }
 327
 328         /* Default to instance id, which defaults to class id. */
 329         proto_id = di->inst_id;
 330         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords,
 331                         &output_type, &proto_id,
 332                         &meta_type_py, &meta_name, &meta_descr)) {
 333                 /* Let Python raise this exception. */
 334                 return NULL;
 335         }
 336
 337         /* Check if the meta value's type is supported. */
 338         if (output_type == SRD_OUTPUT_META) {
 339                 if (meta_type_py == &PyLong_Type)
 340                         meta_type_gv = G_VARIANT_TYPE_INT64;
 341                 else if (meta_type_py == &PyFloat_Type)
 342                         meta_type_gv = G_VARIANT_TYPE_DOUBLE;
 343                 else {
 344                         PyErr_Format(PyExc_TypeError, "Unsupported type '%s'.",
 345                                         meta_type_py->tp_name);
 346                         return NULL;
 347                 }
 348         }
 349
 350         srd_dbg("Instance %s creating new output type %d for %s.",
 351                 di->inst_id, output_type, proto_id);
 352
 353         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
 354                 PyErr_SetString(PyExc_MemoryError, "struct srd_pd_output");
 355                 return NULL;
 356         }
 357
 358         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
 359         pdo->pdo_id = g_slist_length(di->pd_output);
 360         pdo->output_type = output_type;
 361         pdo->di = di;
 362         pdo->proto_id = g_strdup(proto_id);
 363
 364         if (output_type == SRD_OUTPUT_META) {
 365                 pdo->meta_type = meta_type_gv;
 366                 pdo->meta_name = g_strdup(meta_name);
 367                 pdo->meta_descr = g_strdup(meta_descr);
 368         }
 369
 370         di->pd_output = g_slist_append(di->pd_output, pdo);
 371         py_new_output_id = Py_BuildValue("i", pdo->pdo_id);
 372
 373         return py_new_output_id;
 374 }
 375
 376 static PyMethodDef Decoder_methods[] = {
 377         {"put", Decoder_put, METH_VARARGS,
 378          "Accepts a dictionary with the following keys: startsample, endsample, data"},
 379         {"register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS,
 380                         "Register a new output stream"},
 381         {NULL, NULL, 0, NULL}
 382 };
 383
 384 /** @cond PRIVATE */
 385 SRD_PRIV PyTypeObject srd_Decoder_type = {
 386         PyVarObject_HEAD_INIT(NULL, 0)
 387         .tp_name = "sigrokdecode.Decoder",
 388         .tp_basicsize = sizeof(srd_Decoder),
 389         .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
 390         .tp_doc = "sigrok Decoder base class",
 391         .tp_methods = Decoder_methods,
 392 };
 393 /** @endcond */