X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=instance.c;h=b56a3e662400938839a89d99d8ce0bd8ebd0dfd1;hp=e72fc966104d843e68aa5579d76780f6799bec9b;hb=991c44f33a55733610f6d9da1efbcc5bf1074dee;hpb=84c1c0b52820af2418186ac3ecf93a5c6373a22e diff --git a/instance.c b/instance.c index e72fc96..b56a3e6 100644 --- a/instance.c +++ b/instance.c @@ -18,9 +18,9 @@ * along with this program. If not, see . */ -#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ -#include "libsigrokdecode-internal.h" -#include "config.h" +#include +#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode.h" #include #include #include @@ -28,10 +28,10 @@ /** @cond PRIVATE */ -extern GSList *sessions; +extern SRD_PRIV GSList *sessions; -/* type_logic.c */ -extern SRD_PRIV PyTypeObject srd_logic_type; +/* module_sigrokdecode.c */ +extern SRD_PRIV PyObject *srd_logic_type; /** @endcond */ @@ -64,11 +64,11 @@ extern SRD_PRIV PyTypeObject srd_logic_type; SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, GHashTable *options) { - struct srd_decoder_option *sdo; + struct srd_decoder_option *sdo; PyObject *py_di_options, *py_optval; GVariant *value; - GSList *l; - double val_double; + GSList *l; + double val_double; gint64 val_int; int ret; const char *val_str; @@ -96,7 +96,7 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, } ret = SRD_ERR_PYTHON; - py_optval = NULL; + py_optval = NULL; /* * The 'options' tuple is a class variable, but we need to @@ -110,181 +110,168 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, py_di_options = PyDict_New(); PyObject_SetAttrString(di->py_inst, "options", py_di_options); - for (l = di->decoder->options; l; l = l->next) { - sdo = l->data; - if ((value = g_hash_table_lookup(options, sdo->id))) { - /* A value was supplied for this option. */ - if (!g_variant_type_equal(g_variant_get_type(value), - g_variant_get_type(sdo->def))) { - srd_err("Option '%s' should have the same type " - "as the default value.", sdo->id); - goto err_out; - } - } else { - /* Use default for this option. */ - value = sdo->def; - } - if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { - val_str = g_variant_get_string(value, NULL); - if (!(py_optval = PyUnicode_FromString(val_str))) { - /* Some UTF-8 encoding error. */ - PyErr_Clear(); - srd_err("Option '%s' requires a UTF-8 string value.", sdo->id); - goto err_out; - } - } 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))) { - /* ValueError Exception */ - PyErr_Clear(); - srd_err("Option '%s' has invalid integer value.", sdo->id); - goto err_out; - } - } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) { - val_double = g_variant_get_int64(value); - if (!(py_optval = PyFloat_FromDouble(val_double))) { - /* ValueError Exception */ - PyErr_Clear(); - srd_err("Option '%s' has invalid float value.", sdo->id); - goto err_out; - } - } + for (l = di->decoder->options; l; l = l->next) { + sdo = l->data; + if ((value = g_hash_table_lookup(options, sdo->id))) { + /* A value was supplied for this option. */ + if (!g_variant_type_equal(g_variant_get_type(value), + g_variant_get_type(sdo->def))) { + srd_err("Option '%s' should have the same type " + "as the default value.", sdo->id); + goto err_out; + } + } else { + /* Use default for this option. */ + value = sdo->def; + } + if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { + val_str = g_variant_get_string(value, NULL); + if (!(py_optval = PyUnicode_FromString(val_str))) { + /* Some UTF-8 encoding error. */ + PyErr_Clear(); + srd_err("Option '%s' requires a UTF-8 string value.", sdo->id); + goto err_out; + } + } 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))) { + /* ValueError Exception */ + PyErr_Clear(); + srd_err("Option '%s' has invalid integer value.", sdo->id); + goto err_out; + } + } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) { + val_double = g_variant_get_double(value); + if (!(py_optval = PyFloat_FromDouble(val_double))) { + /* ValueError Exception */ + PyErr_Clear(); + srd_err("Option '%s' has invalid float value.", + sdo->id); + goto err_out; + } + } if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) goto err_out; - /* Not harmful even if we used the default. */ - g_hash_table_remove(options, sdo->id); - } - if (g_hash_table_size(options) != 0) - srd_warn("Unknown options specified for '%s'", di->inst_id); + /* Not harmful even if we used the default. */ + g_hash_table_remove(options, sdo->id); + } + if (g_hash_table_size(options) != 0) + srd_warn("Unknown options specified for '%s'", di->inst_id); ret = SRD_OK; err_out: Py_XDECREF(py_optval); if (PyErr_Occurred()) { - srd_exception_catch("Stray exception in srd_inst_option_set()."); + srd_exception_catch("Stray exception in srd_inst_option_set()"); ret = SRD_ERR_PYTHON; } return ret; } -/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ -static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) +/* 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) { - return strcmp(a->id, probe_id); + return strcmp(pdch->id, channel_id); } /** - * Set all probes in a decoder instance. + * Set all channels in a decoder instance. * - * This function sets _all_ probes for the specified decoder instance, i.e., - * it overwrites any probes that were already defined (if any). + * This function sets _all_ channels for the specified decoder instance, i.e., + * it overwrites any channels that were already defined (if any). * * @param di Decoder instance. - * @param new_probes A GHashTable of probes to set. Key is probe name, value is - * the probe number. Samples passed to this instance will be - * arranged in this order. - * @param unit_size Number of bytes per sample in the data stream to be passed - * to the decoder. The highest probe index specified in the - * probe map must lie within a sample unit. + * @param new_channels A GHashTable of channels to set. Key is channel name, + * value is the channel number. Samples passed to this + * instance will be arranged in this order. * * @return SRD_OK upon success, a (negative) error code otherwise. * - * @since 0.1.0 + * @since 0.4.0 */ -SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, - GHashTable *new_probes, int unit_size) +SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, + GHashTable *new_channels) { - GVariant *probe_val; + GVariant *channel_val; GList *l; GSList *sl; - struct srd_probe *p; - int *new_probemap, new_probenum, num_required_probes, i; - char *probe_id; + struct srd_channel *pdch; + int *new_channelmap, new_channelnum, num_required_channels, i; + char *channel_id; - srd_dbg("set probes called for instance %s with list of %d probes", - di->inst_id, g_hash_table_size(new_probes)); + srd_dbg("Setting channels for instance %s with list of %d channels.", + di->inst_id, g_hash_table_size(new_channels)); - if (g_hash_table_size(new_probes) == 0) - /* No probes provided. */ + if (g_hash_table_size(new_channels) == 0) + /* No channels provided. */ return SRD_OK; - if (di->dec_num_probes == 0) { - /* Decoder has no probes. */ - srd_err("Protocol decoder %s has no probes to define.", + if (di->dec_num_channels == 0) { + /* Decoder has no channels. */ + srd_err("Protocol decoder %s has no channels to define.", di->decoder->name); return SRD_ERR_ARG; } - new_probemap = NULL; - - if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { - srd_err("Failed to g_malloc() new probe map."); - return SRD_ERR_MALLOC; - } + new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels); /* - * For now, map all indexes to probe -1 (can be overridden later). - * This -1 is interpreted as an unspecified probe later. + * For now, map all indexes to channel -1 (can be overridden later). + * This -1 is interpreted as an unspecified channel later. */ - for (i = 0; i < di->dec_num_probes; i++) - new_probemap[i] = -1; - - for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { - probe_id = l->data; - probe_val = g_hash_table_lookup(new_probes, probe_id); - if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) { - /* Probe name was specified without a value. */ - srd_err("No probe number was specified for %s.", - probe_id); - g_free(new_probemap); + for (i = 0; i < di->dec_num_channels; i++) + new_channelmap[i] = -1; + + for (l = g_hash_table_get_keys(new_channels); l; l = l->next) { + channel_id = l->data; + channel_val = g_hash_table_lookup(new_channels, channel_id); + if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) { + /* Channel name was specified without a value. */ + srd_err("No channel number was specified for %s.", + channel_id); + g_free(new_channelmap); return SRD_ERR_ARG; } - new_probenum = g_variant_get_int32(probe_val); - if (new_probenum >= 8 * unit_size) { - srd_err("Probe index %d not within data unit (%d bit).", - new_probenum, 8 * unit_size); - g_free(new_probemap); - return SRD_ERR_ARG; - } - if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, - (GCompareFunc)compare_probe_id))) { - /* Fall back on optional probes. */ - if (!(sl = g_slist_find_custom(di->decoder->opt_probes, - probe_id, (GCompareFunc) compare_probe_id))) { - srd_err("Protocol decoder %s has no probe " - "'%s'.", di->decoder->name, probe_id); - g_free(new_probemap); + new_channelnum = g_variant_get_int32(channel_val); + if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id, + (GCompareFunc)compare_channel_id))) { + /* Fall back on optional channels. */ + if (!(sl = g_slist_find_custom(di->decoder->opt_channels, + channel_id, (GCompareFunc)compare_channel_id))) { + srd_err("Protocol decoder %s has no channel " + "'%s'.", di->decoder->name, channel_id); + g_free(new_channelmap); return SRD_ERR_ARG; } } - p = sl->data; - new_probemap[p->order] = new_probenum; - srd_dbg("Setting probe mapping: %s (index %d) = probe %d.", - p->id, p->order, new_probenum); + pdch = sl->data; + new_channelmap[pdch->order] = new_channelnum; + srd_dbg("Setting channel mapping: %s (index %d) = channel %d.", + pdch->id, pdch->order, new_channelnum); } - di->data_unitsize = unit_size; - srd_dbg("Final probe map:"); - num_required_probes = g_slist_length(di->decoder->probes); - for (i = 0; i < di->dec_num_probes; i++) { - srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i], - (i < num_required_probes) ? "required" : "optional"); + 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], + (i < num_required_channels) ? "required" : "optional"); } - /* Report an error if not all required probes were specified. */ - for (i = 0; i < num_required_probes; i++) { - if (new_probemap[i] != -1) + /* Report an error if not all required channels were specified. */ + for (i = 0; i < num_required_channels; i++) { + if (new_channelmap[i] != -1) continue; - p = g_slist_nth(di->decoder->probes, i)->data; - srd_err("Required probe '%s' (index %d) was not specified.", - p->id, i); + pdch = g_slist_nth(di->decoder->channels, i)->data; + srd_err("Required channel '%s' (index %d) was not specified.", + pdch->id, i); return SRD_ERR; } - g_free(di->dec_probemap); - di->dec_probemap = new_probemap; + g_free(di->dec_channelmap); + di->dec_channelmap = new_channelmap; return SRD_OK; } @@ -322,10 +309,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, return NULL; } - if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { - srd_err("Failed to g_malloc() instance."); - return NULL; - } + di = g_malloc0(sizeof(struct srd_decoder_inst)); di->decoder = dec; di->sess = sess; @@ -337,49 +321,51 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, di->inst_id = g_strdup(decoder_id); /* - * Prepare a default probe map, where samples come in the + * Prepare a default channel map, where samples come in the * order in which the decoder class defined them. */ - di->dec_num_probes = g_slist_length(di->decoder->probes) + - g_slist_length(di->decoder->opt_probes); - if (di->dec_num_probes) { - if (!(di->dec_probemap = - g_try_malloc(sizeof(int) * di->dec_num_probes))) { - srd_err("Failed to g_malloc() probe map."); - g_free(di); - return NULL; - } - for (i = 0; i < di->dec_num_probes; i++) - di->dec_probemap[i] = i; - di->data_unitsize = (di->dec_num_probes + 7) / 8; + di->dec_num_channels = g_slist_length(di->decoder->channels) + + g_slist_length(di->decoder->opt_channels); + if (di->dec_num_channels) { + di->dec_channelmap = + g_malloc(sizeof(int) * di->dec_num_channels); + for (i = 0; i < di->dec_num_channels; i++) + di->dec_channelmap[i] = i; /* * Will be used to prepare a sample at every iteration * of the instance's decode() method. */ - if (!(di->probe_samples = g_try_malloc(di->dec_num_probes))) { - srd_err("Failed to g_malloc() sample buffer."); - g_free(di->dec_probemap); - g_free(di); - return NULL; - } + di->channel_samples = g_malloc(di->dec_num_channels); } /* 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: ", + srd_exception_catch("Failed to create %s instance", decoder_id); - g_free(di->dec_probemap); + g_free(di->dec_channelmap); g_free(di); return NULL; } if (options && srd_inst_option_set(di, options) != SRD_OK) { - g_free(di->dec_probemap); + g_free(di->dec_channelmap); g_free(di); return NULL; } + di->condition_list = NULL; + di->match_array = NULL; + di->start_samplenum = 0; + di->end_samplenum = 0; + di->inbuf = NULL; + di->inbuflen = 0; + di->cur_samplenum = 0; + di->old_pins_array = NULL; + di->thread_handle = NULL; + di->got_new_samples = FALSE; + di->handled_all_samples = FALSE; + /* Instance takes input from a frontend by default. */ sess->di_list = g_slist_append(sess->di_list, di); @@ -420,7 +406,7 @@ SRD_API int srd_inst_stack(struct srd_session *sess, /* Stack on top of source di. */ di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top); - srd_dbg("Stacked %s on top of %s.", di_top->inst_id, di_bottom->inst_id); + srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id); return SRD_OK; } @@ -519,6 +505,56 @@ SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, return di; } +/** + * Set the list of initial (assumed) pin values. + * + * If the list already exists, do nothing. + * + * @param di Decoder instance to use. Must not be NULL. + * + * @private + */ +static void set_initial_pin_values(struct srd_decoder_inst *di) +{ + int i; + GString *s; + PyObject *py_initial_pins; + + if (!di || !di->py_inst) { + srd_err("Invalid decoder instance."); + return; + } + + /* Nothing to do if di->old_pins_array is already != NULL. */ + if (di->old_pins_array) { + srd_dbg("Initial pins already set, nothing to do."); + return; + } + + /* Create an array of old (previous sample) pins, init to 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); + + /* Check if the decoder has set self.initial_pins. */ + if (!PyObject_HasAttrString(di->py_inst, "initial_pins")) { + srd_dbg("Initial pins: all 0 (self.initial_pins not set)."); + return; + } + + /* Get self.initial_pins. */ + py_initial_pins = PyObject_GetAttrString(di->py_inst, "initial_pins"); + + /* Fill di->old_pins_array based on self.initial_pins. */ + s = g_string_sized_new(100); + for (i = 0; i < di->dec_num_channels; i++) { + di->old_pins_array->data[i] = PyLong_AsLong(PyList_GetItem(py_initial_pins, i)); + g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]); + } + s = g_string_truncate(s, s->len - 2); + srd_dbg("Initial pins: %s.", s->str); + g_string_free(s, TRUE); +} + /** @private */ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) { @@ -530,13 +566,23 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) srd_dbg("Calling start() method on protocol decoder instance %s.", di->inst_id); + /* Run self.start(). */ if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { - srd_exception_catch("Protocol decoder instance %s: ", + srd_exception_catch("Protocol decoder instance %s", di->inst_id); return SRD_ERR_PYTHON; } Py_DecRef(py_res); + /* Set the initial pins based on self.initial_pins. */ + set_initial_pin_values(di); + + /* Set self.samplenum to 0. */ + PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0)); + + /* Set self.matches to None. */ + PyObject_SetAttrString(di->py_inst, "matches", Py_None); + /* Start all the PDs stacked on top of this one. */ for (l = di->next_di; l; l = l->next) { next_di = l->data; @@ -548,7 +594,305 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) } /** - * Run the specified decoder function. + * Check whether the specified sample matches the specified term. + * + * In the case of SRD_TERM_SKIP, this function can modify + * term->num_samples_already_skipped. + * + * @param old_sample The value of the previous sample (0/1). + * @param sample The value of the current sample (0/1). + * @param term The term that should be checked for a match. Must not be NULL. + * + * @retval TRUE The current sample matches the specified term. + * @retval FALSE The current sample doesn't match the specified term, or an + * invalid term was provided. + * + * @private + */ +static gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term) +{ + if (!term) + return FALSE; + + switch (term->type) { + case SRD_TERM_HIGH: + if (sample == 1) + return TRUE; + break; + case SRD_TERM_LOW: + if (sample == 0) + return TRUE; + break; + case SRD_TERM_RISING_EDGE: + if (old_sample == 0 && sample == 1) + return TRUE; + break; + case SRD_TERM_FALLING_EDGE: + if (old_sample == 1 && sample == 0) + return TRUE; + break; + case SRD_TERM_EITHER_EDGE: + if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1)) + return TRUE; + break; + case SRD_TERM_NO_EDGE: + if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1)) + return TRUE; + break; + case SRD_TERM_SKIP: + if (term->num_samples_already_skipped == term->num_samples_to_skip) + return TRUE; + term->num_samples_already_skipped++; + break; + default: + srd_err("Unknown term type %d.", term->type); + break; + } + + return FALSE; +} + +SRD_PRIV void match_array_free(struct srd_decoder_inst *di) +{ + if (!di || !di->match_array) + return; + + g_array_free(di->match_array, TRUE); + di->match_array = NULL; +} + +SRD_PRIV void condition_list_free(struct srd_decoder_inst *di) +{ + GSList *l, *ll; + + if (!di) + return; + + for (l = di->condition_list; l; l = l->next) { + ll = l->data; + if (ll) + g_slist_free_full(ll, g_free); + } + + di->condition_list = NULL; +} + +static gboolean have_non_null_conds(const struct srd_decoder_inst *di) +{ + GSList *l, *cond; + + if (!di) + return FALSE; + + for (l = di->condition_list; l; l = l->next) { + cond = l->data; + if (cond) + return TRUE; + } + + return FALSE; +} + +static void update_old_pins_array(struct srd_decoder_inst *di, + const uint8_t *sample_pos) +{ + uint8_t sample; + int i, byte_offset, bit_offset; + + if (!di || !di->dec_channelmap || !sample_pos) + return; + + for (i = 0; i < di->dec_num_channels; i++) { + byte_offset = di->dec_channelmap[i] / 8; + bit_offset = di->dec_channelmap[i] % 8; + sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0; + di->old_pins_array->data[i] = sample; + } +} + +static gboolean term_matches(const struct srd_decoder_inst *di, + struct srd_term *term, const uint8_t *sample_pos) +{ + uint8_t old_sample, sample; + int byte_offset, bit_offset, ch; + + if (!di || !di->dec_channelmap || !term || !sample_pos) + return FALSE; + + /* Overwritten below (or ignored for SRD_TERM_SKIP). */ + old_sample = sample = 0; + + if (term->type != SRD_TERM_SKIP) { + ch = term->channel; + byte_offset = di->dec_channelmap[ch] / 8; + bit_offset = di->dec_channelmap[ch] % 8; + sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0; + old_sample = di->old_pins_array->data[ch]; + } + + return sample_matches(old_sample, sample, term); +} + +static gboolean all_terms_match(const struct srd_decoder_inst *di, + const GSList *cond, const uint8_t *sample_pos) +{ + const GSList *l; + struct srd_term *term; + + if (!di || !cond || !sample_pos) + return FALSE; + + for (l = cond; l; l = l->next) { + term = l->data; + if (!term_matches(di, term, sample_pos)) + return FALSE; + } + + return TRUE; +} + +static gboolean at_least_one_condition_matched( + const struct srd_decoder_inst *di, unsigned int num_conditions) +{ + unsigned int i; + + if (!di) + return FALSE; + + for (i = 0; i < num_conditions; i++) { + if (di->match_array->data[i]) + return TRUE; + } + + return FALSE; +} + +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; + unsigned int num_conditions; + + /* Check whether the condition list is NULL/empty. */ + if (!di->condition_list) { + srd_dbg("NULL/empty condition list, automatic match."); + return TRUE; + } + + /* Check whether we have any non-NULL conditions. */ + if (!have_non_null_conds(di)) { + srd_dbg("Only NULL conditions in list, automatic match."); + return TRUE; + } + + num_samples_to_process = di->end_samplenum - di->cur_samplenum; + num_conditions = g_slist_length(di->condition_list); + + /* di->match_array is NULL here. Create a new GArray. */ + di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions); + g_array_set_size(di->match_array, num_conditions); + + for (i = 0, s = 0; i < num_samples_to_process; i++, s++, (di->cur_samplenum)++) { + + sample_pos = di->inbuf + ((di->cur_samplenum - di->start_samplenum) * di->data_unitsize); + + /* Check whether the current sample matches at least one of the conditions (logical OR). */ + /* IMPORTANT: We need to check all conditions, even if there was a match already! */ + for (l = di->condition_list, j = 0; l; l = l->next, j++) { + cond = l->data; + if (!cond) + continue; + /* All terms in 'cond' must match (logical AND). */ + di->match_array->data[j] = all_terms_match(di, cond, sample_pos); + } + + update_old_pins_array(di, sample_pos); + + /* If at least one condition matched we're done. */ + if (at_least_one_condition_matched(di, num_conditions)) + return TRUE; + } + + return FALSE; +} + +/** + * Process available samples and check if they match the defined conditions. + * + * This function returns if there is an error, or when a match is found, or + * when all samples have been processed (whether a match was found or not). + * + * @param di The decoder instance to use. Must not be NULL. + * @param found_match Will be set to TRUE if at least one condition matched, + * FALSE otherwise. Must not be NULL. + * + * @retval SRD_OK No errors occured, see found_match for the result. + * @retval SRD_ERR_ARG Invalid arguments. + * + * @private + */ +SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match) +{ + if (!di || !found_match) + return SRD_ERR_ARG; + + /* Check if any of the current condition(s) match. */ + while (TRUE) { + /* Feed the (next chunk of the) buffer to find_match(). */ + *found_match = find_match(di); + + /* Did we handle all samples yet? */ + if (di->cur_samplenum >= di->end_samplenum) { + srd_dbg("Done, handled all samples (%" PRIu64 "/%" PRIu64 ").", + di->cur_samplenum, di->end_samplenum); + return SRD_OK; + } + + /* If we didn't find a match, continue looking. */ + if (!(*found_match)) + continue; + + /* At least one condition matched, return. */ + return SRD_OK; + } + + return SRD_OK; +} + +/** + * Worker thread (per PD-stack). + * + * @param data Pointer to the lowest-level PD's device instance. + * Must not be NULL. + * + * @return NULL if there was an error. + */ +static gpointer di_thread(gpointer data) +{ + PyObject *py_res; + struct srd_decoder_inst *di; + + if (!data) + return NULL; + + di = data; + + /* Call self.decode(). Only returns if the PD throws an exception. */ + Py_IncRef(di->py_inst); + if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", NULL))) { + srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); + exit(1); /* TODO: Proper shutdown. This is a hack. */ + return NULL; + } + Py_DecRef(py_res); + + return NULL; +} + +/** + * Decode a chunk of samples. * * @param di The decoder instance to call. Must not be NULL. * @param start_samplenum The starting sample number for the buffer's sample @@ -557,23 +901,19 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) * set, relative to the start of capture. * @param inbuf The buffer to decode. Must not be NULL. * @param inbuflen Length of the buffer. Must be > 0. + * @param unitsize The number of bytes per sample. Must be > 0. * * @return SRD_OK upon success, a (negative) error code otherwise. * * @private - * - * @since 0.1.0 */ -SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, +SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di, uint64_t start_samplenum, uint64_t end_samplenum, - const uint8_t *inbuf, uint64_t inbuflen) + const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize) { PyObject *py_res; srd_logic *logic; - - srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes " - "starting at sample %" PRIu64 ".", di->inst_id, inbuflen, - start_samplenum); + long apiver; /* Return an error upon unusable input. */ if (!di) { @@ -588,28 +928,69 @@ SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, srd_dbg("empty buffer"); return SRD_ERR_ARG; } + if (unitsize == 0) { + srd_dbg("unitsize 0"); + return SRD_ERR_ARG; + } - /* - * Create new srd_logic object. Each iteration around the PD's loop - * will fill one sample into this object. - */ - logic = PyObject_New(srd_logic, &srd_logic_type); - Py_INCREF(logic); - logic->di = (struct srd_decoder_inst *)di; - logic->start_samplenum = start_samplenum; - logic->itercnt = 0; - logic->inbuf = (uint8_t *)inbuf; - logic->inbuflen = inbuflen; - logic->sample = PyList_New(2); - Py_INCREF(logic->sample); + di->data_unitsize = unitsize; - Py_IncRef(di->py_inst); - if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", + srd_dbg("Decoding: start sample %" PRIu64 ", end sample %" + PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = " + "%d), instance %s.", start_samplenum, end_samplenum, + end_samplenum - start_samplenum, inbuflen, di->data_unitsize, + di->inst_id); + + apiver = srd_decoder_apiver(di->decoder); + + if (apiver == 2) { + /* + * Create new srd_logic object. Each iteration around the PD's + * loop will fill one sample into this object. + */ + logic = PyObject_New(srd_logic, (PyTypeObject *)srd_logic_type); + Py_INCREF(logic); + logic->di = (struct srd_decoder_inst *)di; + logic->start_samplenum = start_samplenum; + logic->itercnt = 0; + logic->inbuf = (uint8_t *)inbuf; + logic->inbuflen = inbuflen; + logic->sample = PyList_New(2); + Py_INCREF(logic->sample); + + Py_IncRef(di->py_inst); + if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", "KKO", start_samplenum, end_samplenum, logic))) { - srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); - return SRD_ERR_PYTHON; + srd_exception_catch("Protocol decoder instance %s", + di->inst_id); + return SRD_ERR_PYTHON; + } + Py_DecRef(py_res); + } else { + /* If this is the first call, start the worker thread. */ + if (!di->thread_handle) + di->thread_handle = g_thread_new("di_thread", + di_thread, di); + + /* Push the new sample chunk to the worker thread. */ + g_mutex_lock(&di->data_mutex); + di->start_samplenum = start_samplenum; + di->end_samplenum = end_samplenum; + di->inbuf = inbuf; + di->inbuflen = inbuflen; + di->got_new_samples = TRUE; + di->handled_all_samples = FALSE; + + /* Signal the thread that we have new data. */ + g_cond_signal(&di->got_new_samples_cond); + g_mutex_unlock(&di->data_mutex); + + /* When all samples in this chunk were handled, return. */ + g_mutex_lock(&di->data_mutex); + while (!di->handled_all_samples) + g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex); + g_mutex_unlock(&di->data_mutex); } - Py_DecRef(py_res); return SRD_OK; } @@ -624,7 +1005,8 @@ SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) Py_DecRef(di->py_inst); g_free(di->inst_id); - g_free(di->dec_probemap); + g_free(di->dec_channelmap); + g_free(di->channel_samples); g_slist_free(di->next_di); for (l = di->pd_output; l; l = l->next) { pdo = l->data; @@ -660,4 +1042,3 @@ SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) } /** @} */ -