2 * QEMU Plugin Core Loader Code
4 * This is the code responsible for loading and unloading the plugins.
5 * Aside from the basic housekeeping tasks we also need to ensure any
6 * generated code is flushed when we remove a plugin so we cannot end
7 * up calling and unloaded helper function.
9 * Copyright (C) 2017, Emilio G. Cota <cota@braap.org>
10 * Copyright (C) 2019, Linaro
12 * License: GNU GPL, version 2 or later.
13 * See the COPYING file in the top-level directory.
15 * SPDX-License-Identifier: GPL-2.0-or-later
18 #include "qemu/osdep.h"
19 #include "qemu/error-report.h"
20 #include "qemu/config-file.h"
21 #include "qapi/error.h"
22 #include "qemu/option.h"
23 #include "qemu/rcu_queue.h"
25 #include "qemu/bitmap.h"
26 #include "qemu/xxhash.h"
27 #include "qemu/plugin.h"
28 #include "hw/core/cpu.h"
30 #include "exec/exec-all.h"
31 #ifndef CONFIG_USER_ONLY
32 #include "hw/boards.h"
38 * For convenience we use a bitmap for plugin.mask, but really all we need is a
39 * u32, which is what we store in TranslationBlock.
41 QEMU_BUILD_BUG_ON(QEMU_PLUGIN_EV_MAX
> 32);
43 struct qemu_plugin_desc
{
46 QTAILQ_ENTRY(qemu_plugin_desc
) entry
;
50 struct qemu_plugin_parse_arg
{
52 struct qemu_plugin_desc
*curr
;
55 QemuOptsList qemu_plugin_opts
= {
57 .implied_opt_name
= "file",
58 .head
= QTAILQ_HEAD_INITIALIZER(qemu_plugin_opts
.head
),
60 /* do our own parsing to support multiple plugins */
65 typedef int (*qemu_plugin_install_func_t
)(qemu_plugin_id_t
, const qemu_info_t
*, int, char **);
67 extern struct qemu_plugin_state plugin
;
69 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
)
71 uint32_t hash
= qemu_xxhash2((uint64_t)(uintptr_t)arr
);
74 inserted
= qht_insert(&plugin
.dyn_cb_arr_ht
, arr
, hash
, NULL
);
78 static struct qemu_plugin_desc
*plugin_find_desc(QemuPluginList
*head
,
81 struct qemu_plugin_desc
*desc
;
83 QTAILQ_FOREACH(desc
, head
, entry
) {
84 if (strcmp(desc
->path
, path
) == 0) {
91 static int plugin_add(void *opaque
, const char *name
, const char *value
,
94 struct qemu_plugin_parse_arg
*arg
= opaque
;
95 struct qemu_plugin_desc
*p
;
97 if (strcmp(name
, "file") == 0) {
98 if (strcmp(value
, "") == 0) {
99 error_setg(errp
, "requires a non-empty argument");
102 p
= plugin_find_desc(arg
->head
, value
);
104 p
= g_new0(struct qemu_plugin_desc
, 1);
105 p
->path
= g_strdup(value
);
106 QTAILQ_INSERT_TAIL(arg
->head
, p
, entry
);
109 } else if (strcmp(name
, "arg") == 0) {
110 if (arg
->curr
== NULL
) {
111 error_setg(errp
, "missing earlier '-plugin file=' option");
116 p
->argv
= g_realloc_n(p
->argv
, p
->argc
, sizeof(char *));
117 p
->argv
[p
->argc
- 1] = g_strdup(value
);
119 error_setg(errp
, "-plugin: unexpected parameter '%s'; ignored", name
);
124 void qemu_plugin_opt_parse(const char *optarg
, QemuPluginList
*head
)
126 struct qemu_plugin_parse_arg arg
;
129 opts
= qemu_opts_parse_noisily(qemu_find_opts("plugin"), optarg
, true);
135 qemu_opt_foreach(opts
, plugin_add
, &arg
, &error_fatal
);
140 * From: https://en.wikipedia.org/wiki/Xorshift
141 * This is faster than rand_r(), and gives us a wider range (RAND_MAX is only
142 * guaranteed to be >= INT_MAX).
144 static uint64_t xorshift64star(uint64_t x
)
146 x
^= x
>> 12; /* a */
147 x
^= x
<< 25; /* b */
148 x
^= x
>> 27; /* c */
149 return x
* UINT64_C(2685821657736338717);
152 static int plugin_load(struct qemu_plugin_desc
*desc
, const qemu_info_t
*info
)
154 qemu_plugin_install_func_t install
;
155 struct qemu_plugin_ctx
*ctx
;
159 ctx
= qemu_memalign(qemu_dcache_linesize
, sizeof(*ctx
));
160 memset(ctx
, 0, sizeof(*ctx
));
163 ctx
->handle
= g_module_open(desc
->path
, G_MODULE_BIND_LOCAL
);
164 if (ctx
->handle
== NULL
) {
165 error_report("%s: %s", __func__
, g_module_error());
169 if (!g_module_symbol(ctx
->handle
, "qemu_plugin_install", &sym
)) {
170 error_report("%s: %s", __func__
, g_module_error());
173 install
= (qemu_plugin_install_func_t
) sym
;
174 /* symbol was found; it could be NULL though */
175 if (install
== NULL
) {
176 error_report("%s: %s: qemu_plugin_install is NULL",
177 __func__
, desc
->path
);
181 qemu_rec_mutex_lock(&plugin
.lock
);
183 /* find an unused random id with &ctx as the seed */
184 ctx
->id
= (uint64_t)(uintptr_t)ctx
;
188 ctx
->id
= xorshift64star(ctx
->id
);
189 existing
= g_hash_table_lookup(plugin
.id_ht
, &ctx
->id
);
190 if (likely(existing
== NULL
)) {
193 success
= g_hash_table_insert(plugin
.id_ht
, &ctx
->id
, &ctx
->id
);
198 QTAILQ_INSERT_TAIL(&plugin
.ctxs
, ctx
, entry
);
199 ctx
->installing
= true;
200 rc
= install(ctx
->id
, info
, desc
->argc
, desc
->argv
);
201 ctx
->installing
= false;
203 error_report("%s: qemu_plugin_install returned error code %d",
206 * we cannot rely on the plugin doing its own cleanup, so
207 * call a full uninstall if the plugin did not yet call it.
209 if (!ctx
->uninstalling
) {
210 plugin_reset_uninstall(ctx
->id
, NULL
, false);
214 qemu_rec_mutex_unlock(&plugin
.lock
);
223 /* call after having removed @desc from the list */
224 static void plugin_desc_free(struct qemu_plugin_desc
*desc
)
228 for (i
= 0; i
< desc
->argc
; i
++) {
229 g_free(desc
->argv
[i
]);
237 * qemu_plugin_load_list - load a list of plugins
238 * @head: head of the list of descriptors of the plugins to be loaded
240 * Returns 0 if all plugins in the list are installed, !0 otherwise.
242 * Note: the descriptor of each successfully installed plugin is removed
243 * from the list given by @head.
245 int qemu_plugin_load_list(QemuPluginList
*head
)
247 struct qemu_plugin_desc
*desc
, *next
;
248 g_autofree qemu_info_t
*info
= g_new0(qemu_info_t
, 1);
250 info
->target_name
= TARGET_NAME
;
251 #ifndef CONFIG_USER_ONLY
252 MachineState
*ms
= MACHINE(qdev_get_machine());
253 info
->system_emulation
= true;
254 info
->system
.smp_vcpus
= ms
->smp
.cpus
;
255 info
->system
.max_vcpus
= ms
->smp
.max_cpus
;
257 info
->system_emulation
= false;
260 QTAILQ_FOREACH_SAFE(desc
, head
, entry
, next
) {
263 err
= plugin_load(desc
, info
);
267 QTAILQ_REMOVE(head
, desc
, entry
);
272 struct qemu_plugin_reset_data
{
273 struct qemu_plugin_ctx
*ctx
;
274 qemu_plugin_simple_cb_t cb
;
278 static void plugin_reset_destroy__locked(struct qemu_plugin_reset_data
*data
)
280 struct qemu_plugin_ctx
*ctx
= data
->ctx
;
281 enum qemu_plugin_event ev
;
285 * After updating the subscription lists there is no need to wait for an RCU
286 * grace period to elapse, because right now we either are in a "safe async"
287 * work environment (i.e. all vCPUs are asleep), or no vCPUs have yet been
290 for (ev
= 0; ev
< QEMU_PLUGIN_EV_MAX
; ev
++) {
291 plugin_unregister_cb__locked(ctx
, ev
);
295 g_assert(ctx
->resetting
);
299 ctx
->resetting
= false;
304 g_assert(ctx
->uninstalling
);
305 /* we cannot dlclose if we are going to return to plugin code */
306 if (ctx
->installing
) {
307 error_report("Calling qemu_plugin_uninstall from the install function "
308 "is a bug. Instead, return !0 from the install function.");
312 success
= g_hash_table_remove(plugin
.id_ht
, &ctx
->id
);
314 QTAILQ_REMOVE(&plugin
.ctxs
, ctx
, entry
);
318 if (!g_module_close(ctx
->handle
)) {
319 warn_report("%s: %s", __func__
, g_module_error());
321 plugin_desc_free(ctx
->desc
);
326 static void plugin_reset_destroy(struct qemu_plugin_reset_data
*data
)
328 qemu_rec_mutex_lock(&plugin
.lock
);
329 plugin_reset_destroy__locked(data
);
330 qemu_rec_mutex_lock(&plugin
.lock
);
333 static void plugin_flush_destroy(CPUState
*cpu
, run_on_cpu_data arg
)
335 struct qemu_plugin_reset_data
*data
= arg
.host_ptr
;
337 g_assert(cpu_in_exclusive_context(cpu
));
339 plugin_reset_destroy(data
);
342 void plugin_reset_uninstall(qemu_plugin_id_t id
,
343 qemu_plugin_simple_cb_t cb
,
346 struct qemu_plugin_reset_data
*data
;
347 struct qemu_plugin_ctx
*ctx
;
349 qemu_rec_mutex_lock(&plugin
.lock
);
350 ctx
= plugin_id_to_ctx_locked(id
);
351 if (ctx
->uninstalling
|| (reset
&& ctx
->resetting
)) {
352 qemu_rec_mutex_unlock(&plugin
.lock
);
355 ctx
->resetting
= reset
;
356 ctx
->uninstalling
= !reset
;
357 qemu_rec_mutex_unlock(&plugin
.lock
);
359 data
= g_new(struct qemu_plugin_reset_data
, 1);
364 * Only flush the code cache if the vCPUs have been created. If so,
365 * current_cpu must be non-NULL.
368 async_safe_run_on_cpu(current_cpu
, plugin_flush_destroy
,
369 RUN_ON_CPU_HOST_PTR(data
));
372 * If current_cpu isn't set, then we don't have yet any vCPU threads
373 * and we therefore can remove the callbacks synchronously.
375 plugin_reset_destroy(data
);