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