]>
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 | |
57790bc8 UH |
33 | /** @endcond */ |
34 | ||
b2c19614 | 35 | /** |
190b71cf | 36 | * @file |
8c664ca2 | 37 | * |
190b71cf | 38 | * Decoder instance handling. |
b2c19614 | 39 | */ |
4895418c UH |
40 | |
41 | /** | |
42 | * @defgroup grp_instances Decoder instances | |
43 | * | |
44 | * Decoder instance handling. | |
45 | * | |
46 | * @{ | |
47 | */ | |
48 | ||
0dba8d30 UH |
49 | static void oldpins_array_seed(struct srd_decoder_inst *di) |
50 | { | |
51 | size_t count; | |
52 | GArray *arr; | |
53 | ||
54 | if (!di) | |
55 | return; | |
56 | if (di->old_pins_array) | |
57 | return; | |
58 | ||
59 | count = di->dec_num_channels; | |
60 | arr = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t), count); | |
61 | g_array_set_size(arr, count); | |
62 | memset(arr->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0, count); | |
63 | di->old_pins_array = arr; | |
64 | } | |
65 | ||
66 | static void oldpins_array_free(struct srd_decoder_inst *di) | |
67 | { | |
68 | if (!di) | |
69 | return; | |
70 | if (!di->old_pins_array) | |
71 | return; | |
72 | ||
73 | srd_dbg("%s: Releasing initial pin state.", di->inst_id); | |
74 | ||
75 | g_array_free(di->old_pins_array, TRUE); | |
76 | di->old_pins_array = NULL; | |
77 | } | |
78 | ||
7ce7775c | 79 | /** |
b33b8aa5 | 80 | * Set one or more options in a decoder instance. |
0bdadba2 | 81 | * |
361fdcaa UH |
82 | * Handled options are removed from the hash. |
83 | * | |
0bdadba2 BV |
84 | * @param di Decoder instance. |
85 | * @param options A GHashTable of options to set. | |
7ce7775c | 86 | * |
0bdadba2 | 87 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 UH |
88 | * |
89 | * @since 0.1.0 | |
0bdadba2 | 90 | */ |
b33b8aa5 | 91 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 92 | GHashTable *options) |
0bdadba2 | 93 | { |
d841d5b2 | 94 | struct srd_decoder_option *sdo; |
84c1c0b5 | 95 | PyObject *py_di_options, *py_optval; |
2f395bff | 96 | GVariant *value; |
d841d5b2 UH |
97 | GSList *l; |
98 | double val_double; | |
2f395bff | 99 | gint64 val_int; |
84c1c0b5 | 100 | int ret; |
2f395bff | 101 | const char *val_str; |
514b2edc | 102 | PyGILState_STATE gstate; |
0bdadba2 | 103 | |
3af0e345 UH |
104 | if (!di) { |
105 | srd_err("Invalid decoder instance."); | |
106 | return SRD_ERR_ARG; | |
107 | } | |
108 | ||
109 | if (!options) { | |
110 | srd_err("Invalid options GHashTable."); | |
111 | return SRD_ERR_ARG; | |
112 | } | |
113 | ||
514b2edc UH |
114 | gstate = PyGILState_Ensure(); |
115 | ||
c9bfccc6 | 116 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 117 | /* Decoder has no options. */ |
514b2edc | 118 | PyGILState_Release(gstate); |
e431d9cc BV |
119 | if (g_hash_table_size(options) == 0) { |
120 | /* No options provided. */ | |
121 | return SRD_OK; | |
122 | } else { | |
123 | srd_err("Protocol decoder has no options."); | |
124 | return SRD_ERR_ARG; | |
125 | } | |
0bdadba2 | 126 | return SRD_OK; |
e431d9cc | 127 | } |
0bdadba2 BV |
128 | |
129 | ret = SRD_ERR_PYTHON; | |
d841d5b2 | 130 | py_optval = NULL; |
119d6258 BV |
131 | |
132 | /* | |
84c1c0b5 | 133 | * The 'options' tuple is a class variable, but we need to |
119d6258 BV |
134 | * change it. Changing it directly will affect the entire class, |
135 | * so we need to create a new object for it, and populate that | |
136 | * instead. | |
137 | */ | |
a8b72b05 | 138 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 | 139 | goto err_out; |
119d6258 BV |
140 | Py_DECREF(py_di_options); |
141 | py_di_options = PyDict_New(); | |
142 | PyObject_SetAttrString(di->py_inst, "options", py_di_options); | |
e2768fbc | 143 | Py_DECREF(py_di_options); |
0bdadba2 | 144 | |
d841d5b2 UH |
145 | for (l = di->decoder->options; l; l = l->next) { |
146 | sdo = l->data; | |
147 | if ((value = g_hash_table_lookup(options, sdo->id))) { | |
148 | /* A value was supplied for this option. */ | |
149 | if (!g_variant_type_equal(g_variant_get_type(value), | |
bd6594c0 | 150 | g_variant_get_type(sdo->def))) { |
d841d5b2 UH |
151 | srd_err("Option '%s' should have the same type " |
152 | "as the default value.", sdo->id); | |
153 | goto err_out; | |
154 | } | |
155 | } else { | |
156 | /* Use default for this option. */ | |
157 | value = sdo->def; | |
158 | } | |
159 | if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { | |
160 | val_str = g_variant_get_string(value, NULL); | |
161 | if (!(py_optval = PyUnicode_FromString(val_str))) { | |
162 | /* Some UTF-8 encoding error. */ | |
163 | PyErr_Clear(); | |
164 | srd_err("Option '%s' requires a UTF-8 string value.", sdo->id); | |
165 | goto err_out; | |
166 | } | |
167 | } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { | |
168 | val_int = g_variant_get_int64(value); | |
169 | if (!(py_optval = PyLong_FromLong(val_int))) { | |
170 | /* ValueError Exception */ | |
171 | PyErr_Clear(); | |
172 | srd_err("Option '%s' has invalid integer value.", sdo->id); | |
173 | goto err_out; | |
174 | } | |
175 | } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) { | |
176 | val_double = g_variant_get_double(value); | |
177 | if (!(py_optval = PyFloat_FromDouble(val_double))) { | |
178 | /* ValueError Exception */ | |
179 | PyErr_Clear(); | |
180 | srd_err("Option '%s' has invalid float value.", | |
181 | sdo->id); | |
182 | goto err_out; | |
183 | } | |
184 | } | |
84c1c0b5 | 185 | if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1) |
0bdadba2 | 186 | goto err_out; |
d841d5b2 UH |
187 | /* Not harmful even if we used the default. */ |
188 | g_hash_table_remove(options, sdo->id); | |
189 | } | |
190 | if (g_hash_table_size(options) != 0) | |
191 | srd_warn("Unknown options specified for '%s'", di->inst_id); | |
0bdadba2 BV |
192 | |
193 | ret = SRD_OK; | |
194 | ||
195 | err_out: | |
84c1c0b5 | 196 | Py_XDECREF(py_optval); |
7fc7bde6 | 197 | if (PyErr_Occurred()) { |
201a85a8 | 198 | srd_exception_catch("Stray exception in srd_inst_option_set()"); |
7fc7bde6 BV |
199 | ret = SRD_ERR_PYTHON; |
200 | } | |
514b2edc | 201 | PyGILState_Release(gstate); |
0bdadba2 BV |
202 | |
203 | return ret; | |
204 | } | |
205 | ||
7969d803 | 206 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all(). */ |
6a15597a UH |
207 | static gint compare_channel_id(const struct srd_channel *pdch, |
208 | const char *channel_id) | |
f38ec285 | 209 | { |
6a15597a | 210 | return strcmp(pdch->id, channel_id); |
f38ec285 BV |
211 | } |
212 | ||
0bdadba2 | 213 | /** |
6a15597a | 214 | * Set all channels in a decoder instance. |
b33b8aa5 | 215 | * |
6a15597a UH |
216 | * This function sets _all_ channels for the specified decoder instance, i.e., |
217 | * it overwrites any channels that were already defined (if any). | |
0bdadba2 BV |
218 | * |
219 | * @param di Decoder instance. | |
6a15597a UH |
220 | * @param new_channels A GHashTable of channels to set. Key is channel name, |
221 | * value is the channel number. Samples passed to this | |
222 | * instance will be arranged in this order. | |
12243c22 | 223 | * |
0bdadba2 | 224 | * @return SRD_OK upon success, a (negative) error code otherwise. |
8c664ca2 | 225 | * |
cda2d36c | 226 | * @since 0.4.0 |
0bdadba2 | 227 | */ |
6a15597a | 228 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
cda2d36c | 229 | GHashTable *new_channels) |
0bdadba2 | 230 | { |
6a15597a | 231 | GVariant *channel_val; |
f38ec285 BV |
232 | GList *l; |
233 | GSList *sl; | |
6a15597a UH |
234 | struct srd_channel *pdch; |
235 | int *new_channelmap, new_channelnum, num_required_channels, i; | |
236 | char *channel_id; | |
0bdadba2 | 237 | |
cda2d36c UH |
238 | srd_dbg("Setting channels for instance %s with list of %d channels.", |
239 | di->inst_id, g_hash_table_size(new_channels)); | |
ce46beed | 240 | |
6a15597a UH |
241 | if (g_hash_table_size(new_channels) == 0) |
242 | /* No channels provided. */ | |
0bdadba2 BV |
243 | return SRD_OK; |
244 | ||
6a15597a UH |
245 | if (di->dec_num_channels == 0) { |
246 | /* Decoder has no channels. */ | |
247 | srd_err("Protocol decoder %s has no channels to define.", | |
c9bfccc6 | 248 | di->decoder->name); |
f38ec285 BV |
249 | return SRD_ERR_ARG; |
250 | } | |
0bdadba2 | 251 | |
8f14effc | 252 | new_channelmap = g_malloc0(sizeof(int) * di->dec_num_channels); |
0bdadba2 | 253 | |
38ff5046 | 254 | /* |
6a15597a UH |
255 | * For now, map all indexes to channel -1 (can be overridden later). |
256 | * This -1 is interpreted as an unspecified channel later. | |
38ff5046 | 257 | */ |
6a15597a UH |
258 | for (i = 0; i < di->dec_num_channels; i++) |
259 | new_channelmap[i] = -1; | |
260 | ||
261 | for (l = g_hash_table_get_keys(new_channels); l; l = l->next) { | |
262 | channel_id = l->data; | |
263 | channel_val = g_hash_table_lookup(new_channels, channel_id); | |
264 | if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) { | |
265 | /* Channel name was specified without a value. */ | |
266 | srd_err("No channel number was specified for %s.", | |
267 | channel_id); | |
268 | g_free(new_channelmap); | |
be873260 BV |
269 | return SRD_ERR_ARG; |
270 | } | |
6a15597a | 271 | new_channelnum = g_variant_get_int32(channel_val); |
6a15597a UH |
272 | if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id, |
273 | (GCompareFunc)compare_channel_id))) { | |
274 | /* Fall back on optional channels. */ | |
275 | if (!(sl = g_slist_find_custom(di->decoder->opt_channels, | |
d841d5b2 | 276 | channel_id, (GCompareFunc)compare_channel_id))) { |
6a15597a | 277 | srd_err("Protocol decoder %s has no channel " |
d841d5b2 | 278 | "'%s'.", di->decoder->name, channel_id); |
6a15597a | 279 | g_free(new_channelmap); |
f38ec285 BV |
280 | return SRD_ERR_ARG; |
281 | } | |
282 | } | |
6a15597a UH |
283 | pdch = sl->data; |
284 | new_channelmap[pdch->order] = new_channelnum; | |
5b2595b5 | 285 | srd_dbg("Setting channel mapping: %s (PD ch idx %d) = input data ch idx %d.", |
6a15597a | 286 | pdch->id, pdch->order, new_channelnum); |
38ff5046 UH |
287 | } |
288 | ||
6a15597a UH |
289 | srd_dbg("Final channel map:"); |
290 | num_required_channels = g_slist_length(di->decoder->channels); | |
291 | for (i = 0; i < di->dec_num_channels; i++) { | |
3389df7d UH |
292 | GSList *ll = g_slist_nth(di->decoder->channels, i); |
293 | if (!ll) | |
294 | ll = g_slist_nth(di->decoder->opt_channels, | |
5b2595b5 | 295 | i - num_required_channels); |
3389df7d | 296 | pdch = ll->data; |
5b2595b5 UH |
297 | srd_dbg(" - PD ch idx %d (%s) = input data ch idx %d (%s)", i, |
298 | pdch->id, new_channelmap[i], | |
d841d5b2 | 299 | (i < num_required_channels) ? "required" : "optional"); |
f38ec285 | 300 | } |
38ff5046 | 301 | |
6a15597a UH |
302 | /* Report an error if not all required channels were specified. */ |
303 | for (i = 0; i < num_required_channels; i++) { | |
304 | if (new_channelmap[i] != -1) | |
9bf7f71c | 305 | continue; |
6a15597a UH |
306 | pdch = g_slist_nth(di->decoder->channels, i)->data; |
307 | srd_err("Required channel '%s' (index %d) was not specified.", | |
308 | pdch->id, i); | |
25d35761 | 309 | g_free(new_channelmap); |
9bf7f71c UH |
310 | return SRD_ERR; |
311 | } | |
312 | ||
6a15597a UH |
313 | g_free(di->dec_channelmap); |
314 | di->dec_channelmap = new_channelmap; | |
0bdadba2 | 315 | |
f38ec285 | 316 | return SRD_OK; |
0bdadba2 BV |
317 | } |
318 | ||
319 | /** | |
320 | * Create a new protocol decoder instance. | |
7ce7775c | 321 | * |
32cfb920 | 322 | * @param sess The session holding the protocol decoder instance. |
4ccebbd3 | 323 | * Must not be NULL. |
38ff5046 | 324 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 325 | * @param options GHashtable of options which override the defaults set in |
38ff5046 | 326 | * the decoder class. May be NULL. |
12243c22 | 327 | * |
a8b72b05 | 328 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 329 | * NULL in case of failure. |
8c664ca2 | 330 | * |
69075817 | 331 | * @since 0.3.0 |
7ce7775c | 332 | */ |
32cfb920 BV |
333 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
334 | const char *decoder_id, GHashTable *options) | |
b2c19614 | 335 | { |
c9bfccc6 | 336 | int i; |
b2c19614 | 337 | struct srd_decoder *dec; |
a8b72b05 BV |
338 | struct srd_decoder_inst *di; |
339 | char *inst_id; | |
514b2edc | 340 | PyGILState_STATE gstate; |
b2c19614 | 341 | |
3262ef02 | 342 | i = 1; |
7ce7775c | 343 | |
4ccebbd3 | 344 | if (!sess) |
32cfb920 | 345 | return NULL; |
32cfb920 | 346 | |
9d122fd5 | 347 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 348 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 349 | return NULL; |
0bdadba2 | 350 | } |
b2c19614 | 351 | |
077fa8ac | 352 | di = g_malloc0(sizeof(struct srd_decoder_inst)); |
0bdadba2 | 353 | |
b2c19614 | 354 | di->decoder = dec; |
32cfb920 | 355 | di->sess = sess; |
3262ef02 | 356 | |
38ff5046 UH |
357 | if (options) { |
358 | inst_id = g_hash_table_lookup(options, "id"); | |
3262ef02 KP |
359 | if (inst_id) |
360 | di->inst_id = g_strdup(inst_id); | |
38ff5046 | 361 | g_hash_table_remove(options, "id"); |
3262ef02 KP |
362 | } |
363 | ||
364 | /* Create a unique instance ID (as none was provided). */ | |
365 | if (!di->inst_id) { | |
366 | di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++); | |
367 | while (srd_inst_find_by_id(sess, di->inst_id)) { | |
368 | g_free(di->inst_id); | |
369 | di->inst_id = g_strdup_printf("%s-%d", decoder_id, i++); | |
370 | } | |
371 | } | |
b2c19614 | 372 | |
361fdcaa | 373 | /* |
6a15597a | 374 | * Prepare a default channel map, where samples come in the |
f38ec285 BV |
375 | * order in which the decoder class defined them. |
376 | */ | |
6a15597a UH |
377 | di->dec_num_channels = g_slist_length(di->decoder->channels) + |
378 | g_slist_length(di->decoder->opt_channels); | |
379 | if (di->dec_num_channels) { | |
077fa8ac UH |
380 | di->dec_channelmap = |
381 | g_malloc(sizeof(int) * di->dec_num_channels); | |
6a15597a UH |
382 | for (i = 0; i < di->dec_num_channels; i++) |
383 | di->dec_channelmap[i] = i; | |
37b94c20 BV |
384 | /* |
385 | * Will be used to prepare a sample at every iteration | |
386 | * of the instance's decode() method. | |
387 | */ | |
077fa8ac | 388 | di->channel_samples = g_malloc(di->dec_num_channels); |
f38ec285 | 389 | } |
f38ec285 | 390 | |
97b874bd | 391 | /* Default to the initial pins being the same as in sample 0. */ |
63bbdb44 | 392 | oldpins_array_seed(di); |
97b874bd | 393 | |
514b2edc UH |
394 | gstate = PyGILState_Ensure(); |
395 | ||
0bdadba2 | 396 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 397 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 398 | if (PyErr_Occurred()) |
201a85a8 | 399 | srd_exception_catch("Failed to create %s instance", |
69075817 | 400 | decoder_id); |
514b2edc | 401 | PyGILState_Release(gstate); |
6a15597a | 402 | g_free(di->dec_channelmap); |
0bdadba2 | 403 | g_free(di); |
7ce7775c | 404 | return NULL; |
b2c19614 | 405 | } |
7ce7775c | 406 | |
514b2edc UH |
407 | PyGILState_Release(gstate); |
408 | ||
38ff5046 | 409 | if (options && srd_inst_option_set(di, options) != SRD_OK) { |
6a15597a | 410 | g_free(di->dec_channelmap); |
0bdadba2 BV |
411 | g_free(di); |
412 | return NULL; | |
413 | } | |
b2c19614 | 414 | |
21dfd91d UH |
415 | di->condition_list = NULL; |
416 | di->match_array = NULL; | |
4564e8e5 UH |
417 | di->abs_start_samplenum = 0; |
418 | di->abs_end_samplenum = 0; | |
21dfd91d UH |
419 | di->inbuf = NULL; |
420 | di->inbuflen = 0; | |
4564e8e5 | 421 | di->abs_cur_samplenum = 0; |
21dfd91d UH |
422 | di->thread_handle = NULL; |
423 | di->got_new_samples = FALSE; | |
424 | di->handled_all_samples = FALSE; | |
04383ea8 | 425 | di->want_wait_terminate = FALSE; |
d4d8ac2a | 426 | di->decoder_state = SRD_OK; |
04383ea8 GS |
427 | |
428 | /* | |
429 | * Strictly speaking initialization of statically allocated | |
430 | * condition and mutex variables (or variables allocated on the | |
431 | * stack) is not required, but won't harm either. Explicitly | |
432 | * running init() will better match subsequent clear() calls. | |
433 | */ | |
434 | g_cond_init(&di->got_new_samples_cond); | |
435 | g_cond_init(&di->handled_all_samples_cond); | |
436 | g_mutex_init(&di->data_mutex); | |
21dfd91d | 437 | |
f38ec285 | 438 | /* Instance takes input from a frontend by default. */ |
32cfb920 | 439 | sess->di_list = g_slist_append(sess->di_list, di); |
755e4a1e | 440 | srd_dbg("Creating new %s instance %s.", decoder_id, di->inst_id); |
f38ec285 | 441 | |
b2c19614 BV |
442 | return di; |
443 | } | |
444 | ||
04383ea8 GS |
445 | static void srd_inst_join_decode_thread(struct srd_decoder_inst *di) |
446 | { | |
447 | if (!di) | |
448 | return; | |
449 | if (!di->thread_handle) | |
450 | return; | |
451 | ||
452 | srd_dbg("%s: Joining decoder thread.", di->inst_id); | |
453 | ||
454 | /* | |
455 | * Terminate potentially running threads which still | |
456 | * execute the decoder instance's decode() method. | |
457 | */ | |
458 | srd_dbg("%s: Raising want_term, sending got_new.", di->inst_id); | |
459 | g_mutex_lock(&di->data_mutex); | |
460 | di->want_wait_terminate = TRUE; | |
461 | g_cond_signal(&di->got_new_samples_cond); | |
462 | g_mutex_unlock(&di->data_mutex); | |
463 | ||
464 | srd_dbg("%s: Running join().", di->inst_id); | |
465 | (void)g_thread_join(di->thread_handle); | |
466 | srd_dbg("%s: Call to join() done.", di->inst_id); | |
467 | di->thread_handle = NULL; | |
468 | ||
469 | /* | |
470 | * Reset condition and mutex variables, such that next | |
471 | * operations on them will find them in a clean state. | |
472 | */ | |
473 | g_cond_clear(&di->got_new_samples_cond); | |
474 | g_cond_init(&di->got_new_samples_cond); | |
475 | g_cond_clear(&di->handled_all_samples_cond); | |
476 | g_cond_init(&di->handled_all_samples_cond); | |
477 | g_mutex_clear(&di->data_mutex); | |
478 | g_mutex_init(&di->data_mutex); | |
479 | } | |
480 | ||
481 | static void srd_inst_reset_state(struct srd_decoder_inst *di) | |
482 | { | |
483 | if (!di) | |
484 | return; | |
485 | ||
486 | srd_dbg("%s: Resetting decoder state.", di->inst_id); | |
487 | ||
7969d803 | 488 | /* Reset internal state of the decoder. */ |
04383ea8 GS |
489 | condition_list_free(di); |
490 | match_array_free(di); | |
491 | di->abs_start_samplenum = 0; | |
492 | di->abs_end_samplenum = 0; | |
493 | di->inbuf = NULL; | |
494 | di->inbuflen = 0; | |
495 | di->abs_cur_samplenum = 0; | |
496 | oldpins_array_free(di); | |
497 | di->got_new_samples = FALSE; | |
498 | di->handled_all_samples = FALSE; | |
499 | di->want_wait_terminate = FALSE; | |
d4d8ac2a | 500 | di->decoder_state = SRD_OK; |
04383ea8 GS |
501 | /* Conditions and mutex got reset after joining the thread. */ |
502 | } | |
503 | ||
582c8473 BV |
504 | /** |
505 | * Stack a decoder instance on top of another. | |
506 | * | |
32cfb920 | 507 | * @param sess The session holding the protocol decoder instances. |
4ccebbd3 | 508 | * Must not be NULL. |
4d2c7619 BV |
509 | * @param di_bottom The instance on top of which di_top will be stacked. |
510 | * @param di_top The instance to go on top. | |
582c8473 BV |
511 | * |
512 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
8c664ca2 | 513 | * |
69075817 | 514 | * @since 0.3.0 |
582c8473 | 515 | */ |
32cfb920 | 516 | SRD_API int srd_inst_stack(struct srd_session *sess, |
4d2c7619 BV |
517 | struct srd_decoder_inst *di_bottom, |
518 | struct srd_decoder_inst *di_top) | |
7ce7775c | 519 | { |
4ccebbd3 | 520 | if (!sess) |
32cfb920 | 521 | return SRD_ERR_ARG; |
32cfb920 | 522 | |
4d2c7619 | 523 | if (!di_bottom || !di_top) { |
d906d3f9 | 524 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
525 | return SRD_ERR_ARG; |
526 | } | |
527 | ||
4d2c7619 | 528 | if (g_slist_find(sess->di_list, di_top)) { |
2072ae0c | 529 | /* Remove from the unstacked list. */ |
4d2c7619 | 530 | sess->di_list = g_slist_remove(sess->di_list, di_top); |
7ce7775c BV |
531 | } |
532 | ||
369e8265 UH |
533 | /* |
534 | * Check if there's at least one matching input/output pair | |
535 | * for the stacked PDs. We warn if that's not the case, but it's | |
536 | * not a hard error for the time being. | |
537 | */ | |
538 | gboolean at_least_one_match = FALSE; | |
539 | for (GSList *out = di_bottom->decoder->outputs; out; out = out->next) { | |
540 | const char *o = out->data; | |
541 | for (GSList *in = di_top->decoder->inputs; in; in = in->next) { | |
542 | const char *i = in->data; | |
543 | if (!strcmp(o, i)) { | |
544 | at_least_one_match = TRUE; | |
545 | break; | |
546 | } | |
547 | } | |
548 | } | |
549 | ||
550 | if (!at_least_one_match) | |
551 | srd_warn("No matching in-/output when stacking %s onto %s.", | |
552 | di_top->inst_id, di_bottom->inst_id); | |
553 | ||
7ce7775c | 554 | /* Stack on top of source di. */ |
4d2c7619 BV |
555 | di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top); |
556 | ||
755e4a1e | 557 | srd_dbg("Stacking %s onto %s.", di_top->inst_id, di_bottom->inst_id); |
7ce7775c BV |
558 | |
559 | return SRD_OK; | |
560 | } | |
561 | ||
79d0013e KP |
562 | /** |
563 | * Search a decoder instance and its stack for instance ID. | |
564 | * | |
565 | * @param[in] inst_id ID to search for. | |
566 | * @param[in] stack A decoder instance, potentially with stacked instances. | |
567 | * | |
568 | * @return The matching instance, or NULL. | |
569 | */ | |
570 | static struct srd_decoder_inst *srd_inst_find_by_id_stack(const char *inst_id, | |
571 | struct srd_decoder_inst *stack) | |
572 | { | |
573 | const GSList *l; | |
574 | struct srd_decoder_inst *tmp, *di; | |
575 | ||
576 | if (!strcmp(stack->inst_id, inst_id)) | |
577 | return stack; | |
578 | ||
579 | /* Otherwise, look recursively in our stack. */ | |
580 | di = NULL; | |
581 | if (stack->next_di) { | |
582 | for (l = stack->next_di; l; l = l->next) { | |
583 | tmp = l->data; | |
584 | if (!strcmp(tmp->inst_id, inst_id)) { | |
585 | di = tmp; | |
586 | break; | |
587 | } | |
588 | } | |
589 | } | |
590 | ||
591 | return di; | |
592 | } | |
593 | ||
2072ae0c | 594 | /** |
361fdcaa UH |
595 | * Find a decoder instance by its instance ID. |
596 | * | |
79d0013e KP |
597 | * This will recurse to find the instance anywhere in the stack tree of the |
598 | * given session. | |
2072ae0c | 599 | * |
32cfb920 | 600 | * @param sess The session holding the protocol decoder instance. |
4ccebbd3 | 601 | * Must not be NULL. |
ed2306a6 | 602 | * @param inst_id The instance ID to be found. |
2072ae0c | 603 | * |
a8b72b05 | 604 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
8c664ca2 | 605 | * |
69075817 | 606 | * @since 0.3.0 |
2072ae0c | 607 | */ |
32cfb920 BV |
608 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, |
609 | const char *inst_id) | |
7ce7775c BV |
610 | { |
611 | GSList *l; | |
a8b72b05 | 612 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 613 | |
4ccebbd3 | 614 | if (!sess) |
32cfb920 | 615 | return NULL; |
32cfb920 | 616 | |
7ce7775c | 617 | di = NULL; |
32cfb920 | 618 | for (l = sess->di_list; l; l = l->next) { |
7ce7775c | 619 | tmp = l->data; |
9bac00e0 | 620 | if ((di = srd_inst_find_by_id_stack(inst_id, tmp)) != NULL) |
7ce7775c | 621 | break; |
7ce7775c BV |
622 | } |
623 | ||
624 | return di; | |
625 | } | |
626 | ||
21dfd91d UH |
627 | /** |
628 | * Set the list of initial (assumed) pin values. | |
629 | * | |
21dfd91d | 630 | * @param di Decoder instance to use. Must not be NULL. |
97b874bd | 631 | * @param initial_pins A GArray of uint8_t values. Must not be NULL. |
21dfd91d | 632 | * |
97b874bd | 633 | * @since 0.5.0 |
21dfd91d | 634 | */ |
97b874bd | 635 | SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, GArray *initial_pins) |
21dfd91d UH |
636 | { |
637 | int i; | |
638 | GString *s; | |
21dfd91d | 639 | |
97b874bd | 640 | if (!di) { |
21dfd91d | 641 | srd_err("Invalid decoder instance."); |
97b874bd | 642 | return SRD_ERR_ARG; |
21dfd91d UH |
643 | } |
644 | ||
97b874bd UH |
645 | if (!initial_pins) |
646 | return SRD_ERR_ARG; | |
21dfd91d | 647 | |
97b874bd UH |
648 | if (initial_pins->len != (guint)di->dec_num_channels) { |
649 | srd_err("Incorrect number of channels (need %d, got %d).", | |
650 | di->dec_num_channels, initial_pins->len); | |
651 | return SRD_ERR_ARG; | |
21dfd91d UH |
652 | } |
653 | ||
97b874bd UH |
654 | /* Sanity-check initial pin state values. */ |
655 | for (i = 0; i < di->dec_num_channels; i++) { | |
656 | if (initial_pins->data[i] <= 2) | |
657 | continue; | |
658 | srd_err("Invalid initial channel %d pin state: %d.", | |
659 | i, initial_pins->data[i]); | |
660 | return SRD_ERR_ARG; | |
661 | } | |
21dfd91d | 662 | |
21dfd91d | 663 | s = g_string_sized_new(100); |
63bbdb44 | 664 | oldpins_array_seed(di); |
21dfd91d | 665 | for (i = 0; i < di->dec_num_channels; i++) { |
97b874bd | 666 | di->old_pins_array->data[i] = initial_pins->data[i]; |
21dfd91d UH |
667 | g_string_append_printf(s, "%d, ", di->old_pins_array->data[i]); |
668 | } | |
669 | s = g_string_truncate(s, s->len - 2); | |
670 | srd_dbg("Initial pins: %s.", s->str); | |
671 | g_string_free(s, TRUE); | |
97b874bd UH |
672 | |
673 | return SRD_OK; | |
21dfd91d UH |
674 | } |
675 | ||
57790bc8 | 676 | /** @private */ |
ed416497 | 677 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) |
b2c19614 | 678 | { |
e2768fbc | 679 | PyObject *py_res, *py_samplenum; |
2072ae0c | 680 | GSList *l; |
a8b72b05 | 681 | struct srd_decoder_inst *next_di; |
ed416497 | 682 | int ret; |
514b2edc | 683 | PyGILState_STATE gstate; |
b2c19614 | 684 | |
755e4a1e | 685 | srd_dbg("Calling start() of instance %s.", di->inst_id); |
b2c19614 | 686 | |
514b2edc UH |
687 | gstate = PyGILState_Ensure(); |
688 | ||
21dfd91d | 689 | /* Run self.start(). */ |
ed416497 | 690 | if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { |
201a85a8 | 691 | srd_exception_catch("Protocol decoder instance %s", |
ed416497 | 692 | di->inst_id); |
514b2edc | 693 | PyGILState_Release(gstate); |
7ce7775c BV |
694 | return SRD_ERR_PYTHON; |
695 | } | |
f38ec285 | 696 | Py_DecRef(py_res); |
7ce7775c | 697 | |
21dfd91d | 698 | /* Set self.samplenum to 0. */ |
e2768fbc UH |
699 | py_samplenum = PyLong_FromLong(0); |
700 | PyObject_SetAttrString(di->py_inst, "samplenum", py_samplenum); | |
701 | Py_DECREF(py_samplenum); | |
21dfd91d | 702 | |
e27d3e67 GS |
703 | /* Set self.matched to None. */ |
704 | PyObject_SetAttrString(di->py_inst, "matched", Py_None); | |
21dfd91d | 705 | |
514b2edc UH |
706 | PyGILState_Release(gstate); |
707 | ||
ed416497 | 708 | /* Start all the PDs stacked on top of this one. */ |
2072ae0c BV |
709 | for (l = di->next_di; l; l = l->next) { |
710 | next_di = l->data; | |
ed416497 BV |
711 | if ((ret = srd_inst_start(next_di)) != SRD_OK) |
712 | return ret; | |
2072ae0c BV |
713 | } |
714 | ||
b2c19614 BV |
715 | return SRD_OK; |
716 | } | |
717 | ||
21dfd91d UH |
718 | /** |
719 | * Check whether the specified sample matches the specified term. | |
720 | * | |
721 | * In the case of SRD_TERM_SKIP, this function can modify | |
722 | * term->num_samples_already_skipped. | |
723 | * | |
724 | * @param old_sample The value of the previous sample (0/1). | |
725 | * @param sample The value of the current sample (0/1). | |
726 | * @param term The term that should be checked for a match. Must not be NULL. | |
727 | * | |
728 | * @retval TRUE The current sample matches the specified term. | |
729 | * @retval FALSE The current sample doesn't match the specified term, or an | |
730 | * invalid term was provided. | |
731 | * | |
732 | * @private | |
733 | */ | |
9337ab8a UH |
734 | __attribute__((always_inline)) |
735 | static inline gboolean sample_matches(uint8_t old_sample, uint8_t sample, struct srd_term *term) | |
21dfd91d | 736 | { |
7a57c594 | 737 | /* Caller ensures term != NULL. */ |
21dfd91d UH |
738 | |
739 | switch (term->type) { | |
740 | case SRD_TERM_HIGH: | |
741 | if (sample == 1) | |
742 | return TRUE; | |
743 | break; | |
744 | case SRD_TERM_LOW: | |
745 | if (sample == 0) | |
746 | return TRUE; | |
747 | break; | |
748 | case SRD_TERM_RISING_EDGE: | |
749 | if (old_sample == 0 && sample == 1) | |
750 | return TRUE; | |
751 | break; | |
752 | case SRD_TERM_FALLING_EDGE: | |
753 | if (old_sample == 1 && sample == 0) | |
754 | return TRUE; | |
755 | break; | |
756 | case SRD_TERM_EITHER_EDGE: | |
757 | if ((old_sample == 1 && sample == 0) || (old_sample == 0 && sample == 1)) | |
758 | return TRUE; | |
759 | break; | |
760 | case SRD_TERM_NO_EDGE: | |
761 | if ((old_sample == 0 && sample == 0) || (old_sample == 1 && sample == 1)) | |
762 | return TRUE; | |
763 | break; | |
764 | case SRD_TERM_SKIP: | |
765 | if (term->num_samples_already_skipped == term->num_samples_to_skip) | |
766 | return TRUE; | |
767 | term->num_samples_already_skipped++; | |
768 | break; | |
769 | default: | |
770 | srd_err("Unknown term type %d.", term->type); | |
771 | break; | |
772 | } | |
773 | ||
774 | return FALSE; | |
775 | } | |
776 | ||
c947ab01 | 777 | /** @private */ |
21dfd91d UH |
778 | SRD_PRIV void match_array_free(struct srd_decoder_inst *di) |
779 | { | |
780 | if (!di || !di->match_array) | |
781 | return; | |
782 | ||
783 | g_array_free(di->match_array, TRUE); | |
784 | di->match_array = NULL; | |
785 | } | |
786 | ||
c947ab01 | 787 | /** @private */ |
21dfd91d UH |
788 | SRD_PRIV void condition_list_free(struct srd_decoder_inst *di) |
789 | { | |
790 | GSList *l, *ll; | |
791 | ||
792 | if (!di) | |
793 | return; | |
794 | ||
795 | for (l = di->condition_list; l; l = l->next) { | |
796 | ll = l->data; | |
797 | if (ll) | |
798 | g_slist_free_full(ll, g_free); | |
799 | } | |
800 | ||
8c5c361a | 801 | g_slist_free(di->condition_list); |
21dfd91d UH |
802 | di->condition_list = NULL; |
803 | } | |
804 | ||
805 | static gboolean have_non_null_conds(const struct srd_decoder_inst *di) | |
806 | { | |
807 | GSList *l, *cond; | |
808 | ||
809 | if (!di) | |
810 | return FALSE; | |
811 | ||
812 | for (l = di->condition_list; l; l = l->next) { | |
813 | cond = l->data; | |
814 | if (cond) | |
815 | return TRUE; | |
816 | } | |
817 | ||
818 | return FALSE; | |
819 | } | |
820 | ||
821 | static void update_old_pins_array(struct srd_decoder_inst *di, | |
822 | const uint8_t *sample_pos) | |
823 | { | |
824 | uint8_t sample; | |
825 | int i, byte_offset, bit_offset; | |
826 | ||
827 | if (!di || !di->dec_channelmap || !sample_pos) | |
828 | return; | |
829 | ||
63bbdb44 | 830 | oldpins_array_seed(di); |
21dfd91d UH |
831 | for (i = 0; i < di->dec_num_channels; i++) { |
832 | byte_offset = di->dec_channelmap[i] / 8; | |
833 | bit_offset = di->dec_channelmap[i] % 8; | |
834 | sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0; | |
835 | di->old_pins_array->data[i] = sample; | |
836 | } | |
837 | } | |
838 | ||
97b874bd UH |
839 | static void update_old_pins_array_initial_pins(struct srd_decoder_inst *di) |
840 | { | |
841 | uint8_t sample; | |
842 | int i, byte_offset, bit_offset; | |
843 | const uint8_t *sample_pos; | |
844 | ||
845 | if (!di || !di->dec_channelmap) | |
846 | return; | |
847 | ||
848 | sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize); | |
849 | ||
63bbdb44 | 850 | oldpins_array_seed(di); |
97b874bd UH |
851 | for (i = 0; i < di->dec_num_channels; i++) { |
852 | if (di->old_pins_array->data[i] != SRD_INITIAL_PIN_SAME_AS_SAMPLE0) | |
853 | continue; | |
854 | byte_offset = di->dec_channelmap[i] / 8; | |
855 | bit_offset = di->dec_channelmap[i] % 8; | |
856 | sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0; | |
857 | di->old_pins_array->data[i] = sample; | |
858 | } | |
859 | } | |
860 | ||
21dfd91d UH |
861 | static gboolean term_matches(const struct srd_decoder_inst *di, |
862 | struct srd_term *term, const uint8_t *sample_pos) | |
863 | { | |
864 | uint8_t old_sample, sample; | |
865 | int byte_offset, bit_offset, ch; | |
866 | ||
7a57c594 | 867 | /* Caller ensures di, di->dec_channelmap, term, sample_pos != NULL. */ |
21dfd91d | 868 | |
7a57c594 UH |
869 | if (term->type == SRD_TERM_SKIP) |
870 | return sample_matches(0, 0, term); | |
21dfd91d | 871 | |
7a57c594 UH |
872 | ch = term->channel; |
873 | byte_offset = di->dec_channelmap[ch] / 8; | |
874 | bit_offset = di->dec_channelmap[ch] % 8; | |
875 | sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0; | |
876 | old_sample = di->old_pins_array->data[ch]; | |
21dfd91d UH |
877 | |
878 | return sample_matches(old_sample, sample, term); | |
879 | } | |
880 | ||
881 | static gboolean all_terms_match(const struct srd_decoder_inst *di, | |
882 | const GSList *cond, const uint8_t *sample_pos) | |
883 | { | |
884 | const GSList *l; | |
885 | struct srd_term *term; | |
886 | ||
7a57c594 | 887 | /* Caller ensures di, cond, sample_pos != NULL. */ |
21dfd91d UH |
888 | |
889 | for (l = cond; l; l = l->next) { | |
890 | term = l->data; | |
891 | if (!term_matches(di, term, sample_pos)) | |
892 | return FALSE; | |
893 | } | |
894 | ||
895 | return TRUE; | |
896 | } | |
897 | ||
898 | static gboolean at_least_one_condition_matched( | |
899 | const struct srd_decoder_inst *di, unsigned int num_conditions) | |
900 | { | |
901 | unsigned int i; | |
902 | ||
7a57c594 | 903 | /* Caller ensures di != NULL. */ |
21dfd91d UH |
904 | |
905 | for (i = 0; i < num_conditions; i++) { | |
906 | if (di->match_array->data[i]) | |
907 | return TRUE; | |
908 | } | |
909 | ||
910 | return FALSE; | |
911 | } | |
912 | ||
913 | static gboolean find_match(struct srd_decoder_inst *di) | |
914 | { | |
21dfd91d UH |
915 | uint64_t i, j, num_samples_to_process; |
916 | GSList *l, *cond; | |
917 | const uint8_t *sample_pos; | |
918 | unsigned int num_conditions; | |
919 | ||
7a57c594 UH |
920 | /* Caller ensures di != NULL. */ |
921 | ||
21dfd91d UH |
922 | /* Check whether the condition list is NULL/empty. */ |
923 | if (!di->condition_list) { | |
924 | srd_dbg("NULL/empty condition list, automatic match."); | |
925 | return TRUE; | |
926 | } | |
927 | ||
928 | /* Check whether we have any non-NULL conditions. */ | |
929 | if (!have_non_null_conds(di)) { | |
930 | srd_dbg("Only NULL conditions in list, automatic match."); | |
931 | return TRUE; | |
932 | } | |
933 | ||
4564e8e5 | 934 | num_samples_to_process = di->abs_end_samplenum - di->abs_cur_samplenum; |
21dfd91d UH |
935 | num_conditions = g_slist_length(di->condition_list); |
936 | ||
937 | /* di->match_array is NULL here. Create a new GArray. */ | |
938 | di->match_array = g_array_sized_new(FALSE, TRUE, sizeof(gboolean), num_conditions); | |
939 | g_array_set_size(di->match_array, num_conditions); | |
940 | ||
97b874bd UH |
941 | /* Sample 0: Set di->old_pins_array for SRD_INITIAL_PIN_SAME_AS_SAMPLE0 pins. */ |
942 | if (di->abs_cur_samplenum == 0) | |
943 | update_old_pins_array_initial_pins(di); | |
944 | ||
a026a3fb | 945 | for (i = 0; i < num_samples_to_process; i++, (di->abs_cur_samplenum)++) { |
21dfd91d | 946 | |
4564e8e5 | 947 | sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize); |
21dfd91d UH |
948 | |
949 | /* Check whether the current sample matches at least one of the conditions (logical OR). */ | |
950 | /* IMPORTANT: We need to check all conditions, even if there was a match already! */ | |
951 | for (l = di->condition_list, j = 0; l; l = l->next, j++) { | |
952 | cond = l->data; | |
953 | if (!cond) | |
954 | continue; | |
955 | /* All terms in 'cond' must match (logical AND). */ | |
956 | di->match_array->data[j] = all_terms_match(di, cond, sample_pos); | |
957 | } | |
958 | ||
959 | update_old_pins_array(di, sample_pos); | |
960 | ||
961 | /* If at least one condition matched we're done. */ | |
962 | if (at_least_one_condition_matched(di, num_conditions)) | |
963 | return TRUE; | |
964 | } | |
965 | ||
966 | return FALSE; | |
967 | } | |
968 | ||
969 | /** | |
970 | * Process available samples and check if they match the defined conditions. | |
971 | * | |
972 | * This function returns if there is an error, or when a match is found, or | |
973 | * when all samples have been processed (whether a match was found or not). | |
04383ea8 GS |
974 | * This function immediately terminates when the decoder's wait() method |
975 | * invocation shall get terminated. | |
21dfd91d UH |
976 | * |
977 | * @param di The decoder instance to use. Must not be NULL. | |
978 | * @param found_match Will be set to TRUE if at least one condition matched, | |
979 | * FALSE otherwise. Must not be NULL. | |
980 | * | |
981 | * @retval SRD_OK No errors occured, see found_match for the result. | |
982 | * @retval SRD_ERR_ARG Invalid arguments. | |
983 | * | |
984 | * @private | |
985 | */ | |
986 | SRD_PRIV int process_samples_until_condition_match(struct srd_decoder_inst *di, gboolean *found_match) | |
987 | { | |
988 | if (!di || !found_match) | |
989 | return SRD_ERR_ARG; | |
990 | ||
04383ea8 GS |
991 | *found_match = FALSE; |
992 | if (di->want_wait_terminate) | |
993 | return SRD_OK; | |
994 | ||
21dfd91d UH |
995 | /* Check if any of the current condition(s) match. */ |
996 | while (TRUE) { | |
997 | /* Feed the (next chunk of the) buffer to find_match(). */ | |
998 | *found_match = find_match(di); | |
999 | ||
1000 | /* Did we handle all samples yet? */ | |
4564e8e5 UH |
1001 | if (di->abs_cur_samplenum >= di->abs_end_samplenum) { |
1002 | srd_dbg("Done, handled all samples (abs cur %" PRIu64 | |
1003 | " / abs end %" PRIu64 ").", | |
1004 | di->abs_cur_samplenum, di->abs_end_samplenum); | |
21dfd91d UH |
1005 | return SRD_OK; |
1006 | } | |
1007 | ||
1008 | /* If we didn't find a match, continue looking. */ | |
1009 | if (!(*found_match)) | |
1010 | continue; | |
1011 | ||
1012 | /* At least one condition matched, return. */ | |
1013 | return SRD_OK; | |
1014 | } | |
1015 | ||
1016 | return SRD_OK; | |
1017 | } | |
1018 | ||
1019 | /** | |
1020 | * Worker thread (per PD-stack). | |
1021 | * | |
1022 | * @param data Pointer to the lowest-level PD's device instance. | |
1023 | * Must not be NULL. | |
1024 | * | |
1025 | * @return NULL if there was an error. | |
1026 | */ | |
1027 | static gpointer di_thread(gpointer data) | |
1028 | { | |
1029 | PyObject *py_res; | |
1030 | struct srd_decoder_inst *di; | |
04383ea8 | 1031 | int wanted_term; |
514b2edc | 1032 | PyGILState_STATE gstate; |
21dfd91d UH |
1033 | |
1034 | if (!data) | |
1035 | return NULL; | |
1036 | ||
1037 | di = data; | |
1038 | ||
04383ea8 GS |
1039 | srd_dbg("%s: Starting thread routine for decoder.", di->inst_id); |
1040 | ||
514b2edc UH |
1041 | gstate = PyGILState_Ensure(); |
1042 | ||
04383ea8 GS |
1043 | /* |
1044 | * Call self.decode(). Only returns if the PD throws an exception. | |
1045 | * "Regular" termination of the decode() method is not expected. | |
1046 | */ | |
21dfd91d | 1047 | Py_IncRef(di->py_inst); |
755e4a1e | 1048 | srd_dbg("%s: Calling decode().", di->inst_id); |
04383ea8 | 1049 | py_res = PyObject_CallMethod(di->py_inst, "decode", NULL); |
755e4a1e | 1050 | srd_dbg("%s: decode() terminated.", di->inst_id); |
04383ea8 | 1051 | |
d4d8ac2a SA |
1052 | if (!py_res) |
1053 | di->decoder_state = SRD_ERR; | |
1054 | ||
04383ea8 GS |
1055 | /* |
1056 | * Make sure to unblock potentially pending srd_inst_decode() | |
1057 | * calls in application threads after the decode() method might | |
1058 | * have terminated, while it neither has processed sample data | |
1059 | * nor has terminated upon request. This happens e.g. when "need | |
1060 | * a samplerate to decode" exception is thrown. | |
1061 | */ | |
1062 | g_mutex_lock(&di->data_mutex); | |
1063 | wanted_term = di->want_wait_terminate; | |
1064 | di->want_wait_terminate = TRUE; | |
1065 | di->handled_all_samples = TRUE; | |
1066 | g_cond_signal(&di->handled_all_samples_cond); | |
1067 | g_mutex_unlock(&di->data_mutex); | |
1068 | ||
1069 | /* | |
1070 | * Check for the termination cause of the decode() method. | |
1071 | * Though this is mostly for information. | |
1072 | */ | |
1073 | if (!py_res && wanted_term) { | |
1074 | /* | |
1075 | * Silently ignore errors upon return from decode() calls | |
1076 | * when termination was requested. Terminate the thread | |
1077 | * which executed this instance's decode() logic. | |
1078 | */ | |
1079 | srd_dbg("%s: Thread done (!res, want_term).", di->inst_id); | |
1080 | PyErr_Clear(); | |
514b2edc | 1081 | PyGILState_Release(gstate); |
04383ea8 GS |
1082 | return NULL; |
1083 | } | |
1084 | if (!py_res) { | |
1085 | /* | |
1086 | * The decode() invocation terminated unexpectedly. Have | |
1087 | * the back trace printed, and terminate the thread which | |
1088 | * executed the decode() method. | |
1089 | */ | |
1090 | srd_dbg("%s: decode() terminated unrequested.", di->inst_id); | |
21dfd91d | 1091 | srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); |
04383ea8 | 1092 | srd_dbg("%s: Thread done (!res, !want_term).", di->inst_id); |
514b2edc | 1093 | PyGILState_Release(gstate); |
21dfd91d UH |
1094 | return NULL; |
1095 | } | |
04383ea8 GS |
1096 | |
1097 | /* | |
1098 | * TODO: By design the decode() method is not supposed to terminate. | |
1099 | * Nevertheless we have the thread joined, and srd backend calls to | |
1100 | * decode() will re-start another thread transparently. | |
1101 | */ | |
1102 | srd_dbg("%s: decode() terminated (req %d).", di->inst_id, wanted_term); | |
21dfd91d | 1103 | Py_DecRef(py_res); |
04383ea8 GS |
1104 | PyErr_Clear(); |
1105 | ||
514b2edc UH |
1106 | PyGILState_Release(gstate); |
1107 | ||
04383ea8 | 1108 | srd_dbg("%s: Thread done (with res).", di->inst_id); |
21dfd91d UH |
1109 | |
1110 | return NULL; | |
1111 | } | |
1112 | ||
b2c19614 | 1113 | /** |
e959f49a | 1114 | * Decode a chunk of samples. |
b2c19614 | 1115 | * |
4564e8e5 UH |
1116 | * The calls to this function must provide the samples that shall be |
1117 | * used by the protocol decoder | |
1118 | * - in the correct order ([...]5, 6, 4, 7, 8[...] is a bug), | |
1119 | * - starting from sample zero (2, 3, 4, 5, 6[...] is a bug), | |
1120 | * - consecutively, with no gaps (0, 1, 2, 4, 5[...] is a bug). | |
1121 | * | |
1122 | * The start- and end-sample numbers are absolute sample numbers (relative | |
1123 | * to the start of the whole capture/file/stream), i.e. they are not relative | |
1124 | * sample numbers within the chunk specified by 'inbuf' and 'inbuflen'. | |
1125 | * | |
1126 | * Correct example (4096 samples total, 4 chunks @ 1024 samples each): | |
2f7bc9d2 MC |
1127 | * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1); |
1128 | * srd_inst_decode(di, 1024, 2048, inbuf, 1024, 1); | |
1129 | * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1); | |
1130 | * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1); | |
4564e8e5 UH |
1131 | * |
1132 | * The chunk size ('inbuflen') can be arbitrary and can differ between calls. | |
1133 | * | |
1134 | * Correct example (4096 samples total, 7 chunks @ various samples each): | |
2f7bc9d2 MC |
1135 | * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1); |
1136 | * srd_inst_decode(di, 1024, 1124, inbuf, 100, 1); | |
1137 | * srd_inst_decode(di, 1124, 1424, inbuf, 300, 1); | |
1138 | * srd_inst_decode(di, 1424, 1643, inbuf, 219, 1); | |
1139 | * srd_inst_decode(di, 1643, 2048, inbuf, 405, 1); | |
1140 | * srd_inst_decode(di, 2048, 3072, inbuf, 1024, 1); | |
1141 | * srd_inst_decode(di, 3072, 4096, inbuf, 1024, 1); | |
4564e8e5 UH |
1142 | * |
1143 | * INCORRECT example (4096 samples total, 4 chunks @ 1024 samples each, but | |
1144 | * the start- and end-samplenumbers are not absolute): | |
2f7bc9d2 MC |
1145 | * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1); |
1146 | * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1); | |
1147 | * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1); | |
1148 | * srd_inst_decode(di, 0, 1024, inbuf, 1024, 1); | |
4564e8e5 | 1149 | * |
ed416497 | 1150 | * @param di The decoder instance to call. Must not be NULL. |
4564e8e5 UH |
1151 | * @param abs_start_samplenum The absolute starting sample number for the |
1152 | * buffer's sample set, relative to the start of capture. | |
1153 | * @param abs_end_samplenum The absolute ending sample number for the | |
1154 | * buffer's sample set, relative to the start of capture. | |
7a1712c4 UH |
1155 | * @param inbuf The buffer to decode. Must not be NULL. |
1156 | * @param inbuflen Length of the buffer. Must be > 0. | |
e959f49a | 1157 | * @param unitsize The number of bytes per sample. Must be > 0. |
b2c19614 BV |
1158 | * |
1159 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
57790bc8 UH |
1160 | * |
1161 | * @private | |
b2c19614 | 1162 | */ |
21dfd91d | 1163 | SRD_PRIV int srd_inst_decode(struct srd_decoder_inst *di, |
4564e8e5 | 1164 | uint64_t abs_start_samplenum, uint64_t abs_end_samplenum, |
cda2d36c | 1165 | const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize) |
b2c19614 | 1166 | { |
d906d3f9 | 1167 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
1168 | if (!di) { |
1169 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
1170 | return SRD_ERR_ARG; |
1171 | } | |
7a1712c4 UH |
1172 | if (!inbuf) { |
1173 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
1174 | return SRD_ERR_ARG; |
1175 | } | |
1176 | if (inbuflen == 0) { | |
7a1712c4 | 1177 | srd_dbg("empty buffer"); |
d906d3f9 | 1178 | return SRD_ERR_ARG; |
80f8083b UH |
1179 | } |
1180 | if (unitsize == 0) { | |
1181 | srd_dbg("unitsize 0"); | |
1182 | return SRD_ERR_ARG; | |
d906d3f9 | 1183 | } |
b2c19614 | 1184 | |
de23c992 MC |
1185 | if (abs_start_samplenum != di->abs_cur_samplenum || |
1186 | abs_end_samplenum < abs_start_samplenum) { | |
f98f4171 UH |
1187 | srd_dbg("Incorrect sample numbers: start=%" PRIu64 ", cur=%" |
1188 | PRIu64 ", end=%" PRIu64 ".", abs_start_samplenum, | |
1189 | di->abs_cur_samplenum, abs_end_samplenum); | |
de23c992 MC |
1190 | return SRD_ERR_ARG; |
1191 | } | |
1192 | ||
21dfd91d | 1193 | di->data_unitsize = unitsize; |
2730fe23 | 1194 | |
4564e8e5 | 1195 | srd_dbg("Decoding: abs start sample %" PRIu64 ", abs end sample %" |
2730fe23 | 1196 | PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = " |
4564e8e5 UH |
1197 | "%d), instance %s.", abs_start_samplenum, abs_end_samplenum, |
1198 | abs_end_samplenum - abs_start_samplenum, inbuflen, di->data_unitsize, | |
2730fe23 UH |
1199 | di->inst_id); |
1200 | ||
eb883723 UH |
1201 | /* If this is the first call, start the worker thread. */ |
1202 | if (!di->thread_handle) { | |
1203 | srd_dbg("No worker thread for this decoder stack " | |
1204 | "exists yet, creating one: %s.", di->inst_id); | |
1205 | di->thread_handle = g_thread_new(di->inst_id, | |
1206 | di_thread, di); | |
1207 | } | |
04867deb | 1208 | |
eb883723 UH |
1209 | /* Push the new sample chunk to the worker thread. */ |
1210 | g_mutex_lock(&di->data_mutex); | |
1211 | di->abs_start_samplenum = abs_start_samplenum; | |
1212 | di->abs_end_samplenum = abs_end_samplenum; | |
1213 | di->inbuf = inbuf; | |
1214 | di->inbuflen = inbuflen; | |
1215 | di->got_new_samples = TRUE; | |
1216 | di->handled_all_samples = FALSE; | |
21dfd91d | 1217 | |
eb883723 UH |
1218 | /* Signal the thread that we have new data. */ |
1219 | g_cond_signal(&di->got_new_samples_cond); | |
1220 | g_mutex_unlock(&di->data_mutex); | |
1221 | ||
1222 | /* When all samples in this chunk were handled, return. */ | |
1223 | g_mutex_lock(&di->data_mutex); | |
1224 | while (!di->handled_all_samples && !di->want_wait_terminate) | |
1225 | g_cond_wait(&di->handled_all_samples_cond, &di->data_mutex); | |
1226 | g_mutex_unlock(&di->data_mutex); | |
bc5f5a43 | 1227 | |
3f3c4614 GS |
1228 | if (di->want_wait_terminate) |
1229 | return SRD_ERR_TERM_REQ; | |
7969d803 | 1230 | |
b2c19614 BV |
1231 | return SRD_OK; |
1232 | } | |
1233 | ||
9553e962 GS |
1234 | /** |
1235 | * Terminate current decoder work, prepare for re-use on new input data. | |
1236 | * | |
1237 | * Terminates all decoder operations in the specified decoder instance | |
1238 | * and the instances stacked on top of it. Resets internal state such | |
1239 | * that the previously constructed stack can process new input data that | |
1240 | * is not related to previously processed input data. This avoids the | |
1241 | * expensive and complex re-construction of decoder stacks. | |
1242 | * | |
1243 | * Callers are expected to follow up with start, metadata, and decode | |
1244 | * calls like they would for newly constructed decoder stacks. | |
1245 | * | |
1246 | * @param di The decoder instance to call. Must not be NULL. | |
7969d803 | 1247 | * |
9553e962 | 1248 | * @return SRD_OK upon success, a (negative) error code otherwise. |
7969d803 | 1249 | * |
9553e962 GS |
1250 | * @private |
1251 | */ | |
1252 | SRD_PRIV int srd_inst_terminate_reset(struct srd_decoder_inst *di) | |
1253 | { | |
1254 | PyGILState_STATE gstate; | |
1255 | PyObject *py_ret; | |
1256 | GSList *l; | |
1257 | int ret; | |
1258 | ||
1259 | if (!di) | |
1260 | return SRD_ERR_ARG; | |
1261 | ||
1262 | /* | |
1263 | * Request termination and wait for previously initiated | |
1264 | * background operation to finish. Reset internal state, but | |
1265 | * do not start releasing resources yet. This shall result in | |
1266 | * decoders' state just like after creation. This block handles | |
1267 | * the C language library side. | |
1268 | */ | |
1269 | srd_dbg("Terminating instance %s", di->inst_id); | |
1270 | srd_inst_join_decode_thread(di); | |
1271 | srd_inst_reset_state(di); | |
1272 | ||
1273 | /* | |
1274 | * Have the Python side's .reset() method executed (if the PD | |
1275 | * implements it). It's assumed that .reset() assigns variables | |
1276 | * very much like __init__() used to do in the past. Thus memory | |
1277 | * that was allocated in previous calls gets released by Python | |
1278 | * as it's not referenced any longer. | |
1279 | */ | |
1280 | gstate = PyGILState_Ensure(); | |
1281 | if (PyObject_HasAttrString(di->py_inst, "reset")) { | |
755e4a1e | 1282 | srd_dbg("Calling reset() of instance %s", di->inst_id); |
9553e962 GS |
1283 | py_ret = PyObject_CallMethod(di->py_inst, "reset", NULL); |
1284 | Py_XDECREF(py_ret); | |
1285 | } | |
1286 | PyGILState_Release(gstate); | |
1287 | ||
7969d803 | 1288 | /* Pass the "restart" request to all stacked decoders. */ |
9553e962 GS |
1289 | for (l = di->next_di; l; l = l->next) { |
1290 | ret = srd_inst_terminate_reset(l->data); | |
1291 | if (ret != SRD_OK) | |
1292 | return ret; | |
1293 | } | |
1294 | ||
d4d8ac2a | 1295 | return di->decoder_state; |
9553e962 GS |
1296 | } |
1297 | ||
57790bc8 | 1298 | /** @private */ |
12243c22 | 1299 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
1300 | { |
1301 | GSList *l; | |
1302 | struct srd_pd_output *pdo; | |
514b2edc | 1303 | PyGILState_STATE gstate; |
fa12a21e | 1304 | |
7969d803 | 1305 | srd_dbg("Freeing instance %s.", di->inst_id); |
fa12a21e | 1306 | |
04383ea8 | 1307 | srd_inst_join_decode_thread(di); |
514b2edc | 1308 | |
04383ea8 GS |
1309 | srd_inst_reset_state(di); |
1310 | ||
514b2edc | 1311 | gstate = PyGILState_Ensure(); |
a8b72b05 | 1312 | Py_DecRef(di->py_inst); |
514b2edc UH |
1313 | PyGILState_Release(gstate); |
1314 | ||
a8b72b05 | 1315 | g_free(di->inst_id); |
6a15597a | 1316 | g_free(di->dec_channelmap); |
d2297b87 | 1317 | g_free(di->channel_samples); |
fa12a21e BV |
1318 | g_slist_free(di->next_di); |
1319 | for (l = di->pd_output; l; l = l->next) { | |
1320 | pdo = l->data; | |
1321 | g_free(pdo->proto_id); | |
1322 | g_free(pdo); | |
1323 | } | |
1324 | g_slist_free(di->pd_output); | |
e592ac89 | 1325 | g_free(di); |
fa12a21e BV |
1326 | } |
1327 | ||
57790bc8 | 1328 | /** @private */ |
3262ef02 | 1329 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess) |
fa12a21e | 1330 | { |
4ccebbd3 | 1331 | if (!sess) |
32cfb920 | 1332 | return; |
32cfb920 | 1333 | |
3262ef02 | 1334 | g_slist_free_full(sess->di_list, (GDestroyNotify)srd_inst_free); |
fa12a21e | 1335 | } |
b2c19614 | 1336 | |
4895418c | 1337 | /** @} */ |