error_codes.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 ERROR_CODES_H
#define ERROR_CODES_H

#include <types.h>

/* -------------------------------------------------------------------------- */
/* Helper Macros                                                              */
/* -------------------------------------------------------------------------- */

#ifdef __cplusplus
#define ec_sign(a) static_cast<int64_t>(a)
#else
#define ec_sign(a) ((int64_t)(a))
#endif

/* -------------------------------------------------------------------------- */
/* Success                                                                    */
/* -------------------------------------------------------------------------- */

#define SUCCESS 0

/* -------------------------------------------------------------------------- */
/* Entry Error Codes                                                          */
/* -------------------------------------------------------------------------- */

#define ENTRY_SUCCESS ec_sign(SUCCESS)
#define ENTRY_ERROR_STACK_OVERFLOW ec_sign(0x8000000000000010)
#define ENTRY_ERROR_VMM_INIT_FAILED ec_sign(0x8000000000000020)
#define ENTRY_ERROR_VMM_START_FAILED ec_sign(0x8000000000000030)
#define ENTRY_ERROR_VMM_STOP_FAILED ec_sign(0x8000000000000040)
#define ENTRY_ERROR_UNKNOWN ec_sign(0x8000000000000050)

/* -------------------------------------------------------------------------- */
/* C Runtime Error Codes                                                      */
/* -------------------------------------------------------------------------- */

#define CRT_SUCCESS ec_sign(SUCCESS)
#define CRT_FAILURE ec_sign(0x8000000000000100)

/* -------------------------------------------------------------------------- */
/* Unwinder Error Codes                                                       */
/* -------------------------------------------------------------------------- */

#define REGISTER_EH_FRAME_SUCCESS ec_sign(SUCCESS)
#define REGISTER_EH_FRAME_FAILURE ec_sign(0x8000000000001000)

/* -------------------------------------------------------------------------- */
/* Debug Ring Error Codes                                                     */
/* -------------------------------------------------------------------------- */

#define GET_DRR_SUCCESS ec_sign(SUCCESS)
#define GET_DRR_FAILURE ec_sign(0x8000000000010000)

/* -------------------------------------------------------------------------- */
/* ELF Loader Error Codes                                                     */
/* -------------------------------------------------------------------------- */

#define BFELF_SUCCESS ec_sign(SUCCESS)
#define BFELF_ERROR_INVALID_ARG ec_sign(0x8000000000100000)
#define BFELF_ERROR_INVALID_FILE ec_sign(0x8000000000200000)
#define BFELF_ERROR_INVALID_INDEX ec_sign(0x8000000000300000)
#define BFELF_ERROR_INVALID_SIGNATURE ec_sign(0x8000000000500000)
#define BFELF_ERROR_UNSUPPORTED_FILE ec_sign(0x8000000000600000)
#define BFELF_ERROR_INVALID_SEGMENT ec_sign(0x8000000000700000)
#define BFELF_ERROR_INVALID_SECTION ec_sign(0x8000000000800000)
#define BFELF_ERROR_LOADER_FULL ec_sign(0x8000000000900000)
#define BFELF_ERROR_NO_SUCH_SYMBOL ec_sign(0x8000000000A00000)
#define BFELF_ERROR_MISMATCH ec_sign(0x8000000000B00000)
#define BFELF_ERROR_UNSUPPORTED_RELA ec_sign(0x8000000000C00000)
#define BFELF_ERROR_OUT_OF_ORDER ec_sign(0x8000000000D00000)

/* -------------------------------------------------------------------------- */
/* Memory Manager Error Codes                                                 */
/* -------------------------------------------------------------------------- */

#define MEMORY_MANAGER_SUCCESS ec_sign(SUCCESS)
#define MEMORY_MANAGER_FAILURE ec_sign(0x8000000001000000)

/* -------------------------------------------------------------------------- */
/* Common Error Codes                                                         */
/* -------------------------------------------------------------------------- */

