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
, Error
**errp
);
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 /* Internal context for instrumenting an instruction */
96 struct qemu_plugin_insn
{
100 GArray
*cbs
[PLUGIN_N_CB_TYPES
][PLUGIN_N_CB_SUBTYPES
];
107 * qemu_plugin_insn allocate and cleanup functions. We don't expect to
108 * cleanup many of these structures. They are reused for each fresh
112 static inline void qemu_plugin_insn_cleanup_fn(gpointer data
)
114 struct qemu_plugin_insn
*insn
= (struct qemu_plugin_insn
*) data
;
115 g_byte_array_free(insn
->data
, true);
118 static inline struct qemu_plugin_insn
*qemu_plugin_insn_alloc(void)
121 struct qemu_plugin_insn
*insn
= g_new0(struct qemu_plugin_insn
, 1);
122 insn
->data
= g_byte_array_sized_new(4);
124 for (i
= 0; i
< PLUGIN_N_CB_TYPES
; i
++) {
125 for (j
= 0; j
< PLUGIN_N_CB_SUBTYPES
; j
++) {
126 insn
->cbs
[i
][j
] = g_array_new(false, false,
127 sizeof(struct qemu_plugin_dyn_cb
));
133 /* Internal context for this TranslationBlock */
134 struct qemu_plugin_tb
{
142 GArray
*cbs
[PLUGIN_N_CB_SUBTYPES
];
146 * qemu_plugin_tb_insn_get(): get next plugin record for translation.
150 struct qemu_plugin_insn
*qemu_plugin_tb_insn_get(struct qemu_plugin_tb
*tb
)
152 struct qemu_plugin_insn
*insn
;
155 if (unlikely(tb
->n
== tb
->insns
->len
)) {
156 struct qemu_plugin_insn
*new_insn
= qemu_plugin_insn_alloc();
157 g_ptr_array_add(tb
->insns
, new_insn
);
159 insn
= g_ptr_array_index(tb
->insns
, tb
->n
++);
160 g_byte_array_set_size(insn
->data
, 0);
161 insn
->calls_helpers
= false;
162 insn
->mem_helper
= false;
164 for (i
= 0; i
< PLUGIN_N_CB_TYPES
; i
++) {
165 for (j
= 0; j
< PLUGIN_N_CB_SUBTYPES
; j
++) {
166 g_array_set_size(insn
->cbs
[i
][j
], 0);
173 void qemu_plugin_vcpu_init_hook(CPUState
*cpu
);
174 void qemu_plugin_vcpu_exit_hook(CPUState
*cpu
);
175 void qemu_plugin_tb_trans_cb(CPUState
*cpu
, struct qemu_plugin_tb
*tb
);
176 void qemu_plugin_vcpu_idle_cb(CPUState
*cpu
);
177 void qemu_plugin_vcpu_resume_cb(CPUState
*cpu
);
179 qemu_plugin_vcpu_syscall(CPUState
*cpu
, int64_t num
, uint64_t a1
,
180 uint64_t a2
, uint64_t a3
, uint64_t a4
, uint64_t a5
,
181 uint64_t a6
, uint64_t a7
, uint64_t a8
);
182 void qemu_plugin_vcpu_syscall_ret(CPUState
*cpu
, int64_t num
, int64_t ret
);
184 void qemu_plugin_vcpu_mem_cb(CPUState
*cpu
, uint64_t vaddr
, uint32_t meminfo
);
186 void qemu_plugin_flush_cb(void);
188 void qemu_plugin_atexit_cb(void);
190 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
);
192 void qemu_plugin_disable_mem_helpers(CPUState
*cpu
);
194 #else /* !CONFIG_PLUGIN */
196 static inline void qemu_plugin_add_opts(void)
199 static inline void qemu_plugin_opt_parse(const char *optarg
,
200 QemuPluginList
*head
)
202 error_report("plugin interface not enabled in this build");
206 static inline int qemu_plugin_load_list(QemuPluginList
*head
, Error
**errp
)
211 static inline void qemu_plugin_vcpu_init_hook(CPUState
*cpu
)
214 static inline void qemu_plugin_vcpu_exit_hook(CPUState
*cpu
)
217 static inline void qemu_plugin_tb_trans_cb(CPUState
*cpu
,
218 struct qemu_plugin_tb
*tb
)
221 static inline void qemu_plugin_vcpu_idle_cb(CPUState
*cpu
)
224 static inline void qemu_plugin_vcpu_resume_cb(CPUState
*cpu
)
228 qemu_plugin_vcpu_syscall(CPUState
*cpu
, int64_t num
, uint64_t a1
, uint64_t a2
,
229 uint64_t a3
, uint64_t a4
, uint64_t a5
, uint64_t a6
,
230 uint64_t a7
, uint64_t a8
)
234 void qemu_plugin_vcpu_syscall_ret(CPUState
*cpu
, int64_t num
, int64_t ret
)
237 static inline void qemu_plugin_vcpu_mem_cb(CPUState
*cpu
, uint64_t vaddr
,
241 static inline void qemu_plugin_flush_cb(void)
244 static inline void qemu_plugin_atexit_cb(void)
248 void qemu_plugin_add_dyn_cb_arr(GArray
*arr
)
251 static inline void qemu_plugin_disable_mem_helpers(CPUState
*cpu
)
254 #endif /* !CONFIG_PLUGIN */
256 #endif /* QEMU_PLUGIN_H */