lib/MC/MCInstPrinter.cpp

   1 //===- MCInstPrinter.cpp - Convert an MCInst to target assembly syntax ----===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "llvm/MC/MCInstPrinter.h"
  10 #include "llvm/ADT/ArrayRef.h"
  11 #include "llvm/ADT/StringRef.h"
  12 #include "llvm/MC/MCAsmInfo.h"
  13 #include "llvm/MC/MCInstrInfo.h"
  14 #include "llvm/Support/ErrorHandling.h"
  15 #include "llvm/Support/Format.h"
  16 #include "llvm/Support/raw_ostream.h"
  17 #include <cinttypes>
  18 #include <cstdint>
  19
  20 using namespace llvm;
  21
  22 void llvm::dumpBytes(ArrayRef<uint8_t> bytes, raw_ostream &OS) {
  23   static const char hex_rep[] = "0123456789abcdef";
  24   bool First = true;
  25   for (char i: bytes) {
  26     if (First)
  27       First = false;
  28     else
  29       OS << ' ';
  30     OS << hex_rep[(i & 0xF0) >> 4];
  31     OS << hex_rep[i & 0xF];
  32   }
  33 }
  34
  35 MCInstPrinter::~MCInstPrinter() = default;
  36
  37 /// getOpcodeName - Return the name of the specified opcode enum (e.g.
  38 /// "MOV32ri") or empty if we can't resolve it.
  39 StringRef MCInstPrinter::getOpcodeName(unsigned Opcode) const {
  40   return MII.getName(Opcode);
  41 }
  42
  43 void MCInstPrinter::printRegName(raw_ostream &OS, unsigned RegNo) const {
  44   llvm_unreachable("Target should implement this");
  45 }
  46
  47 void MCInstPrinter::printAnnotation(raw_ostream &OS, StringRef Annot) {
  48   if (!Annot.empty()) {
  49     if (CommentStream) {
  50       (*CommentStream) << Annot;
  51       // By definition (see MCInstPrinter.h), CommentStream must end with
  52       // a newline after each comment.
  53       if (Annot.back() != '\n')
  54         (*CommentStream) << '\n';
  55     } else
  56       OS << " " << MAI.getCommentString() << " " << Annot;
  57   }
  58 }
  59
  60 /// Utility functions to make adding mark ups simpler.
  61 StringRef MCInstPrinter::markup(StringRef s) const {
  62   if (getUseMarkup())
  63     return s;
  64   else
  65     return "";
  66 }
  67 StringRef MCInstPrinter::markup(StringRef a, StringRef b) const {
  68   if (getUseMarkup())
  69     return a;
  70   else
  71     return b;
  72 }
  73
  74 // For asm-style hex (e.g. 0ffh) the first digit always has to be a number.
  75 static bool needsLeadingZero(uint64_t Value)
  76 {
  77   while (Value)
  78   {
  79     uint64_t digit = (Value >> 60) & 0xf;
  80     if (digit != 0)
  81       return (digit >= 0xa);
  82     Value <<= 4;
  83   }
  84   return false;
  85 }
  86
  87 format_object<int64_t> MCInstPrinter::formatDec(int64_t Value) const {
  88   return format("%" PRId64, Value);
  89 }
  90
  91 format_object<int64_t> MCInstPrinter::formatHex(int64_t Value) const {
  92   switch(PrintHexStyle) {
  93   case HexStyle::C:
  94     if (Value < 0)
  95       return format("-0x%" PRIx64, -Value);
  96     else
  97       return format("0x%" PRIx64, Value);
  98   case HexStyle::Asm:
  99     if (Value < 0) {
 100       if (needsLeadingZero((uint64_t)(-Value)))
 101         return format("-0%" PRIx64 "h", -Value);
 102       else
 103         return format("-%" PRIx64 "h", -Value);
 104     } else {
 105       if (needsLeadingZero((uint64_t)(Value)))
 106         return format("0%" PRIx64 "h", Value);
 107       else
 108         return format("%" PRIx64 "h", Value);
 109     }
 110   }
 111   llvm_unreachable("unsupported print style");
 112 }
 113
 114 format_object<uint64_t> MCInstPrinter::formatHex(uint64_t Value) const {
 115   switch(PrintHexStyle) {
 116   case HexStyle::C:
 117      return format("0x%" PRIx64, Value);
 118   case HexStyle::Asm:
 119     if (needsLeadingZero(Value))
 120       return format("0%" PRIx64 "h", Value);
 121     else
 122       return format("%" PRIx64 "h", Value);
 123   }
 124   llvm_unreachable("unsupported print style");
 125 }