1 /* Part of CPP library. File handling.
2 Copyright (C) 1986-2016 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. */
112 /* If this file is implicitly preincluded. */
113 bool implicit_preinclude
;
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
;
147 source_location location
;
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
,
175 static bool read_file_guts (cpp_reader
*pfile
, _cpp_file
*file
);
176 static bool read_file (cpp_reader
*pfile
, _cpp_file
*file
);
177 static bool should_stack_file (cpp_reader
*, _cpp_file
*file
, bool import
);
178 static struct cpp_dir
*search_path_head (cpp_reader
*, const char *fname
,
179 int angle_brackets
, enum include_type
);
180 static const char *dir_name_of_file (_cpp_file
*file
);
181 static void open_file_failed (cpp_reader
*pfile
, _cpp_file
*file
, int);
182 static struct cpp_file_hash_entry
*search_cache (struct cpp_file_hash_entry
*head
,
183 const cpp_dir
*start_dir
);
184 static _cpp_file
*make_cpp_file (cpp_reader
*, cpp_dir
*, const char *fname
);
185 static void destroy_cpp_file (_cpp_file
*);
186 static cpp_dir
*make_cpp_dir (cpp_reader
*, const char *dir_name
, int sysp
);
187 static void allocate_file_hash_entries (cpp_reader
*pfile
);
188 static struct cpp_file_hash_entry
*new_file_hash_entry (cpp_reader
*pfile
);
189 static int report_missing_guard (void **slot
, void *b
);
190 static hashval_t
file_hash_hash (const void *p
);
191 static int file_hash_eq (const void *p
, const void *q
);
192 static char *read_filename_string (int ch
, FILE *f
);
193 static void read_name_map (cpp_dir
*dir
);
194 static char *remap_filename (cpp_reader
*pfile
, _cpp_file
*file
);
195 static char *append_file_to_dir (const char *fname
, cpp_dir
*dir
);
196 static bool validate_pch (cpp_reader
*, _cpp_file
*file
, const char *pchname
);
197 static int pchf_save_compare (const void *e1
, const void *e2
);
198 static int pchf_compare (const void *d_p
, const void *e_p
);
199 static bool check_file_against_entries (cpp_reader
*, _cpp_file
*, bool);
201 /* Given a filename in FILE->PATH, with the empty string interpreted
204 On success FILE contains an open file descriptor and stat
205 information for the file. On failure the file descriptor is -1 and
206 the appropriate errno is also stored in FILE. Returns TRUE iff
209 We used to open files in nonblocking mode, but that caused more
210 problems than it solved. Do take care not to acquire a controlling
211 terminal by mistake (this can't happen on sane systems, but
212 paranoia is a virtue).
214 Use the three-argument form of open even though we aren't
215 specifying O_CREAT, to defend against broken system headers.
217 O_BINARY tells some runtime libraries (notably DJGPP) not to do
218 newline translation; we can handle DOS line breaks just fine
221 open_file (_cpp_file
*file
)
223 if (file
->path
[0] == '\0')
226 set_stdin_to_binary_mode ();
229 file
->fd
= open (file
->path
, O_RDONLY
| O_NOCTTY
| O_BINARY
, 0666);
233 if (fstat (file
->fd
, &file
->st
) == 0)
235 if (!S_ISDIR (file
->st
.st_mode
))
241 /* Ignore a directory and continue the search. The file we're
242 looking for may be elsewhere in the search path. */
249 #if defined(_WIN32) && !defined(__CYGWIN__)
250 else if (errno
== EACCES
)
252 /* On most UNIX systems, open succeeds on a directory. Above,
253 we check if we have opened a directory and if so, set errno
254 to ENOENT. However, on Windows, opening a directory
255 fails with EACCES. We want to return ENOENT in that
257 if (stat (file
->path
, &file
->st
) == 0
258 && S_ISDIR (file
->st
.st_mode
))
261 /* The call to stat may have reset errno. */
265 else if (errno
== ENOTDIR
)
268 file
->err_no
= errno
;
273 /* Temporary PCH intercept of opening a file. Try to find a PCH file
274 based on FILE->name and FILE->dir, and test those found for
275 validity using PFILE->cb.valid_pch. Return true iff a valid file is
276 found. Set *INVALID_PCH if a PCH file is found but wasn't valid. */
279 pch_open_file (cpp_reader
*pfile
, _cpp_file
*file
, bool *invalid_pch
)
281 static const char extension
[] = ".gch";
282 const char *path
= file
->path
;
288 /* No PCH on <stdin> or if not requested. */
289 if (file
->name
[0] == '\0' || !pfile
->cb
.valid_pch
)
292 /* If the file is not included as first include from either the toplevel
293 file or the command-line it is not a valid use of PCH. */
294 for (_cpp_file
*f
= pfile
->all_files
; f
; f
= f
->next_file
)
295 if (f
->implicit_preinclude
)
297 else if (f
->main_file
)
302 flen
= strlen (path
);
303 len
= flen
+ sizeof (extension
);
304 pchname
= XNEWVEC (char, len
);
305 memcpy (pchname
, path
, flen
);
306 memcpy (pchname
+ flen
, extension
, sizeof (extension
));
308 if (stat (pchname
, &st
) == 0)
312 size_t dlen
, plen
= len
;
314 if (!S_ISDIR (st
.st_mode
))
315 valid
= validate_pch (pfile
, file
, pchname
);
316 else if ((pchdir
= opendir (pchname
)) != NULL
)
318 pchname
[plen
- 1] = '/';
319 while ((d
= readdir (pchdir
)) != NULL
)
321 dlen
= strlen (d
->d_name
) + 1;
322 if ((strcmp (d
->d_name
, ".") == 0)
323 || (strcmp (d
->d_name
, "..") == 0))
325 if (dlen
+ plen
> len
)
328 pchname
= XRESIZEVEC (char, pchname
, len
);
330 memcpy (pchname
+ plen
, d
->d_name
, dlen
);
331 valid
= validate_pch (pfile
, file
, pchname
);
342 file
->pchname
= pchname
;
349 /* Canonicalize the path to FILE. Return the canonical form if it is
350 shorter, otherwise return NULL. This function does NOT free the
351 memory pointed by FILE. */
354 maybe_shorter_path (const char * file
)
356 char * file2
= lrealpath (file
);
357 if (file2
&& strlen (file2
) < strlen (file
))
368 /* Try to open the path FILE->name appended to FILE->dir. This is
369 where remap and PCH intercept the file lookup process. Return true
370 if the file was found, whether or not the open was successful.
371 Set *INVALID_PCH to true if a PCH file is found but wasn't valid. */
374 find_file_in_dir (cpp_reader
*pfile
, _cpp_file
*file
, bool *invalid_pch
)
378 if (CPP_OPTION (pfile
, remap
) && (path
= remap_filename (pfile
, file
)))
381 if (file
->dir
->construct
)
382 path
= file
->dir
->construct (file
->name
, file
->dir
);
384 path
= append_file_to_dir (file
->name
, file
->dir
);
392 /* We try to canonicalize system headers. For DOS based file
393 * system, we always try to shorten non-system headers, as DOS
394 * has a tighter constraint on max path length. */
395 if ((CPP_OPTION (pfile
, canonical_system_headers
) && file
->dir
->sysp
)
396 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
401 char * canonical_path
= maybe_shorter_path (path
);
404 /* The canonical path was newly allocated. Let's free the
405 non-canonical one. */
407 path
= canonical_path
;
411 hv
= htab_hash_string (path
);
412 if (htab_find_with_hash (pfile
->nonexistent_file_hash
, path
, hv
) != NULL
)
414 file
->err_no
= ENOENT
;
419 if (pch_open_file (pfile
, file
, invalid_pch
))
422 if (open_file (file
))
425 if (file
->err_no
!= ENOENT
)
427 open_file_failed (pfile
, file
, 0);
431 /* We copy the path name onto an obstack partly so that we don't
432 leak the memory, but mostly so that we don't fragment the
434 copy
= (char *) obstack_copy0 (&pfile
->nonexistent_file_ob
, path
,
437 pp
= htab_find_slot_with_hash (pfile
->nonexistent_file_hash
,
441 file
->path
= file
->name
;
445 file
->err_no
= ENOENT
;
452 /* Return tue iff the missing_header callback found the given HEADER. */
454 search_path_exhausted (cpp_reader
*pfile
, const char *header
, _cpp_file
*file
)
456 missing_header_cb func
= pfile
->cb
.missing_header
;
458 /* When the regular search path doesn't work, try context dependent
459 headers search paths. */
461 && file
->dir
== NULL
)
463 if ((file
->path
= func (pfile
, header
, &file
->dir
)) != NULL
)
465 if (open_file (file
))
467 free ((void *)file
->path
);
469 file
->path
= file
->name
;
476 _cpp_find_failed (_cpp_file
*file
)
478 return file
->err_no
!= 0;
481 /* Given a filename FNAME search for such a file in the include path
482 starting from START_DIR. If FNAME is the empty string it is
483 interpreted as STDIN if START_DIR is PFILE->no_search_path.
485 If the file is not found in the file cache fall back to the O/S and
486 add the result to our cache.
488 If the file was not found in the filesystem, or there was an error
489 opening it, then ERR_NO is nonzero and FD is -1. If the file was
490 found, then ERR_NO is zero and FD could be -1 or an open file
491 descriptor. FD can be -1 if the file was found in the cache and
492 had previously been closed. To open it again pass the return value
495 If IMPLICIT_PREINCLUDE then it is OK for the file to be missing.
496 If present, it is OK for a precompiled header to be included after
500 _cpp_find_file (cpp_reader
*pfile
, const char *fname
, cpp_dir
*start_dir
,
501 bool fake
, int angle_brackets
, bool implicit_preinclude
)
503 struct cpp_file_hash_entry
*entry
;
506 bool invalid_pch
= false;
507 bool saw_bracket_include
= false;
508 bool saw_quote_include
= false;
509 struct cpp_dir
*found_in_cache
= NULL
;
511 /* Ensure we get no confusion between cached files and directories. */
512 if (start_dir
== NULL
)
513 cpp_error (pfile
, CPP_DL_ICE
, "NULL directory in find_file");
516 = htab_find_slot_with_hash (pfile
->file_hash
, fname
,
517 htab_hash_string (fname
), INSERT
);
519 /* First check the cache before we resort to memory allocation. */
520 entry
= search_cache ((struct cpp_file_hash_entry
*) *hash_slot
, start_dir
);
522 return entry
->u
.file
;
524 file
= make_cpp_file (pfile
, start_dir
, fname
);
525 file
->implicit_preinclude
= implicit_preinclude
;
527 /* Try each path in the include chain. */
530 if (find_file_in_dir (pfile
, file
, &invalid_pch
))
533 file
->dir
= file
->dir
->next
;
534 if (file
->dir
== NULL
)
536 if (search_path_exhausted (pfile
, fname
, file
))
538 /* Although this file must not go in the cache, because
539 the file found might depend on things (like the current file)
540 that aren't represented in the cache, it still has to go in
541 the list of all files so that #import works. */
542 file
->next_file
= pfile
->all_files
;
543 pfile
->all_files
= file
;
544 if (*hash_slot
== NULL
)
546 /* If *hash_slot is NULL, the above htab_find_slot_with_hash
547 call just created the slot, but we aren't going to store
548 there anything, so need to remove the newly created entry.
549 htab_clear_slot requires that it is non-NULL, so store
550 there some non-NULL pointer, htab_clear_slot will
551 overwrite it immediately. */
553 htab_clear_slot (pfile
->file_hash
, hash_slot
);
560 cpp_error (pfile
, CPP_DL_ERROR
,
561 "one or more PCH files were found, but they were invalid");
562 if (!cpp_get_options (pfile
)->warn_invalid_pch
)
563 cpp_error (pfile
, CPP_DL_ERROR
,
564 "use -Winvalid-pch for more information");
566 if (implicit_preinclude
)
568 free ((char *) file
->name
);
570 if (*hash_slot
== NULL
)
572 /* See comment on the above htab_clear_slot call. */
574 htab_clear_slot (pfile
->file_hash
, hash_slot
);
579 open_file_failed (pfile
, file
, angle_brackets
);
583 /* Only check the cache for the starting location (done above)
584 and the quote and bracket chain heads because there are no
585 other possible starting points for searches. */
586 if (file
->dir
== pfile
->bracket_include
)
587 saw_bracket_include
= true;
588 else if (file
->dir
== pfile
->quote_include
)
589 saw_quote_include
= true;
593 entry
= search_cache ((struct cpp_file_hash_entry
*) *hash_slot
, file
->dir
);
596 found_in_cache
= file
->dir
;
603 /* Cache for START_DIR too, sharing the _cpp_file structure. */
604 free ((char *) file
->name
);
606 file
= entry
->u
.file
;
610 /* This is a new file; put it in the list. */
611 file
->next_file
= pfile
->all_files
;
612 pfile
->all_files
= file
;
615 /* Store this new result in the hash table. */
616 entry
= new_file_hash_entry (pfile
);
617 entry
->next
= (struct cpp_file_hash_entry
*) *hash_slot
;
618 entry
->start_dir
= start_dir
;
619 entry
->location
= pfile
->line_table
->highest_location
;
620 entry
->u
.file
= file
;
621 *hash_slot
= (void *) entry
;
623 /* If we passed the quote or bracket chain heads, cache them also.
624 This speeds up processing if there are lots of -I options. */
625 if (saw_bracket_include
626 && pfile
->bracket_include
!= start_dir
627 && found_in_cache
!= pfile
->bracket_include
)
629 entry
= new_file_hash_entry (pfile
);
630 entry
->next
= (struct cpp_file_hash_entry
*) *hash_slot
;
631 entry
->start_dir
= pfile
->bracket_include
;
632 entry
->location
= pfile
->line_table
->highest_location
;
633 entry
->u
.file
= file
;
634 *hash_slot
= (void *) entry
;
636 if (saw_quote_include
637 && pfile
->quote_include
!= start_dir
638 && found_in_cache
!= pfile
->quote_include
)
640 entry
= new_file_hash_entry (pfile
);
641 entry
->next
= (struct cpp_file_hash_entry
*) *hash_slot
;
642 entry
->start_dir
= pfile
->quote_include
;
643 entry
->location
= pfile
->line_table
->highest_location
;
644 entry
->u
.file
= file
;
645 *hash_slot
= (void *) entry
;
651 /* Read a file into FILE->buffer, returning true on success.
653 If FILE->fd is something weird, like a block device, we don't want
654 to read it at all. Don't even try to figure out what something is,
655 except for plain files and block devices, since there is no
656 reliable portable way of doing this.
658 FIXME: Flush file cache and try again if we run out of memory. */
660 read_file_guts (cpp_reader
*pfile
, _cpp_file
*file
)
662 ssize_t size
, total
, count
;
666 if (S_ISBLK (file
->st
.st_mode
))
668 cpp_error (pfile
, CPP_DL_ERROR
, "%s is a block device", file
->path
);
672 regular
= S_ISREG (file
->st
.st_mode
) != 0;
675 /* off_t might have a wider range than ssize_t - in other words,
676 the max size of a file might be bigger than the address
677 space. We can't handle a file that large. (Anyone with
678 a single source file bigger than 2GB needs to rethink
679 their coding style.) Some systems (e.g. AIX 4.1) define
680 SSIZE_MAX to be much smaller than the actual range of the
681 type. Use INTTYPE_MAXIMUM unconditionally to ensure this
683 if (file
->st
.st_size
> INTTYPE_MAXIMUM (ssize_t
))
685 cpp_error (pfile
, CPP_DL_ERROR
, "%s is too large", file
->path
);
689 size
= file
->st
.st_size
;
692 /* 8 kilobytes is a sensible starting size. It ought to be bigger
693 than the kernel pipe buffer, and it's definitely bigger than
694 the majority of C source files. */
697 /* The + 16 here is space for the final '\n' and 15 bytes of padding,
698 used to quiet warnings from valgrind or Address Sanitizer, when the
699 optimized lexer accesses aligned 16-byte memory chunks, including
700 the bytes after the malloced, area, and stops lexing on '\n'. */
701 buf
= XNEWVEC (uchar
, size
+ 16);
703 while ((count
= read (file
->fd
, buf
+ total
, size
- total
)) > 0)
712 buf
= XRESIZEVEC (uchar
, buf
, size
+ 16);
718 cpp_errno_filename (pfile
, CPP_DL_ERROR
, file
->path
);
723 if (regular
&& total
!= size
&& STAT_SIZE_RELIABLE (file
->st
))
724 cpp_error (pfile
, CPP_DL_WARNING
,
725 "%s is shorter than expected", file
->path
);
727 file
->buffer
= _cpp_convert_input (pfile
,
728 CPP_OPTION (pfile
, input_charset
),
729 buf
, size
+ 16, total
,
732 file
->buffer_valid
= true;
737 /* Convenience wrapper around read_file_guts that opens the file if
738 necessary and closes the file descriptor after reading. FILE must
739 have been passed through find_file() at some stage. */
741 read_file (cpp_reader
*pfile
, _cpp_file
*file
)
743 /* If we already have its contents in memory, succeed immediately. */
744 if (file
->buffer_valid
)
747 /* If an earlier read failed for some reason don't try again. */
748 if (file
->dont_read
|| file
->err_no
)
751 if (file
->fd
== -1 && !open_file (file
))
753 open_file_failed (pfile
, file
, 0);
757 file
->dont_read
= !read_file_guts (pfile
, file
);
761 return !file
->dont_read
;
764 /* Returns TRUE if FILE's contents have been successfully placed in
765 FILE->buffer and the file should be stacked, otherwise false. */
767 should_stack_file (cpp_reader
*pfile
, _cpp_file
*file
, bool import
)
771 /* Skip once-only files. */
775 /* We must mark the file once-only if #import now, before header
776 guard checks. Otherwise, undefining the header guard might
777 cause the file to be re-stacked. */
780 _cpp_mark_file_once_only (pfile
, file
);
782 /* Don't stack files that have been stacked before. */
783 if (file
->stack_count
)
787 /* Skip if the file had a header guard and the macro is defined.
788 PCH relies on this appearing before the PCH handler below. */
789 if (file
->cmacro
&& file
->cmacro
->type
== NT_MACRO
)
792 /* Handle PCH files immediately; don't stack them. */
795 pfile
->cb
.read_pch (pfile
, file
->pchname
, file
->fd
, file
->path
);
797 free ((void *) file
->pchname
);
798 file
->pchname
= NULL
;
802 if (!read_file (pfile
, file
))
805 /* Check the file against the PCH file. This is done before
806 checking against files we've already seen, since it may save on
808 if (check_file_against_entries (pfile
, file
, import
))
810 /* If this isn't a #import, but yet we can't include the file,
811 that means that it was #import-ed in the PCH file,
812 so we can never include it again. */
814 _cpp_mark_file_once_only (pfile
, file
);
818 /* Now we've read the file's contents, we can stack it if there
819 are no once-only files. */
820 if (!pfile
->seen_once_only
)
823 /* We may have read the file under a different name. Look
824 for likely candidates and compare file contents to be sure. */
825 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
830 if ((import
|| f
->once_only
)
832 && f
->st
.st_mtime
== file
->st
.st_mtime
833 && f
->st
.st_size
== file
->st
.st_size
)
836 bool same_file_p
= false;
838 if (f
->buffer
&& !f
->buffer_valid
)
840 /* We already have a buffer but it is not valid, because
841 the file is still stacked. Make a new one. */
842 ref_file
= make_cpp_file (pfile
, f
->dir
, f
->name
);
843 ref_file
->path
= f
->path
;
846 /* The file is not stacked anymore. We can reuse it. */
849 same_file_p
= read_file (pfile
, ref_file
)
850 /* Size might have changed in read_file(). */
851 && ref_file
->st
.st_size
== file
->st
.st_size
852 && !memcmp (ref_file
->buffer
,
856 if (f
->buffer
&& !f
->buffer_valid
)
859 destroy_cpp_file (ref_file
);
870 /* Place the file referenced by FILE into a new buffer on the buffer
871 stack if possible. IMPORT is true if this stacking attempt is
872 because of a #import directive. Returns true if a buffer is
875 _cpp_stack_file (cpp_reader
*pfile
, _cpp_file
*file
, bool import
)
880 if (!should_stack_file (pfile
, file
, import
))
883 if (pfile
->buffer
== NULL
|| file
->dir
== NULL
)
886 sysp
= MAX (pfile
->buffer
->sysp
, file
->dir
->sysp
);
888 /* Add the file to the dependencies on its first inclusion. */
889 if (CPP_OPTION (pfile
, deps
.style
) > !!sysp
&& !file
->stack_count
)
891 if (!file
->main_file
|| !CPP_OPTION (pfile
, deps
.ignore_main_file
))
892 deps_add_dep (pfile
->deps
, file
->path
);
895 /* Clear buffer_valid since _cpp_clean_line messes it up. */
896 file
->buffer_valid
= false;
899 /* Stack the buffer. */
900 buffer
= cpp_push_buffer (pfile
, file
->buffer
, file
->st
.st_size
,
901 CPP_OPTION (pfile
, preprocessed
)
902 && !CPP_OPTION (pfile
, directives_only
));
905 buffer
->to_free
= file
->buffer_start
;
907 /* Initialize controlling macro state. */
908 pfile
->mi_valid
= true;
909 pfile
->mi_cmacro
= 0;
911 /* Generate the call back. */
912 _cpp_do_file_change (pfile
, LC_ENTER
, file
->path
, 1, sysp
);
917 /* Mark FILE to be included once only. */
919 _cpp_mark_file_once_only (cpp_reader
*pfile
, _cpp_file
*file
)
921 pfile
->seen_once_only
= true;
922 file
->once_only
= true;
925 /* Return the directory from which searching for FNAME should start,
926 considering the directive TYPE and ANGLE_BRACKETS. If there is
927 nothing left in the path, returns NULL. */
928 static struct cpp_dir
*
929 search_path_head (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
930 enum include_type type
)
935 if (IS_ABSOLUTE_PATH (fname
))
936 return &pfile
->no_search_path
;
938 /* pfile->buffer is NULL when processing an -include command-line flag. */
939 file
= pfile
->buffer
== NULL
? pfile
->main_file
: pfile
->buffer
->file
;
941 /* For #include_next, skip in the search path past the dir in which
942 the current file was found, but if it was found via an absolute
943 path use the normal search logic. */
944 if (type
== IT_INCLUDE_NEXT
&& file
->dir
945 && file
->dir
!= &pfile
->no_search_path
)
946 dir
= file
->dir
->next
;
947 else if (angle_brackets
)
948 dir
= pfile
->bracket_include
;
949 else if (type
== IT_CMDLINE
)
950 /* -include and -imacros use the #include "" chain with the
951 preprocessor's cwd prepended. */
952 return make_cpp_dir (pfile
, "./", false);
953 else if (pfile
->quote_ignores_source_dir
)
954 dir
= pfile
->quote_include
;
956 return make_cpp_dir (pfile
, dir_name_of_file (file
),
957 pfile
->buffer
? pfile
->buffer
->sysp
: 0);
960 cpp_error (pfile
, CPP_DL_ERROR
,
961 "no include path in which to search for %s", fname
);
966 /* Strip the basename from the file's path. It ends with a slash if
967 of nonzero length. Note that this procedure also works for
968 <stdin>, which is represented by the empty string. */
970 dir_name_of_file (_cpp_file
*file
)
974 size_t len
= lbasename (file
->path
) - file
->path
;
975 char *dir_name
= XNEWVEC (char, len
+ 1);
977 memcpy (dir_name
, file
->path
, len
);
978 dir_name
[len
] = '\0';
979 file
->dir_name
= dir_name
;
982 return file
->dir_name
;
985 /* Handles #include-family directives (distinguished by TYPE),
986 including HEADER, and the command line -imacros and -include.
987 Returns true if a buffer was stacked. */
989 _cpp_stack_include (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
990 enum include_type type
)
996 /* For -include command-line flags we have type == IT_CMDLINE.
997 When the first -include file is processed we have the case, where
998 pfile->cur_token == pfile->cur_run->base, we are directly called up
999 by the front end. However in the case of the second -include file,
1000 we are called from _cpp_lex_token -> _cpp_get_fresh_line ->
1001 cpp_push_include, with pfile->cur_token != pfile->cur_run->base,
1002 and pfile->cur_token[-1].src_loc not (yet) initialized.
1003 However, when the include file cannot be found, we need src_loc to
1004 be initialized to some safe value: 0 means UNKNOWN_LOCATION. */
1005 if (type
== IT_CMDLINE
&& pfile
->cur_token
!= pfile
->cur_run
->base
)
1006 pfile
->cur_token
[-1].src_loc
= 0;
1008 dir
= search_path_head (pfile
, fname
, angle_brackets
, type
);
1012 file
= _cpp_find_file (pfile
, fname
, dir
, false, angle_brackets
,
1013 type
== IT_DEFAULT
);
1014 if (type
== IT_DEFAULT
&& file
== NULL
)
1017 /* Compensate for the increment in linemap_add that occurs if
1018 _cpp_stack_file actually stacks the file. In the case of a
1019 normal #include, we're currently at the start of the line
1020 *following* the #include. A separate source_location for this
1021 location makes no sense (until we do the LC_LEAVE), and
1022 complicates LAST_SOURCE_LINE_LOCATION. This does not apply if we
1023 found a PCH file (in which case linemap_add is not called) or we
1024 were included from the command-line. */
1025 if (file
->pchname
== NULL
&& file
->err_no
== 0
1026 && type
!= IT_CMDLINE
&& type
!= IT_DEFAULT
)
1027 pfile
->line_table
->highest_location
--;
1029 stacked
= _cpp_stack_file (pfile
, file
, type
== IT_IMPORT
);
1032 /* _cpp_stack_file didn't stack the file, so let's rollback the
1033 compensation dance we performed above. */
1034 pfile
->line_table
->highest_location
++;
1039 /* Could not open FILE. The complication is dependency output. */
1041 open_file_failed (cpp_reader
*pfile
, _cpp_file
*file
, int angle_brackets
)
1043 int sysp
= pfile
->line_table
->highest_line
> 1 && pfile
->buffer
? pfile
->buffer
->sysp
: 0;
1044 bool print_dep
= CPP_OPTION (pfile
, deps
.style
) > (angle_brackets
|| !!sysp
);
1046 if (pfile
->state
.in__has_include__
)
1049 errno
= file
->err_no
;
1050 if (print_dep
&& CPP_OPTION (pfile
, deps
.missing_files
) && errno
== ENOENT
)
1052 deps_add_dep (pfile
->deps
, file
->name
);
1053 /* If the preprocessor output (other than dependency information) is
1054 being used, we must also flag an error. */
1055 if (CPP_OPTION (pfile
, deps
.need_preprocessor_output
))
1056 cpp_errno_filename (pfile
, CPP_DL_FATAL
,
1057 file
->path
? file
->path
: file
->name
);
1061 /* If we are not outputting dependencies, or if we are and dependencies
1062 were requested for this file, or if preprocessor output is needed
1063 in addition to dependency information, this is an error.
1065 Otherwise (outputting dependencies but not for this file, and not
1066 using the preprocessor output), we can still produce correct output
1067 so it's only a warning. */
1068 if (CPP_OPTION (pfile
, deps
.style
) == DEPS_NONE
1070 || CPP_OPTION (pfile
, deps
.need_preprocessor_output
))
1071 cpp_errno_filename (pfile
, CPP_DL_FATAL
,
1072 file
->path
? file
->path
: file
->name
);
1074 cpp_errno_filename (pfile
, CPP_DL_WARNING
,
1075 file
->path
? file
->path
: file
->name
);
1079 /* Search in the chain beginning at HEAD for a file whose search path
1080 started at START_DIR != NULL. */
1081 static struct cpp_file_hash_entry
*
1082 search_cache (struct cpp_file_hash_entry
*head
, const cpp_dir
*start_dir
)
1084 while (head
&& head
->start_dir
!= start_dir
)
1090 /* Allocate a new _cpp_file structure. */
1092 make_cpp_file (cpp_reader
*pfile
, cpp_dir
*dir
, const char *fname
)
1096 file
= XCNEW (_cpp_file
);
1097 file
->main_file
= !pfile
->buffer
;
1100 file
->name
= xstrdup (fname
);
1105 /* Release a _cpp_file structure. */
1107 destroy_cpp_file (_cpp_file
*file
)
1109 free ((void *) file
->buffer_start
);
1110 free ((void *) file
->name
);
1114 /* Release all the files allocated by this reader. */
1116 destroy_all_cpp_files (cpp_reader
*pfile
)
1118 _cpp_file
*iter
= pfile
->all_files
;
1121 _cpp_file
*next
= iter
->next_file
;
1122 destroy_cpp_file (iter
);
1127 /* A hash of directory names. The directory names are the path names
1128 of files which contain a #include "", the included file name is
1129 appended to this directories.
1131 To avoid duplicate entries we follow the convention that all
1132 non-empty directory names should end in a '/'. DIR_NAME must be
1133 stored in permanently allocated memory. */
1135 make_cpp_dir (cpp_reader
*pfile
, const char *dir_name
, int sysp
)
1137 struct cpp_file_hash_entry
*entry
, **hash_slot
;
1140 hash_slot
= (struct cpp_file_hash_entry
**)
1141 htab_find_slot_with_hash (pfile
->dir_hash
, dir_name
,
1142 htab_hash_string (dir_name
),
1145 /* Have we already hashed this directory? */
1146 for (entry
= *hash_slot
; entry
; entry
= entry
->next
)
1147 if (entry
->start_dir
== NULL
)
1148 return entry
->u
.dir
;
1150 dir
= XCNEW (cpp_dir
);
1151 dir
->next
= pfile
->quote_include
;
1152 dir
->name
= (char *) dir_name
;
1153 dir
->len
= strlen (dir_name
);
1157 /* Store this new result in the hash table. */
1158 entry
= new_file_hash_entry (pfile
);
1159 entry
->next
= *hash_slot
;
1160 entry
->start_dir
= NULL
;
1161 entry
->location
= pfile
->line_table
->highest_location
;
1168 /* Create a new block of memory for file hash entries. */
1170 allocate_file_hash_entries (cpp_reader
*pfile
)
1172 struct file_hash_entry_pool
*pool
= XNEW (struct file_hash_entry_pool
);
1173 pool
->file_hash_entries_used
= 0;
1174 pool
->next
= pfile
->file_hash_entries
;
1175 pfile
->file_hash_entries
= pool
;
1178 /* Return a new file hash entry. */
1179 static struct cpp_file_hash_entry
*
1180 new_file_hash_entry (cpp_reader
*pfile
)
1183 if (pfile
->file_hash_entries
->file_hash_entries_used
== FILE_HASH_POOL_SIZE
)
1184 allocate_file_hash_entries (pfile
);
1186 idx
= pfile
->file_hash_entries
->file_hash_entries_used
++;
1187 return &pfile
->file_hash_entries
->pool
[idx
];
1190 /* Free the file hash entry pools. */
1192 free_file_hash_entries (cpp_reader
*pfile
)
1194 struct file_hash_entry_pool
*iter
= pfile
->file_hash_entries
;
1197 struct file_hash_entry_pool
*next
= iter
->next
;
1203 /* Returns TRUE if a file FNAME has ever been successfully opened.
1204 This routine is not intended to correctly handle filenames aliased
1205 by links or redundant . or .. traversals etc. */
1207 cpp_included (cpp_reader
*pfile
, const char *fname
)
1209 struct cpp_file_hash_entry
*entry
;
1211 entry
= (struct cpp_file_hash_entry
*)
1212 htab_find_with_hash (pfile
->file_hash
, fname
, htab_hash_string (fname
));
1214 while (entry
&& (entry
->start_dir
== NULL
|| entry
->u
.file
->err_no
))
1215 entry
= entry
->next
;
1217 return entry
!= NULL
;
1220 /* Returns TRUE if a file FNAME has ever been successfully opened
1221 before LOCATION. This routine is not intended to correctly handle
1222 filenames aliased by links or redundant . or .. traversals etc. */
1224 cpp_included_before (cpp_reader
*pfile
, const char *fname
,
1225 source_location location
)
1227 struct cpp_file_hash_entry
*entry
1228 = (struct cpp_file_hash_entry
*)
1229 htab_find_with_hash (pfile
->file_hash
, fname
, htab_hash_string (fname
));
1231 if (IS_ADHOC_LOC (location
))
1232 location
= get_location_from_adhoc_loc (pfile
->line_table
, location
);
1234 while (entry
&& (entry
->start_dir
== NULL
|| entry
->u
.file
->err_no
1235 || entry
->location
> location
))
1236 entry
= entry
->next
;
1238 return entry
!= NULL
;
1241 /* Calculate the hash value of a file hash entry P. */
1244 file_hash_hash (const void *p
)
1246 struct cpp_file_hash_entry
*entry
= (struct cpp_file_hash_entry
*) p
;
1248 if (entry
->start_dir
)
1249 hname
= entry
->u
.file
->name
;
1251 hname
= entry
->u
.dir
->name
;
1253 return htab_hash_string (hname
);
1256 /* Compare a string Q against a file hash entry P. */
1258 file_hash_eq (const void *p
, const void *q
)
1260 struct cpp_file_hash_entry
*entry
= (struct cpp_file_hash_entry
*) p
;
1261 const char *fname
= (const char *) q
;
1264 if (entry
->start_dir
)
1265 hname
= entry
->u
.file
->name
;
1267 hname
= entry
->u
.dir
->name
;
1269 return filename_cmp (hname
, fname
) == 0;
1272 /* Compare entries in the nonexistent file hash table. These are just
1275 nonexistent_file_hash_eq (const void *p
, const void *q
)
1277 return filename_cmp ((const char *) p
, (const char *) q
) == 0;
1280 /* Initialize everything in this source file. */
1282 _cpp_init_files (cpp_reader
*pfile
)
1284 pfile
->file_hash
= htab_create_alloc (127, file_hash_hash
, file_hash_eq
,
1285 NULL
, xcalloc
, free
);
1286 pfile
->dir_hash
= htab_create_alloc (127, file_hash_hash
, file_hash_eq
,
1287 NULL
, xcalloc
, free
);
1288 allocate_file_hash_entries (pfile
);
1289 pfile
->nonexistent_file_hash
= htab_create_alloc (127, htab_hash_string
,
1290 nonexistent_file_hash_eq
,
1291 NULL
, xcalloc
, free
);
1292 obstack_specify_allocation (&pfile
->nonexistent_file_ob
, 0, 0,
1296 /* Finalize everything in this source file. */
1298 _cpp_cleanup_files (cpp_reader
*pfile
)
1300 htab_delete (pfile
->file_hash
);
1301 htab_delete (pfile
->dir_hash
);
1302 htab_delete (pfile
->nonexistent_file_hash
);
1303 obstack_free (&pfile
->nonexistent_file_ob
, 0);
1304 free_file_hash_entries (pfile
);
1305 destroy_all_cpp_files (pfile
);
1308 /* Make the parser forget about files it has seen. This can be useful
1309 for resetting the parser to start another run. */
1311 cpp_clear_file_cache (cpp_reader
*pfile
)
1313 _cpp_cleanup_files (pfile
);
1314 pfile
->file_hash_entries
= NULL
;
1315 pfile
->all_files
= NULL
;
1316 _cpp_init_files (pfile
);
1319 /* Enter a file name in the hash for the sake of cpp_included. */
1321 _cpp_fake_include (cpp_reader
*pfile
, const char *fname
)
1323 _cpp_find_file (pfile
, fname
, pfile
->buffer
->file
->dir
, true, 0, false);
1326 /* Not everyone who wants to set system-header-ness on a buffer can
1327 see the details of a buffer. This is an exported interface because
1328 fix-header needs it. */
1330 cpp_make_system_header (cpp_reader
*pfile
, int syshdr
, int externc
)
1333 const struct line_maps
*line_table
= pfile
->line_table
;
1334 const line_map_ordinary
*map
= LINEMAPS_LAST_ORDINARY_MAP (line_table
);
1335 /* 1 = system header, 2 = system header to be treated as C. */
1337 flags
= 1 + (externc
!= 0);
1338 pfile
->buffer
->sysp
= flags
;
1339 _cpp_do_file_change (pfile
, LC_RENAME
, ORDINARY_MAP_FILE_NAME (map
),
1340 SOURCE_LINE (map
, pfile
->line_table
->highest_line
), flags
);
1343 /* Allow the client to change the current file. Used by the front end
1344 to achieve pseudo-file names like <built-in>.
1345 If REASON is LC_LEAVE, then NEW_NAME must be NULL. */
1347 cpp_change_file (cpp_reader
*pfile
, enum lc_reason reason
,
1348 const char *new_name
)
1350 _cpp_do_file_change (pfile
, reason
, new_name
, 1, 0);
1353 struct report_missing_guard_data
1359 /* Callback function for htab_traverse. */
1361 report_missing_guard (void **slot
, void *d
)
1363 struct cpp_file_hash_entry
*entry
= (struct cpp_file_hash_entry
*) *slot
;
1364 struct report_missing_guard_data
*data
1365 = (struct report_missing_guard_data
*) d
;
1367 /* Skip directories. */
1368 if (entry
->start_dir
!= NULL
)
1370 _cpp_file
*file
= entry
->u
.file
;
1372 /* We don't want MI guard advice for the main file. */
1373 if (!file
->once_only
&& file
->cmacro
== NULL
1374 && file
->stack_count
== 1 && !file
->main_file
)
1376 if (data
->paths
== NULL
)
1378 data
->paths
= XCNEWVEC (const char *, data
->count
);
1382 data
->paths
[data
->count
++] = file
->path
;
1386 /* Keep traversing the hash table. */
1390 /* Comparison function for qsort. */
1392 report_missing_guard_cmp (const void *p1
, const void *p2
)
1394 return strcmp (*(const char *const *) p1
, *(const char *const *) p2
);
1397 /* Report on all files that might benefit from a multiple include guard.
1400 _cpp_report_missing_guards (cpp_reader
*pfile
)
1402 struct report_missing_guard_data data
;
1405 data
.count
= htab_elements (pfile
->file_hash
);
1406 htab_traverse (pfile
->file_hash
, report_missing_guard
, &data
);
1408 if (data
.paths
!= NULL
)
1412 /* Sort the paths to avoid outputting them in hash table
1414 qsort (data
.paths
, data
.count
, sizeof (const char *),
1415 report_missing_guard_cmp
);
1416 fputs (_("Multiple include guards may be useful for:\n"),
1418 for (i
= 0; i
< data
.count
; i
++)
1420 fputs (data
.paths
[i
], stderr
);
1421 putc ('\n', stderr
);
1427 /* Locate HEADER, and determine whether it is newer than the current
1428 file. If it cannot be located or dated, return -1, if it is
1429 newer, return 1, otherwise 0. */
1431 _cpp_compare_file_date (cpp_reader
*pfile
, const char *fname
,
1435 struct cpp_dir
*dir
;
1437 dir
= search_path_head (pfile
, fname
, angle_brackets
, IT_INCLUDE
);
1441 file
= _cpp_find_file (pfile
, fname
, dir
, false, angle_brackets
, false);
1451 return file
->st
.st_mtime
> pfile
->buffer
->file
->st
.st_mtime
;
1454 /* Pushes the given file onto the buffer stack. Returns nonzero if
1457 cpp_push_include (cpp_reader
*pfile
, const char *fname
)
1459 return _cpp_stack_include (pfile
, fname
, false, IT_CMDLINE
);
1462 /* Pushes the given file, implicitly included at the start of a
1463 compilation, onto the buffer stack but without any errors if the
1464 file is not found. Returns nonzero if successful. */
1466 cpp_push_default_include (cpp_reader
*pfile
, const char *fname
)
1468 return _cpp_stack_include (pfile
, fname
, true, IT_DEFAULT
);
1471 /* Do appropriate cleanup when a file INC's buffer is popped off the
1474 _cpp_pop_file_buffer (cpp_reader
*pfile
, _cpp_file
*file
,
1475 const unsigned char *to_free
)
1477 /* Record the inclusion-preventing macro, which could be NULL
1478 meaning no controlling macro. */
1479 if (pfile
->mi_valid
&& file
->cmacro
== NULL
)
1480 file
->cmacro
= pfile
->mi_cmacro
;
1482 /* Invalidate control macros in the #including file. */
1483 pfile
->mi_valid
= false;
1487 if (to_free
== file
->buffer_start
)
1489 file
->buffer_start
= NULL
;
1490 file
->buffer
= NULL
;
1491 file
->buffer_valid
= false;
1493 free ((void *) to_free
);
1497 /* Return the file name associated with FILE. */
1499 _cpp_get_file_name (_cpp_file
*file
)
1504 /* Inteface to file statistics record in _cpp_file structure. */
1506 _cpp_get_file_stat (_cpp_file
*file
)
1511 /* Set the include chain for "" to QUOTE, for <> to BRACKET. If
1512 QUOTE_IGNORES_SOURCE_DIR, then "" includes do not look in the
1513 directory of the including file.
1515 If BRACKET does not lie in the QUOTE chain, it is set to QUOTE. */
1517 cpp_set_include_chains (cpp_reader
*pfile
, cpp_dir
*quote
, cpp_dir
*bracket
,
1518 int quote_ignores_source_dir
)
1520 pfile
->quote_include
= quote
;
1521 pfile
->bracket_include
= quote
;
1522 pfile
->quote_ignores_source_dir
= quote_ignores_source_dir
;
1524 for (; quote
; quote
= quote
->next
)
1526 quote
->name_map
= NULL
;
1527 quote
->len
= strlen (quote
->name
);
1528 if (quote
== bracket
)
1529 pfile
->bracket_include
= bracket
;
1533 /* Append the file name to the directory to create the path, but don't
1534 turn / into // or // into ///; // may be a namespace escape. */
1536 append_file_to_dir (const char *fname
, cpp_dir
*dir
)
1542 flen
= strlen (fname
);
1543 path
= XNEWVEC (char, dlen
+ 1 + flen
+ 1);
1544 memcpy (path
, dir
->name
, dlen
);
1545 if (dlen
&& !IS_DIR_SEPARATOR (path
[dlen
- 1]))
1547 memcpy (&path
[dlen
], fname
, flen
+ 1);
1552 /* Read a space delimited string of unlimited length from a stdio
1555 read_filename_string (int ch
, FILE *f
)
1561 set
= alloc
= XNEWVEC (char, len
+ 1);
1562 if (! is_space (ch
))
1565 while ((ch
= getc (f
)) != EOF
&& ! is_space (ch
))
1567 if (set
- alloc
== len
)
1570 alloc
= XRESIZEVEC (char, alloc
, len
+ 1);
1571 set
= alloc
+ len
/ 2;
1581 /* Read the file name map file for DIR. */
1583 read_name_map (cpp_dir
*dir
)
1585 static const char FILE_NAME_MAP_FILE
[] = "header.gcc";
1588 size_t len
, count
= 0, room
= 9;
1591 name
= (char *) alloca (len
+ sizeof (FILE_NAME_MAP_FILE
) + 1);
1592 memcpy (name
, dir
->name
, len
);
1593 if (len
&& !IS_DIR_SEPARATOR (name
[len
- 1]))
1595 strcpy (name
+ len
, FILE_NAME_MAP_FILE
);
1596 f
= fopen (name
, "r");
1598 dir
->name_map
= XNEWVEC (const char *, room
);
1600 /* Silently return NULL if we cannot open. */
1605 while ((ch
= getc (f
)) != EOF
)
1612 if (count
+ 2 > room
)
1615 dir
->name_map
= XRESIZEVEC (const char *, dir
->name_map
, room
);
1618 dir
->name_map
[count
] = read_filename_string (ch
, f
);
1619 while ((ch
= getc (f
)) != EOF
&& is_hspace (ch
))
1622 to
= read_filename_string (ch
, f
);
1623 if (IS_ABSOLUTE_PATH (to
))
1624 dir
->name_map
[count
+ 1] = to
;
1627 dir
->name_map
[count
+ 1] = append_file_to_dir (to
, dir
);
1632 while ((ch
= getc (f
)) != '\n')
1640 /* Terminate the list of maps. */
1641 dir
->name_map
[count
] = NULL
;
1644 /* Remap a FILE's name based on the file_name_map, if any, for
1645 FILE->dir. If the file name has any directory separators,
1646 recursively check those directories too. */
1648 remap_filename (cpp_reader
*pfile
, _cpp_file
*file
)
1650 const char *fname
, *p
;
1661 read_name_map (dir
);
1663 for (index
= 0; dir
->name_map
[index
]; index
+= 2)
1664 if (!filename_cmp (dir
->name_map
[index
], fname
))
1665 return xstrdup (dir
->name_map
[index
+ 1]);
1666 if (IS_ABSOLUTE_PATH (fname
))
1668 p
= strchr (fname
, '/');
1669 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
1671 char *p2
= strchr (fname
, '\\');
1676 if (!p
|| p
== fname
)
1679 len
= dir
->len
+ (p
- fname
+ 1);
1680 new_dir
= XNEWVEC (char, len
+ 1);
1681 memcpy (new_dir
, dir
->name
, dir
->len
);
1682 memcpy (new_dir
+ dir
->len
, fname
, p
- fname
+ 1);
1683 new_dir
[len
] = '\0';
1685 dir
= make_cpp_dir (pfile
, new_dir
, dir
->sysp
);
1690 /* Returns true if PCHNAME is a valid PCH file for FILE. */
1692 validate_pch (cpp_reader
*pfile
, _cpp_file
*file
, const char *pchname
)
1694 const char *saved_path
= file
->path
;
1697 file
->path
= pchname
;
1698 if (open_file (file
))
1700 valid
= 1 & pfile
->cb
.valid_pch (pfile
, pchname
, file
->fd
);
1708 if (CPP_OPTION (pfile
, print_include_names
))
1711 for (i
= 1; i
< pfile
->line_table
->depth
; i
++)
1713 fprintf (stderr
, "%c %s\n",
1714 valid
? '!' : 'x', pchname
);
1718 file
->path
= saved_path
;
1722 /* Get the path associated with the _cpp_file F. The path includes
1723 the base name from the include directive and the directory it was
1724 found in via the search path. */
1727 cpp_get_path (struct _cpp_file
*f
)
1732 /* Get the directory associated with the _cpp_file F. */
1735 cpp_get_dir (struct _cpp_file
*f
)
1740 /* Get the cpp_buffer currently associated with the cpp_reader
1744 cpp_get_buffer (cpp_reader
*pfile
)
1746 return pfile
->buffer
;
1749 /* Get the _cpp_file associated with the cpp_buffer B. */
1752 cpp_get_file (cpp_buffer
*b
)
1757 /* Get the previous cpp_buffer given a cpp_buffer B. The previous
1758 buffer is the buffer that included the given buffer. */
1761 cpp_get_prev (cpp_buffer
*b
)
1766 /* This data structure holds the list of header files that were seen
1767 while the PCH was being built. The 'entries' field is kept sorted
1768 in memcmp() order; yes, this means that on little-endian systems,
1769 it's sorted initially by the least-significant byte of 'size', but
1770 that's OK. The code does rely on having entries with the same size
1771 next to each other. */
1774 /* The size of this file. This is used to save running a MD5 checksum
1775 if the sizes don't match. */
1777 /* The MD5 checksum of this file. */
1778 unsigned char sum
[16];
1779 /* Is this file to be included only once? */
1784 /* Number of pchf_entry structures. */
1787 /* Are there any values with once_only set?
1788 This is used as an optimisation, it means we don't have to search
1789 the structure if we're processing a regular #include. */
1790 bool have_once_only
;
1792 struct pchf_entry entries
[1];
1795 static struct pchf_data
*pchf
;
1797 /* A qsort ordering function for pchf_entry structures. */
1800 pchf_save_compare (const void *e1
, const void *e2
)
1802 return memcmp (e1
, e2
, sizeof (struct pchf_entry
));
1805 /* Create and write to F a pchf_data structure. */
1808 _cpp_save_file_entries (cpp_reader
*pfile
, FILE *fp
)
1811 struct pchf_data
*result
;
1816 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
1819 result_size
= (sizeof (struct pchf_data
)
1820 + sizeof (struct pchf_entry
) * (count
- 1));
1821 result
= XCNEWVAR (struct pchf_data
, result_size
);
1824 result
->have_once_only
= false;
1826 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
1830 /* This should probably never happen, since if a read error occurred
1831 the PCH file shouldn't be written... */
1832 if (f
->dont_read
|| f
->err_no
)
1835 if (f
->stack_count
== 0)
1838 count
= result
->count
++;
1840 result
->entries
[count
].once_only
= f
->once_only
;
1841 /* |= is avoided in the next line because of an HP C compiler bug */
1842 result
->have_once_only
= result
->have_once_only
| f
->once_only
;
1843 if (f
->buffer_valid
)
1844 md5_buffer ((const char *)f
->buffer
,
1845 f
->st
.st_size
, result
->entries
[count
].sum
);
1853 open_file_failed (pfile
, f
, 0);
1857 ff
= fdopen (f
->fd
, "rb");
1858 md5_stream (ff
, result
->entries
[count
].sum
);
1862 result
->entries
[count
].size
= f
->st
.st_size
;
1865 result_size
= (sizeof (struct pchf_data
)
1866 + sizeof (struct pchf_entry
) * (result
->count
- 1));
1868 qsort (result
->entries
, result
->count
, sizeof (struct pchf_entry
),
1871 ret
= fwrite (result
, result_size
, 1, fp
) == 1;
1876 /* Read the pchf_data structure from F. */
1879 _cpp_read_file_entries (cpp_reader
*pfile ATTRIBUTE_UNUSED
, FILE *f
)
1883 if (fread (&d
, sizeof (struct pchf_data
) - sizeof (struct pchf_entry
), 1, f
)
1887 pchf
= XNEWVAR (struct pchf_data
, sizeof (struct pchf_data
)
1888 + sizeof (struct pchf_entry
) * (d
.count
- 1));
1889 memcpy (pchf
, &d
, sizeof (struct pchf_data
) - sizeof (struct pchf_entry
));
1890 if (fread (pchf
->entries
, sizeof (struct pchf_entry
), d
.count
, f
)
1896 /* The parameters for pchf_compare. */
1898 struct pchf_compare_data
1900 /* The size of the file we're looking for. */
1903 /* The MD5 checksum of the file, if it's been computed. */
1904 unsigned char sum
[16];
1909 /* Do we need to worry about entries that don't have ONCE_ONLY set? */
1910 bool check_included
;
1912 /* The file that we're searching for. */
1916 /* bsearch comparison function; look for D_P in E_P. */
1919 pchf_compare (const void *d_p
, const void *e_p
)
1921 const struct pchf_entry
*e
= (const struct pchf_entry
*)e_p
;
1922 struct pchf_compare_data
*d
= (struct pchf_compare_data
*)d_p
;
1925 result
= memcmp (&d
->size
, &e
->size
, sizeof (off_t
));
1929 if (! d
->sum_computed
)
1931 _cpp_file
*const f
= d
->f
;
1933 md5_buffer ((const char *)f
->buffer
, f
->st
.st_size
, d
->sum
);
1934 d
->sum_computed
= true;
1937 result
= memcmp (d
->sum
, e
->sum
, 16);
1941 if (d
->check_included
|| e
->once_only
)
1947 /* Check that F is not in a list read from a PCH file (if any).
1948 Assumes that f->buffer_valid is true. Return TRUE if the file
1949 should not be read. */
1952 check_file_against_entries (cpp_reader
*pfile ATTRIBUTE_UNUSED
,
1954 bool check_included
)
1956 struct pchf_compare_data d
;
1959 || (! check_included
&& ! pchf
->have_once_only
))
1962 d
.size
= f
->st
.st_size
;
1963 d
.sum_computed
= false;
1965 d
.check_included
= check_included
;
1966 return bsearch (&d
, pchf
->entries
, pchf
->count
, sizeof (struct pchf_entry
),
1967 pchf_compare
) != NULL
;
1970 /* Return true if the file FNAME is found in the appropriate include file path
1971 as indicated by ANGLE_BRACKETS. */
1974 _cpp_has_header (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
1975 enum include_type type
)
1977 cpp_dir
*start_dir
= search_path_head (pfile
, fname
, angle_brackets
, type
);
1978 _cpp_file
*file
= _cpp_find_file (pfile
, fname
, start_dir
,
1979 /*fake=*/false, angle_brackets
,
1980 /*implicit_preinclude=*/false);
1981 return file
->err_no
!= ENOENT
;