X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=ac0d73fc1be80a23cbbbe14c6183376fef687500;hp=f5e272edea49b8c1d5b17bee1502456ec7f9e61a;hb=ce46beed20cef3262cdf8a921fdf7632f0356227;hpb=639c56898e88aae99a7b91a5c6d2b7870956d648 diff --git a/controller.c b/controller.c index f5e272e..ac0d73f 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("Initializing libsigrokdecode."); + + /* 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("Exiting libsigrokdecode."); + srd_unload_all_decoders(); g_slist_free(pd_list); @@ -111,10 +118,19 @@ int srd_exit(void) /** - * Add search directories for the protocol decoders. + * Add an additional search directory for the protocol decoders. + * + * The specified directory is prepended (not appended!) to Python's sys.path, + * in order to search for sigrok protocol decoders in the specified + * directories first, and in the generic Python module directories (and in + * the current working directory) last. This avoids conflicts if there are + * Python modules which have the same name as a sigrok protocol decoder in + * sys.path or in the current working directory. * * TODO: add path from env var SIGROKDECODE_PATH, config etc * TODO: Should take directoryname/path as input. + * + * @return TODO. */ int set_modulepath(void) { @@ -136,9 +152,8 @@ int set_modulepath(void) 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); + s = g_strdup_printf("import sys; sys.path.insert(0, r'%s')", path); ret = PyRun_SimpleString(s); @@ -186,11 +201,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); @@ -204,6 +214,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. */ @@ -217,7 +231,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; } @@ -236,7 +250,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))) @@ -260,15 +274,19 @@ err_out: Py_XDECREF(py_dec_options); if (key) g_free(key); - if (PyErr_Occurred()) { - srd_dbg("stray exception!"); - PyErr_Print(); - PyErr_Clear(); - } + if (PyErr_Occurred()) + catch_exception("Stray exception in srd_instance_set_options()."); 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. * @@ -277,34 +295,67 @@ 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, *probenum_str; - if (g_hash_table_size(probes) == 0) + srd_dbg("set probes called for instance %s with list of %d probes", + di->instance_id, g_hash_table_size(new_probes)); + + 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; + probenum_str = g_hash_table_lookup(new_probes, probe_id); + if (!probenum_str) { + /* Probe name was specified without a value. */ + srd_err("No probe number was specified for %s.", probe_id); + g_free(new_probemap); + return SRD_ERR_ARG; + } + new_probenum = strtol(probenum_str, 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; + srd_dbg("setting probe mapping for %d = probe %d", p->order, new_probenum); + } + g_free(di->dec_probemap); + di->dec_probemap = new_probemap; - return ret; + return SRD_OK; } /** @@ -321,9 +372,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("Creating new %s instance.", decoder_id); if (!(dec = srd_get_decoder_by_id(decoder_id))) { srd_err("Protocol decoder %s not found.", decoder_id); @@ -340,23 +392,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(); + catch_exception("failed to create %s instance: ", decoder_id); + 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; } @@ -365,27 +433,31 @@ 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"); - return SRD_ERR_ARG; + if (g_slist_find(di_list, di_to)) { + /* Remove from the unstacked list. */ + di_list = g_slist_remove(di_list, di_to); } - /* Remove from the unstacked list. */ - di_list = g_slist_remove(di_list, di_to); - /* Stack on top of source di. */ di_from->next_di = g_slist_append(di_from->next_di, di_to); return SRD_OK; } - -/* TODO: this should go into the PD stack */ -struct srd_decoder_instance *srd_instance_find(char *instance_id) +/** + * Finds a decoder instance by its instance id, but only in the bottom + * level of instances -- instances already stacked on top of another one + * will not be found. + * + * @param instance_id The instance id to be found. + * + * @return Pointer to struct srd_decoder_instance, or NULL if not found. + */ +struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id) { GSList *l; struct srd_decoder_instance *tmp, *di; @@ -402,28 +474,68 @@ struct srd_decoder_instance *srd_instance_find(char *instance_id) return di; } +/** + * Finds a decoder instance by its python object, i.e. that instance's + * instantiation of the sigrokdecode.Decoder class. This will recurse + * to find the instance anywhere in the stack tree. + * + * @param stack Pointer to a GSList of struct srd_decoder_instance, + * indicating the stack to search. To start searching at the bottom + * level of decoder instances, pass NULL. + * @param obj The python class instantiation. + * + * @return Pointer to struct srd_decoder_instance, or NULL if not found. + */ +struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack, + PyObject *obj) +{ + GSList *l; + struct srd_decoder_instance *tmp, *di; + + di = NULL; + for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { + tmp = l->data; + if (tmp->py_instance == obj) + di = tmp; + else if (tmp->next_di) + di = srd_instance_find_by_obj(tmp->next_di, obj); + } + + return di; +} + int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) { PyObject *py_name, *py_res; + GSList *l; + struct srd_decoder_instance *next_di; - srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id); + srd_dbg("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'"); - if (PyErr_Occurred()) - PyErr_Print(); + srd_err("Unable to build python object for 'start'."); + catch_exception("Protocol decoder instance %s: ", di->instance_id); return SRD_ERR_PYTHON; } if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance, py_name, args, NULL))) { - if (PyErr_Occurred()) - PyErr_Print(); + catch_exception("Protocol decoder instance %s: ", di->instance_id); return SRD_ERR_PYTHON; } - Py_XDECREF(py_res); - Py_DECREF(py_name); + Py_DecRef(py_res); + Py_DecRef(py_name); + + /* Start all the PDs stacked on top of this one. Pass along the + * metadata all the way from the bottom PD, even though it's only + * applicable to logic data for now. + */ + for (l = di->next_di; l; l = l->next) { + next_di = l->data; + srd_instance_start(next_di, args); + } return SRD_OK; } @@ -431,31 +543,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. Must not be NULL. + * @param inbuf The buffer to decode. Must not be NULL. + * @param inbuflen Length of the buffer. Must be > 0. * * @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) + 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("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) { + srd_dbg("empty decoder instance"); + return SRD_ERR_ARG; + } + if (!inbuf) { + srd_dbg("NULL buffer pointer"); + return SRD_ERR_ARG; + } + if (inbuflen == 0) { + srd_dbg("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; @@ -466,16 +588,14 @@ 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. */ - + catch_exception("Protocol decoder instance %s: ", di->instance_id); return SRD_ERR_PYTHON; /* TODO: More specific error? */ } - - Py_XDECREF(py_res); + Py_DecRef(py_res); return SRD_OK; } @@ -484,36 +604,34 @@ int srd_instance_decode(uint64_t start_samplenum, int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) { PyObject *args; - GSList *d, *s; + GSList *d; struct srd_decoder_instance *di; int ret; + srd_dbg("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; - - /* Run the start() method on all decoders up the stack from this one. */ - for (s = di->next_di; s; s = s->next) { - /* These don't need probes, unitsize and samplerate. */ - di = s->data; - if ((ret = srd_instance_start(di, args) != SRD_OK)) - return ret; - } + break; } - Py_DECREF(args); + Py_DecRef(args); - return SRD_OK; + return ret; } /* Feed logic samples to decoder session. */ @@ -522,6 +640,10 @@ int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen GSList *d; int ret; + srd_dbg("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) @@ -532,48 +654,12 @@ int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen } -int pd_add(struct srd_decoder_instance *di, int output_type, - char *proto_id) -{ - struct srd_pd_output *pdo; - - if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) - return -1; - - /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ - pdo->pdo_id = g_slist_length(di->pd_output); - pdo->output_type = output_type; - pdo->decoder = di->decoder; - pdo->proto_id = g_strdup(proto_id); - di->pd_output = g_slist_append(di->pd_output, pdo); - - return pdo->pdo_id; -} - -struct srd_decoder_instance *get_di_by_decobject(void *decobject) -{ - GSList *l, *s; - struct srd_decoder_instance *di; - - for (l = di_list; l; l = l->next) { - di = l->data; - if (decobject == di->py_instance) - return di; - /* Check decoders stacked on top of this one. */ - for (s = di->next_di; s; s = s->next) { - di = s->data; - if (decobject == di->py_instance) - return di; - } - } - - return NULL; -} - int srd_register_callback(int output_type, void *cb) { struct srd_pd_callback *pd_cb; + srd_dbg("Registering new callback for output type %d.", output_type); + if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) return SRD_ERR_MALLOC; @@ -602,3 +688,25 @@ void *srd_find_callback(int output_type) 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("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; + + /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ + pdo->pdo_id = g_slist_length(di->pd_output); + pdo->output_type = output_type; + pdo->di = di; + pdo->proto_id = g_strdup(proto_id); + di->pd_output = g_slist_append(di->pd_output, pdo); + + return pdo->pdo_id; +} +