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) 2011 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 <glib.h>
  22 #include "config.h"
  23 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  24 #include "sigrokdecode-internal.h"
  25
  26 /* The list of protocol decoders. */
  27 GSList *pd_list = NULL;
  28
  29 /* lives in module_sigrokdecode.c */
  30 extern PyObject *mod_sigrokdecode;
  31
  32
  33 /**
  34  * Returns the list of supported/loaded protocol decoders.
  35  *
  36  * This is a GSList containing the names of the decoders as strings.
  37  *
  38  * @return List of decoders, NULL if none are supported or loaded.
  39  */
  40 GSList *srd_list_decoders(void)
  41 {
  42
  43         return pd_list;
  44 }
  45
  46
  47 /**
  48  * Get the decoder with the specified ID.
  49  *
  50  * @param id The ID string of the decoder to return.
  51  * @return The decoder with the specified ID, or NULL if not found.
  52  */
  53 struct srd_decoder *srd_get_decoder_by_id(const char *id)
  54 {
  55         GSList *l;
  56         struct srd_decoder *dec;
  57
  58         for (l = srd_list_decoders(); l; l = l->next) {
  59                 dec = l->data;
  60                 if (!strcmp(dec->id, id))
  61                         return dec;
  62         }
  63
  64         return NULL;
  65 }
  66
  67
  68 /**
  69  * Load a protocol decoder module into the embedded Python interpreter.
  70  *
  71  * @param name The module name to be loaded.
  72  * @param dec Pointer to the struct srd_decoder filled with the loaded module.
  73  *
  74  * @return SRD_OK upon success, a (negative) error code otherwise.
  75  */
  76 int srd_load_decoder(const char *name, struct srd_decoder **dec)
  77 {
  78         PyObject *py_basedec, *py_annlist, *py_ann;
  79         struct srd_decoder *d;
  80         int alen, ret, i;
  81         char **ann;
  82
  83         py_basedec = NULL;
  84         ret = SRD_ERR;
  85
  86         srd_dbg("decoder: %s: loading module '%s'", __func__, name);
  87
  88         if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
  89                 srd_err("decoder: %s: d malloc failed", __func__);
  90                 ret = SRD_ERR_MALLOC;
  91                 goto err_out;
  92         }
  93
  94         /* Import the Python module. */
  95         if (!(d->py_mod = PyImport_ImportModule(name))) {
  96                 /* TODO: Report exception message/traceback to err/dbg. */
  97                 srd_warn("decoder: %s: import of '%s' failed", __func__, name);
  98                 PyErr_Print();
  99                 PyErr_Clear();
 100                 ret = SRD_ERR_PYTHON;
 101                 goto err_out;
 102         }
 103
 104         /* Get the 'Decoder' class as Python object. */
 105         if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
 106                 /* This generated an AttributeError exception. */
 107                 PyErr_Print();
 108                 PyErr_Clear();
 109                 srd_err("Decoder class not found in protocol decoder module %s", name);
 110                 ret = SRD_ERR_PYTHON;
 111                 goto err_out;
 112         }
 113
 114         if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
 115                 srd_dbg("sigrokdecode module not loaded");
 116                 ret = SRD_ERR_PYTHON;
 117                 goto err_out;
 118         }
 119
 120         if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
 121                 srd_err("Decoder class in protocol decoder module %s is not "
 122                                 "a subclass of sigrokdecode.Decoder", name);
 123                 ret = SRD_ERR_PYTHON;
 124                 goto err_out;
 125         }
 126         Py_DecRef(py_basedec);
 127
 128         if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) {
 129                 return SRD_ERR_PYTHON;
 130                 goto err_out;
 131         }
 132
 133         if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK) {
 134                 return SRD_ERR_PYTHON;
 135                 goto err_out;
 136         }
 137
 138         if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK) {
 139                 return SRD_ERR_PYTHON;
 140                 goto err_out;
 141         }
 142
 143         if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK) {
 144                 return SRD_ERR_PYTHON;
 145                 goto err_out;
 146         }
 147
 148         if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) {
 149                 return SRD_ERR_PYTHON;
 150                 goto err_out;
 151         }
 152
 153         /* TODO: Handle inputformats, outputformats. */
 154         d->inputformats = NULL;
 155         d->outputformats = NULL;
 156
 157         /* Convert class annotation attribute to GSList of **char */
 158         d->annotations = NULL;
 159         if (PyObject_HasAttrString(d->py_dec, "annotations")) {
 160                 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
 161                 if (!PyList_Check(py_annlist)) {
 162                         srd_err("Protocol decoder module %s annotations should be a list", name);
 163                         ret = SRD_ERR_PYTHON;
 164                         goto err_out;
 165                 }
 166                 alen = PyList_Size(py_annlist);
 167                 for (i = 0; i < alen; i++) {
 168                         py_ann = PyList_GetItem(py_annlist, i);
 169                         if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
 170                                 srd_err("Protocol decoder module %s annotation %d should be a list with two elements",
 171                                                 name, i+1);
 172                                 ret = SRD_ERR_PYTHON;
 173                                 goto err_out;
 174                         }
 175
 176                         if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
 177                                 ret = SRD_ERR_PYTHON;
 178                                 goto err_out;
 179                         }
 180                         d->annotations = g_slist_append(d->annotations, ann);
 181                 }
 182         }
 183
 184         *dec = d;
 185         ret = SRD_OK;
 186
 187 err_out:
 188         if (ret != SRD_OK) {
 189                 Py_XDECREF(py_basedec);
 190                 Py_XDECREF(d->py_dec);
 191                 Py_XDECREF(d->py_mod);
 192                 g_free(d);
 193         }
 194
 195         return ret;
 196 }
 197
 198 char *srd_decoder_doc(struct srd_decoder *dec)
 199 {
 200         PyObject *py_str;
 201         char *doc;
 202
 203         if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
 204                 return NULL;
 205
 206         if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
 207                 PyErr_Clear();
 208                 return NULL;
 209         }
 210
 211         doc = NULL;
 212         if (py_str != Py_None)
 213                 py_str_as_str(py_str, &doc);
 214         Py_DecRef(py_str);
 215
 216         return doc;
 217 }
 218
 219
 220 /**
 221  * Unload decoder module.
 222  *
 223  * @param dec The decoder struct to be unloaded.
 224  *
 225  * @return SRD_OK upon success, a (negative) error code otherwise.
 226  */
 227 int srd_unload_decoder(struct srd_decoder *dec)
 228 {
 229
 230         g_free(dec->id);
 231         g_free(dec->name);
 232         g_free(dec->longname);
 233         g_free(dec->desc);
 234         g_free(dec->license);
 235
 236         /* TODO: Free everything in inputformats and outputformats. */
 237         if (dec->inputformats != NULL)
 238                 g_slist_free(dec->inputformats);
 239         if (dec->outputformats != NULL)
 240                 g_slist_free(dec->outputformats);
 241
 242         Py_XDECREF(dec->py_dec);
 243         Py_XDECREF(dec->py_mod);
 244
 245         /* TODO: (g_)free dec itself? */
 246
 247         return SRD_OK;
 248 }
 249
 250 /**
 251  * Check if the directory in the specified search path is a valid PD dir.
 252  *
 253  * A valid sigrok protocol decoder consists of a directory, which contains
 254  * at least two .py files (the special __init__.py and at least one additional
 255  * .py file which contains the actual PD code).
 256  *
 257  * TODO: We should also check that this is not a random other Python module,
 258  * but really a sigrok PD module by some means.
 259  *
 260  * @param search_path A string containing the (absolute) path to the directory
 261  *                    where 'entry' resides in.
 262  * @param entry A string containing the (relative) directory name of the
 263  *              sigrok PD module. E.g. "i2c" for the I2C protocol decoder.
 264  * @return SRD_OK, if the directory is a valid sigrok PD, a negative error
 265  *         code, such as SRD_ERR, otherwise.
 266  */
 267 int srd_is_valid_pd_dir(const gchar *search_path, const gchar *entry)
 268 {
 269         GDir *dir;
 270         int py_files = 0, has_init_py = 0;
 271         gchar *path1, *path2, *file;
 272         GError *error;
 273
 274         /* TODO: Error handling. */
 275         path1 = g_build_filename(search_path, entry, NULL);
 276
 277         /* Check that it is a directory (and exists). */
 278         if (!g_file_test(path1, G_FILE_TEST_IS_DIR)) {
 279                 srd_dbg("decoder: %s: '%s' not a directory or doesn't exist",
 280                         __func__, entry);
 281                 return SRD_ERR;
 282         }
 283
 284         if (!(dir = g_dir_open(path1, 0, &error))) { /* TODO: flags? */
 285                 srd_dbg("decoder: %s: '%s' failed to open directory",
 286                         __func__, entry);
 287                 return SRD_ERR;
 288         }
 289
 290         /* Check the contents of the directory. */
 291         while ((file = g_dir_read_name(dir)) != NULL) {
 292                 /* TODO: Error handling. */
 293                 path2 = g_build_filename(path1, file, NULL);
 294
 295                 /* Ignore non-files. */
 296                 if (!g_file_test(path2, G_FILE_TEST_IS_REGULAR)) {
 297                         srd_spew("decoder: %s: '%s' not a file, ignoring",
 298                                  __func__, file);
 299                         continue;
 300                 }
 301
 302                 /* Count number of .py files. */
 303                 if (g_str_has_suffix(path2, ".py")) {
 304                         srd_spew("decoder: %s: found .py file: '%s'",
 305                                  __func__, file);
 306                         py_files++;
 307                 }
 308
 309                 /* Check if it's an __init__.py file. */
 310                 if (g_str_has_suffix(path2, "__init__.py")) {
 311                         srd_spew("decoder: %s: found __init__.py file: '%s'",
 312                                  __func__, path2);
 313                         has_init_py = 1;
 314                 }
 315         }
 316         g_dir_close(dir);
 317
 318         /* Check if the directory contains >= 2 *.py files. */
 319         if (py_files < 2) {
 320                 srd_dbg("decoder: %s: '%s' is not a valid PD dir, it doesn't "
 321                         "contain >= 2 .py files", __func__, entry);
 322                 return SRD_ERR;
 323         }
 324
 325         /* Check if the directory contains an __init__.py file. */
 326         if (!has_init_py) {
 327                 srd_dbg("decoder: %s: '%s' is not a valid PD dir, it doesn't "
 328                         "contain an __init__.py file", __func__, entry);
 329                 return SRD_ERR;
 330         }
 331
 332         /* TODO: Check if it's a PD, not a random other Python module. */
 333
 334         return SRD_OK;
 335 }
 336
 337 int srd_load_all_decoders(void)
 338 {
 339         GDir *dir;
 340         gchar *direntry;
 341         int ret;
 342         char *decodername;
 343         struct srd_decoder *dec;
 344         GError *error;
 345
 346         if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) { /* TODO: flags? */
 347                 Py_Finalize(); /* Returns void. */
 348                 return SRD_ERR_DECODERS_DIR;
 349         }
 350
 351         while ((direntry = g_dir_read_name(dir)) != NULL) {
 352                 /* Ignore directory entries which are not valid PDs. */
 353                 if (srd_is_valid_pd_dir(DECODERS_DIR, direntry) != SRD_OK) {
 354                         srd_dbg("decoder: %s: '%s' not a valid PD dir, "
 355                                 "ignoring it", __func__, direntry);
 356                         continue;
 357                 }
 358
 359                 /* The decoder name is the PD directory name (e.g. "i2c"). */
 360                 decodername = g_strdup(direntry);
 361
 362                 /* TODO: Error handling. Use g_try_malloc(). */
 363                 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
 364                         Py_Finalize(); /* Returns void. */
 365                         return SRD_ERR_MALLOC;
 366                 }
 367
 368                 /* Load the decoder. */
 369                 /* TODO: Warning if loading fails for a decoder. */
 370                 if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) {
 371                         /* Append it to the list of supported/loaded decoders. */
 372                         pd_list = g_slist_append(pd_list, dec);
 373                 }
 374         }
 375         g_dir_close(dir);
 376
 377         return SRD_OK;
 378 }
 379
 380 /**
 381  * TODO
 382  */
 383 int srd_unload_all_decoders(void)
 384 {
 385         GSList *l;
 386         struct srd_decoder *dec;
 387
 388         for (l = srd_list_decoders(); l; l = l->next) {
 389                 dec = l->data;
 390                 /* TODO: Error handling. */
 391                 srd_unload_decoder(dec);
 392         }
 393
 394         return SRD_OK;
 395 }
 396
 397
 398