#include <glib.h>
#include <inttypes.h>
#include <stdlib.h>
+#include <stdint.h>
/**
* @mainpage libsigrokdecode API
* @{
*/
-/* List of decoder instances. */
-static GSList *di_list = NULL;
-
-/* List of frontend callbacks to receive decoder output. */
-static GSList *callbacks = NULL;
-
/** @cond PRIVATE */
+extern GSList *sessions;
+extern int max_session_id;
+
/* decoder.c */
extern SRD_PRIV GSList *pd_list;
int ret;
char *env_path;
+ if (max_session_id != -1) {
+ srd_err("libsigrokdecode is already initialized.");
+ return SRD_ERR;
+ }
+
srd_dbg("Initializing libsigrokdecode.");
/* Add our own module to the list of built-in modules. */
}
}
+ max_session_id = 0;
+
return SRD_OK;
}
*/
SRD_API int srd_exit(void)
{
+ GSList *l;
+
srd_dbg("Exiting libsigrokdecode.");
+ for (l = sessions; l; l = l->next)
+ srd_session_destroy((struct srd_session *)l->data);
+
srd_decoder_unload_all();
g_slist_free(pd_list);
pd_list = NULL;
/* Py_Finalize() returns void, any finalization errors are ignored. */
Py_Finalize();
+ max_session_id = -1;
+
return SRD_OK;
}
const char *val_str;
char *dbg, *key;
+ if (!di) {
+ srd_err("Invalid decoder instance.");
+ return SRD_ERR_ARG;
+ }
+
+ if (!options) {
+ srd_err("Invalid options GHashTable.");
+ return SRD_ERR_ARG;
+ }
+
if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
/* Decoder has no options. */
if (g_hash_table_size(options) == 0) {
/* All of these are synthesized objects, so they're good. */
py_dec_optkeys = PyDict_Keys(py_dec_options);
num_optkeys = PyList_Size(py_dec_optkeys);
+
+ /*
+ * The 'options' dictionary is a class variable, but we need to
+ * change it. Changing it directly will affect the entire class,
+ * so we need to create a new object for it, and populate that
+ * instead.
+ */
if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
goto err_out;
+ Py_DECREF(py_di_options);
+ py_di_options = PyDict_New();
+ PyObject_SetAttrString(di->py_inst, "options", py_di_options);
for (i = 0; i < num_optkeys; i++) {
/* Get the default class value for this option. */
py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
ret = SRD_OK;
err_out:
- Py_XDECREF(py_optlist);
Py_XDECREF(py_di_options);
Py_XDECREF(py_dec_optkeys);
Py_XDECREF(py_dec_options);
g_free(key);
- if (PyErr_Occurred())
+ if (PyErr_Occurred()) {
srd_exception_catch("Stray exception in srd_inst_option_set().");
+ ret = SRD_ERR_PYTHON;
+ }
return ret;
}
GList *l;
GSList *sl;
struct srd_probe *p;
- int *new_probemap, new_probenum;
+ int *new_probemap, new_probenum, num_required_probes, num_probes, i;
char *probe_id;
- int i, num_required_probes;
srd_dbg("set probes called for instance %s with list of %d probes",
di->inst_id, g_hash_table_size(new_probes));
for (i = 0; i < di->dec_num_probes; i++)
new_probemap[i] = -1;
+ num_probes = 0;
for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
probe_id = l->data;
- probe_val= g_hash_table_lookup(new_probes, probe_id);
+ probe_val = g_hash_table_lookup(new_probes, probe_id);
if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
/* Probe name was specified without a value. */
srd_err("No probe number was specified for %s.",
new_probemap[p->order] = new_probenum;
srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
p->id, p->order, new_probenum);
+ num_probes++;
}
+ di->data_unitsize = (num_probes + 7) / 8;
srd_dbg("Final probe map:");
num_required_probes = g_slist_length(di->decoder->probes);
/**
* Create a new protocol decoder instance.
*
+ * @param sess The session holding the protocol decoder instance.
* @param decoder_id Decoder 'id' field.
* @param options GHashtable of options which override the defaults set in
* the decoder class. May be NULL.
* @return Pointer to a newly allocated struct srd_decoder_inst, or
* NULL in case of failure.
*
- * @since 0.1.0
+ * @since 0.3.0
*/
-SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
- GHashTable *options)
+SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
+ const char *decoder_id, GHashTable *options)
{
int i;
struct srd_decoder *dec;
srd_dbg("Creating new %s instance.", decoder_id);
+ if (session_is_valid(sess) != SRD_OK) {
+ srd_err("Invalid session.");
+ return NULL;
+ }
+
if (!(dec = srd_decoder_get_by_id(decoder_id))) {
srd_err("Protocol decoder %s not found.", decoder_id);
return NULL;
}
di->decoder = dec;
+ di->sess = sess;
if (options) {
inst_id = g_hash_table_lookup(options, "id");
di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
* order in which the decoder class defined them.
*/
di->dec_num_probes = g_slist_length(di->decoder->probes) +
- g_slist_length(di->decoder->opt_probes);
+ g_slist_length(di->decoder->opt_probes);
if (di->dec_num_probes) {
if (!(di->dec_probemap =
- g_try_malloc(sizeof(int) * di->dec_num_probes))) {
+ g_try_malloc(sizeof(int) * di->dec_num_probes))) {
srd_err("Failed to g_malloc() probe map.");
g_free(di);
return NULL;
for (i = 0; i < di->dec_num_probes; i++)
di->dec_probemap[i] = i;
}
+ di->data_unitsize = (di->dec_num_probes + 7) / 8;
/* Create a new instance of this decoder class. */
if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
if (PyErr_Occurred())
srd_exception_catch("failed to create %s instance: ",
- decoder_id);
+ 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);
+ sess->di_list = g_slist_append(sess->di_list, di);
return di;
}
/**
* Stack a decoder instance on top of another.
*
+ * @param sess The session holding the protocol decoder instances.
* @param di_from The instance to move.
* @param di_to The instance on top of which di_from will be stacked.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
- * @since 0.1.0
+ * @since 0.3.0
*/
-SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
- struct srd_decoder_inst *di_to)
+SRD_API int srd_inst_stack(struct srd_session *sess,
+ struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to)
{
+
+ if (session_is_valid(sess) != SRD_OK) {
+ srd_err("Invalid session.");
+ return SRD_ERR_ARG;
+ }
+
if (!di_from || !di_to) {
srd_err("Invalid from/to instance pair.");
return SRD_ERR_ARG;
}
- if (g_slist_find(di_list, di_to)) {
+ if (g_slist_find(sess->di_list, di_to)) {
/* Remove from the unstacked list. */
- di_list = g_slist_remove(di_list, di_to);
+ sess->di_list = g_slist_remove(sess->di_list, di_to);
}
/* Stack on top of source di. */
* Only the bottom level of instances are searched -- instances already stacked
* on top of another one will not be found.
*
+ * @param sess The session holding the protocol decoder instance.
* @param inst_id The instance ID to be found.
*
* @return Pointer to struct srd_decoder_inst, or NULL if not found.
*
- * @since 0.1.0
+ * @since 0.3.0
*/
-SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id)
+SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
+ const char *inst_id)
{
GSList *l;
struct srd_decoder_inst *tmp, *di;
+ if (session_is_valid(sess) != SRD_OK) {
+ srd_err("Invalid session.");
+ return NULL;
+ }
+
di = NULL;
- for (l = di_list; l; l = l->next) {
+ for (l = sess->di_list; l; l = l->next) {
tmp = l->data;
if (!strcmp(tmp->inst_id, inst_id)) {
di = tmp;
return di;
}
+static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
+ struct srd_session *sess, const GSList *stack,
+ const PyObject *obj)
+{
+ const GSList *l;
+ struct srd_decoder_inst *tmp, *di;
+
+ if (session_is_valid(sess) != SRD_OK) {
+ srd_err("Invalid session.");
+ return NULL;
+ }
+
+ di = NULL;
+ for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
+ tmp = l->data;
+ if (tmp->py_inst == obj)
+ di = tmp;
+ else if (tmp->next_di)
+ di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
+ }
+
+ return di;
+}
+
/**
* Find a decoder instance by its Python object.
*
* I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
- * This will recurse to find the instance anywhere in the stack tree.
+ * This will recurse to find the instance anywhere in the stack tree of all
+ * sessions.
*
* @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
* stack to search. To start searching at the bottom level of
SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
const PyObject *obj)
{
- const GSList *l;
- struct srd_decoder_inst *tmp, *di;
+ struct srd_decoder_inst *di;
+ struct srd_session *sess;
+ GSList *l;
di = NULL;
- for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
- tmp = l->data;
- if (tmp->py_inst == obj)
- di = tmp;
- else if (tmp->next_di)
- di = srd_inst_find_by_obj(tmp->next_di, obj);
+ for (l = sessions; di == NULL && l != NULL; l = l->next) {
+ sess = l->data;
+ di = srd_sess_inst_find_by_obj(sess, stack, obj);
}
return di;
}
/** @private */
-SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
+SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
{
- PyObject *py_name, *py_res;
+ PyObject *py_res;
GSList *l;
struct srd_decoder_inst *next_di;
+ int ret;
srd_dbg("Calling start() method on protocol decoder instance %s.",
- di->inst_id);
+ di->inst_id);
- if (!(py_name = PyUnicode_FromString("start"))) {
- srd_err("Unable to build Python object for 'start'.");
+ if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
srd_exception_catch("Protocol decoder instance %s: ",
- di->inst_id);
+ di->inst_id);
return SRD_ERR_PYTHON;
}
-
- if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
- py_name, args, NULL))) {
- srd_exception_catch("Protocol decoder instance %s: ",
- di->inst_id);
- return SRD_ERR_PYTHON;
- }
-
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.
- */
+ /* Start all the PDs stacked on top of this one. */
for (l = di->next_di; l; l = l->next) {
next_di = l->data;
- srd_inst_start(next_di, args);
+ if ((ret = srd_inst_start(next_di)) != SRD_OK)
+ return ret;
}
return SRD_OK;
/**
* Run the specified decoder function.
*
+ * @param di The decoder instance to call. Must not be NULL.
* @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 end_samplenum The ending sample number for the buffer's sample
+ * set, relative to the start of capture.
* @param inbuf The buffer to decode. Must not be NULL.
* @param inbuflen Length of the buffer. Must be > 0.
*
*
* @since 0.1.0
*/
-SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
- const struct srd_decoder_inst *di, const uint8_t *inbuf,
- uint64_t inbuflen)
+SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
+ uint64_t start_samplenum, uint64_t end_samplenum,
+ const uint8_t *inbuf, uint64_t inbuflen)
{
PyObject *py_res;
srd_logic *logic;
- uint64_t end_samplenum;
- srd_dbg("Calling decode() on instance %s with %d bytes starting "
- "at sample %d.", di->inst_id, inbuflen, start_samplenum);
+ srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
+ "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
+ start_samplenum);
/* Return an error upon unusable input. */
if (!di) {
Py_INCREF(logic->sample);
Py_IncRef(di->py_inst);
- end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
- "KKO", logic->start_samplenum,
- end_samplenum, logic))) {
- srd_exception_catch("Protocol decoder instance %s: ",
- di->inst_id);
+ "KKO", start_samplenum, end_samplenum, logic))) {
+ srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
return SRD_ERR_PYTHON;
}
Py_DecRef(py_res);
}
/** @private */
-SRD_PRIV void srd_inst_free_all(GSList *stack)
+SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
{
GSList *l;
struct srd_decoder_inst *di;
+ if (session_is_valid(sess) != SRD_OK) {
+ srd_err("Invalid session.");
+ return;
+ }
+
di = NULL;
- for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
+ for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
di = l->data;
if (di->next_di)
- srd_inst_free_all(di->next_di);
+ srd_inst_free_all(sess, di->next_di);
srd_inst_free(di);
}
if (!stack) {
- g_slist_free(di_list);
- di_list = NULL;
+ g_slist_free(sess->di_list);
+ sess->di_list = NULL;
}
}
/** @} */
-/**
- * @defgroup grp_session Session handling
- *
- * Starting and handling decoding sessions.
- *
- * @{
- */
-
-/**
- * Start a decoding session.
- *
- * Decoders, instances and stack must have been prepared beforehand.
- *
- * @param num_probes The number of probes which the incoming feed will contain.
- * @param unitsize The number of bytes per sample in the incoming feed.
- * @param samplerate The samplerate of the incoming feed.
- *
- * @return SRD_OK upon success, a (negative) error code otherwise.
- *
- * @since 0.1.0
- */
-SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
-{
- PyObject *args;
- GSList *d;
- struct srd_decoder_inst *di;
- int ret;
-
- ret = SRD_OK;
-
- 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.");
- 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->data_num_probes = num_probes;
- di->data_unitsize = unitsize;
- di->data_samplerate = samplerate;
- if ((ret = srd_inst_start(di, args)) != SRD_OK)
- break;
- }
-
- Py_DecRef(args);
-
- return ret;
-}
-
-/**
- * Send a chunk of logic sample data to a running decoder session.
- *
- * @param start_samplenum The sample number of the first sample in this chunk.
- * @param inbuf Pointer to sample data.
- * @param inbuflen Length in bytes of the buffer.
- *
- * @return SRD_OK upon success, a (negative) error code otherwise.
- *
- * @since 0.1.0
- */
-SRD_API int srd_session_send(uint64_t start_samplenum, const 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_inst_decode(start_samplenum, d->data, inbuf,
- inbuflen)) != SRD_OK)
- return ret;
- }
-
- return SRD_OK;
-}
-
-/**
- * Register/add a decoder output callback function.
- *
- * The function will be called when a protocol decoder sends output back
- * to the PD controller (except for Python objects, which only go up the
- * stack).
- *
- * @param output_type The output type this callback will receive. Only one
- * callback per output type can be registered.
- * @param cb The function to call. Must not be NULL.
- * @param cb_data Private data for the callback function. Can be NULL.
- *
- * @since 0.1.0
- */
-SRD_API int srd_pd_output_callback_add(int output_type,
- srd_pd_output_callback_t cb, void *cb_data)
-{
- 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)))) {
- srd_err("Failed to g_malloc() struct srd_pd_callback.");
- return SRD_ERR_MALLOC;
- }
-
- pd_cb->output_type = output_type;
- pd_cb->cb = cb;
- pd_cb->cb_data = cb_data;
- callbacks = g_slist_append(callbacks, pd_cb);
-
- return SRD_OK;
-}
-
-/** @private */
-SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(int output_type)
-{
- GSList *l;
- struct srd_pd_callback *tmp, *pd_cb;
-
- pd_cb = NULL;
- for (l = callbacks; l; l = l->next) {
- tmp = l->data;
- if (tmp->output_type == output_type) {
- pd_cb = tmp;
- break;
- }
- }
-
- return pd_cb;
-}
-
-/* This is the backend function to Python sigrokdecode.add() call. */
-/** @private */
-SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
- int output_type, const char *proto_id)
-{
- struct srd_pd_output *pdo;
-
- srd_dbg("Instance %s creating new output type %d for %s.",
- di->inst_id, output_type, proto_id);
-
- if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
- srd_err("Failed to g_malloc() 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;
-}
-
-/** @} */
projects / libsigrokdecode.git / blobdiff