blob: 1c94d7a29a0e43a3c76496c11ba28e1099876828 [file] [log] [blame]
Bert Vermeulenb2c19612011-12-04 10:33:02 +01001/*
Uwe Hermann50bd5d22013-04-23 22:27:20 +02002 * This file is part of the libsigrokdecode project.
Bert Vermeulenb2c19612011-12-04 10:33:02 +01003 *
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +01005 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
Bert Vermeulenb2c19612011-12-04 10:33:02 +01006 *
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
Uwe Hermannc1f86f02013-05-03 14:49:21 +020021#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22#include "libsigrokdecode-internal.h"
Bert Vermeulen7ce77752012-01-10 00:25:16 +010023#include "config.h"
Bert Vermeulenb2c19612011-12-04 10:33:02 +010024#include <glib.h>
Bert Vermeulen1aef2f92011-12-15 03:31:31 +010025#include <inttypes.h>
Bert Vermeulen0bdadba2012-01-17 03:37:34 +010026#include <stdlib.h>
Bert Vermeulen32cfb922013-09-12 23:54:43 +020027#include <stdint.h>
Bert Vermeulenb2c19612011-12-04 10:33:02 +010028
Uwe Hermannd7dae842013-02-09 21:32:31 +010029/**
30 * @mainpage libsigrokdecode API
31 *
32 * @section sec_intro Introduction
33 *
34 * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
35 * portable, cross-platform, Free/Libre/Open-Source signal analysis software
36 * suite that supports various device types (such as logic analyzers,
37 * oscilloscopes, multimeters, and more).
38 *
39 * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a
40 * shared library written in C which provides the basic API for (streaming)
41 * protocol decoding functionality.
42 *
43 * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
44 * are written in Python (>= 3.0).
45 *
46 * @section sec_api API reference
47 *
48 * See the "Modules" page for an introduction to various libsigrokdecode
49 * related topics and the detailed API documentation of the respective
50 * functions.
51 *
52 * You can also browse the API documentation by file, or review all
53 * data structures.
54 *
55 * @section sec_mailinglists Mailing lists
56 *
57 * There are two mailing lists for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
58 *
59 * @section sec_irc IRC
60 *
61 * You can find the sigrok developers in the
62 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
63 * IRC channel on Freenode.
64 *
65 * @section sec_website Website
66 *
67 * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
68 */
69
70/**
71 * @file
72 *
73 * Initializing and shutting down libsigrokdecode.
74 */
75
76/**
77 * @defgroup grp_init Initialization
78 *
79 * Initializing and shutting down libsigrokdecode.
80 *
81 * Before using any of the libsigrokdecode functionality, srd_init() must
82 * be called to initialize the library.
83 *
84 * When libsigrokdecode functionality is no longer needed, srd_exit() should
85 * be called.
86 *
87 * @{
88 */
89
Uwe Hermann57790bc2013-02-09 21:44:11 +010090/** @cond PRIVATE */
91
Bert Vermeulenfe9d91a2013-11-16 23:14:50 +010092extern GSList *sessions;
93extern int max_session_id;
Bert Vermeulen32cfb922013-09-12 23:54:43 +020094
Uwe Hermannc9bfccc2012-02-08 22:39:30 +010095/* decoder.c */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +010096extern SRD_PRIV GSList *pd_list;
Bert Vermeulenb2c19612011-12-04 10:33:02 +010097
Uwe Hermannc9bfccc2012-02-08 22:39:30 +010098/* module_sigrokdecode.c */
Uwe Hermann53a07a62012-04-16 23:10:26 +020099extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100100
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100101/* type_logic.c */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100102extern SRD_PRIV PyTypeObject srd_logic_type;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100103
Uwe Hermann57790bc2013-02-09 21:44:11 +0100104/** @endcond */
105
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100106/**
107 * Initialize libsigrokdecode.
108 *
109 * This initializes the Python interpreter, and creates and initializes
Uwe Hermann361fdca2012-03-15 22:00:24 +0100110 * a "sigrokdecode" Python module.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100111 *
Uwe Hermann4cc0d9f2013-05-03 21:21:30 +0200112 * Then, it searches for sigrok protocol decoders in the "decoders"
113 * subdirectory of the the libsigrokdecode installation directory.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100114 * All decoders that are found are loaded into memory and added to an
Uwe Hermann4cc0d9f2013-05-03 21:21:30 +0200115 * internal list of decoders, which can be queried via srd_decoder_list().
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100116 *
117 * The caller is responsible for calling the clean-up function srd_exit(),
118 * which will properly shut down libsigrokdecode and free its allocated memory.
119 *
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100120 * Multiple calls to srd_init(), without calling srd_exit() in between,
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100121 * are not allowed.
122 *
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100123 * @param path Path to an extra directory containing protocol decoders
Uwe Hermann4cc0d9f2013-05-03 21:21:30 +0200124 * which will be added to the Python sys.path. May be NULL.
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100125 *
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100126 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann4cc0d9f2013-05-03 21:21:30 +0200127 * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
128 * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
129 * If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200130 *
131 * @since 0.1.0
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100132 */
Uwe Hermannabeeed82012-03-16 15:12:54 +0100133SRD_API int srd_init(const char *path)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100134{
135 int ret;
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100136 char *env_path;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100137
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200138 if (max_session_id != -1) {
139 srd_err("libsigrokdecode is already initialized.");
140 return SRD_ERR;
141 }
142
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100143 srd_dbg("Initializing libsigrokdecode.");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100144
145 /* Add our own module to the list of built-in modules. */
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100146 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
Bert Vermeulen5f802ec2011-12-27 22:15:53 +0100147
Uwe Hermann511e2122012-02-10 09:29:38 +0100148 /* Initialize the Python interpreter. */
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100149 Py_Initialize();
150
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100151 /* Installed decoders. */
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200152 if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100153 Py_Finalize();
154 return ret;
155 }
156
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100157 /* Path specified by the user. */
158 if (path) {
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200159 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100160 Py_Finalize();
161 return ret;
162 }
163 }
164
165 /* Environment variable overrides everything, for debugging. */
166 if ((env_path = getenv("SIGROKDECODE_DIR"))) {
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200167 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100168 Py_Finalize();
169 return ret;
170 }
171 }
172
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200173 max_session_id = 0;
174
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100175 return SRD_OK;
176}
177
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100178/**
179 * Shutdown libsigrokdecode.
180 *
181 * This frees all the memory allocated for protocol decoders and shuts down
182 * the Python interpreter.
183 *
184 * This function should only be called if there was a (successful!) invocation
185 * of srd_init() before. Calling this function multiple times in a row, without
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100186 * any successful srd_init() calls in between, is not allowed.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100187 *
188 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200189 *
190 * @since 0.1.0
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100191 */
Uwe Hermann55c3c5f2012-02-09 19:11:53 +0100192SRD_API int srd_exit(void)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100193{
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200194 GSList *l;
195
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100196 srd_dbg("Exiting libsigrokdecode.");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100197
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200198 for (l = sessions; l; l = l->next)
199 srd_session_destroy((struct srd_session *)l->data);
200
Uwe Hermann8ad6e502012-03-16 15:25:53 +0100201 srd_decoder_unload_all();
Bert Vermeulene5080882011-12-07 09:56:49 +0100202 g_slist_free(pd_list);
Uwe Hermann96c52592012-03-20 18:02:45 +0100203 pd_list = NULL;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100204
205 /* Py_Finalize() returns void, any finalization errors are ignored. */
206 Py_Finalize();
207
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200208 max_session_id = -1;
209
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100210 return SRD_OK;
211}
212
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100213/**
Uwe Hermann9d9fcb32012-01-23 19:58:06 +0100214 * Add an additional search directory for the protocol decoders.
215 *
216 * The specified directory is prepended (not appended!) to Python's sys.path,
217 * in order to search for sigrok protocol decoders in the specified
218 * directories first, and in the generic Python module directories (and in
219 * the current working directory) last. This avoids conflicts if there are
220 * Python modules which have the same name as a sigrok protocol decoder in
221 * sys.path or in the current working directory.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100222 *
Uwe Hermann361fdca2012-03-15 22:00:24 +0100223 * @param path Path to the directory containing protocol decoders which shall
224 * be added to the Python sys.path, or NULL.
Uwe Hermann9d9fcb32012-01-23 19:58:06 +0100225 *
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100226 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann57790bc2013-02-09 21:44:11 +0100227 *
228 * @private
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200229 *
230 * @since 0.1.0
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100231 */
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200232SRD_PRIV int srd_decoder_searchpath_add(const char *path)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100233{
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100234 PyObject *py_cur_path, *py_item;
235 GString *new_path;
236 int wc_len, i;
237 wchar_t *wc_new_path;
238 char *item;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100239
Uwe Hermann8ad6e502012-03-16 15:25:53 +0100240 srd_dbg("Adding '%s' to module path.", path);
Uwe Hermann639c5682012-01-19 00:21:00 +0100241
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100242 new_path = g_string_sized_new(256);
Bert Vermeulene592ac82013-05-05 17:20:13 +0200243 g_string_assign(new_path, path);
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100244 py_cur_path = PySys_GetObject("path");
245 for (i = 0; i < PyList_Size(py_cur_path); i++) {
Bert Vermeulene592ac82013-05-05 17:20:13 +0200246 g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S);
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100247 py_item = PyList_GetItem(py_cur_path, i);
248 if (!PyUnicode_Check(py_item))
249 /* Shouldn't happen. */
250 continue;
251 if (py_str_as_str(py_item, &item) != SRD_OK)
252 continue;
253 g_string_append(new_path, item);
Bert Vermeulene592ac82013-05-05 17:20:13 +0200254 g_free(item);
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100255 }
Uwe Hermann639c5682012-01-19 00:21:00 +0100256
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100257 /* Convert to wide chars. */
258 wc_len = sizeof(wchar_t) * (new_path->len + 1);
259 if (!(wc_new_path = g_try_malloc(wc_len))) {
260 srd_dbg("malloc failed");
261 return SRD_ERR_MALLOC;
262 }
263 mbstowcs(wc_new_path, new_path->str, wc_len);
264 PySys_SetPath(wc_new_path);
265 g_string_free(new_path, TRUE);
266 g_free(wc_new_path);
Uwe Hermann639c5682012-01-19 00:21:00 +0100267
Bert Vermeulen65e1c7d2012-02-12 04:07:22 +0100268 return SRD_OK;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100269}
270
Uwe Hermann48954182013-02-09 22:25:15 +0100271/** @} */
272
273/**
274 * @defgroup grp_instances Decoder instances
275 *
276 * Decoder instance handling.
277 *
278 * @{
279 */
280
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100281/**
Uwe Hermannb33b8aa2012-03-25 14:49:11 +0200282 * Set one or more options in a decoder instance.
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100283 *
Uwe Hermann361fdca2012-03-15 22:00:24 +0100284 * Handled options are removed from the hash.
285 *
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100286 * @param di Decoder instance.
287 * @param options A GHashTable of options to set.
288 *
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100289 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200290 *
291 * @since 0.1.0
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100292 */
Uwe Hermannb33b8aa2012-03-25 14:49:11 +0200293SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
Bert Vermeulen0ff2d192013-03-19 01:01:25 +0100294 GHashTable *options)
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100295{
296 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
297 PyObject *py_optlist, *py_classval;
298 Py_UNICODE *py_ustr;
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100299 GVariant *value;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100300 unsigned long long int val_ull;
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100301 gint64 val_int;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100302 int num_optkeys, ret, size, i;
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100303 const char *val_str;
304 char *dbg, *key;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100305
Uwe Hermann3af0e342013-10-23 19:23:40 +0200306 if (!di) {
307 srd_err("Invalid decoder instance.");
308 return SRD_ERR_ARG;
309 }
310
311 if (!options) {
312 srd_err("Invalid options GHashTable.");
313 return SRD_ERR_ARG;
314 }
315
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100316 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100317 /* Decoder has no options. */
Bert Vermeulene431d9c2012-01-18 22:59:14 +0100318 if (g_hash_table_size(options) == 0) {
319 /* No options provided. */
320 return SRD_OK;
321 } else {
322 srd_err("Protocol decoder has no options.");
323 return SRD_ERR_ARG;
324 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100325 return SRD_OK;
Bert Vermeulene431d9c2012-01-18 22:59:14 +0100326 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100327
328 ret = SRD_ERR_PYTHON;
329 key = NULL;
330 py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
331 py_optlist = py_classval = NULL;
332 py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100333
334 /* All of these are synthesized objects, so they're good. */
335 py_dec_optkeys = PyDict_Keys(py_dec_options);
336 num_optkeys = PyList_Size(py_dec_optkeys);
Bert Vermeulen119d6252013-10-17 16:27:54 +0200337
338 /*
339 * The 'options' dictionary is a class variable, but we need to
340 * change it. Changing it directly will affect the entire class,
341 * so we need to create a new object for it, and populate that
342 * instead.
343 */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100344 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100345 goto err_out;
Bert Vermeulen119d6252013-10-17 16:27:54 +0200346 Py_DECREF(py_di_options);
347 py_di_options = PyDict_New();
348 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100349 for (i = 0; i < num_optkeys; i++) {
350 /* Get the default class value for this option. */
351 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
352 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
353 goto err_out;
354 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
355 goto err_out;
Bert Vermeulen130ef082012-01-19 00:00:02 +0100356 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100357 srd_err("Options of type %s are not yet supported.",
358 Py_TYPE(py_classval)->tp_name);
Bert Vermeulen130ef082012-01-19 00:00:02 +0100359 goto err_out;
360 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100361
362 if ((value = g_hash_table_lookup(options, key))) {
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100363 dbg = g_variant_print(value, TRUE);
364 srd_dbg("got option '%s' = %s", key, dbg);
365 g_free(dbg);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100366 /* An override for this option was provided. */
367 if (PyUnicode_Check(py_classval)) {
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100368 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
369 srd_err("Option '%s' requires a string value.", key);
370 goto err_out;
371 }
372 val_str = g_variant_get_string(value, NULL);
373 if (!(py_optval = PyUnicode_FromString(val_str))) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100374 /* Some UTF-8 encoding error. */
375 PyErr_Clear();
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100376 srd_err("Option '%s' requires a UTF-8 string value.", key);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100377 goto err_out;
378 }
379 } else if (PyLong_Check(py_classval)) {
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100380 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
381 srd_err("Option '%s' requires an integer value.", key);
382 goto err_out;
383 }
384 val_int = g_variant_get_int64(value);
385 if (!(py_optval = PyLong_FromLong(val_int))) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100386 /* ValueError Exception */
387 PyErr_Clear();
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100388 srd_err("Option '%s' has invalid integer value.", key);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100389 goto err_out;
390 }
391 }
392 g_hash_table_remove(options, key);
393 } else {
394 /* Use the class default for this option. */
395 if (PyUnicode_Check(py_classval)) {
396 /* Make a brand new copy of the string. */
397 py_ustr = PyUnicode_AS_UNICODE(py_classval);
398 size = PyUnicode_GET_SIZE(py_classval);
399 py_optval = PyUnicode_FromUnicode(py_ustr, size);
400 } else if (PyLong_Check(py_classval)) {
401 /* Make a brand new copy of the integer. */
402 val_ull = PyLong_AsUnsignedLongLong(py_classval);
403 if (val_ull == (unsigned long long)-1) {
404 /* OverFlowError exception */
405 PyErr_Clear();
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100406 srd_err("Invalid integer value for %s: "
407 "expected integer.", key);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100408 goto err_out;
409 }
410 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
411 goto err_out;
412 }
413 }
414
Uwe Hermann361fdca2012-03-15 22:00:24 +0100415 /*
416 * If we got here, py_optval holds a known good new reference
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100417 * to the instance option to set.
418 */
419 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
420 goto err_out;
Bert Vermeulene592ac82013-05-05 17:20:13 +0200421 g_free(key);
Bert Vermeulenb88e3362013-05-23 11:24:25 +0200422 key = NULL;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100423 }
424
425 ret = SRD_OK;
426
427err_out:
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100428 Py_XDECREF(py_di_options);
429 Py_XDECREF(py_dec_optkeys);
430 Py_XDECREF(py_dec_options);
Uwe Hermann6f858312012-01-28 21:26:26 +0100431 g_free(key);
Bert Vermeulen7fc7bde2013-10-16 11:10:27 +0200432 if (PyErr_Occurred()) {
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200433 srd_exception_catch("Stray exception in srd_inst_option_set().");
Bert Vermeulen7fc7bde2013-10-16 11:10:27 +0200434 ret = SRD_ERR_PYTHON;
435 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100436
437 return ret;
438}
439
Uwe Hermannb33b8aa2012-03-25 14:49:11 +0200440/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
Uwe Hermannabeeed82012-03-16 15:12:54 +0100441static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100442{
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100443 return strcmp(a->id, probe_id);
444}
445
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100446/**
Uwe Hermannb33b8aa2012-03-25 14:49:11 +0200447 * Set all probes in a decoder instance.
448 *
449 * This function sets _all_ probes for the specified decoder instance, i.e.,
450 * it overwrites any probes that were already defined (if any).
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100451 *
452 * @param di Decoder instance.
Uwe Hermann38ff5042013-02-02 12:18:29 +0100453 * @param new_probes A GHashTable of probes to set. Key is probe name, value is
454 * the probe number. Samples passed to this instance will be
455 * arranged in this order.
Bert Vermeulen12243c22012-02-12 14:18:32 +0100456 *
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100457 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200458 *
459 * @since 0.1.0
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100460 */
Uwe Hermannb33b8aa2012-03-25 14:49:11 +0200461SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
Bert Vermeulen0ff2d192013-03-19 01:01:25 +0100462 GHashTable *new_probes)
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100463{
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100464 GVariant *probe_val;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100465 GList *l;
466 GSList *sl;
467 struct srd_probe *p;
Bert Vermeulened416492013-10-30 16:30:05 +0100468 int *new_probemap, new_probenum, num_required_probes, num_probes, i;
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100469 char *probe_id;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100470
Bert Vermeulence46bee2012-01-27 08:21:58 +0100471 srd_dbg("set probes called for instance %s with list of %d probes",
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100472 di->inst_id, g_hash_table_size(new_probes));
Bert Vermeulence46bee2012-01-27 08:21:58 +0100473
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100474 if (g_hash_table_size(new_probes) == 0)
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100475 /* No probes provided. */
476 return SRD_OK;
477
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100478 if (di->dec_num_probes == 0) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100479 /* Decoder has no probes. */
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100480 srd_err("Protocol decoder %s has no probes to define.",
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100481 di->decoder->name);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100482 return SRD_ERR_ARG;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100483 }
484
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100485 new_probemap = NULL;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100486
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100487 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
Uwe Hermanna61ece22012-02-10 00:06:58 +0100488 srd_err("Failed to g_malloc() new probe map.");
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100489 return SRD_ERR_MALLOC;
490 }
491
Uwe Hermann38ff5042013-02-02 12:18:29 +0100492 /*
493 * For now, map all indexes to probe -1 (can be overridden later).
494 * This -1 is interpreted as an unspecified probe later.
495 */
496 for (i = 0; i < di->dec_num_probes; i++)
497 new_probemap[i] = -1;
498
Bert Vermeulened416492013-10-30 16:30:05 +0100499 num_probes = 0;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100500 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
501 probe_id = l->data;
Bert Vermeulen69075812013-10-30 15:22:10 +0100502 probe_val = g_hash_table_lookup(new_probes, probe_id);
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100503 if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
Bert Vermeulenbe873262012-01-23 19:34:23 +0100504 /* Probe name was specified without a value. */
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100505 srd_err("No probe number was specified for %s.",
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100506 probe_id);
Bert Vermeulenbe873262012-01-23 19:34:23 +0100507 g_free(new_probemap);
508 return SRD_ERR_ARG;
509 }
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100510 new_probenum = g_variant_get_int32(probe_val);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100511 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
512 (GCompareFunc)compare_probe_id))) {
513 /* Fall back on optional probes. */
Bert Vermeulendcdf4882012-02-01 00:07:55 +0100514 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100515 probe_id, (GCompareFunc) compare_probe_id))) {
516 srd_err("Protocol decoder %s has no probe "
Bert Vermeulen2f395bf2013-03-19 01:47:53 +0100517 "'%s'.", di->decoder->name, probe_id);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100518 g_free(new_probemap);
519 return SRD_ERR_ARG;
520 }
521 }
522 p = sl->data;
523 new_probemap[p->order] = new_probenum;
Uwe Hermann38ff5042013-02-02 12:18:29 +0100524 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
525 p->id, p->order, new_probenum);
Bert Vermeulened416492013-10-30 16:30:05 +0100526 num_probes++;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100527 }
Bert Vermeulened416492013-10-30 16:30:05 +0100528 di->data_unitsize = (num_probes + 7) / 8;
Uwe Hermann38ff5042013-02-02 12:18:29 +0100529
530 srd_dbg("Final probe map:");
531 num_required_probes = g_slist_length(di->decoder->probes);
532 for (i = 0; i < di->dec_num_probes; i++) {
533 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
534 (i < num_required_probes) ? "required" : "optional");
535 }
536
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100537 g_free(di->dec_probemap);
538 di->dec_probemap = new_probemap;
539
540 return SRD_OK;
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100541}
542
543/**
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100544 * Create a new protocol decoder instance.
545 *
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200546 * @param sess The session holding the protocol decoder instance.
Uwe Hermann38ff5042013-02-02 12:18:29 +0100547 * @param decoder_id Decoder 'id' field.
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100548 * @param options GHashtable of options which override the defaults set in
Uwe Hermann38ff5042013-02-02 12:18:29 +0100549 * the decoder class. May be NULL.
Bert Vermeulen12243c22012-02-12 14:18:32 +0100550 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100551 * @return Pointer to a newly allocated struct srd_decoder_inst, or
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100552 * NULL in case of failure.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200553 *
Bert Vermeulen69075812013-10-30 15:22:10 +0100554 * @since 0.3.0
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100555 */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200556SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
557 const char *decoder_id, GHashTable *options)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100558{
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100559 int i;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100560 struct srd_decoder *dec;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100561 struct srd_decoder_inst *di;
562 char *inst_id;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100563
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100564 srd_dbg("Creating new %s instance.", decoder_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100565
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200566 if (session_is_valid(sess) != SRD_OK) {
567 srd_err("Invalid session.");
568 return NULL;
569 }
570
Bert Vermeulen9d122fd2012-02-14 03:43:28 +0100571 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100572 srd_err("Protocol decoder %s not found.", decoder_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100573 return NULL;
574 }
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100575
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100576 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
Uwe Hermanna61ece22012-02-10 00:06:58 +0100577 srd_err("Failed to g_malloc() instance.");
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100578 return NULL;
579 }
580
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100581 di->decoder = dec;
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200582 di->sess = sess;
Uwe Hermann38ff5042013-02-02 12:18:29 +0100583 if (options) {
584 inst_id = g_hash_table_lookup(options, "id");
585 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
586 g_hash_table_remove(options, "id");
587 } else
588 di->inst_id = g_strdup(decoder_id);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100589
Uwe Hermann361fdca2012-03-15 22:00:24 +0100590 /*
591 * Prepare a default probe map, where samples come in the
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100592 * order in which the decoder class defined them.
593 */
594 di->dec_num_probes = g_slist_length(di->decoder->probes) +
Bert Vermeulen69075812013-10-30 15:22:10 +0100595 g_slist_length(di->decoder->opt_probes);
Bert Vermeulen19a90ba2012-01-21 19:45:04 +0100596 if (di->dec_num_probes) {
Uwe Hermannc9bfccc2012-02-08 22:39:30 +0100597 if (!(di->dec_probemap =
Bert Vermeulen69075812013-10-30 15:22:10 +0100598 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
Uwe Hermanna61ece22012-02-10 00:06:58 +0100599 srd_err("Failed to g_malloc() probe map.");
Bert Vermeulen19a90ba2012-01-21 19:45:04 +0100600 g_free(di);
601 return NULL;
602 }
603 for (i = 0; i < di->dec_num_probes; i++)
604 di->dec_probemap[i] = i;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100605 }
Bert Vermeulened416492013-10-30 16:30:05 +0100606 di->data_unitsize = (di->dec_num_probes + 7) / 8;
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100607
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100608 /* Create a new instance of this decoder class. */
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100609 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100610 if (PyErr_Occurred())
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200611 srd_exception_catch("failed to create %s instance: ",
Bert Vermeulen69075812013-10-30 15:22:10 +0100612 decoder_id);
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100613 g_free(di->dec_probemap);
614 g_free(di);
615 return NULL;
616 }
617
Uwe Hermann38ff5042013-02-02 12:18:29 +0100618 if (options && srd_inst_option_set(di, options) != SRD_OK) {
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100619 g_free(di->dec_probemap);
Bert Vermeulen0bdadba2012-01-17 03:37:34 +0100620 g_free(di);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100621 return NULL;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100622 }
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100623
624 /* Instance takes input from a frontend by default. */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200625 sess->di_list = g_slist_append(sess->di_list, di);
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100626
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100627 return di;
628}
629
Bert Vermeulen582c8472012-02-12 14:55:20 +0100630/**
631 * Stack a decoder instance on top of another.
632 *
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200633 * @param sess The session holding the protocol decoder instances.
Bert Vermeulen582c8472012-02-12 14:55:20 +0100634 * @param di_from The instance to move.
635 * @param di_to The instance on top of which di_from will be stacked.
636 *
637 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200638 *
Bert Vermeulen69075812013-10-30 15:22:10 +0100639 * @since 0.3.0
Bert Vermeulen582c8472012-02-12 14:55:20 +0100640 */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200641SRD_API int srd_inst_stack(struct srd_session *sess,
642 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to)
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100643{
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200644
645 if (session_is_valid(sess) != SRD_OK) {
646 srd_err("Invalid session.");
647 return SRD_ERR_ARG;
648 }
649
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100650 if (!di_from || !di_to) {
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100651 srd_err("Invalid from/to instance pair.");
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100652 return SRD_ERR_ARG;
653 }
654
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200655 if (g_slist_find(sess->di_list, di_to)) {
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100656 /* Remove from the unstacked list. */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200657 sess->di_list = g_slist_remove(sess->di_list, di_to);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100658 }
659
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100660 /* Stack on top of source di. */
661 di_from->next_di = g_slist_append(di_from->next_di, di_to);
662
663 return SRD_OK;
664}
665
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100666/**
Uwe Hermann361fdca2012-03-15 22:00:24 +0100667 * Find a decoder instance by its instance ID.
668 *
669 * Only the bottom level of instances are searched -- instances already stacked
670 * on top of another one will not be found.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100671 *
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200672 * @param sess The session holding the protocol decoder instance.
Uwe Hermanned2306a2012-03-18 14:16:50 +0100673 * @param inst_id The instance ID to be found.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100674 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100675 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200676 *
Bert Vermeulen69075812013-10-30 15:22:10 +0100677 * @since 0.3.0
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100678 */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200679SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
680 const char *inst_id)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100681{
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100682 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100683 struct srd_decoder_inst *tmp, *di;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100684
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200685 if (session_is_valid(sess) != SRD_OK) {
686 srd_err("Invalid session.");
687 return NULL;
688 }
689
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100690 di = NULL;
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200691 for (l = sess->di_list; l; l = l->next) {
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100692 tmp = l->data;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100693 if (!strcmp(tmp->inst_id, inst_id)) {
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100694 di = tmp;
695 break;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100696 }
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100697 }
698
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100699 return di;
700}
701
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200702static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
703 struct srd_session *sess, const GSList *stack,
704 const PyObject *obj)
705{
706 const GSList *l;
707 struct srd_decoder_inst *tmp, *di;
708
709 if (session_is_valid(sess) != SRD_OK) {
710 srd_err("Invalid session.");
711 return NULL;
712 }
713
714 di = NULL;
715 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
716 tmp = l->data;
717 if (tmp->py_inst == obj)
718 di = tmp;
719 else if (tmp->next_di)
720 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
721 }
722
723 return di;
724}
725
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100726/**
Uwe Hermann361fdca2012-03-15 22:00:24 +0100727 * Find a decoder instance by its Python object.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100728 *
Uwe Hermann361fdca2012-03-15 22:00:24 +0100729 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200730 * This will recurse to find the instance anywhere in the stack tree of all
731 * sessions.
Uwe Hermann361fdca2012-03-15 22:00:24 +0100732 *
733 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
734 * stack to search. To start searching at the bottom level of
735 * decoder instances, pass NULL.
Uwe Hermann511e2122012-02-10 09:29:38 +0100736 * @param obj The Python class instantiation.
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100737 *
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100738 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
Uwe Hermann57790bc2013-02-09 21:44:11 +0100739 *
740 * @private
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200741 *
742 * @since 0.1.0
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100743 */
Uwe Hermannabeeed82012-03-16 15:12:54 +0100744SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
Bert Vermeulen0ff2d192013-03-19 01:01:25 +0100745 const PyObject *obj)
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100746{
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200747 struct srd_decoder_inst *di;
748 struct srd_session *sess;
749 GSList *l;
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100750
751 di = NULL;
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200752 for (l = sessions; di == NULL && l != NULL; l = l->next) {
753 sess = l->data;
754 di = srd_sess_inst_find_by_obj(sess, stack, obj);
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100755 }
756
757 return di;
758}
759
Uwe Hermann57790bc2013-02-09 21:44:11 +0100760/** @private */
Bert Vermeulened416492013-10-30 16:30:05 +0100761SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100762{
Bert Vermeulened416492013-10-30 16:30:05 +0100763 PyObject *py_res;
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100764 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100765 struct srd_decoder_inst *next_di;
Bert Vermeulened416492013-10-30 16:30:05 +0100766 int ret;
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100767
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100768 srd_dbg("Calling start() method on protocol decoder instance %s.",
Bert Vermeulened416492013-10-30 16:30:05 +0100769 di->inst_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100770
Bert Vermeulened416492013-10-30 16:30:05 +0100771 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
Uwe Hermannaafeeae2012-03-25 15:08:16 +0200772 srd_exception_catch("Protocol decoder instance %s: ",
Bert Vermeulened416492013-10-30 16:30:05 +0100773 di->inst_id);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100774 return SRD_ERR_PYTHON;
775 }
Bert Vermeulenf38ec282012-01-20 22:25:42 +0100776 Py_DecRef(py_res);
Bert Vermeulen7ce77752012-01-10 00:25:16 +0100777
Bert Vermeulened416492013-10-30 16:30:05 +0100778 /* Start all the PDs stacked on top of this one. */
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100779 for (l = di->next_di; l; l = l->next) {
780 next_di = l->data;
Bert Vermeulened416492013-10-30 16:30:05 +0100781 if ((ret = srd_inst_start(next_di)) != SRD_OK)
782 return ret;
Bert Vermeulen2072ae02012-01-25 01:49:35 +0100783 }
784
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100785 return SRD_OK;
786}
787
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100788/**
789 * Run the specified decoder function.
790 *
Bert Vermeulened416492013-10-30 16:30:05 +0100791 * @param di The decoder instance to call. Must not be NULL.
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100792 * @param start_samplenum The starting sample number for the buffer's sample
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100793 * set, relative to the start of capture.
Bert Vermeulened416492013-10-30 16:30:05 +0100794 * @param end_samplenum The ending sample number for the buffer's sample
795 * set, relative to the start of capture.
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100796 * @param inbuf The buffer to decode. Must not be NULL.
797 * @param inbuflen Length of the buffer. Must be > 0.
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100798 *
799 * @return SRD_OK upon success, a (negative) error code otherwise.
Uwe Hermann57790bc2013-02-09 21:44:11 +0100800 *
801 * @private
Uwe Hermann8c664ca2013-05-03 14:45:49 +0200802 *
803 * @since 0.1.0
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100804 */
Bert Vermeulened416492013-10-30 16:30:05 +0100805SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
806 uint64_t start_samplenum, uint64_t end_samplenum,
807 const uint8_t *inbuf, uint64_t inbuflen)
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100808{
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100809 PyObject *py_res;
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100810 srd_logic *logic;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100811
Uwe Hermann74bb0af2013-10-20 23:09:46 +0200812 srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
813 "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
814 start_samplenum);
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100815
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100816 /* Return an error upon unusable input. */
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100817 if (!di) {
818 srd_dbg("empty decoder instance");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100819 return SRD_ERR_ARG;
820 }
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100821 if (!inbuf) {
822 srd_dbg("NULL buffer pointer");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100823 return SRD_ERR_ARG;
824 }
825 if (inbuflen == 0) {
Uwe Hermann7a1712c2012-01-26 01:15:10 +0100826 srd_dbg("empty buffer");
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100827 return SRD_ERR_ARG;
828 }
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100829
Uwe Hermann361fdca2012-03-15 22:00:24 +0100830 /*
831 * Create new srd_logic object. Each iteration around the PD's loop
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100832 * will fill one sample into this object.
833 */
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100834 logic = PyObject_New(srd_logic, &srd_logic_type);
835 Py_INCREF(logic);
Uwe Hermannabeeed82012-03-16 15:12:54 +0100836 logic->di = (struct srd_decoder_inst *)di;
Bert Vermeulen86528292012-01-15 23:20:39 +0100837 logic->start_samplenum = start_samplenum;
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100838 logic->itercnt = 0;
Uwe Hermannabeeed82012-03-16 15:12:54 +0100839 logic->inbuf = (uint8_t *)inbuf;
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100840 logic->inbuflen = inbuflen;
841 logic->sample = PyList_New(2);
842 Py_INCREF(logic->sample);
843
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100844 Py_IncRef(di->py_inst);
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100845 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
Bert Vermeulened416492013-10-30 16:30:05 +0100846 "KKO", start_samplenum, end_samplenum, logic))) {
847 srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
Bert Vermeulen0ff2d192013-03-19 01:01:25 +0100848 return SRD_ERR_PYTHON;
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100849 }
Bert Vermeulend906d3f2012-01-22 02:51:49 +0100850 Py_DecRef(py_res);
Bert Vermeulenbc5f5a42012-01-05 03:31:36 +0100851
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100852 return SRD_OK;
853}
854
Uwe Hermann57790bc2013-02-09 21:44:11 +0100855/** @private */
Bert Vermeulen12243c22012-02-12 14:18:32 +0100856SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100857{
858 GSList *l;
859 struct srd_pd_output *pdo;
860
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100861 srd_dbg("Freeing instance %s", di->inst_id);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100862
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100863 Py_DecRef(di->py_inst);
864 g_free(di->inst_id);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100865 g_free(di->dec_probemap);
866 g_slist_free(di->next_di);
867 for (l = di->pd_output; l; l = l->next) {
868 pdo = l->data;
869 g_free(pdo->proto_id);
870 g_free(pdo);
871 }
872 g_slist_free(di->pd_output);
Bert Vermeulene592ac82013-05-05 17:20:13 +0200873 g_free(di);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100874}
875
Uwe Hermann57790bc2013-02-09 21:44:11 +0100876/** @private */
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200877SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100878{
879 GSList *l;
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100880 struct srd_decoder_inst *di;
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100881
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200882 if (session_is_valid(sess) != SRD_OK) {
883 srd_err("Invalid session.");
884 return;
885 }
886
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100887 di = NULL;
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200888 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100889 di = l->data;
890 if (di->next_di)
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200891 srd_inst_free_all(sess, di->next_di);
Bert Vermeulena8b72b02012-02-11 18:06:56 +0100892 srd_inst_free(di);
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100893 }
894 if (!stack) {
Bert Vermeulen32cfb922013-09-12 23:54:43 +0200895 g_slist_free(sess->di_list);
896 sess->di_list = NULL;
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100897 }
Bert Vermeulenfa12a212012-01-31 23:48:10 +0100898}
Bert Vermeulenb2c19612011-12-04 10:33:02 +0100899
Uwe Hermann48954182013-02-09 22:25:15 +0100900/** @} */
901