MCInstrDesc.h

Go to the documentation of this file.

//===-- llvm/MC/MCInstrDesc.h - Instruction Descriptors -*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file defines the MCOperandInfo and MCInstrDesc classes, which
// are used to describe target instructions and their operands.
//
//===----------------------------------------------------------------------===//
 
/* Capstone Disassembly Engine */
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2015 */
 
#ifndef CS_LLVM_MC_MCINSTRDESC_H
#define CS_LLVM_MC_MCINSTRDESC_H
 
#include "capstone/platform.h"
 
//===----------------------------------------------------------------------===//
// Machine Operand Flags and Description
//===----------------------------------------------------------------------===//
 
// Operand constraints
enum MCOI_OperandConstraint {
    MCOI_TIED_TO = 0,    // Must be allocated the same register as.
    MCOI_EARLY_CLOBBER   // Operand is an early clobber register operand
};
 
enum MCOI_OperandFlags {
    MCOI_LookupPtrRegClass = 0,
    MCOI_Predicate,
    MCOI_OptionalDef
};
 
enum MCOI_OperandType {
    MCOI_OPERAND_UNKNOWN,
    MCOI_OPERAND_IMMEDIATE,
    MCOI_OPERAND_REGISTER,
    MCOI_OPERAND_MEMORY,
    MCOI_OPERAND_PCREL
};
 
 
typedef struct MCOperandInfo {
    int16_t RegClass;
 
    uint8_t Flags;
 
    uint8_t OperandType;
 
    uint32_t Constraints;
} MCOperandInfo;
 
 
//===----------------------------------------------------------------------===//
// Machine Instruction Flags and Description
//===----------------------------------------------------------------------===//
 
enum {
    MCID_Variadic = 0,
    MCID_HasOptionalDef,
    MCID_Pseudo,
    MCID_Return,
    MCID_Call,
    MCID_Barrier,
    MCID_Terminator,
    MCID_Branch,
    MCID_IndirectBranch,
    MCID_Compare,
    MCID_MoveImm,
    MCID_Bitcast,
    MCID_Select,
    MCID_DelaySlot,
    MCID_FoldableAsLoad,
    MCID_MayLoad,
    MCID_MayStore,
    MCID_Predicable,
    MCID_NotDuplicable,
    MCID_UnmodeledSideEffects,
    MCID_Commutable,
    MCID_ConvertibleTo3Addr,
    MCID_UsesCustomInserter,
    MCID_HasPostISelHook,
    MCID_Rematerializable,
    MCID_CheapAsAMove,
    MCID_ExtraSrcRegAllocReq,
    MCID_ExtraDefRegAllocReq,
    MCID_RegSequence,
    MCID_ExtractSubreg,
    MCID_InsertSubreg
};
 
typedef struct MCInstrDesc {
    unsigned short  Opcode;        // The opcode number
    unsigned char  NumOperands;   // Num of args (may be more if variable_ops)
    unsigned char  NumDefs;       // Num of args that are definitions
    unsigned short  SchedClass;    // enum identifying instr sched class
    unsigned char  Size;          // Number of bytes in encoding.
    unsigned        Flags;         // Flags identifying machine instr class
    uint64_t        TSFlags;       // Target Specific Flag values
    char ImplicitUses;  // Registers implicitly read by this instr
    char ImplicitDefs;  // Registers implicitly defined by this instr
    const MCOperandInfo *OpInfo;   // 'NumOperands' entries about operands
    uint64_t DeprecatedFeatureMask;// Feature bits that this is deprecated on, if any     
    // A complex method to determine is a certain is deprecated or not, and return        
    // the reason for deprecation.
    //bool (*ComplexDeprecationInfo)(MCInst &, MCSubtargetInfo &, std::string &);           
    unsigned char ComplexDeprecationInfo;   // dummy field, just to satisfy initializer
} MCInstrDesc;
 
bool MCOperandInfo_isPredicate(const MCOperandInfo *m);
 
bool MCOperandInfo_isOptionalDef(const MCOperandInfo *m);
 
#endif