X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decode.c;h=6a86b348dbbff48c838bdab4840bc44d0bb28596;hp=fb35517e8a526d16e4662bba9b952bf9bd37d806;hb=03325c23133175d4d1ea86b361c92b8cb12b1b36;hpb=052f32eee3b5e2f850f529c003bc90ef0bb88cc9 diff --git a/decode.c b/decode.c index fb35517..6a86b34 100644 --- a/decode.c +++ b/decode.c @@ -33,6 +33,8 @@ /* The list of protocol decoders. */ static GSList *list_pds = NULL; +/* The list of protocol decoder instances: struct srd_decoder_instance */ +static GSList *decoders; /* * Here's a quick overview of Python/C API reference counting. @@ -49,32 +51,49 @@ static GSList *list_pds = NULL; static int srd_load_decoder(const char *name, struct srd_decoder **dec); -static int _unitsize = 1; - -static PyObject* -emb_put(PyObject *self, PyObject *args) +static PyObject *emb_put(PyObject *self, PyObject *args) { PyObject *arg; - + + (void)self; + if (!PyArg_ParseTuple(args, "O:put", &arg)) return NULL; - fprintf(stderr, "sigrok.put() called by decoder:\n"); + // fprintf(stdout, "sigrok.put() called by decoder:\n"); PyObject_Print(arg, stdout, Py_PRINT_RAW); + puts(""); Py_RETURN_NONE; } static PyMethodDef EmbMethods[] = { {"put", emb_put, METH_VARARGS, - "Accepts a dictionary with the following keys: time, duration, data"}, + "Accepts a dictionary with the following keys: time, duration, data"}, {NULL, NULL, 0, NULL} }; /** * Initialize libsigrokdecode. * + * This initializes the Python interpreter, and creates and initializes + * a "sigrok" Python module with a single put() method. + * + * 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(). + * + * 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, + * are not allowed. + * * @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. */ int srd_init(void) { @@ -87,31 +106,44 @@ int srd_init(void) /* Py_Initialize() returns void and usually cannot fail. */ Py_Initialize(); - Py_InitModule("sigrok", EmbMethods); + /* TODO: Use Py_InitModule3() to add a docstring? */ + if (!Py_InitModule("sigrok", EmbMethods)) { + Py_Finalize(); /* Returns void. */ + return SRD_ERR_PYTHON; + } /* Add search directory for the protocol decoders. */ - /* FIXME: Check error code. */ /* FIXME: What happens if this function is called multiple times? */ - PyRun_SimpleString("import sys;" - "sys.path.append(r'" DECODERS_DIR "');"); + ret = PyRun_SimpleString("import sys;" + "sys.path.append(r'" DECODERS_DIR "');"); + if (ret != 0) { + Py_Finalize(); /* Returns void. */ + return SRD_ERR_PYTHON; + } - if (!(dir = opendir(DECODERS_DIR))) + if (!(dir = opendir(DECODERS_DIR))) { + Py_Finalize(); /* Returns void. */ return SRD_ERR_DECODERS_DIR; + } while ((dp = readdir(dir)) != NULL) { + /* Ignore filenames which don't end with ".py". */ if (!g_str_has_suffix(dp->d_name, ".py")) continue; /* Decoder name == filename (without .py suffix). */ decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3); - /* TODO: Error handling. */ - dec = malloc(sizeof(struct srd_decoder)); + /* TODO: Error handling. Use g_try_malloc(). */ + if (!(dec = malloc(sizeof(struct srd_decoder)))) { + Py_Finalize(); /* Returns void. */ + return SRD_ERR_MALLOC; + } /* Load the decoder. */ + /* TODO: Warning if loading fails for a decoder. */ ret = srd_load_decoder(decodername, &dec); - if (!ret) - { + if (!ret) { /* Append it to the list of supported/loaded decoders. */ list_pds = g_slist_append(list_pds, dec); } @@ -168,7 +200,7 @@ static int h_str(PyObject *py_res, PyObject *py_mod, char *str; int ret; - py_str = PyMapping_GetItemString(py_res, (char *)key); + py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */ if (!py_str || !PyString_Check(py_str)) { ret = SRD_ERR_PYTHON; /* TODO: More specific error? */ goto err_h_decref_mod; @@ -211,13 +243,13 @@ err_h_decref_mod: * * @return SRD_OK upon success, a (negative) error code otherwise. */ -static int srd_load_decoder(const char *name, - struct srd_decoder **dec) +static int srd_load_decoder(const char *name, struct srd_decoder **dec) { struct srd_decoder *d; - PyObject *py_mod, *py_func, *py_res, *py_instance = NULL, *py_args, *py_value/* , *py_tuple */; + PyObject *py_mod, *py_res; int r; - fprintf(stdout, "\n%s\n", name); + + fprintf(stdout, "%s: %s\n", __func__, name); /* "Import" the Python module. */ if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */ @@ -225,22 +257,21 @@ static int srd_load_decoder(const char *name, return SRD_ERR_PYTHON; /* TODO: More specific error? */ } - /* Get the 'register' dictionary as Python object. */ - py_res = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */ - if (!py_res || PyCallable_Check(py_res)) { + /* Get the 'Decoder' class as Python object. */ + py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */ + if (!py_res) { if (PyErr_Occurred()) PyErr_Print(); /* Returns void. */ Py_XDECREF(py_mod); - fprintf(stderr, "register dictionary was not found or is declared a function.\n"); + fprintf(stderr, "Decoder class not found in PD module %s\n", name); return SRD_ERR_PYTHON; /* TODO: More specific error? */ } - if (!(d = malloc(sizeof(struct srd_decoder)))) return SRD_ERR_MALLOC; - if ((r = h_str(py_res, py_mod, "id", &(d->id))) < 0) - return r; + /* We'll just use the name of the module for the ID. */ + d->id = strdup(name); if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0) return r; @@ -266,62 +297,7 @@ static int srd_load_decoder(const char *name, return r; d->py_mod = py_mod; - - Py_XDECREF(py_res); - - - /* Get the 'Decoder' class as Python object. */ - py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */ - if (!py_res) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - //Py_XDECREF(py_mod); - fprintf(stderr, "Decoder class not found in PD module %s\n", name); - //return SRD_ERR_PYTHON; /* TODO: More specific error? */ - - - /* Get the 'decode' function name as Python callable object. */ - py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */ - if (!py_func || !PyCallable_Check(py_func)) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - Py_XDECREF(py_mod); - return SRD_ERR_PYTHON; /* TODO: More specific error? */ - } - } else { - PyObject_Print(py_res, stdout, Py_PRINT_RAW); - fprintf(stdout, "\n"); - - /* Create a Python tuple of size 1. */ - if (!(py_args = PyTuple_New(0))) { /* NEWREF */ - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - - Py_XDECREF(py_res); - Py_XDECREF(py_mod); - - return SRD_ERR_PYTHON; /* TODO: More specific error? */ - } - - py_value = Py_BuildValue("{sssisd}", - "driver", "demo", - "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA - "starttime", 129318231823.0 //TODO: Fill with something reasonable. - ); - /* Create an instance of the Decoder class */ - py_instance = PyObject_Call(py_res, py_args, py_value); - if (!py_instance) { - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ - Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */ - Py_XDECREF(py_res); - Py_XDECREF(py_mod); - fprintf(stderr, "Unable to create instance of Decoder class in PD module %s\n", name); - return SRD_ERR_PYTHON; /* TODO: More specific error? */ - } - } - - d->py_instance = py_instance; + d->py_decobj = py_res; /* TODO: Handle func, inputformats, outputformats. */ /* Note: They must at least be set to NULL, will segfault otherwise. */ @@ -334,6 +310,92 @@ static int srd_load_decoder(const char *name, return SRD_OK; } +/** Create a new decoder instance and add to session. */ +struct srd_decoder_instance *srd_instance_new(const char *id) +{ + struct srd_decoder *dec; + struct srd_decoder_instance *di; + PyObject *py_args; + + if (!(dec = srd_get_decoder_by_id(id))) + return NULL; + + /* TODO: Error handling. Use g_try_malloc(). */ + di = g_malloc(sizeof(*di)); + + /* 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? */ + } + + /* 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. */ + Py_XDECREF(py_args); + return NULL; /* TODO: More specific error? */ + } + + /* Append to list of PD instances */ + decoders = g_slist_append(decoders, di); + + Py_XDECREF(py_args); + + return di; +} + +int srd_instance_set_probe(struct srd_decoder_instance *di, + const char *probename, int num) +{ + PyObject *probedict, *probenum; + + probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */ + if (!probedict) { + if (PyErr_Occurred()) + PyErr_Print(); /* Returns void. */ + + return SRD_ERR_PYTHON; /* TODO: More specific error? */ + } + + probenum = PyInt_FromLong(num); + PyMapping_SetItemString(probedict, (char *)probename, probenum); + + Py_XDECREF(probenum); + Py_XDECREF(probedict); + + return SRD_OK; +} + +/** Start decoding session. Feed metadata to decoder instances. */ +int srd_session_start(const char *driver, int unitsize, uint64_t starttime, + uint64_t samplerate) +{ + PyObject *py_res; + GSList *d; + for (d = decoders; d; d = d->next) { + struct srd_decoder_instance *di = d->data; + /* TODO: Error handling. */ + 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); + } + + return SRD_OK; +} + /** * Run the specified decoder function. * @@ -345,15 +407,13 @@ static int srd_load_decoder(const char *name, * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_run_decoder(struct srd_decoder *dec, - uint8_t *inbuf, uint64_t inbuflen, - uint8_t **outbuf, uint64_t *outbuflen) +static int srd_run_decoder(struct srd_decoder_instance *dec, + uint8_t *inbuf, uint64_t inbuflen) { - PyObject *py_mod, *py_instance, *py_args, *py_value, *py_res; - int r, ret; - + PyObject *py_instance, *py_res; /* FIXME: Don't have a timebase available here. Make one up. */ static int _timehack = 0; + _timehack += inbuflen; /* TODO: Use #defines for the return codes. */ @@ -365,53 +425,40 @@ int srd_run_decoder(struct srd_decoder *dec, return SRD_ERR_ARGS; /* TODO: More specific error? */ if (inbuflen == 0) /* No point in working on empty buffers. */ return SRD_ERR_ARGS; /* TODO: More specific error? */ - if (outbuf == NULL) - return SRD_ERR_ARGS; /* TODO: More specific error? */ - if (outbuflen == NULL) - return SRD_ERR_ARGS; /* TODO: More specific error? */ - + /* TODO: Error handling. */ - py_mod = dec->py_mod; - Py_XINCREF(py_mod); py_instance = dec->py_instance; Py_XINCREF(py_instance); - /* Create a Python tuple of size 1. */ - if (!(py_args = PyTuple_New(1))) { /* NEWREF */ - ret = SRD_ERR_PYTHON; /* TODO: More specific error? */ - goto err_run_decref_func; - } - - /* Get the input buffer as Python "string" (byte array). */ - /* TODO: int vs. uint64_t for 'inbuflen'? */ - - py_value = Py_BuildValue("{sisiss#}", - "time", _timehack, - "duration", 10, - "data", inbuf, inbuflen / _unitsize - ); - - if (!(py_res = PyObject_CallMethod(py_instance, "decode", - "O", py_value))) { /* NEWREF */ - ret = SRD_ERR_PYTHON; /* TODO: More specific error? */ - goto err_run_decref_args; - } - + if (!(py_res = PyObject_CallMethod(py_instance, "decode", + "{s:i,s:i,s:s#}", + "time", _timehack, + "duration", 10, + "data", inbuf, inbuflen))) { /* NEWREF */ + if (PyErr_Occurred()) + PyErr_Print(); /* Returns void. */ - ret = SRD_OK; + return SRD_ERR_PYTHON; /* TODO: More specific error? */ + } Py_XDECREF(py_res); + return SRD_OK; +} -err_run_decref_args: - Py_XDECREF(py_args); -err_run_decref_func: - Py_XDECREF(py_instance); - Py_XDECREF(py_mod); - - if (PyErr_Occurred()) - PyErr_Print(); /* Returns void. */ +/* Feed logic samples to decoder session. */ +int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen) +{ + GSList *d; + for (d = decoders; d; d = d->next) { + /* TODO: Error handling. */ + + int ret = srd_run_decoder(d->data, inbuf, inbuflen); - return ret; + if (ret != SRD_OK) { + fprintf(stderr, "Decoder runtime error (%d)\n", ret); + exit(1); + } + } } /** @@ -431,9 +478,11 @@ static int srd_unload_decoder(struct srd_decoder *dec) if (dec->outputformats != NULL) g_slist_free(dec->outputformats); - Py_XDECREF(dec->py_instance); + Py_XDECREF(dec->py_decobj); Py_XDECREF(dec->py_mod); + /* TODO: (g_)free dec itself? */ + return SRD_OK; } @@ -457,6 +506,13 @@ static int srd_unload_all_decoders(void) /** * 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 inbetween, is not allowed. + * * @return SRD_OK upon success, a (negative) error code otherwise. */ int srd_exit(void)