X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decode.c;h=727134a4c45bfbd939429c52781866579cf04697;hp=396cde8bb1b4bd819cfc614e5a73e0227b851ed0;hb=ad2dc0de10ac5c2c6c3aacff0b2835cd4dc22578;hpb=f97f531c2d31b729afbf1c97a0d017526bf8e52a diff --git a/decode.c b/decode.c index 396cde8..727134a 100644 --- a/decode.c +++ b/decode.c @@ -51,11 +51,10 @@ 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)) @@ -70,14 +69,31 @@ emb_put(PyObject *self, PyObject *args) 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) { @@ -90,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); } @@ -214,12 +243,12 @@ 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_res; int r; + fprintf(stdout, "%s: %s\n", __func__, name); /* "Import" the Python module. */ @@ -241,7 +270,7 @@ static int srd_load_decoder(const char *name, if (!(d = malloc(sizeof(struct srd_decoder)))) return SRD_ERR_MALLOC; - /* We'll just use the name of the module for the id */ + /* 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) @@ -283,27 +312,34 @@ static int srd_load_decoder(const char *name, struct srd_decoder_instance *srd_instance_new(const char *id) { - struct srd_decoder *dec = srd_get_decoder_by_id(id); - if (!dec) - return NULL; - struct srd_decoder_instance *di = g_malloc(sizeof(*di)); + struct srd_decoder *dec; + struct srd_decoder_instance *di; PyObject *py_args, *py_value; - /* Create a Python tuple of size 1. */ + 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? */ } - - 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 */ + /* + * FIXME: Pass in a unitsize that matches the selected LA. + * FIXME: Fill 'starttime' with something reasonable. + */ + py_value = Py_BuildValue("{sssisd}", + "driver", "demo", + "unitsize", _unitsize, + "starttime", 129318231823.0); + + /* Create an instance of the 'Decoder' class. */ di->py_instance = PyObject_Call(dec->py_decobj, py_args, py_value); if (!di->py_instance) { if (PyErr_Occurred()) @@ -311,7 +347,7 @@ struct srd_decoder_instance *srd_instance_new(const char *id) Py_XDECREF(py_args); Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */ return NULL; /* TODO: More specific error? */ - } + } Py_XDECREF(py_args); Py_XDECREF(py_value); @@ -320,22 +356,24 @@ struct srd_decoder_instance *srd_instance_new(const char *id) } int srd_instance_set_probe(struct srd_decoder_instance *di, - const char *probename, int num) + 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); + PyMapping_SetItemString(probedict, (char *)probename, probenum); Py_XDECREF(probenum); Py_XDECREF(probedict); + return SRD_OK; } @@ -351,14 +389,14 @@ int srd_instance_set_probe(struct srd_decoder_instance *di, * @return SRD_OK upon success, a (negative) error code otherwise. */ int srd_run_decoder(struct srd_decoder_instance *dec, - uint8_t *inbuf, uint64_t inbuflen, - uint8_t **outbuf, uint64_t *outbuflen) + uint8_t *inbuf, uint64_t inbuflen, + uint8_t **outbuf, uint64_t *outbuflen) { PyObject *py_instance, *py_value, *py_res; int ret; - /* FIXME: Don't have a timebase available here. Make one up. */ static int _timehack = 0; + _timehack += inbuflen; /* TODO: Use #defines for the return codes. */ @@ -374,7 +412,7 @@ int srd_run_decoder(struct srd_decoder_instance *dec, return SRD_ERR_ARGS; /* TODO: More specific error? */ if (outbuflen == NULL) return SRD_ERR_ARGS; /* TODO: More specific error? */ - + /* TODO: Error handling. */ py_instance = dec->py_instance; Py_XINCREF(py_instance); @@ -382,19 +420,17 @@ int srd_run_decoder(struct srd_decoder_instance *dec, /* 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 - ); + 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 */ + 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; } - ret = SRD_OK; Py_XDECREF(py_res); @@ -427,6 +463,8 @@ static int srd_unload_decoder(struct srd_decoder *dec) Py_XDECREF(dec->py_decobj); Py_XDECREF(dec->py_mod); + /* TODO: (g_)free dec itself? */ + return SRD_OK; } @@ -450,6 +488,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)