clang  9.0.0svn
CGDebugInfo.cpp
Go to the documentation of this file.
1 //===--- CGDebugInfo.cpp - Emit Debug Information for a Module ------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This coordinates the debug information generation while generating code.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CGDebugInfo.h"
14 #include "CGBlocks.h"
15 #include "CGCXXABI.h"
16 #include "CGObjCRuntime.h"
17 #include "CGRecordLayout.h"
18 #include "CodeGenFunction.h"
19 #include "CodeGenModule.h"
20 #include "ConstantEmitter.h"
21 #include "clang/AST/ASTContext.h"
22 #include "clang/AST/DeclFriend.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/Expr.h"
26 #include "clang/AST/RecordLayout.h"
30 #include "clang/Basic/Version.h"
33 #include "clang/Lex/ModuleMap.h"
35 #include "llvm/ADT/DenseSet.h"
36 #include "llvm/ADT/SmallVector.h"
37 #include "llvm/ADT/StringExtras.h"
38 #include "llvm/IR/Constants.h"
39 #include "llvm/IR/DataLayout.h"
40 #include "llvm/IR/DerivedTypes.h"
41 #include "llvm/IR/Instructions.h"
42 #include "llvm/IR/Intrinsics.h"
43 #include "llvm/IR/Metadata.h"
44 #include "llvm/IR/Module.h"
45 #include "llvm/Support/FileSystem.h"
46 #include "llvm/Support/MD5.h"
47 #include "llvm/Support/Path.h"
48 using namespace clang;
49 using namespace clang::CodeGen;
50 
51 static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx) {
52  auto TI = Ctx.getTypeInfo(Ty);
53  return TI.AlignIsRequired ? TI.Align : 0;
54 }
55 
56 static uint32_t getTypeAlignIfRequired(QualType Ty, const ASTContext &Ctx) {
57  return getTypeAlignIfRequired(Ty.getTypePtr(), Ctx);
58 }
59 
60 static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx) {
61  return D->hasAttr<AlignedAttr>() ? D->getMaxAlignment() : 0;
62 }
63 
65  : CGM(CGM), DebugKind(CGM.getCodeGenOpts().getDebugInfo()),
66  DebugTypeExtRefs(CGM.getCodeGenOpts().DebugTypeExtRefs),
67  DBuilder(CGM.getModule()) {
68  for (const auto &KV : CGM.getCodeGenOpts().DebugPrefixMap)
69  DebugPrefixMap[KV.first] = KV.second;
70  CreateCompileUnit();
71 }
72 
74  assert(LexicalBlockStack.empty() &&
75  "Region stack mismatch, stack not empty!");
76 }
77 
78 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
79  SourceLocation TemporaryLocation)
80  : CGF(&CGF) {
81  init(TemporaryLocation);
82 }
83 
84 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF,
85  bool DefaultToEmpty,
86  SourceLocation TemporaryLocation)
87  : CGF(&CGF) {
88  init(TemporaryLocation, DefaultToEmpty);
89 }
90 
91 void ApplyDebugLocation::init(SourceLocation TemporaryLocation,
92  bool DefaultToEmpty) {
93  auto *DI = CGF->getDebugInfo();
94  if (!DI) {
95  CGF = nullptr;
96  return;
97  }
98 
99  OriginalLocation = CGF->Builder.getCurrentDebugLocation();
100 
101  if (OriginalLocation && !DI->CGM.getExpressionLocationsEnabled())
102  return;
103 
104  if (TemporaryLocation.isValid()) {
105  DI->EmitLocation(CGF->Builder, TemporaryLocation);
106  return;
107  }
108 
109  if (DefaultToEmpty) {
110  CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc());
111  return;
112  }
113 
114  // Construct a location that has a valid scope, but no line info.
115  assert(!DI->LexicalBlockStack.empty());
116  CGF->Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
117  0, 0, DI->LexicalBlockStack.back(), DI->getInlinedAt()));
118 }
119 
120 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, const Expr *E)
121  : CGF(&CGF) {
122  init(E->getExprLoc());
123 }
124 
125 ApplyDebugLocation::ApplyDebugLocation(CodeGenFunction &CGF, llvm::DebugLoc Loc)
126  : CGF(&CGF) {
127  if (!CGF.getDebugInfo()) {
128  this->CGF = nullptr;
129  return;
130  }
131  OriginalLocation = CGF.Builder.getCurrentDebugLocation();
132  if (Loc)
133  CGF.Builder.SetCurrentDebugLocation(std::move(Loc));
134 }
135 
137  // Query CGF so the location isn't overwritten when location updates are
138  // temporarily disabled (for C++ default function arguments)
139  if (CGF)
140  CGF->Builder.SetCurrentDebugLocation(std::move(OriginalLocation));
141 }
142 
144  GlobalDecl InlinedFn)
145  : CGF(&CGF) {
146  if (!CGF.getDebugInfo()) {
147  this->CGF = nullptr;
148  return;
149  }
150  auto &DI = *CGF.getDebugInfo();
151  SavedLocation = DI.getLocation();
152  assert((DI.getInlinedAt() ==
153  CGF.Builder.getCurrentDebugLocation()->getInlinedAt()) &&
154  "CGDebugInfo and IRBuilder are out of sync");
155 
156  DI.EmitInlineFunctionStart(CGF.Builder, InlinedFn);
157 }
158 
160  if (!CGF)
161  return;
162  auto &DI = *CGF->getDebugInfo();
164  DI.EmitLocation(CGF->Builder, SavedLocation);
165 }
166 
168  // If the new location isn't valid return.
169  if (Loc.isInvalid())
170  return;
171 
172  CurLoc = CGM.getContext().getSourceManager().getExpansionLoc(Loc);
173 
174  // If we've changed files in the middle of a lexical scope go ahead
175  // and create a new lexical scope with file node if it's different
176  // from the one in the scope.
177  if (LexicalBlockStack.empty())
178  return;
179 
180  SourceManager &SM = CGM.getContext().getSourceManager();
181  auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
182  PresumedLoc PCLoc = SM.getPresumedLoc(CurLoc);
183  if (PCLoc.isInvalid() || Scope->getFile() == getOrCreateFile(CurLoc))
184  return;
185 
186  if (auto *LBF = dyn_cast<llvm::DILexicalBlockFile>(Scope)) {
187  LexicalBlockStack.pop_back();
188  LexicalBlockStack.emplace_back(DBuilder.createLexicalBlockFile(
189  LBF->getScope(), getOrCreateFile(CurLoc)));
190  } else if (isa<llvm::DILexicalBlock>(Scope) ||
191  isa<llvm::DISubprogram>(Scope)) {
192  LexicalBlockStack.pop_back();
193  LexicalBlockStack.emplace_back(
194  DBuilder.createLexicalBlockFile(Scope, getOrCreateFile(CurLoc)));
195  }
196 }
197 
198 llvm::DIScope *CGDebugInfo::getDeclContextDescriptor(const Decl *D) {
199  llvm::DIScope *Mod = getParentModuleOrNull(D);
200  return getContextDescriptor(cast<Decl>(D->getDeclContext()),
201  Mod ? Mod : TheCU);
202 }
203 
204 llvm::DIScope *CGDebugInfo::getContextDescriptor(const Decl *Context,
205  llvm::DIScope *Default) {
206  if (!Context)
207  return Default;
208 
209  auto I = RegionMap.find(Context);
210  if (I != RegionMap.end()) {
211  llvm::Metadata *V = I->second;
212  return dyn_cast_or_null<llvm::DIScope>(V);
213  }
214 
215  // Check namespace.
216  if (const auto *NSDecl = dyn_cast<NamespaceDecl>(Context))
217  return getOrCreateNamespace(NSDecl);
218 
219  if (const auto *RDecl = dyn_cast<RecordDecl>(Context))
220  if (!RDecl->isDependentType())
221  return getOrCreateType(CGM.getContext().getTypeDeclType(RDecl),
222  TheCU->getFile());
223  return Default;
224 }
225 
226 PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
227  PrintingPolicy PP = CGM.getContext().getPrintingPolicy();
228 
229  // If we're emitting codeview, it's important to try to match MSVC's naming so
230  // that visualizers written for MSVC will trigger for our class names. In
231  // particular, we can't have spaces between arguments of standard templates
232  // like basic_string and vector.
233  if (CGM.getCodeGenOpts().EmitCodeView)
234  PP.MSVCFormatting = true;
235 
236  // Apply -fdebug-prefix-map.
237  PP.RemapFilePaths = true;
238  PP.remapPath = [this](StringRef Path) { return remapDIPath(Path); };
239  return PP;
240 }
241 
242 StringRef CGDebugInfo::getFunctionName(const FunctionDecl *FD) {
243  assert(FD && "Invalid FunctionDecl!");
244  IdentifierInfo *FII = FD->getIdentifier();
247 
248  // Emit the unqualified name in normal operation. LLVM and the debugger can
249  // compute the fully qualified name from the scope chain. If we're only
250  // emitting line table info, there won't be any scope chains, so emit the
251  // fully qualified name here so that stack traces are more accurate.
252  // FIXME: Do this when emitting DWARF as well as when emitting CodeView after
253  // evaluating the size impact.
254  bool UseQualifiedName = DebugKind == codegenoptions::DebugLineTablesOnly &&
255  CGM.getCodeGenOpts().EmitCodeView;
256 
257  if (!Info && FII && !UseQualifiedName)
258  return FII->getName();
259 
260  SmallString<128> NS;
261  llvm::raw_svector_ostream OS(NS);
262  if (!UseQualifiedName)
263  FD->printName(OS);
264  else
265  FD->printQualifiedName(OS, getPrintingPolicy());
266 
267  // Add any template specialization args.
268  if (Info) {
269  const TemplateArgumentList *TArgs = Info->TemplateArguments;
270  printTemplateArgumentList(OS, TArgs->asArray(), getPrintingPolicy());
271  }
272 
273  // Copy this name on the side and use its reference.
274  return internString(OS.str());
275 }
276 
277 StringRef CGDebugInfo::getObjCMethodName(const ObjCMethodDecl *OMD) {
278  SmallString<256> MethodName;
279  llvm::raw_svector_ostream OS(MethodName);
280  OS << (OMD->isInstanceMethod() ? '-' : '+') << '[';
281  const DeclContext *DC = OMD->getDeclContext();
282  if (const auto *OID = dyn_cast<ObjCImplementationDecl>(DC)) {
283  OS << OID->getName();
284  } else if (const auto *OID = dyn_cast<ObjCInterfaceDecl>(DC)) {
285  OS << OID->getName();
286  } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(DC)) {
287  if (OC->IsClassExtension()) {
288  OS << OC->getClassInterface()->getName();
289  } else {
290  OS << OC->getIdentifier()->getNameStart() << '('
291  << OC->getIdentifier()->getNameStart() << ')';
292  }
293  } else if (const auto *OCD = dyn_cast<ObjCCategoryImplDecl>(DC)) {
294  OS << OCD->getClassInterface()->getName() << '(' << OCD->getName() << ')';
295  } else if (isa<ObjCProtocolDecl>(DC)) {
296  // We can extract the type of the class from the self pointer.
297  if (ImplicitParamDecl *SelfDecl = OMD->getSelfDecl()) {
298  QualType ClassTy =
299  cast<ObjCObjectPointerType>(SelfDecl->getType())->getPointeeType();
300  ClassTy.print(OS, PrintingPolicy(LangOptions()));
301  }
302  }
303  OS << ' ' << OMD->getSelector().getAsString() << ']';
304 
305  return internString(OS.str());
306 }
307 
308 StringRef CGDebugInfo::getSelectorName(Selector S) {
309  return internString(S.getAsString());
310 }
311 
312 StringRef CGDebugInfo::getClassName(const RecordDecl *RD) {
313  if (isa<ClassTemplateSpecializationDecl>(RD)) {
314  SmallString<128> Name;
315  llvm::raw_svector_ostream OS(Name);
316  RD->getNameForDiagnostic(OS, getPrintingPolicy(),
317  /*Qualified*/ false);
318 
319  // Copy this name on the side and use its reference.
320  return internString(Name);
321  }
322 
323  // quick optimization to avoid having to intern strings that are already
324  // stored reliably elsewhere
325  if (const IdentifierInfo *II = RD->getIdentifier())
326  return II->getName();
327 
328  // The CodeView printer in LLVM wants to see the names of unnamed types: it is
329  // used to reconstruct the fully qualified type names.
330  if (CGM.getCodeGenOpts().EmitCodeView) {
331  if (const TypedefNameDecl *D = RD->getTypedefNameForAnonDecl()) {
332  assert(RD->getDeclContext() == D->getDeclContext() &&
333  "Typedef should not be in another decl context!");
334  assert(D->getDeclName().getAsIdentifierInfo() &&
335  "Typedef was not named!");
336  return D->getDeclName().getAsIdentifierInfo()->getName();
337  }
338 
339  if (CGM.getLangOpts().CPlusPlus) {
340  StringRef Name;
341 
342  ASTContext &Context = CGM.getContext();
343  if (const DeclaratorDecl *DD = Context.getDeclaratorForUnnamedTagDecl(RD))
344  // Anonymous types without a name for linkage purposes have their
345  // declarator mangled in if they have one.
346  Name = DD->getName();
347  else if (const TypedefNameDecl *TND =
349  // Anonymous types without a name for linkage purposes have their
350  // associate typedef mangled in if they have one.
351  Name = TND->getName();
352 
353  if (!Name.empty()) {
354  SmallString<256> UnnamedType("<unnamed-type-");
355  UnnamedType += Name;
356  UnnamedType += '>';
357  return internString(UnnamedType);
358  }
359  }
360  }
361 
362  return StringRef();
363 }
364 
366 CGDebugInfo::computeChecksum(FileID FID, SmallString<32> &Checksum) const {
367  Checksum.clear();
368 
369  if (!CGM.getCodeGenOpts().EmitCodeView &&
370  CGM.getCodeGenOpts().DwarfVersion < 5)
371  return None;
372 
373  SourceManager &SM = CGM.getContext().getSourceManager();
374  bool Invalid;
375  const llvm::MemoryBuffer *MemBuffer = SM.getBuffer(FID, &Invalid);
376  if (Invalid)
377  return None;
378 
379  llvm::MD5 Hash;
380  llvm::MD5::MD5Result Result;
381 
382  Hash.update(MemBuffer->getBuffer());
383  Hash.final(Result);
384 
385  Hash.stringifyResult(Result, Checksum);
386  return llvm::DIFile::CSK_MD5;
387 }
388 
389 Optional<StringRef> CGDebugInfo::getSource(const SourceManager &SM,
390  FileID FID) {
391  if (!CGM.getCodeGenOpts().EmbedSource)
392  return None;
393 
394  bool SourceInvalid = false;
395  StringRef Source = SM.getBufferData(FID, &SourceInvalid);
396 
397  if (SourceInvalid)
398  return None;
399 
400  return Source;
401 }
402 
403 llvm::DIFile *CGDebugInfo::getOrCreateFile(SourceLocation Loc) {
404  if (!Loc.isValid())
405  // If Location is not valid then use main input file.
406  return TheCU->getFile();
407 
408  SourceManager &SM = CGM.getContext().getSourceManager();
409  PresumedLoc PLoc = SM.getPresumedLoc(Loc);
410 
411  StringRef FileName = PLoc.getFilename();
412  if (PLoc.isInvalid() || FileName.empty())
413  // If the location is not valid then use main input file.
414  return TheCU->getFile();
415 
416  // Cache the results.
417  auto It = DIFileCache.find(FileName.data());
418  if (It != DIFileCache.end()) {
419  // Verify that the information still exists.
420  if (llvm::Metadata *V = It->second)
421  return cast<llvm::DIFile>(V);
422  }
423 
424  SmallString<32> Checksum;
426  computeChecksum(SM.getFileID(Loc), Checksum);
428  if (CSKind)
429  CSInfo.emplace(*CSKind, Checksum);
430  return createFile(FileName, CSInfo, getSource(SM, SM.getFileID(Loc)));
431 }
432 
433 llvm::DIFile *
434 CGDebugInfo::createFile(StringRef FileName,
435  Optional<llvm::DIFile::ChecksumInfo<StringRef>> CSInfo,
436  Optional<StringRef> Source) {
437  StringRef Dir;
438  StringRef File;
439  std::string RemappedFile = remapDIPath(FileName);
440  std::string CurDir = remapDIPath(getCurrentDirname());
441  SmallString<128> DirBuf;
442  SmallString<128> FileBuf;
443  if (llvm::sys::path::is_absolute(RemappedFile)) {
444  // Strip the common prefix (if it is more than just "/") from current
445  // directory and FileName for a more space-efficient encoding.
446  auto FileIt = llvm::sys::path::begin(RemappedFile);
447  auto FileE = llvm::sys::path::end(RemappedFile);
448  auto CurDirIt = llvm::sys::path::begin(CurDir);
449  auto CurDirE = llvm::sys::path::end(CurDir);
450  for (; CurDirIt != CurDirE && *CurDirIt == *FileIt; ++CurDirIt, ++FileIt)
451  llvm::sys::path::append(DirBuf, *CurDirIt);
452  if (std::distance(llvm::sys::path::begin(CurDir), CurDirIt) == 1) {
453  // Don't strip the common prefix if it is only the root "/"
454  // since that would make LLVM diagnostic locations confusing.
455  Dir = {};
456  File = RemappedFile;
457  } else {
458  for (; FileIt != FileE; ++FileIt)
459  llvm::sys::path::append(FileBuf, *FileIt);
460  Dir = DirBuf;
461  File = FileBuf;
462  }
463  } else {
464  Dir = CurDir;
465  File = RemappedFile;
466  }
467  llvm::DIFile *F = DBuilder.createFile(File, Dir, CSInfo, Source);
468  DIFileCache[FileName.data()].reset(F);
469  return F;
470 }
471 
472 std::string CGDebugInfo::remapDIPath(StringRef Path) const {
473  for (const auto &Entry : DebugPrefixMap)
474  if (Path.startswith(Entry.first))
475  return (Twine(Entry.second) + Path.substr(Entry.first.size())).str();
476  return Path.str();
477 }
478 
479 unsigned CGDebugInfo::getLineNumber(SourceLocation Loc) {
480  if (Loc.isInvalid() && CurLoc.isInvalid())
481  return 0;
482  SourceManager &SM = CGM.getContext().getSourceManager();
483  PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
484  return PLoc.isValid() ? PLoc.getLine() : 0;
485 }
486 
487 unsigned CGDebugInfo::getColumnNumber(SourceLocation Loc, bool Force) {
488  // We may not want column information at all.
489  if (!Force && !CGM.getCodeGenOpts().DebugColumnInfo)
490  return 0;
491 
492  // If the location is invalid then use the current column.
493  if (Loc.isInvalid() && CurLoc.isInvalid())
494  return 0;
495  SourceManager &SM = CGM.getContext().getSourceManager();
496  PresumedLoc PLoc = SM.getPresumedLoc(Loc.isValid() ? Loc : CurLoc);
497  return PLoc.isValid() ? PLoc.getColumn() : 0;
498 }
499 
500 StringRef CGDebugInfo::getCurrentDirname() {
501  if (!CGM.getCodeGenOpts().DebugCompilationDir.empty())
502  return CGM.getCodeGenOpts().DebugCompilationDir;
503 
504  if (!CWDName.empty())
505  return CWDName;
506  SmallString<256> CWD;
507  llvm::sys::fs::current_path(CWD);
508  return CWDName = internString(CWD);
509 }
510 
511 void CGDebugInfo::CreateCompileUnit() {
512  SmallString<32> Checksum;
515 
516  // Should we be asking the SourceManager for the main file name, instead of
517  // accepting it as an argument? This just causes the main file name to
518  // mismatch with source locations and create extra lexical scopes or
519  // mismatched debug info (a CU with a DW_AT_file of "-", because that's what
520  // the driver passed, but functions/other things have DW_AT_file of "<stdin>"
521  // because that's what the SourceManager says)
522 
523  // Get absolute path name.
524  SourceManager &SM = CGM.getContext().getSourceManager();
525  std::string MainFileName = CGM.getCodeGenOpts().MainFileName;
526  if (MainFileName.empty())
527  MainFileName = "<stdin>";
528 
529  // The main file name provided via the "-main-file-name" option contains just
530  // the file name itself with no path information. This file name may have had
531  // a relative path, so we look into the actual file entry for the main
532  // file to determine the real absolute path for the file.
533  std::string MainFileDir;
534  if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
535  MainFileDir = remapDIPath(MainFile->getDir()->getName());
536  if (MainFileDir != ".") {
537  llvm::SmallString<1024> MainFileDirSS(MainFileDir);
538  llvm::sys::path::append(MainFileDirSS, MainFileName);
539  MainFileName = MainFileDirSS.str();
540  }
541  // If the main file name provided is identical to the input file name, and
542  // if the input file is a preprocessed source, use the module name for
543  // debug info. The module name comes from the name specified in the first
544  // linemarker if the input is a preprocessed source.
545  if (MainFile->getName() == MainFileName &&
547  MainFile->getName().rsplit('.').second)
548  .isPreprocessed())
549  MainFileName = CGM.getModule().getName().str();
550 
551  CSKind = computeChecksum(SM.getMainFileID(), Checksum);
552  }
553 
554  llvm::dwarf::SourceLanguage LangTag;
555  const LangOptions &LO = CGM.getLangOpts();
556  if (LO.CPlusPlus) {
557  if (LO.ObjC)
558  LangTag = llvm::dwarf::DW_LANG_ObjC_plus_plus;
559  else
560  LangTag = llvm::dwarf::DW_LANG_C_plus_plus;
561  } else if (LO.ObjC) {
562  LangTag = llvm::dwarf::DW_LANG_ObjC;
563  } else if (LO.RenderScript) {
564  LangTag = llvm::dwarf::DW_LANG_GOOGLE_RenderScript;
565  } else if (LO.C99) {
566  LangTag = llvm::dwarf::DW_LANG_C99;
567  } else {
568  LangTag = llvm::dwarf::DW_LANG_C89;
569  }
570 
571  std::string Producer = getClangFullVersion();
572 
573  // Figure out which version of the ObjC runtime we have.
574  unsigned RuntimeVers = 0;
575  if (LO.ObjC)
576  RuntimeVers = LO.ObjCRuntime.isNonFragile() ? 2 : 1;
577 
578  llvm::DICompileUnit::DebugEmissionKind EmissionKind;
579  switch (DebugKind) {
582  EmissionKind = llvm::DICompileUnit::NoDebug;
583  break;
585  EmissionKind = llvm::DICompileUnit::LineTablesOnly;
586  break;
589  break;
592  EmissionKind = llvm::DICompileUnit::FullDebug;
593  break;
594  }
595 
596  uint64_t DwoId = 0;
597  auto &CGOpts = CGM.getCodeGenOpts();
598  // The DIFile used by the CU is distinct from the main source
599  // file. Its directory part specifies what becomes the
600  // DW_AT_comp_dir (the compilation directory), even if the source
601  // file was specified with an absolute path.
602  if (CSKind)
603  CSInfo.emplace(*CSKind, Checksum);
604  llvm::DIFile *CUFile = DBuilder.createFile(
605  remapDIPath(MainFileName), remapDIPath(getCurrentDirname()), CSInfo,
606  getSource(SM, SM.getMainFileID()));
607 
608  // Create new compile unit.
609  TheCU = DBuilder.createCompileUnit(
610  LangTag, CUFile, CGOpts.EmitVersionIdentMetadata ? Producer : "",
611  LO.Optimize || CGOpts.PrepareForLTO || CGOpts.PrepareForThinLTO,
612  CGOpts.DwarfDebugFlags, RuntimeVers,
613  (CGOpts.getSplitDwarfMode() != CodeGenOptions::NoFission)
614  ? ""
615  : CGOpts.SplitDwarfFile,
616  EmissionKind, DwoId, CGOpts.SplitDwarfInlining,
617  CGOpts.DebugInfoForProfiling,
618  CGM.getTarget().getTriple().isNVPTX()
620  : static_cast<llvm::DICompileUnit::DebugNameTableKind>(
621  CGOpts.DebugNameTable),
622  CGOpts.DebugRangesBaseAddress);
623 }
624 
625 llvm::DIType *CGDebugInfo::CreateType(const BuiltinType *BT) {
626  llvm::dwarf::TypeKind Encoding;
627  StringRef BTName;
628  switch (BT->getKind()) {
629 #define BUILTIN_TYPE(Id, SingletonId)
630 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
631 #include "clang/AST/BuiltinTypes.def"
632  case BuiltinType::Dependent:
633  llvm_unreachable("Unexpected builtin type");
634  case BuiltinType::NullPtr:
635  return DBuilder.createNullPtrType();
636  case BuiltinType::Void:
637  return nullptr;
638  case BuiltinType::ObjCClass:
639  if (!ClassTy)
640  ClassTy =
641  DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
642  "objc_class", TheCU, TheCU->getFile(), 0);
643  return ClassTy;
644  case BuiltinType::ObjCId: {
645  // typedef struct objc_class *Class;
646  // typedef struct objc_object {
647  // Class isa;
648  // } *id;
649 
650  if (ObjTy)
651  return ObjTy;
652 
653  if (!ClassTy)
654  ClassTy =
655  DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
656  "objc_class", TheCU, TheCU->getFile(), 0);
657 
658  unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
659 
660  auto *ISATy = DBuilder.createPointerType(ClassTy, Size);
661 
662  ObjTy = DBuilder.createStructType(TheCU, "objc_object", TheCU->getFile(), 0,
663  0, 0, llvm::DINode::FlagZero, nullptr,
664  llvm::DINodeArray());
665 
666  DBuilder.replaceArrays(
667  ObjTy, DBuilder.getOrCreateArray(&*DBuilder.createMemberType(
668  ObjTy, "isa", TheCU->getFile(), 0, Size, 0, 0,
669  llvm::DINode::FlagZero, ISATy)));
670  return ObjTy;
671  }
672  case BuiltinType::ObjCSel: {
673  if (!SelTy)
674  SelTy = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
675  "objc_selector", TheCU,
676  TheCU->getFile(), 0);
677  return SelTy;
678  }
679 
680 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
681  case BuiltinType::Id: \
682  return getOrCreateStructPtrType("opencl_" #ImgType "_" #Suffix "_t", \
683  SingletonId);
684 #include "clang/Basic/OpenCLImageTypes.def"
685  case BuiltinType::OCLSampler:
686  return getOrCreateStructPtrType("opencl_sampler_t", OCLSamplerDITy);
687  case BuiltinType::OCLEvent:
688  return getOrCreateStructPtrType("opencl_event_t", OCLEventDITy);
689  case BuiltinType::OCLClkEvent:
690  return getOrCreateStructPtrType("opencl_clk_event_t", OCLClkEventDITy);
691  case BuiltinType::OCLQueue:
692  return getOrCreateStructPtrType("opencl_queue_t", OCLQueueDITy);
693  case BuiltinType::OCLReserveID:
694  return getOrCreateStructPtrType("opencl_reserve_id_t", OCLReserveIDDITy);
695 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
696  case BuiltinType::Id: \
697  return getOrCreateStructPtrType("opencl_" #ExtType, Id##Ty);
698 #include "clang/Basic/OpenCLExtensionTypes.def"
699 
700  case BuiltinType::UChar:
701  case BuiltinType::Char_U:
702  Encoding = llvm::dwarf::DW_ATE_unsigned_char;
703  break;
704  case BuiltinType::Char_S:
705  case BuiltinType::SChar:
706  Encoding = llvm::dwarf::DW_ATE_signed_char;
707  break;
708  case BuiltinType::Char8:
709  case BuiltinType::Char16:
710  case BuiltinType::Char32:
711  Encoding = llvm::dwarf::DW_ATE_UTF;
712  break;
713  case BuiltinType::UShort:
714  case BuiltinType::UInt:
715  case BuiltinType::UInt128:
716  case BuiltinType::ULong:
717  case BuiltinType::WChar_U:
718  case BuiltinType::ULongLong:
719  Encoding = llvm::dwarf::DW_ATE_unsigned;
720  break;
721  case BuiltinType::Short:
722  case BuiltinType::Int:
723  case BuiltinType::Int128:
724  case BuiltinType::Long:
725  case BuiltinType::WChar_S:
726  case BuiltinType::LongLong:
727  Encoding = llvm::dwarf::DW_ATE_signed;
728  break;
729  case BuiltinType::Bool:
730  Encoding = llvm::dwarf::DW_ATE_boolean;
731  break;
732  case BuiltinType::Half:
733  case BuiltinType::Float:
734  case BuiltinType::LongDouble:
735  case BuiltinType::Float16:
736  case BuiltinType::Float128:
737  case BuiltinType::Double:
738  // FIXME: For targets where long double and __float128 have the same size,
739  // they are currently indistinguishable in the debugger without some
740  // special treatment. However, there is currently no consensus on encoding
741  // and this should be updated once a DWARF encoding exists for distinct
742  // floating point types of the same size.
743  Encoding = llvm::dwarf::DW_ATE_float;
744  break;
745  case BuiltinType::ShortAccum:
746  case BuiltinType::Accum:
747  case BuiltinType::LongAccum:
748  case BuiltinType::ShortFract:
749  case BuiltinType::Fract:
750  case BuiltinType::LongFract:
751  case BuiltinType::SatShortFract:
752  case BuiltinType::SatFract:
753  case BuiltinType::SatLongFract:
754  case BuiltinType::SatShortAccum:
755  case BuiltinType::SatAccum:
756  case BuiltinType::SatLongAccum:
757  Encoding = llvm::dwarf::DW_ATE_signed_fixed;
758  break;
759  case BuiltinType::UShortAccum:
760  case BuiltinType::UAccum:
761  case BuiltinType::ULongAccum:
762  case BuiltinType::UShortFract:
763  case BuiltinType::UFract:
764  case BuiltinType::ULongFract:
765  case BuiltinType::SatUShortAccum:
766  case BuiltinType::SatUAccum:
767  case BuiltinType::SatULongAccum:
768  case BuiltinType::SatUShortFract:
769  case BuiltinType::SatUFract:
770  case BuiltinType::SatULongFract:
771  Encoding = llvm::dwarf::DW_ATE_unsigned_fixed;
772  break;
773  }
774 
775  switch (BT->getKind()) {
776  case BuiltinType::Long:
777  BTName = "long int";
778  break;
779  case BuiltinType::LongLong:
780  BTName = "long long int";
781  break;
782  case BuiltinType::ULong:
783  BTName = "long unsigned int";
784  break;
785  case BuiltinType::ULongLong:
786  BTName = "long long unsigned int";
787  break;
788  default:
789  BTName = BT->getName(CGM.getLangOpts());
790  break;
791  }
792  // Bit size and offset of the type.
793  uint64_t Size = CGM.getContext().getTypeSize(BT);
794  return DBuilder.createBasicType(BTName, Size, Encoding);
795 }
796 
797 llvm::DIType *CGDebugInfo::CreateType(const ComplexType *Ty) {
798  // Bit size and offset of the type.
799  llvm::dwarf::TypeKind Encoding = llvm::dwarf::DW_ATE_complex_float;
800  if (Ty->isComplexIntegerType())
801  Encoding = llvm::dwarf::DW_ATE_lo_user;
802 
803  uint64_t Size = CGM.getContext().getTypeSize(Ty);
804  return DBuilder.createBasicType("complex", Size, Encoding);
805 }
806 
807 llvm::DIType *CGDebugInfo::CreateQualifiedType(QualType Ty,
808  llvm::DIFile *Unit) {
810  const Type *T = Qc.strip(Ty);
811 
812  // Ignore these qualifiers for now.
813  Qc.removeObjCGCAttr();
814  Qc.removeAddressSpace();
815  Qc.removeObjCLifetime();
816 
817  // We will create one Derived type for one qualifier and recurse to handle any
818  // additional ones.
819  llvm::dwarf::Tag Tag;
820  if (Qc.hasConst()) {
821  Tag = llvm::dwarf::DW_TAG_const_type;
822  Qc.removeConst();
823  } else if (Qc.hasVolatile()) {
824  Tag = llvm::dwarf::DW_TAG_volatile_type;
825  Qc.removeVolatile();
826  } else if (Qc.hasRestrict()) {
827  Tag = llvm::dwarf::DW_TAG_restrict_type;
828  Qc.removeRestrict();
829  } else {
830  assert(Qc.empty() && "Unknown type qualifier for debug info");
831  return getOrCreateType(QualType(T, 0), Unit);
832  }
833 
834  auto *FromTy = getOrCreateType(Qc.apply(CGM.getContext(), T), Unit);
835 
836  // No need to fill in the Name, Line, Size, Alignment, Offset in case of
837  // CVR derived types.
838  return DBuilder.createQualifiedType(Tag, FromTy);
839 }
840 
841 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectPointerType *Ty,
842  llvm::DIFile *Unit) {
843 
844  // The frontend treats 'id' as a typedef to an ObjCObjectType,
845  // whereas 'id<protocol>' is treated as an ObjCPointerType. For the
846  // debug info, we want to emit 'id' in both cases.
847  if (Ty->isObjCQualifiedIdType())
848  return getOrCreateType(CGM.getContext().getObjCIdType(), Unit);
849 
850  return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
851  Ty->getPointeeType(), Unit);
852 }
853 
854 llvm::DIType *CGDebugInfo::CreateType(const PointerType *Ty,
855  llvm::DIFile *Unit) {
856  return CreatePointerLikeType(llvm::dwarf::DW_TAG_pointer_type, Ty,
857  Ty->getPointeeType(), Unit);
858 }
859 
860 /// \return whether a C++ mangling exists for the type defined by TD.
861 static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU) {
862  switch (TheCU->getSourceLanguage()) {
863  case llvm::dwarf::DW_LANG_C_plus_plus:
864  return true;
865  case llvm::dwarf::DW_LANG_ObjC_plus_plus:
866  return isa<CXXRecordDecl>(TD) || isa<EnumDecl>(TD);
867  default:
868  return false;
869  }
870 }
871 
872 // Determines if the debug info for this tag declaration needs a type
873 // identifier. The purpose of the unique identifier is to deduplicate type
874 // information for identical types across TUs. Because of the C++ one definition
875 // rule (ODR), it is valid to assume that the type is defined the same way in
876 // every TU and its debug info is equivalent.
877 //
878 // C does not have the ODR, and it is common for codebases to contain multiple
879 // different definitions of a struct with the same name in different TUs.
880 // Therefore, if the type doesn't have a C++ mangling, don't give it an
881 // identifer. Type information in C is smaller and simpler than C++ type
882 // information, so the increase in debug info size is negligible.
883 //
884 // If the type is not externally visible, it should be unique to the current TU,
885 // and should not need an identifier to participate in type deduplication.
886 // However, when emitting CodeView, the format internally uses these
887 // unique type name identifers for references between debug info. For example,
888 // the method of a class in an anonymous namespace uses the identifer to refer
889 // to its parent class. The Microsoft C++ ABI attempts to provide unique names
890 // for such types, so when emitting CodeView, always use identifiers for C++
891 // types. This may create problems when attempting to emit CodeView when the MS
892 // C++ ABI is not in use.
893 static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM,
894  llvm::DICompileUnit *TheCU) {
895  // We only add a type identifier for types with C++ name mangling.
896  if (!hasCXXMangling(TD, TheCU))
897  return false;
898 
899  // Externally visible types with C++ mangling need a type identifier.
900  if (TD->isExternallyVisible())
901  return true;
902 
903  // CodeView types with C++ mangling need a type identifier.
904  if (CGM.getCodeGenOpts().EmitCodeView)
905  return true;
906 
907  return false;
908 }
909 
910 // Returns a unique type identifier string if one exists, or an empty string.
911 static SmallString<256> getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM,
912  llvm::DICompileUnit *TheCU) {
913  SmallString<256> Identifier;
914  const TagDecl *TD = Ty->getDecl();
915 
916  if (!needsTypeIdentifier(TD, CGM, TheCU))
917  return Identifier;
918 
919  // TODO: This is using the RTTI name. Is there a better way to get
920  // a unique string for a type?
921  llvm::raw_svector_ostream Out(Identifier);
923  return Identifier;
924 }
925 
926 /// \return the appropriate DWARF tag for a composite type.
927 static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD) {
928  llvm::dwarf::Tag Tag;
929  if (RD->isStruct() || RD->isInterface())
930  Tag = llvm::dwarf::DW_TAG_structure_type;
931  else if (RD->isUnion())
932  Tag = llvm::dwarf::DW_TAG_union_type;
933  else {
934  // FIXME: This could be a struct type giving a default visibility different
935  // than C++ class type, but needs llvm metadata changes first.
936  assert(RD->isClass());
937  Tag = llvm::dwarf::DW_TAG_class_type;
938  }
939  return Tag;
940 }
941 
942 llvm::DICompositeType *
943 CGDebugInfo::getOrCreateRecordFwdDecl(const RecordType *Ty,
944  llvm::DIScope *Ctx) {
945  const RecordDecl *RD = Ty->getDecl();
946  if (llvm::DIType *T = getTypeOrNull(CGM.getContext().getRecordType(RD)))
947  return cast<llvm::DICompositeType>(T);
948  llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
949  unsigned Line = getLineNumber(RD->getLocation());
950  StringRef RDName = getClassName(RD);
951 
952  uint64_t Size = 0;
953  uint32_t Align = 0;
954 
955  // Create the type.
956  SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
957  llvm::DICompositeType *RetTy = DBuilder.createReplaceableCompositeType(
958  getTagForRecord(RD), RDName, Ctx, DefUnit, Line, 0, Size, Align,
959  llvm::DINode::FlagFwdDecl, Identifier);
960  if (CGM.getCodeGenOpts().DebugFwdTemplateParams)
961  if (auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
962  DBuilder.replaceArrays(RetTy, llvm::DINodeArray(),
963  CollectCXXTemplateParams(TSpecial, DefUnit));
964  ReplaceMap.emplace_back(
965  std::piecewise_construct, std::make_tuple(Ty),
966  std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
967  return RetTy;
968 }
969 
970 llvm::DIType *CGDebugInfo::CreatePointerLikeType(llvm::dwarf::Tag Tag,
971  const Type *Ty,
972  QualType PointeeTy,
973  llvm::DIFile *Unit) {
974  // Bit size, align and offset of the type.
975  // Size is always the size of a pointer. We can't use getTypeSize here
976  // because that does not return the correct value for references.
977  unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(PointeeTy);
978  uint64_t Size = CGM.getTarget().getPointerWidth(AddressSpace);
979  auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
980  Optional<unsigned> DWARFAddressSpace =
981  CGM.getTarget().getDWARFAddressSpace(AddressSpace);
982 
983  if (Tag == llvm::dwarf::DW_TAG_reference_type ||
984  Tag == llvm::dwarf::DW_TAG_rvalue_reference_type)
985  return DBuilder.createReferenceType(Tag, getOrCreateType(PointeeTy, Unit),
986  Size, Align, DWARFAddressSpace);
987  else
988  return DBuilder.createPointerType(getOrCreateType(PointeeTy, Unit), Size,
989  Align, DWARFAddressSpace);
990 }
991 
992 llvm::DIType *CGDebugInfo::getOrCreateStructPtrType(StringRef Name,
993  llvm::DIType *&Cache) {
994  if (Cache)
995  return Cache;
996  Cache = DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type, Name,
997  TheCU, TheCU->getFile(), 0);
998  unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
999  Cache = DBuilder.createPointerType(Cache, Size);
1000  return Cache;
1001 }
1002 
1003 uint64_t CGDebugInfo::collectDefaultElementTypesForBlockPointer(
1004  const BlockPointerType *Ty, llvm::DIFile *Unit, llvm::DIDerivedType *DescTy,
1005  unsigned LineNo, SmallVectorImpl<llvm::Metadata *> &EltTys) {
1006  QualType FType;
1007 
1008  // Advanced by calls to CreateMemberType in increments of FType, then
1009  // returned as the overall size of the default elements.
1010  uint64_t FieldOffset = 0;
1011 
1012  // Blocks in OpenCL have unique constraints which make the standard fields
1013  // redundant while requiring size and align fields for enqueue_kernel. See
1014  // initializeForBlockHeader in CGBlocks.cpp
1015  if (CGM.getLangOpts().OpenCL) {
1016  FType = CGM.getContext().IntTy;
1017  EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
1018  EltTys.push_back(CreateMemberType(Unit, FType, "__align", &FieldOffset));
1019  } else {
1020  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1021  EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
1022  FType = CGM.getContext().IntTy;
1023  EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
1024  EltTys.push_back(CreateMemberType(Unit, FType, "__reserved", &FieldOffset));
1025  FType = CGM.getContext().getPointerType(Ty->getPointeeType());
1026  EltTys.push_back(CreateMemberType(Unit, FType, "__FuncPtr", &FieldOffset));
1027  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
1028  uint64_t FieldSize = CGM.getContext().getTypeSize(Ty);
1029  uint32_t FieldAlign = CGM.getContext().getTypeAlign(Ty);
1030  EltTys.push_back(DBuilder.createMemberType(
1031  Unit, "__descriptor", nullptr, LineNo, FieldSize, FieldAlign,
1032  FieldOffset, llvm::DINode::FlagZero, DescTy));
1033  FieldOffset += FieldSize;
1034  }
1035 
1036  return FieldOffset;
1037 }
1038 
1039 llvm::DIType *CGDebugInfo::CreateType(const BlockPointerType *Ty,
1040  llvm::DIFile *Unit) {
1042  QualType FType;
1043  uint64_t FieldOffset;
1044  llvm::DINodeArray Elements;
1045 
1046  FieldOffset = 0;
1047  FType = CGM.getContext().UnsignedLongTy;
1048  EltTys.push_back(CreateMemberType(Unit, FType, "reserved", &FieldOffset));
1049  EltTys.push_back(CreateMemberType(Unit, FType, "Size", &FieldOffset));
1050 
1051  Elements = DBuilder.getOrCreateArray(EltTys);
1052  EltTys.clear();
1053 
1054  llvm::DINode::DIFlags Flags = llvm::DINode::FlagAppleBlock;
1055 
1056  auto *EltTy =
1057  DBuilder.createStructType(Unit, "__block_descriptor", nullptr, 0,
1058  FieldOffset, 0, Flags, nullptr, Elements);
1059 
1060  // Bit size, align and offset of the type.
1061  uint64_t Size = CGM.getContext().getTypeSize(Ty);
1062 
1063  auto *DescTy = DBuilder.createPointerType(EltTy, Size);
1064 
1065  FieldOffset = collectDefaultElementTypesForBlockPointer(Ty, Unit, DescTy,
1066  0, EltTys);
1067 
1068  Elements = DBuilder.getOrCreateArray(EltTys);
1069 
1070  // The __block_literal_generic structs are marked with a special
1071  // DW_AT_APPLE_BLOCK attribute and are an implementation detail only
1072  // the debugger needs to know about. To allow type uniquing, emit
1073  // them without a name or a location.
1074  EltTy = DBuilder.createStructType(Unit, "", nullptr, 0, FieldOffset, 0,
1075  Flags, nullptr, Elements);
1076 
1077  return DBuilder.createPointerType(EltTy, Size);
1078 }
1079 
1080 llvm::DIType *CGDebugInfo::CreateType(const TemplateSpecializationType *Ty,
1081  llvm::DIFile *Unit) {
1082  assert(Ty->isTypeAlias());
1083  llvm::DIType *Src = getOrCreateType(Ty->getAliasedType(), Unit);
1084 
1085  SmallString<128> NS;
1086  llvm::raw_svector_ostream OS(NS);
1087  Ty->getTemplateName().print(OS, getPrintingPolicy(), /*qualified*/ false);
1088  printTemplateArgumentList(OS, Ty->template_arguments(), getPrintingPolicy());
1089 
1090  auto *AliasDecl =
1091  cast<TypeAliasTemplateDecl>(Ty->getTemplateName().getAsTemplateDecl())
1092  ->getTemplatedDecl();
1093 
1094  SourceLocation Loc = AliasDecl->getLocation();
1095  return DBuilder.createTypedef(Src, OS.str(), getOrCreateFile(Loc),
1096  getLineNumber(Loc),
1097  getDeclContextDescriptor(AliasDecl));
1098 }
1099 
1100 llvm::DIType *CGDebugInfo::CreateType(const TypedefType *Ty,
1101  llvm::DIFile *Unit) {
1102  // We don't set size information, but do specify where the typedef was
1103  // declared.
1104  SourceLocation Loc = Ty->getDecl()->getLocation();
1105 
1106  // Typedefs are derived from some other type.
1107  return DBuilder.createTypedef(
1108  getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
1109  Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
1110  getDeclContextDescriptor(Ty->getDecl()));
1111 }
1112 
1113 static unsigned getDwarfCC(CallingConv CC) {
1114  switch (CC) {
1115  case CC_C:
1116  // Avoid emitting DW_AT_calling_convention if the C convention was used.
1117  return 0;
1118 
1119  case CC_X86StdCall:
1120  return llvm::dwarf::DW_CC_BORLAND_stdcall;
1121  case CC_X86FastCall:
1122  return llvm::dwarf::DW_CC_BORLAND_msfastcall;
1123  case CC_X86ThisCall:
1124  return llvm::dwarf::DW_CC_BORLAND_thiscall;
1125  case CC_X86VectorCall:
1126  return llvm::dwarf::DW_CC_LLVM_vectorcall;
1127  case CC_X86Pascal:
1128  return llvm::dwarf::DW_CC_BORLAND_pascal;
1129  case CC_Win64:
1130  return llvm::dwarf::DW_CC_LLVM_Win64;
1131  case CC_X86_64SysV:
1132  return llvm::dwarf::DW_CC_LLVM_X86_64SysV;
1133  case CC_AAPCS:
1134  case CC_AArch64VectorCall:
1135  return llvm::dwarf::DW_CC_LLVM_AAPCS;
1136  case CC_AAPCS_VFP:
1137  return llvm::dwarf::DW_CC_LLVM_AAPCS_VFP;
1138  case CC_IntelOclBicc:
1139  return llvm::dwarf::DW_CC_LLVM_IntelOclBicc;
1140  case CC_SpirFunction:
1141  return llvm::dwarf::DW_CC_LLVM_SpirFunction;
1142  case CC_OpenCLKernel:
1143  return llvm::dwarf::DW_CC_LLVM_OpenCLKernel;
1144  case CC_Swift:
1145  return llvm::dwarf::DW_CC_LLVM_Swift;
1146  case CC_PreserveMost:
1147  return llvm::dwarf::DW_CC_LLVM_PreserveMost;
1148  case CC_PreserveAll:
1149  return llvm::dwarf::DW_CC_LLVM_PreserveAll;
1150  case CC_X86RegCall:
1151  return llvm::dwarf::DW_CC_LLVM_X86RegCall;
1152  }
1153  return 0;
1154 }
1155 
1156 llvm::DIType *CGDebugInfo::CreateType(const FunctionType *Ty,
1157  llvm::DIFile *Unit) {
1159 
1160  // Add the result type at least.
1161  EltTys.push_back(getOrCreateType(Ty->getReturnType(), Unit));
1162 
1163  // Set up remainder of arguments if there is a prototype.
1164  // otherwise emit it as a variadic function.
1165  if (isa<FunctionNoProtoType>(Ty))
1166  EltTys.push_back(DBuilder.createUnspecifiedParameter());
1167  else if (const auto *FPT = dyn_cast<FunctionProtoType>(Ty)) {
1168  for (const QualType &ParamType : FPT->param_types())
1169  EltTys.push_back(getOrCreateType(ParamType, Unit));
1170  if (FPT->isVariadic())
1171  EltTys.push_back(DBuilder.createUnspecifiedParameter());
1172  }
1173 
1174  llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
1175  return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
1176  getDwarfCC(Ty->getCallConv()));
1177 }
1178 
1179 /// Convert an AccessSpecifier into the corresponding DINode flag.
1180 /// As an optimization, return 0 if the access specifier equals the
1181 /// default for the containing type.
1182 static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access,
1183  const RecordDecl *RD) {
1185  if (RD && RD->isClass())
1186  Default = clang::AS_private;
1187  else if (RD && (RD->isStruct() || RD->isUnion()))
1188  Default = clang::AS_public;
1189 
1190  if (Access == Default)
1191  return llvm::DINode::FlagZero;
1192 
1193  switch (Access) {
1194  case clang::AS_private:
1195  return llvm::DINode::FlagPrivate;
1196  case clang::AS_protected:
1197  return llvm::DINode::FlagProtected;
1198  case clang::AS_public:
1199  return llvm::DINode::FlagPublic;
1200  case clang::AS_none:
1201  return llvm::DINode::FlagZero;
1202  }
1203  llvm_unreachable("unexpected access enumerator");
1204 }
1205 
1206 llvm::DIType *CGDebugInfo::createBitFieldType(const FieldDecl *BitFieldDecl,
1207  llvm::DIScope *RecordTy,
1208  const RecordDecl *RD) {
1209  StringRef Name = BitFieldDecl->getName();
1210  QualType Ty = BitFieldDecl->getType();
1211  SourceLocation Loc = BitFieldDecl->getLocation();
1212  llvm::DIFile *VUnit = getOrCreateFile(Loc);
1213  llvm::DIType *DebugType = getOrCreateType(Ty, VUnit);
1214 
1215  // Get the location for the field.
1216  llvm::DIFile *File = getOrCreateFile(Loc);
1217  unsigned Line = getLineNumber(Loc);
1218 
1219  const CGBitFieldInfo &BitFieldInfo =
1220  CGM.getTypes().getCGRecordLayout(RD).getBitFieldInfo(BitFieldDecl);
1221  uint64_t SizeInBits = BitFieldInfo.Size;
1222  assert(SizeInBits > 0 && "found named 0-width bitfield");
1223  uint64_t StorageOffsetInBits =
1224  CGM.getContext().toBits(BitFieldInfo.StorageOffset);
1225  uint64_t Offset = BitFieldInfo.Offset;
1226  // The bit offsets for big endian machines are reversed for big
1227  // endian target, compensate for that as the DIDerivedType requires
1228  // un-reversed offsets.
1229  if (CGM.getDataLayout().isBigEndian())
1230  Offset = BitFieldInfo.StorageSize - BitFieldInfo.Size - Offset;
1231  uint64_t OffsetInBits = StorageOffsetInBits + Offset;
1232  llvm::DINode::DIFlags Flags = getAccessFlag(BitFieldDecl->getAccess(), RD);
1233  return DBuilder.createBitFieldMemberType(
1234  RecordTy, Name, File, Line, SizeInBits, OffsetInBits, StorageOffsetInBits,
1235  Flags, DebugType);
1236 }
1237 
1238 llvm::DIType *
1239 CGDebugInfo::createFieldType(StringRef name, QualType type, SourceLocation loc,
1240  AccessSpecifier AS, uint64_t offsetInBits,
1241  uint32_t AlignInBits, llvm::DIFile *tunit,
1242  llvm::DIScope *scope, const RecordDecl *RD) {
1243  llvm::DIType *debugType = getOrCreateType(type, tunit);
1244 
1245  // Get the location for the field.
1246  llvm::DIFile *file = getOrCreateFile(loc);
1247  unsigned line = getLineNumber(loc);
1248 
1249  uint64_t SizeInBits = 0;
1250  auto Align = AlignInBits;
1251  if (!type->isIncompleteArrayType()) {
1252  TypeInfo TI = CGM.getContext().getTypeInfo(type);
1253  SizeInBits = TI.Width;
1254  if (!Align)
1255  Align = getTypeAlignIfRequired(type, CGM.getContext());
1256  }
1257 
1258  llvm::DINode::DIFlags flags = getAccessFlag(AS, RD);
1259  return DBuilder.createMemberType(scope, name, file, line, SizeInBits, Align,
1260  offsetInBits, flags, debugType);
1261 }
1262 
1263 void CGDebugInfo::CollectRecordLambdaFields(
1264  const CXXRecordDecl *CXXDecl, SmallVectorImpl<llvm::Metadata *> &elements,
1265  llvm::DIType *RecordTy) {
1266  // For C++11 Lambdas a Field will be the same as a Capture, but the Capture
1267  // has the name and the location of the variable so we should iterate over
1268  // both concurrently.
1269  const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(CXXDecl);
1270  RecordDecl::field_iterator Field = CXXDecl->field_begin();
1271  unsigned fieldno = 0;
1273  E = CXXDecl->captures_end();
1274  I != E; ++I, ++Field, ++fieldno) {
1275  const LambdaCapture &C = *I;
1276  if (C.capturesVariable()) {
1277  SourceLocation Loc = C.getLocation();
1278  assert(!Field->isBitField() && "lambdas don't have bitfield members!");
1279  VarDecl *V = C.getCapturedVar();
1280  StringRef VName = V->getName();
1281  llvm::DIFile *VUnit = getOrCreateFile(Loc);
1282  auto Align = getDeclAlignIfRequired(V, CGM.getContext());
1283  llvm::DIType *FieldType = createFieldType(
1284  VName, Field->getType(), Loc, Field->getAccess(),
1285  layout.getFieldOffset(fieldno), Align, VUnit, RecordTy, CXXDecl);
1286  elements.push_back(FieldType);
1287  } else if (C.capturesThis()) {
1288  // TODO: Need to handle 'this' in some way by probably renaming the
1289  // this of the lambda class and having a field member of 'this' or
1290  // by using AT_object_pointer for the function and having that be
1291  // used as 'this' for semantic references.
1292  FieldDecl *f = *Field;
1293  llvm::DIFile *VUnit = getOrCreateFile(f->getLocation());
1294  QualType type = f->getType();
1295  llvm::DIType *fieldType = createFieldType(
1296  "this", type, f->getLocation(), f->getAccess(),
1297  layout.getFieldOffset(fieldno), VUnit, RecordTy, CXXDecl);
1298 
1299  elements.push_back(fieldType);
1300  }
1301  }
1302 }
1303 
1304 llvm::DIDerivedType *
1305 CGDebugInfo::CreateRecordStaticField(const VarDecl *Var, llvm::DIType *RecordTy,
1306  const RecordDecl *RD) {
1307  // Create the descriptor for the static variable, with or without
1308  // constant initializers.
1309  Var = Var->getCanonicalDecl();
1310  llvm::DIFile *VUnit = getOrCreateFile(Var->getLocation());
1311  llvm::DIType *VTy = getOrCreateType(Var->getType(), VUnit);
1312 
1313  unsigned LineNumber = getLineNumber(Var->getLocation());
1314  StringRef VName = Var->getName();
1315  llvm::Constant *C = nullptr;
1316  if (Var->getInit()) {
1317  const APValue *Value = Var->evaluateValue();
1318  if (Value) {
1319  if (Value->isInt())
1320  C = llvm::ConstantInt::get(CGM.getLLVMContext(), Value->getInt());
1321  if (Value->isFloat())
1322  C = llvm::ConstantFP::get(CGM.getLLVMContext(), Value->getFloat());
1323  }
1324  }
1325 
1326  llvm::DINode::DIFlags Flags = getAccessFlag(Var->getAccess(), RD);
1327  auto Align = getDeclAlignIfRequired(Var, CGM.getContext());
1328  llvm::DIDerivedType *GV = DBuilder.createStaticMemberType(
1329  RecordTy, VName, VUnit, LineNumber, VTy, Flags, C, Align);
1330  StaticDataMemberCache[Var->getCanonicalDecl()].reset(GV);
1331  return GV;
1332 }
1333 
1334 void CGDebugInfo::CollectRecordNormalField(
1335  const FieldDecl *field, uint64_t OffsetInBits, llvm::DIFile *tunit,
1336  SmallVectorImpl<llvm::Metadata *> &elements, llvm::DIType *RecordTy,
1337  const RecordDecl *RD) {
1338  StringRef name = field->getName();
1339  QualType type = field->getType();
1340 
1341  // Ignore unnamed fields unless they're anonymous structs/unions.
1342  if (name.empty() && !type->isRecordType())
1343  return;
1344 
1345  llvm::DIType *FieldType;
1346  if (field->isBitField()) {
1347  FieldType = createBitFieldType(field, RecordTy, RD);
1348  } else {
1349  auto Align = getDeclAlignIfRequired(field, CGM.getContext());
1350  FieldType =
1351  createFieldType(name, type, field->getLocation(), field->getAccess(),
1352  OffsetInBits, Align, tunit, RecordTy, RD);
1353  }
1354 
1355  elements.push_back(FieldType);
1356 }
1357 
1358 void CGDebugInfo::CollectRecordNestedType(
1359  const TypeDecl *TD, SmallVectorImpl<llvm::Metadata *> &elements) {
1360  QualType Ty = CGM.getContext().getTypeDeclType(TD);
1361  // Injected class names are not considered nested records.
1362  if (isa<InjectedClassNameType>(Ty))
1363  return;
1364  SourceLocation Loc = TD->getLocation();
1365  llvm::DIType *nestedType = getOrCreateType(Ty, getOrCreateFile(Loc));
1366  elements.push_back(nestedType);
1367 }
1368 
1369 void CGDebugInfo::CollectRecordFields(
1370  const RecordDecl *record, llvm::DIFile *tunit,
1372  llvm::DICompositeType *RecordTy) {
1373  const auto *CXXDecl = dyn_cast<CXXRecordDecl>(record);
1374 
1375  if (CXXDecl && CXXDecl->isLambda())
1376  CollectRecordLambdaFields(CXXDecl, elements, RecordTy);
1377  else {
1378  const ASTRecordLayout &layout = CGM.getContext().getASTRecordLayout(record);
1379 
1380  // Field number for non-static fields.
1381  unsigned fieldNo = 0;
1382 
1383  // Static and non-static members should appear in the same order as
1384  // the corresponding declarations in the source program.
1385  for (const auto *I : record->decls())
1386  if (const auto *V = dyn_cast<VarDecl>(I)) {
1387  if (V->hasAttr<NoDebugAttr>())
1388  continue;
1389 
1390  // Skip variable template specializations when emitting CodeView. MSVC
1391  // doesn't emit them.
1392  if (CGM.getCodeGenOpts().EmitCodeView &&
1393  isa<VarTemplateSpecializationDecl>(V))
1394  continue;
1395 
1396  // Reuse the existing static member declaration if one exists
1397  auto MI = StaticDataMemberCache.find(V->getCanonicalDecl());
1398  if (MI != StaticDataMemberCache.end()) {
1399  assert(MI->second &&
1400  "Static data member declaration should still exist");
1401  elements.push_back(MI->second);
1402  } else {
1403  auto Field = CreateRecordStaticField(V, RecordTy, record);
1404  elements.push_back(Field);
1405  }
1406  } else if (const auto *field = dyn_cast<FieldDecl>(I)) {
1407  CollectRecordNormalField(field, layout.getFieldOffset(fieldNo), tunit,
1408  elements, RecordTy, record);
1409 
1410  // Bump field number for next field.
1411  ++fieldNo;
1412  } else if (CGM.getCodeGenOpts().EmitCodeView) {
1413  // Debug info for nested types is included in the member list only for
1414  // CodeView.
1415  if (const auto *nestedType = dyn_cast<TypeDecl>(I))
1416  if (!nestedType->isImplicit() &&
1417  nestedType->getDeclContext() == record)
1418  CollectRecordNestedType(nestedType, elements);
1419  }
1420  }
1421 }
1422 
1423 llvm::DISubroutineType *
1424 CGDebugInfo::getOrCreateMethodType(const CXXMethodDecl *Method,
1425  llvm::DIFile *Unit) {
1426  const FunctionProtoType *Func = Method->getType()->getAs<FunctionProtoType>();
1427  if (Method->isStatic())
1428  return cast_or_null<llvm::DISubroutineType>(
1429  getOrCreateType(QualType(Func, 0), Unit));
1430  return getOrCreateInstanceMethodType(Method->getThisType(), Func, Unit);
1431 }
1432 
1433 llvm::DISubroutineType *CGDebugInfo::getOrCreateInstanceMethodType(
1434  QualType ThisPtr, const FunctionProtoType *Func, llvm::DIFile *Unit) {
1435  // Add "this" pointer.
1436  llvm::DITypeRefArray Args(
1437  cast<llvm::DISubroutineType>(getOrCreateType(QualType(Func, 0), Unit))
1438  ->getTypeArray());
1439  assert(Args.size() && "Invalid number of arguments!");
1440 
1442 
1443  // First element is always return type. For 'void' functions it is NULL.
1444  Elts.push_back(Args[0]);
1445 
1446  // "this" pointer is always first argument.
1447  const CXXRecordDecl *RD = ThisPtr->getPointeeCXXRecordDecl();
1448  if (isa<ClassTemplateSpecializationDecl>(RD)) {
1449  // Create pointer type directly in this case.
1450  const PointerType *ThisPtrTy = cast<PointerType>(ThisPtr);
1451  QualType PointeeTy = ThisPtrTy->getPointeeType();
1452  unsigned AS = CGM.getContext().getTargetAddressSpace(PointeeTy);
1453  uint64_t Size = CGM.getTarget().getPointerWidth(AS);
1454  auto Align = getTypeAlignIfRequired(ThisPtrTy, CGM.getContext());
1455  llvm::DIType *PointeeType = getOrCreateType(PointeeTy, Unit);
1456  llvm::DIType *ThisPtrType =
1457  DBuilder.createPointerType(PointeeType, Size, Align);
1458  TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1459  // TODO: This and the artificial type below are misleading, the
1460  // types aren't artificial the argument is, but the current
1461  // metadata doesn't represent that.
1462  ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1463  Elts.push_back(ThisPtrType);
1464  } else {
1465  llvm::DIType *ThisPtrType = getOrCreateType(ThisPtr, Unit);
1466  TypeCache[ThisPtr.getAsOpaquePtr()].reset(ThisPtrType);
1467  ThisPtrType = DBuilder.createObjectPointerType(ThisPtrType);
1468  Elts.push_back(ThisPtrType);
1469  }
1470 
1471  // Copy rest of the arguments.
1472  for (unsigned i = 1, e = Args.size(); i != e; ++i)
1473  Elts.push_back(Args[i]);
1474 
1475  llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
1476 
1477  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1478  if (Func->getExtProtoInfo().RefQualifier == RQ_LValue)
1479  Flags |= llvm::DINode::FlagLValueReference;
1480  if (Func->getExtProtoInfo().RefQualifier == RQ_RValue)
1481  Flags |= llvm::DINode::FlagRValueReference;
1482 
1483  return DBuilder.createSubroutineType(EltTypeArray, Flags,
1484  getDwarfCC(Func->getCallConv()));
1485 }
1486 
1487 /// isFunctionLocalClass - Return true if CXXRecordDecl is defined
1488 /// inside a function.
1489 static bool isFunctionLocalClass(const CXXRecordDecl *RD) {
1490  if (const auto *NRD = dyn_cast<CXXRecordDecl>(RD->getDeclContext()))
1491  return isFunctionLocalClass(NRD);
1492  if (isa<FunctionDecl>(RD->getDeclContext()))
1493  return true;
1494  return false;
1495 }
1496 
1497 llvm::DISubprogram *CGDebugInfo::CreateCXXMemberFunction(
1498  const CXXMethodDecl *Method, llvm::DIFile *Unit, llvm::DIType *RecordTy) {
1499  bool IsCtorOrDtor =
1500  isa<CXXConstructorDecl>(Method) || isa<CXXDestructorDecl>(Method);
1501 
1502  StringRef MethodName = getFunctionName(Method);
1503  llvm::DISubroutineType *MethodTy = getOrCreateMethodType(Method, Unit);
1504 
1505  // Since a single ctor/dtor corresponds to multiple functions, it doesn't
1506  // make sense to give a single ctor/dtor a linkage name.
1507  StringRef MethodLinkageName;
1508  // FIXME: 'isFunctionLocalClass' seems like an arbitrary/unintentional
1509  // property to use here. It may've been intended to model "is non-external
1510  // type" but misses cases of non-function-local but non-external classes such
1511  // as those in anonymous namespaces as well as the reverse - external types
1512  // that are function local, such as those in (non-local) inline functions.
1513  if (!IsCtorOrDtor && !isFunctionLocalClass(Method->getParent()))
1514  MethodLinkageName = CGM.getMangledName(Method);
1515 
1516  // Get the location for the method.
1517  llvm::DIFile *MethodDefUnit = nullptr;
1518  unsigned MethodLine = 0;
1519  if (!Method->isImplicit()) {
1520  MethodDefUnit = getOrCreateFile(Method->getLocation());
1521  MethodLine = getLineNumber(Method->getLocation());
1522  }
1523 
1524  // Collect virtual method info.
1525  llvm::DIType *ContainingType = nullptr;
1526  unsigned VIndex = 0;
1527  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
1528  llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
1529  int ThisAdjustment = 0;
1530 
1531  if (Method->isVirtual()) {
1532  if (Method->isPure())
1533  SPFlags |= llvm::DISubprogram::SPFlagPureVirtual;
1534  else
1535  SPFlags |= llvm::DISubprogram::SPFlagVirtual;
1536 
1537  if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1538  // It doesn't make sense to give a virtual destructor a vtable index,
1539  // since a single destructor has two entries in the vtable.
1540  if (!isa<CXXDestructorDecl>(Method))
1541  VIndex = CGM.getItaniumVTableContext().getMethodVTableIndex(Method);
1542  } else {
1543  // Emit MS ABI vftable information. There is only one entry for the
1544  // deleting dtor.
1545  const auto *DD = dyn_cast<CXXDestructorDecl>(Method);
1546  GlobalDecl GD = DD ? GlobalDecl(DD, Dtor_Deleting) : GlobalDecl(Method);
1548  CGM.getMicrosoftVTableContext().getMethodVFTableLocation(GD);
1549  VIndex = ML.Index;
1550 
1551  // CodeView only records the vftable offset in the class that introduces
1552  // the virtual method. This is possible because, unlike Itanium, the MS
1553  // C++ ABI does not include all virtual methods from non-primary bases in
1554  // the vtable for the most derived class. For example, if C inherits from
1555  // A and B, C's primary vftable will not include B's virtual methods.
1556  if (Method->size_overridden_methods() == 0)
1557  Flags |= llvm::DINode::FlagIntroducedVirtual;
1558 
1559  // The 'this' adjustment accounts for both the virtual and non-virtual
1560  // portions of the adjustment. Presumably the debugger only uses it when
1561  // it knows the dynamic type of an object.
1562  ThisAdjustment = CGM.getCXXABI()
1563  .getVirtualFunctionPrologueThisAdjustment(GD)
1564  .getQuantity();
1565  }
1566  ContainingType = RecordTy;
1567  }
1568 
1569  if (Method->isStatic())
1570  Flags |= llvm::DINode::FlagStaticMember;
1571  if (Method->isImplicit())
1572  Flags |= llvm::DINode::FlagArtificial;
1573  Flags |= getAccessFlag(Method->getAccess(), Method->getParent());
1574  if (const auto *CXXC = dyn_cast<CXXConstructorDecl>(Method)) {
1575  if (CXXC->isExplicit())
1576  Flags |= llvm::DINode::FlagExplicit;
1577  } else if (const auto *CXXC = dyn_cast<CXXConversionDecl>(Method)) {
1578  if (CXXC->isExplicit())
1579  Flags |= llvm::DINode::FlagExplicit;
1580  }
1581  if (Method->hasPrototype())
1582  Flags |= llvm::DINode::FlagPrototyped;
1583  if (Method->getRefQualifier() == RQ_LValue)
1584  Flags |= llvm::DINode::FlagLValueReference;
1585  if (Method->getRefQualifier() == RQ_RValue)
1586  Flags |= llvm::DINode::FlagRValueReference;
1587  if (CGM.getLangOpts().Optimize)
1588  SPFlags |= llvm::DISubprogram::SPFlagOptimized;
1589 
1590  llvm::DINodeArray TParamsArray = CollectFunctionTemplateParams(Method, Unit);
1591  llvm::DISubprogram *SP = DBuilder.createMethod(
1592  RecordTy, MethodName, MethodLinkageName, MethodDefUnit, MethodLine,
1593  MethodTy, VIndex, ThisAdjustment, ContainingType, Flags, SPFlags,
1594  TParamsArray.get());
1595 
1596  SPCache[Method->getCanonicalDecl()].reset(SP);
1597 
1598  return SP;
1599 }
1600 
1601 void CGDebugInfo::CollectCXXMemberFunctions(
1602  const CXXRecordDecl *RD, llvm::DIFile *Unit,
1603  SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy) {
1604 
1605  // Since we want more than just the individual member decls if we
1606  // have templated functions iterate over every declaration to gather
1607  // the functions.
1608  for (const auto *I : RD->decls()) {
1609  const auto *Method = dyn_cast<CXXMethodDecl>(I);
1610  // If the member is implicit, don't add it to the member list. This avoids
1611  // the member being added to type units by LLVM, while still allowing it
1612  // to be emitted into the type declaration/reference inside the compile
1613  // unit.
1614  // Ditto 'nodebug' methods, for consistency with CodeGenFunction.cpp.
1615  // FIXME: Handle Using(Shadow?)Decls here to create
1616  // DW_TAG_imported_declarations inside the class for base decls brought into
1617  // derived classes. GDB doesn't seem to notice/leverage these when I tried
1618  // it, so I'm not rushing to fix this. (GCC seems to produce them, if
1619  // referenced)
1620  if (!Method || Method->isImplicit() || Method->hasAttr<NoDebugAttr>())
1621  continue;
1622 
1623  if (Method->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
1624  continue;
1625 
1626  // Reuse the existing member function declaration if it exists.
1627  // It may be associated with the declaration of the type & should be
1628  // reused as we're building the definition.
1629  //
1630  // This situation can arise in the vtable-based debug info reduction where
1631  // implicit members are emitted in a non-vtable TU.
1632  auto MI = SPCache.find(Method->getCanonicalDecl());
1633  EltTys.push_back(MI == SPCache.end()
1634  ? CreateCXXMemberFunction(Method, Unit, RecordTy)
1635  : static_cast<llvm::Metadata *>(MI->second));
1636  }
1637 }
1638 
1639 void CGDebugInfo::CollectCXXBases(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1641  llvm::DIType *RecordTy) {
1643  CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->bases(), SeenTypes,
1644  llvm::DINode::FlagZero);
1645 
1646  // If we are generating CodeView debug info, we also need to emit records for
1647  // indirect virtual base classes.
1648  if (CGM.getCodeGenOpts().EmitCodeView) {
1649  CollectCXXBasesAux(RD, Unit, EltTys, RecordTy, RD->vbases(), SeenTypes,
1650  llvm::DINode::FlagIndirectVirtualBase);
1651  }
1652 }
1653 
1654 void CGDebugInfo::CollectCXXBasesAux(
1655  const CXXRecordDecl *RD, llvm::DIFile *Unit,
1656  SmallVectorImpl<llvm::Metadata *> &EltTys, llvm::DIType *RecordTy,
1659  llvm::DINode::DIFlags StartingFlags) {
1660  const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1661  for (const auto &BI : Bases) {
1662  const auto *Base =
1663  cast<CXXRecordDecl>(BI.getType()->getAs<RecordType>()->getDecl());
1664  if (!SeenTypes.insert(Base).second)
1665  continue;
1666  auto *BaseTy = getOrCreateType(BI.getType(), Unit);
1667  llvm::DINode::DIFlags BFlags = StartingFlags;
1668  uint64_t BaseOffset;
1669  uint32_t VBPtrOffset = 0;
1670 
1671  if (BI.isVirtual()) {
1672  if (CGM.getTarget().getCXXABI().isItaniumFamily()) {
1673  // virtual base offset offset is -ve. The code generator emits dwarf
1674  // expression where it expects +ve number.
1675  BaseOffset = 0 - CGM.getItaniumVTableContext()
1676  .getVirtualBaseOffsetOffset(RD, Base)
1677  .getQuantity();
1678  } else {
1679  // In the MS ABI, store the vbtable offset, which is analogous to the
1680  // vbase offset offset in Itanium.
1681  BaseOffset =
1682  4 * CGM.getMicrosoftVTableContext().getVBTableIndex(RD, Base);
1683  VBPtrOffset = CGM.getContext()
1684  .getASTRecordLayout(RD)
1685  .getVBPtrOffset()
1686  .getQuantity();
1687  }
1688  BFlags |= llvm::DINode::FlagVirtual;
1689  } else
1690  BaseOffset = CGM.getContext().toBits(RL.getBaseClassOffset(Base));
1691  // FIXME: Inconsistent units for BaseOffset. It is in bytes when
1692  // BI->isVirtual() and bits when not.
1693 
1694  BFlags |= getAccessFlag(BI.getAccessSpecifier(), RD);
1695  llvm::DIType *DTy = DBuilder.createInheritance(RecordTy, BaseTy, BaseOffset,
1696  VBPtrOffset, BFlags);
1697  EltTys.push_back(DTy);
1698  }
1699 }
1700 
1701 llvm::DINodeArray
1702 CGDebugInfo::CollectTemplateParams(const TemplateParameterList *TPList,
1704  llvm::DIFile *Unit) {
1705  SmallVector<llvm::Metadata *, 16> TemplateParams;
1706  for (unsigned i = 0, e = TAList.size(); i != e; ++i) {
1707  const TemplateArgument &TA = TAList[i];
1708  StringRef Name;
1709  if (TPList)
1710  Name = TPList->getParam(i)->getName();
1711  switch (TA.getKind()) {
1712  case TemplateArgument::Type: {
1713  llvm::DIType *TTy = getOrCreateType(TA.getAsType(), Unit);
1714  TemplateParams.push_back(
1715  DBuilder.createTemplateTypeParameter(TheCU, Name, TTy));
1716  } break;
1718  llvm::DIType *TTy = getOrCreateType(TA.getIntegralType(), Unit);
1719  TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1720  TheCU, Name, TTy,
1721  llvm::ConstantInt::get(CGM.getLLVMContext(), TA.getAsIntegral())));
1722  } break;
1724  const ValueDecl *D = TA.getAsDecl();
1725  QualType T = TA.getParamTypeForDecl().getDesugaredType(CGM.getContext());
1726  llvm::DIType *TTy = getOrCreateType(T, Unit);
1727  llvm::Constant *V = nullptr;
1728  // Skip retrieve the value if that template parameter has cuda device
1729  // attribute, i.e. that value is not available at the host side.
1730  if (!CGM.getLangOpts().CUDA || CGM.getLangOpts().CUDAIsDevice ||
1731  !D->hasAttr<CUDADeviceAttr>()) {
1732  const CXXMethodDecl *MD;
1733  // Variable pointer template parameters have a value that is the address
1734  // of the variable.
1735  if (const auto *VD = dyn_cast<VarDecl>(D))
1736  V = CGM.GetAddrOfGlobalVar(VD);
1737  // Member function pointers have special support for building them,
1738  // though this is currently unsupported in LLVM CodeGen.
1739  else if ((MD = dyn_cast<CXXMethodDecl>(D)) && MD->isInstance())
1740  V = CGM.getCXXABI().EmitMemberFunctionPointer(MD);
1741  else if (const auto *FD = dyn_cast<FunctionDecl>(D))
1742  V = CGM.GetAddrOfFunction(FD);
1743  // Member data pointers have special handling too to compute the fixed
1744  // offset within the object.
1745  else if (const auto *MPT =
1746  dyn_cast<MemberPointerType>(T.getTypePtr())) {
1747  // These five lines (& possibly the above member function pointer
1748  // handling) might be able to be refactored to use similar code in
1749  // CodeGenModule::getMemberPointerConstant
1750  uint64_t fieldOffset = CGM.getContext().getFieldOffset(D);
1751  CharUnits chars =
1752  CGM.getContext().toCharUnitsFromBits((int64_t)fieldOffset);
1753  V = CGM.getCXXABI().EmitMemberDataPointer(MPT, chars);
1754  }
1755  V = V->stripPointerCasts();
1756  }
1757  TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1758  TheCU, Name, TTy, cast_or_null<llvm::Constant>(V)));
1759  } break;
1761  QualType T = TA.getNullPtrType();
1762  llvm::DIType *TTy = getOrCreateType(T, Unit);
1763  llvm::Constant *V = nullptr;
1764  // Special case member data pointer null values since they're actually -1
1765  // instead of zero.
1766  if (const auto *MPT = dyn_cast<MemberPointerType>(T.getTypePtr()))
1767  // But treat member function pointers as simple zero integers because
1768  // it's easier than having a special case in LLVM's CodeGen. If LLVM
1769  // CodeGen grows handling for values of non-null member function
1770  // pointers then perhaps we could remove this special case and rely on
1771  // EmitNullMemberPointer for member function pointers.
1772  if (MPT->isMemberDataPointer())
1773  V = CGM.getCXXABI().EmitNullMemberPointer(MPT);
1774  if (!V)
1775  V = llvm::ConstantInt::get(CGM.Int8Ty, 0);
1776  TemplateParams.push_back(
1777  DBuilder.createTemplateValueParameter(TheCU, Name, TTy, V));
1778  } break;
1780  TemplateParams.push_back(DBuilder.createTemplateTemplateParameter(
1781  TheCU, Name, nullptr,
1783  break;
1785  TemplateParams.push_back(DBuilder.createTemplateParameterPack(
1786  TheCU, Name, nullptr,
1787  CollectTemplateParams(nullptr, TA.getPackAsArray(), Unit)));
1788  break;
1790  const Expr *E = TA.getAsExpr();
1791  QualType T = E->getType();
1792  if (E->isGLValue())
1793  T = CGM.getContext().getLValueReferenceType(T);
1794  llvm::Constant *V = ConstantEmitter(CGM).emitAbstract(E, T);
1795  assert(V && "Expression in template argument isn't constant");
1796  llvm::DIType *TTy = getOrCreateType(T, Unit);
1797  TemplateParams.push_back(DBuilder.createTemplateValueParameter(
1798  TheCU, Name, TTy, V->stripPointerCasts()));
1799  } break;
1800  // And the following should never occur:
1803  llvm_unreachable(
1804  "These argument types shouldn't exist in concrete types");
1805  }
1806  }
1807  return DBuilder.getOrCreateArray(TemplateParams);
1808 }
1809 
1810 llvm::DINodeArray
1811 CGDebugInfo::CollectFunctionTemplateParams(const FunctionDecl *FD,
1812  llvm::DIFile *Unit) {
1813  if (FD->getTemplatedKind() ==
1816  ->getTemplate()
1818  return CollectTemplateParams(
1819  TList, FD->getTemplateSpecializationArgs()->asArray(), Unit);
1820  }
1821  return llvm::DINodeArray();
1822 }
1823 
1824 llvm::DINodeArray CGDebugInfo::CollectVarTemplateParams(const VarDecl *VL,
1825  llvm::DIFile *Unit) {
1826  if (auto *TS = dyn_cast<VarTemplateSpecializationDecl>(VL)) {
1827  auto T = TS->getSpecializedTemplateOrPartial();
1828  auto TA = TS->getTemplateArgs().asArray();
1829  // Collect parameters for a partial specialization
1830  if (T.is<VarTemplatePartialSpecializationDecl *>()) {
1831  const TemplateParameterList *TList =
1833  ->getTemplateParameters();
1834  return CollectTemplateParams(TList, TA, Unit);
1835  }
1836 
1837  // Collect parameters for an explicit specialization
1838  if (T.is<VarTemplateDecl *>()) {
1839  const TemplateParameterList *TList = T.get<VarTemplateDecl *>()
1840  ->getTemplateParameters();
1841  return CollectTemplateParams(TList, TA, Unit);
1842  }
1843  }
1844  return llvm::DINodeArray();
1845 }
1846 
1847 llvm::DINodeArray CGDebugInfo::CollectCXXTemplateParams(
1848  const ClassTemplateSpecializationDecl *TSpecial, llvm::DIFile *Unit) {
1849  // Always get the full list of parameters, not just the ones from
1850  // the specialization.
1851  TemplateParameterList *TPList =
1853  const TemplateArgumentList &TAList = TSpecial->getTemplateArgs();
1854  return CollectTemplateParams(TPList, TAList.asArray(), Unit);
1855 }
1856 
1857 llvm::DIType *CGDebugInfo::getOrCreateVTablePtrType(llvm::DIFile *Unit) {
1858  if (VTablePtrType)
1859  return VTablePtrType;
1860 
1861  ASTContext &Context = CGM.getContext();
1862 
1863  /* Function type */
1864  llvm::Metadata *STy = getOrCreateType(Context.IntTy, Unit);
1865  llvm::DITypeRefArray SElements = DBuilder.getOrCreateTypeArray(STy);
1866  llvm::DIType *SubTy = DBuilder.createSubroutineType(SElements);
1867  unsigned Size = Context.getTypeSize(Context.VoidPtrTy);
1868  unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1869  Optional<unsigned> DWARFAddressSpace =
1870  CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1871 
1872  llvm::DIType *vtbl_ptr_type = DBuilder.createPointerType(
1873  SubTy, Size, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1874  VTablePtrType = DBuilder.createPointerType(vtbl_ptr_type, Size);
1875  return VTablePtrType;
1876 }
1877 
1878 StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) {
1879  // Copy the gdb compatible name on the side and use its reference.
1880  return internString("_vptr$", RD->getNameAsString());
1881 }
1882 
1883 void CGDebugInfo::CollectVTableInfo(const CXXRecordDecl *RD, llvm::DIFile *Unit,
1885  llvm::DICompositeType *RecordTy) {
1886  // If this class is not dynamic then there is not any vtable info to collect.
1887  if (!RD->isDynamicClass())
1888  return;
1889 
1890  // Don't emit any vtable shape or vptr info if this class doesn't have an
1891  // extendable vfptr. This can happen if the class doesn't have virtual
1892  // methods, or in the MS ABI if those virtual methods only come from virtually
1893  // inherited bases.
1894  const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
1895  if (!RL.hasExtendableVFPtr())
1896  return;
1897 
1898  // CodeView needs to know how large the vtable of every dynamic class is, so
1899  // emit a special named pointer type into the element list. The vptr type
1900  // points to this type as well.
1901  llvm::DIType *VPtrTy = nullptr;
1902  bool NeedVTableShape = CGM.getCodeGenOpts().EmitCodeView &&
1903  CGM.getTarget().getCXXABI().isMicrosoft();
1904  if (NeedVTableShape) {
1905  uint64_t PtrWidth =
1906  CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1907  const VTableLayout &VFTLayout =
1908  CGM.getMicrosoftVTableContext().getVFTableLayout(RD, CharUnits::Zero());
1909  unsigned VSlotCount =
1910  VFTLayout.vtable_components().size() - CGM.getLangOpts().RTTIData;
1911  unsigned VTableWidth = PtrWidth * VSlotCount;
1912  unsigned VtblPtrAddressSpace = CGM.getTarget().getVtblPtrAddressSpace();
1913  Optional<unsigned> DWARFAddressSpace =
1914  CGM.getTarget().getDWARFAddressSpace(VtblPtrAddressSpace);
1915 
1916  // Create a very wide void* type and insert it directly in the element list.
1917  llvm::DIType *VTableType = DBuilder.createPointerType(
1918  nullptr, VTableWidth, 0, DWARFAddressSpace, "__vtbl_ptr_type");
1919  EltTys.push_back(VTableType);
1920 
1921  // The vptr is a pointer to this special vtable type.
1922  VPtrTy = DBuilder.createPointerType(VTableType, PtrWidth);
1923  }
1924 
1925  // If there is a primary base then the artificial vptr member lives there.
1926  if (RL.getPrimaryBase())
1927  return;
1928 
1929  if (!VPtrTy)
1930  VPtrTy = getOrCreateVTablePtrType(Unit);
1931 
1932  unsigned Size = CGM.getContext().getTypeSize(CGM.getContext().VoidPtrTy);
1933  llvm::DIType *VPtrMember =
1934  DBuilder.createMemberType(Unit, getVTableName(RD), Unit, 0, Size, 0, 0,
1935  llvm::DINode::FlagArtificial, VPtrTy);
1936  EltTys.push_back(VPtrMember);
1937 }
1938 
1940  SourceLocation Loc) {
1941  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1942  llvm::DIType *T = getOrCreateType(RTy, getOrCreateFile(Loc));
1943  return T;
1944 }
1945 
1947  SourceLocation Loc) {
1948  return getOrCreateStandaloneType(D, Loc);
1949 }
1950 
1952  SourceLocation Loc) {
1953  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
1954  assert(!D.isNull() && "null type");
1955  llvm::DIType *T = getOrCreateType(D, getOrCreateFile(Loc));
1956  assert(T && "could not create debug info for type");
1957 
1958  RetainedTypes.push_back(D.getAsOpaquePtr());
1959  return T;
1960 }
1961 
1962 void CGDebugInfo::addHeapAllocSiteMetadata(llvm::Instruction *CI,
1963  QualType D,
1964  SourceLocation Loc) {
1965  llvm::MDNode *node;
1966  if (D.getTypePtr()->isVoidPointerType()) {
1967  node = llvm::MDNode::get(CGM.getLLVMContext(), None);
1968  } else {
1969  QualType PointeeTy = D.getTypePtr()->getPointeeType();
1970  node = getOrCreateType(PointeeTy, getOrCreateFile(Loc));
1971  }
1972  CI->setMetadata("heapallocsite", node);
1973 }
1974 
1976  if (DebugKind <= codegenoptions::DebugLineTablesOnly)
1977  return;
1978  QualType Ty = CGM.getContext().getEnumType(ED);
1979  void *TyPtr = Ty.getAsOpaquePtr();
1980  auto I = TypeCache.find(TyPtr);
1981  if (I == TypeCache.end() || !cast<llvm::DIType>(I->second)->isForwardDecl())
1982  return;
1983  llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<EnumType>());
1984  assert(!Res->isForwardDecl());
1985  TypeCache[TyPtr].reset(Res);
1986 }
1987 
1989  if (DebugKind > codegenoptions::LimitedDebugInfo ||
1990  !CGM.getLangOpts().CPlusPlus)
1991  completeRequiredType(RD);
1992 }
1993 
1994 /// Return true if the class or any of its methods are marked dllimport.
1995 static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD) {
1996  if (RD->hasAttr<DLLImportAttr>())
1997  return true;
1998  for (const CXXMethodDecl *MD : RD->methods())
1999  if (MD->hasAttr<DLLImportAttr>())
2000  return true;
2001  return false;
2002 }
2003 
2004 /// Does a type definition exist in an imported clang module?
2005 static bool isDefinedInClangModule(const RecordDecl *RD) {
2006  // Only definitions that where imported from an AST file come from a module.
2007  if (!RD || !RD->isFromASTFile())
2008  return false;
2009  // Anonymous entities cannot be addressed. Treat them as not from module.
2010  if (!RD->isExternallyVisible() && RD->getName().empty())
2011  return false;
2012  if (auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD)) {
2013  if (!CXXDecl->isCompleteDefinition())
2014  return false;
2015  // Check wether RD is a template.
2016  auto TemplateKind = CXXDecl->getTemplateSpecializationKind();
2017  if (TemplateKind != TSK_Undeclared) {
2018  // Unfortunately getOwningModule() isn't accurate enough to find the
2019  // owning module of a ClassTemplateSpecializationDecl that is inside a
2020  // namespace spanning multiple modules.
2021  bool Explicit = false;
2022  if (auto *TD = dyn_cast<ClassTemplateSpecializationDecl>(CXXDecl))
2023  Explicit = TD->isExplicitInstantiationOrSpecialization();
2024  if (!Explicit && CXXDecl->getEnclosingNamespaceContext())
2025  return false;
2026  // This is a template, check the origin of the first member.
2027  if (CXXDecl->field_begin() == CXXDecl->field_end())
2028  return TemplateKind == TSK_ExplicitInstantiationDeclaration;
2029  if (!CXXDecl->field_begin()->isFromASTFile())
2030  return false;
2031  }
2032  }
2033  return true;
2034 }
2035 
2037  if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RD))
2038  if (CXXRD->isDynamicClass() &&
2039  CGM.getVTableLinkage(CXXRD) ==
2040  llvm::GlobalValue::AvailableExternallyLinkage &&
2041  !isClassOrMethodDLLImport(CXXRD))
2042  return;
2043 
2044  if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2045  return;
2046 
2047  completeClass(RD);
2048 }
2049 
2051  if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2052  return;
2053  QualType Ty = CGM.getContext().getRecordType(RD);
2054  void *TyPtr = Ty.getAsOpaquePtr();
2055  auto I = TypeCache.find(TyPtr);
2056  if (I != TypeCache.end() && !cast<llvm::DIType>(I->second)->isForwardDecl())
2057  return;
2058  llvm::DIType *Res = CreateTypeDefinition(Ty->castAs<RecordType>());
2059  assert(!Res->isForwardDecl());
2060  TypeCache[TyPtr].reset(Res);
2061 }
2062 
2065  for (CXXMethodDecl *MD : llvm::make_range(I, End))
2067  if (!Tmpl->isImplicit() && Tmpl->isThisDeclarationADefinition() &&
2068  !MD->getMemberSpecializationInfo()->isExplicitSpecialization())
2069  return true;
2070  return false;
2071 }
2072 
2074  bool DebugTypeExtRefs, const RecordDecl *RD,
2075  const LangOptions &LangOpts) {
2076  if (DebugTypeExtRefs && isDefinedInClangModule(RD->getDefinition()))
2077  return true;
2078 
2079  if (auto *ES = RD->getASTContext().getExternalSource())
2080  if (ES->hasExternalDefinitions(RD) == ExternalASTSource::EK_Always)
2081  return true;
2082 
2083  if (DebugKind > codegenoptions::LimitedDebugInfo)
2084  return false;
2085 
2086  if (!LangOpts.CPlusPlus)
2087  return false;
2088 
2089  if (!RD->isCompleteDefinitionRequired())
2090  return true;
2091 
2092  const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2093 
2094  if (!CXXDecl)
2095  return false;
2096 
2097  // Only emit complete debug info for a dynamic class when its vtable is
2098  // emitted. However, Microsoft debuggers don't resolve type information
2099  // across DLL boundaries, so skip this optimization if the class or any of its
2100  // methods are marked dllimport. This isn't a complete solution, since objects
2101  // without any dllimport methods can be used in one DLL and constructed in
2102  // another, but it is the current behavior of LimitedDebugInfo.
2103  if (CXXDecl->hasDefinition() && CXXDecl->isDynamicClass() &&
2104  !isClassOrMethodDLLImport(CXXDecl))
2105  return true;
2106 
2108  if (const auto *SD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
2109  Spec = SD->getSpecializationKind();
2110 
2113  CXXDecl->method_end()))
2114  return true;
2115 
2116  return false;
2117 }
2118 
2120  if (shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD, CGM.getLangOpts()))
2121  return;
2122 
2123  QualType Ty = CGM.getContext().getRecordType(RD);
2124  llvm::DIType *T = getTypeOrNull(Ty);
2125  if (T && T->isForwardDecl())
2126  completeClassData(RD);
2127 }
2128 
2129 llvm::DIType *CGDebugInfo::CreateType(const RecordType *Ty) {
2130  RecordDecl *RD = Ty->getDecl();
2131  llvm::DIType *T = cast_or_null<llvm::DIType>(getTypeOrNull(QualType(Ty, 0)));
2132  if (T || shouldOmitDefinition(DebugKind, DebugTypeExtRefs, RD,
2133  CGM.getLangOpts())) {
2134  if (!T)
2135  T = getOrCreateRecordFwdDecl(Ty, getDeclContextDescriptor(RD));
2136  return T;
2137  }
2138 
2139  return CreateTypeDefinition(Ty);
2140 }
2141 
2142 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const RecordType *Ty) {
2143  RecordDecl *RD = Ty->getDecl();
2144 
2145  // Get overall information about the record type for the debug info.
2146  llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
2147 
2148  // Records and classes and unions can all be recursive. To handle them, we
2149  // first generate a debug descriptor for the struct as a forward declaration.
2150  // Then (if it is a definition) we go through and get debug info for all of
2151  // its members. Finally, we create a descriptor for the complete type (which
2152  // may refer to the forward decl if the struct is recursive) and replace all
2153  // uses of the forward declaration with the final definition.
2154  llvm::DICompositeType *FwdDecl = getOrCreateLimitedType(Ty, DefUnit);
2155 
2156  const RecordDecl *D = RD->getDefinition();
2157  if (!D || !D->isCompleteDefinition())
2158  return FwdDecl;
2159 
2160  if (const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD))
2161  CollectContainingType(CXXDecl, FwdDecl);
2162 
2163  // Push the struct on region stack.
2164  LexicalBlockStack.emplace_back(&*FwdDecl);
2165  RegionMap[Ty->getDecl()].reset(FwdDecl);
2166 
2167  // Convert all the elements.
2169  // what about nested types?
2170 
2171  // Note: The split of CXXDecl information here is intentional, the
2172  // gdb tests will depend on a certain ordering at printout. The debug
2173  // information offsets are still correct if we merge them all together
2174  // though.
2175  const auto *CXXDecl = dyn_cast<CXXRecordDecl>(RD);
2176  if (CXXDecl) {
2177  CollectCXXBases(CXXDecl, DefUnit, EltTys, FwdDecl);
2178  CollectVTableInfo(CXXDecl, DefUnit, EltTys, FwdDecl);
2179  }
2180 
2181  // Collect data fields (including static variables and any initializers).
2182  CollectRecordFields(RD, DefUnit, EltTys, FwdDecl);
2183  if (CXXDecl)
2184  CollectCXXMemberFunctions(CXXDecl, DefUnit, EltTys, FwdDecl);
2185 
2186  LexicalBlockStack.pop_back();
2187  RegionMap.erase(Ty->getDecl());
2188 
2189  llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2190  DBuilder.replaceArrays(FwdDecl, Elements);
2191 
2192  if (FwdDecl->isTemporary())
2193  FwdDecl =
2194  llvm::MDNode::replaceWithPermanent(llvm::TempDICompositeType(FwdDecl));
2195 
2196  RegionMap[Ty->getDecl()].reset(FwdDecl);
2197  return FwdDecl;
2198 }
2199 
2200 llvm::DIType *CGDebugInfo::CreateType(const ObjCObjectType *Ty,
2201  llvm::DIFile *Unit) {
2202  // Ignore protocols.
2203  return getOrCreateType(Ty->getBaseType(), Unit);
2204 }
2205 
2206 llvm::DIType *CGDebugInfo::CreateType(const ObjCTypeParamType *Ty,
2207  llvm::DIFile *Unit) {
2208  // Ignore protocols.
2209  SourceLocation Loc = Ty->getDecl()->getLocation();
2210 
2211  // Use Typedefs to represent ObjCTypeParamType.
2212  return DBuilder.createTypedef(
2213  getOrCreateType(Ty->getDecl()->getUnderlyingType(), Unit),
2214  Ty->getDecl()->getName(), getOrCreateFile(Loc), getLineNumber(Loc),
2215  getDeclContextDescriptor(Ty->getDecl()));
2216 }
2217 
2218 /// \return true if Getter has the default name for the property PD.
2220  const ObjCMethodDecl *Getter) {
2221  assert(PD);
2222  if (!Getter)
2223  return true;
2224 
2225  assert(Getter->getDeclName().isObjCZeroArgSelector());
2226  return PD->getName() ==
2228 }
2229 
2230 /// \return true if Setter has the default name for the property PD.
2232  const ObjCMethodDecl *Setter) {
2233  assert(PD);
2234  if (!Setter)
2235  return true;
2236 
2237  assert(Setter->getDeclName().isObjCOneArgSelector());
2240 }
2241 
2242 llvm::DIType *CGDebugInfo::CreateType(const ObjCInterfaceType *Ty,
2243  llvm::DIFile *Unit) {
2244  ObjCInterfaceDecl *ID = Ty->getDecl();
2245  if (!ID)
2246  return nullptr;
2247 
2248  // Return a forward declaration if this type was imported from a clang module,
2249  // and this is not the compile unit with the implementation of the type (which
2250  // may contain hidden ivars).
2251  if (DebugTypeExtRefs && ID->isFromASTFile() && ID->getDefinition() &&
2252  !ID->getImplementation())
2253  return DBuilder.createForwardDecl(llvm::dwarf::DW_TAG_structure_type,
2254  ID->getName(),
2255  getDeclContextDescriptor(ID), Unit, 0);
2256 
2257  // Get overall information about the record type for the debug info.
2258  llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2259  unsigned Line = getLineNumber(ID->getLocation());
2260  auto RuntimeLang =
2261  static_cast<llvm::dwarf::SourceLanguage>(TheCU->getSourceLanguage());
2262 
2263  // If this is just a forward declaration return a special forward-declaration
2264  // debug type since we won't be able to lay out the entire type.
2265  ObjCInterfaceDecl *Def = ID->getDefinition();
2266  if (!Def || !Def->getImplementation()) {
2267  llvm::DIScope *Mod = getParentModuleOrNull(ID);
2268  llvm::DIType *FwdDecl = DBuilder.createReplaceableCompositeType(
2269  llvm::dwarf::DW_TAG_structure_type, ID->getName(), Mod ? Mod : TheCU,
2270  DefUnit, Line, RuntimeLang);
2271  ObjCInterfaceCache.push_back(ObjCInterfaceCacheEntry(Ty, FwdDecl, Unit));
2272  return FwdDecl;
2273  }
2274 
2275  return CreateTypeDefinition(Ty, Unit);
2276 }
2277 
2278 llvm::DIModule *
2279 CGDebugInfo::getOrCreateModuleRef(ExternalASTSource::ASTSourceDescriptor Mod,
2280  bool CreateSkeletonCU) {
2281  // Use the Module pointer as the key into the cache. This is a
2282  // nullptr if the "Module" is a PCH, which is safe because we don't
2283  // support chained PCH debug info, so there can only be a single PCH.
2284  const Module *M = Mod.getModuleOrNull();
2285  auto ModRef = ModuleCache.find(M);
2286  if (ModRef != ModuleCache.end())
2287  return cast<llvm::DIModule>(ModRef->second);
2288 
2289  // Macro definitions that were defined with "-D" on the command line.
2290  SmallString<128> ConfigMacros;
2291  {
2292  llvm::raw_svector_ostream OS(ConfigMacros);
2293  const auto &PPOpts = CGM.getPreprocessorOpts();
2294  unsigned I = 0;
2295  // Translate the macro definitions back into a command line.
2296  for (auto &M : PPOpts.Macros) {
2297  if (++I > 1)
2298  OS << " ";
2299  const std::string &Macro = M.first;
2300  bool Undef = M.second;
2301  OS << "\"-" << (Undef ? 'U' : 'D');
2302  for (char c : Macro)
2303  switch (c) {
2304  case '\\':
2305  OS << "\\\\";
2306  break;
2307  case '"':
2308  OS << "\\\"";
2309  break;
2310  default:
2311  OS << c;
2312  }
2313  OS << '\"';
2314  }
2315  }
2316 
2317  bool IsRootModule = M ? !M->Parent : true;
2318  // When a module name is specified as -fmodule-name, that module gets a
2319  // clang::Module object, but it won't actually be built or imported; it will
2320  // be textual.
2321  if (CreateSkeletonCU && IsRootModule && Mod.getASTFile().empty() && M)
2322  assert(StringRef(M->Name).startswith(CGM.getLangOpts().ModuleName) &&
2323  "clang module without ASTFile must be specified by -fmodule-name");
2324 
2325  if (CreateSkeletonCU && IsRootModule && !Mod.getASTFile().empty()) {
2326  // PCH files don't have a signature field in the control block,
2327  // but LLVM detects skeleton CUs by looking for a non-zero DWO id.
2328  // We use the lower 64 bits for debug info.
2329  uint64_t Signature =
2330  Mod.getSignature()
2331  ? (uint64_t)Mod.getSignature()[1] << 32 | Mod.getSignature()[0]
2332  : ~1ULL;
2333  llvm::DIBuilder DIB(CGM.getModule());
2334  DIB.createCompileUnit(TheCU->getSourceLanguage(),
2335  // TODO: Support "Source" from external AST providers?
2336  DIB.createFile(Mod.getModuleName(), Mod.getPath()),
2337  TheCU->getProducer(), true, StringRef(), 0,
2338  Mod.getASTFile(), llvm::DICompileUnit::FullDebug,
2339  Signature);
2340  DIB.finalize();
2341  }
2342 
2343  llvm::DIModule *Parent =
2344  IsRootModule ? nullptr
2345  : getOrCreateModuleRef(
2347  CreateSkeletonCU);
2348  llvm::DIModule *DIMod =
2349  DBuilder.createModule(Parent, Mod.getModuleName(), ConfigMacros,
2350  Mod.getPath(), CGM.getHeaderSearchOpts().Sysroot);
2351  ModuleCache[M].reset(DIMod);
2352  return DIMod;
2353 }
2354 
2355 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const ObjCInterfaceType *Ty,
2356  llvm::DIFile *Unit) {
2357  ObjCInterfaceDecl *ID = Ty->getDecl();
2358  llvm::DIFile *DefUnit = getOrCreateFile(ID->getLocation());
2359  unsigned Line = getLineNumber(ID->getLocation());
2360  unsigned RuntimeLang = TheCU->getSourceLanguage();
2361 
2362  // Bit size, align and offset of the type.
2363  uint64_t Size = CGM.getContext().getTypeSize(Ty);
2364  auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2365 
2366  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2367  if (ID->getImplementation())
2368  Flags |= llvm::DINode::FlagObjcClassComplete;
2369 
2370  llvm::DIScope *Mod = getParentModuleOrNull(ID);
2371  llvm::DICompositeType *RealDecl = DBuilder.createStructType(
2372  Mod ? Mod : Unit, ID->getName(), DefUnit, Line, Size, Align, Flags,
2373  nullptr, llvm::DINodeArray(), RuntimeLang);
2374 
2375  QualType QTy(Ty, 0);
2376  TypeCache[QTy.getAsOpaquePtr()].reset(RealDecl);
2377 
2378  // Push the struct on region stack.
2379  LexicalBlockStack.emplace_back(RealDecl);
2380  RegionMap[Ty->getDecl()].reset(RealDecl);
2381 
2382  // Convert all the elements.
2384 
2385  ObjCInterfaceDecl *SClass = ID->getSuperClass();
2386  if (SClass) {
2387  llvm::DIType *SClassTy =
2388  getOrCreateType(CGM.getContext().getObjCInterfaceType(SClass), Unit);
2389  if (!SClassTy)
2390  return nullptr;
2391 
2392  llvm::DIType *InhTag = DBuilder.createInheritance(RealDecl, SClassTy, 0, 0,
2393  llvm::DINode::FlagZero);
2394  EltTys.push_back(InhTag);
2395  }
2396 
2397  // Create entries for all of the properties.
2398  auto AddProperty = [&](const ObjCPropertyDecl *PD) {
2399  SourceLocation Loc = PD->getLocation();
2400  llvm::DIFile *PUnit = getOrCreateFile(Loc);
2401  unsigned PLine = getLineNumber(Loc);
2402  ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2403  ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2404  llvm::MDNode *PropertyNode = DBuilder.createObjCProperty(
2405  PD->getName(), PUnit, PLine,
2406  hasDefaultGetterName(PD, Getter) ? ""
2407  : getSelectorName(PD->getGetterName()),
2408  hasDefaultSetterName(PD, Setter) ? ""
2409  : getSelectorName(PD->getSetterName()),
2410  PD->getPropertyAttributes(), getOrCreateType(PD->getType(), PUnit));
2411  EltTys.push_back(PropertyNode);
2412  };
2413  {
2414  llvm::SmallPtrSet<const IdentifierInfo *, 16> PropertySet;
2415  for (const ObjCCategoryDecl *ClassExt : ID->known_extensions())
2416  for (auto *PD : ClassExt->properties()) {
2417  PropertySet.insert(PD->getIdentifier());
2418  AddProperty(PD);
2419  }
2420  for (const auto *PD : ID->properties()) {
2421  // Don't emit duplicate metadata for properties that were already in a
2422  // class extension.
2423  if (!PropertySet.insert(PD->getIdentifier()).second)
2424  continue;
2425  AddProperty(PD);
2426  }
2427  }
2428 
2429  const ASTRecordLayout &RL = CGM.getContext().getASTObjCInterfaceLayout(ID);
2430  unsigned FieldNo = 0;
2431  for (ObjCIvarDecl *Field = ID->all_declared_ivar_begin(); Field;
2432  Field = Field->getNextIvar(), ++FieldNo) {
2433  llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
2434  if (!FieldTy)
2435  return nullptr;
2436 
2437  StringRef FieldName = Field->getName();
2438 
2439  // Ignore unnamed fields.
2440  if (FieldName.empty())
2441  continue;
2442 
2443  // Get the location for the field.
2444  llvm::DIFile *FieldDefUnit = getOrCreateFile(Field->getLocation());
2445  unsigned FieldLine = getLineNumber(Field->getLocation());
2446  QualType FType = Field->getType();
2447  uint64_t FieldSize = 0;
2448  uint32_t FieldAlign = 0;
2449 
2450  if (!FType->isIncompleteArrayType()) {
2451 
2452  // Bit size, align and offset of the type.
2453  FieldSize = Field->isBitField()
2454  ? Field->getBitWidthValue(CGM.getContext())
2455  : CGM.getContext().getTypeSize(FType);
2456  FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
2457  }
2458 
2459  uint64_t FieldOffset;
2460  if (CGM.getLangOpts().ObjCRuntime.isNonFragile()) {
2461  // We don't know the runtime offset of an ivar if we're using the
2462  // non-fragile ABI. For bitfields, use the bit offset into the first
2463  // byte of storage of the bitfield. For other fields, use zero.
2464  if (Field->isBitField()) {
2465  FieldOffset =
2466  CGM.getObjCRuntime().ComputeBitfieldBitOffset(CGM, ID, Field);
2467  FieldOffset %= CGM.getContext().getCharWidth();
2468  } else {
2469  FieldOffset = 0;
2470  }
2471  } else {
2472  FieldOffset = RL.getFieldOffset(FieldNo);
2473  }
2474 
2475  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2476  if (Field->getAccessControl() == ObjCIvarDecl::Protected)
2477  Flags = llvm::DINode::FlagProtected;
2478  else if (Field->getAccessControl() == ObjCIvarDecl::Private)
2479  Flags = llvm::DINode::FlagPrivate;
2480  else if (Field->getAccessControl() == ObjCIvarDecl::Public)
2481  Flags = llvm::DINode::FlagPublic;
2482 
2483  llvm::MDNode *PropertyNode = nullptr;
2484  if (ObjCImplementationDecl *ImpD = ID->getImplementation()) {
2485  if (ObjCPropertyImplDecl *PImpD =
2486  ImpD->FindPropertyImplIvarDecl(Field->getIdentifier())) {
2487  if (ObjCPropertyDecl *PD = PImpD->getPropertyDecl()) {
2488  SourceLocation Loc = PD->getLocation();
2489  llvm::DIFile *PUnit = getOrCreateFile(Loc);
2490  unsigned PLine = getLineNumber(Loc);
2491  ObjCMethodDecl *Getter = PD->getGetterMethodDecl();
2492  ObjCMethodDecl *Setter = PD->getSetterMethodDecl();
2493  PropertyNode = DBuilder.createObjCProperty(
2494  PD->getName(), PUnit, PLine,
2495  hasDefaultGetterName(PD, Getter)
2496  ? ""
2497  : getSelectorName(PD->getGetterName()),
2498  hasDefaultSetterName(PD, Setter)
2499  ? ""
2500  : getSelectorName(PD->getSetterName()),
2501  PD->getPropertyAttributes(),
2502  getOrCreateType(PD->getType(), PUnit));
2503  }
2504  }
2505  }
2506  FieldTy = DBuilder.createObjCIVar(FieldName, FieldDefUnit, FieldLine,
2507  FieldSize, FieldAlign, FieldOffset, Flags,
2508  FieldTy, PropertyNode);
2509  EltTys.push_back(FieldTy);
2510  }
2511 
2512  llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
2513  DBuilder.replaceArrays(RealDecl, Elements);
2514 
2515  LexicalBlockStack.pop_back();
2516  return RealDecl;
2517 }
2518 
2519 llvm::DIType *CGDebugInfo::CreateType(const VectorType *Ty,
2520  llvm::DIFile *Unit) {
2521  llvm::DIType *ElementTy = getOrCreateType(Ty->getElementType(), Unit);
2522  int64_t Count = Ty->getNumElements();
2523 
2524  llvm::Metadata *Subscript;
2525  QualType QTy(Ty, 0);
2526  auto SizeExpr = SizeExprCache.find(QTy);
2527  if (SizeExpr != SizeExprCache.end())
2528  Subscript = DBuilder.getOrCreateSubrange(0, SizeExpr->getSecond());
2529  else
2530  Subscript = DBuilder.getOrCreateSubrange(0, Count ? Count : -1);
2531  llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscript);
2532 
2533  uint64_t Size = CGM.getContext().getTypeSize(Ty);
2534  auto Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2535 
2536  return DBuilder.createVectorType(Size, Align, ElementTy, SubscriptArray);
2537 }
2538 
2539 llvm::DIType *CGDebugInfo::CreateType(const ArrayType *Ty, llvm::DIFile *Unit) {
2540  uint64_t Size;
2541  uint32_t Align;
2542 
2543  // FIXME: make getTypeAlign() aware of VLAs and incomplete array types
2544  if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2545  Size = 0;
2546  Align = getTypeAlignIfRequired(CGM.getContext().getBaseElementType(VAT),
2547  CGM.getContext());
2548  } else if (Ty->isIncompleteArrayType()) {
2549  Size = 0;
2550  if (Ty->getElementType()->isIncompleteType())
2551  Align = 0;
2552  else
2553  Align = getTypeAlignIfRequired(Ty->getElementType(), CGM.getContext());
2554  } else if (Ty->isIncompleteType()) {
2555  Size = 0;
2556  Align = 0;
2557  } else {
2558  // Size and align of the whole array, not the element type.
2559  Size = CGM.getContext().getTypeSize(Ty);
2560  Align = getTypeAlignIfRequired(Ty, CGM.getContext());
2561  }
2562 
2563  // Add the dimensions of the array. FIXME: This loses CV qualifiers from
2564  // interior arrays, do we care? Why aren't nested arrays represented the
2565  // obvious/recursive way?
2567  QualType EltTy(Ty, 0);
2568  while ((Ty = dyn_cast<ArrayType>(EltTy))) {
2569  // If the number of elements is known, then count is that number. Otherwise,
2570  // it's -1. This allows us to represent a subrange with an array of 0
2571  // elements, like this:
2572  //
2573  // struct foo {
2574  // int x[0];
2575  // };
2576  int64_t Count = -1; // Count == -1 is an unbounded array.
2577  if (const auto *CAT = dyn_cast<ConstantArrayType>(Ty))
2578  Count = CAT->getSize().getZExtValue();
2579  else if (const auto *VAT = dyn_cast<VariableArrayType>(Ty)) {
2580  if (Expr *Size = VAT->getSizeExpr()) {
2581  Expr::EvalResult Result;
2582  if (Size->EvaluateAsInt(Result, CGM.getContext()))
2583  Count = Result.Val.getInt().getExtValue();
2584  }
2585  }
2586 
2587  auto SizeNode = SizeExprCache.find(EltTy);
2588  if (SizeNode != SizeExprCache.end())
2589  Subscripts.push_back(
2590  DBuilder.getOrCreateSubrange(0, SizeNode->getSecond()));
2591  else
2592  Subscripts.push_back(DBuilder.getOrCreateSubrange(0, Count));
2593  EltTy = Ty->getElementType();
2594  }
2595 
2596  llvm::DINodeArray SubscriptArray = DBuilder.getOrCreateArray(Subscripts);
2597 
2598  return DBuilder.createArrayType(Size, Align, getOrCreateType(EltTy, Unit),
2599  SubscriptArray);
2600 }
2601 
2602 llvm::DIType *CGDebugInfo::CreateType(const LValueReferenceType *Ty,
2603  llvm::DIFile *Unit) {
2604  return CreatePointerLikeType(llvm::dwarf::DW_TAG_reference_type, Ty,
2605  Ty->getPointeeType(), Unit);
2606 }
2607 
2608 llvm::DIType *CGDebugInfo::CreateType(const RValueReferenceType *Ty,
2609  llvm::DIFile *Unit) {
2610  return CreatePointerLikeType(llvm::dwarf::DW_TAG_rvalue_reference_type, Ty,
2611  Ty->getPointeeType(), Unit);
2612 }
2613 
2614 llvm::DIType *CGDebugInfo::CreateType(const MemberPointerType *Ty,
2615  llvm::DIFile *U) {
2616  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
2617  uint64_t Size = 0;
2618 
2619  if (!Ty->isIncompleteType()) {
2620  Size = CGM.getContext().getTypeSize(Ty);
2621 
2622  // Set the MS inheritance model. There is no flag for the unspecified model.
2623  if (CGM.getTarget().getCXXABI().isMicrosoft()) {
2625  case MSInheritanceAttr::Keyword_single_inheritance:
2626  Flags |= llvm::DINode::FlagSingleInheritance;
2627  break;
2628  case MSInheritanceAttr::Keyword_multiple_inheritance:
2629  Flags |= llvm::DINode::FlagMultipleInheritance;
2630  break;
2631  case MSInheritanceAttr::Keyword_virtual_inheritance:
2632  Flags |= llvm::DINode::FlagVirtualInheritance;
2633  break;
2634  case MSInheritanceAttr::Keyword_unspecified_inheritance:
2635  break;
2636  }
2637  }
2638  }
2639 
2640  llvm::DIType *ClassType = getOrCreateType(QualType(Ty->getClass(), 0), U);
2641  if (Ty->isMemberDataPointerType())
2642  return DBuilder.createMemberPointerType(
2643  getOrCreateType(Ty->getPointeeType(), U), ClassType, Size, /*Align=*/0,
2644  Flags);
2645 
2646  const FunctionProtoType *FPT =
2648  return DBuilder.createMemberPointerType(
2649  getOrCreateInstanceMethodType(
2651  FPT, U),
2652  ClassType, Size, /*Align=*/0, Flags);
2653 }
2654 
2655 llvm::DIType *CGDebugInfo::CreateType(const AtomicType *Ty, llvm::DIFile *U) {
2656  auto *FromTy = getOrCreateType(Ty->getValueType(), U);
2657  return DBuilder.createQualifiedType(llvm::dwarf::DW_TAG_atomic_type, FromTy);
2658 }
2659 
2660 llvm::DIType *CGDebugInfo::CreateType(const PipeType *Ty, llvm::DIFile *U) {
2661  return getOrCreateType(Ty->getElementType(), U);
2662 }
2663 
2664 llvm::DIType *CGDebugInfo::CreateEnumType(const EnumType *Ty) {
2665  const EnumDecl *ED = Ty->getDecl();
2666 
2667  uint64_t Size = 0;
2668  uint32_t Align = 0;
2669  if (!ED->getTypeForDecl()->isIncompleteType()) {
2670  Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2671  Align = getDeclAlignIfRequired(ED, CGM.getContext());
2672  }
2673 
2674  SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2675 
2676  bool isImportedFromModule =
2677  DebugTypeExtRefs && ED->isFromASTFile() && ED->getDefinition();
2678 
2679  // If this is just a forward declaration, construct an appropriately
2680  // marked node and just return it.
2681  if (isImportedFromModule || !ED->getDefinition()) {
2682  // Note that it is possible for enums to be created as part of
2683  // their own declcontext. In this case a FwdDecl will be created
2684  // twice. This doesn't cause a problem because both FwdDecls are
2685  // entered into the ReplaceMap: finalize() will replace the first
2686  // FwdDecl with the second and then replace the second with
2687  // complete type.
2688  llvm::DIScope *EDContext = getDeclContextDescriptor(ED);
2689  llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2690  llvm::TempDIScope TmpContext(DBuilder.createReplaceableCompositeType(
2691  llvm::dwarf::DW_TAG_enumeration_type, "", TheCU, DefUnit, 0));
2692 
2693  unsigned Line = getLineNumber(ED->getLocation());
2694  StringRef EDName = ED->getName();
2695  llvm::DIType *RetTy = DBuilder.createReplaceableCompositeType(
2696  llvm::dwarf::DW_TAG_enumeration_type, EDName, EDContext, DefUnit, Line,
2697  0, Size, Align, llvm::DINode::FlagFwdDecl, Identifier);
2698 
2699  ReplaceMap.emplace_back(
2700  std::piecewise_construct, std::make_tuple(Ty),
2701  std::make_tuple(static_cast<llvm::Metadata *>(RetTy)));
2702  return RetTy;
2703  }
2704 
2705  return CreateTypeDefinition(Ty);
2706 }
2707 
2708 llvm::DIType *CGDebugInfo::CreateTypeDefinition(const EnumType *Ty) {
2709  const EnumDecl *ED = Ty->getDecl();
2710  uint64_t Size = 0;
2711  uint32_t Align = 0;
2712  if (!ED->getTypeForDecl()->isIncompleteType()) {
2713  Size = CGM.getContext().getTypeSize(ED->getTypeForDecl());
2714  Align = getDeclAlignIfRequired(ED, CGM.getContext());
2715  }
2716 
2717  SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
2718 
2719  // Create elements for each enumerator.
2721  ED = ED->getDefinition();
2722  bool IsSigned = ED->getIntegerType()->isSignedIntegerType();
2723  for (const auto *Enum : ED->enumerators()) {
2724  const auto &InitVal = Enum->getInitVal();
2725  auto Value = IsSigned ? InitVal.getSExtValue() : InitVal.getZExtValue();
2726  Enumerators.push_back(
2727  DBuilder.createEnumerator(Enum->getName(), Value, !IsSigned));
2728  }
2729 
2730  // Return a CompositeType for the enum itself.
2731  llvm::DINodeArray EltArray = DBuilder.getOrCreateArray(Enumerators);
2732 
2733  llvm::DIFile *DefUnit = getOrCreateFile(ED->getLocation());
2734  unsigned Line = getLineNumber(ED->getLocation());
2735  llvm::DIScope *EnumContext = getDeclContextDescriptor(ED);
2736  llvm::DIType *ClassTy = getOrCreateType(ED->getIntegerType(), DefUnit);
2737  return DBuilder.createEnumerationType(EnumContext, ED->getName(), DefUnit,
2738  Line, Size, Align, EltArray, ClassTy,
2739  Identifier, ED->isScoped());
2740 }
2741 
2742 llvm::DIMacro *CGDebugInfo::CreateMacro(llvm::DIMacroFile *Parent,
2743  unsigned MType, SourceLocation LineLoc,
2744  StringRef Name, StringRef Value) {
2745  unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2746  return DBuilder.createMacro(Parent, Line, MType, Name, Value);
2747 }
2748 
2749 llvm::DIMacroFile *CGDebugInfo::CreateTempMacroFile(llvm::DIMacroFile *Parent,
2750  SourceLocation LineLoc,
2751  SourceLocation FileLoc) {
2752  llvm::DIFile *FName = getOrCreateFile(FileLoc);
2753  unsigned Line = LineLoc.isInvalid() ? 0 : getLineNumber(LineLoc);
2754  return DBuilder.createTempMacroFile(Parent, Line, FName);
2755 }
2756 
2758  Qualifiers Quals;
2759  do {
2760  Qualifiers InnerQuals = T.getLocalQualifiers();
2761  // Qualifiers::operator+() doesn't like it if you add a Qualifier
2762  // that is already there.
2763  Quals += Qualifiers::removeCommonQualifiers(Quals, InnerQuals);
2764  Quals += InnerQuals;
2765  QualType LastT = T;
2766  switch (T->getTypeClass()) {
2767  default:
2768  return C.getQualifiedType(T.getTypePtr(), Quals);
2769  case Type::TemplateSpecialization: {
2770  const auto *Spec = cast<TemplateSpecializationType>(T);
2771  if (Spec->isTypeAlias())
2772  return C.getQualifiedType(T.getTypePtr(), Quals);
2773  T = Spec->desugar();
2774  break;
2775  }
2776  case Type::TypeOfExpr:
2777  T = cast<TypeOfExprType>(T)->getUnderlyingExpr()->getType();
2778  break;
2779  case Type::TypeOf:
2780  T = cast<TypeOfType>(T)->getUnderlyingType();
2781  break;
2782  case Type::Decltype:
2783  T = cast<DecltypeType>(T)->getUnderlyingType();
2784  break;
2785  case Type::UnaryTransform:
2786  T = cast<UnaryTransformType>(T)->getUnderlyingType();
2787  break;
2788  case Type::Attributed:
2789  T = cast<AttributedType>(T)->getEquivalentType();
2790  break;
2791  case Type::Elaborated:
2792  T = cast<ElaboratedType>(T)->getNamedType();
2793  break;
2794  case Type::Paren:
2795  T = cast<ParenType>(T)->getInnerType();
2796  break;
2797  case Type::SubstTemplateTypeParm:
2798  T = cast<SubstTemplateTypeParmType>(T)->getReplacementType();
2799  break;
2800  case Type::Auto:
2801  case Type::DeducedTemplateSpecialization: {
2802  QualType DT = cast<DeducedType>(T)->getDeducedType();
2803  assert(!DT.isNull() && "Undeduced types shouldn't reach here.");
2804  T = DT;
2805  break;
2806  }
2807  case Type::Adjusted:
2808  case Type::Decayed:
2809  // Decayed and adjusted types use the adjusted type in LLVM and DWARF.
2810  T = cast<AdjustedType>(T)->getAdjustedType();
2811  break;
2812  }
2813 
2814  assert(T != LastT && "Type unwrapping failed to unwrap!");
2815  (void)LastT;
2816  } while (true);
2817 }
2818 
2819 llvm::DIType *CGDebugInfo::getTypeOrNull(QualType Ty) {
2820 
2821  // Unwrap the type as needed for debug information.
2822  Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2823 
2824  auto It = TypeCache.find(Ty.getAsOpaquePtr());
2825  if (It != TypeCache.end()) {
2826  // Verify that the debug info still exists.
2827  if (llvm::Metadata *V = It->second)
2828  return cast<llvm::DIType>(V);
2829  }
2830 
2831  return nullptr;
2832 }
2833 
2835  const ClassTemplateSpecializationDecl &SD) {
2836  if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2837  return;
2838  completeUnusedClass(SD);
2839 }
2840 
2842  if (DebugKind <= codegenoptions::DebugLineTablesOnly)
2843  return;
2844 
2845  completeClassData(&D);
2846  // In case this type has no member function definitions being emitted, ensure
2847  // it is retained
2848  RetainedTypes.push_back(CGM.getContext().getRecordType(&D).getAsOpaquePtr());
2849 }
2850 
2851 llvm::DIType *CGDebugInfo::getOrCreateType(QualType Ty, llvm::DIFile *Unit) {
2852  if (Ty.isNull())
2853  return nullptr;
2854 
2855  // Unwrap the type as needed for debug information.
2856  Ty = UnwrapTypeForDebugInfo(Ty, CGM.getContext());
2857 
2858  if (auto *T = getTypeOrNull(Ty))
2859  return T;
2860 
2861  llvm::DIType *Res = CreateTypeNode(Ty, Unit);
2862  void *TyPtr = Ty.getAsOpaquePtr();
2863 
2864  // And update the type cache.
2865  TypeCache[TyPtr].reset(Res);
2866 
2867  return Res;
2868 }
2869 
2870 llvm::DIModule *CGDebugInfo::getParentModuleOrNull(const Decl *D) {
2871  // A forward declaration inside a module header does not belong to the module.
2872  if (isa<RecordDecl>(D) && !cast<RecordDecl>(D)->getDefinition())
2873  return nullptr;
2874  if (DebugTypeExtRefs && D->isFromASTFile()) {
2875  // Record a reference to an imported clang module or precompiled header.
2876  auto *Reader = CGM.getContext().getExternalSource();
2877  auto Idx = D->getOwningModuleID();
2878  auto Info = Reader->getSourceDescriptor(Idx);
2879  if (Info)
2880  return getOrCreateModuleRef(*Info, /*SkeletonCU=*/true);
2881  } else if (ClangModuleMap) {
2882  // We are building a clang module or a precompiled header.
2883  //
2884  // TODO: When D is a CXXRecordDecl or a C++ Enum, the ODR applies
2885  // and it wouldn't be necessary to specify the parent scope
2886  // because the type is already unique by definition (it would look
2887  // like the output of -fno-standalone-debug). On the other hand,
2888  // the parent scope helps a consumer to quickly locate the object
2889  // file where the type's definition is located, so it might be
2890  // best to make this behavior a command line or debugger tuning
2891  // option.
2892  if (Module *M = D->getOwningModule()) {
2893  // This is a (sub-)module.
2895  return getOrCreateModuleRef(Info, /*SkeletonCU=*/false);
2896  } else {
2897  // This the precompiled header being built.
2898  return getOrCreateModuleRef(PCHDescriptor, /*SkeletonCU=*/false);
2899  }
2900  }
2901 
2902  return nullptr;
2903 }
2904 
2905 llvm::DIType *CGDebugInfo::CreateTypeNode(QualType Ty, llvm::DIFile *Unit) {
2906  // Handle qualifiers, which recursively handles what they refer to.
2907  if (Ty.hasLocalQualifiers())
2908  return CreateQualifiedType(Ty, Unit);
2909 
2910  // Work out details of type.
2911  switch (Ty->getTypeClass()) {
2912 #define TYPE(Class, Base)
2913 #define ABSTRACT_TYPE(Class, Base)
2914 #define NON_CANONICAL_TYPE(Class, Base)
2915 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
2916 #include "clang/AST/TypeNodes.def"
2917  llvm_unreachable("Dependent types cannot show up in debug information");
2918 
2919  case Type::ExtVector:
2920  case Type::Vector:
2921  return CreateType(cast<VectorType>(Ty), Unit);
2922  case Type::ObjCObjectPointer:
2923  return CreateType(cast<ObjCObjectPointerType>(Ty), Unit);
2924  case Type::ObjCObject:
2925  return CreateType(cast<ObjCObjectType>(Ty), Unit);
2926  case Type::ObjCTypeParam:
2927  return CreateType(cast<ObjCTypeParamType>(Ty), Unit);
2928  case Type::ObjCInterface:
2929  return CreateType(cast<ObjCInterfaceType>(Ty), Unit);
2930  case Type::Builtin:
2931  return CreateType(cast<BuiltinType>(Ty));
2932  case Type::Complex:
2933  return CreateType(cast<ComplexType>(Ty));
2934  case Type::Pointer:
2935  return CreateType(cast<PointerType>(Ty), Unit);
2936  case Type::BlockPointer:
2937  return CreateType(cast<BlockPointerType>(Ty), Unit);
2938  case Type::Typedef:
2939  return CreateType(cast<TypedefType>(Ty), Unit);
2940  case Type::Record:
2941  return CreateType(cast<RecordType>(Ty));
2942  case Type::Enum:
2943  return CreateEnumType(cast<EnumType>(Ty));
2944  case Type::FunctionProto:
2945  case Type::FunctionNoProto:
2946  return CreateType(cast<FunctionType>(Ty), Unit);
2947  case Type::ConstantArray:
2948  case Type::VariableArray:
2949  case Type::IncompleteArray:
2950  return CreateType(cast<ArrayType>(Ty), Unit);
2951 
2952  case Type::LValueReference:
2953  return CreateType(cast<LValueReferenceType>(Ty), Unit);
2954  case Type::RValueReference:
2955  return CreateType(cast<RValueReferenceType>(Ty), Unit);
2956 
2957  case Type::MemberPointer:
2958  return CreateType(cast<MemberPointerType>(Ty), Unit);
2959 
2960  case Type::Atomic:
2961  return CreateType(cast<AtomicType>(Ty), Unit);
2962 
2963  case Type::Pipe:
2964  return CreateType(cast<PipeType>(Ty), Unit);
2965 
2966  case Type::TemplateSpecialization:
2967  return CreateType(cast<TemplateSpecializationType>(Ty), Unit);
2968 
2969  case Type::Auto:
2970  case Type::Attributed:
2971  case Type::Adjusted:
2972  case Type::Decayed:
2973  case Type::DeducedTemplateSpecialization:
2974  case Type::Elaborated:
2975  case Type::Paren:
2976  case Type::SubstTemplateTypeParm:
2977  case Type::TypeOfExpr:
2978  case Type::TypeOf:
2979  case Type::Decltype:
2980  case Type::UnaryTransform:
2981  case Type::PackExpansion:
2982  break;
2983  }
2984 
2985  llvm_unreachable("type should have been unwrapped!");
2986 }
2987 
2988 llvm::DICompositeType *CGDebugInfo::getOrCreateLimitedType(const RecordType *Ty,
2989  llvm::DIFile *Unit) {
2990  QualType QTy(Ty, 0);
2991 
2992  auto *T = cast_or_null<llvm::DICompositeType>(getTypeOrNull(QTy));
2993 
2994  // We may have cached a forward decl when we could have created
2995  // a non-forward decl. Go ahead and create a non-forward decl
2996  // now.
2997  if (T && !T->isForwardDecl())
2998  return T;
2999 
3000  // Otherwise create the type.
3001  llvm::DICompositeType *Res = CreateLimitedType(Ty);
3002 
3003  // Propagate members from the declaration to the definition
3004  // CreateType(const RecordType*) will overwrite this with the members in the
3005  // correct order if the full type is needed.
3006  DBuilder.replaceArrays(Res, T ? T->getElements() : llvm::DINodeArray());
3007 
3008  // And update the type cache.
3009  TypeCache[QTy.getAsOpaquePtr()].reset(Res);
3010  return Res;
3011 }
3012 
3013 // TODO: Currently used for context chains when limiting debug info.
3014 llvm::DICompositeType *CGDebugInfo::CreateLimitedType(const RecordType *Ty) {
3015  RecordDecl *RD = Ty->getDecl();
3016 
3017  // Get overall information about the record type for the debug info.
3018  llvm::DIFile *DefUnit = getOrCreateFile(RD->getLocation());
3019  unsigned Line = getLineNumber(RD->getLocation());
3020  StringRef RDName = getClassName(RD);
3021 
3022  llvm::DIScope *RDContext = getDeclContextDescriptor(RD);
3023 
3024  // If we ended up creating the type during the context chain construction,
3025  // just return that.
3026  auto *T = cast_or_null<llvm::DICompositeType>(
3027  getTypeOrNull(CGM.getContext().getRecordType(RD)));
3028  if (T && (!T->isForwardDecl() || !RD->getDefinition()))
3029  return T;
3030 
3031  // If this is just a forward or incomplete declaration, construct an
3032  // appropriately marked node and just return it.
3033  const RecordDecl *D = RD->getDefinition();
3034  if (!D || !D->isCompleteDefinition())
3035  return getOrCreateRecordFwdDecl(Ty, RDContext);
3036 
3037  uint64_t Size = CGM.getContext().getTypeSize(Ty);
3038  auto Align = getDeclAlignIfRequired(D, CGM.getContext());
3039 
3040  SmallString<256> Identifier = getTypeIdentifier(Ty, CGM, TheCU);
3041 
3042  // Explicitly record the calling convention for C++ records.
3043  auto Flags = llvm::DINode::FlagZero;
3044  if (auto CXXRD = dyn_cast<CXXRecordDecl>(RD)) {
3045  if (CGM.getCXXABI().getRecordArgABI(CXXRD) == CGCXXABI::RAA_Indirect)
3046  Flags |= llvm::DINode::FlagTypePassByReference;
3047  else
3048  Flags |= llvm::DINode::FlagTypePassByValue;
3049 
3050  // Record if a C++ record is non-trivial type.
3051  if (!CXXRD->isTrivial())
3052  Flags |= llvm::DINode::FlagNonTrivial;
3053  }
3054 
3055  llvm::DICompositeType *RealDecl = DBuilder.createReplaceableCompositeType(
3056  getTagForRecord(RD), RDName, RDContext, DefUnit, Line, 0, Size, Align,
3057  Flags, Identifier);
3058 
3059  // Elements of composite types usually have back to the type, creating
3060  // uniquing cycles. Distinct nodes are more efficient.
3061  switch (RealDecl->getTag()) {
3062  default:
3063  llvm_unreachable("invalid composite type tag");
3064 
3065  case llvm::dwarf::DW_TAG_array_type:
3066  case llvm::dwarf::DW_TAG_enumeration_type:
3067  // Array elements and most enumeration elements don't have back references,
3068  // so they don't tend to be involved in uniquing cycles and there is some
3069  // chance of merging them when linking together two modules. Only make
3070  // them distinct if they are ODR-uniqued.
3071  if (Identifier.empty())
3072  break;
3073  LLVM_FALLTHROUGH;
3074 
3075  case llvm::dwarf::DW_TAG_structure_type:
3076  case llvm::dwarf::DW_TAG_union_type:
3077  case llvm::dwarf::DW_TAG_class_type:
3078  // Immediately resolve to a distinct node.
3079  RealDecl =
3080  llvm::MDNode::replaceWithDistinct(llvm::TempDICompositeType(RealDecl));
3081  break;
3082  }
3083 
3084  RegionMap[Ty->getDecl()].reset(RealDecl);
3085  TypeCache[QualType(Ty, 0).getAsOpaquePtr()].reset(RealDecl);
3086 
3087  if (const auto *TSpecial = dyn_cast<ClassTemplateSpecializationDecl>(RD))
3088  DBuilder.replaceArrays(RealDecl, llvm::DINodeArray(),
3089  CollectCXXTemplateParams(TSpecial, DefUnit));
3090  return RealDecl;
3091 }
3092 
3093 void CGDebugInfo::CollectContainingType(const CXXRecordDecl *RD,
3094  llvm::DICompositeType *RealDecl) {
3095  // A class's primary base or the class itself contains the vtable.
3096  llvm::DICompositeType *ContainingType = nullptr;
3097  const ASTRecordLayout &RL = CGM.getContext().getASTRecordLayout(RD);
3098  if (const CXXRecordDecl *PBase = RL.getPrimaryBase()) {
3099  // Seek non-virtual primary base root.
3100  while (1) {
3101  const ASTRecordLayout &BRL = CGM.getContext().getASTRecordLayout(PBase);
3102  const CXXRecordDecl *PBT = BRL.getPrimaryBase();
3103  if (PBT && !BRL.isPrimaryBaseVirtual())
3104  PBase = PBT;
3105  else
3106  break;
3107  }
3108  ContainingType = cast<llvm::DICompositeType>(
3109  getOrCreateType(QualType(PBase->getTypeForDecl(), 0),
3110  getOrCreateFile(RD->getLocation())));
3111  } else if (RD->isDynamicClass())
3112  ContainingType = RealDecl;
3113 
3114  DBuilder.replaceVTableHolder(RealDecl, ContainingType);
3115 }
3116 
3117 llvm::DIType *CGDebugInfo::CreateMemberType(llvm::DIFile *Unit, QualType FType,
3118  StringRef Name, uint64_t *Offset) {
3119  llvm::DIType *FieldTy = CGDebugInfo::getOrCreateType(FType, Unit);
3120  uint64_t FieldSize = CGM.getContext().getTypeSize(FType);
3121  auto FieldAlign = getTypeAlignIfRequired(FType, CGM.getContext());
3122  llvm::DIType *Ty =
3123  DBuilder.createMemberType(Unit, Name, Unit, 0, FieldSize, FieldAlign,
3124  *Offset, llvm::DINode::FlagZero, FieldTy);
3125  *Offset += FieldSize;
3126  return Ty;
3127 }
3128 
3129 void CGDebugInfo::collectFunctionDeclProps(GlobalDecl GD, llvm::DIFile *Unit,
3130  StringRef &Name,
3131  StringRef &LinkageName,
3132  llvm::DIScope *&FDContext,
3133  llvm::DINodeArray &TParamsArray,
3134  llvm::DINode::DIFlags &Flags) {
3135  const auto *FD = cast<FunctionDecl>(GD.getDecl());
3136  Name = getFunctionName(FD);
3137  // Use mangled name as linkage name for C/C++ functions.
3138  if (FD->hasPrototype()) {
3139  LinkageName = CGM.getMangledName(GD);
3140  Flags |= llvm::DINode::FlagPrototyped;
3141  }
3142  // No need to replicate the linkage name if it isn't different from the
3143  // subprogram name, no need to have it at all unless coverage is enabled or
3144  // debug is set to more than just line tables or extra debug info is needed.
3145  if (LinkageName == Name || (!CGM.getCodeGenOpts().EmitGcovArcs &&
3146  !CGM.getCodeGenOpts().EmitGcovNotes &&
3147  !CGM.getCodeGenOpts().DebugInfoForProfiling &&
3149  LinkageName = StringRef();
3150 
3151  if (DebugKind >= codegenoptions::LimitedDebugInfo) {
3152  if (const NamespaceDecl *NSDecl =
3153  dyn_cast_or_null<NamespaceDecl>(FD->getDeclContext()))
3154  FDContext = getOrCreateNamespace(NSDecl);
3155  else if (const RecordDecl *RDecl =
3156  dyn_cast_or_null<RecordDecl>(FD->getDeclContext())) {
3157  llvm::DIScope *Mod = getParentModuleOrNull(RDecl);
3158  FDContext = getContextDescriptor(RDecl, Mod ? Mod : TheCU);
3159  }
3160  // Check if it is a noreturn-marked function
3161  if (FD->isNoReturn())
3162  Flags |= llvm::DINode::FlagNoReturn;
3163  // Collect template parameters.
3164  TParamsArray = CollectFunctionTemplateParams(FD, Unit);
3165  }
3166 }
3167 
3168 void CGDebugInfo::collectVarDeclProps(const VarDecl *VD, llvm::DIFile *&Unit,
3169  unsigned &LineNo, QualType &T,
3170  StringRef &Name, StringRef &LinkageName,
3171  llvm::MDTuple *&TemplateParameters,
3172  llvm::DIScope *&VDContext) {
3173  Unit = getOrCreateFile(VD->getLocation());
3174  LineNo = getLineNumber(VD->getLocation());
3175 
3176  setLocation(VD->getLocation());
3177 
3178  T = VD->getType();
3179  if (T->isIncompleteArrayType()) {
3180  // CodeGen turns int[] into int[1] so we'll do the same here.
3181  llvm::APInt ConstVal(32, 1);
3182  QualType ET = CGM.getContext().getAsArrayType(T)->getElementType();
3183 
3184  T = CGM.getContext().getConstantArrayType(ET, ConstVal, ArrayType::Normal,
3185  0);
3186  }
3187 
3188  Name = VD->getName();
3189  if (VD->getDeclContext() && !isa<FunctionDecl>(VD->getDeclContext()) &&
3190  !isa<ObjCMethodDecl>(VD->getDeclContext()))
3191  LinkageName = CGM.getMangledName(VD);
3192  if (LinkageName == Name)
3193  LinkageName = StringRef();
3194 
3195  if (isa<VarTemplateSpecializationDecl>(VD)) {
3196  llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VD, &*Unit);
3197  TemplateParameters = parameterNodes.get();
3198  } else {
3199  TemplateParameters = nullptr;
3200  }
3201 
3202  // Since we emit declarations (DW_AT_members) for static members, place the
3203  // definition of those static members in the namespace they were declared in
3204  // in the source code (the lexical decl context).
3205  // FIXME: Generalize this for even non-member global variables where the
3206  // declaration and definition may have different lexical decl contexts, once
3207  // we have support for emitting declarations of (non-member) global variables.
3208  const DeclContext *DC = VD->isStaticDataMember() ? VD->getLexicalDeclContext()
3209  : VD->getDeclContext();
3210  // When a record type contains an in-line initialization of a static data
3211  // member, and the record type is marked as __declspec(dllexport), an implicit
3212  // definition of the member will be created in the record context. DWARF
3213  // doesn't seem to have a nice way to describe this in a form that consumers
3214  // are likely to understand, so fake the "normal" situation of a definition
3215  // outside the class by putting it in the global scope.
3216  if (DC->isRecord())
3217  DC = CGM.getContext().getTranslationUnitDecl();
3218 
3219  llvm::DIScope *Mod = getParentModuleOrNull(VD);
3220  VDContext = getContextDescriptor(cast<Decl>(DC), Mod ? Mod : TheCU);
3221 }
3222 
3223 llvm::DISubprogram *CGDebugInfo::getFunctionFwdDeclOrStub(GlobalDecl GD,
3224  bool Stub) {
3225  llvm::DINodeArray TParamsArray;
3226  StringRef Name, LinkageName;
3227  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3228  llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3229  SourceLocation Loc = GD.getDecl()->getLocation();
3230  llvm::DIFile *Unit = getOrCreateFile(Loc);
3231  llvm::DIScope *DContext = Unit;
3232  unsigned Line = getLineNumber(Loc);
3233  collectFunctionDeclProps(GD, Unit, Name, LinkageName, DContext, TParamsArray,
3234  Flags);
3235  auto *FD = dyn_cast<FunctionDecl>(GD.getDecl());
3236 
3237  // Build function type.
3238  SmallVector<QualType, 16> ArgTypes;
3239  if (FD)
3240  for (const ParmVarDecl *Parm : FD->parameters())
3241  ArgTypes.push_back(Parm->getType());
3242  CallingConv CC = FD->getType()->castAs<FunctionType>()->getCallConv();
3243  QualType FnType = CGM.getContext().getFunctionType(
3244  FD->getReturnType(), ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
3245  if (!FD->isExternallyVisible())
3246  SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3247  if (CGM.getLangOpts().Optimize)
3248  SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3249 
3250  if (Stub) {
3251  Flags |= getCallSiteRelatedAttrs();
3252  SPFlags |= llvm::DISubprogram::SPFlagDefinition;
3253  return DBuilder.createFunction(
3254  DContext, Name, LinkageName, Unit, Line,
3255  getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3256  TParamsArray.get(), getFunctionDeclaration(FD));
3257  }
3258 
3259  llvm::DISubprogram *SP = DBuilder.createTempFunctionFwdDecl(
3260  DContext, Name, LinkageName, Unit, Line,
3261  getOrCreateFunctionType(GD.getDecl(), FnType, Unit), 0, Flags, SPFlags,
3262  TParamsArray.get(), getFunctionDeclaration(FD));
3263  const FunctionDecl *CanonDecl = FD->getCanonicalDecl();
3264  FwdDeclReplaceMap.emplace_back(std::piecewise_construct,
3265  std::make_tuple(CanonDecl),
3266  std::make_tuple(SP));
3267  return SP;
3268 }
3269 
3270 llvm::DISubprogram *CGDebugInfo::getFunctionForwardDeclaration(GlobalDecl GD) {
3271  return getFunctionFwdDeclOrStub(GD, /* Stub = */ false);
3272 }
3273 
3274 llvm::DISubprogram *CGDebugInfo::getFunctionStub(GlobalDecl GD) {
3275  return getFunctionFwdDeclOrStub(GD, /* Stub = */ true);
3276 }
3277 
3278 llvm::DIGlobalVariable *
3279 CGDebugInfo::getGlobalVariableForwardDeclaration(const VarDecl *VD) {
3280  QualType T;
3281  StringRef Name, LinkageName;
3282  SourceLocation Loc = VD->getLocation();
3283  llvm::DIFile *Unit = getOrCreateFile(Loc);
3284  llvm::DIScope *DContext = Unit;
3285  unsigned Line = getLineNumber(Loc);
3286  llvm::MDTuple *TemplateParameters = nullptr;
3287 
3288  collectVarDeclProps(VD, Unit, Line, T, Name, LinkageName, TemplateParameters,
3289  DContext);
3290  auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3291  auto *GV = DBuilder.createTempGlobalVariableFwdDecl(
3292  DContext, Name, LinkageName, Unit, Line, getOrCreateType(T, Unit),
3293  !VD->isExternallyVisible(), nullptr, TemplateParameters, Align);
3294  FwdDeclReplaceMap.emplace_back(
3295  std::piecewise_construct,
3296  std::make_tuple(cast<VarDecl>(VD->getCanonicalDecl())),
3297  std::make_tuple(static_cast<llvm::Metadata *>(GV)));
3298  return GV;
3299 }
3300 
3301 llvm::DINode *CGDebugInfo::getDeclarationOrDefinition(const Decl *D) {
3302  // We only need a declaration (not a definition) of the type - so use whatever
3303  // we would otherwise do to get a type for a pointee. (forward declarations in
3304  // limited debug info, full definitions (if the type definition is available)
3305  // in unlimited debug info)
3306  if (const auto *TD = dyn_cast<TypeDecl>(D))
3307  return getOrCreateType(CGM.getContext().getTypeDeclType(TD),
3308  getOrCreateFile(TD->getLocation()));
3309  auto I = DeclCache.find(D->getCanonicalDecl());
3310 
3311  if (I != DeclCache.end()) {
3312  auto N = I->second;
3313  if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(N))
3314  return GVE->getVariable();
3315  return dyn_cast_or_null<llvm::DINode>(N);
3316  }
3317 
3318  // No definition for now. Emit a forward definition that might be
3319  // merged with a potential upcoming definition.
3320  if (const auto *FD = dyn_cast<FunctionDecl>(D))
3321  return getFunctionForwardDeclaration(FD);
3322  else if (const auto *VD = dyn_cast<VarDecl>(D))
3323  return getGlobalVariableForwardDeclaration(VD);
3324 
3325  return nullptr;
3326 }
3327 
3328 llvm::DISubprogram *CGDebugInfo::getFunctionDeclaration(const Decl *D) {
3329  if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3330  return nullptr;
3331 
3332  const auto *FD = dyn_cast<FunctionDecl>(D);
3333  if (!FD)
3334  return nullptr;
3335 
3336  // Setup context.
3337  auto *S = getDeclContextDescriptor(D);
3338 
3339  auto MI = SPCache.find(FD->getCanonicalDecl());
3340  if (MI == SPCache.end()) {
3341  if (const auto *MD = dyn_cast<CXXMethodDecl>(FD->getCanonicalDecl())) {
3342  return CreateCXXMemberFunction(MD, getOrCreateFile(MD->getLocation()),
3343  cast<llvm::DICompositeType>(S));
3344  }
3345  }
3346  if (MI != SPCache.end()) {
3347  auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3348  if (SP && !SP->isDefinition())
3349  return SP;
3350  }
3351 
3352  for (auto NextFD : FD->redecls()) {
3353  auto MI = SPCache.find(NextFD->getCanonicalDecl());
3354  if (MI != SPCache.end()) {
3355  auto *SP = dyn_cast_or_null<llvm::DISubprogram>(MI->second);
3356  if (SP && !SP->isDefinition())
3357  return SP;
3358  }
3359  }
3360  return nullptr;
3361 }
3362 
3363 // getOrCreateFunctionType - Construct type. If it is a c++ method, include
3364 // implicit parameter "this".
3365 llvm::DISubroutineType *CGDebugInfo::getOrCreateFunctionType(const Decl *D,
3366  QualType FnType,
3367  llvm::DIFile *F) {
3368  if (!D || DebugKind <= codegenoptions::DebugLineTablesOnly)
3369  // Create fake but valid subroutine type. Otherwise -verify would fail, and
3370  // subprogram DIE will miss DW_AT_decl_file and DW_AT_decl_line fields.
3371  return DBuilder.createSubroutineType(DBuilder.getOrCreateTypeArray(None));
3372 
3373  if (const auto *Method = dyn_cast<CXXMethodDecl>(D))
3374  return getOrCreateMethodType(Method, F);
3375 
3376  const auto *FTy = FnType->getAs<FunctionType>();
3377  CallingConv CC = FTy ? FTy->getCallConv() : CallingConv::CC_C;
3378 
3379  if (const auto *OMethod = dyn_cast<ObjCMethodDecl>(D)) {
3380  // Add "self" and "_cmd"
3382 
3383  // First element is always return type. For 'void' functions it is NULL.
3384  QualType ResultTy = OMethod->getReturnType();
3385 
3386  // Replace the instancetype keyword with the actual type.
3387  if (ResultTy == CGM.getContext().getObjCInstanceType())
3388  ResultTy = CGM.getContext().getPointerType(
3389  QualType(OMethod->getClassInterface()->getTypeForDecl(), 0));
3390 
3391  Elts.push_back(getOrCreateType(ResultTy, F));
3392  // "self" pointer is always first argument.
3393  QualType SelfDeclTy;
3394  if (auto *SelfDecl = OMethod->getSelfDecl())
3395  SelfDeclTy = SelfDecl->getType();
3396  else if (auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3397  if (FPT->getNumParams() > 1)
3398  SelfDeclTy = FPT->getParamType(0);
3399  if (!SelfDeclTy.isNull())
3400  Elts.push_back(
3401  CreateSelfType(SelfDeclTy, getOrCreateType(SelfDeclTy, F)));
3402  // "_cmd" pointer is always second argument.
3403  Elts.push_back(DBuilder.createArtificialType(
3404  getOrCreateType(CGM.getContext().getObjCSelType(), F)));
3405  // Get rest of the arguments.
3406  for (const auto *PI : OMethod->parameters())
3407  Elts.push_back(getOrCreateType(PI->getType(), F));
3408  // Variadic methods need a special marker at the end of the type list.
3409  if (OMethod->isVariadic())
3410  Elts.push_back(DBuilder.createUnspecifiedParameter());
3411 
3412  llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(Elts);
3413  return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3414  getDwarfCC(CC));
3415  }
3416 
3417  // Handle variadic function types; they need an additional
3418  // unspecified parameter.
3419  if (const auto *FD = dyn_cast<FunctionDecl>(D))
3420  if (FD->isVariadic()) {
3422  EltTys.push_back(getOrCreateType(FD->getReturnType(), F));
3423  if (const auto *FPT = dyn_cast<FunctionProtoType>(FnType))
3424  for (QualType ParamType : FPT->param_types())
3425  EltTys.push_back(getOrCreateType(ParamType, F));
3426  EltTys.push_back(DBuilder.createUnspecifiedParameter());
3427  llvm::DITypeRefArray EltTypeArray = DBuilder.getOrCreateTypeArray(EltTys);
3428  return DBuilder.createSubroutineType(EltTypeArray, llvm::DINode::FlagZero,
3429  getDwarfCC(CC));
3430  }
3431 
3432  return cast<llvm::DISubroutineType>(getOrCreateType(FnType, F));
3433 }
3434 
3436  SourceLocation ScopeLoc, QualType FnType,
3437  llvm::Function *Fn, bool CurFuncIsThunk,
3438  CGBuilderTy &Builder) {
3439 
3440  StringRef Name;
3441  StringRef LinkageName;
3442 
3443  FnBeginRegionCount.push_back(LexicalBlockStack.size());
3444 
3445  const Decl *D = GD.getDecl();
3446  bool HasDecl = (D != nullptr);
3447 
3448  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3449  llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3450  llvm::DIFile *Unit = getOrCreateFile(Loc);
3451  llvm::DIScope *FDContext = Unit;
3452  llvm::DINodeArray TParamsArray;
3453  if (!HasDecl) {
3454  // Use llvm function name.
3455  LinkageName = Fn->getName();
3456  } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
3457  // If there is a subprogram for this function available then use it.
3458  auto FI = SPCache.find(FD->getCanonicalDecl());
3459  if (FI != SPCache.end()) {
3460  auto *SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3461  if (SP && SP->isDefinition()) {
3462  LexicalBlockStack.emplace_back(SP);
3463  RegionMap[D].reset(SP);
3464  return;
3465  }
3466  }
3467  collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3468  TParamsArray, Flags);
3469  } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3470  Name = getObjCMethodName(OMD);
3471  Flags |= llvm::DINode::FlagPrototyped;
3472  } else {
3473  // Use llvm function name.
3474  Name = Fn->getName();
3475  Flags |= llvm::DINode::FlagPrototyped;
3476  }
3477  if (Name.startswith("\01"))
3478  Name = Name.substr(1);
3479 
3480  if (!HasDecl || D->isImplicit() || D->hasAttr<ArtificialAttr>()) {
3481  Flags |= llvm::DINode::FlagArtificial;
3482  // Artificial functions should not silently reuse CurLoc.
3483  CurLoc = SourceLocation();
3484  }
3485 
3486  if (CurFuncIsThunk)
3487  Flags |= llvm::DINode::FlagThunk;
3488 
3489  if (Fn->hasLocalLinkage())
3490  SPFlags |= llvm::DISubprogram::SPFlagLocalToUnit;
3491  if (CGM.getLangOpts().Optimize)
3492  SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3493 
3494  llvm::DINode::DIFlags FlagsForDef = Flags | getCallSiteRelatedAttrs();
3495  llvm::DISubprogram::DISPFlags SPFlagsForDef =
3496  SPFlags | llvm::DISubprogram::SPFlagDefinition;
3497 
3498  unsigned LineNo = getLineNumber(Loc);
3499  unsigned ScopeLine = getLineNumber(ScopeLoc);
3500 
3501  // FIXME: The function declaration we're constructing here is mostly reusing
3502  // declarations from CXXMethodDecl and not constructing new ones for arbitrary
3503  // FunctionDecls. When/if we fix this we can have FDContext be TheCU/null for
3504  // all subprograms instead of the actual context since subprogram definitions
3505  // are emitted as CU level entities by the backend.
3506  llvm::DISubprogram *SP = DBuilder.createFunction(
3507  FDContext, Name, LinkageName, Unit, LineNo,
3508  getOrCreateFunctionType(D, FnType, Unit), ScopeLine, FlagsForDef,
3509  SPFlagsForDef, TParamsArray.get(), getFunctionDeclaration(D));
3510  Fn->setSubprogram(SP);
3511  // We might get here with a VarDecl in the case we're generating
3512  // code for the initialization of globals. Do not record these decls
3513  // as they will overwrite the actual VarDecl Decl in the cache.
3514  if (HasDecl && isa<FunctionDecl>(D))
3515  DeclCache[D->getCanonicalDecl()].reset(SP);
3516 
3517  if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
3518  // Starting with DWARF V5 method declarations are emitted as children of
3519  // the interface type.
3520  if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
3521  const ObjCInterfaceDecl *ID = OMD->getClassInterface();
3522  QualType QTy(ID->getTypeForDecl(), 0);
3523  auto It = TypeCache.find(QTy.getAsOpaquePtr());
3524  if (It != TypeCache.end()) {
3525  llvm::DICompositeType *InterfaceDecl =
3526  cast<llvm::DICompositeType>(It->second);
3527  llvm::DISubprogram *FD = DBuilder.createFunction(
3528  InterfaceDecl, Name, LinkageName, Unit, LineNo,
3529  getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
3530  TParamsArray.get());
3531  DBuilder.finalizeSubprogram(FD);
3532  ObjCMethodCache[ID].push_back(FD);
3533  }
3534  }
3535  }
3536 
3537  // Push the function onto the lexical block stack.
3538  LexicalBlockStack.emplace_back(SP);
3539 
3540  if (HasDecl)
3541  RegionMap[D].reset(SP);
3542 }
3543 
3545  QualType FnType) {
3546  StringRef Name;
3547  StringRef LinkageName;
3548 
3549  const Decl *D = GD.getDecl();
3550  if (!D)
3551  return;
3552 
3553  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3554  llvm::DIFile *Unit = getOrCreateFile(Loc);
3555  llvm::DIScope *FDContext = getDeclContextDescriptor(D);
3556  llvm::DINodeArray TParamsArray;
3557  if (isa<FunctionDecl>(D)) {
3558  // If there is a DISubprogram for this function available then use it.
3559  collectFunctionDeclProps(GD, Unit, Name, LinkageName, FDContext,
3560  TParamsArray, Flags);
3561  } else if (const auto *OMD = dyn_cast<ObjCMethodDecl>(D)) {
3562  Name = getObjCMethodName(OMD);
3563  Flags |= llvm::DINode::FlagPrototyped;
3564  } else {
3565  llvm_unreachable("not a function or ObjC method");
3566  }
3567  if (!Name.empty() && Name[0] == '\01')
3568  Name = Name.substr(1);
3569 
3570  if (D->isImplicit()) {
3571  Flags |= llvm::DINode::FlagArtificial;
3572  // Artificial functions without a location should not silently reuse CurLoc.
3573  if (Loc.isInvalid())
3574  CurLoc = SourceLocation();
3575  }
3576  unsigned LineNo = getLineNumber(Loc);
3577  unsigned ScopeLine = 0;
3578  llvm::DISubprogram::DISPFlags SPFlags = llvm::DISubprogram::SPFlagZero;
3579  if (CGM.getLangOpts().Optimize)
3580  SPFlags |= llvm::DISubprogram::SPFlagOptimized;
3581 
3582  DBuilder.retainType(DBuilder.createFunction(
3583  FDContext, Name, LinkageName, Unit, LineNo,
3584  getOrCreateFunctionType(D, FnType, Unit), ScopeLine, Flags, SPFlags,
3585  TParamsArray.get(), getFunctionDeclaration(D)));
3586 }
3587 
3589  const auto *FD = cast<FunctionDecl>(GD.getDecl());
3590  // If there is a subprogram for this function available then use it.
3591  auto FI = SPCache.find(FD->getCanonicalDecl());
3592  llvm::DISubprogram *SP = nullptr;
3593  if (FI != SPCache.end())
3594  SP = dyn_cast_or_null<llvm::DISubprogram>(FI->second);
3595  if (!SP || !SP->isDefinition())
3596  SP = getFunctionStub(GD);
3597  FnBeginRegionCount.push_back(LexicalBlockStack.size());
3598  LexicalBlockStack.emplace_back(SP);
3599  setInlinedAt(Builder.getCurrentDebugLocation());
3600  EmitLocation(Builder, FD->getLocation());
3601 }
3602 
3604  assert(CurInlinedAt && "unbalanced inline scope stack");
3605  EmitFunctionEnd(Builder, nullptr);
3606  setInlinedAt(llvm::DebugLoc(CurInlinedAt).getInlinedAt());
3607 }
3608 
3610  // Update our current location
3611  setLocation(Loc);
3612 
3613  if (CurLoc.isInvalid() || CurLoc.isMacroID() || LexicalBlockStack.empty())
3614  return;
3615 
3616  llvm::MDNode *Scope = LexicalBlockStack.back();
3617  Builder.SetCurrentDebugLocation(llvm::DebugLoc::get(
3618  getLineNumber(CurLoc), getColumnNumber(CurLoc), Scope, CurInlinedAt));
3619 }
3620 
3621 void CGDebugInfo::CreateLexicalBlock(SourceLocation Loc) {
3622  llvm::MDNode *Back = nullptr;
3623  if (!LexicalBlockStack.empty())
3624  Back = LexicalBlockStack.back().get();
3625  LexicalBlockStack.emplace_back(DBuilder.createLexicalBlock(
3626  cast<llvm::DIScope>(Back), getOrCreateFile(CurLoc), getLineNumber(CurLoc),
3627  getColumnNumber(CurLoc)));
3628 }
3629 
3630 void CGDebugInfo::AppendAddressSpaceXDeref(
3631  unsigned AddressSpace, SmallVectorImpl<int64_t> &Expr) const {
3632  Optional<unsigned> DWARFAddressSpace =
3633  CGM.getTarget().getDWARFAddressSpace(AddressSpace);
3634  if (!DWARFAddressSpace)
3635  return;
3636 
3637  Expr.push_back(llvm::dwarf::DW_OP_constu);
3638  Expr.push_back(DWARFAddressSpace.getValue());
3639  Expr.push_back(llvm::dwarf::DW_OP_swap);
3640  Expr.push_back(llvm::dwarf::DW_OP_xderef);
3641 }
3642 
3644  SourceLocation Loc) {
3645  // Set our current location.
3646  setLocation(Loc);
3647 
3648  // Emit a line table change for the current location inside the new scope.
3649  Builder.SetCurrentDebugLocation(
3650  llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc),
3651  LexicalBlockStack.back(), CurInlinedAt));
3652 
3653  if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3654  return;
3655 
3656  // Create a new lexical block and push it on the stack.
3657  CreateLexicalBlock(Loc);
3658 }
3659 
3661  SourceLocation Loc) {
3662  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3663 
3664  // Provide an entry in the line table for the end of the block.
3665  EmitLocation(Builder, Loc);
3666 
3667  if (DebugKind <= codegenoptions::DebugLineTablesOnly)
3668  return;
3669 
3670  LexicalBlockStack.pop_back();
3671 }
3672 
3673 void CGDebugInfo::EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn) {
3674  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3675  unsigned RCount = FnBeginRegionCount.back();
3676  assert(RCount <= LexicalBlockStack.size() && "Region stack mismatch");
3677 
3678  // Pop all regions for this function.
3679  while (LexicalBlockStack.size() != RCount) {
3680  // Provide an entry in the line table for the end of the block.
3681  EmitLocation(Builder, CurLoc);
3682  LexicalBlockStack.pop_back();
3683  }
3684  FnBeginRegionCount.pop_back();
3685 
3686  if (Fn && Fn->getSubprogram())
3687  DBuilder.finalizeSubprogram(Fn->getSubprogram());
3688 }
3689 
3690 CGDebugInfo::BlockByRefType
3691 CGDebugInfo::EmitTypeForVarWithBlocksAttr(const VarDecl *VD,
3692  uint64_t *XOffset) {
3694  QualType FType;
3695  uint64_t FieldSize, FieldOffset;
3696  uint32_t FieldAlign;
3697 
3698  llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3699  QualType Type = VD->getType();
3700 
3701  FieldOffset = 0;
3702  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3703  EltTys.push_back(CreateMemberType(Unit, FType, "__isa", &FieldOffset));
3704  EltTys.push_back(CreateMemberType(Unit, FType, "__forwarding", &FieldOffset));
3705  FType = CGM.getContext().IntTy;
3706  EltTys.push_back(CreateMemberType(Unit, FType, "__flags", &FieldOffset));
3707  EltTys.push_back(CreateMemberType(Unit, FType, "__size", &FieldOffset));
3708 
3709  bool HasCopyAndDispose = CGM.getContext().BlockRequiresCopying(Type, VD);
3710  if (HasCopyAndDispose) {
3711  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3712  EltTys.push_back(
3713  CreateMemberType(Unit, FType, "__copy_helper", &FieldOffset));
3714  EltTys.push_back(
3715  CreateMemberType(Unit, FType, "__destroy_helper", &FieldOffset));
3716  }
3717  bool HasByrefExtendedLayout;
3718  Qualifiers::ObjCLifetime Lifetime;
3719  if (CGM.getContext().getByrefLifetime(Type, Lifetime,
3720  HasByrefExtendedLayout) &&
3721  HasByrefExtendedLayout) {
3722  FType = CGM.getContext().getPointerType(CGM.getContext().VoidTy);
3723  EltTys.push_back(
3724  CreateMemberType(Unit, FType, "__byref_variable_layout", &FieldOffset));
3725  }
3726 
3727  CharUnits Align = CGM.getContext().getDeclAlign(VD);
3728  if (Align > CGM.getContext().toCharUnitsFromBits(
3729  CGM.getTarget().getPointerAlign(0))) {
3730  CharUnits FieldOffsetInBytes =
3731  CGM.getContext().toCharUnitsFromBits(FieldOffset);
3732  CharUnits AlignedOffsetInBytes = FieldOffsetInBytes.alignTo(Align);
3733  CharUnits NumPaddingBytes = AlignedOffsetInBytes - FieldOffsetInBytes;
3734 
3735  if (NumPaddingBytes.isPositive()) {
3736  llvm::APInt pad(32, NumPaddingBytes.getQuantity());
3737  FType = CGM.getContext().getConstantArrayType(CGM.getContext().CharTy,
3738  pad, ArrayType::Normal, 0);
3739  EltTys.push_back(CreateMemberType(Unit, FType, "", &FieldOffset));
3740  }
3741  }
3742 
3743  FType = Type;
3744  llvm::DIType *WrappedTy = getOrCreateType(FType, Unit);
3745  FieldSize = CGM.getContext().getTypeSize(FType);
3746  FieldAlign = CGM.getContext().toBits(Align);
3747 
3748  *XOffset = FieldOffset;
3749  llvm::DIType *FieldTy = DBuilder.createMemberType(
3750  Unit, VD->getName(), Unit, 0, FieldSize, FieldAlign, FieldOffset,
3751  llvm::DINode::FlagZero, WrappedTy);
3752  EltTys.push_back(FieldTy);
3753  FieldOffset += FieldSize;
3754 
3755  llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
3756  return {DBuilder.createStructType(Unit, "", Unit, 0, FieldOffset, 0,
3757  llvm::DINode::FlagZero, nullptr, Elements),
3758  WrappedTy};
3759 }
3760 
3761 llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const VarDecl *VD,
3762  llvm::Value *Storage,
3764  CGBuilderTy &Builder) {
3765  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3766  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3767  if (VD->hasAttr<NoDebugAttr>())
3768  return nullptr;
3769 
3770  bool Unwritten =
3771  VD->isImplicit() || (isa<Decl>(VD->getDeclContext()) &&
3772  cast<Decl>(VD->getDeclContext())->isImplicit());
3773  llvm::DIFile *Unit = nullptr;
3774  if (!Unwritten)
3775  Unit = getOrCreateFile(VD->getLocation());
3776  llvm::DIType *Ty;
3777  uint64_t XOffset = 0;
3778  if (VD->hasAttr<BlocksAttr>())
3779  Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
3780  else
3781  Ty = getOrCreateType(VD->getType(), Unit);
3782 
3783  // If there is no debug info for this type then do not emit debug info
3784  // for this variable.
3785  if (!Ty)
3786  return nullptr;
3787 
3788  // Get location information.
3789  unsigned Line = 0;
3790  unsigned Column = 0;
3791  if (!Unwritten) {
3792  Line = getLineNumber(VD->getLocation());
3793  Column = getColumnNumber(VD->getLocation());
3794  }
3796  llvm::DINode::DIFlags Flags = llvm::DINode::FlagZero;
3797  if (VD->isImplicit())
3798  Flags |= llvm::DINode::FlagArtificial;
3799 
3800  auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3801 
3802  unsigned AddressSpace = CGM.getContext().getTargetAddressSpace(VD->getType());
3803  AppendAddressSpaceXDeref(AddressSpace, Expr);
3804 
3805  // If this is implicit parameter of CXXThis or ObjCSelf kind, then give it an
3806  // object pointer flag.
3807  if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD)) {
3808  if (IPD->getParameterKind() == ImplicitParamDecl::CXXThis ||
3809  IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3810  Flags |= llvm::DINode::FlagObjectPointer;
3811  }
3812 
3813  // Note: Older versions of clang used to emit byval references with an extra
3814  // DW_OP_deref, because they referenced the IR arg directly instead of
3815  // referencing an alloca. Newer versions of LLVM don't treat allocas
3816  // differently from other function arguments when used in a dbg.declare.
3817  auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3818  StringRef Name = VD->getName();
3819  if (!Name.empty()) {
3820  if (VD->hasAttr<BlocksAttr>()) {
3821  // Here, we need an offset *into* the alloca.
3822  CharUnits offset = CharUnits::fromQuantity(32);
3823  Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3824  // offset of __forwarding field
3825  offset = CGM.getContext().toCharUnitsFromBits(
3826  CGM.getTarget().getPointerWidth(0));
3827  Expr.push_back(offset.getQuantity());
3828  Expr.push_back(llvm::dwarf::DW_OP_deref);
3829  Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3830  // offset of x field
3831  offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3832  Expr.push_back(offset.getQuantity());
3833  }
3834  } else if (const auto *RT = dyn_cast<RecordType>(VD->getType())) {
3835  // If VD is an anonymous union then Storage represents value for
3836  // all union fields.
3837  const RecordDecl *RD = RT->getDecl();
3838  if (RD->isUnion() && RD->isAnonymousStructOrUnion()) {
3839  // GDB has trouble finding local variables in anonymous unions, so we emit
3840  // artificial local variables for each of the members.
3841  //
3842  // FIXME: Remove this code as soon as GDB supports this.
3843  // The debug info verifier in LLVM operates based on the assumption that a
3844  // variable has the same size as its storage and we had to disable the
3845  // check for artificial variables.
3846  for (const auto *Field : RD->fields()) {
3847  llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
3848  StringRef FieldName = Field->getName();
3849 
3850  // Ignore unnamed fields. Do not ignore unnamed records.
3851  if (FieldName.empty() && !isa<RecordType>(Field->getType()))
3852  continue;
3853 
3854  // Use VarDecl's Tag, Scope and Line number.
3855  auto FieldAlign = getDeclAlignIfRequired(Field, CGM.getContext());
3856  auto *D = DBuilder.createAutoVariable(
3857  Scope, FieldName, Unit, Line, FieldTy, CGM.getLangOpts().Optimize,
3858  Flags | llvm::DINode::FlagArtificial, FieldAlign);
3859 
3860  // Insert an llvm.dbg.declare into the current block.
3861  DBuilder.insertDeclare(
3862  Storage, D, DBuilder.createExpression(Expr),
3863  llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3864  Builder.GetInsertBlock());
3865  }
3866  }
3867  }
3868 
3869  // Create the descriptor for the variable.
3870  auto *D = ArgNo ? DBuilder.createParameterVariable(
3871  Scope, Name, *ArgNo, Unit, Line, Ty,
3872  CGM.getLangOpts().Optimize, Flags)
3873  : DBuilder.createAutoVariable(Scope, Name, Unit, Line, Ty,
3874  CGM.getLangOpts().Optimize,
3875  Flags, Align);
3876 
3877  // Insert an llvm.dbg.declare into the current block.
3878  DBuilder.insertDeclare(Storage, D, DBuilder.createExpression(Expr),
3879  llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3880  Builder.GetInsertBlock());
3881 
3882  return D;
3883 }
3884 
3885 llvm::DILocalVariable *
3887  CGBuilderTy &Builder) {
3888  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3889  return EmitDeclare(VD, Storage, llvm::None, Builder);
3890 }
3891 
3893  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3894  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3895 
3896  if (D->hasAttr<NoDebugAttr>())
3897  return;
3898 
3899  auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
3900  llvm::DIFile *Unit = getOrCreateFile(D->getLocation());
3901 
3902  // Get location information.
3903  unsigned Line = getLineNumber(D->getLocation());
3904  unsigned Column = getColumnNumber(D->getLocation());
3905 
3906  StringRef Name = D->getName();
3907 
3908  // Create the descriptor for the label.
3909  auto *L =
3910  DBuilder.createLabel(Scope, Name, Unit, Line, CGM.getLangOpts().Optimize);
3911 
3912  // Insert an llvm.dbg.label into the current block.
3913  DBuilder.insertLabel(L,
3914  llvm::DebugLoc::get(Line, Column, Scope, CurInlinedAt),
3915  Builder.GetInsertBlock());
3916 }
3917 
3918 llvm::DIType *CGDebugInfo::CreateSelfType(const QualType &QualTy,
3919  llvm::DIType *Ty) {
3920  llvm::DIType *CachedTy = getTypeOrNull(QualTy);
3921  if (CachedTy)
3922  Ty = CachedTy;
3923  return DBuilder.createObjectPointerType(Ty);
3924 }
3925 
3927  const VarDecl *VD, llvm::Value *Storage, CGBuilderTy &Builder,
3928  const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint) {
3929  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
3930  assert(!LexicalBlockStack.empty() && "Region stack mismatch, stack empty!");
3931 
3932  if (Builder.GetInsertBlock() == nullptr)
3933  return;
3934  if (VD->hasAttr<NoDebugAttr>())
3935  return;
3936 
3937  bool isByRef = VD->hasAttr<BlocksAttr>();
3938 
3939  uint64_t XOffset = 0;
3940  llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
3941  llvm::DIType *Ty;
3942  if (isByRef)
3943  Ty = EmitTypeForVarWithBlocksAttr(VD, &XOffset).WrappedType;
3944  else
3945  Ty = getOrCreateType(VD->getType(), Unit);
3946 
3947  // Self is passed along as an implicit non-arg variable in a
3948  // block. Mark it as the object pointer.
3949  if (const auto *IPD = dyn_cast<ImplicitParamDecl>(VD))
3950  if (IPD->getParameterKind() == ImplicitParamDecl::ObjCSelf)
3951  Ty = CreateSelfType(VD->getType(), Ty);
3952 
3953  // Get location information.
3954  unsigned Line = getLineNumber(VD->getLocation());
3955  unsigned Column = getColumnNumber(VD->getLocation());
3956 
3957  const llvm::DataLayout &target = CGM.getDataLayout();
3958 
3960  target.getStructLayout(blockInfo.StructureType)
3961  ->getElementOffset(blockInfo.getCapture(VD).getIndex()));
3962 
3964  addr.push_back(llvm::dwarf::DW_OP_deref);
3965  addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3966  addr.push_back(offset.getQuantity());
3967  if (isByRef) {
3968  addr.push_back(llvm::dwarf::DW_OP_deref);
3969  addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3970  // offset of __forwarding field
3971  offset =
3972  CGM.getContext().toCharUnitsFromBits(target.getPointerSizeInBits(0));
3973  addr.push_back(offset.getQuantity());
3974  addr.push_back(llvm::dwarf::DW_OP_deref);
3975  addr.push_back(llvm::dwarf::DW_OP_plus_uconst);
3976  // offset of x field
3977  offset = CGM.getContext().toCharUnitsFromBits(XOffset);
3978  addr.push_back(offset.getQuantity());
3979  }
3980 
3981  // Create the descriptor for the variable.
3982  auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
3983  auto *D = DBuilder.createAutoVariable(
3984  cast<llvm::DILocalScope>(LexicalBlockStack.back()), VD->getName(), Unit,
3985  Line, Ty, false, llvm::DINode::FlagZero, Align);
3986 
3987  // Insert an llvm.dbg.declare into the current block.
3988  auto DL =
3989  llvm::DebugLoc::get(Line, Column, LexicalBlockStack.back(), CurInlinedAt);
3990  auto *Expr = DBuilder.createExpression(addr);
3991  if (InsertPoint)
3992  DBuilder.insertDeclare(Storage, D, Expr, DL, InsertPoint);
3993  else
3994  DBuilder.insertDeclare(Storage, D, Expr, DL, Builder.GetInsertBlock());
3995 }
3996 
3998  unsigned ArgNo,
3999  CGBuilderTy &Builder) {
4000  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4001  EmitDeclare(VD, AI, ArgNo, Builder);
4002 }
4003 
4004 namespace {
4005 struct BlockLayoutChunk {
4006  uint64_t OffsetInBits;
4007  const BlockDecl::Capture *Capture;
4008 };
4009 bool operator<(const BlockLayoutChunk &l, const BlockLayoutChunk &r) {
4010  return l.OffsetInBits < r.OffsetInBits;
4011 }
4012 } // namespace
4013 
4014 void CGDebugInfo::collectDefaultFieldsForBlockLiteralDeclare(
4015  const CGBlockInfo &Block, const ASTContext &Context, SourceLocation Loc,
4016  const llvm::StructLayout &BlockLayout, llvm::DIFile *Unit,
4018  // Blocks in OpenCL have unique constraints which make the standard fields
4019  // redundant while requiring size and align fields for enqueue_kernel. See
4020  // initializeForBlockHeader in CGBlocks.cpp
4021  if (CGM.getLangOpts().OpenCL) {
4022  Fields.push_back(createFieldType("__size", Context.IntTy, Loc, AS_public,
4023  BlockLayout.getElementOffsetInBits(0),
4024  Unit, Unit));
4025  Fields.push_back(createFieldType("__align", Context.IntTy, Loc, AS_public,
4026  BlockLayout.getElementOffsetInBits(1),
4027  Unit, Unit));
4028  } else {
4029  Fields.push_back(createFieldType("__isa", Context.VoidPtrTy, Loc, AS_public,
4030  BlockLayout.getElementOffsetInBits(0),
4031  Unit, Unit));
4032  Fields.push_back(createFieldType("__flags", Context.IntTy, Loc, AS_public,
4033  BlockLayout.getElementOffsetInBits(1),
4034  Unit, Unit));
4035  Fields.push_back(
4036  createFieldType("__reserved", Context.IntTy, Loc, AS_public,
4037  BlockLayout.getElementOffsetInBits(2), Unit, Unit));
4038  auto *FnTy = Block.getBlockExpr()->getFunctionType();
4039  auto FnPtrType = CGM.getContext().getPointerType(FnTy->desugar());
4040  Fields.push_back(createFieldType("__FuncPtr", FnPtrType, Loc, AS_public,
4041  BlockLayout.getElementOffsetInBits(3),
4042  Unit, Unit));
4043  Fields.push_back(createFieldType(
4044  "__descriptor",
4045  Context.getPointerType(Block.NeedsCopyDispose
4046  ? Context.getBlockDescriptorExtendedType()
4047  : Context.getBlockDescriptorType()),
4048  Loc, AS_public, BlockLayout.getElementOffsetInBits(4), Unit, Unit));
4049  }
4050 }
4051 
4053  StringRef Name,
4054  unsigned ArgNo,
4055  llvm::AllocaInst *Alloca,
4056  CGBuilderTy &Builder) {
4057  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4058  ASTContext &C = CGM.getContext();
4059  const BlockDecl *blockDecl = block.getBlockDecl();
4060 
4061  // Collect some general information about the block's location.
4062  SourceLocation loc = blockDecl->getCaretLocation();
4063  llvm::DIFile *tunit = getOrCreateFile(loc);
4064  unsigned line = getLineNumber(loc);
4065  unsigned column = getColumnNumber(loc);
4066 
4067  // Build the debug-info type for the block literal.
4068  getDeclContextDescriptor(blockDecl);
4069 
4070  const llvm::StructLayout *blockLayout =
4071  CGM.getDataLayout().getStructLayout(block.StructureType);
4072 
4074  collectDefaultFieldsForBlockLiteralDeclare(block, C, loc, *blockLayout, tunit,
4075  fields);
4076 
4077  // We want to sort the captures by offset, not because DWARF
4078  // requires this, but because we're paranoid about debuggers.
4080 
4081  // 'this' capture.
4082  if (blockDecl->capturesCXXThis()) {
4083  BlockLayoutChunk chunk;
4084  chunk.OffsetInBits =
4085  blockLayout->getElementOffsetInBits(block.CXXThisIndex);
4086  chunk.Capture = nullptr;
4087  chunks.push_back(chunk);
4088  }
4089 
4090  // Variable captures.
4091  for (const auto &capture : blockDecl->captures()) {
4092  const VarDecl *variable = capture.getVariable();
4093  const CGBlockInfo::Capture &captureInfo = block.getCapture(variable);
4094 
4095  // Ignore constant captures.
4096  if (captureInfo.isConstant())
4097  continue;
4098 
4099  BlockLayoutChunk chunk;
4100  chunk.OffsetInBits =
4101  blockLayout->getElementOffsetInBits(captureInfo.getIndex());
4102  chunk.Capture = &capture;
4103  chunks.push_back(chunk);
4104  }
4105 
4106  // Sort by offset.
4107  llvm::array_pod_sort(chunks.begin(), chunks.end());
4108 
4109  for (const BlockLayoutChunk &Chunk : chunks) {
4110  uint64_t offsetInBits = Chunk.OffsetInBits;
4111  const BlockDecl::Capture *capture = Chunk.Capture;
4112 
4113  // If we have a null capture, this must be the C++ 'this' capture.
4114  if (!capture) {
4115  QualType type;
4116  if (auto *Method =
4117  cast_or_null<CXXMethodDecl>(blockDecl->getNonClosureContext()))
4118  type = Method->getThisType();
4119  else if (auto *RDecl = dyn_cast<CXXRecordDecl>(blockDecl->getParent()))
4120  type = QualType(RDecl->getTypeForDecl(), 0);
4121  else
4122  llvm_unreachable("unexpected block declcontext");
4123 
4124  fields.push_back(createFieldType("this", type, loc, AS_public,
4125  offsetInBits, tunit, tunit));
4126  continue;
4127  }
4128 
4129  const VarDecl *variable = capture->getVariable();
4130  StringRef name = variable->getName();
4131 
4132  llvm::DIType *fieldType;
4133  if (capture->isByRef()) {
4134  TypeInfo PtrInfo = C.getTypeInfo(C.VoidPtrTy);
4135  auto Align = PtrInfo.AlignIsRequired ? PtrInfo.Align : 0;
4136  // FIXME: This recomputes the layout of the BlockByRefWrapper.
4137  uint64_t xoffset;
4138  fieldType =
4139  EmitTypeForVarWithBlocksAttr(variable, &xoffset).BlockByRefWrapper;
4140  fieldType = DBuilder.createPointerType(fieldType, PtrInfo.Width);
4141  fieldType = DBuilder.createMemberType(tunit, name, tunit, line,
4142  PtrInfo.Width, Align, offsetInBits,
4143  llvm::DINode::FlagZero, fieldType);
4144  } else {
4145  auto Align = getDeclAlignIfRequired(variable, CGM.getContext());
4146  fieldType = createFieldType(name, variable->getType(), loc, AS_public,
4147  offsetInBits, Align, tunit, tunit);
4148  }
4149  fields.push_back(fieldType);
4150  }
4151 
4152  SmallString<36> typeName;
4153  llvm::raw_svector_ostream(typeName)
4154  << "__block_literal_" << CGM.getUniqueBlockCount();
4155 
4156  llvm::DINodeArray fieldsArray = DBuilder.getOrCreateArray(fields);
4157 
4158  llvm::DIType *type =
4159  DBuilder.createStructType(tunit, typeName.str(), tunit, line,
4160  CGM.getContext().toBits(block.BlockSize), 0,
4161  llvm::DINode::FlagZero, nullptr, fieldsArray);
4162  type = DBuilder.createPointerType(type, CGM.PointerWidthInBits);
4163 
4164  // Get overall information about the block.
4165  llvm::DINode::DIFlags flags = llvm::DINode::FlagArtificial;
4166  auto *scope = cast<llvm::DILocalScope>(LexicalBlockStack.back());
4167 
4168  // Create the descriptor for the parameter.
4169  auto *debugVar = DBuilder.createParameterVariable(
4170  scope, Name, ArgNo, tunit, line, type, CGM.getLangOpts().Optimize, flags);
4171 
4172  // Insert an llvm.dbg.declare into the current block.
4173  DBuilder.insertDeclare(Alloca, debugVar, DBuilder.createExpression(),
4174  llvm::DebugLoc::get(line, column, scope, CurInlinedAt),
4175  Builder.GetInsertBlock());
4176 }
4177 
4178 llvm::DIDerivedType *
4179 CGDebugInfo::getOrCreateStaticDataMemberDeclarationOrNull(const VarDecl *D) {
4180  if (!D->isStaticDataMember())
4181  return nullptr;
4182 
4183  auto MI = StaticDataMemberCache.find(D->getCanonicalDecl());
4184  if (MI != StaticDataMemberCache.end()) {
4185  assert(MI->second && "Static data member declaration should still exist");
4186  return MI->second;
4187  }
4188 
4189  // If the member wasn't found in the cache, lazily construct and add it to the
4190  // type (used when a limited form of the type is emitted).
4191  auto DC = D->getDeclContext();
4192  auto *Ctxt = cast<llvm::DICompositeType>(getDeclContextDescriptor(D));
4193  return CreateRecordStaticField(D, Ctxt, cast<RecordDecl>(DC));
4194 }
4195 
4196 llvm::DIGlobalVariableExpression *CGDebugInfo::CollectAnonRecordDecls(
4197  const RecordDecl *RD, llvm::DIFile *Unit, unsigned LineNo,
4198  StringRef LinkageName, llvm::GlobalVariable *Var, llvm::DIScope *DContext) {
4199  llvm::DIGlobalVariableExpression *GVE = nullptr;
4200 
4201  for (const auto *Field : RD->fields()) {
4202  llvm::DIType *FieldTy = getOrCreateType(Field->getType(), Unit);
4203  StringRef FieldName = Field->getName();
4204 
4205  // Ignore unnamed fields, but recurse into anonymous records.
4206  if (FieldName.empty()) {
4207  if (const auto *RT = dyn_cast<RecordType>(Field->getType()))
4208  GVE = CollectAnonRecordDecls(RT->getDecl(), Unit, LineNo, LinkageName,
4209  Var, DContext);
4210  continue;
4211  }
4212  // Use VarDecl's Tag, Scope and Line number.
4213  GVE = DBuilder.createGlobalVariableExpression(
4214  DContext, FieldName, LinkageName, Unit, LineNo, FieldTy,
4215  Var->hasLocalLinkage());
4216  Var->addDebugInfo(GVE);
4217  }
4218  return GVE;
4219 }
4220 
4221 void CGDebugInfo::EmitGlobalVariable(llvm::GlobalVariable *Var,
4222  const VarDecl *D) {
4223  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4224  if (D->hasAttr<NoDebugAttr>())
4225  return;
4226 
4227  // If we already created a DIGlobalVariable for this declaration, just attach
4228  // it to the llvm::GlobalVariable.
4229  auto Cached = DeclCache.find(D->getCanonicalDecl());
4230  if (Cached != DeclCache.end())
4231  return Var->addDebugInfo(
4232  cast<llvm::DIGlobalVariableExpression>(Cached->second));
4233 
4234  // Create global variable debug descriptor.
4235  llvm::DIFile *Unit = nullptr;
4236  llvm::DIScope *DContext = nullptr;
4237  unsigned LineNo;
4238  StringRef DeclName, LinkageName;
4239  QualType T;
4240  llvm::MDTuple *TemplateParameters = nullptr;
4241  collectVarDeclProps(D, Unit, LineNo, T, DeclName, LinkageName,
4242  TemplateParameters, DContext);
4243 
4244  // Attempt to store one global variable for the declaration - even if we
4245  // emit a lot of fields.
4246  llvm::DIGlobalVariableExpression *GVE = nullptr;
4247 
4248  // If this is an anonymous union then we'll want to emit a global
4249  // variable for each member of the anonymous union so that it's possible
4250  // to find the name of any field in the union.
4251  if (T->isUnionType() && DeclName.empty()) {
4252  const RecordDecl *RD = T->castAs<RecordType>()->getDecl();
4253  assert(RD->isAnonymousStructOrUnion() &&
4254  "unnamed non-anonymous struct or union?");
4255  GVE = CollectAnonRecordDecls(RD, Unit, LineNo, LinkageName, Var, DContext);
4256  } else {
4257  auto Align = getDeclAlignIfRequired(D, CGM.getContext());
4258 
4260  unsigned AddressSpace =
4261  CGM.getContext().getTargetAddressSpace(D->getType());
4262  if (CGM.getLangOpts().CUDA && CGM.getLangOpts().CUDAIsDevice) {
4263  if (D->hasAttr<CUDASharedAttr>())
4264  AddressSpace =
4265  CGM.getContext().getTargetAddressSpace(LangAS::cuda_shared);
4266  else if (D->hasAttr<CUDAConstantAttr>())
4267  AddressSpace =
4268  CGM.getContext().getTargetAddressSpace(LangAS::cuda_constant);
4269  }
4270  AppendAddressSpaceXDeref(AddressSpace, Expr);
4271 
4272  GVE = DBuilder.createGlobalVariableExpression(
4273  DContext, DeclName, LinkageName, Unit, LineNo, getOrCreateType(T, Unit),
4274  Var->hasLocalLinkage(),
4275  Expr.empty() ? nullptr : DBuilder.createExpression(Expr),
4276  getOrCreateStaticDataMemberDeclarationOrNull(D), TemplateParameters,
4277  Align);
4278  Var->addDebugInfo(GVE);
4279  }
4280  DeclCache[D->getCanonicalDecl()].reset(GVE);
4281 }
4282 
4283 void CGDebugInfo::EmitGlobalVariable(const ValueDecl *VD, const APValue &Init) {
4284  assert(DebugKind >= codegenoptions::LimitedDebugInfo);
4285  if (VD->hasAttr<NoDebugAttr>())
4286  return;
4287  auto Align = getDeclAlignIfRequired(VD, CGM.getContext());
4288  // Create the descriptor for the variable.
4289  llvm::DIFile *Unit = getOrCreateFile(VD->getLocation());
4290  StringRef Name = VD->getName();
4291  llvm::DIType *Ty = getOrCreateType(VD->getType(), Unit);
4292  if (const auto *ECD = dyn_cast<EnumConstantDecl>(VD)) {
4293  const auto *ED = cast<EnumDecl>(ECD->getDeclContext());
4294  assert(isa<EnumType>(ED->getTypeForDecl()) && "Enum without EnumType?");
4295  Ty = getOrCreateType(QualType(ED->getTypeForDecl(), 0), Unit);
4296  }
4297  // Do not use global variables for enums.
4298  //
4299  // FIXME: why not?
4300  if (Ty->getTag() == llvm::dwarf::DW_TAG_enumeration_type)
4301  return;
4302  // Do not emit separate definitions for function local const/statics.
4303  if (isa<FunctionDecl>(VD->getDeclContext()))
4304  return;
4305  VD = cast<ValueDecl>(VD->getCanonicalDecl());
4306  auto *VarD = cast<VarDecl>(VD);
4307  if (VarD->isStaticDataMember()) {
4308  auto *RD = cast<RecordDecl>(VarD->getDeclContext());
4309  getDeclContextDescriptor(VarD);
4310  // Ensure that the type is retained even though it's otherwise unreferenced.
4311  //
4312  // FIXME: This is probably unnecessary, since Ty should reference RD
4313  // through its scope.
4314  RetainedTypes.push_back(
4315  CGM.getContext().getRecordType(RD).getAsOpaquePtr());
4316  return;
4317  }
4318 
4319  llvm::DIScope *DContext = getDeclContextDescriptor(VD);
4320 
4321  auto &GV = DeclCache[VD];
4322  if (GV)
4323  return;
4324  llvm::DIExpression *InitExpr = nullptr;
4325  if (CGM.getContext().getTypeSize(VD->getType()) <= 64) {
4326  // FIXME: Add a representation for integer constants wider than 64 bits.
4327  if (Init.isInt())
4328  InitExpr =
4329  DBuilder.createConstantValueExpression(Init.getInt().getExtValue());
4330  else if (Init.isFloat())
4331  InitExpr = DBuilder.createConstantValueExpression(
4332  Init.getFloat().bitcastToAPInt().getZExtValue());
4333  }
4334 
4335  llvm::MDTuple *TemplateParameters = nullptr;
4336 
4337  if (isa<VarTemplateSpecializationDecl>(VD))
4338  if (VarD) {
4339  llvm::DINodeArray parameterNodes = CollectVarTemplateParams(VarD, &*Unit);
4340  TemplateParameters = parameterNodes.get();
4341  }
4342 
4343  GV.reset(DBuilder.createGlobalVariableExpression(
4344  DContext, Name, StringRef(), Unit, getLineNumber(VD->getLocation()), Ty,
4345  true, InitExpr, getOrCreateStaticDataMemberDeclarationOrNull(VarD),
4346  TemplateParameters, Align));
4347 }
4348 
4349 llvm::DIScope *CGDebugInfo::getCurrentContextDescriptor(const Decl *D) {
4350  if (!LexicalBlockStack.empty())
4351  return LexicalBlockStack.back();
4352  llvm::DIScope *Mod = getParentModuleOrNull(D);
4353  return getContextDescriptor(D, Mod ? Mod : TheCU);
4354 }
4355 
4357  if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4358  return;
4359  const NamespaceDecl *NSDecl = UD.getNominatedNamespace();
4360  if (!NSDecl->isAnonymousNamespace() ||
4361  CGM.getCodeGenOpts().DebugExplicitImport) {
4362  auto Loc = UD.getLocation();
4363  DBuilder.createImportedModule(
4364  getCurrentContextDescriptor(cast<Decl>(UD.getDeclContext())),
4365  getOrCreateNamespace(NSDecl), getOrCreateFile(Loc), getLineNumber(Loc));
4366  }
4367 }
4368 
4370  if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4371  return;
4372  assert(UD.shadow_size() &&
4373  "We shouldn't be codegening an invalid UsingDecl containing no decls");
4374  // Emitting one decl is sufficient - debuggers can detect that this is an
4375  // overloaded name & provide lookup for all the overloads.
4376  const UsingShadowDecl &USD = **UD.shadow_begin();
4377 
4378  // FIXME: Skip functions with undeduced auto return type for now since we
4379  // don't currently have the plumbing for separate declarations & definitions
4380  // of free functions and mismatched types (auto in the declaration, concrete
4381  // return type in the definition)
4382  if (const auto *FD = dyn_cast<FunctionDecl>(USD.getUnderlyingDecl()))
4383  if (const auto *AT =
4384  FD->getType()->getAs<FunctionProtoType>()->getContainedAutoType())
4385  if (AT->getDeducedType().isNull())
4386  return;
4387  if (llvm::DINode *Target =
4388  getDeclarationOrDefinition(USD.getUnderlyingDecl())) {
4389  auto Loc = USD.getLocation();
4390  DBuilder.createImportedDeclaration(
4391  getCurrentContextDescriptor(cast<Decl>(USD.getDeclContext())), Target,
4392  getOrCreateFile(Loc), getLineNumber(Loc));
4393  }
4394 }
4395 
4397  if (CGM.getCodeGenOpts().getDebuggerTuning() != llvm::DebuggerKind::LLDB)
4398  return;
4399  if (Module *M = ID.getImportedModule()) {
4401  auto Loc = ID.getLocation();
4402  DBuilder.createImportedDeclaration(
4403  getCurrentContextDescriptor(cast<Decl>(ID.getDeclContext())),
4404  getOrCreateModuleRef(Info, DebugTypeExtRefs), getOrCreateFile(Loc),
4405  getLineNumber(Loc));
4406  }
4407 }
4408 
4409 llvm::DIImportedEntity *
4411  if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4412  return nullptr;
4413  auto &VH = NamespaceAliasCache[&NA];
4414  if (VH)
4415  return cast<llvm::DIImportedEntity>(VH);
4416  llvm::DIImportedEntity *R;
4417  auto Loc = NA.getLocation();
4418  if (const auto *Underlying =
4419  dyn_cast<NamespaceAliasDecl>(NA.getAliasedNamespace()))
4420  // This could cache & dedup here rather than relying on metadata deduping.
4421  R = DBuilder.createImportedDeclaration(
4422  getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4423  EmitNamespaceAlias(*Underlying), getOrCreateFile(Loc),
4424  getLineNumber(Loc), NA.getName());
4425  else
4426  R = DBuilder.createImportedDeclaration(
4427  getCurrentContextDescriptor(cast<Decl>(NA.getDeclContext())),
4428  getOrCreateNamespace(cast<NamespaceDecl>(NA.getAliasedNamespace())),
4429  getOrCreateFile(Loc), getLineNumber(Loc), NA.getName());
4430  VH.reset(R);
4431  return R;
4432 }
4433 
4434 llvm::DINamespace *
4435 CGDebugInfo::getOrCreateNamespace(const NamespaceDecl *NSDecl) {
4436  // Don't canonicalize the NamespaceDecl here: The DINamespace will be uniqued
4437  // if necessary, and this way multiple declarations of the same namespace in
4438  // different parent modules stay distinct.
4439  auto I = NamespaceCache.find(NSDecl);
4440  if (I != NamespaceCache.end())
4441  return cast<llvm::DINamespace>(I->second);
4442 
4443  llvm::DIScope *Context = getDeclContextDescriptor(NSDecl);
4444  // Don't trust the context if it is a DIModule (see comment above).
4445  llvm::DINamespace *NS =
4446  DBuilder.createNameSpace(Context, NSDecl->getName(), NSDecl->isInline());
4447  NamespaceCache[NSDecl].reset(NS);
4448  return NS;
4449 }
4450 
4451 void CGDebugInfo::setDwoId(uint64_t Signature) {
4452  assert(TheCU && "no main compile unit");
4453  TheCU->setDWOId(Signature);
4454 }
4455 
4457  // Creating types might create further types - invalidating the current
4458  // element and the size(), so don't cache/reference them.
4459  for (size_t i = 0; i != ObjCInterfaceCache.size(); ++i) {
4460  ObjCInterfaceCacheEntry E = ObjCInterfaceCache[i];
4461  llvm::DIType *Ty = E.Type->getDecl()->getDefinition()
4462  ? CreateTypeDefinition(E.Type, E.Unit)
4463  : E.Decl;
4464  DBuilder.replaceTemporary(llvm::TempDIType(E.Decl), Ty);
4465  }
4466 
4467  if (CGM.getCodeGenOpts().DwarfVersion >= 5) {
4468  // Add methods to interface.
4469  for (const auto &P : ObjCMethodCache) {
4470  if (P.second.empty())
4471  continue;
4472 
4473  QualType QTy(P.first->getTypeForDecl(), 0);
4474  auto It = TypeCache.find(QTy.getAsOpaquePtr());
4475  assert(It != TypeCache.end());
4476 
4477  llvm::DICompositeType *InterfaceDecl =
4478  cast<llvm::DICompositeType>(It->second);
4479 
4481  auto CurrenetElts = InterfaceDecl->getElements();
4482  EltTys.append(CurrenetElts.begin(), CurrenetElts.end());
4483  for (auto &MD : P.second)
4484  EltTys.push_back(MD);
4485  llvm::DINodeArray Elements = DBuilder.getOrCreateArray(EltTys);
4486  DBuilder.replaceArrays(InterfaceDecl, Elements);
4487  }
4488  }
4489 
4490  for (const auto &P : ReplaceMap) {
4491  assert(P.second);
4492  auto *Ty = cast<llvm::DIType>(P.second);
4493  assert(Ty->isForwardDecl());
4494 
4495  auto It = TypeCache.find(P.first);
4496  assert(It != TypeCache.end());
4497  assert(It->second);
4498 
4499  DBuilder.replaceTemporary(llvm::TempDIType(Ty),
4500  cast<llvm::DIType>(It->second));
4501  }
4502 
4503  for (const auto &P : FwdDeclReplaceMap) {
4504  assert(P.second);
4505  llvm::TempMDNode FwdDecl(cast<llvm::MDNode>(P.second));
4506  llvm::Metadata *Repl;
4507 
4508  auto It = DeclCache.find(P.first);
4509  // If there has been no definition for the declaration, call RAUW
4510  // with ourselves, that will destroy the temporary MDNode and
4511  // replace it with a standard one, avoiding leaking memory.
4512  if (It == DeclCache.end())
4513  Repl = P.second;
4514  else
4515  Repl = It->second;
4516 
4517  if (auto *GVE = dyn_cast_or_null<llvm::DIGlobalVariableExpression>(Repl))
4518  Repl = GVE->getVariable();
4519  DBuilder.replaceTemporary(std::move(FwdDecl), cast<llvm::MDNode>(Repl));
4520  }
4521 
4522  // We keep our own list of retained types, because we need to look
4523  // up the final type in the type cache.
4524  for (auto &RT : RetainedTypes)
4525  if (auto MD = TypeCache[RT])
4526  DBuilder.retainType(cast<llvm::DIType>(MD));
4527 
4528  DBuilder.finalize();
4529 }
4530 
4532  if (CGM.getCodeGenOpts().getDebugInfo() < codegenoptions::LimitedDebugInfo)
4533  return;
4534 
4535  if (auto *DieTy = getOrCreateType(Ty, TheCU->getFile()))
4536  // Don't ignore in case of explicit cast where it is referenced indirectly.
4537  DBuilder.retainType(DieTy);
4538 }
4539 
4541  if (LexicalBlockStack.empty())
4542  return llvm::DebugLoc();
4543 
4544  llvm::MDNode *Scope = LexicalBlockStack.back();
4545  return llvm::DebugLoc::get(getLineNumber(Loc), getColumnNumber(Loc), Scope);
4546 }
4547 
4548 llvm::DINode::DIFlags CGDebugInfo::getCallSiteRelatedAttrs() const {
4549  // Call site-related attributes are only useful in optimized programs, and
4550  // when there's a possibility of debugging backtraces.
4551  if (!CGM.getLangOpts().Optimize || DebugKind == codegenoptions::NoDebugInfo ||
4552  DebugKind == codegenoptions::LocTrackingOnly)
4553  return llvm::DINode::FlagZero;
4554 
4555  // Call site-related attributes are available in DWARF v5. Some debuggers,
4556  // while not fully DWARF v5-compliant, may accept these attributes as if they
4557  // were part of DWARF v4.
4558  bool SupportsDWARFv4Ext =
4559  CGM.getCodeGenOpts().DwarfVersion == 4 &&
4560  CGM.getCodeGenOpts().getDebuggerTuning() == llvm::DebuggerKind::LLDB;
4561  if (!SupportsDWARFv4Ext && CGM.getCodeGenOpts().DwarfVersion < 5)
4562  return llvm::DINode::FlagZero;
4563 
4564  return llvm::DINode::FlagAllCallsDescribed;
4565 }
bool isNoReturn() const
Determines whether this function is known to be &#39;noreturn&#39;, through an attribute on its declaration o...
Definition: Decl.cpp:2947
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
Defines the clang::ASTContext interface.
CharUnits alignTo(const CharUnits &Align) const
alignTo - Returns the next integer (mod 2**64) that is greater than or equal to this quantity and is ...
Definition: CharUnits.h:183
const Type * getTypeForDecl() const
Definition: DeclObjC.h:1918
VarDecl * getCapturedVar() const
Retrieve the declaration of the local variable being captured.
bool isStruct() const
Definition: Decl.h:3248
const Capture & getCapture(const VarDecl *var) const
Definition: CGBlocks.h:270
Represents a function declaration or definition.
Definition: Decl.h:1737
FunctionTemplateDecl * getTemplate() const
Retrieve the template from which this function was specialized.
Definition: DeclTemplate.h:549
std::string Name
The name of this module.
Definition: Module.h:67
StringRef Identifier
Definition: Format.cpp:1714
static bool hasDefaultSetterName(const ObjCPropertyDecl *PD, const ObjCMethodDecl *Setter)
bool isObjCQualifiedIdType() const
True if this is equivalent to &#39;id.
Definition: Type.h:5885
const FunctionProtoType * getFunctionType() const
getFunctionType - Return the underlying function type for this block.
Definition: Expr.cpp:2134
Smart pointer class that efficiently represents Objective-C method names.
A class which contains all the information about a particular captured value.
Definition: Decl.h:3863
Module * getOwningModule() const
Get the module that owns this declaration (for visibility purposes).
Definition: DeclBase.h:755
StringRef getName(const PrintingPolicy &Policy) const
Definition: Type.cpp:2734
if(T->getSizeExpr()) TRY_TO(TraverseStmt(T -> getSizeExpr()))
PointerType - C99 6.7.5.1 - Pointer Declarators.
Definition: Type.h:2549
QualType getElementType() const
Definition: Type.h:6028
CanQualType VoidPtrTy
Definition: ASTContext.h:1043
QualType getPointeeType() const
Definition: Type.h:2562
void EmitLocation(raw_ostream &o, const SourceManager &SM, SourceLocation L, const FIDMap &FM, unsigned indent)
Definition: PlistSupport.h:107
bool isPrimaryBaseVirtual() const
isPrimaryBaseVirtual - Get whether the primary base for this record is virtual or not...
Definition: RecordLayout.h:225
static uint32_t getTypeAlignIfRequired(const Type *Ty, const ASTContext &Ctx)
Definition: CGDebugInfo.cpp:51
A (possibly-)qualified type.
Definition: Type.h:639
base_class_range bases()
Definition: DeclCXX.h:822
const CodeGenOptions & getCodeGenOpts() const
ObjCInterfaceDecl * getClassInterface()
Definition: DeclObjC.cpp:1143
void EmitExplicitCastType(QualType Ty)
Emit the type explicitly casted to.
ArrayRef< TemplateArgument > getPackAsArray() const
Return the array of arguments in this template argument pack.
Definition: TemplateBase.h:365
Defines the clang::FileManager interface and associated types.
bool isMemberDataPointerType() const
Definition: Type.h:6350
QualType getDesugaredType(const ASTContext &Context) const
Return the specified type with any "sugar" removed from the type.
Definition: Type.h:939
std::string getClangFullVersion()
Retrieves a string representing the complete clang version, which includes the clang version number...
Definition: Version.cpp:117
void EmitLabel(const LabelDecl *D, CGBuilderTy &Builder)
Emit call to llvm.dbg.label for an label.
TypePropertyCache< Private > Cache
Definition: Type.cpp:3573
llvm::DIType * getOrCreateRecordType(QualType Ty, SourceLocation L)
Emit record type&#39;s standalone debug info.
Kind getKind() const
Definition: Type.h:2430
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition: Type.h:3367
void EmitLexicalBlockEnd(CGBuilderTy &Builder, SourceLocation Loc)
Emit metadata to indicate the end of a new lexical block and pop the current block.
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee...
Definition: Type.cpp:505
CharUnits getBaseClassOffset(const CXXRecordDecl *Base) const
getBaseClassOffset - Get the offset, in chars, for the given base class.
Definition: RecordLayout.h:232
Defines the SourceManager interface.
QualType getThisType() const
Returns the type of the this pointer.
Definition: DeclCXX.cpp:2199
static bool shouldOmitDefinition(codegenoptions::DebugInfoKind DebugKind, bool DebugTypeExtRefs, const RecordDecl *RD, const LangOptions &LangOpts)
The template argument is an expression, and we&#39;ve not resolved it to one of the other forms yet...
Definition: TemplateBase.h:86
bool isRecordType() const
Definition: Type.h:6381
QualType getQualifiedType(SplitQualType split) const
Un-split a SplitQualType.
Definition: ASTContext.h:1932
const Type * getTypeForDecl() const
Definition: Decl.h:2897
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:87
TagDecl * getDecl() const
Definition: Type.cpp:3244
bool isVirtual() const
Definition: DeclCXX.h:2093
Selector getObjCSelector() const
Get the Objective-C selector stored in this declaration name.
Defines the C++ template declaration subclasses.
StringRef P
Parameter for C++ &#39;this&#39; argument.
Definition: Decl.h:1500
static QualType UnwrapTypeForDebugInfo(QualType T, const ASTContext &C)
static bool hasDefaultGetterName(const ObjCPropertyDecl *PD, const ObjCMethodDecl *Getter)
The base class of the type hierarchy.
Definition: Type.h:1414
Represents an array type, per C99 6.7.5.2 - Array Declarators.
Definition: Type.h:2824
Declaration of a variable template.
The template argument is a declaration that was provided for a pointer, reference, or pointer to member non-type template parameter.
Definition: TemplateBase.h:63
Represent a C++ namespace.
Definition: Decl.h:514
NamedDecl * getParam(unsigned Idx)
Definition: DeclTemplate.h:132
AccessSpecifier
A C++ access specifier (public, private, protected), plus the special value "none" which means differ...
Definition: Specifiers.h:97
QualType getValueType() const
Gets the type contained by this atomic type, i.e.
Definition: Type.h:5995
static bool needsTypeIdentifier(const TagDecl *TD, CodeGenModule &CGM, llvm::DICompileUnit *TheCU)
Describes the capture of a variable or of this, or of a C++1y init-capture.
Definition: LambdaCapture.h:25
float __ovld __cnfn distance(float p0, float p1)
Returns the distance between p0 and p1.
MSInheritanceAttr::Spelling getMSInheritanceModel() const
Returns the inheritance model used for this record.
QualType getElementType() const
Definition: Type.h:2859
bool isCompleteDefinition() const
Return true if this decl has its body fully specified.
Definition: Decl.h:3168
StringRef getBufferData(FileID FID, bool *Invalid=nullptr) const
Return a StringRef to the source buffer data for the specified FileID.
enumerator_range enumerators() const
Definition: Decl.h:3452
bool isInterface() const
Definition: Decl.h:3249
Represents a variable declaration or definition.
Definition: Decl.h:812
void removeObjCLifetime()
Definition: Type.h:333
QualType getReturnType() const
Definition: Decl.h:2301
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:6768
Represents an empty template argument, e.g., one that has not been deduced.
Definition: TemplateBase.h:56
Extra information about a function prototype.
Definition: Type.h:3779
decl_range decls() const
decls_begin/decls_end - Iterate over the declarations stored in this context.
Definition: DeclBase.h:2010
A this pointer adjustment.
Definition: ABI.h:107
ObjCMethodDecl - Represents an instance or class method declaration.
Definition: DeclObjC.h:138
Stores a list of template parameters for a TemplateDecl and its derived classes.
Definition: DeclTemplate.h:67
Describes how types, statements, expressions, and declarations should be printed. ...
Definition: PrettyPrinter.h:37
bool isStatic() const
Definition: DeclCXX.cpp:1882
void completeTemplateDefinition(const ClassTemplateSpecializationDecl &SD)
bool hasDefinition() const
Definition: DeclCXX.h:775
static const NamedDecl * getDefinition(const Decl *D)
Definition: SemaDecl.cpp:2517
Represents a parameter to a function.
Definition: Decl.h:1549
QualType getIntegralType() const
Retrieve the type of the integral value.
Definition: TemplateBase.h:314
static llvm::dwarf::Tag getTagForRecord(const RecordDecl *RD)
The collection of all-type qualifiers we support.
Definition: Type.h:137
PipeType - OpenCL20.
Definition: Type.h:6014
bool isClass() const
Definition: Decl.h:3250
IdentifierInfo * getIdentifier() const
Get the identifier that names this declaration, if there is one.
Definition: Decl.h:269
void EmitInlineFunctionEnd(CGBuilderTy &Builder)
End an inlined function scope.
Represents a struct/union/class.
Definition: Decl.h:3592
const TemplateArgumentList & getTemplateArgs() const
Retrieve the template arguments of the class template specialization.
DeclarationName getDeclName() const
Get the actual, stored name of the declaration, which may be a special name.
Definition: Decl.h:297
Represents a class template specialization, which refers to a class template with a given set of temp...
One of these records is kept for each identifier that is lexed.
std::map< std::string, std::string > DebugPrefixMap
void print(raw_ostream &OS, const PrintingPolicy &Policy, bool SuppressNNS=false) const
Print the template name.
void addHeapAllocSiteMetadata(llvm::Instruction *CallSite, QualType Ty, SourceLocation Loc)
Add heapallocsite metadata for MSAllocator calls.
Represents a class type in Objective C.
Definition: Type.h:5550
void removeRestrict()
Definition: Type.h:266
QualType getPointeeType() const
Definition: Type.h:2666
CodeGenFunction - This class organizes the per-function state that is used while generating LLVM code...
Expr * getAsExpr() const
Retrieve the template argument as an expression.
Definition: TemplateBase.h:329
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:154
bool isInline() const
Returns true if this is an inline namespace declaration.
Definition: Decl.h:575
The template argument is an integral value stored in an llvm::APSInt that was provided for an integra...
Definition: TemplateBase.h:71
static bool isFunctionLocalClass(const CXXRecordDecl *RD)
isFunctionLocalClass - Return true if CXXRecordDecl is defined inside a function. ...
TemplateDecl * getAsTemplateDecl() const
Retrieve the underlying template declaration that this template name refers to, if known...
RecordDecl * getDefinition() const
Returns the RecordDecl that actually defines this struct/union/class.
Definition: Decl.h:3773
void EmitImportDecl(const ImportDecl &ID)
Emit an declaration.
field_range fields() const
Definition: Decl.h:3783
Represents a member of a struct/union/class.
Definition: Decl.h:2578
TemplateName getTemplateName() const
Retrieve the name of the template that we are specializing.
Definition: Type.h:4916
void removeConst()
Definition: Type.h:256
CXXMethodDecl * getCanonicalDecl() override
Retrieves the "canonical" declaration of the given declaration.
Definition: DeclCXX.h:2134
prop_range properties() const
Definition: DeclObjC.h:987
void completeClassData(const RecordDecl *RD)
static CharUnits Zero()
Zero - Construct a CharUnits quantity of zero.
Definition: CharUnits.h:52
llvm::DIMacro * CreateMacro(llvm::DIMacroFile *Parent, unsigned MType, SourceLocation LineLoc, StringRef Name, StringRef Value)
Create debug info for a macro defined by a #define directive or a macro undefined by a #undef directi...
method_iterator method_begin() const
Method begin iterator.
Definition: DeclCXX.h:870
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
bool isFloat() const
Definition: APValue.h:239
Describes a module or submodule.
Definition: Module.h:64
QualType getParamTypeForDecl() const
Definition: TemplateBase.h:268
Qualifiers getLocalQualifiers() const
Retrieve the set of qualifiers local to this particular QualType instance, not including any qualifie...
Definition: Type.h:6103
ArrayRef< ParmVarDecl * > parameters() const
Definition: Decl.h:2261
Provides information about a function template specialization, which is a FunctionDecl that has been ...
Definition: DeclTemplate.h:507
bool isGLValue() const
Definition: Expr.h:254
Represents a C++ using-declaration.
Definition: DeclCXX.h:3359
Type(TypeClass tc, QualType canon, bool Dependent, bool InstantiationDependent, bool VariablyModified, bool ContainsUnexpandedParameterPack)
Definition: Type.h:1777
const TemplateArgumentList * TemplateArguments
The template arguments used to produce the function template specialization from the function templat...
Definition: DeclTemplate.h:539
static SmallString< 64 > constructSetterName(StringRef Name)
Return the default setter name for the given identifier.
ArrayRef< VTableComponent > vtable_components() const
unsigned Size
The total size of the bit-field, in bits.
An rvalue reference type, per C++11 [dcl.ref].
Definition: Type.h:2750
bool isBitField() const
Determines whether this field is a bitfield.
Definition: Decl.h:2656
DeclContext * getEnclosingNamespaceContext()
Retrieve the nearest enclosing namespace context.
Definition: DeclBase.cpp:1766
bool isNonFragile() const
Does this runtime follow the set of implied behaviors for a "non-fragile" ABI?
Definition: ObjCRuntime.h:81
RefQualifierKind getRefQualifier() const
Retrieve the ref-qualifier associated with this method.
Definition: DeclCXX.h:2210
An lvalue ref-qualifier was provided (&).
Definition: Type.h:1370
~ApplyInlineDebugLocation()
Restore everything back to the original state.
CharUnits - This is an opaque type for sizes expressed in character units.
Definition: CharUnits.h:37
bool capturesThis() const
Determine whether this capture handles the C++ this pointer.
Definition: LambdaCapture.h:82
APValue Val
Val - This is the value the expression can be folded to.
Definition: Expr.h:575
const BlockDecl * getBlockDecl() const
Definition: CGBlocks.h:280
void print(raw_ostream &OS, const PrintingPolicy &Policy, const Twine &PlaceHolder=Twine(), unsigned Indentation=0) const
Emit location information but do not generate debug info in the output.
bool hasPrototype() const
Whether this function has a prototype, either because one was explicitly written or because it was "i...
Definition: Decl.h:2066
CharUnits StorageOffset
The offset of the bitfield storage from the start of the struct.
QualType getNullPtrType() const
Retrieve the type for null non-type template argument.
Definition: TemplateBase.h:274
bool isTypeAlias() const
Determine if this template specialization type is for a type alias template that has been substituted...
Definition: Type.h:4901
void EmitGlobalVariable(llvm::GlobalVariable *GV, const VarDecl *Decl)
Emit information about a global variable.
Deleting dtor.
Definition: ABI.h:34
bool isByRef() const
Whether this is a "by ref" capture, i.e.
Definition: Decl.h:3888
Represents a declaration of a type.
Definition: Decl.h:2873
static bool hasCXXMangling(const TagDecl *TD, llvm::DICompileUnit *TheCU)
Module * Parent
The parent of this module.
Definition: Module.h:92
const Type * getClass() const
Definition: Type.h:2802
FunctionTemplateSpecializationInfo * getTemplateSpecializationInfo() const
If this function is actually a function template specialization, retrieve information about this func...
Definition: Decl.cpp:3486
bool isLambda() const
Determine whether this class describes a lambda function object.
Definition: DeclCXX.h:1195
Scope - A scope is a transient data structure that is used while parsing the program.
Definition: Scope.h:40
static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R)
Returns the common set of qualifiers while removing them from the given sets.
Definition: Type.h:188
llvm::DIType * getOrCreateInterfaceType(QualType Ty, SourceLocation Loc)
Emit an Objective-C interface type standalone debug info.
const Type * getTypePtr() const
Retrieves a pointer to the underlying (unqualified) type.
Definition: Type.h:6084
unsigned Align
Definition: ASTContext.h:144
field_iterator field_begin() const
Definition: Decl.cpp:4168
bool AlignIsRequired
Definition: ASTContext.h:145
bool isInt() const
Definition: APValue.h:238
bool isCompleteDefinitionRequired() const
Return true if this complete decl is required to be complete for some existing use.
Definition: Decl.h:3177
unsigned Offset
The offset within a contiguous run of bitfields that are represented as a single "field" within the L...
static uint32_t getDeclAlignIfRequired(const Decl *D, const ASTContext &Ctx)
Definition: CGDebugInfo.cpp:60
DeclContext * getLexicalDeclContext()
getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC)...
Definition: DeclBase.h:824
void EmitFunctionEnd(CGBuilderTy &Builder, llvm::Function *Fn)
Constructs the debug code for exiting a function.
llvm::DIImportedEntity * EmitNamespaceAlias(const NamespaceAliasDecl &NA)
Emit C++ namespace alias.
bool isInstance() const
Definition: DeclCXX.h:2076
void * getAsOpaquePtr() const
Definition: Type.h:684
FunctionDecl * getInstantiatedFromMemberFunction() const
If this function is an instantiation of a member function of a class template specialization, retrieves the function from which it was instantiated.
Definition: Decl.cpp:3349
Represents an ObjC class declaration.
Definition: DeclObjC.h:1171
shadow_iterator shadow_begin() const
Definition: DeclCXX.h:3463
void removeVolatile()
Definition: Type.h:261
bool hasConst() const
Definition: Type.h:254
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition: DeclBase.h:873
bool isAnonymousStructOrUnion() const
Whether this is an anonymous struct or union.
Definition: Decl.h:3665
Module * getImportedModule() const
Retrieve the module that was imported by the import declaration.
Definition: Decl.h:4199
bool NeedsCopyDispose
True if the block has captures that would necessitate custom copy or dispose helper functions if the ...
Definition: CGBlocks.h:222
ObjCPropertyImplDecl - Represents implementation declaration of a property in a class or category imp...
Definition: DeclObjC.h:2758
NodeId Parent
Definition: ASTDiff.cpp:191
QualType getBlockDescriptorExtendedType() const
Gets the struct used to keep track of the extended descriptor for pointer to blocks.
static unsigned getDwarfCC(CallingConv CC)
bool hasAttr() const
Definition: DeclBase.h:534
QualType getBaseType() const
Gets the base type of this object type.
Definition: Type.h:5613
Represents a prototype with parameter type info, e.g.
Definition: Type.h:3699
bool isDynamicClass() const
Definition: DeclCXX.h:788
unsigned MSVCFormatting
Use whitespace and punctuation like MSVC does.
CGBlockInfo - Information to generate a block literal.
Definition: CGBlocks.h:152
TemplateSpecializationKind getTemplateSpecializationKind() const
Determine whether this particular class is a specialization or instantiation of a class template or m...
Definition: DeclCXX.cpp:1637
Represents a ValueDecl that came out of a declarator.
Definition: Decl.h:688
QuantityType getQuantity() const
getQuantity - Get the raw integer representation of this quantity.
Definition: CharUnits.h:178
ObjCTypeParamDecl * getDecl() const
Definition: Type.h:5519
void setDwoId(uint64_t Signature)
Module debugging: Support for building PCMs.
ValueDecl * getAsDecl() const
Retrieve the declaration for a declaration non-type template argument.
Definition: TemplateBase.h:263
unsigned Offset
Definition: Format.cpp:1709
ASTRecordLayout - This class contains layout information for one RecordDecl, which is a struct/union/...
Definition: RecordLayout.h:38
capture_const_iterator captures_end() const
Definition: DeclCXX.h:1255
llvm::DILocalVariable * EmitDeclareOfAutoVariable(const VarDecl *Decl, llvm::Value *AI, CGBuilderTy &Builder)
Emit call to llvm.dbg.declare for an automatic variable declaration.
bool isValid() const
void EmitLocation(CGBuilderTy &Builder, SourceLocation Loc)
Emit metadata to indicate a change in line/column information in the source file. ...
TemplateParameterList * getTemplateParameters() const
Get the list of template parameters.
Definition: DeclTemplate.h:431
ApplyInlineDebugLocation(CodeGenFunction &CGF, GlobalDecl InlinedFn)
Set up the CodeGenFunction&#39;s DebugInfo to produce inline locations for the function InlinedFn...
Represents a block literal declaration, which is like an unnamed FunctionDecl.
Definition: Decl.h:3857
Represent the declaration of a variable (in which case it is an lvalue) a function (in which case it ...
Definition: Decl.h:636
This represents one expression.
Definition: Expr.h:108
QualType getPointeeType() const
Definition: Type.h:2706
SourceLocation End
known_extensions_range known_extensions() const
Definition: DeclObjC.h:1760
Emit only debug info necessary for generating line number tables (-gline-tables-only).
bool isPositive() const
isPositive - Test whether the quantity is greater than zero.
Definition: CharUnits.h:121
bool isVariadic() const
Whether this function is variadic.
Definition: Decl.cpp:2702
bool isInvalid() const
Return true if this object is invalid or uninitialized.
void EmitInlineFunctionStart(CGBuilderTy &Builder, GlobalDecl GD)
Start a new scope for an inlined function.
const FileEntry * getFileEntryForID(FileID FID) const
Returns the FileEntry record for the provided FileID.
const AnnotatedLine * Line
const CXXRecordDecl * getPointeeCXXRecordDecl() const
If this is a pointer or reference to a RecordType, return the CXXRecordDecl that the type refers to...
Definition: Type.cpp:1620
const T * castAs() const
Member-template castAs<specific type>.
Definition: Type.h:6831
The template argument is a null pointer or null pointer to member that was provided for a non-type te...
Definition: TemplateBase.h:67
unsigned getLine() const
Return the presumed line number of this location.
Represents a C++ destructor within a class.
Definition: DeclCXX.h:2713
Defines version macros and version-related utility functions for Clang.
bool isAnonymousNamespace() const
Returns true if this is an anonymous namespace declaration.
Definition: Decl.h:570
bool isImplicit() const
isImplicit - Indicates whether the declaration was implicitly generated by the implementation.
Definition: DeclBase.h:550
const TemplateArgumentList * getTemplateSpecializationArgs() const
Retrieve the template arguments used to produce this function template specialization from the primar...
Definition: Decl.cpp:3492
llvm::DIMacroFile * CreateTempMacroFile(llvm::DIMacroFile *Parent, SourceLocation LineLoc, SourceLocation FileLoc)
Create debug info for a file referenced by an #include directive.
field_iterator field_end() const
Definition: Decl.h:3786
ClassTemplateDecl * getSpecializedTemplate() const
Retrieve the template that this specialization specializes.
StringRef getNameForSlot(unsigned argIndex) const
Retrieve the name at a given position in the selector.
DeclContext * getDeclContext()
Definition: DeclBase.h:430
ObjCInterfaceDecl * getSuperClass() const
Definition: DeclObjC.cpp:337
const CXXRecordDecl * getPrimaryBase() const
getPrimaryBase - Get the primary base for this record.
Definition: RecordLayout.h:217
static CharUnits fromQuantity(QuantityType Quantity)
fromQuantity - Construct a CharUnits quantity from a raw integer type.
Definition: CharUnits.h:62
ArrayRef< TemplateArgument > asArray() const
Produce this as an array ref.
Definition: DeclTemplate.h:263
void completeUnusedClass(const CXXRecordDecl &D)
EnumDecl * getDefinition() const
Definition: Decl.h:3426
void printTemplateArgumentList(raw_ostream &OS, ArrayRef< TemplateArgument > Args, const PrintingPolicy &Policy)
Print a template argument list, including the &#39;<&#39; and &#39;>&#39; enclosing the template arguments.
StencilPart node(llvm::StringRef Id)
bool isSignedIntegerType() const
Return true if this is an integer type that is signed, according to C99 6.2.5p4 [char, signed char, short, int, long..], or an enum decl which has a signed representation.
Definition: Type.cpp:1866
QualType getType() const
Definition: Expr.h:130
clang::ObjCRuntime ObjCRuntime
Definition: LangOptions.h:206
bool hasExtendableVFPtr() const
hasVFPtr - Does this class have a virtual function table pointer that can be extended by a derived cl...
Definition: RecordLayout.h:267
unsigned getMaxAlignment() const
getMaxAlignment - return the maximum alignment specified by attributes on this decl, 0 if there are none.
Definition: DeclBase.cpp:383
DeclContext * getParent()
getParent - Returns the containing DeclContext.
Definition: DeclBase.h:1761
method_iterator method_end() const
Method past-the-end iterator.
Definition: DeclCXX.h:875
Represents an unpacked "presumed" location which can be presented to the user.
bool isInstanceMethod() const
Definition: DeclObjC.h:421
QualType getBlockDescriptorType() const
Gets the struct used to keep track of the descriptor for pointer to blocks.
Represents a GCC generic vector type.
Definition: Type.h:3180
SourceLocation getCaretLocation() const
Definition: Decl.h:3930
An lvalue reference type, per C++11 [dcl.ref].
Definition: Type.h:2732
APValue * evaluateValue() const
Attempt to evaluate the value of the initializer attached to this declaration, and produce notes expl...
Definition: Decl.cpp:2271
Selector getSelector() const
Definition: DeclObjC.h:320
void printQualifiedName(raw_ostream &OS) const
Returns a human-readable qualified name for this declaration, like A::B::i, for i being member of nam...
Definition: Decl.cpp:1534
bool isUnionType() const
Definition: Type.cpp:475
bool isNull() const
Return true if this QualType doesn&#39;t point to a type yet.
Definition: Type.h:704
ImplicitParamDecl * getSelfDecl() const
Definition: DeclObjC.h:413
static json::Object createFile(const FileEntry &FE)
const SourceManager & SM
Definition: Format.cpp:1568
CallingConv
CallingConv - Specifies the calling convention that a function uses.
Definition: Specifiers.h:235
VarDecl * getCanonicalDecl() override
Retrieves the "canonical" declaration of the given declaration.
Definition: Decl.cpp:2039
GlobalDecl - represents a global declaration.
Definition: GlobalDecl.h:34
bool isVoidPointerType() const
Definition: Type.cpp:469
bool isObjCOneArgSelector() const
The l-value was considered opaque, so the alignment was determined from a type.
RecordDecl * getDecl() const
Definition: Type.h:4392
const char * getFilename() const
Return the presumed filename of this location.
void EmitDeclareOfArgVariable(const VarDecl *Decl, llvm::Value *AI, unsigned ArgNo, CGBuilderTy &Builder)
Emit call to llvm.dbg.declare for an argument variable declaration.
bool capturesVariable() const
Determine whether this capture handles a variable.
Definition: LambdaCapture.h:88
Pass it as a pointer to temporary memory.
Definition: CGCXXABI.h:136
uint64_t getFieldOffset(unsigned FieldNo) const
getFieldOffset - Get the offset of the given field index, in bits.
Definition: RecordLayout.h:190
virtual void printName(raw_ostream &os) const
Definition: Decl.cpp:1523
unsigned size_overridden_methods() const
Definition: DeclCXX.cpp:2179
void EmitFunctionDecl(GlobalDecl GD, SourceLocation Loc, QualType FnType)
Emit debug info for a function declaration.
static llvm::DINode::DIFlags getAccessFlag(AccessSpecifier Access, const RecordDecl *RD)
Convert an AccessSpecifier into the corresponding DINode flag.
std::string getAsString() const
Derive the full selector name (e.g.
virtual void mangleCXXRTTIName(QualType T, raw_ostream &)=0
ExtProtoInfo getExtProtoInfo() const
Definition: Type.h:3911
redecl_range redecls() const
Returns an iterator range for all the redeclarations of the same decl.
Definition: Redeclarable.h:294
unsigned getColumn() const
Return the presumed column number of this location.
Encodes a location in the source.
ObjCInterfaceDecl * getDecl() const
Get the declaration of this interface.
Definition: Type.h:5763
QualType getReturnType() const
Definition: Type.h:3625
bool isPure() const
Whether this virtual function is pure, i.e.
Definition: Decl.h:2008
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of enums...
Definition: Type.h:4408
Interfaces are the core concept in Objective-C for object oriented design.
Definition: Type.h:5750
llvm::StructType * StructureType
Definition: CGBlocks.h:245
void completeRequiredType(const RecordDecl *RD)
std::string getNameAsString() const
Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ c...
Definition: Decl.h:291
Limit generated debug info to reduce size (-fno-standalone-debug).
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3063
ASTContext & getASTContext() const LLVM_READONLY
Definition: DeclBase.cpp:375
QualType getElementType() const
Definition: Type.h:3215
const Decl * getDecl() const
Definition: GlobalDecl.h:68
static QualType getUnderlyingType(const SubRegion *R)
Represents the declaration of a label.
Definition: Decl.h:468
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:59
APFloat & getFloat()
Definition: APValue.h:271
Represents a static or instance method of a struct/union/class.
Definition: DeclCXX.h:2048
TypedefNameDecl * getTypedefNameForUnnamedTagDecl(const TagDecl *TD)
ObjCCategoryDecl - Represents a category declaration.
Definition: DeclObjC.h:2279
unsigned RemapFilePaths
Whether to apply -fdebug-prefix-map to any file paths.
bool isScoped() const
Returns true if this is a C++11 scoped enumeration.
Definition: Decl.h:3519
llvm::Constant * emitAbstract(const Expr *E, QualType T)
Emit the result of the given expression as an abstract constant, asserting that it succeeded...
Capture(VarDecl *variable, bool byRef, bool nested, Expr *copy)
Definition: Decl.h:3878
bool hasRestrict() const
Definition: Type.h:264
Represents one property declaration in an Objective-C interface.
Definition: DeclObjC.h:728
bool isFromASTFile() const
Determine whether this declaration came from an AST file (such as a precompiled header or module) rat...
Definition: DeclBase.h:698
const BlockExpr * getBlockExpr() const
Definition: CGBlocks.h:281
TypeClass getTypeClass() const
Definition: Type.h:1820
MangleContext & getMangleContext()
Gets the mangle context.
Definition: CGCXXABI.h:96
This template specialization was formed from a template-id but has not yet been declared, defined, or instantiated.
Definition: Specifiers.h:148
constexpr XRayInstrMask None
Definition: XRayInstr.h:37
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
VarDecl * getVariable() const
The variable being captured.
Definition: Decl.h:3884
llvm::APSInt getAsIntegral() const
Retrieve the template argument as an integral value.
Definition: TemplateBase.h:300
EnumDecl * getDecl() const
Definition: Type.h:4415
unsigned CXXThisIndex
The field index of &#39;this&#39; within the block, if there is one.
Definition: CGBlocks.h:158
An rvalue ref-qualifier was provided (&&).
Definition: Type.h:1373
void removeObjCGCAttr()
Definition: Type.h:305
ObjCImplementationDecl * getImplementation() const
Definition: DeclObjC.cpp:1548
static bool hasExplicitMemberDefinition(CXXRecordDecl::method_iterator I, CXXRecordDecl::method_iterator End)
llvm::DebugLoc SourceLocToDebugLoc(SourceLocation Loc)
Describes a module import declaration, which makes the contents of the named module visible in the cu...
Definition: Decl.h:4155
SourceLocation getExprLoc() const LLVM_READONLY
getExprLoc - Return the preferred location for the arrow when diagnosing a problem with a generic exp...
Definition: Expr.cpp:214
StringRef getName() const
Return the actual identifier string.
Base class for declarations which introduce a typedef-name.
Definition: Decl.h:2915
CXXRecordDecl * getMostRecentCXXRecordDecl() const
Definition: Type.cpp:4092
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Represents a template argument.
Definition: TemplateBase.h:50
const llvm::MemoryBuffer * getBuffer(FileID FID, SourceLocation Loc, bool *Invalid=nullptr) const
Return the buffer for the specified FileID.
void completeClass(const RecordDecl *RD)
This class organizes the cross-function state that is used while generating LLVM code.
NamespaceDecl * getNominatedNamespace()
Returns the namespace nominated by this using-directive.
Definition: DeclCXX.cpp:2581
Dataflow Directional Tag Classes.
virtual void getNameForDiagnostic(raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const
Appends a human-readable name for this declaration into the given stream.
Definition: Decl.cpp:1633
bool isValid() const
Return true if this is a valid SourceLocation object.
A qualifier set is used to build a set of qualifiers.
Definition: Type.h:6051
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1266
EvalResult is a struct with detailed info about an evaluated expression.
Definition: Expr.h:573
uint64_t Index
Method&#39;s index in the vftable.
ArrayRef< Capture > captures() const
Definition: Decl.h:3984
static SmallString< 256 > getTypeIdentifier(const TagType *Ty, CodeGenModule &CGM, llvm::DICompileUnit *TheCU)
The template argument is a pack expansion of a template name that was provided for a template templat...
Definition: TemplateBase.h:79
bool isRecord() const
Definition: DeclBase.h:1840
Parameter for Objective-C &#39;self&#39; argument.
Definition: Decl.h:1494
QualType getUnderlyingType() const
Definition: Decl.h:2970
llvm::iterator_range< base_class_const_iterator > base_class_const_range
Definition: DeclCXX.h:820
const Expr * getInit() const
Definition: Decl.h:1219
AccessSpecifier getAccess() const
Definition: DeclBase.h:465
ObjCInterfaceDecl * getDefinition()
Retrieve the definition of this class, or NULL if this class has been forward-declared (with @class) ...
Definition: DeclObjC.h:1548
FileID getMainFileID() const
Returns the FileID of the main source file.
bool hasLocalQualifiers() const
Determine whether this particular QualType instance has any qualifiers, without looking through any t...
Definition: Type.h:741
Emit only debug directives with the line numbers data.
This template specialization was instantiated from a template due to an explicit instantiation declar...
Definition: Specifiers.h:159
const CXXRecordDecl * getParent() const
Returns the parent of this method declaration, which is the class in which this method is defined...
Definition: DeclCXX.h:2173
const Type * strip(QualType type)
Collect any qualifiers on the given type and return an unqualified type.
Definition: Type.h:6058
Decl * getNonClosureContext()
Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc.
Definition: DeclBase.cpp:1002
unsigned shadow_size() const
Return the number of shadowed declarations associated with this using declaration.
Definition: DeclCXX.h:3471
CGDebugInfo(CodeGenModule &CGM)
Definition: CGDebugInfo.cpp:64
Represents an enum.
Definition: Decl.h:3325
unsigned StorageSize
The storage size in bits which should be used when accessing this bitfield.
PresumedLoc getPresumedLoc(SourceLocation Loc, bool UseLineDirectives=true) const
Returns the "presumed" location of a SourceLocation specifies.
A pointer to member type per C++ 8.3.3 - Pointers to members.
Definition: Type.h:2768
TemplateSpecializationKind
Describes the kind of template specialization that a particular template specialization declaration r...
Definition: Specifiers.h:145
QualType apply(const ASTContext &Context, QualType QT) const
Apply the collected qualifiers to the given type.
Definition: Type.cpp:3448
ExternalASTSource * getExternalSource() const
Retrieve a pointer to the external AST source associated with this AST context, if any...
Definition: ASTContext.h:1082
specific_decl_iterator - Iterates over a subrange of declarations stored in a DeclContext, providing only those that are of type SpecificDecl (or a class derived from it).
Definition: DeclBase.h:2030
Represents a pointer to an Objective C object.
Definition: Type.h:5806
Pointer to a block type.
Definition: Type.h:2651
FileID getFileID(SourceLocation SpellingLoc) const
Return the FileID for a SourceLocation.
ObjCImplementationDecl - Represents a class definition - this is where method definitions are specifi...
Definition: DeclObjC.h:2551
bool isIncompleteArrayType() const
Definition: Type.h:6365
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:4382
Complex values, per C99 6.2.5p11.
Definition: Type.h:2489
Don&#39;t generate debug info.
void EmitFunctionStart(GlobalDecl GD, SourceLocation Loc, SourceLocation ScopeLoc, QualType FnType, llvm::Function *Fn, bool CurFnIsThunk, CGBuilderTy &Builder)
Emit a call to llvm.dbg.function.start to indicate start of a new function.
bool empty() const
Definition: Type.h:415
llvm::DIType * getOrCreateStandaloneType(QualType Ty, SourceLocation Loc)
Emit standalone debug info for a type.
std::string remapDIPath(StringRef) const
Remap a given path with the current debug prefix map.
unsigned getOwningModuleID() const
Retrieve the global ID of the module that owns this particular declaration.
Definition: DeclBase.h:710
void completeType(const EnumDecl *ED)
DeclaratorDecl * getDeclaratorForUnnamedTagDecl(const TagDecl *TD)
The template argument is a type.
Definition: TemplateBase.h:59
The template argument is actually a parameter pack.
Definition: TemplateBase.h:90
APValue - This class implements a discriminated union of [uninitialized] [APSInt] [APFloat]...
Definition: APValue.h:38
uint64_t getTypeSize(QualType T) const
Return the size of the specified (complete) type T, in bits.
Definition: ASTContext.h:2072
bool isIncompleteType(NamedDecl **Def=nullptr) const
Types are partitioned into 3 broad categories (C99 6.2.5p1): object types, function types...
Definition: Type.cpp:2053
The type-property cache.
Definition: Type.cpp:3527
bool capturesCXXThis() const
Definition: Decl.h:3989
std::function< std::string(StringRef)> remapPath
When RemapFilePaths is true, this function performs the action.
A template argument list.
Definition: DeclTemplate.h:209
TypedefNameDecl * getDecl() const
Definition: Type.h:4179
void EmitUsingDecl(const UsingDecl &UD)
Emit C++ using declaration.
void EmitUsingDirective(const UsingDirectiveDecl &UD)
Emit C++ using directive.
void EmitLexicalBlockStart(CGBuilderTy &Builder, SourceLocation Loc)
Emit metadata to indicate the beginning of a new lexical block and push the block onto the stack...
ArgKind getKind() const
Return the kind of stored template argument.
Definition: TemplateBase.h:234
Represents a type parameter type in Objective C.
Definition: Type.h:5476
CallingConv getCallConv() const
Definition: Type.h:3635
QualType getAliasedType() const
Get the aliased type, if this is a specialization of a type alias template.
Definition: Type.h:4905
TypedefNameDecl * getTypedefNameForAnonDecl() const
Definition: Decl.h:3273
Represents a C++ struct/union/class.
Definition: DeclCXX.h:299
ArrayRef< TemplateArgument > template_arguments() const
Definition: Type.h:4932
TypeInfo getTypeInfo(const Type *T) const
Get the size and alignment of the specified complete type in bits.
The template argument is a template name that was provided for a template template parameter...
Definition: TemplateBase.h:75
ObjCIvarDecl - Represents an ObjC instance variable.
Definition: DeclObjC.h:1944
QualType getPointerType(QualType T) const
Return the uniqued reference to the type for a pointer to the specified type.
void EmitDeclareOfBlockDeclRefVariable(const VarDecl *variable, llvm::Value *storage, CGBuilderTy &Builder, const CGBlockInfo &blockInfo, llvm::Instruction *InsertPoint=nullptr)
Emit call to llvm.dbg.declare for an imported variable declaration in a block.
This class is used for builtin types like &#39;int&#39;.
Definition: Type.h:2403
void EmitDeclareOfBlockLiteralArgVariable(const CGBlockInfo &block, StringRef Name, unsigned ArgNo, llvm::AllocaInst *LocalAddr, CGBuilderTy &Builder)
Emit call to llvm.dbg.declare for the block-literal argument to a block invocation function...
SourceLocation getLocation() const
Retrieve the source location of the capture.
bool isComplexIntegerType() const
Definition: Type.cpp:487
QualType getIntegerType() const
Return the integer type this enum decl corresponds to.
Definition: Decl.h:3479
StringRef getName() const
Get the name of identifier for this declaration as a StringRef.
Definition: Decl.h:275
bool hasVolatile() const
Definition: Type.h:259
void setLocation(SourceLocation Loc)
Update the current source location.
CGCXXABI & getCXXABI() const
uint64_t Width
Definition: ASTContext.h:143
std::string getQualifiedNameAsString() const
Definition: Decl.cpp:1527
CanQualType IntTy
Definition: ASTContext.h:1024
Abstracts clang modules and precompiled header files and holds everything needed to generate debug in...
unsigned getNumElements() const
Definition: Type.h:3216
QualType getAsType() const
Retrieve the type for a type template argument.
Definition: TemplateBase.h:256
bool isUnion() const
Definition: Decl.h:3251
Represents a type template specialization; the template must be a class template, a type alias templa...
Definition: Type.h:4853
const internal::VariadicDynCastAllOfMatcher< Decl, BlockDecl > blockDecl
Matches block declarations.
static bool isClassOrMethodDLLImport(const CXXRecordDecl *RD)
Return true if the class or any of its methods are marked dllimport.
TemplatedKind getTemplatedKind() const
What kind of templated function this is.
Definition: Decl.cpp:3333
capture_const_iterator captures_begin() const
Definition: DeclCXX.h:1251
bool isStaticDataMember() const
Determines whether this is a static data member.
Definition: Decl.h:1134
QualType getType() const
Definition: Decl.h:647
static InputKind getInputKindForExtension(StringRef Extension)
getInputKindForExtension - Return the appropriate input kind for a file extension.
A wrapper class around a pointer that always points to its canonical declaration. ...
Definition: Redeclarable.h:347
FunctionDecl * getCanonicalDecl() override
Retrieves the "canonical" declaration of the given declaration.
Definition: Decl.cpp:2996
ObjCIvarDecl * all_declared_ivar_begin()
all_declared_ivar_begin - return first ivar declared in this class, its extensions and its implementa...
Definition: DeclObjC.cpp:1591
Represents a C++ namespace alias.
Definition: DeclCXX.h:3027
TemplateName getAsTemplate() const
Retrieve the template name for a template name argument.
Definition: TemplateBase.h:280
APSInt & getInt()
Definition: APValue.h:257
static bool isDefinedInClangModule(const RecordDecl *RD)
Does a type definition exist in an imported clang module?
Represents C++ using-directive.
Definition: DeclCXX.h:2923
void removeAddressSpace()
Definition: Type.h:378
bool isObjCZeroArgSelector() const
base_class_range vbases()
Definition: DeclCXX.h:839
This class handles loading and caching of source files into memory.
SourceLocation getLocation() const
Definition: DeclBase.h:421
QualType getPointeeType() const
Definition: Type.h:2788
Represents a shadow declaration introduced into a scope by a (resolved) using declaration.
Definition: DeclCXX.h:3146
bool isExternallyVisible() const
Definition: Decl.h:379
Structure with information about how a bitfield should be accessed.
NamedDecl * getAliasedNamespace() const
Retrieve the namespace that this alias refers to, which may either be a NamespaceDecl or a NamespaceA...
Definition: DeclCXX.h:3123
QualType getPointeeType() const
Gets the type pointed to by this ObjC pointer.
Definition: Type.h:5822
method_range methods() const
Definition: DeclCXX.h:864