1 /* Part of CPP library. File handling.
2 Copyright (C) 1986-2019 Free Software Foundation, Inc.
3 Written by Per Bothner, 1994.
4 Based on CCCP program by Paul Rubin, June 1986
5 Adapted to ANSI C, Richard Stallman, Jan 1987
6 Split out of cpplib.c, Zack Weinberg, Oct 1998
7 Reimplemented, Neil Booth, Jul 2003
9 This program is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 3, or (at your option) any
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; see the file COPYING3. If not see
21 <http://www.gnu.org/licenses/>. */
33 /* Variable length record files on VMS will have a stat size that includes
34 record control characters that won't be included in the read size. */
36 # define FAB_C_VAR 2 /* variable length records (see Starlet fabdef.h) */
37 # define STAT_SIZE_RELIABLE(ST) ((ST).st_fab_rfm != FAB_C_VAR)
39 # define STAT_SIZE_RELIABLE(ST) true
44 /* For DJGPP redirected input is opened in text mode. */
45 # define set_stdin_to_binary_mode() \
46 if (! isatty (0)) setmode (0, O_BINARY)
48 # define set_stdin_to_binary_mode() /* Nothing */
51 /* This structure represents a file searched for by CPP, whether it
52 exists or not. An instance may be pointed to by more than one
53 cpp_file_hash_entry; at present no reference count is kept. */
56 /* Filename as given to #include or command line switch. */
59 /* The full path used to find the file. */
62 /* The full path of the pch file. */
65 /* The file's path with the basename stripped. NULL if it hasn't
66 been calculated yet. */
69 /* Chain through all files. */
70 struct _cpp_file
*next_file
;
72 /* The contents of NAME after calling read_file(). */
75 /* Pointer to the real start of BUFFER. read_file() might increment
76 BUFFER; when freeing, this this pointer must be used instead. */
77 const uchar
*buffer_start
;
79 /* The macro, if any, preventing re-inclusion. */
80 const cpp_hashnode
*cmacro
;
82 /* The directory in the search path where FILE was found. Used for
83 #include_next and determining whether a header is a system
87 /* As filled in by stat(2) for the file. */
90 /* File descriptor. Invalid if -1, otherwise open. */
93 /* Zero if this file was successfully opened and stat()-ed,
94 otherwise errno obtained from failure. */
97 /* Number of times the file has been stacked for preprocessing. */
98 unsigned short stack_count
;
100 /* If opened with #import or contains #pragma once. */
103 /* If read() failed before. */
106 /* If this file is the main file. */
109 /* If BUFFER above contains the true contents of the file. */
110 bool buffer_valid
: 1;
112 /* If this file is implicitly preincluded. */
113 bool implicit_preinclude
: 1;
116 /* A singly-linked list for all searches for a given file name, with
117 its head pointed to by a slot in FILE_HASH. The file name is what
118 appeared between the quotes in a #include directive; it can be
119 determined implicitly from the hash table location or explicitly
122 FILE is a structure containing details about the file that was
123 found with that search, or details of how the search failed.
125 START_DIR is the starting location of the search in the include
126 chain. The current directories for "" includes are also hashed in
127 the hash table and therefore unique. Files that are looked up
128 without using a search path, such as absolute filenames and file
129 names from the command line share a special starting directory so
130 they don't cause cache hits with normal include-chain lookups.
132 If START_DIR is NULL then the entry is for a directory, not a file,
133 and the directory is in DIR. Since the starting point in a file
134 lookup chain is never NULL, this means that simple pointer
135 comparisons against START_DIR can be made to determine cache hits
138 If a cache lookup fails because of e.g. an extra "./" in the path,
139 then nothing will break. It is just less efficient as CPP will
140 have to do more work re-preprocessing the file, and/or comparing
141 its contents against earlier once-only files.
143 struct cpp_file_hash_entry
145 struct cpp_file_hash_entry
*next
;
155 /* Number of entries to put in a cpp_file_hash_entry pool. */
156 #define FILE_HASH_POOL_SIZE 127
158 /* A file hash entry pool. We allocate cpp_file_hash_entry object from
160 struct file_hash_entry_pool
162 /* Number of entries used from this pool. */
163 unsigned int file_hash_entries_used
;
164 /* Next pool in the chain; used when freeing. */
165 struct file_hash_entry_pool
*next
;
166 /* The memory pool. */
167 struct cpp_file_hash_entry pool
[FILE_HASH_POOL_SIZE
];
170 static bool open_file (_cpp_file
*file
);
171 static bool pch_open_file (cpp_reader
*pfile
, _cpp_file
*file
,
173 static bool find_file_in_dir (cpp_reader
*pfile
, _cpp_file
*file
,
174 bool *invalid_pch
, location_t loc
);
175 static bool read_file_guts (cpp_reader
*pfile
, _cpp_file
*file
,
177 static bool read_file (cpp_reader
*pfile
, _cpp_file
*file
,
179 static struct cpp_dir
*search_path_head (cpp_reader
*, const char *fname
,
180 int angle_brackets
, enum include_type
);
181 static const char *dir_name_of_file (_cpp_file
*file
);
182 static void open_file_failed (cpp_reader
*pfile
, _cpp_file
*file
, int,
184 static struct cpp_file_hash_entry
*search_cache (struct cpp_file_hash_entry
*head
,
185 const cpp_dir
*start_dir
);
186 static _cpp_file
*make_cpp_file (cpp_reader
*, cpp_dir
*, const char *fname
);
187 static void destroy_cpp_file (_cpp_file
*);
188 static cpp_dir
*make_cpp_dir (cpp_reader
*, const char *dir_name
, int sysp
);
189 static void allocate_file_hash_entries (cpp_reader
*pfile
);
190 static struct cpp_file_hash_entry
*new_file_hash_entry (cpp_reader
*pfile
);
191 static int report_missing_guard (void **slot
, void *b
);
192 static hashval_t
file_hash_hash (const void *p
);
193 static int file_hash_eq (const void *p
, const void *q
);
194 static char *read_filename_string (int ch
, FILE *f
);
195 static void read_name_map (cpp_dir
*dir
);
196 static char *remap_filename (cpp_reader
*pfile
, _cpp_file
*file
);
197 static char *append_file_to_dir (const char *fname
, cpp_dir
*dir
);
198 static bool validate_pch (cpp_reader
*, _cpp_file
*file
, const char *pchname
);
199 static int pchf_save_compare (const void *e1
, const void *e2
);
200 static int pchf_compare (const void *d_p
, const void *e_p
);
201 static bool check_file_against_entries (cpp_reader
*, _cpp_file
*, bool);
203 /* Given a filename in FILE->PATH, with the empty string interpreted
206 On success FILE contains an open file descriptor and stat
207 information for the file. On failure the file descriptor is -1 and
208 the appropriate errno is also stored in FILE. Returns TRUE iff
211 We used to open files in nonblocking mode, but that caused more
212 problems than it solved. Do take care not to acquire a controlling
213 terminal by mistake (this can't happen on sane systems, but
214 paranoia is a virtue).
216 Use the three-argument form of open even though we aren't
217 specifying O_CREAT, to defend against broken system headers.
219 O_BINARY tells some runtime libraries (notably DJGPP) not to do
220 newline translation; we can handle DOS line breaks just fine
223 open_file (_cpp_file
*file
)
225 if (file
->path
[0] == '\0')
228 set_stdin_to_binary_mode ();
231 file
->fd
= open (file
->path
, O_RDONLY
| O_NOCTTY
| O_BINARY
, 0666);
235 if (fstat (file
->fd
, &file
->st
) == 0)
237 if (!S_ISDIR (file
->st
.st_mode
))
243 /* Ignore a directory and continue the search. The file we're
244 looking for may be elsewhere in the search path. */
251 #if defined(_WIN32) && !defined(__CYGWIN__)
252 else if (errno
== EACCES
)
254 /* On most UNIX systems, open succeeds on a directory. Above,
255 we check if we have opened a directory and if so, set errno
256 to ENOENT. However, on Windows, opening a directory
257 fails with EACCES. We want to return ENOENT in that
259 if (stat (file
->path
, &file
->st
) == 0
260 && S_ISDIR (file
->st
.st_mode
))
263 /* The call to stat may have reset errno. */
267 else if (errno
== ENOTDIR
)
270 file
->err_no
= errno
;
275 /* Temporary PCH intercept of opening a file. Try to find a PCH file
276 based on FILE->name and FILE->dir, and test those found for
277 validity using PFILE->cb.valid_pch. Return true iff a valid file is
278 found. Set *INVALID_PCH if a PCH file is found but wasn't valid. */
281 pch_open_file (cpp_reader
*pfile
, _cpp_file
*file
, bool *invalid_pch
)
283 static const char extension
[] = ".gch";
284 const char *path
= file
->path
;
290 /* No PCH on <stdin> or if not requested. */
291 if (file
->name
[0] == '\0' || !pfile
->cb
.valid_pch
)
294 /* If the file is not included as first include from either the toplevel
295 file or the command-line it is not a valid use of PCH. */
296 for (_cpp_file
*f
= pfile
->all_files
; f
; f
= f
->next_file
)
297 if (f
->implicit_preinclude
)
299 else if (f
->main_file
)
304 flen
= strlen (path
);
305 len
= flen
+ sizeof (extension
);
306 pchname
= XNEWVEC (char, len
);
307 memcpy (pchname
, path
, flen
);
308 memcpy (pchname
+ flen
, extension
, sizeof (extension
));
310 if (stat (pchname
, &st
) == 0)
314 size_t dlen
, plen
= len
;
316 if (!S_ISDIR (st
.st_mode
))
317 valid
= validate_pch (pfile
, file
, pchname
);
318 else if ((pchdir
= opendir (pchname
)) != NULL
)
320 pchname
[plen
- 1] = '/';
321 while ((d
= readdir (pchdir
)) != NULL
)
323 dlen
= strlen (d
->d_name
) + 1;
324 if ((strcmp (d
->d_name
, ".") == 0)
325 || (strcmp (d
->d_name
, "..") == 0))
327 if (dlen
+ plen
> len
)
330 pchname
= XRESIZEVEC (char, pchname
, len
);
332 memcpy (pchname
+ plen
, d
->d_name
, dlen
);
333 valid
= validate_pch (pfile
, file
, pchname
);
344 file
->pchname
= pchname
;
351 /* Canonicalize the path to FILE. Return the canonical form if it is
352 shorter, otherwise return NULL. This function does NOT free the
353 memory pointed by FILE. */
356 maybe_shorter_path (const char * file
)
358 char * file2
= lrealpath (file
);
359 if (file2
&& strlen (file2
) < strlen (file
))
370 /* Try to open the path FILE->name appended to FILE->dir. This is
371 where remap and PCH intercept the file lookup process. Return true
372 if the file was found, whether or not the open was successful.
373 Set *INVALID_PCH to true if a PCH file is found but wasn't valid.
374 Use LOC when emitting any diagnostics. */
377 find_file_in_dir (cpp_reader
*pfile
, _cpp_file
*file
, bool *invalid_pch
,
382 if (CPP_OPTION (pfile
, remap
) && (path
= remap_filename (pfile
, file
)))
385 if (file
->dir
->construct
)
386 path
= file
->dir
->construct (file
->name
, file
->dir
);
388 path
= append_file_to_dir (file
->name
, file
->dir
);
396 /* We try to canonicalize system headers. For DOS based file
397 * system, we always try to shorten non-system headers, as DOS
398 * has a tighter constraint on max path length. */
399 if ((CPP_OPTION (pfile
, canonical_system_headers
) && file
->dir
->sysp
)
400 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
405 char * canonical_path
= maybe_shorter_path (path
);
408 /* The canonical path was newly allocated. Let's free the
409 non-canonical one. */
411 path
= canonical_path
;
415 hv
= htab_hash_string (path
);
416 if (htab_find_with_hash (pfile
->nonexistent_file_hash
, path
, hv
) != NULL
)
418 file
->err_no
= ENOENT
;
423 if (pch_open_file (pfile
, file
, invalid_pch
))
426 if (open_file (file
))
429 if (file
->err_no
!= ENOENT
)
431 open_file_failed (pfile
, file
, 0, loc
);
435 /* We copy the path name onto an obstack partly so that we don't
436 leak the memory, but mostly so that we don't fragment the
438 copy
= (char *) obstack_copy0 (&pfile
->nonexistent_file_ob
, path
,
441 pp
= htab_find_slot_with_hash (pfile
->nonexistent_file_hash
,
445 file
->path
= file
->name
;
449 file
->err_no
= ENOENT
;
456 /* Return true iff the missing_header callback found the given HEADER. */
458 search_path_exhausted (cpp_reader
*pfile
, const char *header
, _cpp_file
*file
)
460 missing_header_cb func
= pfile
->cb
.missing_header
;
462 /* When the regular search path doesn't work, try context dependent
463 headers search paths. */
465 && file
->dir
== NULL
)
467 if ((file
->path
= func (pfile
, header
, &file
->dir
)) != NULL
)
469 if (open_file (file
))
471 free ((void *)file
->path
);
473 file
->path
= file
->name
;
480 _cpp_find_failed (_cpp_file
*file
)
482 return file
->err_no
!= 0;
485 /* Given a filename FNAME search for such a file in the include path
486 starting from START_DIR. If FNAME is the empty string it is
487 interpreted as STDIN if START_DIR is PFILE->no_search_path.
489 If the file is not found in the file cache fall back to the O/S and
490 add the result to our cache.
492 If the file was not found in the filesystem, or there was an error
493 opening it, then ERR_NO is nonzero and FD is -1. If the file was
494 found, then ERR_NO is zero and FD could be -1 or an open file
495 descriptor. FD can be -1 if the file was found in the cache and
496 had previously been closed. To open it again pass the return value
499 If IMPLICIT_PREINCLUDE then it is OK for the file to be missing.
500 If present, it is OK for a precompiled header to be included after
503 Use LOC as the location for any errors. */
506 _cpp_find_file (cpp_reader
*pfile
, const char *fname
, cpp_dir
*start_dir
,
507 bool fake
, int angle_brackets
, bool implicit_preinclude
,
510 struct cpp_file_hash_entry
*entry
;
513 bool invalid_pch
= false;
514 bool saw_bracket_include
= false;
515 bool saw_quote_include
= false;
516 struct cpp_dir
*found_in_cache
= NULL
;
518 /* Ensure we get no confusion between cached files and directories. */
519 if (start_dir
== NULL
)
520 cpp_error_at (pfile
, CPP_DL_ICE
, loc
, "NULL directory in find_file");
523 = htab_find_slot_with_hash (pfile
->file_hash
, fname
,
524 htab_hash_string (fname
), INSERT
);
526 /* First check the cache before we resort to memory allocation. */
527 entry
= search_cache ((struct cpp_file_hash_entry
*) *hash_slot
, start_dir
);
529 return entry
->u
.file
;
531 file
= make_cpp_file (pfile
, start_dir
, fname
);
532 file
->implicit_preinclude
533 = (implicit_preinclude
535 && pfile
->buffer
->file
->implicit_preinclude
));
538 /* Try each path in the include chain. */
541 if (find_file_in_dir (pfile
, file
, &invalid_pch
, loc
))
544 file
->dir
= file
->dir
->next
;
545 if (file
->dir
== NULL
)
547 if (search_path_exhausted (pfile
, fname
, file
))
549 /* Although this file must not go in the cache,
550 because the file found might depend on things (like
551 the current file) that aren't represented in the
552 cache, it still has to go in the list of all files
553 so that #import works. */
554 file
->next_file
= pfile
->all_files
;
555 pfile
->all_files
= file
;
556 if (*hash_slot
== NULL
)
558 /* If *hash_slot is NULL, the above
559 htab_find_slot_with_hash call just created the
560 slot, but we aren't going to store there
561 anything, so need to remove the newly created
562 entry. htab_clear_slot requires that it is
563 non-NULL, so store there some non-NULL pointer,
564 htab_clear_slot will overwrite it
567 htab_clear_slot (pfile
->file_hash
, hash_slot
);
574 cpp_error (pfile
, CPP_DL_ERROR
,
575 "one or more PCH files were found,"
576 " but they were invalid");
577 if (!cpp_get_options (pfile
)->warn_invalid_pch
)
578 cpp_error (pfile
, CPP_DL_ERROR
,
579 "use -Winvalid-pch for more information");
582 if (implicit_preinclude
)
584 free ((char *) file
->name
);
586 if (*hash_slot
== NULL
)
588 /* See comment on the above htab_clear_slot call. */
590 htab_clear_slot (pfile
->file_hash
, hash_slot
);
595 open_file_failed (pfile
, file
, angle_brackets
, loc
);
599 /* Only check the cache for the starting location (done above)
600 and the quote and bracket chain heads because there are no
601 other possible starting points for searches. */
602 if (file
->dir
== pfile
->bracket_include
)
603 saw_bracket_include
= true;
604 else if (file
->dir
== pfile
->quote_include
)
605 saw_quote_include
= true;
610 = search_cache ((struct cpp_file_hash_entry
*) *hash_slot
, file
->dir
);
613 found_in_cache
= file
->dir
;
620 /* Cache for START_DIR too, sharing the _cpp_file structure. */
621 free ((char *) file
->name
);
623 file
= entry
->u
.file
;
627 /* This is a new file; put it in the list. */
628 file
->next_file
= pfile
->all_files
;
629 pfile
->all_files
= file
;
632 /* Store this new result in the hash table. */
633 entry
= new_file_hash_entry (pfile
);
634 entry
->next
= (struct cpp_file_hash_entry
*) *hash_slot
;
635 entry
->start_dir
= start_dir
;
636 entry
->location
= pfile
->line_table
->highest_location
;
637 entry
->u
.file
= file
;
638 *hash_slot
= (void *) entry
;
640 /* If we passed the quote or bracket chain heads, cache them also.
641 This speeds up processing if there are lots of -I options. */
642 if (saw_bracket_include
643 && pfile
->bracket_include
!= start_dir
644 && found_in_cache
!= pfile
->bracket_include
)
646 entry
= new_file_hash_entry (pfile
);
647 entry
->next
= (struct cpp_file_hash_entry
*) *hash_slot
;
648 entry
->start_dir
= pfile
->bracket_include
;
649 entry
->location
= pfile
->line_table
->highest_location
;
650 entry
->u
.file
= file
;
651 *hash_slot
= (void *) entry
;
653 if (saw_quote_include
654 && pfile
->quote_include
!= start_dir
655 && found_in_cache
!= pfile
->quote_include
)
657 entry
= new_file_hash_entry (pfile
);
658 entry
->next
= (struct cpp_file_hash_entry
*) *hash_slot
;
659 entry
->start_dir
= pfile
->quote_include
;
660 entry
->location
= pfile
->line_table
->highest_location
;
661 entry
->u
.file
= file
;
662 *hash_slot
= (void *) entry
;
668 /* Read a file into FILE->buffer, returning true on success.
670 If FILE->fd is something weird, like a block device, we don't want
671 to read it at all. Don't even try to figure out what something is,
672 except for plain files and block devices, since there is no
673 reliable portable way of doing this.
675 Use LOC for any diagnostics.
677 FIXME: Flush file cache and try again if we run out of memory. */
679 read_file_guts (cpp_reader
*pfile
, _cpp_file
*file
, location_t loc
)
681 ssize_t size
, total
, count
;
685 if (S_ISBLK (file
->st
.st_mode
))
687 cpp_error_at (pfile
, CPP_DL_ERROR
, loc
,
688 "%s is a block device", file
->path
);
692 regular
= S_ISREG (file
->st
.st_mode
) != 0;
695 /* off_t might have a wider range than ssize_t - in other words,
696 the max size of a file might be bigger than the address
697 space. We can't handle a file that large. (Anyone with
698 a single source file bigger than 2GB needs to rethink
699 their coding style.) Some systems (e.g. AIX 4.1) define
700 SSIZE_MAX to be much smaller than the actual range of the
701 type. Use INTTYPE_MAXIMUM unconditionally to ensure this
703 if (file
->st
.st_size
> INTTYPE_MAXIMUM (ssize_t
))
705 cpp_error_at (pfile
, CPP_DL_ERROR
, loc
,
706 "%s is too large", file
->path
);
710 size
= file
->st
.st_size
;
713 /* 8 kilobytes is a sensible starting size. It ought to be bigger
714 than the kernel pipe buffer, and it's definitely bigger than
715 the majority of C source files. */
718 /* The + 16 here is space for the final '\n' and 15 bytes of padding,
719 used to quiet warnings from valgrind or Address Sanitizer, when the
720 optimized lexer accesses aligned 16-byte memory chunks, including
721 the bytes after the malloced, area, and stops lexing on '\n'. */
722 buf
= XNEWVEC (uchar
, size
+ 16);
724 while ((count
= read (file
->fd
, buf
+ total
, size
- total
)) > 0)
733 buf
= XRESIZEVEC (uchar
, buf
, size
+ 16);
739 cpp_errno_filename (pfile
, CPP_DL_ERROR
, file
->path
, loc
);
744 if (regular
&& total
!= size
&& STAT_SIZE_RELIABLE (file
->st
))
745 cpp_error_at (pfile
, CPP_DL_WARNING
, loc
,
746 "%s is shorter than expected", file
->path
);
748 file
->buffer
= _cpp_convert_input (pfile
,
749 CPP_OPTION (pfile
, input_charset
),
750 buf
, size
+ 16, total
,
753 file
->buffer_valid
= true;
758 /* Convenience wrapper around read_file_guts that opens the file if
759 necessary and closes the file descriptor after reading. FILE must
760 have been passed through find_file() at some stage. Use LOC for
763 read_file (cpp_reader
*pfile
, _cpp_file
*file
, location_t loc
)
765 /* If we already have its contents in memory, succeed immediately. */
766 if (file
->buffer_valid
)
769 /* If an earlier read failed for some reason don't try again. */
770 if (file
->dont_read
|| file
->err_no
)
773 if (file
->fd
== -1 && !open_file (file
))
775 open_file_failed (pfile
, file
, 0, loc
);
779 file
->dont_read
= !read_file_guts (pfile
, file
, loc
);
783 return !file
->dont_read
;
786 /* Returns TRUE if FILE is already known to be idempotent, and should
787 therefore not be read again. */
789 is_known_idempotent_file (cpp_reader
*pfile
, _cpp_file
*file
, bool import
)
791 /* Skip once-only files. */
795 /* We must mark the file once-only if #import now, before header
796 guard checks. Otherwise, undefining the header guard might
797 cause the file to be re-stacked. */
800 _cpp_mark_file_once_only (pfile
, file
);
802 /* Don't stack files that have been stacked before. */
803 if (file
->stack_count
)
807 /* Skip if the file had a header guard and the macro is defined.
808 PCH relies on this appearing before the PCH handler below. */
809 if (file
->cmacro
&& cpp_macro_p (file
->cmacro
))
812 /* Handle PCH files immediately; don't stack them. */
815 pfile
->cb
.read_pch (pfile
, file
->pchname
, file
->fd
, file
->path
);
817 free ((void *) file
->pchname
);
818 file
->pchname
= NULL
;
825 /* Return TRUE if file has unique contents, so we should read process
826 it. The file's contents must already have been read. */
829 has_unique_contents (cpp_reader
*pfile
, _cpp_file
*file
, bool import
,
832 /* Check the file against the PCH file. This is done before
833 checking against files we've already seen, since it may save on
835 if (check_file_against_entries (pfile
, file
, import
))
837 /* If this isn't a #import, but yet we can't include the file,
838 that means that it was #import-ed in the PCH file,
839 so we can never include it again. */
841 _cpp_mark_file_once_only (pfile
, file
);
845 /* Now we've read the file's contents, we can stack it if there
846 are no once-only files. */
847 if (!pfile
->seen_once_only
)
850 /* We may have read the file under a different name. Look
851 for likely candidates and compare file contents to be sure. */
852 for (_cpp_file
*f
= pfile
->all_files
; f
; f
= f
->next_file
)
855 continue; /* It'sa me! */
857 if ((import
|| f
->once_only
)
859 && f
->st
.st_mtime
== file
->st
.st_mtime
860 && f
->st
.st_size
== file
->st
.st_size
)
864 if (f
->buffer
&& !f
->buffer_valid
)
866 /* We already have a buffer but it is not valid, because
867 the file is still stacked. Make a new one. */
868 ref_file
= make_cpp_file (pfile
, f
->dir
, f
->name
);
869 ref_file
->path
= f
->path
;
872 /* The file is not stacked anymore. We can reuse it. */
875 bool same_file_p
= (read_file (pfile
, ref_file
, loc
)
876 /* Size might have changed in read_file(). */
877 && ref_file
->st
.st_size
== file
->st
.st_size
878 && !memcmp (ref_file
->buffer
, file
->buffer
,
881 if (f
->buffer
&& !f
->buffer_valid
)
884 destroy_cpp_file (ref_file
);
888 /* Already seen under a different name. */
896 /* Place the file referenced by FILE into a new buffer on the buffer
897 stack if possible. IMPORT is true if this stacking attempt is
898 because of a #import directive. Returns true if a buffer is
899 stacked. Use LOC for any diagnostics. */
901 _cpp_stack_file (cpp_reader
*pfile
, _cpp_file
*file
, include_type type
,
904 if (is_known_idempotent_file (pfile
, file
, type
== IT_IMPORT
))
907 if (!read_file (pfile
, file
, loc
))
910 if (!has_unique_contents (pfile
, file
, type
== IT_IMPORT
, loc
))
914 if (pfile
->buffer
&& file
->dir
)
915 sysp
= MAX (pfile
->buffer
->sysp
, file
->dir
->sysp
);
917 /* Add the file to the dependencies on its first inclusion. */
918 if (CPP_OPTION (pfile
, deps
.style
) > (sysp
!= 0)
919 && !file
->stack_count
921 && !(file
->main_file
&& CPP_OPTION (pfile
, deps
.ignore_main_file
)))
922 deps_add_dep (pfile
->deps
, file
->path
);
924 /* Clear buffer_valid since _cpp_clean_line messes it up. */
925 file
->buffer_valid
= false;
928 /* Stack the buffer. */
930 = cpp_push_buffer (pfile
, file
->buffer
, file
->st
.st_size
,
931 CPP_OPTION (pfile
, preprocessed
)
932 && !CPP_OPTION (pfile
, directives_only
));
935 buffer
->to_free
= file
->buffer_start
;
937 /* Initialize controlling macro state. */
938 pfile
->mi_valid
= true;
939 pfile
->mi_cmacro
= 0;
941 /* In the case of a normal #include, we're now at the start of the
942 line *following* the #include. A separate location_t for this
943 location makes no sense, until we do the LC_LEAVE.
945 This does not apply if we found a PCH file, we're not a regular
946 include, or we ran out of locations. */
947 if (file
->pchname
== NULL
948 && type
< IT_DIRECTIVE_HWM
949 && pfile
->line_table
->highest_location
!= LINE_MAP_MAX_LOCATION
- 1)
950 pfile
->line_table
->highest_location
--;
952 /* Add line map and do callbacks. */
953 _cpp_do_file_change (pfile
, LC_ENTER
, file
->path
, 1, sysp
);
958 /* Mark FILE to be included once only. */
960 _cpp_mark_file_once_only (cpp_reader
*pfile
, _cpp_file
*file
)
962 pfile
->seen_once_only
= true;
963 file
->once_only
= true;
966 /* Return the directory from which searching for FNAME should start,
967 considering the directive TYPE and ANGLE_BRACKETS. If there is
968 nothing left in the path, returns NULL. */
969 static struct cpp_dir
*
970 search_path_head (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
971 enum include_type type
)
976 if (IS_ABSOLUTE_PATH (fname
))
977 return &pfile
->no_search_path
;
979 /* pfile->buffer is NULL when processing an -include command-line flag. */
980 file
= pfile
->buffer
== NULL
? pfile
->main_file
: pfile
->buffer
->file
;
982 /* For #include_next, skip in the search path past the dir in which
983 the current file was found, but if it was found via an absolute
984 path use the normal search logic. */
985 if (type
== IT_INCLUDE_NEXT
&& file
->dir
986 && file
->dir
!= &pfile
->no_search_path
)
987 dir
= file
->dir
->next
;
988 else if (angle_brackets
)
989 dir
= pfile
->bracket_include
;
990 else if (type
== IT_CMDLINE
)
991 /* -include and -imacros use the #include "" chain with the
992 preprocessor's cwd prepended. */
993 return make_cpp_dir (pfile
, "./", false);
994 else if (pfile
->quote_ignores_source_dir
)
995 dir
= pfile
->quote_include
;
997 return make_cpp_dir (pfile
, dir_name_of_file (file
),
998 pfile
->buffer
? pfile
->buffer
->sysp
: 0);
1001 cpp_error (pfile
, CPP_DL_ERROR
,
1002 "no include path in which to search for %s", fname
);
1007 /* Strip the basename from the file's path. It ends with a slash if
1008 of nonzero length. Note that this procedure also works for
1009 <stdin>, which is represented by the empty string. */
1011 dir_name_of_file (_cpp_file
*file
)
1013 if (!file
->dir_name
)
1015 size_t len
= lbasename (file
->path
) - file
->path
;
1016 char *dir_name
= XNEWVEC (char, len
+ 1);
1018 memcpy (dir_name
, file
->path
, len
);
1019 dir_name
[len
] = '\0';
1020 file
->dir_name
= dir_name
;
1023 return file
->dir_name
;
1026 /* Handles #include-family directives (distinguished by TYPE),
1027 including HEADER, and the command line -imacros and -include.
1028 Returns true if a buffer was stacked. */
1030 _cpp_stack_include (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
1031 enum include_type type
, location_t loc
)
1033 /* For -include command-line flags we have type == IT_CMDLINE.
1034 When the first -include file is processed we have the case, where
1035 pfile->cur_token == pfile->cur_run->base, we are directly called up
1036 by the front end. However in the case of the second -include file,
1037 we are called from _cpp_lex_token -> _cpp_get_fresh_line ->
1038 cpp_push_include, with pfile->cur_token != pfile->cur_run->base,
1039 and pfile->cur_token[-1].src_loc not (yet) initialized.
1040 However, when the include file cannot be found, we need src_loc to
1041 be initialized to some safe value: 0 means UNKNOWN_LOCATION. */
1042 if (type
== IT_CMDLINE
&& pfile
->cur_token
!= pfile
->cur_run
->base
)
1043 pfile
->cur_token
[-1].src_loc
= 0;
1045 cpp_dir
*dir
= search_path_head (pfile
, fname
, angle_brackets
, type
);
1049 _cpp_file
*file
= _cpp_find_file (pfile
, fname
, dir
, false, angle_brackets
,
1050 type
== IT_DEFAULT
, loc
);
1051 if (type
== IT_DEFAULT
&& file
== NULL
)
1054 return _cpp_stack_file (pfile
, file
, type
, loc
);
1057 /* Could not open FILE. The complication is dependency output. */
1059 open_file_failed (cpp_reader
*pfile
, _cpp_file
*file
, int angle_brackets
,
1062 int sysp
= pfile
->line_table
->highest_line
> 1 && pfile
->buffer
? pfile
->buffer
->sysp
: 0;
1063 bool print_dep
= CPP_OPTION (pfile
, deps
.style
) > (angle_brackets
|| !!sysp
);
1065 if (pfile
->state
.in__has_include__
)
1068 errno
= file
->err_no
;
1069 if (print_dep
&& CPP_OPTION (pfile
, deps
.missing_files
) && errno
== ENOENT
)
1071 deps_add_dep (pfile
->deps
, file
->name
);
1072 /* If the preprocessor output (other than dependency information) is
1073 being used, we must also flag an error. */
1074 if (CPP_OPTION (pfile
, deps
.need_preprocessor_output
))
1075 cpp_errno_filename (pfile
, CPP_DL_FATAL
,
1076 file
->path
? file
->path
: file
->name
,
1081 /* If we are not outputting dependencies, or if we are and dependencies
1082 were requested for this file, or if preprocessor output is needed
1083 in addition to dependency information, this is an error.
1085 Otherwise (outputting dependencies but not for this file, and not
1086 using the preprocessor output), we can still produce correct output
1087 so it's only a warning. */
1088 if (CPP_OPTION (pfile
, deps
.style
) == DEPS_NONE
1090 || CPP_OPTION (pfile
, deps
.need_preprocessor_output
))
1091 cpp_errno_filename (pfile
, CPP_DL_FATAL
,
1092 file
->path
? file
->path
: file
->name
,
1095 cpp_errno_filename (pfile
, CPP_DL_WARNING
,
1096 file
->path
? file
->path
: file
->name
,
1101 /* Search in the chain beginning at HEAD for a file whose search path
1102 started at START_DIR != NULL. */
1103 static struct cpp_file_hash_entry
*
1104 search_cache (struct cpp_file_hash_entry
*head
, const cpp_dir
*start_dir
)
1106 while (head
&& head
->start_dir
!= start_dir
)
1112 /* Allocate a new _cpp_file structure. */
1114 make_cpp_file (cpp_reader
*pfile
, cpp_dir
*dir
, const char *fname
)
1118 file
= XCNEW (_cpp_file
);
1119 file
->main_file
= !pfile
->buffer
;
1122 file
->name
= xstrdup (fname
);
1127 /* Release a _cpp_file structure. */
1129 destroy_cpp_file (_cpp_file
*file
)
1131 free ((void *) file
->buffer_start
);
1132 free ((void *) file
->name
);
1133 free ((void *) file
->path
);
1137 /* Release all the files allocated by this reader. */
1139 destroy_all_cpp_files (cpp_reader
*pfile
)
1141 _cpp_file
*iter
= pfile
->all_files
;
1144 _cpp_file
*next
= iter
->next_file
;
1145 destroy_cpp_file (iter
);
1150 /* A hash of directory names. The directory names are the path names
1151 of files which contain a #include "", the included file name is
1152 appended to this directories.
1154 To avoid duplicate entries we follow the convention that all
1155 non-empty directory names should end in a '/'. DIR_NAME must be
1156 stored in permanently allocated memory. */
1158 make_cpp_dir (cpp_reader
*pfile
, const char *dir_name
, int sysp
)
1160 struct cpp_file_hash_entry
*entry
, **hash_slot
;
1163 hash_slot
= (struct cpp_file_hash_entry
**)
1164 htab_find_slot_with_hash (pfile
->dir_hash
, dir_name
,
1165 htab_hash_string (dir_name
),
1168 /* Have we already hashed this directory? */
1169 for (entry
= *hash_slot
; entry
; entry
= entry
->next
)
1170 if (entry
->start_dir
== NULL
)
1171 return entry
->u
.dir
;
1173 dir
= XCNEW (cpp_dir
);
1174 dir
->next
= pfile
->quote_include
;
1175 dir
->name
= (char *) dir_name
;
1176 dir
->len
= strlen (dir_name
);
1180 /* Store this new result in the hash table. */
1181 entry
= new_file_hash_entry (pfile
);
1182 entry
->next
= *hash_slot
;
1183 entry
->start_dir
= NULL
;
1184 entry
->location
= pfile
->line_table
->highest_location
;
1191 /* Create a new block of memory for file hash entries. */
1193 allocate_file_hash_entries (cpp_reader
*pfile
)
1195 struct file_hash_entry_pool
*pool
= XNEW (struct file_hash_entry_pool
);
1196 pool
->file_hash_entries_used
= 0;
1197 pool
->next
= pfile
->file_hash_entries
;
1198 pfile
->file_hash_entries
= pool
;
1201 /* Return a new file hash entry. */
1202 static struct cpp_file_hash_entry
*
1203 new_file_hash_entry (cpp_reader
*pfile
)
1206 if (pfile
->file_hash_entries
->file_hash_entries_used
== FILE_HASH_POOL_SIZE
)
1207 allocate_file_hash_entries (pfile
);
1209 idx
= pfile
->file_hash_entries
->file_hash_entries_used
++;
1210 return &pfile
->file_hash_entries
->pool
[idx
];
1213 /* Free the file hash entry pools. */
1215 free_file_hash_entries (cpp_reader
*pfile
)
1217 struct file_hash_entry_pool
*iter
= pfile
->file_hash_entries
;
1220 struct file_hash_entry_pool
*next
= iter
->next
;
1226 /* Returns TRUE if a file FNAME has ever been successfully opened.
1227 This routine is not intended to correctly handle filenames aliased
1228 by links or redundant . or .. traversals etc. */
1230 cpp_included (cpp_reader
*pfile
, const char *fname
)
1232 struct cpp_file_hash_entry
*entry
;
1234 entry
= (struct cpp_file_hash_entry
*)
1235 htab_find_with_hash (pfile
->file_hash
, fname
, htab_hash_string (fname
));
1237 while (entry
&& (entry
->start_dir
== NULL
|| entry
->u
.file
->err_no
))
1238 entry
= entry
->next
;
1240 return entry
!= NULL
;
1243 /* Returns TRUE if a file FNAME has ever been successfully opened
1244 before LOCATION. This routine is not intended to correctly handle
1245 filenames aliased by links or redundant . or .. traversals etc. */
1247 cpp_included_before (cpp_reader
*pfile
, const char *fname
,
1248 location_t location
)
1250 struct cpp_file_hash_entry
*entry
1251 = (struct cpp_file_hash_entry
*)
1252 htab_find_with_hash (pfile
->file_hash
, fname
, htab_hash_string (fname
));
1254 if (IS_ADHOC_LOC (location
))
1255 location
= get_location_from_adhoc_loc (pfile
->line_table
, location
);
1257 while (entry
&& (entry
->start_dir
== NULL
|| entry
->u
.file
->err_no
1258 || entry
->location
> location
))
1259 entry
= entry
->next
;
1261 return entry
!= NULL
;
1264 /* Calculate the hash value of a file hash entry P. */
1267 file_hash_hash (const void *p
)
1269 struct cpp_file_hash_entry
*entry
= (struct cpp_file_hash_entry
*) p
;
1271 if (entry
->start_dir
)
1272 hname
= entry
->u
.file
->name
;
1274 hname
= entry
->u
.dir
->name
;
1276 return htab_hash_string (hname
);
1279 /* Compare a string Q against a file hash entry P. */
1281 file_hash_eq (const void *p
, const void *q
)
1283 struct cpp_file_hash_entry
*entry
= (struct cpp_file_hash_entry
*) p
;
1284 const char *fname
= (const char *) q
;
1287 if (entry
->start_dir
)
1288 hname
= entry
->u
.file
->name
;
1290 hname
= entry
->u
.dir
->name
;
1292 return filename_cmp (hname
, fname
) == 0;
1295 /* Compare entries in the nonexistent file hash table. These are just
1298 nonexistent_file_hash_eq (const void *p
, const void *q
)
1300 return filename_cmp ((const char *) p
, (const char *) q
) == 0;
1303 /* Initialize everything in this source file. */
1305 _cpp_init_files (cpp_reader
*pfile
)
1307 pfile
->file_hash
= htab_create_alloc (127, file_hash_hash
, file_hash_eq
,
1308 NULL
, xcalloc
, free
);
1309 pfile
->dir_hash
= htab_create_alloc (127, file_hash_hash
, file_hash_eq
,
1310 NULL
, xcalloc
, free
);
1311 allocate_file_hash_entries (pfile
);
1312 pfile
->nonexistent_file_hash
= htab_create_alloc (127, htab_hash_string
,
1313 nonexistent_file_hash_eq
,
1314 NULL
, xcalloc
, free
);
1315 obstack_specify_allocation (&pfile
->nonexistent_file_ob
, 0, 0,
1319 /* Finalize everything in this source file. */
1321 _cpp_cleanup_files (cpp_reader
*pfile
)
1323 htab_delete (pfile
->file_hash
);
1324 htab_delete (pfile
->dir_hash
);
1325 htab_delete (pfile
->nonexistent_file_hash
);
1326 obstack_free (&pfile
->nonexistent_file_ob
, 0);
1327 free_file_hash_entries (pfile
);
1328 destroy_all_cpp_files (pfile
);
1331 /* Make the parser forget about files it has seen. This can be useful
1332 for resetting the parser to start another run. */
1334 cpp_clear_file_cache (cpp_reader
*pfile
)
1336 _cpp_cleanup_files (pfile
);
1337 pfile
->file_hash_entries
= NULL
;
1338 pfile
->all_files
= NULL
;
1339 _cpp_init_files (pfile
);
1342 /* Enter a file name in the hash for the sake of cpp_included. */
1344 _cpp_fake_include (cpp_reader
*pfile
, const char *fname
)
1346 _cpp_find_file (pfile
, fname
, pfile
->buffer
->file
->dir
, true, 0, false, 0);
1349 /* Not everyone who wants to set system-header-ness on a buffer can
1350 see the details of a buffer. This is an exported interface because
1351 fix-header needs it. */
1353 cpp_make_system_header (cpp_reader
*pfile
, int syshdr
, int externc
)
1356 const class line_maps
*line_table
= pfile
->line_table
;
1357 const line_map_ordinary
*map
= LINEMAPS_LAST_ORDINARY_MAP (line_table
);
1358 /* 1 = system header, 2 = system header to be treated as C. */
1360 flags
= 1 + (externc
!= 0);
1361 pfile
->buffer
->sysp
= flags
;
1362 _cpp_do_file_change (pfile
, LC_RENAME
, ORDINARY_MAP_FILE_NAME (map
),
1363 SOURCE_LINE (map
, pfile
->line_table
->highest_line
), flags
);
1366 /* Allow the client to change the current file. Used by the front end
1367 to achieve pseudo-file names like <built-in>.
1368 If REASON is LC_LEAVE, then NEW_NAME must be NULL. */
1370 cpp_change_file (cpp_reader
*pfile
, enum lc_reason reason
,
1371 const char *new_name
)
1373 _cpp_do_file_change (pfile
, reason
, new_name
, 1, 0);
1376 struct report_missing_guard_data
1382 /* Callback function for htab_traverse. */
1384 report_missing_guard (void **slot
, void *d
)
1386 struct cpp_file_hash_entry
*entry
= (struct cpp_file_hash_entry
*) *slot
;
1387 struct report_missing_guard_data
*data
1388 = (struct report_missing_guard_data
*) d
;
1390 /* Skip directories. */
1391 if (entry
->start_dir
!= NULL
)
1393 _cpp_file
*file
= entry
->u
.file
;
1395 /* We don't want MI guard advice for the main file. */
1396 if (!file
->once_only
&& file
->cmacro
== NULL
1397 && file
->stack_count
== 1 && !file
->main_file
)
1399 if (data
->paths
== NULL
)
1401 data
->paths
= XCNEWVEC (const char *, data
->count
);
1405 data
->paths
[data
->count
++] = file
->path
;
1409 /* Keep traversing the hash table. */
1413 /* Comparison function for qsort. */
1415 report_missing_guard_cmp (const void *p1
, const void *p2
)
1417 return strcmp (*(const char *const *) p1
, *(const char *const *) p2
);
1420 /* Report on all files that might benefit from a multiple include guard.
1423 _cpp_report_missing_guards (cpp_reader
*pfile
)
1425 struct report_missing_guard_data data
;
1428 data
.count
= htab_elements (pfile
->file_hash
);
1429 htab_traverse (pfile
->file_hash
, report_missing_guard
, &data
);
1431 if (data
.paths
!= NULL
)
1435 /* Sort the paths to avoid outputting them in hash table
1437 qsort (data
.paths
, data
.count
, sizeof (const char *),
1438 report_missing_guard_cmp
);
1439 fputs (_("Multiple include guards may be useful for:\n"),
1441 for (i
= 0; i
< data
.count
; i
++)
1443 fputs (data
.paths
[i
], stderr
);
1444 putc ('\n', stderr
);
1450 /* Locate HEADER, and determine whether it is newer than the current
1451 file. If it cannot be located or dated, return -1, if it is
1452 newer, return 1, otherwise 0. */
1454 _cpp_compare_file_date (cpp_reader
*pfile
, const char *fname
,
1458 struct cpp_dir
*dir
;
1460 dir
= search_path_head (pfile
, fname
, angle_brackets
, IT_INCLUDE
);
1464 file
= _cpp_find_file (pfile
, fname
, dir
, false, angle_brackets
, false, 0);
1474 return file
->st
.st_mtime
> pfile
->buffer
->file
->st
.st_mtime
;
1477 /* Pushes the given file onto the buffer stack. Returns nonzero if
1480 cpp_push_include (cpp_reader
*pfile
, const char *fname
)
1482 return _cpp_stack_include (pfile
, fname
, false, IT_CMDLINE
, 0);
1485 /* Pushes the given file, implicitly included at the start of a
1486 compilation, onto the buffer stack but without any errors if the
1487 file is not found. Returns nonzero if successful. */
1489 cpp_push_default_include (cpp_reader
*pfile
, const char *fname
)
1491 return _cpp_stack_include (pfile
, fname
, true, IT_DEFAULT
, 0);
1494 /* Do appropriate cleanup when a file INC's buffer is popped off the
1497 _cpp_pop_file_buffer (cpp_reader
*pfile
, _cpp_file
*file
,
1498 const unsigned char *to_free
)
1500 /* Record the inclusion-preventing macro, which could be NULL
1501 meaning no controlling macro. */
1502 if (pfile
->mi_valid
&& file
->cmacro
== NULL
)
1503 file
->cmacro
= pfile
->mi_cmacro
;
1505 /* Invalidate control macros in the #including file. */
1506 pfile
->mi_valid
= false;
1510 if (to_free
== file
->buffer_start
)
1512 file
->buffer_start
= NULL
;
1513 file
->buffer
= NULL
;
1514 file
->buffer_valid
= false;
1516 free ((void *) to_free
);
1520 /* Return the file name associated with FILE. */
1522 _cpp_get_file_name (_cpp_file
*file
)
1527 /* Inteface to file statistics record in _cpp_file structure. */
1529 _cpp_get_file_stat (_cpp_file
*file
)
1534 /* Set the include chain for "" to QUOTE, for <> to BRACKET. If
1535 QUOTE_IGNORES_SOURCE_DIR, then "" includes do not look in the
1536 directory of the including file.
1538 If BRACKET does not lie in the QUOTE chain, it is set to QUOTE. */
1540 cpp_set_include_chains (cpp_reader
*pfile
, cpp_dir
*quote
, cpp_dir
*bracket
,
1541 int quote_ignores_source_dir
)
1543 pfile
->quote_include
= quote
;
1544 pfile
->bracket_include
= quote
;
1545 pfile
->quote_ignores_source_dir
= quote_ignores_source_dir
;
1547 for (; quote
; quote
= quote
->next
)
1549 quote
->name_map
= NULL
;
1550 quote
->len
= strlen (quote
->name
);
1551 if (quote
== bracket
)
1552 pfile
->bracket_include
= bracket
;
1556 /* Append the file name to the directory to create the path, but don't
1557 turn / into // or // into ///; // may be a namespace escape. */
1559 append_file_to_dir (const char *fname
, cpp_dir
*dir
)
1565 flen
= strlen (fname
);
1566 path
= XNEWVEC (char, dlen
+ 1 + flen
+ 1);
1567 memcpy (path
, dir
->name
, dlen
);
1568 if (dlen
&& !IS_DIR_SEPARATOR (path
[dlen
- 1]))
1570 memcpy (&path
[dlen
], fname
, flen
+ 1);
1575 /* Read a space delimited string of unlimited length from a stdio
1578 read_filename_string (int ch
, FILE *f
)
1584 set
= alloc
= XNEWVEC (char, len
+ 1);
1585 if (! is_space (ch
))
1588 while ((ch
= getc (f
)) != EOF
&& ! is_space (ch
))
1590 if (set
- alloc
== len
)
1593 alloc
= XRESIZEVEC (char, alloc
, len
+ 1);
1594 set
= alloc
+ len
/ 2;
1604 /* Read the file name map file for DIR. */
1606 read_name_map (cpp_dir
*dir
)
1608 static const char FILE_NAME_MAP_FILE
[] = "header.gcc";
1611 size_t len
, count
= 0, room
= 9;
1614 name
= (char *) alloca (len
+ sizeof (FILE_NAME_MAP_FILE
) + 1);
1615 memcpy (name
, dir
->name
, len
);
1616 if (len
&& !IS_DIR_SEPARATOR (name
[len
- 1]))
1618 strcpy (name
+ len
, FILE_NAME_MAP_FILE
);
1619 f
= fopen (name
, "r");
1621 dir
->name_map
= XNEWVEC (const char *, room
);
1623 /* Silently return NULL if we cannot open. */
1628 while ((ch
= getc (f
)) != EOF
)
1635 if (count
+ 2 > room
)
1638 dir
->name_map
= XRESIZEVEC (const char *, dir
->name_map
, room
);
1641 dir
->name_map
[count
] = read_filename_string (ch
, f
);
1642 while ((ch
= getc (f
)) != EOF
&& is_hspace (ch
))
1645 to
= read_filename_string (ch
, f
);
1646 if (IS_ABSOLUTE_PATH (to
))
1647 dir
->name_map
[count
+ 1] = to
;
1650 dir
->name_map
[count
+ 1] = append_file_to_dir (to
, dir
);
1655 while ((ch
= getc (f
)) != '\n')
1663 /* Terminate the list of maps. */
1664 dir
->name_map
[count
] = NULL
;
1667 /* Remap a FILE's name based on the file_name_map, if any, for
1668 FILE->dir. If the file name has any directory separators,
1669 recursively check those directories too. */
1671 remap_filename (cpp_reader
*pfile
, _cpp_file
*file
)
1673 const char *fname
, *p
;
1684 read_name_map (dir
);
1686 for (index
= 0; dir
->name_map
[index
]; index
+= 2)
1687 if (!filename_cmp (dir
->name_map
[index
], fname
))
1688 return xstrdup (dir
->name_map
[index
+ 1]);
1689 if (IS_ABSOLUTE_PATH (fname
))
1691 p
= strchr (fname
, '/');
1692 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
1694 char *p2
= strchr (fname
, '\\');
1699 if (!p
|| p
== fname
)
1702 len
= dir
->len
+ (p
- fname
+ 1);
1703 new_dir
= XNEWVEC (char, len
+ 2);
1704 p3
= new_dir
+ dir
->len
;
1705 memcpy (new_dir
, dir
->name
, dir
->len
);
1706 if (dir
->len
&& !IS_DIR_SEPARATOR (dir
->name
[dir
->len
- 1]))
1711 memcpy (p3
, fname
, p
- fname
+ 1);
1712 new_dir
[len
] = '\0';
1714 dir
= make_cpp_dir (pfile
, new_dir
, dir
->sysp
);
1719 /* Returns true if PCHNAME is a valid PCH file for FILE. */
1721 validate_pch (cpp_reader
*pfile
, _cpp_file
*file
, const char *pchname
)
1723 const char *saved_path
= file
->path
;
1726 file
->path
= pchname
;
1727 if (open_file (file
))
1729 valid
= 1 & pfile
->cb
.valid_pch (pfile
, pchname
, file
->fd
);
1737 if (CPP_OPTION (pfile
, print_include_names
))
1740 for (i
= 1; i
< pfile
->line_table
->depth
; i
++)
1742 fprintf (stderr
, "%c %s\n",
1743 valid
? '!' : 'x', pchname
);
1747 file
->path
= saved_path
;
1751 /* Get the path associated with the _cpp_file F. The path includes
1752 the base name from the include directive and the directory it was
1753 found in via the search path. */
1756 cpp_get_path (struct _cpp_file
*f
)
1761 /* Get the directory associated with the _cpp_file F. */
1764 cpp_get_dir (struct _cpp_file
*f
)
1769 /* Get the cpp_buffer currently associated with the cpp_reader
1773 cpp_get_buffer (cpp_reader
*pfile
)
1775 return pfile
->buffer
;
1778 /* Get the _cpp_file associated with the cpp_buffer B. */
1781 cpp_get_file (cpp_buffer
*b
)
1786 /* Get the previous cpp_buffer given a cpp_buffer B. The previous
1787 buffer is the buffer that included the given buffer. */
1790 cpp_get_prev (cpp_buffer
*b
)
1795 /* This data structure holds the list of header files that were seen
1796 while the PCH was being built. The 'entries' field is kept sorted
1797 in memcmp() order; yes, this means that on little-endian systems,
1798 it's sorted initially by the least-significant byte of 'size', but
1799 that's OK. The code does rely on having entries with the same size
1800 next to each other. */
1803 /* The size of this file. This is used to save running a MD5 checksum
1804 if the sizes don't match. */
1806 /* The MD5 checksum of this file. */
1807 unsigned char sum
[16];
1808 /* Is this file to be included only once? */
1813 /* Number of pchf_entry structures. */
1816 /* Are there any values with once_only set?
1817 This is used as an optimisation, it means we don't have to search
1818 the structure if we're processing a regular #include. */
1819 bool have_once_only
;
1821 struct pchf_entry entries
[1];
1824 static struct pchf_data
*pchf
;
1826 /* A qsort ordering function for pchf_entry structures. */
1829 pchf_save_compare (const void *e1
, const void *e2
)
1831 return memcmp (e1
, e2
, sizeof (struct pchf_entry
));
1834 /* Create and write to F a pchf_data structure. */
1837 _cpp_save_file_entries (cpp_reader
*pfile
, FILE *fp
)
1840 struct pchf_data
*result
;
1845 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
1848 result_size
= (sizeof (struct pchf_data
)
1849 + sizeof (struct pchf_entry
) * (count
- 1));
1850 result
= XCNEWVAR (struct pchf_data
, result_size
);
1853 result
->have_once_only
= false;
1855 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
1859 /* This should probably never happen, since if a read error occurred
1860 the PCH file shouldn't be written... */
1861 if (f
->dont_read
|| f
->err_no
)
1864 if (f
->stack_count
== 0)
1867 count
= result
->count
++;
1869 result
->entries
[count
].once_only
= f
->once_only
;
1870 /* |= is avoided in the next line because of an HP C compiler bug */
1871 result
->have_once_only
= result
->have_once_only
| f
->once_only
;
1872 if (f
->buffer_valid
)
1873 md5_buffer ((const char *)f
->buffer
,
1874 f
->st
.st_size
, result
->entries
[count
].sum
);
1882 open_file_failed (pfile
, f
, 0, 0);
1886 ff
= fdopen (f
->fd
, "rb");
1887 md5_stream (ff
, result
->entries
[count
].sum
);
1891 result
->entries
[count
].size
= f
->st
.st_size
;
1894 result_size
= (sizeof (struct pchf_data
)
1895 + sizeof (struct pchf_entry
) * (result
->count
- 1));
1897 qsort (result
->entries
, result
->count
, sizeof (struct pchf_entry
),
1900 ret
= fwrite (result
, result_size
, 1, fp
) == 1;
1905 /* Read the pchf_data structure from F. */
1908 _cpp_read_file_entries (cpp_reader
*pfile ATTRIBUTE_UNUSED
, FILE *f
)
1912 if (fread (&d
, sizeof (struct pchf_data
) - sizeof (struct pchf_entry
), 1, f
)
1916 pchf
= XNEWVAR (struct pchf_data
, sizeof (struct pchf_data
)
1917 + sizeof (struct pchf_entry
) * (d
.count
- 1));
1918 memcpy (pchf
, &d
, sizeof (struct pchf_data
) - sizeof (struct pchf_entry
));
1919 if (fread (pchf
->entries
, sizeof (struct pchf_entry
), d
.count
, f
)
1925 /* The parameters for pchf_compare. */
1927 struct pchf_compare_data
1929 /* The size of the file we're looking for. */
1932 /* The MD5 checksum of the file, if it's been computed. */
1933 unsigned char sum
[16];
1938 /* Do we need to worry about entries that don't have ONCE_ONLY set? */
1939 bool check_included
;
1941 /* The file that we're searching for. */
1945 /* bsearch comparison function; look for D_P in E_P. */
1948 pchf_compare (const void *d_p
, const void *e_p
)
1950 const struct pchf_entry
*e
= (const struct pchf_entry
*)e_p
;
1951 struct pchf_compare_data
*d
= (struct pchf_compare_data
*)d_p
;
1954 result
= memcmp (&d
->size
, &e
->size
, sizeof (off_t
));
1958 if (! d
->sum_computed
)
1960 _cpp_file
*const f
= d
->f
;
1962 md5_buffer ((const char *)f
->buffer
, f
->st
.st_size
, d
->sum
);
1963 d
->sum_computed
= true;
1966 result
= memcmp (d
->sum
, e
->sum
, 16);
1970 if (d
->check_included
|| e
->once_only
)
1976 /* Check that F is not in a list read from a PCH file (if any).
1977 Assumes that f->buffer_valid is true. Return TRUE if the file
1978 should not be read. */
1981 check_file_against_entries (cpp_reader
*pfile ATTRIBUTE_UNUSED
,
1983 bool check_included
)
1985 struct pchf_compare_data d
;
1988 || (! check_included
&& ! pchf
->have_once_only
))
1991 d
.size
= f
->st
.st_size
;
1992 d
.sum_computed
= false;
1994 d
.check_included
= check_included
;
1995 return bsearch (&d
, pchf
->entries
, pchf
->count
, sizeof (struct pchf_entry
),
1996 pchf_compare
) != NULL
;
1999 /* Return true if the file FNAME is found in the appropriate include file path
2000 as indicated by ANGLE_BRACKETS. */
2003 _cpp_has_header (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
2004 enum include_type type
)
2006 cpp_dir
*start_dir
= search_path_head (pfile
, fname
, angle_brackets
, type
);
2007 _cpp_file
*file
= _cpp_find_file (pfile
, fname
, start_dir
,
2008 /*fake=*/false, angle_brackets
,
2009 /*implicit_preinclude=*/false, 0);
2010 return file
->err_no
!= ENOENT
;