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