X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=srd.c;h=22f47fcf26a869ad8856e90b6f7f34bc76be5741;hp=61280ef41d7f4f838472aa2f9ff98ec672305520;hb=fe9160d567fbb4c890ac7b8bc2e1f2f9143f0935;hpb=f6527cc4f7625eb5283eee5392312ad5df70e0f3

diff --git a/srd.c b/srd.c
index 61280ef..22f47fc 100644
--- a/srd.c
+++ b/srd.c
@@ -18,9 +18,9 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "libsigrokdecode-internal.h"
-#include "config.h"
+#include <config.h>
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h"
 #include <glib.h>
 
 /** @cond PRIVATE */
@@ -29,8 +29,8 @@
 SRD_PRIV GSList *searchpaths = NULL;
 
 /* session.c */
-extern GSList *sessions;
-extern int max_session_id;
+extern SRD_PRIV GSList *sessions;
+extern SRD_PRIV int max_session_id;
 
 /** @endcond */
 
@@ -62,7 +62,7 @@ extern int max_session_id;
  *
  * @section sec_mailinglists Mailing lists
  *
- * There are two mailing lists for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
+ * There is one mailing list for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a>.
  *
  * @section sec_irc IRC
  *
@@ -95,6 +95,100 @@ extern int max_session_id;
  * @{
  */
 
+static int searchpath_add_xdg_dir(const char *datadir)
+{
+	char *decdir;
+	int ret;
+
+	decdir = g_build_filename(datadir, PACKAGE_TARNAME, "decoders", NULL);
+
+	if (g_file_test(decdir, G_FILE_TEST_IS_DIR))
+		ret = srd_decoder_searchpath_add(decdir);
+	else
+		ret = SRD_OK; /* Just ignore non-existing directory. */
+
+	g_free(decdir);
+
+	return ret;
+}
+
+static void print_versions(void)
+{
+	GString *s;
+	GSList *l, *l_orig, *m;
+	char *str;
+	const char *lib, *version;
+
+	srd_dbg("libsigrokdecode %s/%s (rt: %s/%s).",
+		SRD_PACKAGE_VERSION_STRING, SRD_LIB_VERSION_STRING,
+		srd_package_version_string_get(), srd_lib_version_string_get());
+
+	s = g_string_sized_new(200);
+	g_string_append(s, "Libs: ");
+	l_orig = srd_buildinfo_libs_get();
+	for (l = l_orig; l; l = l->next) {
+		m = l->data;
+		lib = m->data;
+		version = m->next->data;
+		g_string_append_printf(s, "%s %s, ", lib, version);
+		g_slist_free_full(m, g_free);
+	}
+	g_slist_free(l_orig);
+	s->str[s->len - 2] = '.';
+	s->str[s->len - 1] = '\0';
+	srd_dbg("%s", s->str);
+	g_string_free(s, TRUE);
+
+	str = srd_buildinfo_host_get();
+	srd_dbg("Host: %s.", str);
+	g_free(str);
+}
+
+static int print_searchpaths(void)
+{
+	PyObject *py_paths, *py_path, *py_bytes;
+	PyGILState_STATE gstate;
+	GString *s;
+	GSList *l;
+	int i;
+
+	s = g_string_sized_new(500);
+	g_string_append(s, "Protocol decoder search paths:\n");
+	for (l = searchpaths; l; l = l->next)
+		g_string_append_printf(s, " - %s\n", (const char *)l->data);
+	s->str[s->len - 1] = '\0';
+	srd_dbg("%s", s->str);
+	g_string_free(s, TRUE);
+
+	gstate = PyGILState_Ensure();
+
+	py_paths = PySys_GetObject("path");
+	if (!py_paths)
+		goto err;
+
+	s = g_string_sized_new(500);
+	g_string_append(s, "Python system search paths:\n");
+	for (i = 0; i < PyList_Size(py_paths); i++) {
+		py_path = PyList_GetItem(py_paths, i);
+		py_bytes = PyUnicode_AsUTF8String(py_path);
+		g_string_append_printf(s, " - %s\n", PyBytes_AsString(py_bytes));
+		Py_DECREF(py_bytes);
+	}
+	s->str[s->len - 1] = '\0';
+	srd_dbg("%s", s->str);
+	g_string_free(s, TRUE);
+
+	PyGILState_Release(gstate);
+
+	return SRD_OK;
+
+err:
+	srd_err("Unable to query Python system search paths.");
+	PyGILState_Release(gstate);
+
+	return SRD_ERR_PYTHON;
+}
+
 /**
  * Initialize libsigrokdecode.
  *
@@ -124,27 +218,48 @@ extern int max_session_id;
  */
 SRD_API int srd_init(const char *path)
 {
+	const char *const *sys_datadirs;
+	const char *env_path;
+	size_t i;
 	int ret;
-	char *env_path;
 
 	if (max_session_id != -1) {
 		srd_err("libsigrokdecode is already initialized.");
 		return SRD_ERR;
 	}
 
+	print_versions();
+
 	srd_dbg("Initializing libsigrokdecode.");
 
 	/* Add our own module to the list of built-in modules. */
 	PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
 
 	/* Initialize the Python interpreter. */
-	Py_Initialize();
+	Py_InitializeEx(0);
 
-	/* Installed decoders. */
+	/* Locations relative to the XDG system data directories. */
+	sys_datadirs = g_get_system_data_dirs();
+	for (i = g_strv_length((char **)sys_datadirs); i > 0; i--) {
+		ret = searchpath_add_xdg_dir(sys_datadirs[i - 1]);
+		if (ret != SRD_OK) {
+			Py_Finalize();
+			return ret;
+		}
+	}
+#ifdef DECODERS_DIR
+	/* Hardcoded decoders install location, if defined. */
 	if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
 		Py_Finalize();
 		return ret;
 	}
+#endif
+	/* Location relative to the XDG user data directory. */
+	ret = searchpath_add_xdg_dir(g_get_user_data_dir());
+	if (ret != SRD_OK) {
+		Py_Finalize();
+		return ret;
+	}
 
 	/* Path specified by the user. */
 	if (path) {
@@ -155,18 +270,32 @@ SRD_API int srd_init(const char *path)
 	}
 
 	/* Environment variable overrides everything, for debugging. */
-	if ((env_path = getenv("SIGROKDECODE_DIR"))) {
+	if ((env_path = g_getenv("SIGROKDECODE_DIR"))) {
 		if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
 			Py_Finalize();
 			return ret;
 		}
 	}
 
+	/* Initialize the Python GIL (this also happens to acquire it). */
+	PyEval_InitThreads();
+
+	/* Release the GIL (ignore return value, we don't need it here). */
+	(void)PyEval_SaveThread();
+
 	max_session_id = 0;
 
+	print_searchpaths();
+
 	return SRD_OK;
 }
 
