X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=decoder.c;h=3e047221e844f67fd74856410d8d2670389b3094;hb=fdb1a90748f11204293dc8c6e2b559ef8ee8c08e;hp=87df2ad8f839d552494b1c6b6969a5167e5684f4;hpb=1d757906a2f8c881fcbbd1915420aa80a9d5da36;p=libsigrokdecode.git

diff --git a/decoder.c b/decoder.c
index 87df2ad..3e04722 100644
--- a/decoder.c
+++ b/decoder.c
@@ -136,6 +136,18 @@ static void annotation_row_free(void *data)
 	g_free(row);
 }
 
+static void logic_output_channel_free(void *data)
+{
+	struct srd_decoder_logic_output_channel *logic_out_ch = data;
+
+	if (!logic_out_ch)
+		return;
+
+	g_free(logic_out_ch->desc);
+	g_free(logic_out_ch->id);
+	g_free(logic_out_ch);
+}
+
 static void decoder_option_free(void *data)
 {
 	struct srd_decoder_option *opt = data;
@@ -171,6 +183,7 @@ static void decoder_free(struct srd_decoder *dec)
 
 	g_slist_free_full(dec->outputs, g_free);
 	g_slist_free_full(dec->inputs, g_free);
+	g_slist_free_full(dec->tags, g_free);
 	g_free(dec->license);
 	g_free(dec->desc);
 	g_free(dec->longname);
@@ -243,6 +256,7 @@ static int get_channels(const struct srd_decoder *d, const char *attr,
 except_out:
 	srd_exception_catch("Failed to get %s list of %s decoder",
 			attr, d->name);
+
 err_out:
 	g_slist_free_full(pdchl, &channel_free);
 	Py_XDECREF(py_channellist);
@@ -324,8 +338,10 @@ static int get_options(struct srd_decoder *d)
 
 		py_values = PyDict_GetItemString(py_opt, "values");
 		if (py_values) {
-			/* A default is required if a list of values is
-			 * given, since it's used to verify their type. */
+			/*
+			 * A default is required if a list of values is
+			 * given, since it's used to verify their type.
+			 */
 			if (!o->def) {
 				srd_err("No default for option '%s'.", o->id);
 				goto err_out;
@@ -365,6 +381,7 @@ static int get_options(struct srd_decoder *d)
 
 except_out:
 	srd_exception_catch("Failed to get %s decoder options", d->name);
+
 err_out:
 	g_slist_free_full(options, &decoder_option_free);
 	Py_XDECREF(py_opts);
@@ -373,8 +390,7 @@ err_out:
 	return SRD_ERR_PYTHON;
 }
 
-/* Convert annotation class attribute to GSList of char **.
- */
+/* Convert annotation class attribute to GSList of char **. */
 static int get_annotations(struct srd_decoder *dec)
 {
 	PyObject *py_annlist, *py_ann;
@@ -397,8 +413,8 @@ static int get_annotations(struct srd_decoder *dec)
 		goto except_out;
 
 	if (!PyTuple_Check(py_annlist)) {
-		srd_err("Protocol decoder %s annotations should "
-			"be a tuple.", dec->name);
+		srd_err("Protocol decoder %s annotations should be a tuple.",
+			dec->name);
 		goto err_out;
 	}
 
@@ -408,8 +424,7 @@ static int get_annotations(struct srd_decoder *dec)
 			goto except_out;
 
 		if (!PyTuple_Check(py_ann) || PyTuple_Size(py_ann) != 2) {
-			srd_err("Protocol decoder %s annotation %zd should "
-				"be a tuple with two elements.",
+			srd_err("Protocol decoder %s annotation %zd should be a tuple with two elements.",
 				dec->name, i + 1);
 			goto err_out;
 		}
@@ -426,6 +441,7 @@ static int get_annotations(struct srd_decoder *dec)
 
 except_out:
 	srd_exception_catch("Failed to get %s decoder annotations", dec->name);
+
 err_out:
 	g_slist_free_full(annotations, (GDestroyNotify)&g_strfreev);
 	Py_XDECREF(py_annlist);
@@ -434,10 +450,11 @@ err_out:
 	return SRD_ERR_PYTHON;
 }
 
-/* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'.
- */
+/* Convert annotation_rows to GSList of 'struct srd_decoder_annotation_row'. */
 static int get_annotation_rows(struct srd_decoder *dec)
 {
+	const char *py_member_name = "annotation_rows";
+
 	PyObject *py_ann_rows, *py_ann_row, *py_ann_classes, *py_item;
 	GSList *annotation_rows;
 	struct srd_decoder_annotation_row *ann_row;
@@ -447,20 +464,20 @@ static int get_annotation_rows(struct srd_decoder *dec)
 
 	gstate = PyGILState_Ensure();
 
-	if (!PyObject_HasAttrString(dec->py_dec, "annotation_rows")) {
+	if (!PyObject_HasAttrString(dec->py_dec, py_member_name)) {
 		PyGILState_Release(gstate);
 		return SRD_OK;
 	}
 
 	annotation_rows = NULL;
 
-	py_ann_rows = PyObject_GetAttrString(dec->py_dec, "annotation_rows");
+	py_ann_rows = PyObject_GetAttrString(dec->py_dec, py_member_name);
 	if (!py_ann_rows)
 		goto except_out;
 
 	if (!PyTuple_Check(py_ann_rows)) {
-		srd_err("Protocol decoder %s annotation_rows "
-			"must be a tuple.", dec->name);
+		srd_err("Protocol decoder %s %s must be a tuple.",
+			dec->name, py_member_name);
 		goto err_out;
 	}
 
@@ -470,9 +487,8 @@ static int get_annotation_rows(struct srd_decoder *dec)
 			goto except_out;
 
 		if (!PyTuple_Check(py_ann_row) || PyTuple_Size(py_ann_row) != 3) {
-			srd_err("Protocol decoder %s annotation_rows "
-				"must contain only tuples of 3 elements.",
-				dec->name);
+			srd_err("Protocol decoder %s %s must contain only tuples of 3 elements.",
+				dec->name, py_member_name);
 			goto err_out;
 		}
 		ann_row = g_malloc0(sizeof(struct srd_decoder_annotation_row));
@@ -496,9 +512,8 @@ static int get_annotation_rows(struct srd_decoder *dec)
 			goto except_out;
 
 		if (!PyTuple_Check(py_ann_classes)) {
-			srd_err("Protocol decoder %s annotation_rows tuples "
-				"must have a tuple of numbers as 3rd element.",
-				dec->name);
+			srd_err("Protocol decoder %s %s tuples must have a tuple of numbers as 3rd element.",
+				dec->name, py_member_name);
 			goto err_out;
 		}
 
@@ -508,8 +523,7 @@ static int get_annotation_rows(struct srd_decoder *dec)
 				goto except_out;
 
 			if (!PyLong_Check(py_item)) {
-				srd_err("Protocol decoder %s annotation row "
-					"class tuple must only contain numbers.",
+				srd_err("Protocol decoder %s annotation row class tuple must only contain numbers.",
 					dec->name);
 				goto err_out;
 			}
@@ -530,6 +544,7 @@ static int get_annotation_rows(struct srd_decoder *dec)
 except_out:
 	srd_exception_catch("Failed to get %s decoder annotation rows",
 			dec->name);
+
 err_out:
 	g_slist_free_full(annotation_rows, &annotation_row_free);
 	Py_XDECREF(py_ann_rows);
@@ -538,8 +553,7 @@ err_out:
 	return SRD_ERR_PYTHON;
 }
 
-/* Convert binary classes to GSList of char **.
- */
+/* Convert binary classes to GSList of char **. */
 static int get_binary_classes(struct srd_decoder *dec)
 {
 	PyObject *py_bin_classes, *py_bin_class;
@@ -593,6 +607,7 @@ static int get_binary_classes(struct srd_decoder *dec)
 except_out:
 	srd_exception_catch("Failed to get %s decoder binary classes",
 			dec->name);
+
 err_out:
 	g_slist_free_full(bin_classes, (GDestroyNotify)&g_strfreev);
 	Py_XDECREF(py_bin_classes);
@@ -601,8 +616,80 @@ err_out:
 	return SRD_ERR_PYTHON;
 }
 
-/* Check whether the Decoder class defines the named method.
- */
+/* Convert logic_output_channels to GSList of 'struct srd_decoder_logic_output_channel'. */
+static int get_logic_output_channels(struct srd_decoder *dec)
+{
+	PyObject *py_logic_out_chs, *py_logic_out_ch, *py_item;
+	GSList *logic_out_chs;
+	struct srd_decoder_logic_output_channel *logic_out_ch;
+	ssize_t i;
+	PyGILState_STATE gstate;
+
+	gstate = PyGILState_Ensure();
+
+	if (!PyObject_HasAttrString(dec->py_dec, "logic_output_channels")) {
+		PyGILState_Release(gstate);
+		return SRD_OK;
+	}
+
+	logic_out_chs = NULL;
+
+	py_logic_out_chs = PyObject_GetAttrString(dec->py_dec, "logic_output_channels");
+	if (!py_logic_out_chs)
+		goto except_out;
+
+	if (!PyTuple_Check(py_logic_out_chs)) {
+		srd_err("Protocol decoder %s logic_output_channels "
+			"must be a tuple.", dec->name);
+		goto err_out;
+	}
+
+	for (i = PyTuple_Size(py_logic_out_chs) - 1; i >= 0; i--) {
+		py_logic_out_ch = PyTuple_GetItem(py_logic_out_chs, i);
+		if (!py_logic_out_ch)
+			goto except_out;
+
+		if (!PyTuple_Check(py_logic_out_ch) || PyTuple_Size(py_logic_out_ch) != 2) {
+			srd_err("Protocol decoder %s logic_output_channels "
+				"must contain only tuples of 2 elements.",
+				dec->name);
+			goto err_out;
+		}
+		logic_out_ch = g_malloc0(sizeof(*logic_out_ch));
+		/* Add to list right away so it doesn't get lost. */
+		logic_out_chs = g_slist_prepend(logic_out_chs, logic_out_ch);
+
+		py_item = PyTuple_GetItem(py_logic_out_ch, 0);
+		if (!py_item)
+			goto except_out;
+		if (py_str_as_str(py_item, &logic_out_ch->id) != SRD_OK)
+			goto err_out;
+
+		py_item = PyTuple_GetItem(py_logic_out_ch, 1);
+		if (!py_item)
+			goto except_out;
+		if (py_str_as_str(py_item, &logic_out_ch->desc) != SRD_OK)
+			goto err_out;
+	}
+	dec->logic_output_channels = logic_out_chs;
+	Py_DECREF(py_logic_out_chs);
+	PyGILState_Release(gstate);
+
+	return SRD_OK;
+
+except_out:
+	srd_exception_catch("Failed to get %s decoder logic output channels",
+			dec->name);
+
+err_out:
+	g_slist_free_full(logic_out_chs, &logic_output_channel_free);
+	Py_XDECREF(py_logic_out_chs);
+	PyGILState_Release(gstate);
+
+	return SRD_ERR_PYTHON;
+}
+
+/* Check whether the Decoder class defines the named method. */
 static int check_method(PyObject *py_dec, const char *mod_name,
 		const char *method_name)
 {
@@ -664,6 +751,53 @@ SRD_PRIV long srd_decoder_apiver(const struct srd_decoder *d)
 	return apiver;
 }
 
+static gboolean contains_duplicates(GSList *list)
+{
+	for (GSList *l1 = list; l1; l1 = l1->next) {
+		for (GSList *l2 = l1->next; l2; l2 = l2->next)
+			if (!strcmp(l1->data, l2->data))
+				return TRUE;
+	}
+
+	return FALSE;
+}
+
+static gboolean contains_duplicate_ids(GSList *list1, GSList *list2)
+{
+	for (GSList *l1 = list1; l1; l1 = l1->next) {
+		unsigned int cnt = 0;
+		const char **s1 = l1->data;
+		for (GSList *l2 = list2; l2; l2 = l2->next) {
+			const char **s2 = l2->data;
+			if (!strcmp(s1[0], s2[0]))
+				cnt++;
+			if ((list1 == list2) && cnt > 1)
+				return TRUE;
+			if ((list1 != list2) && cnt > 0)
+				return TRUE;
+		}
+	}
+
+	return FALSE;
+}
+
+static gboolean contains_duplicate_row_ids(GSList *list1, GSList *list2)
+{
+	for (GSList *l1 = list1; l1; l1 = l1->next) {
+		unsigned int cnt = 0;
+		const struct srd_decoder_annotation_row *r1 = l1->data;
+		for (GSList *l2 = list2; l2; l2 = l2->next) {
+			const struct srd_decoder_annotation_row *r2 = l2->data;
+			if (!strcmp(r1->id, r2->id))
+				cnt++;
+			if (cnt > 1)
+				return TRUE;
+		}
+	}
+
+	return FALSE;
+}
+
 /**
  * Load a protocol decoder module into the embedded Python interpreter.
  *
@@ -746,8 +880,13 @@ SRD_API int srd_decoder_load(const char *module_name)
 		goto err_out;
 	}
 
-	/* Check Decoder class for required methods.
-	 */
+	/* Check Decoder class for required methods. */
+
+	if (check_method(d->py_dec, module_name, "reset") != SRD_OK) {
+		fail_txt = "no 'reset()' method";
+		goto err_out;
+	}
+
 	if (check_method(d->py_dec, module_name, "start") != SRD_OK) {
 		fail_txt = "no 'start()' method";
 		goto err_out;
@@ -794,6 +933,11 @@ SRD_API int srd_decoder_load(const char *module_name)
 		goto err_out;
 	}
 
+	if (py_attr_as_strlist(d->py_dec, "tags", &(d->tags)) != SRD_OK) {
+		fail_txt = "missing or malformed 'tags' attribute";
+		goto err_out;
+	}
+
 	/* All options and their default values. */
 	if (get_options(d) != SRD_OK) {
 		fail_txt = "cannot get options";
@@ -828,6 +972,66 @@ SRD_API int srd_decoder_load(const char *module_name)
 		goto err_out;
 	}
 
+	if (contains_duplicates(d->inputs)) {
+		fail_txt = "duplicate input IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicates(d->outputs)) {
+		fail_txt = "duplicate output IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicates(d->tags)) {
+		fail_txt = "duplicate tags";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->channels, d->channels)) {
+		fail_txt = "duplicate channel IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->opt_channels, d->opt_channels)) {
+		fail_txt = "duplicate optional channel IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->channels, d->opt_channels)) {
+		fail_txt = "channel and optional channel IDs contain duplicates";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->options, d->options)) {
+		fail_txt = "duplicate option IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->annotations, d->annotations)) {
+		fail_txt = "duplicate annotation class IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicate_row_ids(d->annotation_rows, d->annotation_rows)) {
+		fail_txt = "duplicate annotation row IDs";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->annotations, d->annotation_rows)) {
+		fail_txt = "annotation class/row IDs contain duplicates";
+		goto err_out;
+	}
+
+	if (contains_duplicate_ids(d->binary, d->binary)) {
+		fail_txt = "duplicate binary class IDs";
+		goto err_out;
+	}
+
+	if (get_logic_output_channels(d) != SRD_OK) {
+		fail_txt = "cannot get logic output channels";
+		goto err_out;
+	}
+
 	PyGILState_Release(gstate);
 
 	/* Append it to the list of loaded decoders. */
@@ -842,6 +1046,7 @@ except_out:
 				    module_name, fail_txt);
 	}
 	fail_txt = NULL;
+
 err_out:
 	if (fail_txt)
 		srd_err("Failed to load decoder %s: %s", module_name, fail_txt);
@@ -854,7 +1059,7 @@ err_out:
 /**
  * Return a protocol decoder's docstring.
  *
- * @param dec The loaded protocol decoder.
+ * @param dec The loaded protocol decoder. Must not be NULL.
  *
  * @return A newly allocated buffer containing the protocol decoder's
  *         documentation. The caller is responsible for free'ing the buffer.
@@ -870,7 +1075,7 @@ SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
 	if (!srd_check_init())
 		return NULL;
 
-	if (!dec)
+	if (!dec || !dec->py_mod)
 		return NULL;
 
 	gstate = PyGILState_Ensure();
@@ -1027,21 +1232,21 @@ static void srd_decoder_load_all_path(char *path)
 	const gchar *direntry;
 
 	if (!(dir = g_dir_open(path, 0, NULL))) {
-		/* Not really fatal */
-		/* Try zipimport method too */
+		/* Not really fatal. Try zipimport method too. */
 		srd_decoder_load_all_zip_path(path);
 		return;
 	}
 
