]>
Commit | Line | Data |
---|---|---|
0bfe3ca5 AL |
1 | /* |
2 | * QEMU Module Infrastructure | |
3 | * | |
4 | * Copyright IBM, Corp. 2009 | |
5 | * | |
6 | * Authors: | |
7 | * Anthony Liguori <aliguori@us.ibm.com> | |
8 | * | |
9 | * This work is licensed under the terms of the GNU GPL, version 2. See | |
10 | * the COPYING file in the top-level directory. | |
11 | * | |
6b620ca3 PB |
12 | * Contributions after 2012-01-13 are licensed under the terms of the |
13 | * GNU GPL, version 2 or (at your option) any later version. | |
0bfe3ca5 AL |
14 | */ |
15 | ||
aafd7584 | 16 | #include "qemu/osdep.h" |
aa0d1f44 | 17 | #ifdef CONFIG_MODULES |
e26110cf | 18 | #include <gmodule.h> |
aa0d1f44 | 19 | #endif |
1de7afc9 PB |
20 | #include "qemu/queue.h" |
21 | #include "qemu/module.h" | |
1b934064 | 22 | #include "qemu/cutils.h" |
5111edaf | 23 | #include "qemu/config-file.h" |
bd83c861 CE |
24 | #ifdef CONFIG_MODULE_UPGRADES |
25 | #include "qemu-version.h" | |
26 | #endif | |
819b8b13 | 27 | #include "trace.h" |
0bfe3ca5 AL |
28 | |
29 | typedef struct ModuleEntry | |
30 | { | |
0bfe3ca5 | 31 | void (*init)(void); |
72cf2d4f | 32 | QTAILQ_ENTRY(ModuleEntry) node; |
e26110cf | 33 | module_init_type type; |
0bfe3ca5 AL |
34 | } ModuleEntry; |
35 | ||
72cf2d4f | 36 | typedef QTAILQ_HEAD(, ModuleEntry) ModuleTypeList; |
0bfe3ca5 | 37 | |
f7897430 | 38 | static ModuleTypeList init_type_list[MODULE_INIT_MAX]; |
46a07579 | 39 | static bool modules_init_done[MODULE_INIT_MAX]; |
0bfe3ca5 | 40 | |
e26110cf FZ |
41 | static ModuleTypeList dso_init_list; |
42 | ||
43 | static void init_lists(void) | |
0bfe3ca5 | 44 | { |
f7897430 AL |
45 | static int inited; |
46 | int i; | |
0bfe3ca5 | 47 | |
f7897430 AL |
48 | if (inited) { |
49 | return; | |
0bfe3ca5 AL |
50 | } |
51 | ||
f7897430 | 52 | for (i = 0; i < MODULE_INIT_MAX; i++) { |
72cf2d4f | 53 | QTAILQ_INIT(&init_type_list[i]); |
f7897430 | 54 | } |
0bfe3ca5 | 55 | |
e26110cf FZ |
56 | QTAILQ_INIT(&dso_init_list); |
57 | ||
f7897430 AL |
58 | inited = 1; |
59 | } | |
0bfe3ca5 | 60 | |
0bfe3ca5 | 61 | |
f7897430 AL |
62 | static ModuleTypeList *find_type(module_init_type type) |
63 | { | |
e26110cf | 64 | init_lists(); |
f7897430 | 65 | |
9be38598 | 66 | return &init_type_list[type]; |
0bfe3ca5 AL |
67 | } |
68 | ||
69 | void register_module_init(void (*fn)(void), module_init_type type) | |
70 | { | |
71 | ModuleEntry *e; | |
72 | ModuleTypeList *l; | |
73 | ||
7267c094 | 74 | e = g_malloc0(sizeof(*e)); |
0bfe3ca5 | 75 | e->init = fn; |
e26110cf | 76 | e->type = type; |
0bfe3ca5 | 77 | |
f7897430 | 78 | l = find_type(type); |
0bfe3ca5 | 79 | |
72cf2d4f | 80 | QTAILQ_INSERT_TAIL(l, e, node); |
0bfe3ca5 AL |
81 | } |
82 | ||
e26110cf FZ |
83 | void register_dso_module_init(void (*fn)(void), module_init_type type) |
84 | { | |
85 | ModuleEntry *e; | |
86 | ||
87 | init_lists(); | |
88 | ||
89 | e = g_malloc0(sizeof(*e)); | |
90 | e->init = fn; | |
91 | e->type = type; | |
92 | ||
93 | QTAILQ_INSERT_TAIL(&dso_init_list, e, node); | |
94 | } | |
95 | ||
0bfe3ca5 AL |
96 | void module_call_init(module_init_type type) |
97 | { | |
98 | ModuleTypeList *l; | |
99 | ModuleEntry *e; | |
100 | ||
46a07579 AB |
101 | if (modules_init_done[type]) { |
102 | return; | |
103 | } | |
104 | ||
f7897430 | 105 | l = find_type(type); |
0bfe3ca5 | 106 | |
72cf2d4f | 107 | QTAILQ_FOREACH(e, l, node) { |
0bfe3ca5 AL |
108 | e->init(); |
109 | } | |
46a07579 AB |
110 | |
111 | modules_init_done[type] = true; | |
0bfe3ca5 | 112 | } |
e26110cf FZ |
113 | |
114 | #ifdef CONFIG_MODULES | |
5ebbfecc GH |
115 | |
116 | static const QemuModinfo module_info_stub[] = { { | |
117 | /* end of list */ | |
118 | } }; | |
119 | static const QemuModinfo *module_info = module_info_stub; | |
d7795d3c | 120 | static const char *module_arch; |
5ebbfecc GH |
121 | |
122 | void module_init_info(const QemuModinfo *info) | |
123 | { | |
124 | module_info = info; | |
125 | } | |
126 | ||
d7795d3c GH |
127 | void module_allow_arch(const char *arch) |
128 | { | |
129 | module_arch = arch; | |
130 | } | |
131 | ||
132 | static bool module_check_arch(const QemuModinfo *modinfo) | |
133 | { | |
134 | if (modinfo->arch) { | |
135 | if (!module_arch) { | |
136 | /* no arch set -> ignore all */ | |
137 | return false; | |
138 | } | |
139 | if (strcmp(module_arch, modinfo->arch) != 0) { | |
140 | /* mismatch */ | |
141 | return false; | |
142 | } | |
143 | } | |
144 | return true; | |
145 | } | |
146 | ||
6f13fa7a | 147 | static int module_load_file(const char *fname, bool mayfail, bool export_symbols) |
e26110cf FZ |
148 | { |
149 | GModule *g_module; | |
150 | void (*sym)(void); | |
859aef02 | 151 | const char *dsosuf = CONFIG_HOST_DSOSUF; |
e26110cf FZ |
152 | int len = strlen(fname); |
153 | int suf_len = strlen(dsosuf); | |
154 | ModuleEntry *e, *next; | |
6f13fa7a | 155 | int ret, flags; |
e26110cf FZ |
156 | |
157 | if (len <= suf_len || strcmp(&fname[len - suf_len], dsosuf)) { | |
158 | /* wrong suffix */ | |
159 | ret = -EINVAL; | |
160 | goto out; | |
161 | } | |
162 | if (access(fname, F_OK)) { | |
163 | ret = -ENOENT; | |
164 | goto out; | |
165 | } | |
166 | ||
167 | assert(QTAILQ_EMPTY(&dso_init_list)); | |
168 | ||
546323bd | 169 | flags = 0; |
6f13fa7a GH |
170 | if (!export_symbols) { |
171 | flags |= G_MODULE_BIND_LOCAL; | |
172 | } | |
173 | g_module = g_module_open(fname, flags); | |
e26110cf | 174 | if (!g_module) { |
50109320 GH |
175 | if (!mayfail) { |
176 | fprintf(stderr, "Failed to open module: %s\n", | |
177 | g_module_error()); | |
178 | } | |
e26110cf FZ |
179 | ret = -EINVAL; |
180 | goto out; | |
181 | } | |
182 | if (!g_module_symbol(g_module, DSO_STAMP_FUN_STR, (gpointer *)&sym)) { | |
183 | fprintf(stderr, "Failed to initialize module: %s\n", | |
184 | fname); | |
185 | /* Print some info if this is a QEMU module (but from different build), | |
186 | * this will make debugging user problems easier. */ | |
187 | if (g_module_symbol(g_module, "qemu_module_dummy", (gpointer *)&sym)) { | |
188 | fprintf(stderr, | |
189 | "Note: only modules from the same build can be loaded.\n"); | |
190 | } | |
191 | g_module_close(g_module); | |
192 | ret = -EINVAL; | |
193 | } else { | |
194 | QTAILQ_FOREACH(e, &dso_init_list, node) { | |
88d88798 | 195 | e->init(); |
e26110cf FZ |
196 | register_module_init(e->init, e->type); |
197 | } | |
198 | ret = 0; | |
199 | } | |
200 | ||
819b8b13 | 201 | trace_module_load_module(fname); |
e26110cf FZ |
202 | QTAILQ_FOREACH_SAFE(e, &dso_init_list, node, next) { |
203 | QTAILQ_REMOVE(&dso_init_list, e, node); | |
204 | g_free(e); | |
205 | } | |
206 | out: | |
207 | return ret; | |
208 | } | |
209 | #endif | |
210 | ||
50109320 | 211 | bool module_load_one(const char *prefix, const char *lib_name, bool mayfail) |
e26110cf | 212 | { |
81d8ccb1 MAL |
213 | bool success = false; |
214 | ||
e26110cf FZ |
215 | #ifdef CONFIG_MODULES |
216 | char *fname = NULL; | |
bd83c861 CE |
217 | #ifdef CONFIG_MODULE_UPGRADES |
218 | char *version_dir; | |
219 | #endif | |
900610e6 | 220 | const char *search_dir; |
267514b3 | 221 | char *dirs[5]; |
dffa41b4 | 222 | char *module_name; |
900610e6 | 223 | int i = 0, n_dirs = 0; |
e897b9a7 | 224 | int ret; |
6f13fa7a | 225 | bool export_symbols = false; |
dffa41b4 | 226 | static GHashTable *loaded_modules; |
e897b9a7 GH |
227 | const QemuModinfo *modinfo; |
228 | const char **sl; | |
e26110cf FZ |
229 | |
230 | if (!g_module_supported()) { | |
231 | fprintf(stderr, "Module is not supported by system.\n"); | |
81d8ccb1 | 232 | return false; |
e26110cf FZ |
233 | } |
234 | ||
dffa41b4 FZ |
235 | if (!loaded_modules) { |
236 | loaded_modules = g_hash_table_new(g_str_hash, g_str_equal); | |
237 | } | |
238 | ||
239 | module_name = g_strdup_printf("%s%s", prefix, lib_name); | |
240 | ||
64e16fbb | 241 | if (g_hash_table_contains(loaded_modules, module_name)) { |
dffa41b4 | 242 | g_free(module_name); |
81d8ccb1 | 243 | return true; |
dffa41b4 | 244 | } |
64e16fbb | 245 | g_hash_table_add(loaded_modules, module_name); |
dffa41b4 | 246 | |
e897b9a7 | 247 | for (modinfo = module_info; modinfo->name != NULL; modinfo++) { |
d7795d3c GH |
248 | if (modinfo->arch) { |
249 | if (strcmp(modinfo->name, module_name) == 0) { | |
250 | if (!module_check_arch(modinfo)) { | |
251 | return false; | |
252 | } | |
253 | } | |
254 | } | |
e897b9a7 GH |
255 | if (modinfo->deps) { |
256 | if (strcmp(modinfo->name, module_name) == 0) { | |
257 | /* we depend on other module(s) */ | |
258 | for (sl = modinfo->deps; *sl != NULL; sl++) { | |
259 | module_load_one("", *sl, false); | |
260 | } | |
261 | } else { | |
262 | for (sl = modinfo->deps; *sl != NULL; sl++) { | |
263 | if (strcmp(module_name, *sl) == 0) { | |
264 | /* another module depends on us */ | |
265 | export_symbols = true; | |
266 | } | |
267 | } | |
268 | } | |
269 | } | |
270 | } | |
271 | ||
900610e6 | 272 | search_dir = getenv("QEMU_MODULE_DIR"); |
273 | if (search_dir != NULL) { | |
274 | dirs[n_dirs++] = g_strdup_printf("%s", search_dir); | |
275 | } | |
1b934064 | 276 | dirs[n_dirs++] = get_relocated_path(CONFIG_QEMU_MODDIR); |
a4c13869 | 277 | dirs[n_dirs++] = g_strdup(qemu_get_exec_dir()); |
bd83c861 CE |
278 | |
279 | #ifdef CONFIG_MODULE_UPGRADES | |
280 | version_dir = g_strcanon(g_strdup(QEMU_PKGVERSION), | |
281 | G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "+-.~", | |
282 | '_'); | |
283 | dirs[n_dirs++] = g_strdup_printf("/var/run/qemu/%s", version_dir); | |
284 | #endif | |
285 | ||
900610e6 | 286 | assert(n_dirs <= ARRAY_SIZE(dirs)); |
287 | ||
900610e6 | 288 | for (i = 0; i < n_dirs; i++) { |
dffa41b4 | 289 | fname = g_strdup_printf("%s/%s%s", |
859aef02 | 290 | dirs[i], module_name, CONFIG_HOST_DSOSUF); |
6f13fa7a | 291 | ret = module_load_file(fname, mayfail, export_symbols); |
88d88798 MM |
292 | g_free(fname); |
293 | fname = NULL; | |
294 | /* Try loading until loaded a module file */ | |
295 | if (!ret) { | |
81d8ccb1 | 296 | success = true; |
88d88798 | 297 | break; |
e26110cf | 298 | } |
e26110cf FZ |
299 | } |
300 | ||
81d8ccb1 MAL |
301 | if (!success) { |
302 | g_hash_table_remove(loaded_modules, module_name); | |
638be478 | 303 | g_free(module_name); |
81d8ccb1 MAL |
304 | } |
305 | ||
900610e6 | 306 | for (i = 0; i < n_dirs; i++) { |
e26110cf FZ |
307 | g_free(dirs[i]); |
308 | } | |
309 | ||
310 | #endif | |
81d8ccb1 | 311 | return success; |
e26110cf | 312 | } |
28457744 | 313 | |
9f4a0f09 | 314 | #ifdef CONFIG_MODULES |
28457744 GH |
315 | |
316 | static bool module_loaded_qom_all; | |
317 | ||
318 | void module_load_qom_one(const char *type) | |
319 | { | |
9f4a0f09 GH |
320 | const QemuModinfo *modinfo; |
321 | const char **sl; | |
28457744 | 322 | |
d87350b0 GH |
323 | if (!type) { |
324 | return; | |
325 | } | |
9f4a0f09 | 326 | |
819b8b13 | 327 | trace_module_lookup_object_type(type); |
9f4a0f09 GH |
328 | for (modinfo = module_info; modinfo->name != NULL; modinfo++) { |
329 | if (!modinfo->objs) { | |
330 | continue; | |
331 | } | |
332 | for (sl = modinfo->objs; *sl != NULL; sl++) { | |
333 | if (strcmp(type, *sl) == 0) { | |
334 | module_load_one("", modinfo->name, false); | |
335 | } | |
28457744 GH |
336 | } |
337 | } | |
338 | } | |
339 | ||
340 | void module_load_qom_all(void) | |
341 | { | |
9f4a0f09 | 342 | const QemuModinfo *modinfo; |
28457744 GH |
343 | |
344 | if (module_loaded_qom_all) { | |
345 | return; | |
346 | } | |
9f4a0f09 GH |
347 | |
348 | for (modinfo = module_info; modinfo->name != NULL; modinfo++) { | |
349 | if (!modinfo->objs) { | |
28457744 GH |
350 | continue; |
351 | } | |
9f4a0f09 | 352 | module_load_one("", modinfo->name, false); |
28457744 GH |
353 | } |
354 | module_loaded_qom_all = true; | |
355 | } | |
9f4a0f09 | 356 | |
5111edaf GH |
357 | void qemu_load_module_for_opts(const char *group) |
358 | { | |
359 | const QemuModinfo *modinfo; | |
360 | const char **sl; | |
361 | ||
362 | for (modinfo = module_info; modinfo->name != NULL; modinfo++) { | |
363 | if (!modinfo->opts) { | |
364 | continue; | |
365 | } | |
366 | for (sl = modinfo->opts; *sl != NULL; sl++) { | |
367 | if (strcmp(group, *sl) == 0) { | |
368 | module_load_one("", modinfo->name, false); | |
369 | } | |
370 | } | |
371 | } | |
372 | } | |
373 | ||
9f4a0f09 GH |
374 | #else |
375 | ||
d7795d3c | 376 | void module_allow_arch(const char *arch) {} |
5111edaf | 377 | void qemu_load_module_for_opts(const char *group) {} |
9f4a0f09 GH |
378 | void module_load_qom_one(const char *type) {} |
379 | void module_load_qom_all(void) {} | |
380 | ||
381 | #endif |