vm.hh

Go to the documentation of this file.

/*
 * Copyright 2014 Google, Inc.
 * Copyright (c) 2012, 2015 ARM Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __CPU_KVM_KVMVM_HH__
#define __CPU_KVM_KVMVM_HH__
 
#include <vector>
 
#include "base/addr_range.hh"
#include "sim/sim_object.hh"
 
struct kvm_cpuid_entry2;
struct kvm_cpuid2;
struct kvm_msr_list;
struct kvm_vcpu_init;
 
namespace gem5
{
 
// forward declarations
struct KvmVMParams;
class BaseKvmCPU;
class System;
 
class Kvm
{
    friend class KvmVM;
 
  public:
    virtual ~Kvm();
 
    Kvm *create();
 
    int getAPIVersion() const { return apiVersion; }
    int getVCPUMMapSize() const { return vcpuMMapSize; }
 
    bool capUserMemory() const;
    bool capSetTSSAddress() const;
    bool capExtendedCPUID() const;
    bool capUserNMI() const;
 
    int capCoalescedMMIO() const;
 
    int capNumMemSlots() const;
 
    bool capOneReg() const;
 
    bool capIRQChip() const;
 
    bool capVCPUEvents() const;
 
    bool capDebugRegs() const;
 
    bool capXCRs() const;
 
    bool capXSave() const;
 
    bool capIRQLineLayout2() const;
 
#if defined(__i386__) || defined(__x86_64__)
  public: // x86-specific
    typedef std::vector<struct kvm_cpuid_entry2> CPUIDVector;
    typedef std::vector<uint32_t> MSRIndexVector;
 
    bool getSupportedCPUID(struct kvm_cpuid2 &cpuid) const;
 
    const CPUIDVector &getSupportedCPUID() const;
 
    bool getSupportedMSRs(struct kvm_msr_list &msrs) const;
 
    const MSRIndexVector &getSupportedMSRs() const;
 
  private: // x86-specific
    mutable CPUIDVector supportedCPUIDCache;
 
    mutable MSRIndexVector supportedMSRCache;
 
 
#endif
 
  protected:
    int checkExtension(int extension) const;
 
    int ioctl(int request, long p1) const;
    int ioctl(int request, void *p1) const {
        return ioctl(request, (long)p1);
    }
    int ioctl(int request) const {
        return ioctl(request, 0L);
    }
  private:
    // This object is a singleton, so prevent instantiation.
    Kvm();
 
    // Prevent copying
    Kvm(const Kvm &kvm);
    // Prevent assignment
    Kvm &operator=(const Kvm &kvm);
 
    int createVM();
 
    int kvmFD;
    int apiVersion;
    int vcpuMMapSize;
 
    static Kvm *instance;
};
 
class KvmVM : public SimObject
{
    friend class BaseKvmCPU;
 
  public:
    KvmVM(const KvmVMParams &params);
    virtual ~KvmVM();
 
    void notifyFork();
 
    void setTSSAddress(Addr tss_address);
 
    void coalesceMMIO(Addr start, int size);
 
    void coalesceMMIO(const AddrRange &range);
    void createIRQChip();
 
    void setIRQLine(uint32_t irq, bool high);
 
    bool hasKernelIRQChip() const { return _hasKernelIRQChip; }
 
    void enableKernelIRQChip() { _hasKernelIRQChip = true; }
    struct MemSlot
    {
        MemSlot(uint32_t _num) : num(_num)
        {}
        MemSlot() : num(-1)
        {}
 
        int32_t num;
    };
 
    const MemSlot allocMemSlot(uint64_t size);
 
    void setupMemSlot(const MemSlot slot, void *host_addr, Addr guest_addr,
                      uint32_t flags);
 
    void disableMemSlot(const MemSlot slot);
 
    void freeMemSlot(const MemSlot slot);
 
    int createDevice(uint32_t type, uint32_t flags = 0);
 
    Kvm *kvm;
 
    bool validEnvironment() const;
 
    long contextIdToVCpuId(ContextID ctx) const;
 
#if defined(__aarch64__)
  public: // ARM-specific
    void kvmArmPreferredTarget(struct kvm_vcpu_init &target) const;
 
#endif
 
  protected:
    void cpuStartup();
 
    void delayedStartup();
 
 
    void setUserMemoryRegion(uint32_t slot,
                             void *host_addr, Addr guest_addr,
                             uint64_t len, uint32_t flags);
    int createVCPU(long vcpuID);
 
    long allocVCPUID();
 
    int ioctl(int request, long p1) const;
    int ioctl(int request, void *p1) const {
        return ioctl(request, (long)p1);
    }
    int ioctl(int request) const {
        return ioctl(request, 0L);
    }
  private:
    // Prevent copying
    KvmVM(const KvmVM &vm);
    // Prevent assignment
    KvmVM &operator=(const KvmVM &vm);
 
    System *system;
 
    int vmFD;
 
    bool started;
 
    bool _hasKernelIRQChip;
 
    long nextVCPUID;
 
    class MemorySlot
    {
      public:
        uint64_t size;
        uint32_t slot;
        bool active;
    };
    std::vector<MemorySlot> memorySlots;
    uint32_t maxMemorySlot;
};
 
} // namespace gem5
 
#endif