]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/cppfiles.c
Restore definition of STRUCT_VALUE_REGNUM,
[thirdparty/gcc.git] / gcc / cppfiles.c
CommitLineData
add7091b 1/* Part of CPP library. (include file handling)
5e7b4e25 2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1998,
d6d52dd6 3 1999, 2000, 2001 Free Software Foundation, Inc.
add7091b
ZW
4 Written by Per Bothner, 1994.
5 Based on CCCP program by Paul Rubin, June 1986
6 Adapted to ANSI C, Richard Stallman, Jan 1987
7 Split out of cpplib.c, Zack Weinberg, Oct 1998
8
9This program is free software; you can redistribute it and/or modify it
10under the terms of the GNU General Public License as published by the
11Free Software Foundation; either version 2, or (at your option) any
12later version.
13
14This program is distributed in the hope that it will be useful,
15but WITHOUT ANY WARRANTY; without even the implied warranty of
16MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17GNU General Public License for more details.
18
19You should have received a copy of the GNU General Public License
20along with this program; if not, write to the Free Software
e38992e8 21Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
add7091b
ZW
22
23#include "config.h"
24#include "system.h"
add7091b 25#include "cpplib.h"
88ae23e7 26#include "cpphash.h"
c1212d2f 27#include "intl.h"
168d3732 28#include "mkdeps.h"
c31a6508 29#include "splay-tree.h"
add7091b 30
f8f769ea
ZW
31#ifdef HAVE_MMAP_FILE
32# include <sys/mman.h>
33# ifndef MMAP_THRESHOLD
34# define MMAP_THRESHOLD 3 /* Minimum page count to mmap the file. */
35# endif
36
37#else /* No MMAP_FILE */
38# undef MMAP_THRESHOLD
39# define MMAP_THRESHOLD 0
40#endif
41
d7a2e0f7
ZW
42#ifndef O_BINARY
43# define O_BINARY 0
44#endif
45
a58d32c2
ZW
46/* If errno is inspected immediately after a system call fails, it will be
47 nonzero, and no error number will ever be zero. */
48#ifndef ENOENT
49# define ENOENT 0
50#endif
51#ifndef ENOTDIR
52# define ENOTDIR 0
53#endif
a58d32c2 54
f9a0e96c
ZW
55/* Suppress warning about function macros used w/o arguments in traditional
56 C. It is unlikely that glibc's strcmp macro helps this file at all. */
57#undef strcmp
58
642ce434
NB
59/* This structure is used for the table of all includes. */
60struct include_file
61{
62 const char *name; /* actual path name of file */
63 const cpp_hashnode *cmacro; /* macro, if any, preventing reinclusion. */
591e15a1 64 const struct search_path *foundhere;
642ce434
NB
65 /* location in search path where file was
66 found, for #include_next and sysp. */
67 const unsigned char *buffer; /* pointer to cached file contents */
68 struct stat st; /* copy of stat(2) data for file */
69 int fd; /* fd open on file (short term storage only) */
f277b5e0 70 int err_no; /* errno obtained if opening a file failed */
642ce434
NB
71 unsigned short include_count; /* number of times file has been read */
72 unsigned short refcnt; /* number of stacked buffers using this file */
73 unsigned char mapped; /* file buffer is mmapped */
642ce434
NB
74};
75
ae1139f9
DR
76/* Variable length record files on VMS will have a stat size that includes
77 record control characters that won't be included in the read size. */
78#ifdef VMS
79# define FAB_C_VAR 2 /* variable length records (see Starlet fabdef.h) */
80# define STAT_SIZE_TOO_BIG(ST) ((ST).st_fab_rfm == FAB_C_VAR)
81#else
82# define STAT_SIZE_TOO_BIG(ST) 0
83#endif
84
28e0f040
NB
85/* The cmacro works like this: If it's NULL, the file is to be
86 included again. If it's NEVER_REREAD, the file is never to be
87 included again. Otherwise it is a macro hashnode, and the file is
ba133c96 88 to be included again if the macro is defined. */
28e0f040
NB
89#define NEVER_REREAD ((const cpp_hashnode *)-1)
90#define DO_NOT_REREAD(inc) \
91((inc)->cmacro && ((inc)->cmacro == NEVER_REREAD \
ba133c96 92 || (inc)->cmacro->type == NT_MACRO))
41947a54 93#define NO_INCLUDE_PATH ((struct include_file *) -1)
28e0f040 94
a73ac7a5 95static struct file_name_map *read_name_map
38b24ee2
ZW
96 PARAMS ((cpp_reader *, const char *));
97static char *read_filename_string PARAMS ((int, FILE *));
98static char *remap_filename PARAMS ((cpp_reader *, char *,
591e15a1
NB
99 struct search_path *));
100static struct search_path *search_from PARAMS ((cpp_reader *,
ba133c96 101 enum include_type));
41947a54 102static struct include_file *
ba133c96
NB
103 find_include_file PARAMS ((cpp_reader *, const cpp_token *,
104 enum include_type));
2047e26f 105static struct include_file *open_file PARAMS ((cpp_reader *, const char *));
7c092714 106static int read_include_file PARAMS ((cpp_reader *, struct include_file *));
e5eba70a 107static bool stack_include_file PARAMS ((cpp_reader *, struct include_file *));
a58d32c2 108static void purge_cache PARAMS ((struct include_file *));
a36c54fa 109static void destroy_node PARAMS ((splay_tree_value));
c71f835b 110static int report_missing_guard PARAMS ((splay_tree_node, void *));
a36c54fa
NB
111static splay_tree_node find_or_create_entry PARAMS ((cpp_reader *,
112 const char *));
113static void handle_missing_header PARAMS ((cpp_reader *, const char *, int));
f9200da2 114static int remove_component_p PARAMS ((const char *));
a36c54fa
NB
115
116/* Set up the splay tree we use to store information about all the
117 file names seen in this compilation. We also have entries for each
118 file we tried to open but failed; this saves system calls since we
119 don't try to open it again in future.
120
121 The key of each node is the file name, after processing by
122 _cpp_simplify_pathname. The path name may or may not be absolute.
123 The path string has been malloced, as is automatically freed by
124 registering free () as the splay tree key deletion function.
125
126 A node's value is a pointer to a struct include_file, and is never
127 NULL. */
d35364d1 128void
c71f835b 129_cpp_init_includes (pfile)
d35364d1
ZW
130 cpp_reader *pfile;
131{
132 pfile->all_include_files
c31a6508
ZW
133 = splay_tree_new ((splay_tree_compare_fn) strcmp,
134 (splay_tree_delete_key_fn) free,
a36c54fa 135 destroy_node);
0b3d776a 136}
add7091b 137
a36c54fa 138/* Tear down the splay tree. */
c71f835b
ZW
139void
140_cpp_cleanup_includes (pfile)
141 cpp_reader *pfile;
142{
143 splay_tree_delete (pfile->all_include_files);
144}
145
a36c54fa
NB
146/* Free a node. The path string is automatically freed. */
147static void
148destroy_node (v)
149 splay_tree_value v;
150{
151 struct include_file *f = (struct include_file *)v;
152
153 if (f)
154 {
155 purge_cache (f);
156 free (f);
157 }
158}
159
642ce434
NB
160/* Mark a file to not be reread (e.g. #import, read failure). */
161void
162_cpp_never_reread (file)
163 struct include_file *file;
164{
165 file->cmacro = NEVER_REREAD;
166}
167
ba133c96 168/* Lookup a filename, which is simplified after making a copy, and
f9200da2
NB
169 create an entry if none exists. errno is nonzero iff a (reported)
170 stat() error occurred during simplification. */
a36c54fa
NB
171static splay_tree_node
172find_or_create_entry (pfile, fname)
d6d52dd6
NB
173 cpp_reader *pfile;
174 const char *fname;
175{
a36c54fa
NB
176 splay_tree_node node;
177 struct include_file *file;
ba133c96 178 char *name = xstrdup (fname);
d6d52dd6 179
ba133c96
NB
180 _cpp_simplify_pathname (name);
181 node = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) name);
182 if (node)
183 free (name);
184 else
d6d52dd6 185 {
a36c54fa 186 file = xcnew (struct include_file);
ba133c96 187 file->name = name;
f277b5e0 188 file->err_no = errno;
a36c54fa
NB
189 node = splay_tree_insert (pfile->all_include_files,
190 (splay_tree_key) file->name,
191 (splay_tree_value) file);
d6d52dd6 192 }
a36c54fa
NB
193
194 return node;
195}
196
ba133c96 197/* Enter a file name in the splay tree, for the sake of cpp_included. */
a36c54fa
NB
198void
199_cpp_fake_include (pfile, fname)
200 cpp_reader *pfile;
201 const char *fname;
202{
203 find_or_create_entry (pfile, fname);
d6d52dd6
NB
204}
205
a58d32c2 206/* Given a file name, look it up in the cache; if there is no entry,
2047e26f
NB
207 create one with a non-NULL value (regardless of success in opening
208 the file). If the file doesn't exist or is inaccessible, this
209 entry is flagged so we don't attempt to open it again in the
373e2177
NB
210 future. If the file isn't open, open it. The empty string is
211 interpreted as stdin.
2047e26f
NB
212
213 Returns an include_file structure with an open file descriptor on
214 success, or NULL on failure. */
add7091b 215
c31a6508 216static struct include_file *
2047e26f 217open_file (pfile, filename)
c31a6508
ZW
218 cpp_reader *pfile;
219 const char *filename;
2047e26f 220{
a36c54fa
NB
221 splay_tree_node nd = find_or_create_entry (pfile, filename);
222 struct include_file *file = (struct include_file *) nd->value;
add7091b 223
f277b5e0
NB
224 if (file->err_no)
225 {
226 /* Ugh. handle_missing_header () needs errno to be set. */
227 errno = file->err_no;
228 return 0;
229 }
2047e26f 230
ec5c56db 231 /* Don't reopen an idempotent file. */
a36c54fa
NB
232 if (DO_NOT_REREAD (file))
233 return file;
def3263a 234
ec5c56db 235 /* Don't reopen one which is already loaded. */
a36c54fa
NB
236 if (file->buffer != NULL)
237 return file;
add7091b 238
c31a6508
ZW
239 /* We used to open files in nonblocking mode, but that caused more
240 problems than it solved. Do take care not to acquire a
241 controlling terminal by mistake (this can't happen on sane
242 systems, but paranoia is a virtue).
add7091b 243
c31a6508
ZW
244 Use the three-argument form of open even though we aren't
245 specifying O_CREAT, to defend against broken system headers.
add7091b 246
c31a6508
ZW
247 O_BINARY tells some runtime libraries (notably DJGPP) not to do
248 newline translation; we can handle DOS line breaks just fine
249 ourselves.
b0699dad 250
c31a6508 251 Special case: the empty string is translated to stdin. */
d4506961 252
c31a6508 253 if (filename[0] == '\0')
2047e26f 254 file->fd = 0;
f2d5f0cc 255 else
ba133c96 256 file->fd = open (file->name, O_RDONLY | O_NOCTTY | O_BINARY, 0666);
a58d32c2 257
2047e26f
NB
258 if (file->fd != -1 && fstat (file->fd, &file->st) == 0)
259 {
c0bfe993
NB
260 if (!S_ISDIR (file->st.st_mode))
261 return file;
7c092714
NB
262 /* If it's a directory, we return null and continue the search
263 as the file we're looking for may appear elsewhere in the
264 search path. */
c0bfe993 265 errno = ENOENT;
2047e26f 266 }
a58d32c2 267
f277b5e0 268 file->err_no = errno;
a58d32c2
ZW
269 return 0;
270}
271
e5eba70a
NB
272/* Place the file referenced by INC into a new buffer on the buffer
273 stack, unless there are errors, or the file is not re-included
274 because of e.g. multiple-include guards. Returns true if a buffer
275 is stacked. */
a58d32c2 276
e5eba70a 277static bool
a58d32c2
ZW
278stack_include_file (pfile, inc)
279 cpp_reader *pfile;
280 struct include_file *inc;
281{
282 cpp_buffer *fp;
e5eba70a 283 int sysp;
bb74c963 284 const char *filename;
51d0f328 285
e5eba70a
NB
286 if (DO_NOT_REREAD (inc))
287 return false;
288
47d89cf3 289 sysp = MAX ((pfile->map ? pfile->map->sysp : 0),
11bca309 290 (inc->foundhere ? inc->foundhere->sysp : 0));
51d0f328
NB
291
292 /* For -M, add the file to the dependencies on its first inclusion. */
e5eba70a 293 if (CPP_OPTION (pfile, print_deps) > sysp && !inc->include_count)
51d0f328
NB
294 deps_add_dep (pfile->deps, inc->name);
295
7c092714 296 /* Not in cache? */
e5eba70a 297 if (! inc->buffer)
7c092714 298 {
4d6baafa 299 if (read_include_file (pfile, inc))
e5eba70a 300 {
c0bfe993 301 /* If an error occurs, do not try to read this file again. */
e5eba70a
NB
302 _cpp_never_reread (inc);
303 return false;
304 }
4d6baafa
NB
305 /* Mark a regular, zero-length file never-reread. We read it,
306 NUL-terminate it, and stack it once, so preprocessing a main
307 file of zero length does not raise an error. */
308 if (S_ISREG (inc->st.st_mode) && inc->st.st_size == 0)
309 _cpp_never_reread (inc);
7c092714
NB
310 close (inc->fd);
311 inc->fd = -1;
312 }
313
e5eba70a 314 if (pfile->buffer)
5993019d
NB
315 /* We don't want MI guard advice for the main file. */
316 inc->include_count++;
eb1f4d9d
NB
317
318 /* Push a buffer. */
29401c30
NB
319 fp = cpp_push_buffer (pfile, inc->buffer, inc->st.st_size,
320 /* from_stage3 */ CPP_OPTION (pfile, preprocessed), 0);
eb1f4d9d 321 fp->inc = inc;
3cf3593f 322 fp->inc->refcnt++;
a58d32c2 323
3cf3593f 324 /* Initialise controlling macro state. */
6d18adbc 325 pfile->mi_valid = true;
3cf3593f 326 pfile->mi_cmacro = 0;
eb1f4d9d
NB
327
328 /* Generate the call back. */
bb74c963
NB
329 filename = inc->name;
330 if (*filename == '\0')
331 filename = _("<stdin>");
332 _cpp_do_file_change (pfile, LC_ENTER, filename, 1, sysp);
e5eba70a
NB
333
334 return true;
a58d32c2
ZW
335}
336
337/* Read the file referenced by INC into the file cache.
338
339 If fd points to a plain file, we might be able to mmap it; we can
340 definitely allocate the buffer all at once. If fd is a pipe or
341 terminal, we can't do either. If fd is something weird, like a
7c092714 342 block device, we don't want to read it at all.
a58d32c2
ZW
343
344 Unfortunately, different systems use different st.st_mode values
345 for pipes: some have S_ISFIFO, some S_ISSOCK, some are buggy and
346 zero the entire struct stat except a couple fields. Hence we don't
7c092714
NB
347 even try to figure out what something is, except for plain files
348 and block devices.
a58d32c2
ZW
349
350 FIXME: Flush file cache and try again if we run out of memory. */
351
7c092714 352static int
a58d32c2
ZW
353read_include_file (pfile, inc)
354 cpp_reader *pfile;
355 struct include_file *inc;
356{
357 ssize_t size, offset, count;
358 U_CHAR *buf;
359#if MMAP_THRESHOLD
360 static int pagesize = -1;
361#endif
362
363 if (S_ISREG (inc->st.st_mode))
f2d5f0cc 364 {
a58d32c2
ZW
365 /* off_t might have a wider range than ssize_t - in other words,
366 the max size of a file might be bigger than the address
367 space. We can't handle a file that large. (Anyone with
368 a single source file bigger than 2GB needs to rethink
369 their coding style.) Some systems (e.g. AIX 4.1) define
370 SSIZE_MAX to be much smaller than the actual range of the
371 type. Use INTTYPE_MAXIMUM unconditionally to ensure this
372 does not bite us. */
373 if (inc->st.st_size > INTTYPE_MAXIMUM (ssize_t))
f2d5f0cc 374 {
a58d32c2
ZW
375 cpp_error (pfile, "%s is too large", inc->name);
376 goto fail;
f2d5f0cc 377 }
a58d32c2
ZW
378 size = inc->st.st_size;
379
ae0f4dee 380 inc->mapped = 0;
a58d32c2
ZW
381#if MMAP_THRESHOLD
382 if (pagesize == -1)
383 pagesize = getpagesize ();
384
07e96fc6
ZW
385 /* Use mmap if the file is big enough to be worth it (controlled
386 by MMAP_THRESHOLD) and if we can safely count on there being
387 at least one readable NUL byte after the end of the file's
388 contents. This is true for all tested operating systems when
389 the file size is not an exact multiple of the page size. */
4d6baafa
NB
390 if (size / pagesize >= MMAP_THRESHOLD
391 && (size % pagesize) != 0)
a58d32c2
ZW
392 {
393 buf = (U_CHAR *) mmap (0, size, PROT_READ, MAP_PRIVATE, inc->fd, 0);
394 if (buf == (U_CHAR *)-1)
395 goto perror_fail;
396 inc->mapped = 1;
397 }
398 else
c31a6508 399#endif
d4506961 400 {
4d6baafa 401 buf = (U_CHAR *) xmalloc (size + 1);
a58d32c2
ZW
402 offset = 0;
403 while (offset < size)
404 {
405 count = read (inc->fd, buf + offset, size - offset);
406 if (count < 0)
407 goto perror_fail;
408 if (count == 0)
409 {
ae1139f9
DR
410 if (!STAT_SIZE_TOO_BIG (inc->st))
411 cpp_warning
412 (pfile, "%s is shorter than expected", inc->name);
413 buf = xrealloc (buf, offset);
414 inc->st.st_size = offset;
a58d32c2
ZW
415 break;
416 }
417 offset += count;
418 }
4d6baafa
NB
419 /* The lexer requires that the buffer be NUL-terminated. */
420 buf[size] = '\0';
d4506961 421 }
a58d32c2
ZW
422 }
423 else if (S_ISBLK (inc->st.st_mode))
424 {
425 cpp_error (pfile, "%s is a block device", inc->name);
426 goto fail;
427 }
a58d32c2
ZW
428 else
429 {
430 /* 8 kilobytes is a sensible starting size. It ought to be
431 bigger than the kernel pipe buffer, and it's definitely
432 bigger than the majority of C source files. */
433 size = 8 * 1024;
d4506961 434
4d6baafa 435 buf = (U_CHAR *) xmalloc (size + 1);
a58d32c2
ZW
436 offset = 0;
437 while ((count = read (inc->fd, buf + offset, size - offset)) > 0)
f2d5f0cc 438 {
a58d32c2
ZW
439 offset += count;
440 if (offset == size)
4d6baafa
NB
441 {
442 size *= 2;
443 buf = xrealloc (buf, size + 1);
444 }
f2d5f0cc 445 }
a58d32c2
ZW
446 if (count < 0)
447 goto perror_fail;
448
4d6baafa
NB
449 if (offset + 1 < size)
450 buf = xrealloc (buf, offset + 1);
451
452 /* The lexer requires that the buffer be NUL-terminated. */
453 buf[offset] = '\0';
a58d32c2 454 inc->st.st_size = offset;
f2d5f0cc 455 }
d7a2e0f7 456
a58d32c2 457 inc->buffer = buf;
7c092714 458 return 0;
a58d32c2
ZW
459
460 perror_fail:
461 cpp_error_from_errno (pfile, inc->name);
462 fail:
7c092714 463 return 1;
a58d32c2
ZW
464}
465
466static void
467purge_cache (inc)
468 struct include_file *inc;
469{
470 if (inc->buffer)
c31a6508 471 {
ae0f4dee 472#if MMAP_THRESHOLD
a58d32c2 473 if (inc->mapped)
6f84c9bd 474 munmap ((PTR) inc->buffer, inc->st.st_size);
a58d32c2 475 else
ae0f4dee 476#endif
a58d32c2
ZW
477 free ((PTR) inc->buffer);
478 inc->buffer = NULL;
c31a6508 479 }
e576beb0
ZW
480}
481
c31a6508
ZW
482/* Return 1 if the file named by FNAME has been included before in
483 any context, 0 otherwise. */
484int
485cpp_included (pfile, fname)
add7091b 486 cpp_reader *pfile;
bcc5cac9 487 const char *fname;
add7091b 488{
591e15a1 489 struct search_path *path;
e7182666 490 char *name, *n;
c31a6508 491 splay_tree_node nd;
0b3d776a 492
05e81724 493 if (IS_ABSOLUTE_PATHNAME (fname))
0b3d776a 494 {
c31a6508
ZW
495 /* Just look it up. */
496 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) fname);
497 return (nd && nd->value);
0b3d776a 498 }
c31a6508
ZW
499
500 /* Search directory path for the file. */
b6464a73 501 name = (char *) alloca (strlen (fname) + pfile->max_include_len + 2);
c31a6508 502 for (path = CPP_OPTION (pfile, quote_include); path; path = path->next)
0b3d776a 503 {
591e15a1
NB
504 memcpy (name, path->name, path->len);
505 name[path->len] = '/';
506 strcpy (&name[path->len + 1], fname);
c31a6508 507 if (CPP_OPTION (pfile, remap))
e7182666
NB
508 n = remap_filename (pfile, name, path);
509 else
ba133c96 510 n = name;
c31a6508 511
e7182666 512 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) n);
c31a6508
ZW
513 if (nd && nd->value)
514 return 1;
0b3d776a 515 }
c31a6508 516 return 0;
add7091b
ZW
517}
518
41947a54
NB
519/* Search for HEADER. Return 0 if there is no such file (or it's
520 un-openable), in which case an error code will be in errno. If
521 there is no include path to use it returns NO_INCLUDE_PATH,
522 otherwise an include_file structure. If this request originates
523 from a #include_next directive, set INCLUDE_NEXT to true. */
c31a6508
ZW
524
525static struct include_file *
ba133c96 526find_include_file (pfile, header, type)
f2d5f0cc 527 cpp_reader *pfile;
41947a54 528 const cpp_token *header;
ba133c96 529 enum include_type type;
f2d5f0cc 530{
41947a54 531 const char *fname = (const char *) header->val.str.text;
591e15a1 532 struct search_path *path;
c31a6508 533 struct include_file *file;
e7182666 534 char *name, *n;
add7091b 535
05e81724 536 if (IS_ABSOLUTE_PATHNAME (fname))
2047e26f 537 return open_file (pfile, fname);
41947a54
NB
538
539 /* For #include_next, skip in the search path past the dir in which
e7182666
NB
540 the current file was found, but if it was found via an absolute
541 path use the normal search logic. */
ba133c96 542 if (type == IT_INCLUDE_NEXT && pfile->buffer->inc->foundhere)
41947a54
NB
543 path = pfile->buffer->inc->foundhere->next;
544 else if (header->type == CPP_HEADER_NAME)
545 path = CPP_OPTION (pfile, bracket_include);
546 else
ba133c96 547 path = search_from (pfile, type);
41947a54
NB
548
549 if (path == NULL)
550 {
1f978f5f 551 cpp_error (pfile, "no include path in which to find %s", fname);
41947a54
NB
552 return NO_INCLUDE_PATH;
553 }
554
c31a6508 555 /* Search directory path for the file. */
b6464a73 556 name = (char *) alloca (strlen (fname) + pfile->max_include_len + 2);
41947a54 557 for (; path; path = path->next)
add7091b 558 {
591e15a1
NB
559 memcpy (name, path->name, path->len);
560 name[path->len] = '/';
561 strcpy (&name[path->len + 1], fname);
c31a6508 562 if (CPP_OPTION (pfile, remap))
e7182666
NB
563 n = remap_filename (pfile, name, path);
564 else
ba133c96 565 n = name;
c31a6508 566
e7182666 567 file = open_file (pfile, n);
c31a6508 568 if (file)
add7091b 569 {
c31a6508
ZW
570 file->foundhere = path;
571 return file;
add7091b
ZW
572 }
573 }
591e15a1 574
c31a6508 575 return 0;
add7091b
ZW
576}
577
e605b040 578/* Not everyone who wants to set system-header-ness on a buffer can
642ce434
NB
579 see the details of a buffer. This is an exported interface because
580 fix-header needs it. */
e605b040 581void
614c7d37 582cpp_make_system_header (pfile, syshdr, externc)
e605b040 583 cpp_reader *pfile;
614c7d37 584 int syshdr, externc;
e605b040 585{
614c7d37
NB
586 int flags = 0;
587
588 /* 1 = system header, 2 = system header to be treated as C. */
589 if (syshdr)
590 flags = 1 + (externc != 0);
47d89cf3
NB
591 _cpp_do_file_change (pfile, LC_RENAME, pfile->map->to_file,
592 SOURCE_LINE (pfile->map, pfile->line), flags);
e605b040
ZW
593}
594
c71f835b
ZW
595/* Report on all files that might benefit from a multiple include guard.
596 Triggered by -H. */
597void
598_cpp_report_missing_guards (pfile)
599 cpp_reader *pfile;
600{
601 int banner = 0;
602 splay_tree_foreach (pfile->all_include_files, report_missing_guard,
603 (PTR) &banner);
604}
605
606static int
607report_missing_guard (n, b)
608 splay_tree_node n;
609 void *b;
610{
611 struct include_file *f = (struct include_file *) n->value;
612 int *bannerp = (int *)b;
613
614 if (f && f->cmacro == 0 && f->include_count == 1)
615 {
616 if (*bannerp == 0)
617 {
618 fputs (_("Multiple include guards may be useful for:\n"), stderr);
619 *bannerp = 1;
620 }
621 fputs (f->name, stderr);
622 putc ('\n', stderr);
623 }
624 return 0;
625}
626
6d2f8887 627/* Create a dependency, or issue an error message as appropriate. */
a36c54fa
NB
628static void
629handle_missing_header (pfile, fname, angle_brackets)
630 cpp_reader *pfile;
631 const char *fname;
632 int angle_brackets;
633{
d8693c6f 634 int print_dep = CPP_PRINT_DEPS(pfile) > (angle_brackets || pfile->map->sysp);
7c092714 635
a36c54fa
NB
636 if (CPP_OPTION (pfile, print_deps_missing_files) && print_dep)
637 {
638 if (!angle_brackets || IS_ABSOLUTE_PATHNAME (fname))
639 deps_add_dep (pfile->deps, fname);
640 else
641 {
642 /* If requested as a system header, assume it belongs in
643 the first system header directory. */
644 struct search_path *ptr = CPP_OPTION (pfile, bracket_include);
645 char *p;
646 int len = 0, fname_len = strlen (fname);
647
648 if (ptr)
649 len = ptr->len;
650
651 p = (char *) alloca (len + fname_len + 2);
652 if (len)
653 {
654 memcpy (p, ptr->name, len);
655 p[len++] = '/';
656 }
657 memcpy (p + len, fname, fname_len + 1);
a36c54fa
NB
658 deps_add_dep (pfile->deps, p);
659 }
660 }
e7182666
NB
661 /* If -M was specified, then don't count this as an error, because
662 we can still produce correct output. Otherwise, we can't produce
663 correct output, because there may be dependencies we need inside
664 the missing file, and we don't know what directory this missing
a1f300c0 665 file exists in. FIXME: Use a future cpp_diagnostic_with_errno ()
e7182666 666 for both of these cases. */
a36c54fa 667 else if (CPP_PRINT_DEPS (pfile) && ! print_dep)
e7182666 668 cpp_warning (pfile, "%s: %s", fname, xstrerror (errno));
a36c54fa
NB
669 else
670 cpp_error_from_errno (pfile, fname);
671}
672
e5eba70a
NB
673/* Handles #include-family directives, and the command line -imacros
674 and -include. Returns true if a buffer was stacked. */
675bool
ba133c96 676_cpp_execute_include (pfile, header, type)
168d3732 677 cpp_reader *pfile;
93c80368 678 const cpp_token *header;
ba133c96 679 enum include_type type;
168d3732 680{
e5eba70a 681 bool stacked = false;
ba133c96 682 struct include_file *inc = find_include_file (pfile, header, type);
642ce434 683
41947a54
NB
684 if (inc == 0)
685 handle_missing_header (pfile, (const char *) header->val.str.text,
686 header->type == CPP_HEADER_NAME);
687 else if (inc != NO_INCLUDE_PATH)
168d3732 688 {
e5eba70a 689 stacked = stack_include_file (pfile, inc);
51d0f328 690
ba133c96 691 if (type == IT_IMPORT)
e7182666 692 _cpp_never_reread (inc);
168d3732 693 }
ba133c96 694
e5eba70a 695 return stacked;
168d3732
ZW
696}
697
41947a54
NB
698/* Locate HEADER, and determine whether it is newer than the current
699 file. If it cannot be located or dated, return -1, if it is newer
700 newer, return 1, otherwise 0. */
f3f751ad 701int
41947a54 702_cpp_compare_file_date (pfile, header)
f3f751ad 703 cpp_reader *pfile;
41947a54 704 const cpp_token *header;
f3f751ad 705{
41947a54 706 struct include_file *inc = find_include_file (pfile, header, 0);
f3f751ad 707
41947a54 708 if (inc == NULL || inc == NO_INCLUDE_PATH)
f3f751ad 709 return -1;
41947a54 710
a58d32c2 711 if (inc->fd > 0)
f3f751ad 712 {
f3f751ad
NS
713 close (inc->fd);
714 inc->fd = -1;
715 }
a58d32c2 716
41947a54 717 return inc->st.st_mtime > pfile->buffer->inc->st.st_mtime;
f3f751ad
NS
718}
719
720
e5eba70a
NB
721/* Push an input buffer and load it up with the contents of FNAME. If
722 FNAME is "", read standard input. Return true if a buffer was
723 stacked. */
724bool
614c7d37 725_cpp_read_file (pfile, fname)
c45da1ca
ZW
726 cpp_reader *pfile;
727 const char *fname;
728{
373e2177 729 struct include_file *f = open_file (pfile, fname);
c45da1ca 730
041c3194 731 if (f == NULL)
c0bfe993
NB
732 {
733 cpp_error_from_errno (pfile, fname);
734 return false;
735 }
041c3194 736
c0bfe993 737 return stack_include_file (pfile, f);
f8f769ea
ZW
738}
739
f9a0e96c 740/* Do appropriate cleanup when a file buffer is popped off the input
29401c30 741 stack. Push the next -include file, if any remain. */
f9a0e96c 742void
29401c30 743_cpp_pop_file_buffer (pfile, inc)
f9a0e96c 744 cpp_reader *pfile;
29401c30 745 struct include_file *inc;
f9a0e96c 746{
ba133c96 747 /* Record the inclusion-preventing macro, which could be NULL
6d18adbc
NB
748 meaning no controlling macro. */
749 if (pfile->mi_valid && inc->cmacro == NULL)
ba133c96 750 inc->cmacro = pfile->mi_cmacro;
93c80368
NB
751
752 /* Invalidate control macros in the #including file. */
6d18adbc 753 pfile->mi_valid = false;
f9a0e96c 754
a58d32c2
ZW
755 inc->refcnt--;
756 if (inc->refcnt == 0 && DO_NOT_REREAD (inc))
757 purge_cache (inc);
29401c30
NB
758
759 /* Don't generate a callback for popping the main file. */
760 if (pfile->buffer)
761 {
762 _cpp_do_file_change (pfile, LC_LEAVE, 0, 0, 0);
763
764 /* Finally, push the next -included file, if any. */
765 if (!pfile->buffer->prev)
766 _cpp_push_next_buffer (pfile);
767 }
f9a0e96c
ZW
768}
769
591e15a1
NB
770/* Returns the first place in the include chain to start searching for
771 "" includes. This involves stripping away the basename of the
ba133c96
NB
772 current file, unless -I- was specified.
773
774 If we're handling -include or -imacros, use the "" chain, but with
775 the preprocessor's cwd prepended. */
591e15a1 776static struct search_path *
ba133c96 777search_from (pfile, type)
591e15a1 778 cpp_reader *pfile;
ba133c96 779 enum include_type type;
591e15a1
NB
780{
781 cpp_buffer *buffer = pfile->buffer;
782 unsigned int dlen;
783
ba133c96
NB
784 /* Command line uses the cwd, and does not cache the result. */
785 if (type == IT_CMDLINE)
786 goto use_cwd;
787
591e15a1
NB
788 /* Ignore the current file's directory if -I- was given. */
789 if (CPP_OPTION (pfile, ignore_srcdir))
790 return CPP_OPTION (pfile, quote_include);
791
ba133c96 792 if (! buffer->search_cached)
591e15a1 793 {
ba133c96 794 buffer->search_cached = 1;
591e15a1 795
ba133c96 796 dlen = lbasename (buffer->inc->name) - buffer->inc->name;
591e15a1 797
ba133c96
NB
798 if (dlen)
799 {
800 /* We don't guarantee NAME is null-terminated. This saves
29401c30 801 allocating and freeing memory. Drop a trailing '/'. */
ba133c96
NB
802 buffer->dir.name = buffer->inc->name;
803 if (dlen > 1)
804 dlen--;
805 }
806 else
807 {
808 use_cwd:
809 buffer->dir.name = ".";
810 dlen = 1;
811 }
812
813 if (dlen > pfile->max_include_len)
814 pfile->max_include_len = dlen;
815
816 buffer->dir.len = dlen;
817 buffer->dir.next = CPP_OPTION (pfile, quote_include);
47d89cf3 818 buffer->dir.sysp = pfile->map->sysp;
ba133c96 819 }
591e15a1
NB
820
821 return &buffer->dir;
822}
823
c31a6508
ZW
824/* The file_name_map structure holds a mapping of file names for a
825 particular directory. This mapping is read from the file named
826 FILE_NAME_MAP_FILE in that directory. Such a file can be used to
827 map filenames on a file system with severe filename restrictions,
828 such as DOS. The format of the file name map file is just a series
829 of lines with two tokens on each line. The first token is the name
830 to map, and the second token is the actual name to use. */
831
832struct file_name_map
833{
834 struct file_name_map *map_next;
835 char *map_from;
836 char *map_to;
837};
838
839#define FILE_NAME_MAP_FILE "header.gcc"
840
841/* Read a space delimited string of unlimited length from a stdio
842 file. */
843
844static char *
845read_filename_string (ch, f)
846 int ch;
847 FILE *f;
848{
849 char *alloc, *set;
850 int len;
851
852 len = 20;
853 set = alloc = xmalloc (len + 1);
854 if (! is_space(ch))
855 {
856 *set++ = ch;
857 while ((ch = getc (f)) != EOF && ! is_space(ch))
858 {
859 if (set - alloc == len)
860 {
861 len *= 2;
862 alloc = xrealloc (alloc, len + 1);
863 set = alloc + len / 2;
864 }
865 *set++ = ch;
866 }
867 }
868 *set = '\0';
869 ungetc (ch, f);
870 return alloc;
871}
872
873/* This structure holds a linked list of file name maps, one per directory. */
874
875struct file_name_map_list
876{
877 struct file_name_map_list *map_list_next;
878 char *map_list_name;
879 struct file_name_map *map_list_map;
880};
881
882/* Read the file name map file for DIRNAME. */
883
884static struct file_name_map *
885read_name_map (pfile, dirname)
886 cpp_reader *pfile;
887 const char *dirname;
888{
b3694847 889 struct file_name_map_list *map_list_ptr;
c31a6508
ZW
890 char *name;
891 FILE *f;
892
8767c894 893 /* Check the cache of directories, and mappings in their remap file. */
c31a6508
ZW
894 for (map_list_ptr = CPP_OPTION (pfile, map_list); map_list_ptr;
895 map_list_ptr = map_list_ptr->map_list_next)
896 if (! strcmp (map_list_ptr->map_list_name, dirname))
897 return map_list_ptr->map_list_map;
898
899 map_list_ptr = ((struct file_name_map_list *)
900 xmalloc (sizeof (struct file_name_map_list)));
901 map_list_ptr->map_list_name = xstrdup (dirname);
8767c894
NB
902
903 /* The end of the list ends in NULL. */
4b588241 904 map_list_ptr->map_list_map = NULL;
c31a6508
ZW
905
906 name = (char *) alloca (strlen (dirname) + strlen (FILE_NAME_MAP_FILE) + 2);
907 strcpy (name, dirname);
908 if (*dirname)
909 strcat (name, "/");
910 strcat (name, FILE_NAME_MAP_FILE);
911 f = fopen (name, "r");
8767c894
NB
912
913 /* Silently return NULL if we cannot open. */
914 if (f)
c31a6508
ZW
915 {
916 int ch;
917 int dirlen = strlen (dirname);
918
919 while ((ch = getc (f)) != EOF)
920 {
921 char *from, *to;
922 struct file_name_map *ptr;
923
924 if (is_space(ch))
925 continue;
926 from = read_filename_string (ch, f);
927 while ((ch = getc (f)) != EOF && is_hspace(ch))
928 ;
929 to = read_filename_string (ch, f);
930
931 ptr = ((struct file_name_map *)
932 xmalloc (sizeof (struct file_name_map)));
933 ptr->map_from = from;
934
935 /* Make the real filename absolute. */
05e81724 936 if (IS_ABSOLUTE_PATHNAME (to))
c31a6508
ZW
937 ptr->map_to = to;
938 else
939 {
940 ptr->map_to = xmalloc (dirlen + strlen (to) + 2);
941 strcpy (ptr->map_to, dirname);
942 ptr->map_to[dirlen] = '/';
943 strcpy (ptr->map_to + dirlen + 1, to);
944 free (to);
945 }
946
947 ptr->map_next = map_list_ptr->map_list_map;
948 map_list_ptr->map_list_map = ptr;
949
950 while ((ch = getc (f)) != '\n')
951 if (ch == EOF)
952 break;
953 }
954 fclose (f);
955 }
956
8767c894 957 /* Add this information to the cache. */
c31a6508
ZW
958 map_list_ptr->map_list_next = CPP_OPTION (pfile, map_list);
959 CPP_OPTION (pfile, map_list) = map_list_ptr;
960
961 return map_list_ptr->map_list_map;
962}
963
e7182666
NB
964/* Remap an unsimplified path NAME based on the file_name_map (if any)
965 for LOC. */
c31a6508
ZW
966static char *
967remap_filename (pfile, name, loc)
968 cpp_reader *pfile;
969 char *name;
591e15a1 970 struct search_path *loc;
c31a6508
ZW
971{
972 struct file_name_map *map;
8767c894 973 const char *from, *p;
e7182666 974 char *dir;
c31a6508
ZW
975
976 if (! loc->name_map)
8767c894 977 {
e7182666
NB
978 /* Get a null-terminated path. */
979 char *dname = alloca (loc->len + 1);
980 memcpy (dname, loc->name, loc->len);
981 dname[loc->len] = '\0';
982
591e15a1 983 loc->name_map = read_name_map (pfile, dname);
8767c894
NB
984 if (! loc->name_map)
985 return name;
986 }
c31a6508 987
e7182666 988 /* This works since NAME has not been simplified yet. */
591e15a1 989 from = name + loc->len + 1;
c31a6508
ZW
990
991 for (map = loc->name_map; map; map = map->map_next)
992 if (!strcmp (map->map_from, from))
993 return map->map_to;
994
995 /* Try to find a mapping file for the particular directory we are
996 looking in. Thus #include <sys/types.h> will look up sys/types.h
997 in /usr/include/header.gcc and look up types.h in
998 /usr/include/sys/header.gcc. */
999 p = strrchr (name, '/');
1000 if (!p)
c31a6508
ZW
1001 return name;
1002
8767c894 1003 /* We know p != name as absolute paths don't call remap_filename. */
c31a6508 1004 if (p == name)
8767c894
NB
1005 cpp_ice (pfile, "absolute file name in remap_filename");
1006
1007 dir = (char *) alloca (p - name + 1);
1008 memcpy (dir, name, p - name);
1009 dir[p - name] = '\0';
1010 from = p + 1;
c31a6508
ZW
1011
1012 for (map = read_name_map (pfile, dir); map; map = map->map_next)
8767c894 1013 if (! strcmp (map->map_from, from))
c31a6508
ZW
1014 return map->map_to;
1015
1016 return name;
1017}
1018
f9200da2
NB
1019/* Returns true if it is safe to remove the final component of path,
1020 when it is followed by a ".." component. We use lstat to avoid
1021 symlinks if we have it. If not, we can still catch errors with
1022 stat (). */
1023static int
1024remove_component_p (path)
1025 const char *path;
1026{
1027 struct stat s;
1028 int result;
1029
1030#ifdef HAVE_LSTAT
1031 result = lstat (path, &s);
1032#else
1033 result = stat (path, &s);
1034#endif
1035
8d75ad04
AO
1036 /* There's no guarantee that errno will be unchanged, even on
1037 success. Cygwin's lstat(), for example, will often set errno to
1038 ENOSYS. In case of success, reset errno to zero. */
1039 if (result == 0)
1040 errno = 0;
1041
f9200da2
NB
1042 return result == 0 && S_ISDIR (s.st_mode);
1043}
1044
0b3d776a
ZW
1045/* Simplify a path name in place, deleting redundant components. This
1046 reduces OS overhead and guarantees that equivalent paths compare
1047 the same (modulo symlinks).
1048
1049 Transforms made:
1050 foo/bar/../quux foo/quux
1051 foo/./bar foo/bar
1052 foo//bar foo/bar
1053 /../quux /quux
1054 //quux //quux (POSIX allows leading // as a namespace escape)
1055
f9200da2
NB
1056 Guarantees no trailing slashes. All transforms reduce the length
1057 of the string. Returns PATH. errno is 0 if no error occurred;
1058 nonzero if an error occurred when using stat () or lstat (). */
1059
e7182666 1060char *
b0699dad 1061_cpp_simplify_pathname (path)
21380ab0 1062 char *path;
0b3d776a 1063{
f9200da2
NB
1064#ifndef VMS
1065 char *from, *to;
1066 char *base, *orig_base;
1067 int absolute = 0;
1068
1069 errno = 0;
1070 /* Don't overflow the empty path by putting a '.' in it below. */
1071 if (*path == '\0')
1072 return path;
0b3d776a 1073
509781a4 1074#if defined (HAVE_DOS_BASED_FILE_SYSTEM)
ec5c56db 1075 /* Convert all backslashes to slashes. */
f9200da2
NB
1076 for (from = path; *from; from++)
1077 if (*from == '\\') *from = '/';
0b3d776a 1078
ec5c56db 1079 /* Skip over leading drive letter if present. */
f9200da2
NB
1080 if (ISALPHA (path[0]) && path[1] == ':')
1081 from = to = &path[2];
1082 else
0b3d776a 1083 from = to = path;
f9200da2
NB
1084#else
1085 from = to = path;
0b3d776a
ZW
1086#endif
1087
f9200da2
NB
1088 /* Remove redundant leading /s. */
1089 if (*from == '/')
0b3d776a 1090 {
f9200da2
NB
1091 absolute = 1;
1092 to++;
1093 from++;
1094 if (*from == '/')
0b3d776a 1095 {
f9200da2
NB
1096 if (*++from == '/')
1097 /* 3 or more initial /s are equivalent to 1 /. */
1098 while (*++from == '/');
1099 else
1100 /* On some hosts // differs from /; Posix allows this. */
1101 to++;
0b3d776a
ZW
1102 }
1103 }
f9200da2
NB
1104
1105 base = orig_base = to;
1106 for (;;)
0b3d776a 1107 {
f9200da2
NB
1108 int move_base = 0;
1109
1110 while (*from == '/')
1111 from++;
1112
1113 if (*from == '\0')
1114 break;
1115
1116 if (*from == '.')
0b3d776a 1117 {
f9200da2
NB
1118 if (from[1] == '\0')
1119 break;
1120 if (from[1] == '/')
0b3d776a 1121 {
f9200da2
NB
1122 from += 2;
1123 continue;
0b3d776a 1124 }
f9200da2 1125 else if (from[1] == '.' && (from[2] == '/' || from[2] == '\0'))
0b3d776a 1126 {
f9200da2
NB
1127 /* Don't simplify if there was no previous component. */
1128 if (absolute && orig_base == to)
0b3d776a 1129 {
f9200da2
NB
1130 from += 2;
1131 continue;
0b3d776a 1132 }
f9200da2
NB
1133 /* Don't simplify if the previous component was "../",
1134 or if an error has already occurred with (l)stat. */
1135 if (base != to && errno == 0)
0b3d776a 1136 {
f9200da2
NB
1137 /* We don't back up if it's a symlink. */
1138 *to = '\0';
1139 if (remove_component_p (path))
1140 {
1141 while (to > base && *to != '/')
1142 to--;
1143 from += 2;
1144 continue;
1145 }
0b3d776a 1146 }
f9200da2 1147 move_base = 1;
0b3d776a 1148 }
f9200da2
NB
1149 }
1150
1151 /* Add the component separator. */
1152 if (to > orig_base)
1153 *to++ = '/';
1154
1155 /* Copy this component until the trailing null or '/'. */
1156 while (*from != '\0' && *from != '/')
1157 *to++ = *from++;
1158
1159 if (move_base)
1160 base = to;
0b3d776a
ZW
1161 }
1162
f9200da2
NB
1163 /* Change the empty string to "." so that it is not treated as stdin.
1164 Null terminate. */
1165 if (to == path)
1166 *to++ = '.';
1167 *to = '\0';
1168
1169 return path;
1170#else /* VMS */
1171 errno = 0;
1172 return path;
1173#endif /* !VMS */
0b3d776a 1174}