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;
55 emb_put(PyObject *self, PyObject *args)
61 if (!PyArg_ParseTuple(args, "O:put", &arg))
64 fprintf(stdout, "sigrok.put() called by decoder:\n");
65 PyObject_Print(arg, stdout, Py_PRINT_RAW);
71 static PyMethodDef EmbMethods[] = {
72 {"put", emb_put, METH_VARARGS,
73 "Accepts a dictionary with the following keys: time, duration, data"},
78 * Initialize libsigrokdecode.
80 * @return SRD_OK upon success, a (negative) error code otherwise.
87 struct srd_decoder *dec;
90 /* Py_Initialize() returns void and usually cannot fail. */
93 Py_InitModule("sigrok", EmbMethods);
95 /* Add search directory for the protocol decoders. */
96 /* FIXME: Check error code. */
97 /* FIXME: What happens if this function is called multiple times? */
98 PyRun_SimpleString("import sys;"
99 "sys.path.append(r'" DECODERS_DIR "');");
101 if (!(dir = opendir(DECODERS_DIR)))
102 return SRD_ERR_DECODERS_DIR;
104 while ((dp = readdir(dir)) != NULL) {
105 if (!g_str_has_suffix(dp->d_name, ".py"))
108 /* Decoder name == filename (without .py suffix). */
109 decodername = g_strndup(dp->d_name, strlen(dp->d_name) - 3);
111 /* TODO: Error handling. */
112 dec = malloc(sizeof(struct srd_decoder));
114 /* Load the decoder. */
115 ret = srd_load_decoder(decodername, &dec);
118 /* Append it to the list of supported/loaded decoders. */
119 list_pds = g_slist_append(list_pds, dec);
128 * Returns the list of supported/loaded protocol decoders.
130 * This is a GSList containing the names of the decoders as strings.
132 * @return List of decoders, NULL if none are supported or loaded.
134 GSList *srd_list_decoders(void)
140 * Get the decoder with the specified ID.
142 * @param id The ID string of the decoder to return.
143 * @return The decoder with the specified ID, or NULL if not found.
145 struct srd_decoder *srd_get_decoder_by_id(const char *id)
148 struct srd_decoder *dec;
150 for (l = srd_list_decoders(); l; l = l->next) {
152 if (!strcmp(dec->id, id))
160 * Helper function to handle Python strings.
162 * TODO: @param entries.
164 * @return SRD_OK upon success, a (negative) error code otherwise.
165 * The 'outstr' argument points to a malloc()ed string upon success.
167 static int h_str(PyObject *py_res, PyObject *py_mod,
168 const char *key, char **outstr)
174 py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */
175 if (!py_str || !PyString_Check(py_str)) {
176 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
177 goto err_h_decref_mod;
181 * PyString_AsString()'s returned string refers to an internal buffer
182 * (not a copy), i.e. the data must not be modified, and the memory
183 * must not be free()'d.
185 if (!(str = PyString_AsString(py_str))) {
186 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
187 goto err_h_decref_str;
190 if (!(*outstr = g_strdup(str))) {
191 ret = SRD_ERR_MALLOC;
192 goto err_h_decref_str;
204 if (PyErr_Occurred())
205 PyErr_Print(); /* Returns void. */
215 * @return SRD_OK upon success, a (negative) error code otherwise.
217 static int srd_load_decoder(const char *name,
218 struct srd_decoder **dec)
220 struct srd_decoder *d;
221 PyObject *py_mod, *py_res;
223 fprintf(stdout, "%s: %s\n", __func__, name);
225 /* "Import" the Python module. */
226 if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
227 PyErr_Print(); /* Returns void. */
228 return SRD_ERR_PYTHON; /* TODO: More specific error? */
231 /* Get the 'Decoder' class as Python object. */
232 py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
234 if (PyErr_Occurred())
235 PyErr_Print(); /* Returns void. */
237 fprintf(stderr, "Decoder class not found in PD module %s\n", name);
238 return SRD_ERR_PYTHON; /* TODO: More specific error? */
241 if (!(d = malloc(sizeof(struct srd_decoder))))
242 return SRD_ERR_MALLOC;
244 /* We'll just use the name of the module for the id */
245 d->id = strdup(name);
247 if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
250 if ((r = h_str(py_res, py_mod, "longname",
251 &(d->longname))) < 0)
254 if ((r = h_str(py_res, py_mod, "desc", &(d->desc))) < 0)
257 if ((r = h_str(py_res, py_mod, "longdesc",
258 &(d->longdesc))) < 0)
261 if ((r = h_str(py_res, py_mod, "author", &(d->author))) < 0)
264 if ((r = h_str(py_res, py_mod, "email", &(d->email))) < 0)
267 if ((r = h_str(py_res, py_mod, "license", &(d->license))) < 0)
271 d->py_decobj = py_res;
273 /* TODO: Handle func, inputformats, outputformats. */
274 /* Note: They must at least be set to NULL, will segfault otherwise. */
276 d->inputformats = NULL;
277 d->outputformats = NULL;
284 struct srd_decoder_instance *srd_instance_new(const char *id)
286 struct srd_decoder *dec = srd_get_decoder_by_id(id);
289 struct srd_decoder_instance *di = g_malloc(sizeof(*di));
290 PyObject *py_args, *py_value;
292 /* Create a Python tuple of size 1. */
293 if (!(py_args = PyTuple_New(0))) { /* NEWREF */
294 if (PyErr_Occurred())
295 PyErr_Print(); /* Returns void. */
297 return NULL; /* TODO: More specific error? */
300 py_value = Py_BuildValue("{sssisd}",
302 "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA
303 "starttime", 129318231823.0 //TODO: Fill with something reasonable.
306 /* Create an instance of the Decoder class */
307 di->py_instance = PyObject_Call(dec->py_decobj, py_args, py_value);
308 if (!di->py_instance) {
309 if (PyErr_Occurred())
310 PyErr_Print(); /* Returns void. */
312 Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
313 return NULL; /* TODO: More specific error? */
317 Py_XDECREF(py_value);
322 int srd_instance_set_probe(struct srd_decoder_instance *di,
323 const char *probename, int num)
325 PyObject *probedict, *probenum;
326 probedict = PyObject_GetAttrString(di->py_instance, "probes"); /* NEWREF */
328 if (PyErr_Occurred())
329 PyErr_Print(); /* Returns void. */
331 return SRD_ERR_PYTHON; /* TODO: More specific error? */
334 probenum = PyInt_FromLong(num);
335 PyMapping_SetItemString(probedict, (char*)probename, probenum);
337 Py_XDECREF(probenum);
338 Py_XDECREF(probedict);
343 * Run the specified decoder function.
347 * @param inbuflen TODO
349 * @param outbuflen TODO
351 * @return SRD_OK upon success, a (negative) error code otherwise.
353 int srd_run_decoder(struct srd_decoder_instance *dec,
354 uint8_t *inbuf, uint64_t inbuflen,
355 uint8_t **outbuf, uint64_t *outbuflen)
357 PyObject *py_instance, *py_value, *py_res;
360 /* FIXME: Don't have a timebase available here. Make one up. */
361 static int _timehack = 0;
362 _timehack += inbuflen;
364 /* TODO: Use #defines for the return codes. */
366 /* Return an error upon unusable input. */
368 return SRD_ERR_ARGS; /* TODO: More specific error? */
370 return SRD_ERR_ARGS; /* TODO: More specific error? */
371 if (inbuflen == 0) /* No point in working on empty buffers. */
372 return SRD_ERR_ARGS; /* TODO: More specific error? */
374 return SRD_ERR_ARGS; /* TODO: More specific error? */
375 if (outbuflen == NULL)
376 return SRD_ERR_ARGS; /* TODO: More specific error? */
378 /* TODO: Error handling. */
379 py_instance = dec->py_instance;
380 Py_XINCREF(py_instance);
382 /* Get the input buffer as Python "string" (byte array). */
383 /* TODO: int vs. uint64_t for 'inbuflen'? */
385 py_value = Py_BuildValue("{sisiss#}",
388 "data", inbuf, inbuflen / _unitsize
391 if (!(py_res = PyObject_CallMethod(py_instance, "decode",
392 "O", py_value))) { /* NEWREF */
393 ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
394 goto err_run_decref_args;
402 Py_XDECREF(py_value);
404 if (PyErr_Occurred())
405 PyErr_Print(); /* Returns void. */
413 static int srd_unload_decoder(struct srd_decoder *dec)
420 /* TODO: Free everything in inputformats and outputformats. */
422 if (dec->inputformats != NULL)
423 g_slist_free(dec->inputformats);
424 if (dec->outputformats != NULL)
425 g_slist_free(dec->outputformats);
427 Py_XDECREF(dec->py_decobj);
428 Py_XDECREF(dec->py_mod);
436 static int srd_unload_all_decoders(void)
439 struct srd_decoder *dec;
441 for (l = srd_list_decoders(); l; l = l->next) {
443 /* TODO: Error handling. */
444 srd_unload_decoder(dec);
451 * Shutdown libsigrokdecode.
453 * @return SRD_OK upon success, a (negative) error code otherwise.
457 /* Unload/free all decoders, and then the list of decoders itself. */
458 /* TODO: Error handling. */
459 srd_unload_all_decoders();
460 g_slist_free(list_pds);
462 /* Py_Finalize() returns void, any finalization errors are ignored. */