blob: 23547933b88b9bbd5c72d892c68c679df90317ad [file] [log] [blame]
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001//===- Decl.cpp - Declaration AST Node Implementation ---------------------===//
Chris Lattnera11999d2006-10-15 22:34:45 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Chris Lattnera11999d2006-10-15 22:34:45 +00006//
7//===----------------------------------------------------------------------===//
8//
Argyrios Kyrtzidis63018842008-06-04 13:04:04 +00009// This file implements the Decl subclasses.
Chris Lattnera11999d2006-10-15 22:34:45 +000010//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/Decl.h"
George Burgess IV99db3ea2017-08-09 04:02:49 +000014#include "Linkage.h"
Chris Lattnera7b32872008-03-15 06:12:44 +000015#include "clang/AST/ASTContext.h"
Richard Trieu0f25c742018-12-14 03:35:10 +000016#include "clang/AST/ASTDiagnostic.h"
Faisal Valib90b2112014-04-03 16:32:21 +000017#include "clang/AST/ASTLambda.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000018#include "clang/AST/ASTMutationListener.h"
Reid Kleckner60573ae2019-11-15 17:31:55 -080019#include "clang/AST/Attr.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000020#include "clang/AST/CanonicalType.h"
21#include "clang/AST/DeclBase.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000022#include "clang/AST/DeclCXX.h"
23#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000024#include "clang/AST/DeclOpenMP.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/AST/DeclTemplate.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000026#include "clang/AST/DeclarationName.h"
Nuno Lopes394ec982008-12-17 23:39:55 +000027#include "clang/AST/Expr.h"
Anders Carlsson714d0962009-12-15 19:16:31 +000028#include "clang/AST/ExprCXX.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000029#include "clang/AST/ExternalASTSource.h"
Richard Trieue6caa262017-12-23 00:41:01 +000030#include "clang/AST/ODRHash.h"
Jordan Rose1e879d82018-03-23 00:07:18 +000031#include "clang/AST/PrettyDeclStackTrace.h"
Douglas Gregor7de59662009-05-29 20:38:28 +000032#include "clang/AST/PrettyPrinter.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000033#include "clang/AST/Redeclarable.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000034#include "clang/AST/Stmt.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000035#include "clang/AST/TemplateBase.h"
36#include "clang/AST/Type.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000037#include "clang/AST/TypeLoc.h"
Chris Lattner15ba9492009-06-14 01:54:56 +000038#include "clang/Basic/Builtins.h"
Daniel Dunbar221fa942008-08-11 04:54:23 +000039#include "clang/Basic/IdentifierTable.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000040#include "clang/Basic/LLVM.h"
41#include "clang/Basic/LangOptions.h"
42#include "clang/Basic/Linkage.h"
Douglas Gregorba345522011-12-02 23:23:56 +000043#include "clang/Basic/Module.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000044#include "clang/Basic/PartialDiagnostic.h"
45#include "clang/Basic/SanitizerBlacklist.h"
46#include "clang/Basic/Sanitizers.h"
47#include "clang/Basic/SourceLocation.h"
48#include "clang/Basic/SourceManager.h"
Abramo Bagnara6150c882010-05-11 21:36:43 +000049#include "clang/Basic/Specifiers.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000050#include "clang/Basic/TargetCXXABI.h"
Douglas Gregor1baf38f2011-03-26 12:10:19 +000051#include "clang/Basic/TargetInfo.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000052#include "clang/Basic/Visibility.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000053#include "llvm/ADT/APSInt.h"
54#include "llvm/ADT/ArrayRef.h"
55#include "llvm/ADT/None.h"
56#include "llvm/ADT/Optional.h"
57#include "llvm/ADT/STLExtras.h"
58#include "llvm/ADT/SmallVector.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000059#include "llvm/ADT/StringRef.h"
Reid Kleckner60573ae2019-11-15 17:31:55 -080060#include "llvm/ADT/StringSwitch.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000061#include "llvm/ADT/Triple.h"
62#include "llvm/Support/Casting.h"
John McCall06f6fe8d2009-09-04 01:14:41 +000063#include "llvm/Support/ErrorHandling.h"
Eugene Zelenkode0215c2017-11-13 23:01:27 +000064#include "llvm/Support/raw_ostream.h"
David Blaikie9c70e042011-09-21 18:16:56 +000065#include <algorithm>
Eugene Zelenkode0215c2017-11-13 23:01:27 +000066#include <cassert>
67#include <cstddef>
68#include <cstring>
69#include <memory>
70#include <string>
71#include <tuple>
72#include <type_traits>
David Blaikie9c70e042011-09-21 18:16:56 +000073
Chris Lattner6d9a6852006-10-25 05:11:20 +000074using namespace clang;
Chris Lattnera11999d2006-10-15 22:34:45 +000075
Richard Smith0b87e072013-10-07 08:02:11 +000076Decl *clang::getPrimaryMergedDecl(Decl *D) {
77 return D->getASTContext().getPrimaryMergedDecl(D);
78}
79
Jordan Rose1e879d82018-03-23 00:07:18 +000080void 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, Context.getSourceManager());
85 OS << ": ";
86 }
87 OS << Message;
88
89 if (auto *ND = dyn_cast_or_null<NamedDecl>(TheDecl)) {
90 OS << " '";
91 ND->getNameForDiagnostic(OS, Context.getPrintingPolicy(), true);
92 OS << "'";
93 }
94
95 OS << '\n';
96}
97
Richard Smith73b21d82014-09-03 02:33:22 +000098// Defined here so that it can be inlined into its direct callers.
99bool Decl::isOutOfLine() const {
100 return !getLexicalDeclContext()->Equals(getDeclContext());
101}
102
Richard Smith42413142015-05-15 20:05:43 +0000103TranslationUnitDecl::TranslationUnitDecl(ASTContext &ctx)
104 : Decl(TranslationUnit, nullptr, SourceLocation()),
Eugene Zelenkode0215c2017-11-13 23:01:27 +0000105 DeclContext(TranslationUnit), Ctx(ctx) {}
Richard Smith42413142015-05-15 20:05:43 +0000106
Chris Lattner88f70d62008-03-15 05:43:15 +0000107//===----------------------------------------------------------------------===//
Douglas Gregor6e6ad602009-01-20 01:17:11 +0000108// NamedDecl Implementation
Argyrios Kyrtzidis9e59b572008-11-09 23:41:00 +0000109//===----------------------------------------------------------------------===//
110
John McCalldf25c432013-02-16 00:17:33 +0000111// 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.
John McCalld041a9b2013-02-20 01:54:26 +0000133//
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.
John McCalldf25c432013-02-16 00:17:33 +0000156
John McCalld041a9b2013-02-20 01:54:26 +0000157/// Does this computation kind permit us to consider additional
158/// visibility settings from attributes and the like?
159static bool hasExplicitVisibilityAlready(LVComputationKind computation) {
Richard Smithfbe7b462017-09-22 02:22:32 +0000160 return computation.IgnoreExplicitVisibility;
John McCalld041a9b2013-02-20 01:54:26 +0000161}
162
163/// Given an LVComputationKind, return one of the same type/value sort
164/// that records that it already has explicit visibility.
165static LVComputationKind
Richard Smithfbe7b462017-09-22 02:22:32 +0000166withExplicitVisibilityAlready(LVComputationKind Kind) {
167 Kind.IgnoreExplicitVisibility = true;
168 return Kind;
John McCalld041a9b2013-02-20 01:54:26 +0000169}
170
David Blaikie05785d12013-02-20 22:23:23 +0000171static Optional<Visibility> getExplicitVisibility(const NamedDecl *D,
172 LVComputationKind kind) {
Richard Smithfbe7b462017-09-22 02:22:32 +0000173 assert(!kind.IgnoreExplicitVisibility &&
John McCalld041a9b2013-02-20 01:54:26 +0000174 "asking for explicit visibility when we shouldn't be");
Richard Smithfbe7b462017-09-22 02:22:32 +0000175 return D->getExplicitVisibility(kind.getExplicitVisibilityKind());
John McCalld041a9b2013-02-20 01:54:26 +0000176}
177
John McCalldf25c432013-02-16 00:17:33 +0000178/// Is the given declaration a "type" or a "value" for the purposes of
179/// visibility computation?
180static bool usesTypeVisibility(const NamedDecl *D) {
John McCallb4a99d32013-02-19 01:57:35 +0000181 return isa<TypeDecl>(D) ||
182 isa<ClassTemplateDecl>(D) ||
183 isa<ObjCInterfaceDecl>(D);
John McCalldf25c432013-02-16 00:17:33 +0000184}
185
John McCall5f46c482013-02-21 23:42:58 +0000186/// Does the given declaration have member specialization information,
187/// and if so, is it an explicit specialization?
188template <class T> static typename
Benjamin Kramered2f4762014-03-07 14:30:23 +0000189std::enable_if<!std::is_base_of<RedeclarableTemplateDecl, T>::value, bool>::type
John McCall5f46c482013-02-21 23:42:58 +0000190isExplicitMemberSpecialization(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
John McCalld041a9b2013-02-20 01:54:26 +0000205/// 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
John McCalldf25c432013-02-16 00:17:33 +0000220/// Return the explicit visibility of the given declaration.
David Blaikie05785d12013-02-20 22:23:23 +0000221static Optional<Visibility> getVisibilityOf(const NamedDecl *D,
John McCalld041a9b2013-02-20 01:54:26 +0000222 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) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000226 if (const auto *A = D->getAttr<TypeVisibilityAttr>()) {
John McCalld041a9b2013-02-20 01:54:26 +0000227 return getVisibilityFromAttr(A);
228 }
229 }
230
Douglas Gregor1baf38f2011-03-26 12:10:19 +0000231 // If this declaration has an explicit visibility attribute, use it.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000232 if (const auto *A = D->getAttr<VisibilityAttr>()) {
John McCalld041a9b2013-02-20 01:54:26 +0000233 return getVisibilityFromAttr(A);
John McCall457a04e2010-10-22 21:05:15 +0000234 }
Douglas Gregor1baf38f2011-03-26 12:10:19 +0000235
David Blaikie7a30dc52013-02-21 01:47:18 +0000236 return None;
John McCall457a04e2010-10-22 21:05:15 +0000237}
238
George Burgess IV99db3ea2017-08-09 04:02:49 +0000239LinkageInfo LinkageComputer::getLVForType(const Type &T,
240 LVComputationKind computation) {
Richard Smithfbe7b462017-09-22 02:22:32 +0000241 if (computation.IgnoreAllVisibility)
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000242 return LinkageInfo(T.getLinkage(), DefaultVisibility, true);
George Burgess IV35cb4f82017-08-09 04:12:17 +0000243 return getTypeLinkageAndVisibility(&T);
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000244}
245
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000246/// Get the most restrictive linkage for the types in the given
John McCalldf25c432013-02-16 00:17:33 +0000247/// template parameter list. For visibility purposes, template
248/// parameters are part of the signature of a template.
George Burgess IV99db3ea2017-08-09 04:02:49 +0000249LinkageInfo LinkageComputer::getLVForTemplateParameterList(
250 const TemplateParameterList *Params, LVComputationKind computation) {
John McCalldf25c432013-02-16 00:17:33 +0000251 LinkageInfo LV;
David Majnemerc7b85c42014-04-23 05:16:48 +0000252 for (const NamedDecl *P : *Params) {
John McCalldf25c432013-02-16 00:17:33 +0000253 // Template type parameters are the most common and never
254 // contribute to visibility, pack or not.
David Majnemerc7b85c42014-04-23 05:16:48 +0000255 if (isa<TemplateTypeParmDecl>(P))
John McCalldf25c432013-02-16 00:17:33 +0000256 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.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000262 if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(P)) {
John McCalldf25c432013-02-16 00:17:33 +0000263 // Handle the non-pack case first.
264 if (!NTTP->isExpandedParameterPack()) {
265 if (!NTTP->getType()->isDependentType()) {
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000266 LV.merge(getLVForType(*NTTP->getType(), computation));
Douglas Gregor0231d8d2011-01-19 20:10:05 +0000267 }
268 continue;
269 }
Rafael Espindolaeeb9d9f2012-01-02 06:26:22 +0000270
John McCalldf25c432013-02-16 00:17:33 +0000271 // 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);
274 if (!type->isDependentType())
George Burgess IV35cb4f82017-08-09 04:12:17 +0000275 LV.merge(getTypeLinkageAndVisibility(type));
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000276 }
John McCalldf25c432013-02-16 00:17:33 +0000277 continue;
Douglas Gregor0231d8d2011-01-19 20:10:05 +0000278 }
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000279
John McCalldf25c432013-02-16 00:17:33 +0000280 // Template template parameters can be restricted by their
281 // template parameters, recursively.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000282 const auto *TTP = cast<TemplateTemplateParmDecl>(P);
John McCalldf25c432013-02-16 00:17:33 +0000283
284 // Handle the non-pack case first.
285 if (!TTP->isExpandedParameterPack()) {
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000286 LV.merge(getLVForTemplateParameterList(TTP->getTemplateParameters(),
287 computation));
John McCalldf25c432013-02-16 00:17:33 +0000288 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(getLVForTemplateParameterList(
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000295 TTP->getExpansionTemplateParameters(i), computation));
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000296 }
297 }
298
John McCall457a04e2010-10-22 21:05:15 +0000299 return LV;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000300}
301
Eli Friedman7e346a82013-07-01 20:22:57 +0000302static const Decl *getOutermostFuncOrBlockContext(const Decl *D) {
Craig Topper36250ad2014-05-12 05:36:57 +0000303 const Decl *Ret = nullptr;
Rafael Espindolac1b38a22013-05-16 04:30:21 +0000304 const DeclContext *DC = D->getDeclContext();
305 while (DC->getDeclKind() != Decl::TranslationUnit) {
Eli Friedman7e346a82013-07-01 20:22:57 +0000306 if (isa<FunctionDecl>(DC) || isa<BlockDecl>(DC))
307 Ret = cast<Decl>(DC);
Rafael Espindolac1b38a22013-05-16 04:30:21 +0000308 DC = DC->getParent();
309 }
310 return Ret;
311}
312
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000313/// Get the most restrictive linkage for the types and
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000314/// declarations in the given template argument list.
John McCalldf25c432013-02-16 00:17:33 +0000315///
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.
George Burgess IV99db3ea2017-08-09 04:02:49 +0000318LinkageInfo
319LinkageComputer::getLVForTemplateArgumentList(ArrayRef<TemplateArgument> Args,
320 LVComputationKind computation) {
John McCalldf25c432013-02-16 00:17:33 +0000321 LinkageInfo LV;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000322
David Majnemerc7b85c42014-04-23 05:16:48 +0000323 for (const TemplateArgument &Arg : Args) {
324 switch (Arg.getKind()) {
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000325 case TemplateArgument::Null:
326 case TemplateArgument::Integral:
327 case TemplateArgument::Expression:
John McCalldf25c432013-02-16 00:17:33 +0000328 continue;
Rafael Espindolaeeb9d9f2012-01-02 06:26:22 +0000329
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000330 case TemplateArgument::Type:
David Majnemerc7b85c42014-04-23 05:16:48 +0000331 LV.merge(getLVForType(*Arg.getAsType(), computation));
John McCalldf25c432013-02-16 00:17:33 +0000332 continue;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000333
George Burgess IV00f70bd2018-03-01 05:43:23 +0000334 case TemplateArgument::Declaration: {
335 const NamedDecl *ND = Arg.getAsDecl();
336 assert(!usesTypeVisibility(ND));
337 LV.merge(getLVForDecl(ND, computation));
John McCalldf25c432013-02-16 00:17:33 +0000338 continue;
George Burgess IV00f70bd2018-03-01 05:43:23 +0000339 }
Eli Friedmanb826a002012-09-26 02:36:12 +0000340
341 case TemplateArgument::NullPtr:
George Burgess IV35cb4f82017-08-09 04:12:17 +0000342 LV.merge(getTypeLinkageAndVisibility(Arg.getNullPtrType()));
John McCalldf25c432013-02-16 00:17:33 +0000343 continue;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000344
345 case TemplateArgument::Template:
Douglas Gregore4ff4b52011-01-05 18:58:31 +0000346 case TemplateArgument::TemplateExpansion:
David Majnemerc7b85c42014-04-23 05:16:48 +0000347 if (TemplateDecl *Template =
348 Arg.getAsTemplateOrTemplatePattern().getAsTemplateDecl())
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000349 LV.merge(getLVForDecl(Template, computation));
John McCalldf25c432013-02-16 00:17:33 +0000350 continue;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000351
352 case TemplateArgument::Pack:
David Majnemerc7b85c42014-04-23 05:16:48 +0000353 LV.merge(getLVForTemplateArgumentList(Arg.getPackAsArray(), computation));
John McCalldf25c432013-02-16 00:17:33 +0000354 continue;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000355 }
John McCalldf25c432013-02-16 00:17:33 +0000356 llvm_unreachable("bad template argument kind");
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000357 }
358
John McCall457a04e2010-10-22 21:05:15 +0000359 return LV;
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000360}
361
George Burgess IV99db3ea2017-08-09 04:02:49 +0000362LinkageInfo
363LinkageComputer::getLVForTemplateArgumentList(const TemplateArgumentList &TArgs,
364 LVComputationKind computation) {
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000365 return getLVForTemplateArgumentList(TArgs.asArray(), computation);
John McCall8823c652010-08-13 08:35:10 +0000366}
367
John McCall5f46c482013-02-21 23:42:58 +0000368static bool shouldConsiderTemplateVisibility(const FunctionDecl *fn,
369 const FunctionTemplateSpecializationInfo *specInfo) {
370 // Include visibility from the template parameters and arguments
371 // only if this is not an explicit instantiation or specialization
372 // with direct explicit visibility. (Implicit instantiations won't
373 // have a direct attribute.)
374 if (!specInfo->isExplicitInstantiationOrSpecialization())
375 return true;
376
377 return !fn->hasAttr<VisibilityAttr>();
378}
379
John McCalldf25c432013-02-16 00:17:33 +0000380/// Merge in template-related linkage and visibility for the given
381/// function template specialization.
382///
383/// We don't need a computation kind here because we can assume
384/// LVForValue.
John McCall5f46c482013-02-21 23:42:58 +0000385///
NAKAMURA Takumi62eae082013-02-22 04:06:28 +0000386/// \param[out] LV the computation to use for the parent
George Burgess IV99db3ea2017-08-09 04:02:49 +0000387void LinkageComputer::mergeTemplateLV(
388 LinkageInfo &LV, const FunctionDecl *fn,
389 const FunctionTemplateSpecializationInfo *specInfo,
390 LVComputationKind computation) {
John McCall5f46c482013-02-21 23:42:58 +0000391 bool considerVisibility =
392 shouldConsiderTemplateVisibility(fn, specInfo);
John McCalldf25c432013-02-16 00:17:33 +0000393
394 // Merge information from the template parameters.
John McCall5f46c482013-02-21 23:42:58 +0000395 FunctionTemplateDecl *temp = specInfo->getTemplate();
John McCalldf25c432013-02-16 00:17:33 +0000396 LinkageInfo tempLV =
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000397 getLVForTemplateParameterList(temp->getTemplateParameters(), computation);
John McCalldf25c432013-02-16 00:17:33 +0000398 LV.mergeMaybeWithVisibility(tempLV, considerVisibility);
399
400 // Merge information from the template arguments.
401 const TemplateArgumentList &templateArgs = *specInfo->TemplateArguments;
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000402 LinkageInfo argsLV = getLVForTemplateArgumentList(templateArgs, computation);
John McCalldf25c432013-02-16 00:17:33 +0000403 LV.mergeMaybeWithVisibility(argsLV, considerVisibility);
John McCallb8c604a2011-06-27 23:06:04 +0000404}
405
John McCall5f46c482013-02-21 23:42:58 +0000406/// Does the given declaration have a direct visibility attribute
407/// that would match the given rules?
408static bool hasDirectVisibilityAttribute(const NamedDecl *D,
409 LVComputationKind computation) {
Richard Smithfbe7b462017-09-22 02:22:32 +0000410 if (computation.IgnoreAllVisibility)
John McCall5f46c482013-02-21 23:42:58 +0000411 return false;
Richard Smithfbe7b462017-09-22 02:22:32 +0000412
413 return (computation.isTypeVisibility() && D->hasAttr<TypeVisibilityAttr>()) ||
414 D->hasAttr<VisibilityAttr>();
John McCall5f46c482013-02-21 23:42:58 +0000415}
416
John McCalld041a9b2013-02-20 01:54:26 +0000417/// Should we consider visibility associated with the template
418/// arguments and parameters of the given class template specialization?
419static bool shouldConsiderTemplateVisibility(
420 const ClassTemplateSpecializationDecl *spec,
421 LVComputationKind computation) {
John McCalldf25c432013-02-16 00:17:33 +0000422 // Include visibility from the template parameters and arguments
423 // only if this is not an explicit instantiation or specialization
424 // with direct explicit visibility (and note that implicit
425 // instantiations won't have a direct attribute).
426 //
427 // Furthermore, we want to ignore template parameters and arguments
John McCalld041a9b2013-02-20 01:54:26 +0000428 // for an explicit specialization when computing the visibility of a
429 // member thereof with explicit visibility.
John McCalldf25c432013-02-16 00:17:33 +0000430 //
431 // This is a bit complex; let's unpack it.
432 //
433 // An explicit class specialization is an independent, top-level
434 // declaration. As such, if it or any of its members has an
435 // explicit visibility attribute, that must directly express the
436 // user's intent, and we should honor it. The same logic applies to
437 // an explicit instantiation of a member of such a thing.
John McCalld041a9b2013-02-20 01:54:26 +0000438
439 // Fast path: if this is not an explicit instantiation or
440 // specialization, we always want to consider template-related
441 // visibility restrictions.
442 if (!spec->isExplicitInstantiationOrSpecialization())
443 return true;
444
445 // This is the 'member thereof' check.
446 if (spec->isExplicitSpecialization() &&
447 hasExplicitVisibilityAlready(computation))
448 return false;
449
John McCall5f46c482013-02-21 23:42:58 +0000450 return !hasDirectVisibilityAttribute(spec, computation);
John McCalld041a9b2013-02-20 01:54:26 +0000451}
452
453/// Merge in template-related linkage and visibility for the given
454/// class template specialization.
George Burgess IV99db3ea2017-08-09 04:02:49 +0000455void LinkageComputer::mergeTemplateLV(
456 LinkageInfo &LV, const ClassTemplateSpecializationDecl *spec,
457 LVComputationKind computation) {
John McCalld041a9b2013-02-20 01:54:26 +0000458 bool considerVisibility = shouldConsiderTemplateVisibility(spec, computation);
John McCalldf25c432013-02-16 00:17:33 +0000459
460 // Merge information from the template parameters, but ignore
461 // visibility if we're only considering template arguments.
462
John McCalld041a9b2013-02-20 01:54:26 +0000463 ClassTemplateDecl *temp = spec->getSpecializedTemplate();
John McCalldf25c432013-02-16 00:17:33 +0000464 LinkageInfo tempLV =
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000465 getLVForTemplateParameterList(temp->getTemplateParameters(), computation);
John McCalldf25c432013-02-16 00:17:33 +0000466 LV.mergeMaybeWithVisibility(tempLV,
John McCalld041a9b2013-02-20 01:54:26 +0000467 considerVisibility && !hasExplicitVisibilityAlready(computation));
John McCalldf25c432013-02-16 00:17:33 +0000468
469 // Merge information from the template arguments. We ignore
470 // template-argument visibility if we've got an explicit
471 // instantiation with a visibility attribute.
472 const TemplateArgumentList &templateArgs = spec->getTemplateArgs();
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000473 LinkageInfo argsLV = getLVForTemplateArgumentList(templateArgs, computation);
Rafael Espindola503276b2013-05-30 21:23:15 +0000474 if (considerVisibility)
475 LV.mergeVisibility(argsLV);
476 LV.mergeExternalVisibility(argsLV);
John McCallb8c604a2011-06-27 23:06:04 +0000477}
478
Larisse Voufo5899e192014-07-02 23:08:34 +0000479/// Should we consider visibility associated with the template
480/// arguments and parameters of the given variable template
481/// specialization? As usual, follow class template specialization
482/// logic up to initialization.
483static bool shouldConsiderTemplateVisibility(
484 const VarTemplateSpecializationDecl *spec,
485 LVComputationKind computation) {
486 // Include visibility from the template parameters and arguments
487 // only if this is not an explicit instantiation or specialization
488 // with direct explicit visibility (and note that implicit
489 // instantiations won't have a direct attribute).
490 if (!spec->isExplicitInstantiationOrSpecialization())
491 return true;
492
493 // An explicit variable specialization is an independent, top-level
494 // declaration. As such, if it has an explicit visibility attribute,
495 // that must directly express the user's intent, and we should honor
496 // it.
497 if (spec->isExplicitSpecialization() &&
498 hasExplicitVisibilityAlready(computation))
499 return false;
500
501 return !hasDirectVisibilityAttribute(spec, computation);
502}
503
504/// Merge in template-related linkage and visibility for the given
505/// variable template specialization. As usual, follow class template
506/// specialization logic up to initialization.
George Burgess IV99db3ea2017-08-09 04:02:49 +0000507void LinkageComputer::mergeTemplateLV(LinkageInfo &LV,
508 const VarTemplateSpecializationDecl *spec,
509 LVComputationKind computation) {
Larisse Voufo5899e192014-07-02 23:08:34 +0000510 bool considerVisibility = shouldConsiderTemplateVisibility(spec, computation);
511
512 // Merge information from the template parameters, but ignore
513 // visibility if we're only considering template arguments.
514
515 VarTemplateDecl *temp = spec->getSpecializedTemplate();
516 LinkageInfo tempLV =
517 getLVForTemplateParameterList(temp->getTemplateParameters(), computation);
518 LV.mergeMaybeWithVisibility(tempLV,
519 considerVisibility && !hasExplicitVisibilityAlready(computation));
520
521 // Merge information from the template arguments. We ignore
522 // template-argument visibility if we've got an explicit
523 // instantiation with a visibility attribute.
524 const TemplateArgumentList &templateArgs = spec->getTemplateArgs();
525 LinkageInfo argsLV = getLVForTemplateArgumentList(templateArgs, computation);
526 if (considerVisibility)
527 LV.mergeVisibility(argsLV);
528 LV.mergeExternalVisibility(argsLV);
529}
530
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000531static bool useInlineVisibilityHidden(const NamedDecl *D) {
532 // FIXME: we should warn if -fvisibility-inlines-hidden is used with c.
Rafael Espindola5cc78902012-07-13 23:26:43 +0000533 const LangOptions &Opts = D->getASTContext().getLangOpts();
534 if (!Opts.CPlusPlus || !Opts.InlineVisibilityHidden)
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000535 return false;
536
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000537 const auto *FD = dyn_cast<FunctionDecl>(D);
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000538 if (!FD)
539 return false;
540
541 TemplateSpecializationKind TSK = TSK_Undeclared;
542 if (FunctionTemplateSpecializationInfo *spec
543 = FD->getTemplateSpecializationInfo()) {
544 TSK = spec->getTemplateSpecializationKind();
545 } else if (MemberSpecializationInfo *MSI =
546 FD->getMemberSpecializationInfo()) {
547 TSK = MSI->getTemplateSpecializationKind();
548 }
549
Craig Topper36250ad2014-05-12 05:36:57 +0000550 const FunctionDecl *Def = nullptr;
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000551 // InlineVisibilityHidden only applies to definitions, and
552 // isInlined() only gives meaningful answers on definitions
553 // anyway.
554 return TSK != TSK_ExplicitInstantiationDeclaration &&
555 TSK != TSK_ExplicitInstantiationDefinition &&
Rafael Espindolafb9d4b42012-10-11 16:32:25 +0000556 FD->hasBody(Def) && Def->isInlined() && !Def->hasAttr<GNUInlineAttr>();
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000557}
558
Rafael Espindola593537a2013-05-05 20:15:21 +0000559template <typename T> static bool isFirstInExternCContext(T *D) {
Rafael Espindola8db352d2013-10-17 15:37:26 +0000560 const T *First = D->getFirstDecl();
Rafael Espindola593537a2013-05-05 20:15:21 +0000561 return First->isInExternCContext();
Rafael Espindolaf4187652013-02-14 01:18:37 +0000562}
563
Richard Smith03c05032014-02-17 23:34:47 +0000564static bool isSingleLineLanguageLinkage(const Decl &D) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000565 if (const auto *SD = dyn_cast<LinkageSpecDecl>(D.getDeclContext()))
Richard Smith03c05032014-02-17 23:34:47 +0000566 if (!SD->hasBraces())
Rafael Espindola327be3c2013-04-26 01:30:23 +0000567 return true;
568 return false;
569}
570
Richard Smitha5bbbfe2019-04-18 21:12:54 +0000571/// Determine whether D is declared in the purview of a named module.
572static bool isInModulePurview(const NamedDecl *D) {
573 if (auto *M = D->getOwningModule())
574 return M->isModulePurview();
575 return false;
576}
577
Ali Tamurb6a8a6c2019-04-19 02:15:57 +0000578static bool isExportedFromModuleInterfaceUnit(const NamedDecl *D) {
Richard Smithbecb92d2017-10-10 22:33:17 +0000579 // FIXME: Handle isModulePrivate.
Richard Smith1283e982017-07-07 20:04:28 +0000580 switch (D->getModuleOwnershipKind()) {
581 case Decl::ModuleOwnershipKind::Unowned:
582 case Decl::ModuleOwnershipKind::ModulePrivate:
583 return false;
584 case Decl::ModuleOwnershipKind::Visible:
585 case Decl::ModuleOwnershipKind::VisibleWhenImported:
Richard Smitha5bbbfe2019-04-18 21:12:54 +0000586 return isInModulePurview(D);
Richard Smith1283e982017-07-07 20:04:28 +0000587 }
588 llvm_unreachable("unexpected module ownership kind");
589}
590
591static LinkageInfo getInternalLinkageFor(const NamedDecl *D) {
592 // Internal linkage declarations within a module interface unit are modeled
593 // as "module-internal linkage", which means that they have internal linkage
594 // formally but can be indirectly accessed from outside the module via inline
595 // functions and templates defined within the module.
Richard Smitha5bbbfe2019-04-18 21:12:54 +0000596 if (isInModulePurview(D))
597 return LinkageInfo(ModuleInternalLinkage, DefaultVisibility, false);
Richard Smith1283e982017-07-07 20:04:28 +0000598
599 return LinkageInfo::internal();
600}
601
602static LinkageInfo getExternalLinkageFor(const NamedDecl *D) {
603 // C++ Modules TS [basic.link]/6.8:
604 // - A name declared at namespace scope that does not have internal linkage
605 // by the previous rules and that is introduced by a non-exported
606 // declaration has module linkage.
Richard Smith96451e32019-04-19 02:46:50 +0000607 if (isInModulePurview(D) && !isExportedFromModuleInterfaceUnit(
608 cast<NamedDecl>(D->getCanonicalDecl())))
Richard Smitha5bbbfe2019-04-18 21:12:54 +0000609 return LinkageInfo(ModuleLinkage, DefaultVisibility, false);
Richard Smith1283e982017-07-07 20:04:28 +0000610
611 return LinkageInfo::external();
612}
613
Richard Smithbb750682019-04-26 01:51:08 +0000614static StorageClass getStorageClass(const Decl *D) {
615 if (auto *TD = dyn_cast<TemplateDecl>(D))
616 D = TD->getTemplatedDecl();
Hans Wennborgb0dbc9612019-05-14 10:11:33 +0000617 if (D) {
618 if (auto *VD = dyn_cast<VarDecl>(D))
619 return VD->getStorageClass();
620 if (auto *FD = dyn_cast<FunctionDecl>(D))
621 return FD->getStorageClass();
Richard Smithbb750682019-04-26 01:51:08 +0000622 }
623 return SC_None;
624}
625
George Burgess IV99db3ea2017-08-09 04:02:49 +0000626LinkageInfo
627LinkageComputer::getLVForNamespaceScopeDecl(const NamedDecl *D,
Richard Smithc95d2c52017-09-22 04:25:05 +0000628 LVComputationKind computation,
629 bool IgnoreVarTypeLinkage) {
Sebastian Redl50c68252010-08-31 00:36:30 +0000630 assert(D->getDeclContext()->getRedeclContext()->isFileContext() &&
Douglas Gregorf73b2822009-11-25 22:24:25 +0000631 "Not a name having namespace scope");
632 ASTContext &Context = D->getASTContext();
633
634 // C++ [basic.link]p3:
635 // A name having namespace scope (3.3.6) has internal linkage if it
636 // is the name of
Ilya Biryukovb8292c92019-04-24 08:50:24 +0000637
Hans Wennborgb0dbc9612019-05-14 10:11:33 +0000638 if (getStorageClass(D->getCanonicalDecl()) == SC_Static) {
Richard Smithbb750682019-04-26 01:51:08 +0000639 // - a variable, variable template, function, or function template
640 // that is explicitly declared static; or
641 // (This bullet corresponds to C99 6.2.2p3.)
642 return getInternalLinkageFor(D);
643 }
644
645 if (const auto *Var = dyn_cast<VarDecl>(D)) {
646 // - a non-template variable of non-volatile const-qualified type, unless
647 // - it is explicitly declared extern, or
648 // - it is inline or exported, or
649 // - it was previously declared and the prior declaration did not have
650 // internal linkage
651 // (There is no equivalent in C99.)
David Blaikiebbafb8a2012-03-11 07:00:24 +0000652 if (Context.getLangOpts().CPlusPlus &&
Fangrui Song6907ce22018-07-30 19:24:48 +0000653 Var->getType().isConstQualified() &&
Richard Smith62f19e72016-06-25 00:15:56 +0000654 !Var->getType().isVolatileQualified() &&
Richard Smith1283e982017-07-07 20:04:28 +0000655 !Var->isInline() &&
Richard Smithbb750682019-04-26 01:51:08 +0000656 !isExportedFromModuleInterfaceUnit(Var) &&
657 !isa<VarTemplateSpecializationDecl>(Var) &&
658 !Var->getDescribedVarTemplate()) {
Rafael Espindola985a3ab2013-04-03 19:22:20 +0000659 const VarDecl *PrevVar = Var->getPreviousDecl();
Rafael Espindola985a3ab2013-04-03 19:22:20 +0000660 if (PrevVar)
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000661 return getLVForDecl(PrevVar, computation);
Rafael Espindola6ae7e502013-04-03 19:27:57 +0000662
663 if (Var->getStorageClass() != SC_Extern &&
Rafael Espindola327be3c2013-04-26 01:30:23 +0000664 Var->getStorageClass() != SC_PrivateExtern &&
Richard Smith03c05032014-02-17 23:34:47 +0000665 !isSingleLineLanguageLinkage(*Var))
Richard Smith1283e982017-07-07 20:04:28 +0000666 return getInternalLinkageFor(Var);
Rafael Espindola6ae7e502013-04-03 19:27:57 +0000667 }
668
669 for (const VarDecl *PrevVar = Var->getPreviousDecl(); PrevVar;
670 PrevVar = PrevVar->getPreviousDecl()) {
671 if (PrevVar->getStorageClass() == SC_PrivateExtern &&
672 Var->getStorageClass() == SC_None)
George Burgess IV35cb4f82017-08-09 04:12:17 +0000673 return getDeclLinkageAndVisibility(PrevVar);
Rafael Espindola6ae7e502013-04-03 19:27:57 +0000674 // Explicitly declared static.
675 if (PrevVar->getStorageClass() == SC_Static)
Richard Smith1283e982017-07-07 20:04:28 +0000676 return getInternalLinkageFor(Var);
Fariborz Jahanian8feee2d2011-06-16 20:14:50 +0000677 }
David Majnemer18fac3b2014-12-10 22:58:14 +0000678 } else if (const auto *IFD = dyn_cast<IndirectFieldDecl>(D)) {
679 // - a data member of an anonymous union.
680 const VarDecl *VD = IFD->getVarDecl();
681 assert(VD && "Expected a VarDecl in this IndirectFieldDecl!");
Richard Smithc95d2c52017-09-22 04:25:05 +0000682 return getLVForNamespaceScopeDecl(VD, computation, IgnoreVarTypeLinkage);
Douglas Gregorf73b2822009-11-25 22:24:25 +0000683 }
David Majnemer0eb8bbd2013-10-23 20:52:43 +0000684 assert(!isa<FieldDecl>(D) && "Didn't expect a FieldDecl!");
Douglas Gregorf73b2822009-11-25 22:24:25 +0000685
Richard Smithbb750682019-04-26 01:51:08 +0000686 // FIXME: This gives internal linkage to names that should have no linkage
687 // (those not covered by [basic.link]p6).
Chandler Carruth9682a2fd2011-02-24 19:03:39 +0000688 if (D->isInAnonymousNamespace()) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000689 const auto *Var = dyn_cast<VarDecl>(D);
690 const auto *Func = dyn_cast<FunctionDecl>(D);
Richard Smithdf963a32017-09-22 22:21:44 +0000691 // FIXME: The check for extern "C" here is not justified by the standard
692 // wording, but we retain it from the pre-DR1113 model to avoid breaking
693 // code.
Richard Smith1283e982017-07-07 20:04:28 +0000694 //
695 // C++11 [basic.link]p4:
696 // An unnamed namespace or a namespace declared directly or indirectly
697 // within an unnamed namespace has internal linkage.
Rafael Espindola593537a2013-05-05 20:15:21 +0000698 if ((!Var || !isFirstInExternCContext(Var)) &&
699 (!Func || !isFirstInExternCContext(Func)))
Richard Smithdf963a32017-09-22 22:21:44 +0000700 return getInternalLinkageFor(D);
Chandler Carruth9682a2fd2011-02-24 19:03:39 +0000701 }
John McCallb7139c42010-10-28 04:18:25 +0000702
John McCall457a04e2010-10-22 21:05:15 +0000703 // Set up the defaults.
704
705 // C99 6.2.2p5:
706 // If the declaration of an identifier for an object has file
707 // scope and no storage-class specifier, its linkage is
708 // external.
Richard Smithdd8b5332017-09-04 05:37:53 +0000709 LinkageInfo LV = getExternalLinkageFor(D);
John McCallc273f242010-10-30 11:50:40 +0000710
John McCalld041a9b2013-02-20 01:54:26 +0000711 if (!hasExplicitVisibilityAlready(computation)) {
David Blaikie05785d12013-02-20 22:23:23 +0000712 if (Optional<Visibility> Vis = getExplicitVisibility(D, computation)) {
Rafael Espindola7a5543d2012-04-19 02:22:07 +0000713 LV.mergeVisibility(*Vis, true);
Rafael Espindola78158af2012-04-16 18:46:26 +0000714 } else {
715 // If we're declared in a namespace with a visibility attribute,
John McCalldf25c432013-02-16 00:17:33 +0000716 // use that namespace's visibility, and it still counts as explicit.
Rafael Espindola78158af2012-04-16 18:46:26 +0000717 for (const DeclContext *DC = D->getDeclContext();
718 !isa<TranslationUnitDecl>(DC);
719 DC = DC->getParent()) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000720 const auto *ND = dyn_cast<NamespaceDecl>(DC);
Rafael Espindola78158af2012-04-16 18:46:26 +0000721 if (!ND) continue;
David Blaikie05785d12013-02-20 22:23:23 +0000722 if (Optional<Visibility> Vis = getExplicitVisibility(ND, computation)) {
Rafael Espindola7a5543d2012-04-19 02:22:07 +0000723 LV.mergeVisibility(*Vis, true);
Rafael Espindola78158af2012-04-16 18:46:26 +0000724 break;
725 }
726 }
727 }
Rafael Espindola78158af2012-04-16 18:46:26 +0000728
John McCalldf25c432013-02-16 00:17:33 +0000729 // Add in global settings if the above didn't give us direct visibility.
Rafael Espindola4a5da442013-02-27 02:56:45 +0000730 if (!LV.isVisibilityExplicit()) {
John McCallb4a99d32013-02-19 01:57:35 +0000731 // Use global type/value visibility as appropriate.
Richard Smithfbe7b462017-09-22 02:22:32 +0000732 Visibility globalVisibility =
733 computation.isValueVisibility()
734 ? Context.getLangOpts().getValueVisibilityMode()
735 : Context.getLangOpts().getTypeVisibilityMode();
John McCallb4a99d32013-02-19 01:57:35 +0000736 LV.mergeVisibility(globalVisibility, /*explicit*/ false);
John McCalldf25c432013-02-16 00:17:33 +0000737
738 // If we're paying attention to global visibility, apply
739 // -finline-visibility-hidden if this is an inline method.
740 if (useInlineVisibilityHidden(D))
Reid Klecknera52d1512018-10-10 21:59:56 +0000741 LV.mergeVisibility(HiddenVisibility, /*visibilityExplicit=*/false);
John McCalldf25c432013-02-16 00:17:33 +0000742 }
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000743 }
Rafael Espindolaaf690f52012-04-19 02:55:01 +0000744
Douglas Gregorf73b2822009-11-25 22:24:25 +0000745 // C++ [basic.link]p4:
John McCall457a04e2010-10-22 21:05:15 +0000746
Richard Smithbb750682019-04-26 01:51:08 +0000747 // A name having namespace scope that has not been given internal linkage
748 // above and that is the name of
749 // [...bullets...]
750 // has its linkage determined as follows:
751 // - if the enclosing namespace has internal linkage, the name has
752 // internal linkage; [handled above]
753 // - otherwise, if the declaration of the name is attached to a named
754 // module and is not exported, the name has module linkage;
755 // - otherwise, the name has external linkage.
756 // LV is currently set up to handle the last two bullets.
Douglas Gregorf73b2822009-11-25 22:24:25 +0000757 //
Richard Smithbb750682019-04-26 01:51:08 +0000758 // The bullets are:
759
760 // - a variable; or
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000761 if (const auto *Var = dyn_cast<VarDecl>(D)) {
John McCall37bb6c92010-10-29 22:22:43 +0000762 // GCC applies the following optimization to variables and static
763 // data members, but not to functions:
764 //
John McCall457a04e2010-10-22 21:05:15 +0000765 // Modify the variable's LV by the LV of its type unless this is
766 // C or extern "C". This follows from [basic.link]p9:
767 // A type without linkage shall not be used as the type of a
768 // variable or function with external linkage unless
769 // - the entity has C language linkage, or
770 // - the entity is declared within an unnamed namespace, or
771 // - the entity is not used or is defined in the same
772 // translation unit.
773 // and [basic.link]p10:
774 // ...the types specified by all declarations referring to a
775 // given variable or function shall be identical...
776 // C does not have an equivalent rule.
777 //
John McCall5fe84122010-10-26 04:59:26 +0000778 // Ignore this if we've got an explicit attribute; the user
779 // probably knows what they're doing.
780 //
John McCall457a04e2010-10-22 21:05:15 +0000781 // Note that we don't want to make the variable non-external
782 // because of this, but unique-external linkage suits us.
Richard Smithc95d2c52017-09-22 04:25:05 +0000783 if (Context.getLangOpts().CPlusPlus && !isFirstInExternCContext(Var) &&
784 !IgnoreVarTypeLinkage) {
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000785 LinkageInfo TypeLV = getLVForType(*Var->getType(), computation);
Richard Smith405e2db2017-09-20 07:22:00 +0000786 if (!isExternallyVisible(TypeLV.getLinkage()))
John McCallc273f242010-10-30 11:50:40 +0000787 return LinkageInfo::uniqueExternal();
Rafael Espindola4a5da442013-02-27 02:56:45 +0000788 if (!LV.isVisibilityExplicit())
John McCalldf25c432013-02-16 00:17:33 +0000789 LV.mergeVisibility(TypeLV);
John McCall37bb6c92010-10-29 22:22:43 +0000790 }
791
John McCall23032652010-11-02 18:38:13 +0000792 if (Var->getStorageClass() == SC_PrivateExtern)
Rafael Espindola7a5543d2012-04-19 02:22:07 +0000793 LV.mergeVisibility(HiddenVisibility, true);
John McCall23032652010-11-02 18:38:13 +0000794
Rafael Espindolad5ed0332012-11-12 04:10:23 +0000795 // Note that Sema::MergeVarDecl already takes care of implementing
796 // C99 6.2.2p4 and propagating the visibility attribute, so we don't have
797 // to do it here.
Douglas Gregorf73b2822009-11-25 22:24:25 +0000798
Larisse Voufo5899e192014-07-02 23:08:34 +0000799 // As per function and class template specializations (below),
800 // consider LV for the template and template arguments. We're at file
801 // scope, so we do not need to worry about nested specializations.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000802 if (const auto *spec = dyn_cast<VarTemplateSpecializationDecl>(Var)) {
Larisse Voufo5899e192014-07-02 23:08:34 +0000803 mergeTemplateLV(LV, spec, computation);
804 }
805
Richard Smithbb750682019-04-26 01:51:08 +0000806 // - a function; or
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000807 } else if (const auto *Function = dyn_cast<FunctionDecl>(D)) {
John McCall2efaf112010-10-28 07:07:52 +0000808 // In theory, we can modify the function's LV by the LV of its
809 // type unless it has C linkage (see comment above about variables
810 // for justification). In practice, GCC doesn't do this, so it's
811 // just too painful to make work.
John McCall457a04e2010-10-22 21:05:15 +0000812
John McCall23032652010-11-02 18:38:13 +0000813 if (Function->getStorageClass() == SC_PrivateExtern)
Rafael Espindola7a5543d2012-04-19 02:22:07 +0000814 LV.mergeVisibility(HiddenVisibility, true);
John McCall23032652010-11-02 18:38:13 +0000815
Rafael Espindolaa508c5d2012-11-21 02:47:19 +0000816 // 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.
Douglas Gregorf73b2822009-11-25 22:24:25 +0000819
John McCallf768aa72011-02-10 06:50:24 +0000820 // 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.
Richard Smith99f54792018-01-03 02:34:35 +0000824 if (Context.getLangOpts().CPlusPlus && !isFirstInExternCContext(Function)) {
Richard Smithc95d2c52017-09-22 04:25:05 +0000825 // Only look at the type-as-written. Otherwise, deducing the return type
826 // of a function could change its linkage.
Richard Smith50f4afc2013-05-12 23:17:59 +0000827 QualType TypeAsWritten = Function->getType();
828 if (TypeSourceInfo *TSI = Function->getTypeSourceInfo())
829 TypeAsWritten = TSI->getType();
Richard Smith405e2db2017-09-20 07:22:00 +0000830 if (!isExternallyVisible(TypeAsWritten->getLinkage()))
Richard Smith50f4afc2013-05-12 23:17:59 +0000831 return LinkageInfo::uniqueExternal();
832 }
John McCallf768aa72011-02-10 06:50:24 +0000833
John McCall5f46c482013-02-21 23:42:58 +0000834 // 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.
John McCallb8c604a2011-06-27 23:06:04 +0000837 if (FunctionTemplateSpecializationInfo *specInfo
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000838 = Function->getTemplateSpecializationInfo()) {
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000839 mergeTemplateLV(LV, Function, specInfo, computation);
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000840 }
841
Douglas Gregorf73b2822009-11-25 22:24:25 +0000842 // - 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
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000848 } else if (const auto *Tag = dyn_cast<TagDecl>(D)) {
John McCall457a04e2010-10-22 21:05:15 +0000849 // Unnamed tags have no linkage.
John McCall5ea95772013-03-09 00:54:27 +0000850 if (!Tag->hasNameForLinkage())
John McCallc273f242010-10-30 11:50:40 +0000851 return LinkageInfo::none();
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000852
John McCall457a04e2010-10-22 21:05:15 +0000853 // If this is a class template specialization, consider the
John McCall5f46c482013-02-21 23:42:58 +0000854 // linkage of the template and template arguments. We're at file
855 // scope, so we do not need to worry about nested specializations.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000856 if (const auto *spec = dyn_cast<ClassTemplateSpecializationDecl>(Tag)) {
John McCalldf25c432013-02-16 00:17:33 +0000857 mergeTemplateLV(LV, spec, computation);
Douglas Gregor7dc5c172010-02-03 09:33:45 +0000858 }
Douglas Gregorf73b2822009-11-25 22:24:25 +0000859
Richard Smithbb750682019-04-26 01:51:08 +0000860 // FIXME: This is not part of the C++ standard any more.
861 // - an enumerator belonging to an enumeration with external linkage; or
John McCall457a04e2010-10-22 21:05:15 +0000862 } else if (isa<EnumConstantDecl>(D)) {
Rafael Espindola46cb6f12012-04-21 23:28:21 +0000863 LinkageInfo EnumLV = getLVForDecl(cast<NamedDecl>(D->getDeclContext()),
John McCalldf25c432013-02-16 00:17:33 +0000864 computation);
Rafael Espindolab97e8962013-05-27 14:14:42 +0000865 if (!isExternalFormalLinkage(EnumLV.getLinkage()))
John McCallc273f242010-10-30 11:50:40 +0000866 return LinkageInfo::none();
867 LV.merge(EnumLV);
Douglas Gregorf73b2822009-11-25 22:24:25 +0000868
Richard Smithbb750682019-04-26 01:51:08 +0000869 // - a template
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000870 } else if (const auto *temp = dyn_cast<TemplateDecl>(D)) {
John McCalld041a9b2013-02-20 01:54:26 +0000871 bool considerVisibility = !hasExplicitVisibilityAlready(computation);
John McCalldf25c432013-02-16 00:17:33 +0000872 LinkageInfo tempLV =
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000873 getLVForTemplateParameterList(temp->getTemplateParameters(), computation);
John McCalldf25c432013-02-16 00:17:33 +0000874 LV.mergeMaybeWithVisibility(tempLV, considerVisibility);
875
Richard Smithbb750682019-04-26 01:51:08 +0000876 // 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.
Richard Smith1283e982017-07-07 20:04:28 +0000879 //
880 // We handled names in anonymous namespaces above.
881 } else if (isa<NamespaceDecl>(D)) {
John McCall457a04e2010-10-22 21:05:15 +0000882 return LV;
Douglas Gregorf73b2822009-11-25 22:24:25 +0000883
John McCall457a04e2010-10-22 21:05:15 +0000884 // By extension, we assign external linkage to Objective-C
885 // interfaces.
886 } else if (isa<ObjCInterfaceDecl>(D)) {
887 // fallout
888
Richard Smith97135cc2015-11-12 22:19:45 +0000889 } else if (auto *TD = dyn_cast<TypedefNameDecl>(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
Richard Smithbab6df82020-04-11 22:15:29 -0700895 } else if (isa<MSGuidDecl>(D)) {
896 // A GUID behaves like an inline variable with external linkage. Fall
897 // through.
898
John McCall457a04e2010-10-22 21:05:15 +0000899 // Everything not covered here has no linkage.
900 } else {
John McCallc273f242010-10-30 11:50:40 +0000901 return LinkageInfo::none();
John McCall457a04e2010-10-22 21:05:15 +0000902 }
903
Richard Smithc445d5d2017-10-03 01:58:15 +0000904 // If we ended up with non-externally-visible linkage, visibility should
John McCall457a04e2010-10-22 21:05:15 +0000905 // always be default.
Richard Smithc445d5d2017-10-03 01:58:15 +0000906 if (!isExternallyVisible(LV.getLinkage()))
Rafael Espindola4a5da442013-02-27 02:56:45 +0000907 return LinkageInfo(LV.getLinkage(), DefaultVisibility, false);
John McCall457a04e2010-10-22 21:05:15 +0000908
Alexey Bataevbbc328c2019-11-21 11:30:43 -0500909 // Mark the symbols as hidden when compiling for the device.
910 if (Context.getLangOpts().OpenMP && Context.getLangOpts().OpenMPIsDevice)
911 LV.mergeVisibility(HiddenVisibility, /*newExplicit=*/false);
912
John McCall457a04e2010-10-22 21:05:15 +0000913 return LV;
Douglas Gregorf73b2822009-11-25 22:24:25 +0000914}
915
George Burgess IV99db3ea2017-08-09 04:02:49 +0000916LinkageInfo
917LinkageComputer::getLVForClassMember(const NamedDecl *D,
Richard Smithc95d2c52017-09-22 04:25:05 +0000918 LVComputationKind computation,
919 bool IgnoreVarTypeLinkage) {
John McCall457a04e2010-10-22 21:05:15 +0000920 // Only certain class members have linkage. Note that fields don't
921 // really have linkage, but it's convenient to say they do for the
922 // purposes of calculating linkage of pointer-to-data-member
923 // template arguments.
Richard Smith26d11be2014-01-08 01:51:59 +0000924 //
925 // Templates also don't officially have linkage, but since we ignore
926 // the C++ standard and look at template arguments when determining
927 // linkage and visibility of a template specialization, we might hit
928 // a template template argument that way. If we do, we need to
929 // consider its linkage.
John McCall8823c652010-08-13 08:35:10 +0000930 if (!(isa<CXXMethodDecl>(D) ||
931 isa<VarDecl>(D) ||
John McCall457a04e2010-10-22 21:05:15 +0000932 isa<FieldDecl>(D) ||
David Majnemer0eb8bbd2013-10-23 20:52:43 +0000933 isa<IndirectFieldDecl>(D) ||
Richard Smith26d11be2014-01-08 01:51:59 +0000934 isa<TagDecl>(D) ||
935 isa<TemplateDecl>(D)))
John McCallc273f242010-10-30 11:50:40 +0000936 return LinkageInfo::none();
John McCall8823c652010-08-13 08:35:10 +0000937
John McCall07072662010-11-02 01:45:15 +0000938 LinkageInfo LV;
939
John McCall07072662010-11-02 01:45:15 +0000940 // If we have an explicit visibility attribute, merge that in.
John McCalld041a9b2013-02-20 01:54:26 +0000941 if (!hasExplicitVisibilityAlready(computation)) {
David Blaikie05785d12013-02-20 22:23:23 +0000942 if (Optional<Visibility> Vis = getExplicitVisibility(D, computation))
Douglas Gregor1baf38f2011-03-26 12:10:19 +0000943 LV.mergeVisibility(*Vis, true);
Rafael Espindolac7c7ad52012-07-13 14:25:36 +0000944 // If we're paying attention to global visibility, apply
945 // -finline-visibility-hidden if this is an inline method.
946 //
947 // Note that we do this before merging information about
948 // the class visibility.
Rafael Espindola4a5da442013-02-27 02:56:45 +0000949 if (!LV.isVisibilityExplicit() && useInlineVisibilityHidden(D))
Reid Klecknera52d1512018-10-10 21:59:56 +0000950 LV.mergeVisibility(HiddenVisibility, /*visibilityExplicit=*/false);
John McCall07072662010-11-02 01:45:15 +0000951 }
Rafael Espindola53cf2192012-04-19 05:50:08 +0000952
953 // If this class member has an explicit visibility attribute, the only
954 // thing that can change its visibility is the template arguments, so
Sylvestre Ledru830885c2012-07-23 08:59:39 +0000955 // only look for them when processing the class.
John McCalld041a9b2013-02-20 01:54:26 +0000956 LVComputationKind classComputation = computation;
Rafael Espindola4a5da442013-02-27 02:56:45 +0000957 if (LV.isVisibilityExplicit())
John McCalld041a9b2013-02-20 01:54:26 +0000958 classComputation = withExplicitVisibilityAlready(computation);
Rafael Espindola505a7c82012-04-16 18:25:01 +0000959
John McCall5f46c482013-02-21 23:42:58 +0000960 LinkageInfo classLV =
961 getLVForDecl(cast<RecordDecl>(D->getDeclContext()), classComputation);
Richard Smithcdb06f22017-09-23 04:02:17 +0000962 // The member has the same linkage as the class. If that's not externally
963 // visible, we don't need to compute anything about the linkage.
964 // FIXME: If we're only computing linkage, can we bail out here?
Rafael Espindolae6190db2013-05-28 02:22:10 +0000965 if (!isExternallyVisible(classLV.getLinkage()))
Richard Smithcdb06f22017-09-23 04:02:17 +0000966 return classLV;
Rafael Espindolae6190db2013-05-28 02:22:10 +0000967
968
John McCall5f46c482013-02-21 23:42:58 +0000969 // Otherwise, don't merge in classLV yet, because in certain cases
970 // we need to completely ignore the visibility from it.
971
972 // Specifically, if this decl exists and has an explicit attribute.
Craig Topper36250ad2014-05-12 05:36:57 +0000973 const NamedDecl *explicitSpecSuppressor = nullptr;
John McCall5f46c482013-02-21 23:42:58 +0000974
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000975 if (const auto *MD = dyn_cast<CXXMethodDecl>(D)) {
Richard Smithc95d2c52017-09-22 04:25:05 +0000976 // Only look at the type-as-written. Otherwise, deducing the return type
977 // of a function could change its linkage.
978 QualType TypeAsWritten = MD->getType();
979 if (TypeSourceInfo *TSI = MD->getTypeSourceInfo())
980 TypeAsWritten = TSI->getType();
981 if (!isExternallyVisible(TypeAsWritten->getLinkage()))
982 return LinkageInfo::uniqueExternal();
983
John McCall457a04e2010-10-22 21:05:15 +0000984 // If this is a method template specialization, use the linkage for
985 // the template parameters and arguments.
John McCallb8c604a2011-06-27 23:06:04 +0000986 if (FunctionTemplateSpecializationInfo *spec
John McCall8823c652010-08-13 08:35:10 +0000987 = MD->getTemplateSpecializationInfo()) {
Rafael Espindolaecf63c62013-05-29 04:55:30 +0000988 mergeTemplateLV(LV, MD, spec, computation);
John McCall5f46c482013-02-21 23:42:58 +0000989 if (spec->isExplicitSpecialization()) {
990 explicitSpecSuppressor = MD;
991 } else if (isExplicitMemberSpecialization(spec->getTemplate())) {
992 explicitSpecSuppressor = spec->getTemplate()->getTemplatedDecl();
993 }
994 } else if (isExplicitMemberSpecialization(MD)) {
995 explicitSpecSuppressor = MD;
John McCalle6e622e2010-11-01 01:29:57 +0000996 }
John McCall457a04e2010-10-22 21:05:15 +0000997
Alexander Kornienkofd6ce042015-11-09 17:53:06 +0000998 } else if (const auto *RD = dyn_cast<CXXRecordDecl>(D)) {
999 if (const auto *spec = dyn_cast<ClassTemplateSpecializationDecl>(RD)) {
John McCalldf25c432013-02-16 00:17:33 +00001000 mergeTemplateLV(LV, spec, computation);
John McCall5f46c482013-02-21 23:42:58 +00001001 if (spec->isExplicitSpecialization()) {
1002 explicitSpecSuppressor = spec;
1003 } else {
1004 const ClassTemplateDecl *temp = spec->getSpecializedTemplate();
1005 if (isExplicitMemberSpecialization(temp)) {
1006 explicitSpecSuppressor = temp->getTemplatedDecl();
1007 }
1008 }
1009 } else if (isExplicitMemberSpecialization(RD)) {
1010 explicitSpecSuppressor = RD;
John McCall37bb6c92010-10-29 22:22:43 +00001011 }
1012
John McCall37bb6c92010-10-29 22:22:43 +00001013 // Static data members.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001014 } else if (const auto *VD = dyn_cast<VarDecl>(D)) {
1015 if (const auto *spec = dyn_cast<VarTemplateSpecializationDecl>(VD))
Larisse Voufo5899e192014-07-02 23:08:34 +00001016 mergeTemplateLV(LV, spec, computation);
1017
John McCall36cd5cc2010-10-30 09:18:49 +00001018 // Modify the variable's linkage by its type, but ignore the
1019 // type's visibility unless it's a definition.
Richard Smithc95d2c52017-09-22 04:25:05 +00001020 if (!IgnoreVarTypeLinkage) {
1021 LinkageInfo typeLV = getLVForType(*VD->getType(), computation);
1022 // FIXME: If the type's linkage is not externally visible, we can
1023 // give this static data member UniqueExternalLinkage.
1024 if (!LV.isVisibilityExplicit() && !classLV.isVisibilityExplicit())
1025 LV.mergeVisibility(typeLV);
1026 LV.mergeExternalVisibility(typeLV);
1027 }
John McCall5f46c482013-02-21 23:42:58 +00001028
1029 if (isExplicitMemberSpecialization(VD)) {
1030 explicitSpecSuppressor = VD;
1031 }
John McCalldf25c432013-02-16 00:17:33 +00001032
1033 // Template members.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001034 } else if (const auto *temp = dyn_cast<TemplateDecl>(D)) {
John McCalldf25c432013-02-16 00:17:33 +00001035 bool considerVisibility =
Rafael Espindola4a5da442013-02-27 02:56:45 +00001036 (!LV.isVisibilityExplicit() &&
1037 !classLV.isVisibilityExplicit() &&
John McCalld041a9b2013-02-20 01:54:26 +00001038 !hasExplicitVisibilityAlready(computation));
John McCalldf25c432013-02-16 00:17:33 +00001039 LinkageInfo tempLV =
Rafael Espindolaecf63c62013-05-29 04:55:30 +00001040 getLVForTemplateParameterList(temp->getTemplateParameters(), computation);
John McCalldf25c432013-02-16 00:17:33 +00001041 LV.mergeMaybeWithVisibility(tempLV, considerVisibility);
John McCall5f46c482013-02-21 23:42:58 +00001042
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001043 if (const auto *redeclTemp = dyn_cast<RedeclarableTemplateDecl>(temp)) {
John McCall5f46c482013-02-21 23:42:58 +00001044 if (isExplicitMemberSpecialization(redeclTemp)) {
1045 explicitSpecSuppressor = temp->getTemplatedDecl();
1046 }
1047 }
John McCall37bb6c92010-10-29 22:22:43 +00001048 }
1049
John McCall5f46c482013-02-21 23:42:58 +00001050 // We should never be looking for an attribute directly on a template.
1051 assert(!explicitSpecSuppressor || !isa<TemplateDecl>(explicitSpecSuppressor));
1052
1053 // If this member is an explicit member specialization, and it has
1054 // an explicit attribute, ignore visibility from the parent.
1055 bool considerClassVisibility = true;
1056 if (explicitSpecSuppressor &&
Rafael Espindola4a5da442013-02-27 02:56:45 +00001057 // optimization: hasDVA() is true only with explicit visibility.
1058 LV.isVisibilityExplicit() &&
1059 classLV.getVisibility() != DefaultVisibility &&
John McCall5f46c482013-02-21 23:42:58 +00001060 hasDirectVisibilityAttribute(explicitSpecSuppressor, computation)) {
1061 considerClassVisibility = false;
1062 }
1063
1064 // Finally, merge in information from the class.
1065 LV.mergeMaybeWithVisibility(classLV, considerClassVisibility);
John McCall457a04e2010-10-22 21:05:15 +00001066 return LV;
John McCall8823c652010-08-13 08:35:10 +00001067}
1068
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001069void NamedDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00001070
Rafael Espindola0e0d0092013-03-14 03:07:35 +00001071bool NamedDecl::isLinkageValid() const {
Rafael Espindola50df3a02013-05-25 17:16:20 +00001072 if (!hasCachedLinkage())
Rafael Espindola0e0d0092013-03-14 03:07:35 +00001073 return true;
John McCalld396b972011-02-08 19:01:05 +00001074
Richard Smithfbe7b462017-09-22 02:22:32 +00001075 Linkage L = LinkageComputer{}
1076 .computeLVForDecl(this, LVComputationKind::forLinkageOnly())
1077 .getLinkage();
George Burgess IV99db3ea2017-08-09 04:02:49 +00001078 return L == getCachedLinkage();
John McCalld396b972011-02-08 19:01:05 +00001079}
1080
Fariborz Jahanian6485fe42014-09-09 23:10:54 +00001081ObjCStringFormatFamily NamedDecl::getObjCFStringFormattingFamily() const {
1082 StringRef name = getName();
1083 if (name.empty()) return SFF_None;
Fangrui Song6907ce22018-07-30 19:24:48 +00001084
Fariborz Jahanian6485fe42014-09-09 23:10:54 +00001085 if (name.front() == 'C')
1086 if (name == "CFStringCreateWithFormat" ||
1087 name == "CFStringCreateWithFormatAndArguments" ||
1088 name == "CFStringAppendFormat" ||
1089 name == "CFStringAppendFormatAndArguments")
1090 return SFF_CFString;
1091 return SFF_None;
1092}
1093
Rafael Espindola3ae00052013-05-13 00:12:11 +00001094Linkage NamedDecl::getLinkageInternal() const {
John McCalld041a9b2013-02-20 01:54:26 +00001095 // We don't care about visibility here, so ask for the cheapest
1096 // possible visibility analysis.
Richard Smithfbe7b462017-09-22 02:22:32 +00001097 return LinkageComputer{}
1098 .getLVForDecl(this, LVComputationKind::forLinkageOnly())
1099 .getLinkage();
Douglas Gregorbf62d642010-12-06 18:36:25 +00001100}
1101
John McCallc273f242010-10-30 11:50:40 +00001102LinkageInfo NamedDecl::getLinkageAndVisibility() const {
George Burgess IV99db3ea2017-08-09 04:02:49 +00001103 return LinkageComputer{}.getDeclLinkageAndVisibility(this);
John McCall033caa52010-10-29 00:29:13 +00001104}
Ted Kremenek926d8602010-04-20 23:15:35 +00001105
Rafael Espindola9ad61122013-11-26 16:09:08 +00001106static Optional<Visibility>
1107getExplicitVisibilityAux(const NamedDecl *ND,
1108 NamedDecl::ExplicitVisibilityKind kind,
1109 bool IsMostRecent) {
1110 assert(!IsMostRecent || ND == ND->getMostRecentDecl());
1111
Rafael Espindola3a52c442013-02-26 19:33:14 +00001112 // Check the declaration itself first.
Rafael Espindola9ad61122013-11-26 16:09:08 +00001113 if (Optional<Visibility> V = getVisibilityOf(ND, kind))
Rafael Espindola3a52c442013-02-26 19:33:14 +00001114 return V;
Douglas Gregor1baf38f2011-03-26 12:10:19 +00001115
Rafael Espindola3a52c442013-02-26 19:33:14 +00001116 // If this is a member class of a specialization of a class template
1117 // and the corresponding decl has explicit visibility, use that.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001118 if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
Rafael Espindola3a52c442013-02-26 19:33:14 +00001119 CXXRecordDecl *InstantiatedFrom = RD->getInstantiatedFromMemberClass();
1120 if (InstantiatedFrom)
1121 return getVisibilityOf(InstantiatedFrom, kind);
1122 }
1123
1124 // If there wasn't explicit visibility there, and this is a
1125 // specialization of a class template, check for visibility
1126 // on the pattern.
Steven Wu79cbd112018-04-19 15:46:43 +00001127 if (const auto *spec = dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1128 // Walk all the template decl till this point to see if there are
1129 // explicit visibility attributes.
1130 const auto *TD = spec->getSpecializedTemplate()->getTemplatedDecl();
1131 while (TD != nullptr) {
1132 auto Vis = getVisibilityOf(TD, kind);
1133 if (Vis != None)
1134 return Vis;
1135 TD = TD->getPreviousDecl();
1136 }
1137 return None;
1138 }
Rafael Espindola3a52c442013-02-26 19:33:14 +00001139
1140 // Use the most recent declaration.
Rafael Espindola7ab1ce02013-12-08 01:13:22 +00001141 if (!IsMostRecent && !isa<NamespaceDecl>(ND)) {
Rafael Espindola9ad61122013-11-26 16:09:08 +00001142 const NamedDecl *MostRecent = ND->getMostRecentDecl();
1143 if (MostRecent != ND)
1144 return getExplicitVisibilityAux(MostRecent, kind, true);
1145 }
Rafael Espindola3a52c442013-02-26 19:33:14 +00001146
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001147 if (const auto *Var = dyn_cast<VarDecl>(ND)) {
Rafael Espindola96e68242012-05-16 02:10:38 +00001148 if (Var->isStaticDataMember()) {
1149 VarDecl *InstantiatedFrom = Var->getInstantiatedFromStaticDataMember();
1150 if (InstantiatedFrom)
John McCalld041a9b2013-02-20 01:54:26 +00001151 return getVisibilityOf(InstantiatedFrom, kind);
Rafael Espindola96e68242012-05-16 02:10:38 +00001152 }
1153
David Majnemer35b02bc2014-04-29 07:32:26 +00001154 if (const auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(Var))
1155 return getVisibilityOf(VTSD->getSpecializedTemplate()->getTemplatedDecl(),
1156 kind);
1157
David Blaikie7a30dc52013-02-21 01:47:18 +00001158 return None;
Rafael Espindola96e68242012-05-16 02:10:38 +00001159 }
Rafael Espindola3a52c442013-02-26 19:33:14 +00001160 // Also handle function template specializations.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001161 if (const auto *fn = dyn_cast<FunctionDecl>(ND)) {
Douglas Gregor1baf38f2011-03-26 12:10:19 +00001162 // If the function is a specialization of a template with an
1163 // explicit visibility attribute, use that.
1164 if (FunctionTemplateSpecializationInfo *templateInfo
1165 = fn->getTemplateSpecializationInfo())
John McCalld041a9b2013-02-20 01:54:26 +00001166 return getVisibilityOf(templateInfo->getTemplate()->getTemplatedDecl(),
1167 kind);
Douglas Gregor1baf38f2011-03-26 12:10:19 +00001168
Rafael Espindola8093fdf2012-02-23 04:17:32 +00001169 // If the function is a member of a specialization of a class template
1170 // and the corresponding decl has explicit visibility, use that.
1171 FunctionDecl *InstantiatedFrom = fn->getInstantiatedFromMemberFunction();
1172 if (InstantiatedFrom)
John McCalld041a9b2013-02-20 01:54:26 +00001173 return getVisibilityOf(InstantiatedFrom, kind);
Rafael Espindola8093fdf2012-02-23 04:17:32 +00001174
David Blaikie7a30dc52013-02-21 01:47:18 +00001175 return None;
Douglas Gregor1baf38f2011-03-26 12:10:19 +00001176 }
1177
Rafael Espindolafb4263f2012-07-31 19:02:02 +00001178 // The visibility of a template is stored in the templated decl.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001179 if (const auto *TD = dyn_cast<TemplateDecl>(ND))
John McCalld041a9b2013-02-20 01:54:26 +00001180 return getVisibilityOf(TD->getTemplatedDecl(), kind);
Rafael Espindolafb4263f2012-07-31 19:02:02 +00001181
David Blaikie7a30dc52013-02-21 01:47:18 +00001182 return None;
Douglas Gregor1baf38f2011-03-26 12:10:19 +00001183}
1184
Rafael Espindola9ad61122013-11-26 16:09:08 +00001185Optional<Visibility>
1186NamedDecl::getExplicitVisibility(ExplicitVisibilityKind kind) const {
1187 return getExplicitVisibilityAux(this, kind, false);
1188}
1189
George Burgess IV99db3ea2017-08-09 04:02:49 +00001190LinkageInfo LinkageComputer::getLVForClosure(const DeclContext *DC,
1191 Decl *ContextDecl,
1192 LVComputationKind computation) {
Eli Friedman7e346a82013-07-01 20:22:57 +00001193 // This lambda has its linkage/visibility determined by its owner.
Richard Smithc95d2c52017-09-22 04:25:05 +00001194 const NamedDecl *Owner;
1195 if (!ContextDecl)
1196 Owner = dyn_cast<NamedDecl>(DC);
1197 else if (isa<ParmVarDecl>(ContextDecl))
1198 Owner =
1199 dyn_cast<NamedDecl>(ContextDecl->getDeclContext()->getRedeclContext());
1200 else
1201 Owner = cast<NamedDecl>(ContextDecl);
1202
Richard Smithc95d2c52017-09-22 04:25:05 +00001203 if (!Owner)
Richard Smith7ff83042017-09-22 04:33:20 +00001204 return LinkageInfo::none();
Richard Smithc95d2c52017-09-22 04:25:05 +00001205
1206 // If the owner has a deduced type, we need to skip querying the linkage and
1207 // visibility of that type, because it might involve this closure type. The
1208 // only effect of this is that we might give a lambda VisibleNoLinkage rather
1209 // than NoLinkage when we don't strictly need to, which is benign.
1210 auto *VD = dyn_cast<VarDecl>(Owner);
Richard Smith7ff83042017-09-22 04:33:20 +00001211 LinkageInfo OwnerLV =
Richard Smithc95d2c52017-09-22 04:25:05 +00001212 VD && VD->getType()->getContainedDeducedType()
1213 ? computeLVForDecl(Owner, computation, /*IgnoreVarTypeLinkage*/true)
1214 : getLVForDecl(Owner, computation);
1215
Richard Smith7ff83042017-09-22 04:33:20 +00001216 // A lambda never formally has linkage. But if the owner is externally
1217 // visible, then the lambda is too. We apply the same rules to blocks.
1218 if (!isExternallyVisible(OwnerLV.getLinkage()))
1219 return LinkageInfo::none();
1220 return LinkageInfo(VisibleNoLinkage, OwnerLV.getVisibility(),
1221 OwnerLV.isVisibilityExplicit());
Eli Friedman7e346a82013-07-01 20:22:57 +00001222}
1223
George Burgess IV99db3ea2017-08-09 04:02:49 +00001224LinkageInfo LinkageComputer::getLVForLocalDecl(const NamedDecl *D,
1225 LVComputationKind computation) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001226 if (const auto *Function = dyn_cast<FunctionDecl>(D)) {
John McCalldf25c432013-02-16 00:17:33 +00001227 if (Function->isInAnonymousNamespace() &&
Richard Smith99f54792018-01-03 02:34:35 +00001228 !isFirstInExternCContext(Function))
Richard Smithdf963a32017-09-22 22:21:44 +00001229 return getInternalLinkageFor(Function);
John McCalldf25c432013-02-16 00:17:33 +00001230
1231 // This is a "void f();" which got merged with a file static.
Rafael Espindola6ae7e502013-04-03 19:27:57 +00001232 if (Function->getCanonicalDecl()->getStorageClass() == SC_Static)
Richard Smith1283e982017-07-07 20:04:28 +00001233 return getInternalLinkageFor(Function);
John McCalldf25c432013-02-16 00:17:33 +00001234
1235 LinkageInfo LV;
John McCalld041a9b2013-02-20 01:54:26 +00001236 if (!hasExplicitVisibilityAlready(computation)) {
David Blaikie05785d12013-02-20 22:23:23 +00001237 if (Optional<Visibility> Vis =
1238 getExplicitVisibility(Function, computation))
John McCalldf25c432013-02-16 00:17:33 +00001239 LV.mergeVisibility(*Vis, true);
1240 }
1241
1242 // Note that Sema::MergeCompatibleFunctionDecls already takes care of
1243 // merging storage classes and visibility attributes, so we don't have to
1244 // look at previous decls in here.
1245
1246 return LV;
1247 }
1248
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001249 if (const auto *Var = dyn_cast<VarDecl>(D)) {
Rafael Espindola6ae7e502013-04-03 19:27:57 +00001250 if (Var->hasExternalStorage()) {
Richard Smith99f54792018-01-03 02:34:35 +00001251 if (Var->isInAnonymousNamespace() && !isFirstInExternCContext(Var))
Richard Smithdf963a32017-09-22 22:21:44 +00001252 return getInternalLinkageFor(Var);
John McCalldf25c432013-02-16 00:17:33 +00001253
John McCalldf25c432013-02-16 00:17:33 +00001254 LinkageInfo LV;
1255 if (Var->getStorageClass() == SC_PrivateExtern)
1256 LV.mergeVisibility(HiddenVisibility, true);
John McCalld041a9b2013-02-20 01:54:26 +00001257 else if (!hasExplicitVisibilityAlready(computation)) {
David Blaikie05785d12013-02-20 22:23:23 +00001258 if (Optional<Visibility> Vis = getExplicitVisibility(Var, computation))
John McCalldf25c432013-02-16 00:17:33 +00001259 LV.mergeVisibility(*Vis, true);
1260 }
1261
Rafael Espindola6ae7e502013-04-03 19:27:57 +00001262 if (const VarDecl *Prev = Var->getPreviousDecl()) {
1263 LinkageInfo PrevLV = getLVForDecl(Prev, computation);
1264 if (PrevLV.getLinkage())
1265 LV.setLinkage(PrevLV.getLinkage());
1266 LV.mergeVisibility(PrevLV);
1267 }
1268
John McCalldf25c432013-02-16 00:17:33 +00001269 return LV;
1270 }
Rafael Espindolaa4184182013-06-17 20:04:51 +00001271
1272 if (!Var->isStaticLocal())
1273 return LinkageInfo::none();
John McCalldf25c432013-02-16 00:17:33 +00001274 }
1275
Rafael Espindolaa4184182013-06-17 20:04:51 +00001276 ASTContext &Context = D->getASTContext();
1277 if (!Context.getLangOpts().CPlusPlus)
Rafael Espindola50df3a02013-05-25 17:16:20 +00001278 return LinkageInfo::none();
1279
Eli Friedman7e346a82013-07-01 20:22:57 +00001280 const Decl *OuterD = getOutermostFuncOrBlockContext(D);
Alexey Bataev0a47e652016-01-12 09:01:25 +00001281 if (!OuterD || OuterD->isInvalidDecl())
Rafael Espindola50df3a02013-05-25 17:16:20 +00001282 return LinkageInfo::none();
Rafael Espindola52189362013-06-04 13:43:35 +00001283
Eli Friedman7e346a82013-07-01 20:22:57 +00001284 LinkageInfo LV;
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001285 if (const auto *BD = dyn_cast<BlockDecl>(OuterD)) {
Eli Friedman7e346a82013-07-01 20:22:57 +00001286 if (!BD->getBlockManglingNumber())
1287 return LinkageInfo::none();
Rafael Espindola52189362013-06-04 13:43:35 +00001288
Eli Friedman7e346a82013-07-01 20:22:57 +00001289 LV = getLVForClosure(BD->getDeclContext()->getRedeclContext(),
1290 BD->getBlockManglingContextDecl(), computation);
1291 } else {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001292 const auto *FD = cast<FunctionDecl>(OuterD);
Eli Friedman7e346a82013-07-01 20:22:57 +00001293 if (!FD->isInlined() &&
David Majnemer9963ade2014-12-16 04:52:14 +00001294 !isTemplateInstantiation(FD->getTemplateSpecializationKind()))
Eli Friedman7e346a82013-07-01 20:22:57 +00001295 return LinkageInfo::none();
1296
Hiroshi Inoue03ff37d2018-08-22 05:43:27 +00001297 // If a function is hidden by -fvisibility-inlines-hidden option and
1298 // is not explicitly attributed as a hidden function,
1299 // we should not make static local variables in the function hidden.
Eli Friedman7e346a82013-07-01 20:22:57 +00001300 LV = getLVForDecl(FD, computation);
Reid Klecknera52d1512018-10-10 21:59:56 +00001301 if (isa<VarDecl>(D) && useInlineVisibilityHidden(FD) &&
1302 !LV.isVisibilityExplicit()) {
1303 assert(cast<VarDecl>(D)->isStaticLocal());
1304 // If this was an implicitly hidden inline method, check again for
1305 // explicit visibility on the parent class, and use that for static locals
1306 // if present.
1307 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
1308 LV = getLVForDecl(MD->getParent(), computation);
1309 if (!LV.isVisibilityExplicit()) {
1310 Visibility globalVisibility =
1311 computation.isValueVisibility()
1312 ? Context.getLangOpts().getValueVisibilityMode()
1313 : Context.getLangOpts().getTypeVisibilityMode();
1314 return LinkageInfo(VisibleNoLinkage, globalVisibility,
1315 /*visibilityExplicit=*/false);
1316 }
1317 }
Eli Friedman7e346a82013-07-01 20:22:57 +00001318 }
Rafael Espindola111bb2e2013-05-27 14:50:21 +00001319 if (!isExternallyVisible(LV.getLinkage()))
Rafael Espindola50df3a02013-05-25 17:16:20 +00001320 return LinkageInfo::none();
1321 return LinkageInfo(VisibleNoLinkage, LV.getVisibility(),
1322 LV.isVisibilityExplicit());
John McCalldf25c432013-02-16 00:17:33 +00001323}
1324
George Burgess IV99db3ea2017-08-09 04:02:49 +00001325LinkageInfo LinkageComputer::computeLVForDecl(const NamedDecl *D,
Richard Smithc95d2c52017-09-22 04:25:05 +00001326 LVComputationKind computation,
1327 bool IgnoreVarTypeLinkage) {
Evgeniy Stepanovae6ebd32015-11-10 21:28:44 +00001328 // Internal_linkage attribute overrides other considerations.
1329 if (D->hasAttr<InternalLinkageAttr>())
Richard Smith1283e982017-07-07 20:04:28 +00001330 return getInternalLinkageFor(D);
Evgeniy Stepanovae6ebd32015-11-10 21:28:44 +00001331
Ted Kremenek926d8602010-04-20 23:15:35 +00001332 // Objective-C: treat all Objective-C declarations as having external
1333 // linkage.
John McCall033caa52010-10-29 00:29:13 +00001334 switch (D->getKind()) {
Ted Kremenek926d8602010-04-20 23:15:35 +00001335 default:
1336 break;
Richard Smith97135cc2015-11-12 22:19:45 +00001337
1338 // Per C++ [basic.link]p2, only the names of objects, references,
1339 // functions, types, templates, namespaces, and values ever have linkage.
1340 //
1341 // Note that the name of a typedef, namespace alias, using declaration,
1342 // and so on are not the name of the corresponding type, namespace, or
1343 // declaration, so they do *not* have linkage.
Richard Smith97135cc2015-11-12 22:19:45 +00001344 case Decl::ImplicitParam:
1345 case Decl::Label:
1346 case Decl::NamespaceAlias:
Argyrios Kyrtzidis79d04282011-12-01 01:28:21 +00001347 case Decl::ParmVar:
Richard Smith97135cc2015-11-12 22:19:45 +00001348 case Decl::Using:
1349 case Decl::UsingShadow:
1350 case Decl::UsingDirective:
Argyrios Kyrtzidis79d04282011-12-01 01:28:21 +00001351 return LinkageInfo::none();
Richard Smith97135cc2015-11-12 22:19:45 +00001352
Richard Smith26210db2015-11-13 03:52:13 +00001353 case Decl::EnumConstant:
1354 // C++ [basic.link]p4: an enumerator has the linkage of its enumeration.
Bruno Cardoso Lopes057c82c2017-07-01 00:06:27 +00001355 if (D->getASTContext().getLangOpts().CPlusPlus)
1356 return getLVForDecl(cast<EnumDecl>(D->getDeclContext()), computation);
1357 return LinkageInfo::visible_none();
Richard Smith26210db2015-11-13 03:52:13 +00001358
Richard Smith97135cc2015-11-12 22:19:45 +00001359 case Decl::Typedef:
1360 case Decl::TypeAlias:
1361 // A typedef declaration has linkage if it gives a type a name for
1362 // linkage purposes.
Vassil Vassilevb00ea082017-07-01 20:44:49 +00001363 if (!cast<TypedefNameDecl>(D)
Richard Smith97135cc2015-11-12 22:19:45 +00001364 ->getAnonDeclWithTypedefName(/*AnyRedecl*/true))
1365 return LinkageInfo::none();
1366 break;
1367
John McCall457a04e2010-10-22 21:05:15 +00001368 case Decl::TemplateTemplateParm: // count these as external
1369 case Decl::NonTypeTemplateParm:
Ted Kremenek926d8602010-04-20 23:15:35 +00001370 case Decl::ObjCAtDefsField:
1371 case Decl::ObjCCategory:
1372 case Decl::ObjCCategoryImpl:
Ted Kremenek926d8602010-04-20 23:15:35 +00001373 case Decl::ObjCCompatibleAlias:
Ted Kremenek926d8602010-04-20 23:15:35 +00001374 case Decl::ObjCImplementation:
Ted Kremenek926d8602010-04-20 23:15:35 +00001375 case Decl::ObjCMethod:
1376 case Decl::ObjCProperty:
1377 case Decl::ObjCPropertyImpl:
1378 case Decl::ObjCProtocol:
Richard Smith1283e982017-07-07 20:04:28 +00001379 return getExternalLinkageFor(D);
Fangrui Song6907ce22018-07-30 19:24:48 +00001380
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001381 case Decl::CXXRecord: {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001382 const auto *Record = cast<CXXRecordDecl>(D);
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001383 if (Record->isLambda()) {
Michael Liao243ebfb2019-10-19 00:15:19 +00001384 if (Record->hasKnownLambdaInternalLinkage() ||
1385 !Record->getLambdaManglingNumber()) {
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001386 // This lambda has no mangling number, so it's internal.
Richard Smith1283e982017-07-07 20:04:28 +00001387 return getInternalLinkageFor(D);
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001388 }
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001389
Faisal Vali49b4c1f2013-10-01 02:51:53 +00001390 return getLVForClosure(
Michael Liao29269172020-02-07 12:58:17 -05001391 Record->getDeclContext()->getRedeclContext(),
1392 Record->getLambdaContextDecl(), computation);
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001393 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001394
Douglas Gregor6f88e5e2012-02-21 04:17:39 +00001395 break;
1396 }
Ted Kremenek926d8602010-04-20 23:15:35 +00001397 }
1398
Douglas Gregorf73b2822009-11-25 22:24:25 +00001399 // Handle linkage for namespace-scope names.
John McCall033caa52010-10-29 00:29:13 +00001400 if (D->getDeclContext()->getRedeclContext()->isFileContext())
Richard Smithc95d2c52017-09-22 04:25:05 +00001401 return getLVForNamespaceScopeDecl(D, computation, IgnoreVarTypeLinkage);
Fangrui Song6907ce22018-07-30 19:24:48 +00001402
Douglas Gregorf73b2822009-11-25 22:24:25 +00001403 // C++ [basic.link]p5:
1404 // In addition, a member function, static data member, a named
1405 // class or enumeration of class scope, or an unnamed class or
1406 // enumeration defined in a class-scope typedef declaration such
1407 // that the class or enumeration has the typedef name for linkage
1408 // purposes (7.1.3), has external linkage if the name of the class
1409 // has external linkage.
John McCall033caa52010-10-29 00:29:13 +00001410 if (D->getDeclContext()->isRecord())
Richard Smithc95d2c52017-09-22 04:25:05 +00001411 return getLVForClassMember(D, computation, IgnoreVarTypeLinkage);
Douglas Gregorf73b2822009-11-25 22:24:25 +00001412
1413 // C++ [basic.link]p6:
1414 // The name of a function declared in block scope and the name of
1415 // an object declared by a block scope extern declaration have
1416 // linkage. If there is a visible declaration of an entity with
1417 // linkage having the same name and type, ignoring entities
1418 // declared outside the innermost enclosing namespace scope, the
1419 // block scope declaration declares that same entity and receives
1420 // the linkage of the previous declaration. If there is more than
1421 // one such matching entity, the program is ill-formed. Otherwise,
1422 // if no matching entity is found, the block scope entity receives
1423 // external linkage.
John McCalldf25c432013-02-16 00:17:33 +00001424 if (D->getDeclContext()->isFunctionOrMethod())
1425 return getLVForLocalDecl(D, computation);
Douglas Gregorf73b2822009-11-25 22:24:25 +00001426
1427 // C++ [basic.link]p6:
1428 // Names not covered by these rules have no linkage.
John McCallc273f242010-10-30 11:50:40 +00001429 return LinkageInfo::none();
John McCall457a04e2010-10-22 21:05:15 +00001430}
Douglas Gregorf73b2822009-11-25 22:24:25 +00001431
George Burgess IV99db3ea2017-08-09 04:02:49 +00001432/// getLVForDecl - Get the linkage and visibility for the given declaration.
1433LinkageInfo LinkageComputer::getLVForDecl(const NamedDecl *D,
1434 LVComputationKind computation) {
1435 // Internal_linkage attribute overrides other considerations.
1436 if (D->hasAttr<InternalLinkageAttr>())
1437 return getInternalLinkageFor(D);
Evgeniy Stepanovae6ebd32015-11-10 21:28:44 +00001438
Richard Smithfbe7b462017-09-22 02:22:32 +00001439 if (computation.IgnoreAllVisibility && D->hasCachedLinkage())
George Burgess IV99db3ea2017-08-09 04:02:49 +00001440 return LinkageInfo(D->getCachedLinkage(), DefaultVisibility, false);
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001441
George Burgess IV35cb4f82017-08-09 04:12:17 +00001442 if (llvm::Optional<LinkageInfo> LI = lookup(D, computation))
1443 return *LI;
1444
George Burgess IV99db3ea2017-08-09 04:02:49 +00001445 LinkageInfo LV = computeLVForDecl(D, computation);
1446 if (D->hasCachedLinkage())
1447 assert(D->getCachedLinkage() == LV.getLinkage());
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001448
George Burgess IV99db3ea2017-08-09 04:02:49 +00001449 D->setCachedLinkage(LV.getLinkage());
George Burgess IV35cb4f82017-08-09 04:12:17 +00001450 cache(D, computation, LV);
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001451
1452#ifndef NDEBUG
George Burgess IV99db3ea2017-08-09 04:02:49 +00001453 // In C (because of gnu inline) and in c++ with microsoft extensions an
1454 // static can follow an extern, so we can have two decls with different
1455 // linkages.
1456 const LangOptions &Opts = D->getASTContext().getLangOpts();
1457 if (!Opts.CPlusPlus || Opts.MicrosoftExt)
1458 return LV;
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001459
George Burgess IV99db3ea2017-08-09 04:02:49 +00001460 // We have just computed the linkage for this decl. By induction we know
1461 // that all other computed linkages match, check that the one we just
1462 // computed also does.
1463 NamedDecl *Old = nullptr;
1464 for (auto I : D->redecls()) {
1465 auto *T = cast<NamedDecl>(I);
1466 if (T == D)
1467 continue;
1468 if (!T->isInvalidDecl() && T->hasCachedLinkage()) {
1469 Old = T;
1470 break;
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001471 }
George Burgess IV99db3ea2017-08-09 04:02:49 +00001472 }
1473 assert(!Old || Old->getCachedLinkage() == D->getCachedLinkage());
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001474#endif
1475
George Burgess IV99db3ea2017-08-09 04:02:49 +00001476 return LV;
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001477}
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001478
George Burgess IV99db3ea2017-08-09 04:02:49 +00001479LinkageInfo LinkageComputer::getDeclLinkageAndVisibility(const NamedDecl *D) {
Richard Smithfbe7b462017-09-22 02:22:32 +00001480 return getLVForDecl(D,
1481 LVComputationKind(usesTypeVisibility(D)
1482 ? NamedDecl::VisibilityForType
1483 : NamedDecl::VisibilityForValue));
Rafael Espindola9551d3b2013-05-28 19:43:11 +00001484}
1485
Richard Smithbecb92d2017-10-10 22:33:17 +00001486Module *Decl::getOwningModuleForLinkage(bool IgnoreLinkage) const {
Richard Smithdd8b5332017-09-04 05:37:53 +00001487 Module *M = getOwningModule();
1488 if (!M)
1489 return nullptr;
1490
1491 switch (M->Kind) {
1492 case Module::ModuleMapModule:
1493 // Module map modules have no special linkage semantics.
1494 return nullptr;
1495
1496 case Module::ModuleInterfaceUnit:
1497 return M;
1498
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001499 case Module::GlobalModuleFragment: {
Richard Smithdd8b5332017-09-04 05:37:53 +00001500 // External linkage declarations in the global module have no owning module
1501 // for linkage purposes. But internal linkage declarations in the global
1502 // module fragment of a particular module are owned by that module for
1503 // linkage purposes.
Richard Smithbecb92d2017-10-10 22:33:17 +00001504 if (IgnoreLinkage)
1505 return nullptr;
1506 bool InternalLinkage;
1507 if (auto *ND = dyn_cast<NamedDecl>(this))
1508 InternalLinkage = !ND->hasExternalFormalLinkage();
1509 else {
1510 auto *NSD = dyn_cast<NamespaceDecl>(this);
1511 InternalLinkage = (NSD && NSD->isAnonymousNamespace()) ||
1512 isInAnonymousNamespace();
1513 }
1514 return InternalLinkage ? M->Parent : nullptr;
Richard Smithdd8b5332017-09-04 05:37:53 +00001515 }
Richard Smitha5bbbfe2019-04-18 21:12:54 +00001516
1517 case Module::PrivateModuleFragment:
1518 // The private module fragment is part of its containing module for linkage
1519 // purposes.
1520 return M->Parent;
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001521 }
Richard Smithdd8b5332017-09-04 05:37:53 +00001522
1523 llvm_unreachable("unknown module kind");
1524}
1525
Richard Smith7873de02016-08-11 22:25:46 +00001526void NamedDecl::printName(raw_ostream &os) const {
1527 os << Name;
1528}
1529
Douglas Gregor2ada0482009-02-04 17:27:36 +00001530std::string NamedDecl::getQualifiedNameAsString() const {
Benjamin Kramer24ebf7c2013-02-23 13:53:57 +00001531 std::string QualName;
1532 llvm::raw_string_ostream OS(QualName);
Aaron Ballman75ee4cc2014-01-03 18:42:48 +00001533 printQualifiedName(OS, getASTContext().getPrintingPolicy());
Benjamin Kramer24ebf7c2013-02-23 13:53:57 +00001534 return OS.str();
1535}
1536
1537void NamedDecl::printQualifiedName(raw_ostream &OS) const {
1538 printQualifiedName(OS, getASTContext().getPrintingPolicy());
1539}
1540
1541void NamedDecl::printQualifiedName(raw_ostream &OS,
1542 const PrintingPolicy &P) const {
Ilya Biryukov66482232019-09-25 15:46:04 +00001543 if (getDeclContext()->isFunctionOrMethod()) {
1544 // We do not print '(anonymous)' for function parameters without name.
1545 printName(OS);
1546 return;
1547 }
1548 printNestedNameSpecifier(OS, P);
Richard Smith9bd6b772020-04-14 23:35:35 -07001549 if (getDeclName())
Ilya Biryukov66482232019-09-25 15:46:04 +00001550 OS << *this;
Richard Smith9bd6b772020-04-14 23:35:35 -07001551 else {
1552 // Give the printName override a chance to pick a different name before we
1553 // fall back to "(anonymous)".
1554 SmallString<64> NameBuffer;
1555 llvm::raw_svector_ostream NameOS(NameBuffer);
1556 printName(NameOS);
1557 if (NameBuffer.empty())
1558 OS << "(anonymous)";
1559 else
1560 OS << NameBuffer;
1561 }
Ilya Biryukov66482232019-09-25 15:46:04 +00001562}
1563
1564void NamedDecl::printNestedNameSpecifier(raw_ostream &OS) const {
1565 printNestedNameSpecifier(OS, getASTContext().getPrintingPolicy());
1566}
1567
1568void NamedDecl::printNestedNameSpecifier(raw_ostream &OS,
1569 const PrintingPolicy &P) const {
Douglas Gregor2ada0482009-02-04 17:27:36 +00001570 const DeclContext *Ctx = getDeclContext();
1571
David Goldman19d21852019-04-04 20:13:22 +00001572 // For ObjC methods and properties, look through categories and use the
1573 // interface as context.
Haojian Wu6f565992020-05-19 15:10:10 +02001574 if (auto *MD = dyn_cast<ObjCMethodDecl>(this)) {
Argyrios Kyrtzidisa166a2b2017-03-07 09:26:07 +00001575 if (auto *ID = MD->getClassInterface())
1576 Ctx = ID;
Haojian Wu6f565992020-05-19 15:10:10 +02001577 } else if (auto *PD = dyn_cast<ObjCPropertyDecl>(this)) {
David Goldman19d21852019-04-04 20:13:22 +00001578 if (auto *MD = PD->getGetterMethodDecl())
1579 if (auto *ID = MD->getClassInterface())
1580 Ctx = ID;
Haojian Wu6f565992020-05-19 15:10:10 +02001581 } else if (auto *ID = dyn_cast<ObjCIvarDecl>(this)) {
1582 if (auto *CI = ID->getContainingInterface())
1583 Ctx = CI;
David Goldman19d21852019-04-04 20:13:22 +00001584 }
Argyrios Kyrtzidisa166a2b2017-03-07 09:26:07 +00001585
Ilya Biryukov66482232019-09-25 15:46:04 +00001586 if (Ctx->isFunctionOrMethod())
Benjamin Kramer24ebf7c2013-02-23 13:53:57 +00001587 return;
Douglas Gregor2ada0482009-02-04 17:27:36 +00001588
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001589 using ContextsTy = SmallVector<const DeclContext *, 8>;
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001590 ContextsTy Contexts;
1591
Sam McCall34f9d3f2018-02-02 13:34:47 +00001592 // Collect named contexts.
1593 while (Ctx) {
1594 if (isa<NamedDecl>(Ctx))
1595 Contexts.push_back(Ctx);
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001596 Ctx = Ctx->getParent();
Benjamin Kramer24ebf7c2013-02-23 13:53:57 +00001597 }
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001598
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001599 for (const DeclContext *DC : llvm::reverse(Contexts)) {
David Majnemerf7e36092016-06-23 00:15:04 +00001600 if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(DC)) {
Benjamin Kramer9170e912013-02-22 15:46:01 +00001601 OS << Spec->getName();
Douglas Gregor85673582009-05-18 17:01:57 +00001602 const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
Serge Pavlov03e672c2017-11-28 16:14:14 +00001603 printTemplateArgumentList(OS, TemplateArgs.asArray(), P);
David Majnemerf7e36092016-06-23 00:15:04 +00001604 } else if (const auto *ND = dyn_cast<NamespaceDecl>(DC)) {
Richard Smith46dd5bb2014-05-30 22:16:51 +00001605 if (P.SuppressUnwrittenScope &&
1606 (ND->isAnonymousNamespace() || ND->isInline()))
1607 continue;
Reid Kleckner60103382015-12-16 02:04:40 +00001608 if (ND->isAnonymousNamespace()) {
1609 OS << (P.MSVCFormatting ? "`anonymous namespace\'"
1610 : "(anonymous namespace)");
1611 }
Sam Weinig07d211e2009-12-24 23:15:03 +00001612 else
Benjamin Kramerb89514a2011-10-14 18:45:37 +00001613 OS << *ND;
David Majnemerf7e36092016-06-23 00:15:04 +00001614 } else if (const auto *RD = dyn_cast<RecordDecl>(DC)) {
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001615 if (!RD->getIdentifier())
David Blaikieabe1a392014-04-02 05:58:29 +00001616 OS << "(anonymous " << RD->getKindName() << ')';
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001617 else
Benjamin Kramerb89514a2011-10-14 18:45:37 +00001618 OS << *RD;
David Majnemerf7e36092016-06-23 00:15:04 +00001619 } else if (const auto *FD = dyn_cast<FunctionDecl>(DC)) {
Craig Topper36250ad2014-05-12 05:36:57 +00001620 const FunctionProtoType *FT = nullptr;
Sam Weinigb999f682009-12-28 03:19:38 +00001621 if (FD->hasWrittenPrototype())
Eli Friedman5c27c4c2012-08-30 22:22:09 +00001622 FT = dyn_cast<FunctionProtoType>(FD->getType()->castAs<FunctionType>());
Sam Weinigb999f682009-12-28 03:19:38 +00001623
Benjamin Kramerb89514a2011-10-14 18:45:37 +00001624 OS << *FD << '(';
Sam Weinigb999f682009-12-28 03:19:38 +00001625 if (FT) {
Sam Weinigb999f682009-12-28 03:19:38 +00001626 unsigned NumParams = FD->getNumParams();
1627 for (unsigned i = 0; i < NumParams; ++i) {
1628 if (i)
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001629 OS << ", ";
Argyrios Kyrtzidisa18347e2012-05-05 04:20:37 +00001630 OS << FD->getParamDecl(i)->getType().stream(P);
Sam Weinigb999f682009-12-28 03:19:38 +00001631 }
1632
1633 if (FT->isVariadic()) {
1634 if (NumParams > 0)
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001635 OS << ", ";
1636 OS << "...";
Sam Weinigb999f682009-12-28 03:19:38 +00001637 }
1638 }
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001639 OS << ')';
David Majnemerf7e36092016-06-23 00:15:04 +00001640 } else if (const auto *ED = dyn_cast<EnumDecl>(DC)) {
Alexander Kornienko4f355322015-11-09 16:45:17 +00001641 // C++ [dcl.enum]p10: Each enum-name and each unscoped
1642 // enumerator is declared in the scope that immediately contains
1643 // the enum-specifier. Each scoped enumerator is declared in the
1644 // scope of the enumeration.
Paul Robinsonf1838482017-12-21 21:47:22 +00001645 // For the case of unscoped enumerator, do not include in the qualified
Paul Robinsond1c3dd82017-12-26 18:01:19 +00001646 // name any information about its enum enclosing scope, as its visibility
Paul Robinsonf1838482017-12-21 21:47:22 +00001647 // is global.
1648 if (ED->isScoped())
Alexander Kornienko4f355322015-11-09 16:45:17 +00001649 OS << *ED;
1650 else
1651 continue;
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001652 } else {
David Majnemerf7e36092016-06-23 00:15:04 +00001653 OS << *cast<NamedDecl>(DC);
Benjamin Kramerd76b6982010-04-28 14:33:51 +00001654 }
1655 OS << "::";
Douglas Gregor2ada0482009-02-04 17:27:36 +00001656 }
Benjamin Kramer24ebf7c2013-02-23 13:53:57 +00001657}
Douglas Gregor2ada0482009-02-04 17:27:36 +00001658
Benjamin Kramer24ebf7c2013-02-23 13:53:57 +00001659void NamedDecl::getNameForDiagnostic(raw_ostream &OS,
1660 const PrintingPolicy &Policy,
1661 bool Qualified) const {
1662 if (Qualified)
1663 printQualifiedName(OS, Policy);
1664 else
1665 printName(OS);
Douglas Gregor2ada0482009-02-04 17:27:36 +00001666}
1667
Richard Smithe8292b12015-02-10 03:28:10 +00001668template<typename T> static bool isRedeclarableImpl(Redeclarable<T> *) {
1669 return true;
1670}
1671static bool isRedeclarableImpl(...) { return false; }
1672static bool isRedeclarable(Decl::Kind K) {
1673 switch (K) {
1674#define DECL(Type, Base) \
1675 case Decl::Type: \
1676 return isRedeclarableImpl((Type##Decl *)nullptr);
1677#define ABSTRACT_DECL(DECL)
1678#include "clang/AST/DeclNodes.inc"
1679 }
1680 llvm_unreachable("unknown decl kind");
1681}
1682
1683bool NamedDecl::declarationReplaces(NamedDecl *OldD, bool IsKnownNewer) const {
Douglas Gregor8b9ccca2008-12-23 21:05:05 +00001684 assert(getDeclName() == OldD->getDeclName() && "Declaration name mismatch");
1685
Richard Smithfe620d22015-03-05 23:24:12 +00001686 // Never replace one imported declaration with another; we need both results
1687 // when re-exporting.
1688 if (OldD->isFromASTFile() && isFromASTFile())
1689 return false;
1690
Richard Smith5cd86f82015-11-03 03:13:11 +00001691 // A kind mismatch implies that the declaration is not replaced.
1692 if (OldD->getKind() != getKind())
Richard Smithe8292b12015-02-10 03:28:10 +00001693 return false;
1694
Richard Smith5cd86f82015-11-03 03:13:11 +00001695 // For method declarations, we never replace. (Why?)
1696 if (isa<ObjCMethodDecl>(this))
1697 return false;
1698
1699 // For parameters, pick the newer one. This is either an error or (in
1700 // Objective-C) permitted as an extension.
1701 if (isa<ParmVarDecl>(this))
1702 return true;
1703
Richard Smithe8292b12015-02-10 03:28:10 +00001704 // Inline namespaces can give us two declarations with the same
1705 // name and kind in the same scope but different contexts; we should
1706 // keep both declarations in this case.
1707 if (!this->getDeclContext()->getRedeclContext()->Equals(
1708 OldD->getDeclContext()->getRedeclContext()))
1709 return false;
Mike Stump11289f42009-09-09 15:08:12 +00001710
Richard Smith5cd86f82015-11-03 03:13:11 +00001711 // Using declarations can be replaced if they import the same name from the
1712 // same context.
Richard Smithe8292b12015-02-10 03:28:10 +00001713 if (auto *UD = dyn_cast<UsingDecl>(this)) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00001714 ASTContext &Context = getASTContext();
Richard Smithe8292b12015-02-10 03:28:10 +00001715 return Context.getCanonicalNestedNameSpecifier(UD->getQualifier()) ==
Douglas Gregora9d87bc2011-02-25 00:36:19 +00001716 Context.getCanonicalNestedNameSpecifier(
Richard Smithe8292b12015-02-10 03:28:10 +00001717 cast<UsingDecl>(OldD)->getQualifier());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00001718 }
Richard Smithe8292b12015-02-10 03:28:10 +00001719 if (auto *UUVD = dyn_cast<UnresolvedUsingValueDecl>(this)) {
Eli Friedman0eaf10b2013-08-20 00:39:40 +00001720 ASTContext &Context = getASTContext();
Richard Smithe8292b12015-02-10 03:28:10 +00001721 return Context.getCanonicalNestedNameSpecifier(UUVD->getQualifier()) ==
Eli Friedman0eaf10b2013-08-20 00:39:40 +00001722 Context.getCanonicalNestedNameSpecifier(
1723 cast<UnresolvedUsingValueDecl>(OldD)->getQualifier());
1724 }
1725
Richard Smith5cd86f82015-11-03 03:13:11 +00001726 if (isRedeclarable(getKind())) {
1727 if (getCanonicalDecl() != OldD->getCanonicalDecl())
1728 return false;
1729
1730 if (IsKnownNewer)
1731 return true;
1732
Richard Smithe8292b12015-02-10 03:28:10 +00001733 // Check whether this is actually newer than OldD. We want to keep the
1734 // newer declaration. This loop will usually only iterate once, because
1735 // OldD is usually the previous declaration.
1736 for (auto D : redecls()) {
1737 if (D == OldD)
1738 break;
1739
1740 // If we reach the canonical declaration, then OldD is not actually older
1741 // than this one.
1742 //
1743 // FIXME: In this case, we should not add this decl to the lookup table.
1744 if (D->isCanonicalDecl())
1745 return false;
1746 }
Richard Smith5cd86f82015-11-03 03:13:11 +00001747
1748 // It's a newer declaration of the same kind of declaration in the same
1749 // scope: we want this decl instead of the existing one.
1750 return true;
Richard Smithe8292b12015-02-10 03:28:10 +00001751 }
1752
Richard Smith5cd86f82015-11-03 03:13:11 +00001753 // In all other cases, we need to keep both declarations in case they have
1754 // different visibility. Any attempt to use the name will result in an
1755 // ambiguity if more than one is visible.
1756 return false;
Douglas Gregor8b9ccca2008-12-23 21:05:05 +00001757}
1758
Douglas Gregoreddf4332009-02-24 20:03:32 +00001759bool NamedDecl::hasLinkage() const {
Rafael Espindola50df3a02013-05-25 17:16:20 +00001760 return getFormalLinkage() != NoLinkage;
Douglas Gregoreddf4332009-02-24 20:03:32 +00001761}
Douglas Gregor6e6ad602009-01-20 01:17:11 +00001762
Daniel Dunbar166ea9ad2012-03-08 18:20:41 +00001763NamedDecl *NamedDecl::getUnderlyingDeclImpl() {
Anders Carlsson6915bf62009-06-26 06:29:23 +00001764 NamedDecl *ND = this;
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001765 while (auto *UD = dyn_cast<UsingShadowDecl>(ND))
Benjamin Kramerba0495a2012-03-08 21:00:45 +00001766 ND = UD->getTargetDecl();
1767
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001768 if (auto *AD = dyn_cast<ObjCCompatibleAliasDecl>(ND))
Benjamin Kramerba0495a2012-03-08 21:00:45 +00001769 return AD->getClassInterface();
1770
Richard Smithf2005d32015-12-29 23:34:32 +00001771 if (auto *AD = dyn_cast<NamespaceAliasDecl>(ND))
1772 return AD->getNamespace();
1773
Benjamin Kramerba0495a2012-03-08 21:00:45 +00001774 return ND;
Anders Carlsson6915bf62009-06-26 06:29:23 +00001775}
1776
John McCalla8ae2222010-04-06 21:38:20 +00001777bool NamedDecl::isCXXInstanceMember() const {
Douglas Gregor3f28ec22012-03-08 02:08:05 +00001778 if (!isCXXClassMember())
1779 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00001780
John McCalla8ae2222010-04-06 21:38:20 +00001781 const NamedDecl *D = this;
1782 if (isa<UsingShadowDecl>(D))
1783 D = cast<UsingShadowDecl>(D)->getTargetDecl();
1784
John McCall5e77d762013-04-16 07:28:30 +00001785 if (isa<FieldDecl>(D) || isa<IndirectFieldDecl>(D) || isa<MSPropertyDecl>(D))
John McCalla8ae2222010-04-06 21:38:20 +00001786 return true;
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001787 if (const auto *MD = dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()))
Alp Tokera2794f92014-01-22 07:29:52 +00001788 return MD->isInstance();
John McCalla8ae2222010-04-06 21:38:20 +00001789 return false;
1790}
1791
Argyrios Kyrtzidis9e59b572008-11-09 23:41:00 +00001792//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis6032ef12009-08-21 00:31:54 +00001793// DeclaratorDecl Implementation
1794//===----------------------------------------------------------------------===//
1795
Douglas Gregorec9c6ae2010-07-06 18:42:40 +00001796template <typename DeclT>
1797static SourceLocation getTemplateOrInnerLocStart(const DeclT *decl) {
1798 if (decl->getNumTemplateParameterLists() > 0)
1799 return decl->getTemplateParameterList(0)->getTemplateLoc();
1800 else
1801 return decl->getInnerLocStart();
1802}
1803
Argyrios Kyrtzidis6032ef12009-08-21 00:31:54 +00001804SourceLocation DeclaratorDecl::getTypeSpecStartLoc() const {
John McCallf7bcc812010-05-28 23:32:21 +00001805 TypeSourceInfo *TSI = getTypeSourceInfo();
1806 if (TSI) return TSI->getTypeLoc().getBeginLoc();
Argyrios Kyrtzidis6032ef12009-08-21 00:31:54 +00001807 return SourceLocation();
1808}
1809
Mark de Weverf022a5a2020-01-01 17:23:19 +01001810SourceLocation DeclaratorDecl::getTypeSpecEndLoc() const {
1811 TypeSourceInfo *TSI = getTypeSourceInfo();
1812 if (TSI) return TSI->getTypeLoc().getEndLoc();
1813 return SourceLocation();
1814}
1815
Douglas Gregor14454802011-02-25 02:25:35 +00001816void DeclaratorDecl::setQualifierInfo(NestedNameSpecifierLoc QualifierLoc) {
1817 if (QualifierLoc) {
John McCall3e11ebe2010-03-15 10:12:16 +00001818 // Make sure the extended decl info is allocated.
1819 if (!hasExtInfo()) {
1820 // Save (non-extended) type source info pointer.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001821 auto *savedTInfo = DeclInfo.get<TypeSourceInfo*>();
John McCall3e11ebe2010-03-15 10:12:16 +00001822 // Allocate external info struct.
1823 DeclInfo = new (getASTContext()) ExtInfo;
1824 // Restore savedTInfo into (extended) decl info.
1825 getExtInfo()->TInfo = savedTInfo;
1826 }
1827 // Set qualifier info.
Douglas Gregor14454802011-02-25 02:25:35 +00001828 getExtInfo()->QualifierLoc = QualifierLoc;
Saar Razb65b1f32020-01-09 15:07:51 +02001829 } else if (hasExtInfo()) {
John McCall3e11ebe2010-03-15 10:12:16 +00001830 // Here Qualifier == 0, i.e., we are removing the qualifier (if any).
Saar Razb65b1f32020-01-09 15:07:51 +02001831 getExtInfo()->QualifierLoc = QualifierLoc;
John McCall3e11ebe2010-03-15 10:12:16 +00001832 }
1833}
1834
Saar Razb65b1f32020-01-09 15:07:51 +02001835void DeclaratorDecl::setTrailingRequiresClause(Expr *TrailingRequiresClause) {
1836 assert(TrailingRequiresClause);
1837 // Make sure the extended decl info is allocated.
1838 if (!hasExtInfo()) {
1839 // Save (non-extended) type source info pointer.
1840 auto *savedTInfo = DeclInfo.get<TypeSourceInfo*>();
1841 // Allocate external info struct.
1842 DeclInfo = new (getASTContext()) ExtInfo;
1843 // Restore savedTInfo into (extended) decl info.
1844 getExtInfo()->TInfo = savedTInfo;
1845 }
1846 // Set requires clause info.
1847 getExtInfo()->TrailingRequiresClause = TrailingRequiresClause;
1848}
1849
Benjamin Kramer9cc210652015-08-05 09:40:49 +00001850void DeclaratorDecl::setTemplateParameterListsInfo(
1851 ASTContext &Context, ArrayRef<TemplateParameterList *> TPLists) {
1852 assert(!TPLists.empty());
Abramo Bagnara60804e12011-03-18 15:16:37 +00001853 // Make sure the extended decl info is allocated.
1854 if (!hasExtInfo()) {
1855 // Save (non-extended) type source info pointer.
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00001856 auto *savedTInfo = DeclInfo.get<TypeSourceInfo*>();
Abramo Bagnara60804e12011-03-18 15:16:37 +00001857 // Allocate external info struct.
1858 DeclInfo = new (getASTContext()) ExtInfo;
1859 // Restore savedTInfo into (extended) decl info.
1860 getExtInfo()->TInfo = savedTInfo;
1861 }
1862 // Set the template parameter lists info.
Benjamin Kramer9cc210652015-08-05 09:40:49 +00001863 getExtInfo()->setTemplateParameterListsInfo(Context, TPLists);
Abramo Bagnara60804e12011-03-18 15:16:37 +00001864}
1865
Douglas Gregorec9c6ae2010-07-06 18:42:40 +00001866SourceLocation DeclaratorDecl::getOuterLocStart() const {
1867 return getTemplateOrInnerLocStart(this);
1868}
1869
Abramo Bagnaraea947882011-03-08 16:41:52 +00001870// Helper function: returns true if QT is or contains a type
1871// having a postfix component.
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001872static bool typeIsPostfix(QualType QT) {
Abramo Bagnaraea947882011-03-08 16:41:52 +00001873 while (true) {
1874 const Type* T = QT.getTypePtr();
1875 switch (T->getTypeClass()) {
1876 default:
1877 return false;
1878 case Type::Pointer:
1879 QT = cast<PointerType>(T)->getPointeeType();
1880 break;
1881 case Type::BlockPointer:
1882 QT = cast<BlockPointerType>(T)->getPointeeType();
1883 break;
1884 case Type::MemberPointer:
1885 QT = cast<MemberPointerType>(T)->getPointeeType();
1886 break;
1887 case Type::LValueReference:
1888 case Type::RValueReference:
1889 QT = cast<ReferenceType>(T)->getPointeeType();
1890 break;
1891 case Type::PackExpansion:
1892 QT = cast<PackExpansionType>(T)->getPattern();
1893 break;
1894 case Type::Paren:
1895 case Type::ConstantArray:
1896 case Type::DependentSizedArray:
1897 case Type::IncompleteArray:
1898 case Type::VariableArray:
1899 case Type::FunctionProto:
1900 case Type::FunctionNoProto:
1901 return true;
1902 }
1903 }
1904}
1905
Abramo Bagnaraea947882011-03-08 16:41:52 +00001906SourceRange DeclaratorDecl::getSourceRange() const {
1907 SourceLocation RangeEnd = getLocation();
1908 if (TypeSourceInfo *TInfo = getTypeSourceInfo()) {
Benjamin Kramer3a7cc812014-02-02 15:28:46 +00001909 // If the declaration has no name or the type extends past the name take the
1910 // end location of the type.
1911 if (!getDeclName() || typeIsPostfix(TInfo->getType()))
Abramo Bagnaraea947882011-03-08 16:41:52 +00001912 RangeEnd = TInfo->getTypeLoc().getSourceRange().getEnd();
1913 }
1914 return SourceRange(getOuterLocStart(), RangeEnd);
1915}
1916
Benjamin Kramer9cc210652015-08-05 09:40:49 +00001917void QualifierInfo::setTemplateParameterListsInfo(
1918 ASTContext &Context, ArrayRef<TemplateParameterList *> TPLists) {
Abramo Bagnarada41d0c2010-06-12 08:15:14 +00001919 // Free previous template parameters (if any).
1920 if (NumTemplParamLists > 0) {
Douglas Gregor20527e22010-06-15 17:44:38 +00001921 Context.Deallocate(TemplParamLists);
Craig Topper36250ad2014-05-12 05:36:57 +00001922 TemplParamLists = nullptr;
Abramo Bagnarada41d0c2010-06-12 08:15:14 +00001923 NumTemplParamLists = 0;
1924 }
1925 // Set info on matched template parameter lists (if any).
Benjamin Kramer9cc210652015-08-05 09:40:49 +00001926 if (!TPLists.empty()) {
1927 TemplParamLists = new (Context) TemplateParameterList *[TPLists.size()];
1928 NumTemplParamLists = TPLists.size();
1929 std::copy(TPLists.begin(), TPLists.end(), TemplParamLists);
Abramo Bagnarada41d0c2010-06-12 08:15:14 +00001930 }
1931}
1932
Argyrios Kyrtzidis6032ef12009-08-21 00:31:54 +00001933//===----------------------------------------------------------------------===//
Nuno Lopes394ec982008-12-17 23:39:55 +00001934// VarDecl Implementation
1935//===----------------------------------------------------------------------===//
1936
Sebastian Redl833ef452010-01-26 22:01:41 +00001937const char *VarDecl::getStorageClassSpecifierString(StorageClass SC) {
1938 switch (SC) {
Peter Collingbourne2dbb7082011-09-19 21:14:35 +00001939 case SC_None: break;
Peter Collingbourne9a8f1532011-09-20 12:40:26 +00001940 case SC_Auto: return "auto";
1941 case SC_Extern: return "extern";
Peter Collingbourne9a8f1532011-09-20 12:40:26 +00001942 case SC_PrivateExtern: return "__private_extern__";
1943 case SC_Register: return "register";
1944 case SC_Static: return "static";
Sebastian Redl833ef452010-01-26 22:01:41 +00001945 }
1946
Peter Collingbourne9a8f1532011-09-20 12:40:26 +00001947 llvm_unreachable("Invalid storage class");
Sebastian Redl833ef452010-01-26 22:01:41 +00001948}
1949
Richard Smith053f6c62014-05-16 23:01:30 +00001950VarDecl::VarDecl(Kind DK, ASTContext &C, DeclContext *DC,
1951 SourceLocation StartLoc, SourceLocation IdLoc,
1952 IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo,
1953 StorageClass SC)
1954 : DeclaratorDecl(DK, DC, IdLoc, Id, T, TInfo, StartLoc),
Eugene Zelenkode0215c2017-11-13 23:01:27 +00001955 redeclarable_base(C) {
Benjamin Kramera939c232014-03-15 18:54:13 +00001956 static_assert(sizeof(VarDeclBitfields) <= sizeof(unsigned),
1957 "VarDeclBitfields too large!");
1958 static_assert(sizeof(ParmVarDeclBitfields) <= sizeof(unsigned),
1959 "ParmVarDeclBitfields too large!");
David Majnemerfa7bc782015-05-19 00:57:16 +00001960 static_assert(sizeof(NonParmVarDeclBitfields) <= sizeof(unsigned),
1961 "NonParmVarDeclBitfields too large!");
Larisse Voufo39a1e502013-08-06 01:03:05 +00001962 AllBits = 0;
1963 VarDeclBits.SClass = SC;
1964 // Everything else is implicitly initialized to false.
1965}
1966
Abramo Bagnaradff19302011-03-08 08:55:46 +00001967VarDecl *VarDecl::Create(ASTContext &C, DeclContext *DC,
1968 SourceLocation StartL, SourceLocation IdL,
John McCallbcd03502009-12-07 02:54:59 +00001969 IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo,
Rafael Espindola6ae7e502013-04-03 19:27:57 +00001970 StorageClass S) {
Richard Smith053f6c62014-05-16 23:01:30 +00001971 return new (C, DC) VarDecl(Var, C, DC, StartL, IdL, Id, T, TInfo, S);
Nuno Lopes394ec982008-12-17 23:39:55 +00001972}
1973
Douglas Gregor72172e92012-01-05 21:55:30 +00001974VarDecl *VarDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00001975 return new (C, ID)
1976 VarDecl(Var, C, nullptr, SourceLocation(), SourceLocation(), nullptr,
1977 QualType(), nullptr, SC_None);
Douglas Gregor72172e92012-01-05 21:55:30 +00001978}
1979
Douglas Gregorbf62d642010-12-06 18:36:25 +00001980void VarDecl::setStorageClass(StorageClass SC) {
1981 assert(isLegalForVariable(SC));
John McCallbeaa11c2011-05-01 02:13:58 +00001982 VarDeclBits.SClass = SC;
Douglas Gregorbf62d642010-12-06 18:36:25 +00001983}
1984
Reid Kleckner7d6d2702014-05-01 03:16:47 +00001985VarDecl::TLSKind VarDecl::getTLSKind() const {
1986 switch (VarDeclBits.TSCSpec) {
1987 case TSCS_unspecified:
Samuel Antaof8b50122015-07-13 22:54:53 +00001988 if (!hasAttr<ThreadAttr>() &&
1989 !(getASTContext().getLangOpts().OpenMPUseTLS &&
1990 getASTContext().getTargetInfo().isTLSSupported() &&
1991 hasAttr<OMPThreadPrivateDeclAttr>()))
David Majnemer1b5baff2015-05-14 05:19:23 +00001992 return TLS_None;
Samuel Antaof8b50122015-07-13 22:54:53 +00001993 return ((getASTContext().getLangOpts().isCompatibleWithMSVC(
1994 LangOptions::MSVC2015)) ||
1995 hasAttr<OMPThreadPrivateDeclAttr>())
David Majnemer1b5baff2015-05-14 05:19:23 +00001996 ? TLS_Dynamic
1997 : TLS_Static;
Reid Kleckner7d6d2702014-05-01 03:16:47 +00001998 case TSCS___thread: // Fall through.
1999 case TSCS__Thread_local:
Samuel Antaof8b50122015-07-13 22:54:53 +00002000 return TLS_Static;
Reid Kleckner7d6d2702014-05-01 03:16:47 +00002001 case TSCS_thread_local:
2002 return TLS_Dynamic;
2003 }
2004 llvm_unreachable("Unknown thread storage class specifier!");
2005}
2006
Douglas Gregorec9c6ae2010-07-06 18:42:40 +00002007SourceRange VarDecl::getSourceRange() const {
Argyrios Kyrtzidise0d64972012-10-08 23:08:41 +00002008 if (const Expr *Init = getInit()) {
Stephen Kelly1c301dc2018-08-09 21:09:38 +00002009 SourceLocation InitEnd = Init->getEndLoc();
Fangrui Song6907ce22018-07-30 19:24:48 +00002010 // If Init is implicit, ignore its source range and fallback on
Nico Weberbbe13942013-01-22 17:00:09 +00002011 // DeclaratorDecl::getSourceRange() to handle postfix elements.
2012 if (InitEnd.isValid() && InitEnd != getLocation())
Argyrios Kyrtzidise0d64972012-10-08 23:08:41 +00002013 return SourceRange(getOuterLocStart(), InitEnd);
2014 }
Abramo Bagnaraea947882011-03-08 16:41:52 +00002015 return DeclaratorDecl::getSourceRange();
Argyrios Kyrtzidisa3aeb5a2009-06-20 08:09:14 +00002016}
2017
Rafael Espindola88510672013-01-04 21:18:45 +00002018template<typename T>
Alp Toker84212df2014-05-31 06:11:02 +00002019static LanguageLinkage getDeclLanguageLinkage(const T &D) {
Rafael Espindola5bda63f2013-02-14 01:47:04 +00002020 // C++ [dcl.link]p1: All function types, function names with external linkage,
2021 // and variable names with external linkage have a language linkage.
Rafael Espindola3ae00052013-05-13 00:12:11 +00002022 if (!D.hasExternalFormalLinkage())
Rafael Espindola5bda63f2013-02-14 01:47:04 +00002023 return NoLanguageLinkage;
2024
2025 // Language linkage is a C++ concept, but saying that everything else in C has
Rafael Espindola66748e92013-01-04 20:41:40 +00002026 // C language linkage fits the implementation nicely.
Rafael Espindola576127d2012-12-28 14:21:58 +00002027 ASTContext &Context = D.getASTContext();
2028 if (!Context.getLangOpts().CPlusPlus)
Rafael Espindolaf4187652013-02-14 01:18:37 +00002029 return CLanguageLinkage;
2030
Rafael Espindola5bda63f2013-02-14 01:47:04 +00002031 // C++ [dcl.link]p4: A C language linkage is ignored in determining the
2032 // language linkage of the names of class members and the function type of
2033 // class member functions.
Rafael Espindola576127d2012-12-28 14:21:58 +00002034 const DeclContext *DC = D.getDeclContext();
2035 if (DC->isRecord())
Rafael Espindolaf4187652013-02-14 01:18:37 +00002036 return CXXLanguageLinkage;
Rafael Espindola576127d2012-12-28 14:21:58 +00002037
2038 // If the first decl is in an extern "C" context, any other redeclaration
2039 // will have C language linkage. If the first one is not in an extern "C"
2040 // context, we would have reported an error for any other decl being in one.
Rafael Espindola593537a2013-05-05 20:15:21 +00002041 if (isFirstInExternCContext(&D))
Rafael Espindolaf4187652013-02-14 01:18:37 +00002042 return CLanguageLinkage;
2043 return CXXLanguageLinkage;
Rafael Espindola576127d2012-12-28 14:21:58 +00002044}
2045
Rafael Espindola0e0d0092013-03-14 03:07:35 +00002046template<typename T>
Alp Toker84212df2014-05-31 06:11:02 +00002047static bool isDeclExternC(const T &D) {
Rafael Espindola0e0d0092013-03-14 03:07:35 +00002048 // Since the context is ignored for class members, they can only have C++
2049 // language linkage or no language linkage.
2050 const DeclContext *DC = D.getDeclContext();
2051 if (DC->isRecord()) {
2052 assert(D.getASTContext().getLangOpts().CPlusPlus);
2053 return false;
2054 }
2055
2056 return D.getLanguageLinkage() == CLanguageLinkage;
2057}
2058
Rafael Espindolaf4187652013-02-14 01:18:37 +00002059LanguageLinkage VarDecl::getLanguageLinkage() const {
Alp Toker84212df2014-05-31 06:11:02 +00002060 return getDeclLanguageLinkage(*this);
Rafael Espindola576127d2012-12-28 14:21:58 +00002061}
2062
Rafael Espindola0e0d0092013-03-14 03:07:35 +00002063bool VarDecl::isExternC() const {
Alp Toker84212df2014-05-31 06:11:02 +00002064 return isDeclExternC(*this);
Rafael Espindola0e0d0092013-03-14 03:07:35 +00002065}
2066
Rafael Espindola593537a2013-05-05 20:15:21 +00002067bool VarDecl::isInExternCContext() const {
Serge Pavlov3cb80222013-11-14 02:13:03 +00002068 return getLexicalDeclContext()->isExternCContext();
Rafael Espindola593537a2013-05-05 20:15:21 +00002069}
2070
2071bool VarDecl::isInExternCXXContext() const {
Serge Pavlov3cb80222013-11-14 02:13:03 +00002072 return getLexicalDeclContext()->isExternCXXContext();
Rafael Espindola593537a2013-05-05 20:15:21 +00002073}
2074
Rafael Espindola8db352d2013-10-17 15:37:26 +00002075VarDecl *VarDecl::getCanonicalDecl() { return getFirstDecl(); }
Sebastian Redl833ef452010-01-26 22:01:41 +00002076
Nico Weber7f5015a2015-04-15 21:53:00 +00002077VarDecl::DefinitionKind
2078VarDecl::isThisDeclarationADefinition(ASTContext &C) const {
Richard Smitha22d9a52017-12-02 00:55:48 +00002079 if (isThisDeclarationADemotedDefinition())
2080 return DeclarationOnly;
2081
Sebastian Redl35351a92010-01-31 22:27:38 +00002082 // C++ [basic.def]p2:
2083 // A declaration is a definition unless [...] it contains the 'extern'
2084 // specifier or a linkage-specification and neither an initializer [...],
Richard Smith62f19e72016-06-25 00:15:56 +00002085 // it declares a non-inline static data member in a class declaration [...],
2086 // it declares a static data member outside a class definition and the variable
2087 // was defined within the class with the constexpr specifier [...],
Richard Smith8809a0c2013-09-27 20:14:12 +00002088 // C++1y [temp.expl.spec]p15:
2089 // An explicit specialization of a static data member or an explicit
2090 // specialization of a static data member template is a definition if the
2091 // declaration includes an initializer; otherwise, it is a declaration.
2092 //
2093 // FIXME: How do you declare (but not define) a partial specialization of
2094 // a static data member template outside the containing class?
Sebastian Redl35351a92010-01-31 22:27:38 +00002095 if (isStaticDataMember()) {
Richard Smith8809a0c2013-09-27 20:14:12 +00002096 if (isOutOfLine() &&
Richard Smith62f19e72016-06-25 00:15:56 +00002097 !(getCanonicalDecl()->isInline() &&
2098 getCanonicalDecl()->isConstexpr()) &&
Richard Smith8809a0c2013-09-27 20:14:12 +00002099 (hasInit() ||
2100 // If the first declaration is out-of-line, this may be an
2101 // instantiation of an out-of-line partial specialization of a variable
2102 // template for which we have not yet instantiated the initializer.
Rafael Espindola8db352d2013-10-17 15:37:26 +00002103 (getFirstDecl()->isOutOfLine()
Richard Smith8809a0c2013-09-27 20:14:12 +00002104 ? getTemplateSpecializationKind() == TSK_Undeclared
2105 : getTemplateSpecializationKind() !=
2106 TSK_ExplicitSpecialization) ||
2107 isa<VarTemplatePartialSpecializationDecl>(this)))
Sebastian Redl35351a92010-01-31 22:27:38 +00002108 return Definition;
Richard Smith62f19e72016-06-25 00:15:56 +00002109 else if (!isOutOfLine() && isInline())
2110 return Definition;
Sebastian Redl35351a92010-01-31 22:27:38 +00002111 else
2112 return DeclarationOnly;
2113 }
2114 // C99 6.7p5:
2115 // A definition of an identifier is a declaration for that identifier that
2116 // [...] causes storage to be reserved for that object.
2117 // Note: that applies for all non-file-scope objects.
2118 // C99 6.9.2p1:
2119 // If the declaration of an identifier for an object has file scope and an
2120 // initializer, the declaration is an external definition for the identifier
2121 if (hasInit())
2122 return Definition;
Rafael Espindolabff59562013-04-25 12:11:36 +00002123
Dmitry Polukhin85eda122016-04-11 07:48:59 +00002124 if (hasDefiningAttr())
Rafael Espindolad53ffa02013-10-22 21:39:03 +00002125 return Definition;
2126
David Majnemerdd0bed12015-05-14 05:19:20 +00002127 if (const auto *SAA = getAttr<SelectAnyAttr>())
2128 if (!SAA->isInherited())
2129 return Definition;
2130
Richard Smith8809a0c2013-09-27 20:14:12 +00002131 // A variable template specialization (other than a static data member
2132 // template or an explicit specialization) is a declaration until we
2133 // instantiate its initializer.
Richard Smith435e6472017-12-02 02:48:42 +00002134 if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(this)) {
2135 if (VTSD->getTemplateSpecializationKind() != TSK_ExplicitSpecialization &&
2136 !isa<VarTemplatePartialSpecializationDecl>(VTSD) &&
2137 !VTSD->IsCompleteDefinition)
2138 return DeclarationOnly;
2139 }
Richard Smith8809a0c2013-09-27 20:14:12 +00002140
Nico Weber608e7682015-04-15 23:04:24 +00002141 if (hasExternalStorage())
Sebastian Redl35351a92010-01-31 22:27:38 +00002142 return DeclarationOnly;
Rafael Espindola8f326a52013-03-07 01:42:44 +00002143
Rafael Espindolabff59562013-04-25 12:11:36 +00002144 // [dcl.link] p7:
2145 // A declaration directly contained in a linkage-specification is treated
2146 // as if it contains the extern specifier for the purpose of determining
2147 // the linkage of the declared name and whether it is a definition.
Nico Weber608e7682015-04-15 23:04:24 +00002148 if (isSingleLineLanguageLinkage(*this))
Rafael Espindola327be3c2013-04-26 01:30:23 +00002149 return DeclarationOnly;
Rafael Espindolabff59562013-04-25 12:11:36 +00002150
Sebastian Redl35351a92010-01-31 22:27:38 +00002151 // C99 6.9.2p2:
2152 // A declaration of an object that has file scope without an initializer,
2153 // and without a storage class specifier or the scs 'static', constitutes
2154 // a tentative definition.
2155 // No such thing in C++.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002156 if (!C.getLangOpts().CPlusPlus && isFileVarDecl())
Sebastian Redl35351a92010-01-31 22:27:38 +00002157 return TentativeDefinition;
2158
2159 // What's left is (in C, block-scope) declarations without initializers or
2160 // external storage. These are definitions.
2161 return Definition;
2162}
2163
Sebastian Redl35351a92010-01-31 22:27:38 +00002164VarDecl *VarDecl::getActingDefinition() {
2165 DefinitionKind Kind = isThisDeclarationADefinition();
2166 if (Kind != TentativeDefinition)
Craig Topper36250ad2014-05-12 05:36:57 +00002167 return nullptr;
Sebastian Redl35351a92010-01-31 22:27:38 +00002168
Craig Topper36250ad2014-05-12 05:36:57 +00002169 VarDecl *LastTentative = nullptr;
Rafael Espindola8db352d2013-10-17 15:37:26 +00002170 VarDecl *First = getFirstDecl();
Aaron Ballman86c93902014-03-06 23:45:36 +00002171 for (auto I : First->redecls()) {
2172 Kind = I->isThisDeclarationADefinition();
Sebastian Redl35351a92010-01-31 22:27:38 +00002173 if (Kind == Definition)
Craig Topper36250ad2014-05-12 05:36:57 +00002174 return nullptr;
Sebastian Redl35351a92010-01-31 22:27:38 +00002175 else if (Kind == TentativeDefinition)
Aaron Ballman86c93902014-03-06 23:45:36 +00002176 LastTentative = I;
Sebastian Redl35351a92010-01-31 22:27:38 +00002177 }
2178 return LastTentative;
2179}
2180
Daniel Dunbar9d355812012-03-09 01:51:51 +00002181VarDecl *VarDecl::getDefinition(ASTContext &C) {
Rafael Espindola8db352d2013-10-17 15:37:26 +00002182 VarDecl *First = getFirstDecl();
Aaron Ballman86c93902014-03-06 23:45:36 +00002183 for (auto I : First->redecls()) {
2184 if (I->isThisDeclarationADefinition(C) == Definition)
2185 return I;
Sebastian Redl5ca79842010-02-01 20:16:42 +00002186 }
Craig Topper36250ad2014-05-12 05:36:57 +00002187 return nullptr;
Sebastian Redl5ca79842010-02-01 20:16:42 +00002188}
2189
Daniel Dunbar9d355812012-03-09 01:51:51 +00002190VarDecl::DefinitionKind VarDecl::hasDefinition(ASTContext &C) const {
John McCall37bb6c92010-10-29 22:22:43 +00002191 DefinitionKind Kind = DeclarationOnly;
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002192
Rafael Espindola8db352d2013-10-17 15:37:26 +00002193 const VarDecl *First = getFirstDecl();
Aaron Ballman86c93902014-03-06 23:45:36 +00002194 for (auto I : First->redecls()) {
2195 Kind = std::max(Kind, I->isThisDeclarationADefinition(C));
Daniel Dunbar082c62d2012-03-06 23:52:46 +00002196 if (Kind == Definition)
2197 break;
2198 }
John McCall37bb6c92010-10-29 22:22:43 +00002199
2200 return Kind;
2201}
2202
Sebastian Redl5ca79842010-02-01 20:16:42 +00002203const Expr *VarDecl::getAnyInitializer(const VarDecl *&D) const {
Aaron Ballman86c93902014-03-06 23:45:36 +00002204 for (auto I : redecls()) {
2205 if (auto Expr = I->getInit()) {
2206 D = I;
2207 return Expr;
2208 }
Sebastian Redl833ef452010-01-26 22:01:41 +00002209 }
Craig Topper36250ad2014-05-12 05:36:57 +00002210 return nullptr;
Sebastian Redl833ef452010-01-26 22:01:41 +00002211}
2212
Chandler Carruth813faed2015-12-30 02:51:00 +00002213bool VarDecl::hasInit() const {
2214 if (auto *P = dyn_cast<ParmVarDecl>(this))
2215 if (P->hasUnparsedDefaultArg() || P->hasUninstantiatedDefaultArg())
2216 return false;
2217
2218 return !Init.isNull();
2219}
2220
2221Expr *VarDecl::getInit() {
2222 if (!hasInit())
2223 return nullptr;
2224
2225 if (auto *S = Init.dyn_cast<Stmt *>())
2226 return cast<Expr>(S);
2227
2228 return cast_or_null<Expr>(Init.get<EvaluatedStmt *>()->Value);
2229}
2230
2231Stmt **VarDecl::getInitAddress() {
2232 if (auto *ES = Init.dyn_cast<EvaluatedStmt *>())
2233 return &ES->Value;
2234
2235 return Init.getAddrOfPtr1();
2236}
2237
Richard Smitha6e8b682019-09-04 20:30:37 +00002238VarDecl *VarDecl::getInitializingDeclaration() {
2239 VarDecl *Def = nullptr;
2240 for (auto I : redecls()) {
2241 if (I->hasInit())
2242 return I;
2243
2244 if (I->isThisDeclarationADefinition()) {
2245 if (isStaticDataMember())
2246 return I;
2247 else
2248 Def = I;
2249 }
2250 }
2251 return Def;
2252}
2253
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002254bool VarDecl::isOutOfLine() const {
Douglas Gregorb11aad82011-02-19 18:51:44 +00002255 if (Decl::isOutOfLine())
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002256 return true;
Chandler Carruthf50ef6e2010-02-21 07:08:09 +00002257
2258 if (!isStaticDataMember())
2259 return false;
2260
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002261 // If this static data member was instantiated from a static data member of
Fangrui Song6907ce22018-07-30 19:24:48 +00002262 // a class template, check whether that static data member was defined
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002263 // out-of-line.
2264 if (VarDecl *VD = getInstantiatedFromStaticDataMember())
2265 return VD->isOutOfLine();
Fangrui Song6907ce22018-07-30 19:24:48 +00002266
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002267 return false;
2268}
2269
Douglas Gregord5058122010-02-11 01:19:42 +00002270void VarDecl::setInit(Expr *I) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002271 if (auto *Eval = Init.dyn_cast<EvaluatedStmt *>()) {
Sebastian Redl833ef452010-01-26 22:01:41 +00002272 Eval->~EvaluatedStmt();
Douglas Gregord5058122010-02-11 01:19:42 +00002273 getASTContext().Deallocate(Eval);
Sebastian Redl833ef452010-01-26 22:01:41 +00002274 }
2275
2276 Init = I;
2277}
2278
Richard Smith715f7a12019-06-11 17:50:32 +00002279bool VarDecl::mightBeUsableInConstantExpressions(ASTContext &C) const {
David Blaikiebbafb8a2012-03-11 07:00:24 +00002280 const LangOptions &Lang = C.getLangOpts();
Richard Smith242ad892011-12-21 02:55:12 +00002281
Richard Smith35ecb362012-03-02 04:14:40 +00002282 if (!Lang.CPlusPlus)
2283 return false;
2284
Richard Smith715f7a12019-06-11 17:50:32 +00002285 // Function parameters are never usable in constant expressions.
2286 if (isa<ParmVarDecl>(this))
2287 return false;
2288
Richard Smith35ecb362012-03-02 04:14:40 +00002289 // In C++11, any variable of reference type can be used in a constant
2290 // expression if it is initialized by a constant expression.
Richard Smith2bf7fdb2013-01-02 11:42:31 +00002291 if (Lang.CPlusPlus11 && getType()->isReferenceType())
Richard Smith35ecb362012-03-02 04:14:40 +00002292 return true;
2293
2294 // Only const objects can be used in constant expressions in C++. C++98 does
Richard Smith242ad892011-12-21 02:55:12 +00002295 // not require the variable to be non-volatile, but we consider this to be a
2296 // defect.
Richard Smith35ecb362012-03-02 04:14:40 +00002297 if (!getType().isConstQualified() || getType().isVolatileQualified())
Richard Smith242ad892011-12-21 02:55:12 +00002298 return false;
2299
2300 // In C++, const, non-volatile variables of integral or enumeration types
2301 // can be used in constant expressions.
2302 if (getType()->isIntegralOrEnumerationType())
2303 return true;
2304
Richard Smith35ecb362012-03-02 04:14:40 +00002305 // Additionally, in C++11, non-volatile constexpr variables can be used in
2306 // constant expressions.
Richard Smith2bf7fdb2013-01-02 11:42:31 +00002307 return Lang.CPlusPlus11 && isConstexpr();
Richard Smith242ad892011-12-21 02:55:12 +00002308}
2309
Richard Smith715f7a12019-06-11 17:50:32 +00002310bool VarDecl::isUsableInConstantExpressions(ASTContext &Context) const {
2311 // C++2a [expr.const]p3:
2312 // A variable is usable in constant expressions after its initializing
2313 // declaration is encountered...
2314 const VarDecl *DefVD = nullptr;
2315 const Expr *Init = getAnyInitializer(DefVD);
Richard Smith94bc88e2019-06-17 21:46:17 +00002316 if (!Init || Init->isValueDependent() || getType()->isDependentType())
Richard Smith715f7a12019-06-11 17:50:32 +00002317 return false;
2318 // ... if it is a constexpr variable, or it is of reference type or of
2319 // const-qualified integral or enumeration type, ...
2320 if (!DefVD->mightBeUsableInConstantExpressions(Context))
2321 return false;
2322 // ... and its initializer is a constant initializer.
2323 return DefVD->checkInitIsICE();
2324}
2325
Richard Smithd0b4dd62011-12-19 06:19:21 +00002326/// Convert the initializer for this declaration to the elaborated EvaluatedStmt
2327/// form, which contains extra information on the evaluated value of the
2328/// initializer.
2329EvaluatedStmt *VarDecl::ensureEvaluatedStmt() const {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002330 auto *Eval = Init.dyn_cast<EvaluatedStmt *>();
Richard Smithd0b4dd62011-12-19 06:19:21 +00002331 if (!Eval) {
Manuel Klimeka7328992013-06-03 13:51:33 +00002332 // Note: EvaluatedStmt contains an APValue, which usually holds
2333 // resources not allocated from the ASTContext. We need to do some
2334 // work to avoid leaking those, but we do so in VarDecl::evaluateValue
2335 // where we can detect whether there's anything to clean up or not.
Richard Smithd0b4dd62011-12-19 06:19:21 +00002336 Eval = new (getASTContext()) EvaluatedStmt;
Chandler Carruth813faed2015-12-30 02:51:00 +00002337 Eval->Value = Init.get<Stmt *>();
Richard Smithd0b4dd62011-12-19 06:19:21 +00002338 Init = Eval;
2339 }
2340 return Eval;
2341}
2342
Richard Smithdafff942012-01-14 04:30:29 +00002343APValue *VarDecl::evaluateValue() const {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002344 SmallVector<PartialDiagnosticAt, 8> Notes;
Richard Smithdafff942012-01-14 04:30:29 +00002345 return evaluateValue(Notes);
2346}
2347
2348APValue *VarDecl::evaluateValue(
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002349 SmallVectorImpl<PartialDiagnosticAt> &Notes) const {
Richard Smithd0b4dd62011-12-19 06:19:21 +00002350 EvaluatedStmt *Eval = ensureEvaluatedStmt();
2351
2352 // We only produce notes indicating why an initializer is non-constant the
2353 // first time it is evaluated. FIXME: The notes won't always be emitted the
2354 // first time we try evaluation, so might not be produced at all.
2355 if (Eval->WasEvaluated)
Richard Smithe637cbe2019-05-21 23:15:18 +00002356 return Eval->Evaluated.isAbsent() ? nullptr : &Eval->Evaluated;
Richard Smithd0b4dd62011-12-19 06:19:21 +00002357
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002358 const auto *Init = cast<Expr>(Eval->Value);
Richard Smithd0b4dd62011-12-19 06:19:21 +00002359 assert(!Init->isValueDependent());
2360
2361 if (Eval->IsEvaluating) {
2362 // FIXME: Produce a diagnostic for self-initialization.
2363 Eval->CheckedICE = true;
2364 Eval->IsICE = false;
Craig Topper36250ad2014-05-12 05:36:57 +00002365 return nullptr;
Richard Smithd0b4dd62011-12-19 06:19:21 +00002366 }
2367
2368 Eval->IsEvaluating = true;
2369
2370 bool Result = Init->EvaluateAsInitializer(Eval->Evaluated, getASTContext(),
2371 this, Notes);
2372
Manuel Klimeka7328992013-06-03 13:51:33 +00002373 // Ensure the computed APValue is cleaned up later if evaluation succeeded,
2374 // or that it's empty (so that there's nothing to clean up) if evaluation
2375 // failed.
Richard Smithd0b4dd62011-12-19 06:19:21 +00002376 if (!Result)
2377 Eval->Evaluated = APValue();
Manuel Klimeka7328992013-06-03 13:51:33 +00002378 else if (Eval->Evaluated.needsCleanup())
George Burgess IVb61bfbd2017-02-14 05:37:36 +00002379 getASTContext().addDestruction(&Eval->Evaluated);
Richard Smithd0b4dd62011-12-19 06:19:21 +00002380
2381 Eval->IsEvaluating = false;
2382 Eval->WasEvaluated = true;
2383
2384 // In C++11, we have determined whether the initializer was a constant
2385 // expression as a side-effect.
Richard Smith2bf7fdb2013-01-02 11:42:31 +00002386 if (getASTContext().getLangOpts().CPlusPlus11 && !Eval->CheckedICE) {
Richard Smithd0b4dd62011-12-19 06:19:21 +00002387 Eval->CheckedICE = true;
Eli Friedman8f66cdf2012-02-06 21:50:18 +00002388 Eval->IsICE = Result && Notes.empty();
Richard Smithd0b4dd62011-12-19 06:19:21 +00002389 }
2390
Craig Topper36250ad2014-05-12 05:36:57 +00002391 return Result ? &Eval->Evaluated : nullptr;
Richard Smithd0b4dd62011-12-19 06:19:21 +00002392}
2393
Chandler Carruth813faed2015-12-30 02:51:00 +00002394APValue *VarDecl::getEvaluatedValue() const {
2395 if (EvaluatedStmt *Eval = Init.dyn_cast<EvaluatedStmt *>())
2396 if (Eval->WasEvaluated)
2397 return &Eval->Evaluated;
2398
2399 return nullptr;
2400}
2401
2402bool VarDecl::isInitKnownICE() const {
2403 if (EvaluatedStmt *Eval = Init.dyn_cast<EvaluatedStmt *>())
2404 return Eval->CheckedICE;
2405
2406 return false;
2407}
2408
2409bool VarDecl::isInitICE() const {
2410 assert(isInitKnownICE() &&
2411 "Check whether we already know that the initializer is an ICE");
2412 return Init.get<EvaluatedStmt *>()->IsICE;
2413}
2414
Richard Smithd0b4dd62011-12-19 06:19:21 +00002415bool VarDecl::checkInitIsICE() const {
John McCalla59dc2f2012-01-05 00:13:19 +00002416 // Initializers of weak variables are never ICEs.
2417 if (isWeak())
2418 return false;
2419
Richard Smithd0b4dd62011-12-19 06:19:21 +00002420 EvaluatedStmt *Eval = ensureEvaluatedStmt();
2421 if (Eval->CheckedICE)
2422 // We have already checked whether this subexpression is an
2423 // integral constant expression.
2424 return Eval->IsICE;
2425
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002426 const auto *Init = cast<Expr>(Eval->Value);
Richard Smithd0b4dd62011-12-19 06:19:21 +00002427 assert(!Init->isValueDependent());
2428
2429 // In C++11, evaluate the initializer to check whether it's a constant
2430 // expression.
Richard Smith2bf7fdb2013-01-02 11:42:31 +00002431 if (getASTContext().getLangOpts().CPlusPlus11) {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002432 SmallVector<PartialDiagnosticAt, 8> Notes;
Richard Smithd0b4dd62011-12-19 06:19:21 +00002433 evaluateValue(Notes);
2434 return Eval->IsICE;
2435 }
2436
2437 // It's an ICE whether or not the definition we found is
2438 // out-of-line. See DR 721 and the discussion in Clang PR
2439 // 6206 for details.
2440
2441 if (Eval->CheckingICE)
2442 return false;
2443 Eval->CheckingICE = true;
2444
2445 Eval->IsICE = Init->isIntegerConstantExpr(getASTContext());
2446 Eval->CheckingICE = false;
2447 Eval->CheckedICE = true;
2448 return Eval->IsICE;
2449}
2450
Richard Smithb2997f52019-05-21 20:10:50 +00002451bool VarDecl::isParameterPack() const {
2452 return isa<PackExpansionType>(getType());
2453}
2454
Richard Smith2195ec92017-04-21 01:15:13 +00002455template<typename DeclT>
2456static DeclT *getDefinitionOrSelf(DeclT *D) {
2457 assert(D);
2458 if (auto *Def = D->getDefinition())
2459 return Def;
2460 return D;
2461}
2462
Akira Hatanaka8e57b072018-10-01 21:51:28 +00002463bool VarDecl::isEscapingByref() const {
2464 return hasAttr<BlocksAttr>() && NonParmVarDeclBits.EscapingByref;
2465}
2466
2467bool VarDecl::isNonEscapingByref() const {
2468 return hasAttr<BlocksAttr>() && !NonParmVarDeclBits.EscapingByref;
2469}
2470
Richard Smithedbc6e92016-10-14 21:41:24 +00002471VarDecl *VarDecl::getTemplateInstantiationPattern() const {
Richard Smitha6b41d72019-05-03 23:51:38 +00002472 const VarDecl *VD = this;
Richard Smithedbc6e92016-10-14 21:41:24 +00002473
Richard Smitha6b41d72019-05-03 23:51:38 +00002474 // If this is an instantiated member, walk back to the template from which
2475 // it was instantiated.
2476 if (MemberSpecializationInfo *MSInfo = VD->getMemberSpecializationInfo()) {
Richard Smithedbc6e92016-10-14 21:41:24 +00002477 if (isTemplateInstantiation(MSInfo->getTemplateSpecializationKind())) {
Richard Smitha6b41d72019-05-03 23:51:38 +00002478 VD = VD->getInstantiatedFromStaticDataMember();
Richard Smithedbc6e92016-10-14 21:41:24 +00002479 while (auto *NewVD = VD->getInstantiatedFromStaticDataMember())
2480 VD = NewVD;
Richard Smithedbc6e92016-10-14 21:41:24 +00002481 }
2482 }
2483
Richard Smitha6b41d72019-05-03 23:51:38 +00002484 // If it's an instantiated variable template specialization, find the
2485 // template or partial specialization from which it was instantiated.
2486 if (auto *VDTemplSpec = dyn_cast<VarTemplateSpecializationDecl>(VD)) {
2487 if (isTemplateInstantiation(VDTemplSpec->getTemplateSpecializationKind())) {
2488 auto From = VDTemplSpec->getInstantiatedFrom();
2489 if (auto *VTD = From.dyn_cast<VarTemplateDecl *>()) {
2490 while (!VTD->isMemberSpecialization()) {
2491 auto *NewVTD = VTD->getInstantiatedFromMemberTemplate();
2492 if (!NewVTD)
2493 break;
2494 VTD = NewVTD;
2495 }
2496 return getDefinitionOrSelf(VTD->getTemplatedDecl());
2497 }
2498 if (auto *VTPSD =
2499 From.dyn_cast<VarTemplatePartialSpecializationDecl *>()) {
2500 while (!VTPSD->isMemberSpecialization()) {
2501 auto *NewVTPSD = VTPSD->getInstantiatedFromMember();
2502 if (!NewVTPSD)
2503 break;
2504 VTPSD = NewVTPSD;
2505 }
2506 return getDefinitionOrSelf<VarDecl>(VTPSD);
2507 }
2508 }
2509 }
2510
2511 // If this is the pattern of a variable template, find where it was
2512 // instantiated from. FIXME: Is this necessary?
2513 if (VarTemplateDecl *VarTemplate = VD->getDescribedVarTemplate()) {
2514 while (!VarTemplate->isMemberSpecialization()) {
2515 auto *NewVT = VarTemplate->getInstantiatedFromMemberTemplate();
2516 if (!NewVT)
Richard Smithedbc6e92016-10-14 21:41:24 +00002517 break;
Richard Smitha6b41d72019-05-03 23:51:38 +00002518 VarTemplate = NewVT;
Richard Smithedbc6e92016-10-14 21:41:24 +00002519 }
2520
Richard Smith2195ec92017-04-21 01:15:13 +00002521 return getDefinitionOrSelf(VarTemplate->getTemplatedDecl());
Richard Smithedbc6e92016-10-14 21:41:24 +00002522 }
Richard Smitha6b41d72019-05-03 23:51:38 +00002523
2524 if (VD == this)
2525 return nullptr;
2526 return getDefinitionOrSelf(const_cast<VarDecl*>(VD));
Richard Smithedbc6e92016-10-14 21:41:24 +00002527}
2528
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002529VarDecl *VarDecl::getInstantiatedFromStaticDataMember() const {
Douglas Gregor06db9f52009-10-12 20:18:28 +00002530 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
Douglas Gregor86d142a2009-10-08 07:24:58 +00002531 return cast<VarDecl>(MSI->getInstantiatedFrom());
Craig Topper36250ad2014-05-12 05:36:57 +00002532
2533 return nullptr;
Douglas Gregor86d142a2009-10-08 07:24:58 +00002534}
2535
Douglas Gregor3c74d412009-10-14 20:14:33 +00002536TemplateSpecializationKind VarDecl::getTemplateSpecializationKind() const {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002537 if (const auto *Spec = dyn_cast<VarTemplateSpecializationDecl>(this))
Larisse Voufo39a1e502013-08-06 01:03:05 +00002538 return Spec->getSpecializationKind();
2539
Sebastian Redl35351a92010-01-31 22:27:38 +00002540 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
Douglas Gregor86d142a2009-10-08 07:24:58 +00002541 return MSI->getTemplateSpecializationKind();
Richard Smith8809a0c2013-09-27 20:14:12 +00002542
Douglas Gregor86d142a2009-10-08 07:24:58 +00002543 return TSK_Undeclared;
2544}
2545
Richard Smitha6b41d72019-05-03 23:51:38 +00002546TemplateSpecializationKind
2547VarDecl::getTemplateSpecializationKindForInstantiation() const {
2548 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
2549 return MSI->getTemplateSpecializationKind();
2550
2551 if (const auto *Spec = dyn_cast<VarTemplateSpecializationDecl>(this))
2552 return Spec->getSpecializationKind();
2553
2554 return TSK_Undeclared;
2555}
2556
Richard Smith8809a0c2013-09-27 20:14:12 +00002557SourceLocation VarDecl::getPointOfInstantiation() const {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002558 if (const auto *Spec = dyn_cast<VarTemplateSpecializationDecl>(this))
Richard Smith8809a0c2013-09-27 20:14:12 +00002559 return Spec->getPointOfInstantiation();
2560
2561 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
2562 return MSI->getPointOfInstantiation();
2563
2564 return SourceLocation();
2565}
2566
Larisse Voufo39a1e502013-08-06 01:03:05 +00002567VarTemplateDecl *VarDecl::getDescribedVarTemplate() const {
2568 return getASTContext().getTemplateOrSpecializationInfo(this)
2569 .dyn_cast<VarTemplateDecl *>();
2570}
2571
2572void VarDecl::setDescribedVarTemplate(VarTemplateDecl *Template) {
2573 getASTContext().setTemplateOrSpecializationInfo(this, Template);
2574}
2575
Justin Lebar5489f852018-05-17 16:15:07 +00002576bool VarDecl::isKnownToBeDefined() const {
2577 const auto &LangOpts = getASTContext().getLangOpts();
2578 // In CUDA mode without relocatable device code, variables of form 'extern
2579 // __shared__ Foo foo[]' are pointers to the base of the GPU core's shared
2580 // memory pool. These are never undefined variables, even if they appear
2581 // inside of an anon namespace or static function.
2582 //
2583 // With CUDA relocatable device code enabled, these variables don't get
2584 // special handling; they're treated like regular extern variables.
Yaxun Liu97670892018-10-02 17:48:54 +00002585 if (LangOpts.CUDA && !LangOpts.GPURelocatableDeviceCode &&
Justin Lebar5489f852018-05-17 16:15:07 +00002586 hasExternalStorage() && hasAttr<CUDASharedAttr>() &&
2587 isa<IncompleteArrayType>(getType()))
2588 return true;
2589
2590 return hasDefinition();
2591}
2592
Erik Pilkington5a559e62018-08-21 17:24:06 +00002593bool VarDecl::isNoDestroy(const ASTContext &Ctx) const {
2594 return hasGlobalStorage() && (hasAttr<NoDestroyAttr>() ||
2595 (!Ctx.getLangOpts().RegisterStaticDestructors &&
2596 !hasAttr<AlwaysDestroyAttr>()));
2597}
2598
Richard Smith2b4fa532019-09-29 05:08:46 +00002599QualType::DestructionKind
2600VarDecl::needsDestruction(const ASTContext &Ctx) const {
2601 if (EvaluatedStmt *Eval = Init.dyn_cast<EvaluatedStmt *>())
2602 if (Eval->HasConstantDestruction)
2603 return QualType::DK_none;
2604
2605 if (isNoDestroy(Ctx))
2606 return QualType::DK_none;
2607
2608 return getType().isDestructedType();
2609}
2610
Douglas Gregor3cc3cde2009-10-14 21:29:40 +00002611MemberSpecializationInfo *VarDecl::getMemberSpecializationInfo() const {
Richard Smithb71782b2013-08-01 04:12:04 +00002612 if (isStaticDataMember())
Larisse Voufo39a1e502013-08-06 01:03:05 +00002613 // FIXME: Remove ?
2614 // return getASTContext().getInstantiatedFromStaticDataMember(this);
2615 return getASTContext().getTemplateOrSpecializationInfo(this)
2616 .dyn_cast<MemberSpecializationInfo *>();
Craig Topper36250ad2014-05-12 05:36:57 +00002617 return nullptr;
Douglas Gregor06db9f52009-10-12 20:18:28 +00002618}
2619
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00002620void VarDecl::setTemplateSpecializationKind(TemplateSpecializationKind TSK,
2621 SourceLocation PointOfInstantiation) {
Richard Smith8809a0c2013-09-27 20:14:12 +00002622 assert((isa<VarTemplateSpecializationDecl>(this) ||
2623 getMemberSpecializationInfo()) &&
2624 "not a variable or static data member template specialization");
2625
Larisse Voufo39a1e502013-08-06 01:03:05 +00002626 if (VarTemplateSpecializationDecl *Spec =
2627 dyn_cast<VarTemplateSpecializationDecl>(this)) {
2628 Spec->setSpecializationKind(TSK);
Richard Smitha6b41d72019-05-03 23:51:38 +00002629 if (TSK != TSK_ExplicitSpecialization &&
2630 PointOfInstantiation.isValid() &&
Richard Smith891fc7f2017-12-05 01:31:47 +00002631 Spec->getPointOfInstantiation().isInvalid()) {
Larisse Voufo39a1e502013-08-06 01:03:05 +00002632 Spec->setPointOfInstantiation(PointOfInstantiation);
Richard Smith891fc7f2017-12-05 01:31:47 +00002633 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
2634 L->InstantiationRequested(this);
2635 }
Richard Smitha6b41d72019-05-03 23:51:38 +00002636 } else if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo()) {
Larisse Voufo39a1e502013-08-06 01:03:05 +00002637 MSI->setTemplateSpecializationKind(TSK);
2638 if (TSK != TSK_ExplicitSpecialization && PointOfInstantiation.isValid() &&
Richard Smith891fc7f2017-12-05 01:31:47 +00002639 MSI->getPointOfInstantiation().isInvalid()) {
Larisse Voufo39a1e502013-08-06 01:03:05 +00002640 MSI->setPointOfInstantiation(PointOfInstantiation);
Richard Smith891fc7f2017-12-05 01:31:47 +00002641 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
2642 L->InstantiationRequested(this);
2643 }
Larisse Voufo39a1e502013-08-06 01:03:05 +00002644 }
Larisse Voufo39a1e502013-08-06 01:03:05 +00002645}
2646
2647void
2648VarDecl::setInstantiationOfStaticDataMember(VarDecl *VD,
2649 TemplateSpecializationKind TSK) {
2650 assert(getASTContext().getTemplateOrSpecializationInfo(this).isNull() &&
2651 "Previous template or instantiation?");
2652 getASTContext().setInstantiatedFromStaticDataMember(this, VD, TSK);
Douglas Gregora6ef8f02009-07-24 20:34:43 +00002653}
2654
Sebastian Redl833ef452010-01-26 22:01:41 +00002655//===----------------------------------------------------------------------===//
2656// ParmVarDecl Implementation
2657//===----------------------------------------------------------------------===//
Douglas Gregor0760fa12009-03-10 23:43:53 +00002658
Sebastian Redl833ef452010-01-26 22:01:41 +00002659ParmVarDecl *ParmVarDecl::Create(ASTContext &C, DeclContext *DC,
Abramo Bagnaradff19302011-03-08 08:55:46 +00002660 SourceLocation StartLoc,
2661 SourceLocation IdLoc, IdentifierInfo *Id,
Sebastian Redl833ef452010-01-26 22:01:41 +00002662 QualType T, TypeSourceInfo *TInfo,
Rafael Espindola6ae7e502013-04-03 19:27:57 +00002663 StorageClass S, Expr *DefArg) {
Richard Smith053f6c62014-05-16 23:01:30 +00002664 return new (C, DC) ParmVarDecl(ParmVar, C, DC, StartLoc, IdLoc, Id, T, TInfo,
Richard Smithf7981722013-11-22 09:01:48 +00002665 S, DefArg);
Douglas Gregor0760fa12009-03-10 23:43:53 +00002666}
2667
Reid Kleckner8a365022013-06-24 17:51:48 +00002668QualType ParmVarDecl::getOriginalType() const {
2669 TypeSourceInfo *TSI = getTypeSourceInfo();
2670 QualType T = TSI ? TSI->getType() : getType();
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002671 if (const auto *DT = dyn_cast<DecayedType>(T))
Reid Kleckner8a365022013-06-24 17:51:48 +00002672 return DT->getOriginalType();
2673 return T;
2674}
2675
Douglas Gregor72172e92012-01-05 21:55:30 +00002676ParmVarDecl *ParmVarDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00002677 return new (C, ID)
2678 ParmVarDecl(ParmVar, C, nullptr, SourceLocation(), SourceLocation(),
2679 nullptr, QualType(), nullptr, SC_None, nullptr);
Douglas Gregor72172e92012-01-05 21:55:30 +00002680}
2681
Argyrios Kyrtzidis4c6efa622011-07-30 17:23:26 +00002682SourceRange ParmVarDecl::getSourceRange() const {
2683 if (!hasInheritedDefaultArg()) {
2684 SourceRange ArgRange = getDefaultArgRange();
2685 if (ArgRange.isValid())
2686 return SourceRange(getOuterLocStart(), ArgRange.getEnd());
2687 }
2688
Argyrios Kyrtzidisa0772792013-04-17 01:56:48 +00002689 // DeclaratorDecl considers the range of postfix types as overlapping with the
2690 // declaration name, but this is not the case with parameters in ObjC methods.
2691 if (isa<ObjCMethodDecl>(getDeclContext()))
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002692 return SourceRange(DeclaratorDecl::getBeginLoc(), getLocation());
Argyrios Kyrtzidisa0772792013-04-17 01:56:48 +00002693
Argyrios Kyrtzidis4c6efa622011-07-30 17:23:26 +00002694 return DeclaratorDecl::getSourceRange();
2695}
2696
Sebastian Redl833ef452010-01-26 22:01:41 +00002697Expr *ParmVarDecl::getDefaultArg() {
2698 assert(!hasUnparsedDefaultArg() && "Default argument is not yet parsed!");
2699 assert(!hasUninstantiatedDefaultArg() &&
2700 "Default argument is not yet instantiated!");
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002701
Sebastian Redl833ef452010-01-26 22:01:41 +00002702 Expr *Arg = getInit();
Bill Wendling7c44da22018-10-31 03:48:47 +00002703 if (auto *E = dyn_cast_or_null<FullExpr>(Arg))
Sebastian Redl833ef452010-01-26 22:01:41 +00002704 return E->getSubExpr();
Douglas Gregor0760fa12009-03-10 23:43:53 +00002705
Sebastian Redl833ef452010-01-26 22:01:41 +00002706 return Arg;
2707}
2708
Chandler Carruth813faed2015-12-30 02:51:00 +00002709void ParmVarDecl::setDefaultArg(Expr *defarg) {
2710 ParmVarDeclBits.DefaultArgKind = DAK_Normal;
2711 Init = defarg;
2712}
Sebastian Redl833ef452010-01-26 22:01:41 +00002713
Chandler Carruth813faed2015-12-30 02:51:00 +00002714SourceRange ParmVarDecl::getDefaultArgRange() const {
2715 switch (ParmVarDeclBits.DefaultArgKind) {
2716 case DAK_None:
2717 case DAK_Unparsed:
2718 // Nothing we can do here.
2719 return SourceRange();
2720
2721 case DAK_Uninstantiated:
Sebastian Redl833ef452010-01-26 22:01:41 +00002722 return getUninstantiatedDefaultArg()->getSourceRange();
2723
Chandler Carruth813faed2015-12-30 02:51:00 +00002724 case DAK_Normal:
2725 if (const Expr *E = getInit())
2726 return E->getSourceRange();
2727
2728 // Missing an actual expression, may be invalid.
2729 return SourceRange();
2730 }
2731 llvm_unreachable("Invalid default argument kind.");
2732}
2733
2734void ParmVarDecl::setUninstantiatedDefaultArg(Expr *arg) {
2735 ParmVarDeclBits.DefaultArgKind = DAK_Uninstantiated;
2736 Init = arg;
2737}
2738
2739Expr *ParmVarDecl::getUninstantiatedDefaultArg() {
2740 assert(hasUninstantiatedDefaultArg() &&
2741 "Wrong kind of initialization expression!");
2742 return cast_or_null<Expr>(Init.get<Stmt *>());
2743}
2744
2745bool ParmVarDecl::hasDefaultArg() const {
2746 // FIXME: We should just return false for DAK_None here once callers are
2747 // prepared for the case that we encountered an invalid default argument and
2748 // were unable to even build an invalid expression.
2749 return hasUnparsedDefaultArg() || hasUninstantiatedDefaultArg() ||
2750 !Init.isNull();
Argyrios Kyrtzidis02dd4f92009-07-05 22:21:56 +00002751}
2752
Ted Kremenek540017e2011-10-06 05:00:56 +00002753void ParmVarDecl::setParameterIndexLarge(unsigned parameterIndex) {
2754 getASTContext().setParameterIndex(this, parameterIndex);
2755 ParmVarDeclBits.ParameterIndex = ParameterIndexSentinel;
2756}
2757
2758unsigned ParmVarDecl::getParameterIndexLarge() const {
2759 return getASTContext().getParameterIndex(this);
2760}
2761
Nuno Lopes394ec982008-12-17 23:39:55 +00002762//===----------------------------------------------------------------------===//
Chris Lattner59a25942008-03-31 00:36:02 +00002763// FunctionDecl Implementation
2764//===----------------------------------------------------------------------===//
2765
Erich Keane9c665062018-08-01 21:02:40 +00002766FunctionDecl::FunctionDecl(Kind DK, ASTContext &C, DeclContext *DC,
2767 SourceLocation StartLoc,
2768 const DeclarationNameInfo &NameInfo, QualType T,
2769 TypeSourceInfo *TInfo, StorageClass S,
Gauthier Harnisch796ed032019-06-14 08:56:20 +00002770 bool isInlineSpecified,
Saar Razb65b1f32020-01-09 15:07:51 +02002771 ConstexprSpecKind ConstexprKind,
2772 Expr *TrailingRequiresClause)
Erich Keane9c665062018-08-01 21:02:40 +00002773 : DeclaratorDecl(DK, DC, NameInfo.getLoc(), NameInfo.getName(), T, TInfo,
2774 StartLoc),
Richard Smith848934c2019-12-05 13:37:35 -08002775 DeclContext(DK), redeclarable_base(C), Body(), ODRHash(0),
Erich Keane9c665062018-08-01 21:02:40 +00002776 EndRangeLoc(NameInfo.getEndLoc()), DNLoc(NameInfo.getInfo()) {
Jonas Devlieghere64a26302018-11-11 00:56:15 +00002777 assert(T.isNull() || T->isFunctionType());
Bruno Ricci0b639da2018-12-03 13:04:10 +00002778 FunctionDeclBits.SClass = S;
2779 FunctionDeclBits.IsInline = isInlineSpecified;
2780 FunctionDeclBits.IsInlineSpecified = isInlineSpecified;
Bruno Ricci0b639da2018-12-03 13:04:10 +00002781 FunctionDeclBits.IsVirtualAsWritten = false;
2782 FunctionDeclBits.IsPure = false;
2783 FunctionDeclBits.HasInheritedPrototype = false;
2784 FunctionDeclBits.HasWrittenPrototype = true;
2785 FunctionDeclBits.IsDeleted = false;
2786 FunctionDeclBits.IsTrivial = false;
2787 FunctionDeclBits.IsTrivialForCall = false;
2788 FunctionDeclBits.IsDefaulted = false;
2789 FunctionDeclBits.IsExplicitlyDefaulted = false;
Richard Smith848934c2019-12-05 13:37:35 -08002790 FunctionDeclBits.HasDefaultedFunctionInfo = false;
Bruno Ricci0b639da2018-12-03 13:04:10 +00002791 FunctionDeclBits.HasImplicitReturnZero = false;
2792 FunctionDeclBits.IsLateTemplateParsed = false;
Gauthier Harnisch796ed032019-06-14 08:56:20 +00002793 FunctionDeclBits.ConstexprKind = ConstexprKind;
Bruno Ricci0b639da2018-12-03 13:04:10 +00002794 FunctionDeclBits.InstantiationIsPending = false;
2795 FunctionDeclBits.UsesSEHTry = false;
Melanie Blower7f9b5132019-12-04 12:23:46 -08002796 FunctionDeclBits.UsesFPIntrin = false;
Bruno Ricci0b639da2018-12-03 13:04:10 +00002797 FunctionDeclBits.HasSkippedBody = false;
2798 FunctionDeclBits.WillHaveBody = false;
2799 FunctionDeclBits.IsMultiVersion = false;
2800 FunctionDeclBits.IsCopyDeductionCandidate = false;
2801 FunctionDeclBits.HasODRHash = false;
Saar Razb65b1f32020-01-09 15:07:51 +02002802 if (TrailingRequiresClause)
2803 setTrailingRequiresClause(TrailingRequiresClause);
Erich Keane9c665062018-08-01 21:02:40 +00002804}
2805
Benjamin Kramer9170e912013-02-22 15:46:01 +00002806void FunctionDecl::getNameForDiagnostic(
2807 raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const {
2808 NamedDecl::getNameForDiagnostic(OS, Policy, Qualified);
Douglas Gregorb11aad82011-02-19 18:51:44 +00002809 const TemplateArgumentList *TemplateArgs = getTemplateSpecializationArgs();
2810 if (TemplateArgs)
Serge Pavlov03e672c2017-11-28 16:14:14 +00002811 printTemplateArgumentList(OS, TemplateArgs->asArray(), Policy);
Douglas Gregorb11aad82011-02-19 18:51:44 +00002812}
2813
Ted Kremenek186a0742010-04-29 16:49:01 +00002814bool FunctionDecl::isVariadic() const {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002815 if (const auto *FT = getType()->getAs<FunctionProtoType>())
Ted Kremenek186a0742010-04-29 16:49:01 +00002816 return FT->isVariadic();
2817 return false;
2818}
2819
Richard Smith848934c2019-12-05 13:37:35 -08002820FunctionDecl::DefaultedFunctionInfo *
2821FunctionDecl::DefaultedFunctionInfo::Create(ASTContext &Context,
2822 ArrayRef<DeclAccessPair> Lookups) {
2823 DefaultedFunctionInfo *Info = new (Context.Allocate(
2824 totalSizeToAlloc<DeclAccessPair>(Lookups.size()),
2825 std::max(alignof(DefaultedFunctionInfo), alignof(DeclAccessPair))))
2826 DefaultedFunctionInfo;
2827 Info->NumLookups = Lookups.size();
2828 std::uninitialized_copy(Lookups.begin(), Lookups.end(),
2829 Info->getTrailingObjects<DeclAccessPair>());
2830 return Info;
2831}
2832
2833void FunctionDecl::setDefaultedFunctionInfo(DefaultedFunctionInfo *Info) {
2834 assert(!FunctionDeclBits.HasDefaultedFunctionInfo && "already have this");
2835 assert(!Body && "can't replace function body with defaulted function info");
2836
2837 FunctionDeclBits.HasDefaultedFunctionInfo = true;
2838 DefaultedInfo = Info;
2839}
2840
2841FunctionDecl::DefaultedFunctionInfo *
2842FunctionDecl::getDefaultedFunctionInfo() const {
2843 return FunctionDeclBits.HasDefaultedFunctionInfo ? DefaultedInfo : nullptr;
2844}
2845
Argyrios Kyrtzidis36ea3222010-07-07 11:31:19 +00002846bool FunctionDecl::hasBody(const FunctionDecl *&Definition) const {
Aaron Ballman86c93902014-03-06 23:45:36 +00002847 for (auto I : redecls()) {
Serge Pavlov9a618e12017-02-15 12:30:35 +00002848 if (I->doesThisDeclarationHaveABody()) {
Aaron Ballman86c93902014-03-06 23:45:36 +00002849 Definition = I;
Argyrios Kyrtzidis36ea3222010-07-07 11:31:19 +00002850 return true;
2851 }
2852 }
2853
2854 return false;
2855}
2856
Richard Smith848934c2019-12-05 13:37:35 -08002857bool FunctionDecl::hasTrivialBody() const {
Anders Carlsson9bd7d162011-05-14 23:26:09 +00002858 Stmt *S = getBody();
2859 if (!S) {
2860 // Since we don't have a body for this function, we don't know if it's
2861 // trivial or not.
2862 return false;
2863 }
2864
2865 if (isa<CompoundStmt>(S) && cast<CompoundStmt>(S)->body_empty())
2866 return true;
2867 return false;
2868}
2869
Alexis Hunt4a8ea102011-05-06 20:44:56 +00002870bool FunctionDecl::isDefined(const FunctionDecl *&Definition) const {
Aaron Ballman86c93902014-03-06 23:45:36 +00002871 for (auto I : redecls()) {
Serge Pavlov10673c92017-06-04 12:53:12 +00002872 if (I->isThisDeclarationADefinition()) {
2873 Definition = I;
Alexis Hunt4a8ea102011-05-06 20:44:56 +00002874 return true;
2875 }
2876 }
2877
2878 return false;
2879}
2880
Argyrios Kyrtzidisddcd1322009-06-30 02:35:26 +00002881Stmt *FunctionDecl::getBody(const FunctionDecl *&Definition) const {
Rafael Espindola44503012013-10-19 01:37:17 +00002882 if (!hasBody(Definition))
Craig Topper36250ad2014-05-12 05:36:57 +00002883 return nullptr;
Rafael Espindola44503012013-10-19 01:37:17 +00002884
Richard Smith848934c2019-12-05 13:37:35 -08002885 assert(!Definition->FunctionDeclBits.HasDefaultedFunctionInfo &&
2886 "definition should not have a body");
Rafael Espindola44503012013-10-19 01:37:17 +00002887 if (Definition->Body)
2888 return Definition->Body.get(getASTContext().getExternalSource());
Douglas Gregor89f238c2008-04-21 02:02:58 +00002889
Craig Topper36250ad2014-05-12 05:36:57 +00002890 return nullptr;
Chris Lattnerc5cdf4d2007-01-21 07:42:07 +00002891}
2892
Argyrios Kyrtzidisa3aeb5a2009-06-20 08:09:14 +00002893void FunctionDecl::setBody(Stmt *B) {
Richard Smith848934c2019-12-05 13:37:35 -08002894 FunctionDeclBits.HasDefaultedFunctionInfo = false;
2895 Body = LazyDeclStmtPtr(B);
Douglas Gregor027ba502010-12-06 17:49:01 +00002896 if (B)
Stephen Kelly1c301dc2018-08-09 21:09:38 +00002897 EndRangeLoc = B->getEndLoc();
Argyrios Kyrtzidisa3aeb5a2009-06-20 08:09:14 +00002898}
2899
Douglas Gregor7d9120c2010-09-28 21:55:22 +00002900void FunctionDecl::setPure(bool P) {
Erich Keane9c665062018-08-01 21:02:40 +00002901 FunctionDeclBits.IsPure = P;
Douglas Gregor7d9120c2010-09-28 21:55:22 +00002902 if (P)
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002903 if (auto *Parent = dyn_cast<CXXRecordDecl>(getDeclContext()))
Douglas Gregor7d9120c2010-09-28 21:55:22 +00002904 Parent->markedVirtualFunctionPure();
2905}
2906
Richard Smith8d0dc312013-07-21 23:12:18 +00002907template<std::size_t Len>
2908static bool isNamed(const NamedDecl *ND, const char (&Str)[Len]) {
2909 IdentifierInfo *II = ND->getIdentifier();
2910 return II && II->isStr(Str);
2911}
2912
Douglas Gregor16618f22009-09-12 00:17:51 +00002913bool FunctionDecl::isMain() const {
John McCall53ffd372011-05-15 17:49:20 +00002914 const TranslationUnitDecl *tunit =
2915 dyn_cast<TranslationUnitDecl>(getDeclContext()->getRedeclContext());
2916 return tunit &&
David Blaikiebbafb8a2012-03-11 07:00:24 +00002917 !tunit->getASTContext().getLangOpts().Freestanding &&
Richard Smith8d0dc312013-07-21 23:12:18 +00002918 isNamed(this, "main");
John McCall53ffd372011-05-15 17:49:20 +00002919}
2920
David Majnemerc729b0b2013-09-16 22:44:20 +00002921bool FunctionDecl::isMSVCRTEntryPoint() const {
2922 const TranslationUnitDecl *TUnit =
2923 dyn_cast<TranslationUnitDecl>(getDeclContext()->getRedeclContext());
2924 if (!TUnit)
2925 return false;
2926
2927 // Even though we aren't really targeting MSVCRT if we are freestanding,
2928 // semantic analysis for these functions remains the same.
2929
2930 // MSVCRT entry points only exist on MSVCRT targets.
2931 if (!TUnit->getASTContext().getTargetInfo().getTriple().isOSMSVCRT())
2932 return false;
2933
2934 // Nameless functions like constructors cannot be entry points.
2935 if (!getIdentifier())
2936 return false;
2937
2938 return llvm::StringSwitch<bool>(getName())
2939 .Cases("main", // an ANSI console app
2940 "wmain", // a Unicode console App
2941 "WinMain", // an ANSI GUI app
2942 "wWinMain", // a Unicode GUI app
2943 "DllMain", // a DLL
2944 true)
2945 .Default(false);
2946}
2947
John McCall53ffd372011-05-15 17:49:20 +00002948bool FunctionDecl::isReservedGlobalPlacementOperator() const {
2949 assert(getDeclName().getNameKind() == DeclarationName::CXXOperatorName);
2950 assert(getDeclName().getCXXOverloadedOperator() == OO_New ||
2951 getDeclName().getCXXOverloadedOperator() == OO_Delete ||
2952 getDeclName().getCXXOverloadedOperator() == OO_Array_New ||
2953 getDeclName().getCXXOverloadedOperator() == OO_Array_Delete);
2954
Richard Smithf6004412014-01-19 23:25:37 +00002955 if (!getDeclContext()->getRedeclContext()->isTranslationUnit())
2956 return false;
John McCall53ffd372011-05-15 17:49:20 +00002957
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002958 const auto *proto = getType()->castAs<FunctionProtoType>();
Alp Toker9cacbab2014-01-20 20:26:09 +00002959 if (proto->getNumParams() != 2 || proto->isVariadic())
2960 return false;
John McCall53ffd372011-05-15 17:49:20 +00002961
2962 ASTContext &Context =
2963 cast<TranslationUnitDecl>(getDeclContext()->getRedeclContext())
2964 ->getASTContext();
2965
2966 // The result type and first argument type are constant across all
2967 // these operators. The second argument must be exactly void*.
Alp Toker9cacbab2014-01-20 20:26:09 +00002968 return (proto->getParamType(1).getCanonicalType() == Context.VoidPtrTy);
Douglas Gregore62c0a42009-02-24 01:23:02 +00002969}
2970
Roman Lebedev3dd5a292020-02-26 01:37:17 +03002971bool FunctionDecl::isReplaceableGlobalAllocationFunction(
2972 Optional<unsigned> *AlignmentParam, bool *IsNothrow) const {
Richard Smith8d0dc312013-07-21 23:12:18 +00002973 if (getDeclName().getNameKind() != DeclarationName::CXXOperatorName)
2974 return false;
2975 if (getDeclName().getCXXOverloadedOperator() != OO_New &&
2976 getDeclName().getCXXOverloadedOperator() != OO_Delete &&
2977 getDeclName().getCXXOverloadedOperator() != OO_Array_New &&
2978 getDeclName().getCXXOverloadedOperator() != OO_Array_Delete)
2979 return false;
2980
2981 if (isa<CXXRecordDecl>(getDeclContext()))
2982 return false;
Richard Smithf6004412014-01-19 23:25:37 +00002983
2984 // This can only fail for an invalid 'operator new' declaration.
2985 if (!getDeclContext()->getRedeclContext()->isTranslationUnit())
2986 return false;
Richard Smith8d0dc312013-07-21 23:12:18 +00002987
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00002988 const auto *FPT = getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00002989 if (FPT->getNumParams() == 0 || FPT->getNumParams() > 3 || FPT->isVariadic())
Richard Smith8d0dc312013-07-21 23:12:18 +00002990 return false;
2991
2992 // If this is a single-parameter function, it must be a replaceable global
2993 // allocation or deallocation function.
Alp Toker9cacbab2014-01-20 20:26:09 +00002994 if (FPT->getNumParams() == 1)
Richard Smith8d0dc312013-07-21 23:12:18 +00002995 return true;
2996
Richard Smithb2f0f052016-10-10 18:54:32 +00002997 unsigned Params = 1;
2998 QualType Ty = FPT->getParamType(Params);
Richard Smith1cdec012013-09-29 04:40:38 +00002999 ASTContext &Ctx = getASTContext();
Richard Smithb2f0f052016-10-10 18:54:32 +00003000
3001 auto Consume = [&] {
3002 ++Params;
3003 Ty = Params < FPT->getNumParams() ? FPT->getParamType(Params) : QualType();
3004 };
3005
3006 // In C++14, the next parameter can be a 'std::size_t' for sized delete.
3007 bool IsSizedDelete = false;
Richard Smithb47c36f2013-11-05 09:12:18 +00003008 if (Ctx.getLangOpts().SizedDeallocation &&
Richard Smithb2f0f052016-10-10 18:54:32 +00003009 (getDeclName().getCXXOverloadedOperator() == OO_Delete ||
3010 getDeclName().getCXXOverloadedOperator() == OO_Array_Delete) &&
3011 Ctx.hasSameType(Ty, Ctx.getSizeType())) {
3012 IsSizedDelete = true;
3013 Consume();
3014 }
3015
3016 // In C++17, the next parameter can be a 'std::align_val_t' for aligned
3017 // new/delete.
Akira Hatanakacae83f72017-06-29 18:48:40 +00003018 if (Ctx.getLangOpts().AlignedAllocation && !Ty.isNull() && Ty->isAlignValT()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00003019 Consume();
Roman Lebedev3dd5a292020-02-26 01:37:17 +03003020 if (AlignmentParam)
3021 *AlignmentParam = Params;
Akira Hatanakacae83f72017-06-29 18:48:40 +00003022 }
Richard Smithb2f0f052016-10-10 18:54:32 +00003023
3024 // Finally, if this is not a sized delete, the final parameter can
3025 // be a 'const std::nothrow_t&'.
3026 if (!IsSizedDelete && !Ty.isNull() && Ty->isReferenceType()) {
3027 Ty = Ty->getPointeeType();
3028 if (Ty.getCVRQualifiers() != Qualifiers::Const)
3029 return false;
Roman Lebedev3dd5a292020-02-26 01:37:17 +03003030 if (Ty->isNothrowT()) {
3031 if (IsNothrow)
3032 *IsNothrow = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00003033 Consume();
Roman Lebedev3dd5a292020-02-26 01:37:17 +03003034 }
Richard Smithb2f0f052016-10-10 18:54:32 +00003035 }
3036
3037 return Params == FPT->getNumParams();
Richard Smith8d0dc312013-07-21 23:12:18 +00003038}
3039
serge-sans-pailled437fba2020-01-16 19:54:38 +01003040bool FunctionDecl::isInlineBuiltinDeclaration() const {
3041 if (!getBuiltinID())
3042 return false;
3043
3044 const FunctionDecl *Definition;
3045 return hasBody(Definition) && Definition->isInlineSpecified();
3046}
3047
Richard Smith5b349582017-10-13 01:55:36 +00003048bool FunctionDecl::isDestroyingOperatorDelete() const {
3049 // C++ P0722:
3050 // Within a class C, a single object deallocation function with signature
3051 // (T, std::destroying_delete_t, <more params>)
3052 // is a destroying operator delete.
3053 if (!isa<CXXMethodDecl>(this) || getOverloadedOperator() != OO_Delete ||
3054 getNumParams() < 2)
3055 return false;
3056
3057 auto *RD = getParamDecl(1)->getType()->getAsCXXRecordDecl();
3058 return RD && RD->isInStdNamespace() && RD->getIdentifier() &&
3059 RD->getIdentifier()->isStr("destroying_delete_t");
3060}
3061
Rafael Espindolaf4187652013-02-14 01:18:37 +00003062LanguageLinkage FunctionDecl::getLanguageLinkage() const {
Alp Toker84212df2014-05-31 06:11:02 +00003063 return getDeclLanguageLinkage(*this);
Rafael Espindola576127d2012-12-28 14:21:58 +00003064}
3065
Rafael Espindola0e0d0092013-03-14 03:07:35 +00003066bool FunctionDecl::isExternC() const {
Alp Toker84212df2014-05-31 06:11:02 +00003067 return isDeclExternC(*this);
Rafael Espindola0e0d0092013-03-14 03:07:35 +00003068}
3069
Rafael Espindola593537a2013-05-05 20:15:21 +00003070bool FunctionDecl::isInExternCContext() const {
Anastasia Stulovad6865b72019-05-07 14:22:34 +00003071 if (hasAttr<OpenCLKernelAttr>())
3072 return true;
Serge Pavlov3cb80222013-11-14 02:13:03 +00003073 return getLexicalDeclContext()->isExternCContext();
Rafael Espindola593537a2013-05-05 20:15:21 +00003074}
3075
3076bool FunctionDecl::isInExternCXXContext() const {
Serge Pavlov3cb80222013-11-14 02:13:03 +00003077 return getLexicalDeclContext()->isExternCXXContext();
Rafael Espindola593537a2013-05-05 20:15:21 +00003078}
3079
Douglas Gregorf1b876d2009-03-31 16:35:03 +00003080bool FunctionDecl::isGlobal() const {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00003081 if (const auto *Method = dyn_cast<CXXMethodDecl>(this))
Douglas Gregorf1b876d2009-03-31 16:35:03 +00003082 return Method->isStatic();
3083
Rafael Espindola6ae7e502013-04-03 19:27:57 +00003084 if (getCanonicalDecl()->getStorageClass() == SC_Static)
Douglas Gregorf1b876d2009-03-31 16:35:03 +00003085 return false;
3086
Mike Stump11289f42009-09-09 15:08:12 +00003087 for (const DeclContext *DC = getDeclContext();
Douglas Gregorf1b876d2009-03-31 16:35:03 +00003088 DC->isNamespace();
3089 DC = DC->getParent()) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00003090 if (const auto *Namespace = cast<NamespaceDecl>(DC)) {
Douglas Gregorf1b876d2009-03-31 16:35:03 +00003091 if (!Namespace->getDeclName())
3092 return false;
3093 break;
3094 }
3095 }
3096
3097 return true;
3098}
3099
Richard Smith10876ef2013-01-17 01:30:42 +00003100bool FunctionDecl::isNoReturn() const {
Adrian Prantl721c7cb2016-08-17 16:42:15 +00003101 if (hasAttr<NoReturnAttr>() || hasAttr<CXX11NoReturnAttr>() ||
3102 hasAttr<C11NoReturnAttr>())
3103 return true;
3104
3105 if (auto *FnTy = getType()->getAs<FunctionType>())
3106 return FnTy->getNoReturnAttr();
3107
3108 return false;
Richard Smith10876ef2013-01-17 01:30:42 +00003109}
3110
Erich Keane5c0d1922018-11-28 18:34:14 +00003111
3112MultiVersionKind FunctionDecl::getMultiVersionKind() const {
3113 if (hasAttr<TargetAttr>())
3114 return MultiVersionKind::Target;
3115 if (hasAttr<CPUDispatchAttr>())
3116 return MultiVersionKind::CPUDispatch;
3117 if (hasAttr<CPUSpecificAttr>())
3118 return MultiVersionKind::CPUSpecific;
3119 return MultiVersionKind::None;
3120}
3121
Erich Keane3efe0022018-07-20 14:13:28 +00003122bool FunctionDecl::isCPUDispatchMultiVersion() const {
3123 return isMultiVersion() && hasAttr<CPUDispatchAttr>();
3124}
3125
3126bool FunctionDecl::isCPUSpecificMultiVersion() const {
3127 return isMultiVersion() && hasAttr<CPUSpecificAttr>();
3128}
3129
Erich Keane19a8adc2018-10-25 18:57:19 +00003130bool FunctionDecl::isTargetMultiVersion() const {
3131 return isMultiVersion() && hasAttr<TargetAttr>();
3132}
3133
Sebastian Redl833ef452010-01-26 22:01:41 +00003134void
3135FunctionDecl::setPreviousDeclaration(FunctionDecl *PrevDecl) {
Rafael Espindola8db352d2013-10-17 15:37:26 +00003136 redeclarable_base::setPreviousDecl(PrevDecl);
Sebastian Redl833ef452010-01-26 22:01:41 +00003137
3138 if (FunctionTemplateDecl *FunTmpl = getDescribedFunctionTemplate()) {
3139 FunctionTemplateDecl *PrevFunTmpl
Craig Topper36250ad2014-05-12 05:36:57 +00003140 = PrevDecl? PrevDecl->getDescribedFunctionTemplate() : nullptr;
Sebastian Redl833ef452010-01-26 22:01:41 +00003141 assert((!PrevDecl || PrevFunTmpl) && "Function/function template mismatch");
Rafael Espindola8db352d2013-10-17 15:37:26 +00003142 FunTmpl->setPreviousDecl(PrevFunTmpl);
Sebastian Redl833ef452010-01-26 22:01:41 +00003143 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003144
Erich Keane9c665062018-08-01 21:02:40 +00003145 if (PrevDecl && PrevDecl->isInlined())
3146 setImplicitlyInline(true);
Sebastian Redl833ef452010-01-26 22:01:41 +00003147}
3148
Rafael Espindola8db352d2013-10-17 15:37:26 +00003149FunctionDecl *FunctionDecl::getCanonicalDecl() { return getFirstDecl(); }
Sebastian Redl833ef452010-01-26 22:01:41 +00003150
Erik Pilkingtonb6e16ea2019-03-18 19:23:45 +00003151/// Returns a value indicating whether this function corresponds to a builtin
3152/// function.
Douglas Gregorb9063fc2009-02-13 23:20:09 +00003153///
Erik Pilkingtonb6e16ea2019-03-18 19:23:45 +00003154/// The function corresponds to a built-in function if it is declared at
3155/// translation scope or within an extern "C" block and its name matches with
3156/// the name of a builtin. The returned value will be 0 for functions that do
3157/// not correspond to a builtin, a value of type \c Builtin::ID if in the
3158/// target-independent range \c [1,Builtin::First), or a target-specific builtin
3159/// value.
3160///
3161/// \param ConsiderWrapperFunctions If true, we should consider wrapper
3162/// functions as their wrapped builtins. This shouldn't be done in general, but
3163/// it's useful in Sema to diagnose calls to wrappers based on their semantics.
3164unsigned FunctionDecl::getBuiltinID(bool ConsiderWrapperFunctions) const {
Simon Tatham7c11da02019-09-02 15:35:09 +01003165 unsigned BuiltinID;
Douglas Gregore711f702009-02-14 18:57:46 +00003166
Mikhail Maltsev47edf5ba2020-03-10 14:01:42 +00003167 if (const auto *ABAA = getAttr<ArmBuiltinAliasAttr>()) {
3168 BuiltinID = ABAA->getBuiltinName()->getBuiltinID();
Simon Tatham7c11da02019-09-02 15:35:09 +01003169 } else {
3170 if (!getIdentifier())
3171 return 0;
3172
3173 BuiltinID = getIdentifier()->getBuiltinID();
3174 }
3175
Daniel Dunbar304314d2012-03-06 23:52:37 +00003176 if (!BuiltinID)
3177 return 0;
3178
3179 ASTContext &Context = getASTContext();
Warren Hunt445d83e2013-11-01 23:46:51 +00003180 if (Context.getLangOpts().CPlusPlus) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00003181 const auto *LinkageDecl =
3182 dyn_cast<LinkageSpecDecl>(getFirstDecl()->getDeclContext());
Warren Hunt445d83e2013-11-01 23:46:51 +00003183 // In C++, the first declaration of a builtin is always inside an implicit
3184 // extern "C".
3185 // FIXME: A recognised library function may not be directly in an extern "C"
3186 // declaration, for instance "extern "C" { namespace std { decl } }".
David Majnemerba3e5ec2015-03-13 18:26:17 +00003187 if (!LinkageDecl) {
3188 if (BuiltinID == Builtin::BI__GetExceptionInfo &&
David Majnemer145abde2016-01-26 01:12:17 +00003189 Context.getTargetInfo().getCXXABI().isMicrosoft())
David Majnemerba3e5ec2015-03-13 18:26:17 +00003190 return Builtin::BI__GetExceptionInfo;
3191 return 0;
3192 }
3193 if (LinkageDecl->getLanguage() != LinkageSpecDecl::lang_c)
Warren Hunt445d83e2013-11-01 23:46:51 +00003194 return 0;
3195 }
3196
3197 // If the function is marked "overloadable", it has a different mangled name
3198 // and is not the C library function.
Simon Tatham7c11da02019-09-02 15:35:09 +01003199 if (!ConsiderWrapperFunctions && hasAttr<OverloadableAttr>() &&
Mikhail Maltsev47edf5ba2020-03-10 14:01:42 +00003200 !hasAttr<ArmBuiltinAliasAttr>())
Warren Hunt445d83e2013-11-01 23:46:51 +00003201 return 0;
3202
Douglas Gregore711f702009-02-14 18:57:46 +00003203 if (!Context.BuiltinInfo.isPredefinedLibFunction(BuiltinID))
3204 return BuiltinID;
3205
3206 // This function has the name of a known C library
3207 // function. Determine whether it actually refers to the C library
3208 // function or whether it just has the same name.
3209
Douglas Gregora908e7f2009-02-17 03:23:10 +00003210 // If this is a static function, it's not a builtin.
Erik Pilkingtonb6e16ea2019-03-18 19:23:45 +00003211 if (!ConsiderWrapperFunctions && getStorageClass() == SC_Static)
Douglas Gregora908e7f2009-02-17 03:23:10 +00003212 return 0;
3213
Anastasia Stulova1202de32016-02-12 12:07:04 +00003214 // OpenCL v1.2 s6.9.f - The library functions defined in
3215 // the C99 standard headers are not available.
3216 if (Context.getLangOpts().OpenCL &&
3217 Context.BuiltinInfo.isPredefinedLibFunction(BuiltinID))
3218 return 0;
3219
Artem Belevich5ecdb942018-01-23 19:08:18 +00003220 // CUDA does not have device-side standard library. printf and malloc are the
3221 // only special cases that are supported by device-side runtime.
3222 if (Context.getLangOpts().CUDA && hasAttr<CUDADeviceAttr>() &&
3223 !hasAttr<CUDAHostAttr>() &&
3224 !(BuiltinID == Builtin::BIprintf || BuiltinID == Builtin::BImalloc))
3225 return 0;
3226
Saiyedul Islam602d9b02020-05-14 06:09:04 +00003227 // As AMDGCN implementation of OpenMP does not have a device-side standard
3228 // library, none of the predefined library functions except printf and malloc
3229 // should be treated as a builtin i.e. 0 should be returned for them.
3230 if (Context.getTargetInfo().getTriple().isAMDGCN() &&
3231 Context.getLangOpts().OpenMPIsDevice &&
3232 Context.BuiltinInfo.isPredefinedLibFunction(BuiltinID) &&
3233 !(BuiltinID == Builtin::BIprintf || BuiltinID == Builtin::BImalloc))
3234 return 0;
3235
Warren Hunt445d83e2013-11-01 23:46:51 +00003236 return BuiltinID;
Douglas Gregorb9063fc2009-02-13 23:20:09 +00003237}
3238
Chris Lattner47c0d002009-04-25 06:03:53 +00003239/// getNumParams - Return the number of parameters this function must have
Bob Wilsonb39017a2011-01-10 18:23:55 +00003240/// based on its FunctionType. This is the length of the ParamInfo array
Chris Lattner47c0d002009-04-25 06:03:53 +00003241/// after it has been created.
3242unsigned FunctionDecl::getNumParams() const {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00003243 const auto *FPT = getType()->getAs<FunctionProtoType>();
Alp Toker9cacbab2014-01-20 20:26:09 +00003244 return FPT ? FPT->getNumParams() : 0;
Chris Lattnerc5cdf4d2007-01-21 07:42:07 +00003245}
3246
Argyrios Kyrtzidisf4bc0d82010-09-08 19:31:22 +00003247void FunctionDecl::setParams(ASTContext &C,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003248 ArrayRef<ParmVarDecl *> NewParamInfo) {
Craig Topper36250ad2014-05-12 05:36:57 +00003249 assert(!ParamInfo && "Already has param info!");
David Blaikie9c70e042011-09-21 18:16:56 +00003250 assert(NewParamInfo.size() == getNumParams() && "Parameter count mismatch!");
Mike Stump11289f42009-09-09 15:08:12 +00003251
Chris Lattner8f5bf2f2007-01-21 19:04:10 +00003252 // Zero params -> null pointer.
David Blaikie9c70e042011-09-21 18:16:56 +00003253 if (!NewParamInfo.empty()) {
3254 ParamInfo = new (C) ParmVarDecl*[NewParamInfo.size()];
3255 std::copy(NewParamInfo.begin(), NewParamInfo.end(), ParamInfo);
Chris Lattner8f5bf2f2007-01-21 19:04:10 +00003256 }
Chris Lattnerc5cdf4d2007-01-21 07:42:07 +00003257}
Chris Lattner41943152007-01-25 04:52:46 +00003258
Chris Lattner58258242008-04-10 02:22:51 +00003259/// getMinRequiredArguments - Returns the minimum number of arguments
3260/// needed to call this function. This may be fewer than the number of
3261/// function parameters, if some of the parameters have default
Richard Smith91151782014-04-01 19:18:16 +00003262/// arguments (in C++) or are parameter packs (C++11).
Chris Lattner58258242008-04-10 02:22:51 +00003263unsigned FunctionDecl::getMinRequiredArguments() const {
David Blaikiebbafb8a2012-03-11 07:00:24 +00003264 if (!getASTContext().getLangOpts().CPlusPlus)
Douglas Gregor0dd423e2011-01-11 01:52:23 +00003265 return getNumParams();
Chris Lattner58258242008-04-10 02:22:51 +00003266
Richard Smithb5f2c4e2020-06-02 10:42:36 -07003267 // Note that it is possible for a parameter with no default argument to
3268 // follow a parameter with a default argument.
Richard Smith91151782014-04-01 19:18:16 +00003269 unsigned NumRequiredArgs = 0;
Richard Smithb5f2c4e2020-06-02 10:42:36 -07003270 unsigned MinParamsSoFar = 0;
3271 for (auto *Param : parameters()) {
3272 if (!Param->isParameterPack()) {
3273 ++MinParamsSoFar;
3274 if (!Param->hasDefaultArg())
3275 NumRequiredArgs = MinParamsSoFar;
3276 }
3277 }
Chris Lattner58258242008-04-10 02:22:51 +00003278 return NumRequiredArgs;
3279}
3280
Richard Smithb5f2c4e2020-06-02 10:42:36 -07003281bool FunctionDecl::hasOneParamOrDefaultArgs() const {
3282 return getNumParams() == 1 ||
3283 (getNumParams() > 1 &&
3284 std::all_of(param_begin() + 1, param_end(),
3285 [](ParmVarDecl *P) { return P->hasDefaultArg(); }));
3286}
3287
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003288/// The combination of the extern and inline keywords under MSVC forces
David Majnemer54e3ba52014-04-02 23:17:29 +00003289/// the function to be required.
3290///
3291/// Note: This function assumes that we will only get called when isInlined()
3292/// would return true for this FunctionDecl.
3293bool FunctionDecl::isMSExternInline() const {
3294 assert(isInlined() && "expected to get called on an inlined function!");
3295
3296 const ASTContext &Context = getASTContext();
David Majnemer3f021502015-10-08 04:53:31 +00003297 if (!Context.getTargetInfo().getCXXABI().isMicrosoft() &&
3298 !hasAttr<DLLExportAttr>())
David Majnemer54e3ba52014-04-02 23:17:29 +00003299 return false;
3300
David Majnemer73768702015-03-20 00:02:27 +00003301 for (const FunctionDecl *FD = getMostRecentDecl(); FD;
3302 FD = FD->getPreviousDecl())
David Majnemerc0c42f32015-07-10 20:55:38 +00003303 if (!FD->isImplicit() && FD->getStorageClass() == SC_Extern)
David Majnemer54e3ba52014-04-02 23:17:29 +00003304 return true;
3305
3306 return false;
3307}
3308
3309static bool redeclForcesDefMSVC(const FunctionDecl *Redecl) {
3310 if (Redecl->getStorageClass() != SC_Extern)
3311 return false;
3312
3313 for (const FunctionDecl *FD = Redecl->getPreviousDecl(); FD;
3314 FD = FD->getPreviousDecl())
David Majnemerc0c42f32015-07-10 20:55:38 +00003315 if (!FD->isImplicit() && FD->getStorageClass() == SC_Extern)
David Majnemer54e3ba52014-04-02 23:17:29 +00003316 return false;
3317
3318 return true;
3319}
3320
Eli Friedman1b125c32012-02-07 03:50:18 +00003321static bool RedeclForcesDefC99(const FunctionDecl *Redecl) {
3322 // Only consider file-scope declarations in this test.
3323 if (!Redecl->getLexicalDeclContext()->isTranslationUnit())
3324 return false;
3325
3326 // Only consider explicit declarations; the presence of a builtin for a
3327 // libcall shouldn't affect whether a definition is externally visible.
3328 if (Redecl->isImplicit())
3329 return false;
3330
Fangrui Song6907ce22018-07-30 19:24:48 +00003331 if (!Redecl->isInlineSpecified() || Redecl->getStorageClass() == SC_Extern)
Eli Friedman1b125c32012-02-07 03:50:18 +00003332 return true; // Not an inline definition
3333
3334 return false;
3335}
3336
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003337/// For a function declaration in C or C++, determine whether this
Nick Lewycky26da4dd2011-07-18 05:26:13 +00003338/// declaration causes the definition to be externally visible.
3339///
David Majnemer54e3ba52014-04-02 23:17:29 +00003340/// For instance, this determines if adding the current declaration to the set
Eli Friedman1b125c32012-02-07 03:50:18 +00003341/// of redeclarations of the given functions causes
3342/// isInlineDefinitionExternallyVisible to change from false to true.
Nick Lewycky26da4dd2011-07-18 05:26:13 +00003343bool FunctionDecl::doesDeclarationForceExternallyVisibleDefinition() const {
Justin Lebar0241c962016-10-28 16:46:39 +00003344 assert(!doesThisDeclarationHaveABody() &&
Nick Lewycky26da4dd2011-07-18 05:26:13 +00003345 "Must have a declaration without a body.");
3346
3347 ASTContext &Context = getASTContext();
3348
David Majnemer54e3ba52014-04-02 23:17:29 +00003349 if (Context.getLangOpts().MSVCCompat) {
3350 const FunctionDecl *Definition;
3351 if (hasBody(Definition) && Definition->isInlined() &&
3352 redeclForcesDefMSVC(this))
3353 return true;
3354 }
3355
Martin Storsjo71decf82019-09-27 12:25:19 +00003356 if (Context.getLangOpts().CPlusPlus)
3357 return false;
3358
David Blaikiebbafb8a2012-03-11 07:00:24 +00003359 if (Context.getLangOpts().GNUInline || hasAttr<GNUInlineAttr>()) {
Eli Friedman1b125c32012-02-07 03:50:18 +00003360 // With GNU inlining, a declaration with 'inline' but not 'extern', forces
3361 // an externally visible definition.
3362 //
3363 // FIXME: What happens if gnu_inline gets added on after the first
3364 // declaration?
Rafael Espindola6ae7e502013-04-03 19:27:57 +00003365 if (!isInlineSpecified() || getStorageClass() == SC_Extern)
Eli Friedman1b125c32012-02-07 03:50:18 +00003366 return false;
3367
3368 const FunctionDecl *Prev = this;
3369 bool FoundBody = false;
3370 while ((Prev = Prev->getPreviousDecl())) {
Richard Smith848934c2019-12-05 13:37:35 -08003371 FoundBody |= Prev->doesThisDeclarationHaveABody();
Eli Friedman1b125c32012-02-07 03:50:18 +00003372
Richard Smith848934c2019-12-05 13:37:35 -08003373 if (Prev->doesThisDeclarationHaveABody()) {
Eli Friedman1b125c32012-02-07 03:50:18 +00003374 // If it's not the case that both 'inline' and 'extern' are
3375 // specified on the definition, then it is always externally visible.
3376 if (!Prev->isInlineSpecified() ||
Rafael Espindola6ae7e502013-04-03 19:27:57 +00003377 Prev->getStorageClass() != SC_Extern)
Eli Friedman1b125c32012-02-07 03:50:18 +00003378 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00003379 } else if (Prev->isInlineSpecified() &&
Rafael Espindola6ae7e502013-04-03 19:27:57 +00003380 Prev->getStorageClass() != SC_Extern) {
Eli Friedman1b125c32012-02-07 03:50:18 +00003381 return false;
3382 }
3383 }
3384 return FoundBody;
3385 }
3386
Eli Friedman1b125c32012-02-07 03:50:18 +00003387 // C99 6.7.4p6:
Fangrui Song6907ce22018-07-30 19:24:48 +00003388 // [...] If all of the file scope declarations for a function in a
3389 // translation unit include the inline function specifier without extern,
Eli Friedman1b125c32012-02-07 03:50:18 +00003390 // then the definition in that translation unit is an inline definition.
3391 if (isInlineSpecified() && getStorageClass() != SC_Extern)
Nick Lewycky26da4dd2011-07-18 05:26:13 +00003392 return false;
Eli Friedman1b125c32012-02-07 03:50:18 +00003393 const FunctionDecl *Prev = this;
3394 bool FoundBody = false;
3395 while ((Prev = Prev->getPreviousDecl())) {
Richard Smith848934c2019-12-05 13:37:35 -08003396 FoundBody |= Prev->doesThisDeclarationHaveABody();
Eli Friedman1b125c32012-02-07 03:50:18 +00003397 if (RedeclForcesDefC99(Prev))
3398 return false;
3399 }
3400 return FoundBody;
Nick Lewycky26da4dd2011-07-18 05:26:13 +00003401}
3402
Richard Smithd052a5782019-10-22 17:44:08 -07003403FunctionTypeLoc FunctionDecl::getFunctionTypeLoc() const {
Alp Tokerd0787eb2014-07-02 01:47:15 +00003404 const TypeSourceInfo *TSI = getTypeSourceInfo();
Richard Smithd052a5782019-10-22 17:44:08 -07003405 return TSI ? TSI->getTypeLoc().IgnoreParens().getAs<FunctionTypeLoc>()
3406 : FunctionTypeLoc();
3407}
3408
3409SourceRange FunctionDecl::getReturnTypeSourceRange() const {
3410 FunctionTypeLoc FTL = getFunctionTypeLoc();
Alp Tokerf5b10792014-07-02 12:55:58 +00003411 if (!FTL)
Alp Tokerd0787eb2014-07-02 01:47:15 +00003412 return SourceRange();
3413
Alp Tokerf5b10792014-07-02 12:55:58 +00003414 // Skip self-referential return types.
3415 const SourceManager &SM = getASTContext().getSourceManager();
3416 SourceRange RTRange = FTL.getReturnLoc().getSourceRange();
Stephen Kellyf2ceec42018-08-09 21:08:08 +00003417 SourceLocation Boundary = getNameInfo().getBeginLoc();
Alp Tokerf5b10792014-07-02 12:55:58 +00003418 if (RTRange.isInvalid() || Boundary.isInvalid() ||
3419 !SM.isBeforeInTranslationUnit(RTRange.getEnd(), Boundary))
3420 return SourceRange();
Alp Tokerd0787eb2014-07-02 01:47:15 +00003421
Alp Tokerf5b10792014-07-02 12:55:58 +00003422 return RTRange;
Alp Tokerd0787eb2014-07-02 01:47:15 +00003423}
3424
Nicolas Manichoncc3c9352019-12-03 08:21:55 -05003425SourceRange FunctionDecl::getParametersSourceRange() const {
3426 unsigned NP = getNumParams();
3427 SourceLocation EllipsisLoc = getEllipsisLoc();
3428
3429 if (NP == 0 && EllipsisLoc.isInvalid())
3430 return SourceRange();
3431
3432 SourceLocation Begin =
3433 NP > 0 ? ParamInfo[0]->getSourceRange().getBegin() : EllipsisLoc;
3434 SourceLocation End = EllipsisLoc.isValid()
3435 ? EllipsisLoc
3436 : ParamInfo[NP - 1]->getSourceRange().getEnd();
3437
3438 return SourceRange(Begin, End);
3439}
3440
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +00003441SourceRange FunctionDecl::getExceptionSpecSourceRange() const {
Richard Smithd052a5782019-10-22 17:44:08 -07003442 FunctionTypeLoc FTL = getFunctionTypeLoc();
3443 return FTL ? FTL.getExceptionSpecRange() : SourceRange();
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +00003444}
3445
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003446/// For an inline function definition in C, or for a gnu_inline function
Richard Smithf3814ad2013-01-25 00:08:28 +00003447/// in C++, determine whether the definition will be externally visible.
Douglas Gregor299d76e2009-09-13 07:46:26 +00003448///
3449/// Inline function definitions are always available for inlining optimizations.
3450/// However, depending on the language dialect, declaration specifiers, and
3451/// attributes, the definition of an inline function may or may not be
3452/// "externally" visible to other translation units in the program.
3453///
3454/// In C99, inline definitions are not externally visible by default. However,
Mike Stump13c66702010-01-06 02:05:39 +00003455/// if even one of the global-scope declarations is marked "extern inline", the
Douglas Gregor299d76e2009-09-13 07:46:26 +00003456/// inline definition becomes externally visible (C99 6.7.4p6).
3457///
3458/// In GNU89 mode, or if the gnu_inline attribute is attached to the function
Fangrui Song6907ce22018-07-30 19:24:48 +00003459/// definition, we use the GNU semantics for inline, which are nearly the
3460/// opposite of C99 semantics. In particular, "inline" by itself will create
3461/// an externally visible symbol, but "extern inline" will not create an
Douglas Gregor299d76e2009-09-13 07:46:26 +00003462/// externally visible symbol.
3463bool FunctionDecl::isInlineDefinitionExternallyVisible() const {
Nick Desaulniers58060222019-09-12 19:53:35 +00003464 assert((doesThisDeclarationHaveABody() || willHaveBody() ||
3465 hasAttr<AliasAttr>()) &&
Manuel Klimekda7456a2016-11-01 10:30:50 +00003466 "Must be a function definition");
Douglas Gregor583dcaf2009-10-27 21:11:48 +00003467 assert(isInlined() && "Function must be inline");
Douglas Gregorb7e5c842009-10-27 23:26:40 +00003468 ASTContext &Context = getASTContext();
Fangrui Song6907ce22018-07-30 19:24:48 +00003469
David Blaikiebbafb8a2012-03-11 07:00:24 +00003470 if (Context.getLangOpts().GNUInline || hasAttr<GNUInlineAttr>()) {
Eli Friedman1b125c32012-02-07 03:50:18 +00003471 // Note: If you change the logic here, please change
3472 // doesDeclarationForceExternallyVisibleDefinition as well.
3473 //
Douglas Gregorff76cb92010-12-09 16:59:22 +00003474 // If it's not the case that both 'inline' and 'extern' are
3475 // specified on the definition, then this inline definition is
3476 // externally visible.
Martin Storsjo71decf82019-09-27 12:25:19 +00003477 if (Context.getLangOpts().CPlusPlus)
3478 return false;
Rafael Espindola6ae7e502013-04-03 19:27:57 +00003479 if (!(isInlineSpecified() && getStorageClass() == SC_Extern))
Douglas Gregorff76cb92010-12-09 16:59:22 +00003480 return true;
Fangrui Song6907ce22018-07-30 19:24:48 +00003481
Douglas Gregorff76cb92010-12-09 16:59:22 +00003482 // If any declaration is 'inline' but not 'extern', then this definition
3483 // is externally visible.
Aaron Ballman86c93902014-03-06 23:45:36 +00003484 for (auto Redecl : redecls()) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003485 if (Redecl->isInlineSpecified() &&
Rafael Espindola6ae7e502013-04-03 19:27:57 +00003486 Redecl->getStorageClass() != SC_Extern)
Douglas Gregor299d76e2009-09-13 07:46:26 +00003487 return true;
Fangrui Song6907ce22018-07-30 19:24:48 +00003488 }
3489
Douglas Gregor76fe50c2009-04-28 06:37:30 +00003490 return false;
Douglas Gregor299d76e2009-09-13 07:46:26 +00003491 }
Eli Friedman1b125c32012-02-07 03:50:18 +00003492
Richard Smithf3814ad2013-01-25 00:08:28 +00003493 // The rest of this function is C-only.
3494 assert(!Context.getLangOpts().CPlusPlus &&
3495 "should not use C inline rules in C++");
3496
Douglas Gregor299d76e2009-09-13 07:46:26 +00003497 // C99 6.7.4p6:
Fangrui Song6907ce22018-07-30 19:24:48 +00003498 // [...] If all of the file scope declarations for a function in a
3499 // translation unit include the inline function specifier without extern,
Douglas Gregor299d76e2009-09-13 07:46:26 +00003500 // then the definition in that translation unit is an inline definition.
Aaron Ballman86c93902014-03-06 23:45:36 +00003501 for (auto Redecl : redecls()) {
3502 if (RedeclForcesDefC99(Redecl))
Eli Friedman1b125c32012-02-07 03:50:18 +00003503 return true;
Douglas Gregor299d76e2009-09-13 07:46:26 +00003504 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003505
Douglas Gregor299d76e2009-09-13 07:46:26 +00003506 // C99 6.7.4p6:
Fangrui Song6907ce22018-07-30 19:24:48 +00003507 // An inline definition does not provide an external definition for the
3508 // function, and does not forbid an external definition in another
Douglas Gregor299d76e2009-09-13 07:46:26 +00003509 // translation unit.
Douglas Gregor76fe50c2009-04-28 06:37:30 +00003510 return false;
3511}
3512
Douglas Gregor11d0c4c2008-11-06 22:13:31 +00003513/// getOverloadedOperator - Which C++ overloaded operator this
3514/// function represents, if any.
3515OverloadedOperatorKind FunctionDecl::getOverloadedOperator() const {
Douglas Gregor163c5852008-11-18 14:39:36 +00003516 if (getDeclName().getNameKind() == DeclarationName::CXXOperatorName)
3517 return getDeclName().getCXXOverloadedOperator();
Douglas Gregor11d0c4c2008-11-06 22:13:31 +00003518 else
3519 return OO_None;
3520}
3521
Alexis Huntc88db062010-01-13 09:01:02 +00003522/// getLiteralIdentifier - The literal suffix identifier this function
3523/// represents, if any.
3524const IdentifierInfo *FunctionDecl::getLiteralIdentifier() const {
3525 if (getDeclName().getNameKind() == DeclarationName::CXXLiteralOperatorName)
3526 return getDeclName().getCXXLiteralIdentifier();
3527 else
Craig Topper36250ad2014-05-12 05:36:57 +00003528 return nullptr;
Alexis Huntc88db062010-01-13 09:01:02 +00003529}
3530
Argyrios Kyrtzidiscb6f3462010-06-22 09:54:51 +00003531FunctionDecl::TemplatedKind FunctionDecl::getTemplatedKind() const {
3532 if (TemplateOrSpecialization.isNull())
3533 return TK_NonTemplate;
3534 if (TemplateOrSpecialization.is<FunctionTemplateDecl *>())
3535 return TK_FunctionTemplate;
3536 if (TemplateOrSpecialization.is<MemberSpecializationInfo *>())
3537 return TK_MemberSpecialization;
3538 if (TemplateOrSpecialization.is<FunctionTemplateSpecializationInfo *>())
3539 return TK_FunctionTemplateSpecialization;
3540 if (TemplateOrSpecialization.is
3541 <DependentFunctionTemplateSpecializationInfo*>())
3542 return TK_DependentFunctionTemplateSpecialization;
3543
David Blaikie83d382b2011-09-23 05:06:16 +00003544 llvm_unreachable("Did we miss a TemplateOrSpecialization type?");
Argyrios Kyrtzidiscb6f3462010-06-22 09:54:51 +00003545}
3546
Douglas Gregord801b062009-10-07 23:56:10 +00003547FunctionDecl *FunctionDecl::getInstantiatedFromMemberFunction() const {
Douglas Gregor06db9f52009-10-12 20:18:28 +00003548 if (MemberSpecializationInfo *Info = getMemberSpecializationInfo())
Douglas Gregord801b062009-10-07 23:56:10 +00003549 return cast<FunctionDecl>(Info->getInstantiatedFrom());
Craig Topper36250ad2014-05-12 05:36:57 +00003550
3551 return nullptr;
Douglas Gregord801b062009-10-07 23:56:10 +00003552}
3553
Chandler Carruth21c90602015-12-30 03:24:14 +00003554MemberSpecializationInfo *FunctionDecl::getMemberSpecializationInfo() const {
Richard Smithf19a8b02019-05-02 00:49:14 +00003555 if (auto *MSI =
3556 TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo *>())
3557 return MSI;
3558 if (auto *FTSI = TemplateOrSpecialization
3559 .dyn_cast<FunctionTemplateSpecializationInfo *>())
3560 return FTSI->getMemberSpecializationInfo();
3561 return nullptr;
Chandler Carruth21c90602015-12-30 03:24:14 +00003562}
3563
Fangrui Song6907ce22018-07-30 19:24:48 +00003564void
Argyrios Kyrtzidisf4bc0d82010-09-08 19:31:22 +00003565FunctionDecl::setInstantiationOfMemberFunction(ASTContext &C,
3566 FunctionDecl *FD,
Douglas Gregord801b062009-10-07 23:56:10 +00003567 TemplateSpecializationKind TSK) {
Fangrui Song6907ce22018-07-30 19:24:48 +00003568 assert(TemplateOrSpecialization.isNull() &&
Douglas Gregord801b062009-10-07 23:56:10 +00003569 "Member function is already a specialization");
Fangrui Song6907ce22018-07-30 19:24:48 +00003570 MemberSpecializationInfo *Info
Argyrios Kyrtzidisf4bc0d82010-09-08 19:31:22 +00003571 = new (C) MemberSpecializationInfo(FD, TSK);
Douglas Gregord801b062009-10-07 23:56:10 +00003572 TemplateOrSpecialization = Info;
3573}
3574
Chandler Carruth21c90602015-12-30 03:24:14 +00003575FunctionTemplateDecl *FunctionDecl::getDescribedFunctionTemplate() const {
3576 return TemplateOrSpecialization.dyn_cast<FunctionTemplateDecl *>();
3577}
3578
3579void FunctionDecl::setDescribedFunctionTemplate(FunctionTemplateDecl *Template) {
Richard Smithf19a8b02019-05-02 00:49:14 +00003580 assert(TemplateOrSpecialization.isNull() &&
3581 "Member function is already a specialization");
Chandler Carruth21c90602015-12-30 03:24:14 +00003582 TemplateOrSpecialization = Template;
3583}
3584
Douglas Gregorafca3b42009-10-27 20:53:28 +00003585bool FunctionDecl::isImplicitlyInstantiable() const {
Douglas Gregor69f6a362010-05-17 17:34:56 +00003586 // If the function is invalid, it can't be implicitly instantiated.
3587 if (isInvalidDecl())
Douglas Gregorafca3b42009-10-27 20:53:28 +00003588 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00003589
Richard Smithf19a8b02019-05-02 00:49:14 +00003590 switch (getTemplateSpecializationKindForInstantiation()) {
Douglas Gregorafca3b42009-10-27 20:53:28 +00003591 case TSK_Undeclared:
Douglas Gregorafca3b42009-10-27 20:53:28 +00003592 case TSK_ExplicitInstantiationDefinition:
Richard Smithf19a8b02019-05-02 00:49:14 +00003593 case TSK_ExplicitSpecialization:
Douglas Gregorafca3b42009-10-27 20:53:28 +00003594 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00003595
Douglas Gregorafca3b42009-10-27 20:53:28 +00003596 case TSK_ImplicitInstantiation:
3597 return true;
3598
3599 case TSK_ExplicitInstantiationDeclaration:
3600 // Handled below.
3601 break;
3602 }
3603
3604 // Find the actual template from which we will instantiate.
3605 const FunctionDecl *PatternDecl = getTemplateInstantiationPattern();
Argyrios Kyrtzidis36ea3222010-07-07 11:31:19 +00003606 bool HasPattern = false;
Douglas Gregorafca3b42009-10-27 20:53:28 +00003607 if (PatternDecl)
Argyrios Kyrtzidis36ea3222010-07-07 11:31:19 +00003608 HasPattern = PatternDecl->hasBody(PatternDecl);
Fangrui Song6907ce22018-07-30 19:24:48 +00003609
Douglas Gregorafca3b42009-10-27 20:53:28 +00003610 // C++0x [temp.explicit]p9:
3611 // Except for inline functions, other explicit instantiation declarations
3612 // have the effect of suppressing the implicit instantiation of the entity
Fangrui Song6907ce22018-07-30 19:24:48 +00003613 // to which they refer.
3614 if (!HasPattern || !PatternDecl)
Douglas Gregorafca3b42009-10-27 20:53:28 +00003615 return true;
3616
Douglas Gregor583dcaf2009-10-27 21:11:48 +00003617 return PatternDecl->isInlined();
Ted Kremenek85825ae2011-12-01 00:59:17 +00003618}
3619
3620bool FunctionDecl::isTemplateInstantiation() const {
Richard Smithf19a8b02019-05-02 00:49:14 +00003621 // FIXME: Remove this, it's not clear what it means. (Which template
3622 // specialization kind?)
3623 return clang::isTemplateInstantiation(getTemplateSpecializationKind());
Ted Kremenek85825ae2011-12-01 00:59:17 +00003624}
Fangrui Song6907ce22018-07-30 19:24:48 +00003625
Douglas Gregorafca3b42009-10-27 20:53:28 +00003626FunctionDecl *FunctionDecl::getTemplateInstantiationPattern() const {
Fangrui Song6907ce22018-07-30 19:24:48 +00003627 // If this is a generic lambda call operator specialization, its
Faisal Valib90b2112014-04-03 16:32:21 +00003628 // instantiation pattern is always its primary template's pattern
Fangrui Song6907ce22018-07-30 19:24:48 +00003629 // even if its primary template was instantiated from another
Faisal Valib90b2112014-04-03 16:32:21 +00003630 // member template (which happens with nested generic lambdas).
Fangrui Song6907ce22018-07-30 19:24:48 +00003631 // Since a lambda's call operator's body is transformed eagerly,
3632 // we don't have to go hunting for a prototype definition template
3633 // (i.e. instantiated-from-member-template) to use as an instantiation
Faisal Valib90b2112014-04-03 16:32:21 +00003634 // pattern.
Francois Pichet00c7e6c2011-08-14 03:52:19 +00003635
Faisal Valib90b2112014-04-03 16:32:21 +00003636 if (isGenericLambdaCallOperatorSpecialization(
3637 dyn_cast<CXXMethodDecl>(this))) {
Richard Smith2195ec92017-04-21 01:15:13 +00003638 assert(getPrimaryTemplate() && "not a generic lambda call operator?");
3639 return getDefinitionOrSelf(getPrimaryTemplate()->getTemplatedDecl());
Faisal Valib90b2112014-04-03 16:32:21 +00003640 }
Richard Smith2195ec92017-04-21 01:15:13 +00003641
Richard Smithf19a8b02019-05-02 00:49:14 +00003642 if (MemberSpecializationInfo *Info = getMemberSpecializationInfo()) {
3643 if (!clang::isTemplateInstantiation(Info->getTemplateSpecializationKind()))
3644 return nullptr;
3645 return getDefinitionOrSelf(cast<FunctionDecl>(Info->getInstantiatedFrom()));
3646 }
3647
3648 if (!clang::isTemplateInstantiation(getTemplateSpecializationKind()))
3649 return nullptr;
3650
Douglas Gregorafca3b42009-10-27 20:53:28 +00003651 if (FunctionTemplateDecl *Primary = getPrimaryTemplate()) {
Richard Smitha6b41d72019-05-03 23:51:38 +00003652 // If we hit a point where the user provided a specialization of this
3653 // template, we're done looking.
3654 while (!Primary->isMemberSpecialization()) {
3655 auto *NewPrimary = Primary->getInstantiatedFromMemberTemplate();
3656 if (!NewPrimary)
Douglas Gregorafca3b42009-10-27 20:53:28 +00003657 break;
Richard Smitha6b41d72019-05-03 23:51:38 +00003658 Primary = NewPrimary;
Douglas Gregorafca3b42009-10-27 20:53:28 +00003659 }
Richard Smith2195ec92017-04-21 01:15:13 +00003660
3661 return getDefinitionOrSelf(Primary->getTemplatedDecl());
Fangrui Song6907ce22018-07-30 19:24:48 +00003662 }
Richard Smith2195ec92017-04-21 01:15:13 +00003663
Richard Smith2195ec92017-04-21 01:15:13 +00003664 return nullptr;
Douglas Gregorafca3b42009-10-27 20:53:28 +00003665}
3666
Douglas Gregor70d83e22009-06-29 17:30:29 +00003667FunctionTemplateDecl *FunctionDecl::getPrimaryTemplate() const {
Mike Stump11289f42009-09-09 15:08:12 +00003668 if (FunctionTemplateSpecializationInfo *Info
Douglas Gregor70d83e22009-06-29 17:30:29 +00003669 = TemplateOrSpecialization
3670 .dyn_cast<FunctionTemplateSpecializationInfo*>()) {
Richard Smithf19a8b02019-05-02 00:49:14 +00003671 return Info->getTemplate();
Douglas Gregor70d83e22009-06-29 17:30:29 +00003672 }
Craig Topper36250ad2014-05-12 05:36:57 +00003673 return nullptr;
Douglas Gregor70d83e22009-06-29 17:30:29 +00003674}
3675
Chandler Carruth21c90602015-12-30 03:24:14 +00003676FunctionTemplateSpecializationInfo *
3677FunctionDecl::getTemplateSpecializationInfo() const {
3678 return TemplateOrSpecialization
3679 .dyn_cast<FunctionTemplateSpecializationInfo *>();
3680}
3681
Douglas Gregor70d83e22009-06-29 17:30:29 +00003682const TemplateArgumentList *
3683FunctionDecl::getTemplateSpecializationArgs() const {
Mike Stump11289f42009-09-09 15:08:12 +00003684 if (FunctionTemplateSpecializationInfo *Info
Douglas Gregorcf915552009-10-13 16:30:37 +00003685 = TemplateOrSpecialization
3686 .dyn_cast<FunctionTemplateSpecializationInfo*>()) {
Douglas Gregor70d83e22009-06-29 17:30:29 +00003687 return Info->TemplateArguments;
3688 }
Craig Topper36250ad2014-05-12 05:36:57 +00003689 return nullptr;
Douglas Gregor70d83e22009-06-29 17:30:29 +00003690}
3691
Argyrios Kyrtzidise9a24432011-09-22 20:07:09 +00003692const ASTTemplateArgumentListInfo *
Abramo Bagnara02ccd282010-05-20 15:32:11 +00003693FunctionDecl::getTemplateSpecializationArgsAsWritten() const {
3694 if (FunctionTemplateSpecializationInfo *Info
3695 = TemplateOrSpecialization
3696 .dyn_cast<FunctionTemplateSpecializationInfo*>()) {
3697 return Info->TemplateArgumentsAsWritten;
3698 }
Craig Topper36250ad2014-05-12 05:36:57 +00003699 return nullptr;
Abramo Bagnara02ccd282010-05-20 15:32:11 +00003700}
3701
Mike Stump11289f42009-09-09 15:08:12 +00003702void
Argyrios Kyrtzidisf4bc0d82010-09-08 19:31:22 +00003703FunctionDecl::setFunctionTemplateSpecialization(ASTContext &C,
3704 FunctionTemplateDecl *Template,
Douglas Gregor8f5d4422009-06-29 20:59:39 +00003705 const TemplateArgumentList *TemplateArgs,
Douglas Gregor3a923c2d2009-09-24 23:14:47 +00003706 void *InsertPos,
Abramo Bagnara02ccd282010-05-20 15:32:11 +00003707 TemplateSpecializationKind TSK,
Argyrios Kyrtzidis927d8e02010-07-05 10:37:55 +00003708 const TemplateArgumentListInfo *TemplateArgsAsWritten,
3709 SourceLocation PointOfInstantiation) {
Richard Smithf19a8b02019-05-02 00:49:14 +00003710 assert((TemplateOrSpecialization.isNull() ||
3711 TemplateOrSpecialization.is<MemberSpecializationInfo *>()) &&
3712 "Member function is already a specialization");
Fangrui Song6907ce22018-07-30 19:24:48 +00003713 assert(TSK != TSK_Undeclared &&
Douglas Gregor3a923c2d2009-09-24 23:14:47 +00003714 "Must specify the type of function template specialization");
Richard Smithf19a8b02019-05-02 00:49:14 +00003715 assert((TemplateOrSpecialization.isNull() ||
3716 TSK == TSK_ExplicitSpecialization) &&
3717 "Member specialization must be an explicit specialization");
3718 FunctionTemplateSpecializationInfo *Info =
3719 FunctionTemplateSpecializationInfo::Create(
3720 C, this, Template, TSK, TemplateArgs, TemplateArgsAsWritten,
3721 PointOfInstantiation,
3722 TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo *>());
Douglas Gregor4adbc6d2009-06-26 00:10:03 +00003723 TemplateOrSpecialization = Info;
Douglas Gregorce9978f2012-03-28 14:34:23 +00003724 Template->addSpecialization(Info, InsertPos);
Douglas Gregor4adbc6d2009-06-26 00:10:03 +00003725}
3726
John McCallb9c78482010-04-08 09:05:18 +00003727void
3728FunctionDecl::setDependentTemplateSpecialization(ASTContext &Context,
3729 const UnresolvedSetImpl &Templates,
3730 const TemplateArgumentListInfo &TemplateArgs) {
3731 assert(TemplateOrSpecialization.isNull());
John McCallb9c78482010-04-08 09:05:18 +00003732 DependentFunctionTemplateSpecializationInfo *Info =
James Y Knight7a22b242015-08-06 20:26:32 +00003733 DependentFunctionTemplateSpecializationInfo::Create(Context, Templates,
3734 TemplateArgs);
John McCallb9c78482010-04-08 09:05:18 +00003735 TemplateOrSpecialization = Info;
3736}
3737
James Y Knight7a22b242015-08-06 20:26:32 +00003738DependentFunctionTemplateSpecializationInfo *
Chandler Carruth21c90602015-12-30 03:24:14 +00003739FunctionDecl::getDependentSpecializationInfo() const {
3740 return TemplateOrSpecialization
3741 .dyn_cast<DependentFunctionTemplateSpecializationInfo *>();
3742}
3743
3744DependentFunctionTemplateSpecializationInfo *
James Y Knight7a22b242015-08-06 20:26:32 +00003745DependentFunctionTemplateSpecializationInfo::Create(
3746 ASTContext &Context, const UnresolvedSetImpl &Ts,
3747 const TemplateArgumentListInfo &TArgs) {
3748 void *Buffer = Context.Allocate(
3749 totalSizeToAlloc<TemplateArgumentLoc, FunctionTemplateDecl *>(
3750 TArgs.size(), Ts.size()));
3751 return new (Buffer) DependentFunctionTemplateSpecializationInfo(Ts, TArgs);
3752}
3753
John McCallb9c78482010-04-08 09:05:18 +00003754DependentFunctionTemplateSpecializationInfo::
3755DependentFunctionTemplateSpecializationInfo(const UnresolvedSetImpl &Ts,
3756 const TemplateArgumentListInfo &TArgs)
Benjamin Kramer3ebba522015-04-02 12:43:31 +00003757 : AngleLocs(TArgs.getLAngleLoc(), TArgs.getRAngleLoc()) {
James Y Knight53c76162015-07-17 18:21:37 +00003758 NumTemplates = Ts.size();
3759 NumArgs = TArgs.size();
Benjamin Kramer3ebba522015-04-02 12:43:31 +00003760
James Y Knight7a22b242015-08-06 20:26:32 +00003761 FunctionTemplateDecl **TsArray = getTrailingObjects<FunctionTemplateDecl *>();
John McCallb9c78482010-04-08 09:05:18 +00003762 for (unsigned I = 0, E = Ts.size(); I != E; ++I)
3763 TsArray[I] = cast<FunctionTemplateDecl>(Ts[I]->getUnderlyingDecl());
3764
James Y Knight7a22b242015-08-06 20:26:32 +00003765 TemplateArgumentLoc *ArgsArray = getTrailingObjects<TemplateArgumentLoc>();
John McCallb9c78482010-04-08 09:05:18 +00003766 for (unsigned I = 0, E = TArgs.size(); I != E; ++I)
3767 new (&ArgsArray[I]) TemplateArgumentLoc(TArgs[I]);
3768}
3769
Douglas Gregor34ec2ef2009-09-04 22:48:11 +00003770TemplateSpecializationKind FunctionDecl::getTemplateSpecializationKind() const {
Mike Stump11289f42009-09-09 15:08:12 +00003771 // For a function template specialization, query the specialization
Douglas Gregor34ec2ef2009-09-04 22:48:11 +00003772 // information object.
Richard Smithf19a8b02019-05-02 00:49:14 +00003773 if (FunctionTemplateSpecializationInfo *FTSInfo =
3774 TemplateOrSpecialization
3775 .dyn_cast<FunctionTemplateSpecializationInfo *>())
Douglas Gregord801b062009-10-07 23:56:10 +00003776 return FTSInfo->getTemplateSpecializationKind();
Mike Stump11289f42009-09-09 15:08:12 +00003777
Richard Smithf19a8b02019-05-02 00:49:14 +00003778 if (MemberSpecializationInfo *MSInfo =
3779 TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo *>())
3780 return MSInfo->getTemplateSpecializationKind();
3781
3782 return TSK_Undeclared;
3783}
3784
3785TemplateSpecializationKind
3786FunctionDecl::getTemplateSpecializationKindForInstantiation() const {
3787 // This is the same as getTemplateSpecializationKind(), except that for a
3788 // function that is both a function template specialization and a member
3789 // specialization, we prefer the member specialization information. Eg:
3790 //
3791 // template<typename T> struct A {
3792 // template<typename U> void f() {}
3793 // template<> void f<int>() {}
3794 // };
3795 //
3796 // For A<int>::f<int>():
3797 // * getTemplateSpecializationKind() will return TSK_ExplicitSpecialization
3798 // * getTemplateSpecializationKindForInstantiation() will return
3799 // TSK_ImplicitInstantiation
3800 //
3801 // This reflects the facts that A<int>::f<int> is an explicit specialization
3802 // of A<int>::f, and that A<int>::f<int> should be implicitly instantiated
3803 // from A::f<int> if a definition is needed.
3804 if (FunctionTemplateSpecializationInfo *FTSInfo =
3805 TemplateOrSpecialization
3806 .dyn_cast<FunctionTemplateSpecializationInfo *>()) {
3807 if (auto *MSInfo = FTSInfo->getMemberSpecializationInfo())
3808 return MSInfo->getTemplateSpecializationKind();
3809 return FTSInfo->getTemplateSpecializationKind();
3810 }
3811
3812 if (MemberSpecializationInfo *MSInfo =
3813 TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo *>())
Douglas Gregord801b062009-10-07 23:56:10 +00003814 return MSInfo->getTemplateSpecializationKind();
Fangrui Song6907ce22018-07-30 19:24:48 +00003815
Douglas Gregord801b062009-10-07 23:56:10 +00003816 return TSK_Undeclared;
Douglas Gregor34ec2ef2009-09-04 22:48:11 +00003817}
3818
Mike Stump11289f42009-09-09 15:08:12 +00003819void
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003820FunctionDecl::setTemplateSpecializationKind(TemplateSpecializationKind TSK,
3821 SourceLocation PointOfInstantiation) {
3822 if (FunctionTemplateSpecializationInfo *FTSInfo
3823 = TemplateOrSpecialization.dyn_cast<
3824 FunctionTemplateSpecializationInfo*>()) {
3825 FTSInfo->setTemplateSpecializationKind(TSK);
3826 if (TSK != TSK_ExplicitSpecialization &&
3827 PointOfInstantiation.isValid() &&
Richard Smith891fc7f2017-12-05 01:31:47 +00003828 FTSInfo->getPointOfInstantiation().isInvalid()) {
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003829 FTSInfo->setPointOfInstantiation(PointOfInstantiation);
Richard Smith891fc7f2017-12-05 01:31:47 +00003830 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
3831 L->InstantiationRequested(this);
3832 }
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003833 } else if (MemberSpecializationInfo *MSInfo
3834 = TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo*>()) {
3835 MSInfo->setTemplateSpecializationKind(TSK);
3836 if (TSK != TSK_ExplicitSpecialization &&
3837 PointOfInstantiation.isValid() &&
Richard Smith891fc7f2017-12-05 01:31:47 +00003838 MSInfo->getPointOfInstantiation().isInvalid()) {
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003839 MSInfo->setPointOfInstantiation(PointOfInstantiation);
Richard Smith891fc7f2017-12-05 01:31:47 +00003840 if (ASTMutationListener *L = getASTContext().getASTMutationListener())
3841 L->InstantiationRequested(this);
3842 }
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003843 } else
David Blaikie83d382b2011-09-23 05:06:16 +00003844 llvm_unreachable("Function cannot have a template specialization kind");
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003845}
3846
3847SourceLocation FunctionDecl::getPointOfInstantiation() const {
Douglas Gregord801b062009-10-07 23:56:10 +00003848 if (FunctionTemplateSpecializationInfo *FTSInfo
3849 = TemplateOrSpecialization.dyn_cast<
3850 FunctionTemplateSpecializationInfo*>())
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003851 return FTSInfo->getPointOfInstantiation();
Douglas Gregord801b062009-10-07 23:56:10 +00003852 else if (MemberSpecializationInfo *MSInfo
3853 = TemplateOrSpecialization.dyn_cast<MemberSpecializationInfo*>())
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003854 return MSInfo->getPointOfInstantiation();
Fangrui Song6907ce22018-07-30 19:24:48 +00003855
Douglas Gregor3d7e69f2009-10-15 17:21:20 +00003856 return SourceLocation();
Douglas Gregore8925db2009-06-29 22:39:32 +00003857}
3858
Douglas Gregor6411b922009-09-11 20:15:17 +00003859bool FunctionDecl::isOutOfLine() const {
Douglas Gregorb11aad82011-02-19 18:51:44 +00003860 if (Decl::isOutOfLine())
Douglas Gregor6411b922009-09-11 20:15:17 +00003861 return true;
Fangrui Song6907ce22018-07-30 19:24:48 +00003862
3863 // If this function was instantiated from a member function of a
Douglas Gregor6411b922009-09-11 20:15:17 +00003864 // class template, check whether that member function was defined out-of-line.
3865 if (FunctionDecl *FD = getInstantiatedFromMemberFunction()) {
3866 const FunctionDecl *Definition;
Argyrios Kyrtzidis36ea3222010-07-07 11:31:19 +00003867 if (FD->hasBody(Definition))
Douglas Gregor6411b922009-09-11 20:15:17 +00003868 return Definition->isOutOfLine();
3869 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003870
Douglas Gregor6411b922009-09-11 20:15:17 +00003871 // If this function was instantiated from a function template,
3872 // check whether that function template was defined out-of-line.
3873 if (FunctionTemplateDecl *FunTmpl = getPrimaryTemplate()) {
3874 const FunctionDecl *Definition;
Argyrios Kyrtzidis36ea3222010-07-07 11:31:19 +00003875 if (FunTmpl->getTemplatedDecl()->hasBody(Definition))
Douglas Gregor6411b922009-09-11 20:15:17 +00003876 return Definition->isOutOfLine();
3877 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003878
Douglas Gregor6411b922009-09-11 20:15:17 +00003879 return false;
3880}
3881
Abramo Bagnaraea947882011-03-08 16:41:52 +00003882SourceRange FunctionDecl::getSourceRange() const {
3883 return SourceRange(getOuterLocStart(), EndRangeLoc);
3884}
3885
Anna Zaks28db7ce2012-01-18 02:45:01 +00003886unsigned FunctionDecl::getMemoryFunctionKind() const {
Anna Zaks201d4892012-01-13 21:52:01 +00003887 IdentifierInfo *FnInfo = getIdentifier();
3888
3889 if (!FnInfo)
Anna Zaks22122702012-01-17 00:37:07 +00003890 return 0;
Fangrui Song6907ce22018-07-30 19:24:48 +00003891
Anna Zaks201d4892012-01-13 21:52:01 +00003892 // Builtin handling.
3893 switch (getBuiltinID()) {
3894 case Builtin::BI__builtin_memset:
3895 case Builtin::BI__builtin___memset_chk:
3896 case Builtin::BImemset:
Anna Zaks22122702012-01-17 00:37:07 +00003897 return Builtin::BImemset;
Anna Zaks201d4892012-01-13 21:52:01 +00003898
3899 case Builtin::BI__builtin_memcpy:
3900 case Builtin::BI__builtin___memcpy_chk:
3901 case Builtin::BImemcpy:
Anna Zaks22122702012-01-17 00:37:07 +00003902 return Builtin::BImemcpy;
Anna Zaks201d4892012-01-13 21:52:01 +00003903
serge-sans-paillecee4a1c2019-12-11 21:30:10 +01003904 case Builtin::BI__builtin_mempcpy:
3905 case Builtin::BI__builtin___mempcpy_chk:
3906 case Builtin::BImempcpy:
3907 return Builtin::BImempcpy;
3908
Anna Zaks201d4892012-01-13 21:52:01 +00003909 case Builtin::BI__builtin_memmove:
3910 case Builtin::BI__builtin___memmove_chk:
3911 case Builtin::BImemmove:
Anna Zaks22122702012-01-17 00:37:07 +00003912 return Builtin::BImemmove;
Anna Zaks201d4892012-01-13 21:52:01 +00003913
3914 case Builtin::BIstrlcpy:
Fariborz Jahanianab4fe982014-09-12 18:44:36 +00003915 case Builtin::BI__builtin___strlcpy_chk:
Anna Zaks22122702012-01-17 00:37:07 +00003916 return Builtin::BIstrlcpy;
Fariborz Jahanianab4fe982014-09-12 18:44:36 +00003917
Anna Zaks201d4892012-01-13 21:52:01 +00003918 case Builtin::BIstrlcat:
Fariborz Jahanianab4fe982014-09-12 18:44:36 +00003919 case Builtin::BI__builtin___strlcat_chk:
Anna Zaks22122702012-01-17 00:37:07 +00003920 return Builtin::BIstrlcat;
Anna Zaks201d4892012-01-13 21:52:01 +00003921
3922 case Builtin::BI__builtin_memcmp:
Anna Zaks22122702012-01-17 00:37:07 +00003923 case Builtin::BImemcmp:
3924 return Builtin::BImemcmp;
Anna Zaks201d4892012-01-13 21:52:01 +00003925
Clement Courbet8c3343d2019-02-14 12:00:34 +00003926 case Builtin::BI__builtin_bcmp:
3927 case Builtin::BIbcmp:
3928 return Builtin::BIbcmp;
3929
Anna Zaks201d4892012-01-13 21:52:01 +00003930 case Builtin::BI__builtin_strncpy:
3931 case Builtin::BI__builtin___strncpy_chk:
3932 case Builtin::BIstrncpy:
Anna Zaks22122702012-01-17 00:37:07 +00003933 return Builtin::BIstrncpy;
Anna Zaks201d4892012-01-13 21:52:01 +00003934
3935 case Builtin::BI__builtin_strncmp:
Anna Zaks22122702012-01-17 00:37:07 +00003936 case Builtin::BIstrncmp:
3937 return Builtin::BIstrncmp;
Anna Zaks201d4892012-01-13 21:52:01 +00003938
3939 case Builtin::BI__builtin_strncasecmp:
Anna Zaks22122702012-01-17 00:37:07 +00003940 case Builtin::BIstrncasecmp:
3941 return Builtin::BIstrncasecmp;
Anna Zaks201d4892012-01-13 21:52:01 +00003942
3943 case Builtin::BI__builtin_strncat:
Anna Zaks314cd092012-02-01 19:08:57 +00003944 case Builtin::BI__builtin___strncat_chk:
Anna Zaks201d4892012-01-13 21:52:01 +00003945 case Builtin::BIstrncat:
Anna Zaks22122702012-01-17 00:37:07 +00003946 return Builtin::BIstrncat;
Anna Zaks201d4892012-01-13 21:52:01 +00003947
3948 case Builtin::BI__builtin_strndup:
3949 case Builtin::BIstrndup:
Anna Zaks22122702012-01-17 00:37:07 +00003950 return Builtin::BIstrndup;
Anna Zaks201d4892012-01-13 21:52:01 +00003951
Anna Zaks314cd092012-02-01 19:08:57 +00003952 case Builtin::BI__builtin_strlen:
3953 case Builtin::BIstrlen:
3954 return Builtin::BIstrlen;
3955
Bruno Cardoso Lopes7ea9fd22016-08-10 18:34:47 +00003956 case Builtin::BI__builtin_bzero:
3957 case Builtin::BIbzero:
3958 return Builtin::BIbzero;
3959
Anna Zaks201d4892012-01-13 21:52:01 +00003960 default:
Rafael Espindola5bda63f2013-02-14 01:47:04 +00003961 if (isExternC()) {
Anna Zaks201d4892012-01-13 21:52:01 +00003962 if (FnInfo->isStr("memset"))
Anna Zaks22122702012-01-17 00:37:07 +00003963 return Builtin::BImemset;
Anna Zaks201d4892012-01-13 21:52:01 +00003964 else if (FnInfo->isStr("memcpy"))
Anna Zaks22122702012-01-17 00:37:07 +00003965 return Builtin::BImemcpy;
serge-sans-paillecee4a1c2019-12-11 21:30:10 +01003966 else if (FnInfo->isStr("mempcpy"))
3967 return Builtin::BImempcpy;
Anna Zaks201d4892012-01-13 21:52:01 +00003968 else if (FnInfo->isStr("memmove"))
Anna Zaks22122702012-01-17 00:37:07 +00003969 return Builtin::BImemmove;
Anna Zaks201d4892012-01-13 21:52:01 +00003970 else if (FnInfo->isStr("memcmp"))
Anna Zaks22122702012-01-17 00:37:07 +00003971 return Builtin::BImemcmp;
Clement Courbet8c3343d2019-02-14 12:00:34 +00003972 else if (FnInfo->isStr("bcmp"))
3973 return Builtin::BIbcmp;
Anna Zaks201d4892012-01-13 21:52:01 +00003974 else if (FnInfo->isStr("strncpy"))
Anna Zaks22122702012-01-17 00:37:07 +00003975 return Builtin::BIstrncpy;
Anna Zaks201d4892012-01-13 21:52:01 +00003976 else if (FnInfo->isStr("strncmp"))
Anna Zaks22122702012-01-17 00:37:07 +00003977 return Builtin::BIstrncmp;
Anna Zaks201d4892012-01-13 21:52:01 +00003978 else if (FnInfo->isStr("strncasecmp"))
Anna Zaks22122702012-01-17 00:37:07 +00003979 return Builtin::BIstrncasecmp;
Anna Zaks201d4892012-01-13 21:52:01 +00003980 else if (FnInfo->isStr("strncat"))
Anna Zaks22122702012-01-17 00:37:07 +00003981 return Builtin::BIstrncat;
Anna Zaks201d4892012-01-13 21:52:01 +00003982 else if (FnInfo->isStr("strndup"))
Anna Zaks22122702012-01-17 00:37:07 +00003983 return Builtin::BIstrndup;
Anna Zaks314cd092012-02-01 19:08:57 +00003984 else if (FnInfo->isStr("strlen"))
3985 return Builtin::BIstrlen;
Bruno Cardoso Lopes7ea9fd22016-08-10 18:34:47 +00003986 else if (FnInfo->isStr("bzero"))
3987 return Builtin::BIbzero;
Anna Zaks201d4892012-01-13 21:52:01 +00003988 }
3989 break;
3990 }
Anna Zaks22122702012-01-17 00:37:07 +00003991 return 0;
Anna Zaks201d4892012-01-13 21:52:01 +00003992}
3993
Richard Trieu27c1b1a2018-07-10 01:40:50 +00003994unsigned FunctionDecl::getODRHash() const {
Erich Keane9c665062018-08-01 21:02:40 +00003995 assert(hasODRHash());
Richard Trieu27c1b1a2018-07-10 01:40:50 +00003996 return ODRHash;
3997}
3998
Richard Trieue6caa262017-12-23 00:41:01 +00003999unsigned FunctionDecl::getODRHash() {
Erich Keane9c665062018-08-01 21:02:40 +00004000 if (hasODRHash())
Richard Trieue6caa262017-12-23 00:41:01 +00004001 return ODRHash;
4002
Richard Trieu0ac2eb72018-02-22 05:50:29 +00004003 if (auto *FT = getInstantiatedFromMemberFunction()) {
Erich Keane9c665062018-08-01 21:02:40 +00004004 setHasODRHash(true);
Richard Trieu0ac2eb72018-02-22 05:50:29 +00004005 ODRHash = FT->getODRHash();
4006 return ODRHash;
4007 }
4008
Richard Trieue6caa262017-12-23 00:41:01 +00004009 class ODRHash Hash;
4010 Hash.AddFunctionDecl(this);
Erich Keane9c665062018-08-01 21:02:40 +00004011 setHasODRHash(true);
Richard Trieue6caa262017-12-23 00:41:01 +00004012 ODRHash = Hash.CalculateHash();
4013 return ODRHash;
4014}
4015
Chris Lattner59a25942008-03-31 00:36:02 +00004016//===----------------------------------------------------------------------===//
Sebastian Redl833ef452010-01-26 22:01:41 +00004017// FieldDecl Implementation
4018//===----------------------------------------------------------------------===//
4019
Jay Foad39c79802011-01-12 09:06:06 +00004020FieldDecl *FieldDecl::Create(const ASTContext &C, DeclContext *DC,
Abramo Bagnaradff19302011-03-08 08:55:46 +00004021 SourceLocation StartLoc, SourceLocation IdLoc,
4022 IdentifierInfo *Id, QualType T,
Richard Smith938f40b2011-06-11 17:19:42 +00004023 TypeSourceInfo *TInfo, Expr *BW, bool Mutable,
Richard Smith2b013182012-06-10 03:12:00 +00004024 InClassInitStyle InitStyle) {
Richard Smithf7981722013-11-22 09:01:48 +00004025 return new (C, DC) FieldDecl(Decl::Field, DC, StartLoc, IdLoc, Id, T, TInfo,
4026 BW, Mutable, InitStyle);
Sebastian Redl833ef452010-01-26 22:01:41 +00004027}
4028
Douglas Gregor72172e92012-01-05 21:55:30 +00004029FieldDecl *FieldDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Craig Topper36250ad2014-05-12 05:36:57 +00004030 return new (C, ID) FieldDecl(Field, nullptr, SourceLocation(),
4031 SourceLocation(), nullptr, QualType(), nullptr,
4032 nullptr, false, ICIS_NoInit);
Douglas Gregor72172e92012-01-05 21:55:30 +00004033}
4034
Sebastian Redl833ef452010-01-26 22:01:41 +00004035bool FieldDecl::isAnonymousStructOrUnion() const {
4036 if (!isImplicit() || getDeclName())
4037 return false;
4038
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004039 if (const auto *Record = getType()->getAs<RecordType>())
Sebastian Redl833ef452010-01-26 22:01:41 +00004040 return Record->getDecl()->isAnonymousStructOrUnion();
4041
4042 return false;
4043}
4044
Richard Smithcaf33902011-10-10 18:28:20 +00004045unsigned FieldDecl::getBitWidthValue(const ASTContext &Ctx) const {
4046 assert(isBitField() && "not a bitfield");
Richard Smith6b8e3c02017-08-28 00:28:14 +00004047 return getBitWidth()->EvaluateKnownConstInt(Ctx).getZExtValue();
Richard Smithcaf33902011-10-10 18:28:20 +00004048}
4049
Richard Smith866dee42018-04-02 18:29:43 +00004050bool FieldDecl::isZeroLengthBitField(const ASTContext &Ctx) const {
4051 return isUnnamedBitfield() && !getBitWidth()->isValueDependent() &&
4052 getBitWidthValue(Ctx) == 0;
4053}
4054
Richard Smith78b239e2019-06-20 20:44:45 +00004055bool FieldDecl::isZeroSize(const ASTContext &Ctx) const {
4056 if (isZeroLengthBitField(Ctx))
4057 return true;
4058
4059 // C++2a [intro.object]p7:
4060 // An object has nonzero size if it
4061 // -- is not a potentially-overlapping subobject, or
4062 if (!hasAttr<NoUniqueAddressAttr>())
4063 return false;
4064
4065 // -- is not of class type, or
4066 const auto *RT = getType()->getAs<RecordType>();
4067 if (!RT)
4068 return false;
4069 const RecordDecl *RD = RT->getDecl()->getDefinition();
4070 if (!RD) {
4071 assert(isInvalidDecl() && "valid field has incomplete type");
4072 return false;
4073 }
4074
4075 // -- [has] virtual member functions or virtual base classes, or
4076 // -- has subobjects of nonzero size or bit-fields of nonzero length
4077 const auto *CXXRD = cast<CXXRecordDecl>(RD);
4078 if (!CXXRD->isEmpty())
4079 return false;
4080
4081 // Otherwise, [...] the circumstances under which the object has zero size
4082 // are implementation-defined.
4083 // FIXME: This might be Itanium ABI specific; we don't yet know what the MS
4084 // ABI will do.
4085 return true;
4086}
4087
John McCall4e819612011-01-20 07:57:12 +00004088unsigned FieldDecl::getFieldIndex() const {
Richard Smith0b87e072013-10-07 08:02:11 +00004089 const FieldDecl *Canonical = getCanonicalDecl();
4090 if (Canonical != this)
4091 return Canonical->getFieldIndex();
4092
John McCall4e819612011-01-20 07:57:12 +00004093 if (CachedFieldIndex) return CachedFieldIndex - 1;
4094
Richard Smithd62306a2011-11-10 06:34:14 +00004095 unsigned Index = 0;
Richard Smith85567dd2017-11-15 01:33:46 +00004096 const RecordDecl *RD = getParent()->getDefinition();
4097 assert(RD && "requested index for field of struct with no definition");
Richard Smithd62306a2011-11-10 06:34:14 +00004098
Hans Wennborga302cd92014-08-21 16:06:57 +00004099 for (auto *Field : RD->fields()) {
4100 Field->getCanonicalDecl()->CachedFieldIndex = Index + 1;
4101 ++Index;
4102 }
John McCall4e819612011-01-20 07:57:12 +00004103
Richard Smithd62306a2011-11-10 06:34:14 +00004104 assert(CachedFieldIndex && "failed to find field in parent");
4105 return CachedFieldIndex - 1;
John McCall4e819612011-01-20 07:57:12 +00004106}
4107
Abramo Bagnara20c9e242011-03-08 11:07:11 +00004108SourceRange FieldDecl::getSourceRange() const {
Richard Smith6b8e3c02017-08-28 00:28:14 +00004109 const Expr *FinalExpr = getInClassInitializer();
4110 if (!FinalExpr)
4111 FinalExpr = getBitWidth();
4112 if (FinalExpr)
Stephen Kelly1c301dc2018-08-09 21:09:38 +00004113 return SourceRange(getInnerLocStart(), FinalExpr->getEndLoc());
Richard Smith6b8e3c02017-08-28 00:28:14 +00004114 return DeclaratorDecl::getSourceRange();
Alexey Bataev39c81e22014-08-28 04:28:19 +00004115}
4116
4117void FieldDecl::setCapturedVLAType(const VariableArrayType *VLAType) {
David Blaikie11ab0782014-10-31 17:18:09 +00004118 assert((getParent()->isLambda() || getParent()->isCapturedRecord()) &&
Alexey Bataev330de032014-10-29 12:21:55 +00004119 "capturing type in non-lambda or captured record.");
Richard Smith6b8e3c02017-08-28 00:28:14 +00004120 assert(InitStorage.getInt() == ISK_NoInit &&
John McCallc90c1492014-10-10 18:44:34 +00004121 InitStorage.getPointer() == nullptr &&
Alexey Bataev39c81e22014-08-28 04:28:19 +00004122 "bit width, initializer or captured type already set");
John McCallc90c1492014-10-10 18:44:34 +00004123 InitStorage.setPointerAndInt(const_cast<VariableArrayType *>(VLAType),
4124 ISK_CapturedVLAType);
Alexey Bataev39c81e22014-08-28 04:28:19 +00004125}
4126
Sebastian Redl833ef452010-01-26 22:01:41 +00004127//===----------------------------------------------------------------------===//
Douglas Gregor9ac7a072009-01-07 00:43:41 +00004128// TagDecl Implementation
Ted Kremenek21475702008-09-05 17:16:31 +00004129//===----------------------------------------------------------------------===//
4130
Erich Keanef92f31c2018-08-01 20:48:16 +00004131TagDecl::TagDecl(Kind DK, TagKind TK, const ASTContext &C, DeclContext *DC,
4132 SourceLocation L, IdentifierInfo *Id, TagDecl *PrevDecl,
4133 SourceLocation StartL)
4134 : TypeDecl(DK, DC, L, Id, StartL), DeclContext(DK), redeclarable_base(C),
4135 TypedefNameDeclOrQualifier((TypedefNameDecl *)nullptr) {
4136 assert((DK != Enum || TK == TTK_Enum) &&
4137 "EnumDecl not matched with TTK_Enum");
4138 setPreviousDecl(PrevDecl);
4139 setTagKind(TK);
4140 setCompleteDefinition(false);
4141 setBeingDefined(false);
4142 setEmbeddedInDeclarator(false);
4143 setFreeStanding(false);
4144 setCompleteDefinitionRequired(false);
4145}
4146
Douglas Gregorec9c6ae2010-07-06 18:42:40 +00004147SourceLocation TagDecl::getOuterLocStart() const {
4148 return getTemplateOrInnerLocStart(this);
4149}
4150
Argyrios Kyrtzidis575fa052009-07-14 03:17:17 +00004151SourceRange TagDecl::getSourceRange() const {
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00004152 SourceLocation RBraceLoc = BraceRange.getEnd();
Argyrios Kyrtzidis575fa052009-07-14 03:17:17 +00004153 SourceLocation E = RBraceLoc.isValid() ? RBraceLoc : getLocation();
Douglas Gregorec9c6ae2010-07-06 18:42:40 +00004154 return SourceRange(getOuterLocStart(), E);
Argyrios Kyrtzidis575fa052009-07-14 03:17:17 +00004155}
4156
Rafael Espindola8db352d2013-10-17 15:37:26 +00004157TagDecl *TagDecl::getCanonicalDecl() { return getFirstDecl(); }
Argyrios Kyrtzidis5614aef2009-07-18 00:34:07 +00004158
Rafael Espindolabf5c33b2013-03-12 21:06:00 +00004159void TagDecl::setTypedefNameForAnonDecl(TypedefNameDecl *TDD) {
David Majnemer00350522015-08-31 18:48:39 +00004160 TypedefNameDeclOrQualifier = TDD;
Reid Klecknercae82a22014-04-23 22:03:04 +00004161 if (const Type *T = getTypeForDecl()) {
4162 (void)T;
Richard Smith5b21db82014-04-23 18:20:42 +00004163 assert(T->isLinkageValid());
Reid Klecknercae82a22014-04-23 22:03:04 +00004164 }
Rafael Espindola0e0d0092013-03-14 03:07:35 +00004165 assert(isLinkageValid());
Douglas Gregora72a4e32010-05-19 18:39:18 +00004166}
4167
Douglas Gregordee1be82009-01-17 00:42:38 +00004168void TagDecl::startDefinition() {
Erich Keanef92f31c2018-08-01 20:48:16 +00004169 setBeingDefined(true);
John McCall67da35c2010-02-04 22:26:26 +00004170
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004171 if (auto *D = dyn_cast<CXXRecordDecl>(this)) {
Richard Smith053f6c62014-05-16 23:01:30 +00004172 struct CXXRecordDecl::DefinitionData *Data =
John McCall67da35c2010-02-04 22:26:26 +00004173 new (getASTContext()) struct CXXRecordDecl::DefinitionData(D);
Aaron Ballman86c93902014-03-06 23:45:36 +00004174 for (auto I : redecls())
Richard Smith64c06302014-05-22 23:19:02 +00004175 cast<CXXRecordDecl>(I)->DefinitionData = Data;
John McCall67da35c2010-02-04 22:26:26 +00004176 }
Douglas Gregordee1be82009-01-17 00:42:38 +00004177}
4178
4179void TagDecl::completeDefinition() {
John McCallae580fe2010-02-05 01:33:36 +00004180 assert((!isa<CXXRecordDecl>(this) ||
4181 cast<CXXRecordDecl>(this)->hasDefinition()) &&
4182 "definition completed but not started");
4183
Erich Keanef92f31c2018-08-01 20:48:16 +00004184 setCompleteDefinition(true);
4185 setBeingDefined(false);
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00004186
4187 if (ASTMutationListener *L = getASTMutationListener())
4188 L->CompletedTagDefinition(this);
Douglas Gregordee1be82009-01-17 00:42:38 +00004189}
4190
John McCallf937c022011-10-07 06:10:15 +00004191TagDecl *TagDecl::getDefinition() const {
4192 if (isCompleteDefinition())
Douglas Gregorb6b8f9e2009-07-29 23:36:44 +00004193 return const_cast<TagDecl *>(this);
Douglas Gregor7dab26b2013-02-09 01:35:03 +00004194
4195 // If it's possible for us to have an out-of-date definition, check now.
Erich Keanef92f31c2018-08-01 20:48:16 +00004196 if (mayHaveOutOfDateDef()) {
Douglas Gregor7dab26b2013-02-09 01:35:03 +00004197 if (IdentifierInfo *II = getIdentifier()) {
4198 if (II->isOutOfDate()) {
4199 updateOutOfDate(*II);
4200 }
4201 }
4202 }
4203
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004204 if (const auto *CXXRD = dyn_cast<CXXRecordDecl>(this))
Andrew Trickba266ee2010-10-19 21:54:32 +00004205 return CXXRD->getDefinition();
Mike Stump11289f42009-09-09 15:08:12 +00004206
Aaron Ballman86c93902014-03-06 23:45:36 +00004207 for (auto R : redecls())
John McCallf937c022011-10-07 06:10:15 +00004208 if (R->isCompleteDefinition())
Aaron Ballman86c93902014-03-06 23:45:36 +00004209 return R;
Mike Stump11289f42009-09-09 15:08:12 +00004210
Craig Topper36250ad2014-05-12 05:36:57 +00004211 return nullptr;
Ted Kremenek21475702008-09-05 17:16:31 +00004212}
4213
Douglas Gregor14454802011-02-25 02:25:35 +00004214void TagDecl::setQualifierInfo(NestedNameSpecifierLoc QualifierLoc) {
4215 if (QualifierLoc) {
John McCall3e11ebe2010-03-15 10:12:16 +00004216 // Make sure the extended qualifier info is allocated.
4217 if (!hasExtInfo())
David Majnemer00350522015-08-31 18:48:39 +00004218 TypedefNameDeclOrQualifier = new (getASTContext()) ExtInfo;
John McCall3e11ebe2010-03-15 10:12:16 +00004219 // Set qualifier info.
Douglas Gregor14454802011-02-25 02:25:35 +00004220 getExtInfo()->QualifierLoc = QualifierLoc;
Chad Rosier6fdf38b2011-08-17 23:08:45 +00004221 } else {
John McCall3e11ebe2010-03-15 10:12:16 +00004222 // Here Qualifier == 0, i.e., we are removing the qualifier (if any).
John McCall3e11ebe2010-03-15 10:12:16 +00004223 if (hasExtInfo()) {
Abramo Bagnara60804e12011-03-18 15:16:37 +00004224 if (getExtInfo()->NumTemplParamLists == 0) {
4225 getASTContext().Deallocate(getExtInfo());
David Majnemer00350522015-08-31 18:48:39 +00004226 TypedefNameDeclOrQualifier = (TypedefNameDecl *)nullptr;
Abramo Bagnara60804e12011-03-18 15:16:37 +00004227 }
4228 else
4229 getExtInfo()->QualifierLoc = QualifierLoc;
John McCall3e11ebe2010-03-15 10:12:16 +00004230 }
4231 }
4232}
4233
Benjamin Kramer9cc210652015-08-05 09:40:49 +00004234void TagDecl::setTemplateParameterListsInfo(
4235 ASTContext &Context, ArrayRef<TemplateParameterList *> TPLists) {
4236 assert(!TPLists.empty());
Abramo Bagnara60804e12011-03-18 15:16:37 +00004237 // Make sure the extended decl info is allocated.
4238 if (!hasExtInfo())
4239 // Allocate external info struct.
David Majnemer00350522015-08-31 18:48:39 +00004240 TypedefNameDeclOrQualifier = new (getASTContext()) ExtInfo;
Abramo Bagnara60804e12011-03-18 15:16:37 +00004241 // Set the template parameter lists info.
Benjamin Kramer9cc210652015-08-05 09:40:49 +00004242 getExtInfo()->setTemplateParameterListsInfo(Context, TPLists);
Abramo Bagnara60804e12011-03-18 15:16:37 +00004243}
4244
Ted Kremenek21475702008-09-05 17:16:31 +00004245//===----------------------------------------------------------------------===//
Sebastian Redl833ef452010-01-26 22:01:41 +00004246// EnumDecl Implementation
4247//===----------------------------------------------------------------------===//
4248
Erich Keanef92f31c2018-08-01 20:48:16 +00004249EnumDecl::EnumDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
4250 SourceLocation IdLoc, IdentifierInfo *Id, EnumDecl *PrevDecl,
4251 bool Scoped, bool ScopedUsingClassTag, bool Fixed)
4252 : TagDecl(Enum, TTK_Enum, C, DC, IdLoc, Id, PrevDecl, StartLoc) {
4253 assert(Scoped || !ScopedUsingClassTag);
4254 IntegerType = nullptr;
4255 setNumPositiveBits(0);
4256 setNumNegativeBits(0);
4257 setScoped(Scoped);
4258 setScopedUsingClassTag(ScopedUsingClassTag);
4259 setFixed(Fixed);
4260 setHasODRHash(false);
4261 ODRHash = 0;
4262}
4263
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004264void EnumDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004265
Abramo Bagnara29c2d462011-03-09 14:09:51 +00004266EnumDecl *EnumDecl::Create(ASTContext &C, DeclContext *DC,
4267 SourceLocation StartLoc, SourceLocation IdLoc,
4268 IdentifierInfo *Id,
Abramo Bagnara0e05e242010-12-03 18:54:17 +00004269 EnumDecl *PrevDecl, bool IsScoped,
4270 bool IsScopedUsingClassTag, bool IsFixed) {
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004271 auto *Enum = new (C, DC) EnumDecl(C, DC, StartLoc, IdLoc, Id, PrevDecl,
4272 IsScoped, IsScopedUsingClassTag, IsFixed);
Erich Keanef92f31c2018-08-01 20:48:16 +00004273 Enum->setMayHaveOutOfDateDef(C.getLangOpts().Modules);
Sebastian Redl833ef452010-01-26 22:01:41 +00004274 C.getTypeDeclType(Enum, PrevDecl);
4275 return Enum;
4276}
4277
Douglas Gregor72172e92012-01-05 21:55:30 +00004278EnumDecl *EnumDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00004279 EnumDecl *Enum =
4280 new (C, ID) EnumDecl(C, nullptr, SourceLocation(), SourceLocation(),
4281 nullptr, nullptr, false, false, false);
Erich Keanef92f31c2018-08-01 20:48:16 +00004282 Enum->setMayHaveOutOfDateDef(C.getLangOpts().Modules);
Douglas Gregor7dab26b2013-02-09 01:35:03 +00004283 return Enum;
Argyrios Kyrtzidis39f0e302010-07-02 11:54:55 +00004284}
4285
Alp Tokerb9fa5122014-01-06 11:31:18 +00004286SourceRange EnumDecl::getIntegerTypeRange() const {
4287 if (const TypeSourceInfo *TI = getIntegerTypeSourceInfo())
4288 return TI->getTypeLoc().getSourceRange();
4289 return SourceRange();
4290}
4291
Douglas Gregord5058122010-02-11 01:19:42 +00004292void EnumDecl::completeDefinition(QualType NewType,
John McCall9aa35be2010-05-06 08:49:23 +00004293 QualType NewPromotionType,
4294 unsigned NumPositiveBits,
4295 unsigned NumNegativeBits) {
John McCallf937c022011-10-07 06:10:15 +00004296 assert(!isCompleteDefinition() && "Cannot redefine enums!");
Douglas Gregor0bf31402010-10-08 23:50:27 +00004297 if (!IntegerType)
4298 IntegerType = NewType.getTypePtr();
Sebastian Redl833ef452010-01-26 22:01:41 +00004299 PromotionType = NewPromotionType;
John McCall9aa35be2010-05-06 08:49:23 +00004300 setNumPositiveBits(NumPositiveBits);
4301 setNumNegativeBits(NumNegativeBits);
Sebastian Redl833ef452010-01-26 22:01:41 +00004302 TagDecl::completeDefinition();
4303}
4304
Akira Hatanaka3c268af2017-03-21 02:23:00 +00004305bool EnumDecl::isClosed() const {
4306 if (const auto *A = getAttr<EnumExtensibilityAttr>())
4307 return A->getExtensibility() == EnumExtensibilityAttr::Closed;
4308 return true;
4309}
4310
4311bool EnumDecl::isClosedFlag() const {
4312 return isClosed() && hasAttr<FlagEnumAttr>();
4313}
4314
4315bool EnumDecl::isClosedNonFlag() const {
4316 return isClosed() && !hasAttr<FlagEnumAttr>();
4317}
4318
Richard Smith7d137e32012-03-23 03:33:32 +00004319TemplateSpecializationKind EnumDecl::getTemplateSpecializationKind() const {
4320 if (MemberSpecializationInfo *MSI = getMemberSpecializationInfo())
4321 return MSI->getTemplateSpecializationKind();
4322
4323 return TSK_Undeclared;
4324}
4325
4326void EnumDecl::setTemplateSpecializationKind(TemplateSpecializationKind TSK,
4327 SourceLocation PointOfInstantiation) {
4328 MemberSpecializationInfo *MSI = getMemberSpecializationInfo();
4329 assert(MSI && "Not an instantiated member enumeration?");
4330 MSI->setTemplateSpecializationKind(TSK);
4331 if (TSK != TSK_ExplicitSpecialization &&
4332 PointOfInstantiation.isValid() &&
4333 MSI->getPointOfInstantiation().isInvalid())
4334 MSI->setPointOfInstantiation(PointOfInstantiation);
4335}
4336
Richard Smith6739a102016-05-05 00:56:12 +00004337EnumDecl *EnumDecl::getTemplateInstantiationPattern() const {
4338 if (MemberSpecializationInfo *MSInfo = getMemberSpecializationInfo()) {
4339 if (isTemplateInstantiation(MSInfo->getTemplateSpecializationKind())) {
4340 EnumDecl *ED = getInstantiatedFromMemberEnum();
4341 while (auto *NewED = ED->getInstantiatedFromMemberEnum())
4342 ED = NewED;
Richard Smith2195ec92017-04-21 01:15:13 +00004343 return getDefinitionOrSelf(ED);
Richard Smith6739a102016-05-05 00:56:12 +00004344 }
4345 }
4346
4347 assert(!isTemplateInstantiation(getTemplateSpecializationKind()) &&
4348 "couldn't find pattern for enum instantiation");
4349 return nullptr;
4350}
4351
Richard Smith4b38ded2012-03-14 23:13:10 +00004352EnumDecl *EnumDecl::getInstantiatedFromMemberEnum() const {
4353 if (SpecializationInfo)
4354 return cast<EnumDecl>(SpecializationInfo->getInstantiatedFrom());
4355
Craig Topper36250ad2014-05-12 05:36:57 +00004356 return nullptr;
Richard Smith4b38ded2012-03-14 23:13:10 +00004357}
4358
4359void EnumDecl::setInstantiationOfMemberEnum(ASTContext &C, EnumDecl *ED,
4360 TemplateSpecializationKind TSK) {
4361 assert(!SpecializationInfo && "Member enum is already a specialization");
4362 SpecializationInfo = new (C) MemberSpecializationInfo(ED, TSK);
4363}
4364
Richard Trieuab4d7302018-07-25 22:52:05 +00004365unsigned EnumDecl::getODRHash() {
Erich Keanef92f31c2018-08-01 20:48:16 +00004366 if (hasODRHash())
Richard Trieuab4d7302018-07-25 22:52:05 +00004367 return ODRHash;
4368
4369 class ODRHash Hash;
4370 Hash.AddEnumDecl(this);
Erich Keanef92f31c2018-08-01 20:48:16 +00004371 setHasODRHash(true);
Richard Trieuab4d7302018-07-25 22:52:05 +00004372 ODRHash = Hash.CalculateHash();
4373 return ODRHash;
4374}
4375
Sebastian Redl833ef452010-01-26 22:01:41 +00004376//===----------------------------------------------------------------------===//
Chris Lattner59a25942008-03-31 00:36:02 +00004377// RecordDecl Implementation
4378//===----------------------------------------------------------------------===//
Chris Lattner41943152007-01-25 04:52:46 +00004379
Richard Smith053f6c62014-05-16 23:01:30 +00004380RecordDecl::RecordDecl(Kind DK, TagKind TK, const ASTContext &C,
4381 DeclContext *DC, SourceLocation StartLoc,
4382 SourceLocation IdLoc, IdentifierInfo *Id,
4383 RecordDecl *PrevDecl)
Erich Keanef92f31c2018-08-01 20:48:16 +00004384 : TagDecl(DK, TK, C, DC, IdLoc, Id, PrevDecl, StartLoc) {
4385 assert(classof(static_cast<Decl *>(this)) && "Invalid Kind!");
4386 setHasFlexibleArrayMember(false);
4387 setAnonymousStructOrUnion(false);
4388 setHasObjectMember(false);
4389 setHasVolatileMember(false);
4390 setHasLoadedFieldsFromExternalStorage(false);
4391 setNonTrivialToPrimitiveDefaultInitialize(false);
4392 setNonTrivialToPrimitiveCopy(false);
4393 setNonTrivialToPrimitiveDestroy(false);
Akira Hatanaka09051062019-09-07 00:34:43 +00004394 setHasNonTrivialToPrimitiveDefaultInitializeCUnion(false);
4395 setHasNonTrivialToPrimitiveDestructCUnion(false);
4396 setHasNonTrivialToPrimitiveCopyCUnion(false);
Erich Keanef92f31c2018-08-01 20:48:16 +00004397 setParamDestroyedInCallee(false);
4398 setArgPassingRestrictions(APK_CanPassInRegs);
Ted Kremenek52baf502008-09-02 21:12:32 +00004399}
4400
Jay Foad39c79802011-01-12 09:06:06 +00004401RecordDecl *RecordDecl::Create(const ASTContext &C, TagKind TK, DeclContext *DC,
Abramo Bagnara29c2d462011-03-09 14:09:51 +00004402 SourceLocation StartLoc, SourceLocation IdLoc,
4403 IdentifierInfo *Id, RecordDecl* PrevDecl) {
Richard Smith053f6c62014-05-16 23:01:30 +00004404 RecordDecl *R = new (C, DC) RecordDecl(Record, TK, C, DC,
4405 StartLoc, IdLoc, Id, PrevDecl);
Erich Keanef92f31c2018-08-01 20:48:16 +00004406 R->setMayHaveOutOfDateDef(C.getLangOpts().Modules);
Douglas Gregor7dab26b2013-02-09 01:35:03 +00004407
Ted Kremenek21475702008-09-05 17:16:31 +00004408 C.getTypeDeclType(R, PrevDecl);
4409 return R;
Ted Kremenek52baf502008-09-02 21:12:32 +00004410}
4411
Douglas Gregor72172e92012-01-05 21:55:30 +00004412RecordDecl *RecordDecl::CreateDeserialized(const ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00004413 RecordDecl *R =
4414 new (C, ID) RecordDecl(Record, TTK_Struct, C, nullptr, SourceLocation(),
4415 SourceLocation(), nullptr, nullptr);
Erich Keanef92f31c2018-08-01 20:48:16 +00004416 R->setMayHaveOutOfDateDef(C.getLangOpts().Modules);
Douglas Gregor7dab26b2013-02-09 01:35:03 +00004417 return R;
Argyrios Kyrtzidis39f0e302010-07-02 11:54:55 +00004418}
4419
Douglas Gregordfcad112009-03-25 15:59:44 +00004420bool RecordDecl::isInjectedClassName() const {
Mike Stump11289f42009-09-09 15:08:12 +00004421 return isImplicit() && getDeclName() && getDeclContext()->isRecord() &&
Douglas Gregordfcad112009-03-25 15:59:44 +00004422 cast<RecordDecl>(getDeclContext())->getDeclName() == getDeclName();
4423}
4424
Alexey Bataev39c81e22014-08-28 04:28:19 +00004425bool RecordDecl::isLambda() const {
4426 if (auto RD = dyn_cast<CXXRecordDecl>(this))
4427 return RD->isLambda();
4428 return false;
4429}
4430
Alexey Bataev330de032014-10-29 12:21:55 +00004431bool RecordDecl::isCapturedRecord() const {
4432 return hasAttr<CapturedRecordAttr>();
4433}
4434
4435void RecordDecl::setCapturedRecord() {
4436 addAttr(CapturedRecordAttr::CreateImplicit(getASTContext()));
4437}
4438
Momchil Velikov102b4102020-04-28 16:27:52 +01004439bool RecordDecl::isOrContainsUnion() const {
4440 if (isUnion())
4441 return true;
4442
4443 if (const RecordDecl *Def = getDefinition()) {
4444 for (const FieldDecl *FD : Def->fields()) {
4445 const RecordType *RT = FD->getType()->getAs<RecordType>();
4446 if (RT && RT->getDecl()->isOrContainsUnion())
4447 return true;
4448 }
4449 }
4450
4451 return false;
4452}
4453
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004454RecordDecl::field_iterator RecordDecl::field_begin() const {
Erich Keanef92f31c2018-08-01 20:48:16 +00004455 if (hasExternalLexicalStorage() && !hasLoadedFieldsFromExternalStorage())
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004456 LoadFieldsFromExternalStorage();
4457
4458 return field_iterator(decl_iterator(FirstDecl));
4459}
4460
Douglas Gregorb11aad82011-02-19 18:51:44 +00004461/// completeDefinition - Notes that the definition of this type is now
4462/// complete.
4463void RecordDecl::completeDefinition() {
John McCallf937c022011-10-07 06:10:15 +00004464 assert(!isCompleteDefinition() && "Cannot redefine record!");
Douglas Gregorb11aad82011-02-19 18:51:44 +00004465 TagDecl::completeDefinition();
4466}
4467
Eli Friedman9ee2d0472012-10-12 23:29:20 +00004468/// isMsStruct - Get whether or not this record uses ms_struct layout.
4469/// This which can be turned on with an attribute, pragma, or the
4470/// -mms-bitfields command-line option.
4471bool RecordDecl::isMsStruct(const ASTContext &C) const {
David Majnemer8ab003a2015-02-02 19:30:52 +00004472 return hasAttr<MSStructAttr>() || C.getLangOpts().MSBitfields == 1;
Eli Friedman9ee2d0472012-10-12 23:29:20 +00004473}
4474
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004475void RecordDecl::LoadFieldsFromExternalStorage() const {
4476 ExternalASTSource *Source = getASTContext().getExternalSource();
4477 assert(hasExternalLexicalStorage() && Source && "No external storage?");
4478
4479 // Notify that we have a RecordDecl doing some initialization.
4480 ExternalASTSource::Deserializing TheFields(Source);
4481
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004482 SmallVector<Decl*, 64> Decls;
Erich Keanef92f31c2018-08-01 20:48:16 +00004483 setHasLoadedFieldsFromExternalStorage(true);
Richard Smith3cb15722015-08-05 22:41:45 +00004484 Source->FindExternalLexicalDecls(this, [](Decl::Kind K) {
4485 return FieldDecl::classofKind(K) || IndirectFieldDecl::classofKind(K);
4486 }, Decls);
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004487
4488#ifndef NDEBUG
4489 // Check that all decls we got were FieldDecls.
4490 for (unsigned i=0, e=Decls.size(); i != e; ++i)
Argyrios Kyrtzidisf89a9272012-09-10 22:04:22 +00004491 assert(isa<FieldDecl>(Decls[i]) || isa<IndirectFieldDecl>(Decls[i]));
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004492#endif
4493
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004494 if (Decls.empty())
4495 return;
4496
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00004497 std::tie(FirstDecl, LastDecl) = BuildDeclChain(Decls,
Argyrios Kyrtzidis094da732011-10-07 21:55:43 +00004498 /*FieldsAlreadyLoaded=*/false);
Argyrios Kyrtzidis0e88a562010-10-14 20:14:34 +00004499}
4500
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00004501bool RecordDecl::mayInsertExtraPadding(bool EmitRemark) const {
4502 ASTContext &Context = getASTContext();
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00004503 const SanitizerMask EnabledAsanMask = Context.getLangOpts().Sanitize.Mask &
4504 (SanitizerKind::Address | SanitizerKind::KernelAddress);
4505 if (!EnabledAsanMask || !Context.getLangOpts().SanitizeAddressFieldPadding)
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00004506 return false;
Alexey Samsonov33e00e22014-10-16 23:50:26 +00004507 const auto &Blacklist = Context.getSanitizerBlacklist();
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004508 const auto *CXXRD = dyn_cast<CXXRecordDecl>(this);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00004509 // We may be able to relax some of these requirements.
4510 int ReasonToReject = -1;
4511 if (!CXXRD || CXXRD->isExternCContext())
4512 ReasonToReject = 0; // is not C++.
4513 else if (CXXRD->hasAttr<PackedAttr>())
4514 ReasonToReject = 1; // is packed.
4515 else if (CXXRD->isUnion())
4516 ReasonToReject = 2; // is a union.
4517 else if (CXXRD->isTriviallyCopyable())
4518 ReasonToReject = 3; // is trivially copyable.
4519 else if (CXXRD->hasTrivialDestructor())
4520 ReasonToReject = 4; // has trivial destructor.
4521 else if (CXXRD->isStandardLayout())
4522 ReasonToReject = 5; // is standard layout.
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00004523 else if (Blacklist.isBlacklistedLocation(EnabledAsanMask, getLocation(),
4524 "field-padding"))
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00004525 ReasonToReject = 6; // is in a blacklisted file.
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +00004526 else if (Blacklist.isBlacklistedType(EnabledAsanMask,
4527 getQualifiedNameAsString(),
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00004528 "field-padding"))
4529 ReasonToReject = 7; // is blacklisted.
4530
4531 if (EmitRemark) {
4532 if (ReasonToReject >= 0)
4533 Context.getDiagnostics().Report(
4534 getLocation(),
4535 diag::remark_sanitize_address_insert_extra_padding_rejected)
4536 << getQualifiedNameAsString() << ReasonToReject;
4537 else
4538 Context.getDiagnostics().Report(
4539 getLocation(),
4540 diag::remark_sanitize_address_insert_extra_padding_accepted)
4541 << getQualifiedNameAsString();
4542 }
4543 return ReasonToReject < 0;
4544}
4545
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00004546const FieldDecl *RecordDecl::findFirstNamedDataMember() const {
4547 for (const auto *I : fields()) {
4548 if (I->getIdentifier())
4549 return I;
4550
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004551 if (const auto *RT = I->getType()->getAs<RecordType>())
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00004552 if (const FieldDecl *NamedDataMember =
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004553 RT->getDecl()->findFirstNamedDataMember())
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00004554 return NamedDataMember;
4555 }
4556
4557 // We didn't find a named data member.
4558 return nullptr;
4559}
4560
Steve Naroff415d3d52008-10-08 17:01:13 +00004561//===----------------------------------------------------------------------===//
4562// BlockDecl Implementation
4563//===----------------------------------------------------------------------===//
4564
Erich Keanec9d29902018-08-01 21:16:54 +00004565BlockDecl::BlockDecl(DeclContext *DC, SourceLocation CaretLoc)
4566 : Decl(Block, DC, CaretLoc), DeclContext(Block) {
4567 setIsVariadic(false);
4568 setCapturesCXXThis(false);
4569 setBlockMissingReturnType(true);
4570 setIsConversionFromLambda(false);
4571 setDoesNotEscape(false);
Akira Hatanakac5792aa2019-02-27 18:17:16 +00004572 setCanAvoidCopyToHeap(false);
Erich Keanec9d29902018-08-01 21:16:54 +00004573}
4574
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004575void BlockDecl::setParams(ArrayRef<ParmVarDecl *> NewParamInfo) {
Craig Topper36250ad2014-05-12 05:36:57 +00004576 assert(!ParamInfo && "Already has param info!");
Mike Stump11289f42009-09-09 15:08:12 +00004577
Steve Naroffc4b30e52009-03-13 16:56:44 +00004578 // Zero params -> null pointer.
David Blaikie9c70e042011-09-21 18:16:56 +00004579 if (!NewParamInfo.empty()) {
4580 NumParams = NewParamInfo.size();
4581 ParamInfo = new (getASTContext()) ParmVarDecl*[NewParamInfo.size()];
4582 std::copy(NewParamInfo.begin(), NewParamInfo.end(), ParamInfo);
Steve Naroffc4b30e52009-03-13 16:56:44 +00004583 }
4584}
4585
Benjamin Kramerb40e4af2015-08-05 09:40:35 +00004586void BlockDecl::setCaptures(ASTContext &Context, ArrayRef<Capture> Captures,
4587 bool CapturesCXXThis) {
Erich Keanec9d29902018-08-01 21:16:54 +00004588 this->setCapturesCXXThis(CapturesCXXThis);
Benjamin Kramerb40e4af2015-08-05 09:40:35 +00004589 this->NumCaptures = Captures.size();
John McCallc63de662011-02-02 13:00:07 +00004590
Benjamin Kramerb40e4af2015-08-05 09:40:35 +00004591 if (Captures.empty()) {
4592 this->Captures = nullptr;
John McCallc63de662011-02-02 13:00:07 +00004593 return;
4594 }
4595
Benjamin Kramerb40e4af2015-08-05 09:40:35 +00004596 this->Captures = Captures.copy(Context).data();
Steve Naroffc4b30e52009-03-13 16:56:44 +00004597}
Sebastian Redl833ef452010-01-26 22:01:41 +00004598
John McCallce45f882011-06-15 22:51:16 +00004599bool BlockDecl::capturesVariable(const VarDecl *variable) const {
Aaron Ballman9371dd22014-03-14 18:34:04 +00004600 for (const auto &I : captures())
John McCallce45f882011-06-15 22:51:16 +00004601 // Only auto vars can be captured, so no redeclaration worries.
Aaron Ballman9371dd22014-03-14 18:34:04 +00004602 if (I.getVariable() == variable)
John McCallce45f882011-06-15 22:51:16 +00004603 return true;
4604
4605 return false;
4606}
4607
Douglas Gregor70226da2010-12-21 16:27:07 +00004608SourceRange BlockDecl::getSourceRange() const {
Stephen Kelly1c301dc2018-08-09 21:09:38 +00004609 return SourceRange(getLocation(), Body ? Body->getEndLoc() : getLocation());
Douglas Gregor70226da2010-12-21 16:27:07 +00004610}
Sebastian Redl833ef452010-01-26 22:01:41 +00004611
4612//===----------------------------------------------------------------------===//
4613// Other Decl Allocation/Deallocation Method Implementations
4614//===----------------------------------------------------------------------===//
4615
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004616void TranslationUnitDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004617
Sebastian Redl833ef452010-01-26 22:01:41 +00004618TranslationUnitDecl *TranslationUnitDecl::Create(ASTContext &C) {
Craig Topper36250ad2014-05-12 05:36:57 +00004619 return new (C, (DeclContext *)nullptr) TranslationUnitDecl(C);
Sebastian Redl833ef452010-01-26 22:01:41 +00004620}
4621
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004622void PragmaCommentDecl::anchor() {}
Nico Weber66220292016-03-02 17:28:48 +00004623
4624PragmaCommentDecl *PragmaCommentDecl::Create(const ASTContext &C,
4625 TranslationUnitDecl *DC,
4626 SourceLocation CommentLoc,
4627 PragmaMSCommentKind CommentKind,
4628 StringRef Arg) {
4629 PragmaCommentDecl *PCD =
4630 new (C, DC, additionalSizeToAlloc<char>(Arg.size() + 1))
4631 PragmaCommentDecl(DC, CommentLoc, CommentKind);
4632 memcpy(PCD->getTrailingObjects<char>(), Arg.data(), Arg.size());
4633 PCD->getTrailingObjects<char>()[Arg.size()] = '\0';
4634 return PCD;
4635}
4636
4637PragmaCommentDecl *PragmaCommentDecl::CreateDeserialized(ASTContext &C,
4638 unsigned ID,
4639 unsigned ArgSize) {
4640 return new (C, ID, additionalSizeToAlloc<char>(ArgSize + 1))
4641 PragmaCommentDecl(nullptr, SourceLocation(), PCK_Unknown);
4642}
4643
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004644void PragmaDetectMismatchDecl::anchor() {}
Nico Webercbbaeb12016-03-02 19:28:54 +00004645
4646PragmaDetectMismatchDecl *
4647PragmaDetectMismatchDecl::Create(const ASTContext &C, TranslationUnitDecl *DC,
4648 SourceLocation Loc, StringRef Name,
4649 StringRef Value) {
4650 size_t ValueStart = Name.size() + 1;
4651 PragmaDetectMismatchDecl *PDMD =
4652 new (C, DC, additionalSizeToAlloc<char>(ValueStart + Value.size() + 1))
4653 PragmaDetectMismatchDecl(DC, Loc, ValueStart);
4654 memcpy(PDMD->getTrailingObjects<char>(), Name.data(), Name.size());
4655 PDMD->getTrailingObjects<char>()[Name.size()] = '\0';
4656 memcpy(PDMD->getTrailingObjects<char>() + ValueStart, Value.data(),
4657 Value.size());
4658 PDMD->getTrailingObjects<char>()[ValueStart + Value.size()] = '\0';
4659 return PDMD;
4660}
4661
4662PragmaDetectMismatchDecl *
4663PragmaDetectMismatchDecl::CreateDeserialized(ASTContext &C, unsigned ID,
4664 unsigned NameValueSize) {
4665 return new (C, ID, additionalSizeToAlloc<char>(NameValueSize + 1))
4666 PragmaDetectMismatchDecl(nullptr, SourceLocation(), 0);
4667}
Nico Weber66220292016-03-02 17:28:48 +00004668
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004669void ExternCContextDecl::anchor() {}
Richard Smithf19e1272015-03-07 00:04:49 +00004670
4671ExternCContextDecl *ExternCContextDecl::Create(const ASTContext &C,
4672 TranslationUnitDecl *DC) {
4673 return new (C, DC) ExternCContextDecl(DC);
4674}
4675
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004676void LabelDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004677
Chris Lattnerc8e630e2011-02-17 07:39:24 +00004678LabelDecl *LabelDecl::Create(ASTContext &C, DeclContext *DC,
Abramo Bagnara1c3af962011-03-05 18:21:20 +00004679 SourceLocation IdentL, IdentifierInfo *II) {
Craig Topper36250ad2014-05-12 05:36:57 +00004680 return new (C, DC) LabelDecl(DC, IdentL, II, nullptr, IdentL);
Abramo Bagnara1c3af962011-03-05 18:21:20 +00004681}
4682
4683LabelDecl *LabelDecl::Create(ASTContext &C, DeclContext *DC,
4684 SourceLocation IdentL, IdentifierInfo *II,
4685 SourceLocation GnuLabelL) {
4686 assert(GnuLabelL != IdentL && "Use this only for GNU local labels");
Craig Topper36250ad2014-05-12 05:36:57 +00004687 return new (C, DC) LabelDecl(DC, IdentL, II, nullptr, GnuLabelL);
Chris Lattnerc8e630e2011-02-17 07:39:24 +00004688}
4689
Douglas Gregor72172e92012-01-05 21:55:30 +00004690LabelDecl *LabelDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Craig Topper36250ad2014-05-12 05:36:57 +00004691 return new (C, ID) LabelDecl(nullptr, SourceLocation(), nullptr, nullptr,
4692 SourceLocation());
Douglas Gregor417e87c2010-10-27 19:49:05 +00004693}
4694
Ehsan Akhgari31097582014-09-22 02:21:54 +00004695void LabelDecl::setMSAsmLabel(StringRef Name) {
Saar Razfdf80e82019-12-06 01:30:21 +02004696char *Buffer = new (getASTContext(), 1) char[Name.size() + 1];
Ehsan Akhgari31097582014-09-22 02:21:54 +00004697 memcpy(Buffer, Name.data(), Name.size());
4698 Buffer[Name.size()] = '\0';
4699 MSAsmName = Buffer;
4700}
4701
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004702void ValueDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004703
Benjamin Kramerea70eb32012-12-01 15:09:41 +00004704bool ValueDecl::isWeak() const {
Aaron Ballmanb97112e2014-03-08 22:19:01 +00004705 for (const auto *I : attrs())
4706 if (isa<WeakAttr>(I) || isa<WeakRefAttr>(I))
Benjamin Kramerea70eb32012-12-01 15:09:41 +00004707 return true;
4708
4709 return isWeakImported();
4710}
4711
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004712void ImplicitParamDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004713
Sebastian Redl833ef452010-01-26 22:01:41 +00004714ImplicitParamDecl *ImplicitParamDecl::Create(ASTContext &C, DeclContext *DC,
Abramo Bagnaradff19302011-03-08 08:55:46 +00004715 SourceLocation IdLoc,
Alexey Bataev56223232017-06-09 13:40:18 +00004716 IdentifierInfo *Id, QualType Type,
4717 ImplicitParamKind ParamKind) {
4718 return new (C, DC) ImplicitParamDecl(C, DC, IdLoc, Id, Type, ParamKind);
4719}
4720
4721ImplicitParamDecl *ImplicitParamDecl::Create(ASTContext &C, QualType Type,
4722 ImplicitParamKind ParamKind) {
4723 return new (C, nullptr) ImplicitParamDecl(C, Type, ParamKind);
Sebastian Redl833ef452010-01-26 22:01:41 +00004724}
4725
Richard Smithf7981722013-11-22 09:01:48 +00004726ImplicitParamDecl *ImplicitParamDecl::CreateDeserialized(ASTContext &C,
Douglas Gregor72172e92012-01-05 21:55:30 +00004727 unsigned ID) {
Alexey Bataev56223232017-06-09 13:40:18 +00004728 return new (C, ID) ImplicitParamDecl(C, QualType(), ImplicitParamKind::Other);
Douglas Gregor72172e92012-01-05 21:55:30 +00004729}
4730
Sebastian Redl833ef452010-01-26 22:01:41 +00004731FunctionDecl *FunctionDecl::Create(ASTContext &C, DeclContext *DC,
Abramo Bagnaradff19302011-03-08 08:55:46 +00004732 SourceLocation StartLoc,
Abramo Bagnarad6d2f182010-08-11 22:01:17 +00004733 const DeclarationNameInfo &NameInfo,
4734 QualType T, TypeSourceInfo *TInfo,
Gauthier Harnisch796ed032019-06-14 08:56:20 +00004735 StorageClass SC, bool isInlineSpecified,
Richard Smitha77a0a62011-08-15 21:04:07 +00004736 bool hasWrittenPrototype,
Saar Razb65b1f32020-01-09 15:07:51 +02004737 ConstexprSpecKind ConstexprKind,
4738 Expr *TrailingRequiresClause) {
Richard Smithf7981722013-11-22 09:01:48 +00004739 FunctionDecl *New =
Richard Smith053f6c62014-05-16 23:01:30 +00004740 new (C, DC) FunctionDecl(Function, C, DC, StartLoc, NameInfo, T, TInfo,
Saar Razb65b1f32020-01-09 15:07:51 +02004741 SC, isInlineSpecified, ConstexprKind,
4742 TrailingRequiresClause);
Erich Keane9c665062018-08-01 21:02:40 +00004743 New->setHasWrittenPrototype(hasWrittenPrototype);
Sebastian Redl833ef452010-01-26 22:01:41 +00004744 return New;
4745}
4746
Douglas Gregor72172e92012-01-05 21:55:30 +00004747FunctionDecl *FunctionDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00004748 return new (C, ID) FunctionDecl(Function, C, nullptr, SourceLocation(),
Craig Topper36250ad2014-05-12 05:36:57 +00004749 DeclarationNameInfo(), QualType(), nullptr,
Saar Razb65b1f32020-01-09 15:07:51 +02004750 SC_None, false, CSK_unspecified, nullptr);
Douglas Gregor72172e92012-01-05 21:55:30 +00004751}
4752
Sebastian Redl833ef452010-01-26 22:01:41 +00004753BlockDecl *BlockDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation L) {
Richard Smithf7981722013-11-22 09:01:48 +00004754 return new (C, DC) BlockDecl(DC, L);
Sebastian Redl833ef452010-01-26 22:01:41 +00004755}
4756
Douglas Gregor72172e92012-01-05 21:55:30 +00004757BlockDecl *BlockDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Craig Topper36250ad2014-05-12 05:36:57 +00004758 return new (C, ID) BlockDecl(nullptr, SourceLocation());
John McCall5e77d762013-04-16 07:28:30 +00004759}
4760
Chandler Carruth21c90602015-12-30 03:24:14 +00004761CapturedDecl::CapturedDecl(DeclContext *DC, unsigned NumParams)
4762 : Decl(Captured, DC, SourceLocation()), DeclContext(Captured),
4763 NumParams(NumParams), ContextParam(0), BodyAndNothrow(nullptr, false) {}
4764
Ben Langmuir37943a72013-05-03 19:00:33 +00004765CapturedDecl *CapturedDecl::Create(ASTContext &C, DeclContext *DC,
4766 unsigned NumParams) {
James Y Knight7a22b242015-08-06 20:26:32 +00004767 return new (C, DC, additionalSizeToAlloc<ImplicitParamDecl *>(NumParams))
Richard Smithf7981722013-11-22 09:01:48 +00004768 CapturedDecl(DC, NumParams);
Tareq A. Siraj6dfa25a2013-04-16 19:37:38 +00004769}
4770
Ben Langmuirce914fc2013-05-03 19:20:19 +00004771CapturedDecl *CapturedDecl::CreateDeserialized(ASTContext &C, unsigned ID,
Richard Smithf7981722013-11-22 09:01:48 +00004772 unsigned NumParams) {
James Y Knight7a22b242015-08-06 20:26:32 +00004773 return new (C, ID, additionalSizeToAlloc<ImplicitParamDecl *>(NumParams))
Craig Topper36250ad2014-05-12 05:36:57 +00004774 CapturedDecl(nullptr, NumParams);
Ben Langmuirce914fc2013-05-03 19:20:19 +00004775}
4776
Chandler Carruth21c90602015-12-30 03:24:14 +00004777Stmt *CapturedDecl::getBody() const { return BodyAndNothrow.getPointer(); }
4778void CapturedDecl::setBody(Stmt *B) { BodyAndNothrow.setPointer(B); }
4779
4780bool CapturedDecl::isNothrow() const { return BodyAndNothrow.getInt(); }
4781void CapturedDecl::setNothrow(bool Nothrow) { BodyAndNothrow.setInt(Nothrow); }
4782
Sebastian Redl833ef452010-01-26 22:01:41 +00004783EnumConstantDecl *EnumConstantDecl::Create(ASTContext &C, EnumDecl *CD,
4784 SourceLocation L,
4785 IdentifierInfo *Id, QualType T,
4786 Expr *E, const llvm::APSInt &V) {
Richard Smithf7981722013-11-22 09:01:48 +00004787 return new (C, CD) EnumConstantDecl(CD, L, Id, T, E, V);
Sebastian Redl833ef452010-01-26 22:01:41 +00004788}
4789
Douglas Gregor72172e92012-01-05 21:55:30 +00004790EnumConstantDecl *
4791EnumConstantDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Craig Topper36250ad2014-05-12 05:36:57 +00004792 return new (C, ID) EnumConstantDecl(nullptr, SourceLocation(), nullptr,
4793 QualType(), nullptr, llvm::APSInt());
Douglas Gregor72172e92012-01-05 21:55:30 +00004794}
4795
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004796void IndirectFieldDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004797
Richard Smith9f951822016-01-06 22:49:11 +00004798IndirectFieldDecl::IndirectFieldDecl(ASTContext &C, DeclContext *DC,
4799 SourceLocation L, DeclarationName N,
David Majnemer59f77922016-06-24 04:05:48 +00004800 QualType T,
4801 MutableArrayRef<NamedDecl *> CH)
4802 : ValueDecl(IndirectField, DC, L, N, T), Chaining(CH.data()),
4803 ChainingSize(CH.size()) {
Richard Smith9f951822016-01-06 22:49:11 +00004804 // In C++, indirect field declarations conflict with tag declarations in the
4805 // same scope, so add them to IDNS_Tag so that tag redeclaration finds them.
4806 if (C.getLangOpts().CPlusPlus)
4807 IdentifierNamespace |= IDNS_Tag;
4808}
4809
Benjamin Kramer39593702010-11-21 14:11:41 +00004810IndirectFieldDecl *
4811IndirectFieldDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation L,
David Majnemer59f77922016-06-24 04:05:48 +00004812 IdentifierInfo *Id, QualType T,
4813 llvm::MutableArrayRef<NamedDecl *> CH) {
4814 return new (C, DC) IndirectFieldDecl(C, DC, L, Id, T, CH);
Francois Pichet783dd6e2010-11-21 06:08:52 +00004815}
4816
Douglas Gregor72172e92012-01-05 21:55:30 +00004817IndirectFieldDecl *IndirectFieldDecl::CreateDeserialized(ASTContext &C,
4818 unsigned ID) {
Richard Smith9f951822016-01-06 22:49:11 +00004819 return new (C, ID) IndirectFieldDecl(C, nullptr, SourceLocation(),
David Majnemer59f77922016-06-24 04:05:48 +00004820 DeclarationName(), QualType(), None);
Douglas Gregor72172e92012-01-05 21:55:30 +00004821}
4822
Douglas Gregorbe996932010-09-01 20:41:53 +00004823SourceRange EnumConstantDecl::getSourceRange() const {
4824 SourceLocation End = getLocation();
4825 if (Init)
Stephen Kelly1c301dc2018-08-09 21:09:38 +00004826 End = Init->getEndLoc();
Douglas Gregorbe996932010-09-01 20:41:53 +00004827 return SourceRange(getLocation(), End);
4828}
4829
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004830void TypeDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004831
Sebastian Redl833ef452010-01-26 22:01:41 +00004832TypedefDecl *TypedefDecl::Create(ASTContext &C, DeclContext *DC,
Abramo Bagnarab3185b02011-03-06 15:48:19 +00004833 SourceLocation StartLoc, SourceLocation IdLoc,
4834 IdentifierInfo *Id, TypeSourceInfo *TInfo) {
Richard Smith053f6c62014-05-16 23:01:30 +00004835 return new (C, DC) TypedefDecl(C, DC, StartLoc, IdLoc, Id, TInfo);
Sebastian Redl833ef452010-01-26 22:01:41 +00004836}
4837
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004838void TypedefNameDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004839
Richard Smith42413142015-05-15 20:05:43 +00004840TagDecl *TypedefNameDecl::getAnonDeclWithTypedefName(bool AnyRedecl) const {
4841 if (auto *TT = getTypeSourceInfo()->getType()->getAs<TagType>()) {
4842 auto *OwningTypedef = TT->getDecl()->getTypedefNameForAnonDecl();
4843 auto *ThisTypedef = this;
4844 if (AnyRedecl && OwningTypedef) {
4845 OwningTypedef = OwningTypedef->getCanonicalDecl();
4846 ThisTypedef = ThisTypedef->getCanonicalDecl();
4847 }
4848 if (OwningTypedef == ThisTypedef)
Richard Smitha5230222015-03-27 01:37:43 +00004849 return TT->getDecl();
Richard Smith42413142015-05-15 20:05:43 +00004850 }
Richard Smitha5230222015-03-27 01:37:43 +00004851
4852 return nullptr;
4853}
4854
Argyrios Kyrtzidis3b25c912017-03-21 16:56:02 +00004855bool TypedefNameDecl::isTransparentTagSlow() const {
4856 auto determineIsTransparent = [&]() {
4857 if (auto *TT = getUnderlyingType()->getAs<TagType>()) {
4858 if (auto *TD = TT->getDecl()) {
4859 if (TD->getName() != getName())
4860 return false;
4861 SourceLocation TTLoc = getLocation();
4862 SourceLocation TDLoc = TD->getLocation();
4863 if (!TTLoc.isMacroID() || !TDLoc.isMacroID())
4864 return false;
4865 SourceManager &SM = getASTContext().getSourceManager();
4866 return SM.getSpellingLoc(TTLoc) == SM.getSpellingLoc(TDLoc);
4867 }
4868 }
4869 return false;
4870 };
4871
4872 bool isTransparent = determineIsTransparent();
Benjamin Kramerdfb730a2018-01-26 14:14:11 +00004873 MaybeModedTInfo.setInt((isTransparent << 1) | 1);
Argyrios Kyrtzidis3b25c912017-03-21 16:56:02 +00004874 return isTransparent;
4875}
4876
Douglas Gregor72172e92012-01-05 21:55:30 +00004877TypedefDecl *TypedefDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00004878 return new (C, ID) TypedefDecl(C, nullptr, SourceLocation(), SourceLocation(),
Craig Topper36250ad2014-05-12 05:36:57 +00004879 nullptr, nullptr);
Douglas Gregor72172e92012-01-05 21:55:30 +00004880}
4881
Richard Smithdda56e42011-04-15 14:24:37 +00004882TypeAliasDecl *TypeAliasDecl::Create(ASTContext &C, DeclContext *DC,
4883 SourceLocation StartLoc,
4884 SourceLocation IdLoc, IdentifierInfo *Id,
4885 TypeSourceInfo *TInfo) {
Richard Smith053f6c62014-05-16 23:01:30 +00004886 return new (C, DC) TypeAliasDecl(C, DC, StartLoc, IdLoc, Id, TInfo);
Richard Smithdda56e42011-04-15 14:24:37 +00004887}
4888
Douglas Gregor72172e92012-01-05 21:55:30 +00004889TypeAliasDecl *TypeAliasDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Richard Smith053f6c62014-05-16 23:01:30 +00004890 return new (C, ID) TypeAliasDecl(C, nullptr, SourceLocation(),
4891 SourceLocation(), nullptr, nullptr);
Douglas Gregor72172e92012-01-05 21:55:30 +00004892}
4893
Abramo Bagnaraea947882011-03-08 16:41:52 +00004894SourceRange TypedefDecl::getSourceRange() const {
4895 SourceLocation RangeEnd = getLocation();
4896 if (TypeSourceInfo *TInfo = getTypeSourceInfo()) {
4897 if (typeIsPostfix(TInfo->getType()))
4898 RangeEnd = TInfo->getTypeLoc().getSourceRange().getEnd();
4899 }
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004900 return SourceRange(getBeginLoc(), RangeEnd);
Abramo Bagnaraea947882011-03-08 16:41:52 +00004901}
4902
Richard Smithdda56e42011-04-15 14:24:37 +00004903SourceRange TypeAliasDecl::getSourceRange() const {
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004904 SourceLocation RangeEnd = getBeginLoc();
Richard Smithdda56e42011-04-15 14:24:37 +00004905 if (TypeSourceInfo *TInfo = getTypeSourceInfo())
4906 RangeEnd = TInfo->getTypeLoc().getSourceRange().getEnd();
Stephen Kellyf2ceec42018-08-09 21:08:08 +00004907 return SourceRange(getBeginLoc(), RangeEnd);
Richard Smithdda56e42011-04-15 14:24:37 +00004908}
4909
Eugene Zelenkode0215c2017-11-13 23:01:27 +00004910void FileScopeAsmDecl::anchor() {}
David Blaikie68e081d2011-12-20 02:48:34 +00004911
Sebastian Redl833ef452010-01-26 22:01:41 +00004912FileScopeAsmDecl *FileScopeAsmDecl::Create(ASTContext &C, DeclContext *DC,
Abramo Bagnara348823a2011-03-03 14:20:18 +00004913 StringLiteral *Str,
4914 SourceLocation AsmLoc,
4915 SourceLocation RParenLoc) {
Richard Smithf7981722013-11-22 09:01:48 +00004916 return new (C, DC) FileScopeAsmDecl(DC, Str, AsmLoc, RParenLoc);
Sebastian Redl833ef452010-01-26 22:01:41 +00004917}
Douglas Gregorba345522011-12-02 23:23:56 +00004918
Richard Smithf7981722013-11-22 09:01:48 +00004919FileScopeAsmDecl *FileScopeAsmDecl::CreateDeserialized(ASTContext &C,
Douglas Gregor72172e92012-01-05 21:55:30 +00004920 unsigned ID) {
Craig Topper36250ad2014-05-12 05:36:57 +00004921 return new (C, ID) FileScopeAsmDecl(nullptr, nullptr, SourceLocation(),
4922 SourceLocation());
Douglas Gregor72172e92012-01-05 21:55:30 +00004923}
4924
Michael Han84324352013-02-22 17:15:32 +00004925void EmptyDecl::anchor() {}
4926
4927EmptyDecl *EmptyDecl::Create(ASTContext &C, DeclContext *DC, SourceLocation L) {
Richard Smithf7981722013-11-22 09:01:48 +00004928 return new (C, DC) EmptyDecl(DC, L);
Michael Han84324352013-02-22 17:15:32 +00004929}
4930
4931EmptyDecl *EmptyDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
Craig Topper36250ad2014-05-12 05:36:57 +00004932 return new (C, ID) EmptyDecl(nullptr, SourceLocation());
Michael Han84324352013-02-22 17:15:32 +00004933}
4934
Douglas Gregorba345522011-12-02 23:23:56 +00004935//===----------------------------------------------------------------------===//
4936// ImportDecl Implementation
4937//===----------------------------------------------------------------------===//
4938
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004939/// Retrieve the number of module identifiers needed to name the given
Douglas Gregorba345522011-12-02 23:23:56 +00004940/// module.
4941static unsigned getNumModuleIdentifiers(Module *Mod) {
4942 unsigned Result = 1;
4943 while (Mod->Parent) {
4944 Mod = Mod->Parent;
4945 ++Result;
4946 }
4947 return Result;
4948}
4949
Fangrui Song6907ce22018-07-30 19:24:48 +00004950ImportDecl::ImportDecl(DeclContext *DC, SourceLocation StartLoc,
Douglas Gregorba345522011-12-02 23:23:56 +00004951 Module *Imported,
4952 ArrayRef<SourceLocation> IdentifierLocs)
Reid Klecknerc915cb92020-02-27 18:13:54 -08004953 : Decl(Import, DC, StartLoc), ImportedModule(Imported),
4954 NextLocalImportAndComplete(nullptr, true) {
Douglas Gregorba345522011-12-02 23:23:56 +00004955 assert(getNumModuleIdentifiers(Imported) == IdentifierLocs.size());
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004956 auto *StoredLocs = getTrailingObjects<SourceLocation>();
James Y Knight7a22b242015-08-06 20:26:32 +00004957 std::uninitialized_copy(IdentifierLocs.begin(), IdentifierLocs.end(),
4958 StoredLocs);
Douglas Gregorba345522011-12-02 23:23:56 +00004959}
4960
Fangrui Song6907ce22018-07-30 19:24:48 +00004961ImportDecl::ImportDecl(DeclContext *DC, SourceLocation StartLoc,
Douglas Gregorba345522011-12-02 23:23:56 +00004962 Module *Imported, SourceLocation EndLoc)
Reid Klecknerc915cb92020-02-27 18:13:54 -08004963 : Decl(Import, DC, StartLoc), ImportedModule(Imported),
4964 NextLocalImportAndComplete(nullptr, false) {
James Y Knight7a22b242015-08-06 20:26:32 +00004965 *getTrailingObjects<SourceLocation>() = EndLoc;
Douglas Gregorba345522011-12-02 23:23:56 +00004966}
4967
Richard Smithf7981722013-11-22 09:01:48 +00004968ImportDecl *ImportDecl::Create(ASTContext &C, DeclContext *DC,
Douglas Gregor22d09742012-01-03 18:04:46 +00004969 SourceLocation StartLoc, Module *Imported,
Douglas Gregorba345522011-12-02 23:23:56 +00004970 ArrayRef<SourceLocation> IdentifierLocs) {
James Y Knight7a22b242015-08-06 20:26:32 +00004971 return new (C, DC,
4972 additionalSizeToAlloc<SourceLocation>(IdentifierLocs.size()))
Richard Smithf7981722013-11-22 09:01:48 +00004973 ImportDecl(DC, StartLoc, Imported, IdentifierLocs);
Douglas Gregorba345522011-12-02 23:23:56 +00004974}
4975
Richard Smithf7981722013-11-22 09:01:48 +00004976ImportDecl *ImportDecl::CreateImplicit(ASTContext &C, DeclContext *DC,
Douglas Gregor22d09742012-01-03 18:04:46 +00004977 SourceLocation StartLoc,
Richard Smithf7981722013-11-22 09:01:48 +00004978 Module *Imported,
Douglas Gregorba345522011-12-02 23:23:56 +00004979 SourceLocation EndLoc) {
James Y Knight7a22b242015-08-06 20:26:32 +00004980 ImportDecl *Import = new (C, DC, additionalSizeToAlloc<SourceLocation>(1))
4981 ImportDecl(DC, StartLoc, Imported, EndLoc);
Douglas Gregorba345522011-12-02 23:23:56 +00004982 Import->setImplicit();
4983 return Import;
4984}
4985
Douglas Gregor72172e92012-01-05 21:55:30 +00004986ImportDecl *ImportDecl::CreateDeserialized(ASTContext &C, unsigned ID,
4987 unsigned NumLocations) {
James Y Knight7a22b242015-08-06 20:26:32 +00004988 return new (C, ID, additionalSizeToAlloc<SourceLocation>(NumLocations))
Richard Smithf7981722013-11-22 09:01:48 +00004989 ImportDecl(EmptyShell());
Douglas Gregorba345522011-12-02 23:23:56 +00004990}
4991
4992ArrayRef<SourceLocation> ImportDecl::getIdentifierLocs() const {
Reid Klecknerc915cb92020-02-27 18:13:54 -08004993 if (!isImportComplete())
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +00004994 return None;
Douglas Gregorba345522011-12-02 23:23:56 +00004995
Alexander Kornienkofd6ce042015-11-09 17:53:06 +00004996 const auto *StoredLocs = getTrailingObjects<SourceLocation>();
Craig Topper5fc8fc22014-08-27 06:28:36 +00004997 return llvm::makeArrayRef(StoredLocs,
4998 getNumModuleIdentifiers(getImportedModule()));
Douglas Gregorba345522011-12-02 23:23:56 +00004999}
5000
5001SourceRange ImportDecl::getSourceRange() const {
Reid Klecknerc915cb92020-02-27 18:13:54 -08005002 if (!isImportComplete())
James Y Knight7a22b242015-08-06 20:26:32 +00005003 return SourceRange(getLocation(), *getTrailingObjects<SourceLocation>());
5004
Douglas Gregorba345522011-12-02 23:23:56 +00005005 return SourceRange(getLocation(), getIdentifierLocs().back());
5006}
Richard Smith8df390f2016-09-08 23:14:54 +00005007
5008//===----------------------------------------------------------------------===//
5009// ExportDecl Implementation
5010//===----------------------------------------------------------------------===//
5011
5012void ExportDecl::anchor() {}
5013
5014ExportDecl *ExportDecl::Create(ASTContext &C, DeclContext *DC,
5015 SourceLocation ExportLoc) {
5016 return new (C, DC) ExportDecl(DC, ExportLoc);
5017}
5018
5019ExportDecl *ExportDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
5020 return new (C, ID) ExportDecl(nullptr, SourceLocation());
5021}