blob: 1f0fa78bffc650f78273dd17b29017a4f0a54d3f [file] [log] [blame]
Kevin Enderbye5930f12010-07-28 20:55:35 +00001//===- lib/MC/MCDwarf.cpp - MCDwarf implementation ------------------------===//
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
Chandler Carruth6bda14b2017-06-06 11:49:48 +000010#include "llvm/MC/MCDwarf.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000011#include "llvm/ADT/ArrayRef.h"
12#include "llvm/ADT/DenseMap.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000013#include "llvm/ADT/Hashing.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000014#include "llvm/ADT/None.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000015#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000016#include "llvm/ADT/SmallString.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000017#include "llvm/ADT/SmallVector.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000018#include "llvm/ADT/StringRef.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/ADT/Twine.h"
Zachary Turner264b5d92017-06-07 03:48:56 +000020#include "llvm/BinaryFormat/Dwarf.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/Config/config.h"
Evan Cheng76792992011-07-20 05:58:47 +000022#include "llvm/MC/MCAsmInfo.h"
23#include "llvm/MC/MCContext.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000024#include "llvm/MC/MCExpr.h"
Evan Cheng76792992011-07-20 05:58:47 +000025#include "llvm/MC/MCObjectFileInfo.h"
Rafael Espindola4066e8d2014-05-12 14:28:48 +000026#include "llvm/MC/MCObjectStreamer.h"
Evan Cheng76792992011-07-20 05:58:47 +000027#include "llvm/MC/MCRegisterInfo.h"
Oliver Stannard8b273082014-06-19 15:52:37 +000028#include "llvm/MC/MCSection.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000029#include "llvm/MC/MCStreamer.h"
Kevin Enderbye46564a2010-09-30 16:52:03 +000030#include "llvm/MC/MCSymbol.h"
Paul Robinson1f900292018-02-06 20:29:21 +000031#include "llvm/MC/StringTableBuilder.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000032#include "llvm/Support/Casting.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000033#include "llvm/Support/Endian.h"
Reid Kleckner858239d2016-06-22 23:23:08 +000034#include "llvm/Support/EndianStream.h"
Rafael Espindola85d91982010-12-28 18:36:23 +000035#include "llvm/Support/ErrorHandling.h"
Jim Grosbachbf387df2012-08-08 23:56:06 +000036#include "llvm/Support/LEB128.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000037#include "llvm/Support/MathExtras.h"
Kevin Enderbye7739d42011-12-09 18:09:40 +000038#include "llvm/Support/Path.h"
39#include "llvm/Support/SourceMgr.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000040#include "llvm/Support/raw_ostream.h"
Eugene Zelenkod96089b2017-02-14 00:33:36 +000041#include <cassert>
42#include <cstdint>
43#include <string>
44#include <utility>
45#include <vector>
Hans Wennborg083ca9b2015-10-06 23:24:35 +000046
Kevin Enderbye5930f12010-07-28 20:55:35 +000047using namespace llvm;
48
Paul Robinson1f900292018-02-06 20:29:21 +000049/// Manage the .debug_line_str section contents, if we use it.
50class llvm::MCDwarfLineStr {
51 MCSymbol *LineStrLabel = nullptr;
52 StringTableBuilder LineStrings{StringTableBuilder::DWARF};
53 bool UseRelocs = false;
54
55public:
56 /// Construct an instance that can emit .debug_line_str (for use in a normal
57 /// v5 line table).
58 explicit MCDwarfLineStr(MCContext &Ctx) {
59 UseRelocs = Ctx.getAsmInfo()->doesDwarfUseRelocationsAcrossSections();
60 if (UseRelocs)
61 LineStrLabel =
62 Ctx.getObjectFileInfo()->getDwarfLineStrSection()->getBeginSymbol();
63 }
64
65 /// Emit a reference to the string.
66 void emitRef(MCStreamer *MCOS, StringRef Path);
67
68 /// Emit the .debug_line_str section if appropriate.
69 void emitSection(MCStreamer *MCOS);
70};
71
Ulrich Weigand32d725b2013-06-12 14:46:54 +000072static inline uint64_t ScaleAddrDelta(MCContext &Context, uint64_t AddrDelta) {
Bill Wendlingbc07a892013-06-18 07:20:20 +000073 unsigned MinInsnLength = Context.getAsmInfo()->getMinInstAlignment();
Ulrich Weigand32d725b2013-06-12 14:46:54 +000074 if (MinInsnLength == 1)
Kevin Enderbye46564a2010-09-30 16:52:03 +000075 return AddrDelta;
Ulrich Weigand32d725b2013-06-12 14:46:54 +000076 if (AddrDelta % MinInsnLength != 0) {
Kevin Enderbye46564a2010-09-30 16:52:03 +000077 // TODO: report this error, but really only once.
78 ;
79 }
Ulrich Weigand32d725b2013-06-12 14:46:54 +000080 return AddrDelta / MinInsnLength;
Kevin Enderbye46564a2010-09-30 16:52:03 +000081}
82
83//
84// This is called when an instruction is assembled into the specified section
85// and if there is information from the last .loc directive that has yet to have
86// a line entry made for it is made.
87//
David Majnemer8cc30782016-01-21 01:59:03 +000088void MCDwarfLineEntry::Make(MCObjectStreamer *MCOS, MCSection *Section) {
Kevin Enderbye46564a2010-09-30 16:52:03 +000089 if (!MCOS->getContext().getDwarfLocSeen())
90 return;
91
92 // Create a symbol at in the current section for use in the line entry.
Jim Grosbach6f482002015-05-18 18:43:14 +000093 MCSymbol *LineSym = MCOS->getContext().createTempSymbol();
David Majnemer8cc30782016-01-21 01:59:03 +000094 // Set the value of the symbol to use for the MCDwarfLineEntry.
Kevin Enderbye46564a2010-09-30 16:52:03 +000095 MCOS->EmitLabel(LineSym);
96
97 // Get the current .loc info saved in the context.
98 const MCDwarfLoc &DwarfLoc = MCOS->getContext().getCurrentDwarfLoc();
99
100 // Create a (local) line entry with the symbol and the current .loc info.
David Majnemer8cc30782016-01-21 01:59:03 +0000101 MCDwarfLineEntry LineEntry(LineSym, DwarfLoc);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000102
103 // clear DwarfLocSeen saying the current .loc info is now used.
Jim Grosbach6f482002015-05-18 18:43:14 +0000104 MCOS->getContext().clearDwarfLocSeen();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000105
Kevin Enderbye46564a2010-09-30 16:52:03 +0000106 // Add the line entry to this section's entries.
David Blaikiea55e64f2014-03-12 22:28:56 +0000107 MCOS->getContext()
David Blaikied9012ba2014-03-13 21:59:51 +0000108 .getMCDwarfLineTable(MCOS->getContext().getDwarfCompileUnitID())
David Blaikie11765bc2014-03-13 17:55:28 +0000109 .getMCLineSections()
David Blaikiea55e64f2014-03-12 22:28:56 +0000110 .addLineEntry(LineEntry, Section);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000111}
112
113//
114// This helper routine returns an expression of End - Start + IntVal .
Jim Grosbachdc1e36e2012-05-11 01:41:30 +0000115//
Rafael Espindolad66e65d2010-12-09 23:08:35 +0000116static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
117 const MCSymbol &Start,
118 const MCSymbol &End,
119 int IntVal) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000120 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
121 const MCExpr *Res =
Jim Grosbach13760bd2015-05-30 01:25:56 +0000122 MCSymbolRefExpr::create(&End, Variant, MCOS.getContext());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000123 const MCExpr *RHS =
Jim Grosbach13760bd2015-05-30 01:25:56 +0000124 MCSymbolRefExpr::create(&Start, Variant, MCOS.getContext());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000125 const MCExpr *Res1 =
Jim Grosbach13760bd2015-05-30 01:25:56 +0000126 MCBinaryExpr::create(MCBinaryExpr::Sub, Res, RHS, MCOS.getContext());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000127 const MCExpr *Res2 =
Jim Grosbach13760bd2015-05-30 01:25:56 +0000128 MCConstantExpr::create(IntVal, MCOS.getContext());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000129 const MCExpr *Res3 =
Jim Grosbach13760bd2015-05-30 01:25:56 +0000130 MCBinaryExpr::create(MCBinaryExpr::Sub, Res1, Res2, MCOS.getContext());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000131 return Res3;
132}
133
Kevin Enderbye46564a2010-09-30 16:52:03 +0000134//
Paul Robinson1f900292018-02-06 20:29:21 +0000135// This helper routine returns an expression of Start + IntVal .
136//
137static inline const MCExpr *
138makeStartPlusIntExpr(MCContext &Ctx, const MCSymbol &Start, int IntVal) {
139 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
140 const MCExpr *LHS = MCSymbolRefExpr::create(&Start, Variant, Ctx);
141 const MCExpr *RHS = MCConstantExpr::create(IntVal, Ctx);
142 const MCExpr *Res = MCBinaryExpr::create(MCBinaryExpr::Add, LHS, RHS, Ctx);
143 return Res;
144}
145
146//
Kevin Enderbye46564a2010-09-30 16:52:03 +0000147// This emits the Dwarf line table for the specified section from the entries
148// in the LineSection.
149//
David Blaikief4ad6982014-03-12 22:35:23 +0000150static inline void
Rafael Espindola0709a7b2015-05-21 19:20:38 +0000151EmitDwarfLineTable(MCObjectStreamer *MCOS, MCSection *Section,
David Majnemer8cc30782016-01-21 01:59:03 +0000152 const MCLineSection::MCDwarfLineEntryCollection &LineEntries) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000153 unsigned FileNum = 1;
154 unsigned LastLine = 1;
155 unsigned Column = 0;
156 unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
157 unsigned Isa = 0;
Diego Novillo5b5cf502014-02-14 19:27:53 +0000158 unsigned Discriminator = 0;
Craig Topperbb694de2014-04-13 04:57:38 +0000159 MCSymbol *LastLabel = nullptr;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000160
David Majnemer8cc30782016-01-21 01:59:03 +0000161 // Loop through each MCDwarfLineEntry and encode the dwarf line number table.
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000162 for (const MCDwarfLineEntry &LineEntry : LineEntries) {
163 int64_t LineDelta = static_cast<int64_t>(LineEntry.getLine()) - LastLine;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000164
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000165 if (FileNum != LineEntry.getFileNum()) {
166 FileNum = LineEntry.getFileNum();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000167 MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
Rafael Espindola5e874982010-11-02 17:22:24 +0000168 MCOS->EmitULEB128IntValue(FileNum);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000169 }
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000170 if (Column != LineEntry.getColumn()) {
171 Column = LineEntry.getColumn();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000172 MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
Rafael Espindola5e874982010-11-02 17:22:24 +0000173 MCOS->EmitULEB128IntValue(Column);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000174 }
Dehao Chen6e0c8442016-10-07 15:21:31 +0000175 if (Discriminator != LineEntry.getDiscriminator() &&
176 MCOS->getContext().getDwarfVersion() >= 4) {
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000177 Discriminator = LineEntry.getDiscriminator();
Logan Chien5b776b72014-02-22 14:00:39 +0000178 unsigned Size = getULEB128Size(Discriminator);
Diego Novillo5b5cf502014-02-14 19:27:53 +0000179 MCOS->EmitIntValue(dwarf::DW_LNS_extended_op, 1);
180 MCOS->EmitULEB128IntValue(Size + 1);
181 MCOS->EmitIntValue(dwarf::DW_LNE_set_discriminator, 1);
182 MCOS->EmitULEB128IntValue(Discriminator);
183 }
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000184 if (Isa != LineEntry.getIsa()) {
185 Isa = LineEntry.getIsa();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000186 MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
Rafael Espindola5e874982010-11-02 17:22:24 +0000187 MCOS->EmitULEB128IntValue(Isa);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000188 }
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000189 if ((LineEntry.getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
190 Flags = LineEntry.getFlags();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000191 MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
192 }
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000193 if (LineEntry.getFlags() & DWARF2_FLAG_BASIC_BLOCK)
Kevin Enderbye46564a2010-09-30 16:52:03 +0000194 MCOS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000195 if (LineEntry.getFlags() & DWARF2_FLAG_PROLOGUE_END)
Kevin Enderbye46564a2010-09-30 16:52:03 +0000196 MCOS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000197 if (LineEntry.getFlags() & DWARF2_FLAG_EPILOGUE_BEGIN)
Kevin Enderbye46564a2010-09-30 16:52:03 +0000198 MCOS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
199
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000200 MCSymbol *Label = LineEntry.getLabel();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000201
202 // At this point we want to emit/create the sequence to encode the delta in
203 // line numbers and the increment of the address from the previous Label
204 // and the current Label.
Bill Wendlingbc07a892013-06-18 07:20:20 +0000205 const MCAsmInfo *asmInfo = MCOS->getContext().getAsmInfo();
Evan Chengc7ac6902011-07-14 05:43:07 +0000206 MCOS->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label,
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000207 asmInfo->getCodePointerSize());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000208
Dehao Chen1b54fce2016-04-28 22:09:37 +0000209 Discriminator = 0;
Benjamin Kramer7b4658f2016-06-26 14:49:00 +0000210 LastLine = LineEntry.getLine();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000211 LastLabel = Label;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000212 }
213
214 // Emit a DW_LNE_end_sequence for the end of the section.
Rafael Espindolaf2b408c2015-03-23 21:22:04 +0000215 // Use the section end label to compute the address delta and use INT64_MAX
216 // as the line delta which is the signal that this is actually a
217 // DW_LNE_end_sequence.
218 MCSymbol *SectionEnd = MCOS->endSection(Section);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000219
Rafael Espindolaf2b408c2015-03-23 21:22:04 +0000220 // Switch back the dwarf line section, in case endSection had to switch the
221 // section.
Rafael Espindolaae3d78a2015-03-23 20:25:31 +0000222 MCContext &Ctx = MCOS->getContext();
Rafael Espindolaae3d78a2015-03-23 20:25:31 +0000223 MCOS->SwitchSection(Ctx.getObjectFileInfo()->getDwarfLineSection());
Rafael Espindolab58867c2010-11-19 02:26:16 +0000224
Rafael Espindolaae3d78a2015-03-23 20:25:31 +0000225 const MCAsmInfo *AsmInfo = Ctx.getAsmInfo();
Evan Chengc7ac6902011-07-14 05:43:07 +0000226 MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd,
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000227 AsmInfo->getCodePointerSize());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000228}
229
230//
231// This emits the Dwarf file and the line tables.
232//
Frederic Rissa5ab8442015-08-07 15:14:08 +0000233void MCDwarfLineTable::Emit(MCObjectStreamer *MCOS,
234 MCDwarfLineTableParams Params) {
Rafael Espindola0a017a62010-12-10 07:39:47 +0000235 MCContext &context = MCOS->getContext();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000236
David Blaikie8bf66c42014-04-01 07:35:52 +0000237 auto &LineTables = context.getMCDwarfLineTables();
238
239 // Bail out early so we don't switch to the debug_line section needlessly and
240 // in doing so create an unnecessary (if empty) section.
241 if (LineTables.empty())
242 return;
David Blaikie11765bc2014-03-13 17:55:28 +0000243
Paul Robinson1f900292018-02-06 20:29:21 +0000244 // In a v5 non-split line table, put the strings in a separate section.
245 Optional<MCDwarfLineStr> LineStr;
246 if (context.getDwarfVersion() >= 5)
247 LineStr = MCDwarfLineStr(context);
248
David Blaikie11765bc2014-03-13 17:55:28 +0000249 // Switch to the section where the table will be emitted into.
250 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
251
Manman Ren4e042a62013-02-05 21:52:47 +0000252 // Handle the rest of the Compile Units.
David Blaikie8bf66c42014-04-01 07:35:52 +0000253 for (const auto &CUIDTablePair : LineTables)
Paul Robinson1f900292018-02-06 20:29:21 +0000254 CUIDTablePair.second.EmitCU(MCOS, Params, LineStr);
255
256 if (LineStr)
257 LineStr->emitSection(MCOS);
Manman Ren4e042a62013-02-05 21:52:47 +0000258}
259
Frederic Rissa5ab8442015-08-07 15:14:08 +0000260void MCDwarfDwoLineTable::Emit(MCStreamer &MCOS,
261 MCDwarfLineTableParams Params) const {
Paul Robinson1f900292018-02-06 20:29:21 +0000262 Optional<MCDwarfLineStr> NoLineStr(None);
263 MCOS.EmitLabel(Header.Emit(&MCOS, Params, None, NoLineStr).second);
David Blaikie8287aff2014-03-18 02:13:23 +0000264}
265
Frederic Rissa5ab8442015-08-07 15:14:08 +0000266std::pair<MCSymbol *, MCSymbol *>
Paul Robinson1f900292018-02-06 20:29:21 +0000267MCDwarfLineTableHeader::Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params,
268 Optional<MCDwarfLineStr> &LineStr) const {
David Blaikie8287aff2014-03-18 02:13:23 +0000269 static const char StandardOpcodeLengths[] = {
270 0, // length of DW_LNS_copy
271 1, // length of DW_LNS_advance_pc
272 1, // length of DW_LNS_advance_line
273 1, // length of DW_LNS_set_file
274 1, // length of DW_LNS_set_column
275 0, // length of DW_LNS_negate_stmt
276 0, // length of DW_LNS_set_basic_block
277 0, // length of DW_LNS_const_add_pc
278 1, // length of DW_LNS_fixed_advance_pc
279 0, // length of DW_LNS_set_prologue_end
280 0, // length of DW_LNS_set_epilogue_begin
281 1 // DW_LNS_set_isa
282 };
Frederic Rissa5ab8442015-08-07 15:14:08 +0000283 assert(array_lengthof(StandardOpcodeLengths) >=
Aaron Ballmand8ac7de2015-08-10 15:22:39 +0000284 (Params.DWARF2LineOpcodeBase - 1U));
Paul Robinson1f900292018-02-06 20:29:21 +0000285 return Emit(
286 MCOS, Params,
287 makeArrayRef(StandardOpcodeLengths, Params.DWARF2LineOpcodeBase - 1),
288 LineStr);
David Blaikie8287aff2014-03-18 02:13:23 +0000289}
290
Rafael Espindolac23174b2014-08-15 15:12:13 +0000291static const MCExpr *forceExpAbs(MCStreamer &OS, const MCExpr* Expr) {
292 MCContext &Context = OS.getContext();
293 assert(!isa<MCSymbolRefExpr>(Expr));
294 if (Context.getAsmInfo()->hasAggressiveSymbolFolding())
295 return Expr;
296
Jim Grosbach6f482002015-05-18 18:43:14 +0000297 MCSymbol *ABS = Context.createTempSymbol();
Rafael Espindolac23174b2014-08-15 15:12:13 +0000298 OS.EmitAssignment(ABS, Expr);
Jim Grosbach13760bd2015-05-30 01:25:56 +0000299 return MCSymbolRefExpr::create(ABS, Context);
Rafael Espindolac23174b2014-08-15 15:12:13 +0000300}
301
302static void emitAbsValue(MCStreamer &OS, const MCExpr *Value, unsigned Size) {
303 const MCExpr *ABS = forceExpAbs(OS, Value);
304 OS.EmitValue(ABS, Size);
305}
306
Paul Robinson1f900292018-02-06 20:29:21 +0000307void MCDwarfLineStr::emitSection(MCStreamer *MCOS) {
308 // Switch to the .debug_line_str section.
309 MCOS->SwitchSection(
310 MCOS->getContext().getObjectFileInfo()->getDwarfLineStrSection());
311 // Emit the strings without perturbing the offsets we used.
312 LineStrings.finalizeInOrder();
313 SmallString<0> Data;
314 Data.resize(LineStrings.getSize());
315 LineStrings.write((uint8_t *)Data.data());
316 MCOS->EmitBinaryData(Data.str());
317}
318
319void MCDwarfLineStr::emitRef(MCStreamer *MCOS, StringRef Path) {
320 int RefSize = 4; // FIXME: Support DWARF-64
321 size_t Offset = LineStrings.add(Path);
322 if (UseRelocs) {
323 MCContext &Ctx = MCOS->getContext();
324 MCOS->EmitValue(makeStartPlusIntExpr(Ctx, *LineStrLabel, Offset), RefSize);
325 } else
326 MCOS->EmitIntValue(Offset, RefSize);
327}
328
Paul Robinson2bf8f492018-01-30 21:39:28 +0000329void MCDwarfLineTableHeader::emitV2FileDirTables(MCStreamer *MCOS) const {
Paul Robinson795ab0d2017-12-05 20:35:00 +0000330 // First the directory table.
Paul Robinson2bf8f492018-01-30 21:39:28 +0000331 for (auto &Dir : MCDwarfDirs) {
Paul Robinson795ab0d2017-12-05 20:35:00 +0000332 MCOS->EmitBytes(Dir); // The DirectoryName, and...
333 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
334 }
335 MCOS->EmitIntValue(0, 1); // Terminate the directory list.
336
337 // Second the file table.
338 for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
339 assert(!MCDwarfFiles[i].Name.empty());
340 MCOS->EmitBytes(MCDwarfFiles[i].Name); // FileName and...
341 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
342 MCOS->EmitULEB128IntValue(MCDwarfFiles[i].DirIndex); // Directory number.
343 MCOS->EmitIntValue(0, 1); // Last modification timestamp (always 0).
344 MCOS->EmitIntValue(0, 1); // File size (always 0).
345 }
346 MCOS->EmitIntValue(0, 1); // Terminate the file list.
347}
348
Paul Robinson1f900292018-02-06 20:29:21 +0000349void MCDwarfLineTableHeader::emitV5FileDirTables(
350 MCStreamer *MCOS, Optional<MCDwarfLineStr> &LineStr) const {
351 // The directory format, which is just a list of the directory paths. In a
352 // non-split object, these are references to .debug_line_str; in a split
353 // object, they are inline strings.
Paul Robinson795ab0d2017-12-05 20:35:00 +0000354 MCOS->EmitIntValue(1, 1);
355 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_path);
Paul Robinson1f900292018-02-06 20:29:21 +0000356 MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
357 : dwarf::DW_FORM_string);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000358 MCOS->EmitULEB128IntValue(MCDwarfDirs.size() + 1);
Paul Robinson1f900292018-02-06 20:29:21 +0000359 if (LineStr) {
360 // Record path strings, emit references here.
361 LineStr->emitRef(MCOS, CompilationDir);
362 for (auto &Dir : MCDwarfDirs)
363 LineStr->emitRef(MCOS, Dir);
364 } else {
365 // The list of directory paths. CompilationDir comes first.
366 MCOS->EmitBytes(CompilationDir);
367 MCOS->EmitBytes(StringRef("\0", 1));
368 for (auto &Dir : MCDwarfDirs) {
369 MCOS->EmitBytes(Dir); // The DirectoryName, and...
370 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
371 }
Paul Robinson795ab0d2017-12-05 20:35:00 +0000372 }
373
374 // The file format, which is the inline null-terminated filename and a
375 // directory index. We don't track file size/timestamp so don't emit them
Paul Robinson29f5f982018-01-09 23:31:48 +0000376 // in the v5 table. Emit MD5 checksums if we have them.
377 MCOS->EmitIntValue(HasMD5 ? 3 : 2, 1);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000378 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_path);
Paul Robinson1f900292018-02-06 20:29:21 +0000379 MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
380 : dwarf::DW_FORM_string);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000381 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_directory_index);
382 MCOS->EmitULEB128IntValue(dwarf::DW_FORM_udata);
Paul Robinson29f5f982018-01-09 23:31:48 +0000383 if (HasMD5) {
384 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_MD5);
385 MCOS->EmitULEB128IntValue(dwarf::DW_FORM_data16);
386 }
387 // Then the list of file names. These start at 1.
Paul Robinson795ab0d2017-12-05 20:35:00 +0000388 MCOS->EmitULEB128IntValue(MCDwarfFiles.size() - 1);
389 for (unsigned i = 1; i < MCDwarfFiles.size(); ++i) {
390 assert(!MCDwarfFiles[i].Name.empty());
Paul Robinson1f900292018-02-06 20:29:21 +0000391 if (LineStr)
392 LineStr->emitRef(MCOS, MCDwarfFiles[i].Name);
393 else {
394 MCOS->EmitBytes(MCDwarfFiles[i].Name); // FileName and...
395 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
396 }
Paul Robinson795ab0d2017-12-05 20:35:00 +0000397 MCOS->EmitULEB128IntValue(MCDwarfFiles[i].DirIndex); // Directory number.
Paul Robinson29f5f982018-01-09 23:31:48 +0000398 if (HasMD5) {
399 MD5::MD5Result *Cksum = MCDwarfFiles[i].Checksum;
400 MCOS->EmitBinaryData(
401 StringRef(reinterpret_cast<const char *>(Cksum->Bytes.data()),
402 Cksum->Bytes.size()));
403 }
Paul Robinson795ab0d2017-12-05 20:35:00 +0000404 }
405}
406
David Blaikie8287aff2014-03-18 02:13:23 +0000407std::pair<MCSymbol *, MCSymbol *>
Frederic Rissa5ab8442015-08-07 15:14:08 +0000408MCDwarfLineTableHeader::Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params,
Paul Robinson1f900292018-02-06 20:29:21 +0000409 ArrayRef<char> StandardOpcodeLengths,
410 Optional<MCDwarfLineStr> &LineStr) const {
Manman Ren4e042a62013-02-05 21:52:47 +0000411 MCContext &context = MCOS->getContext();
412
413 // Create a symbol at the beginning of the line table.
David Blaikie11765bc2014-03-13 17:55:28 +0000414 MCSymbol *LineStartSym = Label;
Manman Ren4e042a62013-02-05 21:52:47 +0000415 if (!LineStartSym)
Jim Grosbach6f482002015-05-18 18:43:14 +0000416 LineStartSym = context.createTempSymbol();
Manman Ren4e042a62013-02-05 21:52:47 +0000417 // Set the value of the symbol, as we are at the start of the line table.
Kevin Enderbye46564a2010-09-30 16:52:03 +0000418 MCOS->EmitLabel(LineStartSym);
419
420 // Create a symbol for the end of the section (to be set when we get there).
Jim Grosbach6f482002015-05-18 18:43:14 +0000421 MCSymbol *LineEndSym = context.createTempSymbol();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000422
423 // The first 4 bytes is the total length of the information for this
424 // compilation unit (not including these 4 bytes for the length).
Rafael Espindolac23174b2014-08-15 15:12:13 +0000425 emitAbsValue(*MCOS,
426 MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym, 4), 4);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000427
Paul Robinson68ba7722017-12-04 21:27:46 +0000428 // Next 2 bytes is the Version.
Davide Italiano23b3f6d2017-12-07 00:57:25 +0000429 // FIXME: On Darwin we still default to V2.
Paul Robinson68ba7722017-12-04 21:27:46 +0000430 unsigned LineTableVersion = context.getDwarfVersion();
Davide Italiano23b3f6d2017-12-07 00:57:25 +0000431 if (context.getObjectFileInfo()->getTargetTriple().isOSDarwin())
432 LineTableVersion = 2;
Paul Robinson68ba7722017-12-04 21:27:46 +0000433 MCOS->EmitIntValue(LineTableVersion, 2);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000434
Paul Robinson795ab0d2017-12-05 20:35:00 +0000435 // Keep track of the bytes between the very start and where the header length
436 // comes out.
437 unsigned PreHeaderLengthBytes = 4 + 2;
438
439 // In v5, we get address info next.
440 if (LineTableVersion >= 5) {
441 MCOS->EmitIntValue(context.getAsmInfo()->getCodePointerSize(), 1);
442 MCOS->EmitIntValue(0, 1); // Segment selector; same as EmitGenDwarfAranges.
443 PreHeaderLengthBytes += 2;
444 }
445
Kevin Enderbye46564a2010-09-30 16:52:03 +0000446 // Create a symbol for the end of the prologue (to be set when we get there).
Jim Grosbach6f482002015-05-18 18:43:14 +0000447 MCSymbol *ProEndSym = context.createTempSymbol(); // Lprologue_end
Kevin Enderbye46564a2010-09-30 16:52:03 +0000448
Paul Robinson795ab0d2017-12-05 20:35:00 +0000449 // Length of the prologue, is the next 4 bytes. This is actually the length
450 // from after the length word, to the end of the prologue.
451 emitAbsValue(*MCOS,
452 MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
453 (PreHeaderLengthBytes + 4)),
454 4);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000455
456 // Parameters of the state machine, are next.
Bill Wendlingbc07a892013-06-18 07:20:20 +0000457 MCOS->EmitIntValue(context.getAsmInfo()->getMinInstAlignment(), 1);
Paul Robinson68ba7722017-12-04 21:27:46 +0000458 // maximum_operations_per_instruction
459 // For non-VLIW architectures this field is always 1.
460 // FIXME: VLIW architectures need to update this field accordingly.
Paul Robinson795ab0d2017-12-05 20:35:00 +0000461 if (LineTableVersion >= 4)
Paul Robinson68ba7722017-12-04 21:27:46 +0000462 MCOS->EmitIntValue(1, 1);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000463 MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
Frederic Rissa5ab8442015-08-07 15:14:08 +0000464 MCOS->EmitIntValue(Params.DWARF2LineBase, 1);
465 MCOS->EmitIntValue(Params.DWARF2LineRange, 1);
David Blaikie8287aff2014-03-18 02:13:23 +0000466 MCOS->EmitIntValue(StandardOpcodeLengths.size() + 1, 1);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000467
468 // Standard opcode lengths
David Blaikie8287aff2014-03-18 02:13:23 +0000469 for (char Length : StandardOpcodeLengths)
470 MCOS->EmitIntValue(Length, 1);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000471
Paul Robinson795ab0d2017-12-05 20:35:00 +0000472 // Put out the directory and file tables. The formats vary depending on
473 // the version.
474 if (LineTableVersion >= 5)
Paul Robinson1f900292018-02-06 20:29:21 +0000475 emitV5FileDirTables(MCOS, LineStr);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000476 else
Paul Robinson2bf8f492018-01-30 21:39:28 +0000477 emitV2FileDirTables(MCOS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000478
479 // This is the end of the prologue, so set the value of the symbol at the
480 // end of the prologue (that was used in a previous expression).
481 MCOS->EmitLabel(ProEndSym);
482
David Blaikie5cff0e62014-03-13 21:47:12 +0000483 return std::make_pair(LineStartSym, LineEndSym);
484}
485
Frederic Rissa5ab8442015-08-07 15:14:08 +0000486void MCDwarfLineTable::EmitCU(MCObjectStreamer *MCOS,
Paul Robinson1f900292018-02-06 20:29:21 +0000487 MCDwarfLineTableParams Params,
488 Optional<MCDwarfLineStr> &LineStr) const {
489 MCSymbol *LineEndSym = Header.Emit(MCOS, Params, LineStr).second;
David Blaikie5cff0e62014-03-13 21:47:12 +0000490
Kevin Enderbye46564a2010-09-30 16:52:03 +0000491 // Put out the line tables.
David Blaikie11765bc2014-03-13 17:55:28 +0000492 for (const auto &LineSec : MCLineSections.getMCLineEntries())
493 EmitDwarfLineTable(MCOS, LineSec.first, LineSec.second);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000494
Kevin Enderbye46564a2010-09-30 16:52:03 +0000495 // This is the end of the section, so set the value of the symbol at the end
496 // of this section (that was used in a previous expression).
497 MCOS->EmitLabel(LineEndSym);
498}
499
Paul Robinson70def122018-02-22 21:03:33 +0000500Expected<unsigned> MCDwarfLineTable::tryGetFile(StringRef &Directory,
501 StringRef &FileName,
502 MD5::MD5Result *Checksum,
503 unsigned FileNumber) {
504 return Header.tryGetFile(Directory, FileName, Checksum, FileNumber);
David Blaikie5cff0e62014-03-13 21:47:12 +0000505}
506
Paul Robinson70def122018-02-22 21:03:33 +0000507Expected<unsigned> MCDwarfLineTableHeader::tryGetFile(StringRef &Directory,
508 StringRef &FileName,
509 MD5::MD5Result *Checksum,
510 unsigned FileNumber) {
David Blaikiec7f29dc2014-03-17 23:29:40 +0000511 if (Directory == CompilationDir)
512 Directory = "";
David Blaikiec2df16b2014-03-17 18:13:58 +0000513 if (FileName.empty()) {
514 FileName = "<stdin>";
515 Directory = "";
516 }
517 assert(!FileName.empty());
Paul Robinson70def122018-02-22 21:03:33 +0000518 // If any files have an MD5 checksum, they all must.
519 if (MCDwarfFiles.empty())
520 HasMD5 = (Checksum != nullptr);
David Blaikiec714ef42014-03-17 01:52:11 +0000521 if (FileNumber == 0) {
Adrian Prantld6cc53f2016-03-09 17:32:56 +0000522 // File numbers start with 1 and/or after any file numbers
523 // allocated by inline-assembler .file directives.
524 FileNumber = MCDwarfFiles.empty() ? 1 : MCDwarfFiles.size();
Pete Cooperb7800812015-05-20 19:12:14 +0000525 SmallString<256> Buffer;
David Blaikie5106ce72014-11-19 05:49:42 +0000526 auto IterBool = SourceIdMap.insert(
Pete Cooperb7800812015-05-20 19:12:14 +0000527 std::make_pair((Directory + Twine('\0') + FileName).toStringRef(Buffer),
528 FileNumber));
David Blaikie5106ce72014-11-19 05:49:42 +0000529 if (!IterBool.second)
530 return IterBool.first->second;
David Blaikiec714ef42014-03-17 01:52:11 +0000531 }
David Blaikie498589c2014-03-13 19:15:04 +0000532 // Make space for this FileNumber in the MCDwarfFiles vector if needed.
Paul Robinsona1cedd62017-12-14 18:46:43 +0000533 if (FileNumber >= MCDwarfFiles.size())
534 MCDwarfFiles.resize(FileNumber + 1);
David Blaikie498589c2014-03-13 19:15:04 +0000535
536 // Get the new MCDwarfFile slot for this FileNumber.
537 MCDwarfFile &File = MCDwarfFiles[FileNumber];
538
Paul Robinson70def122018-02-22 21:03:33 +0000539 // It is an error to see the same number more than once.
David Blaikie498589c2014-03-13 19:15:04 +0000540 if (!File.Name.empty())
Paul Robinson70def122018-02-22 21:03:33 +0000541 return make_error<StringError>("file number already allocated",
542 inconvertibleErrorCode());
David Blaikie498589c2014-03-13 19:15:04 +0000543
Paul Robinson29f5f982018-01-09 23:31:48 +0000544 // If any files have an MD5 checksum, they all must.
Paul Robinson70def122018-02-22 21:03:33 +0000545 if (HasMD5 != (Checksum != nullptr))
546 return make_error<StringError>("inconsistent use of MD5 checksums",
547 inconvertibleErrorCode());
Paul Robinson29f5f982018-01-09 23:31:48 +0000548
David Blaikie498589c2014-03-13 19:15:04 +0000549 if (Directory.empty()) {
550 // Separate the directory part from the basename of the FileName.
551 StringRef tFileName = sys::path::filename(FileName);
552 if (!tFileName.empty()) {
553 Directory = sys::path::parent_path(FileName);
554 if (!Directory.empty())
555 FileName = tFileName;
556 }
557 }
558
559 // Find or make an entry in the MCDwarfDirs vector for this Directory.
560 // Capture directory name.
561 unsigned DirIndex;
562 if (Directory.empty()) {
563 // For FileNames with no directories a DirIndex of 0 is used.
564 DirIndex = 0;
565 } else {
566 DirIndex = 0;
567 for (unsigned End = MCDwarfDirs.size(); DirIndex < End; DirIndex++) {
568 if (Directory == MCDwarfDirs[DirIndex])
569 break;
570 }
571 if (DirIndex >= MCDwarfDirs.size())
572 MCDwarfDirs.push_back(Directory);
573 // The DirIndex is one based, as DirIndex of 0 is used for FileNames with
574 // no directories. MCDwarfDirs[] is unlike MCDwarfFiles[] in that the
575 // directory names are stored at MCDwarfDirs[DirIndex-1] where FileNames
576 // are stored at MCDwarfFiles[FileNumber].Name .
577 DirIndex++;
578 }
579
580 File.Name = FileName;
581 File.DirIndex = DirIndex;
Paul Robinson29f5f982018-01-09 23:31:48 +0000582 File.Checksum = Checksum;
583 if (Checksum)
584 HasMD5 = true;
David Blaikie498589c2014-03-13 19:15:04 +0000585
586 // return the allocated FileNumber.
587 return FileNumber;
588}
589
Kevin Enderbye46564a2010-09-30 16:52:03 +0000590/// Utility function to emit the encoding to a streamer.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000591void MCDwarfLineAddr::Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params,
592 int64_t LineDelta, uint64_t AddrDelta) {
Ulrich Weigand32d725b2013-06-12 14:46:54 +0000593 MCContext &Context = MCOS->getContext();
Alp Tokere69170a2014-06-26 22:52:05 +0000594 SmallString<256> Tmp;
595 raw_svector_ostream OS(Tmp);
Frederic Rissa5ab8442015-08-07 15:14:08 +0000596 MCDwarfLineAddr::Encode(Context, Params, LineDelta, AddrDelta, OS);
Eric Christophere3ab3d02013-01-09 01:57:54 +0000597 MCOS->EmitBytes(OS.str());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000598}
599
Frederic Rissa5ab8442015-08-07 15:14:08 +0000600/// Given a special op, return the address skip amount (in units of
601/// DWARF2_LINE_MIN_INSN_LENGTH).
602static uint64_t SpecialAddr(MCDwarfLineTableParams Params, uint64_t op) {
603 return (op - Params.DWARF2LineOpcodeBase) / Params.DWARF2LineRange;
604}
605
Kevin Enderbye46564a2010-09-30 16:52:03 +0000606/// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000607void MCDwarfLineAddr::Encode(MCContext &Context, MCDwarfLineTableParams Params,
608 int64_t LineDelta, uint64_t AddrDelta,
609 raw_ostream &OS) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000610 uint64_t Temp, Opcode;
611 bool NeedCopy = false;
612
Frederic Rissa5ab8442015-08-07 15:14:08 +0000613 // The maximum address skip amount that can be encoded with a special op.
614 uint64_t MaxSpecialAddrDelta = SpecialAddr(Params, 255);
615
Kevin Enderbye46564a2010-09-30 16:52:03 +0000616 // Scale the address delta by the minimum instruction length.
Ulrich Weigand32d725b2013-06-12 14:46:54 +0000617 AddrDelta = ScaleAddrDelta(Context, AddrDelta);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000618
619 // A LineDelta of INT64_MAX is a signal that this is actually a
Jim Grosbachdc1e36e2012-05-11 01:41:30 +0000620 // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
Kevin Enderbye46564a2010-09-30 16:52:03 +0000621 // end_sequence to emit the matrix entry.
622 if (LineDelta == INT64_MAX) {
Frederic Rissa5ab8442015-08-07 15:14:08 +0000623 if (AddrDelta == MaxSpecialAddrDelta)
Kevin Enderbye46564a2010-09-30 16:52:03 +0000624 OS << char(dwarf::DW_LNS_const_add_pc);
Frederic Rissceb18362015-03-15 20:45:39 +0000625 else if (AddrDelta) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000626 OS << char(dwarf::DW_LNS_advance_pc);
Jim Grosbachbf387df2012-08-08 23:56:06 +0000627 encodeULEB128(AddrDelta, OS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000628 }
629 OS << char(dwarf::DW_LNS_extended_op);
630 OS << char(1);
631 OS << char(dwarf::DW_LNE_end_sequence);
632 return;
633 }
634
635 // Bias the line delta by the base.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000636 Temp = LineDelta - Params.DWARF2LineBase;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000637
638 // If the line increment is out of range of a special opcode, we must encode
639 // it with DW_LNS_advance_line.
Frederic Risse5b78d82016-01-31 22:06:35 +0000640 if (Temp >= Params.DWARF2LineRange ||
641 Temp + Params.DWARF2LineOpcodeBase > 255) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000642 OS << char(dwarf::DW_LNS_advance_line);
Jim Grosbachbf387df2012-08-08 23:56:06 +0000643 encodeSLEB128(LineDelta, OS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000644
645 LineDelta = 0;
Frederic Rissa5ab8442015-08-07 15:14:08 +0000646 Temp = 0 - Params.DWARF2LineBase;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000647 NeedCopy = true;
648 }
649
650 // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
651 if (LineDelta == 0 && AddrDelta == 0) {
652 OS << char(dwarf::DW_LNS_copy);
653 return;
654 }
655
656 // Bias the opcode by the special opcode base.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000657 Temp += Params.DWARF2LineOpcodeBase;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000658
659 // Avoid overflow when addr_delta is large.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000660 if (AddrDelta < 256 + MaxSpecialAddrDelta) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000661 // Try using a special opcode.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000662 Opcode = Temp + AddrDelta * Params.DWARF2LineRange;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000663 if (Opcode <= 255) {
664 OS << char(Opcode);
665 return;
666 }
667
668 // Try using DW_LNS_const_add_pc followed by special op.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000669 Opcode = Temp + (AddrDelta - MaxSpecialAddrDelta) * Params.DWARF2LineRange;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000670 if (Opcode <= 255) {
671 OS << char(dwarf::DW_LNS_const_add_pc);
672 OS << char(Opcode);
673 return;
674 }
675 }
676
677 // Otherwise use DW_LNS_advance_pc.
678 OS << char(dwarf::DW_LNS_advance_pc);
Jim Grosbachbf387df2012-08-08 23:56:06 +0000679 encodeULEB128(AddrDelta, OS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000680
681 if (NeedCopy)
682 OS << char(dwarf::DW_LNS_copy);
Frederic Risse5b78d82016-01-31 22:06:35 +0000683 else {
684 assert(Temp <= 255 && "Buggy special opcode encoding.");
Kevin Enderbye46564a2010-09-30 16:52:03 +0000685 OS << char(Temp);
Frederic Risse5b78d82016-01-31 22:06:35 +0000686 }
Kevin Enderbye46564a2010-09-30 16:52:03 +0000687}
688
Kevin Enderbye7739d42011-12-09 18:09:40 +0000689// Utility function to write a tuple for .debug_abbrev.
690static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form) {
691 MCOS->EmitULEB128IntValue(Name);
692 MCOS->EmitULEB128IntValue(Form);
693}
694
695// When generating dwarf for assembly source files this emits
696// the data for .debug_abbrev section which contains three DIEs.
697static void EmitGenDwarfAbbrev(MCStreamer *MCOS) {
698 MCContext &context = MCOS->getContext();
699 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
700
701 // DW_TAG_compile_unit DIE abbrev (1).
702 MCOS->EmitULEB128IntValue(1);
703 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_compile_unit);
704 MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
Paul Robinsone95fa422016-01-04 18:49:15 +0000705 EmitAbbrev(MCOS, dwarf::DW_AT_stmt_list, context.getDwarfVersion() >= 4
706 ? dwarf::DW_FORM_sec_offset
707 : dwarf::DW_FORM_data4);
Paul Robinson22d0d312015-12-23 01:57:31 +0000708 if (context.getGenDwarfSectionSyms().size() > 1 &&
709 context.getDwarfVersion() >= 3) {
Paul Robinsone95fa422016-01-04 18:49:15 +0000710 EmitAbbrev(MCOS, dwarf::DW_AT_ranges, context.getDwarfVersion() >= 4
711 ? dwarf::DW_FORM_sec_offset
Paul Robinson22d0d312015-12-23 01:57:31 +0000712 : dwarf::DW_FORM_data4);
Oliver Stannard8b273082014-06-19 15:52:37 +0000713 } else {
714 EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
715 EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
716 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000717 EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
Andrew Trick32591d32013-12-10 04:39:09 +0000718 if (!context.getCompilationDir().empty())
719 EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000720 StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
721 if (!DwarfDebugFlags.empty())
722 EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
723 EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
724 EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
725 EmitAbbrev(MCOS, 0, 0);
726
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000727 // DW_TAG_label DIE abbrev (2).
Kevin Enderbye7739d42011-12-09 18:09:40 +0000728 MCOS->EmitULEB128IntValue(2);
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000729 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_label);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000730 MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
731 EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
732 EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
733 EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
734 EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000735 EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
736 EmitAbbrev(MCOS, 0, 0);
737
738 // DW_TAG_unspecified_parameters DIE abbrev (3).
739 MCOS->EmitULEB128IntValue(3);
740 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
741 MCOS->EmitIntValue(dwarf::DW_CHILDREN_no, 1);
742 EmitAbbrev(MCOS, 0, 0);
743
744 // Terminate the abbreviations for this compilation unit.
745 MCOS->EmitIntValue(0, 1);
746}
747
748// When generating dwarf for assembly source files this emits the data for
Oliver Stannard8b273082014-06-19 15:52:37 +0000749// .debug_aranges section. This section contains a header and a table of pairs
750// of PointerSize'ed values for the address and size of section(s) with line
751// table entries.
Alexey Samsonov00fd5252012-11-14 09:55:38 +0000752static void EmitGenDwarfAranges(MCStreamer *MCOS,
753 const MCSymbol *InfoSectionSymbol) {
Kevin Enderbye7739d42011-12-09 18:09:40 +0000754 MCContext &context = MCOS->getContext();
755
Oliver Stannard8b273082014-06-19 15:52:37 +0000756 auto &Sections = context.getGenDwarfSectionSyms();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000757
758 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
759
760 // This will be the length of the .debug_aranges section, first account for
761 // the size of each item in the header (see below where we emit these items).
762 int Length = 4 + 2 + 4 + 1 + 1;
763
764 // Figure the padding after the header before the table of address and size
765 // pairs who's values are PointerSize'ed.
Bill Wendlingbc07a892013-06-18 07:20:20 +0000766 const MCAsmInfo *asmInfo = context.getAsmInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000767 int AddrSize = asmInfo->getCodePointerSize();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000768 int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
769 if (Pad == 2 * AddrSize)
770 Pad = 0;
771 Length += Pad;
772
773 // Add the size of the pair of PointerSize'ed values for the address and size
Oliver Stannard8b273082014-06-19 15:52:37 +0000774 // of each section we have in the table.
775 Length += 2 * AddrSize * Sections.size();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000776 // And the pair of terminating zeros.
777 Length += 2 * AddrSize;
778
Kevin Enderbye7739d42011-12-09 18:09:40 +0000779 // Emit the header for this section.
780 // The 4 byte length not including the 4 byte value for the length.
781 MCOS->EmitIntValue(Length - 4, 4);
782 // The 2 byte version, which is 2.
783 MCOS->EmitIntValue(2, 2);
784 // The 4 byte offset to the compile unit in the .debug_info from the start
Alexey Samsonov00fd5252012-11-14 09:55:38 +0000785 // of the .debug_info.
786 if (InfoSectionSymbol)
Saleem Abdulrasoolfcefa212014-09-06 19:57:48 +0000787 MCOS->EmitSymbolValue(InfoSectionSymbol, 4,
788 asmInfo->needsDwarfSectionOffsetDirective());
Alexey Samsonov00fd5252012-11-14 09:55:38 +0000789 else
790 MCOS->EmitIntValue(0, 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000791 // The 1 byte size of an address.
792 MCOS->EmitIntValue(AddrSize, 1);
793 // The 1 byte size of a segment descriptor, we use a value of zero.
794 MCOS->EmitIntValue(0, 1);
795 // Align the header with the padding if needed, before we put out the table.
796 for(int i = 0; i < Pad; i++)
797 MCOS->EmitIntValue(0, 1);
798
Oliver Stannard8b273082014-06-19 15:52:37 +0000799 // Now emit the table of pairs of PointerSize'ed values for the section
800 // addresses and sizes.
Rafael Espindola0709a7b2015-05-21 19:20:38 +0000801 for (MCSection *Sec : Sections) {
802 const MCSymbol *StartSymbol = Sec->getBeginSymbol();
Rafael Espindolae0746792015-05-21 16:52:32 +0000803 MCSymbol *EndSymbol = Sec->getEndSymbol(context);
Oliver Stannard8b273082014-06-19 15:52:37 +0000804 assert(StartSymbol && "StartSymbol must not be NULL");
805 assert(EndSymbol && "EndSymbol must not be NULL");
806
Jim Grosbach13760bd2015-05-30 01:25:56 +0000807 const MCExpr *Addr = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +0000808 StartSymbol, MCSymbolRefExpr::VK_None, context);
809 const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
810 *StartSymbol, *EndSymbol, 0);
811 MCOS->EmitValue(Addr, AddrSize);
Rafael Espindolac23174b2014-08-15 15:12:13 +0000812 emitAbsValue(*MCOS, Size, AddrSize);
Oliver Stannard8b273082014-06-19 15:52:37 +0000813 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000814
815 // And finally the pair of terminating zeros.
816 MCOS->EmitIntValue(0, AddrSize);
817 MCOS->EmitIntValue(0, AddrSize);
818}
819
820// When generating dwarf for assembly source files this emits the data for
821// .debug_info section which contains three parts. The header, the compile_unit
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000822// DIE and a list of label DIEs.
Rafael Espindolac22c85c2012-02-28 21:13:05 +0000823static void EmitGenDwarfInfo(MCStreamer *MCOS,
824 const MCSymbol *AbbrevSectionSymbol,
Oliver Stannard8b273082014-06-19 15:52:37 +0000825 const MCSymbol *LineSectionSymbol,
826 const MCSymbol *RangesSectionSymbol) {
Kevin Enderbye7739d42011-12-09 18:09:40 +0000827 MCContext &context = MCOS->getContext();
828
Jim Grosbachdc1e36e2012-05-11 01:41:30 +0000829 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
Kevin Enderbye7739d42011-12-09 18:09:40 +0000830
831 // Create a symbol at the start and end of this section used in here for the
832 // expression to calculate the length in the header.
Jim Grosbach6f482002015-05-18 18:43:14 +0000833 MCSymbol *InfoStart = context.createTempSymbol();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000834 MCOS->EmitLabel(InfoStart);
Jim Grosbach6f482002015-05-18 18:43:14 +0000835 MCSymbol *InfoEnd = context.createTempSymbol();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000836
837 // First part: the header.
838
839 // The 4 byte total length of the information for this compilation unit, not
840 // including these 4 bytes.
841 const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
Rafael Espindolac23174b2014-08-15 15:12:13 +0000842 emitAbsValue(*MCOS, Length, 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000843
Oliver Stannard7eacbd52014-05-01 08:46:02 +0000844 // The 2 byte DWARF version.
845 MCOS->EmitIntValue(context.getDwarfVersion(), 2);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000846
Paul Robinsondccb4fe2017-02-28 23:40:46 +0000847 // The DWARF v5 header has unit type, address size, abbrev offset.
848 // Earlier versions have abbrev offset, address size.
Saleem Abdulrasool00426d92014-07-19 21:01:58 +0000849 const MCAsmInfo &AsmInfo = *context.getAsmInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000850 int AddrSize = AsmInfo.getCodePointerSize();
Paul Robinsondccb4fe2017-02-28 23:40:46 +0000851 if (context.getDwarfVersion() >= 5) {
852 MCOS->EmitIntValue(dwarf::DW_UT_compile, 1);
853 MCOS->EmitIntValue(AddrSize, 1);
854 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000855 // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
856 // it is at the start of that section so this is zero.
Saleem Abdulrasool7d095302014-07-17 16:27:44 +0000857 if (AbbrevSectionSymbol == nullptr)
Rafael Espindolac22c85c2012-02-28 21:13:05 +0000858 MCOS->EmitIntValue(0, 4);
Saleem Abdulrasool7d095302014-07-17 16:27:44 +0000859 else
Saleem Abdulrasool00426d92014-07-19 21:01:58 +0000860 MCOS->EmitSymbolValue(AbbrevSectionSymbol, 4,
861 AsmInfo.needsDwarfSectionOffsetDirective());
Paul Robinsondccb4fe2017-02-28 23:40:46 +0000862 if (context.getDwarfVersion() <= 4)
863 MCOS->EmitIntValue(AddrSize, 1);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000864
865 // Second part: the compile_unit DIE.
866
867 // The DW_TAG_compile_unit DIE abbrev (1).
868 MCOS->EmitULEB128IntValue(1);
869
870 // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
871 // which is at the start of that section so this is zero.
Saleem Abdulrasool5c70de12014-09-05 04:15:00 +0000872 if (LineSectionSymbol)
873 MCOS->EmitSymbolValue(LineSectionSymbol, 4,
874 AsmInfo.needsDwarfSectionOffsetDirective());
875 else
Rafael Espindolac22c85c2012-02-28 21:13:05 +0000876 MCOS->EmitIntValue(0, 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000877
Oliver Stannard8b273082014-06-19 15:52:37 +0000878 if (RangesSectionSymbol) {
879 // There are multiple sections containing code, so we must use the
880 // .debug_ranges sections.
Kevin Enderbye7739d42011-12-09 18:09:40 +0000881
Oliver Stannard8b273082014-06-19 15:52:37 +0000882 // AT_ranges, the 4 byte offset from the start of the .debug_ranges section
883 // to the address range list for this compilation unit.
884 MCOS->EmitSymbolValue(RangesSectionSymbol, 4);
885 } else {
886 // If we only have one non-empty code section, we can use the simpler
887 // AT_low_pc and AT_high_pc attributes.
888
889 // Find the first (and only) non-empty text section
890 auto &Sections = context.getGenDwarfSectionSyms();
891 const auto TextSection = Sections.begin();
892 assert(TextSection != Sections.end() && "No text section found");
893
Rafael Espindolae0746792015-05-21 16:52:32 +0000894 MCSymbol *StartSymbol = (*TextSection)->getBeginSymbol();
895 MCSymbol *EndSymbol = (*TextSection)->getEndSymbol(context);
Oliver Stannard8b273082014-06-19 15:52:37 +0000896 assert(StartSymbol && "StartSymbol must not be NULL");
897 assert(EndSymbol && "EndSymbol must not be NULL");
898
899 // AT_low_pc, the first address of the default .text section.
Jim Grosbach13760bd2015-05-30 01:25:56 +0000900 const MCExpr *Start = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +0000901 StartSymbol, MCSymbolRefExpr::VK_None, context);
902 MCOS->EmitValue(Start, AddrSize);
903
904 // AT_high_pc, the last address of the default .text section.
Jim Grosbach13760bd2015-05-30 01:25:56 +0000905 const MCExpr *End = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +0000906 EndSymbol, MCSymbolRefExpr::VK_None, context);
907 MCOS->EmitValue(End, AddrSize);
908 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000909
910 // AT_name, the name of the source file. Reconstruct from the first directory
911 // and file table entries.
David Blaikie533490de2014-03-13 19:05:33 +0000912 const SmallVectorImpl<std::string> &MCDwarfDirs = context.getMCDwarfDirs();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000913 if (MCDwarfDirs.size() > 0) {
Eric Christophere3ab3d02013-01-09 01:57:54 +0000914 MCOS->EmitBytes(MCDwarfDirs[0]);
Yaron Keren15217202014-05-16 13:16:30 +0000915 MCOS->EmitBytes(sys::path::get_separator());
Kevin Enderbye7739d42011-12-09 18:09:40 +0000916 }
David Blaikiea55ddad2014-03-13 18:55:04 +0000917 const SmallVectorImpl<MCDwarfFile> &MCDwarfFiles =
Kevin Enderbye7739d42011-12-09 18:09:40 +0000918 MCOS->getContext().getMCDwarfFiles();
David Blaikiea55ddad2014-03-13 18:55:04 +0000919 MCOS->EmitBytes(MCDwarfFiles[1].Name);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000920 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
921
922 // AT_comp_dir, the working directory the assembly was done in.
Andrew Trick32591d32013-12-10 04:39:09 +0000923 if (!context.getCompilationDir().empty()) {
924 MCOS->EmitBytes(context.getCompilationDir());
925 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
926 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000927
928 // AT_APPLE_flags, the command line arguments of the assembler tool.
929 StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
930 if (!DwarfDebugFlags.empty()){
Eric Christophere3ab3d02013-01-09 01:57:54 +0000931 MCOS->EmitBytes(DwarfDebugFlags);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000932 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
933 }
934
935 // AT_producer, the version of the assembler tool.
Kevin Enderbye82ada62013-01-16 17:46:23 +0000936 StringRef DwarfDebugProducer = context.getDwarfDebugProducer();
Saleem Abdulrasool19f8bc62014-07-17 16:27:35 +0000937 if (!DwarfDebugProducer.empty())
Kevin Enderbye82ada62013-01-16 17:46:23 +0000938 MCOS->EmitBytes(DwarfDebugProducer);
Saleem Abdulrasool19f8bc62014-07-17 16:27:35 +0000939 else
940 MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM " PACKAGE_VERSION ")"));
Kevin Enderbye7739d42011-12-09 18:09:40 +0000941 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
942
943 // AT_language, a 4 byte value. We use DW_LANG_Mips_Assembler as the dwarf2
944 // draft has no standard code for assembler.
945 MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
946
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000947 // Third part: the list of label DIEs.
Kevin Enderbye7739d42011-12-09 18:09:40 +0000948
Kevin Enderbyf7d77062012-01-10 21:12:34 +0000949 // Loop on saved info for dwarf labels and create the DIEs for them.
David Blaikie1e0fc8f2014-04-11 00:43:52 +0000950 const std::vector<MCGenDwarfLabelEntry> &Entries =
951 MCOS->getContext().getMCGenDwarfLabelEntries();
952 for (const auto &Entry : Entries) {
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000953 // The DW_TAG_label DIE abbrev (2).
Kevin Enderbye7739d42011-12-09 18:09:40 +0000954 MCOS->EmitULEB128IntValue(2);
955
956 // AT_name, of the label without any leading underbar.
David Blaikie1e0fc8f2014-04-11 00:43:52 +0000957 MCOS->EmitBytes(Entry.getName());
Kevin Enderbye7739d42011-12-09 18:09:40 +0000958 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
959
960 // AT_decl_file, index into the file table.
David Blaikie1e0fc8f2014-04-11 00:43:52 +0000961 MCOS->EmitIntValue(Entry.getFileNumber(), 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000962
963 // AT_decl_line, source line number.
David Blaikie1e0fc8f2014-04-11 00:43:52 +0000964 MCOS->EmitIntValue(Entry.getLineNumber(), 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000965
966 // AT_low_pc, start address of the label.
Jim Grosbach13760bd2015-05-30 01:25:56 +0000967 const MCExpr *AT_low_pc = MCSymbolRefExpr::create(Entry.getLabel(),
Kevin Enderbye7739d42011-12-09 18:09:40 +0000968 MCSymbolRefExpr::VK_None, context);
Rafael Espindola98629c42014-03-20 21:26:38 +0000969 MCOS->EmitValue(AT_low_pc, AddrSize);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000970
Kevin Enderbye7739d42011-12-09 18:09:40 +0000971 // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
972 MCOS->EmitIntValue(0, 1);
973
974 // The DW_TAG_unspecified_parameters DIE abbrev (3).
975 MCOS->EmitULEB128IntValue(3);
976
977 // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
978 MCOS->EmitIntValue(0, 1);
979 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000980
981 // Add the NULL DIE terminating the Compile Unit DIE's.
982 MCOS->EmitIntValue(0, 1);
983
984 // Now set the value of the symbol at the end of the info section.
985 MCOS->EmitLabel(InfoEnd);
986}
987
Oliver Stannard8b273082014-06-19 15:52:37 +0000988// When generating dwarf for assembly source files this emits the data for
989// .debug_ranges section. We only emit one range list, which spans all of the
990// executable sections of this file.
991static void EmitGenDwarfRanges(MCStreamer *MCOS) {
992 MCContext &context = MCOS->getContext();
993 auto &Sections = context.getGenDwarfSectionSyms();
994
995 const MCAsmInfo *AsmInfo = context.getAsmInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000996 int AddrSize = AsmInfo->getCodePointerSize();
Oliver Stannard8b273082014-06-19 15:52:37 +0000997
998 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
999
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001000 for (MCSection *Sec : Sections) {
1001 const MCSymbol *StartSymbol = Sec->getBeginSymbol();
Rafael Espindolae0746792015-05-21 16:52:32 +00001002 MCSymbol *EndSymbol = Sec->getEndSymbol(context);
Oliver Stannard8b273082014-06-19 15:52:37 +00001003 assert(StartSymbol && "StartSymbol must not be NULL");
1004 assert(EndSymbol && "EndSymbol must not be NULL");
1005
1006 // Emit a base address selection entry for the start of this section
Jim Grosbach13760bd2015-05-30 01:25:56 +00001007 const MCExpr *SectionStartAddr = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +00001008 StartSymbol, MCSymbolRefExpr::VK_None, context);
Petr Hosekfaef3202016-06-01 01:59:58 +00001009 MCOS->emitFill(AddrSize, 0xFF);
Oliver Stannard8b273082014-06-19 15:52:37 +00001010 MCOS->EmitValue(SectionStartAddr, AddrSize);
1011
1012 // Emit a range list entry spanning this section
1013 const MCExpr *SectionSize = MakeStartMinusEndExpr(*MCOS,
1014 *StartSymbol, *EndSymbol, 0);
1015 MCOS->EmitIntValue(0, AddrSize);
Rafael Espindolac23174b2014-08-15 15:12:13 +00001016 emitAbsValue(*MCOS, SectionSize, AddrSize);
Oliver Stannard8b273082014-06-19 15:52:37 +00001017 }
1018
1019 // Emit end of list entry
1020 MCOS->EmitIntValue(0, AddrSize);
1021 MCOS->EmitIntValue(0, AddrSize);
1022}
1023
Kevin Enderbye7739d42011-12-09 18:09:40 +00001024//
1025// When generating dwarf for assembly source files this emits the Dwarf
1026// sections.
1027//
David Blaikie8bf66c42014-04-01 07:35:52 +00001028void MCGenDwarfInfo::Emit(MCStreamer *MCOS) {
Kevin Enderbye7739d42011-12-09 18:09:40 +00001029 MCContext &context = MCOS->getContext();
Oliver Stannard8b273082014-06-19 15:52:37 +00001030
1031 // Create the dwarf sections in this order (.debug_line already created).
Bill Wendlingbc07a892013-06-18 07:20:20 +00001032 const MCAsmInfo *AsmInfo = context.getAsmInfo();
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001033 bool CreateDwarfSectionSymbols =
Bill Wendlingbc07a892013-06-18 07:20:20 +00001034 AsmInfo->doesDwarfUseRelocationsAcrossSections();
David Blaikie8bf66c42014-04-01 07:35:52 +00001035 MCSymbol *LineSectionSymbol = nullptr;
David Blaikie34641612014-04-01 08:07:52 +00001036 if (CreateDwarfSectionSymbols)
1037 LineSectionSymbol = MCOS->getDwarfLineTableSymbol(0);
Craig Topperbb694de2014-04-13 04:57:38 +00001038 MCSymbol *AbbrevSectionSymbol = nullptr;
1039 MCSymbol *InfoSectionSymbol = nullptr;
Hans Wennborg083ca9b2015-10-06 23:24:35 +00001040 MCSymbol *RangesSectionSymbol = nullptr;
Oliver Stannard8b273082014-06-19 15:52:37 +00001041
1042 // Create end symbols for each section, and remove empty sections
1043 MCOS->getContext().finalizeDwarfSections(*MCOS);
1044
1045 // If there are no sections to generate debug info for, we don't need
1046 // to do anything
1047 if (MCOS->getContext().getGenDwarfSectionSyms().empty())
1048 return;
1049
Oliver Stannard14f97d02014-09-22 10:45:16 +00001050 // We only use the .debug_ranges section if we have multiple code sections,
1051 // and we are emitting a DWARF version which supports it.
Oliver Stannard8b273082014-06-19 15:52:37 +00001052 const bool UseRangesSection =
Oliver Stannard14f97d02014-09-22 10:45:16 +00001053 MCOS->getContext().getGenDwarfSectionSyms().size() > 1 &&
1054 MCOS->getContext().getDwarfVersion() >= 3;
Oliver Stannard8b273082014-06-19 15:52:37 +00001055 CreateDwarfSectionSymbols |= UseRangesSection;
1056
Kevin Enderbye7739d42011-12-09 18:09:40 +00001057 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001058 if (CreateDwarfSectionSymbols) {
Jim Grosbach6f482002015-05-18 18:43:14 +00001059 InfoSectionSymbol = context.createTempSymbol();
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001060 MCOS->EmitLabel(InfoSectionSymbol);
1061 }
Kevin Enderbye7739d42011-12-09 18:09:40 +00001062 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001063 if (CreateDwarfSectionSymbols) {
Jim Grosbach6f482002015-05-18 18:43:14 +00001064 AbbrevSectionSymbol = context.createTempSymbol();
Rafael Espindolac22c85c2012-02-28 21:13:05 +00001065 MCOS->EmitLabel(AbbrevSectionSymbol);
Rafael Espindolac22c85c2012-02-28 21:13:05 +00001066 }
Oliver Stannard8b273082014-06-19 15:52:37 +00001067 if (UseRangesSection) {
1068 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
1069 if (CreateDwarfSectionSymbols) {
Jim Grosbach6f482002015-05-18 18:43:14 +00001070 RangesSectionSymbol = context.createTempSymbol();
Oliver Stannard8b273082014-06-19 15:52:37 +00001071 MCOS->EmitLabel(RangesSectionSymbol);
1072 }
1073 }
Kevin Enderbye7739d42011-12-09 18:09:40 +00001074
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001075 assert((RangesSectionSymbol != nullptr) || !UseRangesSection);
Oliver Stannard8b273082014-06-19 15:52:37 +00001076
1077 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
Kevin Enderbye7739d42011-12-09 18:09:40 +00001078
1079 // Output the data for .debug_aranges section.
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001080 EmitGenDwarfAranges(MCOS, InfoSectionSymbol);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001081
Oliver Stannard8b273082014-06-19 15:52:37 +00001082 if (UseRangesSection)
1083 EmitGenDwarfRanges(MCOS);
1084
Kevin Enderbye7739d42011-12-09 18:09:40 +00001085 // Output the data for .debug_abbrev section.
1086 EmitGenDwarfAbbrev(MCOS);
1087
1088 // Output the data for .debug_info section.
Oliver Stannard8b273082014-06-19 15:52:37 +00001089 EmitGenDwarfInfo(MCOS, AbbrevSectionSymbol, LineSectionSymbol,
1090 RangesSectionSymbol);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001091}
1092
1093//
1094// When generating dwarf for assembly source files this is called when symbol
1095// for a label is created. If this symbol is not a temporary and is in the
1096// section that dwarf is being generated for, save the needed info to create
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001097// a dwarf label.
Kevin Enderbye7739d42011-12-09 18:09:40 +00001098//
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001099void MCGenDwarfLabelEntry::Make(MCSymbol *Symbol, MCStreamer *MCOS,
Kevin Enderbye7739d42011-12-09 18:09:40 +00001100 SourceMgr &SrcMgr, SMLoc &Loc) {
Oliver Stannard8b273082014-06-19 15:52:37 +00001101 // We won't create dwarf labels for temporary symbols.
Kevin Enderbye7739d42011-12-09 18:09:40 +00001102 if (Symbol->isTemporary())
1103 return;
1104 MCContext &context = MCOS->getContext();
Oliver Stannard8b273082014-06-19 15:52:37 +00001105 // We won't create dwarf labels for symbols in sections that we are not
1106 // generating debug info for.
Eric Christopher445c9522016-10-14 05:47:37 +00001107 if (!context.getGenDwarfSectionSyms().count(MCOS->getCurrentSectionOnly()))
Kevin Enderbye7739d42011-12-09 18:09:40 +00001108 return;
1109
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001110 // The dwarf label's name does not have the symbol name's leading
Kevin Enderbye7739d42011-12-09 18:09:40 +00001111 // underbar if any.
1112 StringRef Name = Symbol->getName();
1113 if (Name.startswith("_"))
1114 Name = Name.substr(1, Name.size()-1);
1115
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001116 // Get the dwarf file number to be used for the dwarf label.
Kevin Enderbye7739d42011-12-09 18:09:40 +00001117 unsigned FileNumber = context.getGenDwarfFileNumber();
1118
1119 // Finding the line number is the expensive part which is why we just don't
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001120 // pass it in as for some symbols we won't create a dwarf label.
Alp Tokera55b95b2014-07-06 10:33:31 +00001121 unsigned CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001122 unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
1123
1124 // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
1125 // values so that they don't have things like an ARM thumb bit from the
1126 // original symbol. So when used they won't get a low bit set after
1127 // relocation.
Jim Grosbach6f482002015-05-18 18:43:14 +00001128 MCSymbol *Label = context.createTempSymbol();
Kevin Enderbye7739d42011-12-09 18:09:40 +00001129 MCOS->EmitLabel(Label);
1130
1131 // Create and entry for the info and add it to the other entries.
David Blaikie1e0fc8f2014-04-11 00:43:52 +00001132 MCOS->getContext().addMCGenDwarfLabelEntry(
1133 MCGenDwarfLabelEntry(Name, FileNumber, LineNumber, Label));
Kevin Enderbye7739d42011-12-09 18:09:40 +00001134}
1135
Rafael Espindola0a017a62010-12-10 07:39:47 +00001136static int getDataAlignmentFactor(MCStreamer &streamer) {
1137 MCContext &context = streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001138 const MCAsmInfo *asmInfo = context.getAsmInfo();
1139 int size = asmInfo->getCalleeSaveStackSlotSize();
1140 if (asmInfo->isStackGrowthDirectionUp())
Rafael Espindola0a017a62010-12-10 07:39:47 +00001141 return size;
Evan Chenga83b37a2011-07-15 02:09:41 +00001142 else
1143 return -size;
Rafael Espindola0a017a62010-12-10 07:39:47 +00001144}
1145
Rafael Espindola5395f442011-04-22 00:08:43 +00001146static unsigned getSizeForEncoding(MCStreamer &streamer,
1147 unsigned symbolEncoding) {
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001148 MCContext &context = streamer.getContext();
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001149 unsigned format = symbolEncoding & 0x0f;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001150 switch (format) {
Craig Toppera2886c22012-02-07 05:05:23 +00001151 default: llvm_unreachable("Unknown Encoding");
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001152 case dwarf::DW_EH_PE_absptr:
1153 case dwarf::DW_EH_PE_signed:
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001154 return context.getAsmInfo()->getCodePointerSize();
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001155 case dwarf::DW_EH_PE_udata2:
1156 case dwarf::DW_EH_PE_sdata2:
Rafael Espindola5395f442011-04-22 00:08:43 +00001157 return 2;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001158 case dwarf::DW_EH_PE_udata4:
1159 case dwarf::DW_EH_PE_sdata4:
Rafael Espindola5395f442011-04-22 00:08:43 +00001160 return 4;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001161 case dwarf::DW_EH_PE_udata8:
1162 case dwarf::DW_EH_PE_sdata8:
Rafael Espindola5395f442011-04-22 00:08:43 +00001163 return 8;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001164 }
Rafael Espindola5395f442011-04-22 00:08:43 +00001165}
1166
Rafael Espindolafe963b12014-08-15 03:07:13 +00001167static void emitFDESymbol(MCObjectStreamer &streamer, const MCSymbol &symbol,
1168 unsigned symbolEncoding, bool isEH) {
Rafael Espindola6bd6a702011-04-28 21:04:39 +00001169 MCContext &context = streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001170 const MCAsmInfo *asmInfo = context.getAsmInfo();
1171 const MCExpr *v = asmInfo->getExprForFDESymbol(&symbol,
1172 symbolEncoding,
1173 streamer);
Rafael Espindola5395f442011-04-22 00:08:43 +00001174 unsigned size = getSizeForEncoding(streamer, symbolEncoding);
Iain Sandoe618def62014-01-08 10:22:54 +00001175 if (asmInfo->doDwarfFDESymbolsUseAbsDiff() && isEH)
Rafael Espindolac23174b2014-08-15 15:12:13 +00001176 emitAbsValue(streamer, v, size);
Iain Sandoe618def62014-01-08 10:22:54 +00001177 else
1178 streamer.EmitValue(v, size);
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001179}
1180
Rafael Espindolac5dac4d2011-04-28 16:09:09 +00001181static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
1182 unsigned symbolEncoding) {
1183 MCContext &context = streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001184 const MCAsmInfo *asmInfo = context.getAsmInfo();
1185 const MCExpr *v = asmInfo->getExprForPersonalitySymbol(&symbol,
1186 symbolEncoding,
1187 streamer);
Rafael Espindolac5dac4d2011-04-28 16:09:09 +00001188 unsigned size = getSizeForEncoding(streamer, symbolEncoding);
Rafael Espindolafd057852011-05-01 03:50:49 +00001189 streamer.EmitValue(v, size);
Rafael Espindolac5dac4d2011-04-28 16:09:09 +00001190}
1191
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001192namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001193
Rafael Espindola68c21652015-11-05 23:54:18 +00001194class FrameEmitterImpl {
Rafael Espindolaa1d960e2015-11-05 23:55:51 +00001195 int CFAOffset = 0;
1196 int InitialCFAOffset = 0;
Rafael Espindola68c21652015-11-05 23:54:18 +00001197 bool IsEH;
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001198 MCObjectStreamer &Streamer;
Bill Wendling4d9aa512011-07-22 21:18:59 +00001199
Rafael Espindola68c21652015-11-05 23:54:18 +00001200public:
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001201 FrameEmitterImpl(bool IsEH, MCObjectStreamer &Streamer)
1202 : IsEH(IsEH), Streamer(Streamer) {}
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001203
Rafael Espindola68c21652015-11-05 23:54:18 +00001204 /// Emit the unwind information in a compact way.
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001205 void EmitCompactUnwind(const MCDwarfFrameInfo &frame);
Rafael Espindola68c21652015-11-05 23:54:18 +00001206
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001207 const MCSymbol &EmitCIE(const MCDwarfFrameInfo &F);
Rafael Espindola46be4352015-11-06 03:02:51 +00001208 void EmitFDE(const MCSymbol &cieStart, const MCDwarfFrameInfo &frame,
Rafael Espindola97588e12015-11-06 13:14:59 +00001209 bool LastInSection, const MCSymbol &SectionStart);
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001210 void EmitCFIInstructions(ArrayRef<MCCFIInstruction> Instrs,
Rafael Espindola68c21652015-11-05 23:54:18 +00001211 MCSymbol *BaseLabel);
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001212 void EmitCFIInstruction(const MCCFIInstruction &Instr);
Rafael Espindola68c21652015-11-05 23:54:18 +00001213};
Bill Wendling567a1ae2011-06-30 21:25:51 +00001214
1215} // end anonymous namespace
1216
Rafael Espindolafe963b12014-08-15 03:07:13 +00001217static void emitEncodingByte(MCObjectStreamer &Streamer, unsigned Encoding) {
Bill Wendling567a1ae2011-06-30 21:25:51 +00001218 Streamer.EmitIntValue(Encoding, 1);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001219}
1220
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001221void FrameEmitterImpl::EmitCFIInstruction(const MCCFIInstruction &Instr) {
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001222 int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001223 auto *MRI = Streamer.getContext().getRegisterInfo();
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001224
1225 switch (Instr.getOperation()) {
Rafael Espindolacdb9a532012-11-25 15:14:49 +00001226 case MCCFIInstruction::OpRegister: {
1227 unsigned Reg1 = Instr.getRegister();
1228 unsigned Reg2 = Instr.getRegister2();
Frederic Rissadbb3f22015-02-26 19:48:07 +00001229 if (!IsEH) {
Jake Ehrlich3da79822017-12-01 21:44:27 +00001230 Reg1 = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg1);
1231 Reg2 = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg2);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001232 }
Rafael Espindolacdb9a532012-11-25 15:14:49 +00001233 Streamer.EmitIntValue(dwarf::DW_CFA_register, 1);
1234 Streamer.EmitULEB128IntValue(Reg1);
1235 Streamer.EmitULEB128IntValue(Reg2);
1236 return;
1237 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001238 case MCCFIInstruction::OpWindowSave:
Venkatraman Govindaraju3816d432013-09-26 14:49:40 +00001239 Streamer.EmitIntValue(dwarf::DW_CFA_GNU_window_save, 1);
1240 return;
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001241
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001242 case MCCFIInstruction::OpUndefined: {
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001243 unsigned Reg = Instr.getRegister();
Rafael Espindola9bb24782012-11-23 16:59:41 +00001244 Streamer.EmitIntValue(dwarf::DW_CFA_undefined, 1);
1245 Streamer.EmitULEB128IntValue(Reg);
1246 return;
1247 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001248 case MCCFIInstruction::OpAdjustCfaOffset:
1249 case MCCFIInstruction::OpDefCfaOffset: {
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001250 const bool IsRelative =
1251 Instr.getOperation() == MCCFIInstruction::OpAdjustCfaOffset;
1252
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001253 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
1254
1255 if (IsRelative)
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001256 CFAOffset += Instr.getOffset();
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001257 else
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001258 CFAOffset = -Instr.getOffset();
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001259
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001260 Streamer.EmitULEB128IntValue(CFAOffset);
1261
1262 return;
1263 }
1264 case MCCFIInstruction::OpDefCfa: {
Frederic Rissadbb3f22015-02-26 19:48:07 +00001265 unsigned Reg = Instr.getRegister();
1266 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001267 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001268 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001269 Streamer.EmitULEB128IntValue(Reg);
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001270 CFAOffset = -Instr.getOffset();
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001271 Streamer.EmitULEB128IntValue(CFAOffset);
1272
1273 return;
1274 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001275 case MCCFIInstruction::OpDefCfaRegister: {
Frederic Rissadbb3f22015-02-26 19:48:07 +00001276 unsigned Reg = Instr.getRegister();
1277 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001278 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001279 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001280 Streamer.EmitULEB128IntValue(Reg);
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001281
1282 return;
1283 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001284 case MCCFIInstruction::OpOffset:
1285 case MCCFIInstruction::OpRelOffset: {
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001286 const bool IsRelative =
1287 Instr.getOperation() == MCCFIInstruction::OpRelOffset;
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001288
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001289 unsigned Reg = Instr.getRegister();
Frederic Rissadbb3f22015-02-26 19:48:07 +00001290 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001291 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001292
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001293 int Offset = Instr.getOffset();
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001294 if (IsRelative)
1295 Offset -= CFAOffset;
1296 Offset = Offset / dataAlignmentFactor;
1297
1298 if (Offset < 0) {
1299 Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
1300 Streamer.EmitULEB128IntValue(Reg);
1301 Streamer.EmitSLEB128IntValue(Offset);
1302 } else if (Reg < 64) {
1303 Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
Rafael Espindolaea61f222011-04-21 23:26:40 +00001304 Streamer.EmitULEB128IntValue(Offset);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001305 } else {
1306 Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
Rafael Espindolaea61f222011-04-21 23:26:40 +00001307 Streamer.EmitULEB128IntValue(Reg);
1308 Streamer.EmitULEB128IntValue(Offset);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001309 }
1310 return;
1311 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001312 case MCCFIInstruction::OpRememberState:
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001313 Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
1314 return;
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001315 case MCCFIInstruction::OpRestoreState:
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001316 Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
1317 return;
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001318 case MCCFIInstruction::OpSameValue: {
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001319 unsigned Reg = Instr.getRegister();
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001320 Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
Rafael Espindola6aea5922011-04-21 23:39:26 +00001321 Streamer.EmitULEB128IntValue(Reg);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001322 return;
1323 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001324 case MCCFIInstruction::OpRestore: {
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001325 unsigned Reg = Instr.getRegister();
Frederic Rissadbb3f22015-02-26 19:48:07 +00001326 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001327 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Rafael Espindola4ea99812011-12-29 21:43:03 +00001328 Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
1329 return;
1330 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001331 case MCCFIInstruction::OpGnuArgsSize:
Michael Kuperstein259f1502015-10-07 07:01:31 +00001332 Streamer.EmitIntValue(dwarf::DW_CFA_GNU_args_size, 1);
1333 Streamer.EmitULEB128IntValue(Instr.getOffset());
1334 return;
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001335
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001336 case MCCFIInstruction::OpEscape:
Eric Christophere3ab3d02013-01-09 01:57:54 +00001337 Streamer.EmitBytes(Instr.getValues());
Rafael Espindolaef4aa352011-12-29 20:24:47 +00001338 return;
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001339 }
1340 llvm_unreachable("Unhandled case in switch");
1341}
1342
Rafael Espindolafe963b12014-08-15 03:07:13 +00001343/// Emit frame instructions to describe the layout of the frame.
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001344void FrameEmitterImpl::EmitCFIInstructions(ArrayRef<MCCFIInstruction> Instrs,
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001345 MCSymbol *BaseLabel) {
Benjamin Kramer7b4658f2016-06-26 14:49:00 +00001346 for (const MCCFIInstruction &Instr : Instrs) {
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001347 MCSymbol *Label = Instr.getLabel();
1348 // Throw out move if the label is invalid.
1349 if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1350
1351 // Advance row if new location.
1352 if (BaseLabel && Label) {
1353 MCSymbol *ThisSym = Label;
1354 if (ThisSym != BaseLabel) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001355 Streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001356 BaseLabel = ThisSym;
1357 }
1358 }
1359
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001360 EmitCFIInstruction(Instr);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001361 }
1362}
1363
Rafael Espindolafe963b12014-08-15 03:07:13 +00001364/// Emit the unwind information in a compact way.
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001365void FrameEmitterImpl::EmitCompactUnwind(const MCDwarfFrameInfo &Frame) {
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001366 MCContext &Context = Streamer.getContext();
Evan Cheng76792992011-07-20 05:58:47 +00001367 const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001368
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001369 // range-start range-length compact-unwind-enc personality-func lsda
1370 // _foo LfooEnd-_foo 0x00000023 0 0
1371 // _bar LbarEnd-_bar 0x00000025 __gxx_personality except_tab1
1372 //
1373 // .section __LD,__compact_unwind,regular,debug
1374 //
1375 // # compact unwind for _foo
1376 // .quad _foo
1377 // .set L1,LfooEnd-_foo
1378 // .long L1
1379 // .long 0x01010001
1380 // .quad 0
1381 // .quad 0
1382 //
1383 // # compact unwind for _bar
1384 // .quad _bar
1385 // .set L2,LbarEnd-_bar
1386 // .long L2
1387 // .long 0x01020011
1388 // .quad __gxx_personality
1389 // .quad except_tab1
1390
Bill Wendling49bc6802011-07-19 00:06:12 +00001391 uint32_t Encoding = Frame.CompactUnwindEncoding;
Bill Wendling99bce5f2013-04-18 23:16:46 +00001392 if (!Encoding) return;
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001393 bool DwarfEHFrameOnly = (Encoding == MOFI->getCompactUnwindDwarfEHFrameOnly());
Bill Wendlingb6adf462011-07-07 00:54:13 +00001394
Bill Wendlingdafd5982011-07-14 23:34:45 +00001395 // The encoding needs to know we have an LSDA.
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001396 if (!DwarfEHFrameOnly && Frame.Lsda)
Bill Wendlingdafd5982011-07-14 23:34:45 +00001397 Encoding |= 0x40000000;
1398
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001399 // Range Start
Rafael Espindolaaa7851d2014-05-12 13:47:05 +00001400 unsigned FDEEncoding = MOFI->getFDEEncoding();
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001401 unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
Rafael Espindola88604822014-06-23 15:34:32 +00001402 Streamer.EmitSymbolValue(Frame.Begin, Size);
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001403
1404 // Range Length
1405 const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1406 *Frame.End, 0);
Rafael Espindolac23174b2014-08-15 15:12:13 +00001407 emitAbsValue(Streamer, Range, 4);
Bill Wendling75174662011-06-30 00:30:52 +00001408
Bill Wendling75174662011-06-30 00:30:52 +00001409 // Compact Encoding
Bill Wendling75174662011-06-30 00:30:52 +00001410 Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1411 Streamer.EmitIntValue(Encoding, Size);
1412
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001413 // Personality Function
Bill Wendlingdafd5982011-07-14 23:34:45 +00001414 Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001415 if (!DwarfEHFrameOnly && Frame.Personality)
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001416 Streamer.EmitSymbolValue(Frame.Personality, Size);
Bill Wendling4cdb2062011-06-29 23:53:16 +00001417 else
1418 Streamer.EmitIntValue(0, Size); // No personality fn
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001419
1420 // LSDA
Bill Wendling4cdb2062011-06-29 23:53:16 +00001421 Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001422 if (!DwarfEHFrameOnly && Frame.Lsda)
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001423 Streamer.EmitSymbolValue(Frame.Lsda, Size);
Bill Wendling4cdb2062011-06-29 23:53:16 +00001424 else
1425 Streamer.EmitIntValue(0, Size); // No LSDA
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001426}
1427
Rafael Espindolaeffdc7e2015-04-28 13:55:31 +00001428static unsigned getCIEVersion(bool IsEH, unsigned DwarfVersion) {
1429 if (IsEH)
1430 return 1;
1431 switch (DwarfVersion) {
1432 case 2:
1433 return 1;
1434 case 3:
1435 return 3;
1436 case 4:
Eric Christopher2ae71802015-12-28 23:02:42 +00001437 case 5:
Rafael Espindolaeffdc7e2015-04-28 13:55:31 +00001438 return 4;
1439 }
1440 llvm_unreachable("Unknown version");
1441}
1442
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001443const MCSymbol &FrameEmitterImpl::EmitCIE(const MCDwarfFrameInfo &Frame) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001444 MCContext &context = Streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001445 const MCRegisterInfo *MRI = context.getRegisterInfo();
Evan Cheng76792992011-07-20 05:58:47 +00001446 const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
Rafael Espindolabf60fb02011-04-28 03:26:11 +00001447
Jim Grosbach6f482002015-05-18 18:43:14 +00001448 MCSymbol *sectionStart = context.createTempSymbol();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001449 Streamer.EmitLabel(sectionStart);
Rafael Espindolabf60fb02011-04-28 03:26:11 +00001450
Jim Grosbach6f482002015-05-18 18:43:14 +00001451 MCSymbol *sectionEnd = context.createTempSymbol();
Rafael Espindola0a017a62010-12-10 07:39:47 +00001452
1453 // Length
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001454 const MCExpr *Length =
1455 MakeStartMinusEndExpr(Streamer, *sectionStart, *sectionEnd, 4);
1456 emitAbsValue(Streamer, Length, 4);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001457
1458 // CIE ID
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001459 unsigned CIE_ID = IsEH ? 0 : -1;
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001460 Streamer.EmitIntValue(CIE_ID, 4);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001461
1462 // Version
Rafael Espindolaeffdc7e2015-04-28 13:55:31 +00001463 uint8_t CIEVersion = getCIEVersion(IsEH, context.getDwarfVersion());
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001464 Streamer.EmitIntValue(CIEVersion, 1);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001465
1466 // Augmentation String
1467 SmallString<8> Augmentation;
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001468 if (IsEH) {
1469 Augmentation += "z";
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001470 if (Frame.Personality)
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001471 Augmentation += "P";
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001472 if (Frame.Lsda)
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001473 Augmentation += "L";
1474 Augmentation += "R";
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001475 if (Frame.IsSignalFrame)
Rafael Espindola3c47e372012-01-23 21:51:52 +00001476 Augmentation += "S";
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001477 Streamer.EmitBytes(Augmentation);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001478 }
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001479 Streamer.EmitIntValue(0, 1);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001480
Keith Walkerea9483f2015-05-12 15:25:08 +00001481 if (CIEVersion >= 4) {
1482 // Address Size
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001483 Streamer.EmitIntValue(context.getAsmInfo()->getCodePointerSize(), 1);
Keith Walkerea9483f2015-05-12 15:25:08 +00001484
1485 // Segment Descriptor Size
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001486 Streamer.EmitIntValue(0, 1);
Keith Walkerea9483f2015-05-12 15:25:08 +00001487 }
1488
Rafael Espindola0a017a62010-12-10 07:39:47 +00001489 // Code Alignment Factor
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001490 Streamer.EmitULEB128IntValue(context.getAsmInfo()->getMinInstAlignment());
Rafael Espindola0a017a62010-12-10 07:39:47 +00001491
1492 // Data Alignment Factor
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001493 Streamer.EmitSLEB128IntValue(getDataAlignmentFactor(Streamer));
Rafael Espindola0a017a62010-12-10 07:39:47 +00001494
1495 // Return Address Register
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001496 unsigned RAReg = Frame.RAReg;
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001497 if (RAReg == static_cast<unsigned>(INT_MAX))
1498 RAReg = MRI->getDwarfRegNum(MRI->getRARegister(), IsEH);
1499
Oliver Stannardf7693f42014-06-19 15:39:33 +00001500 if (CIEVersion == 1) {
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001501 assert(RAReg <= 255 &&
Oliver Stannardf7693f42014-06-19 15:39:33 +00001502 "DWARF 2 encodes return_address_register in one byte");
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001503 Streamer.EmitIntValue(RAReg, 1);
Oliver Stannardf7693f42014-06-19 15:39:33 +00001504 } else {
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001505 Streamer.EmitULEB128IntValue(RAReg);
Oliver Stannardf7693f42014-06-19 15:39:33 +00001506 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001507
1508 // Augmentation Data Length (optional)
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001509 unsigned augmentationLength = 0;
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001510 if (IsEH) {
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001511 if (Frame.Personality) {
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001512 // Personality Encoding
1513 augmentationLength += 1;
1514 // Personality
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001515 augmentationLength +=
1516 getSizeForEncoding(Streamer, Frame.PersonalityEncoding);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001517 }
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001518 if (Frame.Lsda)
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001519 augmentationLength += 1;
1520 // Encoding of the FDE pointers
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001521 augmentationLength += 1;
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001522
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001523 Streamer.EmitULEB128IntValue(augmentationLength);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001524
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001525 // Augmentation Data (optional)
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001526 if (Frame.Personality) {
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001527 // Personality Encoding
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001528 emitEncodingByte(Streamer, Frame.PersonalityEncoding);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001529 // Personality
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001530 EmitPersonality(Streamer, *Frame.Personality, Frame.PersonalityEncoding);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001531 }
Bill Wendling567a1ae2011-06-30 21:25:51 +00001532
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001533 if (Frame.Lsda)
1534 emitEncodingByte(Streamer, Frame.LsdaEncoding);
Bill Wendling567a1ae2011-06-30 21:25:51 +00001535
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001536 // Encoding of the FDE pointers
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001537 emitEncodingByte(Streamer, MOFI->getFDEEncoding());
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001538 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001539
1540 // Initial Instructions
1541
Bill Wendlingbc07a892013-06-18 07:20:20 +00001542 const MCAsmInfo *MAI = context.getAsmInfo();
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001543 if (!Frame.IsSimple) {
David Majnemere035cf92014-01-27 17:20:25 +00001544 const std::vector<MCCFIInstruction> &Instructions =
1545 MAI->getInitialFrameState();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001546 EmitCFIInstructions(Instructions, nullptr);
David Majnemere035cf92014-01-27 17:20:25 +00001547 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001548
Rafael Espindola8b4817b2015-03-24 21:47:31 +00001549 InitialCFAOffset = CFAOffset;
1550
Rafael Espindola0a017a62010-12-10 07:39:47 +00001551 // Padding
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001552 Streamer.EmitValueToAlignment(IsEH ? 4 : MAI->getCodePointerSize());
Rafael Espindola0a017a62010-12-10 07:39:47 +00001553
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001554 Streamer.EmitLabel(sectionEnd);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001555 return *sectionStart;
1556}
1557
Rafael Espindola46be4352015-11-06 03:02:51 +00001558void FrameEmitterImpl::EmitFDE(const MCSymbol &cieStart,
1559 const MCDwarfFrameInfo &frame,
Rafael Espindola97588e12015-11-06 13:14:59 +00001560 bool LastInSection,
1561 const MCSymbol &SectionStart) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001562 MCContext &context = Streamer.getContext();
Jim Grosbach6f482002015-05-18 18:43:14 +00001563 MCSymbol *fdeStart = context.createTempSymbol();
1564 MCSymbol *fdeEnd = context.createTempSymbol();
Evan Cheng76792992011-07-20 05:58:47 +00001565 const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
Rafael Espindola0a017a62010-12-10 07:39:47 +00001566
Rafael Espindola8b4817b2015-03-24 21:47:31 +00001567 CFAOffset = InitialCFAOffset;
1568
Rafael Espindola0a017a62010-12-10 07:39:47 +00001569 // Length
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001570 const MCExpr *Length = MakeStartMinusEndExpr(Streamer, *fdeStart, *fdeEnd, 0);
1571 emitAbsValue(Streamer, Length, 4);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001572
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001573 Streamer.EmitLabel(fdeStart);
Rafael Espindola99f67352011-05-10 20:59:42 +00001574
Rafael Espindola0a017a62010-12-10 07:39:47 +00001575 // CIE Pointer
Bill Wendlingbc07a892013-06-18 07:20:20 +00001576 const MCAsmInfo *asmInfo = context.getAsmInfo();
Rafael Espindola27390b42011-05-10 15:20:23 +00001577 if (IsEH) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001578 const MCExpr *offset =
1579 MakeStartMinusEndExpr(Streamer, cieStart, *fdeStart, 0);
1580 emitAbsValue(Streamer, offset, 4);
Bill Wendlingbc07a892013-06-18 07:20:20 +00001581 } else if (!asmInfo->doesDwarfUseRelocationsAcrossSections()) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001582 const MCExpr *offset =
Rafael Espindola97588e12015-11-06 13:14:59 +00001583 MakeStartMinusEndExpr(Streamer, SectionStart, cieStart, 0);
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001584 emitAbsValue(Streamer, offset, 4);
Rafael Espindola27390b42011-05-10 15:20:23 +00001585 } else {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001586 Streamer.EmitSymbolValue(&cieStart, 4);
Rafael Espindola27390b42011-05-10 15:20:23 +00001587 }
Bill Wendlingf166ab42011-06-30 22:02:20 +00001588
Rafael Espindola0a017a62010-12-10 07:39:47 +00001589 // PC Begin
Rafael Espindola01ee31b2014-05-12 13:40:49 +00001590 unsigned PCEncoding =
Rafael Espindolaaa7851d2014-05-12 13:47:05 +00001591 IsEH ? MOFI->getFDEEncoding() : (unsigned)dwarf::DW_EH_PE_absptr;
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001592 unsigned PCSize = getSizeForEncoding(Streamer, PCEncoding);
1593 emitFDESymbol(Streamer, *frame.Begin, PCEncoding, IsEH);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001594
1595 // PC Range
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001596 const MCExpr *Range =
1597 MakeStartMinusEndExpr(Streamer, *frame.Begin, *frame.End, 0);
1598 emitAbsValue(Streamer, Range, PCSize);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001599
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001600 if (IsEH) {
1601 // Augmentation Data Length
1602 unsigned augmentationLength = 0;
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001603
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001604 if (frame.Lsda)
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001605 augmentationLength += getSizeForEncoding(Streamer, frame.LsdaEncoding);
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001606
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001607 Streamer.EmitULEB128IntValue(augmentationLength);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001608
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001609 // Augmentation Data
1610 if (frame.Lsda)
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001611 emitFDESymbol(Streamer, *frame.Lsda, frame.LsdaEncoding, true);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001612 }
Rafael Espindola68067662011-04-29 03:06:29 +00001613
Rafael Espindola0a017a62010-12-10 07:39:47 +00001614 // Call Frame Instructions
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001615 EmitCFIInstructions(frame.Instructions, frame.Begin);
Rafael Espindolaa75b87b2010-12-28 04:15:37 +00001616
Rafael Espindola0a017a62010-12-10 07:39:47 +00001617 // Padding
Rafael Espindola46be4352015-11-06 03:02:51 +00001618 // The size of a .eh_frame section has to be a multiple of the alignment
1619 // since a null CIE is interpreted as the end. Old systems overaligned
1620 // .eh_frame, so we do too and account for it in the last FDE.
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001621 unsigned Align = LastInSection ? asmInfo->getCodePointerSize() : PCSize;
Rafael Espindola46be4352015-11-06 03:02:51 +00001622 Streamer.EmitValueToAlignment(Align);
Rafael Espindola32c74ea2010-12-17 00:28:02 +00001623
Rafael Espindola46be4352015-11-06 03:02:51 +00001624 Streamer.EmitLabel(fdeEnd);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001625}
1626
Benjamin Kramer570dd782010-12-30 22:34:44 +00001627namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001628
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001629struct CIEKey {
1630 static const CIEKey getEmptyKey() {
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001631 return CIEKey(nullptr, 0, -1, false, false, static_cast<unsigned>(INT_MAX));
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001632 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001633
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001634 static const CIEKey getTombstoneKey() {
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001635 return CIEKey(nullptr, -1, 0, false, false, static_cast<unsigned>(INT_MAX));
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001636 }
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001637
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001638 CIEKey(const MCSymbol *Personality, unsigned PersonalityEncoding,
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001639 unsigned LSDAEncoding, bool IsSignalFrame, bool IsSimple,
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001640 unsigned RAReg)
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001641 : Personality(Personality), PersonalityEncoding(PersonalityEncoding),
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001642 LsdaEncoding(LSDAEncoding), IsSignalFrame(IsSignalFrame),
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001643 IsSimple(IsSimple), RAReg(RAReg) {}
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001644
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001645 explicit CIEKey(const MCDwarfFrameInfo &Frame)
1646 : Personality(Frame.Personality),
1647 PersonalityEncoding(Frame.PersonalityEncoding),
1648 LsdaEncoding(Frame.LsdaEncoding), IsSignalFrame(Frame.IsSignalFrame),
1649 IsSimple(Frame.IsSimple), RAReg(Frame.RAReg) {}
1650
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001651 const MCSymbol *Personality;
1652 unsigned PersonalityEncoding;
1653 unsigned LsdaEncoding;
1654 bool IsSignalFrame;
1655 bool IsSimple;
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001656 unsigned RAReg;
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001657};
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001658
1659} // end anonymous namespace
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001660
1661namespace llvm {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001662
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001663template <> struct DenseMapInfo<CIEKey> {
1664 static CIEKey getEmptyKey() { return CIEKey::getEmptyKey(); }
1665 static CIEKey getTombstoneKey() { return CIEKey::getTombstoneKey(); }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001666
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001667 static unsigned getHashValue(const CIEKey &Key) {
1668 return static_cast<unsigned>(
1669 hash_combine(Key.Personality, Key.PersonalityEncoding, Key.LsdaEncoding,
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001670 Key.IsSignalFrame, Key.IsSimple, Key.RAReg));
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001671 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001672
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001673 static bool isEqual(const CIEKey &LHS, const CIEKey &RHS) {
1674 return LHS.Personality == RHS.Personality &&
1675 LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1676 LHS.LsdaEncoding == RHS.LsdaEncoding &&
1677 LHS.IsSignalFrame == RHS.IsSignalFrame &&
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001678 LHS.IsSimple == RHS.IsSimple &&
1679 LHS.RAReg == RHS.RAReg;
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001680 }
1681};
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001682
1683} // end namespace llvm
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001684
Rafael Espindola4066e8d2014-05-12 14:28:48 +00001685void MCDwarfFrameEmitter::Emit(MCObjectStreamer &Streamer, MCAsmBackend *MAB,
Rafael Espindola8285b772014-05-12 13:34:25 +00001686 bool IsEH) {
Bill Wendling550c76d2013-09-09 19:48:37 +00001687 Streamer.generateCompactUnwindEncodings(MAB);
1688
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001689 MCContext &Context = Streamer.getContext();
Bill Wendlinga800f952013-05-30 18:52:57 +00001690 const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001691 const MCAsmInfo *AsmInfo = Context.getAsmInfo();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001692 FrameEmitterImpl Emitter(IsEH, Streamer);
Saleem Abdulrasool3f3cefd2014-07-13 19:03:36 +00001693 ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getDwarfFrameInfos();
Bill Wendling4d9aa512011-07-22 21:18:59 +00001694
Bill Wendling9803abb2011-09-06 18:37:11 +00001695 // Emit the compact unwind info if available.
Tim Northoverd1c6f512014-03-29 09:03:13 +00001696 bool NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
Bill Wendling4e9fc022013-04-24 03:11:14 +00001697 if (IsEH && MOFI->getCompactUnwindSection()) {
Bill Wendling4e9fc022013-04-24 03:11:14 +00001698 bool SectionEmitted = false;
Benjamin Kramer7b4658f2016-06-26 14:49:00 +00001699 for (const MCDwarfFrameInfo &Frame : FrameArray) {
Bob Wilson0e180f22013-05-07 20:56:33 +00001700 if (Frame.CompactUnwindEncoding == 0) continue;
1701 if (!SectionEmitted) {
1702 Streamer.SwitchSection(MOFI->getCompactUnwindSection());
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001703 Streamer.EmitValueToAlignment(AsmInfo->getCodePointerSize());
Bob Wilson0e180f22013-05-07 20:56:33 +00001704 SectionEmitted = true;
Bill Wendling4e9fc022013-04-24 03:11:14 +00001705 }
Tim Northoverd1c6f512014-03-29 09:03:13 +00001706 NeedsEHFrameSection |=
1707 Frame.CompactUnwindEncoding ==
1708 MOFI->getCompactUnwindDwarfEHFrameOnly();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001709 Emitter.EmitCompactUnwind(Frame);
Bill Wendling4d9aa512011-07-22 21:18:59 +00001710 }
Bill Wendling4e9fc022013-04-24 03:11:14 +00001711 }
Bill Wendling4d9aa512011-07-22 21:18:59 +00001712
Tim Northoverd1c6f512014-03-29 09:03:13 +00001713 if (!NeedsEHFrameSection) return;
1714
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001715 MCSection &Section =
1716 IsEH ? *const_cast<MCObjectFileInfo *>(MOFI)->getEHFrameSection()
1717 : *MOFI->getDwarfFrameSection();
Tim Northoverd1c6f512014-03-29 09:03:13 +00001718
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001719 Streamer.SwitchSection(&Section);
Jim Grosbach6f482002015-05-18 18:43:14 +00001720 MCSymbol *SectionStart = Context.createTempSymbol();
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001721 Streamer.EmitLabel(SectionStart);
Rafael Espindola7c715152011-04-29 02:42:28 +00001722
Eric Christopherd29430d2014-06-19 20:00:09 +00001723 DenseMap<CIEKey, const MCSymbol *> CIEStarts;
Rafael Espindola9141b612010-12-26 20:20:31 +00001724
Craig Topperbb694de2014-04-13 04:57:38 +00001725 const MCSymbol *DummyDebugKey = nullptr;
Tim Northoverf8e47e42015-10-28 22:56:36 +00001726 bool CanOmitDwarf = MOFI->getOmitDwarfIfHaveCompactUnwind();
Rafael Espindola46be4352015-11-06 03:02:51 +00001727 for (auto I = FrameArray.begin(), E = FrameArray.end(); I != E;) {
1728 const MCDwarfFrameInfo &Frame = *I;
1729 ++I;
Tim Northoverf8e47e42015-10-28 22:56:36 +00001730 if (CanOmitDwarf && Frame.CompactUnwindEncoding !=
Tim Northoverd1c6f512014-03-29 09:03:13 +00001731 MOFI->getCompactUnwindDwarfEHFrameOnly())
1732 // Don't generate an EH frame if we don't need one. I.e., it's taken care
1733 // of by the compact unwind encoding.
1734 continue;
1735
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001736 CIEKey Key(Frame);
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001737 const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1738 if (!CIEStart)
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001739 CIEStart = &Emitter.EmitCIE(Frame);
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001740
Rafael Espindola97588e12015-11-06 13:14:59 +00001741 Emitter.EmitFDE(*CIEStart, Frame, I == E, *SectionStart);
Rafael Espindola32c74ea2010-12-17 00:28:02 +00001742 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001743}
Rafael Espindola736a35d2010-12-28 05:39:27 +00001744
Rafael Espindola4066e8d2014-05-12 14:28:48 +00001745void MCDwarfFrameEmitter::EmitAdvanceLoc(MCObjectStreamer &Streamer,
Rafael Espindola736a35d2010-12-28 05:39:27 +00001746 uint64_t AddrDelta) {
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001747 MCContext &Context = Streamer.getContext();
Alp Tokere69170a2014-06-26 22:52:05 +00001748 SmallString<256> Tmp;
1749 raw_svector_ostream OS(Tmp);
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001750 MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OS);
Eric Christophere3ab3d02013-01-09 01:57:54 +00001751 Streamer.EmitBytes(OS.str());
Rafael Espindola736a35d2010-12-28 05:39:27 +00001752}
1753
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001754void MCDwarfFrameEmitter::EncodeAdvanceLoc(MCContext &Context,
1755 uint64_t AddrDelta,
Rafael Espindolaab39c632011-05-08 14:35:21 +00001756 raw_ostream &OS) {
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001757 // Scale the address delta by the minimum instruction length.
1758 AddrDelta = ScaleAddrDelta(Context, AddrDelta);
1759
Rafael Espindola6bbfb6c2010-12-28 23:38:03 +00001760 if (AddrDelta == 0) {
Rafael Espindolaab39c632011-05-08 14:35:21 +00001761 } else if (isUIntN(6, AddrDelta)) {
Rafael Espindola736a35d2010-12-28 05:39:27 +00001762 uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1763 OS << Opcode;
Rafael Espindolaab39c632011-05-08 14:35:21 +00001764 } else if (isUInt<8>(AddrDelta)) {
Rafael Espindola736a35d2010-12-28 05:39:27 +00001765 OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1766 OS << uint8_t(AddrDelta);
Rafael Espindolaab39c632011-05-08 14:35:21 +00001767 } else if (isUInt<16>(AddrDelta)) {
Rafael Espindola736a35d2010-12-28 05:39:27 +00001768 OS << uint8_t(dwarf::DW_CFA_advance_loc2);
Benjamin Kramer58675d42015-06-17 15:14:35 +00001769 if (Context.getAsmInfo()->isLittleEndian())
1770 support::endian::Writer<support::little>(OS).write<uint16_t>(AddrDelta);
1771 else
1772 support::endian::Writer<support::big>(OS).write<uint16_t>(AddrDelta);
Rafael Espindola736a35d2010-12-28 05:39:27 +00001773 } else {
1774 assert(isUInt<32>(AddrDelta));
1775 OS << uint8_t(dwarf::DW_CFA_advance_loc4);
Benjamin Kramer58675d42015-06-17 15:14:35 +00001776 if (Context.getAsmInfo()->isLittleEndian())
1777 support::endian::Writer<support::little>(OS).write<uint32_t>(AddrDelta);
1778 else
1779 support::endian::Writer<support::big>(OS).write<uint32_t>(AddrDelta);
Rafael Espindola736a35d2010-12-28 05:39:27 +00001780 }
1781}