1//===- Decl.cpp - Declaration AST Node Implementation ---------------------===//
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 file implements the Decl subclasses.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/Decl.h"
14#include "Linkage.h"
15#include "clang/AST/ASTContext.h"
16#include "clang/AST/ASTDiagnostic.h"
17#include "clang/AST/ASTLambda.h"
18#include "clang/AST/ASTMutationListener.h"
19#include "clang/AST/Attr.h"
20#include "clang/AST/CanonicalType.h"
21#include "clang/AST/DeclBase.h"
22#include "clang/AST/DeclCXX.h"
23#include "clang/AST/DeclObjC.h"
24#include "clang/AST/DeclTemplate.h"
25#include "clang/AST/DeclarationName.h"
26#include "clang/AST/Expr.h"
27#include "clang/AST/ExprCXX.h"
28#include "clang/AST/ExternalASTSource.h"
29#include "clang/AST/ODRHash.h"
30#include "clang/AST/PrettyDeclStackTrace.h"
31#include "clang/AST/PrettyPrinter.h"
32#include "clang/AST/Randstruct.h"
33#include "clang/AST/RecordLayout.h"
34#include "clang/AST/Redeclarable.h"
35#include "clang/AST/Stmt.h"
36#include "clang/AST/TemplateBase.h"
37#include "clang/AST/Type.h"
38#include "clang/AST/TypeLoc.h"
39#include "clang/Basic/Builtins.h"
40#include "clang/Basic/IdentifierTable.h"
41#include "clang/Basic/LLVM.h"
42#include "clang/Basic/LangOptions.h"
43#include "clang/Basic/Linkage.h"
44#include "clang/Basic/Module.h"
45#include "clang/Basic/NoSanitizeList.h"
46#include "clang/Basic/PartialDiagnostic.h"
47#include "clang/Basic/Sanitizers.h"
48#include "clang/Basic/SourceLocation.h"
49#include "clang/Basic/SourceManager.h"
50#include "clang/Basic/Specifiers.h"
51#include "clang/Basic/TargetCXXABI.h"
52#include "clang/Basic/TargetInfo.h"
53#include "clang/Basic/Visibility.h"
54#include "llvm/ADT/APSInt.h"
55#include "llvm/ADT/ArrayRef.h"
56#include "llvm/ADT/STLExtras.h"
57#include "llvm/ADT/SmallVector.h"
58#include "llvm/ADT/StringRef.h"
59#include "llvm/ADT/StringSwitch.h"
60#include "llvm/ADT/iterator_range.h"
61#include "llvm/Support/Casting.h"
62#include "llvm/Support/ErrorHandling.h"
63#include "llvm/Support/raw_ostream.h"
64#include "llvm/TargetParser/Triple.h"
65#include <algorithm>
66#include <cassert>
67#include <cstddef>
68#include <cstring>
69#include <optional>
70#include <string>
71#include <tuple>
72#include <type_traits>
73
74using namespace clang;
75
76Decl *clang::getPrimaryMergedDecl(Decl *D) {
77 return D->getASTContext().getPrimaryMergedDecl(D);
78}
79
80void PrettyDeclStackTraceEntry::print(raw_ostream &OS) const {
81 SourceLocation Loc = this->Loc;
82 if (!Loc.isValid() && TheDecl) Loc = TheDecl->getLocation();
83 if (Loc.isValid()) {
84 Loc.print(OS, SM: Context.getSourceManager());
85 OS << ": ";
86 }
87 OS << Message;
88
89 if (auto *ND = dyn_cast_if_present<NamedDecl>(Val: TheDecl)) {
90 OS << " '";
91 ND->getNameForDiagnostic(OS, Policy: Context.getPrintingPolicy(), Qualified: true);
92 OS << "'";
93 }
94
95 OS << '\n';
96}
97
98// Defined here so that it can be inlined into its direct callers.
99bool Decl::isOutOfLine() const {
100 return !getLexicalDeclContext()->Equals(DC: getDeclContext());
101}
102
103TranslationUnitDecl::TranslationUnitDecl(ASTContext &ctx)
104 : Decl(TranslationUnit, nullptr, SourceLocation()),
105 DeclContext(TranslationUnit), redeclarable_base(ctx), Ctx(ctx) {}
106
107//===----------------------------------------------------------------------===//
108// NamedDecl Implementation
109//===----------------------------------------------------------------------===//
110
111// Visibility rules aren't rigorously externally specified, but here
112// are the basic principles behind what we implement:
113//
114// 1. An explicit visibility attribute is generally a direct expression
115// of the user's intent and should be honored. Only the innermost
116// visibility attribute applies. If no visibility attribute applies,
117// global visibility settings are considered.
118//
119// 2. There is one caveat to the above: on or in a template pattern,
120// an explicit visibility attribute is just a default rule, and
121// visibility can be decreased by the visibility of template
122// arguments. But this, too, has an exception: an attribute on an
123// explicit specialization or instantiation causes all the visibility
124// restrictions of the template arguments to be ignored.
125//
126// 3. A variable that does not otherwise have explicit visibility can
127// be restricted by the visibility of its type.
128//
129// 4. A visibility restriction is explicit if it comes from an
130// attribute (or something like it), not a global visibility setting.
131// When emitting a reference to an external symbol, visibility
132// restrictions are ignored unless they are explicit.
133//
134// 5. When computing the visibility of a non-type, including a
135// non-type member of a class, only non-type visibility restrictions
136// are considered: the 'visibility' attribute, global value-visibility
137// settings, and a few special cases like __private_extern.
138//
139// 6. When computing the visibility of a type, including a type member
140// of a class, only type visibility restrictions are considered:
141// the 'type_visibility' attribute and global type-visibility settings.
142// However, a 'visibility' attribute counts as a 'type_visibility'
143// attribute on any declaration that only has the former.
144//
145// The visibility of a "secondary" entity, like a template argument,
146// is computed using the kind of that entity, not the kind of the
147// primary entity for which we are computing visibility. For example,
148// the visibility of a specialization of either of these templates:
149// template <class T, bool (&compare)(T, X)> bool has_match(list<T>, X);
150// template <class T, bool (&compare)(T, X)> class matcher;
151// is restricted according to the type visibility of the argument 'T',
152// the type visibility of 'bool(&)(T,X)', and the value visibility of
153// the argument function 'compare'. That 'has_match' is a value
154// and 'matcher' is a type only matters when looking for attributes
155// and settings from the immediate context.
156
157/// Does this computation kind permit us to consider additional
158/// visibility settings from attributes and the like?
159static bool hasExplicitVisibilityAlready(LVComputationKind computation) {
160 return computation.IgnoreExplicitVisibility;
161}
162
163/// Given an LVComputationKind, return one of the same type/value sort
164/// that records that it already has explicit visibility.
165static LVComputationKind
166withExplicitVisibilityAlready(LVComputationKind Kind) {
167 Kind.IgnoreExplicitVisibility = true;
168 return Kind;
169}
170
171static std::optional<Visibility> getExplicitVisibility(const NamedDecl *D,
172 LVComputationKind kind) {
173 assert(!kind.IgnoreExplicitVisibility &&
174 "asking for explicit visibility when we shouldn't be");
175 return D->getExplicitVisibility(kind: kind.getExplicitVisibilityKind());
176}
177
178/// Is the given declaration a "type" or a "value" for the purposes of
179/// visibility computation?
180static bool usesTypeVisibility(const NamedDecl *D) {
181 return isa<TypeDecl>(Val: D) ||
182 isa<ClassTemplateDecl>(Val: D) ||
183 isa<ObjCInterfaceDecl>(Val: D);
184}
185
186/// Does the given declaration have member specialization information,
187/// and if so, is it an explicit specialization?
188template <class T>
189static std::enable_if_t<!std::is_base_of_v<RedeclarableTemplateDecl, T>, bool>
190isExplicitMemberSpecialization(const T *D) {
191 if (const MemberSpecializationInfo *member =
192 D->getMemberSpecializationInfo()) {
193 return member->isExplicitSpecialization();
194 }
195 return false;
196}
197
198/// For templates, this question is easier: a member template can't be
199/// explicitly instantiated, so there's a single bit indicating whether
200/// or not this is an explicit member specialization.
201static bool isExplicitMemberSpecialization(const RedeclarableTemplateDecl *D) {
202 return D->isMemberSpecialization();
203}
204
205/// Given a visibility attribute, return the explicit visibility
206/// associated with it.
207template <class T>
208static Visibility getVisibilityFromAttr(const T *attr) {
209 switch (attr->getVisibility()) {
210 case T::Default:
211 return DefaultVisibility;
212 case T::Hidden:
213 return HiddenVisibility;
214 case T::Protected:
215 return ProtectedVisibility;
216 }
217 llvm_unreachable("bad visibility kind");
218}
219
220/// Return the explicit visibility of the given declaration.
221static std::optional<Visibility>
222getVisibilityOf(const NamedDecl *D, NamedDecl::ExplicitVisibilityKind kind) {
223 // If we're ultimately computing the visibility of a type, look for
224 // a 'type_visibility' attribute before looking for 'visibility'.
225 if (kind == NamedDecl::VisibilityForType) {
226 if (const auto *A = D->getAttr<TypeVisibilityAttr>()) {
227 return getVisibilityFromAttr(attr: A);
228 }
229 }
230
231 // If this declaration has an explicit visibility attribute, use it.
232 if (const auto *A = D->getAttr<VisibilityAttr>()) {
233 return getVisibilityFromAttr(attr: A);
234 }
235
236 return std::nullopt;
237}
238
239LinkageInfo LinkageComputer::getLVForType(const Type &T,
240 LVComputationKind computation) {
241 if (computation.IgnoreAllVisibility)
242 return LinkageInfo(T.getLinkage(), DefaultVisibility, true);
243 return getTypeLinkageAndVisibility(T: &T);
244}
245
246/// Get the most restrictive linkage for the types in the given
247/// template parameter list. For visibility purposes, template
248/// parameters are part of the signature of a template.
249LinkageInfo LinkageComputer::getLVForTemplateParameterList(
250 const TemplateParameterList *Params, LVComputationKind computation) {
251 LinkageInfo LV;
252 for (const NamedDecl *P : *Params) {
253 // Template type parameters are the most common and never
254 // contribute to visibility, pack or not.
255 if (isa<TemplateTypeParmDecl>(Val: P))
256 continue;
257
258 // Non-type template parameters can be restricted by the value type, e.g.
259 // template <enum X> class A { ... };
260 // We have to be careful here, though, because we can be dealing with
261 // dependent types.
262 if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Val: P)) {
263 // Handle the non-pack case first.
264 if (!NTTP->isExpandedParameterPack()) {
265 if (!NTTP->getType()->isDependentType()) {
266 LV.merge(other: getLVForType(T: *NTTP->getType(), computation));
267 }
268 continue;
269 }
270
271 // Look at all the types in an expanded pack.
272 for (unsigned i = 0, n = NTTP->getNumExpansionTypes(); i != n; ++i) {
273 QualType type = NTTP->getExpansionType(I: i);
274 if (!type->isDependentType())
275 LV.merge(other: getTypeLinkageAndVisibility(T: type));
276 }
277 continue;
278 }
279
280 // Template template parameters can be restricted by their
281 // template parameters, recursively.
282 const auto *TTP = cast<TemplateTemplateParmDecl>(Val: P);
283
284 // Handle the non-pack case first.
285 if (!TTP->isExpandedParameterPack()) {
286 LV.merge(other: getLVForTemplateParameterList(Params: TTP->getTemplateParameters(),
287 computation));
288 continue;
289 }
290
291 // Look at all expansions in an expanded pack.
292 for (unsigned i = 0, n = TTP->getNumExpansionTemplateParameters();
293 i != n; ++i) {
294 LV.merge(other: getLVForTemplateParameterList(
295 Params: TTP->getExpansionTemplateParameters(I: i), computation));
296 }
297 }
298
299 return LV;
300}
301
302static const Decl *getOutermostFuncOrBlockContext(const Decl *D) {
303 const Decl *Ret = nullptr;
304 const DeclContext *DC = D->getDeclContext();
305 while (DC->getDeclKind() != Decl::TranslationUnit) {
306 if (isa<FunctionDecl>(Val: DC) || isa<BlockDecl>(Val: DC))
307 Ret = cast<Decl>(Val: DC);
308 DC = DC->getParent();
309 }
310 return Ret;
311}
312
313/// Get the most restrictive linkage for the types and
314/// declarations in the given template argument list.
315///
316/// Note that we don't take an LVComputationKind because we always
317/// want to honor the visibility of template arguments in the same way.
318LinkageInfo
319LinkageComputer::getLVForTemplateArgumentList(ArrayRef<TemplateArgument> Args,
320 LVComputationKind computation) {
321 LinkageInfo LV;
322
323 for (const TemplateArgument &Arg : Args) {
324 switch (Arg.getKind()) {
325 case TemplateArgument::Null:
326 case TemplateArgument::Integral:
327 case TemplateArgument::Expression:
328 continue;
329
330 case TemplateArgument::Type:
331 LV.merge(other: getLVForType(T: *Arg.getAsType(), computation));
332 continue;
333
334 case TemplateArgument::Declaration: {
335 const NamedDecl *ND = Arg.getAsDecl();
336 assert(!usesTypeVisibility(ND));
337 LV.merge(other: getLVForDecl(D: ND, computation));
338 continue;
339 }
340
341 case TemplateArgument::NullPtr:
342 LV.merge(other: getTypeLinkageAndVisibility(T: Arg.getNullPtrType()));
343 continue;
344
345 case TemplateArgument::StructuralValue:
346 LV.merge(other: getLVForValue(V: Arg.getAsStructuralValue(), computation));
347 continue;
348
349 case TemplateArgument::Template:
350 case TemplateArgument::TemplateExpansion:
351 if (TemplateDecl *Template =
352 Arg.getAsTemplateOrTemplatePattern().getAsTemplateDecl(
353 /*IgnoreDeduced=*/true))
354 LV.merge(other: getLVForDecl(D: Template, computation));
355 continue;
356
357 case TemplateArgument::Pack:
358 LV.merge(other: getLVForTemplateArgumentList(Args: Arg.getPackAsArray(), computation));
359 continue;
360 }
361 llvm_unreachable("bad template argument kind");
362 }
363
364 return LV;
365}
366
367LinkageInfo
368LinkageComputer::getLVForTemplateArgumentList(const TemplateArgumentList &TArgs,
369 LVComputationKind computation) {
370 return getLVForTemplateArgumentList(Args: TArgs.asArray(), computation);
371}
372
373static bool shouldConsiderTemplateVisibility(const FunctionDecl *fn,
374 const FunctionTemplateSpecializationInfo *specInfo) {
375 // Include visibility from the template parameters and arguments
376 // only if this is not an explicit instantiation or specialization
377 // with direct explicit visibility. (Implicit instantiations won't
378 // have a direct attribute.)
379 if (!specInfo->isExplicitInstantiationOrSpecialization())
380 return true;
381
382 return !fn->hasAttr<VisibilityAttr>();
383}
384
385/// Merge in template-related linkage and visibility for the given
386/// function template specialization.
387///
388/// We don't need a computation kind here because we can assume
389/// LVForValue.
390///
391/// \param[out] LV the computation to use for the parent
392void LinkageComputer::mergeTemplateLV(
393 LinkageInfo &LV, const FunctionDecl *fn,
394 const FunctionTemplateSpecializationInfo *specInfo,
395 LVComputationKind computation) {
396 bool considerVisibility =
397 shouldConsiderTemplateVisibility(fn, specInfo);
398
399 FunctionTemplateDecl *temp = specInfo->getTemplate();
400 // Merge information from the template declaration.
401 LinkageInfo tempLV = getLVForDecl(D: temp, computation);
402 // The linkage and visibility of the specialization should be
403 // consistent with the template declaration.
404 LV.mergeMaybeWithVisibility(other: tempLV, withVis: considerVisibility);
405
406 // Merge information from the template parameters.
407 LinkageInfo paramsLV =
408 getLVForTemplateParameterList(Params: temp->getTemplateParameters(), computation);
409 LV.mergeMaybeWithVisibility(other: paramsLV, withVis: considerVisibility);
410
411 // Merge information from the template arguments.
412 const TemplateArgumentList &templateArgs = *specInfo->TemplateArguments;
413 LinkageInfo argsLV = getLVForTemplateArgumentList(TArgs: templateArgs, computation);
414 LV.mergeMaybeWithVisibility(other: argsLV, withVis: considerVisibility);
415}
416
417/// Does the given declaration have a direct visibility attribute
418/// that would match the given rules?
419static bool hasDirectVisibilityAttribute(const NamedDecl *D,
420 LVComputationKind computation) {
421 if (computation.IgnoreAllVisibility)
422 return false;
423
424 return (computation.isTypeVisibility() && D->hasAttr<TypeVisibilityAttr>()) ||
425 D->hasAttr<VisibilityAttr>();
426}
427
428/// Should we consider visibility associated with the template
429/// arguments and parameters of the given class template specialization?
430static bool shouldConsiderTemplateVisibility(
431 const ClassTemplateSpecializationDecl *spec,
432 LVComputationKind computation) {
433 // Include visibility from the template parameters and arguments
434 // only if this is not an explicit instantiation or specialization
435 // with direct explicit visibility (and note that implicit
436 // instantiations won't have a direct attribute).
437 //
438 // Furthermore, we want to ignore template parameters and arguments
439 // for an explicit specialization when computing the visibility of a
440 // member thereof with explicit visibility.
441 //
442 // This is a bit complex; let's unpack it.
443 //
444 // An explicit class specialization is an independent, top-level
445 // declaration. As such, if it or any of its members has an
446 // explicit visibility attribute, that must directly express the
447 // user's intent, and we should honor it. The same logic applies to
448 // an explicit instantiation of a member of such a thing.
449
450 // Fast path: if this is not an explicit instantiation or
451 // specialization, we always want to consider template-related
452 // visibility restrictions.
453 if (!spec->isExplicitInstantiationOrSpecialization())
454 return true;
455
456 // This is the 'member thereof' check.
457 if (spec->isExplicitSpecialization() &&
458 hasExplicitVisibilityAlready(computation))
459 return false;
460
461 return !hasDirectVisibilityAttribute(D: spec, computation);
462}
463
464/// Merge in template-related linkage and visibility for the given
465/// class template specialization.
466void LinkageComputer::mergeTemplateLV(
467 LinkageInfo &LV, const ClassTemplateSpecializationDecl *spec,
468 LVComputationKind computation) {
469 bool considerVisibility = shouldConsiderTemplateVisibility(spec, computation);
470
471 // Merge information from the template parameters, but ignore
472 // visibility if we're only considering template arguments.
473 ClassTemplateDecl *temp = spec->getSpecializedTemplate();
474 // Merge information from the template declaration.
475 LinkageInfo tempLV = getLVForDecl(D: temp, computation);
476 // The linkage of the specialization should be consistent with the
477 // template declaration.
478 LV.setLinkage(tempLV.getLinkage());
479
480 LinkageInfo paramsLV =
481 getLVForTemplateParameterList(Params: temp->getTemplateParameters(), computation);
482 LV.mergeMaybeWithVisibility(other: paramsLV,
483 withVis: considerVisibility && !hasExplicitVisibilityAlready(computation));
484
485 // Merge information from the template arguments. We ignore
486 // template-argument visibility if we've got an explicit
487 // instantiation with a visibility attribute.
488 const TemplateArgumentList &templateArgs = spec->getTemplateArgs();
489 LinkageInfo argsLV = getLVForTemplateArgumentList(TArgs: templateArgs, computation);
490 if (considerVisibility)
491 LV.mergeVisibility(other: argsLV);
492 LV.mergeExternalVisibility(Other: argsLV);
493}
494
495/// Should we consider visibility associated with the template
496/// arguments and parameters of the given variable template
497/// specialization? As usual, follow class template specialization
498/// logic up to initialization.
499static bool shouldConsiderTemplateVisibility(
500 const VarTemplateSpecializationDecl *spec,
501 LVComputationKind computation) {
502 // Include visibility from the template parameters and arguments
503 // only if this is not an explicit instantiation or specialization
504 // with direct explicit visibility (and note that implicit
505 // instantiations won't have a direct attribute).
506 if (!spec->isExplicitInstantiationOrSpecialization())
507 return true;
508
509 // An explicit variable specialization is an independent, top-level
510 // declaration. As such, if it has an explicit visibility attribute,
511 // that must directly express the user's intent, and we should honor
512 // it.
513 if (spec->isExplicitSpecialization() &&
514 hasExplicitVisibilityAlready(computation))
515 return false;
516
517 return !hasDirectVisibilityAttribute(D: spec, computation);
518}
519
520/// Merge in template-related linkage and visibility for the given
521/// variable template specialization. As usual, follow class template
522/// specialization logic up to initialization.
523void LinkageComputer::mergeTemplateLV(LinkageInfo &LV,
524 const VarTemplateSpecializationDecl *spec,
525 LVComputationKind computation) {
526 bool considerVisibility = shouldConsiderTemplateVisibility(spec, computation);
527
528 // Merge information from the template parameters, but ignore
529 // visibility if we're only considering template arguments.
530 VarTemplateDecl *temp = spec->getSpecializedTemplate();
531 LinkageInfo tempLV =
532 getLVForTemplateParameterList(Params: temp->getTemplateParameters(), computation);
533 LV.mergeMaybeWithVisibility(other: tempLV,
534 withVis: considerVisibility && !hasExplicitVisibilityAlready(computation));
535
536 // Merge information from the template arguments. We ignore
537 // template-argument visibility if we've got an explicit
538 // instantiation with a visibility attribute.
539 const TemplateArgumentList &templateArgs = spec->getTemplateArgs();
540 LinkageInfo argsLV = getLVForTemplateArgumentList(TArgs: templateArgs, computation);
541 if (considerVisibility)
542 LV.mergeVisibility(other: argsLV);
543 LV.mergeExternalVisibility(Other: argsLV);
544}
545
546static bool useInlineVisibilityHidden(const NamedDecl *D) {
547 // FIXME: we should warn if -fvisibility-inlines-hidden is used with c.
548 const LangOptions &Opts = D->getASTContext().getLangOpts();
549 if (!Opts.CPlusPlus || !Opts.InlineVisibilityHidden)
550 return false;
551
552 const auto *FD = dyn_cast<FunctionDecl>(Val: D);
553 if (!FD)
554 return false;
555
556 TemplateSpecializationKind TSK = TSK_Undeclared;
557 if (FunctionTemplateSpecializationInfo *spec
558 = FD->getTemplateSpecializationInfo()) {
559 TSK = spec->getTemplateSpecializationKind();
560 } else if (MemberSpecializationInfo *MSI =
561 FD->getMemberSpecializationInfo()) {
562 TSK = MSI->getTemplateSpecializationKind();
563 }
564
565 const FunctionDecl *Def = nullptr;
566 // InlineVisibilityHidden only applies to definitions, and
567 // isInlined() only gives meaningful answers on definitions
568 // anyway.
569 return TSK != TSK_ExplicitInstantiationDeclaration &&
570 TSK != TSK_ExplicitInstantiationDefinition &&
571 FD->hasBody(Definition&: Def) && Def->isInlined() && !Def->hasAttr<GNUInlineAttr>();
572}
573
574template <typename T> static bool isFirstInExternCContext(T *D) {
575 const T *First = D->getFirstDecl();
576 return First->isInExternCContext();
577}
578
579static bool isSingleLineLanguageLinkage(const Decl &D) {
580 if (const auto *SD = dyn_cast<LinkageSpecDecl>(Val: D.getDeclContext()))
581 if (!SD->hasBraces())
582 return true;
583 return false;
584}
585
586static LinkageInfo getExternalLinkageFor(const NamedDecl *D) {
587 return LinkageInfo::external();
588}
589
590static StorageClass getStorageClass(const Decl *D) {
591 if (auto *TD = dyn_cast<TemplateDecl>(Val: D))
592 D = TD->getTemplatedDecl();
593 if (D) {
594 if (auto *VD = dyn_cast<VarDecl>(Val: D))
595 return VD->getStorageClass();
596 if (auto *FD = dyn_cast<FunctionDecl>(Val: D))
597 return FD->getStorageClass();
598 }
599 return SC_None;
600}
601
602LinkageInfo
603LinkageComputer::getLVForNamespaceScopeDecl(const NamedDecl *D,
604 LVComputationKind computation,
605 bool IgnoreVarTypeLinkage) {
606 assert(D->getDeclContext()->getRedeclContext()->isFileContext() &&
607 "Not a name having namespace scope");
608 ASTContext &Context = D->getASTContext();
609 const auto *Var = dyn_cast<VarDecl>(Val: D);
610
611 // C++ [basic.link]p3:
612 // A name having namespace scope (3.3.6) has internal linkage if it
613 // is the name of
614
615 if ((getStorageClass(D: D->getCanonicalDecl()) == SC_Static) ||
616 (Context.getLangOpts().C23 && Var && Var->isConstexpr())) {
617 // - a variable, variable template, function, or function template
618 // that is explicitly declared static; or
619 // (This bullet corresponds to C99 6.2.2p3.)
620
621 // C23 6.2.2p3
622 // If the declaration of a file scope identifier for
623 // an object contains any of the storage-class specifiers static or
624 // constexpr then the identifier has internal linkage.
625 return LinkageInfo::internal();
626 }
627
628 if (Var) {
629 // - a non-template variable of non-volatile const-qualified type, unless
630 // - it is explicitly declared extern, or
631 // - it is declared in the purview of a module interface unit
632 // (outside the private-module-fragment, if any) or module partition, or
633 // - it is inline, or
634 // - it was previously declared and the prior declaration did not have
635 // internal linkage
636 // (There is no equivalent in C99.)
637 if (Context.getLangOpts().CPlusPlus && Var->getType().isConstQualified() &&
638 !Var->getType().isVolatileQualified() && !Var->isInline() &&
639 ![Var]() {
640 // Check if it is module purview except private module fragment
641 // and implementation unit.
642 if (auto *M = Var->getOwningModule())
643 return M->isInterfaceOrPartition() || M->isImplicitGlobalModule();
644 return false;
645 }() &&
646 !isa<VarTemplateSpecializationDecl>(Val: Var) &&
647 !Var->getDescribedVarTemplate()) {
648 const VarDecl *PrevVar = Var->getPreviousDecl();
649 if (PrevVar)
650 return getLVForDecl(D: PrevVar, computation);
651
652 if (Var->getStorageClass() != SC_Extern &&
653 Var->getStorageClass() != SC_PrivateExtern &&
654 !isSingleLineLanguageLinkage(D: *Var))
655 return LinkageInfo::internal();
656 }
657
658 for (const VarDecl *PrevVar = Var->getPreviousDecl(); PrevVar;
659 PrevVar = PrevVar->getPreviousDecl()) {
660 if (PrevVar->getStorageClass() == SC_PrivateExtern &&
661 Var->getStorageClass() == SC_None)
662 return getDeclLinkageAndVisibility(D: PrevVar);
663 // Explicitly declared static.
664 if (PrevVar->getStorageClass() == SC_Static)
665 return LinkageInfo::internal();
666 }
667 } else if (const auto *IFD = dyn_cast<IndirectFieldDecl>(Val: D)) {
668 // - a data member of an anonymous union.
669 const VarDecl *VD = IFD->getVarDecl();
670 assert(VD && "Expected a VarDecl in this IndirectFieldDecl!");
671 return getLVForNamespaceScopeDecl(D: VD, computation, IgnoreVarTypeLinkage);
672 }
673 assert(!isa<FieldDecl>(D) && "Didn't expect a FieldDecl!");
674
675 // FIXME: This gives internal linkage to names that should have no linkage
676 // (those not covered by [basic.link]p6).
677 if (D->isInAnonymousNamespace()) {
678 const auto *Var = dyn_cast<VarDecl>(Val: D);
679 const auto *Func = dyn_cast<FunctionDecl>(Val: D);
680 // FIXME: The check for extern "C" here is not justified by the standard
681 // wording, but we retain it from the pre-DR1113 model to avoid breaking
682 // code.
683 //
684 // C++11 [basic.link]p4:
685 // An unnamed namespace or a namespace declared directly or indirectly
686 // within an unnamed namespace has internal linkage.
687 if ((!Var || !isFirstInExternCContext(D: Var)) &&
688 (!Func || !isFirstInExternCContext(D: Func)))
689 return LinkageInfo::internal();
690 }
691
692 // Set up the defaults.
693
694 // C99 6.2.2p5:
695 // If the declaration of an identifier for an object has file
696 // scope and no storage-class specifier, its linkage is
697 // external.
698 LinkageInfo LV = getExternalLinkageFor(D);
699
700 if (!hasExplicitVisibilityAlready(computation)) {
701 if (std::optional<Visibility> Vis = getExplicitVisibility(D, kind: computation)) {
702 LV.mergeVisibility(newVis: *Vis, newExplicit: true);
703 } else {
704 // If we're declared in a namespace with a visibility attribute,
705 // use that namespace's visibility, and it still counts as explicit.
706 for (const DeclContext *DC = D->getDeclContext();
707 !isa<TranslationUnitDecl>(Val: DC);
708 DC = DC->getParent()) {
709 const auto *ND = dyn_cast<NamespaceDecl>(Val: DC);
710 if (!ND) continue;
711 if (std::optional<Visibility> Vis =
712 getExplicitVisibility(D: ND, kind: computation)) {
713 LV.mergeVisibility(newVis: *Vis, newExplicit: true);
714 break;
715 }
716 }
717 }
718
719 // Add in global settings if the above didn't give us direct visibility.
720 if (!LV.isVisibilityExplicit()) {
721 // Use global type/value visibility as appropriate.
722 Visibility globalVisibility =
723 computation.isValueVisibility()
724 ? Context.getLangOpts().getValueVisibilityMode()
725 : Context.getLangOpts().getTypeVisibilityMode();
726 LV.mergeVisibility(newVis: globalVisibility, /*explicit*/ newExplicit: false);
727
728 // If we're paying attention to global visibility, apply
729 // -finline-visibility-hidden if this is an inline method.
730 if (useInlineVisibilityHidden(D))
731 LV.mergeVisibility(newVis: HiddenVisibility, /*visibilityExplicit=*/newExplicit: false);
732 }
733 }
734
735 // C++ [basic.link]p4:
736
737 // A name having namespace scope that has not been given internal linkage
738 // above and that is the name of
739 // [...bullets...]
740 // has its linkage determined as follows:
741 // - if the enclosing namespace has internal linkage, the name has
742 // internal linkage; [handled above]
743 // - otherwise, if the declaration of the name is attached to a named
744 // module and is not exported, the name has module linkage;
745 // - otherwise, the name has external linkage.
746 // LV is currently set up to handle the last two bullets.
747 //
748 // The bullets are:
749
750 // - a variable; or
751 if (const auto *Var = dyn_cast<VarDecl>(Val: D)) {
752 // GCC applies the following optimization to variables and static
753 // data members, but not to functions:
754 //
755 // Modify the variable's LV by the LV of its type unless this is
756 // C or extern "C". This follows from [basic.link]p9:
757 // A type without linkage shall not be used as the type of a
758 // variable or function with external linkage unless
759 // - the entity has C language linkage, or
760 // - the entity is declared within an unnamed namespace, or
761 // - the entity is not used or is defined in the same
762 // translation unit.
763 // and [basic.link]p10:
764 // ...the types specified by all declarations referring to a
765 // given variable or function shall be identical...
766 // C does not have an equivalent rule.
767 //
768 // Ignore this if we've got an explicit attribute; the user
769 // probably knows what they're doing.
770 //
771 // Note that we don't want to make the variable non-external
772 // because of this, but unique-external linkage suits us.
773
774 if (Context.getLangOpts().CPlusPlus && !isFirstInExternCContext(D: Var) &&
775 !IgnoreVarTypeLinkage) {
776 LinkageInfo TypeLV = getLVForType(T: *Var->getType(), computation);
777 if (!isExternallyVisible(L: TypeLV.getLinkage()))
778 return LinkageInfo::uniqueExternal();
779 if (!LV.isVisibilityExplicit())
780 LV.mergeVisibility(other: TypeLV);
781 }
782
783 if (Var->getStorageClass() == SC_PrivateExtern)
784 LV.mergeVisibility(newVis: HiddenVisibility, newExplicit: true);
785
786 // Note that Sema::MergeVarDecl already takes care of implementing
787 // C99 6.2.2p4 and propagating the visibility attribute, so we don't have
788 // to do it here.
789
790 // As per function and class template specializations (below),
791 // consider LV for the template and template arguments. We're at file
792 // scope, so we do not need to worry about nested specializations.
793 if (const auto *spec = dyn_cast<VarTemplateSpecializationDecl>(Val: Var)) {
794 mergeTemplateLV(LV, spec, computation);
795 }
796
797 // - a function; or
798 } else if (const auto *Function = dyn_cast<FunctionDecl>(Val: D)) {
799 // In theory, we can modify the function's LV by the LV of its
800 // type unless it has C linkage (see comment above about variables
801 // for justification). In practice, GCC doesn't do this, so it's
802 // just too painful to make work.
803
804 if (Function->getStorageClass() == SC_PrivateExtern)
805 LV.mergeVisibility(newVis: HiddenVisibility, newExplicit: true);
806
807 // OpenMP target declare device functions are not callable from the host so
808 // they should not be exported from the device image. This applies to all
809 // functions as the host-callable kernel functions are emitted at codegen.
810 if (Context.getLangOpts().OpenMP &&
811 Context.getLangOpts().OpenMPIsTargetDevice &&
812 (Context.getTargetInfo().getTriple().isGPU() ||
813 OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD: Function)))
814 LV.mergeVisibility(newVis: HiddenVisibility, /*newExplicit=*/false);
815
816 // Note that Sema::MergeCompatibleFunctionDecls already takes care of
817 // merging storage classes and visibility attributes, so we don't have to
818 // look at previous decls in here.
819
820 // In C++, then if the type of the function uses a type with
821 // unique-external linkage, it's not legally usable from outside
822 // this translation unit. However, we should use the C linkage
823 // rules instead for extern "C" declarations.
824 if (Context.getLangOpts().CPlusPlus && !isFirstInExternCContext(D: Function)) {
825 // Only look at the type-as-written. Otherwise, deducing the return type
826 // of a function could change its linkage.
827 QualType TypeAsWritten = Function->getType();
828 if (TypeSourceInfo *TSI = Function->getTypeSourceInfo())
829 TypeAsWritten = TSI->getType();
830 if (!isExternallyVisible(L: TypeAsWritten->getLinkage()))
831 return LinkageInfo::uniqueExternal();
832 }
833
834 // Consider LV from the template and the template arguments.
835 // We're at file scope, so we do not need to worry about nested
836 // specializations.
837 if (FunctionTemplateSpecializationInfo *specInfo
838 = Function->getTemplateSpecializationInfo()) {
839 mergeTemplateLV(LV, fn: Function, specInfo, computation);
840 }
841
842 // - a named class (Clause 9), or an unnamed class defined in a
843 // typedef declaration in which the class has the typedef name
844 // for linkage purposes (7.1.3); or
845 // - a named enumeration (7.2), or an unnamed enumeration
846 // defined in a typedef declaration in which the enumeration
847 // has the typedef name for linkage purposes (7.1.3); or
848 } else if (const auto *Tag = dyn_cast<TagDecl>(Val: D)) {
849 // Unnamed tags have no linkage.
850 if (!Tag->hasNameForLinkage())
851 return LinkageInfo::none();
852
853 // If this is a class template specialization, consider the
854 // linkage of the template and template arguments. We're at file
855 // scope, so we do not need to worry about nested specializations.
856 if (const auto *spec = dyn_cast<ClassTemplateSpecializationDecl>(Val: Tag)) {
857 mergeTemplateLV(LV, spec, computation);
858 }
859
860 // FIXME: This is not part of the C++ standard any more.
861 // - an enumerator belonging to an enumeration with external linkage; or
862 } else if (isa<EnumConstantDecl>(Val: D)) {
863 LinkageInfo EnumLV = getLVForDecl(D: cast<NamedDecl>(Val: D->getDeclContext()),
864 computation);
865 if (!isExternalFormalLinkage(L: EnumLV.getLinkage()))
866 return LinkageInfo::none();
867 LV.merge(other: EnumLV);
868
869 // - a template
870 } else if (const auto *temp = dyn_cast<TemplateDecl>(Val: D)) {
871 bool considerVisibility = !hasExplicitVisibilityAlready(computation);
872 LinkageInfo tempLV =
873 getLVForTemplateParameterList(Params: temp->getTemplateParameters(), computation);
874 LV.mergeMaybeWithVisibility(other: tempLV, withVis: considerVisibility);
875
876 // An unnamed namespace or a namespace declared directly or indirectly
877 // within an unnamed namespace has internal linkage. All other namespaces
878 // have external linkage.
879 //
880 // We handled names in anonymous namespaces above.
881 } else if (isa<NamespaceDecl>(Val: D)) {
882 return LV;
883
884 // By extension, we assign external linkage to Objective-C
885 // interfaces.
886 } else if (isa<ObjCInterfaceDecl>(Val: D)) {
887 // fallout
888
889 } else if (auto *TD = dyn_cast<TypedefNameDecl>(Val: D)) {
890 // A typedef declaration has linkage if it gives a type a name for
891 // linkage purposes.
892 if (!TD->getAnonDeclWithTypedefName(/*AnyRedecl*/true))
893 return LinkageInfo::none();
894
895 } else if (isa<MSGuidDecl>(Val: D)) {
896 // A GUID behaves like an inline variable with external linkage. Fall
897 // through.
898
899 // Everything not covered here has no linkage.
900 } else {
901 return LinkageInfo::none();
902 }
903
904 // If we ended up with non-externally-visible linkage, visibility should
905 // always be default.
906 if (!isExternallyVisible(L: LV.getLinkage()))
907 return LinkageInfo(LV.getLinkage(), DefaultVisibility, false);
908
909 return LV;
910}
911
912LinkageInfo
913LinkageComputer::getLVForClassMember(const NamedDecl *D,
914 LVComputationKind computation,
915 bool IgnoreVarTypeLinkage) {
916 // Only certain class members have linkage. Note that fields don't
917 // really have linkage, but it's convenient to say they do for the
918 // purposes of calculating linkage of pointer-to-data-member
919 // template arguments.
920 //
921 // Templates also don't officially have linkage, but since we ignore
922 // the C++ standard and look at template arguments when determining
923 // linkage and visibility of a template specialization, we might hit
924 // a template template argument that way. If we do, we need to
925 // consider its linkage.
926 if (!(isa<CXXMethodDecl>(Val: D) ||
927 isa<VarDecl>(Val: D) ||
928 isa<FieldDecl>(Val: D) ||
929 isa<IndirectFieldDecl>(Val: D) ||
930 isa<TagDecl>(Val: D) ||
931 isa<TemplateDecl>(Val: D)))
932 return LinkageInfo::none();
933
934 LinkageInfo LV;
935
936 // If we have an explicit visibility attribute, merge that in.
937 if (!hasExplicitVisibilityAlready(computation)) {
938 if (std::optional<Visibility> Vis = getExplicitVisibility(D, kind: computation))
939 LV.mergeVisibility(newVis: *Vis, newExplicit: true);
940 // If we're paying attention to global visibility, apply
941 // -finline-visibility-hidden if this is an inline method.
942 //
943 // Note that we do this before merging information about
944 // the class visibility.
945 if (!LV.isVisibilityExplicit() && useInlineVisibilityHidden(D))
946 LV.mergeVisibility(newVis: HiddenVisibility, /*visibilityExplicit=*/newExplicit: false);
947 }
948
949 // If this class member has an explicit visibility attribute, the only
950 // thing that can change its visibility is the template arguments, so
951 // only look for them when processing the class.
952 LVComputationKind classComputation = computation;
953 if (LV.isVisibilityExplicit())
954 classComputation = withExplicitVisibilityAlready(Kind: computation);
955
956 LinkageInfo classLV =
957 getLVForDecl(D: cast<RecordDecl>(Val: D->getDeclContext()), computation: classComputation);
958 // The member has the same linkage as the class. If that's not externally
959 // visible, we don't need to compute anything about the linkage.
960 // FIXME: If we're only computing linkage, can we bail out here?
961 if (!isExternallyVisible(L: classLV.getLinkage()))
962 return classLV;
963
964
965 // Otherwise, don't merge in classLV yet, because in certain cases
966 // we need to completely ignore the visibility from it.
967
968 // Specifically, if this decl exists and has an explicit attribute.
969 const NamedDecl *explicitSpecSuppressor = nullptr;
970
971 if (const auto *MD = dyn_cast<CXXMethodDecl>(Val: D)) {
972 // Only look at the type-as-written. Otherwise, deducing the return type
973 // of a function could change its linkage.
974 QualType TypeAsWritten = MD->getType();
975 if (TypeSourceInfo *TSI = MD->getTypeSourceInfo())
976 TypeAsWritten = TSI->getType();
977 if (!isExternallyVisible(L: TypeAsWritten->getLinkage()))
978 return LinkageInfo::uniqueExternal();
979
980 // If this is a method template specialization, use the linkage for
981 // the template parameters and arguments.
982 if (FunctionTemplateSpecializationInfo *spec
983 = MD->getTemplateSpecializationInfo()) {
984 mergeTemplateLV(LV, fn: MD, specInfo: spec, computation);
985 if (spec->isExplicitSpecialization()) {
986 explicitSpecSuppressor = MD;
987 } else if (isExplicitMemberSpecialization(D: spec->getTemplate())) {
988 explicitSpecSuppressor = spec->getTemplate()->getTemplatedDecl();
989 }
990 } else if (isExplicitMemberSpecialization(D: MD)) {
991 explicitSpecSuppressor = MD;
992 }
993
994 // OpenMP target declare device functions are not callable from the host so
995 // they should not be exported from the device image. This applies to all
996 // functions as the host-callable kernel functions are emitted at codegen.
997 ASTContext &Context = D->getASTContext();
998 if (Context.getLangOpts().OpenMP &&
999 Context.getLangOpts().OpenMPIsTargetDevice &&
1000 ((Context.getTargetInfo().getTriple().isAMDGPU() ||
1001 Context.getTargetInfo().getTriple().isNVPTX()) ||
1002 OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD: MD)))
1003 LV.mergeVisibility(newVis: HiddenVisibility, /*newExplicit=*/false);
1004
1005 } else if (const auto *RD = dyn_cast<CXXRecordDecl>(Val: D)) {
1006 if (const auto *spec = dyn_cast<ClassTemplateSpecializationDecl>(Val: RD)) {
1007 mergeTemplateLV(LV, spec, computation);
1008 if (spec->isExplicitSpecialization()) {
1009 explicitSpecSuppressor = spec;
1010 } else {
1011 const ClassTemplateDecl *temp = spec->getSpecializedTemplate();
1012 if (isExplicitMemberSpecialization(D: temp)) {
1013 explicitSpecSuppressor = temp->getTemplatedDecl();
1014 }
1015 }
1016 } else if (isExplicitMemberSpecialization(D: RD)) {
1017 explicitSpecSuppressor = RD;
1018 }
1019
1020 // Static data members.
1021 } else if (const auto *VD = dyn_cast<VarDecl>(Val: D)) {
1022 if (const auto *spec = dyn_cast<VarTemplateSpecializationDecl>(Val: VD))
1023 mergeTemplateLV(LV, spec, computation);
1024
1025 // Modify the variable's linkage by its type, but ignore the
1026 // type's visibility unless it's a definition.
1027 if (!IgnoreVarTypeLinkage) {
1028 LinkageInfo typeLV = getLVForType(T: *VD->getType(), computation);
1029 // FIXME: If the type's linkage is not externally visible, we can
1030 // give this static data member UniqueExternalLinkage.
1031 if (!LV.isVisibilityExplicit() && !classLV.isVisibilityExplicit())
1032 LV.mergeVisibility(other: typeLV);
1033 LV.mergeExternalVisibility(Other: typeLV);
1034 }
1035
1036 if (isExplicitMemberSpecialization(D: VD)) {
1037 explicitSpecSuppressor = VD;
1038 }
1039
1040 // Template members.
1041 } else if (const auto *temp = dyn_cast<TemplateDecl>(Val: D)) {
1042 bool considerVisibility =
1043 (!LV.isVisibilityExplicit() &&
1044 !classLV.isVisibilityExplicit() &&
1045 !hasExplicitVisibilityAlready(computation));
1046 LinkageInfo tempLV =
1047 getLVForTemplateParameterList(Params: temp->getTemplateParameters(), computation);
1048 LV.mergeMaybeWithVisibility(other: tempLV, withVis: considerVisibility);
1049
1050 if (const auto *redeclTemp = dyn_cast<RedeclarableTemplateDecl>(Val: temp)) {
1051 if (isExplicitMemberSpecialization(D: redeclTemp)) {
1052 explicitSpecSuppressor = temp->getTemplatedDecl();
1053 } else if (const RedeclarableTemplateDecl *from =
1054 redeclTemp->getInstantiatedFromMemberTemplate()) {
1055 // If no explicit visibility is specified yet, and this is an
1056 // instantiated member of a template, look up visibility there
1057 // as well.
1058 LinkageInfo fromLV = from->getLinkageAndVisibility();
1059 LV.mergeMaybeWithVisibility(other: fromLV, withVis: considerVisibility);
1060 }
1061 }
1062 }
1063
1064 // We should never be looking for an attribute directly on a template.
1065 assert(!explicitSpecSuppressor || !isa<TemplateDecl>(explicitSpecSuppressor));
1066
1067 // If this member is an explicit member specialization, and it has
1068 // an explicit attribute, ignore visibility from the parent.
1069 bool considerClassVisibility = true;
1070 if (explicitSpecSuppressor &&
1071 // optimization: hasDVA() is true only with explicit visibility.
1072 LV.isVisibilityExplicit() &&
1073 classLV.getVisibility() != DefaultVisibility &&
1074 hasDirectVisibilityAttribute(D: explicitSpecSuppressor, computation)) {
1075 considerClassVisibility = false;
1076 }
1077
1078 // Finally, merge in information from the class.
1079 LV.mergeMaybeWithVisibility(other: classLV, withVis: considerClassVisibility);
1080 return LV;
1081}
1082
1083void NamedDecl::anchor() {}
1084
1085bool NamedDecl::isLinkageValid() const {
1086 if (!hasCachedLinkage())
1087 return true;
1088
1089 Linkage L = LinkageComputer{}
1090 .computeLVForDecl(D: this, computation: LVComputationKind::forLinkageOnly())
1091 .getLinkage();
1092 return L == getCachedLinkage();
1093}
1094
1095bool NamedDecl::isPlaceholderVar(const LangOptions &LangOpts) const {
1096 // [C++2c] [basic.scope.scope]/p5
1097 // A declaration is name-independent if its name is _ and it declares
1098 // - a variable with automatic storage duration,
1099 // - a structured binding not inhabiting a namespace scope,
1100 // - the variable introduced by an init-capture
1101 // - or a non-static data member.
1102
1103 if (!LangOpts.CPlusPlus || !getIdentifier() ||
1104 !getIdentifier()->isPlaceholder())
1105 return false;
1106 if (isa<FieldDecl>(Val: this))
1107 return true;
1108 if (const auto *IFD = dyn_cast<IndirectFieldDecl>(Val: this)) {
1109 if (!getDeclContext()->isFunctionOrMethod() &&
1110 !getDeclContext()->isRecord())
1111 return false;
1112 const VarDecl *VD = IFD->getVarDecl();
1113 return !VD || VD->getStorageDuration() == SD_Automatic;
1114 }
1115 // and it declares a variable with automatic storage duration
1116 if (const auto *VD = dyn_cast<VarDecl>(Val: this)) {
1117 if (isa<ParmVarDecl>(Val: VD))
1118 return false;
1119 if (VD->isInitCapture())
1120 return true;
1121 return VD->getStorageDuration() == StorageDuration::SD_Automatic;
1122 }
1123 if (const auto *BD = dyn_cast<BindingDecl>(Val: this);
1124 BD && getDeclContext()->isFunctionOrMethod()) {
1125 const VarDecl *VD = BD->getHoldingVar();
1126 return !VD || VD->getStorageDuration() == StorageDuration::SD_Automatic;
1127 }
1128 return false;
1129}
1130
1131ReservedIdentifierStatus
1132NamedDecl::isReserved(const LangOptions &LangOpts) const {
1133 const IdentifierInfo *II = getIdentifier();
1134
1135 // This triggers at least for CXXLiteralIdentifiers, which we already checked
1136 // at lexing time.
1137 if (!II)
1138 return ReservedIdentifierStatus::NotReserved;
1139
1140 ReservedIdentifierStatus Status = II->isReserved(LangOpts);
1141 if (isReservedAtGlobalScope(Status) && !isReservedInAllContexts(Status)) {
1142 // This name is only reserved at global scope. Check if this declaration
1143 // conflicts with a global scope declaration.
1144 if (isa<ParmVarDecl>(Val: this) || isTemplateParameter())
1145 return ReservedIdentifierStatus::NotReserved;
1146
1147 // C++ [dcl.link]/7:
1148 // Two declarations [conflict] if [...] one declares a function or
1149 // variable with C language linkage, and the other declares [...] a
1150 // variable that belongs to the global scope.
1151 //
1152 // Therefore names that are reserved at global scope are also reserved as
1153 // names of variables and functions with C language linkage.
1154 const DeclContext *DC = getDeclContext()->getRedeclContext();
1155 if (DC->isTranslationUnit())
1156 return Status;
1157 if (auto *VD = dyn_cast<VarDecl>(Val: this))
1158 if (VD->isExternC())
1159 return ReservedIdentifierStatus::StartsWithUnderscoreAndIsExternC;
1160 if (auto *FD = dyn_cast<FunctionDecl>(Val: this))
1161 if (FD->isExternC())
1162 return ReservedIdentifierStatus::StartsWithUnderscoreAndIsExternC;
1163 return ReservedIdentifierStatus::NotReserved;
1164 }
1165
1166 return Status;
1167}
1168
1169ObjCStringFormatFamily NamedDecl::getObjCFStringFormattingFamily() const {
1170 StringRef name = getName();
1171 if (name.empty()) return SFF_None;
1172
1173 if (name.front() == 'C')
1174 if (name == "CFStringCreateWithFormat" ||
1175 name == "CFStringCreateWithFormatAndArguments" ||
1176 name == "CFStringAppendFormat" ||
1177 name == "CFStringAppendFormatAndArguments")
1178 return SFF_CFString;
1179 return SFF_None;
1180}
1181
1182Linkage NamedDecl::getLinkageInternal() const {
1183 // We don't care about visibility here, so ask for the cheapest
1184 // possible visibility analysis.
1185 return LinkageComputer{}
1186 .getLVForDecl(D: this, computation: LVComputationKind::forLinkageOnly())
1187 .getLinkage();
1188}
1189
1190static bool isExportedFromModuleInterfaceUnit(const NamedDecl *D) {
1191 // FIXME: Handle isModulePrivate.
1192 switch (D->getModuleOwnershipKind()) {
1193 case Decl::ModuleOwnershipKind::Unowned:
1194 case Decl::ModuleOwnershipKind::ReachableWhenImported:
1195 case Decl::ModuleOwnershipKind::ModulePrivate:
1196 return false;
1197 case Decl::ModuleOwnershipKind::Visible:
1198 case Decl::ModuleOwnershipKind::VisibleWhenImported:
1199 return D->isInNamedModule();
1200 }
1201 llvm_unreachable("unexpected module ownership kind");
1202}
1203
1204/// Get the linkage from a semantic point of view. Entities in
1205/// anonymous namespaces are external (in c++98).
1206Linkage NamedDecl::getFormalLinkage() const {
1207 Linkage InternalLinkage = getLinkageInternal();
1208
1209 // C++ [basic.link]p4.8:
1210 // - if the declaration of the name is attached to a named module and is not
1211 // exported
1212 // the name has module linkage;
1213 //
1214 // [basic.namespace.general]/p2
1215 // A namespace is never attached to a named module and never has a name with
1216 // module linkage.
1217 if (isInNamedModule() && InternalLinkage == Linkage::External &&
1218 !isExportedFromModuleInterfaceUnit(
1219 D: cast<NamedDecl>(Val: this->getCanonicalDecl())) &&
1220 !isa<NamespaceDecl>(Val: this))
1221 InternalLinkage = Linkage::Module;
1222
1223 return clang::getFormalLinkage(L: InternalLinkage);
1224}
1225
1226LinkageInfo NamedDecl::getLinkageAndVisibility() const {
1227 return LinkageComputer{}.getDeclLinkageAndVisibility(D: this);
1228}
1229
1230static std::optional<Visibility>
1231getExplicitVisibilityAux(const NamedDecl *ND,
1232 NamedDecl::ExplicitVisibilityKind kind,
1233 bool IsMostRecent) {
1234 assert(!IsMostRecent || ND == ND->getMostRecentDecl());
1235
1236 if (isa<ConceptDecl>(Val: ND))
1237 return {};
1238
1239 // Check the declaration itself first.
1240 if (std::optional<Visibility> V = getVisibilityOf(D: ND, kind))
1241 return V;
1242
1243 // If this is a member class of a specialization of a class template
1244 // and the corresponding decl has explicit visibility, use that.
1245 if (const auto *RD = dyn_cast<CXXRecordDecl>(Val: ND)) {
1246 CXXRecordDecl *InstantiatedFrom = RD->getInstantiatedFromMemberClass();
1247 if (InstantiatedFrom)
1248 return getVisibilityOf(D: InstantiatedFrom, kind);
1249 }
1250
1251 // If there wasn't explicit visibility there, and this is a
1252 // specialization of a class template, check for visibility
1253 // on the pattern.
1254 if (const auto *spec = dyn_cast<ClassTemplateSpecializationDecl>(Val: ND)) {
1255 // Walk all the template decl till this point to see if there are
1256 // explicit visibility attributes.
1257 const auto *TD = spec->getSpecializedTemplate()->getTemplatedDecl();
1258 while (TD != nullptr) {
1259 auto Vis = getVisibilityOf(D: TD, kind);
1260 if (Vis != std::nullopt)
1261 return Vis;
1262 TD = TD->getPreviousDecl();
1263 }
1264 return std::nullopt;
1265 }
1266
1267 // Use the most recent declaration.
1268 if (!IsMostRecent && !isa<NamespaceDecl>(Val: ND)) {
1269 const NamedDecl *MostRecent = ND->getMostRecentDecl();
1270 if (MostRecent != ND)
1271 return getExplicitVisibilityAux(ND: MostRecent, kind, IsMostRecent: true);
1272 }
1273
1274 if (const auto *Var = dyn_cast<VarDecl>(Val: ND)) {
1275 if (Var->isStaticDataMember()) {
1276 VarDecl *InstantiatedFrom = Var->getInstantiatedFromStaticDataMember();
1277 if (InstantiatedFrom)
1278 return getVisibilityOf(D: InstantiatedFrom, kind);
1279 }
1280
1281 if (const auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(Val: Var))
1282 return getVisibilityOf(D: VTSD->getSpecializedTemplate()->getTemplatedDecl(),
1283 kind);
1284
1285 return std::nullopt;
1286 }
1287 // Also handle function template specializations.
1288 if (const auto *fn = dyn_cast<FunctionDecl>(Val: ND)) {
1289 // If the function is a specialization of a template with an
1290 // explicit visibility attribute, use that.
1291 if (FunctionTemplateSpecializationInfo *templateInfo
1292 = fn->getTemplateSpecializationInfo())
1293 return getVisibilityOf(D: templateInfo->getTemplate()->getTemplatedDecl(),
1294 kind);
1295
1296 // If the function is a member of a specialization of a class template
1297 // and the corresponding decl has explicit visibility, use that.
1298 FunctionDecl *InstantiatedFrom = fn->getInstantiatedFromMemberFunction();
1299 if (InstantiatedFrom)
1300 return getVisibilityOf(D: InstantiatedFrom, kind);
1301
1302 return std::nullopt;
1303 }
1304
1305 // The visibility of a template is stored in the templated decl.
1306 if (const auto *TD = dyn_cast<TemplateDecl>(Val: ND))
1307 return getVisibilityOf(D: TD->getTemplatedDecl(), kind);
1308
1309 return std::nullopt;
1310}
1311
1312std::optional<Visibility>
1313NamedDecl::getExplicitVisibility(ExplicitVisibilityKind kind) const {
1314 return getExplicitVisibilityAux(ND: this, kind, IsMostRecent: false);
1315}
1316
1317LinkageInfo LinkageComputer::getLVForClosure(const DeclContext *DC,
1318 Decl *ContextDecl,
1319 LVComputationKind computation) {
1320 // This lambda has its linkage/visibility determined by its owner.
1321 const NamedDecl *Owner;
1322 if (!ContextDecl)
1323 Owner = dyn_cast<NamedDecl>(Val: DC);
1324 else if (isa<ParmVarDecl>(Val: ContextDecl))
1325 Owner =
1326 dyn_cast<NamedDecl>(Val: ContextDecl->getDeclContext()->getRedeclContext());
1327 else if (isa<ImplicitConceptSpecializationDecl>(Val: ContextDecl)) {
1328 // Replace with the concept's owning decl, which is either a namespace or a
1329 // TU, so this needs a dyn_cast.
1330 Owner = dyn_cast<NamedDecl>(Val: ContextDecl->getDeclContext());
1331 } else {
1332 Owner = cast<NamedDecl>(Val: ContextDecl);
1333 }
1334
1335 if (!Owner)
1336 return LinkageInfo::none();
1337
1338 // If the owner has a deduced type, we need to skip querying the linkage and
1339 // visibility of that type, because it might involve this closure type. The
1340 // only effect of this is that we might give a lambda VisibleNoLinkage rather
1341 // than NoLinkage when we don't strictly need to, which is benign.
1342 auto *VD = dyn_cast<VarDecl>(Val: Owner);
1343 LinkageInfo OwnerLV =
1344 VD && VD->getType()->getContainedDeducedType()
1345 ? computeLVForDecl(D: Owner, computation, /*IgnoreVarTypeLinkage*/true)
1346 : getLVForDecl(D: Owner, computation);
1347
1348 // A lambda never formally has linkage. But if the owner is externally
1349 // visible, then the lambda is too. We apply the same rules to blocks.
1350 if (!isExternallyVisible(L: OwnerLV.getLinkage()))
1351 return LinkageInfo::none();
1352 return LinkageInfo(Linkage::VisibleNone, OwnerLV.getVisibility(),
1353 OwnerLV.isVisibilityExplicit());
1354}
1355
1356LinkageInfo LinkageComputer::getLVForLocalDecl(const NamedDecl *D,
1357 LVComputationKind computation) {
1358 if (const auto *Function = dyn_cast<FunctionDecl>(Val: D)) {
1359 if (Function->isInAnonymousNamespace() &&
1360 !isFirstInExternCContext(D: Function))
1361 return LinkageInfo::internal();
1362
1363 // This is a "void f();" which got merged with a file static.
1364 if (Function->getCanonicalDecl()->getStorageClass() == SC_Static)
1365 return LinkageInfo::internal();
1366
1367 LinkageInfo LV;
1368 if (!hasExplicitVisibilityAlready(computation)) {
1369 if (std::optional<Visibility> Vis =
1370 getExplicitVisibility(D: Function, kind: computation))
1371 LV.mergeVisibility(newVis: *Vis, newExplicit: true);
1372 }
1373
1374 // Note that Sema::MergeCompatibleFunctionDecls already takes care of
1375 // merging storage classes and visibility attributes, so we don't have to
1376 // look at previous decls in here.
1377
1378 return LV;
1379 }
1380
1381 if (const auto *Var = dyn_cast<VarDecl>(Val: D)) {
1382 if (Var->hasExternalStorage()) {
1383 if (Var->isInAnonymousNamespace() && !isFirstInExternCContext(D: Var))
1384 return LinkageInfo::internal();
1385
1386 LinkageInfo LV;
1387 if (Var->getStorageClass() == SC_PrivateExtern)
1388 LV.mergeVisibility(newVis: HiddenVisibility, newExplicit: true);
1389 else if (!hasExplicitVisibilityAlready(computation)) {
1390 if (std::optional<Visibility> Vis =
1391 getExplicitVisibility(D: Var, kind: computation))
1392 LV.mergeVisibility(newVis: *Vis, newExplicit: true);
1393 }
1394
1395 if (const VarDecl *Prev = Var->getPreviousDecl()) {
1396 LinkageInfo PrevLV = getLVForDecl(D: Prev, computation);
1397 if (PrevLV.getLinkage() != Linkage::Invalid)
1398 LV.setLinkage(PrevLV.getLinkage());
1399 LV.mergeVisibility(other: PrevLV);
1400 }
1401
1402 return LV;
1403 }
1404
1405 if (!Var->isStaticLocal())
1406 return LinkageInfo::none();
1407 }
1408
1409 ASTContext &Context = D->getASTContext();
1410 if (!Context.getLangOpts().CPlusPlus)
1411 return LinkageInfo::none();
1412
1413 const Decl *OuterD = getOutermostFuncOrBlockContext(D);
1414 if (!OuterD || OuterD->isInvalidDecl())
1415 return LinkageInfo::none();
1416
1417 LinkageInfo LV;
1418 if (const auto *BD = dyn_cast<BlockDecl>(Val: OuterD)) {
1419 if (!BD->getBlockManglingNumber())
1420 return LinkageInfo::none();
1421
1422 LV = getLVForClosure(DC: BD->getDeclContext()->getRedeclContext(),
1423 ContextDecl: BD->getBlockManglingContextDecl(), computation);
1424 } else {
1425 const auto *FD = cast<FunctionDecl>(Val: OuterD);
1426 if (!FD->isInlined() &&
1427 !isTemplateInstantiation(Kind: FD->getTemplateSpecializationKind()))
1428 return LinkageInfo::none();
1429
1430 // If a function is hidden by -fvisibility-inlines-hidden option and
1431 // is not explicitly attributed as a hidden function,
1432 // we should not make static local variables in the function hidden.
1433 LV = getLVForDecl(D: FD, computation);
1434 if (isa<VarDecl>(Val: D) && useInlineVisibilityHidden(D: FD) &&
1435 !LV.isVisibilityExplicit() &&
1436 !Context.getLangOpts().VisibilityInlinesHiddenStaticLocalVar) {
1437 assert(cast<VarDecl>(D)->isStaticLocal());
1438 // If this was an implicitly hidden inline method, check again for
1439 // explicit visibility on the parent class, and use that for static locals
1440 // if present.
1441 if (const auto *MD = dyn_cast<CXXMethodDecl>(Val: FD))
1442 LV = getLVForDecl(D: MD->getParent(), computation);
1443 if (!LV.isVisibilityExplicit()) {
1444 Visibility globalVisibility =
1445 computation.isValueVisibility()
1446 ? Context.getLangOpts().getValueVisibilityMode()
1447 : Context.getLangOpts().getTypeVisibilityMode();
1448 return LinkageInfo(Linkage::VisibleNone, globalVisibility,
1449 /*visibilityExplicit=*/false);
1450 }
1451 }
1452 }
1453 if (!isExternallyVisible(L: LV.getLinkage()))
1454 return LinkageInfo::none();
1455 return LinkageInfo(Linkage::VisibleNone, LV.getVisibility(),
1456 LV.isVisibilityExplicit());
1457}
1458
1459LinkageInfo LinkageComputer::computeLVForDecl(const NamedDecl *D,
1460 LVComputationKind computation,
1461 bool IgnoreVarTypeLinkage) {
1462 // Internal_linkage attribute overrides other considerations.
1463 if (D->hasAttr<InternalLinkageAttr>())
1464 return LinkageInfo::internal();
1465
1466 // Objective-C: treat all Objective-C declarations as having external
1467 // linkage.
1468 switch (D->getKind()) {
1469 default:
1470 break;
1471
1472 // Per C++ [basic.link]p2, only the names of objects, references,
1473 // functions, types, templates, namespaces, and values ever have linkage.
1474 //
1475 // Note that the name of a typedef, namespace alias, using declaration,
1476 // and so on are not the name of the corresponding type, namespace, or
1477 // declaration, so they do *not* have linkage.
1478 case Decl::ImplicitParam:
1479 case Decl::Label:
1480 case Decl::NamespaceAlias:
1481 case Decl::ParmVar:
1482 case Decl::Using:
1483 case Decl::UsingEnum:
1484 case Decl::UsingShadow:
1485 case Decl::UsingDirective:
1486 return LinkageInfo::none();
1487
1488 case Decl::EnumConstant:
1489 // C++ [basic.link]p4: an enumerator has the linkage of its enumeration.
1490 if (D->getASTContext().getLangOpts().CPlusPlus)
1491 return getLVForDecl(D: cast<EnumDecl>(Val: D->getDeclContext()), computation);
1492 return LinkageInfo::visible_none();
1493
1494 case Decl::Typedef:
1495 case Decl::TypeAlias:
1496 // A typedef declaration has linkage if it gives a type a name for
1497 // linkage purposes.
1498 if (!cast<TypedefNameDecl>(Val: D)
1499 ->getAnonDeclWithTypedefName(/*AnyRedecl*/true))
1500 return LinkageInfo::none();
1501 break;
1502
1503 case Decl::TemplateTemplateParm: // count these as external
1504 case Decl::NonTypeTemplateParm:
1505 case Decl::ObjCAtDefsField:
1506 case Decl::ObjCCategory:
1507 case Decl::ObjCCategoryImpl:
1508 case Decl::ObjCCompatibleAlias:
1509 case Decl::ObjCImplementation:
1510 case Decl::ObjCMethod:
1511 case Decl::ObjCProperty:
1512 case Decl::ObjCPropertyImpl:
1513 case Decl::ObjCProtocol:
1514 return getExternalLinkageFor(D);
1515
1516 case Decl::CXXRecord: {
1517 const auto *Record = cast<CXXRecordDecl>(Val: D);
1518 if (Record->isLambda()) {
1519 if (Record->hasKnownLambdaInternalLinkage() ||
1520 !Record->getLambdaManglingNumber()) {
1521 // This lambda has no mangling number, so it's internal.
1522 return LinkageInfo::internal();
1523 }
1524
1525 return getLVForClosure(
1526 DC: Record->getDeclContext()->getRedeclContext(),
1527 ContextDecl: Record->getLambdaContextDecl(), computation);
1528 }
1529
1530 break;
1531 }
1532
1533 case Decl::TemplateParamObject: {
1534 // The template parameter object can be referenced from anywhere its type
1535 // and value can be referenced.
1536 auto *TPO = cast<TemplateParamObjectDecl>(Val: D);
1537 LinkageInfo LV = getLVForType(T: *TPO->getType(), computation);
1538 LV.merge(other: getLVForValue(V: TPO->getValue(), computation));
1539 return LV;
1540 }
1541 }
1542
1543 // Handle linkage for namespace-scope names.
1544 if (D->getDeclContext()->getRedeclContext()->isFileContext())
1545 return getLVForNamespaceScopeDecl(D, computation, IgnoreVarTypeLinkage);
1546
1547 // C++ [basic.link]p5:
1548 // In addition, a member function, static data member, a named
1549 // class or enumeration of class scope, or an unnamed class or
1550 // enumeration defined in a class-scope typedef declaration such
1551 // that the class or enumeration has the typedef name for linkage
1552 // purposes (7.1.3), has external linkage if the name of the class
1553 // has external linkage.
1554 if (D->getDeclContext()->isRecord())
1555 return getLVForClassMember(D, computation, IgnoreVarTypeLinkage);
1556
1557 // C++ [basic.link]p6:
1558 // The name of a function declared in block scope and the name of
1559 // an object declared by a block scope extern declaration have
1560 // linkage. If there is a visible declaration of an entity with
1561 // linkage having the same name and type, ignoring entities
1562 // declared outside the innermost enclosing namespace scope, the
1563 // block scope declaration declares that same entity and receives
1564 // the linkage of the previous declaration. If there is more than
1565 // one such matching entity, the program is ill-formed. Otherwise,
1566 // if no matching entity is found, the block scope entity receives
1567 // external linkage.
1568 if (D->getDeclContext()->isFunctionOrMethod())
1569 return getLVForLocalDecl(D, computation);
1570
1571 // C++ [basic.link]p6:
1572 // Names not covered by these rules have no linkage.
1573 return LinkageInfo::none();
1574}
1575
1576/// getLVForDecl - Get the linkage and visibility for the given declaration.
1577LinkageInfo LinkageComputer::getLVForDecl(const NamedDecl *D,
1578 LVComputationKind computation) {
1579 // Internal_linkage attribute overrides other considerations.
1580 if (D->hasAttr<InternalLinkageAttr>())
1581 return LinkageInfo::internal();
1582
1583 if (computation.IgnoreAllVisibility && D->hasCachedLinkage())
1584 return LinkageInfo(D->getCachedLinkage(), DefaultVisibility, false);
1585
1586 if (std::optional<LinkageInfo> LI = lookup(ND: D, Kind: computation))
1587 return *LI;
1588
1589 LinkageInfo LV = computeLVForDecl(D, computation);
1590 if (D->hasCachedLinkage())
1591 assert(D->getCachedLinkage() == LV.getLinkage());
1592
1593 D->setCachedLinkage(LV.getLinkage());
1594 cache(ND: D, Kind: computation, Info: LV);
1595
1596#ifndef NDEBUG
1597 // In C (because of gnu inline) and in c++ with microsoft extensions an
1598 // static can follow an extern, so we can have two decls with different
1599 // linkages.
1600 const LangOptions &Opts = D->getASTContext().getLangOpts();
1601 if (!Opts.CPlusPlus || Opts.MicrosoftExt)
1602 return LV;
1603
1604 // We have just computed the linkage for this decl. By induction we know
1605 // that all other computed linkages match, check that the one we just
1606 // computed also does.
1607 // We can't assume the redecl chain is well formed at this point,
1608 // so keep track of already visited declarations.
1609 for (llvm::SmallPtrSet<const Decl *, 4> AlreadyVisited{D}; /**/; /**/) {
1610 D = cast<NamedDecl>(const_cast<NamedDecl *>(D)->getNextRedeclarationImpl());
1611 if (!AlreadyVisited.insert(D).second)
1612 break;
1613 if (D->isInvalidDecl())
1614 continue;
1615 if (auto OldLinkage = D->getCachedLinkage();
1616 OldLinkage != Linkage::Invalid) {
1617 assert(LV.getLinkage() == OldLinkage);
1618 break;
1619 }
1620 }
1621#endif
1622
1623 return LV;
1624}
1625
1626LinkageInfo LinkageComputer::getDeclLinkageAndVisibility(const NamedDecl *D) {
1627 NamedDecl::ExplicitVisibilityKind EK = usesTypeVisibility(D)
1628 ? NamedDecl::VisibilityForType
1629 : NamedDecl::VisibilityForValue;
1630 LVComputationKind CK(EK);
1631 return getLVForDecl(D, computation: D->getASTContext().getLangOpts().IgnoreXCOFFVisibility
1632 ? CK.forLinkageOnly()
1633 : CK);
1634}
1635
1636Module *Decl::getOwningModuleForLinkage() const {
1637 if (isa<NamespaceDecl>(Val: this))
1638 // Namespaces never have module linkage. It is the entities within them
1639 // that [may] do.
1640 return nullptr;
1641
1642 Module *M = getOwningModule();
1643 if (!M)
1644 return nullptr;
1645
1646 switch (M->Kind) {
1647 case Module::ModuleMapModule:
1648 // Module map modules have no special linkage semantics.
1649 return nullptr;
1650
1651 case Module::ModuleInterfaceUnit:
1652 case Module::ModuleImplementationUnit:
1653 case Module::ModulePartitionInterface:
1654 case Module::ModulePartitionImplementation:
1655 return M;
1656
1657 case Module::ModuleHeaderUnit:
1658 case Module::ExplicitGlobalModuleFragment:
1659 case Module::ImplicitGlobalModuleFragment:
1660 // The global module shouldn't change the linkage.
1661 return nullptr;
1662
1663 case Module::PrivateModuleFragment:
1664 // The private module fragment is part of its containing module for linkage
1665 // purposes.
1666 return M->Parent;
1667 }
1668
1669 llvm_unreachable("unknown module kind");
1670}
1671
1672void NamedDecl::printName(raw_ostream &OS, const PrintingPolicy &Policy) const {
1673 Name.print(OS, Policy);
1674}
1675
1676void NamedDecl::printName(raw_ostream &OS) const {
1677 printName(OS, Policy: getASTContext().getPrintingPolicy());
1678}
1679
1680std::string NamedDecl::getQualifiedNameAsString() const {
1681 std::string QualName;
1682 llvm::raw_string_ostream OS(QualName);
1683 printQualifiedName(OS, Policy: getASTContext().getPrintingPolicy());
1684 return QualName;
1685}
1686
1687void NamedDecl::printQualifiedName(raw_ostream &OS) const {
1688 printQualifiedName(OS, Policy: getASTContext().getPrintingPolicy());
1689}
1690
1691void NamedDecl::printQualifiedName(raw_ostream &OS,
1692 const PrintingPolicy &P) const {
1693 if (getDeclContext()->isFunctionOrMethod()) {
1694 // We do not print '(anonymous)' for function parameters without name.
1695 printName(OS, Policy: P);
1696 return;
1697 }
1698 printNestedNameSpecifier(OS, Policy: P);
1699 if (getDeclName()) {
1700 printName(OS, Policy: P);
1701 } else {
1702 // Give the printName override a chance to pick a different name before we
1703 // fall back to "(anonymous)".
1704 SmallString<64> NameBuffer;
1705 llvm::raw_svector_ostream NameOS(NameBuffer);
1706 printName(OS&: NameOS, Policy: P);
1707 if (NameBuffer.empty())
1708 OS << "(anonymous)";
1709 else
1710 OS << NameBuffer;
1711 }
1712}
1713
1714void NamedDecl::printNestedNameSpecifier(raw_ostream &OS) const {
1715 printNestedNameSpecifier(OS, Policy: getASTContext().getPrintingPolicy());
1716}
1717
1718void NamedDecl::printNestedNameSpecifier(raw_ostream &OS,
1719 const PrintingPolicy &P) const {
1720 const DeclContext *Ctx = getDeclContext();
1721
1722 // For ObjC methods and properties, look through categories and use the
1723 // interface as context.
1724 if (auto *MD = dyn_cast<ObjCMethodDecl>(Val: this)) {
1725 if (auto *ID = MD->getClassInterface())
1726 Ctx = ID;
1727 } else if (auto *PD = dyn_cast<ObjCPropertyDecl>(Val: this)) {
1728 if (auto *MD = PD->getGetterMethodDecl())
1729 if (auto *ID = MD->getClassInterface())
1730 Ctx = ID;
1731 } else if (auto *ID = dyn_cast<ObjCIvarDecl>(Val: this)) {
1732 if (auto *CI = ID->getContainingInterface())
1733 Ctx = CI;
1734 }
1735
1736 if (Ctx->isFunctionOrMethod())
1737 return;
1738
1739 using ContextsTy = SmallVector<const DeclContext *, 8>;
1740 ContextsTy Contexts;
1741
1742 // Collect named contexts.
1743 DeclarationName NameInScope = getDeclName();
1744 for (; Ctx; Ctx = Ctx->getParent()) {
1745 if (P.Callbacks && P.Callbacks->isScopeVisible(DC: Ctx))
1746 continue;
1747
1748 // Suppress anonymous namespace if requested.
1749 if (P.SuppressUnwrittenScope && isa<NamespaceDecl>(Val: Ctx) &&
1750 cast<NamespaceDecl>(Val: Ctx)->isAnonymousNamespace())
1751 continue;
1752
1753 // Suppress inline namespace if it doesn't make the result ambiguous.
1754 if (Ctx->isInlineNamespace() && NameInScope) {
1755 if (P.SuppressInlineNamespace ==
1756 llvm::to_underlying(
1757 E: PrintingPolicy::SuppressInlineNamespaceMode::All) ||
1758 (P.SuppressInlineNamespace ==
1759 llvm::to_underlying(
1760 E: PrintingPolicy::SuppressInlineNamespaceMode::Redundant) &&
1761 cast<NamespaceDecl>(Val: Ctx)->isRedundantInlineQualifierFor(
1762 Name: NameInScope))) {
1763 continue;
1764 }
1765 }
1766
1767 // Suppress transparent contexts like export or HLSLBufferDecl context
1768 if (Ctx->isTransparentContext())
1769 continue;
1770
1771 // Skip non-named contexts such as linkage specifications and ExportDecls.
1772 const NamedDecl *ND = dyn_cast<NamedDecl>(Val: Ctx);
1773 if (!ND)
1774 continue;
1775
1776 Contexts.push_back(Elt: Ctx);
1777 NameInScope = ND->getDeclName();
1778 }
1779
1780 for (const DeclContext *DC : llvm::reverse(C&: Contexts)) {
1781 if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(Val: DC)) {
1782 OS << Spec->getName();
1783 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
1784 printTemplateArgumentList(
1785 OS, Args: TemplateArgs.asArray(), Policy: P,
1786 TPL: Spec->getSpecializedTemplate()->getTemplateParameters());
1787 } else if (const auto *ND = dyn_cast<NamespaceDecl>(Val: DC)) {
1788 if (ND->isAnonymousNamespace()) {
1789 OS << (P.MSVCFormatting ? "`anonymous namespace\'"
1790 : "(anonymous namespace)");
1791 }
1792 else
1793 OS << *ND;
1794 } else if (const auto *RD = llvm::dyn_cast<RecordDecl>(Val: DC)) {
1795 PrintingPolicy Copy(P);
1796 // As part of a scope we want to print anonymous names as:
1797 // ..::(anonymous struct)::..
1798 //
1799 // I.e., suppress tag locations, suppress leading keyword, *don't*
1800 // suppress tag in name
1801 Copy.SuppressTagKeyword = true;
1802 Copy.SuppressTagKeywordInAnonNames = false;
1803 Copy.AnonymousTagLocations = false;
1804 RD->printName(OS, Policy: Copy);
1805 } else if (const auto *FD = dyn_cast<FunctionDecl>(Val: DC)) {
1806 const FunctionProtoType *FT = nullptr;
1807 if (FD->hasWrittenPrototype())
1808 FT = dyn_cast<FunctionProtoType>(Val: FD->getType()->castAs<FunctionType>());
1809
1810 OS << *FD << '(';
1811 if (FT) {
1812 unsigned NumParams = FD->getNumParams();
1813 for (unsigned i = 0; i < NumParams; ++i) {
1814 if (i)
1815 OS << ", ";
1816 OS << FD->getParamDecl(i)->getType().stream(Policy: P);
1817 }
1818
1819 if (FT->isVariadic()) {
1820 if (NumParams > 0)
1821 OS << ", ";
1822 OS << "...";
1823 }
1824 }
1825 OS << ')';
1826 } else if (const auto *ED = dyn_cast<EnumDecl>(Val: DC)) {
1827 // C++ [dcl.enum]p10: Each enum-name and each unscoped
1828 // enumerator is declared in the scope that immediately contains
1829 // the enum-specifier. Each scoped enumerator is declared in the
1830 // scope of the enumeration.
1831 // For the case of unscoped enumerator, do not include in the qualified
1832 // name any information about its enum enclosing scope, as its visibility
1833 // is global.
1834 if (ED->isScoped())
1835 OS << *ED;
1836 else
1837 continue;
1838 } else {
1839 OS << *cast<NamedDecl>(Val: DC);
1840 }
1841 OS << "::";
1842 }
1843}
1844
1845void NamedDecl::getNameForDiagnostic(raw_ostream &OS,
1846 const PrintingPolicy &Policy,
1847 bool Qualified) const {
1848 if (Qualified)
1849 printQualifiedName(OS, P: Policy);
1850 else
1851 printName(OS, Policy);
1852}
1853
1854template<typename T> static bool isRedeclarableImpl(Redeclarable<T> *) {
1855 return true;
1856}
1857static bool isRedeclarableImpl(...) { return false; }
1858static bool isRedeclarable(Decl::Kind K) {
1859 switch (K) {
1860#define DECL(Type, Base) \
1861 case Decl::Type: \
1862 return isRedeclarableImpl((Type##Decl *)nullptr);
1863#define ABSTRACT_DECL(DECL)
1864#include "clang/AST/DeclNodes.inc"
1865 }
1866 llvm_unreachable("unknown decl kind");
1867}
1868
1869bool NamedDecl::declarationReplaces(const NamedDecl *OldD,
1870 bool IsKnownNewer) const {
1871 assert(getDeclName() == OldD->getDeclName() && "Declaration name mismatch");
1872
1873 // Never replace one imported declaration with another; we need both results
1874 // when re-exporting.
1875 if (OldD->isFromASTFile() && isFromASTFile())
1876 return false;
1877
1878 // A kind mismatch implies that the declaration is not replaced.
1879 if (OldD->getKind() != getKind())
1880 return false;
1881
1882 // For method declarations, we never replace. (Why?)
1883 if (isa<ObjCMethodDecl>(Val: this))
1884 return false;
1885
1886 // For parameters, pick the newer one. This is either an error or (in
1887 // Objective-C) permitted as an extension.
1888 if (isa<ParmVarDecl>(Val: this))
1889 return true;
1890
1891 // Inline namespaces can give us two declarations with the same
1892 // name and kind in the same scope but different contexts; we should
1893 // keep both declarations in this case.
1894 if (!this->getDeclContext()->getRedeclContext()->Equals(
1895 DC: OldD->getDeclContext()->getRedeclContext()))
1896 return false;
1897
1898 // Using declarations can be replaced if they import the same name from the
1899 // same context.
1900 if (const auto *UD = dyn_cast<UsingDecl>(Val: this))
1901 return UD->getQualifier().getCanonical() ==
1902
1903 cast<UsingDecl>(Val: OldD)->getQualifier().getCanonical();
1904 if (const auto *UUVD = dyn_cast<UnresolvedUsingValueDecl>(Val: this))
1905 return UUVD->getQualifier().getCanonical() ==
1906 cast<UnresolvedUsingValueDecl>(Val: OldD)->getQualifier().getCanonical();
1907
1908 if (isRedeclarable(K: getKind())) {
1909 if (getCanonicalDecl() != OldD->getCanonicalDecl())
1910 return false;
1911
1912 if (IsKnownNewer)
1913 return true;
1914
1915 // Check whether this is actually newer than OldD. We want to keep the
1916 // newer declaration. This loop will usually only iterate once, because
1917 // OldD is usually the previous declaration.
1918 for (const auto *D : redecls()) {
1919 if (D == OldD)
1920 break;
1921
1922 // If we reach the canonical declaration, then OldD is not actually older
1923 // than this one.
1924 //
1925 // FIXME: In this case, we should not add this decl to the lookup table.
1926 if (D->isCanonicalDecl())
1927 return false;
1928 }
1929
1930 // It's a newer declaration of the same kind of declaration in the same
1931 // scope: we want this decl instead of the existing one.
1932 return true;
1933 }
1934
1935 // In all other cases, we need to keep both declarations in case they have
1936 // different visibility. Any attempt to use the name will result in an
1937 // ambiguity if more than one is visible.
1938 return false;
1939}
1940
1941bool NamedDecl::hasLinkage() const {
1942 switch (getFormalLinkage()) {
1943 case Linkage::Invalid:
1944 llvm_unreachable("Linkage hasn't been computed!");
1945 case Linkage::None:
1946 return false;
1947 case Linkage::Internal:
1948 return true;
1949 case Linkage::UniqueExternal:
1950 case Linkage::VisibleNone:
1951 llvm_unreachable("Non-formal linkage is not allowed here!");
1952 case Linkage::Module:
1953 case Linkage::External:
1954 return true;
1955 }
1956 llvm_unreachable("Unhandled Linkage enum");
1957}
1958
1959NamedDecl *NamedDecl::getUnderlyingDeclImpl() {
1960 NamedDecl *ND = this;
1961 if (auto *UD = dyn_cast<UsingShadowDecl>(Val: ND))
1962 ND = UD->getTargetDecl();
1963
1964 if (auto *AD = dyn_cast<ObjCCompatibleAliasDecl>(Val: ND))
1965 return AD->getClassInterface();
1966
1967 if (auto *AD = dyn_cast<NamespaceAliasDecl>(Val: ND))
1968 return AD->getNamespace();
1969
1970 return ND;
1971}
1972
1973bool NamedDecl::isCXXInstanceMember() const {
1974 if (!isCXXClassMember())
1975 return false;
1976
1977 const NamedDecl *D = this;
1978 if (isa<UsingShadowDecl>(Val: D))
1979 D = cast<UsingShadowDecl>(Val: D)->getTargetDecl();
1980
1981 if (isa<FieldDecl>(Val: D) || isa<IndirectFieldDecl>(Val: D) || isa<MSPropertyDecl>(Val: D))
1982 return true;
1983 if (const auto *MD = dyn_cast_if_present<CXXMethodDecl>(Val: D->getAsFunction()))
1984 return MD->isInstance();
1985 return false;
1986}
1987
1988//===----------------------------------------------------------------------===//
1989// DeclaratorDecl Implementation
1990//===----------------------------------------------------------------------===//
1991
1992template <typename DeclT>
1993static SourceLocation getTemplateOrInnerLocStart(const DeclT *decl) {
1994 if (decl->getNumTemplateParameterLists() > 0)
1995 return decl->getTemplateParameterList(0)->getTemplateLoc();
1996 return decl->getInnerLocStart();
1997}
1998
1999SourceLocation DeclaratorDecl::getTypeSpecStartLoc() const {
2000 TypeSourceInfo *TSI = getTypeSourceInfo();
2001 if (TSI) return TSI->getTypeLoc().getBeginLoc();
2002 return SourceLocation();
2003}
2004
2005SourceLocation DeclaratorDecl::getTypeSpecEndLoc() const {
2006 TypeSourceInfo *TSI = getTypeSourceInfo();
2007 if (TSI) return TSI->getTypeLoc().getEndLoc();
2008 return SourceLocation();
2009}
2010
2011void DeclaratorDecl::setQualifierInfo(NestedNameSpecifierLoc QualifierLoc) {
2012 if (QualifierLoc) {
2013 // Make sure the extended decl info is allocated.
2014 if (!hasExtInfo()) {
2015 // Save (non-extended) type source info pointer.
2016 auto *savedTInfo = cast<TypeSourceInfo *>(Val&: DeclInfo);
2017 // Allocate external info struct.
2018 DeclInfo = new (getASTContext()) ExtInfo;
2019 // Restore savedTInfo into (extended) decl info.
2020 getExtInfo()->TInfo = savedTInfo;
2021 }
2022 // Set qualifier info.
2023 getExtInfo()->QualifierLoc = QualifierLoc;
2024 } else if (hasExtInfo()) {
2025 // Here Qualifier == 0, i.e., we are removing the qualifier (if any).
2026 getExtInfo()->QualifierLoc = QualifierLoc;
2027 }
2028}
2029
2030void DeclaratorDecl::setTrailingRequiresClause(const AssociatedConstraint &AC) {
2031 assert(AC);
2032 // Make sure the extended decl info is allocated.
2033 if (!hasExtInfo()) {
2034 // Save (non-extended) type source info pointer.
2035 auto *savedTInfo = cast<TypeSourceInfo *>(Val&: DeclInfo);
2036 // Allocate external info struct.
2037 DeclInfo = new (getASTContext()) ExtInfo;
2038 // Restore savedTInfo into (extended) decl info.
2039 getExtInfo()->TInfo = savedTInfo;
2040 }
2041 // Set requires clause info.
2042 getExtInfo()->TrailingRequiresClause = AC;
2043}
2044
2045void DeclaratorDecl::setTemplateParameterListsInfo(
2046 ASTContext &Context, ArrayRef<TemplateParameterList *> TPLists) {
2047 assert(!TPLists.empty());
2048 // Make sure the extended decl info is allocated.
2049 if (!hasExtInfo()) {
2050 // Save (non-extended) type source info pointer.
2051 auto *savedTInfo = cast<TypeSourceInfo *>(Val&: DeclInfo);
2052 // Allocate external info struct.
2053 DeclInfo = new (getASTContext()) ExtInfo;
2054 // Restore savedTInfo into (extended) decl info.
2055 getExtInfo()->TInfo = savedTInfo;
2056 }
2057 // Set the template parameter lists info.
2058 getExtInfo()->setTemplateParameterListsInfo(Context, TPLists);
2059}
2060
2061SourceLocation DeclaratorDecl::getOuterLocStart() const {
2062 return getTemplateOrInnerLocStart(decl: this);
2063}
2064
2065// Helper function: returns true if QT is or contains a type
2066// having a postfix component.
2067static bool typeIsPostfix(QualType QT) {
2068 while (true) {
2069 const Type* T = QT.getTypePtr();
2070 switch (T->getTypeClass()) {
2071 default:
2072 return false;
2073 case Type::Pointer:
2074 QT = cast<PointerType>(Val: T)->getPointeeType();
2075 break;
2076 case Type::BlockPointer:
2077 QT = cast<BlockPointerType>(Val: T)->getPointeeType();
2078 break;
2079 case Type::MemberPointer:
2080 QT = cast<MemberPointerType>(Val: T)->getPointeeType();
2081 break;
2082 case Type::LValueReference:
2083 case Type::RValueReference:
2084 QT = cast<ReferenceType>(Val: T)->getPointeeType();
2085 break;
2086 case Type::PackExpansion:
2087 QT = cast<PackExpansionType>(Val: T)->getPattern();
2088 break;
2089 case Type::Paren:
2090 case Type::ConstantArray:
2091 case Type::DependentSizedArray:
2092 case Type::IncompleteArray:
2093 case Type::VariableArray:
2094 case Type::FunctionProto:
2095 case Type::FunctionNoProto:
2096 return true;
2097 }
2098 }
2099}
2100
2101SourceRange DeclaratorDecl::getSourceRange() const {
2102 SourceLocation RangeEnd = getLocation();
2103 if (TypeSourceInfo *TInfo = getTypeSourceInfo()) {
2104 // If the declaration has no name or the type extends past the name take the
2105 // end location of the type.
2106 if (!getDeclName() || typeIsPostfix(QT: TInfo->getType()))
2107 RangeEnd = TInfo->getTypeLoc().getSourceRange().getEnd();
2108 }
2109 return SourceRange(getOuterLocStart(), RangeEnd);
2110}
2111
2112void QualifierInfo::setTemplateParameterListsInfo(
2113 ASTContext &Context, ArrayRef<TemplateParameterList *> TPLists) {
2114 // Free previous template parameters (if any).
2115 if (NumTemplParamLists > 0) {
2116 Context.Deallocate(Ptr: TemplParamLists);
2117 TemplParamLists = nullptr;
2118 NumTemplParamLists = 0;
2119 }
2120 // Set info on matched template parameter lists (if any).
2121 if (!TPLists.empty()) {
2122 TemplParamLists = new (Context) TemplateParameterList *[TPLists.size()];
2123 NumTemplParamLists = TPLists.size();
2124 llvm::copy(Range&: TPLists, Out: TemplParamLists);
2125 }
2126}
2127
2128//===----------------------------------------------------------------------===//
2129// VarDecl Implementation
2130//===----------------------------------------------------------------------===//
2131
2132const char *VarDecl::getStorageClassSpecifierString(StorageClass SC) {
2133 switch (SC) {
2134 case SC_None: break;
2135 case SC_Auto: return "auto";
2136 case SC_Extern: return "extern";
2137 case SC_PrivateExtern: return "__private_extern__";
2138 case SC_Register: return "register";
2139 case SC_Static: return "static";
2140 }
2141
2142 llvm_unreachable("Invalid storage class");
2143}
2144
2145VarDecl::VarDecl(Kind DK, ASTContext &C, DeclContext *DC,
2146 SourceLocation StartLoc, SourceLocation IdLoc,
2147 const IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo,
2148 StorageClass SC)
2149 : DeclaratorDecl(DK, DC, IdLoc, Id, T, TInfo, StartLoc),
2150 redeclarable_base(C) {
2151 static_assert(sizeof(VarDeclBitfields) <= sizeof(unsigned),
2152 "VarDeclBitfields too large!");
2153 static_assert(sizeof(ParmVarDeclBitfields) <= sizeof(unsigned),
2154 "ParmVarDeclBitfields too large!");
2155 static_assert(sizeof(NonParmVarDeclBitfields) <= sizeof(unsigned),
2156 "NonParmVarDeclBitfields too large!");
2157 AllBits = 0;
2158 VarDeclBits.SClass = SC;
2159 // Everything else is implicitly initialized to false.
2160}
2161
2162VarDecl *VarDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation StartL,
2163 SourceLocation IdL, const IdentifierInfo *Id,
2164 QualType T, TypeSourceInfo *TInfo, StorageClass S) {
2165 return new (C, DC) VarDecl(Var, C, DC, StartL, IdL, Id, T, TInfo, S);
2166}
2167
2168VarDecl *VarDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
2169 return new (C, ID)
2170 VarDecl(Var, C, nullptr, SourceLocation(), SourceLocation(), nullptr,
2171 QualType(), nullptr, SC_None);
2172}
2173
2174void VarDecl::setStorageClass(StorageClass SC) {
2175 assert(isLegalForVariable(SC));
2176 VarDeclBits.SClass = SC;
2177}
2178
2179VarDecl::TLSKind VarDecl::getTLSKind() const {
2180 switch (VarDeclBits.TSCSpec) {
2181 case TSCS_unspecified:
2182 if (!hasAttr<ThreadAttr>() &&
2183 !(getASTContext().getLangOpts().OpenMPUseTLS &&
2184 getASTContext().getTargetInfo().isTLSSupported() &&
2185 hasAttr<OMPThreadPrivateDeclAttr>()))
2186 return TLS_None;
2187 return ((getASTContext().getLangOpts().isCompatibleWithMSVC(
2188 MajorVersion: LangOptions::MSVC2015)) ||
2189 hasAttr<OMPThreadPrivateDeclAttr>())
2190 ? TLS_Dynamic
2191 : TLS_Static;
2192 case TSCS___thread: // Fall through.
2193 case TSCS__Thread_local:
2194 return TLS_Static;
2195 case TSCS_thread_local:
2196 return TLS_Dynamic;
2197 }
2198 llvm_unreachable("Unknown thread storage class specifier!");
2199}
2200
2201SourceRange VarDecl::getSourceRange() const {
2202 if (const Expr *Init = getInit()) {
2203 SourceLocation InitEnd = Init->getEndLoc();
2204 // If Init is implicit, ignore its source range and fallback on
2205 // DeclaratorDecl::getSourceRange() to handle postfix elements.
2206 if (InitEnd.isValid() && InitEnd != getLocation())
2207 return SourceRange(getOuterLocStart(), InitEnd);
2208 }
2209 return DeclaratorDecl::getSourceRange();
2210}
2211
2212template<typename T>
2213static LanguageLinkage getDeclLanguageLinkage(const T &D) {
2214 // C++ [dcl.link]p1: All function types, function names with external linkage,
2215 // and variable names with external linkage have a language linkage.
2216 if (!D.hasExternalFormalLinkage())
2217 return NoLanguageLinkage;
2218
2219 // Language linkage is a C++ concept, but saying that everything else in C has
2220 // C language linkage fits the implementation nicely.
2221 if (!D.getASTContext().getLangOpts().CPlusPlus)
2222 return CLanguageLinkage;
2223
2224 // C++ [dcl.link]p4: A C language linkage is ignored in determining the
2225 // language linkage of the names of class members and the function type of
2226 // class member functions.
2227 const DeclContext *DC = D.getDeclContext();
2228 if (DC->isRecord())
2229 return CXXLanguageLinkage;
2230
2231 // If the first decl is in an extern "C" context, any other redeclaration
2232 // will have C language linkage. If the first one is not in an extern "C"
2233 // context, we would have reported an error for any other decl being in one.
2234 if (isFirstInExternCContext(&D))
2235 return CLanguageLinkage;
2236 return CXXLanguageLinkage;
2237}
2238
2239template<typename T>
2240static bool isDeclExternC(const T &D) {
2241 // Since the context is ignored for class members, they can only have C++
2242 // language linkage or no language linkage.
2243 const DeclContext *DC = D.getDeclContext();
2244 if (DC->isRecord()) {
2245 assert(D.getASTContext().getLangOpts().CPlusPlus);
2246 return false;
2247 }
2248
2249 return D.getLanguageLinkage() == CLanguageLinkage;
2250}
2251
2252LanguageLinkage VarDecl::getLanguageLinkage() const {
2253 return getDeclLanguageLinkage(D: *this);
2254}
2255
2256bool VarDecl::isExternC() const {
2257 return isDeclExternC(D: *this);
2258}
2259
2260bool VarDecl::isInExternCContext() const {
2261 return getLexicalDeclContext()->isExternCContext();
2262}
2263
2264bool VarDecl::isInExternCXXContext() const {
2265 return getLexicalDeclContext()->isExternCXXContext();
2266}
2267
2268VarDecl *VarDecl::getCanonicalDecl() { return getFirstDecl(); }
2269
2270VarDecl::DefinitionKind
2271VarDecl::isThisDeclarationADefinition(ASTContext &C) const {
2272 if (isThisDeclarationADemotedDefinition())
2273 return DeclarationOnly;
2274
2275 // C++ [basic.def]p2:
2276 // A declaration is a definition unless [...] it contains the 'extern'
2277 // specifier or a linkage-specification and neither an initializer [...],
2278 // it declares a non-inline static data member in a class declaration [...],
2279 // it declares a static data member outside a class definition and the variable
2280 // was defined within the class with the constexpr specifier [...],
2281 // C++1y [temp.expl.spec]p15:
2282 // An explicit specialization of a static data member or an explicit
2283 // specialization of a static data member template is a definition if the
2284 // declaration includes an initializer; otherwise, it is a declaration.
2285 //
2286 // FIXME: How do you declare (but not define) a partial specialization of
2287 // a static data member template outside the containing class?
2288 if (isStaticDataMember()) {
2289 if (isOutOfLine() &&
2290 !(getCanonicalDecl()->isInline() &&
2291 getCanonicalDecl()->isConstexpr()) &&
2292 (hasInit() ||
2293 // If the first declaration is out-of-line, this may be an
2294 // instantiation of an out-of-line partial specialization of a variable
2295 // template for which we have not yet instantiated the initializer.
2296 (getFirstDecl()->isOutOfLine()
2297 ? getTemplateSpecializationKind() == TSK_Undeclared
2298 : getTemplateSpecializationKind() !=
2299 TSK_ExplicitSpecialization) ||
2300 isa<VarTemplatePartialSpecializationDecl>(Val: this)))
2301 return Definition;
2302 if (!isOutOfLine() && isInline())
2303 return Definition;
2304 return DeclarationOnly;
2305 }
2306 // C99 6.7p5:
2307 // A definition of an identifier is a declaration for that identifier that
2308 // [...] causes storage to be reserved for that object.
2309 // Note: that applies for all non-file-scope objects.
2310 // C99 6.9.2p1:
2311 // If the declaration of an identifier for an object has file scope and an
2312 // initializer, the declaration is an external definition for the identifier
2313 if (hasInit())
2314 return Definition;
2315
2316 if (hasDefiningAttr())
2317 return Definition;
2318
2319 if (const auto *SAA = getAttr<SelectAnyAttr>())
2320 if (!SAA->isInherited())
2321 return Definition;
2322
2323 // A variable template specialization (other than a static data member
2324 // template or an explicit specialization) is a declaration until we
2325 // instantiate its initializer.
2326 if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(Val: this)) {
2327 if (VTSD->getTemplateSpecializationKind() != TSK_ExplicitSpecialization &&
2328 !isa<VarTemplatePartialSpecializationDecl>(Val: VTSD) &&
2329 !VTSD->IsCompleteDefinition)
2330 return DeclarationOnly;
2331 }
2332
2333 if (hasExternalStorage())
2334 return DeclarationOnly;
2335
2336 // [dcl.link] p7:
2337 // A declaration directly contained in a linkage-specification is treated
2338 // as if it contains the extern specifier for the purpose of determining
2339 // the linkage of the declared name and whether it is a definition.
2340 if (isSingleLineLanguageLinkage(D: *this))
2341 return DeclarationOnly;
2342
2343 // C99 6.9.2p2:
2344 // A declaration of an object that has file scope without an initializer,
2345 // and without a storage class specifier or the scs 'static', constitutes
2346 // a tentative definition.
2347 // No such thing in C++.
2348 if (!C.getLangOpts().CPlusPlus && isFileVarDecl())
2349 return TentativeDefinition;
2350
2351 // What's left is (in C, block-scope) declarations without initializers or
2352 // external storage. These are definitions.
2353 return Definition;
2354}
2355
2356VarDecl *VarDecl::getActingDefinition() {
2357 DefinitionKind Kind = isThisDeclarationADefinition();
2358 if (Kind != TentativeDefinition)
2359 return nullptr;
2360
2361 VarDecl *LastTentative = nullptr;
2362
2363 // Loop through the declaration chain, starting with the most recent.
2364 for (VarDecl *Decl = getMostRecentDecl(); Decl;
2365 Decl = Decl->getPreviousDecl()) {
2366 Kind = Decl->isThisDeclarationADefinition();
2367 if (Kind == Definition)
2368 return nullptr;
2369 // Record the first (most recent) TentativeDefinition that is encountered.
2370 if (Kind == TentativeDefinition && !LastTentative)
2371 LastTentative = Decl;
2372 }
2373
2374 return LastTentative;
2375}
2376
2377VarDecl *VarDecl::getDefinition(ASTContext &C) {
2378 VarDecl *First = getFirstDecl();
2379 for (auto *I : First->redecls()) {
2380 if (I->isThisDeclarationADefinition(C) == Definition)
2381 return I;
2382 }
2383 return nullptr;
2384}
2385
2386VarDecl::DefinitionKind VarDecl::hasDefinition(ASTContext &C) const {
2387 DefinitionKind Kind = DeclarationOnly;
2388
2389 const VarDecl *First = getFirstDecl();
2390 for (auto *I : First->redecls()) {
2391 Kind = std::max(a: Kind, b: I->isThisDeclarationADefinition(C));
2392 if (Kind == Definition)
2393 break;
2394 }
2395
2396 return Kind;
2397}
2398
2399const Expr *VarDecl::getAnyInitializer(const VarDecl *&D) const {
2400 for (auto *I : redecls()) {
2401 if (auto Expr = I->getInit()) {
2402 D = I;
2403 return Expr;
2404 }
2405 }
2406 return nullptr;
2407}
2408
2409bool VarDecl::hasInit() const {
2410 if (auto *P = dyn_cast<ParmVarDecl>(Val: this))
2411 if (P->hasUnparsedDefaultArg() || P->hasUninstantiatedDefaultArg())
2412 return false;
2413
2414 if (auto *Eval = getEvaluatedStmt())
2415 return Eval->Value.isValid();
2416
2417 return !Init.isNull();
2418}
2419
2420Expr *VarDecl::getInit() {
2421 if (!hasInit())
2422 return nullptr;
2423
2424 if (auto *S = dyn_cast<Stmt *>(Val&: Init))
2425 return cast<Expr>(Val: S);
2426
2427 auto *Eval = getEvaluatedStmt();
2428
2429 return cast<Expr>(Val: Eval->Value.get(
2430 Source: Eval->Value.isOffset() ? getASTContext().getExternalSource() : nullptr));
2431}
2432
2433Stmt **VarDecl::getInitAddress() {
2434 if (auto *ES = Init.dyn_cast<EvaluatedStmt *>())
2435 return ES->Value.getAddressOfPointer(Source: getASTContext().getExternalSource());
2436
2437 return Init.getAddrOfPtr1();
2438}
2439
2440VarDecl *VarDecl::getInitializingDeclaration() {
2441 VarDecl *Def = nullptr;
2442 for (auto *I : redecls()) {
2443 if (I->hasInit())
2444 return I;
2445
2446 if (I->isThisDeclarationADefinition()) {
2447 if (isStaticDataMember())
2448 return I;
2449 Def = I;
2450 }
2451 }
2452 return Def;
2453}
2454
2455bool VarDecl::hasInitWithSideEffects() const {
2456 if (!hasInit())
2457 return false;
2458
2459 EvaluatedStmt *ES = ensureEvaluatedStmt();
2460 if (!ES->CheckedForSideEffects) {
2461 const Expr *E = getInit();
2462 ES->HasSideEffects =
2463 E->HasSideEffects(Ctx: getASTContext()) &&
2464 // We can get a value-dependent initializer during error recovery.
2465 (E->isValueDependent() || getType()->isDependentType() ||
2466 !evaluateValue());
2467 ES->CheckedForSideEffects = true;
2468 }
2469 return ES->HasSideEffects;
2470}
2471
2472bool VarDecl::isOutOfLine() const {
2473 if (Decl::isOutOfLine())
2474 return true;
2475
2476 if (!isStaticDataMember())
2477 return false;
2478
2479 // If this static data member was instantiated from a static data member of
2480 // a class template, check whether that static data member was defined
2481 // out-of-line.
2482 if (VarDecl *VD = getInstantiatedFromStaticDataMember())
2483 return VD->isOutOfLine();
2484
2485 return false;
2486}
2487
2488void VarDecl::setInit(Expr *I) {
2489 if (auto *Eval = dyn_cast_if_present<EvaluatedStmt *>(Val&: Init)) {
2490 Eval->~EvaluatedStmt();
2491 getASTContext().Deallocate(Ptr: Eval);
2492 }
2493
2494 Init = I;
2495}
2496
2497bool VarDecl::mightBeUsableInConstantExpressions(const ASTContext &C) const {
2498 const LangOptions &Lang = C.getLangOpts();
2499
2500 // OpenCL permits const integral variables to be used in constant
2501 // expressions, like in C++98.
2502 if (!Lang.CPlusPlus && !Lang.OpenCL && !Lang.C23)
2503 return false;
2504
2505 // Function parameters are never usable in constant expressions.
2506 if (isa<ParmVarDecl>(Val: this))
2507 return false;
2508
2509 // The values of weak variables are never usable in constant expressions.
2510 if (isWeak())
2511 return false;
2512
2513 // In C++11, any variable of reference type can be used in a constant
2514 // expression if it is initialized by a constant expression.
2515 if (Lang.CPlusPlus11 && getType()->isReferenceType())
2516 return true;
2517
2518 // Only const objects can be used in constant expressions in C++. C++98 does
2519 // not require the variable to be non-volatile, but we consider this to be a
2520 // defect.
2521 if (!getType().isConstant(Ctx: C) || getType().isVolatileQualified())
2522 return false;
2523
2524 // In C++, but not in C, const, non-volatile variables of integral or
2525 // enumeration types can be used in constant expressions.
2526 if (getType()->isIntegralOrEnumerationType() && !Lang.C23)
2527 return true;
2528
2529 // C23 6.6p7: An identifier that is:
2530 // ...
2531 // - declared with storage-class specifier constexpr and has an object type,
2532 // is a named constant, ... such a named constant is a constant expression
2533 // with the type and value of the declared object.
2534 // Additionally, in C++11, non-volatile constexpr variables can be used in
2535 // constant expressions.
2536 return (Lang.CPlusPlus11 || Lang.C23) && isConstexpr();
2537}
2538
2539bool VarDecl::isUsableInConstantExpressions(const ASTContext &Context) const {
2540 // C++2a [expr.const]p3:
2541 // A variable is usable in constant expressions after its initializing
2542 // declaration is encountered...
2543 const VarDecl *DefVD = nullptr;
2544 const Expr *Init = getAnyInitializer(D&: DefVD);
2545 if (!Init || Init->isValueDependent() || getType()->isDependentType())
2546 return false;
2547 // ... if it is a constexpr variable, or it is of reference type or of
2548 // const-qualified integral or enumeration type, ...
2549 if (!DefVD->mightBeUsableInConstantExpressions(C: Context))
2550 return false;
2551 // ... and its initializer is a constant initializer.
2552 if ((Context.getLangOpts().CPlusPlus || getLangOpts().C23) &&
2553 !DefVD->hasConstantInitialization())
2554 return false;
2555 // C++98 [expr.const]p1:
2556 // An integral constant-expression can involve only [...] const variables
2557 // or static data members of integral or enumeration types initialized with
2558 // [integer] constant expressions (dcl.init)
2559 if ((Context.getLangOpts().CPlusPlus || Context.getLangOpts().OpenCL) &&
2560 !Context.getLangOpts().CPlusPlus11 && !DefVD->hasICEInitializer(Context))
2561 return false;
2562 return true;
2563}
2564
2565/// Convert the initializer for this declaration to the elaborated EvaluatedStmt
2566/// form, which contains extra information on the evaluated value of the
2567/// initializer.
2568EvaluatedStmt *VarDecl::ensureEvaluatedStmt() const {
2569 auto *Eval = dyn_cast_if_present<EvaluatedStmt *>(Val&: Init);
2570 if (!Eval) {
2571 // Note: EvaluatedStmt contains an APValue, which usually holds
2572 // resources not allocated from the ASTContext. We need to do some
2573 // work to avoid leaking those, but we do so in VarDecl::evaluateValue
2574 // where we can detect whether there's anything to clean up or not.
2575 Eval = new (getASTContext()) EvaluatedStmt;
2576 Eval->Value = cast<Stmt *>(Val&: Init);
2577 Init = Eval;
2578 }
2579 return Eval;
2580}
2581
2582EvaluatedStmt *VarDecl::getEvaluatedStmt() const {
2583 return dyn_cast_if_present<EvaluatedStmt *>(Val&: Init);
2584}
2585
2586APValue *VarDecl::evaluateValue() const {
2587 SmallVector<PartialDiagnosticAt, 8> Notes;
2588 return evaluateValueImpl(Notes, IsConstantInitialization: hasConstantInitialization());
2589}
2590
2591APValue *VarDecl::evaluateValueImpl(SmallVectorImpl<PartialDiagnosticAt> &Notes,
2592 bool IsConstantInitialization) const {
2593 EvaluatedStmt *Eval = ensureEvaluatedStmt();
2594
2595 const auto *Init = getInit();
2596 assert(!Init->isValueDependent());
2597
2598 // We only produce notes indicating why an initializer is non-constant the
2599 // first time it is evaluated. FIXME: The notes won't always be emitted the
2600 // first time we try evaluation, so might not be produced at all.
2601 if (Eval->WasEvaluated)
2602 return Eval->Evaluated.isAbsent() ? nullptr : &Eval->Evaluated;
2603
2604 if (Eval->IsEvaluating) {
2605 // FIXME: Produce a diagnostic for self-initialization.
2606 return nullptr;
2607 }
2608
2609 Eval->IsEvaluating = true;
2610
2611 ASTContext &Ctx = getASTContext();
2612 bool Result = Init->EvaluateAsInitializer(Result&: Eval->Evaluated, Ctx, VD: this, Notes,
2613 IsConstantInitializer: IsConstantInitialization);
2614
2615 // In C++, or in C23 if we're initialising a 'constexpr' variable, this isn't
2616 // a constant initializer if we produced notes. In that case, we can't keep
2617 // the result, because it may only be correct under the assumption that the
2618 // initializer is a constant context.
2619 if (IsConstantInitialization &&
2620 (Ctx.getLangOpts().CPlusPlus ||
2621 (isConstexpr() && Ctx.getLangOpts().C23)) &&
2622 !Notes.empty())
2623 Result = false;
2624
2625 // Ensure the computed APValue is cleaned up later if evaluation succeeded,
2626 // or that it's empty (so that there's nothing to clean up) if evaluation
2627 // failed.
2628 if (!Result)
2629 Eval->Evaluated = APValue();
2630 else if (Eval->Evaluated.needsCleanup())
2631 Ctx.addDestruction(Ptr: &Eval->Evaluated);
2632
2633 Eval->IsEvaluating = false;
2634 Eval->WasEvaluated = true;
2635
2636 return Result ? &Eval->Evaluated : nullptr;
2637}
2638
2639APValue *VarDecl::getEvaluatedValue() const {
2640 if (EvaluatedStmt *Eval = getEvaluatedStmt())
2641 if (Eval->WasEvaluated)
2642 return &Eval->Evaluated;
2643
2644 return nullptr;
2645}
2646
2647bool VarDecl::hasICEInitializer(const ASTContext &Context) const {
2648 const Expr *Init = getInit();
2649 assert(Init && "no initializer");
2650
2651 EvaluatedStmt *Eval = ensureEvaluatedStmt();
2652 if (!Eval->CheckedForICEInit) {
2653 Eval->CheckedForICEInit = true;
2654 Eval->HasICEInit = Init->isIntegerConstantExpr(Ctx: Context);
2655 }
2656 return Eval->HasICEInit;
2657}
2658
2659bool VarDecl::hasConstantInitialization() const {
2660 // In C, all globals and constexpr variables should have constant
2661 // initialization. For constexpr variables in C check that initializer is a
2662 // constant initializer because they can be used in constant expressions.
2663 if (hasGlobalStorage() && !getASTContext().getLangOpts().CPlusPlus &&
2664 !isConstexpr())
2665 return true;
2666
2667 // In C++, it depends on whether the evaluation at the point of definition
2668 // was evaluatable as a constant initializer.
2669 if (EvaluatedStmt *Eval = getEvaluatedStmt())
2670 return Eval->HasConstantInitialization;
2671
2672 return false;
2673}
2674
2675bool VarDecl::checkForConstantInitialization(
2676 SmallVectorImpl<PartialDiagnosticAt> &Notes) const {
2677 EvaluatedStmt *Eval = ensureEvaluatedStmt();
2678 // If we ask for the value before we know whether we have a constant
2679 // initializer, we can compute the wrong value (for example, due to
2680 // std::is_constant_evaluated()).
2681 assert(!Eval->WasEvaluated &&
2682 "already evaluated var value before checking for constant init");
2683 assert((getASTContext().getLangOpts().CPlusPlus ||
2684 getASTContext().getLangOpts().C23) &&
2685 "only meaningful in C++/C23");
2686
2687 assert(!getInit()->isValueDependent());
2688
2689 // Evaluate the initializer to check whether it's a constant expression.
2690 Eval->HasConstantInitialization =
2691 evaluateValueImpl(Notes, IsConstantInitialization: true) && Notes.empty();
2692
2693 // If evaluation as a constant initializer failed, allow re-evaluation as a
2694 // non-constant initializer if we later find we want the value.
2695 if (!Eval->HasConstantInitialization)
2696 Eval->WasEvaluated = false;
2697
2698 return Eval->HasConstantInitialization;
2699}
2700
2701template<typename DeclT>
2702static DeclT *getDefinitionOrSelf(DeclT *D) {
2703 assert(D);
2704 if (auto *Def = D->getDefinition())
2705 return Def;
2706 return D;
2707}
2708
2709bool VarDecl::isEscapingByref() const {
2710 return hasAttr<BlocksAttr>() && NonParmVarDeclBits.EscapingByref;
2711}
2712
2713bool VarDecl::isNonEscapingByref() const {
2714 return hasAttr<BlocksAttr>() && !NonParmVarDeclBits.EscapingByref;
2715}
2716
2717bool VarDecl::hasDependentAlignment() const {
2718 QualType T = getType();
2719 return T->isDependentType() || T->isUndeducedType() ||
2720 llvm::any_of(Range: specific_attrs<AlignedAttr>(), P: [](const AlignedAttr *AA) {
2721 return AA->isAlignmentDependent();
2722 });
2723}
2724
2725VarDecl *VarDecl::getTemplateInstantiationPattern() const {
2726 const VarDecl *VD = this;
2727
2728 // If this is an instantiated member, walk back to the template from which
2729 // it was instantiated.
2730 if (MemberSpecializationInfo *MSInfo = VD->getMemberSpecializationInfo()) {
2731 if (isTemplateInstantiation(Kind: MSInfo->getTemplateSpecializationKind())) {
2732 VD = VD->getInstantiatedFromStaticDataMember();
2733 while (auto *NewVD = VD->getInstantiatedFromStaticDataMember())
2734 VD = NewVD;
2735 }
2736 }
2737
2738 // If it's an instantiated variable template specialization, find the
2739 // template or partial specialization from which it was instantiated.
2740 if (auto *VDTemplSpec = dyn_cast<VarTemplateSpecializationDecl>(Val: VD)) {
2741 if (isTemplateInstantiation(Kind: VDTemplSpec->getTemplateSpecializationKind())) {
2742 auto From = VDTemplSpec->getInstantiatedFrom();
2743 if (auto *VTD = From.dyn_cast<VarTemplateDecl *>()) {
2744 while (!VTD->isMemberSpecialization()) {
2745 auto *NewVTD = VTD->getInstantiatedFromMemberTemplate();
2746 if (!NewVTD)
2747 break;
2748 VTD = NewVTD;
2749 }
2750 return getDefinitionOrSelf(D: VTD->getTemplatedDecl());
2751 }
2752 if (auto *VTPSD =
2753 From.dyn_cast<VarTemplatePartialSpecializationDecl *>()) {
2754 while (!VTPSD->isMemberSpecialization()) {
2755 auto *NewVTPSD = VTPSD->getInstantiatedFromMember();
2756 if (!NewVTPSD)
2757 break;
2758 VTPSD = NewVTPSD;
2759 }
2760 return getDefinitionOrSelf<VarDecl>(D: VTPSD);
2761 }
2762 }
2763 }
2764
2765 // If this is the pattern of a variable template, find where it was
2766 // instantiated from. FIXME: Is this necessary?
2767 if (VarTemplateDecl *VarTemplate = VD->getDescribedVarTemplate()) {
2768 while (!VarTemplate->isMemberSpecialization()) {
2769 auto *NewVT = VarTemplate->getInstantiatedFromMemberTemplate();
2770 if (!NewVT)
2771 break;
2772 VarTemplate = NewVT;
2773 }
2774
2775 return getDefinitionOrSelf(D: VarTemplate->getTemplatedDecl());
2776 }
2777
2778 if (VD == this)
2779 return nullptr;
2780 return getDefinitionOrSelf(D: const_cast<VarDecl*>(VD));
2781}
2782
2783VarDecl *VarDecl::getInstantiatedFromStaticDataMember() const {
2784 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
2785 return cast<VarDecl>(Val: MSI->getInstantiatedFrom());
2786
2787 return nullptr;
2788}
2789
2790TemplateSpecializationKind VarDecl::getTemplateSpecializationKind() const {
2791 if (const auto *Spec = dyn_cast<VarTemplateSpecializationDecl>(Val: this))
2792 return Spec->getSpecializationKind();
2793
2794 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
2795 return MSI->getTemplateSpecializationKind();
2796
2797 return TSK_Undeclared;
2798}
2799
2800TemplateSpecializationKind
2801VarDecl::getTemplateSpecializationKindForInstantiation() const {
2802 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
2803 return MSI->getTemplateSpecializationKind();
2804
2805 if (const auto *Spec = dyn_cast<VarTemplateSpecializationDecl>(Val: this))
2806 return Spec->getSpecializationKind();
2807
2808 return TSK_Undeclared;
2809}
2810
2811SourceLocation VarDecl::getPointOfInstantiation() const {
2812 if (const auto *Spec = dyn_cast<VarTemplateSpecializationDecl>(Val: this))
2813 return Spec->getPointOfInstantiation();
2814
2815 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
2816 return MSI->getPointOfInstantiation();
2817
2818 return SourceLocation();
2819}
2820
2821VarTemplateDecl *VarDecl::getDescribedVarTemplate() const {
2822 return dyn_cast_if_present<VarTemplateDecl *>(
2823 Val: getASTContext().getTemplateOrSpecializationInfo(Var: this));
2824}
2825
2826void VarDecl::setDescribedVarTemplate(VarTemplateDecl *Template) {
2827 getASTContext().setTemplateOrSpecializationInfo(Inst: this, TSI: Template);
2828}
2829
2830bool VarDecl::isKnownToBeDefined() const {
2831 const auto &LangOpts = getASTContext().getLangOpts();
2832 // In CUDA mode without relocatable device code, variables of form 'extern
2833 // __shared__ Foo foo[]' are pointers to the base of the GPU core's shared
2834 // memory pool. These are never undefined variables, even if they appear
2835 // inside of an anon namespace or static function.
2836 //
2837 // With CUDA relocatable device code enabled, these variables don't get
2838 // special handling; they're treated like regular extern variables.
2839 if (LangOpts.CUDA && !LangOpts.GPURelocatableDeviceCode &&
2840 hasExternalStorage() && hasAttr<CUDASharedAttr>() &&
2841 isa<IncompleteArrayType>(Val: getType()))
2842 return true;
2843
2844 return hasDefinition();
2845}
2846
2847bool VarDecl::isNoDestroy(const ASTContext &Ctx) const {
2848 if (!hasGlobalStorage())
2849 return false;
2850 if (hasAttr<NoDestroyAttr>())
2851 return true;
2852 if (hasAttr<AlwaysDestroyAttr>())
2853 return false;
2854
2855 using RSDKind = LangOptions::RegisterStaticDestructorsKind;
2856 RSDKind K = Ctx.getLangOpts().getRegisterStaticDestructors();
2857 return K == RSDKind::None ||
2858 (K == RSDKind::ThreadLocal && getTLSKind() == TLS_None);
2859}
2860
2861QualType::DestructionKind
2862VarDecl::needsDestruction(const ASTContext &Ctx) const {
2863 if (EvaluatedStmt *Eval = getEvaluatedStmt())
2864 if (Eval->HasConstantDestruction)
2865 return QualType::DK_none;
2866
2867 if (isNoDestroy(Ctx))
2868 return QualType::DK_none;
2869
2870 return getType().isDestructedType();
2871}
2872
2873bool VarDecl::hasFlexibleArrayInit(const ASTContext &Ctx) const {
2874 assert(hasInit() && "Expect initializer to check for flexible array init");
2875 auto *D = getType()->getAsRecordDecl();
2876 if (!D || !D->hasFlexibleArrayMember())
2877 return false;
2878 auto *List = dyn_cast<InitListExpr>(Val: getInit()->IgnoreParens());
2879 if (!List)
2880 return false;
2881 const Expr *FlexibleInit = List->getInit(Init: List->getNumInits() - 1);
2882 auto InitTy = Ctx.getAsConstantArrayType(T: FlexibleInit->getType());
2883 if (!InitTy)
2884 return false;
2885 return !InitTy->isZeroSize();
2886}
2887
2888CharUnits VarDecl::getFlexibleArrayInitChars(const ASTContext &Ctx) const {
2889 assert(hasInit() && "Expect initializer to check for flexible array init");
2890 auto *RD = getType()->getAsRecordDecl();
2891 if (!RD || !RD->hasFlexibleArrayMember())
2892 return CharUnits::Zero();
2893 auto *List = dyn_cast<InitListExpr>(Val: getInit()->IgnoreParens());
2894 if (!List || List->getNumInits() == 0)
2895 return CharUnits::Zero();
2896 const Expr *FlexibleInit = List->getInit(Init: List->getNumInits() - 1);
2897 auto InitTy = Ctx.getAsConstantArrayType(T: FlexibleInit->getType());
2898 if (!InitTy)
2899 return CharUnits::Zero();
2900 CharUnits FlexibleArraySize = Ctx.getTypeSizeInChars(T: InitTy);
2901 const ASTRecordLayout &RL = Ctx.getASTRecordLayout(D: RD);
2902 CharUnits FlexibleArrayOffset =
2903 Ctx.toCharUnitsFromBits(BitSize: RL.getFieldOffset(FieldNo: RL.getFieldCount() - 1));
2904 if (FlexibleArrayOffset + FlexibleArraySize < RL.getSize())
2905 return CharUnits::Zero();
2906 return FlexibleArrayOffset + FlexibleArraySize - RL.getSize();
2907}
2908
2909MemberSpecializationInfo *VarDecl::getMemberSpecializationInfo() const {
2910 if (isStaticDataMember())
2911 // FIXME: Remove ?
2912 // return getASTContext().getInstantiatedFromStaticDataMember(this);
2913 return dyn_cast_if_present<MemberSpecializationInfo *>(
2914 Val: getASTContext().getTemplateOrSpecializationInfo(Var: this));
2915 return nullptr;
2916}
2917
2918void VarDecl::setTemplateSpecializationKind(TemplateSpecializationKind TSK,
2919 SourceLocation PointOfInstantiation) {
2920 assert((isa<VarTemplateSpecializationDecl>(this) ||
2921 getMemberSpecializationInfo()) &&
2922 "not a variable or static data member template specialization");
2923
2924 if (VarTemplateSpecializationDecl *Spec =
2925 dyn_cast<VarTemplateSpecializationDecl>(Val: this)) {
2926 Spec->setSpecializationKind(TSK);
2927 if (TSK != TSK_ExplicitSpecialization &&
2928 PointOfInstantiation.isValid() &&
2929 Spec->getPointOfInstantiation().isInvalid()) {
2930 Spec->setPointOfInstantiation(PointOfInstantiation);
2931 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
2932 L->InstantiationRequested(D: this);
2933 }
2934 } else if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo()) {
2935 MSI->setTemplateSpecializationKind(TSK);
2936 if (TSK != TSK_ExplicitSpecialization && PointOfInstantiation.isValid() &&
2937 MSI->getPointOfInstantiation().isInvalid()) {
2938 MSI->setPointOfInstantiation(PointOfInstantiation);
2939 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
2940 L->InstantiationRequested(D: this);
2941 }
2942 }
2943}
2944
2945void
2946VarDecl::setInstantiationOfStaticDataMember(VarDecl *VD,
2947 TemplateSpecializationKind TSK) {
2948 assert(getASTContext().getTemplateOrSpecializationInfo(this).isNull() &&
2949 "Previous template or instantiation?");
2950 getASTContext().setInstantiatedFromStaticDataMember(Inst: this, Tmpl: VD, TSK);
2951}
2952
2953//===----------------------------------------------------------------------===//
2954// ParmVarDecl Implementation
2955//===----------------------------------------------------------------------===//
2956
2957ParmVarDecl *ParmVarDecl::Create(ASTContext &C, DeclContext *DC,
2958 SourceLocation StartLoc, SourceLocation IdLoc,
2959 const IdentifierInfo *Id, QualType T,
2960 TypeSourceInfo *TInfo, StorageClass S,
2961 Expr *DefArg) {
2962 return new (C, DC) ParmVarDecl(ParmVar, C, DC, StartLoc, IdLoc, Id, T, TInfo,
2963 S, DefArg);
2964}
2965
2966QualType ParmVarDecl::getOriginalType() const {
2967 TypeSourceInfo *TSI = getTypeSourceInfo();
2968 QualType T = TSI ? TSI->getType() : getType();
2969 if (const auto *DT = dyn_cast<DecayedType>(Val&: T))
2970 return DT->getOriginalType();
2971 return T;
2972}
2973
2974ParmVarDecl *ParmVarDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
2975 return new (C, ID)
2976 ParmVarDecl(ParmVar, C, nullptr, SourceLocation(), SourceLocation(),
2977 nullptr, QualType(), nullptr, SC_None, nullptr);
2978}
2979
2980SourceRange ParmVarDecl::getSourceRange() const {
2981 if (!hasInheritedDefaultArg()) {
2982 SourceRange ArgRange = getDefaultArgRange();
2983 if (ArgRange.isValid())
2984 return SourceRange(getOuterLocStart(), ArgRange.getEnd());
2985 }
2986
2987 // DeclaratorDecl considers the range of postfix types as overlapping with the
2988 // declaration name, but this is not the case with parameters in ObjC methods.
2989 if (isa<ObjCMethodDecl>(Val: getDeclContext()))
2990 return SourceRange(DeclaratorDecl::getBeginLoc(), getLocation());
2991
2992 return DeclaratorDecl::getSourceRange();
2993}
2994
2995bool ParmVarDecl::isDestroyedInCallee() const {
2996 // ns_consumed only affects code generation in ARC
2997 if (hasAttr<NSConsumedAttr>())
2998 return getASTContext().getLangOpts().ObjCAutoRefCount;
2999
3000 // FIXME: isParamDestroyedInCallee() should probably imply
3001 // isDestructedType()
3002 const auto *RT = getType()->getAsCanonical<RecordType>();
3003 if (RT && RT->getDecl()->getDefinitionOrSelf()->isParamDestroyedInCallee() &&
3004 getType().isDestructedType())
3005 return true;
3006
3007 return false;
3008}
3009
3010Expr *ParmVarDecl::getDefaultArg() {
3011 assert(!hasUnparsedDefaultArg() && "Default argument is not yet parsed!");
3012 assert(!hasUninstantiatedDefaultArg() &&
3013 "Default argument is not yet instantiated!");
3014
3015 Expr *Arg = getInit();
3016 if (auto *E = dyn_cast_if_present<FullExpr>(Val: Arg))
3017 return E->getSubExpr();
3018
3019 return Arg;
3020}
3021
3022void ParmVarDecl::setDefaultArg(Expr *defarg) {
3023 ParmVarDeclBits.DefaultArgKind = DAK_Normal;
3024 Init = defarg;
3025}
3026
3027SourceRange ParmVarDecl::getDefaultArgRange() const {
3028 switch (ParmVarDeclBits.DefaultArgKind) {
3029 case DAK_None:
3030 case DAK_Unparsed:
3031 // Nothing we can do here.
3032 return SourceRange();
3033
3034 case DAK_Uninstantiated:
3035 return getUninstantiatedDefaultArg()->getSourceRange();
3036
3037 case DAK_Normal:
3038 if (const Expr *E = getInit())
3039 return E->getSourceRange();
3040
3041 // Missing an actual expression, may be invalid.
3042 return SourceRange();
3043 }
3044 llvm_unreachable("Invalid default argument kind.");
3045}
3046
3047void ParmVarDecl::setUninstantiatedDefaultArg(Expr *arg) {
3048 ParmVarDeclBits.DefaultArgKind = DAK_Uninstantiated;
3049 Init = arg;
3050}
3051
3052Expr *ParmVarDecl::getUninstantiatedDefaultArg() {
3053 assert(hasUninstantiatedDefaultArg() &&
3054 "Wrong kind of initialization expression!");
3055 return cast_if_present<Expr>(Val: cast<Stmt *>(Val&: Init));
3056}
3057
3058bool ParmVarDecl::hasDefaultArg() const {
3059 // FIXME: We should just return false for DAK_None here once callers are
3060 // prepared for the case that we encountered an invalid default argument and
3061 // were unable to even build an invalid expression.
3062 return hasUnparsedDefaultArg() || hasUninstantiatedDefaultArg() ||
3063 !Init.isNull();
3064}
3065
3066void ParmVarDecl::setParameterIndexLarge(unsigned parameterIndex) {
3067 getASTContext().setParameterIndex(D: this, index: parameterIndex);
3068 ParmVarDeclBits.ParameterIndex = ParameterIndexSentinel;
3069}
3070
3071unsigned ParmVarDecl::getParameterIndexLarge() const {
3072 return getASTContext().getParameterIndex(D: this);
3073}
3074
3075//===----------------------------------------------------------------------===//
3076// FunctionDecl Implementation
3077//===----------------------------------------------------------------------===//
3078
3079FunctionDecl::FunctionDecl(Kind DK, ASTContext &C, DeclContext *DC,
3080 SourceLocation StartLoc,
3081 const DeclarationNameInfo &NameInfo, QualType T,
3082 TypeSourceInfo *TInfo, StorageClass S,
3083 bool UsesFPIntrin, bool isInlineSpecified,
3084 ConstexprSpecKind ConstexprKind,
3085 const AssociatedConstraint &TrailingRequiresClause)
3086 : DeclaratorDecl(DK, DC, NameInfo.getLoc(), NameInfo.getName(), T, TInfo,
3087 StartLoc),
3088 DeclContext(DK), redeclarable_base(C), Body(), ODRHash(0),
3089 EndRangeLoc(NameInfo.getEndLoc()), DNLoc(NameInfo.getInfo()) {
3090 assert(T.isNull() || T->isFunctionType());
3091 FunctionDeclBits.SClass = S;
3092 FunctionDeclBits.IsInline = isInlineSpecified;
3093 FunctionDeclBits.IsInlineSpecified = isInlineSpecified;
3094 FunctionDeclBits.IsVirtualAsWritten = false;
3095 FunctionDeclBits.IsPureVirtual = false;
3096 FunctionDeclBits.HasInheritedPrototype = false;
3097 FunctionDeclBits.HasWrittenPrototype = true;
3098 FunctionDeclBits.IsDeleted = false;
3099 FunctionDeclBits.IsTrivial = false;
3100 FunctionDeclBits.IsTrivialForCall = false;
3101 FunctionDeclBits.IsDefaulted = false;
3102 FunctionDeclBits.IsExplicitlyDefaulted = false;
3103 FunctionDeclBits.HasDefaultedOrDeletedInfo = false;
3104 FunctionDeclBits.IsIneligibleOrNotSelected = false;
3105 FunctionDeclBits.HasImplicitReturnZero = false;
3106 FunctionDeclBits.IsLateTemplateParsed = false;
3107 FunctionDeclBits.IsInstantiatedFromMemberTemplate = false;
3108 FunctionDeclBits.ConstexprKind = static_cast<uint64_t>(ConstexprKind);
3109 FunctionDeclBits.BodyContainsImmediateEscalatingExpression = false;
3110 FunctionDeclBits.InstantiationIsPending = false;
3111 FunctionDeclBits.UsesSEHTry = false;
3112 FunctionDeclBits.UsesFPIntrin = UsesFPIntrin;
3113 FunctionDeclBits.HasSkippedBody = false;
3114 FunctionDeclBits.WillHaveBody = false;
3115 FunctionDeclBits.IsMultiVersion = false;
3116 FunctionDeclBits.DeductionCandidateKind =
3117 static_cast<unsigned char>(DeductionCandidate::Normal);
3118 FunctionDeclBits.HasODRHash = false;
3119 FunctionDeclBits.FriendConstraintRefersToEnclosingTemplate = false;
3120
3121 if (TrailingRequiresClause)
3122 setTrailingRequiresClause(TrailingRequiresClause);
3123}
3124
3125void FunctionDecl::getNameForDiagnostic(
3126 raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const {
3127 NamedDecl::getNameForDiagnostic(OS, Policy, Qualified);
3128 const TemplateArgumentList *TemplateArgs = getTemplateSpecializationArgs();
3129 if (TemplateArgs)
3130 printTemplateArgumentList(OS, Args: TemplateArgs->asArray(), Policy);
3131}
3132
3133bool FunctionDecl::isVariadic() const {
3134 if (const auto *FT = getType()->getAs<FunctionProtoType>())
3135 return FT->isVariadic();
3136 return false;
3137}
3138
3139FunctionDecl::DefaultedOrDeletedFunctionInfo *
3140FunctionDecl::DefaultedOrDeletedFunctionInfo::Create(
3141 ASTContext &Context, ArrayRef<DeclAccessPair> Lookups,
3142 StringLiteral *DeletedMessage) {
3143 static constexpr size_t Alignment =
3144 std::max(l: {alignof(DefaultedOrDeletedFunctionInfo),
3145 alignof(DeclAccessPair), alignof(StringLiteral *)});
3146 size_t Size = totalSizeToAlloc<DeclAccessPair, StringLiteral *>(
3147 Counts: Lookups.size(), Counts: DeletedMessage != nullptr);
3148
3149 DefaultedOrDeletedFunctionInfo *Info =
3150 new (Context.Allocate(Size, Align: Alignment)) DefaultedOrDeletedFunctionInfo;
3151 Info->NumLookups = Lookups.size();
3152 Info->HasDeletedMessage = DeletedMessage != nullptr;
3153
3154 llvm::uninitialized_copy(Src&: Lookups, Dst: Info->getTrailingObjects<DeclAccessPair>());
3155 if (DeletedMessage)
3156 *Info->getTrailingObjects<StringLiteral *>() = DeletedMessage;
3157 return Info;
3158}
3159
3160void FunctionDecl::setDefaultedOrDeletedInfo(
3161 DefaultedOrDeletedFunctionInfo *Info) {
3162 assert(!FunctionDeclBits.HasDefaultedOrDeletedInfo && "already have this");
3163 assert(!Body && "can't replace function body with defaulted function info");
3164
3165 FunctionDeclBits.HasDefaultedOrDeletedInfo = true;
3166 DefaultedOrDeletedInfo = Info;
3167}
3168
3169void FunctionDecl::setDeletedAsWritten(bool D, StringLiteral *Message) {
3170 FunctionDeclBits.IsDeleted = D;
3171
3172 if (Message) {
3173 assert(isDeletedAsWritten() && "Function must be deleted");
3174 if (FunctionDeclBits.HasDefaultedOrDeletedInfo)
3175 DefaultedOrDeletedInfo->setDeletedMessage(Message);
3176 else
3177 setDefaultedOrDeletedInfo(DefaultedOrDeletedFunctionInfo::Create(
3178 Context&: getASTContext(), /*Lookups=*/{}, DeletedMessage: Message));
3179 }
3180}
3181
3182void FunctionDecl::DefaultedOrDeletedFunctionInfo::setDeletedMessage(
3183 StringLiteral *Message) {
3184 // We should never get here with the DefaultedOrDeletedInfo populated, but
3185 // no space allocated for the deleted message, since that would require
3186 // recreating this, but setDefaultedOrDeletedInfo() disallows overwriting
3187 // an already existing DefaultedOrDeletedFunctionInfo.
3188 assert(HasDeletedMessage &&
3189 "No space to store a delete message in this DefaultedOrDeletedInfo");
3190 *getTrailingObjects<StringLiteral *>() = Message;
3191}
3192
3193FunctionDecl::DefaultedOrDeletedFunctionInfo *
3194FunctionDecl::getDefaultedOrDeletedInfo() const {
3195 return FunctionDeclBits.HasDefaultedOrDeletedInfo ? DefaultedOrDeletedInfo
3196 : nullptr;
3197}
3198
3199bool FunctionDecl::hasBody(const FunctionDecl *&Definition) const {
3200 for (const auto *I : redecls()) {
3201 if (I->doesThisDeclarationHaveABody()) {
3202 Definition = I;
3203 return true;
3204 }
3205 }
3206
3207 return false;
3208}
3209
3210bool FunctionDecl::hasTrivialBody() const {
3211 const Stmt *S = getBody();
3212 if (!S) {
3213 // Since we don't have a body for this function, we don't know if it's
3214 // trivial or not.
3215 return false;
3216 }
3217
3218 if (isa<CompoundStmt>(Val: S) && cast<CompoundStmt>(Val: S)->body_empty())
3219 return true;
3220 return false;
3221}
3222
3223bool FunctionDecl::isThisDeclarationInstantiatedFromAFriendDefinition() const {
3224 if (!getFriendObjectKind())
3225 return false;
3226
3227 // Check for a friend function instantiated from a friend function
3228 // definition in a templated class.
3229 if (const FunctionDecl *InstantiatedFrom =
3230 getInstantiatedFromMemberFunction())
3231 return InstantiatedFrom->getFriendObjectKind() &&
3232 InstantiatedFrom->isThisDeclarationADefinition();
3233
3234 // Check for a friend function template instantiated from a friend
3235 // function template definition in a templated class.
3236 if (const FunctionTemplateDecl *Template = getDescribedFunctionTemplate()) {
3237 if (const FunctionTemplateDecl *InstantiatedFrom =
3238 Template->getInstantiatedFromMemberTemplate())
3239 return InstantiatedFrom->getFriendObjectKind() &&
3240 InstantiatedFrom->isThisDeclarationADefinition();
3241 }
3242
3243 return false;
3244}
3245
3246bool FunctionDecl::isDefined(const FunctionDecl *&Definition,
3247 bool CheckForPendingFriendDefinition) const {
3248 for (const FunctionDecl *FD : redecls()) {
3249 if (FD->isThisDeclarationADefinition()) {
3250 Definition = FD;
3251 return true;
3252 }
3253
3254 // If this is a friend function defined in a class template, it does not
3255 // have a body until it is used, nevertheless it is a definition, see
3256 // [temp.inst]p2:
3257 //
3258 // ... for the purpose of determining whether an instantiated redeclaration
3259 // is valid according to [basic.def.odr] and [class.mem], a declaration that
3260 // corresponds to a definition in the template is considered to be a
3261 // definition.
3262 //
3263 // The following code must produce redefinition error:
3264 //
3265 // template<typename T> struct C20 { friend void func_20() {} };
3266 // C20<int> c20i;
3267 // void func_20() {}
3268 //
3269 if (CheckForPendingFriendDefinition &&
3270 FD->isThisDeclarationInstantiatedFromAFriendDefinition()) {
3271 Definition = FD;
3272 return true;
3273 }
3274 }
3275
3276 return false;
3277}
3278
3279Stmt *FunctionDecl::getBody(const FunctionDecl *&Definition) const {
3280 if (!hasBody(Definition))
3281 return nullptr;
3282
3283 assert(!Definition->FunctionDeclBits.HasDefaultedOrDeletedInfo &&
3284 "definition should not have a body");
3285 if (Definition->Body)
3286 return Definition->Body.get(Source: getASTContext().getExternalSource());
3287
3288 return nullptr;
3289}
3290
3291void FunctionDecl::setBody(Stmt *B) {
3292 FunctionDeclBits.HasDefaultedOrDeletedInfo = false;
3293 Body = LazyDeclStmtPtr(B);
3294 if (B)
3295 EndRangeLoc = B->getEndLoc();
3296}
3297
3298void FunctionDecl::setIsPureVirtual(bool P) {
3299 FunctionDeclBits.IsPureVirtual = P;
3300 if (P)
3301 if (auto *Parent = dyn_cast<CXXRecordDecl>(Val: getDeclContext()))
3302 Parent->markedVirtualFunctionPure();
3303}
3304
3305template<std::size_t Len>
3306static bool isNamed(const NamedDecl *ND, const char (&Str)[Len]) {
3307 const IdentifierInfo *II = ND->getIdentifier();
3308 return II && II->isStr(Str);
3309}
3310
3311bool FunctionDecl::isImmediateEscalating() const {
3312 // C++23 [expr.const]/p17
3313 // An immediate-escalating function is
3314 // - the call operator of a lambda that is not declared with the consteval
3315 // specifier,
3316 if (isLambdaCallOperator(DC: this) && !isConsteval())
3317 return true;
3318 // - a defaulted special member function that is not declared with the
3319 // consteval specifier,
3320 if (isDefaulted() && !isConsteval())
3321 return true;
3322
3323 if (auto *CD = dyn_cast<CXXConstructorDecl>(Val: this);
3324 CD && CD->isInheritingConstructor())
3325 return CD->getInheritedConstructor().getConstructor();
3326
3327 // Destructors are not immediate escalating.
3328 if (isa<CXXDestructorDecl>(Val: this))
3329 return false;
3330
3331 // - a function that results from the instantiation of a templated entity
3332 // defined with the constexpr specifier.
3333 TemplatedKind TK = getTemplatedKind();
3334 if (TK != TK_NonTemplate && TK != TK_DependentNonTemplate &&
3335 isConstexprSpecified())
3336 return true;
3337 return false;
3338}
3339
3340bool FunctionDecl::isImmediateFunction() const {
3341 // C++23 [expr.const]/p18
3342 // An immediate function is a function or constructor that is
3343 // - declared with the consteval specifier
3344 if (isConsteval())
3345 return true;
3346 // - an immediate-escalating function F whose function body contains an
3347 // immediate-escalating expression
3348 if (isImmediateEscalating() && BodyContainsImmediateEscalatingExpressions())
3349 return true;
3350
3351 if (auto *CD = dyn_cast<CXXConstructorDecl>(Val: this);
3352 CD && CD->isInheritingConstructor())
3353 return CD->getInheritedConstructor()
3354 .getConstructor()
3355 ->isImmediateFunction();
3356
3357 if (FunctionDecl *P = getTemplateInstantiationPattern();
3358 P && P->isImmediateFunction())
3359 return true;
3360
3361 if (const auto *MD = dyn_cast<CXXMethodDecl>(Val: this);
3362 MD && MD->isLambdaStaticInvoker())
3363 return MD->getParent()->getLambdaCallOperator()->isImmediateFunction();
3364
3365 return false;
3366}
3367
3368bool FunctionDecl::isMain() const {
3369 return isNamed(ND: this, Str: "main") && !getLangOpts().Freestanding &&
3370 !getLangOpts().HLSL &&
3371 (getDeclContext()->getRedeclContext()->isTranslationUnit() ||
3372 isExternC());
3373}
3374
3375bool FunctionDecl::isMSVCRTEntryPoint() const {
3376 const TranslationUnitDecl *TUnit =
3377 dyn_cast<TranslationUnitDecl>(Val: getDeclContext()->getRedeclContext());
3378 if (!TUnit)
3379 return false;
3380
3381 // Even though we aren't really targeting MSVCRT if we are freestanding,
3382 // semantic analysis for these functions remains the same.
3383
3384 // MSVCRT entry points only exist on MSVCRT targets.
3385 if (!TUnit->getASTContext().getTargetInfo().getTriple().isOSMSVCRT() &&
3386 !TUnit->getASTContext().getTargetInfo().getTriple().isUEFI())
3387 return false;
3388
3389 // Nameless functions like constructors cannot be entry points.
3390 if (!getIdentifier())
3391 return false;
3392
3393 return llvm::StringSwitch<bool>(getName())
3394 .Cases(CaseStrings: {"main", // an ANSI console app
3395 "wmain", // a Unicode console App
3396 "WinMain", // an ANSI GUI app
3397 "wWinMain", // a Unicode GUI app
3398 "DllMain"}, // a DLL
3399 Value: true)
3400 .Default(Value: false);
3401}
3402
3403bool FunctionDecl::isReservedGlobalPlacementOperator() const {
3404 if (!getDeclName().isAnyOperatorNewOrDelete())
3405 return false;
3406
3407 if (!getDeclContext()->getRedeclContext()->isTranslationUnit())
3408 return false;
3409
3410 if (isTypeAwareOperatorNewOrDelete())
3411 return false;
3412
3413 const auto *proto = getType()->castAs<FunctionProtoType>();
3414 if (proto->getNumParams() != 2 || proto->isVariadic())
3415 return false;
3416
3417 const ASTContext &Context =
3418 cast<TranslationUnitDecl>(Val: getDeclContext()->getRedeclContext())
3419 ->getASTContext();
3420
3421 // The result type and first argument type are constant across all
3422 // these operators. The second argument must be exactly void*.
3423 return (proto->getParamType(i: 1).getCanonicalType() == Context.VoidPtrTy);
3424}
3425
3426bool FunctionDecl::isUsableAsGlobalAllocationFunctionInConstantEvaluation(
3427 UnsignedOrNone *AlignmentParam, bool *IsNothrow) const {
3428 if (!getDeclName().isAnyOperatorNewOrDelete())
3429 return false;
3430
3431 if (isa<CXXRecordDecl>(Val: getDeclContext()))
3432 return false;
3433
3434 // This can only fail for an invalid 'operator new' declaration.
3435 if (!getDeclContext()->getRedeclContext()->isTranslationUnit())
3436 return false;
3437
3438 if (isVariadic())
3439 return false;
3440
3441 if (isTypeAwareOperatorNewOrDelete()) {
3442 bool IsDelete = getDeclName().isAnyOperatorDelete();
3443 unsigned RequiredParameterCount =
3444 IsDelete ? FunctionDecl::RequiredTypeAwareDeleteParameterCount
3445 : FunctionDecl::RequiredTypeAwareNewParameterCount;
3446 if (AlignmentParam)
3447 *AlignmentParam =
3448 /* type identity */ 1U + /* address */ IsDelete + /* size */ 1U;
3449 if (RequiredParameterCount == getNumParams())
3450 return true;
3451 if (getNumParams() > RequiredParameterCount + 1)
3452 return false;
3453 if (!getParamDecl(i: RequiredParameterCount)->getType()->isNothrowT())
3454 return false;
3455
3456 if (IsNothrow)
3457 *IsNothrow = true;
3458 return true;
3459 }
3460
3461 const auto *FPT = getType()->castAs<FunctionProtoType>();
3462 if (FPT->getNumParams() == 0 || FPT->getNumParams() > 4)
3463 return false;
3464
3465 // If this is a single-parameter function, it must be a replaceable global
3466 // allocation or deallocation function.
3467 if (FPT->getNumParams() == 1)
3468 return true;
3469
3470 unsigned Params = 1;
3471 QualType Ty = FPT->getParamType(i: Params);
3472 const ASTContext &Ctx = getASTContext();
3473
3474 auto Consume = [&] {
3475 ++Params;
3476 Ty = Params < FPT->getNumParams() ? FPT->getParamType(i: Params) : QualType();
3477 };
3478
3479 // In C++14, the next parameter can be a 'std::size_t' for sized delete.
3480 bool IsSizedDelete = false;
3481 if (Ctx.getLangOpts().SizedDeallocation &&
3482 getDeclName().isAnyOperatorDelete() &&
3483 Ctx.hasSameType(T1: Ty, T2: Ctx.getSizeType())) {
3484 IsSizedDelete = true;
3485 Consume();
3486 }
3487
3488 // In C++17, the next parameter can be a 'std::align_val_t' for aligned
3489 // new/delete.
3490 if (Ctx.getLangOpts().AlignedAllocation && !Ty.isNull() && Ty->isAlignValT()) {
3491 Consume();
3492 if (AlignmentParam)
3493 *AlignmentParam = Params;
3494 }
3495
3496 // If this is not a sized delete, the next parameter can be a
3497 // 'const std::nothrow_t&'.
3498 if (!IsSizedDelete && !Ty.isNull() && Ty->isReferenceType()) {
3499 Ty = Ty->getPointeeType();
3500 if (Ty.getCVRQualifiers() != Qualifiers::Const)
3501 return false;
3502 if (Ty->isNothrowT()) {
3503 if (IsNothrow)
3504 *IsNothrow = true;
3505 Consume();
3506 }
3507 }
3508
3509 // Finally, recognize the not yet standard versions of new that take a
3510 // hot/cold allocation hint (__hot_cold_t). These are currently supported by
3511 // tcmalloc (see
3512 // https://github.com/google/tcmalloc/blob/220043886d4e2efff7a5702d5172cb8065253664/tcmalloc/malloc_extension.h#L53).
3513 if (!IsSizedDelete && !Ty.isNull() && Ty->isEnumeralType()) {
3514 QualType T = Ty;
3515 while (const auto *TD = T->getAs<TypedefType>())
3516 T = TD->getDecl()->getUnderlyingType();
3517 const IdentifierInfo *II =
3518 T->castAsCanonical<EnumType>()->getDecl()->getIdentifier();
3519 if (II && II->isStr(Str: "__hot_cold_t"))
3520 Consume();
3521 }
3522
3523 return Params == FPT->getNumParams();
3524}
3525
3526bool FunctionDecl::isInlineBuiltinDeclaration() const {
3527 if (!getBuiltinID())
3528 return false;
3529
3530 const FunctionDecl *Definition;
3531 if (!hasBody(Definition))
3532 return false;
3533
3534 if (!Definition->isInlineSpecified() ||
3535 !Definition->hasAttr<AlwaysInlineAttr>())
3536 return false;
3537
3538 ASTContext &Context = getASTContext();
3539 switch (Context.GetGVALinkageForFunction(FD: Definition)) {
3540 case GVA_Internal:
3541 case GVA_DiscardableODR:
3542 case GVA_StrongODR:
3543 return false;
3544 case GVA_AvailableExternally:
3545 case GVA_StrongExternal:
3546 return true;
3547 }
3548 llvm_unreachable("Unknown GVALinkage");
3549}
3550
3551bool FunctionDecl::isDestroyingOperatorDelete() const {
3552 return getASTContext().isDestroyingOperatorDelete(FD: this);
3553}
3554
3555void FunctionDecl::setIsDestroyingOperatorDelete(bool IsDestroyingDelete) {
3556 getASTContext().setIsDestroyingOperatorDelete(FD: this, IsDestroying: IsDestroyingDelete);
3557}
3558
3559bool FunctionDecl::isTypeAwareOperatorNewOrDelete() const {
3560 return getASTContext().isTypeAwareOperatorNewOrDelete(FD: this);
3561}
3562
3563void FunctionDecl::setIsTypeAwareOperatorNewOrDelete(bool IsTypeAware) {
3564 getASTContext().setIsTypeAwareOperatorNewOrDelete(FD: this, IsTypeAware);
3565}
3566
3567UsualDeleteParams FunctionDecl::getUsualDeleteParams() const {
3568 UsualDeleteParams Params;
3569
3570 // This function should only be called for operator delete declarations.
3571 assert(getDeclName().isAnyOperatorDelete());
3572 if (!getDeclName().isAnyOperatorDelete())
3573 return Params;
3574
3575 const FunctionProtoType *FPT = getType()->castAs<FunctionProtoType>();
3576 auto AI = FPT->param_type_begin(), AE = FPT->param_type_end();
3577
3578 if (isTypeAwareOperatorNewOrDelete()) {
3579 Params.TypeAwareDelete = TypeAwareAllocationMode::Yes;
3580 assert(AI != AE);
3581 ++AI;
3582 }
3583
3584 // The first argument after the type-identity parameter (if any) is
3585 // always a void* (or C* for a destroying operator delete for class
3586 // type C).
3587 ++AI;
3588
3589 // The next parameter may be a std::destroying_delete_t.
3590 if (isDestroyingOperatorDelete()) {
3591 assert(!isTypeAwareAllocation(Params.TypeAwareDelete));
3592 Params.DestroyingDelete = true;
3593 assert(AI != AE);
3594 ++AI;
3595 }
3596
3597 // Figure out what other parameters we should be implicitly passing.
3598 if (AI != AE && (*AI)->isIntegerType()) {
3599 Params.Size = true;
3600 ++AI;
3601 } else
3602 assert(!isTypeAwareAllocation(Params.TypeAwareDelete));
3603
3604 if (AI != AE && (*AI)->isAlignValT()) {
3605 Params.Alignment = AlignedAllocationMode::Yes;
3606 ++AI;
3607 } else
3608 assert(!isTypeAwareAllocation(Params.TypeAwareDelete));
3609
3610 assert(AI == AE && "unexpected usual deallocation function parameter");
3611 return Params;
3612}
3613
3614LanguageLinkage FunctionDecl::getLanguageLinkage() const {
3615 return getDeclLanguageLinkage(D: *this);
3616}
3617
3618bool FunctionDecl::isExternC() const {
3619 return isDeclExternC(D: *this);
3620}
3621
3622bool FunctionDecl::isInExternCContext() const {
3623 if (DeviceKernelAttr::isOpenCLSpelling(A: getAttr<DeviceKernelAttr>()))
3624 return true;
3625 return getLexicalDeclContext()->isExternCContext();
3626}
3627
3628bool FunctionDecl::isInExternCXXContext() const {
3629 return getLexicalDeclContext()->isExternCXXContext();
3630}
3631
3632bool FunctionDecl::isGlobal() const {
3633 if (const auto *Method = dyn_cast<CXXMethodDecl>(Val: this))
3634 return Method->isStatic();
3635
3636 if (getCanonicalDecl()->getStorageClass() == SC_Static)
3637 return false;
3638
3639 for (const DeclContext *DC = getDeclContext();
3640 DC->isNamespace();
3641 DC = DC->getParent()) {
3642 if (const auto *Namespace = cast<NamespaceDecl>(Val: DC)) {
3643 if (!Namespace->getDeclName())
3644 return false;
3645 }
3646 }
3647
3648 return true;
3649}
3650
3651bool FunctionDecl::isNoReturn() const {
3652 if (hasAttr<NoReturnAttr>() || hasAttr<CXX11NoReturnAttr>() ||
3653 hasAttr<C11NoReturnAttr>())
3654 return true;
3655
3656 if (auto *FnTy = getType()->getAs<FunctionType>())
3657 return FnTy->getNoReturnAttr();
3658
3659 return false;
3660}
3661
3662bool FunctionDecl::isAnalyzerNoReturn() const {
3663 return hasAttr<AnalyzerNoReturnAttr>();
3664}
3665
3666bool FunctionDecl::isMemberLikeConstrainedFriend() const {
3667 // C++20 [temp.friend]p9:
3668 // A non-template friend declaration with a requires-clause [or]
3669 // a friend function template with a constraint that depends on a template
3670 // parameter from an enclosing template [...] does not declare the same
3671 // function or function template as a declaration in any other scope.
3672
3673 // If this isn't a friend then it's not a member-like constrained friend.
3674 if (!getFriendObjectKind()) {
3675 return false;
3676 }
3677
3678 if (!getDescribedFunctionTemplate()) {
3679 // If these friends don't have constraints, they aren't constrained, and
3680 // thus don't fall under temp.friend p9. Else the simple presence of a
3681 // constraint makes them unique.
3682 return !getTrailingRequiresClause().isNull();
3683 }
3684
3685 return FriendConstraintRefersToEnclosingTemplate();
3686}
3687
3688MultiVersionKind FunctionDecl::getMultiVersionKind() const {
3689 if (hasAttr<TargetAttr>())
3690 return MultiVersionKind::Target;
3691 if (hasAttr<TargetVersionAttr>())
3692 return MultiVersionKind::TargetVersion;
3693 if (hasAttr<CPUDispatchAttr>())
3694 return MultiVersionKind::CPUDispatch;
3695 if (hasAttr<CPUSpecificAttr>())
3696 return MultiVersionKind::CPUSpecific;
3697 if (hasAttr<TargetClonesAttr>())
3698 return MultiVersionKind::TargetClones;
3699 return MultiVersionKind::None;
3700}
3701
3702bool FunctionDecl::isCPUDispatchMultiVersion() const {
3703 return isMultiVersion() && hasAttr<CPUDispatchAttr>();
3704}
3705
3706bool FunctionDecl::isCPUSpecificMultiVersion() const {
3707 return isMultiVersion() && hasAttr<CPUSpecificAttr>();
3708}
3709
3710bool FunctionDecl::isTargetMultiVersion() const {
3711 return isMultiVersion() &&
3712 (hasAttr<TargetAttr>() || hasAttr<TargetVersionAttr>());
3713}
3714
3715bool FunctionDecl::isTargetMultiVersionDefault() const {
3716 if (!isMultiVersion())
3717 return false;
3718 if (hasAttr<TargetAttr>())
3719 return getAttr<TargetAttr>()->isDefaultVersion();
3720 return hasAttr<TargetVersionAttr>() &&
3721 getAttr<TargetVersionAttr>()->isDefaultVersion();
3722}
3723
3724bool FunctionDecl::isTargetClonesMultiVersion() const {
3725 return isMultiVersion() && hasAttr<TargetClonesAttr>();
3726}
3727
3728bool FunctionDecl::isTargetVersionMultiVersion() const {
3729 return isMultiVersion() && hasAttr<TargetVersionAttr>();
3730}
3731
3732void
3733FunctionDecl::setPreviousDeclaration(FunctionDecl *PrevDecl) {
3734 redeclarable_base::setPreviousDecl(PrevDecl);
3735
3736 if (FunctionTemplateDecl *FunTmpl = getDescribedFunctionTemplate()) {
3737 FunctionTemplateDecl *PrevFunTmpl
3738 = PrevDecl? PrevDecl->getDescribedFunctionTemplate() : nullptr;
3739 assert((!PrevDecl || PrevFunTmpl) && "Function/function template mismatch");
3740 FunTmpl->setPreviousDecl(PrevFunTmpl);
3741 }
3742
3743 if (PrevDecl && PrevDecl->isInlined())
3744 setImplicitlyInline(true);
3745}
3746
3747FunctionDecl *FunctionDecl::getCanonicalDecl() { return getFirstDecl(); }
3748
3749/// Returns a value indicating whether this function corresponds to a builtin
3750/// function.
3751///
3752/// The function corresponds to a built-in function if it is declared at
3753/// translation scope or within an extern "C" block and its name matches with
3754/// the name of a builtin. The returned value will be 0 for functions that do
3755/// not correspond to a builtin, a value of type \c Builtin::ID if in the
3756/// target-independent range \c [1,Builtin::First), or a target-specific builtin
3757/// value.
3758///
3759/// \param ConsiderWrapperFunctions If true, we should consider wrapper
3760/// functions as their wrapped builtins. This shouldn't be done in general, but
3761/// it's useful in Sema to diagnose calls to wrappers based on their semantics.
3762unsigned FunctionDecl::getBuiltinID(bool ConsiderWrapperFunctions) const {
3763 unsigned BuiltinID = 0;
3764
3765 if (const auto *ABAA = getAttr<ArmBuiltinAliasAttr>()) {
3766 BuiltinID = ABAA->getBuiltinName()->getBuiltinID();
3767 } else if (const auto *BAA = getAttr<BuiltinAliasAttr>()) {
3768 BuiltinID = BAA->getBuiltinName()->getBuiltinID();
3769 } else if (const auto *A = getAttr<BuiltinAttr>()) {
3770 BuiltinID = A->getID();
3771 }
3772
3773 if (!BuiltinID)
3774 return 0;
3775
3776 // If the function is marked "overloadable", it has a different mangled name
3777 // and is not the C library function.
3778 if (!ConsiderWrapperFunctions && hasAttr<OverloadableAttr>() &&
3779 (!hasAttr<ArmBuiltinAliasAttr>() && !hasAttr<BuiltinAliasAttr>()))
3780 return 0;
3781
3782 if (getASTContext().getLangOpts().CPlusPlus &&
3783 BuiltinID == Builtin::BI__builtin_counted_by_ref)
3784 return 0;
3785
3786 const ASTContext &Context = getASTContext();
3787 if (!Context.BuiltinInfo.isPredefinedLibFunction(ID: BuiltinID))
3788 return BuiltinID;
3789
3790 // This function has the name of a known C library
3791 // function. Determine whether it actually refers to the C library
3792 // function or whether it just has the same name.
3793
3794 // If this is a static function, it's not a builtin.
3795 if (!ConsiderWrapperFunctions && getStorageClass() == SC_Static)
3796 return 0;
3797
3798 // OpenCL v1.2 s6.9.f - The library functions defined in
3799 // the C99 standard headers are not available.
3800 if (Context.getLangOpts().OpenCL &&
3801 Context.BuiltinInfo.isPredefinedLibFunction(ID: BuiltinID))
3802 return 0;
3803
3804 // CUDA does not have device-side standard library. printf and malloc are the
3805 // only special cases that are supported by device-side runtime.
3806 if (Context.getLangOpts().CUDA && hasAttr<CUDADeviceAttr>() &&
3807 !hasAttr<CUDAHostAttr>() &&
3808 !(BuiltinID == Builtin::BIprintf || BuiltinID == Builtin::BImalloc))
3809 return 0;
3810
3811 // As AMDGCN implementation of OpenMP does not have a device-side standard
3812 // library, none of the predefined library functions except printf and malloc
3813 // should be treated as a builtin i.e. 0 should be returned for them.
3814 if (Context.getTargetInfo().getTriple().isAMDGCN() &&
3815 Context.getLangOpts().OpenMPIsTargetDevice &&
3816 Context.BuiltinInfo.isPredefinedLibFunction(ID: BuiltinID) &&
3817 !(BuiltinID == Builtin::BIprintf || BuiltinID == Builtin::BImalloc))
3818 return 0;
3819
3820 return BuiltinID;
3821}
3822
3823/// getNumParams - Return the number of parameters this function must have
3824/// based on its FunctionType. This is the length of the ParamInfo array
3825/// after it has been created.
3826unsigned FunctionDecl::getNumParams() const {
3827 const auto *FPT = getType()->getAs<FunctionProtoType>();
3828 return FPT ? FPT->getNumParams() : 0;
3829}
3830
3831void FunctionDecl::setParams(ASTContext &C,
3832 ArrayRef<ParmVarDecl *> NewParamInfo) {
3833 assert(!ParamInfo && "Already has param info!");
3834 assert(NewParamInfo.size() == getNumParams() && "Parameter count mismatch!");
3835
3836 // Zero params -> null pointer.
3837 if (!NewParamInfo.empty()) {
3838 ParamInfo = new (C) ParmVarDecl*[NewParamInfo.size()];
3839 llvm::copy(Range&: NewParamInfo, Out: ParamInfo);
3840 }
3841}
3842
3843/// getMinRequiredArguments - Returns the minimum number of arguments
3844/// needed to call this function. This may be fewer than the number of
3845/// function parameters, if some of the parameters have default
3846/// arguments (in C++) or are parameter packs (C++11).
3847unsigned FunctionDecl::getMinRequiredArguments() const {
3848 if (!getASTContext().getLangOpts().CPlusPlus)
3849 return getNumParams();
3850
3851 // Note that it is possible for a parameter with no default argument to
3852 // follow a parameter with a default argument.
3853 unsigned NumRequiredArgs = 0;
3854 unsigned MinParamsSoFar = 0;
3855 for (auto *Param : parameters()) {
3856 if (!Param->isParameterPack()) {
3857 ++MinParamsSoFar;
3858 if (!Param->hasDefaultArg())
3859 NumRequiredArgs = MinParamsSoFar;
3860 }
3861 }
3862 return NumRequiredArgs;
3863}
3864
3865bool FunctionDecl::hasCXXExplicitFunctionObjectParameter() const {
3866 return getNumParams() != 0 && getParamDecl(i: 0)->isExplicitObjectParameter();
3867}
3868
3869unsigned FunctionDecl::getNumNonObjectParams() const {
3870 return getNumParams() -
3871 static_cast<unsigned>(hasCXXExplicitFunctionObjectParameter());
3872}
3873
3874unsigned FunctionDecl::getMinRequiredExplicitArguments() const {
3875 return getMinRequiredArguments() -
3876 static_cast<unsigned>(hasCXXExplicitFunctionObjectParameter());
3877}
3878
3879bool FunctionDecl::hasOneParamOrDefaultArgs() const {
3880 return getNumParams() == 1 ||
3881 (getNumParams() > 1 &&
3882 llvm::all_of(Range: llvm::drop_begin(RangeOrContainer: parameters()),
3883 P: [](ParmVarDecl *P) { return P->hasDefaultArg(); }));
3884}
3885
3886/// The combination of the extern and inline keywords under MSVC forces
3887/// the function to be required.
3888///
3889/// Note: This function assumes that we will only get called when isInlined()
3890/// would return true for this FunctionDecl.
3891bool FunctionDecl::isMSExternInline() const {
3892 assert(isInlined() && "expected to get called on an inlined function!");
3893
3894 const ASTContext &Context = getASTContext();
3895 if (!Context.getTargetInfo().getCXXABI().isMicrosoft() &&
3896 !hasAttr<DLLExportAttr>())
3897 return false;
3898
3899 for (const FunctionDecl *FD = getMostRecentDecl(); FD;
3900 FD = FD->getPreviousDecl())
3901 if (!FD->isImplicit() && FD->getStorageClass() == SC_Extern)
3902 return true;
3903
3904 return false;
3905}
3906
3907static bool redeclForcesDefMSVC(const FunctionDecl *Redecl) {
3908 if (Redecl->getStorageClass() != SC_Extern)
3909 return false;
3910
3911 for (const FunctionDecl *FD = Redecl->getPreviousDecl(); FD;
3912 FD = FD->getPreviousDecl())
3913 if (!FD->isImplicit() && FD->getStorageClass() == SC_Extern)
3914 return false;
3915
3916 return true;
3917}
3918
3919static bool RedeclForcesDefC99(const FunctionDecl *Redecl) {
3920 // Only consider file-scope declarations in this test.
3921 if (!Redecl->getLexicalDeclContext()->isTranslationUnit())
3922 return false;
3923
3924 // Only consider explicit declarations; the presence of a builtin for a
3925 // libcall shouldn't affect whether a definition is externally visible.
3926 if (Redecl->isImplicit())
3927 return false;
3928
3929 if (!Redecl->isInlineSpecified() || Redecl->getStorageClass() == SC_Extern)
3930 return true; // Not an inline definition
3931
3932 return false;
3933}
3934
3935/// For a function declaration in C or C++, determine whether this
3936/// declaration causes the definition to be externally visible.
3937///
3938/// For instance, this determines if adding the current declaration to the set
3939/// of redeclarations of the given functions causes
3940/// isInlineDefinitionExternallyVisible to change from false to true.
3941bool FunctionDecl::doesDeclarationForceExternallyVisibleDefinition() const {
3942 assert(!doesThisDeclarationHaveABody() &&
3943 "Must have a declaration without a body.");
3944
3945 const ASTContext &Context = getASTContext();
3946
3947 if (Context.getLangOpts().MSVCCompat) {
3948 const FunctionDecl *Definition;
3949 if (hasBody(Definition) && Definition->isInlined() &&
3950 redeclForcesDefMSVC(Redecl: this))
3951 return true;
3952 }
3953
3954 if (Context.getLangOpts().CPlusPlus)
3955 return false;
3956
3957 if (Context.getLangOpts().GNUInline || hasAttr<GNUInlineAttr>()) {
3958 // With GNU inlining, a declaration with 'inline' but not 'extern', forces
3959 // an externally visible definition.
3960 //
3961 // FIXME: What happens if gnu_inline gets added on after the first
3962 // declaration?
3963 if (!isInlineSpecified() || getStorageClass() == SC_Extern)
3964 return false;
3965
3966 const FunctionDecl *Prev = this;
3967 bool FoundBody = false;
3968 while ((Prev = Prev->getPreviousDecl())) {
3969 FoundBody |= Prev->doesThisDeclarationHaveABody();
3970
3971 if (Prev->doesThisDeclarationHaveABody()) {
3972 // If it's not the case that both 'inline' and 'extern' are
3973 // specified on the definition, then it is always externally visible.
3974 if (!Prev->isInlineSpecified() ||
3975 Prev->getStorageClass() != SC_Extern)
3976 return false;
3977 } else if (Prev->isInlineSpecified() &&
3978 Prev->getStorageClass() != SC_Extern) {
3979 return false;
3980 }
3981 }
3982 return FoundBody;
3983 }
3984
3985 // C99 6.7.4p6:
3986 // [...] If all of the file scope declarations for a function in a
3987 // translation unit include the inline function specifier without extern,
3988 // then the definition in that translation unit is an inline definition.
3989 if (isInlineSpecified() && getStorageClass() != SC_Extern)
3990 return false;
3991 const FunctionDecl *Prev = this;
3992 bool FoundBody = false;
3993 while ((Prev = Prev->getPreviousDecl())) {
3994 FoundBody |= Prev->doesThisDeclarationHaveABody();
3995 if (RedeclForcesDefC99(Redecl: Prev))
3996 return false;
3997 }
3998 return FoundBody;
3999}
4000
4001FunctionTypeLoc FunctionDecl::getFunctionTypeLoc() const {
4002 const TypeSourceInfo *TSI = getTypeSourceInfo();
4003
4004 if (!TSI)
4005 return FunctionTypeLoc();
4006
4007 TypeLoc TL = TSI->getTypeLoc();
4008 FunctionTypeLoc FTL;
4009
4010 while (!(FTL = TL.getAs<FunctionTypeLoc>())) {
4011 if (const auto PTL = TL.getAs<ParenTypeLoc>())
4012 TL = PTL.getInnerLoc();
4013 else if (const auto ATL = TL.getAs<AttributedTypeLoc>())
4014 TL = ATL.getEquivalentTypeLoc();
4015 else if (const auto MQTL = TL.getAs<MacroQualifiedTypeLoc>())
4016 TL = MQTL.getInnerLoc();
4017 else
4018 break;
4019 }
4020
4021 return FTL;
4022}
4023
4024SourceRange FunctionDecl::getReturnTypeSourceRange() const {
4025 FunctionTypeLoc FTL = getFunctionTypeLoc();
4026 if (!FTL)
4027 return SourceRange();
4028
4029 // Skip self-referential return types.
4030 const SourceManager &SM = getASTContext().getSourceManager();
4031 SourceRange RTRange = FTL.getReturnLoc().getSourceRange();
4032 SourceLocation Boundary = getNameInfo().getBeginLoc();
4033 if (RTRange.isInvalid() || Boundary.isInvalid() ||
4034 !SM.isBeforeInTranslationUnit(LHS: RTRange.getEnd(), RHS: Boundary))
4035 return SourceRange();
4036
4037 return RTRange;
4038}
4039
4040SourceRange FunctionDecl::getParametersSourceRange() const {
4041 unsigned NP = getNumParams();
4042 SourceLocation EllipsisLoc = getEllipsisLoc();
4043
4044 if (NP == 0 && EllipsisLoc.isInvalid())
4045 return SourceRange();
4046
4047 SourceLocation Begin =
4048 NP > 0 ? ParamInfo[0]->getSourceRange().getBegin() : EllipsisLoc;
4049 SourceLocation End = EllipsisLoc.isValid()
4050 ? EllipsisLoc
4051 : ParamInfo[NP - 1]->getSourceRange().getEnd();
4052
4053 return SourceRange(Begin, End);
4054}
4055
4056SourceRange FunctionDecl::getExceptionSpecSourceRange() const {
4057 FunctionTypeLoc FTL = getFunctionTypeLoc();
4058 return FTL ? FTL.getExceptionSpecRange() : SourceRange();
4059}
4060
4061/// For an inline function definition in C, or for a gnu_inline function
4062/// in C++, determine whether the definition will be externally visible.
4063///
4064/// Inline function definitions are always available for inlining optimizations.
4065/// However, depending on the language dialect, declaration specifiers, and
4066/// attributes, the definition of an inline function may or may not be
4067/// "externally" visible to other translation units in the program.
4068///
4069/// In C99, inline definitions are not externally visible by default. However,
4070/// if even one of the global-scope declarations is marked "extern inline", the
4071/// inline definition becomes externally visible (C99 6.7.4p6).
4072///
4073/// In GNU89 mode, or if the gnu_inline attribute is attached to the function
4074/// definition, we use the GNU semantics for inline, which are nearly the
4075/// opposite of C99 semantics. In particular, "inline" by itself will create
4076/// an externally visible symbol, but "extern inline" will not create an
4077/// externally visible symbol.
4078bool FunctionDecl::isInlineDefinitionExternallyVisible() const {
4079 assert((doesThisDeclarationHaveABody() || willHaveBody() ||
4080 hasAttr<AliasAttr>()) &&
4081 "Must be a function definition");
4082 assert(isInlined() && "Function must be inline");
4083 ASTContext &Context = getASTContext();
4084
4085 if (Context.getLangOpts().GNUInline || hasAttr<GNUInlineAttr>()) {
4086 // Note: If you change the logic here, please change
4087 // doesDeclarationForceExternallyVisibleDefinition as well.
4088 //
4089 // If it's not the case that both 'inline' and 'extern' are
4090 // specified on the definition, then this inline definition is
4091 // externally visible.
4092 if (Context.getLangOpts().CPlusPlus)
4093 return false;
4094 if (!(isInlineSpecified() && getStorageClass() == SC_Extern))
4095 return true;
4096
4097 // If any declaration is 'inline' but not 'extern', then this definition
4098 // is externally visible.
4099 for (auto *Redecl : redecls()) {
4100 if (Redecl->isInlineSpecified() &&
4101 Redecl->getStorageClass() != SC_Extern)
4102 return true;
4103 }
4104
4105 return false;
4106 }
4107
4108 // The rest of this function is C-only.
4109 assert(!Context.getLangOpts().CPlusPlus &&
4110 "should not use C inline rules in C++");
4111
4112 // C99 6.7.4p6:
4113 // [...] If all of the file scope declarations for a function in a
4114 // translation unit include the inline function specifier without extern,
4115 // then the definition in that translation unit is an inline definition.
4116 for (auto *Redecl : redecls()) {
4117 if (RedeclForcesDefC99(Redecl))
4118 return true;
4119 }
4120
4121 // C99 6.7.4p6:
4122 // An inline definition does not provide an external definition for the
4123 // function, and does not forbid an external definition in another
4124 // translation unit.
4125 return false;
4126}
4127
4128/// getOverloadedOperator - Which C++ overloaded operator this
4129/// function represents, if any.
4130OverloadedOperatorKind FunctionDecl::getOverloadedOperator() const {
4131 if (getDeclName().getNameKind() == DeclarationName::CXXOperatorName)
4132 return getDeclName().getCXXOverloadedOperator();
4133 return OO_None;
4134}
4135
4136/// getLiteralIdentifier - The literal suffix identifier this function
4137/// represents, if any.
4138const IdentifierInfo *FunctionDecl::getLiteralIdentifier() const {
4139 if (getDeclName().getNameKind() == DeclarationName::CXXLiteralOperatorName)
4140 return getDeclName().getCXXLiteralIdentifier();
4141 return nullptr;
4142}
4143
4144FunctionDecl::TemplatedKind FunctionDecl::getTemplatedKind() const {
4145 if (TemplateOrSpecialization.isNull())
4146 return TK_NonTemplate;
4147 if (const auto *ND = dyn_cast<NamedDecl *>(Val: TemplateOrSpecialization)) {
4148 if (isa<FunctionDecl>(Val: ND))
4149 return TK_DependentNonTemplate;
4150 assert(isa<FunctionTemplateDecl>(ND) &&
4151 "No other valid types in NamedDecl");
4152 return TK_FunctionTemplate;
4153 }
4154 if (isa<MemberSpecializationInfo *>(Val: TemplateOrSpecialization))
4155 return TK_MemberSpecialization;
4156 if (isa<FunctionTemplateSpecializationInfo *>(Val: TemplateOrSpecialization))
4157 return TK_FunctionTemplateSpecialization;
4158 if (isa<DependentFunctionTemplateSpecializationInfo *>(
4159 Val: TemplateOrSpecialization))
4160 return TK_DependentFunctionTemplateSpecialization;
4161
4162 llvm_unreachable("Did we miss a TemplateOrSpecialization type?");
4163}
4164
4165FunctionDecl *FunctionDecl::getInstantiatedFromMemberFunction() const {
4166 if (MemberSpecializationInfo *Info = getMemberSpecializationInfo())
4167 return cast<FunctionDecl>(Val: Info->getInstantiatedFrom());
4168
4169 return nullptr;
4170}
4171
4172MemberSpecializationInfo *FunctionDecl::getMemberSpecializationInfo() const {
4173 if (auto *MSI = dyn_cast_if_present<MemberSpecializationInfo *>(
4174 Val: TemplateOrSpecialization))
4175 return MSI;
4176 if (auto *FTSI = dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4177 Val: TemplateOrSpecialization))
4178 return FTSI->getMemberSpecializationInfo();
4179 return nullptr;
4180}
4181
4182void
4183FunctionDecl::setInstantiationOfMemberFunction(ASTContext &C,
4184 FunctionDecl *FD,
4185 TemplateSpecializationKind TSK) {
4186 assert(TemplateOrSpecialization.isNull() &&
4187 "Member function is already a specialization");
4188 MemberSpecializationInfo *Info
4189 = new (C) MemberSpecializationInfo(FD, TSK);
4190 TemplateOrSpecialization = Info;
4191}
4192
4193FunctionTemplateDecl *FunctionDecl::getDescribedFunctionTemplate() const {
4194 return dyn_cast_if_present<FunctionTemplateDecl>(
4195 Val: dyn_cast_if_present<NamedDecl *>(Val: TemplateOrSpecialization));
4196}
4197
4198void FunctionDecl::setDescribedFunctionTemplate(
4199 FunctionTemplateDecl *Template) {
4200 assert(TemplateOrSpecialization.isNull() &&
4201 "Member function is already a specialization");
4202 TemplateOrSpecialization = Template;
4203}
4204
4205bool FunctionDecl::isFunctionTemplateSpecialization() const {
4206 return isa<FunctionTemplateSpecializationInfo *>(Val: TemplateOrSpecialization) ||
4207 isa<DependentFunctionTemplateSpecializationInfo *>(
4208 Val: TemplateOrSpecialization);
4209}
4210
4211void FunctionDecl::setInstantiatedFromDecl(FunctionDecl *FD) {
4212 assert(TemplateOrSpecialization.isNull() &&
4213 "Function is already a specialization");
4214 TemplateOrSpecialization = FD;
4215}
4216
4217FunctionDecl *FunctionDecl::getInstantiatedFromDecl() const {
4218 return dyn_cast_if_present<FunctionDecl>(
4219 Val: TemplateOrSpecialization.dyn_cast<NamedDecl *>());
4220}
4221
4222bool FunctionDecl::isImplicitlyInstantiable() const {
4223 // If the function is invalid, it can't be implicitly instantiated.
4224 if (isInvalidDecl())
4225 return false;
4226
4227 switch (getTemplateSpecializationKindForInstantiation()) {
4228 case TSK_Undeclared:
4229 case TSK_ExplicitInstantiationDefinition:
4230 case TSK_ExplicitSpecialization:
4231 return false;
4232
4233 case TSK_ImplicitInstantiation:
4234 return true;
4235
4236 case TSK_ExplicitInstantiationDeclaration:
4237 // Handled below.
4238 break;
4239 }
4240
4241 // Find the actual template from which we will instantiate.
4242 const FunctionDecl *PatternDecl = getTemplateInstantiationPattern();
4243 bool HasPattern = false;
4244 if (PatternDecl)
4245 HasPattern = PatternDecl->hasBody(Definition&: PatternDecl);
4246
4247 // C++0x [temp.explicit]p9:
4248 // Except for inline functions, other explicit instantiation declarations
4249 // have the effect of suppressing the implicit instantiation of the entity
4250 // to which they refer.
4251 if (!HasPattern || !PatternDecl)
4252 return true;
4253
4254 return PatternDecl->isInlined();
4255}
4256
4257bool FunctionDecl::isTemplateInstantiation() const {
4258 // FIXME: Remove this, it's not clear what it means. (Which template
4259 // specialization kind?)
4260 return clang::isTemplateInstantiation(Kind: getTemplateSpecializationKind());
4261}
4262
4263FunctionDecl *
4264FunctionDecl::getTemplateInstantiationPattern(bool ForDefinition) const {
4265 // If this is a generic lambda call operator specialization, its
4266 // instantiation pattern is always its primary template's pattern
4267 // even if its primary template was instantiated from another
4268 // member template (which happens with nested generic lambdas).
4269 // Since a lambda's call operator's body is transformed eagerly,
4270 // we don't have to go hunting for a prototype definition template
4271 // (i.e. instantiated-from-member-template) to use as an instantiation
4272 // pattern.
4273
4274 if (isGenericLambdaCallOperatorSpecialization(
4275 MD: dyn_cast<CXXMethodDecl>(Val: this))) {
4276 assert(getPrimaryTemplate() && "not a generic lambda call operator?");
4277 return getDefinitionOrSelf(D: getPrimaryTemplate()->getTemplatedDecl());
4278 }
4279
4280 // Check for a declaration of this function that was instantiated from a
4281 // friend definition.
4282 const FunctionDecl *FD = nullptr;
4283 if (!isDefined(Definition&: FD, /*CheckForPendingFriendDefinition=*/true))
4284 FD = this;
4285
4286 if (MemberSpecializationInfo *Info = FD->getMemberSpecializationInfo()) {
4287 if (ForDefinition &&
4288 !clang::isTemplateInstantiation(Kind: Info->getTemplateSpecializationKind()))
4289 return nullptr;
4290 return getDefinitionOrSelf(D: cast<FunctionDecl>(Val: Info->getInstantiatedFrom()));
4291 }
4292
4293 if (ForDefinition &&
4294 !clang::isTemplateInstantiation(Kind: getTemplateSpecializationKind()))
4295 return nullptr;
4296
4297 if (FunctionTemplateDecl *Primary = getPrimaryTemplate()) {
4298 // If we hit a point where the user provided a specialization of this
4299 // template, we're done looking.
4300 while (!ForDefinition || !Primary->isMemberSpecialization()) {
4301 auto *NewPrimary = Primary->getInstantiatedFromMemberTemplate();
4302 if (!NewPrimary)
4303 break;
4304 Primary = NewPrimary;
4305 }
4306
4307 return getDefinitionOrSelf(D: Primary->getTemplatedDecl());
4308 }
4309
4310 return nullptr;
4311}
4312
4313FunctionTemplateDecl *FunctionDecl::getPrimaryTemplate() const {
4314 if (FunctionTemplateSpecializationInfo *Info =
4315 dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4316 Val: TemplateOrSpecialization)) {
4317 return Info->getTemplate();
4318 }
4319 return nullptr;
4320}
4321
4322FunctionTemplateSpecializationInfo *
4323FunctionDecl::getTemplateSpecializationInfo() const {
4324 return dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4325 Val: TemplateOrSpecialization);
4326}
4327
4328const TemplateArgumentList *
4329FunctionDecl::getTemplateSpecializationArgs() const {
4330 if (FunctionTemplateSpecializationInfo *Info =
4331 dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4332 Val: TemplateOrSpecialization)) {
4333 return Info->TemplateArguments;
4334 }
4335 return nullptr;
4336}
4337
4338const ASTTemplateArgumentListInfo *
4339FunctionDecl::getTemplateSpecializationArgsAsWritten() const {
4340 if (FunctionTemplateSpecializationInfo *Info =
4341 dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4342 Val: TemplateOrSpecialization)) {
4343 return Info->TemplateArgumentsAsWritten;
4344 }
4345 if (DependentFunctionTemplateSpecializationInfo *Info =
4346 dyn_cast_if_present<DependentFunctionTemplateSpecializationInfo *>(
4347 Val: TemplateOrSpecialization)) {
4348 return Info->TemplateArgumentsAsWritten;
4349 }
4350 return nullptr;
4351}
4352
4353void FunctionDecl::setFunctionTemplateSpecialization(
4354 ASTContext &C, FunctionTemplateDecl *Template,
4355 TemplateArgumentList *TemplateArgs, void *InsertPos,
4356 TemplateSpecializationKind TSK,
4357 const TemplateArgumentListInfo *TemplateArgsAsWritten,
4358 SourceLocation PointOfInstantiation) {
4359 assert((TemplateOrSpecialization.isNull() ||
4360 isa<MemberSpecializationInfo *>(TemplateOrSpecialization)) &&
4361 "Member function is already a specialization");
4362 assert(TSK != TSK_Undeclared &&
4363 "Must specify the type of function template specialization");
4364 assert((TemplateOrSpecialization.isNull() ||
4365 getFriendObjectKind() != FOK_None ||
4366 TSK == TSK_ExplicitSpecialization) &&
4367 "Member specialization must be an explicit specialization");
4368 FunctionTemplateSpecializationInfo *Info =
4369 FunctionTemplateSpecializationInfo::Create(
4370 C, FD: this, Template, TSK, TemplateArgs, TemplateArgsAsWritten,
4371 POI: PointOfInstantiation,
4372 MSInfo: dyn_cast_if_present<MemberSpecializationInfo *>(
4373 Val&: TemplateOrSpecialization));
4374 TemplateOrSpecialization = Info;
4375 Template->addSpecialization(Info, InsertPos);
4376}
4377
4378void FunctionDecl::setDependentTemplateSpecialization(
4379 ASTContext &Context, const UnresolvedSetImpl &Templates,
4380 const TemplateArgumentListInfo *TemplateArgs) {
4381 assert(TemplateOrSpecialization.isNull());
4382 DependentFunctionTemplateSpecializationInfo *Info =
4383 DependentFunctionTemplateSpecializationInfo::Create(Context, Candidates: Templates,
4384 TemplateArgs);
4385 TemplateOrSpecialization = Info;
4386}
4387
4388DependentFunctionTemplateSpecializationInfo *
4389FunctionDecl::getDependentSpecializationInfo() const {
4390 return dyn_cast_if_present<DependentFunctionTemplateSpecializationInfo *>(
4391 Val: TemplateOrSpecialization);
4392}
4393
4394DependentFunctionTemplateSpecializationInfo *
4395DependentFunctionTemplateSpecializationInfo::Create(
4396 ASTContext &Context, const UnresolvedSetImpl &Candidates,
4397 const TemplateArgumentListInfo *TArgs) {
4398 const auto *TArgsWritten =
4399 TArgs ? ASTTemplateArgumentListInfo::Create(C: Context, List: *TArgs) : nullptr;
4400 return new (Context.Allocate(
4401 Size: totalSizeToAlloc<FunctionTemplateDecl *>(Counts: Candidates.size())))
4402 DependentFunctionTemplateSpecializationInfo(Candidates, TArgsWritten);
4403}
4404
4405DependentFunctionTemplateSpecializationInfo::
4406 DependentFunctionTemplateSpecializationInfo(
4407 const UnresolvedSetImpl &Candidates,
4408 const ASTTemplateArgumentListInfo *TemplateArgsWritten)
4409 : NumCandidates(Candidates.size()),
4410 TemplateArgumentsAsWritten(TemplateArgsWritten) {
4411 std::transform(first: Candidates.begin(), last: Candidates.end(), result: getTrailingObjects(),
4412 unary_op: [](NamedDecl *ND) {
4413 return cast<FunctionTemplateDecl>(Val: ND->getUnderlyingDecl());
4414 });
4415}
4416
4417TemplateSpecializationKind FunctionDecl::getTemplateSpecializationKind() const {
4418 // For a function template specialization, query the specialization
4419 // information object.
4420 if (FunctionTemplateSpecializationInfo *FTSInfo =
4421 dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4422 Val: TemplateOrSpecialization))
4423 return FTSInfo->getTemplateSpecializationKind();
4424
4425 if (MemberSpecializationInfo *MSInfo =
4426 dyn_cast_if_present<MemberSpecializationInfo *>(
4427 Val: TemplateOrSpecialization))
4428 return MSInfo->getTemplateSpecializationKind();
4429
4430 // A dependent function template specialization is an explicit specialization,
4431 // except when it's a friend declaration.
4432 if (isa<DependentFunctionTemplateSpecializationInfo *>(
4433 Val: TemplateOrSpecialization) &&
4434 getFriendObjectKind() == FOK_None)
4435 return TSK_ExplicitSpecialization;
4436
4437 return TSK_Undeclared;
4438}
4439
4440TemplateSpecializationKind
4441FunctionDecl::getTemplateSpecializationKindForInstantiation() const {
4442 // This is the same as getTemplateSpecializationKind(), except that for a
4443 // function that is both a function template specialization and a member
4444 // specialization, we prefer the member specialization information. Eg:
4445 //
4446 // template<typename T> struct A {
4447 // template<typename U> void f() {}
4448 // template<> void f<int>() {}
4449 // };
4450 //
4451 // Within the templated CXXRecordDecl, A<T>::f<int> is a dependent function
4452 // template specialization; both getTemplateSpecializationKind() and
4453 // getTemplateSpecializationKindForInstantiation() will return
4454 // TSK_ExplicitSpecialization.
4455 //
4456 // For A<int>::f<int>():
4457 // * getTemplateSpecializationKind() will return TSK_ExplicitSpecialization
4458 // * getTemplateSpecializationKindForInstantiation() will return
4459 // TSK_ImplicitInstantiation
4460 //
4461 // This reflects the facts that A<int>::f<int> is an explicit specialization
4462 // of A<int>::f, and that A<int>::f<int> should be implicitly instantiated
4463 // from A::f<int> if a definition is needed.
4464 if (FunctionTemplateSpecializationInfo *FTSInfo =
4465 dyn_cast_if_present<FunctionTemplateSpecializationInfo *>(
4466 Val: TemplateOrSpecialization)) {
4467 if (auto *MSInfo = FTSInfo->getMemberSpecializationInfo())
4468 return MSInfo->getTemplateSpecializationKind();
4469 return FTSInfo->getTemplateSpecializationKind();
4470 }
4471
4472 if (MemberSpecializationInfo *MSInfo =
4473 dyn_cast_if_present<MemberSpecializationInfo *>(
4474 Val: TemplateOrSpecialization))
4475 return MSInfo->getTemplateSpecializationKind();
4476
4477 if (isa<DependentFunctionTemplateSpecializationInfo *>(
4478 Val: TemplateOrSpecialization) &&
4479 getFriendObjectKind() == FOK_None)
4480 return TSK_ExplicitSpecialization;
4481
4482 return TSK_Undeclared;
4483}
4484
4485void
4486FunctionDecl::setTemplateSpecializationKind(TemplateSpecializationKind TSK,
4487 SourceLocation PointOfInstantiation) {
4488 if (FunctionTemplateSpecializationInfo *FTSInfo =
4489 dyn_cast<FunctionTemplateSpecializationInfo *>(
4490 Val&: TemplateOrSpecialization)) {
4491 FTSInfo->setTemplateSpecializationKind(TSK);
4492 if (TSK != TSK_ExplicitSpecialization &&
4493 PointOfInstantiation.isValid() &&
4494 FTSInfo->getPointOfInstantiation().isInvalid()) {
4495 FTSInfo->setPointOfInstantiation(PointOfInstantiation);
4496 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
4497 L->InstantiationRequested(D: this);
4498 }
4499 } else if (MemberSpecializationInfo *MSInfo =
4500 dyn_cast<MemberSpecializationInfo *>(
4501 Val&: TemplateOrSpecialization)) {
4502 MSInfo->setTemplateSpecializationKind(TSK);
4503 if (TSK != TSK_ExplicitSpecialization &&
4504 PointOfInstantiation.isValid() &&
4505 MSInfo->getPointOfInstantiation().isInvalid()) {
4506 MSInfo->setPointOfInstantiation(PointOfInstantiation);
4507 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
4508 L->InstantiationRequested(D: this);
4509 }
4510 } else
4511 llvm_unreachable("Function cannot have a template specialization kind");
4512}
4513
4514SourceLocation FunctionDecl::getPointOfInstantiation() const {
4515 if (FunctionTemplateSpecializationInfo *FTSInfo
4516 = TemplateOrSpecialization.dyn_cast<
4517 FunctionTemplateSpecializationInfo*>())
4518 return FTSInfo->getPointOfInstantiation();
4519 if (MemberSpecializationInfo *MSInfo =
4520 TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo *>())
4521 return MSInfo->getPointOfInstantiation();
4522
4523 return SourceLocation();
4524}
4525
4526bool FunctionDecl::isOutOfLine() const {
4527 if (Decl::isOutOfLine())
4528 return true;
4529
4530 // If this function was instantiated from a member function of a
4531 // class template, check whether that member function was defined out-of-line.
4532 if (FunctionDecl *FD = getInstantiatedFromMemberFunction()) {
4533 const FunctionDecl *Definition;
4534 if (FD->hasBody(Definition))
4535 return Definition->isOutOfLine();
4536 }
4537
4538 // If this function was instantiated from a function template,
4539 // check whether that function template was defined out-of-line.
4540 if (FunctionTemplateDecl *FunTmpl = getPrimaryTemplate()) {
4541 const FunctionDecl *Definition;
4542 if (FunTmpl->getTemplatedDecl()->hasBody(Definition))
4543 return Definition->isOutOfLine();
4544 }
4545
4546 return false;
4547}
4548
4549SourceRange FunctionDecl::getSourceRange() const {
4550 return SourceRange(getOuterLocStart(), EndRangeLoc);
4551}
4552
4553unsigned FunctionDecl::getMemoryFunctionKind() const {
4554 IdentifierInfo *FnInfo = getIdentifier();
4555
4556 if (!FnInfo)
4557 return 0;
4558
4559 // Builtin handling.
4560 switch (getBuiltinID()) {
4561 case Builtin::BI__builtin_memset:
4562 case Builtin::BI__builtin___memset_chk:
4563 case Builtin::BImemset:
4564 return Builtin::BImemset;
4565
4566 case Builtin::BI__builtin_memcpy:
4567 case Builtin::BI__builtin___memcpy_chk:
4568 case Builtin::BImemcpy:
4569 return Builtin::BImemcpy;
4570
4571 case Builtin::BI__builtin_mempcpy:
4572 case Builtin::BI__builtin___mempcpy_chk:
4573 case Builtin::BImempcpy:
4574 return Builtin::BImempcpy;
4575
4576 case Builtin::BI__builtin_trivially_relocate:
4577 case Builtin::BI__builtin_memmove:
4578 case Builtin::BI__builtin___memmove_chk:
4579 case Builtin::BImemmove:
4580 return Builtin::BImemmove;
4581
4582 case Builtin::BIstrlcpy:
4583 case Builtin::BI__builtin___strlcpy_chk:
4584 return Builtin::BIstrlcpy;
4585
4586 case Builtin::BIstrlcat:
4587 case Builtin::BI__builtin___strlcat_chk:
4588 return Builtin::BIstrlcat;
4589
4590 case Builtin::BI__builtin_memcmp:
4591 case Builtin::BImemcmp:
4592 return Builtin::BImemcmp;
4593
4594 case Builtin::BI__builtin_bcmp:
4595 case Builtin::BIbcmp:
4596 return Builtin::BIbcmp;
4597
4598 case Builtin::BI__builtin_strncpy:
4599 case Builtin::BI__builtin___strncpy_chk:
4600 case Builtin::BIstrncpy:
4601 return Builtin::BIstrncpy;
4602
4603 case Builtin::BI__builtin_strncmp:
4604 case Builtin::BIstrncmp:
4605 return Builtin::BIstrncmp;
4606
4607 case Builtin::BI__builtin_strncasecmp:
4608 case Builtin::BIstrncasecmp:
4609 return Builtin::BIstrncasecmp;
4610
4611 case Builtin::BI__builtin_strncat:
4612 case Builtin::BI__builtin___strncat_chk:
4613 case Builtin::BIstrncat:
4614 return Builtin::BIstrncat;
4615
4616 case Builtin::BI__builtin_strndup:
4617 case Builtin::BIstrndup:
4618 return Builtin::BIstrndup;
4619
4620 case Builtin::BI__builtin_strlen:
4621 case Builtin::BIstrlen:
4622 return Builtin::BIstrlen;
4623
4624 case Builtin::BI__builtin_bzero:
4625 case Builtin::BIbzero:
4626 return Builtin::BIbzero;
4627
4628 case Builtin::BI__builtin_bcopy:
4629 case Builtin::BIbcopy:
4630 return Builtin::BIbcopy;
4631
4632 case Builtin::BIfree:
4633 return Builtin::BIfree;
4634
4635 default:
4636 if (isExternC()) {
4637 if (FnInfo->isStr(Str: "memset"))
4638 return Builtin::BImemset;
4639 if (FnInfo->isStr(Str: "memcpy"))
4640 return Builtin::BImemcpy;
4641 if (FnInfo->isStr(Str: "mempcpy"))
4642 return Builtin::BImempcpy;
4643 if (FnInfo->isStr(Str: "memmove"))
4644 return Builtin::BImemmove;
4645 if (FnInfo->isStr(Str: "memcmp"))
4646 return Builtin::BImemcmp;
4647 if (FnInfo->isStr(Str: "bcmp"))
4648 return Builtin::BIbcmp;
4649 if (FnInfo->isStr(Str: "strncpy"))
4650 return Builtin::BIstrncpy;
4651 if (FnInfo->isStr(Str: "strncmp"))
4652 return Builtin::BIstrncmp;
4653 if (FnInfo->isStr(Str: "strncasecmp"))
4654 return Builtin::BIstrncasecmp;
4655 if (FnInfo->isStr(Str: "strncat"))
4656 return Builtin::BIstrncat;
4657 if (FnInfo->isStr(Str: "strndup"))
4658 return Builtin::BIstrndup;
4659 if (FnInfo->isStr(Str: "strlen"))
4660 return Builtin::BIstrlen;
4661 if (FnInfo->isStr(Str: "bzero"))
4662 return Builtin::BIbzero;
4663 if (FnInfo->isStr(Str: "bcopy"))
4664 return Builtin::BIbcopy;
4665 } else if (isInStdNamespace()) {
4666 if (FnInfo->isStr(Str: "free"))
4667 return Builtin::BIfree;
4668 }
4669 break;
4670 }
4671 return 0;
4672}
4673
4674unsigned FunctionDecl::getODRHash() const {
4675 assert(hasODRHash());
4676 return ODRHash;
4677}
4678
4679unsigned FunctionDecl::getODRHash() {
4680 if (hasODRHash())
4681 return ODRHash;
4682
4683 if (auto *FT = getInstantiatedFromMemberFunction()) {
4684 setHasODRHash(true);
4685 ODRHash = FT->getODRHash();
4686 return ODRHash;
4687 }
4688
4689 class ODRHash Hash;
4690 Hash.AddFunctionDecl(Function: this);
4691 setHasODRHash(true);
4692 ODRHash = Hash.CalculateHash();
4693 return ODRHash;
4694}
4695
4696//===----------------------------------------------------------------------===//
4697// FieldDecl Implementation
4698//===----------------------------------------------------------------------===//
4699
4700FieldDecl *FieldDecl::Create(const ASTContext &C, DeclContext *DC,
4701 SourceLocation StartLoc, SourceLocation IdLoc,
4702 const IdentifierInfo *Id, QualType T,
4703 TypeSourceInfo *TInfo, Expr *BW, bool Mutable,
4704 InClassInitStyle InitStyle) {
4705 return new (C, DC) FieldDecl(Decl::Field, DC, StartLoc, IdLoc, Id, T, TInfo,
4706 BW, Mutable, InitStyle);
4707}
4708
4709FieldDecl *FieldDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
4710 return new (C, ID) FieldDecl(Field, nullptr, SourceLocation(),
4711 SourceLocation(), nullptr, QualType(), nullptr,
4712 nullptr, false, ICIS_NoInit);
4713}
4714
4715bool FieldDecl::isAnonymousStructOrUnion() const {
4716 if (!isImplicit() || getDeclName())
4717 return false;
4718
4719 if (const auto *Record = getType()->getAsCanonical<RecordType>())
4720 return Record->getDecl()->isAnonymousStructOrUnion();
4721
4722 return false;
4723}
4724
4725Expr *FieldDecl::getInClassInitializer() const {
4726 if (!hasInClassInitializer())
4727 return nullptr;
4728
4729 LazyDeclStmtPtr InitPtr = BitField ? InitAndBitWidth->Init : Init;
4730 return cast_if_present<Expr>(
4731 Val: InitPtr.isOffset() ? InitPtr.get(Source: getASTContext().getExternalSource())
4732 : InitPtr.get(Source: nullptr));
4733}
4734
4735void FieldDecl::setInClassInitializer(Expr *NewInit) {
4736 setLazyInClassInitializer(LazyDeclStmtPtr(NewInit));
4737}
4738
4739void FieldDecl::setLazyInClassInitializer(LazyDeclStmtPtr NewInit) {
4740 assert(hasInClassInitializer() && !getInClassInitializer());
4741 if (BitField)
4742 InitAndBitWidth->Init = NewInit;
4743 else
4744 Init = NewInit;
4745}
4746
4747bool FieldDecl::hasConstantIntegerBitWidth() const {
4748 const auto *CE = dyn_cast_if_present<ConstantExpr>(Val: getBitWidth());
4749 return CE && CE->getAPValueResult().isInt();
4750}
4751
4752unsigned FieldDecl::getBitWidthValue() const {
4753 assert(isBitField() && "not a bitfield");
4754 assert(hasConstantIntegerBitWidth());
4755 return cast<ConstantExpr>(Val: getBitWidth())
4756 ->getAPValueResult()
4757 .getInt()
4758 .getZExtValue();
4759}
4760
4761bool FieldDecl::isZeroLengthBitField() const {
4762 return isUnnamedBitField() && !getBitWidth()->isValueDependent() &&
4763 getBitWidthValue() == 0;
4764}
4765
4766bool FieldDecl::isZeroSize(const ASTContext &Ctx) const {
4767 if (isZeroLengthBitField())
4768 return true;
4769
4770 // C++2a [intro.object]p7:
4771 // An object has nonzero size if it
4772 // -- is not a potentially-overlapping subobject, or
4773 if (!hasAttr<NoUniqueAddressAttr>())
4774 return false;
4775
4776 // -- is not of class type, or
4777 const auto *RT = getType()->getAsCanonical<RecordType>();
4778 if (!RT)
4779 return false;
4780 const RecordDecl *RD = RT->getDecl()->getDefinition();
4781 if (!RD) {
4782 assert(isInvalidDecl() && "valid field has incomplete type");
4783 return false;
4784 }
4785
4786 // -- [has] virtual member functions or virtual base classes, or
4787 // -- has subobjects of nonzero size or bit-fields of nonzero length
4788 const auto *CXXRD = cast<CXXRecordDecl>(Val: RD);
4789 if (!CXXRD->isEmpty())
4790 return false;
4791
4792 // Otherwise, [...] the circumstances under which the object has zero size
4793 // are implementation-defined.
4794 if (!Ctx.getTargetInfo().getCXXABI().isMicrosoft())
4795 return true;
4796
4797 // MS ABI: has nonzero size if it is a class type with class type fields,
4798 // whether or not they have nonzero size
4799 return !llvm::any_of(Range: CXXRD->fields(), P: [](const FieldDecl *Field) {
4800 return Field->getType()->isRecordType();
4801 });
4802}
4803
4804bool FieldDecl::isPotentiallyOverlapping() const {
4805 return hasAttr<NoUniqueAddressAttr>() && getType()->getAsCXXRecordDecl();
4806}
4807
4808void FieldDecl::setCachedFieldIndex() const {
4809 assert(this == getCanonicalDecl() &&
4810 "should be called on the canonical decl");
4811
4812 unsigned Index = 0;
4813 const RecordDecl *RD = getParent()->getDefinition();
4814 assert(RD && "requested index for field of struct with no definition");
4815
4816 for (auto *Field : RD->fields()) {
4817 Field->getCanonicalDecl()->CachedFieldIndex = Index + 1;
4818 assert(Field->getCanonicalDecl()->CachedFieldIndex == Index + 1 &&
4819 "overflow in field numbering");
4820 ++Index;
4821 }
4822
4823 assert(CachedFieldIndex && "failed to find field in parent");
4824}
4825
4826SourceRange FieldDecl::getSourceRange() const {
4827 const Expr *FinalExpr = getInClassInitializer();
4828 if (!FinalExpr)
4829 FinalExpr = getBitWidth();
4830 if (FinalExpr)
4831 return SourceRange(getInnerLocStart(), FinalExpr->getEndLoc());
4832 return DeclaratorDecl::getSourceRange();
4833}
4834
4835void FieldDecl::setCapturedVLAType(const VariableArrayType *VLAType) {
4836 assert((getParent()->isLambda() || getParent()->isCapturedRecord()) &&
4837 "capturing type in non-lambda or captured record.");
4838 assert(StorageKind == ISK_NoInit && !BitField &&
4839 "bit-field or field with default member initializer cannot capture "
4840 "VLA type");
4841 StorageKind = ISK_CapturedVLAType;
4842 CapturedVLAType = VLAType;
4843}
4844
4845void FieldDecl::printName(raw_ostream &OS, const PrintingPolicy &Policy) const {
4846 // Print unnamed members using name of their type.
4847 if (isAnonymousStructOrUnion()) {
4848 this->getType().print(OS, Policy);
4849 return;
4850 }
4851 // Otherwise, do the normal printing.
4852 DeclaratorDecl::printName(OS, Policy);
4853}
4854
4855const FieldDecl *FieldDecl::findCountedByField() const {
4856 const auto *CAT = getType()->getAs<CountAttributedType>();
4857 if (!CAT)
4858 return nullptr;
4859
4860 const auto *CountDRE = cast<DeclRefExpr>(Val: CAT->getCountExpr());
4861 const auto *CountDecl = CountDRE->getDecl();
4862 if (const auto *IFD = dyn_cast<IndirectFieldDecl>(Val: CountDecl))
4863 CountDecl = IFD->getAnonField();
4864
4865 return dyn_cast<FieldDecl>(Val: CountDecl);
4866}
4867
4868//===----------------------------------------------------------------------===//
4869// TagDecl Implementation
4870//===----------------------------------------------------------------------===//
4871
4872TagDecl::TagDecl(Kind DK, TagKind TK, const ASTContext &C, DeclContext *DC,
4873 SourceLocation L, IdentifierInfo *Id, TagDecl *PrevDecl,
4874 SourceLocation StartL)
4875 : TypeDecl(DK, DC, L, Id, StartL), DeclContext(DK), redeclarable_base(C),
4876 TypedefNameDeclOrQualifier((TypedefNameDecl *)nullptr) {
4877 assert((DK != Enum || TK == TagTypeKind::Enum) &&
4878 "EnumDecl not matched with TagTypeKind::Enum");
4879 setPreviousDecl(PrevDecl);
4880 setTagKind(TK);
4881 setCompleteDefinition(false);
4882 setBeingDefined(false);
4883 setEmbeddedInDeclarator(false);
4884 setFreeStanding(false);
4885 setCompleteDefinitionRequired(false);
4886 TagDeclBits.IsThisDeclarationADemotedDefinition = false;
4887}
4888
4889SourceLocation TagDecl::getOuterLocStart() const {
4890 return getTemplateOrInnerLocStart(decl: this);
4891}
4892
4893SourceRange TagDecl::getSourceRange() const {
4894 SourceLocation RBraceLoc = BraceRange.getEnd();
4895 SourceLocation E = RBraceLoc.isValid() ? RBraceLoc : getLocation();
4896 return SourceRange(getOuterLocStart(), E);
4897}
4898
4899TagDecl *TagDecl::getCanonicalDecl() { return getFirstDecl(); }
4900
4901void TagDecl::setTypedefNameForAnonDecl(TypedefNameDecl *TDD) {
4902 TypedefNameDeclOrQualifier = TDD;
4903 assert(isLinkageValid());
4904}
4905
4906void TagDecl::startDefinition() {
4907 setBeingDefined(true);
4908
4909 if (auto *D = dyn_cast<CXXRecordDecl>(Val: this)) {
4910 struct CXXRecordDecl::DefinitionData *Data =
4911 new (getASTContext()) struct CXXRecordDecl::DefinitionData(D);
4912 for (auto *I : redecls())
4913 cast<CXXRecordDecl>(Val: I)->DefinitionData = Data;
4914 }
4915}
4916
4917void TagDecl::completeDefinition() {
4918 assert((!isa<CXXRecordDecl>(this) ||
4919 cast<CXXRecordDecl>(this)->hasDefinition()) &&
4920 "definition completed but not started");
4921
4922 setCompleteDefinition(true);
4923 setBeingDefined(false);
4924
4925 if (ASTMutationListener *L = getASTMutationListener())
4926 L->CompletedTagDefinition(D: this);
4927}
4928
4929TagDecl *TagDecl::getDefinition() const {
4930 if (isCompleteDefinition() || isBeingDefined())
4931 return const_cast<TagDecl *>(this);
4932
4933 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(Val: this))
4934 return CXXRD->getDefinition();
4935
4936 for (TagDecl *R :
4937 redecl_range(redecl_iterator(getNextRedeclaration()), redecl_iterator()))
4938 if (R->isCompleteDefinition() || R->isBeingDefined())
4939 return R;
4940 return nullptr;
4941}
4942
4943void TagDecl::setQualifierInfo(NestedNameSpecifierLoc QualifierLoc) {
4944 if (QualifierLoc) {
4945 // Make sure the extended qualifier info is allocated.
4946 if (!hasExtInfo())
4947 TypedefNameDeclOrQualifier = new (getASTContext()) ExtInfo;
4948 // Set qualifier info.
4949 getExtInfo()->QualifierLoc = QualifierLoc;
4950 } else {
4951 // Here Qualifier == 0, i.e., we are removing the qualifier (if any).
4952 if (hasExtInfo()) {
4953 if (getExtInfo()->NumTemplParamLists == 0) {
4954 getASTContext().Deallocate(Ptr: getExtInfo());
4955 TypedefNameDeclOrQualifier = (TypedefNameDecl *)nullptr;
4956 }
4957 else
4958 getExtInfo()->QualifierLoc = QualifierLoc;
4959 }
4960 }
4961}
4962
4963void TagDecl::printAnonymousTagDecl(llvm::raw_ostream &OS,
4964 const PrintingPolicy &Policy) const {
4965 if (TypedefNameDecl *Typedef = getTypedefNameForAnonDecl()) {
4966 assert(Typedef->getIdentifier() && "Typedef without identifier?");
4967 OS << Typedef->getIdentifier()->getName();
4968 return;
4969 }
4970
4971 bool SuppressTagKeywordInName = Policy.SuppressTagKeywordInAnonNames;
4972
4973 // Emit leading keyword. Since we printed a leading keyword make sure we
4974 // don't print the tag as part of the name too.
4975 if (!Policy.SuppressTagKeyword) {
4976 OS << getKindName() << ' ';
4977 SuppressTagKeywordInName = true;
4978 }
4979
4980 // Make an unambiguous representation for anonymous types, e.g.
4981 // (anonymous enum at /usr/include/string.h:120:9)
4982 OS << (Policy.MSVCFormatting ? '`' : '(');
4983
4984 if (isa<CXXRecordDecl>(Val: this) && cast<CXXRecordDecl>(Val: this)->isLambda()) {
4985 OS << "lambda";
4986 SuppressTagKeywordInName = true;
4987 } else if ((isa<RecordDecl>(Val: this) &&
4988 cast<RecordDecl>(Val: this)->isAnonymousStructOrUnion())) {
4989 OS << "anonymous";
4990 } else {
4991 OS << "unnamed";
4992 }
4993
4994 if (!SuppressTagKeywordInName)
4995 OS << ' ' << getKindName();
4996
4997 if (Policy.AnonymousTagLocations) {
4998 PresumedLoc PLoc =
4999 getASTContext().getSourceManager().getPresumedLoc(Loc: getLocation());
5000 if (PLoc.isValid()) {
5001 OS << " at ";
5002 StringRef File = PLoc.getFilename();
5003 llvm::SmallString<1024> WrittenFile(File);
5004 if (auto *Callbacks = Policy.Callbacks)
5005 WrittenFile = Callbacks->remapPath(Path: File);
5006 // Fix inconsistent path separator created by
5007 // clang::DirectoryLookup::LookupFile when the file path is relative
5008 // path.
5009 llvm::sys::path::Style Style =
5010 llvm::sys::path::is_absolute(path: WrittenFile)
5011 ? llvm::sys::path::Style::native
5012 : (Policy.MSVCFormatting
5013 ? llvm::sys::path::Style::windows_backslash
5014 : llvm::sys::path::Style::posix);
5015 llvm::sys::path::native(path&: WrittenFile, style: Style);
5016 OS << WrittenFile << ':' << PLoc.getLine() << ':' << PLoc.getColumn();
5017 }
5018 }
5019
5020 OS << (Policy.MSVCFormatting ? '\'' : ')');
5021}
5022
5023void TagDecl::printName(raw_ostream &OS, const PrintingPolicy &Policy) const {
5024 DeclarationName Name = getDeclName();
5025 // If the name is supposed to have an identifier but does not have one, then
5026 // the tag is anonymous and we should print it differently.
5027 if (Name.isIdentifier() && !Name.getAsIdentifierInfo()) {
5028 printAnonymousTagDecl(OS, Policy);
5029
5030 return;
5031 }
5032
5033 // Otherwise, do the normal printing.
5034 Name.print(OS, Policy);
5035}
5036
5037void TagDecl::setTemplateParameterListsInfo(
5038 ASTContext &Context, ArrayRef<TemplateParameterList *> TPLists) {
5039 assert(!TPLists.empty());
5040 // Make sure the extended decl info is allocated.
5041 if (!hasExtInfo())
5042 // Allocate external info struct.
5043 TypedefNameDeclOrQualifier = new (getASTContext()) ExtInfo;
5044 // Set the template parameter lists info.
5045 getExtInfo()->setTemplateParameterListsInfo(Context, TPLists);
5046}
5047
5048//===----------------------------------------------------------------------===//
5049// EnumDecl Implementation
5050//===----------------------------------------------------------------------===//
5051
5052EnumDecl::EnumDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
5053 SourceLocation IdLoc, IdentifierInfo *Id, EnumDecl *PrevDecl,
5054 bool Scoped, bool ScopedUsingClassTag, bool Fixed)
5055 : TagDecl(Enum, TagTypeKind::Enum, C, DC, IdLoc, Id, PrevDecl, StartLoc) {
5056 assert(Scoped || !ScopedUsingClassTag);
5057 IntegerType = nullptr;
5058 setNumPositiveBits(0);
5059 setNumNegativeBits(0);
5060 setScoped(Scoped);
5061 setScopedUsingClassTag(ScopedUsingClassTag);
5062 setFixed(Fixed);
5063 setHasODRHash(false);
5064 ODRHash = 0;
5065}
5066
5067void EnumDecl::anchor() {}
5068
5069EnumDecl *EnumDecl::Create(ASTContext &C, DeclContext *DC,
5070 SourceLocation StartLoc, SourceLocation IdLoc,
5071 IdentifierInfo *Id,
5072 EnumDecl *PrevDecl, bool IsScoped,
5073 bool IsScopedUsingClassTag, bool IsFixed) {
5074 return new (C, DC) EnumDecl(C, DC, StartLoc, IdLoc, Id, PrevDecl, IsScoped,
5075 IsScopedUsingClassTag, IsFixed);
5076}
5077
5078EnumDecl *EnumDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
5079 return new (C, ID) EnumDecl(C, nullptr, SourceLocation(), SourceLocation(),
5080 nullptr, nullptr, false, false, false);
5081}
5082
5083SourceRange EnumDecl::getIntegerTypeRange() const {
5084 if (const TypeSourceInfo *TI = getIntegerTypeSourceInfo())
5085 return TI->getTypeLoc().getSourceRange();
5086 return SourceRange();
5087}
5088
5089void EnumDecl::completeDefinition(QualType NewType,
5090 QualType NewPromotionType,
5091 unsigned NumPositiveBits,
5092 unsigned NumNegativeBits) {
5093 assert(!isCompleteDefinition() && "Cannot redefine enums!");
5094 if (!IntegerType)
5095 IntegerType = NewType.getTypePtr();
5096 PromotionType = NewPromotionType;
5097 setNumPositiveBits(NumPositiveBits);
5098 setNumNegativeBits(NumNegativeBits);
5099 TagDecl::completeDefinition();
5100}
5101
5102bool EnumDecl::isClosed() const {
5103 if (const auto *A = getAttr<EnumExtensibilityAttr>())
5104 return A->getExtensibility() == EnumExtensibilityAttr::Closed;
5105 return true;
5106}
5107
5108bool EnumDecl::isClosedFlag() const {
5109 return isClosed() && hasAttr<FlagEnumAttr>();
5110}
5111
5112bool EnumDecl::isClosedNonFlag() const {
5113 return isClosed() && !hasAttr<FlagEnumAttr>();
5114}
5115
5116TemplateSpecializationKind EnumDecl::getTemplateSpecializationKind() const {
5117 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
5118 return MSI->getTemplateSpecializationKind();
5119
5120 return TSK_Undeclared;
5121}
5122
5123void EnumDecl::setTemplateSpecializationKind(TemplateSpecializationKind TSK,
5124 SourceLocation PointOfInstantiation) {
5125 MemberSpecializationInfo *MSI = getMemberSpecializationInfo();
5126 assert(MSI && "Not an instantiated member enumeration?");
5127 MSI->setTemplateSpecializationKind(TSK);
5128 if (TSK != TSK_ExplicitSpecialization &&
5129 PointOfInstantiation.isValid() &&
5130 MSI->getPointOfInstantiation().isInvalid())
5131 MSI->setPointOfInstantiation(PointOfInstantiation);
5132}
5133
5134EnumDecl *EnumDecl::getTemplateInstantiationPattern() const {
5135 if (MemberSpecializationInfo *MSInfo = getMemberSpecializationInfo()) {
5136 if (isTemplateInstantiation(Kind: MSInfo->getTemplateSpecializationKind())) {
5137 EnumDecl *ED = getInstantiatedFromMemberEnum();
5138 while (auto *NewED = ED->getInstantiatedFromMemberEnum())
5139 ED = NewED;
5140 return ::getDefinitionOrSelf(D: ED);
5141 }
5142 }
5143
5144 assert(!isTemplateInstantiation(getTemplateSpecializationKind()) &&
5145 "couldn't find pattern for enum instantiation");
5146 return nullptr;
5147}
5148
5149EnumDecl *EnumDecl::getInstantiatedFromMemberEnum() const {
5150 if (SpecializationInfo)
5151 return cast<EnumDecl>(Val: SpecializationInfo->getInstantiatedFrom());
5152
5153 return nullptr;
5154}
5155
5156void EnumDecl::setInstantiationOfMemberEnum(ASTContext &C, EnumDecl *ED,
5157 TemplateSpecializationKind TSK) {
5158 assert(!SpecializationInfo && "Member enum is already a specialization");
5159 SpecializationInfo = new (C) MemberSpecializationInfo(ED, TSK);
5160}
5161
5162unsigned EnumDecl::getODRHash() {
5163 if (hasODRHash())
5164 return ODRHash;
5165
5166 class ODRHash Hash;
5167 Hash.AddEnumDecl(Enum: this);
5168 setHasODRHash(true);
5169 ODRHash = Hash.CalculateHash();
5170 return ODRHash;
5171}
5172
5173SourceRange EnumDecl::getSourceRange() const {
5174 auto Res = TagDecl::getSourceRange();
5175 // Set end-point to enum-base, e.g. enum foo : ^bar
5176 if (auto *TSI = getIntegerTypeSourceInfo()) {
5177 // TagDecl doesn't know about the enum base.
5178 if (!getBraceRange().getEnd().isValid())
5179 Res.setEnd(TSI->getTypeLoc().getEndLoc());
5180 }
5181 return Res;
5182}
5183
5184void EnumDecl::getValueRange(llvm::APInt &Max, llvm::APInt &Min) const {
5185 unsigned Bitwidth = getASTContext().getIntWidth(T: getIntegerType());
5186 unsigned NumNegativeBits = getNumNegativeBits();
5187 unsigned NumPositiveBits = getNumPositiveBits();
5188
5189 if (NumNegativeBits) {
5190 unsigned NumBits = std::max(a: NumNegativeBits, b: NumPositiveBits + 1);
5191 Max = llvm::APInt(Bitwidth, 1) << (NumBits - 1);
5192 Min = -Max;
5193 } else {
5194 Max = llvm::APInt(Bitwidth, 1) << NumPositiveBits;
5195 Min = llvm::APInt::getZero(numBits: Bitwidth);
5196 }
5197}
5198
5199//===----------------------------------------------------------------------===//
5200// RecordDecl Implementation
5201//===----------------------------------------------------------------------===//
5202
5203RecordDecl::RecordDecl(Kind DK, TagKind TK, const ASTContext &C,
5204 DeclContext *DC, SourceLocation StartLoc,
5205 SourceLocation IdLoc, IdentifierInfo *Id,
5206 RecordDecl *PrevDecl)
5207 : TagDecl(DK, TK, C, DC, IdLoc, Id, PrevDecl, StartLoc) {
5208 assert(classof(static_cast<Decl *>(this)) && "Invalid Kind!");
5209 setHasFlexibleArrayMember(false);
5210 setAnonymousStructOrUnion(false);
5211 setHasObjectMember(false);
5212 setHasVolatileMember(false);
5213 setHasLoadedFieldsFromExternalStorage(false);
5214 setNonTrivialToPrimitiveDefaultInitialize(false);
5215 setNonTrivialToPrimitiveCopy(false);
5216 setNonTrivialToPrimitiveDestroy(false);
5217 setHasNonTrivialToPrimitiveDefaultInitializeCUnion(false);
5218 setHasNonTrivialToPrimitiveDestructCUnion(false);
5219 setHasNonTrivialToPrimitiveCopyCUnion(false);
5220 setHasUninitializedExplicitInitFields(false);
5221 setParamDestroyedInCallee(false);
5222 setArgPassingRestrictions(RecordArgPassingKind::CanPassInRegs);
5223 setIsRandomized(false);
5224 setODRHash(0);
5225}
5226
5227RecordDecl *RecordDecl::Create(const ASTContext &C, TagKind TK, DeclContext *DC,
5228 SourceLocation StartLoc, SourceLocation IdLoc,
5229 IdentifierInfo *Id, RecordDecl* PrevDecl) {
5230 return new (C, DC)
5231 RecordDecl(Record, TK, C, DC, StartLoc, IdLoc, Id, PrevDecl);
5232}
5233
5234RecordDecl *RecordDecl::CreateDeserialized(const ASTContext &C,
5235 GlobalDeclID ID) {
5236 return new (C, ID)
5237 RecordDecl(Record, TagTypeKind::Struct, C, nullptr, SourceLocation(),
5238 SourceLocation(), nullptr, nullptr);
5239}
5240
5241bool RecordDecl::isLambda() const {
5242 if (auto RD = dyn_cast<CXXRecordDecl>(Val: this))
5243 return RD->isLambda();
5244 return false;
5245}
5246
5247bool RecordDecl::isCapturedRecord() const {
5248 return hasAttr<CapturedRecordAttr>();
5249}
5250
5251void RecordDecl::setCapturedRecord() {
5252 addAttr(A: CapturedRecordAttr::CreateImplicit(Ctx&: getASTContext()));
5253}
5254
5255bool RecordDecl::isOrContainsUnion() const {
5256 if (isUnion())
5257 return true;
5258
5259 if (const RecordDecl *Def = getDefinition()) {
5260 for (const FieldDecl *FD : Def->fields()) {
5261 const RecordType *RT = FD->getType()->getAsCanonical<RecordType>();
5262 if (RT && RT->getDecl()->isOrContainsUnion())
5263 return true;
5264 }
5265 }
5266
5267 return false;
5268}
5269
5270RecordDecl::field_iterator RecordDecl::field_begin() const {
5271 if (hasExternalLexicalStorage() && !hasLoadedFieldsFromExternalStorage())
5272 LoadFieldsFromExternalStorage();
5273 // This is necessary for correctness for C++ with modules.
5274 // FIXME: Come up with a test case that breaks without definition.
5275 if (RecordDecl *D = getDefinition(); D && D != this)
5276 return D->field_begin();
5277 return field_iterator(decl_iterator(FirstDecl));
5278}
5279
5280RecordDecl::field_iterator RecordDecl::noload_field_begin() const {
5281 return field_iterator(decl_iterator(getDefinitionOrSelf()->FirstDecl));
5282}
5283
5284/// completeDefinition - Notes that the definition of this type is now
5285/// complete.
5286void RecordDecl::completeDefinition() {
5287 assert(!isCompleteDefinition() && "Cannot redefine record!");
5288 TagDecl::completeDefinition();
5289
5290 ASTContext &Ctx = getASTContext();
5291
5292 // Layouts are dumped when computed, so if we are dumping for all complete
5293 // types, we need to force usage to get types that wouldn't be used elsewhere.
5294 //
5295 // If the type is dependent, then we can't compute its layout because there
5296 // is no way for us to know the size or alignment of a dependent type. Also
5297 // ignore declarations marked as invalid since 'getASTRecordLayout()' asserts
5298 // on that.
5299 if (Ctx.getLangOpts().DumpRecordLayoutsComplete && !isDependentType() &&
5300 !isInvalidDecl())
5301 (void)Ctx.getASTRecordLayout(D: this);
5302}
5303
5304/// isMsStruct - Get whether or not this record uses ms_struct layout.
5305/// This which can be turned on with an attribute, pragma, or the
5306/// -mms-bitfields command-line option.
5307bool RecordDecl::isMsStruct(const ASTContext &C) const {
5308 if (hasAttr<GCCStructAttr>())
5309 return false;
5310 if (hasAttr<MSStructAttr>())
5311 return true;
5312 auto LayoutCompatibility = C.getLangOpts().getLayoutCompatibility();
5313 if (LayoutCompatibility == LangOptions::LayoutCompatibilityKind::Default)
5314 return C.defaultsToMsStruct();
5315 return LayoutCompatibility == LangOptions::LayoutCompatibilityKind::Microsoft;
5316}
5317
5318void RecordDecl::reorderDecls(const SmallVectorImpl<Decl *> &Decls) {
5319 std::tie(args&: FirstDecl, args&: LastDecl) = DeclContext::BuildDeclChain(Decls, FieldsAlreadyLoaded: false);
5320 LastDecl->NextInContextAndBits.setPointer(nullptr);
5321 setIsRandomized(true);
5322}
5323
5324void RecordDecl::LoadFieldsFromExternalStorage() const {
5325 ExternalASTSource *Source = getASTContext().getExternalSource();
5326 assert(hasExternalLexicalStorage() && Source && "No external storage?");
5327
5328 // Notify that we have a RecordDecl doing some initialization.
5329 ExternalASTSource::Deserializing TheFields(Source);
5330
5331 SmallVector<Decl*, 64> Decls;
5332 setHasLoadedFieldsFromExternalStorage(true);
5333 Source->FindExternalLexicalDecls(DC: this, IsKindWeWant: [](Decl::Kind K) {
5334 return FieldDecl::classofKind(K) || IndirectFieldDecl::classofKind(K);
5335 }, Result&: Decls);
5336
5337#ifndef NDEBUG
5338 // Check that all decls we got were FieldDecls.
5339 for (unsigned i=0, e=Decls.size(); i != e; ++i)
5340 assert(isa<FieldDecl>(Decls[i]) || isa<IndirectFieldDecl>(Decls[i]));
5341#endif
5342
5343 if (Decls.empty())
5344 return;
5345
5346 auto [ExternalFirst, ExternalLast] =
5347 BuildDeclChain(Decls,
5348 /*FieldsAlreadyLoaded=*/false);
5349 ExternalLast->NextInContextAndBits.setPointer(FirstDecl);
5350 FirstDecl = ExternalFirst;
5351 if (!LastDecl)
5352 LastDecl = ExternalLast;
5353}
5354
5355bool RecordDecl::mayInsertExtraPadding(bool EmitRemark) const {
5356 ASTContext &Context = getASTContext();
5357 const SanitizerMask EnabledAsanMask = Context.getLangOpts().Sanitize.Mask &
5358 (SanitizerKind::Address | SanitizerKind::KernelAddress);
5359 if (!EnabledAsanMask || !Context.getLangOpts().SanitizeAddressFieldPadding)
5360 return false;
5361 const auto &NoSanitizeList = Context.getNoSanitizeList();
5362 const auto *CXXRD = dyn_cast<CXXRecordDecl>(Val: this);
5363 // We may be able to relax some of these requirements.
5364 int ReasonToReject = -1;
5365 if (!CXXRD || CXXRD->isExternCContext())
5366 ReasonToReject = 0; // is not C++.
5367 else if (CXXRD->hasAttr<PackedAttr>())
5368 ReasonToReject = 1; // is packed.
5369 else if (CXXRD->isUnion())
5370 ReasonToReject = 2; // is a union.
5371 else if (CXXRD->isTriviallyCopyable())
5372 ReasonToReject = 3; // is trivially copyable.
5373 else if (CXXRD->hasTrivialDestructor())
5374 ReasonToReject = 4; // has trivial destructor.
5375 else if (CXXRD->isStandardLayout())
5376 ReasonToReject = 5; // is standard layout.
5377 else if (NoSanitizeList.containsLocation(Mask: EnabledAsanMask, Loc: getLocation(),
5378 Category: "field-padding"))
5379 ReasonToReject = 6; // is in an excluded file.
5380 else if (NoSanitizeList.containsType(
5381 Mask: EnabledAsanMask, MangledTypeName: getQualifiedNameAsString(), Category: "field-padding"))
5382 ReasonToReject = 7; // The type is excluded.
5383
5384 if (EmitRemark) {
5385 if (ReasonToReject >= 0)
5386 Context.getDiagnostics().Report(
5387 Loc: getLocation(),
5388 DiagID: diag::remark_sanitize_address_insert_extra_padding_rejected)
5389 << getQualifiedNameAsString() << ReasonToReject;
5390 else
5391 Context.getDiagnostics().Report(
5392 Loc: getLocation(),
5393 DiagID: diag::remark_sanitize_address_insert_extra_padding_accepted)
5394 << getQualifiedNameAsString();
5395 }
5396 return ReasonToReject < 0;
5397}
5398
5399const FieldDecl *RecordDecl::findFirstNamedDataMember() const {
5400 for (const auto *I : fields()) {
5401 if (I->getIdentifier())
5402 return I;
5403
5404 if (const auto *RD = I->getType()->getAsRecordDecl())
5405 if (const FieldDecl *NamedDataMember = RD->findFirstNamedDataMember())
5406 return NamedDataMember;
5407 }
5408
5409 // We didn't find a named data member.
5410 return nullptr;
5411}
5412
5413unsigned RecordDecl::getODRHash() {
5414 if (hasODRHash())
5415 return RecordDeclBits.ODRHash;
5416
5417 // Only calculate hash on first call of getODRHash per record.
5418 ODRHash Hash;
5419 Hash.AddRecordDecl(Record: this);
5420 // For RecordDecl the ODRHash is stored in the remaining
5421 // bits of RecordDeclBits, adjust the hash to accommodate.
5422 static_assert(sizeof(Hash.CalculateHash()) * CHAR_BIT == 32);
5423 setODRHash(Hash.CalculateHash() >> (32 - NumOdrHashBits));
5424 return RecordDeclBits.ODRHash;
5425}
5426
5427//===----------------------------------------------------------------------===//
5428// BlockDecl Implementation
5429//===----------------------------------------------------------------------===//
5430
5431BlockDecl::BlockDecl(DeclContext *DC, SourceLocation CaretLoc)
5432 : Decl(Block, DC, CaretLoc), DeclContext(Block) {
5433 setIsVariadic(false);
5434 setCapturesCXXThis(false);
5435 setBlockMissingReturnType(true);
5436 setIsConversionFromLambda(false);
5437 setDoesNotEscape(false);
5438 setCanAvoidCopyToHeap(false);
5439}
5440
5441void BlockDecl::setParams(ArrayRef<ParmVarDecl *> NewParamInfo) {
5442 assert(!ParamInfo && "Already has param info!");
5443
5444 // Zero params -> null pointer.
5445 if (!NewParamInfo.empty()) {
5446 NumParams = NewParamInfo.size();
5447 ParamInfo = new (getASTContext()) ParmVarDecl*[NewParamInfo.size()];
5448 llvm::copy(Range&: NewParamInfo, Out: ParamInfo);
5449 }
5450}
5451
5452void BlockDecl::setCaptures(ASTContext &Context, ArrayRef<Capture> Captures,
5453 bool CapturesCXXThis) {
5454 this->setCapturesCXXThis(CapturesCXXThis);
5455 this->NumCaptures = Captures.size();
5456
5457 if (Captures.empty()) {
5458 this->Captures = nullptr;
5459 return;
5460 }
5461
5462 this->Captures = Captures.copy(A&: Context).data();
5463}
5464
5465bool BlockDecl::capturesVariable(const VarDecl *variable) const {
5466 for (const auto &I : captures())
5467 // Only auto vars can be captured, so no redeclaration worries.
5468 if (I.getVariable() == variable)
5469 return true;
5470
5471 return false;
5472}
5473
5474SourceRange BlockDecl::getSourceRange() const {
5475 return SourceRange(getLocation(), Body ? Body->getEndLoc() : getLocation());
5476}
5477
5478//===----------------------------------------------------------------------===//
5479// Other Decl Allocation/Deallocation Method Implementations
5480//===----------------------------------------------------------------------===//
5481
5482void TranslationUnitDecl::anchor() {}
5483
5484TranslationUnitDecl *TranslationUnitDecl::Create(ASTContext &C) {
5485 return new (C, (DeclContext *)nullptr) TranslationUnitDecl(C);
5486}
5487
5488void TranslationUnitDecl::setAnonymousNamespace(NamespaceDecl *D) {
5489 AnonymousNamespace = D;
5490
5491 if (ASTMutationListener *Listener = Ctx.getASTMutationListener())
5492 Listener->AddedAnonymousNamespace(TU: this, AnonNamespace: D);
5493}
5494
5495void PragmaCommentDecl::anchor() {}
5496
5497PragmaCommentDecl *PragmaCommentDecl::Create(const ASTContext &C,
5498 TranslationUnitDecl *DC,
5499 SourceLocation CommentLoc,
5500 PragmaMSCommentKind CommentKind,
5501 StringRef Arg) {
5502 PragmaCommentDecl *PCD =
5503 new (C, DC, additionalSizeToAlloc<char>(Counts: Arg.size() + 1))
5504 PragmaCommentDecl(DC, CommentLoc, CommentKind);
5505 llvm::copy(Range&: Arg, Out: PCD->getTrailingObjects());
5506 PCD->getTrailingObjects()[Arg.size()] = '\0';
5507 return PCD;
5508}
5509
5510PragmaCommentDecl *PragmaCommentDecl::CreateDeserialized(ASTContext &C,
5511 GlobalDeclID ID,
5512 unsigned ArgSize) {
5513 return new (C, ID, additionalSizeToAlloc<char>(Counts: ArgSize + 1))
5514 PragmaCommentDecl(nullptr, SourceLocation(), PCK_Unknown);
5515}
5516
5517void PragmaDetectMismatchDecl::anchor() {}
5518
5519PragmaDetectMismatchDecl *
5520PragmaDetectMismatchDecl::Create(const ASTContext &C, TranslationUnitDecl *DC,
5521 SourceLocation Loc, StringRef Name,
5522 StringRef Value) {
5523 size_t ValueStart = Name.size() + 1;
5524 PragmaDetectMismatchDecl *PDMD =
5525 new (C, DC, additionalSizeToAlloc<char>(Counts: ValueStart + Value.size() + 1))
5526 PragmaDetectMismatchDecl(DC, Loc, ValueStart);
5527 llvm::copy(Range&: Name, Out: PDMD->getTrailingObjects());
5528 PDMD->getTrailingObjects()[Name.size()] = '\0';
5529 llvm::copy(Range&: Value, Out: PDMD->getTrailingObjects() + ValueStart);
5530 PDMD->getTrailingObjects()[ValueStart + Value.size()] = '\0';
5531 return PDMD;
5532}
5533
5534PragmaDetectMismatchDecl *
5535PragmaDetectMismatchDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID,
5536 unsigned NameValueSize) {
5537 return new (C, ID, additionalSizeToAlloc<char>(Counts: NameValueSize + 1))
5538 PragmaDetectMismatchDecl(nullptr, SourceLocation(), 0);
5539}
5540
5541void ExternCContextDecl::anchor() {}
5542
5543ExternCContextDecl *ExternCContextDecl::Create(const ASTContext &C,
5544 TranslationUnitDecl *DC) {
5545 return new (C, DC) ExternCContextDecl(DC);
5546}
5547
5548void LabelDecl::anchor() {}
5549
5550LabelDecl *LabelDecl::Create(ASTContext &C, DeclContext *DC,
5551 SourceLocation IdentL, IdentifierInfo *II) {
5552 return new (C, DC) LabelDecl(DC, IdentL, II, nullptr, IdentL);
5553}
5554
5555LabelDecl *LabelDecl::Create(ASTContext &C, DeclContext *DC,
5556 SourceLocation IdentL, IdentifierInfo *II,
5557 SourceLocation GnuLabelL) {
5558 assert(GnuLabelL != IdentL && "Use this only for GNU local labels");
5559 return new (C, DC) LabelDecl(DC, IdentL, II, nullptr, GnuLabelL);
5560}
5561
5562LabelDecl *LabelDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
5563 return new (C, ID) LabelDecl(nullptr, SourceLocation(), nullptr, nullptr,
5564 SourceLocation());
5565}
5566
5567void LabelDecl::setMSAsmLabel(StringRef Name) {
5568char *Buffer = new (getASTContext(), 1) char[Name.size() + 1];
5569llvm::copy(Range&: Name, Out: Buffer);
5570Buffer[Name.size()] = '\0';
5571MSAsmName = Buffer;
5572}
5573
5574void ValueDecl::anchor() {}
5575
5576bool ValueDecl::isWeak() const {
5577 auto *MostRecent = getMostRecentDecl();
5578 return MostRecent->hasAttr<WeakAttr>() ||
5579 MostRecent->hasAttr<WeakRefAttr>() || isWeakImported();
5580}
5581
5582bool ValueDecl::isInitCapture() const {
5583 if (auto *Var = llvm::dyn_cast<VarDecl>(Val: this))
5584 return Var->isInitCapture();
5585 return false;
5586}
5587
5588bool ValueDecl::isParameterPack() const {
5589 if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Val: this))
5590 return NTTP->isParameterPack();
5591
5592 return isa_and_nonnull<PackExpansionType>(Val: getType().getTypePtrOrNull());
5593}
5594
5595void ImplicitParamDecl::anchor() {}
5596
5597ImplicitParamDecl *ImplicitParamDecl::Create(ASTContext &C, DeclContext *DC,
5598 SourceLocation IdLoc,
5599 IdentifierInfo *Id, QualType Type,
5600 ImplicitParamKind ParamKind) {
5601 return new (C, DC) ImplicitParamDecl(C, DC, IdLoc, Id, Type, ParamKind);
5602}
5603
5604ImplicitParamDecl *ImplicitParamDecl::Create(ASTContext &C, QualType Type,
5605 ImplicitParamKind ParamKind) {
5606 return new (C, nullptr) ImplicitParamDecl(C, Type, ParamKind);
5607}
5608
5609ImplicitParamDecl *ImplicitParamDecl::CreateDeserialized(ASTContext &C,
5610 GlobalDeclID ID) {
5611 return new (C, ID) ImplicitParamDecl(C, QualType(), ImplicitParamKind::Other);
5612}
5613
5614FunctionDecl *
5615FunctionDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
5616 const DeclarationNameInfo &NameInfo, QualType T,
5617 TypeSourceInfo *TInfo, StorageClass SC, bool UsesFPIntrin,
5618 bool isInlineSpecified, bool hasWrittenPrototype,
5619 ConstexprSpecKind ConstexprKind,
5620 const AssociatedConstraint &TrailingRequiresClause) {
5621 FunctionDecl *New = new (C, DC) FunctionDecl(
5622 Function, C, DC, StartLoc, NameInfo, T, TInfo, SC, UsesFPIntrin,
5623 isInlineSpecified, ConstexprKind, TrailingRequiresClause);
5624 New->setHasWrittenPrototype(hasWrittenPrototype);
5625 return New;
5626}
5627
5628FunctionDecl *FunctionDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
5629 return new (C, ID) FunctionDecl(
5630 Function, C, nullptr, SourceLocation(), DeclarationNameInfo(), QualType(),
5631 nullptr, SC_None, false, false, ConstexprSpecKind::Unspecified,
5632 /*TrailingRequiresClause=*/{});
5633}
5634
5635bool FunctionDecl::isReferenceableKernel() const {
5636 return hasAttr<CUDAGlobalAttr>() ||
5637 DeviceKernelAttr::isOpenCLSpelling(A: getAttr<DeviceKernelAttr>());
5638}
5639
5640BlockDecl *BlockDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation L) {
5641 return new (C, DC) BlockDecl(DC, L);
5642}
5643
5644BlockDecl *BlockDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
5645 return new (C, ID) BlockDecl(nullptr, SourceLocation());
5646}
5647
5648OutlinedFunctionDecl::OutlinedFunctionDecl(DeclContext *DC, unsigned NumParams)
5649 : Decl(OutlinedFunction, DC, SourceLocation()),
5650 DeclContext(OutlinedFunction), NumParams(NumParams),
5651 BodyAndNothrow(nullptr, false) {}
5652
5653OutlinedFunctionDecl *OutlinedFunctionDecl::Create(ASTContext &C,
5654 DeclContext *DC,
5655 unsigned NumParams) {
5656 return new (C, DC, additionalSizeToAlloc<ImplicitParamDecl *>(Counts: NumParams))
5657 OutlinedFunctionDecl(DC, NumParams);
5658}
5659
5660OutlinedFunctionDecl *
5661OutlinedFunctionDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID,
5662 unsigned NumParams) {
5663 return new (C, ID, additionalSizeToAlloc<ImplicitParamDecl *>(Counts: NumParams))
5664 OutlinedFunctionDecl(nullptr, NumParams);
5665}
5666
5667Stmt *OutlinedFunctionDecl::getBody() const {
5668 return BodyAndNothrow.getPointer();
5669}
5670void OutlinedFunctionDecl::setBody(Stmt *B) { BodyAndNothrow.setPointer(B); }
5671
5672bool OutlinedFunctionDecl::isNothrow() const { return BodyAndNothrow.getInt(); }
5673void OutlinedFunctionDecl::setNothrow(bool Nothrow) {
5674 BodyAndNothrow.setInt(Nothrow);
5675}
5676
5677CapturedDecl::CapturedDecl(DeclContext *DC, unsigned NumParams)
5678 : Decl(Captured, DC, SourceLocation()), DeclContext(Captured),
5679 NumParams(NumParams), ContextParam(0), BodyAndNothrow(nullptr, false) {}
5680
5681CapturedDecl *CapturedDecl::Create(ASTContext &C, DeclContext *DC,
5682 unsigned NumParams) {
5683 return new (C, DC, additionalSizeToAlloc<ImplicitParamDecl *>(Counts: NumParams))
5684 CapturedDecl(DC, NumParams);
5685}
5686
5687CapturedDecl *CapturedDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID,
5688 unsigned NumParams) {
5689 return new (C, ID, additionalSizeToAlloc<ImplicitParamDecl *>(Counts: NumParams))
5690 CapturedDecl(nullptr, NumParams);
5691}
5692
5693Stmt *CapturedDecl::getBody() const { return BodyAndNothrow.getPointer(); }
5694void CapturedDecl::setBody(Stmt *B) { BodyAndNothrow.setPointer(B); }
5695
5696bool CapturedDecl::isNothrow() const { return BodyAndNothrow.getInt(); }
5697void CapturedDecl::setNothrow(bool Nothrow) { BodyAndNothrow.setInt(Nothrow); }
5698
5699EnumConstantDecl::EnumConstantDecl(const ASTContext &C, DeclContext *DC,
5700 SourceLocation L, IdentifierInfo *Id,
5701 QualType T, Expr *E, const llvm::APSInt &V)
5702 : ValueDecl(EnumConstant, DC, L, Id, T), Init((Stmt *)E) {
5703 setInitVal(C, V);
5704}
5705
5706EnumConstantDecl *EnumConstantDecl::Create(ASTContext &C, EnumDecl *CD,
5707 SourceLocation L,
5708 IdentifierInfo *Id, QualType T,
5709 Expr *E, const llvm::APSInt &V) {
5710 return new (C, CD) EnumConstantDecl(C, CD, L, Id, T, E, V);
5711}
5712
5713EnumConstantDecl *EnumConstantDecl::CreateDeserialized(ASTContext &C,
5714 GlobalDeclID ID) {
5715 return new (C, ID) EnumConstantDecl(C, nullptr, SourceLocation(), nullptr,
5716 QualType(), nullptr, llvm::APSInt());
5717}
5718
5719void IndirectFieldDecl::anchor() {}
5720
5721IndirectFieldDecl::IndirectFieldDecl(ASTContext &C, DeclContext *DC,
5722 SourceLocation L, DeclarationName N,
5723 QualType T,
5724 MutableArrayRef<NamedDecl *> CH)
5725 : ValueDecl(IndirectField, DC, L, N, T), Chaining(CH.data()),
5726 ChainingSize(CH.size()) {
5727 // In C++, indirect field declarations conflict with tag declarations in the
5728 // same scope, so add them to IDNS_Tag so that tag redeclaration finds them.
5729 if (C.getLangOpts().CPlusPlus)
5730 IdentifierNamespace |= IDNS_Tag;
5731}
5732
5733IndirectFieldDecl *IndirectFieldDecl::Create(ASTContext &C, DeclContext *DC,
5734 SourceLocation L,
5735 const IdentifierInfo *Id,
5736 QualType T,
5737 MutableArrayRef<NamedDecl *> CH) {
5738 return new (C, DC) IndirectFieldDecl(C, DC, L, Id, T, CH);
5739}
5740
5741IndirectFieldDecl *IndirectFieldDecl::CreateDeserialized(ASTContext &C,
5742 GlobalDeclID ID) {
5743 return new (C, ID) IndirectFieldDecl(C, nullptr, SourceLocation(),
5744 DeclarationName(), QualType(), {});
5745}
5746
5747SourceRange EnumConstantDecl::getSourceRange() const {
5748 SourceLocation End = getLocation();
5749 if (Init)
5750 End = Init->getEndLoc();
5751 return SourceRange(getLocation(), End);
5752}
5753
5754void TypeDecl::anchor() {}
5755
5756TypedefDecl *TypedefDecl::Create(ASTContext &C, DeclContext *DC,
5757 SourceLocation StartLoc, SourceLocation IdLoc,
5758 const IdentifierInfo *Id,
5759 TypeSourceInfo *TInfo) {
5760 return new (C, DC) TypedefDecl(C, DC, StartLoc, IdLoc, Id, TInfo);
5761}
5762
5763void TypedefNameDecl::anchor() {}
5764
5765TagDecl *TypedefNameDecl::getAnonDeclWithTypedefName(bool AnyRedecl) const {
5766 if (auto *TT = getTypeSourceInfo()->getType()->getAs<TagType>()) {
5767 auto *OwningTypedef = TT->getDecl()->getTypedefNameForAnonDecl();
5768 auto *ThisTypedef = this;
5769 if (AnyRedecl && OwningTypedef) {
5770 OwningTypedef = OwningTypedef->getCanonicalDecl();
5771 ThisTypedef = ThisTypedef->getCanonicalDecl();
5772 }
5773 if (OwningTypedef == ThisTypedef)
5774 return TT->getDecl()->getDefinitionOrSelf();
5775 }
5776
5777 return nullptr;
5778}
5779
5780bool TypedefNameDecl::isTransparentTagSlow() const {
5781 auto determineIsTransparent = [&]() {
5782 if (auto *TT = getUnderlyingType()->getAs<TagType>()) {
5783 if (auto *TD = TT->getDecl()) {
5784 if (TD->getName() != getName())
5785 return false;
5786 SourceLocation TTLoc = getLocation();
5787 SourceLocation TDLoc = TD->getLocation();
5788 if (!TTLoc.isMacroID() || !TDLoc.isMacroID())
5789 return false;
5790 SourceManager &SM = getASTContext().getSourceManager();
5791 return SM.getSpellingLoc(Loc: TTLoc) == SM.getSpellingLoc(Loc: TDLoc);
5792 }
5793 }
5794 return false;
5795 };
5796
5797 bool isTransparent = determineIsTransparent();
5798 MaybeModedTInfo.setInt((isTransparent << 1) | 1);
5799 return isTransparent;
5800}
5801
5802TypedefDecl *TypedefDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
5803 return new (C, ID) TypedefDecl(C, nullptr, SourceLocation(), SourceLocation(),
5804 nullptr, nullptr);
5805}
5806
5807TypeAliasDecl *TypeAliasDecl::Create(ASTContext &C, DeclContext *DC,
5808 SourceLocation StartLoc,
5809 SourceLocation IdLoc,
5810 const IdentifierInfo *Id,
5811 TypeSourceInfo *TInfo) {
5812 return new (C, DC) TypeAliasDecl(C, DC, StartLoc, IdLoc, Id, TInfo);
5813}
5814
5815TypeAliasDecl *TypeAliasDecl::CreateDeserialized(ASTContext &C,
5816 GlobalDeclID ID) {
5817 return new (C, ID) TypeAliasDecl(C, nullptr, SourceLocation(),
5818 SourceLocation(), nullptr, nullptr);
5819}
5820
5821SourceRange TypedefDecl::getSourceRange() const {
5822 SourceLocation RangeEnd = getLocation();
5823 if (TypeSourceInfo *TInfo = getTypeSourceInfo()) {
5824 if (typeIsPostfix(QT: TInfo->getType()))
5825 RangeEnd = TInfo->getTypeLoc().getSourceRange().getEnd();
5826 }
5827 return SourceRange(getBeginLoc(), RangeEnd);
5828}
5829
5830SourceRange TypeAliasDecl::getSourceRange() const {
5831 SourceLocation RangeEnd = getBeginLoc();
5832 if (TypeSourceInfo *TInfo = getTypeSourceInfo())
5833 RangeEnd = TInfo->getTypeLoc().getSourceRange().getEnd();
5834 return SourceRange(getBeginLoc(), RangeEnd);
5835}
5836
5837void FileScopeAsmDecl::anchor() {}
5838
5839FileScopeAsmDecl *FileScopeAsmDecl::Create(ASTContext &C, DeclContext *DC,
5840 Expr *Str, SourceLocation AsmLoc,
5841 SourceLocation RParenLoc) {
5842 return new (C, DC) FileScopeAsmDecl(DC, Str, AsmLoc, RParenLoc);
5843}
5844
5845FileScopeAsmDecl *FileScopeAsmDecl::CreateDeserialized(ASTContext &C,
5846 GlobalDeclID ID) {
5847 return new (C, ID) FileScopeAsmDecl(nullptr, nullptr, SourceLocation(),
5848 SourceLocation());
5849}
5850
5851std::string FileScopeAsmDecl::getAsmString() const {
5852 return GCCAsmStmt::ExtractStringFromGCCAsmStmtComponent(E: getAsmStringExpr());
5853}
5854
5855void TopLevelStmtDecl::anchor() {}
5856
5857TopLevelStmtDecl *TopLevelStmtDecl::Create(ASTContext &C, Stmt *Statement) {
5858 assert(C.getLangOpts().IncrementalExtensions &&
5859 "Must be used only in incremental mode");
5860
5861 SourceLocation Loc = Statement ? Statement->getBeginLoc() : SourceLocation();
5862 DeclContext *DC = C.getTranslationUnitDecl();
5863
5864 return new (C, DC) TopLevelStmtDecl(DC, Loc, Statement);
5865}
5866
5867TopLevelStmtDecl *TopLevelStmtDecl::CreateDeserialized(ASTContext &C,
5868 GlobalDeclID ID) {
5869 return new (C, ID)
5870 TopLevelStmtDecl(/*DC=*/nullptr, SourceLocation(), /*S=*/nullptr);
5871}
5872
5873SourceRange TopLevelStmtDecl::getSourceRange() const {
5874 return SourceRange(getLocation(), Statement->getEndLoc());
5875}
5876
5877void TopLevelStmtDecl::setStmt(Stmt *S) {
5878 assert(S);
5879 Statement = S;
5880 setLocation(Statement->getBeginLoc());
5881}
5882
5883void EmptyDecl::anchor() {}
5884
5885EmptyDecl *EmptyDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation L) {
5886 return new (C, DC) EmptyDecl(DC, L);
5887}
5888
5889EmptyDecl *EmptyDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
5890 return new (C, ID) EmptyDecl(nullptr, SourceLocation());
5891}
5892
5893HLSLBufferDecl::HLSLBufferDecl(DeclContext *DC, bool CBuffer,
5894 SourceLocation KwLoc, IdentifierInfo *ID,
5895 SourceLocation IDLoc, SourceLocation LBrace)
5896 : NamedDecl(Decl::Kind::HLSLBuffer, DC, IDLoc, DeclarationName(ID)),
5897 DeclContext(Decl::Kind::HLSLBuffer), LBraceLoc(LBrace), KwLoc(KwLoc),
5898 IsCBuffer(CBuffer), HasValidPackoffset(false), LayoutStruct(nullptr) {}
5899
5900HLSLBufferDecl *HLSLBufferDecl::Create(ASTContext &C,
5901 DeclContext *LexicalParent, bool CBuffer,
5902 SourceLocation KwLoc, IdentifierInfo *ID,
5903 SourceLocation IDLoc,
5904 SourceLocation LBrace) {
5905 // For hlsl like this
5906 // cbuffer A {
5907 // cbuffer B {
5908 // }
5909 // }
5910 // compiler should treat it as
5911 // cbuffer A {
5912 // }
5913 // cbuffer B {
5914 // }
5915 // FIXME: support nested buffers if required for back-compat.
5916 DeclContext *DC = LexicalParent;
5917 HLSLBufferDecl *Result =
5918 new (C, DC) HLSLBufferDecl(DC, CBuffer, KwLoc, ID, IDLoc, LBrace);
5919 return Result;
5920}
5921
5922HLSLBufferDecl *
5923HLSLBufferDecl::CreateDefaultCBuffer(ASTContext &C, DeclContext *LexicalParent,
5924 ArrayRef<Decl *> DefaultCBufferDecls) {
5925 DeclContext *DC = LexicalParent;
5926 IdentifierInfo *II = &C.Idents.get(Name: "$Globals", TokenCode: tok::TokenKind::identifier);
5927 HLSLBufferDecl *Result = new (C, DC) HLSLBufferDecl(
5928 DC, true, SourceLocation(), II, SourceLocation(), SourceLocation());
5929 Result->setImplicit(true);
5930 Result->setDefaultBufferDecls(DefaultCBufferDecls);
5931 return Result;
5932}
5933
5934HLSLBufferDecl *HLSLBufferDecl::CreateDeserialized(ASTContext &C,
5935 GlobalDeclID ID) {
5936 return new (C, ID) HLSLBufferDecl(nullptr, false, SourceLocation(), nullptr,
5937 SourceLocation(), SourceLocation());
5938}
5939
5940void HLSLBufferDecl::addLayoutStruct(CXXRecordDecl *LS) {
5941 assert(LayoutStruct == nullptr && "layout struct has already been set");
5942 LayoutStruct = LS;
5943 addDecl(D: LS);
5944}
5945
5946void HLSLBufferDecl::setDefaultBufferDecls(ArrayRef<Decl *> Decls) {
5947 assert(!Decls.empty());
5948 assert(DefaultBufferDecls.empty() && "default decls are already set");
5949 assert(isImplicit() &&
5950 "default decls can only be added to the implicit/default constant "
5951 "buffer $Globals");
5952
5953 // allocate array for default decls with ASTContext allocator
5954 Decl **DeclsArray = new (getASTContext()) Decl *[Decls.size()];
5955 llvm::copy(Range&: Decls, Out: DeclsArray);
5956 DefaultBufferDecls = ArrayRef<Decl *>(DeclsArray, Decls.size());
5957}
5958
5959HLSLBufferDecl::buffer_decl_iterator
5960HLSLBufferDecl::buffer_decls_begin() const {
5961 return buffer_decl_iterator(llvm::iterator_range(DefaultBufferDecls.begin(),
5962 DefaultBufferDecls.end()),
5963 decl_range(decls_begin(), decls_end()));
5964}
5965
5966HLSLBufferDecl::buffer_decl_iterator HLSLBufferDecl::buffer_decls_end() const {
5967 return buffer_decl_iterator(
5968 llvm::iterator_range(DefaultBufferDecls.end(), DefaultBufferDecls.end()),
5969 decl_range(decls_end(), decls_end()));
5970}
5971
5972bool HLSLBufferDecl::buffer_decls_empty() {
5973 return DefaultBufferDecls.empty() && decls_empty();
5974}
5975
5976//===----------------------------------------------------------------------===//
5977// HLSLRootSignatureDecl Implementation
5978//===----------------------------------------------------------------------===//
5979
5980HLSLRootSignatureDecl::HLSLRootSignatureDecl(
5981 DeclContext *DC, SourceLocation Loc, IdentifierInfo *ID,
5982 llvm::dxbc::RootSignatureVersion Version, unsigned NumElems)
5983 : NamedDecl(Decl::Kind::HLSLRootSignature, DC, Loc, DeclarationName(ID)),
5984 Version(Version), NumElems(NumElems) {}
5985
5986HLSLRootSignatureDecl *HLSLRootSignatureDecl::Create(
5987 ASTContext &C, DeclContext *DC, SourceLocation Loc, IdentifierInfo *ID,
5988 llvm::dxbc::RootSignatureVersion Version,
5989 ArrayRef<llvm::hlsl::rootsig::RootElement> RootElements) {
5990 HLSLRootSignatureDecl *RSDecl =
5991 new (C, DC,
5992 additionalSizeToAlloc<llvm::hlsl::rootsig::RootElement>(
5993 Counts: RootElements.size()))
5994 HLSLRootSignatureDecl(DC, Loc, ID, Version, RootElements.size());
5995 auto *StoredElems = RSDecl->getElems();
5996 llvm::uninitialized_copy(Src&: RootElements, Dst: StoredElems);
5997 return RSDecl;
5998}
5999
6000HLSLRootSignatureDecl *
6001HLSLRootSignatureDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
6002 HLSLRootSignatureDecl *Result = new (C, ID)
6003 HLSLRootSignatureDecl(nullptr, SourceLocation(), nullptr,
6004 /*Version*/ llvm::dxbc::RootSignatureVersion::V1_1,
6005 /*NumElems=*/0);
6006 return Result;
6007}
6008
6009//===----------------------------------------------------------------------===//
6010// ImportDecl Implementation
6011//===----------------------------------------------------------------------===//
6012
6013/// Retrieve the number of module identifiers needed to name the given
6014/// module.
6015static unsigned getNumModuleIdentifiers(Module *Mod) {
6016 unsigned Result = 1;
6017 while (Mod->Parent) {
6018 Mod = Mod->Parent;
6019 ++Result;
6020 }
6021 return Result;
6022}
6023
6024ImportDecl::ImportDecl(DeclContext *DC, SourceLocation StartLoc,
6025 Module *Imported,
6026 ArrayRef<SourceLocation> IdentifierLocs)
6027 : Decl(Import, DC, StartLoc), ImportedModule(Imported),
6028 NextLocalImportAndComplete(nullptr, true) {
6029 assert(getNumModuleIdentifiers(Imported) == IdentifierLocs.size());
6030 auto *StoredLocs = getTrailingObjects();
6031 llvm::uninitialized_copy(Src&: IdentifierLocs, Dst: StoredLocs);
6032}
6033
6034ImportDecl::ImportDecl(DeclContext *DC, SourceLocation StartLoc,
6035 Module *Imported, SourceLocation EndLoc)
6036 : Decl(Import, DC, StartLoc), ImportedModule(Imported),
6037 NextLocalImportAndComplete(nullptr, false) {
6038 *getTrailingObjects() = EndLoc;
6039}
6040
6041ImportDecl *ImportDecl::Create(ASTContext &C, DeclContext *DC,
6042 SourceLocation StartLoc, Module *Imported,
6043 ArrayRef<SourceLocation> IdentifierLocs) {
6044 return new (C, DC,
6045 additionalSizeToAlloc<SourceLocation>(Counts: IdentifierLocs.size()))
6046 ImportDecl(DC, StartLoc, Imported, IdentifierLocs);
6047}
6048
6049ImportDecl *ImportDecl::CreateImplicit(ASTContext &C, DeclContext *DC,
6050 SourceLocation StartLoc,
6051 Module *Imported,
6052 SourceLocation EndLoc) {
6053 ImportDecl *Import = new (C, DC, additionalSizeToAlloc<SourceLocation>(Counts: 1))
6054 ImportDecl(DC, StartLoc, Imported, EndLoc);
6055 Import->setImplicit();
6056 return Import;
6057}
6058
6059ImportDecl *ImportDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID,
6060 unsigned NumLocations) {
6061 return new (C, ID, additionalSizeToAlloc<SourceLocation>(Counts: NumLocations))
6062 ImportDecl(EmptyShell());
6063}
6064
6065ArrayRef<SourceLocation> ImportDecl::getIdentifierLocs() const {
6066 if (!isImportComplete())
6067 return {};
6068
6069 return getTrailingObjects(N: getNumModuleIdentifiers(Mod: getImportedModule()));
6070}
6071
6072SourceRange ImportDecl::getSourceRange() const {
6073 if (!isImportComplete())
6074 return SourceRange(getLocation(), *getTrailingObjects());
6075
6076 return SourceRange(getLocation(), getIdentifierLocs().back());
6077}
6078
6079//===----------------------------------------------------------------------===//
6080// ExportDecl Implementation
6081//===----------------------------------------------------------------------===//
6082
6083void ExportDecl::anchor() {}
6084
6085ExportDecl *ExportDecl::Create(ASTContext &C, DeclContext *DC,
6086 SourceLocation ExportLoc) {
6087 return new (C, DC) ExportDecl(DC, ExportLoc);
6088}
6089
6090ExportDecl *ExportDecl::CreateDeserialized(ASTContext &C, GlobalDeclID ID) {
6091 return new (C, ID) ExportDecl(nullptr, SourceLocation());
6092}
6093
6094bool clang::IsArmStreamingFunction(const FunctionDecl *FD,
6095 bool IncludeLocallyStreaming) {
6096 if (IncludeLocallyStreaming)
6097 if (FD->hasAttr<ArmLocallyStreamingAttr>())
6098 return true;
6099
6100 assert(!FD->getType().isNull() && "Expected a valid FunctionDecl");
6101 if (const auto *FPT = FD->getType()->getAs<FunctionProtoType>())
6102 if (FPT->getAArch64SMEAttributes() & FunctionType::SME_PStateSMEnabledMask)
6103 return true;
6104
6105 return false;
6106}
6107
6108bool clang::hasArmZAState(const FunctionDecl *FD) {
6109 const auto *T = FD->getType()->getAs<FunctionProtoType>();
6110 return (T && FunctionType::getArmZAState(AttrBits: T->getAArch64SMEAttributes()) !=
6111 FunctionType::ARM_None) ||
6112 (FD->hasAttr<ArmNewAttr>() && FD->getAttr<ArmNewAttr>()->isNewZA());
6113}
6114
6115bool clang::hasArmZT0State(const FunctionDecl *FD) {
6116 const auto *T = FD->getType()->getAs<FunctionProtoType>();
6117 return (T && FunctionType::getArmZT0State(AttrBits: T->getAArch64SMEAttributes()) !=
6118 FunctionType::ARM_None) ||
6119 (FD->hasAttr<ArmNewAttr>() && FD->getAttr<ArmNewAttr>()->isNewZT0());
6120}
6121