Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 1 | //===-- llvm/MC/MCInst.h - MCInst class -------------------------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file contains the declaration of the MCInst and MCOperand classes, which |
| 11 | // is the basic representation used to represent low-level machine code |
| 12 | // instructions. |
| 13 | // |
| 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Nguyen Anh Quynh | 6023ef7 | 2014-04-29 11:21:04 +0800 | [diff] [blame] | 16 | /* Capstone Disassembly Engine */ |
| 17 | /* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2014 */ |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 18 | |
Nguyen Anh Quynh | ae3649f | 2014-01-02 13:15:07 +0800 | [diff] [blame] | 19 | #ifndef CS_MCINST_H |
| 20 | #define CS_MCINST_H |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 21 | |
| 22 | #include <stdint.h> |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 23 | |
| 24 | #include "include/capstone.h" |
| 25 | |
| 26 | typedef struct MCInst MCInst; |
Nguyen Anh Quynh | 42c6b1a | 2013-12-30 00:15:25 +0800 | [diff] [blame] | 27 | typedef struct cs_struct cs_struct; |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 28 | typedef struct MCOperand MCOperand; |
| 29 | |
| 30 | /// MCOperand - Instances of this class represent operands of the MCInst class. |
| 31 | /// This is a simple discriminated union. |
| 32 | struct MCOperand { |
| 33 | enum { |
| 34 | kInvalid = 0, ///< Uninitialized. |
| 35 | kRegister, ///< Register operand. |
| 36 | kImmediate, ///< Immediate operand. |
| 37 | kFPImmediate, ///< Floating-point immediate operand. |
| 38 | } MachineOperandType; |
| 39 | unsigned char Kind; |
| 40 | |
| 41 | union { |
| 42 | unsigned RegVal; |
| 43 | int64_t ImmVal; |
| 44 | double FPImmVal; |
| 45 | }; |
| 46 | }; |
| 47 | |
| 48 | bool MCOperand_isValid(const MCOperand *op); |
| 49 | |
| 50 | bool MCOperand_isReg(const MCOperand *op); |
| 51 | |
| 52 | bool MCOperand_isImm(const MCOperand *op); |
| 53 | |
| 54 | bool MCOperand_isFPImm(const MCOperand *op); |
| 55 | |
| 56 | bool MCOperand_isInst(const MCOperand *op); |
| 57 | |
| 58 | void MCInst_clear(MCInst *m); |
| 59 | |
| 60 | /// getReg - Returns the register number. |
| 61 | unsigned MCOperand_getReg(const MCOperand *op); |
| 62 | |
| 63 | /// setReg - Set the register number. |
| 64 | void MCOperand_setReg(MCOperand *op, unsigned Reg); |
| 65 | |
| 66 | int64_t MCOperand_getImm(MCOperand *op); |
| 67 | |
| 68 | void MCOperand_setImm(MCOperand *op, int64_t Val); |
| 69 | |
| 70 | double MCOperand_getFPImm(const MCOperand *op); |
| 71 | |
| 72 | void MCOperand_setFPImm(MCOperand *op, double Val); |
| 73 | |
| 74 | const MCInst *MCOperand_getInst(const MCOperand *op); |
| 75 | |
| 76 | void MCOperand_setInst(MCOperand *op, const MCInst *Val); |
| 77 | |
Nguyen Anh Quynh | 0f648ea | 2014-06-10 01:01:23 +0700 | [diff] [blame] | 78 | // create Reg operand in the next slot |
Nguyen Anh Quynh | cf08138 | 2014-06-06 00:56:46 +0800 | [diff] [blame] | 79 | void MCOperand_CreateReg0(MCInst *inst, unsigned Reg); |
Nguyen Anh Quynh | 937e483 | 2014-06-04 22:51:51 +0700 | [diff] [blame] | 80 | |
Nguyen Anh Quynh | 0f648ea | 2014-06-10 01:01:23 +0700 | [diff] [blame] | 81 | // create Reg operand use the last-unused slot |
| 82 | MCOperand *MCOperand_CreateReg1(MCInst *inst, unsigned Reg); |
| 83 | |
| 84 | // create Imm operand in the next slot |
Nguyen Anh Quynh | cf08138 | 2014-06-06 00:56:46 +0800 | [diff] [blame] | 85 | void MCOperand_CreateImm0(MCInst *inst, int64_t Val); |
Nguyen Anh Quynh | 937e483 | 2014-06-04 22:51:51 +0700 | [diff] [blame] | 86 | |
Nguyen Anh Quynh | 0f648ea | 2014-06-10 01:01:23 +0700 | [diff] [blame] | 87 | // create Imm operand in the last-unused slot |
| 88 | MCOperand *MCOperand_CreateImm1(MCInst *inst, int64_t Val); |
| 89 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 90 | /// MCInst - Instances of this class represent a single low-level machine |
| 91 | /// instruction. |
| 92 | struct MCInst { |
Nguyen Anh Quynh | 495295e | 2014-06-16 15:54:32 +0800 | [diff] [blame] | 93 | unsigned OpcodePub; |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 94 | unsigned size; // number of operands |
Nguyen Anh Quynh | f1ec526 | 2014-06-25 22:03:18 +0800 | [diff] [blame] | 95 | int has_imm; // indicate this instruction has an X86_OP_IMM operand - used for ATT syntax |
| 96 | unsigned Opcode; |
| 97 | MCOperand Operands[48]; |
Nguyen Anh Quynh | 5329a6f | 2014-06-08 23:35:52 +0700 | [diff] [blame] | 98 | cs_insn *flat_insn; // insn to be exposed to public |
Nguyen Anh Quynh | a209e67 | 2013-12-14 00:23:41 +0800 | [diff] [blame] | 99 | uint64_t address; // address of this insn |
Nguyen Anh Quynh | 42c6b1a | 2013-12-30 00:15:25 +0800 | [diff] [blame] | 100 | cs_struct *csh; // save the main csh |
Nguyen Anh Quynh | 1085073 | 2014-06-18 12:16:24 +0800 | [diff] [blame] | 101 | uint8_t x86opsize; // opsize for [mem] operand |
Nguyen Anh Quynh | a5ffdc3 | 2014-05-07 08:25:24 +0800 | [diff] [blame] | 102 | |
Nguyen Anh Quynh | 1085073 | 2014-06-18 12:16:24 +0800 | [diff] [blame] | 103 | // (Optional) instruction prefix, which can be up to 4 bytes. |
Nguyen Anh Quynh | a5ffdc3 | 2014-05-07 08:25:24 +0800 | [diff] [blame] | 104 | // A prefix byte gets value 0 when irrelevant. |
| 105 | // This is copied from cs_x86 struct |
Nguyen Anh Quynh | 46b6693 | 2014-06-04 19:04:46 +0800 | [diff] [blame] | 106 | uint8_t x86_prefix[4]; |
Nguyen Anh Quynh | f1ec526 | 2014-06-25 22:03:18 +0800 | [diff] [blame] | 107 | uint8_t imm_size; // immediate size for X86_OP_IMM operand |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 108 | }; |
| 109 | |
Nguyen Anh Quynh | 495295e | 2014-06-16 15:54:32 +0800 | [diff] [blame] | 110 | void MCInst_Init(MCInst *inst); |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 111 | |
| 112 | void MCInst_clear(MCInst *inst); |
| 113 | |
Nguyen Anh Quynh | 0f648ea | 2014-06-10 01:01:23 +0700 | [diff] [blame] | 114 | // do not free operand after inserting |
| 115 | void MCInst_insert0(MCInst *inst, int index, MCOperand *Op); |
| 116 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 117 | void MCInst_setOpcode(MCInst *inst, unsigned Op); |
| 118 | |
| 119 | unsigned MCInst_getOpcode(const MCInst*); |
| 120 | |
Nguyen Anh Quynh | 6b7abe3 | 2013-11-30 00:54:24 +0800 | [diff] [blame] | 121 | void MCInst_setOpcodePub(MCInst *inst, unsigned Op); |
| 122 | |
| 123 | unsigned MCInst_getOpcodePub(const MCInst*); |
| 124 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 125 | MCOperand *MCInst_getOperand(MCInst *inst, unsigned i); |
| 126 | |
| 127 | unsigned MCInst_getNumOperands(const MCInst *inst); |
| 128 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 129 | // This addOperand2 function doesnt free Op |
Nguyen Anh Quynh | 264ca37 | 2014-06-16 14:52:09 +0800 | [diff] [blame] | 130 | void MCInst_addOperand2(MCInst *inst, MCOperand *Op); |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 131 | |
| 132 | #endif |