165b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//===-- MCInstPrinter.cpp - Convert an MCInst to target assembly syntax ---===//
265b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//
365b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//                     The LLVM Compiler Infrastructure
465b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//
565b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// This file is distributed under the University of Illinois Open Source
665b0b297db16252835ab4d78f33578baa3ace28aChris Lattner// License. See LICENSE.TXT for details.
765b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//
865b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//===----------------------------------------------------------------------===//
965b0b297db16252835ab4d78f33578baa3ace28aChris Lattner
1065b0b297db16252835ab4d78f33578baa3ace28aChris Lattner#include "llvm/MC/MCInstPrinter.h"
117e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner#include "llvm/ADT/StringRef.h"
12d04a8d4b33ff316ca4cf961e06c9e312eff8e64fChandler Carruth#include "llvm/MC/MCAsmInfo.h"
13d04a8d4b33ff316ca4cf961e06c9e312eff8e64fChandler Carruth#include "llvm/MC/MCInstrInfo.h"
14858143816d43e58b17bfd11cb1b57afbd7f0f893Craig Topper#include "llvm/Support/ErrorHandling.h"
1514ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby#include "llvm/Support/Format.h"
16ede042dc8d59ff48a48ef8e2271f2a7ee8324ba5Owen Anderson#include "llvm/Support/raw_ostream.h"
1765b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerusing namespace llvm;
1865b0b297db16252835ab4d78f33578baa3ace28aChris Lattner
1965b0b297db16252835ab4d78f33578baa3ace28aChris LattnerMCInstPrinter::~MCInstPrinter() {
20aa5c1b7f9366950b4cbe710c8426d8589d5d975bEdward O'Callaghan}
217e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner
227e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner/// getOpcodeName - Return the name of the specified opcode enum (e.g.
237e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner/// "MOV32ri") or empty if we can't resolve it.
247e85180d15c4d5a451fbc078f7194a41c6230a57Chris LattnerStringRef MCInstPrinter::getOpcodeName(unsigned Opcode) const {
25c97ef618d2d849a272a353c2b4343fc5902cd921Benjamin Kramer  return MII.getName(Opcode);
267e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner}
2757caad7a33ff145b71545f10dcfbbf2fd0f595d3Anton Korobeynikov
28cde4ce411b1ace4a80ea1dd38df97e8508aed0c9Rafael Espindolavoid MCInstPrinter::printRegName(raw_ostream &OS, unsigned RegNo) const {
29858143816d43e58b17bfd11cb1b57afbd7f0f893Craig Topper  llvm_unreachable("Target should implement this");
3057caad7a33ff145b71545f10dcfbbf2fd0f595d3Anton Korobeynikov}
31ede042dc8d59ff48a48ef8e2271f2a7ee8324ba5Owen Anderson
3298c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Andersonvoid MCInstPrinter::printAnnotation(raw_ostream &OS, StringRef Annot) {
33317eaf19937813d630166bfec7b933a98ea89aa5Owen Anderson  if (!Annot.empty()) {
34db3de106376558c7425d557b1b980f631107cd14Quentin Colombet    if (CommentStream) {
359e5887b17e634b98f7c1cf0ee4f25c218097d08eKevin Enderby      (*CommentStream) << Annot;
36db3de106376558c7425d557b1b980f631107cd14Quentin Colombet      // By definition (see MCInstPrinter.h), CommentStream must end with
37db3de106376558c7425d557b1b980f631107cd14Quentin Colombet      // a newline after each comment.
38db3de106376558c7425d557b1b980f631107cd14Quentin Colombet      if (Annot.back() != '\n')
39db3de106376558c7425d557b1b980f631107cd14Quentin Colombet        (*CommentStream) << '\n';
40db3de106376558c7425d557b1b980f631107cd14Quentin Colombet    } else
419e5887b17e634b98f7c1cf0ee4f25c218097d08eKevin Enderby      OS << " " << MAI.getCommentString() << " " << Annot;
42317eaf19937813d630166bfec7b933a98ea89aa5Owen Anderson  }
43ede042dc8d59ff48a48ef8e2271f2a7ee8324ba5Owen Anderson}
44e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby
45e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby/// Utility functions to make adding mark ups simpler.
46e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin EnderbyStringRef MCInstPrinter::markup(StringRef s) const {
47e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby  if (getUseMarkup())
48e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby    return s;
49e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby  else
50e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby    return "";
51e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby}
52e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin EnderbyStringRef MCInstPrinter::markup(StringRef a, StringRef b) const {
53e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby  if (getUseMarkup())
54e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby    return a;
55e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby  else
56e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby    return b;
57e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby}
5814ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby
5944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea// For asm-style hex (e.g. 0ffh) the first digit always has to be a number.
6044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Maleastatic bool needsLeadingZero(uint64_t Value)
6144c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea{
6244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  while(Value)
6344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  {
6444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    uint64_t digit = (Value >> 60) & 0xf;
6544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    if (digit != 0)
6644c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      return (digit >= 0xa);
6744c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    Value <<= 4;
6844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  }
6944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  return false;
7044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea}
7144c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea
7244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Maleaformat_object1<int64_t> MCInstPrinter::formatDec(const int64_t Value) const {
7344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  return format("%" PRId64, Value);
7444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea}
7544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea
7644c8e346c79cc2affa31385df254b85aa0f5c869Daniel Maleaformat_object1<int64_t> MCInstPrinter::formatHex(const int64_t Value) const {
7744c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  switch(PrintHexStyle) {
7844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  case HexStyle::C:
7944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    if (Value < 0)
8044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      return format("-0x%" PRIx64, -Value);
8144c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    else
8244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      return format("0x%" PRIx64, Value);
8344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  case HexStyle::Asm:
8444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    if (Value < 0) {
8544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      if (needsLeadingZero((uint64_t)(-Value)))
8644c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea        return format("-0%" PRIx64 "h", -Value);
8744c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      else
8844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea        return format("-%" PRIx64 "h", -Value);
8944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    } else {
9044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      if (needsLeadingZero((uint64_t)(Value)))
9144c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea        return format("0%" PRIx64 "h", Value);
9244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      else
9344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea        return format("%" PRIx64 "h", Value);
9444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    }
9544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  }
961cd2ed8fdf7547bff3aaedccaac741b8a1d416a3Duncan Sands  llvm_unreachable("unsupported print style");
9744c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea}
9844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea
9944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Maleaformat_object1<uint64_t> MCInstPrinter::formatHex(const uint64_t Value) const {
10044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  switch(PrintHexStyle) {
10144c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  case HexStyle::C:
10244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea     return format("0x%" PRIx64, Value);
10344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  case HexStyle::Asm:
10444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    if (needsLeadingZero(Value))
10544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      return format("0%" PRIx64 "h", Value);
10644c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea    else
10744c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea      return format("%" PRIx64 "h", Value);
10844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea  }
1091cd2ed8fdf7547bff3aaedccaac741b8a1d416a3Duncan Sands  llvm_unreachable("unsupported print style");
11014ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby}
111