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 ChangeSection(const MCSection *Section) {
  52     LogCall("ChangeSection");
  53     return Child->ChangeSection(Section);
  54   }
  55
  56   virtual void InitSections() {
  57     LogCall("InitSections");
  58     return Child->InitSections();
  59   }
  60
  61   virtual void EmitLabel(MCSymbol *Symbol) {
  62     LogCall("EmitLabel");
  63     return Child->EmitLabel(Symbol);
  64   }
  65
  66   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) {
  67     LogCall("EmitAssemblerFlag");
  68     return Child->EmitAssemblerFlag(Flag);
  69   }
  70
  71   virtual void EmitThumbFunc(MCSymbol *Func) {
  72     LogCall("EmitThumbFunc");
  73     return Child->EmitThumbFunc(Func);
  74   }
  75
  76   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
  77     LogCall("EmitAssignment");
  78     return Child->EmitAssignment(Symbol, Value);
  79   }
  80
  81   virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
  82     LogCall("EmitWeakReference");
  83     return Child->EmitWeakReference(Alias, Symbol);
  84   }
  85
  86   virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
  87                                         const MCSymbol *LastLabel,
  88                                         const MCSymbol *Label,
  89                                         unsigned PointerSize) {
  90     LogCall("EmitDwarfAdvanceLineAddr");
  91     return Child->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label,
  92                                            PointerSize);
  93   }
  94
  95   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) {
  96     LogCall("EmitSymbolAttribute");
  97     return Child->EmitSymbolAttribute(Symbol, Attribute);
  98   }
  99
 100   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 101     LogCall("EmitSymbolDesc");
 102     return Child->EmitSymbolDesc(Symbol, DescValue);
 103   }
 104
 105   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) {
 106     LogCall("BeginCOFFSymbolDef");
 107     return Child->BeginCOFFSymbolDef(Symbol);
 108   }
 109
 110   virtual void EmitCOFFSymbolStorageClass(int StorageClass) {
 111     LogCall("EmitCOFFSymbolStorageClass");
 112     return Child->EmitCOFFSymbolStorageClass(StorageClass);
 113   }
 114
 115   virtual void EmitCOFFSymbolType(int Type) {
 116     LogCall("EmitCOFFSymbolType");
 117     return Child->EmitCOFFSymbolType(Type);
 118   }
 119
 120   virtual void EndCOFFSymbolDef() {
 121     LogCall("EndCOFFSymbolDef");
 122     return Child->EndCOFFSymbolDef();
 123   }
 124
 125   virtual void EmitCOFFSecRel32(MCSymbol const *Symbol) {
 126     LogCall("EmitCOFFSecRel32");
 127     return Child->EmitCOFFSecRel32(Symbol);
 128   }
 129
 130   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 131     LogCall("EmitELFSize");
 132     return Child->EmitELFSize(Symbol, Value);
 133   }
 134
 135   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 136                                 unsigned ByteAlignment) {
 137     LogCall("EmitCommonSymbol");
 138     return Child->EmitCommonSymbol(Symbol, Size, ByteAlignment);
 139   }
 140
 141   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 142                                      unsigned ByteAlignment) {
 143     LogCall("EmitLocalCommonSymbol");
 144     return Child->EmitLocalCommonSymbol(Symbol, Size, ByteAlignment);
 145   }
 146
 147   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 148                             unsigned Size = 0, unsigned ByteAlignment = 0) {
 149     LogCall("EmitZerofill");
 150     return Child->EmitZerofill(Section, Symbol, Size, ByteAlignment);
 151   }
 152
 153   virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
 154                                uint64_t Size, unsigned ByteAlignment = 0) {
 155     LogCall("EmitTBSSSymbol");
 156     return Child->EmitTBSSSymbol(Section, Symbol, Size, ByteAlignment);
 157   }
 158
 159   virtual void EmitBytes(StringRef Data, unsigned AddrSpace) {
 160     LogCall("EmitBytes");
 161     return Child->EmitBytes(Data, AddrSpace);
 162   }
 163
 164   virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
 165                              unsigned AddrSpace){
 166     LogCall("EmitValue");
 167     return Child->EmitValueImpl(Value, Size, AddrSpace);
 168   }
 169
 170   virtual void EmitULEB128Value(const MCExpr *Value) {
 171     LogCall("EmitULEB128Value");
 172     return Child->EmitULEB128Value(Value);
 173   }
 174
 175   virtual void EmitSLEB128Value(const MCExpr *Value) {
 176     LogCall("EmitSLEB128Value");
 177     return Child->EmitSLEB128Value(Value);
 178   }
 179
 180   virtual void EmitGPRel32Value(const MCExpr *Value) {
 181     LogCall("EmitGPRel32Value");
 182     return Child->EmitGPRel32Value(Value);
 183   }
 184
 185   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
 186                         unsigned AddrSpace) {
 187     LogCall("EmitFill");
 188     return Child->EmitFill(NumBytes, FillValue, AddrSpace);
 189   }
 190
 191   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 192                                     unsigned ValueSize = 1,
 193                                     unsigned MaxBytesToEmit = 0) {
 194     LogCall("EmitValueToAlignment");
 195     return Child->EmitValueToAlignment(ByteAlignment, Value,
 196                                        ValueSize, MaxBytesToEmit);
 197   }
 198
 199   virtual void EmitCodeAlignment(unsigned ByteAlignment,
 200                                  unsigned MaxBytesToEmit = 0) {
 201     LogCall("EmitCodeAlignment");
 202     return Child->EmitCodeAlignment(ByteAlignment, MaxBytesToEmit);
 203   }
 204
 205   virtual void EmitValueToOffset(const MCExpr *Offset,
 206                                  unsigned char Value = 0) {
 207     LogCall("EmitValueToOffset");
 208     return Child->EmitValueToOffset(Offset, Value);
 209   }
 210
 211   virtual void EmitFileDirective(StringRef Filename) {
 212     LogCall("EmitFileDirective", "FileName:" + Filename);
 213     return Child->EmitFileDirective(Filename);
 214   }
 215
 216   virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
 217                                       StringRef Filename) {
 218     LogCall("EmitDwarfFileDirective",
 219             "FileNo:" + Twine(FileNo) + " Directory:" + Directory +
 220             " Filename:" + Filename);
 221     return Child->EmitDwarfFileDirective(FileNo, Directory, Filename);
 222   }
 223
 224   virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 225                                      unsigned Column, unsigned Flags,
 226                                      unsigned Isa, unsigned Discriminator,
 227                                      StringRef FileName) {
 228     LogCall("EmitDwarfLocDirective",
 229             "FileNo:" + Twine(FileNo) + " Line:" + Twine(Line) +
 230             " Column:" + Twine(Column) + " Flags:" + Twine(Flags) +
 231             " Isa:" + Twine(Isa) + " Discriminator:" + Twine(Discriminator));
 232             return Child->EmitDwarfLocDirective(FileNo, Line, Column, Flags,
 233                                                 Isa, Discriminator, FileName);
 234   }
 235
 236   virtual void EmitInstruction(const MCInst &Inst) {
 237     LogCall("EmitInstruction");
 238     return Child->EmitInstruction(Inst);
 239   }
 240
 241   virtual void EmitRawText(StringRef String) {
 242     LogCall("EmitRawText", "\"" + String + "\"");
 243     return Child->EmitRawText(String);
 244   }
 245
 246   virtual void Finish() {
 247     LogCall("Finish");
 248     return Child->Finish();
 249   }
 250
 251 };
 252
 253 } // end anonymous namespace.
 254
 255 MCStreamer *llvm::createLoggingStreamer(MCStreamer *Child, raw_ostream &OS) {
 256   return new MCLoggingStreamer(Child, OS);
 257 }