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/>.
22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode.h"
31 extern SRD_PRIV GSList *sessions;
38 * Decoder instance handling.
42 * @defgroup grp_instances Decoder instances
44 * Decoder instance handling.
49 static void oldpins_array_seed(struct srd_decoder_inst *di)
56 if (di->old_pins_array)
59 count = di->dec_num_channels;
60 arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count);
61 g_array_set_size(arr, count);
62 memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count);
63 di->old_pins_array = arr;
66 static void oldpins_array_free(struct srd_decoder_inst *di)
70 if (!di->old_pins_array)
73 srd_dbg("%s: Releasing initial pin state.", di->inst_id);
75 g_array_free(di->old_pins_array, TRUE);
76 di->old_pins_array = NULL;
80 * Set one or more options in a decoder instance.
82 * Handled options are removed from the hash.
84 * @param di Decoder instance.
85 * @param options A GHashTable of options to set.
87 * @return SRD_OK upon success, a (negative) error code otherwise.
91 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
94 struct srd_decoder_option *sdo;
95 PyObject *py_di_options, *py_optval;
102 PyGILState_STATE gstate;
105 srd_err("Invalid decoder instance.");
110 srd_err("Invalid options GHashTable.");
114 gstate = PyGILState_Ensure();
116 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
117 /* Decoder has no options. */
118 PyGILState_Release(gstate);
119 if (g_hash_table_size(options) == 0) {
120 /* No options provided. */
123 srd_err("Protocol decoder has no options.");
129 ret = SRD_ERR_PYTHON;
133 * The 'options' tuple is a class variable, but we need to
134 * change it. Changing it directly will affect the entire class,
135 * so we need to create a new object for it, and populate that
138 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
140 Py_DECREF(py_di_options);
141 py_di_options = PyDict_New();
142 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
144 for (l = di->decoder->options; l; l = l->next) {
146 if ((value = g_hash_table_lookup(options, sdo->id))) {
147 /* A value was supplied for this option. */
148 if (!g_variant_type_equal(g_variant_get_type(value),
149 g_variant_get_type(sdo->def))) {
150 srd_err("Option '%s' should have the same type "
151 "as the default value.", sdo->id);
155 /* Use default for this option. */
158 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
159 val_str = g_variant_get_string(value, NULL);
160 if (!(py_optval = PyUnicode_FromString(val_str))) {
161 /* Some UTF-8 encoding error. */
163 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
166 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
167 val_int = g_variant_get_int64(value);
168 if (!(py_optval = PyLong_FromLong(val_int))) {
169 /* ValueError Exception */
171 srd_err("Option '%s' has invalid integer value.", sdo->id);
174 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
175 val_double = g_variant_get_double(value);
176 if (!(py_optval = PyFloat_FromDouble(val_double))) {
177 /* ValueError Exception */
179 srd_err("Option '%s' has invalid float value.",
184 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
186 /* Not harmful even if we used the default. */
187 g_hash_table_remove(options, sdo->id);
189 if (g_hash_table_size(options) != 0)
190 srd_warn("Unknown options specified for '%s'", di->inst_id);
195 Py_XDECREF(py_optval);
196 if (PyErr_Occurred()) {
197 srd_exception_catch("Stray exception in srd_inst_option_set()");
198 ret = SRD_ERR_PYTHON;
200 PyGILState_Release(gstate);
205 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all(). */
206 static gint compare_channel_id(const struct srd_channel *pdch,
207 const char *channel_id)
209 return strcmp(pdch->id, channel_id);
213 * Set all channels in a decoder instance.
215 * This function sets _all_ channels for the specified decoder instance, i.e.,
216 * it overwrites any channels that were already defined (if any).
218 * @param di Decoder instance.
219 * @param new_channels A GHashTable of channels to set. Key is channel name,
220 * value is the channel number. Samples passed to this
221 * instance will be arranged in this order.
223 * @return SRD_OK upon success, a (negative) error code otherwise.
227 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
228 GHashTable *new_channels)
230 GVariant *channel_val;
233 struct srd_channel *pdch;
234 int *new_channelmap, new_channelnum, num_required_channels, i;
237 srd_dbg("Setting channels for instance %s with list of %d channels.",
238 di->inst_id, g_hash_table_size(new_channels));
240 if (g_hash_table_size(new_channels) == 0)
241 /* No channels provided. */
244 if (di->dec_num_channels == 0) {
245 /* Decoder has no channels. */
246 srd_err("Protocol decoder %s has no channels to define.",
251 new_channelmap = g_malloc0(sizeof(int) * di->dec_num_channels);
254 * For now, map all indexes to channel -1 (can be overridden later).
255 * This -1 is interpreted as an unspecified channel later.
257 for (i = 0; i < di->dec_num_channels; i++)
258 new_channelmap[i] = -1;
260 for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
261 channel_id = l->data;
262 channel_val = g_hash_table_lookup(new_channels, channel_id);
263 if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
264 /* Channel name was specified without a value. */
265 srd_err("No channel number was specified for %s.",
267 g_free(new_channelmap);
270 new_channelnum = g_variant_get_int32(channel_val);
271 if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
272 (GCompareFunc)compare_channel_id))) {
273 /* Fall back on optional channels. */
274 if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
275 channel_id, (GCompareFunc)compare_channel_id))) {
276 srd_err("Protocol decoder %s has no channel "
277 "'%s'.", di->decoder->name, channel_id);
278 g_free(new_channelmap);
283 new_channelmap[pdch->order] = new_channelnum;
284 srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.",
285 pdch->id, pdch->order, new_channelnum);
288 srd_dbg("Final channel map:");
289 num_required_channels = g_slist_length(di->decoder->channels);
290 for (i = 0; i < di->dec_num_channels; i++) {
291 GSList *ll = g_slist_nth(di->decoder->channels, i);
293 ll = g_slist_nth(di->decoder->opt_channels,
294 i - num_required_channels);
296 srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i,
297 pdch->id, new_channelmap[i],
298 (i < num_required_channels) ? "required" : "optional");
301 /* Report an error if not all required channels were specified. */
302 for (i = 0; i < num_required_channels; i++) {
303 if (new_channelmap[i] != -1)
305 pdch = g_slist_nth(di->decoder->channels, i)->data;
306 srd_err("Required channel '%s' (index %d) was not specified.",
308 g_free(new_channelmap);
312 g_free(di->dec_channelmap);
313 di->dec_channelmap = new_channelmap;
319 * Create a new protocol decoder instance.
321 * @param sess The session holding the protocol decoder instance.
323 * @param decoder_id Decoder 'id' field.
324 * @param options GHashtable of options which override the defaults set in
325 * the decoder class. May be NULL.
327 * @return Pointer to a newly allocated struct srd_decoder_inst, or
328 * NULL in case of failure.
332 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
333 const char *decoder_id, GHashTable *options)
336 struct srd_decoder *dec;
337 struct srd_decoder_inst *di;
339 PyGILState_STATE gstate;
346 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
347 srd_err("Protocol decoder %s not found.", decoder_id);
351 di = g_malloc0(sizeof(struct srd_decoder_inst));
357 inst_id = g_hash_table_lookup(options, "id");
359 di->inst_id = g_strdup(inst_id);
360 g_hash_table_remove(options, "id");
363 /* Create a unique instance ID (as none was provided). */
365 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
366 while (srd_inst_find_by_id(sess, di->inst_id)) {
368 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
373 * Prepare a default channel map, where samples come in the
374 * order in which the decoder class defined them.
376 di->dec_num_channels = g_slist_length(di->decoder->channels) +
377 g_slist_length(di->decoder->opt_channels);
378 if (di->dec_num_channels) {
380 g_malloc(sizeof(int) * di->dec_num_channels);
381 for (i = 0; i < di->dec_num_channels; i++)
382 di->dec_channelmap[i] = i;
384 * Will be used to prepare a sample at every iteration
385 * of the instance's decode() method.
387 di->channel_samples = g_malloc(di->dec_num_channels);
390 /* Default to the initial pins being the same as in sample 0. */
391 oldpins_array_seed(di);
393 gstate = PyGILState_Ensure();
395 /* Create a new instance of this decoder class. */
396 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
397 if (PyErr_Occurred())
398 srd_exception_catch("Failed to create %s instance",
400 PyGILState_Release(gstate);
401 g_free(di->dec_channelmap);
406 PyGILState_Release(gstate);
408 if (options && srd_inst_option_set(di, options) != SRD_OK) {
409 g_free(di->dec_channelmap);
414 di->condition_list = NULL;
415 di->match_array = NULL;
416 di->abs_start_samplenum = 0;
417 di->abs_end_samplenum = 0;
420 di->abs_cur_samplenum = 0;
421 di->thread_handle = NULL;
422 di->got_new_samples = FALSE;
423 di->handled_all_samples = FALSE;
424 di->want_wait_terminate = FALSE;
425 di->decoder_state = SRD_OK;
428 * Strictly speaking initialization of statically allocated
429 * condition and mutex variables (or variables allocated on the
430 * stack) is not required, but won't harm either. Explicitly
431 * running init() will better match subsequent clear() calls.
433 g_cond_init(&di->got_new_samples_cond);
434 g_cond_init(&di->handled_all_samples_cond);
435 g_mutex_init(&di->data_mutex);
437 /* Instance takes input from a frontend by default. */
438 sess->di_list = g_slist_append(sess->di_list, di);
439 srd_dbg("Creating new %s instance %s.", decoder_id, di->inst_id);
444 static void srd_inst_join_decode_thread(struct srd_decoder_inst *di)
448 if (!di->thread_handle)
451 srd_dbg("%s: Joining decoder thread.", di->inst_id);
454 * Terminate potentially running threads which still
455 * execute the decoder instance's decode() method.
457 srd_dbg("%s: Raising want_term, sending got_new.", di->inst_id);
458 g_mutex_lock(&di->data_mutex);
459 di->want_wait_terminate = TRUE;
460 g_cond_signal(&di->got_new_samples_cond);
461 g_mutex_unlock(&di->data_mutex);
463 srd_dbg("%s: Running join().", di->inst_id);
464 (void)g_thread_join(di->thread_handle);
465 srd_dbg("%s: Call to join() done.", di->inst_id);
466 di->thread_handle = NULL;
469 * Reset condition and mutex variables, such that next
470 * operations on them will find them in a clean state.
472 g_cond_clear(&di->got_new_samples_cond);
473 g_cond_init(&di->got_new_samples_cond);
474 g_cond_clear(&di->handled_all_samples_cond);
475 g_cond_init(&di->handled_all_samples_cond);
476 g_mutex_clear(&di->data_mutex);
477 g_mutex_init(&di->data_mutex);
480 static void srd_inst_reset_state(struct srd_decoder_inst *di)
485 srd_dbg("%s: Resetting decoder state.", di->inst_id);
487 /* Reset internal state of the decoder. */
488 condition_list_free(di);
489 match_array_free(di);
490 di->abs_start_samplenum = 0;
491 di->abs_end_samplenum = 0;
494 di->abs_cur_samplenum = 0;
495 oldpins_array_free(di);
496 di->got_new_samples = FALSE;
497 di->handled_all_samples = FALSE;
498 di->want_wait_terminate = FALSE;
499 di->decoder_state = SRD_OK;
500 /* Conditions and mutex got reset after joining the thread. */
504 * Stack a decoder instance on top of another.
506 * @param sess The session holding the protocol decoder instances.
508 * @param di_bottom The instance on top of which di_top will be stacked.
509 * @param di_top The instance to go on top.
511 * @return SRD_OK upon success, a (negative) error code otherwise.
515 SRD_API int srd_inst_stack(struct srd_session *sess,
516 struct srd_decoder_inst *di_bottom,
517 struct srd_decoder_inst *di_top)
522 if (!di_bottom || !di_top) {
523 srd_err("Invalid from/to instance pair.");
527 if (g_slist_find(sess->di_list, di_top)) {
528 /* Remove from the unstacked list. */
529 sess->di_list = g_slist_remove(sess->di_list, di_top);
532 /* Stack on top of source di. */
533 di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
535 srd_dbg("Stacking %s onto %s.", di_top->inst_id, di_bottom->inst_id);
541 * Search a decoder instance and its stack for instance ID.
543 * @param[in] inst_id ID to search for.
544 * @param[in] stack A decoder instance, potentially with stacked instances.
546 * @return The matching instance, or NULL.
548 static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id,
549 struct srd_decoder_inst *stack)
552 struct srd_decoder_inst *tmp, *di;
554 if (!strcmp(stack->inst_id, inst_id))
557 /* Otherwise, look recursively in our stack. */
559 if (stack->next_di) {
560 for (l = stack->next_di; l; l = l->next) {
562 if (!strcmp(tmp->inst_id, inst_id)) {
573 * Find a decoder instance by its instance ID.
575 * This will recurse to find the instance anywhere in the stack tree of the
578 * @param sess The session holding the protocol decoder instance.
580 * @param inst_id The instance ID to be found.
582 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
586 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
590 struct srd_decoder_inst *tmp, *di;
596 for (l = sess->di_list; l; l = l->next) {
598 if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL)
606 * Set the list of initial (assumed) pin values.
608 * @param di Decoder instance to use. Must not be NULL.
609 * @param initial_pins A GArray of uint8_t values. Must not be NULL.
613 SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *initial_pins)
619 srd_err("Invalid decoder instance.");
626 if (initial_pins->len != (guint)di->dec_num_channels) {
627 srd_err("Incorrect number of channels (need %d, got %d).",
628 di->dec_num_channels, initial_pins->len);
632 /* Sanity-check initial pin state values. */
633 for (i = 0; i < di->dec_num_channels; i++) {
634 if (initial_pins->data[i] <= 2)
636 srd_err("Invalid initial channel %d pin state: %d.",
637 i, initial_pins->data[i]);
641 s = g_string_sized_new(100);
642 oldpins_array_seed(di);
643 for (i = 0; i < di->dec_num_channels; i++) {
644 di->old_pins_array->data[i] = initial_pins->data[i];
645 g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]);
647 s = g_string_truncate(s, s->len - 2);
648 srd_dbg("Initial pins: %s.", s->str);
649 g_string_free(s, TRUE);
655 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
659 struct srd_decoder_inst *next_di;
661 PyGILState_STATE gstate;
663 srd_dbg("Calling start() of instance %s.", di->inst_id);
665 gstate = PyGILState_Ensure();
667 /* Run self.start(). */
668 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
669 srd_exception_catch("Protocol decoder instance %s",
671 PyGILState_Release(gstate);
672 return SRD_ERR_PYTHON;
676 /* Set self.samplenum to 0. */
677 PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0));
679 /* Set self.matched to None. */
680 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
682 PyGILState_Release(gstate);
684 /* Start all the PDs stacked on top of this one. */
685 for (l = di->next_di; l; l = l->next) {
687 if ((ret = srd_inst_start(next_di)) != SRD_OK)
695 * Check whether the specified sample matches the specified term.
697 * In the case of SRD_TERM_SKIP, this function can modify
698 * term->num_samples_already_skipped.
700 * @param old_sample The value of the previous sample (0/1).
701 * @param sample The value of the current sample (0/1).
702 * @param term The term that should be checked for a match. Must not be NULL.
704 * @retval TRUE The current sample matches the specified term.
705 * @retval FALSE The current sample doesn't match the specified term, or an
706 * invalid term was provided.
710 __attribute__((always_inline))
711 static inline gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
713 /* Caller ensures term != NULL. */
715 switch (term->type) {
724 case SRD_TERM_RISING_EDGE:
725 if (old_sample == 0 && sample == 1)
728 case SRD_TERM_FALLING_EDGE:
729 if (old_sample == 1 && sample == 0)
732 case SRD_TERM_EITHER_EDGE:
733 if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1))
736 case SRD_TERM_NO_EDGE:
737 if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1))
741 if (term->num_samples_already_skipped == term->num_samples_to_skip)
743 term->num_samples_already_skipped++;
746 srd_err("Unknown term type %d.", term->type);
754 SRD_PRIV void match_array_free(struct srd_decoder_inst *di)
756 if (!di || !di->match_array)
759 g_array_free(di->match_array, TRUE);
760 di->match_array = NULL;
764 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di)
771 for (l = di->condition_list; l; l = l->next) {
774 g_slist_free_full(ll, g_free);
777 di->condition_list = NULL;
780 static gboolean have_non_null_conds(const struct srd_decoder_inst *di)
787 for (l = di->condition_list; l; l = l->next) {
796 static void update_old_pins_array(struct srd_decoder_inst *di,
797 const uint8_t *sample_pos)
800 int i, byte_offset, bit_offset;
802 if (!di || !di->dec_channelmap || !sample_pos)
805 oldpins_array_seed(di);
806 for (i = 0; i < di->dec_num_channels; i++) {
807 byte_offset = di->dec_channelmap[i] / 8;
808 bit_offset = di->dec_channelmap[i] % 8;
809 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
810 di->old_pins_array->data[i] = sample;
814 static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di)
817 int i, byte_offset, bit_offset;
818 const uint8_t *sample_pos;
820 if (!di || !di->dec_channelmap)
823 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
825 oldpins_array_seed(di);
826 for (i = 0; i < di->dec_num_channels; i++) {
827 if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0)
829 byte_offset = di->dec_channelmap[i] / 8;
830 bit_offset = di->dec_channelmap[i] % 8;
831 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
832 di->old_pins_array->data[i] = sample;
836 static gboolean term_matches(const struct srd_decoder_inst *di,
837 struct srd_term *term, const uint8_t *sample_pos)
839 uint8_t old_sample, sample;
840 int byte_offset, bit_offset, ch;
842 /* Caller ensures di, di->dec_channelmap, term, sample_pos != NULL. */
844 if (term->type == SRD_TERM_SKIP)
845 return sample_matches(0, 0, term);
848 byte_offset = di->dec_channelmap[ch] / 8;
849 bit_offset = di->dec_channelmap[ch] % 8;
850 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
851 old_sample = di->old_pins_array->data[ch];
853 return sample_matches(old_sample, sample, term);
856 static gboolean all_terms_match(const struct srd_decoder_inst *di,
857 const GSList *cond, const uint8_t *sample_pos)
860 struct srd_term *term;
862 /* Caller ensures di, cond, sample_pos != NULL. */
864 for (l = cond; l; l = l->next) {
866 if (!term_matches(di, term, sample_pos))
873 static gboolean at_least_one_condition_matched(
874 const struct srd_decoder_inst *di, unsigned int num_conditions)
878 /* Caller ensures di != NULL. */
880 for (i = 0; i < num_conditions; i++) {
881 if (di->match_array->data[i])
888 static gboolean find_match(struct srd_decoder_inst *di)
890 uint64_t i, j, num_samples_to_process;
892 const uint8_t *sample_pos;
893 unsigned int num_conditions;
895 /* Caller ensures di != NULL. */
897 /* Check whether the condition list is NULL/empty. */
898 if (!di->condition_list) {
899 srd_dbg("NULL/empty condition list, automatic match.");
903 /* Check whether we have any non-NULL conditions. */
904 if (!have_non_null_conds(di)) {
905 srd_dbg("Only NULL conditions in list, automatic match.");
909 num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum;
910 num_conditions = g_slist_length(di->condition_list);
912 /* di->match_array is NULL here. Create a new GArray. */
913 di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions);
914 g_array_set_size(di->match_array, num_conditions);
916 /* Sample 0: Set di->old_pins_array for SRD_INITIAL_PIN_SAME_AS_SAMPLE0 pins. */
917 if (di->abs_cur_samplenum == 0)
918 update_old_pins_array_initial_pins(di);
920 for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) {
922 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
924 /* Check whether the current sample matches at least one of the conditions (logical OR). */
925 /* IMPORTANT: We need to check all conditions, even if there was a match already! */
926 for (l = di->condition_list, j = 0; l; l = l->next, j++) {
930 /* All terms in 'cond' must match (logical AND). */
931 di->match_array->data[j] = all_terms_match(di, cond, sample_pos);
934 update_old_pins_array(di, sample_pos);
936 /* If at least one condition matched we're done. */
937 if (at_least_one_condition_matched(di, num_conditions))
945 * Process available samples and check if they match the defined conditions.
947 * This function returns if there is an error, or when a match is found, or
948 * when all samples have been processed (whether a match was found or not).
949 * This function immediately terminates when the decoder's wait() method
950 * invocation shall get terminated.
952 * @param di The decoder instance to use. Must not be NULL.
953 * @param found_match Will be set to TRUE if at least one condition matched,
954 * FALSE otherwise. Must not be NULL.
956 * @retval SRD_OK No errors occured, see found_match for the result.
957 * @retval SRD_ERR_ARG Invalid arguments.
961 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match)
963 if (!di || !found_match)
966 *found_match = FALSE;
967 if (di->want_wait_terminate)
970 /* Check if any of the current condition(s) match. */
972 /* Feed the (next chunk of the) buffer to find_match(). */
973 *found_match = find_match(di);
975 /* Did we handle all samples yet? */
976 if (di->abs_cur_samplenum >= di->abs_end_samplenum) {
977 srd_dbg("Done, handled all samples (abs cur %" PRIu64
978 " / abs end %" PRIu64 ").",
979 di->abs_cur_samplenum, di->abs_end_samplenum);
983 /* If we didn't find a match, continue looking. */
987 /* At least one condition matched, return. */
995 * Worker thread (per PD-stack).
997 * @param data Pointer to the lowest-level PD's device instance.
1000 * @return NULL if there was an error.
1002 static gpointer di_thread(gpointer data)
1005 struct srd_decoder_inst *di;
1007 PyGILState_STATE gstate;
1014 srd_dbg("%s: Starting thread routine for decoder.", di->inst_id);
1016 gstate = PyGILState_Ensure();
1019 * Call self.decode(). Only returns if the PD throws an exception.
1020 * "Regular" termination of the decode() method is not expected.
1022 Py_IncRef(di->py_inst);
1023 srd_dbg("%s: Calling decode().", di->inst_id);
1024 py_res = PyObject_CallMethod(di->py_inst, "decode", NULL);
1025 srd_dbg("%s: decode() terminated.", di->inst_id);
1028 di->decoder_state = SRD_ERR;
1031 * Make sure to unblock potentially pending srd_inst_decode()
1032 * calls in application threads after the decode() method might
1033 * have terminated, while it neither has processed sample data
1034 * nor has terminated upon request. This happens e.g. when "need
1035 * a samplerate to decode" exception is thrown.
1037 g_mutex_lock(&di->data_mutex);
1038 wanted_term = di->want_wait_terminate;
1039 di->want_wait_terminate = TRUE;
1040 di->handled_all_samples = TRUE;
1041 g_cond_signal(&di->handled_all_samples_cond);
1042 g_mutex_unlock(&di->data_mutex);
1045 * Check for the termination cause of the decode() method.
1046 * Though this is mostly for information.
1048 if (!py_res && wanted_term) {
1050 * Silently ignore errors upon return from decode() calls
1051 * when termination was requested. Terminate the thread
1052 * which executed this instance's decode() logic.
1054 srd_dbg("%s: Thread done (!res, want_term).", di->inst_id);
1056 PyGILState_Release(gstate);
1061 * The decode() invocation terminated unexpectedly. Have
1062 * the back trace printed, and terminate the thread which
1063 * executed the decode() method.
1065 srd_dbg("%s: decode() terminated unrequested.", di->inst_id);
1066 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
1067 srd_dbg("%s: Thread done (!res, !want_term).", di->inst_id);
1068 PyGILState_Release(gstate);
1073 * TODO: By design the decode() method is not supposed to terminate.
1074 * Nevertheless we have the thread joined, and srd backend calls to
1075 * decode() will re-start another thread transparently.
1077 srd_dbg("%s: decode() terminated (req %d).", di->inst_id, wanted_term);
1081 PyGILState_Release(gstate);
1083 srd_dbg("%s: Thread done (with res).", di->inst_id);
1089 * Decode a chunk of samples.
1091 * The calls to this function must provide the samples that shall be
1092 * used by the protocol decoder
1093 * - in the correct order ([...]5, 6, 4, 7, 8[...] is a bug),
1094 * - starting from sample zero (2, 3, 4, 5, 6[...] is a bug),
1095 * - consecutively, with no gaps (0, 1, 2, 4, 5[...] is a bug).
1097 * The start- and end-sample numbers are absolute sample numbers (relative
1098 * to the start of the whole capture/file/stream), i.e. they are not relative
1099 * sample numbers within the chunk specified by 'inbuf' and 'inbuflen'.
1101 * Correct example (4096 samples total, 4 chunks @ 1024 samples each):
1102 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1103 * srd_inst_decode(di, 1024, 2048, inbuf, 1024, 1);
1104 * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
1105 * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
1107 * The chunk size ('inbuflen') can be arbitrary and can differ between calls.
1109 * Correct example (4096 samples total, 7 chunks @ various samples each):
1110 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1111 * srd_inst_decode(di, 1024, 1124, inbuf, 100, 1);
1112 * srd_inst_decode(di, 1124, 1424, inbuf, 300, 1);
1113 * srd_inst_decode(di, 1424, 1643, inbuf, 219, 1);
1114 * srd_inst_decode(di, 1643, 2048, inbuf, 405, 1);
1115 * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
1116 * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
1118 * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but
1119 * the start- and end-samplenumbers are not absolute):
1120 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1121 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1122 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1123 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1125 * @param di The decoder instance to call. Must not be NULL.
1126 * @param abs_start_samplenum The absolute starting sample number for the
1127 * buffer's sample set, relative to the start of capture.
1128 * @param abs_end_samplenum The absolute ending sample number for the
1129 * buffer's sample set, relative to the start of capture.
1130 * @param inbuf The buffer to decode. Must not be NULL.
1131 * @param inbuflen Length of the buffer. Must be > 0.
1132 * @param unitsize The number of bytes per sample. Must be > 0.
1134 * @return SRD_OK upon success, a (negative) error code otherwise.
1138 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
1139 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
1140 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
1142 /* Return an error upon unusable input. */
1144 srd_dbg("empty decoder instance");
1148 srd_dbg("NULL buffer pointer");
1151 if (inbuflen == 0) {
1152 srd_dbg("empty buffer");
1155 if (unitsize == 0) {
1156 srd_dbg("unitsize 0");
1160 if (abs_start_samplenum != di->abs_cur_samplenum ||
1161 abs_end_samplenum < abs_start_samplenum) {
1162 srd_dbg("Incorrect sample numbers: start=%" PRIu64 ", cur=%"
1163 PRIu64 ", end=%" PRIu64 ".", abs_start_samplenum,
1164 di->abs_cur_samplenum, abs_end_samplenum);
1168 di->data_unitsize = unitsize;
1170 srd_dbg("Decoding: abs start sample %" PRIu64 ", abs end sample %"
1171 PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
1172 "%d), instance %s.", abs_start_samplenum, abs_end_samplenum,
1173 abs_end_samplenum - abs_start_samplenum, inbuflen, di->data_unitsize,
1176 /* If this is the first call, start the worker thread. */
1177 if (!di->thread_handle) {
1178 srd_dbg("No worker thread for this decoder stack "
1179 "exists yet, creating one: %s.", di->inst_id);
1180 di->thread_handle = g_thread_new(di->inst_id,
1184 /* Push the new sample chunk to the worker thread. */
1185 g_mutex_lock(&di->data_mutex);
1186 di->abs_start_samplenum = abs_start_samplenum;
1187 di->abs_end_samplenum = abs_end_samplenum;
1189 di->inbuflen = inbuflen;
1190 di->got_new_samples = TRUE;
1191 di->handled_all_samples = FALSE;
1193 /* Signal the thread that we have new data. */
1194 g_cond_signal(&di->got_new_samples_cond);
1195 g_mutex_unlock(&di->data_mutex);
1197 /* When all samples in this chunk were handled, return. */
1198 g_mutex_lock(&di->data_mutex);
1199 while (!di->handled_all_samples && !di->want_wait_terminate)
1200 g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex);
1201 g_mutex_unlock(&di->data_mutex);
1203 if (di->want_wait_terminate)
1204 return SRD_ERR_TERM_REQ;
1210 * Terminate current decoder work, prepare for re-use on new input data.
1212 * Terminates all decoder operations in the specified decoder instance
1213 * and the instances stacked on top of it. Resets internal state such
1214 * that the previously constructed stack can process new input data that
1215 * is not related to previously processed input data. This avoids the
1216 * expensive and complex re-construction of decoder stacks.
1218 * Callers are expected to follow up with start, metadata, and decode
1219 * calls like they would for newly constructed decoder stacks.
1221 * @param di The decoder instance to call. Must not be NULL.
1223 * @return SRD_OK upon success, a (negative) error code otherwise.
1227 SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di)
1229 PyGILState_STATE gstate;
1238 * Request termination and wait for previously initiated
1239 * background operation to finish. Reset internal state, but
1240 * do not start releasing resources yet. This shall result in
1241 * decoders' state just like after creation. This block handles
1242 * the C language library side.
1244 srd_dbg("Terminating instance %s", di->inst_id);
1245 srd_inst_join_decode_thread(di);
1246 srd_inst_reset_state(di);
1249 * Have the Python side's .reset() method executed (if the PD
1250 * implements it). It's assumed that .reset() assigns variables
1251 * very much like __init__() used to do in the past. Thus memory
1252 * that was allocated in previous calls gets released by Python
1253 * as it's not referenced any longer.
1255 gstate = PyGILState_Ensure();
1256 if (PyObject_HasAttrString(di->py_inst, "reset")) {
1257 srd_dbg("Calling reset() of instance %s", di->inst_id);
1258 py_ret = PyObject_CallMethod(di->py_inst, "reset", NULL);
1261 PyGILState_Release(gstate);
1263 /* Pass the "restart" request to all stacked decoders. */
1264 for (l = di->next_di; l; l = l->next) {
1265 ret = srd_inst_terminate_reset(l->data);
1270 return di->decoder_state;
1274 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
1277 struct srd_pd_output *pdo;
1278 PyGILState_STATE gstate;
1280 srd_dbg("Freeing instance %s.", di->inst_id);
1282 srd_inst_join_decode_thread(di);
1284 srd_inst_reset_state(di);
1286 gstate = PyGILState_Ensure();
1287 Py_DecRef(di->py_inst);
1288 PyGILState_Release(gstate);
1290 g_free(di->inst_id);
1291 g_free(di->dec_channelmap);
1292 g_free(di->channel_samples);
1293 g_slist_free(di->next_di);
1294 for (l = di->pd_output; l; l = l->next) {
1296 g_free(pdo->proto_id);
1299 g_slist_free(di->pd_output);
1304 SRD_PRIV void srd_inst_free_all(struct srd_session *sess)
1309 g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free);