X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=9f9b7b1820481c8e82e4c5992299b6a8cf370c24;hp=a0e8bfe8d13b240a16dee82c66b4d564d58c323d;hb=0169f19c53e195df2f96c4df731ad3214c59e20a;hpb=b231546d63396fd6cac381b12b99caf07687e7e3 diff --git a/controller.c b/controller.c index a0e8bfe..9f9b7b1 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,78 +18,165 @@ * along with this program. If not, see . */ +#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "libsigrokdecode-internal.h" #include "config.h" -#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ #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 + */ -static GSList *callbacks = NULL; +/** + * @file + * + * Initializing and shutting down libsigrokdecode. + */ -/* TODO -static GSList *pipelines = NULL; -struct srd_pipeline { - int id; - GSList *decoders; -}; -*/ +/** + * @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 */ -/* lives in decoder.c */ -extern GSList *pd_list; -extern GSList *di_list; +SRD_PRIV GSList *sessions = NULL; +static int max_session_id = -1; -/* lives in module_sigrokdecode.c */ +static int session_is_valid(struct srd_session *sess); + +/* 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. * - * Multiple calls to srd_init(), without calling srd_exit() inbetween, + * 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. * @@ -98,265 +185,1013 @@ int srd_init(void) * * This function should only be called if there was a (successful!) invocation * of srd_init() before. Calling this function multiple times in a row, without - * any successful srd_init() calls inbetween, is not allowed. + * 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 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 + * + * @since 0.1.0 + */ +SRD_PRIV int srd_decoder_searchpath_add(const char *path) +{ + 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); + } + + /* 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 SRD_OK; } +/** @} */ /** - * Add search directories for the protocol decoders. + * @defgroup grp_instances Decoder instances + * + * Decoder instance handling. * - * TODO: add path from env var SIGROKDECODE_PATH, config etc + * @{ */ -int set_modulepath(void) + +/** + * 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 + */ +SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, + GHashTable *options) { - int ret; + 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; + 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. */ + if (g_hash_table_size(options) == 0) { + /* No options provided. */ + return SRD_OK; + } else { + srd_err("Protocol decoder has no options."); + return SRD_ERR_ARG; + } + return SRD_OK; + } - PyRun_SimpleString("import sys"); - ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');"); + ret = SRD_ERR_PYTHON; + key = NULL; + py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; + py_optlist = py_classval = NULL; + py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); + + /* 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); + if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) + goto err_out; + 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); + 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 (!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 (!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 integer value.", key); + goto err_out; + } + } + g_hash_table_remove(options, key); + } else { + /* Use the class default for this option. */ + if (PyUnicode_Check(py_classval)) { + /* Make a brand new copy of the string. */ + py_ustr = PyUnicode_AS_UNICODE(py_classval); + size = PyUnicode_GET_SIZE(py_classval); + py_optval = PyUnicode_FromUnicode(py_ustr, size); + } else if (PyLong_Check(py_classval)) { + /* Make a brand new copy of the integer. */ + val_ull = PyLong_AsUnsignedLongLong(py_classval); + if (val_ull == (unsigned long long)-1) { + /* OverFlowError exception */ + PyErr_Clear(); + srd_err("Invalid integer value for %s: " + "expected integer.", key); + goto err_out; + } + if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) + goto err_out; + } + } + + /* + * 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_di_options); + Py_XDECREF(py_dec_optkeys); + Py_XDECREF(py_dec_options); + g_free(key); + if (PyErr_Occurred()) { + 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 all probes in a decoder instance. + * + * This function sets _all_ probes for the specified decoder instance, i.e., + * it overwrites any probes that were already defined (if any). + * + * @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 + */ +SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, + GHashTable *new_probes) +{ + 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(new_probes) == 0) + /* No probes provided. */ + return SRD_OK; + + if (di->dec_num_probes == 0) { + /* Decoder has no probes. */ + srd_err("Protocol decoder %s has no probes to define.", + di->decoder->name); + return SRD_ERR_ARG; + } + + new_probemap = NULL; + + 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; + } + + /* + * 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; + + 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; -struct srd_decoder_instance *srd_instance_new(const char *id) + return SRD_OK; +} + +/** + * 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. 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(struct srd_session *sess, + const char *decoder_id, GHashTable *options) { + int i; struct srd_decoder *dec; - struct srd_decoder_instance *di; - PyObject *py_args; + struct srd_decoder_inst *di; + char *inst_id; - if (!(dec = srd_get_decoder_by_id(id))) + srd_dbg("Creating new %s instance.", decoder_id); + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); return NULL; + } - /* TODO: Error handling. Use g_try_malloc(). */ - di = g_malloc(sizeof(*di)); - di->decoder = dec; - di->pd_output = NULL; - di->unitsize = 0; + if (!(dec = srd_decoder_get_by_id(decoder_id))) { + srd_err("Protocol decoder %s not found.", decoder_id); + return NULL; + } - /* Create an empty Python tuple. */ - if (!(py_args = PyTuple_New(0))) { /* NEWREF */ - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ + if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { + srd_err("Failed to g_malloc() instance."); + return NULL; + } - return NULL; /* TODO: More specific error? */ + di->decoder = dec; + 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 an instance of the 'Decoder' class. */ - di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL); - if (!di->py_instance) { + /* Create a new instance of this decoder class. */ + if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - Py_XDECREF(py_args); - return NULL; /* TODO: More specific error? */ + srd_exception_catch("failed to create %s instance: ", + decoder_id); + g_free(di->dec_probemap); + g_free(di); + return NULL; } - di_list = g_slist_append(di_list, di); - Py_XDECREF(py_args); + 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_set_probe(struct srd_decoder_instance *di, - const char *probename, int num) +/** + * 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) { - PyObject *probedict, *probenum; - probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */ - if (!probedict) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return SRD_ERR_ARG; + } - return SRD_ERR_PYTHON; /* TODO: More specific error? */ + if (!di_from || !di_to) { + srd_err("Invalid from/to instance pair."); + return SRD_ERR_ARG; } - probenum = PyLong_FromLong(num); - PyMapping_SetItemString(probedict, (char *)probename, probenum); + 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); + } - Py_XDECREF(probenum); - Py_XDECREF(probedict); + /* Stack on top of source di. */ + di_from->next_di = g_slist_append(di_from->next_di, di_to); return SRD_OK; } +/** + * 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_inst *tmp, *di; + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return NULL; + } + + di = NULL; + for (l = sess->di_list; l; l = l->next) { + tmp = l->data; + if (!strcmp(tmp->inst_id, inst_id)) { + di = tmp; + break; + } + } + + 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 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); + } -int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) + return di; +} + +/** @private */ +SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di) { PyObject *py_res; - GSList *d; - struct srd_decoder_instance *di; + GSList *l; + struct srd_decoder_inst *next_di; + int ret; - for (d = di_list; d; d = d->next) { - di = d->data; - di->num_probes = num_probes; - di->unitsize = unitsize; - di->samplerate = samplerate; - if (!(py_res = PyObject_CallMethod(di->py_instance, "start", - "{s:l}", - "samplerate", (long)samplerate))) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - - return SRD_ERR_PYTHON; /* TODO: More specific error? */ - } - Py_XDECREF(py_res); + 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); + + /* 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; } - /** * 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_run_decoder(uint64_t timeoffset, uint64_t duration, - 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; - /* 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); - if (!(py_res = PyObject_CallMethod(py_instance, "decode", - "KKO", timeoffset, duration, logic))) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ + 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_DecRef(py_res); - return SRD_ERR_PYTHON; /* TODO: More specific error? */ + return SRD_OK; +} + +/** @private */ +SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) +{ + GSList *l; + struct srd_pd_output *pdo; + + srd_dbg("Freeing instance %s", di->inst_id); + + 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); } + g_slist_free(di->pd_output); + g_free(di); +} + +/** @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 : sess->di_list; di == NULL && l != NULL; l = l->next) { + di = l->data; + if (di->next_di) + srd_inst_free_all(sess, di->next_di); + srd_inst_free(di); + } + if (!stack) { + g_slist_free(sess->di_list); + sess->di_list = NULL; + } +} + +/** @} */ + +/** + * @defgroup grp_session Session handling + * + * Starting and handling decoding sessions. + * + * @{ + */ + +static int session_is_valid(struct srd_session *sess) +{ - Py_XDECREF(py_res); + if (!sess || sess->session_id < 1) + return SRD_ERR; return SRD_OK; } +/** + * Create a decoding session. + * + * A session holds all decoder instances, their stack relationships and + * output callbacks. + * + * @param sess A pointer which will hold a pointer to a newly + * initialized session on return. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.3.0 + */ +SRD_API int srd_session_new(struct srd_session **sess) +{ + + if (!sess) { + srd_err("Invalid session pointer."); + return SRD_ERR_ARG; + } -/* Feed logic samples to decoder session. */ -int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, - uint64_t inbuflen) + if (!(*sess = g_try_malloc(sizeof(struct srd_session)))) + return SRD_ERR_MALLOC; + (*sess)->session_id = ++max_session_id; + (*sess)->di_list = (*sess)->callbacks = NULL; + + /* Keep a list of all sessions, so we can clean up as needed. */ + sessions = g_slist_append(sessions, *sess); + + srd_dbg("Created session %d.", (*sess)->session_id); + + return SRD_OK; +} + +/** + * Start a decoding session. + * + * Decoders, instances and stack must have been prepared beforehand, + * and all SRD_CONF parameters set. + * + * @param sess The session to start. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.3.0 + */ +SRD_API int srd_session_start(struct srd_session *sess) { GSList *d; + struct srd_decoder_inst *di; int ret; - for (d = di_list; d; d = d->next) { - if ((ret = srd_run_decoder(timeoffset, duration, d->data, inbuf, - inbuflen)) != SRD_OK) - return ret; + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session pointer."); + return SRD_ERR; } + srd_dbg("Calling start() on all instances in session %d.", sess->session_id); + + /* Run the start() method on all decoders receiving frontend data. */ + ret = SRD_OK; + for (d = sess->di_list; d; d = d->next) { + di = d->data; + if ((ret = srd_inst_start(di)) != SRD_OK) + break; + } + + return ret; +} + +SRD_PRIV int srd_inst_send_meta(struct srd_decoder_inst *di, int key, + GVariant *data) +{ + PyObject *py_ret; + + if (key != SRD_CONF_SAMPLERATE) + /* This is the only key we pass on to the decoder for now. */ + return SRD_OK; + + if (!PyObject_HasAttrString(di->py_inst, "metadata")) + /* This decoder doesn't want metadata, that's fine. */ + return SRD_OK; + + py_ret = PyObject_CallMethod(di->py_inst, "metadata", "lK", + (long)SRD_CONF_SAMPLERATE, + (unsigned long long)g_variant_get_uint64(data)); + Py_XDECREF(py_ret); + return SRD_OK; } +/** + * Set a metadata configuration key in a session. + * + * @param sess The session to configure. + * @param key The configuration key (SRD_CONF_*). + * @param data The new value for the key, as a GVariant with GVariantType + * appropriate to that key. A floating reference can be passed + * in; its refcount will be sunk and unreferenced after use. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.3.0 + */ +SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, + GVariant *data) +{ + GSList *l; + int ret; + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return SRD_ERR_ARG; + } + + if (key != SRD_CONF_SAMPLERATE) { + srd_err("Unknown config key %d.", key); + return SRD_ERR_ARG; + } + + srd_dbg("Setting session %d samplerate to %"PRIu64".", + sess->session_id, g_variant_get_uint64(data)); -int pd_add(struct srd_decoder_instance *di, int output_type, - char *protocol_id) + ret = SRD_OK; + for (l = sess->di_list; l; l = l->next) { + if ((ret = srd_inst_send_meta(l->data, key, data)) != SRD_OK) + break; + } + + g_variant_unref(data); + + return ret; +} + +/** + * Send a chunk of logic sample data to a running decoder session. + * + * The logic samples must be arranged in probe order, in the least + * amount of space possible. If no probes were configured, the default + * probe set consists of all required probes + all optional probes. + * + * The size of a sample in inbuf is the minimum number of bytes needed + * to store the configured (or default) probes. + * + * @param sess The session to use. + * @param start_samplenum The sample number of the first sample in this chunk. + * @param end_samplenum The sample number of the last 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. + * + * @since 0.3.0 + */ +SRD_API int srd_session_send(struct srd_session *sess, + uint64_t start_samplenum, uint64_t end_samplenum, + const uint8_t *inbuf, uint64_t inbuflen) { - struct srd_pd_output *pdo; + GSList *d; + int ret; - if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) - return -1; + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return SRD_ERR_ARG; + } - /* 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->protocol_id = g_strdup(protocol_id); - di->pd_output = g_slist_append(di->pd_output, pdo); + srd_dbg("Calling decode() on all instances with starting sample " + "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", + start_samplenum, inbuflen, inbuf); - return pdo->pdo_id; + for (d = sess->di_list; d; d = d->next) { + if ((ret = srd_inst_decode(d->data, start_samplenum, + end_samplenum, inbuf, inbuflen)) != SRD_OK) + return ret; + } + + return SRD_OK; } -struct srd_decoder_instance *get_di_by_decobject(void *decobject) +/** + * Destroy a decoding session. + * + * All decoder instances and output callbacks are properly released. + * + * @param sess The session to be destroyed. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + * + * @since 0.3.0 + */ +SRD_API int srd_session_destroy(struct srd_session *sess) { - GSList *l; - struct srd_decoder_instance *di; + int session_id; - for (l = di_list; l; l = l->next) { - di = l->data; - if (decobject == di->py_instance) - return di; + if (!sess) { + srd_err("Invalid session."); + return SRD_ERR_ARG; } - return NULL; + session_id = sess->session_id; + if (sess->di_list) + srd_inst_free_all(sess, NULL); + if (sess->callbacks) + g_slist_free_full(sess->callbacks, g_free); + sessions = g_slist_remove(sessions, sess); + g_free(sess); + + srd_dbg("Destroyed session %d.", session_id); + + return SRD_OK; } -int srd_register_callback(int output_type, void *cb) +/** + * 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 sess The output session in which to register the callback. + * @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. + * + * @since 0.3.0 + */ +SRD_API int srd_pd_output_callback_add(struct srd_session *sess, + int output_type, srd_pd_output_callback_t cb, void *cb_data) { struct srd_pd_callback *pd_cb; - if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return SRD_ERR_ARG; + } + + 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->callback = cb; - callbacks = g_slist_append(callbacks, pd_cb); + pd_cb->cb = cb; + pd_cb->cb_data = cb_data; + sess->callbacks = g_slist_append(sess->callbacks, pd_cb); return SRD_OK; } -void *srd_find_callback(int output_type) +/** @private */ +SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find( + struct srd_session *sess, int output_type) { GSList *l; - struct srd_pd_callback *pd_cb; - void *(cb); + struct srd_pd_callback *tmp, *pd_cb; + + if (session_is_valid(sess) != SRD_OK) { + srd_err("Invalid session."); + return NULL; + } - cb = NULL; - for (l = callbacks; l; l = l->next) { - pd_cb = l->data; - if (pd_cb->output_type == output_type) { - cb = pd_cb->callback; + pd_cb = NULL; + for (l = sess->callbacks; l; l = l->next) { + tmp = l->data; + if (tmp->output_type == output_type) { + pd_cb = tmp; break; } } - return cb; + return pd_cb; } -//int srd_pipeline_new(int plid) -//{ -// -// -//} - - - - +/** @} */