File size: 5,274 Bytes
3dcad1f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
/* Copyright 2001,2002,2004,2006,2009-2011,2018-2019,2021
Free Software Foundation, Inc.
This file is part of Guile.
Guile is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Guile is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with Guile. If not, see
<https://www.gnu.org/licenses/>. */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <string.h>
#include "dynl.h"
#include "dynwind.h"
#include "gc.h"
#include "gsubr.h"
#include "foreign.h"
#include "strings.h"
#include "threads.h"
#include "extensions.h"
typedef struct extension_t
{
struct extension_t *next;
const char *lib;
const char *init;
void (*func)(void *);
void *data;
} extension_t;
static extension_t *registered_extensions = NULL;
static scm_i_pthread_mutex_t ext_lock = SCM_I_PTHREAD_MUTEX_INITIALIZER;
/* Register a LIB/INIT pair for use by `scm_load_extension'. LIB is
allowed to be NULL and then only INIT is used to identify the
registered entry. This is useful when you don't know the library
name (which isn't really relevant anyway in a completely linked
program) and you are sure that INIT is unique (which it must be for
static linking). Hmm, given this reasoning, what use is LIB
anyway?
*/
void
scm_c_register_extension (const char *lib, const char *init,
void (*func) (void *), void *data)
{
extension_t *ext = scm_malloc (sizeof(extension_t));
if (lib)
ext->lib = scm_strdup (lib);
else
ext->lib = NULL;
ext->init = scm_strdup (init);
ext->func = func;
ext->data = data;
scm_i_pthread_mutex_lock (&ext_lock);
ext->next = registered_extensions;
registered_extensions = ext;
scm_i_pthread_mutex_unlock (&ext_lock);
}
static void
load_extension (SCM lib, SCM init)
{
extension_t *head;
scm_i_pthread_mutex_lock (&ext_lock);
head = registered_extensions;
scm_i_pthread_mutex_unlock (&ext_lock);
/* Search the registry. */
if (head != NULL)
{
extension_t *ext;
char *clib, *cinit;
int found = 0;
scm_dynwind_begin (0);
clib = scm_to_utf8_string (lib);
scm_dynwind_free (clib);
cinit = scm_to_utf8_string (init);
scm_dynwind_free (cinit);
for (ext = head; ext; ext = ext->next)
if ((ext->lib == NULL || !strcmp (ext->lib, clib))
&& !strcmp (ext->init, cinit))
{
ext->func (ext->data);
found = 1;
break;
}
scm_dynwind_end ();
if (found)
return;
}
/* Dynamically link the library. */
#if HAVE_MODULES
SCM pointer = scm_dynamic_pointer (init, scm_dynamic_link (lib));
void (*f)(void) = scm_to_pointer (pointer);
f ();
#else
scm_misc_error ("load-extension",
"extension ~S:~S not registered and dynamic-link disabled",
scm_list_2 (init, lib));
#endif
}
void
scm_c_load_extension (const char *lib, const char *init)
{
load_extension (scm_from_utf8_string (lib), scm_from_utf8_string (init));
}
SCM_DEFINE (scm_load_extension, "load-extension", 2, 0, 0,
(SCM lib, SCM init),
"Load and initialize the extension designated by LIB and INIT.\n"
"When there is no pre-registered function for LIB/INIT, this is\n"
"equivalent to\n"
"\n"
"@lisp\n"
"(dynamic-call INIT (dynamic-link LIB))\n"
"@end lisp\n"
"\n"
"When there is a pre-registered function, that function is called\n"
"instead.\n"
"\n"
"Normally, there is no pre-registered function. This option exists\n"
"only for situations where dynamic linking is unavailable or unwanted.\n"
"In that case, you would statically link your program with the desired\n"
"library, and register its init function right after Guile has been\n"
"initialized.\n"
"\n"
"LIB should be a string denoting a shared library without any file type\n"
"suffix such as \".so\". The suffix is provided automatically. It\n"
"should also not contain any directory components. Libraries that\n"
"implement Guile Extensions should be put into the normal locations for\n"
"shared libraries. We recommend to use the naming convention\n"
"libguile-bla-blum for a extension related to a module `(bla blum)'.\n"
"\n"
"The normal way for a extension to be used is to write a small Scheme\n"
"file that defines a module, and to load the extension into this\n"
"module. When the module is auto-loaded, the extension is loaded as\n"
"well. For example,\n"
"\n"
"@lisp\n"
"(define-module (bla blum))\n"
"\n"
"(load-extension \"libguile-bla-blum\" \"bla_init_blum\")\n"
"@end lisp")
#define FUNC_NAME s_scm_load_extension
{
load_extension (lib, init);
return SCM_UNSPECIFIED;
}
#undef FUNC_NAME
void
scm_init_extensions ()
{
#include "extensions.x"
}
|