1 /*- 2 * Copyright (c) 2011 NetApp, Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef _VMM_DEV_H_ 30 #define _VMM_DEV_H_ 31 32 #ifdef _KERNEL 33 void vmmdev_init(void); 34 int vmmdev_cleanup(void); 35 #endif 36 37 struct vm_memory_segment { 38 vm_paddr_t gpa; /* in */ 39 size_t len; 40 int wired; 41 }; 42 43 struct vm_register { 44 int cpuid; 45 int regnum; /* enum vm_reg_name */ 46 uint64_t regval; 47 }; 48 49 struct vm_seg_desc { /* data or code segment */ 50 int cpuid; 51 int regnum; /* enum vm_reg_name */ 52 struct seg_desc desc; 53 }; 54 55 struct vm_run { 56 int cpuid; 57 uint64_t rip; /* start running here */ 58 struct vm_exit vm_exit; 59 }; 60 61 struct vm_exception { 62 int cpuid; 63 int vector; 64 uint32_t error_code; 65 int error_code_valid; 66 int restart_instruction; 67 }; 68 69 struct vm_lapic_msi { 70 uint64_t msg; 71 uint64_t addr; 72 }; 73 74 struct vm_lapic_irq { 75 int cpuid; 76 int vector; 77 }; 78 79 struct vm_ioapic_irq { 80 int irq; 81 }; 82 83 struct vm_isa_irq { 84 int atpic_irq; 85 int ioapic_irq; 86 }; 87 88 struct vm_isa_irq_trigger { 89 int atpic_irq; 90 enum vm_intr_trigger trigger; 91 }; 92 93 struct vm_capability { 94 int cpuid; 95 enum vm_cap_type captype; 96 int capval; 97 int allcpus; 98 }; 99 100 struct vm_pptdev { 101 int bus; 102 int slot; 103 int func; 104 }; 105 106 struct vm_pptdev_mmio { 107 int bus; 108 int slot; 109 int func; 110 vm_paddr_t gpa; 111 vm_paddr_t hpa; 112 size_t len; 113 }; 114 115 struct vm_pptdev_msi { 116 int vcpu; 117 int bus; 118 int slot; 119 int func; 120 int numvec; /* 0 means disabled */ 121 uint64_t msg; 122 uint64_t addr; 123 }; 124 125 struct vm_pptdev_msix { 126 int vcpu; 127 int bus; 128 int slot; 129 int func; 130 int idx; 131 uint64_t msg; 132 uint32_t vector_control; 133 uint64_t addr; 134 }; 135 136 struct vm_nmi { 137 int cpuid; 138 }; 139 140 #define MAX_VM_STATS 64 141 struct vm_stats { 142 int cpuid; /* in */ 143 int num_entries; /* out */ 144 struct timeval tv; 145 uint64_t statbuf[MAX_VM_STATS]; 146 }; 147 148 struct vm_stat_desc { 149 int index; /* in */ 150 char desc[128]; /* out */ 151 }; 152 153 struct vm_x2apic { 154 int cpuid; 155 enum x2apic_state state; 156 }; 157 158 struct vm_gpa_pte { 159 uint64_t gpa; /* in */ 160 uint64_t pte[4]; /* out */ 161 int ptenum; 162 }; 163 164 struct vm_hpet_cap { 165 uint32_t capabilities; /* lower 32 bits of HPET capabilities */ 166 }; 167 168 struct vm_suspend { 169 enum vm_suspend_how how; 170 }; 171 172 struct vm_gla2gpa { 173 int vcpuid; /* inputs */ 174 int prot; /* PROT_READ or PROT_WRITE */ 175 uint64_t gla; 176 struct vm_guest_paging paging; 177 int fault; /* outputs */ 178 uint64_t gpa; 179 }; 180 181 struct vm_activate_cpu { 182 int vcpuid; 183 }; 184 185 struct vm_cpuset { 186 int which; 187 int cpusetsize; 188 cpuset_t *cpus; 189 }; 190 #define VM_ACTIVE_CPUS 0 191 #define VM_SUSPENDED_CPUS 1 192 193 struct vm_intinfo { 194 int vcpuid; 195 uint64_t info1; 196 uint64_t info2; 197 }; 198 199 struct vm_rtc_time { 200 time_t secs; 201 }; 202 203 struct vm_rtc_data { 204 int offset; 205 uint8_t value; 206 }; 207 208 enum { 209 /* general routines */ 210 IOCNUM_ABIVERS = 0, 211 IOCNUM_RUN = 1, 212 IOCNUM_SET_CAPABILITY = 2, 213 IOCNUM_GET_CAPABILITY = 3, 214 IOCNUM_SUSPEND = 4, 215 IOCNUM_REINIT = 5, 216 217 /* memory apis */ 218 IOCNUM_MAP_MEMORY = 10, 219 IOCNUM_GET_MEMORY_SEG = 11, 220 IOCNUM_GET_GPA_PMAP = 12, 221 IOCNUM_GLA2GPA = 13, 222 223 /* register/state accessors */ 224 IOCNUM_SET_REGISTER = 20, 225 IOCNUM_GET_REGISTER = 21, 226 IOCNUM_SET_SEGMENT_DESCRIPTOR = 22, 227 IOCNUM_GET_SEGMENT_DESCRIPTOR = 23, 228 229 /* interrupt injection */ 230 IOCNUM_GET_INTINFO = 28, 231 IOCNUM_SET_INTINFO = 29, 232 IOCNUM_INJECT_EXCEPTION = 30, 233 IOCNUM_LAPIC_IRQ = 31, 234 IOCNUM_INJECT_NMI = 32, 235 IOCNUM_IOAPIC_ASSERT_IRQ = 33, 236 IOCNUM_IOAPIC_DEASSERT_IRQ = 34, 237 IOCNUM_IOAPIC_PULSE_IRQ = 35, 238 IOCNUM_LAPIC_MSI = 36, 239 IOCNUM_LAPIC_LOCAL_IRQ = 37, 240 IOCNUM_IOAPIC_PINCOUNT = 38, 241 242 /* PCI pass-thru */ 243 IOCNUM_BIND_PPTDEV = 40, 244 IOCNUM_UNBIND_PPTDEV = 41, 245 IOCNUM_MAP_PPTDEV_MMIO = 42, 246 IOCNUM_PPTDEV_MSI = 43, 247 IOCNUM_PPTDEV_MSIX = 44, 248 249 /* statistics */ 250 IOCNUM_VM_STATS = 50, 251 IOCNUM_VM_STAT_DESC = 51, 252 253 /* kernel device state */ 254 IOCNUM_SET_X2APIC_STATE = 60, 255 IOCNUM_GET_X2APIC_STATE = 61, 256 IOCNUM_GET_HPET_CAPABILITIES = 62, 257 258 /* legacy interrupt injection */ 259 IOCNUM_ISA_ASSERT_IRQ = 80, 260 IOCNUM_ISA_DEASSERT_IRQ = 81, 261 IOCNUM_ISA_PULSE_IRQ = 82, 262 IOCNUM_ISA_SET_IRQ_TRIGGER = 83, 263 264 /* vm_cpuset */ 265 IOCNUM_ACTIVATE_CPU = 90, 266 IOCNUM_GET_CPUSET = 91, 267 268 /* RTC */ 269 IOCNUM_RTC_READ = 100, 270 IOCNUM_RTC_WRITE = 101, 271 IOCNUM_RTC_SETTIME = 102, 272 IOCNUM_RTC_GETTIME = 103, 273 }; 274 275 #define VM_RUN \ 276 _IOWR('v', IOCNUM_RUN, struct vm_run) 277 #define VM_SUSPEND \ 278 _IOW('v', IOCNUM_SUSPEND, struct vm_suspend) 279 #define VM_REINIT \ 280 _IO('v', IOCNUM_REINIT) 281 #define VM_MAP_MEMORY \ 282 _IOWR('v', IOCNUM_MAP_MEMORY, struct vm_memory_segment) 283 #define VM_GET_MEMORY_SEG \ 284 _IOWR('v', IOCNUM_GET_MEMORY_SEG, struct vm_memory_segment) 285 #define VM_SET_REGISTER \ 286 _IOW('v', IOCNUM_SET_REGISTER, struct vm_register) 287 #define VM_GET_REGISTER \ 288 _IOWR('v', IOCNUM_GET_REGISTER, struct vm_register) 289 #define VM_SET_SEGMENT_DESCRIPTOR \ 290 _IOW('v', IOCNUM_SET_SEGMENT_DESCRIPTOR, struct vm_seg_desc) 291 #define VM_GET_SEGMENT_DESCRIPTOR \ 292 _IOWR('v', IOCNUM_GET_SEGMENT_DESCRIPTOR, struct vm_seg_desc) 293 #define VM_INJECT_EXCEPTION \ 294 _IOW('v', IOCNUM_INJECT_EXCEPTION, struct vm_exception) 295 #define VM_LAPIC_IRQ \ 296 _IOW('v', IOCNUM_LAPIC_IRQ, struct vm_lapic_irq) 297 #define VM_LAPIC_LOCAL_IRQ \ 298 _IOW('v', IOCNUM_LAPIC_LOCAL_IRQ, struct vm_lapic_irq) 299 #define VM_LAPIC_MSI \ 300 _IOW('v', IOCNUM_LAPIC_MSI, struct vm_lapic_msi) 301 #define VM_IOAPIC_ASSERT_IRQ \ 302 _IOW('v', IOCNUM_IOAPIC_ASSERT_IRQ, struct vm_ioapic_irq) 303 #define VM_IOAPIC_DEASSERT_IRQ \ 304 _IOW('v', IOCNUM_IOAPIC_DEASSERT_IRQ, struct vm_ioapic_irq) 305 #define VM_IOAPIC_PULSE_IRQ \ 306 _IOW('v', IOCNUM_IOAPIC_PULSE_IRQ, struct vm_ioapic_irq) 307 #define VM_IOAPIC_PINCOUNT \ 308 _IOR('v', IOCNUM_IOAPIC_PINCOUNT, int) 309 #define VM_ISA_ASSERT_IRQ \ 310 _IOW('v', IOCNUM_ISA_ASSERT_IRQ, struct vm_isa_irq) 311 #define VM_ISA_DEASSERT_IRQ \ 312 _IOW('v', IOCNUM_ISA_DEASSERT_IRQ, struct vm_isa_irq) 313 #define VM_ISA_PULSE_IRQ \ 314 _IOW('v', IOCNUM_ISA_PULSE_IRQ, struct vm_isa_irq) 315 #define VM_ISA_SET_IRQ_TRIGGER \ 316 _IOW('v', IOCNUM_ISA_SET_IRQ_TRIGGER, struct vm_isa_irq_trigger) 317 #define VM_SET_CAPABILITY \ 318 _IOW('v', IOCNUM_SET_CAPABILITY, struct vm_capability) 319 #define VM_GET_CAPABILITY \ 320 _IOWR('v', IOCNUM_GET_CAPABILITY, struct vm_capability) 321 #define VM_BIND_PPTDEV \ 322 _IOW('v', IOCNUM_BIND_PPTDEV, struct vm_pptdev) 323 #define VM_UNBIND_PPTDEV \ 324 _IOW('v', IOCNUM_UNBIND_PPTDEV, struct vm_pptdev) 325 #define VM_MAP_PPTDEV_MMIO \ 326 _IOW('v', IOCNUM_MAP_PPTDEV_MMIO, struct vm_pptdev_mmio) 327 #define VM_PPTDEV_MSI \ 328 _IOW('v', IOCNUM_PPTDEV_MSI, struct vm_pptdev_msi) 329 #define VM_PPTDEV_MSIX \ 330 _IOW('v', IOCNUM_PPTDEV_MSIX, struct vm_pptdev_msix) 331 #define VM_INJECT_NMI \ 332 _IOW('v', IOCNUM_INJECT_NMI, struct vm_nmi) 333 #define VM_STATS \ 334 _IOWR('v', IOCNUM_VM_STATS, struct vm_stats) 335 #define VM_STAT_DESC \ 336 _IOWR('v', IOCNUM_VM_STAT_DESC, struct vm_stat_desc) 337 #define VM_SET_X2APIC_STATE \ 338 _IOW('v', IOCNUM_SET_X2APIC_STATE, struct vm_x2apic) 339 #define VM_GET_X2APIC_STATE \ 340 _IOWR('v', IOCNUM_GET_X2APIC_STATE, struct vm_x2apic) 341 #define VM_GET_HPET_CAPABILITIES \ 342 _IOR('v', IOCNUM_GET_HPET_CAPABILITIES, struct vm_hpet_cap) 343 #define VM_GET_GPA_PMAP \ 344 _IOWR('v', IOCNUM_GET_GPA_PMAP, struct vm_gpa_pte) 345 #define VM_GLA2GPA \ 346 _IOWR('v', IOCNUM_GLA2GPA, struct vm_gla2gpa) 347 #define VM_ACTIVATE_CPU \ 348 _IOW('v', IOCNUM_ACTIVATE_CPU, struct vm_activate_cpu) 349 #define VM_GET_CPUS \ 350 _IOW('v', IOCNUM_GET_CPUSET, struct vm_cpuset) 351 #define VM_SET_INTINFO \ 352 _IOW('v', IOCNUM_SET_INTINFO, struct vm_intinfo) 353 #define VM_GET_INTINFO \ 354 _IOWR('v', IOCNUM_GET_INTINFO, struct vm_intinfo) 355 #define VM_RTC_WRITE \ 356 _IOW('v', IOCNUM_RTC_WRITE, struct vm_rtc_data) 357 #define VM_RTC_READ \ 358 _IOWR('v', IOCNUM_RTC_READ, struct vm_rtc_data) 359 #define VM_RTC_SETTIME \ 360 _IOW('v', IOCNUM_RTC_SETTIME, struct vm_rtc_time) 361 #define VM_RTC_GETTIME \ 362 _IOR('v', IOCNUM_RTC_GETTIME, struct vm_rtc_time) 363 #endif 364