X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=ebda088932ea4885f5b834c81e0b914773ee137e;hp=a0e8bfe8d13b240a16dee82c66b4d564d58c323d;hb=21481b6609641fb3076290dad915a3a6259ce05a;hpb=b231546d63396fd6cac381b12b99caf07687e7e3

diff --git a/controller.c b/controller.c
index a0e8bfe..ebda088 100644
--- a/controller.c
+++ b/controller.c
@@ -18,25 +18,19 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "config.h"
 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "sigrokdecode-internal.h"
+#include "config.h"
 #include <glib.h>
 #include <inttypes.h>
+#include <stdlib.h>
 
 
+static GSList *di_list = NULL;
 static GSList *callbacks = NULL;
 
-/* TODO
-static GSList *pipelines = NULL;
-struct srd_pipeline {
-	int id;
-	GSList *decoders;
-};
-*/
-
 /* lives in decoder.c */
 extern GSList *pd_list;
-extern GSList *di_list;
 
 /* lives in module_sigrokdecode.c */
 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
@@ -59,7 +53,7 @@ extern PyTypeObject srd_logic_type;
  * The caller is responsible for calling the clean-up function srd_exit(),
  * which will properly shut down libsigrokdecode and free its allocated memory.
  *
- * Multiple calls to srd_init(), without calling srd_exit() inbetween,
+ * Multiple calls to srd_init(), without calling srd_exit() in between,
  * are not allowed.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
@@ -98,7 +92,7 @@ int srd_init(void)
  *
  * This function should only be called if there was a (successful!) invocation
  * of srd_init() before. Calling this function multiple times in a row, without
- * any successful srd_init() calls inbetween, is not allowed.
+ * any successful srd_init() calls in between, is not allowed.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -120,105 +114,323 @@ 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);
+
+	ret = PyRun_SimpleString(s);
+
+	g_free(path);
+	g_free(s);
+
+	return ret;
+}
+
+
+/**
+ * Set options in a decoder instance.
+ *
+ * @param di Decoder instance.
+ * @param options A GHashTable of options to set.
+ *
+ * Handled options are removed from the hash.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ */
+int srd_instance_set_options(struct srd_decoder_instance *di,
+		GHashTable *options)
+{
+	PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
+	PyObject *py_optlist, *py_classval;
+	Py_UNICODE *py_ustr;
+	unsigned long long int val_ull;
+	int num_optkeys, ret, size, i;
+	char *key, *value;
+
+	if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
+		/* Decoder has no options. */
+		if (g_hash_table_size(options) == 0) {
+			/* No options provided. */
+			return SRD_OK;
+		} else {
+			srd_err("Protocol decoder has no options.");
+			return SRD_ERR_ARG;
+		}
+		return SRD_OK;
+	}
+
+	ret = SRD_ERR_PYTHON;
+	key = NULL;
+	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);
+	num_optkeys = PyList_Size(py_dec_optkeys);
+	if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options")))
+		goto err_out;
+	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);
+		if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
+			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. */
+			if (PyUnicode_Check(py_classval)) {
+				if (!(py_optval = PyUnicode_FromString(value))) {
+					/* Some UTF-8 encoding error. */
+					PyErr_Clear();
+					goto err_out;
+				}
+			} else if (PyLong_Check(py_classval)) {
+				if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
+					/* ValueError Exception */
+					PyErr_Clear();
+					srd_err("Option %s has invalid value %s: expected integer",
+							key, value);
+					goto err_out;
+				}
+			}
+			g_hash_table_remove(options, key);
+		} else {
+			/* Use the class default for this option. */
+			if (PyUnicode_Check(py_classval)) {
+				/* Make a brand new copy of the string. */
+				py_ustr = PyUnicode_AS_UNICODE(py_classval);
+				size = PyUnicode_GET_SIZE(py_classval);
+				py_optval = PyUnicode_FromUnicode(py_ustr, size);
+			} else if (PyLong_Check(py_classval)) {
+				/* Make a brand new copy of the integer. */
+				val_ull = PyLong_AsUnsignedLongLong(py_classval);
+				if (val_ull == (unsigned long long)-1) {
+					/* OverFlowError exception */
+					PyErr_Clear();
+					srd_err("Invalid integer value for %s: expected integer", key);
+					goto err_out;
+				}
+				if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
+					goto err_out;
+			}
+		}
+
+		/* If we got here, py_optval holds a known good new reference
+		 * to the instance option to set.
+		 */
+		if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
+			goto err_out;
+	}
 
-	PyRun_SimpleString("import sys");
-	ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');");
+	ret = SRD_OK;
+
+err_out:
+	Py_XDECREF(py_optlist);
+	Py_XDECREF(py_di_options);
+	Py_XDECREF(py_dec_optkeys);
+	Py_XDECREF(py_dec_options);
+	if (key)
+		g_free(key);
+	if (PyErr_Occurred()) {
+		srd_dbg("stray exception!");
+		PyErr_Print();
+		PyErr_Clear();
+	}
 
 	return ret;
 }
 
