2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "sigrokdecode-internal.h"
29 * Listing, loading, unloading, and handling protocol decoders.
34 /* The list of protocol decoders. */
35 SRD_PRIV GSList *pd_list = NULL;
37 /* module_sigrokdecode.c */
38 extern SRD_PRIV PyObject *mod_sigrokdecode;
43 * Returns the list of supported/loaded protocol decoders.
45 * This is a GSList containing the names of the decoders as strings.
47 * @return List of decoders, NULL if none are supported or loaded.
49 SRD_API const GSList *srd_decoder_list(void)
55 * Get the decoder with the specified ID.
57 * @param id The ID string of the decoder to return.
59 * @return The decoder with the specified ID, or NULL if not found.
61 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id)
64 struct srd_decoder *dec;
66 for (l = pd_list; l; l = l->next) {
68 if (!strcmp(dec->id, id))
75 static int get_probes(const struct srd_decoder *d, const char *attr,
78 PyObject *py_probelist, *py_entry;
80 int ret, num_probes, i;
82 if (!PyObject_HasAttrString(d->py_dec, attr))
83 /* No probes of this type specified. */
87 py_probelist = py_entry = NULL;
89 py_probelist = PyObject_GetAttrString(d->py_dec, attr);
90 if (!PyList_Check(py_probelist)) {
91 srd_err("Protocol decoder %s %s attribute is not "
92 "a list.", d->name, attr);
96 num_probes = PyList_Size(py_probelist);
98 /* Empty probelist. */
101 for (i = 0; i < num_probes; i++) {
102 py_entry = PyList_GetItem(py_probelist, i);
103 if (!PyDict_Check(py_entry)) {
104 srd_err("Protocol decoder %s %s attribute is not "
105 "a list with dict elements.", d->name, attr);
109 if (!(p = g_try_malloc(sizeof(struct srd_probe)))) {
110 srd_err("Failed to g_malloc() struct srd_probe.");
111 ret = SRD_ERR_MALLOC;
115 if ((py_dictitem_as_str(py_entry, "id", &p->id)) != SRD_OK)
117 if ((py_dictitem_as_str(py_entry, "name", &p->name)) != SRD_OK)
119 if ((py_dictitem_as_str(py_entry, "desc", &p->desc)) != SRD_OK)
123 *pl = g_slist_append(*pl, p);
129 Py_DecRef(py_probelist);
135 * Load a protocol decoder module into the embedded Python interpreter.
137 * @param module_name The module name to be loaded.
139 * @return SRD_OK upon success, a (negative) error code otherwise.
141 SRD_API int srd_decoder_load(const char *module_name)
143 PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann;
144 struct srd_decoder *d;
150 srd_dbg("Loading protocol decoder '%s'.", module_name);
152 py_basedec = py_method = py_attr = NULL;
154 if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) {
155 srd_dbg("Failed to g_malloc() struct srd_decoder.");
156 ret = SRD_ERR_MALLOC;
160 ret = SRD_ERR_PYTHON;
162 /* Import the Python module. */
163 if (!(d->py_mod = PyImport_ImportModule(module_name))) {
164 srd_exception_catch("Import of '%s' failed.", module_name);
168 /* Get the 'Decoder' class as Python object. */
169 if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) {
170 /* This generated an AttributeError exception. */
172 srd_err("Decoder class not found in protocol decoder %s.",
177 if (!(py_basedec = PyObject_GetAttrString(mod_sigrokdecode, "Decoder"))) {
178 srd_dbg("sigrokdecode module not loaded.");
182 if (!PyObject_IsSubclass(d->py_dec, py_basedec)) {
183 srd_err("Decoder class in protocol decoder module %s is not "
184 "a subclass of sigrokdecode.Decoder.", module_name);
187 Py_CLEAR(py_basedec);
189 /* Check for a proper start() method. */
190 if (!PyObject_HasAttrString(d->py_dec, "start")) {
191 srd_err("Protocol decoder %s has no start() method Decoder "
192 "class.", module_name);
195 py_method = PyObject_GetAttrString(d->py_dec, "start");
196 if (!PyFunction_Check(py_method)) {
197 srd_err("Protocol decoder %s Decoder class attribute 'start' "
198 "is not a method.", module_name);
203 /* Check for a proper decode() method. */
204 if (!PyObject_HasAttrString(d->py_dec, "decode")) {
205 srd_err("Protocol decoder %s has no decode() method Decoder "
206 "class.", module_name);
209 py_method = PyObject_GetAttrString(d->py_dec, "decode");
210 if (!PyFunction_Check(py_method)) {
211 srd_err("Protocol decoder %s Decoder class attribute 'decode' "
212 "is not a method.", module_name);
217 /* If present, options must be a dictionary. */
218 if (PyObject_HasAttrString(d->py_dec, "options")) {
219 py_attr = PyObject_GetAttrString(d->py_dec, "options");
220 if (!PyDict_Check(py_attr)) {
221 srd_err("Protocol decoder %s options attribute is not "
222 "a dictionary.", d->name);
229 /* Check and import required probes. */
230 if (get_probes(d, "probes", &d->probes) != SRD_OK)
233 /* Check and import optional probes. */
234 if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK)
238 * Fix order numbers for the optional probes.
241 * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4.
242 * 'order' fields in the d->probes list = 0, 1, 2.
243 * 'order' fields in the d->opt_probes list = 3, 4, 5, 6.
245 for (l = d->opt_probes; l; l = l->next) {
247 p->order += g_slist_length(d->probes);
250 /* Store required fields in newly allocated strings. */
251 if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK)
254 if (py_attr_as_str(d->py_dec, "name", &(d->name)) != SRD_OK)
257 if (py_attr_as_str(d->py_dec, "longname", &(d->longname)) != SRD_OK)
260 if (py_attr_as_str(d->py_dec, "desc", &(d->desc)) != SRD_OK)
263 if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK)
266 /* Convert class annotation attribute to GSList of **char. */
267 d->annotations = NULL;
268 if (PyObject_HasAttrString(d->py_dec, "annotations")) {
269 py_annlist = PyObject_GetAttrString(d->py_dec, "annotations");
270 if (!PyList_Check(py_annlist)) {
271 srd_err("Protocol decoder module %s annotations "
272 "should be a list.", module_name);
275 alen = PyList_Size(py_annlist);
276 for (i = 0; i < alen; i++) {
277 py_ann = PyList_GetItem(py_annlist, i);
278 if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) {
279 srd_err("Protocol decoder module %s "
280 "annotation %d should be a list with "
281 "two elements.", module_name, i + 1);
285 if (py_strlist_to_char(py_ann, &ann) != SRD_OK) {
288 d->annotations = g_slist_append(d->annotations, ann);
292 /* Append it to the list of supported/loaded decoders. */
293 pd_list = g_slist_append(pd_list, d);
299 Py_XDECREF(py_method);
300 Py_XDECREF(py_basedec);
301 Py_XDECREF(d->py_dec);
302 Py_XDECREF(d->py_mod);
310 * Return a protocol decoder's docstring.
312 * @param dec The loaded protocol decoder.
314 * @return A newly allocated buffer containing the protocol decoder's
315 * documentation. The caller is responsible for free'ing the buffer.
317 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec)
322 if (!PyObject_HasAttrString(dec->py_mod, "__doc__"))
325 if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) {
326 srd_exception_catch("");
331 if (py_str != Py_None)
332 py_str_as_str(py_str, &doc);
338 static void free_probes(GSList *probelist)
343 if (probelist == NULL)
346 for (l = probelist; l; l = l->next) {
353 g_slist_free(probelist);
357 * Unload decoder module.
359 * @param dec The struct srd_decoder to be unloaded.
361 * @return SRD_OK upon success, a (negative) error code otherwise.
363 SRD_API int srd_decoder_unload(struct srd_decoder *dec)
365 srd_dbg("Unloading protocol decoder '%s'.", dec->name);
368 * Since any instances of this decoder need to be released as well,
369 * but they could be anywhere in the stack, just free the entire
370 * stack. A frontend reloading a decoder thus has to restart all
371 * instances, and rebuild the stack.
373 srd_inst_free_all(NULL);
375 free_probes(dec->probes);
376 free_probes(dec->opt_probes);
379 g_free(dec->longname);
381 g_free(dec->license);
383 /* The module's Decoder class. */
384 Py_XDECREF(dec->py_dec);
385 /* The module itself. */
386 Py_XDECREF(dec->py_mod);
388 /* TODO: (g_)free dec itself? */
394 * Load all installed protocol decoders.
396 * @return SRD_OK upon success, a (negative) error code otherwise.
398 SRD_API int srd_decoder_load_all(void)
402 const gchar *direntry;
404 if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) {
405 srd_err("Unable to open %s for reading.", DECODERS_DIR);
406 return SRD_ERR_DECODERS_DIR;
409 while ((direntry = g_dir_read_name(dir)) != NULL) {
410 /* The directory name is the module name (e.g. "i2c"). */
411 srd_decoder_load(direntry);
419 * Unload all loaded protocol decoders.
421 * @return SRD_OK upon success, a (negative) error code otherwise.
423 SRD_API int srd_decoder_unload_all(void)
426 struct srd_decoder *dec;
428 for (l = pd_list; l; l = l->next) {
430 srd_decoder_unload(dec);