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