+/**
+ * Set probes in a decoder instance.
+ *
+ * @param di Decoder instance.
+ * @param probes A GHashTable of probes to set. Key is probe name, value is
+ * 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)
+{
+	int ret;
+
+	if (g_hash_table_size(probes) == 0)
+		/* No probes provided. */
+		return SRD_OK;
+
+	if(!PyObject_HasAttrString(di->decoder->py_dec, "probes"))
+		/* Decoder has no probes. */
+		return SRD_OK;
+
+	ret = SRD_ERR_PYTHON;
 
-struct srd_decoder_instance *srd_instance_new(const char *id)
+	/* TODO */
+	if (g_hash_table_size(probes) > 0) {
+		srd_err("Setting probes is not yet supported.");
+		return SRD_ERR_PYTHON;
+	}
+
+	ret = SRD_OK;
+
+	return ret;
+}
+
+/**
+ * Create a new protocol decoder instance.
+ *
+ * @param id Decoder 'id' field.
+ * @param options GHashtable of options which override the defaults set in
+ * 	    the decoder class.
+ * @return Pointer to a newly allocated struct srd_decoder_instance, or
+ * 		NULL in case of failure.
+ */
+struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
+		GHashTable *options)
 {
 	struct srd_decoder *dec;
 	struct srd_decoder_instance *di;
-	PyObject *py_args;
+	char *instance_id;
+
+	srd_dbg("%s: creating new %s instance", __func__, decoder_id);
 
-	if (!(dec = srd_get_decoder_by_id(id)))
+	if (!(dec = srd_get_decoder_by_id(decoder_id))) {
+		srd_err("Protocol decoder %s not found.", decoder_id);
 		return NULL;
+	}
 
-	/* TODO: Error handling. Use g_try_malloc(). */
-	di = g_malloc(sizeof(*di));
+	if (!(di = g_try_malloc0(sizeof(*di)))) {
+		srd_err("Failed to malloc instance.");
+		return NULL;
+	}
+
+	instance_id = g_hash_table_lookup(options, "id");
 	di->decoder = dec;
-	di->pd_output = NULL;
-	di->unitsize = 0;
+	di->instance_id = g_strdup(instance_id ? instance_id : decoder_id);
+	g_hash_table_remove(options, "id");
 
-	/* Create an empty Python tuple. */
-	if (!(py_args = PyTuple_New(0))) { /* NEWREF */
+	/* Create a new instance of this decoder class. */
+	if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
 		if (PyErr_Occurred())
-			PyErr_Print(); /* Returns void. */
-
-		return NULL; /* TODO: More specific error? */
+			PyErr_Print();
+		g_free(di);
+		return NULL;
 	}
 
-	/* Create an instance of the 'Decoder' class. */
-	di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL);
-	if (!di->py_instance) {
-		if (PyErr_Occurred())
-			PyErr_Print(); /* Returns void. */
-		Py_XDECREF(py_args);
-		return NULL; /* TODO: More specific error? */
-	}
+	/* Instance takes input from a frontend by default. */
 	di_list = g_slist_append(di_list, di);
 
-	Py_XDECREF(py_args);
+	if (srd_instance_set_options(di, options) != SRD_OK) {
+		di_list = g_slist_remove(di_list, di);
+		g_free(di);
+		return NULL;
+	}
 
 	return di;
 }
 
