]> sigrok.org Git - libsigrokdecode.git/blobdiff - instance.c
avr_isp: Add more parts
[libsigrokdecode.git] / instance.c
index 3327926d70e10db917174dda878ee0019789c19a..067e98da44ca9797c1a4c2be5ad28083b9759860 100644 (file)
 
 extern SRD_PRIV GSList *sessions;
 
-static void srd_inst_join_decode_thread(struct srd_decoder_inst *di);
-static void srd_inst_reset_state(struct srd_decoder_inst *di);
-SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di);
-
 /** @endcond */
 
 /**
@@ -50,6 +46,37 @@ SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di);
  * @{
  */
 
+static void oldpins_array_seed(struct srd_decoder_inst *di)
+{
+       size_t count;
+       GArray *arr;
+
+       if (!di)
+               return;
+       if (di->old_pins_array)
+               return;
+
+       count = di->dec_num_channels;
+       arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count);
+       g_array_set_size(arr, count);
+       if (arr->data)
+               memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count);
+       di->old_pins_array = arr;
+}
+
+static void oldpins_array_free(struct srd_decoder_inst *di)
+{
+       if (!di)
+               return;
+       if (!di->old_pins_array)
+               return;
+
+       srd_dbg("%s: Releasing initial pin state.", di->inst_id);
+
+       g_array_free(di->old_pins_array, TRUE);
+       di->old_pins_array = NULL;
+}
+
 /**
  * Set one or more options in a decoder instance.
  *
@@ -73,6 +100,7 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
        gint64 val_int;
        int ret;
        const char *val_str;
+       PyGILState_STATE gstate;
 
        if (!di) {
                srd_err("Invalid decoder instance.");
@@ -84,8 +112,11 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
                return SRD_ERR_ARG;
        }
 
+       gstate = PyGILState_Ensure();
+
        if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
                /* Decoder has no options. */
+               PyGILState_Release(gstate);
                if (g_hash_table_size(options) == 0) {
                        /* No options provided. */
                        return SRD_OK;
@@ -110,6 +141,7 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
        Py_DECREF(py_di_options);
        py_di_options = PyDict_New();
        PyObject_SetAttrString(di->py_inst, "options", py_di_options);
+       Py_DECREF(py_di_options);
 
        for (l = di->decoder->options; l; l = l->next) {
                sdo = l->data;
@@ -135,7 +167,7 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
                        }
                } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
                        val_int = g_variant_get_int64(value);
-                       if (!(py_optval = PyLong_FromLong(val_int))) {
+                       if (!(py_optval = PyLong_FromLongLong(val_int))) {
                                /* ValueError Exception */
                                PyErr_Clear();
                                srd_err("Option '%s' has invalid integer value.", sdo->id);
@@ -151,10 +183,13 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
                                goto err_out;
                        }
                }
-               if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
+               if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) {
+                       Py_XDECREF(py_optval);
                        goto err_out;
+               }
                /* Not harmful even if we used the default. */
                g_hash_table_remove(options, sdo->id);
+               Py_XDECREF(py_optval);
        }
        if (g_hash_table_size(options) != 0)
                srd_warn("Unknown options specified for '%s'", di->inst_id);
@@ -162,16 +197,16 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
        ret = SRD_OK;
 
 err_out:
-       Py_XDECREF(py_optval);
        if (PyErr_Occurred()) {
                srd_exception_catch("Stray exception in srd_inst_option_set()");
                ret = SRD_ERR_PYTHON;
        }
+       PyGILState_Release(gstate);
 
        return ret;
 }
 
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all(). */
 static gint compare_channel_id(const struct srd_channel *pdch,
                        const char *channel_id)
 {
@@ -217,7 +252,7 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
                return SRD_ERR_ARG;
        }
 