#define BF_SUCCESS ec_sign(SUCCESS)
#define BF_ERROR_INVALID_ARG ec_sign(0x8000000010000000)
#define BF_ERROR_INVALID_INDEX ec_sign(0x8000000020000000)
#define BF_ERROR_NO_MODULES_ADDED ec_sign(0x8000000030000000)
#define BF_ERROR_MAX_MODULES_REACHED ec_sign(0x8000000040000000)
#define BF_ERROR_VMM_INVALID_STATE ec_sign(0x8000000050000000)
#define BF_ERROR_FAILED_TO_ADD_FILE ec_sign(0x8000000060000000)
#define BF_ERROR_FAILED_TO_DUMP_DR ec_sign(0x8000000070000000)
#define BF_ERROR_OUT_OF_MEMORY ec_sign(0x8000000080000000)
#define BF_ERROR_VMM_CORRUPTED ec_sign(0x8000000090000000)
#define BF_ERROR_UNKNOWN ec_sign(0x80000000A0000000)

/* -------------------------------------------------------------------------- */
/* IOCTL Error Codes                                                          */
/* -------------------------------------------------------------------------- */

#define BF_IOCTL_SUCCESS ec_sign(SUCCESS)
#define BF_IOCTL_FAILURE ec_sign(-1)

/* -------------------------------------------------------------------------- */
/* Bad Alloc                                                                  */
/* -------------------------------------------------------------------------- */

#define BF_BAD_ALLOC ec_sign(0x8000000100000000)

/* -------------------------------------------------------------------------- */
/* VMCall                                                                     */
/* -------------------------------------------------------------------------- */

#define BF_VMCALL_SUCCESS ec_sign(SUCCESS)
#define BF_VMCALL_FAILURE ec_sign(0x8000001000000000)

/* -------------------------------------------------------------------------- */
/* Stringify Error Codes                                                      */
/* -------------------------------------------------------------------------- */

#define EC_CASE(a) \
    case a: return #a

static inline const char *
ec_to_str(int64_t value)
{
    switch (value)
    {
            EC_CASE(SUCCESS);
            EC_CASE(ENTRY_ERROR_STACK_OVERFLOW);
            EC_CASE(ENTRY_ERROR_VMM_INIT_FAILED);
            EC_CASE(ENTRY_ERROR_VMM_START_FAILED);
            EC_CASE(ENTRY_ERROR_VMM_STOP_FAILED);
            EC_CASE(ENTRY_ERROR_UNKNOWN);
            EC_CASE(CRT_FAILURE);
            EC_CASE(REGISTER_EH_FRAME_FAILURE);
            EC_CASE(GET_DRR_FAILURE);
            EC_CASE(MEMORY_MANAGER_FAILURE);
            EC_CASE(BFELF_ERROR_INVALID_ARG);
            EC_CASE(BFELF_ERROR_INVALID_FILE);
            EC_CASE(BFELF_ERROR_INVALID_INDEX);
            EC_CASE(BFELF_ERROR_INVALID_SIGNATURE);
            EC_CASE(BFELF_ERROR_UNSUPPORTED_FILE);
            EC_CASE(BFELF_ERROR_INVALID_SEGMENT);
            EC_CASE(BFELF_ERROR_INVALID_SECTION);
            EC_CASE(BFELF_ERROR_LOADER_FULL);
            EC_CASE(BFELF_ERROR_NO_SUCH_SYMBOL);
            EC_CASE(BFELF_ERROR_MISMATCH);
            EC_CASE(BFELF_ERROR_UNSUPPORTED_RELA);
            EC_CASE(BFELF_ERROR_OUT_OF_ORDER);
            EC_CASE(BF_ERROR_INVALID_ARG);
            EC_CASE(BF_ERROR_INVALID_INDEX);
            EC_CASE(BF_ERROR_NO_MODULES_ADDED);
            EC_CASE(BF_ERROR_MAX_MODULES_REACHED);
            EC_CASE(BF_ERROR_VMM_INVALID_STATE);
            EC_CASE(BF_ERROR_FAILED_TO_ADD_FILE);
            EC_CASE(BF_ERROR_FAILED_TO_DUMP_DR);
            EC_CASE(BF_ERROR_OUT_OF_MEMORY);
            EC_CASE(BF_ERROR_VMM_CORRUPTED);
            EC_CASE(BF_ERROR_UNKNOWN);
            EC_CASE(BF_BAD_ALLOC);
            EC_CASE(BF_IOCTL_FAILURE);

        default:
            return "UNDEFINED_ERROR_CODE";
    }
}

#endif