blob: e555d9078fc7734df37419355fe74bf4b95a7fba [file] [log] [blame]
Douglas Gregor2cf26342009-04-09 22:27:44 +00001//===--- PCHReader.cpp - Precompiled Headers Reader -------------*- C++ -*-===//
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 PCHReader class, which reads a precompiled header.
11//
12//===----------------------------------------------------------------------===//
Chris Lattner4c6f9522009-04-27 05:14:47 +000013
Douglas Gregor2cf26342009-04-09 22:27:44 +000014#include "clang/Frontend/PCHReader.h"
Douglas Gregor0a0428e2009-04-10 20:39:37 +000015#include "clang/Frontend/FrontendDiagnostic.h"
Daniel Dunbarc7162932009-11-11 23:58:53 +000016#include "clang/Frontend/Utils.h"
Douglas Gregor668c1a42009-04-21 22:25:48 +000017#include "../Sema/Sema.h" // FIXME: move Sema headers elsewhere
Douglas Gregorfdd01722009-04-14 00:24:19 +000018#include "clang/AST/ASTConsumer.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000019#include "clang/AST/ASTContext.h"
Douglas Gregor0b748912009-04-14 21:18:50 +000020#include "clang/AST/Expr.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000021#include "clang/AST/Type.h"
John McCalla1ee0c52009-10-16 21:56:05 +000022#include "clang/AST/TypeLocVisitor.h"
Chris Lattner42d42b52009-04-10 21:41:48 +000023#include "clang/Lex/MacroInfo.h"
Douglas Gregor6a5a23f2010-03-19 21:51:54 +000024#include "clang/Lex/PreprocessingRecord.h"
Douglas Gregor14f79002009-04-10 03:52:48 +000025#include "clang/Lex/Preprocessor.h"
Steve Naroff83d63c72009-04-24 20:03:17 +000026#include "clang/Lex/HeaderSearch.h"
Douglas Gregor668c1a42009-04-21 22:25:48 +000027#include "clang/Basic/OnDiskHashTable.h"
Douglas Gregor14f79002009-04-10 03:52:48 +000028#include "clang/Basic/SourceManager.h"
Douglas Gregorbd945002009-04-13 16:31:14 +000029#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregor14f79002009-04-10 03:52:48 +000030#include "clang/Basic/FileManager.h"
Douglas Gregor2bec0412009-04-10 21:16:55 +000031#include "clang/Basic/TargetInfo.h"
Douglas Gregor445e23e2009-10-05 21:07:28 +000032#include "clang/Basic/Version.h"
Daniel Dunbar2596e422009-10-17 23:52:28 +000033#include "llvm/ADT/StringExtras.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000034#include "llvm/Bitcode/BitstreamReader.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000035#include "llvm/Support/MemoryBuffer.h"
John McCall833ca992009-10-29 08:12:44 +000036#include "llvm/Support/ErrorHandling.h"
Daniel Dunbard5b21972009-11-18 19:50:41 +000037#include "llvm/System/Path.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000038#include <algorithm>
Douglas Gregore721f952009-04-28 18:58:38 +000039#include <iterator>
Douglas Gregor2cf26342009-04-09 22:27:44 +000040#include <cstdio>
Douglas Gregor4fed3f42009-04-27 18:38:38 +000041#include <sys/stat.h>
Douglas Gregor2cf26342009-04-09 22:27:44 +000042using namespace clang;
43
44//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000045// PCH reader validator implementation
46//===----------------------------------------------------------------------===//
47
48PCHReaderListener::~PCHReaderListener() {}
49
50bool
51PCHValidator::ReadLanguageOptions(const LangOptions &LangOpts) {
52 const LangOptions &PPLangOpts = PP.getLangOptions();
53#define PARSE_LANGOPT_BENIGN(Option)
54#define PARSE_LANGOPT_IMPORTANT(Option, DiagID) \
55 if (PPLangOpts.Option != LangOpts.Option) { \
56 Reader.Diag(DiagID) << LangOpts.Option << PPLangOpts.Option; \
57 return true; \
58 }
59
60 PARSE_LANGOPT_BENIGN(Trigraphs);
61 PARSE_LANGOPT_BENIGN(BCPLComment);
62 PARSE_LANGOPT_BENIGN(DollarIdents);
63 PARSE_LANGOPT_BENIGN(AsmPreprocessor);
64 PARSE_LANGOPT_IMPORTANT(GNUMode, diag::warn_pch_gnu_extensions);
Chandler Carrutheb5d7b72010-04-17 20:17:31 +000065 PARSE_LANGOPT_IMPORTANT(GNUKeywords, diag::warn_pch_gnu_keywords);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000066 PARSE_LANGOPT_BENIGN(ImplicitInt);
67 PARSE_LANGOPT_BENIGN(Digraphs);
68 PARSE_LANGOPT_BENIGN(HexFloats);
69 PARSE_LANGOPT_IMPORTANT(C99, diag::warn_pch_c99);
70 PARSE_LANGOPT_IMPORTANT(Microsoft, diag::warn_pch_microsoft_extensions);
71 PARSE_LANGOPT_IMPORTANT(CPlusPlus, diag::warn_pch_cplusplus);
72 PARSE_LANGOPT_IMPORTANT(CPlusPlus0x, diag::warn_pch_cplusplus0x);
73 PARSE_LANGOPT_BENIGN(CXXOperatorName);
74 PARSE_LANGOPT_IMPORTANT(ObjC1, diag::warn_pch_objective_c);
75 PARSE_LANGOPT_IMPORTANT(ObjC2, diag::warn_pch_objective_c2);
76 PARSE_LANGOPT_IMPORTANT(ObjCNonFragileABI, diag::warn_pch_nonfragile_abi);
Fariborz Jahanian412e7982010-02-09 19:31:38 +000077 PARSE_LANGOPT_IMPORTANT(ObjCNonFragileABI2, diag::warn_pch_nonfragile_abi2);
Fariborz Jahanian4c9d8d02010-04-22 21:01:59 +000078 PARSE_LANGOPT_IMPORTANT(NoConstantCFStrings,
79 diag::warn_pch_no_constant_cfstrings);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000080 PARSE_LANGOPT_BENIGN(PascalStrings);
81 PARSE_LANGOPT_BENIGN(WritableStrings);
Mike Stump1eb44332009-09-09 15:08:12 +000082 PARSE_LANGOPT_IMPORTANT(LaxVectorConversions,
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000083 diag::warn_pch_lax_vector_conversions);
Nate Begeman69cfb9b2009-06-25 22:57:40 +000084 PARSE_LANGOPT_IMPORTANT(AltiVec, diag::warn_pch_altivec);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000085 PARSE_LANGOPT_IMPORTANT(Exceptions, diag::warn_pch_exceptions);
Daniel Dunbar73482882010-02-10 18:48:44 +000086 PARSE_LANGOPT_IMPORTANT(SjLjExceptions, diag::warn_pch_sjlj_exceptions);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000087 PARSE_LANGOPT_IMPORTANT(NeXTRuntime, diag::warn_pch_objc_runtime);
88 PARSE_LANGOPT_IMPORTANT(Freestanding, diag::warn_pch_freestanding);
89 PARSE_LANGOPT_IMPORTANT(NoBuiltin, diag::warn_pch_builtins);
Mike Stump1eb44332009-09-09 15:08:12 +000090 PARSE_LANGOPT_IMPORTANT(ThreadsafeStatics,
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000091 diag::warn_pch_thread_safe_statics);
Daniel Dunbar5345c392009-09-03 04:54:28 +000092 PARSE_LANGOPT_IMPORTANT(POSIXThreads, diag::warn_pch_posix_threads);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000093 PARSE_LANGOPT_IMPORTANT(Blocks, diag::warn_pch_blocks);
94 PARSE_LANGOPT_BENIGN(EmitAllDecls);
95 PARSE_LANGOPT_IMPORTANT(MathErrno, diag::warn_pch_math_errno);
96 PARSE_LANGOPT_IMPORTANT(OverflowChecking, diag::warn_pch_overflow_checking);
Mike Stump1eb44332009-09-09 15:08:12 +000097 PARSE_LANGOPT_IMPORTANT(HeinousExtensions,
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +000098 diag::warn_pch_heinous_extensions);
99 // FIXME: Most of the options below are benign if the macro wasn't
100 // used. Unfortunately, this means that a PCH compiled without
101 // optimization can't be used with optimization turned on, even
102 // though the only thing that changes is whether __OPTIMIZE__ was
103 // defined... but if __OPTIMIZE__ never showed up in the header, it
104 // doesn't matter. We could consider making this some special kind
105 // of check.
106 PARSE_LANGOPT_IMPORTANT(Optimize, diag::warn_pch_optimize);
107 PARSE_LANGOPT_IMPORTANT(OptimizeSize, diag::warn_pch_optimize_size);
108 PARSE_LANGOPT_IMPORTANT(Static, diag::warn_pch_static);
109 PARSE_LANGOPT_IMPORTANT(PICLevel, diag::warn_pch_pic_level);
110 PARSE_LANGOPT_IMPORTANT(GNUInline, diag::warn_pch_gnu_inline);
111 PARSE_LANGOPT_IMPORTANT(NoInline, diag::warn_pch_no_inline);
112 PARSE_LANGOPT_IMPORTANT(AccessControl, diag::warn_pch_access_control);
113 PARSE_LANGOPT_IMPORTANT(CharIsSigned, diag::warn_pch_char_signed);
John Thompsona6fda122009-11-05 20:14:16 +0000114 PARSE_LANGOPT_IMPORTANT(ShortWChar, diag::warn_pch_short_wchar);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000115 if ((PPLangOpts.getGCMode() != 0) != (LangOpts.getGCMode() != 0)) {
Mike Stump1eb44332009-09-09 15:08:12 +0000116 Reader.Diag(diag::warn_pch_gc_mode)
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000117 << LangOpts.getGCMode() << PPLangOpts.getGCMode();
118 return true;
119 }
120 PARSE_LANGOPT_BENIGN(getVisibilityMode());
Daniel Dunbarab8e2812009-09-21 04:16:19 +0000121 PARSE_LANGOPT_IMPORTANT(getStackProtectorMode(),
122 diag::warn_pch_stack_protector);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000123 PARSE_LANGOPT_BENIGN(InstantiationDepth);
Nate Begeman69cfb9b2009-06-25 22:57:40 +0000124 PARSE_LANGOPT_IMPORTANT(OpenCL, diag::warn_pch_opencl);
Mike Stump9c276ae2009-12-12 01:27:46 +0000125 PARSE_LANGOPT_BENIGN(CatchUndefined);
Daniel Dunbarab8e2812009-09-21 04:16:19 +0000126 PARSE_LANGOPT_IMPORTANT(ElideConstructors, diag::warn_pch_elide_constructors);
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +0000127#undef PARSE_LANGOPT_IMPORTANT
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000128#undef PARSE_LANGOPT_BENIGN
129
130 return false;
131}
132
Daniel Dunbardc3c0d22009-11-11 00:52:11 +0000133bool PCHValidator::ReadTargetTriple(llvm::StringRef Triple) {
134 if (Triple == PP.getTargetInfo().getTriple().str())
135 return false;
136
137 Reader.Diag(diag::warn_pch_target_triple)
138 << Triple << PP.getTargetInfo().getTriple().str();
139 return true;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000140}
141
Daniel Dunbardc3c0d22009-11-11 00:52:11 +0000142bool PCHValidator::ReadPredefinesBuffer(llvm::StringRef PCHPredef,
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000143 FileID PCHBufferID,
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000144 llvm::StringRef OriginalFileName,
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000145 std::string &SuggestedPredefines) {
Daniel Dunbarc7162932009-11-11 23:58:53 +0000146 // We are in the context of an implicit include, so the predefines buffer will
147 // have a #include entry for the PCH file itself (as normalized by the
148 // preprocessor initialization). Find it and skip over it in the checking
149 // below.
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000150 llvm::SmallString<256> PCHInclude;
151 PCHInclude += "#include \"";
Daniel Dunbarc7162932009-11-11 23:58:53 +0000152 PCHInclude += NormalizeDashIncludePath(OriginalFileName);
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000153 PCHInclude += "\"\n";
154 std::pair<llvm::StringRef,llvm::StringRef> Split =
155 llvm::StringRef(PP.getPredefines()).split(PCHInclude.str());
156 llvm::StringRef Left = Split.first, Right = Split.second;
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +0000157 if (Left == PP.getPredefines()) {
158 Error("Missing PCH include entry!");
159 return true;
160 }
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000161
162 // If the predefines is equal to the joined left and right halves, we're done!
163 if (Left.size() + Right.size() == PCHPredef.size() &&
164 PCHPredef.startswith(Left) && PCHPredef.endswith(Right))
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000165 return false;
166
167 SourceManager &SourceMgr = PP.getSourceManager();
Mike Stump1eb44332009-09-09 15:08:12 +0000168
Daniel Dunbar10014aa2009-11-11 03:45:59 +0000169 // The predefines buffers are different. Determine what the differences are,
170 // and whether they require us to reject the PCH file.
Daniel Dunbare6750492009-11-13 16:46:11 +0000171 llvm::SmallVector<llvm::StringRef, 8> PCHLines;
172 PCHPredef.split(PCHLines, "\n", /*MaxSplit=*/-1, /*KeepEmpty=*/false);
173
174 llvm::SmallVector<llvm::StringRef, 8> CmdLineLines;
175 Left.split(CmdLineLines, "\n", /*MaxSplit=*/-1, /*KeepEmpty=*/false);
176 Right.split(CmdLineLines, "\n", /*MaxSplit=*/-1, /*KeepEmpty=*/false);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000177
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000178 // Sort both sets of predefined buffer lines, since we allow some extra
179 // definitions and they may appear at any point in the output.
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000180 std::sort(CmdLineLines.begin(), CmdLineLines.end());
181 std::sort(PCHLines.begin(), PCHLines.end());
182
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000183 // Determine which predefines that were used to build the PCH file are missing
184 // from the command line.
185 std::vector<llvm::StringRef> MissingPredefines;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000186 std::set_difference(PCHLines.begin(), PCHLines.end(),
187 CmdLineLines.begin(), CmdLineLines.end(),
188 std::back_inserter(MissingPredefines));
189
190 bool MissingDefines = false;
191 bool ConflictingDefines = false;
192 for (unsigned I = 0, N = MissingPredefines.size(); I != N; ++I) {
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000193 llvm::StringRef Missing = MissingPredefines[I];
194 if (!Missing.startswith("#define ")) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000195 Reader.Diag(diag::warn_pch_compiler_options_mismatch);
196 return true;
197 }
Mike Stump1eb44332009-09-09 15:08:12 +0000198
Daniel Dunbar10014aa2009-11-11 03:45:59 +0000199 // This is a macro definition. Determine the name of the macro we're
200 // defining.
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000201 std::string::size_type StartOfMacroName = strlen("#define ");
Mike Stump1eb44332009-09-09 15:08:12 +0000202 std::string::size_type EndOfMacroName
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000203 = Missing.find_first_of("( \n\r", StartOfMacroName);
204 assert(EndOfMacroName != std::string::npos &&
205 "Couldn't find the end of the macro name");
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000206 llvm::StringRef MacroName = Missing.slice(StartOfMacroName, EndOfMacroName);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000207
Daniel Dunbar10014aa2009-11-11 03:45:59 +0000208 // Determine whether this macro was given a different definition on the
209 // command line.
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000210 std::string MacroDefStart = "#define " + MacroName.str();
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000211 std::string::size_type MacroDefLen = MacroDefStart.size();
Daniel Dunbare6750492009-11-13 16:46:11 +0000212 llvm::SmallVector<llvm::StringRef, 8>::iterator ConflictPos
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000213 = std::lower_bound(CmdLineLines.begin(), CmdLineLines.end(),
214 MacroDefStart);
215 for (; ConflictPos != CmdLineLines.end(); ++ConflictPos) {
Daniel Dunbar10014aa2009-11-11 03:45:59 +0000216 if (!ConflictPos->startswith(MacroDefStart)) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000217 // Different macro; we're done.
218 ConflictPos = CmdLineLines.end();
Mike Stump1eb44332009-09-09 15:08:12 +0000219 break;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000220 }
Mike Stump1eb44332009-09-09 15:08:12 +0000221
222 assert(ConflictPos->size() > MacroDefLen &&
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000223 "Invalid #define in predefines buffer?");
Mike Stump1eb44332009-09-09 15:08:12 +0000224 if ((*ConflictPos)[MacroDefLen] != ' ' &&
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000225 (*ConflictPos)[MacroDefLen] != '(')
226 continue; // Longer macro name; keep trying.
Mike Stump1eb44332009-09-09 15:08:12 +0000227
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000228 // We found a conflicting macro definition.
229 break;
230 }
Mike Stump1eb44332009-09-09 15:08:12 +0000231
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000232 if (ConflictPos != CmdLineLines.end()) {
233 Reader.Diag(diag::warn_cmdline_conflicting_macro_def)
234 << MacroName;
235
236 // Show the definition of this macro within the PCH file.
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000237 llvm::StringRef::size_type Offset = PCHPredef.find(Missing);
238 assert(Offset != llvm::StringRef::npos && "Unable to find macro!");
239 SourceLocation PCHMissingLoc = SourceMgr.getLocForStartOfFile(PCHBufferID)
240 .getFileLocWithOffset(Offset);
241 Reader.Diag(PCHMissingLoc, diag::note_pch_macro_defined_as) << MacroName;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000242
243 ConflictingDefines = true;
244 continue;
245 }
Mike Stump1eb44332009-09-09 15:08:12 +0000246
Daniel Dunbar10014aa2009-11-11 03:45:59 +0000247 // If the macro doesn't conflict, then we'll just pick up the macro
248 // definition from the PCH file. Warn the user that they made a mistake.
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000249 if (ConflictingDefines)
250 continue; // Don't complain if there are already conflicting defs
Mike Stump1eb44332009-09-09 15:08:12 +0000251
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000252 if (!MissingDefines) {
253 Reader.Diag(diag::warn_cmdline_missing_macro_defs);
254 MissingDefines = true;
255 }
256
257 // Show the definition of this macro within the PCH file.
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000258 llvm::StringRef::size_type Offset = PCHPredef.find(Missing);
259 assert(Offset != llvm::StringRef::npos && "Unable to find macro!");
260 SourceLocation PCHMissingLoc = SourceMgr.getLocForStartOfFile(PCHBufferID)
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000261 .getFileLocWithOffset(Offset);
262 Reader.Diag(PCHMissingLoc, diag::note_using_macro_def_from_pch);
263 }
Mike Stump1eb44332009-09-09 15:08:12 +0000264
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000265 if (ConflictingDefines)
266 return true;
Mike Stump1eb44332009-09-09 15:08:12 +0000267
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000268 // Determine what predefines were introduced based on command-line
269 // parameters that were not present when building the PCH
270 // file. Extra #defines are okay, so long as the identifiers being
271 // defined were not used within the precompiled header.
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000272 std::vector<llvm::StringRef> ExtraPredefines;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000273 std::set_difference(CmdLineLines.begin(), CmdLineLines.end(),
274 PCHLines.begin(), PCHLines.end(),
Mike Stump1eb44332009-09-09 15:08:12 +0000275 std::back_inserter(ExtraPredefines));
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000276 for (unsigned I = 0, N = ExtraPredefines.size(); I != N; ++I) {
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000277 llvm::StringRef &Extra = ExtraPredefines[I];
278 if (!Extra.startswith("#define ")) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000279 Reader.Diag(diag::warn_pch_compiler_options_mismatch);
280 return true;
281 }
282
283 // This is an extra macro definition. Determine the name of the
284 // macro we're defining.
285 std::string::size_type StartOfMacroName = strlen("#define ");
Mike Stump1eb44332009-09-09 15:08:12 +0000286 std::string::size_type EndOfMacroName
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000287 = Extra.find_first_of("( \n\r", StartOfMacroName);
288 assert(EndOfMacroName != std::string::npos &&
289 "Couldn't find the end of the macro name");
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000290 llvm::StringRef MacroName = Extra.slice(StartOfMacroName, EndOfMacroName);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000291
292 // Check whether this name was used somewhere in the PCH file. If
293 // so, defining it as a macro could change behavior, so we reject
294 // the PCH file.
Daniel Dunbar4d5936a2009-11-11 05:26:28 +0000295 if (IdentifierInfo *II = Reader.get(MacroName)) {
Daniel Dunbar4fda42e2009-11-11 00:52:00 +0000296 Reader.Diag(diag::warn_macro_name_used_in_pch) << II;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000297 return true;
298 }
299
300 // Add this definition to the suggested predefines buffer.
301 SuggestedPredefines += Extra;
302 SuggestedPredefines += '\n';
303 }
304
305 // If we get here, it's because the predefines buffer had compatible
306 // contents. Accept the PCH file.
307 return false;
308}
309
Douglas Gregor12fab312010-03-16 16:35:32 +0000310void PCHValidator::ReadHeaderFileInfo(const HeaderFileInfo &HFI,
311 unsigned ID) {
312 PP.getHeaderSearchInfo().setHeaderFileInfoForUID(HFI, ID);
313 ++NumHeaderInfos;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000314}
315
316void PCHValidator::ReadCounter(unsigned Value) {
317 PP.setCounterValue(Value);
318}
319
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000320//===----------------------------------------------------------------------===//
Douglas Gregor668c1a42009-04-21 22:25:48 +0000321// PCH reader implementation
322//===----------------------------------------------------------------------===//
323
Mike Stump1eb44332009-09-09 15:08:12 +0000324PCHReader::PCHReader(Preprocessor &PP, ASTContext *Context,
325 const char *isysroot)
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000326 : Listener(new PCHValidator(PP, *this)), SourceMgr(PP.getSourceManager()),
327 FileMgr(PP.getFileManager()), Diags(PP.getDiagnostics()),
Douglas Gregor52e71082009-10-16 18:18:30 +0000328 SemaObj(0), PP(&PP), Context(Context), StatCache(0), Consumer(0),
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000329 IdentifierTableData(0), IdentifierLookupTable(0),
330 IdentifierOffsets(0),
331 MethodPoolLookupTable(0), MethodPoolLookupTableData(0),
332 TotalSelectorsInMethodPool(0), SelectorOffsets(0),
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000333 TotalNumSelectors(0), MacroDefinitionOffsets(0),
Douglas Gregorc6fbbed2010-03-19 22:13:20 +0000334 NumPreallocatedPreprocessingEntities(0),
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000335 isysroot(isysroot), NumStatHits(0), NumStatMisses(0),
Mike Stump1eb44332009-09-09 15:08:12 +0000336 NumSLocEntriesRead(0), NumStatementsRead(0),
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000337 NumMacrosRead(0), NumMethodPoolSelectorsRead(0), NumMethodPoolMisses(0),
Douglas Gregore650c8c2009-07-07 00:12:59 +0000338 NumLexicalDeclContextsRead(0), NumVisibleDeclContextsRead(0),
Mike Stump1eb44332009-09-09 15:08:12 +0000339 CurrentlyLoadingTypeOrDecl(0) {
Douglas Gregore650c8c2009-07-07 00:12:59 +0000340 RelocatablePCH = false;
341}
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000342
343PCHReader::PCHReader(SourceManager &SourceMgr, FileManager &FileMgr,
Mike Stump1eb44332009-09-09 15:08:12 +0000344 Diagnostic &Diags, const char *isysroot)
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000345 : SourceMgr(SourceMgr), FileMgr(FileMgr), Diags(Diags),
Douglas Gregor52e71082009-10-16 18:18:30 +0000346 SemaObj(0), PP(0), Context(0), StatCache(0), Consumer(0),
Chris Lattner4c6f9522009-04-27 05:14:47 +0000347 IdentifierTableData(0), IdentifierLookupTable(0),
348 IdentifierOffsets(0),
349 MethodPoolLookupTable(0), MethodPoolLookupTableData(0),
350 TotalSelectorsInMethodPool(0), SelectorOffsets(0),
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000351 TotalNumSelectors(0), MacroDefinitionOffsets(0),
Douglas Gregorc6fbbed2010-03-19 22:13:20 +0000352 NumPreallocatedPreprocessingEntities(0),
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000353 isysroot(isysroot), NumStatHits(0), NumStatMisses(0),
Mike Stump1eb44332009-09-09 15:08:12 +0000354 NumSLocEntriesRead(0), NumStatementsRead(0),
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000355 NumMacrosRead(0), NumMethodPoolSelectorsRead(0), NumMethodPoolMisses(0),
Douglas Gregord89275b2009-07-06 18:54:52 +0000356 NumLexicalDeclContextsRead(0), NumVisibleDeclContextsRead(0),
Mike Stump1eb44332009-09-09 15:08:12 +0000357 CurrentlyLoadingTypeOrDecl(0) {
Douglas Gregore650c8c2009-07-07 00:12:59 +0000358 RelocatablePCH = false;
359}
Chris Lattner4c6f9522009-04-27 05:14:47 +0000360
361PCHReader::~PCHReader() {}
362
Chris Lattnerda930612009-04-27 05:58:23 +0000363Expr *PCHReader::ReadDeclExpr() {
364 return dyn_cast_or_null<Expr>(ReadStmt(DeclsCursor));
365}
366
367Expr *PCHReader::ReadTypeExpr() {
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000368 return dyn_cast_or_null<Expr>(ReadStmt(DeclsCursor));
Chris Lattner4c6f9522009-04-27 05:14:47 +0000369}
370
371
Douglas Gregor668c1a42009-04-21 22:25:48 +0000372namespace {
Benjamin Kramerbd218282009-11-28 10:07:24 +0000373class PCHMethodPoolLookupTrait {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000374 PCHReader &Reader;
375
376public:
377 typedef std::pair<ObjCMethodList, ObjCMethodList> data_type;
378
379 typedef Selector external_key_type;
380 typedef external_key_type internal_key_type;
381
382 explicit PCHMethodPoolLookupTrait(PCHReader &Reader) : Reader(Reader) { }
Mike Stump1eb44332009-09-09 15:08:12 +0000383
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000384 static bool EqualKey(const internal_key_type& a,
385 const internal_key_type& b) {
386 return a == b;
387 }
Mike Stump1eb44332009-09-09 15:08:12 +0000388
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000389 static unsigned ComputeHash(Selector Sel) {
390 unsigned N = Sel.getNumArgs();
391 if (N == 0)
392 ++N;
393 unsigned R = 5381;
394 for (unsigned I = 0; I != N; ++I)
395 if (IdentifierInfo *II = Sel.getIdentifierInfoForSlot(I))
Daniel Dunbar2596e422009-10-17 23:52:28 +0000396 R = llvm::HashString(II->getName(), R);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000397 return R;
398 }
Mike Stump1eb44332009-09-09 15:08:12 +0000399
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000400 // This hopefully will just get inlined and removed by the optimizer.
401 static const internal_key_type&
402 GetInternalKey(const external_key_type& x) { return x; }
Mike Stump1eb44332009-09-09 15:08:12 +0000403
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000404 static std::pair<unsigned, unsigned>
405 ReadKeyDataLength(const unsigned char*& d) {
406 using namespace clang::io;
407 unsigned KeyLen = ReadUnalignedLE16(d);
408 unsigned DataLen = ReadUnalignedLE16(d);
409 return std::make_pair(KeyLen, DataLen);
410 }
Mike Stump1eb44332009-09-09 15:08:12 +0000411
Douglas Gregor83941df2009-04-25 17:48:32 +0000412 internal_key_type ReadKey(const unsigned char* d, unsigned) {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000413 using namespace clang::io;
Chris Lattnerd1d64a02009-04-27 21:45:14 +0000414 SelectorTable &SelTable = Reader.getContext()->Selectors;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000415 unsigned N = ReadUnalignedLE16(d);
Mike Stump1eb44332009-09-09 15:08:12 +0000416 IdentifierInfo *FirstII
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000417 = Reader.DecodeIdentifierInfo(ReadUnalignedLE32(d));
418 if (N == 0)
419 return SelTable.getNullarySelector(FirstII);
420 else if (N == 1)
421 return SelTable.getUnarySelector(FirstII);
422
423 llvm::SmallVector<IdentifierInfo *, 16> Args;
424 Args.push_back(FirstII);
425 for (unsigned I = 1; I != N; ++I)
426 Args.push_back(Reader.DecodeIdentifierInfo(ReadUnalignedLE32(d)));
427
Douglas Gregor75fdb232009-05-22 22:45:36 +0000428 return SelTable.getSelector(N, Args.data());
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000429 }
Mike Stump1eb44332009-09-09 15:08:12 +0000430
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000431 data_type ReadData(Selector, const unsigned char* d, unsigned DataLen) {
432 using namespace clang::io;
433 unsigned NumInstanceMethods = ReadUnalignedLE16(d);
434 unsigned NumFactoryMethods = ReadUnalignedLE16(d);
435
436 data_type Result;
437
438 // Load instance methods
439 ObjCMethodList *Prev = 0;
440 for (unsigned I = 0; I != NumInstanceMethods; ++I) {
Mike Stump1eb44332009-09-09 15:08:12 +0000441 ObjCMethodDecl *Method
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000442 = cast<ObjCMethodDecl>(Reader.GetDecl(ReadUnalignedLE32(d)));
443 if (!Result.first.Method) {
444 // This is the first method, which is the easy case.
445 Result.first.Method = Method;
446 Prev = &Result.first;
447 continue;
448 }
449
Ted Kremenek298ed872010-02-11 00:53:01 +0000450 ObjCMethodList *Mem =
451 Reader.getSema()->BumpAlloc.Allocate<ObjCMethodList>();
452 Prev->Next = new (Mem) ObjCMethodList(Method, 0);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000453 Prev = Prev->Next;
454 }
455
456 // Load factory methods
457 Prev = 0;
458 for (unsigned I = 0; I != NumFactoryMethods; ++I) {
Mike Stump1eb44332009-09-09 15:08:12 +0000459 ObjCMethodDecl *Method
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000460 = cast<ObjCMethodDecl>(Reader.GetDecl(ReadUnalignedLE32(d)));
461 if (!Result.second.Method) {
462 // This is the first method, which is the easy case.
463 Result.second.Method = Method;
464 Prev = &Result.second;
465 continue;
466 }
467
Ted Kremenek298ed872010-02-11 00:53:01 +0000468 ObjCMethodList *Mem =
469 Reader.getSema()->BumpAlloc.Allocate<ObjCMethodList>();
470 Prev->Next = new (Mem) ObjCMethodList(Method, 0);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000471 Prev = Prev->Next;
472 }
473
474 return Result;
475 }
476};
Mike Stump1eb44332009-09-09 15:08:12 +0000477
478} // end anonymous namespace
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000479
480/// \brief The on-disk hash table used for the global method pool.
Mike Stump1eb44332009-09-09 15:08:12 +0000481typedef OnDiskChainedHashTable<PCHMethodPoolLookupTrait>
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +0000482 PCHMethodPoolLookupTable;
483
484namespace {
Benjamin Kramerbd218282009-11-28 10:07:24 +0000485class PCHIdentifierLookupTrait {
Douglas Gregor668c1a42009-04-21 22:25:48 +0000486 PCHReader &Reader;
487
488 // If we know the IdentifierInfo in advance, it is here and we will
489 // not build a new one. Used when deserializing information about an
490 // identifier that was constructed before the PCH file was read.
491 IdentifierInfo *KnownII;
492
493public:
494 typedef IdentifierInfo * data_type;
495
496 typedef const std::pair<const char*, unsigned> external_key_type;
497
498 typedef external_key_type internal_key_type;
499
Mike Stump1eb44332009-09-09 15:08:12 +0000500 explicit PCHIdentifierLookupTrait(PCHReader &Reader, IdentifierInfo *II = 0)
Douglas Gregor668c1a42009-04-21 22:25:48 +0000501 : Reader(Reader), KnownII(II) { }
Mike Stump1eb44332009-09-09 15:08:12 +0000502
Douglas Gregor668c1a42009-04-21 22:25:48 +0000503 static bool EqualKey(const internal_key_type& a,
504 const internal_key_type& b) {
505 return (a.second == b.second) ? memcmp(a.first, b.first, a.second) == 0
506 : false;
507 }
Mike Stump1eb44332009-09-09 15:08:12 +0000508
Douglas Gregor668c1a42009-04-21 22:25:48 +0000509 static unsigned ComputeHash(const internal_key_type& a) {
Daniel Dunbar2596e422009-10-17 23:52:28 +0000510 return llvm::HashString(llvm::StringRef(a.first, a.second));
Douglas Gregor668c1a42009-04-21 22:25:48 +0000511 }
Mike Stump1eb44332009-09-09 15:08:12 +0000512
Douglas Gregor668c1a42009-04-21 22:25:48 +0000513 // This hopefully will just get inlined and removed by the optimizer.
514 static const internal_key_type&
515 GetInternalKey(const external_key_type& x) { return x; }
Mike Stump1eb44332009-09-09 15:08:12 +0000516
Douglas Gregor668c1a42009-04-21 22:25:48 +0000517 static std::pair<unsigned, unsigned>
518 ReadKeyDataLength(const unsigned char*& d) {
519 using namespace clang::io;
Douglas Gregor5f8e3302009-04-25 20:26:24 +0000520 unsigned DataLen = ReadUnalignedLE16(d);
Douglas Gregord6595a42009-04-25 21:04:17 +0000521 unsigned KeyLen = ReadUnalignedLE16(d);
Douglas Gregor668c1a42009-04-21 22:25:48 +0000522 return std::make_pair(KeyLen, DataLen);
523 }
Mike Stump1eb44332009-09-09 15:08:12 +0000524
Douglas Gregor668c1a42009-04-21 22:25:48 +0000525 static std::pair<const char*, unsigned>
526 ReadKey(const unsigned char* d, unsigned n) {
527 assert(n >= 2 && d[n-1] == '\0');
528 return std::make_pair((const char*) d, n-1);
529 }
Mike Stump1eb44332009-09-09 15:08:12 +0000530
531 IdentifierInfo *ReadData(const internal_key_type& k,
Douglas Gregor668c1a42009-04-21 22:25:48 +0000532 const unsigned char* d,
533 unsigned DataLen) {
534 using namespace clang::io;
Douglas Gregora92193e2009-04-28 21:18:29 +0000535 pch::IdentID ID = ReadUnalignedLE32(d);
536 bool IsInteresting = ID & 0x01;
537
538 // Wipe out the "is interesting" bit.
539 ID = ID >> 1;
540
541 if (!IsInteresting) {
542 // For unintersting identifiers, just build the IdentifierInfo
543 // and associate it with the persistent ID.
544 IdentifierInfo *II = KnownII;
545 if (!II)
546 II = &Reader.getIdentifierTable().CreateIdentifierInfo(
547 k.first, k.first + k.second);
548 Reader.SetIdentifierInfo(ID, II);
549 return II;
550 }
551
Douglas Gregor5998da52009-04-28 21:32:13 +0000552 unsigned Bits = ReadUnalignedLE16(d);
Douglas Gregor2deaea32009-04-22 18:49:13 +0000553 bool CPlusPlusOperatorKeyword = Bits & 0x01;
554 Bits >>= 1;
555 bool Poisoned = Bits & 0x01;
556 Bits >>= 1;
557 bool ExtensionToken = Bits & 0x01;
558 Bits >>= 1;
559 bool hasMacroDefinition = Bits & 0x01;
560 Bits >>= 1;
561 unsigned ObjCOrBuiltinID = Bits & 0x3FF;
562 Bits >>= 10;
Mike Stump1eb44332009-09-09 15:08:12 +0000563
Douglas Gregor2deaea32009-04-22 18:49:13 +0000564 assert(Bits == 0 && "Extra bits in the identifier?");
Douglas Gregor5998da52009-04-28 21:32:13 +0000565 DataLen -= 6;
Douglas Gregor668c1a42009-04-21 22:25:48 +0000566
567 // Build the IdentifierInfo itself and link the identifier ID with
568 // the new IdentifierInfo.
569 IdentifierInfo *II = KnownII;
570 if (!II)
Douglas Gregor5f8e3302009-04-25 20:26:24 +0000571 II = &Reader.getIdentifierTable().CreateIdentifierInfo(
572 k.first, k.first + k.second);
Douglas Gregor668c1a42009-04-21 22:25:48 +0000573 Reader.SetIdentifierInfo(ID, II);
574
Douglas Gregor2deaea32009-04-22 18:49:13 +0000575 // Set or check the various bits in the IdentifierInfo structure.
576 // FIXME: Load token IDs lazily, too?
Douglas Gregor2deaea32009-04-22 18:49:13 +0000577 II->setObjCOrBuiltinID(ObjCOrBuiltinID);
Mike Stump1eb44332009-09-09 15:08:12 +0000578 assert(II->isExtensionToken() == ExtensionToken &&
Douglas Gregor2deaea32009-04-22 18:49:13 +0000579 "Incorrect extension token flag");
580 (void)ExtensionToken;
581 II->setIsPoisoned(Poisoned);
582 assert(II->isCPlusPlusOperatorKeyword() == CPlusPlusOperatorKeyword &&
583 "Incorrect C++ operator keyword flag");
584 (void)CPlusPlusOperatorKeyword;
585
Douglas Gregor37e26842009-04-21 23:56:24 +0000586 // If this identifier is a macro, deserialize the macro
587 // definition.
588 if (hasMacroDefinition) {
Douglas Gregor5998da52009-04-28 21:32:13 +0000589 uint32_t Offset = ReadUnalignedLE32(d);
Douglas Gregor37e26842009-04-21 23:56:24 +0000590 Reader.ReadMacroRecord(Offset);
Douglas Gregor5998da52009-04-28 21:32:13 +0000591 DataLen -= 4;
Douglas Gregor37e26842009-04-21 23:56:24 +0000592 }
Douglas Gregor668c1a42009-04-21 22:25:48 +0000593
594 // Read all of the declarations visible at global scope with this
595 // name.
Chris Lattner6bf690f2009-04-27 22:17:41 +0000596 if (Reader.getContext() == 0) return II;
Douglas Gregord89275b2009-07-06 18:54:52 +0000597 if (DataLen > 0) {
598 llvm::SmallVector<uint32_t, 4> DeclIDs;
599 for (; DataLen > 0; DataLen -= 4)
600 DeclIDs.push_back(ReadUnalignedLE32(d));
601 Reader.SetGloballyVisibleDecls(II, DeclIDs);
Douglas Gregor668c1a42009-04-21 22:25:48 +0000602 }
Mike Stump1eb44332009-09-09 15:08:12 +0000603
Douglas Gregor668c1a42009-04-21 22:25:48 +0000604 return II;
605 }
606};
Mike Stump1eb44332009-09-09 15:08:12 +0000607
608} // end anonymous namespace
Douglas Gregor668c1a42009-04-21 22:25:48 +0000609
610/// \brief The on-disk hash table used to contain information about
611/// all of the identifiers in the program.
Mike Stump1eb44332009-09-09 15:08:12 +0000612typedef OnDiskChainedHashTable<PCHIdentifierLookupTrait>
Douglas Gregor668c1a42009-04-21 22:25:48 +0000613 PCHIdentifierLookupTable;
614
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +0000615void PCHReader::Error(const char *Msg) {
616 Diag(diag::err_fe_pch_malformed) << Msg;
Douglas Gregor2cf26342009-04-09 22:27:44 +0000617}
618
Douglas Gregore1d918e2009-04-10 23:10:45 +0000619/// \brief Check the contents of the predefines buffer against the
620/// contents of the predefines buffer used to build the PCH file.
621///
622/// The contents of the two predefines buffers should be the same. If
623/// not, then some command-line option changed the preprocessor state
624/// and we must reject the PCH file.
625///
626/// \param PCHPredef The start of the predefines buffer in the PCH
627/// file.
628///
629/// \param PCHPredefLen The length of the predefines buffer in the PCH
630/// file.
631///
632/// \param PCHBufferID The FileID for the PCH predefines buffer.
633///
634/// \returns true if there was a mismatch (in which case the PCH file
635/// should be ignored), or false otherwise.
Daniel Dunbardc3c0d22009-11-11 00:52:11 +0000636bool PCHReader::CheckPredefinesBuffer(llvm::StringRef PCHPredef,
Douglas Gregore1d918e2009-04-10 23:10:45 +0000637 FileID PCHBufferID) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000638 if (Listener)
Daniel Dunbardc3c0d22009-11-11 00:52:11 +0000639 return Listener->ReadPredefinesBuffer(PCHPredef, PCHBufferID,
Daniel Dunbar7b5a1212009-11-11 05:29:04 +0000640 ActualOriginalFileName,
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +0000641 SuggestedPredefines);
Douglas Gregore721f952009-04-28 18:58:38 +0000642 return false;
Douglas Gregore1d918e2009-04-10 23:10:45 +0000643}
644
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000645//===----------------------------------------------------------------------===//
646// Source Manager Deserialization
647//===----------------------------------------------------------------------===//
648
Douglas Gregorbd945002009-04-13 16:31:14 +0000649/// \brief Read the line table in the source manager block.
650/// \returns true if ther was an error.
Douglas Gregore650c8c2009-07-07 00:12:59 +0000651bool PCHReader::ParseLineTable(llvm::SmallVectorImpl<uint64_t> &Record) {
Douglas Gregorbd945002009-04-13 16:31:14 +0000652 unsigned Idx = 0;
653 LineTableInfo &LineTable = SourceMgr.getLineTable();
654
655 // Parse the file names
Douglas Gregorff0a9872009-04-13 17:12:42 +0000656 std::map<int, int> FileIDs;
657 for (int I = 0, N = Record[Idx++]; I != N; ++I) {
Douglas Gregorbd945002009-04-13 16:31:14 +0000658 // Extract the file name
659 unsigned FilenameLen = Record[Idx++];
660 std::string Filename(&Record[Idx], &Record[Idx] + FilenameLen);
661 Idx += FilenameLen;
Douglas Gregore650c8c2009-07-07 00:12:59 +0000662 MaybeAddSystemRootToFilename(Filename);
Mike Stump1eb44332009-09-09 15:08:12 +0000663 FileIDs[I] = LineTable.getLineTableFilenameID(Filename.c_str(),
Douglas Gregorff0a9872009-04-13 17:12:42 +0000664 Filename.size());
Douglas Gregorbd945002009-04-13 16:31:14 +0000665 }
666
667 // Parse the line entries
668 std::vector<LineEntry> Entries;
669 while (Idx < Record.size()) {
Douglas Gregorff0a9872009-04-13 17:12:42 +0000670 int FID = FileIDs[Record[Idx++]];
Douglas Gregorbd945002009-04-13 16:31:14 +0000671
672 // Extract the line entries
673 unsigned NumEntries = Record[Idx++];
674 Entries.clear();
675 Entries.reserve(NumEntries);
676 for (unsigned I = 0; I != NumEntries; ++I) {
677 unsigned FileOffset = Record[Idx++];
678 unsigned LineNo = Record[Idx++];
679 int FilenameID = Record[Idx++];
Mike Stump1eb44332009-09-09 15:08:12 +0000680 SrcMgr::CharacteristicKind FileKind
Douglas Gregorbd945002009-04-13 16:31:14 +0000681 = (SrcMgr::CharacteristicKind)Record[Idx++];
682 unsigned IncludeOffset = Record[Idx++];
683 Entries.push_back(LineEntry::get(FileOffset, LineNo, FilenameID,
684 FileKind, IncludeOffset));
685 }
686 LineTable.AddEntry(FID, Entries);
687 }
688
689 return false;
690}
691
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000692namespace {
693
Benjamin Kramerbd218282009-11-28 10:07:24 +0000694class PCHStatData {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000695public:
696 const bool hasStat;
697 const ino_t ino;
698 const dev_t dev;
699 const mode_t mode;
700 const time_t mtime;
701 const off_t size;
Mike Stump1eb44332009-09-09 15:08:12 +0000702
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000703 PCHStatData(ino_t i, dev_t d, mode_t mo, time_t m, off_t s)
Mike Stump1eb44332009-09-09 15:08:12 +0000704 : hasStat(true), ino(i), dev(d), mode(mo), mtime(m), size(s) {}
705
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000706 PCHStatData()
707 : hasStat(false), ino(0), dev(0), mode(0), mtime(0), size(0) {}
708};
709
Benjamin Kramerbd218282009-11-28 10:07:24 +0000710class PCHStatLookupTrait {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000711 public:
712 typedef const char *external_key_type;
713 typedef const char *internal_key_type;
714
715 typedef PCHStatData data_type;
716
717 static unsigned ComputeHash(const char *path) {
Daniel Dunbar2596e422009-10-17 23:52:28 +0000718 return llvm::HashString(path);
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000719 }
720
721 static internal_key_type GetInternalKey(const char *path) { return path; }
722
723 static bool EqualKey(internal_key_type a, internal_key_type b) {
724 return strcmp(a, b) == 0;
725 }
726
727 static std::pair<unsigned, unsigned>
728 ReadKeyDataLength(const unsigned char*& d) {
729 unsigned KeyLen = (unsigned) clang::io::ReadUnalignedLE16(d);
730 unsigned DataLen = (unsigned) *d++;
731 return std::make_pair(KeyLen + 1, DataLen);
732 }
733
734 static internal_key_type ReadKey(const unsigned char *d, unsigned) {
735 return (const char *)d;
736 }
737
738 static data_type ReadData(const internal_key_type, const unsigned char *d,
739 unsigned /*DataLen*/) {
740 using namespace clang::io;
741
742 if (*d++ == 1)
743 return data_type();
744
745 ino_t ino = (ino_t) ReadUnalignedLE32(d);
746 dev_t dev = (dev_t) ReadUnalignedLE32(d);
747 mode_t mode = (mode_t) ReadUnalignedLE16(d);
Mike Stump1eb44332009-09-09 15:08:12 +0000748 time_t mtime = (time_t) ReadUnalignedLE64(d);
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000749 off_t size = (off_t) ReadUnalignedLE64(d);
750 return data_type(ino, dev, mode, mtime, size);
751 }
752};
753
754/// \brief stat() cache for precompiled headers.
755///
756/// This cache is very similar to the stat cache used by pretokenized
757/// headers.
Benjamin Kramerbd218282009-11-28 10:07:24 +0000758class PCHStatCache : public StatSysCallCache {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000759 typedef OnDiskChainedHashTable<PCHStatLookupTrait> CacheTy;
760 CacheTy *Cache;
761
762 unsigned &NumStatHits, &NumStatMisses;
Mike Stump1eb44332009-09-09 15:08:12 +0000763public:
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000764 PCHStatCache(const unsigned char *Buckets,
765 const unsigned char *Base,
766 unsigned &NumStatHits,
Mike Stump1eb44332009-09-09 15:08:12 +0000767 unsigned &NumStatMisses)
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000768 : Cache(0), NumStatHits(NumStatHits), NumStatMisses(NumStatMisses) {
769 Cache = CacheTy::Create(Buckets, Base);
770 }
771
772 ~PCHStatCache() { delete Cache; }
Mike Stump1eb44332009-09-09 15:08:12 +0000773
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000774 int stat(const char *path, struct stat *buf) {
775 // Do the lookup for the file's data in the PCH file.
776 CacheTy::iterator I = Cache->find(path);
777
778 // If we don't get a hit in the PCH file just forward to 'stat'.
779 if (I == Cache->end()) {
780 ++NumStatMisses;
Douglas Gregor52e71082009-10-16 18:18:30 +0000781 return StatSysCallCache::stat(path, buf);
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000782 }
Mike Stump1eb44332009-09-09 15:08:12 +0000783
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000784 ++NumStatHits;
785 PCHStatData Data = *I;
Mike Stump1eb44332009-09-09 15:08:12 +0000786
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000787 if (!Data.hasStat)
788 return 1;
789
790 buf->st_ino = Data.ino;
791 buf->st_dev = Data.dev;
792 buf->st_mtime = Data.mtime;
793 buf->st_mode = Data.mode;
794 buf->st_size = Data.size;
795 return 0;
796 }
797};
798} // end anonymous namespace
799
800
Douglas Gregor14f79002009-04-10 03:52:48 +0000801/// \brief Read the source manager block
Douglas Gregore1d918e2009-04-10 23:10:45 +0000802PCHReader::PCHReadResult PCHReader::ReadSourceManagerBlock() {
Douglas Gregor14f79002009-04-10 03:52:48 +0000803 using namespace SrcMgr;
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000804
805 // Set the source-location entry cursor to the current position in
806 // the stream. This cursor will be used to read the contents of the
807 // source manager block initially, and then lazily read
808 // source-location entries as needed.
809 SLocEntryCursor = Stream;
810
811 // The stream itself is going to skip over the source manager block.
812 if (Stream.SkipBlock()) {
Douglas Gregora02b1472009-04-28 21:53:25 +0000813 Error("malformed block record in PCH file");
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000814 return Failure;
815 }
816
817 // Enter the source manager block.
818 if (SLocEntryCursor.EnterSubBlock(pch::SOURCE_MANAGER_BLOCK_ID)) {
Douglas Gregora02b1472009-04-28 21:53:25 +0000819 Error("malformed source manager block record in PCH file");
Douglas Gregore1d918e2009-04-10 23:10:45 +0000820 return Failure;
821 }
Douglas Gregor14f79002009-04-10 03:52:48 +0000822
Douglas Gregor14f79002009-04-10 03:52:48 +0000823 RecordData Record;
824 while (true) {
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000825 unsigned Code = SLocEntryCursor.ReadCode();
Douglas Gregor14f79002009-04-10 03:52:48 +0000826 if (Code == llvm::bitc::END_BLOCK) {
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000827 if (SLocEntryCursor.ReadBlockEnd()) {
Douglas Gregora02b1472009-04-28 21:53:25 +0000828 Error("error at end of Source Manager block in PCH file");
Douglas Gregore1d918e2009-04-10 23:10:45 +0000829 return Failure;
830 }
Douglas Gregore1d918e2009-04-10 23:10:45 +0000831 return Success;
Douglas Gregor14f79002009-04-10 03:52:48 +0000832 }
Mike Stump1eb44332009-09-09 15:08:12 +0000833
Douglas Gregor14f79002009-04-10 03:52:48 +0000834 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
835 // No known subblocks, always skip them.
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000836 SLocEntryCursor.ReadSubBlockID();
837 if (SLocEntryCursor.SkipBlock()) {
Douglas Gregora02b1472009-04-28 21:53:25 +0000838 Error("malformed block record in PCH file");
Douglas Gregore1d918e2009-04-10 23:10:45 +0000839 return Failure;
840 }
Douglas Gregor14f79002009-04-10 03:52:48 +0000841 continue;
842 }
Mike Stump1eb44332009-09-09 15:08:12 +0000843
Douglas Gregor14f79002009-04-10 03:52:48 +0000844 if (Code == llvm::bitc::DEFINE_ABBREV) {
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000845 SLocEntryCursor.ReadAbbrevRecord();
Douglas Gregor14f79002009-04-10 03:52:48 +0000846 continue;
847 }
Mike Stump1eb44332009-09-09 15:08:12 +0000848
Douglas Gregor14f79002009-04-10 03:52:48 +0000849 // Read a record.
850 const char *BlobStart;
851 unsigned BlobLen;
852 Record.clear();
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000853 switch (SLocEntryCursor.ReadRecord(Code, Record, &BlobStart, &BlobLen)) {
Douglas Gregor14f79002009-04-10 03:52:48 +0000854 default: // Default behavior: ignore.
855 break;
856
Chris Lattner2c78b872009-04-14 23:22:57 +0000857 case pch::SM_LINE_TABLE:
Douglas Gregore650c8c2009-07-07 00:12:59 +0000858 if (ParseLineTable(Record))
Douglas Gregorbd945002009-04-13 16:31:14 +0000859 return Failure;
Chris Lattner2c78b872009-04-14 23:22:57 +0000860 break;
Douglas Gregor2eafc1b2009-04-26 00:07:37 +0000861
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000862 case pch::SM_SLOC_FILE_ENTRY:
863 case pch::SM_SLOC_BUFFER_ENTRY:
864 case pch::SM_SLOC_INSTANTIATION_ENTRY:
865 // Once we hit one of the source location entries, we're done.
866 return Success;
Douglas Gregor14f79002009-04-10 03:52:48 +0000867 }
868 }
869}
870
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000871/// \brief Read in the source location entry with the given ID.
872PCHReader::PCHReadResult PCHReader::ReadSLocEntryRecord(unsigned ID) {
873 if (ID == 0)
874 return Success;
875
876 if (ID > TotalNumSLocEntries) {
877 Error("source location entry ID out-of-range for PCH file");
878 return Failure;
879 }
880
881 ++NumSLocEntriesRead;
882 SLocEntryCursor.JumpToBit(SLocOffsets[ID - 1]);
883 unsigned Code = SLocEntryCursor.ReadCode();
884 if (Code == llvm::bitc::END_BLOCK ||
885 Code == llvm::bitc::ENTER_SUBBLOCK ||
886 Code == llvm::bitc::DEFINE_ABBREV) {
887 Error("incorrectly-formatted source location entry in PCH file");
888 return Failure;
889 }
890
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000891 RecordData Record;
892 const char *BlobStart;
893 unsigned BlobLen;
894 switch (SLocEntryCursor.ReadRecord(Code, Record, &BlobStart, &BlobLen)) {
895 default:
896 Error("incorrectly-formatted source location entry in PCH file");
897 return Failure;
898
899 case pch::SM_SLOC_FILE_ENTRY: {
Douglas Gregore650c8c2009-07-07 00:12:59 +0000900 std::string Filename(BlobStart, BlobStart + BlobLen);
901 MaybeAddSystemRootToFilename(Filename);
902 const FileEntry *File = FileMgr.getFile(Filename);
Chris Lattnerd3555ae2009-06-15 04:35:16 +0000903 if (File == 0) {
904 std::string ErrorStr = "could not find file '";
Douglas Gregore650c8c2009-07-07 00:12:59 +0000905 ErrorStr += Filename;
Chris Lattnerd3555ae2009-06-15 04:35:16 +0000906 ErrorStr += "' referenced by PCH file";
907 Error(ErrorStr.c_str());
908 return Failure;
909 }
Mike Stump1eb44332009-09-09 15:08:12 +0000910
Douglas Gregor2d52be52010-03-21 22:49:54 +0000911 if (Record.size() < 10) {
Ted Kremenek1857f622010-03-18 21:23:05 +0000912 Error("source location entry is incorrect");
913 return Failure;
914 }
915
Douglas Gregor9f692a02010-04-09 15:54:22 +0000916 if ((off_t)Record[4] != File->getSize()
917#if !defined(LLVM_ON_WIN32)
918 // In our regression testing, the Windows file system seems to
919 // have inconsistent modification times that sometimes
920 // erroneously trigger this error-handling path.
921 || (time_t)Record[5] != File->getModificationTime()
922#endif
923 ) {
Douglas Gregor2d52be52010-03-21 22:49:54 +0000924 Diag(diag::err_fe_pch_file_modified)
925 << Filename;
926 return Failure;
927 }
928
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000929 FileID FID = SourceMgr.createFileID(File,
930 SourceLocation::getFromRawEncoding(Record[1]),
931 (SrcMgr::CharacteristicKind)Record[2],
932 ID, Record[0]);
933 if (Record[3])
934 const_cast<SrcMgr::FileInfo&>(SourceMgr.getSLocEntry(FID).getFile())
935 .setHasLineDirectives();
936
Douglas Gregor12fab312010-03-16 16:35:32 +0000937 // Reconstruct header-search information for this file.
938 HeaderFileInfo HFI;
Douglas Gregor2d52be52010-03-21 22:49:54 +0000939 HFI.isImport = Record[6];
940 HFI.DirInfo = Record[7];
941 HFI.NumIncludes = Record[8];
942 HFI.ControllingMacroID = Record[9];
Douglas Gregor12fab312010-03-16 16:35:32 +0000943 if (Listener)
944 Listener->ReadHeaderFileInfo(HFI, File->getUID());
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000945 break;
946 }
947
948 case pch::SM_SLOC_BUFFER_ENTRY: {
949 const char *Name = BlobStart;
950 unsigned Offset = Record[0];
951 unsigned Code = SLocEntryCursor.ReadCode();
952 Record.clear();
Mike Stump1eb44332009-09-09 15:08:12 +0000953 unsigned RecCode
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000954 = SLocEntryCursor.ReadRecord(Code, Record, &BlobStart, &BlobLen);
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +0000955
956 if (RecCode != pch::SM_SLOC_BUFFER_BLOB) {
957 Error("PCH record has invalid code");
958 return Failure;
959 }
960
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000961 llvm::MemoryBuffer *Buffer
Chris Lattnera0a270c2010-04-05 22:42:27 +0000962 = llvm::MemoryBuffer::getMemBuffer(llvm::StringRef(BlobStart, BlobLen - 1),
963 Name);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000964 FileID BufferID = SourceMgr.createFileIDForMemBuffer(Buffer, ID, Offset);
Mike Stump1eb44332009-09-09 15:08:12 +0000965
Douglas Gregor92b059e2009-04-28 20:33:11 +0000966 if (strcmp(Name, "<built-in>") == 0) {
967 PCHPredefinesBufferID = BufferID;
968 PCHPredefines = BlobStart;
969 PCHPredefinesLen = BlobLen - 1;
970 }
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000971
972 break;
973 }
974
975 case pch::SM_SLOC_INSTANTIATION_ENTRY: {
Mike Stump1eb44332009-09-09 15:08:12 +0000976 SourceLocation SpellingLoc
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000977 = SourceLocation::getFromRawEncoding(Record[1]);
978 SourceMgr.createInstantiationLoc(SpellingLoc,
979 SourceLocation::getFromRawEncoding(Record[2]),
980 SourceLocation::getFromRawEncoding(Record[3]),
981 Record[4],
982 ID,
983 Record[0]);
984 break;
Mike Stump1eb44332009-09-09 15:08:12 +0000985 }
Douglas Gregor7f94b0b2009-04-27 06:38:32 +0000986 }
987
988 return Success;
989}
990
Chris Lattner6367f6d2009-04-27 01:05:14 +0000991/// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
992/// specified cursor. Read the abbreviations that are at the top of the block
993/// and then leave the cursor pointing into the block.
994bool PCHReader::ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor,
995 unsigned BlockID) {
996 if (Cursor.EnterSubBlock(BlockID)) {
Douglas Gregora02b1472009-04-28 21:53:25 +0000997 Error("malformed block record in PCH file");
Chris Lattner6367f6d2009-04-27 01:05:14 +0000998 return Failure;
999 }
Mike Stump1eb44332009-09-09 15:08:12 +00001000
Chris Lattner6367f6d2009-04-27 01:05:14 +00001001 while (true) {
1002 unsigned Code = Cursor.ReadCode();
Mike Stump1eb44332009-09-09 15:08:12 +00001003
Chris Lattner6367f6d2009-04-27 01:05:14 +00001004 // We expect all abbrevs to be at the start of the block.
1005 if (Code != llvm::bitc::DEFINE_ABBREV)
1006 return false;
1007 Cursor.ReadAbbrevRecord();
1008 }
1009}
1010
Douglas Gregor37e26842009-04-21 23:56:24 +00001011void PCHReader::ReadMacroRecord(uint64_t Offset) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001012 assert(PP && "Forgot to set Preprocessor ?");
Mike Stump1eb44332009-09-09 15:08:12 +00001013
Douglas Gregor37e26842009-04-21 23:56:24 +00001014 // Keep track of where we are in the stream, then jump back there
1015 // after reading this macro.
1016 SavedStreamPosition SavedPosition(Stream);
1017
1018 Stream.JumpToBit(Offset);
1019 RecordData Record;
1020 llvm::SmallVector<IdentifierInfo*, 16> MacroArgs;
1021 MacroInfo *Macro = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001022
Douglas Gregor37e26842009-04-21 23:56:24 +00001023 while (true) {
1024 unsigned Code = Stream.ReadCode();
1025 switch (Code) {
1026 case llvm::bitc::END_BLOCK:
1027 return;
1028
1029 case llvm::bitc::ENTER_SUBBLOCK:
1030 // No known subblocks, always skip them.
1031 Stream.ReadSubBlockID();
1032 if (Stream.SkipBlock()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001033 Error("malformed block record in PCH file");
Douglas Gregor37e26842009-04-21 23:56:24 +00001034 return;
1035 }
1036 continue;
Mike Stump1eb44332009-09-09 15:08:12 +00001037
Douglas Gregor37e26842009-04-21 23:56:24 +00001038 case llvm::bitc::DEFINE_ABBREV:
1039 Stream.ReadAbbrevRecord();
1040 continue;
1041 default: break;
1042 }
1043
1044 // Read a record.
1045 Record.clear();
1046 pch::PreprocessorRecordTypes RecType =
1047 (pch::PreprocessorRecordTypes)Stream.ReadRecord(Code, Record);
1048 switch (RecType) {
Douglas Gregor37e26842009-04-21 23:56:24 +00001049 case pch::PP_MACRO_OBJECT_LIKE:
1050 case pch::PP_MACRO_FUNCTION_LIKE: {
1051 // If we already have a macro, that means that we've hit the end
1052 // of the definition of the macro we were looking for. We're
1053 // done.
1054 if (Macro)
1055 return;
1056
1057 IdentifierInfo *II = DecodeIdentifierInfo(Record[0]);
1058 if (II == 0) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001059 Error("macro must have a name in PCH file");
Douglas Gregor37e26842009-04-21 23:56:24 +00001060 return;
1061 }
1062 SourceLocation Loc = SourceLocation::getFromRawEncoding(Record[1]);
1063 bool isUsed = Record[2];
Mike Stump1eb44332009-09-09 15:08:12 +00001064
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001065 MacroInfo *MI = PP->AllocateMacroInfo(Loc);
Douglas Gregor37e26842009-04-21 23:56:24 +00001066 MI->setIsUsed(isUsed);
Mike Stump1eb44332009-09-09 15:08:12 +00001067
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001068 unsigned NextIndex = 3;
Douglas Gregor37e26842009-04-21 23:56:24 +00001069 if (RecType == pch::PP_MACRO_FUNCTION_LIKE) {
1070 // Decode function-like macro info.
1071 bool isC99VarArgs = Record[3];
1072 bool isGNUVarArgs = Record[4];
1073 MacroArgs.clear();
1074 unsigned NumArgs = Record[5];
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001075 NextIndex = 6 + NumArgs;
Douglas Gregor37e26842009-04-21 23:56:24 +00001076 for (unsigned i = 0; i != NumArgs; ++i)
1077 MacroArgs.push_back(DecodeIdentifierInfo(Record[6+i]));
1078
1079 // Install function-like macro info.
1080 MI->setIsFunctionLike();
1081 if (isC99VarArgs) MI->setIsC99Varargs();
1082 if (isGNUVarArgs) MI->setIsGNUVarargs();
Douglas Gregor75fdb232009-05-22 22:45:36 +00001083 MI->setArgumentList(MacroArgs.data(), MacroArgs.size(),
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001084 PP->getPreprocessorAllocator());
Douglas Gregor37e26842009-04-21 23:56:24 +00001085 }
1086
1087 // Finally, install the macro.
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001088 PP->setMacroInfo(II, MI);
Douglas Gregor37e26842009-04-21 23:56:24 +00001089
1090 // Remember that we saw this macro last so that we add the tokens that
1091 // form its body to it.
1092 Macro = MI;
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001093
1094 if (NextIndex + 1 == Record.size() && PP->getPreprocessingRecord()) {
1095 // We have a macro definition. Load it now.
1096 PP->getPreprocessingRecord()->RegisterMacroDefinition(Macro,
1097 getMacroDefinition(Record[NextIndex]));
1098 }
1099
Douglas Gregor37e26842009-04-21 23:56:24 +00001100 ++NumMacrosRead;
1101 break;
1102 }
Mike Stump1eb44332009-09-09 15:08:12 +00001103
Douglas Gregor37e26842009-04-21 23:56:24 +00001104 case pch::PP_TOKEN: {
1105 // If we see a TOKEN before a PP_MACRO_*, then the file is
1106 // erroneous, just pretend we didn't see this.
1107 if (Macro == 0) break;
Mike Stump1eb44332009-09-09 15:08:12 +00001108
Douglas Gregor37e26842009-04-21 23:56:24 +00001109 Token Tok;
1110 Tok.startToken();
1111 Tok.setLocation(SourceLocation::getFromRawEncoding(Record[0]));
1112 Tok.setLength(Record[1]);
1113 if (IdentifierInfo *II = DecodeIdentifierInfo(Record[2]))
1114 Tok.setIdentifierInfo(II);
1115 Tok.setKind((tok::TokenKind)Record[3]);
1116 Tok.setFlag((Token::TokenFlags)Record[4]);
1117 Macro->AddTokenToBody(Tok);
1118 break;
1119 }
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001120
1121 case pch::PP_MACRO_INSTANTIATION: {
1122 // If we already have a macro, that means that we've hit the end
1123 // of the definition of the macro we were looking for. We're
1124 // done.
1125 if (Macro)
1126 return;
1127
1128 if (!PP->getPreprocessingRecord()) {
1129 Error("missing preprocessing record in PCH file");
1130 return;
1131 }
1132
1133 PreprocessingRecord &PPRec = *PP->getPreprocessingRecord();
1134 if (PPRec.getPreprocessedEntity(Record[0]))
1135 return;
1136
1137 MacroInstantiation *MI
1138 = new (PPRec) MacroInstantiation(DecodeIdentifierInfo(Record[3]),
1139 SourceRange(
1140 SourceLocation::getFromRawEncoding(Record[1]),
1141 SourceLocation::getFromRawEncoding(Record[2])),
1142 getMacroDefinition(Record[4]));
1143 PPRec.SetPreallocatedEntity(Record[0], MI);
1144 return;
1145 }
1146
1147 case pch::PP_MACRO_DEFINITION: {
1148 // If we already have a macro, that means that we've hit the end
1149 // of the definition of the macro we were looking for. We're
1150 // done.
1151 if (Macro)
1152 return;
1153
1154 if (!PP->getPreprocessingRecord()) {
1155 Error("missing preprocessing record in PCH file");
1156 return;
1157 }
1158
1159 PreprocessingRecord &PPRec = *PP->getPreprocessingRecord();
1160 if (PPRec.getPreprocessedEntity(Record[0]))
1161 return;
1162
1163 if (Record[1] >= MacroDefinitionsLoaded.size()) {
1164 Error("out-of-bounds macro definition record");
1165 return;
1166 }
1167
1168 MacroDefinition *MD
1169 = new (PPRec) MacroDefinition(DecodeIdentifierInfo(Record[4]),
1170 SourceLocation::getFromRawEncoding(Record[5]),
1171 SourceRange(
1172 SourceLocation::getFromRawEncoding(Record[2]),
1173 SourceLocation::getFromRawEncoding(Record[3])));
1174 PPRec.SetPreallocatedEntity(Record[0], MD);
1175 MacroDefinitionsLoaded[Record[1]] = MD;
1176 return;
1177 }
Steve Naroff83d63c72009-04-24 20:03:17 +00001178 }
Douglas Gregor37e26842009-04-21 23:56:24 +00001179 }
1180}
1181
Douglas Gregor88a35862010-01-04 19:18:44 +00001182void PCHReader::ReadDefinedMacros() {
1183 // If there was no preprocessor block, do nothing.
1184 if (!MacroCursor.getBitStreamReader())
1185 return;
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001186
Douglas Gregor88a35862010-01-04 19:18:44 +00001187 llvm::BitstreamCursor Cursor = MacroCursor;
1188 if (Cursor.EnterSubBlock(pch::PREPROCESSOR_BLOCK_ID)) {
1189 Error("malformed preprocessor block record in PCH file");
1190 return;
1191 }
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001192
Douglas Gregor88a35862010-01-04 19:18:44 +00001193 RecordData Record;
1194 while (true) {
1195 unsigned Code = Cursor.ReadCode();
1196 if (Code == llvm::bitc::END_BLOCK) {
1197 if (Cursor.ReadBlockEnd())
1198 Error("error at end of preprocessor block in PCH file");
1199 return;
1200 }
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001201
Douglas Gregor88a35862010-01-04 19:18:44 +00001202 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
1203 // No known subblocks, always skip them.
1204 Cursor.ReadSubBlockID();
1205 if (Cursor.SkipBlock()) {
1206 Error("malformed block record in PCH file");
1207 return;
1208 }
1209 continue;
1210 }
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001211
Douglas Gregor88a35862010-01-04 19:18:44 +00001212 if (Code == llvm::bitc::DEFINE_ABBREV) {
1213 Cursor.ReadAbbrevRecord();
1214 continue;
1215 }
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001216
Douglas Gregor88a35862010-01-04 19:18:44 +00001217 // Read a record.
1218 const char *BlobStart;
1219 unsigned BlobLen;
1220 Record.clear();
1221 switch (Cursor.ReadRecord(Code, Record, &BlobStart, &BlobLen)) {
1222 default: // Default behavior: ignore.
1223 break;
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001224
Douglas Gregor88a35862010-01-04 19:18:44 +00001225 case pch::PP_MACRO_OBJECT_LIKE:
1226 case pch::PP_MACRO_FUNCTION_LIKE:
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001227 DecodeIdentifierInfo(Record[0]);
Douglas Gregor88a35862010-01-04 19:18:44 +00001228 break;
1229
1230 case pch::PP_TOKEN:
1231 // Ignore tokens.
1232 break;
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001233
1234 case pch::PP_MACRO_INSTANTIATION:
1235 case pch::PP_MACRO_DEFINITION:
1236 // Read the macro record.
1237 ReadMacroRecord(Cursor.GetCurrentBitNo());
1238 break;
Douglas Gregor88a35862010-01-04 19:18:44 +00001239 }
1240 }
1241}
1242
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001243MacroDefinition *PCHReader::getMacroDefinition(pch::IdentID ID) {
1244 if (ID == 0 || ID >= MacroDefinitionsLoaded.size())
1245 return 0;
1246
1247 if (!MacroDefinitionsLoaded[ID])
1248 ReadMacroRecord(MacroDefinitionOffsets[ID]);
1249
1250 return MacroDefinitionsLoaded[ID];
1251}
1252
Douglas Gregore650c8c2009-07-07 00:12:59 +00001253/// \brief If we are loading a relocatable PCH file, and the filename is
1254/// not an absolute path, add the system root to the beginning of the file
1255/// name.
1256void PCHReader::MaybeAddSystemRootToFilename(std::string &Filename) {
1257 // If this is not a relocatable PCH file, there's nothing to do.
1258 if (!RelocatablePCH)
1259 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001260
Daniel Dunbard5b21972009-11-18 19:50:41 +00001261 if (Filename.empty() || llvm::sys::Path(Filename).isAbsolute())
Douglas Gregore650c8c2009-07-07 00:12:59 +00001262 return;
1263
Douglas Gregore650c8c2009-07-07 00:12:59 +00001264 if (isysroot == 0) {
1265 // If no system root was given, default to '/'
1266 Filename.insert(Filename.begin(), '/');
1267 return;
1268 }
Mike Stump1eb44332009-09-09 15:08:12 +00001269
Douglas Gregore650c8c2009-07-07 00:12:59 +00001270 unsigned Length = strlen(isysroot);
1271 if (isysroot[Length - 1] != '/')
1272 Filename.insert(Filename.begin(), '/');
Mike Stump1eb44332009-09-09 15:08:12 +00001273
Douglas Gregore650c8c2009-07-07 00:12:59 +00001274 Filename.insert(Filename.begin(), isysroot, isysroot + Length);
1275}
1276
Mike Stump1eb44332009-09-09 15:08:12 +00001277PCHReader::PCHReadResult
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001278PCHReader::ReadPCHBlock() {
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001279 if (Stream.EnterSubBlock(pch::PCH_BLOCK_ID)) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001280 Error("malformed block record in PCH file");
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001281 return Failure;
1282 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001283
1284 // Read all of the records and blocks for the PCH file.
Douglas Gregor8038d512009-04-10 17:25:41 +00001285 RecordData Record;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001286 while (!Stream.AtEndOfStream()) {
1287 unsigned Code = Stream.ReadCode();
1288 if (Code == llvm::bitc::END_BLOCK) {
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001289 if (Stream.ReadBlockEnd()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001290 Error("error at end of module block in PCH file");
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001291 return Failure;
1292 }
Chris Lattner7356a312009-04-11 21:15:38 +00001293
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001294 return Success;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001295 }
1296
1297 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
1298 switch (Stream.ReadSubBlockID()) {
Douglas Gregor61d60ee2009-10-17 00:13:19 +00001299 case pch::DECLTYPES_BLOCK_ID:
Chris Lattner6367f6d2009-04-27 01:05:14 +00001300 // We lazily load the decls block, but we want to set up the
1301 // DeclsCursor cursor to point into it. Clone our current bitcode
1302 // cursor to it, enter the block and read the abbrevs in that block.
1303 // With the main cursor, we just skip over it.
1304 DeclsCursor = Stream;
1305 if (Stream.SkipBlock() || // Skip with the main cursor.
1306 // Read the abbrevs.
Douglas Gregor61d60ee2009-10-17 00:13:19 +00001307 ReadBlockAbbrevs(DeclsCursor, pch::DECLTYPES_BLOCK_ID)) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001308 Error("malformed block record in PCH file");
Chris Lattner6367f6d2009-04-27 01:05:14 +00001309 return Failure;
1310 }
1311 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001312
Chris Lattner7356a312009-04-11 21:15:38 +00001313 case pch::PREPROCESSOR_BLOCK_ID:
Douglas Gregor88a35862010-01-04 19:18:44 +00001314 MacroCursor = Stream;
1315 if (PP)
1316 PP->setExternalSource(this);
1317
Chris Lattner7356a312009-04-11 21:15:38 +00001318 if (Stream.SkipBlock()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001319 Error("malformed block record in PCH file");
Chris Lattner7356a312009-04-11 21:15:38 +00001320 return Failure;
1321 }
1322 break;
Steve Naroff90cd1bb2009-04-23 10:39:46 +00001323
Douglas Gregor14f79002009-04-10 03:52:48 +00001324 case pch::SOURCE_MANAGER_BLOCK_ID:
Douglas Gregore1d918e2009-04-10 23:10:45 +00001325 switch (ReadSourceManagerBlock()) {
1326 case Success:
1327 break;
1328
1329 case Failure:
Douglas Gregora02b1472009-04-28 21:53:25 +00001330 Error("malformed source manager block in PCH file");
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001331 return Failure;
Douglas Gregore1d918e2009-04-10 23:10:45 +00001332
1333 case IgnorePCH:
1334 return IgnorePCH;
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001335 }
Douglas Gregor14f79002009-04-10 03:52:48 +00001336 break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001337 }
Douglas Gregor8038d512009-04-10 17:25:41 +00001338 continue;
1339 }
1340
1341 if (Code == llvm::bitc::DEFINE_ABBREV) {
1342 Stream.ReadAbbrevRecord();
1343 continue;
1344 }
1345
1346 // Read and process a record.
1347 Record.clear();
Douglas Gregor2bec0412009-04-10 21:16:55 +00001348 const char *BlobStart = 0;
1349 unsigned BlobLen = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001350 switch ((pch::PCHRecordTypes)Stream.ReadRecord(Code, Record,
Douglas Gregor2bec0412009-04-10 21:16:55 +00001351 &BlobStart, &BlobLen)) {
Douglas Gregor8038d512009-04-10 17:25:41 +00001352 default: // Default behavior: ignore.
1353 break;
1354
1355 case pch::TYPE_OFFSET:
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00001356 if (!TypesLoaded.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001357 Error("duplicate TYPE_OFFSET record in PCH file");
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001358 return Failure;
1359 }
Chris Lattnerc732f5a2009-04-27 18:24:17 +00001360 TypeOffsets = (const uint32_t *)BlobStart;
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00001361 TypesLoaded.resize(Record[0]);
Douglas Gregor8038d512009-04-10 17:25:41 +00001362 break;
1363
1364 case pch::DECL_OFFSET:
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00001365 if (!DeclsLoaded.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001366 Error("duplicate DECL_OFFSET record in PCH file");
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001367 return Failure;
1368 }
Chris Lattnerc732f5a2009-04-27 18:24:17 +00001369 DeclOffsets = (const uint32_t *)BlobStart;
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00001370 DeclsLoaded.resize(Record[0]);
Douglas Gregor8038d512009-04-10 17:25:41 +00001371 break;
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001372
1373 case pch::LANGUAGE_OPTIONS:
1374 if (ParseLanguageOptions(Record))
1375 return IgnorePCH;
1376 break;
Douglas Gregor2bec0412009-04-10 21:16:55 +00001377
Douglas Gregorab41e632009-04-27 22:23:34 +00001378 case pch::METADATA: {
1379 if (Record[0] != pch::VERSION_MAJOR) {
1380 Diag(Record[0] < pch::VERSION_MAJOR? diag::warn_pch_version_too_old
1381 : diag::warn_pch_version_too_new);
1382 return IgnorePCH;
1383 }
1384
Douglas Gregore650c8c2009-07-07 00:12:59 +00001385 RelocatablePCH = Record[4];
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001386 if (Listener) {
1387 std::string TargetTriple(BlobStart, BlobLen);
1388 if (Listener->ReadTargetTriple(TargetTriple))
1389 return IgnorePCH;
Douglas Gregor2bec0412009-04-10 21:16:55 +00001390 }
1391 break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001392 }
Douglas Gregorafaf3082009-04-11 00:14:32 +00001393
1394 case pch::IDENTIFIER_TABLE:
Douglas Gregor668c1a42009-04-21 22:25:48 +00001395 IdentifierTableData = BlobStart;
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001396 if (Record[0]) {
Mike Stump1eb44332009-09-09 15:08:12 +00001397 IdentifierLookupTable
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001398 = PCHIdentifierLookupTable::Create(
Douglas Gregor668c1a42009-04-21 22:25:48 +00001399 (const unsigned char *)IdentifierTableData + Record[0],
Mike Stump1eb44332009-09-09 15:08:12 +00001400 (const unsigned char *)IdentifierTableData,
Douglas Gregor668c1a42009-04-21 22:25:48 +00001401 PCHIdentifierLookupTrait(*this));
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001402 if (PP)
1403 PP->getIdentifierTable().setExternalIdentifierLookup(this);
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001404 }
Douglas Gregorafaf3082009-04-11 00:14:32 +00001405 break;
1406
1407 case pch::IDENTIFIER_OFFSET:
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001408 if (!IdentifiersLoaded.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001409 Error("duplicate IDENTIFIER_OFFSET record in PCH file");
Douglas Gregorafaf3082009-04-11 00:14:32 +00001410 return Failure;
1411 }
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001412 IdentifierOffsets = (const uint32_t *)BlobStart;
1413 IdentifiersLoaded.resize(Record[0]);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001414 if (PP)
1415 PP->getHeaderSearchInfo().SetExternalLookup(this);
Douglas Gregorafaf3082009-04-11 00:14:32 +00001416 break;
Douglas Gregorfdd01722009-04-14 00:24:19 +00001417
1418 case pch::EXTERNAL_DEFINITIONS:
1419 if (!ExternalDefinitions.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001420 Error("duplicate EXTERNAL_DEFINITIONS record in PCH file");
Douglas Gregorfdd01722009-04-14 00:24:19 +00001421 return Failure;
1422 }
1423 ExternalDefinitions.swap(Record);
1424 break;
Douglas Gregor3e1af842009-04-17 22:13:46 +00001425
Douglas Gregorad1de002009-04-18 05:55:16 +00001426 case pch::SPECIAL_TYPES:
1427 SpecialTypes.swap(Record);
1428 break;
1429
Douglas Gregor3e1af842009-04-17 22:13:46 +00001430 case pch::STATISTICS:
1431 TotalNumStatements = Record[0];
Douglas Gregor37e26842009-04-21 23:56:24 +00001432 TotalNumMacros = Record[1];
Douglas Gregor25123082009-04-22 22:34:57 +00001433 TotalLexicalDeclContexts = Record[2];
1434 TotalVisibleDeclContexts = Record[3];
Douglas Gregor3e1af842009-04-17 22:13:46 +00001435 break;
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001436
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00001437 case pch::TENTATIVE_DEFINITIONS:
1438 if (!TentativeDefinitions.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001439 Error("duplicate TENTATIVE_DEFINITIONS record in PCH file");
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00001440 return Failure;
1441 }
1442 TentativeDefinitions.swap(Record);
1443 break;
Douglas Gregor14c22f22009-04-22 22:18:58 +00001444
Tanya Lattnere6bbc012010-02-12 00:07:30 +00001445 case pch::UNUSED_STATIC_FUNCS:
1446 if (!UnusedStaticFuncs.empty()) {
1447 Error("duplicate UNUSED_STATIC_FUNCS record in PCH file");
1448 return Failure;
1449 }
1450 UnusedStaticFuncs.swap(Record);
1451 break;
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001452
Douglas Gregor14c22f22009-04-22 22:18:58 +00001453 case pch::LOCALLY_SCOPED_EXTERNAL_DECLS:
1454 if (!LocallyScopedExternalDecls.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001455 Error("duplicate LOCALLY_SCOPED_EXTERNAL_DECLS record in PCH file");
Douglas Gregor14c22f22009-04-22 22:18:58 +00001456 return Failure;
1457 }
1458 LocallyScopedExternalDecls.swap(Record);
1459 break;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001460
Douglas Gregor83941df2009-04-25 17:48:32 +00001461 case pch::SELECTOR_OFFSETS:
1462 SelectorOffsets = (const uint32_t *)BlobStart;
1463 TotalNumSelectors = Record[0];
1464 SelectorsLoaded.resize(TotalNumSelectors);
1465 break;
1466
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001467 case pch::METHOD_POOL:
Douglas Gregor83941df2009-04-25 17:48:32 +00001468 MethodPoolLookupTableData = (const unsigned char *)BlobStart;
1469 if (Record[0])
Mike Stump1eb44332009-09-09 15:08:12 +00001470 MethodPoolLookupTable
Douglas Gregor83941df2009-04-25 17:48:32 +00001471 = PCHMethodPoolLookupTable::Create(
1472 MethodPoolLookupTableData + Record[0],
Mike Stump1eb44332009-09-09 15:08:12 +00001473 MethodPoolLookupTableData,
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001474 PCHMethodPoolLookupTrait(*this));
Douglas Gregor83941df2009-04-25 17:48:32 +00001475 TotalSelectorsInMethodPool = Record[1];
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001476 break;
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001477
1478 case pch::PP_COUNTER_VALUE:
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001479 if (!Record.empty() && Listener)
1480 Listener->ReadCounter(Record[0]);
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001481 break;
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001482
1483 case pch::SOURCE_LOCATION_OFFSETS:
Chris Lattner090d9b52009-04-27 19:01:47 +00001484 SLocOffsets = (const uint32_t *)BlobStart;
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001485 TotalNumSLocEntries = Record[0];
Douglas Gregor445e23e2009-10-05 21:07:28 +00001486 SourceMgr.PreallocateSLocEntries(this, TotalNumSLocEntries, Record[1]);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001487 break;
1488
1489 case pch::SOURCE_LOCATION_PRELOADS:
1490 for (unsigned I = 0, N = Record.size(); I != N; ++I) {
1491 PCHReadResult Result = ReadSLocEntryRecord(Record[I]);
1492 if (Result != Success)
1493 return Result;
1494 }
1495 break;
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001496
Douglas Gregor52e71082009-10-16 18:18:30 +00001497 case pch::STAT_CACHE: {
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001498 PCHStatCache *MyStatCache =
Douglas Gregor52e71082009-10-16 18:18:30 +00001499 new PCHStatCache((const unsigned char *)BlobStart + Record[0],
1500 (const unsigned char *)BlobStart,
1501 NumStatHits, NumStatMisses);
1502 FileMgr.addStatCache(MyStatCache);
1503 StatCache = MyStatCache;
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001504 break;
Douglas Gregor52e71082009-10-16 18:18:30 +00001505 }
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001506
Douglas Gregorb81c1702009-04-27 20:06:05 +00001507 case pch::EXT_VECTOR_DECLS:
1508 if (!ExtVectorDecls.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001509 Error("duplicate EXT_VECTOR_DECLS record in PCH file");
Douglas Gregorb81c1702009-04-27 20:06:05 +00001510 return Failure;
1511 }
1512 ExtVectorDecls.swap(Record);
1513 break;
1514
Douglas Gregorb64c1932009-05-12 01:31:05 +00001515 case pch::ORIGINAL_FILE_NAME:
Daniel Dunbar7b5a1212009-11-11 05:29:04 +00001516 ActualOriginalFileName.assign(BlobStart, BlobLen);
1517 OriginalFileName = ActualOriginalFileName;
Douglas Gregore650c8c2009-07-07 00:12:59 +00001518 MaybeAddSystemRootToFilename(OriginalFileName);
Douglas Gregorb64c1932009-05-12 01:31:05 +00001519 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001520
Ted Kremenek5b4ec632010-01-22 20:59:36 +00001521 case pch::VERSION_CONTROL_BRANCH_REVISION: {
Ted Kremenek974be4d2010-02-12 23:31:14 +00001522 const std::string &CurBranch = getClangFullRepositoryVersion();
Ted Kremenek517e6762010-01-22 20:55:35 +00001523 llvm::StringRef PCHBranch(BlobStart, BlobLen);
Ted Kremenek974be4d2010-02-12 23:31:14 +00001524 if (llvm::StringRef(CurBranch) != PCHBranch) {
Douglas Gregor445e23e2009-10-05 21:07:28 +00001525 Diag(diag::warn_pch_different_branch) << PCHBranch << CurBranch;
1526 return IgnorePCH;
1527 }
1528 break;
1529 }
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001530
1531 case pch::MACRO_DEFINITION_OFFSETS:
1532 MacroDefinitionOffsets = (const uint32_t *)BlobStart;
1533 if (PP) {
1534 if (!PP->getPreprocessingRecord())
1535 PP->createPreprocessingRecord();
1536 PP->getPreprocessingRecord()->SetExternalSource(*this, Record[0]);
1537 } else {
1538 NumPreallocatedPreprocessingEntities = Record[0];
1539 }
1540
1541 MacroDefinitionsLoaded.resize(Record[1]);
1542 break;
Douglas Gregorafaf3082009-04-11 00:14:32 +00001543 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001544 }
Douglas Gregora02b1472009-04-28 21:53:25 +00001545 Error("premature end of bitstream in PCH file");
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001546 return Failure;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001547}
1548
Douglas Gregore1d918e2009-04-10 23:10:45 +00001549PCHReader::PCHReadResult PCHReader::ReadPCH(const std::string &FileName) {
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001550 // Set the PCH file name.
1551 this->FileName = FileName;
1552
Douglas Gregor2cf26342009-04-09 22:27:44 +00001553 // Open the PCH file.
Daniel Dunbarf3c740e2009-09-22 05:38:01 +00001554 //
1555 // FIXME: This shouldn't be here, we should just take a raw_ostream.
Douglas Gregor2cf26342009-04-09 22:27:44 +00001556 std::string ErrStr;
Daniel Dunbar731ad8f2009-11-10 00:46:19 +00001557 Buffer.reset(llvm::MemoryBuffer::getFileOrSTDIN(FileName, &ErrStr));
Douglas Gregore1d918e2009-04-10 23:10:45 +00001558 if (!Buffer) {
1559 Error(ErrStr.c_str());
1560 return IgnorePCH;
1561 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001562
1563 // Initialize the stream
Mike Stump1eb44332009-09-09 15:08:12 +00001564 StreamFile.init((const unsigned char *)Buffer->getBufferStart(),
Chris Lattnerb9fa9172009-04-26 20:59:20 +00001565 (const unsigned char *)Buffer->getBufferEnd());
1566 Stream.init(StreamFile);
Douglas Gregor2cf26342009-04-09 22:27:44 +00001567
1568 // Sniff for the signature.
1569 if (Stream.Read(8) != 'C' ||
1570 Stream.Read(8) != 'P' ||
1571 Stream.Read(8) != 'C' ||
Douglas Gregore1d918e2009-04-10 23:10:45 +00001572 Stream.Read(8) != 'H') {
Douglas Gregora02b1472009-04-28 21:53:25 +00001573 Diag(diag::err_not_a_pch_file) << FileName;
1574 return Failure;
Douglas Gregore1d918e2009-04-10 23:10:45 +00001575 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001576
Douglas Gregor2cf26342009-04-09 22:27:44 +00001577 while (!Stream.AtEndOfStream()) {
1578 unsigned Code = Stream.ReadCode();
Mike Stump1eb44332009-09-09 15:08:12 +00001579
Douglas Gregore1d918e2009-04-10 23:10:45 +00001580 if (Code != llvm::bitc::ENTER_SUBBLOCK) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001581 Error("invalid record at top-level of PCH file");
Douglas Gregore1d918e2009-04-10 23:10:45 +00001582 return Failure;
1583 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001584
1585 unsigned BlockID = Stream.ReadSubBlockID();
Douglas Gregor668c1a42009-04-21 22:25:48 +00001586
Douglas Gregor2cf26342009-04-09 22:27:44 +00001587 // We only know the PCH subblock ID.
1588 switch (BlockID) {
1589 case llvm::bitc::BLOCKINFO_BLOCK_ID:
Douglas Gregore1d918e2009-04-10 23:10:45 +00001590 if (Stream.ReadBlockInfoBlock()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001591 Error("malformed BlockInfoBlock in PCH file");
Douglas Gregore1d918e2009-04-10 23:10:45 +00001592 return Failure;
1593 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001594 break;
1595 case pch::PCH_BLOCK_ID:
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001596 switch (ReadPCHBlock()) {
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001597 case Success:
1598 break;
1599
1600 case Failure:
Douglas Gregore1d918e2009-04-10 23:10:45 +00001601 return Failure;
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001602
1603 case IgnorePCH:
Douglas Gregor2bec0412009-04-10 21:16:55 +00001604 // FIXME: We could consider reading through to the end of this
1605 // PCH block, skipping subblocks, to see if there are other
1606 // PCH blocks elsewhere.
Douglas Gregor2bf1eb02009-04-27 21:28:04 +00001607
1608 // Clear out any preallocated source location entries, so that
1609 // the source manager does not try to resolve them later.
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001610 SourceMgr.ClearPreallocatedSLocEntries();
Douglas Gregor2bf1eb02009-04-27 21:28:04 +00001611
1612 // Remove the stat cache.
Douglas Gregor52e71082009-10-16 18:18:30 +00001613 if (StatCache)
1614 FileMgr.removeStatCache((PCHStatCache*)StatCache);
Douglas Gregor2bf1eb02009-04-27 21:28:04 +00001615
Douglas Gregore1d918e2009-04-10 23:10:45 +00001616 return IgnorePCH;
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001617 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001618 break;
1619 default:
Douglas Gregore1d918e2009-04-10 23:10:45 +00001620 if (Stream.SkipBlock()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00001621 Error("malformed block record in PCH file");
Douglas Gregore1d918e2009-04-10 23:10:45 +00001622 return Failure;
1623 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001624 break;
1625 }
Mike Stump1eb44332009-09-09 15:08:12 +00001626 }
1627
Douglas Gregor92b059e2009-04-28 20:33:11 +00001628 // Check the predefines buffer.
Daniel Dunbardc3c0d22009-11-11 00:52:11 +00001629 if (CheckPredefinesBuffer(llvm::StringRef(PCHPredefines, PCHPredefinesLen),
Douglas Gregor92b059e2009-04-28 20:33:11 +00001630 PCHPredefinesBufferID))
1631 return IgnorePCH;
Mike Stump1eb44332009-09-09 15:08:12 +00001632
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001633 if (PP) {
Zhongxing Xu08996212009-07-18 09:26:51 +00001634 // Initialization of keywords and pragmas occurs before the
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001635 // PCH file is read, so there may be some identifiers that were
1636 // loaded into the IdentifierTable before we intercepted the
1637 // creation of identifiers. Iterate through the list of known
1638 // identifiers and determine whether we have to establish
1639 // preprocessor definitions or top-level identifier declaration
1640 // chains for those identifiers.
1641 //
1642 // We copy the IdentifierInfo pointers to a small vector first,
1643 // since de-serializing declarations or macro definitions can add
1644 // new entries into the identifier table, invalidating the
1645 // iterators.
1646 llvm::SmallVector<IdentifierInfo *, 128> Identifiers;
1647 for (IdentifierTable::iterator Id = PP->getIdentifierTable().begin(),
1648 IdEnd = PP->getIdentifierTable().end();
1649 Id != IdEnd; ++Id)
1650 Identifiers.push_back(Id->second);
Mike Stump1eb44332009-09-09 15:08:12 +00001651 PCHIdentifierLookupTable *IdTable
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001652 = (PCHIdentifierLookupTable *)IdentifierLookupTable;
1653 for (unsigned I = 0, N = Identifiers.size(); I != N; ++I) {
1654 IdentifierInfo *II = Identifiers[I];
1655 // Look in the on-disk hash table for an entry for
1656 PCHIdentifierLookupTrait Info(*this, II);
Daniel Dunbare013d682009-10-18 20:26:12 +00001657 std::pair<const char*, unsigned> Key(II->getNameStart(), II->getLength());
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001658 PCHIdentifierLookupTable::iterator Pos = IdTable->find(Key, &Info);
1659 if (Pos == IdTable->end())
1660 continue;
Mike Stump1eb44332009-09-09 15:08:12 +00001661
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001662 // Dereferencing the iterator has the effect of populating the
1663 // IdentifierInfo node with the various declarations it needs.
1664 (void)*Pos;
1665 }
Douglas Gregor668c1a42009-04-21 22:25:48 +00001666 }
1667
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001668 if (Context)
1669 InitializeContext(*Context);
Douglas Gregor0b748912009-04-14 21:18:50 +00001670
Douglas Gregor668c1a42009-04-21 22:25:48 +00001671 return Success;
Douglas Gregor0b748912009-04-14 21:18:50 +00001672}
1673
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001674void PCHReader::setPreprocessor(Preprocessor &pp) {
1675 PP = &pp;
1676
1677 if (NumPreallocatedPreprocessingEntities) {
1678 if (!PP->getPreprocessingRecord())
1679 PP->createPreprocessingRecord();
1680 PP->getPreprocessingRecord()->SetExternalSource(*this,
1681 NumPreallocatedPreprocessingEntities);
1682 NumPreallocatedPreprocessingEntities = 0;
1683 }
1684}
1685
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001686void PCHReader::InitializeContext(ASTContext &Ctx) {
1687 Context = &Ctx;
1688 assert(Context && "Passed null context!");
1689
1690 assert(PP && "Forgot to set Preprocessor ?");
1691 PP->getIdentifierTable().setExternalIdentifierLookup(this);
1692 PP->getHeaderSearchInfo().SetExternalLookup(this);
Douglas Gregor88a35862010-01-04 19:18:44 +00001693 PP->setExternalSource(this);
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00001694
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001695 // Load the translation unit declaration
1696 ReadDeclRecord(DeclOffsets[0], 0);
1697
1698 // Load the special types.
1699 Context->setBuiltinVaListType(
1700 GetType(SpecialTypes[pch::SPECIAL_TYPE_BUILTIN_VA_LIST]));
1701 if (unsigned Id = SpecialTypes[pch::SPECIAL_TYPE_OBJC_ID])
1702 Context->setObjCIdType(GetType(Id));
1703 if (unsigned Sel = SpecialTypes[pch::SPECIAL_TYPE_OBJC_SELECTOR])
1704 Context->setObjCSelType(GetType(Sel));
1705 if (unsigned Proto = SpecialTypes[pch::SPECIAL_TYPE_OBJC_PROTOCOL])
1706 Context->setObjCProtoType(GetType(Proto));
1707 if (unsigned Class = SpecialTypes[pch::SPECIAL_TYPE_OBJC_CLASS])
1708 Context->setObjCClassType(GetType(Class));
Steve Naroff14108da2009-07-10 23:34:53 +00001709
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001710 if (unsigned String = SpecialTypes[pch::SPECIAL_TYPE_CF_CONSTANT_STRING])
1711 Context->setCFConstantStringType(GetType(String));
Mike Stump1eb44332009-09-09 15:08:12 +00001712 if (unsigned FastEnum
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001713 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_FAST_ENUMERATION_STATE])
1714 Context->setObjCFastEnumerationStateType(GetType(FastEnum));
Douglas Gregorc29f77b2009-07-07 16:35:42 +00001715 if (unsigned File = SpecialTypes[pch::SPECIAL_TYPE_FILE]) {
1716 QualType FileType = GetType(File);
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001717 if (FileType.isNull()) {
1718 Error("FILE type is NULL");
1719 return;
1720 }
John McCall183700f2009-09-21 23:43:11 +00001721 if (const TypedefType *Typedef = FileType->getAs<TypedefType>())
Douglas Gregorc29f77b2009-07-07 16:35:42 +00001722 Context->setFILEDecl(Typedef->getDecl());
1723 else {
Ted Kremenek6217b802009-07-29 21:53:49 +00001724 const TagType *Tag = FileType->getAs<TagType>();
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001725 if (!Tag) {
1726 Error("Invalid FILE type in PCH file");
1727 return;
1728 }
Douglas Gregorc29f77b2009-07-07 16:35:42 +00001729 Context->setFILEDecl(Tag->getDecl());
1730 }
1731 }
Mike Stump782fa302009-07-28 02:25:19 +00001732 if (unsigned Jmp_buf = SpecialTypes[pch::SPECIAL_TYPE_jmp_buf]) {
1733 QualType Jmp_bufType = GetType(Jmp_buf);
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001734 if (Jmp_bufType.isNull()) {
1735 Error("jmp_bug type is NULL");
1736 return;
1737 }
John McCall183700f2009-09-21 23:43:11 +00001738 if (const TypedefType *Typedef = Jmp_bufType->getAs<TypedefType>())
Mike Stump782fa302009-07-28 02:25:19 +00001739 Context->setjmp_bufDecl(Typedef->getDecl());
1740 else {
Ted Kremenek6217b802009-07-29 21:53:49 +00001741 const TagType *Tag = Jmp_bufType->getAs<TagType>();
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001742 if (!Tag) {
1743 Error("Invalid jmp_bug type in PCH file");
1744 return;
1745 }
Mike Stump782fa302009-07-28 02:25:19 +00001746 Context->setjmp_bufDecl(Tag->getDecl());
1747 }
1748 }
1749 if (unsigned Sigjmp_buf = SpecialTypes[pch::SPECIAL_TYPE_sigjmp_buf]) {
1750 QualType Sigjmp_bufType = GetType(Sigjmp_buf);
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001751 if (Sigjmp_bufType.isNull()) {
1752 Error("sigjmp_buf type is NULL");
1753 return;
1754 }
John McCall183700f2009-09-21 23:43:11 +00001755 if (const TypedefType *Typedef = Sigjmp_bufType->getAs<TypedefType>())
Mike Stump782fa302009-07-28 02:25:19 +00001756 Context->setsigjmp_bufDecl(Typedef->getDecl());
1757 else {
Ted Kremenek6217b802009-07-29 21:53:49 +00001758 const TagType *Tag = Sigjmp_bufType->getAs<TagType>();
Mike Stump782fa302009-07-28 02:25:19 +00001759 assert(Tag && "Invalid sigjmp_buf type in PCH file");
1760 Context->setsigjmp_bufDecl(Tag->getDecl());
1761 }
1762 }
Mike Stump1eb44332009-09-09 15:08:12 +00001763 if (unsigned ObjCIdRedef
Douglas Gregord1571ac2009-08-21 00:27:50 +00001764 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_ID_REDEFINITION])
1765 Context->ObjCIdRedefinitionType = GetType(ObjCIdRedef);
Mike Stump1eb44332009-09-09 15:08:12 +00001766 if (unsigned ObjCClassRedef
Douglas Gregord1571ac2009-08-21 00:27:50 +00001767 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_CLASS_REDEFINITION])
1768 Context->ObjCClassRedefinitionType = GetType(ObjCClassRedef);
Mike Stumpadaaad32009-10-20 02:12:22 +00001769 if (unsigned String = SpecialTypes[pch::SPECIAL_TYPE_BLOCK_DESCRIPTOR])
1770 Context->setBlockDescriptorType(GetType(String));
Mike Stump083c25e2009-10-22 00:49:09 +00001771 if (unsigned String
1772 = SpecialTypes[pch::SPECIAL_TYPE_BLOCK_EXTENDED_DESCRIPTOR])
1773 Context->setBlockDescriptorExtendedType(GetType(String));
Fariborz Jahanian2bb5dda2010-04-23 17:41:07 +00001774 if (unsigned ObjCSelRedef
1775 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_SEL_REDEFINITION])
1776 Context->ObjCSelRedefinitionType = GetType(ObjCSelRedef);
1777 if (unsigned String = SpecialTypes[pch::SPECIAL_TYPE_NS_CONSTANT_STRING])
1778 Context->setNSConstantStringType(GetType(String));
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001779}
1780
Douglas Gregorb64c1932009-05-12 01:31:05 +00001781/// \brief Retrieve the name of the original source file name
1782/// directly from the PCH file, without actually loading the PCH
1783/// file.
Daniel Dunbar93ebb1b2009-12-03 09:13:06 +00001784std::string PCHReader::getOriginalSourceFile(const std::string &PCHFileName,
1785 Diagnostic &Diags) {
Douglas Gregorb64c1932009-05-12 01:31:05 +00001786 // Open the PCH file.
1787 std::string ErrStr;
1788 llvm::OwningPtr<llvm::MemoryBuffer> Buffer;
1789 Buffer.reset(llvm::MemoryBuffer::getFile(PCHFileName.c_str(), &ErrStr));
1790 if (!Buffer) {
Daniel Dunbar93ebb1b2009-12-03 09:13:06 +00001791 Diags.Report(diag::err_fe_unable_to_read_pch_file) << ErrStr;
Douglas Gregorb64c1932009-05-12 01:31:05 +00001792 return std::string();
1793 }
1794
1795 // Initialize the stream
1796 llvm::BitstreamReader StreamFile;
1797 llvm::BitstreamCursor Stream;
Mike Stump1eb44332009-09-09 15:08:12 +00001798 StreamFile.init((const unsigned char *)Buffer->getBufferStart(),
Douglas Gregorb64c1932009-05-12 01:31:05 +00001799 (const unsigned char *)Buffer->getBufferEnd());
1800 Stream.init(StreamFile);
1801
1802 // Sniff for the signature.
1803 if (Stream.Read(8) != 'C' ||
1804 Stream.Read(8) != 'P' ||
1805 Stream.Read(8) != 'C' ||
1806 Stream.Read(8) != 'H') {
Daniel Dunbar93ebb1b2009-12-03 09:13:06 +00001807 Diags.Report(diag::err_fe_not_a_pch_file) << PCHFileName;
Douglas Gregorb64c1932009-05-12 01:31:05 +00001808 return std::string();
1809 }
1810
1811 RecordData Record;
1812 while (!Stream.AtEndOfStream()) {
1813 unsigned Code = Stream.ReadCode();
Mike Stump1eb44332009-09-09 15:08:12 +00001814
Douglas Gregorb64c1932009-05-12 01:31:05 +00001815 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
1816 unsigned BlockID = Stream.ReadSubBlockID();
Mike Stump1eb44332009-09-09 15:08:12 +00001817
Douglas Gregorb64c1932009-05-12 01:31:05 +00001818 // We only know the PCH subblock ID.
1819 switch (BlockID) {
1820 case pch::PCH_BLOCK_ID:
1821 if (Stream.EnterSubBlock(pch::PCH_BLOCK_ID)) {
Daniel Dunbar93ebb1b2009-12-03 09:13:06 +00001822 Diags.Report(diag::err_fe_pch_malformed_block) << PCHFileName;
Douglas Gregorb64c1932009-05-12 01:31:05 +00001823 return std::string();
1824 }
1825 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001826
Douglas Gregorb64c1932009-05-12 01:31:05 +00001827 default:
1828 if (Stream.SkipBlock()) {
Daniel Dunbar93ebb1b2009-12-03 09:13:06 +00001829 Diags.Report(diag::err_fe_pch_malformed_block) << PCHFileName;
Douglas Gregorb64c1932009-05-12 01:31:05 +00001830 return std::string();
1831 }
1832 break;
1833 }
1834 continue;
1835 }
1836
1837 if (Code == llvm::bitc::END_BLOCK) {
1838 if (Stream.ReadBlockEnd()) {
Daniel Dunbar93ebb1b2009-12-03 09:13:06 +00001839 Diags.Report(diag::err_fe_pch_error_at_end_block) << PCHFileName;
Douglas Gregorb64c1932009-05-12 01:31:05 +00001840 return std::string();
1841 }
1842 continue;
1843 }
1844
1845 if (Code == llvm::bitc::DEFINE_ABBREV) {
1846 Stream.ReadAbbrevRecord();
1847 continue;
1848 }
1849
1850 Record.clear();
1851 const char *BlobStart = 0;
1852 unsigned BlobLen = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001853 if (Stream.ReadRecord(Code, Record, &BlobStart, &BlobLen)
Douglas Gregorb64c1932009-05-12 01:31:05 +00001854 == pch::ORIGINAL_FILE_NAME)
1855 return std::string(BlobStart, BlobLen);
Mike Stump1eb44332009-09-09 15:08:12 +00001856 }
Douglas Gregorb64c1932009-05-12 01:31:05 +00001857
1858 return std::string();
1859}
1860
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001861/// \brief Parse the record that corresponds to a LangOptions data
1862/// structure.
1863///
1864/// This routine compares the language options used to generate the
1865/// PCH file against the language options set for the current
1866/// compilation. For each option, we classify differences between the
1867/// two compiler states as either "benign" or "important". Benign
1868/// differences don't matter, and we accept them without complaint
1869/// (and without modifying the language options). Differences between
1870/// the states for important options cause the PCH file to be
1871/// unusable, so we emit a warning and return true to indicate that
1872/// there was an error.
1873///
1874/// \returns true if the PCH file is unacceptable, false otherwise.
1875bool PCHReader::ParseLanguageOptions(
1876 const llvm::SmallVectorImpl<uint64_t> &Record) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001877 if (Listener) {
1878 LangOptions LangOpts;
Mike Stump1eb44332009-09-09 15:08:12 +00001879
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001880 #define PARSE_LANGOPT(Option) \
1881 LangOpts.Option = Record[Idx]; \
1882 ++Idx
Mike Stump1eb44332009-09-09 15:08:12 +00001883
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001884 unsigned Idx = 0;
1885 PARSE_LANGOPT(Trigraphs);
1886 PARSE_LANGOPT(BCPLComment);
1887 PARSE_LANGOPT(DollarIdents);
1888 PARSE_LANGOPT(AsmPreprocessor);
1889 PARSE_LANGOPT(GNUMode);
Chandler Carrutheb5d7b72010-04-17 20:17:31 +00001890 PARSE_LANGOPT(GNUKeywords);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001891 PARSE_LANGOPT(ImplicitInt);
1892 PARSE_LANGOPT(Digraphs);
1893 PARSE_LANGOPT(HexFloats);
1894 PARSE_LANGOPT(C99);
1895 PARSE_LANGOPT(Microsoft);
1896 PARSE_LANGOPT(CPlusPlus);
1897 PARSE_LANGOPT(CPlusPlus0x);
1898 PARSE_LANGOPT(CXXOperatorNames);
1899 PARSE_LANGOPT(ObjC1);
1900 PARSE_LANGOPT(ObjC2);
1901 PARSE_LANGOPT(ObjCNonFragileABI);
Fariborz Jahanian412e7982010-02-09 19:31:38 +00001902 PARSE_LANGOPT(ObjCNonFragileABI2);
Fariborz Jahanian4c9d8d02010-04-22 21:01:59 +00001903 PARSE_LANGOPT(NoConstantCFStrings);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001904 PARSE_LANGOPT(PascalStrings);
1905 PARSE_LANGOPT(WritableStrings);
1906 PARSE_LANGOPT(LaxVectorConversions);
Nate Begemanb9e7e632009-06-25 23:01:11 +00001907 PARSE_LANGOPT(AltiVec);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001908 PARSE_LANGOPT(Exceptions);
Daniel Dunbar73482882010-02-10 18:48:44 +00001909 PARSE_LANGOPT(SjLjExceptions);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001910 PARSE_LANGOPT(NeXTRuntime);
1911 PARSE_LANGOPT(Freestanding);
1912 PARSE_LANGOPT(NoBuiltin);
1913 PARSE_LANGOPT(ThreadsafeStatics);
Douglas Gregor972d9542009-09-03 14:36:33 +00001914 PARSE_LANGOPT(POSIXThreads);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001915 PARSE_LANGOPT(Blocks);
1916 PARSE_LANGOPT(EmitAllDecls);
1917 PARSE_LANGOPT(MathErrno);
1918 PARSE_LANGOPT(OverflowChecking);
1919 PARSE_LANGOPT(HeinousExtensions);
1920 PARSE_LANGOPT(Optimize);
1921 PARSE_LANGOPT(OptimizeSize);
1922 PARSE_LANGOPT(Static);
1923 PARSE_LANGOPT(PICLevel);
1924 PARSE_LANGOPT(GNUInline);
1925 PARSE_LANGOPT(NoInline);
1926 PARSE_LANGOPT(AccessControl);
1927 PARSE_LANGOPT(CharIsSigned);
John Thompsona6fda122009-11-05 20:14:16 +00001928 PARSE_LANGOPT(ShortWChar);
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001929 LangOpts.setGCMode((LangOptions::GCMode)Record[Idx]);
1930 ++Idx;
1931 LangOpts.setVisibilityMode((LangOptions::VisibilityMode)Record[Idx]);
1932 ++Idx;
Daniel Dunbarab8e2812009-09-21 04:16:19 +00001933 LangOpts.setStackProtectorMode((LangOptions::StackProtectorMode)
1934 Record[Idx]);
1935 ++Idx;
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001936 PARSE_LANGOPT(InstantiationDepth);
Nate Begemanb9e7e632009-06-25 23:01:11 +00001937 PARSE_LANGOPT(OpenCL);
Mike Stump9c276ae2009-12-12 01:27:46 +00001938 PARSE_LANGOPT(CatchUndefined);
1939 // FIXME: Missing ElideConstructors?!
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001940 #undef PARSE_LANGOPT
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001941
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00001942 return Listener->ReadLanguageOptions(LangOpts);
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001943 }
Douglas Gregor0a0428e2009-04-10 20:39:37 +00001944
1945 return false;
1946}
1947
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001948void PCHReader::ReadPreprocessedEntities() {
1949 ReadDefinedMacros();
1950}
1951
Douglas Gregor2cf26342009-04-09 22:27:44 +00001952/// \brief Read and return the type at the given offset.
1953///
1954/// This routine actually reads the record corresponding to the type
1955/// at the given offset in the bitstream. It is a helper routine for
1956/// GetType, which deals with reading type IDs.
1957QualType PCHReader::ReadTypeRecord(uint64_t Offset) {
Douglas Gregor0b748912009-04-14 21:18:50 +00001958 // Keep track of where we are in the stream, then jump back there
1959 // after reading this type.
Douglas Gregor61d60ee2009-10-17 00:13:19 +00001960 SavedStreamPosition SavedPosition(DeclsCursor);
Douglas Gregor0b748912009-04-14 21:18:50 +00001961
Douglas Gregord89275b2009-07-06 18:54:52 +00001962 // Note that we are loading a type record.
1963 LoadingTypeOrDecl Loading(*this);
Mike Stump1eb44332009-09-09 15:08:12 +00001964
Douglas Gregor61d60ee2009-10-17 00:13:19 +00001965 DeclsCursor.JumpToBit(Offset);
Douglas Gregor2cf26342009-04-09 22:27:44 +00001966 RecordData Record;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00001967 unsigned Code = DeclsCursor.ReadCode();
1968 switch ((pch::TypeCode)DeclsCursor.ReadRecord(Code, Record)) {
Douglas Gregor6d473962009-04-15 22:00:08 +00001969 case pch::TYPE_EXT_QUAL: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001970 if (Record.size() != 2) {
1971 Error("Incorrect encoding of extended qualifier type");
1972 return QualType();
1973 }
Douglas Gregor6d473962009-04-15 22:00:08 +00001974 QualType Base = GetType(Record[0]);
John McCall0953e762009-09-24 19:53:00 +00001975 Qualifiers Quals = Qualifiers::fromOpaqueValue(Record[1]);
1976 return Context->getQualifiedType(Base, Quals);
Douglas Gregor6d473962009-04-15 22:00:08 +00001977 }
Douglas Gregorb4e715b2009-04-13 20:46:52 +00001978
Douglas Gregor2cf26342009-04-09 22:27:44 +00001979 case pch::TYPE_COMPLEX: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001980 if (Record.size() != 1) {
1981 Error("Incorrect encoding of complex type");
1982 return QualType();
1983 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001984 QualType ElemType = GetType(Record[0]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00001985 return Context->getComplexType(ElemType);
Douglas Gregor2cf26342009-04-09 22:27:44 +00001986 }
1987
1988 case pch::TYPE_POINTER: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001989 if (Record.size() != 1) {
1990 Error("Incorrect encoding of pointer type");
1991 return QualType();
1992 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001993 QualType PointeeType = GetType(Record[0]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00001994 return Context->getPointerType(PointeeType);
Douglas Gregor2cf26342009-04-09 22:27:44 +00001995 }
1996
1997 case pch::TYPE_BLOCK_POINTER: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00001998 if (Record.size() != 1) {
1999 Error("Incorrect encoding of block pointer type");
2000 return QualType();
2001 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002002 QualType PointeeType = GetType(Record[0]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002003 return Context->getBlockPointerType(PointeeType);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002004 }
2005
2006 case pch::TYPE_LVALUE_REFERENCE: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002007 if (Record.size() != 1) {
2008 Error("Incorrect encoding of lvalue reference type");
2009 return QualType();
2010 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002011 QualType PointeeType = GetType(Record[0]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002012 return Context->getLValueReferenceType(PointeeType);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002013 }
2014
2015 case pch::TYPE_RVALUE_REFERENCE: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002016 if (Record.size() != 1) {
2017 Error("Incorrect encoding of rvalue reference type");
2018 return QualType();
2019 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002020 QualType PointeeType = GetType(Record[0]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002021 return Context->getRValueReferenceType(PointeeType);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002022 }
2023
2024 case pch::TYPE_MEMBER_POINTER: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002025 if (Record.size() != 1) {
2026 Error("Incorrect encoding of member pointer type");
2027 return QualType();
2028 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002029 QualType PointeeType = GetType(Record[0]);
2030 QualType ClassType = GetType(Record[1]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002031 return Context->getMemberPointerType(PointeeType, ClassType.getTypePtr());
Douglas Gregor2cf26342009-04-09 22:27:44 +00002032 }
2033
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002034 case pch::TYPE_CONSTANT_ARRAY: {
2035 QualType ElementType = GetType(Record[0]);
2036 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
2037 unsigned IndexTypeQuals = Record[2];
2038 unsigned Idx = 3;
2039 llvm::APInt Size = ReadAPInt(Record, Idx);
Douglas Gregor7e7eb3d2009-07-06 15:59:29 +00002040 return Context->getConstantArrayType(ElementType, Size,
2041 ASM, IndexTypeQuals);
2042 }
2043
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002044 case pch::TYPE_INCOMPLETE_ARRAY: {
2045 QualType ElementType = GetType(Record[0]);
2046 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
2047 unsigned IndexTypeQuals = Record[2];
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002048 return Context->getIncompleteArrayType(ElementType, ASM, IndexTypeQuals);
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002049 }
2050
2051 case pch::TYPE_VARIABLE_ARRAY: {
Douglas Gregor0b748912009-04-14 21:18:50 +00002052 QualType ElementType = GetType(Record[0]);
2053 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
2054 unsigned IndexTypeQuals = Record[2];
Douglas Gregor7e7eb3d2009-07-06 15:59:29 +00002055 SourceLocation LBLoc = SourceLocation::getFromRawEncoding(Record[3]);
2056 SourceLocation RBLoc = SourceLocation::getFromRawEncoding(Record[4]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002057 return Context->getVariableArrayType(ElementType, ReadTypeExpr(),
Douglas Gregor7e7eb3d2009-07-06 15:59:29 +00002058 ASM, IndexTypeQuals,
2059 SourceRange(LBLoc, RBLoc));
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002060 }
2061
2062 case pch::TYPE_VECTOR: {
John Thompson82287d12010-02-05 00:12:22 +00002063 if (Record.size() != 4) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002064 Error("incorrect encoding of vector type in PCH file");
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002065 return QualType();
2066 }
2067
2068 QualType ElementType = GetType(Record[0]);
2069 unsigned NumElements = Record[1];
John Thompson82287d12010-02-05 00:12:22 +00002070 bool AltiVec = Record[2];
2071 bool Pixel = Record[3];
2072 return Context->getVectorType(ElementType, NumElements, AltiVec, Pixel);
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002073 }
2074
2075 case pch::TYPE_EXT_VECTOR: {
John Thompson82287d12010-02-05 00:12:22 +00002076 if (Record.size() != 4) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002077 Error("incorrect encoding of extended vector type in PCH file");
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002078 return QualType();
2079 }
2080
2081 QualType ElementType = GetType(Record[0]);
2082 unsigned NumElements = Record[1];
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002083 return Context->getExtVectorType(ElementType, NumElements);
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002084 }
2085
2086 case pch::TYPE_FUNCTION_NO_PROTO: {
Rafael Espindola425ef722010-03-30 22:15:11 +00002087 if (Record.size() != 4) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002088 Error("incorrect encoding of no-proto function type");
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002089 return QualType();
2090 }
2091 QualType ResultType = GetType(Record[0]);
Rafael Espindola425ef722010-03-30 22:15:11 +00002092 FunctionType::ExtInfo Info(Record[1], Record[2], (CallingConv)Record[3]);
Rafael Espindola264ba482010-03-30 20:24:48 +00002093 return Context->getFunctionNoProtoType(ResultType, Info);
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002094 }
2095
2096 case pch::TYPE_FUNCTION_PROTO: {
2097 QualType ResultType = GetType(Record[0]);
Douglas Gregor91236662009-12-22 18:11:50 +00002098 bool NoReturn = Record[1];
Rafael Espindola425ef722010-03-30 22:15:11 +00002099 unsigned RegParm = Record[2];
2100 CallingConv CallConv = (CallingConv)Record[3];
2101 unsigned Idx = 4;
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002102 unsigned NumParams = Record[Idx++];
2103 llvm::SmallVector<QualType, 16> ParamTypes;
2104 for (unsigned I = 0; I != NumParams; ++I)
2105 ParamTypes.push_back(GetType(Record[Idx++]));
2106 bool isVariadic = Record[Idx++];
2107 unsigned Quals = Record[Idx++];
Sebastian Redl465226e2009-05-27 22:11:52 +00002108 bool hasExceptionSpec = Record[Idx++];
2109 bool hasAnyExceptionSpec = Record[Idx++];
2110 unsigned NumExceptions = Record[Idx++];
2111 llvm::SmallVector<QualType, 2> Exceptions;
2112 for (unsigned I = 0; I != NumExceptions; ++I)
2113 Exceptions.push_back(GetType(Record[Idx++]));
Jay Foadbeaaccd2009-05-21 09:52:38 +00002114 return Context->getFunctionType(ResultType, ParamTypes.data(), NumParams,
Sebastian Redl465226e2009-05-27 22:11:52 +00002115 isVariadic, Quals, hasExceptionSpec,
2116 hasAnyExceptionSpec, NumExceptions,
Rafael Espindola264ba482010-03-30 20:24:48 +00002117 Exceptions.data(),
Rafael Espindola425ef722010-03-30 22:15:11 +00002118 FunctionType::ExtInfo(NoReturn, RegParm,
2119 CallConv));
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002120 }
2121
John McCalled976492009-12-04 22:46:56 +00002122 case pch::TYPE_UNRESOLVED_USING:
2123 return Context->getTypeDeclType(
2124 cast<UnresolvedUsingTypenameDecl>(GetDecl(Record[0])));
2125
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002126 case pch::TYPE_TYPEDEF:
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002127 if (Record.size() != 1) {
2128 Error("incorrect encoding of typedef type");
2129 return QualType();
2130 }
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002131 return Context->getTypeDeclType(cast<TypedefDecl>(GetDecl(Record[0])));
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002132
2133 case pch::TYPE_TYPEOF_EXPR:
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002134 return Context->getTypeOfExprType(ReadTypeExpr());
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002135
2136 case pch::TYPE_TYPEOF: {
2137 if (Record.size() != 1) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002138 Error("incorrect encoding of typeof(type) in PCH file");
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002139 return QualType();
2140 }
2141 QualType UnderlyingType = GetType(Record[0]);
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002142 return Context->getTypeOfType(UnderlyingType);
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002143 }
Mike Stump1eb44332009-09-09 15:08:12 +00002144
Anders Carlsson395b4752009-06-24 19:06:50 +00002145 case pch::TYPE_DECLTYPE:
2146 return Context->getDecltypeType(ReadTypeExpr());
2147
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002148 case pch::TYPE_RECORD:
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002149 if (Record.size() != 1) {
2150 Error("incorrect encoding of record type");
2151 return QualType();
2152 }
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002153 return Context->getTypeDeclType(cast<RecordDecl>(GetDecl(Record[0])));
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002154
Douglas Gregor0a2b45e2009-04-13 18:14:40 +00002155 case pch::TYPE_ENUM:
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002156 if (Record.size() != 1) {
2157 Error("incorrect encoding of enum type");
2158 return QualType();
2159 }
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002160 return Context->getTypeDeclType(cast<EnumDecl>(GetDecl(Record[0])));
Douglas Gregor0a2b45e2009-04-13 18:14:40 +00002161
John McCall7da24312009-09-05 00:15:47 +00002162 case pch::TYPE_ELABORATED: {
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002163 if (Record.size() != 2) {
2164 Error("incorrect encoding of elaborated type");
2165 return QualType();
2166 }
John McCall7da24312009-09-05 00:15:47 +00002167 unsigned Tag = Record[1];
Abramo Bagnara465d41b2010-05-11 21:36:43 +00002168 // FIXME: Deserialize the qualifier (C++ only)
2169 return Context->getElaboratedType((ElaboratedTypeKeyword) Tag,
2170 /* NNS */ 0,
2171 GetType(Record[0]));
John McCall7da24312009-09-05 00:15:47 +00002172 }
2173
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002174 case pch::TYPE_OBJC_INTERFACE: {
Chris Lattnerc6fa4452009-04-22 06:45:28 +00002175 unsigned Idx = 0;
2176 ObjCInterfaceDecl *ItfD = cast<ObjCInterfaceDecl>(GetDecl(Record[Idx++]));
John McCallc12c5bb2010-05-15 11:32:37 +00002177 return Context->getObjCInterfaceType(ItfD);
2178 }
2179
2180 case pch::TYPE_OBJC_OBJECT: {
2181 unsigned Idx = 0;
2182 QualType Base = GetType(Record[Idx++]);
Chris Lattnerc6fa4452009-04-22 06:45:28 +00002183 unsigned NumProtos = Record[Idx++];
2184 llvm::SmallVector<ObjCProtocolDecl*, 4> Protos;
2185 for (unsigned I = 0; I != NumProtos; ++I)
2186 Protos.push_back(cast<ObjCProtocolDecl>(GetDecl(Record[Idx++])));
John McCallc12c5bb2010-05-15 11:32:37 +00002187 return Context->getObjCObjectType(Base, Protos.data(), NumProtos);
Chris Lattnerc6fa4452009-04-22 06:45:28 +00002188 }
Douglas Gregorb4e715b2009-04-13 20:46:52 +00002189
Steve Naroffd1b3c2d2009-06-17 22:40:22 +00002190 case pch::TYPE_OBJC_OBJECT_POINTER: {
Chris Lattnerd7a3fcd2009-04-22 06:40:03 +00002191 unsigned Idx = 0;
John McCallc12c5bb2010-05-15 11:32:37 +00002192 QualType Pointee = GetType(Record[Idx++]);
2193 return Context->getObjCObjectPointerType(Pointee);
Chris Lattnerd7a3fcd2009-04-22 06:40:03 +00002194 }
Argyrios Kyrtzidis24fab412009-09-29 19:42:55 +00002195
John McCall49a832b2009-10-18 09:09:24 +00002196 case pch::TYPE_SUBST_TEMPLATE_TYPE_PARM: {
2197 unsigned Idx = 0;
2198 QualType Parm = GetType(Record[Idx++]);
2199 QualType Replacement = GetType(Record[Idx++]);
2200 return
2201 Context->getSubstTemplateTypeParmType(cast<TemplateTypeParmType>(Parm),
2202 Replacement);
2203 }
John McCall3cb0ebd2010-03-10 03:28:59 +00002204
2205 case pch::TYPE_INJECTED_CLASS_NAME: {
2206 CXXRecordDecl *D = cast<CXXRecordDecl>(GetDecl(Record[0]));
2207 QualType TST = GetType(Record[1]); // probably derivable
2208 return Context->getInjectedClassNameType(D, TST);
2209 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002210 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002211 // Suppress a GCC warning
2212 return QualType();
2213}
2214
John McCalla1ee0c52009-10-16 21:56:05 +00002215namespace {
2216
2217class TypeLocReader : public TypeLocVisitor<TypeLocReader> {
2218 PCHReader &Reader;
2219 const PCHReader::RecordData &Record;
2220 unsigned &Idx;
2221
2222public:
2223 TypeLocReader(PCHReader &Reader, const PCHReader::RecordData &Record,
2224 unsigned &Idx)
2225 : Reader(Reader), Record(Record), Idx(Idx) { }
2226
John McCall51bd8032009-10-18 01:05:36 +00002227 // We want compile-time assurance that we've enumerated all of
2228 // these, so unfortunately we have to declare them first, then
2229 // define them out-of-line.
2230#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCalla1ee0c52009-10-16 21:56:05 +00002231#define TYPELOC(CLASS, PARENT) \
John McCall51bd8032009-10-18 01:05:36 +00002232 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCalla1ee0c52009-10-16 21:56:05 +00002233#include "clang/AST/TypeLocNodes.def"
2234
John McCall51bd8032009-10-18 01:05:36 +00002235 void VisitFunctionTypeLoc(FunctionTypeLoc);
2236 void VisitArrayTypeLoc(ArrayTypeLoc);
John McCalla1ee0c52009-10-16 21:56:05 +00002237};
2238
2239}
2240
John McCall51bd8032009-10-18 01:05:36 +00002241void TypeLocReader::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
John McCalla1ee0c52009-10-16 21:56:05 +00002242 // nothing to do
2243}
John McCall51bd8032009-10-18 01:05:36 +00002244void TypeLocReader::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Douglas Gregorddf889a2010-01-18 18:04:31 +00002245 TL.setBuiltinLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2246 if (TL.needsExtraLocalData()) {
2247 TL.setWrittenTypeSpec(static_cast<DeclSpec::TST>(Record[Idx++]));
2248 TL.setWrittenSignSpec(static_cast<DeclSpec::TSS>(Record[Idx++]));
2249 TL.setWrittenWidthSpec(static_cast<DeclSpec::TSW>(Record[Idx++]));
2250 TL.setModeAttr(Record[Idx++]);
2251 }
John McCalla1ee0c52009-10-16 21:56:05 +00002252}
John McCall51bd8032009-10-18 01:05:36 +00002253void TypeLocReader::VisitComplexTypeLoc(ComplexTypeLoc TL) {
2254 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002255}
John McCall51bd8032009-10-18 01:05:36 +00002256void TypeLocReader::VisitPointerTypeLoc(PointerTypeLoc TL) {
2257 TL.setStarLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002258}
John McCall51bd8032009-10-18 01:05:36 +00002259void TypeLocReader::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
2260 TL.setCaretLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002261}
John McCall51bd8032009-10-18 01:05:36 +00002262void TypeLocReader::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
2263 TL.setAmpLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002264}
John McCall51bd8032009-10-18 01:05:36 +00002265void TypeLocReader::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
2266 TL.setAmpAmpLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002267}
John McCall51bd8032009-10-18 01:05:36 +00002268void TypeLocReader::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
2269 TL.setStarLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002270}
John McCall51bd8032009-10-18 01:05:36 +00002271void TypeLocReader::VisitArrayTypeLoc(ArrayTypeLoc TL) {
2272 TL.setLBracketLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2273 TL.setRBracketLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002274 if (Record[Idx++])
John McCall51bd8032009-10-18 01:05:36 +00002275 TL.setSizeExpr(Reader.ReadDeclExpr());
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002276 else
John McCall51bd8032009-10-18 01:05:36 +00002277 TL.setSizeExpr(0);
2278}
2279void TypeLocReader::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
2280 VisitArrayTypeLoc(TL);
2281}
2282void TypeLocReader::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
2283 VisitArrayTypeLoc(TL);
2284}
2285void TypeLocReader::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
2286 VisitArrayTypeLoc(TL);
2287}
2288void TypeLocReader::VisitDependentSizedArrayTypeLoc(
2289 DependentSizedArrayTypeLoc TL) {
2290 VisitArrayTypeLoc(TL);
2291}
2292void TypeLocReader::VisitDependentSizedExtVectorTypeLoc(
2293 DependentSizedExtVectorTypeLoc TL) {
2294 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2295}
2296void TypeLocReader::VisitVectorTypeLoc(VectorTypeLoc TL) {
2297 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2298}
2299void TypeLocReader::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
2300 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2301}
2302void TypeLocReader::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
2303 TL.setLParenLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2304 TL.setRParenLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2305 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i) {
John McCall86acc2a2009-10-23 01:28:53 +00002306 TL.setArg(i, cast_or_null<ParmVarDecl>(Reader.GetDecl(Record[Idx++])));
John McCall51bd8032009-10-18 01:05:36 +00002307 }
2308}
2309void TypeLocReader::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
2310 VisitFunctionTypeLoc(TL);
2311}
2312void TypeLocReader::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
2313 VisitFunctionTypeLoc(TL);
2314}
John McCalled976492009-12-04 22:46:56 +00002315void TypeLocReader::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
2316 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2317}
John McCall51bd8032009-10-18 01:05:36 +00002318void TypeLocReader::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
2319 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2320}
2321void TypeLocReader::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
John McCallcfb708c2010-01-13 20:03:27 +00002322 TL.setTypeofLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2323 TL.setLParenLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2324 TL.setRParenLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCall51bd8032009-10-18 01:05:36 +00002325}
2326void TypeLocReader::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
John McCallcfb708c2010-01-13 20:03:27 +00002327 TL.setTypeofLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2328 TL.setLParenLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2329 TL.setRParenLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2330 TL.setUnderlyingTInfo(Reader.GetTypeSourceInfo(Record, Idx));
John McCall51bd8032009-10-18 01:05:36 +00002331}
2332void TypeLocReader::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
2333 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2334}
2335void TypeLocReader::VisitRecordTypeLoc(RecordTypeLoc TL) {
2336 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2337}
2338void TypeLocReader::VisitEnumTypeLoc(EnumTypeLoc TL) {
2339 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2340}
John McCall51bd8032009-10-18 01:05:36 +00002341void TypeLocReader::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
2342 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2343}
John McCall49a832b2009-10-18 09:09:24 +00002344void TypeLocReader::VisitSubstTemplateTypeParmTypeLoc(
2345 SubstTemplateTypeParmTypeLoc TL) {
2346 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2347}
John McCall51bd8032009-10-18 01:05:36 +00002348void TypeLocReader::VisitTemplateSpecializationTypeLoc(
2349 TemplateSpecializationTypeLoc TL) {
John McCall833ca992009-10-29 08:12:44 +00002350 TL.setTemplateNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2351 TL.setLAngleLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2352 TL.setRAngleLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2353 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
2354 TL.setArgLocInfo(i,
2355 Reader.GetTemplateArgumentLocInfo(TL.getTypePtr()->getArg(i).getKind(),
2356 Record, Idx));
John McCall51bd8032009-10-18 01:05:36 +00002357}
Abramo Bagnara465d41b2010-05-11 21:36:43 +00002358void TypeLocReader::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Abramo Bagnarae4da7a02010-05-19 21:37:53 +00002359 TL.setKeywordLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2360 TL.setQualifierRange(Reader.ReadSourceRange(Record, Idx));
John McCall51bd8032009-10-18 01:05:36 +00002361}
John McCall3cb0ebd2010-03-10 03:28:59 +00002362void TypeLocReader::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
2363 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2364}
Douglas Gregor4714c122010-03-31 17:34:00 +00002365void TypeLocReader::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Abramo Bagnarae4da7a02010-05-19 21:37:53 +00002366 TL.setKeywordLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2367 TL.setQualifierRange(Reader.ReadSourceRange(Record, Idx));
John McCall51bd8032009-10-18 01:05:36 +00002368 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2369}
John McCall33500952010-06-11 00:33:02 +00002370void TypeLocReader::VisitDependentTemplateSpecializationTypeLoc(
2371 DependentTemplateSpecializationTypeLoc TL) {
2372 TL.setKeywordLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2373 TL.setQualifierRange(Reader.ReadSourceRange(Record, Idx));
2374 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2375 TL.setLAngleLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2376 TL.setRAngleLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2377 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
2378 TL.setArgLocInfo(I,
2379 Reader.GetTemplateArgumentLocInfo(TL.getTypePtr()->getArg(I).getKind(),
2380 Record, Idx));
2381}
John McCall51bd8032009-10-18 01:05:36 +00002382void TypeLocReader::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
2383 TL.setNameLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCallc12c5bb2010-05-15 11:32:37 +00002384}
2385void TypeLocReader::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
2386 TL.setHasBaseTypeAsWritten(Record[Idx++]);
John McCall51bd8032009-10-18 01:05:36 +00002387 TL.setLAngleLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2388 TL.setRAngleLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
2389 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
2390 TL.setProtocolLoc(i, SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCalla1ee0c52009-10-16 21:56:05 +00002391}
John McCall54e14c42009-10-22 22:37:11 +00002392void TypeLocReader::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
2393 TL.setStarLoc(SourceLocation::getFromRawEncoding(Record[Idx++]));
John McCall54e14c42009-10-22 22:37:11 +00002394}
John McCalla1ee0c52009-10-16 21:56:05 +00002395
John McCalla93c9342009-12-07 02:54:59 +00002396TypeSourceInfo *PCHReader::GetTypeSourceInfo(const RecordData &Record,
John McCalla1ee0c52009-10-16 21:56:05 +00002397 unsigned &Idx) {
2398 QualType InfoTy = GetType(Record[Idx++]);
2399 if (InfoTy.isNull())
2400 return 0;
2401
John McCalla93c9342009-12-07 02:54:59 +00002402 TypeSourceInfo *TInfo = getContext()->CreateTypeSourceInfo(InfoTy);
John McCalla1ee0c52009-10-16 21:56:05 +00002403 TypeLocReader TLR(*this, Record, Idx);
John McCalla93c9342009-12-07 02:54:59 +00002404 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
John McCalla1ee0c52009-10-16 21:56:05 +00002405 TLR.Visit(TL);
John McCalla93c9342009-12-07 02:54:59 +00002406 return TInfo;
John McCalla1ee0c52009-10-16 21:56:05 +00002407}
Douglas Gregor2cf26342009-04-09 22:27:44 +00002408
Douglas Gregor8038d512009-04-10 17:25:41 +00002409QualType PCHReader::GetType(pch::TypeID ID) {
John McCall0953e762009-09-24 19:53:00 +00002410 unsigned FastQuals = ID & Qualifiers::FastMask;
2411 unsigned Index = ID >> Qualifiers::FastWidth;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002412
2413 if (Index < pch::NUM_PREDEF_TYPE_IDS) {
2414 QualType T;
2415 switch ((pch::PredefinedTypeIDs)Index) {
2416 case pch::PREDEF_TYPE_NULL_ID: return QualType();
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002417 case pch::PREDEF_TYPE_VOID_ID: T = Context->VoidTy; break;
2418 case pch::PREDEF_TYPE_BOOL_ID: T = Context->BoolTy; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002419
2420 case pch::PREDEF_TYPE_CHAR_U_ID:
2421 case pch::PREDEF_TYPE_CHAR_S_ID:
2422 // FIXME: Check that the signedness of CharTy is correct!
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002423 T = Context->CharTy;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002424 break;
2425
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002426 case pch::PREDEF_TYPE_UCHAR_ID: T = Context->UnsignedCharTy; break;
2427 case pch::PREDEF_TYPE_USHORT_ID: T = Context->UnsignedShortTy; break;
2428 case pch::PREDEF_TYPE_UINT_ID: T = Context->UnsignedIntTy; break;
2429 case pch::PREDEF_TYPE_ULONG_ID: T = Context->UnsignedLongTy; break;
2430 case pch::PREDEF_TYPE_ULONGLONG_ID: T = Context->UnsignedLongLongTy; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +00002431 case pch::PREDEF_TYPE_UINT128_ID: T = Context->UnsignedInt128Ty; break;
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002432 case pch::PREDEF_TYPE_SCHAR_ID: T = Context->SignedCharTy; break;
2433 case pch::PREDEF_TYPE_WCHAR_ID: T = Context->WCharTy; break;
2434 case pch::PREDEF_TYPE_SHORT_ID: T = Context->ShortTy; break;
2435 case pch::PREDEF_TYPE_INT_ID: T = Context->IntTy; break;
2436 case pch::PREDEF_TYPE_LONG_ID: T = Context->LongTy; break;
2437 case pch::PREDEF_TYPE_LONGLONG_ID: T = Context->LongLongTy; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +00002438 case pch::PREDEF_TYPE_INT128_ID: T = Context->Int128Ty; break;
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002439 case pch::PREDEF_TYPE_FLOAT_ID: T = Context->FloatTy; break;
2440 case pch::PREDEF_TYPE_DOUBLE_ID: T = Context->DoubleTy; break;
2441 case pch::PREDEF_TYPE_LONGDOUBLE_ID: T = Context->LongDoubleTy; break;
2442 case pch::PREDEF_TYPE_OVERLOAD_ID: T = Context->OverloadTy; break;
2443 case pch::PREDEF_TYPE_DEPENDENT_ID: T = Context->DependentTy; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +00002444 case pch::PREDEF_TYPE_NULLPTR_ID: T = Context->NullPtrTy; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +00002445 case pch::PREDEF_TYPE_CHAR16_ID: T = Context->Char16Ty; break;
2446 case pch::PREDEF_TYPE_CHAR32_ID: T = Context->Char32Ty; break;
Steve Naroffde2e22d2009-07-15 18:40:39 +00002447 case pch::PREDEF_TYPE_OBJC_ID: T = Context->ObjCBuiltinIdTy; break;
2448 case pch::PREDEF_TYPE_OBJC_CLASS: T = Context->ObjCBuiltinClassTy; break;
Fariborz Jahanian13dcd002009-11-21 19:53:08 +00002449 case pch::PREDEF_TYPE_OBJC_SEL: T = Context->ObjCBuiltinSelTy; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002450 }
2451
2452 assert(!T.isNull() && "Unknown predefined type");
John McCall0953e762009-09-24 19:53:00 +00002453 return T.withFastQualifiers(FastQuals);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002454 }
2455
2456 Index -= pch::NUM_PREDEF_TYPE_IDS;
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002457 //assert(Index < TypesLoaded.size() && "Type index out-of-range");
John McCall0953e762009-09-24 19:53:00 +00002458 if (TypesLoaded[Index].isNull())
2459 TypesLoaded[Index] = ReadTypeRecord(TypeOffsets[Index]);
Mike Stump1eb44332009-09-09 15:08:12 +00002460
John McCall0953e762009-09-24 19:53:00 +00002461 return TypesLoaded[Index].withFastQualifiers(FastQuals);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002462}
2463
John McCall833ca992009-10-29 08:12:44 +00002464TemplateArgumentLocInfo
2465PCHReader::GetTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
2466 const RecordData &Record,
2467 unsigned &Index) {
2468 switch (Kind) {
2469 case TemplateArgument::Expression:
2470 return ReadDeclExpr();
2471 case TemplateArgument::Type:
John McCalla93c9342009-12-07 02:54:59 +00002472 return GetTypeSourceInfo(Record, Index);
Douglas Gregor788cd062009-11-11 01:00:40 +00002473 case TemplateArgument::Template: {
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00002474 SourceLocation
Douglas Gregor788cd062009-11-11 01:00:40 +00002475 QualStart = SourceLocation::getFromRawEncoding(Record[Index++]),
2476 QualEnd = SourceLocation::getFromRawEncoding(Record[Index++]),
2477 TemplateNameLoc = SourceLocation::getFromRawEncoding(Record[Index++]);
2478 return TemplateArgumentLocInfo(SourceRange(QualStart, QualEnd),
2479 TemplateNameLoc);
2480 }
John McCall833ca992009-10-29 08:12:44 +00002481 case TemplateArgument::Null:
2482 case TemplateArgument::Integral:
2483 case TemplateArgument::Declaration:
2484 case TemplateArgument::Pack:
2485 return TemplateArgumentLocInfo();
2486 }
Jeffrey Yasskin9f61aa92009-12-12 05:05:38 +00002487 llvm_unreachable("unexpected template argument loc");
John McCall833ca992009-10-29 08:12:44 +00002488 return TemplateArgumentLocInfo();
2489}
2490
John McCall76bd1f32010-06-01 09:23:16 +00002491Decl *PCHReader::GetExternalDecl(uint32_t ID) {
2492 return GetDecl(ID);
2493}
2494
Douglas Gregor8038d512009-04-10 17:25:41 +00002495Decl *PCHReader::GetDecl(pch::DeclID ID) {
Douglas Gregor2cf26342009-04-09 22:27:44 +00002496 if (ID == 0)
2497 return 0;
2498
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002499 if (ID > DeclsLoaded.size()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002500 Error("declaration ID out-of-range for PCH file");
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002501 return 0;
2502 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002503
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002504 unsigned Index = ID - 1;
2505 if (!DeclsLoaded[Index])
2506 ReadDeclRecord(DeclOffsets[Index], Index);
2507
2508 return DeclsLoaded[Index];
Douglas Gregor2cf26342009-04-09 22:27:44 +00002509}
2510
Chris Lattner887e2b32009-04-27 05:46:25 +00002511/// \brief Resolve the offset of a statement into a statement.
2512///
2513/// This operation will read a new statement from the external
2514/// source each time it is called, and is meant to be used via a
2515/// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
John McCall76bd1f32010-06-01 09:23:16 +00002516Stmt *PCHReader::GetExternalDeclStmt(uint64_t Offset) {
Chris Lattnerda930612009-04-27 05:58:23 +00002517 // Since we know tha this statement is part of a decl, make sure to use the
2518 // decl cursor to read it.
2519 DeclsCursor.JumpToBit(Offset);
2520 return ReadStmt(DeclsCursor);
Douglas Gregor250fc9c2009-04-18 00:07:54 +00002521}
2522
John McCall76bd1f32010-06-01 09:23:16 +00002523bool PCHReader::FindExternalLexicalDecls(const DeclContext *DC,
2524 llvm::SmallVectorImpl<Decl*> &Decls) {
Mike Stump1eb44332009-09-09 15:08:12 +00002525 assert(DC->hasExternalLexicalStorage() &&
Douglas Gregor2cf26342009-04-09 22:27:44 +00002526 "DeclContext has no lexical decls in storage");
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002527
Douglas Gregor2cf26342009-04-09 22:27:44 +00002528 uint64_t Offset = DeclContextOffsets[DC].first;
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002529 if (Offset == 0) {
2530 Error("DeclContext has no lexical decls in storage");
2531 return true;
2532 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002533
Douglas Gregor0b748912009-04-14 21:18:50 +00002534 // Keep track of where we are in the stream, then jump back there
2535 // after reading this context.
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002536 SavedStreamPosition SavedPosition(DeclsCursor);
Douglas Gregor0b748912009-04-14 21:18:50 +00002537
Douglas Gregor2cf26342009-04-09 22:27:44 +00002538 // Load the record containing all of the declarations lexically in
2539 // this context.
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002540 DeclsCursor.JumpToBit(Offset);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002541 RecordData Record;
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002542 unsigned Code = DeclsCursor.ReadCode();
2543 unsigned RecCode = DeclsCursor.ReadRecord(Code, Record);
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002544 if (RecCode != pch::DECL_CONTEXT_LEXICAL) {
2545 Error("Expected lexical block");
2546 return true;
2547 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002548
2549 // Load all of the declaration IDs
John McCall76bd1f32010-06-01 09:23:16 +00002550 for (RecordData::iterator I = Record.begin(), E = Record.end(); I != E; ++I)
2551 Decls.push_back(GetDecl(*I));
Douglas Gregor25123082009-04-22 22:34:57 +00002552 ++NumLexicalDeclContextsRead;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002553 return false;
2554}
2555
John McCall76bd1f32010-06-01 09:23:16 +00002556DeclContext::lookup_result
2557PCHReader::FindExternalVisibleDeclsByName(const DeclContext *DC,
2558 DeclarationName Name) {
Mike Stump1eb44332009-09-09 15:08:12 +00002559 assert(DC->hasExternalVisibleStorage() &&
Douglas Gregor2cf26342009-04-09 22:27:44 +00002560 "DeclContext has no visible decls in storage");
2561 uint64_t Offset = DeclContextOffsets[DC].second;
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002562 if (Offset == 0) {
2563 Error("DeclContext has no visible decls in storage");
John McCall76bd1f32010-06-01 09:23:16 +00002564 return DeclContext::lookup_result(DeclContext::lookup_iterator(),
2565 DeclContext::lookup_iterator());
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002566 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002567
Douglas Gregor0b748912009-04-14 21:18:50 +00002568 // Keep track of where we are in the stream, then jump back there
2569 // after reading this context.
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002570 SavedStreamPosition SavedPosition(DeclsCursor);
Douglas Gregor0b748912009-04-14 21:18:50 +00002571
Douglas Gregor2cf26342009-04-09 22:27:44 +00002572 // Load the record containing all of the declarations visible in
2573 // this context.
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002574 DeclsCursor.JumpToBit(Offset);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002575 RecordData Record;
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002576 unsigned Code = DeclsCursor.ReadCode();
2577 unsigned RecCode = DeclsCursor.ReadRecord(Code, Record);
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002578 if (RecCode != pch::DECL_CONTEXT_VISIBLE) {
2579 Error("Expected visible block");
John McCall76bd1f32010-06-01 09:23:16 +00002580 return DeclContext::lookup_result(DeclContext::lookup_iterator(),
2581 DeclContext::lookup_iterator());
Ted Kremenekd5d7b3f2010-03-18 00:56:54 +00002582 }
2583
John McCall76bd1f32010-06-01 09:23:16 +00002584 llvm::SmallVector<VisibleDeclaration, 64> Decls;
2585 if (Record.empty()) {
2586 SetExternalVisibleDecls(DC, Decls);
2587 return DeclContext::lookup_result(DeclContext::lookup_iterator(),
2588 DeclContext::lookup_iterator());
2589 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002590
2591 unsigned Idx = 0;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002592 while (Idx < Record.size()) {
2593 Decls.push_back(VisibleDeclaration());
2594 Decls.back().Name = ReadDeclarationName(Record, Idx);
2595
Douglas Gregor2cf26342009-04-09 22:27:44 +00002596 unsigned Size = Record[Idx++];
Chris Lattnerc47be9e2009-04-27 07:35:40 +00002597 llvm::SmallVector<unsigned, 4> &LoadedDecls = Decls.back().Declarations;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002598 LoadedDecls.reserve(Size);
2599 for (unsigned I = 0; I < Size; ++I)
2600 LoadedDecls.push_back(Record[Idx++]);
2601 }
2602
Douglas Gregor25123082009-04-22 22:34:57 +00002603 ++NumVisibleDeclContextsRead;
John McCall76bd1f32010-06-01 09:23:16 +00002604
2605 SetExternalVisibleDecls(DC, Decls);
2606 return const_cast<DeclContext*>(DC)->lookup(Name);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002607}
2608
Douglas Gregorfdd01722009-04-14 00:24:19 +00002609void PCHReader::StartTranslationUnit(ASTConsumer *Consumer) {
Douglas Gregor0af2ca42009-04-22 19:09:20 +00002610 this->Consumer = Consumer;
2611
Douglas Gregorfdd01722009-04-14 00:24:19 +00002612 if (!Consumer)
2613 return;
2614
2615 for (unsigned I = 0, N = ExternalDefinitions.size(); I != N; ++I) {
Daniel Dunbar04a0b502009-09-17 03:06:44 +00002616 // Force deserialization of this decl, which will cause it to be passed to
2617 // the consumer (or queued).
2618 GetDecl(ExternalDefinitions[I]);
Douglas Gregorfdd01722009-04-14 00:24:19 +00002619 }
Douglas Gregorc62a2fe2009-04-25 00:41:30 +00002620
2621 for (unsigned I = 0, N = InterestingDecls.size(); I != N; ++I) {
2622 DeclGroupRef DG(InterestingDecls[I]);
2623 Consumer->HandleTopLevelDecl(DG);
2624 }
Douglas Gregorfdd01722009-04-14 00:24:19 +00002625}
2626
Douglas Gregor2cf26342009-04-09 22:27:44 +00002627void PCHReader::PrintStats() {
2628 std::fprintf(stderr, "*** PCH Statistics:\n");
2629
Mike Stump1eb44332009-09-09 15:08:12 +00002630 unsigned NumTypesLoaded
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002631 = TypesLoaded.size() - std::count(TypesLoaded.begin(), TypesLoaded.end(),
John McCall0953e762009-09-24 19:53:00 +00002632 QualType());
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002633 unsigned NumDeclsLoaded
2634 = DeclsLoaded.size() - std::count(DeclsLoaded.begin(), DeclsLoaded.end(),
2635 (Decl *)0);
2636 unsigned NumIdentifiersLoaded
2637 = IdentifiersLoaded.size() - std::count(IdentifiersLoaded.begin(),
2638 IdentifiersLoaded.end(),
2639 (IdentifierInfo *)0);
Mike Stump1eb44332009-09-09 15:08:12 +00002640 unsigned NumSelectorsLoaded
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002641 = SelectorsLoaded.size() - std::count(SelectorsLoaded.begin(),
2642 SelectorsLoaded.end(),
2643 Selector());
Douglas Gregor2d41cc12009-04-13 20:50:16 +00002644
Douglas Gregor4fed3f42009-04-27 18:38:38 +00002645 std::fprintf(stderr, " %u stat cache hits\n", NumStatHits);
2646 std::fprintf(stderr, " %u stat cache misses\n", NumStatMisses);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00002647 if (TotalNumSLocEntries)
2648 std::fprintf(stderr, " %u/%u source location entries read (%f%%)\n",
2649 NumSLocEntriesRead, TotalNumSLocEntries,
2650 ((float)NumSLocEntriesRead/TotalNumSLocEntries * 100));
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002651 if (!TypesLoaded.empty())
Douglas Gregor83941df2009-04-25 17:48:32 +00002652 std::fprintf(stderr, " %u/%u types read (%f%%)\n",
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002653 NumTypesLoaded, (unsigned)TypesLoaded.size(),
2654 ((float)NumTypesLoaded/TypesLoaded.size() * 100));
2655 if (!DeclsLoaded.empty())
Douglas Gregor83941df2009-04-25 17:48:32 +00002656 std::fprintf(stderr, " %u/%u declarations read (%f%%)\n",
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002657 NumDeclsLoaded, (unsigned)DeclsLoaded.size(),
2658 ((float)NumDeclsLoaded/DeclsLoaded.size() * 100));
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002659 if (!IdentifiersLoaded.empty())
Douglas Gregor83941df2009-04-25 17:48:32 +00002660 std::fprintf(stderr, " %u/%u identifiers read (%f%%)\n",
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002661 NumIdentifiersLoaded, (unsigned)IdentifiersLoaded.size(),
2662 ((float)NumIdentifiersLoaded/IdentifiersLoaded.size() * 100));
Douglas Gregor83941df2009-04-25 17:48:32 +00002663 if (TotalNumSelectors)
2664 std::fprintf(stderr, " %u/%u selectors read (%f%%)\n",
2665 NumSelectorsLoaded, TotalNumSelectors,
2666 ((float)NumSelectorsLoaded/TotalNumSelectors * 100));
2667 if (TotalNumStatements)
2668 std::fprintf(stderr, " %u/%u statements read (%f%%)\n",
2669 NumStatementsRead, TotalNumStatements,
2670 ((float)NumStatementsRead/TotalNumStatements * 100));
2671 if (TotalNumMacros)
2672 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
2673 NumMacrosRead, TotalNumMacros,
2674 ((float)NumMacrosRead/TotalNumMacros * 100));
2675 if (TotalLexicalDeclContexts)
2676 std::fprintf(stderr, " %u/%u lexical declcontexts read (%f%%)\n",
2677 NumLexicalDeclContextsRead, TotalLexicalDeclContexts,
2678 ((float)NumLexicalDeclContextsRead/TotalLexicalDeclContexts
2679 * 100));
2680 if (TotalVisibleDeclContexts)
2681 std::fprintf(stderr, " %u/%u visible declcontexts read (%f%%)\n",
2682 NumVisibleDeclContextsRead, TotalVisibleDeclContexts,
2683 ((float)NumVisibleDeclContextsRead/TotalVisibleDeclContexts
2684 * 100));
2685 if (TotalSelectorsInMethodPool) {
2686 std::fprintf(stderr, " %u/%u method pool entries read (%f%%)\n",
2687 NumMethodPoolSelectorsRead, TotalSelectorsInMethodPool,
2688 ((float)NumMethodPoolSelectorsRead/TotalSelectorsInMethodPool
2689 * 100));
2690 std::fprintf(stderr, " %u method pool misses\n", NumMethodPoolMisses);
2691 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002692 std::fprintf(stderr, "\n");
2693}
2694
Douglas Gregor668c1a42009-04-21 22:25:48 +00002695void PCHReader::InitializeSema(Sema &S) {
2696 SemaObj = &S;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002697 S.ExternalSource = this;
2698
Douglas Gregor6cfc1a82009-04-22 21:15:06 +00002699 // Makes sure any declarations that were deserialized "too early"
2700 // still get added to the identifier's declaration chains.
2701 for (unsigned I = 0, N = PreloadedDecls.size(); I != N; ++I) {
2702 SemaObj->TUScope->AddDecl(Action::DeclPtrTy::make(PreloadedDecls[I]));
2703 SemaObj->IdResolver.AddDecl(PreloadedDecls[I]);
Douglas Gregor668c1a42009-04-21 22:25:48 +00002704 }
Douglas Gregor6cfc1a82009-04-22 21:15:06 +00002705 PreloadedDecls.clear();
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002706
2707 // If there were any tentative definitions, deserialize them and add
Sebastian Redle9d12b62010-01-31 22:27:38 +00002708 // them to Sema's list of tentative definitions.
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002709 for (unsigned I = 0, N = TentativeDefinitions.size(); I != N; ++I) {
2710 VarDecl *Var = cast<VarDecl>(GetDecl(TentativeDefinitions[I]));
Sebastian Redle9d12b62010-01-31 22:27:38 +00002711 SemaObj->TentativeDefinitions.push_back(Var);
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002712 }
Kovarththanan Rajaratnam6b82f642010-03-07 19:10:13 +00002713
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002714 // If there were any unused static functions, deserialize them and add to
2715 // Sema's list of unused static functions.
2716 for (unsigned I = 0, N = UnusedStaticFuncs.size(); I != N; ++I) {
2717 FunctionDecl *FD = cast<FunctionDecl>(GetDecl(UnusedStaticFuncs[I]));
2718 SemaObj->UnusedStaticFuncs.push_back(FD);
2719 }
Douglas Gregor14c22f22009-04-22 22:18:58 +00002720
2721 // If there were any locally-scoped external declarations,
2722 // deserialize them and add them to Sema's table of locally-scoped
2723 // external declarations.
2724 for (unsigned I = 0, N = LocallyScopedExternalDecls.size(); I != N; ++I) {
2725 NamedDecl *D = cast<NamedDecl>(GetDecl(LocallyScopedExternalDecls[I]));
2726 SemaObj->LocallyScopedExternalDecls[D->getDeclName()] = D;
2727 }
Douglas Gregorb81c1702009-04-27 20:06:05 +00002728
2729 // If there were any ext_vector type declarations, deserialize them
2730 // and add them to Sema's vector of such declarations.
2731 for (unsigned I = 0, N = ExtVectorDecls.size(); I != N; ++I)
2732 SemaObj->ExtVectorDecls.push_back(
2733 cast<TypedefDecl>(GetDecl(ExtVectorDecls[I])));
Douglas Gregor668c1a42009-04-21 22:25:48 +00002734}
2735
2736IdentifierInfo* PCHReader::get(const char *NameStart, const char *NameEnd) {
2737 // Try to find this name within our on-disk hash table
Mike Stump1eb44332009-09-09 15:08:12 +00002738 PCHIdentifierLookupTable *IdTable
Douglas Gregor668c1a42009-04-21 22:25:48 +00002739 = (PCHIdentifierLookupTable *)IdentifierLookupTable;
2740 std::pair<const char*, unsigned> Key(NameStart, NameEnd - NameStart);
2741 PCHIdentifierLookupTable::iterator Pos = IdTable->find(Key);
2742 if (Pos == IdTable->end())
2743 return 0;
2744
2745 // Dereferencing the iterator has the effect of building the
2746 // IdentifierInfo node and populating it with the various
2747 // declarations it needs.
2748 return *Pos;
2749}
2750
Mike Stump1eb44332009-09-09 15:08:12 +00002751std::pair<ObjCMethodList, ObjCMethodList>
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002752PCHReader::ReadMethodPool(Selector Sel) {
2753 if (!MethodPoolLookupTable)
2754 return std::pair<ObjCMethodList, ObjCMethodList>();
2755
2756 // Try to find this selector within our on-disk hash table.
2757 PCHMethodPoolLookupTable *PoolTable
2758 = (PCHMethodPoolLookupTable*)MethodPoolLookupTable;
2759 PCHMethodPoolLookupTable::iterator Pos = PoolTable->find(Sel);
Douglas Gregor83941df2009-04-25 17:48:32 +00002760 if (Pos == PoolTable->end()) {
2761 ++NumMethodPoolMisses;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002762 return std::pair<ObjCMethodList, ObjCMethodList>();;
Douglas Gregor83941df2009-04-25 17:48:32 +00002763 }
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002764
Douglas Gregor83941df2009-04-25 17:48:32 +00002765 ++NumMethodPoolSelectorsRead;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002766 return *Pos;
2767}
2768
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002769void PCHReader::SetIdentifierInfo(unsigned ID, IdentifierInfo *II) {
Douglas Gregor668c1a42009-04-21 22:25:48 +00002770 assert(ID && "Non-zero identifier ID required");
Douglas Gregora02b1472009-04-28 21:53:25 +00002771 assert(ID <= IdentifiersLoaded.size() && "identifier ID out of range");
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002772 IdentifiersLoaded[ID - 1] = II;
Douglas Gregor668c1a42009-04-21 22:25:48 +00002773}
2774
Douglas Gregord89275b2009-07-06 18:54:52 +00002775/// \brief Set the globally-visible declarations associated with the given
2776/// identifier.
2777///
2778/// If the PCH reader is currently in a state where the given declaration IDs
Mike Stump1eb44332009-09-09 15:08:12 +00002779/// cannot safely be resolved, they are queued until it is safe to resolve
Douglas Gregord89275b2009-07-06 18:54:52 +00002780/// them.
2781///
2782/// \param II an IdentifierInfo that refers to one or more globally-visible
2783/// declarations.
2784///
2785/// \param DeclIDs the set of declaration IDs with the name @p II that are
2786/// visible at global scope.
2787///
2788/// \param Nonrecursive should be true to indicate that the caller knows that
2789/// this call is non-recursive, and therefore the globally-visible declarations
2790/// will not be placed onto the pending queue.
Mike Stump1eb44332009-09-09 15:08:12 +00002791void
2792PCHReader::SetGloballyVisibleDecls(IdentifierInfo *II,
Douglas Gregord89275b2009-07-06 18:54:52 +00002793 const llvm::SmallVectorImpl<uint32_t> &DeclIDs,
2794 bool Nonrecursive) {
2795 if (CurrentlyLoadingTypeOrDecl && !Nonrecursive) {
2796 PendingIdentifierInfos.push_back(PendingIdentifierInfo());
2797 PendingIdentifierInfo &PII = PendingIdentifierInfos.back();
2798 PII.II = II;
2799 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I)
2800 PII.DeclIDs.push_back(DeclIDs[I]);
2801 return;
2802 }
Mike Stump1eb44332009-09-09 15:08:12 +00002803
Douglas Gregord89275b2009-07-06 18:54:52 +00002804 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I) {
2805 NamedDecl *D = cast<NamedDecl>(GetDecl(DeclIDs[I]));
2806 if (SemaObj) {
2807 // Introduce this declaration into the translation-unit scope
2808 // and add it to the declaration chain for this identifier, so
2809 // that (unqualified) name lookup will find it.
2810 SemaObj->TUScope->AddDecl(Action::DeclPtrTy::make(D));
2811 SemaObj->IdResolver.AddDeclToIdentifierChain(II, D);
2812 } else {
2813 // Queue this declaration so that it will be added to the
2814 // translation unit scope and identifier's declaration chain
2815 // once a Sema object is known.
2816 PreloadedDecls.push_back(D);
2817 }
2818 }
2819}
2820
Chris Lattner7356a312009-04-11 21:15:38 +00002821IdentifierInfo *PCHReader::DecodeIdentifierInfo(unsigned ID) {
Douglas Gregorafaf3082009-04-11 00:14:32 +00002822 if (ID == 0)
2823 return 0;
Mike Stump1eb44332009-09-09 15:08:12 +00002824
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002825 if (!IdentifierTableData || IdentifiersLoaded.empty()) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002826 Error("no identifier table in PCH file");
Douglas Gregorafaf3082009-04-11 00:14:32 +00002827 return 0;
2828 }
Mike Stump1eb44332009-09-09 15:08:12 +00002829
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00002830 assert(PP && "Forgot to set Preprocessor ?");
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002831 if (!IdentifiersLoaded[ID - 1]) {
2832 uint32_t Offset = IdentifierOffsets[ID - 1];
Douglas Gregor17e1c5e2009-04-25 21:21:38 +00002833 const char *Str = IdentifierTableData + Offset;
Douglas Gregord6595a42009-04-25 21:04:17 +00002834
Douglas Gregor02fc7512009-04-28 20:01:51 +00002835 // All of the strings in the PCH file are preceded by a 16-bit
2836 // length. Extract that 16-bit length to avoid having to execute
2837 // strlen().
Ted Kremenek231bc0b2009-10-23 04:45:31 +00002838 // NOTE: 'StrLenPtr' is an 'unsigned char*' so that we load bytes as
2839 // unsigned integers. This is important to avoid integer overflow when
2840 // we cast them to 'unsigned'.
Ted Kremenekff1ea462009-10-23 03:57:22 +00002841 const unsigned char *StrLenPtr = (const unsigned char*) Str - 2;
Douglas Gregor02fc7512009-04-28 20:01:51 +00002842 unsigned StrLen = (((unsigned) StrLenPtr[0])
2843 | (((unsigned) StrLenPtr[1]) << 8)) - 1;
Mike Stump1eb44332009-09-09 15:08:12 +00002844 IdentifiersLoaded[ID - 1]
Kovarththanan Rajaratnam811f4262010-03-12 10:32:27 +00002845 = &PP->getIdentifierTable().get(Str, StrLen);
Douglas Gregorafaf3082009-04-11 00:14:32 +00002846 }
Mike Stump1eb44332009-09-09 15:08:12 +00002847
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002848 return IdentifiersLoaded[ID - 1];
Douglas Gregor2cf26342009-04-09 22:27:44 +00002849}
2850
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00002851void PCHReader::ReadSLocEntry(unsigned ID) {
2852 ReadSLocEntryRecord(ID);
2853}
2854
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002855Selector PCHReader::DecodeSelector(unsigned ID) {
2856 if (ID == 0)
2857 return Selector();
Mike Stump1eb44332009-09-09 15:08:12 +00002858
Douglas Gregora02b1472009-04-28 21:53:25 +00002859 if (!MethodPoolLookupTableData)
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002860 return Selector();
Douglas Gregor83941df2009-04-25 17:48:32 +00002861
2862 if (ID > TotalNumSelectors) {
Douglas Gregora02b1472009-04-28 21:53:25 +00002863 Error("selector ID out of range in PCH file");
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002864 return Selector();
2865 }
Douglas Gregor83941df2009-04-25 17:48:32 +00002866
2867 unsigned Index = ID - 1;
2868 if (SelectorsLoaded[Index].getAsOpaquePtr() == 0) {
2869 // Load this selector from the selector table.
2870 // FIXME: endianness portability issues with SelectorOffsets table
2871 PCHMethodPoolLookupTrait Trait(*this);
Mike Stump1eb44332009-09-09 15:08:12 +00002872 SelectorsLoaded[Index]
Douglas Gregor83941df2009-04-25 17:48:32 +00002873 = Trait.ReadKey(MethodPoolLookupTableData + SelectorOffsets[Index], 0);
2874 }
2875
2876 return SelectorsLoaded[Index];
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002877}
2878
John McCall76bd1f32010-06-01 09:23:16 +00002879Selector PCHReader::GetExternalSelector(uint32_t ID) {
Douglas Gregor719770d2010-04-06 17:30:22 +00002880 return DecodeSelector(ID);
2881}
2882
John McCall76bd1f32010-06-01 09:23:16 +00002883uint32_t PCHReader::GetNumExternalSelectors() {
Douglas Gregor719770d2010-04-06 17:30:22 +00002884 return TotalNumSelectors + 1;
2885}
2886
Mike Stump1eb44332009-09-09 15:08:12 +00002887DeclarationName
Douglas Gregor2cf26342009-04-09 22:27:44 +00002888PCHReader::ReadDeclarationName(const RecordData &Record, unsigned &Idx) {
2889 DeclarationName::NameKind Kind = (DeclarationName::NameKind)Record[Idx++];
2890 switch (Kind) {
2891 case DeclarationName::Identifier:
2892 return DeclarationName(GetIdentifierInfo(Record, Idx));
2893
2894 case DeclarationName::ObjCZeroArgSelector:
2895 case DeclarationName::ObjCOneArgSelector:
2896 case DeclarationName::ObjCMultiArgSelector:
Steve Naroffa7503a72009-04-23 15:15:40 +00002897 return DeclarationName(GetSelector(Record, Idx));
Douglas Gregor2cf26342009-04-09 22:27:44 +00002898
2899 case DeclarationName::CXXConstructorName:
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002900 return Context->DeclarationNames.getCXXConstructorName(
Douglas Gregor50d62d12009-08-05 05:36:45 +00002901 Context->getCanonicalType(GetType(Record[Idx++])));
Douglas Gregor2cf26342009-04-09 22:27:44 +00002902
2903 case DeclarationName::CXXDestructorName:
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002904 return Context->DeclarationNames.getCXXDestructorName(
Douglas Gregor50d62d12009-08-05 05:36:45 +00002905 Context->getCanonicalType(GetType(Record[Idx++])));
Douglas Gregor2cf26342009-04-09 22:27:44 +00002906
2907 case DeclarationName::CXXConversionFunctionName:
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002908 return Context->DeclarationNames.getCXXConversionFunctionName(
Douglas Gregor50d62d12009-08-05 05:36:45 +00002909 Context->getCanonicalType(GetType(Record[Idx++])));
Douglas Gregor2cf26342009-04-09 22:27:44 +00002910
2911 case DeclarationName::CXXOperatorName:
Chris Lattnerd1d64a02009-04-27 21:45:14 +00002912 return Context->DeclarationNames.getCXXOperatorName(
Douglas Gregor2cf26342009-04-09 22:27:44 +00002913 (OverloadedOperatorKind)Record[Idx++]);
2914
Sean Hunt3e518bd2009-11-29 07:34:05 +00002915 case DeclarationName::CXXLiteralOperatorName:
2916 return Context->DeclarationNames.getCXXLiteralOperatorName(
2917 GetIdentifierInfo(Record, Idx));
2918
Douglas Gregor2cf26342009-04-09 22:27:44 +00002919 case DeclarationName::CXXUsingDirective:
2920 return DeclarationName::getUsingDirectiveName();
2921 }
2922
2923 // Required to silence GCC warning
2924 return DeclarationName();
2925}
Douglas Gregor0a0428e2009-04-10 20:39:37 +00002926
Chris Lattner6ad9ac02010-05-07 21:43:38 +00002927NestedNameSpecifier *
2928PCHReader::ReadNestedNameSpecifier(const RecordData &Record, unsigned &Idx) {
2929 unsigned N = Record[Idx++];
2930 NestedNameSpecifier *NNS = 0, *Prev = 0;
2931 for (unsigned I = 0; I != N; ++I) {
2932 NestedNameSpecifier::SpecifierKind Kind
2933 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
2934 switch (Kind) {
2935 case NestedNameSpecifier::Identifier: {
2936 IdentifierInfo *II = GetIdentifierInfo(Record, Idx);
2937 NNS = NestedNameSpecifier::Create(*Context, Prev, II);
2938 break;
2939 }
2940
2941 case NestedNameSpecifier::Namespace: {
2942 NamespaceDecl *NS = cast<NamespaceDecl>(GetDecl(Record[Idx++]));
2943 NNS = NestedNameSpecifier::Create(*Context, Prev, NS);
2944 break;
2945 }
2946
2947 case NestedNameSpecifier::TypeSpec:
2948 case NestedNameSpecifier::TypeSpecWithTemplate: {
2949 Type *T = GetType(Record[Idx++]).getTypePtr();
2950 bool Template = Record[Idx++];
2951 NNS = NestedNameSpecifier::Create(*Context, Prev, Template, T);
2952 break;
2953 }
2954
2955 case NestedNameSpecifier::Global: {
2956 NNS = NestedNameSpecifier::GlobalSpecifier(*Context);
2957 // No associated value, and there can't be a prefix.
2958 break;
2959 }
2960 Prev = NNS;
2961 }
2962 }
2963 return NNS;
2964}
2965
2966SourceRange
2967PCHReader::ReadSourceRange(const RecordData &Record, unsigned &Idx) {
Daniel Dunbar8ee59392010-06-02 15:47:10 +00002968 SourceLocation beg = SourceLocation::getFromRawEncoding(Record[Idx++]);
2969 SourceLocation end = SourceLocation::getFromRawEncoding(Record[Idx++]);
2970 return SourceRange(beg, end);
Chris Lattner6ad9ac02010-05-07 21:43:38 +00002971}
2972
Douglas Gregor0a2b45e2009-04-13 18:14:40 +00002973/// \brief Read an integral value
2974llvm::APInt PCHReader::ReadAPInt(const RecordData &Record, unsigned &Idx) {
2975 unsigned BitWidth = Record[Idx++];
2976 unsigned NumWords = llvm::APInt::getNumWords(BitWidth);
2977 llvm::APInt Result(BitWidth, NumWords, &Record[Idx]);
2978 Idx += NumWords;
2979 return Result;
2980}
2981
2982/// \brief Read a signed integral value
2983llvm::APSInt PCHReader::ReadAPSInt(const RecordData &Record, unsigned &Idx) {
2984 bool isUnsigned = Record[Idx++];
2985 return llvm::APSInt(ReadAPInt(Record, Idx), isUnsigned);
2986}
2987
Douglas Gregor17fc2232009-04-14 21:55:33 +00002988/// \brief Read a floating-point value
2989llvm::APFloat PCHReader::ReadAPFloat(const RecordData &Record, unsigned &Idx) {
Douglas Gregor17fc2232009-04-14 21:55:33 +00002990 return llvm::APFloat(ReadAPInt(Record, Idx));
2991}
2992
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002993// \brief Read a string
2994std::string PCHReader::ReadString(const RecordData &Record, unsigned &Idx) {
2995 unsigned Len = Record[Idx++];
Jay Foadbeaaccd2009-05-21 09:52:38 +00002996 std::string Result(Record.data() + Idx, Record.data() + Idx + Len);
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002997 Idx += Len;
2998 return Result;
2999}
3000
Chris Lattnerd2598362010-05-10 00:25:06 +00003001CXXTemporary *PCHReader::ReadCXXTemporary(const RecordData &Record,
3002 unsigned &Idx) {
3003 CXXDestructorDecl *Decl = cast<CXXDestructorDecl>(GetDecl(Record[Idx++]));
3004 return CXXTemporary::Create(*Context, Decl);
3005}
3006
Douglas Gregor0a0428e2009-04-10 20:39:37 +00003007DiagnosticBuilder PCHReader::Diag(unsigned DiagID) {
Douglas Gregore1d918e2009-04-10 23:10:45 +00003008 return Diag(SourceLocation(), DiagID);
3009}
3010
3011DiagnosticBuilder PCHReader::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00003012 return Diags.Report(FullSourceLoc(Loc, SourceMgr), DiagID);
Douglas Gregor0a0428e2009-04-10 20:39:37 +00003013}
Douglas Gregor025452f2009-04-17 00:04:06 +00003014
Douglas Gregor668c1a42009-04-21 22:25:48 +00003015/// \brief Retrieve the identifier table associated with the
3016/// preprocessor.
3017IdentifierTable &PCHReader::getIdentifierTable() {
Argyrios Kyrtzidis11e51102009-06-19 00:03:23 +00003018 assert(PP && "Forgot to set Preprocessor ?");
3019 return PP->getIdentifierTable();
Douglas Gregor668c1a42009-04-21 22:25:48 +00003020}
3021
Douglas Gregor025452f2009-04-17 00:04:06 +00003022/// \brief Record that the given ID maps to the given switch-case
3023/// statement.
3024void PCHReader::RecordSwitchCaseID(SwitchCase *SC, unsigned ID) {
3025 assert(SwitchCaseStmts[ID] == 0 && "Already have a SwitchCase with this ID");
3026 SwitchCaseStmts[ID] = SC;
3027}
3028
3029/// \brief Retrieve the switch-case statement with the given ID.
3030SwitchCase *PCHReader::getSwitchCaseWithID(unsigned ID) {
3031 assert(SwitchCaseStmts[ID] != 0 && "No SwitchCase with this ID");
3032 return SwitchCaseStmts[ID];
3033}
Douglas Gregor1de05fe2009-04-17 18:18:49 +00003034
3035/// \brief Record that the given label statement has been
3036/// deserialized and has the given ID.
3037void PCHReader::RecordLabelStmt(LabelStmt *S, unsigned ID) {
Mike Stump1eb44332009-09-09 15:08:12 +00003038 assert(LabelStmts.find(ID) == LabelStmts.end() &&
Douglas Gregor1de05fe2009-04-17 18:18:49 +00003039 "Deserialized label twice");
3040 LabelStmts[ID] = S;
3041
3042 // If we've already seen any goto statements that point to this
3043 // label, resolve them now.
3044 typedef std::multimap<unsigned, GotoStmt *>::iterator GotoIter;
3045 std::pair<GotoIter, GotoIter> Gotos = UnresolvedGotoStmts.equal_range(ID);
3046 for (GotoIter Goto = Gotos.first; Goto != Gotos.second; ++Goto)
3047 Goto->second->setLabel(S);
3048 UnresolvedGotoStmts.erase(Gotos.first, Gotos.second);
Douglas Gregor7d5c2f22009-04-17 18:58:21 +00003049
3050 // If we've already seen any address-label statements that point to
3051 // this label, resolve them now.
3052 typedef std::multimap<unsigned, AddrLabelExpr *>::iterator AddrLabelIter;
Mike Stump1eb44332009-09-09 15:08:12 +00003053 std::pair<AddrLabelIter, AddrLabelIter> AddrLabels
Douglas Gregor7d5c2f22009-04-17 18:58:21 +00003054 = UnresolvedAddrLabelExprs.equal_range(ID);
Mike Stump1eb44332009-09-09 15:08:12 +00003055 for (AddrLabelIter AddrLabel = AddrLabels.first;
Douglas Gregor7d5c2f22009-04-17 18:58:21 +00003056 AddrLabel != AddrLabels.second; ++AddrLabel)
3057 AddrLabel->second->setLabel(S);
3058 UnresolvedAddrLabelExprs.erase(AddrLabels.first, AddrLabels.second);
Douglas Gregor1de05fe2009-04-17 18:18:49 +00003059}
3060
3061/// \brief Set the label of the given statement to the label
3062/// identified by ID.
3063///
3064/// Depending on the order in which the label and other statements
3065/// referencing that label occur, this operation may complete
3066/// immediately (updating the statement) or it may queue the
3067/// statement to be back-patched later.
3068void PCHReader::SetLabelOf(GotoStmt *S, unsigned ID) {
3069 std::map<unsigned, LabelStmt *>::iterator Label = LabelStmts.find(ID);
3070 if (Label != LabelStmts.end()) {
3071 // We've already seen this label, so set the label of the goto and
3072 // we're done.
3073 S->setLabel(Label->second);
3074 } else {
3075 // We haven't seen this label yet, so add this goto to the set of
3076 // unresolved goto statements.
3077 UnresolvedGotoStmts.insert(std::make_pair(ID, S));
3078 }
3079}
Douglas Gregor7d5c2f22009-04-17 18:58:21 +00003080
3081/// \brief Set the label of the given expression to the label
3082/// identified by ID.
3083///
3084/// Depending on the order in which the label and other statements
3085/// referencing that label occur, this operation may complete
3086/// immediately (updating the statement) or it may queue the
3087/// statement to be back-patched later.
3088void PCHReader::SetLabelOf(AddrLabelExpr *S, unsigned ID) {
3089 std::map<unsigned, LabelStmt *>::iterator Label = LabelStmts.find(ID);
3090 if (Label != LabelStmts.end()) {
3091 // We've already seen this label, so set the label of the
3092 // label-address expression and we're done.
3093 S->setLabel(Label->second);
3094 } else {
3095 // We haven't seen this label yet, so add this label-address
3096 // expression to the set of unresolved label-address expressions.
3097 UnresolvedAddrLabelExprs.insert(std::make_pair(ID, S));
3098 }
3099}
Douglas Gregord89275b2009-07-06 18:54:52 +00003100
3101
Mike Stump1eb44332009-09-09 15:08:12 +00003102PCHReader::LoadingTypeOrDecl::LoadingTypeOrDecl(PCHReader &Reader)
Douglas Gregord89275b2009-07-06 18:54:52 +00003103 : Reader(Reader), Parent(Reader.CurrentlyLoadingTypeOrDecl) {
3104 Reader.CurrentlyLoadingTypeOrDecl = this;
3105}
3106
3107PCHReader::LoadingTypeOrDecl::~LoadingTypeOrDecl() {
3108 if (!Parent) {
3109 // If any identifiers with corresponding top-level declarations have
3110 // been loaded, load those declarations now.
3111 while (!Reader.PendingIdentifierInfos.empty()) {
3112 Reader.SetGloballyVisibleDecls(Reader.PendingIdentifierInfos.front().II,
3113 Reader.PendingIdentifierInfos.front().DeclIDs,
3114 true);
3115 Reader.PendingIdentifierInfos.pop_front();
3116 }
3117 }
3118
Mike Stump1eb44332009-09-09 15:08:12 +00003119 Reader.CurrentlyLoadingTypeOrDecl = Parent;
Douglas Gregord89275b2009-07-06 18:54:52 +00003120}