1 // SPDX-License-Identifier: GPL-2.0-only
3 * tools/testing/selftests/kvm/lib/x86_64/processor.c
5 * Copyright (C) 2018, Google LLC.
10 #include "../kvm_util_internal.h"
11 #include "processor.h"
13 #ifndef NUM_INTERRUPTS
14 #define NUM_INTERRUPTS 256
17 #define DEFAULT_CODE_SELECTOR 0x8
18 #define DEFAULT_DATA_SELECTOR 0x10
20 vm_vaddr_t exception_handlers;
22 /* Virtual translation table structure declarations */
23 struct pageUpperEntry {
27 uint64_t write_through:1;
28 uint64_t cache_disable:1;
30 uint64_t ignored_06:1;
32 uint64_t ignored_11_08:4;
34 uint64_t ignored_62_52:11;
35 uint64_t execute_disable:1;
38 struct pageTableEntry {
42 uint64_t write_through:1;
43 uint64_t cache_disable:1;
46 uint64_t reserved_07:1;
48 uint64_t ignored_11_09:3;
50 uint64_t ignored_62_52:11;
51 uint64_t execute_disable:1;
54 void regs_dump(FILE *stream, struct kvm_regs *regs,
57 fprintf(stream, "%*srax: 0x%.16llx rbx: 0x%.16llx "
58 "rcx: 0x%.16llx rdx: 0x%.16llx\n",
60 regs->rax, regs->rbx, regs->rcx, regs->rdx);
61 fprintf(stream, "%*srsi: 0x%.16llx rdi: 0x%.16llx "
62 "rsp: 0x%.16llx rbp: 0x%.16llx\n",
64 regs->rsi, regs->rdi, regs->rsp, regs->rbp);
65 fprintf(stream, "%*sr8: 0x%.16llx r9: 0x%.16llx "
66 "r10: 0x%.16llx r11: 0x%.16llx\n",
68 regs->r8, regs->r9, regs->r10, regs->r11);
69 fprintf(stream, "%*sr12: 0x%.16llx r13: 0x%.16llx "
70 "r14: 0x%.16llx r15: 0x%.16llx\n",
72 regs->r12, regs->r13, regs->r14, regs->r15);
73 fprintf(stream, "%*srip: 0x%.16llx rfl: 0x%.16llx\n",
75 regs->rip, regs->rflags);
82 * stream - Output FILE stream
83 * segment - KVM segment
84 * indent - Left margin indent amount
90 * Dumps the state of the KVM segment given by @segment, to the FILE stream
93 static void segment_dump(FILE *stream, struct kvm_segment *segment,
96 fprintf(stream, "%*sbase: 0x%.16llx limit: 0x%.8x "
97 "selector: 0x%.4x type: 0x%.2x\n",
98 indent, "", segment->base, segment->limit,
99 segment->selector, segment->type);
100 fprintf(stream, "%*spresent: 0x%.2x dpl: 0x%.2x "
101 "db: 0x%.2x s: 0x%.2x l: 0x%.2x\n",
102 indent, "", segment->present, segment->dpl,
103 segment->db, segment->s, segment->l);
104 fprintf(stream, "%*sg: 0x%.2x avl: 0x%.2x "
105 "unusable: 0x%.2x padding: 0x%.2x\n",
106 indent, "", segment->g, segment->avl,
107 segment->unusable, segment->padding);
114 * stream - Output FILE stream
115 * dtable - KVM dtable
116 * indent - Left margin indent amount
122 * Dumps the state of the KVM dtable given by @dtable, to the FILE stream
125 static void dtable_dump(FILE *stream, struct kvm_dtable *dtable,
128 fprintf(stream, "%*sbase: 0x%.16llx limit: 0x%.4x "
129 "padding: 0x%.4x 0x%.4x 0x%.4x\n",
130 indent, "", dtable->base, dtable->limit,
131 dtable->padding[0], dtable->padding[1], dtable->padding[2]);
134 void sregs_dump(FILE *stream, struct kvm_sregs *sregs,
139 fprintf(stream, "%*scs:\n", indent, "");
140 segment_dump(stream, &sregs->cs, indent + 2);
141 fprintf(stream, "%*sds:\n", indent, "");
142 segment_dump(stream, &sregs->ds, indent + 2);
143 fprintf(stream, "%*ses:\n", indent, "");
144 segment_dump(stream, &sregs->es, indent + 2);
145 fprintf(stream, "%*sfs:\n", indent, "");
146 segment_dump(stream, &sregs->fs, indent + 2);
147 fprintf(stream, "%*sgs:\n", indent, "");
148 segment_dump(stream, &sregs->gs, indent + 2);
149 fprintf(stream, "%*sss:\n", indent, "");
150 segment_dump(stream, &sregs->ss, indent + 2);
151 fprintf(stream, "%*str:\n", indent, "");
152 segment_dump(stream, &sregs->tr, indent + 2);
153 fprintf(stream, "%*sldt:\n", indent, "");
154 segment_dump(stream, &sregs->ldt, indent + 2);
156 fprintf(stream, "%*sgdt:\n", indent, "");
157 dtable_dump(stream, &sregs->gdt, indent + 2);
158 fprintf(stream, "%*sidt:\n", indent, "");
159 dtable_dump(stream, &sregs->idt, indent + 2);
161 fprintf(stream, "%*scr0: 0x%.16llx cr2: 0x%.16llx "
162 "cr3: 0x%.16llx cr4: 0x%.16llx\n",
164 sregs->cr0, sregs->cr2, sregs->cr3, sregs->cr4);
165 fprintf(stream, "%*scr8: 0x%.16llx efer: 0x%.16llx "
166 "apic_base: 0x%.16llx\n",
168 sregs->cr8, sregs->efer, sregs->apic_base);
170 fprintf(stream, "%*sinterrupt_bitmap:\n", indent, "");
171 for (i = 0; i < (KVM_NR_INTERRUPTS + 63) / 64; i++) {
172 fprintf(stream, "%*s%.16llx\n", indent + 2, "",
173 sregs->interrupt_bitmap[i]);
177 void virt_pgd_alloc(struct kvm_vm *vm)
179 TEST_ASSERT(vm->mode == VM_MODE_PXXV48_4K, "Attempt to use "
180 "unknown or unsupported guest mode, mode: 0x%x", vm->mode);
182 /* If needed, create page map l4 table. */
183 if (!vm->pgd_created) {
184 vm->pgd = vm_alloc_page_table(vm);
185 vm->pgd_created = true;
189 static void *virt_get_pte(struct kvm_vm *vm, uint64_t pt_pfn, uint64_t vaddr,
192 uint64_t *page_table = addr_gpa2hva(vm, pt_pfn << vm->page_shift);
193 int index = vaddr >> (vm->page_shift + level * 9) & 0x1ffu;
195 return &page_table[index];
198 static struct pageUpperEntry *virt_create_upper_pte(struct kvm_vm *vm,
203 enum x86_page_size page_size)
205 struct pageUpperEntry *pte = virt_get_pte(vm, pt_pfn, vaddr, level);
208 pte->writable = true;
210 pte->page_size = (level == page_size);
212 pte->pfn = paddr >> vm->page_shift;
214 pte->pfn = vm_alloc_page_table(vm) >> vm->page_shift;
217 * Entry already present. Assert that the caller doesn't want
218 * a hugepage at this level, and that there isn't a hugepage at
221 TEST_ASSERT(level != page_size,
222 "Cannot create hugepage at level: %u, vaddr: 0x%lx\n",
224 TEST_ASSERT(!pte->page_size,
225 "Cannot create page table at level: %u, vaddr: 0x%lx\n",
231 void __virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr,
232 enum x86_page_size page_size)
234 const uint64_t pg_size = 1ull << ((page_size * 9) + 12);
235 struct pageUpperEntry *pml4e, *pdpe, *pde;
236 struct pageTableEntry *pte;
238 TEST_ASSERT(vm->mode == VM_MODE_PXXV48_4K,
239 "Unknown or unsupported guest mode, mode: 0x%x", vm->mode);
241 TEST_ASSERT((vaddr % pg_size) == 0,
242 "Virtual address not aligned,\n"
243 "vaddr: 0x%lx page size: 0x%lx", vaddr, pg_size);
244 TEST_ASSERT(sparsebit_is_set(vm->vpages_valid, (vaddr >> vm->page_shift)),
245 "Invalid virtual address, vaddr: 0x%lx", vaddr);
246 TEST_ASSERT((paddr % pg_size) == 0,
247 "Physical address not aligned,\n"
248 " paddr: 0x%lx page size: 0x%lx", paddr, pg_size);
249 TEST_ASSERT((paddr >> vm->page_shift) <= vm->max_gfn,
250 "Physical address beyond maximum supported,\n"
251 " paddr: 0x%lx vm->max_gfn: 0x%lx vm->page_size: 0x%x",
252 paddr, vm->max_gfn, vm->page_size);
255 * Allocate upper level page tables, if not already present. Return
256 * early if a hugepage was created.
258 pml4e = virt_create_upper_pte(vm, vm->pgd >> vm->page_shift,
259 vaddr, paddr, 3, page_size);
260 if (pml4e->page_size)
263 pdpe = virt_create_upper_pte(vm, pml4e->pfn, vaddr, paddr, 2, page_size);
267 pde = virt_create_upper_pte(vm, pdpe->pfn, vaddr, paddr, 1, page_size);
271 /* Fill in page table entry. */
272 pte = virt_get_pte(vm, pde->pfn, vaddr, 0);
273 TEST_ASSERT(!pte->present,
274 "PTE already present for 4k page at vaddr: 0x%lx\n", vaddr);
275 pte->pfn = paddr >> vm->page_shift;
276 pte->writable = true;
280 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr)
282 __virt_pg_map(vm, vaddr, paddr, X86_PAGE_SIZE_4K);
285 void virt_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent)
287 struct pageUpperEntry *pml4e, *pml4e_start;
288 struct pageUpperEntry *pdpe, *pdpe_start;
289 struct pageUpperEntry *pde, *pde_start;
290 struct pageTableEntry *pte, *pte_start;
292 if (!vm->pgd_created)
295 fprintf(stream, "%*s "
296 " no\n", indent, "");
297 fprintf(stream, "%*s index hvaddr gpaddr "
298 "addr w exec dirty\n",
300 pml4e_start = (struct pageUpperEntry *) addr_gpa2hva(vm, vm->pgd);
301 for (uint16_t n1 = 0; n1 <= 0x1ffu; n1++) {
302 pml4e = &pml4e_start[n1];
305 fprintf(stream, "%*spml4e 0x%-3zx %p 0x%-12lx 0x%-10lx %u "
308 pml4e - pml4e_start, pml4e,
309 addr_hva2gpa(vm, pml4e), (uint64_t) pml4e->pfn,
310 pml4e->writable, pml4e->execute_disable);
312 pdpe_start = addr_gpa2hva(vm, pml4e->pfn * vm->page_size);
313 for (uint16_t n2 = 0; n2 <= 0x1ffu; n2++) {
314 pdpe = &pdpe_start[n2];
317 fprintf(stream, "%*spdpe 0x%-3zx %p 0x%-12lx 0x%-10lx "
320 pdpe - pdpe_start, pdpe,
321 addr_hva2gpa(vm, pdpe),
322 (uint64_t) pdpe->pfn, pdpe->writable,
323 pdpe->execute_disable);
325 pde_start = addr_gpa2hva(vm, pdpe->pfn * vm->page_size);
326 for (uint16_t n3 = 0; n3 <= 0x1ffu; n3++) {
327 pde = &pde_start[n3];
330 fprintf(stream, "%*spde 0x%-3zx %p "
331 "0x%-12lx 0x%-10lx %u %u\n",
332 indent, "", pde - pde_start, pde,
333 addr_hva2gpa(vm, pde),
334 (uint64_t) pde->pfn, pde->writable,
335 pde->execute_disable);
337 pte_start = addr_gpa2hva(vm, pde->pfn * vm->page_size);
338 for (uint16_t n4 = 0; n4 <= 0x1ffu; n4++) {
339 pte = &pte_start[n4];
342 fprintf(stream, "%*spte 0x%-3zx %p "
343 "0x%-12lx 0x%-10lx %u %u "
346 pte - pte_start, pte,
347 addr_hva2gpa(vm, pte),
350 pte->execute_disable,
352 ((uint64_t) n1 << 27)
353 | ((uint64_t) n2 << 18)
354 | ((uint64_t) n3 << 9)
363 * Set Unusable Segment
368 * segp - Pointer to segment register
372 * Sets the segment register pointed to by @segp to an unusable state.
374 static void kvm_seg_set_unusable(struct kvm_segment *segp)
376 memset(segp, 0, sizeof(*segp));
377 segp->unusable = true;
380 static void kvm_seg_fill_gdt_64bit(struct kvm_vm *vm, struct kvm_segment *segp)
382 void *gdt = addr_gva2hva(vm, vm->gdt);
383 struct desc64 *desc = gdt + (segp->selector >> 3) * 8;
385 desc->limit0 = segp->limit & 0xFFFF;
386 desc->base0 = segp->base & 0xFFFF;
387 desc->base1 = segp->base >> 16;
388 desc->type = segp->type;
390 desc->dpl = segp->dpl;
391 desc->p = segp->present;
392 desc->limit1 = segp->limit >> 16;
393 desc->avl = segp->avl;
397 desc->base2 = segp->base >> 24;
399 desc->base3 = segp->base >> 32;
404 * Set Long Mode Flat Kernel Code Segment
407 * vm - VM whose GDT is being filled, or NULL to only write segp
408 * selector - selector value
411 * segp - Pointer to KVM segment
415 * Sets up the KVM segment pointed to by @segp, to be a code segment
416 * with the selector value given by @selector.
418 static void kvm_seg_set_kernel_code_64bit(struct kvm_vm *vm, uint16_t selector,
419 struct kvm_segment *segp)
421 memset(segp, 0, sizeof(*segp));
422 segp->selector = selector;
423 segp->limit = 0xFFFFFFFFu;
424 segp->s = 0x1; /* kTypeCodeData */
425 segp->type = 0x08 | 0x01 | 0x02; /* kFlagCode | kFlagCodeAccessed
426 * | kFlagCodeReadable
432 kvm_seg_fill_gdt_64bit(vm, segp);
436 * Set Long Mode Flat Kernel Data Segment
439 * vm - VM whose GDT is being filled, or NULL to only write segp
440 * selector - selector value
443 * segp - Pointer to KVM segment
447 * Sets up the KVM segment pointed to by @segp, to be a data segment
448 * with the selector value given by @selector.
450 static void kvm_seg_set_kernel_data_64bit(struct kvm_vm *vm, uint16_t selector,
451 struct kvm_segment *segp)
453 memset(segp, 0, sizeof(*segp));
454 segp->selector = selector;
455 segp->limit = 0xFFFFFFFFu;
456 segp->s = 0x1; /* kTypeCodeData */
457 segp->type = 0x00 | 0x01 | 0x02; /* kFlagData | kFlagDataAccessed
458 * | kFlagDataWritable
461 segp->present = true;
463 kvm_seg_fill_gdt_64bit(vm, segp);
466 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva)
469 struct pageUpperEntry *pml4e, *pdpe, *pde;
470 struct pageTableEntry *pte;
472 TEST_ASSERT(vm->mode == VM_MODE_PXXV48_4K, "Attempt to use "
473 "unknown or unsupported guest mode, mode: 0x%x", vm->mode);
475 index[0] = (gva >> 12) & 0x1ffu;
476 index[1] = (gva >> 21) & 0x1ffu;
477 index[2] = (gva >> 30) & 0x1ffu;
478 index[3] = (gva >> 39) & 0x1ffu;
480 if (!vm->pgd_created)
482 pml4e = addr_gpa2hva(vm, vm->pgd);
483 if (!pml4e[index[3]].present)
486 pdpe = addr_gpa2hva(vm, pml4e[index[3]].pfn * vm->page_size);
487 if (!pdpe[index[2]].present)
490 pde = addr_gpa2hva(vm, pdpe[index[2]].pfn * vm->page_size);
491 if (!pde[index[1]].present)
494 pte = addr_gpa2hva(vm, pde[index[1]].pfn * vm->page_size);
495 if (!pte[index[0]].present)
498 return (pte[index[0]].pfn * vm->page_size) + (gva & 0xfffu);
501 TEST_FAIL("No mapping for vm virtual address, gva: 0x%lx", gva);
505 static void kvm_setup_gdt(struct kvm_vm *vm, struct kvm_dtable *dt)
508 vm->gdt = vm_vaddr_alloc_page(vm);
511 dt->limit = getpagesize();
514 static void kvm_setup_tss_64bit(struct kvm_vm *vm, struct kvm_segment *segp,
518 vm->tss = vm_vaddr_alloc_page(vm);
520 memset(segp, 0, sizeof(*segp));
521 segp->base = vm->tss;
523 segp->selector = selector;
526 kvm_seg_fill_gdt_64bit(vm, segp);
529 static void vcpu_setup(struct kvm_vm *vm, int vcpuid)
531 struct kvm_sregs sregs;
533 /* Set mode specific system register values. */
534 vcpu_sregs_get(vm, vcpuid, &sregs);
538 kvm_setup_gdt(vm, &sregs.gdt);
541 case VM_MODE_PXXV48_4K:
542 sregs.cr0 = X86_CR0_PE | X86_CR0_NE | X86_CR0_PG;
543 sregs.cr4 |= X86_CR4_PAE | X86_CR4_OSFXSR;
544 sregs.efer |= (EFER_LME | EFER_LMA | EFER_NX);
546 kvm_seg_set_unusable(&sregs.ldt);
547 kvm_seg_set_kernel_code_64bit(vm, DEFAULT_CODE_SELECTOR, &sregs.cs);
548 kvm_seg_set_kernel_data_64bit(vm, DEFAULT_DATA_SELECTOR, &sregs.ds);
549 kvm_seg_set_kernel_data_64bit(vm, DEFAULT_DATA_SELECTOR, &sregs.es);
550 kvm_setup_tss_64bit(vm, &sregs.tr, 0x18);
554 TEST_FAIL("Unknown guest mode, mode: 0x%x", vm->mode);
558 vcpu_sregs_set(vm, vcpuid, &sregs);
561 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code)
563 struct kvm_mp_state mp_state;
564 struct kvm_regs regs;
565 vm_vaddr_t stack_vaddr;
566 stack_vaddr = vm_vaddr_alloc(vm, DEFAULT_STACK_PGS * getpagesize(),
567 DEFAULT_GUEST_STACK_VADDR_MIN);
570 vm_vcpu_add(vm, vcpuid);
571 vcpu_setup(vm, vcpuid);
573 /* Setup guest general purpose registers */
574 vcpu_regs_get(vm, vcpuid, ®s);
575 regs.rflags = regs.rflags | 0x2;
576 regs.rsp = stack_vaddr + (DEFAULT_STACK_PGS * getpagesize());
577 regs.rip = (unsigned long) guest_code;
578 vcpu_regs_set(vm, vcpuid, ®s);
580 /* Setup the MP state */
581 mp_state.mp_state = 0;
582 vcpu_set_mp_state(vm, vcpuid, &mp_state);
584 /* Setup supported CPUIDs */
585 vcpu_set_cpuid(vm, vcpuid, kvm_get_supported_cpuid());
589 * Allocate an instance of struct kvm_cpuid2
595 * Return: A pointer to the allocated struct. The caller is responsible
596 * for freeing this struct.
598 * Since kvm_cpuid2 uses a 0-length array to allow a the size of the
599 * array to be decided at allocation time, allocation is slightly
600 * complicated. This function uses a reasonable default length for
601 * the array and performs the appropriate allocation.
603 static struct kvm_cpuid2 *allocate_kvm_cpuid2(void)
605 struct kvm_cpuid2 *cpuid;
609 size = sizeof(*cpuid);
610 size += nent * sizeof(struct kvm_cpuid_entry2);
611 cpuid = malloc(size);
623 * KVM Supported CPUID Get
629 * Return: The supported KVM CPUID
631 * Get the guest CPUID supported by KVM.
633 struct kvm_cpuid2 *kvm_get_supported_cpuid(void)
635 static struct kvm_cpuid2 *cpuid;
642 cpuid = allocate_kvm_cpuid2();
643 kvm_fd = open_kvm_dev_path_or_exit();
645 ret = ioctl(kvm_fd, KVM_GET_SUPPORTED_CPUID, cpuid);
646 TEST_ASSERT(ret == 0, "KVM_GET_SUPPORTED_CPUID failed %d %d\n",
657 * msr_index - Index of MSR
661 * Return: On success, value of the MSR. On failure a TEST_ASSERT is produced.
663 * Get value of MSR for VCPU.
665 uint64_t kvm_get_feature_msr(uint64_t msr_index)
668 struct kvm_msrs header;
669 struct kvm_msr_entry entry;
673 buffer.header.nmsrs = 1;
674 buffer.entry.index = msr_index;
675 kvm_fd = open_kvm_dev_path_or_exit();
677 r = ioctl(kvm_fd, KVM_GET_MSRS, &buffer.header);
678 TEST_ASSERT(r == 1, "KVM_GET_MSRS IOCTL failed,\n"
679 " rc: %i errno: %i", r, errno);
682 return buffer.entry.data;
689 * vm - Virtual Machine
694 * Return: KVM CPUID (KVM_GET_CPUID2)
696 * Set the VCPU's CPUID.
698 struct kvm_cpuid2 *vcpu_get_cpuid(struct kvm_vm *vm, uint32_t vcpuid)
700 struct vcpu *vcpu = vcpu_find(vm, vcpuid);
701 struct kvm_cpuid2 *cpuid;
705 TEST_ASSERT(vcpu != NULL, "vcpu not found, vcpuid: %u", vcpuid);
707 cpuid = allocate_kvm_cpuid2();
708 max_ent = cpuid->nent;
710 for (cpuid->nent = 1; cpuid->nent <= max_ent; cpuid->nent++) {
711 rc = ioctl(vcpu->fd, KVM_GET_CPUID2, cpuid);
715 TEST_ASSERT(rc == -1 && errno == E2BIG,
716 "KVM_GET_CPUID2 should either succeed or give E2BIG: %d %d",
720 TEST_ASSERT(rc == 0, "KVM_GET_CPUID2 failed, rc: %i errno: %i",
729 * Locate a cpuid entry.
732 * function: The function of the cpuid entry to find.
733 * index: The index of the cpuid entry.
737 * Return: A pointer to the cpuid entry. Never returns NULL.
739 struct kvm_cpuid_entry2 *
740 kvm_get_supported_cpuid_index(uint32_t function, uint32_t index)
742 struct kvm_cpuid2 *cpuid;
743 struct kvm_cpuid_entry2 *entry = NULL;
746 cpuid = kvm_get_supported_cpuid();
747 for (i = 0; i < cpuid->nent; i++) {
748 if (cpuid->entries[i].function == function &&
749 cpuid->entries[i].index == index) {
750 entry = &cpuid->entries[i];
755 TEST_ASSERT(entry, "Guest CPUID entry not found: (EAX=%x, ECX=%x).",
764 * vm - Virtual Machine
766 * cpuid - The CPUID values to set.
772 * Set the VCPU's CPUID.
774 void vcpu_set_cpuid(struct kvm_vm *vm,
775 uint32_t vcpuid, struct kvm_cpuid2 *cpuid)
777 struct vcpu *vcpu = vcpu_find(vm, vcpuid);
780 TEST_ASSERT(vcpu != NULL, "vcpu not found, vcpuid: %u", vcpuid);
782 rc = ioctl(vcpu->fd, KVM_SET_CPUID2, cpuid);
783 TEST_ASSERT(rc == 0, "KVM_SET_CPUID2 failed, rc: %i errno: %i",
792 * vm - Virtual Machine
794 * msr_index - Index of MSR
798 * Return: On success, value of the MSR. On failure a TEST_ASSERT is produced.
800 * Get value of MSR for VCPU.
802 uint64_t vcpu_get_msr(struct kvm_vm *vm, uint32_t vcpuid, uint64_t msr_index)
804 struct vcpu *vcpu = vcpu_find(vm, vcpuid);
806 struct kvm_msrs header;
807 struct kvm_msr_entry entry;
811 TEST_ASSERT(vcpu != NULL, "vcpu not found, vcpuid: %u", vcpuid);
812 buffer.header.nmsrs = 1;
813 buffer.entry.index = msr_index;
814 r = ioctl(vcpu->fd, KVM_GET_MSRS, &buffer.header);
815 TEST_ASSERT(r == 1, "KVM_GET_MSRS IOCTL failed,\n"
816 " rc: %i errno: %i", r, errno);
818 return buffer.entry.data;
825 * vm - Virtual Machine
827 * msr_index - Index of MSR
828 * msr_value - New value of MSR
832 * Return: The result of KVM_SET_MSRS.
834 * Sets the value of an MSR for the given VCPU.
836 int _vcpu_set_msr(struct kvm_vm *vm, uint32_t vcpuid, uint64_t msr_index,
839 struct vcpu *vcpu = vcpu_find(vm, vcpuid);
841 struct kvm_msrs header;
842 struct kvm_msr_entry entry;
846 TEST_ASSERT(vcpu != NULL, "vcpu not found, vcpuid: %u", vcpuid);
847 memset(&buffer, 0, sizeof(buffer));
848 buffer.header.nmsrs = 1;
849 buffer.entry.index = msr_index;
850 buffer.entry.data = msr_value;
851 r = ioctl(vcpu->fd, KVM_SET_MSRS, &buffer.header);
859 * vm - Virtual Machine
861 * msr_index - Index of MSR
862 * msr_value - New value of MSR
866 * Return: On success, nothing. On failure a TEST_ASSERT is produced.
868 * Set value of MSR for VCPU.
870 void vcpu_set_msr(struct kvm_vm *vm, uint32_t vcpuid, uint64_t msr_index,
875 r = _vcpu_set_msr(vm, vcpuid, msr_index, msr_value);
876 TEST_ASSERT(r == 1, "KVM_SET_MSRS IOCTL failed,\n"
877 " rc: %i errno: %i", r, errno);
880 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...)
883 struct kvm_regs regs;
885 TEST_ASSERT(num >= 1 && num <= 6, "Unsupported number of args,\n"
890 vcpu_regs_get(vm, vcpuid, ®s);
893 regs.rdi = va_arg(ap, uint64_t);
896 regs.rsi = va_arg(ap, uint64_t);
899 regs.rdx = va_arg(ap, uint64_t);
902 regs.rcx = va_arg(ap, uint64_t);
905 regs.r8 = va_arg(ap, uint64_t);
908 regs.r9 = va_arg(ap, uint64_t);
910 vcpu_regs_set(vm, vcpuid, ®s);
914 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid, uint8_t indent)
916 struct kvm_regs regs;
917 struct kvm_sregs sregs;
919 fprintf(stream, "%*scpuid: %u\n", indent, "", vcpuid);
921 fprintf(stream, "%*sregs:\n", indent + 2, "");
922 vcpu_regs_get(vm, vcpuid, ®s);
923 regs_dump(stream, ®s, indent + 4);
925 fprintf(stream, "%*ssregs:\n", indent + 2, "");
926 vcpu_sregs_get(vm, vcpuid, &sregs);
927 sregs_dump(stream, &sregs, indent + 4);
930 struct kvm_x86_state {
931 struct kvm_vcpu_events events;
932 struct kvm_mp_state mp_state;
933 struct kvm_regs regs;
934 struct kvm_xsave xsave;
935 struct kvm_xcrs xcrs;
936 struct kvm_sregs sregs;
937 struct kvm_debugregs debugregs;
939 struct kvm_nested_state nested;
942 struct kvm_msrs msrs;
945 static int kvm_get_num_msrs_fd(int kvm_fd)
947 struct kvm_msr_list nmsrs;
951 r = ioctl(kvm_fd, KVM_GET_MSR_INDEX_LIST, &nmsrs);
952 TEST_ASSERT(r == -1 && errno == E2BIG, "Unexpected result from KVM_GET_MSR_INDEX_LIST probe, r: %i",
958 static int kvm_get_num_msrs(struct kvm_vm *vm)
960 return kvm_get_num_msrs_fd(vm->kvm_fd);
963 struct kvm_msr_list *kvm_get_msr_index_list(void)
965 struct kvm_msr_list *list;
966 int nmsrs, r, kvm_fd;
968 kvm_fd = open_kvm_dev_path_or_exit();
970 nmsrs = kvm_get_num_msrs_fd(kvm_fd);
971 list = malloc(sizeof(*list) + nmsrs * sizeof(list->indices[0]));
973 r = ioctl(kvm_fd, KVM_GET_MSR_INDEX_LIST, list);
976 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_MSR_INDEX_LIST, r: %i",
982 struct kvm_x86_state *vcpu_save_state(struct kvm_vm *vm, uint32_t vcpuid)
984 struct vcpu *vcpu = vcpu_find(vm, vcpuid);
985 struct kvm_msr_list *list;
986 struct kvm_x86_state *state;
988 static int nested_size = -1;
990 if (nested_size == -1) {
991 nested_size = kvm_check_cap(KVM_CAP_NESTED_STATE);
992 TEST_ASSERT(nested_size <= sizeof(state->nested_),
993 "Nested state size too big, %i > %zi",
994 nested_size, sizeof(state->nested_));
998 * When KVM exits to userspace with KVM_EXIT_IO, KVM guarantees
999 * guest state is consistent only after userspace re-enters the
1000 * kernel with KVM_RUN. Complete IO prior to migrating state
1003 vcpu_run_complete_io(vm, vcpuid);
1005 nmsrs = kvm_get_num_msrs(vm);
1006 list = malloc(sizeof(*list) + nmsrs * sizeof(list->indices[0]));
1007 list->nmsrs = nmsrs;
1008 r = ioctl(vm->kvm_fd, KVM_GET_MSR_INDEX_LIST, list);
1009 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_MSR_INDEX_LIST, r: %i",
1012 state = malloc(sizeof(*state) + nmsrs * sizeof(state->msrs.entries[0]));
1013 r = ioctl(vcpu->fd, KVM_GET_VCPU_EVENTS, &state->events);
1014 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_VCPU_EVENTS, r: %i",
1017 r = ioctl(vcpu->fd, KVM_GET_MP_STATE, &state->mp_state);
1018 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_MP_STATE, r: %i",
1021 r = ioctl(vcpu->fd, KVM_GET_REGS, &state->regs);
1022 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_REGS, r: %i",
1025 r = ioctl(vcpu->fd, KVM_GET_XSAVE, &state->xsave);
1026 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_XSAVE, r: %i",
1029 if (kvm_check_cap(KVM_CAP_XCRS)) {
1030 r = ioctl(vcpu->fd, KVM_GET_XCRS, &state->xcrs);
1031 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_XCRS, r: %i",
1035 r = ioctl(vcpu->fd, KVM_GET_SREGS, &state->sregs);
1036 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_SREGS, r: %i",
1040 state->nested.size = sizeof(state->nested_);
1041 r = ioctl(vcpu->fd, KVM_GET_NESTED_STATE, &state->nested);
1042 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_NESTED_STATE, r: %i",
1044 TEST_ASSERT(state->nested.size <= nested_size,
1045 "Nested state size too big, %i (KVM_CHECK_CAP gave %i)",
1046 state->nested.size, nested_size);
1048 state->nested.size = 0;
1050 state->msrs.nmsrs = nmsrs;
1051 for (i = 0; i < nmsrs; i++)
1052 state->msrs.entries[i].index = list->indices[i];
1053 r = ioctl(vcpu->fd, KVM_GET_MSRS, &state->msrs);
1054 TEST_ASSERT(r == nmsrs, "Unexpected result from KVM_GET_MSRS, r: %i (failed MSR was 0x%x)",
1055 r, r == nmsrs ? -1 : list->indices[r]);
1057 r = ioctl(vcpu->fd, KVM_GET_DEBUGREGS, &state->debugregs);
1058 TEST_ASSERT(r == 0, "Unexpected result from KVM_GET_DEBUGREGS, r: %i",
1065 void vcpu_load_state(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_x86_state *state)
1067 struct vcpu *vcpu = vcpu_find(vm, vcpuid);
1070 r = ioctl(vcpu->fd, KVM_SET_XSAVE, &state->xsave);
1071 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_XSAVE, r: %i",
1074 if (kvm_check_cap(KVM_CAP_XCRS)) {
1075 r = ioctl(vcpu->fd, KVM_SET_XCRS, &state->xcrs);
1076 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_XCRS, r: %i",
1080 r = ioctl(vcpu->fd, KVM_SET_SREGS, &state->sregs);
1081 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_SREGS, r: %i",
1084 r = ioctl(vcpu->fd, KVM_SET_MSRS, &state->msrs);
1085 TEST_ASSERT(r == state->msrs.nmsrs, "Unexpected result from KVM_SET_MSRS, r: %i (failed at %x)",
1086 r, r == state->msrs.nmsrs ? -1 : state->msrs.entries[r].index);
1088 r = ioctl(vcpu->fd, KVM_SET_VCPU_EVENTS, &state->events);
1089 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_VCPU_EVENTS, r: %i",
1092 r = ioctl(vcpu->fd, KVM_SET_MP_STATE, &state->mp_state);
1093 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_MP_STATE, r: %i",
1096 r = ioctl(vcpu->fd, KVM_SET_DEBUGREGS, &state->debugregs);
1097 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_DEBUGREGS, r: %i",
1100 r = ioctl(vcpu->fd, KVM_SET_REGS, &state->regs);
1101 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_REGS, r: %i",
1104 if (state->nested.size) {
1105 r = ioctl(vcpu->fd, KVM_SET_NESTED_STATE, &state->nested);
1106 TEST_ASSERT(r == 0, "Unexpected result from KVM_SET_NESTED_STATE, r: %i",
1111 bool is_intel_cpu(void)
1113 int eax, ebx, ecx, edx;
1114 const uint32_t *chunk;
1117 __asm__ __volatile__(
1119 : /* output */ "=a"(eax), "=b"(ebx),
1120 "=c"(ecx), "=d"(edx)
1121 : /* input */ "0"(leaf), "2"(0));
1123 chunk = (const uint32_t *)("GenuineIntel");
1124 return (ebx == chunk[0] && edx == chunk[1] && ecx == chunk[2]);
1127 uint32_t kvm_get_cpuid_max_basic(void)
1129 return kvm_get_supported_cpuid_entry(0)->eax;
1132 uint32_t kvm_get_cpuid_max_extended(void)
1134 return kvm_get_supported_cpuid_entry(0x80000000)->eax;
1137 void kvm_get_cpu_address_width(unsigned int *pa_bits, unsigned int *va_bits)
1139 struct kvm_cpuid_entry2 *entry;
1143 if (kvm_get_cpuid_max_extended() < 0x80000008) {
1144 pae = kvm_get_supported_cpuid_entry(1)->edx & (1 << 6);
1145 *pa_bits = pae ? 36 : 32;
1148 entry = kvm_get_supported_cpuid_entry(0x80000008);
1149 *pa_bits = entry->eax & 0xff;
1150 *va_bits = (entry->eax >> 8) & 0xff;
1164 uint32_t offset2; uint32_t reserved;
1167 static void set_idt_entry(struct kvm_vm *vm, int vector, unsigned long addr,
1168 int dpl, unsigned short selector)
1170 struct idt_entry *base =
1171 (struct idt_entry *)addr_gva2hva(vm, vm->idt);
1172 struct idt_entry *e = &base[vector];
1174 memset(e, 0, sizeof(*e));
1176 e->selector = selector;
1181 e->offset1 = addr >> 16;
1182 e->offset2 = addr >> 32;
1185 void kvm_exit_unexpected_vector(uint32_t value)
1187 outl(UNEXPECTED_VECTOR_PORT, value);
1190 void route_exception(struct ex_regs *regs)
1192 typedef void(*handler)(struct ex_regs *);
1193 handler *handlers = (handler *)exception_handlers;
1195 if (handlers && handlers[regs->vector]) {
1196 handlers[regs->vector](regs);
1200 kvm_exit_unexpected_vector(regs->vector);
1203 void vm_init_descriptor_tables(struct kvm_vm *vm)
1205 extern void *idt_handlers;
1208 vm->idt = vm_vaddr_alloc_page(vm);
1209 vm->handlers = vm_vaddr_alloc_page(vm);
1210 /* Handlers have the same address in both address spaces.*/
1211 for (i = 0; i < NUM_INTERRUPTS; i++)
1212 set_idt_entry(vm, i, (unsigned long)(&idt_handlers)[i], 0,
1213 DEFAULT_CODE_SELECTOR);
1216 void vcpu_init_descriptor_tables(struct kvm_vm *vm, uint32_t vcpuid)
1218 struct kvm_sregs sregs;
1220 vcpu_sregs_get(vm, vcpuid, &sregs);
1221 sregs.idt.base = vm->idt;
1222 sregs.idt.limit = NUM_INTERRUPTS * sizeof(struct idt_entry) - 1;
1223 sregs.gdt.base = vm->gdt;
1224 sregs.gdt.limit = getpagesize() - 1;
1225 kvm_seg_set_kernel_data_64bit(NULL, DEFAULT_DATA_SELECTOR, &sregs.gs);
1226 vcpu_sregs_set(vm, vcpuid, &sregs);
1227 *(vm_vaddr_t *)addr_gva2hva(vm, (vm_vaddr_t)(&exception_handlers)) = vm->handlers;
1230 void vm_handle_exception(struct kvm_vm *vm, int vector,
1231 void (*handler)(struct ex_regs *))
1233 vm_vaddr_t *handlers = (vm_vaddr_t *)addr_gva2hva(vm, vm->handlers);
1235 handlers[vector] = (vm_vaddr_t)handler;
1238 void assert_on_unhandled_exception(struct kvm_vm *vm, uint32_t vcpuid)
1240 if (vcpu_state(vm, vcpuid)->exit_reason == KVM_EXIT_IO
1241 && vcpu_state(vm, vcpuid)->io.port == UNEXPECTED_VECTOR_PORT
1242 && vcpu_state(vm, vcpuid)->io.size == 4) {
1243 /* Grab pointer to io data */
1244 uint32_t *data = (void *)vcpu_state(vm, vcpuid)
1245 + vcpu_state(vm, vcpuid)->io.data_offset;
1248 "Unexpected vectored event in guest (vector:0x%x)",
1253 bool set_cpuid(struct kvm_cpuid2 *cpuid,
1254 struct kvm_cpuid_entry2 *ent)
1258 for (i = 0; i < cpuid->nent; i++) {
1259 struct kvm_cpuid_entry2 *cur = &cpuid->entries[i];
1261 if (cur->function != ent->function || cur->index != ent->index)
1264 memcpy(cur, ent, sizeof(struct kvm_cpuid_entry2));
1271 uint64_t kvm_hypercall(uint64_t nr, uint64_t a0, uint64_t a1, uint64_t a2,
1276 asm volatile("vmcall"
1278 : "b"(a0), "c"(a1), "d"(a2), "S"(a3));
1282 struct kvm_cpuid2 *kvm_get_supported_hv_cpuid(void)
1284 static struct kvm_cpuid2 *cpuid;
1291 cpuid = allocate_kvm_cpuid2();
1292 kvm_fd = open_kvm_dev_path_or_exit();
1294 ret = ioctl(kvm_fd, KVM_GET_SUPPORTED_HV_CPUID, cpuid);
1295 TEST_ASSERT(ret == 0, "KVM_GET_SUPPORTED_HV_CPUID failed %d %d\n",
1302 void vcpu_set_hv_cpuid(struct kvm_vm *vm, uint32_t vcpuid)
1304 static struct kvm_cpuid2 *cpuid_full;
1305 struct kvm_cpuid2 *cpuid_sys, *cpuid_hv;
1309 cpuid_sys = kvm_get_supported_cpuid();
1310 cpuid_hv = kvm_get_supported_hv_cpuid();
1312 cpuid_full = malloc(sizeof(*cpuid_full) +
1313 (cpuid_sys->nent + cpuid_hv->nent) *
1314 sizeof(struct kvm_cpuid_entry2));
1320 /* Need to skip KVM CPUID leaves 0x400000xx */
1321 for (i = 0; i < cpuid_sys->nent; i++) {
1322 if (cpuid_sys->entries[i].function >= 0x40000000 &&
1323 cpuid_sys->entries[i].function < 0x40000100)
1325 cpuid_full->entries[nent] = cpuid_sys->entries[i];
1329 memcpy(&cpuid_full->entries[nent], cpuid_hv->entries,
1330 cpuid_hv->nent * sizeof(struct kvm_cpuid_entry2));
1331 cpuid_full->nent = nent + cpuid_hv->nent;
1334 vcpu_set_cpuid(vm, vcpuid, cpuid_full);
1337 struct kvm_cpuid2 *vcpu_get_supported_hv_cpuid(struct kvm_vm *vm, uint32_t vcpuid)
1339 static struct kvm_cpuid2 *cpuid;
1341 cpuid = allocate_kvm_cpuid2();
1343 vcpu_ioctl(vm, vcpuid, KVM_GET_SUPPORTED_HV_CPUID, cpuid);