X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=d2056915b831c961c90cc1373ecf395c89e7f478;hp=4fa729ca81430c100cc809c84ada0e9301a19310;hb=4fadb1282f5e9aa41abcb67e7d90cdc4a9b2628d;hpb=e431d9cc4afa5e695efea61fb769f20d86f0bbe0 diff --git a/controller.c b/controller.c index 4fa729c..d205691 100644 --- a/controller.c +++ b/controller.c @@ -26,7 +26,10 @@ #include +/* List of decoder instances. */ static GSList *di_list = NULL; + +/* List of frontend callbacks to receive PD output. */ static GSList *callbacks = NULL; /* lives in decoder.c */ @@ -65,9 +68,12 @@ int srd_init(void) { int ret; + srd_dbg("srd: initializing"); + + /* Add our own module to the list of built-in modules. */ PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); - /* Py_Initialize() returns void and usually cannot fail. */ + /* Initialize the python interpreter. */ Py_Initialize(); if ((ret = set_modulepath()) != SRD_OK) { @@ -98,8 +104,9 @@ int srd_init(void) */ int srd_exit(void) { - /* Unload/free all decoders, and then the list of decoders itself. */ - /* TODO: Error handling. */ + + srd_dbg("srd: exiting"); + srd_unload_all_decoders(); g_slist_free(pd_list); @@ -114,13 +121,36 @@ int srd_exit(void) * Add search directories for the protocol decoders. * * TODO: add path from env var SIGROKDECODE_PATH, config etc + * TODO: Should take directoryname/path as input. */ int set_modulepath(void) { int ret; + gchar *path, *s; + +#ifdef _WIN32 + gchar **splitted; + + /* + * On Windows/MinGW, Python's sys.path needs entries of the form + * 'C:\\foo\\bar' instead of '/foo/bar'. + */ + + splitted = g_strsplit(DECODERS_DIR, "/", 0); + path = g_build_pathv("\\\\", splitted); + g_strfreev(splitted); +#else + path = g_strdup(DECODERS_DIR); +#endif + + /* TODO: Prepend instead of appending. */ + /* TODO: Sanity check on 'path' (length, escape special chars, ...). */ + s = g_strdup_printf("import sys; sys.path.append(r'%s')", path); - PyRun_SimpleString("import sys"); - ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');"); + ret = PyRun_SimpleString(s); + + g_free(path); + g_free(s); return ret; } @@ -163,11 +193,6 @@ int srd_instance_set_options(struct srd_decoder_instance *di, py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; py_optlist = py_classval = NULL; py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); - if (!PyDict_Check(py_dec_options)) { - srd_err("Protocol decoder %s options is not a dictionary.", - di->decoder->name); - goto err_out; - } /* All of these are synthesized objects, so they're good. */ py_dec_optkeys = PyDict_Keys(py_dec_options); @@ -181,6 +206,10 @@ int srd_instance_set_options(struct srd_decoder_instance *di, goto err_out; if (!(py_classval = PyList_GetItem(py_optlist, 1))) goto err_out; + if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { + srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name); + goto err_out; + } if ((value = g_hash_table_lookup(options, key))) { /* An override for this option was provided. */ @@ -194,7 +223,7 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (!(py_optval = PyLong_FromString(value, NULL, 0))) { /* ValueError Exception */ PyErr_Clear(); - srd_err("Option %s has invalid value %s: expected integer", + srd_err("Option %s has invalid value %s: expected integer.", key, value); goto err_out; } @@ -213,7 +242,7 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (val_ull == (unsigned long long)-1) { /* OverFlowError exception */ PyErr_Clear(); - srd_err("Invalid integer value for %s: expected integer", key); + srd_err("Invalid integer value for %s: expected integer.", key); goto err_out; } if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) @@ -238,7 +267,7 @@ err_out: if (key) g_free(key); if (PyErr_Occurred()) { - srd_dbg("stray exception!"); + srd_dbg("srd: stray exception!"); PyErr_Print(); PyErr_Clear(); } @@ -246,6 +275,13 @@ err_out: return ret; } +/* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */ +static gint compare_probe_id(struct srd_probe *a, char *probe_id) +{ + + return strcmp(a->id, probe_id); +} + /** * Set probes in a decoder instance. * @@ -254,34 +290,56 @@ err_out: * the probe number. Samples passed to this instance will be arranged in this * order. * - * Handled probes are removed from the hash. - * * @return SRD_OK upon success, a (negative) error code otherwise. */ int srd_instance_set_probes(struct srd_decoder_instance *di, - GHashTable *probes) + GHashTable *new_probes) { - int ret; + GList *l; + GSList *sl; + struct srd_probe *p; + int *new_probemap, new_probenum; + char *probe_id; - if (g_hash_table_size(probes) == 0) + if (g_hash_table_size(new_probes) == 0) /* No probes provided. */ return SRD_OK; - if(!PyObject_HasAttrString(di->decoder->py_dec, "probes")) + if(di->dec_num_probes == 0) { /* Decoder has no probes. */ - return SRD_OK; + srd_err("Protocol decoder %s has no probes to define.", + di->decoder->name); + return SRD_ERR_ARG; + } - ret = SRD_ERR_PYTHON; + new_probemap = NULL; - /* TODO */ - if (g_hash_table_size(probes) > 0) { - srd_err("Setting probes is not yet supported."); - return SRD_ERR_PYTHON; + if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { + srd_err("Failed to malloc new probe map."); + return SRD_ERR_MALLOC; } - ret = SRD_OK; + for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { + probe_id = l->data; + new_probenum = strtol(g_hash_table_lookup(new_probes, probe_id), NULL, 10); + if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, + (GCompareFunc)compare_probe_id))) { + /* Fall back on optional probes. */ + if (!(sl = g_slist_find_custom(di->decoder->extra_probes, + probe_id, (GCompareFunc)compare_probe_id))) { + srd_err("Protocol decoder %s has no probe '%s'.", + di->decoder->name, probe_id); + g_free(new_probemap); + return SRD_ERR_ARG; + } + } + p = sl->data; + new_probemap[p->order] = new_probenum; + } + g_free(di->dec_probemap); + di->dec_probemap = new_probemap; - return ret; + return SRD_OK; } /** @@ -298,9 +356,10 @@ struct srd_decoder_instance *srd_instance_new(const char *decoder_id, { struct srd_decoder *dec; struct srd_decoder_instance *di; + int i; char *instance_id; - srd_dbg("%s: creating new %s instance", __func__, decoder_id); + srd_dbg("srd: creating new %s instance", decoder_id); if (!(dec = srd_get_decoder_by_id(decoder_id))) { srd_err("Protocol decoder %s not found.", decoder_id); @@ -317,23 +376,39 @@ struct srd_decoder_instance *srd_instance_new(const char *decoder_id, di->instance_id = g_strdup(instance_id ? instance_id : decoder_id); g_hash_table_remove(options, "id"); + /* Prepare a default probe map, where samples come in the + * order in which the decoder class defined them. + */ + di->dec_num_probes = g_slist_length(di->decoder->probes) + + g_slist_length(di->decoder->extra_probes); + if (di->dec_num_probes) { + if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { + srd_err("Failed to malloc probe map."); + g_free(di); + return NULL; + } + for (i = 0; i < di->dec_num_probes; i++) + di->dec_probemap[i] = i; + } + /* Create a new instance of this decoder class. */ if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) { if (PyErr_Occurred()) PyErr_Print(); + g_free(di->dec_probemap); g_free(di); return NULL; } - /* Instance takes input from a frontend by default. */ - di_list = g_slist_append(di_list, di); - if (srd_instance_set_options(di, options) != SRD_OK) { - di_list = g_slist_remove(di_list, di); + g_free(di->dec_probemap); g_free(di); return NULL; } + /* Instance takes input from a frontend by default. */ + di_list = g_slist_append(di_list, di); + return di; } @@ -342,12 +417,12 @@ int srd_instance_stack(struct srd_decoder_instance *di_from, { if (!di_from || !di_to) { - srd_err("invalid from/to instance pair"); + srd_err("Invalid from/to instance pair."); return SRD_ERR_ARG; } if (!g_slist_find(di_list, di_from)) { - srd_err("unstacked instance not found"); + srd_err("Unstacked instance not found."); return SRD_ERR_ARG; } @@ -383,10 +458,11 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) { PyObject *py_name, *py_res; - srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id); + srd_dbg("srd: calling start() method on protocol decoder instance %s", + di->instance_id); if (!(py_name = PyUnicode_FromString("start"))) { - srd_err("unable to build python object for 'start'"); + srd_err("Unable to build python object for 'start'."); if (PyErr_Occurred()) PyErr_Print(); return SRD_ERR_PYTHON; @@ -399,8 +475,8 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) return SRD_ERR_PYTHON; } - Py_XDECREF(py_res); - Py_DECREF(py_name); + Py_DecRef(py_res); + Py_DecRef(py_name); return SRD_OK; } @@ -408,31 +484,41 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) /** * Run the specified decoder function. * - * @param dec TODO - * @param inbuf TODO - * @param inbuflen TODO + * @param start_samplenum The starting sample number for the buffer's sample + * set, relative to the start of capture. + * @param di The decoder instance to call. + * @param inbuf The buffer to decode. + * @param inbuflen Length of the buffer. * * @return SRD_OK upon success, a (negative) error code otherwise. */ int srd_instance_decode(uint64_t start_samplenum, struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen) { - PyObject *py_instance, *py_res; + PyObject *py_res; srd_logic *logic; uint64_t end_samplenum; - /* Return an error upon unusable input. */ - if (di == NULL) - return SRD_ERR_ARG; /* TODO: More specific error? */ - if (inbuf == NULL) - return SRD_ERR_ARG; /* TODO: More specific error? */ - if (inbuflen == 0) /* No point in working on empty buffers. */ - return SRD_ERR_ARG; /* TODO: More specific error? */ + srd_dbg("srd: calling decode() on instance %s with %d bytes starting " + "at sample %d", di->instance_id, inbuflen, start_samplenum); - /* TODO: Error handling. */ - py_instance = di->py_instance; - Py_XINCREF(py_instance); + /* Return an error upon unusable input. */ + if (di == NULL) { + srd_dbg("srd: empty decoder instance"); + return SRD_ERR_ARG; + } + if (inbuf == NULL) { + srd_dbg("srd: NULL buffer pointer"); + return SRD_ERR_ARG; + } + if (inbuflen == 0) { + srd_dbg("srd: empty buffer"); + return SRD_ERR_ARG; + } + /* Create new srd_logic object. Each iteration around the PD's loop + * will fill one sample into this object. + */ logic = PyObject_New(srd_logic, &srd_logic_type); Py_INCREF(logic); logic->di = di; @@ -443,16 +529,16 @@ int srd_instance_decode(uint64_t start_samplenum, logic->sample = PyList_New(2); Py_INCREF(logic->sample); - end_samplenum = start_samplenum + inbuflen / di->unitsize; - if (!(py_res = PyObject_CallMethod(py_instance, "decode", + Py_IncRef(di->py_instance); + end_samplenum = start_samplenum + inbuflen / di->data_unitsize; + if (!(py_res = PyObject_CallMethod(di->py_instance, "decode", "KKO", logic->start_samplenum, end_samplenum, logic))) { if (PyErr_Occurred()) PyErr_Print(); /* Returns void. */ return SRD_ERR_PYTHON; /* TODO: More specific error? */ } - - Py_XDECREF(py_res); + Py_DecRef(py_res); return SRD_OK; } @@ -465,17 +551,23 @@ int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) struct srd_decoder_instance *di; int ret; + srd_dbg("srd: calling start() on all instances with %d probes, " + "unitsize %d samplerate %d", num_probes, unitsize, samplerate); + + /* Currently only one item of metadata is passed along to decoders, + * samplerate. This can be extended as needed. + */ if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { - srd_err("unable to build python object for metadata"); + srd_err("Unable to build python object for metadata."); return SRD_ERR_PYTHON; } /* Run the start() method on all decoders receiving frontend data. */ for (d = di_list; d; d = d->next) { di = d->data; - di->num_probes = num_probes; - di->unitsize = unitsize; - di->samplerate = samplerate; + di->data_num_probes = num_probes; + di->data_unitsize = unitsize; + di->data_samplerate = samplerate; if ((ret = srd_instance_start(di, args) != SRD_OK)) return ret; @@ -488,7 +580,7 @@ int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) } } - Py_DECREF(args); + Py_DecRef(args); return SRD_OK; } @@ -499,6 +591,10 @@ int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen GSList *d; int ret; + srd_dbg("srd: calling decode() on all instances with starting sample " + "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum, + inbuflen, inbuf); + for (d = di_list; d; d = d->next) { if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf, inbuflen)) != SRD_OK) @@ -509,11 +605,50 @@ int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen } +int srd_register_callback(int output_type, void *cb) +{ + struct srd_pd_callback *pd_cb; + + srd_dbg("srd: registering new callback for output type %d", output_type); + + if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) + return SRD_ERR_MALLOC; + + pd_cb->output_type = output_type; + pd_cb->callback = cb; + callbacks = g_slist_append(callbacks, pd_cb); + + return SRD_OK; +} + +void *srd_find_callback(int output_type) +{ + GSList *l; + struct srd_pd_callback *pd_cb; + void *(cb); + + cb = NULL; + for (l = callbacks; l; l = l->next) { + pd_cb = l->data; + if (pd_cb->output_type == output_type) { + cb = pd_cb->callback; + break; + } + } + + return cb; +} + + +/* This is the backend function to python sigrokdecode.add() call. */ int pd_add(struct srd_decoder_instance *di, int output_type, char *proto_id) { struct srd_pd_output *pdo; + srd_dbg("srd: instance %s creating new output type %d for %s", + di->instance_id, output_type, proto_id); + if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) return -1; @@ -547,35 +682,3 @@ struct srd_decoder_instance *get_di_by_decobject(void *decobject) return NULL; } -int srd_register_callback(int output_type, void *cb) -{ - struct srd_pd_callback *pd_cb; - - if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) - return SRD_ERR_MALLOC; - - pd_cb->output_type = output_type; - pd_cb->callback = cb; - callbacks = g_slist_append(callbacks, pd_cb); - - return SRD_OK; -} - -void *srd_find_callback(int output_type) -{ - GSList *l; - struct srd_pd_callback *pd_cb; - void *(cb); - - cb = NULL; - for (l = callbacks; l; l = l->next) { - pd_cb = l->data; - if (pd_cb->output_type == output_type) { - cb = pd_cb->callback; - break; - } - } - - return cb; -} -