Acquire/release the Python GIL where needed to avoid threading issues.
[libsigrokdecode.git] / exception.c
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode.h"
23 #include <stdarg.h>
24 #include <glib.h>
25
26 static char *py_stringify(PyObject *py_obj)
27 {
28         PyObject *py_str, *py_bytes;
29         char *str = NULL;
30
31         /* Note: Caller already ran PyGILState_Ensure(). */
32
33         if (!py_obj)
34                 return NULL;
35
36         py_str = PyObject_Str(py_obj);
37         if (!py_str || !PyUnicode_Check(py_str))
38                 goto cleanup;
39
40         py_bytes = PyUnicode_AsUTF8String(py_str);
41         if (!py_bytes)
42                 goto cleanup;
43
44         str = g_strdup(PyBytes_AsString(py_bytes));
45         Py_DECREF(py_bytes);
46
47 cleanup:
48         Py_XDECREF(py_str);
49         if (!str) {
50                 PyErr_Clear();
51                 srd_dbg("Failed to stringify object.");
52         }
53         return str;
54 }
55
56 static char *py_get_string_attr(PyObject *py_obj, const char *attr)
57 {
58         PyObject *py_str, *py_bytes;
59         char *str = NULL;
60
61         /* Note: Caller already ran PyGILState_Ensure(). */
62
63         if (!py_obj)
64                 return NULL;
65
66         py_str = PyObject_GetAttrString(py_obj, attr);
67         if (!py_str || !PyUnicode_Check(py_str))
68                 goto cleanup;
69
70         py_bytes = PyUnicode_AsUTF8String(py_str);
71         if (!py_bytes)
72                 goto cleanup;
73
74         str = g_strdup(PyBytes_AsString(py_bytes));
75         Py_DECREF(py_bytes);
76
77 cleanup:
78         Py_XDECREF(py_str);
79         if (!str) {
80                 PyErr_Clear();
81                 srd_dbg("Failed to get object attribute %s.", attr);
82         }
83         return str;
84 }
85
86 /** @private */
87 SRD_PRIV void srd_exception_catch(const char *format, ...)
88 {
89         va_list args;
90         PyObject *py_etype, *py_evalue, *py_etraceback;
91         PyObject *py_mod, *py_func, *py_tracefmt;
92         char *msg, *etype_name, *evalue_str, *tracefmt_str;
93         const char *etype_name_fallback;
94         PyGILState_STATE gstate;
95
96         py_etype = py_evalue = py_etraceback = py_mod = py_func = NULL;
97
98         va_start(args, format);
99         msg = g_strdup_vprintf(format, args);
100         va_end(args);
101
102         gstate = PyGILState_Ensure();
103
104         PyErr_Fetch(&py_etype, &py_evalue, &py_etraceback);
105         if (!py_etype) {
106                 /* No current exception, so just print the message. */
107                 srd_err("%s.", msg);
108                 goto cleanup;
109         }
110         PyErr_NormalizeException(&py_etype, &py_evalue, &py_etraceback);
111
112         etype_name = py_get_string_attr(py_etype, "__name__");
113         evalue_str = py_stringify(py_evalue);
114         etype_name_fallback = (etype_name) ? etype_name : "(unknown exception)";
115
116         if (evalue_str)
117                 srd_err("%s: %s: %s", etype_name_fallback, msg, evalue_str);
118         else
119                 srd_err("%s: %s.", etype_name_fallback, msg);
120
121         g_free(evalue_str);
122         g_free(etype_name);
123
124         /* If there is no traceback object, we are done. */
125         if (!py_etraceback)
126                 goto cleanup;
127
128         py_mod = py_import_by_name("traceback");
129         if (!py_mod)
130                 goto cleanup;
131
132         py_func = PyObject_GetAttrString(py_mod, "format_exception");
133         if (!py_func || !PyCallable_Check(py_func))
134                 goto cleanup;
135
136         /* Call into Python to format the stack trace. */
137         py_tracefmt = PyObject_CallFunctionObjArgs(py_func,
138                         py_etype, py_evalue, py_etraceback, NULL);
139         if (!py_tracefmt)
140                 goto cleanup;
141
142         tracefmt_str = py_stringify(py_tracefmt);
143         Py_DECREF(py_tracefmt);
144
145         /* Log the detailed stack trace. */
146         if (tracefmt_str) {
147                 srd_dbg("%s", tracefmt_str);
148                 g_free(tracefmt_str);
149         }
150
151 cleanup:
152         Py_XDECREF(py_func);
153         Py_XDECREF(py_mod);
154         Py_XDECREF(py_etraceback);
155         Py_XDECREF(py_evalue);
156         Py_XDECREF(py_etype);
157
158         /* Just in case. */
159         PyErr_Clear();
160
161         PyGILState_Release(gstate);
162
163         g_free(msg);
164 }