2 * Copyright (C) 2017, Emilio G. Cota <cota@braap.org>
4 * License: GNU GPL, version 2 or later.
5 * See the COPYING file in the top-level directory.
10 #include "qemu/config-file.h"
11 #include "qemu/qemu-plugin.h"
12 #include "qemu/error-report.h"
13 #include "qemu/queue.h"
14 #include "qemu/option.h"
17 * Events that plugins can subscribe to.
19 enum qemu_plugin_event
{
20 QEMU_PLUGIN_EV_VCPU_INIT
,
21 QEMU_PLUGIN_EV_VCPU_EXIT
,
22 QEMU_PLUGIN_EV_VCPU_TB_TRANS
,
23 QEMU_PLUGIN_EV_VCPU_IDLE
,
24 QEMU_PLUGIN_EV_VCPU_RESUME
,
25 QEMU_PLUGIN_EV_VCPU_SYSCALL
,
26 QEMU_PLUGIN_EV_VCPU_SYSCALL_RET
,
28 QEMU_PLUGIN_EV_ATEXIT
,
29 QEMU_PLUGIN_EV_MAX
, /* total number of plugin events we support */
33 * Option parsing/processing.
34 * Note that we can load an arbitrary number of plugins.
36 struct qemu_plugin_desc
;
37 typedef QTAILQ_HEAD(, qemu_plugin_desc
) QemuPluginList
;
40 extern QemuOptsList qemu_plugin_opts
;
42 static inline void qemu_plugin_add_opts(void)
44 qemu_add_opts(&qemu_plugin_opts
);
47 void qemu_plugin_opt_parse(const char *optarg
, QemuPluginList
*head
);
48 int qemu_plugin_load_list(QemuPluginList
*head
);
50 union qemu_plugin_cb_sig
{
51 qemu_plugin_simple_cb_t simple
;
52 qemu_plugin_udata_cb_t udata
;
53 qemu_plugin_vcpu_simple_cb_t vcpu_simple
;
54 qemu_plugin_vcpu_udata_cb_t vcpu_udata
;
55 qemu_plugin_vcpu_tb_trans_cb_t vcpu_tb_trans
;
56 qemu_plugin_vcpu_mem_cb_t vcpu_mem
;
57 qemu_plugin_vcpu_syscall_cb_t vcpu_syscall
;
58 qemu_plugin_vcpu_syscall_ret_cb_t vcpu_syscall_ret
;
62 enum plugin_dyn_cb_type
{
68 enum plugin_dyn_cb_subtype
{
75 * A dynamic callback has an insertion point that is determined at run-time.
76 * Usually the insertion point is somewhere in the code cache; think for
77 * instance of a callback to be called upon the execution of a particular TB.
79 struct qemu_plugin_dyn_cb
{
80 union qemu_plugin_cb_sig f
;
83 enum plugin_dyn_cb_subtype type
;
84 /* @rw applies to mem callbacks only (both regular and inline) */
85 enum qemu_plugin_mem_rw rw
;
86 /* fields specific to each dyn_cb type go here */
89 enum qemu_plugin_op op
;
95 struct qemu_plugin_insn
{
99 GArray
*cbs
[PLUGIN_N_CB_TYPES
][PLUGIN_N_CB_SUBTYPES
];
105 * qemu_plugin_insn allocate and cleanup functions. We don't expect to
106 * cleanup many of these structures. They are reused for each fresh
110 static inline void qemu_plugin_insn_cleanup_fn(gpointer data
)
112 struct qemu_plugin_insn
*insn
= (struct qemu_plugin_insn
*) data
;
113 g_byte_array_free(insn
->data
, true);
116 static inline struct qemu_plugin_insn
*qemu_plugin_insn_alloc(void)
119 struct qemu_plugin_insn
*insn
= g_new0(struct qemu_plugin_insn
, 1);
120 insn
->data
= g_byte_array_sized_new(4);
122 for (i
= 0; i
< PLUGIN_N_CB_TYPES
; i
++) {
123 for (j
= 0; j
< PLUGIN_N_CB_SUBTYPES
; j
++) {
124 insn
->cbs
[i
][j
] = g_array_new(false, false,
125 sizeof(struct qemu_plugin_dyn_cb
));
131 struct qemu_plugin_tb
{
138 GArray
*cbs
[PLUGIN_N_CB_SUBTYPES
];
142 * qemu_plugin_tb_insn_get(): get next plugin record for translation.
146 struct qemu_plugin_insn
*qemu_plugin_tb_insn_get(struct qemu_plugin_tb
*tb
)
148 struct qemu_plugin_insn
*insn
;
151 if (unlikely(tb
->n
== tb
->insns
->len
)) {
152 struct qemu_plugin_insn
*new_insn
= qemu_plugin_insn_alloc();
153 g_ptr_array_add(tb
->insns
, new_insn
);
155 insn
= g_ptr_array_index(tb
->insns
, tb
->n
++);
156 g_byte_array_set_size(insn
->data
, 0);
157 insn
->calls_helpers
= false;
158 insn
->mem_helper
= false;
160 for (i
= 0; i
< PLUGIN_N_CB_TYPES
; i
++) {
161 for (j
= 0; j
< PLUGIN_N_CB_SUBTYPES
; j
++) {
162 g_array_set_size(insn
->cbs
[i
][j
], 0);
169 void qemu_plugin_vcpu_init_hook(CPUState
*cpu
);
170 void qemu_plugin_vcpu_exit_hook(CPUState
*cpu
);
171 void qemu_plugin_tb_trans_cb(CPUState
*cpu
, struct qemu_plugin_tb
*tb
);
172 void qemu_plugin_vcpu_idle_cb(CPUState
*cpu
);
173 void qemu_plugin_vcpu_resume_cb(CPUState
*cpu
);
175 qemu_plugin_vcpu_syscall(CPUState
*cpu
, int64_t num
, uint64_t a1
,
176 uint64_t a2
, uint64_t a3
, uint64_t a4
, uint64_t a5
,
177 uint64_t a6
, uint64_t a7
, uint64_t a8
);
178 void qemu_plugin_vcpu_syscall_ret(CPUState
*cpu
, int64_t num
, int64_t ret
);
180 void qemu_plugin_vcpu_mem_cb(CPUState
*cpu
, uint64_t vaddr
, uint32_t meminfo
);
182 void qemu_plugin_flush_cb(void);
184 void qemu_plugin_atexit_cb(void);
186 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
);
188 void qemu_plugin_disable_mem_helpers(CPUState
*cpu
);
190 #else /* !CONFIG_PLUGIN */
192 static inline void qemu_plugin_add_opts(void)
195 static inline void qemu_plugin_opt_parse(const char *optarg
,
196 QemuPluginList
*head
)
198 error_report("plugin interface not enabled in this build");
202 static inline int qemu_plugin_load_list(QemuPluginList
*head
)
207 static inline void qemu_plugin_vcpu_init_hook(CPUState
*cpu
)
210 static inline void qemu_plugin_vcpu_exit_hook(CPUState
*cpu
)
213 static inline void qemu_plugin_tb_trans_cb(CPUState
*cpu
,
214 struct qemu_plugin_tb
*tb
)
217 static inline void qemu_plugin_vcpu_idle_cb(CPUState
*cpu
)
220 static inline void qemu_plugin_vcpu_resume_cb(CPUState
*cpu
)
224 qemu_plugin_vcpu_syscall(CPUState
*cpu
, int64_t num
, uint64_t a1
, uint64_t a2
,
225 uint64_t a3
, uint64_t a4
, uint64_t a5
, uint64_t a6
,
226 uint64_t a7
, uint64_t a8
)
230 void qemu_plugin_vcpu_syscall_ret(CPUState
*cpu
, int64_t num
, int64_t ret
)
233 static inline void qemu_plugin_vcpu_mem_cb(CPUState
*cpu
, uint64_t vaddr
,
237 static inline void qemu_plugin_flush_cb(void)
240 static inline void qemu_plugin_atexit_cb(void)
244 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
)
247 static inline void qemu_plugin_disable_mem_helpers(CPUState
*cpu
)
250 #endif /* !CONFIG_PLUGIN */
252 #endif /* QEMU_PLUGIN_H */