Commit | Line | Data |
---|---|---|
1edae076 MV |
1 | /* dynl.c - dynamic linking |
2 | * | |
58ade102 | 3 | * Copyright (C) 1990, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. |
1edae076 MV |
4 | * |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation; either version 2, or (at your option) | |
8 | * any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with this software; see the file COPYING. If not, write to | |
82892bed JB |
17 | * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
18 | * Boston, MA 02111-1307 USA | |
1edae076 MV |
19 | * |
20 | * As a special exception, the Free Software Foundation gives permission | |
21 | * for additional uses of the text contained in its release of GUILE. | |
22 | * | |
23 | * The exception is that, if you link the GUILE library with other files | |
24 | * to produce an executable, this does not by itself cause the | |
25 | * resulting executable to be covered by the GNU General Public License. | |
26 | * Your use of that executable is in no way restricted on account of | |
27 | * linking the GUILE library code into it. | |
28 | * | |
29 | * This exception does not however invalidate any other reasons why | |
30 | * the executable file might be covered by the GNU General Public License. | |
31 | * | |
32 | * This exception applies only to the code released by the | |
33 | * Free Software Foundation under the name GUILE. If you copy | |
34 | * code from other Free Software Foundation releases into a copy of | |
35 | * GUILE, as the General Public License permits, the exception does | |
36 | * not apply to the code that you add in this way. To avoid misleading | |
37 | * anyone as to the status of such modified files, you must delete | |
38 | * this exception notice from them. | |
39 | * | |
40 | * If you write modifications of your own for GUILE, it is your choice | |
41 | * whether to permit this exception to apply to your modifications. | |
82892bed | 42 | * If you do not wish that, delete this exception notice. */ |
1edae076 | 43 | |
1bbd0b84 GB |
44 | |
45 | ||
1edae076 MV |
46 | /* "dynl.c" dynamically link&load object files. |
47 | Author: Aubrey Jaffer | |
48 | Modified for libguile by Marius Vollmer */ | |
49 | ||
104d4533 | 50 | #if 0 /* Disabled until we know for sure that it isn't needed */ |
80bc7890 MV |
51 | /* XXX - This is only here to drag in a definition of __eprintf. This |
52 | is needed for proper operation of dynamic linking. The real | |
53 | solution would probably be a shared libgcc. */ | |
54 | ||
55 | #undef NDEBUG | |
56 | #include <assert.h> | |
57 | ||
58 | static void | |
59 | maybe_drag_in_eprintf () | |
60 | { | |
61 | assert (!maybe_drag_in_eprintf); | |
62 | } | |
104d4533 | 63 | #endif |
80bc7890 | 64 | |
96599e6a | 65 | #include <stdio.h> |
13070bd3 DH |
66 | #include <string.h> |
67 | ||
a0599745 MD |
68 | #include "libguile/_scm.h" |
69 | #include "libguile/dynl.h" | |
70 | #include "libguile/smob.h" | |
71 | #include "libguile/keywords.h" | |
72 | #include "libguile/ports.h" | |
73 | #include "libguile/strings.h" | |
a0e0793f | 74 | #include "libguile/deprecation.h" |
c96d76b8 | 75 | #include "libguile/lang.h" |
a0599745 | 76 | #include "libguile/validate.h" |
408ea28a | 77 | |
4feb69af MV |
78 | #ifdef DYNAMIC_LINKING |
79 | ||
07286af9 | 80 | #include "libltdl/ltdl.h" |
4feb69af | 81 | |
732b9327 GH |
82 | /* From the libtool manual: "Note that libltdl is not threadsafe, |
83 | i.e. a multithreaded application has to use a mutex for libltdl.". | |
84 | ||
85 | Guile does not currently support pre-emptive threads, so there is | |
86 | no mutex. Previously SCM_DEFER_INTS and SCM_ALLOW_INTS were used: | |
87 | they are mentioned here in case somebody is grepping for thread | |
88 | problems ;) | |
89 | */ | |
90 | ||
4feb69af | 91 | static void * |
af45e3b0 | 92 | sysdep_dynl_link (const char *fname, const char *subr) |
4feb69af | 93 | { |
7cf1a27e MD |
94 | lt_dlhandle handle; |
95 | handle = lt_dlopenext (fname); | |
4feb69af MV |
96 | if (NULL == handle) |
97 | { | |
01449aa5 DH |
98 | SCM fn; |
99 | SCM msg; | |
100 | ||
01449aa5 DH |
101 | fn = scm_makfrom0str (fname); |
102 | msg = scm_makfrom0str (lt_dlerror ()); | |
1afff620 | 103 | scm_misc_error (subr, "file: ~S, message: ~S", scm_list_2 (fn, msg)); |
4feb69af MV |
104 | } |
105 | return (void *) handle; | |
106 | } | |
107 | ||
108 | static void | |
109 | sysdep_dynl_unlink (void *handle, const char *subr) | |
110 | { | |
111 | if (lt_dlclose ((lt_dlhandle) handle)) | |
112 | { | |
7cf1a27e | 113 | scm_misc_error (subr, (char *) lt_dlerror (), SCM_EOL); |
4feb69af MV |
114 | } |
115 | } | |
116 | ||
117 | static void * | |
118 | sysdep_dynl_func (const char *symb, void *handle, const char *subr) | |
119 | { | |
120 | void *fptr; | |
121 | ||
122 | fptr = lt_dlsym ((lt_dlhandle) handle, symb); | |
123 | if (!fptr) | |
124 | { | |
7cf1a27e | 125 | scm_misc_error (subr, (char *) lt_dlerror (), SCM_EOL); |
4feb69af MV |
126 | } |
127 | return fptr; | |
128 | } | |
129 | ||
130 | static void | |
131 | sysdep_dynl_init () | |
132 | { | |
133 | lt_dlinit (); | |
134 | } | |
135 | ||
1edae076 | 136 | #else |
96599e6a MV |
137 | |
138 | /* no dynamic linking available, throw errors. */ | |
139 | ||
140 | static void | |
1bbd0b84 | 141 | sysdep_dynl_init (void) |
96599e6a MV |
142 | { |
143 | } | |
144 | ||
145 | static void | |
a80a90e9 | 146 | no_dynl_error (const char *subr) |
96599e6a | 147 | { |
419e9e11 | 148 | scm_misc_error (subr, "dynamic linking not available", SCM_EOL); |
96599e6a MV |
149 | } |
150 | ||
151 | static void * | |
af45e3b0 | 152 | sysdep_dynl_link (const char *filename, const char *subr) |
96599e6a | 153 | { |
7cf1a27e MD |
154 | no_dynl_error (subr); |
155 | return NULL; | |
96599e6a MV |
156 | } |
157 | ||
158 | static void | |
a80a90e9 JB |
159 | sysdep_dynl_unlink (void *handle, |
160 | const char *subr) | |
96599e6a | 161 | { |
7cf1a27e | 162 | no_dynl_error (subr); |
96599e6a MV |
163 | } |
164 | ||
165 | static void * | |
a80a90e9 JB |
166 | sysdep_dynl_func (const char *symbol, |
167 | void *handle, | |
168 | const char *subr) | |
96599e6a | 169 | { |
7cf1a27e MD |
170 | no_dynl_error (subr); |
171 | return NULL; | |
96599e6a MV |
172 | } |
173 | ||
80bc7890 MV |
174 | #endif |
175 | ||
92c2555f | 176 | scm_t_bits scm_tc16_dynamic_obj; |
80bc7890 | 177 | |
b82c6ce0 DH |
178 | #define DYNL_FILENAME(x) (SCM_CELL_OBJECT_1 (x)) |
179 | #define DYNL_HANDLE(x) ((void *) SCM_CELL_WORD_2 (x)) | |
180 | #define SET_DYNL_HANDLE(x, v) (SCM_SET_CELL_WORD_2 ((x), (v))) | |
7cf1a27e | 181 | |
7cf1a27e | 182 | |
80bc7890 | 183 | static SCM |
e841c3e0 | 184 | dynl_obj_mark (SCM ptr) |
80bc7890 | 185 | { |
7cf1a27e | 186 | return DYNL_FILENAME (ptr); |
c487ad44 MV |
187 | } |
188 | ||
e841c3e0 | 189 | |
80bc7890 | 190 | static int |
e841c3e0 | 191 | dynl_obj_print (SCM exp, SCM port, scm_print_state *pstate) |
80bc7890 | 192 | { |
7cf1a27e MD |
193 | scm_puts ("#<dynamic-object ", port); |
194 | scm_iprin1 (DYNL_FILENAME (exp), port, pstate); | |
195 | if (DYNL_HANDLE (exp) == NULL) | |
196 | scm_puts (" (unlinked)", port); | |
197 | scm_putc ('>', port); | |
198 | return 1; | |
80bc7890 MV |
199 | } |
200 | ||
8e3ab003 | 201 | |
af45e3b0 | 202 | SCM_DEFINE (scm_dynamic_link, "dynamic-link", 1, 0, 0, |
1e6808ea MG |
203 | (SCM filename), |
204 | "Open the dynamic library called @var{filename}. A library\n" | |
205 | "handle representing the opened library is returned; this handle\n" | |
206 | "should be used as the @var{dobj} argument to the following\n" | |
207 | "functions.") | |
1bbd0b84 | 208 | #define FUNC_NAME s_scm_dynamic_link |
80bc7890 | 209 | { |
7cf1a27e | 210 | void *handle; |
80bc7890 | 211 | |
1e6808ea | 212 | SCM_VALIDATE_STRING (1, filename); |
1e6808ea MG |
213 | handle = sysdep_dynl_link (SCM_STRING_CHARS (filename), FUNC_NAME); |
214 | SCM_RETURN_NEWSMOB2 (scm_tc16_dynamic_obj, SCM_UNPACK (filename), handle); | |
80bc7890 | 215 | } |
1bbd0b84 | 216 | #undef FUNC_NAME |
80bc7890 | 217 | |
80bc7890 | 218 | |
a1ec6916 | 219 | SCM_DEFINE (scm_dynamic_object_p, "dynamic-object?", 1, 0, 0, |
1bbd0b84 | 220 | (SCM obj), |
b380b885 MD |
221 | "Return @code{#t} if @var{obj} is a dynamic library handle, or @code{#f}\n" |
222 | "otherwise.") | |
1bbd0b84 | 223 | #define FUNC_NAME s_scm_dynamic_object_p |
80bc7890 | 224 | { |
e841c3e0 | 225 | return SCM_BOOL (SCM_TYP16_PREDICATE (scm_tc16_dynamic_obj, obj)); |
80bc7890 | 226 | } |
1bbd0b84 | 227 | #undef FUNC_NAME |
80bc7890 | 228 | |
b82c6ce0 | 229 | |
a1ec6916 | 230 | SCM_DEFINE (scm_dynamic_unlink, "dynamic-unlink", 1, 0, 0, |
1bbd0b84 | 231 | (SCM dobj), |
b82c6ce0 | 232 | "Unlink the indicated object file from the application. The\n" |
1e6808ea | 233 | "argument @var{dobj} must have been obtained by a call to\n" |
b82c6ce0 | 234 | "@code{dynamic-link}. After @code{dynamic-unlink} has been\n" |
1e6808ea | 235 | "called on @var{dobj}, its content is no longer accessible.") |
1bbd0b84 | 236 | #define FUNC_NAME s_scm_dynamic_unlink |
80bc7890 | 237 | { |
7cf1a27e | 238 | /*fixme* GC-problem */ |
b82c6ce0 DH |
239 | SCM_VALIDATE_SMOB (SCM_ARG1, dobj, dynamic_obj); |
240 | if (DYNL_HANDLE (dobj) == NULL) { | |
241 | SCM_MISC_ERROR ("Already unlinked: ~S", dobj); | |
242 | } else { | |
b82c6ce0 DH |
243 | sysdep_dynl_unlink (DYNL_HANDLE (dobj), FUNC_NAME); |
244 | SET_DYNL_HANDLE (dobj, NULL); | |
b82c6ce0 DH |
245 | return SCM_UNSPECIFIED; |
246 | } | |
80bc7890 | 247 | } |
1bbd0b84 | 248 | #undef FUNC_NAME |
80bc7890 | 249 | |
b82c6ce0 | 250 | |
a1ec6916 | 251 | SCM_DEFINE (scm_dynamic_func, "dynamic-func", 2, 0, 0, |
a6d9e5ab DH |
252 | (SCM name, SCM dobj), |
253 | "Search the dynamic object @var{dobj} for the C function\n" | |
254 | "indicated by the string @var{name} and return some Scheme\n" | |
255 | "handle that can later be used with @code{dynamic-call} to\n" | |
256 | "actually call the function.\n\n" | |
b380b885 MD |
257 | "Regardless whether your C compiler prepends an underscore @samp{_} to\n" |
258 | "the global names in a program, you should @strong{not} include this\n" | |
259 | "underscore in @var{function}. Guile knows whether the underscore is\n" | |
872e0c72 | 260 | "needed or not and will add it when necessary.") |
1bbd0b84 | 261 | #define FUNC_NAME s_scm_dynamic_func |
80bc7890 | 262 | { |
a6d9e5ab DH |
263 | /* The returned handle is formed by casting the address of the function to a |
264 | * long value and converting this to a scheme number | |
265 | */ | |
266 | ||
7cf1a27e | 267 | void (*func) (); |
80bc7890 | 268 | |
a6d9e5ab | 269 | SCM_VALIDATE_STRING (1, name); |
7cf1a27e | 270 | /*fixme* GC-problem */ |
b82c6ce0 DH |
271 | SCM_VALIDATE_SMOB (SCM_ARG2, dobj, dynamic_obj); |
272 | if (DYNL_HANDLE (dobj) == NULL) { | |
273 | SCM_MISC_ERROR ("Already unlinked: ~S", dobj); | |
274 | } else { | |
a002f1a2 DH |
275 | char *chars; |
276 | ||
a6d9e5ab | 277 | chars = SCM_STRING_CHARS (name); |
a002f1a2 | 278 | func = (void (*) ()) sysdep_dynl_func (chars, DYNL_HANDLE (dobj), FUNC_NAME); |
b82c6ce0 DH |
279 | return scm_ulong2num ((unsigned long) func); |
280 | } | |
80bc7890 | 281 | } |
1bbd0b84 | 282 | #undef FUNC_NAME |
80bc7890 | 283 | |
b82c6ce0 | 284 | |
a1ec6916 | 285 | SCM_DEFINE (scm_dynamic_call, "dynamic-call", 2, 0, 0, |
1bbd0b84 | 286 | (SCM func, SCM dobj), |
1e6808ea MG |
287 | "Call the C function indicated by @var{func} and @var{dobj}.\n" |
288 | "The function is passed no arguments and its return value is\n" | |
289 | "ignored. When @var{function} is something returned by\n" | |
290 | "@code{dynamic-func}, call that function and ignore @var{dobj}.\n" | |
291 | "When @var{func} is a string , look it up in @var{dynobj}; this\n" | |
292 | "is equivalent to\n" | |
b380b885 | 293 | "@smallexample\n" |
1e6808ea | 294 | "(dynamic-call (dynamic-func @var{func} @var{dobj} #f))\n" |
732b9327 | 295 | "@end smallexample\n\n") |
1bbd0b84 | 296 | #define FUNC_NAME s_scm_dynamic_call |
80bc7890 | 297 | { |
7cf1a27e MD |
298 | void (*fptr) (); |
299 | ||
a6d9e5ab | 300 | if (SCM_STRINGP (func)) |
7cf1a27e MD |
301 | func = scm_dynamic_func (func, dobj); |
302 | fptr = (void (*) ()) SCM_NUM2ULONG (1, func); | |
7cf1a27e | 303 | fptr (); |
7cf1a27e | 304 | return SCM_UNSPECIFIED; |
80bc7890 | 305 | } |
1bbd0b84 | 306 | #undef FUNC_NAME |
80bc7890 | 307 | |
2ee08a28 GH |
308 | /* return a newly allocated array of char pointers to each of the strings |
309 | in args, with a terminating NULL pointer. */ | |
310 | /* Note: a similar function is defined in posix.c, but we don't necessarily | |
311 | want to export it. */ | |
312 | static char **allocate_string_pointers (SCM args, int *num_args_return) | |
313 | { | |
314 | char **result; | |
315 | int n_args = scm_ilength (args); | |
316 | int i; | |
317 | ||
318 | SCM_ASSERT (n_args >= 0, args, SCM_ARGn, "allocate_string_pointers"); | |
319 | result = (char **) scm_malloc ((n_args + 1) * sizeof (char *)); | |
320 | result[n_args] = NULL; | |
321 | for (i = 0; i < n_args; i++) | |
322 | { | |
323 | SCM car = SCM_CAR (args); | |
324 | ||
325 | if (!SCM_STRINGP (car)) | |
326 | { | |
327 | free (result); | |
328 | scm_wrong_type_arg ("allocate_string_pointers", SCM_ARGn, car); | |
329 | } | |
330 | result[i] = SCM_STRING_CHARS (SCM_CAR (args)); | |
331 | args = SCM_CDR (args); | |
332 | } | |
333 | *num_args_return = n_args; | |
334 | return result; | |
335 | } | |
336 | ||
a1ec6916 | 337 | SCM_DEFINE (scm_dynamic_args_call, "dynamic-args-call", 3, 0, 0, |
1bbd0b84 | 338 | (SCM func, SCM dobj, SCM args), |
1e6808ea MG |
339 | "Call the C function indicated by @var{func} and @var{dobj},\n" |
340 | "just like @code{dynamic-call}, but pass it some arguments and\n" | |
341 | "return its return value. The C function is expected to take\n" | |
342 | "two arguments and return an @code{int}, just like @code{main}:\n" | |
b380b885 MD |
343 | "@smallexample\n" |
344 | "int c_func (int argc, char **argv);\n" | |
345 | "@end smallexample\n\n" | |
1e6808ea MG |
346 | "The parameter @var{args} must be a list of strings and is\n" |
347 | "converted into an array of @code{char *}. The array is passed\n" | |
348 | "in @var{argv} and its size in @var{argc}. The return value is\n" | |
349 | "converted to a Scheme number and returned from the call to\n" | |
350 | "@code{dynamic-args-call}.") | |
1bbd0b84 | 351 | #define FUNC_NAME s_scm_dynamic_args_call |
80bc7890 | 352 | { |
7cf1a27e MD |
353 | int (*fptr) (int argc, char **argv); |
354 | int result, argc; | |
355 | char **argv; | |
356 | ||
a6d9e5ab | 357 | if (SCM_STRINGP (func)) |
7cf1a27e MD |
358 | func = scm_dynamic_func (func, dobj); |
359 | ||
360 | fptr = (int (*) (int, char **)) SCM_NUM2ULONG (1, func); | |
2ee08a28 GH |
361 | argv = allocate_string_pointers (args, &argc); |
362 | /* if the procedure mutates its arguments, the original strings will be | |
363 | changed -- in Guile 1.6 and earlier, this wasn't the case since a | |
364 | new copy of each string was allocated. */ | |
7cf1a27e | 365 | result = (*fptr) (argc, argv); |
2ee08a28 | 366 | free (argv); |
7cf1a27e MD |
367 | |
368 | return SCM_MAKINUM (0L + result); | |
80bc7890 | 369 | } |
1bbd0b84 | 370 | #undef FUNC_NAME |
80bc7890 | 371 | |
1edae076 MV |
372 | void |
373 | scm_init_dynamic_linking () | |
374 | { | |
7cf1a27e | 375 | scm_tc16_dynamic_obj = scm_make_smob_type ("dynamic-object", 0); |
e841c3e0 KN |
376 | scm_set_smob_mark (scm_tc16_dynamic_obj, dynl_obj_mark); |
377 | scm_set_smob_print (scm_tc16_dynamic_obj, dynl_obj_print); | |
7cf1a27e | 378 | sysdep_dynl_init (); |
a0599745 | 379 | #include "libguile/dynl.x" |
1edae076 | 380 | } |
89e00824 ML |
381 | |
382 | /* | |
383 | Local Variables: | |
384 | c-file-style: "gnu" | |
385 | End: | |
386 | */ |