Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 1 | //===-- EDMain.cpp - LLVM Enhanced Disassembly C API ----------------------===// |
Sean Callanan | bd51cdd | 2010-01-29 01:30:01 +0000 | [diff] [blame] | 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 implements the enhanced disassembler's public C API. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Daniel Dunbar | 5a93995 | 2011-11-29 00:25:57 +0000 | [diff] [blame] | 14 | #include "EDDisassembler.h" |
| 15 | #include "EDInst.h" |
| 16 | #include "EDOperand.h" |
| 17 | #include "EDToken.h" |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 18 | #include "llvm-c/EnhancedDisassembly.h" |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 19 | using namespace llvm; |
Sean Callanan | bd51cdd | 2010-01-29 01:30:01 +0000 | [diff] [blame] | 20 | |
| 21 | int EDGetDisassembler(EDDisassemblerRef *disassembler, |
| 22 | const char *triple, |
| 23 | EDAssemblySyntax_t syntax) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 24 | EDDisassembler::AssemblySyntax Syntax; |
| 25 | switch (syntax) { |
Craig Topper | 8581438 | 2012-02-07 05:05:23 +0000 | [diff] [blame] | 26 | default: llvm_unreachable("Unknown assembly syntax!"); |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 27 | case kEDAssemblySyntaxX86Intel: |
| 28 | Syntax = EDDisassembler::kEDAssemblySyntaxX86Intel; |
| 29 | break; |
| 30 | case kEDAssemblySyntaxX86ATT: |
| 31 | Syntax = EDDisassembler::kEDAssemblySyntaxX86ATT; |
| 32 | break; |
| 33 | case kEDAssemblySyntaxARMUAL: |
| 34 | Syntax = EDDisassembler::kEDAssemblySyntaxARMUAL; |
| 35 | break; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 36 | } |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 37 | |
| 38 | EDDisassemblerRef ret = EDDisassembler::getDisassembler(triple, Syntax); |
| 39 | |
| 40 | if (!ret) |
| 41 | return -1; |
| 42 | *disassembler = ret; |
| 43 | return 0; |
Sean Callanan | bd51cdd | 2010-01-29 01:30:01 +0000 | [diff] [blame] | 44 | } |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 45 | |
| 46 | int EDGetRegisterName(const char** regName, |
| 47 | EDDisassemblerRef disassembler, |
| 48 | unsigned regID) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 49 | const char *name = ((EDDisassembler*)disassembler)->nameWithRegisterID(regID); |
Sean Callanan | 8f993b8 | 2010-04-08 00:48:21 +0000 | [diff] [blame] | 50 | if (!name) |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 51 | return -1; |
| 52 | *regName = name; |
| 53 | return 0; |
| 54 | } |
| 55 | |
| 56 | int EDRegisterIsStackPointer(EDDisassemblerRef disassembler, |
| 57 | unsigned regID) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 58 | return ((EDDisassembler*)disassembler)->registerIsStackPointer(regID) ? 1 : 0; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | int EDRegisterIsProgramCounter(EDDisassemblerRef disassembler, |
| 62 | unsigned regID) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 63 | return ((EDDisassembler*)disassembler)->registerIsProgramCounter(regID) ? 1:0; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 64 | } |
| 65 | |
| 66 | unsigned int EDCreateInsts(EDInstRef *insts, |
| 67 | unsigned int count, |
| 68 | EDDisassemblerRef disassembler, |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 69 | ::EDByteReaderCallback byteReader, |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 70 | uint64_t address, |
| 71 | void *arg) { |
| 72 | unsigned int index; |
| 73 | |
Sean Callanan | 8f993b8 | 2010-04-08 00:48:21 +0000 | [diff] [blame] | 74 | for (index = 0; index < count; ++index) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 75 | EDInst *inst = ((EDDisassembler*)disassembler)->createInst(byteReader, |
| 76 | address, arg); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 77 | |
Sean Callanan | 8f993b8 | 2010-04-08 00:48:21 +0000 | [diff] [blame] | 78 | if (!inst) |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 79 | return index; |
| 80 | |
| 81 | insts[index] = inst; |
| 82 | address += inst->byteSize(); |
| 83 | } |
| 84 | |
| 85 | return count; |
| 86 | } |
| 87 | |
| 88 | void EDReleaseInst(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 89 | delete ((EDInst*)inst); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | int EDInstByteSize(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 93 | return ((EDInst*)inst)->byteSize(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | int EDGetInstString(const char **buf, |
| 97 | EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 98 | return ((EDInst*)inst)->getString(*buf); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | int EDInstID(unsigned *instID, EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 102 | *instID = ((EDInst*)inst)->instID(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 103 | return 0; |
| 104 | } |
| 105 | |
| 106 | int EDInstIsBranch(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 107 | return ((EDInst*)inst)->isBranch(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 108 | } |
| 109 | |
| 110 | int EDInstIsMove(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 111 | return ((EDInst*)inst)->isMove(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | int EDBranchTargetID(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 115 | return ((EDInst*)inst)->branchTargetID(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 116 | } |
| 117 | |
| 118 | int EDMoveSourceID(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 119 | return ((EDInst*)inst)->moveSourceID(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 120 | } |
| 121 | |
| 122 | int EDMoveTargetID(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 123 | return ((EDInst*)inst)->moveTargetID(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | int EDNumTokens(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 127 | return ((EDInst*)inst)->numTokens(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 128 | } |
| 129 | |
| 130 | int EDGetToken(EDTokenRef *token, |
| 131 | EDInstRef inst, |
| 132 | int index) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 133 | return ((EDInst*)inst)->getToken(*(EDToken**)token, index); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 134 | } |
| 135 | |
| 136 | int EDGetTokenString(const char **buf, |
| 137 | EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 138 | return ((EDToken*)token)->getString(*buf); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | int EDOperandIndexForToken(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 142 | return ((EDToken*)token)->operandID(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | int EDTokenIsWhitespace(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 146 | return ((EDToken*)token)->type() == EDToken::kTokenWhitespace; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 147 | } |
| 148 | |
| 149 | int EDTokenIsPunctuation(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 150 | return ((EDToken*)token)->type() == EDToken::kTokenPunctuation; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 151 | } |
| 152 | |
| 153 | int EDTokenIsOpcode(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 154 | return ((EDToken*)token)->type() == EDToken::kTokenOpcode; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | int EDTokenIsLiteral(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 158 | return ((EDToken*)token)->type() == EDToken::kTokenLiteral; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | int EDTokenIsRegister(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 162 | return ((EDToken*)token)->type() == EDToken::kTokenRegister; |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 163 | } |
| 164 | |
| 165 | int EDTokenIsNegativeLiteral(EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 166 | if (((EDToken*)token)->type() != EDToken::kTokenLiteral) |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 167 | return -1; |
| 168 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 169 | return ((EDToken*)token)->literalSign(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 170 | } |
| 171 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 172 | int EDLiteralTokenAbsoluteValue(uint64_t *value, EDTokenRef token) { |
| 173 | if (((EDToken*)token)->type() != EDToken::kTokenLiteral) |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 174 | return -1; |
| 175 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 176 | return ((EDToken*)token)->literalAbsoluteValue(*value); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | int EDRegisterTokenValue(unsigned *registerID, |
| 180 | EDTokenRef token) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 181 | if (((EDToken*)token)->type() != EDToken::kTokenRegister) |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 182 | return -1; |
| 183 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 184 | return ((EDToken*)token)->registerID(*registerID); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | int EDNumOperands(EDInstRef inst) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 188 | return ((EDInst*)inst)->numOperands(); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 189 | } |
| 190 | |
| 191 | int EDGetOperand(EDOperandRef *operand, |
| 192 | EDInstRef inst, |
| 193 | int index) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 194 | return ((EDInst*)inst)->getOperand(*(EDOperand**)operand, index); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 195 | } |
| 196 | |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 197 | int EDOperandIsRegister(EDOperandRef operand) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 198 | return ((EDOperand*)operand)->isRegister(); |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 199 | } |
| 200 | |
| 201 | int EDOperandIsImmediate(EDOperandRef operand) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 202 | return ((EDOperand*)operand)->isImmediate(); |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | int EDOperandIsMemory(EDOperandRef operand) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 206 | return ((EDOperand*)operand)->isMemory(); |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 207 | } |
| 208 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 209 | int EDRegisterOperandValue(unsigned *value, EDOperandRef operand) { |
| 210 | if (!((EDOperand*)operand)->isRegister()) |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 211 | return -1; |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 212 | *value = ((EDOperand*)operand)->regVal(); |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 213 | return 0; |
| 214 | } |
| 215 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 216 | int EDImmediateOperandValue(uint64_t *value, EDOperandRef operand) { |
| 217 | if (!((EDOperand*)operand)->isImmediate()) |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 218 | return -1; |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 219 | *value = ((EDOperand*)operand)->immediateVal(); |
Sean Callanan | 7670658 | 2010-02-04 01:43:08 +0000 | [diff] [blame] | 220 | return 0; |
| 221 | } |
| 222 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 223 | int EDEvaluateOperand(uint64_t *result, EDOperandRef operand, |
| 224 | ::EDRegisterReaderCallback regReader, void *arg) { |
| 225 | return ((EDOperand*)operand)->evaluate(*result, regReader, arg); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 226 | } |
| 227 | |
| 228 | #ifdef __BLOCKS__ |
| 229 | |
| 230 | struct ByteReaderWrapper { |
| 231 | EDByteBlock_t byteBlock; |
| 232 | }; |
| 233 | |
| 234 | static int readerWrapperCallback(uint8_t *byte, |
| 235 | uint64_t address, |
| 236 | void *arg) { |
| 237 | struct ByteReaderWrapper *wrapper = (struct ByteReaderWrapper *)arg; |
| 238 | return wrapper->byteBlock(byte, address); |
| 239 | } |
| 240 | |
| 241 | unsigned int EDBlockCreateInsts(EDInstRef *insts, |
| 242 | int count, |
| 243 | EDDisassemblerRef disassembler, |
| 244 | EDByteBlock_t byteBlock, |
| 245 | uint64_t address) { |
| 246 | struct ByteReaderWrapper wrapper; |
| 247 | wrapper.byteBlock = byteBlock; |
| 248 | |
| 249 | return EDCreateInsts(insts, |
| 250 | count, |
| 251 | disassembler, |
| 252 | readerWrapperCallback, |
| 253 | address, |
| 254 | (void*)&wrapper); |
| 255 | } |
| 256 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 257 | int EDBlockEvaluateOperand(uint64_t *result, EDOperandRef operand, |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 258 | EDRegisterBlock_t regBlock) { |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 259 | return ((EDOperand*)operand)->evaluate(*result, regBlock); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 260 | } |
| 261 | |
Chris Lattner | 847da55 | 2010-07-20 18:25:19 +0000 | [diff] [blame] | 262 | int EDBlockVisitTokens(EDInstRef inst, ::EDTokenVisitor_t visitor) { |
| 263 | return ((EDInst*)inst)->visitTokens((llvm::EDTokenVisitor_t)visitor); |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 264 | } |
| 265 | |
Sean Callanan | 37ad466 | 2010-02-02 00:04:46 +0000 | [diff] [blame] | 266 | #else |
| 267 | |
| 268 | extern "C" unsigned int EDBlockCreateInsts() { |
| 269 | return 0; |
| 270 | } |
| 271 | |
| 272 | extern "C" int EDBlockEvaluateOperand() { |
| 273 | return -1; |
| 274 | } |
| 275 | |
| 276 | extern "C" int EDBlockVisitTokens() { |
| 277 | return -1; |
| 278 | } |
| 279 | |
Sean Callanan | ee5dfd4 | 2010-02-01 08:49:35 +0000 | [diff] [blame] | 280 | #endif |