xref: /qemu/tests/tcg/plugins/inline.c (revision 544595e73007c824b7435b52519cc578586783a6)
1 /*
2  * Copyright (C) 2023, Pierrick Bouvier <pierrick.bouvier@linaro.org>
3  *
4  * Demonstrates and tests usage of inline ops.
5  *
6  * License: GNU GPL, version 2 or later.
7  *   See the COPYING file in the top-level directory.
8  */
9 
10 #include <glib.h>
11 #include <stdint.h>
12 #include <stdio.h>
13 
14 #include <qemu-plugin.h>
15 
16 typedef struct {
17     uint64_t count_tb;
18     uint64_t count_tb_inline;
19     uint64_t count_insn;
20     uint64_t count_insn_inline;
21     uint64_t count_mem;
22     uint64_t count_mem_inline;
23     uint64_t tb_cond_num_trigger;
24     uint64_t tb_cond_track_count;
25     uint64_t insn_cond_num_trigger;
26     uint64_t insn_cond_track_count;
27 } CPUCount;
28 
29 static const uint64_t cond_trigger_limit = 100;
30 
31 typedef struct {
32     uint64_t data_insn;
33     uint64_t data_tb;
34     uint64_t data_mem;
35 } CPUData;
36 
37 static struct qemu_plugin_scoreboard *counts;
38 static qemu_plugin_u64 count_tb;
39 static qemu_plugin_u64 count_tb_inline;
40 static qemu_plugin_u64 count_insn;
41 static qemu_plugin_u64 count_insn_inline;
42 static qemu_plugin_u64 count_mem;
43 static qemu_plugin_u64 count_mem_inline;
44 static qemu_plugin_u64 tb_cond_num_trigger;
45 static qemu_plugin_u64 tb_cond_track_count;
46 static qemu_plugin_u64 insn_cond_num_trigger;
47 static qemu_plugin_u64 insn_cond_track_count;
48 static struct qemu_plugin_scoreboard *data;
49 static qemu_plugin_u64 data_insn;
50 static qemu_plugin_u64 data_tb;
51 static qemu_plugin_u64 data_mem;
52 
53 static uint64_t global_count_tb;
54 static uint64_t global_count_insn;
55 static uint64_t global_count_mem;
56 static unsigned int max_cpu_index;
57 static GMutex tb_lock;
58 static GMutex insn_lock;
59 static GMutex mem_lock;
60 
61 QEMU_PLUGIN_EXPORT int qemu_plugin_version = QEMU_PLUGIN_VERSION;
62 
63 static void stats_insn(void)
64 {
65     const uint64_t expected = global_count_insn;
66     const uint64_t per_vcpu = qemu_plugin_u64_sum(count_insn);
67     const uint64_t inl_per_vcpu =
68         qemu_plugin_u64_sum(count_insn_inline);
69     const uint64_t cond_num_trigger =
70         qemu_plugin_u64_sum(insn_cond_num_trigger);
71     const uint64_t cond_track_left = qemu_plugin_u64_sum(insn_cond_track_count);
72     const uint64_t conditional =
73         cond_num_trigger * cond_trigger_limit + cond_track_left;
74     printf("insn: %" PRIu64 "\n", expected);
75     printf("insn: %" PRIu64 " (per vcpu)\n", per_vcpu);
76     printf("insn: %" PRIu64 " (per vcpu inline)\n", inl_per_vcpu);
77     printf("insn: %" PRIu64 " (cond cb)\n", conditional);
78     g_assert(expected > 0);
79     g_assert(per_vcpu == expected);
80     g_assert(inl_per_vcpu == expected);
81     g_assert(conditional == expected);
82 }
83 
84 static void stats_tb(void)
85 {
86     const uint64_t expected = global_count_tb;
87     const uint64_t per_vcpu = qemu_plugin_u64_sum(count_tb);
88     const uint64_t inl_per_vcpu =
89         qemu_plugin_u64_sum(count_tb_inline);
90     const uint64_t cond_num_trigger = qemu_plugin_u64_sum(tb_cond_num_trigger);
91     const uint64_t cond_track_left = qemu_plugin_u64_sum(tb_cond_track_count);
92     const uint64_t conditional =
93         cond_num_trigger * cond_trigger_limit + cond_track_left;
94     printf("tb: %" PRIu64 "\n", expected);
95     printf("tb: %" PRIu64 " (per vcpu)\n", per_vcpu);
96     printf("tb: %" PRIu64 " (per vcpu inline)\n", inl_per_vcpu);
97     printf("tb: %" PRIu64 " (conditional cb)\n", conditional);
98     g_assert(expected > 0);
99     g_assert(per_vcpu == expected);
100     g_assert(inl_per_vcpu == expected);
101     g_assert(conditional == expected);
102 }
103 
104 static void stats_mem(void)
105 {
106     const uint64_t expected = global_count_mem;
107     const uint64_t per_vcpu = qemu_plugin_u64_sum(count_mem);
108     const uint64_t inl_per_vcpu =
109         qemu_plugin_u64_sum(count_mem_inline);
110     printf("mem: %" PRIu64 "\n", expected);
111     printf("mem: %" PRIu64 " (per vcpu)\n", per_vcpu);
112     printf("mem: %" PRIu64 " (per vcpu inline)\n", inl_per_vcpu);
113     g_assert(expected > 0);
114     g_assert(per_vcpu == expected);
115     g_assert(inl_per_vcpu == expected);
116 }
117 
118 static void plugin_exit(qemu_plugin_id_t id, void *udata)
119 {
120     const unsigned int num_cpus = qemu_plugin_num_vcpus();
121     g_assert(num_cpus == max_cpu_index + 1);
122 
123     for (int i = 0; i < num_cpus ; ++i) {
124         const uint64_t tb = qemu_plugin_u64_get(count_tb, i);
125         const uint64_t tb_inline = qemu_plugin_u64_get(count_tb_inline, i);
126         const uint64_t insn = qemu_plugin_u64_get(count_insn, i);
127         const uint64_t insn_inline = qemu_plugin_u64_get(count_insn_inline, i);
128         const uint64_t mem = qemu_plugin_u64_get(count_mem, i);
129         const uint64_t mem_inline = qemu_plugin_u64_get(count_mem_inline, i);
130         const uint64_t tb_cond_trigger =
131             qemu_plugin_u64_get(tb_cond_num_trigger, i);
132         const uint64_t tb_cond_left =
133             qemu_plugin_u64_get(tb_cond_track_count, i);
134         const uint64_t insn_cond_trigger =
135             qemu_plugin_u64_get(insn_cond_num_trigger, i);
136         const uint64_t insn_cond_left =
137             qemu_plugin_u64_get(insn_cond_track_count, i);
138         printf("cpu %d: tb (%" PRIu64 ", %" PRIu64
139                ", %" PRIu64 " * %" PRIu64 " + %" PRIu64
140                ") | "
141                "insn (%" PRIu64 ", %" PRIu64
142                ", %" PRIu64 " * %" PRIu64 " + %" PRIu64
143                ") | "
144                "mem (%" PRIu64 ", %" PRIu64 ")"
145                "\n",
146                i,
147                tb, tb_inline,
148                tb_cond_trigger, cond_trigger_limit, tb_cond_left,
149                insn, insn_inline,
150                insn_cond_trigger, cond_trigger_limit, insn_cond_left,
151                mem, mem_inline);
152         g_assert(tb == tb_inline);
153         g_assert(insn == insn_inline);
154         g_assert(mem == mem_inline);
155         g_assert(tb_cond_trigger == tb / cond_trigger_limit);
156         g_assert(tb_cond_left == tb % cond_trigger_limit);
157         g_assert(insn_cond_trigger == insn / cond_trigger_limit);
158         g_assert(insn_cond_left == insn % cond_trigger_limit);
159     }
160 
161     stats_tb();
162     stats_insn();
163     stats_mem();
164 
165     qemu_plugin_scoreboard_free(counts);
166     qemu_plugin_scoreboard_free(data);
167 }
168 
169 static void vcpu_tb_exec(unsigned int cpu_index, void *udata)
170 {
171     qemu_plugin_u64_add(count_tb, cpu_index, 1);
172     g_assert(qemu_plugin_u64_get(data_tb, cpu_index) == (uintptr_t) udata);
173     g_mutex_lock(&tb_lock);
174     max_cpu_index = MAX(max_cpu_index, cpu_index);
175     global_count_tb++;
176     g_mutex_unlock(&tb_lock);
177 }
178 
179 static void vcpu_tb_cond_exec(unsigned int cpu_index, void *udata)
180 {
181     g_assert(qemu_plugin_u64_get(tb_cond_track_count, cpu_index) ==
182              cond_trigger_limit);
183     g_assert(qemu_plugin_u64_get(data_tb, cpu_index) == (uintptr_t) udata);
184     qemu_plugin_u64_set(tb_cond_track_count, cpu_index, 0);
185     qemu_plugin_u64_add(tb_cond_num_trigger, cpu_index, 1);
186 }
187 
188 static void vcpu_insn_cond_exec(unsigned int cpu_index, void *udata)
189 {
190     g_assert(qemu_plugin_u64_get(insn_cond_track_count, cpu_index) ==
191              cond_trigger_limit);
192     g_assert(qemu_plugin_u64_get(data_insn, cpu_index) == (uintptr_t) udata);
193     qemu_plugin_u64_set(insn_cond_track_count, cpu_index, 0);
194     qemu_plugin_u64_add(insn_cond_num_trigger, cpu_index, 1);
195 }
196 
197 static void vcpu_insn_exec(unsigned int cpu_index, void *udata)
198 {
199     qemu_plugin_u64_add(count_insn, cpu_index, 1);
200     g_assert(qemu_plugin_u64_get(data_insn, cpu_index) == (uintptr_t) udata);
201     g_mutex_lock(&insn_lock);
202     global_count_insn++;
203     g_mutex_unlock(&insn_lock);
204 }
205 
206 static void vcpu_mem_access(unsigned int cpu_index,
207                             qemu_plugin_meminfo_t info,
208                             uint64_t vaddr,
209                             void *udata)
210 {
211     qemu_plugin_u64_add(count_mem, cpu_index, 1);
212     g_assert(qemu_plugin_u64_get(data_mem, cpu_index) == (uintptr_t) udata);
213     g_mutex_lock(&mem_lock);
214     global_count_mem++;
215     g_mutex_unlock(&mem_lock);
216 }
217 
218 static void vcpu_tb_trans(qemu_plugin_id_t id, struct qemu_plugin_tb *tb)
219 {
220     void *tb_store = tb;
221     qemu_plugin_register_vcpu_tb_exec_inline_per_vcpu(
222         tb, QEMU_PLUGIN_INLINE_STORE_U64, data_tb, (uintptr_t) tb_store);
223     qemu_plugin_register_vcpu_tb_exec_cb(
224         tb, vcpu_tb_exec, QEMU_PLUGIN_CB_NO_REGS, tb_store);
225     qemu_plugin_register_vcpu_tb_exec_inline_per_vcpu(
226         tb, QEMU_PLUGIN_INLINE_ADD_U64, count_tb_inline, 1);
227 
228     qemu_plugin_register_vcpu_tb_exec_inline_per_vcpu(
229         tb, QEMU_PLUGIN_INLINE_ADD_U64, tb_cond_track_count, 1);
230     qemu_plugin_register_vcpu_tb_exec_cond_cb(
231         tb, vcpu_tb_cond_exec, QEMU_PLUGIN_CB_NO_REGS,
232         QEMU_PLUGIN_COND_EQ, tb_cond_track_count, cond_trigger_limit, tb_store);
233 
234     for (int idx = 0; idx < qemu_plugin_tb_n_insns(tb); ++idx) {
235         struct qemu_plugin_insn *insn = qemu_plugin_tb_get_insn(tb, idx);
236         void *insn_store = insn;
237         void *mem_store = (char *)insn_store + 0xff;
238 
239         qemu_plugin_register_vcpu_insn_exec_inline_per_vcpu(
240             insn, QEMU_PLUGIN_INLINE_STORE_U64, data_insn,
241             (uintptr_t) insn_store);
242         qemu_plugin_register_vcpu_insn_exec_cb(
243             insn, vcpu_insn_exec, QEMU_PLUGIN_CB_NO_REGS, insn_store);
244         qemu_plugin_register_vcpu_insn_exec_inline_per_vcpu(
245             insn, QEMU_PLUGIN_INLINE_ADD_U64, count_insn_inline, 1);
246 
247         qemu_plugin_register_vcpu_insn_exec_inline_per_vcpu(
248             insn, QEMU_PLUGIN_INLINE_ADD_U64, insn_cond_track_count, 1);
249         qemu_plugin_register_vcpu_insn_exec_cond_cb(
250             insn, vcpu_insn_cond_exec, QEMU_PLUGIN_CB_NO_REGS,
251             QEMU_PLUGIN_COND_EQ, insn_cond_track_count, cond_trigger_limit,
252             insn_store);
253 
254         qemu_plugin_register_vcpu_mem_inline_per_vcpu(
255             insn, QEMU_PLUGIN_MEM_RW,
256             QEMU_PLUGIN_INLINE_STORE_U64,
257             data_mem, (uintptr_t) mem_store);
258         qemu_plugin_register_vcpu_mem_cb(insn, &vcpu_mem_access,
259                                          QEMU_PLUGIN_CB_NO_REGS,
260                                          QEMU_PLUGIN_MEM_RW, mem_store);
261         qemu_plugin_register_vcpu_mem_inline_per_vcpu(
262             insn, QEMU_PLUGIN_MEM_RW,
263             QEMU_PLUGIN_INLINE_ADD_U64,
264             count_mem_inline, 1);
265     }
266 }
267 
268 QEMU_PLUGIN_EXPORT
269 int qemu_plugin_install(qemu_plugin_id_t id, const qemu_info_t *info,
270                         int argc, char **argv)
271 {
272     counts = qemu_plugin_scoreboard_new(sizeof(CPUCount));
273     count_tb = qemu_plugin_scoreboard_u64_in_struct(
274         counts, CPUCount, count_tb);
275     count_insn = qemu_plugin_scoreboard_u64_in_struct(
276         counts, CPUCount, count_insn);
277     count_mem = qemu_plugin_scoreboard_u64_in_struct(
278         counts, CPUCount, count_mem);
279     count_tb_inline = qemu_plugin_scoreboard_u64_in_struct(
280         counts, CPUCount, count_tb_inline);
281     count_insn_inline = qemu_plugin_scoreboard_u64_in_struct(
282         counts, CPUCount, count_insn_inline);
283     count_mem_inline = qemu_plugin_scoreboard_u64_in_struct(
284         counts, CPUCount, count_mem_inline);
285     tb_cond_num_trigger = qemu_plugin_scoreboard_u64_in_struct(
286         counts, CPUCount, tb_cond_num_trigger);
287     tb_cond_track_count = qemu_plugin_scoreboard_u64_in_struct(
288         counts, CPUCount, tb_cond_track_count);
289     insn_cond_num_trigger = qemu_plugin_scoreboard_u64_in_struct(
290         counts, CPUCount, insn_cond_num_trigger);
291     insn_cond_track_count = qemu_plugin_scoreboard_u64_in_struct(
292         counts, CPUCount, insn_cond_track_count);
293     data = qemu_plugin_scoreboard_new(sizeof(CPUData));
294     data_insn = qemu_plugin_scoreboard_u64_in_struct(data, CPUData, data_insn);
295     data_tb = qemu_plugin_scoreboard_u64_in_struct(data, CPUData, data_tb);
296     data_mem = qemu_plugin_scoreboard_u64_in_struct(data, CPUData, data_mem);
297 
298     qemu_plugin_register_vcpu_tb_trans_cb(id, vcpu_tb_trans);
299     qemu_plugin_register_atexit_cb(id, plugin_exit, NULL);
300 
301     return 0;
302 }
303