blob: 37e1263be65c22898b602b5849b3300427e28756 [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"
Scott Linder16c7bda2018-02-23 23:01:06 +000014#include "llvm/ADT/Optional.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
Paul Robinson7cb26ad2018-03-27 21:28:59 +0000260void MCDwarfDwoLineTable::Emit(MCStreamer &MCOS, MCDwarfLineTableParams Params,
261 MCSection *Section) const {
262 if (Header.MCDwarfFiles.empty())
263 return;
Paul Robinson1f900292018-02-06 20:29:21 +0000264 Optional<MCDwarfLineStr> NoLineStr(None);
Paul Robinson7cb26ad2018-03-27 21:28:59 +0000265 MCOS.SwitchSection(Section);
Paul Robinson1f900292018-02-06 20:29:21 +0000266 MCOS.EmitLabel(Header.Emit(&MCOS, Params, None, NoLineStr).second);
David Blaikie8287aff2014-03-18 02:13:23 +0000267}
268
Frederic Rissa5ab8442015-08-07 15:14:08 +0000269std::pair<MCSymbol *, MCSymbol *>
Paul Robinson1f900292018-02-06 20:29:21 +0000270MCDwarfLineTableHeader::Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params,
271 Optional<MCDwarfLineStr> &LineStr) const {
David Blaikie8287aff2014-03-18 02:13:23 +0000272 static const char StandardOpcodeLengths[] = {
273 0, // length of DW_LNS_copy
274 1, // length of DW_LNS_advance_pc
275 1, // length of DW_LNS_advance_line
276 1, // length of DW_LNS_set_file
277 1, // length of DW_LNS_set_column
278 0, // length of DW_LNS_negate_stmt
279 0, // length of DW_LNS_set_basic_block
280 0, // length of DW_LNS_const_add_pc
281 1, // length of DW_LNS_fixed_advance_pc
282 0, // length of DW_LNS_set_prologue_end
283 0, // length of DW_LNS_set_epilogue_begin
284 1 // DW_LNS_set_isa
285 };
Frederic Rissa5ab8442015-08-07 15:14:08 +0000286 assert(array_lengthof(StandardOpcodeLengths) >=
Aaron Ballmand8ac7de2015-08-10 15:22:39 +0000287 (Params.DWARF2LineOpcodeBase - 1U));
Paul Robinson1f900292018-02-06 20:29:21 +0000288 return Emit(
289 MCOS, Params,
290 makeArrayRef(StandardOpcodeLengths, Params.DWARF2LineOpcodeBase - 1),
291 LineStr);
David Blaikie8287aff2014-03-18 02:13:23 +0000292}
293
Rafael Espindolac23174b2014-08-15 15:12:13 +0000294static const MCExpr *forceExpAbs(MCStreamer &OS, const MCExpr* Expr) {
295 MCContext &Context = OS.getContext();
296 assert(!isa<MCSymbolRefExpr>(Expr));
297 if (Context.getAsmInfo()->hasAggressiveSymbolFolding())
298 return Expr;
299
Jim Grosbach6f482002015-05-18 18:43:14 +0000300 MCSymbol *ABS = Context.createTempSymbol();
Rafael Espindolac23174b2014-08-15 15:12:13 +0000301 OS.EmitAssignment(ABS, Expr);
Jim Grosbach13760bd2015-05-30 01:25:56 +0000302 return MCSymbolRefExpr::create(ABS, Context);
Rafael Espindolac23174b2014-08-15 15:12:13 +0000303}
304
305static void emitAbsValue(MCStreamer &OS, const MCExpr *Value, unsigned Size) {
306 const MCExpr *ABS = forceExpAbs(OS, Value);
307 OS.EmitValue(ABS, Size);
308}
309
Paul Robinson1f900292018-02-06 20:29:21 +0000310void MCDwarfLineStr::emitSection(MCStreamer *MCOS) {
311 // Switch to the .debug_line_str section.
312 MCOS->SwitchSection(
313 MCOS->getContext().getObjectFileInfo()->getDwarfLineStrSection());
314 // Emit the strings without perturbing the offsets we used.
315 LineStrings.finalizeInOrder();
316 SmallString<0> Data;
317 Data.resize(LineStrings.getSize());
318 LineStrings.write((uint8_t *)Data.data());
319 MCOS->EmitBinaryData(Data.str());
320}
321
322void MCDwarfLineStr::emitRef(MCStreamer *MCOS, StringRef Path) {
323 int RefSize = 4; // FIXME: Support DWARF-64
324 size_t Offset = LineStrings.add(Path);
325 if (UseRelocs) {
326 MCContext &Ctx = MCOS->getContext();
327 MCOS->EmitValue(makeStartPlusIntExpr(Ctx, *LineStrLabel, Offset), RefSize);
328 } else
329 MCOS->EmitIntValue(Offset, RefSize);
330}
331
Paul Robinson2bf8f492018-01-30 21:39:28 +0000332void MCDwarfLineTableHeader::emitV2FileDirTables(MCStreamer *MCOS) const {
Paul Robinson795ab0d2017-12-05 20:35:00 +0000333 // First the directory table.
Paul Robinson2bf8f492018-01-30 21:39:28 +0000334 for (auto &Dir : MCDwarfDirs) {
Paul Robinson795ab0d2017-12-05 20:35:00 +0000335 MCOS->EmitBytes(Dir); // The DirectoryName, and...
336 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
337 }
338 MCOS->EmitIntValue(0, 1); // Terminate the directory list.
339
340 // Second the file table.
341 for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
342 assert(!MCDwarfFiles[i].Name.empty());
343 MCOS->EmitBytes(MCDwarfFiles[i].Name); // FileName and...
344 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
345 MCOS->EmitULEB128IntValue(MCDwarfFiles[i].DirIndex); // Directory number.
346 MCOS->EmitIntValue(0, 1); // Last modification timestamp (always 0).
347 MCOS->EmitIntValue(0, 1); // File size (always 0).
348 }
349 MCOS->EmitIntValue(0, 1); // Terminate the file list.
350}
351
Paul Robinsonb271f312018-03-29 17:16:41 +0000352static void emitOneV5FileEntry(MCStreamer *MCOS, const MCDwarfFile &DwarfFile,
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000353 bool EmitMD5, bool HasSource,
Paul Robinsonb271f312018-03-29 17:16:41 +0000354 Optional<MCDwarfLineStr> &LineStr) {
355 assert(!DwarfFile.Name.empty());
356 if (LineStr)
357 LineStr->emitRef(MCOS, DwarfFile.Name);
358 else {
359 MCOS->EmitBytes(DwarfFile.Name); // FileName and...
360 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
361 }
362 MCOS->EmitULEB128IntValue(DwarfFile.DirIndex); // Directory number.
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000363 if (EmitMD5) {
Paul Robinsonb271f312018-03-29 17:16:41 +0000364 MD5::MD5Result *Cksum = DwarfFile.Checksum;
365 MCOS->EmitBinaryData(
366 StringRef(reinterpret_cast<const char *>(Cksum->Bytes.data()),
367 Cksum->Bytes.size()));
368 }
369 if (HasSource) {
370 if (LineStr)
371 LineStr->emitRef(MCOS, DwarfFile.Source.getValueOr(StringRef()));
372 else {
373 MCOS->EmitBytes(
374 DwarfFile.Source.getValueOr(StringRef())); // Source and...
375 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
376 }
377 }
378}
379
Paul Robinson1f900292018-02-06 20:29:21 +0000380void MCDwarfLineTableHeader::emitV5FileDirTables(
Paul Robinsonf69316c2018-06-12 16:09:03 +0000381 MCStreamer *MCOS, Optional<MCDwarfLineStr> &LineStr,
382 StringRef CtxCompilationDir) const {
Paul Robinson1f900292018-02-06 20:29:21 +0000383 // The directory format, which is just a list of the directory paths. In a
384 // non-split object, these are references to .debug_line_str; in a split
385 // object, they are inline strings.
Paul Robinson795ab0d2017-12-05 20:35:00 +0000386 MCOS->EmitIntValue(1, 1);
387 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_path);
Paul Robinson1f900292018-02-06 20:29:21 +0000388 MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
389 : dwarf::DW_FORM_string);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000390 MCOS->EmitULEB128IntValue(MCDwarfDirs.size() + 1);
Paul Robinsonf69316c2018-06-12 16:09:03 +0000391 // Try not to emit an empty compilation directory.
Paul Robinson8e3e3742018-06-20 17:08:46 +0000392 const StringRef CompDir =
393 CompilationDir.empty() ? CtxCompilationDir : StringRef(CompilationDir);
Paul Robinson1f900292018-02-06 20:29:21 +0000394 if (LineStr) {
395 // Record path strings, emit references here.
Paul Robinsonf69316c2018-06-12 16:09:03 +0000396 LineStr->emitRef(MCOS, CompDir);
Paul Robinson1f900292018-02-06 20:29:21 +0000397 for (auto &Dir : MCDwarfDirs)
398 LineStr->emitRef(MCOS, Dir);
399 } else {
Paul Robinsonf69316c2018-06-12 16:09:03 +0000400 // The list of directory paths. Compilation directory comes first.
401 MCOS->EmitBytes(CompDir);
Paul Robinson1f900292018-02-06 20:29:21 +0000402 MCOS->EmitBytes(StringRef("\0", 1));
403 for (auto &Dir : MCDwarfDirs) {
404 MCOS->EmitBytes(Dir); // The DirectoryName, and...
405 MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
406 }
Paul Robinson795ab0d2017-12-05 20:35:00 +0000407 }
408
409 // The file format, which is the inline null-terminated filename and a
410 // directory index. We don't track file size/timestamp so don't emit them
Scott Linder16c7bda2018-02-23 23:01:06 +0000411 // in the v5 table. Emit MD5 checksums and source if we have them.
412 uint64_t Entries = 2;
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000413 if (HasAllMD5)
Scott Linder16c7bda2018-02-23 23:01:06 +0000414 Entries += 1;
415 if (HasSource)
416 Entries += 1;
417 MCOS->EmitIntValue(Entries, 1);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000418 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_path);
Paul Robinson1f900292018-02-06 20:29:21 +0000419 MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
420 : dwarf::DW_FORM_string);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000421 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_directory_index);
422 MCOS->EmitULEB128IntValue(dwarf::DW_FORM_udata);
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000423 if (HasAllMD5) {
Paul Robinson29f5f982018-01-09 23:31:48 +0000424 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_MD5);
425 MCOS->EmitULEB128IntValue(dwarf::DW_FORM_data16);
426 }
Scott Linder16c7bda2018-02-23 23:01:06 +0000427 if (HasSource) {
428 MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_LLVM_source);
429 MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
430 : dwarf::DW_FORM_string);
431 }
Paul Robinsonb271f312018-03-29 17:16:41 +0000432 // Then the counted list of files. The root file is file #0, then emit the
Paul Robinsonf69316c2018-06-12 16:09:03 +0000433 // files as provide by .file directives. To accommodate assembler source
434 // written for DWARF v4 but trying to emit v5, if we didn't see a root file
435 // explicitly, replicate file #1.
Paul Robinsonb271f312018-03-29 17:16:41 +0000436 MCOS->EmitULEB128IntValue(MCDwarfFiles.size());
Paul Robinsonf69316c2018-06-12 16:09:03 +0000437 emitOneV5FileEntry(MCOS, RootFile.Name.empty() ? MCDwarfFiles[1] : RootFile,
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000438 HasAllMD5, HasSource, LineStr);
Paul Robinsonb271f312018-03-29 17:16:41 +0000439 for (unsigned i = 1; i < MCDwarfFiles.size(); ++i)
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000440 emitOneV5FileEntry(MCOS, MCDwarfFiles[i], HasAllMD5, HasSource, LineStr);
Paul Robinson795ab0d2017-12-05 20:35:00 +0000441}
442
David Blaikie8287aff2014-03-18 02:13:23 +0000443std::pair<MCSymbol *, MCSymbol *>
Frederic Rissa5ab8442015-08-07 15:14:08 +0000444MCDwarfLineTableHeader::Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params,
Paul Robinson1f900292018-02-06 20:29:21 +0000445 ArrayRef<char> StandardOpcodeLengths,
446 Optional<MCDwarfLineStr> &LineStr) const {
Manman Ren4e042a62013-02-05 21:52:47 +0000447 MCContext &context = MCOS->getContext();
448
449 // Create a symbol at the beginning of the line table.
David Blaikie11765bc2014-03-13 17:55:28 +0000450 MCSymbol *LineStartSym = Label;
Manman Ren4e042a62013-02-05 21:52:47 +0000451 if (!LineStartSym)
Jim Grosbach6f482002015-05-18 18:43:14 +0000452 LineStartSym = context.createTempSymbol();
Manman Ren4e042a62013-02-05 21:52:47 +0000453 // Set the value of the symbol, as we are at the start of the line table.
Kevin Enderbye46564a2010-09-30 16:52:03 +0000454 MCOS->EmitLabel(LineStartSym);
455
456 // Create a symbol for the end of the section (to be set when we get there).
Jim Grosbach6f482002015-05-18 18:43:14 +0000457 MCSymbol *LineEndSym = context.createTempSymbol();
Kevin Enderbye46564a2010-09-30 16:52:03 +0000458
459 // The first 4 bytes is the total length of the information for this
460 // compilation unit (not including these 4 bytes for the length).
Rafael Espindolac23174b2014-08-15 15:12:13 +0000461 emitAbsValue(*MCOS,
462 MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym, 4), 4);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000463
Paul Robinson68ba7722017-12-04 21:27:46 +0000464 // Next 2 bytes is the Version.
Davide Italiano23b3f6d2017-12-07 00:57:25 +0000465 // FIXME: On Darwin we still default to V2.
Paul Robinson68ba7722017-12-04 21:27:46 +0000466 unsigned LineTableVersion = context.getDwarfVersion();
Davide Italiano23b3f6d2017-12-07 00:57:25 +0000467 if (context.getObjectFileInfo()->getTargetTriple().isOSDarwin())
468 LineTableVersion = 2;
Paul Robinson68ba7722017-12-04 21:27:46 +0000469 MCOS->EmitIntValue(LineTableVersion, 2);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000470
Paul Robinson795ab0d2017-12-05 20:35:00 +0000471 // Keep track of the bytes between the very start and where the header length
472 // comes out.
473 unsigned PreHeaderLengthBytes = 4 + 2;
474
475 // In v5, we get address info next.
476 if (LineTableVersion >= 5) {
477 MCOS->EmitIntValue(context.getAsmInfo()->getCodePointerSize(), 1);
478 MCOS->EmitIntValue(0, 1); // Segment selector; same as EmitGenDwarfAranges.
479 PreHeaderLengthBytes += 2;
480 }
481
Kevin Enderbye46564a2010-09-30 16:52:03 +0000482 // Create a symbol for the end of the prologue (to be set when we get there).
Jim Grosbach6f482002015-05-18 18:43:14 +0000483 MCSymbol *ProEndSym = context.createTempSymbol(); // Lprologue_end
Kevin Enderbye46564a2010-09-30 16:52:03 +0000484
Paul Robinson795ab0d2017-12-05 20:35:00 +0000485 // Length of the prologue, is the next 4 bytes. This is actually the length
486 // from after the length word, to the end of the prologue.
487 emitAbsValue(*MCOS,
488 MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
489 (PreHeaderLengthBytes + 4)),
490 4);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000491
492 // Parameters of the state machine, are next.
Bill Wendlingbc07a892013-06-18 07:20:20 +0000493 MCOS->EmitIntValue(context.getAsmInfo()->getMinInstAlignment(), 1);
Paul Robinson68ba7722017-12-04 21:27:46 +0000494 // maximum_operations_per_instruction
495 // For non-VLIW architectures this field is always 1.
496 // FIXME: VLIW architectures need to update this field accordingly.
Paul Robinson795ab0d2017-12-05 20:35:00 +0000497 if (LineTableVersion >= 4)
Paul Robinson68ba7722017-12-04 21:27:46 +0000498 MCOS->EmitIntValue(1, 1);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000499 MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
Frederic Rissa5ab8442015-08-07 15:14:08 +0000500 MCOS->EmitIntValue(Params.DWARF2LineBase, 1);
501 MCOS->EmitIntValue(Params.DWARF2LineRange, 1);
David Blaikie8287aff2014-03-18 02:13:23 +0000502 MCOS->EmitIntValue(StandardOpcodeLengths.size() + 1, 1);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000503
504 // Standard opcode lengths
David Blaikie8287aff2014-03-18 02:13:23 +0000505 for (char Length : StandardOpcodeLengths)
506 MCOS->EmitIntValue(Length, 1);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000507
Paul Robinson795ab0d2017-12-05 20:35:00 +0000508 // Put out the directory and file tables. The formats vary depending on
509 // the version.
510 if (LineTableVersion >= 5)
Paul Robinsonf69316c2018-06-12 16:09:03 +0000511 emitV5FileDirTables(MCOS, LineStr, context.getCompilationDir());
Paul Robinson795ab0d2017-12-05 20:35:00 +0000512 else
Paul Robinson2bf8f492018-01-30 21:39:28 +0000513 emitV2FileDirTables(MCOS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000514
515 // This is the end of the prologue, so set the value of the symbol at the
516 // end of the prologue (that was used in a previous expression).
517 MCOS->EmitLabel(ProEndSym);
518
David Blaikie5cff0e62014-03-13 21:47:12 +0000519 return std::make_pair(LineStartSym, LineEndSym);
520}
521
Frederic Rissa5ab8442015-08-07 15:14:08 +0000522void MCDwarfLineTable::EmitCU(MCObjectStreamer *MCOS,
Paul Robinson1f900292018-02-06 20:29:21 +0000523 MCDwarfLineTableParams Params,
524 Optional<MCDwarfLineStr> &LineStr) const {
525 MCSymbol *LineEndSym = Header.Emit(MCOS, Params, LineStr).second;
David Blaikie5cff0e62014-03-13 21:47:12 +0000526
Kevin Enderbye46564a2010-09-30 16:52:03 +0000527 // Put out the line tables.
David Blaikie11765bc2014-03-13 17:55:28 +0000528 for (const auto &LineSec : MCLineSections.getMCLineEntries())
529 EmitDwarfLineTable(MCOS, LineSec.first, LineSec.second);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000530
Kevin Enderbye46564a2010-09-30 16:52:03 +0000531 // This is the end of the section, so set the value of the symbol at the end
532 // of this section (that was used in a previous expression).
533 MCOS->EmitLabel(LineEndSym);
534}
535
Paul Robinson70def122018-02-22 21:03:33 +0000536Expected<unsigned> MCDwarfLineTable::tryGetFile(StringRef &Directory,
537 StringRef &FileName,
538 MD5::MD5Result *Checksum,
Scott Linder16c7bda2018-02-23 23:01:06 +0000539 Optional<StringRef> Source,
Paul Robinson70def122018-02-22 21:03:33 +0000540 unsigned FileNumber) {
Scott Linder16c7bda2018-02-23 23:01:06 +0000541 return Header.tryGetFile(Directory, FileName, Checksum, Source, FileNumber);
David Blaikie5cff0e62014-03-13 21:47:12 +0000542}
543
Scott Linder16c7bda2018-02-23 23:01:06 +0000544Expected<unsigned>
545MCDwarfLineTableHeader::tryGetFile(StringRef &Directory,
546 StringRef &FileName,
547 MD5::MD5Result *Checksum,
548 Optional<StringRef> &Source,
549 unsigned FileNumber) {
David Blaikiec7f29dc2014-03-17 23:29:40 +0000550 if (Directory == CompilationDir)
551 Directory = "";
David Blaikiec2df16b2014-03-17 18:13:58 +0000552 if (FileName.empty()) {
553 FileName = "<stdin>";
554 Directory = "";
555 }
556 assert(!FileName.empty());
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000557 // Keep track of whether any or all files have an MD5 checksum.
558 // If any files have embedded source, they all must.
Scott Linder16c7bda2018-02-23 23:01:06 +0000559 if (MCDwarfFiles.empty()) {
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000560 trackMD5Usage(Checksum);
Scott Linder16c7bda2018-02-23 23:01:06 +0000561 HasSource = (Source != None);
562 }
David Blaikiec714ef42014-03-17 01:52:11 +0000563 if (FileNumber == 0) {
Adrian Prantld6cc53f2016-03-09 17:32:56 +0000564 // File numbers start with 1 and/or after any file numbers
565 // allocated by inline-assembler .file directives.
566 FileNumber = MCDwarfFiles.empty() ? 1 : MCDwarfFiles.size();
Pete Cooperb7800812015-05-20 19:12:14 +0000567 SmallString<256> Buffer;
David Blaikie5106ce72014-11-19 05:49:42 +0000568 auto IterBool = SourceIdMap.insert(
Pete Cooperb7800812015-05-20 19:12:14 +0000569 std::make_pair((Directory + Twine('\0') + FileName).toStringRef(Buffer),
570 FileNumber));
David Blaikie5106ce72014-11-19 05:49:42 +0000571 if (!IterBool.second)
572 return IterBool.first->second;
David Blaikiec714ef42014-03-17 01:52:11 +0000573 }
David Blaikie498589c2014-03-13 19:15:04 +0000574 // Make space for this FileNumber in the MCDwarfFiles vector if needed.
Paul Robinsona1cedd62017-12-14 18:46:43 +0000575 if (FileNumber >= MCDwarfFiles.size())
576 MCDwarfFiles.resize(FileNumber + 1);
David Blaikie498589c2014-03-13 19:15:04 +0000577
578 // Get the new MCDwarfFile slot for this FileNumber.
579 MCDwarfFile &File = MCDwarfFiles[FileNumber];
580
Paul Robinson70def122018-02-22 21:03:33 +0000581 // It is an error to see the same number more than once.
David Blaikie498589c2014-03-13 19:15:04 +0000582 if (!File.Name.empty())
Paul Robinson70def122018-02-22 21:03:33 +0000583 return make_error<StringError>("file number already allocated",
584 inconvertibleErrorCode());
David Blaikie498589c2014-03-13 19:15:04 +0000585
Scott Linder16c7bda2018-02-23 23:01:06 +0000586 // If any files have embedded source, they all must.
587 if (HasSource != (Source != None))
588 return make_error<StringError>("inconsistent use of embedded source",
589 inconvertibleErrorCode());
Paul Robinson29f5f982018-01-09 23:31:48 +0000590
David Blaikie498589c2014-03-13 19:15:04 +0000591 if (Directory.empty()) {
592 // Separate the directory part from the basename of the FileName.
593 StringRef tFileName = sys::path::filename(FileName);
594 if (!tFileName.empty()) {
595 Directory = sys::path::parent_path(FileName);
596 if (!Directory.empty())
597 FileName = tFileName;
598 }
599 }
600
601 // Find or make an entry in the MCDwarfDirs vector for this Directory.
602 // Capture directory name.
603 unsigned DirIndex;
604 if (Directory.empty()) {
605 // For FileNames with no directories a DirIndex of 0 is used.
606 DirIndex = 0;
607 } else {
608 DirIndex = 0;
609 for (unsigned End = MCDwarfDirs.size(); DirIndex < End; DirIndex++) {
610 if (Directory == MCDwarfDirs[DirIndex])
611 break;
612 }
613 if (DirIndex >= MCDwarfDirs.size())
614 MCDwarfDirs.push_back(Directory);
615 // The DirIndex is one based, as DirIndex of 0 is used for FileNames with
616 // no directories. MCDwarfDirs[] is unlike MCDwarfFiles[] in that the
617 // directory names are stored at MCDwarfDirs[DirIndex-1] where FileNames
618 // are stored at MCDwarfFiles[FileNumber].Name .
619 DirIndex++;
620 }
621
622 File.Name = FileName;
623 File.DirIndex = DirIndex;
Paul Robinson29f5f982018-01-09 23:31:48 +0000624 File.Checksum = Checksum;
Paul Robinsoncc7344a2018-06-14 13:38:20 +0000625 trackMD5Usage(Checksum);
Scott Linder16c7bda2018-02-23 23:01:06 +0000626 File.Source = Source;
627 if (Source)
628 HasSource = true;
David Blaikie498589c2014-03-13 19:15:04 +0000629
630 // return the allocated FileNumber.
631 return FileNumber;
632}
633
Kevin Enderbye46564a2010-09-30 16:52:03 +0000634/// Utility function to emit the encoding to a streamer.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000635void MCDwarfLineAddr::Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params,
636 int64_t LineDelta, uint64_t AddrDelta) {
Ulrich Weigand32d725b2013-06-12 14:46:54 +0000637 MCContext &Context = MCOS->getContext();
Alp Tokere69170a2014-06-26 22:52:05 +0000638 SmallString<256> Tmp;
639 raw_svector_ostream OS(Tmp);
Frederic Rissa5ab8442015-08-07 15:14:08 +0000640 MCDwarfLineAddr::Encode(Context, Params, LineDelta, AddrDelta, OS);
Eric Christophere3ab3d02013-01-09 01:57:54 +0000641 MCOS->EmitBytes(OS.str());
Kevin Enderbye46564a2010-09-30 16:52:03 +0000642}
643
Frederic Rissa5ab8442015-08-07 15:14:08 +0000644/// Given a special op, return the address skip amount (in units of
645/// DWARF2_LINE_MIN_INSN_LENGTH).
646static uint64_t SpecialAddr(MCDwarfLineTableParams Params, uint64_t op) {
647 return (op - Params.DWARF2LineOpcodeBase) / Params.DWARF2LineRange;
648}
649
Kevin Enderbye46564a2010-09-30 16:52:03 +0000650/// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000651void MCDwarfLineAddr::Encode(MCContext &Context, MCDwarfLineTableParams Params,
652 int64_t LineDelta, uint64_t AddrDelta,
653 raw_ostream &OS) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000654 uint64_t Temp, Opcode;
655 bool NeedCopy = false;
656
Frederic Rissa5ab8442015-08-07 15:14:08 +0000657 // The maximum address skip amount that can be encoded with a special op.
658 uint64_t MaxSpecialAddrDelta = SpecialAddr(Params, 255);
659
Kevin Enderbye46564a2010-09-30 16:52:03 +0000660 // Scale the address delta by the minimum instruction length.
Ulrich Weigand32d725b2013-06-12 14:46:54 +0000661 AddrDelta = ScaleAddrDelta(Context, AddrDelta);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000662
663 // A LineDelta of INT64_MAX is a signal that this is actually a
Jim Grosbachdc1e36e2012-05-11 01:41:30 +0000664 // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
Kevin Enderbye46564a2010-09-30 16:52:03 +0000665 // end_sequence to emit the matrix entry.
666 if (LineDelta == INT64_MAX) {
Frederic Rissa5ab8442015-08-07 15:14:08 +0000667 if (AddrDelta == MaxSpecialAddrDelta)
Kevin Enderbye46564a2010-09-30 16:52:03 +0000668 OS << char(dwarf::DW_LNS_const_add_pc);
Frederic Rissceb18362015-03-15 20:45:39 +0000669 else if (AddrDelta) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000670 OS << char(dwarf::DW_LNS_advance_pc);
Jim Grosbachbf387df2012-08-08 23:56:06 +0000671 encodeULEB128(AddrDelta, OS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000672 }
673 OS << char(dwarf::DW_LNS_extended_op);
674 OS << char(1);
675 OS << char(dwarf::DW_LNE_end_sequence);
676 return;
677 }
678
679 // Bias the line delta by the base.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000680 Temp = LineDelta - Params.DWARF2LineBase;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000681
682 // If the line increment is out of range of a special opcode, we must encode
683 // it with DW_LNS_advance_line.
Frederic Risse5b78d82016-01-31 22:06:35 +0000684 if (Temp >= Params.DWARF2LineRange ||
685 Temp + Params.DWARF2LineOpcodeBase > 255) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000686 OS << char(dwarf::DW_LNS_advance_line);
Jim Grosbachbf387df2012-08-08 23:56:06 +0000687 encodeSLEB128(LineDelta, OS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000688
689 LineDelta = 0;
Frederic Rissa5ab8442015-08-07 15:14:08 +0000690 Temp = 0 - Params.DWARF2LineBase;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000691 NeedCopy = true;
692 }
693
694 // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
695 if (LineDelta == 0 && AddrDelta == 0) {
696 OS << char(dwarf::DW_LNS_copy);
697 return;
698 }
699
700 // Bias the opcode by the special opcode base.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000701 Temp += Params.DWARF2LineOpcodeBase;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000702
703 // Avoid overflow when addr_delta is large.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000704 if (AddrDelta < 256 + MaxSpecialAddrDelta) {
Kevin Enderbye46564a2010-09-30 16:52:03 +0000705 // Try using a special opcode.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000706 Opcode = Temp + AddrDelta * Params.DWARF2LineRange;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000707 if (Opcode <= 255) {
708 OS << char(Opcode);
709 return;
710 }
711
712 // Try using DW_LNS_const_add_pc followed by special op.
Frederic Rissa5ab8442015-08-07 15:14:08 +0000713 Opcode = Temp + (AddrDelta - MaxSpecialAddrDelta) * Params.DWARF2LineRange;
Kevin Enderbye46564a2010-09-30 16:52:03 +0000714 if (Opcode <= 255) {
715 OS << char(dwarf::DW_LNS_const_add_pc);
716 OS << char(Opcode);
717 return;
718 }
719 }
720
721 // Otherwise use DW_LNS_advance_pc.
722 OS << char(dwarf::DW_LNS_advance_pc);
Jim Grosbachbf387df2012-08-08 23:56:06 +0000723 encodeULEB128(AddrDelta, OS);
Kevin Enderbye46564a2010-09-30 16:52:03 +0000724
725 if (NeedCopy)
726 OS << char(dwarf::DW_LNS_copy);
Frederic Risse5b78d82016-01-31 22:06:35 +0000727 else {
728 assert(Temp <= 255 && "Buggy special opcode encoding.");
Kevin Enderbye46564a2010-09-30 16:52:03 +0000729 OS << char(Temp);
Frederic Risse5b78d82016-01-31 22:06:35 +0000730 }
Kevin Enderbye46564a2010-09-30 16:52:03 +0000731}
732
Kevin Enderbye7739d42011-12-09 18:09:40 +0000733// Utility function to write a tuple for .debug_abbrev.
734static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form) {
735 MCOS->EmitULEB128IntValue(Name);
736 MCOS->EmitULEB128IntValue(Form);
737}
738
739// When generating dwarf for assembly source files this emits
740// the data for .debug_abbrev section which contains three DIEs.
741static void EmitGenDwarfAbbrev(MCStreamer *MCOS) {
742 MCContext &context = MCOS->getContext();
743 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
744
745 // DW_TAG_compile_unit DIE abbrev (1).
746 MCOS->EmitULEB128IntValue(1);
747 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_compile_unit);
748 MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
Paul Robinsone95fa422016-01-04 18:49:15 +0000749 EmitAbbrev(MCOS, dwarf::DW_AT_stmt_list, context.getDwarfVersion() >= 4
750 ? dwarf::DW_FORM_sec_offset
751 : dwarf::DW_FORM_data4);
Paul Robinson22d0d312015-12-23 01:57:31 +0000752 if (context.getGenDwarfSectionSyms().size() > 1 &&
753 context.getDwarfVersion() >= 3) {
Paul Robinsone95fa422016-01-04 18:49:15 +0000754 EmitAbbrev(MCOS, dwarf::DW_AT_ranges, context.getDwarfVersion() >= 4
755 ? dwarf::DW_FORM_sec_offset
Paul Robinson22d0d312015-12-23 01:57:31 +0000756 : dwarf::DW_FORM_data4);
Oliver Stannard8b273082014-06-19 15:52:37 +0000757 } else {
758 EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
759 EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
760 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000761 EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
Andrew Trick32591d32013-12-10 04:39:09 +0000762 if (!context.getCompilationDir().empty())
763 EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000764 StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
765 if (!DwarfDebugFlags.empty())
766 EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
767 EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
768 EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
769 EmitAbbrev(MCOS, 0, 0);
770
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000771 // DW_TAG_label DIE abbrev (2).
Kevin Enderbye7739d42011-12-09 18:09:40 +0000772 MCOS->EmitULEB128IntValue(2);
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000773 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_label);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000774 MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
775 EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
776 EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
777 EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
778 EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000779 EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
780 EmitAbbrev(MCOS, 0, 0);
781
782 // DW_TAG_unspecified_parameters DIE abbrev (3).
783 MCOS->EmitULEB128IntValue(3);
784 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
785 MCOS->EmitIntValue(dwarf::DW_CHILDREN_no, 1);
786 EmitAbbrev(MCOS, 0, 0);
787
788 // Terminate the abbreviations for this compilation unit.
789 MCOS->EmitIntValue(0, 1);
790}
791
792// When generating dwarf for assembly source files this emits the data for
Oliver Stannard8b273082014-06-19 15:52:37 +0000793// .debug_aranges section. This section contains a header and a table of pairs
794// of PointerSize'ed values for the address and size of section(s) with line
795// table entries.
Alexey Samsonov00fd5252012-11-14 09:55:38 +0000796static void EmitGenDwarfAranges(MCStreamer *MCOS,
797 const MCSymbol *InfoSectionSymbol) {
Kevin Enderbye7739d42011-12-09 18:09:40 +0000798 MCContext &context = MCOS->getContext();
799
Oliver Stannard8b273082014-06-19 15:52:37 +0000800 auto &Sections = context.getGenDwarfSectionSyms();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000801
802 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
803
804 // This will be the length of the .debug_aranges section, first account for
805 // the size of each item in the header (see below where we emit these items).
806 int Length = 4 + 2 + 4 + 1 + 1;
807
808 // Figure the padding after the header before the table of address and size
809 // pairs who's values are PointerSize'ed.
Bill Wendlingbc07a892013-06-18 07:20:20 +0000810 const MCAsmInfo *asmInfo = context.getAsmInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000811 int AddrSize = asmInfo->getCodePointerSize();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000812 int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
813 if (Pad == 2 * AddrSize)
814 Pad = 0;
815 Length += Pad;
816
817 // Add the size of the pair of PointerSize'ed values for the address and size
Oliver Stannard8b273082014-06-19 15:52:37 +0000818 // of each section we have in the table.
819 Length += 2 * AddrSize * Sections.size();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000820 // And the pair of terminating zeros.
821 Length += 2 * AddrSize;
822
Kevin Enderbye7739d42011-12-09 18:09:40 +0000823 // Emit the header for this section.
824 // The 4 byte length not including the 4 byte value for the length.
825 MCOS->EmitIntValue(Length - 4, 4);
826 // The 2 byte version, which is 2.
827 MCOS->EmitIntValue(2, 2);
828 // The 4 byte offset to the compile unit in the .debug_info from the start
Alexey Samsonov00fd5252012-11-14 09:55:38 +0000829 // of the .debug_info.
830 if (InfoSectionSymbol)
Saleem Abdulrasoolfcefa212014-09-06 19:57:48 +0000831 MCOS->EmitSymbolValue(InfoSectionSymbol, 4,
832 asmInfo->needsDwarfSectionOffsetDirective());
Alexey Samsonov00fd5252012-11-14 09:55:38 +0000833 else
834 MCOS->EmitIntValue(0, 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000835 // The 1 byte size of an address.
836 MCOS->EmitIntValue(AddrSize, 1);
837 // The 1 byte size of a segment descriptor, we use a value of zero.
838 MCOS->EmitIntValue(0, 1);
839 // Align the header with the padding if needed, before we put out the table.
840 for(int i = 0; i < Pad; i++)
841 MCOS->EmitIntValue(0, 1);
842
Oliver Stannard8b273082014-06-19 15:52:37 +0000843 // Now emit the table of pairs of PointerSize'ed values for the section
844 // addresses and sizes.
Rafael Espindola0709a7b2015-05-21 19:20:38 +0000845 for (MCSection *Sec : Sections) {
846 const MCSymbol *StartSymbol = Sec->getBeginSymbol();
Rafael Espindolae0746792015-05-21 16:52:32 +0000847 MCSymbol *EndSymbol = Sec->getEndSymbol(context);
Oliver Stannard8b273082014-06-19 15:52:37 +0000848 assert(StartSymbol && "StartSymbol must not be NULL");
849 assert(EndSymbol && "EndSymbol must not be NULL");
850
Jim Grosbach13760bd2015-05-30 01:25:56 +0000851 const MCExpr *Addr = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +0000852 StartSymbol, MCSymbolRefExpr::VK_None, context);
853 const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
854 *StartSymbol, *EndSymbol, 0);
855 MCOS->EmitValue(Addr, AddrSize);
Rafael Espindolac23174b2014-08-15 15:12:13 +0000856 emitAbsValue(*MCOS, Size, AddrSize);
Oliver Stannard8b273082014-06-19 15:52:37 +0000857 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000858
859 // And finally the pair of terminating zeros.
860 MCOS->EmitIntValue(0, AddrSize);
861 MCOS->EmitIntValue(0, AddrSize);
862}
863
864// When generating dwarf for assembly source files this emits the data for
865// .debug_info section which contains three parts. The header, the compile_unit
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000866// DIE and a list of label DIEs.
Rafael Espindolac22c85c2012-02-28 21:13:05 +0000867static void EmitGenDwarfInfo(MCStreamer *MCOS,
868 const MCSymbol *AbbrevSectionSymbol,
Oliver Stannard8b273082014-06-19 15:52:37 +0000869 const MCSymbol *LineSectionSymbol,
870 const MCSymbol *RangesSectionSymbol) {
Kevin Enderbye7739d42011-12-09 18:09:40 +0000871 MCContext &context = MCOS->getContext();
872
Jim Grosbachdc1e36e2012-05-11 01:41:30 +0000873 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
Kevin Enderbye7739d42011-12-09 18:09:40 +0000874
875 // Create a symbol at the start and end of this section used in here for the
876 // expression to calculate the length in the header.
Jim Grosbach6f482002015-05-18 18:43:14 +0000877 MCSymbol *InfoStart = context.createTempSymbol();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000878 MCOS->EmitLabel(InfoStart);
Jim Grosbach6f482002015-05-18 18:43:14 +0000879 MCSymbol *InfoEnd = context.createTempSymbol();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000880
881 // First part: the header.
882
883 // The 4 byte total length of the information for this compilation unit, not
884 // including these 4 bytes.
885 const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
Rafael Espindolac23174b2014-08-15 15:12:13 +0000886 emitAbsValue(*MCOS, Length, 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000887
Oliver Stannard7eacbd52014-05-01 08:46:02 +0000888 // The 2 byte DWARF version.
889 MCOS->EmitIntValue(context.getDwarfVersion(), 2);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000890
Paul Robinsondccb4fe2017-02-28 23:40:46 +0000891 // The DWARF v5 header has unit type, address size, abbrev offset.
892 // Earlier versions have abbrev offset, address size.
Saleem Abdulrasool00426d92014-07-19 21:01:58 +0000893 const MCAsmInfo &AsmInfo = *context.getAsmInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +0000894 int AddrSize = AsmInfo.getCodePointerSize();
Paul Robinsondccb4fe2017-02-28 23:40:46 +0000895 if (context.getDwarfVersion() >= 5) {
896 MCOS->EmitIntValue(dwarf::DW_UT_compile, 1);
897 MCOS->EmitIntValue(AddrSize, 1);
898 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000899 // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
900 // it is at the start of that section so this is zero.
Saleem Abdulrasool7d095302014-07-17 16:27:44 +0000901 if (AbbrevSectionSymbol == nullptr)
Rafael Espindolac22c85c2012-02-28 21:13:05 +0000902 MCOS->EmitIntValue(0, 4);
Saleem Abdulrasool7d095302014-07-17 16:27:44 +0000903 else
Saleem Abdulrasool00426d92014-07-19 21:01:58 +0000904 MCOS->EmitSymbolValue(AbbrevSectionSymbol, 4,
905 AsmInfo.needsDwarfSectionOffsetDirective());
Paul Robinsondccb4fe2017-02-28 23:40:46 +0000906 if (context.getDwarfVersion() <= 4)
907 MCOS->EmitIntValue(AddrSize, 1);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000908
909 // Second part: the compile_unit DIE.
910
911 // The DW_TAG_compile_unit DIE abbrev (1).
912 MCOS->EmitULEB128IntValue(1);
913
914 // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
915 // which is at the start of that section so this is zero.
Saleem Abdulrasool5c70de12014-09-05 04:15:00 +0000916 if (LineSectionSymbol)
917 MCOS->EmitSymbolValue(LineSectionSymbol, 4,
918 AsmInfo.needsDwarfSectionOffsetDirective());
919 else
Rafael Espindolac22c85c2012-02-28 21:13:05 +0000920 MCOS->EmitIntValue(0, 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000921
Oliver Stannard8b273082014-06-19 15:52:37 +0000922 if (RangesSectionSymbol) {
923 // There are multiple sections containing code, so we must use the
924 // .debug_ranges sections.
Kevin Enderbye7739d42011-12-09 18:09:40 +0000925
Oliver Stannard8b273082014-06-19 15:52:37 +0000926 // AT_ranges, the 4 byte offset from the start of the .debug_ranges section
927 // to the address range list for this compilation unit.
928 MCOS->EmitSymbolValue(RangesSectionSymbol, 4);
929 } else {
930 // If we only have one non-empty code section, we can use the simpler
931 // AT_low_pc and AT_high_pc attributes.
932
933 // Find the first (and only) non-empty text section
934 auto &Sections = context.getGenDwarfSectionSyms();
935 const auto TextSection = Sections.begin();
936 assert(TextSection != Sections.end() && "No text section found");
937
Rafael Espindolae0746792015-05-21 16:52:32 +0000938 MCSymbol *StartSymbol = (*TextSection)->getBeginSymbol();
939 MCSymbol *EndSymbol = (*TextSection)->getEndSymbol(context);
Oliver Stannard8b273082014-06-19 15:52:37 +0000940 assert(StartSymbol && "StartSymbol must not be NULL");
941 assert(EndSymbol && "EndSymbol must not be NULL");
942
943 // AT_low_pc, the first address of the default .text section.
Jim Grosbach13760bd2015-05-30 01:25:56 +0000944 const MCExpr *Start = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +0000945 StartSymbol, MCSymbolRefExpr::VK_None, context);
946 MCOS->EmitValue(Start, AddrSize);
947
948 // AT_high_pc, the last address of the default .text section.
Jim Grosbach13760bd2015-05-30 01:25:56 +0000949 const MCExpr *End = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +0000950 EndSymbol, MCSymbolRefExpr::VK_None, context);
951 MCOS->EmitValue(End, AddrSize);
952 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000953
954 // AT_name, the name of the source file. Reconstruct from the first directory
955 // and file table entries.
David Blaikie533490de2014-03-13 19:05:33 +0000956 const SmallVectorImpl<std::string> &MCDwarfDirs = context.getMCDwarfDirs();
Kevin Enderbye7739d42011-12-09 18:09:40 +0000957 if (MCDwarfDirs.size() > 0) {
Eric Christophere3ab3d02013-01-09 01:57:54 +0000958 MCOS->EmitBytes(MCDwarfDirs[0]);
Yaron Keren15217202014-05-16 13:16:30 +0000959 MCOS->EmitBytes(sys::path::get_separator());
Kevin Enderbye7739d42011-12-09 18:09:40 +0000960 }
David Blaikiea55ddad2014-03-13 18:55:04 +0000961 const SmallVectorImpl<MCDwarfFile> &MCDwarfFiles =
Kevin Enderbye7739d42011-12-09 18:09:40 +0000962 MCOS->getContext().getMCDwarfFiles();
David Blaikiea55ddad2014-03-13 18:55:04 +0000963 MCOS->EmitBytes(MCDwarfFiles[1].Name);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000964 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
965
966 // AT_comp_dir, the working directory the assembly was done in.
Andrew Trick32591d32013-12-10 04:39:09 +0000967 if (!context.getCompilationDir().empty()) {
968 MCOS->EmitBytes(context.getCompilationDir());
969 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
970 }
Kevin Enderbye7739d42011-12-09 18:09:40 +0000971
972 // AT_APPLE_flags, the command line arguments of the assembler tool.
973 StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
974 if (!DwarfDebugFlags.empty()){
Eric Christophere3ab3d02013-01-09 01:57:54 +0000975 MCOS->EmitBytes(DwarfDebugFlags);
Kevin Enderbye7739d42011-12-09 18:09:40 +0000976 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
977 }
978
979 // AT_producer, the version of the assembler tool.
Kevin Enderbye82ada62013-01-16 17:46:23 +0000980 StringRef DwarfDebugProducer = context.getDwarfDebugProducer();
Saleem Abdulrasool19f8bc62014-07-17 16:27:35 +0000981 if (!DwarfDebugProducer.empty())
Kevin Enderbye82ada62013-01-16 17:46:23 +0000982 MCOS->EmitBytes(DwarfDebugProducer);
Saleem Abdulrasool19f8bc62014-07-17 16:27:35 +0000983 else
984 MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM " PACKAGE_VERSION ")"));
Kevin Enderbye7739d42011-12-09 18:09:40 +0000985 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
986
987 // AT_language, a 4 byte value. We use DW_LANG_Mips_Assembler as the dwarf2
988 // draft has no standard code for assembler.
989 MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
990
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000991 // Third part: the list of label DIEs.
Kevin Enderbye7739d42011-12-09 18:09:40 +0000992
Kevin Enderbyf7d77062012-01-10 21:12:34 +0000993 // Loop on saved info for dwarf labels and create the DIEs for them.
David Blaikie1e0fc8f2014-04-11 00:43:52 +0000994 const std::vector<MCGenDwarfLabelEntry> &Entries =
995 MCOS->getContext().getMCGenDwarfLabelEntries();
996 for (const auto &Entry : Entries) {
Kevin Enderby8d4a2202012-01-10 17:52:29 +0000997 // The DW_TAG_label DIE abbrev (2).
Kevin Enderbye7739d42011-12-09 18:09:40 +0000998 MCOS->EmitULEB128IntValue(2);
999
1000 // AT_name, of the label without any leading underbar.
David Blaikie1e0fc8f2014-04-11 00:43:52 +00001001 MCOS->EmitBytes(Entry.getName());
Kevin Enderbye7739d42011-12-09 18:09:40 +00001002 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
1003
1004 // AT_decl_file, index into the file table.
David Blaikie1e0fc8f2014-04-11 00:43:52 +00001005 MCOS->EmitIntValue(Entry.getFileNumber(), 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001006
1007 // AT_decl_line, source line number.
David Blaikie1e0fc8f2014-04-11 00:43:52 +00001008 MCOS->EmitIntValue(Entry.getLineNumber(), 4);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001009
1010 // AT_low_pc, start address of the label.
Jim Grosbach13760bd2015-05-30 01:25:56 +00001011 const MCExpr *AT_low_pc = MCSymbolRefExpr::create(Entry.getLabel(),
Kevin Enderbye7739d42011-12-09 18:09:40 +00001012 MCSymbolRefExpr::VK_None, context);
Rafael Espindola98629c42014-03-20 21:26:38 +00001013 MCOS->EmitValue(AT_low_pc, AddrSize);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001014
Kevin Enderbye7739d42011-12-09 18:09:40 +00001015 // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
1016 MCOS->EmitIntValue(0, 1);
1017
1018 // The DW_TAG_unspecified_parameters DIE abbrev (3).
1019 MCOS->EmitULEB128IntValue(3);
1020
1021 // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
1022 MCOS->EmitIntValue(0, 1);
1023 }
Kevin Enderbye7739d42011-12-09 18:09:40 +00001024
1025 // Add the NULL DIE terminating the Compile Unit DIE's.
1026 MCOS->EmitIntValue(0, 1);
1027
1028 // Now set the value of the symbol at the end of the info section.
1029 MCOS->EmitLabel(InfoEnd);
1030}
1031
Oliver Stannard8b273082014-06-19 15:52:37 +00001032// When generating dwarf for assembly source files this emits the data for
1033// .debug_ranges section. We only emit one range list, which spans all of the
1034// executable sections of this file.
1035static void EmitGenDwarfRanges(MCStreamer *MCOS) {
1036 MCContext &context = MCOS->getContext();
1037 auto &Sections = context.getGenDwarfSectionSyms();
1038
1039 const MCAsmInfo *AsmInfo = context.getAsmInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001040 int AddrSize = AsmInfo->getCodePointerSize();
Oliver Stannard8b273082014-06-19 15:52:37 +00001041
1042 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
1043
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001044 for (MCSection *Sec : Sections) {
1045 const MCSymbol *StartSymbol = Sec->getBeginSymbol();
Rafael Espindolae0746792015-05-21 16:52:32 +00001046 MCSymbol *EndSymbol = Sec->getEndSymbol(context);
Oliver Stannard8b273082014-06-19 15:52:37 +00001047 assert(StartSymbol && "StartSymbol must not be NULL");
1048 assert(EndSymbol && "EndSymbol must not be NULL");
1049
1050 // Emit a base address selection entry for the start of this section
Jim Grosbach13760bd2015-05-30 01:25:56 +00001051 const MCExpr *SectionStartAddr = MCSymbolRefExpr::create(
Oliver Stannard8b273082014-06-19 15:52:37 +00001052 StartSymbol, MCSymbolRefExpr::VK_None, context);
Petr Hosekfaef3202016-06-01 01:59:58 +00001053 MCOS->emitFill(AddrSize, 0xFF);
Oliver Stannard8b273082014-06-19 15:52:37 +00001054 MCOS->EmitValue(SectionStartAddr, AddrSize);
1055
1056 // Emit a range list entry spanning this section
1057 const MCExpr *SectionSize = MakeStartMinusEndExpr(*MCOS,
1058 *StartSymbol, *EndSymbol, 0);
1059 MCOS->EmitIntValue(0, AddrSize);
Rafael Espindolac23174b2014-08-15 15:12:13 +00001060 emitAbsValue(*MCOS, SectionSize, AddrSize);
Oliver Stannard8b273082014-06-19 15:52:37 +00001061 }
1062
1063 // Emit end of list entry
1064 MCOS->EmitIntValue(0, AddrSize);
1065 MCOS->EmitIntValue(0, AddrSize);
1066}
1067
Kevin Enderbye7739d42011-12-09 18:09:40 +00001068//
1069// When generating dwarf for assembly source files this emits the Dwarf
1070// sections.
1071//
David Blaikie8bf66c42014-04-01 07:35:52 +00001072void MCGenDwarfInfo::Emit(MCStreamer *MCOS) {
Kevin Enderbye7739d42011-12-09 18:09:40 +00001073 MCContext &context = MCOS->getContext();
Oliver Stannard8b273082014-06-19 15:52:37 +00001074
1075 // Create the dwarf sections in this order (.debug_line already created).
Bill Wendlingbc07a892013-06-18 07:20:20 +00001076 const MCAsmInfo *AsmInfo = context.getAsmInfo();
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001077 bool CreateDwarfSectionSymbols =
Bill Wendlingbc07a892013-06-18 07:20:20 +00001078 AsmInfo->doesDwarfUseRelocationsAcrossSections();
David Blaikie8bf66c42014-04-01 07:35:52 +00001079 MCSymbol *LineSectionSymbol = nullptr;
David Blaikie34641612014-04-01 08:07:52 +00001080 if (CreateDwarfSectionSymbols)
1081 LineSectionSymbol = MCOS->getDwarfLineTableSymbol(0);
Craig Topperbb694de2014-04-13 04:57:38 +00001082 MCSymbol *AbbrevSectionSymbol = nullptr;
1083 MCSymbol *InfoSectionSymbol = nullptr;
Hans Wennborg083ca9b2015-10-06 23:24:35 +00001084 MCSymbol *RangesSectionSymbol = nullptr;
Oliver Stannard8b273082014-06-19 15:52:37 +00001085
1086 // Create end symbols for each section, and remove empty sections
1087 MCOS->getContext().finalizeDwarfSections(*MCOS);
1088
1089 // If there are no sections to generate debug info for, we don't need
1090 // to do anything
1091 if (MCOS->getContext().getGenDwarfSectionSyms().empty())
1092 return;
1093
Oliver Stannard14f97d02014-09-22 10:45:16 +00001094 // We only use the .debug_ranges section if we have multiple code sections,
1095 // and we are emitting a DWARF version which supports it.
Oliver Stannard8b273082014-06-19 15:52:37 +00001096 const bool UseRangesSection =
Oliver Stannard14f97d02014-09-22 10:45:16 +00001097 MCOS->getContext().getGenDwarfSectionSyms().size() > 1 &&
1098 MCOS->getContext().getDwarfVersion() >= 3;
Oliver Stannard8b273082014-06-19 15:52:37 +00001099 CreateDwarfSectionSymbols |= UseRangesSection;
1100
Kevin Enderbye7739d42011-12-09 18:09:40 +00001101 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001102 if (CreateDwarfSectionSymbols) {
Jim Grosbach6f482002015-05-18 18:43:14 +00001103 InfoSectionSymbol = context.createTempSymbol();
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001104 MCOS->EmitLabel(InfoSectionSymbol);
1105 }
Kevin Enderbye7739d42011-12-09 18:09:40 +00001106 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001107 if (CreateDwarfSectionSymbols) {
Jim Grosbach6f482002015-05-18 18:43:14 +00001108 AbbrevSectionSymbol = context.createTempSymbol();
Rafael Espindolac22c85c2012-02-28 21:13:05 +00001109 MCOS->EmitLabel(AbbrevSectionSymbol);
Rafael Espindolac22c85c2012-02-28 21:13:05 +00001110 }
Oliver Stannard8b273082014-06-19 15:52:37 +00001111 if (UseRangesSection) {
1112 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
1113 if (CreateDwarfSectionSymbols) {
Jim Grosbach6f482002015-05-18 18:43:14 +00001114 RangesSectionSymbol = context.createTempSymbol();
Oliver Stannard8b273082014-06-19 15:52:37 +00001115 MCOS->EmitLabel(RangesSectionSymbol);
1116 }
1117 }
Kevin Enderbye7739d42011-12-09 18:09:40 +00001118
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001119 assert((RangesSectionSymbol != nullptr) || !UseRangesSection);
Oliver Stannard8b273082014-06-19 15:52:37 +00001120
1121 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
Kevin Enderbye7739d42011-12-09 18:09:40 +00001122
1123 // Output the data for .debug_aranges section.
Alexey Samsonov00fd5252012-11-14 09:55:38 +00001124 EmitGenDwarfAranges(MCOS, InfoSectionSymbol);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001125
Oliver Stannard8b273082014-06-19 15:52:37 +00001126 if (UseRangesSection)
1127 EmitGenDwarfRanges(MCOS);
1128
Kevin Enderbye7739d42011-12-09 18:09:40 +00001129 // Output the data for .debug_abbrev section.
1130 EmitGenDwarfAbbrev(MCOS);
1131
1132 // Output the data for .debug_info section.
Oliver Stannard8b273082014-06-19 15:52:37 +00001133 EmitGenDwarfInfo(MCOS, AbbrevSectionSymbol, LineSectionSymbol,
1134 RangesSectionSymbol);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001135}
1136
1137//
1138// When generating dwarf for assembly source files this is called when symbol
1139// for a label is created. If this symbol is not a temporary and is in the
1140// section that dwarf is being generated for, save the needed info to create
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001141// a dwarf label.
Kevin Enderbye7739d42011-12-09 18:09:40 +00001142//
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001143void MCGenDwarfLabelEntry::Make(MCSymbol *Symbol, MCStreamer *MCOS,
Kevin Enderbye7739d42011-12-09 18:09:40 +00001144 SourceMgr &SrcMgr, SMLoc &Loc) {
Oliver Stannard8b273082014-06-19 15:52:37 +00001145 // We won't create dwarf labels for temporary symbols.
Kevin Enderbye7739d42011-12-09 18:09:40 +00001146 if (Symbol->isTemporary())
1147 return;
1148 MCContext &context = MCOS->getContext();
Oliver Stannard8b273082014-06-19 15:52:37 +00001149 // We won't create dwarf labels for symbols in sections that we are not
1150 // generating debug info for.
Eric Christopher445c9522016-10-14 05:47:37 +00001151 if (!context.getGenDwarfSectionSyms().count(MCOS->getCurrentSectionOnly()))
Kevin Enderbye7739d42011-12-09 18:09:40 +00001152 return;
1153
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001154 // The dwarf label's name does not have the symbol name's leading
Kevin Enderbye7739d42011-12-09 18:09:40 +00001155 // underbar if any.
1156 StringRef Name = Symbol->getName();
1157 if (Name.startswith("_"))
1158 Name = Name.substr(1, Name.size()-1);
1159
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001160 // Get the dwarf file number to be used for the dwarf label.
Kevin Enderbye7739d42011-12-09 18:09:40 +00001161 unsigned FileNumber = context.getGenDwarfFileNumber();
1162
1163 // Finding the line number is the expensive part which is why we just don't
Kevin Enderbyf7d77062012-01-10 21:12:34 +00001164 // pass it in as for some symbols we won't create a dwarf label.
Alp Tokera55b95b2014-07-06 10:33:31 +00001165 unsigned CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
Kevin Enderbye7739d42011-12-09 18:09:40 +00001166 unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
1167
1168 // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
1169 // values so that they don't have things like an ARM thumb bit from the
1170 // original symbol. So when used they won't get a low bit set after
1171 // relocation.
Jim Grosbach6f482002015-05-18 18:43:14 +00001172 MCSymbol *Label = context.createTempSymbol();
Kevin Enderbye7739d42011-12-09 18:09:40 +00001173 MCOS->EmitLabel(Label);
1174
1175 // Create and entry for the info and add it to the other entries.
David Blaikie1e0fc8f2014-04-11 00:43:52 +00001176 MCOS->getContext().addMCGenDwarfLabelEntry(
1177 MCGenDwarfLabelEntry(Name, FileNumber, LineNumber, Label));
Kevin Enderbye7739d42011-12-09 18:09:40 +00001178}
1179
Rafael Espindola0a017a62010-12-10 07:39:47 +00001180static int getDataAlignmentFactor(MCStreamer &streamer) {
1181 MCContext &context = streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001182 const MCAsmInfo *asmInfo = context.getAsmInfo();
1183 int size = asmInfo->getCalleeSaveStackSlotSize();
1184 if (asmInfo->isStackGrowthDirectionUp())
Rafael Espindola0a017a62010-12-10 07:39:47 +00001185 return size;
Evan Chenga83b37a2011-07-15 02:09:41 +00001186 else
1187 return -size;
Rafael Espindola0a017a62010-12-10 07:39:47 +00001188}
1189
Rafael Espindola5395f442011-04-22 00:08:43 +00001190static unsigned getSizeForEncoding(MCStreamer &streamer,
1191 unsigned symbolEncoding) {
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001192 MCContext &context = streamer.getContext();
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001193 unsigned format = symbolEncoding & 0x0f;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001194 switch (format) {
Craig Toppera2886c22012-02-07 05:05:23 +00001195 default: llvm_unreachable("Unknown Encoding");
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001196 case dwarf::DW_EH_PE_absptr:
1197 case dwarf::DW_EH_PE_signed:
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001198 return context.getAsmInfo()->getCodePointerSize();
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001199 case dwarf::DW_EH_PE_udata2:
1200 case dwarf::DW_EH_PE_sdata2:
Rafael Espindola5395f442011-04-22 00:08:43 +00001201 return 2;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001202 case dwarf::DW_EH_PE_udata4:
1203 case dwarf::DW_EH_PE_sdata4:
Rafael Espindola5395f442011-04-22 00:08:43 +00001204 return 4;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001205 case dwarf::DW_EH_PE_udata8:
1206 case dwarf::DW_EH_PE_sdata8:
Rafael Espindola5395f442011-04-22 00:08:43 +00001207 return 8;
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001208 }
Rafael Espindola5395f442011-04-22 00:08:43 +00001209}
1210
Rafael Espindolafe963b12014-08-15 03:07:13 +00001211static void emitFDESymbol(MCObjectStreamer &streamer, const MCSymbol &symbol,
1212 unsigned symbolEncoding, bool isEH) {
Rafael Espindola6bd6a702011-04-28 21:04:39 +00001213 MCContext &context = streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001214 const MCAsmInfo *asmInfo = context.getAsmInfo();
1215 const MCExpr *v = asmInfo->getExprForFDESymbol(&symbol,
1216 symbolEncoding,
1217 streamer);
Rafael Espindola5395f442011-04-22 00:08:43 +00001218 unsigned size = getSizeForEncoding(streamer, symbolEncoding);
Iain Sandoe618def62014-01-08 10:22:54 +00001219 if (asmInfo->doDwarfFDESymbolsUseAbsDiff() && isEH)
Rafael Espindolac23174b2014-08-15 15:12:13 +00001220 emitAbsValue(streamer, v, size);
Iain Sandoe618def62014-01-08 10:22:54 +00001221 else
1222 streamer.EmitValue(v, size);
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001223}
1224
Rafael Espindolac5dac4d2011-04-28 16:09:09 +00001225static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
1226 unsigned symbolEncoding) {
1227 MCContext &context = streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001228 const MCAsmInfo *asmInfo = context.getAsmInfo();
1229 const MCExpr *v = asmInfo->getExprForPersonalitySymbol(&symbol,
1230 symbolEncoding,
1231 streamer);
Rafael Espindolac5dac4d2011-04-28 16:09:09 +00001232 unsigned size = getSizeForEncoding(streamer, symbolEncoding);
Rafael Espindolafd057852011-05-01 03:50:49 +00001233 streamer.EmitValue(v, size);
Rafael Espindolac5dac4d2011-04-28 16:09:09 +00001234}
1235
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001236namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001237
Rafael Espindola68c21652015-11-05 23:54:18 +00001238class FrameEmitterImpl {
Rafael Espindolaa1d960e2015-11-05 23:55:51 +00001239 int CFAOffset = 0;
1240 int InitialCFAOffset = 0;
Rafael Espindola68c21652015-11-05 23:54:18 +00001241 bool IsEH;
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001242 MCObjectStreamer &Streamer;
Bill Wendling4d9aa512011-07-22 21:18:59 +00001243
Rafael Espindola68c21652015-11-05 23:54:18 +00001244public:
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001245 FrameEmitterImpl(bool IsEH, MCObjectStreamer &Streamer)
1246 : IsEH(IsEH), Streamer(Streamer) {}
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001247
Rafael Espindola68c21652015-11-05 23:54:18 +00001248 /// Emit the unwind information in a compact way.
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001249 void EmitCompactUnwind(const MCDwarfFrameInfo &frame);
Rafael Espindola68c21652015-11-05 23:54:18 +00001250
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001251 const MCSymbol &EmitCIE(const MCDwarfFrameInfo &F);
Rafael Espindola46be4352015-11-06 03:02:51 +00001252 void EmitFDE(const MCSymbol &cieStart, const MCDwarfFrameInfo &frame,
Rafael Espindola97588e12015-11-06 13:14:59 +00001253 bool LastInSection, const MCSymbol &SectionStart);
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001254 void EmitCFIInstructions(ArrayRef<MCCFIInstruction> Instrs,
Rafael Espindola68c21652015-11-05 23:54:18 +00001255 MCSymbol *BaseLabel);
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001256 void EmitCFIInstruction(const MCCFIInstruction &Instr);
Rafael Espindola68c21652015-11-05 23:54:18 +00001257};
Bill Wendling567a1ae2011-06-30 21:25:51 +00001258
1259} // end anonymous namespace
1260
Rafael Espindolafe963b12014-08-15 03:07:13 +00001261static void emitEncodingByte(MCObjectStreamer &Streamer, unsigned Encoding) {
Bill Wendling567a1ae2011-06-30 21:25:51 +00001262 Streamer.EmitIntValue(Encoding, 1);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001263}
1264
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001265void FrameEmitterImpl::EmitCFIInstruction(const MCCFIInstruction &Instr) {
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001266 int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001267 auto *MRI = Streamer.getContext().getRegisterInfo();
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001268
1269 switch (Instr.getOperation()) {
Rafael Espindolacdb9a532012-11-25 15:14:49 +00001270 case MCCFIInstruction::OpRegister: {
1271 unsigned Reg1 = Instr.getRegister();
1272 unsigned Reg2 = Instr.getRegister2();
Frederic Rissadbb3f22015-02-26 19:48:07 +00001273 if (!IsEH) {
Jake Ehrlich3da79822017-12-01 21:44:27 +00001274 Reg1 = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg1);
1275 Reg2 = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg2);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001276 }
Rafael Espindolacdb9a532012-11-25 15:14:49 +00001277 Streamer.EmitIntValue(dwarf::DW_CFA_register, 1);
1278 Streamer.EmitULEB128IntValue(Reg1);
1279 Streamer.EmitULEB128IntValue(Reg2);
1280 return;
1281 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001282 case MCCFIInstruction::OpWindowSave:
Venkatraman Govindaraju3816d432013-09-26 14:49:40 +00001283 Streamer.EmitIntValue(dwarf::DW_CFA_GNU_window_save, 1);
1284 return;
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001285
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001286 case MCCFIInstruction::OpUndefined: {
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001287 unsigned Reg = Instr.getRegister();
Rafael Espindola9bb24782012-11-23 16:59:41 +00001288 Streamer.EmitIntValue(dwarf::DW_CFA_undefined, 1);
1289 Streamer.EmitULEB128IntValue(Reg);
1290 return;
1291 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001292 case MCCFIInstruction::OpAdjustCfaOffset:
1293 case MCCFIInstruction::OpDefCfaOffset: {
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001294 const bool IsRelative =
1295 Instr.getOperation() == MCCFIInstruction::OpAdjustCfaOffset;
1296
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001297 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
1298
1299 if (IsRelative)
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001300 CFAOffset += Instr.getOffset();
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001301 else
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001302 CFAOffset = -Instr.getOffset();
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001303
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001304 Streamer.EmitULEB128IntValue(CFAOffset);
1305
1306 return;
1307 }
1308 case MCCFIInstruction::OpDefCfa: {
Frederic Rissadbb3f22015-02-26 19:48:07 +00001309 unsigned Reg = Instr.getRegister();
1310 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001311 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001312 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001313 Streamer.EmitULEB128IntValue(Reg);
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001314 CFAOffset = -Instr.getOffset();
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001315 Streamer.EmitULEB128IntValue(CFAOffset);
1316
1317 return;
1318 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001319 case MCCFIInstruction::OpDefCfaRegister: {
Frederic Rissadbb3f22015-02-26 19:48:07 +00001320 unsigned Reg = Instr.getRegister();
1321 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001322 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001323 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001324 Streamer.EmitULEB128IntValue(Reg);
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001325
1326 return;
1327 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001328 case MCCFIInstruction::OpOffset:
1329 case MCCFIInstruction::OpRelOffset: {
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001330 const bool IsRelative =
1331 Instr.getOperation() == MCCFIInstruction::OpRelOffset;
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001332
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001333 unsigned Reg = Instr.getRegister();
Frederic Rissadbb3f22015-02-26 19:48:07 +00001334 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001335 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Frederic Rissadbb3f22015-02-26 19:48:07 +00001336
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001337 int Offset = Instr.getOffset();
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001338 if (IsRelative)
1339 Offset -= CFAOffset;
1340 Offset = Offset / dataAlignmentFactor;
1341
1342 if (Offset < 0) {
1343 Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
1344 Streamer.EmitULEB128IntValue(Reg);
1345 Streamer.EmitSLEB128IntValue(Offset);
1346 } else if (Reg < 64) {
1347 Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
Rafael Espindolaea61f222011-04-21 23:26:40 +00001348 Streamer.EmitULEB128IntValue(Offset);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001349 } else {
1350 Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
Rafael Espindolaea61f222011-04-21 23:26:40 +00001351 Streamer.EmitULEB128IntValue(Reg);
1352 Streamer.EmitULEB128IntValue(Offset);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001353 }
1354 return;
1355 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001356 case MCCFIInstruction::OpRememberState:
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001357 Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
1358 return;
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001359 case MCCFIInstruction::OpRestoreState:
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001360 Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
1361 return;
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001362 case MCCFIInstruction::OpSameValue: {
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001363 unsigned Reg = Instr.getRegister();
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001364 Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
Rafael Espindola6aea5922011-04-21 23:39:26 +00001365 Streamer.EmitULEB128IntValue(Reg);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001366 return;
1367 }
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001368 case MCCFIInstruction::OpRestore: {
Rafael Espindolacc0c74a2012-11-24 04:33:48 +00001369 unsigned Reg = Instr.getRegister();
Frederic Rissadbb3f22015-02-26 19:48:07 +00001370 if (!IsEH)
Jake Ehrlich3da79822017-12-01 21:44:27 +00001371 Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
Rafael Espindola4ea99812011-12-29 21:43:03 +00001372 Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
1373 return;
1374 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001375 case MCCFIInstruction::OpGnuArgsSize:
Michael Kuperstein259f1502015-10-07 07:01:31 +00001376 Streamer.EmitIntValue(dwarf::DW_CFA_GNU_args_size, 1);
1377 Streamer.EmitULEB128IntValue(Instr.getOffset());
1378 return;
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001379
Rafael Espindola5dce65b2012-11-24 03:10:54 +00001380 case MCCFIInstruction::OpEscape:
Eric Christophere3ab3d02013-01-09 01:57:54 +00001381 Streamer.EmitBytes(Instr.getValues());
Rafael Espindolaef4aa352011-12-29 20:24:47 +00001382 return;
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001383 }
1384 llvm_unreachable("Unhandled case in switch");
1385}
1386
Rafael Espindolafe963b12014-08-15 03:07:13 +00001387/// Emit frame instructions to describe the layout of the frame.
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001388void FrameEmitterImpl::EmitCFIInstructions(ArrayRef<MCCFIInstruction> Instrs,
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001389 MCSymbol *BaseLabel) {
Benjamin Kramer7b4658f2016-06-26 14:49:00 +00001390 for (const MCCFIInstruction &Instr : Instrs) {
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001391 MCSymbol *Label = Instr.getLabel();
1392 // Throw out move if the label is invalid.
1393 if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1394
1395 // Advance row if new location.
1396 if (BaseLabel && Label) {
1397 MCSymbol *ThisSym = Label;
1398 if (ThisSym != BaseLabel) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001399 Streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001400 BaseLabel = ThisSym;
1401 }
1402 }
1403
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001404 EmitCFIInstruction(Instr);
Rafael Espindola1ec0f462011-04-12 16:12:03 +00001405 }
1406}
1407
Rafael Espindolafe963b12014-08-15 03:07:13 +00001408/// Emit the unwind information in a compact way.
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001409void FrameEmitterImpl::EmitCompactUnwind(const MCDwarfFrameInfo &Frame) {
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001410 MCContext &Context = Streamer.getContext();
Evan Cheng76792992011-07-20 05:58:47 +00001411 const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001412
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001413 // range-start range-length compact-unwind-enc personality-func lsda
1414 // _foo LfooEnd-_foo 0x00000023 0 0
1415 // _bar LbarEnd-_bar 0x00000025 __gxx_personality except_tab1
1416 //
1417 // .section __LD,__compact_unwind,regular,debug
1418 //
1419 // # compact unwind for _foo
1420 // .quad _foo
1421 // .set L1,LfooEnd-_foo
1422 // .long L1
1423 // .long 0x01010001
1424 // .quad 0
1425 // .quad 0
1426 //
1427 // # compact unwind for _bar
1428 // .quad _bar
1429 // .set L2,LbarEnd-_bar
1430 // .long L2
1431 // .long 0x01020011
1432 // .quad __gxx_personality
1433 // .quad except_tab1
1434
Bill Wendling49bc6802011-07-19 00:06:12 +00001435 uint32_t Encoding = Frame.CompactUnwindEncoding;
Bill Wendling99bce5f2013-04-18 23:16:46 +00001436 if (!Encoding) return;
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001437 bool DwarfEHFrameOnly = (Encoding == MOFI->getCompactUnwindDwarfEHFrameOnly());
Bill Wendlingb6adf462011-07-07 00:54:13 +00001438
Bill Wendlingdafd5982011-07-14 23:34:45 +00001439 // The encoding needs to know we have an LSDA.
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001440 if (!DwarfEHFrameOnly && Frame.Lsda)
Bill Wendlingdafd5982011-07-14 23:34:45 +00001441 Encoding |= 0x40000000;
1442
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001443 // Range Start
Rafael Espindolaaa7851d2014-05-12 13:47:05 +00001444 unsigned FDEEncoding = MOFI->getFDEEncoding();
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001445 unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
Rafael Espindola88604822014-06-23 15:34:32 +00001446 Streamer.EmitSymbolValue(Frame.Begin, Size);
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001447
1448 // Range Length
1449 const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1450 *Frame.End, 0);
Rafael Espindolac23174b2014-08-15 15:12:13 +00001451 emitAbsValue(Streamer, Range, 4);
Bill Wendling75174662011-06-30 00:30:52 +00001452
Bill Wendling75174662011-06-30 00:30:52 +00001453 // Compact Encoding
Bill Wendling75174662011-06-30 00:30:52 +00001454 Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1455 Streamer.EmitIntValue(Encoding, Size);
1456
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001457 // Personality Function
Bill Wendlingdafd5982011-07-14 23:34:45 +00001458 Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001459 if (!DwarfEHFrameOnly && Frame.Personality)
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001460 Streamer.EmitSymbolValue(Frame.Personality, Size);
Bill Wendling4cdb2062011-06-29 23:53:16 +00001461 else
1462 Streamer.EmitIntValue(0, Size); // No personality fn
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001463
1464 // LSDA
Bill Wendling4cdb2062011-06-29 23:53:16 +00001465 Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
Bill Wendling2d1df6b2013-04-10 21:42:06 +00001466 if (!DwarfEHFrameOnly && Frame.Lsda)
Bill Wendling8fa4ada2011-06-29 23:49:12 +00001467 Streamer.EmitSymbolValue(Frame.Lsda, Size);
Bill Wendling4cdb2062011-06-29 23:53:16 +00001468 else
1469 Streamer.EmitIntValue(0, Size); // No LSDA
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001470}
1471
Rafael Espindolaeffdc7e2015-04-28 13:55:31 +00001472static unsigned getCIEVersion(bool IsEH, unsigned DwarfVersion) {
1473 if (IsEH)
1474 return 1;
1475 switch (DwarfVersion) {
1476 case 2:
1477 return 1;
1478 case 3:
1479 return 3;
1480 case 4:
Eric Christopher2ae71802015-12-28 23:02:42 +00001481 case 5:
Rafael Espindolaeffdc7e2015-04-28 13:55:31 +00001482 return 4;
1483 }
1484 llvm_unreachable("Unknown version");
1485}
1486
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001487const MCSymbol &FrameEmitterImpl::EmitCIE(const MCDwarfFrameInfo &Frame) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001488 MCContext &context = Streamer.getContext();
Bill Wendlingbc07a892013-06-18 07:20:20 +00001489 const MCRegisterInfo *MRI = context.getRegisterInfo();
Evan Cheng76792992011-07-20 05:58:47 +00001490 const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
Rafael Espindolabf60fb02011-04-28 03:26:11 +00001491
Jim Grosbach6f482002015-05-18 18:43:14 +00001492 MCSymbol *sectionStart = context.createTempSymbol();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001493 Streamer.EmitLabel(sectionStart);
Rafael Espindolabf60fb02011-04-28 03:26:11 +00001494
Jim Grosbach6f482002015-05-18 18:43:14 +00001495 MCSymbol *sectionEnd = context.createTempSymbol();
Rafael Espindola0a017a62010-12-10 07:39:47 +00001496
1497 // Length
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001498 const MCExpr *Length =
1499 MakeStartMinusEndExpr(Streamer, *sectionStart, *sectionEnd, 4);
1500 emitAbsValue(Streamer, Length, 4);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001501
1502 // CIE ID
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001503 unsigned CIE_ID = IsEH ? 0 : -1;
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001504 Streamer.EmitIntValue(CIE_ID, 4);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001505
1506 // Version
Rafael Espindolaeffdc7e2015-04-28 13:55:31 +00001507 uint8_t CIEVersion = getCIEVersion(IsEH, context.getDwarfVersion());
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001508 Streamer.EmitIntValue(CIEVersion, 1);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001509
1510 // Augmentation String
1511 SmallString<8> Augmentation;
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001512 if (IsEH) {
1513 Augmentation += "z";
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001514 if (Frame.Personality)
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001515 Augmentation += "P";
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001516 if (Frame.Lsda)
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001517 Augmentation += "L";
1518 Augmentation += "R";
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001519 if (Frame.IsSignalFrame)
Rafael Espindola3c47e372012-01-23 21:51:52 +00001520 Augmentation += "S";
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001521 Streamer.EmitBytes(Augmentation);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001522 }
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001523 Streamer.EmitIntValue(0, 1);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001524
Keith Walkerea9483f2015-05-12 15:25:08 +00001525 if (CIEVersion >= 4) {
1526 // Address Size
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001527 Streamer.EmitIntValue(context.getAsmInfo()->getCodePointerSize(), 1);
Keith Walkerea9483f2015-05-12 15:25:08 +00001528
1529 // Segment Descriptor Size
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001530 Streamer.EmitIntValue(0, 1);
Keith Walkerea9483f2015-05-12 15:25:08 +00001531 }
1532
Rafael Espindola0a017a62010-12-10 07:39:47 +00001533 // Code Alignment Factor
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001534 Streamer.EmitULEB128IntValue(context.getAsmInfo()->getMinInstAlignment());
Rafael Espindola0a017a62010-12-10 07:39:47 +00001535
1536 // Data Alignment Factor
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001537 Streamer.EmitSLEB128IntValue(getDataAlignmentFactor(Streamer));
Rafael Espindola0a017a62010-12-10 07:39:47 +00001538
1539 // Return Address Register
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001540 unsigned RAReg = Frame.RAReg;
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001541 if (RAReg == static_cast<unsigned>(INT_MAX))
1542 RAReg = MRI->getDwarfRegNum(MRI->getRARegister(), IsEH);
1543
Oliver Stannardf7693f42014-06-19 15:39:33 +00001544 if (CIEVersion == 1) {
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001545 assert(RAReg <= 255 &&
Oliver Stannardf7693f42014-06-19 15:39:33 +00001546 "DWARF 2 encodes return_address_register in one byte");
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001547 Streamer.EmitIntValue(RAReg, 1);
Oliver Stannardf7693f42014-06-19 15:39:33 +00001548 } else {
Saleem Abdulrasoola219b3d2017-07-28 03:39:19 +00001549 Streamer.EmitULEB128IntValue(RAReg);
Oliver Stannardf7693f42014-06-19 15:39:33 +00001550 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001551
1552 // Augmentation Data Length (optional)
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001553 unsigned augmentationLength = 0;
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001554 if (IsEH) {
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001555 if (Frame.Personality) {
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001556 // Personality Encoding
1557 augmentationLength += 1;
1558 // Personality
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001559 augmentationLength +=
1560 getSizeForEncoding(Streamer, Frame.PersonalityEncoding);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001561 }
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001562 if (Frame.Lsda)
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001563 augmentationLength += 1;
1564 // Encoding of the FDE pointers
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001565 augmentationLength += 1;
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001566
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001567 Streamer.EmitULEB128IntValue(augmentationLength);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001568
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001569 // Augmentation Data (optional)
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001570 if (Frame.Personality) {
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001571 // Personality Encoding
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001572 emitEncodingByte(Streamer, Frame.PersonalityEncoding);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001573 // Personality
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001574 EmitPersonality(Streamer, *Frame.Personality, Frame.PersonalityEncoding);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001575 }
Bill Wendling567a1ae2011-06-30 21:25:51 +00001576
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001577 if (Frame.Lsda)
1578 emitEncodingByte(Streamer, Frame.LsdaEncoding);
Bill Wendling567a1ae2011-06-30 21:25:51 +00001579
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001580 // Encoding of the FDE pointers
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001581 emitEncodingByte(Streamer, MOFI->getFDEEncoding());
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001582 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001583
1584 // Initial Instructions
1585
Bill Wendlingbc07a892013-06-18 07:20:20 +00001586 const MCAsmInfo *MAI = context.getAsmInfo();
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001587 if (!Frame.IsSimple) {
David Majnemere035cf92014-01-27 17:20:25 +00001588 const std::vector<MCCFIInstruction> &Instructions =
1589 MAI->getInitialFrameState();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001590 EmitCFIInstructions(Instructions, nullptr);
David Majnemere035cf92014-01-27 17:20:25 +00001591 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001592
Rafael Espindola8b4817b2015-03-24 21:47:31 +00001593 InitialCFAOffset = CFAOffset;
1594
Rafael Espindola0a017a62010-12-10 07:39:47 +00001595 // Padding
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001596 Streamer.EmitValueToAlignment(IsEH ? 4 : MAI->getCodePointerSize());
Rafael Espindola0a017a62010-12-10 07:39:47 +00001597
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001598 Streamer.EmitLabel(sectionEnd);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001599 return *sectionStart;
1600}
1601
Rafael Espindola46be4352015-11-06 03:02:51 +00001602void FrameEmitterImpl::EmitFDE(const MCSymbol &cieStart,
1603 const MCDwarfFrameInfo &frame,
Rafael Espindola97588e12015-11-06 13:14:59 +00001604 bool LastInSection,
1605 const MCSymbol &SectionStart) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001606 MCContext &context = Streamer.getContext();
Jim Grosbach6f482002015-05-18 18:43:14 +00001607 MCSymbol *fdeStart = context.createTempSymbol();
1608 MCSymbol *fdeEnd = context.createTempSymbol();
Evan Cheng76792992011-07-20 05:58:47 +00001609 const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
Rafael Espindola0a017a62010-12-10 07:39:47 +00001610
Rafael Espindola8b4817b2015-03-24 21:47:31 +00001611 CFAOffset = InitialCFAOffset;
1612
Rafael Espindola0a017a62010-12-10 07:39:47 +00001613 // Length
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001614 const MCExpr *Length = MakeStartMinusEndExpr(Streamer, *fdeStart, *fdeEnd, 0);
1615 emitAbsValue(Streamer, Length, 4);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001616
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001617 Streamer.EmitLabel(fdeStart);
Rafael Espindola99f67352011-05-10 20:59:42 +00001618
Rafael Espindola0a017a62010-12-10 07:39:47 +00001619 // CIE Pointer
Bill Wendlingbc07a892013-06-18 07:20:20 +00001620 const MCAsmInfo *asmInfo = context.getAsmInfo();
Rafael Espindola27390b42011-05-10 15:20:23 +00001621 if (IsEH) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001622 const MCExpr *offset =
1623 MakeStartMinusEndExpr(Streamer, cieStart, *fdeStart, 0);
1624 emitAbsValue(Streamer, offset, 4);
Bill Wendlingbc07a892013-06-18 07:20:20 +00001625 } else if (!asmInfo->doesDwarfUseRelocationsAcrossSections()) {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001626 const MCExpr *offset =
Rafael Espindola97588e12015-11-06 13:14:59 +00001627 MakeStartMinusEndExpr(Streamer, SectionStart, cieStart, 0);
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001628 emitAbsValue(Streamer, offset, 4);
Rafael Espindola27390b42011-05-10 15:20:23 +00001629 } else {
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001630 Streamer.EmitSymbolValue(&cieStart, 4);
Rafael Espindola27390b42011-05-10 15:20:23 +00001631 }
Bill Wendlingf166ab42011-06-30 22:02:20 +00001632
Rafael Espindola0a017a62010-12-10 07:39:47 +00001633 // PC Begin
Rafael Espindola01ee31b2014-05-12 13:40:49 +00001634 unsigned PCEncoding =
Rafael Espindolaaa7851d2014-05-12 13:47:05 +00001635 IsEH ? MOFI->getFDEEncoding() : (unsigned)dwarf::DW_EH_PE_absptr;
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001636 unsigned PCSize = getSizeForEncoding(Streamer, PCEncoding);
1637 emitFDESymbol(Streamer, *frame.Begin, PCEncoding, IsEH);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001638
1639 // PC Range
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001640 const MCExpr *Range =
1641 MakeStartMinusEndExpr(Streamer, *frame.Begin, *frame.End, 0);
1642 emitAbsValue(Streamer, Range, PCSize);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001643
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001644 if (IsEH) {
1645 // Augmentation Data Length
1646 unsigned augmentationLength = 0;
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001647
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001648 if (frame.Lsda)
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001649 augmentationLength += getSizeForEncoding(Streamer, frame.LsdaEncoding);
Rafael Espindola6a85f9b2011-04-29 21:50:57 +00001650
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001651 Streamer.EmitULEB128IntValue(augmentationLength);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001652
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001653 // Augmentation Data
1654 if (frame.Lsda)
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001655 emitFDESymbol(Streamer, *frame.Lsda, frame.LsdaEncoding, true);
Rafael Espindola1ecb12f2011-05-10 03:54:12 +00001656 }
Rafael Espindola68067662011-04-29 03:06:29 +00001657
Rafael Espindola0a017a62010-12-10 07:39:47 +00001658 // Call Frame Instructions
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001659 EmitCFIInstructions(frame.Instructions, frame.Begin);
Rafael Espindolaa75b87b2010-12-28 04:15:37 +00001660
Rafael Espindola0a017a62010-12-10 07:39:47 +00001661 // Padding
Rafael Espindola46be4352015-11-06 03:02:51 +00001662 // The size of a .eh_frame section has to be a multiple of the alignment
1663 // since a null CIE is interpreted as the end. Old systems overaligned
1664 // .eh_frame, so we do too and account for it in the last FDE.
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001665 unsigned Align = LastInSection ? asmInfo->getCodePointerSize() : PCSize;
Rafael Espindola46be4352015-11-06 03:02:51 +00001666 Streamer.EmitValueToAlignment(Align);
Rafael Espindola32c74ea2010-12-17 00:28:02 +00001667
Rafael Espindola46be4352015-11-06 03:02:51 +00001668 Streamer.EmitLabel(fdeEnd);
Rafael Espindola0a017a62010-12-10 07:39:47 +00001669}
1670
Benjamin Kramer570dd782010-12-30 22:34:44 +00001671namespace {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001672
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001673struct CIEKey {
1674 static const CIEKey getEmptyKey() {
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001675 return CIEKey(nullptr, 0, -1, false, false, static_cast<unsigned>(INT_MAX));
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001676 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001677
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001678 static const CIEKey getTombstoneKey() {
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001679 return CIEKey(nullptr, -1, 0, false, false, static_cast<unsigned>(INT_MAX));
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001680 }
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001681
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001682 CIEKey(const MCSymbol *Personality, unsigned PersonalityEncoding,
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001683 unsigned LSDAEncoding, bool IsSignalFrame, bool IsSimple,
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001684 unsigned RAReg)
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001685 : Personality(Personality), PersonalityEncoding(PersonalityEncoding),
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001686 LsdaEncoding(LSDAEncoding), IsSignalFrame(IsSignalFrame),
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001687 IsSimple(IsSimple), RAReg(RAReg) {}
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001688
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001689 explicit CIEKey(const MCDwarfFrameInfo &Frame)
1690 : Personality(Frame.Personality),
1691 PersonalityEncoding(Frame.PersonalityEncoding),
1692 LsdaEncoding(Frame.LsdaEncoding), IsSignalFrame(Frame.IsSignalFrame),
1693 IsSimple(Frame.IsSimple), RAReg(Frame.RAReg) {}
1694
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001695 const MCSymbol *Personality;
1696 unsigned PersonalityEncoding;
1697 unsigned LsdaEncoding;
1698 bool IsSignalFrame;
1699 bool IsSimple;
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001700 unsigned RAReg;
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001701};
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001702
1703} // end anonymous namespace
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001704
1705namespace llvm {
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001706
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001707template <> struct DenseMapInfo<CIEKey> {
1708 static CIEKey getEmptyKey() { return CIEKey::getEmptyKey(); }
1709 static CIEKey getTombstoneKey() { return CIEKey::getTombstoneKey(); }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001710
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001711 static unsigned getHashValue(const CIEKey &Key) {
1712 return static_cast<unsigned>(
1713 hash_combine(Key.Personality, Key.PersonalityEncoding, Key.LsdaEncoding,
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001714 Key.IsSignalFrame, Key.IsSimple, Key.RAReg));
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001715 }
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001716
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001717 static bool isEqual(const CIEKey &LHS, const CIEKey &RHS) {
1718 return LHS.Personality == RHS.Personality &&
1719 LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1720 LHS.LsdaEncoding == RHS.LsdaEncoding &&
1721 LHS.IsSignalFrame == RHS.IsSignalFrame &&
Saleem Abdulrasoolfc850672017-07-29 20:03:00 +00001722 LHS.IsSimple == RHS.IsSimple &&
1723 LHS.RAReg == RHS.RAReg;
Rafael Espindola5b2131c2015-11-06 14:12:17 +00001724 }
1725};
Eugene Zelenkod96089b2017-02-14 00:33:36 +00001726
1727} // end namespace llvm
Rafael Espindola1de2dd02010-12-27 15:56:22 +00001728
Rafael Espindola4066e8d2014-05-12 14:28:48 +00001729void MCDwarfFrameEmitter::Emit(MCObjectStreamer &Streamer, MCAsmBackend *MAB,
Rafael Espindola8285b772014-05-12 13:34:25 +00001730 bool IsEH) {
Bill Wendling550c76d2013-09-09 19:48:37 +00001731 Streamer.generateCompactUnwindEncodings(MAB);
1732
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001733 MCContext &Context = Streamer.getContext();
Bill Wendlinga800f952013-05-30 18:52:57 +00001734 const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001735 const MCAsmInfo *AsmInfo = Context.getAsmInfo();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001736 FrameEmitterImpl Emitter(IsEH, Streamer);
Saleem Abdulrasool3f3cefd2014-07-13 19:03:36 +00001737 ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getDwarfFrameInfos();
Bill Wendling4d9aa512011-07-22 21:18:59 +00001738
Bill Wendling9803abb2011-09-06 18:37:11 +00001739 // Emit the compact unwind info if available.
Tim Northoverd1c6f512014-03-29 09:03:13 +00001740 bool NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
Bill Wendling4e9fc022013-04-24 03:11:14 +00001741 if (IsEH && MOFI->getCompactUnwindSection()) {
Bill Wendling4e9fc022013-04-24 03:11:14 +00001742 bool SectionEmitted = false;
Benjamin Kramer7b4658f2016-06-26 14:49:00 +00001743 for (const MCDwarfFrameInfo &Frame : FrameArray) {
Bob Wilson0e180f22013-05-07 20:56:33 +00001744 if (Frame.CompactUnwindEncoding == 0) continue;
1745 if (!SectionEmitted) {
1746 Streamer.SwitchSection(MOFI->getCompactUnwindSection());
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001747 Streamer.EmitValueToAlignment(AsmInfo->getCodePointerSize());
Bob Wilson0e180f22013-05-07 20:56:33 +00001748 SectionEmitted = true;
Bill Wendling4e9fc022013-04-24 03:11:14 +00001749 }
Tim Northoverd1c6f512014-03-29 09:03:13 +00001750 NeedsEHFrameSection |=
1751 Frame.CompactUnwindEncoding ==
1752 MOFI->getCompactUnwindDwarfEHFrameOnly();
Rafael Espindola6efa6fb2015-11-06 00:05:57 +00001753 Emitter.EmitCompactUnwind(Frame);
Bill Wendling4d9aa512011-07-22 21:18:59 +00001754 }
Bill Wendling4e9fc022013-04-24 03:11:14 +00001755 }
Bill Wendling4d9aa512011-07-22 21:18:59 +00001756
Tim Northoverd1c6f512014-03-29 09:03:13 +00001757 if (!NeedsEHFrameSection) return;
1758
Rafael Espindola0709a7b2015-05-21 19:20:38 +00001759 MCSection &Section =
1760 IsEH ? *const_cast<MCObjectFileInfo *>(MOFI)->getEHFrameSection()
1761 : *MOFI->getDwarfFrameSection();
Tim Northoverd1c6f512014-03-29 09:03:13 +00001762
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001763 Streamer.SwitchSection(&Section);
Jim Grosbach6f482002015-05-18 18:43:14 +00001764 MCSymbol *SectionStart = Context.createTempSymbol();
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001765 Streamer.EmitLabel(SectionStart);
Rafael Espindola7c715152011-04-29 02:42:28 +00001766
Eric Christopherd29430d2014-06-19 20:00:09 +00001767 DenseMap<CIEKey, const MCSymbol *> CIEStarts;
Rafael Espindola9141b612010-12-26 20:20:31 +00001768
Craig Topperbb694de2014-04-13 04:57:38 +00001769 const MCSymbol *DummyDebugKey = nullptr;
Tim Northoverf8e47e42015-10-28 22:56:36 +00001770 bool CanOmitDwarf = MOFI->getOmitDwarfIfHaveCompactUnwind();
Rafael Espindola46be4352015-11-06 03:02:51 +00001771 for (auto I = FrameArray.begin(), E = FrameArray.end(); I != E;) {
1772 const MCDwarfFrameInfo &Frame = *I;
1773 ++I;
Tim Northoverf8e47e42015-10-28 22:56:36 +00001774 if (CanOmitDwarf && Frame.CompactUnwindEncoding !=
Tim Northoverd1c6f512014-03-29 09:03:13 +00001775 MOFI->getCompactUnwindDwarfEHFrameOnly())
1776 // Don't generate an EH frame if we don't need one. I.e., it's taken care
1777 // of by the compact unwind encoding.
1778 continue;
1779
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001780 CIEKey Key(Frame);
Bill Wendlinga4b9d1f2011-06-23 07:44:54 +00001781 const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1782 if (!CIEStart)
Saleem Abdulrasool29199f52017-07-29 20:03:02 +00001783 CIEStart = &Emitter.EmitCIE(Frame);
Bill Wendlinge8fc92a2011-06-23 01:06:23 +00001784
Rafael Espindola97588e12015-11-06 13:14:59 +00001785 Emitter.EmitFDE(*CIEStart, Frame, I == E, *SectionStart);
Rafael Espindola32c74ea2010-12-17 00:28:02 +00001786 }
Rafael Espindola0a017a62010-12-10 07:39:47 +00001787}
Rafael Espindola736a35d2010-12-28 05:39:27 +00001788
Rafael Espindola4066e8d2014-05-12 14:28:48 +00001789void MCDwarfFrameEmitter::EmitAdvanceLoc(MCObjectStreamer &Streamer,
Rafael Espindola736a35d2010-12-28 05:39:27 +00001790 uint64_t AddrDelta) {
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001791 MCContext &Context = Streamer.getContext();
Alp Tokere69170a2014-06-26 22:52:05 +00001792 SmallString<256> Tmp;
1793 raw_svector_ostream OS(Tmp);
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001794 MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OS);
Eric Christophere3ab3d02013-01-09 01:57:54 +00001795 Streamer.EmitBytes(OS.str());
Rafael Espindola736a35d2010-12-28 05:39:27 +00001796}
1797
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001798void MCDwarfFrameEmitter::EncodeAdvanceLoc(MCContext &Context,
1799 uint64_t AddrDelta,
Rafael Espindolaab39c632011-05-08 14:35:21 +00001800 raw_ostream &OS) {
Ulrich Weigand32d725b2013-06-12 14:46:54 +00001801 // Scale the address delta by the minimum instruction length.
1802 AddrDelta = ScaleAddrDelta(Context, AddrDelta);
1803
Peter Collingbournee3f65292018-05-18 19:46:24 +00001804 support::endianness E =
1805 Context.getAsmInfo()->isLittleEndian() ? support::little : support::big;
Rafael Espindola6bbfb6c2010-12-28 23:38:03 +00001806 if (AddrDelta == 0) {
Rafael Espindolaab39c632011-05-08 14:35:21 +00001807 } else if (isUIntN(6, AddrDelta)) {
Rafael Espindola736a35d2010-12-28 05:39:27 +00001808 uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1809 OS << Opcode;
Rafael Espindolaab39c632011-05-08 14:35:21 +00001810 } else if (isUInt<8>(AddrDelta)) {
Rafael Espindola736a35d2010-12-28 05:39:27 +00001811 OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1812 OS << uint8_t(AddrDelta);
Rafael Espindolaab39c632011-05-08 14:35:21 +00001813 } else if (isUInt<16>(AddrDelta)) {
Rafael Espindola736a35d2010-12-28 05:39:27 +00001814 OS << uint8_t(dwarf::DW_CFA_advance_loc2);
Peter Collingbournee3f65292018-05-18 19:46:24 +00001815 support::endian::write<uint16_t>(OS, AddrDelta, E);
Rafael Espindola736a35d2010-12-28 05:39:27 +00001816 } else {
1817 assert(isUInt<32>(AddrDelta));
1818 OS << uint8_t(dwarf::DW_CFA_advance_loc4);
Peter Collingbournee3f65292018-05-18 19:46:24 +00001819 support::endian::write<uint32_t>(OS, AddrDelta, E);
Rafael Espindola736a35d2010-12-28 05:39:27 +00001820 }
1821}