lp_bld_debug.cpp revision 1633dcd890d97bd5e4d125d57f2f529f04d14477
1/************************************************************************** 2 * 3 * Copyright 2009-2011 VMware, Inc. 4 * All Rights Reserved. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the 8 * "Software"), to deal in the Software without restriction, including 9 * without limitation the rights to use, copy, modify, merge, publish, 10 * distribute, sub license, and/or sell copies of the Software, and to 11 * permit persons to whom the Software is furnished to do so, subject to 12 * the following conditions: 13 * 14 * The above copyright notice and this permission notice (including the 15 * next paragraph) shall be included in all copies or substantial portions 16 * of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR 22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 * 26 **************************************************************************/ 27 28#include <stddef.h> 29 30#include <llvm-c/Core.h> 31#include <llvm/Target/TargetMachine.h> 32#include <llvm/Target/TargetInstrInfo.h> 33#include <llvm/Support/raw_ostream.h> 34#include <llvm/Support/MemoryObject.h> 35 36#if HAVE_LLVM >= 0x0300 37#include <llvm/Support/TargetRegistry.h> 38#include <llvm/Support/TargetSelect.h> 39#else /* HAVE_LLVM < 0x0300 */ 40#include <llvm/Target/TargetRegistry.h> 41#include <llvm/Target/TargetSelect.h> 42#endif /* HAVE_LLVM < 0x0300 */ 43 44#if HAVE_LLVM >= 0x0209 45#include <llvm/Support/Host.h> 46#else /* HAVE_LLVM < 0x0209 */ 47#include <llvm/System/Host.h> 48#endif /* HAVE_LLVM < 0x0209 */ 49 50#if HAVE_LLVM >= 0x0207 51#include <llvm/MC/MCDisassembler.h> 52#include <llvm/MC/MCAsmInfo.h> 53#include <llvm/MC/MCInst.h> 54#include <llvm/MC/MCInstPrinter.h> 55#endif /* HAVE_LLVM >= 0x0207 */ 56 57#include "util/u_math.h" 58#include "util/u_debug.h" 59 60#include "lp_bld_debug.h" 61 62 63 64/** 65 * Check alignment. 66 * 67 * It is important that this check is not implemented as a macro or inlined 68 * function, as the compiler assumptions in respect to alignment of global 69 * and stack variables would often make the check a no op, defeating the 70 * whole purpose of the exercise. 71 */ 72extern "C" boolean 73lp_check_alignment(const void *ptr, unsigned alignment) 74{ 75 assert(util_is_power_of_two(alignment)); 76 return ((uintptr_t)ptr & (alignment - 1)) == 0; 77} 78 79 80class raw_debug_ostream : 81 public llvm::raw_ostream 82{ 83 uint64_t pos; 84 85 void write_impl(const char *Ptr, size_t Size); 86 uint64_t current_pos() { return pos; } 87 uint64_t current_pos() const { return pos; } 88 89#if HAVE_LLVM >= 0x207 90 uint64_t preferred_buffer_size() { return 512; } 91#else 92 size_t preferred_buffer_size() { return 512; } 93#endif 94}; 95 96 97void 98raw_debug_ostream::write_impl(const char *Ptr, size_t Size) 99{ 100 if (Size > 0) { 101 char *lastPtr = (char *)&Ptr[Size]; 102 char last = *lastPtr; 103 *lastPtr = 0; 104 _debug_printf("%*s", Size, Ptr); 105 *lastPtr = last; 106 pos += Size; 107 } 108} 109 110 111/** 112 * Same as LLVMDumpValue, but through our debugging channels. 113 */ 114extern "C" void 115lp_debug_dump_value(LLVMValueRef value) 116{ 117#if (defined(PIPE_OS_WINDOWS) && !defined(PIPE_CC_MSVC)) || defined(PIPE_OS_EMBDDED) 118 raw_debug_ostream os; 119 llvm::unwrap(value)->print(os); 120 os.flush(); 121#else 122 LLVMDumpValue(value); 123#endif 124} 125 126 127#if HAVE_LLVM >= 0x0207 128/* 129 * MemoryObject wrapper around a buffer of memory, to be used by MC 130 * disassembler. 131 */ 132class BufferMemoryObject: 133 public llvm::MemoryObject 134{ 135private: 136 const uint8_t *Bytes; 137 uint64_t Length; 138public: 139 BufferMemoryObject(const uint8_t *bytes, uint64_t length) : 140 Bytes(bytes), Length(length) 141 { 142 } 143 144 uint64_t getBase() const 145 { 146 return 0; 147 } 148 149 uint64_t getExtent() const 150 { 151 return Length; 152 } 153 154 int readByte(uint64_t addr, uint8_t *byte) const 155 { 156 if (addr > getExtent()) 157 return -1; 158 *byte = Bytes[addr]; 159 return 0; 160 } 161}; 162#endif /* HAVE_LLVM >= 0x0207 */ 163 164 165/* 166 * Disassemble a function, using the LLVM MC disassembler. 167 * 168 * See also: 169 * - http://blog.llvm.org/2010/01/x86-disassembler.html 170 * - http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html 171 */ 172extern "C" void 173lp_disassemble(const void* func) 174{ 175#if HAVE_LLVM >= 0x0207 176 using namespace llvm; 177 178 const uint8_t *bytes = (const uint8_t *)func; 179 180 /* 181 * Limit disassembly to this extent 182 */ 183 const uint64_t extent = 0x10000; 184 185 uint64_t max_pc = 0; 186 187 /* 188 * Initialize all used objects. 189 */ 190 191#if HAVE_LLVM >= 0x0301 192 std::string Triple = sys::getDefaultTargetTriple(); 193#else 194 std::string Triple = sys::getHostTriple(); 195#endif 196 197 std::string Error; 198 const Target *T = TargetRegistry::lookupTarget(Triple, Error); 199 200#if HAVE_LLVM >= 0x0208 201 InitializeNativeTargetAsmPrinter(); 202#elif defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64) 203 LLVMInitializeX86AsmPrinter(); 204#elif defined(PIPE_ARCH_ARM) 205 LLVMInitializeARMAsmPrinter(); 206#elif defined(PIPE_ARCH_PPC) 207 LLVMInitializePowerPCAsmPrinter(); 208#endif 209 210#if defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64) 211 LLVMInitializeX86Disassembler(); 212#elif defined(PIPE_ARCH_ARM) 213 LLVMInitializeARMDisassembler(); 214#endif 215 216#if HAVE_LLVM >= 0x0300 217 OwningPtr<const MCAsmInfo> AsmInfo(T->createMCAsmInfo(Triple)); 218#else 219 OwningPtr<const MCAsmInfo> AsmInfo(T->createAsmInfo(Triple)); 220#endif 221 222 if (!AsmInfo) { 223 debug_printf("error: no assembly info for target %s\n", Triple.c_str()); 224 return; 225 } 226 227#if HAVE_LLVM >= 0x0300 228 const MCSubtargetInfo *STI = T->createMCSubtargetInfo(Triple, sys::getHostCPUName(), ""); 229 OwningPtr<const MCDisassembler> DisAsm(T->createMCDisassembler(*STI)); 230#else 231 OwningPtr<const MCDisassembler> DisAsm(T->createMCDisassembler()); 232#endif 233 if (!DisAsm) { 234 debug_printf("error: no disassembler for target %s\n", Triple.c_str()); 235 return; 236 } 237 238 raw_debug_ostream Out; 239 240#if HAVE_LLVM >= 0x0300 241 unsigned int AsmPrinterVariant = AsmInfo->getAssemblerDialect(); 242#else 243 int AsmPrinterVariant = AsmInfo->getAssemblerDialect(); 244#endif 245 246#if HAVE_LLVM >= 0x0301 247 OwningPtr<const MCRegisterInfo> MRI(T->createMCRegInfo(Triple)); 248 if (!MRI) { 249 debug_printf("error: no register info for target %s\n", Triple.c_str()); 250 return; 251 } 252#endif 253 254#if HAVE_LLVM >= 0x0301 255 OwningPtr<MCInstPrinter> Printer( 256 T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo, *MRI, *STI)); 257#elif HAVE_LLVM == 0x0300 258 OwningPtr<MCInstPrinter> Printer( 259 T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo, *STI)); 260#elif HAVE_LLVM >= 0x0208 261 OwningPtr<MCInstPrinter> Printer( 262 T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo)); 263#else 264 OwningPtr<MCInstPrinter> Printer( 265 T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo, Out)); 266#endif 267 if (!Printer) { 268 debug_printf("error: no instruction printer for target %s\n", Triple.c_str()); 269 return; 270 } 271 272#if HAVE_LLVM >= 0x0301 273 TargetOptions options; 274#if defined(DEBUG) 275 options.JITEmitDebugInfo = true; 276#endif 277#if defined(PIPE_ARCH_X86) 278 options.StackAlignmentOverride = 4; 279#endif 280#if defined(DEBUG) || defined(PROFILE) 281 options.NoFramePointerElim = true; 282#endif 283 TargetMachine *TM = T->createTargetMachine(Triple, sys::getHostCPUName(), "", options); 284#elif HAVE_LLVM == 0x0300 285 TargetMachine *TM = T->createTargetMachine(Triple, sys::getHostCPUName(), ""); 286#else 287 TargetMachine *TM = T->createTargetMachine(Triple, ""); 288#endif 289 290 const TargetInstrInfo *TII = TM->getInstrInfo(); 291 292 /* 293 * Wrap the data in a MemoryObject 294 */ 295 BufferMemoryObject memoryObject((const uint8_t *)bytes, extent); 296 297 uint64_t pc; 298 pc = 0; 299 while (true) { 300 MCInst Inst; 301 uint64_t Size; 302 303 /* 304 * Print address. We use addresses relative to the start of the function, 305 * so that between runs. 306 */ 307 308 debug_printf("%6lu:\t", (unsigned long)pc); 309 310 if (!DisAsm->getInstruction(Inst, Size, memoryObject, 311 pc, 312#if HAVE_LLVM >= 0x0300 313 nulls(), nulls())) { 314#else 315 nulls())) { 316#endif 317 debug_printf("invalid\n"); 318 pc += 1; 319 } 320 321 /* 322 * Output the bytes in hexidecimal format. 323 */ 324 325 if (0) { 326 unsigned i; 327 for (i = 0; i < Size; ++i) { 328 debug_printf("%02x ", ((const uint8_t*)bytes)[pc + i]); 329 } 330 for (; i < 16; ++i) { 331 debug_printf(" "); 332 } 333 } 334 335 /* 336 * Print the instruction. 337 */ 338 339#if HAVE_LLVM >= 0x0300 340 Printer->printInst(&Inst, Out, ""); 341#elif HAVE_LLVM >= 0x208 342 Printer->printInst(&Inst, Out); 343#else 344 Printer->printInst(&Inst); 345#endif 346 Out.flush(); 347 348 /* 349 * Advance. 350 */ 351 352 pc += Size; 353 354#if HAVE_LLVM >= 0x0300 355 const MCInstrDesc &TID = TII->get(Inst.getOpcode()); 356#else 357 const TargetInstrDesc &TID = TII->get(Inst.getOpcode()); 358#endif 359 360 /* 361 * Keep track of forward jumps to a nearby address. 362 */ 363 364 if (TID.isBranch()) { 365 for (unsigned i = 0; i < Inst.getNumOperands(); ++i) { 366 const MCOperand &operand = Inst.getOperand(i); 367 if (operand.isImm()) { 368 uint64_t jump; 369 370 /* 371 * FIXME: Handle both relative and absolute addresses correctly. 372 * EDInstInfo actually has this info, but operandTypes and 373 * operandFlags enums are not exposed in the public interface. 374 */ 375 376 if (1) { 377 /* 378 * PC relative addr. 379 */ 380 381 jump = pc + operand.getImm(); 382 } else { 383 /* 384 * Absolute addr. 385 */ 386 387 jump = (uint64_t)operand.getImm(); 388 } 389 390 /* 391 * Output the address relative to the function start, given 392 * that MC will print the addresses relative the current pc. 393 */ 394 debug_printf("\t\t; %lu", (unsigned long)jump); 395 396 /* 397 * Ignore far jumps given it could be actually a tail return to 398 * a random address. 399 */ 400 401 if (jump > max_pc && 402 jump < extent) { 403 max_pc = jump; 404 } 405 } 406 } 407 } 408 409 debug_printf("\n"); 410 411 /* 412 * Stop disassembling on return statements, if there is no record of a 413 * jump to a successive address. 414 */ 415 416 if (TID.isReturn()) { 417 if (pc > max_pc) { 418 break; 419 } 420 } 421 } 422 423 /* 424 * Print GDB command, useful to verify output. 425 */ 426 427 if (0) { 428 debug_printf("disassemble %p %p\n", bytes, bytes + pc); 429 } 430 431 debug_printf("\n"); 432#else /* HAVE_LLVM < 0x0207 */ 433 (void)func; 434#endif /* HAVE_LLVM < 0x0207 */ 435} 436 437