X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=1c94d7a29a0e43a3c76496c11ba28e1099876828;hp=fa67004b22caf0b35e3014ea22d52eeac3c51101;hb=fe9d91a88a8896ef04d12682720943b237c0a295;hpb=11ea8ae1b2279566125978766735a26252dff412 diff --git a/controller.c b/controller.c index fa67004..1c94d7a 100644 --- a/controller.c +++ b/controller.c @@ -1,5 +1,5 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrokdecode project. * * Copyright (C) 2010 Uwe Hermann * Copyright (C) 2012 Bert Vermeulen @@ -18,37 +18,101 @@ * along with this program. If not, see . */ -#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ -#include "sigrokdecode-internal.h" +#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode-internal.h" #include "config.h" #include #include #include +#include +/** + * @mainpage libsigrokdecode API + * + * @section sec_intro Introduction + * + * The sigrok project aims at creating a + * portable, cross-platform, Free/Libre/Open-Source signal analysis software + * suite that supports various device types (such as logic analyzers, + * oscilloscopes, multimeters, and more). + * + * libsigrokdecode is a + * shared library written in C which provides the basic API for (streaming) + * protocol decoding functionality. + * + * The protocol decoders + * are written in Python (>= 3.0). + * + * @section sec_api API reference + * + * See the "Modules" page for an introduction to various libsigrokdecode + * related topics and the detailed API documentation of the respective + * functions. + * + * You can also browse the API documentation by file, or review all + * data structures. + * + * @section sec_mailinglists Mailing lists + * + * There are two mailing lists for sigrok/libsigrokdecode: sigrok-devel and sigrok-commits. + * + * @section sec_irc IRC + * + * You can find the sigrok developers in the + * \#sigrok + * IRC channel on Freenode. + * + * @section sec_website Website + * + * sigrok.org/wiki/Libsigrokdecode + */ + +/** + * @file + * + * Initializing and shutting down libsigrokdecode. + */ + +/** + * @defgroup grp_init Initialization + * + * Initializing and shutting down libsigrokdecode. + * + * Before using any of the libsigrokdecode functionality, srd_init() must + * be called to initialize the library. + * + * When libsigrokdecode functionality is no longer needed, srd_exit() should + * be called. + * + * @{ + */ -static GSList *di_list = NULL; -static GSList *callbacks = NULL; +/** @cond PRIVATE */ -/* lives in decoder.c */ -extern GSList *pd_list; +extern GSList *sessions; +extern int max_session_id; -/* lives in module_sigrokdecode.c */ +/* decoder.c */ +extern SRD_PRIV GSList *pd_list; + +/* module_sigrokdecode.c */ extern PyMODINIT_FUNC PyInit_sigrokdecode(void); -/* lives in type_logic.c */ -extern PyTypeObject srd_logic_type; +/* type_logic.c */ +extern SRD_PRIV PyTypeObject srd_logic_type; +/** @endcond */ /** * Initialize libsigrokdecode. * * This initializes the Python interpreter, and creates and initializes - * a "sigrok" Python module with a single put() method. + * a "sigrokdecode" Python module. * - * Then, it searches for sigrok protocol decoder files (*.py) in the - * "decoders" subdirectory of the the sigrok installation directory. + * Then, it searches for sigrok protocol decoders in the "decoders" + * subdirectory of the the libsigrokdecode installation directory. * All decoders that are found are loaded into memory and added to an - * internal list of decoders, which can be queried via srd_list_decoders(). + * internal list of decoders, which can be queried via srd_decoder_list(). * * The caller is responsible for calling the clean-up function srd_exit(), * which will properly shut down libsigrokdecode and free its allocated memory. @@ -56,34 +120,61 @@ extern PyTypeObject srd_logic_type; * Multiple calls to srd_init(), without calling srd_exit() in between, * are not allowed. * + * @param path Path to an extra directory containing protocol decoders + * which will be added to the Python sys.path. May be NULL. + * * @return SRD_OK upon success, a (negative) error code otherwise. - * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders - * directory cannot be accessed, return SRD_ERR_DECODERS_DIR. - * If not enough memory could be allocated, return SRD_ERR_MALLOC. + * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders + * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned. + * If not enough memory could be allocated, SRD_ERR_MALLOC is returned. + * + * @since 0.1.0 */ -int srd_init(void) +SRD_API int srd_init(const char *path) { int ret; + char *env_path; + + if (max_session_id != -1) { + srd_err("libsigrokdecode is already initialized."); + return SRD_ERR; + } + + srd_dbg("Initializing libsigrokdecode."); + /* Add our own module to the list of built-in modules. */ PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); - /* Py_Initialize() returns void and usually cannot fail. */ + /* Initialize the Python interpreter. */ Py_Initialize(); - if ((ret = set_modulepath()) != SRD_OK) { + /* Installed decoders. */ + if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { Py_Finalize(); return ret; } - if ((ret = srd_load_all_decoders()) != SRD_OK) { - Py_Finalize(); - return ret; + /* Path specified by the user. */ + if (path) { + if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { + Py_Finalize(); + return ret; + } + } + + /* Environment variable overrides everything, for debugging. */ + if ((env_path = getenv("SIGROKDECODE_DIR"))) { + if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { + Py_Finalize(); + return ret; + } } + max_session_id = 0; + return SRD_OK; } - /** * Shutdown libsigrokdecode. * @@ -95,81 +186,134 @@ int srd_init(void) * any successful srd_init() calls in between, is not allowed. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ -int srd_exit(void) +SRD_API int srd_exit(void) { - /* Unload/free all decoders, and then the list of decoders itself. */ - /* TODO: Error handling. */ - srd_unload_all_decoders(); + GSList *l; + + srd_dbg("Exiting libsigrokdecode."); + + for (l = sessions; l; l = l->next) + srd_session_destroy((struct srd_session *)l->data); + + srd_decoder_unload_all(); g_slist_free(pd_list); + pd_list = NULL; /* Py_Finalize() returns void, any finalization errors are ignored. */ Py_Finalize(); + max_session_id = -1; + return SRD_OK; } - /** - * Add search directories for the protocol decoders. + * Add an additional search directory for the protocol decoders. + * + * The specified directory is prepended (not appended!) to Python's sys.path, + * in order to search for sigrok protocol decoders in the specified + * directories first, and in the generic Python module directories (and in + * the current working directory) last. This avoids conflicts if there are + * Python modules which have the same name as a sigrok protocol decoder in + * sys.path or in the current working directory. + * + * @param path Path to the directory containing protocol decoders which shall + * be added to the Python sys.path, or NULL. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @private * - * TODO: add path from env var SIGROKDECODE_PATH, config etc - * TODO: Should take directoryname/path as input. + * @since 0.1.0 */ -int set_modulepath(void) +SRD_PRIV int srd_decoder_searchpath_add(const char *path) { - int ret; - gchar *path, *s; - -#ifdef _WIN32 - gchar **splitted; - - /* - * On Windows/MinGW, Python's sys.path needs entries of the form - * 'C:\\foo\\bar' instead of '/foo/bar'. - */ - - splitted = g_strsplit(DECODERS_DIR, "/", 0); - path = g_build_pathv("\\\\", splitted); - g_strfreev(splitted); -#else - path = g_strdup(DECODERS_DIR); -#endif - - /* TODO: Prepend instead of appending. */ - /* TODO: Sanity check on 'path' (length, escape special chars, ...). */ - s = g_strdup_printf("import sys; sys.path.append(r'%s')", path); - - ret = PyRun_SimpleString(s); + PyObject *py_cur_path, *py_item; + GString *new_path; + int wc_len, i; + wchar_t *wc_new_path; + char *item; + + srd_dbg("Adding '%s' to module path.", path); + + new_path = g_string_sized_new(256); + g_string_assign(new_path, path); + py_cur_path = PySys_GetObject("path"); + for (i = 0; i < PyList_Size(py_cur_path); i++) { + g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S); + py_item = PyList_GetItem(py_cur_path, i); + if (!PyUnicode_Check(py_item)) + /* Shouldn't happen. */ + continue; + if (py_str_as_str(py_item, &item) != SRD_OK) + continue; + g_string_append(new_path, item); + g_free(item); + } - g_free(path); - g_free(s); + /* Convert to wide chars. */ + wc_len = sizeof(wchar_t) * (new_path->len + 1); + if (!(wc_new_path = g_try_malloc(wc_len))) { + srd_dbg("malloc failed"); + return SRD_ERR_MALLOC; + } + mbstowcs(wc_new_path, new_path->str, wc_len); + PySys_SetPath(wc_new_path); + g_string_free(new_path, TRUE); + g_free(wc_new_path); - return ret; + return SRD_OK; } +/** @} */ /** - * Set options in a decoder instance. + * @defgroup grp_instances Decoder instances * - * @param di Decoder instance. - * @param options A GHashTable of options to set. + * Decoder instance handling. + * + * @{ + */ + +/** + * Set one or more options in a decoder instance. * * Handled options are removed from the hash. * + * @param di Decoder instance. + * @param options A GHashTable of options to set. + * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ -int srd_instance_set_options(struct srd_decoder_instance *di, +SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, GHashTable *options) { PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; PyObject *py_optlist, *py_classval; Py_UNICODE *py_ustr; + GVariant *value; unsigned long long int val_ull; + gint64 val_int; int num_optkeys, ret, size, i; - char *key, *value; + const char *val_str; + char *dbg, *key; - if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) { + if (!di) { + srd_err("Invalid decoder instance."); + return SRD_ERR_ARG; + } + + if (!options) { + srd_err("Invalid options GHashTable."); + return SRD_ERR_ARG; + } + + if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { /* Decoder has no options. */ if (g_hash_table_size(options) == 0) { /* No options provided. */ @@ -190,8 +334,18 @@ int srd_instance_set_options(struct srd_decoder_instance *di, /* All of these are synthesized objects, so they're good. */ py_dec_optkeys = PyDict_Keys(py_dec_options); num_optkeys = PyList_Size(py_dec_optkeys); - if (!(py_di_options = PyObject_GetAttrString(di->py_instance, "options"))) + + /* + * The 'options' dictionary is a class variable, but we need to + * change it. Changing it directly will affect the entire class, + * so we need to create a new object for it, and populate that + * instead. + */ + if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) goto err_out; + Py_DECREF(py_di_options); + py_di_options = PyDict_New(); + PyObject_SetAttrString(di->py_inst, "options", py_di_options); for (i = 0; i < num_optkeys; i++) { /* Get the default class value for this option. */ py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); @@ -200,24 +354,38 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (!(py_classval = PyList_GetItem(py_optlist, 1))) goto err_out; if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { - srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name); + srd_err("Options of type %s are not yet supported.", + Py_TYPE(py_classval)->tp_name); goto err_out; } if ((value = g_hash_table_lookup(options, key))) { + dbg = g_variant_print(value, TRUE); + srd_dbg("got option '%s' = %s", key, dbg); + g_free(dbg); /* An override for this option was provided. */ if (PyUnicode_Check(py_classval)) { - if (!(py_optval = PyUnicode_FromString(value))) { + if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { + srd_err("Option '%s' requires a string value.", key); + goto err_out; + } + val_str = g_variant_get_string(value, NULL); + if (!(py_optval = PyUnicode_FromString(val_str))) { /* Some UTF-8 encoding error. */ PyErr_Clear(); + srd_err("Option '%s' requires a UTF-8 string value.", key); goto err_out; } } else if (PyLong_Check(py_classval)) { - if (!(py_optval = PyLong_FromString(value, NULL, 0))) { + if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { + srd_err("Option '%s' requires an integer value.", key); + goto err_out; + } + val_int = g_variant_get_int64(value); + if (!(py_optval = PyLong_FromLong(val_int))) { /* ValueError Exception */ PyErr_Clear(); - srd_err("Option %s has invalid value %s: expected integer", - key, value); + srd_err("Option '%s' has invalid integer value.", key); goto err_out; } } @@ -235,7 +403,8 @@ int srd_instance_set_options(struct srd_decoder_instance *di, if (val_ull == (unsigned long long)-1) { /* OverFlowError exception */ PyErr_Clear(); - srd_err("Invalid integer value for %s: expected integer", key); + srd_err("Invalid integer value for %s: " + "expected integer.", key); goto err_out; } if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) @@ -243,138 +412,250 @@ int srd_instance_set_options(struct srd_decoder_instance *di, } } - /* If we got here, py_optval holds a known good new reference + /* + * If we got here, py_optval holds a known good new reference * to the instance option to set. */ if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) goto err_out; + g_free(key); + key = NULL; } ret = SRD_OK; err_out: - Py_XDECREF(py_optlist); Py_XDECREF(py_di_options); Py_XDECREF(py_dec_optkeys); Py_XDECREF(py_dec_options); - if (key) - g_free(key); + g_free(key); if (PyErr_Occurred()) { - srd_dbg("stray exception!"); - PyErr_Print(); - PyErr_Clear(); + srd_exception_catch("Stray exception in srd_inst_option_set()."); + ret = SRD_ERR_PYTHON; } return ret; } +/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ +static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) +{ + return strcmp(a->id, probe_id); +} + /** - * Set probes in a decoder instance. + * Set all probes in a decoder instance. * - * @param di Decoder instance. - * @param probes A GHashTable of probes to set. Key is probe name, value is - * the probe number. Samples passed to this instance will be arranged in this - * order. + * This function sets _all_ probes for the specified decoder instance, i.e., + * it overwrites any probes that were already defined (if any). * - * Handled probes are removed from the hash. + * @param di Decoder instance. + * @param new_probes A GHashTable of probes to set. Key is probe name, value is + * the probe number. Samples passed to this instance will be + * arranged in this order. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ -int srd_instance_set_probes(struct srd_decoder_instance *di, - GHashTable *probes) +SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, + GHashTable *new_probes) { - int ret; + GVariant *probe_val; + GList *l; + GSList *sl; + struct srd_probe *p; + int *new_probemap, new_probenum, num_required_probes, num_probes, i; + char *probe_id; + + srd_dbg("set probes called for instance %s with list of %d probes", + di->inst_id, g_hash_table_size(new_probes)); - if (g_hash_table_size(probes) == 0) + if (g_hash_table_size(new_probes) == 0) /* No probes provided. */ return SRD_OK; - if(!PyObject_HasAttrString(di->decoder->py_dec, "probes")) + if (di->dec_num_probes == 0) { /* Decoder has no probes. */ - return SRD_OK; + srd_err("Protocol decoder %s has no probes to define.", + di->decoder->name); + return SRD_ERR_ARG; + } - ret = SRD_ERR_PYTHON; + new_probemap = NULL; - /* TODO */ - if (g_hash_table_size(probes) > 0) { - srd_err("Setting probes is not yet supported."); - return SRD_ERR_PYTHON; + if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { + srd_err("Failed to g_malloc() new probe map."); + return SRD_ERR_MALLOC; } - ret = SRD_OK; + /* + * For now, map all indexes to probe -1 (can be overridden later). + * This -1 is interpreted as an unspecified probe later. + */ + for (i = 0; i < di->dec_num_probes; i++) + new_probemap[i] = -1; + + num_probes = 0; + for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { + probe_id = l->data; + probe_val = g_hash_table_lookup(new_probes, probe_id); + if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) { + /* Probe name was specified without a value. */ + srd_err("No probe number was specified for %s.", + probe_id); + g_free(new_probemap); + return SRD_ERR_ARG; + } + new_probenum = g_variant_get_int32(probe_val); + if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, + (GCompareFunc)compare_probe_id))) { + /* Fall back on optional probes. */ + if (!(sl = g_slist_find_custom(di->decoder->opt_probes, + probe_id, (GCompareFunc) compare_probe_id))) { + srd_err("Protocol decoder %s has no probe " + "'%s'.", di->decoder->name, probe_id); + g_free(new_probemap); + return SRD_ERR_ARG; + } + } + p = sl->data; + new_probemap[p->order] = new_probenum; + srd_dbg("Setting probe mapping: %s (index %d) = probe %d.", + p->id, p->order, new_probenum); + num_probes++; + } + di->data_unitsize = (num_probes + 7) / 8; - return ret; + srd_dbg("Final probe map:"); + num_required_probes = g_slist_length(di->decoder->probes); + for (i = 0; i < di->dec_num_probes; i++) { + srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i], + (i < num_required_probes) ? "required" : "optional"); + } + + g_free(di->dec_probemap); + di->dec_probemap = new_probemap; + + return SRD_OK; } /** * Create a new protocol decoder instance. * - * @param id Decoder 'id' field. + * @param sess The session holding the protocol decoder instance. + * @param decoder_id Decoder 'id' field. * @param options GHashtable of options which override the defaults set in - * the decoder class. - * @return Pointer to a newly allocated struct srd_decoder_instance, or - * NULL in case of failure. + * the decoder class. May be NULL. + * + * @return Pointer to a newly allocated struct srd_decoder_inst, or + * NULL in case of failure. + * + * @since 0.3.0 */ -struct srd_decoder_instance *srd_instance_new(const char *decoder_id, - GHashTable *options) +SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, + const char *decoder_id, GHashTable *options) { + int i; struct srd_decoder *dec; - struct srd_decoder_instance *di; - char *instance_id; + struct srd_decoder_inst *di; + char *inst_id; - srd_dbg("%s: creating new %s instance", __func__, decoder_id); + srd_dbg("Creating new %s instance.", decoder_id); + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return NULL; + } - if (!(dec = srd_get_decoder_by_id(decoder_id))) { + if (!(dec = srd_decoder_get_by_id(decoder_id))) { srd_err("Protocol decoder %s not found.", decoder_id); return NULL; } - if (!(di = g_try_malloc0(sizeof(*di)))) { - srd_err("Failed to malloc instance."); + if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { + srd_err("Failed to g_malloc() instance."); return NULL; } - instance_id = g_hash_table_lookup(options, "id"); di->decoder = dec; - di->instance_id = g_strdup(instance_id ? instance_id : decoder_id); - g_hash_table_remove(options, "id"); + di->sess = sess; + if (options) { + inst_id = g_hash_table_lookup(options, "id"); + di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); + g_hash_table_remove(options, "id"); + } else + di->inst_id = g_strdup(decoder_id); + + /* + * Prepare a default probe map, where samples come in the + * order in which the decoder class defined them. + */ + di->dec_num_probes = g_slist_length(di->decoder->probes) + + g_slist_length(di->decoder->opt_probes); + if (di->dec_num_probes) { + if (!(di->dec_probemap = + g_try_malloc(sizeof(int) * di->dec_num_probes))) { + srd_err("Failed to g_malloc() probe map."); + g_free(di); + return NULL; + } + for (i = 0; i < di->dec_num_probes; i++) + di->dec_probemap[i] = i; + } + di->data_unitsize = (di->dec_num_probes + 7) / 8; /* Create a new instance of this decoder class. */ - if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) { + if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { if (PyErr_Occurred()) - PyErr_Print(); + srd_exception_catch("failed to create %s instance: ", + decoder_id); + g_free(di->dec_probemap); g_free(di); return NULL; } - /* Instance takes input from a frontend by default. */ - di_list = g_slist_append(di_list, di); - - if (srd_instance_set_options(di, options) != SRD_OK) { - di_list = g_slist_remove(di_list, di); + if (options && srd_inst_option_set(di, options) != SRD_OK) { + g_free(di->dec_probemap); g_free(di); return NULL; } + /* Instance takes input from a frontend by default. */ + sess->di_list = g_slist_append(sess->di_list, di); + return di; } -int srd_instance_stack(struct srd_decoder_instance *di_from, - struct srd_decoder_instance *di_to) +/** + * Stack a decoder instance on top of another. + * + * @param sess The session holding the protocol decoder instances. + * @param di_from The instance to move. + * @param di_to The instance on top of which di_from will be stacked. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.3.0 + */ +SRD_API int srd_inst_stack(struct srd_session *sess, + struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to) { - if (!di_from || !di_to) { - srd_err("invalid from/to instance pair"); + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); return SRD_ERR_ARG; } - if (!g_slist_find(di_list, di_from)) { - srd_err("unstacked instance not found"); + if (!di_from || !di_to) { + srd_err("Invalid from/to instance pair."); return SRD_ERR_ARG; } - /* Remove from the unstacked list. */ - di_list = g_slist_remove(di_list, di_to); + if (g_slist_find(sess->di_list, di_to)) { + /* Remove from the unstacked list. */ + sess->di_list = g_slist_remove(sess->di_list, di_to); + } /* Stack on top of source di. */ di_from->next_di = g_slist_append(di_from->next_di, di_to); @@ -382,17 +663,34 @@ int srd_instance_stack(struct srd_decoder_instance *di_from, return SRD_OK; } - -/* TODO: this should go into the PD stack */ -struct srd_decoder_instance *srd_instance_find(char *instance_id) +/** + * Find a decoder instance by its instance ID. + * + * Only the bottom level of instances are searched -- instances already stacked + * on top of another one will not be found. + * + * @param sess The session holding the protocol decoder instance. + * @param inst_id The instance ID to be found. + * + * @return Pointer to struct srd_decoder_inst, or NULL if not found. + * + * @since 0.3.0 + */ +SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, + const char *inst_id) { GSList *l; - struct srd_decoder_instance *tmp, *di; + struct srd_decoder_inst *tmp, *di; + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return NULL; + } di = NULL; - for (l = di_list; l; l = l->next) { + for (l = sess->di_list; l; l = l->next) { tmp = l->data; - if (!strcmp(tmp->instance_id, instance_id)) { + if (!strcmp(tmp->inst_id, inst_id)) { di = tmp; break; } @@ -401,28 +699,88 @@ struct srd_decoder_instance *srd_instance_find(char *instance_id) return di; } -int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) +static struct srd_decoder_inst *srd_sess_inst_find_by_obj( + struct srd_session *sess, const GSList *stack, + const PyObject *obj) { - PyObject *py_name, *py_res; + const GSList *l; + struct srd_decoder_inst *tmp, *di; - srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id); + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return NULL; + } - if (!(py_name = PyUnicode_FromString("start"))) { - srd_err("unable to build python object for 'start'"); - if (PyErr_Occurred()) - PyErr_Print(); - return SRD_ERR_PYTHON; + di = NULL; + for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { + tmp = l->data; + if (tmp->py_inst == obj) + di = tmp; + else if (tmp->next_di) + di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); } - if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance, - py_name, args, NULL))) { - if (PyErr_Occurred()) - PyErr_Print(); + return di; +} + +/** + * Find a decoder instance by its Python object. + * + * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. + * This will recurse to find the instance anywhere in the stack tree of all + * sessions. + * + * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the + * stack to search. To start searching at the bottom level of + * decoder instances, pass NULL. + * @param obj The Python class instantiation. + * + * @return Pointer to struct srd_decoder_inst, or NULL if not found. + * + * @private + * + * @since 0.1.0 + */ +SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, + const PyObject *obj) +{ + struct srd_decoder_inst *di; + struct srd_session *sess; + GSList *l; + + di = NULL; + for (l = sessions; di == NULL && l != NULL; l = l->next) { + sess = l->data; + di = srd_sess_inst_find_by_obj(sess, stack, obj); + } + + return di; +} + +/** @private */ +SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) +{ + PyObject *py_res; + GSList *l; + struct srd_decoder_inst *next_di; + int ret; + + srd_dbg("Calling start() method on protocol decoder instance %s.", + di->inst_id); + + if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { + srd_exception_catch("Protocol decoder instance %s: ", + di->inst_id); return SRD_ERR_PYTHON; } + Py_DecRef(py_res); - Py_XDECREF(py_res); - Py_DECREF(py_name); + /* Start all the PDs stacked on top of this one. */ + for (l = di->next_di; l; l = l->next) { + next_di = l->data; + if ((ret = srd_inst_start(next_di)) != SRD_OK) + return ret; + } return SRD_OK; } @@ -430,174 +788,114 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) /** * Run the specified decoder function. * - * @param dec TODO - * @param inbuf TODO - * @param inbuflen TODO + * @param di The decoder instance to call. Must not be NULL. + * @param start_samplenum The starting sample number for the buffer's sample + * set, relative to the start of capture. + * @param end_samplenum The ending sample number for the buffer's sample + * set, relative to the start of capture. + * @param inbuf The buffer to decode. Must not be NULL. + * @param inbuflen Length of the buffer. Must be > 0. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @private + * + * @since 0.1.0 */ -int srd_instance_decode(uint64_t start_samplenum, - struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen) +SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di, + uint64_t start_samplenum, uint64_t end_samplenum, + const uint8_t *inbuf, uint64_t inbuflen) { - PyObject *py_instance, *py_res; + PyObject *py_res; srd_logic *logic; - uint64_t end_samplenum; - /* Return an error upon unusable input. */ - if (di == NULL) - return SRD_ERR_ARG; /* TODO: More specific error? */ - if (inbuf == NULL) - return SRD_ERR_ARG; /* TODO: More specific error? */ - if (inbuflen == 0) /* No point in working on empty buffers. */ - return SRD_ERR_ARG; /* TODO: More specific error? */ + srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes " + "starting at sample %" PRIu64 ".", di->inst_id, inbuflen, + start_samplenum); - /* TODO: Error handling. */ - py_instance = di->py_instance; - Py_XINCREF(py_instance); + /* Return an error upon unusable input. */ + if (!di) { + srd_dbg("empty decoder instance"); + return SRD_ERR_ARG; + } + if (!inbuf) { + srd_dbg("NULL buffer pointer"); + return SRD_ERR_ARG; + } + if (inbuflen == 0) { + srd_dbg("empty buffer"); + return SRD_ERR_ARG; + } + /* + * Create new srd_logic object. Each iteration around the PD's loop + * will fill one sample into this object. + */ logic = PyObject_New(srd_logic, &srd_logic_type); Py_INCREF(logic); - logic->di = di; + logic->di = (struct srd_decoder_inst *)di; logic->start_samplenum = start_samplenum; logic->itercnt = 0; - logic->inbuf = inbuf; + logic->inbuf = (uint8_t *)inbuf; logic->inbuflen = inbuflen; logic->sample = PyList_New(2); Py_INCREF(logic->sample); - end_samplenum = start_samplenum + inbuflen / di->unitsize; - if (!(py_res = PyObject_CallMethod(py_instance, "decode", - "KKO", logic->start_samplenum, end_samplenum, logic))) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - - return SRD_ERR_PYTHON; /* TODO: More specific error? */ + Py_IncRef(di->py_inst); + if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", + "KKO", start_samplenum, end_samplenum, logic))) { + srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); + return SRD_ERR_PYTHON; } - - Py_XDECREF(py_res); + Py_DecRef(py_res); return SRD_OK; } - -int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) +/** @private */ +SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) { - PyObject *args; - GSList *d, *s; - struct srd_decoder_instance *di; - int ret; - - if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { - srd_err("unable to build python object for metadata"); - return SRD_ERR_PYTHON; - } + GSList *l; + struct srd_pd_output *pdo; - /* Run the start() method on all decoders receiving frontend data. */ - for (d = di_list; d; d = d->next) { - di = d->data; - di->num_probes = num_probes; - di->unitsize = unitsize; - di->samplerate = samplerate; - if ((ret = srd_instance_start(di, args) != SRD_OK)) - return ret; + srd_dbg("Freeing instance %s", di->inst_id); - /* Run the start() method on all decoders up the stack from this one. */ - for (s = di->next_di; s; s = s->next) { - /* These don't need probes, unitsize and samplerate. */ - di = s->data; - if ((ret = srd_instance_start(di, args) != SRD_OK)) - return ret; - } + Py_DecRef(di->py_inst); + g_free(di->inst_id); + g_free(di->dec_probemap); + g_slist_free(di->next_di); + for (l = di->pd_output; l; l = l->next) { + pdo = l->data; + g_free(pdo->proto_id); + g_free(pdo); } - - Py_DECREF(args); - - return SRD_OK; + g_slist_free(di->pd_output); + g_free(di); } -/* Feed logic samples to decoder session. */ -int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen) +/** @private */ +SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) { - GSList *d; - int ret; + GSList *l; + struct srd_decoder_inst *di; - for (d = di_list; d; d = d->next) { - if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf, - inbuflen)) != SRD_OK) - return ret; + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return; } - return SRD_OK; -} - - -int pd_add(struct srd_decoder_instance *di, int output_type, - char *proto_id) -{ - struct srd_pd_output *pdo; - - if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) - return -1; - - /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ - pdo->pdo_id = g_slist_length(di->pd_output); - pdo->output_type = output_type; - pdo->decoder = di->decoder; - pdo->proto_id = g_strdup(proto_id); - di->pd_output = g_slist_append(di->pd_output, pdo); - - return pdo->pdo_id; -} - -struct srd_decoder_instance *get_di_by_decobject(void *decobject) -{ - GSList *l, *s; - struct srd_decoder_instance *di; - - for (l = di_list; l; l = l->next) { + di = NULL; + for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { di = l->data; - if (decobject == di->py_instance) - return di; - /* Check decoders stacked on top of this one. */ - for (s = di->next_di; s; s = s->next) { - di = s->data; - if (decobject == di->py_instance) - return di; - } + if (di->next_di) + srd_inst_free_all(sess, di->next_di); + srd_inst_free(di); } - - return NULL; -} - -int srd_register_callback(int output_type, void *cb) -{ - struct srd_pd_callback *pd_cb; - - if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) - return SRD_ERR_MALLOC; - - pd_cb->output_type = output_type; - pd_cb->callback = cb; - callbacks = g_slist_append(callbacks, pd_cb); - - return SRD_OK; -} - -void *srd_find_callback(int output_type) -{ - GSList *l; - struct srd_pd_callback *pd_cb; - void *(cb); - - cb = NULL; - for (l = callbacks; l; l = l->next) { - pd_cb = l->data; - if (pd_cb->output_type == output_type) { - cb = pd_cb->callback; - break; - } + if (!stack) { + g_slist_free(sess->di_list); + sess->di_list = NULL; } - - return cb; } +/** @} */ +