[PATCH] Documentation: core-api: entry: Replace deprecated KVM entry/exit functions

[PATCH] Documentation: core-api: entry: Replace deprecated KVM entry/exit functions

[Andrew Donnellan]

The x86-specific functions kvm_guest_{enter,exit}_irqoff() were removed
and replaced by the generic guest_state_{enter,exit}_irqoff() in commit
ef9989afda73 ("kvm: add guest_state_{enter,exit}_irqoff()") and commit
b2d2af7e5df3 ("kvm/x86: rework guest entry logic").

Update the references in the entry/exit handling documentation.

Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Nicolas Saenz Julienne <nsaenz@amazon.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
---
 Documentation/core-api/entry.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/core-api/entry.rst b/Documentation/core-api/entry.rst
index a15f9b1767a2..286a5ecf7cae 100644
--- a/Documentation/core-api/entry.rst
+++ b/Documentation/core-api/entry.rst
@@ -115,8 +115,8 @@ Entering or exiting guest mode is very similar to syscalls. From the host
 kernel point of view the CPU goes off into user space when entering the
 guest and returns to the kernel on exit.
 
-kvm_guest_enter_irqoff() is a KVM-specific variant of exit_to_user_mode()
-and kvm_guest_exit_irqoff() is the KVM variant of enter_from_user_mode().
+guest_state_enter_irqoff() is a KVM-specific variant of exit_to_user_mode()
+and guest_state_exit_irqoff() is the KVM variant of enter_from_user_mode().
 The state operations have the same ordering.
 
 Task work handling is done separately for guest at the boundary of the
-- 
2.50.1

Re: [PATCH] Documentation: core-api: entry: Replace deprecated KVM entry/exit functions

[Mark Rutland]

On Wed, Jul 23, 2025 at 05:51:34PM +1000, Andrew Donnellan wrote:
> The x86-specific functions kvm_guest_{enter,exit}_irqoff() were removed
> and replaced by the generic guest_state_{enter,exit}_irqoff() in commit
> ef9989afda73 ("kvm: add guest_state_{enter,exit}_irqoff()") and commit
> b2d2af7e5df3 ("kvm/x86: rework guest entry logic").
> 
> Update the references in the entry/exit handling documentation.

Sorry for missing this when I updated the code; thanks for cleaning this
up!

> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: Nicolas Saenz Julienne <nsaenz@amazon.com>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>

Acked-by: Mark Rutland <mark.rutland@arm.com>

Mark.

> ---
>  Documentation/core-api/entry.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/core-api/entry.rst b/Documentation/core-api/entry.rst
> index a15f9b1767a2..286a5ecf7cae 100644
> --- a/Documentation/core-api/entry.rst
> +++ b/Documentation/core-api/entry.rst
> @@ -115,8 +115,8 @@ Entering or exiting guest mode is very similar to syscalls. From the host
>  kernel point of view the CPU goes off into user space when entering the
>  guest and returns to the kernel on exit.
>  
> -kvm_guest_enter_irqoff() is a KVM-specific variant of exit_to_user_mode()
> -and kvm_guest_exit_irqoff() is the KVM variant of enter_from_user_mode().
> +guest_state_enter_irqoff() is a KVM-specific variant of exit_to_user_mode()
> +and guest_state_exit_irqoff() is the KVM variant of enter_from_user_mode().
>  The state operations have the same ordering.
>  
>  Task work handling is done separately for guest at the boundary of the
> -- 
> 2.50.1
> 

Re: [PATCH] Documentation: core-api: entry: Replace deprecated KVM entry/exit functions

[Thomas Gleixner]

On Wed, Jul 23 2025 at 17:51, Andrew Donnellan wrote:

> The x86-specific functions kvm_guest_{enter,exit}_irqoff() were removed
> and replaced by the generic guest_state_{enter,exit}_irqoff() in commit
> ef9989afda73 ("kvm: add guest_state_{enter,exit}_irqoff()") and commit
> b2d2af7e5df3 ("kvm/x86: rework guest entry logic").
>
> Update the references in the entry/exit handling documentation.
>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: Nicolas Saenz Julienne <nsaenz@amazon.com>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>

Reviewed-by: Thomas Gleixner <tglx@linutronix.de>

Re: [PATCH] Documentation: core-api: entry: Replace deprecated KVM entry/exit functions

[Jonathan Corbet]

Andrew Donnellan <ajd@linux.ibm.com> writes:

> The x86-specific functions kvm_guest_{enter,exit}_irqoff() were removed
> and replaced by the generic guest_state_{enter,exit}_irqoff() in commit
> ef9989afda73 ("kvm: add guest_state_{enter,exit}_irqoff()") and commit
> b2d2af7e5df3 ("kvm/x86: rework guest entry logic").
>
> Update the references in the entry/exit handling documentation.
>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: Nicolas Saenz Julienne <nsaenz@amazon.com>
> Cc: Mark Rutland <mark.rutland@arm.com>
> Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
> ---
>  Documentation/core-api/entry.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/core-api/entry.rst b/Documentation/core-api/entry.rst
> index a15f9b1767a2..286a5ecf7cae 100644
> --- a/Documentation/core-api/entry.rst
> +++ b/Documentation/core-api/entry.rst
> @@ -115,8 +115,8 @@ Entering or exiting guest mode is very similar to syscalls. From the host
>  kernel point of view the CPU goes off into user space when entering the
>  guest and returns to the kernel on exit.
>  
> -kvm_guest_enter_irqoff() is a KVM-specific variant of exit_to_user_mode()
> -and kvm_guest_exit_irqoff() is the KVM variant of enter_from_user_mode().
> +guest_state_enter_irqoff() is a KVM-specific variant of exit_to_user_mode()
> +and guest_state_exit_irqoff() is the KVM variant of enter_from_user_mode().
>  The state operations have the same ordering.

Applied, thanks.

jon