Branch data Line data Source code
1 : : /* module-test.c - test program for GMODULE
2 : : * Copyright (C) 1998 Tim Janik
3 : : *
4 : : * SPDX-License-Identifier: LGPL-2.1-or-later
5 : : *
6 : : * This library is free software; you can redistribute it and/or
7 : : * modify it under the terms of the GNU Lesser General Public
8 : : * License as published by the Free Software Foundation; either
9 : : * version 2.1 of the License, or (at your option) any later version.
10 : : *
11 : : * This library is distributed in the hope that it will be useful,
12 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 : : * Lesser General Public License for more details.
15 : : *
16 : : * You should have received a copy of the GNU Lesser General Public
17 : : * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 : : */
19 : :
20 : : /*
21 : : * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 : : * file for a list of people on the GLib Team. See the ChangeLog
23 : : * files for a list of changes. These files are distributed with
24 : : * GLib at ftp://ftp.gtk.org/pub/gtk/.
25 : : */
26 : :
27 : : #include <gmodule.h>
28 : : #include <glib/gstdio.h>
29 : :
30 : : #ifdef _MSC_VER
31 : : # define MODULE_FILENAME_PREFIX ""
32 : : #else
33 : : # define MODULE_FILENAME_PREFIX "lib"
34 : : #endif
35 : :
36 : : gchar *global_state = NULL;
37 : :
38 : : G_MODULE_EXPORT void g_clash_func (void);
39 : :
40 : : G_MODULE_EXPORT void
41 : 2 : g_clash_func (void)
42 : : {
43 : 2 : global_state = "global clash";
44 : 2 : }
45 : :
46 : : typedef void (*SimpleFunc) (void);
47 : : typedef void (*GModuleFunc) (GModule *);
48 : :
49 : : static gchar **gplugin_a_state;
50 : : static gchar **gplugin_b_state;
51 : :
52 : : static void
53 : 108 : compare (const gchar *desc, const gchar *expected, const gchar *found)
54 : : {
55 : 108 : if (!expected && !found)
56 : 88 : return;
57 : :
58 : 20 : if (expected && found && strcmp (expected, found) == 0)
59 : 20 : return;
60 : :
61 : 0 : g_error ("error: %s state should have been \"%s\", but is \"%s\"",
62 : : desc, expected ? expected : "NULL", found ? found : "NULL");
63 : : }
64 : :
65 : : static void
66 : 36 : test_states (const gchar *global, const gchar *gplugin_a, const gchar *gplugin_b)
67 : : {
68 : 36 : compare ("global", global, global_state);
69 : 36 : compare ("Plugin A", gplugin_a, *gplugin_a_state);
70 : 36 : compare ("Plugin B", gplugin_b, *gplugin_b_state);
71 : :
72 : 36 : global_state = *gplugin_a_state = *gplugin_b_state = NULL;
73 : 36 : }
74 : :
75 : : static SimpleFunc plugin_clash_func = NULL;
76 : :
77 : : static void
78 : 4 : test_module_basics (void)
79 : : {
80 : 4 : if (!g_module_supported ())
81 : : {
82 : 0 : g_test_skip ("dynamic modules not supported");
83 : 0 : return;
84 : : }
85 : :
86 : : /* Run the actual test in a subprocess to avoid symbol table changes from
87 : : * previous tests potentially affecting it. */
88 : 4 : if (g_test_subprocess ())
89 : : {
90 : : GModule *module_self, *module_a, *module_b;
91 : : gchar *plugin_a, *plugin_b;
92 : : SimpleFunc f_a, f_b, f_self;
93 : : GModuleFunc gmod_f;
94 : 2 : GError *error = NULL;
95 : :
96 : 2 : plugin_a = g_test_build_filename (G_TEST_BUILT, MODULE_FILENAME_PREFIX "moduletestplugin_a_" MODULE_TYPE, NULL);
97 : 2 : plugin_b = g_test_build_filename (G_TEST_BUILT, MODULE_FILENAME_PREFIX "moduletestplugin_b_" MODULE_TYPE, NULL);
98 : :
99 : : /* module handles */
100 : :
101 : 2 : module_self = g_module_open_full (NULL, G_MODULE_BIND_LAZY, &error);
102 : 2 : g_assert_no_error (error);
103 : 2 : if (!module_self)
104 : 0 : g_error ("error: %s", g_module_error ());
105 : :
106 : : /* On Windows static compilation mode, glib API symbols are not
107 : : * exported dynamically by definition. */
108 : : #if !defined(G_PLATFORM_WIN32) || !defined(GLIB_STATIC_COMPILATION)
109 : 2 : if (!g_module_symbol (module_self, "g_module_close", (gpointer *) &f_self))
110 : 0 : g_error ("error: %s", g_module_error ());
111 : : #endif
112 : :
113 : 2 : module_a = g_module_open_full (plugin_a, G_MODULE_BIND_LAZY, &error);
114 : 2 : g_assert_no_error (error);
115 : 2 : if (!module_a)
116 : 0 : g_error ("error: %s", g_module_error ());
117 : :
118 : 2 : module_b = g_module_open_full (plugin_b, G_MODULE_BIND_LAZY, &error);
119 : 2 : g_assert_no_error (error);
120 : 2 : if (!module_b)
121 : 0 : g_error ("error: %s", g_module_error ());
122 : :
123 : : /* get plugin state vars */
124 : :
125 : 2 : if (!g_module_symbol (module_a, "gplugin_a_state",
126 : : (gpointer *) &gplugin_a_state))
127 : 0 : g_error ("error: %s", g_module_error ());
128 : :
129 : 2 : if (!g_module_symbol (module_b, "gplugin_b_state",
130 : : (gpointer *) &gplugin_b_state))
131 : 0 : g_error ("error: %s", g_module_error ());
132 : 2 : test_states (NULL, NULL, "check-init");
133 : :
134 : : /* get plugin specific symbols and call them */
135 : :
136 : 2 : if (!g_module_symbol (module_a, "gplugin_a_func", (gpointer *) &f_a))
137 : 0 : g_error ("error: %s", g_module_error ());
138 : 2 : test_states (NULL, NULL, NULL);
139 : :
140 : 2 : if (!g_module_symbol (module_b, "gplugin_b_func", (gpointer *) &f_b))
141 : 0 : g_error ("error: %s", g_module_error ());
142 : 2 : test_states (NULL, NULL, NULL);
143 : :
144 : 2 : f_a ();
145 : 2 : test_states (NULL, "Hello world", NULL);
146 : :
147 : 2 : f_b ();
148 : 2 : test_states (NULL, NULL, "Hello world");
149 : :
150 : : /* get and call globally clashing functions */
151 : :
152 : 2 : if (!g_module_symbol (module_self, "g_clash_func", (gpointer *) &f_self))
153 : 0 : g_error ("error: %s", g_module_error ());
154 : 2 : test_states (NULL, NULL, NULL);
155 : :
156 : 2 : if (!g_module_symbol (module_a, "g_clash_func", (gpointer *) &f_a))
157 : 0 : g_error ("error: %s", g_module_error ());
158 : 2 : test_states (NULL, NULL, NULL);
159 : :
160 : 2 : if (!g_module_symbol (module_b, "g_clash_func", (gpointer *) &f_b))
161 : 0 : g_error ("error: %s", g_module_error ());
162 : 2 : test_states (NULL, NULL, NULL);
163 : :
164 : 2 : f_self ();
165 : 2 : test_states ("global clash", NULL, NULL);
166 : :
167 : 2 : f_a ();
168 : 2 : test_states (NULL, "global clash", NULL);
169 : :
170 : 2 : f_b ();
171 : 2 : test_states (NULL, NULL, "global clash");
172 : :
173 : : /* get and call clashing plugin functions */
174 : :
175 : 2 : if (!g_module_symbol (module_a, "gplugin_clash_func", (gpointer *) &f_a))
176 : 0 : g_error ("error: %s", g_module_error ());
177 : 2 : test_states (NULL, NULL, NULL);
178 : :
179 : 2 : if (!g_module_symbol (module_b, "gplugin_clash_func", (gpointer *) &f_b))
180 : 0 : g_error ("error: %s", g_module_error ());
181 : 2 : test_states (NULL, NULL, NULL);
182 : :
183 : 2 : plugin_clash_func = f_a;
184 : 2 : plugin_clash_func ();
185 : 2 : test_states (NULL, "plugin clash", NULL);
186 : :
187 : 2 : plugin_clash_func = f_b;
188 : 2 : plugin_clash_func ();
189 : 2 : test_states (NULL, NULL, "plugin clash");
190 : :
191 : : /* call gmodule function from A */
192 : :
193 : 2 : if (!g_module_symbol (module_a, "gplugin_a_module_func", (gpointer *) &gmod_f))
194 : 0 : g_error ("error: %s", g_module_error ());
195 : 2 : test_states (NULL, NULL, NULL);
196 : :
197 : 2 : gmod_f (module_b);
198 : 2 : test_states (NULL, NULL, "BOOH");
199 : :
200 : 2 : gmod_f (module_a);
201 : 2 : test_states (NULL, "BOOH", NULL);
202 : :
203 : : /* unload plugins */
204 : :
205 : 2 : if (!g_module_close (module_a))
206 : 0 : g_error ("error: %s", g_module_error ());
207 : :
208 : 2 : if (!g_module_close (module_b))
209 : 0 : g_error ("error: %s", g_module_error ());
210 : :
211 : 2 : g_free (plugin_a);
212 : 2 : g_free (plugin_b);
213 : 2 : g_module_close (module_self);
214 : : }
215 : : else
216 : : {
217 : 2 : g_test_trap_subprocess (NULL, 0, G_TEST_SUBPROCESS_DEFAULT);
218 : 2 : g_test_trap_assert_passed ();
219 : : }
220 : : }
221 : :
222 : : static void
223 : 2 : test_module_invalid_libtool_archive (void)
224 : : {
225 : : int la_fd;
226 : 2 : gchar *la_filename = NULL;
227 : 2 : GModule *module = NULL;
228 : 2 : GError *local_error = NULL;
229 : :
230 : 2 : g_test_summary ("Test that opening an invalid .la file fails");
231 : :
232 : : /* Create an empty temporary file ending in `.la` */
233 : 2 : la_fd = g_file_open_tmp ("gmodule-invalid-XXXXXX.la", &la_filename, &local_error);
234 : 2 : g_assert_no_error (local_error);
235 : 2 : g_assert_true (g_str_has_suffix (la_filename, ".la"));
236 : 2 : g_close (la_fd, NULL);
237 : :
238 : : /* Try loading it */
239 : 2 : module = g_module_open_full (la_filename, 0, &local_error);
240 : 2 : g_assert_error (local_error, G_MODULE_ERROR, G_MODULE_ERROR_FAILED);
241 : 2 : g_assert_null (module);
242 : 2 : g_clear_error (&local_error);
243 : :
244 : 2 : (void) g_unlink (la_filename);
245 : :
246 : 2 : g_free (la_filename);
247 : 2 : }
248 : :
249 : : static void
250 : 4 : test_local_binding (void)
251 : : {
252 : 4 : g_test_summary ("Test that binding a library's symbols locally does not add them globally");
253 : :
254 : : #if defined(G_PLATFORM_WIN32)
255 : : g_test_skip ("G_MODULE_BIND_LOCAL is not supported on Windows.");
256 : : return;
257 : : #endif
258 : :
259 : : /* Run the actual test in a subprocess to avoid symbol table changes from
260 : : * previous tests potentially affecting it. */
261 : 4 : if (g_test_subprocess ())
262 : : {
263 : 2 : gchar *plugin = NULL;
264 : 2 : GModule *module_plugin = NULL, *module_self = NULL;
265 : 2 : GError *error = NULL;
266 : :
267 : 2 : gboolean found_symbol = FALSE;
268 : 2 : gpointer symbol = NULL;
269 : :
270 : 2 : plugin = g_test_build_filename (G_TEST_BUILT, MODULE_FILENAME_PREFIX "moduletestplugin_a_" MODULE_TYPE, NULL);
271 : :
272 : 2 : module_plugin = g_module_open_full (plugin, G_MODULE_BIND_LOCAL, &error);
273 : 2 : g_assert_no_error (error);
274 : 2 : g_assert_nonnull (module_plugin);
275 : :
276 : 2 : module_self = g_module_open_full (NULL, 0, &error);
277 : 2 : g_assert_no_error (error);
278 : 2 : g_assert_nonnull (module_self);
279 : :
280 : 2 : found_symbol = g_module_symbol (module_self, "gplugin_say_boo_func", &symbol);
281 : 2 : g_assert_false (found_symbol);
282 : 2 : g_assert_null (symbol);
283 : :
284 : 2 : g_module_close (module_self);
285 : 2 : g_module_close (module_plugin);
286 : 2 : g_free (plugin);
287 : : }
288 : : else
289 : : {
290 : 2 : g_test_trap_subprocess (NULL, 0, G_TEST_SUBPROCESS_DEFAULT);
291 : 2 : g_test_trap_assert_passed ();
292 : : }
293 : 4 : }
294 : :
295 : : int
296 : 6 : main (int argc, char *argv[])
297 : : {
298 : 6 : g_test_init (&argc, &argv, NULL);
299 : :
300 : 6 : g_test_add_func ("/module/basics", test_module_basics);
301 : 6 : g_test_add_func ("/module/invalid-libtool-archive", test_module_invalid_libtool_archive);
302 : 6 : g_test_add_func ("/module/local-binding", test_local_binding);
303 : :
304 : 6 : return g_test_run ();
305 : : }
|