-       new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
+       new_channelmap = g_malloc0(sizeof(int) * di->dec_num_channels);
 
        /*
         * For now, map all indexes to channel -1 (can be overridden later).
@@ -250,14 +285,20 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
                }
                pdch = sl->data;
                new_channelmap[pdch->order] = new_channelnum;
-               srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
+               srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.",
                        pdch->id, pdch->order, new_channelnum);
        }
 
        srd_dbg("Final channel map:");
        num_required_channels = g_slist_length(di->decoder->channels);
        for (i = 0; i < di->dec_num_channels; i++) {
-               srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i],
+               GSList *ll = g_slist_nth(di->decoder->channels, i);
+               if (!ll)
+                       ll = g_slist_nth(di->decoder->opt_channels,
+                               i - num_required_channels);
+               pdch = ll->data;
+               srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i,
+                       pdch->id, new_channelmap[i],
                        (i < num_required_channels) ? "required" : "optional");
        }
 
@@ -268,6 +309,7 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
                pdch = g_slist_nth(di->decoder->channels, i)->data;
                srd_err("Required channel '%s' (index %d) was not specified.",
                        pdch->id, i);
+               g_free(new_channelmap);
                return SRD_ERR;
        }
 
@@ -281,6 +323,7 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
  * Create a new protocol decoder instance.
  *
  * @param sess The session holding the protocol decoder instance.
+ *             Must not be NULL.
  * @param decoder_id Decoder 'id' field.
  * @param options GHashtable of options which override the defaults set in
  *                the decoder class. May be NULL.
@@ -297,14 +340,12 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
        struct srd_decoder *dec;
        struct srd_decoder_inst *di;
        char *inst_id;
+       PyGILState_STATE gstate;
 
        i = 1;
-       srd_dbg("Creating new %s instance.", decoder_id);
 
-       if (session_is_valid(sess) != SRD_OK) {
-               srd_err("Invalid session.");
+       if (!sess)
                return NULL;
-       }
 
        if (!(dec = srd_decoder_get_by_id(decoder_id))) {
                srd_err("Protocol decoder %s not found.", decoder_id);
@@ -351,22 +392,23 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
        }
 
        /* Default to the initial pins being the same as in sample 0. */
-       di->old_pins_array = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t),
-                                               di->dec_num_channels);
-       g_array_set_size(di->old_pins_array, di->dec_num_channels);
-       memset(di->old_pins_array->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
-               di->dec_num_channels);
+       oldpins_array_seed(di);
+
+       gstate = PyGILState_Ensure();
 
        /* Create a new instance of this decoder class. */
        if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
                if (PyErr_Occurred())
                        srd_exception_catch("Failed to create %s instance",
                                        decoder_id);
+               PyGILState_Release(gstate);
                g_free(di->dec_channelmap);
                g_free(di);
                return NULL;
        }
 
+       PyGILState_Release(gstate);
+
        if (options && srd_inst_option_set(di, options) != SRD_OK) {
                g_free(di->dec_channelmap);
                g_free(di);
@@ -384,6 +426,8 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
        di->got_new_samples = FALSE;
        di->handled_all_samples = FALSE;
        di->want_wait_terminate = FALSE;
+       di->communicate_eof = FALSE;
+       di->decoder_state = SRD_OK;
 
        /*
         * Strictly speaking initialization of statically allocated
@@ -397,7 +441,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
 
        /* Instance takes input from a frontend by default. */
        sess->di_list = g_slist_append(sess->di_list, di);
-       srd_dbg("Created new %s instance with ID %s.", decoder_id, di->inst_id);
+       srd_dbg("Creating new %s instance %s.", decoder_id, di->inst_id);
 
        return di;
 }
@@ -445,9 +489,7 @@ static void srd_inst_reset_state(struct srd_decoder_inst *di)
 
        srd_dbg("%s: Resetting decoder state.", di->inst_id);
 
-       /*
-        * Reset internal state of the decoder.
-        */
+       /* Reset internal state of the decoder. */
        condition_list_free(di);
        match_array_free(di);
        di->abs_start_samplenum = 0;
@@ -459,6 +501,8 @@ static void srd_inst_reset_state(struct srd_decoder_inst *di)
        di->got_new_samples = FALSE;
        di->handled_all_samples = FALSE;
        di->want_wait_terminate = FALSE;
+       di->communicate_eof = FALSE;
+       di->decoder_state = SRD_OK;
        /* Conditions and mutex got reset after joining the thread. */
 }
 
@@ -466,6 +510,7 @@ static void srd_inst_reset_state(struct srd_decoder_inst *di)
  * Stack a decoder instance on top of another.
  *
  * @param sess The session holding the protocol decoder instances.
+ *             Must not be NULL.
  * @param di_bottom The instance on top of which di_top will be stacked.
  * @param di_top The instance to go on top.
  *
