Status.h

Go to the documentation of this file.

/***************************************************************************************************
 
  Zyan Disassembler Library (Zydis)
 
  Original Author : Florian Bernd
 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 
***************************************************************************************************/
 
#ifndef ZYDIS_STATUS_H
#define ZYDIS_STATUS_H
 
#include <Zydis/CommonTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ============================================================================================== */
/* Enums and types                                                                                */
/* ============================================================================================== */
 
typedef uint32_t ZydisStatus;
 
enum ZydisStatusCode
{
    /* ------------------------------------------------------------------------------------------ */
    /* General                                                                                    */
    /* ------------------------------------------------------------------------------------------ */
 
    ZYDIS_STATUS_SUCCESS                                                              = 0x00000000,
    ZYDIS_STATUS_INVALID_PARAMETER,
    ZYDIS_STATUS_INVALID_OPERATION,
    ZYDIS_STATUS_INSUFFICIENT_BUFFER_SIZE,
 
    /* ------------------------------------------------------------------------------------------ */
    /* Decoder                                                                                    */
    /* ------------------------------------------------------------------------------------------ */
 
    ZYDIS_STATUS_NO_MORE_DATA,
    ZYDIS_STATUS_DECODING_ERROR, 
    ZYDIS_STATUS_INSTRUCTION_TOO_LONG,
    ZYDIS_STATUS_BAD_REGISTER,
    ZYDIS_STATUS_ILLEGAL_LOCK,
    ZYDIS_STATUS_ILLEGAL_LEGACY_PFX,
    ZYDIS_STATUS_ILLEGAL_REX,
    ZYDIS_STATUS_INVALID_MAP,
    ZYDIS_STATUS_MALFORMED_EVEX,
    ZYDIS_STATUS_MALFORMED_MVEX, // TODO: Do we need this?
    ZYDIS_STATUS_INVALID_MASK,
 
    /* ------------------------------------------------------------------------------------------ */
    /* Encoder                                                                                    */
    /* ------------------------------------------------------------------------------------------ */
 
    ZYDIS_STATUS_IMPOSSIBLE_INSTRUCTION,
 
    /* ------------------------------------------------------------------------------------------ */
    /* Misc                                                                                       */
    /* ------------------------------------------------------------------------------------------ */
 
    ZYDIS_STATUS_USER                                                                 = 0x10000000
 
    // Max value entry intentionally omitted since users might 
    // define custom error codes for formatter hooks.
};
 
/* ============================================================================================== */
/* Macros                                                                                         */
/* ============================================================================================== */
 
#define ZYDIS_SUCCESS(status) (status == ZYDIS_STATUS_SUCCESS)
 
#define ZYDIS_CHECK(status) \
    do \
    { \
        ZydisStatus s = status; \
        if (!ZYDIS_SUCCESS(s)) \
        { \
            return s; \
        } \
    } while (0)
 
/* ============================================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZYDIS_STATUS_H */