linux-kernel - Re: [PATCH 7/9] x86/nmi: Improve NMI header documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <bbd417f4-b165-435a-8bb8-f90e42f0eb16@intel.com>
Date: Mon, 31 Mar 2025 14:36:36 -0700
From: Sohil Mehta <sohil.mehta@...el.com>
To: Ingo Molnar <mingo@...nel.org>
CC: <x86@...nel.org>, Thomas Gleixner <tglx@...utronix.de>, Ingo Molnar
	<mingo@...hat.com>, Borislav Petkov <bp@...en8.de>, Dave Hansen
	<dave.hansen@...ux.intel.com>, "H . Peter Anvin" <hpa@...or.com>, "Josh
 Poimboeuf" <jpoimboe@...nel.org>, Peter Zijlstra <peterz@...radead.org>,
	"Kirill A . Shutemov" <kirill.shutemov@...ux.intel.com>, Kai Huang
	<kai.huang@...el.com>, Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
	Mike Rapoport <rppt@...nel.org>, Petr Mladek <pmladek@...e.com>, Jani Nikula
	<jani.nikula@...el.com>, Tony Luck <tony.luck@...el.com>, Xin Li
	<xin@...or.com>, <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 7/9] x86/nmi: Improve NMI header documentation

On 3/31/2025 9:04 AM, Sohil Mehta wrote:
> On 3/31/2025 3:47 AM, Ingo Molnar wrote:
>>
>> * Sohil Mehta <sohil.mehta@...el.com> wrote:
>>
>>> diff --git a/arch/x86/include/asm/x86_init.h b/arch/x86/include/asm/x86_init.h
>>> index 213cf5379a5a..36698cc9fb44 100644
>>> --- a/arch/x86/include/asm/x86_init.h
>>> +++ b/arch/x86/include/asm/x86_init.h
>>> @@ -292,6 +292,7 @@ struct x86_hyper_runtime {
>>>   * @set_wallclock:		set time back to HW clock
>>>   * @is_untracked_pat_range	exclude from PAT logic
>>>   * @nmi_init			enable NMI on cpus
>>> + * @get_nmi_reason		get the reason an NMI was received
>>>   * @save_sched_clock_state:	save state for sched_clock() on suspend
>>>   * @restore_sched_clock_state:	restore state for sched_clock() on resume
>>>   * @apic_post_init:		adjust apic if needed
>>
>> Note that I've split off this second half into a separate commit:
>>
>>   x86/nmi: Add missing description x86_hyper_runtime::get_nmi_reason to <asm/x86_init.h>
>>

Upon closer inspection, I realized that the commit title for the new
patch is incorrect.
s/x86_hyper_runtime/x86_platform_ops

The git diff context shown above is misleading. We are modifying the
struct x86_platform_ops documentation and not struct x86_hyper_runtime.

/**
 * struct x86_platform_ops - platform specific runtime functions
 * @calibrate_cpu:		calibrate CPU
 * @calibrate_tsc:		calibrate TSC, if different from CPU
 * @get_wallclock:		get time from HW clock like RTC etc.
 * @set_wallclock:		set time back to HW clock
 * @is_untracked_pat_range	exclude from PAT logic
 * @nmi_init			enable NMI on cpus
 * @get_nmi_reason		get the reason an NMI was received
 * @save_sched_clock_state:	save state for sched_clock() on suspend
 * @restore_sched_clock_state:	restore state for sched_clock() on resu

>> as it's basically an independent KernelDoc bugfix AFAICS.
>>
> 
> That's fine with me. I did consider it for a moment but choose otherwise
> to avoid micro-patches. Here is my sign-off if you need one.
> 
> Signed-off-by: Sohil Mehta <sohil.mehta@...el.com>

Sohil