Huang, Kai wrote: > On Mon, 2024-08-05 at 21:19 -0700, Williams, Dan J wrote: > > Kai Huang wrote: > > > Currently the kernel doesn't print any information regarding the TDX > > > module itself, e.g. module version. In practice such information is > > > useful, especially to the developers. > > > > > > For instance, there are a couple of use cases for dumping module basic > > > information: > > > > > > 1) When something goes wrong around using TDX, the information like TDX > > > module version, supported features etc could be helpful [1][2]. > > > > > > 2) For Linux, when the user wants to update the TDX module, one needs to > > > replace the old module in a specific location in the EFI partition > > > with the new one so that after reboot the BIOS can load it. However, > > > after kernel boots, currently the user has no way to verify it is > > > indeed the new module that gets loaded and initialized (e.g., error > > > could happen when replacing the old module). With the module version > > > dumped the user can verify this easily. > > > > > > So dump the basic TDX module information: > > > > > > - TDX module version, and the build date. > > > - TDX module type: Debug or Production. > > > - TDX_FEATURES0: Supported TDX features. > > > > > > And dump the information right after reading global metadata, so that > > > this information is printed no matter whether module initialization > > > fails or not. > > > > > > The actual dmesg will look like: > > > > > > virt/tdx: Initializing TDX module: 1.5.00.00.0481 (build_date 20230323, Production module), TDX_FEATURES0 0xfbf > > > > > > Link: https://lore.kernel.org/lkml/e2d844ad-182a-4fc0-a06a-d609c9cbef74@xxxxxxxx/T/#m352829aedf6680d4628c7e40dc40b332eda93355 [1] > > > Link: https://lore.kernel.org/lkml/e2d844ad-182a-4fc0-a06a-d609c9cbef74@xxxxxxxx/T/#m351ebcbc006d2e5bc3e7650206a087cb2708d451 [2] > > > Signed-off-by: Kai Huang <kai.huang@xxxxxxxxx> > > > --- > > > > > > v1 -> v2 (Nikolay): > > > - Change the format to dump TDX basic info. > > > - Slightly improve changelog. > > > > > > --- > > > arch/x86/virt/vmx/tdx/tdx.c | 64 +++++++++++++++++++++++++++++++++++++ > > > arch/x86/virt/vmx/tdx/tdx.h | 33 ++++++++++++++++++- > > > 2 files changed, 96 insertions(+), 1 deletion(-) > > > > > > diff --git a/arch/x86/virt/vmx/tdx/tdx.c b/arch/x86/virt/vmx/tdx/tdx.c > > > index 3253cdfa5207..5ac0c411f4f7 100644 > > > --- a/arch/x86/virt/vmx/tdx/tdx.c > > > +++ b/arch/x86/virt/vmx/tdx/tdx.c > > > @@ -319,6 +319,58 @@ static int stbuf_read_sysmd_multi(const struct field_mapping *fields, > > > return 0; > > > } > > > > > > +#define TD_SYSINFO_MAP_MOD_INFO(_field_id, _member) \ > > > + TD_SYSINFO_MAP(_field_id, struct tdx_sysinfo_module_info, _member) > > > + > > > +static int get_tdx_module_info(struct tdx_sysinfo_module_info *modinfo) > > > +{ > > > + static const struct field_mapping fields[] = { > > > + TD_SYSINFO_MAP_MOD_INFO(SYS_ATTRIBUTES, sys_attributes), > > > + TD_SYSINFO_MAP_MOD_INFO(TDX_FEATURES0, tdx_features0), > > > + }; > > > + > > > + return stbuf_read_sysmd_multi(fields, ARRAY_SIZE(fields), modinfo); > > > +} > > > + > > > +#define TD_SYSINFO_MAP_MOD_VERSION(_field_id, _member) \ > > > + TD_SYSINFO_MAP(_field_id, struct tdx_sysinfo_module_version, _member) > > > + > > > +static int get_tdx_module_version(struct tdx_sysinfo_module_version *modver) > > > +{ > > > + static const struct field_mapping fields[] = { > > > + TD_SYSINFO_MAP_MOD_VERSION(MAJOR_VERSION, major), > > > + TD_SYSINFO_MAP_MOD_VERSION(MINOR_VERSION, minor), > > > + TD_SYSINFO_MAP_MOD_VERSION(UPDATE_VERSION, update), > > > + TD_SYSINFO_MAP_MOD_VERSION(INTERNAL_VERSION, internal), > > > + TD_SYSINFO_MAP_MOD_VERSION(BUILD_NUM, build_num), > > > + TD_SYSINFO_MAP_MOD_VERSION(BUILD_DATE, build_date), > > > + }; > > > + > > > + return stbuf_read_sysmd_multi(fields, ARRAY_SIZE(fields), modver); > > > > Looks good if stbuf_read_sysmd_multi() is replaced with the work being > > done internal to TD_SYSINFO_MAP_MOD_VERSION(). > > > > > +} > > > + > > > +static void print_basic_sysinfo(struct tdx_sysinfo *sysinfo) > > > +{ > > > + struct tdx_sysinfo_module_version *modver = &sysinfo->module_version; > > > + struct tdx_sysinfo_module_info *modinfo = &sysinfo->module_info; > > > + bool debug = modinfo->sys_attributes & TDX_SYS_ATTR_DEBUG_MODULE; > > > > Why is this casually checking for debug modules, but doing nothing with > > that indication? Shouldn't the kernel have policy around whether it > > wants to interoperate with a debug module? I would expect that kernel > > operation with a debug module would need explicit opt-in consideration. > > For now the purpose is just to print whether module is debug or > production in the dmesg to let the user easily see, just like the module > version info. > > Currently Linux depends on the BIOS to load the TDX module. For that we > need to put the module at /boot/efi/EFI/TDX/ and name it TDX-SEAM.so. So > given a machine, it's hard for the user to know whether a module is debug > one (the user may be able to get such info from the BIOS log, but it is > not always available for the user). > > Yes I agree we should have a policy in the kernel to handle debug module, > but I don't see urgent need of it. So I would prefer to leave it as > future work when needed. Then lets leave printing it as future work as well. It has no value outside of folks that can get their hands on a platform and a module-build that enables debug and to my knowledge that capability is not openly available. In the meantime I assume TDs will just need to be careful to check for this detail in their attestation report. It serves no real purpose to the VMM kernel. [..] > > This name feels too generic, perhaps 'tdx_sys_info_features' makes it > > clearer? > > I wanted to name the structure following the "Class" name in the JSON > file. Both 'sys_attributes' and 'tdx_featueres0' are under class "Module > Info". I am not sure how far we need to take fidelity to the naming choices that the TDX module makes. It would likely be sufficient to note the class name in a comment for the origin of the fields, i.e. the script has some mapping like: { class name, field name } => { linux struct name, linux attribute name } ...where they are mostly 1:1, but Linux has the option of picking more relevant names, especially since the class names are not directly reusable as Linux data type names. > I guess "attributes" are not necessarily features. Sure, but given that attributes have no real value to the VMM kernel at this point and features do, then name the data structure by its primary use. > > > + u32 sys_attributes; > > > + u64 tdx_features0; > > > +}; > > > + > > > +#define TDX_SYS_ATTR_DEBUG_MODULE 0x1 > > > + > > > +/* Class "TDX Module Version" */ > > > +struct tdx_sysinfo_module_version { > > > + u16 major; > > > + u16 minor; > > > + u16 update; > > > + u16 internal; > > > + u16 build_num; > > > + u32 build_date; > > > +}; > > > + > > > /* Class "TDMR Info" */ > > > struct tdx_sysinfo_tdmr_info { > > > u16 max_tdmrs; > > > @@ -134,7 +163,9 @@ struct tdx_sysinfo_tdmr_info { > > > }; > > > > > > struct tdx_sysinfo { > > > - struct tdx_sysinfo_tdmr_info tdmr_info; > > > + struct tdx_sysinfo_module_info module_info; > > > + struct tdx_sysinfo_module_version module_version; > > > + struct tdx_sysinfo_tdmr_info tdmr_info; > > > > Compare that to: > > > > struct tdx_sys_info { > > struct tdx_sys_info_features features; > > struct tdx_sys_info_version version; > > struct tdx_sys_info_tdmr tdmr; > > }; > > > > ...and tell me which oine is easier to read. > > I agree this is easier to read if we don't look at the JSON file. On the > other hand, following JSON file's "Class" names IMHO we can more easily > find which class to look at for a given member. > > So I think they both have pros/cons, and I have no hard opinion on this. Yeah, it is arbitrary. All I can offer is this quote from Ingo when I did the initial ACPI NFIT enabling and spilled all of its awkward terminology into the Linux implementation [1]: "So why on earth is this whole concept and the naming itself ('drivers/block/nd/' stands for 'NFIT Defined', apparently) revolving around a specific 'firmware' mindset and revolving around specific, weirdly named, overly complicated looking firmware interfaces that come with their own new weird glossary??" The TDX "Class" names are not completely unreasonable, but if they only get replicated as part of kdoc comments on the data structures I think that's ok. [1]: http://lore.kernel.org/20150420070624.GB13876@xxxxxxxxx
