exception.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 EXCEPTION_H
#define EXCEPTION_H

#include <string>
#include <ostream>
#include <typeinfo>
#include <stdexcept>

// *INDENT-OFF*

namespace bfn
{

// -----------------------------------------------------------------------------
// General Exception
// -----------------------------------------------------------------------------

class general_exception : public std::exception
{
public:

    general_exception() noexcept = default;

    ~general_exception() override = default;

    const char *what() const noexcept override
    { return typeid(*this).name(); }

public:

    virtual std::ostream &print(std::ostream &os) const
    { return os << "general exception"; }
};

}

inline std::ostream &
operator<<(std::ostream &os, const bfn::general_exception &ge)
{ return ge.print(os); }

namespace bfn
{

// -----------------------------------------------------------------------------
// Unknown Command Error
// -----------------------------------------------------------------------------

class unknown_command_error : public bfn::general_exception
{
public:
    unknown_command_error(std::string mesg) :
        m_mesg(std::move(mesg))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << "unknown command: `" << m_mesg << "`"; }

private:
    std::string m_mesg;
};

#define unknown_command(a) bfn::unknown_command_error(a)

// -----------------------------------------------------------------------------
// Unknown VMCall Type Error
// -----------------------------------------------------------------------------

class unknown_vmcall_type_error : public bfn::general_exception
{
public:
    unknown_vmcall_type_error(std::string mesg) :
        m_mesg(std::move(mesg))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << "unknown vmcall type: `" << m_mesg << "`"; }

private:
    std::string m_mesg;
};

#define unknown_vmcall_type(a) bfn::unknown_vmcall_type_error(a)

// -----------------------------------------------------------------------------
// Unknown VMCall String Type Error
// -----------------------------------------------------------------------------

class unknown_vmcall_string_type_error : public bfn::general_exception
{
public:
    unknown_vmcall_string_type_error(std::string mesg) :
        m_mesg(std::move(mesg))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << "unknown string type: `" << m_mesg << "`"; }

private:
    std::string m_mesg;
};

#define unknown_vmcall_string_type(a) bfn::unknown_vmcall_string_type_error(a)

// -----------------------------------------------------------------------------
// Unknown VMCall String Type Error
// -----------------------------------------------------------------------------

class unknown_vmcall_data_type_error : public bfn::general_exception
{
public:
    unknown_vmcall_data_type_error(std::string mesg) :
        m_mesg(std::move(mesg))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << "unknown data type: `" << m_mesg << "`"; }

private:
    std::string m_mesg;
};

#define unknown_vmcall_data_type(a) bfn::unknown_vmcall_data_type_error(a)

// -----------------------------------------------------------------------------
// Missing Argument Error
// -----------------------------------------------------------------------------

class missing_argument_error : public bfn::general_exception
{
public:
    std::ostream &print(std::ostream &os) const override
    { return os << "missing argument"; }
};

#define missing_argument() bfn::missing_argument_error()

// -----------------------------------------------------------------------------
// Invalid Filename Error
// -----------------------------------------------------------------------------

class invalid_file_error : public bfn::general_exception
{
public:
    invalid_file_error(std::string mesg) :
        m_mesg(std::move(mesg))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << "invalid filename: `" << m_mesg << "`"; }

private:
    std::string m_mesg;
};

#define invalid_file(a) bfn::invalid_file_error(a)

// -----------------------------------------------------------------------------
// Driver Inaccessible
// -----------------------------------------------------------------------------

class driver_inaccessible_error : public bfn::general_exception
{
public:
    std::ostream &print(std::ostream &os) const override
    {
        os << "bareflank driver inaccessible:";
        os << std::endl << "    - check that the bareflank driver is loaded";
        os << std::endl << "    - check that bfm was exectued with the "
           << "proper permissions";
        return os;
    }
};

#define driver_inaccessible(a) bfn::driver_inaccessible_error(a)

// -----------------------------------------------------------------------------
// IOCTL Failed
// -----------------------------------------------------------------------------

class ioctl_failed_error : public bfn::general_exception
{
public:
    ioctl_failed_error(std::string ioctl) :
        m_ioctl(std::move(ioctl))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << "ioctl failed: `" << m_ioctl << "`"; }

private:
    std::string m_ioctl;
};

#define ioctl_failed(a) bfn::ioctl_failed_error(#a)

// -----------------------------------------------------------------------------
// Corrupt VMM
// -----------------------------------------------------------------------------

class corrupt_vmm_error : public bfn::general_exception
{
public:
    std::ostream &print(std::ostream &os) const override
    { return os << "unable to process request. vmm is in a corrupt state"; }
};

#define corrupt_vmm() bfn::corrupt_vmm_error()

// -----------------------------------------------------------------------------
// Unknown VMM Status
// -----------------------------------------------------------------------------

class unknown_status_error : public bfn::general_exception
{
public:
    std::ostream &print(std::ostream &os) const override
    { return os << "unable to process request. vmm status unknown"; }
};

#define unknown_status() bfn::unknown_status_error()

// -----------------------------------------------------------------------------
// Invalid VMM Status
// -----------------------------------------------------------------------------

class invalid_vmm_state_error : public bfn::general_exception
{
public:
    invalid_vmm_state_error(std::string mesg) :
        m_mesg(std::move(mesg))
    {}

    std::ostream &print(std::ostream &os) const override
    { return os << m_mesg; }

private:
    std::string m_mesg;
};

#define invalid_vmm_state(a) bfn::invalid_vmm_state_error(a)

}

// *INDENT-ON*

#endif