@@ -477,11 +522,8 @@ SRD_API int srd_inst_stack(struct srd_session *sess,
                struct srd_decoder_inst *di_bottom,
                struct srd_decoder_inst *di_top)
 {
-
-       if (session_is_valid(sess) != SRD_OK) {
-               srd_err("Invalid session.");
+       if (!sess)
                return SRD_ERR_ARG;
-       }
 
        if (!di_bottom || !di_top) {
                srd_err("Invalid from/to instance pair.");
@@ -493,10 +535,31 @@ SRD_API int srd_inst_stack(struct srd_session *sess,
                sess->di_list = g_slist_remove(sess->di_list, di_top);
        }
 
+       /*
+        * Check if there's at least one matching input/output pair
+        * for the stacked PDs. We warn if that's not the case, but it's
+        * not a hard error for the time being.
+        */
+       gboolean at_least_one_match = FALSE;
+       for (GSList *out = di_bottom->decoder->outputs; out; out = out->next) {
+               const char *o = out->data;
+               for (GSList *in = di_top->decoder->inputs; in; in = in->next) {
+                       const char *i = in->data;
+                       if (!strcmp(o, i)) {
+                               at_least_one_match = TRUE;
+                               break;
+                       }
+               }
+       }
+
+       if (!at_least_one_match)
+               srd_warn("No matching in-/output when stacking %s onto %s.",
+                       di_top->inst_id, di_bottom->inst_id);
+
        /* Stack on top of source di. */
        di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
 
-       srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
+       srd_dbg("Stacking %s onto %s.", di_top->inst_id, di_bottom->inst_id);
 
        return SRD_OK;
 }
@@ -540,6 +603,7 @@ static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id,
  * given session.
  *
  * @param sess The session holding the protocol decoder instance.
+ *             Must not be NULL.
  * @param inst_id The instance ID to be found.
  *
  * @return Pointer to struct srd_decoder_inst, or NULL if not found.
@@ -552,10 +616,8 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
        GSList *l;
        struct srd_decoder_inst *tmp, *di;
 
-       if (session_is_valid(sess) != SRD_OK) {
-               srd_err("Invalid session.");
+       if (!sess)
                return NULL;
-       }
 
        di = NULL;
        for (l = sess->di_list; l; l = l->next) {
@@ -567,64 +629,6 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
        return di;
 }
 
-static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
-               struct srd_session *sess, const GSList *stack,
-               const PyObject *obj)
-{
-       const GSList *l;
-       struct srd_decoder_inst *tmp, *di;
-
-       if (session_is_valid(sess) != SRD_OK) {
-               srd_err("Invalid session.");
-               return NULL;
-       }
-
-       di = NULL;
-       for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
-               tmp = l->data;
-               if (tmp->py_inst == obj)
-                       di = tmp;
-               else if (tmp->next_di)
-                       di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
-       }
-
-       return di;
-}
-
-/**
- * Find a decoder instance by its Python object.
- *
- * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
- * This will recurse to find the instance anywhere in the stack tree of all
- * sessions.
- *
- * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
- *              stack to search. To start searching at the bottom level of
- *              decoder instances, pass NULL.
- * @param obj The Python class instantiation.
- *
- * @return Pointer to struct srd_decoder_inst, or NULL if not found.
- *
- * @private
- *
- * @since 0.1.0
- */
-SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
-               const PyObject *obj)
-{
-       struct srd_decoder_inst *di;
-       struct srd_session *sess;
-       GSList *l;
-
-       di = NULL;
-       for (l = sessions; di == NULL && l != NULL; l = l->next) {
-               sess = l->data;
-               di = srd_sess_inst_find_by_obj(sess, stack, obj);
-       }
-
-       return di;
-}
-
 /**
  * Set the list of initial (assumed) pin values.
  *
@@ -662,6 +666,7 @@ SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *i
        }
 
        s = g_string_sized_new(100);
+       oldpins_array_seed(di);
        for (i = 0; i < di->dec_num_channels; i++) {
                di->old_pins_array->data[i] = initial_pins->data[i];
                g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]);
@@ -673,45 +678,38 @@ SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *i
        return SRD_OK;
 }
 
-/** @private */
-SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di)
-{
-       if (!di)
-               return;
-       if (!di->old_pins_array)
-               return;
-
-       srd_dbg("%s: Releasing initial pin state.", di->inst_id);
-
-       g_array_free(di->old_pins_array, TRUE);
-       di->old_pins_array = NULL;
-}
-
 /** @private */
 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
 {
-       PyObject *py_res;
+       PyObject *py_res, *py_samplenum;
        GSList *l;
        struct srd_decoder_inst *next_di;
        int ret;
+       PyGILState_STATE gstate;
 
-       srd_dbg("Calling start() method on protocol decoder instance %s.",
-                       di->inst_id);
+       srd_dbg("Calling start() of instance %s.", di->inst_id);
+
+       gstate = PyGILState_Ensure();
 
        /* Run self.start(). */
        if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
                srd_exception_catch("Protocol decoder instance %s",
                                di->inst_id);
+               PyGILState_Release(gstate);
                return SRD_ERR_PYTHON;
        }
