blob: 939d13faec0246918a6320bbc3982012ae484ccd [file] [log] [blame]
David Blaikie319a05f2013-12-02 19:33:10 +00001//===-- llvm/CodeGen/DwarfUnit.cpp - Dwarf Type and Compile Units ---------===//
Devang Patel0e821f42011-04-12 23:21:44 +00002//
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//
Eric Christopher160522c2012-08-14 05:13:29 +000010// This file contains support for constructing a dwarf compile unit.
Devang Patel0e821f42011-04-12 23:21:44 +000011//
12//===----------------------------------------------------------------------===//
13
David Blaikie2c86a722013-12-02 19:33:15 +000014#include "DwarfUnit.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000015#include "AddressPool.h"
David Blaikie37c52312014-10-04 15:49:50 +000016#include "DwarfCompileUnit.h"
Devang Patel0e821f42011-04-12 23:21:44 +000017#include "DwarfDebug.h"
Adrian Prantl00dbc2a2015-01-12 22:19:26 +000018#include "DwarfExpression.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000019#include "llvm/ADT/APFloat.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000020#include "llvm/ADT/APInt.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000021#include "llvm/ADT/None.h"
Paul Robinson612e89d2018-01-12 19:17:50 +000022#include "llvm/ADT/StringExtras.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000023#include "llvm/ADT/iterator_range.h"
Adrian Prantlb846acc2015-03-02 22:02:36 +000024#include "llvm/CodeGen/MachineFunction.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000025#include "llvm/CodeGen/MachineOperand.h"
David Blaikieb3bde2e2017-11-17 01:07:10 +000026#include "llvm/CodeGen/TargetLoweringObjectFile.h"
27#include "llvm/CodeGen/TargetRegisterInfo.h"
28#include "llvm/CodeGen/TargetSubtargetInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000029#include "llvm/IR/Constants.h"
30#include "llvm/IR/DataLayout.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000031#include "llvm/IR/GlobalValue.h"
32#include "llvm/IR/Metadata.h"
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +000033#include "llvm/MC/MCAsmInfo.h"
Paul Robinson612e89d2018-01-12 19:17:50 +000034#include "llvm/MC/MCContext.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000035#include "llvm/MC/MCDwarf.h"
David Blaikie6b288cf2013-10-30 20:42:41 +000036#include "llvm/MC/MCSection.h"
37#include "llvm/MC/MCStreamer.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000038#include "llvm/MC/MachineLocation.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000039#include "llvm/Support/Casting.h"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000040#include "llvm/Support/CommandLine.h"
Eugene Zelenko1804a772016-08-25 00:45:04 +000041#include <cassert>
42#include <cstdint>
43#include <string>
44#include <utility>
Devang Patel0e821f42011-04-12 23:21:44 +000045
46using namespace llvm;
47
Chandler Carruth1b9dde02014-04-22 02:02:50 +000048#define DEBUG_TYPE "dwarfdebug"
49
Eric Christopher4287a492013-12-09 23:57:44 +000050static cl::opt<bool>
51GenerateDwarfTypeUnits("generate-type-units", cl::Hidden,
52 cl::desc("Generate DWARF4 type units."),
53 cl::init(false));
David Blaikie409dd9c2013-11-19 23:08:21 +000054
Adrian Prantlb846acc2015-03-02 22:02:36 +000055DIEDwarfExpression::DIEDwarfExpression(const AsmPrinter &AP, DwarfUnit &DU,
56 DIELoc &DIE)
Greg Claytone6543972016-11-23 23:30:37 +000057 : DwarfExpression(AP.getDwarfVersion()), AP(AP), DU(DU),
Peter Collingbourne96c9ae62016-05-20 19:35:17 +000058 DIE(DIE) {}
Adrian Prantl92da14b2015-03-02 22:02:33 +000059
Adrian Prantla63b8e82017-03-16 17:42:45 +000060void DIEDwarfExpression::emitOp(uint8_t Op, const char* Comment) {
Adrian Prantl00dbc2a2015-01-12 22:19:26 +000061 DU.addUInt(DIE, dwarf::DW_FORM_data1, Op);
62}
Eugene Zelenko1804a772016-08-25 00:45:04 +000063
Adrian Prantla63b8e82017-03-16 17:42:45 +000064void DIEDwarfExpression::emitSigned(int64_t Value) {
Adrian Prantl00dbc2a2015-01-12 22:19:26 +000065 DU.addSInt(DIE, dwarf::DW_FORM_sdata, Value);
66}
Eugene Zelenko1804a772016-08-25 00:45:04 +000067
Adrian Prantla63b8e82017-03-16 17:42:45 +000068void DIEDwarfExpression::emitUnsigned(uint64_t Value) {
Adrian Prantl00dbc2a2015-01-12 22:19:26 +000069 DU.addUInt(DIE, dwarf::DW_FORM_udata, Value);
70}
Eugene Zelenko1804a772016-08-25 00:45:04 +000071
Peter Collingbourne96c9ae62016-05-20 19:35:17 +000072bool DIEDwarfExpression::isFrameRegister(const TargetRegisterInfo &TRI,
73 unsigned MachineReg) {
Adrian Prantl92da14b2015-03-02 22:02:33 +000074 return MachineReg == TRI.getFrameRegister(*AP.MF);
Adrian Prantl00dbc2a2015-01-12 22:19:26 +000075}
76
Peter Collingbourne7c384cc2016-02-11 19:57:46 +000077DwarfUnit::DwarfUnit(dwarf::Tag UnitTag, const DICompileUnit *Node,
78 AsmPrinter *A, DwarfDebug *DW, DwarfFile *DWU)
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +000079 : DIEUnit(A->getDwarfVersion(), A->MAI->getCodePointerSize(), UnitTag),
80 CUNode(Node), Asm(A), DD(DW), DU(DWU), IndexTyDie(nullptr) {
David Blaikie319a05f2013-12-02 19:33:10 +000081}
82
Peter Collingbourne7c384cc2016-02-11 19:57:46 +000083DwarfTypeUnit::DwarfTypeUnit(DwarfCompileUnit &CU, AsmPrinter *A,
David Blaikie92a2f8a2014-04-28 21:04:29 +000084 DwarfDebug *DW, DwarfFile *DWU,
David Blaikie8287aff2014-03-18 02:13:23 +000085 MCDwarfDwoLineTable *SplitLineTable)
Peter Collingbourne7c384cc2016-02-11 19:57:46 +000086 : DwarfUnit(dwarf::DW_TAG_type_unit, CU.getCUNode(), A, DW, DWU), CU(CU),
87 SplitLineTable(SplitLineTable) {
David Blaikie4a2f95f2014-03-18 01:17:26 +000088 if (SplitLineTable)
Greg Clayton35630c32016-12-01 18:56:29 +000089 addSectionOffset(getUnitDie(), dwarf::DW_AT_stmt_list, 0);
David Blaikie4a2f95f2014-03-18 01:17:26 +000090}
David Blaikie409dd9c2013-11-19 23:08:21 +000091
Eric Christophera5a79422013-12-09 23:32:48 +000092DwarfUnit::~DwarfUnit() {
Devang Patel0e821f42011-04-12 23:21:44 +000093 for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
94 DIEBlocks[j]->~DIEBlock();
Eric Christopher4a741042014-02-16 08:46:55 +000095 for (unsigned j = 0, M = DIELocs.size(); j < M; ++j)
96 DIELocs[j]->~DIELoc();
Devang Patel0e821f42011-04-12 23:21:44 +000097}
98
Eric Christophera5a79422013-12-09 23:32:48 +000099int64_t DwarfUnit::getDefaultLowerBound() const {
David Blaikiecb8e4352013-11-15 23:50:53 +0000100 switch (getLanguage()) {
Bill Wendling28fe9e72012-12-06 07:38:10 +0000101 default:
102 break;
103
Paul Robinson91d74812017-03-01 18:32:37 +0000104 // The languages below have valid values in all DWARF versions.
Bill Wendling28fe9e72012-12-06 07:38:10 +0000105 case dwarf::DW_LANG_C:
Paul Robinsond4f1c482017-03-01 19:01:47 +0000106 case dwarf::DW_LANG_C89:
Bill Wendling28fe9e72012-12-06 07:38:10 +0000107 case dwarf::DW_LANG_C_plus_plus:
Bill Wendling28fe9e72012-12-06 07:38:10 +0000108 return 0;
109
110 case dwarf::DW_LANG_Fortran77:
111 case dwarf::DW_LANG_Fortran90:
Bill Wendling28fe9e72012-12-06 07:38:10 +0000112 return 1;
113
Paul Robinson91d74812017-03-01 18:32:37 +0000114 // The languages below have valid values only if the DWARF version >= 3.
115 case dwarf::DW_LANG_C99:
116 case dwarf::DW_LANG_ObjC:
117 case dwarf::DW_LANG_ObjC_plus_plus:
118 if (DD->getDwarfVersion() >= 3)
119 return 0;
120 break;
121
122 case dwarf::DW_LANG_Fortran95:
123 if (DD->getDwarfVersion() >= 3)
124 return 1;
125 break;
126
127 // Starting with DWARF v4, all defined languages have valid values.
Paul Robinsond4f1c482017-03-01 19:01:47 +0000128 case dwarf::DW_LANG_D:
Bill Wendling28fe9e72012-12-06 07:38:10 +0000129 case dwarf::DW_LANG_Java:
130 case dwarf::DW_LANG_Python:
131 case dwarf::DW_LANG_UPC:
Paul Robinson91d74812017-03-01 18:32:37 +0000132 if (DD->getDwarfVersion() >= 4)
Bill Wendling28fe9e72012-12-06 07:38:10 +0000133 return 0;
134 break;
135
136 case dwarf::DW_LANG_Ada83:
137 case dwarf::DW_LANG_Ada95:
138 case dwarf::DW_LANG_Cobol74:
139 case dwarf::DW_LANG_Cobol85:
140 case dwarf::DW_LANG_Modula2:
141 case dwarf::DW_LANG_Pascal83:
142 case dwarf::DW_LANG_PLI:
Paul Robinson91d74812017-03-01 18:32:37 +0000143 if (DD->getDwarfVersion() >= 4)
Bill Wendling28fe9e72012-12-06 07:38:10 +0000144 return 1;
145 break;
Bruce Mitchener7e575ed2015-02-07 06:35:30 +0000146
Paul Robinson91d74812017-03-01 18:32:37 +0000147 // The languages below are new in DWARF v5.
Paul Robinsond4f1c482017-03-01 19:01:47 +0000148 case dwarf::DW_LANG_BLISS:
149 case dwarf::DW_LANG_C11:
Bruce Mitchener7e575ed2015-02-07 06:35:30 +0000150 case dwarf::DW_LANG_C_plus_plus_03:
151 case dwarf::DW_LANG_C_plus_plus_11:
Bruce Mitchener7e575ed2015-02-07 06:35:30 +0000152 case dwarf::DW_LANG_C_plus_plus_14:
Paul Robinsond4f1c482017-03-01 19:01:47 +0000153 case dwarf::DW_LANG_Dylan:
154 case dwarf::DW_LANG_Go:
155 case dwarf::DW_LANG_Haskell:
156 case dwarf::DW_LANG_OCaml:
157 case dwarf::DW_LANG_OpenCL:
Paul Robinson91d74812017-03-01 18:32:37 +0000158 case dwarf::DW_LANG_RenderScript:
Paul Robinsond4f1c482017-03-01 19:01:47 +0000159 case dwarf::DW_LANG_Rust:
160 case dwarf::DW_LANG_Swift:
Paul Robinson91d74812017-03-01 18:32:37 +0000161 if (DD->getDwarfVersion() >= 5)
Bruce Mitchener7e575ed2015-02-07 06:35:30 +0000162 return 0;
163 break;
164
Bruce Mitchener7e575ed2015-02-07 06:35:30 +0000165 case dwarf::DW_LANG_Fortran03:
166 case dwarf::DW_LANG_Fortran08:
Paul Robinsond4f1c482017-03-01 19:01:47 +0000167 case dwarf::DW_LANG_Julia:
168 case dwarf::DW_LANG_Modula3:
Paul Robinson91d74812017-03-01 18:32:37 +0000169 if (DD->getDwarfVersion() >= 5)
Bruce Mitchener7e575ed2015-02-07 06:35:30 +0000170 return 1;
171 break;
Bill Wendling28fe9e72012-12-06 07:38:10 +0000172 }
173
174 return -1;
175}
176
Manman Ren4dbdc902013-10-31 17:54:35 +0000177/// Check whether the DIE for this MDNode can be shared across CUs.
David Blaikie488393f2017-05-12 01:13:45 +0000178bool DwarfUnit::isShareableAcrossCUs(const DINode *D) const {
David Blaikiebcb418e2013-11-20 18:40:16 +0000179 // When the MDNode can be part of the type system, the DIE can be shared
180 // across CUs.
181 // Combining type units and cross-CU DIE sharing is lower value (since
182 // cross-CU DIE sharing is used in LTO and removes type redundancy at that
183 // level already) but may be implementable for some value in projects
184 // building multiple independent libraries with LTO and then linking those
185 // together.
David Blaikie488393f2017-05-12 01:13:45 +0000186 if (isDwoUnit() && !DD->shareAcrossDWOCUs())
187 return false;
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000188 return (isa<DIType>(D) ||
189 (isa<DISubprogram>(D) && !cast<DISubprogram>(D)->isDefinition())) &&
Eric Christopher4287a492013-12-09 23:57:44 +0000190 !GenerateDwarfTypeUnits;
Manman Ren4dbdc902013-10-31 17:54:35 +0000191}
192
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000193DIE *DwarfUnit::getDIE(const DINode *D) const {
David Blaikie2ad00162013-11-15 23:09:13 +0000194 if (isShareableAcrossCUs(D))
David Blaikie9bfd7a92014-11-04 22:12:18 +0000195 return DU->getDIE(D);
David Blaikie2ad00162013-11-15 23:09:13 +0000196 return MDNodeToDieMap.lookup(D);
Manman Ren4dbdc902013-10-31 17:54:35 +0000197}
198
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000199void DwarfUnit::insertDIE(const DINode *Desc, DIE *D) {
David Blaikie2ad00162013-11-15 23:09:13 +0000200 if (isShareableAcrossCUs(Desc)) {
David Blaikie9bfd7a92014-11-04 22:12:18 +0000201 DU->insertDIE(Desc, D);
Manman Ren4dbdc902013-10-31 17:54:35 +0000202 return;
203 }
David Blaikie2ad00162013-11-15 23:09:13 +0000204 MDNodeToDieMap.insert(std::make_pair(Desc, D));
Manman Ren4dbdc902013-10-31 17:54:35 +0000205}
206
David Blaikie65a74662014-04-25 18:26:14 +0000207void DwarfUnit::addFlag(DIE &Die, dwarf::Attribute Attribute) {
Michael Gottesmanc89466f2013-09-04 04:39:38 +0000208 if (DD->getDwarfVersion() >= 4)
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000209 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag_present,
210 DIEInteger(1));
Eric Christopherbb69a272012-08-24 01:14:27 +0000211 else
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000212 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_flag,
213 DIEInteger(1));
Eric Christopherbb69a272012-08-24 01:14:27 +0000214}
215
Duncan P. N. Exon Smith55a868a2015-08-02 20:44:46 +0000216void DwarfUnit::addUInt(DIEValueList &Die, dwarf::Attribute Attribute,
Eric Christophera5a79422013-12-09 23:32:48 +0000217 Optional<dwarf::Form> Form, uint64_t Integer) {
Eric Christopherc2697f82013-10-19 01:04:47 +0000218 if (!Form)
219 Form = DIEInteger::BestForm(false, Integer);
Victor Leschukcbddae72017-01-10 21:18:26 +0000220 assert(Form != dwarf::DW_FORM_implicit_const &&
221 "DW_FORM_implicit_const is used only for signed integers");
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000222 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer));
David Blaikief2443192013-10-21 17:28:37 +0000223}
224
Duncan P. N. Exon Smith55a868a2015-08-02 20:44:46 +0000225void DwarfUnit::addUInt(DIEValueList &Block, dwarf::Form Form,
226 uint64_t Integer) {
David Blaikief2443192013-10-21 17:28:37 +0000227 addUInt(Block, (dwarf::Attribute)0, Form, Integer);
Devang Patel0e821f42011-04-12 23:21:44 +0000228}
229
Duncan P. N. Exon Smith55a868a2015-08-02 20:44:46 +0000230void DwarfUnit::addSInt(DIEValueList &Die, dwarf::Attribute Attribute,
Eric Christophera5a79422013-12-09 23:32:48 +0000231 Optional<dwarf::Form> Form, int64_t Integer) {
Eric Christopherc2697f82013-10-19 01:04:47 +0000232 if (!Form)
233 Form = DIEInteger::BestForm(true, Integer);
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000234 Die.addValue(DIEValueAllocator, Attribute, *Form, DIEInteger(Integer));
David Blaikief2443192013-10-21 17:28:37 +0000235}
236
David Blaikie65a74662014-04-25 18:26:14 +0000237void DwarfUnit::addSInt(DIELoc &Die, Optional<dwarf::Form> Form,
Eric Christophera5a79422013-12-09 23:32:48 +0000238 int64_t Integer) {
David Blaikief2443192013-10-21 17:28:37 +0000239 addSInt(Die, (dwarf::Attribute)0, Form, Integer);
Devang Patel0e821f42011-04-12 23:21:44 +0000240}
241
David Blaikie65a74662014-04-25 18:26:14 +0000242void DwarfUnit::addString(DIE &Die, dwarf::Attribute Attribute,
Eric Christophera5a79422013-12-09 23:32:48 +0000243 StringRef String) {
Wolfgang Pieb456b5552018-01-26 18:52:58 +0000244 auto StringPoolEntry = DU->getStringPool().getEntry(*Asm, String);
245 dwarf::Form IxForm =
246 isDwoUnit() ? dwarf::DW_FORM_GNU_str_index : dwarf::DW_FORM_strp;
247 // For DWARF v5 and beyond, use the smallest strx? form possible.
248 if (useSegmentedStringOffsetsTable()) {
249 IxForm = dwarf::DW_FORM_strx1;
250 unsigned Index = StringPoolEntry.getIndex();
251 if (Index > 0xffffff)
252 IxForm = dwarf::DW_FORM_strx4;
253 else if (Index > 0xffff)
254 IxForm = dwarf::DW_FORM_strx3;
255 else if (Index > 0xff)
256 IxForm = dwarf::DW_FORM_strx2;
257 }
258 Die.addValue(DIEValueAllocator, Attribute, IxForm,
259 DIEString(StringPoolEntry));
Devang Patel0e821f42011-04-12 23:21:44 +0000260}
261
Duncan P. N. Exon Smith55a868a2015-08-02 20:44:46 +0000262DIEValueList::value_iterator DwarfUnit::addLabel(DIEValueList &Die,
263 dwarf::Attribute Attribute,
264 dwarf::Form Form,
265 const MCSymbol *Label) {
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000266 return Die.addValue(DIEValueAllocator, Attribute, Form, DIELabel(Label));
David Blaikief3cd7c52013-06-28 20:05:04 +0000267}
268
David Blaikie65a74662014-04-25 18:26:14 +0000269void DwarfUnit::addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label) {
David Blaikief2443192013-10-21 17:28:37 +0000270 addLabel(Die, (dwarf::Attribute)0, Form, Label);
271}
272
David Blaikie65a74662014-04-25 18:26:14 +0000273void DwarfUnit::addSectionOffset(DIE &Die, dwarf::Attribute Attribute,
Eric Christophera5a79422013-12-09 23:32:48 +0000274 uint64_t Integer) {
Eric Christopher33ff6972013-11-21 23:46:41 +0000275 if (DD->getDwarfVersion() >= 4)
276 addUInt(Die, Attribute, dwarf::DW_FORM_sec_offset, Integer);
277 else
278 addUInt(Die, Attribute, dwarf::DW_FORM_data4, Integer);
279}
280
Paul Robinson612e89d2018-01-12 19:17:50 +0000281MD5::MD5Result *DwarfUnit::getMD5AsBytes(const DIFile *File) {
282 assert(File);
283 if (File->getChecksumKind() != DIFile::CSK_MD5)
284 return nullptr;
285
286 // Convert the string checksum to an MD5Result for the streamer.
287 // The verifier validates the checksum so we assume it's okay.
288 // An MD5 checksum is 16 bytes.
289 std::string Checksum = fromHex(File->getChecksum());
290 void *CKMem = Asm->OutStreamer->getContext().allocate(16, 1);
291 memcpy(CKMem, Checksum.data(), 16);
292 return reinterpret_cast<MD5::MD5Result *>(CKMem);
293}
294
295unsigned DwarfTypeUnit::getOrCreateSourceID(const DIFile *File) {
Paul Robinson29f5f982018-01-09 23:31:48 +0000296 return SplitLineTable
Paul Robinson612e89d2018-01-12 19:17:50 +0000297 ? SplitLineTable->getFile(File->getDirectory(),
298 File->getFilename(), getMD5AsBytes(File))
299 : getCU().getOrCreateSourceID(File);
David Blaikie4a2f95f2014-03-18 01:17:26 +0000300}
301
David Blaikie65a74662014-04-25 18:26:14 +0000302void DwarfUnit::addOpAddress(DIELoc &Die, const MCSymbol *Sym) {
Eric Christophere9ec2452013-01-18 22:11:33 +0000303 if (!DD->useSplitDwarf()) {
David Blaikief2443192013-10-21 17:28:37 +0000304 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
305 addLabel(Die, dwarf::DW_FORM_udata, Sym);
Eric Christophere9ec2452013-01-18 22:11:33 +0000306 } else {
David Blaikief2443192013-10-21 17:28:37 +0000307 addUInt(Die, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
David Blaikiee226b082014-04-23 21:04:59 +0000308 addUInt(Die, dwarf::DW_FORM_GNU_addr_index,
David Blaikied75fb282014-04-23 21:20:10 +0000309 DD->getAddressPool().getIndex(Sym));
Eric Christophere9ec2452013-01-18 22:11:33 +0000310 }
311}
312
David Blaikie65a74662014-04-25 18:26:14 +0000313void DwarfUnit::addLabelDelta(DIE &Die, dwarf::Attribute Attribute,
David Blaikie48b1bdc2014-03-07 01:30:55 +0000314 const MCSymbol *Hi, const MCSymbol *Lo) {
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000315 Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_data4,
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000316 new (DIEValueAllocator) DIEDelta(Hi, Lo));
David Blaikie48b1bdc2014-03-07 01:30:55 +0000317}
318
David Blaikie8dbcc3f2014-04-25 19:33:43 +0000319void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry) {
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000320 addDIEEntry(Die, Attribute, DIEEntry(Entry));
Manman Ren4dbdc902013-10-31 17:54:35 +0000321}
322
Peter Collingbourne7c384cc2016-02-11 19:57:46 +0000323void DwarfUnit::addDIETypeSignature(DIE &Die, uint64_t Signature) {
David Blaikief3de2ab2014-04-26 16:26:41 +0000324 // Flag the type unit reference as a declaration so that if it contains
325 // members (implicit special members, static data member definitions, member
326 // declarations for definitions in this CU, etc) consumers don't get confused
327 // and think this is a full definition.
328 addFlag(Die, dwarf::DW_AT_declaration);
329
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000330 Die.addValue(DIEValueAllocator, dwarf::DW_AT_signature,
Peter Collingbourne7c384cc2016-02-11 19:57:46 +0000331 dwarf::DW_FORM_ref_sig8, DIEInteger(Signature));
David Blaikie47f615e2013-12-17 23:32:35 +0000332}
333
David Blaikie65a74662014-04-25 18:26:14 +0000334void DwarfUnit::addDIEEntry(DIE &Die, dwarf::Attribute Attribute,
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000335 DIEEntry Entry) {
Greg Clayton35630c32016-12-01 18:56:29 +0000336 const DIEUnit *CU = Die.getUnit();
337 const DIEUnit *EntryCU = Entry.getEntry().getUnit();
338 if (!CU)
Manman Ren4dbdc902013-10-31 17:54:35 +0000339 // We assume that Die belongs to this CU, if it is not linked to any CU yet.
Greg Clayton35630c32016-12-01 18:56:29 +0000340 CU = getUnitDie().getUnit();
Manman Ren4dbdc902013-10-31 17:54:35 +0000341 if (!EntryCU)
Greg Clayton35630c32016-12-01 18:56:29 +0000342 EntryCU = getUnitDie().getUnit();
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000343 Die.addValue(DIEValueAllocator, Attribute,
Greg Clayton35630c32016-12-01 18:56:29 +0000344 EntryCU == CU ? dwarf::DW_FORM_ref4 : dwarf::DW_FORM_ref_addr,
David Blaikie65a74662014-04-25 18:26:14 +0000345 Entry);
Devang Patel0e821f42011-04-12 23:21:44 +0000346}
347
Amjad Aboud293ee8b2016-04-29 16:07:55 +0000348DIE &DwarfUnit::createAndAddDIE(unsigned Tag, DIE &Parent, const DINode *N) {
Amjad Aboud72da9392016-04-30 01:44:07 +0000349 DIE &Die = Parent.addChild(DIE::get(DIEValueAllocator, (dwarf::Tag)Tag));
350 if (N)
351 insertDIE(N, &Die);
Manman Renb987e512013-10-29 00:53:03 +0000352 return Die;
353}
354
David Blaikie65a74662014-04-25 18:26:14 +0000355void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Loc) {
Eric Christopher8bdab432014-02-27 18:36:10 +0000356 Loc->ComputeSize(Asm);
Eric Christopher4a741042014-02-16 08:46:55 +0000357 DIELocs.push_back(Loc); // Memoize so we can call the destructor later on.
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000358 Die.addValue(DIEValueAllocator, Attribute,
359 Loc->BestForm(DD->getDwarfVersion()), Loc);
Eric Christopher4a741042014-02-16 08:46:55 +0000360}
361
David Blaikie65a74662014-04-25 18:26:14 +0000362void DwarfUnit::addBlock(DIE &Die, dwarf::Attribute Attribute,
Eric Christophera5a79422013-12-09 23:32:48 +0000363 DIEBlock *Block) {
Eric Christopher8bdab432014-02-27 18:36:10 +0000364 Block->ComputeSize(Asm);
Devang Patel0e821f42011-04-12 23:21:44 +0000365 DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +0000366 Die.addValue(DIEValueAllocator, Attribute, Block->BestForm(), Block);
Devang Patel0e821f42011-04-12 23:21:44 +0000367}
368
Paul Robinson612e89d2018-01-12 19:17:50 +0000369void DwarfUnit::addSourceLine(DIE &Die, unsigned Line, const DIFile *File) {
Devang Patel0e821f42011-04-12 23:21:44 +0000370 if (Line == 0)
371 return;
David Blaikie101613e2014-02-12 00:11:25 +0000372
Paul Robinson612e89d2018-01-12 19:17:50 +0000373 unsigned FileID = getOrCreateSourceID(File);
Devang Patel0e821f42011-04-12 23:21:44 +0000374 assert(FileID && "Invalid file id");
David Blaikief2443192013-10-21 17:28:37 +0000375 addUInt(Die, dwarf::DW_AT_decl_file, None, FileID);
376 addUInt(Die, dwarf::DW_AT_decl_line, None, Line);
Devang Patel0e821f42011-04-12 23:21:44 +0000377}
378
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000379void DwarfUnit::addSourceLine(DIE &Die, const DILocalVariable *V) {
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000380 assert(V);
David Blaikie101613e2014-02-12 00:11:25 +0000381
Paul Robinson612e89d2018-01-12 19:17:50 +0000382 addSourceLine(Die, V->getLine(), V->getFile());
David Blaikie101613e2014-02-12 00:11:25 +0000383}
384
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000385void DwarfUnit::addSourceLine(DIE &Die, const DIGlobalVariable *G) {
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000386 assert(G);
Devang Patel0e821f42011-04-12 23:21:44 +0000387
Paul Robinson612e89d2018-01-12 19:17:50 +0000388 addSourceLine(Die, G->getLine(), G->getFile());
Devang Patel0e821f42011-04-12 23:21:44 +0000389}
390
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000391void DwarfUnit::addSourceLine(DIE &Die, const DISubprogram *SP) {
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000392 assert(SP);
Eric Christopher7734ca22012-03-15 23:55:40 +0000393
Paul Robinson612e89d2018-01-12 19:17:50 +0000394 addSourceLine(Die, SP->getLine(), SP->getFile());
Devang Patel0e821f42011-04-12 23:21:44 +0000395}
396
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000397void DwarfUnit::addSourceLine(DIE &Die, const DIType *Ty) {
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000398 assert(Ty);
Devang Patel0e821f42011-04-12 23:21:44 +0000399
Paul Robinson612e89d2018-01-12 19:17:50 +0000400 addSourceLine(Die, Ty->getLine(), Ty->getFile());
Devang Patel0e821f42011-04-12 23:21:44 +0000401}
402
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000403void DwarfUnit::addSourceLine(DIE &Die, const DIObjCProperty *Ty) {
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000404 assert(Ty);
Eric Christopher70e1bd82012-03-29 08:42:56 +0000405
Paul Robinson612e89d2018-01-12 19:17:50 +0000406 addSourceLine(Die, Ty->getLine(), Ty->getFile());
Eric Christopher70e1bd82012-03-29 08:42:56 +0000407}
408
Devang Patel0e821f42011-04-12 23:21:44 +0000409/* Byref variables, in Blocks, are declared by the programmer as "SomeType
410 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
411 gives the variable VarName either the struct, or a pointer to the struct, as
412 its type. This is necessary for various behind-the-scenes things the
413 compiler needs to do with by-reference variables in Blocks.
414
415 However, as far as the original *programmer* is concerned, the variable
416 should still have type 'SomeType', as originally declared.
417
418 The function getBlockByrefType dives into the __Block_byref_x_VarName
419 struct to find the original type of the variable, which is then assigned to
420 the variable's Debug Information Entry as its real type. So far, so good.
421 However now the debugger will expect the variable VarName to have the type
422 SomeType. So we need the location attribute for the variable to be an
423 expression that explains to the debugger how to navigate through the
424 pointers and struct to find the actual variable of type SomeType.
425
426 The following function does just that. We start by getting
427 the "normal" location for the variable. This will be the location
428 of either the struct __Block_byref_x_VarName or the pointer to the
429 struct __Block_byref_x_VarName.
430
431 The struct will look something like:
432
433 struct __Block_byref_x_VarName {
434 ... <various fields>
435 struct __Block_byref_x_VarName *forwarding;
436 ... <various other fields>
437 SomeType VarName;
438 ... <maybe more fields>
439 };
440
441 If we are given the struct directly (as our starting point) we
442 need to tell the debugger to:
443
444 1). Add the offset of the forwarding field.
445
446 2). Follow that pointer to get the real __Block_byref_x_VarName
447 struct to use (the real one may have been copied onto the heap).
448
449 3). Add the offset for the field VarName, to find the actual variable.
450
451 If we started with a pointer to the struct, then we need to
452 dereference that pointer first, before the other steps.
453 Translating this into DWARF ops, we will need to append the following
454 to the current location description for the variable:
455
456 DW_OP_deref -- optional, if we start with a pointer
457 DW_OP_plus_uconst <forward_fld_offset>
458 DW_OP_deref
459 DW_OP_plus_uconst <varName_fld_offset>
460
461 That is what this function does. */
462
David Blaikie65a74662014-04-25 18:26:14 +0000463void DwarfUnit::addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
Eric Christophera5a79422013-12-09 23:32:48 +0000464 dwarf::Attribute Attribute,
465 const MachineLocation &Location) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000466 const DIType *Ty = DV.getType();
467 const DIType *TmpTy = Ty;
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000468 uint16_t Tag = Ty->getTag();
Devang Patel0e821f42011-04-12 23:21:44 +0000469 bool isPointer = false;
470
Eric Christopherbf2d23c2013-06-24 21:07:27 +0000471 StringRef varName = DV.getName();
Devang Patel0e821f42011-04-12 23:21:44 +0000472
473 if (Tag == dwarf::DW_TAG_pointer_type) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000474 auto *DTy = cast<DIDerivedType>(Ty);
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000475 TmpTy = resolve(DTy->getBaseType());
Devang Patel0e821f42011-04-12 23:21:44 +0000476 isPointer = true;
477 }
478
Devang Patel0e821f42011-04-12 23:21:44 +0000479 // Find the __forwarding field and the variable field in the __Block_byref
480 // struct.
Duncan P. N. Exon Smith6ac940d2015-07-24 18:17:17 +0000481 DINodeArray Fields = cast<DICompositeType>(TmpTy)->getElements();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000482 const DIDerivedType *varField = nullptr;
483 const DIDerivedType *forwardingField = nullptr;
Devang Patel0e821f42011-04-12 23:21:44 +0000484
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +0000485 for (unsigned i = 0, N = Fields.size(); i < N; ++i) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000486 auto *DT = cast<DIDerivedType>(Fields[i]);
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000487 StringRef fieldName = DT->getName();
Devang Patel0e821f42011-04-12 23:21:44 +0000488 if (fieldName == "__forwarding")
David Blaikie4f6bf27a2013-11-18 23:33:32 +0000489 forwardingField = DT;
Devang Patel0e821f42011-04-12 23:21:44 +0000490 else if (fieldName == varName)
David Blaikie4f6bf27a2013-11-18 23:33:32 +0000491 varField = DT;
Devang Patel0e821f42011-04-12 23:21:44 +0000492 }
493
494 // Get the offsets for the forwarding field and the variable field.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000495 unsigned forwardingFieldOffset = forwardingField->getOffsetInBits() >> 3;
496 unsigned varFieldOffset = varField->getOffsetInBits() >> 2;
Devang Patel0e821f42011-04-12 23:21:44 +0000497
498 // Decode the original location, and use that as the start of the byref
499 // variable's location.
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000500 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
Adrian Prantl956484b2017-03-20 21:35:09 +0000501 DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
Adrian Prantlc12cee32017-04-19 23:42:25 +0000502 if (Location.isIndirect())
503 DwarfExpr.setMemoryLocationKind();
Devang Patel0e821f42011-04-12 23:21:44 +0000504
Adrian Prantl2049c0d2017-08-02 15:22:17 +0000505 SmallVector<uint64_t, 6> Ops;
Devang Patel0e821f42011-04-12 23:21:44 +0000506 // If we started with a pointer to the __Block_byref... struct, then
507 // the first thing we need to do is dereference the pointer (DW_OP_deref).
508 if (isPointer)
Adrian Prantl956484b2017-03-20 21:35:09 +0000509 Ops.push_back(dwarf::DW_OP_deref);
Devang Patel0e821f42011-04-12 23:21:44 +0000510
511 // Next add the offset for the '__forwarding' field:
512 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
513 // adding the offset if it's 0.
514 if (forwardingFieldOffset > 0) {
Florian Hahnffc498d2017-06-14 13:14:38 +0000515 Ops.push_back(dwarf::DW_OP_plus_uconst);
Adrian Prantl956484b2017-03-20 21:35:09 +0000516 Ops.push_back(forwardingFieldOffset);
Devang Patel0e821f42011-04-12 23:21:44 +0000517 }
518
519 // Now dereference the __forwarding field to get to the real __Block_byref
520 // struct: DW_OP_deref.
Adrian Prantl956484b2017-03-20 21:35:09 +0000521 Ops.push_back(dwarf::DW_OP_deref);
Devang Patel0e821f42011-04-12 23:21:44 +0000522
523 // Now that we've got the real __Block_byref... struct, add the offset
524 // for the variable's field to get to the location of the actual variable:
525 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
526 if (varFieldOffset > 0) {
Florian Hahnffc498d2017-06-14 13:14:38 +0000527 Ops.push_back(dwarf::DW_OP_plus_uconst);
Adrian Prantl956484b2017-03-20 21:35:09 +0000528 Ops.push_back(varFieldOffset);
Devang Patel0e821f42011-04-12 23:21:44 +0000529 }
Adrian Prantl956484b2017-03-20 21:35:09 +0000530
531 DIExpressionCursor Cursor(Ops);
532 const TargetRegisterInfo &TRI = *Asm->MF->getSubtarget().getRegisterInfo();
Adrian Prantlc12cee32017-04-19 23:42:25 +0000533 if (!DwarfExpr.addMachineRegExpression(TRI, Cursor, Location.getReg()))
Adrian Prantl956484b2017-03-20 21:35:09 +0000534 return;
535 DwarfExpr.addExpression(std::move(Cursor));
Devang Patel0e821f42011-04-12 23:21:44 +0000536
537 // Now attach the location information to the DIE.
Adrian Prantl956484b2017-03-20 21:35:09 +0000538 addBlock(Die, Attribute, DwarfExpr.finalize());
Devang Patel0e821f42011-04-12 23:21:44 +0000539}
540
Manman Renb3388602013-10-05 01:43:03 +0000541/// Return true if type encoding is unsigned.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000542static bool isUnsignedDIType(DwarfDebug *DD, const DIType *Ty) {
Duncan P. N. Exon Smith89c5e6ff2015-07-24 19:42:12 +0000543 if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
544 // FIXME: Enums without a fixed underlying type have unknown signedness
545 // here, leading to incorrectly emitted constants.
546 if (CTy->getTag() == dwarf::DW_TAG_enumeration_type)
547 return false;
548
549 // (Pieces of) aggregate types that get hacked apart by SROA may be
550 // represented by a constant. Encode them as unsigned bytes.
551 return true;
552 }
553
554 if (auto *DTy = dyn_cast<DIDerivedType>(Ty)) {
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000555 dwarf::Tag T = (dwarf::Tag)Ty->getTag();
David Blaikie2af1c802014-05-20 18:21:51 +0000556 // Encode pointer constants as unsigned bytes. This is used at least for
David Blaikie93ef46b2014-05-20 21:40:13 +0000557 // null pointer constant emission.
558 // FIXME: reference and rvalue_reference /probably/ shouldn't be allowed
559 // here, but accept them for now due to a bug in SROA producing bogus
560 // dbg.values.
Duncan P. N. Exon Smith89c5e6ff2015-07-24 19:42:12 +0000561 if (T == dwarf::DW_TAG_pointer_type ||
David Blaikie93ef46b2014-05-20 21:40:13 +0000562 T == dwarf::DW_TAG_ptr_to_member_type ||
563 T == dwarf::DW_TAG_reference_type ||
Duncan P. N. Exon Smith89c5e6ff2015-07-24 19:42:12 +0000564 T == dwarf::DW_TAG_rvalue_reference_type)
David Blaikie2af1c802014-05-20 18:21:51 +0000565 return true;
566 assert(T == dwarf::DW_TAG_typedef || T == dwarf::DW_TAG_const_type ||
567 T == dwarf::DW_TAG_volatile_type ||
Victor Leschuke1156c22016-10-31 19:09:38 +0000568 T == dwarf::DW_TAG_restrict_type || T == dwarf::DW_TAG_atomic_type);
Duncan P. N. Exon Smith89c5e6ff2015-07-24 19:42:12 +0000569 DITypeRef Deriv = DTy->getBaseType();
570 assert(Deriv && "Expected valid base type");
571 return isUnsignedDIType(DD, DD->resolve(Deriv));
David Blaikiee0f14742014-05-11 17:04:05 +0000572 }
Manman Renb3388602013-10-05 01:43:03 +0000573
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000574 auto *BTy = cast<DIBasicType>(Ty);
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000575 unsigned Encoding = BTy->getEncoding();
Saleem Abdulrasoolfba09d42014-05-12 06:08:18 +0000576 assert((Encoding == dwarf::DW_ATE_unsigned ||
577 Encoding == dwarf::DW_ATE_unsigned_char ||
578 Encoding == dwarf::DW_ATE_signed ||
579 Encoding == dwarf::DW_ATE_signed_char ||
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000580 Encoding == dwarf::DW_ATE_float || Encoding == dwarf::DW_ATE_UTF ||
581 Encoding == dwarf::DW_ATE_boolean ||
582 (Ty->getTag() == dwarf::DW_TAG_unspecified_type &&
583 Ty->getName() == "decltype(nullptr)")) &&
David Blaikiec405c9c2014-05-16 21:53:09 +0000584 "Unsupported encoding");
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000585 return Encoding == dwarf::DW_ATE_unsigned ||
586 Encoding == dwarf::DW_ATE_unsigned_char ||
587 Encoding == dwarf::DW_ATE_UTF || Encoding == dwarf::DW_ATE_boolean ||
588 Ty->getTag() == dwarf::DW_TAG_unspecified_type;
Manman Renb3388602013-10-05 01:43:03 +0000589}
590
David Blaikie65a74662014-04-25 18:26:14 +0000591void DwarfUnit::addConstantFPValue(DIE &Die, const MachineOperand &MO) {
Eric Christopherc2697f82013-10-19 01:04:47 +0000592 assert(MO.isFPImm() && "Invalid machine operand!");
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000593 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
Devang Patel0e821f42011-04-12 23:21:44 +0000594 APFloat FPImm = MO.getFPImm()->getValueAPF();
595
596 // Get the raw data form of the floating point.
597 const APInt FltVal = FPImm.bitcastToAPInt();
Eric Christopherc2697f82013-10-19 01:04:47 +0000598 const char *FltPtr = (const char *)FltVal.getRawData();
Devang Patel0e821f42011-04-12 23:21:44 +0000599
600 int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000601 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
Devang Patel0e821f42011-04-12 23:21:44 +0000602 int Incr = (LittleEndian ? 1 : -1);
603 int Start = (LittleEndian ? 0 : NumBytes - 1);
604 int Stop = (LittleEndian ? NumBytes : -1);
605
606 // Output the constant to DWARF one byte at a time.
607 for (; Start != Stop; Start += Incr)
David Blaikie65a74662014-04-25 18:26:14 +0000608 addUInt(*Block, dwarf::DW_FORM_data1, (unsigned char)0xFF & FltPtr[Start]);
Devang Patel0e821f42011-04-12 23:21:44 +0000609
David Blaikief2443192013-10-21 17:28:37 +0000610 addBlock(Die, dwarf::DW_AT_const_value, Block);
Devang Patel0e821f42011-04-12 23:21:44 +0000611}
612
David Blaikie65a74662014-04-25 18:26:14 +0000613void DwarfUnit::addConstantFPValue(DIE &Die, const ConstantFP *CFP) {
Eric Christopher9d1daa82013-08-27 23:49:04 +0000614 // Pass this down to addConstantValue as an unsigned bag of bits.
615 addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
David Blaikiea39a76e2013-01-20 01:18:01 +0000616}
617
Duncan P. N. Exon Smith9928a902015-04-20 18:52:06 +0000618void DwarfUnit::addConstantValue(DIE &Die, const ConstantInt *CI,
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000619 const DIType *Ty) {
David Blaikiec0a28412014-05-11 15:56:59 +0000620 addConstantValue(Die, CI->getValue(), Ty);
David Blaikiea39a76e2013-01-20 01:18:01 +0000621}
622
David Blaikiec05c8f42014-05-11 15:47:39 +0000623void DwarfUnit::addConstantValue(DIE &Die, const MachineOperand &MO,
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000624 const DIType *Ty) {
David Blaikiec05c8f42014-05-11 15:47:39 +0000625 assert(MO.isImm() && "Invalid machine operand!");
626
David Blaikie60cae1b2014-05-11 16:08:41 +0000627 addConstantValue(Die, isUnsignedDIType(DD, Ty), MO.getImm());
David Blaikiec05c8f42014-05-11 15:47:39 +0000628}
629
David Blaikie60cae1b2014-05-11 16:08:41 +0000630void DwarfUnit::addConstantValue(DIE &Die, bool Unsigned, uint64_t Val) {
David Blaikiec05c8f42014-05-11 15:47:39 +0000631 // FIXME: This is a bit conservative/simple - it emits negative values always
632 // sign extended to 64 bits rather than minimizing the number of bytes.
633 addUInt(Die, dwarf::DW_AT_const_value,
David Blaikie60cae1b2014-05-11 16:08:41 +0000634 Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata, Val);
David Blaikiec05c8f42014-05-11 15:47:39 +0000635}
636
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000637void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty) {
David Blaikiec0a28412014-05-11 15:56:59 +0000638 addConstantValue(Die, Val, isUnsignedDIType(DD, Ty));
639}
640
David Blaikie65a74662014-04-25 18:26:14 +0000641void DwarfUnit::addConstantValue(DIE &Die, const APInt &Val, bool Unsigned) {
David Blaikiea39a76e2013-01-20 01:18:01 +0000642 unsigned CIBitWidth = Val.getBitWidth();
Devang Patel8816bbc2011-05-28 00:39:18 +0000643 if (CIBitWidth <= 64) {
David Blaikie60cae1b2014-05-11 16:08:41 +0000644 addConstantValue(Die, Unsigned,
645 Unsigned ? Val.getZExtValue() : Val.getSExtValue());
Eric Christopher78fcf4902013-07-03 01:08:30 +0000646 return;
Devang Patel0e821f42011-04-12 23:21:44 +0000647 }
648
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000649 DIEBlock *Block = new (DIEValueAllocator) DIEBlock;
Devang Patel0e821f42011-04-12 23:21:44 +0000650
651 // Get the raw data form of the large APInt.
NAKAMURA Takumi29ccdd82011-10-28 14:12:22 +0000652 const uint64_t *Ptr64 = Val.getRawData();
Devang Patel0e821f42011-04-12 23:21:44 +0000653
654 int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
Micah Villmowcdfe20b2012-10-08 16:38:25 +0000655 bool LittleEndian = Asm->getDataLayout().isLittleEndian();
Devang Patel0e821f42011-04-12 23:21:44 +0000656
657 // Output the constant to DWARF one byte at a time.
NAKAMURA Takumi29ccdd82011-10-28 14:12:22 +0000658 for (int i = 0; i < NumBytes; i++) {
659 uint8_t c;
660 if (LittleEndian)
661 c = Ptr64[i / 8] >> (8 * (i & 7));
662 else
663 c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
David Blaikie65a74662014-04-25 18:26:14 +0000664 addUInt(*Block, dwarf::DW_FORM_data1, c);
NAKAMURA Takumi29ccdd82011-10-28 14:12:22 +0000665 }
Devang Patel0e821f42011-04-12 23:21:44 +0000666
David Blaikief2443192013-10-21 17:28:37 +0000667 addBlock(Die, dwarf::DW_AT_const_value, Block);
Devang Patel0e821f42011-04-12 23:21:44 +0000668}
669
Paul Robinson857b4432015-03-10 22:44:45 +0000670void DwarfUnit::addLinkageName(DIE &Die, StringRef LinkageName) {
Paul Robinson43d1e452016-04-18 22:41:41 +0000671 if (!LinkageName.empty())
Paul Robinson857b4432015-03-10 22:44:45 +0000672 addString(Die,
673 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name
674 : dwarf::DW_AT_MIPS_linkage_name,
Peter Collingbourne6f0ecca2017-05-16 00:39:01 +0000675 GlobalValue::dropLLVMManglingEscape(LinkageName));
Paul Robinson857b4432015-03-10 22:44:45 +0000676}
677
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000678void DwarfUnit::addTemplateParams(DIE &Buffer, DINodeArray TParams) {
Devang Patel0e821f42011-04-12 23:21:44 +0000679 // Add template parameters.
Duncan P. N. Exon Smith7c60f202015-04-18 00:35:36 +0000680 for (const auto *Element : TParams) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000681 if (auto *TTP = dyn_cast<DITemplateTypeParameter>(Element))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000682 constructTemplateTypeParameterDIE(Buffer, TTP);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000683 else if (auto *TVP = dyn_cast<DITemplateValueParameter>(Element))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000684 constructTemplateValueParameterDIE(Buffer, TVP);
Devang Patel0e821f42011-04-12 23:21:44 +0000685 }
Devang Patel0e821f42011-04-12 23:21:44 +0000686}
Nick Lewycky654f5ce2011-10-26 22:55:33 +0000687
Adrian Prantl1d12b882017-04-26 22:56:44 +0000688/// Add thrown types.
689void DwarfUnit::addThrownTypes(DIE &Die, DINodeArray ThrownTypes) {
690 for (const auto *Ty : ThrownTypes) {
691 DIE &TT = createAndAddDIE(dwarf::DW_TAG_thrown_type, Die);
692 addType(TT, cast<DIType>(Ty));
693 }
694}
695
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000696DIE *DwarfUnit::getOrCreateContextDIE(const DIScope *Context) {
697 if (!Context || isa<DIFile>(Context))
David Blaikieadcde362014-04-25 18:35:57 +0000698 return &getUnitDie();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000699 if (auto *T = dyn_cast<DIType>(Context))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000700 return getOrCreateTypeDIE(T);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000701 if (auto *NS = dyn_cast<DINamespace>(Context))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000702 return getOrCreateNameSpace(NS);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000703 if (auto *SP = dyn_cast<DISubprogram>(Context))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000704 return getOrCreateSubprogramDIE(SP);
Adrian Prantld2095002015-09-10 17:13:58 +0000705 if (auto *M = dyn_cast<DIModule>(Context))
706 return getOrCreateModule(M);
Adrian Prantl7d828bb2013-11-15 21:05:09 +0000707 return getDIE(Context);
Eric Christopher4d23a4a2013-01-16 01:22:23 +0000708}
709
David Blaikiea0e3c752017-02-03 00:44:18 +0000710DIE *DwarfTypeUnit::createTypeDIE(const DICompositeType *Ty) {
Duncan P. N. Exon Smithbe9e4fe2015-04-20 18:32:29 +0000711 auto *Context = resolve(Ty->getScope());
David Blaikie9d861be2013-11-26 00:15:27 +0000712 DIE *ContextDIE = getOrCreateContextDIE(Context);
David Blaikie409dd9c2013-11-19 23:08:21 +0000713
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000714 if (DIE *TyDIE = getDIE(Ty))
David Blaikie409dd9c2013-11-19 23:08:21 +0000715 return TyDIE;
716
717 // Create new type.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000718 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
David Blaikie409dd9c2013-11-19 23:08:21 +0000719
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000720 constructTypeDIE(TyDIE, cast<DICompositeType>(Ty));
David Blaikie409dd9c2013-11-19 23:08:21 +0000721
Adrian Prantl19aadf52017-03-13 22:56:14 +0000722 updateAcceleratorTables(Context, Ty, TyDIE);
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000723 return &TyDIE;
David Blaikie409dd9c2013-11-19 23:08:21 +0000724}
725
David Blaikied51dea62015-07-01 18:07:16 +0000726DIE *DwarfUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
David Blaikie32887552013-11-14 22:25:02 +0000727 if (!TyNode)
Craig Topper353eda42014-04-24 06:44:33 +0000728 return nullptr;
Manman Renf4c339e2013-10-29 22:49:29 +0000729
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000730 auto *Ty = cast<DIType>(TyNode);
David Blaikie32887552013-11-14 22:25:02 +0000731
David Blaikieee11f222014-04-12 05:35:59 +0000732 // DW_TAG_restrict_type is not supported in DWARF2
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000733 if (Ty->getTag() == dwarf::DW_TAG_restrict_type && DD->getDwarfVersion() <= 2)
David Blaikied51dea62015-07-01 18:07:16 +0000734 return getOrCreateTypeDIE(resolve(cast<DIDerivedType>(Ty)->getBaseType()));
David Blaikieee11f222014-04-12 05:35:59 +0000735
Victor Leschuke1156c22016-10-31 19:09:38 +0000736 // DW_TAG_atomic_type is not supported in DWARF < 5
737 if (Ty->getTag() == dwarf::DW_TAG_atomic_type && DD->getDwarfVersion() < 5)
738 return getOrCreateTypeDIE(resolve(cast<DIDerivedType>(Ty)->getBaseType()));
739
Manman Renf4c339e2013-10-29 22:49:29 +0000740 // Construct the context before querying for the existence of the DIE in case
741 // such construction creates the DIE.
Duncan P. N. Exon Smithbe9e4fe2015-04-20 18:32:29 +0000742 auto *Context = resolve(Ty->getScope());
Amjad Aboud72da9392016-04-30 01:44:07 +0000743 DIE *ContextDIE = getOrCreateContextDIE(Context);
744 assert(ContextDIE);
Manman Renf4c339e2013-10-29 22:49:29 +0000745
David Blaikie65a74662014-04-25 18:26:14 +0000746 if (DIE *TyDIE = getDIE(Ty))
Devang Patel0e821f42011-04-12 23:21:44 +0000747 return TyDIE;
748
Amjad Aboud72da9392016-04-30 01:44:07 +0000749 // Create new type.
750 DIE &TyDIE = createAndAddDIE(Ty->getTag(), *ContextDIE, Ty);
Manman Renf4c339e2013-10-29 22:49:29 +0000751
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000752 updateAcceleratorTables(Context, Ty, TyDIE);
David Blaikiec3d9e9e2014-03-06 01:42:00 +0000753
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000754 if (auto *BT = dyn_cast<DIBasicType>(Ty))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000755 constructTypeDIE(TyDIE, BT);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000756 else if (auto *STy = dyn_cast<DISubroutineType>(Ty))
Duncan P. N. Exon Smith698df362015-04-20 21:04:33 +0000757 constructTypeDIE(TyDIE, STy);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000758 else if (auto *CTy = dyn_cast<DICompositeType>(Ty)) {
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000759 if (GenerateDwarfTypeUnits && !Ty->isForwardDecl())
760 if (MDString *TypeId = CTy->getRawIdentifier()) {
David Blaikie15632ae2014-02-12 00:31:30 +0000761 DD->addDwarfTypeUnitType(getCU(), TypeId->getString(), TyDIE, CTy);
Adrian Prantle2da17f2014-03-14 23:08:17 +0000762 // Skip updating the accelerator tables since this is not the full type.
David Blaikie65a74662014-04-25 18:26:14 +0000763 return &TyDIE;
David Blaikiecfb21152014-01-03 18:59:42 +0000764 }
David Blaikie65a74662014-04-25 18:26:14 +0000765 constructTypeDIE(TyDIE, CTy);
David Blaikie8a263cb2013-11-26 00:22:37 +0000766 } else {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000767 constructTypeDIE(TyDIE, cast<DIDerivedType>(Ty));
Devang Patel0e821f42011-04-12 23:21:44 +0000768 }
David Blaikie2ea848b2013-11-19 22:51:04 +0000769
David Blaikie65a74662014-04-25 18:26:14 +0000770 return &TyDIE;
David Blaikie2ea848b2013-11-19 22:51:04 +0000771}
772
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000773void DwarfUnit::updateAcceleratorTables(const DIScope *Context,
774 const DIType *Ty, const DIE &TyDIE) {
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000775 if (!Ty->getName().empty() && !Ty->isForwardDecl()) {
Eugene Zelenko1804a772016-08-25 00:45:04 +0000776 bool IsImplementation = false;
Duncan P. N. Exon Smithacd8cf82015-07-24 20:45:26 +0000777 if (auto *CT = dyn_cast<DICompositeType>(Ty)) {
Eric Christopher8ea8e4f2012-01-06 23:03:37 +0000778 // A runtime language of 0 actually means C/C++ and that any
779 // non-negative value is some version of Objective-C/C++.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000780 IsImplementation = CT->getRuntimeLang() == 0 || CT->isObjcClassComplete();
Eric Christopher21bde872012-01-06 04:35:23 +0000781 }
Eric Christophercf7289f2013-09-05 18:20:16 +0000782 unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000783 DD->addAccelType(Ty->getName(), TyDIE, Flags);
David Blaikie9d861be2013-11-26 00:15:27 +0000784
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000785 if (!Context || isa<DICompileUnit>(Context) || isa<DIFile>(Context) ||
786 isa<DINamespace>(Context))
David Blaikie98cf1722014-11-02 06:06:14 +0000787 addGlobalType(Ty, TyDIE, Context);
Eric Christopher21bde872012-01-06 04:35:23 +0000788 }
Devang Patel0e821f42011-04-12 23:21:44 +0000789}
790
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000791void DwarfUnit::addType(DIE &Entity, const DIType *Ty,
Duncan P. N. Exon Smith9928a902015-04-20 18:52:06 +0000792 dwarf::Attribute Attribute) {
Eric Christopher0df08e22013-08-08 07:40:37 +0000793 assert(Ty && "Trying to add a type that doesn't exist?");
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +0000794 addDIEEntry(Entity, Attribute, DIEEntry(*getOrCreateTypeDIE(Ty)));
Devang Patel1cb8ab42011-05-31 23:30:30 +0000795}
796
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000797std::string DwarfUnit::getParentContextString(const DIScope *Context) const {
Eric Christopher2c8b7902013-10-17 02:06:06 +0000798 if (!Context)
799 return "";
800
801 // FIXME: Decide whether to implement this for non-C++ languages.
802 if (getLanguage() != dwarf::DW_LANG_C_plus_plus)
803 return "";
804
Eric Christopher8dba0d52013-10-19 01:04:42 +0000805 std::string CS;
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000806 SmallVector<const DIScope *, 1> Parents;
807 while (!isa<DICompileUnit>(Context)) {
Eric Christopher2c8b7902013-10-17 02:06:06 +0000808 Parents.push_back(Context);
Duncan P. N. Exon Smithb273d062015-04-16 01:37:00 +0000809 if (Context->getScope())
810 Context = resolve(Context->getScope());
Eric Christopher2c8b7902013-10-17 02:06:06 +0000811 else
812 // Structure, etc types will have a NULL context if they're at the top
813 // level.
814 break;
815 }
816
817 // Reverse iterate over our list to go from the outermost construct to the
818 // innermost.
Pete Cooper7679afd2015-07-24 21:13:43 +0000819 for (const DIScope *Ctx : make_range(Parents.rbegin(), Parents.rend())) {
Duncan P. N. Exon Smithb273d062015-04-16 01:37:00 +0000820 StringRef Name = Ctx->getName();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000821 if (Name.empty() && isa<DINamespace>(Ctx))
David Blaikie553eb4a2014-06-06 22:16:56 +0000822 Name = "(anonymous namespace)";
Eric Christopher8dba0d52013-10-19 01:04:42 +0000823 if (!Name.empty()) {
Eric Christopher2c8b7902013-10-17 02:06:06 +0000824 CS += Name;
825 CS += "::";
826 }
827 }
828 return CS;
Devang Patel0e821f42011-04-12 23:21:44 +0000829}
830
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000831void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIBasicType *BTy) {
Devang Patel0e821f42011-04-12 23:21:44 +0000832 // Get core information.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000833 StringRef Name = BTy->getName();
Devang Patel0e821f42011-04-12 23:21:44 +0000834 // Add name if not anonymous or intermediate type.
835 if (!Name.empty())
David Blaikie65a74662014-04-25 18:26:14 +0000836 addString(Buffer, dwarf::DW_AT_name, Name);
Devang Patel04d6d472011-09-14 23:13:28 +0000837
David Blaikiefac56122013-10-04 23:21:16 +0000838 // An unspecified type only has a name attribute.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000839 if (BTy->getTag() == dwarf::DW_TAG_unspecified_type)
Devang Patel04d6d472011-09-14 23:13:28 +0000840 return;
Devang Patel04d6d472011-09-14 23:13:28 +0000841
David Blaikie65a74662014-04-25 18:26:14 +0000842 addUInt(Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000843 BTy->getEncoding());
Devang Patel04d6d472011-09-14 23:13:28 +0000844
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000845 uint64_t Size = BTy->getSizeInBits() >> 3;
David Blaikie65a74662014-04-25 18:26:14 +0000846 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
Devang Patel0e821f42011-04-12 23:21:44 +0000847}
848
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000849void DwarfUnit::constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy) {
Devang Patel0e821f42011-04-12 23:21:44 +0000850 // Get core information.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000851 StringRef Name = DTy->getName();
852 uint64_t Size = DTy->getSizeInBits() >> 3;
David Blaikiefac56122013-10-04 23:21:16 +0000853 uint16_t Tag = Buffer.getTag();
Devang Patel0e821f42011-04-12 23:21:44 +0000854
855 // Map to main type, void will not have a type.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000856 const DIType *FromTy = resolve(DTy->getBaseType());
Eric Christopher0df08e22013-08-08 07:40:37 +0000857 if (FromTy)
David Blaikie65a74662014-04-25 18:26:14 +0000858 addType(Buffer, FromTy);
Devang Patel0e821f42011-04-12 23:21:44 +0000859
860 // Add name if not anonymous or intermediate type.
861 if (!Name.empty())
David Blaikie65a74662014-04-25 18:26:14 +0000862 addString(Buffer, dwarf::DW_AT_name, Name);
Devang Patel0e821f42011-04-12 23:21:44 +0000863
864 // Add size if non-zero (derived types might be zero-sized.)
Adrian Prantl3026a542014-12-24 01:17:51 +0000865 if (Size && Tag != dwarf::DW_TAG_pointer_type
Keno Fischerb011c632015-11-16 07:57:32 +0000866 && Tag != dwarf::DW_TAG_ptr_to_member_type
867 && Tag != dwarf::DW_TAG_reference_type
868 && Tag != dwarf::DW_TAG_rvalue_reference_type)
David Blaikie65a74662014-04-25 18:26:14 +0000869 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
Devang Patel0e821f42011-04-12 23:21:44 +0000870
David Blaikie5d3249b2013-01-07 05:51:15 +0000871 if (Tag == dwarf::DW_TAG_ptr_to_member_type)
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +0000872 addDIEEntry(
873 Buffer, dwarf::DW_AT_containing_type,
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000874 *getOrCreateTypeDIE(resolve(cast<DIDerivedType>(DTy)->getClassType())));
Devang Patel0e821f42011-04-12 23:21:44 +0000875 // Add source line info if available and TyDesc is not a forward declaration.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000876 if (!DTy->isForwardDecl())
David Blaikie65a74662014-04-25 18:26:14 +0000877 addSourceLine(Buffer, DTy);
Konstantin Zhuravlyovd5561e02017-03-08 23:55:44 +0000878
879 // If DWARF address space value is other than None, add it for pointer and
880 // reference types as DW_AT_address_class.
881 if (DTy->getDWARFAddressSpace() && (Tag == dwarf::DW_TAG_pointer_type ||
882 Tag == dwarf::DW_TAG_reference_type))
883 addUInt(Buffer, dwarf::DW_AT_address_class, dwarf::DW_FORM_data4,
884 DTy->getDWARFAddressSpace().getValue());
Devang Patel0e821f42011-04-12 23:21:44 +0000885}
886
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000887void DwarfUnit::constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args) {
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +0000888 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000889 const DIType *Ty = resolve(Args[i]);
Manman Renf93ac4b2014-07-29 18:20:39 +0000890 if (!Ty) {
Adrian Prantl69140d22014-02-25 22:27:14 +0000891 assert(i == N-1 && "Unspecified parameter must be the last argument");
892 createAndAddDIE(dwarf::DW_TAG_unspecified_parameters, Buffer);
893 } else {
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000894 DIE &Arg = createAndAddDIE(dwarf::DW_TAG_formal_parameter, Buffer);
David Blaikiedf1cca32014-10-26 23:37:04 +0000895 addType(Arg, Ty);
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000896 if (Ty->isArtificial())
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000897 addFlag(Arg, dwarf::DW_AT_artificial);
Adrian Prantl3f49c892014-02-25 19:57:42 +0000898 }
Adrian Prantl69140d22014-02-25 22:27:14 +0000899 }
Adrian Prantl3f49c892014-02-25 19:57:42 +0000900}
901
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000902void DwarfUnit::constructTypeDIE(DIE &Buffer, const DISubroutineType *CTy) {
Duncan P. N. Exon Smith698df362015-04-20 21:04:33 +0000903 // Add return type. A void return won't have a type.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000904 auto Elements = cast<DISubroutineType>(CTy)->getTypeArray();
Duncan P. N. Exon Smith698df362015-04-20 21:04:33 +0000905 if (Elements.size())
906 if (auto RTy = resolve(Elements[0]))
907 addType(Buffer, RTy);
908
909 bool isPrototyped = true;
910 if (Elements.size() == 2 && !Elements[1])
911 isPrototyped = false;
912
913 constructSubprogramArguments(Buffer, Elements);
914
915 // Add prototype flag if we're dealing with a C language and the function has
916 // been prototyped.
917 uint16_t Language = getLanguage();
918 if (isPrototyped &&
919 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
920 Language == dwarf::DW_LANG_ObjC))
921 addFlag(Buffer, dwarf::DW_AT_prototyped);
922
Reid Klecknerde3d8b52016-06-08 20:34:29 +0000923 // Add a DW_AT_calling_convention if this has an explicit convention.
924 if (CTy->getCC() && CTy->getCC() != dwarf::DW_CC_normal)
925 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
926 CTy->getCC());
927
Duncan P. N. Exon Smith698df362015-04-20 21:04:33 +0000928 if (CTy->isLValueReference())
929 addFlag(Buffer, dwarf::DW_AT_reference);
930
931 if (CTy->isRValueReference())
932 addFlag(Buffer, dwarf::DW_AT_rvalue_reference);
933}
934
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000935void DwarfUnit::constructTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
David Blaikie409dd9c2013-11-19 23:08:21 +0000936 // Add name if not anonymous or intermediate type.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000937 StringRef Name = CTy->getName();
Devang Patel0e821f42011-04-12 23:21:44 +0000938
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000939 uint64_t Size = CTy->getSizeInBits() >> 3;
David Blaikiefac56122013-10-04 23:21:16 +0000940 uint16_t Tag = Buffer.getTag();
Devang Patel0e821f42011-04-12 23:21:44 +0000941
942 switch (Tag) {
Devang Patel0e821f42011-04-12 23:21:44 +0000943 case dwarf::DW_TAG_array_type:
Eric Christopherdf9955d2013-11-11 18:52:31 +0000944 constructArrayTypeDIE(Buffer, CTy);
Devang Patel0e821f42011-04-12 23:21:44 +0000945 break;
Eric Christopheraeb105f2013-11-11 18:52:39 +0000946 case dwarf::DW_TAG_enumeration_type:
947 constructEnumTypeDIE(Buffer, CTy);
948 break;
Adrian Prantl8c599212018-02-06 23:45:59 +0000949 case dwarf::DW_TAG_variant_part:
Devang Patel0e821f42011-04-12 23:21:44 +0000950 case dwarf::DW_TAG_structure_type:
951 case dwarf::DW_TAG_union_type:
952 case dwarf::DW_TAG_class_type: {
Adrian Prantl8c599212018-02-06 23:45:59 +0000953 // Emit the discriminator for a variant part.
954 DIDerivedType *Discriminator = nullptr;
955 if (Tag == dwarf::DW_TAG_variant_part) {
956 Discriminator = CTy->getDiscriminator();
957 if (Discriminator) {
958 // DWARF says:
959 // If the variant part has a discriminant, the discriminant is
960 // represented by a separate debugging information entry which is
961 // a child of the variant part entry.
962 DIE &DiscMember = constructMemberDIE(Buffer, Discriminator);
963 addDIEEntry(Buffer, dwarf::DW_AT_discr, DiscMember);
964 }
965 }
966
Devang Patel0e821f42011-04-12 23:21:44 +0000967 // Add elements to structure type.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000968 DINodeArray Elements = CTy->getElements();
Duncan P. N. Exon Smith7c60f202015-04-18 00:35:36 +0000969 for (const auto *Element : Elements) {
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000970 if (!Element)
971 continue;
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000972 if (auto *SP = dyn_cast<DISubprogram>(Element))
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +0000973 getOrCreateSubprogramDIE(SP);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000974 else if (auto *DDTy = dyn_cast<DIDerivedType>(Element)) {
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000975 if (DDTy->getTag() == dwarf::DW_TAG_friend) {
David Blaikieb0b3fcf2014-04-25 18:52:29 +0000976 DIE &ElemDie = createAndAddDIE(dwarf::DW_TAG_friend, Buffer);
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +0000977 addType(ElemDie, resolve(DDTy->getBaseType()), dwarf::DW_AT_friend);
978 } else if (DDTy->isStaticMember()) {
Manman Ren57e6ff72013-10-23 22:57:12 +0000979 getOrCreateStaticMemberDIE(DDTy);
Adrian Prantl8c599212018-02-06 23:45:59 +0000980 } else if (Tag == dwarf::DW_TAG_variant_part) {
981 // When emitting a variant part, wrap each member in
982 // DW_TAG_variant.
983 DIE &Variant = createAndAddDIE(dwarf::DW_TAG_variant, Buffer);
984 if (const ConstantInt *CI =
985 dyn_cast_or_null<ConstantInt>(DDTy->getDiscriminantValue())) {
986 if (isUnsignedDIType(DD, resolve(Discriminator->getBaseType())))
987 addUInt(Variant, dwarf::DW_AT_discr_value, None, CI->getZExtValue());
988 else
989 addSInt(Variant, dwarf::DW_AT_discr_value, None, CI->getSExtValue());
990 }
991 constructMemberDIE(Variant, DDTy);
Manman Renc6b63922013-10-14 20:33:57 +0000992 } else {
Manman Ren230ec862013-10-23 23:00:44 +0000993 constructMemberDIE(Buffer, DDTy);
Manman Renc6b63922013-10-14 20:33:57 +0000994 }
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000995 } else if (auto *Property = dyn_cast<DIObjCProperty>(Element)) {
Duncan P. N. Exon Smithde8e4272015-04-14 01:46:44 +0000996 DIE &ElemDie = createAndAddDIE(Property->getTag(), Buffer);
997 StringRef PropertyName = Property->getName();
Devang Pateld925d1a2012-02-07 23:33:58 +0000998 addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
Duncan P. N. Exon Smithde8e4272015-04-14 01:46:44 +0000999 if (Property->getType())
Adrian Prantl8ff53b32015-06-15 23:18:03 +00001000 addType(ElemDie, resolve(Property->getType()));
Eric Christopherd42b92f2012-05-22 18:45:24 +00001001 addSourceLine(ElemDie, Property);
Duncan P. N. Exon Smithde8e4272015-04-14 01:46:44 +00001002 StringRef GetterName = Property->getGetterName();
Devang Pateld925d1a2012-02-07 23:33:58 +00001003 if (!GetterName.empty())
1004 addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
Duncan P. N. Exon Smithde8e4272015-04-14 01:46:44 +00001005 StringRef SetterName = Property->getSetterName();
Devang Pateld925d1a2012-02-07 23:33:58 +00001006 if (!SetterName.empty())
1007 addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
Duncan P. N. Exon Smithde8e4272015-04-14 01:46:44 +00001008 if (unsigned PropertyAttributes = Property->getAttributes())
David Blaikief2443192013-10-21 17:28:37 +00001009 addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, None,
Eric Christopherc2697f82013-10-19 01:04:47 +00001010 PropertyAttributes);
Adrian Prantl8c599212018-02-06 23:45:59 +00001011 } else if (auto *Composite = dyn_cast<DICompositeType>(Element)) {
1012 if (Composite->getTag() == dwarf::DW_TAG_variant_part) {
1013 DIE &VariantPart = createAndAddDIE(Composite->getTag(), Buffer);
1014 constructTypeDIE(VariantPart, Composite);
1015 }
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +00001016 }
Devang Patel0e821f42011-04-12 23:21:44 +00001017 }
1018
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001019 if (CTy->isAppleBlockExtension())
David Blaikie65a74662014-04-25 18:26:14 +00001020 addFlag(Buffer, dwarf::DW_AT_APPLE_block);
Devang Patel0e821f42011-04-12 23:21:44 +00001021
Adrian Prantlcf44e782014-12-19 00:01:20 +00001022 // This is outside the DWARF spec, but GDB expects a DW_AT_containing_type
1023 // inside C++ composite types to point to the base class with the vtable.
Adrian Prantla8e56452017-11-08 22:04:43 +00001024 // Rust uses DW_AT_containing_type to link a vtable to the type
1025 // for which it was created.
1026 if (auto *ContainingType = resolve(CTy->getVTableHolder()))
David Blaikie65a74662014-04-25 18:26:14 +00001027 addDIEEntry(Buffer, dwarf::DW_AT_containing_type,
David Blaikie8dbcc3f2014-04-25 19:33:43 +00001028 *getOrCreateTypeDIE(ContainingType));
Devang Patel0e821f42011-04-12 23:21:44 +00001029
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001030 if (CTy->isObjcClassComplete())
David Blaikie65a74662014-04-25 18:26:14 +00001031 addFlag(Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
Devang Patel2409e782011-05-12 19:06:16 +00001032
Eric Christopherda011dd2011-12-16 23:42:42 +00001033 // Add template parameters to a class, structure or union types.
1034 // FIXME: The support isn't in the metadata for this yet.
1035 if (Tag == dwarf::DW_TAG_class_type ||
Eric Christopherc2697f82013-10-19 01:04:47 +00001036 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001037 addTemplateParams(Buffer, CTy->getTemplateParams());
Devang Patel0e821f42011-04-12 23:21:44 +00001038
Adrian Prantla29aac72018-01-05 01:13:37 +00001039 // Add the type's non-standard calling convention.
1040 uint8_t CC = 0;
1041 if (CTy->isTypePassByValue())
1042 CC = dwarf::DW_CC_pass_by_value;
1043 else if (CTy->isTypePassByReference())
1044 CC = dwarf::DW_CC_pass_by_reference;
1045 if (CC)
1046 addUInt(Buffer, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1,
1047 CC);
Devang Patel0e821f42011-04-12 23:21:44 +00001048 break;
1049 }
1050 default:
1051 break;
1052 }
1053
1054 // Add name if not anonymous or intermediate type.
1055 if (!Name.empty())
David Blaikie65a74662014-04-25 18:26:14 +00001056 addString(Buffer, dwarf::DW_AT_name, Name);
Devang Patel0e821f42011-04-12 23:21:44 +00001057
Eric Christopher775cbd22012-05-22 18:45:18 +00001058 if (Tag == dwarf::DW_TAG_enumeration_type ||
Eric Christopherc2697f82013-10-19 01:04:47 +00001059 Tag == dwarf::DW_TAG_class_type || Tag == dwarf::DW_TAG_structure_type ||
Eric Christopher775cbd22012-05-22 18:45:18 +00001060 Tag == dwarf::DW_TAG_union_type) {
Devang Patel0e821f42011-04-12 23:21:44 +00001061 // Add size if non-zero (derived types might be zero-sized.)
Eric Christopher1cf33382012-06-01 00:22:32 +00001062 // TODO: Do we care about size for enum forward declarations?
Devang Patel0e821f42011-04-12 23:21:44 +00001063 if (Size)
David Blaikie65a74662014-04-25 18:26:14 +00001064 addUInt(Buffer, dwarf::DW_AT_byte_size, None, Size);
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001065 else if (!CTy->isForwardDecl())
Devang Patel0e821f42011-04-12 23:21:44 +00001066 // Add zero size if it is not a forward declaration.
David Blaikie65a74662014-04-25 18:26:14 +00001067 addUInt(Buffer, dwarf::DW_AT_byte_size, None, 0);
Eric Christopher1cf33382012-06-01 00:22:32 +00001068
1069 // If we're a forward decl, say so.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001070 if (CTy->isForwardDecl())
David Blaikie65a74662014-04-25 18:26:14 +00001071 addFlag(Buffer, dwarf::DW_AT_declaration);
Devang Patel0e821f42011-04-12 23:21:44 +00001072
1073 // Add source line info if available.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001074 if (!CTy->isForwardDecl())
David Blaikie65a74662014-04-25 18:26:14 +00001075 addSourceLine(Buffer, CTy);
Eric Christopher54cf8ff2012-03-07 00:15:19 +00001076
1077 // No harm in adding the runtime language to the declaration.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001078 unsigned RLang = CTy->getRuntimeLang();
Eric Christopher54cf8ff2012-03-07 00:15:19 +00001079 if (RLang)
David Blaikie65a74662014-04-25 18:26:14 +00001080 addUInt(Buffer, dwarf::DW_AT_APPLE_runtime_class, dwarf::DW_FORM_data1,
Eric Christopherc2697f82013-10-19 01:04:47 +00001081 RLang);
Victor Leschuk3c989982016-10-26 11:59:03 +00001082
1083 // Add align info if available.
Victor Leschuka37660c2016-10-26 21:32:29 +00001084 if (uint32_t AlignInBytes = CTy->getAlignInBytes())
Victor Leschuk3c989982016-10-26 11:59:03 +00001085 addUInt(Buffer, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1086 AlignInBytes);
Devang Patel0e821f42011-04-12 23:21:44 +00001087 }
1088}
1089
Duncan P. N. Exon Smith60635e32015-04-21 18:44:06 +00001090void DwarfUnit::constructTemplateTypeParameterDIE(
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091 DIE &Buffer, const DITemplateTypeParameter *TP) {
David Blaikie65a74662014-04-25 18:26:14 +00001092 DIE &ParamDIE =
David Blaikieb0b3fcf2014-04-25 18:52:29 +00001093 createAndAddDIE(dwarf::DW_TAG_template_type_parameter, Buffer);
Eric Christopher056b6472013-08-08 08:09:43 +00001094 // Add the type if it exists, it could be void and therefore no type.
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001095 if (TP->getType())
1096 addType(ParamDIE, resolve(TP->getType()));
1097 if (!TP->getName().empty())
1098 addString(ParamDIE, dwarf::DW_AT_name, TP->getName());
Devang Patel0e821f42011-04-12 23:21:44 +00001099}
1100
Duncan P. N. Exon Smith60635e32015-04-21 18:44:06 +00001101void DwarfUnit::constructTemplateValueParameterDIE(
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001102 DIE &Buffer, const DITemplateValueParameter *VP) {
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001103 DIE &ParamDIE = createAndAddDIE(VP->getTag(), Buffer);
Eric Christopher0df08e22013-08-08 07:40:37 +00001104
1105 // Add the type if there is one, template template and template parameter
1106 // packs will not have a type.
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001107 if (VP->getTag() == dwarf::DW_TAG_template_value_parameter)
1108 addType(ParamDIE, resolve(VP->getType()));
1109 if (!VP->getName().empty())
1110 addString(ParamDIE, dwarf::DW_AT_name, VP->getName());
1111 if (Metadata *Val = VP->getValue()) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001112 if (ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(Val))
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001113 addConstantValue(ParamDIE, CI, resolve(VP->getType()));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001114 else if (GlobalValue *GV = mdconst::dyn_extract<GlobalValue>(Val)) {
David Majnemer28c36462016-07-09 20:47:48 +00001115 // We cannot describe the location of dllimport'd entities: the
1116 // computation of their address requires loads from the IAT.
1117 if (!GV->hasDLLImportStorageClass()) {
1118 // For declaration non-type template parameters (such as global values
1119 // and functions)
1120 DIELoc *Loc = new (DIEValueAllocator) DIELoc;
1121 addOpAddress(*Loc, Asm->getSymbol(GV));
1122 // Emit DW_OP_stack_value to use the address as the immediate value of
1123 // the parameter, rather than a pointer to it.
1124 addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1125 addBlock(ParamDIE, dwarf::DW_AT_location, Loc);
1126 }
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001127 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_template_param) {
David Blaikie2b380232013-06-22 18:59:11 +00001128 assert(isa<MDString>(Val));
1129 addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1130 cast<MDString>(Val)->getString());
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001131 } else if (VP->getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +00001132 addTemplateParams(ParamDIE, cast<MDTuple>(Val));
David Blaikiea1e813d2013-05-10 21:52:07 +00001133 }
1134 }
Devang Patel0e821f42011-04-12 23:21:44 +00001135}
1136
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001137DIE *DwarfUnit::getOrCreateNameSpace(const DINamespace *NS) {
Manman Renf6b936b2013-10-29 05:49:41 +00001138 // Construct the context before querying for the existence of the DIE in case
1139 // such construction creates the DIE.
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001140 DIE *ContextDIE = getOrCreateContextDIE(NS->getScope());
Manman Renf6b936b2013-10-29 05:49:41 +00001141
David Blaikie65a74662014-04-25 18:26:14 +00001142 if (DIE *NDie = getDIE(NS))
Devang Patel17b53272011-05-06 16:57:54 +00001143 return NDie;
David Blaikieb0b3fcf2014-04-25 18:52:29 +00001144 DIE &NDie = createAndAddDIE(dwarf::DW_TAG_namespace, *ContextDIE, NS);
Manman Renf6b936b2013-10-29 05:49:41 +00001145
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001146 StringRef Name = NS->getName();
David Blaikie553eb4a2014-06-06 22:16:56 +00001147 if (!Name.empty())
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001148 addString(NDie, dwarf::DW_AT_name, NS->getName());
David Blaikie553eb4a2014-06-06 22:16:56 +00001149 else
1150 Name = "(anonymous namespace)";
1151 DD->addAccelNamespace(Name, NDie);
Duncan P. N. Exon Smith20caafb2015-04-14 03:01:27 +00001152 addGlobalName(Name, NDie, NS->getScope());
Adrian Prantldbfda632016-11-03 19:42:02 +00001153 if (NS->getExportSymbols())
1154 addFlag(NDie, dwarf::DW_AT_export_symbols);
David Blaikie65a74662014-04-25 18:26:14 +00001155 return &NDie;
Devang Patel17b53272011-05-06 16:57:54 +00001156}
1157
Adrian Prantl08a388b2015-06-30 02:13:04 +00001158DIE *DwarfUnit::getOrCreateModule(const DIModule *M) {
1159 // Construct the context before querying for the existence of the DIE in case
1160 // such construction creates the DIE.
1161 DIE *ContextDIE = getOrCreateContextDIE(M->getScope());
1162
1163 if (DIE *MDie = getDIE(M))
1164 return MDie;
1165 DIE &MDie = createAndAddDIE(dwarf::DW_TAG_module, *ContextDIE, M);
1166
1167 if (!M->getName().empty()) {
1168 addString(MDie, dwarf::DW_AT_name, M->getName());
1169 addGlobalName(M->getName(), MDie, M->getScope());
1170 }
1171 if (!M->getConfigurationMacros().empty())
1172 addString(MDie, dwarf::DW_AT_LLVM_config_macros,
1173 M->getConfigurationMacros());
1174 if (!M->getIncludePath().empty())
1175 addString(MDie, dwarf::DW_AT_LLVM_include_path, M->getIncludePath());
1176 if (!M->getISysRoot().empty())
1177 addString(MDie, dwarf::DW_AT_LLVM_isysroot, M->getISysRoot());
1178
1179 return &MDie;
1180}
1181
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001182DIE *DwarfUnit::getOrCreateSubprogramDIE(const DISubprogram *SP, bool Minimal) {
David Blaikie309ffe42013-10-04 01:39:59 +00001183 // Construct the context before querying for the existence of the DIE in case
1184 // such construction creates the DIE (as is the case for member function
1185 // declarations).
David Blaikie3a443c22014-11-04 22:12:25 +00001186 DIE *ContextDIE =
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001187 Minimal ? &getUnitDie() : getOrCreateContextDIE(resolve(SP->getScope()));
Adrian Prantld486b342014-03-18 17:41:15 +00001188
David Blaikie65a74662014-04-25 18:26:14 +00001189 if (DIE *SPDie = getDIE(SP))
Devang Patel89543712011-08-15 17:24:54 +00001190 return SPDie;
1191
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001192 if (auto *SPDecl = SP->getDeclaration()) {
David Blaikie3a443c22014-11-04 22:12:25 +00001193 if (!Minimal) {
1194 // Add subprogram definitions to the CU die directly.
1195 ContextDIE = &getUnitDie();
1196 // Build the decl now to ensure it precedes the definition.
1197 getOrCreateSubprogramDIE(SPDecl);
1198 }
David Blaikiece7a1bd2014-05-21 18:04:33 +00001199 }
Peter Collingbourne4d358b52012-05-27 18:36:44 +00001200
1201 // DW_TAG_inlined_subroutine may refer to this DIE.
David Blaikieb0b3fcf2014-04-25 18:52:29 +00001202 DIE &SPDie = createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, SP);
Peter Collingbourne4d358b52012-05-27 18:36:44 +00001203
David Blaikie6cfa9e12014-06-05 00:25:26 +00001204 // Stop here and fill this in later, depending on whether or not this
David Blaikief7221ad2014-05-27 18:37:43 +00001205 // subprogram turns out to have inlined instances or not.
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001206 if (SP->isDefinition())
David Blaikief7221ad2014-05-27 18:37:43 +00001207 return &SPDie;
1208
David Blaikie7f916862014-05-27 18:37:38 +00001209 applySubprogramAttributes(SP, SPDie);
1210 return &SPDie;
1211}
1212
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001213bool DwarfUnit::applySubprogramDefinitionAttributes(const DISubprogram *SP,
David Blaikie3a443c22014-11-04 22:12:25 +00001214 DIE &SPDie) {
David Blaikie7f916862014-05-27 18:37:38 +00001215 DIE *DeclDie = nullptr;
1216 StringRef DeclLinkageName;
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001217 if (auto *SPDecl = SP->getDeclaration()) {
David Blaikief7221ad2014-05-27 18:37:43 +00001218 DeclDie = getDIE(SPDecl);
David Blaikie6cfa9e12014-06-05 00:25:26 +00001219 assert(DeclDie && "This DIE should've already been constructed when the "
Alp Toker5c536392014-06-07 21:23:09 +00001220 "definition DIE was created in "
David Blaikie6cfa9e12014-06-05 00:25:26 +00001221 "getOrCreateSubprogramDIE");
Paul Robinsondad49072016-12-02 01:55:17 +00001222 // Look at the Decl's linkage name only if we emitted it.
1223 if (DD->useAllLinkageNames())
1224 DeclLinkageName = SPDecl->getLinkageName();
Paul Robinson612e89d2018-01-12 19:17:50 +00001225 unsigned DeclID = getOrCreateSourceID(SPDecl->getFile());
1226 unsigned DefID = getOrCreateSourceID(SP->getFile());
David Blaikiec9ad9192015-10-07 00:04:16 +00001227 if (DeclID != DefID)
1228 addUInt(SPDie, dwarf::DW_AT_decl_file, None, DefID);
1229
1230 if (SP->getLine() != SPDecl->getLine())
1231 addUInt(SPDie, dwarf::DW_AT_decl_line, None, SP->getLine());
David Blaikie7f916862014-05-27 18:37:38 +00001232 }
Rafael Espindola79278362011-11-10 22:34:29 +00001233
Devang Patel89543712011-08-15 17:24:54 +00001234 // Add function template parameters.
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001235 addTemplateParams(SPDie, SP->getTemplateParams());
Devang Patel89543712011-08-15 17:24:54 +00001236
Adrian Prantl8714aaf2014-04-14 21:16:04 +00001237 // Add the linkage name if we have one and it isn't in the Decl.
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001238 StringRef LinkageName = SP->getLinkageName();
David Blaikiece7a1bd2014-05-21 18:04:33 +00001239 assert(((LinkageName.empty() || DeclLinkageName.empty()) ||
1240 LinkageName == DeclLinkageName) &&
1241 "decl has a linkage name and it is different");
Paul Robinson43d1e452016-04-18 22:41:41 +00001242 if (DeclLinkageName.empty() &&
1243 // Always emit it for abstract subprograms.
1244 (DD->useAllLinkageNames() || DU->getAbstractSPDies().lookup(SP)))
Paul Robinson857b4432015-03-10 22:44:45 +00001245 addLinkageName(SPDie, LinkageName);
Devang Patel89543712011-08-15 17:24:54 +00001246
David Blaikie3a443c22014-11-04 22:12:25 +00001247 if (!DeclDie)
1248 return false;
1249
1250 // Refer to the function declaration where all the other attributes will be
1251 // found.
1252 addDIEEntry(SPDie, dwarf::DW_AT_specification, *DeclDie);
1253 return true;
1254}
1255
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001256void DwarfUnit::applySubprogramAttributes(const DISubprogram *SP, DIE &SPDie,
Dehao Chen1ce8d6c2017-01-19 00:44:11 +00001257 bool SkipSPAttributes) {
1258 // If -fdebug-info-for-profiling is enabled, need to emit the subprogram
1259 // and its source location.
1260 bool SkipSPSourceLocation = SkipSPAttributes &&
Dehao Chen0944a8c2017-02-01 22:45:09 +00001261 !CUNode->getDebugInfoForProfiling();
Dehao Chen1ce8d6c2017-01-19 00:44:11 +00001262 if (!SkipSPSourceLocation)
David Blaikie3a443c22014-11-04 22:12:25 +00001263 if (applySubprogramDefinitionAttributes(SP, SPDie))
1264 return;
Eric Christopheracb71152012-08-23 22:52:55 +00001265
Devang Patel89543712011-08-15 17:24:54 +00001266 // Constructors and operators for anonymous aggregates do not have names.
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001267 if (!SP->getName().empty())
1268 addString(SPDie, dwarf::DW_AT_name, SP->getName());
Devang Patel89543712011-08-15 17:24:54 +00001269
Dehao Chen1ce8d6c2017-01-19 00:44:11 +00001270 if (!SkipSPSourceLocation)
1271 addSourceLine(SPDie, SP);
David Blaikie73b65d22014-09-19 04:30:36 +00001272
Dehao Chen1ce8d6c2017-01-19 00:44:11 +00001273 // Skip the rest of the attributes under -gmlt to save space.
1274 if (SkipSPAttributes)
1275 return;
Devang Patel89543712011-08-15 17:24:54 +00001276
Eric Christopher5cd2a9d2012-02-22 08:46:21 +00001277 // Add the prototype if we have a prototype and we have a C like
1278 // language.
David Blaikiecb8e4352013-11-15 23:50:53 +00001279 uint16_t Language = getLanguage();
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001280 if (SP->isPrototyped() &&
Eric Christopherc2697f82013-10-19 01:04:47 +00001281 (Language == dwarf::DW_LANG_C89 || Language == dwarf::DW_LANG_C99 ||
Eric Christopher5cd2a9d2012-02-22 08:46:21 +00001282 Language == dwarf::DW_LANG_ObjC))
Eric Christopherbb69a272012-08-24 01:14:27 +00001283 addFlag(SPDie, dwarf::DW_AT_prototyped);
Devang Patel89543712011-08-15 17:24:54 +00001284
Reid Klecknerde3d8b52016-06-08 20:34:29 +00001285 unsigned CC = 0;
Duncan P. N. Exon Smith0660bcd2015-08-28 21:38:24 +00001286 DITypeRefArray Args;
Reid Klecknerde3d8b52016-06-08 20:34:29 +00001287 if (const DISubroutineType *SPTy = SP->getType()) {
Duncan P. N. Exon Smith0660bcd2015-08-28 21:38:24 +00001288 Args = SPTy->getTypeArray();
Reid Klecknerde3d8b52016-06-08 20:34:29 +00001289 CC = SPTy->getCC();
1290 }
1291
1292 // Add a DW_AT_calling_convention if this has an explicit convention.
1293 if (CC && CC != dwarf::DW_CC_normal)
1294 addUInt(SPDie, dwarf::DW_AT_calling_convention, dwarf::DW_FORM_data1, CC);
Devang Patel89543712011-08-15 17:24:54 +00001295
Eric Christopher691281b2013-10-21 17:48:51 +00001296 // Add a return type. If this is a type like a C/C++ void type we don't add a
1297 // return type.
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +00001298 if (Args.size())
Duncan P. N. Exon Smith9a597ef2015-04-07 18:07:41 +00001299 if (auto Ty = resolve(Args[0]))
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +00001300 addType(SPDie, Ty);
Devang Patel89543712011-08-15 17:24:54 +00001301
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001302 unsigned VK = SP->getVirtuality();
Devang Patel89543712011-08-15 17:24:54 +00001303 if (VK) {
Nick Lewyckycfde1a22011-12-14 00:56:07 +00001304 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
Peter Collingbournea1f86252016-03-17 23:58:03 +00001305 if (SP->getVirtualIndex() != -1u) {
1306 DIELoc *Block = getDIELoc();
1307 addUInt(*Block, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1308 addUInt(*Block, dwarf::DW_FORM_udata, SP->getVirtualIndex());
1309 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, Block);
1310 }
Eric Christopher98b7f172013-11-11 18:52:36 +00001311 ContainingTypeMap.insert(
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001312 std::make_pair(&SPDie, resolve(SP->getContainingType())));
Devang Patel89543712011-08-15 17:24:54 +00001313 }
1314
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001315 if (!SP->isDefinition()) {
Eric Christopherbb69a272012-08-24 01:14:27 +00001316 addFlag(SPDie, dwarf::DW_AT_declaration);
Eric Christopher92331fd2012-11-21 00:34:38 +00001317
Devang Patel89543712011-08-15 17:24:54 +00001318 // Add arguments. Do not add arguments for subprogram definition. They will
1319 // be handled while processing variables.
David Blaikie899ae612014-04-30 22:58:19 +00001320 constructSubprogramArguments(SPDie, Args);
Devang Patel89543712011-08-15 17:24:54 +00001321 }
1322
Adrian Prantl1d12b882017-04-26 22:56:44 +00001323 addThrownTypes(SPDie, SP->getThrownTypes());
1324
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001325 if (SP->isArtificial())
Eric Christopherbb69a272012-08-24 01:14:27 +00001326 addFlag(SPDie, dwarf::DW_AT_artificial);
Devang Patel89543712011-08-15 17:24:54 +00001327
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001328 if (!SP->isLocalToUnit())
Eric Christopherbb69a272012-08-24 01:14:27 +00001329 addFlag(SPDie, dwarf::DW_AT_external);
Devang Patel89543712011-08-15 17:24:54 +00001330
David Blaikiec53e18d2016-05-24 21:19:28 +00001331 if (DD->useAppleExtensionAttributes()) {
1332 if (SP->isOptimized())
1333 addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
Devang Patel89543712011-08-15 17:24:54 +00001334
David Blaikiec53e18d2016-05-24 21:19:28 +00001335 if (unsigned isa = Asm->getISAEncoding())
1336 addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1337 }
Devang Patel89543712011-08-15 17:24:54 +00001338
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001339 if (SP->isLValueReference())
Adrian Prantl99c7af22013-12-18 21:48:19 +00001340 addFlag(SPDie, dwarf::DW_AT_reference);
1341
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001342 if (SP->isRValueReference())
Adrian Prantl99c7af22013-12-18 21:48:19 +00001343 addFlag(SPDie, dwarf::DW_AT_rvalue_reference);
1344
Adrian Prantlc19dee72016-08-17 16:02:43 +00001345 if (SP->isNoReturn())
1346 addFlag(SPDie, dwarf::DW_AT_noreturn);
1347
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001348 if (SP->isProtected())
Adrian Prantlef129fb2014-01-18 02:12:00 +00001349 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1350 dwarf::DW_ACCESS_protected);
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001351 else if (SP->isPrivate())
Adrian Prantlef129fb2014-01-18 02:12:00 +00001352 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1353 dwarf::DW_ACCESS_private);
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001354 else if (SP->isPublic())
Adrian Prantlef129fb2014-01-18 02:12:00 +00001355 addUInt(SPDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1356 dwarf::DW_ACCESS_public);
1357
Duncan P. N. Exon Smith537b4a82015-04-14 03:40:37 +00001358 if (SP->isExplicit())
Adrian Prantlef129fb2014-01-18 02:12:00 +00001359 addFlag(SPDie, dwarf::DW_AT_explicit);
David Blaikiece3c8ef2016-11-28 21:32:19 +00001360
1361 if (SP->isMainSubprogram())
1362 addFlag(SPDie, dwarf::DW_AT_main_subprogram);
Devang Patel89543712011-08-15 17:24:54 +00001363}
1364
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001365void DwarfUnit::constructSubrangeDIE(DIE &Buffer, const DISubrange *SR,
Duncan P. N. Exon Smith60635e32015-04-21 18:44:06 +00001366 DIE *IndexTy) {
David Blaikieb0b3fcf2014-04-25 18:52:29 +00001367 DIE &DW_Subrange = createAndAddDIE(dwarf::DW_TAG_subrange_type, Buffer);
David Blaikie8dbcc3f2014-04-25 19:33:43 +00001368 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, *IndexTy);
Devang Patel0e821f42011-04-12 23:21:44 +00001369
Bill Wendling28fe9e72012-12-06 07:38:10 +00001370 // The LowerBound value defines the lower bounds which is typically zero for
1371 // C/C++. The Count value is the number of elements. Values are 64 bit. If
1372 // Count == -1 then the array is unbounded and we do not emit
David Blaikie32b0f362014-10-01 00:56:55 +00001373 // DW_AT_lower_bound and DW_AT_count attributes.
Duncan P. N. Exon Smithb273d062015-04-16 01:37:00 +00001374 int64_t LowerBound = SR->getLowerBound();
Bill Wendling3495f9b2012-12-06 07:55:19 +00001375 int64_t DefaultLowerBound = getDefaultLowerBound();
Sander de Smalenfdf40912018-01-24 09:56:07 +00001376 int64_t Count = -1;
1377 if (auto *CI = SR->getCount().dyn_cast<ConstantInt*>())
1378 Count = CI->getSExtValue();
Devang Patel0e821f42011-04-12 23:21:44 +00001379
Bill Wendling3495f9b2012-12-06 07:55:19 +00001380 if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
David Blaikief2443192013-10-21 17:28:37 +00001381 addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, None, LowerBound);
Bill Wendling28fe9e72012-12-06 07:38:10 +00001382
Sander de Smalendc00bec2018-01-24 13:35:54 +00001383 if (auto *CV = SR->getCount().dyn_cast<DIVariable*>()) {
1384 // 'finishVariableDefinition' that creates the types for a variable is
1385 // always called _after_ the DIEs for variables are created.
1386 auto *CountVarDIE = getDIE(CV);
1387 assert(CountVarDIE && "DIE for count is not yet instantiated");
1388 addDIEEntry(DW_Subrange, dwarf::DW_AT_count, *CountVarDIE);
1389 } else if (Count != -1)
Bill Wendlingd7767122012-12-04 21:34:03 +00001390 // FIXME: An unbounded array should reference the expression that defines
1391 // the array.
David Blaikie32b0f362014-10-01 00:56:55 +00001392 addUInt(DW_Subrange, dwarf::DW_AT_count, None, Count);
Devang Patel0e821f42011-04-12 23:21:44 +00001393}
1394
David Blaikie871c2d92014-11-02 03:09:13 +00001395DIE *DwarfUnit::getIndexTyDie() {
1396 if (IndexTyDie)
1397 return IndexTyDie;
1398 // Construct an integer type to use for indexes.
Greg Clayton35630c32016-12-01 18:56:29 +00001399 IndexTyDie = &createAndAddDIE(dwarf::DW_TAG_base_type, getUnitDie());
David Blaikie871c2d92014-11-02 03:09:13 +00001400 addString(*IndexTyDie, dwarf::DW_AT_name, "sizetype");
1401 addUInt(*IndexTyDie, dwarf::DW_AT_byte_size, None, sizeof(int64_t));
1402 addUInt(*IndexTyDie, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1403 dwarf::DW_ATE_unsigned);
1404 return IndexTyDie;
1405}
1406
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001407void DwarfUnit::constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001408 if (CTy->isVector())
David Blaikie65a74662014-04-25 18:26:14 +00001409 addFlag(Buffer, dwarf::DW_AT_GNU_vector);
Devang Patel0e821f42011-04-12 23:21:44 +00001410
Eric Christopher0df08e22013-08-08 07:40:37 +00001411 // Emit the element type.
Duncan P. N. Exon Smithb1055642015-04-16 01:01:28 +00001412 addType(Buffer, resolve(CTy->getBaseType()));
Devang Patel0e821f42011-04-12 23:21:44 +00001413
1414 // Get an anonymous type for index type.
Eric Christophercad9b532013-01-04 21:51:53 +00001415 // FIXME: This type should be passed down from the front end
1416 // as different languages may have different sizes for indexes.
Devang Patel0e821f42011-04-12 23:21:44 +00001417 DIE *IdxTy = getIndexTyDie();
Devang Patel0e821f42011-04-12 23:21:44 +00001418
1419 // Add subranges to array type.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001420 DINodeArray Elements = CTy->getElements();
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +00001421 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Duncan P. N. Exon Smithf15c6f82015-04-16 01:53:33 +00001422 // FIXME: Should this really be such a loose cast?
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001423 if (auto *Element = dyn_cast_or_null<DINode>(Elements[i]))
Duncan P. N. Exon Smithf15c6f82015-04-16 01:53:33 +00001424 if (Element->getTag() == dwarf::DW_TAG_subrange_type)
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001425 constructSubrangeDIE(Buffer, cast<DISubrange>(Element), IdxTy);
Devang Patel0e821f42011-04-12 23:21:44 +00001426 }
1427}
1428
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001429void DwarfUnit::constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy) {
Momchil Velikov08dc66e2018-02-12 16:10:09 +00001430 const DIType *DTy = resolve(CTy->getBaseType());
1431 bool IsUnsigned = DTy && isUnsignedDIType(DD, DTy);
1432 if (DTy && DD->getDwarfVersion() >= 3)
1433 addType(Buffer, DTy);
1434 if (DD->getDwarfVersion() >= 4 && (CTy->getFlags() & DINode::FlagFixedEnum)) {
1435 assert(DTy);
1436 addFlag(Buffer, dwarf::DW_AT_enum_class);
1437 }
1438
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001439 DINodeArray Elements = CTy->getElements();
Eric Christopheraeb105f2013-11-11 18:52:39 +00001440
1441 // Add enumerators to enumeration type.
Duncan P. N. Exon Smith000fa2c2015-04-07 04:14:33 +00001442 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001443 auto *Enum = dyn_cast_or_null<DIEnumerator>(Elements[i]);
Duncan P. N. Exon Smithe686f152015-04-06 23:27:40 +00001444 if (Enum) {
David Blaikieb0b3fcf2014-04-25 18:52:29 +00001445 DIE &Enumerator = createAndAddDIE(dwarf::DW_TAG_enumerator, Buffer);
Duncan P. N. Exon Smithb273d062015-04-16 01:37:00 +00001446 StringRef Name = Enum->getName();
Eric Christopheraeb105f2013-11-11 18:52:39 +00001447 addString(Enumerator, dwarf::DW_AT_name, Name);
Momchil Velikov08dc66e2018-02-12 16:10:09 +00001448 auto Value = static_cast<uint64_t>(Enum->getValue());
1449 addConstantValue(Enumerator, IsUnsigned, Value);
Eric Christopheraeb105f2013-11-11 18:52:39 +00001450 }
1451 }
Devang Patel0e821f42011-04-12 23:21:44 +00001452}
1453
Eric Christophera5a79422013-12-09 23:32:48 +00001454void DwarfUnit::constructContainingTypeDIEs() {
Duncan P. N. Exon Smith7c60f202015-04-18 00:35:36 +00001455 for (auto CI = ContainingTypeMap.begin(), CE = ContainingTypeMap.end();
Eric Christopherc2697f82013-10-19 01:04:47 +00001456 CI != CE; ++CI) {
David Blaikie65a74662014-04-25 18:26:14 +00001457 DIE &SPDie = *CI->first;
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001458 const DINode *D = CI->second;
David Blaikie2ad00162013-11-15 23:09:13 +00001459 if (!D)
Eric Christopherc2697f82013-10-19 01:04:47 +00001460 continue;
David Blaikie2ad00162013-11-15 23:09:13 +00001461 DIE *NDie = getDIE(D);
Eric Christopherc2697f82013-10-19 01:04:47 +00001462 if (!NDie)
1463 continue;
David Blaikie8dbcc3f2014-04-25 19:33:43 +00001464 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, *NDie);
Devang Patel89543712011-08-15 17:24:54 +00001465 }
1466}
1467
Adrian Prantl8c599212018-02-06 23:45:59 +00001468DIE &DwarfUnit::constructMemberDIE(DIE &Buffer, const DIDerivedType *DT) {
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001469 DIE &MemberDie = createAndAddDIE(DT->getTag(), Buffer);
1470 StringRef Name = DT->getName();
Devang Patel0e821f42011-04-12 23:21:44 +00001471 if (!Name.empty())
Nick Lewyckyd59c0ca2011-10-27 06:44:11 +00001472 addString(MemberDie, dwarf::DW_AT_name, Name);
Devang Patel0e821f42011-04-12 23:21:44 +00001473
Adrian McCarthy74bfafa2018-01-05 23:01:04 +00001474 if (DIType *Resolved = resolve(DT->getBaseType()))
1475 addType(MemberDie, Resolved);
Devang Patel0e821f42011-04-12 23:21:44 +00001476
1477 addSourceLine(MemberDie, DT);
1478
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001479 if (DT->getTag() == dwarf::DW_TAG_inheritance && DT->isVirtual()) {
Devang Patel0e821f42011-04-12 23:21:44 +00001480
1481 // For C++, virtual base classes are not at fixed offset. Use following
1482 // expression to extract appropriate offset from vtable.
1483 // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1484
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +00001485 DIELoc *VBaseLocationDie = new (DIEValueAllocator) DIELoc;
David Blaikie65a74662014-04-25 18:26:14 +00001486 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1487 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1488 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001489 addUInt(*VBaseLocationDie, dwarf::DW_FORM_udata, DT->getOffsetInBits());
David Blaikie65a74662014-04-25 18:26:14 +00001490 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1491 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1492 addUInt(*VBaseLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
Devang Patel0e821f42011-04-12 23:21:44 +00001493
David Blaikief2443192013-10-21 17:28:37 +00001494 addBlock(MemberDie, dwarf::DW_AT_data_member_location, VBaseLocationDie);
David Blaikie71d34a22013-11-01 00:25:45 +00001495 } else {
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001496 uint64_t Size = DT->getSizeInBits();
Amjad Aboudacee5682016-07-12 12:06:34 +00001497 uint64_t FieldSize = DD->getBaseTypeSize(DT);
Victor Leschuka37660c2016-10-26 21:32:29 +00001498 uint32_t AlignInBytes = DT->getAlignInBytes();
David Blaikie71d34a22013-11-01 00:25:45 +00001499 uint64_t OffsetInBytes;
Adrian Prantlf0a41082016-05-17 20:12:08 +00001500
Adrian Prantl7aa34c82016-05-17 02:37:53 +00001501 bool IsBitfield = FieldSize && Size != FieldSize;
1502 if (IsBitfield) {
Eric Christopher1acdbb82014-03-12 17:14:46 +00001503 // Handle bitfield, assume bytes are 8 bits.
Adrian Prantl6323ddf2016-05-17 21:07:16 +00001504 if (DD->useDWARF2Bitfields())
Adrian Prantle7d833d2016-05-16 22:45:10 +00001505 addUInt(MemberDie, dwarf::DW_AT_byte_size, None, FieldSize/8);
Eric Christopher1acdbb82014-03-12 17:14:46 +00001506 addUInt(MemberDie, dwarf::DW_AT_bit_size, None, Size);
Adrian Prantlf393d312016-04-28 15:37:48 +00001507
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001508 uint64_t Offset = DT->getOffsetInBits();
Victor Leschuk2ede1262016-10-20 00:13:12 +00001509 // We can't use DT->getAlignInBits() here: AlignInBits for member type
1510 // is non-zero if and only if alignment was forced (e.g. _Alignas()),
1511 // which can't be done with bitfields. Thus we use FieldSize here.
1512 uint32_t AlignInBits = FieldSize;
1513 uint32_t AlignMask = ~(AlignInBits - 1);
Adrian Prantld3da8ca2015-06-26 23:31:27 +00001514 // The bits from the start of the storage unit to the start of the field.
1515 uint64_t StartBitOffset = Offset - (Offset & AlignMask);
Adrian Prantlcb53eed2015-06-27 21:55:00 +00001516 // The byte offset of the field's aligned storage unit inside the struct.
1517 OffsetInBytes = (Offset - StartBitOffset) / 8;
Adrian Prantlf393d312016-04-28 15:37:48 +00001518
Adrian Prantl6323ddf2016-05-17 21:07:16 +00001519 if (DD->useDWARF2Bitfields()) {
Adrian Prantle5447572016-04-28 15:37:52 +00001520 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1521 uint64_t FieldOffset = (HiMark - FieldSize);
1522 Offset -= FieldOffset;
Adrian Prantlf393d312016-04-28 15:37:48 +00001523
Adrian Prantle5447572016-04-28 15:37:52 +00001524 // Maybe we need to work from the other end.
1525 if (Asm->getDataLayout().isLittleEndian())
1526 Offset = FieldSize - (Offset + Size);
1527
1528 addUInt(MemberDie, dwarf::DW_AT_bit_offset, None, Offset);
1529 OffsetInBytes = FieldOffset >> 3;
Adrian Prantlf0a41082016-05-17 20:12:08 +00001530 } else {
1531 addUInt(MemberDie, dwarf::DW_AT_data_bit_offset, None, Offset);
Adrian Prantlf393d312016-04-28 15:37:48 +00001532 }
Adrian Prantlf0a41082016-05-17 20:12:08 +00001533 } else {
David Blaikie71d34a22013-11-01 00:25:45 +00001534 // This is not a bitfield.
Adrian Prantld3da8ca2015-06-26 23:31:27 +00001535 OffsetInBytes = DT->getOffsetInBits() / 8;
Victor Leschuk3c989982016-10-26 11:59:03 +00001536 if (AlignInBytes)
1537 addUInt(MemberDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1538 AlignInBytes);
Adrian Prantlf0a41082016-05-17 20:12:08 +00001539 }
David Blaikie2ada1162014-01-03 00:48:38 +00001540
David Blaikie22b29a52014-01-03 01:30:05 +00001541 if (DD->getDwarfVersion() <= 2) {
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +00001542 DIELoc *MemLocationDie = new (DIEValueAllocator) DIELoc;
David Blaikie65a74662014-04-25 18:26:14 +00001543 addUInt(*MemLocationDie, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1544 addUInt(*MemLocationDie, dwarf::DW_FORM_udata, OffsetInBytes);
David Blaikie22b29a52014-01-03 01:30:05 +00001545 addBlock(MemberDie, dwarf::DW_AT_data_member_location, MemLocationDie);
Adrian Prantl6323ddf2016-05-17 21:07:16 +00001546 } else if (!IsBitfield || DD->useDWARF2Bitfields())
David Blaikie22b29a52014-01-03 01:30:05 +00001547 addUInt(MemberDie, dwarf::DW_AT_data_member_location, None,
1548 OffsetInBytes);
David Blaikie71d34a22013-11-01 00:25:45 +00001549 }
Devang Patel0e821f42011-04-12 23:21:44 +00001550
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001551 if (DT->isProtected())
Nick Lewyckycb918492011-12-13 05:09:11 +00001552 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
Devang Patel0e821f42011-04-12 23:21:44 +00001553 dwarf::DW_ACCESS_protected);
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001554 else if (DT->isPrivate())
Nick Lewyckycb918492011-12-13 05:09:11 +00001555 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
Devang Patel0e821f42011-04-12 23:21:44 +00001556 dwarf::DW_ACCESS_private);
1557 // Otherwise C++ member and base classes are considered public.
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001558 else if (DT->isPublic())
Nick Lewyckycb918492011-12-13 05:09:11 +00001559 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
Devang Patel0e821f42011-04-12 23:21:44 +00001560 dwarf::DW_ACCESS_public);
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001561 if (DT->isVirtual())
Nick Lewyckycfde1a22011-12-14 00:56:07 +00001562 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
Devang Patel0e821f42011-04-12 23:21:44 +00001563 dwarf::DW_VIRTUALITY_virtual);
Devang Patel514b4002011-04-16 00:11:51 +00001564
1565 // Objective-C properties.
Duncan P. N. Exon Smithe7e1d0c2015-05-27 22:14:58 +00001566 if (DINode *PNode = DT->getObjCProperty())
1567 if (DIE *PDie = getDIE(PNode))
Duncan P. N. Exon Smith4fb1f9c2015-06-25 23:46:41 +00001568 MemberDie.addValue(DIEValueAllocator, dwarf::DW_AT_APPLE_property,
1569 dwarf::DW_FORM_ref4, DIEEntry(*PDie));
Devang Patel44882172012-02-06 17:49:43 +00001570
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001571 if (DT->isArtificial())
David Blaikie37fefc32012-12-13 22:43:07 +00001572 addFlag(MemberDie, dwarf::DW_AT_artificial);
Adrian Prantl8c599212018-02-06 23:45:59 +00001573
1574 return MemberDie;
Devang Patel0e821f42011-04-12 23:21:44 +00001575}
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001576
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001577DIE *DwarfUnit::getOrCreateStaticMemberDIE(const DIDerivedType *DT) {
Duncan P. N. Exon Smitha5099dc2015-04-06 19:49:39 +00001578 if (!DT)
Craig Topper353eda42014-04-24 06:44:33 +00001579 return nullptr;
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001580
Manman Renc6b63922013-10-14 20:33:57 +00001581 // Construct the context before querying for the existence of the DIE in case
1582 // such construction creates the DIE.
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001583 DIE *ContextDIE = getOrCreateContextDIE(resolve(DT->getScope()));
David Blaikiebd700e42013-11-14 21:24:34 +00001584 assert(dwarf::isType(ContextDIE->getTag()) &&
1585 "Static member should belong to a type.");
Manman Renc6b63922013-10-14 20:33:57 +00001586
David Blaikie65a74662014-04-25 18:26:14 +00001587 if (DIE *StaticMemberDIE = getDIE(DT))
Manman Renc6b63922013-10-14 20:33:57 +00001588 return StaticMemberDIE;
1589
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001590 DIE &StaticMemberDIE = createAndAddDIE(DT->getTag(), *ContextDIE, DT);
Manman Renc6b63922013-10-14 20:33:57 +00001591
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001592 const DIType *Ty = resolve(DT->getBaseType());
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001593
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001594 addString(StaticMemberDIE, dwarf::DW_AT_name, DT->getName());
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001595 addType(StaticMemberDIE, Ty);
1596 addSourceLine(StaticMemberDIE, DT);
1597 addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1598 addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1599
1600 // FIXME: We could omit private if the parent is a class_type, and
1601 // public if the parent is something else.
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001602 if (DT->isProtected())
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001603 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1604 dwarf::DW_ACCESS_protected);
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001605 else if (DT->isPrivate())
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001606 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1607 dwarf::DW_ACCESS_private);
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001608 else if (DT->isPublic())
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001609 addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1610 dwarf::DW_ACCESS_public);
1611
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001612 if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT->getConstant()))
David Blaikiec0a28412014-05-11 15:56:59 +00001613 addConstantValue(StaticMemberDIE, CI, Ty);
Duncan P. N. Exon Smith1d1a8e02015-04-15 23:49:09 +00001614 if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT->getConstant()))
David Blaikiea39a76e2013-01-20 01:18:01 +00001615 addConstantFPValue(StaticMemberDIE, CFP);
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001616
Victor Leschuka37660c2016-10-26 21:32:29 +00001617 if (uint32_t AlignInBytes = DT->getAlignInBytes())
Victor Leschuk3c989982016-10-26 11:59:03 +00001618 addUInt(StaticMemberDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
1619 AlignInBytes);
1620
David Blaikie65a74662014-04-25 18:26:14 +00001621 return &StaticMemberDIE;
Eric Christopher4d23a4a2013-01-16 01:22:23 +00001622}
David Blaikie6b288cf2013-10-30 20:42:41 +00001623
Paul Robinsoncddd6042017-02-28 20:24:55 +00001624void DwarfUnit::emitCommonHeader(bool UseOffsets, dwarf::UnitType UT) {
David Blaikieae57e662014-11-01 23:59:23 +00001625 // Emit size of content not including length itself
Lang Hames9ff69c82015-04-24 19:11:51 +00001626 Asm->OutStreamer->AddComment("Length of Unit");
Greg Clayton35630c32016-12-01 18:56:29 +00001627 Asm->EmitInt32(getHeaderSize() + getUnitDie().getSize());
David Blaikieae57e662014-11-01 23:59:23 +00001628
Lang Hames9ff69c82015-04-24 19:11:51 +00001629 Asm->OutStreamer->AddComment("DWARF version number");
Paul Robinsoncddd6042017-02-28 20:24:55 +00001630 unsigned Version = DD->getDwarfVersion();
1631 Asm->EmitInt16(Version);
1632
1633 // DWARF v5 reorders the address size and adds a unit type.
1634 if (Version >= 5) {
1635 Asm->OutStreamer->AddComment("DWARF Unit Type");
1636 Asm->EmitInt8(UT);
1637 Asm->OutStreamer->AddComment("Address Size (in bytes)");
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001638 Asm->EmitInt8(Asm->MAI->getCodePointerSize());
Paul Robinsoncddd6042017-02-28 20:24:55 +00001639 }
Rafael Espindola063d7252015-03-10 16:58:10 +00001640
David Blaikie6896e192013-12-04 23:39:02 +00001641 // We share one abbreviations table across all units so it's always at the
1642 // start of the section. Use a relocatable offset where needed to ensure
1643 // linking doesn't invalidate that offset.
Paul Robinsoncddd6042017-02-28 20:24:55 +00001644 Asm->OutStreamer->AddComment("Offset Into Abbrev. Section");
Rafael Espindola063d7252015-03-10 16:58:10 +00001645 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Peter Collingbourne7c384cc2016-02-11 19:57:46 +00001646 if (UseOffsets)
1647 Asm->EmitInt32(0);
1648 else
1649 Asm->emitDwarfSymbolReference(
1650 TLOF.getDwarfAbbrevSection()->getBeginSymbol(), false);
Rafael Espindola063d7252015-03-10 16:58:10 +00001651
Paul Robinsoncddd6042017-02-28 20:24:55 +00001652 if (Version <= 4) {
1653 Asm->OutStreamer->AddComment("Address Size (in bytes)");
Konstantin Zhuravlyovdc77b2e2017-04-17 17:41:25 +00001654 Asm->EmitInt8(Asm->MAI->getCodePointerSize());
Paul Robinsoncddd6042017-02-28 20:24:55 +00001655 }
David Blaikie6b288cf2013-10-30 20:42:41 +00001656}
David Blaikiebc563272013-12-13 21:33:40 +00001657
Rafael Espindola063d7252015-03-10 16:58:10 +00001658void DwarfTypeUnit::emitHeader(bool UseOffsets) {
Paul Robinsoncddd6042017-02-28 20:24:55 +00001659 DwarfUnit::emitCommonHeader(UseOffsets,
1660 DD->useSplitDwarf() ? dwarf::DW_UT_split_type
1661 : dwarf::DW_UT_type);
Lang Hames9ff69c82015-04-24 19:11:51 +00001662 Asm->OutStreamer->AddComment("Type Signature");
1663 Asm->OutStreamer->EmitIntValue(TypeSignature, sizeof(TypeSignature));
1664 Asm->OutStreamer->AddComment("Type DIE Offset");
David Blaikie15ed5eb2014-01-10 01:38:41 +00001665 // In a skeleton type unit there is no type DIE so emit a zero offset.
Lang Hames9ff69c82015-04-24 19:11:51 +00001666 Asm->OutStreamer->EmitIntValue(Ty ? Ty->getOffset() : 0,
1667 sizeof(Ty->getOffset()));
David Blaikiebc563272013-12-13 21:33:40 +00001668}
1669
Wolfgang Piebe60147c2017-06-30 00:27:45 +00001670DIE::value_iterator
1671DwarfUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
1672 const MCSymbol *Hi, const MCSymbol *Lo) {
1673 return Die.addValue(DIEValueAllocator, Attribute,
1674 DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
1675 : dwarf::DW_FORM_data4,
1676 new (DIEValueAllocator) DIEDelta(Hi, Lo));
1677}
1678
1679DIE::value_iterator
1680DwarfUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
1681 const MCSymbol *Label, const MCSymbol *Sec) {
1682 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1683 return addLabel(Die, Attribute,
1684 DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
1685 : dwarf::DW_FORM_data4,
1686 Label);
1687 return addSectionDelta(Die, Attribute, Label, Sec);
1688}
1689
David Blaikiecafd9622014-11-02 08:51:37 +00001690bool DwarfTypeUnit::isDwoUnit() const {
1691 // Since there are no skeleton type units, all type units are dwo type units
1692 // when split DWARF is being used.
1693 return DD->useSplitDwarf();
1694}
David Blaikiea0e3c752017-02-03 00:44:18 +00001695
1696void DwarfTypeUnit::addGlobalName(StringRef Name, const DIE &Die,
1697 const DIScope *Context) {
1698 getCU().addGlobalNameForTypeUnit(Name, Context);
1699}
1700
1701void DwarfTypeUnit::addGlobalType(const DIType *Ty, const DIE &Die,
1702 const DIScope *Context) {
1703 getCU().addGlobalTypeUnitType(Ty, Context);
1704}
David Blaikie85366ac2017-04-22 07:53:44 +00001705
1706const MCSymbol *DwarfUnit::getCrossSectionRelativeBaseAddress() const {
1707 if (!Asm->MAI->doesDwarfUseRelocationsAcrossSections())
1708 return nullptr;
1709 if (isDwoUnit())
1710 return nullptr;
1711 return getSection()->getBeginSymbol();
1712}
Wolfgang Pieb456b5552018-01-26 18:52:58 +00001713
1714void DwarfUnit::addStringOffsetsStart() {
1715 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1716 addSectionLabel(getUnitDie(), dwarf::DW_AT_str_offsets_base,
1717 DU->getStringOffsetsStartSym(),
1718 TLOF.getDwarfStrOffSection()->getBeginSymbol());
1719}