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