decode.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include "config.h"
  22 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #include <stdio.h>
  24 #include <string.h>
  25 #include <dirent.h>
  26
  27 /* Re-define some string functions for Python >= 3.0. */
  28 #if PY_VERSION_HEX >= 0x03000000
  29 #define PyString_AsString PyBytes_AsString
  30 #define PyString_FromString PyBytes_FromString
  31 #define PyString_Check PyBytes_Check
  32 #endif
  33
  34 /* The list of protocol decoders. */
  35 static GSList *list_pds = NULL;
  36 /* The list of protocol decoder instances: struct srd_decoder_instance */
  37 static GSList *decoders;
  38
  39 /*
  40  * Here's a quick overview of Python/C API reference counting.
  41  *
  42  * Check the Python/C API docs for what type of reference a function returns.
  43  *
  44  *  - If it returns a "new reference", you're responsible to Py_XDECREF() it.
  45  *
  46  *  - If it returns a "borrowed reference", you MUST NOT Py_XDECREF() it.
  47  *
  48  *  - If a function "steals" a reference, you no longer are responsible for
  49  *    Py_XDECREF()ing it (someone else will do it for you at some point).
  50  */
  51
  52 static int srd_load_decoder(PyObject *py_res);
  53
  54 static PyObject *emb_register(PyObject *self, PyObject *args)
  55 {
  56         PyObject *arg;
  57
  58         (void)self;
  59
  60         if (!PyArg_ParseTuple(args, "O:decoder", &arg))
  61                 return NULL;
  62
  63         srd_load_decoder(arg);
  64
  65         Py_RETURN_NONE;
  66 }
  67
  68 static PyObject *emb_put(PyObject *self, PyObject *args)
  69 {
  70         PyObject *arg;
  71
  72         (void)self;
  73
  74         if (!PyArg_ParseTuple(args, "O:put", &arg))
  75                 return NULL;
  76
  77         PyObject_Print(arg, stdout, Py_PRINT_RAW);
  78         puts("");
  79
  80         Py_RETURN_NONE;
  81 }
  82
  83 static PyMethodDef EmbMethods[] = {
  84         {"register", emb_register, METH_VARARGS,
  85          "Register a protocol decoder object with libsigrokdecode."},
  86         {"put", emb_put, METH_VARARGS,
  87          "Accepts a dictionary with the following keys: time, duration, data"},
  88         {NULL, NULL, 0, NULL}
  89 };
  90
  91 /**
  92  * Initialize libsigrokdecode.
  93  *
  94  * This initializes the Python interpreter, and creates and initializes
  95  * a "sigrok" Python module with a single put() method.
  96  *
  97  * Then, it searches for sigrok protocol decoder files (*.py) in the
  98  * "decoders" subdirectory of the the sigrok installation directory.
  99  * All decoders that are found are loaded into memory and added to an
 100  * internal list of decoders, which can be queried via srd_list_decoders().
 101  *
 102  * The caller is responsible for calling the clean-up function srd_exit(),
 103  * which will properly shut down libsigrokdecode and free its allocated memory.
 104  *
 105  * Multiple calls to srd_init(), without calling srd_exit() inbetween,
 106  * are not allowed.
 107  *
 108  * @return SRD_OK upon success, a (negative) error code otherwise.
 109  *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
 110  *         directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
 111  *         If not enough memory could be allocated, return SRD_ERR_MALLOC.
 112  */
 113 int srd_init(void)
 114 {
 115         DIR *dir;
 116         struct dirent *dp;
 117         char *decodername;
 118         struct srd_decoder *dec;
 119         int ret;
 120
 121         /* Py_Initialize() returns void and usually cannot fail. */
 122         Py_Initialize();
 123
 124         /* TODO: Use Py_InitModule3() to add a docstring? */
 125         if (!Py_InitModule("sigrok", EmbMethods)) {
 126                 Py_Finalize(); /* Returns void. */
 127                 return SRD_ERR_PYTHON;
 128         }
 129
 130         /* Add search directory for the protocol decoders. */
 131         /* FIXME: What happens if this function is called multiple times? */
 132         ret = PyRun_SimpleString("import sys;"
 133                                  "sys.path.append(r'" DECODERS_DIR "');");
 134         if (ret != 0) {
 135                 Py_Finalize(); /* Returns void. */
 136                 return SRD_ERR_PYTHON;
 137         }
 138
 139         if (!(dir = opendir(DECODERS_DIR))) {
 140                 Py_Finalize(); /* Returns void. */
 141                 return SRD_ERR_DECODERS_DIR;
 142         }
 143
 144         while ((dp = readdir(dir)) != NULL) {
 145                 /* Ignore filenames which don't end with ".py". */
 146                 if (!g_str_has_suffix(dp->d_name, ".py"))
 147                         continue;
 148
 149                 /* Decoder name == filename (without .py suffix). */
 150                 decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
 151
 152                 /* TODO: Error handling. Use g_try_malloc(). */
 153                 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
 154                         Py_Finalize(); /* Returns void. */
 155                         return SRD_ERR_MALLOC;
 156                 }
 157
 158                 /* Load the decoder. */
 159                 /* "Import" the Python module. */
 160                 PyObject *py_mod;
 161                 if (!(py_mod = PyImport_ImportModule(decodername))) { /* NEWREF */
 162                         PyErr_Print(); /* Returns void. */
 163                         return SRD_ERR_PYTHON; /* TODO: More specific error? */
 164                 }
 165                 /* We release here.  If any decoders were registered they
 166                  * will hold references. */
 167                 Py_XDECREF(py_mod);
 168         }
 169         closedir(dir);
 170
 171         return SRD_OK;
 172 }
 173
 174 /**
 175  * Returns the list of supported/loaded protocol decoders.
 176  *
 177  * This is a GSList containing the names of the decoders as strings.
 178  *
 179  * @return List of decoders, NULL if none are supported or loaded.
 180  */
 181 GSList *srd_list_decoders(void)
 182 {
 183         return list_pds;
 184 }
 185
 186 /**
 187  * Get the decoder with the specified ID.
 188  *
 189  * @param id The ID string of the decoder to return.
 190  * @return The decoder with the specified ID, or NULL if not found.
 191  */
 192 struct srd_decoder *srd_get_decoder_by_id(const char *id)
 193 {
 194         GSList *l;
 195         struct srd_decoder *dec;
 196
 197         for (l = srd_list_decoders(); l; l = l->next) {
 198                 dec = l->data;
 199                 if (!strcmp(dec->id, id))
 200                         return dec;
 201         }
 202
 203         return NULL;
 204 }
 205
 206 /**
 207  * Helper function to handle Python strings.
 208  *
 209  * TODO: @param entries.
 210  *
 211  * @return SRD_OK upon success, a (negative) error code otherwise.
 212  *         The 'outstr' argument points to a malloc()ed string upon success.
 213  */
 214 static int h_str(PyObject *py_res, const char *key, char **outstr)
 215 {
 216         PyObject *py_str;
 217         char *str;
 218         int ret;
 219
 220         py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */
 221         if (!py_str || !PyString_Check(py_str)) {
 222                 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
 223                 goto err_h_decref_mod;
 224         }
 225
 226         /*
 227          * PyString_AsString()'s returned string refers to an internal buffer
 228          * (not a copy), i.e. the data must not be modified, and the memory
 229          * must not be free()'d.
 230          */
 231         if (!(str = PyString_AsString(py_str))) {
 232                 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
 233                 goto err_h_decref_str;
 234         }
 235
 236         if (!(*outstr = g_strdup(str))) {
 237                 ret = SRD_ERR_MALLOC;
 238                 goto err_h_decref_str;
 239         }
 240
 241         Py_XDECREF(py_str);
 242
 243         return SRD_OK;
 244
 245 err_h_decref_str:
 246         Py_XDECREF(py_str);
 247 err_h_decref_mod:
 248
 249         if (PyErr_Occurred())
 250                 PyErr_Print(); /* Returns void. */
 251
 252         return ret;
 253 }
 254
 255 /**
 256  * TODO
 257  *
 258  * @param name TODO
 259  *
 260  * @return SRD_OK upon success, a (negative) error code otherwise.
 261  */
 262 static int srd_load_decoder(PyObject *py_res)
 263 {
 264         struct srd_decoder *d;
 265         int r;
 266
 267         if (!(d = malloc(sizeof(struct srd_decoder))))
 268                 return SRD_ERR_MALLOC;
 269
 270         if ((r = h_str(py_res, "id", &(d->id))) < 0)
 271                 return r;
 272
 273         if ((r = h_str(py_res, "name", &(d->name))) < 0)
 274                 return r;
 275
 276         if ((r = h_str(py_res, "longname",
 277                        &(d->longname))) < 0)
 278                 return r;
 279
 280         if ((r = h_str(py_res, "desc", &(d->desc))) < 0)
 281                 return r;
 282
 283         if ((r = h_str(py_res, "longdesc",
 284                        &(d->longdesc))) < 0)
 285                 return r;
 286
 287         if ((r = h_str(py_res, "author", &(d->author))) < 0)
 288                 return r;
 289
 290         if ((r = h_str(py_res, "email", &(d->email))) < 0)
 291                 return r;
 292
 293         if ((r = h_str(py_res, "license", &(d->license))) < 0)
 294                 return r;
 295
 296         d->py_decobj = py_res;
 297
 298         /* TODO: Handle func, inputformats, outputformats. */
 299         /* Note: They must at least be set to NULL, will segfault otherwise. */
 300         d->func = NULL;
 301         d->inputformats = NULL;
 302         d->outputformats = NULL;
 303
 304         Py_INCREF(py_res);
 305         fprintf(stderr, "srd: registered '%s'\n", d->id);
 306         list_pds = g_slist_append(list_pds, d);
 307
 308         return SRD_OK;
 309 }
 310
 311 /** Create a new decoder instance and add to session. */
 312 struct srd_decoder_instance *srd_instance_new(const char *id)
 313 {
 314         struct srd_decoder *dec;
 315         struct srd_decoder_instance *di;
 316         PyObject *py_args;
 317
 318         if (!(dec = srd_get_decoder_by_id(id)))
 319                 return NULL;
 320
 321         /* TODO: Error handling. Use g_try_malloc(). */
 322         di = g_malloc(sizeof(*di));
 323
 324         /* Create an empty Python tuple. */
 325         if (!(py_args = PyTuple_New(0))) { /* NEWREF */
 326                 if (PyErr_Occurred())
 327                         PyErr_Print(); /* Returns void. */
 328
 329                 return NULL; /* TODO: More specific error? */
 330         }
 331
 332         /* Create an instance of the 'Decoder' class. */
 333         di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL);
 334         if (!di->py_instance) {
 335                 if (PyErr_Occurred())
 336                         PyErr_Print(); /* Returns void. */
 337                 Py_XDECREF(py_args);
 338                 return NULL; /* TODO: More specific error? */
 339         }
 340
 341         /* Append to list of PD instances */
 342         decoders = g_slist_append(decoders, di);
 343
 344         Py_XDECREF(py_args);
 345
 346         return di;
 347 }
 348
 349 int srd_instance_set_probe(struct srd_decoder_instance *di,
 350                            const char *probename, int num)
 351 {
 352         PyObject *probedict, *probenum;
 353
 354         probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
 355         if (!probedict) {
 356                 if (PyErr_Occurred())
 357                         PyErr_Print(); /* Returns void. */
 358
 359                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
 360         }
 361
 362         probenum = PyInt_FromLong(num);
 363         PyMapping_SetItemString(probedict, (char *)probename, probenum);
 364
 365         Py_XDECREF(probenum);
 366         Py_XDECREF(probedict);
 367
 368         return SRD_OK;
 369 }
 370
 371 /** Start decoding session.  Feed metadata to decoder instances. */
 372 int srd_session_start(const char *driver, int unitsize, uint64_t starttime,
 373                         uint64_t samplerate)
 374 {
 375         PyObject *py_res;
 376         GSList *d;
 377         for (d = decoders; d; d = d->next) {
 378                 struct srd_decoder_instance *di = d->data;
 379                 /* TODO: Error handling. */
 380                 if (!(py_res = PyObject_CallMethod(di->py_instance, "start",
 381                                         "{s:s,s:l,s:l,s:l}",
 382                                         "driver", driver,
 383                                         "unitsize", (long)unitsize,
 384                                         "starttime", (long)starttime,
 385                                         "samplerate", (long)samplerate))) {
 386                         if (PyErr_Occurred())
 387                                 PyErr_Print(); /* Returns void. */
 388
 389                         return SRD_ERR_PYTHON; /* TODO: More specific error? */
 390                 }
 391                 Py_XDECREF(py_res);
 392         }
 393
 394         return SRD_OK;
 395 }
 396
 397 /**
 398  * Run the specified decoder function.
 399  *
 400  * @param dec TODO
 401  * @param inbuf TODO
 402  * @param inbuflen TODO
 403  * @param outbuf TODO
 404  * @param outbuflen TODO
 405  *
 406  * @return SRD_OK upon success, a (negative) error code otherwise.
 407  */
 408 static int srd_run_decoder(struct srd_decoder_instance *dec,
 409                     uint8_t *inbuf, uint64_t inbuflen)
 410 {
 411         PyObject *py_instance, *py_res;
 412         /* FIXME: Don't have a timebase available here. Make one up. */
 413         static int _timehack = 0;
 414
 415         _timehack += inbuflen;
 416
 417         /* TODO: Use #defines for the return codes. */
 418
 419         /* Return an error upon unusable input. */
 420         if (dec == NULL)
 421                 return SRD_ERR_ARGS; /* TODO: More specific error? */
 422         if (inbuf == NULL)
 423                 return SRD_ERR_ARGS; /* TODO: More specific error? */
 424         if (inbuflen == 0) /* No point in working on empty buffers. */
 425                 return SRD_ERR_ARGS; /* TODO: More specific error? */
 426
 427         /* TODO: Error handling. */
 428         py_instance = dec->py_instance;
 429         Py_XINCREF(py_instance);
 430
 431         if (!(py_res = PyObject_CallMethod(py_instance, "decode",
 432                                            "{s:i,s:i,s:s#}",
 433                                            "time", _timehack,
 434                                            "duration", 10,
 435                                            "data", inbuf, inbuflen))) { /* NEWREF */
 436                 if (PyErr_Occurred())
 437                         PyErr_Print(); /* Returns void. */
 438
 439                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
 440         }
 441
 442         Py_XDECREF(py_res);
 443         return SRD_OK;
 444 }
 445
 446 /* Feed logic samples to decoder session. */
 447 int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen)
 448 {
 449         GSList *d;
 450         for (d = decoders; d; d = d->next) {
 451                 /* TODO: Error handling. */
 452
 453                 int ret = srd_run_decoder(d->data, inbuf, inbuflen);
 454
 455                 if (ret != SRD_OK) {
 456                         /* This probably shouldn't fail catastrophically. */
 457                         fprintf(stderr, "Decoder runtime error (%d)\n", ret);
 458                         exit(1);
 459                 }
 460         }
 461         return SRD_OK;
 462 }
 463
 464 /**
 465  * TODO
 466  */
 467 static int srd_unload_decoder(struct srd_decoder *dec)
 468 {
 469         g_free(dec->id);
 470         g_free(dec->name);
 471         g_free(dec->desc);
 472         g_free(dec->func);
 473
 474         /* TODO: Free everything in inputformats and outputformats. */
 475
 476         if (dec->inputformats != NULL)
 477                 g_slist_free(dec->inputformats);
 478         if (dec->outputformats != NULL)
 479                 g_slist_free(dec->outputformats);
 480
 481         Py_XDECREF(dec->py_decobj);
 482
 483         /* TODO: (g_)free dec itself? */
 484
 485         return SRD_OK;
 486 }
 487
 488 /**
 489  * TODO
 490  */
 491 static int srd_unload_all_decoders(void)
 492 {
 493         GSList *l;
 494         struct srd_decoder *dec;
 495
 496         for (l = srd_list_decoders(); l; l = l->next) {
 497                 dec = l->data;
 498                 /* TODO: Error handling. */
 499                 srd_unload_decoder(dec);
 500         }
 501
 502         return SRD_OK;
 503 }
 504
 505 /**
 506  * Shutdown libsigrokdecode.
 507  *
 508  * This frees all the memory allocated for protocol decoders and shuts down
 509  * the Python interpreter.
 510  *
 511  * This function should only be called if there was a (successful!) invocation
 512  * of srd_init() before. Calling this function multiple times in a row, without
 513  * any successful srd_init() calls inbetween, is not allowed.
 514  *
 515  * @return SRD_OK upon success, a (negative) error code otherwise.
 516  */
 517 int srd_exit(void)
 518 {
 519         /* Unload/free all decoders, and then the list of decoders itself. */
 520         /* TODO: Error handling. */
 521         srd_unload_all_decoders();
 522         g_slist_free(list_pds);
 523
 524         /* Py_Finalize() returns void, any finalization errors are ignored. */
 525         Py_Finalize();
 526
 527         return SRD_OK;
 528 }