X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=92959635b5e34ad95771714c921bdded3e8d0b3a;hp=d3bcdcb532a86692107457341b050fa7f649cd8d;hb=190b71cfebc1dd000d3203c7300a10afd96c1201;hpb=ed41649709abc02362df526cbd725775000e8199 diff --git a/controller.c b/controller.c index d3bcdcb..9295963 100644 --- a/controller.c +++ b/controller.c @@ -26,79 +26,9 @@ #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. - * - * @{ - */ - /** @cond PRIVATE */ -SRD_PRIV GSList *sessions = NULL; -static int max_session_id = -1; - -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); +extern GSList *sessions; /* type_logic.c */ extern SRD_PRIV PyTypeObject srd_logic_type; @@ -106,171 +36,10 @@ 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 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_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() 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, 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. */ - PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); - - /* Initialize the Python interpreter. */ - Py_Initialize(); - - /* Installed decoders. */ - if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != 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. - * - * This frees all the memory allocated for protocol decoders and shuts down - * the Python interpreter. - * - * 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 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; - - /* 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 + * @file * - * @since 0.1.0 + * Decoder instance handling. */ -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; -} - -/** @} */ /** * @defgroup grp_instances Decoder instances @@ -901,322 +670,3 @@ SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) /** @} */ -/** - * @defgroup grp_session Session handling - * - * Starting and handling decoding sessions. - * - * @{ - */ - -static int session_is_valid(struct srd_session *sess) -{ - - 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; - } - - 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; - - 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)); - - 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) -{ - GSList *d; - int ret; - - if (session_is_valid(sess) != SRD_OK) { - srd_err("Invalid session."); - return SRD_ERR_ARG; - } - - srd_dbg("Calling decode() on all instances with starting sample " - "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", - start_samplenum, inbuflen, inbuf); - - 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; -} - -/** - * 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) -{ - int session_id; - - if (!sess) { - srd_err("Invalid session."); - return SRD_ERR_ARG; - } - - 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; -} - -/** - * 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 (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->cb = cb; - pd_cb->cb_data = cb_data; - sess->callbacks = g_slist_append(sess->callbacks, pd_cb); - - return SRD_OK; -} - -/** @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 *tmp, *pd_cb; - - if (session_is_valid(sess) != SRD_OK) { - srd_err("Invalid session."); - return NULL; - } - - 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 pd_cb; -} - -/* This is the backend function to Python sigrokdecode.add() call. */ -/** @private */ -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; -} - -/** @} */