1 /* Set up combined include path chain for the preprocessor.
2 Copyright (C) 1986-2014 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"
30 #include "cppdefault.h"
31 #include "diagnostic.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_errno (pfile
, CPP_DL_WARNING
, cur
->name
);
268 reason
= REASON_NOENT
;
271 else if (!S_ISDIR (st
.st_mode
))
272 cpp_error_with_line (pfile
, CPP_DL_WARNING
, 0, 0,
273 "%s: not a directory", cur
->name
);
276 #if defined (INO_T_COPY)
277 INO_T_COPY (cur
->ino
, st
.st_ino
);
278 cur
->dev
= st
.st_dev
;
281 /* Remove this one if it is in the system chain. */
282 reason
= REASON_DUP_SYS
;
283 for (tmp
= system
; tmp
; tmp
= tmp
->next
)
284 if (DIRS_EQ (tmp
, cur
) && cur
->construct
== tmp
->construct
)
289 /* Duplicate of something earlier in the same chain? */
291 for (tmp
= head
; tmp
!= cur
; tmp
= tmp
->next
)
292 if (DIRS_EQ (cur
, tmp
) && cur
->construct
== tmp
->construct
)
296 /* Last in the chain and duplicate of JOIN? */
297 && !(cur
->next
== NULL
&& join
298 && DIRS_EQ (cur
, join
)
299 && cur
->construct
== join
->construct
))
301 /* Unique, so keep this directory. */
308 /* Remove this entry from the chain. */
310 free_path (cur
, verbose
? reason
: REASON_QUIET
);
317 /* Add SYSROOT to any user-supplied paths in CHAIN starting with
321 add_sysroot_to_chain (const char *sysroot
, int chain
)
325 for (p
= heads
[chain
]; p
!= NULL
; p
= p
->next
)
326 if (p
->name
[0] == '=' && p
->user_supplied_p
)
327 p
->name
= concat (sysroot
, p
->name
+ 1, NULL
);
330 /* Merge the four include chains together in the order quote, bracket,
331 system, after. Remove duplicate dirs (determined in
332 system-specific manner).
334 We can't just merge the lists and then uniquify them because then
335 we may lose directories from the <> search path that should be
336 there; consider -iquote foo -iquote bar -Ifoo -Iquux. It is
337 however safe to treat -iquote bar -iquote foo -Ifoo -Iquux as if
338 written -iquote bar -Ifoo -Iquux. */
341 merge_include_chains (const char *sysroot
, cpp_reader
*pfile
, int verbose
)
343 /* Add the sysroot to user-supplied paths starting with "=". */
346 add_sysroot_to_chain (sysroot
, QUOTE
);
347 add_sysroot_to_chain (sysroot
, BRACKET
);
348 add_sysroot_to_chain (sysroot
, SYSTEM
);
349 add_sysroot_to_chain (sysroot
, AFTER
);
352 /* Need to run here before processing below as that'll automatically cull
353 paths that do not exist. However, we want to throw errors whenever the
354 build includes things like -I/usr/include/asdf even if it happens to not
355 exist on the current system. */
356 if (flag_poison_system_directories
)
359 unsigned int chains
[] = { QUOTE
, BRACKET
, SYSTEM
, AFTER
};
361 /* Enable -Werror=poison-system-directories when -Werror and -Wno-error
364 Ideally this would be done in toplev's process_options, but this
365 function runs before that one, so we inline it here instead. */
366 if (POISON_SYSTEM_DIRECTORIES_DEFAULT
367 && !global_options_set
.x_warnings_are_errors
368 && global_dc
->classify_diagnostic
[OPT_Wpoison_system_directories
] ==
370 diagnostic_classify_diagnostic (global_dc
,
371 OPT_Wpoison_system_directories
,
372 DK_ERROR
, UNKNOWN_LOCATION
);
374 for (c
= 0; c
< ARRAY_SIZE (chains
); ++c
)
376 unsigned int chain
= chains
[c
];
379 for (p
= heads
[chain
]; p
; p
= p
->next
)
380 if (!strncmp (p
->name
, "/usr/include", 12)
381 || !strncmp (p
->name
, "/usr/local/include", 18)
382 || !strncmp (p
->name
, "/usr/X11R6/include", 18)
383 || !strncmp (p
->name
, "/lib", 4)
384 || !strncmp (p
->name
, "/usr/local/lib", 14))
385 warning (OPT_Wpoison_system_directories
,
386 "include location \"%s\" is unsafe for "
387 "cross-compilation", p
->name
);
391 /* Join the SYSTEM and AFTER chains. Remove duplicates in the
392 resulting SYSTEM chain. */
394 tails
[SYSTEM
]->next
= heads
[AFTER
];
396 heads
[SYSTEM
] = heads
[AFTER
];
397 heads
[SYSTEM
] = remove_duplicates (pfile
, heads
[SYSTEM
], 0, 0, verbose
);
399 /* Remove duplicates from BRACKET that are in itself or SYSTEM, and
400 join it to SYSTEM. */
401 heads
[BRACKET
] = remove_duplicates (pfile
, heads
[BRACKET
], heads
[SYSTEM
],
402 heads
[SYSTEM
], verbose
);
404 /* Remove duplicates from QUOTE that are in itself or SYSTEM, and
405 join it to BRACKET. */
406 heads
[QUOTE
] = remove_duplicates (pfile
, heads
[QUOTE
], heads
[SYSTEM
],
407 heads
[BRACKET
], verbose
);
409 /* If verbose, print the list of dirs to search. */
414 fprintf (stderr
, _("#include \"...\" search starts here:\n"));
415 for (p
= heads
[QUOTE
];; p
= p
->next
)
417 if (p
== heads
[BRACKET
])
418 fprintf (stderr
, _("#include <...> search starts here:\n"));
421 fprintf (stderr
, " %s\n", p
->name
);
423 fprintf (stderr
, _("End of search list.\n"));
427 /* Use given -I paths for #include "..." but not #include <...>, and
428 don't search the directory of the present file for #include "...".
429 (Note that -I. -I- is not the same as the default setup; -I. uses
430 the compiler's working dir.) */
432 split_quote_chain (void)
435 free_path (heads
[QUOTE
], REASON_QUIET
);
437 free_path (tails
[QUOTE
], REASON_QUIET
);
438 heads
[QUOTE
] = heads
[BRACKET
];
439 tails
[QUOTE
] = tails
[BRACKET
];
440 heads
[BRACKET
] = NULL
;
441 tails
[BRACKET
] = NULL
;
442 /* This is NOT redundant. */
443 quote_ignores_source_dir
= true;
446 /* Add P to the chain specified by CHAIN. */
449 add_cpp_dir_path (cpp_dir
*p
, int chain
)
452 tails
[chain
]->next
= p
;
458 /* Add PATH to the include chain CHAIN. PATH must be malloc-ed and
461 add_path (char *path
, int chain
, int cxx_aware
, bool user_supplied_p
)
465 #if defined (HAVE_DOS_BASED_FILE_SYSTEM)
466 /* Remove unnecessary trailing slashes. On some versions of MS
467 Windows, trailing _forward_ slashes cause no problems for stat().
468 On newer versions, stat() does not recognize a directory that ends
469 in a '\\' or '/', unless it is a drive root dir, such as "c:/",
470 where it is obligatory. */
471 int pathlen
= strlen (path
);
472 char* end
= path
+ pathlen
- 1;
473 /* Preserve the lead '/' or lead "c:/". */
474 char* start
= path
+ (pathlen
> 2 && path
[1] == ':' ? 3 : 1);
476 for (; end
> start
&& IS_DIR_SEPARATOR (*end
); end
--)
484 p
->canonical_name
= lrealpath (path
);
486 if (chain
== SYSTEM
|| chain
== AFTER
)
487 p
->sysp
= 1 + !cxx_aware
;
491 p
->user_supplied_p
= user_supplied_p
;
493 add_cpp_dir_path (p
, chain
);
496 /* Return the bracket and quote include search paths
497 in *BRACKETS and *QUOTES respectively. */
500 get_include_chains (cpp_dir
**quotes
, cpp_dir
**brackets
, cpp_dir
**systems
)
502 *quotes
= heads
[QUOTE
];
503 *brackets
= heads
[BRACKET
];
504 *systems
= heads
[SYSTEM
];
507 /* Make HEAD and TAIL pointers to include paths resynchronized
508 after appending new paths. */
511 clear_include_chains (void)
513 heads
[QUOTE
] = tails
[QUOTE
] = NULL
;
514 heads
[BRACKET
] = tails
[BRACKET
] = NULL
;
515 heads
[SYSTEM
] = tails
[SYSTEM
] = NULL
;
516 heads
[AFTER
] = tails
[AFTER
] = NULL
;
519 /* Exported function to handle include chain merging, duplicate
520 removal, and registration with cpplib. */
522 register_include_chains (cpp_reader
*pfile
, const char *sysroot
,
523 const char *iprefix
, const char *imultilib
,
524 int stdinc
, int cxx_stdinc
, int verbose
)
526 static const char *const lang_env_vars
[] =
527 { "C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH",
528 "OBJC_INCLUDE_PATH", "OBJCPLUS_INCLUDE_PATH" };
529 cpp_options
*cpp_opts
= cpp_get_options (pfile
);
530 size_t idx
= (cpp_opts
->objc
? 2: 0);
532 if (cpp_opts
->cplusplus
)
537 /* CPATH and language-dependent environment variables may add to the
539 add_env_var_paths ("CPATH", BRACKET
);
540 add_env_var_paths (lang_env_vars
[idx
], SYSTEM
);
542 target_c_incpath
.extra_pre_includes (sysroot
, iprefix
, stdinc
);
544 /* Finally chain on the standard directories. */
546 add_standard_paths (sysroot
, iprefix
, imultilib
, cxx_stdinc
);
548 target_c_incpath
.extra_includes (sysroot
, iprefix
, stdinc
);
550 merge_include_chains (sysroot
, pfile
, verbose
);
552 cpp_set_include_chains (pfile
, heads
[QUOTE
], heads
[BRACKET
],
553 quote_ignores_source_dir
);
556 /* Return the current chain of cpp dirs. */
559 get_added_cpp_dirs (int chain
)
564 #if !(defined TARGET_EXTRA_INCLUDES) || !(defined TARGET_EXTRA_PRE_INCLUDES)
565 static void hook_void_charptr_charptr_int (const char *sysroot ATTRIBUTE_UNUSED
,
566 const char *iprefix ATTRIBUTE_UNUSED
,
567 int stdinc ATTRIBUTE_UNUSED
)
572 #ifndef TARGET_EXTRA_INCLUDES
573 #define TARGET_EXTRA_INCLUDES hook_void_charptr_charptr_int
575 #ifndef TARGET_EXTRA_PRE_INCLUDES
576 #define TARGET_EXTRA_PRE_INCLUDES hook_void_charptr_charptr_int
579 struct target_c_incpath_s target_c_incpath
= { TARGET_EXTRA_PRE_INCLUDES
, TARGET_EXTRA_INCLUDES
};