X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=1c94d7a29a0e43a3c76496c11ba28e1099876828;hp=995ddd7f13667302a2c7cc271829aafb2148d9cb;hb=fe9d91a88a8896ef04d12682720943b237c0a295;hpb=dd93276bf6b7537b65cab270f66666bf23fbc585 diff --git a/controller.c b/controller.c index 995ddd7..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,39 +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 -/* List of decoder instances. */ -static GSList *di_list = NULL; +/** + * @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. + * + * @{ + */ + +/** @cond PRIVATE */ -/* List of frontend callbacks to receive decoder output. */ -static GSList *callbacks = NULL; +extern GSList *sessions; +extern int max_session_id; /* decoder.c */ extern SRD_PRIV GSList *pd_list; /* module_sigrokdecode.c */ -/* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */ extern PyMODINIT_FUNC PyInit_sigrokdecode(void); /* type_logic.c */ extern SRD_PRIV PyTypeObject srd_logic_type; +/** @endcond */ + /** * Initialize libsigrokdecode. * * This initializes the Python interpreter, and creates and initializes * 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_decoders_list(). + * 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. @@ -59,18 +121,25 @@ extern SRD_PRIV PyTypeObject srd_logic_type; * are not allowed. * * @param path Path to an extra directory containing protocol decoders - * which will be added to the Python sys.path, or NULL. + * 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 */ 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. */ @@ -101,6 +170,8 @@ SRD_API int srd_init(const char *path) } } + max_session_id = 0; + return SRD_OK; } @@ -115,11 +186,18 @@ SRD_API int srd_init(const char *path) * any successful srd_init() calls in between, is not allowed. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_exit(void) { + 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; @@ -127,6 +205,8 @@ SRD_API int srd_exit(void) /* Py_Finalize() returns void, any finalization errors are ignored. */ Py_Finalize(); + max_session_id = -1; + return SRD_OK; } @@ -144,6 +224,10 @@ SRD_API int srd_exit(void) * be added to the Python sys.path, or NULL. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @private + * + * @since 0.1.0 */ SRD_PRIV int srd_decoder_searchpath_add(const char *path) { @@ -156,10 +240,10 @@ SRD_PRIV int srd_decoder_searchpath_add(const char *path) srd_dbg("Adding '%s' to module path.", path); new_path = g_string_sized_new(256); - g_string_assign(new_path, g_strdup(path)); + 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_strdup(G_SEARCHPATH_SEPARATOR_S)); + 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. */ @@ -167,6 +251,7 @@ SRD_PRIV int srd_decoder_searchpath_add(const char *path) if (py_str_as_str(py_item, &item) != SRD_OK) continue; g_string_append(new_path, item); + g_free(item); } /* Convert to wide chars. */ @@ -180,24 +265,19 @@ SRD_PRIV int srd_decoder_searchpath_add(const char *path) g_string_free(new_path, TRUE); g_free(wc_new_path); -//#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 - return SRD_OK; } +/** @} */ + +/** + * @defgroup grp_instances Decoder instances + * + * Decoder instance handling. + * + * @{ + */ + /** * Set one or more options in a decoder instance. * @@ -207,16 +287,31 @@ SRD_PRIV int srd_decoder_searchpath_add(const char *path) * @param options A GHashTable of options to set. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, - GHashTable *options) + 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 (!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. */ @@ -239,8 +334,18 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *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); + + /* + * 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); @@ -255,20 +360,32 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, } 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; } } @@ -301,18 +418,21 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, */ 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); g_free(key); - if (PyErr_Occurred()) + if (PyErr_Occurred()) { srd_exception_catch("Stray exception in srd_inst_option_set()."); + ret = SRD_ERR_PYTHON; + } return ret; } @@ -335,16 +455,18 @@ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) * arranged in this order. * * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.1.0 */ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, - GHashTable *new_probes) + GHashTable *new_probes) { + GVariant *probe_val; GList *l; GSList *sl; struct srd_probe *p; - int *new_probemap, new_probenum; - char *probe_id, *probenum_str; - int i, num_required_probes; + 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)); @@ -374,24 +496,25 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, 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; - probenum_str = g_hash_table_lookup(new_probes, probe_id); - if (!probenum_str) { + 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); + probe_id); g_free(new_probemap); return SRD_ERR_ARG; } - new_probenum = strtol(probenum_str, NULL, 10); + 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); + "'%s'.", di->decoder->name, probe_id); g_free(new_probemap); return SRD_ERR_ARG; } @@ -400,7 +523,9 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, 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; srd_dbg("Final probe map:"); num_required_probes = g_slist_length(di->decoder->probes); @@ -418,15 +543,18 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, /** * Create a new protocol decoder instance. * + * @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. + * 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 */ -SRD_API struct srd_decoder_inst *srd_inst_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; @@ -435,6 +563,11 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *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_decoder_get_by_id(decoder_id))) { srd_err("Protocol decoder %s not found.", decoder_id); return NULL; @@ -445,20 +578,24 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, return NULL; } - inst_id = g_hash_table_lookup(options, "id"); di->decoder = dec; - di->inst_id = g_strdup(inst_id ? inst_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); + 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))) { + g_try_malloc(sizeof(int) * di->dec_num_probes))) { srd_err("Failed to g_malloc() probe map."); g_free(di); return NULL; @@ -466,25 +603,26 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, 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_inst = PyObject_CallObject(dec->py_dec, NULL))) { if (PyErr_Occurred()) srd_exception_catch("failed to create %s instance: ", - decoder_id); + decoder_id); g_free(di->dec_probemap); g_free(di); return NULL; } - if (srd_inst_option_set(di, options) != SRD_OK) { + 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. */ - di_list = g_slist_append(di_list, di); + sess->di_list = g_slist_append(sess->di_list, di); return di; } @@ -492,22 +630,31 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, /** * 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_decoder_inst *di_from, - struct srd_decoder_inst *di_to) +SRD_API int srd_inst_stack(struct srd_session *sess, + struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to) { + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return SRD_ERR_ARG; + } + if (!di_from || !di_to) { srd_err("Invalid from/to instance pair."); return SRD_ERR_ARG; } - if (g_slist_find(di_list, di_to)) { + if (g_slist_find(sess->di_list, di_to)) { /* Remove from the unstacked list. */ - di_list = g_slist_remove(di_list, di_to); + sess->di_list = g_slist_remove(sess->di_list, di_to); } /* Stack on top of source di. */ @@ -522,17 +669,26 @@ SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, * 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(const char *inst_id) +SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, + const char *inst_id) { GSList *l; 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->inst_id, inst_id)) { di = tmp; @@ -543,11 +699,36 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) return di; } +static struct srd_decoder_inst *srd_sess_inst_find_by_obj( + struct srd_session *sess, const GSList *stack, + const PyObject *obj) +{ + const GSList *l; + struct srd_decoder_inst *tmp, *di; + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return NULL; + } + + 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); + } + + 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. + * 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 @@ -555,60 +736,50 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) * @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) + const PyObject *obj) { -// TODO? - const GSList *l; - struct srd_decoder_inst *tmp, *di; + struct srd_decoder_inst *di; + struct srd_session *sess; + GSList *l; di = NULL; - for (l = stack ? stack : 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_inst_find_by_obj(tmp->next_di, obj); + 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; } -SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) +/** @private */ +SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) { - PyObject *py_name, *py_res; + 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_name = PyUnicode_FromString("start"))) { - srd_err("Unable to build Python object for 'start'."); - srd_exception_catch("Protocol decoder instance %s: ", - di->inst_id); - return SRD_ERR_PYTHON; - } + di->inst_id); - if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, - py_name, args, NULL))) { + if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) { srd_exception_catch("Protocol decoder instance %s: ", - di->inst_id); + di->inst_id); return SRD_ERR_PYTHON; } - Py_DecRef(py_res); - Py_DecRef(py_name); - /* - * Start all the PDs stacked on top of this one. Pass along the - * metadata all the way from the bottom PD, even though it's only - * applicable to logic data for now. - */ + /* Start all the PDs stacked on top of this one. */ for (l = di->next_di; l; l = l->next) { next_di = l->data; - srd_inst_start(next_di, args); + if ((ret = srd_inst_start(next_di)) != SRD_OK) + return ret; } return SRD_OK; @@ -617,24 +788,30 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) /** * Run the specified decoder function. * + * @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 di The decoder instance to call. Must not be NULL. + * @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 */ -SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, - const struct srd_decoder_inst *di, - const 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_res; srd_logic *logic; - uint64_t end_samplenum; - srd_dbg("Calling decode() on instance %s with %d bytes starting " - "at sample %d.", di->inst_id, inbuflen, start_samplenum); + srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes " + "starting at sample %" PRIu64 ".", di->inst_id, inbuflen, + start_samplenum); /* Return an error upon unusable input. */ if (!di) { @@ -665,19 +842,17 @@ SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, Py_INCREF(logic->sample); Py_IncRef(di->py_inst); - end_samplenum = start_samplenum + inbuflen / di->data_unitsize; if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", - "KKO", logic->start_samplenum, - end_samplenum, logic))) { - srd_exception_catch("Protocol decoder instance %s: ", - di->inst_id); - return SRD_ERR_PYTHON; /* TODO: More specific error? */ + "KKO", start_samplenum, end_samplenum, logic))) { + srd_exception_catch("Protocol decoder instance %s: ", di->inst_id); + return SRD_ERR_PYTHON; } Py_DecRef(py_res); return SRD_OK; } +/** @private */ SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) { GSList *l; @@ -695,169 +870,32 @@ SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) g_free(pdo); } g_slist_free(di->pd_output); + g_free(di); } -SRD_PRIV void srd_inst_free_all(GSList *stack) +/** @private */ +SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) { GSList *l; struct srd_decoder_inst *di; + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return; + } + di = NULL; - for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { + for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { di = l->data; if (di->next_di) - srd_inst_free_all(di->next_di); + srd_inst_free_all(sess, di->next_di); srd_inst_free(di); } if (!stack) { - g_slist_free(di_list); - di_list = NULL; - } -} - -/** - * Start a decoding session. - * - * Decoders, instances and stack must have been prepared beforehand. - * - * @param num_probes The number of probes which the incoming feed will contain. - * @param unitsize The number of bytes per sample in the incoming feed. - * @param samplerate The samplerate of the incoming feed. - * - * @return SRD_OK upon success, a (negative) error code otherwise. - */ -SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) -{ - PyObject *args; - GSList *d; - struct srd_decoder_inst *di; - int ret; - - srd_dbg("Calling start() on all instances with %d probes, " - "unitsize %d samplerate %d.", num_probes, unitsize, samplerate); - - /* - * Currently only one item of metadata is passed along to decoders, - * samplerate. This can be extended as needed. - */ - if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { - srd_err("Unable to build Python object for metadata."); - return SRD_ERR_PYTHON; - } - - /* Run the start() method on all decoders receiving frontend data. */ - for (d = di_list; d; d = d->next) { - di = d->data; - di->data_num_probes = num_probes; - di->data_unitsize = unitsize; - di->data_samplerate = samplerate; - if ((ret = srd_inst_start(di, args)) != SRD_OK) - break; + g_slist_free(sess->di_list); + sess->di_list = NULL; } - - Py_DecRef(args); - - return ret; -} - -/** - * Send a chunk of logic sample data to a running decoder session. - * - * @param start_samplenum The sample number of the first sample in this chunk. - * @param inbuf Pointer to sample data. - * @param inbuflen Length in bytes of the buffer. - * - * @return SRD_OK upon success, a (negative) error code otherwise. - */ -SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, - uint64_t inbuflen) -{ - GSList *d; - int ret; - - srd_dbg("Calling decode() on all instances with starting sample " - "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", - start_samplenum, inbuflen, inbuf); - - for (d = di_list; d; d = d->next) { - if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, - inbuflen)) != SRD_OK) - return ret; - } - - return SRD_OK; } -/** - * Register/add a decoder output callback function. - * - * The function will be called when a protocol decoder sends output back - * to the PD controller (except for Python objects, which only go up the - * stack). - * - * @param output_type The output type this callback will receive. Only one - * callback per output type can be registered. - * @param cb The function to call. Must not be NULL. - * @param cb_data Private data for the callback function. Can be NULL. - */ -SRD_API int srd_pd_output_callback_add(int output_type, - srd_pd_output_callback_t cb, void *cb_data) -{ - struct srd_pd_callback *pd_cb; - - srd_dbg("Registering new callback for output type %d.", output_type); +/** @} */ - if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { - srd_err("Failed to g_malloc() struct srd_pd_callback."); - return SRD_ERR_MALLOC; - } - - pd_cb->output_type = output_type; - pd_cb->cb = cb; - pd_cb->cb_data = cb_data; - callbacks = g_slist_append(callbacks, pd_cb); - - return SRD_OK; -} - -SRD_PRIV void *srd_pd_output_callback_find(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->cb; - break; - } - } - - return cb; -} - -/* This is the backend function to Python sigrokdecode.add() call. */ -SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, - int output_type, const char *proto_id) -{ - struct srd_pd_output *pdo; - - srd_dbg("Instance %s creating new output type %d for %s.", - di->inst_id, output_type, proto_id); - - if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { - srd_err("Failed to g_malloc() 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->di = di; - pdo->proto_id = g_strdup(proto_id); - di->pd_output = g_slist_append(di->pd_output, pdo); - - return pdo->pdo_id; -}