+static void srd_session_destroy_cb(void *arg, void *ignored)
+{
+	(void)ignored; // Prevent unused warning
+	srd_session_destroy((struct srd_session *)arg);
+}
+
 /**
  * Shutdown libsigrokdecode.
  *
@@ -183,20 +312,28 @@ SRD_API int srd_init(const char *path)
  */
 SRD_API int srd_exit(void)
 {
-	GSList *l;
-
 	srd_dbg("Exiting libsigrokdecode.");
 
-	for (l = sessions; l; l = l->next)
-		srd_session_destroy((struct srd_session *)l->data);
+	g_slist_foreach(sessions, srd_session_destroy_cb, NULL);
+	g_slist_free(sessions);
+	sessions = NULL;
 
 	srd_decoder_unload_all();
 	g_slist_free_full(searchpaths, g_free);
 	searchpaths = NULL;
 
+	/*
+	 * Acquire the GIL, otherwise Py_Finalize() might have issues.
+	 * Ignore the return value, we don't need it here.
+	 */
+	if (Py_IsInitialized())
+		(void)PyGILState_Ensure();
+
 	/* Py_Finalize() returns void, any finalization errors are ignored. */
 	Py_Finalize();
 
+	/* Note: No need to release the GIL since Python is shut down now. */
+
 	max_session_id = -1;
 
 	return SRD_OK;
@@ -218,47 +355,59 @@ SRD_API int srd_exit(void)
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *
  * @private
- *
- * @since 0.1.0
  */
 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
 {
 	PyObject *py_cur_path, *py_item;
-	GString *new_path;
-	int wc_len, i;
-	wchar_t *wc_new_path;
-	char *item;
+	PyGILState_STATE gstate;
 
 	srd_dbg("Adding '%s' to module path.", path);
 
-	new_path = g_string_sized_new(256);
-	g_string_assign(new_path, path);
+	gstate = PyGILState_Ensure();
+
 	py_cur_path = PySys_GetObject("path");
-	for (i = 0; i < PyList_Size(py_cur_path); i++) {
-		g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S);
-		py_item = PyList_GetItem(py_cur_path, i);
-		if (!PyUnicode_Check(py_item))
-			/* Shouldn't happen. */
-			continue;
-		if (py_str_as_str(py_item, &item) != SRD_OK)
-			continue;
-		g_string_append(new_path, item);
-		g_free(item);
-	}
+	if (!py_cur_path)
+		goto err;
 
-	/* Convert to wide chars. */
-	wc_len = sizeof(wchar_t) * (new_path->len + 1);
-	if (!(wc_new_path = g_try_malloc(wc_len))) {
-		srd_dbg("malloc failed");
-		return SRD_ERR_MALLOC;
+	py_item = PyUnicode_FromString(path);
+	if (!py_item) {
+		srd_exception_catch("Failed to create Unicode object");
+		goto err;
 	}
-	mbstowcs(wc_new_path, new_path->str, wc_len);
-	PySys_SetPath(wc_new_path);
-	g_string_free(new_path, TRUE);
-	g_free(wc_new_path);
-	searchpaths = g_slist_append(searchpaths, g_strdup(path));
+	if (PyList_Insert(py_cur_path, 0, py_item) < 0) {
+		srd_exception_catch("Failed to insert path element");
+		Py_DECREF(py_item);
+		goto err;
+	}
+	Py_DECREF(py_item);
+
+	PyGILState_Release(gstate);
+
+	searchpaths = g_slist_prepend(searchpaths, g_strdup(path));
 
 	return SRD_OK;
+
+err:
+	PyGILState_Release(gstate);
+
+	return SRD_ERR_PYTHON;
+}
+
+/**
+ * Return the list of protocol decoder search paths.
+ *
+ * @return The list of search paths used when loading protocol decoders.
+ *
+ * @since 0.5.1
+ */
+SRD_API GSList *srd_searchpaths_get(void)
+{
+	GSList *paths = NULL;
+
+	for (GSList *l = searchpaths; l; l = l->next)
+		paths = g_slist_append(paths, g_strdup(l->data));
+
+	return paths;
 }
 
 /** @} */