This command returns subpage protection (SPP) write bitmaps for an array
of guest physical addresses of 4KB size.
Like the KVMI_GET_PAGE_ACCESS command, it checks only the radix tree,
not the SPP tables. So, either we change it to check the SPP tables
or we drop it. Given the fact that the KVMI_EVENT_PF events are filter
using the radix tree and that the introspection tool should know what
it tracks, we should choose the later.
Signed-off-by: Adalbert Lazăr <alazar@xxxxxxxxxxxxxxx>
---
Documentation/virtual/kvm/kvmi.rst | 44 ++++++++++++++++++++++++++++++
arch/x86/kvm/kvmi.c | 44 ++++++++++++++++++++++++++++++
include/uapi/linux/kvmi.h | 11 ++++++++
virt/kvm/kvmi.c | 11 ++++++++
virt/kvm/kvmi_int.h | 11 ++++++++
virt/kvm/kvmi_msg.c | 18 ++++++++++++
6 files changed, 139 insertions(+)
diff --git a/Documentation/virtual/kvm/kvmi.rst b/Documentation/virtual/kvm/kvmi.rst
index c1d12aaa8633..2ffb92b0fa71 100644
--- a/Documentation/virtual/kvm/kvmi.rst
+++ b/Documentation/virtual/kvm/kvmi.rst
@@ -650,6 +650,50 @@ If SPP is not enabled, *KVMI_GET_PAGE_WRITE_BITMAP* and
* -KVM_EOPNOTSUPP - the hardware doesn't support SPP
* -KVM_EOPNOTSUPP - the current implementation can't disable SPP
+12. KVMI_GET_PAGE_WRITE_BITMAP
+------------------------------
+
+:Architectures: x86
+:Versions: >= 1
+:Parameters:
+
+::
+
+ struct kvmi_get_page_write_bitmap {
+ __u16 view;
+ __u16 count;
+ __u32 padding;
+ __u64 gpa[0];
+ };
+
+:Returns:
+
+::
+
+ struct kvmi_error_code;
+ struct kvmi_get_page_write_bitmap_reply {
+ __u32 bitmap[0];
+ };
+
+Returns subpage protection (SPP) write bitmaps for an array of ``count``
+guest physical addresses of 4KB size.
+
+By default, for any guest physical address, the returned bits will be zero
+(no write access for any subpage if the *KVMI_PAGE_ACCESS_W* flag has been
+cleared for the whole 4KB page - see *KVMI_SET_PAGE_ACCESS*).
+
+On Intel hardware with multiple EPT views, the ``view`` argument selects the
+EPT view (0 is primary). On all other hardware it must be zero.
+
+:Errors:
+
+* -KVM_EINVAL - the selected SPT view is invalid
+* -KVM_EINVAL - padding is not zero
+* -KVM_EOPNOTSUPP - a SPT view was selected but the hardware doesn't support it
+* -KVM_EOPNOTSUPP - the hardware doesn't support SPP or hasn't been enabled
+* -KVM_EAGAIN - the selected vCPU can't be introspected yet
+* -KVM_ENOMEM - not enough memory to allocate the reply
+
Events
======
diff --git a/arch/x86/kvm/kvmi.c b/arch/x86/kvm/kvmi.c
index 01fd218e213c..356ec79936b3 100644
--- a/arch/x86/kvm/kvmi.c
+++ b/arch/x86/kvm/kvmi.c
@@ -224,6 +224,50 @@ int kvmi_arch_cmd_get_page_access(struct kvmi *ikvm,
return 0;
}
+int kvmi_arch_cmd_get_page_write_bitmap(struct kvmi *ikvm,
+ const struct kvmi_msg_hdr *msg,
+ const struct kvmi_get_page_write_bitmap
+ *req,
+ struct kvmi_get_page_write_bitmap_reply
+ **dest, size_t *dest_size)
+{
+ struct kvmi_get_page_write_bitmap_reply *rpl = NULL;
+ size_t rpl_size = 0;
+ u16 k, n = req->count;
+ int ec = 0;
+
+ if (req->padding)
+ return -KVM_EINVAL;
+
+ if (msg->size < sizeof(*req) + req->count * sizeof(req->gpa[0]))
+ return -KVM_EINVAL;
+
+ if (!kvmi_spp_enabled(ikvm))
+ return -KVM_EOPNOTSUPP;
+
+ if (req->view != 0) /* TODO */
+ return -KVM_EOPNOTSUPP;
+
+ rpl_size = sizeof(*rpl) + sizeof(rpl->bitmap[0]) * n;
+ rpl = kvmi_msg_alloc_check(rpl_size);
+ if (!rpl)
+ return -KVM_ENOMEM;
+
+ for (k = 0; k < n && ec == 0; k++)
+ ec = kvmi_cmd_get_page_write_bitmap(ikvm, req->gpa[k],
+ &rpl->bitmap[k]);
+
+ if (ec) {
+ kvmi_msg_free(rpl);
+ return ec;
+ }
+
+ *dest = rpl;
+ *dest_size = rpl_size;
+
+ return 0;
+}
+
int kvmi_arch_cmd_set_page_access(struct kvmi *ikvm,
const struct kvmi_msg_hdr *msg,
const struct kvmi_set_page_access *req)
diff --git a/include/uapi/linux/kvmi.h b/include/uapi/linux/kvmi.h
index 9f2b13718e47..19a6a50df96b 100644
--- a/include/uapi/linux/kvmi.h
+++ b/include/uapi/linux/kvmi.h
@@ -149,6 +149,17 @@ struct kvmi_control_spp {
__u32 padding3;
};
+struct kvmi_get_page_write_bitmap {
+ __u16 view;
+ __u16 count;
+ __u32 padding;
+ __u64 gpa[0];
+};
+
+struct kvmi_get_page_write_bitmap_reply {
+ __u32 bitmap[0];
+};
+
struct kvmi_get_vcpu_info_reply {
__u64 tsc_speed;
};
diff --git a/virt/kvm/kvmi.c b/virt/kvm/kvmi.c
index e18dfffa25ac..22e233ca474c 100644
--- a/virt/kvm/kvmi.c
+++ b/virt/kvm/kvmi.c
@@ -1161,6 +1161,17 @@ int kvmi_cmd_get_page_access(struct kvmi *ikvm, u64 gpa, u8 *access)
return 0;
}
+int kvmi_cmd_get_page_write_bitmap(struct kvmi *ikvm, u64 gpa,
+ u32 *write_bitmap)
+{
+ gfn_t gfn = gpa_to_gfn(gpa);
+ u8 ignored_access;
+
+ kvmi_get_gfn_access(ikvm, gfn, &ignored_access, write_bitmap);
+
+ return 0;
+}
+
int kvmi_cmd_set_page_access(struct kvmi *ikvm, u64 gpa, u8 access)
{
gfn_t gfn = gpa_to_gfn(gpa);
diff --git a/virt/kvm/kvmi_int.h b/virt/kvm/kvmi_int.h
index d9a10a3b7082..7243c57be27a 100644
--- a/virt/kvm/kvmi_int.h
+++ b/virt/kvm/kvmi_int.h
@@ -150,6 +150,11 @@ static inline bool is_event_enabled(struct kvm_vcpu *vcpu, int event)
return test_bit(event, IVCPU(vcpu)->ev_mask);
}
+static inline bool kvmi_spp_enabled(struct kvmi *ikvm)
+{
+ return atomic_read(&ikvm->spp.enabled);
+}
+
/* kvmi_msg.c */
bool kvmi_sock_get(struct kvmi *ikvm, int fd);
void kvmi_sock_shutdown(struct kvmi *ikvm);
@@ -167,6 +172,7 @@ void *kvmi_msg_alloc_check(size_t size);
void kvmi_msg_free(void *addr);
int kvmi_cmd_get_page_access(struct kvmi *ikvm, u64 gpa, u8 *access);
int kvmi_cmd_set_page_access(struct kvmi *ikvm, u64 gpa, u8 access);
+int kvmi_cmd_get_page_write_bitmap(struct kvmi *ikvm, u64 gpa, u32 *bitmap);
int kvmi_cmd_control_events(struct kvm_vcpu *vcpu, unsigned int event_id,
bool enable);
int kvmi_cmd_control_vm_events(struct kvmi *ikvm, unsigned int event_id,
@@ -191,6 +197,11 @@ int kvmi_arch_cmd_set_page_access(struct kvmi *ikvm,
const struct kvmi_msg_hdr *msg,
const struct kvmi_set_page_access *req);
int kvmi_arch_cmd_control_spp(struct kvmi *ikvm);
+int kvmi_arch_cmd_get_page_write_bitmap(struct kvmi *ikvm,
+ const struct kvmi_msg_hdr *msg,
+ const struct kvmi_get_page_write_bitmap *req,
+ struct kvmi_get_page_write_bitmap_reply **dest,
+ size_t *dest_size);
void kvmi_arch_setup_event(struct kvm_vcpu *vcpu, struct kvmi_event *ev);
bool kvmi_arch_pf_event(struct kvm_vcpu *vcpu, gpa_t gpa, gva_t gva,
u8 access);
diff --git a/virt/kvm/kvmi_msg.c b/virt/kvm/kvmi_msg.c
index e501a807c8a2..eb247ac3e037 100644
--- a/virt/kvm/kvmi_msg.c
+++ b/virt/kvm/kvmi_msg.c
@@ -31,6 +31,7 @@ static const char *const msg_IDs[] = {
[KVMI_EVENT_REPLY] = "KVMI_EVENT_REPLY",
[KVMI_GET_GUEST_INFO] = "KVMI_GET_GUEST_INFO",
[KVMI_GET_PAGE_ACCESS] = "KVMI_GET_PAGE_ACCESS",
+ [KVMI_GET_PAGE_WRITE_BITMAP] = "KVMI_GET_PAGE_WRITE_BITMAP",
[KVMI_GET_VCPU_INFO] = "KVMI_GET_VCPU_INFO",
[KVMI_GET_VERSION] = "KVMI_GET_VERSION",
[KVMI_SET_PAGE_ACCESS] = "KVMI_SET_PAGE_ACCESS",
@@ -383,6 +384,22 @@ static int handle_set_page_access(struct kvmi *ikvm,
return kvmi_msg_vm_maybe_reply(ikvm, msg, ec, NULL, 0);
}
+static int handle_get_page_write_bitmap(struct kvmi *ikvm,
+ const struct kvmi_msg_hdr *msg,
+ const void *req)
+{
+ struct kvmi_get_page_write_bitmap_reply *rpl = NULL;
+ size_t rpl_size = 0;
+ int err, ec;
+
+ ec = kvmi_arch_cmd_get_page_write_bitmap(ikvm, msg, req, &rpl,
+ &rpl_size);
+
+ err = kvmi_msg_vm_maybe_reply(ikvm, msg, ec, rpl, rpl_size);
+ kvmi_msg_free(rpl);
+ return err;
+}
+
static bool invalid_vcpu_hdr(const struct kvmi_vcpu_hdr *hdr)
{
return hdr->padding1 || hdr->padding2;
@@ -400,6 +417,7 @@ static int(*const msg_vm[])(struct kvmi *, const struct kvmi_msg_hdr *,
[KVMI_CONTROL_VM_EVENTS] = handle_control_vm_events,
[KVMI_GET_GUEST_INFO] = handle_get_guest_info,
[KVMI_GET_PAGE_ACCESS] = handle_get_page_access,
+ [KVMI_GET_PAGE_WRITE_BITMAP] = handle_get_page_write_bitmap,
[KVMI_GET_VERSION] = handle_get_version,
[KVMI_SET_PAGE_ACCESS] = handle_set_page_access,
};
