controller.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 "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  22 #include "sigrokdecode-internal.h"
  23 #include "config.h"
  24 #include <glib.h>
  25 #include <inttypes.h>
  26
  27
  28 static GSList *di_list = NULL;
  29 static GSList *callbacks = NULL;
  30
  31 /* lives in decoder.c */
  32 extern GSList *pd_list;
  33
  34 /* lives in module_sigrokdecode.c */
  35 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
  36
  37 /* lives in type_logic.c */
  38 extern PyTypeObject srd_logic_type;
  39
  40
  41 /**
  42  * Initialize libsigrokdecode.
  43  *
  44  * This initializes the Python interpreter, and creates and initializes
  45  * a "sigrok" Python module with a single put() method.
  46  *
  47  * Then, it searches for sigrok protocol decoder files (*.py) in the
  48  * "decoders" subdirectory of the the sigrok installation directory.
  49  * All decoders that are found are loaded into memory and added to an
  50  * internal list of decoders, which can be queried via srd_list_decoders().
  51  *
  52  * The caller is responsible for calling the clean-up function srd_exit(),
  53  * which will properly shut down libsigrokdecode and free its allocated memory.
  54  *
  55  * Multiple calls to srd_init(), without calling srd_exit() in between,
  56  * are not allowed.
  57  *
  58  * @return SRD_OK upon success, a (negative) error code otherwise.
  59  *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
  60  *         directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
  61  *         If not enough memory could be allocated, return SRD_ERR_MALLOC.
  62  */
  63 int srd_init(void)
  64 {
  65         int ret;
  66
  67         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
  68
  69         /* Py_Initialize() returns void and usually cannot fail. */
  70         Py_Initialize();
  71
  72         if ((ret = set_modulepath()) != SRD_OK) {
  73                 Py_Finalize();
  74                 return ret;
  75         }
  76
  77         if ((ret = srd_load_all_decoders()) != SRD_OK) {
  78                 Py_Finalize();
  79                 return ret;
  80         }
  81
  82         return SRD_OK;
  83 }
  84
  85
  86 /**
  87  * Shutdown libsigrokdecode.
  88  *
  89  * This frees all the memory allocated for protocol decoders and shuts down
  90  * the Python interpreter.
  91  *
  92  * This function should only be called if there was a (successful!) invocation
  93  * of srd_init() before. Calling this function multiple times in a row, without
  94  * any successful srd_init() calls in between, is not allowed.
  95  *
  96  * @return SRD_OK upon success, a (negative) error code otherwise.
  97  */
  98 int srd_exit(void)
  99 {
 100         /* Unload/free all decoders, and then the list of decoders itself. */
 101         /* TODO: Error handling. */
 102         srd_unload_all_decoders();
 103         g_slist_free(pd_list);
 104
 105         /* Py_Finalize() returns void, any finalization errors are ignored. */
 106         Py_Finalize();
 107
 108         return SRD_OK;
 109 }
 110
 111
 112 /**
 113  * Add search directories for the protocol decoders.
 114  *
 115  * TODO: add path from env var SIGROKDECODE_PATH, config etc
 116  */
 117 int set_modulepath(void)
 118 {
 119         int ret;
 120
 121         PyRun_SimpleString("import sys");
 122         ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');");
 123
 124         return ret;
 125 }
 126
 127
 128 /**
 129  * Create a new protocol decoder instance.
 130  *
 131  * TODO: this should be a decoder name, as decoder ids will disappear.
 132  *
 133  * @param id Decoder 'id' field.
 134  * @param instance_id Optional unique identifier for this instance. If NULL,
 135  *        the 'id' parameter is used.
 136  * @return Pointer to a newly allocated struct srd_decoder_instance, or
 137  *         NULL in case of failure.
 138  */
 139 struct srd_decoder_instance *srd_instance_new(const char *id,
 140                 const char *instance_id)
 141 {
 142         struct srd_decoder *dec;
 143         struct srd_decoder_instance *di;
 144         PyObject *py_args;
 145
 146         srd_dbg("%s: creating new %s instance", __func__, id);
 147
 148         if (!(dec = srd_get_decoder_by_id(id)))
 149                 return NULL;
 150
 151         if (!(di = g_try_malloc(sizeof(*di)))) {
 152                 srd_err("failed to malloc instance");
 153                 return NULL;
 154         }
 155         di->decoder = dec;
 156         di->instance_id = g_strdup(instance_id ? instance_id : id);
 157         di->pd_output = NULL;
 158         di->num_probes = 0;
 159         di->unitsize = 0;
 160         di->samplerate = 0;
 161         di->next_di = NULL;
 162
 163         /* Create an empty Python tuple. */
 164         if (!(py_args = PyTuple_New(0))) { /* NEWREF */
 165                 if (PyErr_Occurred())
 166                         PyErr_Print();
 167                 return NULL;
 168         }
 169
 170         /* Create an instance of the 'Decoder' class. */
 171         di->py_instance = PyObject_Call(dec->py_dec, py_args, NULL);
 172         if (!di->py_instance) {
 173                 if (PyErr_Occurred())
 174                         PyErr_Print();
 175                 Py_XDECREF(py_args);
 176                 return NULL;
 177         }
 178
 179         /* Instance takes input from a frontend by default. */
 180         di_list = g_slist_append(di_list, di);
 181
 182         Py_XDECREF(py_args);
 183
 184         return di;
 185 }
 186
 187 int srd_instance_stack(struct srd_decoder_instance *di_from,
 188                 struct srd_decoder_instance *di_to)
 189 {
 190
 191         if (!di_from || !di_to) {
 192                 srd_err("invalid from/to instance pair");
 193                 return SRD_ERR_ARG;
 194         }
 195
 196         if (!g_slist_find(di_list, di_from)) {
 197                 srd_err("unstacked instance not found");
 198                 return SRD_ERR_ARG;
 199         }
 200
 201         /* Remove from the unstacked list. */
 202         di_list = g_slist_remove(di_list, di_to);
 203
 204         /* Stack on top of source di. */
 205         di_from->next_di = g_slist_append(di_from->next_di, di_to);
 206
 207         return SRD_OK;
 208 }
 209
 210
 211 int srd_instance_set_probe(struct srd_decoder_instance *di,
 212                            const char *probename, int num)
 213 {
 214         PyObject *probedict, *probenum;
 215
 216         probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
 217         if (!probedict) {
 218                 if (PyErr_Occurred())
 219                         PyErr_Print(); /* Returns void. */
 220
 221                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
 222         }
 223
 224         probenum = PyLong_FromLong(num);
 225         PyMapping_SetItemString(probedict, (char *)probename, probenum);
 226
 227         Py_XDECREF(probenum);
 228         Py_XDECREF(probedict);
 229
 230         return SRD_OK;
 231 }
 232
 233 /* TODO: this should go into the PD stack */
 234 struct srd_decoder_instance *srd_instance_find(char *instance_id)
 235 {
 236         GSList *l;
 237         struct srd_decoder_instance *tmp, *di;
 238
 239         di = NULL;
 240         for (l = di_list; l; l = l->next) {
 241                 tmp = l->data;
 242                 if (!strcmp(tmp->instance_id, instance_id)) {
 243                         di = tmp;
 244                         break;
 245                 }
 246         }
 247
 248         return di;
 249 }
 250
 251 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
 252 {
 253         PyObject *py_name, *py_res;
 254
 255         srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id);
 256
 257         if (!(py_name = PyUnicode_FromString("start"))) {
 258                 srd_err("unable to build python object for 'start'");
 259                 if (PyErr_Occurred())
 260                         PyErr_Print();
 261                 return SRD_ERR_PYTHON;
 262         }
 263
 264         if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
 265                         py_name, args, NULL))) {
 266                 if (PyErr_Occurred())
 267                         PyErr_Print();
 268                 return SRD_ERR_PYTHON;
 269         }
 270
 271         Py_XDECREF(py_res);
 272         Py_DECREF(py_name);
 273
 274         return SRD_OK;
 275 }
 276
 277 /**
 278  * Run the specified decoder function.
 279  *
 280  * @param dec TODO
 281  * @param inbuf TODO
 282  * @param inbuflen TODO
 283  *
 284  * @return SRD_OK upon success, a (negative) error code otherwise.
 285  */
 286 int srd_instance_decode(uint64_t start_samplenum,
 287                 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
 288 {
 289         PyObject *py_instance, *py_res;
 290         srd_logic *logic;
 291         uint64_t end_samplenum;
 292
 293         /* Return an error upon unusable input. */
 294         if (di == NULL)
 295                 return SRD_ERR_ARG; /* TODO: More specific error? */
 296         if (inbuf == NULL)
 297                 return SRD_ERR_ARG; /* TODO: More specific error? */
 298         if (inbuflen == 0) /* No point in working on empty buffers. */
 299                 return SRD_ERR_ARG; /* TODO: More specific error? */
 300
 301         /* TODO: Error handling. */
 302         py_instance = di->py_instance;
 303         Py_XINCREF(py_instance);
 304
 305         logic = PyObject_New(srd_logic, &srd_logic_type);
 306         Py_INCREF(logic);
 307         logic->di = di;
 308         logic->start_samplenum = start_samplenum;
 309         logic->itercnt = 0;
 310         logic->inbuf = inbuf;
 311         logic->inbuflen = inbuflen;
 312         logic->sample = PyList_New(2);
 313         Py_INCREF(logic->sample);
 314
 315         end_samplenum = start_samplenum + inbuflen / di->unitsize;
 316         if (!(py_res = PyObject_CallMethod(py_instance, "decode",
 317                         "KKO", logic->start_samplenum, end_samplenum, logic))) {
 318                 if (PyErr_Occurred())
 319                         PyErr_Print(); /* Returns void. */
 320
 321                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
 322         }
 323
 324         Py_XDECREF(py_res);
 325
 326         return SRD_OK;
 327 }
 328
 329
 330 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 331 {
 332         PyObject *args;
 333         GSList *d, *s;
 334         struct srd_decoder_instance *di;
 335         int ret;
 336
 337         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
 338                 srd_err("unable to build python object for metadata");
 339                 return SRD_ERR_PYTHON;
 340         }
 341
 342         /* Run the start() method on all decoders receiving frontend data. */
 343         for (d = di_list; d; d = d->next) {
 344                 di = d->data;
 345                 di->num_probes = num_probes;
 346                 di->unitsize = unitsize;
 347                 di->samplerate = samplerate;
 348                 if ((ret = srd_instance_start(di, args) != SRD_OK))
 349                         return ret;
 350
 351                 /* Run the start() method on all decoders up the stack from this one. */
 352                 for (s = di->next_di; s; s = s->next) {
 353                         /* These don't need probes, unitsize and samplerate. */
 354                         di = s->data;
 355                         if ((ret = srd_instance_start(di, args) != SRD_OK))
 356                                 return ret;
 357                 }
 358         }
 359
 360         Py_DECREF(args);
 361
 362         return SRD_OK;
 363 }
 364
 365 /* Feed logic samples to decoder session. */
 366 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
 367 {
 368         GSList *d;
 369         int ret;
 370
 371         for (d = di_list; d; d = d->next) {
 372                 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
 373                                 inbuflen)) != SRD_OK)
 374                         return ret;
 375         }
 376
 377         return SRD_OK;
 378 }
 379
 380
 381 int pd_add(struct srd_decoder_instance *di, int output_type,
 382                 char *proto_id)
 383 {
 384         struct srd_pd_output *pdo;
 385
 386         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
 387                 return -1;
 388
 389         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
 390         pdo->pdo_id = g_slist_length(di->pd_output);
 391         pdo->output_type = output_type;
 392         pdo->decoder = di->decoder;
 393         pdo->proto_id = g_strdup(proto_id);
 394         di->pd_output = g_slist_append(di->pd_output, pdo);
 395
 396         return pdo->pdo_id;
 397 }
 398
 399 struct srd_decoder_instance *get_di_by_decobject(void *decobject)
 400 {
 401         GSList *l, *s;
 402         struct srd_decoder_instance *di;
 403
 404         for (l = di_list; l; l = l->next) {
 405                 di = l->data;
 406                 if (decobject == di->py_instance)
 407                         return di;
 408                 /* Check decoders stacked on top of this one. */
 409                 for (s = di->next_di; s; s = s->next) {
 410                         di = s->data;
 411                         if (decobject == di->py_instance)
 412                                 return di;
 413                 }
 414         }
 415
 416         return NULL;
 417 }
 418
 419 int srd_register_callback(int output_type, void *cb)
 420 {
 421         struct srd_pd_callback *pd_cb;
 422
 423         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
 424                 return SRD_ERR_MALLOC;
 425
 426         pd_cb->output_type = output_type;
 427         pd_cb->callback = cb;
 428         callbacks = g_slist_append(callbacks, pd_cb);
 429
 430         return SRD_OK;
 431 }
 432
 433 void *srd_find_callback(int output_type)
 434 {
 435         GSList *l;
 436         struct srd_pd_callback *pd_cb;
 437         void *(cb);
 438
 439         cb = NULL;
 440         for (l = callbacks; l; l = l->next) {
 441                 pd_cb = l->data;
 442                 if (pd_cb->output_type == output_type) {
 443                         cb = pd_cb->callback;
 444                         break;
 445                 }
 446         }
 447
 448         return cb;
 449 }
 450