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         GSList *l;
 153         int i;
 154
 155         s = g_string_sized_new(500);
 156         g_string_append(s, "Protocol decoder search paths:\n");
 157         for (l = searchpaths; l; l = l->next)
 158                 g_string_append_printf(s, " - %s\n", (const char *)l->data);
 159         s->str[s->len - 1] = '\0';
 160         srd_dbg("%s", s->str);
 161         g_string_free(s, TRUE);
 162
 163         gstate = PyGILState_Ensure();
 164
 165         py_paths = PySys_GetObject("path");
 166         if (!py_paths)
 167                 goto err;
 168
 169         s = g_string_sized_new(500);
 170         g_string_append(s, "Python system search paths:\n");
 171         for (i = 0; i < PyList_Size(py_paths); i++) {
 172                 py_path = PyList_GetItem(py_paths, i);
 173                 py_bytes = PyUnicode_AsUTF8String(py_path);
 174                 g_string_append_printf(s, " - %s\n", PyBytes_AsString(py_bytes));
 175         }
 176         s->str[s->len - 1] = '\0';
 177         srd_dbg("%s", s->str);
 178         g_string_free(s, TRUE);
 179
 180         PyGILState_Release(gstate);
 181
 182         return SRD_OK;
 183
 184 err:
 185         srd_err("Unable to query Python system search paths.");
 186         PyGILState_Release(gstate);
 187
 188         return SRD_ERR_PYTHON;
 189 }
 190
 191 /**
 192  * Initialize libsigrokdecode.
 193  *
 194  * This initializes the Python interpreter, and creates and initializes
 195  * a "sigrokdecode" Python module.
 196  *
 197  * Then, it searches for sigrok protocol decoders in the "decoders"
 198  * subdirectory of the the libsigrokdecode installation directory.
 199  * All decoders that are found are loaded into memory and added to an
 200  * internal list of decoders, which can be queried via srd_decoder_list().
 201  *
 202  * The caller is responsible for calling the clean-up function srd_exit(),
 203  * which will properly shut down libsigrokdecode and free its allocated memory.
 204  *
 205  * Multiple calls to srd_init(), without calling srd_exit() in between,
 206  * are not allowed.
 207  *
 208  * @param path Path to an extra directory containing protocol decoders
 209  *             which will be added to the Python sys.path. May be NULL.
 210  *
 211  * @return SRD_OK upon success, a (negative) error code otherwise.
 212  *         Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders
 213  *         directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned.
 214  *         If not enough memory could be allocated, SRD_ERR_MALLOC is returned.
 215  *
 216  * @since 0.1.0
 217  */
 218 SRD_API int srd_init(const char *path)
 219 {
 220         const char *const *sys_datadirs;
 221         const char *env_path;
 222         size_t i;
 223         int ret;
 224
 225         if (max_session_id != -1) {
 226                 srd_err("libsigrokdecode is already initialized.");
 227                 return SRD_ERR;
 228         }
 229
 230         print_versions();
 231
 232         srd_dbg("Initializing libsigrokdecode.");
 233
 234         /* Add our own module to the list of built-in modules. */
 235         PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
 236
 237         /* Initialize the Python interpreter. */
 238         Py_InitializeEx(0);
 239
 240         /* Locations relative to the XDG system data directories. */
 241         sys_datadirs = g_get_system_data_dirs();
 242         for (i = g_strv_length((char **)sys_datadirs); i > 0; i--) {
 243                 ret = searchpath_add_xdg_dir(sys_datadirs[i - 1]);
 244                 if (ret != SRD_OK) {
 245                         Py_Finalize();
 246                         return ret;
 247                 }
 248         }
 249 #ifdef DECODERS_DIR
 250         /* Hardcoded decoders install location, if defined. */
 251         if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
 252                 Py_Finalize();
 253                 return ret;
 254         }
 255 #endif
 256         /* Location relative to the XDG user data directory. */
 257         ret = searchpath_add_xdg_dir(g_get_user_data_dir());
 258         if (ret != SRD_OK) {
 259                 Py_Finalize();
 260                 return ret;
 261         }
 262
 263         /* Path specified by the user. */
 264         if (path) {
 265                 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
 266                         Py_Finalize();
 267                         return ret;
 268                 }
 269         }
 270
 271         /* Environment variable overrides everything, for debugging. */
 272         if ((env_path = g_getenv("SIGROKDECODE_DIR"))) {
 273                 if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
 274                         Py_Finalize();
 275                         return ret;
 276                 }
 277         }
 278
 279         /* Initialize the Python GIL (this also happens to acquire it). */
 280         PyEval_InitThreads();
 281
 282         /* Release the GIL (ignore return value, we don't need it here). */
 283         (void)PyEval_SaveThread();
 284
 285         max_session_id = 0;
 286
 287         print_searchpaths();
 288
 289         return SRD_OK;
 290 }
 291
 292 /**
 293  * Shutdown libsigrokdecode.
 294  *
 295  * This frees all the memory allocated for protocol decoders and shuts down
 296  * the Python interpreter.
 297  *
 298  * This function should only be called if there was a (successful!) invocation
 299  * of srd_init() before. Calling this function multiple times in a row, without
 300  * any successful srd_init() calls in between, is not allowed.
 301  *
 302  * @return SRD_OK upon success, a (negative) error code otherwise.
 303  *
 304  * @since 0.1.0
 305  */
 306 SRD_API int srd_exit(void)
 307 {
 308         srd_dbg("Exiting libsigrokdecode.");
 309
 310         g_slist_foreach(sessions, (GFunc)srd_session_destroy, NULL);
 311
 312         srd_decoder_unload_all();
 313         g_slist_free_full(searchpaths, g_free);
 314         searchpaths = NULL;
 315
 316         /*
 317          * Acquire the GIL, otherwise Py_Finalize() might have issues.
 318          * Ignore the return value, we don't need it here.
 319          */
 320         if (Py_IsInitialized())
 321                 (void)PyGILState_Ensure();
 322
 323         /* Py_Finalize() returns void, any finalization errors are ignored. */
 324         Py_Finalize();
 325
 326         /* Note: No need to release the GIL since Python is shut down now. */
 327
 328         max_session_id = -1;
 329
 330         return SRD_OK;
 331 }
 332
 333 /**
 334  * Add an additional search directory for the protocol decoders.
 335  *
 336  * The specified directory is prepended (not appended!) to Python's sys.path,
 337  * in order to search for sigrok protocol decoders in the specified
 338  * directories first, and in the generic Python module directories (and in
 339  * the current working directory) last. This avoids conflicts if there are
 340  * Python modules which have the same name as a sigrok protocol decoder in
 341  * sys.path or in the current working directory.
 342  *
 343  * @param path Path to the directory containing protocol decoders which shall
 344  *             be added to the Python sys.path, or NULL.
 345  *
 346  * @return SRD_OK upon success, a (negative) error code otherwise.
 347  *
 348  * @private
 349  *
 350  * @since 0.1.0
 351  */
 352 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
 353 {
 354         PyObject *py_cur_path, *py_item;
 355         PyGILState_STATE gstate;
 356
 357         srd_dbg("Adding '%s' to module path.", path);
 358
 359         gstate = PyGILState_Ensure();
 360
 361         py_cur_path = PySys_GetObject("path");
 362         if (!py_cur_path)
 363                 goto err;
 364
 365         py_item = PyUnicode_FromString(path);
 366         if (!py_item) {
 367                 srd_exception_catch("Failed to create Unicode object");
 368                 goto err;
 369         }
 370         if (PyList_Insert(py_cur_path, 0, py_item) < 0) {
 371                 srd_exception_catch("Failed to insert path element");
 372                 Py_DECREF(py_item);
 373                 goto err;
 374         }
 375         Py_DECREF(py_item);
 376
 377         PyGILState_Release(gstate);
 378
 379         searchpaths = g_slist_prepend(searchpaths, g_strdup(path));
 380
 381         return SRD_OK;
 382
 383 err:
 384         PyGILState_Release(gstate);
 385
 386         return SRD_ERR_PYTHON;
 387 }
 388
 389 /**
 390  * Return the list of protocol decoder search paths.
 391  *
 392  * @return The list of search paths used when loading protocol decoders.
 393  *
 394  * @since 0.5.1
 395  */
 396 SRD_API GSList *srd_searchpaths_get(void)
 397 {
 398         return g_slist_copy_deep(searchpaths, (GCopyFunc)g_strdup, NULL);
 399 }
 400
 401 /** @} */