decoder.c

   1 /*
   2  * This file is part of the libsigrokdecode project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include "config.h"
  22 #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #include "libsigrokdecode-internal.h"
  24 #include <glib.h>
  25
  26 /**
  27  * @file
  28  *
  29  * Listing, loading, unloading, and handling protocol decoders.
  30  */
  31
  32 /**
  33  * @defgroup grp_decoder Protocol decoders
  34  *
  35  * Handling protocol decoders.
  36  *
  37  * @{
  38  */
  39
  40 /** @cond PRIVATE */
  41
  42 /* The list of protocol decoders. */
  43 SRD_PRIV GSList *pd_list = NULL;
  44
  45 extern GSList *sessions;
  46
  47 /* module_sigrokdecode.c */
  48 extern SRD_PRIV PyObject *mod_sigrokdecode;
  49
  50 /** @endcond */
  51
  52 /**
  53  * Returns the list of supported/loaded protocol decoders.
  54  *
  55  * This is a GSList containing the names of the decoders as strings.
  56  *
  57  * @return List of decoders, NULL if none are supported or loaded.
  58  *
  59  * @since 0.1.0 (but the API changed in 0.2.0)
  60  */
  61 SRD_API const GSList *srd_decoder_list(void)
  62 {
  63         return pd_list;
  64 }
  65
  66 /**
  67  * Get the decoder with the specified ID.
  68  *
  69  * @param id The ID string of the decoder to return.
  70  *
  71  * @return The decoder with the specified ID, or NULL if not found.
  72  *
  73  * @since 0.1.0
  74  */
  75 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
  76 {
  77         GSList *l;
  78         struct srd_decoder *dec;
  79
  80         for (l = pd_list; l; l = l->next) {
  81                 dec = l->data;
  82                 if (!strcmp(dec->id, id))
  83                         return dec;
  84         }
  85
  86         return NULL;
  87 }
  88
  89 static int get_probes(const struct srd_decoder *d, const char *attr,
  90                 GSList **pl)
  91 {
  92         PyObject *py_probelist, *py_entry;
  93         struct srd_probe *p;
  94         int ret, num_probes, i;
  95
  96         if (!PyObject_HasAttrString(d->py_dec, attr))
  97                 /* No probes of this type specified. */
  98                 return SRD_OK;
  99
 100         py_probelist = PyObject_GetAttrString(d->py_dec, attr);
 101         if (!PyList_Check(py_probelist)) {
 102                 srd_err("Protocol decoder %s %s attribute is not a list.",
 103                                 d->name, attr);
 104                 return SRD_ERR_PYTHON;
 105         }
 106
 107         if ((num_probes = PyList_Size(py_probelist)) == 0)
 108                 /* Empty probelist. */
 109                 return SRD_OK;
 110
 111         ret = SRD_OK;
 112         for (i = 0; i < num_probes; i++) {
 113                 py_entry = PyList_GetItem(py_probelist, i);
 114                 if (!PyDict_Check(py_entry)) {
 115                         srd_err("Protocol decoder %s %s attribute is not "
 116                                 "a list with dict elements.", d->name, attr);
 117                         ret = SRD_ERR_PYTHON;
 118                         break;
 119                 }
 120
 121                 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
 122                         srd_err("Failed to g_malloc() struct srd_probe.");
 123                         ret = SRD_ERR_MALLOC;
 124                         break;
 125                 }
 126
 127                 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK) {
 128                         ret = SRD_ERR_PYTHON;
 129                         break;
 130                 }
 131                 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK) {
 132                         ret = SRD_ERR_PYTHON;
 133                         break;
 134                 }
 135                 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK) {
 136                         ret = SRD_ERR_PYTHON;
 137                         break;
 138                 }
 139                 p->order = i;
 140
 141                 *pl = g_slist_append(*pl, p);
 142         }
 143
 144         Py_DecRef(py_probelist);
 145
 146         return ret;
 147 }
 148
 149 static int get_options(struct srd_decoder *d)
 150 {
 151         PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default;
 152         Py_ssize_t i;
 153         struct srd_decoder_option *o;
 154         gint64 def_long;
 155         int num_keys, overflow, ret;
 156         char *key, *def_str;
 157
 158         ret = SRD_ERR_PYTHON;
 159         key = NULL;
 160
 161         if (!PyObject_HasAttrString(d->py_dec, "options"))
 162                 /* That's fine. */
 163                 return SRD_OK;
 164
 165         /* If present, options must be a dictionary. */
 166         py_opts = PyObject_GetAttrString(d->py_dec, "options");
 167         if (!PyDict_Check(py_opts)) {
 168                 srd_err("Protocol decoder %s options attribute is not "
 169                         "a dictionary.", d->name);
 170                 goto err_out;
 171         }
 172
 173         py_keys = PyDict_Keys(py_opts);
 174         py_values = PyDict_Values(py_opts);
 175         num_keys = PyList_Size(py_keys);
 176         for (i = 0; i < num_keys; i++) {
 177                 py_str_as_str(PyList_GetItem(py_keys, i), &key);
 178                 srd_dbg("option '%s'", key);
 179                 py_val = PyList_GetItem(py_values, i);
 180                 if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) {
 181                         srd_err("Protocol decoder %s option '%s' value must be "
 182                                         "a list with two elements.", d->name, key);
 183                         goto err_out;
 184                 }
 185                 py_desc = PyList_GetItem(py_val, 0);
 186                 if (!PyUnicode_Check(py_desc)) {
 187                         srd_err("Protocol decoder %s option '%s' has no "
 188                                         "description.", d->name, key);
 189                         goto err_out;
 190                 }
 191                 py_default = PyList_GetItem(py_val, 1);
 192                 if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) {
 193                         srd_err("Protocol decoder %s option '%s' has default "
 194                                         "of unsupported type '%s'.", d->name, key,
 195                                         Py_TYPE(py_default)->tp_name);
 196                         goto err_out;
 197                 }
 198                 if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
 199                         srd_err("option malloc failed");
 200                         goto err_out;
 201                 }
 202                 o->id = g_strdup(key);
 203                 py_str_as_str(py_desc, &o->desc);
 204                 if (PyUnicode_Check(py_default)) {
 205                         /* UTF-8 string */
 206                         py_str_as_str(py_default, &def_str);
 207                         o->def = g_variant_new_string(def_str);
 208                         g_free(def_str);
 209                 } else {
 210                         /* Long */
 211                         def_long = PyLong_AsLongAndOverflow(py_default, &overflow);
 212                         if (overflow) {
 213                                 /* Value is < LONG_MIN or > LONG_MAX */
 214                                 PyErr_Clear();
 215                                 srd_err("Protocol decoder %s option '%s' has "
 216                                                 "invalid default value.", d->name, key);
 217                                 goto err_out;
 218                         }
 219                         o->def = g_variant_new_int64(def_long);
 220                 }
 221                 g_variant_ref_sink(o->def);
 222                 d->options = g_slist_append(d->options, o);
 223                 g_free(key);
 224                 key = NULL;
 225         }
 226         Py_DecRef(py_keys);
 227         Py_DecRef(py_values);
 228
 229         ret = SRD_OK;
 230
 231 err_out:
 232         Py_XDECREF(py_opts);
 233         g_free(key);
 234
 235         return ret;
 236 }
 237
 238 /**
 239  * Load a protocol decoder module into the embedded Python interpreter.
 240  *
 241  * @param module_name The module name to be loaded.
 242  *
 243  * @return SRD_OK upon success, a (negative) error code otherwise.
 244  *
 245  * @since 0.1.0
 246  */
 247 SRD_API int srd_decoder_load(const char *module_name)
 248 {
 249         PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann, \
 250                 *py_bin_classes, *py_bin_class;
 251         struct srd_decoder *d;
 252         int len, ret, i;
 253         char **ann, *bin;
 254         struct srd_probe *p;
 255         GSList *l;
 256
 257         if (!srd_check_init())
 258                 return SRD_ERR;
 259
 260         if (!module_name)
 261                 return SRD_ERR_ARG;
 262
 263         if (PyDict_GetItemString(PyImport_GetModuleDict(), module_name)) {
 264                 /* Module was already imported. */
 265                 return SRD_OK;
 266         }
 267
 268         srd_dbg("Loading protocol decoder '%s'.", module_name);
 269
 270         py_basedec = py_method = py_attr = NULL;
 271
 272         if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
 273                 srd_dbg("Failed to g_malloc() struct srd_decoder.");
 274                 ret = SRD_ERR_MALLOC;
 275                 goto err_out;
 276         }
 277
 278         ret = SRD_ERR_PYTHON;
 279
 280         /* Import the Python module. */
 281         if (!(d->py_mod = PyImport_ImportModule(module_name))) {
 282                 srd_exception_catch("Import of '%s' failed.", module_name);
 283                 goto err_out;
 284         }
 285
 286         /* Get the 'Decoder' class as Python object. */
 287         if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
 288                 /* This generated an AttributeError exception. */
 289                 PyErr_Clear();
 290                 srd_err("Decoder class not found in protocol decoder %s.",
 291                         module_name);
 292                 goto err_out;
 293         }
 294
 295         if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
 296                 srd_dbg("sigrokdecode module not loaded.");
 297                 goto err_out;
 298         }
 299
 300         if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
 301                 srd_err("Decoder class in protocol decoder module %s is not "
 302                         "a subclass of sigrokdecode.Decoder.", module_name);
 303                 goto err_out;
 304         }
 305         Py_CLEAR(py_basedec);
 306
 307         /* Check for a proper start() method. */
 308         if (!PyObject_HasAttrString(d->py_dec, "start")) {
 309                 srd_err("Protocol decoder %s has no start() method Decoder "
 310                         "class.", module_name);
 311                 goto err_out;
 312         }
 313         py_method = PyObject_GetAttrString(d->py_dec, "start");
 314         if (!PyFunction_Check(py_method)) {
 315                 srd_err("Protocol decoder %s Decoder class attribute 'start' "
 316                         "is not a method.", module_name);
 317                 goto err_out;
 318         }
 319         Py_CLEAR(py_method);
 320
 321         /* Check for a proper decode() method. */
 322         if (!PyObject_HasAttrString(d->py_dec, "decode")) {
 323                 srd_err("Protocol decoder %s has no decode() method Decoder "
 324                         "class.", module_name);
 325                 goto err_out;
 326         }
 327         py_method = PyObject_GetAttrString(d->py_dec, "decode");
 328         if (!PyFunction_Check(py_method)) {
 329                 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
 330                         "is not a method.", module_name);
 331                 goto err_out;
 332         }
 333         Py_CLEAR(py_method);
 334
 335         if (get_options(d) != SRD_OK)
 336                 goto err_out;
 337
 338         /* Check and import required probes. */
 339         if (get_probes(d, "probes", &d->probes) != SRD_OK)
 340                 goto err_out;
 341
 342         /* Check and import optional probes. */
 343         if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
 344                 goto err_out;
 345
 346         /*
 347          * Fix order numbers for the optional probes.
 348          *
 349          * Example:
 350          * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
 351          * 'order' fields in the d->probes list = 0, 1, 2.
 352          * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
 353          */
 354         for (l = d->opt_probes; l; l = l->next) {
 355                 p = l->data;
 356                 p->order += g_slist_length(d->probes);
 357         }
 358
 359         /* Store required fields in newly allocated strings. */
 360         if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
 361                 goto err_out;
 362
 363         if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
 364                 goto err_out;
 365
 366         if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
 367                 goto err_out;
 368
 369         if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
 370                 goto err_out;
 371
 372         if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
 373                 goto err_out;
 374
 375         /* Convert annotation class attribute to GSList of char **. */
 376         d->annotations = NULL;
 377         if (PyObject_HasAttrString(d->py_dec, "annotations")) {
 378                 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
 379                 if (!PyList_Check(py_annlist)) {
 380                         srd_err("Protocol decoder module %s annotations "
 381                                 "should be a list.", module_name);
 382                         goto err_out;
 383                 }
 384                 len = PyList_Size(py_annlist);
 385                 for (i = 0; i < len; i++) {
 386                         py_ann = PyList_GetItem(py_annlist, i);
 387                         if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
 388                                 srd_err("Protocol decoder module %s "
 389                                         "annotation %d should be a list with "
 390                                         "two elements.", module_name, i + 1);
 391                                 goto err_out;
 392                         }
 393
 394                         if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
 395                                 goto err_out;
 396                         }
 397                         d->annotations = g_slist_append(d->annotations, ann);
 398                 }
 399         }
 400
 401         /* Convert binary class to GSList of char *. */
 402         d->binary = NULL;
 403         if (PyObject_HasAttrString(d->py_dec, "binary")) {
 404                 py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary");
 405                 if (!PyTuple_Check(py_bin_classes)) {
 406                         srd_err("Protocol decoder module %s binary classes "
 407                                 "should be a tuple.", module_name);
 408                         goto err_out;
 409                 }
 410                 len = PyTuple_Size(py_bin_classes);
 411                 for (i = 0; i < len; i++) {
 412                         py_bin_class = PyTuple_GetItem(py_bin_classes, i);
 413                         if (!PyUnicode_Check(py_bin_class)) {
 414                                 srd_err("Protocol decoder module %s binary "
 415                                                 "class should be a string.", module_name);
 416                                 goto err_out;
 417                         }
 418
 419                         if (py_str_as_str(py_bin_class, &bin) != SRD_OK) {
 420                                 goto err_out;
 421                         }
 422                         d->binary = g_slist_append(d->binary, bin);
 423                 }
 424         }
 425
 426         /* Append it to the list of supported/loaded decoders. */
 427         pd_list = g_slist_append(pd_list, d);
 428
 429         ret = SRD_OK;
 430
 431 err_out:
 432         if (ret != SRD_OK) {
 433                 Py_XDECREF(py_method);
 434                 Py_XDECREF(py_basedec);
 435                 Py_XDECREF(d->py_dec);
 436                 Py_XDECREF(d->py_mod);
 437                 g_free(d);
 438         }
 439
 440         return ret;
 441 }
 442
 443 /**
 444  * Return a protocol decoder's docstring.
 445  *
 446  * @param dec The loaded protocol decoder.
 447  *
 448  * @return A newly allocated buffer containing the protocol decoder's
 449  *         documentation. The caller is responsible for free'ing the buffer.
 450  *
 451  * @since 0.1.0
 452  */
 453 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 454 {
 455         PyObject *py_str;
 456         char *doc;
 457
 458         if (!srd_check_init())
 459                 return NULL;
 460
 461         if (!dec)
 462                 return NULL;
 463
 464         if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
 465                 return NULL;
 466
 467         if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
 468                 srd_exception_catch("");
 469                 return NULL;
 470         }
 471
 472         doc = NULL;
 473         if (py_str != Py_None)
 474                 py_str_as_str(py_str, &doc);
 475         Py_DecRef(py_str);
 476
 477         return doc;
 478 }
 479
 480 static void free_probes(GSList *probelist)
 481 {
 482         GSList *l;
 483         struct srd_probe *p;
 484
 485         if (probelist == NULL)
 486                 return;
 487
 488         for (l = probelist; l; l = l->next) {
 489                 p = l->data;
 490                 g_free(p->id);
 491                 g_free(p->name);
 492                 g_free(p->desc);
 493                 g_free(p);
 494         }
 495         g_slist_free(probelist);
 496 }
 497
 498 /**
 499  * Unload the specified protocol decoder.
 500  *
 501  * @param dec The struct srd_decoder to be unloaded.
 502  *
 503  * @return SRD_OK upon success, a (negative) error code otherwise.
 504  *
 505  * @since 0.1.0
 506  */
 507 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 508 {
 509         struct srd_decoder_option *o;
 510         struct srd_session *sess;
 511         GSList *l;
 512
 513         if (!srd_check_init())
 514                 return SRD_ERR;
 515
 516         if (!dec)
 517                 return SRD_ERR_ARG;
 518
 519         srd_dbg("Unloading protocol decoder '%s'.", dec->name);
 520
 521         /*
 522          * Since any instances of this decoder need to be released as well,
 523          * but they could be anywhere in the stack, just free the entire
 524          * stack. A frontend reloading a decoder thus has to restart all
 525          * instances, and rebuild the stack.
 526          */
 527         for (l = sessions; l; l = l->next) {
 528                 sess = l->data;
 529                 srd_inst_free_all(sess, NULL);
 530         }
 531
 532         for (l = dec->options; l; l = l->next) {
 533                 o = l->data;
 534                 g_free(o->id);
 535                 g_free(o->desc);
 536                 g_variant_unref(o->def);
 537                 g_free(o);
 538         }
 539         g_slist_free(dec->options);
 540
 541         free_probes(dec->probes);
 542         free_probes(dec->opt_probes);
 543         g_free(dec->id);
 544         g_free(dec->name);
 545         g_free(dec->longname);
 546         g_free(dec->desc);
 547         g_free(dec->license);
 548
 549         /* The module's Decoder class. */
 550         Py_XDECREF(dec->py_dec);
 551         /* The module itself. */
 552         Py_XDECREF(dec->py_mod);
 553
 554         g_free(dec);
 555
 556         return SRD_OK;
 557 }
 558
 559 /**
 560  * Load all installed protocol decoders.
 561  *
 562  * @return SRD_OK upon success, a (negative) error code otherwise.
 563  *
 564  * @since 0.1.0
 565  */
 566 SRD_API int srd_decoder_load_all(void)
 567 {
 568         GDir *dir;
 569         GError *error;
 570         const gchar *direntry;
 571
 572         if (!srd_check_init())
 573                 return SRD_ERR;
 574
 575         if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
 576                 srd_err("Unable to open %s for reading.", DECODERS_DIR);
 577                 return SRD_ERR_DECODERS_DIR;
 578         }
 579
 580         while ((direntry = g_dir_read_name(dir)) != NULL) {
 581                 /* The directory name is the module name (e.g. "i2c"). */
 582                 srd_decoder_load(direntry);
 583         }
 584         g_dir_close(dir);
 585
 586         return SRD_OK;
 587 }
 588
 589 /**
 590  * Unload all loaded protocol decoders.
 591  *
 592  * @return SRD_OK upon success, a (negative) error code otherwise.
 593  *
 594  * @since 0.1.0
 595  */
 596 SRD_API int srd_decoder_unload_all(void)
 597 {
 598         GSList *l;
 599         struct srd_decoder *dec;
 600
 601         for (l = pd_list; l; l = l->next) {
 602                 dec = l->data;
 603                 srd_decoder_unload(dec);
 604         }
 605
 606         return SRD_OK;
 607 }
 608
 609 /** @} */