src/cpu/kvm/vm.cc

   1 /*
   2  * Copyright 2014 Google, Inc.
   3  * Copyright (c) 2012, 2015 ARM Limited
   4  * All rights reserved
   5  *
   6  * The license below extends only to copyright in the software and shall
   7  * not be construed as granting a license to any other intellectual
   8  * property including but not limited to intellectual property relating
   9  * to a hardware implementation of the functionality of the software
  10  * licensed hereunder.  You may use the software subject to the license
  11  * terms below provided that you ensure that this notice is replicated
  12  * unmodified and in its entirety in all distributions of the software,
  13  * modified or unmodified, in source code or in binary form.
  14  *
  15  * Redistribution and use in source and binary forms, with or without
  16  * modification, are permitted provided that the following conditions are
  17  * met: redistributions of source code must retain the above copyright
  18  * notice, this list of conditions and the following disclaimer;
  19  * redistributions in binary form must reproduce the above copyright
  20  * notice, this list of conditions and the following disclaimer in the
  21  * documentation and/or other materials provided with the distribution;
  22  * neither the name of the copyright holders nor the names of its
  23  * contributors may be used to endorse or promote products derived from
  24  * this software without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  27  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  28  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  29  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  30  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  36  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  *
  38  * Authors: Andreas Sandberg
  39  */
  40
  41 #include <linux/kvm.h>
  42 #include <sys/ioctl.h>
  43 #include <sys/stat.h>
  44 #include <sys/types.h>
  45 #include <fcntl.h>
  46 #include <unistd.h>
  47
  48 #include <cerrno>
  49 #include <memory>
  50
  51 #include "cpu/kvm/vm.hh"
  52 #include "debug/Kvm.hh"
  53 #include "params/KvmVM.hh"
  54 #include "sim/system.hh"
  55
  56 #define EXPECTED_KVM_API_VERSION 12
  57
  58 #if EXPECTED_KVM_API_VERSION != KVM_API_VERSION
  59 #error Unsupported KVM version
  60 #endif
  61
  62 Kvm *Kvm::instance = NULL;
  63
  64 Kvm::Kvm()
  65     : kvmFD(-1), apiVersion(-1), vcpuMMapSize(0)
  66 {
  67     kvmFD = ::open("/dev/kvm", O_RDWR);
  68     if (kvmFD == -1)
  69         fatal("KVM: Failed to open /dev/kvm\n");
  70
  71     apiVersion = ioctl(KVM_GET_API_VERSION);
  72     if (apiVersion != EXPECTED_KVM_API_VERSION)
  73         fatal("KVM: Incompatible API version\n");
  74
  75     vcpuMMapSize = ioctl(KVM_GET_VCPU_MMAP_SIZE);
  76     if (vcpuMMapSize == -1)
  77         panic("KVM: Failed to get virtual CPU MMAP size\n");
  78 }
  79
  80 Kvm::~Kvm()
  81 {
  82     close(kvmFD);
  83 }
  84
  85 Kvm *
  86 Kvm::create()
  87 {
  88     if (!instance)
  89         instance = new Kvm();
  90
  91     return instance;
  92 }
  93
  94 bool
  95 Kvm::capUserMemory() const
  96 {
  97     return checkExtension(KVM_CAP_USER_MEMORY) != 0;
  98 }
  99
 100 bool
 101 Kvm::capSetTSSAddress() const
 102 {
 103     return checkExtension(KVM_CAP_SET_TSS_ADDR) != 0;
 104 }
 105
 106 bool
 107 Kvm::capExtendedCPUID() const
 108 {
 109     return checkExtension(KVM_CAP_EXT_CPUID) != 0;
 110 }
 111
 112 bool
 113 Kvm::capUserNMI() const
 114 {
 115 #ifdef KVM_CAP_USER_NMI
 116     return checkExtension(KVM_CAP_USER_NMI) != 0;
 117 #else
 118     return false;
 119 #endif
 120 }
 121
 122 int
 123 Kvm::capCoalescedMMIO() const
 124 {
 125     return checkExtension(KVM_CAP_COALESCED_MMIO);
 126 }
 127
 128 int
 129 Kvm::capNumMemSlots() const
 130 {
 131 #ifdef KVM_CAP_NR_MEMSLOTS
 132     return checkExtension(KVM_CAP_NR_MEMSLOTS);
 133 #else
 134     return 0;
 135 #endif
 136 }
 137
 138 bool
 139 Kvm::capOneReg() const
 140 {
 141 #ifdef KVM_CAP_ONE_REG
 142     return checkExtension(KVM_CAP_ONE_REG) != 0;
 143 #else
 144     return false;
 145 #endif
 146 }
 147
 148 bool
 149 Kvm::capIRQChip() const
 150 {
 151     return checkExtension(KVM_CAP_IRQCHIP) != 0;
 152 }
 153
 154 bool
 155 Kvm::capVCPUEvents() const
 156 {
 157 #ifdef KVM_CAP_VCPU_EVENTS
 158     return checkExtension(KVM_CAP_VCPU_EVENTS) != 0;
 159 #else
 160     return false;
 161 #endif
 162 }
 163
 164 bool
 165 Kvm::capDebugRegs() const
 166 {
 167 #ifdef KVM_CAP_DEBUGREGS
 168     return checkExtension(KVM_CAP_DEBUGREGS) != 0;
 169 #else
 170     return false;
 171 #endif
 172 }
 173
 174 bool
 175 Kvm::capXCRs() const
 176 {
 177 #ifdef KVM_CAP_XCRS
 178     return checkExtension(KVM_CAP_XCRS) != 0;
 179 #else
 180     return false;
 181 #endif
 182 }
 183
 184 bool
 185 Kvm::capXSave() const
 186 {
 187 #ifdef KVM_CAP_XSAVE
 188     return checkExtension(KVM_CAP_XSAVE) != 0;
 189 #else
 190     return false;
 191 #endif
 192 }
 193
 194
 195 #if defined(__i386__) || defined(__x86_64__)
 196 bool
 197 Kvm::getSupportedCPUID(struct kvm_cpuid2 &cpuid) const
 198 {
 199     if (ioctl(KVM_GET_SUPPORTED_CPUID, (void *)&cpuid) == -1) {
 200         if (errno == E2BIG)
 201             return false;
 202         else
 203             panic("KVM: Failed to get supported CPUID (errno: %i)\n", errno);
 204     } else
 205         return true;
 206 }
 207
 208 const Kvm::CPUIDVector &
 209 Kvm::getSupportedCPUID() const
 210 {
 211     if (supportedCPUIDCache.empty()) {
 212         std::unique_ptr<struct kvm_cpuid2> cpuid;
 213         int i(1);
 214         do {
 215             cpuid.reset((struct kvm_cpuid2 *)operator new(
 216                             sizeof(kvm_cpuid2) + i * sizeof(kvm_cpuid_entry2)));
 217
 218             cpuid->nent = i;
 219             ++i;
 220         } while (!getSupportedCPUID(*cpuid));
 221         supportedCPUIDCache.assign(cpuid->entries,
 222                                    cpuid->entries + cpuid->nent);
 223     }
 224
 225     return supportedCPUIDCache;
 226 }
 227
 228 bool
 229 Kvm::getSupportedMSRs(struct kvm_msr_list &msrs) const
 230 {
 231     if (ioctl(KVM_GET_MSR_INDEX_LIST, (void *)&msrs) == -1) {
 232         if (errno == E2BIG)
 233             return false;
 234         else
 235             panic("KVM: Failed to get supported CPUID (errno: %i)\n", errno);
 236     } else
 237         return true;
 238 }
 239
 240 const Kvm::MSRIndexVector &
 241 Kvm::getSupportedMSRs() const
 242 {
 243     if (supportedMSRCache.empty()) {
 244         std::unique_ptr<struct kvm_msr_list> msrs;
 245         int i(0);
 246         do {
 247             msrs.reset((struct kvm_msr_list *)operator new(
 248                            sizeof(kvm_msr_list) + i * sizeof(uint32_t)));
 249
 250             msrs->nmsrs = i;
 251             ++i;
 252         } while (!getSupportedMSRs(*msrs));
 253         supportedMSRCache.assign(msrs->indices, msrs->indices + msrs->nmsrs);
 254     }
 255
 256     return supportedMSRCache;
 257 }
 258
 259 #endif // x86-specific
 260
 261
 262 int
 263 Kvm::checkExtension(int extension) const
 264 {
 265     int ret = ioctl(KVM_CHECK_EXTENSION, extension);
 266     if (ret == -1)
 267         panic("KVM: ioctl failed when checking for extension\n");
 268     return ret;
 269 }
 270
 271 int
 272 Kvm::ioctl(int request, long p1) const
 273 {
 274     assert(kvmFD != -1);
 275
 276     return ::ioctl(kvmFD, request, p1);
 277 }
 278
 279 int
 280 Kvm::createVM()
 281 {
 282     int vmFD;
 283
 284     vmFD = ioctl(KVM_CREATE_VM);
 285     if (vmFD == -1)
 286         panic("Failed to create KVM VM\n");
 287
 288     return vmFD;
 289 }
 290
 291
 292 KvmVM::KvmVM(KvmVMParams *params)
 293     : SimObject(params),
 294       kvm(new Kvm()), system(params->system),
 295       vmFD(kvm->createVM()),
 296       started(false),
 297       nextVCPUID(0)
 298 {
 299     maxMemorySlot = kvm->capNumMemSlots();
 300     /* If we couldn't determine how memory slots there are, guess 32. */
 301     if (!maxMemorySlot)
 302         maxMemorySlot = 32;
 303     /* Setup the coalesced MMIO regions */
 304     for (int i = 0; i < params->coalescedMMIO.size(); ++i)
 305         coalesceMMIO(params->coalescedMMIO[i]);
 306 }
 307
 308 KvmVM::~KvmVM()
 309 {
 310     if (vmFD != -1)
 311         close(vmFD);
 312
 313     if (kvm)
 314         delete kvm;
 315 }
 316
 317 void
 318 KvmVM::notifyFork()
 319 {
 320     if (vmFD != -1) {
 321         if (close(vmFD) == -1)
 322             warn("kvm VM: notifyFork failed to close vmFD\n");
 323
 324         vmFD = -1;
 325
 326         delete kvm;
 327         kvm = NULL;
 328     }
 329 }
 330
 331 void
 332 KvmVM::cpuStartup()
 333 {
 334     if (started)
 335         return;
 336     started = true;
 337
 338     delayedStartup();
 339 }
 340
 341 void
 342 KvmVM::delayedStartup()
 343 {
 344     const std::vector<BackingStoreEntry> &memories(
 345         system->getPhysMem().getBackingStore());
 346
 347     DPRINTF(Kvm, "Mapping %i memory region(s)\n", memories.size());
 348     for (int slot(0); slot < memories.size(); ++slot) {
 349         if (!memories[slot].kvmMap) {
 350             DPRINTF(Kvm, "Skipping region marked as not usable by KVM\n");
 351             continue;
 352         }
 353
 354         const AddrRange &range(memories[slot].range);
 355         void *pmem(memories[slot].pmem);
 356
 357         if (pmem) {
 358             DPRINTF(Kvm, "Mapping region: 0x%p -> 0x%llx [size: 0x%llx]\n",
 359                     pmem, range.start(), range.size());
 360
 361             if (range.interleaved()) {
 362                 panic("Tried to map an interleaved memory range into "
 363                       "a KVM VM.\n");
 364             }
 365
 366             const MemSlot slot = allocMemSlot(range.size());
 367             setupMemSlot(slot, pmem, range.start(), 0/* flags */);
 368         } else {
 369             DPRINTF(Kvm, "Zero-region not mapped: [0x%llx]\n", range.start());
 370             hack("KVM: Zero memory handled as IO\n");
 371         }
 372     }
 373 }
 374
 375 const KvmVM::MemSlot
 376 KvmVM::allocMemSlot(uint64_t size)
 377 {
 378     if (!size)
 379         panic("Memory slots must have non-zero size.\n");
 380
 381     std::vector<MemorySlot>::iterator pos;
 382     for (pos = memorySlots.begin(); pos != memorySlots.end(); pos++) {
 383         if (!pos->size) {
 384             pos->size = size;
 385             pos->active = false;
 386             return pos->slot;
 387         }
 388     }
 389
 390     uint32_t nextSlot = memorySlots.size();
 391     if (nextSlot > maxMemorySlot)
 392         panic("Out of memory slots.\n");
 393
 394     MemorySlot slot;
 395     slot.size = size;
 396     slot.slot = nextSlot;
 397     slot.active = false;
 398
 399     memorySlots.push_back(slot);
 400     return MemSlot(slot.slot);
 401 }
 402
 403 void
 404 KvmVM::setupMemSlot(const KvmVM::MemSlot num, void *host_addr, Addr guest,
 405                     uint32_t flags)
 406 {
 407     MemorySlot &slot = memorySlots.at(num.num);
 408     slot.active = true;
 409     setUserMemoryRegion(num.num, host_addr, guest, slot.size, flags);
 410 }
 411
 412 void
 413 KvmVM::disableMemSlot(const KvmVM::MemSlot num)
 414 {
 415     MemorySlot &slot = memorySlots.at(num.num);
 416     if (slot.active)
 417         setUserMemoryRegion(num.num, NULL, 0, 0, 0);
 418     slot.active = false;
 419 }
 420
 421 void
 422 KvmVM::freeMemSlot(const KvmVM::MemSlot num)
 423 {
 424     disableMemSlot(num.num);
 425     MemorySlot &slot = memorySlots.at(num.num);
 426     slot.size = 0;
 427 }
 428
 429 void
 430 KvmVM::setUserMemoryRegion(uint32_t slot,
 431                            void *host_addr, Addr guest_addr,
 432                            uint64_t len, uint32_t flags)
 433 {
 434     struct kvm_userspace_memory_region m;
 435
 436     memset(&m, 0, sizeof(m));
 437     m.slot = slot;
 438     m.flags = flags;
 439     m.guest_phys_addr = (uint64_t)guest_addr;
 440     m.memory_size = len;
 441     m.userspace_addr = (__u64)host_addr;
 442
 443     if (ioctl(KVM_SET_USER_MEMORY_REGION, (void *)&m) == -1) {
 444         panic("Failed to setup KVM memory region:\n"
 445               "\tHost Address: 0x%p\n"
 446               "\tGuest Address: 0x%llx\n",
 447               "\tSize: %ll\n",
 448               "\tFlags: 0x%x\n",
 449               m.userspace_addr, m.guest_phys_addr,
 450               m.memory_size, m.flags);
 451     }
 452 }
 453
 454 void
 455 KvmVM::coalesceMMIO(const AddrRange &range)
 456 {
 457     coalesceMMIO(range.start(), range.size());
 458 }
 459
 460 void
 461 KvmVM::coalesceMMIO(Addr start, int size)
 462 {
 463     struct kvm_coalesced_mmio_zone zone;
 464
 465     zone.addr = start;
 466     zone.size = size;
 467     zone.pad = 0;
 468
 469     DPRINTF(Kvm, "KVM: Registering coalesced MMIO region [0x%x, 0x%x]\n",
 470             zone.addr, zone.addr + zone.size - 1);
 471     if (ioctl(KVM_REGISTER_COALESCED_MMIO, (void *)&zone) == -1)
 472         panic("KVM: Failed to register coalesced MMIO region (%i)\n",
 473               errno);
 474 }
 475
 476 void
 477 KvmVM::setTSSAddress(Addr tss_address)
 478 {
 479     if (ioctl(KVM_SET_TSS_ADDR, (unsigned long)tss_address) == -1)
 480         panic("KVM: Failed to set VM TSS address\n");
 481 }
 482
 483 void
 484 KvmVM::createIRQChip()
 485 {
 486     if (_hasKernelIRQChip)
 487         panic("KvmVM::createIRQChip called twice.\n");
 488
 489     if (ioctl(KVM_CREATE_IRQCHIP) != -1) {
 490         _hasKernelIRQChip = true;
 491     } else {
 492         warn("KVM: Failed to create in-kernel IRQ chip (errno: %i)\n",
 493              errno);
 494         _hasKernelIRQChip = false;
 495     }
 496 }
 497
 498 void
 499 KvmVM::setIRQLine(uint32_t irq, bool high)
 500 {
 501     struct kvm_irq_level kvm_level;
 502
 503     kvm_level.irq = irq;
 504     kvm_level.level = high ? 1 : 0;
 505
 506     if (ioctl(KVM_IRQ_LINE, &kvm_level) == -1)
 507         panic("KVM: Failed to set IRQ line level (errno: %i)\n",
 508               errno);
 509 }
 510
 511 int
 512 KvmVM::createDevice(uint32_t type, uint32_t flags)
 513 {
 514 #if defined(KVM_CREATE_DEVICE)
 515     struct kvm_create_device dev = { type, 0, flags };
 516
 517     if (ioctl(KVM_CREATE_DEVICE, &dev) == -1) {
 518         panic("KVM: Failed to create device (errno: %i)\n",
 519               errno);
 520     }
 521
 522     return dev.fd;
 523 #else
 524     panic("Kernel headers don't support KVM_CREATE_DEVICE\n");
 525 #endif
 526 }
 527
 528 int
 529 KvmVM::createVCPU(long vcpuID)
 530 {
 531     int fd;
 532
 533     fd = ioctl(KVM_CREATE_VCPU, vcpuID);
 534     if (fd == -1)
 535         panic("KVM: Failed to create virtual CPU");
 536
 537     return fd;
 538 }
 539
 540 long
 541 KvmVM::allocVCPUID()
 542 {
 543     return nextVCPUID++;
 544 }
 545
 546 #if defined(__aarch64__)
 547 void
 548 KvmVM::kvmArmPreferredTarget(struct kvm_vcpu_init &target) const
 549 {
 550     if (ioctl(KVM_ARM_PREFERRED_TARGET, &target) == -1) {
 551         panic("KVM: Failed to get ARM preferred CPU target (errno: %i)\n",
 552               errno);
 553     }
 554 }
 555 #endif
 556
 557 int
 558 KvmVM::ioctl(int request, long p1) const
 559 {
 560     assert(vmFD != -1);
 561
 562     return ::ioctl(vmFD, request, p1);
 563 }
 564
 565
 566 KvmVM *
 567 KvmVMParams::create()
 568 {
 569     static bool created = false;
 570     if (created)
 571         warn_once("Use of multiple KvmVMs is currently untested!\n");
 572
 573     created = true;
 574
 575     return new KvmVM(this);
 576 }