#include <stdlib.h>
+/* 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 */
{
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) {
*/
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);
/**
- * 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)
{
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);
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;
}
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)))
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("srd: 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)
{
GSList *sl;
struct srd_probe *p;
int *new_probemap, new_probenum;
- char *probe_id;
+ char *probe_id, *probenum_str;
if (g_hash_table_size(new_probes) == 0)
/* No probes provided. */
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);
+ 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'",
+ srd_err("Protocol decoder %s has no probe '%s'.",
di->decoder->name, probe_id);
g_free(new_probemap);
return SRD_ERR_ARG;
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);
/* 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;
{
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;
}
{
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'");
- 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;
}
/**
* 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;
logic->sample = PyList_New(2);
Py_INCREF(logic->sample);
+ Py_IncRef(di->py_instance);
end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
- if (!(py_res = PyObject_CallMethod(py_instance, "decode",
+ 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;
}
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;
}
}
}
- Py_DECREF(args);
+ Py_DecRef(args);
return SRD_OK;
}
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)
}
+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;
/* 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->di = di;
pdo->proto_id = g_strdup(proto_id);
di->pd_output = g_slist_append(di->pd_output, pdo);
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;
-}
-