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;
33 static void srd_inst_join_decode_thread(struct srd_decoder_inst *di);
34 static void srd_inst_reset_state(struct srd_decoder_inst *di);
35 SRD_PRIV void oldpins_array_seed(struct srd_decoder_inst *di);
36 SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di);
43 * Decoder instance handling.
47 * @defgroup grp_instances Decoder instances
49 * Decoder instance handling.
55 * Set one or more options in a decoder instance.
57 * Handled options are removed from the hash.
59 * @param di Decoder instance.
60 * @param options A GHashTable of options to set.
62 * @return SRD_OK upon success, a (negative) error code otherwise.
66 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
69 struct srd_decoder_option *sdo;
70 PyObject *py_di_options, *py_optval;
77 PyGILState_STATE gstate;
80 srd_err("Invalid decoder instance.");
85 srd_err("Invalid options GHashTable.");
89 gstate = PyGILState_Ensure();
91 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
92 /* Decoder has no options. */
93 PyGILState_Release(gstate);
94 if (g_hash_table_size(options) == 0) {
95 /* No options provided. */
98 srd_err("Protocol decoder has no options.");
104 ret = SRD_ERR_PYTHON;
108 * The 'options' tuple is a class variable, but we need to
109 * change it. Changing it directly will affect the entire class,
110 * so we need to create a new object for it, and populate that
113 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
115 Py_DECREF(py_di_options);
116 py_di_options = PyDict_New();
117 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
119 for (l = di->decoder->options; l; l = l->next) {
121 if ((value = g_hash_table_lookup(options, sdo->id))) {
122 /* A value was supplied for this option. */
123 if (!g_variant_type_equal(g_variant_get_type(value),
124 g_variant_get_type(sdo->def))) {
125 srd_err("Option '%s' should have the same type "
126 "as the default value.", sdo->id);
130 /* Use default for this option. */
133 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
134 val_str = g_variant_get_string(value, NULL);
135 if (!(py_optval = PyUnicode_FromString(val_str))) {
136 /* Some UTF-8 encoding error. */
138 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
141 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
142 val_int = g_variant_get_int64(value);
143 if (!(py_optval = PyLong_FromLong(val_int))) {
144 /* ValueError Exception */
146 srd_err("Option '%s' has invalid integer value.", sdo->id);
149 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
150 val_double = g_variant_get_double(value);
151 if (!(py_optval = PyFloat_FromDouble(val_double))) {
152 /* ValueError Exception */
154 srd_err("Option '%s' has invalid float value.",
159 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
161 /* Not harmful even if we used the default. */
162 g_hash_table_remove(options, sdo->id);
164 if (g_hash_table_size(options) != 0)
165 srd_warn("Unknown options specified for '%s'", di->inst_id);
170 Py_XDECREF(py_optval);
171 if (PyErr_Occurred()) {
172 srd_exception_catch("Stray exception in srd_inst_option_set()");
173 ret = SRD_ERR_PYTHON;
175 PyGILState_Release(gstate);
180 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */
181 static gint compare_channel_id(const struct srd_channel *pdch,
182 const char *channel_id)
184 return strcmp(pdch->id, channel_id);
188 * Set all channels in a decoder instance.
190 * This function sets _all_ channels for the specified decoder instance, i.e.,
191 * it overwrites any channels that were already defined (if any).
193 * @param di Decoder instance.
194 * @param new_channels A GHashTable of channels to set. Key is channel name,
195 * value is the channel number. Samples passed to this
196 * instance will be arranged in this order.
198 * @return SRD_OK upon success, a (negative) error code otherwise.
202 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
203 GHashTable *new_channels)
205 GVariant *channel_val;
208 struct srd_channel *pdch;
209 int *new_channelmap, new_channelnum, num_required_channels, i;
212 srd_dbg("Setting channels for instance %s with list of %d channels.",
213 di->inst_id, g_hash_table_size(new_channels));
215 if (g_hash_table_size(new_channels) == 0)
216 /* No channels provided. */
219 if (di->dec_num_channels == 0) {
220 /* Decoder has no channels. */
221 srd_err("Protocol decoder %s has no channels to define.",
226 new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
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 (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
247 (GCompareFunc)compare_channel_id))) {
248 /* Fall back on optional channels. */
249 if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
250 channel_id, (GCompareFunc)compare_channel_id))) {
251 srd_err("Protocol decoder %s has no channel "
252 "'%s'.", di->decoder->name, channel_id);
253 g_free(new_channelmap);
258 new_channelmap[pdch->order] = new_channelnum;
259 srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.",
260 pdch->id, pdch->order, new_channelnum);
263 srd_dbg("Final channel map:");
264 num_required_channels = g_slist_length(di->decoder->channels);
265 for (i = 0; i < di->dec_num_channels; i++) {
266 GSList *l = g_slist_nth(di->decoder->channels, i);
268 l = g_slist_nth(di->decoder->opt_channels,
269 i - num_required_channels);
271 srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i,
272 pdch->id, new_channelmap[i],
273 (i < num_required_channels) ? "required" : "optional");
276 /* Report an error if not all required channels were specified. */
277 for (i = 0; i < num_required_channels; i++) {
278 if (new_channelmap[i] != -1)
280 pdch = g_slist_nth(di->decoder->channels, i)->data;
281 srd_err("Required channel '%s' (index %d) was not specified.",
286 g_free(di->dec_channelmap);
287 di->dec_channelmap = new_channelmap;
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;
312 PyGILState_STATE gstate;
315 srd_dbg("Creating new %s instance.", decoder_id);
317 if (session_is_valid(sess) != SRD_OK) {
318 srd_err("Invalid session.");
322 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
323 srd_err("Protocol decoder %s not found.", decoder_id);
327 di = g_malloc0(sizeof(struct srd_decoder_inst));
333 inst_id = g_hash_table_lookup(options, "id");
335 di->inst_id = g_strdup(inst_id);
336 g_hash_table_remove(options, "id");
339 /* Create a unique instance ID (as none was provided). */
341 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
342 while (srd_inst_find_by_id(sess, di->inst_id)) {
344 di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++);
349 * Prepare a default channel map, where samples come in the
350 * order in which the decoder class defined them.
352 di->dec_num_channels = g_slist_length(di->decoder->channels) +
353 g_slist_length(di->decoder->opt_channels);
354 if (di->dec_num_channels) {
356 g_malloc(sizeof(int) * di->dec_num_channels);
357 for (i = 0; i < di->dec_num_channels; i++)
358 di->dec_channelmap[i] = i;
360 * Will be used to prepare a sample at every iteration
361 * of the instance's decode() method.
363 di->channel_samples = g_malloc(di->dec_num_channels);
366 /* Default to the initial pins being the same as in sample 0. */
367 oldpins_array_seed(di);
369 gstate = PyGILState_Ensure();
371 /* Create a new instance of this decoder class. */
372 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
373 if (PyErr_Occurred())
374 srd_exception_catch("Failed to create %s instance",
376 PyGILState_Release(gstate);
377 g_free(di->dec_channelmap);
382 PyGILState_Release(gstate);
384 if (options && srd_inst_option_set(di, options) != SRD_OK) {
385 g_free(di->dec_channelmap);
390 di->condition_list = NULL;
391 di->match_array = NULL;
392 di->abs_start_samplenum = 0;
393 di->abs_end_samplenum = 0;
396 di->abs_cur_samplenum = 0;
397 di->thread_handle = NULL;
398 di->got_new_samples = FALSE;
399 di->handled_all_samples = FALSE;
400 di->want_wait_terminate = FALSE;
403 * Strictly speaking initialization of statically allocated
404 * condition and mutex variables (or variables allocated on the
405 * stack) is not required, but won't harm either. Explicitly
406 * running init() will better match subsequent clear() calls.
408 g_cond_init(&di->got_new_samples_cond);
409 g_cond_init(&di->handled_all_samples_cond);
410 g_mutex_init(&di->data_mutex);
412 /* Instance takes input from a frontend by default. */
413 sess->di_list = g_slist_append(sess->di_list, di);
414 srd_dbg("Created new %s instance with ID %s.", decoder_id, di->inst_id);
419 static void srd_inst_join_decode_thread(struct srd_decoder_inst *di)
423 if (!di->thread_handle)
426 srd_dbg("%s: Joining decoder thread.", di->inst_id);
429 * Terminate potentially running threads which still
430 * execute the decoder instance's decode() method.
432 srd_dbg("%s: Raising want_term, sending got_new.", di->inst_id);
433 g_mutex_lock(&di->data_mutex);
434 di->want_wait_terminate = TRUE;
435 g_cond_signal(&di->got_new_samples_cond);
436 g_mutex_unlock(&di->data_mutex);
438 srd_dbg("%s: Running join().", di->inst_id);
439 (void)g_thread_join(di->thread_handle);
440 srd_dbg("%s: Call to join() done.", di->inst_id);
441 di->thread_handle = NULL;
444 * Reset condition and mutex variables, such that next
445 * operations on them will find them in a clean state.
447 g_cond_clear(&di->got_new_samples_cond);
448 g_cond_init(&di->got_new_samples_cond);
449 g_cond_clear(&di->handled_all_samples_cond);
450 g_cond_init(&di->handled_all_samples_cond);
451 g_mutex_clear(&di->data_mutex);
452 g_mutex_init(&di->data_mutex);
455 static void srd_inst_reset_state(struct srd_decoder_inst *di)
460 srd_dbg("%s: Resetting decoder state.", di->inst_id);
463 * Reset internal state of the decoder.
465 condition_list_free(di);
466 match_array_free(di);
467 di->abs_start_samplenum = 0;
468 di->abs_end_samplenum = 0;
471 di->abs_cur_samplenum = 0;
472 oldpins_array_free(di);
473 di->got_new_samples = FALSE;
474 di->handled_all_samples = FALSE;
475 di->want_wait_terminate = FALSE;
476 /* Conditions and mutex got reset after joining the thread. */
480 * Stack a decoder instance on top of another.
482 * @param sess The session holding the protocol decoder instances.
483 * @param di_bottom The instance on top of which di_top will be stacked.
484 * @param di_top The instance to go on top.
486 * @return SRD_OK upon success, a (negative) error code otherwise.
490 SRD_API int srd_inst_stack(struct srd_session *sess,
491 struct srd_decoder_inst *di_bottom,
492 struct srd_decoder_inst *di_top)
494 if (session_is_valid(sess) != SRD_OK) {
495 srd_err("Invalid session.");
499 if (!di_bottom || !di_top) {
500 srd_err("Invalid from/to instance pair.");
504 if (g_slist_find(sess->di_list, di_top)) {
505 /* Remove from the unstacked list. */
506 sess->di_list = g_slist_remove(sess->di_list, di_top);
509 /* Stack on top of source di. */
510 di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
512 srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
518 * Search a decoder instance and its stack for instance ID.
520 * @param[in] inst_id ID to search for.
521 * @param[in] stack A decoder instance, potentially with stacked instances.
523 * @return The matching instance, or NULL.
525 static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id,
526 struct srd_decoder_inst *stack)
529 struct srd_decoder_inst *tmp, *di;
531 if (!strcmp(stack->inst_id, inst_id))
534 /* Otherwise, look recursively in our stack. */
536 if (stack->next_di) {
537 for (l = stack->next_di; l; l = l->next) {
539 if (!strcmp(tmp->inst_id, inst_id)) {
550 * Find a decoder instance by its instance ID.
552 * This will recurse to find the instance anywhere in the stack tree of the
555 * @param sess The session holding the protocol decoder instance.
556 * @param inst_id The instance ID to be found.
558 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
562 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
566 struct srd_decoder_inst *tmp, *di;
568 if (session_is_valid(sess) != SRD_OK) {
569 srd_err("Invalid session.");
574 for (l = sess->di_list; l; l = l->next) {
576 if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL)
583 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
584 struct srd_session *sess, const GSList *stack,
588 struct srd_decoder_inst *tmp, *di;
590 if (session_is_valid(sess) != SRD_OK) {
591 srd_err("Invalid session.");
596 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
598 if (tmp->py_inst == obj)
600 else if (tmp->next_di)
601 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
608 * Find a decoder instance by its Python object.
610 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
611 * This will recurse to find the instance anywhere in the stack tree of all
614 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
615 * stack to search. To start searching at the bottom level of
616 * decoder instances, pass NULL.
617 * @param obj The Python class instantiation.
619 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
625 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
628 struct srd_decoder_inst *di;
629 struct srd_session *sess;
633 for (l = sessions; di == NULL && l != NULL; l = l->next) {
635 di = srd_sess_inst_find_by_obj(sess, stack, obj);
642 * Set the list of initial (assumed) pin values.
644 * @param di Decoder instance to use. Must not be NULL.
645 * @param initial_pins A GArray of uint8_t values. Must not be NULL.
649 SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *initial_pins)
655 srd_err("Invalid decoder instance.");
662 if (initial_pins->len != (guint)di->dec_num_channels) {
663 srd_err("Incorrect number of channels (need %d, got %d).",
664 di->dec_num_channels, initial_pins->len);
668 /* Sanity-check initial pin state values. */
669 for (i = 0; i < di->dec_num_channels; i++) {
670 if (initial_pins->data[i] <= 2)
672 srd_err("Invalid initial channel %d pin state: %d.",
673 i, initial_pins->data[i]);
677 s = g_string_sized_new(100);
678 oldpins_array_seed(di);
679 for (i = 0; i < di->dec_num_channels; i++) {
680 di->old_pins_array->data[i] = initial_pins->data[i];
681 g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]);
683 s = g_string_truncate(s, s->len - 2);
684 srd_dbg("Initial pins: %s.", s->str);
685 g_string_free(s, TRUE);
691 SRD_PRIV void oldpins_array_seed(struct srd_decoder_inst *di)
698 if (di->old_pins_array)
701 srd_dbg("%s: Seeding old pins, %s().", di->inst_id, __func__);
702 count = di->dec_num_channels;
703 arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count);
704 g_array_set_size(arr, count);
705 memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count);
706 di->old_pins_array = arr;
710 SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di)
714 if (!di->old_pins_array)
717 srd_dbg("%s: Releasing initial pin state.", di->inst_id);
719 g_array_free(di->old_pins_array, TRUE);
720 di->old_pins_array = NULL;
724 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
728 struct srd_decoder_inst *next_di;
730 PyGILState_STATE gstate;
732 srd_dbg("Calling start() method on protocol decoder instance %s.",
735 gstate = PyGILState_Ensure();
737 /* Run self.start(). */
738 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
739 srd_exception_catch("Protocol decoder instance %s",
741 PyGILState_Release(gstate);
742 return SRD_ERR_PYTHON;
746 /* Set self.samplenum to 0. */
747 PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0));
749 /* Set self.matched to None. */
750 PyObject_SetAttrString(di->py_inst, "matched", Py_None);
752 PyGILState_Release(gstate);
754 /* Start all the PDs stacked on top of this one. */
755 for (l = di->next_di; l; l = l->next) {
757 if ((ret = srd_inst_start(next_di)) != SRD_OK)
765 * Check whether the specified sample matches the specified term.
767 * In the case of SRD_TERM_SKIP, this function can modify
768 * term->num_samples_already_skipped.
770 * @param old_sample The value of the previous sample (0/1).
771 * @param sample The value of the current sample (0/1).
772 * @param term The term that should be checked for a match. Must not be NULL.
774 * @retval TRUE The current sample matches the specified term.
775 * @retval FALSE The current sample doesn't match the specified term, or an
776 * invalid term was provided.
780 static gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
782 /* Caller ensures term != NULL. */
784 switch (term->type) {
793 case SRD_TERM_RISING_EDGE:
794 if (old_sample == 0 && sample == 1)
797 case SRD_TERM_FALLING_EDGE:
798 if (old_sample == 1 && sample == 0)
801 case SRD_TERM_EITHER_EDGE:
802 if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1))
805 case SRD_TERM_NO_EDGE:
806 if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1))
810 if (term->num_samples_already_skipped == term->num_samples_to_skip)
812 term->num_samples_already_skipped++;
815 srd_err("Unknown term type %d.", term->type);
823 SRD_PRIV void match_array_free(struct srd_decoder_inst *di)
825 if (!di || !di->match_array)
828 g_array_free(di->match_array, TRUE);
829 di->match_array = NULL;
833 SRD_PRIV void condition_list_free(struct srd_decoder_inst *di)
840 for (l = di->condition_list; l; l = l->next) {
843 g_slist_free_full(ll, g_free);
846 di->condition_list = NULL;
849 static gboolean have_non_null_conds(const struct srd_decoder_inst *di)
856 for (l = di->condition_list; l; l = l->next) {
865 static void update_old_pins_array(struct srd_decoder_inst *di,
866 const uint8_t *sample_pos)
869 int i, byte_offset, bit_offset;
871 if (!di || !di->dec_channelmap || !sample_pos)
874 oldpins_array_seed(di);
875 for (i = 0; i < di->dec_num_channels; i++) {
876 byte_offset = di->dec_channelmap[i] / 8;
877 bit_offset = di->dec_channelmap[i] % 8;
878 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
879 di->old_pins_array->data[i] = sample;
883 static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di)
886 int i, byte_offset, bit_offset;
887 const uint8_t *sample_pos;
889 if (!di || !di->dec_channelmap)
892 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
894 oldpins_array_seed(di);
895 for (i = 0; i < di->dec_num_channels; i++) {
896 if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0)
898 byte_offset = di->dec_channelmap[i] / 8;
899 bit_offset = di->dec_channelmap[i] % 8;
900 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
901 di->old_pins_array->data[i] = sample;
905 static gboolean term_matches(const struct srd_decoder_inst *di,
906 struct srd_term *term, const uint8_t *sample_pos)
908 uint8_t old_sample, sample;
909 int byte_offset, bit_offset, ch;
911 /* Caller ensures di, di->dec_channelmap, term, sample_pos != NULL. */
913 if (term->type == SRD_TERM_SKIP)
914 return sample_matches(0, 0, term);
917 byte_offset = di->dec_channelmap[ch] / 8;
918 bit_offset = di->dec_channelmap[ch] % 8;
919 sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
920 old_sample = di->old_pins_array->data[ch];
922 return sample_matches(old_sample, sample, term);
925 static gboolean all_terms_match(const struct srd_decoder_inst *di,
926 const GSList *cond, const uint8_t *sample_pos)
929 struct srd_term *term;
931 /* Caller ensures di, cond, sample_pos != NULL. */
933 for (l = cond; l; l = l->next) {
935 if (!term_matches(di, term, sample_pos))
942 static gboolean at_least_one_condition_matched(
943 const struct srd_decoder_inst *di, unsigned int num_conditions)
947 /* Caller ensures di != NULL. */
949 for (i = 0; i < num_conditions; i++) {
950 if (di->match_array->data[i])
957 static gboolean find_match(struct srd_decoder_inst *di)
959 uint64_t i, j, num_samples_to_process;
961 const uint8_t *sample_pos;
962 unsigned int num_conditions;
964 /* Caller ensures di != NULL. */
966 /* Check whether the condition list is NULL/empty. */
967 if (!di->condition_list) {
968 srd_dbg("NULL/empty condition list, automatic match.");
972 /* Check whether we have any non-NULL conditions. */
973 if (!have_non_null_conds(di)) {
974 srd_dbg("Only NULL conditions in list, automatic match.");
978 num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum;
979 num_conditions = g_slist_length(di->condition_list);
981 /* di->match_array is NULL here. Create a new GArray. */
982 di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions);
983 g_array_set_size(di->match_array, num_conditions);
985 /* Sample 0: Set di->old_pins_array for SRD_INITIAL_PIN_SAME_AS_SAMPLE0 pins. */
986 if (di->abs_cur_samplenum == 0)
987 update_old_pins_array_initial_pins(di);
989 for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) {
991 sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
993 /* Check whether the current sample matches at least one of the conditions (logical OR). */
994 /* IMPORTANT: We need to check all conditions, even if there was a match already! */
995 for (l = di->condition_list, j = 0; l; l = l->next, j++) {
999 /* All terms in 'cond' must match (logical AND). */
1000 di->match_array->data[j] = all_terms_match(di, cond, sample_pos);
1003 update_old_pins_array(di, sample_pos);
1005 /* If at least one condition matched we're done. */
1006 if (at_least_one_condition_matched(di, num_conditions))
1014 * Process available samples and check if they match the defined conditions.
1016 * This function returns if there is an error, or when a match is found, or
1017 * when all samples have been processed (whether a match was found or not).
1018 * This function immediately terminates when the decoder's wait() method
1019 * invocation shall get terminated.
1021 * @param di The decoder instance to use. Must not be NULL.
1022 * @param found_match Will be set to TRUE if at least one condition matched,
1023 * FALSE otherwise. Must not be NULL.
1025 * @retval SRD_OK No errors occured, see found_match for the result.
1026 * @retval SRD_ERR_ARG Invalid arguments.
1030 SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match)
1032 if (!di || !found_match)
1035 *found_match = FALSE;
1036 if (di->want_wait_terminate)
1039 /* Check if any of the current condition(s) match. */
1041 /* Feed the (next chunk of the) buffer to find_match(). */
1042 *found_match = find_match(di);
1044 /* Did we handle all samples yet? */
1045 if (di->abs_cur_samplenum >= di->abs_end_samplenum) {
1046 srd_dbg("Done, handled all samples (abs cur %" PRIu64
1047 " / abs end %" PRIu64 ").",
1048 di->abs_cur_samplenum, di->abs_end_samplenum);
1052 /* If we didn't find a match, continue looking. */
1053 if (!(*found_match))
1056 /* At least one condition matched, return. */
1064 * Worker thread (per PD-stack).
1066 * @param data Pointer to the lowest-level PD's device instance.
1069 * @return NULL if there was an error.
1071 static gpointer di_thread(gpointer data)
1074 struct srd_decoder_inst *di;
1076 PyGILState_STATE gstate;
1083 srd_dbg("%s: Starting thread routine for decoder.", di->inst_id);
1085 gstate = PyGILState_Ensure();
1088 * Call self.decode(). Only returns if the PD throws an exception.
1089 * "Regular" termination of the decode() method is not expected.
1091 Py_IncRef(di->py_inst);
1092 srd_dbg("%s: Calling decode() method.", di->inst_id);
1093 py_res = PyObject_CallMethod(di->py_inst, "decode", NULL);
1094 srd_dbg("%s: decode() method terminated.", di->inst_id);
1097 * Make sure to unblock potentially pending srd_inst_decode()
1098 * calls in application threads after the decode() method might
1099 * have terminated, while it neither has processed sample data
1100 * nor has terminated upon request. This happens e.g. when "need
1101 * a samplerate to decode" exception is thrown.
1103 g_mutex_lock(&di->data_mutex);
1104 wanted_term = di->want_wait_terminate;
1105 di->want_wait_terminate = TRUE;
1106 di->handled_all_samples = TRUE;
1107 g_cond_signal(&di->handled_all_samples_cond);
1108 g_mutex_unlock(&di->data_mutex);
1111 * Check for the termination cause of the decode() method.
1112 * Though this is mostly for information.
1114 if (!py_res && wanted_term) {
1116 * Silently ignore errors upon return from decode() calls
1117 * when termination was requested. Terminate the thread
1118 * which executed this instance's decode() logic.
1120 srd_dbg("%s: Thread done (!res, want_term).", di->inst_id);
1122 PyGILState_Release(gstate);
1127 * The decode() invocation terminated unexpectedly. Have
1128 * the back trace printed, and terminate the thread which
1129 * executed the decode() method.
1131 srd_dbg("%s: decode() terminated unrequested.", di->inst_id);
1132 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
1133 srd_dbg("%s: Thread done (!res, !want_term).", di->inst_id);
1134 PyGILState_Release(gstate);
1139 * TODO: By design the decode() method is not supposed to terminate.
1140 * Nevertheless we have the thread joined, and srd backend calls to
1141 * decode() will re-start another thread transparently.
1143 srd_dbg("%s: decode() terminated (req %d).", di->inst_id, wanted_term);
1147 PyGILState_Release(gstate);
1149 srd_dbg("%s: Thread done (with res).", di->inst_id);
1155 * Decode a chunk of samples.
1157 * The calls to this function must provide the samples that shall be
1158 * used by the protocol decoder
1159 * - in the correct order ([...]5, 6, 4, 7, 8[...] is a bug),
1160 * - starting from sample zero (2, 3, 4, 5, 6[...] is a bug),
1161 * - consecutively, with no gaps (0, 1, 2, 4, 5[...] is a bug).
1163 * The start- and end-sample numbers are absolute sample numbers (relative
1164 * to the start of the whole capture/file/stream), i.e. they are not relative
1165 * sample numbers within the chunk specified by 'inbuf' and 'inbuflen'.
1167 * Correct example (4096 samples total, 4 chunks @ 1024 samples each):
1168 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1169 * srd_inst_decode(di, 1024, 2048, inbuf, 1024, 1);
1170 * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
1171 * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
1173 * The chunk size ('inbuflen') can be arbitrary and can differ between calls.
1175 * Correct example (4096 samples total, 7 chunks @ various samples each):
1176 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1177 * srd_inst_decode(di, 1024, 1124, inbuf, 100, 1);
1178 * srd_inst_decode(di, 1124, 1424, inbuf, 300, 1);
1179 * srd_inst_decode(di, 1424, 1643, inbuf, 219, 1);
1180 * srd_inst_decode(di, 1643, 2048, inbuf, 405, 1);
1181 * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1);
1182 * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1);
1184 * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but
1185 * the start- and end-samplenumbers are not absolute):
1186 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1187 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1188 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1189 * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1);
1191 * @param di The decoder instance to call. Must not be NULL.
1192 * @param abs_start_samplenum The absolute starting sample number for the
1193 * buffer's sample set, relative to the start of capture.
1194 * @param abs_end_samplenum The absolute ending sample number for the
1195 * buffer's sample set, relative to the start of capture.
1196 * @param inbuf The buffer to decode. Must not be NULL.
1197 * @param inbuflen Length of the buffer. Must be > 0.
1198 * @param unitsize The number of bytes per sample. Must be > 0.
1200 * @return SRD_OK upon success, a (negative) error code otherwise.
1204 SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
1205 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
1206 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
1208 /* Return an error upon unusable input. */
1210 srd_dbg("empty decoder instance");
1214 srd_dbg("NULL buffer pointer");
1217 if (inbuflen == 0) {
1218 srd_dbg("empty buffer");
1221 if (unitsize == 0) {
1222 srd_dbg("unitsize 0");
1226 if (abs_start_samplenum != di->abs_cur_samplenum ||
1227 abs_end_samplenum < abs_start_samplenum) {
1228 srd_dbg("Incorrect sample numbers: start=%" PRIu64 ", cur=%"
1229 PRIu64 ", end=%" PRIu64 ".", abs_start_samplenum,
1230 di->abs_cur_samplenum, abs_end_samplenum);
1234 di->data_unitsize = unitsize;
1236 srd_dbg("Decoding: abs start sample %" PRIu64 ", abs end sample %"
1237 PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
1238 "%d), instance %s.", abs_start_samplenum, abs_end_samplenum,
1239 abs_end_samplenum - abs_start_samplenum, inbuflen, di->data_unitsize,
1242 /* If this is the first call, start the worker thread. */
1243 if (!di->thread_handle) {
1244 srd_dbg("No worker thread for this decoder stack "
1245 "exists yet, creating one: %s.", di->inst_id);
1246 di->thread_handle = g_thread_new(di->inst_id,
1250 /* Push the new sample chunk to the worker thread. */
1251 g_mutex_lock(&di->data_mutex);
1252 di->abs_start_samplenum = abs_start_samplenum;
1253 di->abs_end_samplenum = abs_end_samplenum;
1255 di->inbuflen = inbuflen;
1256 di->got_new_samples = TRUE;
1257 di->handled_all_samples = FALSE;
1258 di->want_wait_terminate = FALSE;
1260 /* Signal the thread that we have new data. */
1261 g_cond_signal(&di->got_new_samples_cond);
1262 g_mutex_unlock(&di->data_mutex);
1264 /* When all samples in this chunk were handled, return. */
1265 g_mutex_lock(&di->data_mutex);
1266 while (!di->handled_all_samples && !di->want_wait_terminate)
1267 g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex);
1268 g_mutex_unlock(&di->data_mutex);
1274 * Terminate current decoder work, prepare for re-use on new input data.
1276 * Terminates all decoder operations in the specified decoder instance
1277 * and the instances stacked on top of it. Resets internal state such
1278 * that the previously constructed stack can process new input data that
1279 * is not related to previously processed input data. This avoids the
1280 * expensive and complex re-construction of decoder stacks.
1282 * Callers are expected to follow up with start, metadata, and decode
1283 * calls like they would for newly constructed decoder stacks.
1285 * @param di The decoder instance to call. Must not be NULL.
1286 * @return SRD_OK upon success, a (negative) error code otherwise.
1289 SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di)
1291 PyGILState_STATE gstate;
1300 * Request termination and wait for previously initiated
1301 * background operation to finish. Reset internal state, but
1302 * do not start releasing resources yet. This shall result in
1303 * decoders' state just like after creation. This block handles
1304 * the C language library side.
1306 srd_dbg("Terminating instance %s", di->inst_id);
1307 srd_inst_join_decode_thread(di);
1308 srd_inst_reset_state(di);
1311 * Have the Python side's .reset() method executed (if the PD
1312 * implements it). It's assumed that .reset() assigns variables
1313 * very much like __init__() used to do in the past. Thus memory
1314 * that was allocated in previous calls gets released by Python
1315 * as it's not referenced any longer.
1317 gstate = PyGILState_Ensure();
1318 if (PyObject_HasAttrString(di->py_inst, "reset")) {
1319 srd_dbg("Calling .reset() of instance %s", di->inst_id);
1320 py_ret = PyObject_CallMethod(di->py_inst, "reset", NULL);
1323 PyGILState_Release(gstate);
1326 * Pass the "restart" request to all stacked decoders.
1328 for (l = di->next_di; l; l = l->next) {
1329 ret = srd_inst_terminate_reset(l->data);
1338 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
1341 struct srd_pd_output *pdo;
1342 PyGILState_STATE gstate;
1344 srd_dbg("Freeing instance %s", di->inst_id);
1346 srd_inst_join_decode_thread(di);
1348 srd_inst_reset_state(di);
1350 gstate = PyGILState_Ensure();
1351 Py_DecRef(di->py_inst);
1352 PyGILState_Release(gstate);
1354 g_free(di->inst_id);
1355 g_free(di->dec_channelmap);
1356 g_free(di->channel_samples);
1357 g_slist_free(di->next_di);
1358 for (l = di->pd_output; l; l = l->next) {
1360 g_free(pdo->proto_id);
1363 g_slist_free(di->pd_output);
1368 SRD_PRIV void srd_inst_free_all(struct srd_session *sess)
1370 if (session_is_valid(sess) != SRD_OK) {
1371 srd_err("Invalid session.");
1375 g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free);