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         ret = SRD_ERR_PYTHON;
 101         py_probelist = py_entry = NULL;
 102
 103         py_probelist = PyObject_GetAttrString(d->py_dec, attr);
 104         if (!PyList_Check(py_probelist)) {
 105                 srd_err("Protocol decoder %s %s attribute is not "
 106                         "a list.", d->name, attr);
 107                 goto err_out;
 108         }
 109
 110         num_probes = PyList_Size(py_probelist);
 111         if (num_probes == 0)
 112                 /* Empty probelist. */
 113                 return SRD_OK;
 114
 115         for (i = 0; i < num_probes; i++) {
 116                 py_entry = PyList_GetItem(py_probelist, i);
 117                 if (!PyDict_Check(py_entry)) {
 118                         srd_err("Protocol decoder %s %s attribute is not "
 119                                 "a list with dict elements.", d->name, attr);
 120                         goto err_out;
 121                 }
 122
 123                 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
 124                         srd_err("Failed to g_malloc() struct srd_probe.");
 125                         ret = SRD_ERR_MALLOC;
 126                         goto err_out;
 127                 }
 128
 129                 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
 130                         goto err_out;
 131                 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
 132                         goto err_out;
 133                 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
 134                         goto err_out;
 135                 p->order = i;
 136
 137                 *pl = g_slist_append(*pl, p);
 138         }
 139         ret = SRD_OK;
 140
 141 err_out:
 142         Py_DecRef(py_entry);
 143         Py_DecRef(py_probelist);
 144
 145         return ret;
 146 }
 147
 148 static int get_options(struct srd_decoder *d)
 149 {
 150         PyObject *py_opts, *py_keys, *py_values, *py_val, *py_desc, *py_default;
 151         Py_ssize_t i;
 152         struct srd_decoder_option *o;
 153         gint64 def_long;
 154         int num_keys, overflow, ret;
 155         char *key, *def_str;
 156
 157         ret = SRD_ERR_PYTHON;
 158         key = NULL;
 159
 160         if (!PyObject_HasAttrString(d->py_dec, "options"))
 161                 /* That's fine. */
 162                 return SRD_OK;
 163
 164         /* If present, options must be a dictionary. */
 165         py_opts = PyObject_GetAttrString(d->py_dec, "options");
 166         if (!PyDict_Check(py_opts)) {
 167                 srd_err("Protocol decoder %s options attribute is not "
 168                         "a dictionary.", d->name);
 169                 goto err_out;
 170         }
 171
 172         py_keys = PyDict_Keys(py_opts);
 173         py_values = PyDict_Values(py_opts);
 174         num_keys = PyList_Size(py_keys);
 175         for (i = 0; i < num_keys; i++) {
 176                 py_str_as_str(PyList_GetItem(py_keys, i), &key);
 177                 srd_dbg("option '%s'", key);
 178                 py_val = PyList_GetItem(py_values, i);
 179                 if (!PyList_Check(py_val) || PyList_Size(py_val) != 2) {
 180                         srd_err("Protocol decoder %s option '%s' value must be "
 181                                         "a list with two elements.", d->name, key);
 182                         goto err_out;
 183                 }
 184                 py_desc = PyList_GetItem(py_val, 0);
 185                 if (!PyUnicode_Check(py_desc)) {
 186                         srd_err("Protocol decoder %s option '%s' has no "
 187                                         "description.", d->name, key);
 188                         goto err_out;
 189                 }
 190                 py_default = PyList_GetItem(py_val, 1);
 191                 if (!PyUnicode_Check(py_default) && !PyLong_Check(py_default)) {
 192                         srd_err("Protocol decoder %s option '%s' has default "
 193                                         "of unsupported type '%s'.", d->name, key,
 194                                         Py_TYPE(py_default)->tp_name);
 195                         goto err_out;
 196                 }
 197                 if (!(o = g_try_malloc(sizeof(struct srd_decoder_option)))) {
 198                         srd_err("option malloc failed");
 199                         goto err_out;
 200                 }
 201                 o->id = g_strdup(key);
 202                 py_str_as_str(py_desc, &o->desc);
 203                 if (PyUnicode_Check(py_default)) {
 204                         /* UTF-8 string */
 205                         py_str_as_str(py_default, &def_str);
 206                         o->def = g_variant_new_string(def_str);
 207                         g_free(def_str);
 208                 } else {
 209                         /* Long */
 210                         def_long = PyLong_AsLongAndOverflow(py_default, &overflow);
 211                         if (overflow) {
 212                                 /* Value is < LONG_MIN or > LONG_MAX */
 213                                 PyErr_Clear();
 214                                 srd_err("Protocol decoder %s option '%s' has "
 215                                                 "invalid default value.", d->name, key);
 216                                 goto err_out;
 217                         }
 218                         o->def = g_variant_new_int64(def_long);
 219                 }
 220                 g_variant_ref_sink(o->def);
 221                 d->options = g_slist_append(d->options, o);
 222                 g_free(key);
 223                 key = NULL;
 224         }
 225         Py_DecRef(py_keys);
 226         Py_DecRef(py_values);
 227
 228         ret = SRD_OK;
 229
 230 err_out:
 231         Py_XDECREF(py_opts);
 232         g_free(key);
 233
 234         return ret;
 235 }
 236
 237 /**
 238  * Load a protocol decoder module into the embedded Python interpreter.
 239  *
 240  * @param module_name The module name to be loaded.
 241  *
 242  * @return SRD_OK upon success, a (negative) error code otherwise.
 243  *
 244  * @since 0.1.0
 245  */
 246 SRD_API int srd_decoder_load(const char *module_name)
 247 {
 248         PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann, \
 249                 *py_bin_classes, *py_bin_class;
 250         struct srd_decoder *d;
 251         int len, ret, i;
 252         char **ann, *bin;
 253         struct srd_probe *p;
 254         GSList *l;
 255
 256         if (!srd_check_init())
 257                 return SRD_ERR;
 258
 259         if (!module_name)
 260                 return SRD_ERR_ARG;
 261
 262         srd_dbg("Loading protocol decoder '%s'.", module_name);
 263
 264         py_basedec = py_method = py_attr = NULL;
 265
 266         if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
 267                 srd_dbg("Failed to g_malloc() struct srd_decoder.");
 268                 ret = SRD_ERR_MALLOC;
 269                 goto err_out;
 270         }
 271
 272         ret = SRD_ERR_PYTHON;
 273
 274         /* Import the Python module. */
 275         if (!(d->py_mod = PyImport_ImportModule(module_name))) {
 276                 srd_exception_catch("Import of '%s' failed.", module_name);
 277                 goto err_out;
 278         }
 279
 280         /* Get the 'Decoder' class as Python object. */
 281         if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
 282                 /* This generated an AttributeError exception. */
 283                 PyErr_Clear();
 284                 srd_err("Decoder class not found in protocol decoder %s.",
 285                         module_name);
 286                 goto err_out;
 287         }
 288
 289         if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
 290                 srd_dbg("sigrokdecode module not loaded.");
 291                 goto err_out;
 292         }
 293
 294         if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
 295                 srd_err("Decoder class in protocol decoder module %s is not "
 296                         "a subclass of sigrokdecode.Decoder.", module_name);
 297                 goto err_out;
 298         }
 299         Py_CLEAR(py_basedec);
 300
 301         /* Check for a proper start() method. */
 302         if (!PyObject_HasAttrString(d->py_dec, "start")) {
 303                 srd_err("Protocol decoder %s has no start() method Decoder "
 304                         "class.", module_name);
 305                 goto err_out;
 306         }
 307         py_method = PyObject_GetAttrString(d->py_dec, "start");
 308         if (!PyFunction_Check(py_method)) {
 309                 srd_err("Protocol decoder %s Decoder class attribute 'start' "
 310                         "is not a method.", module_name);
 311                 goto err_out;
 312         }
 313         Py_CLEAR(py_method);
 314
 315         /* Check for a proper decode() method. */
 316         if (!PyObject_HasAttrString(d->py_dec, "decode")) {
 317                 srd_err("Protocol decoder %s has no decode() method Decoder "
 318                         "class.", module_name);
 319                 goto err_out;
 320         }
 321         py_method = PyObject_GetAttrString(d->py_dec, "decode");
 322         if (!PyFunction_Check(py_method)) {
 323                 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
 324                         "is not a method.", module_name);
 325                 goto err_out;
 326         }
 327         Py_CLEAR(py_method);
 328
 329         if (get_options(d) != SRD_OK)
 330                 goto err_out;
 331
 332         /* Check and import required probes. */
 333         if (get_probes(d, "probes", &d->probes) != SRD_OK)
 334                 goto err_out;
 335
 336         /* Check and import optional probes. */
 337         if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
 338                 goto err_out;
 339
 340         /*
 341          * Fix order numbers for the optional probes.
 342          *
 343          * Example:
 344          * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
 345          * 'order' fields in the d->probes list = 0, 1, 2.
 346          * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
 347          */
 348         for (l = d->opt_probes; l; l = l->next) {
 349                 p = l->data;
 350                 p->order += g_slist_length(d->probes);
 351         }
 352
 353         /* Store required fields in newly allocated strings. */
 354         if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
 355                 goto err_out;
 356
 357         if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
 358                 goto err_out;
 359
 360         if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
 361                 goto err_out;
 362
 363         if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
 364                 goto err_out;
 365
 366         if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
 367                 goto err_out;
 368
 369         /* Convert annotation class attribute to GSList of char **. */
 370         d->annotations = NULL;
 371         if (PyObject_HasAttrString(d->py_dec, "annotations")) {
 372                 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
 373                 if (!PyList_Check(py_annlist)) {
 374                         srd_err("Protocol decoder module %s annotations "
 375                                 "should be a list.", module_name);
 376                         goto err_out;
 377                 }
 378                 len = PyList_Size(py_annlist);
 379                 for (i = 0; i < len; i++) {
 380                         py_ann = PyList_GetItem(py_annlist, i);
 381                         if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
 382                                 srd_err("Protocol decoder module %s "
 383                                         "annotation %d should be a list with "
 384                                         "two elements.", module_name, i + 1);
 385                                 goto err_out;
 386                         }
 387
 388                         if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
 389                                 goto err_out;
 390                         }
 391                         d->annotations = g_slist_append(d->annotations, ann);
 392                 }
 393         }
 394
 395         /* Convert binary class to GSList of char *. */
 396         d->binary = NULL;
 397         if (PyObject_HasAttrString(d->py_dec, "binary")) {
 398                 py_bin_classes = PyObject_GetAttrString(d->py_dec, "binary");
 399                 if (!PyTuple_Check(py_bin_classes)) {
 400                         srd_err("Protocol decoder module %s binary classes "
 401                                 "should be a tuple.", module_name);
 402                         goto err_out;
 403                 }
 404                 len = PyTuple_Size(py_bin_classes);
 405                 for (i = 0; i < len; i++) {
 406                         py_bin_class = PyTuple_GetItem(py_bin_classes, i);
 407                         if (!PyUnicode_Check(py_bin_class)) {
 408                                 srd_err("Protocol decoder module %s binary "
 409                                                 "class should be a string.", module_name);
 410                                 goto err_out;
 411                         }
 412
 413                         if (py_str_as_str(py_bin_class, &bin) != SRD_OK) {
 414                                 goto err_out;
 415                         }
 416                         d->binary = g_slist_append(d->binary, bin);
 417                 }
 418         }
 419
 420         /* Append it to the list of supported/loaded decoders. */
 421         pd_list = g_slist_append(pd_list, d);
 422
 423         ret = SRD_OK;
 424
 425 err_out:
 426         if (ret != SRD_OK) {
 427                 Py_XDECREF(py_method);
 428                 Py_XDECREF(py_basedec);
 429                 Py_XDECREF(d->py_dec);
 430                 Py_XDECREF(d->py_mod);
 431                 g_free(d);
 432         }
 433
 434         return ret;
 435 }
 436
 437 /**
 438  * Return a protocol decoder's docstring.
 439  *
 440  * @param dec The loaded protocol decoder.
 441  *
 442  * @return A newly allocated buffer containing the protocol decoder's
 443  *         documentation. The caller is responsible for free'ing the buffer.
 444  *
 445  * @since 0.1.0
 446  */
 447 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 448 {
 449         PyObject *py_str;
 450         char *doc;
 451
 452         if (!srd_check_init())
 453                 return NULL;
 454
 455         if (!dec)
 456                 return NULL;
 457
 458         if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
 459                 return NULL;
 460
 461         if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
 462                 srd_exception_catch("");
 463                 return NULL;
 464         }
 465
 466         doc = NULL;
 467         if (py_str != Py_None)
 468                 py_str_as_str(py_str, &doc);
 469         Py_DecRef(py_str);
 470
 471         return doc;
 472 }
 473
 474 static void free_probes(GSList *probelist)
 475 {
 476         GSList *l;
 477         struct srd_probe *p;
 478
 479         if (probelist == NULL)
 480                 return;
 481
 482         for (l = probelist; l; l = l->next) {
 483                 p = l->data;
 484                 g_free(p->id);
 485                 g_free(p->name);
 486                 g_free(p->desc);
 487                 g_free(p);
 488         }
 489         g_slist_free(probelist);
 490 }
 491
 492 /**
 493  * Unload the specified protocol decoder.
 494  *
 495  * @param dec The struct srd_decoder to be unloaded.
 496  *
 497  * @return SRD_OK upon success, a (negative) error code otherwise.
 498  *
 499  * @since 0.1.0
 500  */
 501 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 502 {
 503         struct srd_decoder_option *o;
 504         struct srd_session *sess;
 505         GSList *l;
 506
 507         if (!srd_check_init())
 508                 return SRD_ERR;
 509
 510         if (!dec)
 511                 return SRD_ERR_ARG;
 512
 513         srd_dbg("Unloading protocol decoder '%s'.", dec->name);
 514
 515         /*
 516          * Since any instances of this decoder need to be released as well,
 517          * but they could be anywhere in the stack, just free the entire
 518          * stack. A frontend reloading a decoder thus has to restart all
 519          * instances, and rebuild the stack.
 520          */
 521         for (l = sessions; l; l = l->next) {
 522                 sess = l->data;
 523                 srd_inst_free_all(sess, NULL);
 524         }
 525
 526         for (l = dec->options; l; l = l->next) {
 527                 o = l->data;
 528                 g_free(o->id);
 529                 g_free(o->desc);
 530                 g_variant_unref(o->def);
 531                 g_free(o);
 532         }
 533         g_slist_free(dec->options);
 534
 535         free_probes(dec->probes);
 536         free_probes(dec->opt_probes);
 537         g_free(dec->id);
 538         g_free(dec->name);
 539         g_free(dec->longname);
 540         g_free(dec->desc);
 541         g_free(dec->license);
 542
 543         /* The module's Decoder class. */
 544         Py_XDECREF(dec->py_dec);
 545         /* The module itself. */
 546         Py_XDECREF(dec->py_mod);
 547
 548         g_free(dec);
 549
 550         return SRD_OK;
 551 }
 552
 553 /**
 554  * Load all installed protocol decoders.
 555  *
 556  * @return SRD_OK upon success, a (negative) error code otherwise.
 557  *
 558  * @since 0.1.0
 559  */
 560 SRD_API int srd_decoder_load_all(void)
 561 {
 562         GDir *dir;
 563         GError *error;
 564         const gchar *direntry;
 565
 566         if (!srd_check_init())
 567                 return SRD_ERR;
 568
 569         if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
 570                 srd_err("Unable to open %s for reading.", DECODERS_DIR);
 571                 return SRD_ERR_DECODERS_DIR;
 572         }
 573
 574         while ((direntry = g_dir_read_name(dir)) != NULL) {
 575                 /* The directory name is the module name (e.g. "i2c"). */
 576                 srd_decoder_load(direntry);
 577         }
 578         g_dir_close(dir);
 579
 580         return SRD_OK;
 581 }
 582
 583 /**
 584  * Unload all loaded protocol decoders.
 585  *
 586  * @return SRD_OK upon success, a (negative) error code otherwise.
 587  *
 588  * @since 0.1.0
 589  */
 590 SRD_API int srd_decoder_unload_all(void)
 591 {
 592         GSList *l;
 593         struct srd_decoder *dec;
 594
 595         for (l = pd_list; l; l = l->next) {
 596                 dec = l->data;
 597                 srd_decoder_unload(dec);
 598         }
 599
 600         return SRD_OK;
 601 }
 602
 603 /** @} */