1 /* 2 * QEMU VMPort emulation 3 * 4 * Copyright (C) 2007 Hervé Poussineau 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to deal 8 * in the Software without restriction, including without limitation the rights 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 * THE SOFTWARE. 23 */ 24 25 /* 26 * Guest code that interacts with this virtual device can be found 27 * in VMware open-vm-tools open-source project: 28 * https://github.com/vmware/open-vm-tools 29 */ 30 31 #include "qemu/osdep.h" 32 #include "hw/isa/isa.h" 33 #include "hw/i386/vmport.h" 34 #include "hw/qdev-properties.h" 35 #include "sysemu/sysemu.h" 36 #include "sysemu/hw_accel.h" 37 #include "qemu/log.h" 38 #include "cpu.h" 39 #include "trace.h" 40 41 #define VMPORT_MAGIC 0x564D5868 42 43 /* Compatibility flags for migration */ 44 #define VMPORT_COMPAT_READ_SET_EAX_BIT 0 45 #define VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD_BIT 1 46 #define VMPORT_COMPAT_REPORT_VMX_TYPE_BIT 2 47 #define VMPORT_COMPAT_CMDS_V2_BIT 3 48 #define VMPORT_COMPAT_READ_SET_EAX \ 49 (1 << VMPORT_COMPAT_READ_SET_EAX_BIT) 50 #define VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD \ 51 (1 << VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD_BIT) 52 #define VMPORT_COMPAT_REPORT_VMX_TYPE \ 53 (1 << VMPORT_COMPAT_REPORT_VMX_TYPE_BIT) 54 #define VMPORT_COMPAT_CMDS_V2 \ 55 (1 << VMPORT_COMPAT_CMDS_V2_BIT) 56 57 /* vCPU features reported by CMD_GET_VCPU_INFO */ 58 #define VCPU_INFO_SLC64_BIT 0 59 #define VCPU_INFO_SYNC_VTSCS_BIT 1 60 #define VCPU_INFO_HV_REPLAY_OK_BIT 2 61 #define VCPU_INFO_LEGACY_X2APIC_BIT 3 62 #define VCPU_INFO_RESERVED_BIT 31 63 64 #define VMPORT(obj) OBJECT_CHECK(VMPortState, (obj), TYPE_VMPORT) 65 66 typedef struct VMPortState { 67 ISADevice parent_obj; 68 69 MemoryRegion io; 70 VMPortReadFunc *func[VMPORT_ENTRIES]; 71 void *opaque[VMPORT_ENTRIES]; 72 73 uint32_t vmware_vmx_version; 74 uint8_t vmware_vmx_type; 75 76 uint32_t compat_flags; 77 } VMPortState; 78 79 static VMPortState *port_state; 80 81 void vmport_register(VMPortCommand command, VMPortReadFunc *func, void *opaque) 82 { 83 assert(command < VMPORT_ENTRIES); 84 trace_vmport_register(command, func, opaque); 85 port_state->func[command] = func; 86 port_state->opaque[command] = opaque; 87 } 88 89 static uint64_t vmport_ioport_read(void *opaque, hwaddr addr, 90 unsigned size) 91 { 92 VMPortState *s = opaque; 93 CPUState *cs = current_cpu; 94 X86CPU *cpu = X86_CPU(cs); 95 CPUX86State *env = &cpu->env; 96 unsigned char command; 97 uint32_t eax; 98 99 cpu_synchronize_state(cs); 100 101 eax = env->regs[R_EAX]; 102 if (eax != VMPORT_MAGIC) { 103 goto err; 104 } 105 106 command = env->regs[R_ECX]; 107 trace_vmport_command(command); 108 if (command >= VMPORT_ENTRIES || !s->func[command]) { 109 qemu_log_mask(LOG_UNIMP, "vmport: unknown command %x\n", command); 110 goto err; 111 } 112 113 eax = s->func[command](s->opaque[command], addr); 114 goto out; 115 116 err: 117 if (s->compat_flags & VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD) { 118 eax = UINT32_MAX; 119 } 120 121 out: 122 /* 123 * The call above to cpu_synchronize_state() gets vCPU registers values 124 * to QEMU but also cause QEMU to write QEMU vCPU registers values to 125 * vCPU implementation (e.g. Accelerator such as KVM) just before 126 * resuming guest. 127 * 128 * Therefore, in order to make IOPort return value propagate to 129 * guest EAX, we need to explicitly update QEMU EAX register value. 130 */ 131 if (s->compat_flags & VMPORT_COMPAT_READ_SET_EAX) { 132 cpu->env.regs[R_EAX] = eax; 133 } 134 135 return eax; 136 } 137 138 static void vmport_ioport_write(void *opaque, hwaddr addr, 139 uint64_t val, unsigned size) 140 { 141 X86CPU *cpu = X86_CPU(current_cpu); 142 143 cpu->env.regs[R_EAX] = vmport_ioport_read(opaque, addr, 4); 144 } 145 146 static uint32_t vmport_cmd_get_version(void *opaque, uint32_t addr) 147 { 148 X86CPU *cpu = X86_CPU(current_cpu); 149 150 cpu->env.regs[R_EBX] = VMPORT_MAGIC; 151 if (port_state->compat_flags & VMPORT_COMPAT_REPORT_VMX_TYPE) { 152 cpu->env.regs[R_ECX] = port_state->vmware_vmx_type; 153 } 154 return port_state->vmware_vmx_version; 155 } 156 157 static uint32_t vmport_cmd_get_bios_uuid(void *opaque, uint32_t addr) 158 { 159 X86CPU *cpu = X86_CPU(current_cpu); 160 uint32_t *uuid_parts = (uint32_t *)(qemu_uuid.data); 161 162 cpu->env.regs[R_EAX] = le32_to_cpu(uuid_parts[0]); 163 cpu->env.regs[R_EBX] = le32_to_cpu(uuid_parts[1]); 164 cpu->env.regs[R_ECX] = le32_to_cpu(uuid_parts[2]); 165 cpu->env.regs[R_EDX] = le32_to_cpu(uuid_parts[3]); 166 return cpu->env.regs[R_EAX]; 167 } 168 169 static uint32_t vmport_cmd_ram_size(void *opaque, uint32_t addr) 170 { 171 X86CPU *cpu = X86_CPU(current_cpu); 172 173 cpu->env.regs[R_EBX] = 0x1177; 174 return ram_size; 175 } 176 177 static uint32_t vmport_cmd_get_vcpu_info(void *opaque, uint32_t addr) 178 { 179 X86CPU *cpu = X86_CPU(current_cpu); 180 uint32_t ret = 0; 181 182 if (cpu->env.features[FEAT_1_ECX] & CPUID_EXT_X2APIC) { 183 ret |= 1 << VCPU_INFO_LEGACY_X2APIC_BIT; 184 } 185 186 return ret; 187 } 188 189 static const MemoryRegionOps vmport_ops = { 190 .read = vmport_ioport_read, 191 .write = vmport_ioport_write, 192 .impl = { 193 .min_access_size = 4, 194 .max_access_size = 4, 195 }, 196 .endianness = DEVICE_LITTLE_ENDIAN, 197 }; 198 199 static void vmport_realizefn(DeviceState *dev, Error **errp) 200 { 201 ISADevice *isadev = ISA_DEVICE(dev); 202 VMPortState *s = VMPORT(dev); 203 204 memory_region_init_io(&s->io, OBJECT(s), &vmport_ops, s, "vmport", 1); 205 isa_register_ioport(isadev, &s->io, 0x5658); 206 207 port_state = s; 208 209 /* Register some generic port commands */ 210 vmport_register(VMPORT_CMD_GETVERSION, vmport_cmd_get_version, NULL); 211 vmport_register(VMPORT_CMD_GETRAMSIZE, vmport_cmd_ram_size, NULL); 212 if (s->compat_flags & VMPORT_COMPAT_CMDS_V2) { 213 vmport_register(VMPORT_CMD_GETBIOSUUID, vmport_cmd_get_bios_uuid, NULL); 214 vmport_register(VMPORT_CMD_GET_VCPU_INFO, vmport_cmd_get_vcpu_info, 215 NULL); 216 } 217 } 218 219 static Property vmport_properties[] = { 220 /* Used to enforce compatibility for migration */ 221 DEFINE_PROP_BIT("x-read-set-eax", VMPortState, compat_flags, 222 VMPORT_COMPAT_READ_SET_EAX_BIT, true), 223 DEFINE_PROP_BIT("x-signal-unsupported-cmd", VMPortState, compat_flags, 224 VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD_BIT, true), 225 DEFINE_PROP_BIT("x-report-vmx-type", VMPortState, compat_flags, 226 VMPORT_COMPAT_REPORT_VMX_TYPE_BIT, true), 227 DEFINE_PROP_BIT("x-cmds-v2", VMPortState, compat_flags, 228 VMPORT_COMPAT_CMDS_V2_BIT, true), 229 230 /* Default value taken from open-vm-tools code VERSION_MAGIC definition */ 231 DEFINE_PROP_UINT32("vmware-vmx-version", VMPortState, 232 vmware_vmx_version, 6), 233 /* 234 * Value determines which VMware product type host report itself to guest. 235 * 236 * Most guests are fine with exposing host as VMware ESX server. 237 * Some legacy/proprietary guests hard-code a given type. 238 * 239 * For a complete list of values, refer to enum VMXType at open-vm-tools 240 * project (Defined at lib/include/vm_vmx_type.h). 241 * 242 * Reasonable options: 243 * 0 - Unset 244 * 1 - VMware Express (deprecated) 245 * 2 - VMware ESX Server 246 * 3 - VMware Server (Deprecated) 247 * 4 - VMware Workstation 248 * 5 - ACE 1.x (Deprecated) 249 */ 250 DEFINE_PROP_UINT8("vmware-vmx-type", VMPortState, vmware_vmx_type, 2), 251 252 DEFINE_PROP_END_OF_LIST(), 253 }; 254 255 static void vmport_class_initfn(ObjectClass *klass, void *data) 256 { 257 DeviceClass *dc = DEVICE_CLASS(klass); 258 259 dc->realize = vmport_realizefn; 260 /* Reason: realize sets global port_state */ 261 dc->user_creatable = false; 262 device_class_set_props(dc, vmport_properties); 263 } 264 265 static const TypeInfo vmport_info = { 266 .name = TYPE_VMPORT, 267 .parent = TYPE_ISA_DEVICE, 268 .instance_size = sizeof(VMPortState), 269 .class_init = vmport_class_initfn, 270 }; 271 272 static void vmport_register_types(void) 273 { 274 type_register_static(&vmport_info); 275 } 276 277 type_init(vmport_register_types) 278