-
-int srd_instance_set_probe(struct srd_decoder_instance *di,
-			   const char *probename, int num)
+int srd_instance_stack(struct srd_decoder_instance *di_from,
+		struct srd_decoder_instance *di_to)
 {
-	PyObject *probedict, *probenum;
 
-	probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
-	if (!probedict) {
-		if (PyErr_Occurred())
-			PyErr_Print(); /* Returns void. */
+	if (!di_from || !di_to) {
+		srd_err("invalid from/to instance pair");
+		return SRD_ERR_ARG;
+	}
 
-		return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	if (!g_slist_find(di_list, di_from)) {
+		srd_err("unstacked instance not found");
+		return SRD_ERR_ARG;
 	}
 
-	probenum = PyLong_FromLong(num);
-	PyMapping_SetItemString(probedict, (char *)probename, probenum);
+	/* Remove from the unstacked list. */
+	di_list = g_slist_remove(di_list, di_to);
 
-	Py_XDECREF(probenum);
-	Py_XDECREF(probedict);
+	/* Stack on top of source di. */
+	di_from->next_di = g_slist_append(di_from->next_di, di_to);
 
 	return SRD_OK;
 }
 
 
-int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
+/* TODO: this should go into the PD stack */
+struct srd_decoder_instance *srd_instance_find(char *instance_id)
 {
-	PyObject *py_res;
-	GSList *d;
-	struct srd_decoder_instance *di;
-
-	for (d = di_list; d; d = d->next) {
-		di = d->data;
-		di->num_probes = num_probes;
-		di->unitsize = unitsize;
-		di->samplerate = samplerate;
-		if (!(py_res = PyObject_CallMethod(di->py_instance, "start",
-				    "{s:l}",
-					"samplerate", (long)samplerate))) {
-			if (PyErr_Occurred())
-				PyErr_Print(); /* Returns void. */
+	GSList *l;
+	struct srd_decoder_instance *tmp, *di;
 
-			return SRD_ERR_PYTHON; /* TODO: More specific error? */
+	di = NULL;
+	for (l = di_list; l; l = l->next) {
+		tmp = l->data;
+		if (!strcmp(tmp->instance_id, instance_id)) {
+			di = tmp;
+			break;
 		}
-		Py_XDECREF(py_res);
 	}
 
-	return SRD_OK;
+	return di;
 }
 
+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);
+
+	if (!(py_name = PyUnicode_FromString("start"))) {
+		srd_err("unable to build python object for 'start'");
+		if (PyErr_Occurred())
+			PyErr_Print();
+		return SRD_ERR_PYTHON;
+	}
+
+	if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
+			py_name, args, NULL))) {
+		if (PyErr_Occurred())
+			PyErr_Print();
+		return SRD_ERR_PYTHON;
+	}
+
+	Py_XDECREF(py_res);
+	Py_DECREF(py_name);
+
+	return SRD_OK;
+}
 
 /**
  * Run the specified decoder function.
@@ -229,11 +441,12 @@ int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
+int srd_instance_decode(uint64_t start_samplenum,
 		struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
 {
 	PyObject *py_instance, *py_res;
 	srd_logic *logic;
+	uint64_t end_samplenum;
 
 	/* Return an error upon unusable input. */
 	if (di == NULL)
@@ -250,14 +463,16 @@ int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
 	logic = PyObject_New(srd_logic, &srd_logic_type);
 	Py_INCREF(logic);
 	logic->di = di;
+	logic->start_samplenum = start_samplenum;
 	logic->itercnt = 0;
 	logic->inbuf = inbuf;
 	logic->inbuflen = inbuflen;
 	logic->sample = PyList_New(2);
 	Py_INCREF(logic->sample);
 
+	end_samplenum = start_samplenum + inbuflen / di->unitsize;
 	if (!(py_res = PyObject_CallMethod(py_instance, "decode",
-			"KKO", timeoffset, duration, logic))) {
+			"KKO", logic->start_samplenum, end_samplenum, logic))) {
 		if (PyErr_Occurred())
 			PyErr_Print(); /* Returns void. */
 
@@ -270,15 +485,49 @@ int srd_run_decoder(uint64_t timeoffset, uint64_t duration,
 }
 
 
+int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
+{
+	PyObject *args;
+	GSList *d, *s;
+	struct srd_decoder_instance *di;
+	int ret;
+
+	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->num_probes = num_probes;
+		di->unitsize = unitsize;
+		di->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;
+		}
+	}
+
+	Py_DECREF(args);
+
+	return SRD_OK;
+}
+
 /* Feed logic samples to decoder session. */
-int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
-		uint64_t inbuflen)
+int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
 {
 	GSList *d;
 	int ret;
 
 	for (d = di_list; d; d = d->next) {
-		if ((ret = srd_run_decoder(timeoffset, duration, d->data, inbuf,
+		if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
 				inbuflen)) != SRD_OK)
 			return ret;
 	}
@@ -288,7 +537,7 @@ int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
 
 
 int pd_add(struct srd_decoder_instance *di, int output_type,
-		char *protocol_id)
+		char *proto_id)
 {
 	struct srd_pd_output *pdo;
 
@@ -299,7 +548,7 @@ int pd_add(struct srd_decoder_instance *di, int output_type,
 	pdo->pdo_id = g_slist_length(di->pd_output);
 	pdo->output_type = output_type;
 	pdo->decoder = di->decoder;
-	pdo->protocol_id = g_strdup(protocol_id);
+	pdo->proto_id = g_strdup(proto_id);
 	di->pd_output = g_slist_append(di->pd_output, pdo);
 
 	return pdo->pdo_id;
@@ -307,13 +556,19 @@ int pd_add(struct srd_decoder_instance *di, int output_type,
 
 struct srd_decoder_instance *get_di_by_decobject(void *decobject)
 {
-	GSList *l;
+	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;
@@ -351,12 +606,3 @@ void *srd_find_callback(int output_type)
 	return cb;
 }
 
-//int srd_pipeline_new(int plid)
-//{
-//
-//
-//}
-
-
-
-