srd.c

   1 /*
   2  * This file is part of the libsigrokdecode project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  */
  20
  21 #include <config.h>
  22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #include "libsigrokdecode.h"
  24 #include <glib.h>
  25
  26 /** @cond PRIVATE */
  27
  28 /* Python module search paths */
  29 SRD_PRIV GSList *searchpaths = NULL;
  30
  31 /* session.c */
  32 extern SRD_PRIV GSList *sessions;
  33 extern SRD_PRIV int max_session_id;
  34
  35 /** @endcond */
  36
  37 /**
  38  * @mainpage libsigrokdecode API
  39  *
  40  * @section sec_intro Introduction
  41  *
  42  * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
  43  * portable, cross-platform, Free/Libre/Open-Source signal analysis software
  44  * suite that supports various device types (such as logic analyzers,
  45  * oscilloscopes, multimeters, and more).
  46  *
  47  * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a
  48  * shared library written in C which provides the basic API for (streaming)
  49  * protocol decoding functionality.
  50  *
  51  * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
  52  * are written in Python (>= 3.0).
  53  *
  54  * @section sec_api API reference
  55  *
  56  * See the "Modules" page for an introduction to various libsigrokdecode
  57  * related topics and the detailed API documentation of the respective
  58  * functions.
  59  *
  60  * You can also browse the API documentation by file, or review all
  61  * data structures.
  62  *
  63  * @section sec_mailinglists Mailing lists
  64  *
  65  * There is one mailing list for sigrok/libsigrokdecode: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a>.
  66  *
  67  * @section sec_irc IRC
  68  *
  69  * You can find the sigrok developers in the
  70  * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
  71  * IRC channel on Freenode.
  72  *
  73  * @section sec_website Website
  74  *
  75  * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
  76  */
  77
  78 /**
  79  * @file
  80  *
  81  * Initializing and shutting down libsigrokdecode.
  82  */
  83
  84 /**
  85  * @defgroup grp_init Initialization
  86  *
  87  * Initializing and shutting down libsigrokdecode.
  88  *
  89  * Before using any of the libsigrokdecode functionality, srd_init() must
  90  * be called to initialize the library.
  91  *
  92  * When libsigrokdecode functionality is no longer needed, srd_exit() should
  93  * be called.
  94  *
  95  * @{
  96  */
  97
  98 static int searchpath_add_xdg_dir(const char *datadir)
  99 {
 100         char *decdir;
 101         int ret;
 102
 103         decdir = g_build_filename(datadir, PACKAGE_TARNAME, "decoders", NULL);
 104
 105         if (g_file_test(decdir, G_FILE_TEST_IS_DIR))
 106                 ret = srd_decoder_searchpath_add(decdir);
 107         else
 108                 ret = SRD_OK; /* just ignore non-existing directory */
 109
 110         g_free(decdir);
 111
 112         return ret;
 113 }
 114
 115 static void print_versions(void)
 116 {
 117         GString *s;
 118         GSList *l, *l_orig, *m;
 119         char *str;
 120         const char *lib, *version;
 121
 122         srd_dbg("libsigrokdecode %s/%s (rt: %s/%s).",
 123                 SRD_PACKAGE_VERSION_STRING, SRD_LIB_VERSION_STRING,
 124                 srd_package_version_string_get(), srd_lib_version_string_get());
 125
 126         s = g_string_sized_new(200);
 127         g_string_append(s, "Libs: ");
 128         l_orig = srd_buildinfo_libs_get();
 129         for (l = l_orig; l; l = l->next) {
 130                 m = l->data;
 131                 lib = m->data;
 132                 version = m->next->data;
 133                 g_string_append_printf(s, "%s %s, ", lib, version);
 134                 g_slist_free_full(m, g_free);
 135         }
 136         g_slist_free(l_orig);
 137         s->str[s->len - 2] = '.';
 138         s->str[s->len - 1] = '\0';
 139         srd_dbg("%s", s->str);
 140         g_string_free(s, TRUE);
 141
 142         str = srd_buildinfo_host_get();
 143         srd_dbg("Host: %s.", str);
 144         g_free(str);
 145 }
 146
 147 static int print_searchpaths(void)
 148 {
 149         PyObject *py_paths, *py_path, *py_bytes;
 150         PyGILState_STATE gstate;
 151         GString *s;
 152         int i;
 153
 154         gstate = PyGILState_Ensure();
 155
 156         py_paths = PySys_GetObject("path");
 157         if (!py_paths)
 158                 goto err;
 159
 160         s = g_string_sized_new(500);
 161         g_string_append(s, "Decoder search paths:\n");
 162         for (i = 0; i < PyList_Size(py_paths); i++) {
 163                 py_path = PyList_GetItem(py_paths, i);
 164                 py_bytes = PyUnicode_AsUTF8String(py_path);
 165                 g_string_append_printf(s, " - %s\n", PyBytes_AsString(py_bytes));
 166         }
 167         s->str[s->len - 1] = '\0';
 168         srd_dbg("%s", s->str);
 169         g_string_free(s, TRUE);
 170
 171         PyGILState_Release(gstate);
 172
 173         return SRD_OK;
 174
 175 err:
 176         srd_err("Unable to query decoder search paths.");
 177         PyGILState_Release(gstate);
 178
 179         return SRD_ERR_PYTHON;
 180 }
 181
 182 SRD_API GSList *srd_searchpaths_get(void)
 183 {
 184         return g_slist_copy_deep(searchpaths, (GCopyFunc)g_strdup, NULL);
 185 }
 186
 187 /**
 188  * Initialize libsigrokdecode.
 189  *
 190  * This initializes the Python interpreter, and creates and initializes
 191  * a "sigrokdecode" Python module.
 192  *
 193  * Then, it searches for sigrok protocol decoders in the "decoders"
 194  * subdirectory of the the libsigrokdecode installation directory.
 195  * All decoders that are found are loaded into memory and added to an
 196  * internal list of decoders, which can be queried via srd_decoder_list().
 197  *
 198  * The caller is responsible for calling the clean-up function srd_exit(),
 199  * which will properly shut down libsigrokdecode and free its allocated memory.
 200  *
 201  * Multiple calls to srd_init(), without calling srd_exit() in between,
 202  * are not allowed.
 203  *
 204  * @param path Path to an extra directory containing protocol decoders
 205  *             which will be added to the Python sys.path. May be NULL.
 206  *
 207  * @return SRD_OK upon success, a (negative) error code otherwise.
 208  *         Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
 209  *         directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
 210  *         If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
 211  *
 212  * @since 0.1.0
 213  */
 214 SRD_API int srd_init(const char *path)
 215 {
 216         const char *const *sys_datadirs;
 217         const char *env_path;
 218         size_t i;
 219         int ret;
 220
 221         if (max_session_id != -1) {
 222                 srd_err("libsigrokdecode is already initialized.");
 223                 return SRD_ERR;
 224         }
 225
 226         print_versions();
 227
 228         srd_dbg("Initializing libsigrokdecode.");
 229
 230         /* Add our own module to the list of built-in modules. */
 231         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
 232
 233         /* Initialize the Python interpreter. */
 234         Py_InitializeEx(0);
 235
 236         /* Locations relative to the XDG system data directories. */
 237         sys_datadirs = g_get_system_data_dirs();
 238         for (i = g_strv_length((char **)sys_datadirs); i > 0; i--) {
 239                 ret = searchpath_add_xdg_dir(sys_datadirs[i-1]);
 240                 if (ret != SRD_OK) {
 241                         Py_Finalize();
 242                         return ret;
 243                 }
 244         }
 245 #ifdef DECODERS_DIR
 246         /* Hardcoded decoders install location, if defined. */
 247         if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
 248                 Py_Finalize();
 249                 return ret;
 250         }
 251 #endif
 252         /* Location relative to the XDG user data directory. */
 253         ret = searchpath_add_xdg_dir(g_get_user_data_dir());
 254         if (ret != SRD_OK) {
 255                 Py_Finalize();
 256                 return ret;
 257         }
 258
 259         /* Path specified by the user. */
 260         if (path) {
 261                 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
 262                         Py_Finalize();
 263                         return ret;
 264                 }
 265         }
 266
 267         /* Environment variable overrides everything, for debugging. */
 268         if ((env_path = g_getenv("SIGROKDECODE_DIR"))) {
 269                 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
 270                         Py_Finalize();
 271                         return ret;
 272                 }
 273         }
 274
 275         /* Initialize the Python GIL (this also happens to acquire it). */
 276         PyEval_InitThreads();
 277
 278         /* Release the GIL (ignore return value, we don't need it here). */
 279         (void)PyEval_SaveThread();
 280
 281         max_session_id = 0;
 282
 283         print_searchpaths();
 284
 285         return SRD_OK;
 286 }
 287
 288 /**
 289  * Shutdown libsigrokdecode.
 290  *
 291  * This frees all the memory allocated for protocol decoders and shuts down
 292  * the Python interpreter.
 293  *
 294  * This function should only be called if there was a (successful!) invocation
 295  * of srd_init() before. Calling this function multiple times in a row, without
 296  * any successful srd_init() calls in between, is not allowed.
 297  *
 298  * @return SRD_OK upon success, a (negative) error code otherwise.
 299  *
 300  * @since 0.1.0
 301  */
 302 SRD_API int srd_exit(void)
 303 {
 304         srd_dbg("Exiting libsigrokdecode.");
 305
 306         g_slist_foreach(sessions, (GFunc)srd_session_destroy, NULL);
 307
 308         srd_decoder_unload_all();
 309         g_slist_free_full(searchpaths, g_free);
 310         searchpaths = NULL;
 311
 312         /*
 313          * Acquire the GIL, otherwise Py_Finalize() might have issues.
 314          * Ignore the return value, we don't need it here.
 315          */
 316         if (Py_IsInitialized())
 317                 (void)PyGILState_Ensure();
 318
 319         /* Py_Finalize() returns void, any finalization errors are ignored. */
 320         Py_Finalize();
 321
 322         /* Note: No need to release the GIL since Python is shut down now. */
 323
 324         max_session_id = -1;
 325
 326         return SRD_OK;
 327 }
 328
 329 /**
 330  * Add an additional search directory for the protocol decoders.
 331  *
 332  * The specified directory is prepended (not appended!) to Python's sys.path,
 333  * in order to search for sigrok protocol decoders in the specified
 334  * directories first, and in the generic Python module directories (and in
 335  * the current working directory) last. This avoids conflicts if there are
 336  * Python modules which have the same name as a sigrok protocol decoder in
 337  * sys.path or in the current working directory.
 338  *
 339  * @param path Path to the directory containing protocol decoders which shall
 340  *             be added to the Python sys.path, or NULL.
 341  *
 342  * @return SRD_OK upon success, a (negative) error code otherwise.
 343  *
 344  * @private
 345  *
 346  * @since 0.1.0
 347  */
 348 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
 349 {
 350         PyObject *py_cur_path, *py_item;
 351         PyGILState_STATE gstate;
 352
 353         srd_dbg("Adding '%s' to module path.", path);
 354
 355         gstate = PyGILState_Ensure();
 356
 357         py_cur_path = PySys_GetObject("path");
 358         if (!py_cur_path)
 359                 goto err;
 360
 361         py_item = PyUnicode_FromString(path);
 362         if (!py_item) {
 363                 srd_exception_catch("Failed to create Unicode object");
 364                 goto err;
 365         }
 366         if (PyList_Insert(py_cur_path, 0, py_item) < 0) {
 367                 srd_exception_catch("Failed to insert path element");
 368                 Py_DECREF(py_item);
 369                 goto err;
 370         }
 371         Py_DECREF(py_item);
 372
 373         PyGILState_Release(gstate);
 374
 375         searchpaths = g_slist_prepend(searchpaths, g_strdup(path));
 376
 377         return SRD_OK;
 378
 379 err:
 380         PyGILState_Release(gstate);
 381
 382         return SRD_ERR_PYTHON;
 383 }
 384
 385 /** @} */