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 int _unitsize = 1;
54 static PyObject *emb_put(PyObject *self, PyObject *args)
60 if (!PyArg_ParseTuple(args, "O:put", &arg))
63 // fprintf(stdout, "sigrok.put() called by decoder:\n");
64 PyObject_Print(arg, stdout, Py_PRINT_RAW);
70 static PyMethodDef EmbMethods[] = {
71 {"put", emb_put, METH_VARARGS,
72 "Accepts a dictionary with the following keys: time, duration, data"},
77 * Initialize libsigrokdecode.
79 * This initializes the Python interpreter, and creates and initializes
80 * a "sigrok" Python module with a single put() method.
82 * Then, it searches for sigrok protocol decoder files (*.py) in the
83 * "decoders" subdirectory of the the sigrok installation directory.
84 * All decoders that are found are loaded into memory and added to an
85 * internal list of decoders, which can be queried via srd_list_decoders().
87 * The caller is responsible for calling the clean-up function srd_exit(),
88 * which will properly shut down libsigrokdecode and free its allocated memory.
90 * Multiple calls to srd_init(), without calling srd_exit() inbetween,
93 * @return SRD_OK upon success, a (negative) error code otherwise.
94 * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders
95 * directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
96 * If not enough memory could be allocated, return SRD_ERR_MALLOC.
103 struct srd_decoder *dec;
106 /* Py_Initialize() returns void and usually cannot fail. */
109 /* TODO: Use Py_InitModule3() to add a docstring? */
110 if (!Py_InitModule("sigrok", EmbMethods)) {
111 Py_Finalize(); /* Returns void. */
112 return SRD_ERR_PYTHON;
115 /* Add search directory for the protocol decoders. */
116 /* FIXME: What happens if this function is called multiple times? */
117 ret = PyRun_SimpleString("import sys;"
118 "sys.path.append(r'" DECODERS_DIR "');");
120 Py_Finalize(); /* Returns void. */
121 return SRD_ERR_PYTHON;
124 if (!(dir = opendir(DECODERS_DIR))) {
125 Py_Finalize(); /* Returns void. */
126 return SRD_ERR_DECODERS_DIR;
129 while ((dp = readdir(dir)) != NULL) {
130 /* Ignore filenames which don't end with ".py". */
131 if (!g_str_has_suffix(dp->d_name, ".py"))
134 /* Decoder name == filename (without .py suffix). */
135 decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
137 /* TODO: Error handling. Use g_try_malloc(). */
138 if (!(dec = malloc(sizeof(struct srd_decoder)))) {
139 Py_Finalize(); /* Returns void. */
140 return SRD_ERR_MALLOC;
143 /* Load the decoder. */
144 /* TODO: Warning if loading fails for a decoder. */
145 ret = srd_load_decoder(decodername, &dec);
147 /* Append it to the list of supported/loaded decoders. */
148 list_pds = g_slist_append(list_pds, dec);
157 * Returns the list of supported/loaded protocol decoders.
159 * This is a GSList containing the names of the decoders as strings.
161 * @return List of decoders, NULL if none are supported or loaded.
163 GSList *srd_list_decoders(void)
169 * Get the decoder with the specified ID.
171 * @param id The ID string of the decoder to return.
172 * @return The decoder with the specified ID, or NULL if not found.
174 struct srd_decoder *srd_get_decoder_by_id(const char *id)
177 struct srd_decoder *dec;
179 for (l = srd_list_decoders(); l; l = l->next) {
181 if (!strcmp(dec->id, id))
189 * Helper function to handle Python strings.
191 * TODO: @param entries.
193 * @return SRD_OK upon success, a (negative) error code otherwise.
194 * The 'outstr' argument points to a malloc()ed string upon success.
196 static int h_str(PyObject *py_res, PyObject *py_mod,
197 const char *key, char **outstr)
203 py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */
204 if (!py_str || !PyString_Check(py_str)) {
205 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
206 goto err_h_decref_mod;
210 * PyString_AsString()'s returned string refers to an internal buffer
211 * (not a copy), i.e. the data must not be modified, and the memory
212 * must not be free()'d.
214 if (!(str = PyString_AsString(py_str))) {
215 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
216 goto err_h_decref_str;
219 if (!(*outstr = g_strdup(str))) {
220 ret = SRD_ERR_MALLOC;
221 goto err_h_decref_str;
233 if (PyErr_Occurred())
234 PyErr_Print(); /* Returns void. */
244 * @return SRD_OK upon success, a (negative) error code otherwise.
246 static int srd_load_decoder(const char *name, struct srd_decoder **dec)
248 struct srd_decoder *d;
249 PyObject *py_mod, *py_res;
252 fprintf(stdout, "%s: %s\n", __func__, name);
254 /* "Import" the Python module. */
255 if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
256 PyErr_Print(); /* Returns void. */
257 return SRD_ERR_PYTHON; /* TODO: More specific error? */
260 /* Get the 'Decoder' class as Python object. */
261 py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
263 if (PyErr_Occurred())
264 PyErr_Print(); /* Returns void. */
266 fprintf(stderr, "Decoder class not found in PD module %s\n", name);
267 return SRD_ERR_PYTHON; /* TODO: More specific error? */
270 if (!(d = malloc(sizeof(struct srd_decoder))))
271 return SRD_ERR_MALLOC;
273 /* We'll just use the name of the module for the ID. */
274 d->id = strdup(name);
276 if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
279 if ((r = h_str(py_res, py_mod, "longname",
280 &(d->longname))) < 0)
283 if ((r = h_str(py_res, py_mod, "desc", &(d->desc))) < 0)
286 if ((r = h_str(py_res, py_mod, "longdesc",
287 &(d->longdesc))) < 0)
290 if ((r = h_str(py_res, py_mod, "author", &(d->author))) < 0)
293 if ((r = h_str(py_res, py_mod, "email", &(d->email))) < 0)
296 if ((r = h_str(py_res, py_mod, "license", &(d->license))) < 0)
300 d->py_decobj = py_res;
302 /* TODO: Handle func, inputformats, outputformats. */
303 /* Note: They must at least be set to NULL, will segfault otherwise. */
305 d->inputformats = NULL;
306 d->outputformats = NULL;
313 struct srd_decoder_instance *srd_instance_new(const char *id)
315 struct srd_decoder *dec;
316 struct srd_decoder_instance *di;
317 PyObject *py_args, *py_value;
319 if (!(dec = srd_get_decoder_by_id(id)))
322 /* TODO: Error handling. Use g_try_malloc(). */
323 di = g_malloc(sizeof(*di));
325 /* Create an empty Python tuple. */
326 if (!(py_args = PyTuple_New(0))) { /* NEWREF */
327 if (PyErr_Occurred())
328 PyErr_Print(); /* Returns void. */
330 return NULL; /* TODO: More specific error? */
334 * FIXME: Pass in a unitsize that matches the selected LA.
335 * FIXME: Fill 'starttime' with something reasonable.
337 py_value = Py_BuildValue("{sssisd}",
339 "unitsize", _unitsize,
340 "starttime", 129318231823.0);
342 /* Create an instance of the 'Decoder' class. */
343 di->py_instance = PyObject_Call(dec->py_decobj, py_args, py_value);
344 if (!di->py_instance) {
345 if (PyErr_Occurred())
346 PyErr_Print(); /* Returns void. */
348 Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
349 return NULL; /* TODO: More specific error? */
353 Py_XDECREF(py_value);
358 int srd_instance_set_probe(struct srd_decoder_instance *di,
359 const char *probename, int num)
361 PyObject *probedict, *probenum;
363 probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
365 if (PyErr_Occurred())
366 PyErr_Print(); /* Returns void. */
368 return SRD_ERR_PYTHON; /* TODO: More specific error? */
371 probenum = PyInt_FromLong(num);
372 PyMapping_SetItemString(probedict, (char *)probename, probenum);
374 Py_XDECREF(probenum);
375 Py_XDECREF(probedict);
381 * Run the specified decoder function.
385 * @param inbuflen TODO
387 * @param outbuflen TODO
389 * @return SRD_OK upon success, a (negative) error code otherwise.
391 int srd_run_decoder(struct srd_decoder_instance *dec,
392 uint8_t *inbuf, uint64_t inbuflen,
393 uint8_t **outbuf, uint64_t *outbuflen)
395 PyObject *py_instance, *py_value, *py_res;
397 /* FIXME: Don't have a timebase available here. Make one up. */
398 static int _timehack = 0;
400 _timehack += inbuflen;
402 /* TODO: Use #defines for the return codes. */
404 /* Return an error upon unusable input. */
406 return SRD_ERR_ARGS; /* TODO: More specific error? */
408 return SRD_ERR_ARGS; /* TODO: More specific error? */
409 if (inbuflen == 0) /* No point in working on empty buffers. */
410 return SRD_ERR_ARGS; /* TODO: More specific error? */
412 return SRD_ERR_ARGS; /* TODO: More specific error? */
413 if (outbuflen == NULL)
414 return SRD_ERR_ARGS; /* TODO: More specific error? */
416 /* TODO: Error handling. */
417 py_instance = dec->py_instance;
418 Py_XINCREF(py_instance);
420 /* Get the input buffer as Python "string" (byte array). */
421 /* TODO: int vs. uint64_t for 'inbuflen'? */
423 py_value = Py_BuildValue("{sisiss#}",
426 "data", inbuf, inbuflen / _unitsize);
428 if (!(py_res = PyObject_CallMethod(py_instance, "decode",
429 "O", py_value))) { /* NEWREF */
430 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
431 goto err_run_decref_args;
438 Py_XDECREF(py_value);
440 if (PyErr_Occurred())
441 PyErr_Print(); /* Returns void. */
449 static int srd_unload_decoder(struct srd_decoder *dec)
456 /* TODO: Free everything in inputformats and outputformats. */
458 if (dec->inputformats != NULL)
459 g_slist_free(dec->inputformats);
460 if (dec->outputformats != NULL)
461 g_slist_free(dec->outputformats);
463 Py_XDECREF(dec->py_decobj);
464 Py_XDECREF(dec->py_mod);
466 /* TODO: (g_)free dec itself? */
474 static int srd_unload_all_decoders(void)
477 struct srd_decoder *dec;
479 for (l = srd_list_decoders(); l; l = l->next) {
481 /* TODO: Error handling. */
482 srd_unload_decoder(dec);
489 * Shutdown libsigrokdecode.
491 * This frees all the memory allocated for protocol decoders and shuts down
492 * the Python interpreter.
494 * This function should only be called if there was a (successful!) invocation
495 * of srd_init() before. Calling this function multiple times in a row, without
496 * any successful srd_init() calls inbetween, is not allowed.
498 * @return SRD_OK upon success, a (negative) error code otherwise.
502 /* Unload/free all decoders, and then the list of decoders itself. */
503 /* TODO: Error handling. */
504 srd_unload_all_decoders();
505 g_slist_free(list_pds);
507 /* Py_Finalize() returns void, any finalization errors are ignored. */