]>
Commit | Line | Data |
---|---|---|
d0a0ed03 | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
d0a0ed03 BV |
3 | * |
4 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> | |
5 | * | |
6 | * This program is free software: you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation, either version 3 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
36784362 | 20 | #include <config.h> |
f6c7eade MC |
21 | #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
22 | #include "libsigrokdecode.h" | |
dbeaab27 | 23 | #include <inttypes.h> |
d0a0ed03 | 24 | |
17475b09 UH |
25 | typedef struct { |
26 | PyObject_HEAD | |
27 | } srd_Decoder; | |
28 | ||
201a85a8 DE |
29 | /* This is only used for nicer srd_dbg() output. |
30 | */ | |
31 | static const char *output_type_name(unsigned int idx) | |
32 | { | |
33 | static const char names[][16] = { | |
34 | "OUTPUT_ANN", | |
35 | "OUTPUT_PYTHON", | |
36 | "OUTPUT_BINARY", | |
37 | "OUTPUT_META", | |
38 | "(invalid)" | |
39 | }; | |
40 | return names[MIN(idx, G_N_ELEMENTS(names) - 1)]; | |
41 | } | |
58572aed | 42 | |
4f75f1c1 | 43 | static int convert_annotation(struct srd_decoder_inst *di, PyObject *obj, |
0b922460 | 44 | struct srd_proto_data *pdata) |
d0a0ed03 BV |
45 | { |
46 | PyObject *py_tmp; | |
47 | struct srd_pd_output *pdo; | |
0b922460 | 48 | struct srd_proto_data_annotation *pda; |
280d554c | 49 | int ann_class; |
0b922460 | 50 | char **ann_text; |
514b2edc UH |
51 | PyGILState_STATE gstate; |
52 | ||
53 | gstate = PyGILState_Ensure(); | |
d0a0ed03 | 54 | |
280d554c | 55 | /* Should be a list of [annotation class, [string, ...]]. */ |
0679f5bf | 56 | if (!PyList_Check(obj)) { |
201a85a8 | 57 | srd_err("Protocol decoder %s submitted an annotation that" |
0679f5bf | 58 | " is not a list", di->decoder->name); |
514b2edc | 59 | goto err; |
d0a0ed03 BV |
60 | } |
61 | ||
361fdcaa | 62 | /* Should have 2 elements. */ |
d0a0ed03 | 63 | if (PyList_Size(obj) != 2) { |
c9bfccc6 | 64 | srd_err("Protocol decoder %s submitted annotation list with " |
4916b173 | 65 | "%zd elements instead of 2", di->decoder->name, |
c9bfccc6 | 66 | PyList_Size(obj)); |
514b2edc | 67 | goto err; |
d0a0ed03 BV |
68 | } |
69 | ||
c9bfccc6 UH |
70 | /* |
71 | * The first element should be an integer matching a previously | |
280d554c | 72 | * registered annotation class. |
c9bfccc6 | 73 | */ |
d0a0ed03 BV |
74 | py_tmp = PyList_GetItem(obj, 0); |
75 | if (!PyLong_Check(py_tmp)) { | |
c9bfccc6 UH |
76 | srd_err("Protocol decoder %s submitted annotation list, but " |
77 | "first element was not an integer.", di->decoder->name); | |
514b2edc | 78 | goto err; |
d0a0ed03 | 79 | } |
280d554c UH |
80 | ann_class = PyLong_AsLong(py_tmp); |
81 | if (!(pdo = g_slist_nth_data(di->decoder->annotations, ann_class))) { | |
d906d3f9 | 82 | srd_err("Protocol decoder %s submitted data to unregistered " |
280d554c | 83 | "annotation class %d.", di->decoder->name, ann_class); |
514b2edc | 84 | goto err; |
d0a0ed03 | 85 | } |
d0a0ed03 | 86 | |
361fdcaa | 87 | /* Second element must be a list. */ |
d0a0ed03 BV |
88 | py_tmp = PyList_GetItem(obj, 1); |
89 | if (!PyList_Check(py_tmp)) { | |
d906d3f9 | 90 | srd_err("Protocol decoder %s submitted annotation list, but " |
c9bfccc6 | 91 | "second element was not a list.", di->decoder->name); |
514b2edc | 92 | goto err; |
d0a0ed03 | 93 | } |
62a2b15c | 94 | if (py_strseq_to_char(py_tmp, &ann_text) != SRD_OK) { |
d906d3f9 | 95 | srd_err("Protocol decoder %s submitted annotation list, but " |
c9bfccc6 | 96 | "second element was malformed.", di->decoder->name); |
514b2edc | 97 | goto err; |
d0a0ed03 BV |
98 | } |
99 | ||
077fa8ac | 100 | pda = g_malloc(sizeof(struct srd_proto_data_annotation)); |
280d554c | 101 | pda->ann_class = ann_class; |
0b922460 BV |
102 | pda->ann_text = ann_text; |
103 | pdata->data = pda; | |
104 | ||
514b2edc UH |
105 | PyGILState_Release(gstate); |
106 | ||
d0a0ed03 | 107 | return SRD_OK; |
514b2edc UH |
108 | |
109 | err: | |
110 | PyGILState_Release(gstate); | |
111 | ||
112 | return SRD_ERR_PYTHON; | |
d0a0ed03 BV |
113 | } |
114 | ||
d75d8a7c BV |
115 | static int convert_binary(struct srd_decoder_inst *di, PyObject *obj, |
116 | struct srd_proto_data *pdata) | |
117 | { | |
118 | struct srd_proto_data_binary *pdb; | |
119 | PyObject *py_tmp; | |
120 | Py_ssize_t size; | |
121 | int bin_class; | |
122 | char *class_name, *buf; | |
514b2edc UH |
123 | PyGILState_STATE gstate; |
124 | ||
125 | gstate = PyGILState_Ensure(); | |
d75d8a7c | 126 | |
2824e811 UH |
127 | /* Should be a list of [binary class, bytes]. */ |
128 | if (!PyList_Check(obj)) { | |
129 | srd_err("Protocol decoder %s submitted non-list for SRD_OUTPUT_BINARY.", | |
201a85a8 | 130 | di->decoder->name); |
514b2edc | 131 | goto err; |
d75d8a7c BV |
132 | } |
133 | ||
134 | /* Should have 2 elements. */ | |
2824e811 UH |
135 | if (PyList_Size(obj) != 2) { |
136 | srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list " | |
4916b173 | 137 | "with %zd elements instead of 2", di->decoder->name, |
d75d8a7c | 138 | PyList_Size(obj)); |
514b2edc | 139 | goto err; |
d75d8a7c BV |
140 | } |
141 | ||
142 | /* The first element should be an integer. */ | |
2824e811 | 143 | py_tmp = PyList_GetItem(obj, 0); |
d75d8a7c | 144 | if (!PyLong_Check(py_tmp)) { |
2824e811 | 145 | srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, " |
d75d8a7c | 146 | "but first element was not an integer.", di->decoder->name); |
514b2edc | 147 | goto err; |
d75d8a7c BV |
148 | } |
149 | bin_class = PyLong_AsLong(py_tmp); | |
150 | if (!(class_name = g_slist_nth_data(di->decoder->binary, bin_class))) { | |
151 | srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY with " | |
152 | "unregistered binary class %d.", di->decoder->name, bin_class); | |
514b2edc | 153 | goto err; |
d75d8a7c BV |
154 | } |
155 | ||
156 | /* Second element should be bytes. */ | |
2824e811 | 157 | py_tmp = PyList_GetItem(obj, 1); |
d75d8a7c | 158 | if (!PyBytes_Check(py_tmp)) { |
2824e811 | 159 | srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY list, " |
d75d8a7c | 160 | "but second element was not bytes.", di->decoder->name); |
514b2edc | 161 | goto err; |
d75d8a7c BV |
162 | } |
163 | ||
164 | /* Consider an empty set of bytes a bug. */ | |
165 | if (PyBytes_Size(py_tmp) == 0) { | |
166 | srd_err("Protocol decoder %s submitted SRD_OUTPUT_BINARY " | |
167 | "with empty data set.", di->decoder->name); | |
514b2edc | 168 | goto err; |
d75d8a7c BV |
169 | } |
170 | ||
077fa8ac | 171 | pdb = g_malloc(sizeof(struct srd_proto_data_binary)); |
d75d8a7c | 172 | if (PyBytes_AsStringAndSize(py_tmp, &buf, &size) == -1) |
514b2edc UH |
173 | goto err; |
174 | ||
175 | PyGILState_Release(gstate); | |
176 | ||
d75d8a7c BV |
177 | pdb->bin_class = bin_class; |
178 | pdb->size = size; | |
179 | if (!(pdb->data = g_try_malloc(pdb->size))) | |
180 | return SRD_ERR_MALLOC; | |
181 | memcpy((void *)pdb->data, (const void *)buf, pdb->size); | |
182 | pdata->data = pdb; | |
183 | ||
184 | return SRD_OK; | |
514b2edc UH |
185 | |
186 | err: | |
187 | PyGILState_Release(gstate); | |
188 | ||
189 | return SRD_ERR_PYTHON; | |
d75d8a7c BV |
190 | } |
191 | ||
7ee0c40b BV |
192 | static int convert_meta(struct srd_proto_data *pdata, PyObject *obj) |
193 | { | |
194 | long long intvalue; | |
195 | double dvalue; | |
514b2edc UH |
196 | PyGILState_STATE gstate; |
197 | ||
198 | gstate = PyGILState_Ensure(); | |
7ee0c40b BV |
199 | |
200 | if (pdata->pdo->meta_type == G_VARIANT_TYPE_INT64) { | |
201 | if (!PyLong_Check(obj)) { | |
202 | PyErr_Format(PyExc_TypeError, "This output was registered " | |
201a85a8 | 203 | "as 'int', but something else was passed."); |
514b2edc | 204 | goto err; |
7ee0c40b BV |
205 | } |
206 | intvalue = PyLong_AsLongLong(obj); | |
207 | if (PyErr_Occurred()) | |
514b2edc | 208 | goto err; |
7ee0c40b BV |
209 | pdata->data = g_variant_new_int64(intvalue); |
210 | } else if (pdata->pdo->meta_type == G_VARIANT_TYPE_DOUBLE) { | |
211 | if (!PyFloat_Check(obj)) { | |
212 | PyErr_Format(PyExc_TypeError, "This output was registered " | |
201a85a8 | 213 | "as 'float', but something else was passed."); |
514b2edc | 214 | goto err; |
7ee0c40b BV |
215 | } |
216 | dvalue = PyFloat_AsDouble(obj); | |
217 | if (PyErr_Occurred()) | |
514b2edc | 218 | goto err; |
7ee0c40b BV |
219 | pdata->data = g_variant_new_double(dvalue); |
220 | } | |
221 | ||
514b2edc UH |
222 | PyGILState_Release(gstate); |
223 | ||
7ee0c40b | 224 | return SRD_OK; |
514b2edc UH |
225 | |
226 | err: | |
227 | PyGILState_Release(gstate); | |
228 | ||
229 | return SRD_ERR_PYTHON; | |
7ee0c40b BV |
230 | } |
231 | ||
d0a0ed03 BV |
232 | static PyObject *Decoder_put(PyObject *self, PyObject *args) |
233 | { | |
234 | GSList *l; | |
4f75f1c1 | 235 | PyObject *py_data, *py_res; |
a8b72b05 | 236 | struct srd_decoder_inst *di, *next_di; |
d0a0ed03 | 237 | struct srd_pd_output *pdo; |
8a9f60b1 | 238 | struct srd_proto_data pdata; |
d0a0ed03 BV |
239 | uint64_t start_sample, end_sample; |
240 | int output_id; | |
2994587f | 241 | struct srd_pd_callback *cb; |
514b2edc UH |
242 | PyGILState_STATE gstate; |
243 | ||
244 | gstate = PyGILState_Ensure(); | |
d0a0ed03 | 245 | |
a8b72b05 | 246 | if (!(di = srd_inst_find_by_obj(NULL, self))) { |
58572aed | 247 | /* Shouldn't happen. */ |
7a1712c4 | 248 | srd_dbg("put(): self instance not found."); |
514b2edc | 249 | goto err; |
58572aed | 250 | } |
d0a0ed03 | 251 | |
c9bfccc6 | 252 | if (!PyArg_ParseTuple(args, "KKiO", &start_sample, &end_sample, |
3d14e7c9 | 253 | &output_id, &py_data)) { |
c9bfccc6 UH |
254 | /* |
255 | * This throws an exception, but by returning NULL here we let | |
256 | * Python raise it. This results in a much better trace in | |
257 | * controller.c on the decode() method call. | |
258 | */ | |
514b2edc | 259 | goto err; |
c9bfccc6 | 260 | } |
d0a0ed03 BV |
261 | |
262 | if (!(l = g_slist_nth(di->pd_output, output_id))) { | |
d906d3f9 | 263 | srd_err("Protocol decoder %s submitted invalid output ID %d.", |
c9bfccc6 | 264 | di->decoder->name, output_id); |
514b2edc | 265 | goto err; |
d0a0ed03 BV |
266 | } |
267 | pdo = l->data; | |
268 | ||
1c2b0d0b | 269 | srd_spew("Instance %s put %" PRIu64 "-%" PRIu64 " %s on oid %d.", |
a8b72b05 | 270 | di->inst_id, start_sample, end_sample, |
201a85a8 | 271 | output_type_name(pdo->output_type), output_id); |
58572aed | 272 | |
8a9f60b1 UH |
273 | pdata.start_sample = start_sample; |
274 | pdata.end_sample = end_sample; | |
275 | pdata.pdo = pdo; | |
276 | pdata.data = NULL; | |
d0a0ed03 BV |
277 | |
278 | switch (pdo->output_type) { | |
279 | case SRD_OUTPUT_ANN: | |
280 | /* Annotations are only fed to callbacks. */ | |
32cfb920 | 281 | if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) { |
d75d8a7c | 282 | /* Convert from PyDict to srd_proto_data_annotation. */ |
8a9f60b1 | 283 | if (convert_annotation(di, py_data, &pdata) != SRD_OK) { |
d0a0ed03 BV |
284 | /* An error was already logged. */ |
285 | break; | |
286 | } | |
514b2edc | 287 | Py_BEGIN_ALLOW_THREADS |
8a9f60b1 | 288 | cb->cb(&pdata, cb->cb_data); |
514b2edc | 289 | Py_END_ALLOW_THREADS |
d0a0ed03 BV |
290 | } |
291 | break; | |
f2a5df42 | 292 | case SRD_OUTPUT_PYTHON: |
d0a0ed03 BV |
293 | for (l = di->next_di; l; l = l->next) { |
294 | next_di = l->data; | |
4916b173 | 295 | srd_spew("Sending %" PRIu64 "-%" PRIu64 " to instance %s", |
3d14e7c9 | 296 | start_sample, end_sample, next_di->inst_id); |
c9bfccc6 | 297 | if (!(py_res = PyObject_CallMethod( |
3d14e7c9 BV |
298 | next_di->py_inst, "decode", "KKO", start_sample, |
299 | end_sample, py_data))) { | |
201a85a8 | 300 | srd_exception_catch("Calling %s decode() failed", |
3d14e7c9 | 301 | next_di->inst_id); |
d0a0ed03 BV |
302 | } |
303 | Py_XDECREF(py_res); | |
304 | } | |
3d14e7c9 BV |
305 | if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) { |
306 | /* Frontends aren't really supposed to get Python | |
307 | * callbacks, but it's useful for testing. */ | |
8a9f60b1 UH |
308 | pdata.data = py_data; |
309 | cb->cb(&pdata, cb->cb_data); | |
3d14e7c9 | 310 | } |
d0a0ed03 BV |
311 | break; |
312 | case SRD_OUTPUT_BINARY: | |
d75d8a7c BV |
313 | if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) { |
314 | /* Convert from PyDict to srd_proto_data_binary. */ | |
8a9f60b1 | 315 | if (convert_binary(di, py_data, &pdata) != SRD_OK) { |
d75d8a7c BV |
316 | /* An error was already logged. */ |
317 | break; | |
318 | } | |
514b2edc | 319 | Py_BEGIN_ALLOW_THREADS |
8a9f60b1 | 320 | cb->cb(&pdata, cb->cb_data); |
514b2edc | 321 | Py_END_ALLOW_THREADS |
d75d8a7c | 322 | } |
d0a0ed03 | 323 | break; |
7ee0c40b BV |
324 | case SRD_OUTPUT_META: |
325 | if ((cb = srd_pd_output_callback_find(di->sess, pdo->output_type))) { | |
326 | /* Annotations need converting from PyObject. */ | |
8a9f60b1 | 327 | if (convert_meta(&pdata, py_data) != SRD_OK) { |
7ee0c40b BV |
328 | /* An exception was already set up. */ |
329 | break; | |
330 | } | |
514b2edc | 331 | Py_BEGIN_ALLOW_THREADS |
8a9f60b1 | 332 | cb->cb(&pdata, cb->cb_data); |
514b2edc | 333 | Py_END_ALLOW_THREADS |
7ee0c40b BV |
334 | } |
335 | break; | |
d0a0ed03 | 336 | default: |
d906d3f9 | 337 | srd_err("Protocol decoder %s submitted invalid output type %d.", |
c9bfccc6 | 338 | di->decoder->name, pdo->output_type); |
d0a0ed03 BV |
339 | break; |
340 | } | |
341 | ||
514b2edc UH |
342 | PyGILState_Release(gstate); |
343 | ||
d0a0ed03 | 344 | Py_RETURN_NONE; |
514b2edc UH |
345 | |
346 | err: | |
347 | PyGILState_Release(gstate); | |
348 | ||
349 | return NULL; | |
d0a0ed03 BV |
350 | } |
351 | ||
7ee0c40b BV |
352 | static PyObject *Decoder_register(PyObject *self, PyObject *args, |
353 | PyObject *kwargs) | |
d0a0ed03 | 354 | { |
a8b72b05 | 355 | struct srd_decoder_inst *di; |
7ee0c40b BV |
356 | struct srd_pd_output *pdo; |
357 | PyObject *py_new_output_id; | |
358 | PyTypeObject *meta_type_py; | |
359 | const GVariantType *meta_type_gv; | |
360 | int output_type; | |
361 | char *proto_id, *meta_name, *meta_descr; | |
362 | char *keywords[] = {"output_type", "proto_id", "meta", NULL}; | |
514b2edc | 363 | PyGILState_STATE gstate; |
7d82e3c1 GS |
364 | gboolean is_meta; |
365 | GSList *l; | |
366 | struct srd_pd_output *cmp; | |
514b2edc UH |
367 | |
368 | gstate = PyGILState_Ensure(); | |
7ee0c40b BV |
369 | |
370 | meta_type_py = NULL; | |
371 | meta_type_gv = NULL; | |
372 | meta_name = meta_descr = NULL; | |
d0a0ed03 | 373 | |
a8b72b05 | 374 | if (!(di = srd_inst_find_by_obj(NULL, self))) { |
d0a0ed03 | 375 | PyErr_SetString(PyExc_Exception, "decoder instance not found"); |
514b2edc | 376 | goto err; |
d0a0ed03 BV |
377 | } |
378 | ||
7ee0c40b BV |
379 | /* Default to instance id, which defaults to class id. */ |
380 | proto_id = di->inst_id; | |
381 | if (!PyArg_ParseTupleAndKeywords(args, kwargs, "i|s(Oss)", keywords, | |
382 | &output_type, &proto_id, | |
383 | &meta_type_py, &meta_name, &meta_descr)) { | |
511e2123 | 384 | /* Let Python raise this exception. */ |
514b2edc | 385 | goto err; |
d0a0ed03 BV |
386 | } |
387 | ||
7ee0c40b | 388 | /* Check if the meta value's type is supported. */ |
7d82e3c1 GS |
389 | is_meta = output_type == SRD_OUTPUT_META; |
390 | if (is_meta) { | |
7ee0c40b BV |
391 | if (meta_type_py == &PyLong_Type) |
392 | meta_type_gv = G_VARIANT_TYPE_INT64; | |
393 | else if (meta_type_py == &PyFloat_Type) | |
394 | meta_type_gv = G_VARIANT_TYPE_DOUBLE; | |
395 | else { | |
201a85a8 | 396 | PyErr_Format(PyExc_TypeError, "Unsupported type."); |
514b2edc | 397 | goto err; |
7ee0c40b BV |
398 | } |
399 | } | |
400 | ||
7d82e3c1 GS |
401 | pdo = NULL; |
402 | for (l = di->pd_output; l; l = l->next) { | |
403 | cmp = l->data; | |
404 | if (cmp->output_type != output_type) | |
405 | continue; | |
406 | if (strcmp(cmp->proto_id, proto_id) != 0) | |
407 | continue; | |
408 | if (is_meta && cmp->meta_type != meta_type_gv) | |
409 | continue; | |
410 | if (is_meta && strcmp(cmp->meta_name, meta_name) != 0) | |
411 | continue; | |
412 | if (is_meta && strcmp(cmp->meta_descr, meta_descr) != 0) | |
413 | continue; | |
414 | pdo = cmp; | |
415 | break; | |
416 | } | |
417 | if (pdo) { | |
418 | py_new_output_id = Py_BuildValue("i", pdo->pdo_id); | |
419 | PyGILState_Release(gstate); | |
420 | return py_new_output_id; | |
421 | } | |
422 | ||
7ee0c40b BV |
423 | srd_dbg("Instance %s creating new output type %d for %s.", |
424 | di->inst_id, output_type, proto_id); | |
425 | ||
077fa8ac | 426 | pdo = g_malloc(sizeof(struct srd_pd_output)); |
7ee0c40b BV |
427 | |
428 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ | |
429 | pdo->pdo_id = g_slist_length(di->pd_output); | |
430 | pdo->output_type = output_type; | |
431 | pdo->di = di; | |
432 | pdo->proto_id = g_strdup(proto_id); | |
433 | ||
434 | if (output_type == SRD_OUTPUT_META) { | |
435 | pdo->meta_type = meta_type_gv; | |
436 | pdo->meta_name = g_strdup(meta_name); | |
437 | pdo->meta_descr = g_strdup(meta_descr); | |
438 | } | |
439 | ||
440 | di->pd_output = g_slist_append(di->pd_output, pdo); | |
441 | py_new_output_id = Py_BuildValue("i", pdo->pdo_id); | |
442 | ||
514b2edc UH |
443 | PyGILState_Release(gstate); |
444 | ||
7ee0c40b | 445 | return py_new_output_id; |
514b2edc UH |
446 | |
447 | err: | |
448 | PyGILState_Release(gstate); | |
449 | ||
450 | return NULL; | |
7ee0c40b BV |
451 | } |
452 | ||
21dfd91d UH |
453 | static int get_term_type(const char *v) |
454 | { | |
455 | switch (v[0]) { | |
456 | case 'h': | |
457 | return SRD_TERM_HIGH; | |
458 | case 'l': | |
459 | return SRD_TERM_LOW; | |
460 | case 'r': | |
461 | return SRD_TERM_RISING_EDGE; | |
462 | case 'f': | |
463 | return SRD_TERM_FALLING_EDGE; | |
464 | case 'e': | |
465 | return SRD_TERM_EITHER_EDGE; | |
466 | case 'n': | |
467 | return SRD_TERM_NO_EDGE; | |
468 | } | |
469 | ||
470 | return -1; | |
471 | } | |
472 | ||
473 | /** | |
474 | * Get the pin values at the current sample number. | |
475 | * | |
476 | * @param di The decoder instance to use. Must not be NULL. | |
477 | * The number of channels must be >= 1. | |
478 | * | |
479 | * @return A newly allocated PyTuple containing the pin values at the | |
480 | * current sample number. | |
481 | */ | |
482 | static PyObject *get_current_pinvalues(const struct srd_decoder_inst *di) | |
483 | { | |
484 | int i; | |
485 | uint8_t sample; | |
486 | const uint8_t *sample_pos; | |
487 | int byte_offset, bit_offset; | |
488 | PyObject *py_pinvalues; | |
514b2edc UH |
489 | PyGILState_STATE gstate; |
490 | ||
491 | gstate = PyGILState_Ensure(); | |
21dfd91d UH |
492 | |
493 | if (!di) { | |
494 | srd_err("Invalid decoder instance."); | |
514b2edc | 495 | PyGILState_Release(gstate); |
21dfd91d UH |
496 | return NULL; |
497 | } | |
498 | ||
499 | py_pinvalues = PyTuple_New(di->dec_num_channels); | |
500 | ||
501 | for (i = 0; i < di->dec_num_channels; i++) { | |
502 | /* A channelmap value of -1 means "unused optional channel". */ | |
503 | if (di->dec_channelmap[i] == -1) { | |
504 | /* Value of unused channel is 0xff, instead of 0 or 1. */ | |
505 | PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(0xff)); | |
506 | } else { | |
4564e8e5 | 507 | sample_pos = di->inbuf + ((di->abs_cur_samplenum - di->abs_start_samplenum) * di->data_unitsize); |
21dfd91d UH |
508 | byte_offset = di->dec_channelmap[i] / 8; |
509 | bit_offset = di->dec_channelmap[i] % 8; | |
510 | sample = *(sample_pos + byte_offset) & (1 << bit_offset) ? 1 : 0; | |
511 | PyTuple_SetItem(py_pinvalues, i, PyLong_FromLong(sample)); | |
512 | } | |
513 | } | |
514 | ||
514b2edc UH |
515 | PyGILState_Release(gstate); |
516 | ||
21dfd91d UH |
517 | return py_pinvalues; |
518 | } | |
519 | ||
520 | /** | |
521 | * Create a list of terms in the specified condition. | |
522 | * | |
523 | * If there are no terms in the condition, 'term_list' will be NULL. | |
524 | * | |
525 | * @param py_dict A Python dict containing terms. Must not be NULL. | |
526 | * @param term_list Pointer to a GSList which will be set to the newly | |
527 | * created list of terms. Must not be NULL. | |
528 | * | |
529 | * @return SRD_OK upon success, a negative error code otherwise. | |
530 | */ | |
531 | static int create_term_list(PyObject *py_dict, GSList **term_list) | |
532 | { | |
533 | Py_ssize_t pos = 0; | |
534 | PyObject *py_key, *py_value; | |
535 | struct srd_term *term; | |
536 | uint64_t num_samples_to_skip; | |
537 | char *term_str; | |
514b2edc | 538 | PyGILState_STATE gstate; |
21dfd91d UH |
539 | |
540 | if (!py_dict || !term_list) | |
541 | return SRD_ERR_ARG; | |
542 | ||
543 | /* "Create" an empty GSList of terms. */ | |
544 | *term_list = NULL; | |
545 | ||
514b2edc UH |
546 | gstate = PyGILState_Ensure(); |
547 | ||
21dfd91d UH |
548 | /* Iterate over all items in the current dict. */ |
549 | while (PyDict_Next(py_dict, &pos, &py_key, &py_value)) { | |
550 | /* Check whether the current key is a string or a number. */ | |
551 | if (PyLong_Check(py_key)) { | |
552 | /* The key is a number. */ | |
553 | /* TODO: Check if the number is a valid channel. */ | |
554 | /* Get the value string. */ | |
555 | if ((py_pydictitem_as_str(py_dict, py_key, &term_str)) != SRD_OK) { | |
556 | srd_err("Failed to get the value."); | |
514b2edc | 557 | goto err; |
21dfd91d UH |
558 | } |
559 | term = g_malloc0(sizeof(struct srd_term)); | |
560 | term->type = get_term_type(term_str); | |
561 | term->channel = PyLong_AsLong(py_key); | |
562 | g_free(term_str); | |
563 | } else if (PyUnicode_Check(py_key)) { | |
564 | /* The key is a string. */ | |
565 | /* TODO: Check if it's "skip". */ | |
566 | if ((py_pydictitem_as_long(py_dict, py_key, &num_samples_to_skip)) != SRD_OK) { | |
567 | srd_err("Failed to get number of samples to skip."); | |
514b2edc | 568 | goto err; |
21dfd91d UH |
569 | } |
570 | term = g_malloc0(sizeof(struct srd_term)); | |
571 | term->type = SRD_TERM_SKIP; | |
572 | term->num_samples_to_skip = num_samples_to_skip; | |
573 | term->num_samples_already_skipped = 0; | |
574 | } else { | |
575 | srd_err("Term key is neither a string nor a number."); | |
514b2edc | 576 | goto err; |
21dfd91d UH |
577 | } |
578 | ||
579 | /* Add the term to the list of terms. */ | |
580 | *term_list = g_slist_append(*term_list, term); | |
581 | } | |
582 | ||
514b2edc UH |
583 | PyGILState_Release(gstate); |
584 | ||
21dfd91d | 585 | return SRD_OK; |
514b2edc UH |
586 | |
587 | err: | |
588 | PyGILState_Release(gstate); | |
589 | ||
590 | return SRD_ERR; | |
21dfd91d UH |
591 | } |
592 | ||
593 | /** | |
594 | * Replace the current condition list with the new one. | |
595 | * | |
596 | * @param self TODO. Must not be NULL. | |
597 | * @param args TODO. Must not be NULL. | |
598 | * | |
599 | * @retval SRD_OK The new condition list was set successfully. | |
600 | * @retval SRD_ERR There was an error setting the new condition list. | |
601 | * The contents of di->condition_list are undefined. | |
602 | * @retval 9999 TODO. | |
603 | */ | |
604 | static int set_new_condition_list(PyObject *self, PyObject *args) | |
605 | { | |
606 | struct srd_decoder_inst *di; | |
607 | GSList *term_list; | |
608 | PyObject *py_conditionlist, *py_conds, *py_dict; | |
609 | int i, num_conditions, ret; | |
514b2edc | 610 | PyGILState_STATE gstate; |
21dfd91d UH |
611 | |
612 | if (!self || !args) | |
613 | return SRD_ERR_ARG; | |
614 | ||
514b2edc UH |
615 | gstate = PyGILState_Ensure(); |
616 | ||
21dfd91d UH |
617 | /* Get the decoder instance. */ |
618 | if (!(di = srd_inst_find_by_obj(NULL, self))) { | |
619 | PyErr_SetString(PyExc_Exception, "decoder instance not found"); | |
514b2edc | 620 | goto err; |
21dfd91d UH |
621 | } |
622 | ||
04383ea8 GS |
623 | /* |
624 | * Return an error condition from .wait() when termination is | |
625 | * requested, such that decode() will terminate. | |
626 | */ | |
627 | if (di->want_wait_terminate) { | |
628 | srd_dbg("%s: %s: Skip (want_term).", di->inst_id, __func__); | |
514b2edc | 629 | goto err; |
04383ea8 GS |
630 | } |
631 | ||
6e19f325 GS |
632 | /* |
633 | * Parse the argument of self.wait() into 'py_conds', and check | |
634 | * the data type. The argument is optional, None is assumed in | |
635 | * its absence. None or an empty dict or an empty list mean that | |
636 | * there is no condition, and the next available sample shall | |
637 | * get returned to the caller. | |
638 | */ | |
639 | py_conds = Py_None; | |
640 | if (!PyArg_ParseTuple(args, "|O", &py_conds)) { | |
21dfd91d | 641 | /* Let Python raise this exception. */ |
514b2edc | 642 | goto err; |
21dfd91d | 643 | } |
6e19f325 GS |
644 | if (py_conds == Py_None) { |
645 | /* 'py_conds' is None. */ | |
514b2edc | 646 | goto ret_9999; |
6e19f325 | 647 | } else if (PyList_Check(py_conds)) { |
21dfd91d UH |
648 | /* 'py_conds' is a list. */ |
649 | py_conditionlist = py_conds; | |
650 | num_conditions = PyList_Size(py_conditionlist); | |
651 | if (num_conditions == 0) | |
514b2edc | 652 | goto ret_9999; /* The PD invoked self.wait([]). */ |
066fbafd | 653 | Py_IncRef(py_conditionlist); |
21dfd91d UH |
654 | } else if (PyDict_Check(py_conds)) { |
655 | /* 'py_conds' is a dict. */ | |
656 | if (PyDict_Size(py_conds) == 0) | |
514b2edc | 657 | goto ret_9999; /* The PD invoked self.wait({}). */ |
21dfd91d UH |
658 | /* Make a list and put the dict in there for convenience. */ |
659 | py_conditionlist = PyList_New(1); | |
01f15bdf | 660 | Py_IncRef(py_conds); |
21dfd91d UH |
661 | PyList_SetItem(py_conditionlist, 0, py_conds); |
662 | num_conditions = 1; | |
663 | } else { | |
664 | srd_err("Condition list is neither a list nor a dict."); | |
514b2edc | 665 | goto err; |
21dfd91d UH |
666 | } |
667 | ||
668 | /* Free the old condition list. */ | |
669 | condition_list_free(di); | |
670 | ||
671 | ret = SRD_OK; | |
672 | ||
673 | /* Iterate over the conditions, set di->condition_list accordingly. */ | |
674 | for (i = 0; i < num_conditions; i++) { | |
675 | /* Get a condition (dict) from the condition list. */ | |
676 | py_dict = PyList_GetItem(py_conditionlist, i); | |
677 | if (!PyDict_Check(py_dict)) { | |
678 | srd_err("Condition is not a dict."); | |
679 | ret = SRD_ERR; | |
680 | break; | |
681 | } | |
682 | ||
683 | /* Create the list of terms in this condition. */ | |
684 | if ((ret = create_term_list(py_dict, &term_list)) < 0) | |
685 | break; | |
686 | ||
687 | /* Add the new condition to the PD instance's condition list. */ | |
688 | di->condition_list = g_slist_append(di->condition_list, term_list); | |
689 | } | |
690 | ||
691 | Py_DecRef(py_conditionlist); | |
692 | ||
514b2edc UH |
693 | PyGILState_Release(gstate); |
694 | ||
21dfd91d | 695 | return ret; |
514b2edc UH |
696 | |
697 | err: | |
698 | PyGILState_Release(gstate); | |
699 | ||
700 | return SRD_ERR; | |
701 | ||
702 | ret_9999: | |
703 | PyGILState_Release(gstate); | |
704 | ||
705 | return 9999; | |
21dfd91d UH |
706 | } |
707 | ||
96e1cee7 GS |
708 | /** |
709 | * Create a SKIP condition list for condition-less .wait() calls. | |
710 | * | |
711 | * @param di Decoder instance. | |
712 | * @param count Number of samples to skip. | |
713 | * | |
714 | * @retval SRD_OK The new condition list was set successfully. | |
715 | * @retval SRD_ERR There was an error setting the new condition list. | |
716 | * The contents of di->condition_list are undefined. | |
717 | * | |
718 | * This routine is a reduced and specialized version of the @ref | |
719 | * set_new_condition_list() and @ref create_term_list() routines which | |
720 | * gets invoked when .wait() was called without specifications for | |
721 | * conditions. This minor duplication of the SKIP term list creation | |
722 | * simplifies the logic and avoids the creation of expensive Python | |
723 | * objects with "constant" values which the caller did not pass in the | |
724 | * first place. It results in maximum sharing of match handling code | |
725 | * paths. | |
726 | */ | |
727 | static int set_skip_condition(struct srd_decoder_inst *di, uint64_t count) | |
728 | { | |
729 | struct srd_term *term; | |
730 | GSList *term_list; | |
731 | ||
732 | condition_list_free(di); | |
733 | term = g_malloc0(sizeof(*term)); | |
734 | term->type = SRD_TERM_SKIP; | |
735 | term->num_samples_to_skip = count; | |
736 | term->num_samples_already_skipped = 0; | |
737 | term_list = g_slist_append(NULL, term); | |
738 | di->condition_list = g_slist_append(di->condition_list, term_list); | |
739 | ||
740 | return SRD_OK; | |
741 | } | |
742 | ||
21dfd91d UH |
743 | static PyObject *Decoder_wait(PyObject *self, PyObject *args) |
744 | { | |
745 | int ret; | |
96e1cee7 | 746 | uint64_t skip_count; |
21dfd91d UH |
747 | unsigned int i; |
748 | gboolean found_match; | |
749 | struct srd_decoder_inst *di; | |
750 | PyObject *py_pinvalues, *py_matched; | |
514b2edc | 751 | PyGILState_STATE gstate; |
21dfd91d UH |
752 | |
753 | if (!self || !args) | |
754 | return NULL; | |
755 | ||
514b2edc UH |
756 | gstate = PyGILState_Ensure(); |
757 | ||
21dfd91d UH |
758 | if (!(di = srd_inst_find_by_obj(NULL, self))) { |
759 | PyErr_SetString(PyExc_Exception, "decoder instance not found"); | |
514b2edc | 760 | PyGILState_Release(gstate); |
21dfd91d UH |
761 | Py_RETURN_NONE; |
762 | } | |
763 | ||
764 | ret = set_new_condition_list(self, args); | |
04383ea8 GS |
765 | if (ret < 0) { |
766 | srd_dbg("%s: %s: Aborting wait().", di->inst_id, __func__); | |
514b2edc | 767 | goto err; |
04383ea8 | 768 | } |
21dfd91d | 769 | if (ret == 9999) { |
96e1cee7 GS |
770 | /* |
771 | * Empty condition list, automatic match. Arrange for the | |
772 | * execution of regular match handling code paths such that | |
773 | * the next available sample is returned to the caller. | |
774 | * Make sure to skip one sample when "anywhere within the | |
775 | * stream", yet make sure to not skip sample number 0. | |
776 | */ | |
777 | if (di->abs_cur_samplenum) | |
778 | skip_count = 1; | |
779 | else if (!di->condition_list) | |
780 | skip_count = 0; | |
781 | else | |
782 | skip_count = 1; | |
783 | ret = set_skip_condition(di, skip_count); | |
784 | if (ret < 0) { | |
785 | srd_dbg("%s: %s: Cannot setup condition-less wait().", | |
786 | di->inst_id, __func__); | |
514b2edc | 787 | goto err; |
96e1cee7 | 788 | } |
21dfd91d UH |
789 | } |
790 | ||
791 | while (1) { | |
514b2edc UH |
792 | |
793 | Py_BEGIN_ALLOW_THREADS | |
794 | ||
04383ea8 | 795 | /* Wait for new samples to process, or termination request. */ |
21dfd91d | 796 | g_mutex_lock(&di->data_mutex); |
04383ea8 | 797 | while (!di->got_new_samples && !di->want_wait_terminate) |
21dfd91d UH |
798 | g_cond_wait(&di->got_new_samples_cond, &di->data_mutex); |
799 | ||
04383ea8 GS |
800 | /* |
801 | * Check whether any of the current condition(s) match. | |
802 | * Arrange for termination requests to take a code path which | |
803 | * won't find new samples to process, pretends to have processed | |
804 | * previously stored samples, and returns to the main thread, | |
805 | * while the termination request still gets signalled. | |
806 | */ | |
807 | found_match = FALSE; | |
21dfd91d UH |
808 | ret = process_samples_until_condition_match(di, &found_match); |
809 | ||
514b2edc UH |
810 | Py_END_ALLOW_THREADS |
811 | ||
21dfd91d UH |
812 | /* If there's a match, set self.samplenum etc. and return. */ |
813 | if (found_match) { | |
814 | /* Set self.samplenum to the (absolute) sample number that matched. */ | |
815 | PyObject_SetAttrString(di->py_inst, "samplenum", | |
4564e8e5 | 816 | PyLong_FromLong(di->abs_cur_samplenum)); |
21dfd91d UH |
817 | |
818 | if (di->match_array && di->match_array->len > 0) { | |
819 | py_matched = PyTuple_New(di->match_array->len); | |
820 | for (i = 0; i < di->match_array->len; i++) | |
821 | PyTuple_SetItem(py_matched, i, PyBool_FromLong(di->match_array->data[i])); | |
822 | PyObject_SetAttrString(di->py_inst, "matched", py_matched); | |
823 | match_array_free(di); | |
824 | } else { | |
825 | PyObject_SetAttrString(di->py_inst, "matched", Py_None); | |
826 | } | |
fa168be6 | 827 | |
21dfd91d UH |
828 | py_pinvalues = get_current_pinvalues(di); |
829 | ||
830 | g_mutex_unlock(&di->data_mutex); | |
831 | ||
514b2edc UH |
832 | PyGILState_Release(gstate); |
833 | ||
21dfd91d UH |
834 | return py_pinvalues; |
835 | } | |
836 | ||
837 | /* No match, reset state for the next chunk. */ | |
838 | di->got_new_samples = FALSE; | |
839 | di->handled_all_samples = TRUE; | |
4564e8e5 UH |
840 | di->abs_start_samplenum = 0; |
841 | di->abs_end_samplenum = 0; | |
21dfd91d UH |
842 | di->inbuf = NULL; |
843 | di->inbuflen = 0; | |
844 | ||
845 | /* Signal the main thread that we handled all samples. */ | |
846 | g_cond_signal(&di->handled_all_samples_cond); | |
847 | ||
04383ea8 GS |
848 | /* |
849 | * When termination of wait() and decode() was requested, | |
850 | * then exit the loop after releasing the mutex. | |
851 | */ | |
852 | if (di->want_wait_terminate) { | |
853 | srd_dbg("%s: %s: Will return from wait().", | |
854 | di->inst_id, __func__); | |
855 | g_mutex_unlock(&di->data_mutex); | |
514b2edc | 856 | goto err; |
04383ea8 GS |
857 | } |
858 | ||
21dfd91d UH |
859 | g_mutex_unlock(&di->data_mutex); |
860 | } | |
861 | ||
514b2edc UH |
862 | PyGILState_Release(gstate); |
863 | ||
21dfd91d | 864 | Py_RETURN_NONE; |
514b2edc UH |
865 | |
866 | err: | |
867 | PyGILState_Release(gstate); | |
868 | ||
869 | return NULL; | |
21dfd91d UH |
870 | } |
871 | ||
872 | /** | |
873 | * Return whether the specified channel was supplied to the decoder. | |
874 | * | |
875 | * @param self TODO. Must not be NULL. | |
876 | * @param args TODO. Must not be NULL. | |
877 | * | |
878 | * @retval Py_True The channel has been supplied by the frontend. | |
879 | * @retval Py_False The channel has been supplied by the frontend. | |
880 | * @retval NULL An error occurred. | |
881 | */ | |
882 | static PyObject *Decoder_has_channel(PyObject *self, PyObject *args) | |
883 | { | |
cd8d9188 | 884 | int idx, count; |
21dfd91d | 885 | struct srd_decoder_inst *di; |
514b2edc | 886 | PyGILState_STATE gstate; |
21dfd91d UH |
887 | |
888 | if (!self || !args) | |
889 | return NULL; | |
890 | ||
514b2edc UH |
891 | gstate = PyGILState_Ensure(); |
892 | ||
21dfd91d UH |
893 | if (!(di = srd_inst_find_by_obj(NULL, self))) { |
894 | PyErr_SetString(PyExc_Exception, "decoder instance not found"); | |
514b2edc | 895 | goto err; |
21dfd91d UH |
896 | } |
897 | ||
cd8d9188 GS |
898 | /* |
899 | * Get the integer argument of self.has_channel(). Check for | |
900 | * the range of supported PD input channel numbers. | |
901 | */ | |
902 | if (!PyArg_ParseTuple(args, "i", &idx)) { | |
21dfd91d | 903 | /* Let Python raise this exception. */ |
514b2edc | 904 | goto err; |
21dfd91d UH |
905 | } |
906 | ||
cd8d9188 GS |
907 | count = g_slist_length(di->decoder->channels) + |
908 | g_slist_length(di->decoder->opt_channels); | |
909 | if (idx < 0 || idx >= count) { | |
910 | srd_err("Invalid index %d, PD channel count %d.", idx, count); | |
911 | PyErr_SetString(PyExc_IndexError, "invalid channel index"); | |
514b2edc | 912 | goto err; |
21dfd91d UH |
913 | } |
914 | ||
514b2edc UH |
915 | PyGILState_Release(gstate); |
916 | ||
21dfd91d | 917 | return (di->dec_channelmap[idx] == -1) ? Py_False : Py_True; |
514b2edc UH |
918 | |
919 | err: | |
920 | PyGILState_Release(gstate); | |
921 | ||
922 | return NULL; | |
21dfd91d UH |
923 | } |
924 | ||
d0a0ed03 BV |
925 | static PyMethodDef Decoder_methods[] = { |
926 | {"put", Decoder_put, METH_VARARGS, | |
86528298 | 927 | "Accepts a dictionary with the following keys: startsample, endsample, data"}, |
7ee0c40b BV |
928 | {"register", (PyCFunction)Decoder_register, METH_VARARGS|METH_KEYWORDS, |
929 | "Register a new output stream"}, | |
21dfd91d UH |
930 | {"wait", Decoder_wait, METH_VARARGS, |
931 | "Wait for one or more conditions to occur"}, | |
932 | {"has_channel", Decoder_has_channel, METH_VARARGS, | |
933 | "Report whether a channel was supplied"}, | |
d0a0ed03 BV |
934 | {NULL, NULL, 0, NULL} |
935 | }; | |
936 | ||
21dfd91d UH |
937 | /** |
938 | * Create the sigrokdecode.Decoder type. | |
939 | * | |
201a85a8 | 940 | * @return The new type object. |
21dfd91d | 941 | * |
201a85a8 DE |
942 | * @private |
943 | */ | |
944 | SRD_PRIV PyObject *srd_Decoder_type_new(void) | |
945 | { | |
946 | PyType_Spec spec; | |
947 | PyType_Slot slots[] = { | |
948 | { Py_tp_doc, "sigrok Decoder base class" }, | |
949 | { Py_tp_methods, Decoder_methods }, | |
950 | { Py_tp_new, (void *)&PyType_GenericNew }, | |
951 | { 0, NULL } | |
952 | }; | |
514b2edc UH |
953 | PyObject *py_obj; |
954 | PyGILState_STATE gstate; | |
955 | ||
956 | gstate = PyGILState_Ensure(); | |
957 | ||
201a85a8 DE |
958 | spec.name = "sigrokdecode.Decoder"; |
959 | spec.basicsize = sizeof(srd_Decoder); | |
960 | spec.itemsize = 0; | |
961 | spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE; | |
962 | spec.slots = slots; | |
963 | ||
514b2edc UH |
964 | py_obj = PyType_FromSpec(&spec); |
965 | ||
966 | PyGILState_Release(gstate); | |
967 | ||
968 | return py_obj; | |
201a85a8 | 969 | } |