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/Sema/Sema.h" 17 #include "clang/Sema/IdentifierResolver.h" 18 #include "clang/AST/ASTContext.h" 19 #include "clang/AST/Decl.h" 20 #include "clang/AST/DeclContextInternals.h" 21 #include "clang/AST/DeclTemplate.h" 22 #include "clang/AST/DeclFriend.h" 23 #include "clang/AST/Expr.h" 24 #include "clang/AST/ExprCXX.h" 25 #include "clang/AST/Type.h" 26 #include "clang/AST/TypeLocVisitor.h" 27 #include "clang/Serialization/ASTReader.h" 28 #include "clang/Lex/MacroInfo.h" 29 #include "clang/Lex/PreprocessingRecord.h" 30 #include "clang/Lex/Preprocessor.h" 31 #include "clang/Lex/HeaderSearch.h" 32 #include "clang/Basic/FileManager.h" 33 #include "clang/Basic/FileSystemStatCache.h" 34 #include "clang/Basic/OnDiskHashTable.h" 35 #include "clang/Basic/SourceManager.h" 36 #include "clang/Basic/SourceManagerInternals.h" 37 #include "clang/Basic/TargetInfo.h" 38 #include "clang/Basic/Version.h" 39 #include "clang/Basic/VersionTuple.h" 40 #include "llvm/ADT/APFloat.h" 41 #include "llvm/ADT/APInt.h" 42 #include "llvm/ADT/StringExtras.h" 43 #include "llvm/Bitcode/BitstreamWriter.h" 44 #include "llvm/Support/FileSystem.h" 45 #include "llvm/Support/MemoryBuffer.h" 46 #include "llvm/Support/Path.h" 47 #include <algorithm> 48 #include <cstdio> 49 #include <string.h> 50 #include <utility> 51 using namespace clang; 52 using namespace clang::serialization; 53 54 template <typename T, typename Allocator> 55 static StringRef data(const std::vector<T, Allocator> &v) { 56 if (v.empty()) return StringRef(); 57 return StringRef(reinterpret_cast<const char*>(&v[0]), 58 sizeof(T) * v.size()); 59 } 60 61 template <typename T> 62 static StringRef data(const SmallVectorImpl<T> &v) { 63 return StringRef(reinterpret_cast<const char*>(v.data()), 64 sizeof(T) * v.size()); 65 } 66 67 //===----------------------------------------------------------------------===// 68 // Type serialization 69 //===----------------------------------------------------------------------===// 70 71 namespace { 72 class ASTTypeWriter { 73 ASTWriter &Writer; 74 ASTWriter::RecordDataImpl &Record; 75 76 public: 77 /// \brief Type code that corresponds to the record generated. 78 TypeCode Code; 79 80 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record) 81 : Writer(Writer), Record(Record), Code(TYPE_EXT_QUAL) { } 82 83 void VisitArrayType(const ArrayType *T); 84 void VisitFunctionType(const FunctionType *T); 85 void VisitTagType(const TagType *T); 86 87 #define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T); 88 #define ABSTRACT_TYPE(Class, Base) 89 #include "clang/AST/TypeNodes.def" 90 }; 91 } 92 93 void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) { 94 llvm_unreachable("Built-in types are never serialized"); 95 } 96 97 void ASTTypeWriter::VisitComplexType(const ComplexType *T) { 98 Writer.AddTypeRef(T->getElementType(), Record); 99 Code = TYPE_COMPLEX; 100 } 101 102 void ASTTypeWriter::VisitPointerType(const PointerType *T) { 103 Writer.AddTypeRef(T->getPointeeType(), Record); 104 Code = TYPE_POINTER; 105 } 106 107 void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) { 108 Writer.AddTypeRef(T->getPointeeType(), Record); 109 Code = TYPE_BLOCK_POINTER; 110 } 111 112 void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) { 113 Writer.AddTypeRef(T->getPointeeTypeAsWritten(), Record); 114 Record.push_back(T->isSpelledAsLValue()); 115 Code = TYPE_LVALUE_REFERENCE; 116 } 117 118 void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) { 119 Writer.AddTypeRef(T->getPointeeTypeAsWritten(), Record); 120 Code = TYPE_RVALUE_REFERENCE; 121 } 122 123 void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) { 124 Writer.AddTypeRef(T->getPointeeType(), Record); 125 Writer.AddTypeRef(QualType(T->getClass(), 0), Record); 126 Code = TYPE_MEMBER_POINTER; 127 } 128 129 void ASTTypeWriter::VisitArrayType(const ArrayType *T) { 130 Writer.AddTypeRef(T->getElementType(), Record); 131 Record.push_back(T->getSizeModifier()); // FIXME: stable values 132 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values 133 } 134 135 void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) { 136 VisitArrayType(T); 137 Writer.AddAPInt(T->getSize(), Record); 138 Code = TYPE_CONSTANT_ARRAY; 139 } 140 141 void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) { 142 VisitArrayType(T); 143 Code = TYPE_INCOMPLETE_ARRAY; 144 } 145 146 void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) { 147 VisitArrayType(T); 148 Writer.AddSourceLocation(T->getLBracketLoc(), Record); 149 Writer.AddSourceLocation(T->getRBracketLoc(), Record); 150 Writer.AddStmt(T->getSizeExpr()); 151 Code = TYPE_VARIABLE_ARRAY; 152 } 153 154 void ASTTypeWriter::VisitVectorType(const VectorType *T) { 155 Writer.AddTypeRef(T->getElementType(), Record); 156 Record.push_back(T->getNumElements()); 157 Record.push_back(T->getVectorKind()); 158 Code = TYPE_VECTOR; 159 } 160 161 void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) { 162 VisitVectorType(T); 163 Code = TYPE_EXT_VECTOR; 164 } 165 166 void ASTTypeWriter::VisitFunctionType(const FunctionType *T) { 167 Writer.AddTypeRef(T->getResultType(), Record); 168 FunctionType::ExtInfo C = T->getExtInfo(); 169 Record.push_back(C.getNoReturn()); 170 Record.push_back(C.getHasRegParm()); 171 Record.push_back(C.getRegParm()); 172 // FIXME: need to stabilize encoding of calling convention... 173 Record.push_back(C.getCC()); 174 Record.push_back(C.getProducesResult()); 175 } 176 177 void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) { 178 VisitFunctionType(T); 179 Code = TYPE_FUNCTION_NO_PROTO; 180 } 181 182 void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) { 183 VisitFunctionType(T); 184 Record.push_back(T->getNumArgs()); 185 for (unsigned I = 0, N = T->getNumArgs(); I != N; ++I) 186 Writer.AddTypeRef(T->getArgType(I), Record); 187 Record.push_back(T->isVariadic()); 188 Record.push_back(T->getTypeQuals()); 189 Record.push_back(static_cast<unsigned>(T->getRefQualifier())); 190 Record.push_back(T->getExceptionSpecType()); 191 if (T->getExceptionSpecType() == EST_Dynamic) { 192 Record.push_back(T->getNumExceptions()); 193 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I) 194 Writer.AddTypeRef(T->getExceptionType(I), Record); 195 } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) { 196 Writer.AddStmt(T->getNoexceptExpr()); 197 } 198 Code = TYPE_FUNCTION_PROTO; 199 } 200 201 void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) { 202 Writer.AddDeclRef(T->getDecl(), Record); 203 Code = TYPE_UNRESOLVED_USING; 204 } 205 206 void ASTTypeWriter::VisitTypedefType(const TypedefType *T) { 207 Writer.AddDeclRef(T->getDecl(), Record); 208 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?"); 209 Writer.AddTypeRef(T->getCanonicalTypeInternal(), Record); 210 Code = TYPE_TYPEDEF; 211 } 212 213 void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) { 214 Writer.AddStmt(T->getUnderlyingExpr()); 215 Code = TYPE_TYPEOF_EXPR; 216 } 217 218 void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) { 219 Writer.AddTypeRef(T->getUnderlyingType(), Record); 220 Code = TYPE_TYPEOF; 221 } 222 223 void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) { 224 Writer.AddStmt(T->getUnderlyingExpr()); 225 Code = TYPE_DECLTYPE; 226 } 227 228 void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) { 229 Writer.AddTypeRef(T->getBaseType(), Record); 230 Writer.AddTypeRef(T->getUnderlyingType(), Record); 231 Record.push_back(T->getUTTKind()); 232 Code = TYPE_UNARY_TRANSFORM; 233 } 234 235 void ASTTypeWriter::VisitAutoType(const AutoType *T) { 236 Writer.AddTypeRef(T->getDeducedType(), Record); 237 Code = TYPE_AUTO; 238 } 239 240 void ASTTypeWriter::VisitTagType(const TagType *T) { 241 Record.push_back(T->isDependentType()); 242 Writer.AddDeclRef(T->getDecl(), Record); 243 assert(!T->isBeingDefined() && 244 "Cannot serialize in the middle of a type definition"); 245 } 246 247 void ASTTypeWriter::VisitRecordType(const RecordType *T) { 248 VisitTagType(T); 249 Code = TYPE_RECORD; 250 } 251 252 void ASTTypeWriter::VisitEnumType(const EnumType *T) { 253 VisitTagType(T); 254 Code = TYPE_ENUM; 255 } 256 257 void ASTTypeWriter::VisitAttributedType(const AttributedType *T) { 258 Writer.AddTypeRef(T->getModifiedType(), Record); 259 Writer.AddTypeRef(T->getEquivalentType(), Record); 260 Record.push_back(T->getAttrKind()); 261 Code = TYPE_ATTRIBUTED; 262 } 263 264 void 265 ASTTypeWriter::VisitSubstTemplateTypeParmType( 266 const SubstTemplateTypeParmType *T) { 267 Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record); 268 Writer.AddTypeRef(T->getReplacementType(), Record); 269 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM; 270 } 271 272 void 273 ASTTypeWriter::VisitSubstTemplateTypeParmPackType( 274 const SubstTemplateTypeParmPackType *T) { 275 Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record); 276 Writer.AddTemplateArgument(T->getArgumentPack(), Record); 277 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK; 278 } 279 280 void 281 ASTTypeWriter::VisitTemplateSpecializationType( 282 const TemplateSpecializationType *T) { 283 Record.push_back(T->isDependentType()); 284 Writer.AddTemplateName(T->getTemplateName(), Record); 285 Record.push_back(T->getNumArgs()); 286 for (TemplateSpecializationType::iterator ArgI = T->begin(), ArgE = T->end(); 287 ArgI != ArgE; ++ArgI) 288 Writer.AddTemplateArgument(*ArgI, Record); 289 Writer.AddTypeRef(T->isTypeAlias() ? T->getAliasedType() : 290 T->isCanonicalUnqualified() ? QualType() 291 : T->getCanonicalTypeInternal(), 292 Record); 293 Code = TYPE_TEMPLATE_SPECIALIZATION; 294 } 295 296 void 297 ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) { 298 VisitArrayType(T); 299 Writer.AddStmt(T->getSizeExpr()); 300 Writer.AddSourceRange(T->getBracketsRange(), Record); 301 Code = TYPE_DEPENDENT_SIZED_ARRAY; 302 } 303 304 void 305 ASTTypeWriter::VisitDependentSizedExtVectorType( 306 const DependentSizedExtVectorType *T) { 307 // FIXME: Serialize this type (C++ only) 308 llvm_unreachable("Cannot serialize dependent sized extended vector types"); 309 } 310 311 void 312 ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) { 313 Record.push_back(T->getDepth()); 314 Record.push_back(T->getIndex()); 315 Record.push_back(T->isParameterPack()); 316 Writer.AddDeclRef(T->getDecl(), Record); 317 Code = TYPE_TEMPLATE_TYPE_PARM; 318 } 319 320 void 321 ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) { 322 Record.push_back(T->getKeyword()); 323 Writer.AddNestedNameSpecifier(T->getQualifier(), Record); 324 Writer.AddIdentifierRef(T->getIdentifier(), Record); 325 Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType() 326 : T->getCanonicalTypeInternal(), 327 Record); 328 Code = TYPE_DEPENDENT_NAME; 329 } 330 331 void 332 ASTTypeWriter::VisitDependentTemplateSpecializationType( 333 const DependentTemplateSpecializationType *T) { 334 Record.push_back(T->getKeyword()); 335 Writer.AddNestedNameSpecifier(T->getQualifier(), Record); 336 Writer.AddIdentifierRef(T->getIdentifier(), Record); 337 Record.push_back(T->getNumArgs()); 338 for (DependentTemplateSpecializationType::iterator 339 I = T->begin(), E = T->end(); I != E; ++I) 340 Writer.AddTemplateArgument(*I, Record); 341 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION; 342 } 343 344 void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) { 345 Writer.AddTypeRef(T->getPattern(), Record); 346 if (llvm::Optional<unsigned> NumExpansions = T->getNumExpansions()) 347 Record.push_back(*NumExpansions + 1); 348 else 349 Record.push_back(0); 350 Code = TYPE_PACK_EXPANSION; 351 } 352 353 void ASTTypeWriter::VisitParenType(const ParenType *T) { 354 Writer.AddTypeRef(T->getInnerType(), Record); 355 Code = TYPE_PAREN; 356 } 357 358 void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) { 359 Record.push_back(T->getKeyword()); 360 Writer.AddNestedNameSpecifier(T->getQualifier(), Record); 361 Writer.AddTypeRef(T->getNamedType(), Record); 362 Code = TYPE_ELABORATED; 363 } 364 365 void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) { 366 Writer.AddDeclRef(T->getDecl(), Record); 367 Writer.AddTypeRef(T->getInjectedSpecializationType(), Record); 368 Code = TYPE_INJECTED_CLASS_NAME; 369 } 370 371 void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) { 372 Writer.AddDeclRef(T->getDecl(), Record); 373 Code = TYPE_OBJC_INTERFACE; 374 } 375 376 void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) { 377 Writer.AddTypeRef(T->getBaseType(), Record); 378 Record.push_back(T->getNumProtocols()); 379 for (ObjCObjectType::qual_iterator I = T->qual_begin(), 380 E = T->qual_end(); I != E; ++I) 381 Writer.AddDeclRef(*I, Record); 382 Code = TYPE_OBJC_OBJECT; 383 } 384 385 void 386 ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) { 387 Writer.AddTypeRef(T->getPointeeType(), Record); 388 Code = TYPE_OBJC_OBJECT_POINTER; 389 } 390 391 void 392 ASTTypeWriter::VisitAtomicType(const AtomicType *T) { 393 Writer.AddTypeRef(T->getValueType(), Record); 394 Code = TYPE_ATOMIC; 395 } 396 397 namespace { 398 399 class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> { 400 ASTWriter &Writer; 401 ASTWriter::RecordDataImpl &Record; 402 403 public: 404 TypeLocWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record) 405 : Writer(Writer), Record(Record) { } 406 407 #define ABSTRACT_TYPELOC(CLASS, PARENT) 408 #define TYPELOC(CLASS, PARENT) \ 409 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc); 410 #include "clang/AST/TypeLocNodes.def" 411 412 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc); 413 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc); 414 }; 415 416 } 417 418 void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) { 419 // nothing to do 420 } 421 void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) { 422 Writer.AddSourceLocation(TL.getBuiltinLoc(), Record); 423 if (TL.needsExtraLocalData()) { 424 Record.push_back(TL.getWrittenTypeSpec()); 425 Record.push_back(TL.getWrittenSignSpec()); 426 Record.push_back(TL.getWrittenWidthSpec()); 427 Record.push_back(TL.hasModeAttr()); 428 } 429 } 430 void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) { 431 Writer.AddSourceLocation(TL.getNameLoc(), Record); 432 } 433 void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) { 434 Writer.AddSourceLocation(TL.getStarLoc(), Record); 435 } 436 void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) { 437 Writer.AddSourceLocation(TL.getCaretLoc(), Record); 438 } 439 void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) { 440 Writer.AddSourceLocation(TL.getAmpLoc(), Record); 441 } 442 void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) { 443 Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record); 444 } 445 void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) { 446 Writer.AddSourceLocation(TL.getStarLoc(), Record); 447 Writer.AddTypeSourceInfo(TL.getClassTInfo(), Record); 448 } 449 void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) { 450 Writer.AddSourceLocation(TL.getLBracketLoc(), Record); 451 Writer.AddSourceLocation(TL.getRBracketLoc(), Record); 452 Record.push_back(TL.getSizeExpr() ? 1 : 0); 453 if (TL.getSizeExpr()) 454 Writer.AddStmt(TL.getSizeExpr()); 455 } 456 void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) { 457 VisitArrayTypeLoc(TL); 458 } 459 void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) { 460 VisitArrayTypeLoc(TL); 461 } 462 void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) { 463 VisitArrayTypeLoc(TL); 464 } 465 void TypeLocWriter::VisitDependentSizedArrayTypeLoc( 466 DependentSizedArrayTypeLoc TL) { 467 VisitArrayTypeLoc(TL); 468 } 469 void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc( 470 DependentSizedExtVectorTypeLoc TL) { 471 Writer.AddSourceLocation(TL.getNameLoc(), Record); 472 } 473 void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) { 474 Writer.AddSourceLocation(TL.getNameLoc(), Record); 475 } 476 void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) { 477 Writer.AddSourceLocation(TL.getNameLoc(), Record); 478 } 479 void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) { 480 Writer.AddSourceLocation(TL.getLocalRangeBegin(), Record); 481 Writer.AddSourceLocation(TL.getLocalRangeEnd(), Record); 482 Record.push_back(TL.getTrailingReturn()); 483 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i) 484 Writer.AddDeclRef(TL.getArg(i), Record); 485 } 486 void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) { 487 VisitFunctionTypeLoc(TL); 488 } 489 void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) { 490 VisitFunctionTypeLoc(TL); 491 } 492 void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) { 493 Writer.AddSourceLocation(TL.getNameLoc(), Record); 494 } 495 void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) { 496 Writer.AddSourceLocation(TL.getNameLoc(), Record); 497 } 498 void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) { 499 Writer.AddSourceLocation(TL.getTypeofLoc(), Record); 500 Writer.AddSourceLocation(TL.getLParenLoc(), Record); 501 Writer.AddSourceLocation(TL.getRParenLoc(), Record); 502 } 503 void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) { 504 Writer.AddSourceLocation(TL.getTypeofLoc(), Record); 505 Writer.AddSourceLocation(TL.getLParenLoc(), Record); 506 Writer.AddSourceLocation(TL.getRParenLoc(), Record); 507 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record); 508 } 509 void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) { 510 Writer.AddSourceLocation(TL.getNameLoc(), Record); 511 } 512 void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) { 513 Writer.AddSourceLocation(TL.getKWLoc(), Record); 514 Writer.AddSourceLocation(TL.getLParenLoc(), Record); 515 Writer.AddSourceLocation(TL.getRParenLoc(), Record); 516 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record); 517 } 518 void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) { 519 Writer.AddSourceLocation(TL.getNameLoc(), Record); 520 } 521 void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) { 522 Writer.AddSourceLocation(TL.getNameLoc(), Record); 523 } 524 void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) { 525 Writer.AddSourceLocation(TL.getNameLoc(), Record); 526 } 527 void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) { 528 Writer.AddSourceLocation(TL.getAttrNameLoc(), Record); 529 if (TL.hasAttrOperand()) { 530 SourceRange range = TL.getAttrOperandParensRange(); 531 Writer.AddSourceLocation(range.getBegin(), Record); 532 Writer.AddSourceLocation(range.getEnd(), Record); 533 } 534 if (TL.hasAttrExprOperand()) { 535 Expr *operand = TL.getAttrExprOperand(); 536 Record.push_back(operand ? 1 : 0); 537 if (operand) Writer.AddStmt(operand); 538 } else if (TL.hasAttrEnumOperand()) { 539 Writer.AddSourceLocation(TL.getAttrEnumOperandLoc(), Record); 540 } 541 } 542 void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) { 543 Writer.AddSourceLocation(TL.getNameLoc(), Record); 544 } 545 void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc( 546 SubstTemplateTypeParmTypeLoc TL) { 547 Writer.AddSourceLocation(TL.getNameLoc(), Record); 548 } 549 void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc( 550 SubstTemplateTypeParmPackTypeLoc TL) { 551 Writer.AddSourceLocation(TL.getNameLoc(), Record); 552 } 553 void TypeLocWriter::VisitTemplateSpecializationTypeLoc( 554 TemplateSpecializationTypeLoc TL) { 555 Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record); 556 Writer.AddSourceLocation(TL.getLAngleLoc(), Record); 557 Writer.AddSourceLocation(TL.getRAngleLoc(), Record); 558 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i) 559 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(), 560 TL.getArgLoc(i).getLocInfo(), Record); 561 } 562 void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) { 563 Writer.AddSourceLocation(TL.getLParenLoc(), Record); 564 Writer.AddSourceLocation(TL.getRParenLoc(), Record); 565 } 566 void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) { 567 Writer.AddSourceLocation(TL.getKeywordLoc(), Record); 568 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record); 569 } 570 void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) { 571 Writer.AddSourceLocation(TL.getNameLoc(), Record); 572 } 573 void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) { 574 Writer.AddSourceLocation(TL.getKeywordLoc(), Record); 575 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record); 576 Writer.AddSourceLocation(TL.getNameLoc(), Record); 577 } 578 void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc( 579 DependentTemplateSpecializationTypeLoc TL) { 580 Writer.AddSourceLocation(TL.getKeywordLoc(), Record); 581 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record); 582 Writer.AddSourceLocation(TL.getNameLoc(), Record); 583 Writer.AddSourceLocation(TL.getLAngleLoc(), Record); 584 Writer.AddSourceLocation(TL.getRAngleLoc(), Record); 585 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) 586 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(), 587 TL.getArgLoc(I).getLocInfo(), Record); 588 } 589 void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) { 590 Writer.AddSourceLocation(TL.getEllipsisLoc(), Record); 591 } 592 void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) { 593 Writer.AddSourceLocation(TL.getNameLoc(), Record); 594 } 595 void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) { 596 Record.push_back(TL.hasBaseTypeAsWritten()); 597 Writer.AddSourceLocation(TL.getLAngleLoc(), Record); 598 Writer.AddSourceLocation(TL.getRAngleLoc(), Record); 599 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i) 600 Writer.AddSourceLocation(TL.getProtocolLoc(i), Record); 601 } 602 void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) { 603 Writer.AddSourceLocation(TL.getStarLoc(), Record); 604 } 605 void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) { 606 Writer.AddSourceLocation(TL.getKWLoc(), Record); 607 Writer.AddSourceLocation(TL.getLParenLoc(), Record); 608 Writer.AddSourceLocation(TL.getRParenLoc(), Record); 609 } 610 611 //===----------------------------------------------------------------------===// 612 // ASTWriter Implementation 613 //===----------------------------------------------------------------------===// 614 615 static void EmitBlockID(unsigned ID, const char *Name, 616 llvm::BitstreamWriter &Stream, 617 ASTWriter::RecordDataImpl &Record) { 618 Record.clear(); 619 Record.push_back(ID); 620 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record); 621 622 // Emit the block name if present. 623 if (Name == 0 || Name[0] == 0) return; 624 Record.clear(); 625 while (*Name) 626 Record.push_back(*Name++); 627 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record); 628 } 629 630 static void EmitRecordID(unsigned ID, const char *Name, 631 llvm::BitstreamWriter &Stream, 632 ASTWriter::RecordDataImpl &Record) { 633 Record.clear(); 634 Record.push_back(ID); 635 while (*Name) 636 Record.push_back(*Name++); 637 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record); 638 } 639 640 static void AddStmtsExprs(llvm::BitstreamWriter &Stream, 641 ASTWriter::RecordDataImpl &Record) { 642 #define RECORD(X) EmitRecordID(X, #X, Stream, Record) 643 RECORD(STMT_STOP); 644 RECORD(STMT_NULL_PTR); 645 RECORD(STMT_NULL); 646 RECORD(STMT_COMPOUND); 647 RECORD(STMT_CASE); 648 RECORD(STMT_DEFAULT); 649 RECORD(STMT_LABEL); 650 RECORD(STMT_IF); 651 RECORD(STMT_SWITCH); 652 RECORD(STMT_WHILE); 653 RECORD(STMT_DO); 654 RECORD(STMT_FOR); 655 RECORD(STMT_GOTO); 656 RECORD(STMT_INDIRECT_GOTO); 657 RECORD(STMT_CONTINUE); 658 RECORD(STMT_BREAK); 659 RECORD(STMT_RETURN); 660 RECORD(STMT_DECL); 661 RECORD(STMT_ASM); 662 RECORD(EXPR_PREDEFINED); 663 RECORD(EXPR_DECL_REF); 664 RECORD(EXPR_INTEGER_LITERAL); 665 RECORD(EXPR_FLOATING_LITERAL); 666 RECORD(EXPR_IMAGINARY_LITERAL); 667 RECORD(EXPR_STRING_LITERAL); 668 RECORD(EXPR_CHARACTER_LITERAL); 669 RECORD(EXPR_PAREN); 670 RECORD(EXPR_UNARY_OPERATOR); 671 RECORD(EXPR_SIZEOF_ALIGN_OF); 672 RECORD(EXPR_ARRAY_SUBSCRIPT); 673 RECORD(EXPR_CALL); 674 RECORD(EXPR_MEMBER); 675 RECORD(EXPR_BINARY_OPERATOR); 676 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR); 677 RECORD(EXPR_CONDITIONAL_OPERATOR); 678 RECORD(EXPR_IMPLICIT_CAST); 679 RECORD(EXPR_CSTYLE_CAST); 680 RECORD(EXPR_COMPOUND_LITERAL); 681 RECORD(EXPR_EXT_VECTOR_ELEMENT); 682 RECORD(EXPR_INIT_LIST); 683 RECORD(EXPR_DESIGNATED_INIT); 684 RECORD(EXPR_IMPLICIT_VALUE_INIT); 685 RECORD(EXPR_VA_ARG); 686 RECORD(EXPR_ADDR_LABEL); 687 RECORD(EXPR_STMT); 688 RECORD(EXPR_CHOOSE); 689 RECORD(EXPR_GNU_NULL); 690 RECORD(EXPR_SHUFFLE_VECTOR); 691 RECORD(EXPR_BLOCK); 692 RECORD(EXPR_BLOCK_DECL_REF); 693 RECORD(EXPR_GENERIC_SELECTION); 694 RECORD(EXPR_OBJC_STRING_LITERAL); 695 RECORD(EXPR_OBJC_ENCODE); 696 RECORD(EXPR_OBJC_SELECTOR_EXPR); 697 RECORD(EXPR_OBJC_PROTOCOL_EXPR); 698 RECORD(EXPR_OBJC_IVAR_REF_EXPR); 699 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR); 700 RECORD(EXPR_OBJC_KVC_REF_EXPR); 701 RECORD(EXPR_OBJC_MESSAGE_EXPR); 702 RECORD(STMT_OBJC_FOR_COLLECTION); 703 RECORD(STMT_OBJC_CATCH); 704 RECORD(STMT_OBJC_FINALLY); 705 RECORD(STMT_OBJC_AT_TRY); 706 RECORD(STMT_OBJC_AT_SYNCHRONIZED); 707 RECORD(STMT_OBJC_AT_THROW); 708 RECORD(EXPR_CXX_OPERATOR_CALL); 709 RECORD(EXPR_CXX_CONSTRUCT); 710 RECORD(EXPR_CXX_STATIC_CAST); 711 RECORD(EXPR_CXX_DYNAMIC_CAST); 712 RECORD(EXPR_CXX_REINTERPRET_CAST); 713 RECORD(EXPR_CXX_CONST_CAST); 714 RECORD(EXPR_CXX_FUNCTIONAL_CAST); 715 RECORD(EXPR_CXX_BOOL_LITERAL); 716 RECORD(EXPR_CXX_NULL_PTR_LITERAL); 717 RECORD(EXPR_CXX_TYPEID_EXPR); 718 RECORD(EXPR_CXX_TYPEID_TYPE); 719 RECORD(EXPR_CXX_UUIDOF_EXPR); 720 RECORD(EXPR_CXX_UUIDOF_TYPE); 721 RECORD(EXPR_CXX_THIS); 722 RECORD(EXPR_CXX_THROW); 723 RECORD(EXPR_CXX_DEFAULT_ARG); 724 RECORD(EXPR_CXX_BIND_TEMPORARY); 725 RECORD(EXPR_CXX_SCALAR_VALUE_INIT); 726 RECORD(EXPR_CXX_NEW); 727 RECORD(EXPR_CXX_DELETE); 728 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR); 729 RECORD(EXPR_EXPR_WITH_CLEANUPS); 730 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER); 731 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF); 732 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT); 733 RECORD(EXPR_CXX_UNRESOLVED_MEMBER); 734 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP); 735 RECORD(EXPR_CXX_UNARY_TYPE_TRAIT); 736 RECORD(EXPR_CXX_NOEXCEPT); 737 RECORD(EXPR_OPAQUE_VALUE); 738 RECORD(EXPR_BINARY_TYPE_TRAIT); 739 RECORD(EXPR_PACK_EXPANSION); 740 RECORD(EXPR_SIZEOF_PACK); 741 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK); 742 RECORD(EXPR_CUDA_KERNEL_CALL); 743 #undef RECORD 744 } 745 746 void ASTWriter::WriteBlockInfoBlock() { 747 RecordData Record; 748 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3); 749 750 #define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record) 751 #define RECORD(X) EmitRecordID(X, #X, Stream, Record) 752 753 // AST Top-Level Block. 754 BLOCK(AST_BLOCK); 755 RECORD(ORIGINAL_FILE_NAME); 756 RECORD(ORIGINAL_FILE_ID); 757 RECORD(TYPE_OFFSET); 758 RECORD(DECL_OFFSET); 759 RECORD(LANGUAGE_OPTIONS); 760 RECORD(METADATA); 761 RECORD(IDENTIFIER_OFFSET); 762 RECORD(IDENTIFIER_TABLE); 763 RECORD(EXTERNAL_DEFINITIONS); 764 RECORD(SPECIAL_TYPES); 765 RECORD(STATISTICS); 766 RECORD(TENTATIVE_DEFINITIONS); 767 RECORD(UNUSED_FILESCOPED_DECLS); 768 RECORD(LOCALLY_SCOPED_EXTERNAL_DECLS); 769 RECORD(SELECTOR_OFFSETS); 770 RECORD(METHOD_POOL); 771 RECORD(PP_COUNTER_VALUE); 772 RECORD(SOURCE_LOCATION_OFFSETS); 773 RECORD(SOURCE_LOCATION_PRELOADS); 774 RECORD(STAT_CACHE); 775 RECORD(EXT_VECTOR_DECLS); 776 RECORD(VERSION_CONTROL_BRANCH_REVISION); 777 RECORD(PPD_ENTITIES_OFFSETS); 778 RECORD(IMPORTS); 779 RECORD(REFERENCED_SELECTOR_POOL); 780 RECORD(TU_UPDATE_LEXICAL); 781 RECORD(REDECLS_UPDATE_LATEST); 782 RECORD(SEMA_DECL_REFS); 783 RECORD(WEAK_UNDECLARED_IDENTIFIERS); 784 RECORD(PENDING_IMPLICIT_INSTANTIATIONS); 785 RECORD(DECL_REPLACEMENTS); 786 RECORD(UPDATE_VISIBLE); 787 RECORD(DECL_UPDATE_OFFSETS); 788 RECORD(DECL_UPDATES); 789 RECORD(CXX_BASE_SPECIFIER_OFFSETS); 790 RECORD(DIAG_PRAGMA_MAPPINGS); 791 RECORD(CUDA_SPECIAL_DECL_REFS); 792 RECORD(HEADER_SEARCH_TABLE); 793 RECORD(ORIGINAL_PCH_DIR); 794 RECORD(FP_PRAGMA_OPTIONS); 795 RECORD(OPENCL_EXTENSIONS); 796 RECORD(DELEGATING_CTORS); 797 RECORD(FILE_SOURCE_LOCATION_OFFSETS); 798 RECORD(KNOWN_NAMESPACES); 799 RECORD(MODULE_OFFSET_MAP); 800 RECORD(SOURCE_MANAGER_LINE_TABLE); 801 802 // SourceManager Block. 803 BLOCK(SOURCE_MANAGER_BLOCK); 804 RECORD(SM_SLOC_FILE_ENTRY); 805 RECORD(SM_SLOC_BUFFER_ENTRY); 806 RECORD(SM_SLOC_BUFFER_BLOB); 807 RECORD(SM_SLOC_EXPANSION_ENTRY); 808 809 // Preprocessor Block. 810 BLOCK(PREPROCESSOR_BLOCK); 811 RECORD(PP_MACRO_OBJECT_LIKE); 812 RECORD(PP_MACRO_FUNCTION_LIKE); 813 RECORD(PP_TOKEN); 814 815 // Decls and Types block. 816 BLOCK(DECLTYPES_BLOCK); 817 RECORD(TYPE_EXT_QUAL); 818 RECORD(TYPE_COMPLEX); 819 RECORD(TYPE_POINTER); 820 RECORD(TYPE_BLOCK_POINTER); 821 RECORD(TYPE_LVALUE_REFERENCE); 822 RECORD(TYPE_RVALUE_REFERENCE); 823 RECORD(TYPE_MEMBER_POINTER); 824 RECORD(TYPE_CONSTANT_ARRAY); 825 RECORD(TYPE_INCOMPLETE_ARRAY); 826 RECORD(TYPE_VARIABLE_ARRAY); 827 RECORD(TYPE_VECTOR); 828 RECORD(TYPE_EXT_VECTOR); 829 RECORD(TYPE_FUNCTION_PROTO); 830 RECORD(TYPE_FUNCTION_NO_PROTO); 831 RECORD(TYPE_TYPEDEF); 832 RECORD(TYPE_TYPEOF_EXPR); 833 RECORD(TYPE_TYPEOF); 834 RECORD(TYPE_RECORD); 835 RECORD(TYPE_ENUM); 836 RECORD(TYPE_OBJC_INTERFACE); 837 RECORD(TYPE_OBJC_OBJECT); 838 RECORD(TYPE_OBJC_OBJECT_POINTER); 839 RECORD(TYPE_DECLTYPE); 840 RECORD(TYPE_ELABORATED); 841 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM); 842 RECORD(TYPE_UNRESOLVED_USING); 843 RECORD(TYPE_INJECTED_CLASS_NAME); 844 RECORD(TYPE_OBJC_OBJECT); 845 RECORD(TYPE_TEMPLATE_TYPE_PARM); 846 RECORD(TYPE_TEMPLATE_SPECIALIZATION); 847 RECORD(TYPE_DEPENDENT_NAME); 848 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION); 849 RECORD(TYPE_DEPENDENT_SIZED_ARRAY); 850 RECORD(TYPE_PAREN); 851 RECORD(TYPE_PACK_EXPANSION); 852 RECORD(TYPE_ATTRIBUTED); 853 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK); 854 RECORD(TYPE_ATOMIC); 855 RECORD(DECL_TYPEDEF); 856 RECORD(DECL_ENUM); 857 RECORD(DECL_RECORD); 858 RECORD(DECL_ENUM_CONSTANT); 859 RECORD(DECL_FUNCTION); 860 RECORD(DECL_OBJC_METHOD); 861 RECORD(DECL_OBJC_INTERFACE); 862 RECORD(DECL_OBJC_PROTOCOL); 863 RECORD(DECL_OBJC_IVAR); 864 RECORD(DECL_OBJC_AT_DEFS_FIELD); 865 RECORD(DECL_OBJC_CLASS); 866 RECORD(DECL_OBJC_FORWARD_PROTOCOL); 867 RECORD(DECL_OBJC_CATEGORY); 868 RECORD(DECL_OBJC_CATEGORY_IMPL); 869 RECORD(DECL_OBJC_IMPLEMENTATION); 870 RECORD(DECL_OBJC_COMPATIBLE_ALIAS); 871 RECORD(DECL_OBJC_PROPERTY); 872 RECORD(DECL_OBJC_PROPERTY_IMPL); 873 RECORD(DECL_FIELD); 874 RECORD(DECL_VAR); 875 RECORD(DECL_IMPLICIT_PARAM); 876 RECORD(DECL_PARM_VAR); 877 RECORD(DECL_FILE_SCOPE_ASM); 878 RECORD(DECL_BLOCK); 879 RECORD(DECL_CONTEXT_LEXICAL); 880 RECORD(DECL_CONTEXT_VISIBLE); 881 RECORD(DECL_NAMESPACE); 882 RECORD(DECL_NAMESPACE_ALIAS); 883 RECORD(DECL_USING); 884 RECORD(DECL_USING_SHADOW); 885 RECORD(DECL_USING_DIRECTIVE); 886 RECORD(DECL_UNRESOLVED_USING_VALUE); 887 RECORD(DECL_UNRESOLVED_USING_TYPENAME); 888 RECORD(DECL_LINKAGE_SPEC); 889 RECORD(DECL_CXX_RECORD); 890 RECORD(DECL_CXX_METHOD); 891 RECORD(DECL_CXX_CONSTRUCTOR); 892 RECORD(DECL_CXX_DESTRUCTOR); 893 RECORD(DECL_CXX_CONVERSION); 894 RECORD(DECL_ACCESS_SPEC); 895 RECORD(DECL_FRIEND); 896 RECORD(DECL_FRIEND_TEMPLATE); 897 RECORD(DECL_CLASS_TEMPLATE); 898 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION); 899 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION); 900 RECORD(DECL_FUNCTION_TEMPLATE); 901 RECORD(DECL_TEMPLATE_TYPE_PARM); 902 RECORD(DECL_NON_TYPE_TEMPLATE_PARM); 903 RECORD(DECL_TEMPLATE_TEMPLATE_PARM); 904 RECORD(DECL_STATIC_ASSERT); 905 RECORD(DECL_CXX_BASE_SPECIFIERS); 906 RECORD(DECL_INDIRECTFIELD); 907 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK); 908 909 // Statements and Exprs can occur in the Decls and Types block. 910 AddStmtsExprs(Stream, Record); 911 912 BLOCK(PREPROCESSOR_DETAIL_BLOCK); 913 RECORD(PPD_MACRO_EXPANSION); 914 RECORD(PPD_MACRO_DEFINITION); 915 RECORD(PPD_INCLUSION_DIRECTIVE); 916 917 #undef RECORD 918 #undef BLOCK 919 Stream.ExitBlock(); 920 } 921 922 /// \brief Adjusts the given filename to only write out the portion of the 923 /// filename that is not part of the system root directory. 924 /// 925 /// \param Filename the file name to adjust. 926 /// 927 /// \param isysroot When non-NULL, the PCH file is a relocatable PCH file and 928 /// the returned filename will be adjusted by this system root. 929 /// 930 /// \returns either the original filename (if it needs no adjustment) or the 931 /// adjusted filename (which points into the @p Filename parameter). 932 static const char * 933 adjustFilenameForRelocatablePCH(const char *Filename, StringRef isysroot) { 934 assert(Filename && "No file name to adjust?"); 935 936 if (isysroot.empty()) 937 return Filename; 938 939 // Verify that the filename and the system root have the same prefix. 940 unsigned Pos = 0; 941 for (; Filename[Pos] && Pos < isysroot.size(); ++Pos) 942 if (Filename[Pos] != isysroot[Pos]) 943 return Filename; // Prefixes don't match. 944 945 // We hit the end of the filename before we hit the end of the system root. 946 if (!Filename[Pos]) 947 return Filename; 948 949 // If the file name has a '/' at the current position, skip over the '/'. 950 // We distinguish sysroot-based includes from absolute includes by the 951 // absence of '/' at the beginning of sysroot-based includes. 952 if (Filename[Pos] == '/') 953 ++Pos; 954 955 return Filename + Pos; 956 } 957 958 /// \brief Write the AST metadata (e.g., i686-apple-darwin9). 959 void ASTWriter::WriteMetadata(ASTContext &Context, StringRef isysroot, 960 const std::string &OutputFile) { 961 using namespace llvm; 962 963 // Metadata 964 const TargetInfo &Target = Context.getTargetInfo(); 965 BitCodeAbbrev *MetaAbbrev = new BitCodeAbbrev(); 966 MetaAbbrev->Add(BitCodeAbbrevOp(METADATA)); 967 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // AST major 968 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // AST minor 969 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang major 970 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang minor 971 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable 972 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Target triple 973 unsigned MetaAbbrevCode = Stream.EmitAbbrev(MetaAbbrev); 974 975 RecordData Record; 976 Record.push_back(METADATA); 977 Record.push_back(VERSION_MAJOR); 978 Record.push_back(VERSION_MINOR); 979 Record.push_back(CLANG_VERSION_MAJOR); 980 Record.push_back(CLANG_VERSION_MINOR); 981 Record.push_back(!isysroot.empty()); 982 const std::string &Triple = Target.getTriple().getTriple(); 983 Stream.EmitRecordWithBlob(MetaAbbrevCode, Record, Triple); 984 985 if (Chain) { 986 serialization::ModuleManager &Mgr = Chain->getModuleManager(); 987 llvm::SmallVector<char, 128> ModulePaths; 988 Record.clear(); 989 990 for (ModuleManager::ModuleIterator M = Mgr.begin(), MEnd = Mgr.end(); 991 M != MEnd; ++M) { 992 // Skip modules that weren't directly imported. 993 if (!(*M)->isDirectlyImported()) 994 continue; 995 996 Record.push_back((unsigned)(*M)->Kind); // FIXME: Stable encoding 997 // FIXME: Write import location, once it matters. 998 // FIXME: This writes the absolute path for AST files we depend on. 999 const std::string &FileName = (*M)->FileName; 1000 Record.push_back(FileName.size()); 1001 Record.append(FileName.begin(), FileName.end()); 1002 } 1003 Stream.EmitRecord(IMPORTS, Record); 1004 } 1005 1006 // Original file name and file ID 1007 SourceManager &SM = Context.getSourceManager(); 1008 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) { 1009 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev(); 1010 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE_NAME)); 1011 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name 1012 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev); 1013 1014 llvm::SmallString<128> MainFilePath(MainFile->getName()); 1015 1016 llvm::sys::fs::make_absolute(MainFilePath); 1017 1018 const char *MainFileNameStr = MainFilePath.c_str(); 1019 MainFileNameStr = adjustFilenameForRelocatablePCH(MainFileNameStr, 1020 isysroot); 1021 RecordData Record; 1022 Record.push_back(ORIGINAL_FILE_NAME); 1023 Stream.EmitRecordWithBlob(FileAbbrevCode, Record, MainFileNameStr); 1024 1025 Record.clear(); 1026 Record.push_back(SM.getMainFileID().getOpaqueValue()); 1027 Stream.EmitRecord(ORIGINAL_FILE_ID, Record); 1028 } 1029 1030 // Original PCH directory 1031 if (!OutputFile.empty() && OutputFile != "-") { 1032 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1033 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR)); 1034 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name 1035 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev); 1036 1037 llvm::SmallString<128> OutputPath(OutputFile); 1038 1039 llvm::sys::fs::make_absolute(OutputPath); 1040 StringRef origDir = llvm::sys::path::parent_path(OutputPath); 1041 1042 RecordData Record; 1043 Record.push_back(ORIGINAL_PCH_DIR); 1044 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir); 1045 } 1046 1047 // Repository branch/version information. 1048 BitCodeAbbrev *RepoAbbrev = new BitCodeAbbrev(); 1049 RepoAbbrev->Add(BitCodeAbbrevOp(VERSION_CONTROL_BRANCH_REVISION)); 1050 RepoAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag 1051 unsigned RepoAbbrevCode = Stream.EmitAbbrev(RepoAbbrev); 1052 Record.clear(); 1053 Record.push_back(VERSION_CONTROL_BRANCH_REVISION); 1054 Stream.EmitRecordWithBlob(RepoAbbrevCode, Record, 1055 getClangFullRepositoryVersion()); 1056 } 1057 1058 /// \brief Write the LangOptions structure. 1059 void ASTWriter::WriteLanguageOptions(const LangOptions &LangOpts) { 1060 RecordData Record; 1061 #define LANGOPT(Name, Bits, Default, Description) \ 1062 Record.push_back(LangOpts.Name); 1063 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \ 1064 Record.push_back(static_cast<unsigned>(LangOpts.get##Name())); 1065 #include "clang/Basic/LangOptions.def" 1066 1067 Record.push_back(LangOpts.CurrentModule.size()); 1068 Record.append(LangOpts.CurrentModule.begin(), LangOpts.CurrentModule.end()); 1069 Stream.EmitRecord(LANGUAGE_OPTIONS, Record); 1070 } 1071 1072 //===----------------------------------------------------------------------===// 1073 // stat cache Serialization 1074 //===----------------------------------------------------------------------===// 1075 1076 namespace { 1077 // Trait used for the on-disk hash table of stat cache results. 1078 class ASTStatCacheTrait { 1079 public: 1080 typedef const char * key_type; 1081 typedef key_type key_type_ref; 1082 1083 typedef struct stat data_type; 1084 typedef const data_type &data_type_ref; 1085 1086 static unsigned ComputeHash(const char *path) { 1087 return llvm::HashString(path); 1088 } 1089 1090 std::pair<unsigned,unsigned> 1091 EmitKeyDataLength(raw_ostream& Out, const char *path, 1092 data_type_ref Data) { 1093 unsigned StrLen = strlen(path); 1094 clang::io::Emit16(Out, StrLen); 1095 unsigned DataLen = 4 + 4 + 2 + 8 + 8; 1096 clang::io::Emit8(Out, DataLen); 1097 return std::make_pair(StrLen + 1, DataLen); 1098 } 1099 1100 void EmitKey(raw_ostream& Out, const char *path, unsigned KeyLen) { 1101 Out.write(path, KeyLen); 1102 } 1103 1104 void EmitData(raw_ostream &Out, key_type_ref, 1105 data_type_ref Data, unsigned DataLen) { 1106 using namespace clang::io; 1107 uint64_t Start = Out.tell(); (void)Start; 1108 1109 Emit32(Out, (uint32_t) Data.st_ino); 1110 Emit32(Out, (uint32_t) Data.st_dev); 1111 Emit16(Out, (uint16_t) Data.st_mode); 1112 Emit64(Out, (uint64_t) Data.st_mtime); 1113 Emit64(Out, (uint64_t) Data.st_size); 1114 1115 assert(Out.tell() - Start == DataLen && "Wrong data length"); 1116 } 1117 }; 1118 } // end anonymous namespace 1119 1120 /// \brief Write the stat() system call cache to the AST file. 1121 void ASTWriter::WriteStatCache(MemorizeStatCalls &StatCalls) { 1122 // Build the on-disk hash table containing information about every 1123 // stat() call. 1124 OnDiskChainedHashTableGenerator<ASTStatCacheTrait> Generator; 1125 unsigned NumStatEntries = 0; 1126 for (MemorizeStatCalls::iterator Stat = StatCalls.begin(), 1127 StatEnd = StatCalls.end(); 1128 Stat != StatEnd; ++Stat, ++NumStatEntries) { 1129 StringRef Filename = Stat->first(); 1130 Generator.insert(Filename.data(), Stat->second); 1131 } 1132 1133 // Create the on-disk hash table in a buffer. 1134 llvm::SmallString<4096> StatCacheData; 1135 uint32_t BucketOffset; 1136 { 1137 llvm::raw_svector_ostream Out(StatCacheData); 1138 // Make sure that no bucket is at offset 0 1139 clang::io::Emit32(Out, 0); 1140 BucketOffset = Generator.Emit(Out); 1141 } 1142 1143 // Create a blob abbreviation 1144 using namespace llvm; 1145 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1146 Abbrev->Add(BitCodeAbbrevOp(STAT_CACHE)); 1147 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 1148 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 1149 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 1150 unsigned StatCacheAbbrev = Stream.EmitAbbrev(Abbrev); 1151 1152 // Write the stat cache 1153 RecordData Record; 1154 Record.push_back(STAT_CACHE); 1155 Record.push_back(BucketOffset); 1156 Record.push_back(NumStatEntries); 1157 Stream.EmitRecordWithBlob(StatCacheAbbrev, Record, StatCacheData.str()); 1158 } 1159 1160 //===----------------------------------------------------------------------===// 1161 // Source Manager Serialization 1162 //===----------------------------------------------------------------------===// 1163 1164 /// \brief Create an abbreviation for the SLocEntry that refers to a 1165 /// file. 1166 static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) { 1167 using namespace llvm; 1168 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1169 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY)); 1170 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset 1171 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location 1172 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic 1173 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives 1174 // FileEntry fields. 1175 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size 1176 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time 1177 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // BufferOverridden 1178 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs 1179 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex 1180 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls 1181 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name 1182 return Stream.EmitAbbrev(Abbrev); 1183 } 1184 1185 /// \brief Create an abbreviation for the SLocEntry that refers to a 1186 /// buffer. 1187 static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) { 1188 using namespace llvm; 1189 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1190 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY)); 1191 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset 1192 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location 1193 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic 1194 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives 1195 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob 1196 return Stream.EmitAbbrev(Abbrev); 1197 } 1198 1199 /// \brief Create an abbreviation for the SLocEntry that refers to a 1200 /// buffer's blob. 1201 static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) { 1202 using namespace llvm; 1203 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1204 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB)); 1205 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob 1206 return Stream.EmitAbbrev(Abbrev); 1207 } 1208 1209 /// \brief Create an abbreviation for the SLocEntry that refers to a macro 1210 /// expansion. 1211 static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) { 1212 using namespace llvm; 1213 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1214 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY)); 1215 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset 1216 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location 1217 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location 1218 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location 1219 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length 1220 return Stream.EmitAbbrev(Abbrev); 1221 } 1222 1223 namespace { 1224 // Trait used for the on-disk hash table of header search information. 1225 class HeaderFileInfoTrait { 1226 ASTWriter &Writer; 1227 const HeaderSearch &HS; 1228 1229 // Keep track of the framework names we've used during serialization. 1230 SmallVector<char, 128> FrameworkStringData; 1231 llvm::StringMap<unsigned> FrameworkNameOffset; 1232 1233 public: 1234 HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS) 1235 : Writer(Writer), HS(HS) { } 1236 1237 typedef const char *key_type; 1238 typedef key_type key_type_ref; 1239 1240 typedef HeaderFileInfo data_type; 1241 typedef const data_type &data_type_ref; 1242 1243 static unsigned ComputeHash(const char *path) { 1244 // The hash is based only on the filename portion of the key, so that the 1245 // reader can match based on filenames when symlinking or excess path 1246 // elements ("foo/../", "../") change the form of the name. However, 1247 // complete path is still the key. 1248 return llvm::HashString(llvm::sys::path::filename(path)); 1249 } 1250 1251 std::pair<unsigned,unsigned> 1252 EmitKeyDataLength(raw_ostream& Out, const char *path, 1253 data_type_ref Data) { 1254 unsigned StrLen = strlen(path); 1255 clang::io::Emit16(Out, StrLen); 1256 unsigned DataLen = 1 + 2 + 4 + 4; 1257 clang::io::Emit8(Out, DataLen); 1258 return std::make_pair(StrLen + 1, DataLen); 1259 } 1260 1261 void EmitKey(raw_ostream& Out, const char *path, unsigned KeyLen) { 1262 Out.write(path, KeyLen); 1263 } 1264 1265 void EmitData(raw_ostream &Out, key_type_ref, 1266 data_type_ref Data, unsigned DataLen) { 1267 using namespace clang::io; 1268 uint64_t Start = Out.tell(); (void)Start; 1269 1270 unsigned char Flags = (Data.isImport << 5) 1271 | (Data.isPragmaOnce << 4) 1272 | (Data.DirInfo << 2) 1273 | (Data.Resolved << 1) 1274 | Data.IndexHeaderMapHeader; 1275 Emit8(Out, (uint8_t)Flags); 1276 Emit16(Out, (uint16_t) Data.NumIncludes); 1277 1278 if (!Data.ControllingMacro) 1279 Emit32(Out, (uint32_t)Data.ControllingMacroID); 1280 else 1281 Emit32(Out, (uint32_t)Writer.getIdentifierRef(Data.ControllingMacro)); 1282 1283 unsigned Offset = 0; 1284 if (!Data.Framework.empty()) { 1285 // If this header refers into a framework, save the framework name. 1286 llvm::StringMap<unsigned>::iterator Pos 1287 = FrameworkNameOffset.find(Data.Framework); 1288 if (Pos == FrameworkNameOffset.end()) { 1289 Offset = FrameworkStringData.size() + 1; 1290 FrameworkStringData.append(Data.Framework.begin(), 1291 Data.Framework.end()); 1292 FrameworkStringData.push_back(0); 1293 1294 FrameworkNameOffset[Data.Framework] = Offset; 1295 } else 1296 Offset = Pos->second; 1297 } 1298 Emit32(Out, Offset); 1299 1300 assert(Out.tell() - Start == DataLen && "Wrong data length"); 1301 } 1302 1303 const char *strings_begin() const { return FrameworkStringData.begin(); } 1304 const char *strings_end() const { return FrameworkStringData.end(); } 1305 }; 1306 } // end anonymous namespace 1307 1308 /// \brief Write the header search block for the list of files that 1309 /// 1310 /// \param HS The header search structure to save. 1311 /// 1312 /// \param Chain Whether we're creating a chained AST file. 1313 void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS, StringRef isysroot) { 1314 SmallVector<const FileEntry *, 16> FilesByUID; 1315 HS.getFileMgr().GetUniqueIDMapping(FilesByUID); 1316 1317 if (FilesByUID.size() > HS.header_file_size()) 1318 FilesByUID.resize(HS.header_file_size()); 1319 1320 HeaderFileInfoTrait GeneratorTrait(*this, HS); 1321 OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator; 1322 SmallVector<const char *, 4> SavedStrings; 1323 unsigned NumHeaderSearchEntries = 0; 1324 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) { 1325 const FileEntry *File = FilesByUID[UID]; 1326 if (!File) 1327 continue; 1328 1329 // Use HeaderSearch's getFileInfo to make sure we get the HeaderFileInfo 1330 // from the external source if it was not provided already. 1331 const HeaderFileInfo &HFI = HS.getFileInfo(File); 1332 if (HFI.External && Chain) 1333 continue; 1334 1335 // Turn the file name into an absolute path, if it isn't already. 1336 const char *Filename = File->getName(); 1337 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot); 1338 1339 // If we performed any translation on the file name at all, we need to 1340 // save this string, since the generator will refer to it later. 1341 if (Filename != File->getName()) { 1342 Filename = strdup(Filename); 1343 SavedStrings.push_back(Filename); 1344 } 1345 1346 Generator.insert(Filename, HFI, GeneratorTrait); 1347 ++NumHeaderSearchEntries; 1348 } 1349 1350 // Create the on-disk hash table in a buffer. 1351 llvm::SmallString<4096> TableData; 1352 uint32_t BucketOffset; 1353 { 1354 llvm::raw_svector_ostream Out(TableData); 1355 // Make sure that no bucket is at offset 0 1356 clang::io::Emit32(Out, 0); 1357 BucketOffset = Generator.Emit(Out, GeneratorTrait); 1358 } 1359 1360 // Create a blob abbreviation 1361 using namespace llvm; 1362 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1363 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE)); 1364 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 1365 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 1366 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 1367 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 1368 unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev); 1369 1370 // Write the header search table 1371 RecordData Record; 1372 Record.push_back(HEADER_SEARCH_TABLE); 1373 Record.push_back(BucketOffset); 1374 Record.push_back(NumHeaderSearchEntries); 1375 Record.push_back(TableData.size()); 1376 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end()); 1377 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData.str()); 1378 1379 // Free all of the strings we had to duplicate. 1380 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I) 1381 free((void*)SavedStrings[I]); 1382 } 1383 1384 /// \brief Writes the block containing the serialized form of the 1385 /// source manager. 1386 /// 1387 /// TODO: We should probably use an on-disk hash table (stored in a 1388 /// blob), indexed based on the file name, so that we only create 1389 /// entries for files that we actually need. In the common case (no 1390 /// errors), we probably won't have to create file entries for any of 1391 /// the files in the AST. 1392 void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr, 1393 const Preprocessor &PP, 1394 StringRef isysroot) { 1395 RecordData Record; 1396 1397 // Enter the source manager block. 1398 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3); 1399 1400 // Abbreviations for the various kinds of source-location entries. 1401 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream); 1402 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream); 1403 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream); 1404 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream); 1405 1406 // Write out the source location entry table. We skip the first 1407 // entry, which is always the same dummy entry. 1408 std::vector<uint32_t> SLocEntryOffsets; 1409 // Write out the offsets of only source location file entries. 1410 // We will go through them in ASTReader::validateFileEntries(). 1411 std::vector<uint32_t> SLocFileEntryOffsets; 1412 RecordData PreloadSLocs; 1413 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1); 1414 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); 1415 I != N; ++I) { 1416 // Get this source location entry. 1417 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I); 1418 1419 // Record the offset of this source-location entry. 1420 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo()); 1421 1422 // Figure out which record code to use. 1423 unsigned Code; 1424 if (SLoc->isFile()) { 1425 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache(); 1426 if (Cache->OrigEntry) { 1427 Code = SM_SLOC_FILE_ENTRY; 1428 SLocFileEntryOffsets.push_back(Stream.GetCurrentBitNo()); 1429 } else 1430 Code = SM_SLOC_BUFFER_ENTRY; 1431 } else 1432 Code = SM_SLOC_EXPANSION_ENTRY; 1433 Record.clear(); 1434 Record.push_back(Code); 1435 1436 // Starting offset of this entry within this module, so skip the dummy. 1437 Record.push_back(SLoc->getOffset() - 2); 1438 if (SLoc->isFile()) { 1439 const SrcMgr::FileInfo &File = SLoc->getFile(); 1440 Record.push_back(File.getIncludeLoc().getRawEncoding()); 1441 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding 1442 Record.push_back(File.hasLineDirectives()); 1443 1444 const SrcMgr::ContentCache *Content = File.getContentCache(); 1445 if (Content->OrigEntry) { 1446 assert(Content->OrigEntry == Content->ContentsEntry && 1447 "Writing to AST an overridden file is not supported"); 1448 1449 // The source location entry is a file. The blob associated 1450 // with this entry is the file name. 1451 1452 // Emit size/modification time for this file. 1453 Record.push_back(Content->OrigEntry->getSize()); 1454 Record.push_back(Content->OrigEntry->getModificationTime()); 1455 Record.push_back(Content->BufferOverridden); 1456 Record.push_back(File.NumCreatedFIDs); 1457 1458 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(SLoc); 1459 if (FDI != FileDeclIDs.end()) { 1460 Record.push_back(FDI->second->FirstDeclIndex); 1461 Record.push_back(FDI->second->DeclIDs.size()); 1462 } else { 1463 Record.push_back(0); 1464 Record.push_back(0); 1465 } 1466 1467 // Turn the file name into an absolute path, if it isn't already. 1468 const char *Filename = Content->OrigEntry->getName(); 1469 llvm::SmallString<128> FilePath(Filename); 1470 1471 // Ask the file manager to fixup the relative path for us. This will 1472 // honor the working directory. 1473 SourceMgr.getFileManager().FixupRelativePath(FilePath); 1474 1475 // FIXME: This call to make_absolute shouldn't be necessary, the 1476 // call to FixupRelativePath should always return an absolute path. 1477 llvm::sys::fs::make_absolute(FilePath); 1478 Filename = FilePath.c_str(); 1479 1480 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot); 1481 Stream.EmitRecordWithBlob(SLocFileAbbrv, Record, Filename); 1482 1483 if (Content->BufferOverridden) { 1484 Record.clear(); 1485 Record.push_back(SM_SLOC_BUFFER_BLOB); 1486 const llvm::MemoryBuffer *Buffer 1487 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager()); 1488 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, 1489 StringRef(Buffer->getBufferStart(), 1490 Buffer->getBufferSize() + 1)); 1491 } 1492 } else { 1493 // The source location entry is a buffer. The blob associated 1494 // with this entry contains the contents of the buffer. 1495 1496 // We add one to the size so that we capture the trailing NULL 1497 // that is required by llvm::MemoryBuffer::getMemBuffer (on 1498 // the reader side). 1499 const llvm::MemoryBuffer *Buffer 1500 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager()); 1501 const char *Name = Buffer->getBufferIdentifier(); 1502 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record, 1503 StringRef(Name, strlen(Name) + 1)); 1504 Record.clear(); 1505 Record.push_back(SM_SLOC_BUFFER_BLOB); 1506 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, 1507 StringRef(Buffer->getBufferStart(), 1508 Buffer->getBufferSize() + 1)); 1509 1510 if (strcmp(Name, "<built-in>") == 0) { 1511 PreloadSLocs.push_back(SLocEntryOffsets.size()); 1512 } 1513 } 1514 } else { 1515 // The source location entry is a macro expansion. 1516 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion(); 1517 Record.push_back(Expansion.getSpellingLoc().getRawEncoding()); 1518 Record.push_back(Expansion.getExpansionLocStart().getRawEncoding()); 1519 Record.push_back(Expansion.isMacroArgExpansion() ? 0 1520 : Expansion.getExpansionLocEnd().getRawEncoding()); 1521 1522 // Compute the token length for this macro expansion. 1523 unsigned NextOffset = SourceMgr.getNextLocalOffset(); 1524 if (I + 1 != N) 1525 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset(); 1526 Record.push_back(NextOffset - SLoc->getOffset() - 1); 1527 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record); 1528 } 1529 } 1530 1531 Stream.ExitBlock(); 1532 1533 if (SLocEntryOffsets.empty()) 1534 return; 1535 1536 // Write the source-location offsets table into the AST block. This 1537 // table is used for lazily loading source-location information. 1538 using namespace llvm; 1539 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1540 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS)); 1541 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs 1542 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size 1543 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets 1544 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev); 1545 1546 Record.clear(); 1547 Record.push_back(SOURCE_LOCATION_OFFSETS); 1548 Record.push_back(SLocEntryOffsets.size()); 1549 Record.push_back(SourceMgr.getNextLocalOffset() - 1); // skip dummy 1550 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record, data(SLocEntryOffsets)); 1551 1552 Abbrev = new BitCodeAbbrev(); 1553 Abbrev->Add(BitCodeAbbrevOp(FILE_SOURCE_LOCATION_OFFSETS)); 1554 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs 1555 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets 1556 unsigned SLocFileOffsetsAbbrev = Stream.EmitAbbrev(Abbrev); 1557 1558 Record.clear(); 1559 Record.push_back(FILE_SOURCE_LOCATION_OFFSETS); 1560 Record.push_back(SLocFileEntryOffsets.size()); 1561 Stream.EmitRecordWithBlob(SLocFileOffsetsAbbrev, Record, 1562 data(SLocFileEntryOffsets)); 1563 1564 // Write the source location entry preloads array, telling the AST 1565 // reader which source locations entries it should load eagerly. 1566 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs); 1567 1568 // Write the line table. It depends on remapping working, so it must come 1569 // after the source location offsets. 1570 if (SourceMgr.hasLineTable()) { 1571 LineTableInfo &LineTable = SourceMgr.getLineTable(); 1572 1573 Record.clear(); 1574 // Emit the file names 1575 Record.push_back(LineTable.getNumFilenames()); 1576 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I) { 1577 // Emit the file name 1578 const char *Filename = LineTable.getFilename(I); 1579 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot); 1580 unsigned FilenameLen = Filename? strlen(Filename) : 0; 1581 Record.push_back(FilenameLen); 1582 if (FilenameLen) 1583 Record.insert(Record.end(), Filename, Filename + FilenameLen); 1584 } 1585 1586 // Emit the line entries 1587 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end(); 1588 L != LEnd; ++L) { 1589 // Only emit entries for local files. 1590 if (L->first < 0) 1591 continue; 1592 1593 // Emit the file ID 1594 Record.push_back(L->first); 1595 1596 // Emit the line entries 1597 Record.push_back(L->second.size()); 1598 for (std::vector<LineEntry>::iterator LE = L->second.begin(), 1599 LEEnd = L->second.end(); 1600 LE != LEEnd; ++LE) { 1601 Record.push_back(LE->FileOffset); 1602 Record.push_back(LE->LineNo); 1603 Record.push_back(LE->FilenameID); 1604 Record.push_back((unsigned)LE->FileKind); 1605 Record.push_back(LE->IncludeOffset); 1606 } 1607 } 1608 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record); 1609 } 1610 } 1611 1612 //===----------------------------------------------------------------------===// 1613 // Preprocessor Serialization 1614 //===----------------------------------------------------------------------===// 1615 1616 static int compareMacroDefinitions(const void *XPtr, const void *YPtr) { 1617 const std::pair<const IdentifierInfo *, MacroInfo *> &X = 1618 *(const std::pair<const IdentifierInfo *, MacroInfo *>*)XPtr; 1619 const std::pair<const IdentifierInfo *, MacroInfo *> &Y = 1620 *(const std::pair<const IdentifierInfo *, MacroInfo *>*)YPtr; 1621 return X.first->getName().compare(Y.first->getName()); 1622 } 1623 1624 /// \brief Writes the block containing the serialized form of the 1625 /// preprocessor. 1626 /// 1627 void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) { 1628 PreprocessingRecord *PPRec = PP.getPreprocessingRecord(); 1629 if (PPRec) 1630 WritePreprocessorDetail(*PPRec); 1631 1632 RecordData Record; 1633 1634 // If the preprocessor __COUNTER__ value has been bumped, remember it. 1635 if (PP.getCounterValue() != 0) { 1636 Record.push_back(PP.getCounterValue()); 1637 Stream.EmitRecord(PP_COUNTER_VALUE, Record); 1638 Record.clear(); 1639 } 1640 1641 // Enter the preprocessor block. 1642 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3); 1643 1644 // If the AST file contains __DATE__ or __TIME__ emit a warning about this. 1645 // FIXME: use diagnostics subsystem for localization etc. 1646 if (PP.SawDateOrTime()) 1647 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n"); 1648 1649 1650 // Loop over all the macro definitions that are live at the end of the file, 1651 // emitting each to the PP section. 1652 1653 // Construct the list of macro definitions that need to be serialized. 1654 SmallVector<std::pair<const IdentifierInfo *, MacroInfo *>, 2> 1655 MacrosToEmit; 1656 llvm::SmallPtrSet<const IdentifierInfo*, 4> MacroDefinitionsSeen; 1657 for (Preprocessor::macro_iterator I = PP.macro_begin(Chain == 0), 1658 E = PP.macro_end(Chain == 0); 1659 I != E; ++I) { 1660 if (!IsModule || I->second->isPublic()) { 1661 MacroDefinitionsSeen.insert(I->first); 1662 MacrosToEmit.push_back(std::make_pair(I->first, I->second)); 1663 } 1664 } 1665 1666 // Sort the set of macro definitions that need to be serialized by the 1667 // name of the macro, to provide a stable ordering. 1668 llvm::array_pod_sort(MacrosToEmit.begin(), MacrosToEmit.end(), 1669 &compareMacroDefinitions); 1670 1671 // Resolve any identifiers that defined macros at the time they were 1672 // deserialized, adding them to the list of macros to emit (if appropriate). 1673 for (unsigned I = 0, N = DeserializedMacroNames.size(); I != N; ++I) { 1674 IdentifierInfo *Name 1675 = const_cast<IdentifierInfo *>(DeserializedMacroNames[I]); 1676 if (Name->hasMacroDefinition() && MacroDefinitionsSeen.insert(Name)) 1677 MacrosToEmit.push_back(std::make_pair(Name, PP.getMacroInfo(Name))); 1678 } 1679 1680 for (unsigned I = 0, N = MacrosToEmit.size(); I != N; ++I) { 1681 const IdentifierInfo *Name = MacrosToEmit[I].first; 1682 MacroInfo *MI = MacrosToEmit[I].second; 1683 if (!MI) 1684 continue; 1685 1686 // Don't emit builtin macros like __LINE__ to the AST file unless they have 1687 // been redefined by the header (in which case they are not isBuiltinMacro). 1688 // Also skip macros from a AST file if we're chaining. 1689 1690 // FIXME: There is a (probably minor) optimization we could do here, if 1691 // the macro comes from the original PCH but the identifier comes from a 1692 // chained PCH, by storing the offset into the original PCH rather than 1693 // writing the macro definition a second time. 1694 if (MI->isBuiltinMacro() || 1695 (Chain && 1696 Name->isFromAST() && !Name->hasChangedSinceDeserialization() && 1697 MI->isFromAST() && !MI->hasChangedAfterLoad())) 1698 continue; 1699 1700 AddIdentifierRef(Name, Record); 1701 MacroOffsets[Name] = Stream.GetCurrentBitNo(); 1702 Record.push_back(MI->getDefinitionLoc().getRawEncoding()); 1703 Record.push_back(MI->isUsed()); 1704 Record.push_back(MI->isPublic()); 1705 AddSourceLocation(MI->getVisibilityLocation(), Record); 1706 unsigned Code; 1707 if (MI->isObjectLike()) { 1708 Code = PP_MACRO_OBJECT_LIKE; 1709 } else { 1710 Code = PP_MACRO_FUNCTION_LIKE; 1711 1712 Record.push_back(MI->isC99Varargs()); 1713 Record.push_back(MI->isGNUVarargs()); 1714 Record.push_back(MI->getNumArgs()); 1715 for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end(); 1716 I != E; ++I) 1717 AddIdentifierRef(*I, Record); 1718 } 1719 1720 // If we have a detailed preprocessing record, record the macro definition 1721 // ID that corresponds to this macro. 1722 if (PPRec) 1723 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]); 1724 1725 Stream.EmitRecord(Code, Record); 1726 Record.clear(); 1727 1728 // Emit the tokens array. 1729 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) { 1730 // Note that we know that the preprocessor does not have any annotation 1731 // tokens in it because they are created by the parser, and thus can't be 1732 // in a macro definition. 1733 const Token &Tok = MI->getReplacementToken(TokNo); 1734 1735 Record.push_back(Tok.getLocation().getRawEncoding()); 1736 Record.push_back(Tok.getLength()); 1737 1738 // FIXME: When reading literal tokens, reconstruct the literal pointer if 1739 // it is needed. 1740 AddIdentifierRef(Tok.getIdentifierInfo(), Record); 1741 // FIXME: Should translate token kind to a stable encoding. 1742 Record.push_back(Tok.getKind()); 1743 // FIXME: Should translate token flags to a stable encoding. 1744 Record.push_back(Tok.getFlags()); 1745 1746 Stream.EmitRecord(PP_TOKEN, Record); 1747 Record.clear(); 1748 } 1749 ++NumMacros; 1750 } 1751 Stream.ExitBlock(); 1752 } 1753 1754 void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) { 1755 if (PPRec.local_begin() == PPRec.local_end()) 1756 return; 1757 1758 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets; 1759 1760 // Enter the preprocessor block. 1761 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3); 1762 1763 // If the preprocessor has a preprocessing record, emit it. 1764 unsigned NumPreprocessingRecords = 0; 1765 using namespace llvm; 1766 1767 // Set up the abbreviation for 1768 unsigned InclusionAbbrev = 0; 1769 { 1770 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1771 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE)); 1772 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length 1773 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes 1774 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind 1775 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 1776 InclusionAbbrev = Stream.EmitAbbrev(Abbrev); 1777 } 1778 1779 unsigned FirstPreprocessorEntityID 1780 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0) 1781 + NUM_PREDEF_PP_ENTITY_IDS; 1782 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID; 1783 RecordData Record; 1784 for (PreprocessingRecord::iterator E = PPRec.local_begin(), 1785 EEnd = PPRec.local_end(); 1786 E != EEnd; 1787 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) { 1788 Record.clear(); 1789 1790 PreprocessedEntityOffsets.push_back(PPEntityOffset((*E)->getSourceRange(), 1791 Stream.GetCurrentBitNo())); 1792 1793 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) { 1794 // Record this macro definition's ID. 1795 MacroDefinitions[MD] = NextPreprocessorEntityID; 1796 1797 AddIdentifierRef(MD->getName(), Record); 1798 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record); 1799 continue; 1800 } 1801 1802 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(*E)) { 1803 Record.push_back(ME->isBuiltinMacro()); 1804 if (ME->isBuiltinMacro()) 1805 AddIdentifierRef(ME->getName(), Record); 1806 else 1807 Record.push_back(MacroDefinitions[ME->getDefinition()]); 1808 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record); 1809 continue; 1810 } 1811 1812 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) { 1813 Record.push_back(PPD_INCLUSION_DIRECTIVE); 1814 Record.push_back(ID->getFileName().size()); 1815 Record.push_back(ID->wasInQuotes()); 1816 Record.push_back(static_cast<unsigned>(ID->getKind())); 1817 llvm::SmallString<64> Buffer; 1818 Buffer += ID->getFileName(); 1819 Buffer += ID->getFile()->getName(); 1820 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer); 1821 continue; 1822 } 1823 1824 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter"); 1825 } 1826 Stream.ExitBlock(); 1827 1828 // Write the offsets table for the preprocessing record. 1829 if (NumPreprocessingRecords > 0) { 1830 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords); 1831 1832 // Write the offsets table for identifier IDs. 1833 using namespace llvm; 1834 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1835 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS)); 1836 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity 1837 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 1838 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev); 1839 1840 Record.clear(); 1841 Record.push_back(PPD_ENTITIES_OFFSETS); 1842 Record.push_back(FirstPreprocessorEntityID - NUM_PREDEF_PP_ENTITY_IDS); 1843 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record, 1844 data(PreprocessedEntityOffsets)); 1845 } 1846 } 1847 1848 unsigned ASTWriter::getSubmoduleID(Module *Mod) { 1849 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod); 1850 if (Known != SubmoduleIDs.end()) 1851 return Known->second; 1852 1853 return SubmoduleIDs[Mod] = NextSubmoduleID++; 1854 } 1855 1856 /// \brief Compute the number of modules within the given tree (including the 1857 /// given module). 1858 static unsigned getNumberOfModules(Module *Mod) { 1859 unsigned ChildModules = 0; 1860 for (llvm::StringMap<Module *>::iterator Sub = Mod->SubModules.begin(), 1861 SubEnd = Mod->SubModules.end(); 1862 Sub != SubEnd; ++Sub) 1863 ChildModules += getNumberOfModules(Sub->getValue()); 1864 1865 return ChildModules + 1; 1866 } 1867 1868 void ASTWriter::WriteSubmodules(Module *WritingModule) { 1869 // Determine the dependencies of our module and each of it's submodules. 1870 // FIXME: This feels like it belongs somewhere else, but there are no 1871 // other consumers of this information. 1872 SourceManager &SrcMgr = PP->getSourceManager(); 1873 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap(); 1874 for (ASTContext::import_iterator I = Context->local_import_begin(), 1875 IEnd = Context->local_import_end(); 1876 I != IEnd; ++I) { 1877 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end()); 1878 if (Module *ImportedFrom 1879 = ModMap.inferModuleFromLocation(FullSourceLoc(I->getLocation(), 1880 SrcMgr))) { 1881 ImportedFrom->Imports.push_back(I->getImportedModule()); 1882 } 1883 } 1884 1885 // Enter the submodule description block. 1886 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, NUM_ALLOWED_ABBREVS_SIZE); 1887 1888 // Write the abbreviations needed for the submodules block. 1889 using namespace llvm; 1890 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 1891 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION)); 1892 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID 1893 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent 1894 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework 1895 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit 1896 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit... 1897 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit 1898 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild... 1899 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 1900 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev); 1901 1902 Abbrev = new BitCodeAbbrev(); 1903 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER)); 1904 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 1905 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev); 1906 1907 Abbrev = new BitCodeAbbrev(); 1908 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER)); 1909 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 1910 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev); 1911 1912 Abbrev = new BitCodeAbbrev(); 1913 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR)); 1914 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name 1915 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev); 1916 1917 // Write the submodule metadata block. 1918 RecordData Record; 1919 Record.push_back(getNumberOfModules(WritingModule)); 1920 Record.push_back(FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS); 1921 Stream.EmitRecord(SUBMODULE_METADATA, Record); 1922 1923 // Write all of the submodules. 1924 std::queue<Module *> Q; 1925 Q.push(WritingModule); 1926 while (!Q.empty()) { 1927 Module *Mod = Q.front(); 1928 Q.pop(); 1929 unsigned ID = getSubmoduleID(Mod); 1930 1931 // Emit the definition of the block. 1932 Record.clear(); 1933 Record.push_back(SUBMODULE_DEFINITION); 1934 Record.push_back(ID); 1935 if (Mod->Parent) { 1936 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?"); 1937 Record.push_back(SubmoduleIDs[Mod->Parent]); 1938 } else { 1939 Record.push_back(0); 1940 } 1941 Record.push_back(Mod->IsFramework); 1942 Record.push_back(Mod->IsExplicit); 1943 Record.push_back(Mod->InferSubmodules); 1944 Record.push_back(Mod->InferExplicitSubmodules); 1945 Record.push_back(Mod->InferExportWildcard); 1946 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name); 1947 1948 // Emit the umbrella header, if there is one. 1949 if (const FileEntry *UmbrellaHeader = Mod->getUmbrellaHeader()) { 1950 Record.clear(); 1951 Record.push_back(SUBMODULE_UMBRELLA_HEADER); 1952 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record, 1953 UmbrellaHeader->getName()); 1954 } else if (const DirectoryEntry *UmbrellaDir = Mod->getUmbrellaDir()) { 1955 Record.clear(); 1956 Record.push_back(SUBMODULE_UMBRELLA_DIR); 1957 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record, 1958 UmbrellaDir->getName()); 1959 } 1960 1961 // Emit the headers. 1962 for (unsigned I = 0, N = Mod->Headers.size(); I != N; ++I) { 1963 Record.clear(); 1964 Record.push_back(SUBMODULE_HEADER); 1965 Stream.EmitRecordWithBlob(HeaderAbbrev, Record, 1966 Mod->Headers[I]->getName()); 1967 } 1968 1969 // Emit the imports. 1970 if (!Mod->Imports.empty()) { 1971 Record.clear(); 1972 for (unsigned I = 0, N = Mod->Imports.size(); I != N; ++I) { 1973 unsigned ImportedID = getSubmoduleID(Mod->Imports[I]); 1974 assert(ImportedID && "Unknown submodule!"); 1975 Record.push_back(ImportedID); 1976 } 1977 Stream.EmitRecord(SUBMODULE_IMPORTS, Record); 1978 } 1979 1980 // Emit the exports. 1981 if (!Mod->Exports.empty()) { 1982 Record.clear(); 1983 for (unsigned I = 0, N = Mod->Exports.size(); I != N; ++I) { 1984 if (Module *Exported = Mod->Exports[I].getPointer()) { 1985 unsigned ExportedID = SubmoduleIDs[Exported]; 1986 assert(ExportedID > 0 && "Unknown submodule ID?"); 1987 Record.push_back(ExportedID); 1988 } else { 1989 Record.push_back(0); 1990 } 1991 1992 Record.push_back(Mod->Exports[I].getInt()); 1993 } 1994 Stream.EmitRecord(SUBMODULE_EXPORTS, Record); 1995 } 1996 1997 // Queue up the submodules of this module. 1998 llvm::SmallVector<StringRef, 2> SubModules; 1999 2000 // Sort the submodules first, so we get a predictable ordering in the AST 2001 // file. 2002 for (llvm::StringMap<Module *>::iterator 2003 Sub = Mod->SubModules.begin(), 2004 SubEnd = Mod->SubModules.end(); 2005 Sub != SubEnd; ++Sub) 2006 SubModules.push_back(Sub->getKey()); 2007 llvm::array_pod_sort(SubModules.begin(), SubModules.end()); 2008 2009 for (unsigned I = 0, N = SubModules.size(); I != N; ++I) 2010 Q.push(Mod->SubModules[SubModules[I]]); 2011 } 2012 2013 Stream.ExitBlock(); 2014 2015 assert((NextSubmoduleID - FirstSubmoduleID 2016 == getNumberOfModules(WritingModule)) && "Wrong # of submodules"); 2017 } 2018 2019 serialization::SubmoduleID 2020 ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) { 2021 if (Loc.isInvalid() || !WritingModule) 2022 return 0; // No submodule 2023 2024 // Find the module that owns this location. 2025 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap(); 2026 Module *OwningMod 2027 = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager())); 2028 if (!OwningMod) 2029 return 0; 2030 2031 // Check whether this submodule is part of our own module. 2032 if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule)) 2033 return 0; 2034 2035 return getSubmoduleID(OwningMod); 2036 } 2037 2038 void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag) { 2039 RecordData Record; 2040 for (DiagnosticsEngine::DiagStatePointsTy::const_iterator 2041 I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end(); 2042 I != E; ++I) { 2043 const DiagnosticsEngine::DiagStatePoint &point = *I; 2044 if (point.Loc.isInvalid()) 2045 continue; 2046 2047 Record.push_back(point.Loc.getRawEncoding()); 2048 for (DiagnosticsEngine::DiagState::const_iterator 2049 I = point.State->begin(), E = point.State->end(); I != E; ++I) { 2050 if (I->second.isPragma()) { 2051 Record.push_back(I->first); 2052 Record.push_back(I->second.getMapping()); 2053 } 2054 } 2055 Record.push_back(-1); // mark the end of the diag/map pairs for this 2056 // location. 2057 } 2058 2059 if (!Record.empty()) 2060 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record); 2061 } 2062 2063 void ASTWriter::WriteCXXBaseSpecifiersOffsets() { 2064 if (CXXBaseSpecifiersOffsets.empty()) 2065 return; 2066 2067 RecordData Record; 2068 2069 // Create a blob abbreviation for the C++ base specifiers offsets. 2070 using namespace llvm; 2071 2072 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 2073 Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS)); 2074 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size 2075 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2076 unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev); 2077 2078 // Write the base specifier offsets table. 2079 Record.clear(); 2080 Record.push_back(CXX_BASE_SPECIFIER_OFFSETS); 2081 Record.push_back(CXXBaseSpecifiersOffsets.size()); 2082 Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record, 2083 data(CXXBaseSpecifiersOffsets)); 2084 } 2085 2086 //===----------------------------------------------------------------------===// 2087 // Type Serialization 2088 //===----------------------------------------------------------------------===// 2089 2090 /// \brief Write the representation of a type to the AST stream. 2091 void ASTWriter::WriteType(QualType T) { 2092 TypeIdx &Idx = TypeIdxs[T]; 2093 if (Idx.getIndex() == 0) // we haven't seen this type before. 2094 Idx = TypeIdx(NextTypeID++); 2095 2096 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST"); 2097 2098 // Record the offset for this type. 2099 unsigned Index = Idx.getIndex() - FirstTypeID; 2100 if (TypeOffsets.size() == Index) 2101 TypeOffsets.push_back(Stream.GetCurrentBitNo()); 2102 else if (TypeOffsets.size() < Index) { 2103 TypeOffsets.resize(Index + 1); 2104 TypeOffsets[Index] = Stream.GetCurrentBitNo(); 2105 } 2106 2107 RecordData Record; 2108 2109 // Emit the type's representation. 2110 ASTTypeWriter W(*this, Record); 2111 2112 if (T.hasLocalNonFastQualifiers()) { 2113 Qualifiers Qs = T.getLocalQualifiers(); 2114 AddTypeRef(T.getLocalUnqualifiedType(), Record); 2115 Record.push_back(Qs.getAsOpaqueValue()); 2116 W.Code = TYPE_EXT_QUAL; 2117 } else { 2118 switch (T->getTypeClass()) { 2119 // For all of the concrete, non-dependent types, call the 2120 // appropriate visitor function. 2121 #define TYPE(Class, Base) \ 2122 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break; 2123 #define ABSTRACT_TYPE(Class, Base) 2124 #include "clang/AST/TypeNodes.def" 2125 } 2126 } 2127 2128 // Emit the serialized record. 2129 Stream.EmitRecord(W.Code, Record); 2130 2131 // Flush any expressions that were written as part of this type. 2132 FlushStmts(); 2133 } 2134 2135 //===----------------------------------------------------------------------===// 2136 // Declaration Serialization 2137 //===----------------------------------------------------------------------===// 2138 2139 /// \brief Write the block containing all of the declaration IDs 2140 /// lexically declared within the given DeclContext. 2141 /// 2142 /// \returns the offset of the DECL_CONTEXT_LEXICAL block within the 2143 /// bistream, or 0 if no block was written. 2144 uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context, 2145 DeclContext *DC) { 2146 if (DC->decls_empty()) 2147 return 0; 2148 2149 uint64_t Offset = Stream.GetCurrentBitNo(); 2150 RecordData Record; 2151 Record.push_back(DECL_CONTEXT_LEXICAL); 2152 SmallVector<KindDeclIDPair, 64> Decls; 2153 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end(); 2154 D != DEnd; ++D) 2155 Decls.push_back(std::make_pair((*D)->getKind(), GetDeclRef(*D))); 2156 2157 ++NumLexicalDeclContexts; 2158 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record, data(Decls)); 2159 return Offset; 2160 } 2161 2162 void ASTWriter::WriteTypeDeclOffsets() { 2163 using namespace llvm; 2164 RecordData Record; 2165 2166 // Write the type offsets array 2167 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 2168 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET)); 2169 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types 2170 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index 2171 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block 2172 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev); 2173 Record.clear(); 2174 Record.push_back(TYPE_OFFSET); 2175 Record.push_back(TypeOffsets.size()); 2176 Record.push_back(FirstTypeID - NUM_PREDEF_TYPE_IDS); 2177 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, data(TypeOffsets)); 2178 2179 // Write the declaration offsets array 2180 Abbrev = new BitCodeAbbrev(); 2181 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET)); 2182 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations 2183 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID 2184 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block 2185 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev); 2186 Record.clear(); 2187 Record.push_back(DECL_OFFSET); 2188 Record.push_back(DeclOffsets.size()); 2189 Record.push_back(FirstDeclID - NUM_PREDEF_DECL_IDS); 2190 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, data(DeclOffsets)); 2191 } 2192 2193 void ASTWriter::WriteFileDeclIDsMap() { 2194 using namespace llvm; 2195 RecordData Record; 2196 2197 // Join the vectors of DeclIDs from all files. 2198 SmallVector<DeclID, 256> FileSortedIDs; 2199 for (FileDeclIDsTy::iterator 2200 FI = FileDeclIDs.begin(), FE = FileDeclIDs.end(); FI != FE; ++FI) { 2201 DeclIDInFileInfo &Info = *FI->second; 2202 Info.FirstDeclIndex = FileSortedIDs.size(); 2203 for (LocDeclIDsTy::iterator 2204 DI = Info.DeclIDs.begin(), DE = Info.DeclIDs.end(); DI != DE; ++DI) 2205 FileSortedIDs.push_back(DI->second); 2206 } 2207 2208 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 2209 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS)); 2210 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2211 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev); 2212 Record.push_back(FILE_SORTED_DECLS); 2213 Stream.EmitRecordWithBlob(AbbrevCode, Record, data(FileSortedIDs)); 2214 } 2215 2216 //===----------------------------------------------------------------------===// 2217 // Global Method Pool and Selector Serialization 2218 //===----------------------------------------------------------------------===// 2219 2220 namespace { 2221 // Trait used for the on-disk hash table used in the method pool. 2222 class ASTMethodPoolTrait { 2223 ASTWriter &Writer; 2224 2225 public: 2226 typedef Selector key_type; 2227 typedef key_type key_type_ref; 2228 2229 struct data_type { 2230 SelectorID ID; 2231 ObjCMethodList Instance, Factory; 2232 }; 2233 typedef const data_type& data_type_ref; 2234 2235 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { } 2236 2237 static unsigned ComputeHash(Selector Sel) { 2238 return serialization::ComputeHash(Sel); 2239 } 2240 2241 std::pair<unsigned,unsigned> 2242 EmitKeyDataLength(raw_ostream& Out, Selector Sel, 2243 data_type_ref Methods) { 2244 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4); 2245 clang::io::Emit16(Out, KeyLen); 2246 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts 2247 for (const ObjCMethodList *Method = &Methods.Instance; Method; 2248 Method = Method->Next) 2249 if (Method->Method) 2250 DataLen += 4; 2251 for (const ObjCMethodList *Method = &Methods.Factory; Method; 2252 Method = Method->Next) 2253 if (Method->Method) 2254 DataLen += 4; 2255 clang::io::Emit16(Out, DataLen); 2256 return std::make_pair(KeyLen, DataLen); 2257 } 2258 2259 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) { 2260 uint64_t Start = Out.tell(); 2261 assert((Start >> 32) == 0 && "Selector key offset too large"); 2262 Writer.SetSelectorOffset(Sel, Start); 2263 unsigned N = Sel.getNumArgs(); 2264 clang::io::Emit16(Out, N); 2265 if (N == 0) 2266 N = 1; 2267 for (unsigned I = 0; I != N; ++I) 2268 clang::io::Emit32(Out, 2269 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I))); 2270 } 2271 2272 void EmitData(raw_ostream& Out, key_type_ref, 2273 data_type_ref Methods, unsigned DataLen) { 2274 uint64_t Start = Out.tell(); (void)Start; 2275 clang::io::Emit32(Out, Methods.ID); 2276 unsigned NumInstanceMethods = 0; 2277 for (const ObjCMethodList *Method = &Methods.Instance; Method; 2278 Method = Method->Next) 2279 if (Method->Method) 2280 ++NumInstanceMethods; 2281 2282 unsigned NumFactoryMethods = 0; 2283 for (const ObjCMethodList *Method = &Methods.Factory; Method; 2284 Method = Method->Next) 2285 if (Method->Method) 2286 ++NumFactoryMethods; 2287 2288 clang::io::Emit16(Out, NumInstanceMethods); 2289 clang::io::Emit16(Out, NumFactoryMethods); 2290 for (const ObjCMethodList *Method = &Methods.Instance; Method; 2291 Method = Method->Next) 2292 if (Method->Method) 2293 clang::io::Emit32(Out, Writer.getDeclID(Method->Method)); 2294 for (const ObjCMethodList *Method = &Methods.Factory; Method; 2295 Method = Method->Next) 2296 if (Method->Method) 2297 clang::io::Emit32(Out, Writer.getDeclID(Method->Method)); 2298 2299 assert(Out.tell() - Start == DataLen && "Data length is wrong"); 2300 } 2301 }; 2302 } // end anonymous namespace 2303 2304 /// \brief Write ObjC data: selectors and the method pool. 2305 /// 2306 /// The method pool contains both instance and factory methods, stored 2307 /// in an on-disk hash table indexed by the selector. The hash table also 2308 /// contains an empty entry for every other selector known to Sema. 2309 void ASTWriter::WriteSelectors(Sema &SemaRef) { 2310 using namespace llvm; 2311 2312 // Do we have to do anything at all? 2313 if (SemaRef.MethodPool.empty() && SelectorIDs.empty()) 2314 return; 2315 unsigned NumTableEntries = 0; 2316 // Create and write out the blob that contains selectors and the method pool. 2317 { 2318 OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator; 2319 ASTMethodPoolTrait Trait(*this); 2320 2321 // Create the on-disk hash table representation. We walk through every 2322 // selector we've seen and look it up in the method pool. 2323 SelectorOffsets.resize(NextSelectorID - FirstSelectorID); 2324 for (llvm::DenseMap<Selector, SelectorID>::iterator 2325 I = SelectorIDs.begin(), E = SelectorIDs.end(); 2326 I != E; ++I) { 2327 Selector S = I->first; 2328 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S); 2329 ASTMethodPoolTrait::data_type Data = { 2330 I->second, 2331 ObjCMethodList(), 2332 ObjCMethodList() 2333 }; 2334 if (F != SemaRef.MethodPool.end()) { 2335 Data.Instance = F->second.first; 2336 Data.Factory = F->second.second; 2337 } 2338 // Only write this selector if it's not in an existing AST or something 2339 // changed. 2340 if (Chain && I->second < FirstSelectorID) { 2341 // Selector already exists. Did it change? 2342 bool changed = false; 2343 for (ObjCMethodList *M = &Data.Instance; !changed && M && M->Method; 2344 M = M->Next) { 2345 if (!M->Method->isFromASTFile()) 2346 changed = true; 2347 } 2348 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->Method; 2349 M = M->Next) { 2350 if (!M->Method->isFromASTFile()) 2351 changed = true; 2352 } 2353 if (!changed) 2354 continue; 2355 } else if (Data.Instance.Method || Data.Factory.Method) { 2356 // A new method pool entry. 2357 ++NumTableEntries; 2358 } 2359 Generator.insert(S, Data, Trait); 2360 } 2361 2362 // Create the on-disk hash table in a buffer. 2363 llvm::SmallString<4096> MethodPool; 2364 uint32_t BucketOffset; 2365 { 2366 ASTMethodPoolTrait Trait(*this); 2367 llvm::raw_svector_ostream Out(MethodPool); 2368 // Make sure that no bucket is at offset 0 2369 clang::io::Emit32(Out, 0); 2370 BucketOffset = Generator.Emit(Out, Trait); 2371 } 2372 2373 // Create a blob abbreviation 2374 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 2375 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL)); 2376 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2377 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2378 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2379 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev); 2380 2381 // Write the method pool 2382 RecordData Record; 2383 Record.push_back(METHOD_POOL); 2384 Record.push_back(BucketOffset); 2385 Record.push_back(NumTableEntries); 2386 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str()); 2387 2388 // Create a blob abbreviation for the selector table offsets. 2389 Abbrev = new BitCodeAbbrev(); 2390 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS)); 2391 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size 2392 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID 2393 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2394 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev); 2395 2396 // Write the selector offsets table. 2397 Record.clear(); 2398 Record.push_back(SELECTOR_OFFSETS); 2399 Record.push_back(SelectorOffsets.size()); 2400 Record.push_back(FirstSelectorID - NUM_PREDEF_SELECTOR_IDS); 2401 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record, 2402 data(SelectorOffsets)); 2403 } 2404 } 2405 2406 /// \brief Write the selectors referenced in @selector expression into AST file. 2407 void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) { 2408 using namespace llvm; 2409 if (SemaRef.ReferencedSelectors.empty()) 2410 return; 2411 2412 RecordData Record; 2413 2414 // Note: this writes out all references even for a dependent AST. But it is 2415 // very tricky to fix, and given that @selector shouldn't really appear in 2416 // headers, probably not worth it. It's not a correctness issue. 2417 for (DenseMap<Selector, SourceLocation>::iterator S = 2418 SemaRef.ReferencedSelectors.begin(), 2419 E = SemaRef.ReferencedSelectors.end(); S != E; ++S) { 2420 Selector Sel = (*S).first; 2421 SourceLocation Loc = (*S).second; 2422 AddSelectorRef(Sel, Record); 2423 AddSourceLocation(Loc, Record); 2424 } 2425 Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record); 2426 } 2427 2428 //===----------------------------------------------------------------------===// 2429 // Identifier Table Serialization 2430 //===----------------------------------------------------------------------===// 2431 2432 namespace { 2433 class ASTIdentifierTableTrait { 2434 ASTWriter &Writer; 2435 Preprocessor &PP; 2436 IdentifierResolver &IdResolver; 2437 bool IsModule; 2438 2439 /// \brief Determines whether this is an "interesting" identifier 2440 /// that needs a full IdentifierInfo structure written into the hash 2441 /// table. 2442 bool isInterestingIdentifier(IdentifierInfo *II, MacroInfo *&Macro) { 2443 if (II->isPoisoned() || 2444 II->isExtensionToken() || 2445 II->getObjCOrBuiltinID() || 2446 II->hasRevertedTokenIDToIdentifier() || 2447 II->getFETokenInfo<void>()) 2448 return true; 2449 2450 return hasMacroDefinition(II, Macro); 2451 } 2452 2453 bool hasMacroDefinition(IdentifierInfo *II, MacroInfo *&Macro) { 2454 if (!II->hasMacroDefinition()) 2455 return false; 2456 2457 if (Macro || (Macro = PP.getMacroInfo(II))) 2458 return !Macro->isBuiltinMacro() && (!IsModule || Macro->isPublic()); 2459 2460 return false; 2461 } 2462 2463 public: 2464 typedef IdentifierInfo* key_type; 2465 typedef key_type key_type_ref; 2466 2467 typedef IdentID data_type; 2468 typedef data_type data_type_ref; 2469 2470 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP, 2471 IdentifierResolver &IdResolver, bool IsModule) 2472 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule) { } 2473 2474 static unsigned ComputeHash(const IdentifierInfo* II) { 2475 return llvm::HashString(II->getName()); 2476 } 2477 2478 std::pair<unsigned,unsigned> 2479 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) { 2480 unsigned KeyLen = II->getLength() + 1; 2481 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1 2482 MacroInfo *Macro = 0; 2483 if (isInterestingIdentifier(II, Macro)) { 2484 DataLen += 2; // 2 bytes for builtin ID, flags 2485 if (hasMacroDefinition(II, Macro)) 2486 DataLen += 8; 2487 2488 for (IdentifierResolver::iterator D = IdResolver.begin(II), 2489 DEnd = IdResolver.end(); 2490 D != DEnd; ++D) 2491 DataLen += sizeof(DeclID); 2492 } 2493 clang::io::Emit16(Out, DataLen); 2494 // We emit the key length after the data length so that every 2495 // string is preceded by a 16-bit length. This matches the PTH 2496 // format for storing identifiers. 2497 clang::io::Emit16(Out, KeyLen); 2498 return std::make_pair(KeyLen, DataLen); 2499 } 2500 2501 void EmitKey(raw_ostream& Out, const IdentifierInfo* II, 2502 unsigned KeyLen) { 2503 // Record the location of the key data. This is used when generating 2504 // the mapping from persistent IDs to strings. 2505 Writer.SetIdentifierOffset(II, Out.tell()); 2506 Out.write(II->getNameStart(), KeyLen); 2507 } 2508 2509 void EmitData(raw_ostream& Out, IdentifierInfo* II, 2510 IdentID ID, unsigned) { 2511 MacroInfo *Macro = 0; 2512 if (!isInterestingIdentifier(II, Macro)) { 2513 clang::io::Emit32(Out, ID << 1); 2514 return; 2515 } 2516 2517 clang::io::Emit32(Out, (ID << 1) | 0x01); 2518 uint32_t Bits = 0; 2519 bool HasMacroDefinition = hasMacroDefinition(II, Macro); 2520 Bits = (uint32_t)II->getObjCOrBuiltinID(); 2521 Bits = (Bits << 1) | unsigned(HasMacroDefinition); 2522 Bits = (Bits << 1) | unsigned(II->isExtensionToken()); 2523 Bits = (Bits << 1) | unsigned(II->isPoisoned()); 2524 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier()); 2525 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword()); 2526 clang::io::Emit16(Out, Bits); 2527 2528 if (HasMacroDefinition) { 2529 clang::io::Emit32(Out, Writer.getMacroOffset(II)); 2530 clang::io::Emit32(Out, 2531 Writer.inferSubmoduleIDFromLocation(Macro->getDefinitionLoc())); 2532 } 2533 2534 // Emit the declaration IDs in reverse order, because the 2535 // IdentifierResolver provides the declarations as they would be 2536 // visible (e.g., the function "stat" would come before the struct 2537 // "stat"), but the ASTReader adds declarations to the end of the list 2538 // (so we need to see the struct "status" before the function "status"). 2539 // Only emit declarations that aren't from a chained PCH, though. 2540 SmallVector<Decl *, 16> Decls(IdResolver.begin(II), 2541 IdResolver.end()); 2542 for (SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(), 2543 DEnd = Decls.rend(); 2544 D != DEnd; ++D) 2545 clang::io::Emit32(Out, Writer.getDeclID(*D)); 2546 } 2547 }; 2548 } // end anonymous namespace 2549 2550 /// \brief Write the identifier table into the AST file. 2551 /// 2552 /// The identifier table consists of a blob containing string data 2553 /// (the actual identifiers themselves) and a separate "offsets" index 2554 /// that maps identifier IDs to locations within the blob. 2555 void ASTWriter::WriteIdentifierTable(Preprocessor &PP, 2556 IdentifierResolver &IdResolver, 2557 bool IsModule) { 2558 using namespace llvm; 2559 2560 // Create and write out the blob that contains the identifier 2561 // strings. 2562 { 2563 OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator; 2564 ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule); 2565 2566 // Look for any identifiers that were named while processing the 2567 // headers, but are otherwise not needed. We add these to the hash 2568 // table to enable checking of the predefines buffer in the case 2569 // where the user adds new macro definitions when building the AST 2570 // file. 2571 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(), 2572 IDEnd = PP.getIdentifierTable().end(); 2573 ID != IDEnd; ++ID) 2574 getIdentifierRef(ID->second); 2575 2576 // Create the on-disk hash table representation. We only store offsets 2577 // for identifiers that appear here for the first time. 2578 IdentifierOffsets.resize(NextIdentID - FirstIdentID); 2579 for (llvm::DenseMap<const IdentifierInfo *, IdentID>::iterator 2580 ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end(); 2581 ID != IDEnd; ++ID) { 2582 assert(ID->first && "NULL identifier in identifier table"); 2583 if (!Chain || !ID->first->isFromAST() || 2584 ID->first->hasChangedSinceDeserialization()) 2585 Generator.insert(const_cast<IdentifierInfo *>(ID->first), ID->second, 2586 Trait); 2587 } 2588 2589 // Create the on-disk hash table in a buffer. 2590 llvm::SmallString<4096> IdentifierTable; 2591 uint32_t BucketOffset; 2592 { 2593 ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule); 2594 llvm::raw_svector_ostream Out(IdentifierTable); 2595 // Make sure that no bucket is at offset 0 2596 clang::io::Emit32(Out, 0); 2597 BucketOffset = Generator.Emit(Out, Trait); 2598 } 2599 2600 // Create a blob abbreviation 2601 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 2602 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE)); 2603 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); 2604 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2605 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev); 2606 2607 // Write the identifier table 2608 RecordData Record; 2609 Record.push_back(IDENTIFIER_TABLE); 2610 Record.push_back(BucketOffset); 2611 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str()); 2612 } 2613 2614 // Write the offsets table for identifier IDs. 2615 BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 2616 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET)); 2617 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers 2618 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID 2619 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 2620 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev); 2621 2622 RecordData Record; 2623 Record.push_back(IDENTIFIER_OFFSET); 2624 Record.push_back(IdentifierOffsets.size()); 2625 Record.push_back(FirstIdentID - NUM_PREDEF_IDENT_IDS); 2626 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record, 2627 data(IdentifierOffsets)); 2628 } 2629 2630 //===----------------------------------------------------------------------===// 2631 // DeclContext's Name Lookup Table Serialization 2632 //===----------------------------------------------------------------------===// 2633 2634 namespace { 2635 // Trait used for the on-disk hash table used in the method pool. 2636 class ASTDeclContextNameLookupTrait { 2637 ASTWriter &Writer; 2638 2639 public: 2640 typedef DeclarationName key_type; 2641 typedef key_type key_type_ref; 2642 2643 typedef DeclContext::lookup_result data_type; 2644 typedef const data_type& data_type_ref; 2645 2646 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { } 2647 2648 unsigned ComputeHash(DeclarationName Name) { 2649 llvm::FoldingSetNodeID ID; 2650 ID.AddInteger(Name.getNameKind()); 2651 2652 switch (Name.getNameKind()) { 2653 case DeclarationName::Identifier: 2654 ID.AddString(Name.getAsIdentifierInfo()->getName()); 2655 break; 2656 case DeclarationName::ObjCZeroArgSelector: 2657 case DeclarationName::ObjCOneArgSelector: 2658 case DeclarationName::ObjCMultiArgSelector: 2659 ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector())); 2660 break; 2661 case DeclarationName::CXXConstructorName: 2662 case DeclarationName::CXXDestructorName: 2663 case DeclarationName::CXXConversionFunctionName: 2664 break; 2665 case DeclarationName::CXXOperatorName: 2666 ID.AddInteger(Name.getCXXOverloadedOperator()); 2667 break; 2668 case DeclarationName::CXXLiteralOperatorName: 2669 ID.AddString(Name.getCXXLiteralIdentifier()->getName()); 2670 case DeclarationName::CXXUsingDirective: 2671 break; 2672 } 2673 2674 return ID.ComputeHash(); 2675 } 2676 2677 std::pair<unsigned,unsigned> 2678 EmitKeyDataLength(raw_ostream& Out, DeclarationName Name, 2679 data_type_ref Lookup) { 2680 unsigned KeyLen = 1; 2681 switch (Name.getNameKind()) { 2682 case DeclarationName::Identifier: 2683 case DeclarationName::ObjCZeroArgSelector: 2684 case DeclarationName::ObjCOneArgSelector: 2685 case DeclarationName::ObjCMultiArgSelector: 2686 case DeclarationName::CXXLiteralOperatorName: 2687 KeyLen += 4; 2688 break; 2689 case DeclarationName::CXXOperatorName: 2690 KeyLen += 1; 2691 break; 2692 case DeclarationName::CXXConstructorName: 2693 case DeclarationName::CXXDestructorName: 2694 case DeclarationName::CXXConversionFunctionName: 2695 case DeclarationName::CXXUsingDirective: 2696 break; 2697 } 2698 clang::io::Emit16(Out, KeyLen); 2699 2700 // 2 bytes for num of decls and 4 for each DeclID. 2701 unsigned DataLen = 2 + 4 * (Lookup.second - Lookup.first); 2702 clang::io::Emit16(Out, DataLen); 2703 2704 return std::make_pair(KeyLen, DataLen); 2705 } 2706 2707 void EmitKey(raw_ostream& Out, DeclarationName Name, unsigned) { 2708 using namespace clang::io; 2709 2710 assert(Name.getNameKind() < 0x100 && "Invalid name kind ?"); 2711 Emit8(Out, Name.getNameKind()); 2712 switch (Name.getNameKind()) { 2713 case DeclarationName::Identifier: 2714 Emit32(Out, Writer.getIdentifierRef(Name.getAsIdentifierInfo())); 2715 break; 2716 case DeclarationName::ObjCZeroArgSelector: 2717 case DeclarationName::ObjCOneArgSelector: 2718 case DeclarationName::ObjCMultiArgSelector: 2719 Emit32(Out, Writer.getSelectorRef(Name.getObjCSelector())); 2720 break; 2721 case DeclarationName::CXXOperatorName: 2722 assert(Name.getCXXOverloadedOperator() < 0x100 && "Invalid operator ?"); 2723 Emit8(Out, Name.getCXXOverloadedOperator()); 2724 break; 2725 case DeclarationName::CXXLiteralOperatorName: 2726 Emit32(Out, Writer.getIdentifierRef(Name.getCXXLiteralIdentifier())); 2727 break; 2728 case DeclarationName::CXXConstructorName: 2729 case DeclarationName::CXXDestructorName: 2730 case DeclarationName::CXXConversionFunctionName: 2731 case DeclarationName::CXXUsingDirective: 2732 break; 2733 } 2734 } 2735 2736 void EmitData(raw_ostream& Out, key_type_ref, 2737 data_type Lookup, unsigned DataLen) { 2738 uint64_t Start = Out.tell(); (void)Start; 2739 clang::io::Emit16(Out, Lookup.second - Lookup.first); 2740 for (; Lookup.first != Lookup.second; ++Lookup.first) 2741 clang::io::Emit32(Out, Writer.GetDeclRef(*Lookup.first)); 2742 2743 assert(Out.tell() - Start == DataLen && "Data length is wrong"); 2744 } 2745 }; 2746 } // end anonymous namespace 2747 2748 /// \brief Write the block containing all of the declaration IDs 2749 /// visible from the given DeclContext. 2750 /// 2751 /// \returns the offset of the DECL_CONTEXT_VISIBLE block within the 2752 /// bitstream, or 0 if no block was written. 2753 uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context, 2754 DeclContext *DC) { 2755 if (DC->getPrimaryContext() != DC) 2756 return 0; 2757 2758 // Since there is no name lookup into functions or methods, don't bother to 2759 // build a visible-declarations table for these entities. 2760 if (DC->isFunctionOrMethod()) 2761 return 0; 2762 2763 // If not in C++, we perform name lookup for the translation unit via the 2764 // IdentifierInfo chains, don't bother to build a visible-declarations table. 2765 // FIXME: In C++ we need the visible declarations in order to "see" the 2766 // friend declarations, is there a way to do this without writing the table ? 2767 if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus) 2768 return 0; 2769 2770 // Force the DeclContext to build a its name-lookup table. 2771 if (!DC->hasExternalVisibleStorage()) 2772 DC->lookup(DeclarationName()); 2773 2774 // Serialize the contents of the mapping used for lookup. Note that, 2775 // although we have two very different code paths, the serialized 2776 // representation is the same for both cases: a declaration name, 2777 // followed by a size, followed by references to the visible 2778 // declarations that have that name. 2779 uint64_t Offset = Stream.GetCurrentBitNo(); 2780 StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr()); 2781 if (!Map || Map->empty()) 2782 return 0; 2783 2784 OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator; 2785 ASTDeclContextNameLookupTrait Trait(*this); 2786 2787 // Create the on-disk hash table representation. 2788 DeclarationName ConversionName; 2789 llvm::SmallVector<NamedDecl *, 4> ConversionDecls; 2790 for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end(); 2791 D != DEnd; ++D) { 2792 DeclarationName Name = D->first; 2793 DeclContext::lookup_result Result = D->second.getLookupResult(); 2794 if (Result.first != Result.second) { 2795 if (Name.getNameKind() == DeclarationName::CXXConversionFunctionName) { 2796 // Hash all conversion function names to the same name. The actual 2797 // type information in conversion function name is not used in the 2798 // key (since such type information is not stable across different 2799 // modules), so the intended effect is to coalesce all of the conversion 2800 // functions under a single key. 2801 if (!ConversionName) 2802 ConversionName = Name; 2803 ConversionDecls.append(Result.first, Result.second); 2804 continue; 2805 } 2806 2807 Generator.insert(Name, Result, Trait); 2808 } 2809 } 2810 2811 // Add the conversion functions 2812 if (!ConversionDecls.empty()) { 2813 Generator.insert(ConversionName, 2814 DeclContext::lookup_result(ConversionDecls.begin(), 2815 ConversionDecls.end()), 2816 Trait); 2817 } 2818 2819 // Create the on-disk hash table in a buffer. 2820 llvm::SmallString<4096> LookupTable; 2821 uint32_t BucketOffset; 2822 { 2823 llvm::raw_svector_ostream Out(LookupTable); 2824 // Make sure that no bucket is at offset 0 2825 clang::io::Emit32(Out, 0); 2826 BucketOffset = Generator.Emit(Out, Trait); 2827 } 2828 2829 // Write the lookup table 2830 RecordData Record; 2831 Record.push_back(DECL_CONTEXT_VISIBLE); 2832 Record.push_back(BucketOffset); 2833 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record, 2834 LookupTable.str()); 2835 2836 Stream.EmitRecord(DECL_CONTEXT_VISIBLE, Record); 2837 ++NumVisibleDeclContexts; 2838 return Offset; 2839 } 2840 2841 /// \brief Write an UPDATE_VISIBLE block for the given context. 2842 /// 2843 /// UPDATE_VISIBLE blocks contain the declarations that are added to an existing 2844 /// DeclContext in a dependent AST file. As such, they only exist for the TU 2845 /// (in C++) and for namespaces. 2846 void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) { 2847 StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr()); 2848 if (!Map || Map->empty()) 2849 return; 2850 2851 OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator; 2852 ASTDeclContextNameLookupTrait Trait(*this); 2853 2854 // Create the hash table. 2855 for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end(); 2856 D != DEnd; ++D) { 2857 DeclarationName Name = D->first; 2858 DeclContext::lookup_result Result = D->second.getLookupResult(); 2859 // For any name that appears in this table, the results are complete, i.e. 2860 // they overwrite results from previous PCHs. Merging is always a mess. 2861 if (Result.first != Result.second) 2862 Generator.insert(Name, Result, Trait); 2863 } 2864 2865 // Create the on-disk hash table in a buffer. 2866 llvm::SmallString<4096> LookupTable; 2867 uint32_t BucketOffset; 2868 { 2869 llvm::raw_svector_ostream Out(LookupTable); 2870 // Make sure that no bucket is at offset 0 2871 clang::io::Emit32(Out, 0); 2872 BucketOffset = Generator.Emit(Out, Trait); 2873 } 2874 2875 // Write the lookup table 2876 RecordData Record; 2877 Record.push_back(UPDATE_VISIBLE); 2878 Record.push_back(getDeclID(cast<Decl>(DC))); 2879 Record.push_back(BucketOffset); 2880 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable.str()); 2881 } 2882 2883 /// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions. 2884 void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) { 2885 RecordData Record; 2886 Record.push_back(Opts.fp_contract); 2887 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record); 2888 } 2889 2890 /// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions. 2891 void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) { 2892 if (!SemaRef.Context.getLangOptions().OpenCL) 2893 return; 2894 2895 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions(); 2896 RecordData Record; 2897 #define OPENCLEXT(nm) Record.push_back(Opts.nm); 2898 #include "clang/Basic/OpenCLExtensions.def" 2899 Stream.EmitRecord(OPENCL_EXTENSIONS, Record); 2900 } 2901 2902 //===----------------------------------------------------------------------===// 2903 // General Serialization Routines 2904 //===----------------------------------------------------------------------===// 2905 2906 /// \brief Write a record containing the given attributes. 2907 void ASTWriter::WriteAttributes(const AttrVec &Attrs, RecordDataImpl &Record) { 2908 Record.push_back(Attrs.size()); 2909 for (AttrVec::const_iterator i = Attrs.begin(), e = Attrs.end(); i != e; ++i){ 2910 const Attr * A = *i; 2911 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs 2912 AddSourceRange(A->getRange(), Record); 2913 2914 #include "clang/Serialization/AttrPCHWrite.inc" 2915 2916 } 2917 } 2918 2919 void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) { 2920 Record.push_back(Str.size()); 2921 Record.insert(Record.end(), Str.begin(), Str.end()); 2922 } 2923 2924 void ASTWriter::AddVersionTuple(const VersionTuple &Version, 2925 RecordDataImpl &Record) { 2926 Record.push_back(Version.getMajor()); 2927 if (llvm::Optional<unsigned> Minor = Version.getMinor()) 2928 Record.push_back(*Minor + 1); 2929 else 2930 Record.push_back(0); 2931 if (llvm::Optional<unsigned> Subminor = Version.getSubminor()) 2932 Record.push_back(*Subminor + 1); 2933 else 2934 Record.push_back(0); 2935 } 2936 2937 /// \brief Note that the identifier II occurs at the given offset 2938 /// within the identifier table. 2939 void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) { 2940 IdentID ID = IdentifierIDs[II]; 2941 // Only store offsets new to this AST file. Other identifier names are looked 2942 // up earlier in the chain and thus don't need an offset. 2943 if (ID >= FirstIdentID) 2944 IdentifierOffsets[ID - FirstIdentID] = Offset; 2945 } 2946 2947 /// \brief Note that the selector Sel occurs at the given offset 2948 /// within the method pool/selector table. 2949 void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) { 2950 unsigned ID = SelectorIDs[Sel]; 2951 assert(ID && "Unknown selector"); 2952 // Don't record offsets for selectors that are also available in a different 2953 // file. 2954 if (ID < FirstSelectorID) 2955 return; 2956 SelectorOffsets[ID - FirstSelectorID] = Offset; 2957 } 2958 2959 ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream) 2960 : Stream(Stream), Context(0), PP(0), Chain(0), WritingModule(0), 2961 WritingAST(false), 2962 FirstDeclID(NUM_PREDEF_DECL_IDS), NextDeclID(FirstDeclID), 2963 FirstTypeID(NUM_PREDEF_TYPE_IDS), NextTypeID(FirstTypeID), 2964 FirstIdentID(NUM_PREDEF_IDENT_IDS), NextIdentID(FirstIdentID), 2965 FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS), 2966 NextSubmoduleID(FirstSubmoduleID), 2967 FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID), 2968 CollectedStmts(&StmtsToEmit), 2969 NumStatements(0), NumMacros(0), NumLexicalDeclContexts(0), 2970 NumVisibleDeclContexts(0), 2971 NextCXXBaseSpecifiersID(1), 2972 DeclParmVarAbbrev(0), DeclContextLexicalAbbrev(0), 2973 DeclContextVisibleLookupAbbrev(0), UpdateVisibleAbbrev(0), 2974 DeclRefExprAbbrev(0), CharacterLiteralAbbrev(0), 2975 DeclRecordAbbrev(0), IntegerLiteralAbbrev(0), 2976 DeclTypedefAbbrev(0), 2977 DeclVarAbbrev(0), DeclFieldAbbrev(0), 2978 DeclEnumAbbrev(0), DeclObjCIvarAbbrev(0) 2979 { 2980 } 2981 2982 ASTWriter::~ASTWriter() { 2983 for (FileDeclIDsTy::iterator 2984 I = FileDeclIDs.begin(), E = FileDeclIDs.end(); I != E; ++I) 2985 delete I->second; 2986 } 2987 2988 void ASTWriter::WriteAST(Sema &SemaRef, MemorizeStatCalls *StatCalls, 2989 const std::string &OutputFile, 2990 Module *WritingModule, StringRef isysroot) { 2991 WritingAST = true; 2992 2993 // Emit the file header. 2994 Stream.Emit((unsigned)'C', 8); 2995 Stream.Emit((unsigned)'P', 8); 2996 Stream.Emit((unsigned)'C', 8); 2997 Stream.Emit((unsigned)'H', 8); 2998 2999 WriteBlockInfoBlock(); 3000 3001 Context = &SemaRef.Context; 3002 PP = &SemaRef.PP; 3003 this->WritingModule = WritingModule; 3004 WriteASTCore(SemaRef, StatCalls, isysroot, OutputFile, WritingModule); 3005 Context = 0; 3006 PP = 0; 3007 this->WritingModule = 0; 3008 3009 WritingAST = false; 3010 } 3011 3012 template<typename Vector> 3013 static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec, 3014 ASTWriter::RecordData &Record) { 3015 for (typename Vector::iterator I = Vec.begin(0, true), E = Vec.end(); 3016 I != E; ++I) { 3017 Writer.AddDeclRef(*I, Record); 3018 } 3019 } 3020 3021 void ASTWriter::WriteASTCore(Sema &SemaRef, MemorizeStatCalls *StatCalls, 3022 StringRef isysroot, 3023 const std::string &OutputFile, 3024 Module *WritingModule) { 3025 using namespace llvm; 3026 3027 // Make sure that the AST reader knows to finalize itself. 3028 if (Chain) 3029 Chain->finalizeForWriting(); 3030 3031 ASTContext &Context = SemaRef.Context; 3032 Preprocessor &PP = SemaRef.PP; 3033 3034 // Set up predefined declaration IDs. 3035 DeclIDs[Context.getTranslationUnitDecl()] = PREDEF_DECL_TRANSLATION_UNIT_ID; 3036 if (Context.ObjCIdDecl) 3037 DeclIDs[Context.ObjCIdDecl] = PREDEF_DECL_OBJC_ID_ID; 3038 if (Context.ObjCSelDecl) 3039 DeclIDs[Context.ObjCSelDecl] = PREDEF_DECL_OBJC_SEL_ID; 3040 if (Context.ObjCClassDecl) 3041 DeclIDs[Context.ObjCClassDecl] = PREDEF_DECL_OBJC_CLASS_ID; 3042 if (Context.Int128Decl) 3043 DeclIDs[Context.Int128Decl] = PREDEF_DECL_INT_128_ID; 3044 if (Context.UInt128Decl) 3045 DeclIDs[Context.UInt128Decl] = PREDEF_DECL_UNSIGNED_INT_128_ID; 3046 if (Context.ObjCInstanceTypeDecl) 3047 DeclIDs[Context.ObjCInstanceTypeDecl] = PREDEF_DECL_OBJC_INSTANCETYPE_ID; 3048 3049 if (!Chain) { 3050 // Make sure that we emit IdentifierInfos (and any attached 3051 // declarations) for builtins. We don't need to do this when we're 3052 // emitting chained PCH files, because all of the builtins will be 3053 // in the original PCH file. 3054 // FIXME: Modules won't like this at all. 3055 IdentifierTable &Table = PP.getIdentifierTable(); 3056 SmallVector<const char *, 32> BuiltinNames; 3057 Context.BuiltinInfo.GetBuiltinNames(BuiltinNames, 3058 Context.getLangOptions().NoBuiltin); 3059 for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I) 3060 getIdentifierRef(&Table.get(BuiltinNames[I])); 3061 } 3062 3063 // If there are any out-of-date identifiers, bring them up to date. 3064 if (ExternalPreprocessorSource *ExtSource = PP.getExternalSource()) { 3065 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(), 3066 IDEnd = PP.getIdentifierTable().end(); 3067 ID != IDEnd; ++ID) 3068 if (ID->second->isOutOfDate()) 3069 ExtSource->updateOutOfDateIdentifier(*ID->second); 3070 } 3071 3072 // Build a record containing all of the tentative definitions in this file, in 3073 // TentativeDefinitions order. Generally, this record will be empty for 3074 // headers. 3075 RecordData TentativeDefinitions; 3076 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions); 3077 3078 // Build a record containing all of the file scoped decls in this file. 3079 RecordData UnusedFileScopedDecls; 3080 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls, 3081 UnusedFileScopedDecls); 3082 3083 // Build a record containing all of the delegating constructors we still need 3084 // to resolve. 3085 RecordData DelegatingCtorDecls; 3086 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls); 3087 3088 // Write the set of weak, undeclared identifiers. We always write the 3089 // entire table, since later PCH files in a PCH chain are only interested in 3090 // the results at the end of the chain. 3091 RecordData WeakUndeclaredIdentifiers; 3092 if (!SemaRef.WeakUndeclaredIdentifiers.empty()) { 3093 for (llvm::DenseMap<IdentifierInfo*,WeakInfo>::iterator 3094 I = SemaRef.WeakUndeclaredIdentifiers.begin(), 3095 E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) { 3096 AddIdentifierRef(I->first, WeakUndeclaredIdentifiers); 3097 AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers); 3098 AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers); 3099 WeakUndeclaredIdentifiers.push_back(I->second.getUsed()); 3100 } 3101 } 3102 3103 // Build a record containing all of the locally-scoped external 3104 // declarations in this header file. Generally, this record will be 3105 // empty. 3106 RecordData LocallyScopedExternalDecls; 3107 // FIXME: This is filling in the AST file in densemap order which is 3108 // nondeterminstic! 3109 for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator 3110 TD = SemaRef.LocallyScopedExternalDecls.begin(), 3111 TDEnd = SemaRef.LocallyScopedExternalDecls.end(); 3112 TD != TDEnd; ++TD) { 3113 if (!TD->second->isFromASTFile()) 3114 AddDeclRef(TD->second, LocallyScopedExternalDecls); 3115 } 3116 3117 // Build a record containing all of the ext_vector declarations. 3118 RecordData ExtVectorDecls; 3119 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls); 3120 3121 // Build a record containing all of the VTable uses information. 3122 RecordData VTableUses; 3123 if (!SemaRef.VTableUses.empty()) { 3124 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) { 3125 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses); 3126 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses); 3127 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]); 3128 } 3129 } 3130 3131 // Build a record containing all of dynamic classes declarations. 3132 RecordData DynamicClasses; 3133 AddLazyVectorDecls(*this, SemaRef.DynamicClasses, DynamicClasses); 3134 3135 // Build a record containing all of pending implicit instantiations. 3136 RecordData PendingInstantiations; 3137 for (std::deque<Sema::PendingImplicitInstantiation>::iterator 3138 I = SemaRef.PendingInstantiations.begin(), 3139 N = SemaRef.PendingInstantiations.end(); I != N; ++I) { 3140 AddDeclRef(I->first, PendingInstantiations); 3141 AddSourceLocation(I->second, PendingInstantiations); 3142 } 3143 assert(SemaRef.PendingLocalImplicitInstantiations.empty() && 3144 "There are local ones at end of translation unit!"); 3145 3146 // Build a record containing some declaration references. 3147 RecordData SemaDeclRefs; 3148 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) { 3149 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs); 3150 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs); 3151 } 3152 3153 RecordData CUDASpecialDeclRefs; 3154 if (Context.getcudaConfigureCallDecl()) { 3155 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs); 3156 } 3157 3158 // Build a record containing all of the known namespaces. 3159 RecordData KnownNamespaces; 3160 for (llvm::DenseMap<NamespaceDecl*, bool>::iterator 3161 I = SemaRef.KnownNamespaces.begin(), 3162 IEnd = SemaRef.KnownNamespaces.end(); 3163 I != IEnd; ++I) { 3164 if (!I->second) 3165 AddDeclRef(I->first, KnownNamespaces); 3166 } 3167 3168 // Write the remaining AST contents. 3169 RecordData Record; 3170 Stream.EnterSubblock(AST_BLOCK_ID, 5); 3171 WriteMetadata(Context, isysroot, OutputFile); 3172 WriteLanguageOptions(Context.getLangOptions()); 3173 if (StatCalls && isysroot.empty()) 3174 WriteStatCache(*StatCalls); 3175 3176 // Create a lexical update block containing all of the declarations in the 3177 // translation unit that do not come from other AST files. 3178 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl(); 3179 SmallVector<KindDeclIDPair, 64> NewGlobalDecls; 3180 for (DeclContext::decl_iterator I = TU->noload_decls_begin(), 3181 E = TU->noload_decls_end(); 3182 I != E; ++I) { 3183 if (!(*I)->isFromASTFile()) 3184 NewGlobalDecls.push_back(std::make_pair((*I)->getKind(), GetDeclRef(*I))); 3185 } 3186 3187 llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev(); 3188 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL)); 3189 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)); 3190 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv); 3191 Record.clear(); 3192 Record.push_back(TU_UPDATE_LEXICAL); 3193 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record, 3194 data(NewGlobalDecls)); 3195 3196 // And a visible updates block for the translation unit. 3197 Abv = new llvm::BitCodeAbbrev(); 3198 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE)); 3199 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6)); 3200 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32)); 3201 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob)); 3202 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv); 3203 WriteDeclContextVisibleUpdate(TU); 3204 3205 // If the translation unit has an anonymous namespace, and we don't already 3206 // have an update block for it, write it as an update block. 3207 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) { 3208 ASTWriter::UpdateRecord &Record = DeclUpdates[TU]; 3209 if (Record.empty()) { 3210 Record.push_back(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE); 3211 Record.push_back(reinterpret_cast<uint64_t>(NS)); 3212 } 3213 } 3214 3215 // Resolve any declaration pointers within the declaration updates block. 3216 ResolveDeclUpdatesBlocks(); 3217 3218 // Form the record of special types. 3219 RecordData SpecialTypes; 3220 AddTypeRef(Context.getBuiltinVaListType(), SpecialTypes); 3221 AddTypeRef(Context.ObjCProtoType, SpecialTypes); 3222 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes); 3223 AddTypeRef(Context.getFILEType(), SpecialTypes); 3224 AddTypeRef(Context.getjmp_bufType(), SpecialTypes); 3225 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes); 3226 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes); 3227 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes); 3228 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes); 3229 AddTypeRef(Context.getucontext_tType(), SpecialTypes); 3230 3231 // Keep writing types and declarations until all types and 3232 // declarations have been written. 3233 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, NUM_ALLOWED_ABBREVS_SIZE); 3234 WriteDeclsBlockAbbrevs(); 3235 for (DeclsToRewriteTy::iterator I = DeclsToRewrite.begin(), 3236 E = DeclsToRewrite.end(); 3237 I != E; ++I) 3238 DeclTypesToEmit.push(const_cast<Decl*>(*I)); 3239 while (!DeclTypesToEmit.empty()) { 3240 DeclOrType DOT = DeclTypesToEmit.front(); 3241 DeclTypesToEmit.pop(); 3242 if (DOT.isType()) 3243 WriteType(DOT.getType()); 3244 else 3245 WriteDecl(Context, DOT.getDecl()); 3246 } 3247 Stream.ExitBlock(); 3248 3249 WriteFileDeclIDsMap(); 3250 WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot); 3251 3252 if (Chain) { 3253 // Write the mapping information describing our module dependencies and how 3254 // each of those modules were mapped into our own offset/ID space, so that 3255 // the reader can build the appropriate mapping to its own offset/ID space. 3256 // The map consists solely of a blob with the following format: 3257 // *(module-name-len:i16 module-name:len*i8 3258 // source-location-offset:i32 3259 // identifier-id:i32 3260 // preprocessed-entity-id:i32 3261 // macro-definition-id:i32 3262 // submodule-id:i32 3263 // selector-id:i32 3264 // declaration-id:i32 3265 // c++-base-specifiers-id:i32 3266 // type-id:i32) 3267 // 3268 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev(); 3269 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP)); 3270 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); 3271 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev); 3272 llvm::SmallString<2048> Buffer; 3273 { 3274 llvm::raw_svector_ostream Out(Buffer); 3275 for (ModuleManager::ModuleConstIterator M = Chain->ModuleMgr.begin(), 3276 MEnd = Chain->ModuleMgr.end(); 3277 M != MEnd; ++M) { 3278 StringRef FileName = (*M)->FileName; 3279 io::Emit16(Out, FileName.size()); 3280 Out.write(FileName.data(), FileName.size()); 3281 io::Emit32(Out, (*M)->SLocEntryBaseOffset); 3282 io::Emit32(Out, (*M)->BaseIdentifierID); 3283 io::Emit32(Out, (*M)->BasePreprocessedEntityID); 3284 io::Emit32(Out, (*M)->BaseSubmoduleID); 3285 io::Emit32(Out, (*M)->BaseSelectorID); 3286 io::Emit32(Out, (*M)->BaseDeclID); 3287 io::Emit32(Out, (*M)->BaseTypeIndex); 3288 } 3289 } 3290 Record.clear(); 3291 Record.push_back(MODULE_OFFSET_MAP); 3292 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record, 3293 Buffer.data(), Buffer.size()); 3294 } 3295 WritePreprocessor(PP, WritingModule != 0); 3296 WriteHeaderSearch(PP.getHeaderSearchInfo(), isysroot); 3297 WriteSelectors(SemaRef); 3298 WriteReferencedSelectorsPool(SemaRef); 3299 WriteIdentifierTable(PP, SemaRef.IdResolver, WritingModule != 0); 3300 WriteFPPragmaOptions(SemaRef.getFPOptions()); 3301 WriteOpenCLExtensions(SemaRef); 3302 3303 WriteTypeDeclOffsets(); 3304 WritePragmaDiagnosticMappings(Context.getDiagnostics()); 3305 3306 WriteCXXBaseSpecifiersOffsets(); 3307 3308 // If we're emitting a module, write out the submodule information. 3309 if (WritingModule) 3310 WriteSubmodules(WritingModule); 3311 3312 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes); 3313 3314 /// Build a record containing first declarations from a chained PCH and the 3315 /// most recent declarations in this AST that they point to. 3316 RecordData FirstLatestDeclIDs; 3317 for (FirstLatestDeclMap::iterator I = FirstLatestDecls.begin(), 3318 E = FirstLatestDecls.end(); 3319 I != E; ++I) { 3320 AddDeclRef(I->first, FirstLatestDeclIDs); 3321 AddDeclRef(I->second, FirstLatestDeclIDs); 3322 } 3323 3324 if (!FirstLatestDeclIDs.empty()) 3325 Stream.EmitRecord(REDECLS_UPDATE_LATEST, FirstLatestDeclIDs); 3326 3327 // Write the record containing external, unnamed definitions. 3328 if (!ExternalDefinitions.empty()) 3329 Stream.EmitRecord(EXTERNAL_DEFINITIONS, ExternalDefinitions); 3330 3331 // Write the record containing tentative definitions. 3332 if (!TentativeDefinitions.empty()) 3333 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions); 3334 3335 // Write the record containing unused file scoped decls. 3336 if (!UnusedFileScopedDecls.empty()) 3337 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls); 3338 3339 // Write the record containing weak undeclared identifiers. 3340 if (!WeakUndeclaredIdentifiers.empty()) 3341 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS, 3342 WeakUndeclaredIdentifiers); 3343 3344 // Write the record containing locally-scoped external definitions. 3345 if (!LocallyScopedExternalDecls.empty()) 3346 Stream.EmitRecord(LOCALLY_SCOPED_EXTERNAL_DECLS, 3347 LocallyScopedExternalDecls); 3348 3349 // Write the record containing ext_vector type names. 3350 if (!ExtVectorDecls.empty()) 3351 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls); 3352 3353 // Write the record containing VTable uses information. 3354 if (!VTableUses.empty()) 3355 Stream.EmitRecord(VTABLE_USES, VTableUses); 3356 3357 // Write the record containing dynamic classes declarations. 3358 if (!DynamicClasses.empty()) 3359 Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses); 3360 3361 // Write the record containing pending implicit instantiations. 3362 if (!PendingInstantiations.empty()) 3363 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations); 3364 3365 // Write the record containing declaration references of Sema. 3366 if (!SemaDeclRefs.empty()) 3367 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs); 3368 3369 // Write the record containing CUDA-specific declaration references. 3370 if (!CUDASpecialDeclRefs.empty()) 3371 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs); 3372 3373 // Write the delegating constructors. 3374 if (!DelegatingCtorDecls.empty()) 3375 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls); 3376 3377 // Write the known namespaces. 3378 if (!KnownNamespaces.empty()) 3379 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces); 3380 3381 // Write the visible updates to DeclContexts. 3382 for (llvm::SmallPtrSet<const DeclContext *, 16>::iterator 3383 I = UpdatedDeclContexts.begin(), 3384 E = UpdatedDeclContexts.end(); 3385 I != E; ++I) 3386 WriteDeclContextVisibleUpdate(*I); 3387 3388 if (!WritingModule) { 3389 // Write the submodules that were imported, if any. 3390 RecordData ImportedModules; 3391 for (ASTContext::import_iterator I = Context.local_import_begin(), 3392 IEnd = Context.local_import_end(); 3393 I != IEnd; ++I) { 3394 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end()); 3395 ImportedModules.push_back(SubmoduleIDs[I->getImportedModule()]); 3396 } 3397 if (!ImportedModules.empty()) { 3398 // Sort module IDs. 3399 llvm::array_pod_sort(ImportedModules.begin(), ImportedModules.end()); 3400 3401 // Unique module IDs. 3402 ImportedModules.erase(std::unique(ImportedModules.begin(), 3403 ImportedModules.end()), 3404 ImportedModules.end()); 3405 3406 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules); 3407 } 3408 } 3409 3410 WriteDeclUpdatesBlocks(); 3411 WriteDeclReplacementsBlock(); 3412 WriteChainedObjCCategories(); 3413 3414 // Some simple statistics 3415 Record.clear(); 3416 Record.push_back(NumStatements); 3417 Record.push_back(NumMacros); 3418 Record.push_back(NumLexicalDeclContexts); 3419 Record.push_back(NumVisibleDeclContexts); 3420 Stream.EmitRecord(STATISTICS, Record); 3421 Stream.ExitBlock(); 3422 } 3423 3424 /// \brief Go through the declaration update blocks and resolve declaration 3425 /// pointers into declaration IDs. 3426 void ASTWriter::ResolveDeclUpdatesBlocks() { 3427 for (DeclUpdateMap::iterator 3428 I = DeclUpdates.begin(), E = DeclUpdates.end(); I != E; ++I) { 3429 const Decl *D = I->first; 3430 UpdateRecord &URec = I->second; 3431 3432 if (isRewritten(D)) 3433 continue; // The decl will be written completely 3434 3435 unsigned Idx = 0, N = URec.size(); 3436 while (Idx < N) { 3437 switch ((DeclUpdateKind)URec[Idx++]) { 3438 case UPD_CXX_SET_DEFINITIONDATA: 3439 case UPD_CXX_ADDED_IMPLICIT_MEMBER: 3440 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION: 3441 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE: 3442 URec[Idx] = GetDeclRef(reinterpret_cast<Decl *>(URec[Idx])); 3443 ++Idx; 3444 break; 3445 3446 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER: 3447 ++Idx; 3448 break; 3449 } 3450 } 3451 } 3452 } 3453 3454 void ASTWriter::WriteDeclUpdatesBlocks() { 3455 if (DeclUpdates.empty()) 3456 return; 3457 3458 RecordData OffsetsRecord; 3459 Stream.EnterSubblock(DECL_UPDATES_BLOCK_ID, NUM_ALLOWED_ABBREVS_SIZE); 3460 for (DeclUpdateMap::iterator 3461 I = DeclUpdates.begin(), E = DeclUpdates.end(); I != E; ++I) { 3462 const Decl *D = I->first; 3463 UpdateRecord &URec = I->second; 3464 3465 if (isRewritten(D)) 3466 continue; // The decl will be written completely,no need to store updates. 3467 3468 uint64_t Offset = Stream.GetCurrentBitNo(); 3469 Stream.EmitRecord(DECL_UPDATES, URec); 3470 3471 OffsetsRecord.push_back(GetDeclRef(D)); 3472 OffsetsRecord.push_back(Offset); 3473 } 3474 Stream.ExitBlock(); 3475 Stream.EmitRecord(DECL_UPDATE_OFFSETS, OffsetsRecord); 3476 } 3477 3478 void ASTWriter::WriteDeclReplacementsBlock() { 3479 if (ReplacedDecls.empty()) 3480 return; 3481 3482 RecordData Record; 3483 for (SmallVector<ReplacedDeclInfo, 16>::iterator 3484 I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) { 3485 Record.push_back(I->ID); 3486 Record.push_back(I->Offset); 3487 Record.push_back(I->Loc); 3488 } 3489 Stream.EmitRecord(DECL_REPLACEMENTS, Record); 3490 } 3491 3492 void ASTWriter::WriteChainedObjCCategories() { 3493 if (LocalChainedObjCCategories.empty()) 3494 return; 3495 3496 RecordData Record; 3497 for (SmallVector<ChainedObjCCategoriesData, 16>::iterator 3498 I = LocalChainedObjCCategories.begin(), 3499 E = LocalChainedObjCCategories.end(); I != E; ++I) { 3500 ChainedObjCCategoriesData &Data = *I; 3501 if (isRewritten(Data.Interface)) 3502 continue; 3503 3504 assert(Data.Interface->getCategoryList()); 3505 serialization::DeclID 3506 HeadCatID = getDeclID(Data.Interface->getCategoryList()); 3507 3508 Record.push_back(getDeclID(Data.Interface)); 3509 Record.push_back(HeadCatID); 3510 Record.push_back(getDeclID(Data.TailCategory)); 3511 } 3512 Stream.EmitRecord(OBJC_CHAINED_CATEGORIES, Record); 3513 } 3514 3515 void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) { 3516 Record.push_back(Loc.getRawEncoding()); 3517 } 3518 3519 void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) { 3520 AddSourceLocation(Range.getBegin(), Record); 3521 AddSourceLocation(Range.getEnd(), Record); 3522 } 3523 3524 void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) { 3525 Record.push_back(Value.getBitWidth()); 3526 const uint64_t *Words = Value.getRawData(); 3527 Record.append(Words, Words + Value.getNumWords()); 3528 } 3529 3530 void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) { 3531 Record.push_back(Value.isUnsigned()); 3532 AddAPInt(Value, Record); 3533 } 3534 3535 void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) { 3536 AddAPInt(Value.bitcastToAPInt(), Record); 3537 } 3538 3539 void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) { 3540 Record.push_back(getIdentifierRef(II)); 3541 } 3542 3543 IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) { 3544 if (II == 0) 3545 return 0; 3546 3547 IdentID &ID = IdentifierIDs[II]; 3548 if (ID == 0) 3549 ID = NextIdentID++; 3550 return ID; 3551 } 3552 3553 void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) { 3554 Record.push_back(getSelectorRef(SelRef)); 3555 } 3556 3557 SelectorID ASTWriter::getSelectorRef(Selector Sel) { 3558 if (Sel.getAsOpaquePtr() == 0) { 3559 return 0; 3560 } 3561 3562 SelectorID &SID = SelectorIDs[Sel]; 3563 if (SID == 0 && Chain) { 3564 // This might trigger a ReadSelector callback, which will set the ID for 3565 // this selector. 3566 Chain->LoadSelector(Sel); 3567 } 3568 if (SID == 0) { 3569 SID = NextSelectorID++; 3570 } 3571 return SID; 3572 } 3573 3574 void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) { 3575 AddDeclRef(Temp->getDestructor(), Record); 3576 } 3577 3578 void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases, 3579 CXXBaseSpecifier const *BasesEnd, 3580 RecordDataImpl &Record) { 3581 assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded"); 3582 CXXBaseSpecifiersToWrite.push_back( 3583 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID, 3584 Bases, BasesEnd)); 3585 Record.push_back(NextCXXBaseSpecifiersID++); 3586 } 3587 3588 void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind, 3589 const TemplateArgumentLocInfo &Arg, 3590 RecordDataImpl &Record) { 3591 switch (Kind) { 3592 case TemplateArgument::Expression: 3593 AddStmt(Arg.getAsExpr()); 3594 break; 3595 case TemplateArgument::Type: 3596 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record); 3597 break; 3598 case TemplateArgument::Template: 3599 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record); 3600 AddSourceLocation(Arg.getTemplateNameLoc(), Record); 3601 break; 3602 case TemplateArgument::TemplateExpansion: 3603 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record); 3604 AddSourceLocation(Arg.getTemplateNameLoc(), Record); 3605 AddSourceLocation(Arg.getTemplateEllipsisLoc(), Record); 3606 break; 3607 case TemplateArgument::Null: 3608 case TemplateArgument::Integral: 3609 case TemplateArgument::Declaration: 3610 case TemplateArgument::Pack: 3611 break; 3612 } 3613 } 3614 3615 void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg, 3616 RecordDataImpl &Record) { 3617 AddTemplateArgument(Arg.getArgument(), Record); 3618 3619 if (Arg.getArgument().getKind() == TemplateArgument::Expression) { 3620 bool InfoHasSameExpr 3621 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr(); 3622 Record.push_back(InfoHasSameExpr); 3623 if (InfoHasSameExpr) 3624 return; // Avoid storing the same expr twice. 3625 } 3626 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(), 3627 Record); 3628 } 3629 3630 void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo, 3631 RecordDataImpl &Record) { 3632 if (TInfo == 0) { 3633 AddTypeRef(QualType(), Record); 3634 return; 3635 } 3636 3637 AddTypeLoc(TInfo->getTypeLoc(), Record); 3638 } 3639 3640 void ASTWriter::AddTypeLoc(TypeLoc TL, RecordDataImpl &Record) { 3641 AddTypeRef(TL.getType(), Record); 3642 3643 TypeLocWriter TLW(*this, Record); 3644 for (; !TL.isNull(); TL = TL.getNextTypeLoc()) 3645 TLW.Visit(TL); 3646 } 3647 3648 void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) { 3649 Record.push_back(GetOrCreateTypeID(T)); 3650 } 3651 3652 TypeID ASTWriter::GetOrCreateTypeID( QualType T) { 3653 return MakeTypeID(*Context, T, 3654 std::bind1st(std::mem_fun(&ASTWriter::GetOrCreateTypeIdx), this)); 3655 } 3656 3657 TypeID ASTWriter::getTypeID(QualType T) const { 3658 return MakeTypeID(*Context, T, 3659 std::bind1st(std::mem_fun(&ASTWriter::getTypeIdx), this)); 3660 } 3661 3662 TypeIdx ASTWriter::GetOrCreateTypeIdx(QualType T) { 3663 if (T.isNull()) 3664 return TypeIdx(); 3665 assert(!T.getLocalFastQualifiers()); 3666 3667 TypeIdx &Idx = TypeIdxs[T]; 3668 if (Idx.getIndex() == 0) { 3669 // We haven't seen this type before. Assign it a new ID and put it 3670 // into the queue of types to emit. 3671 Idx = TypeIdx(NextTypeID++); 3672 DeclTypesToEmit.push(T); 3673 } 3674 return Idx; 3675 } 3676 3677 TypeIdx ASTWriter::getTypeIdx(QualType T) const { 3678 if (T.isNull()) 3679 return TypeIdx(); 3680 assert(!T.getLocalFastQualifiers()); 3681 3682 TypeIdxMap::const_iterator I = TypeIdxs.find(T); 3683 assert(I != TypeIdxs.end() && "Type not emitted!"); 3684 return I->second; 3685 } 3686 3687 void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) { 3688 Record.push_back(GetDeclRef(D)); 3689 } 3690 3691 DeclID ASTWriter::GetDeclRef(const Decl *D) { 3692 assert(WritingAST && "Cannot request a declaration ID before AST writing"); 3693 3694 if (D == 0) { 3695 return 0; 3696 } 3697 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer"); 3698 DeclID &ID = DeclIDs[D]; 3699 if (ID == 0) { 3700 // We haven't seen this declaration before. Give it a new ID and 3701 // enqueue it in the list of declarations to emit. 3702 ID = NextDeclID++; 3703 DeclTypesToEmit.push(const_cast<Decl *>(D)); 3704 } 3705 3706 return ID; 3707 } 3708 3709 DeclID ASTWriter::getDeclID(const Decl *D) { 3710 if (D == 0) 3711 return 0; 3712 3713 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!"); 3714 return DeclIDs[D]; 3715 } 3716 3717 static inline bool compLocDecl(std::pair<unsigned, serialization::DeclID> L, 3718 std::pair<unsigned, serialization::DeclID> R) { 3719 return L.first < R.first; 3720 } 3721 3722 void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) { 3723 assert(ID); 3724 assert(D); 3725 3726 SourceLocation Loc = D->getLocation(); 3727 if (Loc.isInvalid()) 3728 return; 3729 3730 // We only keep track of the file-level declarations of each file. 3731 if (!D->getLexicalDeclContext()->isFileContext()) 3732 return; 3733 3734 SourceManager &SM = Context->getSourceManager(); 3735 SourceLocation FileLoc = SM.getFileLoc(Loc); 3736 assert(SM.isLocalSourceLocation(FileLoc)); 3737 FileID FID; 3738 unsigned Offset; 3739 llvm::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc); 3740 if (FID.isInvalid()) 3741 return; 3742 const SrcMgr::SLocEntry *Entry = &SM.getSLocEntry(FID); 3743 assert(Entry->isFile()); 3744 3745 DeclIDInFileInfo *&Info = FileDeclIDs[Entry]; 3746 if (!Info) 3747 Info = new DeclIDInFileInfo(); 3748 3749 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID); 3750 LocDeclIDsTy &Decls = Info->DeclIDs; 3751 3752 if (Decls.empty() || Decls.back().first <= Offset) { 3753 Decls.push_back(LocDecl); 3754 return; 3755 } 3756 3757 LocDeclIDsTy::iterator 3758 I = std::upper_bound(Decls.begin(), Decls.end(), LocDecl, compLocDecl); 3759 3760 Decls.insert(I, LocDecl); 3761 } 3762 3763 void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) { 3764 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc. 3765 Record.push_back(Name.getNameKind()); 3766 switch (Name.getNameKind()) { 3767 case DeclarationName::Identifier: 3768 AddIdentifierRef(Name.getAsIdentifierInfo(), Record); 3769 break; 3770 3771 case DeclarationName::ObjCZeroArgSelector: 3772 case DeclarationName::ObjCOneArgSelector: 3773 case DeclarationName::ObjCMultiArgSelector: 3774 AddSelectorRef(Name.getObjCSelector(), Record); 3775 break; 3776 3777 case DeclarationName::CXXConstructorName: 3778 case DeclarationName::CXXDestructorName: 3779 case DeclarationName::CXXConversionFunctionName: 3780 AddTypeRef(Name.getCXXNameType(), Record); 3781 break; 3782 3783 case DeclarationName::CXXOperatorName: 3784 Record.push_back(Name.getCXXOverloadedOperator()); 3785 break; 3786 3787 case DeclarationName::CXXLiteralOperatorName: 3788 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record); 3789 break; 3790 3791 case DeclarationName::CXXUsingDirective: 3792 // No extra data to emit 3793 break; 3794 } 3795 } 3796 3797 void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc, 3798 DeclarationName Name, RecordDataImpl &Record) { 3799 switch (Name.getNameKind()) { 3800 case DeclarationName::CXXConstructorName: 3801 case DeclarationName::CXXDestructorName: 3802 case DeclarationName::CXXConversionFunctionName: 3803 AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record); 3804 break; 3805 3806 case DeclarationName::CXXOperatorName: 3807 AddSourceLocation( 3808 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc), 3809 Record); 3810 AddSourceLocation( 3811 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc), 3812 Record); 3813 break; 3814 3815 case DeclarationName::CXXLiteralOperatorName: 3816 AddSourceLocation( 3817 SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc), 3818 Record); 3819 break; 3820 3821 case DeclarationName::Identifier: 3822 case DeclarationName::ObjCZeroArgSelector: 3823 case DeclarationName::ObjCOneArgSelector: 3824 case DeclarationName::ObjCMultiArgSelector: 3825 case DeclarationName::CXXUsingDirective: 3826 break; 3827 } 3828 } 3829 3830 void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo, 3831 RecordDataImpl &Record) { 3832 AddDeclarationName(NameInfo.getName(), Record); 3833 AddSourceLocation(NameInfo.getLoc(), Record); 3834 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record); 3835 } 3836 3837 void ASTWriter::AddQualifierInfo(const QualifierInfo &Info, 3838 RecordDataImpl &Record) { 3839 AddNestedNameSpecifierLoc(Info.QualifierLoc, Record); 3840 Record.push_back(Info.NumTemplParamLists); 3841 for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i) 3842 AddTemplateParameterList(Info.TemplParamLists[i], Record); 3843 } 3844 3845 void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS, 3846 RecordDataImpl &Record) { 3847 // Nested name specifiers usually aren't too long. I think that 8 would 3848 // typically accommodate the vast majority. 3849 SmallVector<NestedNameSpecifier *, 8> NestedNames; 3850 3851 // Push each of the NNS's onto a stack for serialization in reverse order. 3852 while (NNS) { 3853 NestedNames.push_back(NNS); 3854 NNS = NNS->getPrefix(); 3855 } 3856 3857 Record.push_back(NestedNames.size()); 3858 while(!NestedNames.empty()) { 3859 NNS = NestedNames.pop_back_val(); 3860 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind(); 3861 Record.push_back(Kind); 3862 switch (Kind) { 3863 case NestedNameSpecifier::Identifier: 3864 AddIdentifierRef(NNS->getAsIdentifier(), Record); 3865 break; 3866 3867 case NestedNameSpecifier::Namespace: 3868 AddDeclRef(NNS->getAsNamespace(), Record); 3869 break; 3870 3871 case NestedNameSpecifier::NamespaceAlias: 3872 AddDeclRef(NNS->getAsNamespaceAlias(), Record); 3873 break; 3874 3875 case NestedNameSpecifier::TypeSpec: 3876 case NestedNameSpecifier::TypeSpecWithTemplate: 3877 AddTypeRef(QualType(NNS->getAsType(), 0), Record); 3878 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate); 3879 break; 3880 3881 case NestedNameSpecifier::Global: 3882 // Don't need to write an associated value. 3883 break; 3884 } 3885 } 3886 } 3887 3888 void ASTWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS, 3889 RecordDataImpl &Record) { 3890 // Nested name specifiers usually aren't too long. I think that 8 would 3891 // typically accommodate the vast majority. 3892 SmallVector<NestedNameSpecifierLoc , 8> NestedNames; 3893 3894 // Push each of the nested-name-specifiers's onto a stack for 3895 // serialization in reverse order. 3896 while (NNS) { 3897 NestedNames.push_back(NNS); 3898 NNS = NNS.getPrefix(); 3899 } 3900 3901 Record.push_back(NestedNames.size()); 3902 while(!NestedNames.empty()) { 3903 NNS = NestedNames.pop_back_val(); 3904 NestedNameSpecifier::SpecifierKind Kind 3905 = NNS.getNestedNameSpecifier()->getKind(); 3906 Record.push_back(Kind); 3907 switch (Kind) { 3908 case NestedNameSpecifier::Identifier: 3909 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier(), Record); 3910 AddSourceRange(NNS.getLocalSourceRange(), Record); 3911 break; 3912 3913 case NestedNameSpecifier::Namespace: 3914 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace(), Record); 3915 AddSourceRange(NNS.getLocalSourceRange(), Record); 3916 break; 3917 3918 case NestedNameSpecifier::NamespaceAlias: 3919 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(), Record); 3920 AddSourceRange(NNS.getLocalSourceRange(), Record); 3921 break; 3922 3923 case NestedNameSpecifier::TypeSpec: 3924 case NestedNameSpecifier::TypeSpecWithTemplate: 3925 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate); 3926 AddTypeLoc(NNS.getTypeLoc(), Record); 3927 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record); 3928 break; 3929 3930 case NestedNameSpecifier::Global: 3931 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record); 3932 break; 3933 } 3934 } 3935 } 3936 3937 void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) { 3938 TemplateName::NameKind Kind = Name.getKind(); 3939 Record.push_back(Kind); 3940 switch (Kind) { 3941 case TemplateName::Template: 3942 AddDeclRef(Name.getAsTemplateDecl(), Record); 3943 break; 3944 3945 case TemplateName::OverloadedTemplate: { 3946 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate(); 3947 Record.push_back(OvT->size()); 3948 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end(); 3949 I != E; ++I) 3950 AddDeclRef(*I, Record); 3951 break; 3952 } 3953 3954 case TemplateName::QualifiedTemplate: { 3955 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName(); 3956 AddNestedNameSpecifier(QualT->getQualifier(), Record); 3957 Record.push_back(QualT->hasTemplateKeyword()); 3958 AddDeclRef(QualT->getTemplateDecl(), Record); 3959 break; 3960 } 3961 3962 case TemplateName::DependentTemplate: { 3963 DependentTemplateName *DepT = Name.getAsDependentTemplateName(); 3964 AddNestedNameSpecifier(DepT->getQualifier(), Record); 3965 Record.push_back(DepT->isIdentifier()); 3966 if (DepT->isIdentifier()) 3967 AddIdentifierRef(DepT->getIdentifier(), Record); 3968 else 3969 Record.push_back(DepT->getOperator()); 3970 break; 3971 } 3972 3973 case TemplateName::SubstTemplateTemplateParm: { 3974 SubstTemplateTemplateParmStorage *subst 3975 = Name.getAsSubstTemplateTemplateParm(); 3976 AddDeclRef(subst->getParameter(), Record); 3977 AddTemplateName(subst->getReplacement(), Record); 3978 break; 3979 } 3980 3981 case TemplateName::SubstTemplateTemplateParmPack: { 3982 SubstTemplateTemplateParmPackStorage *SubstPack 3983 = Name.getAsSubstTemplateTemplateParmPack(); 3984 AddDeclRef(SubstPack->getParameterPack(), Record); 3985 AddTemplateArgument(SubstPack->getArgumentPack(), Record); 3986 break; 3987 } 3988 } 3989 } 3990 3991 void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg, 3992 RecordDataImpl &Record) { 3993 Record.push_back(Arg.getKind()); 3994 switch (Arg.getKind()) { 3995 case TemplateArgument::Null: 3996 break; 3997 case TemplateArgument::Type: 3998 AddTypeRef(Arg.getAsType(), Record); 3999 break; 4000 case TemplateArgument::Declaration: 4001 AddDeclRef(Arg.getAsDecl(), Record); 4002 break; 4003 case TemplateArgument::Integral: 4004 AddAPSInt(*Arg.getAsIntegral(), Record); 4005 AddTypeRef(Arg.getIntegralType(), Record); 4006 break; 4007 case TemplateArgument::Template: 4008 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record); 4009 break; 4010 case TemplateArgument::TemplateExpansion: 4011 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record); 4012 if (llvm::Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions()) 4013 Record.push_back(*NumExpansions + 1); 4014 else 4015 Record.push_back(0); 4016 break; 4017 case TemplateArgument::Expression: 4018 AddStmt(Arg.getAsExpr()); 4019 break; 4020 case TemplateArgument::Pack: 4021 Record.push_back(Arg.pack_size()); 4022 for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end(); 4023 I != E; ++I) 4024 AddTemplateArgument(*I, Record); 4025 break; 4026 } 4027 } 4028 4029 void 4030 ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams, 4031 RecordDataImpl &Record) { 4032 assert(TemplateParams && "No TemplateParams!"); 4033 AddSourceLocation(TemplateParams->getTemplateLoc(), Record); 4034 AddSourceLocation(TemplateParams->getLAngleLoc(), Record); 4035 AddSourceLocation(TemplateParams->getRAngleLoc(), Record); 4036 Record.push_back(TemplateParams->size()); 4037 for (TemplateParameterList::const_iterator 4038 P = TemplateParams->begin(), PEnd = TemplateParams->end(); 4039 P != PEnd; ++P) 4040 AddDeclRef(*P, Record); 4041 } 4042 4043 /// \brief Emit a template argument list. 4044 void 4045 ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs, 4046 RecordDataImpl &Record) { 4047 assert(TemplateArgs && "No TemplateArgs!"); 4048 Record.push_back(TemplateArgs->size()); 4049 for (int i=0, e = TemplateArgs->size(); i != e; ++i) 4050 AddTemplateArgument(TemplateArgs->get(i), Record); 4051 } 4052 4053 4054 void 4055 ASTWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordDataImpl &Record) { 4056 Record.push_back(Set.size()); 4057 for (UnresolvedSetImpl::const_iterator 4058 I = Set.begin(), E = Set.end(); I != E; ++I) { 4059 AddDeclRef(I.getDecl(), Record); 4060 Record.push_back(I.getAccess()); 4061 } 4062 } 4063 4064 void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base, 4065 RecordDataImpl &Record) { 4066 Record.push_back(Base.isVirtual()); 4067 Record.push_back(Base.isBaseOfClass()); 4068 Record.push_back(Base.getAccessSpecifierAsWritten()); 4069 Record.push_back(Base.getInheritConstructors()); 4070 AddTypeSourceInfo(Base.getTypeSourceInfo(), Record); 4071 AddSourceRange(Base.getSourceRange(), Record); 4072 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc() 4073 : SourceLocation(), 4074 Record); 4075 } 4076 4077 void ASTWriter::FlushCXXBaseSpecifiers() { 4078 RecordData Record; 4079 for (unsigned I = 0, N = CXXBaseSpecifiersToWrite.size(); I != N; ++I) { 4080 Record.clear(); 4081 4082 // Record the offset of this base-specifier set. 4083 unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1; 4084 if (Index == CXXBaseSpecifiersOffsets.size()) 4085 CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo()); 4086 else { 4087 if (Index > CXXBaseSpecifiersOffsets.size()) 4088 CXXBaseSpecifiersOffsets.resize(Index + 1); 4089 CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo(); 4090 } 4091 4092 const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases, 4093 *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd; 4094 Record.push_back(BEnd - B); 4095 for (; B != BEnd; ++B) 4096 AddCXXBaseSpecifier(*B, Record); 4097 Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record); 4098 4099 // Flush any expressions that were written as part of the base specifiers. 4100 FlushStmts(); 4101 } 4102 4103 CXXBaseSpecifiersToWrite.clear(); 4104 } 4105 4106 void ASTWriter::AddCXXCtorInitializers( 4107 const CXXCtorInitializer * const *CtorInitializers, 4108 unsigned NumCtorInitializers, 4109 RecordDataImpl &Record) { 4110 Record.push_back(NumCtorInitializers); 4111 for (unsigned i=0; i != NumCtorInitializers; ++i) { 4112 const CXXCtorInitializer *Init = CtorInitializers[i]; 4113 4114 if (Init->isBaseInitializer()) { 4115 Record.push_back(CTOR_INITIALIZER_BASE); 4116 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record); 4117 Record.push_back(Init->isBaseVirtual()); 4118 } else if (Init->isDelegatingInitializer()) { 4119 Record.push_back(CTOR_INITIALIZER_DELEGATING); 4120 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record); 4121 } else if (Init->isMemberInitializer()){ 4122 Record.push_back(CTOR_INITIALIZER_MEMBER); 4123 AddDeclRef(Init->getMember(), Record); 4124 } else { 4125 Record.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER); 4126 AddDeclRef(Init->getIndirectMember(), Record); 4127 } 4128 4129 AddSourceLocation(Init->getMemberLocation(), Record); 4130 AddStmt(Init->getInit()); 4131 AddSourceLocation(Init->getLParenLoc(), Record); 4132 AddSourceLocation(Init->getRParenLoc(), Record); 4133 Record.push_back(Init->isWritten()); 4134 if (Init->isWritten()) { 4135 Record.push_back(Init->getSourceOrder()); 4136 } else { 4137 Record.push_back(Init->getNumArrayIndices()); 4138 for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i) 4139 AddDeclRef(Init->getArrayIndex(i), Record); 4140 } 4141 } 4142 } 4143 4144 void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) { 4145 assert(D->DefinitionData); 4146 struct CXXRecordDecl::DefinitionData &Data = *D->DefinitionData; 4147 Record.push_back(Data.UserDeclaredConstructor); 4148 Record.push_back(Data.UserDeclaredCopyConstructor); 4149 Record.push_back(Data.UserDeclaredMoveConstructor); 4150 Record.push_back(Data.UserDeclaredCopyAssignment); 4151 Record.push_back(Data.UserDeclaredMoveAssignment); 4152 Record.push_back(Data.UserDeclaredDestructor); 4153 Record.push_back(Data.Aggregate); 4154 Record.push_back(Data.PlainOldData); 4155 Record.push_back(Data.Empty); 4156 Record.push_back(Data.Polymorphic); 4157 Record.push_back(Data.Abstract); 4158 Record.push_back(Data.IsStandardLayout); 4159 Record.push_back(Data.HasNoNonEmptyBases); 4160 Record.push_back(Data.HasPrivateFields); 4161 Record.push_back(Data.HasProtectedFields); 4162 Record.push_back(Data.HasPublicFields); 4163 Record.push_back(Data.HasMutableFields); 4164 Record.push_back(Data.HasTrivialDefaultConstructor); 4165 Record.push_back(Data.HasConstexprNonCopyMoveConstructor); 4166 Record.push_back(Data.HasTrivialCopyConstructor); 4167 Record.push_back(Data.HasTrivialMoveConstructor); 4168 Record.push_back(Data.HasTrivialCopyAssignment); 4169 Record.push_back(Data.HasTrivialMoveAssignment); 4170 Record.push_back(Data.HasTrivialDestructor); 4171 Record.push_back(Data.HasNonLiteralTypeFieldsOrBases); 4172 Record.push_back(Data.ComputedVisibleConversions); 4173 Record.push_back(Data.UserProvidedDefaultConstructor); 4174 Record.push_back(Data.DeclaredDefaultConstructor); 4175 Record.push_back(Data.DeclaredCopyConstructor); 4176 Record.push_back(Data.DeclaredMoveConstructor); 4177 Record.push_back(Data.DeclaredCopyAssignment); 4178 Record.push_back(Data.DeclaredMoveAssignment); 4179 Record.push_back(Data.DeclaredDestructor); 4180 Record.push_back(Data.FailedImplicitMoveConstructor); 4181 Record.push_back(Data.FailedImplicitMoveAssignment); 4182 4183 Record.push_back(Data.NumBases); 4184 if (Data.NumBases > 0) 4185 AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases, 4186 Record); 4187 4188 // FIXME: Make VBases lazily computed when needed to avoid storing them. 4189 Record.push_back(Data.NumVBases); 4190 if (Data.NumVBases > 0) 4191 AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases, 4192 Record); 4193 4194 AddUnresolvedSet(Data.Conversions, Record); 4195 AddUnresolvedSet(Data.VisibleConversions, Record); 4196 // Data.Definition is the owning decl, no need to write it. 4197 AddDeclRef(Data.FirstFriend, Record); 4198 } 4199 4200 void ASTWriter::ReaderInitialized(ASTReader *Reader) { 4201 assert(Reader && "Cannot remove chain"); 4202 assert((!Chain || Chain == Reader) && "Cannot replace chain"); 4203 assert(FirstDeclID == NextDeclID && 4204 FirstTypeID == NextTypeID && 4205 FirstIdentID == NextIdentID && 4206 FirstSubmoduleID == NextSubmoduleID && 4207 FirstSelectorID == NextSelectorID && 4208 "Setting chain after writing has started."); 4209 4210 Chain = Reader; 4211 4212 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls(); 4213 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes(); 4214 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers(); 4215 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules(); 4216 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors(); 4217 NextDeclID = FirstDeclID; 4218 NextTypeID = FirstTypeID; 4219 NextIdentID = FirstIdentID; 4220 NextSelectorID = FirstSelectorID; 4221 NextSubmoduleID = FirstSubmoduleID; 4222 } 4223 4224 void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) { 4225 IdentifierIDs[II] = ID; 4226 if (II->hasMacroDefinition()) 4227 DeserializedMacroNames.push_back(II); 4228 } 4229 4230 void ASTWriter::TypeRead(TypeIdx Idx, QualType T) { 4231 // Always take the highest-numbered type index. This copes with an interesting 4232 // case for chained AST writing where we schedule writing the type and then, 4233 // later, deserialize the type from another AST. In this case, we want to 4234 // keep the higher-numbered entry so that we can properly write it out to 4235 // the AST file. 4236 TypeIdx &StoredIdx = TypeIdxs[T]; 4237 if (Idx.getIndex() >= StoredIdx.getIndex()) 4238 StoredIdx = Idx; 4239 } 4240 4241 void ASTWriter::DeclRead(DeclID ID, const Decl *D) { 4242 DeclIDs[D] = ID; 4243 } 4244 4245 void ASTWriter::SelectorRead(SelectorID ID, Selector S) { 4246 SelectorIDs[S] = ID; 4247 } 4248 4249 void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID, 4250 MacroDefinition *MD) { 4251 assert(MacroDefinitions.find(MD) == MacroDefinitions.end()); 4252 MacroDefinitions[MD] = ID; 4253 } 4254 4255 void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) { 4256 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end()); 4257 SubmoduleIDs[Mod] = ID; 4258 } 4259 4260 void ASTWriter::CompletedTagDefinition(const TagDecl *D) { 4261 assert(D->isCompleteDefinition()); 4262 assert(!WritingAST && "Already writing the AST!"); 4263 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) { 4264 // We are interested when a PCH decl is modified. 4265 if (RD->isFromASTFile()) { 4266 // A forward reference was mutated into a definition. Rewrite it. 4267 // FIXME: This happens during template instantiation, should we 4268 // have created a new definition decl instead ? 4269 RewriteDecl(RD); 4270 } 4271 4272 for (CXXRecordDecl::redecl_iterator 4273 I = RD->redecls_begin(), E = RD->redecls_end(); I != E; ++I) { 4274 CXXRecordDecl *Redecl = cast<CXXRecordDecl>(*I); 4275 if (Redecl == RD) 4276 continue; 4277 4278 // We are interested when a PCH decl is modified. 4279 if (Redecl->isFromASTFile()) { 4280 UpdateRecord &Record = DeclUpdates[Redecl]; 4281 Record.push_back(UPD_CXX_SET_DEFINITIONDATA); 4282 assert(Redecl->DefinitionData); 4283 assert(Redecl->DefinitionData->Definition == D); 4284 Record.push_back(reinterpret_cast<uint64_t>(D)); // the DefinitionDecl 4285 } 4286 } 4287 } 4288 } 4289 void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) { 4290 assert(!WritingAST && "Already writing the AST!"); 4291 4292 // TU and namespaces are handled elsewhere. 4293 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC)) 4294 return; 4295 4296 if (!(!D->isFromASTFile() && cast<Decl>(DC)->isFromASTFile())) 4297 return; // Not a source decl added to a DeclContext from PCH. 4298 4299 AddUpdatedDeclContext(DC); 4300 } 4301 4302 void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) { 4303 assert(!WritingAST && "Already writing the AST!"); 4304 assert(D->isImplicit()); 4305 if (!(!D->isFromASTFile() && RD->isFromASTFile())) 4306 return; // Not a source member added to a class from PCH. 4307 if (!isa<CXXMethodDecl>(D)) 4308 return; // We are interested in lazily declared implicit methods. 4309 4310 // A decl coming from PCH was modified. 4311 assert(RD->isCompleteDefinition()); 4312 UpdateRecord &Record = DeclUpdates[RD]; 4313 Record.push_back(UPD_CXX_ADDED_IMPLICIT_MEMBER); 4314 Record.push_back(reinterpret_cast<uint64_t>(D)); 4315 } 4316 4317 void ASTWriter::AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD, 4318 const ClassTemplateSpecializationDecl *D) { 4319 // The specializations set is kept in the canonical template. 4320 assert(!WritingAST && "Already writing the AST!"); 4321 TD = TD->getCanonicalDecl(); 4322 if (!(!D->isFromASTFile() && TD->isFromASTFile())) 4323 return; // Not a source specialization added to a template from PCH. 4324 4325 UpdateRecord &Record = DeclUpdates[TD]; 4326 Record.push_back(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION); 4327 Record.push_back(reinterpret_cast<uint64_t>(D)); 4328 } 4329 4330 void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD, 4331 const FunctionDecl *D) { 4332 // The specializations set is kept in the canonical template. 4333 assert(!WritingAST && "Already writing the AST!"); 4334 TD = TD->getCanonicalDecl(); 4335 if (!(!D->isFromASTFile() && TD->isFromASTFile())) 4336 return; // Not a source specialization added to a template from PCH. 4337 4338 UpdateRecord &Record = DeclUpdates[TD]; 4339 Record.push_back(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION); 4340 Record.push_back(reinterpret_cast<uint64_t>(D)); 4341 } 4342 4343 void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) { 4344 assert(!WritingAST && "Already writing the AST!"); 4345 if (!D->isFromASTFile()) 4346 return; // Declaration not imported from PCH. 4347 4348 // Implicit decl from a PCH was defined. 4349 // FIXME: Should implicit definition be a separate FunctionDecl? 4350 RewriteDecl(D); 4351 } 4352 4353 void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) { 4354 assert(!WritingAST && "Already writing the AST!"); 4355 if (!D->isFromASTFile()) 4356 return; 4357 4358 // Since the actual instantiation is delayed, this really means that we need 4359 // to update the instantiation location. 4360 UpdateRecord &Record = DeclUpdates[D]; 4361 Record.push_back(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER); 4362 AddSourceLocation( 4363 D->getMemberSpecializationInfo()->getPointOfInstantiation(), Record); 4364 } 4365 4366 void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD, 4367 const ObjCInterfaceDecl *IFD) { 4368 assert(!WritingAST && "Already writing the AST!"); 4369 if (!IFD->isFromASTFile()) 4370 return; // Declaration not imported from PCH. 4371 if (CatD->getNextClassCategory() && 4372 !CatD->getNextClassCategory()->isFromASTFile()) 4373 return; // We already recorded that the tail of a category chain should be 4374 // attached to an interface. 4375 4376 ChainedObjCCategoriesData Data = { IFD, CatD }; 4377 LocalChainedObjCCategories.push_back(Data); 4378 } 4379 4380 void ASTWriter::CompletedObjCForwardRef(const ObjCContainerDecl *D) { 4381 assert(!WritingAST && "Already writing the AST!"); 4382 if (!D->isFromASTFile()) 4383 return; // Declaration not imported from PCH. 4384 4385 RewriteDecl(D); 4386 } 4387 4388 void ASTWriter::AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop, 4389 const ObjCPropertyDecl *OrigProp, 4390 const ObjCCategoryDecl *ClassExt) { 4391 const ObjCInterfaceDecl *D = ClassExt->getClassInterface(); 4392 if (!D) 4393 return; 4394 4395 assert(!WritingAST && "Already writing the AST!"); 4396 if (!D->isFromASTFile()) 4397 return; // Declaration not imported from PCH. 4398 4399 RewriteDecl(D); 4400 } 4401 4402 void ASTWriter::UpdatedAttributeList(const Decl *D) { 4403 assert(!WritingAST && "Already writing the AST!"); 4404 if (!D->isFromASTFile()) 4405 return; // Declaration not imported from PCH. 4406 4407 RewriteDecl(D); 4408 } 4409