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
 190         /* All of these are synthesized objects, so they're good. */
 191         py_dec_optkeys = PyDict_Keys(py_dec_options);
 192         num_optkeys = PyList_Size(py_dec_optkeys);
 193         if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options")))
 194                 goto err_out;
 195         for (i = 0; i < num_optkeys; i++) {
 196                 /* Get the default class value for this option. */
 197                 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
 198                 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
 199                         goto err_out;
 200                 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
 201                         goto err_out;
 202                 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
 203                         srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name);
 204                         goto err_out;
 205                 }
 206
 207                 if ((value = g_hash_table_lookup(options, key))) {
 208                         /* An override for this option was provided. */
 209                         if (PyUnicode_Check(py_classval)) {
 210                                 if (!(py_optval = PyUnicode_FromString(value))) {
 211                                         /* Some UTF-8 encoding error. */
 212                                         PyErr_Clear();
 213                                         goto err_out;
 214                                 }
 215                         } else if (PyLong_Check(py_classval)) {
 216                                 if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
 217                                         /* ValueError Exception */
 218                                         PyErr_Clear();
 219                                         srd_err("Option %s has invalid value %s: expected integer",
 220                                                         key, value);
 221                                         goto err_out;
 222                                 }
 223                         }
 224                         g_hash_table_remove(options, key);
 225                 } else {
 226                         /* Use the class default for this option. */
 227                         if (PyUnicode_Check(py_classval)) {
 228                                 /* Make a brand new copy of the string. */
 229                                 py_ustr = PyUnicode_AS_UNICODE(py_classval);
 230                                 size = PyUnicode_GET_SIZE(py_classval);
 231                                 py_optval = PyUnicode_FromUnicode(py_ustr, size);
 232                         } else if (PyLong_Check(py_classval)) {
 233                                 /* Make a brand new copy of the integer. */
 234                                 val_ull = PyLong_AsUnsignedLongLong(py_classval);
 235                                 if (val_ull == (unsigned long long)-1) {
 236                                         /* OverFlowError exception */
 237                                         PyErr_Clear();
 238                                         srd_err("Invalid integer value for %s: expected integer", key);
 239                                         goto err_out;
 240                                 }
 241                                 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
 242                                         goto err_out;
 243                         }
 244                 }
 245
 246                 /* If we got here, py_optval holds a known good new reference
 247                  * to the instance option to set.
 248                  */
 249                 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
 250                         goto err_out;
 251         }
 252
 253         ret = SRD_OK;
 254
 255 err_out:
 256         Py_XDECREF(py_optlist);
 257         Py_XDECREF(py_di_options);
 258         Py_XDECREF(py_dec_optkeys);
 259         Py_XDECREF(py_dec_options);
 260         if (key)
 261                 g_free(key);
 262         if (PyErr_Occurred()) {
 263                 srd_dbg("stray exception!");
 264                 PyErr_Print();
 265                 PyErr_Clear();
 266         }
 267
 268         return ret;
 269 }
 270
 271 static gint compare_probe_id(struct srd_probe *a, char *probe_id)
 272 {
 273
 274         return strcmp(a->id, probe_id);
 275 }
 276
 277 /**
 278  * Set probes in a decoder instance.
 279  *
 280  * @param di Decoder instance.
 281  * @param probes A GHashTable of probes to set. Key is probe name, value is
 282  * the probe number. Samples passed to this instance will be arranged in this
 283  * order.
 284  *
 285  * @return SRD_OK upon success, a (negative) error code otherwise.
 286  */
 287 int srd_instance_set_probes(struct srd_decoder_instance *di,
 288                 GHashTable *new_probes)
 289 {
 290         GList *l;
 291         GSList *sl;
 292         struct srd_probe *p;
 293         int *new_probemap, new_probenum;
 294         char *probe_id;
 295
 296         if (g_hash_table_size(new_probes) == 0)
 297                 /* No probes provided. */
 298                 return SRD_OK;
 299
 300         if(di->dec_num_probes == 0) {
 301                 /* Decoder has no probes. */
 302                 srd_err("Protocol decoder %s has no probes to define.",
 303                                 di->decoder->name);
 304                 return SRD_ERR_ARG;
 305         }
 306
 307         new_probemap = NULL;
 308
 309         if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
 310                 srd_err("Failed to malloc new probe map.");
 311                 return SRD_ERR_MALLOC;
 312         }
 313
 314         for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
 315                 probe_id = l->data;
 316                 new_probenum = strtol(g_hash_table_lookup(new_probes, probe_id), NULL, 10);
 317                 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
 318                                 (GCompareFunc)compare_probe_id))) {
 319                         /* Fall back on optional probes. */
 320                         if (!(sl = g_slist_find_custom(di->decoder->extra_probes,
 321                                         probe_id, (GCompareFunc)compare_probe_id))) {
 322                                 srd_err("Protocol decoder %s has no probe '%s'",
 323                                                 di->decoder->name, probe_id);
 324                                 g_free(new_probemap);
 325                                 return SRD_ERR_ARG;
 326                         }
 327                 }
 328                 p = sl->data;
 329                 new_probemap[p->order] = new_probenum;
 330         }
 331         g_free(di->dec_probemap);
 332         di->dec_probemap = new_probemap;
 333
 334         return SRD_OK;
 335 }
 336
 337 /**
 338  * Create a new protocol decoder instance.
 339  *
 340  * @param id Decoder 'id' field.
 341  * @param options GHashtable of options which override the defaults set in
 342  *          the decoder class.
 343  * @return Pointer to a newly allocated struct srd_decoder_instance, or
 344  *              NULL in case of failure.
 345  */
 346 struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
 347                 GHashTable *options)
 348 {
 349         struct srd_decoder *dec;
 350         struct srd_decoder_instance *di;
 351         int i;
 352         char *instance_id;
 353
 354         srd_dbg("%s: creating new %s instance", __func__, decoder_id);
 355
 356         if (!(dec = srd_get_decoder_by_id(decoder_id))) {
 357                 srd_err("Protocol decoder %s not found.", decoder_id);
 358                 return NULL;
 359         }
 360
 361         if (!(di = g_try_malloc0(sizeof(*di)))) {
 362                 srd_err("Failed to malloc instance.");
 363                 return NULL;
 364         }
 365
 366         instance_id = g_hash_table_lookup(options, "id");
 367         di->decoder = dec;
 368         di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
 369         g_hash_table_remove(options, "id");
 370
 371         /* Prepare a default probe map, where samples come in the
 372          * order in which the decoder class defined them.
 373          */
 374         di->dec_num_probes = g_slist_length(di->decoder->probes) +
 375                         g_slist_length(di->decoder->extra_probes);
 376         if (di->dec_num_probes) {
 377                 if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
 378                         srd_err("Failed to malloc probe map.");
 379                         g_free(di);
 380                         return NULL;
 381                 }
 382                 for (i = 0; i < di->dec_num_probes; i++)
 383                         di->dec_probemap[i] = i;
 384         }
 385
 386         /* Create a new instance of this decoder class. */
 387         if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
 388                 if (PyErr_Occurred())
 389                         PyErr_Print();
 390                 g_free(di->dec_probemap);
 391                 g_free(di);
 392                 return NULL;
 393         }
 394
 395         if (srd_instance_set_options(di, options) != SRD_OK) {
 396                 g_free(di->dec_probemap);
 397                 g_free(di);
 398                 return NULL;
 399         }
 400
 401         /* Instance takes input from a frontend by default. */
 402         di_list = g_slist_append(di_list, di);
 403
 404         return di;
 405 }
 406
 407 int srd_instance_stack(struct srd_decoder_instance *di_from,
 408                 struct srd_decoder_instance *di_to)
 409 {
 410
 411         if (!di_from || !di_to) {
 412                 srd_err("invalid from/to instance pair");
 413                 return SRD_ERR_ARG;
 414         }
 415
 416         if (!g_slist_find(di_list, di_from)) {
 417                 srd_err("unstacked instance not found");
 418                 return SRD_ERR_ARG;
 419         }
 420
 421         /* Remove from the unstacked list. */
 422         di_list = g_slist_remove(di_list, di_to);
 423
 424         /* Stack on top of source di. */
 425         di_from->next_di = g_slist_append(di_from->next_di, di_to);
 426
 427         return SRD_OK;
 428 }
 429
 430
 431 /* TODO: this should go into the PD stack */
 432 struct srd_decoder_instance *srd_instance_find(char *instance_id)
 433 {
 434         GSList *l;
 435         struct srd_decoder_instance *tmp, *di;
 436
 437         di = NULL;
 438         for (l = di_list; l; l = l->next) {
 439                 tmp = l->data;
 440                 if (!strcmp(tmp->instance_id, instance_id)) {
 441                         di = tmp;
 442                         break;
 443                 }
 444         }
 445
 446         return di;
 447 }
 448
 449 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
 450 {
 451         PyObject *py_name, *py_res;
 452
 453         srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id);
 454
 455         if (!(py_name = PyUnicode_FromString("start"))) {
 456                 srd_err("unable to build python object for 'start'");
 457                 if (PyErr_Occurred())
 458                         PyErr_Print();
 459                 return SRD_ERR_PYTHON;
 460         }
 461
 462         if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
 463                         py_name, args, NULL))) {
 464                 if (PyErr_Occurred())
 465                         PyErr_Print();
 466                 return SRD_ERR_PYTHON;
 467         }
 468
 469         Py_DecRef(py_res);
 470         Py_DecRef(py_name);
 471
 472         return SRD_OK;
 473 }
 474
 475 /**
 476  * Run the specified decoder function.
 477  *
 478  * @param dec TODO
 479  * @param inbuf TODO
 480  * @param inbuflen TODO
 481  *
 482  * @return SRD_OK upon success, a (negative) error code otherwise.
 483  */
 484 int srd_instance_decode(uint64_t start_samplenum,
 485                 struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
 486 {
 487         PyObject *py_instance, *py_res;
 488         srd_logic *logic;
 489         uint64_t end_samplenum;
 490
 491         /* Return an error upon unusable input. */
 492         if (di == NULL)
 493                 return SRD_ERR_ARG; /* TODO: More specific error? */
 494         if (inbuf == NULL)
 495                 return SRD_ERR_ARG; /* TODO: More specific error? */
 496         if (inbuflen == 0) /* No point in working on empty buffers. */
 497                 return SRD_ERR_ARG; /* TODO: More specific error? */
 498
 499         /* TODO: Error handling. */
 500         py_instance = di->py_instance;
 501         Py_XINCREF(py_instance);
 502
 503         logic = PyObject_New(srd_logic, &srd_logic_type);
 504         Py_INCREF(logic);
 505         logic->di = di;
 506         logic->start_samplenum = start_samplenum;
 507         logic->itercnt = 0;
 508         logic->inbuf = inbuf;
 509         logic->inbuflen = inbuflen;
 510         logic->sample = PyList_New(2);
 511         Py_INCREF(logic->sample);
 512
 513         end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
 514         if (!(py_res = PyObject_CallMethod(py_instance, "decode",
 515                         "KKO", logic->start_samplenum, end_samplenum, logic))) {
 516                 if (PyErr_Occurred())
 517                         PyErr_Print(); /* Returns void. */
 518
 519                 return SRD_ERR_PYTHON; /* TODO: More specific error? */
 520         }
 521
 522         Py_XDECREF(py_res);
 523
 524         return SRD_OK;
 525 }
 526
 527
 528 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 529 {
 530         PyObject *args;
 531         GSList *d, *s;
 532         struct srd_decoder_instance *di;
 533         int ret;
 534
 535         if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
 536                 srd_err("unable to build python object for metadata");
 537                 return SRD_ERR_PYTHON;
 538         }
 539
 540         /* Run the start() method on all decoders receiving frontend data. */
 541         for (d = di_list; d; d = d->next) {
 542                 di = d->data;
 543                 di->data_num_probes = num_probes;
 544                 di->data_unitsize = unitsize;
 545                 di->data_samplerate = samplerate;
 546                 if ((ret = srd_instance_start(di, args) != SRD_OK))
 547                         return ret;
 548
 549                 /* Run the start() method on all decoders up the stack from this one. */
 550                 for (s = di->next_di; s; s = s->next) {
 551                         /* These don't need probes, unitsize and samplerate. */
 552                         di = s->data;
 553                         if ((ret = srd_instance_start(di, args) != SRD_OK))
 554                                 return ret;
 555                 }
 556         }
 557
 558         Py_DECREF(args);
 559
 560         return SRD_OK;
 561 }
 562
 563 /* Feed logic samples to decoder session. */
 564 int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
 565 {
 566         GSList *d;
 567         int ret;
 568
 569         for (d = di_list; d; d = d->next) {
 570                 if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
 571                                 inbuflen)) != SRD_OK)
 572                         return ret;
 573         }
 574
 575         return SRD_OK;
 576 }
 577
 578
 579 int pd_add(struct srd_decoder_instance *di, int output_type,
 580                 char *proto_id)
 581 {
 582         struct srd_pd_output *pdo;
 583
 584         if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
 585                 return -1;
 586
 587         /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
 588         pdo->pdo_id = g_slist_length(di->pd_output);
 589         pdo->output_type = output_type;
 590         pdo->decoder = di->decoder;
 591         pdo->proto_id = g_strdup(proto_id);
 592         di->pd_output = g_slist_append(di->pd_output, pdo);
 593
 594         return pdo->pdo_id;
 595 }
 596
 597 struct srd_decoder_instance *get_di_by_decobject(void *decobject)
 598 {
 599         GSList *l, *s;
 600         struct srd_decoder_instance *di;
 601
 602         for (l = di_list; l; l = l->next) {
 603                 di = l->data;
 604                 if (decobject == di->py_instance)
 605                         return di;
 606                 /* Check decoders stacked on top of this one. */
 607                 for (s = di->next_di; s; s = s->next) {
 608                         di = s->data;
 609                         if (decobject == di->py_instance)
 610                                 return di;
 611                 }
 612         }
 613
 614         return NULL;
 615 }
 616
 617 int srd_register_callback(int output_type, void *cb)
 618 {
 619         struct srd_pd_callback *pd_cb;
 620
 621         if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
 622                 return SRD_ERR_MALLOC;
 623
 624         pd_cb->output_type = output_type;
 625         pd_cb->callback = cb;
 626         callbacks = g_slist_append(callbacks, pd_cb);
 627
 628         return SRD_OK;
 629 }
 630
 631 void *srd_find_callback(int output_type)
 632 {
 633         GSList *l;
 634         struct srd_pd_callback *pd_cb;
 635         void *(cb);
 636
 637         cb = NULL;
 638         for (l = callbacks; l; l = l->next) {
 639                 pd_cb = l->data;
 640                 if (pd_cb->output_type == output_type) {
 641                         cb = pd_cb->callback;
 642                         break;
 643                 }
 644         }
 645
 646         return cb;
 647 }
 648