165b0b297db16252835ab4d78f33578baa3ace28aChris Lattner//===-- MCInstPrinter.h - 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#ifndef LLVM_MC_MCINSTPRINTER_H 1165b0b297db16252835ab4d78f33578baa3ace28aChris Lattner#define LLVM_MC_MCINSTPRINTER_H 1265b0b297db16252835ab4d78f33578baa3ace28aChris Lattner 13d9791538156702ac1f92ca2984a8ab536deda4f1Benjamin Kramer#include "llvm/Support/DataTypes.h" 1414ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby#include "llvm/Support/Format.h" 1514ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 1665b0b297db16252835ab4d78f33578baa3ace28aChris Lattnernamespace llvm { 1765b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerclass MCInst; 1865b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerclass raw_ostream; 19c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattnerclass MCAsmInfo; 2017463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topperclass MCInstrInfo; 21c6449b636f4984be88f128d0375c056ad05e7e8fJim Grosbachclass MCRegisterInfo; 227e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattnerclass StringRef; 23c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattner 2444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Maleanamespace HexStyle { 2544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea enum Style { 2644c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea C, ///< 0xff 2744c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea Asm ///< 0ffh 2844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea }; 2944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea} 3044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea 3165b0b297db16252835ab4d78f33578baa3ace28aChris Lattner/// MCInstPrinter - This is an instance of a target assembly language printer 3265b0b297db16252835ab4d78f33578baa3ace28aChris Lattner/// that converts an MCInst to valid target assembly syntax. 3365b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerclass MCInstPrinter { 34c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattnerprotected: 355d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// CommentStream - a stream that comments can be emitted to if desired. 365d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// Each comment must end with a newline. This will be null if verbose 375d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// assembly emission is disable. 385d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner raw_ostream *CommentStream; 39c493fb2f4d67bfe4b695d9067eae178ced5970ccChris Lattner const MCAsmInfo &MAI; 4017463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topper const MCInstrInfo &MII; 41c6449b636f4984be88f128d0375c056ad05e7e8fJim Grosbach const MCRegisterInfo &MRI; 4244dcfd36253570ccd5f00189eb918604473135e0Bill Wendling 4344dcfd36253570ccd5f00189eb918604473135e0Bill Wendling /// The current set of available features. 44f21c18db9fa8bf185a44287f5700fec3d4a98e14Joey Gouly uint64_t AvailableFeatures; 4598c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson 463ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby /// True if we are printing marked up assembly. 473ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby bool UseMarkup; 483ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby 4914ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby /// True if we are printing immediates as hex. 5014ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby bool PrintImmHex; 5114ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 5244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea /// Which style to use for printing hexadecimal values. 5344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea HexStyle::Style PrintHexStyle; 5444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea 5598c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson /// Utility function for printing annotations. 5698c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson void printAnnotation(raw_ostream &OS, StringRef Annot); 5765b0b297db16252835ab4d78f33578baa3ace28aChris Lattnerpublic: 5817463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topper MCInstPrinter(const MCAsmInfo &mai, const MCInstrInfo &mii, 5917463b3ef1a3d39b10619254f12e806c8c43f9e7Craig Topper const MCRegisterInfo &mri) 60dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines : CommentStream(nullptr), MAI(mai), MII(mii), MRI(mri), 61dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines AvailableFeatures(0), UseMarkup(0), PrintImmHex(0), 62dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines PrintHexStyle(HexStyle::C) {} 63fd2eaed4f0a9375071a448993c573a124370ed34Jim Grosbach 6465b0b297db16252835ab4d78f33578baa3ace28aChris Lattner virtual ~MCInstPrinter(); 655d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner 665d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner /// setCommentStream - Specify a stream to emit comments to. 675d672cfab096390690a1a5f33b0057c4cf252c55Chris Lattner void setCommentStream(raw_ostream &OS) { CommentStream = &OS; } 68fd2eaed4f0a9375071a448993c573a124370ed34Jim Grosbach 69d374087be5360a353a4239a155b1227057145f48Chris Lattner /// printInst - Print the specified MCInst to the specified raw_ostream. 7065b0b297db16252835ab4d78f33578baa3ace28aChris Lattner /// 7198c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson virtual void printInst(const MCInst *MI, raw_ostream &OS, 7298c5ddabca1debf935a07d14d0cbc9732374bdb8Owen Anderson StringRef Annot) = 0; 73ede042dc8d59ff48a48ef8e2271f2a7ee8324ba5Owen Anderson 747e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner /// getOpcodeName - Return the name of the specified opcode enum (e.g. 757e85180d15c4d5a451fbc078f7194a41c6230a57Chris Lattner /// "MOV32ri") or empty if we can't resolve it. 76c97ef618d2d849a272a353c2b4343fc5902cd921Benjamin Kramer StringRef getOpcodeName(unsigned Opcode) const; 7757caad7a33ff145b71545f10dcfbbf2fd0f595d3Anton Korobeynikov 78cde4ce411b1ace4a80ea1dd38df97e8508aed0c9Rafael Espindola /// printRegName - Print the assembler register name. 79cde4ce411b1ace4a80ea1dd38df97e8508aed0c9Rafael Espindola virtual void printRegName(raw_ostream &OS, unsigned RegNo) const; 8044dcfd36253570ccd5f00189eb918604473135e0Bill Wendling 81f21c18db9fa8bf185a44287f5700fec3d4a98e14Joey Gouly uint64_t getAvailableFeatures() const { return AvailableFeatures; } 82f21c18db9fa8bf185a44287f5700fec3d4a98e14Joey Gouly void setAvailableFeatures(uint64_t Value) { AvailableFeatures = Value; } 833ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby 843ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby bool getUseMarkup() const { return UseMarkup; } 853ed0316f756e2f1730f46654776fcf77f5ace7aaKevin Enderby void setUseMarkup(bool Value) { UseMarkup = Value; } 86e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby 87e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby /// Utility functions to make adding mark ups simpler. 88e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby StringRef markup(StringRef s) const; 89e1d4a8813427b76c5f59cf5b70a9df734b7e9284Kevin Enderby StringRef markup(StringRef a, StringRef b) const; 9014ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 9114ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby bool getPrintImmHex() const { return PrintImmHex; } 9214ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby void setPrintImmHex(bool Value) { PrintImmHex = Value; } 9314ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby 9444c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea HexStyle::Style getPrintHexStyleHex() const { return PrintHexStyle; } 9544c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea void setPrintImmHex(HexStyle::Style Value) { PrintHexStyle = Value; } 9644c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea 9714ccc9007a932a23201251ced4be4c898a62d6a5Kevin Enderby /// Utility function to print immediates in decimal or hex. 9844c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea format_object1<int64_t> formatImm(const int64_t Value) const { return PrintImmHex ? formatHex(Value) : formatDec(Value); } 9944c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea 10044c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea /// Utility functions to print decimal/hexadecimal values. 10144c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea format_object1<int64_t> formatDec(const int64_t Value) const; 10244c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea format_object1<int64_t> formatHex(const int64_t Value) const; 10344c8e346c79cc2affa31385df254b85aa0f5c869Daniel Malea format_object1<uint64_t> formatHex(const uint64_t Value) const; 10465b0b297db16252835ab4d78f33578baa3ace28aChris Lattner}; 105fd2eaed4f0a9375071a448993c573a124370ed34Jim Grosbach 10665b0b297db16252835ab4d78f33578baa3ace28aChris Lattner} // namespace llvm 10765b0b297db16252835ab4d78f33578baa3ace28aChris Lattner 10865b0b297db16252835ab4d78f33578baa3ace28aChris Lattner#endif 109