-       Py_DecRef(py_res);
+       Py_DECREF(py_res);
 
        /* Set self.samplenum to 0. */
-       PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0));
+       py_samplenum = PyLong_FromUnsignedLongLong(0);
+       PyObject_SetAttrString(di->py_inst, "samplenum", py_samplenum);
+       Py_DECREF(py_samplenum);
 
        /* Set self.matched to None. */
        PyObject_SetAttrString(di->py_inst, "matched", Py_None);
 
+       PyGILState_Release(gstate);
+
        /* Start all the PDs stacked on top of this one. */
        for (l = di->next_di; l; l = l->next) {
                next_di = l->data;
@@ -738,7 +736,8 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
  *
  * @private
  */
-static gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
+__attribute__((always_inline))
+static inline gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term)
 {
        /* Caller ensures term != NULL. */
 
@@ -804,6 +803,7 @@ SRD_PRIV void condition_list_free(struct srd_decoder_inst *di)
                        g_slist_free_full(ll, g_free);
        }
 
+       g_slist_free(di->condition_list);
        di->condition_list = NULL;
 }
 
@@ -832,7 +832,10 @@ static void update_old_pins_array(struct srd_decoder_inst *di,
        if (!di || !di->dec_channelmap || !sample_pos)
                return;
 
+       oldpins_array_seed(di);
        for (i = 0; i < di->dec_num_channels; i++) {
+               if (di->dec_channelmap[i] == -1)
+                       continue; /* Ignore unused optional channels. */
                byte_offset = di->dec_channelmap[i] / 8;
                bit_offset = di->dec_channelmap[i] % 8;
                sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
@@ -851,9 +854,12 @@ static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di)
 
        sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
 
+       oldpins_array_seed(di);
        for (i = 0; i < di->dec_num_channels; i++) {
                if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0)
                        continue;
+               if (di->dec_channelmap[i] == -1)
+                       continue; /* Ignore unused optional channels. */
                byte_offset = di->dec_channelmap[i] / 8;
                bit_offset = di->dec_channelmap[i] % 8;
                sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0;
@@ -891,6 +897,8 @@ static gboolean all_terms_match(const struct srd_decoder_inst *di,
 
        for (l = cond; l; l = l->next) {
                term = l->data;
+               if (term->type == SRD_TERM_ALWAYS_FALSE)
+                       return FALSE;
                if (!term_matches(di, term, sample_pos))
                        return FALSE;
        }
@@ -915,7 +923,6 @@ static gboolean at_least_one_condition_matched(
 
 static gboolean find_match(struct srd_decoder_inst *di)
 {
-       static uint64_t s = 0;
        uint64_t i, j, num_samples_to_process;
        GSList *l, *cond;
        const uint8_t *sample_pos;
@@ -946,7 +953,7 @@ static gboolean find_match(struct srd_decoder_inst *di)
        if (di->abs_cur_samplenum == 0)
                update_old_pins_array_initial_pins(di);
 
-       for (i = 0, s = 0; i < num_samples_to_process; i++, s++, (di->abs_cur_samplenum)++) {
+       for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) {
 
                sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize);
 
@@ -1033,6 +1040,7 @@ static gpointer di_thread(gpointer data)
        PyObject *py_res;
        struct srd_decoder_inst *di;
        int wanted_term;
+       PyGILState_STATE gstate;
 
        if (!data)
                return NULL;
@@ -1041,14 +1049,30 @@ static gpointer di_thread(gpointer data)
 
        srd_dbg("%s: Starting thread routine for decoder.", di->inst_id);
 
+       gstate = PyGILState_Ensure();
+
        /*
         * Call self.decode(). Only returns if the PD throws an exception.
         * "Regular" termination of the decode() method is not expected.
         */
-       Py_IncRef(di->py_inst);
-       srd_dbg("%s: Calling decode() method.", di->inst_id);
+       Py_INCREF(di->py_inst);
+       srd_dbg("%s: Calling decode().", di->inst_id);
        py_res = PyObject_CallMethod(di->py_inst, "decode", NULL);
-       srd_dbg("%s: decode() method terminated.", di->inst_id);
+       srd_dbg("%s: decode() terminated.", di->inst_id);
+
+       /*
+        * Termination with an EOFError exception is accepted to simplify
+        * the implementation of decoders and for backwards compatibility.
+        */
+       if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_EOFError)) {
+               srd_dbg("%s: ignoring EOFError during decode() execution.",
+                       di->inst_id);
+               PyErr_Clear();
+               if (!py_res)
+                       py_res = Py_None;
+       }
+       if (!py_res)
+               di->decoder_state = SRD_ERR;
 
        /*
         * Make sure to unblock potentially pending srd_inst_decode()
@@ -1076,6 +1100,7 @@ static gpointer di_thread(gpointer data)
                 */
                srd_dbg("%s: Thread done (!res, want_term).", di->inst_id);
                PyErr_Clear();
+               PyGILState_Release(gstate);
                return NULL;
        }
        if (!py_res) {
@@ -1087,6 +1112,7 @@ static gpointer di_thread(gpointer data)
                srd_dbg("%s: decode() terminated unrequested.", di->inst_id);
                srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
                srd_dbg("%s: Thread done (!res, !want_term).", di->inst_id);
+               PyGILState_Release(gstate);
                return NULL;
        }
 
@@ -1096,9 +1122,11 @@ static gpointer di_thread(gpointer data)
         * decode() will re-start another thread transparently.
         */
        srd_dbg("%s: decode() terminated (req %d).", di->inst_id, wanted_term);
-       Py_DecRef(py_res);
+       Py_DECREF(py_res);
        PyErr_Clear();
 
+       PyGILState_Release(gstate);
+
        srd_dbg("%s: Thread done (with res).", di->inst_id);
 
        return NULL;
@@ -1208,7 +1236,6 @@ SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
        di->inbuflen = inbuflen;
        di->got_new_samples = TRUE;
        di->handled_all_samples = FALSE;
-       di->want_wait_terminate = FALSE;
 
        /* Signal the thread that we have new data. */
        g_cond_signal(&di->got_new_samples_cond);
@@ -1220,21 +1247,192 @@ SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di,
                g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex);
        g_mutex_unlock(&di->data_mutex);
 
