1 /* Part of CPP library. File handling.
2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 Free Software Foundation, Inc.
5 Written by Per Bothner, 1994.
6 Based on CCCP program by Paul Rubin, June 1986
7 Adapted to ANSI C, Richard Stallman, Jan 1987
8 Split out of cpplib.c, Zack Weinberg, Oct 1998
9 Reimplemented, Neil Booth, Jul 2003
11 This program is free software; you can redistribute it and/or modify it
12 under the terms of the GNU General Public License as published by the
13 Free Software Foundation; either version 2, or (at your option) any
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
35 /* Variable length record files on VMS will have a stat size that includes
36 record control characters that won't be included in the read size. */
38 # define FAB_C_VAR 2 /* variable length records (see Starlet fabdef.h) */
39 # define STAT_SIZE_RELIABLE(ST) ((ST).st_fab_rfm != FAB_C_VAR)
41 # define STAT_SIZE_RELIABLE(ST) true
46 /* For DJGPP redirected input is opened in text mode. */
47 # define set_stdin_to_binary_mode() \
48 if (! isatty (0)) setmode (0, O_BINARY)
50 # define set_stdin_to_binary_mode() /* Nothing */
53 /* This structure represents a file searched for by CPP, whether it
54 exists or not. An instance may be pointed to by more than one
55 file_hash_entry; at present no reference count is kept. */
58 /* Filename as given to #include or command line switch. */
61 /* The full path used to find the file. */
64 /* The full path of the pch file. */
67 /* The file's path with the basename stripped. NULL if it hasn't
68 been calculated yet. */
71 /* Chain through all files. */
72 struct _cpp_file
*next_file
;
74 /* The contents of NAME after calling read_file(). */
77 /* The macro, if any, preventing re-inclusion. */
78 const cpp_hashnode
*cmacro
;
80 /* The directory in the search path where FILE was found. Used for
81 #include_next and determining whether a header is a system
85 /* As filled in by stat(2) for the file. */
88 /* File descriptor. Invalid if -1, otherwise open. */
91 /* Zero if this file was successfully opened and stat()-ed,
92 otherwise errno obtained from failure. */
95 /* Number of times the file has been stacked for preprocessing. */
96 unsigned short stack_count
;
98 /* If opened with #import or contains #pragma once. */
101 /* If read() failed before. */
104 /* If this file is the main file. */
107 /* If BUFFER above contains the true contents of the file. */
110 /* File is a PCH (on return from find_include_file). */
114 /* A singly-linked list for all searches for a given file name, with
115 its head pointed to by a slot in FILE_HASH. The file name is what
116 appeared between the quotes in a #include directive; it can be
117 determined implicitly from the hash table location or explicitly
120 FILE is a structure containing details about the file that was
121 found with that search, or details of how the search failed.
123 START_DIR is the starting location of the search in the include
124 chain. The current directories for "" includes are also hashed in
125 the hash table and therefore unique. Files that are looked up
126 without using a search path, such as absolute filenames and file
127 names from the command line share a special starting directory so
128 they don't cause cache hits with normal include-chain lookups.
130 If START_DIR is NULL then the entry is for a directory, not a file,
131 and the directory is in DIR. Since the starting point in a file
132 lookup chain is never NULL, this means that simple pointer
133 comparisons against START_DIR can be made to determine cache hits
136 If a cache lookup fails because of e.g. an extra "./" in the path,
137 then nothing will break. It is just less efficient as CPP will
138 have to do more work re-preprocessing the file, and/or comparing
139 its contents against earlier once-only files.
141 struct file_hash_entry
143 struct file_hash_entry
*next
;
152 static bool open_file (_cpp_file
*file
);
153 static bool pch_open_file (cpp_reader
*pfile
, _cpp_file
*file
,
155 static bool find_file_in_dir (cpp_reader
*pfile
, _cpp_file
*file
,
157 static bool read_file_guts (cpp_reader
*pfile
, _cpp_file
*file
);
158 static bool read_file (cpp_reader
*pfile
, _cpp_file
*file
);
159 static bool should_stack_file (cpp_reader
*, _cpp_file
*file
, bool import
);
160 static struct cpp_dir
*search_path_head (cpp_reader
*, const char *fname
,
161 int angle_brackets
, enum include_type
);
162 static const char *dir_name_of_file (_cpp_file
*file
);
163 static void open_file_failed (cpp_reader
*pfile
, _cpp_file
*file
, int);
164 static struct file_hash_entry
*search_cache (struct file_hash_entry
*head
,
165 const cpp_dir
*start_dir
);
166 static _cpp_file
*make_cpp_file (cpp_reader
*, cpp_dir
*, const char *fname
);
167 static void destroy_cpp_file (_cpp_file
*);
168 static cpp_dir
*make_cpp_dir (cpp_reader
*, const char *dir_name
, int sysp
);
169 static void allocate_file_hash_entries (cpp_reader
*pfile
);
170 static struct file_hash_entry
*new_file_hash_entry (cpp_reader
*pfile
);
171 static int report_missing_guard (void **slot
, void *b
);
172 static hashval_t
file_hash_hash (const void *p
);
173 static int file_hash_eq (const void *p
, const void *q
);
174 static char *read_filename_string (int ch
, FILE *f
);
175 static void read_name_map (cpp_dir
*dir
);
176 static char *remap_filename (cpp_reader
*pfile
, _cpp_file
*file
);
177 static char *append_file_to_dir (const char *fname
, cpp_dir
*dir
);
178 static bool validate_pch (cpp_reader
*, _cpp_file
*file
, const char *pchname
);
179 static int pchf_save_compare (const void *e1
, const void *e2
);
180 static int pchf_compare (const void *d_p
, const void *e_p
);
181 static bool check_file_against_entries (cpp_reader
*, _cpp_file
*, bool);
183 /* Given a filename in FILE->PATH, with the empty string interpreted
186 On success FILE contains an open file descriptor and stat
187 information for the file. On failure the file descriptor is -1 and
188 the appropriate errno is also stored in FILE. Returns TRUE iff
191 We used to open files in nonblocking mode, but that caused more
192 problems than it solved. Do take care not to acquire a controlling
193 terminal by mistake (this can't happen on sane systems, but
194 paranoia is a virtue).
196 Use the three-argument form of open even though we aren't
197 specifying O_CREAT, to defend against broken system headers.
199 O_BINARY tells some runtime libraries (notably DJGPP) not to do
200 newline translation; we can handle DOS line breaks just fine
203 open_file (_cpp_file
*file
)
205 if (file
->path
[0] == '\0')
208 set_stdin_to_binary_mode ();
211 file
->fd
= open (file
->path
, O_RDONLY
| O_NOCTTY
| O_BINARY
, 0666);
215 if (fstat (file
->fd
, &file
->st
) == 0)
217 if (!S_ISDIR (file
->st
.st_mode
))
223 /* Ignore a directory and continue the search. The file we're
224 looking for may be elsewhere in the search path. */
231 #if defined(_WIN32) && !defined(__CYGWIN__)
232 else if (errno
== EACCES
)
234 /* On most UNIX systems, open succeeds on a directory. Above,
235 we check if we have opened a directory and if so, set errno
236 to ENOENT. However, on Windows, opening a directory
237 fails with EACCESS. We want to return ENOENT in that
239 if (stat (file
->path
, &file
->st
) == 0
240 && S_ISDIR (file
->st
.st_mode
))
244 else if (errno
== ENOTDIR
)
247 file
->err_no
= errno
;
252 /* Temporary PCH intercept of opening a file. Try to find a PCH file
253 based on FILE->name and FILE->dir, and test those found for
254 validity using PFILE->cb.valid_pch. Return true iff a valid file is
255 found. Set *INVALID_PCH if a PCH file is found but wasn't valid. */
258 pch_open_file (cpp_reader
*pfile
, _cpp_file
*file
, bool *invalid_pch
)
260 static const char extension
[] = ".gch";
261 const char *path
= file
->path
;
267 /* No PCH on <stdin> or if not requested. */
268 if (file
->name
[0] == '\0' || !pfile
->cb
.valid_pch
)
271 flen
= strlen (path
);
272 len
= flen
+ sizeof (extension
);
273 pchname
= XNEWVEC (char, len
);
274 memcpy (pchname
, path
, flen
);
275 memcpy (pchname
+ flen
, extension
, sizeof (extension
));
277 if (stat (pchname
, &st
) == 0)
281 size_t dlen
, plen
= len
;
283 if (!S_ISDIR (st
.st_mode
))
284 valid
= validate_pch (pfile
, file
, pchname
);
285 else if ((pchdir
= opendir (pchname
)) != NULL
)
287 pchname
[plen
- 1] = '/';
288 while ((d
= readdir (pchdir
)) != NULL
)
290 dlen
= strlen (d
->d_name
) + 1;
291 if ((strcmp (d
->d_name
, ".") == 0)
292 || (strcmp (d
->d_name
, "..") == 0))
294 if (dlen
+ plen
> len
)
297 pchname
= XRESIZEVEC (char, pchname
, len
);
299 memcpy (pchname
+ plen
, d
->d_name
, dlen
);
300 valid
= validate_pch (pfile
, file
, pchname
);
313 file
->pchname
= pchname
;
320 /* Try to open the path FILE->name appended to FILE->dir. This is
321 where remap and PCH intercept the file lookup process. Return true
322 if the file was found, whether or not the open was successful.
323 Set *INVALID_PCH to true if a PCH file is found but wasn't valid. */
326 find_file_in_dir (cpp_reader
*pfile
, _cpp_file
*file
, bool *invalid_pch
)
330 if (CPP_OPTION (pfile
, remap
) && (path
= remap_filename (pfile
, file
)))
333 if (file
->dir
->construct
)
334 path
= file
->dir
->construct (file
->name
, file
->dir
);
336 path
= append_file_to_dir (file
->name
, file
->dir
);
340 hashval_t hv
= htab_hash_string (path
);
344 if (htab_find_with_hash (pfile
->nonexistent_file_hash
, path
, hv
) != NULL
)
346 file
->err_no
= ENOENT
;
351 if (pch_open_file (pfile
, file
, invalid_pch
))
354 if (open_file (file
))
357 if (file
->err_no
!= ENOENT
)
359 open_file_failed (pfile
, file
, 0);
363 /* We copy the path name onto an obstack partly so that we don't
364 leak the memory, but mostly so that we don't fragment the
366 copy
= obstack_copy0 (&pfile
->nonexistent_file_ob
, path
,
369 pp
= htab_find_slot_with_hash (pfile
->nonexistent_file_hash
,
373 file
->path
= file
->name
;
377 file
->err_no
= ENOENT
;
384 /* Return tue iff the missing_header callback found the given HEADER. */
386 search_path_exhausted (cpp_reader
*pfile
, const char *header
, _cpp_file
*file
)
388 missing_header_cb func
= pfile
->cb
.missing_header
;
390 /* When the regular search path doesn't work, try context dependent
391 headers search paths. */
393 && file
->dir
== NULL
)
395 if ((file
->path
= func (pfile
, header
, &file
->dir
)) != NULL
)
397 if (open_file (file
))
399 free ((void *)file
->path
);
401 file
->path
= file
->name
;
408 _cpp_find_failed (_cpp_file
*file
)
410 return file
->err_no
!= 0;
413 /* Given a filename FNAME search for such a file in the include path
414 starting from START_DIR. If FNAME is the empty string it is
415 interpreted as STDIN if START_DIR is PFILE->no_search_path.
417 If the file is not found in the file cache fall back to the O/S and
418 add the result to our cache.
420 If the file was not found in the filesystem, or there was an error
421 opening it, then ERR_NO is nonzero and FD is -1. If the file was
422 found, then ERR_NO is zero and FD could be -1 or an open file
423 descriptor. FD can be -1 if the file was found in the cache and
424 had previously been closed. To open it again pass the return value
428 _cpp_find_file (cpp_reader
*pfile
, const char *fname
, cpp_dir
*start_dir
, bool fake
, int angle_brackets
)
430 struct file_hash_entry
*entry
, **hash_slot
;
432 bool invalid_pch
= false;
433 bool saw_bracket_include
= false;
434 bool saw_quote_include
= false;
435 struct cpp_dir
*found_in_cache
= NULL
;
437 /* Ensure we get no confusion between cached files and directories. */
438 if (start_dir
== NULL
)
439 cpp_error (pfile
, CPP_DL_ICE
, "NULL directory in find_file");
441 hash_slot
= (struct file_hash_entry
**)
442 htab_find_slot_with_hash (pfile
->file_hash
, fname
,
443 htab_hash_string (fname
),
446 /* First check the cache before we resort to memory allocation. */
447 entry
= search_cache (*hash_slot
, start_dir
);
449 return entry
->u
.file
;
451 file
= make_cpp_file (pfile
, start_dir
, fname
);
453 /* Try each path in the include chain. */
456 if (find_file_in_dir (pfile
, file
, &invalid_pch
))
459 file
->dir
= file
->dir
->next
;
460 if (file
->dir
== NULL
)
462 if (search_path_exhausted (pfile
, fname
, file
))
464 /* Although this file must not go in the cache, because
465 the file found might depend on things (like the current file)
466 that aren't represented in the cache, it still has to go in
467 the list of all files so that #import works. */
468 file
->next_file
= pfile
->all_files
;
469 pfile
->all_files
= file
;
473 open_file_failed (pfile
, file
, angle_brackets
);
476 cpp_error (pfile
, CPP_DL_ERROR
,
477 "one or more PCH files were found, but they were invalid");
478 if (!cpp_get_options (pfile
)->warn_invalid_pch
)
479 cpp_error (pfile
, CPP_DL_ERROR
,
480 "use -Winvalid-pch for more information");
485 /* Only check the cache for the starting location (done above)
486 and the quote and bracket chain heads because there are no
487 other possible starting points for searches. */
488 if (file
->dir
== pfile
->bracket_include
)
489 saw_bracket_include
= true;
490 else if (file
->dir
== pfile
->quote_include
)
491 saw_quote_include
= true;
495 entry
= search_cache (*hash_slot
, file
->dir
);
498 found_in_cache
= file
->dir
;
505 /* Cache for START_DIR too, sharing the _cpp_file structure. */
506 free ((char *) file
->name
);
508 file
= entry
->u
.file
;
512 /* This is a new file; put it in the list. */
513 file
->next_file
= pfile
->all_files
;
514 pfile
->all_files
= file
;
517 /* Store this new result in the hash table. */
518 entry
= new_file_hash_entry (pfile
);
519 entry
->next
= *hash_slot
;
520 entry
->start_dir
= start_dir
;
521 entry
->u
.file
= file
;
524 /* If we passed the quote or bracket chain heads, cache them also.
525 This speeds up processing if there are lots of -I options. */
526 if (saw_bracket_include
527 && pfile
->bracket_include
!= start_dir
528 && found_in_cache
!= pfile
->bracket_include
)
530 entry
= new_file_hash_entry (pfile
);
531 entry
->next
= *hash_slot
;
532 entry
->start_dir
= pfile
->bracket_include
;
533 entry
->u
.file
= file
;
536 if (saw_quote_include
537 && pfile
->quote_include
!= start_dir
538 && found_in_cache
!= pfile
->quote_include
)
540 entry
= new_file_hash_entry (pfile
);
541 entry
->next
= *hash_slot
;
542 entry
->start_dir
= pfile
->quote_include
;
543 entry
->u
.file
= file
;
550 /* Read a file into FILE->buffer, returning true on success.
552 If FILE->fd is something weird, like a block device, we don't want
553 to read it at all. Don't even try to figure out what something is,
554 except for plain files and block devices, since there is no
555 reliable portable way of doing this.
557 FIXME: Flush file cache and try again if we run out of memory. */
559 read_file_guts (cpp_reader
*pfile
, _cpp_file
*file
)
561 ssize_t size
, total
, count
;
565 if (S_ISBLK (file
->st
.st_mode
))
567 cpp_error (pfile
, CPP_DL_ERROR
, "%s is a block device", file
->path
);
571 regular
= S_ISREG (file
->st
.st_mode
);
574 /* off_t might have a wider range than ssize_t - in other words,
575 the max size of a file might be bigger than the address
576 space. We can't handle a file that large. (Anyone with
577 a single source file bigger than 2GB needs to rethink
578 their coding style.) Some systems (e.g. AIX 4.1) define
579 SSIZE_MAX to be much smaller than the actual range of the
580 type. Use INTTYPE_MAXIMUM unconditionally to ensure this
582 if (file
->st
.st_size
> INTTYPE_MAXIMUM (ssize_t
))
584 cpp_error (pfile
, CPP_DL_ERROR
, "%s is too large", file
->path
);
588 size
= file
->st
.st_size
;
591 /* 8 kilobytes is a sensible starting size. It ought to be bigger
592 than the kernel pipe buffer, and it's definitely bigger than
593 the majority of C source files. */
596 buf
= XNEWVEC (uchar
, size
+ 1);
598 while ((count
= read (file
->fd
, buf
+ total
, size
- total
)) > 0)
607 buf
= XRESIZEVEC (uchar
, buf
, size
+ 1);
613 cpp_errno (pfile
, CPP_DL_ERROR
, file
->path
);
617 if (regular
&& total
!= size
&& STAT_SIZE_RELIABLE (file
->st
))
618 cpp_error (pfile
, CPP_DL_WARNING
,
619 "%s is shorter than expected", file
->path
);
621 file
->buffer
= _cpp_convert_input (pfile
, CPP_OPTION (pfile
, input_charset
),
622 buf
, size
, total
, &file
->st
.st_size
);
623 file
->buffer_valid
= true;
628 /* Convenience wrapper around read_file_guts that opens the file if
629 necessary and closes the file descriptor after reading. FILE must
630 have been passed through find_file() at some stage. */
632 read_file (cpp_reader
*pfile
, _cpp_file
*file
)
634 /* If we already have its contents in memory, succeed immediately. */
635 if (file
->buffer_valid
)
638 /* If an earlier read failed for some reason don't try again. */
639 if (file
->dont_read
|| file
->err_no
)
642 if (file
->fd
== -1 && !open_file (file
))
644 open_file_failed (pfile
, file
, 0);
648 file
->dont_read
= !read_file_guts (pfile
, file
);
652 return !file
->dont_read
;
655 /* Returns TRUE if FILE's contents have been successfully placed in
656 FILE->buffer and the file should be stacked, otherwise false. */
658 should_stack_file (cpp_reader
*pfile
, _cpp_file
*file
, bool import
)
662 /* Skip once-only files. */
666 /* We must mark the file once-only if #import now, before header
667 guard checks. Otherwise, undefining the header guard might
668 cause the file to be re-stacked. */
671 _cpp_mark_file_once_only (pfile
, file
);
673 /* Don't stack files that have been stacked before. */
674 if (file
->stack_count
)
678 /* Skip if the file had a header guard and the macro is defined.
679 PCH relies on this appearing before the PCH handler below. */
680 if (file
->cmacro
&& file
->cmacro
->type
== NT_MACRO
)
683 /* Handle PCH files immediately; don't stack them. */
686 pfile
->cb
.read_pch (pfile
, file
->pchname
, file
->fd
, file
->path
);
692 if (!read_file (pfile
, file
))
695 /* Check the file against the PCH file. This is done before
696 checking against files we've already seen, since it may save on
698 if (check_file_against_entries (pfile
, file
, import
))
700 /* If this isn't a #import, but yet we can't include the file,
701 that means that it was #import-ed in the PCH file,
702 so we can never include it again. */
704 _cpp_mark_file_once_only (pfile
, file
);
708 /* Now we've read the file's contents, we can stack it if there
709 are no once-only files. */
710 if (!pfile
->seen_once_only
)
713 /* We may have read the file under a different name. Look
714 for likely candidates and compare file contents to be sure. */
715 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
720 if ((import
|| f
->once_only
)
722 && f
->st
.st_mtime
== file
->st
.st_mtime
723 && f
->st
.st_size
== file
->st
.st_size
)
726 bool same_file_p
= false;
728 if (f
->buffer
&& !f
->buffer_valid
)
730 /* We already have a buffer but it is not valid, because
731 the file is still stacked. Make a new one. */
732 ref_file
= make_cpp_file (pfile
, f
->dir
, f
->name
);
733 ref_file
->path
= f
->path
;
736 /* The file is not stacked anymore. We can reuse it. */
739 same_file_p
= read_file (pfile
, ref_file
)
740 /* Size might have changed in read_file(). */
741 && ref_file
->st
.st_size
== file
->st
.st_size
742 && !memcmp (ref_file
->buffer
,
746 if (f
->buffer
&& !f
->buffer_valid
)
749 destroy_cpp_file (ref_file
);
760 /* Place the file referenced by FILE into a new buffer on the buffer
761 stack if possible. IMPORT is true if this stacking attempt is
762 because of a #import directive. Returns true if a buffer is
765 _cpp_stack_file (cpp_reader
*pfile
, _cpp_file
*file
, bool import
)
770 if (!should_stack_file (pfile
, file
, import
))
773 if (pfile
->buffer
== NULL
|| file
->dir
== NULL
)
776 sysp
= MAX (pfile
->buffer
->sysp
, file
->dir
->sysp
);
778 /* Add the file to the dependencies on its first inclusion. */
779 if (CPP_OPTION (pfile
, deps
.style
) > !!sysp
&& !file
->stack_count
)
781 if (!file
->main_file
|| !CPP_OPTION (pfile
, deps
.ignore_main_file
))
782 deps_add_dep (pfile
->deps
, file
->path
);
785 /* Clear buffer_valid since _cpp_clean_line messes it up. */
786 file
->buffer_valid
= false;
789 /* Stack the buffer. */
790 buffer
= cpp_push_buffer (pfile
, file
->buffer
, file
->st
.st_size
,
791 CPP_OPTION (pfile
, preprocessed
));
795 /* Initialize controlling macro state. */
796 pfile
->mi_valid
= true;
797 pfile
->mi_cmacro
= 0;
799 /* Generate the call back. */
800 _cpp_do_file_change (pfile
, LC_ENTER
, file
->path
, 1, sysp
);
805 /* Mark FILE to be included once only. */
807 _cpp_mark_file_once_only (cpp_reader
*pfile
, _cpp_file
*file
)
809 pfile
->seen_once_only
= true;
810 file
->once_only
= true;
813 /* Return the directory from which searching for FNAME should start,
814 considering the directive TYPE and ANGLE_BRACKETS. If there is
815 nothing left in the path, returns NULL. */
816 static struct cpp_dir
*
817 search_path_head (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
818 enum include_type type
)
823 if (IS_ABSOLUTE_PATH (fname
))
824 return &pfile
->no_search_path
;
826 /* pfile->buffer is NULL when processing an -include command-line flag. */
827 file
= pfile
->buffer
== NULL
? pfile
->main_file
: pfile
->buffer
->file
;
829 /* For #include_next, skip in the search path past the dir in which
830 the current file was found, but if it was found via an absolute
831 path use the normal search logic. */
832 if (type
== IT_INCLUDE_NEXT
&& file
->dir
)
833 dir
= file
->dir
->next
;
834 else if (angle_brackets
)
835 dir
= pfile
->bracket_include
;
836 else if (type
== IT_CMDLINE
)
837 /* -include and -imacros use the #include "" chain with the
838 preprocessor's cwd prepended. */
839 return make_cpp_dir (pfile
, "./", false);
840 else if (pfile
->quote_ignores_source_dir
)
841 dir
= pfile
->quote_include
;
843 return make_cpp_dir (pfile
, dir_name_of_file (file
),
844 pfile
->buffer
? pfile
->buffer
->sysp
: 0);
847 cpp_error (pfile
, CPP_DL_ERROR
,
848 "no include path in which to search for %s", fname
);
853 /* Strip the basename from the file's path. It ends with a slash if
854 of nonzero length. Note that this procedure also works for
855 <stdin>, which is represented by the empty string. */
857 dir_name_of_file (_cpp_file
*file
)
861 size_t len
= lbasename (file
->path
) - file
->path
;
862 char *dir_name
= XNEWVEC (char, len
+ 1);
864 memcpy (dir_name
, file
->path
, len
);
865 dir_name
[len
] = '\0';
866 file
->dir_name
= dir_name
;
869 return file
->dir_name
;
872 /* Handles #include-family directives (distinguished by TYPE),
873 including HEADER, and the command line -imacros and -include.
874 Returns true if a buffer was stacked. */
876 _cpp_stack_include (cpp_reader
*pfile
, const char *fname
, int angle_brackets
,
877 enum include_type type
)
882 dir
= search_path_head (pfile
, fname
, angle_brackets
, type
);
886 file
= _cpp_find_file (pfile
, fname
, dir
, false, angle_brackets
);
888 /* Compensate for the increment in linemap_add. In the case of a
889 normal #include, we're currently at the start of the line
890 *following* the #include. A separate source_location for this
891 location makes no sense (until we do the LC_LEAVE), and
892 complicates LAST_SOURCE_LINE_LOCATION. This does not apply if we
893 found a PCH file (in which case linemap_add is not called) or we
894 were included from the command-line. */
895 if (! file
->pch
&& file
->err_no
== 0 && type
!= IT_CMDLINE
)
896 pfile
->line_table
->highest_location
--;
898 return _cpp_stack_file (pfile
, file
, type
== IT_IMPORT
);
901 /* Could not open FILE. The complication is dependency output. */
903 open_file_failed (cpp_reader
*pfile
, _cpp_file
*file
, int angle_brackets
)
905 int sysp
= pfile
->line_table
->highest_line
> 1 && pfile
->buffer
? pfile
->buffer
->sysp
: 0;
906 bool print_dep
= CPP_OPTION (pfile
, deps
.style
) > (angle_brackets
|| !!sysp
);
908 errno
= file
->err_no
;
909 if (print_dep
&& CPP_OPTION (pfile
, deps
.missing_files
) && errno
== ENOENT
)
910 deps_add_dep (pfile
->deps
, file
->name
);
913 /* If we are outputting dependencies but not for this file then
914 don't error because we can still produce correct output. */
915 if (CPP_OPTION (pfile
, deps
.style
) && ! print_dep
)
916 cpp_errno (pfile
, CPP_DL_WARNING
, file
->path
);
918 cpp_errno (pfile
, CPP_DL_ERROR
, file
->path
);
922 /* Search in the chain beginning at HEAD for a file whose search path
923 started at START_DIR != NULL. */
924 static struct file_hash_entry
*
925 search_cache (struct file_hash_entry
*head
, const cpp_dir
*start_dir
)
927 while (head
&& head
->start_dir
!= start_dir
)
933 /* Allocate a new _cpp_file structure. */
935 make_cpp_file (cpp_reader
*pfile
, cpp_dir
*dir
, const char *fname
)
939 file
= XCNEW (_cpp_file
);
940 file
->main_file
= !pfile
->buffer
;
943 file
->name
= xstrdup (fname
);
948 /* Release a _cpp_file structure. */
950 destroy_cpp_file (_cpp_file
*file
)
953 free ((void *) file
->buffer
);
954 free ((void *) file
->name
);
958 /* A hash of directory names. The directory names are the path names
959 of files which contain a #include "", the included file name is
960 appended to this directories.
962 To avoid duplicate entries we follow the convention that all
963 non-empty directory names should end in a '/'. DIR_NAME must be
964 stored in permanently allocated memory. */
966 make_cpp_dir (cpp_reader
*pfile
, const char *dir_name
, int sysp
)
968 struct file_hash_entry
*entry
, **hash_slot
;
971 hash_slot
= (struct file_hash_entry
**)
972 htab_find_slot_with_hash (pfile
->dir_hash
, dir_name
,
973 htab_hash_string (dir_name
),
976 /* Have we already hashed this directory? */
977 for (entry
= *hash_slot
; entry
; entry
= entry
->next
)
978 if (entry
->start_dir
== NULL
)
981 dir
= XCNEW (cpp_dir
);
982 dir
->next
= pfile
->quote_include
;
983 dir
->name
= (char *) dir_name
;
984 dir
->len
= strlen (dir_name
);
988 /* Store this new result in the hash table. */
989 entry
= new_file_hash_entry (pfile
);
990 entry
->next
= *hash_slot
;
991 entry
->start_dir
= NULL
;
998 /* Create a new block of memory for file hash entries. */
1000 allocate_file_hash_entries (cpp_reader
*pfile
)
1002 pfile
->file_hash_entries_used
= 0;
1003 pfile
->file_hash_entries_allocated
= 127;
1004 pfile
->file_hash_entries
= XNEWVEC (struct file_hash_entry
,
1005 pfile
->file_hash_entries_allocated
);
1008 /* Return a new file hash entry. */
1009 static struct file_hash_entry
*
1010 new_file_hash_entry (cpp_reader
*pfile
)
1012 if (pfile
->file_hash_entries_used
== pfile
->file_hash_entries_allocated
)
1013 allocate_file_hash_entries (pfile
);
1015 return &pfile
->file_hash_entries
[pfile
->file_hash_entries_used
++];
1018 /* Returns TRUE if a file FNAME has ever been successfully opened.
1019 This routine is not intended to correctly handle filenames aliased
1020 by links or redundant . or .. traversals etc. */
1022 cpp_included (cpp_reader
*pfile
, const char *fname
)
1024 struct file_hash_entry
*entry
;
1026 entry
= (struct file_hash_entry
*)
1027 htab_find_with_hash (pfile
->file_hash
, fname
, htab_hash_string (fname
));
1029 while (entry
&& (entry
->start_dir
== NULL
|| entry
->u
.file
->err_no
))
1030 entry
= entry
->next
;
1032 return entry
!= NULL
;
1035 /* Calculate the hash value of a file hash entry P. */
1038 file_hash_hash (const void *p
)
1040 struct file_hash_entry
*entry
= (struct file_hash_entry
*) p
;
1042 if (entry
->start_dir
)
1043 hname
= entry
->u
.file
->name
;
1045 hname
= entry
->u
.dir
->name
;
1047 return htab_hash_string (hname
);
1050 /* Compare a string Q against a file hash entry P. */
1052 file_hash_eq (const void *p
, const void *q
)
1054 struct file_hash_entry
*entry
= (struct file_hash_entry
*) p
;
1055 const char *fname
= (const char *) q
;
1058 if (entry
->start_dir
)
1059 hname
= entry
->u
.file
->name
;
1061 hname
= entry
->u
.dir
->name
;
1063 return strcmp (hname
, fname
) == 0;
1066 /* Compare entries in the nonexistent file hash table. These are just
1069 nonexistent_file_hash_eq (const void *p
, const void *q
)
1071 return strcmp (p
, q
) == 0;
1074 /* Initialize everything in this source file. */
1076 _cpp_init_files (cpp_reader
*pfile
)
1078 pfile
->file_hash
= htab_create_alloc (127, file_hash_hash
, file_hash_eq
,
1079 NULL
, xcalloc
, free
);
1080 pfile
->dir_hash
= htab_create_alloc (127, file_hash_hash
, file_hash_eq
,
1081 NULL
, xcalloc
, free
);
1082 allocate_file_hash_entries (pfile
);
1083 pfile
->nonexistent_file_hash
= htab_create_alloc (127, htab_hash_string
,
1084 nonexistent_file_hash_eq
,
1085 NULL
, xcalloc
, free
);
1086 _obstack_begin (&pfile
->nonexistent_file_ob
, 0, 0,
1087 (void *(*) (long)) xmalloc
,
1088 (void (*) (void *)) free
);
1091 /* Finalize everything in this source file. */
1093 _cpp_cleanup_files (cpp_reader
*pfile
)
1095 htab_delete (pfile
->file_hash
);
1096 htab_delete (pfile
->dir_hash
);
1097 htab_delete (pfile
->nonexistent_file_hash
);
1098 obstack_free (&pfile
->nonexistent_file_ob
, 0);
1101 /* Enter a file name in the hash for the sake of cpp_included. */
1103 _cpp_fake_include (cpp_reader
*pfile
, const char *fname
)
1105 _cpp_find_file (pfile
, fname
, pfile
->buffer
->file
->dir
, true, 0);
1108 /* Not everyone who wants to set system-header-ness on a buffer can
1109 see the details of a buffer. This is an exported interface because
1110 fix-header needs it. */
1112 cpp_make_system_header (cpp_reader
*pfile
, int syshdr
, int externc
)
1115 const struct line_maps
*line_table
= pfile
->line_table
;
1116 const struct line_map
*map
= &line_table
->maps
[line_table
->used
-1];
1118 /* 1 = system header, 2 = system header to be treated as C. */
1120 flags
= 1 + (externc
!= 0);
1121 pfile
->buffer
->sysp
= flags
;
1122 _cpp_do_file_change (pfile
, LC_RENAME
, map
->to_file
,
1123 SOURCE_LINE (map
, pfile
->line_table
->highest_line
), flags
);
1126 /* Allow the client to change the current file. Used by the front end
1127 to achieve pseudo-file names like <built-in>.
1128 If REASON is LC_LEAVE, then NEW_NAME must be NULL. */
1130 cpp_change_file (cpp_reader
*pfile
, enum lc_reason reason
,
1131 const char *new_name
)
1133 _cpp_do_file_change (pfile
, reason
, new_name
, 1, 0);
1136 /* Callback function for htab_traverse. */
1138 report_missing_guard (void **slot
, void *b
)
1140 struct file_hash_entry
*entry
= (struct file_hash_entry
*) *slot
;
1141 int *bannerp
= (int *) b
;
1143 /* Skip directories. */
1144 if (entry
->start_dir
!= NULL
)
1146 _cpp_file
*file
= entry
->u
.file
;
1148 /* We don't want MI guard advice for the main file. */
1149 if (file
->cmacro
== NULL
&& file
->stack_count
== 1 && !file
->main_file
)
1153 fputs (_("Multiple include guards may be useful for:\n"),
1158 fputs (entry
->u
.file
->path
, stderr
);
1159 putc ('\n', stderr
);
1166 /* Report on all files that might benefit from a multiple include guard.
1169 _cpp_report_missing_guards (cpp_reader
*pfile
)
1173 htab_traverse (pfile
->file_hash
, report_missing_guard
, &banner
);
1176 /* Locate HEADER, and determine whether it is newer than the current
1177 file. If it cannot be located or dated, return -1, if it is
1178 newer, return 1, otherwise 0. */
1180 _cpp_compare_file_date (cpp_reader
*pfile
, const char *fname
,
1184 struct cpp_dir
*dir
;
1186 dir
= search_path_head (pfile
, fname
, angle_brackets
, IT_INCLUDE
);
1190 file
= _cpp_find_file (pfile
, fname
, dir
, false, angle_brackets
);
1200 return file
->st
.st_mtime
> pfile
->buffer
->file
->st
.st_mtime
;
1203 /* Pushes the given file onto the buffer stack. Returns nonzero if
1206 cpp_push_include (cpp_reader
*pfile
, const char *fname
)
1208 return _cpp_stack_include (pfile
, fname
, false, IT_CMDLINE
);
1211 /* Do appropriate cleanup when a file INC's buffer is popped off the
1214 _cpp_pop_file_buffer (cpp_reader
*pfile
, _cpp_file
*file
)
1216 /* Record the inclusion-preventing macro, which could be NULL
1217 meaning no controlling macro. */
1218 if (pfile
->mi_valid
&& file
->cmacro
== NULL
)
1219 file
->cmacro
= pfile
->mi_cmacro
;
1221 /* Invalidate control macros in the #including file. */
1222 pfile
->mi_valid
= false;
1226 free ((void *) file
->buffer
);
1227 file
->buffer
= NULL
;
1228 file
->buffer_valid
= false;
1232 /* Inteface to file statistics record in _cpp_file structure. */
1234 _cpp_get_file_stat (_cpp_file
*file
)
1239 /* Set the include chain for "" to QUOTE, for <> to BRACKET. If
1240 QUOTE_IGNORES_SOURCE_DIR, then "" includes do not look in the
1241 directory of the including file.
1243 If BRACKET does not lie in the QUOTE chain, it is set to QUOTE. */
1245 cpp_set_include_chains (cpp_reader
*pfile
, cpp_dir
*quote
, cpp_dir
*bracket
,
1246 int quote_ignores_source_dir
)
1248 pfile
->quote_include
= quote
;
1249 pfile
->bracket_include
= quote
;
1250 pfile
->quote_ignores_source_dir
= quote_ignores_source_dir
;
1252 for (; quote
; quote
= quote
->next
)
1254 quote
->name_map
= NULL
;
1255 quote
->len
= strlen (quote
->name
);
1256 if (quote
== bracket
)
1257 pfile
->bracket_include
= bracket
;
1261 /* Append the file name to the directory to create the path, but don't
1262 turn / into // or // into ///; // may be a namespace escape. */
1264 append_file_to_dir (const char *fname
, cpp_dir
*dir
)
1270 flen
= strlen (fname
);
1271 path
= XNEWVEC (char, dlen
+ 1 + flen
+ 1);
1272 memcpy (path
, dir
->name
, dlen
);
1273 if (dlen
&& path
[dlen
- 1] != '/')
1275 memcpy (&path
[dlen
], fname
, flen
+ 1);
1280 /* Read a space delimited string of unlimited length from a stdio
1283 read_filename_string (int ch
, FILE *f
)
1289 set
= alloc
= XNEWVEC (char, len
+ 1);
1290 if (! is_space (ch
))
1293 while ((ch
= getc (f
)) != EOF
&& ! is_space (ch
))
1295 if (set
- alloc
== len
)
1298 alloc
= XRESIZEVEC (char, alloc
, len
+ 1);
1299 set
= alloc
+ len
/ 2;
1309 /* Read the file name map file for DIR. */
1311 read_name_map (cpp_dir
*dir
)
1313 static const char FILE_NAME_MAP_FILE
[] = "header.gcc";
1316 size_t len
, count
= 0, room
= 9;
1319 name
= (char *) alloca (len
+ sizeof (FILE_NAME_MAP_FILE
) + 1);
1320 memcpy (name
, dir
->name
, len
);
1321 if (len
&& name
[len
- 1] != '/')
1323 strcpy (name
+ len
, FILE_NAME_MAP_FILE
);
1324 f
= fopen (name
, "r");
1326 dir
->name_map
= XNEWVEC (const char *, room
);
1328 /* Silently return NULL if we cannot open. */
1333 while ((ch
= getc (f
)) != EOF
)
1340 if (count
+ 2 > room
)
1343 dir
->name_map
= XRESIZEVEC (const char *, dir
->name_map
, room
);
1346 dir
->name_map
[count
] = read_filename_string (ch
, f
);
1347 while ((ch
= getc (f
)) != EOF
&& is_hspace (ch
))
1350 to
= read_filename_string (ch
, f
);
1351 if (IS_ABSOLUTE_PATH (to
))
1352 dir
->name_map
[count
+ 1] = to
;
1355 dir
->name_map
[count
+ 1] = append_file_to_dir (to
, dir
);
1360 while ((ch
= getc (f
)) != '\n')
1368 /* Terminate the list of maps. */
1369 dir
->name_map
[count
] = NULL
;
1372 /* Remap a FILE's name based on the file_name_map, if any, for
1373 FILE->dir. If the file name has any directory separators,
1374 recursively check those directories too. */
1376 remap_filename (cpp_reader
*pfile
, _cpp_file
*file
)
1378 const char *fname
, *p
;
1389 read_name_map (dir
);
1391 for (index
= 0; dir
->name_map
[index
]; index
+= 2)
1392 if (!strcmp (dir
->name_map
[index
], fname
))
1393 return xstrdup (dir
->name_map
[index
+ 1]);
1395 p
= strchr (fname
, '/');
1396 if (!p
|| p
== fname
)
1399 len
= dir
->len
+ (p
- fname
+ 1);
1400 new_dir
= XNEWVEC (char, len
+ 1);
1401 memcpy (new_dir
, dir
->name
, dir
->len
);
1402 memcpy (new_dir
+ dir
->len
, fname
, p
- fname
+ 1);
1403 new_dir
[len
] = '\0';
1405 dir
= make_cpp_dir (pfile
, new_dir
, dir
->sysp
);
1410 /* Returns true if PCHNAME is a valid PCH file for FILE. */
1412 validate_pch (cpp_reader
*pfile
, _cpp_file
*file
, const char *pchname
)
1414 const char *saved_path
= file
->path
;
1417 file
->path
= pchname
;
1418 if (open_file (file
))
1420 valid
= 1 & pfile
->cb
.valid_pch (pfile
, pchname
, file
->fd
);
1428 if (CPP_OPTION (pfile
, print_include_names
))
1431 for (i
= 1; i
< pfile
->line_table
->depth
; i
++)
1433 fprintf (stderr
, "%c %s\n",
1434 valid
? '!' : 'x', pchname
);
1438 file
->path
= saved_path
;
1442 /* Get the path associated with the _cpp_file F. The path includes
1443 the base name from the include directive and the directory it was
1444 found in via the search path. */
1447 cpp_get_path (struct _cpp_file
*f
)
1452 /* Get the directory associated with the _cpp_file F. */
1455 cpp_get_dir (struct _cpp_file
*f
)
1460 /* Get the cpp_buffer currently associated with the cpp_reader
1464 cpp_get_buffer (cpp_reader
*pfile
)
1466 return pfile
->buffer
;
1469 /* Get the _cpp_file associated with the cpp_buffer B. */
1472 cpp_get_file (cpp_buffer
*b
)
1477 /* Get the previous cpp_buffer given a cpp_buffer B. The previous
1478 buffer is the buffer that included the given buffer. */
1481 cpp_get_prev (cpp_buffer
*b
)
1486 /* This data structure holds the list of header files that were seen
1487 while the PCH was being built. The 'entries' field is kept sorted
1488 in memcmp() order; yes, this means that on little-endian systems,
1489 it's sorted initially by the least-significant byte of 'size', but
1490 that's OK. The code does rely on having entries with the same size
1491 next to each other. */
1494 /* The size of this file. This is used to save running a MD5 checksum
1495 if the sizes don't match. */
1497 /* The MD5 checksum of this file. */
1498 unsigned char sum
[16];
1499 /* Is this file to be included only once? */
1504 /* Number of pchf_entry structures. */
1507 /* Are there any values with once_only set?
1508 This is used as an optimisation, it means we don't have to search
1509 the structure if we're processing a regular #include. */
1510 bool have_once_only
;
1512 struct pchf_entry entries
[1];
1515 static struct pchf_data
*pchf
;
1517 /* A qsort ordering function for pchf_entry structures. */
1520 pchf_save_compare (const void *e1
, const void *e2
)
1522 return memcmp (e1
, e2
, sizeof (struct pchf_entry
));
1525 /* Create and write to F a pchf_data structure. */
1528 _cpp_save_file_entries (cpp_reader
*pfile
, FILE *fp
)
1531 struct pchf_data
*result
;
1535 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
1538 result_size
= (sizeof (struct pchf_data
)
1539 + sizeof (struct pchf_entry
) * (count
- 1));
1540 result
= XCNEWVAR (struct pchf_data
, result_size
);
1543 result
->have_once_only
= false;
1545 for (f
= pfile
->all_files
; f
; f
= f
->next_file
)
1549 /* This should probably never happen, since if a read error occurred
1550 the PCH file shouldn't be written... */
1551 if (f
->dont_read
|| f
->err_no
)
1554 if (f
->stack_count
== 0)
1557 count
= result
->count
++;
1559 result
->entries
[count
].once_only
= f
->once_only
;
1560 /* |= is avoided in the next line because of an HP C compiler bug */
1561 result
->have_once_only
= result
->have_once_only
| f
->once_only
;
1562 if (f
->buffer_valid
)
1563 md5_buffer ((const char *)f
->buffer
,
1564 f
->st
.st_size
, result
->entries
[count
].sum
);
1572 open_file_failed (pfile
, f
, 0);
1575 ff
= fdopen (f
->fd
, "rb");
1576 md5_stream (ff
, result
->entries
[count
].sum
);
1580 result
->entries
[count
].size
= f
->st
.st_size
;
1583 result_size
= (sizeof (struct pchf_data
)
1584 + sizeof (struct pchf_entry
) * (result
->count
- 1));
1586 qsort (result
->entries
, result
->count
, sizeof (struct pchf_entry
),
1589 return fwrite (result
, result_size
, 1, fp
) == 1;
1592 /* Read the pchf_data structure from F. */
1595 _cpp_read_file_entries (cpp_reader
*pfile ATTRIBUTE_UNUSED
, FILE *f
)
1599 if (fread (&d
, sizeof (struct pchf_data
) - sizeof (struct pchf_entry
), 1, f
)
1603 pchf
= XNEWVAR (struct pchf_data
, sizeof (struct pchf_data
)
1604 + sizeof (struct pchf_entry
) * (d
.count
- 1));
1605 memcpy (pchf
, &d
, sizeof (struct pchf_data
) - sizeof (struct pchf_entry
));
1606 if (fread (pchf
->entries
, sizeof (struct pchf_entry
), d
.count
, f
)
1612 /* The parameters for pchf_compare. */
1614 struct pchf_compare_data
1616 /* The size of the file we're looking for. */
1619 /* The MD5 checksum of the file, if it's been computed. */
1620 unsigned char sum
[16];
1625 /* Do we need to worry about entries that don't have ONCE_ONLY set? */
1626 bool check_included
;
1628 /* The file that we're searching for. */
1632 /* bsearch comparison function; look for D_P in E_P. */
1635 pchf_compare (const void *d_p
, const void *e_p
)
1637 const struct pchf_entry
*e
= (const struct pchf_entry
*)e_p
;
1638 struct pchf_compare_data
*d
= (struct pchf_compare_data
*)d_p
;
1641 result
= memcmp (&d
->size
, &e
->size
, sizeof (off_t
));
1645 if (! d
->sum_computed
)
1647 _cpp_file
*const f
= d
->f
;
1649 md5_buffer ((const char *)f
->buffer
, f
->st
.st_size
, d
->sum
);
1650 d
->sum_computed
= true;
1653 result
= memcmp (d
->sum
, e
->sum
, 16);
1657 if (d
->check_included
|| e
->once_only
)
1663 /* Check that F is not in a list read from a PCH file (if any).
1664 Assumes that f->buffer_valid is true. Return TRUE if the file
1665 should not be read. */
1668 check_file_against_entries (cpp_reader
*pfile ATTRIBUTE_UNUSED
,
1670 bool check_included
)
1672 struct pchf_compare_data d
;
1675 || (! check_included
&& ! pchf
->have_once_only
))
1678 d
.size
= f
->st
.st_size
;
1679 d
.sum_computed
= false;
1681 d
.check_included
= check_included
;
1682 return bsearch (&d
, pchf
->entries
, pchf
->count
, sizeof (struct pchf_entry
),
1683 pchf_compare
) != NULL
;