gcc/incpath.c

   1 /* Set up combined include path chain for the preprocessor.
   2    Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
   3    1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2010
   4    Free Software Foundation, Inc.
   5
   6    Broken out of cppinit.c and cppfiles.c and rewritten Mar 2003.
   7
   8    This program is free software; you can redistribute it and/or modify it
   9    under the terms of the GNU General Public License as published by the
  10    Free Software Foundation; either version 3, or (at your option) any
  11    later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; see the file COPYING3.  If not see
  20    <http://www.gnu.org/licenses/>.  */
  21
  22 #include "config.h"
  23 #include "system.h"
  24 #include "coretypes.h"
  25 #include "machmode.h"
  26 #include "target.h"
  27 #include "tm.h"
  28 #include "cpplib.h"
  29 #include "prefix.h"
  30 #include "intl.h"
  31 #include "incpath.h"
  32 #include "cppdefault.h"
  33
  34 /* Microsoft Windows does not natively support inodes.
  35    VMS has non-numeric inodes.  */
  36 #ifdef VMS
  37 # define INO_T_EQ(A, B) (!memcmp (&(A), &(B), sizeof (A)))
  38 # define INO_T_COPY(DEST, SRC) memcpy(&(DEST), &(SRC), sizeof (SRC))
  39 #elif !defined (HOST_LACKS_INODE_NUMBERS)
  40 # define INO_T_EQ(A, B) ((A) == (B))
  41 # define INO_T_COPY(DEST, SRC) (DEST) = (SRC)
  42 #endif
  43
  44 #if defined INO_T_EQ
  45 #define DIRS_EQ(A, B) ((A)->dev == (B)->dev \
  46         && INO_T_EQ((A)->ino, (B)->ino))
  47 #else
  48 #define DIRS_EQ(A, B) (!strcmp ((A)->canonical_name, (B)->canonical_name))
  49 #endif
  50
  51 static const char dir_separator_str[] = { DIR_SEPARATOR, 0 };
  52
  53 static void add_env_var_paths (const char *, int);
  54 static void add_standard_paths (const char *, const char *, const char *, int);
  55 static void free_path (struct cpp_dir *, int);
  56 static void merge_include_chains (const char *, cpp_reader *, int);
  57 static void add_sysroot_to_chain (const char *, int);
  58 static struct cpp_dir *remove_duplicates (cpp_reader *, struct cpp_dir *,
  59                                            struct cpp_dir *,
  60                                            struct cpp_dir *, int);
  61
  62 /* Include chains heads and tails.  */
  63 static struct cpp_dir *heads[4];
  64 static struct cpp_dir *tails[4];
  65 static bool quote_ignores_source_dir;
  66 enum { REASON_QUIET = 0, REASON_NOENT, REASON_DUP, REASON_DUP_SYS };
  67
  68 /* Free an element of the include chain, possibly giving a reason.  */
  69 static void
  70 free_path (struct cpp_dir *path, int reason)
  71 {
  72   switch (reason)
  73     {
  74     case REASON_DUP:
  75     case REASON_DUP_SYS:
  76       fprintf (stderr, _("ignoring duplicate directory \"%s\"\n"), path->name);
  77       if (reason == REASON_DUP_SYS)
  78         fprintf (stderr,
  79  _("  as it is a non-system directory that duplicates a system directory\n"));
  80       break;
  81
  82     case REASON_NOENT:
  83       fprintf (stderr, _("ignoring nonexistent directory \"%s\"\n"),
  84                path->name);
  85       break;
  86
  87     case REASON_QUIET:
  88     default:
  89       break;
  90     }
  91
  92   free (path->name);
  93   free (path);
  94 }
  95
  96 /* Read ENV_VAR for a PATH_SEPARATOR-separated list of file names; and
  97    append all the names to the search path CHAIN.  */
  98 static void
  99 add_env_var_paths (const char *env_var, int chain)
 100 {
 101   char *p, *q, *path;
 102
 103   q = getenv (env_var);
 104
 105   if (!q)
 106     return;
 107
 108   for (p = q; *q; p = q + 1)
 109     {
 110       q = p;
 111       while (*q != 0 && *q != PATH_SEPARATOR)
 112         q++;
 113
 114       if (p == q)
 115         path = xstrdup (".");
 116       else
 117         {
 118           path = XNEWVEC (char, q - p + 1);
 119           memcpy (path, p, q - p);
 120           path[q - p] = '\0';
 121         }
 122
 123       add_path (path, chain, chain == SYSTEM, false);
 124     }
 125 }
 126
 127 /* Append the standard include chain defined in cppdefault.c.  */
 128 static void
 129 add_standard_paths (const char *sysroot, const char *iprefix,
 130                     const char *imultilib, int cxx_stdinc)
 131 {
 132   const struct default_include *p;
 133   int relocated = cpp_relocated();
 134   size_t len;
 135
 136   if (iprefix && (len = cpp_GCC_INCLUDE_DIR_len) != 0)
 137     {
 138       /* Look for directories that start with the standard prefix.
 139          "Translate" them, i.e. replace /usr/local/lib/gcc... with
 140          IPREFIX and search them first.  */
 141       for (p = cpp_include_defaults; p->fname; p++)
 142         {
 143           if (!p->cplusplus || cxx_stdinc)
 144             {
 145               /* Should we be translating sysrooted dirs too?  Assume
 146                  that iprefix and sysroot are mutually exclusive, for
 147                  now.  */
 148               if (sysroot && p->add_sysroot)
 149                 continue;
 150               if (!strncmp (p->fname, cpp_GCC_INCLUDE_DIR, len))
 151                 {
 152                   char *str = concat (iprefix, p->fname + len, NULL);
 153                   if (p->multilib == 1 && imultilib)
 154                     str = concat (str, dir_separator_str, imultilib, NULL);
 155                   else if (p->multilib == 2)
 156                     {
 157                       if (!imultiarch)
 158                         continue;
 159                       str = concat (str, dir_separator_str, imultiarch, NULL);
 160                     }
 161                   add_path (str, SYSTEM, p->cxx_aware, false);
 162                 }
 163             }
 164         }
 165     }
 166
 167   for (p = cpp_include_defaults; p->fname; p++)
 168     {
 169       if (!p->cplusplus || cxx_stdinc)
 170         {
 171           char *str;
 172
 173           /* Should this directory start with the sysroot?  */
 174           if (sysroot && p->add_sysroot)
 175             str = concat (sysroot, p->fname, NULL);
 176           else if (!p->add_sysroot && relocated
 177                    && strncmp (p->fname, cpp_PREFIX, cpp_PREFIX_len) == 0)
 178             {
 179               static const char *relocated_prefix;
 180               /* If this path starts with the configure-time prefix,
 181                  but the compiler has been relocated, replace it
 182                  with the run-time prefix.  The run-time exec prefix
 183                  is GCC_EXEC_PREFIX.  Compute the path from there back
 184                  to the toplevel prefix.  */
 185               if (!relocated_prefix)
 186                 {
 187                   char *dummy;
 188                   /* Make relative prefix expects the first argument
 189                      to be a program, not a directory.  */
 190                   dummy = concat (gcc_exec_prefix, "dummy", NULL);
 191                   relocated_prefix
 192                     = make_relative_prefix (dummy,
 193                                             cpp_EXEC_PREFIX,
 194                                             cpp_PREFIX);
 195                 }
 196               str = concat (relocated_prefix,
 197                             p->fname + cpp_PREFIX_len,
 198                             NULL);
 199               str = update_path (str, p->component);
 200             }
 201           else
 202             str = update_path (p->fname, p->component);
 203
 204           if (p->multilib == 1 && imultilib)
 205             str = concat (str, dir_separator_str, imultilib, NULL);
 206           else if (p->multilib == 2)
 207             {
 208               if (!imultiarch)
 209                 continue;
 210               str = concat (str, dir_separator_str, imultiarch, NULL);
 211             }
 212
 213           add_path (str, SYSTEM, p->cxx_aware, false);
 214         }
 215     }
 216 }
 217
 218 /* For each duplicate path in chain HEAD, keep just the first one.
 219    Remove each path in chain HEAD that also exists in chain SYSTEM.
 220    Set the NEXT pointer of the last path in the resulting chain to
 221    JOIN, unless it duplicates JOIN in which case the last path is
 222    removed.  Return the head of the resulting chain.  Any of HEAD,
 223    JOIN and SYSTEM can be NULL.  */
 224
 225 static struct cpp_dir *
 226 remove_duplicates (cpp_reader *pfile, struct cpp_dir *head,
 227                    struct cpp_dir *system, struct cpp_dir *join,
 228                    int verbose)
 229 {
 230   struct cpp_dir **pcur, *tmp, *cur;
 231   struct stat st;
 232
 233   for (pcur = &head; *pcur; )
 234     {
 235       int reason = REASON_QUIET;
 236
 237       cur = *pcur;
 238
 239       if (stat (cur->name, &st))
 240         {
 241           /* Dirs that don't exist are silently ignored, unless verbose.  */
 242           if (errno != ENOENT)
 243             cpp_errno (pfile, CPP_DL_ERROR, cur->name);
 244           else
 245             {
 246               /* If -Wmissing-include-dirs is given, warn.  */
 247               cpp_options *opts = cpp_get_options (pfile);
 248               if (opts->warn_missing_include_dirs && cur->user_supplied_p)
 249                 cpp_errno (pfile, CPP_DL_WARNING, cur->name);
 250               reason = REASON_NOENT;
 251             }
 252         }
 253       else if (!S_ISDIR (st.st_mode))
 254         cpp_error_with_line (pfile, CPP_DL_WARNING, 0, 0,
 255                              "%s: not a directory", cur->name);
 256       else
 257         {
 258 #if defined (INO_T_COPY)
 259           INO_T_COPY (cur->ino, st.st_ino);
 260           cur->dev  = st.st_dev;
 261 #endif
 262
 263           /* Remove this one if it is in the system chain.  */
 264           reason = REASON_DUP_SYS;
 265           for (tmp = system; tmp; tmp = tmp->next)
 266            if (DIRS_EQ (tmp, cur) && cur->construct == tmp->construct)
 267               break;
 268
 269           if (!tmp)
 270             {
 271               /* Duplicate of something earlier in the same chain?  */
 272               reason = REASON_DUP;
 273               for (tmp = head; tmp != cur; tmp = tmp->next)
 274                if (DIRS_EQ (cur, tmp) && cur->construct == tmp->construct)
 275                   break;
 276
 277               if (tmp == cur
 278                   /* Last in the chain and duplicate of JOIN?  */
 279                   && !(cur->next == NULL && join
 280                        && DIRS_EQ (cur, join)
 281                        && cur->construct == join->construct))
 282                 {
 283                   /* Unique, so keep this directory.  */
 284                   pcur = &cur->next;
 285                   continue;
 286                 }
 287             }
 288         }
 289
 290       /* Remove this entry from the chain.  */
 291       *pcur = cur->next;
 292       free_path (cur, verbose ? reason: REASON_QUIET);
 293     }
 294
 295   *pcur = join;
 296   return head;
 297 }
 298
 299 /* Add SYSROOT to any user-supplied paths in CHAIN starting with
 300    "=".  */
 301
 302 static void
 303 add_sysroot_to_chain (const char *sysroot, int chain)
 304 {
 305   struct cpp_dir *p;
 306
 307   for (p = heads[chain]; p != NULL; p = p->next)
 308     if (p->name[0] == '=' && p->user_supplied_p)
 309       p->name = concat (sysroot, p->name + 1, NULL);
 310 }
 311
 312 /* Merge the four include chains together in the order quote, bracket,
 313    system, after.  Remove duplicate dirs (determined in
 314    system-specific manner).
 315
 316    We can't just merge the lists and then uniquify them because then
 317    we may lose directories from the <> search path that should be
 318    there; consider -iquote foo -iquote bar -Ifoo -Iquux.  It is
 319    however safe to treat -iquote bar -iquote foo -Ifoo -Iquux as if
 320    written -iquote bar -Ifoo -Iquux.  */
 321
 322 static void
 323 merge_include_chains (const char *sysroot, cpp_reader *pfile, int verbose)
 324 {
 325   /* Add the sysroot to user-supplied paths starting with "=".  */
 326   if (sysroot)
 327     {
 328       add_sysroot_to_chain (sysroot, QUOTE);
 329       add_sysroot_to_chain (sysroot, BRACKET);
 330       add_sysroot_to_chain (sysroot, SYSTEM);
 331       add_sysroot_to_chain (sysroot, AFTER);
 332     }
 333
 334   /* Join the SYSTEM and AFTER chains.  Remove duplicates in the
 335      resulting SYSTEM chain.  */
 336   if (heads[SYSTEM])
 337     tails[SYSTEM]->next = heads[AFTER];
 338   else
 339     heads[SYSTEM] = heads[AFTER];
 340   heads[SYSTEM] = remove_duplicates (pfile, heads[SYSTEM], 0, 0, verbose);
 341
 342   /* Remove duplicates from BRACKET that are in itself or SYSTEM, and
 343      join it to SYSTEM.  */
 344   heads[BRACKET] = remove_duplicates (pfile, heads[BRACKET], heads[SYSTEM],
 345                                       heads[SYSTEM], verbose);
 346
 347   /* Remove duplicates from QUOTE that are in itself or SYSTEM, and
 348      join it to BRACKET.  */
 349   heads[QUOTE] = remove_duplicates (pfile, heads[QUOTE], heads[SYSTEM],
 350                                     heads[BRACKET], verbose);
 351
 352   /* If verbose, print the list of dirs to search.  */
 353   if (verbose)
 354     {
 355       struct cpp_dir *p;
 356
 357       fprintf (stderr, _("#include \"...\" search starts here:\n"));
 358       for (p = heads[QUOTE];; p = p->next)
 359         {
 360           if (p == heads[BRACKET])
 361             fprintf (stderr, _("#include <...> search starts here:\n"));
 362           if (!p)
 363             break;
 364           fprintf (stderr, " %s\n", p->name);
 365         }
 366       fprintf (stderr, _("End of search list.\n"));
 367     }
 368 }
 369
 370 /* Use given -I paths for #include "..." but not #include <...>, and
 371    don't search the directory of the present file for #include "...".
 372    (Note that -I. -I- is not the same as the default setup; -I. uses
 373    the compiler's working dir.)  */
 374 void
 375 split_quote_chain (void)
 376 {
 377   heads[QUOTE] = heads[BRACKET];
 378   tails[QUOTE] = tails[BRACKET];
 379   heads[BRACKET] = NULL;
 380   tails[BRACKET] = NULL;
 381   /* This is NOT redundant.  */
 382   quote_ignores_source_dir = true;
 383 }
 384
 385 /* Add P to the chain specified by CHAIN.  */
 386
 387 void
 388 add_cpp_dir_path (cpp_dir *p, int chain)
 389 {
 390   if (tails[chain])
 391     tails[chain]->next = p;
 392   else
 393     heads[chain] = p;
 394   tails[chain] = p;
 395 }
 396
 397 /* Add PATH to the include chain CHAIN. PATH must be malloc-ed and
 398    NUL-terminated.  */
 399 void
 400 add_path (char *path, int chain, int cxx_aware, bool user_supplied_p)
 401 {
 402   cpp_dir *p;
 403
 404 #if defined (HAVE_DOS_BASED_FILE_SYSTEM)
 405   /* Remove unnecessary trailing slashes.  On some versions of MS
 406      Windows, trailing  _forward_ slashes cause no problems for stat().
 407      On newer versions, stat() does not recognize a directory that ends
 408      in a '\\' or '/', unless it is a drive root dir, such as "c:/",
 409      where it is obligatory.  */
 410   int pathlen = strlen (path);
 411   char* end = path + pathlen - 1;
 412   /* Preserve the lead '/' or lead "c:/".  */
 413   char* start = path + (pathlen > 2 && path[1] == ':' ? 3 : 1);
 414
 415   for (; end > start && IS_DIR_SEPARATOR (*end); end--)
 416     *end = 0;
 417 #endif
 418
 419   p = XNEW (cpp_dir);
 420   p->next = NULL;
 421   p->name = path;
 422 #ifndef INO_T_EQ
 423   p->canonical_name = lrealpath (path);
 424 #endif
 425   if (chain == SYSTEM || chain == AFTER)
 426     p->sysp = 1 + !cxx_aware;
 427   else
 428     p->sysp = 0;
 429   p->construct = 0;
 430   p->user_supplied_p = user_supplied_p;
 431
 432   add_cpp_dir_path (p, chain);
 433 }
 434
 435 /* Exported function to handle include chain merging, duplicate
 436    removal, and registration with cpplib.  */
 437 void
 438 register_include_chains (cpp_reader *pfile, const char *sysroot,
 439                          const char *iprefix, const char *imultilib,
 440                          int stdinc, int cxx_stdinc, int verbose)
 441 {
 442   static const char *const lang_env_vars[] =
 443     { "C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH",
 444       "OBJC_INCLUDE_PATH", "OBJCPLUS_INCLUDE_PATH" };
 445   cpp_options *cpp_opts = cpp_get_options (pfile);
 446   size_t idx = (cpp_opts->objc ? 2: 0);
 447
 448   if (cpp_opts->cplusplus)
 449     idx++;
 450   else
 451     cxx_stdinc = false;
 452
 453   /* CPATH and language-dependent environment variables may add to the
 454      include chain.  */
 455   add_env_var_paths ("CPATH", BRACKET);
 456   add_env_var_paths (lang_env_vars[idx], SYSTEM);
 457
 458   target_c_incpath.extra_pre_includes (sysroot, iprefix, stdinc);
 459
 460   /* Finally chain on the standard directories.  */
 461   if (stdinc)
 462     add_standard_paths (sysroot, iprefix, imultilib, cxx_stdinc);
 463
 464   target_c_incpath.extra_includes (sysroot, iprefix, stdinc);
 465
 466   merge_include_chains (sysroot, pfile, verbose);
 467
 468   cpp_set_include_chains (pfile, heads[QUOTE], heads[BRACKET],
 469                           quote_ignores_source_dir);
 470 }
 471 #if !(defined TARGET_EXTRA_INCLUDES) || !(defined TARGET_EXTRA_PRE_INCLUDES)
 472 static void hook_void_charptr_charptr_int (const char *sysroot ATTRIBUTE_UNUSED,
 473                                            const char *iprefix ATTRIBUTE_UNUSED,
 474                                            int stdinc ATTRIBUTE_UNUSED)
 475 {
 476 }
 477 #endif
 478
 479 #ifndef TARGET_EXTRA_INCLUDES
 480 #define TARGET_EXTRA_INCLUDES hook_void_charptr_charptr_int
 481 #endif
 482 #ifndef TARGET_EXTRA_PRE_INCLUDES
 483 #define TARGET_EXTRA_PRE_INCLUDES hook_void_charptr_charptr_int
 484 #endif
 485
 486 struct target_c_incpath_s target_c_incpath = { TARGET_EXTRA_PRE_INCLUDES, TARGET_EXTRA_INCLUDES };
 487