2 * TPR optimization for 32-bit Windows guests (XP and Server 2003)
4 * Copyright (C) 2007-2008 Qumranet Technologies
5 * Copyright (C) 2012 Jan Kiszka, Siemens AG
7 * This work is licensed under the terms of the GNU GPL version 2, or
8 * (at your option) any later version. See the COPYING file in the
14 #include "apic_internal.h"
16 #define APIC_DEFAULT_ADDRESS 0xfee00000
18 #define VAPIC_IO_PORT 0x7e
20 #define VAPIC_CPU_SHIFT 7
22 #define ROM_BLOCK_SIZE 512
23 #define ROM_BLOCK_MASK (~(ROM_BLOCK_SIZE - 1))
25 typedef enum VAPICMode {
31 typedef struct VAPICHandlers {
35 uint32_t get_tpr_stack;
36 } QEMU_PACKED VAPICHandlers;
38 typedef struct GuestROMState {
46 uint32_t real_tpr_addr;
49 } QEMU_PACKED GuestROMState;
51 typedef struct VAPICROMState {
56 uint32_t rom_state_paddr;
57 uint32_t rom_state_vaddr;
59 uint32_t real_tpr_addr;
60 GuestROMState rom_state;
62 bool rom_mapped_writable;
65 #define TPR_INSTR_ABS_MODRM 0x1
66 #define TPR_INSTR_MATCH_MODRM_REG 0x2
68 typedef struct TPRInstruction {
77 /* must be sorted by length, shortest first */
78 static const TPRInstruction tpr_instr[] = {
79 { /* mov abs to eax */
81 .access = TPR_ACCESS_READ,
85 { /* mov eax to abs */
87 .access = TPR_ACCESS_WRITE,
91 { /* mov r32 to r/m32 */
93 .flags = TPR_INSTR_ABS_MODRM,
94 .access = TPR_ACCESS_WRITE,
98 { /* mov r/m32 to r32 */
100 .flags = TPR_INSTR_ABS_MODRM,
101 .access = TPR_ACCESS_READ,
108 .flags = TPR_INSTR_ABS_MODRM | TPR_INSTR_MATCH_MODRM_REG,
109 .access = TPR_ACCESS_READ,
113 { /* mov imm32, r/m32 (c7/0) */
116 .flags = TPR_INSTR_ABS_MODRM | TPR_INSTR_MATCH_MODRM_REG,
117 .access = TPR_ACCESS_WRITE,
123 static void read_guest_rom_state(VAPICROMState *s)
125 cpu_physical_memory_rw(s->rom_state_paddr, (void *)&s->rom_state,
126 sizeof(GuestROMState), 0);
129 static void write_guest_rom_state(VAPICROMState *s)
131 cpu_physical_memory_rw(s->rom_state_paddr, (void *)&s->rom_state,
132 sizeof(GuestROMState), 1);
135 static void update_guest_rom_state(VAPICROMState *s)
137 read_guest_rom_state(s);
139 s->rom_state.real_tpr_addr = cpu_to_le32(s->real_tpr_addr);
140 s->rom_state.vcpu_shift = cpu_to_le32(VAPIC_CPU_SHIFT);
142 write_guest_rom_state(s);
145 static int find_real_tpr_addr(VAPICROMState *s, CPUX86State *env)
147 target_phys_addr_t paddr;
150 if (s->state == VAPIC_ACTIVE) {
154 * If there is no prior TPR access instruction we could analyze (which is
155 * the case after resume from hibernation), we need to scan the possible
156 * virtual address space for the APIC mapping.
158 for (addr = 0xfffff000; addr >= 0x80000000; addr -= TARGET_PAGE_SIZE) {
159 paddr = cpu_get_phys_page_debug(env, addr);
160 if (paddr != APIC_DEFAULT_ADDRESS) {
163 s->real_tpr_addr = addr + 0x80;
164 update_guest_rom_state(s);
170 static uint8_t modrm_reg(uint8_t modrm)
172 return (modrm >> 3) & 7;
175 static bool is_abs_modrm(uint8_t modrm)
177 return (modrm & 0xc7) == 0x05;
180 static bool opcode_matches(uint8_t *opcode, const TPRInstruction *instr)
182 return opcode[0] == instr->opcode &&
183 (!(instr->flags & TPR_INSTR_ABS_MODRM) || is_abs_modrm(opcode[1])) &&
184 (!(instr->flags & TPR_INSTR_MATCH_MODRM_REG) ||
185 modrm_reg(opcode[1]) == instr->modrm_reg);
188 static int evaluate_tpr_instruction(VAPICROMState *s, CPUX86State *env,
189 target_ulong *pip, TPRAccess access)
191 const TPRInstruction *instr;
192 target_ulong ip = *pip;
194 uint32_t real_tpr_addr;
197 if ((ip & 0xf0000000ULL) != 0x80000000ULL &&
198 (ip & 0xf0000000ULL) != 0xe0000000ULL) {
203 * Early Windows 2003 SMP initialization contains a
207 * instruction that is patched by TPR optimization. The problem is that
208 * RSP, used by the patched instruction, is zero, so the guest gets a
209 * double fault and dies.
211 if (env->regs[R_ESP] == 0) {
215 if (kvm_enabled() && !kvm_irqchip_in_kernel()) {
217 * KVM without kernel-based TPR access reporting will pass an IP that
218 * points after the accessing instruction. So we need to look backward
219 * to find the reason.
221 for (i = 0; i < ARRAY_SIZE(tpr_instr); i++) {
222 instr = &tpr_instr[i];
223 if (instr->access != access) {
226 if (cpu_memory_rw_debug(env, ip - instr->length, opcode,
227 sizeof(opcode), 0) < 0) {
230 if (opcode_matches(opcode, instr)) {
237 if (cpu_memory_rw_debug(env, ip, opcode, sizeof(opcode), 0) < 0) {
240 for (i = 0; i < ARRAY_SIZE(tpr_instr); i++) {
241 instr = &tpr_instr[i];
242 if (opcode_matches(opcode, instr)) {
251 * Grab the virtual TPR address from the instruction
252 * and update the cached values.
254 if (cpu_memory_rw_debug(env, ip + instr->addr_offset,
255 (void *)&real_tpr_addr,
256 sizeof(real_tpr_addr), 0) < 0) {
259 real_tpr_addr = le32_to_cpu(real_tpr_addr);
260 if ((real_tpr_addr & 0xfff) != 0x80) {
263 s->real_tpr_addr = real_tpr_addr;
264 update_guest_rom_state(s);
270 static int update_rom_mapping(VAPICROMState *s, CPUX86State *env, target_ulong ip)
272 target_phys_addr_t paddr;
273 uint32_t rom_state_vaddr;
274 uint32_t pos, patch, offset;
276 /* nothing to do if already activated */
277 if (s->state == VAPIC_ACTIVE) {
281 /* bail out if ROM init code was not executed (missing ROM?) */
282 if (s->state == VAPIC_INACTIVE) {
286 /* find out virtual address of the ROM */
287 rom_state_vaddr = s->rom_state_paddr + (ip & 0xf0000000);
288 paddr = cpu_get_phys_page_debug(env, rom_state_vaddr);
292 paddr += rom_state_vaddr & ~TARGET_PAGE_MASK;
293 if (paddr != s->rom_state_paddr) {
296 read_guest_rom_state(s);
297 if (memcmp(s->rom_state.signature, "kvm aPiC", 8) != 0) {
300 s->rom_state_vaddr = rom_state_vaddr;
302 /* fixup addresses in ROM if needed */
303 if (rom_state_vaddr == le32_to_cpu(s->rom_state.vaddr)) {
306 for (pos = le32_to_cpu(s->rom_state.fixup_start);
307 pos < le32_to_cpu(s->rom_state.fixup_end);
309 cpu_physical_memory_rw(paddr + pos - s->rom_state.vaddr,
310 (void *)&offset, sizeof(offset), 0);
311 offset = le32_to_cpu(offset);
312 cpu_physical_memory_rw(paddr + offset, (void *)&patch,
314 patch = le32_to_cpu(patch);
315 patch += rom_state_vaddr - le32_to_cpu(s->rom_state.vaddr);
316 patch = cpu_to_le32(patch);
317 cpu_physical_memory_rw(paddr + offset, (void *)&patch,
320 read_guest_rom_state(s);
321 s->vapic_paddr = paddr + le32_to_cpu(s->rom_state.vapic_vaddr) -
322 le32_to_cpu(s->rom_state.vaddr);
328 * Tries to read the unique processor number from the Kernel Processor Control
329 * Region (KPCR) of 32-bit Windows XP and Server 2003. Returns -1 if the KPCR
330 * cannot be accessed or is considered invalid. This also ensures that we are
331 * not patching the wrong guest.
333 static int get_kpcr_number(CPUX86State *env)
342 if (cpu_memory_rw_debug(env, env->segs[R_FS].base,
343 (void *)&kpcr, sizeof(kpcr), 0) < 0 ||
344 kpcr.self != env->segs[R_FS].base) {
350 static int vapic_enable(VAPICROMState *s, CPUX86State *env)
352 int cpu_number = get_kpcr_number(env);
353 target_phys_addr_t vapic_paddr;
354 static const uint8_t enabled = 1;
356 if (cpu_number < 0) {
359 vapic_paddr = s->vapic_paddr +
360 (((target_phys_addr_t)cpu_number) << VAPIC_CPU_SHIFT);
361 cpu_physical_memory_rw(vapic_paddr + offsetof(VAPICState, enabled),
362 (void *)&enabled, sizeof(enabled), 1);
363 apic_enable_vapic(env->apic_state, vapic_paddr);
365 s->state = VAPIC_ACTIVE;
370 static void patch_byte(CPUX86State *env, target_ulong addr, uint8_t byte)
372 cpu_memory_rw_debug(env, addr, &byte, 1, 1);
375 static void patch_call(VAPICROMState *s, CPUX86State *env, target_ulong ip,
380 offset = cpu_to_le32(target - ip - 5);
381 patch_byte(env, ip, 0xe8); /* call near */
382 cpu_memory_rw_debug(env, ip + 1, (void *)&offset, sizeof(offset), 1);
385 static void patch_instruction(VAPICROMState *s, CPUX86State *env, target_ulong ip)
387 target_phys_addr_t paddr;
388 VAPICHandlers *handlers;
393 handlers = &s->rom_state.up;
395 handlers = &s->rom_state.mp;
400 cpu_memory_rw_debug(env, ip, opcode, sizeof(opcode), 0);
403 case 0x89: /* mov r32 to r/m32 */
404 patch_byte(env, ip, 0x50 + modrm_reg(opcode[1])); /* push reg */
405 patch_call(s, env, ip + 1, handlers->set_tpr);
407 case 0x8b: /* mov r/m32 to r32 */
408 patch_byte(env, ip, 0x90);
409 patch_call(s, env, ip + 1, handlers->get_tpr[modrm_reg(opcode[1])]);
411 case 0xa1: /* mov abs to eax */
412 patch_call(s, env, ip, handlers->get_tpr[0]);
414 case 0xa3: /* mov eax to abs */
415 patch_call(s, env, ip, handlers->set_tpr_eax);
417 case 0xc7: /* mov imm32, r/m32 (c7/0) */
418 patch_byte(env, ip, 0x68); /* push imm32 */
419 cpu_memory_rw_debug(env, ip + 6, (void *)&imm32, sizeof(imm32), 0);
420 cpu_memory_rw_debug(env, ip + 1, (void *)&imm32, sizeof(imm32), 1);
421 patch_call(s, env, ip + 5, handlers->set_tpr);
423 case 0xff: /* push r/m32 */
424 patch_byte(env, ip, 0x50); /* push eax */
425 patch_call(s, env, ip + 1, handlers->get_tpr_stack);
433 paddr = cpu_get_phys_page_debug(env, ip);
434 paddr += ip & ~TARGET_PAGE_MASK;
435 tb_invalidate_phys_page_range(paddr, paddr + 1, 1);
438 void vapic_report_tpr_access(DeviceState *dev, void *cpu, target_ulong ip,
441 VAPICROMState *s = DO_UPCAST(VAPICROMState, busdev.qdev, dev);
442 CPUX86State *env = cpu;
444 cpu_synchronize_state(env);
446 if (evaluate_tpr_instruction(s, env, &ip, access) < 0) {
447 if (s->state == VAPIC_ACTIVE) {
448 vapic_enable(s, env);
452 if (update_rom_mapping(s, env, ip) < 0) {
455 if (vapic_enable(s, env) < 0) {
458 patch_instruction(s, env, ip);
461 typedef struct VAPICEnableTPRReporting {
464 } VAPICEnableTPRReporting;
466 static void vapic_do_enable_tpr_reporting(void *data)
468 VAPICEnableTPRReporting *info = data;
470 apic_enable_tpr_access_reporting(info->apic, info->enable);
473 static void vapic_enable_tpr_reporting(bool enable)
475 VAPICEnableTPRReporting info = {
480 for (env = first_cpu; env != NULL; env = env->next_cpu) {
481 info.apic = env->apic_state;
482 run_on_cpu(env, vapic_do_enable_tpr_reporting, &info);
486 static void vapic_reset(DeviceState *dev)
488 VAPICROMState *s = DO_UPCAST(VAPICROMState, busdev.qdev, dev);
490 if (s->state == VAPIC_ACTIVE) {
491 s->state = VAPIC_STANDBY;
493 vapic_enable_tpr_reporting(false);
497 * Set the IRQ polling hypercalls to the supported variant:
498 * - vmcall if using KVM in-kernel irqchip
499 * - 32-bit VAPIC port write otherwise
501 static int patch_hypercalls(VAPICROMState *s)
503 target_phys_addr_t rom_paddr = s->rom_state_paddr & ROM_BLOCK_MASK;
504 static const uint8_t vmcall_pattern[] = { /* vmcall */
505 0xb8, 0x1, 0, 0, 0, 0xf, 0x1, 0xc1
507 static const uint8_t outl_pattern[] = { /* nop; outl %eax,0x7e */
508 0xb8, 0x1, 0, 0, 0, 0x90, 0xe7, 0x7e
510 uint8_t alternates[2];
511 const uint8_t *pattern;
512 const uint8_t *patch;
517 rom = g_malloc(s->rom_size);
518 cpu_physical_memory_rw(rom_paddr, rom, s->rom_size, 0);
520 for (pos = 0; pos < s->rom_size - sizeof(vmcall_pattern); pos++) {
521 if (kvm_irqchip_in_kernel()) {
522 pattern = outl_pattern;
523 alternates[0] = outl_pattern[7];
524 alternates[1] = outl_pattern[7];
525 patch = &vmcall_pattern[5];
527 pattern = vmcall_pattern;
528 alternates[0] = vmcall_pattern[7];
529 alternates[1] = 0xd9; /* AMD's VMMCALL */
530 patch = &outl_pattern[5];
532 if (memcmp(rom + pos, pattern, 7) == 0 &&
533 (rom[pos + 7] == alternates[0] || rom[pos + 7] == alternates[1])) {
534 cpu_physical_memory_rw(rom_paddr + pos + 5, (uint8_t *)patch,
537 * Don't flush the tb here. Under ordinary conditions, the patched
538 * calls are miles away from the current IP. Under malicious
539 * conditions, the guest could trick us to crash.
546 if (patches != 0 && patches != 2) {
554 * For TCG mode or the time KVM honors read-only memory regions, we need to
555 * enable write access to the option ROM so that variables can be updated by
558 static void vapic_map_rom_writable(VAPICROMState *s)
560 target_phys_addr_t rom_paddr = s->rom_state_paddr & ROM_BLOCK_MASK;
561 MemoryRegionSection section;
566 as = sysbus_address_space(&s->busdev);
568 if (s->rom_mapped_writable) {
569 memory_region_del_subregion(as, &s->rom);
570 memory_region_destroy(&s->rom);
573 /* grab RAM memory region (region @rom_paddr may still be pc.rom) */
574 section = memory_region_find(as, 0, 1);
576 /* read ROM size from RAM region */
577 ram = memory_region_get_ram_ptr(section.mr);
578 rom_size = ram[rom_paddr + 2] * ROM_BLOCK_SIZE;
579 s->rom_size = rom_size;
581 /* We need to round to avoid creating subpages
582 * from which we cannot run code. */
583 rom_size += rom_paddr & ~TARGET_PAGE_MASK;
584 rom_paddr &= TARGET_PAGE_MASK;
585 rom_size = TARGET_PAGE_ALIGN(rom_size);
587 memory_region_init_alias(&s->rom, "kvmvapic-rom", section.mr, rom_paddr,
589 memory_region_add_subregion_overlap(as, rom_paddr, &s->rom, 1000);
590 s->rom_mapped_writable = true;
593 static int vapic_prepare(VAPICROMState *s)
595 vapic_map_rom_writable(s);
597 if (patch_hypercalls(s) < 0) {
601 vapic_enable_tpr_reporting(true);
606 static void vapic_write(void *opaque, target_phys_addr_t addr, uint64_t data,
609 CPUX86State *env = cpu_single_env;
610 target_phys_addr_t rom_paddr;
611 VAPICROMState *s = opaque;
613 cpu_synchronize_state(env);
616 * The VAPIC supports two PIO-based hypercalls, both via port 0x7E.
617 * o 16-bit write access:
618 * Reports the option ROM initialization to the hypervisor. Written
619 * value is the offset of the state structure in the ROM.
620 * o 8-bit write access:
621 * Reactivates the VAPIC after a guest hibernation, i.e. after the
622 * option ROM content has been re-initialized by a guest power cycle.
623 * o 32-bit write access:
624 * Poll for pending IRQs, considering the current VAPIC state.
628 if (s->state == VAPIC_INACTIVE) {
629 rom_paddr = (env->segs[R_CS].base + env->eip) & ROM_BLOCK_MASK;
630 s->rom_state_paddr = rom_paddr + data;
632 s->state = VAPIC_STANDBY;
634 if (vapic_prepare(s) < 0) {
635 s->state = VAPIC_INACTIVE;
642 * Disable triggering instruction in ROM by writing a NOP.
644 * We cannot do this in TCG mode as the reported IP is not
648 patch_byte(env, env->eip - 2, 0x66);
649 patch_byte(env, env->eip - 1, 0x90);
653 if (s->state == VAPIC_ACTIVE) {
656 if (update_rom_mapping(s, env, env->eip) < 0) {
659 if (find_real_tpr_addr(s, env) < 0) {
662 vapic_enable(s, env);
666 if (!kvm_irqchip_in_kernel()) {
667 apic_poll_irq(env->apic_state);
673 static const MemoryRegionOps vapic_ops = {
674 .write = vapic_write,
675 .endianness = DEVICE_NATIVE_ENDIAN,
678 static int vapic_init(SysBusDevice *dev)
680 VAPICROMState *s = FROM_SYSBUS(VAPICROMState, dev);
682 memory_region_init_io(&s->io, &vapic_ops, s, "kvmvapic", 2);
683 sysbus_add_io(dev, VAPIC_IO_PORT, &s->io);
684 sysbus_init_ioports(dev, VAPIC_IO_PORT, 2);
686 option_rom[nb_option_roms].name = "kvmvapic.bin";
687 option_rom[nb_option_roms].bootindex = -1;
693 static void do_vapic_enable(void *data)
695 VAPICROMState *s = data;
697 vapic_enable(s, first_cpu);
700 static int vapic_post_load(void *opaque, int version_id)
702 VAPICROMState *s = opaque;
706 * The old implementation of qemu-kvm did not provide the state
707 * VAPIC_STANDBY. Reconstruct it.
709 if (s->state == VAPIC_INACTIVE && s->rom_state_paddr != 0) {
710 s->state = VAPIC_STANDBY;
713 if (s->state != VAPIC_INACTIVE) {
714 if (vapic_prepare(s) < 0) {
718 if (s->state == VAPIC_ACTIVE) {
720 run_on_cpu(first_cpu, do_vapic_enable, s);
722 zero = g_malloc0(s->rom_state.vapic_size);
723 cpu_physical_memory_rw(s->vapic_paddr, zero,
724 s->rom_state.vapic_size, 1);
732 static const VMStateDescription vmstate_handlers = {
733 .name = "kvmvapic-handlers",
735 .minimum_version_id = 1,
736 .minimum_version_id_old = 1,
737 .fields = (VMStateField[]) {
738 VMSTATE_UINT32(set_tpr, VAPICHandlers),
739 VMSTATE_UINT32(set_tpr_eax, VAPICHandlers),
740 VMSTATE_UINT32_ARRAY(get_tpr, VAPICHandlers, 8),
741 VMSTATE_UINT32(get_tpr_stack, VAPICHandlers),
742 VMSTATE_END_OF_LIST()
746 static const VMStateDescription vmstate_guest_rom = {
747 .name = "kvmvapic-guest-rom",
749 .minimum_version_id = 1,
750 .minimum_version_id_old = 1,
751 .fields = (VMStateField[]) {
752 VMSTATE_UNUSED(8), /* signature */
753 VMSTATE_UINT32(vaddr, GuestROMState),
754 VMSTATE_UINT32(fixup_start, GuestROMState),
755 VMSTATE_UINT32(fixup_end, GuestROMState),
756 VMSTATE_UINT32(vapic_vaddr, GuestROMState),
757 VMSTATE_UINT32(vapic_size, GuestROMState),
758 VMSTATE_UINT32(vcpu_shift, GuestROMState),
759 VMSTATE_UINT32(real_tpr_addr, GuestROMState),
760 VMSTATE_STRUCT(up, GuestROMState, 0, vmstate_handlers, VAPICHandlers),
761 VMSTATE_STRUCT(mp, GuestROMState, 0, vmstate_handlers, VAPICHandlers),
762 VMSTATE_END_OF_LIST()
766 static const VMStateDescription vmstate_vapic = {
767 .name = "kvm-tpr-opt", /* compatible with qemu-kvm VAPIC */
769 .minimum_version_id = 1,
770 .minimum_version_id_old = 1,
771 .post_load = vapic_post_load,
772 .fields = (VMStateField[]) {
773 VMSTATE_STRUCT(rom_state, VAPICROMState, 0, vmstate_guest_rom,
775 VMSTATE_UINT32(state, VAPICROMState),
776 VMSTATE_UINT32(real_tpr_addr, VAPICROMState),
777 VMSTATE_UINT32(rom_state_vaddr, VAPICROMState),
778 VMSTATE_UINT32(vapic_paddr, VAPICROMState),
779 VMSTATE_UINT32(rom_state_paddr, VAPICROMState),
780 VMSTATE_END_OF_LIST()
784 static void vapic_class_init(ObjectClass *klass, void *data)
786 SysBusDeviceClass *sc = SYS_BUS_DEVICE_CLASS(klass);
787 DeviceClass *dc = DEVICE_CLASS(klass);
790 dc->reset = vapic_reset;
791 dc->vmsd = &vmstate_vapic;
792 sc->init = vapic_init;
795 static TypeInfo vapic_type = {
797 .parent = TYPE_SYS_BUS_DEVICE,
798 .instance_size = sizeof(VAPICROMState),
799 .class_init = vapic_class_init,
802 static void vapic_register(void)
804 type_register_static(&vapic_type);
807 type_init(vapic_register);