X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=controller.c;h=20364f7076c8d4eab8c7fdacd8d4c5db8b293d4f;hp=140f664f1a2166992095a23459195993e939308b;hb=42a85ed0aed14216232ae48af1b5b709ec31f800;hpb=1aef2f93a29f01168c04fd0478b29af290d8756b diff --git a/controller.c b/controller.c index 140f664..20364f7 100644 --- a/controller.c +++ b/controller.c @@ -2,7 +2,7 @@ * This file is part of the sigrok project. * * Copyright (C) 2010 Uwe Hermann - * Copyright (C) 2011 Bert Vermeulen + * Copyright (C) 2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -18,159 +18,25 @@ * along with this program. If not, see . */ +#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include "sigrokdecode-internal.h" #include "config.h" -#include /* First, so we avoid a _POSIX_C_SOURCE warning. */ #include #include -/* TODO: this should probably be in sigrokdecode.h */ -/* Re-define some string functions for Python >= 3.0. */ -#if PY_VERSION_HEX >= 0x03000000 -#define PyString_AsString PyBytes_AsString -#define PyString_FromString PyBytes_FromString -#define PyString_Check PyBytes_Check -#endif - -/* TODO -static GSList *pipelines = NULL; -*/ +static GSList *di_list = NULL; +static GSList *callbacks = NULL; /* lives in decoder.c */ extern GSList *pd_list; -extern GSList *di_list; - -struct srd_pipeline { - int id; - GSList *decoders; -}; - - - -static PyObject *Decoder_init(PyObject *self, PyObject *args) -{ - (void)self; - (void)args; -// printf("init object %x\n", self); - - Py_RETURN_NONE; -} - -struct srd_decoder_instance *get_di_by_decobject(void *decobject); - -static PyObject *Decoder_put(PyObject *self, PyObject *args) -{ - GSList *l; - PyObject *data; - struct srd_decoder_instance *di; - struct srd_pd_output *pdo; - uint64_t timeoffset, duration; - int output_id; - - if (!(di = get_di_by_decobject(self))) - return NULL; - - if (!PyArg_ParseTuple(args, "KKiO", &timeoffset, &duration, &output_id, &data)) - return NULL; - - printf("put: %s instance %p time %" PRIu64 " duration %" PRIu64 " ", - di->decoder->name, di, timeoffset, duration); - if (!(l = g_slist_nth(di->pd_output, output_id))) - /* PD supplied invalid output id */ - /* TODO: better error message */ - return NULL; - pdo = l->data; - - printf("stream %d: ", pdo->output_type); - PyObject_Print(data, stdout, Py_PRINT_RAW); - puts(""); - - Py_RETURN_NONE; -} - - -static PyObject *Decoder_output_new(PyObject *self, PyObject *py_output_type) -{ - PyObject *ret; - struct srd_decoder_instance *di; - char *protocol_id, *description; - int output_type, pdo_id; - - if (!(di = get_di_by_decobject(self))) - return NULL; - - printf("output_new di %s\n", di->decoder->name); - -// if (!PyArg_ParseTuple(args, "i:output_type,s:protocol_id,s:description", -// &output_type, &protocol_id, &description)) - if (!PyArg_ParseTuple(py_output_type, "i:output_type", &output_type)) - return NULL; - - protocol_id = "i2c"; - description = "blah"; - pdo_id = pd_output_new(di, output_type, protocol_id, description); - if (pdo_id < 0) - Py_RETURN_NONE; - else - ret = Py_BuildValue("i", pdo_id); - - return ret; -} - -static PyMethodDef no_methods[] = { {NULL, NULL, 0, NULL} }; -static PyMethodDef Decoder_methods[] = { - {"__init__", Decoder_init, METH_VARARGS, ""}, - {"put", Decoder_put, METH_VARARGS, - "Accepts a dictionary with the following keys: time, duration, data"}, - {"output_new", Decoder_output_new, METH_VARARGS, - "Create a new output stream"}, - {NULL, NULL, 0, NULL} -}; - - -typedef struct { - PyObject_HEAD -} sigrok_Decoder_object; - -static PyTypeObject sigrok_Decoder_type = { - PyObject_HEAD_INIT(NULL) - .tp_name = "sigrok.Decoder", - .tp_basicsize = sizeof(sigrok_Decoder_object), - .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, - .tp_doc = "Sigrok Decoder object", - .tp_methods = Decoder_methods, -}; - -PyMODINIT_FUNC init_sigrok_Decoder(void) -{ - PyObject *mod; +/* lives in module_sigrokdecode.c */ +extern PyMODINIT_FUNC PyInit_sigrokdecode(void); - /* assign this here, for compiler portability */ - sigrok_Decoder_type.tp_new = PyType_GenericNew; - if (PyType_Ready(&sigrok_Decoder_type) < 0) - return; +/* lives in type_logic.c */ +extern PyTypeObject srd_logic_type; - mod = Py_InitModule3("sigrok", no_methods, "sigrok base classes"); - Py_INCREF(&sigrok_Decoder_type); - PyModule_AddObject(mod, "Decoder", (PyObject *)&sigrok_Decoder_type); - -} - - -struct srd_decoder_instance *get_di_by_decobject(void *decobject) -{ - GSList *l; - struct srd_decoder_instance *di; - - for (l = di_list; l; l = l->next) { - di = l->data; - if (decobject == di->py_instance) - return di; - } - - return NULL; -} /** * Initialize libsigrokdecode. @@ -186,7 +52,7 @@ struct srd_decoder_instance *get_di_by_decobject(void *decobject) * 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. * * @return SRD_OK upon success, a (negative) error code otherwise. @@ -198,12 +64,11 @@ int srd_init(void) { int ret; + PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); + /* Py_Initialize() returns void and usually cannot fail. */ Py_Initialize(); - init_sigrok_Decoder(); - - PyRun_SimpleString("import sys;"); if ((ret = set_modulepath()) != SRD_OK) { Py_Finalize(); return ret; @@ -226,7 +91,7 @@ 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. */ @@ -253,44 +118,65 @@ int set_modulepath(void) { int ret; + PyRun_SimpleString("import sys"); ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');"); return ret; } -struct srd_decoder_instance *srd_instance_new(const char *id) +/** + * Create a new protocol decoder instance. + * + * TODO: this should be a decoder name, as decoder ids will disappear. + * + * @param id Decoder 'id' field. + * @param instance_id Optional unique identifier for this instance. If NULL, + * the 'id' parameter is used. + * @return Pointer to a newly allocated struct srd_decoder_instance, or + * NULL in case of failure. + */ +struct srd_decoder_instance *srd_instance_new(const char *id, + const char *instance_id) { struct srd_decoder *dec; struct srd_decoder_instance *di; PyObject *py_args; - fprintf(stdout, "%s: %s\n", __func__, id); + srd_dbg("%s: creating new %s instance", __func__, id); if (!(dec = srd_get_decoder_by_id(id))) return NULL; - /* TODO: Error handling. Use g_try_malloc(). */ - di = g_malloc(sizeof(*di)); + if (!(di = g_try_malloc(sizeof(*di)))) { + srd_err("failed to malloc instance"); + return NULL; + } di->decoder = dec; + di->instance_id = g_strdup(instance_id ? instance_id : id); di->pd_output = NULL; + di->num_probes = 0; + di->unitsize = 0; + di->samplerate = 0; + di->next_di = NULL; /* Create an empty Python tuple. */ if (!(py_args = PyTuple_New(0))) { /* NEWREF */ if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - - return NULL; /* TODO: More specific error? */ + PyErr_Print(); + return NULL; } /* Create an instance of the 'Decoder' class. */ di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL); if (!di->py_instance) { if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ + PyErr_Print(); Py_XDECREF(py_args); - return NULL; /* TODO: More specific error? */ + return NULL; } + + /* Instance takes input from a frontend by default. */ di_list = g_slist_append(di_list, di); Py_XDECREF(py_args); @@ -298,6 +184,29 @@ struct srd_decoder_instance *srd_instance_new(const char *id) return di; } +int srd_instance_stack(struct srd_decoder_instance *di_from, + struct srd_decoder_instance *di_to) +{ + + if (!di_from || !di_to) { + srd_err("invalid from/to instance pair"); + return SRD_ERR_ARG; + } + + if (!g_slist_find(di_list, di_from)) { + srd_err("unstacked instance not found"); + return SRD_ERR_ARG; + } + + /* Remove from the unstacked list. */ + di_list = g_slist_remove(di_list, di_to); + + /* Stack on top of source di. */ + di_from->next_di = g_slist_append(di_from->next_di, di_to); + + return SRD_OK; +} + int srd_instance_set_probe(struct srd_decoder_instance *di, const char *probename, int num) @@ -312,7 +221,7 @@ int srd_instance_set_probe(struct srd_decoder_instance *di, return SRD_ERR_PYTHON; /* TODO: More specific error? */ } - probenum = PyInt_FromLong(num); + probenum = PyLong_FromLong(num); PyMapping_SetItemString(probedict, (char *)probename, probenum); Py_XDECREF(probenum); @@ -321,36 +230,49 @@ int srd_instance_set_probe(struct srd_decoder_instance *di, return SRD_OK; } +struct srd_decoder_instance *srd_instance_find(char *instance_id) +{ + GSList *l; + struct srd_decoder_instance *tmp, *di; -int srd_session_start(const char *driver, int unitsize, uint64_t starttime, - uint64_t samplerate) + di = NULL; + for (l = di_list; l; l = l->next) { + tmp = l->data; + if (!strcmp(tmp->instance_id, instance_id)) { + di = tmp; + break; + } + } + + return di; +} + +int srd_instance_start(struct srd_decoder_instance *di, PyObject *args) { - PyObject *py_res; - GSList *d; - struct srd_decoder_instance *di; + PyObject *py_name, *py_res; - fprintf(stdout, "%s: %s\n", __func__, driver); + srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id); - for (d = di_list; d; d = d->next) { - di = d->data; - if (!(py_res = PyObject_CallMethod(di->py_instance, "start", - "{s:s,s:l,s:l,s:l}", - "driver", driver, - "unitsize", (long)unitsize, - "starttime", (long)starttime, - "samplerate", (long)samplerate))) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - - return SRD_ERR_PYTHON; /* TODO: More specific error? */ - } - Py_XDECREF(py_res); + if (!(py_name = PyUnicode_FromString("start"))) { + srd_err("unable to build python object for 'start'"); + if (PyErr_Occurred()) + PyErr_Print(); + return SRD_ERR_PYTHON; } + if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance, + py_name, args, NULL))) { + if (PyErr_Occurred()) + PyErr_Print(); + return SRD_ERR_PYTHON; + } + + Py_XDECREF(py_res); + Py_DECREF(py_name); + return SRD_OK; } - /** * Run the specified decoder function. * @@ -360,16 +282,14 @@ int srd_session_start(const char *driver, int unitsize, uint64_t starttime, * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_run_decoder(uint64_t timeoffset, uint64_t duration, - struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen) +int srd_instance_decode(uint64_t timeoffset, uint64_t duration, + struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen) { PyObject *py_instance, *py_res; - -// fprintf(stdout, "%s: %s\n", __func__, dec->decoder->name); -// printf("to %u du %u len %d\n", timeoffset, duration, inbuflen); + srd_logic *logic; /* Return an error upon unusable input. */ - if (dec == NULL) + if (di == NULL) return SRD_ERR_ARG; /* TODO: More specific error? */ if (inbuf == NULL) return SRD_ERR_ARG; /* TODO: More specific error? */ @@ -377,11 +297,20 @@ int srd_run_decoder(uint64_t timeoffset, uint64_t duration, return SRD_ERR_ARG; /* TODO: More specific error? */ /* TODO: Error handling. */ - py_instance = dec->py_instance; + py_instance = di->py_instance; Py_XINCREF(py_instance); + logic = PyObject_New(srd_logic, &srd_logic_type); + Py_INCREF(logic); + logic->di = di; + logic->itercnt = 0; + logic->inbuf = inbuf; + logic->inbuflen = inbuflen; + logic->sample = PyList_New(2); + Py_INCREF(logic->sample); + if (!(py_res = PyObject_CallMethod(py_instance, "decode", - "KKs#", timeoffset, duration, inbuf, inbuflen))) { + "KKO", timeoffset, duration, logic))) { if (PyErr_Occurred()) PyErr_Print(); /* Returns void. */ @@ -389,10 +318,46 @@ int srd_run_decoder(uint64_t timeoffset, uint64_t duration, } Py_XDECREF(py_res); + return SRD_OK; } +int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) +{ + PyObject *args; + GSList *d, *s; + struct srd_decoder_instance *di; + int ret; + + if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { + srd_err("unable to build python object for metadata"); + return SRD_ERR_PYTHON; + } + + /* Run the start() method on all decoders receiving frontend data. */ + for (d = di_list; d; d = d->next) { + di = d->data; + di->num_probes = num_probes; + di->unitsize = unitsize; + di->samplerate = samplerate; + if ((ret = srd_instance_start(di, args) != SRD_OK)) + return ret; + + /* Run the start() method on all decoders up the stack from this one. */ + for (s = di->next_di; s; s = s->next) { + /* These don't need probes, unitsize and samplerate. */ + di = s->data; + if ((ret = srd_instance_start(di, args) != SRD_OK)) + return ret; + } + } + + Py_DECREF(args); + + return SRD_OK; +} + /* Feed logic samples to decoder session. */ int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, uint64_t inbuflen) @@ -400,10 +365,8 @@ int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, GSList *d; int ret; -// fprintf(stdout, "%s: %d bytes\n", __func__, inbuflen); - for (d = di_list; d; d = d->next) { - if ((ret = srd_run_decoder(timeoffset, duration, d->data, inbuf, + if ((ret = srd_instance_decode(timeoffset, duration, d->data, inbuf, inbuflen)) != SRD_OK) return ret; } @@ -412,43 +375,73 @@ int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf, } -int pd_output_new(struct srd_decoder_instance *di, int output_type, - char *protocol_id, char *description) +int pd_add(struct srd_decoder_instance *di, int output_type, + char *protocol_id) { - GSList *l; struct srd_pd_output *pdo; - int pdo_id; - - fprintf(stdout, "%s: output type %d, protocol_id %s, description %s\n", - __func__, output_type, protocol_id, description); - - pdo_id = -1; - for (l = di->pd_output; l; l = l->next) { - pdo = l->data; - if (pdo->pdo_id > pdo_id) - pdo_id = pdo->pdo_id; - } - pdo_id++; if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) return -1; - pdo->pdo_id = pdo_id; + /* 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); - pdo->description = g_strdup(description); di->pd_output = g_slist_append(di->pd_output, pdo); - return pdo_id; + return pdo->pdo_id; } +struct srd_decoder_instance *get_di_by_decobject(void *decobject) +{ + GSList *l, *s; + struct srd_decoder_instance *di; -//int srd_pipeline_new(int plid) -//{ -// -// -//} + for (l = di_list; l; l = l->next) { + di = l->data; + if (decobject == di->py_instance) + return di; + /* Check decoders stacked on top of this one. */ + for (s = di->next_di; s; s = s->next) { + di = s->data; + if (decobject == di->py_instance) + return di; + } + } + + return NULL; +} + +int srd_register_callback(int output_type, void *cb) +{ + struct srd_pd_callback *pd_cb; + if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) + return SRD_ERR_MALLOC; + pd_cb->output_type = output_type; + pd_cb->callback = cb; + callbacks = g_slist_append(callbacks, pd_cb); + return SRD_OK; +} + +void *srd_find_callback(int output_type) +{ + GSList *l; + struct srd_pd_callback *pd_cb; + void *(cb); + + cb = NULL; + for (l = callbacks; l; l = l->next) { + pd_cb = l->data; + if (pd_cb->output_type == output_type) { + cb = pd_cb->callback; + break; + } + } + + return cb; +}