xref: /openbmc/qemu/plugins/plugin.h (revision 3fb356cc)
154cb65d8SEmilio G. Cota /*
254cb65d8SEmilio G. Cota  * Plugin Shared Internal Functions
354cb65d8SEmilio G. Cota  *
454cb65d8SEmilio G. Cota  * Copyright (C) 2019, Linaro
554cb65d8SEmilio G. Cota  *
654cb65d8SEmilio G. Cota  * License: GNU GPL, version 2 or later.
754cb65d8SEmilio G. Cota  *   See the COPYING file in the top-level directory.
854cb65d8SEmilio G. Cota  *
954cb65d8SEmilio G. Cota  * SPDX-License-Identifier: GPL-2.0-or-later
1054cb65d8SEmilio G. Cota  */
1154cb65d8SEmilio G. Cota 
1254cb65d8SEmilio G. Cota #ifndef _PLUGIN_INTERNAL_H_
1354cb65d8SEmilio G. Cota #define _PLUGIN_INTERNAL_H_
1454cb65d8SEmilio G. Cota 
1554cb65d8SEmilio G. Cota #include <gmodule.h>
1654cb65d8SEmilio G. Cota 
17*3fb356ccSAlex Bennée #define QEMU_PLUGIN_MIN_VERSION 0
18*3fb356ccSAlex Bennée 
1954cb65d8SEmilio G. Cota /* global state */
2054cb65d8SEmilio G. Cota struct qemu_plugin_state {
2154cb65d8SEmilio G. Cota     QTAILQ_HEAD(, qemu_plugin_ctx) ctxs;
2254cb65d8SEmilio G. Cota     QLIST_HEAD(, qemu_plugin_cb) cb_lists[QEMU_PLUGIN_EV_MAX];
2354cb65d8SEmilio G. Cota     /*
2454cb65d8SEmilio G. Cota      * Use the HT as a hash map by inserting k == v, which saves memory as
2554cb65d8SEmilio G. Cota      * documented by GLib. The parent struct is obtained with container_of().
2654cb65d8SEmilio G. Cota      */
2754cb65d8SEmilio G. Cota     GHashTable *id_ht;
2854cb65d8SEmilio G. Cota     /*
2954cb65d8SEmilio G. Cota      * Use the HT as a hash map. Note that we could use a list here,
3054cb65d8SEmilio G. Cota      * but with the HT we avoid adding a field to CPUState.
3154cb65d8SEmilio G. Cota      */
3254cb65d8SEmilio G. Cota     GHashTable *cpu_ht;
3354cb65d8SEmilio G. Cota     DECLARE_BITMAP(mask, QEMU_PLUGIN_EV_MAX);
3454cb65d8SEmilio G. Cota     /*
3554cb65d8SEmilio G. Cota      * @lock protects the struct as well as ctx->uninstalling.
3654cb65d8SEmilio G. Cota      * The lock must be acquired by all API ops.
3754cb65d8SEmilio G. Cota      * The lock is recursive, which greatly simplifies things, e.g.
3854cb65d8SEmilio G. Cota      * callback registration from qemu_plugin_vcpu_for_each().
3954cb65d8SEmilio G. Cota      */
4054cb65d8SEmilio G. Cota     QemuRecMutex lock;
4154cb65d8SEmilio G. Cota     /*
4254cb65d8SEmilio G. Cota      * HT of callbacks invoked from helpers. All entries are freed when
4354cb65d8SEmilio G. Cota      * the code cache is flushed.
4454cb65d8SEmilio G. Cota      */
4554cb65d8SEmilio G. Cota     struct qht dyn_cb_arr_ht;
4654cb65d8SEmilio G. Cota };
4754cb65d8SEmilio G. Cota 
4854cb65d8SEmilio G. Cota 
4954cb65d8SEmilio G. Cota struct qemu_plugin_ctx {
5054cb65d8SEmilio G. Cota     GModule *handle;
5154cb65d8SEmilio G. Cota     qemu_plugin_id_t id;
5254cb65d8SEmilio G. Cota     struct qemu_plugin_cb *callbacks[QEMU_PLUGIN_EV_MAX];
5354cb65d8SEmilio G. Cota     QTAILQ_ENTRY(qemu_plugin_ctx) entry;
5454cb65d8SEmilio G. Cota     /*
5554cb65d8SEmilio G. Cota      * keep a reference to @desc until uninstall, so that plugins do not have
5654cb65d8SEmilio G. Cota      * to strdup plugin args.
5754cb65d8SEmilio G. Cota      */
5854cb65d8SEmilio G. Cota     struct qemu_plugin_desc *desc;
5954cb65d8SEmilio G. Cota     bool installing;
6054cb65d8SEmilio G. Cota     bool uninstalling;
6154cb65d8SEmilio G. Cota     bool resetting;
6254cb65d8SEmilio G. Cota };
6354cb65d8SEmilio G. Cota 
6454cb65d8SEmilio G. Cota struct qemu_plugin_ctx *plugin_id_to_ctx_locked(qemu_plugin_id_t id);
6554cb65d8SEmilio G. Cota 
6654cb65d8SEmilio G. Cota void plugin_register_inline_op(GArray **arr,
6754cb65d8SEmilio G. Cota                                enum qemu_plugin_mem_rw rw,
6854cb65d8SEmilio G. Cota                                enum qemu_plugin_op op, void *ptr,
6954cb65d8SEmilio G. Cota                                uint64_t imm);
7054cb65d8SEmilio G. Cota 
7154cb65d8SEmilio G. Cota void plugin_reset_uninstall(qemu_plugin_id_t id,
7254cb65d8SEmilio G. Cota                             qemu_plugin_simple_cb_t cb,
7354cb65d8SEmilio G. Cota                             bool reset);
7454cb65d8SEmilio G. Cota 
7554cb65d8SEmilio G. Cota void plugin_register_cb(qemu_plugin_id_t id, enum qemu_plugin_event ev,
7654cb65d8SEmilio G. Cota                         void *func);
7754cb65d8SEmilio G. Cota 
7854cb65d8SEmilio G. Cota void plugin_unregister_cb__locked(struct qemu_plugin_ctx *ctx,
7954cb65d8SEmilio G. Cota                                   enum qemu_plugin_event ev);
8054cb65d8SEmilio G. Cota 
8154cb65d8SEmilio G. Cota void
8254cb65d8SEmilio G. Cota plugin_register_cb_udata(qemu_plugin_id_t id, enum qemu_plugin_event ev,
8354cb65d8SEmilio G. Cota                          void *func, void *udata);
8454cb65d8SEmilio G. Cota 
8554cb65d8SEmilio G. Cota void
8654cb65d8SEmilio G. Cota plugin_register_dyn_cb__udata(GArray **arr,
8754cb65d8SEmilio G. Cota                               qemu_plugin_vcpu_udata_cb_t cb,
8854cb65d8SEmilio G. Cota                               enum qemu_plugin_cb_flags flags, void *udata);
8954cb65d8SEmilio G. Cota 
9054cb65d8SEmilio G. Cota 
9154cb65d8SEmilio G. Cota void plugin_register_vcpu_mem_cb(GArray **arr,
9254cb65d8SEmilio G. Cota                                  void *cb,
9354cb65d8SEmilio G. Cota                                  enum qemu_plugin_cb_flags flags,
9454cb65d8SEmilio G. Cota                                  enum qemu_plugin_mem_rw rw,
9554cb65d8SEmilio G. Cota                                  void *udata);
9654cb65d8SEmilio G. Cota 
9754cb65d8SEmilio G. Cota void exec_inline_op(struct qemu_plugin_dyn_cb *cb);
9854cb65d8SEmilio G. Cota 
9954cb65d8SEmilio G. Cota #endif /* _PLUGIN_INTERNAL_H_ */
100