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