+       /* Flush all PDs in the stack that can be flushed */
+       srd_inst_flush(di);
+
+       if (di->want_wait_terminate)
+               return SRD_ERR_TERM_REQ;
+
+       return SRD_OK;
+}
+
+
+/**
+ * Flush all data that is pending, bottom decoder first up to the top of the stack.
+ *
+ * @param di The decoder instance to call. Must not be NULL.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
+ */
+SRD_PRIV int srd_inst_flush(struct srd_decoder_inst *di)
+{
+       PyGILState_STATE gstate;
+       PyObject *py_ret;
+       GSList *l;
+       int ret;
+
+       if (!di)
+               return SRD_ERR_ARG;
+
+       gstate = PyGILState_Ensure();
+       if (PyObject_HasAttrString(di->py_inst, "flush")) {
+               srd_dbg("Calling flush() of instance %s", di->inst_id);
+               py_ret = PyObject_CallMethod(di->py_inst, "flush", NULL);
+               Py_XDECREF(py_ret);
+       }
+       PyGILState_Release(gstate);
+
+       /* Pass the "flush" request to all stacked decoders. */
+       for (l = di->next_di; l; l = l->next) {
+               ret = srd_inst_flush(l->data);
+               if (ret != SRD_OK)
+                       return ret;
+       }
+
+       return di->decoder_state;
+}
+
+/**
+ * Communicate the end of the stream of sample data to a decoder instance.
+ *
+ * @param[in] di The decoder instance to call. Must not be NULL.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
+ */
+SRD_PRIV int srd_inst_send_eof(struct srd_decoder_inst *di)
+{
+       GSList *l;
+       int ret;
+
+       if (!di)
+               return SRD_ERR_ARG;
+
+       /*
+        * Send EOF to the caller specified decoder instance. Only
+        * communicate EOF to currently executing decoders. Never
+        * started or previously finished is perfectly acceptable.
+        */
+       srd_dbg("End of sample data: instance %s.", di->inst_id);
+       if (!di->thread_handle) {
+               srd_dbg("No worker thread, nothing to do.");
+               return SRD_OK;
+       }
+
+       /* Signal the thread about the EOF condition. */
+       g_mutex_lock(&di->data_mutex);
+       di->inbuf = NULL;
+       di->inbuflen = 0;
+       di->got_new_samples = TRUE;
+       di->handled_all_samples = FALSE;
+       di->want_wait_terminate = TRUE;
+       di->communicate_eof = TRUE;
+       g_cond_signal(&di->got_new_samples_cond);
+       g_mutex_unlock(&di->data_mutex);
+
+       /* Only return from here when the condition was handled. */
+       g_mutex_lock(&di->data_mutex);
+       while (!di->handled_all_samples && !di->want_wait_terminate)
+               g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex);
+       g_mutex_unlock(&di->data_mutex);
+
+       /* Flush the decoder instance which handled EOF. */
+       srd_inst_flush(di);
+
+       /* Pass EOF to all stacked decoders. */
+       for (l = di->next_di; l; l = l->next) {
+               ret = srd_inst_send_eof(l->data);
+               if (ret != SRD_OK)
+                       return ret;
+       }
+
        return SRD_OK;
 }
 
