[PATCH v4 6/8] x86/virt/tdx: Print TDX module version

Kai Huang
2024-09-24T11:29:30Z

Currently the kernel doesn't print any TDX module version information.
In practice such information is useful, especially to the developers.

For instance:

1) When something goes wrong around using TDX, the module version is
normally the first information the users want to know [1].

2) After initializing TDX module, the users want to quickly know module
version to see whether the loaded module is the expected one.

Dump TDX module version. The actual dmesg will look like:

virt/tdx: Initializing TDX module: 1.5.00.00.0481 (build_date 20230323).

And dump right after reading global metadata, so that this information is
printed no matter whether module initialization fails or not.

Link: https://lore.kernel.org/lkml/4b3adb59-50ea-419e-ad02-e19e8ca20dee@intel.com/ [1]
Signed-off-by: Kai Huang <kai.huang@intel.com>
---
v3 -> v4:
- Omit dumping TDX_FEATURES0 - Dan.
- As a result, move TDX_FEATURES0 related code out to NO_MOD_RBP patch.
- Update changelog accordingly.
- Simplify changelog for the use case 2).
- Use permalink - Dan.

v2 -> v3:
- 'struct tdx_sysinfo_module_info' -> 'struct tdx_sys_info_features'
- 'struct tdx_sysinfo_module_version' -> 'struct tdx_sys_info_version'
- Remove the 'sys_attributes' and the check of debug/production module.

https://lore.kernel.org/kvm/cover.1721186590.git.kai.huang@intel.com/T/#md73dd9b02a492acf4a6facae63e8d030e320967d

---
arch/x86/virt/vmx/tdx/tdx.c | 51 +++++++++++++++++++++++++++++++++++++
arch/x86/virt/vmx/tdx/tdx.h | 20 ++++++++++++++-
2 files changed, 70 insertions(+), 1 deletion(-)

diff --git a/arch/x86/virt/vmx/tdx/tdx.c b/arch/x86/virt/vmx/tdx/tdx.c
index 44ef74d1fafb..d599aaaa2730 100644
--- a/arch/x86/virt/vmx/tdx/tdx.c
+++ b/arch/x86/virt/vmx/tdx/tdx.c
@@ -286,6 +286,7 @@ static int __read_sys_metadata_field##_size(u64 field_id, u##_size *val) \
}

build_sysmd_read(16)
+build_sysmd_read(32)

#define read_sys_metadata_field(_field_id, _val, _size) \
({ \
@@ -295,6 +296,26 @@ build_sysmd_read(16)
__read_sys_metadata_field##_size(_field_id, _val); \
})

+static int get_tdx_sys_info_version(struct tdx_sys_info_version *sysinfo_version)
+{
+ int ret = 0;
+
+#define READ_SYS_INFO(_field_id, _member, _size) \
+ ret = ret ?: read_sys_metadata_field(MD_FIELD_ID_##_field_id, \
+ &sysinfo_version->_member, _size)
+
+ READ_SYS_INFO(MAJOR_VERSION, major, 16);
+ READ_SYS_INFO(MINOR_VERSION, minor, 16);
+ READ_SYS_INFO(UPDATE_VERSION, update, 16);
+ READ_SYS_INFO(INTERNAL_VERSION, internal, 16);
+ READ_SYS_INFO(BUILD_NUM, build_num, 16);
+ READ_SYS_INFO(BUILD_DATE, build_date, 32);
+
+#undef READ_SYS_INFO
+
+ return ret;
+}
+
static int get_tdx_sys_info_tdmr(struct tdx_sys_info_tdmr *sysinfo_tdmr)
{
int ret = 0;
@@ -316,9 +337,37 @@ static int get_tdx_sys_info_tdmr(struct tdx_sys_info_tdmr *sysinfo_tdmr)

static int get_tdx_sys_info(struct tdx_sys_info *sysinfo)
{
+ int ret;
+
+ ret = get_tdx_sys_info_version(&sysinfo->version);
+ if (ret)
+ return ret;
+
return get_tdx_sys_info_tdmr(&sysinfo->tdmr);
}

+static void print_sys_info_version(struct tdx_sys_info_version *version)
+{
+ /*
+ * TDX module version encoding:
+ *
+ * <major>.<minor>.<update>.<internal>.<build_num>
+ *
+ * When printed as text, <major> and <minor> are 1-digit,
+ * <update> and <internal> are 2-digits and <build_num>
+ * is 4-digits.
+ */
+ pr_info("Initializing TDX module: %u.%u.%02u.%02u.%04u (build_date %u).\n",
+ version->major, version->minor, version->update,
+ version->internal, version->build_num,
+ version->build_date);
+}
+
+static void print_basic_sys_info(struct tdx_sys_info *sysinfo)
+{
+ print_sys_info_version(&sysinfo->version);
+}
+
/* Calculate the actual TDMR size */
static int tdmr_size_single(u16 max_reserved_per_tdmr)
{
@@ -1098,6 +1147,8 @@ static int init_tdx_module(void)
if (ret)
return ret;

+ print_basic_sys_info(&sysinfo);
+
/*
* To keep things simple, assume that all TDX-protected memory
* will come from the page allocator. Make sure all pages in the
diff --git a/arch/x86/virt/vmx/tdx/tdx.h b/arch/x86/virt/vmx/tdx/tdx.h
index b9a89da39e1e..a8d0ab3e5acd 100644
--- a/arch/x86/virt/vmx/tdx/tdx.h
+++ b/arch/x86/virt/vmx/tdx/tdx.h
@@ -31,6 +31,12 @@
*
* See the "global_metadata.json" in the "TDX 1.5 ABI definitions".
*/
+#define MD_FIELD_ID_BUILD_DATE 0x8800000200000001ULL
+#define MD_FIELD_ID_BUILD_NUM 0x8800000100000002ULL
+#define MD_FIELD_ID_MINOR_VERSION 0x0800000100000003ULL
+#define MD_FIELD_ID_MAJOR_VERSION 0x0800000100000004ULL
+#define MD_FIELD_ID_UPDATE_VERSION 0x0800000100000005ULL
+#define MD_FIELD_ID_INTERNAL_VERSION 0x0800000100000006ULL
#define MD_FIELD_ID_MAX_TDMRS 0x9100000100000008ULL
#define MD_FIELD_ID_MAX_RESERVED_PER_TDMR 0x9100000100000009ULL
#define MD_FIELD_ID_PAMT_4K_ENTRY_SIZE 0x9100000100000010ULL
@@ -54,6 +60,7 @@
(((_field_id) & GENMASK_ULL(33, 32)) >> 32)

#define MD_FIELD_ID_ELE_SIZE_16BIT 1
+#define MD_FIELD_ID_ELE_SIZE_32BIT 2

struct tdmr_reserved_area {
u64 offset;
@@ -98,6 +105,16 @@ struct tdmr_info {
* those used by the kernel are.
*/

+/* Class "TDX Module Version" */
+struct tdx_sys_info_version {
+ u16 major;
+ u16 minor;
+ u16 update;
+ u16 internal;
+ u16 build_num;
+ u32 build_date;
+};
+
/* Class "TDMR info" */
struct tdx_sys_info_tdmr {
u16 max_tdmrs;
@@ -106,7 +123,8 @@ struct tdx_sys_info_tdmr {
};

struct tdx_sys_info {
- struct tdx_sys_info_tdmr tdmr;
+ struct tdx_sys_info_version version;
+ struct tdx_sys_info_tdmr tdmr;
};

/*
--
2.46.0