lib/MC/MCLoggingStreamer.cpp

   1 //===- lib/MC/MCLoggingStreamer.cpp - API Logging Streamer ----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/MC/MCStreamer.h"
  11 #include "llvm/ADT/OwningPtr.h"
  12 #include "llvm/ADT/Twine.h"
  13 #include "llvm/Support/raw_ostream.h"
  14 using namespace llvm;
  15
  16 namespace {
  17
  18 class MCLoggingStreamer : public MCStreamer {
  19   llvm::OwningPtr<MCStreamer> Child;
  20
  21   raw_ostream &OS;
  22
  23 public:
  24   MCLoggingStreamer(MCStreamer *_Child, raw_ostream &_OS)
  25     : MCStreamer(_Child->getContext()), Child(_Child), OS(_OS) {}
  26
  27   void LogCall(const char *Function) {
  28     OS << Function << "\n";
  29   }
  30
  31   void LogCall(const char *Function, const Twine &Message) {
  32     OS << Function << ": " << Message << "\n";
  33   }
  34
  35   virtual bool isVerboseAsm() const { return Child->isVerboseAsm(); }
  36
  37   virtual bool hasRawTextSupport() const { return Child->hasRawTextSupport(); }
  38
  39   virtual raw_ostream &GetCommentOS() { return Child->GetCommentOS(); }
  40
  41   virtual void AddComment(const Twine &T) {
  42     LogCall("AddComment", T);
  43     return Child->AddComment(T);
  44   }
  45
  46   virtual void AddBlankLine() {
  47     LogCall("AddBlankLine");
  48     return Child->AddBlankLine();
  49   }
  50
  51   virtual void SwitchSection(const MCSection *Section) {
  52     CurSection = Section;
  53     LogCall("SwitchSection");
  54     return Child->SwitchSection(Section);
  55   }
  56
  57   virtual void InitSections() {
  58     LogCall("InitSections");
  59     return Child->InitSections();
  60   }
  61
  62   virtual void EmitLabel(MCSymbol *Symbol) {
  63     LogCall("EmitLabel");
  64     return Child->EmitLabel(Symbol);
  65   }
  66
  67   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) {
  68     LogCall("EmitAssemblerFlag");
  69     return Child->EmitAssemblerFlag(Flag);
  70   }
  71
  72   virtual void EmitThumbFunc(MCSymbol *Func) {
  73     LogCall("EmitThumbFunc");
  74     return Child->EmitThumbFunc(Func);
  75   }
  76
  77   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
  78     LogCall("EmitAssignment");
  79     return Child->EmitAssignment(Symbol, Value);
  80   }
  81
  82   virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
  83     LogCall("EmitWeakReference");
  84     return Child->EmitWeakReference(Alias, Symbol);
  85   }
  86
  87   virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
  88                                         const MCSymbol *LastLabel,
  89                                         const MCSymbol *Label) {
  90     LogCall("EmitDwarfAdvanceLineAddr");
  91     return Child->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label);
  92   }
  93
  94   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) {
  95     LogCall("EmitSymbolAttribute");
  96     return Child->EmitSymbolAttribute(Symbol, Attribute);
  97   }
  98
  99   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 100     LogCall("EmitSymbolDesc");
 101     return Child->EmitSymbolDesc(Symbol, DescValue);
 102   }
 103
 104   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) {
 105     LogCall("BeginCOFFSymbolDef");
 106     return Child->BeginCOFFSymbolDef(Symbol);
 107   }
 108
 109   virtual void EmitCOFFSymbolStorageClass(int StorageClass) {
 110     LogCall("EmitCOFFSymbolStorageClass");
 111     return Child->EmitCOFFSymbolStorageClass(StorageClass);
 112   }
 113
 114   virtual void EmitCOFFSymbolType(int Type) {
 115     LogCall("EmitCOFFSymbolType");
 116     return Child->EmitCOFFSymbolType(Type);
 117   }
 118
 119   virtual void EndCOFFSymbolDef() {
 120     LogCall("EndCOFFSymbolDef");
 121     return Child->EndCOFFSymbolDef();
 122   }
 123
 124   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 125     LogCall("EmitELFSize");
 126     return Child->EmitELFSize(Symbol, Value);
 127   }
 128
 129   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 130                                 unsigned ByteAlignment) {
 131     LogCall("EmitCommonSymbol");
 132     return Child->EmitCommonSymbol(Symbol, Size, ByteAlignment);
 133   }
 134
 135   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
 136     LogCall("EmitLocalCommonSymbol");
 137     return Child->EmitLocalCommonSymbol(Symbol, Size);
 138   }
 139
 140   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 141                             unsigned Size = 0, unsigned ByteAlignment = 0) {
 142     LogCall("EmitZerofill");
 143     return Child->EmitZerofill(Section, Symbol, Size, ByteAlignment);
 144   }
 145
 146   virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
 147                                uint64_t Size, unsigned ByteAlignment = 0) {
 148     LogCall("EmitTBSSSymbol");
 149     return Child->EmitTBSSSymbol(Section, Symbol, Size, ByteAlignment);
 150   }
 151
 152   virtual void EmitBytes(StringRef Data, unsigned AddrSpace) {
 153     LogCall("EmitBytes");
 154     return Child->EmitBytes(Data, AddrSpace);
 155   }
 156
 157   virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
 158                              bool isPCRel, unsigned AddrSpace){
 159     LogCall("EmitValue");
 160     return Child->EmitValueImpl(Value, Size, isPCRel, AddrSpace);
 161   }
 162
 163   virtual void EmitULEB128Value(const MCExpr *Value,
 164                                 unsigned AddrSpace = 0) {
 165     LogCall("EmitULEB128Value");
 166     return Child->EmitULEB128Value(Value, AddrSpace);
 167   }
 168
 169   virtual void EmitSLEB128Value(const MCExpr *Value,
 170                                 unsigned AddrSpace = 0) {
 171     LogCall("EmitSLEB128Value");
 172     return Child->EmitSLEB128Value(Value, AddrSpace);
 173   }
 174
 175   virtual void EmitGPRel32Value(const MCExpr *Value) {
 176     LogCall("EmitGPRel32Value");
 177     return Child->EmitGPRel32Value(Value);
 178   }
 179
 180   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
 181                         unsigned AddrSpace) {
 182     LogCall("EmitFill");
 183     return Child->EmitFill(NumBytes, FillValue, AddrSpace);
 184   }
 185
 186   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 187                                     unsigned ValueSize = 1,
 188                                     unsigned MaxBytesToEmit = 0) {
 189     LogCall("EmitValueToAlignment");
 190     return Child->EmitValueToAlignment(ByteAlignment, Value,
 191                                        ValueSize, MaxBytesToEmit);
 192   }
 193
 194   virtual void EmitCodeAlignment(unsigned ByteAlignment,
 195                                  unsigned MaxBytesToEmit = 0) {
 196     LogCall("EmitCodeAlignment");
 197     return Child->EmitCodeAlignment(ByteAlignment, MaxBytesToEmit);
 198   }
 199
 200   virtual void EmitValueToOffset(const MCExpr *Offset,
 201                                  unsigned char Value = 0) {
 202     LogCall("EmitValueToOffset");
 203     return Child->EmitValueToOffset(Offset, Value);
 204   }
 205
 206   virtual void EmitFileDirective(StringRef Filename) {
 207     LogCall("EmitFileDirective", "FileName:" + Filename);
 208     return Child->EmitFileDirective(Filename);
 209   }
 210
 211   virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Filename) {
 212     LogCall("EmitDwarfFileDirective",
 213             "FileNo:" + Twine(FileNo) + " Filename:" + Filename);
 214     return Child->EmitDwarfFileDirective(FileNo, Filename);
 215   }
 216
 217   virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 218                                      unsigned Column, unsigned Flags,
 219                                      unsigned Isa, unsigned Discriminator) {
 220     LogCall("EmitDwarfLocDirective",
 221             "FileNo:" + Twine(FileNo) + " Line:" + Twine(Line) +
 222             " Column:" + Twine(Column) + " Flags:" + Twine(Flags) +
 223             " Isa:" + Twine(Isa) + " Discriminator:" + Twine(Discriminator));
 224             return Child->EmitDwarfLocDirective(FileNo, Line, Column, Flags,
 225                                                 Isa, Discriminator);
 226   }
 227
 228   virtual void EmitInstruction(const MCInst &Inst) {
 229     LogCall("EmitInstruction");
 230     return Child->EmitInstruction(Inst);
 231   }
 232
 233   virtual void EmitRawText(StringRef String) {
 234     LogCall("EmitRawText", "\"" + String + "\"");
 235     return Child->EmitRawText(String);
 236   }
 237
 238   virtual void Finish() {
 239     LogCall("Finish");
 240     return Child->Finish();
 241   }
 242
 243 };
 244
 245 } // end anonymous namespace.
 246
 247 MCStreamer *llvm::createLoggingStreamer(MCStreamer *Child, raw_ostream &OS) {
 248   return new MCLoggingStreamer(Child, OS);
 249 }