]>
Commit | Line | Data |
---|---|---|
1c6fa20f UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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 | |
19 | */ | |
20 | ||
21 | #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
22 | #include <stdio.h> | |
5c55017c | 23 | #include <string.h> |
7c24d086 | 24 | #include <dirent.h> |
d842aebe | 25 | #include <config.h> |
1c6fa20f | 26 | |
e6c7a826 UH |
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 | |
32 | #endif | |
33 | ||
7c24d086 | 34 | /* The list of protocol decoders. */ |
871d21e2 | 35 | GSList *list_pds = NULL; |
7c24d086 | 36 | |
f800adc4 UH |
37 | /* |
38 | * Here's a quick overview of Python/C API reference counting. | |
39 | * | |
40 | * Check the Python/C API docs for what type of reference a function returns. | |
41 | * | |
2557ad9d | 42 | * - If it returns a "new reference", you're responsible to Py_XDECREF() it. |
f800adc4 | 43 | * |
2557ad9d | 44 | * - If it returns a "borrowed reference", you MUST NOT Py_XDECREF() it. |
f800adc4 UH |
45 | * |
46 | * - If a function "steals" a reference, you no longer are responsible for | |
2557ad9d | 47 | * Py_XDECREF()ing it (someone else will do it for you at some point). |
f800adc4 UH |
48 | */ |
49 | ||
1c6fa20f UH |
50 | /** |
51 | * Initialize libsigrokdecode. | |
52 | * | |
70e44845 | 53 | * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise. |
1c6fa20f UH |
54 | */ |
55 | int sigrokdecode_init(void) | |
56 | { | |
7c24d086 UH |
57 | DIR *dir; |
58 | struct dirent *dp; | |
59 | char *tmp; | |
60 | ||
1c6fa20f UH |
61 | /* Py_Initialize() returns void and usually cannot fail. */ |
62 | Py_Initialize(); | |
63 | ||
0895f56a | 64 | /* Add search directory for the protocol decoders. */ |
2454527d | 65 | /* FIXME: Check error code. */ |
70e44845 | 66 | /* FIXME: What happens if this function is called multiple times? */ |
0895f56a | 67 | PyRun_SimpleString("import sys;" |
10426068 | 68 | "sys.path.append(r'" DECODERS_DIR "');"); |
1c6fa20f | 69 | |
7c24d086 UH |
70 | if (!(dir = opendir(DECODERS_DIR))) |
71 | return SIGROKDECODE_ERR_DECODERS_DIR; | |
72 | ||
73 | while ((dp = readdir(dir)) != NULL) { | |
276b55eb | 74 | if (!g_str_has_suffix(dp->d_name, ".py")) |
7c24d086 | 75 | continue; |
5b05904d UH |
76 | /* For now use the filename (without .py) as decoder name. */ |
77 | if ((tmp = g_strndup(dp->d_name, strlen(dp->d_name) - 3))) | |
7c24d086 UH |
78 | list_pds = g_slist_append(list_pds, tmp); |
79 | } | |
80 | closedir(dir); | |
81 | ||
70e44845 | 82 | return SIGROKDECODE_OK; |
1c6fa20f UH |
83 | } |
84 | ||
871d21e2 UH |
85 | /** |
86 | * Returns the list of supported/loaded protocol decoders. | |
87 | * | |
88 | * This is a GSList containing the names of the decoders as strings. | |
89 | * | |
90 | * @return List of decoders, NULL if none are supported or loaded. | |
91 | */ | |
92 | GSList *sigrokdecode_list_decoders(void) | |
93 | { | |
94 | return list_pds; | |
95 | } | |
96 | ||
5c55017c UH |
97 | /** |
98 | * Helper function to handle Python strings. | |
99 | * | |
100 | * TODO: @param entries. | |
101 | * | |
3a9a7e38 | 102 | * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise. |
70e44845 | 103 | * The 'outstr' argument points to a malloc()ed string upon success. |
5c55017c UH |
104 | */ |
105 | static int h_str(PyObject *py_res, PyObject *py_func, PyObject *py_mod, | |
106 | const char *key, char **outstr) | |
107 | { | |
108 | PyObject *py_str; | |
109 | char *str; | |
f7313eea | 110 | int ret; |
5c55017c UH |
111 | |
112 | py_str = PyMapping_GetItemString(py_res, (char *)key); | |
113 | if (!py_str || !PyString_Check(py_str)) { | |
f7313eea UH |
114 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
115 | goto err_h_decref_func; | |
5c55017c UH |
116 | } |
117 | ||
6b08da24 UH |
118 | /* |
119 | * PyString_AsString()'s returned string refers to an internal buffer | |
120 | * (not a copy), i.e. the data must not be modified, and the memory | |
121 | * must not be free()'d. | |
122 | */ | |
5c55017c | 123 | if (!(str = PyString_AsString(py_str))) { |
f7313eea UH |
124 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
125 | goto err_h_decref_str; | |
5c55017c UH |
126 | } |
127 | ||
128 | if (!(*outstr = strdup(str))) { | |
f7313eea UH |
129 | ret = SIGROKDECODE_ERR_MALLOC; |
130 | goto err_h_decref_str; | |
5c55017c UH |
131 | } |
132 | ||
2557ad9d | 133 | Py_XDECREF(py_str); |
5c55017c | 134 | |
70e44845 | 135 | return SIGROKDECODE_OK; |
f7313eea UH |
136 | |
137 | err_h_decref_str: | |
138 | Py_XDECREF(py_str); | |
139 | err_h_decref_func: | |
140 | Py_XDECREF(py_func); | |
141 | err_h_decref_mod: | |
142 | Py_XDECREF(py_mod); | |
143 | ||
144 | if (PyErr_Occurred()) | |
145 | PyErr_Print(); /* Returns void. */ | |
146 | ||
147 | return ret; | |
5c55017c UH |
148 | } |
149 | ||
1c6fa20f UH |
150 | /** |
151 | * TODO | |
152 | * | |
153 | * @param name TODO | |
70e44845 | 154 | * |
3a9a7e38 | 155 | * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise. |
1c6fa20f | 156 | */ |
5c55017c UH |
157 | int sigrokdecode_load_decoder(const char *name, |
158 | struct sigrokdecode_decoder **dec) | |
1c6fa20f | 159 | { |
5c55017c UH |
160 | struct sigrokdecode_decoder *d; |
161 | PyObject *py_name, *py_mod, *py_func, *py_res /* , *py_tuple */; | |
162 | int r; | |
163 | ||
164 | /* Get the name of the decoder module as Python string. */ | |
6b08da24 UH |
165 | if (!(py_name = PyString_FromString(name))) { /* NEWREF */ |
166 | PyErr_Print(); /* Returns void. */ | |
5c55017c UH |
167 | return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
168 | } | |
169 | ||
170 | /* "Import" the Python module. */ | |
6b08da24 UH |
171 | if (!(py_mod = PyImport_Import(py_name))) { /* NEWREF */ |
172 | PyErr_Print(); /* Returns void. */ | |
2557ad9d | 173 | Py_XDECREF(py_name); |
5c55017c UH |
174 | return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
175 | } | |
2557ad9d | 176 | Py_XDECREF(py_name); |
5c55017c UH |
177 | |
178 | /* Get the 'register' function name as Python callable object. */ | |
6b08da24 | 179 | py_func = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */ |
5c55017c UH |
180 | if (!py_func || !PyCallable_Check(py_func)) { |
181 | if (PyErr_Occurred()) | |
6b08da24 | 182 | PyErr_Print(); /* Returns void. */ |
2557ad9d | 183 | Py_XDECREF(py_mod); |
5c55017c UH |
184 | return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
185 | } | |
186 | ||
187 | /* Call the 'register' function without arguments, get the result. */ | |
6b08da24 UH |
188 | if (!(py_res = PyObject_CallFunction(py_func, NULL))) { /* NEWREF */ |
189 | PyErr_Print(); /* Returns void. */ | |
2557ad9d UH |
190 | Py_XDECREF(py_func); |
191 | Py_XDECREF(py_mod); | |
5c55017c UH |
192 | return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
193 | } | |
194 | ||
195 | if (!(d = malloc(sizeof(struct sigrokdecode_decoder)))) | |
196 | return SIGROKDECODE_ERR_MALLOC; | |
197 | ||
198 | if ((r = h_str(py_res, py_func, py_mod, "id", &(d->id))) < 0) | |
199 | return r; | |
200 | ||
201 | if ((r = h_str(py_res, py_func, py_mod, "name", &(d->name))) < 0) | |
202 | return r; | |
203 | ||
204 | if ((r = h_str(py_res, py_func, py_mod, "desc", &(d->desc))) < 0) | |
205 | return r; | |
206 | ||
207 | d->py_mod = py_mod; | |
208 | ||
2557ad9d UH |
209 | Py_XDECREF(py_res); |
210 | Py_XDECREF(py_func); | |
5c55017c UH |
211 | |
212 | /* Get the 'decode' function name as Python callable object. */ | |
6b08da24 | 213 | py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */ |
5c55017c UH |
214 | if (!py_func || !PyCallable_Check(py_func)) { |
215 | if (PyErr_Occurred()) | |
6b08da24 | 216 | PyErr_Print(); /* Returns void. */ |
2557ad9d | 217 | Py_XDECREF(py_mod); |
5c55017c UH |
218 | return SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
219 | } | |
220 | ||
221 | d->py_func = py_func; | |
222 | ||
223 | /* TODO: Handle inputformats, outputformats. */ | |
224 | ||
225 | *dec = d; | |
910e5fd8 | 226 | |
70e44845 | 227 | return SIGROKDECODE_OK; |
1c6fa20f UH |
228 | } |
229 | ||
230 | /** | |
231 | * Run the specified decoder function. | |
232 | * | |
5c55017c | 233 | * @param dec TODO |
1c6fa20f UH |
234 | * @param inbuf TODO |
235 | * @param inbuflen TODO | |
236 | * @param outbuf TODO | |
237 | * @param outbuflen TODO | |
70e44845 | 238 | * |
3a9a7e38 | 239 | * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise. |
1c6fa20f | 240 | */ |
5c55017c | 241 | int sigrokdecode_run_decoder(struct sigrokdecode_decoder *dec, |
2b45dd71 | 242 | uint8_t *inbuf, uint64_t inbuflen, |
243 | uint8_t **outbuf, uint64_t *outbuflen) | |
1c6fa20f | 244 | { |
5c55017c | 245 | PyObject *py_mod, *py_func, *py_args, *py_value, *py_res; |
036e6f67 | 246 | int r, ret; |
1c6fa20f UH |
247 | |
248 | /* TODO: Use #defines for the return codes. */ | |
249 | ||
250 | /* Return an error upon unusable input. */ | |
5c55017c UH |
251 | if (dec == NULL) |
252 | return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */ | |
1c6fa20f | 253 | if (inbuf == NULL) |
5c55017c | 254 | return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */ |
1c6fa20f | 255 | if (inbuflen == 0) /* No point in working on empty buffers. */ |
5c55017c | 256 | return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */ |
1c6fa20f | 257 | if (outbuf == NULL) |
5c55017c | 258 | return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */ |
1c6fa20f | 259 | if (outbuflen == NULL) |
5c55017c | 260 | return SIGROKDECODE_ERR_ARGS; /* TODO: More specific error? */ |
1c6fa20f | 261 | |
5c55017c UH |
262 | /* TODO: Error handling. */ |
263 | py_mod = dec->py_mod; | |
2557ad9d | 264 | Py_XINCREF(py_mod); |
5c55017c | 265 | py_func = dec->py_func; |
2557ad9d | 266 | Py_XINCREF(py_func); |
1c6fa20f UH |
267 | |
268 | /* Create a Python tuple of size 1. */ | |
6b08da24 | 269 | if (!(py_args = PyTuple_New(1))) { /* NEWREF */ |
036e6f67 UH |
270 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
271 | goto err_run_decref_func; | |
1c6fa20f UH |
272 | } |
273 | ||
274 | /* Get the input buffer as Python "string" (byte array). */ | |
275 | /* TODO: int vs. uint64_t for 'inbuflen'? */ | |
6b08da24 | 276 | if (!(py_value = Py_BuildValue("s#", inbuf, inbuflen))) { /* NEWREF */ |
036e6f67 UH |
277 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
278 | goto err_run_decref_args; | |
1c6fa20f UH |
279 | } |
280 | ||
f800adc4 UH |
281 | /* |
282 | * IMPORTANT: PyTuple_SetItem() "steals" a reference to py_value! | |
2557ad9d | 283 | * That means we are no longer responsible for Py_XDECREF()'ing it. |
f800adc4 UH |
284 | * It will automatically be free'd when the 'py_args' tuple is free'd. |
285 | */ | |
6b08da24 | 286 | if (PyTuple_SetItem(py_args, 0, py_value) != 0) { /* STEAL */ |
036e6f67 | 287 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
2557ad9d | 288 | Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */ |
036e6f67 | 289 | goto err_run_decref_args; |
1c6fa20f UH |
290 | } |
291 | ||
6b08da24 | 292 | if (!(py_res = PyObject_CallObject(py_func, py_args))) { /* NEWREF */ |
036e6f67 UH |
293 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ |
294 | goto err_run_decref_args; | |
1c6fa20f UH |
295 | } |
296 | ||
036e6f67 UH |
297 | if ((r = PyObject_AsCharBuffer(py_res, (const char **)outbuf, |
298 | (Py_ssize_t *)outbuflen))) { | |
299 | ret = SIGROKDECODE_ERR_PYTHON; /* TODO: More specific error? */ | |
2557ad9d | 300 | Py_XDECREF(py_res); |
036e6f67 | 301 | goto err_run_decref_args; |
1c6fa20f UH |
302 | } |
303 | ||
036e6f67 UH |
304 | ret = SIGROKDECODE_OK; |
305 | ||
2557ad9d | 306 | Py_XDECREF(py_res); |
036e6f67 UH |
307 | |
308 | err_run_decref_args: | |
2557ad9d | 309 | Py_XDECREF(py_args); |
036e6f67 | 310 | err_run_decref_func: |
2557ad9d | 311 | Py_XDECREF(py_func); |
036e6f67 | 312 | err_run_decref_mod: |
2557ad9d | 313 | Py_XDECREF(py_mod); |
1c6fa20f | 314 | |
036e6f67 UH |
315 | if (PyErr_Occurred()) |
316 | PyErr_Print(); /* Returns void. */ | |
317 | ||
318 | return ret; | |
1c6fa20f UH |
319 | } |
320 | ||
321 | /** | |
322 | * Shutdown libsigrokdecode. | |
323 | * | |
3a9a7e38 | 324 | * @return SIGROKDECODE_OK upon success, a (negative) error code otherwise. |
1c6fa20f UH |
325 | */ |
326 | int sigrokdecode_shutdown(void) | |
327 | { | |
328 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
329 | Py_Finalize(); | |
330 | ||
70e44845 | 331 | return SIGROKDECODE_OK; |
1c6fa20f | 332 | } |