OSDN Git Service

d86811a7fbcf73744d614548fa4f4790f9ab5c02
[pf3gnuchains/gcc-fork.git] / gcc / lto-streamer.h
1 /* Data structures and declarations used for reading and writing
2    GIMPLE to a file stream.
3
4    Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5    Contributed by Doug Kwan <dougkwan@google.com>
6
7 This file is part of GCC.
8
9 GCC is free software; you can redistribute it and/or modify it under
10 the terms of the GNU General Public License as published by the Free
11 Software Foundation; either version 3, or (at your option) any later
12 version.
13
14 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
17 for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with GCC; see the file COPYING3.  If not see
21 <http://www.gnu.org/licenses/>.  */
22
23 #ifndef GCC_LTO_STREAMER_H
24 #define GCC_LTO_STREAMER_H
25
26 #include "plugin-api.h"
27 #include "tree.h"
28 #include "gimple.h"
29 #include "target.h"
30 #include "cgraph.h"
31 #include "vec.h"
32 #include "vecprim.h"
33 #include "alloc-pool.h"
34
35 /* Define when debugging the LTO streamer.  This causes the writer
36    to output the numeric value for the memory address of the tree node
37    being emitted.  When debugging a problem in the reader, check the
38    original address that the writer was emitting using lto_orig_address_get.
39    With this value, set a breakpoint in the writer (e.g., lto_output_tree)
40    to trace how the faulty node is being emitted.  */
41 /* #define LTO_STREAMER_DEBUG   1  */
42
43 /* The encoding for a function consists of the following sections:
44
45    1)    The header.
46    2)    FIELD_DECLS.
47    3)    FUNCTION_DECLS.
48    4)    global VAR_DECLS.
49    5)    type_decls
50    6)    types.
51    7)    Names for the labels that have names
52    8)    The SSA names.
53    9)    The control flow graph.
54    10-11)Gimple for local decls.
55    12)   Gimple for the function.
56    13)   Strings.
57
58    1) THE HEADER.
59    2-6) THE GLOBAL DECLS AND TYPES.
60
61       The global decls and types are encoded in the same way.  For each
62       entry, there is word with the offset within the section to the
63       entry.
64
65    7) THE LABEL NAMES.
66
67       Since most labels do not have names, this section my be of zero
68       length.  It consists of an array of string table references, one
69       per label.  In the lto code, the labels are given either
70       positive or negative indexes.  the positive ones have names and
71       the negative ones do not.  The positive index can be used to
72       find the name in this array.
73
74    9) THE CFG.
75
76    10) Index into the local decls.  Since local decls can have local
77       decls inside them, they must be read in randomly in order to
78       properly restore them.
79
80    11-12) GIMPLE FOR THE LOCAL DECLS AND THE FUNCTION BODY.
81
82      The gimple consists of a set of records.
83
84      THE FUNCTION
85
86      At the top level of (8) is the function. It consists of five
87      pieces:
88
89      LTO_function     - The tag.
90      eh tree          - This is all of the exception handling regions
91                         put out in a post order traversial of the
92                         tree.  Siblings are output as lists terminated
93                         by a 0.  The set of fields matches the fields
94                         defined in except.c.
95
96      last_basic_block - in uleb128 form.
97
98      basic blocks     - This is the set of basic blocks.
99
100      zero             - The termination of the basic blocks.
101
102      BASIC BLOCKS
103
104      There are two forms of basic blocks depending on if they are
105      empty or not.
106
107      The basic block consists of:
108
109      LTO_bb1 or LTO_bb0 - The tag.
110
111      bb->index          - the index in uleb128 form.
112
113      #succs             - The number of successors un uleb128 form.
114
115      the successors     - For each edge, a pair.  The first of the
116                           pair is the index of the successor in
117                           uleb128 form and the second are the flags in
118                           uleb128 form.
119
120      the statements     - A gimple tree, as described above.
121                           These are only present for LTO_BB1.
122                           Following each statement is an optional
123                           exception handling record LTO_eh_region
124                           which contains the region number (for
125                           regions >= 0).
126
127      zero               - This is only present for LTO_BB1 and is used
128                           to terminate the statements and exception
129                           regions within this block.
130
131    12) STRINGS
132
133      String are represented in the table as pairs, a length in ULEB128
134      form followed by the data for the string.  */
135
136 /* The string that is the prefix on the section names we make for lto.
137    For decls the DECL_ASSEMBLER_NAME is appended to make the section
138    name for the functions and static_initializers.  For other types of
139    sections a '.' and the section type are appended.  */
140 #define LTO_SECTION_NAME_PREFIX         ".gnu.lto_"
141
142 #define LTO_major_version 1
143 #define LTO_minor_version 0
144
145 typedef unsigned char   lto_decl_flags_t;
146
147
148 /* Data structures used to pack values and bitflags into a vector of
149    words.  Used to stream values of a fixed number of bits in a space
150    efficient way.  */
151 static unsigned const BITS_PER_BITPACK_WORD = HOST_BITS_PER_WIDE_INT;
152
153 typedef unsigned HOST_WIDE_INT bitpack_word_t;
154 DEF_VEC_I(bitpack_word_t);
155 DEF_VEC_ALLOC_I(bitpack_word_t, heap);
156
157 struct bitpack_d
158 {
159   /* Total number of bits packed/unpacked so far.  */
160   size_t num_bits;
161
162   /* Values are stored contiguously, so there may be internal
163      fragmentation (words with unused bits).  Therefore, we need to
164      keep track of the first available bit in the last word of the
165      bitpack.  */
166   size_t first_unused_bit;
167
168   /* Vector of words holding the packed values.  */
169   VEC(bitpack_word_t, heap) *values;
170 };
171
172 /* Tags representing the various IL objects written to the bytecode file
173    (GIMPLE statements, basic blocks, EH regions, tree nodes, etc).
174
175    NOTE, when adding new LTO tags, also update lto_tag_name.  */
176 enum LTO_tags
177 {
178   LTO_null = 0,
179
180   /* Reserve enough entries to fit all the tree and gimple codes handled
181      by the streamer.  This guarantees that:
182
183      1- Given a tree code C:
184                 enum LTO_tags tag == C + 1
185
186      2- Given a gimple code C:
187                 enum LTO_tags tag == C + NUM_TREE_CODES + 1
188
189      Conversely, to map between LTO tags and tree/gimple codes, the
190      reverse operation must be applied.  */
191   LTO_bb0 = 1 + NUM_TREE_CODES + LAST_AND_UNUSED_GIMPLE_CODE,
192   LTO_bb1,
193
194   /* EH region holding the previous statement.  */
195   LTO_eh_region,
196
197   /* An MD or NORMAL builtin.  Only the code and class are streamed out.  */
198   LTO_builtin_decl,
199
200   /* Function body.  */
201   LTO_function,
202
203   /* EH table.  */
204   LTO_eh_table,
205
206   /* EH region types.  These mirror enum eh_region_type.  */
207   LTO_ert_cleanup,
208   LTO_ert_try,
209   LTO_ert_allowed_exceptions,
210   LTO_ert_must_not_throw,
211
212   /* EH landing pad.  */
213   LTO_eh_landing_pad,
214
215   /* EH try/catch node.  */
216   LTO_eh_catch,
217
218   /* Special for global streamer. Reference to previously-streamed node.  */
219   LTO_tree_pickle_reference,
220
221   /* References to indexable tree nodes.  These objects are stored in
222      tables that are written separately from the function bodies that
223      reference them.  This way they can be instantiated even when the
224      referencing functions aren't (e.g., during WPA) and it also allows
225      functions to be copied from one file to another without having
226      to unpickle the body first (the references are location
227      independent).
228
229      NOTE, do not regroup these values as the grouping is exposed
230      in the range checks done in lto_input_tree.  */
231   LTO_field_decl_ref,                   /* Do not change.  */
232   LTO_function_decl_ref,
233   LTO_label_decl_ref,
234   LTO_namespace_decl_ref,
235   LTO_result_decl_ref,
236   LTO_ssa_name_ref,
237   LTO_type_decl_ref,
238   LTO_type_ref,
239   LTO_const_decl_ref,
240   LTO_imported_decl_ref,
241   LTO_global_decl_ref,                  /* Do not change.  */
242
243   /* This tag must always be last.  */
244   LTO_NUM_TAGS
245 };
246
247
248 /* Set of section types that are in an LTO file.  This list will grow
249    as the number of IPA passes grows since each IPA pass will need its
250    own section type to store its summary information.
251
252    When adding a new section type, you must also extend the
253    LTO_SECTION_NAME array in lto-section-in.c.  */
254 enum lto_section_type
255 {
256   LTO_section_decls = 0,
257   LTO_section_function_body,
258   LTO_section_static_initializer,
259   LTO_section_cgraph,
260   LTO_section_varpool,
261   LTO_section_refs,
262   LTO_section_jump_functions,
263   LTO_section_ipa_pure_const,
264   LTO_section_ipa_reference,
265   LTO_section_symtab,
266   LTO_section_opts,
267   LTO_N_SECTION_TYPES           /* Must be last.  */
268 };
269
270 /* Indices to the various function, type and symbol streams. */
271 typedef enum
272 {
273   LTO_DECL_STREAM_TYPE = 0,             /* Must be first. */
274   LTO_DECL_STREAM_FIELD_DECL,
275   LTO_DECL_STREAM_FN_DECL,
276   LTO_DECL_STREAM_VAR_DECL,
277   LTO_DECL_STREAM_TYPE_DECL,
278   LTO_DECL_STREAM_NAMESPACE_DECL,
279   LTO_DECL_STREAM_LABEL_DECL,
280   LTO_N_DECL_STREAMS
281 } lto_decl_stream_e_t;
282
283 typedef enum ld_plugin_symbol_resolution ld_plugin_symbol_resolution_t;
284 DEF_VEC_I(ld_plugin_symbol_resolution_t);
285 DEF_VEC_ALLOC_I(ld_plugin_symbol_resolution_t, heap);
286
287
288 /* Macro to define convenience functions for type and decl streams
289    in lto_file_decl_data.  */
290 #define DEFINE_DECL_STREAM_FUNCS(UPPER_NAME, name) \
291 static inline tree \
292 lto_file_decl_data_get_ ## name (struct lto_file_decl_data *data, \
293                                  unsigned int idx) \
294 { \
295   struct lto_in_decl_state *state = data->current_decl_state; \
296   gcc_assert (idx < state->streams[LTO_DECL_STREAM_## UPPER_NAME].size); \
297   return state->streams[LTO_DECL_STREAM_## UPPER_NAME].trees[idx]; \
298 } \
299 \
300 static inline unsigned int \
301 lto_file_decl_data_num_ ## name ## s (struct lto_file_decl_data *data) \
302 { \
303   struct lto_in_decl_state *state = data->current_decl_state; \
304   return state->streams[LTO_DECL_STREAM_## UPPER_NAME].size; \
305 }
306
307
308 /* Return a char pointer to the start of a data stream for an lto pass
309    or function.  The first parameter is the file data that contains
310    the information.  The second parameter is the type of information
311    to be obtained.  The third parameter is the name of the function
312    and is only used when finding a function body; otherwise it is
313    NULL.  The fourth parameter is the length of the data returned.  */
314 typedef const char* (lto_get_section_data_f) (struct lto_file_decl_data *,
315                                               enum lto_section_type,
316                                               const char *,
317                                               size_t *);
318
319 /* Return the data found from the above call.  The first three
320    parameters are the same as above.  The fourth parameter is the data
321    itself and the fifth is the lenght of the data. */
322 typedef void (lto_free_section_data_f) (struct lto_file_decl_data *,
323                                         enum lto_section_type,
324                                         const char *,
325                                         const char *,
326                                         size_t);
327
328 /* Cache of pickled nodes.  Used to avoid writing the same node more
329    than once.  The first time a tree node is streamed out, it is
330    entered in this cache.  Subsequent references to the same node are
331    resolved by looking it up in this cache.
332
333    This is used in two ways:
334
335    - On the writing side, the first time T is added to STREAMER_CACHE,
336      a new reference index is created for T and T is emitted on the
337      stream.  If T needs to be emitted again to the stream, instead of
338      pickling it again, the reference index is emitted.
339
340    - On the reading side, the first time T is read from the stream, it
341      is reconstructed in memory and a new reference index created for
342      T.  The reconstructed T is inserted in some array so that when
343      the reference index for T is found in the input stream, it can be
344      used to look up into the array to get the reconstructed T.  */
345 struct lto_streamer_cache_d
346 {
347   /* The mapping between tree nodes and slots into the nodes array.  */
348   htab_t node_map;
349
350   /* Node map to store entries into.  */
351   alloc_pool node_map_entries;
352
353   /* Next available slot in the nodes and offsets arrays.  */
354   unsigned next_slot;
355
356   /* The nodes pickled so far.  */
357   VEC(tree,heap) *nodes;
358
359   /* Offset into the stream where the nodes have been written.  */
360   VEC(unsigned,heap) *offsets;
361 };
362
363
364 /* Structure used as buffer for reading an LTO file.  */
365 struct lto_input_block
366 {
367   const char *data;
368   unsigned int p;
369   unsigned int len;
370 };
371
372 #define LTO_INIT_INPUT_BLOCK(BASE,D,P,L)   \
373   do {                                     \
374     BASE.data = D;                         \
375     BASE.p = P;                            \
376     BASE.len = L;                          \
377   } while (0)
378
379 #define LTO_INIT_INPUT_BLOCK_PTR(BASE,D,P,L) \
380   do {                                       \
381     BASE->data = D;                          \
382     BASE->p = P;                             \
383     BASE->len = L;                           \
384   } while (0)
385
386
387 /* The is the first part of the record for a function or constructor
388    in the .o file.  */
389 struct lto_header
390 {
391   int16_t major_version;
392   int16_t minor_version;
393   enum lto_section_type section_type;
394 };
395
396 /* The header for a function body.  */
397 struct lto_function_header
398 {
399   /* The header for all types of sections. */
400   struct lto_header lto_header;
401
402   /* Number of labels with names.  */
403   int32_t num_named_labels;
404
405   /* Number of labels without names.  */
406   int32_t num_unnamed_labels;
407
408   /* Size compressed or 0 if not compressed.  */
409   int32_t compressed_size;
410
411   /* Size of names for named labels.  */
412   int32_t named_label_size;
413
414   /* Size of the cfg.  */
415   int32_t cfg_size;
416
417   /* Size of main gimple body of function.  */
418   int32_t main_size;
419
420   /* Size of the string table.  */
421   int32_t string_size;
422 };
423
424
425 /* Structure describing a symbol section.  */
426 struct lto_decl_header
427 {
428   /* The header for all types of sections. */
429   struct lto_header lto_header;
430
431   /* Size of region for decl state. */
432   int32_t decl_state_size;
433
434   /* Number of nodes in globals stream.  */
435   int32_t num_nodes;
436
437   /* Size of region for expressions, decls, types, etc. */
438   int32_t main_size;
439
440   /* Size of the string table.  */
441   int32_t string_size;
442 };
443
444
445 /* Statistics gathered during LTO, WPA and LTRANS.  */
446 struct lto_stats_d
447 {
448   unsigned HOST_WIDE_INT num_input_cgraph_nodes;
449   unsigned HOST_WIDE_INT num_output_cgraph_nodes;
450   unsigned HOST_WIDE_INT num_input_files;
451   unsigned HOST_WIDE_INT num_output_files;
452   unsigned HOST_WIDE_INT num_cgraph_partitions;
453   unsigned HOST_WIDE_INT section_size[LTO_N_SECTION_TYPES];
454   unsigned HOST_WIDE_INT num_function_bodies;
455   unsigned HOST_WIDE_INT num_trees[NUM_TREE_CODES];
456   unsigned HOST_WIDE_INT num_output_il_bytes;
457   unsigned HOST_WIDE_INT num_compressed_il_bytes;
458   unsigned HOST_WIDE_INT num_input_il_bytes;
459   unsigned HOST_WIDE_INT num_uncompressed_il_bytes;
460 };
461
462 /* Encoder data structure used to stream callgraph nodes.  */
463 struct lto_cgraph_encoder_d
464 {
465   /* Map nodes to reference number. */
466   struct pointer_map_t *map;
467
468   /* Map reference number to node. */
469   VEC(cgraph_node_ptr,heap) *nodes;
470
471   /* Map of nodes where we want to output body.  */
472   struct pointer_set_t *body;
473 };
474
475 typedef struct lto_cgraph_encoder_d *lto_cgraph_encoder_t;
476
477 /* Return number of encoded nodes in ENCODER.  */
478
479 static inline int
480 lto_cgraph_encoder_size (lto_cgraph_encoder_t encoder)
481 {
482   return VEC_length (cgraph_node_ptr, encoder->nodes);
483 }
484
485
486 /* Encoder data structure used to stream callgraph nodes.  */
487 struct lto_varpool_encoder_d
488 {
489   /* Map nodes to reference number. */
490   struct pointer_map_t *map;
491
492   /* Map reference number to node. */
493   VEC(varpool_node_ptr,heap) *nodes;
494
495   /* Map of nodes where we want to output initializer.  */
496   struct pointer_set_t *initializer;
497 };
498 typedef struct lto_varpool_encoder_d *lto_varpool_encoder_t;
499
500 /* Mapping from indices to trees.  */
501 struct GTY(()) lto_tree_ref_table
502 {
503   /* Array of referenced trees . */
504   tree * GTY((length ("%h.size"))) trees;
505
506   /* Size of array. */
507   unsigned int size;
508 };
509
510
511 /* Mapping between trees and slots in an array.  */
512 struct lto_decl_slot
513 {
514   tree t;
515   int slot_num;
516 };
517
518
519 /* The lto_tree_ref_encoder struct is used to encode trees into indices. */
520
521 struct lto_tree_ref_encoder
522 {
523   htab_t tree_hash_table;       /* Maps pointers to indices. */
524   unsigned int next_index;      /* Next available index. */
525   VEC(tree,heap) *trees;        /* Maps indices to pointers. */
526 };
527
528
529 /* Structure to hold states of input scope.  */
530 struct GTY(()) lto_in_decl_state
531 {
532   /* Array of lto_in_decl_buffers to store type and decls streams. */
533   struct lto_tree_ref_table streams[LTO_N_DECL_STREAMS];
534
535   /* If this in-decl state is associated with a function. FN_DECL
536      point to the FUNCTION_DECL. */
537   tree fn_decl;
538 };
539
540 typedef struct lto_in_decl_state *lto_in_decl_state_ptr;
541
542
543 /* The structure that holds all of the vectors of global types,
544    decls and cgraph nodes used in the serialization of this file.  */
545 struct lto_out_decl_state
546 {
547   /* The buffers contain the sets of decls of various kinds and types we have
548      seen so far and the indexes assigned to them.  */
549   struct lto_tree_ref_encoder streams[LTO_N_DECL_STREAMS];
550
551   /* Encoder for cgraph nodes.  */
552   lto_cgraph_encoder_t cgraph_node_encoder;
553
554   /* Encoder for varpool nodes.  */
555   lto_varpool_encoder_t varpool_node_encoder;
556
557   /* If this out-decl state belongs to a function, fn_decl points to that
558      function.  Otherwise, it is NULL. */
559   tree fn_decl;
560 };
561
562 typedef struct lto_out_decl_state *lto_out_decl_state_ptr;
563
564 DEF_VEC_P(lto_out_decl_state_ptr);
565 DEF_VEC_ALLOC_P(lto_out_decl_state_ptr, heap);
566
567 /* One of these is allocated for each object file that being compiled
568    by lto.  This structure contains the tables that are needed by the
569    serialized functions and ipa passes to connect themselves to the
570    global types and decls as they are reconstituted.  */
571 struct GTY(()) lto_file_decl_data
572 {
573   /* Decl state currently used. */
574   struct lto_in_decl_state *current_decl_state;
575
576   /* Decl state corresponding to regions outside of any functions
577      in the compilation unit. */
578   struct lto_in_decl_state *global_decl_state;
579
580   /* Table of cgraph nodes present in this file.  */
581   lto_cgraph_encoder_t GTY((skip)) cgraph_node_encoder;
582
583   /* Table of varpool nodes present in this file.  */
584   lto_varpool_encoder_t GTY((skip)) varpool_node_encoder;
585
586   /* Hash table maps lto-related section names to location in file.  */
587   htab_t GTY((param_is (struct lto_in_decl_state))) function_decl_states;
588
589   /* The .o file that these offsets relate to.  */
590   const char *GTY((skip)) file_name;
591
592   /* Hash table maps lto-related section names to location in file.  */
593   htab_t GTY((skip)) section_hash_table;
594
595   /* Hash new name of renamed global declaration to its original name.  */
596   htab_t GTY((skip)) renaming_hash_table;
597 };
598
599 struct lto_char_ptr_base
600 {
601   char *ptr;
602 };
603
604 /* An incore byte stream to buffer the various parts of the function.
605    The entire structure should be zeroed when created.  The record
606    consists of a set of blocks.  The first sizeof (ptr) bytes are used
607    as a chain, and the rest store the bytes to be written.  */
608 struct lto_output_stream
609 {
610   /* The pointer to the first block in the stream.  */
611   struct lto_char_ptr_base * first_block;
612
613   /* The pointer to the last and current block in the stream.  */
614   struct lto_char_ptr_base * current_block;
615
616   /* The pointer to where the next char should be written.  */
617   char * current_pointer;
618
619   /* The number of characters left in the current block.  */
620   unsigned int left_in_block;
621
622   /* The block size of the last block allocated.  */
623   unsigned int block_size;
624
625   /* The total number of characters written.  */
626   unsigned int total_size;
627 };
628
629 /* The is the first part of the record in an LTO file for many of the
630    IPA passes.  */
631 struct lto_simple_header
632 {
633   /* The header for all types of sections. */
634   struct lto_header lto_header;
635
636   /* Size of main gimple body of function.  */
637   int32_t main_size;
638
639   /* Size of main stream when compressed.  */
640   int32_t compressed_size;
641 };
642
643 /* A simple output block.  This can be used for simple IPA passes that
644    do not need more than one stream.  */
645 struct lto_simple_output_block
646 {
647   enum lto_section_type section_type;
648   struct lto_out_decl_state *decl_state;
649
650   /* The stream that the main tree codes are written to.  */
651   struct lto_output_stream *main_stream;
652 };
653
654 /* Data structure holding all the data and descriptors used when writing
655    an LTO file.  */
656 struct output_block
657 {
658   enum lto_section_type section_type;
659   struct lto_out_decl_state *decl_state;
660
661   /* The stream that the main tree codes are written to.  */
662   struct lto_output_stream *main_stream;
663
664   /* The stream that contains the string table.  */
665   struct lto_output_stream *string_stream;
666
667   /* The stream that contains the cfg.  */
668   struct lto_output_stream *cfg_stream;
669
670   /* The hash table that contains the set of strings we have seen so
671      far and the indexes assigned to them.  */
672   htab_t string_hash_table;
673
674   /* The current cgraph_node that we are currently serializing.  Null
675      if we are serializing something else.  */
676   struct cgraph_node *cgraph_node;
677
678   /* These are the last file and line that were seen in the stream.
679      If the current node differs from these, it needs to insert
680      something into the stream and fix these up.  */
681   const char *current_file;
682   int current_line;
683   int current_col;
684
685   /* True if writing globals and types.  */
686   bool global;
687
688   /* Cache of nodes written in this section.  */
689   struct lto_streamer_cache_d *writer_cache;
690 };
691
692
693 /* Data and descriptors used when reading from an LTO file.  */
694 struct data_in
695 {
696   /* The global decls and types.  */
697   struct lto_file_decl_data *file_data;
698
699   /* All of the labels.  */
700   tree *labels;
701
702   /* The string table.  */
703   const char *strings;
704
705   /* The length of the string table.  */
706   unsigned int strings_len;
707
708   /* Number of named labels.  Used to find the index of unnamed labels
709      since they share space with the named labels.  */
710   unsigned int num_named_labels;
711
712   /* Number of unnamed labels.  */
713   unsigned int num_unnamed_labels;
714
715   const char *current_file;
716   int current_line;
717   int current_col;
718
719   /* Maps each reference number to the resolution done by the linker. */
720   VEC(ld_plugin_symbol_resolution_t,heap) *globals_resolution;
721
722   /* Cache of pickled nodes.  */
723   struct lto_streamer_cache_d *reader_cache;
724 };
725
726
727 /* In lto-section-in.c  */
728 extern struct lto_input_block * lto_create_simple_input_block (
729                                struct lto_file_decl_data *,
730                                enum lto_section_type, const char **, size_t *);
731 extern void
732 lto_destroy_simple_input_block (struct lto_file_decl_data *,
733                                 enum lto_section_type,
734                                 struct lto_input_block *, const char *, size_t);
735 extern void lto_set_in_hooks (struct lto_file_decl_data **,
736                               lto_get_section_data_f *,
737                               lto_free_section_data_f *);
738 extern struct lto_file_decl_data **lto_get_file_decl_data (void);
739 extern const char *lto_get_section_data (struct lto_file_decl_data *,
740                                          enum lto_section_type,
741                                          const char *, size_t *);
742 extern void lto_free_section_data (struct lto_file_decl_data *,
743                                    enum lto_section_type,
744                                    const char *, const char *, size_t);
745 extern unsigned char lto_input_1_unsigned (struct lto_input_block *);
746 extern unsigned HOST_WIDE_INT lto_input_uleb128 (struct lto_input_block *);
747 extern unsigned HOST_WIDEST_INT lto_input_widest_uint_uleb128 (
748                                                 struct lto_input_block *);
749 extern HOST_WIDE_INT lto_input_sleb128 (struct lto_input_block *);
750 extern htab_t lto_create_renaming_table (void);
751 extern void lto_record_renamed_decl (struct lto_file_decl_data *,
752                                      const char *, const char *);
753 extern const char *lto_get_decl_name_mapping (struct lto_file_decl_data *,
754                                               const char *);
755 extern struct lto_in_decl_state *lto_new_in_decl_state (void);
756 extern void lto_delete_in_decl_state (struct lto_in_decl_state *);
757 extern hashval_t lto_hash_in_decl_state (const void *);
758 extern int lto_eq_in_decl_state (const void *, const void *);
759 extern struct lto_in_decl_state *lto_get_function_in_decl_state (
760                                       struct lto_file_decl_data *, tree);
761
762 /* In lto-section-out.c  */
763 extern hashval_t lto_hash_decl_slot_node (const void *);
764 extern int lto_eq_decl_slot_node (const void *, const void *);
765 extern hashval_t lto_hash_type_slot_node (const void *);
766 extern int lto_eq_type_slot_node (const void *, const void *);
767 extern void lto_begin_section (const char *, bool);
768 extern void lto_end_section (void);
769 extern void lto_write_stream (struct lto_output_stream *);
770 extern void lto_output_1_stream (struct lto_output_stream *, char);
771 extern void lto_output_data_stream (struct lto_output_stream *, const void *,
772                                     size_t);
773 extern void lto_output_uleb128_stream (struct lto_output_stream *,
774                                        unsigned HOST_WIDE_INT);
775 extern void lto_output_widest_uint_uleb128_stream (struct lto_output_stream *,
776                                                    unsigned HOST_WIDEST_INT);
777 extern void lto_output_sleb128_stream (struct lto_output_stream *,
778                                        HOST_WIDE_INT);
779 extern bool lto_output_decl_index (struct lto_output_stream *,
780                             struct lto_tree_ref_encoder *,
781                             tree, unsigned int *);
782 extern void lto_output_field_decl_index (struct lto_out_decl_state *,
783                                   struct lto_output_stream *, tree);
784 extern void lto_output_fn_decl_index (struct lto_out_decl_state *,
785                                struct lto_output_stream *, tree);
786 extern void lto_output_namespace_decl_index (struct lto_out_decl_state *,
787                                       struct lto_output_stream *, tree);
788 extern void lto_output_var_decl_index (struct lto_out_decl_state *,
789                                 struct lto_output_stream *, tree);
790 extern void lto_output_type_decl_index (struct lto_out_decl_state *,
791                                  struct lto_output_stream *, tree);
792 extern void lto_output_type_ref_index (struct lto_out_decl_state *,
793                                 struct lto_output_stream *, tree);
794 extern struct lto_simple_output_block *lto_create_simple_output_block (
795                                 enum lto_section_type);
796 extern void lto_destroy_simple_output_block (struct lto_simple_output_block *);
797 extern struct lto_out_decl_state *lto_new_out_decl_state (void);
798 extern void lto_delete_out_decl_state (struct lto_out_decl_state *);
799 extern struct lto_out_decl_state *lto_get_out_decl_state (void);
800 extern void lto_push_out_decl_state (struct lto_out_decl_state *);
801 extern struct lto_out_decl_state *lto_pop_out_decl_state (void);
802 extern void lto_record_function_out_decl_state (tree,
803                                                 struct lto_out_decl_state *);
804
805
806 /* In lto-streamer.c.  */
807 extern const char *lto_tag_name (enum LTO_tags);
808 extern bitmap lto_bitmap_alloc (void);
809 extern void lto_bitmap_free (bitmap);
810 extern char *lto_get_section_name (int, const char *);
811 extern void print_lto_report (void);
812 extern struct bitpack_d *bitpack_create (void);
813 extern void bitpack_delete (struct bitpack_d *);
814 extern void bp_pack_value (struct bitpack_d *, bitpack_word_t, unsigned);
815 extern bitpack_word_t bp_unpack_value (struct bitpack_d *, unsigned);
816 extern bool lto_streamer_cache_insert (struct lto_streamer_cache_d *, tree,
817                                        int *, unsigned *);
818 extern bool lto_streamer_cache_insert_at (struct lto_streamer_cache_d *, tree,
819                                           int);
820 extern bool lto_streamer_cache_lookup (struct lto_streamer_cache_d *, tree,
821                                        int *);
822 extern tree lto_streamer_cache_get (struct lto_streamer_cache_d *, int);
823 extern struct lto_streamer_cache_d *lto_streamer_cache_create (void);
824 extern void lto_streamer_cache_delete (struct lto_streamer_cache_d *);
825 extern void lto_streamer_init (void);
826 extern bool gate_lto_out (void);
827 #ifdef LTO_STREAMER_DEBUG
828 extern void lto_orig_address_map (tree, intptr_t);
829 extern intptr_t lto_orig_address_get (tree);
830 extern void lto_orig_address_remove (tree);
831 #endif
832 extern void lto_check_version (int, int);
833
834
835 /* In lto-streamer-in.c */
836 extern void lto_input_cgraph (struct lto_file_decl_data *, const char *);
837 extern void lto_init_reader (void);
838 extern tree lto_input_tree (struct lto_input_block *, struct data_in *);
839 extern void lto_input_function_body (struct lto_file_decl_data *, tree,
840                                      const char *);
841 extern void lto_input_constructors_and_inits (struct lto_file_decl_data *,
842                                               const char *);
843 extern struct bitpack_d *lto_input_bitpack (struct lto_input_block *);
844 extern void lto_init_reader (void);
845 extern struct data_in *lto_data_in_create (struct lto_file_decl_data *,
846                                     const char *, unsigned,
847                                     VEC(ld_plugin_symbol_resolution_t,heap) *);
848 extern void lto_data_in_delete (struct data_in *);
849
850
851 /* In lto-streamer-out.c  */
852 extern void lto_register_decl_definition (tree, struct lto_file_decl_data *);
853 extern struct output_block *create_output_block (enum lto_section_type);
854 extern void destroy_output_block (struct output_block *);
855 extern void lto_output_tree (struct output_block *, tree, bool);
856 extern void lto_output_bitpack (struct lto_output_stream *, struct bitpack_d *);
857 extern void produce_asm (struct output_block *ob, tree fn);
858
859
860 /* In lto-cgraph.c  */
861 struct cgraph_node *lto_cgraph_encoder_deref (lto_cgraph_encoder_t, int);
862 int lto_cgraph_encoder_lookup (lto_cgraph_encoder_t, struct cgraph_node *);
863 lto_cgraph_encoder_t lto_cgraph_encoder_new (void);
864 int lto_cgraph_encoder_encode (lto_cgraph_encoder_t, struct cgraph_node *);
865 void lto_cgraph_encoder_delete (lto_cgraph_encoder_t);
866 bool lto_cgraph_encoder_encode_body_p (lto_cgraph_encoder_t,
867                                        struct cgraph_node *);
868
869 bool lto_varpool_encoder_encode_body_p (lto_varpool_encoder_t,
870                                         struct varpool_node *);
871 struct varpool_node *lto_varpool_encoder_deref (lto_varpool_encoder_t, int);
872 int lto_varpool_encoder_lookup (lto_varpool_encoder_t, struct varpool_node *);
873 lto_varpool_encoder_t lto_varpool_encoder_new (void);
874 int lto_varpool_encoder_encode (lto_varpool_encoder_t, struct varpool_node *);
875 void lto_varpool_encoder_delete (lto_varpool_encoder_t);
876 bool lto_varpool_encoder_encode_initializer_p (lto_varpool_encoder_t,
877                                                struct varpool_node *);
878 void output_cgraph (cgraph_node_set, varpool_node_set);
879 void input_cgraph (void);
880 bool referenced_from_other_partition_p (struct ipa_ref_list *,
881                                         cgraph_node_set,
882                                         varpool_node_set vset);
883 bool reachable_from_other_partition_p (struct cgraph_node *,
884                                        cgraph_node_set);
885 bool referenced_from_this_partition_p (struct ipa_ref_list *,
886                                         cgraph_node_set,
887                                         varpool_node_set vset);
888 bool reachable_from_this_partition_p (struct cgraph_node *,
889                                        cgraph_node_set);
890 void compute_ltrans_boundary (struct lto_out_decl_state *state,
891                               cgraph_node_set, varpool_node_set);
892
893
894 /* In lto-symtab.c.  */
895 extern void lto_symtab_register_decl (tree, ld_plugin_symbol_resolution_t,
896                                       struct lto_file_decl_data *);
897 extern void lto_symtab_merge_decls (void);
898 extern void lto_symtab_merge_cgraph_nodes (void);
899 extern tree lto_symtab_prevailing_decl (tree decl);
900 extern enum ld_plugin_symbol_resolution lto_symtab_get_resolution (tree decl);
901 extern void lto_symtab_free (void);
902
903
904 /* In lto-opts.c.  */
905 extern void lto_register_user_option (size_t, const char *, int, int);
906 extern void lto_read_file_options (struct lto_file_decl_data *);
907 extern void lto_write_options (void);
908 extern void lto_reissue_options (void);
909 void lto_clear_user_options (void);
910 void lto_clear_file_options (void);
911
912
913 /* In lto-wpa-fixup.c  */
914 void lto_mark_nothrow_fndecl (tree);
915 void lto_fixup_nothrow_decls (void);
916
917
918 /* Statistics gathered during LTO, WPA and LTRANS.  */
919 extern struct lto_stats_d lto_stats;
920
921 /* Section names corresponding to the values of enum lto_section_type.  */
922 extern const char *lto_section_name[];
923
924 /* Holds all the out decl states of functions output so far in the
925    current output file.  */
926 extern VEC(lto_out_decl_state_ptr, heap) *lto_function_decl_states;
927
928 /* Return true if LTO tag TAG corresponds to a tree code.  */
929 static inline bool
930 lto_tag_is_tree_code_p (enum LTO_tags tag)
931 {
932   return tag > LTO_null && (unsigned) tag <= NUM_TREE_CODES;
933 }
934
935
936 /* Return true if LTO tag TAG corresponds to a gimple code.  */
937 static inline bool
938 lto_tag_is_gimple_code_p (enum LTO_tags tag)
939 {
940   return (unsigned) tag >= NUM_TREE_CODES + 1
941          && (unsigned) tag < 1 + NUM_TREE_CODES + LAST_AND_UNUSED_GIMPLE_CODE;
942 }
943
944
945 /* Return the LTO tag corresponding to gimple code CODE.  See enum
946    LTO_tags for details on the conversion.  */
947 static inline enum LTO_tags
948 lto_gimple_code_to_tag (enum gimple_code code)
949 {
950   return (enum LTO_tags) ((unsigned) code + NUM_TREE_CODES + 1);
951 }
952
953
954 /* Return the GIMPLE code corresponding to TAG.  See enum LTO_tags for
955    details on the conversion.  */
956 static inline enum gimple_code
957 lto_tag_to_gimple_code (enum LTO_tags tag)
958 {
959   gcc_assert (lto_tag_is_gimple_code_p (tag));
960   return (enum gimple_code) ((unsigned) tag - NUM_TREE_CODES - 1);
961 }
962
963
964 /* Return the LTO tag corresponding to tree code CODE.  See enum
965    LTO_tags for details on the conversion.  */
966 static inline enum LTO_tags
967 lto_tree_code_to_tag (enum tree_code code)
968 {
969   return (enum LTO_tags) ((unsigned) code + 1);
970 }
971
972
973 /* Return the tree code corresponding to TAG.  See enum LTO_tags for
974    details on the conversion.  */
975 static inline enum tree_code
976 lto_tag_to_tree_code (enum LTO_tags tag)
977 {
978   gcc_assert (lto_tag_is_tree_code_p (tag));
979   return (enum tree_code) ((unsigned) tag - 1);
980 }
981
982 /* Initialize an lto_out_decl_buffer ENCODER.  */
983 static inline void
984 lto_init_tree_ref_encoder (struct lto_tree_ref_encoder *encoder,
985                            htab_hash hash_fn, htab_eq eq_fn)
986 {
987   encoder->tree_hash_table = htab_create (37, hash_fn, eq_fn, free);
988   encoder->next_index = 0;
989   encoder->trees = NULL;
990 }
991
992
993 /* Destory an lto_tree_ref_encoder ENCODER by freeing its contents.  The
994    memory used by ENCODER is not freed by this function.  */
995 static inline void
996 lto_destroy_tree_ref_encoder (struct lto_tree_ref_encoder *encoder)
997 {
998   /* Hash table may be delete already.  */
999   if (encoder->tree_hash_table)
1000     htab_delete (encoder->tree_hash_table);
1001   VEC_free (tree, heap, encoder->trees);
1002 }
1003
1004 /* Return the number of trees encoded in ENCODER. */
1005 static inline unsigned int
1006 lto_tree_ref_encoder_size (struct lto_tree_ref_encoder *encoder)
1007 {
1008   return VEC_length (tree, encoder->trees);
1009 }
1010
1011 /* Return the IDX-th tree in ENCODER. */
1012 static inline tree
1013 lto_tree_ref_encoder_get_tree (struct lto_tree_ref_encoder *encoder,
1014                                unsigned int idx)
1015 {
1016   return VEC_index (tree, encoder->trees, idx);
1017 }
1018
1019
1020 /* Return true if LABEL should be emitted in the global context.  */
1021 static inline bool
1022 emit_label_in_global_context_p (tree label)
1023 {
1024   return DECL_NONLOCAL (label) || FORCED_LABEL (label);
1025 }
1026
1027 /* Return true if tree node EXPR should be streamed as a builtin.  For
1028    these nodes, we just emit the class and function code.  */
1029 static inline bool
1030 lto_stream_as_builtin_p (tree expr)
1031 {
1032   return (TREE_CODE (expr) == FUNCTION_DECL
1033           && DECL_IS_BUILTIN (expr)
1034           && (DECL_BUILT_IN_CLASS (expr) == BUILT_IN_NORMAL
1035               || DECL_BUILT_IN_CLASS (expr) == BUILT_IN_MD));
1036 }
1037
1038 /* Return true if EXPR is a tree node that can be written to disk.  */
1039 static inline bool
1040 lto_is_streamable (tree expr)
1041 {
1042   enum tree_code code = TREE_CODE (expr);
1043
1044   /* Notice that we reject SSA_NAMEs as well.  We only emit the SSA
1045      name version in lto_output_tree_ref (see output_ssa_names).  */
1046   return !is_lang_specific (expr)
1047          && code != SSA_NAME
1048          && code != CALL_EXPR
1049          && code != LANG_TYPE
1050          && code != MODIFY_EXPR
1051          && code != INIT_EXPR
1052          && code != TARGET_EXPR
1053          && code != BIND_EXPR
1054          && code != WITH_CLEANUP_EXPR
1055          && code != STATEMENT_LIST
1056          && (code == CASE_LABEL_EXPR
1057              || code == DECL_EXPR
1058              || TREE_CODE_CLASS (code) != tcc_statement);
1059 }
1060
1061 DEFINE_DECL_STREAM_FUNCS (TYPE, type)
1062 DEFINE_DECL_STREAM_FUNCS (FIELD_DECL, field_decl)
1063 DEFINE_DECL_STREAM_FUNCS (FN_DECL, fn_decl)
1064 DEFINE_DECL_STREAM_FUNCS (VAR_DECL, var_decl)
1065 DEFINE_DECL_STREAM_FUNCS (TYPE_DECL, type_decl)
1066 DEFINE_DECL_STREAM_FUNCS (NAMESPACE_DECL, namespace_decl)
1067 DEFINE_DECL_STREAM_FUNCS (LABEL_DECL, label_decl)
1068
1069 #endif /* GCC_LTO_STREAMER_H  */