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