decoder.c

   1 /*
   2  * This file is part of the sigrok 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 /** @cond PRIVATE */
  33
  34 /* The list of protocol decoders. */
  35 SRD_PRIV GSList *pd_list = NULL;
  36
  37 /* module_sigrokdecode.c */
  38 extern SRD_PRIV PyObject *mod_sigrokdecode;
  39
  40 /** @endcond */
  41
  42 /**
  43  * Returns the list of supported/loaded protocol decoders.
  44  *
  45  * This is a GSList containing the names of the decoders as strings.
  46  *
  47  * @return List of decoders, NULL if none are supported or loaded.
  48  */
  49 SRD_API const GSList *srd_decoder_list(void)
  50 {
  51         return pd_list;
  52 }
  53
  54 /**
  55  * Get the decoder with the specified ID.
  56  *
  57  * @param id The ID string of the decoder to return.
  58  *
  59  * @return The decoder with the specified ID, or NULL if not found.
  60  */
  61 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
  62 {
  63         GSList *l;
  64         struct srd_decoder *dec;
  65
  66         for (l = pd_list; l; l = l->next) {
  67                 dec = l->data;
  68                 if (!strcmp(dec->id, id))
  69                         return dec;
  70         }
  71
  72         return NULL;
  73 }
  74
  75 static int get_probes(const struct srd_decoder *d, const char *attr,
  76                       GSList **pl)
  77 {
  78         PyObject *py_probelist, *py_entry;
  79         struct srd_probe *p;
  80         int ret, num_probes, i;
  81
  82         if (!PyObject_HasAttrString(d->py_dec, attr))
  83                 /* No probes of this type specified. */
  84                 return SRD_OK;
  85
  86         ret = SRD_ERR_PYTHON;
  87         py_probelist = py_entry = NULL;
  88
  89         py_probelist = PyObject_GetAttrString(d->py_dec, attr);
  90         if (!PyList_Check(py_probelist)) {
  91                 srd_err("Protocol decoder %s %s attribute is not "
  92                         "a list.", d->name, attr);
  93                 goto err_out;
  94         }
  95
  96         num_probes = PyList_Size(py_probelist);
  97         if (num_probes == 0)
  98                 /* Empty probelist. */
  99                 return SRD_OK;
 100
 101         for (i = 0; i < num_probes; i++) {
 102                 py_entry = PyList_GetItem(py_probelist, i);
 103                 if (!PyDict_Check(py_entry)) {
 104                         srd_err("Protocol decoder %s %s attribute is not "
 105                                 "a list with dict elements.", d->name, attr);
 106                         goto err_out;
 107                 }
 108
 109                 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
 110                         srd_err("Failed to g_malloc() struct srd_probe.");
 111                         ret = SRD_ERR_MALLOC;
 112                         goto err_out;
 113                 }
 114
 115                 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
 116                         goto err_out;
 117                 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
 118                         goto err_out;
 119                 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
 120                         goto err_out;
 121                 p->order = i;
 122
 123                 *pl = g_slist_append(*pl, p);
 124         }
 125         ret = SRD_OK;
 126
 127 err_out:
 128         Py_DecRef(py_entry);
 129         Py_DecRef(py_probelist);
 130
 131         return ret;
 132 }
 133
 134 /**
 135  * Load a protocol decoder module into the embedded Python interpreter.
 136  *
 137  * @param module_name The module name to be loaded.
 138  *
 139  * @return SRD_OK upon success, a (negative) error code otherwise.
 140  */
 141 SRD_API int srd_decoder_load(const char *module_name)
 142 {
 143         PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
 144         struct srd_decoder *d;
 145         int alen, ret, i;
 146         char **ann;
 147         struct srd_probe *p;
 148         GSList *l;
 149
 150         srd_dbg("Loading protocol decoder '%s'.", module_name);
 151
 152         py_basedec = py_method = py_attr = NULL;
 153
 154         if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
 155                 srd_dbg("Failed to g_malloc() struct srd_decoder.");
 156                 ret = SRD_ERR_MALLOC;
 157                 goto err_out;
 158         }
 159
 160         ret = SRD_ERR_PYTHON;
 161
 162         /* Import the Python module. */
 163         if (!(d->py_mod = PyImport_ImportModule(module_name))) {
 164                 srd_exception_catch("Import of '%s' failed.", module_name);
 165                 goto err_out;
 166         }
 167
 168         /* Get the 'Decoder' class as Python object. */
 169         if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
 170                 /* This generated an AttributeError exception. */
 171                 PyErr_Clear();
 172                 srd_err("Decoder class not found in protocol decoder %s.",
 173                         module_name);
 174                 goto err_out;
 175         }
 176
 177         if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
 178                 srd_dbg("sigrokdecode module not loaded.");
 179                 goto err_out;
 180         }
 181
 182         if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
 183                 srd_err("Decoder class in protocol decoder module %s is not "
 184                         "a subclass of sigrokdecode.Decoder.", module_name);
 185                 goto err_out;
 186         }
 187         Py_CLEAR(py_basedec);
 188
 189         /* Check for a proper start() method. */
 190         if (!PyObject_HasAttrString(d->py_dec, "start")) {
 191                 srd_err("Protocol decoder %s has no start() method Decoder "
 192                         "class.", module_name);
 193                 goto err_out;
 194         }
 195         py_method = PyObject_GetAttrString(d->py_dec, "start");
 196         if (!PyFunction_Check(py_method)) {
 197                 srd_err("Protocol decoder %s Decoder class attribute 'start' "
 198                         "is not a method.", module_name);
 199                 goto err_out;
 200         }
 201         Py_CLEAR(py_method);
 202
 203         /* Check for a proper decode() method. */
 204         if (!PyObject_HasAttrString(d->py_dec, "decode")) {
 205                 srd_err("Protocol decoder %s has no decode() method Decoder "
 206                         "class.", module_name);
 207                 goto err_out;
 208         }
 209         py_method = PyObject_GetAttrString(d->py_dec, "decode");
 210         if (!PyFunction_Check(py_method)) {
 211                 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
 212                         "is not a method.", module_name);
 213                 goto err_out;
 214         }
 215         Py_CLEAR(py_method);
 216
 217         /* If present, options must be a dictionary. */
 218         if (PyObject_HasAttrString(d->py_dec, "options")) {
 219                 py_attr = PyObject_GetAttrString(d->py_dec, "options");
 220                 if (!PyDict_Check(py_attr)) {
 221                         srd_err("Protocol decoder %s options attribute is not "
 222                                 "a dictionary.", d->name);
 223                         Py_DecRef(py_attr);
 224                         goto err_out;
 225                 }
 226                 Py_DecRef(py_attr);
 227         }
 228
 229         /* Check and import required probes. */
 230         if (get_probes(d, "probes", &d->probes) != SRD_OK)
 231                 goto err_out;
 232
 233         /* Check and import optional probes. */
 234         if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
 235                 goto err_out;
 236
 237         /*
 238          * Fix order numbers for the optional probes.
 239          *
 240          * Example:
 241          * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
 242          * 'order' fields in the d->probes list = 0, 1, 2.
 243          * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
 244          */
 245         for (l = d->opt_probes; l; l = l->next) {
 246                 p = l->data;
 247                 p->order += g_slist_length(d->probes);
 248         }
 249
 250         /* Store required fields in newly allocated strings. */
 251         if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
 252                 goto err_out;
 253
 254         if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
 255                 goto err_out;
 256
 257         if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
 258                 goto err_out;
 259
 260         if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
 261                 goto err_out;
 262
 263         if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
 264                 goto err_out;
 265
 266         /* Convert class annotation attribute to GSList of **char. */
 267         d->annotations = NULL;
 268         if (PyObject_HasAttrString(d->py_dec, "annotations")) {
 269                 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
 270                 if (!PyList_Check(py_annlist)) {
 271                         srd_err("Protocol decoder module %s annotations "
 272                                 "should be a list.", module_name);
 273                         goto err_out;
 274                 }
 275                 alen = PyList_Size(py_annlist);
 276                 for (i = 0; i < alen; i++) {
 277                         py_ann = PyList_GetItem(py_annlist, i);
 278                         if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
 279                                 srd_err("Protocol decoder module %s "
 280                                         "annotation %d should be a list with "
 281                                         "two elements.", module_name, i + 1);
 282                                 goto err_out;
 283                         }
 284
 285                         if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
 286                                 goto err_out;
 287                         }
 288                         d->annotations = g_slist_append(d->annotations, ann);
 289                 }
 290         }
 291
 292         /* Append it to the list of supported/loaded decoders. */
 293         pd_list = g_slist_append(pd_list, d);
 294
 295         ret = SRD_OK;
 296
 297 err_out:
 298         if (ret != SRD_OK) {
 299                 Py_XDECREF(py_method);
 300                 Py_XDECREF(py_basedec);
 301                 Py_XDECREF(d->py_dec);
 302                 Py_XDECREF(d->py_mod);
 303                 g_free(d);
 304         }
 305
 306         return ret;
 307 }
 308
 309 /**
 310  * Return a protocol decoder's docstring.
 311  *
 312  * @param dec The loaded protocol decoder.
 313  *
 314  * @return A newly allocated buffer containing the protocol decoder's
 315  *         documentation. The caller is responsible for free'ing the buffer.
 316  */
 317 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 318 {
 319         PyObject *py_str;
 320         char *doc;
 321
 322         if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
 323                 return NULL;
 324
 325         if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
 326                 srd_exception_catch("");
 327                 return NULL;
 328         }
 329
 330         doc = NULL;
 331         if (py_str != Py_None)
 332                 py_str_as_str(py_str, &doc);
 333         Py_DecRef(py_str);
 334
 335         return doc;
 336 }
 337
 338 static void free_probes(GSList *probelist)
 339 {
 340         GSList *l;
 341         struct srd_probe *p;
 342
 343         if (probelist == NULL)
 344                 return;
 345
 346         for (l = probelist; l; l = l->next) {
 347                 p = l->data;
 348                 g_free(p->id);
 349                 g_free(p->name);
 350                 g_free(p->desc);
 351                 g_free(p);
 352         }
 353         g_slist_free(probelist);
 354 }
 355
 356 /**
 357  * Unload decoder module.
 358  *
 359  * @param dec The struct srd_decoder to be unloaded.
 360  *
 361  * @return SRD_OK upon success, a (negative) error code otherwise.
 362  */
 363 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
 364 {
 365         srd_dbg("Unloading protocol decoder '%s'.", dec->name);
 366
 367         /*
 368          * Since any instances of this decoder need to be released as well,
 369          * but they could be anywhere in the stack, just free the entire
 370          * stack. A frontend reloading a decoder thus has to restart all
 371          * instances, and rebuild the stack.
 372          */
 373         srd_inst_free_all(NULL);
 374
 375         free_probes(dec->probes);
 376         free_probes(dec->opt_probes);
 377         g_free(dec->id);
 378         g_free(dec->name);
 379         g_free(dec->longname);
 380         g_free(dec->desc);
 381         g_free(dec->license);
 382
 383         /* The module's Decoder class. */
 384         Py_XDECREF(dec->py_dec);
 385         /* The module itself. */
 386         Py_XDECREF(dec->py_mod);
 387
 388         /* TODO: (g_)free dec itself? */
 389
 390         return SRD_OK;
 391 }
 392
 393 /**
 394  * Load all installed protocol decoders.
 395  *
 396  * @return SRD_OK upon success, a (negative) error code otherwise.
 397  */
 398 SRD_API int srd_decoder_load_all(void)
 399 {
 400         GDir *dir;
 401         GError *error;
 402         const gchar *direntry;
 403
 404         if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
 405                 srd_err("Unable to open %s for reading.", DECODERS_DIR);
 406                 return SRD_ERR_DECODERS_DIR;
 407         }
 408
 409         while ((direntry = g_dir_read_name(dir)) != NULL) {
 410                 /* The directory name is the module name (e.g. "i2c"). */
 411                 srd_decoder_load(direntry);
 412         }
 413         g_dir_close(dir);
 414
 415         return SRD_OK;
 416 }
 417
 418 /**
 419  * Unload all loaded protocol decoders.
 420  *
 421  * @return SRD_OK upon success, a (negative) error code otherwise.
 422  */
 423 SRD_API int srd_decoder_unload_all(void)
 424 {
 425         GSList *l;
 426         struct srd_decoder *dec;
 427
 428         for (l = pd_list; l; l = l->next) {
 429                 dec = l->data;
 430                 srd_decoder_unload(dec);
 431         }
 432
 433         return SRD_OK;
 434 }