clang/lib/Serialization/ASTCommon.cpp

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