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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/* $Id: shlib.pl,v 1.11 1999/11/29 14:36:42 jan Exp $
Copyright (c) 1990 Jan Wielemaker. All rights reserved.
jan@swi.psy.uva.nl
Purpose: Front-end for loading shared libraries
*/
:- module(shlib,
[ load_foreign_library/1, % :LibFile
load_foreign_library/2, % :LibFile, +InstallFunc
unload_foreign_library/1, % +LibFile
unload_foreign_library/1, % +LibFile, +UninstallFunc
current_foreign_library/2, % ?LibFile, ?Public
reload_foreign_libraries/0
]).
:- module_transparent
load_foreign_library/1,
load_foreign_library/2.
:- dynamic
current_library/6, % Lib x Entry x Path x
% Module x Handle x Public
fpublic/1.
:- volatile
current_library/6,
fpublic/1.
:- ( current_prolog_flag(open_shared_object, true)
-> true
; format(user_error,
'library(shlib): warning: Emulator does not support foreign libraries',
[])
).
/*******************************
* DISPATCHING *
*******************************/
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Windows: If libpl.dll is compiled for debugging, prefer loading <lib>D.dll
to allow for debugging.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
find_library(Spec, Lib) :-
current_prolog_flag(windows, true),
current_prolog_flag(kernel_compile_mode, debug),
libd_spec(Spec, SpecD),
catch(find_library2(SpecD, Lib), _, fail), !.
find_library(Spec, Lib) :-
find_library2(Spec, Lib).
find_library2(Spec, Lib) :-
absolute_file_name(Spec,
[ file_type(executable),
access(read),
file_errors(fail)
], Lib), !.
find_library2(Spec, Spec) :-
atom(Spec), !. % use machines finding schema
find_library2(foreign(Spec), Spec) :-
atom(Spec), !. % use machines finding schema
find_library2(Spec, _) :-
throw(error(existence_error(source_sink, Spec), _)).
libd_spec(Name, NameD) :-
atomic(Name), !,
file_name_extension(Base, Ext, Name),
atom_concat(Base, 'D', BaseD),
file_name_extension(BaseD, Ext, NameD).
libd_spec(Spec, SpecD) :-
Spec =.. [Alias,Name], !,
libd_spec(Name, NameD),
SpecD =.. [Alias,NameD].
libd_spec(Spec, Spec). % delay errors
base(Path, Base) :-
atomic(Path), !,
file_base_name(Path, File),
file_name_extension(Base, _Ext, File).
base(Path, Base) :-
Path =.. [_,Arg],
base(Arg, Base).
entry(_, Function, Function) :-
Function \= default(_), !.
entry(Spec, default(FuncBase), Function) :-
base(Spec, Base),
concat_atom([FuncBase, Base], '_', Function).
entry(_, default(Function), Function).
/*******************************
* (UN)LOADING *
*******************************/
load_foreign_library(Library) :-
load_foreign_library(Library, default(install)).
load_foreign_library(LibFileSpec, Entry) :-
'$strip_module'(LibFileSpec, Module, LibFile),
load_foreign_library(LibFile, Module, Entry).
load_foreign_library(LibFile, _Module, _) :-
current_library(LibFile, _, _, _, _, _), !.
load_foreign_library(LibFile, Module, DefEntry) :-
find_library(LibFile, Path),
( clean_fpublic, % safety
Module:open_shared_object(Path, Handle),
( entry(LibFile, DefEntry, Entry),
Module:call_shared_object_function(Handle, Entry)
-> true
; DefEntry == default(install)
)
-> assert_shlib(LibFile, Entry, Path, Module, Handle),
clean_fpublic
; print_message(error, shlib(LibFile, call_entry(DefEntry))),
close_shared_object(Handle),
fail
).
unload_foreign_library(LibFile) :-
unload_foreign_library(LibFile, default(uninstall)).
unload_foreign_library(LibFile, DefUninstall) :-
current_library(LibFile, _, _, Module, Public, Handle),
retractall(current_library(LibFile, _, _, _, _, _)),
( entry(LibFile, DefUninstall, Uninstall),
Module:call_shared_object_function(Handle, Uninstall)
-> true
; true
),
forall(member(Module:Head, Public),
( functor(Head, Name, Arity),
abolish(Module:Name, Arity)
)),
close_shared_object(Handle).
system:'$foreign_registered'(M, H) :-
assert(fpublic(M:H)).
clean_fpublic :-
retractall(fpublic(_)).
assert_shlib(File, Entry, Path, Module, Handle) :-
findall(P, fpublic(P), Public),
retractall(current_library(File, _, _, _, _, _)),
asserta(current_library(File, Entry, Path, Module, Public, Handle)).
/*******************************
* ADMINISTRATION *
*******************************/
% current_foreign_library(?File, ?Public)
%
% Query currently loaded shared libraries
current_foreign_library(File, Public) :-
current_library(File, _Entry, _Path, _Module, Public, _Handle).
/*******************************
* RELOAD *
*******************************/
% reload_foreign_libraries
%
% Reload all foreign libraries loaded (after restore of state)
reload_foreign_libraries :-
forall(retract(current_library(File, Entry, _, Module, _, _)),
( load_foreign_library(File, Module, Entry)
-> true
; print_message(shlib(File, load_failed))
)).
/*******************************
* CLEANUP (WINDOWS ...) *
*******************************/
/* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Called from Halt() in pl-os.c (if it is defined), *after* all at_halt/1
hooks have been executed, and after dieIO(), closing and flushing all
files has been called.
On Unix, this is not very useful, and can only lead to conflicts.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
unload_all_foreign_libraries :-
current_prolog_flag(unix, true), !.
unload_all_foreign_libraries :-
forall(current_foreign_library(File, _),
unload_foreign_library(File)).
/*******************************
* MESSAGES *
*******************************/
:- multifile
prolog:message/3.
prolog:message(shlib(LibFile, call_entry(DefEntry))) -->
[ '~w: Failed to call entry-point ~w'-[LibFile, DefEntry] ].
prolog:message(shlib(LibFile, load_failed)) -->
[ '~w: Failed to load file'-[LibFile] ].
|
