]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> | |
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 | ||
21 | #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
22 | #include "sigrokdecode-internal.h" | |
23 | #include "config.h" | |
24 | #include <glib.h> | |
25 | #include <inttypes.h> | |
26 | #include <stdlib.h> | |
27 | ||
28 | /* List of decoder instances. */ | |
29 | static GSList *di_list = NULL; | |
30 | ||
31 | /* List of frontend callbacks to receive decoder output. */ | |
32 | static GSList *callbacks = NULL; | |
33 | ||
34 | /* decoder.c */ | |
35 | extern SRD_PRIV GSList *pd_list; | |
36 | ||
37 | /* module_sigrokdecode.c */ | |
38 | extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void); | |
39 | ||
40 | /* type_logic.c */ | |
41 | extern SRD_PRIV PyTypeObject srd_logic_type; | |
42 | ||
43 | /** | |
44 | * Initialize libsigrokdecode. | |
45 | * | |
46 | * This initializes the Python interpreter, and creates and initializes | |
47 | * a "sigrokdecode" Python module. | |
48 | * | |
49 | * Then, it searches for sigrok protocol decoder files (*.py) in the | |
50 | * "decoders" subdirectory of the the sigrok installation directory. | |
51 | * All decoders that are found are loaded into memory and added to an | |
52 | * internal list of decoders, which can be queried via srd_decoders_list(). | |
53 | * | |
54 | * The caller is responsible for calling the clean-up function srd_exit(), | |
55 | * which will properly shut down libsigrokdecode and free its allocated memory. | |
56 | * | |
57 | * Multiple calls to srd_init(), without calling srd_exit() in between, | |
58 | * are not allowed. | |
59 | * | |
60 | * @param path Path to an extra directory containing protocol decoders | |
61 | * which will be added to the Python sys.path, or NULL. | |
62 | * | |
63 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
64 | * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders | |
65 | * directory cannot be accessed, return SRD_ERR_DECODERS_DIR. | |
66 | * If not enough memory could be allocated, return SRD_ERR_MALLOC. | |
67 | */ | |
68 | SRD_API int srd_init(const char *path) | |
69 | { | |
70 | int ret; | |
71 | char *env_path; | |
72 | ||
73 | srd_dbg("Initializing libsigrokdecode."); | |
74 | ||
75 | /* Add our own module to the list of built-in modules. */ | |
76 | PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); | |
77 | ||
78 | /* Initialize the Python interpreter. */ | |
79 | Py_Initialize(); | |
80 | ||
81 | /* Installed decoders. */ | |
82 | if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { | |
83 | Py_Finalize(); | |
84 | return ret; | |
85 | } | |
86 | ||
87 | /* Path specified by the user. */ | |
88 | if (path) { | |
89 | if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { | |
90 | Py_Finalize(); | |
91 | return ret; | |
92 | } | |
93 | } | |
94 | ||
95 | /* Environment variable overrides everything, for debugging. */ | |
96 | if ((env_path = getenv("SIGROKDECODE_DIR"))) { | |
97 | if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { | |
98 | Py_Finalize(); | |
99 | return ret; | |
100 | } | |
101 | } | |
102 | ||
103 | return SRD_OK; | |
104 | } | |
105 | ||
106 | /** | |
107 | * Shutdown libsigrokdecode. | |
108 | * | |
109 | * This frees all the memory allocated for protocol decoders and shuts down | |
110 | * the Python interpreter. | |
111 | * | |
112 | * This function should only be called if there was a (successful!) invocation | |
113 | * of srd_init() before. Calling this function multiple times in a row, without | |
114 | * any successful srd_init() calls in between, is not allowed. | |
115 | * | |
116 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
117 | */ | |
118 | SRD_API int srd_exit(void) | |
119 | { | |
120 | srd_dbg("Exiting libsigrokdecode."); | |
121 | ||
122 | srd_decoder_unload_all(); | |
123 | g_slist_free(pd_list); | |
124 | pd_list = NULL; | |
125 | ||
126 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
127 | Py_Finalize(); | |
128 | ||
129 | return SRD_OK; | |
130 | } | |
131 | ||
132 | /** | |
133 | * Add an additional search directory for the protocol decoders. | |
134 | * | |
135 | * The specified directory is prepended (not appended!) to Python's sys.path, | |
136 | * in order to search for sigrok protocol decoders in the specified | |
137 | * directories first, and in the generic Python module directories (and in | |
138 | * the current working directory) last. This avoids conflicts if there are | |
139 | * Python modules which have the same name as a sigrok protocol decoder in | |
140 | * sys.path or in the current working directory. | |
141 | * | |
142 | * @param path Path to the directory containing protocol decoders which shall | |
143 | * be added to the Python sys.path, or NULL. | |
144 | * | |
145 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
146 | */ | |
147 | SRD_PRIV int srd_decoder_searchpath_add(const char *path) | |
148 | { | |
149 | PyObject *py_cur_path, *py_item; | |
150 | GString *new_path; | |
151 | int wc_len, i; | |
152 | wchar_t *wc_new_path; | |
153 | char *item; | |
154 | ||
155 | srd_dbg("Adding '%s' to module path.", path); | |
156 | ||
157 | new_path = g_string_sized_new(256); | |
158 | g_string_assign(new_path, g_strdup(path)); | |
159 | py_cur_path = PySys_GetObject("path"); | |
160 | for (i = 0; i < PyList_Size(py_cur_path); i++) { | |
161 | g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S)); | |
162 | py_item = PyList_GetItem(py_cur_path, i); | |
163 | if (!PyUnicode_Check(py_item)) | |
164 | /* Shouldn't happen. */ | |
165 | continue; | |
166 | if (py_str_as_str(py_item, &item) != SRD_OK) | |
167 | continue; | |
168 | g_string_append(new_path, item); | |
169 | } | |
170 | ||
171 | /* Convert to wide chars. */ | |
172 | wc_len = sizeof(wchar_t) * (new_path->len + 1); | |
173 | if (!(wc_new_path = g_try_malloc(wc_len))) { | |
174 | srd_dbg("malloc failed"); | |
175 | return SRD_ERR_MALLOC; | |
176 | } | |
177 | mbstowcs(wc_new_path, new_path->str, wc_len); | |
178 | PySys_SetPath(wc_new_path); | |
179 | g_string_free(new_path, TRUE); | |
180 | g_free(wc_new_path); | |
181 | ||
182 | //#ifdef _WIN32 | |
183 | // gchar **splitted; | |
184 | // | |
185 | // /* | |
186 | // * On Windows/MinGW, Python's sys.path needs entries of the form | |
187 | // * 'C:\\foo\\bar' instead of '/foo/bar'. | |
188 | // */ | |
189 | // | |
190 | // splitted = g_strsplit(DECODERS_DIR, "/", 0); | |
191 | // path = g_build_pathv("\\\\", splitted); | |
192 | // g_strfreev(splitted); | |
193 | //#else | |
194 | // path = g_strdup(DECODERS_DIR); | |
195 | //#endif | |
196 | ||
197 | return SRD_OK; | |
198 | } | |
199 | ||
200 | /** | |
201 | * Set one or more options in a decoder instance. | |
202 | * | |
203 | * Handled options are removed from the hash. | |
204 | * | |
205 | * @param di Decoder instance. | |
206 | * @param options A GHashTable of options to set. | |
207 | * | |
208 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
209 | */ | |
210 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, | |
211 | GHashTable *options) | |
212 | { | |
213 | PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; | |
214 | PyObject *py_optlist, *py_classval; | |
215 | Py_UNICODE *py_ustr; | |
216 | unsigned long long int val_ull; | |
217 | int num_optkeys, ret, size, i; | |
218 | char *key, *value; | |
219 | ||
220 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { | |
221 | /* Decoder has no options. */ | |
222 | if (g_hash_table_size(options) == 0) { | |
223 | /* No options provided. */ | |
224 | return SRD_OK; | |
225 | } else { | |
226 | srd_err("Protocol decoder has no options."); | |
227 | return SRD_ERR_ARG; | |
228 | } | |
229 | return SRD_OK; | |
230 | } | |
231 | ||
232 | ret = SRD_ERR_PYTHON; | |
233 | key = NULL; | |
234 | py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; | |
235 | py_optlist = py_classval = NULL; | |
236 | py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); | |
237 | ||
238 | /* All of these are synthesized objects, so they're good. */ | |
239 | py_dec_optkeys = PyDict_Keys(py_dec_options); | |
240 | num_optkeys = PyList_Size(py_dec_optkeys); | |
241 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) | |
242 | goto err_out; | |
243 | for (i = 0; i < num_optkeys; i++) { | |
244 | /* Get the default class value for this option. */ | |
245 | py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); | |
246 | if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) | |
247 | goto err_out; | |
248 | if (!(py_classval = PyList_GetItem(py_optlist, 1))) | |
249 | goto err_out; | |
250 | if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { | |
251 | srd_err("Options of type %s are not yet supported.", | |
252 | Py_TYPE(py_classval)->tp_name); | |
253 | goto err_out; | |
254 | } | |
255 | ||
256 | if ((value = g_hash_table_lookup(options, key))) { | |
257 | /* An override for this option was provided. */ | |
258 | if (PyUnicode_Check(py_classval)) { | |
259 | if (!(py_optval = PyUnicode_FromString(value))) { | |
260 | /* Some UTF-8 encoding error. */ | |
261 | PyErr_Clear(); | |
262 | goto err_out; | |
263 | } | |
264 | } else if (PyLong_Check(py_classval)) { | |
265 | if (!(py_optval = PyLong_FromString(value, NULL, 0))) { | |
266 | /* ValueError Exception */ | |
267 | PyErr_Clear(); | |
268 | srd_err("Option %s has invalid value " | |
269 | "%s: expected integer.", | |
270 | key, value); | |
271 | goto err_out; | |
272 | } | |
273 | } | |
274 | g_hash_table_remove(options, key); | |
275 | } else { | |
276 | /* Use the class default for this option. */ | |
277 | if (PyUnicode_Check(py_classval)) { | |
278 | /* Make a brand new copy of the string. */ | |
279 | py_ustr = PyUnicode_AS_UNICODE(py_classval); | |
280 | size = PyUnicode_GET_SIZE(py_classval); | |
281 | py_optval = PyUnicode_FromUnicode(py_ustr, size); | |
282 | } else if (PyLong_Check(py_classval)) { | |
283 | /* Make a brand new copy of the integer. */ | |
284 | val_ull = PyLong_AsUnsignedLongLong(py_classval); | |
285 | if (val_ull == (unsigned long long)-1) { | |
286 | /* OverFlowError exception */ | |
287 | PyErr_Clear(); | |
288 | srd_err("Invalid integer value for %s: " | |
289 | "expected integer.", key); | |
290 | goto err_out; | |
291 | } | |
292 | if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) | |
293 | goto err_out; | |
294 | } | |
295 | } | |
296 | ||
297 | /* | |
298 | * If we got here, py_optval holds a known good new reference | |
299 | * to the instance option to set. | |
300 | */ | |
301 | if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) | |
302 | goto err_out; | |
303 | } | |
304 | ||
305 | ret = SRD_OK; | |
306 | ||
307 | err_out: | |
308 | Py_XDECREF(py_optlist); | |
309 | Py_XDECREF(py_di_options); | |
310 | Py_XDECREF(py_dec_optkeys); | |
311 | Py_XDECREF(py_dec_options); | |
312 | g_free(key); | |
313 | if (PyErr_Occurred()) | |
314 | srd_exception_catch("Stray exception in srd_inst_option_set()."); | |
315 | ||
316 | return ret; | |
317 | } | |
318 | ||
319 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ | |
320 | static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) | |
321 | { | |
322 | return strcmp(a->id, probe_id); | |
323 | } | |
324 | ||
325 | /** | |
326 | * Set all probes in a decoder instance. | |
327 | * | |
328 | * This function sets _all_ probes for the specified decoder instance, i.e., | |
329 | * it overwrites any probes that were already defined (if any). | |
330 | * | |
331 | * @param di Decoder instance. | |
332 | * @param probes A GHashTable of probes to set. Key is probe name, value is | |
333 | * the probe number. Samples passed to this instance will be | |
334 | * arranged in this order. | |
335 | * | |
336 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
337 | */ | |
338 | SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, | |
339 | GHashTable *new_probes) | |
340 | { | |
341 | GList *l; | |
342 | GSList *sl; | |
343 | struct srd_probe *p; | |
344 | int *new_probemap, new_probenum; | |
345 | char *probe_id, *probenum_str; | |
346 | ||
347 | srd_dbg("set probes called for instance %s with list of %d probes", | |
348 | di->inst_id, g_hash_table_size(new_probes)); | |
349 | ||
350 | if (g_hash_table_size(new_probes) == 0) | |
351 | /* No probes provided. */ | |
352 | return SRD_OK; | |
353 | ||
354 | if (di->dec_num_probes == 0) { | |
355 | /* Decoder has no probes. */ | |
356 | srd_err("Protocol decoder %s has no probes to define.", | |
357 | di->decoder->name); | |
358 | return SRD_ERR_ARG; | |
359 | } | |
360 | ||
361 | new_probemap = NULL; | |
362 | ||
363 | if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { | |
364 | srd_err("Failed to g_malloc() new probe map."); | |
365 | return SRD_ERR_MALLOC; | |
366 | } | |
367 | ||
368 | for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { | |
369 | probe_id = l->data; | |
370 | probenum_str = g_hash_table_lookup(new_probes, probe_id); | |
371 | if (!probenum_str) { | |
372 | /* Probe name was specified without a value. */ | |
373 | srd_err("No probe number was specified for %s.", | |
374 | probe_id); | |
375 | g_free(new_probemap); | |
376 | return SRD_ERR_ARG; | |
377 | } | |
378 | new_probenum = strtol(probenum_str, NULL, 10); | |
379 | if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, | |
380 | (GCompareFunc)compare_probe_id))) { | |
381 | /* Fall back on optional probes. */ | |
382 | if (!(sl = g_slist_find_custom(di->decoder->opt_probes, | |
383 | probe_id, (GCompareFunc) compare_probe_id))) { | |
384 | srd_err("Protocol decoder %s has no probe " | |
385 | "'%s'.", di->decoder->name, probe_id); | |
386 | g_free(new_probemap); | |
387 | return SRD_ERR_ARG; | |
388 | } | |
389 | } | |
390 | p = sl->data; | |
391 | new_probemap[p->order] = new_probenum; | |
392 | srd_dbg("setting probe mapping for %d = probe %d", p->order, | |
393 | new_probenum); | |
394 | } | |
395 | g_free(di->dec_probemap); | |
396 | di->dec_probemap = new_probemap; | |
397 | ||
398 | return SRD_OK; | |
399 | } | |
400 | ||
401 | /** | |
402 | * Create a new protocol decoder instance. | |
403 | * | |
404 | * @param id Decoder 'id' field. | |
405 | * @param options GHashtable of options which override the defaults set in | |
406 | * the decoder class. | |
407 | * | |
408 | * @return Pointer to a newly allocated struct srd_decoder_inst, or | |
409 | * NULL in case of failure. | |
410 | */ | |
411 | SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, | |
412 | GHashTable *options) | |
413 | { | |
414 | int i; | |
415 | struct srd_decoder *dec; | |
416 | struct srd_decoder_inst *di; | |
417 | char *inst_id; | |
418 | ||
419 | srd_dbg("Creating new %s instance.", decoder_id); | |
420 | ||
421 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { | |
422 | srd_err("Protocol decoder %s not found.", decoder_id); | |
423 | return NULL; | |
424 | } | |
425 | ||
426 | if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { | |
427 | srd_err("Failed to g_malloc() instance."); | |
428 | return NULL; | |
429 | } | |
430 | ||
431 | inst_id = g_hash_table_lookup(options, "id"); | |
432 | di->decoder = dec; | |
433 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
434 | g_hash_table_remove(options, "id"); | |
435 | ||
436 | /* | |
437 | * Prepare a default probe map, where samples come in the | |
438 | * order in which the decoder class defined them. | |
439 | */ | |
440 | di->dec_num_probes = g_slist_length(di->decoder->probes) + | |
441 | g_slist_length(di->decoder->opt_probes); | |
442 | if (di->dec_num_probes) { | |
443 | if (!(di->dec_probemap = | |
444 | g_try_malloc(sizeof(int) * di->dec_num_probes))) { | |
445 | srd_err("Failed to g_malloc() probe map."); | |
446 | g_free(di); | |
447 | return NULL; | |
448 | } | |
449 | for (i = 0; i < di->dec_num_probes; i++) | |
450 | di->dec_probemap[i] = i; | |
451 | } | |
452 | ||
453 | /* Create a new instance of this decoder class. */ | |
454 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { | |
455 | if (PyErr_Occurred()) | |
456 | srd_exception_catch("failed to create %s instance: ", | |
457 | decoder_id); | |
458 | g_free(di->dec_probemap); | |
459 | g_free(di); | |
460 | return NULL; | |
461 | } | |
462 | ||
463 | if (srd_inst_option_set(di, options) != SRD_OK) { | |
464 | g_free(di->dec_probemap); | |
465 | g_free(di); | |
466 | return NULL; | |
467 | } | |
468 | ||
469 | /* Instance takes input from a frontend by default. */ | |
470 | di_list = g_slist_append(di_list, di); | |
471 | ||
472 | return di; | |
473 | } | |
474 | ||
475 | /** | |
476 | * Stack a decoder instance on top of another. | |
477 | * | |
478 | * @param di_from The instance to move. | |
479 | * @param di_to The instance on top of which di_from will be stacked. | |
480 | * | |
481 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
482 | */ | |
483 | SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, | |
484 | struct srd_decoder_inst *di_to) | |
485 | { | |
486 | if (!di_from || !di_to) { | |
487 | srd_err("Invalid from/to instance pair."); | |
488 | return SRD_ERR_ARG; | |
489 | } | |
490 | ||
491 | if (g_slist_find(di_list, di_to)) { | |
492 | /* Remove from the unstacked list. */ | |
493 | di_list = g_slist_remove(di_list, di_to); | |
494 | } | |
495 | ||
496 | /* Stack on top of source di. */ | |
497 | di_from->next_di = g_slist_append(di_from->next_di, di_to); | |
498 | ||
499 | return SRD_OK; | |
500 | } | |
501 | ||
502 | /** | |
503 | * Find a decoder instance by its instance ID. | |
504 | * | |
505 | * Only the bottom level of instances are searched -- instances already stacked | |
506 | * on top of another one will not be found. | |
507 | * | |
508 | * @param inst_id The instance ID to be found. | |
509 | * | |
510 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. | |
511 | */ | |
512 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) | |
513 | { | |
514 | GSList *l; | |
515 | struct srd_decoder_inst *tmp, *di; | |
516 | ||
517 | di = NULL; | |
518 | for (l = di_list; l; l = l->next) { | |
519 | tmp = l->data; | |
520 | if (!strcmp(tmp->inst_id, inst_id)) { | |
521 | di = tmp; | |
522 | break; | |
523 | } | |
524 | } | |
525 | ||
526 | return di; | |
527 | } | |
528 | ||
529 | /** | |
530 | * Find a decoder instance by its Python object. | |
531 | * | |
532 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
533 | * This will recurse to find the instance anywhere in the stack tree. | |
534 | * | |
535 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the | |
536 | * stack to search. To start searching at the bottom level of | |
537 | * decoder instances, pass NULL. | |
538 | * @param obj The Python class instantiation. | |
539 | * | |
540 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. | |
541 | */ | |
542 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, | |
543 | const PyObject *obj) | |
544 | { | |
545 | // TODO? | |
546 | const GSList *l; | |
547 | struct srd_decoder_inst *tmp, *di; | |
548 | ||
549 | di = NULL; | |
550 | for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { | |
551 | tmp = l->data; | |
552 | if (tmp->py_inst == obj) | |
553 | di = tmp; | |
554 | else if (tmp->next_di) | |
555 | di = srd_inst_find_by_obj(tmp->next_di, obj); | |
556 | } | |
557 | ||
558 | return di; | |
559 | } | |
560 | ||
561 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) | |
562 | { | |
563 | PyObject *py_name, *py_res; | |
564 | GSList *l; | |
565 | struct srd_decoder_inst *next_di; | |
566 | ||
567 | srd_dbg("Calling start() method on protocol decoder instance %s.", | |
568 | di->inst_id); | |
569 | ||
570 | if (!(py_name = PyUnicode_FromString("start"))) { | |
571 | srd_err("Unable to build Python object for 'start'."); | |
572 | srd_exception_catch("Protocol decoder instance %s: ", | |
573 | di->inst_id); | |
574 | return SRD_ERR_PYTHON; | |
575 | } | |
576 | ||
577 | if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, | |
578 | py_name, args, NULL))) { | |
579 | srd_exception_catch("Protocol decoder instance %s: ", | |
580 | di->inst_id); | |
581 | return SRD_ERR_PYTHON; | |
582 | } | |
583 | ||
584 | Py_DecRef(py_res); | |
585 | Py_DecRef(py_name); | |
586 | ||
587 | /* | |
588 | * Start all the PDs stacked on top of this one. Pass along the | |
589 | * metadata all the way from the bottom PD, even though it's only | |
590 | * applicable to logic data for now. | |
591 | */ | |
592 | for (l = di->next_di; l; l = l->next) { | |
593 | next_di = l->data; | |
594 | srd_inst_start(next_di, args); | |
595 | } | |
596 | ||
597 | return SRD_OK; | |
598 | } | |
599 | ||
600 | /** | |
601 | * Run the specified decoder function. | |
602 | * | |
603 | * @param start_samplenum The starting sample number for the buffer's sample | |
604 | * set, relative to the start of capture. | |
605 | * @param di The decoder instance to call. Must not be NULL. | |
606 | * @param inbuf The buffer to decode. Must not be NULL. | |
607 | * @param inbuflen Length of the buffer. Must be > 0. | |
608 | * | |
609 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
610 | */ | |
611 | SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, | |
612 | const struct srd_decoder_inst *di, | |
613 | const uint8_t *inbuf, uint64_t inbuflen) | |
614 | { | |
615 | PyObject *py_res; | |
616 | srd_logic *logic; | |
617 | uint64_t end_samplenum; | |
618 | ||
619 | srd_dbg("Calling decode() on instance %s with %d bytes starting " | |
620 | "at sample %d.", di->inst_id, inbuflen, start_samplenum); | |
621 | ||
622 | /* Return an error upon unusable input. */ | |
623 | if (!di) { | |
624 | srd_dbg("empty decoder instance"); | |
625 | return SRD_ERR_ARG; | |
626 | } | |
627 | if (!inbuf) { | |
628 | srd_dbg("NULL buffer pointer"); | |
629 | return SRD_ERR_ARG; | |
630 | } | |
631 | if (inbuflen == 0) { | |
632 | srd_dbg("empty buffer"); | |
633 | return SRD_ERR_ARG; | |
634 | } | |
635 | ||
636 | /* | |
637 | * Create new srd_logic object. Each iteration around the PD's loop | |
638 | * will fill one sample into this object. | |
639 | */ | |
640 | logic = PyObject_New(srd_logic, &srd_logic_type); | |
641 | Py_INCREF(logic); | |
642 | logic->di = (struct srd_decoder_inst *)di; | |
643 | logic->start_samplenum = start_samplenum; | |
644 | logic->itercnt = 0; | |
645 | logic->inbuf = (uint8_t *)inbuf; | |
646 | logic->inbuflen = inbuflen; | |
647 | logic->sample = PyList_New(2); | |
648 | Py_INCREF(logic->sample); | |
649 | ||
650 | Py_IncRef(di->py_inst); | |
651 | end_samplenum = start_samplenum + inbuflen / di->data_unitsize; | |
652 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", | |
653 | "KKO", logic->start_samplenum, | |
654 | end_samplenum, logic))) { | |
655 | srd_exception_catch("Protocol decoder instance %s: ", | |
656 | di->inst_id); | |
657 | return SRD_ERR_PYTHON; /* TODO: More specific error? */ | |
658 | } | |
659 | Py_DecRef(py_res); | |
660 | ||
661 | return SRD_OK; | |
662 | } | |
663 | ||
664 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) | |
665 | { | |
666 | GSList *l; | |
667 | struct srd_pd_output *pdo; | |
668 | ||
669 | srd_dbg("Freeing instance %s", di->inst_id); | |
670 | ||
671 | Py_DecRef(di->py_inst); | |
672 | g_free(di->inst_id); | |
673 | g_free(di->dec_probemap); | |
674 | g_slist_free(di->next_di); | |
675 | for (l = di->pd_output; l; l = l->next) { | |
676 | pdo = l->data; | |
677 | g_free(pdo->proto_id); | |
678 | g_free(pdo); | |
679 | } | |
680 | g_slist_free(di->pd_output); | |
681 | } | |
682 | ||
683 | SRD_PRIV void srd_inst_free_all(GSList *stack) | |
684 | { | |
685 | GSList *l; | |
686 | struct srd_decoder_inst *di; | |
687 | ||
688 | di = NULL; | |
689 | for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { | |
690 | di = l->data; | |
691 | if (di->next_di) | |
692 | srd_inst_free_all(di->next_di); | |
693 | srd_inst_free(di); | |
694 | } | |
695 | if (!stack) { | |
696 | g_slist_free(di_list); | |
697 | di_list = NULL; | |
698 | } | |
699 | } | |
700 | ||
701 | /** | |
702 | * Start a decoding session. | |
703 | * | |
704 | * Decoders, instances and stack must have been prepared beforehand. | |
705 | * | |
706 | * @param num_probes The number of probes which the incoming feed will contain. | |
707 | * @param unitsize The number of bytes per sample in the incoming feed. | |
708 | * @param samplerate The samplerate of the incoming feed. | |
709 | * | |
710 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
711 | */ | |
712 | SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) | |
713 | { | |
714 | PyObject *args; | |
715 | GSList *d; | |
716 | struct srd_decoder_inst *di; | |
717 | int ret; | |
718 | ||
719 | srd_dbg("Calling start() on all instances with %d probes, " | |
720 | "unitsize %d samplerate %d.", num_probes, unitsize, samplerate); | |
721 | ||
722 | /* | |
723 | * Currently only one item of metadata is passed along to decoders, | |
724 | * samplerate. This can be extended as needed. | |
725 | */ | |
726 | if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { | |
727 | srd_err("Unable to build Python object for metadata."); | |
728 | return SRD_ERR_PYTHON; | |
729 | } | |
730 | ||
731 | /* Run the start() method on all decoders receiving frontend data. */ | |
732 | for (d = di_list; d; d = d->next) { | |
733 | di = d->data; | |
734 | di->data_num_probes = num_probes; | |
735 | di->data_unitsize = unitsize; | |
736 | di->data_samplerate = samplerate; | |
737 | if ((ret = srd_inst_start(di, args) != SRD_OK)) | |
738 | break; | |
739 | } | |
740 | ||
741 | Py_DecRef(args); | |
742 | ||
743 | return ret; | |
744 | } | |
745 | ||
746 | /** | |
747 | * Send a chunk of logic sample data to a running decoder session. | |
748 | * | |
749 | * @param start_samplenum The sample number of the first sample in this chunk. | |
750 | * @param inbuf Pointer to sample data. | |
751 | * @param inbuf Length in bytes of the buffer. | |
752 | * | |
753 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
754 | */ | |
755 | SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, | |
756 | uint64_t inbuflen) | |
757 | { | |
758 | GSList *d; | |
759 | int ret; | |
760 | ||
761 | srd_dbg("Calling decode() on all instances with starting sample " | |
762 | "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", | |
763 | start_samplenum, inbuflen, inbuf); | |
764 | ||
765 | for (d = di_list; d; d = d->next) { | |
766 | if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, | |
767 | inbuflen)) != SRD_OK) | |
768 | return ret; | |
769 | } | |
770 | ||
771 | return SRD_OK; | |
772 | } | |
773 | ||
774 | /** | |
775 | * Register/add a decoder output callback function. | |
776 | * | |
777 | * The function will be called when a protocol decoder sends output back | |
778 | * to the PD controller (except for Python objects, which only go up the | |
779 | * stack). | |
780 | * | |
781 | * @param output_type The output type this callback will receive. Only one | |
782 | * callback per output type can be registered. | |
783 | * @param cb The function to call. Must not be NULL. | |
784 | * @param cb_data Private data for the callback function. Can be NULL. | |
785 | */ | |
786 | SRD_API int srd_pd_output_callback_add(int output_type, | |
787 | srd_pd_output_callback_t cb, void *cb_data) | |
788 | { | |
789 | struct srd_pd_callback *pd_cb; | |
790 | ||
791 | srd_dbg("Registering new callback for output type %d.", output_type); | |
792 | ||
793 | if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { | |
794 | srd_err("Failed to g_malloc() struct srd_pd_callback."); | |
795 | return SRD_ERR_MALLOC; | |
796 | } | |
797 | ||
798 | pd_cb->output_type = output_type; | |
799 | pd_cb->cb = cb; | |
800 | pd_cb->cb_data = cb_data; | |
801 | callbacks = g_slist_append(callbacks, pd_cb); | |
802 | ||
803 | return SRD_OK; | |
804 | } | |
805 | ||
806 | SRD_PRIV void *srd_pd_output_callback_find(int output_type) | |
807 | { | |
808 | GSList *l; | |
809 | struct srd_pd_callback *pd_cb; | |
810 | void *(cb); | |
811 | ||
812 | cb = NULL; | |
813 | for (l = callbacks; l; l = l->next) { | |
814 | pd_cb = l->data; | |
815 | if (pd_cb->output_type == output_type) { | |
816 | cb = pd_cb->cb; | |
817 | break; | |
818 | } | |
819 | } | |
820 | ||
821 | return cb; | |
822 | } | |
823 | ||
824 | /* This is the backend function to Python sigrokdecode.add() call. */ | |
825 | SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, | |
826 | int output_type, const char *proto_id) | |
827 | { | |
828 | struct srd_pd_output *pdo; | |
829 | ||
830 | srd_dbg("Instance %s creating new output type %d for %s.", | |
831 | di->inst_id, output_type, proto_id); | |
832 | ||
833 | if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { | |
834 | srd_err("Failed to g_malloc() struct srd_pd_output."); | |
835 | return -1; | |
836 | } | |
837 | ||
838 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ | |
839 | pdo->pdo_id = g_slist_length(di->pd_output); | |
840 | pdo->output_type = output_type; | |
841 | pdo->di = di; | |
842 | pdo->proto_id = g_strdup(proto_id); | |
843 | di->pd_output = g_slist_append(di->pd_output, pdo); | |
844 | ||
845 | return pdo->pdo_id; | |
846 | } |