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 #include <stdlib.h>
  27
  28
  29 static GSList *di_list = NULL;
  30 static GSList *callbacks = NULL;
  31
  32 /* lives in decoder.c */
  33 extern GSList *pd_list;
  34
  35 /* lives in module_sigrokdecode.c */
  36 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
  37
  38 /* lives in type_logic.c */
  39 extern PyTypeObject srd_logic_type;
  40
  41
  42 /**
  43  * Initialize libsigrokdecode.
  44  *
  45  * This initializes the Python interpreter, and creates and initializes
  46  * a "sigrok" Python module with a single put() method.
  47  *
  48  * Then, it searches for sigrok protocol decoder files (*.py) in the
  49  * "decoders" subdirectory of the the sigrok installation directory.
  50  * All decoders that are found are loaded into memory and added to an
  51  * internal list of decoders, which can be queried via srd_list_decoders().
  52  *
  53  * The caller is responsible for calling the clean-up function srd_exit(),
  54  * which will properly shut down libsigrokdecode and free its allocated memory.
  55  *
  56  * Multiple calls to srd_init(), without calling srd_exit() in between,
  57  * are not allowed.
  58  *
  59  * @return SRD_OK upon success, a (negative) error code otherwise.
  60  *         Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
  61  *         directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
  62  *         If not enough memory could be allocated, return SRD_ERR_MALLOC.
  63  */
  64 int srd_init(void)
  65 {
  66         int ret;
  67
  68         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
  69
  70         /* Py_Initialize() returns void and usually cannot fail. */
  71         Py_Initialize();
  72
  73         if ((ret = set_modulepath()) != SRD_OK) {
  74                 Py_Finalize();
  75                 return ret;
  76         }
  77
  78         if ((ret = srd_load_all_decoders()) != SRD_OK) {
  79                 Py_Finalize();
  80                 return ret;
  81         }
  82
  83         return SRD_OK;
  84 }
  85
  86
  87 /**
  88  * Shutdown libsigrokdecode.
  89  *
  90  * This frees all the memory allocated for protocol decoders and shuts down
  91  * the Python interpreter.
  92  *
  93  * This function should only be called if there was a (successful!) invocation
  94  * of srd_init() before. Calling this function multiple times in a row, without
  95  * any successful srd_init() calls in between, is not allowed.
  96  *
  97  * @return SRD_OK upon success, a (negative) error code otherwise.
  98  */
  99 int srd_exit(void)
 100 {
 101         /* Unload/free all decoders, and then the list of decoders itself. */
 102         /* TODO: Error handling. */
 103         srd_unload_all_decoders();
 104         g_slist_free(pd_list);
 105
 106         /* Py_Finalize() returns void, any finalization errors are ignored. */
 107         Py_Finalize();
 108
 109         return SRD_OK;
 110 }
 111
 112
 113 /**
 114  * Add search directories for the protocol decoders.
 115  *
 116  * TODO: add path from env var SIGROKDECODE_PATH, config etc
 117  * TODO: Should take directoryname/path as input.
 118  */
 119 int set_modulepath(void)
 120 {
 121         int ret;
 122         gchar *path, *s;
 123
 124 #ifdef _WIN32
 125         gchar **splitted;
 126
 127         /*
 128          * On Windows/MinGW, Python's sys.path needs entries of the form
 129          * 'C:\\foo\\bar' instead of '/foo/bar'.
 130          */
 131
 132         splitted = g_strsplit(DECODERS_DIR, "/", 0);
 133         path = g_build_pathv("\\\\", splitted);
 134         g_strfreev(splitted);
 135 #else
 136         path = g_strdup(DECODERS_DIR);
 137 #endif
 138
 139         /* TODO: Prepend instead of appending. */
 140         /* TODO: Sanity check on 'path' (length, escape special chars, ...). */
 141         s = g_strdup_printf("import sys; sys.path.append(r'%s')", path);
 142
 143         ret = PyRun_SimpleString(s);
 144
 145         g_free(path);
 146         g_free(s);
 147
 148         return ret;
 149 }
 150
 151
 152 /**
 153  * Set options in a decoder instance.
 154  *
 155  * @param di Decoder instance.
 156  * @param options A GHashTable of options to set.
 157  *
 158  * Handled options are removed from the hash.
 159  *
 160  * @return SRD_OK upon success, a (negative) error code otherwise.
 161  */
 162 int srd_instance_set_options(struct srd_decoder_instance *di,
 163                 GHashTable *options)
 164 {
 165         PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
 166         PyObject *py_optlist, *py_classval;
 167         Py_UNICODE *py_ustr;
 168         unsigned long long int val_ull;
 169         int num_optkeys, ret, size, i;
 170         char *key, *value;
 171
 172         if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
 173                 /* Decoder has no options. */
 174                 if (g_hash_table_size(options) == 0) {
 175                         /* No options provided. */
 176                         return SRD_OK;
 177                 } else {
 178                         srd_err("Protocol decoder has no options.");
 179                         return SRD_ERR_ARG;
 180                 }
 181                 return SRD_OK;
 182         }
 183
 184         ret = SRD_ERR_PYTHON;
 185         key = NULL;
 186         py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
 187         py_optlist = py_classval = NULL;
 188         py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
 189         if (!PyDict_Check(py_dec_options)) {
 190                 srd_err("Protocol decoder %s options is not a dictionary.",
 191                                 di->decoder->name);
 192                 goto err_out;
 193         }
 194
 195         /* All of these are synthesized objects, so they're good. */
 196         py_dec_optkeys = PyDict_Keys(py_dec_options);
 197         num_optkeys = PyList_Size(py_dec_optkeys);
 198         if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options")))
 199                 goto err_out;
 200         for (i = 0; i < num_optkeys; i++) {
 201                 /* Get the default class value for this option. */
 202                 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
 203                 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
 204                         goto err_out;
 205                 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
 206                         goto err_out;
 207
 208                 if ((value = g_hash_table_lookup(options, key))) {
 209                         /* An override for this option was provided. */
 210                         if (PyUnicode_Check(py_classval)) {
 211                                 if (!(py_optval = PyUnicode_FromString(value))) {
 212                                         /* Some UTF-8 encoding error. */
 213                                         PyErr_Clear();
 214                                         goto err_out;
 215                                 }
 216                         } else if (PyLong_Check(py_classval)) {
 217                                 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
 218                                         /* ValueError Exception */
 219                                         PyErr_Clear();
 220                                         srd_err("Option %s has invalid value %s: expected integer",
 221                                                         key, value);
 222                                         goto err_out;
 223                                 }
 224                         }
 225                         g_hash_table_remove(options, key);
 226                 } else {
 227                         /* Use the class default for this option. */
 228                         if (PyUnicode_Check(py_classval)) {
 229                                 /* Make a brand new copy of the string. */
 230                                 py_ustr = PyUnicode_AS_UNICODE(py_classval);
 231                                 size = PyUnicode_GET_SIZE(py_classval);
 232                                 py_optval = PyUnicode_FromUnicode(py_ustr, size);
 233                         } else if (PyLong_Check(py_classval)) {
 234                                 /* Make a brand new copy of the integer. */
 235                                 val_ull = PyLong_AsUnsignedLongLong(py_classval);
 236                                 if (val_ull == (unsigned long long)-1) {
 237                                         /* OverFlowError exception */
 238                                         PyErr_Clear();
 239                                         srd_err("Invalid integer value for %s: expected integer", key);
 240                                         goto err_out;
 241                                 }
 242                                 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
 243                                         goto err_out;
 244                         }
 245                 }
 246
 247                 /* If we got here, py_optval holds a known good new reference
 248                  * to the instance option to set.
 249                  */
 250                 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
 251                         goto err_out;
 252         }
 253
 254         ret = SRD_OK;
 255
 256 err_out:
 257         Py_XDECREF(py_optlist);
 258         Py_XDECREF(py_di_options);
 259         Py_XDECREF(py_dec_optkeys);
 260         Py_XDECREF(py_dec_options);
 261         if (key)
 262                 g_free(key);
 263         if (PyErr_Occurred()) {
 264                 srd_dbg("stray exception!");
 265                 PyErr_Print();
 266                 PyErr_Clear();
 267         }
 268
 269         return ret;
 270 }
 271
 272 /**
 273  * Set probes in a decoder instance.
 274  *
 275  * @param di Decoder instance.
 276  * @param probes A GHashTable of probes to set. Key is probe name, value is
 277  * the probe number. Samples passed to this instance will be arranged in this
 278  * order.
 279  *
 280  * Handled probes are removed from the hash.
 281  *
 282  * @return SRD_OK upon success, a (negative) error code otherwise.
 283  */
 284 int srd_instance_set_probes(struct srd_decoder_instance *di,
 285                 GHashTable *probes)
 286 {
 287         int ret;
 288
 289         if (g_hash_table_size(probes) == 0)
 290                 /* No probes provided. */
 291                 return SRD_OK;
 292
 293         if(!PyObject_HasAttrString(di->decoder->py_dec, "probes"))
 294                 /* Decoder has no probes. */
 295                 return SRD_OK;
 296
 297         ret = SRD_ERR_PYTHON;
 298
 299         /* TODO */
 300         if (g_hash_table_size(probes) > 0) {
 301                 srd_err("Setting probes is not yet supported.");
 302                 return SRD_ERR_PYTHON;
 303         }
 304
 305         ret = SRD_OK;
 306
 307         return ret;
 308 }
 309
 310 /**
 311  * Create a new protocol decoder instance.
 312  *
 313  * @param id Decoder 'id' field.
 314  * @param options GHashtable of options which override the defaults set in
 315  *          the decoder class.
 316  * @return Pointer to a newly allocated struct srd_decoder_instance, or
 317  *              NULL in case of failure.
 318  */
 319 struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
 320                 GHashTable *options)
 321 {
 322         struct srd_decoder *dec;
 323         struct srd_decoder_instance *di;
 324         char *instance_id;
 325
 326         srd_dbg("%s: creating new %s instance", __func__, decoder_id);
 327
 328         if (!(dec = srd_get_decoder_by_id(decoder_id))) {
 329                 srd_err("Protocol decoder %s not found.", decoder_id);
 330                 return NULL;
 331         }
 332
 333         if (!(di = g_try_malloc0(sizeof(*di)))) {
 334                 srd_err("Failed to malloc instance.");
 335                 return NULL;
 336         }
 337
 338         instance_id = g_hash_table_lookup(options, "id");
 339         di->decoder = dec;
 340         di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
 341         g_hash_table_remove(options, "id");
 342
 343         /* Create a new instance of this decoder class. */
 344         if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
 345                 if (PyErr_Occurred())
 346                         PyErr_Print();
 347                 g_free(di);
 348                 return NULL;
 349         }
 350
 351         /* Instance takes input from a frontend by default. */
 352         di_list = g_slist_append(di_list, di);
 353
 354         if (srd_instance_set_options(di, options) != SRD_OK) {
 355                 di_list = g_slist_remove(di_list, di);
 356                 g_free(di);
 357                 return NULL;
 358         }
 359
 360         return di;
 361 }
 362
 363 int srd_instance_stack(struct srd_decoder_instance *di_from,
 364                 struct srd_decoder_instance *di_to)
 365 {
 366
 367         if (!di_from || !di_to) {
 368                 srd_err("invalid from/to instance pair");
 369                 return SRD_ERR_ARG;
 370         }
 371
 372         if (!g_slist_find(di_list, di_from)) {
 373                 srd_err("unstacked instance not found");
 374                 return SRD_ERR_ARG;
 375         }
 376
 377         /* Remove from the unstacked list. */
 378         di_list = g_slist_remove(di_list, di_to);
 379
 380         /* Stack on top of source di. */
 381         di_from->next_di = g_slist_append(di_from->next_di, di_to);
 382
 383         return SRD_OK;
 384 }
 385
 386
 387 /* TODO: this should go into the PD stack */
 388 struct srd_decoder_instance *srd_instance_find(char *instance_id)
 389 {
 390         GSList *l;
 391         struct srd_decoder_instance *tmp, *di;
 392
 393         di = NULL;
 394         for (l = di_list; l; l = l->next) {
 395                 tmp = l->data;
 396                 if (!strcmp(tmp->instance_id, instance_id)) {
 397                         di = tmp;
 398                         break;
 399                 }
 400         }
 401
 402         return di;
 403 }
 404
 405 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
 406 {
 407         PyObject *py_name, *py_res;
 408
 409         srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id);
 410
 411         if (!(py_name = PyUnicode_FromString("start"))) {
 412                 srd_err("unable to build python object for 'start'");
 413                 if (PyErr_Occurred())
 414                         PyErr_Print();
 415                 return SRD_ERR_PYTHON;
 416         }
 417
 418         if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
 419                         py_name, args, NULL))) {
 420                 if (PyErr_Occurred())
 421                         PyErr_Print();
 422                 return SRD_ERR_PYTHON;
 423         }
 424
 425         Py_XDECREF(py_res);
 426         Py_DECREF(py_name);
 427
 428         return SRD_OK;
 429 }
 430
 431 /**
 432  * Run the specified decoder function.
 433  *
 434  * @param dec TODO
 435  * @param inbuf TODO
 436  * @param inbuflen TODO
 437  *
 438  * @return SRD_OK upon success, a (negative) error code otherwise.
 439  */
 440 int srd_instance_decode(uint64_t start_samplenum,
 441                 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
 442 {
 443         PyObject *py_instance, *py_res;
 444         srd_logic *logic;
 445         uint64_t end_samplenum;
 446
 447         /* Return an error upon unusable input. */
 448         if (di == NULL)
 449                 return SRD_ERR_ARG; /* TODO: More specific error? */
 450         if (inbuf == NULL)
 451                 return SRD_ERR_ARG; /* TODO: More specific error? */
 452         if (inbuflen == 0) /* No point in working on empty buffers. */
 453                 return SRD_ERR_ARG; /* TODO: More specific error? */
 454
 455         /* TODO: Error handling. */
 456         py_instance = di->py_instance;
 457         Py_XINCREF(py_instance);
 458
 459         logic = PyObject_New(srd_logic, &srd_logic_type);
 460         Py_INCREF(logic);
 461         logic->di = di;
 462         logic->start_samplenum = start_samplenum;
 463         logic->itercnt = 0;
 464         logic->inbuf = inbuf;
 465         logic->inbuflen = inbuflen;
 466         logic->sample = PyList_New(2);
 467         Py_INCREF(logic->sample);
 468
 469         end_samplenum = start_samplenum + inbuflen / di->unitsize;
 470         if (!(py_res = PyObject_CallMethod(py_instance, "decode",
 471                         "KKO", logic->start_samplenum, end_samplenum, logic))) {
 472                 if (PyErr_Occurred())
 473                         PyErr_Print(); /* Returns void. */
 474
 475                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
 476         }
 477
 478         Py_XDECREF(py_res);
 479
 480         return SRD_OK;
 481 }
 482
 483
 484 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 485 {
 486         PyObject *args;
 487         GSList *d, *s;
 488         struct srd_decoder_instance *di;
 489         int ret;
 490
 491         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
 492                 srd_err("unable to build python object for metadata");
 493                 return SRD_ERR_PYTHON;
 494         }
 495
 496         /* Run the start() method on all decoders receiving frontend data. */
 497         for (d = di_list; d; d = d->next) {
 498                 di = d->data;
 499                 di->num_probes = num_probes;
 500                 di->unitsize = unitsize;
 501                 di->samplerate = samplerate;
 502                 if ((ret = srd_instance_start(di, args) != SRD_OK))
 503                         return ret;
 504
 505                 /* Run the start() method on all decoders up the stack from this one. */
 506                 for (s = di->next_di; s; s = s->next) {
 507                         /* These don't need probes, unitsize and samplerate. */
 508                         di = s->data;
 509                         if ((ret = srd_instance_start(di, args) != SRD_OK))
 510                                 return ret;
 511                 }
 512         }
 513
 514         Py_DECREF(args);
 515
 516         return SRD_OK;
 517 }
 518
 519 /* Feed logic samples to decoder session. */
 520 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
 521 {
 522         GSList *d;
 523         int ret;
 524
 525         for (d = di_list; d; d = d->next) {
 526                 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
 527                                 inbuflen)) != SRD_OK)
 528                         return ret;
 529         }
 530
 531         return SRD_OK;
 532 }
 533
 534
 535 int pd_add(struct srd_decoder_instance *di, int output_type,
 536                 char *proto_id)
 537 {
 538         struct srd_pd_output *pdo;
 539
 540         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
 541                 return -1;
 542
 543         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
 544         pdo->pdo_id = g_slist_length(di->pd_output);
 545         pdo->output_type = output_type;
 546         pdo->decoder = di->decoder;
 547         pdo->proto_id = g_strdup(proto_id);
 548         di->pd_output = g_slist_append(di->pd_output, pdo);
 549
 550         return pdo->pdo_id;
 551 }
 552
 553 struct srd_decoder_instance *get_di_by_decobject(void *decobject)
 554 {
 555         GSList *l, *s;
 556         struct srd_decoder_instance *di;
 557
 558         for (l = di_list; l; l = l->next) {
 559                 di = l->data;
 560                 if (decobject == di->py_instance)
 561                         return di;
 562                 /* Check decoders stacked on top of this one. */
 563                 for (s = di->next_di; s; s = s->next) {
 564                         di = s->data;
 565                         if (decobject == di->py_instance)
 566                                 return di;
 567                 }
 568         }
 569
 570         return NULL;
 571 }
 572
 573 int srd_register_callback(int output_type, void *cb)
 574 {
 575         struct srd_pd_callback *pd_cb;
 576
 577         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
 578                 return SRD_ERR_MALLOC;
 579
 580         pd_cb->output_type = output_type;
 581         pd_cb->callback = cb;
 582         callbacks = g_slist_append(callbacks, pd_cb);
 583
 584         return SRD_OK;
 585 }
 586
 587 void *srd_find_callback(int output_type)
 588 {
 589         GSList *l;
 590         struct srd_pd_callback *pd_cb;
 591         void *(cb);
 592
 593         cb = NULL;
 594         for (l = callbacks; l; l = l->next) {
 595                 pd_cb = l->data;
 596                 if (pd_cb->output_type == output_type) {
 597                         cb = pd_cb->callback;
 598                         break;
 599                 }
 600         }
 601
 602         return cb;
 603 }
 604