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