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