Skip to content

Commit 7efd8fa

Browse files
jan-kiszkaavikivity
authored andcommitted
KVM: Improve wording of KVM_SET_USER_MEMORY_REGION documentation
Signed-off-by: Jan Kiszka <[email protected]> Signed-off-by: Avi Kivity <[email protected]>
1 parent a50abc3 commit 7efd8fa

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/virtual/kvm/api.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -874,17 +874,17 @@ It is recommended that the lower 21 bits of guest_phys_addr and userspace_addr
874874
be identical. This allows large pages in the guest to be backed by large
875875
pages in the host.
876876

877-
The flags field supports two flag, KVM_MEM_LOG_DIRTY_PAGES, which
878-
instructs kvm to keep track of writes to memory within the slot. See
879-
the KVM_GET_DIRTY_LOG ioctl. Another flag is KVM_MEM_READONLY when the
880-
KVM_CAP_READONLY_MEM capability, it indicates the guest memory is read-only,
881-
that means, guest is only allowed to read it. Writes will be posted to
882-
userspace as KVM_EXIT_MMIO exits.
883-
884-
When the KVM_CAP_SYNC_MMU capability, changes in the backing of the memory
885-
region are automatically reflected into the guest. For example, an mmap()
886-
that affects the region will be made visible immediately. Another example
887-
is madvise(MADV_DROP).
877+
The flags field supports two flag, KVM_MEM_LOG_DIRTY_PAGES, which instructs
878+
kvm to keep track of writes to memory within the slot. See KVM_GET_DIRTY_LOG
879+
ioctl. The KVM_CAP_READONLY_MEM capability indicates the availability of the
880+
KVM_MEM_READONLY flag. When this flag is set for a memory region, KVM only
881+
allows read accesses. Writes will be posted to userspace as KVM_EXIT_MMIO
882+
exits.
883+
884+
When the KVM_CAP_SYNC_MMU capability is available, changes in the backing of
885+
the memory region are automatically reflected into the guest. For example, an
886+
mmap() that affects the region will be made visible immediately. Another
887+
example is madvise(MADV_DROP).
888888

889889
It is recommended to use this API instead of the KVM_SET_MEMORY_REGION ioctl.
890890
The KVM_SET_MEMORY_REGION does not allow fine grained control over memory

0 commit comments

Comments
 (0)