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 SRD_PRIV 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_channel_set_all() */
173 static gint compare_channel_id(const struct srd_channel *pdch,
174 const char *channel_id)
176 return strcmp(pdch->id, channel_id);
180 * Set all channels in a decoder instance.
182 * This function sets _all_ channels for the specified decoder instance, i.e.,
183 * it overwrites any channels that were already defined (if any).
185 * @param di Decoder instance.
186 * @param new_channels A GHashTable of channels to set. Key is channel name,
187 * value is the channel number. Samples passed to this
188 * instance will be arranged in this order.
189 * @param unit_size Number of bytes per sample in the data stream to be passed
190 * to the decoder. The highest channel index specified in the
191 * channel map must lie within a sample unit.
193 * @return SRD_OK upon success, a (negative) error code otherwise.
197 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
198 GHashTable *new_channels, int unit_size)
200 GVariant *channel_val;
203 struct srd_channel *pdch;
204 int *new_channelmap, new_channelnum, num_required_channels, i;
207 srd_dbg("Setting channels for instance %s with list of %d channels, "
208 "unitsize %d.", di->inst_id, g_hash_table_size(new_channels), unit_size);
210 if (g_hash_table_size(new_channels) == 0)
211 /* No channels provided. */
214 if (di->dec_num_channels == 0) {
215 /* Decoder has no channels. */
216 srd_err("Protocol decoder %s has no channels to define.",
221 new_channelmap = NULL;
223 if (!(new_channelmap = g_try_malloc(sizeof(int) * di->dec_num_channels))) {
224 srd_err("Failed to g_malloc() new channel map.");
225 return SRD_ERR_MALLOC;
229 * For now, map all indexes to channel -1 (can be overridden later).
230 * This -1 is interpreted as an unspecified channel later.
232 for (i = 0; i < di->dec_num_channels; i++)
233 new_channelmap[i] = -1;
235 for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
236 channel_id = l->data;
237 channel_val = g_hash_table_lookup(new_channels, channel_id);
238 if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
239 /* Channel name was specified without a value. */
240 srd_err("No channel number was specified for %s.",
242 g_free(new_channelmap);
245 new_channelnum = g_variant_get_int32(channel_val);
246 if (new_channelnum >= 8 * unit_size) {
247 srd_err("Channel index %d not within data unit (%d bit).",
248 new_channelnum, 8 * unit_size);
249 g_free(new_channelmap);
252 if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
253 (GCompareFunc)compare_channel_id))) {
254 /* Fall back on optional channels. */
255 if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
256 channel_id, (GCompareFunc) compare_channel_id))) {
257 srd_err("Protocol decoder %s has no channel "
258 "'%s'.", di->decoder->name, channel_id);
259 g_free(new_channelmap);
264 new_channelmap[pdch->order] = new_channelnum;
265 srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
266 pdch->id, pdch->order, new_channelnum);
268 di->data_unitsize = unit_size;
270 srd_dbg("Final channel map:");
271 num_required_channels = g_slist_length(di->decoder->channels);
272 for (i = 0; i < di->dec_num_channels; i++) {
273 srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i],
274 (i < num_required_channels) ? "required" : "optional");
277 /* Report an error if not all required channels were specified. */
278 for (i = 0; i < num_required_channels; i++) {
279 if (new_channelmap[i] != -1)
281 pdch = g_slist_nth(di->decoder->channels, i)->data;
282 srd_err("Required channel '%s' (index %d) was not specified.",
287 g_free(di->dec_channelmap);
288 di->dec_channelmap = new_channelmap;
294 * Create a new protocol decoder instance.
296 * @param sess The session holding the protocol decoder instance.
297 * @param decoder_id Decoder 'id' field.
298 * @param options GHashtable of options which override the defaults set in
299 * the decoder class. May be NULL.
301 * @return Pointer to a newly allocated struct srd_decoder_inst, or
302 * NULL in case of failure.
306 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
307 const char *decoder_id, GHashTable *options)
310 struct srd_decoder *dec;
311 struct srd_decoder_inst *di;
314 srd_dbg("Creating new %s instance.", decoder_id);
316 if (session_is_valid(sess) != SRD_OK) {
317 srd_err("Invalid session.");
321 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
322 srd_err("Protocol decoder %s not found.", decoder_id);
326 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
327 srd_err("Failed to g_malloc() instance.");
334 inst_id = g_hash_table_lookup(options, "id");
335 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
336 g_hash_table_remove(options, "id");
338 di->inst_id = g_strdup(decoder_id);
341 * Prepare a default channel map, where samples come in the
342 * order in which the decoder class defined them.
344 di->dec_num_channels = g_slist_length(di->decoder->channels) +
345 g_slist_length(di->decoder->opt_channels);
346 if (di->dec_num_channels) {
347 if (!(di->dec_channelmap =
348 g_try_malloc(sizeof(int) * di->dec_num_channels))) {
349 srd_err("Failed to g_malloc() channel map.");
353 for (i = 0; i < di->dec_num_channels; i++)
354 di->dec_channelmap[i] = i;
355 di->data_unitsize = (di->dec_num_channels + 7) / 8;
357 * Will be used to prepare a sample at every iteration
358 * of the instance's decode() method.
360 if (!(di->channel_samples = g_try_malloc(di->dec_num_channels))) {
361 srd_err("Failed to g_malloc() sample buffer.");
362 g_free(di->dec_channelmap);
368 /* Create a new instance of this decoder class. */
369 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
370 if (PyErr_Occurred())
371 srd_exception_catch("failed to create %s instance: ",
373 g_free(di->dec_channelmap);
378 if (options && srd_inst_option_set(di, options) != SRD_OK) {
379 g_free(di->dec_channelmap);
384 /* Instance takes input from a frontend by default. */
385 sess->di_list = g_slist_append(sess->di_list, di);
391 * Stack a decoder instance on top of another.
393 * @param sess The session holding the protocol decoder instances.
394 * @param di_bottom The instance on top of which di_top will be stacked.
395 * @param di_top The instance to go on top.
397 * @return SRD_OK upon success, a (negative) error code otherwise.
401 SRD_API int srd_inst_stack(struct srd_session *sess,
402 struct srd_decoder_inst *di_bottom,
403 struct srd_decoder_inst *di_top)
406 if (session_is_valid(sess) != SRD_OK) {
407 srd_err("Invalid session.");
411 if (!di_bottom || !di_top) {
412 srd_err("Invalid from/to instance pair.");
416 if (g_slist_find(sess->di_list, di_top)) {
417 /* Remove from the unstacked list. */
418 sess->di_list = g_slist_remove(sess->di_list, di_top);
421 /* Stack on top of source di. */
422 di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
424 srd_dbg("Stacked %s on top of %s.", di_top->inst_id, di_bottom->inst_id);
430 * Find a decoder instance by its instance ID.
432 * Only the bottom level of instances are searched -- instances already stacked
433 * on top of another one will not be found.
435 * @param sess The session holding the protocol decoder instance.
436 * @param inst_id The instance ID to be found.
438 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
442 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
446 struct srd_decoder_inst *tmp, *di;
448 if (session_is_valid(sess) != SRD_OK) {
449 srd_err("Invalid session.");
454 for (l = sess->di_list; l; l = l->next) {
456 if (!strcmp(tmp->inst_id, inst_id)) {
465 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
466 struct srd_session *sess, const GSList *stack,
470 struct srd_decoder_inst *tmp, *di;
472 if (session_is_valid(sess) != SRD_OK) {
473 srd_err("Invalid session.");
478 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
480 if (tmp->py_inst == obj)
482 else if (tmp->next_di)
483 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
490 * Find a decoder instance by its Python object.
492 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
493 * This will recurse to find the instance anywhere in the stack tree of all
496 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
497 * stack to search. To start searching at the bottom level of
498 * decoder instances, pass NULL.
499 * @param obj The Python class instantiation.
501 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
507 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
510 struct srd_decoder_inst *di;
511 struct srd_session *sess;
515 for (l = sessions; di == NULL && l != NULL; l = l->next) {
517 di = srd_sess_inst_find_by_obj(sess, stack, obj);
524 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
528 struct srd_decoder_inst *next_di;
531 srd_dbg("Calling start() method on protocol decoder instance %s.",
534 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
535 srd_exception_catch("Protocol decoder instance %s: ",
537 return SRD_ERR_PYTHON;
541 /* Start all the PDs stacked on top of this one. */
542 for (l = di->next_di; l; l = l->next) {
544 if ((ret = srd_inst_start(next_di)) != SRD_OK)
552 * Run the specified decoder function.
554 * @param di The decoder instance to call. Must not be NULL.
555 * @param start_samplenum The starting sample number for the buffer's sample
556 * set, relative to the start of capture.
557 * @param end_samplenum The ending sample number for the buffer's sample
558 * set, relative to the start of capture.
559 * @param inbuf The buffer to decode. Must not be NULL.
560 * @param inbuflen Length of the buffer. Must be > 0.
562 * @return SRD_OK upon success, a (negative) error code otherwise.
568 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
569 uint64_t start_samplenum, uint64_t end_samplenum,
570 const uint8_t *inbuf, uint64_t inbuflen)
575 srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
576 "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
579 /* Return an error upon unusable input. */
581 srd_dbg("empty decoder instance");
585 srd_dbg("NULL buffer pointer");
589 srd_dbg("empty buffer");
594 * Create new srd_logic object. Each iteration around the PD's loop
595 * will fill one sample into this object.
597 logic = PyObject_New(srd_logic, &srd_logic_type);
599 logic->di = (struct srd_decoder_inst *)di;
600 logic->start_samplenum = start_samplenum;
602 logic->inbuf = (uint8_t *)inbuf;
603 logic->inbuflen = inbuflen;
604 logic->sample = PyList_New(2);
605 Py_INCREF(logic->sample);
607 Py_IncRef(di->py_inst);
608 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
609 "KKO", start_samplenum, end_samplenum, logic))) {
610 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
611 return SRD_ERR_PYTHON;
619 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
622 struct srd_pd_output *pdo;
624 srd_dbg("Freeing instance %s", di->inst_id);
626 Py_DecRef(di->py_inst);
628 g_free(di->dec_channelmap);
629 g_slist_free(di->next_di);
630 for (l = di->pd_output; l; l = l->next) {
632 g_free(pdo->proto_id);
635 g_slist_free(di->pd_output);
640 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
643 struct srd_decoder_inst *di;
645 if (session_is_valid(sess) != SRD_OK) {
646 srd_err("Invalid session.");
651 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
654 srd_inst_free_all(sess, di->next_di);
658 g_slist_free(sess->di_list);
659 sess->di_list = NULL;