type_decoder: Fixup memory leak in Decoder.put() (meta, python)

[libsigrokdecode.git] / instance.c

diff --git a/instance.c b/instance.c
index 81ce3fd33fbc8b23d6665b098a1b3963c732a65a..f8cd2c68f66804833d0f41e75e885c27c5b86a4d 100644 (file)
--- a/instance.c
+++ b/instance.c
@@ -32,6 +32,7 @@ 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_seed(struct srd_decoder_inst *di);
 SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di);
 
 /** @endcond */
@@ -363,11 +364,7 @@ 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();
 
@@ -678,6 +675,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]);
@@ -689,6 +687,25 @@ 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_seed(struct srd_decoder_inst *di)
+{
+       size_t count;
+       GArray *arr;
+
+       if (!di)
+               return;
+       if (di->old_pins_array)
+               return;
+
+       srd_dbg("%s: Seeding old pins, %s().", di->inst_id, __func__);
+       count = di->dec_num_channels;
+       arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count);
+       g_array_set_size(arr, count);
+       memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count);
+       di->old_pins_array = arr;
+}
+
 /** @private */
 SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di)
 {
@@ -854,6 +871,7 @@ 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++) {
                byte_offset = di->dec_channelmap[i] / 8;
                bit_offset = di->dec_channelmap[i] % 8;
@@ -873,6 +891,7 @@ 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;
@@ -1236,7 +1255,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);
@@ -1248,6 +1266,72 @@ 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);
 
+       if (di->want_wait_terminate)
+               return SRD_ERR_TERM_REQ;
+       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 SRD_OK;
 }