1//===--- ASTCommon.cpp - Common stuff for ASTReader/ASTWriter----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines common functions that both ASTReader and ASTWriter use.
10//
11//===----------------------------------------------------------------------===//
12
13#include "ASTCommon.h"
14#include "clang/AST/DeclCXX.h"
15#include "clang/AST/DeclObjC.h"
16#include "clang/Basic/IdentifierTable.h"
17#include "clang/Serialization/ASTDeserializationListener.h"
18#include "llvm/Support/DJB.h"
19
20using namespace clang;
21
22// Give ASTDeserializationListener's VTable a home.
23ASTDeserializationListener::~ASTDeserializationListener() { }
24
25serialization::TypeIdx
26serialization::TypeIdxFromBuiltin(const BuiltinType *BT) {
27 unsigned ID = 0;
28 switch (BT->getKind()) {
29 case BuiltinType::Void:
30 ID = PREDEF_TYPE_VOID_ID;
31 break;
32 case BuiltinType::Bool:
33 ID = PREDEF_TYPE_BOOL_ID;
34 break;
35 case BuiltinType::Char_U:
36 ID = PREDEF_TYPE_CHAR_U_ID;
37 break;
38 case BuiltinType::UChar:
39 ID = PREDEF_TYPE_UCHAR_ID;
40 break;
41 case BuiltinType::UShort:
42 ID = PREDEF_TYPE_USHORT_ID;
43 break;
44 case BuiltinType::UInt:
45 ID = PREDEF_TYPE_UINT_ID;
46 break;
47 case BuiltinType::ULong:
48 ID = PREDEF_TYPE_ULONG_ID;
49 break;
50 case BuiltinType::ULongLong:
51 ID = PREDEF_TYPE_ULONGLONG_ID;
52 break;
53 case BuiltinType::UInt128:
54 ID = PREDEF_TYPE_UINT128_ID;
55 break;
56 case BuiltinType::Char_S:
57 ID = PREDEF_TYPE_CHAR_S_ID;
58 break;
59 case BuiltinType::SChar:
60 ID = PREDEF_TYPE_SCHAR_ID;
61 break;
62 case BuiltinType::WChar_S:
63 case BuiltinType::WChar_U:
64 ID = PREDEF_TYPE_WCHAR_ID;
65 break;
66 case BuiltinType::Short:
67 ID = PREDEF_TYPE_SHORT_ID;
68 break;
69 case BuiltinType::Int:
70 ID = PREDEF_TYPE_INT_ID;
71 break;
72 case BuiltinType::Long:
73 ID = PREDEF_TYPE_LONG_ID;
74 break;
75 case BuiltinType::LongLong:
76 ID = PREDEF_TYPE_LONGLONG_ID;
77 break;
78 case BuiltinType::Int128:
79 ID = PREDEF_TYPE_INT128_ID;
80 break;
81 case BuiltinType::Half:
82 ID = PREDEF_TYPE_HALF_ID;
83 break;
84 case BuiltinType::Float:
85 ID = PREDEF_TYPE_FLOAT_ID;
86 break;
87 case BuiltinType::Double:
88 ID = PREDEF_TYPE_DOUBLE_ID;
89 break;
90 case BuiltinType::LongDouble:
91 ID = PREDEF_TYPE_LONGDOUBLE_ID;
92 break;
93 case BuiltinType::ShortAccum:
94 ID = PREDEF_TYPE_SHORT_ACCUM_ID;
95 break;
96 case BuiltinType::Accum:
97 ID = PREDEF_TYPE_ACCUM_ID;
98 break;
99 case BuiltinType::LongAccum:
100 ID = PREDEF_TYPE_LONG_ACCUM_ID;
101 break;
102 case BuiltinType::UShortAccum:
103 ID = PREDEF_TYPE_USHORT_ACCUM_ID;
104 break;
105 case BuiltinType::UAccum:
106 ID = PREDEF_TYPE_UACCUM_ID;
107 break;
108 case BuiltinType::ULongAccum:
109 ID = PREDEF_TYPE_ULONG_ACCUM_ID;
110 break;
111 case BuiltinType::ShortFract:
112 ID = PREDEF_TYPE_SHORT_FRACT_ID;
113 break;
114 case BuiltinType::Fract:
115 ID = PREDEF_TYPE_FRACT_ID;
116 break;
117 case BuiltinType::LongFract:
118 ID = PREDEF_TYPE_LONG_FRACT_ID;
119 break;
120 case BuiltinType::UShortFract:
121 ID = PREDEF_TYPE_USHORT_FRACT_ID;
122 break;
123 case BuiltinType::UFract:
124 ID = PREDEF_TYPE_UFRACT_ID;
125 break;
126 case BuiltinType::ULongFract:
127 ID = PREDEF_TYPE_ULONG_FRACT_ID;
128 break;
129 case BuiltinType::SatShortAccum:
130 ID = PREDEF_TYPE_SAT_SHORT_ACCUM_ID;
131 break;
132 case BuiltinType::SatAccum:
133 ID = PREDEF_TYPE_SAT_ACCUM_ID;
134 break;
135 case BuiltinType::SatLongAccum:
136 ID = PREDEF_TYPE_SAT_LONG_ACCUM_ID;
137 break;
138 case BuiltinType::SatUShortAccum:
139 ID = PREDEF_TYPE_SAT_USHORT_ACCUM_ID;
140 break;
141 case BuiltinType::SatUAccum:
142 ID = PREDEF_TYPE_SAT_UACCUM_ID;
143 break;
144 case BuiltinType::SatULongAccum:
145 ID = PREDEF_TYPE_SAT_ULONG_ACCUM_ID;
146 break;
147 case BuiltinType::SatShortFract:
148 ID = PREDEF_TYPE_SAT_SHORT_FRACT_ID;
149 break;
150 case BuiltinType::SatFract:
151 ID = PREDEF_TYPE_SAT_FRACT_ID;
152 break;
153 case BuiltinType::SatLongFract:
154 ID = PREDEF_TYPE_SAT_LONG_FRACT_ID;
155 break;
156 case BuiltinType::SatUShortFract:
157 ID = PREDEF_TYPE_SAT_USHORT_FRACT_ID;
158 break;
159 case BuiltinType::SatUFract:
160 ID = PREDEF_TYPE_SAT_UFRACT_ID;
161 break;
162 case BuiltinType::SatULongFract:
163 ID = PREDEF_TYPE_SAT_ULONG_FRACT_ID;
164 break;
165 case BuiltinType::Float16:
166 ID = PREDEF_TYPE_FLOAT16_ID;
167 break;
168 case BuiltinType::Float128:
169 ID = PREDEF_TYPE_FLOAT128_ID;
170 break;
171 case BuiltinType::Ibm128:
172 ID = PREDEF_TYPE_IBM128_ID;
173 break;
174 case BuiltinType::NullPtr:
175 ID = PREDEF_TYPE_NULLPTR_ID;
176 break;
177 case BuiltinType::Char8:
178 ID = PREDEF_TYPE_CHAR8_ID;
179 break;
180 case BuiltinType::Char16:
181 ID = PREDEF_TYPE_CHAR16_ID;
182 break;
183 case BuiltinType::Char32:
184 ID = PREDEF_TYPE_CHAR32_ID;
185 break;
186 case BuiltinType::Overload:
187 ID = PREDEF_TYPE_OVERLOAD_ID;
188 break;
189 case BuiltinType::BoundMember:
190 ID = PREDEF_TYPE_BOUND_MEMBER;
191 break;
192 case BuiltinType::PseudoObject:
193 ID = PREDEF_TYPE_PSEUDO_OBJECT;
194 break;
195 case BuiltinType::Dependent:
196 ID = PREDEF_TYPE_DEPENDENT_ID;
197 break;
198 case BuiltinType::UnknownAny:
199 ID = PREDEF_TYPE_UNKNOWN_ANY;
200 break;
201 case BuiltinType::ARCUnbridgedCast:
202 ID = PREDEF_TYPE_ARC_UNBRIDGED_CAST;
203 break;
204 case BuiltinType::ObjCId:
205 ID = PREDEF_TYPE_OBJC_ID;
206 break;
207 case BuiltinType::ObjCClass:
208 ID = PREDEF_TYPE_OBJC_CLASS;
209 break;
210 case BuiltinType::ObjCSel:
211 ID = PREDEF_TYPE_OBJC_SEL;
212 break;
213#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
214 case BuiltinType::Id: \
215 ID = PREDEF_TYPE_##Id##_ID; \
216 break;
217#include "clang/Basic/OpenCLImageTypes.def"
218#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
219 case BuiltinType::Id: \
220 ID = PREDEF_TYPE_##Id##_ID; \
221 break;
222#include "clang/Basic/OpenCLExtensionTypes.def"
223 case BuiltinType::OCLSampler:
224 ID = PREDEF_TYPE_SAMPLER_ID;
225 break;
226 case BuiltinType::OCLEvent:
227 ID = PREDEF_TYPE_EVENT_ID;
228 break;
229 case BuiltinType::OCLClkEvent:
230 ID = PREDEF_TYPE_CLK_EVENT_ID;
231 break;
232 case BuiltinType::OCLQueue:
233 ID = PREDEF_TYPE_QUEUE_ID;
234 break;
235 case BuiltinType::OCLReserveID:
236 ID = PREDEF_TYPE_RESERVE_ID_ID;
237 break;
238#define SVE_TYPE(Name, Id, SingletonId) \
239 case BuiltinType::Id: \
240 ID = PREDEF_TYPE_##Id##_ID; \
241 break;
242#include "clang/Basic/AArch64SVEACLETypes.def"
243#define PPC_VECTOR_TYPE(Name, Id, Size) \
244 case BuiltinType::Id: \
245 ID = PREDEF_TYPE_##Id##_ID; \
246 break;
247#include "clang/Basic/PPCTypes.def"
248#define RVV_TYPE(Name, Id, SingletonId) \
249 case BuiltinType::Id: \
250 ID = PREDEF_TYPE_##Id##_ID; \
251 break;
252#include "clang/Basic/RISCVVTypes.def"
253#define WASM_TYPE(Name, Id, SingletonId) \
254 case BuiltinType::Id: \
255 ID = PREDEF_TYPE_##Id##_ID; \
256 break;
257#include "clang/Basic/WebAssemblyReferenceTypes.def"
258 case BuiltinType::BuiltinFn:
259 ID = PREDEF_TYPE_BUILTIN_FN;
260 break;
261 case BuiltinType::IncompleteMatrixIdx:
262 ID = PREDEF_TYPE_INCOMPLETE_MATRIX_IDX;
263 break;
264 case BuiltinType::OMPArraySection:
265 ID = PREDEF_TYPE_OMP_ARRAY_SECTION;
266 break;
267 case BuiltinType::OMPArrayShaping:
268 ID = PREDEF_TYPE_OMP_ARRAY_SHAPING;
269 break;
270 case BuiltinType::OMPIterator:
271 ID = PREDEF_TYPE_OMP_ITERATOR;
272 break;
273 case BuiltinType::BFloat16:
274 ID = PREDEF_TYPE_BFLOAT16_ID;
275 break;
276 }
277
278 return TypeIdx(ID);
279}
280
281unsigned serialization::ComputeHash(Selector Sel) {
282 unsigned N = Sel.getNumArgs();
283 if (N == 0)
284 ++N;
285 unsigned R = 5381;
286 for (unsigned I = 0; I != N; ++I)
287 if (const IdentifierInfo *II = Sel.getIdentifierInfoForSlot(argIndex: I))
288 R = llvm::djbHash(Buffer: II->getName(), H: R);
289 return R;
290}
291
292const DeclContext *
293serialization::getDefinitiveDeclContext(const DeclContext *DC) {
294 switch (DC->getDeclKind()) {
295 // These entities may have multiple definitions.
296 case Decl::TranslationUnit:
297 case Decl::ExternCContext:
298 case Decl::Namespace:
299 case Decl::LinkageSpec:
300 case Decl::Export:
301 return nullptr;
302
303 // C/C++ tag types can only be defined in one place.
304 case Decl::Enum:
305 case Decl::Record:
306 if (const TagDecl *Def = cast<TagDecl>(Val: DC)->getDefinition())
307 return Def;
308 return nullptr;
309
310 // FIXME: These can be defined in one place... except special member
311 // functions and out-of-line definitions.
312 case Decl::CXXRecord:
313 case Decl::ClassTemplateSpecialization:
314 case Decl::ClassTemplatePartialSpecialization:
315 return nullptr;
316
317 // Each function, method, and block declaration is its own DeclContext.
318 case Decl::Function:
319 case Decl::CXXMethod:
320 case Decl::CXXConstructor:
321 case Decl::CXXDestructor:
322 case Decl::CXXConversion:
323 case Decl::ObjCMethod:
324 case Decl::Block:
325 case Decl::Captured:
326 // Objective C categories, category implementations, and class
327 // implementations can only be defined in one place.
328 case Decl::ObjCCategory:
329 case Decl::ObjCCategoryImpl:
330 case Decl::ObjCImplementation:
331 return DC;
332
333 case Decl::ObjCProtocol:
334 if (const ObjCProtocolDecl *Def
335 = cast<ObjCProtocolDecl>(Val: DC)->getDefinition())
336 return Def;
337 return nullptr;
338
339 // FIXME: These are defined in one place, but properties in class extensions
340 // end up being back-patched into the main interface. See
341 // Sema::HandlePropertyInClassExtension for the offending code.
342 case Decl::ObjCInterface:
343 return nullptr;
344
345 default:
346 llvm_unreachable("Unhandled DeclContext in AST reader");
347 }
348
349 llvm_unreachable("Unhandled decl kind");
350}
351
352bool serialization::isRedeclarableDeclKind(unsigned Kind) {
353 switch (static_cast<Decl::Kind>(Kind)) {
354 case Decl::TranslationUnit:
355 case Decl::ExternCContext:
356 // Special case of a "merged" declaration.
357 return true;
358
359 case Decl::Namespace:
360 case Decl::NamespaceAlias:
361 case Decl::Typedef:
362 case Decl::TypeAlias:
363 case Decl::Enum:
364 case Decl::Record:
365 case Decl::CXXRecord:
366 case Decl::ClassTemplateSpecialization:
367 case Decl::ClassTemplatePartialSpecialization:
368 case Decl::VarTemplateSpecialization:
369 case Decl::VarTemplatePartialSpecialization:
370 case Decl::Function:
371 case Decl::CXXDeductionGuide:
372 case Decl::CXXMethod:
373 case Decl::CXXConstructor:
374 case Decl::CXXDestructor:
375 case Decl::CXXConversion:
376 case Decl::UsingShadow:
377 case Decl::ConstructorUsingShadow:
378 case Decl::Var:
379 case Decl::FunctionTemplate:
380 case Decl::ClassTemplate:
381 case Decl::VarTemplate:
382 case Decl::TypeAliasTemplate:
383 case Decl::ObjCProtocol:
384 case Decl::ObjCInterface:
385 case Decl::Empty:
386 return true;
387
388 // Never redeclarable.
389 case Decl::UsingDirective:
390 case Decl::Label:
391 case Decl::UnresolvedUsingTypename:
392 case Decl::TemplateTypeParm:
393 case Decl::EnumConstant:
394 case Decl::UnresolvedUsingValue:
395 case Decl::IndirectField:
396 case Decl::Field:
397 case Decl::MSProperty:
398 case Decl::MSGuid:
399 case Decl::UnnamedGlobalConstant:
400 case Decl::TemplateParamObject:
401 case Decl::ObjCIvar:
402 case Decl::ObjCAtDefsField:
403 case Decl::NonTypeTemplateParm:
404 case Decl::TemplateTemplateParm:
405 case Decl::Using:
406 case Decl::UsingEnum:
407 case Decl::UsingPack:
408 case Decl::ObjCMethod:
409 case Decl::ObjCCategory:
410 case Decl::ObjCCategoryImpl:
411 case Decl::ObjCImplementation:
412 case Decl::ObjCProperty:
413 case Decl::ObjCCompatibleAlias:
414 case Decl::LinkageSpec:
415 case Decl::Export:
416 case Decl::ObjCPropertyImpl:
417 case Decl::PragmaComment:
418 case Decl::PragmaDetectMismatch:
419 case Decl::FileScopeAsm:
420 case Decl::TopLevelStmt:
421 case Decl::AccessSpec:
422 case Decl::Friend:
423 case Decl::FriendTemplate:
424 case Decl::StaticAssert:
425 case Decl::Block:
426 case Decl::Captured:
427 case Decl::Import:
428 case Decl::OMPThreadPrivate:
429 case Decl::OMPAllocate:
430 case Decl::OMPRequires:
431 case Decl::OMPCapturedExpr:
432 case Decl::OMPDeclareReduction:
433 case Decl::OMPDeclareMapper:
434 case Decl::BuiltinTemplate:
435 case Decl::Decomposition:
436 case Decl::Binding:
437 case Decl::Concept:
438 case Decl::ImplicitConceptSpecialization:
439 case Decl::LifetimeExtendedTemporary:
440 case Decl::RequiresExprBody:
441 case Decl::UnresolvedUsingIfExists:
442 case Decl::HLSLBuffer:
443 return false;
444
445 // These indirectly derive from Redeclarable<T> but are not actually
446 // redeclarable.
447 case Decl::ImplicitParam:
448 case Decl::ParmVar:
449 case Decl::ObjCTypeParam:
450 return false;
451 }
452
453 llvm_unreachable("Unhandled declaration kind");
454}
455
456bool serialization::needsAnonymousDeclarationNumber(const NamedDecl *D) {
457 // Friend declarations in dependent contexts aren't anonymous in the usual
458 // sense, but they cannot be found by name lookup in their semantic context
459 // (or indeed in any context), so we treat them as anonymous.
460 //
461 // This doesn't apply to friend tag decls; Sema makes those available to name
462 // lookup in the surrounding context.
463 if (D->getFriendObjectKind() &&
464 D->getLexicalDeclContext()->isDependentContext() && !isa<TagDecl>(Val: D)) {
465 // For function templates and class templates, the template is numbered and
466 // not its pattern.
467 if (auto *FD = dyn_cast<FunctionDecl>(Val: D))
468 return !FD->getDescribedFunctionTemplate();
469 if (auto *RD = dyn_cast<CXXRecordDecl>(Val: D))
470 return !RD->getDescribedClassTemplate();
471 return true;
472 }
473
474 // At block scope, we number everything that we need to deduplicate, since we
475 // can't just use name matching to keep things lined up.
476 // FIXME: This is only necessary for an inline function or a template or
477 // similar.
478 if (D->getLexicalDeclContext()->isFunctionOrMethod()) {
479 if (auto *VD = dyn_cast<VarDecl>(Val: D))
480 return VD->isStaticLocal();
481 // FIXME: What about CapturedDecls (and declarations nested within them)?
482 return isa<TagDecl, BlockDecl>(Val: D);
483 }
484
485 // Otherwise, we only care about anonymous class members / block-scope decls.
486 // FIXME: We need to handle blocks within inline / templated variables too.
487 if (D->getDeclName())
488 return false;
489 if (!isa<RecordDecl, ObjCInterfaceDecl>(D->getLexicalDeclContext()))
490 return false;
491 return isa<TagDecl, FieldDecl>(Val: D);
492}
493

source code of clang/lib/Serialization/ASTCommon.cpp