instance.c

   1 /*
   2  * This file is part of the libsigrokdecode project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  22 #include "libsigrokdecode.h"
  23 #include "config.h"
  24 #include <glib.h>
  25 #include <inttypes.h>
  26 #include <stdlib.h>
  27 #include <stdint.h>
  28
  29 /** @cond PRIVATE */
  30
  31 extern SRD_PRIV GSList *sessions;
  32
  33 /* type_logic.c */
  34 extern SRD_PRIV PyTypeObject srd_logic_type;
  35
  36 /** @endcond */
  37
  38 /**
  39  * @file
  40  *
  41  * Decoder instance handling.
  42  */
  43
  44 /**
  45  * @defgroup grp_instances Decoder instances
  46  *
  47  * Decoder instance handling.
  48  *
  49  * @{
  50  */
  51
  52 /**
  53  * Set one or more options in a decoder instance.
  54  *
  55  * Handled options are removed from the hash.
  56  *
  57  * @param di Decoder instance.
  58  * @param options A GHashTable of options to set.
  59  *
  60  * @return SRD_OK upon success, a (negative) error code otherwise.
  61  *
  62  * @since 0.1.0
  63  */
  64 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
  65                 GHashTable *options)
  66 {
  67         struct srd_decoder_option *sdo;
  68         PyObject *py_di_options, *py_optval;
  69         GVariant *value;
  70         GSList *l;
  71         double val_double;
  72         gint64 val_int;
  73         int ret;
  74         const char *val_str;
  75
  76         if (!di) {
  77                 srd_err("Invalid decoder instance.");
  78                 return SRD_ERR_ARG;
  79         }
  80
  81         if (!options) {
  82                 srd_err("Invalid options GHashTable.");
  83                 return SRD_ERR_ARG;
  84         }
  85
  86         if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
  87                 /* Decoder has no options. */
  88                 if (g_hash_table_size(options) == 0) {
  89                         /* No options provided. */
  90                         return SRD_OK;
  91                 } else {
  92                         srd_err("Protocol decoder has no options.");
  93                         return SRD_ERR_ARG;
  94                 }
  95                 return SRD_OK;
  96         }
  97
  98         ret = SRD_ERR_PYTHON;
  99         py_optval = NULL;
 100
 101         /*
 102          * The 'options' tuple is a class variable, but we need to
 103          * change it. Changing it directly will affect the entire class,
 104          * so we need to create a new object for it, and populate that
 105          * instead.
 106          */
 107         if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
 108                 goto err_out;
 109         Py_DECREF(py_di_options);
 110         py_di_options = PyDict_New();
 111         PyObject_SetAttrString(di->py_inst, "options", py_di_options);
 112
 113         for (l = di->decoder->options; l; l = l->next) {
 114                 sdo = l->data;
 115                 if ((value = g_hash_table_lookup(options, sdo->id))) {
 116                         /* A value was supplied for this option. */
 117                         if (!g_variant_type_equal(g_variant_get_type(value),
 118                                   g_variant_get_type(sdo->def))) {
 119                                 srd_err("Option '%s' should have the same type "
 120                                         "as the default value.", sdo->id);
 121                                 goto err_out;
 122                         }
 123                 } else {
 124                         /* Use default for this option. */
 125                         value = sdo->def;
 126                 }
 127                 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
 128                         val_str = g_variant_get_string(value, NULL);
 129                         if (!(py_optval = PyUnicode_FromString(val_str))) {
 130                                 /* Some UTF-8 encoding error. */
 131                                 PyErr_Clear();
 132                                 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
 133                                 goto err_out;
 134                         }
 135                 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
 136                         val_int = g_variant_get_int64(value);
 137                         if (!(py_optval = PyLong_FromLong(val_int))) {
 138                                 /* ValueError Exception */
 139                                 PyErr_Clear();
 140                                 srd_err("Option '%s' has invalid integer value.", sdo->id);
 141                                 goto err_out;
 142                         }
 143                 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
 144                         val_double = g_variant_get_double(value);
 145                         if (!(py_optval = PyFloat_FromDouble(val_double))) {
 146                                 /* ValueError Exception */
 147                                 PyErr_Clear();
 148                                 srd_err("Option '%s' has invalid float value.",
 149                                         sdo->id);
 150                                 goto err_out;
 151                         }
 152                 }
 153                 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
 154                         goto err_out;
 155                 /* Not harmful even if we used the default. */
 156                 g_hash_table_remove(options, sdo->id);
 157         }
 158         if (g_hash_table_size(options) != 0)
 159                 srd_warn("Unknown options specified for '%s'", di->inst_id);
 160
 161         ret = SRD_OK;
 162
 163 err_out:
 164         Py_XDECREF(py_optval);
 165         if (PyErr_Occurred()) {
 166                 srd_exception_catch("Stray exception in srd_inst_option_set().");
 167                 ret = SRD_ERR_PYTHON;
 168         }
 169
 170         return ret;
 171 }
 172
 173 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */
 174 static gint compare_channel_id(const struct srd_channel *pdch,
 175                         const char *channel_id)
 176 {
 177         return strcmp(pdch->id, channel_id);
 178 }
 179
 180 /**
 181  * Set all channels in a decoder instance.
 182  *
 183  * This function sets _all_ channels for the specified decoder instance, i.e.,
 184  * it overwrites any channels that were already defined (if any).
 185  *
 186  * @param di Decoder instance.
 187  * @param new_channels A GHashTable of channels to set. Key is channel name,
 188  *                     value is the channel number. Samples passed to this
 189  *                     instance will be arranged in this order.
 190  * @param unit_size Number of bytes per sample in the data stream to be passed
 191  *                  to the decoder. The highest channel index specified in the
 192  *                  channel map must lie within a sample unit.
 193  *
 194  * @return SRD_OK upon success, a (negative) error code otherwise.
 195  *
 196  * @since 0.3.0
 197  */
 198 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
 199                 GHashTable *new_channels, int unit_size)
 200 {
 201         GVariant *channel_val;
 202         GList *l;
 203         GSList *sl;
 204         struct srd_channel *pdch;
 205         int *new_channelmap, new_channelnum, num_required_channels, i;
 206         char *channel_id;
 207
 208         srd_dbg("Setting channels for instance %s with list of %d channels, "
 209                 "unitsize %d.", di->inst_id, g_hash_table_size(new_channels),
 210                 unit_size);
 211
 212         if (g_hash_table_size(new_channels) == 0)
 213                 /* No channels provided. */
 214                 return SRD_OK;
 215
 216         if (di->dec_num_channels == 0) {
 217                 /* Decoder has no channels. */
 218                 srd_err("Protocol decoder %s has no channels to define.",
 219                         di->decoder->name);
 220                 return SRD_ERR_ARG;
 221         }
 222
 223         new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
 224
 225         /*
 226          * For now, map all indexes to channel -1 (can be overridden later).
 227          * This -1 is interpreted as an unspecified channel later.
 228          */
 229         for (i = 0; i < di->dec_num_channels; i++)
 230                 new_channelmap[i] = -1;
 231
 232         for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
 233                 channel_id = l->data;
 234                 channel_val = g_hash_table_lookup(new_channels, channel_id);
 235                 if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
 236                         /* Channel name was specified without a value. */
 237                         srd_err("No channel number was specified for %s.",
 238                                         channel_id);
 239                         g_free(new_channelmap);
 240                         return SRD_ERR_ARG;
 241                 }
 242                 new_channelnum = g_variant_get_int32(channel_val);
 243                 if (new_channelnum >= 8 * unit_size) {
 244                         srd_err("Channel index %d not within data unit (%d bit).",
 245                                 new_channelnum, 8 * unit_size);
 246                         g_free(new_channelmap);
 247                         return SRD_ERR_ARG;
 248                 }
 249                 if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
 250                                 (GCompareFunc)compare_channel_id))) {
 251                         /* Fall back on optional channels. */
 252                         if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
 253                              channel_id, (GCompareFunc)compare_channel_id))) {
 254                                 srd_err("Protocol decoder %s has no channel "
 255                                         "'%s'.", di->decoder->name, channel_id);
 256                                 g_free(new_channelmap);
 257                                 return SRD_ERR_ARG;
 258                         }
 259                 }
 260                 pdch = sl->data;
 261                 new_channelmap[pdch->order] = new_channelnum;
 262                 srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
 263                         pdch->id, pdch->order, new_channelnum);
 264         }
 265         di->data_unitsize = unit_size;
 266
 267         srd_dbg("Final channel map:");
 268         num_required_channels = g_slist_length(di->decoder->channels);
 269         for (i = 0; i < di->dec_num_channels; i++) {
 270                 srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i],
 271                         (i < num_required_channels) ? "required" : "optional");
 272         }
 273
 274         /* Report an error if not all required channels were specified. */
 275         for (i = 0; i < num_required_channels; i++) {
 276                 if (new_channelmap[i] != -1)
 277                         continue;
 278                 pdch = g_slist_nth(di->decoder->channels, i)->data;
 279                 srd_err("Required channel '%s' (index %d) was not specified.",
 280                         pdch->id, i);
 281                 return SRD_ERR;
 282         }
 283
 284         g_free(di->dec_channelmap);
 285         di->dec_channelmap = new_channelmap;
 286
 287         return SRD_OK;
 288 }
 289
 290 /**
 291  * Create a new protocol decoder instance.
 292  *
 293  * @param sess The session holding the protocol decoder instance.
 294  * @param decoder_id Decoder 'id' field.
 295  * @param options GHashtable of options which override the defaults set in
 296  *                the decoder class. May be NULL.
 297  *
 298  * @return Pointer to a newly allocated struct srd_decoder_inst, or
 299  *         NULL in case of failure.
 300  *
 301  * @since 0.3.0
 302  */
 303 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
 304                 const char *decoder_id, GHashTable *options)
 305 {
 306         int i;
 307         struct srd_decoder *dec;
 308         struct srd_decoder_inst *di;
 309         char *inst_id;
 310
 311         srd_dbg("Creating new %s instance.", decoder_id);
 312
 313         if (session_is_valid(sess) != SRD_OK) {
 314                 srd_err("Invalid session.");
 315                 return NULL;
 316         }
 317
 318         if (!(dec = srd_decoder_get_by_id(decoder_id))) {
 319                 srd_err("Protocol decoder %s not found.", decoder_id);
 320                 return NULL;
 321         }
 322
 323         di = g_malloc0(sizeof(struct srd_decoder_inst));
 324
 325         di->decoder = dec;
 326         di->sess = sess;
 327         if (options) {
 328                 inst_id = g_hash_table_lookup(options, "id");
 329                 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
 330                 g_hash_table_remove(options, "id");
 331         } else
 332                 di->inst_id = g_strdup(decoder_id);
 333
 334         /*
 335          * Prepare a default channel map, where samples come in the
 336          * order in which the decoder class defined them.
 337          */
 338         di->dec_num_channels = g_slist_length(di->decoder->channels) +
 339                         g_slist_length(di->decoder->opt_channels);
 340         if (di->dec_num_channels) {
 341                 di->dec_channelmap =
 342                                 g_malloc(sizeof(int) * di->dec_num_channels);
 343                 for (i = 0; i < di->dec_num_channels; i++)
 344                         di->dec_channelmap[i] = i;
 345                 di->data_unitsize = (di->dec_num_channels + 7) / 8;
 346                 /*
 347                  * Will be used to prepare a sample at every iteration
 348                  * of the instance's decode() method.
 349                  */
 350                 di->channel_samples = g_malloc(di->dec_num_channels);
 351         }
 352
 353         /* Create a new instance of this decoder class. */
 354         if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
 355                 if (PyErr_Occurred())
 356                         srd_exception_catch("failed to create %s instance: ",
 357                                         decoder_id);
 358                 g_free(di->dec_channelmap);
 359                 g_free(di);
 360                 return NULL;
 361         }
 362
 363         if (options && srd_inst_option_set(di, options) != SRD_OK) {
 364                 g_free(di->dec_channelmap);
 365                 g_free(di);
 366                 return NULL;
 367         }
 368
 369         /* Instance takes input from a frontend by default. */
 370         sess->di_list = g_slist_append(sess->di_list, di);
 371
 372         return di;
 373 }
 374
 375 /**
 376  * Stack a decoder instance on top of another.
 377  *
 378  * @param sess The session holding the protocol decoder instances.
 379  * @param di_bottom The instance on top of which di_top will be stacked.
 380  * @param di_top The instance to go on top.
 381  *
 382  * @return SRD_OK upon success, a (negative) error code otherwise.
 383  *
 384  * @since 0.3.0
 385  */
 386 SRD_API int srd_inst_stack(struct srd_session *sess,
 387                 struct srd_decoder_inst *di_bottom,
 388                 struct srd_decoder_inst *di_top)
 389 {
 390
 391         if (session_is_valid(sess) != SRD_OK) {
 392                 srd_err("Invalid session.");
 393                 return SRD_ERR_ARG;
 394         }
 395
 396         if (!di_bottom || !di_top) {
 397                 srd_err("Invalid from/to instance pair.");
 398                 return SRD_ERR_ARG;
 399         }
 400
 401         if (g_slist_find(sess->di_list, di_top)) {
 402                 /* Remove from the unstacked list. */
 403                 sess->di_list = g_slist_remove(sess->di_list, di_top);
 404         }
 405
 406         /* Stack on top of source di. */
 407         di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
 408
 409         srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
 410
 411         return SRD_OK;
 412 }
 413
 414 /**
 415  * Find a decoder instance by its instance ID.
 416  *
 417  * Only the bottom level of instances are searched -- instances already stacked
 418  * on top of another one will not be found.
 419  *
 420  * @param sess The session holding the protocol decoder instance.
 421  * @param inst_id The instance ID to be found.
 422  *
 423  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
 424  *
 425  * @since 0.3.0
 426  */
 427 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
 428                 const char *inst_id)
 429 {
 430         GSList *l;
 431         struct srd_decoder_inst *tmp, *di;
 432
 433         if (session_is_valid(sess) != SRD_OK) {
 434                 srd_err("Invalid session.");
 435                 return NULL;
 436         }
 437
 438         di = NULL;
 439         for (l = sess->di_list; l; l = l->next) {
 440                 tmp = l->data;
 441                 if (!strcmp(tmp->inst_id, inst_id)) {
 442                         di = tmp;
 443                         break;
 444                 }
 445         }
 446
 447         return di;
 448 }
 449
 450 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
 451                 struct srd_session *sess, const GSList *stack,
 452                 const PyObject *obj)
 453 {
 454         const GSList *l;
 455         struct srd_decoder_inst *tmp, *di;
 456
 457         if (session_is_valid(sess) != SRD_OK) {
 458                 srd_err("Invalid session.");
 459                 return NULL;
 460         }
 461
 462         di = NULL;
 463         for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
 464                 tmp = l->data;
 465                 if (tmp->py_inst == obj)
 466                         di = tmp;
 467                 else if (tmp->next_di)
 468                         di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
 469         }
 470
 471         return di;
 472 }
 473
 474 /**
 475  * Find a decoder instance by its Python object.
 476  *
 477  * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
 478  * This will recurse to find the instance anywhere in the stack tree of all
 479  * sessions.
 480  *
 481  * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
 482  *              stack to search. To start searching at the bottom level of
 483  *              decoder instances, pass NULL.
 484  * @param obj The Python class instantiation.
 485  *
 486  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
 487  *
 488  * @private
 489  *
 490  * @since 0.1.0
 491  */
 492 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
 493                 const PyObject *obj)
 494 {
 495         struct srd_decoder_inst *di;
 496         struct srd_session *sess;
 497         GSList *l;
 498
 499         di = NULL;
 500         for (l = sessions; di == NULL && l != NULL; l = l->next) {
 501                 sess = l->data;
 502                 di = srd_sess_inst_find_by_obj(sess, stack, obj);
 503         }
 504
 505         return di;
 506 }
 507
 508 /** @private */
 509 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
 510 {
 511         PyObject *py_res;
 512         GSList *l;
 513         struct srd_decoder_inst *next_di;
 514         int ret;
 515
 516         srd_dbg("Calling start() method on protocol decoder instance %s.",
 517                         di->inst_id);
 518
 519         if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
 520                 srd_exception_catch("Protocol decoder instance %s: ",
 521                                 di->inst_id);
 522                 return SRD_ERR_PYTHON;
 523         }
 524         Py_DecRef(py_res);
 525
 526         /* Start all the PDs stacked on top of this one. */
 527         for (l = di->next_di; l; l = l->next) {
 528                 next_di = l->data;
 529                 if ((ret = srd_inst_start(next_di)) != SRD_OK)
 530                         return ret;
 531         }
 532
 533         return SRD_OK;
 534 }
 535
 536 /**
 537  * Run the specified decoder function.
 538  *
 539  * @param di The decoder instance to call. Must not be NULL.
 540  * @param start_samplenum The starting sample number for the buffer's sample
 541  *                        set, relative to the start of capture.
 542  * @param end_samplenum The ending sample number for the buffer's sample
 543  *                        set, relative to the start of capture.
 544  * @param inbuf The buffer to decode. Must not be NULL.
 545  * @param inbuflen Length of the buffer. Must be > 0.
 546  *
 547  * @return SRD_OK upon success, a (negative) error code otherwise.
 548  *
 549  * @private
 550  *
 551  * @since 0.1.0
 552  */
 553 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
 554                 uint64_t start_samplenum, uint64_t end_samplenum,
 555                 const uint8_t *inbuf, uint64_t inbuflen)
 556 {
 557         PyObject *py_res;
 558         srd_logic *logic;
 559
 560         srd_dbg("Calling decode(), start sample %" PRIu64 ", end sample %"
 561                 PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
 562                 "%d), instance %s.", start_samplenum, end_samplenum,
 563                 end_samplenum - start_samplenum, inbuflen, di->data_unitsize,
 564                 di->inst_id);
 565
 566         /* Return an error upon unusable input. */
 567         if (!di) {
 568                 srd_dbg("empty decoder instance");
 569                 return SRD_ERR_ARG;
 570         }
 571         if (!inbuf) {
 572                 srd_dbg("NULL buffer pointer");
 573                 return SRD_ERR_ARG;
 574         }
 575         if (inbuflen == 0) {
 576                 srd_dbg("empty buffer");
 577                 return SRD_ERR_ARG;
 578         }
 579
 580         /*
 581          * Create new srd_logic object. Each iteration around the PD's loop
 582          * will fill one sample into this object.
 583          */
 584         logic = PyObject_New(srd_logic, &srd_logic_type);
 585         Py_INCREF(logic);
 586         logic->di = (struct srd_decoder_inst *)di;
 587         logic->start_samplenum = start_samplenum;
 588         logic->itercnt = 0;
 589         logic->inbuf = (uint8_t *)inbuf;
 590         logic->inbuflen = inbuflen;
 591         logic->sample = PyList_New(2);
 592         Py_INCREF(logic->sample);
 593
 594         Py_IncRef(di->py_inst);
 595         if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
 596                         "KKO", start_samplenum, end_samplenum, logic))) {
 597                 srd_exception_catch("Protocol decoder instance %s: ",
 598                                 di->inst_id);
 599                 return SRD_ERR_PYTHON;
 600         }
 601         Py_DecRef(py_res);
 602
 603         return SRD_OK;
 604 }
 605
 606 /** @private */
 607 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
 608 {
 609         GSList *l;
 610         struct srd_pd_output *pdo;
 611
 612         srd_dbg("Freeing instance %s", di->inst_id);
 613
 614         Py_DecRef(di->py_inst);
 615         g_free(di->inst_id);
 616         g_free(di->dec_channelmap);
 617         g_slist_free(di->next_di);
 618         for (l = di->pd_output; l; l = l->next) {
 619                 pdo = l->data;
 620                 g_free(pdo->proto_id);
 621                 g_free(pdo);
 622         }
 623         g_slist_free(di->pd_output);
 624         g_free(di);
 625 }
 626
 627 /** @private */
 628 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
 629 {
 630         GSList *l;
 631         struct srd_decoder_inst *di;
 632
 633         if (session_is_valid(sess) != SRD_OK) {
 634                 srd_err("Invalid session.");
 635                 return;
 636         }
 637
 638         di = NULL;
 639         for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
 640                 di = l->data;
 641                 if (di->next_di)
 642                         srd_inst_free_all(sess, di->next_di);
 643                 srd_inst_free(di);
 644         }
 645         if (!stack) {
 646                 g_slist_free(sess->di_list);
 647                 sess->di_list = NULL;
 648         }
 649 }
 650
 651 /** @} */