1 //===- ASTWriter.cpp - AST File Writer ------------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file defines the ASTWriter class, which writes AST files. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "clang/Serialization/ASTWriter.h" 15 #include "ASTCommon.h" 16 #include "ASTReaderInternals.h" 17 #include "MultiOnDiskHashTable.h" 18 #include "clang/AST/ASTContext.h" 19 #include "clang/AST/ASTUnresolvedSet.h" 20 #include "clang/AST/Attr.h" 21 #include "clang/AST/Decl.h" 22 #include "clang/AST/DeclBase.h" 23 #include "clang/AST/DeclCXX.h" 24 #include "clang/AST/DeclContextInternals.h" 25 #include "clang/AST/DeclFriend.h" 26 #include "clang/AST/DeclObjC.h" 27 #include "clang/AST/DeclTemplate.h" 28 #include "clang/AST/DeclarationName.h" 29 #include "clang/AST/Expr.h" 30 #include "clang/AST/ExprCXX.h" 31 #include "clang/AST/LambdaCapture.h" 32 #include "clang/AST/NestedNameSpecifier.h" 33 #include "clang/AST/RawCommentList.h" 34 #include "clang/AST/TemplateName.h" 35 #include "clang/AST/Type.h" 36 #include "clang/AST/TypeLocVisitor.h" 37 #include "clang/Basic/Diagnostic.h" 38 #include "clang/Basic/DiagnosticOptions.h" 39 #include "clang/Basic/FileManager.h" 40 #include "clang/Basic/FileSystemOptions.h" 41 #include "clang/Basic/IdentifierTable.h" 42 #include "clang/Basic/LLVM.h" 43 #include "clang/Basic/Lambda.h" 44 #include "clang/Basic/LangOptions.h" 45 #include "clang/Basic/MemoryBufferCache.h" 46 #include "clang/Basic/Module.h" 47 #include "clang/Basic/ObjCRuntime.h" 48 #include "clang/Basic/OpenCLOptions.h" 49 #include "clang/Basic/SourceLocation.h" 50 #include "clang/Basic/SourceManager.h" 51 #include "clang/Basic/SourceManagerInternals.h" 52 #include "clang/Basic/Specifiers.h" 53 #include "clang/Basic/TargetInfo.h" 54 #include "clang/Basic/TargetOptions.h" 55 #include "clang/Basic/Version.h" 56 #include "clang/Basic/VersionTuple.h" 57 #include "clang/Lex/HeaderSearch.h" 58 #include "clang/Lex/HeaderSearchOptions.h" 59 #include "clang/Lex/MacroInfo.h" 60 #include "clang/Lex/ModuleMap.h" 61 #include "clang/Lex/PreprocessingRecord.h" 62 #include "clang/Lex/Preprocessor.h" 63 #include "clang/Lex/PreprocessorOptions.h" 64 #include "clang/Lex/Token.h" 65 #include "clang/Sema/IdentifierResolver.h" 66 #include "clang/Sema/ObjCMethodList.h" 67 #include "clang/Sema/Sema.h" 68 #include "clang/Sema/Weak.h" 69 #include "clang/Serialization/ASTReader.h" 70 #include "clang/Serialization/Module.h" 71 #include "clang/Serialization/ModuleFileExtension.h" 72 #include "clang/Serialization/SerializationDiagnostic.h" 73 #include "llvm/ADT/APFloat.h" 74 #include "llvm/ADT/APInt.h" 75 #include "llvm/ADT/APSInt.h" 76 #include "llvm/ADT/ArrayRef.h" 77 #include "llvm/ADT/DenseMap.h" 78 #include "llvm/ADT/Hashing.h" 79 #include "llvm/ADT/Optional.h" 80 #include "llvm/ADT/PointerIntPair.h" 81 #include "llvm/ADT/STLExtras.h" 82 #include "llvm/ADT/SmallSet.h" 83 #include "llvm/ADT/SmallString.h" 84 #include "llvm/ADT/SmallVector.h" 85 #include "llvm/ADT/StringMap.h" 86 #include "llvm/ADT/StringRef.h" 87 #include "llvm/Bitcode/BitCodes.h" 88 #include "llvm/Bitcode/BitstreamWriter.h" 89 #include "llvm/Support/Casting.h" 90 #include "llvm/Support/Compression.h" 91 #include "llvm/Support/DJB.h" 92 #include "llvm/Support/Endian.h" 93 #include "llvm/Support/EndianStream.h" 94 #include "llvm/Support/Error.h" 95 #include "llvm/Support/ErrorHandling.h" 96 #include "llvm/Support/MemoryBuffer.h" 97 #include "llvm/Support/OnDiskHashTable.h" 98 #include "llvm/Support/Path.h" 99 #include "llvm/Support/SHA1.h" 100 #include "llvm/Support/raw_ostream.h" 101 #include <algorithm> 102 #include <cassert> 103 #include <cstdint> 104 #include <cstdlib> 105 #include <cstring> 106 #include <ctime> 107 #include <deque> 108 #include <limits> 109 #include <memory> 110 #include <queue> 111 #include <tuple> 112 #include <utility> 113 #include <vector> 114 115 using namespace clang; 116 using namespace clang::serialization; 117 118 template <typename T, typename Allocator> 119 static StringRef bytes(const std::vector<T, Allocator> &v) { 120 if (v.empty()) return StringRef(); 121 return StringRef(reinterpret_cast<const char*>(&v[0]), 122 sizeof(T) * v.size()); 123 } 124 125 template <typename T> 126 static StringRef bytes(const SmallVectorImpl<T> &v) { 127 return StringRef(reinterpret_cast<const char*>(v.data()), 128 sizeof(T) * v.size()); 129 } 130 131 //===----------------------------------------------------------------------===// 132 // Type serialization 133 //===----------------------------------------------------------------------===// 134 135 namespace clang { 136 137 class ASTTypeWriter { 138 ASTWriter &Writer; 139 ASTRecordWriter Record; 140 141 /// \brief Type code that corresponds to the record generated. 142 TypeCode Code = static_cast<TypeCode>(0); 143 144 /// \brief Abbreviation to use for the record, if any. 145 unsigned AbbrevToUse = 0; 146 147 public: 148 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record) 149 : Writer(Writer), Record(Writer, Record) {} 150 151 uint64_t Emit() { 152 return Record.Emit(Code, AbbrevToUse); 153 } 154 155 void Visit(QualType T) { 156 if (T.hasLocalNonFastQualifiers()) { 157 Qualifiers Qs = T.getLocalQualifiers(); 158 Record.AddTypeRef(T.getLocalUnqualifiedType()); 159 Record.push_back(Qs.getAsOpaqueValue()); 160 Code = TYPE_EXT_QUAL; 161 AbbrevToUse = Writer.TypeExtQualAbbrev; 162 } else { 163 switch (T->getTypeClass()) { 164 // For all of the concrete, non-dependent types, call the 165 // appropriate visitor function. 166 #define TYPE(Class, Base) \ 167 case Type::Class: Visit##Class##Type(cast<Class##Type>(T)); break; 168 #define ABSTRACT_TYPE(Class, Base) 169 #include "clang/AST/TypeNodes.def" 170 } 171 } 172 } 173 174 void VisitArrayType(const ArrayType *T); 175 void VisitFunctionType(const FunctionType *T); 176 void VisitTagType(const TagType *T); 177 178 #define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T); 179 #define ABSTRACT_TYPE(Class, Base) 180 #include "clang/AST/TypeNodes.def" 181 }; 182 183 } // namespace clang 184 185 void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) { 186 llvm_unreachable("Built-in types are never serialized"); 187 } 188 189 void ASTTypeWriter::VisitComplexType(const ComplexType *T) { 190 Record.AddTypeRef(T->getElementType()); 191 Code = TYPE_COMPLEX; 192 } 193 194 void ASTTypeWriter::VisitPointerType(const PointerType *T) { 195 Record.AddTypeRef(T->getPointeeType()); 196 Code = TYPE_POINTER; 197 } 198 199 void ASTTypeWriter::VisitDecayedType(const DecayedType *T) { 200 Record.AddTypeRef(T->getOriginalType()); 201 Code = TYPE_DECAYED; 202 } 203 204 void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) { 205 Record.AddTypeRef(T->getOriginalType()); 206 Record.AddTypeRef(T->getAdjustedType()); 207 Code = TYPE_ADJUSTED; 208 } 209 210 void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) { 211 Record.AddTypeRef(T->getPointeeType()); 212 Code = TYPE_BLOCK_POINTER; 213 } 214 215 void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) { 216 Record.AddTypeRef(T->getPointeeTypeAsWritten()); 217 Record.push_back(T->isSpelledAsLValue()); 218 Code = TYPE_LVALUE_REFERENCE; 219 } 220 221 void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) { 222 Record.AddTypeRef(T->getPointeeTypeAsWritten()); 223 Code = TYPE_RVALUE_REFERENCE; 224 } 225 226 void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) { 227 Record.AddTypeRef(T->getPointeeType()); 228 Record.AddTypeRef(QualType(T->getClass(), 0)); 229 Code = TYPE_MEMBER_POINTER; 230 } 231 232 void ASTTypeWriter::VisitArrayType(const ArrayType *T) { 233 Record.AddTypeRef(T->getElementType()); 234 Record.push_back(T->getSizeModifier()); // FIXME: stable values 235 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values 236 } 237 238 void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) { 239 VisitArrayType(T); 240 Record.AddAPInt(T->getSize()); 241 Code = TYPE_CONSTANT_ARRAY; 242 } 243 244 void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) { 245 VisitArrayType(T); 246 Code = TYPE_INCOMPLETE_ARRAY; 247 } 248 249 void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) { 250 VisitArrayType(T); 251 Record.AddSourceLocation(T->getLBracketLoc()); 252 Record.AddSourceLocation(T->getRBracketLoc()); 253 Record.AddStmt(T->getSizeExpr()); 254 Code = TYPE_VARIABLE_ARRAY; 255 } 256 257 void ASTTypeWriter::VisitVectorType(const VectorType *T) { 258 Record.AddTypeRef(T->getElementType()); 259 Record.push_back(T->getNumElements()); 260 Record.push_back(T->getVectorKind()); 261 Code = TYPE_VECTOR; 262 } 263 264 void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) { 265 VisitVectorType(T); 266 Code = TYPE_EXT_VECTOR; 267 } 268 269 void ASTTypeWriter::VisitFunctionType(const FunctionType *T) { 270 Record.AddTypeRef(T->getReturnType()); 271 FunctionType::ExtInfo C = T->getExtInfo(); 272 Record.push_back(C.getNoReturn()); 273 Record.push_back(C.getHasRegParm()); 274 Record.push_back(C.getRegParm()); 275 // FIXME: need to stabilize encoding of calling convention... 276 Record.push_back(C.getCC()); 277 Record.push_back(C.getProducesResult()); 278 Record.push_back(C.getNoCallerSavedRegs()); 279 Record.push_back(C.getNoCfCheck()); 280 281 if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult()) 282 AbbrevToUse = 0; 283 } 284 285 void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) { 286 VisitFunctionType(T); 287 Code = TYPE_FUNCTION_NO_PROTO; 288 } 289 290 static void addExceptionSpec(const FunctionProtoType *T, 291 ASTRecordWriter &Record) { 292 Record.push_back(T->getExceptionSpecType()); 293 if (T->getExceptionSpecType() == EST_Dynamic) { 294 Record.push_back(T->getNumExceptions()); 295 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I) 296 Record.AddTypeRef(T->getExceptionType(I)); 297 } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) { 298 Record.AddStmt(T->getNoexceptExpr()); 299 } else if (T->getExceptionSpecType() == EST_Uninstantiated) { 300 Record.AddDeclRef(T->getExceptionSpecDecl()); 301 Record.AddDeclRef(T->getExceptionSpecTemplate()); 302 } else if (T->getExceptionSpecType() == EST_Unevaluated) { 303 Record.AddDeclRef(T->getExceptionSpecDecl()); 304 } 305 } 306 307 void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) { 308 VisitFunctionType(T); 309 310 Record.push_back(T->isVariadic()); 311 Record.push_back(T->hasTrailingReturn()); 312 Record.push_back(T->getTypeQuals()); 313 Record.push_back(static_cast<unsigned>(T->getRefQualifier())); 314 addExceptionSpec(T, Record); 315 316 Record.push_back(T->getNumParams()); 317 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I) 318 Record.AddTypeRef(T->getParamType(I)); 319 320 if (T->hasExtParameterInfos()) { 321 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I) 322 Record.push_back(T->getExtParameterInfo(I).getOpaqueValue()); 323 } 324 325 if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() || 326 T->getRefQualifier() || T->getExceptionSpecType() != EST_None || 327 T->hasExtParameterInfos()) 328 AbbrevToUse = 0; 329 330 Code = TYPE_FUNCTION_PROTO; 331 } 332 333 void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) { 334 Record.AddDeclRef(T->getDecl()); 335 Code = TYPE_UNRESOLVED_USING; 336 } 337 338 void ASTTypeWriter::VisitTypedefType(const TypedefType *T) { 339 Record.AddDeclRef(T->getDecl()); 340 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?"); 341 Record.AddTypeRef(T->getCanonicalTypeInternal()); 342 Code = TYPE_TYPEDEF; 343 } 344 345 void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) { 346 Record.AddStmt(T->getUnderlyingExpr()); 347 Code = TYPE_TYPEOF_EXPR; 348 } 349 350 void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) { 351 Record.AddTypeRef(T->getUnderlyingType()); 352 Code = TYPE_TYPEOF; 353 } 354 355 void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) { 356 Record.AddTypeRef(T->getUnderlyingType()); 357 Record.AddStmt(T->getUnderlyingExpr()); 358 Code = TYPE_DECLTYPE; 359 } 360 361 void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) { 362 Record.AddTypeRef(T->getBaseType()); 363 Record.AddTypeRef(T->getUnderlyingType()); 364 Record.push_back(T->getUTTKind()); 365 Code = TYPE_UNARY_TRANSFORM; 366 } 367 368 void ASTTypeWriter::VisitAutoType(const AutoType *T) { 369 Record.AddTypeRef(T->getDeducedType()); 370 Record.push_back((unsigned)T->getKeyword()); 371 if (T->getDeducedType().isNull()) 372 Record.push_back(T->isDependentType()); 373 Code = TYPE_AUTO; 374 } 375 376 void ASTTypeWriter::VisitDeducedTemplateSpecializationType( 377 const DeducedTemplateSpecializationType *T) { 378 Record.AddTemplateName(T->getTemplateName()); 379 Record.AddTypeRef(T->getDeducedType()); 380 if (T->getDeducedType().isNull()) 381 Record.push_back(T->isDependentType()); 382 Code = TYPE_DEDUCED_TEMPLATE_SPECIALIZATION; 383 } 384 385 void ASTTypeWriter::VisitTagType(const TagType *T) { 386 Record.push_back(T->isDependentType()); 387 Record.AddDeclRef(T->getDecl()->getCanonicalDecl()); 388 assert(!T->isBeingDefined() && 389 "Cannot serialize in the middle of a type definition"); 390 } 391 392 void ASTTypeWriter::VisitRecordType(const RecordType *T) { 393 VisitTagType(T); 394 Code = TYPE_RECORD; 395 } 396 397 void ASTTypeWriter::VisitEnumType(const EnumType *T) { 398 VisitTagType(T); 399 Code = TYPE_ENUM; 400 } 401 402 void ASTTypeWriter::VisitAttributedType(const AttributedType *T) { 403 Record.AddTypeRef(T->getModifiedType()); 404 Record.AddTypeRef(T->getEquivalentType()); 405 Record.push_back(T->getAttrKind()); 406 Code = TYPE_ATTRIBUTED; 407 } 408 409 void 410 ASTTypeWriter::VisitSubstTemplateTypeParmType( 411 const SubstTemplateTypeParmType *T) { 412 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0)); 413 Record.AddTypeRef(T->getReplacementType()); 414 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM; 415 } 416 417 void 418 ASTTypeWriter::VisitSubstTemplateTypeParmPackType( 419 const SubstTemplateTypeParmPackType *T) { 420 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0)); 421 Record.AddTemplateArgument(T->getArgumentPack()); 422 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK; 423 } 424 425 void 426 ASTTypeWriter::VisitTemplateSpecializationType( 427 const TemplateSpecializationType *T) { 428 Record.push_back(T->isDependentType()); 429 Record.AddTemplateName(T->getTemplateName()); 430 Record.push_back(T->getNumArgs()); 431 for (const auto &ArgI : *T) 432 Record.AddTemplateArgument(ArgI); 433 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType() 434 : T->isCanonicalUnqualified() 435 ? QualType() 436 : T->getCanonicalTypeInternal()); 437 Code = TYPE_TEMPLATE_SPECIALIZATION; 438 } 439 440 void 441 ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) { 442 VisitArrayType(T); 443 Record.AddStmt(T->getSizeExpr()); 444 Record.AddSourceRange(T->getBracketsRange()); 445 Code = TYPE_DEPENDENT_SIZED_ARRAY; 446 } 447 448 void 449 ASTTypeWriter::VisitDependentSizedExtVectorType( 450 const DependentSizedExtVectorType *T) { 451 Record.AddTypeRef(T->getElementType()); 452 Record.AddStmt(T->getSizeExpr()); 453 Record.AddSourceLocation(T->getAttributeLoc()); 454 Code = TYPE_DEPENDENT_SIZED_EXT_VECTOR; 455 } 456 457 void 458 ASTTypeWriter::VisitDependentAddressSpaceType( 459 const DependentAddressSpaceType *T) { 460 Record.AddTypeRef(T->getPointeeType()); 461 Record.AddStmt(T->getAddrSpaceExpr()); 462 Record.AddSourceLocation(T->getAttributeLoc()); 463 Code = TYPE_DEPENDENT_ADDRESS_SPACE; 464 } 465 466 void 467 ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) { 468 Record.push_back(T->getDepth()); 469 Record.push_back(T->getIndex()); 470 Record.push_back(T->isParameterPack()); 471 Record.AddDeclRef(T->getDecl()); 472 Code = TYPE_TEMPLATE_TYPE_PARM; 473 } 474 475 void 476 ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) { 477 Record.push_back(T->getKeyword()); 478 Record.AddNestedNameSpecifier(T->getQualifier()); 479 Record.AddIdentifierRef(T->getIdentifier()); 480 Record.AddTypeRef( 481 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal()); 482 Code = TYPE_DEPENDENT_NAME; 483 } 484 485 void 486 ASTTypeWriter::VisitDependentTemplateSpecializationType( 487 const DependentTemplateSpecializationType *T) { 488 Record.push_back(T->getKeyword()); 489 Record.AddNestedNameSpecifier(T->getQualifier()); 490 Record.AddIdentifierRef(T->getIdentifier()); 491 Record.push_back(T->getNumArgs()); 492 for (const auto &I : *T) 493 Record.AddTemplateArgument(I); 494 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION; 495 } 496 497 void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) { 498 Record.AddTypeRef(T->getPattern()); 499 if (Optional<unsigned> NumExpansions = T->getNumExpansions()) 500 Record.push_back(*NumExpansions + 1); 501 else 502 Record.push_back(0); 503 Code = TYPE_PACK_EXPANSION; 504 } 505 506 void ASTTypeWriter::VisitParenType(const ParenType *T) { 507 Record.AddTypeRef(T->getInnerType()); 508 Code = TYPE_PAREN; 509 } 510 511 void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) { 512 Record.push_back(T->getKeyword()); 513 Record.AddNestedNameSpecifier(T->getQualifier()); 514 Record.AddTypeRef(T->getNamedType()); 515 Code = TYPE_ELABORATED; 516 } 517 518 void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) { 519 Record.AddDeclRef(T->getDecl()->getCanonicalDecl()); 520 Record.AddTypeRef(T->getInjectedSpecializationType()); 521 Code = TYPE_INJECTED_CLASS_NAME; 522 } 523 524 void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) { 525 Record.AddDeclRef(T->getDecl()->getCanonicalDecl()); 526 Code = TYPE_OBJC_INTERFACE; 527 } 528 529 void ASTTypeWriter::VisitObjCTypeParamType(const ObjCTypeParamType *T) { 530 Record.AddDeclRef(T->getDecl()); 531 Record.push_back(T->getNumProtocols()); 532 for (const auto *I : T->quals()) 533 Record.AddDeclRef(I); 534 Code = TYPE_OBJC_TYPE_PARAM; 535 } 536 537 void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) { 538 Record.AddTypeRef(T->getBaseType()); 539 Record.push_back(T->getTypeArgsAsWritten().size()); 540 for (auto TypeArg : T->getTypeArgsAsWritten()) 541 Record.AddTypeRef(TypeArg); 542 Record.push_back(T->getNumProtocols()); 543 for (const auto *I : T->quals()) 544 Record.AddDeclRef(I); 545 Record.push_back(T->isKindOfTypeAsWritten()); 546 Code = TYPE_OBJC_OBJECT; 547 } 548 549 void 550 ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) { 551 Record.AddTypeRef(T->getPointeeType()); 552 Code = TYPE_OBJC_OBJECT_POINTER; 553 } 554 555 void 556 ASTTypeWriter::VisitAtomicType(const AtomicType *T) { 557 Record.AddTypeRef(T->getValueType()); 558 Code = TYPE_ATOMIC; 559 } 560 561 void 562 ASTTypeWriter::VisitPipeType(const PipeType *T) { 563 Record.AddTypeRef(T->getElementType()); 564 Record.push_back(T->isReadOnly()); 565 Code = TYPE_PIPE; 566 } 567 568 namespace { 569 570 class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> { 571 ASTRecordWriter &Record; 572 573 public: 574 TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {} 575 576 #define ABSTRACT_TYPELOC(CLASS, PARENT) 577 #define TYPELOC(CLASS, PARENT) \ 578 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc); 579 #include "clang/AST/TypeLocNodes.def" 580 581 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc); 582 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc); 583 }; 584 585 } // namespace 586 587 void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) { 588 // nothing to do 589 } 590 591 void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) { 592 Record.AddSourceLocation(TL.getBuiltinLoc()); 593 if (TL.needsExtraLocalData()) { 594 Record.push_back(TL.getWrittenTypeSpec()); 595 Record.push_back(TL.getWrittenSignSpec()); 596 Record.push_back(TL.getWrittenWidthSpec()); 597 Record.push_back(TL.hasModeAttr()); 598 } 599 } 600 601 void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) { 602 Record.AddSourceLocation(TL.getNameLoc()); 603 } 604 605 void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) { 606 Record.AddSourceLocation(TL.getStarLoc()); 607 } 608 609 void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) { 610 // nothing to do 611 } 612 613 void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) { 614 // nothing to do 615 } 616 617 void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) { 618 Record.AddSourceLocation(TL.getCaretLoc()); 619 } 620 621 void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) { 622 Record.AddSourceLocation(TL.getAmpLoc()); 623 } 624 625 void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) { 626 Record.AddSourceLocation(TL.getAmpAmpLoc()); 627 } 628 629 void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) { 630 Record.AddSourceLocation(TL.getStarLoc()); 631 Record.AddTypeSourceInfo(TL.getClassTInfo()); 632 } 633 634 void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) { 635 Record.AddSourceLocation(TL.getLBracketLoc()); 636 Record.AddSourceLocation(TL.getRBracketLoc()); 637 Record.push_back(TL.getSizeExpr() ? 1 : 0); 638 if (TL.getSizeExpr()) 639 Record.AddStmt(TL.getSizeExpr()); 640 } 641 642 void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) { 643 VisitArrayTypeLoc(TL); 644 } 645 646 void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) { 647 VisitArrayTypeLoc(TL); 648 } 649 650 void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) { 651 VisitArrayTypeLoc(TL); 652 } 653 654 void TypeLocWriter::VisitDependentSizedArrayTypeLoc( 655 DependentSizedArrayTypeLoc TL) { 656 VisitArrayTypeLoc(TL); 657 } 658 659 void TypeLocWriter::VisitDependentAddressSpaceTypeLoc( 660 DependentAddressSpaceTypeLoc TL) { 661 Record.AddSourceLocation(TL.getAttrNameLoc()); 662 SourceRange range = TL.getAttrOperandParensRange(); 663 Record.AddSourceLocation(range.getBegin()); 664 Record.AddSourceLocation(range.getEnd()); 665 Record.AddStmt(TL.getAttrExprOperand()); 666 } 667 668 void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc( 669 DependentSizedExtVectorTypeLoc TL) { 670 Record.AddSourceLocation(TL.getNameLoc()); 671 } 672 673 void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) { 674 Record.AddSourceLocation(TL.getNameLoc()); 675 } 676 677 void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) { 678 Record.AddSourceLocation(TL.getNameLoc()); 679 } 680 681 void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) { 682 Record.AddSourceLocation(TL.getLocalRangeBegin()); 683 Record.AddSourceLocation(TL.getLParenLoc()); 684 Record.AddSourceLocation(TL.getRParenLoc()); 685 Record.AddSourceRange(TL.getExceptionSpecRange()); 686 Record.AddSourceLocation(TL.getLocalRangeEnd()); 687 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i) 688 Record.AddDeclRef(TL.getParam(i)); 689 } 690 691 void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) { 692 VisitFunctionTypeLoc(TL); 693 } 694 695 void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) { 696 VisitFunctionTypeLoc(TL); 697 } 698 699 void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) { 700 Record.AddSourceLocation(TL.getNameLoc()); 701 } 702 703 void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) { 704 Record.AddSourceLocation(TL.getNameLoc()); 705 } 706 707 void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) { 708 if (TL.getNumProtocols()) { 709 Record.AddSourceLocation(TL.getProtocolLAngleLoc()); 710 Record.AddSourceLocation(TL.getProtocolRAngleLoc()); 711 } 712 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i) 713 Record.AddSourceLocation(TL.getProtocolLoc(i)); 714 } 715 716 void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) { 717 Record.AddSourceLocation(TL.getTypeofLoc()); 718 Record.AddSourceLocation(TL.getLParenLoc()); 719 Record.AddSourceLocation(TL.getRParenLoc()); 720 } 721 722 void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) { 723 Record.AddSourceLocation(TL.getTypeofLoc()); 724 Record.AddSourceLocation(TL.getLParenLoc()); 725 Record.AddSourceLocation(TL.getRParenLoc()); 726 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo()); 727 } 728 729 void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) { 730 Record.AddSourceLocation(TL.getNameLoc()); 731 } 732 733 void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) { 734 Record.AddSourceLocation(TL.getKWLoc()); 735 Record.AddSourceLocation(TL.getLParenLoc()); 736 Record.AddSourceLocation(TL.getRParenLoc()); 737 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo()); 738 } 739 740 void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) { 741 Record.AddSourceLocation(TL.getNameLoc()); 742 } 743 744 void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc( 745 DeducedTemplateSpecializationTypeLoc TL) { 746 Record.AddSourceLocation(TL.getTemplateNameLoc()); 747 } 748 749 void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) { 750 Record.AddSourceLocation(TL.getNameLoc()); 751 } 752 753 void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) { 754 Record.AddSourceLocation(TL.getNameLoc()); 755 } 756 757 void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) { 758 Record.AddSourceLocation(TL.getAttrNameLoc()); 759 if (TL.hasAttrOperand()) { 760 SourceRange range = TL.getAttrOperandParensRange(); 761 Record.AddSourceLocation(range.getBegin()); 762 Record.AddSourceLocation(range.getEnd()); 763 } 764 if (TL.hasAttrExprOperand()) { 765 Expr *operand = TL.getAttrExprOperand(); 766 Record.push_back(operand ? 1 : 0); 767 if (operand) Record.AddStmt(operand); 768 } else if (TL.hasAttrEnumOperand()) { 769 Record.AddSourceLocation(TL.getAttrEnumOperandLoc()); 770 } 771 } 772 773 void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) { 774 Record.AddSourceLocation(TL.getNameLoc()); 775 } 776 777 void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc( 778 SubstTemplateTypeParmTypeLoc TL) { 779 Record.AddSourceLocation(TL.getNameLoc()); 780 } 781 782 void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc( 783 SubstTemplateTypeParmPackTypeLoc TL) { 784 Record.AddSourceLocation(TL.getNameLoc()); 785 } 786 787 void TypeLocWriter::VisitTemplateSpecializationTypeLoc( 788 TemplateSpecializationTypeLoc TL) { 789 Record.AddSourceLocation(TL.getTemplateKeywordLoc()); 790 Record.AddSourceLocation(TL.getTemplateNameLoc()); 791 Record.AddSourceLocation(TL.getLAngleLoc()); 792 Record.AddSourceLocation(TL.getRAngleLoc()); 793 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i) 794 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(), 795 TL.getArgLoc(i).getLocInfo()); 796 } 797 798 void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) { 799 Record.AddSourceLocation(TL.getLParenLoc()); 800 Record.AddSourceLocation(TL.getRParenLoc()); 801 } 802 803 void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) { 804 Record.AddSourceLocation(TL.getElaboratedKeywordLoc()); 805 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc()); 806 } 807 808 void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) { 809 Record.AddSourceLocation(TL.getNameLoc()); 810 } 811 812 void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) { 813 Record.AddSourceLocation(TL.getElaboratedKeywordLoc()); 814 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc()); 815 Record.AddSourceLocation(TL.getNameLoc()); 816 } 817 818 void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc( 819 DependentTemplateSpecializationTypeLoc TL) { 820 Record.AddSourceLocation(TL.getElaboratedKeywordLoc()); 821 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc()); 822 Record.AddSourceLocation(TL.getTemplateKeywordLoc()); 823 Record.AddSourceLocation(TL.getTemplateNameLoc()); 824 Record.AddSourceLocation(TL.getLAngleLoc()); 825 Record.AddSourceLocation(TL.getRAngleLoc()); 826 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) 827 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(), 828 TL.getArgLoc(I).getLocInfo()); 829 } 830 831 void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) { 832 Record.AddSourceLocation(TL.getEllipsisLoc()); 833 } 834 835 void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) { 836 Record.AddSourceLocation(TL.getNameLoc()); 837 } 838 839 void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) { 840 Record.push_back(TL.hasBaseTypeAsWritten()); 841 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc()); 842 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc()); 843 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i) 844 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i)); 845 Record.AddSourceLocation(TL.getProtocolLAngleLoc()); 846 Record.AddSourceLocation(TL.getProtocolRAngleLoc()); 847 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i) 848 Record.AddSourceLocation(TL.getProtocolLoc(i)); 849 } 850 851 void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) { 852 Record.AddSourceLocation(TL.getStarLoc()); 853 } 854 855 void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) { 856 Record.AddSourceLocation(TL.getKWLoc()); 857 Record.AddSourceLocation(TL.getLParenLoc()); 858 Record.AddSourceLocation(TL.getRParenLoc()); 859 } 860 861 void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) { 862 Record.AddSourceLocation(TL.getKWLoc()); 863 } 864 865 void ASTWriter::WriteTypeAbbrevs() { 866 using namespace llvm; 867 868 std::shared_ptr<BitCodeAbbrev> Abv; 869 870 // Abbreviation for TYPE_EXT_QUAL 871 Abv = std::make_shared<BitCodeAbbrev>(); 872 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL)); 873 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type 874 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals 875 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv)); 876 877 // Abbreviation for TYPE_FUNCTION_PROTO 878 Abv = std::make_shared<BitCodeAbbrev>(); 879 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO)); 880 // FunctionType 881 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType 882 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn 883 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm 884 Abv->Add(BitCodeAbbrevOp(0)); // RegParm 885 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC 886 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult 887 Abv->Add(BitCodeAbbrevOp(0)); // NoCallerSavedRegs 888 Abv->Add(BitCodeAbbrevOp(0)); // NoCfCheck 889 // FunctionProtoType 890 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic 891 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn 892 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals 893 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier 894 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec 895 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams 896 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array)); 897 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params 898 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv)); 899 } 900 901 //===----------------------------------------------------------------------===// 902 // ASTWriter Implementation 903 //===----------------------------------------------------------------------===// 904 905 static void EmitBlockID(unsigned ID, const char *Name, 906 llvm::BitstreamWriter &Stream, 907 ASTWriter::RecordDataImpl &Record) { 908 Record.clear(); 909 Record.push_back(ID); 910 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record); 911 912 // Emit the block name if present. 913 if (!Name || Name[0] == 0) 914 return; 915 Record.clear(); 916 while (*Name) 917 Record.push_back(*Name++); 918 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record); 919 } 920 921 static void EmitRecordID(unsigned ID, const char *Name, 922 llvm::BitstreamWriter &Stream, 923 ASTWriter::RecordDataImpl &Record) { 924 Record.clear(); 925 Record.push_back(ID); 926 while (*Name) 927 Record.push_back(*Name++); 928 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record); 929 } 930 931 static void AddStmtsExprs(llvm::BitstreamWriter &Stream, 932 ASTWriter::RecordDataImpl &Record) { 933 #define RECORD(X) EmitRecordID(X, #X, Stream, Record) 934 RECORD(STMT_STOP); 935 RECORD(STMT_NULL_PTR); 936 RECORD(STMT_REF_PTR); 937 RECORD(STMT_NULL); 938 RECORD(STMT_COMPOUND); 939 RECORD(STMT_CASE); 940 RECORD(STMT_DEFAULT); 941 RECORD(STMT_LABEL); 942 RECORD(STMT_ATTRIBUTED); 943 RECORD(STMT_IF); 944 RECORD(STMT_SWITCH); 945 RECORD(STMT_WHILE); 946 RECORD(STMT_DO); 947 RECORD(STMT_FOR); 948 RECORD(STMT_GOTO); 949 RECORD(STMT_INDIRECT_GOTO); 950 RECORD(STMT_CONTINUE); 951 RECORD(STMT_BREAK); 952 RECORD(STMT_RETURN); 953 RECORD(STMT_DECL); 954 RECORD(STMT_GCCASM); 955 RECORD(STMT_MSASM); 956 RECORD(EXPR_PREDEFINED); 957 RECORD(EXPR_DECL_REF); 958 RECORD(EXPR_INTEGER_LITERAL); 959 RECORD(EXPR_FLOATING_LITERAL); 960 RECORD(EXPR_IMAGINARY_LITERAL); 961 RECORD(EXPR_STRING_LITERAL); 962 RECORD(EXPR_CHARACTER_LITERAL); 963 RECORD(EXPR_PAREN); 964 RECORD(EXPR_PAREN_LIST); 965 RECORD(EXPR_UNARY_OPERATOR); 966 RECORD(EXPR_SIZEOF_ALIGN_OF); 967 RECORD(EXPR_ARRAY_SUBSCRIPT); 968 RECORD(EXPR_CALL); 969 RECORD(EXPR_MEMBER); 970 RECORD(EXPR_BINARY_OPERATOR); 971 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR); 972 RECORD(EXPR_CONDITIONAL_OPERATOR); 973 RECORD(EXPR_IMPLICIT_CAST); 974 RECORD(EXPR_CSTYLE_CAST); 975 RECORD(EXPR_COMPOUND_LITERAL); 976 RECORD(EXPR_EXT_VECTOR_ELEMENT); 977 RECORD(EXPR_INIT_LIST); 978 RECORD(EXPR_DESIGNATED_INIT); 979 RECORD(EXPR_DESIGNATED_INIT_UPDATE); 980 RECORD(EXPR_IMPLICIT_VALUE_INIT); 981 RECORD(EXPR_NO_INIT); 982 RECORD(EXPR_VA_ARG); 983 RECORD(EXPR_ADDR_LABEL); 984 RECORD(EXPR_STMT); 985 RECORD(EXPR_CHOOSE); 986 RECORD(EXPR_GNU_NULL); 987 RECORD(EXPR_SHUFFLE_VECTOR); 988 RECORD(EXPR_BLOCK); 989 RECORD(EXPR_GENERIC_SELECTION); 990 RECORD(EXPR_OBJC_STRING_LITERAL); 991 RECORD(EXPR_OBJC_BOXED_EXPRESSION); 992 RECORD(EXPR_OBJC_ARRAY_LITERAL); 993 RECORD(EXPR_OBJC_DICTIONARY_LITERAL); 994 RECORD(EXPR_OBJC_ENCODE); 995 RECORD(EXPR_OBJC_SELECTOR_EXPR); 996 RECORD(EXPR_OBJC_PROTOCOL_EXPR); 997 RECORD(EXPR_OBJC_IVAR_REF_EXPR); 998 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR); 999 RECORD(EXPR_OBJC_KVC_REF_EXPR); 1000 RECORD(EXPR_OBJC_MESSAGE_EXPR); 1001 RECORD(STMT_OBJC_FOR_COLLECTION); 1002 RECORD(STMT_OBJC_CATCH); 1003 RECORD(STMT_OBJC_FINALLY); 1004 RECORD(STMT_OBJC_AT_TRY); 1005 RECORD(STMT_OBJC_AT_SYNCHRONIZED); 1006 RECORD(STMT_OBJC_AT_THROW); 1007 RECORD(EXPR_OBJC_BOOL_LITERAL); 1008 RECORD(STMT_CXX_CATCH); 1009 RECORD(STMT_CXX_TRY); 1010 RECORD(STMT_CXX_FOR_RANGE); 1011 RECORD(EXPR_CXX_OPERATOR_CALL); 1012 RECORD(EXPR_CXX_MEMBER_CALL); 1013 RECORD(EXPR_CXX_CONSTRUCT); 1014 RECORD(EXPR_CXX_TEMPORARY_OBJECT); 1015 RECORD(EXPR_CXX_STATIC_CAST); 1016 RECORD(EXPR_CXX_DYNAMIC_CAST); 1017 RECORD(EXPR_CXX_REINTERPRET_CAST); 1018 RECORD(EXPR_CXX_CONST_CAST); 1019 RECORD(EXPR_CXX_FUNCTIONAL_CAST); 1020 RECORD(EXPR_USER_DEFINED_LITERAL); 1021 RECORD(EXPR_CXX_STD_INITIALIZER_LIST); 1022 RECORD(EXPR_CXX_BOOL_LITERAL); 1023 RECORD(EXPR_CXX_NULL_PTR_LITERAL); 1024 RECORD(EXPR_CXX_TYPEID_EXPR); 1025 RECORD(EXPR_CXX_TYPEID_TYPE); 1026 RECORD(EXPR_CXX_THIS); 1027 RECORD(EXPR_CXX_THROW); 1028 RECORD(EXPR_CXX_DEFAULT_ARG); 1029 RECORD(EXPR_CXX_DEFAULT_INIT); 1030 RECORD(EXPR_CXX_BIND_TEMPORARY); 1031 RECORD(EXPR_CXX_SCALAR_VALUE_INIT); 1032 RECORD(EXPR_CXX_NEW); 1033 RECORD(EXPR_CXX_DELETE); 1034 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR); 1035 RECORD(EXPR_EXPR_WITH_CLEANUPS); 1036 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER); 1037 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF); 1038 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT); 1039 RECORD(EXPR_CXX_UNRESOLVED_MEMBER); 1040 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP); 1041 RECORD(EXPR_CXX_EXPRESSION_TRAIT); 1042 RECORD(EXPR_CXX_NOEXCEPT); 1043 RECORD(EXPR_OPAQUE_VALUE); 1044 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR); 1045 RECORD(EXPR_TYPE_TRAIT); 1046 RECORD(EXPR_ARRAY_TYPE_TRAIT); 1047 RECORD(EXPR_PACK_EXPANSION); 1048 RECORD(EXPR_SIZEOF_PACK); 1049 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM); 1050 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK); 1051 RECORD(EXPR_FUNCTION_PARM_PACK); 1052 RECORD(EXPR_MATERIALIZE_TEMPORARY); 1053 RECORD(EXPR_CUDA_KERNEL_CALL); 1054 RECORD(EXPR_CXX_UUIDOF_EXPR); 1055 RECORD(EXPR_CXX_UUIDOF_TYPE); 1056 RECORD(EXPR_LAMBDA); 1057 #undef RECORD 1058 } 1059 1060 void ASTWriter::WriteBlockInfoBlock() { 1061 RecordData Record; 1062 Stream.EnterBlockInfoBlock(); 1063 1064 #define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record) 1065 #define RECORD(X) EmitRecordID(X, #X, Stream, Record) 1066 1067 // Control Block. 1068 BLOCK(CONTROL_BLOCK); 1069 RECORD(METADATA); 1070 RECORD(MODULE_NAME); 1071 RECORD(MODULE_DIRECTORY); 1072 RECORD(MODULE_MAP_FILE); 1073 RECORD(IMPORTS); 1074 RECORD(ORIGINAL_FILE); 1075 RECORD(ORIGINAL_PCH_DIR); 1076 RECORD(ORIGINAL_FILE_ID); 1077 RECORD(INPUT_FILE_OFFSETS); 1078 1079 BLOCK(OPTIONS_BLOCK); 1080 RECORD(LANGUAGE_OPTIONS); 1081 RECORD(TARGET_OPTIONS); 1082 RECORD(FILE_SYSTEM_OPTIONS); 1083 RECORD(HEADER_SEARCH_OPTIONS); 1084 RECORD(PREPROCESSOR_OPTIONS); 1085 1086 BLOCK(INPUT_FILES_BLOCK); 1087 RECORD(INPUT_FILE); 1088 1089 // AST Top-Level Block. 1090 BLOCK(AST_BLOCK); 1091 RECORD(TYPE_OFFSET); 1092 RECORD(DECL_OFFSET); 1093 RECORD(IDENTIFIER_OFFSET); 1094 RECORD(IDENTIFIER_TABLE); 1095 RECORD(EAGERLY_DESERIALIZED_DECLS); 1096 RECORD(MODULAR_CODEGEN_DECLS); 1097 RECORD(SPECIAL_TYPES); 1098 RECORD(STATISTICS); 1099 RECORD(TENTATIVE_DEFINITIONS); 1100 RECORD(SELECTOR_OFFSETS); 1101 RECORD(METHOD_POOL); 1102 RECORD(PP_COUNTER_VALUE); 1103 RECORD(SOURCE_LOCATION_OFFSETS); 1104 RECORD(SOURCE_LOCATION_PRELOADS); 1105 RECORD(EXT_VECTOR_DECLS); 1106 RECORD(UNUSED_FILESCOPED_DECLS); 1107 RECORD(PPD_ENTITIES_OFFSETS); 1108 RECORD(VTABLE_USES); 1109 RECORD(PPD_SKIPPED_RANGES); 1110 RECORD(REFERENCED_SELECTOR_POOL); 1111 RECORD(TU_UPDATE_LEXICAL); 1112 RECORD(SEMA_DECL_REFS); 1113 RECORD(WEAK_UNDECLARED_IDENTIFIERS); 1114 RECORD(PENDING_IMPLICIT_INSTANTIATIONS); 1115 RECORD(UPDATE_VISIBLE); 1116 RECORD(DECL_UPDATE_OFFSETS); 1117 RECORD(DECL_UPDATES); 1118 RECORD(CUDA_SPECIAL_DECL_REFS); 1119 RECORD(HEADER_SEARCH_TABLE); 1120 RECORD(FP_PRAGMA_OPTIONS); 1121 RECORD(OPENCL_EXTENSIONS); 1122 RECORD(OPENCL_EXTENSION_TYPES); 1123 RECORD(OPENCL_EXTENSION_DECLS); 1124 RECORD(DELEGATING_CTORS); 1125 RECORD(KNOWN_NAMESPACES); 1126 RECORD(MODULE_OFFSET_MAP); 1127 RECORD(SOURCE_MANAGER_LINE_TABLE); 1128 RECORD(OBJC_CATEGORIES_MAP); 1129 RECORD(FILE_SORTED_DECLS); 1130 RECORD(IMPORTED_MODULES); 1131 RECORD(OBJC_CATEGORIES); 1132 RECORD(MACRO_OFFSET); 1133 RECORD(INTERESTING_IDENTIFIERS); 1134 RECORD(UNDEFINED_BUT_USED); 1135 RECORD(LATE_PARSED_TEMPLATE); 1136 RECORD(OPTIMIZE_PRAGMA_OPTIONS); 1137 RECORD(MSSTRUCT_PRAGMA_OPTIONS); 1138 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS); 1139 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES); 1140 RECORD(DELETE_EXPRS_TO_ANALYZE); 1141 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH); 1142 RECORD(PP_CONDITIONAL_STACK); 1143 1144 // SourceManager Block. 1145 BLOCK(SOURCE_MANAGER_BLOCK); 1146 RECORD(SM_SLOC_FILE_ENTRY); 1147 RECORD(SM_SLOC_BUFFER_ENTRY); 1148 RECORD(SM_SLOC_BUFFER_BLOB); 1149 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED); 1150 RECORD(SM_SLOC_EXPANSION_ENTRY); 1151 1152 // Preprocessor Block. 1153 BLOCK(PREPROCESSOR_BLOCK); 1154 RECORD(PP_MACRO_DIRECTIVE_HISTORY); 1155 RECORD(PP_MACRO_FUNCTION_LIKE); 1156 RECORD(PP_MACRO_OBJECT_LIKE); 1157 RECORD(PP_MODULE_MACRO); 1158 RECORD(PP_TOKEN); 1159 1160 // Submodule Block. 1161 BLOCK(SUBMODULE_BLOCK); 1162 RECORD(SUBMODULE_METADATA); 1163 RECORD(SUBMODULE_DEFINITION); 1164 RECORD(SUBMODULE_UMBRELLA_HEADER); 1165 RECORD(SUBMODULE_HEADER); 1166 RECORD(SUBMODULE_TOPHEADER); 1167 RECORD(SUBMODULE_UMBRELLA_DIR); 1168 RECORD(SUBMODULE_IMPORTS); 1169 RECORD(SUBMODULE_EXPORTS); 1170 RECORD(SUBMODULE_REQUIRES); 1171 RECORD(SUBMODULE_EXCLUDED_HEADER); 1172 RECORD(SUBMODULE_LINK_LIBRARY); 1173 RECORD(SUBMODULE_CONFIG_MACRO); 1174 RECORD(SUBMODULE_CONFLICT); 1175 RECORD(SUBMODULE_PRIVATE_HEADER); 1176 RECORD(SUBMODULE_TEXTUAL_HEADER); 1177 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER); 1178 RECORD(SUBMODULE_INITIALIZERS); 1179 RECORD(SUBMODULE_EXPORT_AS); 1180 1181 // Comments Block. 1182 BLOCK(COMMENTS_BLOCK); 1183 RECORD(COMMENTS_RAW_COMMENT); 1184 1185 // Decls and Types block. 1186 BLOCK(DECLTYPES_BLOCK); 1187 RECORD(TYPE_EXT_QUAL); 1188 RECORD(TYPE_COMPLEX); 1189 RECORD(TYPE_POINTER); 1190 RECORD(TYPE_BLOCK_POINTER); 1191 RECORD(TYPE_LVALUE_REFERENCE); 1192 RECORD(TYPE_RVALUE_REFERENCE); 1193 RECORD(TYPE_MEMBER_POINTER); 1194 RECORD(TYPE_CONSTANT_ARRAY); 1195 RECORD(TYPE_INCOMPLETE_ARRAY); 1196 RECORD(TYPE_VARIABLE_ARRAY); 1197 RECORD(TYPE_VECTOR); 1198 RECORD(TYPE_EXT_VECTOR); 1199 RECORD(TYPE_FUNCTION_NO_PROTO); 1200 RECORD(TYPE_FUNCTION_PROTO); 1201 RECORD(TYPE_TYPEDEF); 1202 RECORD(TYPE_TYPEOF_EXPR); 1203 RECORD(TYPE_TYPEOF); 1204 RECORD(TYPE_RECORD); 1205 RECORD(TYPE_ENUM); 1206 RECORD(TYPE_OBJC_INTERFACE); 1207 RECORD(TYPE_OBJC_OBJECT_POINTER); 1208 RECORD(TYPE_DECLTYPE); 1209 RECORD(TYPE_ELABORATED); 1210 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM); 1211 RECORD(TYPE_UNRESOLVED_USING); 1212 RECORD(TYPE_INJECTED_CLASS_NAME); 1213 RECORD(TYPE_OBJC_OBJECT); 1214 RECORD(TYPE_TEMPLATE_TYPE_PARM); 1215 RECORD(TYPE_TEMPLATE_SPECIALIZATION); 1216 RECORD(TYPE_DEPENDENT_NAME); 1217 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION); 1218 RECORD(TYPE_DEPENDENT_SIZED_ARRAY); 1219 RECORD(TYPE_PAREN); 1220 RECORD(TYPE_PACK_EXPANSION); 1221 RECORD(TYPE_ATTRIBUTED); 1222 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK); 1223 RECORD(TYPE_AUTO); 1224 RECORD(TYPE_UNARY_TRANSFORM); 1225 RECORD(TYPE_ATOMIC); 1226 RECORD(TYPE_DECAYED); 1227 RECORD(TYPE_ADJUSTED); 1228 RECORD(TYPE_OBJC_TYPE_PARAM); 1229 RECORD(LOCAL_REDECLARATIONS); 1230 RECORD(DECL_TYPEDEF); 1231 RECORD(DECL_TYPEALIAS); 1232 RECORD(DECL_ENUM); 1233 RECORD(DECL_RECORD); 1234 RECORD(DECL_ENUM_CONSTANT); 1235 RECORD(DECL_FUNCTION); 1236 RECORD(DECL_OBJC_METHOD); 1237 RECORD(DECL_OBJC_INTERFACE); 1238 RECORD(DECL_OBJC_PROTOCOL); 1239 RECORD(DECL_OBJC_IVAR); 1240 RECORD(DECL_OBJC_AT_DEFS_FIELD); 1241 RECORD(DECL_OBJC_CATEGORY); 1242 RECORD(DECL_OBJC_CATEGORY_IMPL); 1243 RECORD(DECL_OBJC_IMPLEMENTATION); 1244 RECORD(DECL_OBJC_COMPATIBLE_ALIAS); 1245 RECORD(DECL_OBJC_PROPERTY); 1246 RECORD(DECL_OBJC_PROPERTY_IMPL); 1247 RECORD(DECL_FIELD); 1248 RECORD(DECL_MS_PROPERTY); 1249 RECORD(DECL_VAR); 1250 RECORD(DECL_IMPLICIT_PARAM); 1251 RECORD(DECL_PARM_VAR); 1252 RECORD(DECL_FILE_SCOPE_ASM); 1253 RECORD(DECL_BLOCK); 1254 RECORD(DECL_CONTEXT_LEXICAL); 1255 RECORD(DECL_CONTEXT_VISIBLE); 1256 RECORD(DECL_NAMESPACE); 1257 RECORD(DECL_NAMESPACE_ALIAS); 1258 RECORD(DECL_USING); 1259 RECORD(DECL_USING_SHADOW); 1260 RECORD(DECL_USING_DIRECTIVE); 1261 RECORD(DECL_UNRESOLVED_USING_VALUE); 1262 RECORD(DECL_UNRESOLVED_USING_TYPENAME); 1263 RECORD(DECL_LINKAGE_SPEC); 1264 RECORD(DECL_CXX_RECORD); 1265 RECORD(DECL_CXX_METHOD); 1266 RECORD(DECL_CXX_CONSTRUCTOR); 1267 RECORD(DECL_CXX_INHERITED_CONSTRUCTOR); 1268 RECORD(DECL_CXX_DESTRUCTOR); 1269 RECORD(DECL_CXX_CONVERSION); 1270 RECORD(DECL_ACCESS_SPEC); 1271 RECORD(DECL_FRIEND); 1272 RECORD(DECL_FRIEND_TEMPLATE); 1273 RECORD(DECL_CLASS_TEMPLATE); 1274 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION); 1275 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION); 1276 RECORD(DECL_VAR_TEMPLATE); 1277 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION); 1278 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION); 1279 RECORD(DECL_FUNCTION_TEMPLATE); 1280 RECORD(DECL_TEMPLATE_TYPE_PARM); 1281 RECORD(DECL_NON_TYPE_TEMPLATE_PARM); 1282 RECORD(DECL_TEMPLATE_TEMPLATE_PARM); 1283 RECORD(DECL_TYPE_ALIAS_TEMPLATE); 1284 RECORD(DECL_STATIC_ASSERT); 1285 RECORD(DECL_CXX_BASE_SPECIFIERS); 1286 RECORD(DECL_CXX_CTOR_INITIALIZERS); 1287 RECORD(DECL_INDIRECTFIELD); 1288 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK); 1289 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK); 1290 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION); 1291 RECORD(DECL_IMPORT); 1292 RECORD(DECL_OMP_THREADPRIVATE); 1293 RECORD(DECL_EMPTY); 1294 RECORD(DECL_OBJC_TYPE_PARAM); 1295 RECORD(DECL_OMP_CAPTUREDEXPR); 1296 RECORD(DECL_PRAGMA_COMMENT); 1297 RECORD(DECL_PRAGMA_DETECT_MISMATCH); 1298 RECORD(DECL_OMP_DECLARE_REDUCTION); 1299 1300 // Statements and Exprs can occur in the Decls and Types block. 1301 AddStmtsExprs(Stream, Record); 1302 1303 BLOCK(PREPROCESSOR_DETAIL_BLOCK); 1304 RECORD(PPD_MACRO_EXPANSION); 1305 RECORD(PPD_MACRO_DEFINITION); 1306 RECORD(PPD_INCLUSION_DIRECTIVE); 1307 1308 // Decls and Types block. 1309 BLOCK(EXTENSION_BLOCK); 1310 RECORD(EXTENSION_METADATA); 1311 1312 BLOCK(UNHASHED_CONTROL_BLOCK); 1313 RECORD(SIGNATURE); 1314 RECORD(DIAGNOSTIC_OPTIONS); 1315 RECORD(DIAG_PRAGMA_MAPPINGS); 1316 1317 #undef RECORD 1318 #undef BLOCK 1319 Stream.ExitBlock(); 1320 } 1321 1322 /// \brief Prepares a path for being written to an AST file by converting it 1323 /// to an absolute path and removing nested './'s. 1324 /// 1325 /// \return \c true if the path was changed. 1326 static bool cleanPathForOutput(FileManager &FileMgr, 1327 SmallVectorImpl<char> &Path) { 1328 bool Changed = FileMgr.makeAbsolutePath(Path); 1329 return Changed | llvm::sys::path::remove_dots(Path); 1330 } 1331 1332 /// \brief Adjusts the given filename to only write out the portion of the 1333 /// filename that is not part of the system root directory. 1334 /// 1335 /// \param Filename the file name to adjust. 1336 /// 1337 /// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and 1338 /// the returned filename will be adjusted by this root directory. 1339 /// 1340 /// \returns either the original filename (if it needs no adjustment) or the 1341 /// adjusted filename (which points into the @p Filename parameter). 1342 static const char * 1343 adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) { 1344 assert(Filename && "No file name to adjust?"); 1345 1346 if (BaseDir.empty()) 1347 return Filename; 1348 1349 // Verify that the filename and the system root have the same prefix. 1350 unsigned Pos = 0; 1351 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos) 1352 if (Filename[Pos] != BaseDir[Pos]) 1353 return Filename; // Prefixes don't match. 1354 1355 // We hit the end of the filename before we hit the end of the system root. 1356 if (!Filename[Pos]) 1357 return Filename; 1358 1359 // If there's not a path separator at the end of the base directory nor 1360 // immediately after it, then this isn't within the base directory. 1361 if (!llvm::sys::path::is_separator(Filename[Pos])) { 1362 if (!llvm::sys::path::is_separator(BaseDir.back())) 1363 return Filename; 1364 } else { 1365 // If the file name has a '/' at the current position, skip over the '/'. 1366 // We distinguish relative paths from absolute paths by the 1367 // absence of '/' at the beginning of relative paths. 1368 // 1369 // FIXME: This is wrong. We distinguish them by asking if the path is 1370 // absolute, which isn't the same thing. And there might be multiple '/'s 1371 // in a row. Use a better mechanism to indicate whether we have emitted an 1372 // absolute or relative path. 1373 ++Pos; 1374 } 1375 1376 return Filename + Pos; 1377 } 1378 1379 ASTFileSignature ASTWriter::createSignature(StringRef Bytes) { 1380 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK. 1381 llvm::SHA1 Hasher; 1382 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size())); 1383 auto Hash = Hasher.result(); 1384 1385 // Convert to an array [5*i32]. 1386 ASTFileSignature Signature; 1387 auto LShift = [&](unsigned char Val, unsigned Shift) { 1388 return (uint32_t)Val << Shift; 1389 }; 1390 for (int I = 0; I != 5; ++I) 1391 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) | 1392 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0); 1393 1394 return Signature; 1395 } 1396 1397 ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP, 1398 ASTContext &Context) { 1399 // Flush first to prepare the PCM hash (signature). 1400 Stream.FlushToWord(); 1401 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3; 1402 1403 // Enter the block and prepare to write records. 1404 RecordData Record; 1405 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5); 1406 1407 // For implicit modules, write the hash of the PCM as its signature. 1408 ASTFileSignature Signature; 1409 if (WritingModule && 1410 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) { 1411 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl)); 1412 Record.append(Signature.begin(), Signature.end()); 1413 Stream.EmitRecord(SIGNATURE, Record); 1414 Record.clear(); 1415 } 1416 1417 // Diagnostic options. 1418 const auto &Diags = Context.getDiagnostics(); 1419 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions(); 1420 #define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name); 1421 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \ 1422 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name())); 1423 #include "clang/Basic/DiagnosticOptions.def" 1424 Record.push_back(DiagOpts.Warnings.size()); 1425 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I) 1426 AddString(DiagOpts.Warnings[I], Record); 1427 Record.push_back(DiagOpts.Remarks.size()); 1428 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I) 1429 AddString(DiagOpts.Remarks[I], Record); 1430 // Note: we don't serialize the log or serialization file names, because they 1431 // are generally transient files and will almost always be overridden. 1432 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record); 1433 1434 // Write out the diagnostic/pragma mappings. 1435 WritePragmaDiagnosticMappings(Diags, /* IsModule = */ WritingModule); 1436 1437 // Leave the options block. 1438 Stream.ExitBlock(); 1439 return Signature; 1440 } 1441 1442 /// \brief Write the control block. 1443 void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context, 1444 StringRef isysroot, 1445 const std::string &OutputFile) { 1446 using namespace llvm; 1447 1448 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5); 1449 RecordData Record; 1450 1451 // Metadata 1452 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>(); 1453 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA)); 1454 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major 1455 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor 1456 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj. 1457 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min. 1458 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable 1459 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps 1460 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors 1461 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag 1462 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev)); 1463 assert((!WritingModule || isysroot.empty()) && 1464 "writing module as a relocatable PCH?"); 1465 { 1466 RecordData::value_type Record[] = {METADATA, VERSION_MAJOR, VERSION_MINOR, 1467 CLANG_VERSION_MAJOR, CLANG_VERSION_MINOR, 1468 !isysroot.empty(), IncludeTimestamps, 1469 ASTHasCompilerErrors}; 1470 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record, 1471 getClangFullRepositoryVersion()); 1472 } 1473 1474 if (WritingModule) { 1475 // Module name 1476 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1477 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME)); 1478 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 1479 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev)); 1480 RecordData::value_type Record[] = {MODULE_NAME}; 1481 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name); 1482 } 1483 1484 if (WritingModule && WritingModule->Directory) { 1485 SmallString<128> BaseDir(WritingModule->Directory->getName()); 1486 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir); 1487 1488 // If the home of the module is the current working directory, then we 1489 // want to pick up the cwd of the build process loading the module, not 1490 // our cwd, when we load this module. 1491 if (!PP.getHeaderSearchInfo() 1492 .getHeaderSearchOpts() 1493 .ModuleMapFileHomeIsCwd || 1494 WritingModule->Directory->getName() != StringRef(".")) { 1495 // Module directory. 1496 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1497 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY)); 1498 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory 1499 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev)); 1500 1501 RecordData::value_type Record[] = {MODULE_DIRECTORY}; 1502 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir); 1503 } 1504 1505 // Write out all other paths relative to the base directory if possible. 1506 BaseDirectory.assign(BaseDir.begin(), BaseDir.end()); 1507 } else if (!isysroot.empty()) { 1508 // Write out paths relative to the sysroot if possible. 1509 BaseDirectory = isysroot; 1510 } 1511 1512 // Module map file 1513 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) { 1514 Record.clear(); 1515 1516 auto &Map = PP.getHeaderSearchInfo().getModuleMap(); 1517 AddPath(WritingModule->PresumedModuleMapFile.empty() 1518 ? Map.getModuleMapFileForUniquing(WritingModule)->getName() 1519 : StringRef(WritingModule->PresumedModuleMapFile), 1520 Record); 1521 1522 // Additional module map files. 1523 if (auto *AdditionalModMaps = 1524 Map.getAdditionalModuleMapFiles(WritingModule)) { 1525 Record.push_back(AdditionalModMaps->size()); 1526 for (const FileEntry *F : *AdditionalModMaps) 1527 AddPath(F->getName(), Record); 1528 } else { 1529 Record.push_back(0); 1530 } 1531 1532 Stream.EmitRecord(MODULE_MAP_FILE, Record); 1533 } 1534 1535 // Imports 1536 if (Chain) { 1537 serialization::ModuleManager &Mgr = Chain->getModuleManager(); 1538 Record.clear(); 1539 1540 for (ModuleFile &M : Mgr) { 1541 // Skip modules that weren't directly imported. 1542 if (!M.isDirectlyImported()) 1543 continue; 1544 1545 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding 1546 AddSourceLocation(M.ImportLoc, Record); 1547 1548 // If we have calculated signature, there is no need to store 1549 // the size or timestamp. 1550 Record.push_back(M.Signature ? 0 : M.File->getSize()); 1551 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File)); 1552 1553 for (auto I : M.Signature) 1554 Record.push_back(I); 1555 1556 AddString(M.ModuleName, Record); 1557 AddPath(M.FileName, Record); 1558 } 1559 Stream.EmitRecord(IMPORTS, Record); 1560 } 1561 1562 // Write the options block. 1563 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4); 1564 1565 // Language options. 1566 Record.clear(); 1567 const LangOptions &LangOpts = Context.getLangOpts(); 1568 #define LANGOPT(Name, Bits, Default, Description) \ 1569 Record.push_back(LangOpts.Name); 1570 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \ 1571 Record.push_back(static_cast<unsigned>(LangOpts.get##Name())); 1572 #include "clang/Basic/LangOptions.def" 1573 #define SANITIZER(NAME, ID) \ 1574 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID)); 1575 #include "clang/Basic/Sanitizers.def" 1576 1577 Record.push_back(LangOpts.ModuleFeatures.size()); 1578 for (StringRef Feature : LangOpts.ModuleFeatures) 1579 AddString(Feature, Record); 1580 1581 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind()); 1582 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record); 1583 1584 AddString(LangOpts.CurrentModule, Record); 1585 1586 // Comment options. 1587 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size()); 1588 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) { 1589 AddString(I, Record); 1590 } 1591 Record.push_back(LangOpts.CommentOpts.ParseAllComments); 1592 1593 // OpenMP offloading options. 1594 Record.push_back(LangOpts.OMPTargetTriples.size()); 1595 for (auto &T : LangOpts.OMPTargetTriples) 1596 AddString(T.getTriple(), Record); 1597 1598 AddString(LangOpts.OMPHostIRFile, Record); 1599 1600 Stream.EmitRecord(LANGUAGE_OPTIONS, Record); 1601 1602 // Target options. 1603 Record.clear(); 1604 const TargetInfo &Target = Context.getTargetInfo(); 1605 const TargetOptions &TargetOpts = Target.getTargetOpts(); 1606 AddString(TargetOpts.Triple, Record); 1607 AddString(TargetOpts.CPU, Record); 1608 AddString(TargetOpts.ABI, Record); 1609 Record.push_back(TargetOpts.FeaturesAsWritten.size()); 1610 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) { 1611 AddString(TargetOpts.FeaturesAsWritten[I], Record); 1612 } 1613 Record.push_back(TargetOpts.Features.size()); 1614 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) { 1615 AddString(TargetOpts.Features[I], Record); 1616 } 1617 Stream.EmitRecord(TARGET_OPTIONS, Record); 1618 1619 // File system options. 1620 Record.clear(); 1621 const FileSystemOptions &FSOpts = 1622 Context.getSourceManager().getFileManager().getFileSystemOpts(); 1623 AddString(FSOpts.WorkingDir, Record); 1624 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record); 1625 1626 // Header search options. 1627 Record.clear(); 1628 const HeaderSearchOptions &HSOpts 1629 = PP.getHeaderSearchInfo().getHeaderSearchOpts(); 1630 AddString(HSOpts.Sysroot, Record); 1631 1632 // Include entries. 1633 Record.push_back(HSOpts.UserEntries.size()); 1634 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) { 1635 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I]; 1636 AddString(Entry.Path, Record); 1637 Record.push_back(static_cast<unsigned>(Entry.Group)); 1638 Record.push_back(Entry.IsFramework); 1639 Record.push_back(Entry.IgnoreSysRoot); 1640 } 1641 1642 // System header prefixes. 1643 Record.push_back(HSOpts.SystemHeaderPrefixes.size()); 1644 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) { 1645 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record); 1646 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader); 1647 } 1648 1649 AddString(HSOpts.ResourceDir, Record); 1650 AddString(HSOpts.ModuleCachePath, Record); 1651 AddString(HSOpts.ModuleUserBuildPath, Record); 1652 Record.push_back(HSOpts.DisableModuleHash); 1653 Record.push_back(HSOpts.ImplicitModuleMaps); 1654 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd); 1655 Record.push_back(HSOpts.UseBuiltinIncludes); 1656 Record.push_back(HSOpts.UseStandardSystemIncludes); 1657 Record.push_back(HSOpts.UseStandardCXXIncludes); 1658 Record.push_back(HSOpts.UseLibcxx); 1659 // Write out the specific module cache path that contains the module files. 1660 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record); 1661 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record); 1662 1663 // Preprocessor options. 1664 Record.clear(); 1665 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts(); 1666 1667 // Macro definitions. 1668 Record.push_back(PPOpts.Macros.size()); 1669 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) { 1670 AddString(PPOpts.Macros[I].first, Record); 1671 Record.push_back(PPOpts.Macros[I].second); 1672 } 1673 1674 // Includes 1675 Record.push_back(PPOpts.Includes.size()); 1676 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I) 1677 AddString(PPOpts.Includes[I], Record); 1678 1679 // Macro includes 1680 Record.push_back(PPOpts.MacroIncludes.size()); 1681 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I) 1682 AddString(PPOpts.MacroIncludes[I], Record); 1683 1684 Record.push_back(PPOpts.UsePredefines); 1685 // Detailed record is important since it is used for the module cache hash. 1686 Record.push_back(PPOpts.DetailedRecord); 1687 AddString(PPOpts.ImplicitPCHInclude, Record); 1688 AddString(PPOpts.ImplicitPTHInclude, Record); 1689 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary)); 1690 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record); 1691 1692 // Leave the options block. 1693 Stream.ExitBlock(); 1694 1695 // Original file name and file ID 1696 SourceManager &SM = Context.getSourceManager(); 1697 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) { 1698 auto FileAbbrev = std::make_shared<BitCodeAbbrev>(); 1699 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE)); 1700 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID 1701 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name 1702 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev)); 1703 1704 Record.clear(); 1705 Record.push_back(ORIGINAL_FILE); 1706 Record.push_back(SM.getMainFileID().getOpaqueValue()); 1707 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName()); 1708 } 1709 1710 Record.clear(); 1711 Record.push_back(SM.getMainFileID().getOpaqueValue()); 1712 Stream.EmitRecord(ORIGINAL_FILE_ID, Record); 1713 1714 // Original PCH directory 1715 if (!OutputFile.empty() && OutputFile != "-") { 1716 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1717 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR)); 1718 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name 1719 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev)); 1720 1721 SmallString<128> OutputPath(OutputFile); 1722 1723 SM.getFileManager().makeAbsolutePath(OutputPath); 1724 StringRef origDir = llvm::sys::path::parent_path(OutputPath); 1725 1726 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR}; 1727 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir); 1728 } 1729 1730 WriteInputFiles(Context.SourceMgr, 1731 PP.getHeaderSearchInfo().getHeaderSearchOpts(), 1732 PP.getLangOpts().Modules); 1733 Stream.ExitBlock(); 1734 } 1735 1736 namespace { 1737 1738 /// \brief An input file. 1739 struct InputFileEntry { 1740 const FileEntry *File; 1741 bool IsSystemFile; 1742 bool IsTransient; 1743 bool BufferOverridden; 1744 bool IsTopLevelModuleMap; 1745 }; 1746 1747 } // namespace 1748 1749 void ASTWriter::WriteInputFiles(SourceManager &SourceMgr, 1750 HeaderSearchOptions &HSOpts, 1751 bool Modules) { 1752 using namespace llvm; 1753 1754 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4); 1755 1756 // Create input-file abbreviation. 1757 auto IFAbbrev = std::make_shared<BitCodeAbbrev>(); 1758 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE)); 1759 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID 1760 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size 1761 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time 1762 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden 1763 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient 1764 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map 1765 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name 1766 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev)); 1767 1768 // Get all ContentCache objects for files, sorted by whether the file is a 1769 // system one or not. System files go at the back, users files at the front. 1770 std::deque<InputFileEntry> SortedFiles; 1771 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) { 1772 // Get this source location entry. 1773 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I); 1774 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc); 1775 1776 // We only care about file entries that were not overridden. 1777 if (!SLoc->isFile()) 1778 continue; 1779 const SrcMgr::FileInfo &File = SLoc->getFile(); 1780 const SrcMgr::ContentCache *Cache = File.getContentCache(); 1781 if (!Cache->OrigEntry) 1782 continue; 1783 1784 InputFileEntry Entry; 1785 Entry.File = Cache->OrigEntry; 1786 Entry.IsSystemFile = Cache->IsSystemFile; 1787 Entry.IsTransient = Cache->IsTransient; 1788 Entry.BufferOverridden = Cache->BufferOverridden; 1789 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) && 1790 File.getIncludeLoc().isInvalid(); 1791 if (Cache->IsSystemFile) 1792 SortedFiles.push_back(Entry); 1793 else 1794 SortedFiles.push_front(Entry); 1795 } 1796 1797 unsigned UserFilesNum = 0; 1798 // Write out all of the input files. 1799 std::vector<uint64_t> InputFileOffsets; 1800 for (const auto &Entry : SortedFiles) { 1801 uint32_t &InputFileID = InputFileIDs[Entry.File]; 1802 if (InputFileID != 0) 1803 continue; // already recorded this file. 1804 1805 // Record this entry's offset. 1806 InputFileOffsets.push_back(Stream.GetCurrentBitNo()); 1807 1808 InputFileID = InputFileOffsets.size(); 1809 1810 if (!Entry.IsSystemFile) 1811 ++UserFilesNum; 1812 1813 // Emit size/modification time for this file. 1814 // And whether this file was overridden. 1815 RecordData::value_type Record[] = { 1816 INPUT_FILE, 1817 InputFileOffsets.size(), 1818 (uint64_t)Entry.File->getSize(), 1819 (uint64_t)getTimestampForOutput(Entry.File), 1820 Entry.BufferOverridden, 1821 Entry.IsTransient, 1822 Entry.IsTopLevelModuleMap}; 1823 1824 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName()); 1825 } 1826 1827 Stream.ExitBlock(); 1828 1829 // Create input file offsets abbreviation. 1830 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>(); 1831 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS)); 1832 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files 1833 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system 1834 // input files 1835 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array 1836 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev)); 1837 1838 // Write input file offsets. 1839 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS, 1840 InputFileOffsets.size(), UserFilesNum}; 1841 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets)); 1842 } 1843 1844 //===----------------------------------------------------------------------===// 1845 // Source Manager Serialization 1846 //===----------------------------------------------------------------------===// 1847 1848 /// \brief Create an abbreviation for the SLocEntry that refers to a 1849 /// file. 1850 static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) { 1851 using namespace llvm; 1852 1853 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1854 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY)); 1855 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset 1856 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location 1857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic 1858 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives 1859 // FileEntry fields. 1860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID 1861 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs 1862 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex 1863 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls 1864 return Stream.EmitAbbrev(std::move(Abbrev)); 1865 } 1866 1867 /// \brief Create an abbreviation for the SLocEntry that refers to a 1868 /// buffer. 1869 static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) { 1870 using namespace llvm; 1871 1872 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1873 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY)); 1874 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset 1875 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location 1876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic 1877 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives 1878 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob 1879 return Stream.EmitAbbrev(std::move(Abbrev)); 1880 } 1881 1882 /// \brief Create an abbreviation for the SLocEntry that refers to a 1883 /// buffer's blob. 1884 static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream, 1885 bool Compressed) { 1886 using namespace llvm; 1887 1888 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1889 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED 1890 : SM_SLOC_BUFFER_BLOB)); 1891 if (Compressed) 1892 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size 1893 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob 1894 return Stream.EmitAbbrev(std::move(Abbrev)); 1895 } 1896 1897 /// \brief Create an abbreviation for the SLocEntry that refers to a macro 1898 /// expansion. 1899 static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) { 1900 using namespace llvm; 1901 1902 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 1903 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY)); 1904 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset 1905 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location 1906 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location 1907 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location 1908 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length 1909 return Stream.EmitAbbrev(std::move(Abbrev)); 1910 } 1911 1912 namespace { 1913 1914 // Trait used for the on-disk hash table of header search information. 1915 class HeaderFileInfoTrait { 1916 ASTWriter &Writer; 1917 1918 // Keep track of the framework names we've used during serialization. 1919 SmallVector<char, 128> FrameworkStringData; 1920 llvm::StringMap<unsigned> FrameworkNameOffset; 1921 1922 public: 1923 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {} 1924 1925 struct key_type { 1926 StringRef Filename; 1927 off_t Size; 1928 time_t ModTime; 1929 }; 1930 using key_type_ref = const key_type &; 1931 1932 using UnresolvedModule = 1933 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>; 1934 1935 struct data_type { 1936 const HeaderFileInfo &HFI; 1937 ArrayRef<ModuleMap::KnownHeader> KnownHeaders; 1938 UnresolvedModule Unresolved; 1939 }; 1940 using data_type_ref = const data_type &; 1941 1942 using hash_value_type = unsigned; 1943 using offset_type = unsigned; 1944 1945 hash_value_type ComputeHash(key_type_ref key) { 1946 // The hash is based only on size/time of the file, so that the reader can 1947 // match even when symlinking or excess path elements ("foo/../", "../") 1948 // change the form of the name. However, complete path is still the key. 1949 return llvm::hash_combine(key.Size, key.ModTime); 1950 } 1951 1952 std::pair<unsigned, unsigned> 1953 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) { 1954 using namespace llvm::support; 1955 1956 endian::Writer<little> LE(Out); 1957 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8; 1958 LE.write<uint16_t>(KeyLen); 1959 unsigned DataLen = 1 + 2 + 4 + 4; 1960 for (auto ModInfo : Data.KnownHeaders) 1961 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule())) 1962 DataLen += 4; 1963 if (Data.Unresolved.getPointer()) 1964 DataLen += 4; 1965 LE.write<uint8_t>(DataLen); 1966 return std::make_pair(KeyLen, DataLen); 1967 } 1968 1969 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) { 1970 using namespace llvm::support; 1971 1972 endian::Writer<little> LE(Out); 1973 LE.write<uint64_t>(key.Size); 1974 KeyLen -= 8; 1975 LE.write<uint64_t>(key.ModTime); 1976 KeyLen -= 8; 1977 Out.write(key.Filename.data(), KeyLen); 1978 } 1979 1980 void EmitData(raw_ostream &Out, key_type_ref key, 1981 data_type_ref Data, unsigned DataLen) { 1982 using namespace llvm::support; 1983 1984 endian::Writer<little> LE(Out); 1985 uint64_t Start = Out.tell(); (void)Start; 1986 1987 unsigned char Flags = (Data.HFI.isImport << 5) 1988 | (Data.HFI.isPragmaOnce << 4) 1989 | (Data.HFI.DirInfo << 1) 1990 | Data.HFI.IndexHeaderMapHeader; 1991 LE.write<uint8_t>(Flags); 1992 LE.write<uint16_t>(Data.HFI.NumIncludes); 1993 1994 if (!Data.HFI.ControllingMacro) 1995 LE.write<uint32_t>(Data.HFI.ControllingMacroID); 1996 else 1997 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro)); 1998 1999 unsigned Offset = 0; 2000 if (!Data.HFI.Framework.empty()) { 2001 // If this header refers into a framework, save the framework name. 2002 llvm::StringMap<unsigned>::iterator Pos 2003 = FrameworkNameOffset.find(Data.HFI.Framework); 2004 if (Pos == FrameworkNameOffset.end()) { 2005 Offset = FrameworkStringData.size() + 1; 2006 FrameworkStringData.append(Data.HFI.Framework.begin(), 2007 Data.HFI.Framework.end()); 2008 FrameworkStringData.push_back(0); 2009 2010 FrameworkNameOffset[Data.HFI.Framework] = Offset; 2011 } else 2012 Offset = Pos->second; 2013 } 2014 LE.write<uint32_t>(Offset); 2015 2016 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) { 2017 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) { 2018 uint32_t Value = (ModID << 2) | (unsigned)Role; 2019 assert((Value >> 2) == ModID && "overflow in header module info"); 2020 LE.write<uint32_t>(Value); 2021 } 2022 }; 2023 2024 // FIXME: If the header is excluded, we should write out some 2025 // record of that fact. 2026 for (auto ModInfo : Data.KnownHeaders) 2027 EmitModule(ModInfo.getModule(), ModInfo.getRole()); 2028 if (Data.Unresolved.getPointer()) 2029 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt()); 2030 2031 assert(Out.tell() - Start == DataLen && "Wrong data length"); 2032 } 2033 2034 const char *strings_begin() const { return FrameworkStringData.begin(); } 2035 const char *strings_end() const { return FrameworkStringData.end(); } 2036 }; 2037 2038 } // namespace 2039 2040 /// \brief Write the header search block for the list of files that 2041 /// 2042 /// \param HS The header search structure to save. 2043 void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) { 2044 HeaderFileInfoTrait GeneratorTrait(*this); 2045 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator; 2046 SmallVector<const char *, 4> SavedStrings; 2047 unsigned NumHeaderSearchEntries = 0; 2048 2049 // Find all unresolved headers for the current module. We generally will 2050 // have resolved them before we get here, but not necessarily: we might be 2051 // compiling a preprocessed module, where there is no requirement for the 2052 // original files to exist any more. 2053 const HeaderFileInfo Empty; // So we can take a reference. 2054 if (WritingModule) { 2055 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule); 2056 while (!Worklist.empty()) { 2057 Module *M = Worklist.pop_back_val(); 2058 if (!M->isAvailable()) 2059 continue; 2060 2061 // Map to disk files where possible, to pick up any missing stat 2062 // information. This also means we don't need to check the unresolved 2063 // headers list when emitting resolved headers in the first loop below. 2064 // FIXME: It'd be preferable to avoid doing this if we were given 2065 // sufficient stat information in the module map. 2066 HS.getModuleMap().resolveHeaderDirectives(M); 2067 2068 // If the file didn't exist, we can still create a module if we were given 2069 // enough information in the module map. 2070 for (auto U : M->MissingHeaders) { 2071 // Check that we were given enough information to build a module 2072 // without this file existing on disk. 2073 if (!U.Size || (!U.ModTime && IncludeTimestamps)) { 2074 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header) 2075 << WritingModule->getFullModuleName() << U.Size.hasValue() 2076 << U.FileName; 2077 continue; 2078 } 2079 2080 // Form the effective relative pathname for the file. 2081 SmallString<128> Filename(M->Directory->getName()); 2082 llvm::sys::path::append(Filename, U.FileName); 2083 PreparePathForOutput(Filename); 2084 2085 StringRef FilenameDup = strdup(Filename.c_str()); 2086 SavedStrings.push_back(FilenameDup.data()); 2087 2088 HeaderFileInfoTrait::key_type Key = { 2089 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0 2090 }; 2091 HeaderFileInfoTrait::data_type Data = { 2092 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)} 2093 }; 2094 // FIXME: Deal with cases where there are multiple unresolved header 2095 // directives in different submodules for the same header. 2096 Generator.insert(Key, Data, GeneratorTrait); 2097 ++NumHeaderSearchEntries; 2098 } 2099 2100 Worklist.append(M->submodule_begin(), M->submodule_end()); 2101 } 2102 } 2103 2104 SmallVector<const FileEntry *, 16> FilesByUID; 2105 HS.getFileMgr().GetUniqueIDMapping(FilesByUID); 2106 2107 if (FilesByUID.size() > HS.header_file_size()) 2108 FilesByUID.resize(HS.header_file_size()); 2109 2110 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) { 2111 const FileEntry *File = FilesByUID[UID]; 2112 if (!File) 2113 continue; 2114 2115 // Get the file info. This will load info from the external source if 2116 // necessary. Skip emitting this file if we have no information on it 2117 // as a header file (in which case HFI will be null) or if it hasn't 2118 // changed since it was loaded. Also skip it if it's for a modular header 2119 // from a different module; in that case, we rely on the module(s) 2120 // containing the header to provide this information. 2121 const HeaderFileInfo *HFI = 2122 HS.getExistingFileInfo(File, /*WantExternal*/!Chain); 2123 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader)) 2124 continue; 2125 2126 // Massage the file path into an appropriate form. 2127 StringRef Filename = File->getName(); 2128 SmallString<128> FilenameTmp(Filename); 2129 if (PreparePathForOutput(FilenameTmp)) { 2130 // If we performed any translation on the file name at all, we need to 2131 // save this string, since the generator will refer to it later. 2132 Filename = StringRef(strdup(FilenameTmp.c_str())); 2133 SavedStrings.push_back(Filename.data()); 2134 } 2135 2136 HeaderFileInfoTrait::key_type Key = { 2137 Filename, File->getSize(), getTimestampForOutput(File) 2138 }; 2139 HeaderFileInfoTrait::data_type Data = { 2140 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {} 2141 }; 2142 Generator.insert(Key, Data, GeneratorTrait); 2143 ++NumHeaderSearchEntries; 2144 } 2145 2146 // Create the on-disk hash table in a buffer. 2147 SmallString<4096> TableData; 2148 uint32_t BucketOffset; 2149 { 2150 using namespace llvm::support; 2151 2152 llvm::raw_svector_ostream Out(TableData); 2153 // Make sure that no bucket is at offset 0 2154 endian::Writer<little>(Out).write<uint32_t>(0); 2155 BucketOffset = Generator.Emit(Out, GeneratorTrait); 2156 } 2157 2158 // Create a blob abbreviation 2159 using namespace llvm; 2160 2161 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2162 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE)); 2163 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2164 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2165 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2166 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2167 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2168 2169 // Write the header search table 2170 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset, 2171 NumHeaderSearchEntries, TableData.size()}; 2172 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end()); 2173 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData); 2174 2175 // Free all of the strings we had to duplicate. 2176 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I) 2177 free(const_cast<char *>(SavedStrings[I])); 2178 } 2179 2180 static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob, 2181 unsigned SLocBufferBlobCompressedAbbrv, 2182 unsigned SLocBufferBlobAbbrv) { 2183 using RecordDataType = ASTWriter::RecordData::value_type; 2184 2185 // Compress the buffer if possible. We expect that almost all PCM 2186 // consumers will not want its contents. 2187 SmallString<0> CompressedBuffer; 2188 if (llvm::zlib::isAvailable()) { 2189 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer); 2190 if (!E) { 2191 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED, 2192 Blob.size() - 1}; 2193 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record, 2194 CompressedBuffer); 2195 return; 2196 } 2197 llvm::consumeError(std::move(E)); 2198 } 2199 2200 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB}; 2201 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob); 2202 } 2203 2204 /// \brief Writes the block containing the serialized form of the 2205 /// source manager. 2206 /// 2207 /// TODO: We should probably use an on-disk hash table (stored in a 2208 /// blob), indexed based on the file name, so that we only create 2209 /// entries for files that we actually need. In the common case (no 2210 /// errors), we probably won't have to create file entries for any of 2211 /// the files in the AST. 2212 void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr, 2213 const Preprocessor &PP) { 2214 RecordData Record; 2215 2216 // Enter the source manager block. 2217 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4); 2218 2219 // Abbreviations for the various kinds of source-location entries. 2220 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream); 2221 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream); 2222 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false); 2223 unsigned SLocBufferBlobCompressedAbbrv = 2224 CreateSLocBufferBlobAbbrev(Stream, true); 2225 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream); 2226 2227 // Write out the source location entry table. We skip the first 2228 // entry, which is always the same dummy entry. 2229 std::vector<uint32_t> SLocEntryOffsets; 2230 RecordData PreloadSLocs; 2231 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1); 2232 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); 2233 I != N; ++I) { 2234 // Get this source location entry. 2235 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I); 2236 FileID FID = FileID::get(I); 2237 assert(&SourceMgr.getSLocEntry(FID) == SLoc); 2238 2239 // Record the offset of this source-location entry. 2240 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo()); 2241 2242 // Figure out which record code to use. 2243 unsigned Code; 2244 if (SLoc->isFile()) { 2245 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache(); 2246 if (Cache->OrigEntry) { 2247 Code = SM_SLOC_FILE_ENTRY; 2248 } else 2249 Code = SM_SLOC_BUFFER_ENTRY; 2250 } else 2251 Code = SM_SLOC_EXPANSION_ENTRY; 2252 Record.clear(); 2253 Record.push_back(Code); 2254 2255 // Starting offset of this entry within this module, so skip the dummy. 2256 Record.push_back(SLoc->getOffset() - 2); 2257 if (SLoc->isFile()) { 2258 const SrcMgr::FileInfo &File = SLoc->getFile(); 2259 AddSourceLocation(File.getIncludeLoc(), Record); 2260 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding 2261 Record.push_back(File.hasLineDirectives()); 2262 2263 const SrcMgr::ContentCache *Content = File.getContentCache(); 2264 bool EmitBlob = false; 2265 if (Content->OrigEntry) { 2266 assert(Content->OrigEntry == Content->ContentsEntry && 2267 "Writing to AST an overridden file is not supported"); 2268 2269 // The source location entry is a file. Emit input file ID. 2270 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry"); 2271 Record.push_back(InputFileIDs[Content->OrigEntry]); 2272 2273 Record.push_back(File.NumCreatedFIDs); 2274 2275 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID); 2276 if (FDI != FileDeclIDs.end()) { 2277 Record.push_back(FDI->second->FirstDeclIndex); 2278 Record.push_back(FDI->second->DeclIDs.size()); 2279 } else { 2280 Record.push_back(0); 2281 Record.push_back(0); 2282 } 2283 2284 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record); 2285 2286 if (Content->BufferOverridden || Content->IsTransient) 2287 EmitBlob = true; 2288 } else { 2289 // The source location entry is a buffer. The blob associated 2290 // with this entry contains the contents of the buffer. 2291 2292 // We add one to the size so that we capture the trailing NULL 2293 // that is required by llvm::MemoryBuffer::getMemBuffer (on 2294 // the reader side). 2295 const llvm::MemoryBuffer *Buffer 2296 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager()); 2297 StringRef Name = Buffer->getBufferIdentifier(); 2298 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record, 2299 StringRef(Name.data(), Name.size() + 1)); 2300 EmitBlob = true; 2301 2302 if (Name == "<built-in>") 2303 PreloadSLocs.push_back(SLocEntryOffsets.size()); 2304 } 2305 2306 if (EmitBlob) { 2307 // Include the implicit terminating null character in the on-disk buffer 2308 // if we're writing it uncompressed. 2309 const llvm::MemoryBuffer *Buffer = 2310 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager()); 2311 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1); 2312 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv, 2313 SLocBufferBlobAbbrv); 2314 } 2315 } else { 2316 // The source location entry is a macro expansion. 2317 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion(); 2318 AddSourceLocation(Expansion.getSpellingLoc(), Record); 2319 AddSourceLocation(Expansion.getExpansionLocStart(), Record); 2320 AddSourceLocation(Expansion.isMacroArgExpansion() 2321 ? SourceLocation() 2322 : Expansion.getExpansionLocEnd(), 2323 Record); 2324 2325 // Compute the token length for this macro expansion. 2326 unsigned NextOffset = SourceMgr.getNextLocalOffset(); 2327 if (I + 1 != N) 2328 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset(); 2329 Record.push_back(NextOffset - SLoc->getOffset() - 1); 2330 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record); 2331 } 2332 } 2333 2334 Stream.ExitBlock(); 2335 2336 if (SLocEntryOffsets.empty()) 2337 return; 2338 2339 // Write the source-location offsets table into the AST block. This 2340 // table is used for lazily loading source-location information. 2341 using namespace llvm; 2342 2343 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2344 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS)); 2345 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs 2346 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size 2347 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets 2348 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2349 { 2350 RecordData::value_type Record[] = { 2351 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(), 2352 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */}; 2353 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record, 2354 bytes(SLocEntryOffsets)); 2355 } 2356 // Write the source location entry preloads array, telling the AST 2357 // reader which source locations entries it should load eagerly. 2358 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs); 2359 2360 // Write the line table. It depends on remapping working, so it must come 2361 // after the source location offsets. 2362 if (SourceMgr.hasLineTable()) { 2363 LineTableInfo &LineTable = SourceMgr.getLineTable(); 2364 2365 Record.clear(); 2366 2367 // Emit the needed file names. 2368 llvm::DenseMap<int, int> FilenameMap; 2369 FilenameMap[-1] = -1; // For unspecified filenames. 2370 for (const auto &L : LineTable) { 2371 if (L.first.ID < 0) 2372 continue; 2373 for (auto &LE : L.second) { 2374 if (FilenameMap.insert(std::make_pair(LE.FilenameID, 2375 FilenameMap.size() - 1)).second) 2376 AddPath(LineTable.getFilename(LE.FilenameID), Record); 2377 } 2378 } 2379 Record.push_back(0); 2380 2381 // Emit the line entries 2382 for (const auto &L : LineTable) { 2383 // Only emit entries for local files. 2384 if (L.first.ID < 0) 2385 continue; 2386 2387 // Emit the file ID 2388 Record.push_back(L.first.ID); 2389 2390 // Emit the line entries 2391 Record.push_back(L.second.size()); 2392 for (const auto &LE : L.second) { 2393 Record.push_back(LE.FileOffset); 2394 Record.push_back(LE.LineNo); 2395 Record.push_back(FilenameMap[LE.FilenameID]); 2396 Record.push_back((unsigned)LE.FileKind); 2397 Record.push_back(LE.IncludeOffset); 2398 } 2399 } 2400 2401 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record); 2402 } 2403 } 2404 2405 //===----------------------------------------------------------------------===// 2406 // Preprocessor Serialization 2407 //===----------------------------------------------------------------------===// 2408 2409 static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule, 2410 const Preprocessor &PP) { 2411 if (MacroInfo *MI = MD->getMacroInfo()) 2412 if (MI->isBuiltinMacro()) 2413 return true; 2414 2415 if (IsModule) { 2416 SourceLocation Loc = MD->getLocation(); 2417 if (Loc.isInvalid()) 2418 return true; 2419 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID()) 2420 return true; 2421 } 2422 2423 return false; 2424 } 2425 2426 /// \brief Writes the block containing the serialized form of the 2427 /// preprocessor. 2428 void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) { 2429 PreprocessingRecord *PPRec = PP.getPreprocessingRecord(); 2430 if (PPRec) 2431 WritePreprocessorDetail(*PPRec); 2432 2433 RecordData Record; 2434 RecordData ModuleMacroRecord; 2435 2436 // If the preprocessor __COUNTER__ value has been bumped, remember it. 2437 if (PP.getCounterValue() != 0) { 2438 RecordData::value_type Record[] = {PP.getCounterValue()}; 2439 Stream.EmitRecord(PP_COUNTER_VALUE, Record); 2440 } 2441 2442 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) { 2443 assert(!IsModule); 2444 auto SkipInfo = PP.getPreambleSkipInfo(); 2445 if (SkipInfo.hasValue()) { 2446 Record.push_back(true); 2447 AddSourceLocation(SkipInfo->HashTokenLoc, Record); 2448 AddSourceLocation(SkipInfo->IfTokenLoc, Record); 2449 Record.push_back(SkipInfo->FoundNonSkipPortion); 2450 Record.push_back(SkipInfo->FoundElse); 2451 AddSourceLocation(SkipInfo->ElseLoc, Record); 2452 } else { 2453 Record.push_back(false); 2454 } 2455 for (const auto &Cond : PP.getPreambleConditionalStack()) { 2456 AddSourceLocation(Cond.IfLoc, Record); 2457 Record.push_back(Cond.WasSkipping); 2458 Record.push_back(Cond.FoundNonSkip); 2459 Record.push_back(Cond.FoundElse); 2460 } 2461 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record); 2462 Record.clear(); 2463 } 2464 2465 // Enter the preprocessor block. 2466 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3); 2467 2468 // If the AST file contains __DATE__ or __TIME__ emit a warning about this. 2469 // FIXME: Include a location for the use, and say which one was used. 2470 if (PP.SawDateOrTime()) 2471 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule; 2472 2473 // Loop over all the macro directives that are live at the end of the file, 2474 // emitting each to the PP section. 2475 2476 // Construct the list of identifiers with macro directives that need to be 2477 // serialized. 2478 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers; 2479 for (auto &Id : PP.getIdentifierTable()) 2480 if (Id.second->hadMacroDefinition() && 2481 (!Id.second->isFromAST() || 2482 Id.second->hasChangedSinceDeserialization())) 2483 MacroIdentifiers.push_back(Id.second); 2484 // Sort the set of macro definitions that need to be serialized by the 2485 // name of the macro, to provide a stable ordering. 2486 llvm::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(), 2487 llvm::less_ptr<IdentifierInfo>()); 2488 2489 // Emit the macro directives as a list and associate the offset with the 2490 // identifier they belong to. 2491 for (const IdentifierInfo *Name : MacroIdentifiers) { 2492 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name); 2493 auto StartOffset = Stream.GetCurrentBitNo(); 2494 2495 // Emit the macro directives in reverse source order. 2496 for (; MD; MD = MD->getPrevious()) { 2497 // Once we hit an ignored macro, we're done: the rest of the chain 2498 // will all be ignored macros. 2499 if (shouldIgnoreMacro(MD, IsModule, PP)) 2500 break; 2501 2502 AddSourceLocation(MD->getLocation(), Record); 2503 Record.push_back(MD->getKind()); 2504 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) { 2505 Record.push_back(getMacroRef(DefMD->getInfo(), Name)); 2506 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) { 2507 Record.push_back(VisMD->isPublic()); 2508 } 2509 } 2510 2511 // Write out any exported module macros. 2512 bool EmittedModuleMacros = false; 2513 // We write out exported module macros for PCH as well. 2514 auto Leafs = PP.getLeafModuleMacros(Name); 2515 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end()); 2516 llvm::DenseMap<ModuleMacro*, unsigned> Visits; 2517 while (!Worklist.empty()) { 2518 auto *Macro = Worklist.pop_back_val(); 2519 2520 // Emit a record indicating this submodule exports this macro. 2521 ModuleMacroRecord.push_back( 2522 getSubmoduleID(Macro->getOwningModule())); 2523 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name)); 2524 for (auto *M : Macro->overrides()) 2525 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule())); 2526 2527 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord); 2528 ModuleMacroRecord.clear(); 2529 2530 // Enqueue overridden macros once we've visited all their ancestors. 2531 for (auto *M : Macro->overrides()) 2532 if (++Visits[M] == M->getNumOverridingMacros()) 2533 Worklist.push_back(M); 2534 2535 EmittedModuleMacros = true; 2536 } 2537 2538 if (Record.empty() && !EmittedModuleMacros) 2539 continue; 2540 2541 IdentMacroDirectivesOffsetMap[Name] = StartOffset; 2542 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record); 2543 Record.clear(); 2544 } 2545 2546 /// \brief Offsets of each of the macros into the bitstream, indexed by 2547 /// the local macro ID 2548 /// 2549 /// For each identifier that is associated with a macro, this map 2550 /// provides the offset into the bitstream where that macro is 2551 /// defined. 2552 std::vector<uint32_t> MacroOffsets; 2553 2554 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) { 2555 const IdentifierInfo *Name = MacroInfosToEmit[I].Name; 2556 MacroInfo *MI = MacroInfosToEmit[I].MI; 2557 MacroID ID = MacroInfosToEmit[I].ID; 2558 2559 if (ID < FirstMacroID) { 2560 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?"); 2561 continue; 2562 } 2563 2564 // Record the local offset of this macro. 2565 unsigned Index = ID - FirstMacroID; 2566 if (Index == MacroOffsets.size()) 2567 MacroOffsets.push_back(Stream.GetCurrentBitNo()); 2568 else { 2569 if (Index > MacroOffsets.size()) 2570 MacroOffsets.resize(Index + 1); 2571 2572 MacroOffsets[Index] = Stream.GetCurrentBitNo(); 2573 } 2574 2575 AddIdentifierRef(Name, Record); 2576 AddSourceLocation(MI->getDefinitionLoc(), Record); 2577 AddSourceLocation(MI->getDefinitionEndLoc(), Record); 2578 Record.push_back(MI->isUsed()); 2579 Record.push_back(MI->isUsedForHeaderGuard()); 2580 unsigned Code; 2581 if (MI->isObjectLike()) { 2582 Code = PP_MACRO_OBJECT_LIKE; 2583 } else { 2584 Code = PP_MACRO_FUNCTION_LIKE; 2585 2586 Record.push_back(MI->isC99Varargs()); 2587 Record.push_back(MI->isGNUVarargs()); 2588 Record.push_back(MI->hasCommaPasting()); 2589 Record.push_back(MI->getNumParams()); 2590 for (const IdentifierInfo *Param : MI->params()) 2591 AddIdentifierRef(Param, Record); 2592 } 2593 2594 // If we have a detailed preprocessing record, record the macro definition 2595 // ID that corresponds to this macro. 2596 if (PPRec) 2597 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]); 2598 2599 Stream.EmitRecord(Code, Record); 2600 Record.clear(); 2601 2602 // Emit the tokens array. 2603 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) { 2604 // Note that we know that the preprocessor does not have any annotation 2605 // tokens in it because they are created by the parser, and thus can't 2606 // be in a macro definition. 2607 const Token &Tok = MI->getReplacementToken(TokNo); 2608 AddToken(Tok, Record); 2609 Stream.EmitRecord(PP_TOKEN, Record); 2610 Record.clear(); 2611 } 2612 ++NumMacros; 2613 } 2614 2615 Stream.ExitBlock(); 2616 2617 // Write the offsets table for macro IDs. 2618 using namespace llvm; 2619 2620 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2621 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET)); 2622 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros 2623 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID 2624 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2625 2626 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2627 { 2628 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(), 2629 FirstMacroID - NUM_PREDEF_MACRO_IDS}; 2630 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets)); 2631 } 2632 } 2633 2634 void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) { 2635 if (PPRec.local_begin() == PPRec.local_end()) 2636 return; 2637 2638 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets; 2639 2640 // Enter the preprocessor block. 2641 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3); 2642 2643 // If the preprocessor has a preprocessing record, emit it. 2644 unsigned NumPreprocessingRecords = 0; 2645 using namespace llvm; 2646 2647 // Set up the abbreviation for 2648 unsigned InclusionAbbrev = 0; 2649 { 2650 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2651 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE)); 2652 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length 2653 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes 2654 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind 2655 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module 2656 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2657 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2658 } 2659 2660 unsigned FirstPreprocessorEntityID 2661 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0) 2662 + NUM_PREDEF_PP_ENTITY_IDS; 2663 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID; 2664 RecordData Record; 2665 for (PreprocessingRecord::iterator E = PPRec.local_begin(), 2666 EEnd = PPRec.local_end(); 2667 E != EEnd; 2668 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) { 2669 Record.clear(); 2670 2671 PreprocessedEntityOffsets.push_back( 2672 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo())); 2673 2674 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) { 2675 // Record this macro definition's ID. 2676 MacroDefinitions[MD] = NextPreprocessorEntityID; 2677 2678 AddIdentifierRef(MD->getName(), Record); 2679 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record); 2680 continue; 2681 } 2682 2683 if (auto *ME = dyn_cast<MacroExpansion>(*E)) { 2684 Record.push_back(ME->isBuiltinMacro()); 2685 if (ME->isBuiltinMacro()) 2686 AddIdentifierRef(ME->getName(), Record); 2687 else 2688 Record.push_back(MacroDefinitions[ME->getDefinition()]); 2689 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record); 2690 continue; 2691 } 2692 2693 if (auto *ID = dyn_cast<InclusionDirective>(*E)) { 2694 Record.push_back(PPD_INCLUSION_DIRECTIVE); 2695 Record.push_back(ID->getFileName().size()); 2696 Record.push_back(ID->wasInQuotes()); 2697 Record.push_back(static_cast<unsigned>(ID->getKind())); 2698 Record.push_back(ID->importedModule()); 2699 SmallString<64> Buffer; 2700 Buffer += ID->getFileName(); 2701 // Check that the FileEntry is not null because it was not resolved and 2702 // we create a PCH even with compiler errors. 2703 if (ID->getFile()) 2704 Buffer += ID->getFile()->getName(); 2705 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer); 2706 continue; 2707 } 2708 2709 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter"); 2710 } 2711 Stream.ExitBlock(); 2712 2713 // Write the offsets table for the preprocessing record. 2714 if (NumPreprocessingRecords > 0) { 2715 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords); 2716 2717 // Write the offsets table for identifier IDs. 2718 using namespace llvm; 2719 2720 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2721 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS)); 2722 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity 2723 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2724 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2725 2726 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS, 2727 FirstPreprocessorEntityID - 2728 NUM_PREDEF_PP_ENTITY_IDS}; 2729 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record, 2730 bytes(PreprocessedEntityOffsets)); 2731 } 2732 2733 // Write the skipped region table for the preprocessing record. 2734 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges(); 2735 if (SkippedRanges.size() > 0) { 2736 std::vector<PPSkippedRange> SerializedSkippedRanges; 2737 SerializedSkippedRanges.reserve(SkippedRanges.size()); 2738 for (auto const& Range : SkippedRanges) 2739 SerializedSkippedRanges.emplace_back(Range); 2740 2741 using namespace llvm; 2742 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2743 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES)); 2744 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2745 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2746 2747 Record.clear(); 2748 Record.push_back(PPD_SKIPPED_RANGES); 2749 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record, 2750 bytes(SerializedSkippedRanges)); 2751 } 2752 } 2753 2754 unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) { 2755 if (!Mod) 2756 return 0; 2757 2758 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod); 2759 if (Known != SubmoduleIDs.end()) 2760 return Known->second; 2761 2762 auto *Top = Mod->getTopLevelModule(); 2763 if (Top != WritingModule && 2764 (getLangOpts().CompilingPCH || 2765 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule)))) 2766 return 0; 2767 2768 return SubmoduleIDs[Mod] = NextSubmoduleID++; 2769 } 2770 2771 unsigned ASTWriter::getSubmoduleID(Module *Mod) { 2772 // FIXME: This can easily happen, if we have a reference to a submodule that 2773 // did not result in us loading a module file for that submodule. For 2774 // instance, a cross-top-level-module 'conflict' declaration will hit this. 2775 unsigned ID = getLocalOrImportedSubmoduleID(Mod); 2776 assert((ID || !Mod) && 2777 "asked for module ID for non-local, non-imported module"); 2778 return ID; 2779 } 2780 2781 /// \brief Compute the number of modules within the given tree (including the 2782 /// given module). 2783 static unsigned getNumberOfModules(Module *Mod) { 2784 unsigned ChildModules = 0; 2785 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end(); 2786 Sub != SubEnd; ++Sub) 2787 ChildModules += getNumberOfModules(*Sub); 2788 2789 return ChildModules + 1; 2790 } 2791 2792 void ASTWriter::WriteSubmodules(Module *WritingModule) { 2793 // Enter the submodule description block. 2794 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5); 2795 2796 // Write the abbreviations needed for the submodules block. 2797 using namespace llvm; 2798 2799 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 2800 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION)); 2801 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID 2802 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent 2803 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind 2804 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework 2805 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit 2806 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem 2807 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC 2808 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules... 2809 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit... 2810 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild... 2811 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh... 2812 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv... 2813 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2814 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2815 2816 Abbrev = std::make_shared<BitCodeAbbrev>(); 2817 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER)); 2818 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2819 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2820 2821 Abbrev = std::make_shared<BitCodeAbbrev>(); 2822 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER)); 2823 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2824 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2825 2826 Abbrev = std::make_shared<BitCodeAbbrev>(); 2827 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER)); 2828 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2829 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2830 2831 Abbrev = std::make_shared<BitCodeAbbrev>(); 2832 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR)); 2833 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2834 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2835 2836 Abbrev = std::make_shared<BitCodeAbbrev>(); 2837 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES)); 2838 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State 2839 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature 2840 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2841 2842 Abbrev = std::make_shared<BitCodeAbbrev>(); 2843 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER)); 2844 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2845 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2846 2847 Abbrev = std::make_shared<BitCodeAbbrev>(); 2848 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER)); 2849 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2850 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2851 2852 Abbrev = std::make_shared<BitCodeAbbrev>(); 2853 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER)); 2854 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2855 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2856 2857 Abbrev = std::make_shared<BitCodeAbbrev>(); 2858 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER)); 2859 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2860 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2861 2862 Abbrev = std::make_shared<BitCodeAbbrev>(); 2863 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY)); 2864 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework 2865 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 2866 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2867 2868 Abbrev = std::make_shared<BitCodeAbbrev>(); 2869 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO)); 2870 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name 2871 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2872 2873 Abbrev = std::make_shared<BitCodeAbbrev>(); 2874 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT)); 2875 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module 2876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message 2877 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2878 2879 Abbrev = std::make_shared<BitCodeAbbrev>(); 2880 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS)); 2881 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name 2882 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 2883 2884 // Write the submodule metadata block. 2885 RecordData::value_type Record[] = { 2886 getNumberOfModules(WritingModule), 2887 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS}; 2888 Stream.EmitRecord(SUBMODULE_METADATA, Record); 2889 2890 // Write all of the submodules. 2891 std::queue<Module *> Q; 2892 Q.push(WritingModule); 2893 while (!Q.empty()) { 2894 Module *Mod = Q.front(); 2895 Q.pop(); 2896 unsigned ID = getSubmoduleID(Mod); 2897 2898 uint64_t ParentID = 0; 2899 if (Mod->Parent) { 2900 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?"); 2901 ParentID = SubmoduleIDs[Mod->Parent]; 2902 } 2903 2904 // Emit the definition of the block. 2905 { 2906 RecordData::value_type Record[] = {SUBMODULE_DEFINITION, 2907 ID, 2908 ParentID, 2909 (RecordData::value_type)Mod->Kind, 2910 Mod->IsFramework, 2911 Mod->IsExplicit, 2912 Mod->IsSystem, 2913 Mod->IsExternC, 2914 Mod->InferSubmodules, 2915 Mod->InferExplicitSubmodules, 2916 Mod->InferExportWildcard, 2917 Mod->ConfigMacrosExhaustive, 2918 Mod->ModuleMapIsPrivate}; 2919 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name); 2920 } 2921 2922 // Emit the requirements. 2923 for (const auto &R : Mod->Requirements) { 2924 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second}; 2925 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first); 2926 } 2927 2928 // Emit the umbrella header, if there is one. 2929 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) { 2930 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER}; 2931 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record, 2932 UmbrellaHeader.NameAsWritten); 2933 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) { 2934 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR}; 2935 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record, 2936 UmbrellaDir.NameAsWritten); 2937 } 2938 2939 // Emit the headers. 2940 struct { 2941 unsigned RecordKind; 2942 unsigned Abbrev; 2943 Module::HeaderKind HeaderKind; 2944 } HeaderLists[] = { 2945 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal}, 2946 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual}, 2947 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private}, 2948 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev, 2949 Module::HK_PrivateTextual}, 2950 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded} 2951 }; 2952 for (auto &HL : HeaderLists) { 2953 RecordData::value_type Record[] = {HL.RecordKind}; 2954 for (auto &H : Mod->Headers[HL.HeaderKind]) 2955 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten); 2956 } 2957 2958 // Emit the top headers. 2959 { 2960 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager()); 2961 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER}; 2962 for (auto *H : TopHeaders) 2963 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName()); 2964 } 2965 2966 // Emit the imports. 2967 if (!Mod->Imports.empty()) { 2968 RecordData Record; 2969 for (auto *I : Mod->Imports) 2970 Record.push_back(getSubmoduleID(I)); 2971 Stream.EmitRecord(SUBMODULE_IMPORTS, Record); 2972 } 2973 2974 // Emit the exports. 2975 if (!Mod->Exports.empty()) { 2976 RecordData Record; 2977 for (const auto &E : Mod->Exports) { 2978 // FIXME: This may fail; we don't require that all exported modules 2979 // are local or imported. 2980 Record.push_back(getSubmoduleID(E.getPointer())); 2981 Record.push_back(E.getInt()); 2982 } 2983 Stream.EmitRecord(SUBMODULE_EXPORTS, Record); 2984 } 2985 2986 //FIXME: How do we emit the 'use'd modules? They may not be submodules. 2987 // Might be unnecessary as use declarations are only used to build the 2988 // module itself. 2989 2990 // Emit the link libraries. 2991 for (const auto &LL : Mod->LinkLibraries) { 2992 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY, 2993 LL.IsFramework}; 2994 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library); 2995 } 2996 2997 // Emit the conflicts. 2998 for (const auto &C : Mod->Conflicts) { 2999 // FIXME: This may fail; we don't require that all conflicting modules 3000 // are local or imported. 3001 RecordData::value_type Record[] = {SUBMODULE_CONFLICT, 3002 getSubmoduleID(C.Other)}; 3003 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message); 3004 } 3005 3006 // Emit the configuration macros. 3007 for (const auto &CM : Mod->ConfigMacros) { 3008 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO}; 3009 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM); 3010 } 3011 3012 // Emit the initializers, if any. 3013 RecordData Inits; 3014 for (Decl *D : Context->getModuleInitializers(Mod)) 3015 Inits.push_back(GetDeclRef(D)); 3016 if (!Inits.empty()) 3017 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits); 3018 3019 // Emit the name of the re-exported module, if any. 3020 if (!Mod->ExportAsModule.empty()) { 3021 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS}; 3022 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule); 3023 } 3024 3025 // Queue up the submodules of this module. 3026 for (auto *M : Mod->submodules()) 3027 Q.push(M); 3028 } 3029 3030 Stream.ExitBlock(); 3031 3032 assert((NextSubmoduleID - FirstSubmoduleID == 3033 getNumberOfModules(WritingModule)) && 3034 "Wrong # of submodules; found a reference to a non-local, " 3035 "non-imported submodule?"); 3036 } 3037 3038 void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag, 3039 bool isModule) { 3040 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64> 3041 DiagStateIDMap; 3042 unsigned CurrID = 0; 3043 RecordData Record; 3044 3045 auto EncodeDiagStateFlags = 3046 [](const DiagnosticsEngine::DiagState *DS) -> unsigned { 3047 unsigned Result = (unsigned)DS->ExtBehavior; 3048 for (unsigned Val : 3049 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings, 3050 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal, 3051 (unsigned)DS->SuppressSystemWarnings}) 3052 Result = (Result << 1) | Val; 3053 return Result; 3054 }; 3055 3056 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState); 3057 Record.push_back(Flags); 3058 3059 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State, 3060 bool IncludeNonPragmaStates) { 3061 // Ensure that the diagnostic state wasn't modified since it was created. 3062 // We will not correctly round-trip this information otherwise. 3063 assert(Flags == EncodeDiagStateFlags(State) && 3064 "diag state flags vary in single AST file"); 3065 3066 unsigned &DiagStateID = DiagStateIDMap[State]; 3067 Record.push_back(DiagStateID); 3068 3069 if (DiagStateID == 0) { 3070 DiagStateID = ++CurrID; 3071 3072 // Add a placeholder for the number of mappings. 3073 auto SizeIdx = Record.size(); 3074 Record.emplace_back(); 3075 for (const auto &I : *State) { 3076 if (I.second.isPragma() || IncludeNonPragmaStates) { 3077 Record.push_back(I.first); 3078 Record.push_back(I.second.serialize()); 3079 } 3080 } 3081 // Update the placeholder. 3082 Record[SizeIdx] = (Record.size() - SizeIdx) / 2; 3083 } 3084 }; 3085 3086 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule); 3087 3088 // Reserve a spot for the number of locations with state transitions. 3089 auto NumLocationsIdx = Record.size(); 3090 Record.emplace_back(); 3091 3092 // Emit the state transitions. 3093 unsigned NumLocations = 0; 3094 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) { 3095 if (!FileIDAndFile.first.isValid() || 3096 !FileIDAndFile.second.HasLocalTransitions) 3097 continue; 3098 ++NumLocations; 3099 3100 SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0); 3101 assert(!Loc.isInvalid() && "start loc for valid FileID is invalid"); 3102 AddSourceLocation(Loc, Record); 3103 3104 Record.push_back(FileIDAndFile.second.StateTransitions.size()); 3105 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) { 3106 Record.push_back(StatePoint.Offset); 3107 AddDiagState(StatePoint.State, false); 3108 } 3109 } 3110 3111 // Backpatch the number of locations. 3112 Record[NumLocationsIdx] = NumLocations; 3113 3114 // Emit CurDiagStateLoc. Do it last in order to match source order. 3115 // 3116 // This also protects against a hypothetical corner case with simulating 3117 // -Werror settings for implicit modules in the ASTReader, where reading 3118 // CurDiagState out of context could change whether warning pragmas are 3119 // treated as errors. 3120 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record); 3121 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false); 3122 3123 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record); 3124 } 3125 3126 //===----------------------------------------------------------------------===// 3127 // Type Serialization 3128 //===----------------------------------------------------------------------===// 3129 3130 /// \brief Write the representation of a type to the AST stream. 3131 void ASTWriter::WriteType(QualType T) { 3132 TypeIdx &IdxRef = TypeIdxs[T]; 3133 if (IdxRef.getIndex() == 0) // we haven't seen this type before. 3134 IdxRef = TypeIdx(NextTypeID++); 3135 TypeIdx Idx = IdxRef; 3136 3137 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST"); 3138 3139 RecordData Record; 3140 3141 // Emit the type's representation. 3142 ASTTypeWriter W(*this, Record); 3143 W.Visit(T); 3144 uint64_t Offset = W.Emit(); 3145 3146 // Record the offset for this type. 3147 unsigned Index = Idx.getIndex() - FirstTypeID; 3148 if (TypeOffsets.size() == Index) 3149 TypeOffsets.push_back(Offset); 3150 else if (TypeOffsets.size() < Index) { 3151 TypeOffsets.resize(Index + 1); 3152 TypeOffsets[Index] = Offset; 3153 } else { 3154 llvm_unreachable("Types emitted in wrong order"); 3155 } 3156 } 3157 3158 //===----------------------------------------------------------------------===// 3159 // Declaration Serialization 3160 //===----------------------------------------------------------------------===// 3161 3162 /// \brief Write the block containing all of the declaration IDs 3163 /// lexically declared within the given DeclContext. 3164 /// 3165 /// \returns the offset of the DECL_CONTEXT_LEXICAL block within the 3166 /// bitstream, or 0 if no block was written. 3167 uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context, 3168 DeclContext *DC) { 3169 if (DC->decls_empty()) 3170 return 0; 3171 3172 uint64_t Offset = Stream.GetCurrentBitNo(); 3173 SmallVector<uint32_t, 128> KindDeclPairs; 3174 for (const auto *D : DC->decls()) { 3175 KindDeclPairs.push_back(D->getKind()); 3176 KindDeclPairs.push_back(GetDeclRef(D)); 3177 } 3178 3179 ++NumLexicalDeclContexts; 3180 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL}; 3181 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record, 3182 bytes(KindDeclPairs)); 3183 return Offset; 3184 } 3185 3186 void ASTWriter::WriteTypeDeclOffsets() { 3187 using namespace llvm; 3188 3189 // Write the type offsets array 3190 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 3191 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET)); 3192 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types 3193 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index 3194 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block 3195 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 3196 { 3197 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(), 3198 FirstTypeID - NUM_PREDEF_TYPE_IDS}; 3199 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets)); 3200 } 3201 3202 // Write the declaration offsets array 3203 Abbrev = std::make_shared<BitCodeAbbrev>(); 3204 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET)); 3205 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations 3206 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID 3207 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block 3208 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 3209 { 3210 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(), 3211 FirstDeclID - NUM_PREDEF_DECL_IDS}; 3212 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets)); 3213 } 3214 } 3215 3216 void ASTWriter::WriteFileDeclIDsMap() { 3217 using namespace llvm; 3218 3219 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs( 3220 FileDeclIDs.begin(), FileDeclIDs.end()); 3221 llvm::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(), 3222 llvm::less_first()); 3223 3224 // Join the vectors of DeclIDs from all files. 3225 SmallVector<DeclID, 256> FileGroupedDeclIDs; 3226 for (auto &FileDeclEntry : SortedFileDeclIDs) { 3227 DeclIDInFileInfo &Info = *FileDeclEntry.second; 3228 Info.FirstDeclIndex = FileGroupedDeclIDs.size(); 3229 for (auto &LocDeclEntry : Info.DeclIDs) 3230 FileGroupedDeclIDs.push_back(LocDeclEntry.second); 3231 } 3232 3233 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 3234 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS)); 3235 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3236 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 3237 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev)); 3238 RecordData::value_type Record[] = {FILE_SORTED_DECLS, 3239 FileGroupedDeclIDs.size()}; 3240 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs)); 3241 } 3242 3243 void ASTWriter::WriteComments() { 3244 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3); 3245 ArrayRef<RawComment *> RawComments = Context->Comments.getComments(); 3246 RecordData Record; 3247 for (const auto *I : RawComments) { 3248 Record.clear(); 3249 AddSourceRange(I->getSourceRange(), Record); 3250 Record.push_back(I->getKind()); 3251 Record.push_back(I->isTrailingComment()); 3252 Record.push_back(I->isAlmostTrailingComment()); 3253 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record); 3254 } 3255 Stream.ExitBlock(); 3256 } 3257 3258 //===----------------------------------------------------------------------===// 3259 // Global Method Pool and Selector Serialization 3260 //===----------------------------------------------------------------------===// 3261 3262 namespace { 3263 3264 // Trait used for the on-disk hash table used in the method pool. 3265 class ASTMethodPoolTrait { 3266 ASTWriter &Writer; 3267 3268 public: 3269 using key_type = Selector; 3270 using key_type_ref = key_type; 3271 3272 struct data_type { 3273 SelectorID ID; 3274 ObjCMethodList Instance, Factory; 3275 }; 3276 using data_type_ref = const data_type &; 3277 3278 using hash_value_type = unsigned; 3279 using offset_type = unsigned; 3280 3281 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {} 3282 3283 static hash_value_type ComputeHash(Selector Sel) { 3284 return serialization::ComputeHash(Sel); 3285 } 3286 3287 std::pair<unsigned, unsigned> 3288 EmitKeyDataLength(raw_ostream& Out, Selector Sel, 3289 data_type_ref Methods) { 3290 using namespace llvm::support; 3291 3292 endian::Writer<little> LE(Out); 3293 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4); 3294 LE.write<uint16_t>(KeyLen); 3295 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts 3296 for (const ObjCMethodList *Method = &Methods.Instance; Method; 3297 Method = Method->getNext()) 3298 if (Method->getMethod()) 3299 DataLen += 4; 3300 for (const ObjCMethodList *Method = &Methods.Factory; Method; 3301 Method = Method->getNext()) 3302 if (Method->getMethod()) 3303 DataLen += 4; 3304 LE.write<uint16_t>(DataLen); 3305 return std::make_pair(KeyLen, DataLen); 3306 } 3307 3308 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) { 3309 using namespace llvm::support; 3310 3311 endian::Writer<little> LE(Out); 3312 uint64_t Start = Out.tell(); 3313 assert((Start >> 32) == 0 && "Selector key offset too large"); 3314 Writer.SetSelectorOffset(Sel, Start); 3315 unsigned N = Sel.getNumArgs(); 3316 LE.write<uint16_t>(N); 3317 if (N == 0) 3318 N = 1; 3319 for (unsigned I = 0; I != N; ++I) 3320 LE.write<uint32_t>( 3321 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I))); 3322 } 3323 3324 void EmitData(raw_ostream& Out, key_type_ref, 3325 data_type_ref Methods, unsigned DataLen) { 3326 using namespace llvm::support; 3327 3328 endian::Writer<little> LE(Out); 3329 uint64_t Start = Out.tell(); (void)Start; 3330 LE.write<uint32_t>(Methods.ID); 3331 unsigned NumInstanceMethods = 0; 3332 for (const ObjCMethodList *Method = &Methods.Instance; Method; 3333 Method = Method->getNext()) 3334 if (Method->getMethod()) 3335 ++NumInstanceMethods; 3336 3337 unsigned NumFactoryMethods = 0; 3338 for (const ObjCMethodList *Method = &Methods.Factory; Method; 3339 Method = Method->getNext()) 3340 if (Method->getMethod()) 3341 ++NumFactoryMethods; 3342 3343 unsigned InstanceBits = Methods.Instance.getBits(); 3344 assert(InstanceBits < 4); 3345 unsigned InstanceHasMoreThanOneDeclBit = 3346 Methods.Instance.hasMoreThanOneDecl(); 3347 unsigned FullInstanceBits = (NumInstanceMethods << 3) | 3348 (InstanceHasMoreThanOneDeclBit << 2) | 3349 InstanceBits; 3350 unsigned FactoryBits = Methods.Factory.getBits(); 3351 assert(FactoryBits < 4); 3352 unsigned FactoryHasMoreThanOneDeclBit = 3353 Methods.Factory.hasMoreThanOneDecl(); 3354 unsigned FullFactoryBits = (NumFactoryMethods << 3) | 3355 (FactoryHasMoreThanOneDeclBit << 2) | 3356 FactoryBits; 3357 LE.write<uint16_t>(FullInstanceBits); 3358 LE.write<uint16_t>(FullFactoryBits); 3359 for (const ObjCMethodList *Method = &Methods.Instance; Method; 3360 Method = Method->getNext()) 3361 if (Method->getMethod()) 3362 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod())); 3363 for (const ObjCMethodList *Method = &Methods.Factory; Method; 3364 Method = Method->getNext()) 3365 if (Method->getMethod()) 3366 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod())); 3367 3368 assert(Out.tell() - Start == DataLen && "Data length is wrong"); 3369 } 3370 }; 3371 3372 } // namespace 3373 3374 /// \brief Write ObjC data: selectors and the method pool. 3375 /// 3376 /// The method pool contains both instance and factory methods, stored 3377 /// in an on-disk hash table indexed by the selector. The hash table also 3378 /// contains an empty entry for every other selector known to Sema. 3379 void ASTWriter::WriteSelectors(Sema &SemaRef) { 3380 using namespace llvm; 3381 3382 // Do we have to do anything at all? 3383 if (SemaRef.MethodPool.empty() && SelectorIDs.empty()) 3384 return; 3385 unsigned NumTableEntries = 0; 3386 // Create and write out the blob that contains selectors and the method pool. 3387 { 3388 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator; 3389 ASTMethodPoolTrait Trait(*this); 3390 3391 // Create the on-disk hash table representation. We walk through every 3392 // selector we've seen and look it up in the method pool. 3393 SelectorOffsets.resize(NextSelectorID - FirstSelectorID); 3394 for (auto &SelectorAndID : SelectorIDs) { 3395 Selector S = SelectorAndID.first; 3396 SelectorID ID = SelectorAndID.second; 3397 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S); 3398 ASTMethodPoolTrait::data_type Data = { 3399 ID, 3400 ObjCMethodList(), 3401 ObjCMethodList() 3402 }; 3403 if (F != SemaRef.MethodPool.end()) { 3404 Data.Instance = F->second.first; 3405 Data.Factory = F->second.second; 3406 } 3407 // Only write this selector if it's not in an existing AST or something 3408 // changed. 3409 if (Chain && ID < FirstSelectorID) { 3410 // Selector already exists. Did it change? 3411 bool changed = false; 3412 for (ObjCMethodList *M = &Data.Instance; 3413 !changed && M && M->getMethod(); M = M->getNext()) { 3414 if (!M->getMethod()->isFromASTFile()) 3415 changed = true; 3416 } 3417 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod(); 3418 M = M->getNext()) { 3419 if (!M->getMethod()->isFromASTFile()) 3420 changed = true; 3421 } 3422 if (!changed) 3423 continue; 3424 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) { 3425 // A new method pool entry. 3426 ++NumTableEntries; 3427 } 3428 Generator.insert(S, Data, Trait); 3429 } 3430 3431 // Create the on-disk hash table in a buffer. 3432 SmallString<4096> MethodPool; 3433 uint32_t BucketOffset; 3434 { 3435 using namespace llvm::support; 3436 3437 ASTMethodPoolTrait Trait(*this); 3438 llvm::raw_svector_ostream Out(MethodPool); 3439 // Make sure that no bucket is at offset 0 3440 endian::Writer<little>(Out).write<uint32_t>(0); 3441 BucketOffset = Generator.Emit(Out, Trait); 3442 } 3443 3444 // Create a blob abbreviation 3445 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 3446 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL)); 3447 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3448 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3449 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 3450 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 3451 3452 // Write the method pool 3453 { 3454 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset, 3455 NumTableEntries}; 3456 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool); 3457 } 3458 3459 // Create a blob abbreviation for the selector table offsets. 3460 Abbrev = std::make_shared<BitCodeAbbrev>(); 3461 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS)); 3462 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size 3463 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID 3464 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 3465 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 3466 3467 // Write the selector offsets table. 3468 { 3469 RecordData::value_type Record[] = { 3470 SELECTOR_OFFSETS, SelectorOffsets.size(), 3471 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS}; 3472 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record, 3473 bytes(SelectorOffsets)); 3474 } 3475 } 3476 } 3477 3478 /// \brief Write the selectors referenced in @selector expression into AST file. 3479 void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) { 3480 using namespace llvm; 3481 3482 if (SemaRef.ReferencedSelectors.empty()) 3483 return; 3484 3485 RecordData Record; 3486 ASTRecordWriter Writer(*this, Record); 3487 3488 // Note: this writes out all references even for a dependent AST. But it is 3489 // very tricky to fix, and given that @selector shouldn't really appear in 3490 // headers, probably not worth it. It's not a correctness issue. 3491 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) { 3492 Selector Sel = SelectorAndLocation.first; 3493 SourceLocation Loc = SelectorAndLocation.second; 3494 Writer.AddSelectorRef(Sel); 3495 Writer.AddSourceLocation(Loc); 3496 } 3497 Writer.Emit(REFERENCED_SELECTOR_POOL); 3498 } 3499 3500 //===----------------------------------------------------------------------===// 3501 // Identifier Table Serialization 3502 //===----------------------------------------------------------------------===// 3503 3504 /// Determine the declaration that should be put into the name lookup table to 3505 /// represent the given declaration in this module. This is usually D itself, 3506 /// but if D was imported and merged into a local declaration, we want the most 3507 /// recent local declaration instead. The chosen declaration will be the most 3508 /// recent declaration in any module that imports this one. 3509 static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts, 3510 NamedDecl *D) { 3511 if (!LangOpts.Modules || !D->isFromASTFile()) 3512 return D; 3513 3514 if (Decl *Redecl = D->getPreviousDecl()) { 3515 // For Redeclarable decls, a prior declaration might be local. 3516 for (; Redecl; Redecl = Redecl->getPreviousDecl()) { 3517 // If we find a local decl, we're done. 3518 if (!Redecl->isFromASTFile()) { 3519 // Exception: in very rare cases (for injected-class-names), not all 3520 // redeclarations are in the same semantic context. Skip ones in a 3521 // different context. They don't go in this lookup table at all. 3522 if (!Redecl->getDeclContext()->getRedeclContext()->Equals( 3523 D->getDeclContext()->getRedeclContext())) 3524 continue; 3525 return cast<NamedDecl>(Redecl); 3526 } 3527 3528 // If we find a decl from a (chained-)PCH stop since we won't find a 3529 // local one. 3530 if (Redecl->getOwningModuleID() == 0) 3531 break; 3532 } 3533 } else if (Decl *First = D->getCanonicalDecl()) { 3534 // For Mergeable decls, the first decl might be local. 3535 if (!First->isFromASTFile()) 3536 return cast<NamedDecl>(First); 3537 } 3538 3539 // All declarations are imported. Our most recent declaration will also be 3540 // the most recent one in anyone who imports us. 3541 return D; 3542 } 3543 3544 namespace { 3545 3546 class ASTIdentifierTableTrait { 3547 ASTWriter &Writer; 3548 Preprocessor &PP; 3549 IdentifierResolver &IdResolver; 3550 bool IsModule; 3551 bool NeedDecls; 3552 ASTWriter::RecordData *InterestingIdentifierOffsets; 3553 3554 /// \brief Determines whether this is an "interesting" identifier that needs a 3555 /// full IdentifierInfo structure written into the hash table. Notably, this 3556 /// doesn't check whether the name has macros defined; use PublicMacroIterator 3557 /// to check that. 3558 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) { 3559 if (MacroOffset || 3560 II->isPoisoned() || 3561 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) || 3562 II->hasRevertedTokenIDToIdentifier() || 3563 (NeedDecls && II->getFETokenInfo<void>())) 3564 return true; 3565 3566 return false; 3567 } 3568 3569 public: 3570 using key_type = IdentifierInfo *; 3571 using key_type_ref = key_type; 3572 3573 using data_type = IdentID; 3574 using data_type_ref = data_type; 3575 3576 using hash_value_type = unsigned; 3577 using offset_type = unsigned; 3578 3579 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP, 3580 IdentifierResolver &IdResolver, bool IsModule, 3581 ASTWriter::RecordData *InterestingIdentifierOffsets) 3582 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule), 3583 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus), 3584 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {} 3585 3586 bool needDecls() const { return NeedDecls; } 3587 3588 static hash_value_type ComputeHash(const IdentifierInfo* II) { 3589 return llvm::djbHash(II->getName()); 3590 } 3591 3592 bool isInterestingIdentifier(const IdentifierInfo *II) { 3593 auto MacroOffset = Writer.getMacroDirectivesOffset(II); 3594 return isInterestingIdentifier(II, MacroOffset); 3595 } 3596 3597 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) { 3598 return isInterestingIdentifier(II, 0); 3599 } 3600 3601 std::pair<unsigned, unsigned> 3602 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) { 3603 unsigned KeyLen = II->getLength() + 1; 3604 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1 3605 auto MacroOffset = Writer.getMacroDirectivesOffset(II); 3606 if (isInterestingIdentifier(II, MacroOffset)) { 3607 DataLen += 2; // 2 bytes for builtin ID 3608 DataLen += 2; // 2 bytes for flags 3609 if (MacroOffset) 3610 DataLen += 4; // MacroDirectives offset. 3611 3612 if (NeedDecls) { 3613 for (IdentifierResolver::iterator D = IdResolver.begin(II), 3614 DEnd = IdResolver.end(); 3615 D != DEnd; ++D) 3616 DataLen += 4; 3617 } 3618 } 3619 3620 using namespace llvm::support; 3621 3622 endian::Writer<little> LE(Out); 3623 3624 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen); 3625 LE.write<uint16_t>(DataLen); 3626 // We emit the key length after the data length so that every 3627 // string is preceded by a 16-bit length. This matches the PTH 3628 // format for storing identifiers. 3629 LE.write<uint16_t>(KeyLen); 3630 return std::make_pair(KeyLen, DataLen); 3631 } 3632 3633 void EmitKey(raw_ostream& Out, const IdentifierInfo* II, 3634 unsigned KeyLen) { 3635 // Record the location of the key data. This is used when generating 3636 // the mapping from persistent IDs to strings. 3637 Writer.SetIdentifierOffset(II, Out.tell()); 3638 3639 // Emit the offset of the key/data length information to the interesting 3640 // identifiers table if necessary. 3641 if (InterestingIdentifierOffsets && isInterestingIdentifier(II)) 3642 InterestingIdentifierOffsets->push_back(Out.tell() - 4); 3643 3644 Out.write(II->getNameStart(), KeyLen); 3645 } 3646 3647 void EmitData(raw_ostream& Out, IdentifierInfo* II, 3648 IdentID ID, unsigned) { 3649 using namespace llvm::support; 3650 3651 endian::Writer<little> LE(Out); 3652 3653 auto MacroOffset = Writer.getMacroDirectivesOffset(II); 3654 if (!isInterestingIdentifier(II, MacroOffset)) { 3655 LE.write<uint32_t>(ID << 1); 3656 return; 3657 } 3658 3659 LE.write<uint32_t>((ID << 1) | 0x01); 3660 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID(); 3661 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader."); 3662 LE.write<uint16_t>(Bits); 3663 Bits = 0; 3664 bool HadMacroDefinition = MacroOffset != 0; 3665 Bits = (Bits << 1) | unsigned(HadMacroDefinition); 3666 Bits = (Bits << 1) | unsigned(II->isExtensionToken()); 3667 Bits = (Bits << 1) | unsigned(II->isPoisoned()); 3668 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin()); 3669 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier()); 3670 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword()); 3671 LE.write<uint16_t>(Bits); 3672 3673 if (HadMacroDefinition) 3674 LE.write<uint32_t>(MacroOffset); 3675 3676 if (NeedDecls) { 3677 // Emit the declaration IDs in reverse order, because the 3678 // IdentifierResolver provides the declarations as they would be 3679 // visible (e.g., the function "stat" would come before the struct 3680 // "stat"), but the ASTReader adds declarations to the end of the list 3681 // (so we need to see the struct "stat" before the function "stat"). 3682 // Only emit declarations that aren't from a chained PCH, though. 3683 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II), 3684 IdResolver.end()); 3685 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(), 3686 DEnd = Decls.rend(); 3687 D != DEnd; ++D) 3688 LE.write<uint32_t>( 3689 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D))); 3690 } 3691 } 3692 }; 3693 3694 } // namespace 3695 3696 /// \brief Write the identifier table into the AST file. 3697 /// 3698 /// The identifier table consists of a blob containing string data 3699 /// (the actual identifiers themselves) and a separate "offsets" index 3700 /// that maps identifier IDs to locations within the blob. 3701 void ASTWriter::WriteIdentifierTable(Preprocessor &PP, 3702 IdentifierResolver &IdResolver, 3703 bool IsModule) { 3704 using namespace llvm; 3705 3706 RecordData InterestingIdents; 3707 3708 // Create and write out the blob that contains the identifier 3709 // strings. 3710 { 3711 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator; 3712 ASTIdentifierTableTrait Trait( 3713 *this, PP, IdResolver, IsModule, 3714 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr); 3715 3716 // Look for any identifiers that were named while processing the 3717 // headers, but are otherwise not needed. We add these to the hash 3718 // table to enable checking of the predefines buffer in the case 3719 // where the user adds new macro definitions when building the AST 3720 // file. 3721 SmallVector<const IdentifierInfo *, 128> IIs; 3722 for (const auto &ID : PP.getIdentifierTable()) 3723 IIs.push_back(ID.second); 3724 // Sort the identifiers lexicographically before getting them references so 3725 // that their order is stable. 3726 llvm::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>()); 3727 for (const IdentifierInfo *II : IIs) 3728 if (Trait.isInterestingNonMacroIdentifier(II)) 3729 getIdentifierRef(II); 3730 3731 // Create the on-disk hash table representation. We only store offsets 3732 // for identifiers that appear here for the first time. 3733 IdentifierOffsets.resize(NextIdentID - FirstIdentID); 3734 for (auto IdentIDPair : IdentifierIDs) { 3735 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first); 3736 IdentID ID = IdentIDPair.second; 3737 assert(II && "NULL identifier in identifier table"); 3738 // Write out identifiers if either the ID is local or the identifier has 3739 // changed since it was loaded. 3740 if (ID >= FirstIdentID || !Chain || !II->isFromAST() 3741 || II->hasChangedSinceDeserialization() || 3742 (Trait.needDecls() && 3743 II->hasFETokenInfoChangedSinceDeserialization())) 3744 Generator.insert(II, ID, Trait); 3745 } 3746 3747 // Create the on-disk hash table in a buffer. 3748 SmallString<4096> IdentifierTable; 3749 uint32_t BucketOffset; 3750 { 3751 using namespace llvm::support; 3752 3753 llvm::raw_svector_ostream Out(IdentifierTable); 3754 // Make sure that no bucket is at offset 0 3755 endian::Writer<little>(Out).write<uint32_t>(0); 3756 BucketOffset = Generator.Emit(Out, Trait); 3757 } 3758 3759 // Create a blob abbreviation 3760 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 3761 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE)); 3762 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 3763 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 3764 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 3765 3766 // Write the identifier table 3767 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset}; 3768 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable); 3769 } 3770 3771 // Write the offsets table for identifier IDs. 3772 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 3773 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET)); 3774 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers 3775 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID 3776 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 3777 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 3778 3779 #ifndef NDEBUG 3780 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I) 3781 assert(IdentifierOffsets[I] && "Missing identifier offset?"); 3782 #endif 3783 3784 RecordData::value_type Record[] = {IDENTIFIER_OFFSET, 3785 IdentifierOffsets.size(), 3786 FirstIdentID - NUM_PREDEF_IDENT_IDS}; 3787 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record, 3788 bytes(IdentifierOffsets)); 3789 3790 // In C++, write the list of interesting identifiers (those that are 3791 // defined as macros, poisoned, or similar unusual things). 3792 if (!InterestingIdents.empty()) 3793 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents); 3794 } 3795 3796 //===----------------------------------------------------------------------===// 3797 // DeclContext's Name Lookup Table Serialization 3798 //===----------------------------------------------------------------------===// 3799 3800 namespace { 3801 3802 // Trait used for the on-disk hash table used in the method pool. 3803 class ASTDeclContextNameLookupTrait { 3804 ASTWriter &Writer; 3805 llvm::SmallVector<DeclID, 64> DeclIDs; 3806 3807 public: 3808 using key_type = DeclarationNameKey; 3809 using key_type_ref = key_type; 3810 3811 /// A start and end index into DeclIDs, representing a sequence of decls. 3812 using data_type = std::pair<unsigned, unsigned>; 3813 using data_type_ref = const data_type &; 3814 3815 using hash_value_type = unsigned; 3816 using offset_type = unsigned; 3817 3818 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {} 3819 3820 template<typename Coll> 3821 data_type getData(const Coll &Decls) { 3822 unsigned Start = DeclIDs.size(); 3823 for (NamedDecl *D : Decls) { 3824 DeclIDs.push_back( 3825 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D))); 3826 } 3827 return std::make_pair(Start, DeclIDs.size()); 3828 } 3829 3830 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) { 3831 unsigned Start = DeclIDs.size(); 3832 for (auto ID : FromReader) 3833 DeclIDs.push_back(ID); 3834 return std::make_pair(Start, DeclIDs.size()); 3835 } 3836 3837 static bool EqualKey(key_type_ref a, key_type_ref b) { 3838 return a == b; 3839 } 3840 3841 hash_value_type ComputeHash(DeclarationNameKey Name) { 3842 return Name.getHash(); 3843 } 3844 3845 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const { 3846 assert(Writer.hasChain() && 3847 "have reference to loaded module file but no chain?"); 3848 3849 using namespace llvm::support; 3850 3851 endian::Writer<little>(Out) 3852 .write<uint32_t>(Writer.getChain()->getModuleFileID(F)); 3853 } 3854 3855 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out, 3856 DeclarationNameKey Name, 3857 data_type_ref Lookup) { 3858 using namespace llvm::support; 3859 3860 endian::Writer<little> LE(Out); 3861 unsigned KeyLen = 1; 3862 switch (Name.getKind()) { 3863 case DeclarationName::Identifier: 3864 case DeclarationName::ObjCZeroArgSelector: 3865 case DeclarationName::ObjCOneArgSelector: 3866 case DeclarationName::ObjCMultiArgSelector: 3867 case DeclarationName::CXXLiteralOperatorName: 3868 case DeclarationName::CXXDeductionGuideName: 3869 KeyLen += 4; 3870 break; 3871 case DeclarationName::CXXOperatorName: 3872 KeyLen += 1; 3873 break; 3874 case DeclarationName::CXXConstructorName: 3875 case DeclarationName::CXXDestructorName: 3876 case DeclarationName::CXXConversionFunctionName: 3877 case DeclarationName::CXXUsingDirective: 3878 break; 3879 } 3880 LE.write<uint16_t>(KeyLen); 3881 3882 // 4 bytes for each DeclID. 3883 unsigned DataLen = 4 * (Lookup.second - Lookup.first); 3884 assert(uint16_t(DataLen) == DataLen && 3885 "too many decls for serialized lookup result"); 3886 LE.write<uint16_t>(DataLen); 3887 3888 return std::make_pair(KeyLen, DataLen); 3889 } 3890 3891 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) { 3892 using namespace llvm::support; 3893 3894 endian::Writer<little> LE(Out); 3895 LE.write<uint8_t>(Name.getKind()); 3896 switch (Name.getKind()) { 3897 case DeclarationName::Identifier: 3898 case DeclarationName::CXXLiteralOperatorName: 3899 case DeclarationName::CXXDeductionGuideName: 3900 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier())); 3901 return; 3902 case DeclarationName::ObjCZeroArgSelector: 3903 case DeclarationName::ObjCOneArgSelector: 3904 case DeclarationName::ObjCMultiArgSelector: 3905 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector())); 3906 return; 3907 case DeclarationName::CXXOperatorName: 3908 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS && 3909 "Invalid operator?"); 3910 LE.write<uint8_t>(Name.getOperatorKind()); 3911 return; 3912 case DeclarationName::CXXConstructorName: 3913 case DeclarationName::CXXDestructorName: 3914 case DeclarationName::CXXConversionFunctionName: 3915 case DeclarationName::CXXUsingDirective: 3916 return; 3917 } 3918 3919 llvm_unreachable("Invalid name kind?"); 3920 } 3921 3922 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup, 3923 unsigned DataLen) { 3924 using namespace llvm::support; 3925 3926 endian::Writer<little> LE(Out); 3927 uint64_t Start = Out.tell(); (void)Start; 3928 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I) 3929 LE.write<uint32_t>(DeclIDs[I]); 3930 assert(Out.tell() - Start == DataLen && "Data length is wrong"); 3931 } 3932 }; 3933 3934 } // namespace 3935 3936 bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result, 3937 DeclContext *DC) { 3938 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage; 3939 } 3940 3941 bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result, 3942 DeclContext *DC) { 3943 for (auto *D : Result.getLookupResult()) 3944 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile()) 3945 return false; 3946 3947 return true; 3948 } 3949 3950 void 3951 ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC, 3952 llvm::SmallVectorImpl<char> &LookupTable) { 3953 assert(!ConstDC->HasLazyLocalLexicalLookups && 3954 !ConstDC->HasLazyExternalLexicalLookups && 3955 "must call buildLookups first"); 3956 3957 // FIXME: We need to build the lookups table, which is logically const. 3958 auto *DC = const_cast<DeclContext*>(ConstDC); 3959 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table"); 3960 3961 // Create the on-disk hash table representation. 3962 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait, 3963 ASTDeclContextNameLookupTrait> Generator; 3964 ASTDeclContextNameLookupTrait Trait(*this); 3965 3966 // The first step is to collect the declaration names which we need to 3967 // serialize into the name lookup table, and to collect them in a stable 3968 // order. 3969 SmallVector<DeclarationName, 16> Names; 3970 3971 // We also build up small sets of the constructor and conversion function 3972 // names which are visible. 3973 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet; 3974 3975 for (auto &Lookup : *DC->buildLookup()) { 3976 auto &Name = Lookup.first; 3977 auto &Result = Lookup.second; 3978 3979 // If there are no local declarations in our lookup result, we 3980 // don't need to write an entry for the name at all. If we can't 3981 // write out a lookup set without performing more deserialization, 3982 // just skip this entry. 3983 if (isLookupResultExternal(Result, DC) && 3984 isLookupResultEntirelyExternal(Result, DC)) 3985 continue; 3986 3987 // We also skip empty results. If any of the results could be external and 3988 // the currently available results are empty, then all of the results are 3989 // external and we skip it above. So the only way we get here with an empty 3990 // results is when no results could have been external *and* we have 3991 // external results. 3992 // 3993 // FIXME: While we might want to start emitting on-disk entries for negative 3994 // lookups into a decl context as an optimization, today we *have* to skip 3995 // them because there are names with empty lookup results in decl contexts 3996 // which we can't emit in any stable ordering: we lookup constructors and 3997 // conversion functions in the enclosing namespace scope creating empty 3998 // results for them. This in almost certainly a bug in Clang's name lookup, 3999 // but that is likely to be hard or impossible to fix and so we tolerate it 4000 // here by omitting lookups with empty results. 4001 if (Lookup.second.getLookupResult().empty()) 4002 continue; 4003 4004 switch (Lookup.first.getNameKind()) { 4005 default: 4006 Names.push_back(Lookup.first); 4007 break; 4008 4009 case DeclarationName::CXXConstructorName: 4010 assert(isa<CXXRecordDecl>(DC) && 4011 "Cannot have a constructor name outside of a class!"); 4012 ConstructorNameSet.insert(Name); 4013 break; 4014 4015 case DeclarationName::CXXConversionFunctionName: 4016 assert(isa<CXXRecordDecl>(DC) && 4017 "Cannot have a conversion function name outside of a class!"); 4018 ConversionNameSet.insert(Name); 4019 break; 4020 } 4021 } 4022 4023 // Sort the names into a stable order. 4024 llvm::sort(Names.begin(), Names.end()); 4025 4026 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) { 4027 // We need to establish an ordering of constructor and conversion function 4028 // names, and they don't have an intrinsic ordering. 4029 4030 // First we try the easy case by forming the current context's constructor 4031 // name and adding that name first. This is a very useful optimization to 4032 // avoid walking the lexical declarations in many cases, and it also 4033 // handles the only case where a constructor name can come from some other 4034 // lexical context -- when that name is an implicit constructor merged from 4035 // another declaration in the redecl chain. Any non-implicit constructor or 4036 // conversion function which doesn't occur in all the lexical contexts 4037 // would be an ODR violation. 4038 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName( 4039 Context->getCanonicalType(Context->getRecordType(D))); 4040 if (ConstructorNameSet.erase(ImplicitCtorName)) 4041 Names.push_back(ImplicitCtorName); 4042 4043 // If we still have constructors or conversion functions, we walk all the 4044 // names in the decl and add the constructors and conversion functions 4045 // which are visible in the order they lexically occur within the context. 4046 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty()) 4047 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls()) 4048 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) { 4049 auto Name = ChildND->getDeclName(); 4050 switch (Name.getNameKind()) { 4051 default: 4052 continue; 4053 4054 case DeclarationName::CXXConstructorName: 4055 if (ConstructorNameSet.erase(Name)) 4056 Names.push_back(Name); 4057 break; 4058 4059 case DeclarationName::CXXConversionFunctionName: 4060 if (ConversionNameSet.erase(Name)) 4061 Names.push_back(Name); 4062 break; 4063 } 4064 4065 if (ConstructorNameSet.empty() && ConversionNameSet.empty()) 4066 break; 4067 } 4068 4069 assert(ConstructorNameSet.empty() && "Failed to find all of the visible " 4070 "constructors by walking all the " 4071 "lexical members of the context."); 4072 assert(ConversionNameSet.empty() && "Failed to find all of the visible " 4073 "conversion functions by walking all " 4074 "the lexical members of the context."); 4075 } 4076 4077 // Next we need to do a lookup with each name into this decl context to fully 4078 // populate any results from external sources. We don't actually use the 4079 // results of these lookups because we only want to use the results after all 4080 // results have been loaded and the pointers into them will be stable. 4081 for (auto &Name : Names) 4082 DC->lookup(Name); 4083 4084 // Now we need to insert the results for each name into the hash table. For 4085 // constructor names and conversion function names, we actually need to merge 4086 // all of the results for them into one list of results each and insert 4087 // those. 4088 SmallVector<NamedDecl *, 8> ConstructorDecls; 4089 SmallVector<NamedDecl *, 8> ConversionDecls; 4090 4091 // Now loop over the names, either inserting them or appending for the two 4092 // special cases. 4093 for (auto &Name : Names) { 4094 DeclContext::lookup_result Result = DC->noload_lookup(Name); 4095 4096 switch (Name.getNameKind()) { 4097 default: 4098 Generator.insert(Name, Trait.getData(Result), Trait); 4099 break; 4100 4101 case DeclarationName::CXXConstructorName: 4102 ConstructorDecls.append(Result.begin(), Result.end()); 4103 break; 4104 4105 case DeclarationName::CXXConversionFunctionName: 4106 ConversionDecls.append(Result.begin(), Result.end()); 4107 break; 4108 } 4109 } 4110 4111 // Handle our two special cases if we ended up having any. We arbitrarily use 4112 // the first declaration's name here because the name itself isn't part of 4113 // the key, only the kind of name is used. 4114 if (!ConstructorDecls.empty()) 4115 Generator.insert(ConstructorDecls.front()->getDeclName(), 4116 Trait.getData(ConstructorDecls), Trait); 4117 if (!ConversionDecls.empty()) 4118 Generator.insert(ConversionDecls.front()->getDeclName(), 4119 Trait.getData(ConversionDecls), Trait); 4120 4121 // Create the on-disk hash table. Also emit the existing imported and 4122 // merged table if there is one. 4123 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr; 4124 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr); 4125 } 4126 4127 /// \brief Write the block containing all of the declaration IDs 4128 /// visible from the given DeclContext. 4129 /// 4130 /// \returns the offset of the DECL_CONTEXT_VISIBLE block within the 4131 /// bitstream, or 0 if no block was written. 4132 uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context, 4133 DeclContext *DC) { 4134 // If we imported a key declaration of this namespace, write the visible 4135 // lookup results as an update record for it rather than including them 4136 // on this declaration. We will only look at key declarations on reload. 4137 if (isa<NamespaceDecl>(DC) && Chain && 4138 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) { 4139 // Only do this once, for the first local declaration of the namespace. 4140 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev; 4141 Prev = Prev->getPreviousDecl()) 4142 if (!Prev->isFromASTFile()) 4143 return 0; 4144 4145 // Note that we need to emit an update record for the primary context. 4146 UpdatedDeclContexts.insert(DC->getPrimaryContext()); 4147 4148 // Make sure all visible decls are written. They will be recorded later. We 4149 // do this using a side data structure so we can sort the names into 4150 // a deterministic order. 4151 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup(); 4152 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16> 4153 LookupResults; 4154 if (Map) { 4155 LookupResults.reserve(Map->size()); 4156 for (auto &Entry : *Map) 4157 LookupResults.push_back( 4158 std::make_pair(Entry.first, Entry.second.getLookupResult())); 4159 } 4160 4161 llvm::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first()); 4162 for (auto &NameAndResult : LookupResults) { 4163 DeclarationName Name = NameAndResult.first; 4164 DeclContext::lookup_result Result = NameAndResult.second; 4165 if (Name.getNameKind() == DeclarationName::CXXConstructorName || 4166 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) { 4167 // We have to work around a name lookup bug here where negative lookup 4168 // results for these names get cached in namespace lookup tables (these 4169 // names should never be looked up in a namespace). 4170 assert(Result.empty() && "Cannot have a constructor or conversion " 4171 "function name in a namespace!"); 4172 continue; 4173 } 4174 4175 for (NamedDecl *ND : Result) 4176 if (!ND->isFromASTFile()) 4177 GetDeclRef(ND); 4178 } 4179 4180 return 0; 4181 } 4182 4183 if (DC->getPrimaryContext() != DC) 4184 return 0; 4185 4186 // Skip contexts which don't support name lookup. 4187 if (!DC->isLookupContext()) 4188 return 0; 4189 4190 // If not in C++, we perform name lookup for the translation unit via the 4191 // IdentifierInfo chains, don't bother to build a visible-declarations table. 4192 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus) 4193 return 0; 4194 4195 // Serialize the contents of the mapping used for lookup. Note that, 4196 // although we have two very different code paths, the serialized 4197 // representation is the same for both cases: a declaration name, 4198 // followed by a size, followed by references to the visible 4199 // declarations that have that name. 4200 uint64_t Offset = Stream.GetCurrentBitNo(); 4201 StoredDeclsMap *Map = DC->buildLookup(); 4202 if (!Map || Map->empty()) 4203 return 0; 4204 4205 // Create the on-disk hash table in a buffer. 4206 SmallString<4096> LookupTable; 4207 GenerateNameLookupTable(DC, LookupTable); 4208 4209 // Write the lookup table 4210 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE}; 4211 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record, 4212 LookupTable); 4213 ++NumVisibleDeclContexts; 4214 return Offset; 4215 } 4216 4217 /// \brief Write an UPDATE_VISIBLE block for the given context. 4218 /// 4219 /// UPDATE_VISIBLE blocks contain the declarations that are added to an existing 4220 /// DeclContext in a dependent AST file. As such, they only exist for the TU 4221 /// (in C++), for namespaces, and for classes with forward-declared unscoped 4222 /// enumeration members (in C++11). 4223 void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) { 4224 StoredDeclsMap *Map = DC->getLookupPtr(); 4225 if (!Map || Map->empty()) 4226 return; 4227 4228 // Create the on-disk hash table in a buffer. 4229 SmallString<4096> LookupTable; 4230 GenerateNameLookupTable(DC, LookupTable); 4231 4232 // If we're updating a namespace, select a key declaration as the key for the 4233 // update record; those are the only ones that will be checked on reload. 4234 if (isa<NamespaceDecl>(DC)) 4235 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC))); 4236 4237 // Write the lookup table 4238 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))}; 4239 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable); 4240 } 4241 4242 /// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions. 4243 void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) { 4244 RecordData::value_type Record[] = {Opts.getInt()}; 4245 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record); 4246 } 4247 4248 /// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions. 4249 void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) { 4250 if (!SemaRef.Context.getLangOpts().OpenCL) 4251 return; 4252 4253 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions(); 4254 RecordData Record; 4255 for (const auto &I:Opts.OptMap) { 4256 AddString(I.getKey(), Record); 4257 auto V = I.getValue(); 4258 Record.push_back(V.Supported ? 1 : 0); 4259 Record.push_back(V.Enabled ? 1 : 0); 4260 Record.push_back(V.Avail); 4261 Record.push_back(V.Core); 4262 } 4263 Stream.EmitRecord(OPENCL_EXTENSIONS, Record); 4264 } 4265 4266 void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) { 4267 if (!SemaRef.Context.getLangOpts().OpenCL) 4268 return; 4269 4270 RecordData Record; 4271 for (const auto &I : SemaRef.OpenCLTypeExtMap) { 4272 Record.push_back( 4273 static_cast<unsigned>(getTypeID(I.first->getCanonicalTypeInternal()))); 4274 Record.push_back(I.second.size()); 4275 for (auto Ext : I.second) 4276 AddString(Ext, Record); 4277 } 4278 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record); 4279 } 4280 4281 void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) { 4282 if (!SemaRef.Context.getLangOpts().OpenCL) 4283 return; 4284 4285 RecordData Record; 4286 for (const auto &I : SemaRef.OpenCLDeclExtMap) { 4287 Record.push_back(getDeclID(I.first)); 4288 Record.push_back(static_cast<unsigned>(I.second.size())); 4289 for (auto Ext : I.second) 4290 AddString(Ext, Record); 4291 } 4292 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record); 4293 } 4294 4295 void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) { 4296 if (SemaRef.ForceCUDAHostDeviceDepth > 0) { 4297 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth}; 4298 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record); 4299 } 4300 } 4301 4302 void ASTWriter::WriteObjCCategories() { 4303 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap; 4304 RecordData Categories; 4305 4306 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) { 4307 unsigned Size = 0; 4308 unsigned StartIndex = Categories.size(); 4309 4310 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I]; 4311 4312 // Allocate space for the size. 4313 Categories.push_back(0); 4314 4315 // Add the categories. 4316 for (ObjCInterfaceDecl::known_categories_iterator 4317 Cat = Class->known_categories_begin(), 4318 CatEnd = Class->known_categories_end(); 4319 Cat != CatEnd; ++Cat, ++Size) { 4320 assert(getDeclID(*Cat) != 0 && "Bogus category"); 4321 AddDeclRef(*Cat, Categories); 4322 } 4323 4324 // Update the size. 4325 Categories[StartIndex] = Size; 4326 4327 // Record this interface -> category map. 4328 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex }; 4329 CategoriesMap.push_back(CatInfo); 4330 } 4331 4332 // Sort the categories map by the definition ID, since the reader will be 4333 // performing binary searches on this information. 4334 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end()); 4335 4336 // Emit the categories map. 4337 using namespace llvm; 4338 4339 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 4340 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP)); 4341 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries 4342 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 4343 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev)); 4344 4345 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()}; 4346 Stream.EmitRecordWithBlob(AbbrevID, Record, 4347 reinterpret_cast<char *>(CategoriesMap.data()), 4348 CategoriesMap.size() * sizeof(ObjCCategoriesInfo)); 4349 4350 // Emit the category lists. 4351 Stream.EmitRecord(OBJC_CATEGORIES, Categories); 4352 } 4353 4354 void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) { 4355 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap; 4356 4357 if (LPTMap.empty()) 4358 return; 4359 4360 RecordData Record; 4361 for (auto &LPTMapEntry : LPTMap) { 4362 const FunctionDecl *FD = LPTMapEntry.first; 4363 LateParsedTemplate &LPT = *LPTMapEntry.second; 4364 AddDeclRef(FD, Record); 4365 AddDeclRef(LPT.D, Record); 4366 Record.push_back(LPT.Toks.size()); 4367 4368 for (const auto &Tok : LPT.Toks) { 4369 AddToken(Tok, Record); 4370 } 4371 } 4372 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record); 4373 } 4374 4375 /// \brief Write the state of 'pragma clang optimize' at the end of the module. 4376 void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) { 4377 RecordData Record; 4378 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation(); 4379 AddSourceLocation(PragmaLoc, Record); 4380 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record); 4381 } 4382 4383 /// \brief Write the state of 'pragma ms_struct' at the end of the module. 4384 void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) { 4385 RecordData Record; 4386 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF); 4387 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record); 4388 } 4389 4390 /// \brief Write the state of 'pragma pointers_to_members' at the end of the 4391 //module. 4392 void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) { 4393 RecordData Record; 4394 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod); 4395 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record); 4396 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record); 4397 } 4398 4399 /// \brief Write the state of 'pragma pack' at the end of the module. 4400 void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) { 4401 // Don't serialize pragma pack state for modules, since it should only take 4402 // effect on a per-submodule basis. 4403 if (WritingModule) 4404 return; 4405 4406 RecordData Record; 4407 Record.push_back(SemaRef.PackStack.CurrentValue); 4408 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record); 4409 Record.push_back(SemaRef.PackStack.Stack.size()); 4410 for (const auto &StackEntry : SemaRef.PackStack.Stack) { 4411 Record.push_back(StackEntry.Value); 4412 AddSourceLocation(StackEntry.PragmaLocation, Record); 4413 AddSourceLocation(StackEntry.PragmaPushLocation, Record); 4414 AddString(StackEntry.StackSlotLabel, Record); 4415 } 4416 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record); 4417 } 4418 4419 void ASTWriter::WriteModuleFileExtension(Sema &SemaRef, 4420 ModuleFileExtensionWriter &Writer) { 4421 // Enter the extension block. 4422 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4); 4423 4424 // Emit the metadata record abbreviation. 4425 auto Abv = std::make_shared<llvm::BitCodeAbbrev>(); 4426 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA)); 4427 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6)); 4428 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6)); 4429 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6)); 4430 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6)); 4431 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)); 4432 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv)); 4433 4434 // Emit the metadata record. 4435 RecordData Record; 4436 auto Metadata = Writer.getExtension()->getExtensionMetadata(); 4437 Record.push_back(EXTENSION_METADATA); 4438 Record.push_back(Metadata.MajorVersion); 4439 Record.push_back(Metadata.MinorVersion); 4440 Record.push_back(Metadata.BlockName.size()); 4441 Record.push_back(Metadata.UserInfo.size()); 4442 SmallString<64> Buffer; 4443 Buffer += Metadata.BlockName; 4444 Buffer += Metadata.UserInfo; 4445 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer); 4446 4447 // Emit the contents of the extension block. 4448 Writer.writeExtensionContents(SemaRef, Stream); 4449 4450 // Exit the extension block. 4451 Stream.ExitBlock(); 4452 } 4453 4454 //===----------------------------------------------------------------------===// 4455 // General Serialization Routines 4456 //===----------------------------------------------------------------------===// 4457 4458 /// \brief Emit the list of attributes to the specified record. 4459 void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) { 4460 auto &Record = *this; 4461 Record.push_back(Attrs.size()); 4462 for (const auto *A : Attrs) { 4463 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs 4464 Record.AddSourceRange(A->getRange()); 4465 4466 #include "clang/Serialization/AttrPCHWrite.inc" 4467 } 4468 } 4469 4470 void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) { 4471 AddSourceLocation(Tok.getLocation(), Record); 4472 Record.push_back(Tok.getLength()); 4473 4474 // FIXME: When reading literal tokens, reconstruct the literal pointer 4475 // if it is needed. 4476 AddIdentifierRef(Tok.getIdentifierInfo(), Record); 4477 // FIXME: Should translate token kind to a stable encoding. 4478 Record.push_back(Tok.getKind()); 4479 // FIXME: Should translate token flags to a stable encoding. 4480 Record.push_back(Tok.getFlags()); 4481 } 4482 4483 void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) { 4484 Record.push_back(Str.size()); 4485 Record.insert(Record.end(), Str.begin(), Str.end()); 4486 } 4487 4488 bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) { 4489 assert(Context && "should have context when outputting path"); 4490 4491 bool Changed = 4492 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path); 4493 4494 // Remove a prefix to make the path relative, if relevant. 4495 const char *PathBegin = Path.data(); 4496 const char *PathPtr = 4497 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory); 4498 if (PathPtr != PathBegin) { 4499 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin)); 4500 Changed = true; 4501 } 4502 4503 return Changed; 4504 } 4505 4506 void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) { 4507 SmallString<128> FilePath(Path); 4508 PreparePathForOutput(FilePath); 4509 AddString(FilePath, Record); 4510 } 4511 4512 void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record, 4513 StringRef Path) { 4514 SmallString<128> FilePath(Path); 4515 PreparePathForOutput(FilePath); 4516 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath); 4517 } 4518 4519 void ASTWriter::AddVersionTuple(const VersionTuple &Version, 4520 RecordDataImpl &Record) { 4521 Record.push_back(Version.getMajor()); 4522 if (Optional<unsigned> Minor = Version.getMinor()) 4523 Record.push_back(*Minor + 1); 4524 else 4525 Record.push_back(0); 4526 if (Optional<unsigned> Subminor = Version.getSubminor()) 4527 Record.push_back(*Subminor + 1); 4528 else 4529 Record.push_back(0); 4530 } 4531 4532 /// \brief Note that the identifier II occurs at the given offset 4533 /// within the identifier table. 4534 void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) { 4535 IdentID ID = IdentifierIDs[II]; 4536 // Only store offsets new to this AST file. Other identifier names are looked 4537 // up earlier in the chain and thus don't need an offset. 4538 if (ID >= FirstIdentID) 4539 IdentifierOffsets[ID - FirstIdentID] = Offset; 4540 } 4541 4542 /// \brief Note that the selector Sel occurs at the given offset 4543 /// within the method pool/selector table. 4544 void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) { 4545 unsigned ID = SelectorIDs[Sel]; 4546 assert(ID && "Unknown selector"); 4547 // Don't record offsets for selectors that are also available in a different 4548 // file. 4549 if (ID < FirstSelectorID) 4550 return; 4551 SelectorOffsets[ID - FirstSelectorID] = Offset; 4552 } 4553 4554 ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream, 4555 SmallVectorImpl<char> &Buffer, MemoryBufferCache &PCMCache, 4556 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions, 4557 bool IncludeTimestamps) 4558 : Stream(Stream), Buffer(Buffer), PCMCache(PCMCache), 4559 IncludeTimestamps(IncludeTimestamps) { 4560 for (const auto &Ext : Extensions) { 4561 if (auto Writer = Ext->createExtensionWriter(*this)) 4562 ModuleFileExtensionWriters.push_back(std::move(Writer)); 4563 } 4564 } 4565 4566 ASTWriter::~ASTWriter() { 4567 llvm::DeleteContainerSeconds(FileDeclIDs); 4568 } 4569 4570 const LangOptions &ASTWriter::getLangOpts() const { 4571 assert(WritingAST && "can't determine lang opts when not writing AST"); 4572 return Context->getLangOpts(); 4573 } 4574 4575 time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const { 4576 return IncludeTimestamps ? E->getModificationTime() : 0; 4577 } 4578 4579 ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef, 4580 const std::string &OutputFile, 4581 Module *WritingModule, StringRef isysroot, 4582 bool hasErrors) { 4583 WritingAST = true; 4584 4585 ASTHasCompilerErrors = hasErrors; 4586 4587 // Emit the file header. 4588 Stream.Emit((unsigned)'C', 8); 4589 Stream.Emit((unsigned)'P', 8); 4590 Stream.Emit((unsigned)'C', 8); 4591 Stream.Emit((unsigned)'H', 8); 4592 4593 WriteBlockInfoBlock(); 4594 4595 Context = &SemaRef.Context; 4596 PP = &SemaRef.PP; 4597 this->WritingModule = WritingModule; 4598 ASTFileSignature Signature = 4599 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule); 4600 Context = nullptr; 4601 PP = nullptr; 4602 this->WritingModule = nullptr; 4603 this->BaseDirectory.clear(); 4604 4605 WritingAST = false; 4606 if (SemaRef.Context.getLangOpts().ImplicitModules && WritingModule) { 4607 // Construct MemoryBuffer and update buffer manager. 4608 PCMCache.addBuffer(OutputFile, 4609 llvm::MemoryBuffer::getMemBufferCopy( 4610 StringRef(Buffer.begin(), Buffer.size()))); 4611 } 4612 return Signature; 4613 } 4614 4615 template<typename Vector> 4616 static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec, 4617 ASTWriter::RecordData &Record) { 4618 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end(); 4619 I != E; ++I) { 4620 Writer.AddDeclRef(*I, Record); 4621 } 4622 } 4623 4624 ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot, 4625 const std::string &OutputFile, 4626 Module *WritingModule) { 4627 using namespace llvm; 4628 4629 bool isModule = WritingModule != nullptr; 4630 4631 // Make sure that the AST reader knows to finalize itself. 4632 if (Chain) 4633 Chain->finalizeForWriting(); 4634 4635 ASTContext &Context = SemaRef.Context; 4636 Preprocessor &PP = SemaRef.PP; 4637 4638 // Set up predefined declaration IDs. 4639 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) { 4640 if (D) { 4641 assert(D->isCanonicalDecl() && "predefined decl is not canonical"); 4642 DeclIDs[D] = ID; 4643 } 4644 }; 4645 RegisterPredefDecl(Context.getTranslationUnitDecl(), 4646 PREDEF_DECL_TRANSLATION_UNIT_ID); 4647 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID); 4648 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID); 4649 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID); 4650 RegisterPredefDecl(Context.ObjCProtocolClassDecl, 4651 PREDEF_DECL_OBJC_PROTOCOL_ID); 4652 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID); 4653 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID); 4654 RegisterPredefDecl(Context.ObjCInstanceTypeDecl, 4655 PREDEF_DECL_OBJC_INSTANCETYPE_ID); 4656 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID); 4657 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG); 4658 RegisterPredefDecl(Context.BuiltinMSVaListDecl, 4659 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID); 4660 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID); 4661 RegisterPredefDecl(Context.MakeIntegerSeqDecl, 4662 PREDEF_DECL_MAKE_INTEGER_SEQ_ID); 4663 RegisterPredefDecl(Context.CFConstantStringTypeDecl, 4664 PREDEF_DECL_CF_CONSTANT_STRING_ID); 4665 RegisterPredefDecl(Context.CFConstantStringTagDecl, 4666 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID); 4667 RegisterPredefDecl(Context.TypePackElementDecl, 4668 PREDEF_DECL_TYPE_PACK_ELEMENT_ID); 4669 4670 // Build a record containing all of the tentative definitions in this file, in 4671 // TentativeDefinitions order. Generally, this record will be empty for 4672 // headers. 4673 RecordData TentativeDefinitions; 4674 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions); 4675 4676 // Build a record containing all of the file scoped decls in this file. 4677 RecordData UnusedFileScopedDecls; 4678 if (!isModule) 4679 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls, 4680 UnusedFileScopedDecls); 4681 4682 // Build a record containing all of the delegating constructors we still need 4683 // to resolve. 4684 RecordData DelegatingCtorDecls; 4685 if (!isModule) 4686 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls); 4687 4688 // Write the set of weak, undeclared identifiers. We always write the 4689 // entire table, since later PCH files in a PCH chain are only interested in 4690 // the results at the end of the chain. 4691 RecordData WeakUndeclaredIdentifiers; 4692 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) { 4693 IdentifierInfo *II = WeakUndeclaredIdentifier.first; 4694 WeakInfo &WI = WeakUndeclaredIdentifier.second; 4695 AddIdentifierRef(II, WeakUndeclaredIdentifiers); 4696 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers); 4697 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers); 4698 WeakUndeclaredIdentifiers.push_back(WI.getUsed()); 4699 } 4700 4701 // Build a record containing all of the ext_vector declarations. 4702 RecordData ExtVectorDecls; 4703 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls); 4704 4705 // Build a record containing all of the VTable uses information. 4706 RecordData VTableUses; 4707 if (!SemaRef.VTableUses.empty()) { 4708 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) { 4709 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses); 4710 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses); 4711 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]); 4712 } 4713 } 4714 4715 // Build a record containing all of the UnusedLocalTypedefNameCandidates. 4716 RecordData UnusedLocalTypedefNameCandidates; 4717 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates) 4718 AddDeclRef(TD, UnusedLocalTypedefNameCandidates); 4719 4720 // Build a record containing all of pending implicit instantiations. 4721 RecordData PendingInstantiations; 4722 for (const auto &I : SemaRef.PendingInstantiations) { 4723 AddDeclRef(I.first, PendingInstantiations); 4724 AddSourceLocation(I.second, PendingInstantiations); 4725 } 4726 assert(SemaRef.PendingLocalImplicitInstantiations.empty() && 4727 "There are local ones at end of translation unit!"); 4728 4729 // Build a record containing some declaration references. 4730 RecordData SemaDeclRefs; 4731 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) { 4732 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs); 4733 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs); 4734 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs); 4735 } 4736 4737 RecordData CUDASpecialDeclRefs; 4738 if (Context.getcudaConfigureCallDecl()) { 4739 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs); 4740 } 4741 4742 // Build a record containing all of the known namespaces. 4743 RecordData KnownNamespaces; 4744 for (const auto &I : SemaRef.KnownNamespaces) { 4745 if (!I.second) 4746 AddDeclRef(I.first, KnownNamespaces); 4747 } 4748 4749 // Build a record of all used, undefined objects that require definitions. 4750 RecordData UndefinedButUsed; 4751 4752 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined; 4753 SemaRef.getUndefinedButUsed(Undefined); 4754 for (const auto &I : Undefined) { 4755 AddDeclRef(I.first, UndefinedButUsed); 4756 AddSourceLocation(I.second, UndefinedButUsed); 4757 } 4758 4759 // Build a record containing all delete-expressions that we would like to 4760 // analyze later in AST. 4761 RecordData DeleteExprsToAnalyze; 4762 4763 for (const auto &DeleteExprsInfo : 4764 SemaRef.getMismatchingDeleteExpressions()) { 4765 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze); 4766 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size()); 4767 for (const auto &DeleteLoc : DeleteExprsInfo.second) { 4768 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze); 4769 DeleteExprsToAnalyze.push_back(DeleteLoc.second); 4770 } 4771 } 4772 4773 // Write the control block 4774 WriteControlBlock(PP, Context, isysroot, OutputFile); 4775 4776 // Write the remaining AST contents. 4777 Stream.EnterSubblock(AST_BLOCK_ID, 5); 4778 4779 // This is so that older clang versions, before the introduction 4780 // of the control block, can read and reject the newer PCH format. 4781 { 4782 RecordData Record = {VERSION_MAJOR}; 4783 Stream.EmitRecord(METADATA_OLD_FORMAT, Record); 4784 } 4785 4786 // Create a lexical update block containing all of the declarations in the 4787 // translation unit that do not come from other AST files. 4788 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl(); 4789 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs; 4790 for (const auto *D : TU->noload_decls()) { 4791 if (!D->isFromASTFile()) { 4792 NewGlobalKindDeclPairs.push_back(D->getKind()); 4793 NewGlobalKindDeclPairs.push_back(GetDeclRef(D)); 4794 } 4795 } 4796 4797 auto Abv = std::make_shared<BitCodeAbbrev>(); 4798 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL)); 4799 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)); 4800 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv)); 4801 { 4802 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL}; 4803 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record, 4804 bytes(NewGlobalKindDeclPairs)); 4805 } 4806 4807 // And a visible updates block for the translation unit. 4808 Abv = std::make_shared<BitCodeAbbrev>(); 4809 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE)); 4810 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6)); 4811 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)); 4812 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv)); 4813 WriteDeclContextVisibleUpdate(TU); 4814 4815 // If we have any extern "C" names, write out a visible update for them. 4816 if (Context.ExternCContext) 4817 WriteDeclContextVisibleUpdate(Context.ExternCContext); 4818 4819 // If the translation unit has an anonymous namespace, and we don't already 4820 // have an update block for it, write it as an update block. 4821 // FIXME: Why do we not do this if there's already an update block? 4822 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) { 4823 ASTWriter::UpdateRecord &Record = DeclUpdates[TU]; 4824 if (Record.empty()) 4825 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS)); 4826 } 4827 4828 // Add update records for all mangling numbers and static local numbers. 4829 // These aren't really update records, but this is a convenient way of 4830 // tagging this rare extra data onto the declarations. 4831 for (const auto &Number : Context.MangleNumbers) 4832 if (!Number.first->isFromASTFile()) 4833 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER, 4834 Number.second)); 4835 for (const auto &Number : Context.StaticLocalNumbers) 4836 if (!Number.first->isFromASTFile()) 4837 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER, 4838 Number.second)); 4839 4840 // Make sure visible decls, added to DeclContexts previously loaded from 4841 // an AST file, are registered for serialization. Likewise for template 4842 // specializations added to imported templates. 4843 for (const auto *I : DeclsToEmitEvenIfUnreferenced) { 4844 GetDeclRef(I); 4845 } 4846 4847 // Make sure all decls associated with an identifier are registered for 4848 // serialization, if we're storing decls with identifiers. 4849 if (!WritingModule || !getLangOpts().CPlusPlus) { 4850 llvm::SmallVector<const IdentifierInfo*, 256> IIs; 4851 for (const auto &ID : PP.getIdentifierTable()) { 4852 const IdentifierInfo *II = ID.second; 4853 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization()) 4854 IIs.push_back(II); 4855 } 4856 // Sort the identifiers to visit based on their name. 4857 llvm::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>()); 4858 for (const IdentifierInfo *II : IIs) { 4859 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II), 4860 DEnd = SemaRef.IdResolver.end(); 4861 D != DEnd; ++D) { 4862 GetDeclRef(*D); 4863 } 4864 } 4865 } 4866 4867 // For method pool in the module, if it contains an entry for a selector, 4868 // the entry should be complete, containing everything introduced by that 4869 // module and all modules it imports. It's possible that the entry is out of 4870 // date, so we need to pull in the new content here. 4871 4872 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be 4873 // safe, we copy all selectors out. 4874 llvm::SmallVector<Selector, 256> AllSelectors; 4875 for (auto &SelectorAndID : SelectorIDs) 4876 AllSelectors.push_back(SelectorAndID.first); 4877 for (auto &Selector : AllSelectors) 4878 SemaRef.updateOutOfDateSelector(Selector); 4879 4880 // Form the record of special types. 4881 RecordData SpecialTypes; 4882 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes); 4883 AddTypeRef(Context.getFILEType(), SpecialTypes); 4884 AddTypeRef(Context.getjmp_bufType(), SpecialTypes); 4885 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes); 4886 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes); 4887 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes); 4888 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes); 4889 AddTypeRef(Context.getucontext_tType(), SpecialTypes); 4890 4891 if (Chain) { 4892 // Write the mapping information describing our module dependencies and how 4893 // each of those modules were mapped into our own offset/ID space, so that 4894 // the reader can build the appropriate mapping to its own offset/ID space. 4895 // The map consists solely of a blob with the following format: 4896 // *(module-kind:i8 4897 // module-name-len:i16 module-name:len*i8 4898 // source-location-offset:i32 4899 // identifier-id:i32 4900 // preprocessed-entity-id:i32 4901 // macro-definition-id:i32 4902 // submodule-id:i32 4903 // selector-id:i32 4904 // declaration-id:i32 4905 // c++-base-specifiers-id:i32 4906 // type-id:i32) 4907 // 4908 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or 4909 // MK_ExplicitModule, then the module-name is the module name. Otherwise, 4910 // it is the module file name. 4911 auto Abbrev = std::make_shared<BitCodeAbbrev>(); 4912 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP)); 4913 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 4914 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev)); 4915 SmallString<2048> Buffer; 4916 { 4917 llvm::raw_svector_ostream Out(Buffer); 4918 for (ModuleFile &M : Chain->ModuleMgr) { 4919 using namespace llvm::support; 4920 4921 endian::Writer<little> LE(Out); 4922 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind)); 4923 StringRef Name = 4924 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule 4925 ? M.ModuleName 4926 : M.FileName; 4927 LE.write<uint16_t>(Name.size()); 4928 Out.write(Name.data(), Name.size()); 4929 4930 // Note: if a base ID was uint max, it would not be possible to load 4931 // another module after it or have more than one entity inside it. 4932 uint32_t None = std::numeric_limits<uint32_t>::max(); 4933 4934 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) { 4935 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high"); 4936 if (ShouldWrite) 4937 LE.write<uint32_t>(BaseID); 4938 else 4939 LE.write<uint32_t>(None); 4940 }; 4941 4942 // These values should be unique within a chain, since they will be read 4943 // as keys into ContinuousRangeMaps. 4944 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries); 4945 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers); 4946 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros); 4947 writeBaseIDOrNone(M.BasePreprocessedEntityID, 4948 M.NumPreprocessedEntities); 4949 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules); 4950 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors); 4951 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls); 4952 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes); 4953 } 4954 } 4955 RecordData::value_type Record[] = {MODULE_OFFSET_MAP}; 4956 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record, 4957 Buffer.data(), Buffer.size()); 4958 } 4959 4960 RecordData DeclUpdatesOffsetsRecord; 4961 4962 // Keep writing types, declarations, and declaration update records 4963 // until we've emitted all of them. 4964 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5); 4965 WriteTypeAbbrevs(); 4966 WriteDeclAbbrevs(); 4967 do { 4968 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord); 4969 while (!DeclTypesToEmit.empty()) { 4970 DeclOrType DOT = DeclTypesToEmit.front(); 4971 DeclTypesToEmit.pop(); 4972 if (DOT.isType()) 4973 WriteType(DOT.getType()); 4974 else 4975 WriteDecl(Context, DOT.getDecl()); 4976 } 4977 } while (!DeclUpdates.empty()); 4978 Stream.ExitBlock(); 4979 4980 DoneWritingDeclsAndTypes = true; 4981 4982 // These things can only be done once we've written out decls and types. 4983 WriteTypeDeclOffsets(); 4984 if (!DeclUpdatesOffsetsRecord.empty()) 4985 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord); 4986 WriteFileDeclIDsMap(); 4987 WriteSourceManagerBlock(Context.getSourceManager(), PP); 4988 WriteComments(); 4989 WritePreprocessor(PP, isModule); 4990 WriteHeaderSearch(PP.getHeaderSearchInfo()); 4991 WriteSelectors(SemaRef); 4992 WriteReferencedSelectorsPool(SemaRef); 4993 WriteLateParsedTemplates(SemaRef); 4994 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule); 4995 WriteFPPragmaOptions(SemaRef.getFPOptions()); 4996 WriteOpenCLExtensions(SemaRef); 4997 WriteOpenCLExtensionTypes(SemaRef); 4998 WriteOpenCLExtensionDecls(SemaRef); 4999 WriteCUDAPragmas(SemaRef); 5000 5001 // If we're emitting a module, write out the submodule information. 5002 if (WritingModule) 5003 WriteSubmodules(WritingModule); 5004 5005 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes); 5006 5007 // Write the record containing external, unnamed definitions. 5008 if (!EagerlyDeserializedDecls.empty()) 5009 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls); 5010 5011 if (!ModularCodegenDecls.empty()) 5012 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls); 5013 5014 // Write the record containing tentative definitions. 5015 if (!TentativeDefinitions.empty()) 5016 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions); 5017 5018 // Write the record containing unused file scoped decls. 5019 if (!UnusedFileScopedDecls.empty()) 5020 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls); 5021 5022 // Write the record containing weak undeclared identifiers. 5023 if (!WeakUndeclaredIdentifiers.empty()) 5024 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS, 5025 WeakUndeclaredIdentifiers); 5026 5027 // Write the record containing ext_vector type names. 5028 if (!ExtVectorDecls.empty()) 5029 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls); 5030 5031 // Write the record containing VTable uses information. 5032 if (!VTableUses.empty()) 5033 Stream.EmitRecord(VTABLE_USES, VTableUses); 5034 5035 // Write the record containing potentially unused local typedefs. 5036 if (!UnusedLocalTypedefNameCandidates.empty()) 5037 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES, 5038 UnusedLocalTypedefNameCandidates); 5039 5040 // Write the record containing pending implicit instantiations. 5041 if (!PendingInstantiations.empty()) 5042 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations); 5043 5044 // Write the record containing declaration references of Sema. 5045 if (!SemaDeclRefs.empty()) 5046 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs); 5047 5048 // Write the record containing CUDA-specific declaration references. 5049 if (!CUDASpecialDeclRefs.empty()) 5050 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs); 5051 5052 // Write the delegating constructors. 5053 if (!DelegatingCtorDecls.empty()) 5054 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls); 5055 5056 // Write the known namespaces. 5057 if (!KnownNamespaces.empty()) 5058 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces); 5059 5060 // Write the undefined internal functions and variables, and inline functions. 5061 if (!UndefinedButUsed.empty()) 5062 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed); 5063 5064 if (!DeleteExprsToAnalyze.empty()) 5065 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze); 5066 5067 // Write the visible updates to DeclContexts. 5068 for (auto *DC : UpdatedDeclContexts) 5069 WriteDeclContextVisibleUpdate(DC); 5070 5071 if (!WritingModule) { 5072 // Write the submodules that were imported, if any. 5073 struct ModuleInfo { 5074 uint64_t ID; 5075 Module *M; 5076 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {} 5077 }; 5078 llvm::SmallVector<ModuleInfo, 64> Imports; 5079 for (const auto *I : Context.local_imports()) { 5080 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end()); 5081 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()], 5082 I->getImportedModule())); 5083 } 5084 5085 if (!Imports.empty()) { 5086 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) { 5087 return A.ID < B.ID; 5088 }; 5089 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) { 5090 return A.ID == B.ID; 5091 }; 5092 5093 // Sort and deduplicate module IDs. 5094 llvm::sort(Imports.begin(), Imports.end(), Cmp); 5095 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq), 5096 Imports.end()); 5097 5098 RecordData ImportedModules; 5099 for (const auto &Import : Imports) { 5100 ImportedModules.push_back(Import.ID); 5101 // FIXME: If the module has macros imported then later has declarations 5102 // imported, this location won't be the right one as a location for the 5103 // declaration imports. 5104 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules); 5105 } 5106 5107 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules); 5108 } 5109 } 5110 5111 WriteObjCCategories(); 5112 if(!WritingModule) { 5113 WriteOptimizePragmaOptions(SemaRef); 5114 WriteMSStructPragmaOptions(SemaRef); 5115 WriteMSPointersToMembersPragmaOptions(SemaRef); 5116 } 5117 WritePackPragmaOptions(SemaRef); 5118 5119 // Some simple statistics 5120 RecordData::value_type Record[] = { 5121 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts}; 5122 Stream.EmitRecord(STATISTICS, Record); 5123 Stream.ExitBlock(); 5124 5125 // Write the module file extension blocks. 5126 for (const auto &ExtWriter : ModuleFileExtensionWriters) 5127 WriteModuleFileExtension(SemaRef, *ExtWriter); 5128 5129 return writeUnhashedControlBlock(PP, Context); 5130 } 5131 5132 void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) { 5133 if (DeclUpdates.empty()) 5134 return; 5135 5136 DeclUpdateMap LocalUpdates; 5137 LocalUpdates.swap(DeclUpdates); 5138 5139 for (auto &DeclUpdate : LocalUpdates) { 5140 const Decl *D = DeclUpdate.first; 5141 5142 bool HasUpdatedBody = false; 5143 RecordData RecordData; 5144 ASTRecordWriter Record(*this, RecordData); 5145 for (auto &Update : DeclUpdate.second) { 5146 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind(); 5147 5148 // An updated body is emitted last, so that the reader doesn't need 5149 // to skip over the lazy body to reach statements for other records. 5150 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION) 5151 HasUpdatedBody = true; 5152 else 5153 Record.push_back(Kind); 5154 5155 switch (Kind) { 5156 case UPD_CXX_ADDED_IMPLICIT_MEMBER: 5157 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION: 5158 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE: 5159 assert(Update.getDecl() && "no decl to add?"); 5160 Record.push_back(GetDeclRef(Update.getDecl())); 5161 break; 5162 5163 case UPD_CXX_ADDED_FUNCTION_DEFINITION: 5164 break; 5165 5166 case UPD_CXX_POINT_OF_INSTANTIATION: 5167 // FIXME: Do we need to also save the template specialization kind here? 5168 Record.AddSourceLocation(Update.getLoc()); 5169 break; 5170 5171 case UPD_CXX_ADDED_VAR_DEFINITION: { 5172 const VarDecl *VD = cast<VarDecl>(D); 5173 Record.push_back(VD->isInline()); 5174 Record.push_back(VD->isInlineSpecified()); 5175 if (VD->getInit()) { 5176 Record.push_back(!VD->isInitKnownICE() ? 1 5177 : (VD->isInitICE() ? 3 : 2)); 5178 Record.AddStmt(const_cast<Expr*>(VD->getInit())); 5179 } else { 5180 Record.push_back(0); 5181 } 5182 break; 5183 } 5184 5185 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT: 5186 Record.AddStmt(const_cast<Expr *>( 5187 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg())); 5188 break; 5189 5190 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER: 5191 Record.AddStmt( 5192 cast<FieldDecl>(Update.getDecl())->getInClassInitializer()); 5193 break; 5194 5195 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: { 5196 auto *RD = cast<CXXRecordDecl>(D); 5197 UpdatedDeclContexts.insert(RD->getPrimaryContext()); 5198 Record.push_back(RD->isParamDestroyedInCallee()); 5199 Record.push_back(RD->getArgPassingRestrictions()); 5200 Record.AddCXXDefinitionData(RD); 5201 Record.AddOffset(WriteDeclContextLexicalBlock( 5202 *Context, const_cast<CXXRecordDecl *>(RD))); 5203 5204 // This state is sometimes updated by template instantiation, when we 5205 // switch from the specialization referring to the template declaration 5206 // to it referring to the template definition. 5207 if (auto *MSInfo = RD->getMemberSpecializationInfo()) { 5208 Record.push_back(MSInfo->getTemplateSpecializationKind()); 5209 Record.AddSourceLocation(MSInfo->getPointOfInstantiation()); 5210 } else { 5211 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD); 5212 Record.push_back(Spec->getTemplateSpecializationKind()); 5213 Record.AddSourceLocation(Spec->getPointOfInstantiation()); 5214 5215 // The instantiation might have been resolved to a partial 5216 // specialization. If so, record which one. 5217 auto From = Spec->getInstantiatedFrom(); 5218 if (auto PartialSpec = 5219 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) { 5220 Record.push_back(true); 5221 Record.AddDeclRef(PartialSpec); 5222 Record.AddTemplateArgumentList( 5223 &Spec->getTemplateInstantiationArgs()); 5224 } else { 5225 Record.push_back(false); 5226 } 5227 } 5228 Record.push_back(RD->getTagKind()); 5229 Record.AddSourceLocation(RD->getLocation()); 5230 Record.AddSourceLocation(RD->getLocStart()); 5231 Record.AddSourceRange(RD->getBraceRange()); 5232 5233 // Instantiation may change attributes; write them all out afresh. 5234 Record.push_back(D->hasAttrs()); 5235 if (D->hasAttrs()) 5236 Record.AddAttributes(D->getAttrs()); 5237 5238 // FIXME: Ensure we don't get here for explicit instantiations. 5239 break; 5240 } 5241 5242 case UPD_CXX_RESOLVED_DTOR_DELETE: 5243 Record.AddDeclRef(Update.getDecl()); 5244 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg()); 5245 break; 5246 5247 case UPD_CXX_RESOLVED_EXCEPTION_SPEC: 5248 addExceptionSpec( 5249 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(), 5250 Record); 5251 break; 5252 5253 case UPD_CXX_DEDUCED_RETURN_TYPE: 5254 Record.push_back(GetOrCreateTypeID(Update.getType())); 5255 break; 5256 5257 case UPD_DECL_MARKED_USED: 5258 break; 5259 5260 case UPD_MANGLING_NUMBER: 5261 case UPD_STATIC_LOCAL_NUMBER: 5262 Record.push_back(Update.getNumber()); 5263 break; 5264 5265 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE: 5266 Record.AddSourceRange( 5267 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange()); 5268 break; 5269 5270 case UPD_DECL_MARKED_OPENMP_DECLARETARGET: 5271 Record.AddSourceRange( 5272 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange()); 5273 break; 5274 5275 case UPD_DECL_EXPORTED: 5276 Record.push_back(getSubmoduleID(Update.getModule())); 5277 break; 5278 5279 case UPD_ADDED_ATTR_TO_RECORD: 5280 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr())); 5281 break; 5282 } 5283 } 5284 5285 if (HasUpdatedBody) { 5286 const auto *Def = cast<FunctionDecl>(D); 5287 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION); 5288 Record.push_back(Def->isInlined()); 5289 Record.AddSourceLocation(Def->getInnerLocStart()); 5290 Record.AddFunctionDefinition(Def); 5291 } 5292 5293 OffsetsRecord.push_back(GetDeclRef(D)); 5294 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES)); 5295 } 5296 } 5297 5298 void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) { 5299 uint32_t Raw = Loc.getRawEncoding(); 5300 Record.push_back((Raw << 1) | (Raw >> 31)); 5301 } 5302 5303 void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) { 5304 AddSourceLocation(Range.getBegin(), Record); 5305 AddSourceLocation(Range.getEnd(), Record); 5306 } 5307 5308 void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) { 5309 Record->push_back(Value.getBitWidth()); 5310 const uint64_t *Words = Value.getRawData(); 5311 Record->append(Words, Words + Value.getNumWords()); 5312 } 5313 5314 void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) { 5315 Record->push_back(Value.isUnsigned()); 5316 AddAPInt(Value); 5317 } 5318 5319 void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) { 5320 AddAPInt(Value.bitcastToAPInt()); 5321 } 5322 5323 void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) { 5324 Record.push_back(getIdentifierRef(II)); 5325 } 5326 5327 IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) { 5328 if (!II) 5329 return 0; 5330 5331 IdentID &ID = IdentifierIDs[II]; 5332 if (ID == 0) 5333 ID = NextIdentID++; 5334 return ID; 5335 } 5336 5337 MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) { 5338 // Don't emit builtin macros like __LINE__ to the AST file unless they 5339 // have been redefined by the header (in which case they are not 5340 // isBuiltinMacro). 5341 if (!MI || MI->isBuiltinMacro()) 5342 return 0; 5343 5344 MacroID &ID = MacroIDs[MI]; 5345 if (ID == 0) { 5346 ID = NextMacroID++; 5347 MacroInfoToEmitData Info = { Name, MI, ID }; 5348 MacroInfosToEmit.push_back(Info); 5349 } 5350 return ID; 5351 } 5352 5353 MacroID ASTWriter::getMacroID(MacroInfo *MI) { 5354 if (!MI || MI->isBuiltinMacro()) 5355 return 0; 5356 5357 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!"); 5358 return MacroIDs[MI]; 5359 } 5360 5361 uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) { 5362 return IdentMacroDirectivesOffsetMap.lookup(Name); 5363 } 5364 5365 void ASTRecordWriter::AddSelectorRef(const Selector SelRef) { 5366 Record->push_back(Writer->getSelectorRef(SelRef)); 5367 } 5368 5369 SelectorID ASTWriter::getSelectorRef(Selector Sel) { 5370 if (Sel.getAsOpaquePtr() == nullptr) { 5371 return 0; 5372 } 5373 5374 SelectorID SID = SelectorIDs[Sel]; 5375 if (SID == 0 && Chain) { 5376 // This might trigger a ReadSelector callback, which will set the ID for 5377 // this selector. 5378 Chain->LoadSelector(Sel); 5379 SID = SelectorIDs[Sel]; 5380 } 5381 if (SID == 0) { 5382 SID = NextSelectorID++; 5383 SelectorIDs[Sel] = SID; 5384 } 5385 return SID; 5386 } 5387 5388 void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) { 5389 AddDeclRef(Temp->getDestructor()); 5390 } 5391 5392 void ASTRecordWriter::AddTemplateArgumentLocInfo( 5393 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) { 5394 switch (Kind) { 5395 case TemplateArgument::Expression: 5396 AddStmt(Arg.getAsExpr()); 5397 break; 5398 case TemplateArgument::Type: 5399 AddTypeSourceInfo(Arg.getAsTypeSourceInfo()); 5400 break; 5401 case TemplateArgument::Template: 5402 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc()); 5403 AddSourceLocation(Arg.getTemplateNameLoc()); 5404 break; 5405 case TemplateArgument::TemplateExpansion: 5406 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc()); 5407 AddSourceLocation(Arg.getTemplateNameLoc()); 5408 AddSourceLocation(Arg.getTemplateEllipsisLoc()); 5409 break; 5410 case TemplateArgument::Null: 5411 case TemplateArgument::Integral: 5412 case TemplateArgument::Declaration: 5413 case TemplateArgument::NullPtr: 5414 case TemplateArgument::Pack: 5415 // FIXME: Is this right? 5416 break; 5417 } 5418 } 5419 5420 void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) { 5421 AddTemplateArgument(Arg.getArgument()); 5422 5423 if (Arg.getArgument().getKind() == TemplateArgument::Expression) { 5424 bool InfoHasSameExpr 5425 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr(); 5426 Record->push_back(InfoHasSameExpr); 5427 if (InfoHasSameExpr) 5428 return; // Avoid storing the same expr twice. 5429 } 5430 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo()); 5431 } 5432 5433 void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) { 5434 if (!TInfo) { 5435 AddTypeRef(QualType()); 5436 return; 5437 } 5438 5439 AddTypeLoc(TInfo->getTypeLoc()); 5440 } 5441 5442 void ASTRecordWriter::AddTypeLoc(TypeLoc TL) { 5443 AddTypeRef(TL.getType()); 5444 5445 TypeLocWriter TLW(*this); 5446 for (; !TL.isNull(); TL = TL.getNextTypeLoc()) 5447 TLW.Visit(TL); 5448 } 5449 5450 void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) { 5451 Record.push_back(GetOrCreateTypeID(T)); 5452 } 5453 5454 TypeID ASTWriter::GetOrCreateTypeID(QualType T) { 5455 assert(Context); 5456 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx { 5457 if (T.isNull()) 5458 return TypeIdx(); 5459 assert(!T.getLocalFastQualifiers()); 5460 5461 TypeIdx &Idx = TypeIdxs[T]; 5462 if (Idx.getIndex() == 0) { 5463 if (DoneWritingDeclsAndTypes) { 5464 assert(0 && "New type seen after serializing all the types to emit!"); 5465 return TypeIdx(); 5466 } 5467 5468 // We haven't seen this type before. Assign it a new ID and put it 5469 // into the queue of types to emit. 5470 Idx = TypeIdx(NextTypeID++); 5471 DeclTypesToEmit.push(T); 5472 } 5473 return Idx; 5474 }); 5475 } 5476 5477 TypeID ASTWriter::getTypeID(QualType T) const { 5478 assert(Context); 5479 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx { 5480 if (T.isNull()) 5481 return TypeIdx(); 5482 assert(!T.getLocalFastQualifiers()); 5483 5484 TypeIdxMap::const_iterator I = TypeIdxs.find(T); 5485 assert(I != TypeIdxs.end() && "Type not emitted!"); 5486 return I->second; 5487 }); 5488 } 5489 5490 void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) { 5491 Record.push_back(GetDeclRef(D)); 5492 } 5493 5494 DeclID ASTWriter::GetDeclRef(const Decl *D) { 5495 assert(WritingAST && "Cannot request a declaration ID before AST writing"); 5496 5497 if (!D) { 5498 return 0; 5499 } 5500 5501 // If D comes from an AST file, its declaration ID is already known and 5502 // fixed. 5503 if (D->isFromASTFile()) 5504 return D->getGlobalID(); 5505 5506 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer"); 5507 DeclID &ID = DeclIDs[D]; 5508 if (ID == 0) { 5509 if (DoneWritingDeclsAndTypes) { 5510 assert(0 && "New decl seen after serializing all the decls to emit!"); 5511 return 0; 5512 } 5513 5514 // We haven't seen this declaration before. Give it a new ID and 5515 // enqueue it in the list of declarations to emit. 5516 ID = NextDeclID++; 5517 DeclTypesToEmit.push(const_cast<Decl *>(D)); 5518 } 5519 5520 return ID; 5521 } 5522 5523 DeclID ASTWriter::getDeclID(const Decl *D) { 5524 if (!D) 5525 return 0; 5526 5527 // If D comes from an AST file, its declaration ID is already known and 5528 // fixed. 5529 if (D->isFromASTFile()) 5530 return D->getGlobalID(); 5531 5532 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!"); 5533 return DeclIDs[D]; 5534 } 5535 5536 void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) { 5537 assert(ID); 5538 assert(D); 5539 5540 SourceLocation Loc = D->getLocation(); 5541 if (Loc.isInvalid()) 5542 return; 5543 5544 // We only keep track of the file-level declarations of each file. 5545 if (!D->getLexicalDeclContext()->isFileContext()) 5546 return; 5547 // FIXME: ParmVarDecls that are part of a function type of a parameter of 5548 // a function/objc method, should not have TU as lexical context. 5549 // TemplateTemplateParmDecls that are part of an alias template, should not 5550 // have TU as lexical context. 5551 if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D)) 5552 return; 5553 5554 SourceManager &SM = Context->getSourceManager(); 5555 SourceLocation FileLoc = SM.getFileLoc(Loc); 5556 assert(SM.isLocalSourceLocation(FileLoc)); 5557 FileID FID; 5558 unsigned Offset; 5559 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc); 5560 if (FID.isInvalid()) 5561 return; 5562 assert(SM.getSLocEntry(FID).isFile()); 5563 5564 DeclIDInFileInfo *&Info = FileDeclIDs[FID]; 5565 if (!Info) 5566 Info = new DeclIDInFileInfo(); 5567 5568 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID); 5569 LocDeclIDsTy &Decls = Info->DeclIDs; 5570 5571 if (Decls.empty() || Decls.back().first <= Offset) { 5572 Decls.push_back(LocDecl); 5573 return; 5574 } 5575 5576 LocDeclIDsTy::iterator I = 5577 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first()); 5578 5579 Decls.insert(I, LocDecl); 5580 } 5581 5582 void ASTRecordWriter::AddDeclarationName(DeclarationName Name) { 5583 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc. 5584 Record->push_back(Name.getNameKind()); 5585 switch (Name.getNameKind()) { 5586 case DeclarationName::Identifier: 5587 AddIdentifierRef(Name.getAsIdentifierInfo()); 5588 break; 5589 5590 case DeclarationName::ObjCZeroArgSelector: 5591 case DeclarationName::ObjCOneArgSelector: 5592 case DeclarationName::ObjCMultiArgSelector: 5593 AddSelectorRef(Name.getObjCSelector()); 5594 break; 5595 5596 case DeclarationName::CXXConstructorName: 5597 case DeclarationName::CXXDestructorName: 5598 case DeclarationName::CXXConversionFunctionName: 5599 AddTypeRef(Name.getCXXNameType()); 5600 break; 5601 5602 case DeclarationName::CXXDeductionGuideName: 5603 AddDeclRef(Name.getCXXDeductionGuideTemplate()); 5604 break; 5605 5606 case DeclarationName::CXXOperatorName: 5607 Record->push_back(Name.getCXXOverloadedOperator()); 5608 break; 5609 5610 case DeclarationName::CXXLiteralOperatorName: 5611 AddIdentifierRef(Name.getCXXLiteralIdentifier()); 5612 break; 5613 5614 case DeclarationName::CXXUsingDirective: 5615 // No extra data to emit 5616 break; 5617 } 5618 } 5619 5620 unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) { 5621 assert(needsAnonymousDeclarationNumber(D) && 5622 "expected an anonymous declaration"); 5623 5624 // Number the anonymous declarations within this context, if we've not 5625 // already done so. 5626 auto It = AnonymousDeclarationNumbers.find(D); 5627 if (It == AnonymousDeclarationNumbers.end()) { 5628 auto *DC = D->getLexicalDeclContext(); 5629 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) { 5630 AnonymousDeclarationNumbers[ND] = Number; 5631 }); 5632 5633 It = AnonymousDeclarationNumbers.find(D); 5634 assert(It != AnonymousDeclarationNumbers.end() && 5635 "declaration not found within its lexical context"); 5636 } 5637 5638 return It->second; 5639 } 5640 5641 void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc, 5642 DeclarationName Name) { 5643 switch (Name.getNameKind()) { 5644 case DeclarationName::CXXConstructorName: 5645 case DeclarationName::CXXDestructorName: 5646 case DeclarationName::CXXConversionFunctionName: 5647 AddTypeSourceInfo(DNLoc.NamedType.TInfo); 5648 break; 5649 5650 case DeclarationName::CXXOperatorName: 5651 AddSourceLocation(SourceLocation::getFromRawEncoding( 5652 DNLoc.CXXOperatorName.BeginOpNameLoc)); 5653 AddSourceLocation( 5654 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc)); 5655 break; 5656 5657 case DeclarationName::CXXLiteralOperatorName: 5658 AddSourceLocation(SourceLocation::getFromRawEncoding( 5659 DNLoc.CXXLiteralOperatorName.OpNameLoc)); 5660 break; 5661 5662 case DeclarationName::Identifier: 5663 case DeclarationName::ObjCZeroArgSelector: 5664 case DeclarationName::ObjCOneArgSelector: 5665 case DeclarationName::ObjCMultiArgSelector: 5666 case DeclarationName::CXXUsingDirective: 5667 case DeclarationName::CXXDeductionGuideName: 5668 break; 5669 } 5670 } 5671 5672 void ASTRecordWriter::AddDeclarationNameInfo( 5673 const DeclarationNameInfo &NameInfo) { 5674 AddDeclarationName(NameInfo.getName()); 5675 AddSourceLocation(NameInfo.getLoc()); 5676 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName()); 5677 } 5678 5679 void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) { 5680 AddNestedNameSpecifierLoc(Info.QualifierLoc); 5681 Record->push_back(Info.NumTemplParamLists); 5682 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i) 5683 AddTemplateParameterList(Info.TemplParamLists[i]); 5684 } 5685 5686 void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) { 5687 // Nested name specifiers usually aren't too long. I think that 8 would 5688 // typically accommodate the vast majority. 5689 SmallVector<NestedNameSpecifier *, 8> NestedNames; 5690 5691 // Push each of the NNS's onto a stack for serialization in reverse order. 5692 while (NNS) { 5693 NestedNames.push_back(NNS); 5694 NNS = NNS->getPrefix(); 5695 } 5696 5697 Record->push_back(NestedNames.size()); 5698 while(!NestedNames.empty()) { 5699 NNS = NestedNames.pop_back_val(); 5700 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind(); 5701 Record->push_back(Kind); 5702 switch (Kind) { 5703 case NestedNameSpecifier::Identifier: 5704 AddIdentifierRef(NNS->getAsIdentifier()); 5705 break; 5706 5707 case NestedNameSpecifier::Namespace: 5708 AddDeclRef(NNS->getAsNamespace()); 5709 break; 5710 5711 case NestedNameSpecifier::NamespaceAlias: 5712 AddDeclRef(NNS->getAsNamespaceAlias()); 5713 break; 5714 5715 case NestedNameSpecifier::TypeSpec: 5716 case NestedNameSpecifier::TypeSpecWithTemplate: 5717 AddTypeRef(QualType(NNS->getAsType(), 0)); 5718 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate); 5719 break; 5720 5721 case NestedNameSpecifier::Global: 5722 // Don't need to write an associated value. 5723 break; 5724 5725 case NestedNameSpecifier::Super: 5726 AddDeclRef(NNS->getAsRecordDecl()); 5727 break; 5728 } 5729 } 5730 } 5731 5732 void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) { 5733 // Nested name specifiers usually aren't too long. I think that 8 would 5734 // typically accommodate the vast majority. 5735 SmallVector<NestedNameSpecifierLoc , 8> NestedNames; 5736 5737 // Push each of the nested-name-specifiers's onto a stack for 5738 // serialization in reverse order. 5739 while (NNS) { 5740 NestedNames.push_back(NNS); 5741 NNS = NNS.getPrefix(); 5742 } 5743 5744 Record->push_back(NestedNames.size()); 5745 while(!NestedNames.empty()) { 5746 NNS = NestedNames.pop_back_val(); 5747 NestedNameSpecifier::SpecifierKind Kind 5748 = NNS.getNestedNameSpecifier()->getKind(); 5749 Record->push_back(Kind); 5750 switch (Kind) { 5751 case NestedNameSpecifier::Identifier: 5752 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier()); 5753 AddSourceRange(NNS.getLocalSourceRange()); 5754 break; 5755 5756 case NestedNameSpecifier::Namespace: 5757 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace()); 5758 AddSourceRange(NNS.getLocalSourceRange()); 5759 break; 5760 5761 case NestedNameSpecifier::NamespaceAlias: 5762 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias()); 5763 AddSourceRange(NNS.getLocalSourceRange()); 5764 break; 5765 5766 case NestedNameSpecifier::TypeSpec: 5767 case NestedNameSpecifier::TypeSpecWithTemplate: 5768 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate); 5769 AddTypeLoc(NNS.getTypeLoc()); 5770 AddSourceLocation(NNS.getLocalSourceRange().getEnd()); 5771 break; 5772 5773 case NestedNameSpecifier::Global: 5774 AddSourceLocation(NNS.getLocalSourceRange().getEnd()); 5775 break; 5776 5777 case NestedNameSpecifier::Super: 5778 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl()); 5779 AddSourceRange(NNS.getLocalSourceRange()); 5780 break; 5781 } 5782 } 5783 } 5784 5785 void ASTRecordWriter::AddTemplateName(TemplateName Name) { 5786 TemplateName::NameKind Kind = Name.getKind(); 5787 Record->push_back(Kind); 5788 switch (Kind) { 5789 case TemplateName::Template: 5790 AddDeclRef(Name.getAsTemplateDecl()); 5791 break; 5792 5793 case TemplateName::OverloadedTemplate: { 5794 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate(); 5795 Record->push_back(OvT->size()); 5796 for (const auto &I : *OvT) 5797 AddDeclRef(I); 5798 break; 5799 } 5800 5801 case TemplateName::QualifiedTemplate: { 5802 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName(); 5803 AddNestedNameSpecifier(QualT->getQualifier()); 5804 Record->push_back(QualT->hasTemplateKeyword()); 5805 AddDeclRef(QualT->getTemplateDecl()); 5806 break; 5807 } 5808 5809 case TemplateName::DependentTemplate: { 5810 DependentTemplateName *DepT = Name.getAsDependentTemplateName(); 5811 AddNestedNameSpecifier(DepT->getQualifier()); 5812 Record->push_back(DepT->isIdentifier()); 5813 if (DepT->isIdentifier()) 5814 AddIdentifierRef(DepT->getIdentifier()); 5815 else 5816 Record->push_back(DepT->getOperator()); 5817 break; 5818 } 5819 5820 case TemplateName::SubstTemplateTemplateParm: { 5821 SubstTemplateTemplateParmStorage *subst 5822 = Name.getAsSubstTemplateTemplateParm(); 5823 AddDeclRef(subst->getParameter()); 5824 AddTemplateName(subst->getReplacement()); 5825 break; 5826 } 5827 5828 case TemplateName::SubstTemplateTemplateParmPack: { 5829 SubstTemplateTemplateParmPackStorage *SubstPack 5830 = Name.getAsSubstTemplateTemplateParmPack(); 5831 AddDeclRef(SubstPack->getParameterPack()); 5832 AddTemplateArgument(SubstPack->getArgumentPack()); 5833 break; 5834 } 5835 } 5836 } 5837 5838 void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) { 5839 Record->push_back(Arg.getKind()); 5840 switch (Arg.getKind()) { 5841 case TemplateArgument::Null: 5842 break; 5843 case TemplateArgument::Type: 5844 AddTypeRef(Arg.getAsType()); 5845 break; 5846 case TemplateArgument::Declaration: 5847 AddDeclRef(Arg.getAsDecl()); 5848 AddTypeRef(Arg.getParamTypeForDecl()); 5849 break; 5850 case TemplateArgument::NullPtr: 5851 AddTypeRef(Arg.getNullPtrType()); 5852 break; 5853 case TemplateArgument::Integral: 5854 AddAPSInt(Arg.getAsIntegral()); 5855 AddTypeRef(Arg.getIntegralType()); 5856 break; 5857 case TemplateArgument::Template: 5858 AddTemplateName(Arg.getAsTemplateOrTemplatePattern()); 5859 break; 5860 case TemplateArgument::TemplateExpansion: 5861 AddTemplateName(Arg.getAsTemplateOrTemplatePattern()); 5862 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions()) 5863 Record->push_back(*NumExpansions + 1); 5864 else 5865 Record->push_back(0); 5866 break; 5867 case TemplateArgument::Expression: 5868 AddStmt(Arg.getAsExpr()); 5869 break; 5870 case TemplateArgument::Pack: 5871 Record->push_back(Arg.pack_size()); 5872 for (const auto &P : Arg.pack_elements()) 5873 AddTemplateArgument(P); 5874 break; 5875 } 5876 } 5877 5878 void ASTRecordWriter::AddTemplateParameterList( 5879 const TemplateParameterList *TemplateParams) { 5880 assert(TemplateParams && "No TemplateParams!"); 5881 AddSourceLocation(TemplateParams->getTemplateLoc()); 5882 AddSourceLocation(TemplateParams->getLAngleLoc()); 5883 AddSourceLocation(TemplateParams->getRAngleLoc()); 5884 // TODO: Concepts 5885 Record->push_back(TemplateParams->size()); 5886 for (const auto &P : *TemplateParams) 5887 AddDeclRef(P); 5888 } 5889 5890 /// \brief Emit a template argument list. 5891 void ASTRecordWriter::AddTemplateArgumentList( 5892 const TemplateArgumentList *TemplateArgs) { 5893 assert(TemplateArgs && "No TemplateArgs!"); 5894 Record->push_back(TemplateArgs->size()); 5895 for (int i = 0, e = TemplateArgs->size(); i != e; ++i) 5896 AddTemplateArgument(TemplateArgs->get(i)); 5897 } 5898 5899 void ASTRecordWriter::AddASTTemplateArgumentListInfo( 5900 const ASTTemplateArgumentListInfo *ASTTemplArgList) { 5901 assert(ASTTemplArgList && "No ASTTemplArgList!"); 5902 AddSourceLocation(ASTTemplArgList->LAngleLoc); 5903 AddSourceLocation(ASTTemplArgList->RAngleLoc); 5904 Record->push_back(ASTTemplArgList->NumTemplateArgs); 5905 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs(); 5906 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i) 5907 AddTemplateArgumentLoc(TemplArgs[i]); 5908 } 5909 5910 void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) { 5911 Record->push_back(Set.size()); 5912 for (ASTUnresolvedSet::const_iterator 5913 I = Set.begin(), E = Set.end(); I != E; ++I) { 5914 AddDeclRef(I.getDecl()); 5915 Record->push_back(I.getAccess()); 5916 } 5917 } 5918 5919 // FIXME: Move this out of the main ASTRecordWriter interface. 5920 void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) { 5921 Record->push_back(Base.isVirtual()); 5922 Record->push_back(Base.isBaseOfClass()); 5923 Record->push_back(Base.getAccessSpecifierAsWritten()); 5924 Record->push_back(Base.getInheritConstructors()); 5925 AddTypeSourceInfo(Base.getTypeSourceInfo()); 5926 AddSourceRange(Base.getSourceRange()); 5927 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc() 5928 : SourceLocation()); 5929 } 5930 5931 static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W, 5932 ArrayRef<CXXBaseSpecifier> Bases) { 5933 ASTWriter::RecordData Record; 5934 ASTRecordWriter Writer(W, Record); 5935 Writer.push_back(Bases.size()); 5936 5937 for (auto &Base : Bases) 5938 Writer.AddCXXBaseSpecifier(Base); 5939 5940 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS); 5941 } 5942 5943 // FIXME: Move this out of the main ASTRecordWriter interface. 5944 void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) { 5945 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases)); 5946 } 5947 5948 static uint64_t 5949 EmitCXXCtorInitializers(ASTWriter &W, 5950 ArrayRef<CXXCtorInitializer *> CtorInits) { 5951 ASTWriter::RecordData Record; 5952 ASTRecordWriter Writer(W, Record); 5953 Writer.push_back(CtorInits.size()); 5954 5955 for (auto *Init : CtorInits) { 5956 if (Init->isBaseInitializer()) { 5957 Writer.push_back(CTOR_INITIALIZER_BASE); 5958 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo()); 5959 Writer.push_back(Init->isBaseVirtual()); 5960 } else if (Init->isDelegatingInitializer()) { 5961 Writer.push_back(CTOR_INITIALIZER_DELEGATING); 5962 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo()); 5963 } else if (Init->isMemberInitializer()){ 5964 Writer.push_back(CTOR_INITIALIZER_MEMBER); 5965 Writer.AddDeclRef(Init->getMember()); 5966 } else { 5967 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER); 5968 Writer.AddDeclRef(Init->getIndirectMember()); 5969 } 5970 5971 Writer.AddSourceLocation(Init->getMemberLocation()); 5972 Writer.AddStmt(Init->getInit()); 5973 Writer.AddSourceLocation(Init->getLParenLoc()); 5974 Writer.AddSourceLocation(Init->getRParenLoc()); 5975 Writer.push_back(Init->isWritten()); 5976 if (Init->isWritten()) 5977 Writer.push_back(Init->getSourceOrder()); 5978 } 5979 5980 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS); 5981 } 5982 5983 // FIXME: Move this out of the main ASTRecordWriter interface. 5984 void ASTRecordWriter::AddCXXCtorInitializers( 5985 ArrayRef<CXXCtorInitializer *> CtorInits) { 5986 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits)); 5987 } 5988 5989 void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) { 5990 auto &Data = D->data(); 5991 Record->push_back(Data.IsLambda); 5992 Record->push_back(Data.UserDeclaredConstructor); 5993 Record->push_back(Data.UserDeclaredSpecialMembers); 5994 Record->push_back(Data.Aggregate); 5995 Record->push_back(Data.PlainOldData); 5996 Record->push_back(Data.Empty); 5997 Record->push_back(Data.Polymorphic); 5998 Record->push_back(Data.Abstract); 5999 Record->push_back(Data.IsStandardLayout); 6000 Record->push_back(Data.IsCXX11StandardLayout); 6001 Record->push_back(Data.HasBasesWithFields); 6002 Record->push_back(Data.HasBasesWithNonStaticDataMembers); 6003 Record->push_back(Data.HasPrivateFields); 6004 Record->push_back(Data.HasProtectedFields); 6005 Record->push_back(Data.HasPublicFields); 6006 Record->push_back(Data.HasMutableFields); 6007 Record->push_back(Data.HasVariantMembers); 6008 Record->push_back(Data.HasOnlyCMembers); 6009 Record->push_back(Data.HasInClassInitializer); 6010 Record->push_back(Data.HasUninitializedReferenceMember); 6011 Record->push_back(Data.HasUninitializedFields); 6012 Record->push_back(Data.HasInheritedConstructor); 6013 Record->push_back(Data.HasInheritedAssignment); 6014 Record->push_back(Data.NeedOverloadResolutionForCopyConstructor); 6015 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor); 6016 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment); 6017 Record->push_back(Data.NeedOverloadResolutionForDestructor); 6018 Record->push_back(Data.DefaultedCopyConstructorIsDeleted); 6019 Record->push_back(Data.DefaultedMoveConstructorIsDeleted); 6020 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted); 6021 Record->push_back(Data.DefaultedDestructorIsDeleted); 6022 Record->push_back(Data.HasTrivialSpecialMembers); 6023 Record->push_back(Data.HasTrivialSpecialMembersForCall); 6024 Record->push_back(Data.DeclaredNonTrivialSpecialMembers); 6025 Record->push_back(Data.DeclaredNonTrivialSpecialMembersForCall); 6026 Record->push_back(Data.HasIrrelevantDestructor); 6027 Record->push_back(Data.HasConstexprNonCopyMoveConstructor); 6028 Record->push_back(Data.HasDefaultedDefaultConstructor); 6029 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr); 6030 Record->push_back(Data.HasConstexprDefaultConstructor); 6031 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases); 6032 Record->push_back(Data.ComputedVisibleConversions); 6033 Record->push_back(Data.UserProvidedDefaultConstructor); 6034 Record->push_back(Data.DeclaredSpecialMembers); 6035 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForVBase); 6036 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForNonVBase); 6037 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam); 6038 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam); 6039 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam); 6040 6041 // getODRHash will compute the ODRHash if it has not been previously computed. 6042 Record->push_back(D->getODRHash()); 6043 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo && 6044 Writer->WritingModule && !D->isDependentType(); 6045 Record->push_back(ModulesDebugInfo); 6046 if (ModulesDebugInfo) 6047 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D)); 6048 6049 // IsLambda bit is already saved. 6050 6051 Record->push_back(Data.NumBases); 6052 if (Data.NumBases > 0) 6053 AddCXXBaseSpecifiers(Data.bases()); 6054 6055 // FIXME: Make VBases lazily computed when needed to avoid storing them. 6056 Record->push_back(Data.NumVBases); 6057 if (Data.NumVBases > 0) 6058 AddCXXBaseSpecifiers(Data.vbases()); 6059 6060 AddUnresolvedSet(Data.Conversions.get(*Writer->Context)); 6061 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context)); 6062 // Data.Definition is the owning decl, no need to write it. 6063 AddDeclRef(D->getFirstFriend()); 6064 6065 // Add lambda-specific data. 6066 if (Data.IsLambda) { 6067 auto &Lambda = D->getLambdaData(); 6068 Record->push_back(Lambda.Dependent); 6069 Record->push_back(Lambda.IsGenericLambda); 6070 Record->push_back(Lambda.CaptureDefault); 6071 Record->push_back(Lambda.NumCaptures); 6072 Record->push_back(Lambda.NumExplicitCaptures); 6073 Record->push_back(Lambda.ManglingNumber); 6074 AddDeclRef(D->getLambdaContextDecl()); 6075 AddTypeSourceInfo(Lambda.MethodTyInfo); 6076 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) { 6077 const LambdaCapture &Capture = Lambda.Captures[I]; 6078 AddSourceLocation(Capture.getLocation()); 6079 Record->push_back(Capture.isImplicit()); 6080 Record->push_back(Capture.getCaptureKind()); 6081 switch (Capture.getCaptureKind()) { 6082 case LCK_StarThis: 6083 case LCK_This: 6084 case LCK_VLAType: 6085 break; 6086 case LCK_ByCopy: 6087 case LCK_ByRef: 6088 VarDecl *Var = 6089 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr; 6090 AddDeclRef(Var); 6091 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc() 6092 : SourceLocation()); 6093 break; 6094 } 6095 } 6096 } 6097 } 6098 6099 void ASTWriter::ReaderInitialized(ASTReader *Reader) { 6100 assert(Reader && "Cannot remove chain"); 6101 assert((!Chain || Chain == Reader) && "Cannot replace chain"); 6102 assert(FirstDeclID == NextDeclID && 6103 FirstTypeID == NextTypeID && 6104 FirstIdentID == NextIdentID && 6105 FirstMacroID == NextMacroID && 6106 FirstSubmoduleID == NextSubmoduleID && 6107 FirstSelectorID == NextSelectorID && 6108 "Setting chain after writing has started."); 6109 6110 Chain = Reader; 6111 6112 // Note, this will get called multiple times, once one the reader starts up 6113 // and again each time it's done reading a PCH or module. 6114 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls(); 6115 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes(); 6116 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers(); 6117 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros(); 6118 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules(); 6119 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors(); 6120 NextDeclID = FirstDeclID; 6121 NextTypeID = FirstTypeID; 6122 NextIdentID = FirstIdentID; 6123 NextMacroID = FirstMacroID; 6124 NextSelectorID = FirstSelectorID; 6125 NextSubmoduleID = FirstSubmoduleID; 6126 } 6127 6128 void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) { 6129 // Always keep the highest ID. See \p TypeRead() for more information. 6130 IdentID &StoredID = IdentifierIDs[II]; 6131 if (ID > StoredID) 6132 StoredID = ID; 6133 } 6134 6135 void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) { 6136 // Always keep the highest ID. See \p TypeRead() for more information. 6137 MacroID &StoredID = MacroIDs[MI]; 6138 if (ID > StoredID) 6139 StoredID = ID; 6140 } 6141 6142 void ASTWriter::TypeRead(TypeIdx Idx, QualType T) { 6143 // Always take the highest-numbered type index. This copes with an interesting 6144 // case for chained AST writing where we schedule writing the type and then, 6145 // later, deserialize the type from another AST. In this case, we want to 6146 // keep the higher-numbered entry so that we can properly write it out to 6147 // the AST file. 6148 TypeIdx &StoredIdx = TypeIdxs[T]; 6149 if (Idx.getIndex() >= StoredIdx.getIndex()) 6150 StoredIdx = Idx; 6151 } 6152 6153 void ASTWriter::SelectorRead(SelectorID ID, Selector S) { 6154 // Always keep the highest ID. See \p TypeRead() for more information. 6155 SelectorID &StoredID = SelectorIDs[S]; 6156 if (ID > StoredID) 6157 StoredID = ID; 6158 } 6159 6160 void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID, 6161 MacroDefinitionRecord *MD) { 6162 assert(MacroDefinitions.find(MD) == MacroDefinitions.end()); 6163 MacroDefinitions[MD] = ID; 6164 } 6165 6166 void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) { 6167 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end()); 6168 SubmoduleIDs[Mod] = ID; 6169 } 6170 6171 void ASTWriter::CompletedTagDefinition(const TagDecl *D) { 6172 if (Chain && Chain->isProcessingUpdateRecords()) return; 6173 assert(D->isCompleteDefinition()); 6174 assert(!WritingAST && "Already writing the AST!"); 6175 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) { 6176 // We are interested when a PCH decl is modified. 6177 if (RD->isFromASTFile()) { 6178 // A forward reference was mutated into a definition. Rewrite it. 6179 // FIXME: This happens during template instantiation, should we 6180 // have created a new definition decl instead ? 6181 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) && 6182 "completed a tag from another module but not by instantiation?"); 6183 DeclUpdates[RD].push_back( 6184 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION)); 6185 } 6186 } 6187 } 6188 6189 static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) { 6190 if (D->isFromASTFile()) 6191 return true; 6192 6193 // The predefined __va_list_tag struct is imported if we imported any decls. 6194 // FIXME: This is a gross hack. 6195 return D == D->getASTContext().getVaListTagDecl(); 6196 } 6197 6198 void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) { 6199 if (Chain && Chain->isProcessingUpdateRecords()) return; 6200 assert(DC->isLookupContext() && 6201 "Should not add lookup results to non-lookup contexts!"); 6202 6203 // TU is handled elsewhere. 6204 if (isa<TranslationUnitDecl>(DC)) 6205 return; 6206 6207 // Namespaces are handled elsewhere, except for template instantiations of 6208 // FunctionTemplateDecls in namespaces. We are interested in cases where the 6209 // local instantiations are added to an imported context. Only happens when 6210 // adding ADL lookup candidates, for example templated friends. 6211 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None && 6212 !isa<FunctionTemplateDecl>(D)) 6213 return; 6214 6215 // We're only interested in cases where a local declaration is added to an 6216 // imported context. 6217 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC))) 6218 return; 6219 6220 assert(DC == DC->getPrimaryContext() && "added to non-primary context"); 6221 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!"); 6222 assert(!WritingAST && "Already writing the AST!"); 6223 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) { 6224 // We're adding a visible declaration to a predefined decl context. Ensure 6225 // that we write out all of its lookup results so we don't get a nasty 6226 // surprise when we try to emit its lookup table. 6227 for (auto *Child : DC->decls()) 6228 DeclsToEmitEvenIfUnreferenced.push_back(Child); 6229 } 6230 DeclsToEmitEvenIfUnreferenced.push_back(D); 6231 } 6232 6233 void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) { 6234 if (Chain && Chain->isProcessingUpdateRecords()) return; 6235 assert(D->isImplicit()); 6236 6237 // We're only interested in cases where a local declaration is added to an 6238 // imported context. 6239 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD)) 6240 return; 6241 6242 if (!isa<CXXMethodDecl>(D)) 6243 return; 6244 6245 // A decl coming from PCH was modified. 6246 assert(RD->isCompleteDefinition()); 6247 assert(!WritingAST && "Already writing the AST!"); 6248 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D)); 6249 } 6250 6251 void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) { 6252 if (Chain && Chain->isProcessingUpdateRecords()) return; 6253 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!"); 6254 if (!Chain) return; 6255 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) { 6256 // If we don't already know the exception specification for this redecl 6257 // chain, add an update record for it. 6258 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D) 6259 ->getType() 6260 ->castAs<FunctionProtoType>() 6261 ->getExceptionSpecType())) 6262 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC); 6263 }); 6264 } 6265 6266 void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) { 6267 if (Chain && Chain->isProcessingUpdateRecords()) return; 6268 assert(!WritingAST && "Already writing the AST!"); 6269 if (!Chain) return; 6270 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) { 6271 DeclUpdates[D].push_back( 6272 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType)); 6273 }); 6274 } 6275 6276 void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD, 6277 const FunctionDecl *Delete, 6278 Expr *ThisArg) { 6279 if (Chain && Chain->isProcessingUpdateRecords()) return; 6280 assert(!WritingAST && "Already writing the AST!"); 6281 assert(Delete && "Not given an operator delete"); 6282 if (!Chain) return; 6283 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) { 6284 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete)); 6285 }); 6286 } 6287 6288 void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) { 6289 if (Chain && Chain->isProcessingUpdateRecords()) return; 6290 assert(!WritingAST && "Already writing the AST!"); 6291 if (!D->isFromASTFile()) 6292 return; // Declaration not imported from PCH. 6293 6294 // Implicit function decl from a PCH was defined. 6295 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION)); 6296 } 6297 6298 void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) { 6299 if (Chain && Chain->isProcessingUpdateRecords()) return; 6300 assert(!WritingAST && "Already writing the AST!"); 6301 if (!D->isFromASTFile()) 6302 return; 6303 6304 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION)); 6305 } 6306 6307 void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) { 6308 if (Chain && Chain->isProcessingUpdateRecords()) return; 6309 assert(!WritingAST && "Already writing the AST!"); 6310 if (!D->isFromASTFile()) 6311 return; 6312 6313 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION)); 6314 } 6315 6316 void ASTWriter::InstantiationRequested(const ValueDecl *D) { 6317 if (Chain && Chain->isProcessingUpdateRecords()) return; 6318 assert(!WritingAST && "Already writing the AST!"); 6319 if (!D->isFromASTFile()) 6320 return; 6321 6322 // Since the actual instantiation is delayed, this really means that we need 6323 // to update the instantiation location. 6324 SourceLocation POI; 6325 if (auto *VD = dyn_cast<VarDecl>(D)) 6326 POI = VD->getPointOfInstantiation(); 6327 else 6328 POI = cast<FunctionDecl>(D)->getPointOfInstantiation(); 6329 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI)); 6330 } 6331 6332 void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) { 6333 if (Chain && Chain->isProcessingUpdateRecords()) return; 6334 assert(!WritingAST && "Already writing the AST!"); 6335 if (!D->isFromASTFile()) 6336 return; 6337 6338 DeclUpdates[D].push_back( 6339 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D)); 6340 } 6341 6342 void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) { 6343 assert(!WritingAST && "Already writing the AST!"); 6344 if (!D->isFromASTFile()) 6345 return; 6346 6347 DeclUpdates[D].push_back( 6348 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D)); 6349 } 6350 6351 void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD, 6352 const ObjCInterfaceDecl *IFD) { 6353 if (Chain && Chain->isProcessingUpdateRecords()) return; 6354 assert(!WritingAST && "Already writing the AST!"); 6355 if (!IFD->isFromASTFile()) 6356 return; // Declaration not imported from PCH. 6357 6358 assert(IFD->getDefinition() && "Category on a class without a definition?"); 6359 ObjCClassesWithCategories.insert( 6360 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition())); 6361 } 6362 6363 void ASTWriter::DeclarationMarkedUsed(const Decl *D) { 6364 if (Chain && Chain->isProcessingUpdateRecords()) return; 6365 assert(!WritingAST && "Already writing the AST!"); 6366 6367 // If there is *any* declaration of the entity that's not from an AST file, 6368 // we can skip writing the update record. We make sure that isUsed() triggers 6369 // completion of the redeclaration chain of the entity. 6370 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl()) 6371 if (IsLocalDecl(Prev)) 6372 return; 6373 6374 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED)); 6375 } 6376 6377 void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) { 6378 if (Chain && Chain->isProcessingUpdateRecords()) return; 6379 assert(!WritingAST && "Already writing the AST!"); 6380 if (!D->isFromASTFile()) 6381 return; 6382 6383 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE)); 6384 } 6385 6386 void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D, 6387 const Attr *Attr) { 6388 if (Chain && Chain->isProcessingUpdateRecords()) return; 6389 assert(!WritingAST && "Already writing the AST!"); 6390 if (!D->isFromASTFile()) 6391 return; 6392 6393 DeclUpdates[D].push_back( 6394 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr)); 6395 } 6396 6397 void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) { 6398 if (Chain && Chain->isProcessingUpdateRecords()) return; 6399 assert(!WritingAST && "Already writing the AST!"); 6400 assert(D->isHidden() && "expected a hidden declaration"); 6401 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M)); 6402 } 6403 6404 void ASTWriter::AddedAttributeToRecord(const Attr *Attr, 6405 const RecordDecl *Record) { 6406 if (Chain && Chain->isProcessingUpdateRecords()) return; 6407 assert(!WritingAST && "Already writing the AST!"); 6408 if (!Record->isFromASTFile()) 6409 return; 6410 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr)); 6411 } 6412 6413 void ASTWriter::AddedCXXTemplateSpecialization( 6414 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) { 6415 assert(!WritingAST && "Already writing the AST!"); 6416 6417 if (!TD->getFirstDecl()->isFromASTFile()) 6418 return; 6419 if (Chain && Chain->isProcessingUpdateRecords()) 6420 return; 6421 6422 DeclsToEmitEvenIfUnreferenced.push_back(D); 6423 } 6424 6425 void ASTWriter::AddedCXXTemplateSpecialization( 6426 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) { 6427 assert(!WritingAST && "Already writing the AST!"); 6428 6429 if (!TD->getFirstDecl()->isFromASTFile()) 6430 return; 6431 if (Chain && Chain->isProcessingUpdateRecords()) 6432 return; 6433 6434 DeclsToEmitEvenIfUnreferenced.push_back(D); 6435 } 6436 6437 void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD, 6438 const FunctionDecl *D) { 6439 assert(!WritingAST && "Already writing the AST!"); 6440 6441 if (!TD->getFirstDecl()->isFromASTFile()) 6442 return; 6443 if (Chain && Chain->isProcessingUpdateRecords()) 6444 return; 6445 6446 DeclsToEmitEvenIfUnreferenced.push_back(D); 6447 } 6448