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