2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
27 /* Re-define some string functions for Python >= 3.0. */
28 #if PY_VERSION_HEX >= 0x03000000
29 #define PyString_AsString PyBytes_AsString
30 #define PyString_FromString PyBytes_FromString
31 #define PyString_Check PyBytes_Check
34 /* The list of protocol decoders. */
35 static GSList *list_pds = NULL;
38 * Here's a quick overview of Python/C API reference counting.
40 * Check the Python/C API docs for what type of reference a function returns.
42 * - If it returns a "new reference", you're responsible to Py_XDECREF() it.
44 * - If it returns a "borrowed reference", you MUST NOT Py_XDECREF() it.
46 * - If a function "steals" a reference, you no longer are responsible for
47 * Py_XDECREF()ing it (someone else will do it for you at some point).
50 static int srd_load_decoder(const char *name, struct srd_decoder **dec);
52 static PyObject *emb_put(PyObject *self, PyObject *args)
58 if (!PyArg_ParseTuple(args, "O:put", &arg))
61 // fprintf(stdout, "sigrok.put() called by decoder:\n");
62 PyObject_Print(arg, stdout, Py_PRINT_RAW);
68 static PyMethodDef EmbMethods[] = {
69 {"put", emb_put, METH_VARARGS,
70 "Accepts a dictionary with the following keys: time, duration, data"},
75 * Initialize libsigrokdecode.
77 * This initializes the Python interpreter, and creates and initializes
78 * a "sigrok" Python module with a single put() method.
80 * Then, it searches for sigrok protocol decoder files (*.py) in the
81 * "decoders" subdirectory of the the sigrok installation directory.
82 * All decoders that are found are loaded into memory and added to an
83 * internal list of decoders, which can be queried via srd_list_decoders().
85 * The caller is responsible for calling the clean-up function srd_exit(),
86 * which will properly shut down libsigrokdecode and free its allocated memory.
88 * Multiple calls to srd_init(), without calling srd_exit() inbetween,
91 * @return SRD_OK upon success, a (negative) error code otherwise.
92 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
93 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
94 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
101 struct srd_decoder *dec;
104 /* Py_Initialize() returns void and usually cannot fail. */
107 /* TODO: Use Py_InitModule3() to add a docstring? */
108 if (!Py_InitModule("sigrok", EmbMethods)) {
109 Py_Finalize(); /* Returns void. */
110 return SRD_ERR_PYTHON;
113 /* Add search directory for the protocol decoders. */
114 /* FIXME: What happens if this function is called multiple times? */
115 ret = PyRun_SimpleString("import sys;"
116 "sys.path.append(r'" DECODERS_DIR "');");
118 Py_Finalize(); /* Returns void. */
119 return SRD_ERR_PYTHON;
122 if (!(dir = opendir(DECODERS_DIR))) {
123 Py_Finalize(); /* Returns void. */
124 return SRD_ERR_DECODERS_DIR;
127 while ((dp = readdir(dir)) != NULL) {
128 /* Ignore filenames which don't end with ".py". */
129 if (!g_str_has_suffix(dp->d_name, ".py"))
132 /* Decoder name == filename (without .py suffix). */
133 decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
135 /* TODO: Error handling. Use g_try_malloc(). */
136 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
137 Py_Finalize(); /* Returns void. */
138 return SRD_ERR_MALLOC;
141 /* Load the decoder. */
142 /* TODO: Warning if loading fails for a decoder. */
143 ret = srd_load_decoder(decodername, &dec);
145 /* Append it to the list of supported/loaded decoders. */
146 list_pds = g_slist_append(list_pds, dec);
155 * Returns the list of supported/loaded protocol decoders.
157 * This is a GSList containing the names of the decoders as strings.
159 * @return List of decoders, NULL if none are supported or loaded.
161 GSList *srd_list_decoders(void)
167 * Get the decoder with the specified ID.
169 * @param id The ID string of the decoder to return.
170 * @return The decoder with the specified ID, or NULL if not found.
172 struct srd_decoder *srd_get_decoder_by_id(const char *id)
175 struct srd_decoder *dec;
177 for (l = srd_list_decoders(); l; l = l->next) {
179 if (!strcmp(dec->id, id))
187 * Helper function to handle Python strings.
189 * TODO: @param entries.
191 * @return SRD_OK upon success, a (negative) error code otherwise.
192 * The 'outstr' argument points to a malloc()ed string upon success.
194 static int h_str(PyObject *py_res, PyObject *py_mod,
195 const char *key, char **outstr)
201 py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */
202 if (!py_str || !PyString_Check(py_str)) {
203 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
204 goto err_h_decref_mod;
208 * PyString_AsString()'s returned string refers to an internal buffer
209 * (not a copy), i.e. the data must not be modified, and the memory
210 * must not be free()'d.
212 if (!(str = PyString_AsString(py_str))) {
213 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
214 goto err_h_decref_str;
217 if (!(*outstr = g_strdup(str))) {
218 ret = SRD_ERR_MALLOC;
219 goto err_h_decref_str;
231 if (PyErr_Occurred())
232 PyErr_Print(); /* Returns void. */
242 * @return SRD_OK upon success, a (negative) error code otherwise.
244 static int srd_load_decoder(const char *name, struct srd_decoder **dec)
246 struct srd_decoder *d;
247 PyObject *py_mod, *py_res;
250 fprintf(stdout, "%s: %s\n", __func__, name);
252 /* "Import" the Python module. */
253 if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
254 PyErr_Print(); /* Returns void. */
255 return SRD_ERR_PYTHON; /* TODO: More specific error? */
258 /* Get the 'Decoder' class as Python object. */
259 py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
261 if (PyErr_Occurred())
262 PyErr_Print(); /* Returns void. */
264 fprintf(stderr, "Decoder class not found in PD module %s\n", name);
265 return SRD_ERR_PYTHON; /* TODO: More specific error? */
268 if (!(d = malloc(sizeof(struct srd_decoder))))
269 return SRD_ERR_MALLOC;
271 /* We'll just use the name of the module for the ID. */
272 d->id = strdup(name);
274 if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
277 if ((r = h_str(py_res, py_mod, "longname",
278 &(d->longname))) < 0)
281 if ((r = h_str(py_res, py_mod, "desc", &(d->desc))) < 0)
284 if ((r = h_str(py_res, py_mod, "longdesc",
285 &(d->longdesc))) < 0)
288 if ((r = h_str(py_res, py_mod, "author", &(d->author))) < 0)
291 if ((r = h_str(py_res, py_mod, "email", &(d->email))) < 0)
294 if ((r = h_str(py_res, py_mod, "license", &(d->license))) < 0)
298 d->py_decobj = py_res;
300 /* TODO: Handle func, inputformats, outputformats. */
301 /* Note: They must at least be set to NULL, will segfault otherwise. */
303 d->inputformats = NULL;
304 d->outputformats = NULL;
311 struct srd_decoder_instance *srd_instance_new(const char *id)
313 struct srd_decoder *dec;
314 struct srd_decoder_instance *di;
317 if (!(dec = srd_get_decoder_by_id(id)))
320 /* TODO: Error handling. Use g_try_malloc(). */
321 di = g_malloc(sizeof(*di));
323 /* Create an empty Python tuple. */
324 if (!(py_args = PyTuple_New(0))) { /* NEWREF */
325 if (PyErr_Occurred())
326 PyErr_Print(); /* Returns void. */
328 return NULL; /* TODO: More specific error? */
331 /* Create an instance of the 'Decoder' class. */
332 di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL);
333 if (!di->py_instance) {
334 if (PyErr_Occurred())
335 PyErr_Print(); /* Returns void. */
337 return NULL; /* TODO: More specific error? */
345 int srd_instance_set_probe(struct srd_decoder_instance *di,
346 const char *probename, int num)
348 PyObject *probedict, *probenum;
350 probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
352 if (PyErr_Occurred())
353 PyErr_Print(); /* Returns void. */
355 return SRD_ERR_PYTHON; /* TODO: More specific error? */
358 probenum = PyInt_FromLong(num);
359 PyMapping_SetItemString(probedict, (char *)probename, probenum);
361 Py_XDECREF(probenum);
362 Py_XDECREF(probedict);
367 int srd_instance_start(struct srd_decoder_instance *di,
368 const char *driver, int unitsize, uint64_t starttime,
373 if (!(py_res = PyObject_CallMethod(di->py_instance, "start",
376 "unitsize", (long)unitsize,
377 "starttime", (long)starttime,
378 "samplerate", (long)samplerate))) {
379 if (PyErr_Occurred())
380 PyErr_Print(); /* Returns void. */
382 return SRD_ERR_PYTHON; /* TODO: More specific error? */
389 * Run the specified decoder function.
393 * @param inbuflen TODO
395 * @param outbuflen TODO
397 * @return SRD_OK upon success, a (negative) error code otherwise.
399 int srd_run_decoder(struct srd_decoder_instance *dec,
400 uint8_t *inbuf, uint64_t inbuflen,
401 uint8_t **outbuf, uint64_t *outbuflen)
403 PyObject *py_instance, *py_res;
404 /* FIXME: Don't have a timebase available here. Make one up. */
405 static int _timehack = 0;
407 _timehack += inbuflen;
409 /* TODO: Use #defines for the return codes. */
411 /* Return an error upon unusable input. */
413 return SRD_ERR_ARGS; /* TODO: More specific error? */
415 return SRD_ERR_ARGS; /* TODO: More specific error? */
416 if (inbuflen == 0) /* No point in working on empty buffers. */
417 return SRD_ERR_ARGS; /* TODO: More specific error? */
419 return SRD_ERR_ARGS; /* TODO: More specific error? */
420 if (outbuflen == NULL)
421 return SRD_ERR_ARGS; /* TODO: More specific error? */
423 /* TODO: Error handling. */
424 py_instance = dec->py_instance;
425 Py_XINCREF(py_instance);
427 if (!(py_res = PyObject_CallMethod(py_instance, "decode",
431 "data", inbuf, inbuflen))) { /* NEWREF */
432 if (PyErr_Occurred())
433 PyErr_Print(); /* Returns void. */
435 return SRD_ERR_PYTHON; /* TODO: More specific error? */
445 static int srd_unload_decoder(struct srd_decoder *dec)
452 /* TODO: Free everything in inputformats and outputformats. */
454 if (dec->inputformats != NULL)
455 g_slist_free(dec->inputformats);
456 if (dec->outputformats != NULL)
457 g_slist_free(dec->outputformats);
459 Py_XDECREF(dec->py_decobj);
460 Py_XDECREF(dec->py_mod);
462 /* TODO: (g_)free dec itself? */
470 static int srd_unload_all_decoders(void)
473 struct srd_decoder *dec;
475 for (l = srd_list_decoders(); l; l = l->next) {
477 /* TODO: Error handling. */
478 srd_unload_decoder(dec);
485 * Shutdown libsigrokdecode.
487 * This frees all the memory allocated for protocol decoders and shuts down
488 * the Python interpreter.
490 * This function should only be called if there was a (successful!) invocation
491 * of srd_init() before. Calling this function multiple times in a row, without
492 * any successful srd_init() calls inbetween, is not allowed.
494 * @return SRD_OK upon success, a (negative) error code otherwise.
498 /* Unload/free all decoders, and then the list of decoders itself. */
499 /* TODO: Error handling. */
500 srd_unload_all_decoders();
501 g_slist_free(list_pds);
503 /* Py_Finalize() returns void, any finalization errors are ignored. */