-	/* This ignores errors returned by srd_decoder_load(). That
+	/*
+	 * This ignores errors returned by srd_decoder_load(). That
 	 * function will have logged the cause, but in any case we
-	 * want to continue anyway. */
+	 * want to continue anyway.
+	 */
 	while ((direntry = g_dir_read_name(dir)) != NULL) {
 		/* The directory name is the module name (e.g. "i2c"). */
 		srd_decoder_load(direntry);
 	}
 	g_dir_close(dir);
-
 }
 
 /**
@@ -1064,6 +1269,13 @@ SRD_API int srd_decoder_load_all(void)
 	return SRD_OK;
 }
 
+static void srd_decoder_unload_cb(void *arg, void *ignored)
+{
+	(void)ignored;
+
+	srd_decoder_unload((struct srd_decoder *)arg);
+}
+
 /**
  * Unload all loaded protocol decoders.
  *
@@ -1073,7 +1285,7 @@ SRD_API int srd_decoder_load_all(void)
  */
 SRD_API int srd_decoder_unload_all(void)
 {
-	g_slist_foreach(pd_list, (GFunc)srd_decoder_unload, NULL);
+	g_slist_foreach(pd_list, srd_decoder_unload_cb, NULL);
 	g_slist_free(pd_list);
 	pd_list = NULL;