src/gallium/auxiliary/gallivm/lp_bld_debug.cpp

   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  */
  72 extern "C" boolean
  73 lp_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
  80 class 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
  97 void
  98 raw_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  */
 114 extern "C" void
 115 lp_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  */
 132 class BufferMemoryObject:
 133    public llvm::MemoryObject
 134 {
 135 private:
 136    const uint8_t *Bytes;
 137    uint64_t Length;
 138 public:
 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 #if HAVE_LLVM >= 0x0301
 150    uint64_t getExtent()
 151 #else
 152    uint64_t getExtent() const
 153 #endif
 154    {
 155       return Length;
 156    }
 157
 158 #if HAVE_LLVM >= 0x0301
 159    int readByte(uint64_t addr, uint8_t *byte)
 160 #else
 161    int readByte(uint64_t addr, uint8_t *byte) const
 162 #endif
 163    {
 164       if (addr > getExtent())
 165          return -1;
 166       *byte = Bytes[addr];
 167       return 0;
 168    }
 169 };
 170 #endif /* HAVE_LLVM >= 0x0207 */
 171
 172
 173 /*
 174  * Disassemble a function, using the LLVM MC disassembler.
 175  *
 176  * See also:
 177  * - http://blog.llvm.org/2010/01/x86-disassembler.html
 178  * - http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html
 179  */
 180 extern "C" void
 181 lp_disassemble(const void* func)
 182 {
 183 #if HAVE_LLVM >= 0x0207
 184    using namespace llvm;
 185
 186    const uint8_t *bytes = (const uint8_t *)func;
 187
 188    /*
 189     * Limit disassembly to this extent
 190     */
 191    const uint64_t extent = 0x10000;
 192
 193    uint64_t max_pc = 0;
 194
 195    /*
 196     * Initialize all used objects.
 197     */
 198
 199 #if HAVE_LLVM >= 0x0301
 200    std::string Triple = sys::getDefaultTargetTriple();
 201 #else
 202    std::string Triple = sys::getHostTriple();
 203 #endif
 204
 205    std::string Error;
 206    const Target *T = TargetRegistry::lookupTarget(Triple, Error);
 207
 208 #if HAVE_LLVM >= 0x0208
 209    InitializeNativeTargetAsmPrinter();
 210 #elif defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64)
 211    LLVMInitializeX86AsmPrinter();
 212 #elif defined(PIPE_ARCH_ARM)
 213    LLVMInitializeARMAsmPrinter();
 214 #elif defined(PIPE_ARCH_PPC)
 215    LLVMInitializePowerPCAsmPrinter();
 216 #endif
 217
 218 #if defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64)
 219    LLVMInitializeX86Disassembler();
 220 #elif defined(PIPE_ARCH_ARM)
 221    LLVMInitializeARMDisassembler();
 222 #endif
 223
 224 #if HAVE_LLVM >= 0x0300
 225    OwningPtr<const MCAsmInfo> AsmInfo(T->createMCAsmInfo(Triple));
 226 #else
 227    OwningPtr<const MCAsmInfo> AsmInfo(T->createAsmInfo(Triple));
 228 #endif
 229
 230    if (!AsmInfo) {
 231       debug_printf("error: no assembly info for target %s\n", Triple.c_str());
 232       return;
 233    }
 234
 235 #if HAVE_LLVM >= 0x0300
 236    const MCSubtargetInfo *STI = T->createMCSubtargetInfo(Triple, sys::getHostCPUName(), "");
 237    OwningPtr<const MCDisassembler> DisAsm(T->createMCDisassembler(*STI));
 238 #else
 239    OwningPtr<const MCDisassembler> DisAsm(T->createMCDisassembler());
 240 #endif
 241    if (!DisAsm) {
 242       debug_printf("error: no disassembler for target %s\n", Triple.c_str());
 243       return;
 244    }
 245
 246    raw_debug_ostream Out;
 247
 248 #if HAVE_LLVM >= 0x0300
 249    unsigned int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
 250 #else
 251    int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
 252 #endif
 253
 254 #if HAVE_LLVM >= 0x0300
 255    OwningPtr<MCInstPrinter> Printer(
 256          T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo, *STI));
 257 #elif HAVE_LLVM >= 0x0208
 258    OwningPtr<MCInstPrinter> Printer(
 259          T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo));
 260 #else
 261    OwningPtr<MCInstPrinter> Printer(
 262          T->createMCInstPrinter(AsmPrinterVariant, *AsmInfo, Out));
 263 #endif
 264    if (!Printer) {
 265       debug_printf("error: no instruction printer for target %s\n", Triple.c_str());
 266       return;
 267    }
 268
 269 #if HAVE_LLVM >= 0x0301
 270    TargetOptions options;
 271 #if defined(DEBUG)
 272    options.JITEmitDebugInfo = true;
 273 #endif
 274 #if defined(PIPE_ARCH_X86)
 275    options.StackAlignmentOverride = 4;
 276 #endif
 277 #if defined(DEBUG) || defined(PROFILE)
 278    options.NoFramePointerElim = true;
 279 #endif
 280    TargetMachine *TM = T->createTargetMachine(Triple, sys::getHostCPUName(), "", options);
 281 #elif HAVE_LLVM == 0x0300
 282    TargetMachine *TM = T->createTargetMachine(Triple, sys::getHostCPUName(), "");
 283 #else
 284    TargetMachine *TM = T->createTargetMachine(Triple, "");
 285 #endif
 286
 287    const TargetInstrInfo *TII = TM->getInstrInfo();
 288
 289    /*
 290     * Wrap the data in a MemoryObject
 291     */
 292    BufferMemoryObject memoryObject((const uint8_t *)bytes, extent);
 293
 294    uint64_t pc;
 295    pc = 0;
 296    while (true) {
 297       MCInst Inst;
 298       uint64_t Size;
 299
 300       /*
 301        * Print address.  We use addresses relative to the start of the function,
 302        * so that between runs.
 303        */
 304
 305       debug_printf("%6lu:\t", (unsigned long)pc);
 306
 307       if (!DisAsm->getInstruction(Inst, Size, memoryObject,
 308                                  pc,
 309 #if HAVE_LLVM >= 0x0300
 310                                   nulls(), nulls())) {
 311 #else
 312                                   nulls())) {
 313 #endif
 314          debug_printf("invalid\n");
 315          pc += 1;
 316       }
 317
 318       /*
 319        * Output the bytes in hexidecimal format.
 320        */
 321
 322       if (0) {
 323          unsigned i;
 324          for (i = 0; i < Size; ++i) {
 325             debug_printf("%02x ", ((const uint8_t*)bytes)[pc + i]);
 326          }
 327          for (; i < 16; ++i) {
 328             debug_printf("   ");
 329          }
 330       }
 331
 332       /*
 333        * Print the instruction.
 334        */
 335
 336 #if HAVE_LLVM >= 0x0300
 337       Printer->printInst(&Inst, Out, "");
 338 #elif HAVE_LLVM >= 0x208
 339       Printer->printInst(&Inst, Out);
 340 #else
 341       Printer->printInst(&Inst);
 342 #endif
 343       Out.flush();
 344
 345       /*
 346        * Advance.
 347        */
 348
 349       pc += Size;
 350
 351 #if HAVE_LLVM >= 0x0300
 352       const MCInstrDesc &TID = TII->get(Inst.getOpcode());
 353 #else
 354       const TargetInstrDesc &TID = TII->get(Inst.getOpcode());
 355 #endif
 356
 357       /*
 358        * Keep track of forward jumps to a nearby address.
 359        */
 360
 361       if (TID.isBranch()) {
 362          for (unsigned i = 0; i < Inst.getNumOperands(); ++i) {
 363             const MCOperand &operand = Inst.getOperand(i);
 364             if (operand.isImm()) {
 365                uint64_t jump;
 366
 367                /*
 368                 * FIXME: Handle both relative and absolute addresses correctly.
 369                 * EDInstInfo actually has this info, but operandTypes and
 370                 * operandFlags enums are not exposed in the public interface.
 371                 */
 372
 373                if (1) {
 374                   /*
 375                    * PC relative addr.
 376                    */
 377
 378                   jump = pc + operand.getImm();
 379                } else {
 380                   /*
 381                    * Absolute addr.
 382                    */
 383
 384                   jump = (uint64_t)operand.getImm();
 385                }
 386
 387                /*
 388                 * Output the address relative to the function start, given
 389                 * that MC will print the addresses relative the current pc.
 390                 */
 391                debug_printf("\t\t; %lu", (unsigned long)jump);
 392
 393                /*
 394                 * Ignore far jumps given it could be actually a tail return to
 395                 * a random address.
 396                 */
 397
 398                if (jump > max_pc &&
 399                    jump < extent) {
 400                   max_pc = jump;
 401                }
 402             }
 403          }
 404       }
 405
 406       debug_printf("\n");
 407
 408       /*
 409        * Stop disassembling on return statements, if there is no record of a
 410        * jump to a successive address.
 411        */
 412
 413       if (TID.isReturn()) {
 414          if (pc > max_pc) {
 415             break;
 416          }
 417       }
 418    }
 419
 420    /*
 421     * Print GDB command, useful to verify output.
 422     */
 423
 424    if (0) {
 425       debug_printf("disassemble %p %p\n", bytes, bytes + pc);
 426    }
 427
 428    debug_printf("\n");
 429 #else /* HAVE_LLVM < 0x0207 */
 430    (void)func;
 431 #endif /* HAVE_LLVM < 0x0207 */
 432 }
 433