vcpu.h

Go to the documentation of this file.

//
// Bareflank Hypervisor
//
// Copyright (C) 2015 Assured Information Security, Inc.
// Author: Rian Quinn        <quinnr@ainfosec.com>
// Author: Brendan Kerrigan  <kerriganb@ainfosec.com>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

#ifndef VCPU_H
#define VCPU_H

#include <string>
#include <memory>

#include <vcpuid.h>
#include <user_data.h>
#include <debug_ring/debug_ring.h>

class vcpu
{
public:

    vcpu(vcpuid::type id, std::unique_ptr<debug_ring> dr = nullptr);

    virtual ~vcpu() = default;

    virtual void init(user_data *data = nullptr);

    virtual void fini(user_data *data = nullptr);

    virtual void run(user_data *data = nullptr);

    virtual void hlt(user_data *data = nullptr);

    virtual vcpuid::type id() const
    { return m_id; }

    virtual bool is_running()
    { return m_is_running; }

    virtual bool is_initialized()
    { return m_is_initialized; }

    virtual bool is_bootstrap_vcpu()
    { return m_id == 0; }

    virtual bool is_host_vm_vcpu()
    { return (m_id & (vcpuid::guest_mask & ~vcpuid::reserved)) == 0; }

    virtual bool is_guest_vm_vcpu()
    { return (m_id & (vcpuid::guest_mask & ~vcpuid::reserved)) != 0; }

    virtual void write(const std::string &str) noexcept;

private:

    vcpuid::type m_id;
    std::unique_ptr<debug_ring> m_debug_ring;

    bool m_is_running;
    bool m_is_initialized;

public:

    vcpu(vcpu &&) = default;
    vcpu &operator=(vcpu &&) = default;

    vcpu(const vcpu &) = delete;
    vcpu &operator=(const vcpu &) = delete;
};

#endif