exit_handler_intel_x64.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 EXIT_HANDLER_INTEL_X64_H
#define EXIT_HANDLER_INTEL_X64_H

#include <memory>

#include <json.h>
#include <vmcall_interface.h>
#include <vmcs/vmcs_intel_x64.h>
#include <memory_manager/map_ptr_x64.h>

class vcpu_intel_x64;

// -----------------------------------------------------------------------------
// Exit Handler
// -----------------------------------------------------------------------------

class exit_handler_intel_x64
{
public:

    using ret_type = int64_t;

    exit_handler_intel_x64();

    virtual ~exit_handler_intel_x64() = default;

    virtual void dispatch();

    virtual void halt() noexcept;

    virtual void complete_vmcall(ret_type ret, vmcall_registers_t &regs) noexcept;

protected:

    virtual void handle_exit(intel_x64::vmcs::value_type reason);

    void handle_cpuid();
    void handle_invd();
    void handle_vmcall();
    void handle_vmxoff();
    void handle_rdmsr();
    void handle_wrmsr();

    void advance_rip() noexcept;
    void unimplemented_handler() noexcept;

    virtual void handle_vmcall_versions(vmcall_registers_t &regs);
    virtual void handle_vmcall_registers(vmcall_registers_t &regs);
    virtual void handle_vmcall_data(vmcall_registers_t &regs);
    virtual void handle_vmcall_event(vmcall_registers_t &regs);
    virtual void handle_vmcall_start(vmcall_registers_t &regs);
    virtual void handle_vmcall_stop(vmcall_registers_t &regs);
    virtual void handle_vmcall_unittest(vmcall_registers_t &regs);

    virtual void handle_vmcall_data_string_unformatted(
        const std::string &istr, std::string &ostr);

    virtual void handle_vmcall_data_string_json(
        const json &ijson, json &ojson);

    virtual void handle_vmcall_data_binary_unformatted(
        const bfn::unique_map_ptr_x64<char> &imap,
        const bfn::unique_map_ptr_x64<char> &omap);

    void reply_with_string(
        vmcall_registers_t &regs, const std::string &str,
        const bfn::unique_map_ptr_x64<char> &omap);

    void reply_with_json(
        vmcall_registers_t &regs, const json &str,
        const bfn::unique_map_ptr_x64<char> &omap);

public:

    // The following are only marked public for unit testing. Do not use
    // these APIs directly as they may change at any time, and their direct
    // use may be unstable. You have been warned.

    vmcs_intel_x64 *m_vmcs;
    state_save_intel_x64 *m_state_save;

    virtual void set_vmcs(gsl::not_null<vmcs_intel_x64 *> vmcs)
    { m_vmcs = vmcs; }

    virtual void set_state_save(gsl::not_null<state_save_intel_x64 *> state_save)
    { m_state_save = state_save; }

private:

#ifdef INCLUDE_LIBCXX_UNITTESTS
    void unittest_1001_containers_array() const;
    void unittest_1002_containers_vector() const;
    void unittest_1003_containers_deque() const;
    void unittest_1004_containers_forward_list() const;
    void unittest_1005_containers_list() const;
    void unittest_1006_containers_stack() const;
    void unittest_1007_containers_queue() const;
    void unittest_1008_containers_priority_queue() const;
    void unittest_1009_containers_set() const;
    void unittest_100A_containers_map() const;

    void unittest_1100_io_cout() const;
    void unittest_1101_io_manipulators() const;
#endif

};

#endif