2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode-internal.h"
31 extern GSList *sessions;
34 extern SRD_PRIV PyTypeObject srd_logic_type;
41 * Decoder instance handling.
45 * @defgroup grp_instances Decoder instances
47 * Decoder instance handling.
53 * Set one or more options in a decoder instance.
55 * Handled options are removed from the hash.
57 * @param di Decoder instance.
58 * @param options A GHashTable of options to set.
60 * @return SRD_OK upon success, a (negative) error code otherwise.
64 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
67 struct srd_decoder_option *sdo;
68 PyObject *py_di_options, *py_optval;
77 srd_err("Invalid decoder instance.");
82 srd_err("Invalid options GHashTable.");
86 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
87 /* Decoder has no options. */
88 if (g_hash_table_size(options) == 0) {
89 /* No options provided. */
92 srd_err("Protocol decoder has no options.");
102 * The 'options' tuple is a class variable, but we need to
103 * change it. Changing it directly will affect the entire class,
104 * so we need to create a new object for it, and populate that
107 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
109 Py_DECREF(py_di_options);
110 py_di_options = PyDict_New();
111 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
113 for (l = di->decoder->options; l; l = l->next) {
115 if ((value = g_hash_table_lookup(options, sdo->id))) {
116 /* A value was supplied for this option. */
117 if (!g_variant_type_equal(g_variant_get_type(value),
118 g_variant_get_type(sdo->def))) {
119 srd_err("Option '%s' should have the same type "
120 "as the default value.", sdo->id);
124 /* Use default for this option. */
127 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
128 val_str = g_variant_get_string(value, NULL);
129 if (!(py_optval = PyUnicode_FromString(val_str))) {
130 /* Some UTF-8 encoding error. */
132 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
135 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
136 val_int = g_variant_get_int64(value);
137 if (!(py_optval = PyLong_FromLong(val_int))) {
138 /* ValueError Exception */
140 srd_err("Option '%s' has invalid integer value.", sdo->id);
143 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
144 val_double = g_variant_get_double(value);
145 if (!(py_optval = PyFloat_FromDouble(val_double))) {
146 /* ValueError Exception */
148 srd_err("Option '%s' has invalid float value.", sdo->id);
152 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
154 /* Not harmful even if we used the default. */
155 g_hash_table_remove(options, sdo->id);
157 if (g_hash_table_size(options) != 0)
158 srd_warn("Unknown options specified for '%s'", di->inst_id);
163 Py_XDECREF(py_optval);
164 if (PyErr_Occurred()) {
165 srd_exception_catch("Stray exception in srd_inst_option_set().");
166 ret = SRD_ERR_PYTHON;
172 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
173 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
175 return strcmp(a->id, probe_id);
179 * Set all probes in a decoder instance.
181 * This function sets _all_ probes for the specified decoder instance, i.e.,
182 * it overwrites any probes that were already defined (if any).
184 * @param di Decoder instance.
185 * @param new_probes A GHashTable of probes to set. Key is probe name, value is
186 * the probe number. Samples passed to this instance will be
187 * arranged in this order.
188 * @param unit_size Number of bytes per sample in the data stream to be passed
189 * to the decoder. The highest probe index specified in the
190 * probe map must lie within a sample unit.
192 * @return SRD_OK upon success, a (negative) error code otherwise.
196 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
197 GHashTable *new_probes, int unit_size)
203 int *new_probemap, new_probenum, num_required_probes, i;
206 srd_dbg("set probes called for instance %s with list of %d probes",
207 di->inst_id, g_hash_table_size(new_probes));
209 if (g_hash_table_size(new_probes) == 0)
210 /* No probes provided. */
213 if (di->dec_num_probes == 0) {
214 /* Decoder has no probes. */
215 srd_err("Protocol decoder %s has no probes to define.",
222 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
223 srd_err("Failed to g_malloc() new probe map.");
224 return SRD_ERR_MALLOC;
228 * For now, map all indexes to probe -1 (can be overridden later).
229 * This -1 is interpreted as an unspecified probe later.
231 for (i = 0; i < di->dec_num_probes; i++)
232 new_probemap[i] = -1;
234 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
236 probe_val = g_hash_table_lookup(new_probes, probe_id);
237 if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
238 /* Probe name was specified without a value. */
239 srd_err("No probe number was specified for %s.",
241 g_free(new_probemap);
244 new_probenum = g_variant_get_int32(probe_val);
245 if (new_probenum >= 8 * unit_size) {
246 srd_err("Probe index %d not within data unit (%d bit).",
247 new_probenum, 8 * unit_size);
248 g_free(new_probemap);
251 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
252 (GCompareFunc)compare_probe_id))) {
253 /* Fall back on optional probes. */
254 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
255 probe_id, (GCompareFunc) compare_probe_id))) {
256 srd_err("Protocol decoder %s has no probe "
257 "'%s'.", di->decoder->name, probe_id);
258 g_free(new_probemap);
263 new_probemap[p->order] = new_probenum;
264 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
265 p->id, p->order, new_probenum);
267 di->data_unitsize = unit_size;
269 srd_dbg("Final probe map:");
270 num_required_probes = g_slist_length(di->decoder->probes);
271 for (i = 0; i < di->dec_num_probes; i++) {
272 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
273 (i < num_required_probes) ? "required" : "optional");
276 /* Report an error if not all required probes were specified. */
277 for (i = 0; i < num_required_probes; i++) {
278 if (new_probemap[i] != -1)
280 p = g_slist_nth(di->decoder->probes, i)->data;
281 srd_err("Required probe '%s' (index %d) was not specified.",
286 g_free(di->dec_probemap);
287 di->dec_probemap = new_probemap;
293 * Create a new protocol decoder instance.
295 * @param sess The session holding the protocol decoder instance.
296 * @param decoder_id Decoder 'id' field.
297 * @param options GHashtable of options which override the defaults set in
298 * the decoder class. May be NULL.
300 * @return Pointer to a newly allocated struct srd_decoder_inst, or
301 * NULL in case of failure.
305 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
306 const char *decoder_id, GHashTable *options)
309 struct srd_decoder *dec;
310 struct srd_decoder_inst *di;
313 srd_dbg("Creating new %s instance.", decoder_id);
315 if (session_is_valid(sess) != SRD_OK) {
316 srd_err("Invalid session.");
320 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
321 srd_err("Protocol decoder %s not found.", decoder_id);
325 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
326 srd_err("Failed to g_malloc() instance.");
333 inst_id = g_hash_table_lookup(options, "id");
334 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
335 g_hash_table_remove(options, "id");
337 di->inst_id = g_strdup(decoder_id);
340 * Prepare a default probe map, where samples come in the
341 * order in which the decoder class defined them.
343 di->dec_num_probes = g_slist_length(di->decoder->probes) +
344 g_slist_length(di->decoder->opt_probes);
345 if (di->dec_num_probes) {
346 if (!(di->dec_probemap =
347 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
348 srd_err("Failed to g_malloc() probe map.");
352 for (i = 0; i < di->dec_num_probes; i++)
353 di->dec_probemap[i] = i;
354 di->data_unitsize = (di->dec_num_probes + 7) / 8;
356 * Will be used to prepare a sample at every iteration
357 * of the instance's decode() method.
359 if (!(di->probe_samples = g_try_malloc(di->dec_num_probes))) {
360 srd_err("Failed to g_malloc() sample buffer.");
361 g_free(di->dec_probemap);
367 /* Create a new instance of this decoder class. */
368 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
369 if (PyErr_Occurred())
370 srd_exception_catch("failed to create %s instance: ",
372 g_free(di->dec_probemap);
377 if (options && srd_inst_option_set(di, options) != SRD_OK) {
378 g_free(di->dec_probemap);
383 /* Instance takes input from a frontend by default. */
384 sess->di_list = g_slist_append(sess->di_list, di);
390 * Stack a decoder instance on top of another.
392 * @param sess The session holding the protocol decoder instances.
393 * @param di_bottom The instance on top of which di_top will be stacked.
394 * @param di_top The instance to go on top.
396 * @return SRD_OK upon success, a (negative) error code otherwise.
400 SRD_API int srd_inst_stack(struct srd_session *sess,
401 struct srd_decoder_inst *di_bottom,
402 struct srd_decoder_inst *di_top)
405 if (session_is_valid(sess) != SRD_OK) {
406 srd_err("Invalid session.");
410 if (!di_bottom || !di_top) {
411 srd_err("Invalid from/to instance pair.");
415 if (g_slist_find(sess->di_list, di_top)) {
416 /* Remove from the unstacked list. */
417 sess->di_list = g_slist_remove(sess->di_list, di_top);
420 /* Stack on top of source di. */
421 di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
423 srd_dbg("Stacked %s on top of %s.", di_top->inst_id, di_bottom->inst_id);
429 * Find a decoder instance by its instance ID.
431 * Only the bottom level of instances are searched -- instances already stacked
432 * on top of another one will not be found.
434 * @param sess The session holding the protocol decoder instance.
435 * @param inst_id The instance ID to be found.
437 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
441 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
445 struct srd_decoder_inst *tmp, *di;
447 if (session_is_valid(sess) != SRD_OK) {
448 srd_err("Invalid session.");
453 for (l = sess->di_list; l; l = l->next) {
455 if (!strcmp(tmp->inst_id, inst_id)) {
464 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
465 struct srd_session *sess, const GSList *stack,
469 struct srd_decoder_inst *tmp, *di;
471 if (session_is_valid(sess) != SRD_OK) {
472 srd_err("Invalid session.");
477 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
479 if (tmp->py_inst == obj)
481 else if (tmp->next_di)
482 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
489 * Find a decoder instance by its Python object.
491 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
492 * This will recurse to find the instance anywhere in the stack tree of all
495 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
496 * stack to search. To start searching at the bottom level of
497 * decoder instances, pass NULL.
498 * @param obj The Python class instantiation.
500 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
506 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
509 struct srd_decoder_inst *di;
510 struct srd_session *sess;
514 for (l = sessions; di == NULL && l != NULL; l = l->next) {
516 di = srd_sess_inst_find_by_obj(sess, stack, obj);
523 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
527 struct srd_decoder_inst *next_di;
530 srd_dbg("Calling start() method on protocol decoder instance %s.",
533 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
534 srd_exception_catch("Protocol decoder instance %s: ",
536 return SRD_ERR_PYTHON;
540 /* Start all the PDs stacked on top of this one. */
541 for (l = di->next_di; l; l = l->next) {
543 if ((ret = srd_inst_start(next_di)) != SRD_OK)
551 * Run the specified decoder function.
553 * @param di The decoder instance to call. Must not be NULL.
554 * @param start_samplenum The starting sample number for the buffer's sample
555 * set, relative to the start of capture.
556 * @param end_samplenum The ending sample number for the buffer's sample
557 * set, relative to the start of capture.
558 * @param inbuf The buffer to decode. Must not be NULL.
559 * @param inbuflen Length of the buffer. Must be > 0.
561 * @return SRD_OK upon success, a (negative) error code otherwise.
567 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
568 uint64_t start_samplenum, uint64_t end_samplenum,
569 const uint8_t *inbuf, uint64_t inbuflen)
574 srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
575 "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
578 /* Return an error upon unusable input. */
580 srd_dbg("empty decoder instance");
584 srd_dbg("NULL buffer pointer");
588 srd_dbg("empty buffer");
593 * Create new srd_logic object. Each iteration around the PD's loop
594 * will fill one sample into this object.
596 logic = PyObject_New(srd_logic, &srd_logic_type);
598 logic->di = (struct srd_decoder_inst *)di;
599 logic->start_samplenum = start_samplenum;
601 logic->inbuf = (uint8_t *)inbuf;
602 logic->inbuflen = inbuflen;
603 logic->sample = PyList_New(2);
604 Py_INCREF(logic->sample);
606 Py_IncRef(di->py_inst);
607 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
608 "KKO", start_samplenum, end_samplenum, logic))) {
609 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
610 return SRD_ERR_PYTHON;
618 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
621 struct srd_pd_output *pdo;
623 srd_dbg("Freeing instance %s", di->inst_id);
625 Py_DecRef(di->py_inst);
627 g_free(di->dec_probemap);
628 g_slist_free(di->next_di);
629 for (l = di->pd_output; l; l = l->next) {
631 g_free(pdo->proto_id);
634 g_slist_free(di->pd_output);
639 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
642 struct srd_decoder_inst *di;
644 if (session_is_valid(sess) != SRD_OK) {
645 srd_err("Invalid session.");
650 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
653 srd_inst_free_all(sess, di->next_di);
657 g_slist_free(sess->di_list);
658 sess->di_list = NULL;