1 /* 2 * Copyright (C) 2017, Emilio G. Cota <cota@braap.org> 3 * 4 * License: GNU GPL, version 2 or later. 5 * See the COPYING file in the top-level directory. 6 */ 7 #ifndef QEMU_PLUGIN_H 8 #define QEMU_PLUGIN_H 9 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" 15 #include "qemu/plugin-event.h" 16 #include "qemu/bitmap.h" 17 #include "exec/memopidx.h" 18 #include "hw/core/cpu.h" 19 20 /* 21 * Option parsing/processing. 22 * Note that we can load an arbitrary number of plugins. 23 */ 24 struct qemu_plugin_desc; 25 typedef QTAILQ_HEAD(, qemu_plugin_desc) QemuPluginList; 26 27 /* 28 * Construct a qemu_plugin_meminfo_t. 29 */ 30 static inline qemu_plugin_meminfo_t 31 make_plugin_meminfo(MemOpIdx oi, enum qemu_plugin_mem_rw rw) 32 { 33 return oi | (rw << 16); 34 } 35 36 /* 37 * Extract the memory operation direction from a qemu_plugin_meminfo_t. 38 * Other portions may be extracted via get_memop and get_mmuidx. 39 */ 40 static inline enum qemu_plugin_mem_rw 41 get_plugin_meminfo_rw(qemu_plugin_meminfo_t i) 42 { 43 return i >> 16; 44 } 45 46 #ifdef CONFIG_PLUGIN 47 extern QemuOptsList qemu_plugin_opts; 48 49 static inline void qemu_plugin_add_opts(void) 50 { 51 qemu_add_opts(&qemu_plugin_opts); 52 } 53 54 void qemu_plugin_opt_parse(const char *optstr, QemuPluginList *head); 55 int qemu_plugin_load_list(QemuPluginList *head, Error **errp); 56 57 union qemu_plugin_cb_sig { 58 qemu_plugin_simple_cb_t simple; 59 qemu_plugin_udata_cb_t udata; 60 qemu_plugin_vcpu_simple_cb_t vcpu_simple; 61 qemu_plugin_vcpu_udata_cb_t vcpu_udata; 62 qemu_plugin_vcpu_tb_trans_cb_t vcpu_tb_trans; 63 qemu_plugin_vcpu_mem_cb_t vcpu_mem; 64 qemu_plugin_vcpu_syscall_cb_t vcpu_syscall; 65 qemu_plugin_vcpu_syscall_ret_cb_t vcpu_syscall_ret; 66 void *generic; 67 }; 68 69 enum plugin_dyn_cb_type { 70 PLUGIN_CB_REGULAR, 71 PLUGIN_CB_COND, 72 PLUGIN_CB_MEM_REGULAR, 73 PLUGIN_CB_INLINE_ADD_U64, 74 PLUGIN_CB_INLINE_STORE_U64, 75 }; 76 77 struct qemu_plugin_regular_cb { 78 union qemu_plugin_cb_sig f; 79 TCGHelperInfo *info; 80 void *userp; 81 enum qemu_plugin_mem_rw rw; 82 }; 83 84 struct qemu_plugin_inline_cb { 85 qemu_plugin_u64 entry; 86 uint64_t imm; 87 enum qemu_plugin_mem_rw rw; 88 }; 89 90 struct qemu_plugin_conditional_cb { 91 union qemu_plugin_cb_sig f; 92 TCGHelperInfo *info; 93 void *userp; 94 qemu_plugin_u64 entry; 95 enum qemu_plugin_cond cond; 96 uint64_t imm; 97 }; 98 99 /* 100 * A dynamic callback has an insertion point that is determined at run-time. 101 * Usually the insertion point is somewhere in the code cache; think for 102 * instance of a callback to be called upon the execution of a particular TB. 103 */ 104 struct qemu_plugin_dyn_cb { 105 enum plugin_dyn_cb_type type; 106 union { 107 struct qemu_plugin_regular_cb regular; 108 struct qemu_plugin_conditional_cb cond; 109 struct qemu_plugin_inline_cb inline_insn; 110 }; 111 }; 112 113 /* Internal context for instrumenting an instruction */ 114 struct qemu_plugin_insn { 115 uint64_t vaddr; 116 GArray *insn_cbs; 117 GArray *mem_cbs; 118 uint8_t len; 119 bool calls_helpers; 120 121 /* if set, the instruction calls helpers that might access guest memory */ 122 bool mem_helper; 123 }; 124 125 /* A scoreboard is an array of values, indexed by vcpu_index */ 126 struct qemu_plugin_scoreboard { 127 GArray *data; 128 QLIST_ENTRY(qemu_plugin_scoreboard) entry; 129 }; 130 131 /* Internal context for this TranslationBlock */ 132 struct qemu_plugin_tb { 133 GPtrArray *insns; 134 size_t n; 135 136 /* if set, the TB calls helpers that might access guest memory */ 137 bool mem_helper; 138 139 GArray *cbs; 140 }; 141 142 /** 143 * struct CPUPluginState - per-CPU state for plugins 144 * @event_mask: plugin event bitmap. Modified only via async work. 145 */ 146 struct CPUPluginState { 147 DECLARE_BITMAP(event_mask, QEMU_PLUGIN_EV_MAX); 148 }; 149 150 /** 151 * qemu_plugin_create_vcpu_state: allocate plugin state 152 * 153 * The returned data must be released with g_free() 154 * when no longer required. 155 */ 156 CPUPluginState *qemu_plugin_create_vcpu_state(void); 157 158 void qemu_plugin_vcpu_init_hook(CPUState *cpu); 159 void qemu_plugin_vcpu_exit_hook(CPUState *cpu); 160 void qemu_plugin_tb_trans_cb(CPUState *cpu, struct qemu_plugin_tb *tb); 161 void qemu_plugin_vcpu_idle_cb(CPUState *cpu); 162 void qemu_plugin_vcpu_resume_cb(CPUState *cpu); 163 void 164 qemu_plugin_vcpu_syscall(CPUState *cpu, int64_t num, uint64_t a1, 165 uint64_t a2, uint64_t a3, uint64_t a4, uint64_t a5, 166 uint64_t a6, uint64_t a7, uint64_t a8); 167 void qemu_plugin_vcpu_syscall_ret(CPUState *cpu, int64_t num, int64_t ret); 168 169 void qemu_plugin_vcpu_mem_cb(CPUState *cpu, uint64_t vaddr, 170 uint64_t value_low, 171 uint64_t value_high, 172 MemOpIdx oi, enum qemu_plugin_mem_rw rw); 173 174 void qemu_plugin_flush_cb(void); 175 176 void qemu_plugin_atexit_cb(void); 177 178 void qemu_plugin_add_dyn_cb_arr(GArray *arr); 179 180 static inline void qemu_plugin_disable_mem_helpers(CPUState *cpu) 181 { 182 cpu->neg.plugin_mem_cbs = NULL; 183 } 184 185 /** 186 * qemu_plugin_user_exit(): clean-up callbacks before calling exit callbacks 187 * 188 * This is a user-mode only helper that ensure we have fully cleared 189 * callbacks from all threads before calling the exit callbacks. This 190 * is so the plugins themselves don't have to jump through hoops to 191 * guard against race conditions. 192 */ 193 void qemu_plugin_user_exit(void); 194 195 /** 196 * qemu_plugin_user_prefork_lock(): take plugin lock before forking 197 * 198 * This is a user-mode only helper to take the internal plugin lock 199 * before a fork event. This is ensure a consistent lock state 200 */ 201 void qemu_plugin_user_prefork_lock(void); 202 203 /** 204 * qemu_plugin_user_postfork(): reset the plugin lock 205 * @is_child: is this thread the child 206 * 207 * This user-mode only helper resets the lock state after a fork so we 208 * can continue using the plugin interface. 209 */ 210 void qemu_plugin_user_postfork(bool is_child); 211 212 #else /* !CONFIG_PLUGIN */ 213 214 static inline void qemu_plugin_add_opts(void) 215 { } 216 217 static inline void qemu_plugin_opt_parse(const char *optstr, 218 QemuPluginList *head) 219 { 220 error_report("plugin interface not enabled in this build"); 221 exit(1); 222 } 223 224 static inline int qemu_plugin_load_list(QemuPluginList *head, Error **errp) 225 { 226 return 0; 227 } 228 229 static inline void qemu_plugin_vcpu_init_hook(CPUState *cpu) 230 { } 231 232 static inline void qemu_plugin_vcpu_exit_hook(CPUState *cpu) 233 { } 234 235 static inline void qemu_plugin_tb_trans_cb(CPUState *cpu, 236 struct qemu_plugin_tb *tb) 237 { } 238 239 static inline void qemu_plugin_vcpu_idle_cb(CPUState *cpu) 240 { } 241 242 static inline void qemu_plugin_vcpu_resume_cb(CPUState *cpu) 243 { } 244 245 static inline void 246 qemu_plugin_vcpu_syscall(CPUState *cpu, int64_t num, uint64_t a1, uint64_t a2, 247 uint64_t a3, uint64_t a4, uint64_t a5, uint64_t a6, 248 uint64_t a7, uint64_t a8) 249 { } 250 251 static inline 252 void qemu_plugin_vcpu_syscall_ret(CPUState *cpu, int64_t num, int64_t ret) 253 { } 254 255 static inline void qemu_plugin_vcpu_mem_cb(CPUState *cpu, uint64_t vaddr, 256 uint64_t value_low, 257 uint64_t value_high, 258 MemOpIdx oi, 259 enum qemu_plugin_mem_rw rw) 260 { } 261 262 static inline void qemu_plugin_flush_cb(void) 263 { } 264 265 static inline void qemu_plugin_atexit_cb(void) 266 { } 267 268 static inline 269 void qemu_plugin_add_dyn_cb_arr(GArray *arr) 270 { } 271 272 static inline void qemu_plugin_disable_mem_helpers(CPUState *cpu) 273 { } 274 275 static inline void qemu_plugin_user_exit(void) 276 { } 277 278 static inline void qemu_plugin_user_prefork_lock(void) 279 { } 280 281 static inline void qemu_plugin_user_postfork(bool is_child) 282 { } 283 284 #endif /* !CONFIG_PLUGIN */ 285 286 #endif /* QEMU_PLUGIN_H */ 287