HeaderSearch.h revision e434ec71fccfe078906403affd641f709702d598
1//===--- HeaderSearch.h - Resolve Header File Locations ---------*- 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 HeaderSearch interface. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_CLANG_LEX_HEADERSEARCH_H 15#define LLVM_CLANG_LEX_HEADERSEARCH_H 16 17#include "clang/Lex/DirectoryLookup.h" 18#include "clang/Lex/ModuleMap.h" 19#include "llvm/ADT/StringMap.h" 20#include "llvm/ADT/StringSet.h" 21#include "llvm/Support/Allocator.h" 22#include <vector> 23 24namespace clang { 25 26class DiagnosticsEngine; 27class ExternalIdentifierLookup; 28class FileEntry; 29class FileManager; 30class IdentifierInfo; 31 32/// HeaderFileInfo - The preprocessor keeps track of this information for each 33/// file that is #included. 34struct HeaderFileInfo { 35 /// isImport - True if this is a #import'd or #pragma once file. 36 unsigned isImport : 1; 37 38 /// isPragmaOnce - True if this is #pragma once file. 39 unsigned isPragmaOnce : 1; 40 41 /// DirInfo - Keep track of whether this is a system header, and if so, 42 /// whether it is C++ clean or not. This can be set by the include paths or 43 /// by #pragma gcc system_header. This is an instance of 44 /// SrcMgr::CharacteristicKind. 45 unsigned DirInfo : 2; 46 47 /// \brief Whether this header file info was supplied by an external source. 48 unsigned External : 1; 49 50 /// \brief Whether this structure is considered to already have been 51 /// "resolved", meaning that it was loaded from the external source. 52 unsigned Resolved : 1; 53 54 /// \brief Whether this is a header inside a framework that is currently 55 /// being built. 56 /// 57 /// When a framework is being built, the headers have not yet been placed 58 /// into the appropriate framework subdirectories, and therefore are 59 /// provided via a header map. This bit indicates when this is one of 60 /// those framework headers. 61 unsigned IndexHeaderMapHeader : 1; 62 63 /// NumIncludes - This is the number of times the file has been included 64 /// already. 65 unsigned short NumIncludes; 66 67 /// \brief The ID number of the controlling macro. 68 /// 69 /// This ID number will be non-zero when there is a controlling 70 /// macro whose IdentifierInfo may not yet have been loaded from 71 /// external storage. 72 unsigned ControllingMacroID; 73 74 /// ControllingMacro - If this file has a #ifndef XXX (or equivalent) guard 75 /// that protects the entire contents of the file, this is the identifier 76 /// for the macro that controls whether or not it has any effect. 77 /// 78 /// Note: Most clients should use getControllingMacro() to access 79 /// the controlling macro of this header, since 80 /// getControllingMacro() is able to load a controlling macro from 81 /// external storage. 82 const IdentifierInfo *ControllingMacro; 83 84 /// \brief If this header came from a framework include, this is the name 85 /// of the framework. 86 StringRef Framework; 87 88 HeaderFileInfo() 89 : isImport(false), isPragmaOnce(false), DirInfo(SrcMgr::C_User), 90 External(false), Resolved(false), IndexHeaderMapHeader(false), 91 NumIncludes(0), ControllingMacroID(0), ControllingMacro(0) {} 92 93 /// \brief Retrieve the controlling macro for this header file, if 94 /// any. 95 const IdentifierInfo *getControllingMacro(ExternalIdentifierLookup *External); 96 97 /// \brief Determine whether this is a non-default header file info, e.g., 98 /// it corresponds to an actual header we've included or tried to include. 99 bool isNonDefault() const { 100 return isImport || isPragmaOnce || NumIncludes || ControllingMacro || 101 ControllingMacroID; 102 } 103}; 104 105/// \brief An external source of header file information, which may supply 106/// information about header files already included. 107class ExternalHeaderFileInfoSource { 108public: 109 virtual ~ExternalHeaderFileInfoSource(); 110 111 /// \brief Retrieve the header file information for the given file entry. 112 /// 113 /// \returns Header file information for the given file entry, with the 114 /// \c External bit set. If the file entry is not known, return a 115 /// default-constructed \c HeaderFileInfo. 116 virtual HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) = 0; 117}; 118 119/// HeaderSearch - This class encapsulates the information needed to find the 120/// file referenced by a #include or #include_next, (sub-)framework lookup, etc. 121class HeaderSearch { 122 FileManager &FileMgr; 123 DiagnosticsEngine &Diags; 124 /// #include search path information. Requests for #include "x" search the 125 /// directory of the #including file first, then each directory in SearchDirs 126 /// consecutively. Requests for <x> search the current dir first, then each 127 /// directory in SearchDirs, starting at AngledDirIdx, consecutively. If 128 /// NoCurDirSearch is true, then the check for the file in the current 129 /// directory is suppressed. 130 std::vector<DirectoryLookup> SearchDirs; 131 unsigned AngledDirIdx; 132 unsigned SystemDirIdx; 133 bool NoCurDirSearch; 134 135 /// \brief The path to the module cache. 136 std::string ModuleCachePath; 137 138 /// FileInfo - This contains all of the preprocessor-specific data about files 139 /// that are included. The vector is indexed by the FileEntry's UID. 140 /// 141 std::vector<HeaderFileInfo> FileInfo; 142 143 /// LookupFileCache - This is keeps track of each lookup performed by 144 /// LookupFile. The first part of the value is the starting index in 145 /// SearchDirs that the cached search was performed from. If there is a hit 146 /// and this value doesn't match the current query, the cache has to be 147 /// ignored. The second value is the entry in SearchDirs that satisfied the 148 /// query. 149 llvm::StringMap<std::pair<unsigned, unsigned>, llvm::BumpPtrAllocator> 150 LookupFileCache; 151 152 /// FrameworkMap - This is a collection mapping a framework or subframework 153 /// name like "Carbon" to the Carbon.framework directory. 154 llvm::StringMap<const DirectoryEntry *, llvm::BumpPtrAllocator> 155 FrameworkMap; 156 157 /// HeaderMaps - This is a mapping from FileEntry -> HeaderMap, uniquing 158 /// headermaps. This vector owns the headermap. 159 std::vector<std::pair<const FileEntry*, const HeaderMap*> > HeaderMaps; 160 161 /// \brief The mapping between modules and headers. 162 ModuleMap ModMap; 163 164 /// \brief Describes whether a given directory has a module map in it. 165 llvm::DenseMap<const DirectoryEntry *, bool> DirectoryHasModuleMap; 166 167 /// \brief Uniqued set of framework names, which is used to track which 168 /// headers were included as framework headers. 169 llvm::StringSet<llvm::BumpPtrAllocator> FrameworkNames; 170 171 /// \brief Entity used to resolve the identifier IDs of controlling 172 /// macros into IdentifierInfo pointers, as needed. 173 ExternalIdentifierLookup *ExternalLookup; 174 175 /// \brief Entity used to look up stored header file information. 176 ExternalHeaderFileInfoSource *ExternalSource; 177 178 // Various statistics we track for performance analysis. 179 unsigned NumIncluded; 180 unsigned NumMultiIncludeFileOptzn; 181 unsigned NumFrameworkLookups, NumSubFrameworkLookups; 182 183 // HeaderSearch doesn't support default or copy construction. 184 explicit HeaderSearch(); 185 explicit HeaderSearch(const HeaderSearch&); 186 void operator=(const HeaderSearch&); 187 188 friend class DirectoryLookup; 189 190public: 191 HeaderSearch(FileManager &FM, DiagnosticsEngine &Diags, 192 const LangOptions &LangOpts); 193 ~HeaderSearch(); 194 195 FileManager &getFileMgr() const { return FileMgr; } 196 197 /// SetSearchPaths - Interface for setting the file search paths. 198 /// 199 void SetSearchPaths(const std::vector<DirectoryLookup> &dirs, 200 unsigned angledDirIdx, unsigned systemDirIdx, 201 bool noCurDirSearch) { 202 assert(angledDirIdx <= systemDirIdx && systemDirIdx <= dirs.size() && 203 "Directory indicies are unordered"); 204 SearchDirs = dirs; 205 AngledDirIdx = angledDirIdx; 206 SystemDirIdx = systemDirIdx; 207 NoCurDirSearch = noCurDirSearch; 208 //LookupFileCache.clear(); 209 } 210 211 /// AddSearchPath - Add an additional search path. 212 void AddSearchPath(const DirectoryLookup &dir, bool isAngled) { 213 unsigned idx = isAngled ? SystemDirIdx : AngledDirIdx; 214 SearchDirs.insert(SearchDirs.begin() + idx, dir); 215 if (!isAngled) 216 AngledDirIdx++; 217 SystemDirIdx++; 218 } 219 220 /// \brief Set the path to the module cache. 221 void setModuleCachePath(StringRef CachePath) { 222 ModuleCachePath = CachePath; 223 } 224 225 /// \brief Retrieve the path to the module cache. 226 StringRef getModuleCachePath() const { return ModuleCachePath; } 227 228 /// ClearFileInfo - Forget everything we know about headers so far. 229 void ClearFileInfo() { 230 FileInfo.clear(); 231 } 232 233 void SetExternalLookup(ExternalIdentifierLookup *EIL) { 234 ExternalLookup = EIL; 235 } 236 237 ExternalIdentifierLookup *getExternalLookup() const { 238 return ExternalLookup; 239 } 240 241 /// \brief Set the external source of header information. 242 void SetExternalSource(ExternalHeaderFileInfoSource *ES) { 243 ExternalSource = ES; 244 } 245 246 /// LookupFile - Given a "foo" or <foo> reference, look up the indicated file, 247 /// return null on failure. 248 /// 249 /// \returns If successful, this returns 'UsedDir', the DirectoryLookup member 250 /// the file was found in, or null if not applicable. 251 /// 252 /// \param isAngled indicates whether the file reference is a <> reference. 253 /// 254 /// \param CurDir If non-null, the file was found in the specified directory 255 /// search location. This is used to implement #include_next. 256 /// 257 /// \param CurFileEnt If non-null, indicates where the #including file is, in 258 /// case a relative search is needed. 259 /// 260 /// \param SearchPath If non-null, will be set to the search path relative 261 /// to which the file was found. If the include path is absolute, SearchPath 262 /// will be set to an empty string. 263 /// 264 /// \param RelativePath If non-null, will be set to the path relative to 265 /// SearchPath at which the file was found. This only differs from the 266 /// Filename for framework includes. 267 /// 268 /// \param SuggestedModule If non-null, and the file found is semantically 269 /// part of a known module, this will be set to the module that should 270 /// be imported instead of preprocessing/parsing the file found. 271 const FileEntry *LookupFile(StringRef Filename, bool isAngled, 272 const DirectoryLookup *FromDir, 273 const DirectoryLookup *&CurDir, 274 const FileEntry *CurFileEnt, 275 SmallVectorImpl<char> *SearchPath, 276 SmallVectorImpl<char> *RelativePath, 277 Module **SuggestedModule, 278 bool SkipCache = false); 279 280 /// LookupSubframeworkHeader - Look up a subframework for the specified 281 /// #include file. For example, if #include'ing <HIToolbox/HIToolbox.h> from 282 /// within ".../Carbon.framework/Headers/Carbon.h", check to see if HIToolbox 283 /// is a subframework within Carbon.framework. If so, return the FileEntry 284 /// for the designated file, otherwise return null. 285 const FileEntry *LookupSubframeworkHeader( 286 StringRef Filename, 287 const FileEntry *RelativeFileEnt, 288 SmallVectorImpl<char> *SearchPath, 289 SmallVectorImpl<char> *RelativePath); 290 291 /// LookupFrameworkCache - Look up the specified framework name in our 292 /// framework cache, returning the DirectoryEntry it is in if we know, 293 /// otherwise, return null. 294 const DirectoryEntry *&LookupFrameworkCache(StringRef FWName) { 295 return FrameworkMap.GetOrCreateValue(FWName).getValue(); 296 } 297 298 /// ShouldEnterIncludeFile - Mark the specified file as a target of of a 299 /// #include, #include_next, or #import directive. Return false if #including 300 /// the file will have no effect or true if we should include it. 301 bool ShouldEnterIncludeFile(const FileEntry *File, bool isImport); 302 303 304 /// getFileDirFlavor - Return whether the specified file is a normal header, 305 /// a system header, or a C++ friendly system header. 306 SrcMgr::CharacteristicKind getFileDirFlavor(const FileEntry *File) { 307 return (SrcMgr::CharacteristicKind)getFileInfo(File).DirInfo; 308 } 309 310 /// MarkFileIncludeOnce - Mark the specified file as a "once only" file, e.g. 311 /// due to #pragma once. 312 void MarkFileIncludeOnce(const FileEntry *File) { 313 HeaderFileInfo &FI = getFileInfo(File); 314 FI.isImport = true; 315 FI.isPragmaOnce = true; 316 } 317 318 /// MarkFileSystemHeader - Mark the specified file as a system header, e.g. 319 /// due to #pragma GCC system_header. 320 void MarkFileSystemHeader(const FileEntry *File) { 321 getFileInfo(File).DirInfo = SrcMgr::C_System; 322 } 323 324 /// IncrementIncludeCount - Increment the count for the number of times the 325 /// specified FileEntry has been entered. 326 void IncrementIncludeCount(const FileEntry *File) { 327 ++getFileInfo(File).NumIncludes; 328 } 329 330 /// SetFileControllingMacro - Mark the specified file as having a controlling 331 /// macro. This is used by the multiple-include optimization to eliminate 332 /// no-op #includes. 333 void SetFileControllingMacro(const FileEntry *File, 334 const IdentifierInfo *ControllingMacro) { 335 getFileInfo(File).ControllingMacro = ControllingMacro; 336 } 337 338 /// \brief Determine whether this file is intended to be safe from 339 /// multiple inclusions, e.g., it has #pragma once or a controlling 340 /// macro. 341 /// 342 /// This routine does not consider the effect of #import 343 bool isFileMultipleIncludeGuarded(const FileEntry *File); 344 345 /// CreateHeaderMap - This method returns a HeaderMap for the specified 346 /// FileEntry, uniquing them through the the 'HeaderMaps' datastructure. 347 const HeaderMap *CreateHeaderMap(const FileEntry *FE); 348 349 /// \brief Retrieve the name of the module file that should be used to 350 /// load the given module. 351 /// 352 /// \param Module The module whose module file name will be returned. 353 /// 354 /// \returns The name of the module file that corresponds to this module, 355 /// or an empty string if this module does not correspond to any module file. 356 std::string getModuleFileName(Module *Module); 357 358 /// \brief Retrieve the name of the module file that should be used to 359 /// load a module with the given name. 360 /// 361 /// \param Module The module whose module file name will be returned. 362 /// 363 /// \returns The name of the module file that corresponds to this module, 364 /// or an empty string if this module does not correspond to any module file. 365 std::string getModuleFileName(StringRef ModuleName); 366 367 /// \brief Lookup a module Search for a module with the given name. 368 /// 369 /// \param ModuleName The name of the module we're looking for. 370 /// 371 /// \param AllowSearch Whether we are allowed to search in the various 372 /// search directories to produce a module definition. If not, this lookup 373 /// will only return an already-known module. 374 /// 375 /// \returns The module with the given name. 376 Module *lookupModule(StringRef ModuleName, bool AllowSearch = true); 377 378 void IncrementFrameworkLookupCount() { ++NumFrameworkLookups; } 379 380 /// \brief Determine whether there is a module map that may map the header 381 /// with the given file name to a (sub)module. 382 /// 383 /// \param Filename The name of the file. 384 /// 385 /// \param Root The "root" directory, at which we should stop looking for 386 /// module maps. 387 bool hasModuleMap(StringRef Filename, const DirectoryEntry *Root); 388 389 /// \brief Retrieve the module that corresponds to the given file, if any. 390 /// 391 /// \param File The header that we wish to map to a module. 392 Module *findModuleForHeader(const FileEntry *File); 393 394 395 /// \brief Read the contents of the given module map file. 396 /// 397 /// \param File The module map file. 398 /// 399 /// \param OnlyModule If non-NULL, this will receive the 400 /// 401 /// \returns true if an error occurred, false otherwise. 402 bool loadModuleMapFile(const FileEntry *File); 403 404private: 405 /// \brief Retrieve a module with the given name, which may be part of the 406 /// given framework. 407 /// 408 /// \param Name The name of the module to retrieve. 409 /// 410 /// \param Dir The framework directory (e.g., ModuleName.framework). 411 /// 412 /// \param IsSystem Whether the framework directory is part of the system 413 /// frameworks. 414 /// 415 /// \returns The module, if found; otherwise, null. 416 Module *loadFrameworkModule(StringRef Name, 417 const DirectoryEntry *Dir, 418 bool IsSystem); 419 420public: 421 /// \brief Retrieve the module map. 422 ModuleMap &getModuleMap() { return ModMap; } 423 424 unsigned header_file_size() const { return FileInfo.size(); } 425 426 // Used by ASTReader. 427 void setHeaderFileInfoForUID(HeaderFileInfo HFI, unsigned UID); 428 429 /// getFileInfo - Return the HeaderFileInfo structure for the specified 430 /// FileEntry. 431 const HeaderFileInfo &getFileInfo(const FileEntry *FE) const { 432 return const_cast<HeaderSearch*>(this)->getFileInfo(FE); 433 } 434 435 // Used by external tools 436 typedef std::vector<DirectoryLookup>::const_iterator search_dir_iterator; 437 search_dir_iterator search_dir_begin() const { return SearchDirs.begin(); } 438 search_dir_iterator search_dir_end() const { return SearchDirs.end(); } 439 unsigned search_dir_size() const { return SearchDirs.size(); } 440 441 search_dir_iterator quoted_dir_begin() const { 442 return SearchDirs.begin(); 443 } 444 search_dir_iterator quoted_dir_end() const { 445 return SearchDirs.begin() + AngledDirIdx; 446 } 447 448 search_dir_iterator angled_dir_begin() const { 449 return SearchDirs.begin() + AngledDirIdx; 450 } 451 search_dir_iterator angled_dir_end() const { 452 return SearchDirs.begin() + SystemDirIdx; 453 } 454 455 search_dir_iterator system_dir_begin() const { 456 return SearchDirs.begin() + SystemDirIdx; 457 } 458 search_dir_iterator system_dir_end() const { return SearchDirs.end(); } 459 460 /// \brief Retrieve a uniqued framework name. 461 StringRef getUniqueFrameworkName(StringRef Framework); 462 463 void PrintStats(); 464 465 size_t getTotalMemory() const; 466 467 static std::string NormalizeDashIncludePath(StringRef File, 468 FileManager &FileMgr); 469 470private: 471 /// \brief Describes what happened when we tried to load a module map file. 472 enum LoadModuleMapResult { 473 /// \brief The module map file had already been loaded. 474 LMM_AlreadyLoaded, 475 /// \brief The module map file was loaded by this invocation. 476 LMM_NewlyLoaded, 477 /// \brief There is was directory with the given name. 478 LMM_NoDirectory, 479 /// \brief There was either no module map file or the module map file was 480 /// invalid. 481 LMM_InvalidModuleMap 482 }; 483 484 /// \brief Try to load the module map file in the given directory. 485 /// 486 /// \param DirName The name of the directory where we will look for a module 487 /// map file. 488 /// 489 /// \returns The result of attempting to load the module map file from the 490 /// named directory. 491 LoadModuleMapResult loadModuleMapFile(StringRef DirName); 492 493 /// \brief Try to load the module map file in the given directory. 494 /// 495 /// \param Dir The directory where we will look for a module map file. 496 /// 497 /// \returns The result of attempting to load the module map file from the 498 /// named directory. 499 LoadModuleMapResult loadModuleMapFile(const DirectoryEntry *Dir); 500 501 /// getFileInfo - Return the HeaderFileInfo structure for the specified 502 /// FileEntry. 503 HeaderFileInfo &getFileInfo(const FileEntry *FE); 504}; 505 506} // end namespace clang 507 508#endif 509