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