X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=5ffe7ae21bfc2a8c51a18b8e27425b835c02e724;hp=3c50d8a578ef935c51fd0490ddfa7e7af442517b;hb=361fdcaafec8ddd37f0d381204e4c2a22c56b238;hpb=e09023b9dc8f1d6783a3bf6b05402a88060a795f diff --git a/controller.c b/controller.c index 3c50d8a..5ffe7ae 100644 --- a/controller.c +++ b/controller.c @@ -28,7 +28,7 @@ /* List of decoder instances. */ static GSList *di_list = NULL; -/* List of frontend callbacks to receive PD output. */ +/* List of frontend callbacks to receive decoder output. */ static GSList *callbacks = NULL; /* decoder.c */ @@ -44,12 +44,12 @@ extern SRD_PRIV PyTypeObject srd_logic_type; * 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. * 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_decoders_list(). * * The caller is responsible for calling the clean-up function srd_exit(), * which will properly shut down libsigrokdecode and free its allocated memory. @@ -57,14 +57,18 @@ extern SRD_PRIV 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, or 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. */ -SRD_API int srd_init(void) +SRD_API int srd_init(char *path) { int ret; + char *env_path; srd_dbg("Initializing libsigrokdecode."); @@ -74,14 +78,26 @@ SRD_API int srd_init(void) /* Initialize the Python interpreter. */ Py_Initialize(); - if ((ret = set_modulepath()) != SRD_OK) { + /* Installed decoders. */ + if ((ret = add_modulepath(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 = add_modulepath(path)) != SRD_OK) { + Py_Finalize(); + return ret; + } + } + + /* Environment variable overrides everything, for debugging. */ + if ((env_path = getenv("SIGROKDECODE_DIR"))) { + if ((ret = add_modulepath(env_path)) != SRD_OK) { + Py_Finalize(); + return ret; + } } return SRD_OK; @@ -103,7 +119,7 @@ SRD_API int srd_exit(void) { srd_dbg("Exiting libsigrokdecode."); - srd_unload_all_decoders(); + srd_decoders_unload_all(); g_slist_free(pd_list); /* Py_Finalize() returns void, any finalization errors are ignored. */ @@ -122,54 +138,76 @@ SRD_API int srd_exit(void) * Python modules which have the same name as a sigrok protocol decoder in * sys.path or in the current working directory. * - * TODO: add path from env var SIGROKDECODE_PATH, config etc - * TODO: Should take directoryname/path as input. + * @param path Path to the directory containing protocol decoders which shall + * be added to the Python sys.path, or NULL. * - * @return TODO. + * @return SRD_OK upon success, a (negative) error code otherwise. */ -SRD_API int set_modulepath(void) +SRD_PRIV int add_modulepath(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: Sanity check on 'path' (length, escape special chars, ...). */ - s = g_strdup_printf("import sys; sys.path.insert(0, r'%s')", path); - - ret = PyRun_SimpleString(s); - - g_free(path); - g_free(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, g_strdup(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)); + 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); + } + + /* 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); + +//#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 ret; + return SRD_OK; } /** * Set options in a decoder instance. * + * Handled options are removed from the hash. + * * @param di Decoder instance. * @param options A GHashTable of options to set. * - * Handled options are removed from the hash. - * * @return SRD_OK upon success, a (negative) error code otherwise. */ -SRD_API int srd_inst_set_options(struct srd_decoder_inst *di, - GHashTable *options) +SRD_API int srd_inst_options_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; @@ -255,7 +293,8 @@ SRD_API int srd_inst_set_options(struct srd_decoder_inst *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) @@ -276,7 +315,7 @@ err_out: return ret; } -/* Helper GComparefunc for g_slist_find_custom() in srd_inst_set_probes() */ +/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probes_set() */ static gint compare_probe_id(struct srd_probe *a, char *probe_id) { return strcmp(a->id, probe_id); @@ -289,10 +328,11 @@ static gint compare_probe_id(struct srd_probe *a, char *probe_id) * @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. + * * @return SRD_OK upon success, a (negative) error code otherwise. */ -SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di, - GHashTable *new_probes) +SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di, + GHashTable *new_probes) { GList *l; GSList *sl; @@ -360,11 +400,12 @@ SRD_API int srd_inst_set_probes(struct srd_decoder_inst *di, * @param 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_inst, or * NULL in case of failure. */ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, - GHashTable *options) + GHashTable *options) { int i; struct srd_decoder *dec; @@ -373,7 +414,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, srd_dbg("Creating new %s instance.", decoder_id); - 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; } @@ -388,7 +429,8 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); g_hash_table_remove(options, "id"); - /* Prepare a default probe map, where samples come in the + /* + * 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) + @@ -414,7 +456,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, return NULL; } - if (srd_inst_set_options(di, options) != SRD_OK) { + if (srd_inst_options_set(di, options) != SRD_OK) { g_free(di->dec_probemap); g_free(di); return NULL; @@ -426,6 +468,14 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, return di; } +/** + * Stack a decoder instance on top of another. + * + * @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. + */ SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to) { @@ -446,11 +496,12 @@ SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, } /** - * Finds a decoder instance by its instance id, but only in the bottom - * level of instances -- instances already stacked on top of another one - * will not be found. + * Find a decoder instance by its instance ID. * - * @param inst_id The instance id to be found. + * Only the bottom level of instances are searched -- instances already stacked + * on top of another one will not be found. + * + * @param inst_id The instance ID to be found. * * @return Pointer to struct srd_decoder_inst, or NULL if not found. */ @@ -472,19 +523,20 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_id(char *inst_id) } /** - * Finds a decoder instance by its Python object, i.e. that instance's - * instantiation of the sigrokdecode.Decoder class. This will recurse - * to find the instance anywhere in the stack tree. + * 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. * - * @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 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. */ -SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack, - PyObject *obj) +SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack, + PyObject *obj) { GSList *l; struct srd_decoder_inst *tmp, *di; @@ -501,7 +553,7 @@ SRD_API struct srd_decoder_inst *srd_inst_find_by_obj(GSList *stack, return di; } -SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) +SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) { PyObject *py_name, *py_res; GSList *l; @@ -527,7 +579,8 @@ SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) Py_DecRef(py_res); Py_DecRef(py_name); - /* Start all the PDs stacked on top of this one. Pass along the + /* + * 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. */ @@ -550,7 +603,7 @@ SRD_API int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -SRD_API int srd_inst_decode(uint64_t start_samplenum, +SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, struct srd_decoder_inst *di, uint8_t *inbuf, uint64_t inbuflen) { @@ -575,7 +628,8 @@ SRD_API int srd_inst_decode(uint64_t start_samplenum, return SRD_ERR_ARG; } - /* Create new srd_logic object. Each iteration around the PD's loop + /* + * 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); @@ -602,7 +656,7 @@ SRD_API int srd_inst_decode(uint64_t start_samplenum, return SRD_OK; } -SRD_API void srd_inst_free(struct srd_decoder_inst *di) +SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) { GSList *l; struct srd_pd_output *pdo; @@ -621,7 +675,7 @@ SRD_API void srd_inst_free(struct srd_decoder_inst *di) g_slist_free(di->pd_output); } -SRD_API void srd_inst_free_all(GSList *stack) +SRD_PRIV void srd_inst_free_all(GSList *stack) { GSList *l; struct srd_decoder_inst *di; @@ -639,6 +693,17 @@ SRD_API void srd_inst_free_all(GSList *stack) } } +/** + * 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; @@ -649,7 +714,8 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) 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, + /* + * 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))) { @@ -672,8 +738,16 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) return ret; } -/* Feed logic samples to decoder session. */ -SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf, +/** + * Feed 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 inbuf Length in bytes of the buffer. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + */ +SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen) { GSList *d; @@ -685,15 +759,27 @@ SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t * inbuf, for (d = di_list; d; d = d->next) { if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, - inbuflen)) != SRD_OK) + inbuflen)) != SRD_OK) return ret; } return SRD_OK; } +/** + * Register 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_register_callback(int output_type, - srd_pd_output_callback_t cb, void *user_data) + srd_pd_output_callback_t cb, void *cb_data) { struct srd_pd_callback *pd_cb; @@ -705,14 +791,14 @@ SRD_API int srd_register_callback(int output_type, } pd_cb->output_type = output_type; - pd_cb->callback = cb; - pd_cb->user_data = user_data; + pd_cb->cb = cb; + pd_cb->cb_data = cb_data; callbacks = g_slist_append(callbacks, pd_cb); return SRD_OK; } -SRD_API void *srd_find_callback(int output_type) +SRD_PRIV void *srd_find_callback(int output_type) { GSList *l; struct srd_pd_callback *pd_cb; @@ -722,7 +808,7 @@ SRD_API void *srd_find_callback(int output_type) for (l = callbacks; l; l = l->next) { pd_cb = l->data; if (pd_cb->output_type == output_type) { - cb = pd_cb->callback; + cb = pd_cb->cb; break; } }