1 //===--- InitHeaderSearch.cpp - Initialize header search paths ------------===//
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 implements the InitHeaderSearch class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Frontend/Utils.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/LangOptions.h"
17 #include "clang/Config/config.h" // C_INCLUDE_DIRS
18 #include "clang/Lex/HeaderSearch.h"
19 #include "clang/Lex/HeaderSearchOptions.h"
20 #include "llvm/ADT/SmallPtrSet.h"
21 #include "llvm/ADT/SmallString.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/StringExtras.h"
24 #include "llvm/ADT/Triple.h"
25 #include "llvm/ADT/Twine.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/raw_ostream.h"
30 
31 using namespace clang;
32 using namespace clang::frontend;
33 
34 namespace {
35 
36 /// InitHeaderSearch - This class makes it easier to set the search paths of
37 ///  a HeaderSearch object. InitHeaderSearch stores several search path lists
38 ///  internally, which can be sent to a HeaderSearch object in one swoop.
39 class InitHeaderSearch {
40   std::vector<std::pair<IncludeDirGroup, DirectoryLookup> > IncludePath;
41   typedef std::vector<std::pair<IncludeDirGroup,
42                       DirectoryLookup> >::const_iterator path_iterator;
43   std::vector<std::pair<std::string, bool> > SystemHeaderPrefixes;
44   HeaderSearch &Headers;
45   bool Verbose;
46   std::string IncludeSysroot;
47   bool HasSysroot;
48 
49 public:
50 
InitHeaderSearch(HeaderSearch & HS,bool verbose,StringRef sysroot)51   InitHeaderSearch(HeaderSearch &HS, bool verbose, StringRef sysroot)
52     : Headers(HS), Verbose(verbose), IncludeSysroot(sysroot),
53       HasSysroot(!(sysroot.empty() || sysroot == "/")) {
54   }
55 
56   /// AddPath - Add the specified path to the specified group list, prefixing
57   /// the sysroot if used.
58   void AddPath(const Twine &Path, IncludeDirGroup Group, bool isFramework);
59 
60   /// AddUnmappedPath - Add the specified path to the specified group list,
61   /// without performing any sysroot remapping.
62   void AddUnmappedPath(const Twine &Path, IncludeDirGroup Group,
63                        bool isFramework);
64 
65   /// AddSystemHeaderPrefix - Add the specified prefix to the system header
66   /// prefix list.
AddSystemHeaderPrefix(StringRef Prefix,bool IsSystemHeader)67   void AddSystemHeaderPrefix(StringRef Prefix, bool IsSystemHeader) {
68     SystemHeaderPrefixes.push_back(std::make_pair(Prefix, IsSystemHeader));
69   }
70 
71   /// AddGnuCPlusPlusIncludePaths - Add the necessary paths to support a gnu
72   ///  libstdc++.
73   void AddGnuCPlusPlusIncludePaths(StringRef Base,
74                                    StringRef ArchDir,
75                                    StringRef Dir32,
76                                    StringRef Dir64,
77                                    const llvm::Triple &triple);
78 
79   /// AddMinGWCPlusPlusIncludePaths - Add the necessary paths to support a MinGW
80   ///  libstdc++.
81   void AddMinGWCPlusPlusIncludePaths(StringRef Base,
82                                      StringRef Arch,
83                                      StringRef Version);
84 
85   /// AddMinGW64CXXPaths - Add the necessary paths to support
86   /// libstdc++ of x86_64-w64-mingw32 aka mingw-w64.
87   void AddMinGW64CXXPaths(StringRef Base,
88                           StringRef Version);
89 
90   // AddDefaultCIncludePaths - Add paths that should always be searched.
91   void AddDefaultCIncludePaths(const llvm::Triple &triple,
92                                const HeaderSearchOptions &HSOpts);
93 
94   // AddDefaultCPlusPlusIncludePaths -  Add paths that should be searched when
95   //  compiling c++.
96   void AddDefaultCPlusPlusIncludePaths(const llvm::Triple &triple,
97                                        const HeaderSearchOptions &HSOpts);
98 
99   /// AddDefaultSystemIncludePaths - Adds the default system include paths so
100   ///  that e.g. stdio.h is found.
101   void AddDefaultIncludePaths(const LangOptions &Lang,
102                               const llvm::Triple &triple,
103                               const HeaderSearchOptions &HSOpts);
104 
105   /// Realize - Merges all search path lists into one list and send it to
106   /// HeaderSearch.
107   void Realize(const LangOptions &Lang);
108 };
109 
110 }  // end anonymous namespace.
111 
CanPrefixSysroot(StringRef Path)112 static bool CanPrefixSysroot(StringRef Path) {
113 #if defined(LLVM_ON_WIN32)
114   return !Path.empty() && llvm::sys::path::is_separator(Path[0]);
115 #else
116   return llvm::sys::path::is_absolute(Path);
117 #endif
118 }
119 
AddPath(const Twine & Path,IncludeDirGroup Group,bool isFramework)120 void InitHeaderSearch::AddPath(const Twine &Path, IncludeDirGroup Group,
121                                bool isFramework) {
122   // Add the path with sysroot prepended, if desired and this is a system header
123   // group.
124   if (HasSysroot) {
125     SmallString<256> MappedPathStorage;
126     StringRef MappedPathStr = Path.toStringRef(MappedPathStorage);
127     if (CanPrefixSysroot(MappedPathStr)) {
128       AddUnmappedPath(IncludeSysroot + Path, Group, isFramework);
129       return;
130     }
131   }
132 
133   AddUnmappedPath(Path, Group, isFramework);
134 }
135 
AddUnmappedPath(const Twine & Path,IncludeDirGroup Group,bool isFramework)136 void InitHeaderSearch::AddUnmappedPath(const Twine &Path, IncludeDirGroup Group,
137                                        bool isFramework) {
138   assert(!Path.isTriviallyEmpty() && "can't handle empty path here");
139 
140   FileManager &FM = Headers.getFileMgr();
141   SmallString<256> MappedPathStorage;
142   StringRef MappedPathStr = Path.toStringRef(MappedPathStorage);
143 
144   // Compute the DirectoryLookup type.
145   SrcMgr::CharacteristicKind Type;
146   if (Group == Quoted || Group == Angled || Group == IndexHeaderMap) {
147     Type = SrcMgr::C_User;
148   } else if (Group == ExternCSystem) {
149     Type = SrcMgr::C_ExternCSystem;
150   } else {
151     Type = SrcMgr::C_System;
152   }
153 
154   // If the directory exists, add it.
155   if (const DirectoryEntry *DE = FM.getDirectory(MappedPathStr)) {
156     IncludePath.push_back(
157       std::make_pair(Group, DirectoryLookup(DE, Type, isFramework)));
158     return;
159   }
160 
161   // Check to see if this is an apple-style headermap (which are not allowed to
162   // be frameworks).
163   if (!isFramework) {
164     if (const FileEntry *FE = FM.getFile(MappedPathStr)) {
165       if (const HeaderMap *HM = Headers.CreateHeaderMap(FE)) {
166         // It is a headermap, add it to the search path.
167         IncludePath.push_back(
168           std::make_pair(Group,
169                          DirectoryLookup(HM, Type, Group == IndexHeaderMap)));
170         return;
171       }
172     }
173   }
174 
175   if (Verbose)
176     llvm::errs() << "ignoring nonexistent directory \""
177                  << MappedPathStr << "\"\n";
178 }
179 
AddGnuCPlusPlusIncludePaths(StringRef Base,StringRef ArchDir,StringRef Dir32,StringRef Dir64,const llvm::Triple & triple)180 void InitHeaderSearch::AddGnuCPlusPlusIncludePaths(StringRef Base,
181                                                    StringRef ArchDir,
182                                                    StringRef Dir32,
183                                                    StringRef Dir64,
184                                                    const llvm::Triple &triple) {
185   // Add the base dir
186   AddPath(Base, CXXSystem, false);
187 
188   // Add the multilib dirs
189   llvm::Triple::ArchType arch = triple.getArch();
190   bool is64bit = arch == llvm::Triple::ppc64 || arch == llvm::Triple::x86_64;
191   if (is64bit)
192     AddPath(Base + "/" + ArchDir + "/" + Dir64, CXXSystem, false);
193   else
194     AddPath(Base + "/" + ArchDir + "/" + Dir32, CXXSystem, false);
195 
196   // Add the backward dir
197   AddPath(Base + "/backward", CXXSystem, false);
198 }
199 
AddMinGWCPlusPlusIncludePaths(StringRef Base,StringRef Arch,StringRef Version)200 void InitHeaderSearch::AddMinGWCPlusPlusIncludePaths(StringRef Base,
201                                                      StringRef Arch,
202                                                      StringRef Version) {
203   AddPath(Base + "/" + Arch + "/" + Version + "/include/c++",
204           CXXSystem, false);
205   AddPath(Base + "/" + Arch + "/" + Version + "/include/c++/" + Arch,
206           CXXSystem, false);
207   AddPath(Base + "/" + Arch + "/" + Version + "/include/c++/backward",
208           CXXSystem, false);
209 }
210 
AddMinGW64CXXPaths(StringRef Base,StringRef Version)211 void InitHeaderSearch::AddMinGW64CXXPaths(StringRef Base,
212                                           StringRef Version) {
213   // Assumes Base is HeaderSearchOpts' ResourceDir
214   AddPath(Base + "/../../../include/c++/" + Version,
215           CXXSystem, false);
216   AddPath(Base + "/../../../include/c++/" + Version + "/x86_64-w64-mingw32",
217           CXXSystem, false);
218   AddPath(Base + "/../../../include/c++/" + Version + "/i686-w64-mingw32",
219           CXXSystem, false);
220   AddPath(Base + "/../../../include/c++/" + Version + "/backward",
221           CXXSystem, false);
222 }
223 
AddDefaultCIncludePaths(const llvm::Triple & triple,const HeaderSearchOptions & HSOpts)224 void InitHeaderSearch::AddDefaultCIncludePaths(const llvm::Triple &triple,
225                                             const HeaderSearchOptions &HSOpts) {
226   llvm::Triple::OSType os = triple.getOS();
227 
228   if (HSOpts.UseStandardSystemIncludes) {
229     switch (os) {
230     case llvm::Triple::FreeBSD:
231     case llvm::Triple::NetBSD:
232     case llvm::Triple::OpenBSD:
233     case llvm::Triple::Minix:
234     case llvm::Triple::Bitrig:
235       break;
236     default:
237       // FIXME: temporary hack: hard-coded paths.
238       AddPath("/usr/local/include", System, false);
239       break;
240     }
241   }
242 
243   // Builtin includes use #include_next directives and should be positioned
244   // just prior C include dirs.
245   if (HSOpts.UseBuiltinIncludes) {
246     // Ignore the sys root, we *always* look for clang headers relative to
247     // supplied path.
248     SmallString<128> P = StringRef(HSOpts.ResourceDir);
249     llvm::sys::path::append(P, "include");
250     AddUnmappedPath(P.str(), ExternCSystem, false);
251   }
252 
253   // All remaining additions are for system include directories, early exit if
254   // we aren't using them.
255   if (!HSOpts.UseStandardSystemIncludes)
256     return;
257 
258   // Add dirs specified via 'configure --with-c-include-dirs'.
259   StringRef CIncludeDirs(C_INCLUDE_DIRS);
260   if (CIncludeDirs != "") {
261     SmallVector<StringRef, 5> dirs;
262     CIncludeDirs.split(dirs, ":");
263     for (SmallVectorImpl<StringRef>::iterator i = dirs.begin();
264          i != dirs.end();
265          ++i)
266       AddPath(*i, ExternCSystem, false);
267     return;
268   }
269 
270   switch (os) {
271   case llvm::Triple::Linux:
272     llvm_unreachable("Include management is handled in the driver.");
273 
274   case llvm::Triple::Haiku:
275     AddPath("/boot/common/include", System, false);
276     AddPath("/boot/develop/headers/os", System, false);
277     AddPath("/boot/develop/headers/os/app", System, false);
278     AddPath("/boot/develop/headers/os/arch", System, false);
279     AddPath("/boot/develop/headers/os/device", System, false);
280     AddPath("/boot/develop/headers/os/drivers", System, false);
281     AddPath("/boot/develop/headers/os/game", System, false);
282     AddPath("/boot/develop/headers/os/interface", System, false);
283     AddPath("/boot/develop/headers/os/kernel", System, false);
284     AddPath("/boot/develop/headers/os/locale", System, false);
285     AddPath("/boot/develop/headers/os/mail", System, false);
286     AddPath("/boot/develop/headers/os/media", System, false);
287     AddPath("/boot/develop/headers/os/midi", System, false);
288     AddPath("/boot/develop/headers/os/midi2", System, false);
289     AddPath("/boot/develop/headers/os/net", System, false);
290     AddPath("/boot/develop/headers/os/storage", System, false);
291     AddPath("/boot/develop/headers/os/support", System, false);
292     AddPath("/boot/develop/headers/os/translation", System, false);
293     AddPath("/boot/develop/headers/os/add-ons/graphics", System, false);
294     AddPath("/boot/develop/headers/os/add-ons/input_server", System, false);
295     AddPath("/boot/develop/headers/os/add-ons/screen_saver", System, false);
296     AddPath("/boot/develop/headers/os/add-ons/tracker", System, false);
297     AddPath("/boot/develop/headers/os/be_apps/Deskbar", System, false);
298     AddPath("/boot/develop/headers/os/be_apps/NetPositive", System, false);
299     AddPath("/boot/develop/headers/os/be_apps/Tracker", System, false);
300     AddPath("/boot/develop/headers/cpp", System, false);
301     AddPath("/boot/develop/headers/cpp/i586-pc-haiku", System, false);
302     AddPath("/boot/develop/headers/3rdparty", System, false);
303     AddPath("/boot/develop/headers/bsd", System, false);
304     AddPath("/boot/develop/headers/glibc", System, false);
305     AddPath("/boot/develop/headers/posix", System, false);
306     AddPath("/boot/develop/headers",  System, false);
307     break;
308   case llvm::Triple::RTEMS:
309     break;
310   case llvm::Triple::Win32:
311     switch (triple.getEnvironment()) {
312     default: llvm_unreachable("Include management is handled in the driver.");
313     case llvm::Triple::Cygnus:
314       AddPath("/usr/include/w32api", System, false);
315       break;
316     case llvm::Triple::GNU:
317       // mingw-w64 crt include paths
318       // <sysroot>/i686-w64-mingw32/include
319       SmallString<128> P = StringRef(HSOpts.ResourceDir);
320       llvm::sys::path::append(P, "../../../i686-w64-mingw32/include");
321       AddPath(P.str(), System, false);
322 
323       // <sysroot>/x86_64-w64-mingw32/include
324       P.resize(HSOpts.ResourceDir.size());
325       llvm::sys::path::append(P, "../../../x86_64-w64-mingw32/include");
326       AddPath(P.str(), System, false);
327 
328       // mingw.org crt include paths
329       // <sysroot>/include
330       P.resize(HSOpts.ResourceDir.size());
331       llvm::sys::path::append(P, "../../../include");
332       AddPath(P.str(), System, false);
333       AddPath("/mingw/include", System, false);
334 #if defined(LLVM_ON_WIN32)
335       AddPath("c:/mingw/include", System, false);
336 #endif
337       break;
338     }
339     break;
340   default:
341     break;
342   }
343 
344   if ( os != llvm::Triple::RTEMS )
345     AddPath("/usr/include", ExternCSystem, false);
346 }
347 
348 void InitHeaderSearch::
AddDefaultCPlusPlusIncludePaths(const llvm::Triple & triple,const HeaderSearchOptions & HSOpts)349 AddDefaultCPlusPlusIncludePaths(const llvm::Triple &triple, const HeaderSearchOptions &HSOpts) {
350   llvm::Triple::OSType os = triple.getOS();
351   // FIXME: temporary hack: hard-coded paths.
352 
353   if (triple.isOSDarwin()) {
354     switch (triple.getArch()) {
355     default: break;
356 
357     case llvm::Triple::ppc:
358     case llvm::Triple::ppc64:
359       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
360                                   "powerpc-apple-darwin10", "", "ppc64",
361                                   triple);
362       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.0.0",
363                                   "powerpc-apple-darwin10", "", "ppc64",
364                                   triple);
365       break;
366 
367     case llvm::Triple::x86:
368     case llvm::Triple::x86_64:
369       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
370                                   "i686-apple-darwin10", "", "x86_64", triple);
371       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.0.0",
372                                   "i686-apple-darwin8", "", "", triple);
373       break;
374 
375     case llvm::Triple::arm:
376     case llvm::Triple::thumb:
377       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
378                                   "arm-apple-darwin10", "v7", "", triple);
379       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
380                                   "arm-apple-darwin10", "v6", "", triple);
381       break;
382 
383     case llvm::Triple::aarch64:
384       AddGnuCPlusPlusIncludePaths("/usr/include/c++/4.2.1",
385                                   "arm64-apple-darwin10", "", "", triple);
386       break;
387     }
388     return;
389   }
390 
391   switch (os) {
392   case llvm::Triple::Linux:
393     llvm_unreachable("Include management is handled in the driver.");
394     break;
395   case llvm::Triple::Win32:
396     switch (triple.getEnvironment()) {
397     default: llvm_unreachable("Include management is handled in the driver.");
398     case llvm::Triple::Cygnus:
399       // Cygwin-1.7
400       AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.7.3");
401       AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.5.3");
402       AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.3.4");
403       // g++-4 / Cygwin-1.5
404       AddMinGWCPlusPlusIncludePaths("/usr/lib/gcc", "i686-pc-cygwin", "4.3.2");
405       break;
406     case llvm::Triple::GNU:
407       // mingw-w64 C++ include paths (i686-w64-mingw32 and x86_64-w64-mingw32)
408       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.0");
409       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.1");
410       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.2");
411       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.7.3");
412       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.8.0");
413       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.8.1");
414       AddMinGW64CXXPaths(HSOpts.ResourceDir, "4.8.2");
415       // mingw.org C++ include paths
416 #if defined(LLVM_ON_WIN32)
417       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.0");
418       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.1");
419       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.2");
420       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.7.3");
421       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.8.0");
422       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.8.1");
423       AddMinGWCPlusPlusIncludePaths("c:/MinGW/lib/gcc", "mingw32", "4.8.2");
424 #endif
425       break;
426     }
427   case llvm::Triple::DragonFly:
428     if (llvm::sys::fs::exists("/usr/lib/gcc47"))
429       AddPath("/usr/include/c++/4.7", CXXSystem, false);
430     else
431       AddPath("/usr/include/c++/4.4", CXXSystem, false);
432     break;
433   case llvm::Triple::OpenBSD: {
434     std::string t = triple.getTriple();
435     if (t.substr(0, 6) == "x86_64")
436       t.replace(0, 6, "amd64");
437     AddGnuCPlusPlusIncludePaths("/usr/include/g++",
438                                 t, "", "", triple);
439     break;
440   }
441 #if !defined(__minix)
442   case llvm::Triple::Minix:
443     AddGnuCPlusPlusIncludePaths("/usr/gnu/include/c++/4.4.3",
444                                 "", "", "", triple);
445     break;
446 #endif /* !defined(__minix) */
447   case llvm::Triple::Solaris:
448     AddGnuCPlusPlusIncludePaths("/usr/gcc/4.5/include/c++/4.5.2/",
449                                 "i386-pc-solaris2.11", "", "", triple);
450     break;
451   default:
452     break;
453   }
454 }
455 
AddDefaultIncludePaths(const LangOptions & Lang,const llvm::Triple & triple,const HeaderSearchOptions & HSOpts)456 void InitHeaderSearch::AddDefaultIncludePaths(const LangOptions &Lang,
457                                               const llvm::Triple &triple,
458                                             const HeaderSearchOptions &HSOpts) {
459   // NB: This code path is going away. All of the logic is moving into the
460   // driver which has the information necessary to do target-specific
461   // selections of default include paths. Each target which moves there will be
462   // exempted from this logic here until we can delete the entire pile of code.
463   switch (triple.getOS()) {
464   default:
465     break; // Everything else continues to use this routine's logic.
466 
467   case llvm::Triple::Linux:
468     return;
469 
470   case llvm::Triple::Win32:
471     if (triple.getEnvironment() == llvm::Triple::MSVC ||
472         triple.getEnvironment() == llvm::Triple::Itanium ||
473         triple.isOSBinFormatMachO())
474       return;
475     break;
476   }
477 
478   if (Lang.CPlusPlus && HSOpts.UseStandardCXXIncludes &&
479       HSOpts.UseStandardSystemIncludes) {
480     if (HSOpts.UseLibcxx) {
481       if (triple.isOSDarwin()) {
482         // On Darwin, libc++ may be installed alongside the compiler in
483         // include/c++/v1.
484         if (!HSOpts.ResourceDir.empty()) {
485           // Remove version from foo/lib/clang/version
486           StringRef NoVer = llvm::sys::path::parent_path(HSOpts.ResourceDir);
487           // Remove clang from foo/lib/clang
488           StringRef Lib = llvm::sys::path::parent_path(NoVer);
489           // Remove lib from foo/lib
490           SmallString<128> P = llvm::sys::path::parent_path(Lib);
491 
492           // Get foo/include/c++/v1
493           llvm::sys::path::append(P, "include", "c++", "v1");
494           AddUnmappedPath(P.str(), CXXSystem, false);
495         }
496       }
497       // On Solaris, include the support directory for things like xlocale and
498       // fudged system headers.
499       if (triple.getOS() == llvm::Triple::Solaris)
500         AddPath("/usr/include/c++/v1/support/solaris", CXXSystem, false);
501 
502       AddPath("/usr/include/c++/v1", CXXSystem, false);
503     } else {
504       AddDefaultCPlusPlusIncludePaths(triple, HSOpts);
505     }
506   }
507 
508   AddDefaultCIncludePaths(triple, HSOpts);
509 
510   // Add the default framework include paths on Darwin.
511   if (HSOpts.UseStandardSystemIncludes) {
512     if (triple.isOSDarwin()) {
513       AddPath("/System/Library/Frameworks", System, true);
514       AddPath("/Library/Frameworks", System, true);
515     }
516   }
517 }
518 
519 /// RemoveDuplicates - If there are duplicate directory entries in the specified
520 /// search list, remove the later (dead) ones.  Returns the number of non-system
521 /// headers removed, which is used to update NumAngled.
RemoveDuplicates(std::vector<DirectoryLookup> & SearchList,unsigned First,bool Verbose)522 static unsigned RemoveDuplicates(std::vector<DirectoryLookup> &SearchList,
523                                  unsigned First, bool Verbose) {
524   llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenDirs;
525   llvm::SmallPtrSet<const DirectoryEntry *, 8> SeenFrameworkDirs;
526   llvm::SmallPtrSet<const HeaderMap *, 8> SeenHeaderMaps;
527   unsigned NonSystemRemoved = 0;
528   for (unsigned i = First; i != SearchList.size(); ++i) {
529     unsigned DirToRemove = i;
530 
531     const DirectoryLookup &CurEntry = SearchList[i];
532 
533     if (CurEntry.isNormalDir()) {
534       // If this isn't the first time we've seen this dir, remove it.
535       if (SeenDirs.insert(CurEntry.getDir()).second)
536         continue;
537     } else if (CurEntry.isFramework()) {
538       // If this isn't the first time we've seen this framework dir, remove it.
539       if (SeenFrameworkDirs.insert(CurEntry.getFrameworkDir()).second)
540         continue;
541     } else {
542       assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
543       // If this isn't the first time we've seen this headermap, remove it.
544       if (SeenHeaderMaps.insert(CurEntry.getHeaderMap()).second)
545         continue;
546     }
547 
548     // If we have a normal #include dir/framework/headermap that is shadowed
549     // later in the chain by a system include location, we actually want to
550     // ignore the user's request and drop the user dir... keeping the system
551     // dir.  This is weird, but required to emulate GCC's search path correctly.
552     //
553     // Since dupes of system dirs are rare, just rescan to find the original
554     // that we're nuking instead of using a DenseMap.
555     if (CurEntry.getDirCharacteristic() != SrcMgr::C_User) {
556       // Find the dir that this is the same of.
557       unsigned FirstDir;
558       for (FirstDir = 0; ; ++FirstDir) {
559         assert(FirstDir != i && "Didn't find dupe?");
560 
561         const DirectoryLookup &SearchEntry = SearchList[FirstDir];
562 
563         // If these are different lookup types, then they can't be the dupe.
564         if (SearchEntry.getLookupType() != CurEntry.getLookupType())
565           continue;
566 
567         bool isSame;
568         if (CurEntry.isNormalDir())
569           isSame = SearchEntry.getDir() == CurEntry.getDir();
570         else if (CurEntry.isFramework())
571           isSame = SearchEntry.getFrameworkDir() == CurEntry.getFrameworkDir();
572         else {
573           assert(CurEntry.isHeaderMap() && "Not a headermap or normal dir?");
574           isSame = SearchEntry.getHeaderMap() == CurEntry.getHeaderMap();
575         }
576 
577         if (isSame)
578           break;
579       }
580 
581       // If the first dir in the search path is a non-system dir, zap it
582       // instead of the system one.
583       if (SearchList[FirstDir].getDirCharacteristic() == SrcMgr::C_User)
584         DirToRemove = FirstDir;
585     }
586 
587     if (Verbose) {
588       llvm::errs() << "ignoring duplicate directory \""
589                    << CurEntry.getName() << "\"\n";
590       if (DirToRemove != i)
591         llvm::errs() << "  as it is a non-system directory that duplicates "
592                      << "a system directory\n";
593     }
594     if (DirToRemove != i)
595       ++NonSystemRemoved;
596 
597     // This is reached if the current entry is a duplicate.  Remove the
598     // DirToRemove (usually the current dir).
599     SearchList.erase(SearchList.begin()+DirToRemove);
600     --i;
601   }
602   return NonSystemRemoved;
603 }
604 
605 
Realize(const LangOptions & Lang)606 void InitHeaderSearch::Realize(const LangOptions &Lang) {
607   // Concatenate ANGLE+SYSTEM+AFTER chains together into SearchList.
608   std::vector<DirectoryLookup> SearchList;
609   SearchList.reserve(IncludePath.size());
610 
611   // Quoted arguments go first.
612   for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
613        it != ie; ++it) {
614     if (it->first == Quoted)
615       SearchList.push_back(it->second);
616   }
617   // Deduplicate and remember index.
618   RemoveDuplicates(SearchList, 0, Verbose);
619   unsigned NumQuoted = SearchList.size();
620 
621   for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
622        it != ie; ++it) {
623     if (it->first == Angled || it->first == IndexHeaderMap)
624       SearchList.push_back(it->second);
625   }
626 
627   RemoveDuplicates(SearchList, NumQuoted, Verbose);
628   unsigned NumAngled = SearchList.size();
629 
630   for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
631        it != ie; ++it) {
632     if (it->first == System || it->first == ExternCSystem ||
633         (!Lang.ObjC1 && !Lang.CPlusPlus && it->first == CSystem)    ||
634         (/*FIXME !Lang.ObjC1 && */Lang.CPlusPlus  && it->first == CXXSystem)  ||
635         (Lang.ObjC1  && !Lang.CPlusPlus && it->first == ObjCSystem) ||
636         (Lang.ObjC1  && Lang.CPlusPlus  && it->first == ObjCXXSystem))
637       SearchList.push_back(it->second);
638   }
639 
640   for (path_iterator it = IncludePath.begin(), ie = IncludePath.end();
641        it != ie; ++it) {
642     if (it->first == After)
643       SearchList.push_back(it->second);
644   }
645 
646   // Remove duplicates across both the Angled and System directories.  GCC does
647   // this and failing to remove duplicates across these two groups breaks
648   // #include_next.
649   unsigned NonSystemRemoved = RemoveDuplicates(SearchList, NumQuoted, Verbose);
650   NumAngled -= NonSystemRemoved;
651 
652   bool DontSearchCurDir = false;  // TODO: set to true if -I- is set?
653   Headers.SetSearchPaths(SearchList, NumQuoted, NumAngled, DontSearchCurDir);
654 
655   Headers.SetSystemHeaderPrefixes(SystemHeaderPrefixes);
656 
657   // If verbose, print the list of directories that will be searched.
658   if (Verbose) {
659     llvm::errs() << "#include \"...\" search starts here:\n";
660     for (unsigned i = 0, e = SearchList.size(); i != e; ++i) {
661       if (i == NumQuoted)
662         llvm::errs() << "#include <...> search starts here:\n";
663       const char *Name = SearchList[i].getName();
664       const char *Suffix;
665       if (SearchList[i].isNormalDir())
666         Suffix = "";
667       else if (SearchList[i].isFramework())
668         Suffix = " (framework directory)";
669       else {
670         assert(SearchList[i].isHeaderMap() && "Unknown DirectoryLookup");
671         Suffix = " (headermap)";
672       }
673       llvm::errs() << " " << Name << Suffix << "\n";
674     }
675     llvm::errs() << "End of search list.\n";
676   }
677 }
678 
ApplyHeaderSearchOptions(HeaderSearch & HS,const HeaderSearchOptions & HSOpts,const LangOptions & Lang,const llvm::Triple & Triple)679 void clang::ApplyHeaderSearchOptions(HeaderSearch &HS,
680                                      const HeaderSearchOptions &HSOpts,
681                                      const LangOptions &Lang,
682                                      const llvm::Triple &Triple) {
683   InitHeaderSearch Init(HS, HSOpts.Verbose, HSOpts.Sysroot);
684 
685   // Add the user defined entries.
686   for (unsigned i = 0, e = HSOpts.UserEntries.size(); i != e; ++i) {
687     const HeaderSearchOptions::Entry &E = HSOpts.UserEntries[i];
688     if (E.IgnoreSysRoot) {
689       Init.AddUnmappedPath(E.Path, E.Group, E.IsFramework);
690     } else {
691       Init.AddPath(E.Path, E.Group, E.IsFramework);
692     }
693   }
694 
695   Init.AddDefaultIncludePaths(Lang, Triple, HSOpts);
696 
697   for (unsigned i = 0, e = HSOpts.SystemHeaderPrefixes.size(); i != e; ++i)
698     Init.AddSystemHeaderPrefix(HSOpts.SystemHeaderPrefixes[i].Prefix,
699                                HSOpts.SystemHeaderPrefixes[i].IsSystemHeader);
700 
701   if (HSOpts.UseBuiltinIncludes) {
702     // Set up the builtin include directory in the module map.
703     SmallString<128> P = StringRef(HSOpts.ResourceDir);
704     llvm::sys::path::append(P, "include");
705     if (const DirectoryEntry *Dir = HS.getFileMgr().getDirectory(P.str()))
706       HS.getModuleMap().setBuiltinIncludeDir(Dir);
707   }
708 
709   Init.Realize(Lang);
710 }
711