1 /******************************************************************************
4 * Memory event common structures.
6 * Copyright (c) 2009 by Citrix Systems, Inc. (Patrick Colp)
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to
10 * deal in the Software without restriction, including without limitation the
11 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12 * sell copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
27 #ifndef _XEN_PUBLIC_VM_EVENT_H
28 #define _XEN_PUBLIC_VM_EVENT_H
32 #define VM_EVENT_INTERFACE_VERSION 0x00000001
34 #if defined(__XEN__) || defined(__XEN_TOOLS__)
43 * VCPU_PAUSED in a request signals that the vCPU triggering the event has been
45 * VCPU_PAUSED in a response signals to unpause the vCPU
47 #define VM_EVENT_FLAG_VCPU_PAUSED (1 << 0)
48 /* Flags to aid debugging vm_event */
49 #define VM_EVENT_FLAG_FOREIGN (1 << 1)
51 * The following flags can be set in response to a mem_access event.
53 * Emulate the fault-causing instruction (if set in the event response flags).
54 * This will allow the guest to continue execution without lifting the page
55 * access restrictions.
57 #define VM_EVENT_FLAG_EMULATE (1 << 2)
59 * Same as VM_EVENT_FLAG_EMULATE, but with write operations or operations
60 * potentially having side effects (like memory mapped or port I/O) disabled.
62 #define VM_EVENT_FLAG_EMULATE_NOWRITE (1 << 3)
64 * Toggle singlestepping on vm_event response.
65 * Requires the vCPU to be paused already (synchronous events only).
67 #define VM_EVENT_FLAG_TOGGLE_SINGLESTEP (1 << 4)
69 * Data is being sent back to the hypervisor in the event response, to be
70 * returned by the read function when emulating an instruction.
71 * This flag is only useful when combined with VM_EVENT_FLAG_EMULATE
72 * and takes precedence if combined with VM_EVENT_FLAG_EMULATE_NOWRITE
73 * (i.e. if both VM_EVENT_FLAG_EMULATE_NOWRITE and
74 * VM_EVENT_FLAG_SET_EMUL_READ_DATA are set, only the latter will be honored).
76 #define VM_EVENT_FLAG_SET_EMUL_READ_DATA (1 << 5)
78 * Deny completion of the operation that triggered the event.
79 * Currently only useful for MSR, CR0, CR3 and CR4 write events.
81 #define VM_EVENT_FLAG_DENY (1 << 6)
83 * This flag can be set in a request or a response
85 * On a request, indicates that the event occurred in the alternate p2m specified by
86 * the altp2m_idx request field.
88 * On a response, indicates that the VCPU should resume in the alternate p2m specified
89 * by the altp2m_idx response field if possible.
91 #define VM_EVENT_FLAG_ALTERNATE_P2M (1 << 7)
94 * Reasons for the vm event request
98 #define VM_EVENT_REASON_UNKNOWN 0
99 /* Memory access violation */
100 #define VM_EVENT_REASON_MEM_ACCESS 1
101 /* Memory sharing event */
102 #define VM_EVENT_REASON_MEM_SHARING 2
103 /* Memory paging event */
104 #define VM_EVENT_REASON_MEM_PAGING 3
105 /* A control register was updated */
106 #define VM_EVENT_REASON_WRITE_CTRLREG 4
107 /* An MSR was updated. */
108 #define VM_EVENT_REASON_MOV_TO_MSR 5
109 /* Debug operation executed (e.g. int3) */
110 #define VM_EVENT_REASON_SOFTWARE_BREAKPOINT 6
111 /* Single-step (e.g. MTF) */
112 #define VM_EVENT_REASON_SINGLESTEP 7
113 /* An event has been requested via HVMOP_guest_request_vm_event. */
114 #define VM_EVENT_REASON_GUEST_REQUEST 8
116 /* Supported values for the vm_event_write_ctrlreg index. */
117 #define VM_EVENT_X86_CR0 0
118 #define VM_EVENT_X86_CR3 1
119 #define VM_EVENT_X86_CR4 2
120 #define VM_EVENT_X86_XCR0 3
123 * Using a custom struct (not hvm_hw_cpu) so as to not fill
124 * the vm_event ring buffer too quickly.
126 struct vm_event_regs_x86 {
150 uint64_t sysenter_cs;
151 uint64_t sysenter_esp;
152 uint64_t sysenter_eip;
163 * mem_access flag definitions
165 * These flags are set only as part of a mem_event request.
167 * R/W/X: Defines the type of violation that has triggered the event
168 * Multiple types can be set in a single violation!
169 * GLA_VALID: If the gla field holds a guest VA associated with the event
170 * FAULT_WITH_GLA: If the violation was triggered by accessing gla
171 * FAULT_IN_GPT: If the violation was triggered during translating gla
173 #define MEM_ACCESS_R (1 << 0)
174 #define MEM_ACCESS_W (1 << 1)
175 #define MEM_ACCESS_X (1 << 2)
176 #define MEM_ACCESS_RWX (MEM_ACCESS_R | MEM_ACCESS_W | MEM_ACCESS_X)
177 #define MEM_ACCESS_RW (MEM_ACCESS_R | MEM_ACCESS_W)
178 #define MEM_ACCESS_RX (MEM_ACCESS_R | MEM_ACCESS_X)
179 #define MEM_ACCESS_WX (MEM_ACCESS_W | MEM_ACCESS_X)
180 #define MEM_ACCESS_GLA_VALID (1 << 3)
181 #define MEM_ACCESS_FAULT_WITH_GLA (1 << 4)
182 #define MEM_ACCESS_FAULT_IN_GPT (1 << 5)
184 struct vm_event_mem_access {
187 uint64_t gla; /* if flags has MEM_ACCESS_GLA_VALID set */
188 uint32_t flags; /* MEM_ACCESS_* */
192 struct vm_event_write_ctrlreg {
199 struct vm_event_debug {
203 struct vm_event_mov_to_msr {
208 #define MEM_PAGING_DROP_PAGE (1 << 0)
209 #define MEM_PAGING_EVICT_FAIL (1 << 1)
211 struct vm_event_paging {
217 struct vm_event_sharing {
223 struct vm_event_emul_read_data {
225 /* The struct is used in a union with vm_event_regs_x86. */
226 uint8_t data[sizeof(struct vm_event_regs_x86) - sizeof(uint32_t)];
229 typedef struct vm_event_st {
230 uint32_t version; /* VM_EVENT_INTERFACE_VERSION */
231 uint32_t flags; /* VM_EVENT_FLAG_* */
232 uint32_t reason; /* VM_EVENT_REASON_* */
234 uint16_t altp2m_idx; /* may be used during request and response */
238 struct vm_event_paging mem_paging;
239 struct vm_event_sharing mem_sharing;
240 struct vm_event_mem_access mem_access;
241 struct vm_event_write_ctrlreg write_ctrlreg;
242 struct vm_event_mov_to_msr mov_to_msr;
243 struct vm_event_debug software_breakpoint;
244 struct vm_event_debug singlestep;
249 struct vm_event_regs_x86 x86;
252 struct vm_event_emul_read_data emul_read_data;
254 } vm_event_request_t, vm_event_response_t;
256 DEFINE_RING_TYPES(vm_event, vm_event_request_t, vm_event_response_t);
258 #endif /* defined(__XEN__) || defined(__XEN_TOOLS__) */
259 #endif /* _XEN_PUBLIC_VM_EVENT_H */
264 * c-file-style: "BSD"
267 * indent-tabs-mode: nil