+/**
+ * Terminate current decoder work, prepare for re-use on new input data.
+ *
+ * Terminates all decoder operations in the specified decoder instance
+ * and the instances stacked on top of it. Resets internal state such
+ * that the previously constructed stack can process new input data that
+ * is not related to previously processed input data. This avoids the
+ * expensive and complex re-construction of decoder stacks.
+ *
+ * Callers are expected to follow up with start, metadata, and decode
+ * calls like they would for newly constructed decoder stacks.
+ *
+ * @param di The decoder instance to call. Must not be NULL.
+ *
+ * @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @private
+ */
+SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di)
+{
+       PyGILState_STATE gstate;
+       PyObject *py_ret;
+       GSList *l;
+       int ret;
+
+       if (!di)
+               return SRD_ERR_ARG;
+
+       /*
+        * Request termination and wait for previously initiated
+        * background operation to finish. Reset internal state, but
+        * do not start releasing resources yet. This shall result in
+        * decoders' state just like after creation. This block handles
+        * the C language library side.
+        */
+       srd_dbg("Terminating instance %s", di->inst_id);
+       srd_inst_join_decode_thread(di);
+       srd_inst_reset_state(di);
+
+       /*
+        * Have the Python side's .reset() method executed (if the PD
+        * implements it). It's assumed that .reset() assigns variables
+        * very much like __init__() used to do in the past. Thus memory
+        * that was allocated in previous calls gets released by Python
+        * as it's not referenced any longer.
+        */
+       gstate = PyGILState_Ensure();
+       if (PyObject_HasAttrString(di->py_inst, "reset")) {
+               srd_dbg("Calling reset() of instance %s", di->inst_id);
+               py_ret = PyObject_CallMethod(di->py_inst, "reset", NULL);
+               Py_XDECREF(py_ret);
+       }
+       PyGILState_Release(gstate);
+
+       /* Pass the "restart" request to all stacked decoders. */
+       for (l = di->next_di; l; l = l->next) {
+               ret = srd_inst_terminate_reset(l->data);
+               if (ret != SRD_OK)
+                       return ret;
+       }
+
+       return di->decoder_state;
+}
+
 /** @private */
 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
 {
        GSList *l;
        struct srd_pd_output *pdo;
+       PyGILState_STATE gstate;
 
-       srd_dbg("Freeing instance %s", di->inst_id);
+       srd_dbg("Freeing instance %s.", di->inst_id);
 
        srd_inst_join_decode_thread(di);
+
        srd_inst_reset_state(di);
 
-       Py_DecRef(di->py_inst);
+       gstate = PyGILState_Ensure();
+       Py_DECREF(di->py_inst);
+       PyGILState_Release(gstate);
+
        g_free(di->inst_id);
        g_free(di->dec_channelmap);
        g_free(di->channel_samples);
@@ -1251,10 +1449,8 @@ SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
 /** @private */
 SRD_PRIV void srd_inst_free_all(struct srd_session *sess)
 {
-       if (session_is_valid(sess) != SRD_OK) {
-               srd_err("Invalid session.");
+       if (!sess)
                return;
-       }
 
        g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free);
 }