xref: /linux/arch/x86/kvm/mmu/mmutrace.h (revision 2ed2e359dea752e7758d29a423033031a0b96584)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #if !defined(_TRACE_KVMMMU_H) || defined(TRACE_HEADER_MULTI_READ)
3 #define _TRACE_KVMMMU_H
4 
5 #include <linux/tracepoint.h>
6 #include <linux/trace_events.h>
7 
8 #undef TRACE_SYSTEM
9 #define TRACE_SYSTEM kvmmmu
10 
11 #define KVM_MMU_PAGE_FIELDS		\
12 	__field(__u8, mmu_valid_gen)	\
13 	__field(__u64, gfn)		\
14 	__field(__u32, role)		\
15 	__field(__u32, root_count)	\
16 	__field(bool, unsync)
17 
18 #define KVM_MMU_PAGE_ASSIGN(sp)				\
19 	__entry->mmu_valid_gen = sp->mmu_valid_gen;	\
20 	__entry->gfn = sp->gfn;				\
21 	__entry->role = sp->role.word;			\
22 	__entry->root_count = sp->root_count;		\
23 	__entry->unsync = sp->unsync;
24 
25 #define KVM_MMU_PAGE_PRINTK() ({				        \
26 	const char *saved_ptr = trace_seq_buffer_ptr(p);		\
27 	static const char *access_str[] = {			        \
28 		"----", "r---", "-w--", "rw--", "--u-", "r-u-", "-wu-", "rwu-", \
29 		"---x", "r--x", "-w-x", "rw-x", "--ux", "r-ux", "-wux", "rwux"	\
30 	};							        \
31 	union kvm_mmu_page_role role;				        \
32 								        \
33 	role.word = __entry->role;					\
34 									\
35 	trace_seq_printf(p, "sp gen %u gfn %llx l%u %u-byte q%u%s %s%s"	\
36 			 " %snxe %sad root %u %s%c",			\
37 			 __entry->mmu_valid_gen,			\
38 			 __entry->gfn, role.level,			\
39 			 role.has_4_byte_gpte ? 4 : 8,			\
40 			 role.quadrant,					\
41 			 role.direct ? " direct" : "",			\
42 			 access_str[role.access],			\
43 			 role.invalid ? " invalid" : "",		\
44 			 role.efer_nx ? "" : "!",			\
45 			 role.ad_disabled ? "!" : "",			\
46 			 __entry->root_count,				\
47 			 __entry->unsync ? "unsync" : "sync", 0);	\
48 	saved_ptr;							\
49 		})
50 
51 #define kvm_mmu_trace_pferr_flags       \
52 	{ PFERR_PRESENT_MASK, "P" },	\
53 	{ PFERR_WRITE_MASK, "W" },	\
54 	{ PFERR_USER_MASK, "U" },	\
55 	{ PFERR_PK_MASK, "PK" },	\
56 	{ PFERR_SS_MASK, "SS" },	\
57 	{ PFERR_SGX_MASK, "SGX" },	\
58 	{ PFERR_RSVD_MASK, "RSVD" },	\
59 	{ PFERR_FETCH_MASK, "F" }
60 
61 TRACE_DEFINE_ENUM(RET_PF_CONTINUE);
62 TRACE_DEFINE_ENUM(RET_PF_RETRY);
63 TRACE_DEFINE_ENUM(RET_PF_EMULATE);
64 TRACE_DEFINE_ENUM(RET_PF_WRITE_PROTECTED);
65 TRACE_DEFINE_ENUM(RET_PF_INVALID);
66 TRACE_DEFINE_ENUM(RET_PF_FIXED);
67 TRACE_DEFINE_ENUM(RET_PF_SPURIOUS);
68 
69 /*
70  * A pagetable walk has started
71  */
72 TRACE_EVENT(
73 	kvm_mmu_pagetable_walk,
74 	TP_PROTO(u64 addr, u32 pferr),
75 	TP_ARGS(addr, pferr),
76 
77 	TP_STRUCT__entry(
78 		__field(__u64, addr)
79 		__field(__u32, pferr)
80 	),
81 
82 	TP_fast_assign(
83 		__entry->addr = addr;
84 		__entry->pferr = pferr;
85 	),
86 
87 	TP_printk("addr %llx pferr %x %s", __entry->addr, __entry->pferr,
88 		  __print_flags(__entry->pferr, "|", kvm_mmu_trace_pferr_flags))
89 );
90 
91 
92 /* We just walked a paging element */
93 TRACE_EVENT(
94 	kvm_mmu_paging_element,
95 	TP_PROTO(u64 pte, int level),
96 	TP_ARGS(pte, level),
97 
98 	TP_STRUCT__entry(
99 		__field(__u64, pte)
100 		__field(__u32, level)
101 		),
102 
103 	TP_fast_assign(
104 		__entry->pte = pte;
105 		__entry->level = level;
106 		),
107 
108 	TP_printk("pte %llx level %u", __entry->pte, __entry->level)
109 );
110 
111 DECLARE_EVENT_CLASS(kvm_mmu_set_bit_class,
112 
113 	TP_PROTO(unsigned long table_gfn, unsigned index, unsigned size),
114 
115 	TP_ARGS(table_gfn, index, size),
116 
117 	TP_STRUCT__entry(
118 		__field(__u64, gpa)
119 	),
120 
121 	TP_fast_assign(
122 		__entry->gpa = ((u64)table_gfn << PAGE_SHIFT)
123 				+ index * size;
124 		),
125 
126 	TP_printk("gpa %llx", __entry->gpa)
127 );
128 
129 /* We set a pte accessed bit */
130 DEFINE_EVENT(kvm_mmu_set_bit_class, kvm_mmu_set_accessed_bit,
131 
132 	TP_PROTO(unsigned long table_gfn, unsigned index, unsigned size),
133 
134 	TP_ARGS(table_gfn, index, size)
135 );
136 
137 /* We set a pte dirty bit */
138 DEFINE_EVENT(kvm_mmu_set_bit_class, kvm_mmu_set_dirty_bit,
139 
140 	TP_PROTO(unsigned long table_gfn, unsigned index, unsigned size),
141 
142 	TP_ARGS(table_gfn, index, size)
143 );
144 
145 TRACE_EVENT(
146 	kvm_mmu_walker_error,
147 	TP_PROTO(u32 pferr),
148 	TP_ARGS(pferr),
149 
150 	TP_STRUCT__entry(
151 		__field(__u32, pferr)
152 		),
153 
154 	TP_fast_assign(
155 		__entry->pferr = pferr;
156 		),
157 
158 	TP_printk("pferr %x %s", __entry->pferr,
159 		  __print_flags(__entry->pferr, "|", kvm_mmu_trace_pferr_flags))
160 );
161 
162 TRACE_EVENT(
163 	kvm_mmu_get_page,
164 	TP_PROTO(struct kvm_mmu_page *sp, bool created),
165 	TP_ARGS(sp, created),
166 
167 	TP_STRUCT__entry(
168 		KVM_MMU_PAGE_FIELDS
169 		__field(bool, created)
170 		),
171 
172 	TP_fast_assign(
173 		KVM_MMU_PAGE_ASSIGN(sp)
174 		__entry->created = created;
175 		),
176 
177 	TP_printk("%s %s", KVM_MMU_PAGE_PRINTK(),
178 		  __entry->created ? "new" : "existing")
179 );
180 
181 DECLARE_EVENT_CLASS(kvm_mmu_page_class,
182 
183 	TP_PROTO(struct kvm_mmu_page *sp),
184 	TP_ARGS(sp),
185 
186 	TP_STRUCT__entry(
187 		KVM_MMU_PAGE_FIELDS
188 	),
189 
190 	TP_fast_assign(
191 		KVM_MMU_PAGE_ASSIGN(sp)
192 	),
193 
194 	TP_printk("%s", KVM_MMU_PAGE_PRINTK())
195 );
196 
197 DEFINE_EVENT(kvm_mmu_page_class, kvm_mmu_sync_page,
198 	TP_PROTO(struct kvm_mmu_page *sp),
199 
200 	TP_ARGS(sp)
201 );
202 
203 DEFINE_EVENT(kvm_mmu_page_class, kvm_mmu_unsync_page,
204 	TP_PROTO(struct kvm_mmu_page *sp),
205 
206 	TP_ARGS(sp)
207 );
208 
209 DEFINE_EVENT(kvm_mmu_page_class, kvm_mmu_prepare_zap_page,
210 	TP_PROTO(struct kvm_mmu_page *sp),
211 
212 	TP_ARGS(sp)
213 );
214 
215 TRACE_EVENT(
216 	mark_mmio_spte,
217 	TP_PROTO(u64 *sptep, gfn_t gfn, u64 spte),
218 	TP_ARGS(sptep, gfn, spte),
219 
220 	TP_STRUCT__entry(
221 		__field(void *, sptep)
222 		__field(gfn_t, gfn)
223 		__field(unsigned, access)
224 		__field(unsigned int, gen)
225 	),
226 
227 	TP_fast_assign(
228 		__entry->sptep = sptep;
229 		__entry->gfn = gfn;
230 		__entry->access = spte & ACC_ALL;
231 		__entry->gen = get_mmio_spte_generation(spte);
232 	),
233 
234 	TP_printk("sptep:%p gfn %llx access %x gen %x", __entry->sptep,
235 		  __entry->gfn, __entry->access, __entry->gen)
236 );
237 
238 TRACE_EVENT(
239 	handle_mmio_page_fault,
240 	TP_PROTO(u64 addr, gfn_t gfn, unsigned access),
241 	TP_ARGS(addr, gfn, access),
242 
243 	TP_STRUCT__entry(
244 		__field(u64, addr)
245 		__field(gfn_t, gfn)
246 		__field(unsigned, access)
247 	),
248 
249 	TP_fast_assign(
250 		__entry->addr = addr;
251 		__entry->gfn = gfn;
252 		__entry->access = access;
253 	),
254 
255 	TP_printk("addr:%llx gfn %llx access %x", __entry->addr, __entry->gfn,
256 		  __entry->access)
257 );
258 
259 TRACE_EVENT(
260 	fast_page_fault,
261 	TP_PROTO(struct kvm_vcpu *vcpu, struct kvm_page_fault *fault,
262 		 u64 *sptep, u64 old_spte, int ret),
263 	TP_ARGS(vcpu, fault, sptep, old_spte, ret),
264 
265 	TP_STRUCT__entry(
266 		__field(int, vcpu_id)
267 		__field(gpa_t, cr2_or_gpa)
268 		__field(u64, error_code)
269 		__field(u64 *, sptep)
270 		__field(u64, old_spte)
271 		__field(u64, new_spte)
272 		__field(int, ret)
273 	),
274 
275 	TP_fast_assign(
276 		__entry->vcpu_id = vcpu->vcpu_id;
277 		__entry->cr2_or_gpa = fault->addr;
278 		__entry->error_code = fault->error_code;
279 		__entry->sptep = sptep;
280 		__entry->old_spte = old_spte;
281 		__entry->new_spte = *sptep;
282 		__entry->ret = ret;
283 	),
284 
285 	TP_printk("vcpu %d gva %llx error_code %s sptep %p old %#llx"
286 		  " new %llx spurious %d fixed %d", __entry->vcpu_id,
287 		  __entry->cr2_or_gpa, __print_flags(__entry->error_code, "|",
288 		  kvm_mmu_trace_pferr_flags), __entry->sptep,
289 		  __entry->old_spte, __entry->new_spte,
290 		  __entry->ret == RET_PF_SPURIOUS, __entry->ret == RET_PF_FIXED
291 	)
292 );
293 
294 TRACE_EVENT(
295 	kvm_mmu_zap_all_fast,
296 	TP_PROTO(struct kvm *kvm),
297 	TP_ARGS(kvm),
298 
299 	TP_STRUCT__entry(
300 		__field(__u8, mmu_valid_gen)
301 		__field(unsigned int, mmu_used_pages)
302 	),
303 
304 	TP_fast_assign(
305 		__entry->mmu_valid_gen = kvm->arch.mmu_valid_gen;
306 		__entry->mmu_used_pages = kvm->stat.mmu_shadow_pages;
307 	),
308 
309 	TP_printk("kvm-mmu-valid-gen %u used_pages %x",
310 		  __entry->mmu_valid_gen, __entry->mmu_used_pages
311 	)
312 );
313 
314 
315 TRACE_EVENT(
316 	check_mmio_spte,
317 	TP_PROTO(u64 spte, unsigned int kvm_gen, unsigned int spte_gen),
318 	TP_ARGS(spte, kvm_gen, spte_gen),
319 
320 	TP_STRUCT__entry(
321 		__field(unsigned int, kvm_gen)
322 		__field(unsigned int, spte_gen)
323 		__field(u64, spte)
324 	),
325 
326 	TP_fast_assign(
327 		__entry->kvm_gen = kvm_gen;
328 		__entry->spte_gen = spte_gen;
329 		__entry->spte = spte;
330 	),
331 
332 	TP_printk("spte %llx kvm_gen %x spte-gen %x valid %d", __entry->spte,
333 		  __entry->kvm_gen, __entry->spte_gen,
334 		  __entry->kvm_gen == __entry->spte_gen
335 	)
336 );
337 
338 TRACE_EVENT(
339 	kvm_mmu_set_spte,
340 	TP_PROTO(int level, gfn_t gfn, u64 *sptep),
341 	TP_ARGS(level, gfn, sptep),
342 
343 	TP_STRUCT__entry(
344 		__field(u64, gfn)
345 		__field(u64, spte)
346 		__field(u64, sptep)
347 		__field(u8, level)
348 		/* These depend on page entry type, so compute them now.  */
349 		__field(bool, r)
350 		__field(bool, x)
351 		__field(signed char, u)
352 	),
353 
354 	TP_fast_assign(
355 		__entry->gfn = gfn;
356 		__entry->spte = *sptep;
357 		__entry->sptep = virt_to_phys(sptep);
358 		__entry->level = level;
359 		__entry->r = shadow_present_mask || (__entry->spte & PT_PRESENT_MASK);
360 		__entry->x = (__entry->spte & (shadow_xs_mask | shadow_nx_mask)) == shadow_xs_mask;
361 		__entry->u = !!(__entry->spte & (shadow_xu_mask | shadow_user_mask));
362 	),
363 
364 	TP_printk("gfn %llx spte %llx (%s%s%s%s) level %d at %llx",
365 		  __entry->gfn, __entry->spte,
366 		  __entry->r ? "r" : "-",
367 		  __entry->spte & PT_WRITABLE_MASK ? "w" : "-",
368 		  __entry->x ? "x" : "-",
369 		  __entry->u ? "u" : "-",
370 		  __entry->level, __entry->sptep
371 	)
372 );
373 
374 TRACE_EVENT(
375 	kvm_mmu_spte_requested,
376 	TP_PROTO(struct kvm_page_fault *fault, u8 access),
377 	TP_ARGS(fault, access),
378 
379 	TP_STRUCT__entry(
380 		__field(u64, gfn)
381 		__field(u64, pfn)
382 		__field(u8, level)
383 		__field(u8, access)
384 	),
385 
386 	TP_fast_assign(
387 		__entry->gfn = fault->gfn;
388 		__entry->pfn = fault->pfn | (fault->gfn & (KVM_PAGES_PER_HPAGE(fault->goal_level) - 1));
389 		__entry->level = fault->goal_level;
390 		__entry->access = access;
391 	),
392 
393 	TP_printk("gfn %llx pfn %llx level %d access %x",
394 		  __entry->gfn, __entry->pfn, __entry->level, __entry->access
395 	)
396 );
397 
398 TRACE_EVENT(
399 	kvm_tdp_mmu_spte_changed,
400 	TP_PROTO(int as_id, gfn_t gfn, int level, u64 old_spte, u64 new_spte),
401 	TP_ARGS(as_id, gfn, level, old_spte, new_spte),
402 
403 	TP_STRUCT__entry(
404 		__field(u64, gfn)
405 		__field(u64, old_spte)
406 		__field(u64, new_spte)
407 		/* Level cannot be larger than 5 on x86, so it fits in a u8. */
408 		__field(u8, level)
409 		/* as_id can only be 0 or 1 x86, so it fits in a u8. */
410 		__field(u8, as_id)
411 	),
412 
413 	TP_fast_assign(
414 		__entry->gfn = gfn;
415 		__entry->old_spte = old_spte;
416 		__entry->new_spte = new_spte;
417 		__entry->level = level;
418 		__entry->as_id = as_id;
419 	),
420 
421 	TP_printk("as id %d gfn %llx level %d old_spte %llx new_spte %llx",
422 		  __entry->as_id, __entry->gfn, __entry->level,
423 		  __entry->old_spte, __entry->new_spte
424 	)
425 );
426 
427 TRACE_EVENT(
428 	kvm_mmu_split_huge_page,
429 	TP_PROTO(u64 gfn, u64 spte, int level, int errno),
430 	TP_ARGS(gfn, spte, level, errno),
431 
432 	TP_STRUCT__entry(
433 		__field(u64, gfn)
434 		__field(u64, spte)
435 		__field(int, level)
436 		__field(int, errno)
437 	),
438 
439 	TP_fast_assign(
440 		__entry->gfn = gfn;
441 		__entry->spte = spte;
442 		__entry->level = level;
443 		__entry->errno = errno;
444 	),
445 
446 	TP_printk("gfn %llx spte %llx level %d errno %d",
447 		  __entry->gfn, __entry->spte, __entry->level, __entry->errno)
448 );
449 
450 #endif /* _TRACE_KVMMMU_H */
451 
452 #undef TRACE_INCLUDE_PATH
453 #define TRACE_INCLUDE_PATH mmu
454 #undef TRACE_INCLUDE_FILE
455 #define TRACE_INCLUDE_FILE mmutrace
456 
457 /* This part must be outside protection */
458 #include <trace/define_trace.h>
459