1 /* Part of CPP library. (Precompiled header reading/writing.)
2 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005
3 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
26 static int write_macdef (cpp_reader
*, cpp_hashnode
*, void *);
27 static int save_idents (cpp_reader
*, cpp_hashnode
*, void *);
28 static hashval_t
hashmem (const void *, size_t);
29 static hashval_t
cpp_string_hash (const void *);
30 static int cpp_string_eq (const void *, const void *);
31 static int count_defs (cpp_reader
*, cpp_hashnode
*, void *);
32 static int comp_hashnodes (const void *, const void *);
33 static int collect_ht_nodes (cpp_reader
*, cpp_hashnode
*, void *);
34 static int write_defs (cpp_reader
*, cpp_hashnode
*, void *);
35 static int save_macros (cpp_reader
*, cpp_hashnode
*, void *);
37 /* This structure represents a macro definition on disk. */
38 struct macrodef_struct
40 unsigned int definition_length
;
41 unsigned short name_length
;
45 /* This is how we write out a macro definition.
46 Suitable for being called by cpp_forall_identifiers. */
49 write_macdef (cpp_reader
*pfile
, cpp_hashnode
*hn
, void *file_p
)
51 FILE *f
= (FILE *) file_p
;
55 if (! (hn
->flags
& NODE_POISONED
))
59 if ((hn
->flags
& NODE_BUILTIN
))
63 struct macrodef_struct s
;
64 const unsigned char *defn
;
66 s
.name_length
= NODE_LEN (hn
);
67 s
.flags
= hn
->flags
& NODE_POISONED
;
69 if (hn
->type
== NT_MACRO
)
71 defn
= cpp_macro_definition (pfile
, hn
);
72 s
.definition_length
= ustrlen (defn
);
76 defn
= NODE_NAME (hn
);
77 s
.definition_length
= s
.name_length
;
80 if (fwrite (&s
, sizeof (s
), 1, f
) != 1
81 || fwrite (defn
, 1, s
.definition_length
, f
) != s
.definition_length
)
83 cpp_errno (pfile
, CPP_DL_ERROR
,
84 "while writing precompiled header");
91 /* Not currently implemented. */
99 /* This structure records the names of the defined macros.
100 It's also used as a callback structure for size_initial_idents
103 struct cpp_savedstate
105 /* A hash table of the defined identifiers. */
107 /* The size of the definitions of those identifiers (the size of
110 /* Number of definitions */
112 /* Array of definitions. In cpp_write_pch_deps it is used for sorting. */
114 /* Space for the next definition. Definitions are null-terminated
116 unsigned char *definedstrs
;
119 /* Save this identifier into the state: put it in the hash table,
120 put the definition in 'definedstrs'. */
123 save_idents (cpp_reader
*pfile ATTRIBUTE_UNUSED
, cpp_hashnode
*hn
, void *ss_p
)
125 struct cpp_savedstate
*const ss
= (struct cpp_savedstate
*)ss_p
;
127 if (hn
->type
!= NT_VOID
)
129 struct cpp_string news
;
132 news
.len
= NODE_LEN (hn
);
133 news
.text
= NODE_NAME (hn
);
134 slot
= htab_find_slot (ss
->definedhash
, &news
, INSERT
);
137 struct cpp_string
*sp
;
140 sp
= XNEW (struct cpp_string
);
143 sp
->len
= NODE_LEN (hn
);
144 sp
->text
= text
= XNEWVEC (unsigned char, NODE_LEN (hn
));
145 memcpy (text
, NODE_NAME (hn
), NODE_LEN (hn
));
152 /* Hash some memory in a generic way. */
155 hashmem (const void *p_p
, size_t sz
)
157 const unsigned char *p
= (const unsigned char *)p_p
;
162 for (i
= 0; i
< sz
; i
++)
163 h
= h
* 67 - (*p
++ - 113);
167 /* Hash a cpp string for the hashtable machinery. */
170 cpp_string_hash (const void *a_p
)
172 const struct cpp_string
*a
= (const struct cpp_string
*) a_p
;
173 return hashmem (a
->text
, a
->len
);
176 /* Compare two cpp strings for the hashtable machinery. */
179 cpp_string_eq (const void *a_p
, const void *b_p
)
181 const struct cpp_string
*a
= (const struct cpp_string
*) a_p
;
182 const struct cpp_string
*b
= (const struct cpp_string
*) b_p
;
183 return (a
->len
== b
->len
184 && memcmp (a
->text
, b
->text
, a
->len
) == 0);
187 /* Save the current definitions of the cpp_reader for dependency
188 checking purposes. When writing a precompiled header, this should
189 be called at the same point in the compilation as cpp_valid_state
190 would be called when reading the precompiled header back in. */
193 cpp_save_state (cpp_reader
*r
, FILE *f
)
195 /* Save the list of non-void identifiers for the dependency checking. */
196 r
->savedstate
= XNEW (struct cpp_savedstate
);
197 r
->savedstate
->definedhash
= htab_create (100, cpp_string_hash
,
198 cpp_string_eq
, NULL
);
199 cpp_forall_identifiers (r
, save_idents
, r
->savedstate
);
201 /* Write out the list of defined identifiers. */
202 cpp_forall_identifiers (r
, write_macdef
, f
);
207 /* Calculate the 'hashsize' field of the saved state. */
210 count_defs (cpp_reader
*pfile ATTRIBUTE_UNUSED
, cpp_hashnode
*hn
, void *ss_p
)
212 struct cpp_savedstate
*const ss
= (struct cpp_savedstate
*)ss_p
;
217 if (hn
->flags
& NODE_BUILTIN
)
220 /* else fall through. */
224 struct cpp_string news
;
227 news
.len
= NODE_LEN (hn
);
228 news
.text
= NODE_NAME (hn
);
229 slot
= (void **) htab_find (ss
->definedhash
, &news
);
232 ss
->hashsize
+= NODE_LEN (hn
) + 1;
239 /* Not currently implemented. */
247 /* Collect the identifiers into the state's string table. */
249 write_defs (cpp_reader
*pfile ATTRIBUTE_UNUSED
, cpp_hashnode
*hn
, void *ss_p
)
251 struct cpp_savedstate
*const ss
= (struct cpp_savedstate
*)ss_p
;
256 if (hn
->flags
& NODE_BUILTIN
)
259 /* else fall through. */
263 struct cpp_string news
;
266 news
.len
= NODE_LEN (hn
);
267 news
.text
= NODE_NAME (hn
);
268 slot
= (void **) htab_find (ss
->definedhash
, &news
);
271 ss
->defs
[ss
->n_defs
] = hn
;
278 /* Not currently implemented. */
286 /* Comparison function for qsort. The arguments point to pointers of
287 type ht_hashnode *. */
289 comp_hashnodes (const void *px
, const void *py
)
291 cpp_hashnode
*x
= *(cpp_hashnode
**) px
;
292 cpp_hashnode
*y
= *(cpp_hashnode
**) py
;
293 return ustrcmp (NODE_NAME (x
), NODE_NAME (y
));
296 /* Write out the remainder of the dependency information. This should be
297 called after the PCH is ready to be saved. */
300 cpp_write_pch_deps (cpp_reader
*r
, FILE *f
)
302 struct macrodef_struct z
;
303 struct cpp_savedstate
*const ss
= r
->savedstate
;
304 unsigned char *definedstrs
;
307 /* Collect the list of identifiers which have been seen and
308 weren't defined to anything previously. */
311 cpp_forall_identifiers (r
, count_defs
, ss
);
313 ss
->defs
= XNEWVEC (cpp_hashnode
*, ss
->n_defs
);
315 cpp_forall_identifiers (r
, write_defs
, ss
);
317 /* Sort the list, copy it into a buffer, and write it out. */
318 qsort (ss
->defs
, ss
->n_defs
, sizeof (cpp_hashnode
*), &comp_hashnodes
);
319 definedstrs
= ss
->definedstrs
= XNEWVEC (unsigned char, ss
->hashsize
);
320 for (i
= 0; i
< ss
->n_defs
; ++i
)
322 size_t len
= NODE_LEN (ss
->defs
[i
]);
323 memcpy (definedstrs
, NODE_NAME (ss
->defs
[i
]), len
+ 1);
324 definedstrs
+= len
+ 1;
327 memset (&z
, 0, sizeof (z
));
328 z
.definition_length
= ss
->hashsize
;
329 if (fwrite (&z
, sizeof (z
), 1, f
) != 1
330 || fwrite (ss
->definedstrs
, ss
->hashsize
, 1, f
) != 1)
332 cpp_errno (r
, CPP_DL_ERROR
, "while writing precompiled header");
335 free (ss
->definedstrs
);
337 /* Free the saved state. */
339 r
->savedstate
= NULL
;
341 /* Save the next value of __COUNTER__. */
342 if (fwrite (&r
->counter
, sizeof (r
->counter
), 1, f
) != 1)
344 cpp_errno (r
, CPP_DL_ERROR
, "while writing precompiled header");
351 /* Write out the definitions of the preprocessor, in a form suitable for
355 cpp_write_pch_state (cpp_reader
*r
, FILE *f
)
358 r
->deps
= deps_init ();
360 if (deps_save (r
->deps
, f
) != 0)
362 cpp_errno (r
, CPP_DL_ERROR
, "while writing precompiled header");
366 if (! _cpp_save_file_entries (r
, f
))
368 cpp_errno (r
, CPP_DL_ERROR
, "while writing precompiled header");
372 /* Save the next __COUNTER__ value. When we include a precompiled header,
373 we need to start at the offset we would have if the header had been
374 included normally. */
375 if (fwrite (&r
->counter
, sizeof (r
->counter
), 1, f
) != 1)
377 cpp_errno (r
, CPP_DL_ERROR
, "while writing precompiled header");
385 /* Data structure to transform hash table nodes into a sorted list */
391 /* Number of nodes in the array */
393 /* Size of the allocated array */
397 /* Callback for collecting identifiers from hash table */
400 collect_ht_nodes (cpp_reader
*pfile ATTRIBUTE_UNUSED
, cpp_hashnode
*hn
,
403 struct ht_node_list
*const nl
= (struct ht_node_list
*)nl_p
;
405 if (hn
->type
!= NT_VOID
|| hn
->flags
& NODE_POISONED
)
407 if (nl
->n_defs
== nl
->asize
)
410 nl
->defs
= XRESIZEVEC (cpp_hashnode
*, nl
->defs
, nl
->asize
);
413 nl
->defs
[nl
->n_defs
] = hn
;
420 /* Return nonzero if FD is a precompiled header which is consistent
421 with the preprocessor's current definitions. It will be consistent
424 - anything that was defined just before the PCH was generated
425 is defined the same way now; and
426 - anything that was not defined then, but is defined now, was not
429 NAME is used to print warnings if `warn_invalid_pch' is set in the
434 cpp_valid_state (cpp_reader
*r
, const char *name
, int fd
)
436 struct macrodef_struct m
;
437 size_t namebufsz
= 256;
438 unsigned char *namebuf
= XNEWVEC (unsigned char, namebufsz
);
439 unsigned char *undeftab
= NULL
;
440 struct ht_node_list nl
= { 0, 0, 0 };
441 unsigned char *first
, *last
;
443 unsigned int counter
;
445 /* Read in the list of identifiers that must be defined
446 Check that they are defined in the same way. */
450 const unsigned char *newdefn
;
452 if (read (fd
, &m
, sizeof (m
)) != sizeof (m
))
455 if (m
.name_length
== 0)
458 /* If this file is already preprocessed, there won't be any
459 macros defined, and that's OK. */
460 if (CPP_OPTION (r
, preprocessed
))
462 if (lseek (fd
, m
.definition_length
, SEEK_CUR
) == -1)
467 if (m
.definition_length
> namebufsz
)
470 namebufsz
= m
.definition_length
+ 256;
471 namebuf
= XNEWVEC (unsigned char, namebufsz
);
474 if ((size_t)read (fd
, namebuf
, m
.definition_length
)
475 != m
.definition_length
)
478 h
= cpp_lookup (r
, namebuf
, m
.name_length
);
479 if (m
.flags
& NODE_POISONED
480 || h
->type
!= NT_MACRO
481 || h
->flags
& NODE_POISONED
)
483 if (CPP_OPTION (r
, warn_invalid_pch
))
484 cpp_error (r
, CPP_DL_WARNING_SYSHDR
,
485 "%s: not used because `%.*s' not defined",
486 name
, m
.name_length
, namebuf
);
490 newdefn
= cpp_macro_definition (r
, h
);
492 if (m
.definition_length
!= ustrlen (newdefn
)
493 || memcmp (namebuf
, newdefn
, m
.definition_length
) != 0)
495 if (CPP_OPTION (r
, warn_invalid_pch
))
496 cpp_error (r
, CPP_DL_WARNING_SYSHDR
,
497 "%s: not used because `%.*s' defined as `%s' not `%.*s'",
498 name
, m
.name_length
, namebuf
, newdefn
+ m
.name_length
,
499 m
.definition_length
- m
.name_length
,
500 namebuf
+ m
.name_length
);
507 /* Read in the list of identifiers that must not be defined.
508 Check that they really aren't. */
509 undeftab
= XNEWVEC (unsigned char, m
.definition_length
);
510 if ((size_t) read (fd
, undeftab
, m
.definition_length
) != m
.definition_length
)
513 /* Collect identifiers from the current hash table. */
516 nl
.defs
= XNEWVEC (cpp_hashnode
*, nl
.asize
);
517 cpp_forall_identifiers (r
, &collect_ht_nodes
, &nl
);
518 qsort (nl
.defs
, nl
.n_defs
, sizeof (cpp_hashnode
*), &comp_hashnodes
);
520 /* Loop through nl.defs and undeftab, both of which are sorted lists.
521 There should be no matches. */
523 last
= undeftab
+ m
.definition_length
;
526 while (first
< last
&& i
< nl
.n_defs
)
528 int cmp
= ustrcmp (first
, NODE_NAME (nl
.defs
[i
]));
531 first
+= ustrlen (first
) + 1;
536 if (CPP_OPTION (r
, warn_invalid_pch
))
537 cpp_error (r
, CPP_DL_WARNING_SYSHDR
,
538 "%s: not used because `%s' is defined",
549 /* Read in the next value of __COUNTER__.
550 Check that (a) __COUNTER__ was not used in the pch or (b) __COUNTER__
551 has not been used in this translation unit. */
552 if (read (fd
, &counter
, sizeof (counter
)) != sizeof (counter
))
554 if (counter
&& r
->counter
)
556 if (CPP_OPTION (r
, warn_invalid_pch
))
557 cpp_error (r
, CPP_DL_WARNING_SYSHDR
,
558 "%s: not used because `__COUNTER__' is invalid",
567 cpp_errno (r
, CPP_DL_ERROR
, "while reading precompiled header");
573 if (undeftab
!= NULL
)
580 /* Save all the existing macros. */
582 struct save_macro_data
587 char **saved_pragmas
;
590 /* Save the definition of a single macro, so that it will persist
591 across a PCH restore. Because macro data is in GCed memory, which
592 will be blown away by PCH, it must be temporarily copied to
593 malloced memory. (The macros will refer to identifier nodes which
594 are also GCed and so on, so the copying is done by turning them
595 into self-contained strings.) The assumption is that most macro
596 definitions will come from the PCH file, not from the compilation
597 before the PCH file is loaded, so it doesn't matter that this is
600 It would reduce the cost even further if macros defined in the PCH
601 file were not saved in this way, but this is not done (yet), except
602 for builtins, and for #assert by default. */
605 save_macros (cpp_reader
*r
, cpp_hashnode
*h
, void *data_p
)
607 struct save_macro_data
*data
= (struct save_macro_data
*)data_p
;
608 if (h
->type
!= NT_VOID
609 && (h
->flags
& NODE_BUILTIN
) == 0)
611 if (data
->count
== data
->array_size
)
613 data
->array_size
*= 2;
614 data
->defns
= XRESIZEVEC (uchar
*, data
->defns
, (data
->array_size
));
620 /* Not currently implemented. */
625 const uchar
* defn
= cpp_macro_definition (r
, h
);
626 size_t defnlen
= ustrlen (defn
);
628 data
->defns
[data
->count
] = (uchar
*) xmemdup (defn
, defnlen
,
630 data
->defns
[data
->count
][defnlen
] = '\n';
642 /* Prepare to restore the state, by saving the currently-defined
646 cpp_prepare_state (cpp_reader
*r
, struct save_macro_data
**data
)
648 struct save_macro_data
*d
= XNEW (struct save_macro_data
);
651 d
->defns
= XNEWVEC (uchar
*, d
->array_size
);
653 cpp_forall_identifiers (r
, save_macros
, d
);
654 d
->saved_pragmas
= _cpp_save_pragma_names (r
);
658 /* Given a precompiled header that was previously determined to be valid,
659 apply all its definitions (and undefinitions) to the current state.
660 DEPNAME is passed to deps_restore. */
663 cpp_read_state (cpp_reader
*r
, const char *name
, FILE *f
,
664 struct save_macro_data
*data
)
667 struct lexer_state old_state
;
668 unsigned int counter
;
670 /* Restore spec_nodes, which will be full of references to the old
671 hashtable entries and so will now be invalid. */
673 struct spec_nodes
*s
= &r
->spec_nodes
;
674 s
->n_defined
= cpp_lookup (r
, DSC("defined"));
675 s
->n_true
= cpp_lookup (r
, DSC("true"));
676 s
->n_false
= cpp_lookup (r
, DSC("false"));
677 s
->n__VA_ARGS__
= cpp_lookup (r
, DSC("__VA_ARGS__"));
680 old_state
= r
->state
;
681 r
->state
.in_directive
= 1;
682 r
->state
.prevent_expansion
= 1;
683 r
->state
.angled_headers
= 0;
685 /* Run through the carefully-saved macros, insert them. */
686 for (i
= 0; i
< data
->count
; i
++)
692 namelen
= ustrcspn (data
->defns
[i
], "( \n");
693 h
= cpp_lookup (r
, data
->defns
[i
], namelen
);
694 defn
= data
->defns
[i
] + namelen
;
696 /* The PCH file is valid, so we know that if there is a definition
697 from the PCH file it must be the same as the one we had
698 originally, and so do not need to restore it. */
699 if (h
->type
== NT_VOID
)
701 if (cpp_push_buffer (r
, defn
, ustrchr (defn
, '\n') - defn
, true)
705 if (!_cpp_create_definition (r
, h
))
713 free (data
->defns
[i
]);
715 r
->state
= old_state
;
717 _cpp_restore_pragma_names (r
, data
->saved_pragmas
);
721 if (deps_restore (r
->deps
, f
, CPP_OPTION (r
, restore_pch_deps
) ? name
: NULL
)
725 if (! _cpp_read_file_entries (r
, f
))
728 if (fread (&counter
, sizeof (counter
), 1, f
) != 1)
732 r
->counter
= counter
;
737 cpp_errno (r
, CPP_DL_ERROR
, "while reading precompiled header");