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 * Option parsing/processing.
18 * Note that we can load an arbitrary number of plugins.
20 struct qemu_plugin_desc
;
21 typedef QTAILQ_HEAD(, qemu_plugin_desc
) QemuPluginList
;
24 extern QemuOptsList qemu_plugin_opts
;
26 static inline void qemu_plugin_add_opts(void)
28 qemu_add_opts(&qemu_plugin_opts
);
31 void qemu_plugin_opt_parse(const char *optarg
, QemuPluginList
*head
);
32 int qemu_plugin_load_list(QemuPluginList
*head
);
33 #else /* !CONFIG_PLUGIN */
34 static inline void qemu_plugin_add_opts(void)
37 static inline void qemu_plugin_opt_parse(const char *optarg
,
40 error_report("plugin interface not enabled in this build");
44 static inline int qemu_plugin_load_list(QemuPluginList
*head
)
48 #endif /* !CONFIG_PLUGIN */
51 * Events that plugins can subscribe to.
53 enum qemu_plugin_event
{
54 QEMU_PLUGIN_EV_VCPU_INIT
,
55 QEMU_PLUGIN_EV_VCPU_EXIT
,
56 QEMU_PLUGIN_EV_VCPU_TB_TRANS
,
57 QEMU_PLUGIN_EV_VCPU_IDLE
,
58 QEMU_PLUGIN_EV_VCPU_RESUME
,
59 QEMU_PLUGIN_EV_VCPU_SYSCALL
,
60 QEMU_PLUGIN_EV_VCPU_SYSCALL_RET
,
62 QEMU_PLUGIN_EV_ATEXIT
,
63 QEMU_PLUGIN_EV_MAX
, /* total number of plugin events we support */
66 union qemu_plugin_cb_sig
{
67 qemu_plugin_simple_cb_t simple
;
68 qemu_plugin_udata_cb_t udata
;
69 qemu_plugin_vcpu_simple_cb_t vcpu_simple
;
70 qemu_plugin_vcpu_udata_cb_t vcpu_udata
;
71 qemu_plugin_vcpu_tb_trans_cb_t vcpu_tb_trans
;
72 qemu_plugin_vcpu_mem_cb_t vcpu_mem
;
73 qemu_plugin_vcpu_syscall_cb_t vcpu_syscall
;
74 qemu_plugin_vcpu_syscall_ret_cb_t vcpu_syscall_ret
;
78 enum plugin_dyn_cb_type
{
84 enum plugin_dyn_cb_subtype
{
91 * A dynamic callback has an insertion point that is determined at run-time.
92 * Usually the insertion point is somewhere in the code cache; think for
93 * instance of a callback to be called upon the execution of a particular TB.
95 struct qemu_plugin_dyn_cb
{
96 union qemu_plugin_cb_sig f
;
99 enum plugin_dyn_cb_subtype type
;
100 /* @rw applies to mem callbacks only (both regular and inline) */
101 enum qemu_plugin_mem_rw rw
;
102 /* fields specific to each dyn_cb type go here */
105 enum qemu_plugin_op op
;
111 struct qemu_plugin_insn
{
115 GArray
*cbs
[PLUGIN_N_CB_TYPES
][PLUGIN_N_CB_SUBTYPES
];
121 * qemu_plugin_insn allocate and cleanup functions. We don't expect to
122 * cleanup many of these structures. They are reused for each fresh
126 static inline void qemu_plugin_insn_cleanup_fn(gpointer data
)
128 struct qemu_plugin_insn
*insn
= (struct qemu_plugin_insn
*) data
;
129 g_byte_array_free(insn
->data
, true);
132 static inline struct qemu_plugin_insn
*qemu_plugin_insn_alloc(void)
135 struct qemu_plugin_insn
*insn
= g_new0(struct qemu_plugin_insn
, 1);
136 insn
->data
= g_byte_array_sized_new(4);
138 for (i
= 0; i
< PLUGIN_N_CB_TYPES
; i
++) {
139 for (j
= 0; j
< PLUGIN_N_CB_SUBTYPES
; j
++) {
140 insn
->cbs
[i
][j
] = g_array_new(false, false,
141 sizeof(struct qemu_plugin_dyn_cb
));
147 struct qemu_plugin_tb
{
154 GArray
*cbs
[PLUGIN_N_CB_SUBTYPES
];
158 * qemu_plugin_tb_insn_get(): get next plugin record for translation.
162 struct qemu_plugin_insn
*qemu_plugin_tb_insn_get(struct qemu_plugin_tb
*tb
)
164 struct qemu_plugin_insn
*insn
;
167 if (unlikely(tb
->n
== tb
->insns
->len
)) {
168 struct qemu_plugin_insn
*new_insn
= qemu_plugin_insn_alloc();
169 g_ptr_array_add(tb
->insns
, new_insn
);
171 insn
= g_ptr_array_index(tb
->insns
, tb
->n
++);
172 g_byte_array_set_size(insn
->data
, 0);
173 insn
->calls_helpers
= false;
174 insn
->mem_helper
= false;
176 for (i
= 0; i
< PLUGIN_N_CB_TYPES
; i
++) {
177 for (j
= 0; j
< PLUGIN_N_CB_SUBTYPES
; j
++) {
178 g_array_set_size(insn
->cbs
[i
][j
], 0);
187 void qemu_plugin_vcpu_init_hook(CPUState
*cpu
);
188 void qemu_plugin_vcpu_exit_hook(CPUState
*cpu
);
189 void qemu_plugin_tb_trans_cb(CPUState
*cpu
, struct qemu_plugin_tb
*tb
);
190 void qemu_plugin_vcpu_idle_cb(CPUState
*cpu
);
191 void qemu_plugin_vcpu_resume_cb(CPUState
*cpu
);
193 qemu_plugin_vcpu_syscall(CPUState
*cpu
, int64_t num
, uint64_t a1
,
194 uint64_t a2
, uint64_t a3
, uint64_t a4
, uint64_t a5
,
195 uint64_t a6
, uint64_t a7
, uint64_t a8
);
196 void qemu_plugin_vcpu_syscall_ret(CPUState
*cpu
, int64_t num
, int64_t ret
);
198 void qemu_plugin_vcpu_mem_cb(CPUState
*cpu
, uint64_t vaddr
, uint32_t meminfo
);
200 void qemu_plugin_flush_cb(void);
202 void qemu_plugin_atexit_cb(void);
204 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
);
206 void qemu_plugin_disable_mem_helpers(CPUState
*cpu
);
208 #else /* !CONFIG_PLUGIN */
210 static inline void qemu_plugin_vcpu_init_hook(CPUState
*cpu
)
213 static inline void qemu_plugin_vcpu_exit_hook(CPUState
*cpu
)
216 static inline void qemu_plugin_tb_trans_cb(CPUState
*cpu
,
217 struct qemu_plugin_tb
*tb
)
220 static inline void qemu_plugin_vcpu_idle_cb(CPUState
*cpu
)
223 static inline void qemu_plugin_vcpu_resume_cb(CPUState
*cpu
)
227 qemu_plugin_vcpu_syscall(CPUState
*cpu
, int64_t num
, uint64_t a1
, uint64_t a2
,
228 uint64_t a3
, uint64_t a4
, uint64_t a5
, uint64_t a6
,
229 uint64_t a7
, uint64_t a8
)
233 void qemu_plugin_vcpu_syscall_ret(CPUState
*cpu
, int64_t num
, int64_t ret
)
236 static inline void qemu_plugin_vcpu_mem_cb(CPUState
*cpu
, uint64_t vaddr
,
240 static inline void qemu_plugin_flush_cb(void)
243 static inline void qemu_plugin_atexit_cb(void)
247 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
)
250 static inline void qemu_plugin_disable_mem_helpers(CPUState
*cpu
)
253 #endif /* !CONFIG_PLUGIN */
255 #endif /* QEMU_PLUGIN_H */