]>
Commit | Line | Data |
---|---|---|
b2c19614 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
b2c19614 BV |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
bc5f5a43 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
b2c19614 BV |
6 | * |
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. | |
11 | * | |
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. | |
16 | * | |
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/>. | |
19 | */ | |
20 | ||
36784362 | 21 | #include <config.h> |
f6c7eade MC |
22 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
23 | #include "libsigrokdecode.h" | |
b2c19614 | 24 | #include <glib.h> |
1aef2f93 | 25 | #include <inttypes.h> |
0bdadba2 | 26 | #include <stdlib.h> |
32cfb920 | 27 | #include <stdint.h> |
b2c19614 | 28 | |
32cfb920 | 29 | /** @cond PRIVATE */ |
d906d3f9 | 30 | |
23a29d24 | 31 | extern SRD_PRIV GSList *sessions; |
b2c19614 | 32 | |
04383ea8 GS |
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); | |
63bbdb44 | 35 | SRD_PRIV void oldpins_array_seed(struct srd_decoder_inst *di); |
04383ea8 GS |
36 | SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di); |
37 | ||
57790bc8 UH |
38 | /** @endcond */ |
39 | ||
b2c19614 | 40 | /** |
190b71cf | 41 | * @file |
8c664ca2 | 42 | * |
190b71cf | 43 | * Decoder instance handling. |
b2c19614 | 44 | */ |
4895418c UH |
45 | |
46 | /** | |
47 | * @defgroup grp_instances Decoder instances | |
48 | * | |
49 | * Decoder instance handling. | |
50 | * | |
51 | * @{ | |
52 | */ | |
53 | ||
7ce7775c | 54 | /** |
b33b8aa5 | 55 | * Set one or more options in a decoder instance. |
0bdadba2 | 56 | * |
361fdcaa UH |
57 | * Handled options are removed from the hash. |
58 | * | |
0bdadba2 BV |
59 | * @param di Decoder instance. |
60 | * @param options A GHashTable of options to set. | |
7ce7775c | 61 | * |
0bdadba2 | 62 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
63 | * |
64 | * @since 0.1.0 | |
0bdadba2 | 65 | */ |
b33b8aa5 | 66 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 67 | GHashTable *options) |
0bdadba2 | 68 | { |
d841d5b2 | 69 | struct srd_decoder_option *sdo; |
84c1c0b5 | 70 | PyObject *py_di_options, *py_optval; |
2f395bff | 71 | GVariant *value; |
d841d5b2 UH |
72 | GSList *l; |
73 | double val_double; | |
2f395bff | 74 | gint64 val_int; |
84c1c0b5 | 75 | int ret; |
2f395bff | 76 | const char *val_str; |
514b2edc | 77 | PyGILState_STATE gstate; |
0bdadba2 | 78 | |
3af0e345 UH |
79 | if (!di) { |
80 | srd_err("Invalid decoder instance."); | |
81 | return SRD_ERR_ARG; | |
82 | } | |
83 | ||
84 | if (!options) { | |
85 | srd_err("Invalid options GHashTable."); | |
86 | return SRD_ERR_ARG; | |
87 | } | |
88 | ||
514b2edc UH |
89 | gstate = PyGILState_Ensure(); |
90 | ||
c9bfccc6 | 91 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 92 | /* Decoder has no options. */ |
514b2edc | 93 | PyGILState_Release(gstate); |
e431d9cc BV |
94 | if (g_hash_table_size(options) == 0) { |
95 | /* No options provided. */ | |
96 | return SRD_OK; | |
97 | } else { | |
98 | srd_err("Protocol decoder has no options."); | |
99 | return SRD_ERR_ARG; | |
100 | } | |
0bdadba2 | 101 | return SRD_OK; |
e431d9cc | 102 | } |
0bdadba2 BV |
103 | |
104 | ret = SRD_ERR_PYTHON; | |
d841d5b2 | 105 | py_optval = NULL; |
119d6258 BV |
106 | |
107 | /* | |
84c1c0b5 | 108 | * The 'options' tuple is a class variable, but we need to |
119d6258 BV |
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 | |
111 | * instead. | |
112 | */ | |
a8b72b05 | 113 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 | 114 | goto err_out; |
119d6258 BV |
115 | Py_DECREF(py_di_options); |
116 | py_di_options = PyDict_New(); | |
117 | PyObject_SetAttrString(di->py_inst, "options", py_di_options); | |
0bdadba2 | 118 | |
d841d5b2 UH |
119 | for (l = di->decoder->options; l; l = l->next) { |
120 | sdo = l->data; | |
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), | |
bd6594c0 | 124 | g_variant_get_type(sdo->def))) { |
d841d5b2 UH |
125 | srd_err("Option '%s' should have the same type " |
126 | "as the default value.", sdo->id); | |
127 | goto err_out; | |
128 | } | |
129 | } else { | |
130 | /* Use default for this option. */ | |
131 | value = sdo->def; | |
132 | } | |
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. */ | |
137 | PyErr_Clear(); | |
138 | srd_err("Option '%s' requires a UTF-8 string value.", sdo->id); | |
139 | goto err_out; | |
140 | } | |
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 */ | |
145 | PyErr_Clear(); | |
146 | srd_err("Option '%s' has invalid integer value.", sdo->id); | |
147 | goto err_out; | |
148 | } | |
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 */ | |
153 | PyErr_Clear(); | |
154 | srd_err("Option '%s' has invalid float value.", | |
155 | sdo->id); | |
156 | goto err_out; | |
157 | } | |
158 | } | |
84c1c0b5 | 159 | if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) |
0bdadba2 | 160 | goto err_out; |
d841d5b2 UH |
161 | /* Not harmful even if we used the default. */ |
162 | g_hash_table_remove(options, sdo->id); | |
163 | } | |
164 | if (g_hash_table_size(options) != 0) | |
165 | srd_warn("Unknown options specified for '%s'", di->inst_id); | |
0bdadba2 BV |
166 | |
167 | ret = SRD_OK; | |
168 | ||
169 | err_out: | |
84c1c0b5 | 170 | Py_XDECREF(py_optval); |
7fc7bde6 | 171 | if (PyErr_Occurred()) { |
201a85a8 | 172 | srd_exception_catch("Stray exception in srd_inst_option_set()"); |
7fc7bde6 BV |
173 | ret = SRD_ERR_PYTHON; |
174 | } | |
514b2edc | 175 | PyGILState_Release(gstate); |
0bdadba2 BV |
176 | |
177 | return ret; | |
178 | } | |
179 | ||
6a15597a UH |
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) | |
f38ec285 | 183 | { |
6a15597a | 184 | return strcmp(pdch->id, channel_id); |
f38ec285 BV |
185 | } |
186 | ||
0bdadba2 | 187 | /** |
6a15597a | 188 | * Set all channels in a decoder instance. |
b33b8aa5 | 189 | * |
6a15597a UH |
190 | * This function sets _all_ channels for the specified decoder instance, i.e., |
191 | * it overwrites any channels that were already defined (if any). | |
0bdadba2 BV |
192 | * |
193 | * @param di Decoder instance. | |
6a15597a UH |
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. | |
12243c22 | 197 | * |
0bdadba2 | 198 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 | 199 | * |
cda2d36c | 200 | * @since 0.4.0 |
0bdadba2 | 201 | */ |
6a15597a | 202 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
cda2d36c | 203 | GHashTable *new_channels) |
0bdadba2 | 204 | { |
6a15597a | 205 | GVariant *channel_val; |
f38ec285 BV |
206 | GList *l; |
207 | GSList *sl; | |
6a15597a UH |
208 | struct srd_channel *pdch; |
209 | int *new_channelmap, new_channelnum, num_required_channels, i; | |
210 | char *channel_id; | |
0bdadba2 | 211 | |
cda2d36c UH |
212 | srd_dbg("Setting channels for instance %s with list of %d channels.", |
213 | di->inst_id, g_hash_table_size(new_channels)); | |
ce46beed | 214 | |
6a15597a UH |
215 | if (g_hash_table_size(new_channels) == 0) |
216 | /* No channels provided. */ | |
0bdadba2 BV |
217 | return SRD_OK; |
218 | ||
6a15597a UH |
219 | if (di->dec_num_channels == 0) { |
220 | /* Decoder has no channels. */ | |
221 | srd_err("Protocol decoder %s has no channels to define.", | |
c9bfccc6 | 222 | di->decoder->name); |
f38ec285 BV |
223 | return SRD_ERR_ARG; |
224 | } | |
0bdadba2 | 225 | |
077fa8ac | 226 | new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels); |
0bdadba2 | 227 | |
38ff5046 | 228 | /* |
6a15597a UH |
229 | * For now, map all indexes to channel -1 (can be overridden later). |
230 | * This -1 is interpreted as an unspecified channel later. | |
38ff5046 | 231 | */ |
6a15597a UH |
232 | for (i = 0; i < di->dec_num_channels; i++) |
233 | new_channelmap[i] = -1; | |
234 | ||
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.", | |
241 | channel_id); | |
242 | g_free(new_channelmap); | |
be873260 BV |
243 | return SRD_ERR_ARG; |
244 | } | |
6a15597a | 245 | new_channelnum = g_variant_get_int32(channel_val); |
6a15597a UH |
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, | |
d841d5b2 | 250 | channel_id, (GCompareFunc)compare_channel_id))) { |
6a15597a | 251 | srd_err("Protocol decoder %s has no channel " |
d841d5b2 | 252 | "'%s'.", di->decoder->name, channel_id); |
6a15597a | 253 | g_free(new_channelmap); |
f38ec285 BV |
254 | return SRD_ERR_ARG; |
255 | } | |
256 | } | |
6a15597a UH |
257 | pdch = sl->data; |
258 | new_channelmap[pdch->order] = new_channelnum; | |
5b2595b5 | 259 | srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.", |
6a15597a | 260 | pdch->id, pdch->order, new_channelnum); |
38ff5046 UH |
261 | } |
262 | ||
6a15597a UH |
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++) { | |
5b2595b5 UH |
266 | GSList *l = g_slist_nth(di->decoder->channels, i); |
267 | if (!l) | |
268 | l = g_slist_nth(di->decoder->opt_channels, | |
269 | i - num_required_channels); | |
270 | pdch = l->data; | |
271 | srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i, | |
272 | pdch->id, new_channelmap[i], | |
d841d5b2 | 273 | (i < num_required_channels) ? "required" : "optional"); |
f38ec285 | 274 | } |
38ff5046 | 275 | |
6a15597a UH |
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) | |
9bf7f71c | 279 | continue; |
6a15597a UH |
280 | pdch = g_slist_nth(di->decoder->channels, i)->data; |
281 | srd_err("Required channel '%s' (index %d) was not specified.", | |
282 | pdch->id, i); | |
9bf7f71c UH |
283 | return SRD_ERR; |
284 | } | |
285 | ||
6a15597a UH |
286 | g_free(di->dec_channelmap); |
287 | di->dec_channelmap = new_channelmap; | |
0bdadba2 | 288 | |
f38ec285 | 289 | return SRD_OK; |
0bdadba2 BV |
290 | } |
291 | ||
292 | /** | |
293 | * Create a new protocol decoder instance. | |
7ce7775c | 294 | * |
32cfb920 | 295 | * @param sess The session holding the protocol decoder instance. |
38ff5046 | 296 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 297 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 298 | * the decoder class. May be NULL. |
12243c22 | 299 | * |
a8b72b05 | 300 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 301 | * NULL in case of failure. |
8c664ca2 | 302 | * |
69075817 | 303 | * @since 0.3.0 |
7ce7775c | 304 | */ |
32cfb920 BV |
305 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
306 | const char *decoder_id, GHashTable *options) | |
b2c19614 | 307 | { |
c9bfccc6 | 308 | int i; |
b2c19614 | 309 | struct srd_decoder *dec; |
a8b72b05 BV |
310 | struct srd_decoder_inst *di; |
311 | char *inst_id; | |
514b2edc | 312 | PyGILState_STATE gstate; |
b2c19614 | 313 | |
3262ef02 | 314 | i = 1; |
7a1712c4 | 315 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 316 | |
32cfb920 BV |
317 | if (session_is_valid(sess) != SRD_OK) { |
318 | srd_err("Invalid session."); | |
319 | return NULL; | |
320 | } | |
321 | ||
9d122fd5 | 322 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 323 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 324 | return NULL; |
0bdadba2 | 325 | } |
b2c19614 | 326 | |
077fa8ac | 327 | di = g_malloc0(sizeof(struct srd_decoder_inst)); |
0bdadba2 | 328 | |
b2c19614 | 329 | di->decoder = dec; |
32cfb920 | 330 | di->sess = sess; |
3262ef02 | 331 | |
38ff5046 UH |
332 | if (options) { |
333 | inst_id = g_hash_table_lookup(options, "id"); | |
3262ef02 KP |
334 | if (inst_id) |
335 | di->inst_id = g_strdup(inst_id); | |
38ff5046 | 336 | g_hash_table_remove(options, "id"); |
3262ef02 KP |
337 | } |
338 | ||
339 | /* Create a unique instance ID (as none was provided). */ | |
340 | if (!di->inst_id) { | |
341 | di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++); | |
342 | while (srd_inst_find_by_id(sess, di->inst_id)) { | |
343 | g_free(di->inst_id); | |
344 | di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++); | |
345 | } | |
346 | } | |
b2c19614 | 347 | |
361fdcaa | 348 | /* |
6a15597a | 349 | * Prepare a default channel map, where samples come in the |
f38ec285 BV |
350 | * order in which the decoder class defined them. |
351 | */ | |
6a15597a UH |
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) { | |
077fa8ac UH |
355 | di->dec_channelmap = |
356 | g_malloc(sizeof(int) * di->dec_num_channels); | |
6a15597a UH |
357 | for (i = 0; i < di->dec_num_channels; i++) |
358 | di->dec_channelmap[i] = i; | |
37b94c20 BV |
359 | /* |
360 | * Will be used to prepare a sample at every iteration | |
361 | * of the instance's decode() method. | |
362 | */ | |
077fa8ac | 363 | di->channel_samples = g_malloc(di->dec_num_channels); |
f38ec285 | 364 | } |
f38ec285 | 365 | |
97b874bd | 366 | /* Default to the initial pins being the same as in sample 0. */ |
63bbdb44 | 367 | oldpins_array_seed(di); |
97b874bd | 368 | |
514b2edc UH |
369 | gstate = PyGILState_Ensure(); |
370 | ||
0bdadba2 | 371 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 372 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 373 | if (PyErr_Occurred()) |
201a85a8 | 374 | srd_exception_catch("Failed to create %s instance", |
69075817 | 375 | decoder_id); |
514b2edc | 376 | PyGILState_Release(gstate); |
6a15597a | 377 | g_free(di->dec_channelmap); |
0bdadba2 | 378 | g_free(di); |
7ce7775c | 379 | return NULL; |
b2c19614 | 380 | } |
7ce7775c | 381 | |
514b2edc UH |
382 | PyGILState_Release(gstate); |
383 | ||
38ff5046 | 384 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
6a15597a | 385 | g_free(di->dec_channelmap); |
0bdadba2 BV |
386 | g_free(di); |
387 | return NULL; | |
388 | } | |
b2c19614 | 389 | |
21dfd91d UH |
390 | di->condition_list = NULL; |
391 | di->match_array = NULL; | |
4564e8e5 UH |
392 | di->abs_start_samplenum = 0; |
393 | di->abs_end_samplenum = 0; | |
21dfd91d UH |
394 | di->inbuf = NULL; |
395 | di->inbuflen = 0; | |
4564e8e5 | 396 | di->abs_cur_samplenum = 0; |
21dfd91d UH |
397 | di->thread_handle = NULL; |
398 | di->got_new_samples = FALSE; | |
399 | di->handled_all_samples = FALSE; | |
04383ea8 GS |
400 | di->want_wait_terminate = FALSE; |
401 | ||
402 | /* | |
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. | |
407 | */ | |
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); | |
21dfd91d | 411 | |
f38ec285 | 412 | /* Instance takes input from a frontend by default. */ |
32cfb920 | 413 | sess->di_list = g_slist_append(sess->di_list, di); |
3262ef02 | 414 | srd_dbg("Created new %s instance with ID %s.", decoder_id, di->inst_id); |
f38ec285 | 415 | |
b2c19614 BV |
416 | return di; |
417 | } | |
418 | ||
04383ea8 GS |
419 | static void srd_inst_join_decode_thread(struct srd_decoder_inst *di) |
420 | { | |
421 | if (!di) | |
422 | return; | |
423 | if (!di->thread_handle) | |
424 | return; | |
425 | ||
426 | srd_dbg("%s: Joining decoder thread.", di->inst_id); | |
427 | ||
428 | /* | |
429 | * Terminate potentially running threads which still | |
430 | * execute the decoder instance's decode() method. | |
431 | */ | |
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); | |
437 | ||
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; | |
442 | ||
443 | /* | |
444 | * Reset condition and mutex variables, such that next | |
445 | * operations on them will find them in a clean state. | |
446 | */ | |
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); | |
453 | } | |
454 | ||
455 | static void srd_inst_reset_state(struct srd_decoder_inst *di) | |
456 | { | |
457 | if (!di) | |
458 | return; | |
459 | ||
460 | srd_dbg("%s: Resetting decoder state.", di->inst_id); | |
461 | ||
462 | /* | |
463 | * Reset internal state of the decoder. | |
464 | */ | |
465 | condition_list_free(di); | |
466 | match_array_free(di); | |
467 | di->abs_start_samplenum = 0; | |
468 | di->abs_end_samplenum = 0; | |
469 | di->inbuf = NULL; | |
470 | di->inbuflen = 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. */ | |
477 | } | |
478 | ||
582c8473 BV |
479 | /** |
480 | * Stack a decoder instance on top of another. | |
481 | * | |
32cfb920 | 482 | * @param sess The session holding the protocol decoder instances. |
4d2c7619 BV |
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. | |
582c8473 BV |
485 | * |
486 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 487 | * |
69075817 | 488 | * @since 0.3.0 |
582c8473 | 489 | */ |
32cfb920 | 490 | SRD_API int srd_inst_stack(struct srd_session *sess, |
4d2c7619 BV |
491 | struct srd_decoder_inst *di_bottom, |
492 | struct srd_decoder_inst *di_top) | |
7ce7775c | 493 | { |
32cfb920 BV |
494 | if (session_is_valid(sess) != SRD_OK) { |
495 | srd_err("Invalid session."); | |
496 | return SRD_ERR_ARG; | |
497 | } | |
498 | ||
4d2c7619 | 499 | if (!di_bottom || !di_top) { |
d906d3f9 | 500 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
501 | return SRD_ERR_ARG; |
502 | } | |
503 | ||
4d2c7619 | 504 | if (g_slist_find(sess->di_list, di_top)) { |
2072ae0c | 505 | /* Remove from the unstacked list. */ |
4d2c7619 | 506 | sess->di_list = g_slist_remove(sess->di_list, di_top); |
7ce7775c BV |
507 | } |
508 | ||
7ce7775c | 509 | /* Stack on top of source di. */ |
4d2c7619 BV |
510 | di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top); |
511 | ||
d841d5b2 | 512 | srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id); |
7ce7775c BV |
513 | |
514 | return SRD_OK; | |
515 | } | |
516 | ||
79d0013e KP |
517 | /** |
518 | * Search a decoder instance and its stack for instance ID. | |
519 | * | |
520 | * @param[in] inst_id ID to search for. | |
521 | * @param[in] stack A decoder instance, potentially with stacked instances. | |
522 | * | |
523 | * @return The matching instance, or NULL. | |
524 | */ | |
525 | static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id, | |
526 | struct srd_decoder_inst *stack) | |
527 | { | |
528 | const GSList *l; | |
529 | struct srd_decoder_inst *tmp, *di; | |
530 | ||
531 | if (!strcmp(stack->inst_id, inst_id)) | |
532 | return stack; | |
533 | ||
534 | /* Otherwise, look recursively in our stack. */ | |
535 | di = NULL; | |
536 | if (stack->next_di) { | |
537 | for (l = stack->next_di; l; l = l->next) { | |
538 | tmp = l->data; | |
539 | if (!strcmp(tmp->inst_id, inst_id)) { | |
540 | di = tmp; | |
541 | break; | |
542 | } | |
543 | } | |
544 | } | |
545 | ||
546 | return di; | |
547 | } | |
548 | ||
2072ae0c | 549 | /** |
361fdcaa UH |
550 | * Find a decoder instance by its instance ID. |
551 | * | |
79d0013e KP |
552 | * This will recurse to find the instance anywhere in the stack tree of the |
553 | * given session. | |
2072ae0c | 554 | * |
32cfb920 | 555 | * @param sess The session holding the protocol decoder instance. |
ed2306a6 | 556 | * @param inst_id The instance ID to be found. |
2072ae0c | 557 | * |
a8b72b05 | 558 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 | 559 | * |
69075817 | 560 | * @since 0.3.0 |
2072ae0c | 561 | */ |
32cfb920 BV |
562 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, |
563 | const char *inst_id) | |
7ce7775c BV |
564 | { |
565 | GSList *l; | |
a8b72b05 | 566 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 567 | |
32cfb920 BV |
568 | if (session_is_valid(sess) != SRD_OK) { |
569 | srd_err("Invalid session."); | |
570 | return NULL; | |
571 | } | |
572 | ||
7ce7775c | 573 | di = NULL; |
32cfb920 | 574 | for (l = sess->di_list; l; l = l->next) { |
7ce7775c | 575 | tmp = l->data; |
9bac00e0 | 576 | if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL) |
7ce7775c | 577 | break; |
7ce7775c BV |
578 | } |
579 | ||
580 | return di; | |
581 | } | |
582 | ||
32cfb920 BV |
583 | static struct srd_decoder_inst *srd_sess_inst_find_by_obj( |
584 | struct srd_session *sess, const GSList *stack, | |
585 | const PyObject *obj) | |
586 | { | |
587 | const GSList *l; | |
588 | struct srd_decoder_inst *tmp, *di; | |
589 | ||
590 | if (session_is_valid(sess) != SRD_OK) { | |
591 | srd_err("Invalid session."); | |
592 | return NULL; | |
593 | } | |
594 | ||
595 | di = NULL; | |
596 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
597 | tmp = l->data; | |
598 | if (tmp->py_inst == obj) | |
599 | di = tmp; | |
600 | else if (tmp->next_di) | |
601 | di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); | |
602 | } | |
603 | ||
604 | return di; | |
605 | } | |
606 | ||
2072ae0c | 607 | /** |
361fdcaa UH |
608 | * Find a decoder instance by its Python object. |
609 | * | |
610 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
32cfb920 BV |
611 | * This will recurse to find the instance anywhere in the stack tree of all |
612 | * sessions. | |
2072ae0c | 613 | * |
361fdcaa UH |
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. | |
511e2123 | 617 | * @param obj The Python class instantiation. |
2072ae0c | 618 | * |
a8b72b05 | 619 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
57790bc8 UH |
620 | * |
621 | * @private | |
8c664ca2 UH |
622 | * |
623 | * @since 0.1.0 | |
2072ae0c | 624 | */ |
abeeed8b | 625 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
0ff2d191 | 626 | const PyObject *obj) |
2072ae0c | 627 | { |
32cfb920 BV |
628 | struct srd_decoder_inst *di; |
629 | struct srd_session *sess; | |
630 | GSList *l; | |
2072ae0c BV |
631 | |
632 | di = NULL; | |
32cfb920 BV |
633 | for (l = sessions; di == NULL && l != NULL; l = l->next) { |
634 | sess = l->data; | |
635 | di = srd_sess_inst_find_by_obj(sess, stack, obj); | |
2072ae0c BV |
636 | } |
637 | ||
638 | return di; | |
639 | } | |
640 | ||
21dfd91d UH |
641 | /** |
642 | * Set the list of initial (assumed) pin values. | |
643 | * | |
21dfd91d | 644 | * @param di Decoder instance to use. Must not be NULL. |
97b874bd | 645 | * @param initial_pins A GArray of uint8_t values. Must not be NULL. |
21dfd91d | 646 | * |
97b874bd | 647 | * @since 0.5.0 |
21dfd91d | 648 | */ |
97b874bd | 649 | SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *initial_pins) |
21dfd91d UH |
650 | { |
651 | int i; | |
652 | GString *s; | |
21dfd91d | 653 | |
97b874bd | 654 | if (!di) { |
21dfd91d | 655 | srd_err("Invalid decoder instance."); |
97b874bd | 656 | return SRD_ERR_ARG; |
21dfd91d UH |
657 | } |
658 | ||
97b874bd UH |
659 | if (!initial_pins) |
660 | return SRD_ERR_ARG; | |
21dfd91d | 661 | |
97b874bd UH |
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); | |
665 | return SRD_ERR_ARG; | |
21dfd91d UH |
666 | } |
667 | ||
97b874bd UH |
668 | /* Sanity-check initial pin state values. */ |
669 | for (i = 0; i < di->dec_num_channels; i++) { | |
670 | if (initial_pins->data[i] <= 2) | |
671 | continue; | |
672 | srd_err("Invalid initial channel %d pin state: %d.", | |
673 | i, initial_pins->data[i]); | |
674 | return SRD_ERR_ARG; | |
675 | } | |
21dfd91d | 676 | |
21dfd91d | 677 | s = g_string_sized_new(100); |
63bbdb44 | 678 | oldpins_array_seed(di); |
21dfd91d | 679 | for (i = 0; i < di->dec_num_channels; i++) { |
97b874bd | 680 | di->old_pins_array->data[i] = initial_pins->data[i]; |
21dfd91d UH |
681 | g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]); |
682 | } | |
683 | s = g_string_truncate(s, s->len - 2); | |
684 | srd_dbg("Initial pins: %s.", s->str); | |
685 | g_string_free(s, TRUE); | |
97b874bd UH |
686 | |
687 | return SRD_OK; | |
21dfd91d UH |
688 | } |
689 | ||
63bbdb44 GS |
690 | /** @private */ |
691 | SRD_PRIV void oldpins_array_seed(struct srd_decoder_inst *di) | |
692 | { | |
693 | size_t count; | |
694 | GArray *arr; | |
695 | ||
696 | if (!di) | |
697 | return; | |
698 | if (di->old_pins_array) | |
699 | return; | |
700 | ||
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; | |
707 | } | |
708 | ||
c947ab01 | 709 | /** @private */ |
04383ea8 GS |
710 | SRD_PRIV void oldpins_array_free(struct srd_decoder_inst *di) |
711 | { | |
712 | if (!di) | |
713 | return; | |
714 | if (!di->old_pins_array) | |
715 | return; | |
716 | ||
717 | srd_dbg("%s: Releasing initial pin state.", di->inst_id); | |
718 | ||
719 | g_array_free(di->old_pins_array, TRUE); | |
720 | di->old_pins_array = NULL; | |
721 | } | |
722 | ||
57790bc8 | 723 | /** @private */ |
ed416497 | 724 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) |
b2c19614 | 725 | { |
ed416497 | 726 | PyObject *py_res; |
2072ae0c | 727 | GSList *l; |
a8b72b05 | 728 | struct srd_decoder_inst *next_di; |
ed416497 | 729 | int ret; |
514b2edc | 730 | PyGILState_STATE gstate; |
b2c19614 | 731 | |
7a1712c4 | 732 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
ed416497 | 733 | di->inst_id); |
b2c19614 | 734 | |
514b2edc UH |
735 | gstate = PyGILState_Ensure(); |
736 | ||
21dfd91d | 737 | /* Run self.start(). */ |
ed416497 | 738 | if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { |
201a85a8 | 739 | srd_exception_catch("Protocol decoder instance %s", |
ed416497 | 740 | di->inst_id); |
514b2edc | 741 | PyGILState_Release(gstate); |
7ce7775c BV |
742 | return SRD_ERR_PYTHON; |
743 | } | |
f38ec285 | 744 | Py_DecRef(py_res); |
7ce7775c | 745 | |
21dfd91d UH |
746 | /* Set self.samplenum to 0. */ |
747 | PyObject_SetAttrString(di->py_inst, "samplenum", PyLong_FromLong(0)); | |
748 | ||
e27d3e67 GS |
749 | /* Set self.matched to None. */ |
750 | PyObject_SetAttrString(di->py_inst, "matched", Py_None); | |
21dfd91d | 751 | |
514b2edc UH |
752 | PyGILState_Release(gstate); |
753 | ||
ed416497 | 754 | /* Start all the PDs stacked on top of this one. */ |
2072ae0c BV |
755 | for (l = di->next_di; l; l = l->next) { |
756 | next_di = l->data; | |
ed416497 BV |
757 | if ((ret = srd_inst_start(next_di)) != SRD_OK) |
758 | return ret; | |
2072ae0c BV |
759 | } |
760 | ||
b2c19614 BV |
761 | return SRD_OK; |
762 | } | |
763 | ||
21dfd91d UH |
764 | /** |
765 | * Check whether the specified sample matches the specified term. | |
766 | * | |
767 | * In the case of SRD_TERM_SKIP, this function can modify | |
768 | * term->num_samples_already_skipped. | |
769 | * | |
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. | |
773 | * | |
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. | |
777 | * | |
778 | * @private | |
779 | */ | |
780 | static gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term) | |
781 | { | |
7a57c594 | 782 | /* Caller ensures term != NULL. */ |
21dfd91d UH |
783 | |
784 | switch (term->type) { | |
785 | case SRD_TERM_HIGH: | |
786 | if (sample == 1) | |
787 | return TRUE; | |
788 | break; | |
789 | case SRD_TERM_LOW: | |
790 | if (sample == 0) | |
791 | return TRUE; | |
792 | break; | |
793 | case SRD_TERM_RISING_EDGE: | |
794 | if (old_sample == 0 && sample == 1) | |
795 | return TRUE; | |
796 | break; | |
797 | case SRD_TERM_FALLING_EDGE: | |
798 | if (old_sample == 1 && sample == 0) | |
799 | return TRUE; | |
800 | break; | |
801 | case SRD_TERM_EITHER_EDGE: | |
802 | if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1)) | |
803 | return TRUE; | |
804 | break; | |
805 | case SRD_TERM_NO_EDGE: | |
806 | if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1)) | |
807 | return TRUE; | |
808 | break; | |
809 | case SRD_TERM_SKIP: | |
810 | if (term->num_samples_already_skipped == term->num_samples_to_skip) | |
811 | return TRUE; | |
812 | term->num_samples_already_skipped++; | |
813 | break; | |
814 | default: | |
815 | srd_err("Unknown term type %d.", term->type); | |
816 | break; | |
817 | } | |
818 | ||
819 | return FALSE; | |
820 | } | |
821 | ||
c947ab01 | 822 | /** @private */ |
21dfd91d UH |
823 | SRD_PRIV void match_array_free(struct srd_decoder_inst *di) |
824 | { | |
825 | if (!di || !di->match_array) | |
826 | return; | |
827 | ||
828 | g_array_free(di->match_array, TRUE); | |
829 | di->match_array = NULL; | |
830 | } | |
831 | ||
c947ab01 | 832 | /** @private */ |
21dfd91d UH |
833 | SRD_PRIV void condition_list_free(struct srd_decoder_inst *di) |
834 | { | |
835 | GSList *l, *ll; | |
836 | ||
837 | if (!di) | |
838 | return; | |
839 | ||
840 | for (l = di->condition_list; l; l = l->next) { | |
841 | ll = l->data; | |
842 | if (ll) | |
843 | g_slist_free_full(ll, g_free); | |
844 | } | |
845 | ||
846 | di->condition_list = NULL; | |
847 | } | |
848 | ||
849 | static gboolean have_non_null_conds(const struct srd_decoder_inst *di) | |
850 | { | |
851 | GSList *l, *cond; | |
852 | ||
853 | if (!di) | |
854 | return FALSE; | |
855 | ||
856 | for (l = di->condition_list; l; l = l->next) { | |
857 | cond = l->data; | |
858 | if (cond) | |
859 | return TRUE; | |
860 | } | |
861 | ||
862 | return FALSE; | |
863 | } | |
864 | ||
865 | static void update_old_pins_array(struct srd_decoder_inst *di, | |
866 | const uint8_t *sample_pos) | |
867 | { | |
868 | uint8_t sample; | |
869 | int i, byte_offset, bit_offset; | |
870 | ||
871 | if (!di || !di->dec_channelmap || !sample_pos) | |
872 | return; | |
873 | ||
63bbdb44 | 874 | oldpins_array_seed(di); |
21dfd91d UH |
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; | |
880 | } | |
881 | } | |
882 | ||
97b874bd UH |
883 | static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di) |
884 | { | |
885 | uint8_t sample; | |
886 | int i, byte_offset, bit_offset; | |
887 | const uint8_t *sample_pos; | |
888 | ||
889 | if (!di || !di->dec_channelmap) | |
890 | return; | |
891 | ||
892 | sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize); | |
893 | ||
63bbdb44 | 894 | oldpins_array_seed(di); |
97b874bd UH |
895 | for (i = 0; i < di->dec_num_channels; i++) { |
896 | if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0) | |
897 | continue; | |
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; | |
902 | } | |
903 | } | |
904 | ||
21dfd91d UH |
905 | static gboolean term_matches(const struct srd_decoder_inst *di, |
906 | struct srd_term *term, const uint8_t *sample_pos) | |
907 | { | |
908 | uint8_t old_sample, sample; | |
909 | int byte_offset, bit_offset, ch; | |
910 | ||
7a57c594 | 911 | /* Caller ensures di, di->dec_channelmap, term, sample_pos != NULL. */ |
21dfd91d | 912 | |
7a57c594 UH |
913 | if (term->type == SRD_TERM_SKIP) |
914 | return sample_matches(0, 0, term); | |
21dfd91d | 915 | |
7a57c594 UH |
916 | ch = term->channel; |
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]; | |
21dfd91d UH |
921 | |
922 | return sample_matches(old_sample, sample, term); | |
923 | } | |
924 | ||
925 | static gboolean all_terms_match(const struct srd_decoder_inst *di, | |
926 | const GSList *cond, const uint8_t *sample_pos) | |
927 | { | |
928 | const GSList *l; | |
929 | struct srd_term *term; | |
930 | ||
7a57c594 | 931 | /* Caller ensures di, cond, sample_pos != NULL. */ |
21dfd91d UH |
932 | |
933 | for (l = cond; l; l = l->next) { | |
934 | term = l->data; | |
935 | if (!term_matches(di, term, sample_pos)) | |
936 | return FALSE; | |
937 | } | |
938 | ||
939 | return TRUE; | |
940 | } | |
941 | ||
942 | static gboolean at_least_one_condition_matched( | |
943 | const struct srd_decoder_inst *di, unsigned int num_conditions) | |
944 | { | |
945 | unsigned int i; | |
946 | ||
7a57c594 | 947 | /* Caller ensures di != NULL. */ |
21dfd91d UH |
948 | |
949 | for (i = 0; i < num_conditions; i++) { | |
950 | if (di->match_array->data[i]) | |
951 | return TRUE; | |
952 | } | |
953 | ||
954 | return FALSE; | |
955 | } | |
956 | ||
957 | static gboolean find_match(struct srd_decoder_inst *di) | |
958 | { | |
21dfd91d UH |
959 | uint64_t i, j, num_samples_to_process; |
960 | GSList *l, *cond; | |
961 | const uint8_t *sample_pos; | |
962 | unsigned int num_conditions; | |
963 | ||
7a57c594 UH |
964 | /* Caller ensures di != NULL. */ |
965 | ||
21dfd91d UH |
966 | /* Check whether the condition list is NULL/empty. */ |
967 | if (!di->condition_list) { | |
968 | srd_dbg("NULL/empty condition list, automatic match."); | |
969 | return TRUE; | |
970 | } | |
971 | ||
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."); | |
975 | return TRUE; | |
976 | } | |
977 | ||
4564e8e5 | 978 | num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum; |
21dfd91d UH |
979 | num_conditions = g_slist_length(di->condition_list); |
980 | ||
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); | |
984 | ||
97b874bd UH |
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); | |
988 | ||
a026a3fb | 989 | for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) { |
21dfd91d | 990 | |
4564e8e5 | 991 | sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize); |
21dfd91d UH |
992 | |
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++) { | |
996 | cond = l->data; | |
997 | if (!cond) | |
998 | continue; | |
999 | /* All terms in 'cond' must match (logical AND). */ | |
1000 | di->match_array->data[j] = all_terms_match(di, cond, sample_pos); | |
1001 | } | |
1002 | ||
1003 | update_old_pins_array(di, sample_pos); | |
1004 | ||
1005 | /* If at least one condition matched we're done. */ | |
1006 | if (at_least_one_condition_matched(di, num_conditions)) | |
1007 | return TRUE; | |
1008 | } | |
1009 | ||
1010 | return FALSE; | |
1011 | } | |
1012 | ||
1013 | /** | |
1014 | * Process available samples and check if they match the defined conditions. | |
1015 | * | |
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). | |
04383ea8 GS |
1018 | * This function immediately terminates when the decoder's wait() method |
1019 | * invocation shall get terminated. | |
21dfd91d UH |
1020 | * |
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. | |
1024 | * | |
1025 | * @retval SRD_OK No errors occured, see found_match for the result. | |
1026 | * @retval SRD_ERR_ARG Invalid arguments. | |
1027 | * | |
1028 | * @private | |
1029 | */ | |
1030 | SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match) | |
1031 | { | |
1032 | if (!di || !found_match) | |
1033 | return SRD_ERR_ARG; | |
1034 | ||
04383ea8 GS |
1035 | *found_match = FALSE; |
1036 | if (di->want_wait_terminate) | |
1037 | return SRD_OK; | |
1038 | ||
21dfd91d UH |
1039 | /* Check if any of the current condition(s) match. */ |
1040 | while (TRUE) { | |
1041 | /* Feed the (next chunk of the) buffer to find_match(). */ | |
1042 | *found_match = find_match(di); | |
1043 | ||
1044 | /* Did we handle all samples yet? */ | |
4564e8e5 UH |
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); | |
21dfd91d UH |
1049 | return SRD_OK; |
1050 | } | |
1051 | ||
1052 | /* If we didn't find a match, continue looking. */ | |
1053 | if (!(*found_match)) | |
1054 | continue; | |
1055 | ||
1056 | /* At least one condition matched, return. */ | |
1057 | return SRD_OK; | |
1058 | } | |
1059 | ||
1060 | return SRD_OK; | |
1061 | } | |
1062 | ||
1063 | /** | |
1064 | * Worker thread (per PD-stack). | |
1065 | * | |
1066 | * @param data Pointer to the lowest-level PD's device instance. | |
1067 | * Must not be NULL. | |
1068 | * | |
1069 | * @return NULL if there was an error. | |
1070 | */ | |
1071 | static gpointer di_thread(gpointer data) | |
1072 | { | |
1073 | PyObject *py_res; | |
1074 | struct srd_decoder_inst *di; | |
04383ea8 | 1075 | int wanted_term; |
514b2edc | 1076 | PyGILState_STATE gstate; |
21dfd91d UH |
1077 | |
1078 | if (!data) | |
1079 | return NULL; | |
1080 | ||
1081 | di = data; | |
1082 | ||
04383ea8 GS |
1083 | srd_dbg("%s: Starting thread routine for decoder.", di->inst_id); |
1084 | ||
514b2edc UH |
1085 | gstate = PyGILState_Ensure(); |
1086 | ||
04383ea8 GS |
1087 | /* |
1088 | * Call self.decode(). Only returns if the PD throws an exception. | |
1089 | * "Regular" termination of the decode() method is not expected. | |
1090 | */ | |
21dfd91d | 1091 | Py_IncRef(di->py_inst); |
04383ea8 GS |
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); | |
1095 | ||
1096 | /* | |
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. | |
1102 | */ | |
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); | |
1109 | ||
1110 | /* | |
1111 | * Check for the termination cause of the decode() method. | |
1112 | * Though this is mostly for information. | |
1113 | */ | |
1114 | if (!py_res && wanted_term) { | |
1115 | /* | |
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. | |
1119 | */ | |
1120 | srd_dbg("%s: Thread done (!res, want_term).", di->inst_id); | |
1121 | PyErr_Clear(); | |
514b2edc | 1122 | PyGILState_Release(gstate); |
04383ea8 GS |
1123 | return NULL; |
1124 | } | |
1125 | if (!py_res) { | |
1126 | /* | |
1127 | * The decode() invocation terminated unexpectedly. Have | |
1128 | * the back trace printed, and terminate the thread which | |
1129 | * executed the decode() method. | |
1130 | */ | |
1131 | srd_dbg("%s: decode() terminated unrequested.", di->inst_id); | |
21dfd91d | 1132 | srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); |
04383ea8 | 1133 | srd_dbg("%s: Thread done (!res, !want_term).", di->inst_id); |
514b2edc | 1134 | PyGILState_Release(gstate); |
21dfd91d UH |
1135 | return NULL; |
1136 | } | |
04383ea8 GS |
1137 | |
1138 | /* | |
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. | |
1142 | */ | |
1143 | srd_dbg("%s: decode() terminated (req %d).", di->inst_id, wanted_term); | |
21dfd91d | 1144 | Py_DecRef(py_res); |
04383ea8 GS |
1145 | PyErr_Clear(); |
1146 | ||
514b2edc UH |
1147 | PyGILState_Release(gstate); |
1148 | ||
04383ea8 | 1149 | srd_dbg("%s: Thread done (with res).", di->inst_id); |
21dfd91d UH |
1150 | |
1151 | return NULL; | |
1152 | } | |
1153 | ||
b2c19614 | 1154 | /** |
e959f49a | 1155 | * Decode a chunk of samples. |
b2c19614 | 1156 | * |
4564e8e5 UH |
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). | |
1162 | * | |
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'. | |
1166 | * | |
1167 | * Correct example (4096 samples total, 4 chunks @ 1024 samples each): | |
2f7bc9d2 MC |
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); | |
4564e8e5 UH |
1172 | * |
1173 | * The chunk size ('inbuflen') can be arbitrary and can differ between calls. | |
1174 | * | |
1175 | * Correct example (4096 samples total, 7 chunks @ various samples each): | |
2f7bc9d2 MC |
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); | |
4564e8e5 UH |
1183 | * |
1184 | * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but | |
1185 | * the start- and end-samplenumbers are not absolute): | |
2f7bc9d2 MC |
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); | |
4564e8e5 | 1190 | * |
ed416497 | 1191 | * @param di The decoder instance to call. Must not be NULL. |
4564e8e5 UH |
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. | |
7a1712c4 UH |
1196 | * @param inbuf The buffer to decode. Must not be NULL. |
1197 | * @param inbuflen Length of the buffer. Must be > 0. | |
e959f49a | 1198 | * @param unitsize The number of bytes per sample. Must be > 0. |
b2c19614 BV |
1199 | * |
1200 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
1201 | * |
1202 | * @private | |
b2c19614 | 1203 | */ |
21dfd91d | 1204 | SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di, |
4564e8e5 | 1205 | uint64_t abs_start_samplenum, uint64_t abs_end_samplenum, |
cda2d36c | 1206 | const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize) |
b2c19614 | 1207 | { |
d906d3f9 | 1208 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
1209 | if (!di) { |
1210 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
1211 | return SRD_ERR_ARG; |
1212 | } | |
7a1712c4 UH |
1213 | if (!inbuf) { |
1214 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
1215 | return SRD_ERR_ARG; |
1216 | } | |
1217 | if (inbuflen == 0) { | |
7a1712c4 | 1218 | srd_dbg("empty buffer"); |
d906d3f9 | 1219 | return SRD_ERR_ARG; |
80f8083b UH |
1220 | } |
1221 | if (unitsize == 0) { | |
1222 | srd_dbg("unitsize 0"); | |
1223 | return SRD_ERR_ARG; | |
d906d3f9 | 1224 | } |
b2c19614 | 1225 | |
de23c992 MC |
1226 | if (abs_start_samplenum != di->abs_cur_samplenum || |
1227 | abs_end_samplenum < abs_start_samplenum) { | |
f98f4171 UH |
1228 | srd_dbg("Incorrect sample numbers: start=%" PRIu64 ", cur=%" |
1229 | PRIu64 ", end=%" PRIu64 ".", abs_start_samplenum, | |
1230 | di->abs_cur_samplenum, abs_end_samplenum); | |
de23c992 MC |
1231 | return SRD_ERR_ARG; |
1232 | } | |
1233 | ||
21dfd91d | 1234 | di->data_unitsize = unitsize; |
2730fe23 | 1235 | |
4564e8e5 | 1236 | srd_dbg("Decoding: abs start sample %" PRIu64 ", abs end sample %" |
2730fe23 | 1237 | PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = " |
4564e8e5 UH |
1238 | "%d), instance %s.", abs_start_samplenum, abs_end_samplenum, |
1239 | abs_end_samplenum - abs_start_samplenum, inbuflen, di->data_unitsize, | |
2730fe23 UH |
1240 | di->inst_id); |
1241 | ||
eb883723 UH |
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, | |
1247 | di_thread, di); | |
1248 | } | |
04867deb | 1249 | |
eb883723 UH |
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; | |
1254 | di->inbuf = inbuf; | |
1255 | di->inbuflen = inbuflen; | |
1256 | di->got_new_samples = TRUE; | |
1257 | di->handled_all_samples = FALSE; | |
1258 | di->want_wait_terminate = FALSE; | |
21dfd91d | 1259 | |
eb883723 UH |
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); | |
1263 | ||
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); | |
bc5f5a43 | 1269 | |
b2c19614 BV |
1270 | return SRD_OK; |
1271 | } | |
1272 | ||
57790bc8 | 1273 | /** @private */ |
12243c22 | 1274 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
1275 | { |
1276 | GSList *l; | |
1277 | struct srd_pd_output *pdo; | |
514b2edc | 1278 | PyGILState_STATE gstate; |
fa12a21e | 1279 | |
a8b72b05 | 1280 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 1281 | |
04383ea8 | 1282 | srd_inst_join_decode_thread(di); |
514b2edc | 1283 | |
04383ea8 GS |
1284 | srd_inst_reset_state(di); |
1285 | ||
514b2edc | 1286 | gstate = PyGILState_Ensure(); |
a8b72b05 | 1287 | Py_DecRef(di->py_inst); |
514b2edc UH |
1288 | PyGILState_Release(gstate); |
1289 | ||
a8b72b05 | 1290 | g_free(di->inst_id); |
6a15597a | 1291 | g_free(di->dec_channelmap); |
d2297b87 | 1292 | g_free(di->channel_samples); |
fa12a21e BV |
1293 | g_slist_free(di->next_di); |
1294 | for (l = di->pd_output; l; l = l->next) { | |
1295 | pdo = l->data; | |
1296 | g_free(pdo->proto_id); | |
1297 | g_free(pdo); | |
1298 | } | |
1299 | g_slist_free(di->pd_output); | |
e592ac89 | 1300 | g_free(di); |
fa12a21e BV |
1301 | } |
1302 | ||
57790bc8 | 1303 | /** @private */ |
3262ef02 | 1304 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess) |
fa12a21e | 1305 | { |
32cfb920 BV |
1306 | if (session_is_valid(sess) != SRD_OK) { |
1307 | srd_err("Invalid session."); | |
1308 | return; | |
1309 | } | |
1310 | ||
3262ef02 | 1311 | g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free); |
fa12a21e | 1312 | } |
b2c19614 | 1313 | |
4895418c | 1314 | /** @} */ |