blob: d9d3960f6fdaaa77b8042a546579d3725f2f1868 [file] [log] [blame]
Douglas Gregoref84c4b2009-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 Lattner92ba5ff2009-04-27 05:14:47 +000013
Douglas Gregoref84c4b2009-04-09 22:27:44 +000014#include "clang/Frontend/PCHReader.h"
Douglas Gregor55abb232009-04-10 20:39:37 +000015#include "clang/Frontend/FrontendDiagnostic.h"
Douglas Gregora868bbd2009-04-21 22:25:48 +000016#include "../Sema/Sema.h" // FIXME: move Sema headers elsewhere
Douglas Gregor1a0d0b92009-04-14 00:24:19 +000017#include "clang/AST/ASTConsumer.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000018#include "clang/AST/ASTContext.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000019#include "clang/AST/Expr.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000020#include "clang/AST/Type.h"
Chris Lattner34321bc2009-04-10 21:41:48 +000021#include "clang/Lex/MacroInfo.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000022#include "clang/Lex/Preprocessor.h"
Steve Naroff3fa455a2009-04-24 20:03:17 +000023#include "clang/Lex/HeaderSearch.h"
Douglas Gregora868bbd2009-04-21 22:25:48 +000024#include "clang/Basic/OnDiskHashTable.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000025#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000026#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000027#include "clang/Basic/FileManager.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000028#include "clang/Basic/TargetInfo.h"
Douglas Gregord54f3a12009-10-05 21:07:28 +000029#include "clang/Basic/Version.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000030#include "llvm/Bitcode/BitstreamReader.h"
31#include "llvm/Support/Compiler.h"
32#include "llvm/Support/MemoryBuffer.h"
33#include <algorithm>
Douglas Gregorc379c072009-04-28 18:58:38 +000034#include <iterator>
Douglas Gregoref84c4b2009-04-09 22:27:44 +000035#include <cstdio>
Douglas Gregorc5046832009-04-27 18:38:38 +000036#include <sys/stat.h>
Douglas Gregoref84c4b2009-04-09 22:27:44 +000037using namespace clang;
38
39//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +000040// PCH reader validator implementation
41//===----------------------------------------------------------------------===//
42
43PCHReaderListener::~PCHReaderListener() {}
44
45bool
46PCHValidator::ReadLanguageOptions(const LangOptions &LangOpts) {
47 const LangOptions &PPLangOpts = PP.getLangOptions();
48#define PARSE_LANGOPT_BENIGN(Option)
49#define PARSE_LANGOPT_IMPORTANT(Option, DiagID) \
50 if (PPLangOpts.Option != LangOpts.Option) { \
51 Reader.Diag(DiagID) << LangOpts.Option << PPLangOpts.Option; \
52 return true; \
53 }
54
55 PARSE_LANGOPT_BENIGN(Trigraphs);
56 PARSE_LANGOPT_BENIGN(BCPLComment);
57 PARSE_LANGOPT_BENIGN(DollarIdents);
58 PARSE_LANGOPT_BENIGN(AsmPreprocessor);
59 PARSE_LANGOPT_IMPORTANT(GNUMode, diag::warn_pch_gnu_extensions);
60 PARSE_LANGOPT_BENIGN(ImplicitInt);
61 PARSE_LANGOPT_BENIGN(Digraphs);
62 PARSE_LANGOPT_BENIGN(HexFloats);
63 PARSE_LANGOPT_IMPORTANT(C99, diag::warn_pch_c99);
64 PARSE_LANGOPT_IMPORTANT(Microsoft, diag::warn_pch_microsoft_extensions);
65 PARSE_LANGOPT_IMPORTANT(CPlusPlus, diag::warn_pch_cplusplus);
66 PARSE_LANGOPT_IMPORTANT(CPlusPlus0x, diag::warn_pch_cplusplus0x);
67 PARSE_LANGOPT_BENIGN(CXXOperatorName);
68 PARSE_LANGOPT_IMPORTANT(ObjC1, diag::warn_pch_objective_c);
69 PARSE_LANGOPT_IMPORTANT(ObjC2, diag::warn_pch_objective_c2);
70 PARSE_LANGOPT_IMPORTANT(ObjCNonFragileABI, diag::warn_pch_nonfragile_abi);
71 PARSE_LANGOPT_BENIGN(PascalStrings);
72 PARSE_LANGOPT_BENIGN(WritableStrings);
Mike Stump11289f42009-09-09 15:08:12 +000073 PARSE_LANGOPT_IMPORTANT(LaxVectorConversions,
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +000074 diag::warn_pch_lax_vector_conversions);
Nate Begeman9d905792009-06-25 22:57:40 +000075 PARSE_LANGOPT_IMPORTANT(AltiVec, diag::warn_pch_altivec);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +000076 PARSE_LANGOPT_IMPORTANT(Exceptions, diag::warn_pch_exceptions);
77 PARSE_LANGOPT_IMPORTANT(NeXTRuntime, diag::warn_pch_objc_runtime);
78 PARSE_LANGOPT_IMPORTANT(Freestanding, diag::warn_pch_freestanding);
79 PARSE_LANGOPT_IMPORTANT(NoBuiltin, diag::warn_pch_builtins);
Mike Stump11289f42009-09-09 15:08:12 +000080 PARSE_LANGOPT_IMPORTANT(ThreadsafeStatics,
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +000081 diag::warn_pch_thread_safe_statics);
Daniel Dunbara77eaeb2009-09-03 04:54:28 +000082 PARSE_LANGOPT_IMPORTANT(POSIXThreads, diag::warn_pch_posix_threads);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +000083 PARSE_LANGOPT_IMPORTANT(Blocks, diag::warn_pch_blocks);
84 PARSE_LANGOPT_BENIGN(EmitAllDecls);
85 PARSE_LANGOPT_IMPORTANT(MathErrno, diag::warn_pch_math_errno);
86 PARSE_LANGOPT_IMPORTANT(OverflowChecking, diag::warn_pch_overflow_checking);
Mike Stump11289f42009-09-09 15:08:12 +000087 PARSE_LANGOPT_IMPORTANT(HeinousExtensions,
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +000088 diag::warn_pch_heinous_extensions);
89 // FIXME: Most of the options below are benign if the macro wasn't
90 // used. Unfortunately, this means that a PCH compiled without
91 // optimization can't be used with optimization turned on, even
92 // though the only thing that changes is whether __OPTIMIZE__ was
93 // defined... but if __OPTIMIZE__ never showed up in the header, it
94 // doesn't matter. We could consider making this some special kind
95 // of check.
96 PARSE_LANGOPT_IMPORTANT(Optimize, diag::warn_pch_optimize);
97 PARSE_LANGOPT_IMPORTANT(OptimizeSize, diag::warn_pch_optimize_size);
98 PARSE_LANGOPT_IMPORTANT(Static, diag::warn_pch_static);
99 PARSE_LANGOPT_IMPORTANT(PICLevel, diag::warn_pch_pic_level);
100 PARSE_LANGOPT_IMPORTANT(GNUInline, diag::warn_pch_gnu_inline);
101 PARSE_LANGOPT_IMPORTANT(NoInline, diag::warn_pch_no_inline);
102 PARSE_LANGOPT_IMPORTANT(AccessControl, diag::warn_pch_access_control);
103 PARSE_LANGOPT_IMPORTANT(CharIsSigned, diag::warn_pch_char_signed);
104 if ((PPLangOpts.getGCMode() != 0) != (LangOpts.getGCMode() != 0)) {
Mike Stump11289f42009-09-09 15:08:12 +0000105 Reader.Diag(diag::warn_pch_gc_mode)
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000106 << LangOpts.getGCMode() << PPLangOpts.getGCMode();
107 return true;
108 }
109 PARSE_LANGOPT_BENIGN(getVisibilityMode());
Daniel Dunbar143021e2009-09-21 04:16:19 +0000110 PARSE_LANGOPT_IMPORTANT(getStackProtectorMode(),
111 diag::warn_pch_stack_protector);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000112 PARSE_LANGOPT_BENIGN(InstantiationDepth);
Nate Begeman9d905792009-06-25 22:57:40 +0000113 PARSE_LANGOPT_IMPORTANT(OpenCL, diag::warn_pch_opencl);
Daniel Dunbar143021e2009-09-21 04:16:19 +0000114 PARSE_LANGOPT_IMPORTANT(ElideConstructors, diag::warn_pch_elide_constructors);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000115#undef PARSE_LANGOPT_IRRELEVANT
116#undef PARSE_LANGOPT_BENIGN
117
118 return false;
119}
120
121bool PCHValidator::ReadTargetTriple(const std::string &Triple) {
Daniel Dunbar40165182009-08-24 09:10:05 +0000122 if (Triple != PP.getTargetInfo().getTriple().getTriple()) {
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000123 Reader.Diag(diag::warn_pch_target_triple)
Daniel Dunbar40165182009-08-24 09:10:05 +0000124 << Triple << PP.getTargetInfo().getTriple().getTriple();
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000125 return true;
126 }
127 return false;
128}
129
130/// \brief Split the given string into a vector of lines, eliminating
131/// any empty lines in the process.
132///
133/// \param Str the string to split.
134/// \param Len the length of Str.
135/// \param KeepEmptyLines true if empty lines should be included
136/// \returns a vector of lines, with the line endings removed
137static std::vector<std::string> splitLines(const char *Str, unsigned Len,
138 bool KeepEmptyLines = false) {
139 std::vector<std::string> Lines;
140 for (unsigned LineStart = 0; LineStart < Len; ++LineStart) {
141 unsigned LineEnd = LineStart;
142 while (LineEnd < Len && Str[LineEnd] != '\n')
143 ++LineEnd;
144 if (LineStart != LineEnd || KeepEmptyLines)
145 Lines.push_back(std::string(&Str[LineStart], &Str[LineEnd]));
146 LineStart = LineEnd;
147 }
148 return Lines;
149}
150
151/// \brief Determine whether the string Haystack starts with the
152/// substring Needle.
153static bool startsWith(const std::string &Haystack, const char *Needle) {
154 for (unsigned I = 0, N = Haystack.size(); Needle[I] != 0; ++I) {
155 if (I == N)
156 return false;
157 if (Haystack[I] != Needle[I])
158 return false;
159 }
160
161 return true;
162}
163
164/// \brief Determine whether the string Haystack starts with the
165/// substring Needle.
166static inline bool startsWith(const std::string &Haystack,
167 const std::string &Needle) {
168 return startsWith(Haystack, Needle.c_str());
169}
170
Mike Stump11289f42009-09-09 15:08:12 +0000171bool PCHValidator::ReadPredefinesBuffer(const char *PCHPredef,
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000172 unsigned PCHPredefLen,
173 FileID PCHBufferID,
174 std::string &SuggestedPredefines) {
175 const char *Predef = PP.getPredefines().c_str();
176 unsigned PredefLen = PP.getPredefines().size();
177
178 // If the two predefines buffers compare equal, we're done!
Mike Stump11289f42009-09-09 15:08:12 +0000179 if (PredefLen == PCHPredefLen &&
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000180 strncmp(Predef, PCHPredef, PCHPredefLen) == 0)
181 return false;
182
183 SourceManager &SourceMgr = PP.getSourceManager();
Mike Stump11289f42009-09-09 15:08:12 +0000184
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000185 // The predefines buffers are different. Determine what the
186 // differences are, and whether they require us to reject the PCH
187 // file.
188 std::vector<std::string> CmdLineLines = splitLines(Predef, PredefLen);
189 std::vector<std::string> PCHLines = splitLines(PCHPredef, PCHPredefLen);
190
Mike Stump11289f42009-09-09 15:08:12 +0000191 // Sort both sets of predefined buffer lines, since
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000192 std::sort(CmdLineLines.begin(), CmdLineLines.end());
193 std::sort(PCHLines.begin(), PCHLines.end());
194
195 // Determine which predefines that where used to build the PCH file
196 // are missing from the command line.
197 std::vector<std::string> MissingPredefines;
198 std::set_difference(PCHLines.begin(), PCHLines.end(),
199 CmdLineLines.begin(), CmdLineLines.end(),
200 std::back_inserter(MissingPredefines));
201
202 bool MissingDefines = false;
203 bool ConflictingDefines = false;
204 for (unsigned I = 0, N = MissingPredefines.size(); I != N; ++I) {
205 const std::string &Missing = MissingPredefines[I];
206 if (!startsWith(Missing, "#define ") != 0) {
207 Reader.Diag(diag::warn_pch_compiler_options_mismatch);
208 return true;
209 }
Mike Stump11289f42009-09-09 15:08:12 +0000210
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000211 // This is a macro definition. Determine the name of the macro
212 // we're defining.
213 std::string::size_type StartOfMacroName = strlen("#define ");
Mike Stump11289f42009-09-09 15:08:12 +0000214 std::string::size_type EndOfMacroName
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000215 = Missing.find_first_of("( \n\r", StartOfMacroName);
216 assert(EndOfMacroName != std::string::npos &&
217 "Couldn't find the end of the macro name");
218 std::string MacroName = Missing.substr(StartOfMacroName,
219 EndOfMacroName - StartOfMacroName);
220
221 // Determine whether this macro was given a different definition
222 // on the command line.
223 std::string MacroDefStart = "#define " + MacroName;
224 std::string::size_type MacroDefLen = MacroDefStart.size();
225 std::vector<std::string>::iterator ConflictPos
226 = std::lower_bound(CmdLineLines.begin(), CmdLineLines.end(),
227 MacroDefStart);
228 for (; ConflictPos != CmdLineLines.end(); ++ConflictPos) {
229 if (!startsWith(*ConflictPos, MacroDefStart)) {
230 // Different macro; we're done.
231 ConflictPos = CmdLineLines.end();
Mike Stump11289f42009-09-09 15:08:12 +0000232 break;
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000233 }
Mike Stump11289f42009-09-09 15:08:12 +0000234
235 assert(ConflictPos->size() > MacroDefLen &&
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000236 "Invalid #define in predefines buffer?");
Mike Stump11289f42009-09-09 15:08:12 +0000237 if ((*ConflictPos)[MacroDefLen] != ' ' &&
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000238 (*ConflictPos)[MacroDefLen] != '(')
239 continue; // Longer macro name; keep trying.
Mike Stump11289f42009-09-09 15:08:12 +0000240
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000241 // We found a conflicting macro definition.
242 break;
243 }
Mike Stump11289f42009-09-09 15:08:12 +0000244
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000245 if (ConflictPos != CmdLineLines.end()) {
246 Reader.Diag(diag::warn_cmdline_conflicting_macro_def)
247 << MacroName;
248
249 // Show the definition of this macro within the PCH file.
250 const char *MissingDef = strstr(PCHPredef, Missing.c_str());
251 unsigned Offset = MissingDef - PCHPredef;
252 SourceLocation PCHMissingLoc
253 = SourceMgr.getLocForStartOfFile(PCHBufferID)
254 .getFileLocWithOffset(Offset);
255 Reader.Diag(PCHMissingLoc, diag::note_pch_macro_defined_as)
256 << MacroName;
257
258 ConflictingDefines = true;
259 continue;
260 }
Mike Stump11289f42009-09-09 15:08:12 +0000261
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000262 // If the macro doesn't conflict, then we'll just pick up the
263 // macro definition from the PCH file. Warn the user that they
264 // made a mistake.
265 if (ConflictingDefines)
266 continue; // Don't complain if there are already conflicting defs
Mike Stump11289f42009-09-09 15:08:12 +0000267
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000268 if (!MissingDefines) {
269 Reader.Diag(diag::warn_cmdline_missing_macro_defs);
270 MissingDefines = true;
271 }
272
273 // Show the definition of this macro within the PCH file.
274 const char *MissingDef = strstr(PCHPredef, Missing.c_str());
275 unsigned Offset = MissingDef - PCHPredef;
276 SourceLocation PCHMissingLoc
277 = SourceMgr.getLocForStartOfFile(PCHBufferID)
278 .getFileLocWithOffset(Offset);
279 Reader.Diag(PCHMissingLoc, diag::note_using_macro_def_from_pch);
280 }
Mike Stump11289f42009-09-09 15:08:12 +0000281
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000282 if (ConflictingDefines)
283 return true;
Mike Stump11289f42009-09-09 15:08:12 +0000284
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000285 // Determine what predefines were introduced based on command-line
286 // parameters that were not present when building the PCH
287 // file. Extra #defines are okay, so long as the identifiers being
288 // defined were not used within the precompiled header.
289 std::vector<std::string> ExtraPredefines;
290 std::set_difference(CmdLineLines.begin(), CmdLineLines.end(),
291 PCHLines.begin(), PCHLines.end(),
Mike Stump11289f42009-09-09 15:08:12 +0000292 std::back_inserter(ExtraPredefines));
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000293 for (unsigned I = 0, N = ExtraPredefines.size(); I != N; ++I) {
294 const std::string &Extra = ExtraPredefines[I];
295 if (!startsWith(Extra, "#define ") != 0) {
296 Reader.Diag(diag::warn_pch_compiler_options_mismatch);
297 return true;
298 }
299
300 // This is an extra macro definition. Determine the name of the
301 // macro we're defining.
302 std::string::size_type StartOfMacroName = strlen("#define ");
Mike Stump11289f42009-09-09 15:08:12 +0000303 std::string::size_type EndOfMacroName
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000304 = Extra.find_first_of("( \n\r", StartOfMacroName);
305 assert(EndOfMacroName != std::string::npos &&
306 "Couldn't find the end of the macro name");
307 std::string MacroName = Extra.substr(StartOfMacroName,
308 EndOfMacroName - StartOfMacroName);
309
310 // Check whether this name was used somewhere in the PCH file. If
311 // so, defining it as a macro could change behavior, so we reject
312 // the PCH file.
313 if (IdentifierInfo *II = Reader.get(MacroName.c_str(),
314 MacroName.c_str() + MacroName.size())) {
315 Reader.Diag(diag::warn_macro_name_used_in_pch)
316 << II;
317 return true;
318 }
319
320 // Add this definition to the suggested predefines buffer.
321 SuggestedPredefines += Extra;
322 SuggestedPredefines += '\n';
323 }
324
325 // If we get here, it's because the predefines buffer had compatible
326 // contents. Accept the PCH file.
327 return false;
328}
329
330void PCHValidator::ReadHeaderFileInfo(const HeaderFileInfo &HFI) {
331 PP.getHeaderSearchInfo().setHeaderFileInfoForUID(HFI, NumHeaderInfos++);
332}
333
334void PCHValidator::ReadCounter(unsigned Value) {
335 PP.setCounterValue(Value);
336}
337
338
339
340//===----------------------------------------------------------------------===//
Douglas Gregora868bbd2009-04-21 22:25:48 +0000341// PCH reader implementation
342//===----------------------------------------------------------------------===//
343
Mike Stump11289f42009-09-09 15:08:12 +0000344PCHReader::PCHReader(Preprocessor &PP, ASTContext *Context,
345 const char *isysroot)
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000346 : Listener(new PCHValidator(PP, *this)), SourceMgr(PP.getSourceManager()),
347 FileMgr(PP.getFileManager()), Diags(PP.getDiagnostics()),
348 SemaObj(0), PP(&PP), Context(Context), Consumer(0),
349 IdentifierTableData(0), IdentifierLookupTable(0),
350 IdentifierOffsets(0),
351 MethodPoolLookupTable(0), MethodPoolLookupTableData(0),
352 TotalSelectorsInMethodPool(0), SelectorOffsets(0),
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000353 TotalNumSelectors(0), Comments(0), NumComments(0), isysroot(isysroot),
Mike Stump11289f42009-09-09 15:08:12 +0000354 NumStatHits(0), NumStatMisses(0),
355 NumSLocEntriesRead(0), NumStatementsRead(0),
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000356 NumMacrosRead(0), NumMethodPoolSelectorsRead(0), NumMethodPoolMisses(0),
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000357 NumLexicalDeclContextsRead(0), NumVisibleDeclContextsRead(0),
Mike Stump11289f42009-09-09 15:08:12 +0000358 CurrentlyLoadingTypeOrDecl(0) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000359 RelocatablePCH = false;
360}
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000361
362PCHReader::PCHReader(SourceManager &SourceMgr, FileManager &FileMgr,
Mike Stump11289f42009-09-09 15:08:12 +0000363 Diagnostic &Diags, const char *isysroot)
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000364 : SourceMgr(SourceMgr), FileMgr(FileMgr), Diags(Diags),
Argyrios Kyrtzidise55f6ff2009-06-19 07:55:35 +0000365 SemaObj(0), PP(0), Context(0), Consumer(0),
Chris Lattner92ba5ff2009-04-27 05:14:47 +0000366 IdentifierTableData(0), IdentifierLookupTable(0),
367 IdentifierOffsets(0),
368 MethodPoolLookupTable(0), MethodPoolLookupTableData(0),
369 TotalSelectorsInMethodPool(0), SelectorOffsets(0),
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000370 TotalNumSelectors(0), Comments(0), NumComments(0), isysroot(isysroot),
Mike Stump11289f42009-09-09 15:08:12 +0000371 NumStatHits(0), NumStatMisses(0),
372 NumSLocEntriesRead(0), NumStatementsRead(0),
Douglas Gregor258ae542009-04-27 06:38:32 +0000373 NumMacrosRead(0), NumMethodPoolSelectorsRead(0), NumMethodPoolMisses(0),
Douglas Gregor1342e842009-07-06 18:54:52 +0000374 NumLexicalDeclContextsRead(0), NumVisibleDeclContextsRead(0),
Mike Stump11289f42009-09-09 15:08:12 +0000375 CurrentlyLoadingTypeOrDecl(0) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000376 RelocatablePCH = false;
377}
Chris Lattner92ba5ff2009-04-27 05:14:47 +0000378
379PCHReader::~PCHReader() {}
380
Chris Lattner1de76db2009-04-27 05:58:23 +0000381Expr *PCHReader::ReadDeclExpr() {
382 return dyn_cast_or_null<Expr>(ReadStmt(DeclsCursor));
383}
384
385Expr *PCHReader::ReadTypeExpr() {
Chris Lattnerf4262532009-04-27 05:41:06 +0000386 return dyn_cast_or_null<Expr>(ReadStmt(Stream));
Chris Lattner92ba5ff2009-04-27 05:14:47 +0000387}
388
389
Douglas Gregora868bbd2009-04-21 22:25:48 +0000390namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +0000391class VISIBILITY_HIDDEN PCHMethodPoolLookupTrait {
392 PCHReader &Reader;
393
394public:
395 typedef std::pair<ObjCMethodList, ObjCMethodList> data_type;
396
397 typedef Selector external_key_type;
398 typedef external_key_type internal_key_type;
399
400 explicit PCHMethodPoolLookupTrait(PCHReader &Reader) : Reader(Reader) { }
Mike Stump11289f42009-09-09 15:08:12 +0000401
Douglas Gregorc78d3462009-04-24 21:10:55 +0000402 static bool EqualKey(const internal_key_type& a,
403 const internal_key_type& b) {
404 return a == b;
405 }
Mike Stump11289f42009-09-09 15:08:12 +0000406
Douglas Gregorc78d3462009-04-24 21:10:55 +0000407 static unsigned ComputeHash(Selector Sel) {
408 unsigned N = Sel.getNumArgs();
409 if (N == 0)
410 ++N;
411 unsigned R = 5381;
412 for (unsigned I = 0; I != N; ++I)
413 if (IdentifierInfo *II = Sel.getIdentifierInfoForSlot(I))
414 R = clang::BernsteinHashPartial(II->getName(), II->getLength(), R);
415 return R;
416 }
Mike Stump11289f42009-09-09 15:08:12 +0000417
Douglas Gregorc78d3462009-04-24 21:10:55 +0000418 // This hopefully will just get inlined and removed by the optimizer.
419 static const internal_key_type&
420 GetInternalKey(const external_key_type& x) { return x; }
Mike Stump11289f42009-09-09 15:08:12 +0000421
Douglas Gregorc78d3462009-04-24 21:10:55 +0000422 static std::pair<unsigned, unsigned>
423 ReadKeyDataLength(const unsigned char*& d) {
424 using namespace clang::io;
425 unsigned KeyLen = ReadUnalignedLE16(d);
426 unsigned DataLen = ReadUnalignedLE16(d);
427 return std::make_pair(KeyLen, DataLen);
428 }
Mike Stump11289f42009-09-09 15:08:12 +0000429
Douglas Gregor95c13f52009-04-25 17:48:32 +0000430 internal_key_type ReadKey(const unsigned char* d, unsigned) {
Douglas Gregorc78d3462009-04-24 21:10:55 +0000431 using namespace clang::io;
Chris Lattner8575daa2009-04-27 21:45:14 +0000432 SelectorTable &SelTable = Reader.getContext()->Selectors;
Douglas Gregorc78d3462009-04-24 21:10:55 +0000433 unsigned N = ReadUnalignedLE16(d);
Mike Stump11289f42009-09-09 15:08:12 +0000434 IdentifierInfo *FirstII
Douglas Gregorc78d3462009-04-24 21:10:55 +0000435 = Reader.DecodeIdentifierInfo(ReadUnalignedLE32(d));
436 if (N == 0)
437 return SelTable.getNullarySelector(FirstII);
438 else if (N == 1)
439 return SelTable.getUnarySelector(FirstII);
440
441 llvm::SmallVector<IdentifierInfo *, 16> Args;
442 Args.push_back(FirstII);
443 for (unsigned I = 1; I != N; ++I)
444 Args.push_back(Reader.DecodeIdentifierInfo(ReadUnalignedLE32(d)));
445
Douglas Gregor038c3382009-05-22 22:45:36 +0000446 return SelTable.getSelector(N, Args.data());
Douglas Gregorc78d3462009-04-24 21:10:55 +0000447 }
Mike Stump11289f42009-09-09 15:08:12 +0000448
Douglas Gregorc78d3462009-04-24 21:10:55 +0000449 data_type ReadData(Selector, const unsigned char* d, unsigned DataLen) {
450 using namespace clang::io;
451 unsigned NumInstanceMethods = ReadUnalignedLE16(d);
452 unsigned NumFactoryMethods = ReadUnalignedLE16(d);
453
454 data_type Result;
455
456 // Load instance methods
457 ObjCMethodList *Prev = 0;
458 for (unsigned I = 0; I != NumInstanceMethods; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +0000459 ObjCMethodDecl *Method
Douglas Gregorc78d3462009-04-24 21:10:55 +0000460 = cast<ObjCMethodDecl>(Reader.GetDecl(ReadUnalignedLE32(d)));
461 if (!Result.first.Method) {
462 // This is the first method, which is the easy case.
463 Result.first.Method = Method;
464 Prev = &Result.first;
465 continue;
466 }
467
468 Prev->Next = new ObjCMethodList(Method, 0);
469 Prev = Prev->Next;
470 }
471
472 // Load factory methods
473 Prev = 0;
474 for (unsigned I = 0; I != NumFactoryMethods; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +0000475 ObjCMethodDecl *Method
Douglas Gregorc78d3462009-04-24 21:10:55 +0000476 = cast<ObjCMethodDecl>(Reader.GetDecl(ReadUnalignedLE32(d)));
477 if (!Result.second.Method) {
478 // This is the first method, which is the easy case.
479 Result.second.Method = Method;
480 Prev = &Result.second;
481 continue;
482 }
483
484 Prev->Next = new ObjCMethodList(Method, 0);
485 Prev = Prev->Next;
486 }
487
488 return Result;
489 }
490};
Mike Stump11289f42009-09-09 15:08:12 +0000491
492} // end anonymous namespace
Douglas Gregorc78d3462009-04-24 21:10:55 +0000493
494/// \brief The on-disk hash table used for the global method pool.
Mike Stump11289f42009-09-09 15:08:12 +0000495typedef OnDiskChainedHashTable<PCHMethodPoolLookupTrait>
Douglas Gregorc78d3462009-04-24 21:10:55 +0000496 PCHMethodPoolLookupTable;
497
498namespace {
Douglas Gregora868bbd2009-04-21 22:25:48 +0000499class VISIBILITY_HIDDEN PCHIdentifierLookupTrait {
500 PCHReader &Reader;
501
502 // If we know the IdentifierInfo in advance, it is here and we will
503 // not build a new one. Used when deserializing information about an
504 // identifier that was constructed before the PCH file was read.
505 IdentifierInfo *KnownII;
506
507public:
508 typedef IdentifierInfo * data_type;
509
510 typedef const std::pair<const char*, unsigned> external_key_type;
511
512 typedef external_key_type internal_key_type;
513
Mike Stump11289f42009-09-09 15:08:12 +0000514 explicit PCHIdentifierLookupTrait(PCHReader &Reader, IdentifierInfo *II = 0)
Douglas Gregora868bbd2009-04-21 22:25:48 +0000515 : Reader(Reader), KnownII(II) { }
Mike Stump11289f42009-09-09 15:08:12 +0000516
Douglas Gregora868bbd2009-04-21 22:25:48 +0000517 static bool EqualKey(const internal_key_type& a,
518 const internal_key_type& b) {
519 return (a.second == b.second) ? memcmp(a.first, b.first, a.second) == 0
520 : false;
521 }
Mike Stump11289f42009-09-09 15:08:12 +0000522
Douglas Gregora868bbd2009-04-21 22:25:48 +0000523 static unsigned ComputeHash(const internal_key_type& a) {
524 return BernsteinHash(a.first, a.second);
525 }
Mike Stump11289f42009-09-09 15:08:12 +0000526
Douglas Gregora868bbd2009-04-21 22:25:48 +0000527 // This hopefully will just get inlined and removed by the optimizer.
528 static const internal_key_type&
529 GetInternalKey(const external_key_type& x) { return x; }
Mike Stump11289f42009-09-09 15:08:12 +0000530
Douglas Gregora868bbd2009-04-21 22:25:48 +0000531 static std::pair<unsigned, unsigned>
532 ReadKeyDataLength(const unsigned char*& d) {
533 using namespace clang::io;
Douglas Gregor6b7bf5a2009-04-25 20:26:24 +0000534 unsigned DataLen = ReadUnalignedLE16(d);
Douglas Gregor5287b4e2009-04-25 21:04:17 +0000535 unsigned KeyLen = ReadUnalignedLE16(d);
Douglas Gregora868bbd2009-04-21 22:25:48 +0000536 return std::make_pair(KeyLen, DataLen);
537 }
Mike Stump11289f42009-09-09 15:08:12 +0000538
Douglas Gregora868bbd2009-04-21 22:25:48 +0000539 static std::pair<const char*, unsigned>
540 ReadKey(const unsigned char* d, unsigned n) {
541 assert(n >= 2 && d[n-1] == '\0');
542 return std::make_pair((const char*) d, n-1);
543 }
Mike Stump11289f42009-09-09 15:08:12 +0000544
545 IdentifierInfo *ReadData(const internal_key_type& k,
Douglas Gregora868bbd2009-04-21 22:25:48 +0000546 const unsigned char* d,
547 unsigned DataLen) {
548 using namespace clang::io;
Douglas Gregor1d583f22009-04-28 21:18:29 +0000549 pch::IdentID ID = ReadUnalignedLE32(d);
550 bool IsInteresting = ID & 0x01;
551
552 // Wipe out the "is interesting" bit.
553 ID = ID >> 1;
554
555 if (!IsInteresting) {
556 // For unintersting identifiers, just build the IdentifierInfo
557 // and associate it with the persistent ID.
558 IdentifierInfo *II = KnownII;
559 if (!II)
560 II = &Reader.getIdentifierTable().CreateIdentifierInfo(
561 k.first, k.first + k.second);
562 Reader.SetIdentifierInfo(ID, II);
563 return II;
564 }
565
Douglas Gregorb9256522009-04-28 21:32:13 +0000566 unsigned Bits = ReadUnalignedLE16(d);
Douglas Gregor4621c6a2009-04-22 18:49:13 +0000567 bool CPlusPlusOperatorKeyword = Bits & 0x01;
568 Bits >>= 1;
569 bool Poisoned = Bits & 0x01;
570 Bits >>= 1;
571 bool ExtensionToken = Bits & 0x01;
572 Bits >>= 1;
573 bool hasMacroDefinition = Bits & 0x01;
574 Bits >>= 1;
575 unsigned ObjCOrBuiltinID = Bits & 0x3FF;
576 Bits >>= 10;
Mike Stump11289f42009-09-09 15:08:12 +0000577
Douglas Gregor4621c6a2009-04-22 18:49:13 +0000578 assert(Bits == 0 && "Extra bits in the identifier?");
Douglas Gregorb9256522009-04-28 21:32:13 +0000579 DataLen -= 6;
Douglas Gregora868bbd2009-04-21 22:25:48 +0000580
581 // Build the IdentifierInfo itself and link the identifier ID with
582 // the new IdentifierInfo.
583 IdentifierInfo *II = KnownII;
584 if (!II)
Douglas Gregor6b7bf5a2009-04-25 20:26:24 +0000585 II = &Reader.getIdentifierTable().CreateIdentifierInfo(
586 k.first, k.first + k.second);
Douglas Gregora868bbd2009-04-21 22:25:48 +0000587 Reader.SetIdentifierInfo(ID, II);
588
Douglas Gregor4621c6a2009-04-22 18:49:13 +0000589 // Set or check the various bits in the IdentifierInfo structure.
590 // FIXME: Load token IDs lazily, too?
Douglas Gregor4621c6a2009-04-22 18:49:13 +0000591 II->setObjCOrBuiltinID(ObjCOrBuiltinID);
Mike Stump11289f42009-09-09 15:08:12 +0000592 assert(II->isExtensionToken() == ExtensionToken &&
Douglas Gregor4621c6a2009-04-22 18:49:13 +0000593 "Incorrect extension token flag");
594 (void)ExtensionToken;
595 II->setIsPoisoned(Poisoned);
596 assert(II->isCPlusPlusOperatorKeyword() == CPlusPlusOperatorKeyword &&
597 "Incorrect C++ operator keyword flag");
598 (void)CPlusPlusOperatorKeyword;
599
Douglas Gregorc3366a52009-04-21 23:56:24 +0000600 // If this identifier is a macro, deserialize the macro
601 // definition.
602 if (hasMacroDefinition) {
Douglas Gregorb9256522009-04-28 21:32:13 +0000603 uint32_t Offset = ReadUnalignedLE32(d);
Douglas Gregorc3366a52009-04-21 23:56:24 +0000604 Reader.ReadMacroRecord(Offset);
Douglas Gregorb9256522009-04-28 21:32:13 +0000605 DataLen -= 4;
Douglas Gregorc3366a52009-04-21 23:56:24 +0000606 }
Douglas Gregora868bbd2009-04-21 22:25:48 +0000607
608 // Read all of the declarations visible at global scope with this
609 // name.
Chris Lattner1d728882009-04-27 22:17:41 +0000610 if (Reader.getContext() == 0) return II;
Douglas Gregor1342e842009-07-06 18:54:52 +0000611 if (DataLen > 0) {
612 llvm::SmallVector<uint32_t, 4> DeclIDs;
613 for (; DataLen > 0; DataLen -= 4)
614 DeclIDs.push_back(ReadUnalignedLE32(d));
615 Reader.SetGloballyVisibleDecls(II, DeclIDs);
Douglas Gregora868bbd2009-04-21 22:25:48 +0000616 }
Mike Stump11289f42009-09-09 15:08:12 +0000617
Douglas Gregora868bbd2009-04-21 22:25:48 +0000618 return II;
619 }
620};
Mike Stump11289f42009-09-09 15:08:12 +0000621
622} // end anonymous namespace
Douglas Gregora868bbd2009-04-21 22:25:48 +0000623
624/// \brief The on-disk hash table used to contain information about
625/// all of the identifiers in the program.
Mike Stump11289f42009-09-09 15:08:12 +0000626typedef OnDiskChainedHashTable<PCHIdentifierLookupTrait>
Douglas Gregora868bbd2009-04-21 22:25:48 +0000627 PCHIdentifierLookupTable;
628
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000629bool PCHReader::Error(const char *Msg) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000630 unsigned DiagID = Diags.getCustomDiagID(Diagnostic::Fatal, Msg);
631 Diag(DiagID);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000632 return true;
633}
634
Douglas Gregor92863e42009-04-10 23:10:45 +0000635/// \brief Check the contents of the predefines buffer against the
636/// contents of the predefines buffer used to build the PCH file.
637///
638/// The contents of the two predefines buffers should be the same. If
639/// not, then some command-line option changed the preprocessor state
640/// and we must reject the PCH file.
641///
642/// \param PCHPredef The start of the predefines buffer in the PCH
643/// file.
644///
645/// \param PCHPredefLen The length of the predefines buffer in the PCH
646/// file.
647///
648/// \param PCHBufferID The FileID for the PCH predefines buffer.
649///
650/// \returns true if there was a mismatch (in which case the PCH file
651/// should be ignored), or false otherwise.
Mike Stump11289f42009-09-09 15:08:12 +0000652bool PCHReader::CheckPredefinesBuffer(const char *PCHPredef,
Douglas Gregor92863e42009-04-10 23:10:45 +0000653 unsigned PCHPredefLen,
654 FileID PCHBufferID) {
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000655 if (Listener)
656 return Listener->ReadPredefinesBuffer(PCHPredef, PCHPredefLen, PCHBufferID,
657 SuggestedPredefines);
Douglas Gregorc379c072009-04-28 18:58:38 +0000658 return false;
Douglas Gregor92863e42009-04-10 23:10:45 +0000659}
660
Douglas Gregorc5046832009-04-27 18:38:38 +0000661//===----------------------------------------------------------------------===//
662// Source Manager Deserialization
663//===----------------------------------------------------------------------===//
664
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000665/// \brief Read the line table in the source manager block.
666/// \returns true if ther was an error.
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000667bool PCHReader::ParseLineTable(llvm::SmallVectorImpl<uint64_t> &Record) {
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000668 unsigned Idx = 0;
669 LineTableInfo &LineTable = SourceMgr.getLineTable();
670
671 // Parse the file names
Douglas Gregora8854652009-04-13 17:12:42 +0000672 std::map<int, int> FileIDs;
673 for (int I = 0, N = Record[Idx++]; I != N; ++I) {
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000674 // Extract the file name
675 unsigned FilenameLen = Record[Idx++];
676 std::string Filename(&Record[Idx], &Record[Idx] + FilenameLen);
677 Idx += FilenameLen;
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000678 MaybeAddSystemRootToFilename(Filename);
Mike Stump11289f42009-09-09 15:08:12 +0000679 FileIDs[I] = LineTable.getLineTableFilenameID(Filename.c_str(),
Douglas Gregora8854652009-04-13 17:12:42 +0000680 Filename.size());
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000681 }
682
683 // Parse the line entries
684 std::vector<LineEntry> Entries;
685 while (Idx < Record.size()) {
Douglas Gregora8854652009-04-13 17:12:42 +0000686 int FID = FileIDs[Record[Idx++]];
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000687
688 // Extract the line entries
689 unsigned NumEntries = Record[Idx++];
690 Entries.clear();
691 Entries.reserve(NumEntries);
692 for (unsigned I = 0; I != NumEntries; ++I) {
693 unsigned FileOffset = Record[Idx++];
694 unsigned LineNo = Record[Idx++];
695 int FilenameID = Record[Idx++];
Mike Stump11289f42009-09-09 15:08:12 +0000696 SrcMgr::CharacteristicKind FileKind
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000697 = (SrcMgr::CharacteristicKind)Record[Idx++];
698 unsigned IncludeOffset = Record[Idx++];
699 Entries.push_back(LineEntry::get(FileOffset, LineNo, FilenameID,
700 FileKind, IncludeOffset));
701 }
702 LineTable.AddEntry(FID, Entries);
703 }
704
705 return false;
706}
707
Douglas Gregorc5046832009-04-27 18:38:38 +0000708namespace {
709
710class VISIBILITY_HIDDEN PCHStatData {
711public:
712 const bool hasStat;
713 const ino_t ino;
714 const dev_t dev;
715 const mode_t mode;
716 const time_t mtime;
717 const off_t size;
Mike Stump11289f42009-09-09 15:08:12 +0000718
Douglas Gregorc5046832009-04-27 18:38:38 +0000719 PCHStatData(ino_t i, dev_t d, mode_t mo, time_t m, off_t s)
Mike Stump11289f42009-09-09 15:08:12 +0000720 : hasStat(true), ino(i), dev(d), mode(mo), mtime(m), size(s) {}
721
Douglas Gregorc5046832009-04-27 18:38:38 +0000722 PCHStatData()
723 : hasStat(false), ino(0), dev(0), mode(0), mtime(0), size(0) {}
724};
725
726class VISIBILITY_HIDDEN PCHStatLookupTrait {
727 public:
728 typedef const char *external_key_type;
729 typedef const char *internal_key_type;
730
731 typedef PCHStatData data_type;
732
733 static unsigned ComputeHash(const char *path) {
734 return BernsteinHash(path);
735 }
736
737 static internal_key_type GetInternalKey(const char *path) { return path; }
738
739 static bool EqualKey(internal_key_type a, internal_key_type b) {
740 return strcmp(a, b) == 0;
741 }
742
743 static std::pair<unsigned, unsigned>
744 ReadKeyDataLength(const unsigned char*& d) {
745 unsigned KeyLen = (unsigned) clang::io::ReadUnalignedLE16(d);
746 unsigned DataLen = (unsigned) *d++;
747 return std::make_pair(KeyLen + 1, DataLen);
748 }
749
750 static internal_key_type ReadKey(const unsigned char *d, unsigned) {
751 return (const char *)d;
752 }
753
754 static data_type ReadData(const internal_key_type, const unsigned char *d,
755 unsigned /*DataLen*/) {
756 using namespace clang::io;
757
758 if (*d++ == 1)
759 return data_type();
760
761 ino_t ino = (ino_t) ReadUnalignedLE32(d);
762 dev_t dev = (dev_t) ReadUnalignedLE32(d);
763 mode_t mode = (mode_t) ReadUnalignedLE16(d);
Mike Stump11289f42009-09-09 15:08:12 +0000764 time_t mtime = (time_t) ReadUnalignedLE64(d);
Douglas Gregorc5046832009-04-27 18:38:38 +0000765 off_t size = (off_t) ReadUnalignedLE64(d);
766 return data_type(ino, dev, mode, mtime, size);
767 }
768};
769
770/// \brief stat() cache for precompiled headers.
771///
772/// This cache is very similar to the stat cache used by pretokenized
773/// headers.
774class VISIBILITY_HIDDEN PCHStatCache : public StatSysCallCache {
775 typedef OnDiskChainedHashTable<PCHStatLookupTrait> CacheTy;
776 CacheTy *Cache;
777
778 unsigned &NumStatHits, &NumStatMisses;
Mike Stump11289f42009-09-09 15:08:12 +0000779public:
Douglas Gregorc5046832009-04-27 18:38:38 +0000780 PCHStatCache(const unsigned char *Buckets,
781 const unsigned char *Base,
782 unsigned &NumStatHits,
Mike Stump11289f42009-09-09 15:08:12 +0000783 unsigned &NumStatMisses)
Douglas Gregorc5046832009-04-27 18:38:38 +0000784 : Cache(0), NumStatHits(NumStatHits), NumStatMisses(NumStatMisses) {
785 Cache = CacheTy::Create(Buckets, Base);
786 }
787
788 ~PCHStatCache() { delete Cache; }
Mike Stump11289f42009-09-09 15:08:12 +0000789
Douglas Gregorc5046832009-04-27 18:38:38 +0000790 int stat(const char *path, struct stat *buf) {
791 // Do the lookup for the file's data in the PCH file.
792 CacheTy::iterator I = Cache->find(path);
793
794 // If we don't get a hit in the PCH file just forward to 'stat'.
795 if (I == Cache->end()) {
796 ++NumStatMisses;
797 return ::stat(path, buf);
798 }
Mike Stump11289f42009-09-09 15:08:12 +0000799
Douglas Gregorc5046832009-04-27 18:38:38 +0000800 ++NumStatHits;
801 PCHStatData Data = *I;
Mike Stump11289f42009-09-09 15:08:12 +0000802
Douglas Gregorc5046832009-04-27 18:38:38 +0000803 if (!Data.hasStat)
804 return 1;
805
806 buf->st_ino = Data.ino;
807 buf->st_dev = Data.dev;
808 buf->st_mtime = Data.mtime;
809 buf->st_mode = Data.mode;
810 buf->st_size = Data.size;
811 return 0;
812 }
813};
814} // end anonymous namespace
815
816
Douglas Gregora7f71a92009-04-10 03:52:48 +0000817/// \brief Read the source manager block
Douglas Gregor92863e42009-04-10 23:10:45 +0000818PCHReader::PCHReadResult PCHReader::ReadSourceManagerBlock() {
Douglas Gregora7f71a92009-04-10 03:52:48 +0000819 using namespace SrcMgr;
Douglas Gregor258ae542009-04-27 06:38:32 +0000820
821 // Set the source-location entry cursor to the current position in
822 // the stream. This cursor will be used to read the contents of the
823 // source manager block initially, and then lazily read
824 // source-location entries as needed.
825 SLocEntryCursor = Stream;
826
827 // The stream itself is going to skip over the source manager block.
828 if (Stream.SkipBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000829 Error("malformed block record in PCH file");
Douglas Gregor258ae542009-04-27 06:38:32 +0000830 return Failure;
831 }
832
833 // Enter the source manager block.
834 if (SLocEntryCursor.EnterSubBlock(pch::SOURCE_MANAGER_BLOCK_ID)) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000835 Error("malformed source manager block record in PCH file");
Douglas Gregor92863e42009-04-10 23:10:45 +0000836 return Failure;
837 }
Douglas Gregora7f71a92009-04-10 03:52:48 +0000838
Douglas Gregora7f71a92009-04-10 03:52:48 +0000839 RecordData Record;
840 while (true) {
Douglas Gregor258ae542009-04-27 06:38:32 +0000841 unsigned Code = SLocEntryCursor.ReadCode();
Douglas Gregora7f71a92009-04-10 03:52:48 +0000842 if (Code == llvm::bitc::END_BLOCK) {
Douglas Gregor258ae542009-04-27 06:38:32 +0000843 if (SLocEntryCursor.ReadBlockEnd()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000844 Error("error at end of Source Manager block in PCH file");
Douglas Gregor92863e42009-04-10 23:10:45 +0000845 return Failure;
846 }
Douglas Gregor92863e42009-04-10 23:10:45 +0000847 return Success;
Douglas Gregora7f71a92009-04-10 03:52:48 +0000848 }
Mike Stump11289f42009-09-09 15:08:12 +0000849
Douglas Gregora7f71a92009-04-10 03:52:48 +0000850 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
851 // No known subblocks, always skip them.
Douglas Gregor258ae542009-04-27 06:38:32 +0000852 SLocEntryCursor.ReadSubBlockID();
853 if (SLocEntryCursor.SkipBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000854 Error("malformed block record in PCH file");
Douglas Gregor92863e42009-04-10 23:10:45 +0000855 return Failure;
856 }
Douglas Gregora7f71a92009-04-10 03:52:48 +0000857 continue;
858 }
Mike Stump11289f42009-09-09 15:08:12 +0000859
Douglas Gregora7f71a92009-04-10 03:52:48 +0000860 if (Code == llvm::bitc::DEFINE_ABBREV) {
Douglas Gregor258ae542009-04-27 06:38:32 +0000861 SLocEntryCursor.ReadAbbrevRecord();
Douglas Gregora7f71a92009-04-10 03:52:48 +0000862 continue;
863 }
Mike Stump11289f42009-09-09 15:08:12 +0000864
Douglas Gregora7f71a92009-04-10 03:52:48 +0000865 // Read a record.
866 const char *BlobStart;
867 unsigned BlobLen;
868 Record.clear();
Douglas Gregor258ae542009-04-27 06:38:32 +0000869 switch (SLocEntryCursor.ReadRecord(Code, Record, &BlobStart, &BlobLen)) {
Douglas Gregora7f71a92009-04-10 03:52:48 +0000870 default: // Default behavior: ignore.
871 break;
872
Chris Lattner184e65d2009-04-14 23:22:57 +0000873 case pch::SM_LINE_TABLE:
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000874 if (ParseLineTable(Record))
Douglas Gregor4c7626e2009-04-13 16:31:14 +0000875 return Failure;
Chris Lattner184e65d2009-04-14 23:22:57 +0000876 break;
Douglas Gregoreda6a892009-04-26 00:07:37 +0000877
878 case pch::SM_HEADER_FILE_INFO: {
879 HeaderFileInfo HFI;
880 HFI.isImport = Record[0];
881 HFI.DirInfo = Record[1];
882 HFI.NumIncludes = Record[2];
883 HFI.ControllingMacroID = Record[3];
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +0000884 if (Listener)
885 Listener->ReadHeaderFileInfo(HFI);
Douglas Gregoreda6a892009-04-26 00:07:37 +0000886 break;
887 }
Douglas Gregor258ae542009-04-27 06:38:32 +0000888
889 case pch::SM_SLOC_FILE_ENTRY:
890 case pch::SM_SLOC_BUFFER_ENTRY:
891 case pch::SM_SLOC_INSTANTIATION_ENTRY:
892 // Once we hit one of the source location entries, we're done.
893 return Success;
Douglas Gregora7f71a92009-04-10 03:52:48 +0000894 }
895 }
896}
897
Douglas Gregor258ae542009-04-27 06:38:32 +0000898/// \brief Read in the source location entry with the given ID.
899PCHReader::PCHReadResult PCHReader::ReadSLocEntryRecord(unsigned ID) {
900 if (ID == 0)
901 return Success;
902
903 if (ID > TotalNumSLocEntries) {
904 Error("source location entry ID out-of-range for PCH file");
905 return Failure;
906 }
907
908 ++NumSLocEntriesRead;
909 SLocEntryCursor.JumpToBit(SLocOffsets[ID - 1]);
910 unsigned Code = SLocEntryCursor.ReadCode();
911 if (Code == llvm::bitc::END_BLOCK ||
912 Code == llvm::bitc::ENTER_SUBBLOCK ||
913 Code == llvm::bitc::DEFINE_ABBREV) {
914 Error("incorrectly-formatted source location entry in PCH file");
915 return Failure;
916 }
917
Douglas Gregor258ae542009-04-27 06:38:32 +0000918 RecordData Record;
919 const char *BlobStart;
920 unsigned BlobLen;
921 switch (SLocEntryCursor.ReadRecord(Code, Record, &BlobStart, &BlobLen)) {
922 default:
923 Error("incorrectly-formatted source location entry in PCH file");
924 return Failure;
925
926 case pch::SM_SLOC_FILE_ENTRY: {
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000927 std::string Filename(BlobStart, BlobStart + BlobLen);
928 MaybeAddSystemRootToFilename(Filename);
929 const FileEntry *File = FileMgr.getFile(Filename);
Chris Lattnerd20dc872009-06-15 04:35:16 +0000930 if (File == 0) {
931 std::string ErrorStr = "could not find file '";
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000932 ErrorStr += Filename;
Chris Lattnerd20dc872009-06-15 04:35:16 +0000933 ErrorStr += "' referenced by PCH file";
934 Error(ErrorStr.c_str());
935 return Failure;
936 }
Mike Stump11289f42009-09-09 15:08:12 +0000937
Douglas Gregor258ae542009-04-27 06:38:32 +0000938 FileID FID = SourceMgr.createFileID(File,
939 SourceLocation::getFromRawEncoding(Record[1]),
940 (SrcMgr::CharacteristicKind)Record[2],
941 ID, Record[0]);
942 if (Record[3])
943 const_cast<SrcMgr::FileInfo&>(SourceMgr.getSLocEntry(FID).getFile())
944 .setHasLineDirectives();
945
946 break;
947 }
948
949 case pch::SM_SLOC_BUFFER_ENTRY: {
950 const char *Name = BlobStart;
951 unsigned Offset = Record[0];
952 unsigned Code = SLocEntryCursor.ReadCode();
953 Record.clear();
Mike Stump11289f42009-09-09 15:08:12 +0000954 unsigned RecCode
Douglas Gregor258ae542009-04-27 06:38:32 +0000955 = SLocEntryCursor.ReadRecord(Code, Record, &BlobStart, &BlobLen);
956 assert(RecCode == pch::SM_SLOC_BUFFER_BLOB && "Ill-formed PCH file");
957 (void)RecCode;
958 llvm::MemoryBuffer *Buffer
Mike Stump11289f42009-09-09 15:08:12 +0000959 = llvm::MemoryBuffer::getMemBuffer(BlobStart,
Douglas Gregor258ae542009-04-27 06:38:32 +0000960 BlobStart + BlobLen - 1,
961 Name);
962 FileID BufferID = SourceMgr.createFileIDForMemBuffer(Buffer, ID, Offset);
Mike Stump11289f42009-09-09 15:08:12 +0000963
Douglas Gregore6648fb2009-04-28 20:33:11 +0000964 if (strcmp(Name, "<built-in>") == 0) {
965 PCHPredefinesBufferID = BufferID;
966 PCHPredefines = BlobStart;
967 PCHPredefinesLen = BlobLen - 1;
968 }
Douglas Gregor258ae542009-04-27 06:38:32 +0000969
970 break;
971 }
972
973 case pch::SM_SLOC_INSTANTIATION_ENTRY: {
Mike Stump11289f42009-09-09 15:08:12 +0000974 SourceLocation SpellingLoc
Douglas Gregor258ae542009-04-27 06:38:32 +0000975 = SourceLocation::getFromRawEncoding(Record[1]);
976 SourceMgr.createInstantiationLoc(SpellingLoc,
977 SourceLocation::getFromRawEncoding(Record[2]),
978 SourceLocation::getFromRawEncoding(Record[3]),
979 Record[4],
980 ID,
981 Record[0]);
982 break;
Mike Stump11289f42009-09-09 15:08:12 +0000983 }
Douglas Gregor258ae542009-04-27 06:38:32 +0000984 }
985
986 return Success;
987}
988
Chris Lattnere78a6be2009-04-27 01:05:14 +0000989/// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
990/// specified cursor. Read the abbreviations that are at the top of the block
991/// and then leave the cursor pointing into the block.
992bool PCHReader::ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor,
993 unsigned BlockID) {
994 if (Cursor.EnterSubBlock(BlockID)) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +0000995 Error("malformed block record in PCH file");
Chris Lattnere78a6be2009-04-27 01:05:14 +0000996 return Failure;
997 }
Mike Stump11289f42009-09-09 15:08:12 +0000998
Chris Lattnere78a6be2009-04-27 01:05:14 +0000999 while (true) {
1000 unsigned Code = Cursor.ReadCode();
Mike Stump11289f42009-09-09 15:08:12 +00001001
Chris Lattnere78a6be2009-04-27 01:05:14 +00001002 // We expect all abbrevs to be at the start of the block.
1003 if (Code != llvm::bitc::DEFINE_ABBREV)
1004 return false;
1005 Cursor.ReadAbbrevRecord();
1006 }
1007}
1008
Douglas Gregorc3366a52009-04-21 23:56:24 +00001009void PCHReader::ReadMacroRecord(uint64_t Offset) {
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001010 assert(PP && "Forgot to set Preprocessor ?");
Mike Stump11289f42009-09-09 15:08:12 +00001011
Douglas Gregorc3366a52009-04-21 23:56:24 +00001012 // Keep track of where we are in the stream, then jump back there
1013 // after reading this macro.
1014 SavedStreamPosition SavedPosition(Stream);
1015
1016 Stream.JumpToBit(Offset);
1017 RecordData Record;
1018 llvm::SmallVector<IdentifierInfo*, 16> MacroArgs;
1019 MacroInfo *Macro = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001020
Douglas Gregorc3366a52009-04-21 23:56:24 +00001021 while (true) {
1022 unsigned Code = Stream.ReadCode();
1023 switch (Code) {
1024 case llvm::bitc::END_BLOCK:
1025 return;
1026
1027 case llvm::bitc::ENTER_SUBBLOCK:
1028 // No known subblocks, always skip them.
1029 Stream.ReadSubBlockID();
1030 if (Stream.SkipBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001031 Error("malformed block record in PCH file");
Douglas Gregorc3366a52009-04-21 23:56:24 +00001032 return;
1033 }
1034 continue;
Mike Stump11289f42009-09-09 15:08:12 +00001035
Douglas Gregorc3366a52009-04-21 23:56:24 +00001036 case llvm::bitc::DEFINE_ABBREV:
1037 Stream.ReadAbbrevRecord();
1038 continue;
1039 default: break;
1040 }
1041
1042 // Read a record.
1043 Record.clear();
1044 pch::PreprocessorRecordTypes RecType =
1045 (pch::PreprocessorRecordTypes)Stream.ReadRecord(Code, Record);
1046 switch (RecType) {
Douglas Gregorc3366a52009-04-21 23:56:24 +00001047 case pch::PP_MACRO_OBJECT_LIKE:
1048 case pch::PP_MACRO_FUNCTION_LIKE: {
1049 // If we already have a macro, that means that we've hit the end
1050 // of the definition of the macro we were looking for. We're
1051 // done.
1052 if (Macro)
1053 return;
1054
1055 IdentifierInfo *II = DecodeIdentifierInfo(Record[0]);
1056 if (II == 0) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001057 Error("macro must have a name in PCH file");
Douglas Gregorc3366a52009-04-21 23:56:24 +00001058 return;
1059 }
1060 SourceLocation Loc = SourceLocation::getFromRawEncoding(Record[1]);
1061 bool isUsed = Record[2];
Mike Stump11289f42009-09-09 15:08:12 +00001062
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001063 MacroInfo *MI = PP->AllocateMacroInfo(Loc);
Douglas Gregorc3366a52009-04-21 23:56:24 +00001064 MI->setIsUsed(isUsed);
Mike Stump11289f42009-09-09 15:08:12 +00001065
Douglas Gregorc3366a52009-04-21 23:56:24 +00001066 if (RecType == pch::PP_MACRO_FUNCTION_LIKE) {
1067 // Decode function-like macro info.
1068 bool isC99VarArgs = Record[3];
1069 bool isGNUVarArgs = Record[4];
1070 MacroArgs.clear();
1071 unsigned NumArgs = Record[5];
1072 for (unsigned i = 0; i != NumArgs; ++i)
1073 MacroArgs.push_back(DecodeIdentifierInfo(Record[6+i]));
1074
1075 // Install function-like macro info.
1076 MI->setIsFunctionLike();
1077 if (isC99VarArgs) MI->setIsC99Varargs();
1078 if (isGNUVarArgs) MI->setIsGNUVarargs();
Douglas Gregor038c3382009-05-22 22:45:36 +00001079 MI->setArgumentList(MacroArgs.data(), MacroArgs.size(),
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001080 PP->getPreprocessorAllocator());
Douglas Gregorc3366a52009-04-21 23:56:24 +00001081 }
1082
1083 // Finally, install the macro.
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001084 PP->setMacroInfo(II, MI);
Douglas Gregorc3366a52009-04-21 23:56:24 +00001085
1086 // Remember that we saw this macro last so that we add the tokens that
1087 // form its body to it.
1088 Macro = MI;
1089 ++NumMacrosRead;
1090 break;
1091 }
Mike Stump11289f42009-09-09 15:08:12 +00001092
Douglas Gregorc3366a52009-04-21 23:56:24 +00001093 case pch::PP_TOKEN: {
1094 // If we see a TOKEN before a PP_MACRO_*, then the file is
1095 // erroneous, just pretend we didn't see this.
1096 if (Macro == 0) break;
Mike Stump11289f42009-09-09 15:08:12 +00001097
Douglas Gregorc3366a52009-04-21 23:56:24 +00001098 Token Tok;
1099 Tok.startToken();
1100 Tok.setLocation(SourceLocation::getFromRawEncoding(Record[0]));
1101 Tok.setLength(Record[1]);
1102 if (IdentifierInfo *II = DecodeIdentifierInfo(Record[2]))
1103 Tok.setIdentifierInfo(II);
1104 Tok.setKind((tok::TokenKind)Record[3]);
1105 Tok.setFlag((Token::TokenFlags)Record[4]);
1106 Macro->AddTokenToBody(Tok);
1107 break;
1108 }
Steve Naroff3fa455a2009-04-24 20:03:17 +00001109 }
Douglas Gregorc3366a52009-04-21 23:56:24 +00001110 }
1111}
1112
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001113/// \brief If we are loading a relocatable PCH file, and the filename is
1114/// not an absolute path, add the system root to the beginning of the file
1115/// name.
1116void PCHReader::MaybeAddSystemRootToFilename(std::string &Filename) {
1117 // If this is not a relocatable PCH file, there's nothing to do.
1118 if (!RelocatablePCH)
1119 return;
Mike Stump11289f42009-09-09 15:08:12 +00001120
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001121 if (Filename.empty() || Filename[0] == '/' || Filename[0] == '<')
1122 return;
1123
1124 std::string FIXME = Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001125
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001126 if (isysroot == 0) {
1127 // If no system root was given, default to '/'
1128 Filename.insert(Filename.begin(), '/');
1129 return;
1130 }
Mike Stump11289f42009-09-09 15:08:12 +00001131
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001132 unsigned Length = strlen(isysroot);
1133 if (isysroot[Length - 1] != '/')
1134 Filename.insert(Filename.begin(), '/');
Mike Stump11289f42009-09-09 15:08:12 +00001135
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001136 Filename.insert(Filename.begin(), isysroot, isysroot + Length);
1137}
1138
Mike Stump11289f42009-09-09 15:08:12 +00001139PCHReader::PCHReadResult
Douglas Gregoreda6a892009-04-26 00:07:37 +00001140PCHReader::ReadPCHBlock() {
Douglas Gregor55abb232009-04-10 20:39:37 +00001141 if (Stream.EnterSubBlock(pch::PCH_BLOCK_ID)) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001142 Error("malformed block record in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001143 return Failure;
1144 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001145
1146 // Read all of the records and blocks for the PCH file.
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001147 RecordData Record;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001148 while (!Stream.AtEndOfStream()) {
1149 unsigned Code = Stream.ReadCode();
1150 if (Code == llvm::bitc::END_BLOCK) {
Douglas Gregor55abb232009-04-10 20:39:37 +00001151 if (Stream.ReadBlockEnd()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001152 Error("error at end of module block in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001153 return Failure;
1154 }
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001155
Douglas Gregor55abb232009-04-10 20:39:37 +00001156 return Success;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001157 }
1158
1159 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
1160 switch (Stream.ReadSubBlockID()) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001161 case pch::TYPES_BLOCK_ID: // Skip types block (lazily loaded)
1162 default: // Skip unknown content.
Douglas Gregor55abb232009-04-10 20:39:37 +00001163 if (Stream.SkipBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001164 Error("malformed block record in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001165 return Failure;
1166 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001167 break;
1168
Chris Lattnere78a6be2009-04-27 01:05:14 +00001169 case pch::DECLS_BLOCK_ID:
1170 // We lazily load the decls block, but we want to set up the
1171 // DeclsCursor cursor to point into it. Clone our current bitcode
1172 // cursor to it, enter the block and read the abbrevs in that block.
1173 // With the main cursor, we just skip over it.
1174 DeclsCursor = Stream;
1175 if (Stream.SkipBlock() || // Skip with the main cursor.
1176 // Read the abbrevs.
1177 ReadBlockAbbrevs(DeclsCursor, pch::DECLS_BLOCK_ID)) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001178 Error("malformed block record in PCH file");
Chris Lattnere78a6be2009-04-27 01:05:14 +00001179 return Failure;
1180 }
1181 break;
Mike Stump11289f42009-09-09 15:08:12 +00001182
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001183 case pch::PREPROCESSOR_BLOCK_ID:
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001184 if (Stream.SkipBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001185 Error("malformed block record in PCH file");
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001186 return Failure;
1187 }
1188 break;
Steve Naroff2ddea052009-04-23 10:39:46 +00001189
Douglas Gregora7f71a92009-04-10 03:52:48 +00001190 case pch::SOURCE_MANAGER_BLOCK_ID:
Douglas Gregor92863e42009-04-10 23:10:45 +00001191 switch (ReadSourceManagerBlock()) {
1192 case Success:
1193 break;
1194
1195 case Failure:
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001196 Error("malformed source manager block in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001197 return Failure;
Douglas Gregor92863e42009-04-10 23:10:45 +00001198
1199 case IgnorePCH:
1200 return IgnorePCH;
Douglas Gregor55abb232009-04-10 20:39:37 +00001201 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00001202 break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001203 }
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001204 continue;
1205 }
1206
1207 if (Code == llvm::bitc::DEFINE_ABBREV) {
1208 Stream.ReadAbbrevRecord();
1209 continue;
1210 }
1211
1212 // Read and process a record.
1213 Record.clear();
Douglas Gregorbfbde532009-04-10 21:16:55 +00001214 const char *BlobStart = 0;
1215 unsigned BlobLen = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001216 switch ((pch::PCHRecordTypes)Stream.ReadRecord(Code, Record,
Douglas Gregorbfbde532009-04-10 21:16:55 +00001217 &BlobStart, &BlobLen)) {
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001218 default: // Default behavior: ignore.
1219 break;
1220
1221 case pch::TYPE_OFFSET:
Douglas Gregor745ed142009-04-25 18:35:21 +00001222 if (!TypesLoaded.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001223 Error("duplicate TYPE_OFFSET record in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001224 return Failure;
1225 }
Chris Lattnereeb05692009-04-27 18:24:17 +00001226 TypeOffsets = (const uint32_t *)BlobStart;
Douglas Gregor745ed142009-04-25 18:35:21 +00001227 TypesLoaded.resize(Record[0]);
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001228 break;
1229
1230 case pch::DECL_OFFSET:
Douglas Gregor745ed142009-04-25 18:35:21 +00001231 if (!DeclsLoaded.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001232 Error("duplicate DECL_OFFSET record in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001233 return Failure;
1234 }
Chris Lattnereeb05692009-04-27 18:24:17 +00001235 DeclOffsets = (const uint32_t *)BlobStart;
Douglas Gregor745ed142009-04-25 18:35:21 +00001236 DeclsLoaded.resize(Record[0]);
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001237 break;
Douglas Gregor55abb232009-04-10 20:39:37 +00001238
1239 case pch::LANGUAGE_OPTIONS:
1240 if (ParseLanguageOptions(Record))
1241 return IgnorePCH;
1242 break;
Douglas Gregorbfbde532009-04-10 21:16:55 +00001243
Douglas Gregor7b71e632009-04-27 22:23:34 +00001244 case pch::METADATA: {
1245 if (Record[0] != pch::VERSION_MAJOR) {
1246 Diag(Record[0] < pch::VERSION_MAJOR? diag::warn_pch_version_too_old
1247 : diag::warn_pch_version_too_new);
1248 return IgnorePCH;
1249 }
1250
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001251 RelocatablePCH = Record[4];
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001252 if (Listener) {
1253 std::string TargetTriple(BlobStart, BlobLen);
1254 if (Listener->ReadTargetTriple(TargetTriple))
1255 return IgnorePCH;
Douglas Gregorbfbde532009-04-10 21:16:55 +00001256 }
1257 break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001258 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001259
1260 case pch::IDENTIFIER_TABLE:
Douglas Gregora868bbd2009-04-21 22:25:48 +00001261 IdentifierTableData = BlobStart;
Douglas Gregor0e149972009-04-25 19:10:14 +00001262 if (Record[0]) {
Mike Stump11289f42009-09-09 15:08:12 +00001263 IdentifierLookupTable
Douglas Gregor0e149972009-04-25 19:10:14 +00001264 = PCHIdentifierLookupTable::Create(
Douglas Gregora868bbd2009-04-21 22:25:48 +00001265 (const unsigned char *)IdentifierTableData + Record[0],
Mike Stump11289f42009-09-09 15:08:12 +00001266 (const unsigned char *)IdentifierTableData,
Douglas Gregora868bbd2009-04-21 22:25:48 +00001267 PCHIdentifierLookupTrait(*this));
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001268 if (PP)
1269 PP->getIdentifierTable().setExternalIdentifierLookup(this);
Douglas Gregor0e149972009-04-25 19:10:14 +00001270 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001271 break;
1272
1273 case pch::IDENTIFIER_OFFSET:
Douglas Gregor0e149972009-04-25 19:10:14 +00001274 if (!IdentifiersLoaded.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001275 Error("duplicate IDENTIFIER_OFFSET record in PCH file");
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001276 return Failure;
1277 }
Douglas Gregor0e149972009-04-25 19:10:14 +00001278 IdentifierOffsets = (const uint32_t *)BlobStart;
1279 IdentifiersLoaded.resize(Record[0]);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001280 if (PP)
1281 PP->getHeaderSearchInfo().SetExternalLookup(this);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001282 break;
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00001283
1284 case pch::EXTERNAL_DEFINITIONS:
1285 if (!ExternalDefinitions.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001286 Error("duplicate EXTERNAL_DEFINITIONS record in PCH file");
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00001287 return Failure;
1288 }
1289 ExternalDefinitions.swap(Record);
1290 break;
Douglas Gregor08f01292009-04-17 22:13:46 +00001291
Douglas Gregor652d82a2009-04-18 05:55:16 +00001292 case pch::SPECIAL_TYPES:
1293 SpecialTypes.swap(Record);
1294 break;
1295
Douglas Gregor08f01292009-04-17 22:13:46 +00001296 case pch::STATISTICS:
1297 TotalNumStatements = Record[0];
Douglas Gregorc3366a52009-04-21 23:56:24 +00001298 TotalNumMacros = Record[1];
Douglas Gregora57c3ab2009-04-22 22:34:57 +00001299 TotalLexicalDeclContexts = Record[2];
1300 TotalVisibleDeclContexts = Record[3];
Douglas Gregor08f01292009-04-17 22:13:46 +00001301 break;
Douglas Gregor258ae542009-04-27 06:38:32 +00001302
Douglas Gregord4df8652009-04-22 22:02:47 +00001303 case pch::TENTATIVE_DEFINITIONS:
1304 if (!TentativeDefinitions.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001305 Error("duplicate TENTATIVE_DEFINITIONS record in PCH file");
Douglas Gregord4df8652009-04-22 22:02:47 +00001306 return Failure;
1307 }
1308 TentativeDefinitions.swap(Record);
1309 break;
Douglas Gregoracfc76c2009-04-22 22:18:58 +00001310
1311 case pch::LOCALLY_SCOPED_EXTERNAL_DECLS:
1312 if (!LocallyScopedExternalDecls.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001313 Error("duplicate LOCALLY_SCOPED_EXTERNAL_DECLS record in PCH file");
Douglas Gregoracfc76c2009-04-22 22:18:58 +00001314 return Failure;
1315 }
1316 LocallyScopedExternalDecls.swap(Record);
1317 break;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001318
Douglas Gregor95c13f52009-04-25 17:48:32 +00001319 case pch::SELECTOR_OFFSETS:
1320 SelectorOffsets = (const uint32_t *)BlobStart;
1321 TotalNumSelectors = Record[0];
1322 SelectorsLoaded.resize(TotalNumSelectors);
1323 break;
1324
Douglas Gregorc78d3462009-04-24 21:10:55 +00001325 case pch::METHOD_POOL:
Douglas Gregor95c13f52009-04-25 17:48:32 +00001326 MethodPoolLookupTableData = (const unsigned char *)BlobStart;
1327 if (Record[0])
Mike Stump11289f42009-09-09 15:08:12 +00001328 MethodPoolLookupTable
Douglas Gregor95c13f52009-04-25 17:48:32 +00001329 = PCHMethodPoolLookupTable::Create(
1330 MethodPoolLookupTableData + Record[0],
Mike Stump11289f42009-09-09 15:08:12 +00001331 MethodPoolLookupTableData,
Douglas Gregorc78d3462009-04-24 21:10:55 +00001332 PCHMethodPoolLookupTrait(*this));
Douglas Gregor95c13f52009-04-25 17:48:32 +00001333 TotalSelectorsInMethodPool = Record[1];
Douglas Gregorc78d3462009-04-24 21:10:55 +00001334 break;
Douglas Gregoreda6a892009-04-26 00:07:37 +00001335
1336 case pch::PP_COUNTER_VALUE:
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001337 if (!Record.empty() && Listener)
1338 Listener->ReadCounter(Record[0]);
Douglas Gregoreda6a892009-04-26 00:07:37 +00001339 break;
Douglas Gregor258ae542009-04-27 06:38:32 +00001340
1341 case pch::SOURCE_LOCATION_OFFSETS:
Chris Lattner12d61d32009-04-27 19:01:47 +00001342 SLocOffsets = (const uint32_t *)BlobStart;
Douglas Gregor258ae542009-04-27 06:38:32 +00001343 TotalNumSLocEntries = Record[0];
Douglas Gregord54f3a12009-10-05 21:07:28 +00001344 SourceMgr.PreallocateSLocEntries(this, TotalNumSLocEntries, Record[1]);
Douglas Gregor258ae542009-04-27 06:38:32 +00001345 break;
1346
1347 case pch::SOURCE_LOCATION_PRELOADS:
1348 for (unsigned I = 0, N = Record.size(); I != N; ++I) {
1349 PCHReadResult Result = ReadSLocEntryRecord(Record[I]);
1350 if (Result != Success)
1351 return Result;
1352 }
1353 break;
Douglas Gregorc5046832009-04-27 18:38:38 +00001354
1355 case pch::STAT_CACHE:
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001356 FileMgr.setStatCache(
Douglas Gregorc5046832009-04-27 18:38:38 +00001357 new PCHStatCache((const unsigned char *)BlobStart + Record[0],
1358 (const unsigned char *)BlobStart,
1359 NumStatHits, NumStatMisses));
1360 break;
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001361
1362 case pch::EXT_VECTOR_DECLS:
1363 if (!ExtVectorDecls.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001364 Error("duplicate EXT_VECTOR_DECLS record in PCH file");
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001365 return Failure;
1366 }
1367 ExtVectorDecls.swap(Record);
1368 break;
1369
Douglas Gregor45fe0362009-05-12 01:31:05 +00001370 case pch::ORIGINAL_FILE_NAME:
1371 OriginalFileName.assign(BlobStart, BlobLen);
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001372 MaybeAddSystemRootToFilename(OriginalFileName);
Douglas Gregor45fe0362009-05-12 01:31:05 +00001373 break;
Mike Stump11289f42009-09-09 15:08:12 +00001374
Douglas Gregorc6d5edd2009-07-02 17:08:52 +00001375 case pch::COMMENT_RANGES:
1376 Comments = (SourceRange *)BlobStart;
1377 NumComments = BlobLen / sizeof(SourceRange);
1378 break;
Douglas Gregord54f3a12009-10-05 21:07:28 +00001379
1380 case pch::SVN_BRANCH_REVISION: {
1381 unsigned CurRevision = getClangSubversionRevision();
1382 if (Record[0] && CurRevision && Record[0] != CurRevision) {
1383 Diag(Record[0] < CurRevision? diag::warn_pch_version_too_old
1384 : diag::warn_pch_version_too_new);
1385 return IgnorePCH;
1386 }
1387
1388 const char *CurBranch = getClangSubversionPath();
1389 if (strncmp(CurBranch, BlobStart, BlobLen)) {
1390 std::string PCHBranch(BlobStart, BlobLen);
1391 Diag(diag::warn_pch_different_branch) << PCHBranch << CurBranch;
1392 return IgnorePCH;
1393 }
1394 break;
1395 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001396 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001397 }
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001398 Error("premature end of bitstream in PCH file");
Douglas Gregor55abb232009-04-10 20:39:37 +00001399 return Failure;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001400}
1401
Douglas Gregor92863e42009-04-10 23:10:45 +00001402PCHReader::PCHReadResult PCHReader::ReadPCH(const std::string &FileName) {
Douglas Gregor55abb232009-04-10 20:39:37 +00001403 // Set the PCH file name.
1404 this->FileName = FileName;
1405
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001406 // Open the PCH file.
Daniel Dunbar2d925eb2009-09-22 05:38:01 +00001407 //
1408 // FIXME: This shouldn't be here, we should just take a raw_ostream.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001409 std::string ErrStr;
Daniel Dunbar2d925eb2009-09-22 05:38:01 +00001410 if (FileName == "-")
1411 Buffer.reset(llvm::MemoryBuffer::getSTDIN());
1412 else
1413 Buffer.reset(llvm::MemoryBuffer::getFile(FileName.c_str(), &ErrStr));
Douglas Gregor92863e42009-04-10 23:10:45 +00001414 if (!Buffer) {
1415 Error(ErrStr.c_str());
1416 return IgnorePCH;
1417 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001418
1419 // Initialize the stream
Mike Stump11289f42009-09-09 15:08:12 +00001420 StreamFile.init((const unsigned char *)Buffer->getBufferStart(),
Chris Lattner9356ace2009-04-26 20:59:20 +00001421 (const unsigned char *)Buffer->getBufferEnd());
1422 Stream.init(StreamFile);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001423
1424 // Sniff for the signature.
1425 if (Stream.Read(8) != 'C' ||
1426 Stream.Read(8) != 'P' ||
1427 Stream.Read(8) != 'C' ||
Douglas Gregor92863e42009-04-10 23:10:45 +00001428 Stream.Read(8) != 'H') {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001429 Diag(diag::err_not_a_pch_file) << FileName;
1430 return Failure;
Douglas Gregor92863e42009-04-10 23:10:45 +00001431 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001432
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001433 while (!Stream.AtEndOfStream()) {
1434 unsigned Code = Stream.ReadCode();
Mike Stump11289f42009-09-09 15:08:12 +00001435
Douglas Gregor92863e42009-04-10 23:10:45 +00001436 if (Code != llvm::bitc::ENTER_SUBBLOCK) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001437 Error("invalid record at top-level of PCH file");
Douglas Gregor92863e42009-04-10 23:10:45 +00001438 return Failure;
1439 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001440
1441 unsigned BlockID = Stream.ReadSubBlockID();
Douglas Gregora868bbd2009-04-21 22:25:48 +00001442
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001443 // We only know the PCH subblock ID.
1444 switch (BlockID) {
1445 case llvm::bitc::BLOCKINFO_BLOCK_ID:
Douglas Gregor92863e42009-04-10 23:10:45 +00001446 if (Stream.ReadBlockInfoBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001447 Error("malformed BlockInfoBlock in PCH file");
Douglas Gregor92863e42009-04-10 23:10:45 +00001448 return Failure;
1449 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001450 break;
1451 case pch::PCH_BLOCK_ID:
Douglas Gregoreda6a892009-04-26 00:07:37 +00001452 switch (ReadPCHBlock()) {
Douglas Gregor55abb232009-04-10 20:39:37 +00001453 case Success:
1454 break;
1455
1456 case Failure:
Douglas Gregor92863e42009-04-10 23:10:45 +00001457 return Failure;
Douglas Gregor55abb232009-04-10 20:39:37 +00001458
1459 case IgnorePCH:
Douglas Gregorbfbde532009-04-10 21:16:55 +00001460 // FIXME: We could consider reading through to the end of this
1461 // PCH block, skipping subblocks, to see if there are other
1462 // PCH blocks elsewhere.
Douglas Gregor0bc12932009-04-27 21:28:04 +00001463
1464 // Clear out any preallocated source location entries, so that
1465 // the source manager does not try to resolve them later.
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001466 SourceMgr.ClearPreallocatedSLocEntries();
Douglas Gregor0bc12932009-04-27 21:28:04 +00001467
1468 // Remove the stat cache.
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001469 FileMgr.setStatCache(0);
Douglas Gregor0bc12932009-04-27 21:28:04 +00001470
Douglas Gregor92863e42009-04-10 23:10:45 +00001471 return IgnorePCH;
Douglas Gregor55abb232009-04-10 20:39:37 +00001472 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001473 break;
1474 default:
Douglas Gregor92863e42009-04-10 23:10:45 +00001475 if (Stream.SkipBlock()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001476 Error("malformed block record in PCH file");
Douglas Gregor92863e42009-04-10 23:10:45 +00001477 return Failure;
1478 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001479 break;
1480 }
Mike Stump11289f42009-09-09 15:08:12 +00001481 }
1482
Douglas Gregore6648fb2009-04-28 20:33:11 +00001483 // Check the predefines buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001484 if (CheckPredefinesBuffer(PCHPredefines, PCHPredefinesLen,
Douglas Gregore6648fb2009-04-28 20:33:11 +00001485 PCHPredefinesBufferID))
1486 return IgnorePCH;
Mike Stump11289f42009-09-09 15:08:12 +00001487
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001488 if (PP) {
Zhongxing Xu3f51f412009-07-18 09:26:51 +00001489 // Initialization of keywords and pragmas occurs before the
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001490 // PCH file is read, so there may be some identifiers that were
1491 // loaded into the IdentifierTable before we intercepted the
1492 // creation of identifiers. Iterate through the list of known
1493 // identifiers and determine whether we have to establish
1494 // preprocessor definitions or top-level identifier declaration
1495 // chains for those identifiers.
1496 //
1497 // We copy the IdentifierInfo pointers to a small vector first,
1498 // since de-serializing declarations or macro definitions can add
1499 // new entries into the identifier table, invalidating the
1500 // iterators.
1501 llvm::SmallVector<IdentifierInfo *, 128> Identifiers;
1502 for (IdentifierTable::iterator Id = PP->getIdentifierTable().begin(),
1503 IdEnd = PP->getIdentifierTable().end();
1504 Id != IdEnd; ++Id)
1505 Identifiers.push_back(Id->second);
Mike Stump11289f42009-09-09 15:08:12 +00001506 PCHIdentifierLookupTable *IdTable
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001507 = (PCHIdentifierLookupTable *)IdentifierLookupTable;
1508 for (unsigned I = 0, N = Identifiers.size(); I != N; ++I) {
1509 IdentifierInfo *II = Identifiers[I];
1510 // Look in the on-disk hash table for an entry for
1511 PCHIdentifierLookupTrait Info(*this, II);
1512 std::pair<const char*, unsigned> Key(II->getName(), II->getLength());
1513 PCHIdentifierLookupTable::iterator Pos = IdTable->find(Key, &Info);
1514 if (Pos == IdTable->end())
1515 continue;
Mike Stump11289f42009-09-09 15:08:12 +00001516
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001517 // Dereferencing the iterator has the effect of populating the
1518 // IdentifierInfo node with the various declarations it needs.
1519 (void)*Pos;
1520 }
Douglas Gregora868bbd2009-04-21 22:25:48 +00001521 }
1522
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001523 if (Context)
1524 InitializeContext(*Context);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00001525
Douglas Gregora868bbd2009-04-21 22:25:48 +00001526 return Success;
Douglas Gregorfeb84b02009-04-14 21:18:50 +00001527}
1528
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001529void PCHReader::InitializeContext(ASTContext &Ctx) {
1530 Context = &Ctx;
1531 assert(Context && "Passed null context!");
1532
1533 assert(PP && "Forgot to set Preprocessor ?");
1534 PP->getIdentifierTable().setExternalIdentifierLookup(this);
1535 PP->getHeaderSearchInfo().SetExternalLookup(this);
Mike Stump11289f42009-09-09 15:08:12 +00001536
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001537 // Load the translation unit declaration
1538 ReadDeclRecord(DeclOffsets[0], 0);
1539
1540 // Load the special types.
1541 Context->setBuiltinVaListType(
1542 GetType(SpecialTypes[pch::SPECIAL_TYPE_BUILTIN_VA_LIST]));
1543 if (unsigned Id = SpecialTypes[pch::SPECIAL_TYPE_OBJC_ID])
1544 Context->setObjCIdType(GetType(Id));
1545 if (unsigned Sel = SpecialTypes[pch::SPECIAL_TYPE_OBJC_SELECTOR])
1546 Context->setObjCSelType(GetType(Sel));
1547 if (unsigned Proto = SpecialTypes[pch::SPECIAL_TYPE_OBJC_PROTOCOL])
1548 Context->setObjCProtoType(GetType(Proto));
1549 if (unsigned Class = SpecialTypes[pch::SPECIAL_TYPE_OBJC_CLASS])
1550 Context->setObjCClassType(GetType(Class));
Steve Naroff7cae42b2009-07-10 23:34:53 +00001551
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001552 if (unsigned String = SpecialTypes[pch::SPECIAL_TYPE_CF_CONSTANT_STRING])
1553 Context->setCFConstantStringType(GetType(String));
Mike Stump11289f42009-09-09 15:08:12 +00001554 if (unsigned FastEnum
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001555 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_FAST_ENUMERATION_STATE])
1556 Context->setObjCFastEnumerationStateType(GetType(FastEnum));
Douglas Gregor27821ce2009-07-07 16:35:42 +00001557 if (unsigned File = SpecialTypes[pch::SPECIAL_TYPE_FILE]) {
1558 QualType FileType = GetType(File);
1559 assert(!FileType.isNull() && "FILE type is NULL");
John McCall9dd450b2009-09-21 23:43:11 +00001560 if (const TypedefType *Typedef = FileType->getAs<TypedefType>())
Douglas Gregor27821ce2009-07-07 16:35:42 +00001561 Context->setFILEDecl(Typedef->getDecl());
1562 else {
Ted Kremenekc23c7e62009-07-29 21:53:49 +00001563 const TagType *Tag = FileType->getAs<TagType>();
Douglas Gregor27821ce2009-07-07 16:35:42 +00001564 assert(Tag && "Invalid FILE type in PCH file");
1565 Context->setFILEDecl(Tag->getDecl());
1566 }
1567 }
Mike Stumpa4de80b2009-07-28 02:25:19 +00001568 if (unsigned Jmp_buf = SpecialTypes[pch::SPECIAL_TYPE_jmp_buf]) {
1569 QualType Jmp_bufType = GetType(Jmp_buf);
1570 assert(!Jmp_bufType.isNull() && "jmp_bug type is NULL");
John McCall9dd450b2009-09-21 23:43:11 +00001571 if (const TypedefType *Typedef = Jmp_bufType->getAs<TypedefType>())
Mike Stumpa4de80b2009-07-28 02:25:19 +00001572 Context->setjmp_bufDecl(Typedef->getDecl());
1573 else {
Ted Kremenekc23c7e62009-07-29 21:53:49 +00001574 const TagType *Tag = Jmp_bufType->getAs<TagType>();
Mike Stumpa4de80b2009-07-28 02:25:19 +00001575 assert(Tag && "Invalid jmp_bug type in PCH file");
1576 Context->setjmp_bufDecl(Tag->getDecl());
1577 }
1578 }
1579 if (unsigned Sigjmp_buf = SpecialTypes[pch::SPECIAL_TYPE_sigjmp_buf]) {
1580 QualType Sigjmp_bufType = GetType(Sigjmp_buf);
1581 assert(!Sigjmp_bufType.isNull() && "sigjmp_buf type is NULL");
John McCall9dd450b2009-09-21 23:43:11 +00001582 if (const TypedefType *Typedef = Sigjmp_bufType->getAs<TypedefType>())
Mike Stumpa4de80b2009-07-28 02:25:19 +00001583 Context->setsigjmp_bufDecl(Typedef->getDecl());
1584 else {
Ted Kremenekc23c7e62009-07-29 21:53:49 +00001585 const TagType *Tag = Sigjmp_bufType->getAs<TagType>();
Mike Stumpa4de80b2009-07-28 02:25:19 +00001586 assert(Tag && "Invalid sigjmp_buf type in PCH file");
1587 Context->setsigjmp_bufDecl(Tag->getDecl());
1588 }
1589 }
Mike Stump11289f42009-09-09 15:08:12 +00001590 if (unsigned ObjCIdRedef
Douglas Gregora8eed7d2009-08-21 00:27:50 +00001591 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_ID_REDEFINITION])
1592 Context->ObjCIdRedefinitionType = GetType(ObjCIdRedef);
Mike Stump11289f42009-09-09 15:08:12 +00001593 if (unsigned ObjCClassRedef
Douglas Gregora8eed7d2009-08-21 00:27:50 +00001594 = SpecialTypes[pch::SPECIAL_TYPE_OBJC_CLASS_REDEFINITION])
1595 Context->ObjCClassRedefinitionType = GetType(ObjCClassRedef);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001596}
1597
Douglas Gregor45fe0362009-05-12 01:31:05 +00001598/// \brief Retrieve the name of the original source file name
1599/// directly from the PCH file, without actually loading the PCH
1600/// file.
1601std::string PCHReader::getOriginalSourceFile(const std::string &PCHFileName) {
1602 // Open the PCH file.
1603 std::string ErrStr;
1604 llvm::OwningPtr<llvm::MemoryBuffer> Buffer;
1605 Buffer.reset(llvm::MemoryBuffer::getFile(PCHFileName.c_str(), &ErrStr));
1606 if (!Buffer) {
1607 fprintf(stderr, "error: %s\n", ErrStr.c_str());
1608 return std::string();
1609 }
1610
1611 // Initialize the stream
1612 llvm::BitstreamReader StreamFile;
1613 llvm::BitstreamCursor Stream;
Mike Stump11289f42009-09-09 15:08:12 +00001614 StreamFile.init((const unsigned char *)Buffer->getBufferStart(),
Douglas Gregor45fe0362009-05-12 01:31:05 +00001615 (const unsigned char *)Buffer->getBufferEnd());
1616 Stream.init(StreamFile);
1617
1618 // Sniff for the signature.
1619 if (Stream.Read(8) != 'C' ||
1620 Stream.Read(8) != 'P' ||
1621 Stream.Read(8) != 'C' ||
1622 Stream.Read(8) != 'H') {
Mike Stump11289f42009-09-09 15:08:12 +00001623 fprintf(stderr,
Douglas Gregor45fe0362009-05-12 01:31:05 +00001624 "error: '%s' does not appear to be a precompiled header file\n",
1625 PCHFileName.c_str());
1626 return std::string();
1627 }
1628
1629 RecordData Record;
1630 while (!Stream.AtEndOfStream()) {
1631 unsigned Code = Stream.ReadCode();
Mike Stump11289f42009-09-09 15:08:12 +00001632
Douglas Gregor45fe0362009-05-12 01:31:05 +00001633 if (Code == llvm::bitc::ENTER_SUBBLOCK) {
1634 unsigned BlockID = Stream.ReadSubBlockID();
Mike Stump11289f42009-09-09 15:08:12 +00001635
Douglas Gregor45fe0362009-05-12 01:31:05 +00001636 // We only know the PCH subblock ID.
1637 switch (BlockID) {
1638 case pch::PCH_BLOCK_ID:
1639 if (Stream.EnterSubBlock(pch::PCH_BLOCK_ID)) {
1640 fprintf(stderr, "error: malformed block record in PCH file\n");
1641 return std::string();
1642 }
1643 break;
Mike Stump11289f42009-09-09 15:08:12 +00001644
Douglas Gregor45fe0362009-05-12 01:31:05 +00001645 default:
1646 if (Stream.SkipBlock()) {
1647 fprintf(stderr, "error: malformed block record in PCH file\n");
1648 return std::string();
1649 }
1650 break;
1651 }
1652 continue;
1653 }
1654
1655 if (Code == llvm::bitc::END_BLOCK) {
1656 if (Stream.ReadBlockEnd()) {
1657 fprintf(stderr, "error: error at end of module block in PCH file\n");
1658 return std::string();
1659 }
1660 continue;
1661 }
1662
1663 if (Code == llvm::bitc::DEFINE_ABBREV) {
1664 Stream.ReadAbbrevRecord();
1665 continue;
1666 }
1667
1668 Record.clear();
1669 const char *BlobStart = 0;
1670 unsigned BlobLen = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001671 if (Stream.ReadRecord(Code, Record, &BlobStart, &BlobLen)
Douglas Gregor45fe0362009-05-12 01:31:05 +00001672 == pch::ORIGINAL_FILE_NAME)
1673 return std::string(BlobStart, BlobLen);
Mike Stump11289f42009-09-09 15:08:12 +00001674 }
Douglas Gregor45fe0362009-05-12 01:31:05 +00001675
1676 return std::string();
1677}
1678
Douglas Gregor55abb232009-04-10 20:39:37 +00001679/// \brief Parse the record that corresponds to a LangOptions data
1680/// structure.
1681///
1682/// This routine compares the language options used to generate the
1683/// PCH file against the language options set for the current
1684/// compilation. For each option, we classify differences between the
1685/// two compiler states as either "benign" or "important". Benign
1686/// differences don't matter, and we accept them without complaint
1687/// (and without modifying the language options). Differences between
1688/// the states for important options cause the PCH file to be
1689/// unusable, so we emit a warning and return true to indicate that
1690/// there was an error.
1691///
1692/// \returns true if the PCH file is unacceptable, false otherwise.
1693bool PCHReader::ParseLanguageOptions(
1694 const llvm::SmallVectorImpl<uint64_t> &Record) {
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001695 if (Listener) {
1696 LangOptions LangOpts;
Mike Stump11289f42009-09-09 15:08:12 +00001697
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001698 #define PARSE_LANGOPT(Option) \
1699 LangOpts.Option = Record[Idx]; \
1700 ++Idx
Mike Stump11289f42009-09-09 15:08:12 +00001701
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001702 unsigned Idx = 0;
1703 PARSE_LANGOPT(Trigraphs);
1704 PARSE_LANGOPT(BCPLComment);
1705 PARSE_LANGOPT(DollarIdents);
1706 PARSE_LANGOPT(AsmPreprocessor);
1707 PARSE_LANGOPT(GNUMode);
1708 PARSE_LANGOPT(ImplicitInt);
1709 PARSE_LANGOPT(Digraphs);
1710 PARSE_LANGOPT(HexFloats);
1711 PARSE_LANGOPT(C99);
1712 PARSE_LANGOPT(Microsoft);
1713 PARSE_LANGOPT(CPlusPlus);
1714 PARSE_LANGOPT(CPlusPlus0x);
1715 PARSE_LANGOPT(CXXOperatorNames);
1716 PARSE_LANGOPT(ObjC1);
1717 PARSE_LANGOPT(ObjC2);
1718 PARSE_LANGOPT(ObjCNonFragileABI);
1719 PARSE_LANGOPT(PascalStrings);
1720 PARSE_LANGOPT(WritableStrings);
1721 PARSE_LANGOPT(LaxVectorConversions);
Nate Begemanf2911662009-06-25 23:01:11 +00001722 PARSE_LANGOPT(AltiVec);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001723 PARSE_LANGOPT(Exceptions);
1724 PARSE_LANGOPT(NeXTRuntime);
1725 PARSE_LANGOPT(Freestanding);
1726 PARSE_LANGOPT(NoBuiltin);
1727 PARSE_LANGOPT(ThreadsafeStatics);
Douglas Gregorb3286fe2009-09-03 14:36:33 +00001728 PARSE_LANGOPT(POSIXThreads);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001729 PARSE_LANGOPT(Blocks);
1730 PARSE_LANGOPT(EmitAllDecls);
1731 PARSE_LANGOPT(MathErrno);
1732 PARSE_LANGOPT(OverflowChecking);
1733 PARSE_LANGOPT(HeinousExtensions);
1734 PARSE_LANGOPT(Optimize);
1735 PARSE_LANGOPT(OptimizeSize);
1736 PARSE_LANGOPT(Static);
1737 PARSE_LANGOPT(PICLevel);
1738 PARSE_LANGOPT(GNUInline);
1739 PARSE_LANGOPT(NoInline);
1740 PARSE_LANGOPT(AccessControl);
1741 PARSE_LANGOPT(CharIsSigned);
1742 LangOpts.setGCMode((LangOptions::GCMode)Record[Idx]);
1743 ++Idx;
1744 LangOpts.setVisibilityMode((LangOptions::VisibilityMode)Record[Idx]);
1745 ++Idx;
Daniel Dunbar143021e2009-09-21 04:16:19 +00001746 LangOpts.setStackProtectorMode((LangOptions::StackProtectorMode)
1747 Record[Idx]);
1748 ++Idx;
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001749 PARSE_LANGOPT(InstantiationDepth);
Nate Begemanf2911662009-06-25 23:01:11 +00001750 PARSE_LANGOPT(OpenCL);
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001751 #undef PARSE_LANGOPT
Douglas Gregor55abb232009-04-10 20:39:37 +00001752
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00001753 return Listener->ReadLanguageOptions(LangOpts);
Douglas Gregor55abb232009-04-10 20:39:37 +00001754 }
Douglas Gregor55abb232009-04-10 20:39:37 +00001755
1756 return false;
1757}
1758
Douglas Gregorc6d5edd2009-07-02 17:08:52 +00001759void PCHReader::ReadComments(std::vector<SourceRange> &Comments) {
1760 Comments.resize(NumComments);
1761 std::copy(this->Comments, this->Comments + NumComments,
1762 Comments.begin());
1763}
1764
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001765/// \brief Read and return the type at the given offset.
1766///
1767/// This routine actually reads the record corresponding to the type
1768/// at the given offset in the bitstream. It is a helper routine for
1769/// GetType, which deals with reading type IDs.
1770QualType PCHReader::ReadTypeRecord(uint64_t Offset) {
Douglas Gregorfeb84b02009-04-14 21:18:50 +00001771 // Keep track of where we are in the stream, then jump back there
1772 // after reading this type.
1773 SavedStreamPosition SavedPosition(Stream);
1774
Douglas Gregor1342e842009-07-06 18:54:52 +00001775 // Note that we are loading a type record.
1776 LoadingTypeOrDecl Loading(*this);
Mike Stump11289f42009-09-09 15:08:12 +00001777
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001778 Stream.JumpToBit(Offset);
1779 RecordData Record;
1780 unsigned Code = Stream.ReadCode();
1781 switch ((pch::TypeCode)Stream.ReadRecord(Code, Record)) {
Douglas Gregor455b8f42009-04-15 22:00:08 +00001782 case pch::TYPE_EXT_QUAL: {
John McCall8ccfcb52009-09-24 19:53:00 +00001783 assert(Record.size() == 2 &&
Douglas Gregor455b8f42009-04-15 22:00:08 +00001784 "Incorrect encoding of extended qualifier type");
1785 QualType Base = GetType(Record[0]);
John McCall8ccfcb52009-09-24 19:53:00 +00001786 Qualifiers Quals = Qualifiers::fromOpaqueValue(Record[1]);
1787 return Context->getQualifiedType(Base, Quals);
Douglas Gregor455b8f42009-04-15 22:00:08 +00001788 }
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001789
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001790 case pch::TYPE_FIXED_WIDTH_INT: {
1791 assert(Record.size() == 2 && "Incorrect encoding of fixed-width int type");
Chris Lattner8575daa2009-04-27 21:45:14 +00001792 return Context->getFixedWidthIntType(Record[0], Record[1]);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001793 }
1794
1795 case pch::TYPE_COMPLEX: {
1796 assert(Record.size() == 1 && "Incorrect encoding of complex type");
1797 QualType ElemType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001798 return Context->getComplexType(ElemType);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001799 }
1800
1801 case pch::TYPE_POINTER: {
1802 assert(Record.size() == 1 && "Incorrect encoding of pointer type");
1803 QualType PointeeType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001804 return Context->getPointerType(PointeeType);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001805 }
1806
1807 case pch::TYPE_BLOCK_POINTER: {
1808 assert(Record.size() == 1 && "Incorrect encoding of block pointer type");
1809 QualType PointeeType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001810 return Context->getBlockPointerType(PointeeType);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001811 }
1812
1813 case pch::TYPE_LVALUE_REFERENCE: {
1814 assert(Record.size() == 1 && "Incorrect encoding of lvalue reference type");
1815 QualType PointeeType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001816 return Context->getLValueReferenceType(PointeeType);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001817 }
1818
1819 case pch::TYPE_RVALUE_REFERENCE: {
1820 assert(Record.size() == 1 && "Incorrect encoding of rvalue reference type");
1821 QualType PointeeType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001822 return Context->getRValueReferenceType(PointeeType);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001823 }
1824
1825 case pch::TYPE_MEMBER_POINTER: {
1826 assert(Record.size() == 1 && "Incorrect encoding of member pointer type");
1827 QualType PointeeType = GetType(Record[0]);
1828 QualType ClassType = GetType(Record[1]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001829 return Context->getMemberPointerType(PointeeType, ClassType.getTypePtr());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001830 }
1831
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001832 case pch::TYPE_CONSTANT_ARRAY: {
1833 QualType ElementType = GetType(Record[0]);
1834 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
1835 unsigned IndexTypeQuals = Record[2];
1836 unsigned Idx = 3;
1837 llvm::APInt Size = ReadAPInt(Record, Idx);
Douglas Gregor04318252009-07-06 15:59:29 +00001838 return Context->getConstantArrayType(ElementType, Size,
1839 ASM, IndexTypeQuals);
1840 }
1841
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001842 case pch::TYPE_INCOMPLETE_ARRAY: {
1843 QualType ElementType = GetType(Record[0]);
1844 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
1845 unsigned IndexTypeQuals = Record[2];
Chris Lattner8575daa2009-04-27 21:45:14 +00001846 return Context->getIncompleteArrayType(ElementType, ASM, IndexTypeQuals);
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001847 }
1848
1849 case pch::TYPE_VARIABLE_ARRAY: {
Douglas Gregorfeb84b02009-04-14 21:18:50 +00001850 QualType ElementType = GetType(Record[0]);
1851 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
1852 unsigned IndexTypeQuals = Record[2];
Douglas Gregor04318252009-07-06 15:59:29 +00001853 SourceLocation LBLoc = SourceLocation::getFromRawEncoding(Record[3]);
1854 SourceLocation RBLoc = SourceLocation::getFromRawEncoding(Record[4]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001855 return Context->getVariableArrayType(ElementType, ReadTypeExpr(),
Douglas Gregor04318252009-07-06 15:59:29 +00001856 ASM, IndexTypeQuals,
1857 SourceRange(LBLoc, RBLoc));
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001858 }
1859
1860 case pch::TYPE_VECTOR: {
1861 if (Record.size() != 2) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001862 Error("incorrect encoding of vector type in PCH file");
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001863 return QualType();
1864 }
1865
1866 QualType ElementType = GetType(Record[0]);
1867 unsigned NumElements = Record[1];
Chris Lattner8575daa2009-04-27 21:45:14 +00001868 return Context->getVectorType(ElementType, NumElements);
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001869 }
1870
1871 case pch::TYPE_EXT_VECTOR: {
1872 if (Record.size() != 2) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001873 Error("incorrect encoding of extended vector type in PCH file");
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001874 return QualType();
1875 }
1876
1877 QualType ElementType = GetType(Record[0]);
1878 unsigned NumElements = Record[1];
Chris Lattner8575daa2009-04-27 21:45:14 +00001879 return Context->getExtVectorType(ElementType, NumElements);
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001880 }
1881
1882 case pch::TYPE_FUNCTION_NO_PROTO: {
1883 if (Record.size() != 1) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001884 Error("incorrect encoding of no-proto function type");
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001885 return QualType();
1886 }
1887 QualType ResultType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001888 return Context->getFunctionNoProtoType(ResultType);
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001889 }
1890
1891 case pch::TYPE_FUNCTION_PROTO: {
1892 QualType ResultType = GetType(Record[0]);
1893 unsigned Idx = 1;
1894 unsigned NumParams = Record[Idx++];
1895 llvm::SmallVector<QualType, 16> ParamTypes;
1896 for (unsigned I = 0; I != NumParams; ++I)
1897 ParamTypes.push_back(GetType(Record[Idx++]));
1898 bool isVariadic = Record[Idx++];
1899 unsigned Quals = Record[Idx++];
Sebastian Redl5068f77ac2009-05-27 22:11:52 +00001900 bool hasExceptionSpec = Record[Idx++];
1901 bool hasAnyExceptionSpec = Record[Idx++];
1902 unsigned NumExceptions = Record[Idx++];
1903 llvm::SmallVector<QualType, 2> Exceptions;
1904 for (unsigned I = 0; I != NumExceptions; ++I)
1905 Exceptions.push_back(GetType(Record[Idx++]));
Jay Foad7d0479f2009-05-21 09:52:38 +00001906 return Context->getFunctionType(ResultType, ParamTypes.data(), NumParams,
Sebastian Redl5068f77ac2009-05-27 22:11:52 +00001907 isVariadic, Quals, hasExceptionSpec,
1908 hasAnyExceptionSpec, NumExceptions,
1909 Exceptions.data());
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001910 }
1911
1912 case pch::TYPE_TYPEDEF:
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001913 assert(Record.size() == 1 && "incorrect encoding of typedef type");
Chris Lattner8575daa2009-04-27 21:45:14 +00001914 return Context->getTypeDeclType(cast<TypedefDecl>(GetDecl(Record[0])));
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001915
1916 case pch::TYPE_TYPEOF_EXPR:
Chris Lattner8575daa2009-04-27 21:45:14 +00001917 return Context->getTypeOfExprType(ReadTypeExpr());
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001918
1919 case pch::TYPE_TYPEOF: {
1920 if (Record.size() != 1) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001921 Error("incorrect encoding of typeof(type) in PCH file");
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001922 return QualType();
1923 }
1924 QualType UnderlyingType = GetType(Record[0]);
Chris Lattner8575daa2009-04-27 21:45:14 +00001925 return Context->getTypeOfType(UnderlyingType);
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001926 }
Mike Stump11289f42009-09-09 15:08:12 +00001927
Anders Carlsson81df7b82009-06-24 19:06:50 +00001928 case pch::TYPE_DECLTYPE:
1929 return Context->getDecltypeType(ReadTypeExpr());
1930
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001931 case pch::TYPE_RECORD:
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001932 assert(Record.size() == 1 && "incorrect encoding of record type");
Chris Lattner8575daa2009-04-27 21:45:14 +00001933 return Context->getTypeDeclType(cast<RecordDecl>(GetDecl(Record[0])));
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001934
Douglas Gregor1daeb692009-04-13 18:14:40 +00001935 case pch::TYPE_ENUM:
Douglas Gregor6f00bf82009-04-28 21:53:25 +00001936 assert(Record.size() == 1 && "incorrect encoding of enum type");
Chris Lattner8575daa2009-04-27 21:45:14 +00001937 return Context->getTypeDeclType(cast<EnumDecl>(GetDecl(Record[0])));
Douglas Gregor1daeb692009-04-13 18:14:40 +00001938
John McCallfcc33b02009-09-05 00:15:47 +00001939 case pch::TYPE_ELABORATED: {
1940 assert(Record.size() == 2 && "incorrect encoding of elaborated type");
1941 unsigned Tag = Record[1];
1942 return Context->getElaboratedType(GetType(Record[0]),
1943 (ElaboratedType::TagKind) Tag);
1944 }
1945
Steve Naroffc277ad12009-07-18 15:33:26 +00001946 case pch::TYPE_OBJC_INTERFACE: {
Chris Lattner587cbe12009-04-22 06:45:28 +00001947 unsigned Idx = 0;
1948 ObjCInterfaceDecl *ItfD = cast<ObjCInterfaceDecl>(GetDecl(Record[Idx++]));
1949 unsigned NumProtos = Record[Idx++];
1950 llvm::SmallVector<ObjCProtocolDecl*, 4> Protos;
1951 for (unsigned I = 0; I != NumProtos; ++I)
1952 Protos.push_back(cast<ObjCProtocolDecl>(GetDecl(Record[Idx++])));
Steve Naroffc277ad12009-07-18 15:33:26 +00001953 return Context->getObjCInterfaceType(ItfD, Protos.data(), NumProtos);
Chris Lattner587cbe12009-04-22 06:45:28 +00001954 }
Douglas Gregor85c0fcd2009-04-13 20:46:52 +00001955
Steve Narofffb4330f2009-06-17 22:40:22 +00001956 case pch::TYPE_OBJC_OBJECT_POINTER: {
Chris Lattner6e054af2009-04-22 06:40:03 +00001957 unsigned Idx = 0;
Steve Naroff7cae42b2009-07-10 23:34:53 +00001958 QualType OIT = GetType(Record[Idx++]);
Chris Lattner6e054af2009-04-22 06:40:03 +00001959 unsigned NumProtos = Record[Idx++];
1960 llvm::SmallVector<ObjCProtocolDecl*, 4> Protos;
1961 for (unsigned I = 0; I != NumProtos; ++I)
1962 Protos.push_back(cast<ObjCProtocolDecl>(GetDecl(Record[Idx++])));
Steve Naroff7cae42b2009-07-10 23:34:53 +00001963 return Context->getObjCObjectPointerType(OIT, Protos.data(), NumProtos);
Chris Lattner6e054af2009-04-22 06:40:03 +00001964 }
Argyrios Kyrtzidisa7a36df2009-09-29 19:42:55 +00001965
1966 case pch::TYPE_OBJC_PROTOCOL_LIST: {
1967 unsigned Idx = 0;
1968 QualType OIT = GetType(Record[Idx++]);
1969 unsigned NumProtos = Record[Idx++];
1970 llvm::SmallVector<ObjCProtocolDecl*, 4> Protos;
1971 for (unsigned I = 0; I != NumProtos; ++I)
1972 Protos.push_back(cast<ObjCProtocolDecl>(GetDecl(Record[Idx++])));
1973 return Context->getObjCProtocolListType(OIT, Protos.data(), NumProtos);
1974 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001975 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001976 // Suppress a GCC warning
1977 return QualType();
1978}
1979
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001980
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001981QualType PCHReader::GetType(pch::TypeID ID) {
John McCall8ccfcb52009-09-24 19:53:00 +00001982 unsigned FastQuals = ID & Qualifiers::FastMask;
1983 unsigned Index = ID >> Qualifiers::FastWidth;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001984
1985 if (Index < pch::NUM_PREDEF_TYPE_IDS) {
1986 QualType T;
1987 switch ((pch::PredefinedTypeIDs)Index) {
1988 case pch::PREDEF_TYPE_NULL_ID: return QualType();
Chris Lattner8575daa2009-04-27 21:45:14 +00001989 case pch::PREDEF_TYPE_VOID_ID: T = Context->VoidTy; break;
1990 case pch::PREDEF_TYPE_BOOL_ID: T = Context->BoolTy; break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001991
1992 case pch::PREDEF_TYPE_CHAR_U_ID:
1993 case pch::PREDEF_TYPE_CHAR_S_ID:
1994 // FIXME: Check that the signedness of CharTy is correct!
Chris Lattner8575daa2009-04-27 21:45:14 +00001995 T = Context->CharTy;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001996 break;
1997
Chris Lattner8575daa2009-04-27 21:45:14 +00001998 case pch::PREDEF_TYPE_UCHAR_ID: T = Context->UnsignedCharTy; break;
1999 case pch::PREDEF_TYPE_USHORT_ID: T = Context->UnsignedShortTy; break;
2000 case pch::PREDEF_TYPE_UINT_ID: T = Context->UnsignedIntTy; break;
2001 case pch::PREDEF_TYPE_ULONG_ID: T = Context->UnsignedLongTy; break;
2002 case pch::PREDEF_TYPE_ULONGLONG_ID: T = Context->UnsignedLongLongTy; break;
Chris Lattnerf122cef2009-04-30 02:43:43 +00002003 case pch::PREDEF_TYPE_UINT128_ID: T = Context->UnsignedInt128Ty; break;
Chris Lattner8575daa2009-04-27 21:45:14 +00002004 case pch::PREDEF_TYPE_SCHAR_ID: T = Context->SignedCharTy; break;
2005 case pch::PREDEF_TYPE_WCHAR_ID: T = Context->WCharTy; break;
2006 case pch::PREDEF_TYPE_SHORT_ID: T = Context->ShortTy; break;
2007 case pch::PREDEF_TYPE_INT_ID: T = Context->IntTy; break;
2008 case pch::PREDEF_TYPE_LONG_ID: T = Context->LongTy; break;
2009 case pch::PREDEF_TYPE_LONGLONG_ID: T = Context->LongLongTy; break;
Chris Lattnerf122cef2009-04-30 02:43:43 +00002010 case pch::PREDEF_TYPE_INT128_ID: T = Context->Int128Ty; break;
Chris Lattner8575daa2009-04-27 21:45:14 +00002011 case pch::PREDEF_TYPE_FLOAT_ID: T = Context->FloatTy; break;
2012 case pch::PREDEF_TYPE_DOUBLE_ID: T = Context->DoubleTy; break;
2013 case pch::PREDEF_TYPE_LONGDOUBLE_ID: T = Context->LongDoubleTy; break;
2014 case pch::PREDEF_TYPE_OVERLOAD_ID: T = Context->OverloadTy; break;
2015 case pch::PREDEF_TYPE_DEPENDENT_ID: T = Context->DependentTy; break;
Sebastian Redl576fd422009-05-10 18:38:11 +00002016 case pch::PREDEF_TYPE_NULLPTR_ID: T = Context->NullPtrTy; break;
Alisdair Mereditha9ad47d2009-07-14 06:30:34 +00002017 case pch::PREDEF_TYPE_CHAR16_ID: T = Context->Char16Ty; break;
2018 case pch::PREDEF_TYPE_CHAR32_ID: T = Context->Char32Ty; break;
Steve Naroff1329fa02009-07-15 18:40:39 +00002019 case pch::PREDEF_TYPE_OBJC_ID: T = Context->ObjCBuiltinIdTy; break;
2020 case pch::PREDEF_TYPE_OBJC_CLASS: T = Context->ObjCBuiltinClassTy; break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002021 }
2022
2023 assert(!T.isNull() && "Unknown predefined type");
John McCall8ccfcb52009-09-24 19:53:00 +00002024 return T.withFastQualifiers(FastQuals);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002025 }
2026
2027 Index -= pch::NUM_PREDEF_TYPE_IDS;
Steve Naroffc277ad12009-07-18 15:33:26 +00002028 //assert(Index < TypesLoaded.size() && "Type index out-of-range");
John McCall8ccfcb52009-09-24 19:53:00 +00002029 if (TypesLoaded[Index].isNull())
2030 TypesLoaded[Index] = ReadTypeRecord(TypeOffsets[Index]);
Mike Stump11289f42009-09-09 15:08:12 +00002031
John McCall8ccfcb52009-09-24 19:53:00 +00002032 return TypesLoaded[Index].withFastQualifiers(FastQuals);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002033}
2034
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00002035Decl *PCHReader::GetDecl(pch::DeclID ID) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002036 if (ID == 0)
2037 return 0;
2038
Douglas Gregor745ed142009-04-25 18:35:21 +00002039 if (ID > DeclsLoaded.size()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00002040 Error("declaration ID out-of-range for PCH file");
Douglas Gregor745ed142009-04-25 18:35:21 +00002041 return 0;
2042 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002043
Douglas Gregor745ed142009-04-25 18:35:21 +00002044 unsigned Index = ID - 1;
2045 if (!DeclsLoaded[Index])
2046 ReadDeclRecord(DeclOffsets[Index], Index);
2047
2048 return DeclsLoaded[Index];
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002049}
2050
Chris Lattner9c28af02009-04-27 05:46:25 +00002051/// \brief Resolve the offset of a statement into a statement.
2052///
2053/// This operation will read a new statement from the external
2054/// source each time it is called, and is meant to be used via a
2055/// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
2056Stmt *PCHReader::GetDeclStmt(uint64_t Offset) {
Chris Lattner1de76db2009-04-27 05:58:23 +00002057 // Since we know tha this statement is part of a decl, make sure to use the
2058 // decl cursor to read it.
2059 DeclsCursor.JumpToBit(Offset);
2060 return ReadStmt(DeclsCursor);
Douglas Gregor3c3aa612009-04-18 00:07:54 +00002061}
2062
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002063bool PCHReader::ReadDeclsLexicallyInContext(DeclContext *DC,
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00002064 llvm::SmallVectorImpl<pch::DeclID> &Decls) {
Mike Stump11289f42009-09-09 15:08:12 +00002065 assert(DC->hasExternalLexicalStorage() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002066 "DeclContext has no lexical decls in storage");
2067 uint64_t Offset = DeclContextOffsets[DC].first;
2068 assert(Offset && "DeclContext has no lexical decls in storage");
2069
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002070 // Keep track of where we are in the stream, then jump back there
2071 // after reading this context.
Chris Lattner72405d62009-04-27 07:35:40 +00002072 SavedStreamPosition SavedPosition(DeclsCursor);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002073
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002074 // Load the record containing all of the declarations lexically in
2075 // this context.
Chris Lattner72405d62009-04-27 07:35:40 +00002076 DeclsCursor.JumpToBit(Offset);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002077 RecordData Record;
Chris Lattner72405d62009-04-27 07:35:40 +00002078 unsigned Code = DeclsCursor.ReadCode();
2079 unsigned RecCode = DeclsCursor.ReadRecord(Code, Record);
Douglas Gregore95304a2009-04-15 18:43:11 +00002080 (void)RecCode;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002081 assert(RecCode == pch::DECL_CONTEXT_LEXICAL && "Expected lexical block");
2082
2083 // Load all of the declaration IDs
2084 Decls.clear();
2085 Decls.insert(Decls.end(), Record.begin(), Record.end());
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002086 ++NumLexicalDeclContextsRead;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002087 return false;
2088}
2089
2090bool PCHReader::ReadDeclsVisibleInContext(DeclContext *DC,
Chris Lattner72405d62009-04-27 07:35:40 +00002091 llvm::SmallVectorImpl<VisibleDeclaration> &Decls) {
Mike Stump11289f42009-09-09 15:08:12 +00002092 assert(DC->hasExternalVisibleStorage() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002093 "DeclContext has no visible decls in storage");
2094 uint64_t Offset = DeclContextOffsets[DC].second;
2095 assert(Offset && "DeclContext has no visible decls in storage");
2096
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002097 // Keep track of where we are in the stream, then jump back there
2098 // after reading this context.
Chris Lattner72405d62009-04-27 07:35:40 +00002099 SavedStreamPosition SavedPosition(DeclsCursor);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002100
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002101 // Load the record containing all of the declarations visible in
2102 // this context.
Chris Lattner72405d62009-04-27 07:35:40 +00002103 DeclsCursor.JumpToBit(Offset);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002104 RecordData Record;
Chris Lattner72405d62009-04-27 07:35:40 +00002105 unsigned Code = DeclsCursor.ReadCode();
2106 unsigned RecCode = DeclsCursor.ReadRecord(Code, Record);
Douglas Gregore95304a2009-04-15 18:43:11 +00002107 (void)RecCode;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002108 assert(RecCode == pch::DECL_CONTEXT_VISIBLE && "Expected visible block");
2109 if (Record.size() == 0)
Mike Stump11289f42009-09-09 15:08:12 +00002110 return false;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002111
2112 Decls.clear();
2113
2114 unsigned Idx = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002115 while (Idx < Record.size()) {
2116 Decls.push_back(VisibleDeclaration());
2117 Decls.back().Name = ReadDeclarationName(Record, Idx);
2118
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002119 unsigned Size = Record[Idx++];
Chris Lattner72405d62009-04-27 07:35:40 +00002120 llvm::SmallVector<unsigned, 4> &LoadedDecls = Decls.back().Declarations;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002121 LoadedDecls.reserve(Size);
2122 for (unsigned I = 0; I < Size; ++I)
2123 LoadedDecls.push_back(Record[Idx++]);
2124 }
2125
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002126 ++NumVisibleDeclContextsRead;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002127 return false;
2128}
2129
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00002130void PCHReader::StartTranslationUnit(ASTConsumer *Consumer) {
Douglas Gregorb985eeb2009-04-22 19:09:20 +00002131 this->Consumer = Consumer;
2132
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00002133 if (!Consumer)
2134 return;
2135
2136 for (unsigned I = 0, N = ExternalDefinitions.size(); I != N; ++I) {
Daniel Dunbar865c2a72009-09-17 03:06:44 +00002137 // Force deserialization of this decl, which will cause it to be passed to
2138 // the consumer (or queued).
2139 GetDecl(ExternalDefinitions[I]);
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00002140 }
Douglas Gregorf005eac2009-04-25 00:41:30 +00002141
2142 for (unsigned I = 0, N = InterestingDecls.size(); I != N; ++I) {
2143 DeclGroupRef DG(InterestingDecls[I]);
2144 Consumer->HandleTopLevelDecl(DG);
2145 }
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00002146}
2147
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002148void PCHReader::PrintStats() {
2149 std::fprintf(stderr, "*** PCH Statistics:\n");
2150
Mike Stump11289f42009-09-09 15:08:12 +00002151 unsigned NumTypesLoaded
Douglas Gregor0e149972009-04-25 19:10:14 +00002152 = TypesLoaded.size() - std::count(TypesLoaded.begin(), TypesLoaded.end(),
John McCall8ccfcb52009-09-24 19:53:00 +00002153 QualType());
Douglas Gregor0e149972009-04-25 19:10:14 +00002154 unsigned NumDeclsLoaded
2155 = DeclsLoaded.size() - std::count(DeclsLoaded.begin(), DeclsLoaded.end(),
2156 (Decl *)0);
2157 unsigned NumIdentifiersLoaded
2158 = IdentifiersLoaded.size() - std::count(IdentifiersLoaded.begin(),
2159 IdentifiersLoaded.end(),
2160 (IdentifierInfo *)0);
Mike Stump11289f42009-09-09 15:08:12 +00002161 unsigned NumSelectorsLoaded
Douglas Gregor0e149972009-04-25 19:10:14 +00002162 = SelectorsLoaded.size() - std::count(SelectorsLoaded.begin(),
2163 SelectorsLoaded.end(),
2164 Selector());
Douglas Gregorc3b1dd12009-04-13 20:50:16 +00002165
Douglas Gregorc5046832009-04-27 18:38:38 +00002166 std::fprintf(stderr, " %u stat cache hits\n", NumStatHits);
2167 std::fprintf(stderr, " %u stat cache misses\n", NumStatMisses);
Douglas Gregor258ae542009-04-27 06:38:32 +00002168 if (TotalNumSLocEntries)
2169 std::fprintf(stderr, " %u/%u source location entries read (%f%%)\n",
2170 NumSLocEntriesRead, TotalNumSLocEntries,
2171 ((float)NumSLocEntriesRead/TotalNumSLocEntries * 100));
Douglas Gregor745ed142009-04-25 18:35:21 +00002172 if (!TypesLoaded.empty())
Douglas Gregor95c13f52009-04-25 17:48:32 +00002173 std::fprintf(stderr, " %u/%u types read (%f%%)\n",
Douglas Gregor745ed142009-04-25 18:35:21 +00002174 NumTypesLoaded, (unsigned)TypesLoaded.size(),
2175 ((float)NumTypesLoaded/TypesLoaded.size() * 100));
2176 if (!DeclsLoaded.empty())
Douglas Gregor95c13f52009-04-25 17:48:32 +00002177 std::fprintf(stderr, " %u/%u declarations read (%f%%)\n",
Douglas Gregor745ed142009-04-25 18:35:21 +00002178 NumDeclsLoaded, (unsigned)DeclsLoaded.size(),
2179 ((float)NumDeclsLoaded/DeclsLoaded.size() * 100));
Douglas Gregor0e149972009-04-25 19:10:14 +00002180 if (!IdentifiersLoaded.empty())
Douglas Gregor95c13f52009-04-25 17:48:32 +00002181 std::fprintf(stderr, " %u/%u identifiers read (%f%%)\n",
Douglas Gregor0e149972009-04-25 19:10:14 +00002182 NumIdentifiersLoaded, (unsigned)IdentifiersLoaded.size(),
2183 ((float)NumIdentifiersLoaded/IdentifiersLoaded.size() * 100));
Douglas Gregor95c13f52009-04-25 17:48:32 +00002184 if (TotalNumSelectors)
2185 std::fprintf(stderr, " %u/%u selectors read (%f%%)\n",
2186 NumSelectorsLoaded, TotalNumSelectors,
2187 ((float)NumSelectorsLoaded/TotalNumSelectors * 100));
2188 if (TotalNumStatements)
2189 std::fprintf(stderr, " %u/%u statements read (%f%%)\n",
2190 NumStatementsRead, TotalNumStatements,
2191 ((float)NumStatementsRead/TotalNumStatements * 100));
2192 if (TotalNumMacros)
2193 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
2194 NumMacrosRead, TotalNumMacros,
2195 ((float)NumMacrosRead/TotalNumMacros * 100));
2196 if (TotalLexicalDeclContexts)
2197 std::fprintf(stderr, " %u/%u lexical declcontexts read (%f%%)\n",
2198 NumLexicalDeclContextsRead, TotalLexicalDeclContexts,
2199 ((float)NumLexicalDeclContextsRead/TotalLexicalDeclContexts
2200 * 100));
2201 if (TotalVisibleDeclContexts)
2202 std::fprintf(stderr, " %u/%u visible declcontexts read (%f%%)\n",
2203 NumVisibleDeclContextsRead, TotalVisibleDeclContexts,
2204 ((float)NumVisibleDeclContextsRead/TotalVisibleDeclContexts
2205 * 100));
2206 if (TotalSelectorsInMethodPool) {
2207 std::fprintf(stderr, " %u/%u method pool entries read (%f%%)\n",
2208 NumMethodPoolSelectorsRead, TotalSelectorsInMethodPool,
2209 ((float)NumMethodPoolSelectorsRead/TotalSelectorsInMethodPool
2210 * 100));
2211 std::fprintf(stderr, " %u method pool misses\n", NumMethodPoolMisses);
2212 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002213 std::fprintf(stderr, "\n");
2214}
2215
Douglas Gregora868bbd2009-04-21 22:25:48 +00002216void PCHReader::InitializeSema(Sema &S) {
2217 SemaObj = &S;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002218 S.ExternalSource = this;
2219
Douglas Gregor7cd60f72009-04-22 21:15:06 +00002220 // Makes sure any declarations that were deserialized "too early"
2221 // still get added to the identifier's declaration chains.
2222 for (unsigned I = 0, N = PreloadedDecls.size(); I != N; ++I) {
2223 SemaObj->TUScope->AddDecl(Action::DeclPtrTy::make(PreloadedDecls[I]));
2224 SemaObj->IdResolver.AddDecl(PreloadedDecls[I]);
Douglas Gregora868bbd2009-04-21 22:25:48 +00002225 }
Douglas Gregor7cd60f72009-04-22 21:15:06 +00002226 PreloadedDecls.clear();
Douglas Gregord4df8652009-04-22 22:02:47 +00002227
2228 // If there were any tentative definitions, deserialize them and add
2229 // them to Sema's table of tentative definitions.
2230 for (unsigned I = 0, N = TentativeDefinitions.size(); I != N; ++I) {
2231 VarDecl *Var = cast<VarDecl>(GetDecl(TentativeDefinitions[I]));
2232 SemaObj->TentativeDefinitions[Var->getDeclName()] = Var;
Chris Lattner0c797362009-09-08 18:19:27 +00002233 SemaObj->TentativeDefinitionList.push_back(Var->getDeclName());
Douglas Gregord4df8652009-04-22 22:02:47 +00002234 }
Douglas Gregoracfc76c2009-04-22 22:18:58 +00002235
2236 // If there were any locally-scoped external declarations,
2237 // deserialize them and add them to Sema's table of locally-scoped
2238 // external declarations.
2239 for (unsigned I = 0, N = LocallyScopedExternalDecls.size(); I != N; ++I) {
2240 NamedDecl *D = cast<NamedDecl>(GetDecl(LocallyScopedExternalDecls[I]));
2241 SemaObj->LocallyScopedExternalDecls[D->getDeclName()] = D;
2242 }
Douglas Gregor61cac2b2009-04-27 20:06:05 +00002243
2244 // If there were any ext_vector type declarations, deserialize them
2245 // and add them to Sema's vector of such declarations.
2246 for (unsigned I = 0, N = ExtVectorDecls.size(); I != N; ++I)
2247 SemaObj->ExtVectorDecls.push_back(
2248 cast<TypedefDecl>(GetDecl(ExtVectorDecls[I])));
Douglas Gregora868bbd2009-04-21 22:25:48 +00002249}
2250
2251IdentifierInfo* PCHReader::get(const char *NameStart, const char *NameEnd) {
2252 // Try to find this name within our on-disk hash table
Mike Stump11289f42009-09-09 15:08:12 +00002253 PCHIdentifierLookupTable *IdTable
Douglas Gregora868bbd2009-04-21 22:25:48 +00002254 = (PCHIdentifierLookupTable *)IdentifierLookupTable;
2255 std::pair<const char*, unsigned> Key(NameStart, NameEnd - NameStart);
2256 PCHIdentifierLookupTable::iterator Pos = IdTable->find(Key);
2257 if (Pos == IdTable->end())
2258 return 0;
2259
2260 // Dereferencing the iterator has the effect of building the
2261 // IdentifierInfo node and populating it with the various
2262 // declarations it needs.
2263 return *Pos;
2264}
2265
Mike Stump11289f42009-09-09 15:08:12 +00002266std::pair<ObjCMethodList, ObjCMethodList>
Douglas Gregorc78d3462009-04-24 21:10:55 +00002267PCHReader::ReadMethodPool(Selector Sel) {
2268 if (!MethodPoolLookupTable)
2269 return std::pair<ObjCMethodList, ObjCMethodList>();
2270
2271 // Try to find this selector within our on-disk hash table.
2272 PCHMethodPoolLookupTable *PoolTable
2273 = (PCHMethodPoolLookupTable*)MethodPoolLookupTable;
2274 PCHMethodPoolLookupTable::iterator Pos = PoolTable->find(Sel);
Douglas Gregor95c13f52009-04-25 17:48:32 +00002275 if (Pos == PoolTable->end()) {
2276 ++NumMethodPoolMisses;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002277 return std::pair<ObjCMethodList, ObjCMethodList>();;
Douglas Gregor95c13f52009-04-25 17:48:32 +00002278 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00002279
Douglas Gregor95c13f52009-04-25 17:48:32 +00002280 ++NumMethodPoolSelectorsRead;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002281 return *Pos;
2282}
2283
Douglas Gregor0e149972009-04-25 19:10:14 +00002284void PCHReader::SetIdentifierInfo(unsigned ID, IdentifierInfo *II) {
Douglas Gregora868bbd2009-04-21 22:25:48 +00002285 assert(ID && "Non-zero identifier ID required");
Douglas Gregor6f00bf82009-04-28 21:53:25 +00002286 assert(ID <= IdentifiersLoaded.size() && "identifier ID out of range");
Douglas Gregor0e149972009-04-25 19:10:14 +00002287 IdentifiersLoaded[ID - 1] = II;
Douglas Gregora868bbd2009-04-21 22:25:48 +00002288}
2289
Douglas Gregor1342e842009-07-06 18:54:52 +00002290/// \brief Set the globally-visible declarations associated with the given
2291/// identifier.
2292///
2293/// If the PCH reader is currently in a state where the given declaration IDs
Mike Stump11289f42009-09-09 15:08:12 +00002294/// cannot safely be resolved, they are queued until it is safe to resolve
Douglas Gregor1342e842009-07-06 18:54:52 +00002295/// them.
2296///
2297/// \param II an IdentifierInfo that refers to one or more globally-visible
2298/// declarations.
2299///
2300/// \param DeclIDs the set of declaration IDs with the name @p II that are
2301/// visible at global scope.
2302///
2303/// \param Nonrecursive should be true to indicate that the caller knows that
2304/// this call is non-recursive, and therefore the globally-visible declarations
2305/// will not be placed onto the pending queue.
Mike Stump11289f42009-09-09 15:08:12 +00002306void
2307PCHReader::SetGloballyVisibleDecls(IdentifierInfo *II,
Douglas Gregor1342e842009-07-06 18:54:52 +00002308 const llvm::SmallVectorImpl<uint32_t> &DeclIDs,
2309 bool Nonrecursive) {
2310 if (CurrentlyLoadingTypeOrDecl && !Nonrecursive) {
2311 PendingIdentifierInfos.push_back(PendingIdentifierInfo());
2312 PendingIdentifierInfo &PII = PendingIdentifierInfos.back();
2313 PII.II = II;
2314 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I)
2315 PII.DeclIDs.push_back(DeclIDs[I]);
2316 return;
2317 }
Mike Stump11289f42009-09-09 15:08:12 +00002318
Douglas Gregor1342e842009-07-06 18:54:52 +00002319 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I) {
2320 NamedDecl *D = cast<NamedDecl>(GetDecl(DeclIDs[I]));
2321 if (SemaObj) {
2322 // Introduce this declaration into the translation-unit scope
2323 // and add it to the declaration chain for this identifier, so
2324 // that (unqualified) name lookup will find it.
2325 SemaObj->TUScope->AddDecl(Action::DeclPtrTy::make(D));
2326 SemaObj->IdResolver.AddDeclToIdentifierChain(II, D);
2327 } else {
2328 // Queue this declaration so that it will be added to the
2329 // translation unit scope and identifier's declaration chain
2330 // once a Sema object is known.
2331 PreloadedDecls.push_back(D);
2332 }
2333 }
2334}
2335
Chris Lattnerc523d8e2009-04-11 21:15:38 +00002336IdentifierInfo *PCHReader::DecodeIdentifierInfo(unsigned ID) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00002337 if (ID == 0)
2338 return 0;
Mike Stump11289f42009-09-09 15:08:12 +00002339
Douglas Gregor0e149972009-04-25 19:10:14 +00002340 if (!IdentifierTableData || IdentifiersLoaded.empty()) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00002341 Error("no identifier table in PCH file");
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00002342 return 0;
2343 }
Mike Stump11289f42009-09-09 15:08:12 +00002344
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00002345 assert(PP && "Forgot to set Preprocessor ?");
Douglas Gregor0e149972009-04-25 19:10:14 +00002346 if (!IdentifiersLoaded[ID - 1]) {
2347 uint32_t Offset = IdentifierOffsets[ID - 1];
Douglas Gregor95272492009-04-25 21:21:38 +00002348 const char *Str = IdentifierTableData + Offset;
Douglas Gregor5287b4e2009-04-25 21:04:17 +00002349
Douglas Gregorab4df582009-04-28 20:01:51 +00002350 // All of the strings in the PCH file are preceded by a 16-bit
2351 // length. Extract that 16-bit length to avoid having to execute
2352 // strlen().
2353 const char *StrLenPtr = Str - 2;
2354 unsigned StrLen = (((unsigned) StrLenPtr[0])
2355 | (((unsigned) StrLenPtr[1]) << 8)) - 1;
Mike Stump11289f42009-09-09 15:08:12 +00002356 IdentifiersLoaded[ID - 1]
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00002357 = &PP->getIdentifierTable().get(Str, Str + StrLen);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00002358 }
Mike Stump11289f42009-09-09 15:08:12 +00002359
Douglas Gregor0e149972009-04-25 19:10:14 +00002360 return IdentifiersLoaded[ID - 1];
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002361}
2362
Douglas Gregor258ae542009-04-27 06:38:32 +00002363void PCHReader::ReadSLocEntry(unsigned ID) {
2364 ReadSLocEntryRecord(ID);
2365}
2366
Steve Naroff2ddea052009-04-23 10:39:46 +00002367Selector PCHReader::DecodeSelector(unsigned ID) {
2368 if (ID == 0)
2369 return Selector();
Mike Stump11289f42009-09-09 15:08:12 +00002370
Douglas Gregor6f00bf82009-04-28 21:53:25 +00002371 if (!MethodPoolLookupTableData)
Steve Naroff2ddea052009-04-23 10:39:46 +00002372 return Selector();
Douglas Gregor95c13f52009-04-25 17:48:32 +00002373
2374 if (ID > TotalNumSelectors) {
Douglas Gregor6f00bf82009-04-28 21:53:25 +00002375 Error("selector ID out of range in PCH file");
Steve Naroff2ddea052009-04-23 10:39:46 +00002376 return Selector();
2377 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00002378
2379 unsigned Index = ID - 1;
2380 if (SelectorsLoaded[Index].getAsOpaquePtr() == 0) {
2381 // Load this selector from the selector table.
2382 // FIXME: endianness portability issues with SelectorOffsets table
2383 PCHMethodPoolLookupTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00002384 SelectorsLoaded[Index]
Douglas Gregor95c13f52009-04-25 17:48:32 +00002385 = Trait.ReadKey(MethodPoolLookupTableData + SelectorOffsets[Index], 0);
2386 }
2387
2388 return SelectorsLoaded[Index];
Steve Naroff2ddea052009-04-23 10:39:46 +00002389}
2390
Mike Stump11289f42009-09-09 15:08:12 +00002391DeclarationName
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002392PCHReader::ReadDeclarationName(const RecordData &Record, unsigned &Idx) {
2393 DeclarationName::NameKind Kind = (DeclarationName::NameKind)Record[Idx++];
2394 switch (Kind) {
2395 case DeclarationName::Identifier:
2396 return DeclarationName(GetIdentifierInfo(Record, Idx));
2397
2398 case DeclarationName::ObjCZeroArgSelector:
2399 case DeclarationName::ObjCOneArgSelector:
2400 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff3c301dc2009-04-23 15:15:40 +00002401 return DeclarationName(GetSelector(Record, Idx));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002402
2403 case DeclarationName::CXXConstructorName:
Chris Lattner8575daa2009-04-27 21:45:14 +00002404 return Context->DeclarationNames.getCXXConstructorName(
Douglas Gregor2211d342009-08-05 05:36:45 +00002405 Context->getCanonicalType(GetType(Record[Idx++])));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002406
2407 case DeclarationName::CXXDestructorName:
Chris Lattner8575daa2009-04-27 21:45:14 +00002408 return Context->DeclarationNames.getCXXDestructorName(
Douglas Gregor2211d342009-08-05 05:36:45 +00002409 Context->getCanonicalType(GetType(Record[Idx++])));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002410
2411 case DeclarationName::CXXConversionFunctionName:
Chris Lattner8575daa2009-04-27 21:45:14 +00002412 return Context->DeclarationNames.getCXXConversionFunctionName(
Douglas Gregor2211d342009-08-05 05:36:45 +00002413 Context->getCanonicalType(GetType(Record[Idx++])));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002414
2415 case DeclarationName::CXXOperatorName:
Chris Lattner8575daa2009-04-27 21:45:14 +00002416 return Context->DeclarationNames.getCXXOperatorName(
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002417 (OverloadedOperatorKind)Record[Idx++]);
2418
2419 case DeclarationName::CXXUsingDirective:
2420 return DeclarationName::getUsingDirectiveName();
2421 }
2422
2423 // Required to silence GCC warning
2424 return DeclarationName();
2425}
Douglas Gregor55abb232009-04-10 20:39:37 +00002426
Douglas Gregor1daeb692009-04-13 18:14:40 +00002427/// \brief Read an integral value
2428llvm::APInt PCHReader::ReadAPInt(const RecordData &Record, unsigned &Idx) {
2429 unsigned BitWidth = Record[Idx++];
2430 unsigned NumWords = llvm::APInt::getNumWords(BitWidth);
2431 llvm::APInt Result(BitWidth, NumWords, &Record[Idx]);
2432 Idx += NumWords;
2433 return Result;
2434}
2435
2436/// \brief Read a signed integral value
2437llvm::APSInt PCHReader::ReadAPSInt(const RecordData &Record, unsigned &Idx) {
2438 bool isUnsigned = Record[Idx++];
2439 return llvm::APSInt(ReadAPInt(Record, Idx), isUnsigned);
2440}
2441
Douglas Gregore0a3a512009-04-14 21:55:33 +00002442/// \brief Read a floating-point value
2443llvm::APFloat PCHReader::ReadAPFloat(const RecordData &Record, unsigned &Idx) {
Douglas Gregore0a3a512009-04-14 21:55:33 +00002444 return llvm::APFloat(ReadAPInt(Record, Idx));
2445}
2446
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002447// \brief Read a string
2448std::string PCHReader::ReadString(const RecordData &Record, unsigned &Idx) {
2449 unsigned Len = Record[Idx++];
Jay Foad7d0479f2009-05-21 09:52:38 +00002450 std::string Result(Record.data() + Idx, Record.data() + Idx + Len);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002451 Idx += Len;
2452 return Result;
2453}
2454
Douglas Gregor55abb232009-04-10 20:39:37 +00002455DiagnosticBuilder PCHReader::Diag(unsigned DiagID) {
Douglas Gregor92863e42009-04-10 23:10:45 +00002456 return Diag(SourceLocation(), DiagID);
2457}
2458
2459DiagnosticBuilder PCHReader::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00002460 return Diags.Report(FullSourceLoc(Loc, SourceMgr), DiagID);
Douglas Gregor55abb232009-04-10 20:39:37 +00002461}
Douglas Gregora9af1d12009-04-17 00:04:06 +00002462
Douglas Gregora868bbd2009-04-21 22:25:48 +00002463/// \brief Retrieve the identifier table associated with the
2464/// preprocessor.
2465IdentifierTable &PCHReader::getIdentifierTable() {
Argyrios Kyrtzidis366985d2009-06-19 00:03:23 +00002466 assert(PP && "Forgot to set Preprocessor ?");
2467 return PP->getIdentifierTable();
Douglas Gregora868bbd2009-04-21 22:25:48 +00002468}
2469
Douglas Gregora9af1d12009-04-17 00:04:06 +00002470/// \brief Record that the given ID maps to the given switch-case
2471/// statement.
2472void PCHReader::RecordSwitchCaseID(SwitchCase *SC, unsigned ID) {
2473 assert(SwitchCaseStmts[ID] == 0 && "Already have a SwitchCase with this ID");
2474 SwitchCaseStmts[ID] = SC;
2475}
2476
2477/// \brief Retrieve the switch-case statement with the given ID.
2478SwitchCase *PCHReader::getSwitchCaseWithID(unsigned ID) {
2479 assert(SwitchCaseStmts[ID] != 0 && "No SwitchCase with this ID");
2480 return SwitchCaseStmts[ID];
2481}
Douglas Gregor6cc68a42009-04-17 18:18:49 +00002482
2483/// \brief Record that the given label statement has been
2484/// deserialized and has the given ID.
2485void PCHReader::RecordLabelStmt(LabelStmt *S, unsigned ID) {
Mike Stump11289f42009-09-09 15:08:12 +00002486 assert(LabelStmts.find(ID) == LabelStmts.end() &&
Douglas Gregor6cc68a42009-04-17 18:18:49 +00002487 "Deserialized label twice");
2488 LabelStmts[ID] = S;
2489
2490 // If we've already seen any goto statements that point to this
2491 // label, resolve them now.
2492 typedef std::multimap<unsigned, GotoStmt *>::iterator GotoIter;
2493 std::pair<GotoIter, GotoIter> Gotos = UnresolvedGotoStmts.equal_range(ID);
2494 for (GotoIter Goto = Gotos.first; Goto != Gotos.second; ++Goto)
2495 Goto->second->setLabel(S);
2496 UnresolvedGotoStmts.erase(Gotos.first, Gotos.second);
Douglas Gregor779d8652009-04-17 18:58:21 +00002497
2498 // If we've already seen any address-label statements that point to
2499 // this label, resolve them now.
2500 typedef std::multimap<unsigned, AddrLabelExpr *>::iterator AddrLabelIter;
Mike Stump11289f42009-09-09 15:08:12 +00002501 std::pair<AddrLabelIter, AddrLabelIter> AddrLabels
Douglas Gregor779d8652009-04-17 18:58:21 +00002502 = UnresolvedAddrLabelExprs.equal_range(ID);
Mike Stump11289f42009-09-09 15:08:12 +00002503 for (AddrLabelIter AddrLabel = AddrLabels.first;
Douglas Gregor779d8652009-04-17 18:58:21 +00002504 AddrLabel != AddrLabels.second; ++AddrLabel)
2505 AddrLabel->second->setLabel(S);
2506 UnresolvedAddrLabelExprs.erase(AddrLabels.first, AddrLabels.second);
Douglas Gregor6cc68a42009-04-17 18:18:49 +00002507}
2508
2509/// \brief Set the label of the given statement to the label
2510/// identified by ID.
2511///
2512/// Depending on the order in which the label and other statements
2513/// referencing that label occur, this operation may complete
2514/// immediately (updating the statement) or it may queue the
2515/// statement to be back-patched later.
2516void PCHReader::SetLabelOf(GotoStmt *S, unsigned ID) {
2517 std::map<unsigned, LabelStmt *>::iterator Label = LabelStmts.find(ID);
2518 if (Label != LabelStmts.end()) {
2519 // We've already seen this label, so set the label of the goto and
2520 // we're done.
2521 S->setLabel(Label->second);
2522 } else {
2523 // We haven't seen this label yet, so add this goto to the set of
2524 // unresolved goto statements.
2525 UnresolvedGotoStmts.insert(std::make_pair(ID, S));
2526 }
2527}
Douglas Gregor779d8652009-04-17 18:58:21 +00002528
2529/// \brief Set the label of the given expression to the label
2530/// identified by ID.
2531///
2532/// Depending on the order in which the label and other statements
2533/// referencing that label occur, this operation may complete
2534/// immediately (updating the statement) or it may queue the
2535/// statement to be back-patched later.
2536void PCHReader::SetLabelOf(AddrLabelExpr *S, unsigned ID) {
2537 std::map<unsigned, LabelStmt *>::iterator Label = LabelStmts.find(ID);
2538 if (Label != LabelStmts.end()) {
2539 // We've already seen this label, so set the label of the
2540 // label-address expression and we're done.
2541 S->setLabel(Label->second);
2542 } else {
2543 // We haven't seen this label yet, so add this label-address
2544 // expression to the set of unresolved label-address expressions.
2545 UnresolvedAddrLabelExprs.insert(std::make_pair(ID, S));
2546 }
2547}
Douglas Gregor1342e842009-07-06 18:54:52 +00002548
2549
Mike Stump11289f42009-09-09 15:08:12 +00002550PCHReader::LoadingTypeOrDecl::LoadingTypeOrDecl(PCHReader &Reader)
Douglas Gregor1342e842009-07-06 18:54:52 +00002551 : Reader(Reader), Parent(Reader.CurrentlyLoadingTypeOrDecl) {
2552 Reader.CurrentlyLoadingTypeOrDecl = this;
2553}
2554
2555PCHReader::LoadingTypeOrDecl::~LoadingTypeOrDecl() {
2556 if (!Parent) {
2557 // If any identifiers with corresponding top-level declarations have
2558 // been loaded, load those declarations now.
2559 while (!Reader.PendingIdentifierInfos.empty()) {
2560 Reader.SetGloballyVisibleDecls(Reader.PendingIdentifierInfos.front().II,
2561 Reader.PendingIdentifierInfos.front().DeclIDs,
2562 true);
2563 Reader.PendingIdentifierInfos.pop_front();
2564 }
2565 }
2566
Mike Stump11289f42009-09-09 15:08:12 +00002567 Reader.CurrentlyLoadingTypeOrDecl = Parent;
Douglas Gregor1342e842009-07-06 18:54:52 +00002568}