[libvirt PATCH v4 11/12] scripts: add systemtap script for capturing SEV-ES VMSA

[Daniel P. Berrangé]

In general we expect to be able to construct a SEV-ES VMSA
blob from knowledge about the AMD achitectural CPU register
defaults, KVM setup and QEMU setup. If any of this unexpectedly
changes, figuring out what's wrong could be horrible. This
systemtap script demonstrates how to capture the real VMSA
that is used for a SEV-ES as it is booted. The captured data
can be fed into the 'sevctl vmsa show' command in order to
produce formatted info with named registers, allowing a
'diff' to be performed.

This script will need updating for any kernel version that is
not 6.0, to set the correct line numbers.

Reviewed-by: Ján Tomko <jtomko at redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
---
 examples/systemtap/amd-sev-es-vmsa.stp | 48 ++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 examples/systemtap/amd-sev-es-vmsa.stp

diff --git a/examples/systemtap/amd-sev-es-vmsa.stp b/examples/systemtap/amd-sev-es-vmsa.stp
new file mode 100644
index 0000000000..551ed739b7
--- /dev/null
+++ b/examples/systemtap/amd-sev-es-vmsa.stp
@@ -0,0 +1,48 @@
+#!/usr/bin/stap
+#
+# Copyright (C) 2022 Red Hat, Inc.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library.  If not, see
+# <http://www.gnu.org/licenses/>.
+#
+# A script that captures the VMSA blob for the boot vCPU and
+# first additional vCPU, when a KVM guest is booted with SEV-ES
+#
+# The captured VMSA will be printed to the console in hex format,
+# and can be converted to the required binary format by feeding
+# it through
+#
+# perl -e 'while (<>) { print pack("C64", map { hex($_) } ( $_ =~ m/../g )); }' > vmsa.bin
+#
+
+probe begin {
+  printf("Running\n")
+}
+
+function dump_vmsa(addr:long) {
+  printf("VMSA\n")
+  for (i = 0; i < 4096 ; i+= 64) {
+    printf("%.64M\n", addr + i);
+  }
+}
+
+# This line number will need to be updated for the specific kernel
+# version that is being probed. The line that needs to be targetted
+# is the one beween the call to clflush_cache_range(...) and the
+# call to sev_issue_cmd(kvm, SEV_CMD_LAUNCH_UPDATE...).
+#
+# Line 632 is correct for Linux v6.0
+probe module("kvm_amd").statement("__sev_launch_update_vmsa at arch/x86/kvm/svm/sev.c:632") {
+  dump_vmsa($svm->vmsa)
+}
-- 
2.37.3