1 /* Set up combined include path chain for the preprocessor.
2 Copyright (C) 1986-2015 Free Software Foundation, Inc.
4 Broken out of cppinit.c and cppfiles.c and rewritten Mar 2003.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
22 #include "coretypes.h"
31 #include "cppdefault.h"
33 /* Microsoft Windows does not natively support inodes.
34 VMS has non-numeric inodes. */
36 # define INO_T_EQ(A, B) (!memcmp (&(A), &(B), sizeof (A)))
37 # define INO_T_COPY(DEST, SRC) memcpy (&(DEST), &(SRC), sizeof (SRC))
38 #elif !defined (HOST_LACKS_INODE_NUMBERS)
39 # define INO_T_EQ(A, B) ((A) == (B))
40 # define INO_T_COPY(DEST, SRC) (DEST) = (SRC)
44 #define DIRS_EQ(A, B) ((A)->dev == (B)->dev \
45 && INO_T_EQ ((A)->ino, (B)->ino))
47 #define DIRS_EQ(A, B) (!filename_cmp ((A)->canonical_name, (B)->canonical_name))
50 static const char dir_separator_str
[] = { DIR_SEPARATOR
, 0 };
52 static void add_env_var_paths (const char *, int);
53 static void add_standard_paths (const char *, const char *, const char *, int);
54 static void free_path (struct cpp_dir
*, int);
55 static void merge_include_chains (const char *, cpp_reader
*, int);
56 static void add_sysroot_to_chain (const char *, int);
57 static struct cpp_dir
*remove_duplicates (cpp_reader
*, struct cpp_dir
*,
59 struct cpp_dir
*, int);
61 /* Include chains heads and tails. */
62 static struct cpp_dir
*heads
[4];
63 static struct cpp_dir
*tails
[4];
64 static bool quote_ignores_source_dir
;
65 enum { REASON_QUIET
= 0, REASON_NOENT
, REASON_DUP
, REASON_DUP_SYS
};
67 /* Free an element of the include chain, possibly giving a reason. */
69 free_path (struct cpp_dir
*path
, int reason
)
75 fprintf (stderr
, _("ignoring duplicate directory \"%s\"\n"), path
->name
);
76 if (reason
== REASON_DUP_SYS
)
78 _(" as it is a non-system directory that duplicates a system directory\n"));
82 fprintf (stderr
, _("ignoring nonexistent directory \"%s\"\n"),
95 /* Read ENV_VAR for a PATH_SEPARATOR-separated list of file names; and
96 append all the names to the search path CHAIN. */
98 add_env_var_paths (const char *env_var
, int chain
)
102 q
= getenv (env_var
);
107 for (p
= q
; *q
; p
= q
+ 1)
110 while (*q
!= 0 && *q
!= PATH_SEPARATOR
)
114 path
= xstrdup (".");
117 path
= XNEWVEC (char, q
- p
+ 1);
118 memcpy (path
, p
, q
- p
);
122 add_path (path
, chain
, chain
== SYSTEM
, false);
126 /* Append the standard include chain defined in cppdefault.c. */
128 add_standard_paths (const char *sysroot
, const char *iprefix
,
129 const char *imultilib
, int cxx_stdinc
)
131 const struct default_include
*p
;
132 int relocated
= cpp_relocated ();
135 if (iprefix
&& (len
= cpp_GCC_INCLUDE_DIR_len
) != 0)
137 /* Look for directories that start with the standard prefix.
138 "Translate" them, i.e. replace /usr/local/lib/gcc... with
139 IPREFIX and search them first. */
140 for (p
= cpp_include_defaults
; p
->fname
; p
++)
142 if (!p
->cplusplus
|| cxx_stdinc
)
144 /* Should we be translating sysrooted dirs too? Assume
145 that iprefix and sysroot are mutually exclusive, for
147 if (sysroot
&& p
->add_sysroot
)
149 if (!filename_ncmp (p
->fname
, cpp_GCC_INCLUDE_DIR
, len
))
151 char *str
= concat (iprefix
, p
->fname
+ len
, NULL
);
152 if (p
->multilib
== 1 && imultilib
)
153 str
= reconcat (str
, str
, dir_separator_str
,
155 else if (p
->multilib
== 2)
162 str
= reconcat (str
, str
, dir_separator_str
,
165 add_path (str
, SYSTEM
, p
->cxx_aware
, false);
171 for (p
= cpp_include_defaults
; p
->fname
; p
++)
173 if (!p
->cplusplus
|| cxx_stdinc
)
177 /* Should this directory start with the sysroot? */
178 if (sysroot
&& p
->add_sysroot
)
180 char *sysroot_no_trailing_dir_separator
= xstrdup (sysroot
);
181 size_t sysroot_len
= strlen (sysroot
);
183 if (sysroot_len
> 0 && sysroot
[sysroot_len
- 1] == DIR_SEPARATOR
)
184 sysroot_no_trailing_dir_separator
[sysroot_len
- 1] = '\0';
185 str
= concat (sysroot_no_trailing_dir_separator
, p
->fname
, NULL
);
186 free (sysroot_no_trailing_dir_separator
);
188 else if (!p
->add_sysroot
&& relocated
189 && !filename_ncmp (p
->fname
, cpp_PREFIX
, cpp_PREFIX_len
))
191 static const char *relocated_prefix
;
193 /* If this path starts with the configure-time prefix,
194 but the compiler has been relocated, replace it
195 with the run-time prefix. The run-time exec prefix
196 is GCC_EXEC_PREFIX. Compute the path from there back
197 to the toplevel prefix. */
198 if (!relocated_prefix
)
201 /* Make relative prefix expects the first argument
202 to be a program, not a directory. */
203 dummy
= concat (gcc_exec_prefix
, "dummy", NULL
);
205 = make_relative_prefix (dummy
,
210 ostr
= concat (relocated_prefix
,
211 p
->fname
+ cpp_PREFIX_len
,
213 str
= update_path (ostr
, p
->component
);
217 str
= update_path (p
->fname
, p
->component
);
219 if (p
->multilib
== 1 && imultilib
)
220 str
= reconcat (str
, str
, dir_separator_str
, imultilib
, NULL
);
221 else if (p
->multilib
== 2)
228 str
= reconcat (str
, str
, dir_separator_str
, imultiarch
, NULL
);
231 add_path (str
, SYSTEM
, p
->cxx_aware
, false);
236 /* For each duplicate path in chain HEAD, keep just the first one.
237 Remove each path in chain HEAD that also exists in chain SYSTEM.
238 Set the NEXT pointer of the last path in the resulting chain to
239 JOIN, unless it duplicates JOIN in which case the last path is
240 removed. Return the head of the resulting chain. Any of HEAD,
241 JOIN and SYSTEM can be NULL. */
243 static struct cpp_dir
*
244 remove_duplicates (cpp_reader
*pfile
, struct cpp_dir
*head
,
245 struct cpp_dir
*system
, struct cpp_dir
*join
,
248 struct cpp_dir
**pcur
, *tmp
, *cur
;
251 for (pcur
= &head
; *pcur
; )
253 int reason
= REASON_QUIET
;
257 if (stat (cur
->name
, &st
))
259 /* Dirs that don't exist are silently ignored, unless verbose. */
261 cpp_errno (pfile
, CPP_DL_ERROR
, cur
->name
);
264 /* If -Wmissing-include-dirs is given, warn. */
265 cpp_options
*opts
= cpp_get_options (pfile
);
266 if (opts
->warn_missing_include_dirs
&& cur
->user_supplied_p
)
267 cpp_warning (pfile
, CPP_W_MISSING_INCLUDE_DIRS
, "%s: %s",
268 cur
->name
, xstrerror (errno
));
269 reason
= REASON_NOENT
;
272 else if (!S_ISDIR (st
.st_mode
))
273 cpp_error_with_line (pfile
, CPP_DL_WARNING
, 0, 0,
274 "%s: not a directory", cur
->name
);
277 #if defined (INO_T_COPY)
278 INO_T_COPY (cur
->ino
, st
.st_ino
);
279 cur
->dev
= st
.st_dev
;
282 /* Remove this one if it is in the system chain. */
283 reason
= REASON_DUP_SYS
;
284 for (tmp
= system
; tmp
; tmp
= tmp
->next
)
285 if (DIRS_EQ (tmp
, cur
) && cur
->construct
== tmp
->construct
)
290 /* Duplicate of something earlier in the same chain? */
292 for (tmp
= head
; tmp
!= cur
; tmp
= tmp
->next
)
293 if (DIRS_EQ (cur
, tmp
) && cur
->construct
== tmp
->construct
)
297 /* Last in the chain and duplicate of JOIN? */
298 && !(cur
->next
== NULL
&& join
299 && DIRS_EQ (cur
, join
)
300 && cur
->construct
== join
->construct
))
302 /* Unique, so keep this directory. */
309 /* Remove this entry from the chain. */
311 free_path (cur
, verbose
? reason
: REASON_QUIET
);
318 /* Add SYSROOT to any user-supplied paths in CHAIN starting with
322 add_sysroot_to_chain (const char *sysroot
, int chain
)
326 for (p
= heads
[chain
]; p
!= NULL
; p
= p
->next
)
327 if (p
->name
[0] == '=' && p
->user_supplied_p
)
328 p
->name
= concat (sysroot
, p
->name
+ 1, NULL
);
331 /* Merge the four include chains together in the order quote, bracket,
332 system, after. Remove duplicate dirs (determined in
333 system-specific manner).
335 We can't just merge the lists and then uniquify them because then
336 we may lose directories from the <> search path that should be
337 there; consider -iquote foo -iquote bar -Ifoo -Iquux. It is
338 however safe to treat -iquote bar -iquote foo -Ifoo -Iquux as if
339 written -iquote bar -Ifoo -Iquux. */
342 merge_include_chains (const char *sysroot
, cpp_reader
*pfile
, int verbose
)
344 /* Add the sysroot to user-supplied paths starting with "=". */
347 add_sysroot_to_chain (sysroot
, QUOTE
);
348 add_sysroot_to_chain (sysroot
, BRACKET
);
349 add_sysroot_to_chain (sysroot
, SYSTEM
);
350 add_sysroot_to_chain (sysroot
, AFTER
);
353 /* Join the SYSTEM and AFTER chains. Remove duplicates in the
354 resulting SYSTEM chain. */
356 tails
[SYSTEM
]->next
= heads
[AFTER
];
358 heads
[SYSTEM
] = heads
[AFTER
];
359 heads
[SYSTEM
] = remove_duplicates (pfile
, heads
[SYSTEM
], 0, 0, verbose
);
361 /* Remove duplicates from BRACKET that are in itself or SYSTEM, and
362 join it to SYSTEM. */
363 heads
[BRACKET
] = remove_duplicates (pfile
, heads
[BRACKET
], heads
[SYSTEM
],
364 heads
[SYSTEM
], verbose
);
366 /* Remove duplicates from QUOTE that are in itself or SYSTEM, and
367 join it to BRACKET. */
368 heads
[QUOTE
] = remove_duplicates (pfile
, heads
[QUOTE
], heads
[SYSTEM
],
369 heads
[BRACKET
], verbose
);
371 /* If verbose, print the list of dirs to search. */
376 fprintf (stderr
, _("#include \"...\" search starts here:\n"));
377 for (p
= heads
[QUOTE
];; p
= p
->next
)
379 if (p
== heads
[BRACKET
])
380 fprintf (stderr
, _("#include <...> search starts here:\n"));
383 fprintf (stderr
, " %s\n", p
->name
);
385 fprintf (stderr
, _("End of search list.\n"));
389 /* Use given -I paths for #include "..." but not #include <...>, and
390 don't search the directory of the present file for #include "...".
391 (Note that -I. -I- is not the same as the default setup; -I. uses
392 the compiler's working dir.) */
394 split_quote_chain (void)
397 free_path (heads
[QUOTE
], REASON_QUIET
);
399 free_path (tails
[QUOTE
], REASON_QUIET
);
400 heads
[QUOTE
] = heads
[BRACKET
];
401 tails
[QUOTE
] = tails
[BRACKET
];
402 heads
[BRACKET
] = NULL
;
403 tails
[BRACKET
] = NULL
;
404 /* This is NOT redundant. */
405 quote_ignores_source_dir
= true;
408 /* Add P to the chain specified by CHAIN. */
411 add_cpp_dir_path (cpp_dir
*p
, int chain
)
414 tails
[chain
]->next
= p
;
420 /* Add PATH to the include chain CHAIN. PATH must be malloc-ed and
423 add_path (char *path
, int chain
, int cxx_aware
, bool user_supplied_p
)
427 #if defined (HAVE_DOS_BASED_FILE_SYSTEM)
428 /* Remove unnecessary trailing slashes. On some versions of MS
429 Windows, trailing _forward_ slashes cause no problems for stat().
430 On newer versions, stat() does not recognize a directory that ends
431 in a '\\' or '/', unless it is a drive root dir, such as "c:/",
432 where it is obligatory. */
433 int pathlen
= strlen (path
);
434 char* end
= path
+ pathlen
- 1;
435 /* Preserve the lead '/' or lead "c:/". */
436 char* start
= path
+ (pathlen
> 2 && path
[1] == ':' ? 3 : 1);
438 for (; end
> start
&& IS_DIR_SEPARATOR (*end
); end
--)
446 p
->canonical_name
= lrealpath (path
);
448 if (chain
== SYSTEM
|| chain
== AFTER
)
449 p
->sysp
= 1 + !cxx_aware
;
453 p
->user_supplied_p
= user_supplied_p
;
455 add_cpp_dir_path (p
, chain
);
458 /* Exported function to handle include chain merging, duplicate
459 removal, and registration with cpplib. */
461 register_include_chains (cpp_reader
*pfile
, const char *sysroot
,
462 const char *iprefix
, const char *imultilib
,
463 int stdinc
, int cxx_stdinc
, int verbose
)
465 static const char *const lang_env_vars
[] =
466 { "C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH",
467 "OBJC_INCLUDE_PATH", "OBJCPLUS_INCLUDE_PATH" };
468 cpp_options
*cpp_opts
= cpp_get_options (pfile
);
469 size_t idx
= (cpp_opts
->objc
? 2: 0);
471 if (cpp_opts
->cplusplus
)
476 /* CPATH and language-dependent environment variables may add to the
478 add_env_var_paths ("CPATH", BRACKET
);
479 add_env_var_paths (lang_env_vars
[idx
], SYSTEM
);
481 target_c_incpath
.extra_pre_includes (sysroot
, iprefix
, stdinc
);
483 /* Finally chain on the standard directories. */
485 add_standard_paths (sysroot
, iprefix
, imultilib
, cxx_stdinc
);
487 target_c_incpath
.extra_includes (sysroot
, iprefix
, stdinc
);
489 merge_include_chains (sysroot
, pfile
, verbose
);
491 cpp_set_include_chains (pfile
, heads
[QUOTE
], heads
[BRACKET
],
492 quote_ignores_source_dir
);
495 /* Return the current chain of cpp dirs. */
498 get_added_cpp_dirs (int chain
)
503 #if !(defined TARGET_EXTRA_INCLUDES) || !(defined TARGET_EXTRA_PRE_INCLUDES)
504 static void hook_void_charptr_charptr_int (const char *sysroot ATTRIBUTE_UNUSED
,
505 const char *iprefix ATTRIBUTE_UNUSED
,
506 int stdinc ATTRIBUTE_UNUSED
)
511 #ifndef TARGET_EXTRA_INCLUDES
512 #define TARGET_EXTRA_INCLUDES hook_void_charptr_charptr_int
514 #ifndef TARGET_EXTRA_PRE_INCLUDES
515 #define TARGET_EXTRA_PRE_INCLUDES hook_void_charptr_charptr_int
518 struct target_c_incpath_s target_c_incpath
= { TARGET_EXTRA_PRE_INCLUDES
, TARGET_EXTRA_INCLUDES
};