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 EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) {
  88     LogCall("EmitSymbolAttribute");
  89     return Child->EmitSymbolAttribute(Symbol, Attribute);
  90   }
  91
  92   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
  93     LogCall("EmitSymbolDesc");
  94     return Child->EmitSymbolDesc(Symbol, DescValue);
  95   }
  96
  97   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) {
  98     LogCall("BeginCOFFSymbolDef");
  99     return Child->BeginCOFFSymbolDef(Symbol);
 100   }
 101
 102   virtual void EmitCOFFSymbolStorageClass(int StorageClass) {
 103     LogCall("EmitCOFFSymbolStorageClass");
 104     return Child->EmitCOFFSymbolStorageClass(StorageClass);
 105   }
 106
 107   virtual void EmitCOFFSymbolType(int Type) {
 108     LogCall("EmitCOFFSymbolType");
 109     return Child->EmitCOFFSymbolType(Type);
 110   }
 111
 112   virtual void EndCOFFSymbolDef() {
 113     LogCall("EndCOFFSymbolDef");
 114     return Child->EndCOFFSymbolDef();
 115   }
 116
 117   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 118     LogCall("EmitELFSize");
 119     return Child->EmitELFSize(Symbol, Value);
 120   }
 121
 122   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 123                                 unsigned ByteAlignment) {
 124     LogCall("EmitCommonSymbol");
 125     return Child->EmitCommonSymbol(Symbol, Size, ByteAlignment);
 126   }
 127
 128   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
 129     LogCall("EmitLocalCommonSymbol");
 130     return Child->EmitLocalCommonSymbol(Symbol, Size);
 131   }
 132
 133   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 134                             unsigned Size = 0, unsigned ByteAlignment = 0) {
 135     LogCall("EmitZerofill");
 136     return Child->EmitZerofill(Section, Symbol, Size, ByteAlignment);
 137   }
 138
 139   virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
 140                                uint64_t Size, unsigned ByteAlignment = 0) {
 141     LogCall("EmitTBSSSymbol");
 142     return Child->EmitTBSSSymbol(Section, Symbol, Size, ByteAlignment);
 143   }
 144
 145   virtual void EmitBytes(StringRef Data, unsigned AddrSpace) {
 146     LogCall("EmitBytes");
 147     return Child->EmitBytes(Data, AddrSpace);
 148   }
 149
 150   virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace){
 151     LogCall("EmitValue");
 152     return Child->EmitValue(Value, Size, AddrSpace);
 153   }
 154
 155   virtual void EmitIntValue(uint64_t Value, unsigned Size, unsigned AddrSpace) {
 156     LogCall("EmitIntValue");
 157     return Child->EmitIntValue(Value, Size, AddrSpace);
 158   }
 159
 160   virtual void EmitULEB128Value(const MCExpr *Value,
 161                                 unsigned AddrSpace = 0) {
 162     LogCall("EmitULEB128Value");
 163     return Child->EmitULEB128Value(Value, AddrSpace);
 164   }
 165
 166   virtual void EmitSLEB128Value(const MCExpr *Value,
 167                                 unsigned AddrSpace = 0) {
 168     LogCall("EmitSLEB128Value");
 169     return Child->EmitSLEB128Value(Value, AddrSpace);
 170   }
 171
 172   virtual void EmitGPRel32Value(const MCExpr *Value) {
 173     LogCall("EmitGPRel32Value");
 174     return Child->EmitGPRel32Value(Value);
 175   }
 176
 177   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
 178                         unsigned AddrSpace) {
 179     LogCall("EmitFill");
 180     return Child->EmitFill(NumBytes, FillValue, AddrSpace);
 181   }
 182
 183   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 184                                     unsigned ValueSize = 1,
 185                                     unsigned MaxBytesToEmit = 0) {
 186     LogCall("EmitValueToAlignment");
 187     return Child->EmitValueToAlignment(ByteAlignment, Value,
 188                                        ValueSize, MaxBytesToEmit);
 189   }
 190
 191   virtual void EmitCodeAlignment(unsigned ByteAlignment,
 192                                  unsigned MaxBytesToEmit = 0) {
 193     LogCall("EmitCodeAlignment");
 194     return Child->EmitCodeAlignment(ByteAlignment, MaxBytesToEmit);
 195   }
 196
 197   virtual void EmitValueToOffset(const MCExpr *Offset,
 198                                  unsigned char Value = 0) {
 199     LogCall("EmitValueToOffset");
 200     return Child->EmitValueToOffset(Offset, Value);
 201   }
 202
 203   virtual void EmitFileDirective(StringRef Filename) {
 204     LogCall("EmitFileDirective", "FileName:" + Filename);
 205     return Child->EmitFileDirective(Filename);
 206   }
 207
 208   virtual void EmitDwarfFileDirective(unsigned FileNo, StringRef Filename) {
 209     LogCall("EmitDwarfFileDirective",
 210             "FileNo:" + Twine(FileNo) + " Filename:" + Filename);
 211     return Child->EmitDwarfFileDirective(FileNo, Filename);
 212   }
 213
 214   virtual void EmitInstruction(const MCInst &Inst) {
 215     LogCall("EmitInstruction");
 216     return Child->EmitInstruction(Inst);
 217   }
 218
 219   virtual void EmitRawText(StringRef String) {
 220     LogCall("EmitRawText", "\"" + String + "\"");
 221     return Child->EmitRawText(String);
 222   }
 223
 224   virtual void Finish() {
 225     LogCall("Finish");
 226     return Child->Finish();
 227   }
 228
 229 };
 230
 231 } // end anonymous namespace.
 232
 233 MCStreamer *llvm::createLoggingStreamer(MCStreamer *Child, raw_ostream &OS) {
 234   return new MCLoggingStreamer(Child, OS);
 235 }