2023-06-10 06:17:24

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] Documentation: virt: clean up paravirt_ops doc.

Clarify language. Clean up grammar. Hyphenate some words.

Change "low-ops" to "low-level" since "low-ops" isn't defined or even
mentioned anywhere else in the kernel source tree.

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Juergen Gross <[email protected]>
Cc: Ajay Kaher <[email protected]>
Cc: Alexey Makhalov <[email protected]>
Cc: VMware PV-Drivers Reviewers <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Paolo Bonzini <[email protected]>
Cc: "Luke Nowakowski-Krijger" <[email protected]>
Cc: Luis Chamberlain <[email protected]>
---
Documentation/virt/paravirt_ops.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff -- a/Documentation/virt/paravirt_ops.rst b/Documentation/virt/paravirt_ops.rst
--- a/Documentation/virt/paravirt_ops.rst
+++ b/Documentation/virt/paravirt_ops.rst
@@ -5,31 +5,31 @@ Paravirt_ops
============

Linux provides support for different hypervisor virtualization technologies.
-Historically different binary kernels would be required in order to support
-different hypervisors, this restriction was removed with pv_ops.
+Historically, different binary kernels would be required in order to support
+different hypervisors; this restriction was removed with pv_ops.
Linux pv_ops is a virtualization API which enables support for different
hypervisors. It allows each hypervisor to override critical operations and
allows a single kernel binary to run on all supported execution environments
including native machine -- without any hypervisors.

pv_ops provides a set of function pointers which represent operations
-corresponding to low level critical instructions and high level
-functionalities in various areas. pv-ops allows for optimizations at run
-time by enabling binary patching of the low-ops critical operations
+corresponding to low-level critical instructions and high-level
+functionalities in various areas. pv_ops allows for optimizations at run
+time by enabling binary patching of the low-level critical operations
at boot time.

pv_ops operations are classified into three categories:

- simple indirect call
- These operations correspond to high level functionality where it is
+ These operations correspond to high-level functionality where it is
known that the overhead of indirect call isn't very important.

- indirect call which allows optimization with binary patch
- Usually these operations correspond to low level critical instructions. They
+ Usually these operations correspond to low-level critical instructions. They
are called frequently and are performance critical. The overhead is
very important.

- a set of macros for hand written assembly code
Hand written assembly codes (.S files) also need paravirtualization
- because they include sensitive instructions or some of code paths in
+ because they include sensitive instructions or some code paths in
them are very performance critical.


2023-06-12 05:40:26

by Juergen Gross

[permalink] [raw]
Subject: Re: [PATCH] Documentation: virt: clean up paravirt_ops doc.

On 10.06.23 07:43, Randy Dunlap wrote:
> Clarify language. Clean up grammar. Hyphenate some words.
>
> Change "low-ops" to "low-level" since "low-ops" isn't defined or even
> mentioned anywhere else in the kernel source tree.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Juergen Gross <[email protected]>
> Cc: Ajay Kaher <[email protected]>
> Cc: Alexey Makhalov <[email protected]>
> Cc: VMware PV-Drivers Reviewers <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Paolo Bonzini <[email protected]>
> Cc: "Luke Nowakowski-Krijger" <[email protected]>
> Cc: Luis Chamberlain <[email protected]>

Acked-by: Juergen Gross <[email protected]>


Juergen


Attachments:
OpenPGP_0xB0DE9DD628BF132F.asc (3.08 kB)
OpenPGP public key
OpenPGP_signature (505.00 B)
OpenPGP digital signature
Download all attachments

2023-06-19 10:43:50

by tip-bot2 for Jacob Pan

[permalink] [raw]
Subject: [tip: x86/cleanups] Documentation: virt: Clean up paravirt_ops doc

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID: 6f7f812f54b46da88ec6e98b4a10e501d0d7164c
Gitweb: https://git.kernel.org/tip/6f7f812f54b46da88ec6e98b4a10e501d0d7164c
Author: Randy Dunlap <[email protected]>
AuthorDate: Fri, 09 Jun 2023 22:43:10 -07:00
Committer: Borislav Petkov (AMD) <[email protected]>
CommitterDate: Mon, 19 Jun 2023 12:09:54 +02:00

Documentation: virt: Clean up paravirt_ops doc

Clarify language. Clean up grammar. Hyphenate some words.

Change "low-ops" to "low-level" since "low-ops" isn't defined or even
mentioned anywhere else in the kernel source tree.

Signed-off-by: Randy Dunlap <[email protected]>
Signed-off-by: Borislav Petkov (AMD) <[email protected]>
Acked-by: Juergen Gross <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
---
Documentation/virt/paravirt_ops.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/virt/paravirt_ops.rst b/Documentation/virt/paravirt_ops.rst
index 6b789d2..62d867e 100644
--- a/Documentation/virt/paravirt_ops.rst
+++ b/Documentation/virt/paravirt_ops.rst
@@ -5,31 +5,31 @@ Paravirt_ops
============

Linux provides support for different hypervisor virtualization technologies.
-Historically different binary kernels would be required in order to support
-different hypervisors, this restriction was removed with pv_ops.
+Historically, different binary kernels would be required in order to support
+different hypervisors; this restriction was removed with pv_ops.
Linux pv_ops is a virtualization API which enables support for different
hypervisors. It allows each hypervisor to override critical operations and
allows a single kernel binary to run on all supported execution environments
including native machine -- without any hypervisors.

pv_ops provides a set of function pointers which represent operations
-corresponding to low level critical instructions and high level
-functionalities in various areas. pv-ops allows for optimizations at run
-time by enabling binary patching of the low-ops critical operations
+corresponding to low-level critical instructions and high-level
+functionalities in various areas. pv_ops allows for optimizations at run
+time by enabling binary patching of the low-level critical operations
at boot time.

pv_ops operations are classified into three categories:

- simple indirect call
- These operations correspond to high level functionality where it is
+ These operations correspond to high-level functionality where it is
known that the overhead of indirect call isn't very important.

- indirect call which allows optimization with binary patch
- Usually these operations correspond to low level critical instructions. They
+ Usually these operations correspond to low-level critical instructions. They
are called frequently and are performance critical. The overhead is
very important.

- a set of macros for hand written assembly code
Hand written assembly codes (.S files) also need paravirtualization
- because they include sensitive instructions or some of code paths in
+ because they include sensitive instructions or some code paths in
them are very performance critical.