include/llvm/MC/MCDwarf.h

   1 //===- MCDwarf.h - Machine Code Dwarf support -------------------*- C++ -*-===//
   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 // This file contains the declaration of the MCDwarfFile to support the dwarf
  11 // .file directive and the .loc directive.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_MC_MCDWARF_H
  16 #define LLVM_MC_MCDWARF_H
  17
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/ADT/MapVector.h"
  20 #include "llvm/Support/Compiler.h"
  21 #include "llvm/Support/Dwarf.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include <map>
  24 #include <vector>
  25
  26 namespace llvm {
  27 class MCAsmBackend;
  28 class MCContext;
  29 class MCSection;
  30 class MCStreamer;
  31 class MCSymbol;
  32 class SourceMgr;
  33 class SMLoc;
  34
  35 /// MCDwarfFile - Instances of this class represent the name of the dwarf
  36 /// .file directive and its associated dwarf file number in the MC file,
  37 /// and MCDwarfFile's are created and unique'd by the MCContext class where
  38 /// the file number for each is its index into the vector of DwarfFiles (note
  39 /// index 0 is not used and not a valid dwarf file number).
  40 class MCDwarfFile {
  41   // Name - the base name of the file without its directory path.
  42   // The StringRef references memory allocated in the MCContext.
  43   StringRef Name;
  44
  45   // DirIndex - the index into the list of directory names for this file name.
  46   unsigned DirIndex;
  47
  48 private: // MCContext creates and uniques these.
  49   friend class MCContext;
  50   MCDwarfFile(StringRef name, unsigned dirIndex)
  51       : Name(name), DirIndex(dirIndex) {}
  52
  53   MCDwarfFile(const MCDwarfFile &) LLVM_DELETED_FUNCTION;
  54   void operator=(const MCDwarfFile &) LLVM_DELETED_FUNCTION;
  55
  56 public:
  57   /// getName - Get the base name of this MCDwarfFile.
  58   StringRef getName() const { return Name; }
  59
  60   /// getDirIndex - Get the dirIndex of this MCDwarfFile.
  61   unsigned getDirIndex() const { return DirIndex; }
  62
  63   /// print - Print the value to the stream \p OS.
  64   void print(raw_ostream &OS) const;
  65
  66   /// dump - Print the value to stderr.
  67   void dump() const;
  68 };
  69
  70 inline raw_ostream &operator<<(raw_ostream &OS, const MCDwarfFile &DwarfFile) {
  71   DwarfFile.print(OS);
  72   return OS;
  73 }
  74
  75 /// MCDwarfLoc - Instances of this class represent the information from a
  76 /// dwarf .loc directive.
  77 class MCDwarfLoc {
  78   // FileNum - the file number.
  79   unsigned FileNum;
  80   // Line - the line number.
  81   unsigned Line;
  82   // Column - the column position.
  83   unsigned Column;
  84   // Flags (see #define's below)
  85   unsigned Flags;
  86   // Isa
  87   unsigned Isa;
  88   // Discriminator
  89   unsigned Discriminator;
  90
  91 // Flag that indicates the initial value of the is_stmt_start flag.
  92 #define DWARF2_LINE_DEFAULT_IS_STMT 1
  93
  94 #define DWARF2_FLAG_IS_STMT (1 << 0)
  95 #define DWARF2_FLAG_BASIC_BLOCK (1 << 1)
  96 #define DWARF2_FLAG_PROLOGUE_END (1 << 2)
  97 #define DWARF2_FLAG_EPILOGUE_BEGIN (1 << 3)
  98
  99 private: // MCContext manages these
 100   friend class MCContext;
 101   friend class MCLineEntry;
 102   MCDwarfLoc(unsigned fileNum, unsigned line, unsigned column, unsigned flags,
 103              unsigned isa, unsigned discriminator)
 104       : FileNum(fileNum), Line(line), Column(column), Flags(flags), Isa(isa),
 105         Discriminator(discriminator) {}
 106
 107   // Allow the default copy constructor and assignment operator to be used
 108   // for an MCDwarfLoc object.
 109
 110 public:
 111   /// getFileNum - Get the FileNum of this MCDwarfLoc.
 112   unsigned getFileNum() const { return FileNum; }
 113
 114   /// getLine - Get the Line of this MCDwarfLoc.
 115   unsigned getLine() const { return Line; }
 116
 117   /// getColumn - Get the Column of this MCDwarfLoc.
 118   unsigned getColumn() const { return Column; }
 119
 120   /// getFlags - Get the Flags of this MCDwarfLoc.
 121   unsigned getFlags() const { return Flags; }
 122
 123   /// getIsa - Get the Isa of this MCDwarfLoc.
 124   unsigned getIsa() const { return Isa; }
 125
 126   /// getDiscriminator - Get the Discriminator of this MCDwarfLoc.
 127   unsigned getDiscriminator() const { return Discriminator; }
 128
 129   /// setFileNum - Set the FileNum of this MCDwarfLoc.
 130   void setFileNum(unsigned fileNum) { FileNum = fileNum; }
 131
 132   /// setLine - Set the Line of this MCDwarfLoc.
 133   void setLine(unsigned line) { Line = line; }
 134
 135   /// setColumn - Set the Column of this MCDwarfLoc.
 136   void setColumn(unsigned column) { Column = column; }
 137
 138   /// setFlags - Set the Flags of this MCDwarfLoc.
 139   void setFlags(unsigned flags) { Flags = flags; }
 140
 141   /// setIsa - Set the Isa of this MCDwarfLoc.
 142   void setIsa(unsigned isa) { Isa = isa; }
 143
 144   /// setDiscriminator - Set the Discriminator of this MCDwarfLoc.
 145   void setDiscriminator(unsigned discriminator) {
 146     Discriminator = discriminator;
 147   }
 148 };
 149
 150 /// MCLineEntry - Instances of this class represent the line information for
 151 /// the dwarf line table entries.  Which is created after a machine
 152 /// instruction is assembled and uses an address from a temporary label
 153 /// created at the current address in the current section and the info from
 154 /// the last .loc directive seen as stored in the context.
 155 class MCLineEntry : public MCDwarfLoc {
 156   MCSymbol *Label;
 157
 158 private:
 159   // Allow the default copy constructor and assignment operator to be used
 160   // for an MCLineEntry object.
 161
 162 public:
 163   // Constructor to create an MCLineEntry given a symbol and the dwarf loc.
 164   MCLineEntry(MCSymbol *label, const MCDwarfLoc loc)
 165       : MCDwarfLoc(loc), Label(label) {}
 166
 167   MCSymbol *getLabel() const { return Label; }
 168
 169   // This is called when an instruction is assembled into the specified
 170   // section and if there is information from the last .loc directive that
 171   // has yet to have a line entry made for it is made.
 172   static void Make(MCStreamer *MCOS, const MCSection *Section);
 173 };
 174
 175 /// MCLineSection - Instances of this class represent the line information
 176 /// for a compile unit where machine instructions have been assembled after seeing
 177 /// .loc directives.  This is the information used to build the dwarf line
 178 /// table for a section.
 179 class MCLineSection {
 180 public:
 181   // addLineEntry - adds an entry to this MCLineSection's line entries
 182   void addLineEntry(const MCLineEntry &LineEntry, const MCSection *Sec) {
 183     MCLineDivisions[Sec].push_back(LineEntry);
 184   }
 185
 186   typedef std::vector<MCLineEntry> MCLineEntryCollection;
 187   typedef MCLineEntryCollection::iterator iterator;
 188   typedef MCLineEntryCollection::const_iterator const_iterator;
 189   typedef MapVector<const MCSection *, MCLineEntryCollection> MCLineDivisionMap;
 190
 191 private:
 192   // A collection of MCLineEntry for each section.
 193   MCLineDivisionMap MCLineDivisions;
 194
 195 public:
 196   // Returns the collection of MCLineEntry for a given Compile Unit ID.
 197   const MCLineDivisionMap &getMCLineEntries() const {
 198     return MCLineDivisions;
 199   }
 200 };
 201
 202 class MCDwarfFileTable {
 203   MCSymbol *Label;
 204   SmallVector<StringRef, 3> MCDwarfDirs;
 205   SmallVector<MCDwarfFile *, 3> MCDwarfFiles;
 206   MCLineSection MCLineSections;
 207
 208 public:
 209   //
 210   // This emits the Dwarf file and the line tables for all Compile Units.
 211   //
 212   static const MCSymbol *Emit(MCStreamer *MCOS);
 213   //
 214   // This emits the Dwarf file and the line tables for a given Compile Unit.
 215   //
 216   const MCSymbol *EmitCU(MCStreamer *MCOS) const;
 217
 218   const SmallVectorImpl<StringRef> &getMCDwarfDirs() const {
 219     return MCDwarfDirs;
 220   }
 221
 222   SmallVectorImpl<StringRef> &getMCDwarfDirs() {
 223     return MCDwarfDirs;
 224   }
 225
 226   const SmallVectorImpl<MCDwarfFile *> &getMCDwarfFiles() const {
 227     return MCDwarfFiles;
 228   }
 229
 230   SmallVectorImpl<MCDwarfFile *> &getMCDwarfFiles() {
 231     return MCDwarfFiles;
 232   }
 233
 234   const MCLineSection &getMCLineSections() const {
 235     return MCLineSections;
 236   }
 237   MCLineSection &getMCLineSections() {
 238     return MCLineSections;
 239   }
 240
 241   MCSymbol *getLabel() const {
 242     return Label;
 243   }
 244
 245   void setLabel(MCSymbol *Label) {
 246     this->Label = Label;
 247   }
 248 };
 249
 250 class MCDwarfLineAddr {
 251 public:
 252   /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
 253   static void Encode(MCContext &Context, int64_t LineDelta, uint64_t AddrDelta,
 254                      raw_ostream &OS);
 255
 256   /// Utility function to emit the encoding to a streamer.
 257   static void Emit(MCStreamer *MCOS, int64_t LineDelta, uint64_t AddrDelta);
 258 };
 259
 260 class MCGenDwarfInfo {
 261 public:
 262   //
 263   // When generating dwarf for assembly source files this emits the Dwarf
 264   // sections.
 265   //
 266   static void Emit(MCStreamer *MCOS, const MCSymbol *LineSectionSymbol);
 267 };
 268
 269 // When generating dwarf for assembly source files this is the info that is
 270 // needed to be gathered for each symbol that will have a dwarf label.
 271 class MCGenDwarfLabelEntry {
 272 private:
 273   // Name of the symbol without a leading underbar, if any.
 274   StringRef Name;
 275   // The dwarf file number this symbol is in.
 276   unsigned FileNumber;
 277   // The line number this symbol is at.
 278   unsigned LineNumber;
 279   // The low_pc for the dwarf label is taken from this symbol.
 280   MCSymbol *Label;
 281
 282 public:
 283   MCGenDwarfLabelEntry(StringRef name, unsigned fileNumber, unsigned lineNumber,
 284                        MCSymbol *label)
 285       : Name(name), FileNumber(fileNumber), LineNumber(lineNumber),
 286         Label(label) {}
 287
 288   StringRef getName() const { return Name; }
 289   unsigned getFileNumber() const { return FileNumber; }
 290   unsigned getLineNumber() const { return LineNumber; }
 291   MCSymbol *getLabel() const { return Label; }
 292
 293   // This is called when label is created when we are generating dwarf for
 294   // assembly source files.
 295   static void Make(MCSymbol *Symbol, MCStreamer *MCOS, SourceMgr &SrcMgr,
 296                    SMLoc &Loc);
 297 };
 298
 299 class MCCFIInstruction {
 300 public:
 301   enum OpType {
 302     OpSameValue,
 303     OpRememberState,
 304     OpRestoreState,
 305     OpOffset,
 306     OpDefCfaRegister,
 307     OpDefCfaOffset,
 308     OpDefCfa,
 309     OpRelOffset,
 310     OpAdjustCfaOffset,
 311     OpEscape,
 312     OpRestore,
 313     OpUndefined,
 314     OpRegister,
 315     OpWindowSave
 316   };
 317
 318 private:
 319   OpType Operation;
 320   MCSymbol *Label;
 321   unsigned Register;
 322   union {
 323     int Offset;
 324     unsigned Register2;
 325   };
 326   std::vector<char> Values;
 327
 328   MCCFIInstruction(OpType Op, MCSymbol *L, unsigned R, int O, StringRef V)
 329       : Operation(Op), Label(L), Register(R), Offset(O),
 330         Values(V.begin(), V.end()) {
 331     assert(Op != OpRegister);
 332   }
 333
 334   MCCFIInstruction(OpType Op, MCSymbol *L, unsigned R1, unsigned R2)
 335       : Operation(Op), Label(L), Register(R1), Register2(R2) {
 336     assert(Op == OpRegister);
 337   }
 338
 339 public:
 340   /// \brief .cfi_def_cfa defines a rule for computing CFA as: take address from
 341   /// Register and add Offset to it.
 342   static MCCFIInstruction createDefCfa(MCSymbol *L, unsigned Register,
 343                                        int Offset) {
 344     return MCCFIInstruction(OpDefCfa, L, Register, -Offset, "");
 345   }
 346
 347   /// \brief .cfi_def_cfa_register modifies a rule for computing CFA. From now
 348   /// on Register will be used instead of the old one. Offset remains the same.
 349   static MCCFIInstruction createDefCfaRegister(MCSymbol *L, unsigned Register) {
 350     return MCCFIInstruction(OpDefCfaRegister, L, Register, 0, "");
 351   }
 352
 353   /// \brief .cfi_def_cfa_offset modifies a rule for computing CFA. Register
 354   /// remains the same, but offset is new. Note that it is the absolute offset
 355   /// that will be added to a defined register to the compute CFA address.
 356   static MCCFIInstruction createDefCfaOffset(MCSymbol *L, int Offset) {
 357     return MCCFIInstruction(OpDefCfaOffset, L, 0, -Offset, "");
 358   }
 359
 360   /// \brief .cfi_adjust_cfa_offset Same as .cfi_def_cfa_offset, but
 361   /// Offset is a relative value that is added/subtracted from the previous
 362   /// offset.
 363   static MCCFIInstruction createAdjustCfaOffset(MCSymbol *L, int Adjustment) {
 364     return MCCFIInstruction(OpAdjustCfaOffset, L, 0, Adjustment, "");
 365   }
 366
 367   /// \brief .cfi_offset Previous value of Register is saved at offset Offset
 368   /// from CFA.
 369   static MCCFIInstruction createOffset(MCSymbol *L, unsigned Register,
 370                                        int Offset) {
 371     return MCCFIInstruction(OpOffset, L, Register, Offset, "");
 372   }
 373
 374   /// \brief .cfi_rel_offset Previous value of Register is saved at offset
 375   /// Offset from the current CFA register. This is transformed to .cfi_offset
 376   /// using the known displacement of the CFA register from the CFA.
 377   static MCCFIInstruction createRelOffset(MCSymbol *L, unsigned Register,
 378                                           int Offset) {
 379     return MCCFIInstruction(OpRelOffset, L, Register, Offset, "");
 380   }
 381
 382   /// \brief .cfi_register Previous value of Register1 is saved in
 383   /// register Register2.
 384   static MCCFIInstruction createRegister(MCSymbol *L, unsigned Register1,
 385                                          unsigned Register2) {
 386     return MCCFIInstruction(OpRegister, L, Register1, Register2);
 387   }
 388
 389   /// \brief .cfi_window_save SPARC register window is saved.
 390   static MCCFIInstruction createWindowSave(MCSymbol *L) {
 391     return MCCFIInstruction(OpWindowSave, L, 0, 0, "");
 392   }
 393
 394   /// \brief .cfi_restore says that the rule for Register is now the same as it
 395   /// was at the beginning of the function, after all initial instructions added
 396   /// by .cfi_startproc were executed.
 397   static MCCFIInstruction createRestore(MCSymbol *L, unsigned Register) {
 398     return MCCFIInstruction(OpRestore, L, Register, 0, "");
 399   }
 400
 401   /// \brief .cfi_undefined From now on the previous value of Register can't be
 402   /// restored anymore.
 403   static MCCFIInstruction createUndefined(MCSymbol *L, unsigned Register) {
 404     return MCCFIInstruction(OpUndefined, L, Register, 0, "");
 405   }
 406
 407   /// \brief .cfi_same_value Current value of Register is the same as in the
 408   /// previous frame. I.e., no restoration is needed.
 409   static MCCFIInstruction createSameValue(MCSymbol *L, unsigned Register) {
 410     return MCCFIInstruction(OpSameValue, L, Register, 0, "");
 411   }
 412
 413   /// \brief .cfi_remember_state Save all current rules for all registers.
 414   static MCCFIInstruction createRememberState(MCSymbol *L) {
 415     return MCCFIInstruction(OpRememberState, L, 0, 0, "");
 416   }
 417
 418   /// \brief .cfi_restore_state Restore the previously saved state.
 419   static MCCFIInstruction createRestoreState(MCSymbol *L) {
 420     return MCCFIInstruction(OpRestoreState, L, 0, 0, "");
 421   }
 422
 423   /// \brief .cfi_escape Allows the user to add arbitrary bytes to the unwind
 424   /// info.
 425   static MCCFIInstruction createEscape(MCSymbol *L, StringRef Vals) {
 426     return MCCFIInstruction(OpEscape, L, 0, 0, Vals);
 427   }
 428
 429   OpType getOperation() const { return Operation; }
 430   MCSymbol *getLabel() const { return Label; }
 431
 432   unsigned getRegister() const {
 433     assert(Operation == OpDefCfa || Operation == OpOffset ||
 434            Operation == OpRestore || Operation == OpUndefined ||
 435            Operation == OpSameValue || Operation == OpDefCfaRegister ||
 436            Operation == OpRelOffset || Operation == OpRegister);
 437     return Register;
 438   }
 439
 440   unsigned getRegister2() const {
 441     assert(Operation == OpRegister);
 442     return Register2;
 443   }
 444
 445   int getOffset() const {
 446     assert(Operation == OpDefCfa || Operation == OpOffset ||
 447            Operation == OpRelOffset || Operation == OpDefCfaOffset ||
 448            Operation == OpAdjustCfaOffset);
 449     return Offset;
 450   }
 451
 452   const StringRef getValues() const {
 453     assert(Operation == OpEscape);
 454     return StringRef(&Values[0], Values.size());
 455   }
 456 };
 457
 458 struct MCDwarfFrameInfo {
 459   MCDwarfFrameInfo()
 460       : Begin(0), End(0), Personality(0), Lsda(0), Function(0), Instructions(),
 461         PersonalityEncoding(), LsdaEncoding(0), CompactUnwindEncoding(0),
 462         IsSignalFrame(false), IsSimple(false) {}
 463   MCSymbol *Begin;
 464   MCSymbol *End;
 465   const MCSymbol *Personality;
 466   const MCSymbol *Lsda;
 467   const MCSymbol *Function;
 468   std::vector<MCCFIInstruction> Instructions;
 469   unsigned PersonalityEncoding;
 470   unsigned LsdaEncoding;
 471   uint32_t CompactUnwindEncoding;
 472   bool IsSignalFrame;
 473   bool IsSimple;
 474 };
 475
 476 class MCDwarfFrameEmitter {
 477 public:
 478   //
 479   // This emits the frame info section.
 480   //
 481   static void Emit(MCStreamer &streamer, MCAsmBackend *MAB,
 482                    bool usingCFI, bool isEH);
 483   static void EmitAdvanceLoc(MCStreamer &Streamer, uint64_t AddrDelta);
 484   static void EncodeAdvanceLoc(MCContext &Context, uint64_t AddrDelta,
 485                                raw_ostream &OS);
 486 };
 487 } // end namespace llvm
 488
 489 #endif