Daily bump.
[official-gcc.git] / gcc / lto-streamer.h
blobd5873f7dabf014d85f361ba6636a17b181973c4b
1 /* Data structures and declarations used for reading and writing
2 GIMPLE to a file stream.
4 Copyright (C) 2009-2018 Free Software Foundation, Inc.
5 Contributed by Doug Kwan <dougkwan@google.com>
7 This file is part of GCC.
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.
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.
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/>. */
23 #ifndef GCC_LTO_STREAMER_H
24 #define GCC_LTO_STREAMER_H
26 #include "plugin-api.h"
27 #include "gcov-io.h"
28 #include "diagnostic.h"
30 /* The encoding for a function consists of the following sections:
32 1) The header.
33 2) FIELD_DECLS.
34 3) FUNCTION_DECLS.
35 4) global VAR_DECLS.
36 5) type_decls
37 6) types.
38 7) Names for the labels that have names
39 8) The SSA names.
40 9) The control flow graph.
41 10-11)Gimple for local decls.
42 12) Gimple for the function.
43 13) Strings.
45 1) THE HEADER.
46 2-6) THE GLOBAL DECLS AND TYPES.
48 The global decls and types are encoded in the same way. For each
49 entry, there is word with the offset within the section to the
50 entry.
52 7) THE LABEL NAMES.
54 Since most labels do not have names, this section my be of zero
55 length. It consists of an array of string table references, one
56 per label. In the lto code, the labels are given either
57 positive or negative indexes. the positive ones have names and
58 the negative ones do not. The positive index can be used to
59 find the name in this array.
61 9) THE CFG.
63 10) Index into the local decls. Since local decls can have local
64 decls inside them, they must be read in randomly in order to
65 properly restore them.
67 11-12) GIMPLE FOR THE LOCAL DECLS AND THE FUNCTION BODY.
69 The gimple consists of a set of records.
71 THE FUNCTION
73 At the top level of (8) is the function. It consists of five
74 pieces:
76 LTO_function - The tag.
77 eh tree - This is all of the exception handling regions
78 put out in a post order traversial of the
79 tree. Siblings are output as lists terminated
80 by a 0. The set of fields matches the fields
81 defined in except.c.
83 last_basic_block - in uleb128 form.
85 basic blocks - This is the set of basic blocks.
87 zero - The termination of the basic blocks.
89 BASIC BLOCKS
91 There are two forms of basic blocks depending on if they are
92 empty or not.
94 The basic block consists of:
96 LTO_bb1 or LTO_bb0 - The tag.
98 bb->index - the index in uleb128 form.
100 #succs - The number of successors un uleb128 form.
102 the successors - For each edge, a pair. The first of the
103 pair is the index of the successor in
104 uleb128 form and the second are the flags in
105 uleb128 form.
107 the statements - A gimple tree, as described above.
108 These are only present for LTO_BB1.
109 Following each statement is an optional
110 exception handling record LTO_eh_region
111 which contains the region number (for
112 regions >= 0).
114 zero - This is only present for LTO_BB1 and is used
115 to terminate the statements and exception
116 regions within this block.
118 12) STRINGS
120 String are represented in the table as pairs, a length in ULEB128
121 form followed by the data for the string. */
123 #define LTO_major_version 7
124 #define LTO_minor_version 0
126 typedef unsigned char lto_decl_flags_t;
129 /* Tags representing the various IL objects written to the bytecode file
130 (GIMPLE statements, basic blocks, EH regions, tree nodes, etc).
132 NOTE, when adding new LTO tags, also update lto_tag_name. */
133 enum LTO_tags
135 LTO_null = 0,
137 /* Special for streamer. Reference to previously-streamed node. */
138 LTO_tree_pickle_reference,
140 /* Reserve enough entries to fit all the tree and gimple codes handled
141 by the streamer. This guarantees that:
143 1- Given a tree code C:
144 enum LTO_tags tag == C + 1
146 2- Given a gimple code C:
147 enum LTO_tags tag == C + NUM_TREE_CODES + 1
149 Conversely, to map between LTO tags and tree/gimple codes, the
150 reverse operation must be applied. */
151 LTO_bb0 = 1 + MAX_TREE_CODES + LAST_AND_UNUSED_GIMPLE_CODE,
152 LTO_bb1,
154 /* EH region holding the previous statement. */
155 LTO_eh_region,
157 /* Shared INTEGER_CST node. */
158 LTO_integer_cst,
160 /* Function body. */
161 LTO_function,
163 /* EH table. */
164 LTO_eh_table,
166 /* EH region types. These mirror enum eh_region_type. */
167 LTO_ert_cleanup,
168 LTO_ert_try,
169 LTO_ert_allowed_exceptions,
170 LTO_ert_must_not_throw,
172 /* EH landing pad. */
173 LTO_eh_landing_pad,
175 /* EH try/catch node. */
176 LTO_eh_catch,
178 /* Special for global streamer. A blob of unnamed tree nodes. */
179 LTO_tree_scc,
181 /* References to indexable tree nodes. These objects are stored in
182 tables that are written separately from the function bodies that
183 reference them. This way they can be instantiated even when the
184 referencing functions aren't (e.g., during WPA) and it also allows
185 functions to be copied from one file to another without having
186 to unpickle the body first (the references are location
187 independent).
189 NOTE, do not regroup these values as the grouping is exposed
190 in the range checks done in lto_input_tree. */
191 LTO_field_decl_ref, /* Do not change. */
192 LTO_function_decl_ref,
193 LTO_label_decl_ref,
194 LTO_namespace_decl_ref,
195 LTO_result_decl_ref,
196 LTO_ssa_name_ref,
197 LTO_type_decl_ref,
198 LTO_type_ref,
199 LTO_const_decl_ref,
200 LTO_imported_decl_ref,
201 LTO_translation_unit_decl_ref,
202 LTO_global_decl_ref,
203 LTO_namelist_decl_ref, /* Do not change. */
205 /* This tag must always be last. */
206 LTO_NUM_TAGS
210 /* Set of section types that are in an LTO file. This list will grow
211 as the number of IPA passes grows since each IPA pass will need its
212 own section type to store its summary information.
214 When adding a new section type, you must also extend the
215 LTO_SECTION_NAME array in lto-section-in.c. */
216 enum lto_section_type
218 LTO_section_decls = 0,
219 LTO_section_function_body,
220 LTO_section_static_initializer,
221 LTO_section_symtab,
222 LTO_section_refs,
223 LTO_section_asm,
224 LTO_section_jump_functions,
225 LTO_section_ipa_pure_const,
226 LTO_section_ipa_reference,
227 LTO_section_ipa_profile,
228 LTO_section_symtab_nodes,
229 LTO_section_opts,
230 LTO_section_cgraph_opt_sum,
231 LTO_section_ipa_fn_summary,
232 LTO_section_ipcp_transform,
233 LTO_section_ipa_icf,
234 LTO_section_offload_table,
235 LTO_section_mode_table,
236 LTO_section_ipa_hsa,
237 LTO_N_SECTION_TYPES /* Must be last. */
240 /* Indices to the various function, type and symbol streams. */
241 enum lto_decl_stream_e_t
243 LTO_DECL_STREAM_TYPE = 0, /* Must be first. */
244 LTO_DECL_STREAM_FIELD_DECL,
245 LTO_DECL_STREAM_FN_DECL,
246 LTO_DECL_STREAM_VAR_DECL,
247 LTO_DECL_STREAM_TYPE_DECL,
248 LTO_DECL_STREAM_NAMESPACE_DECL,
249 LTO_DECL_STREAM_LABEL_DECL,
250 LTO_N_DECL_STREAMS
253 typedef enum ld_plugin_symbol_resolution ld_plugin_symbol_resolution_t;
256 /* Macro to define convenience functions for type and decl streams
257 in lto_file_decl_data. */
258 #define DEFINE_DECL_STREAM_FUNCS(UPPER_NAME, name) \
259 static inline tree \
260 lto_file_decl_data_get_ ## name (struct lto_file_decl_data *data, \
261 unsigned int idx) \
263 struct lto_in_decl_state *state = data->current_decl_state; \
264 return (*state->streams[LTO_DECL_STREAM_## UPPER_NAME])[idx]; \
267 static inline unsigned int \
268 lto_file_decl_data_num_ ## name ## s (struct lto_file_decl_data *data) \
270 struct lto_in_decl_state *state = data->current_decl_state; \
271 return vec_safe_length (state->streams[LTO_DECL_STREAM_## UPPER_NAME]); \
275 /* Return a char pointer to the start of a data stream for an lto pass
276 or function. The first parameter is the file data that contains
277 the information. The second parameter is the type of information
278 to be obtained. The third parameter is the name of the function
279 and is only used when finding a function body; otherwise it is
280 NULL. The fourth parameter is the length of the data returned. */
281 typedef const char* (lto_get_section_data_f) (struct lto_file_decl_data *,
282 enum lto_section_type,
283 const char *,
284 size_t *);
286 /* Return the data found from the above call. The first three
287 parameters are the same as above. The fourth parameter is the data
288 itself and the fifth is the length of the data. */
289 typedef void (lto_free_section_data_f) (struct lto_file_decl_data *,
290 enum lto_section_type,
291 const char *,
292 const char *,
293 size_t);
295 /* The location cache holds expanded locations for streamed in trees.
296 This is done to reduce memory usage of libcpp linemap that strongly preffers
297 locations to be inserted in the soruce order. */
299 class lto_location_cache
301 public:
302 /* Apply all changes in location cache. Add locations into linemap and patch
303 trees. */
304 bool apply_location_cache ();
305 /* Tree merging did not suceed; mark all changes in the cache as accepted. */
306 void accept_location_cache ();
307 /* Tree merging did suceed; throw away recent changes. */
308 void revert_location_cache ();
309 void input_location (location_t *loc, struct bitpack_d *bp,
310 struct data_in *data_in);
311 lto_location_cache ()
312 : loc_cache (), accepted_length (0), current_file (NULL), current_line (0),
313 current_col (0), current_sysp (false), current_loc (UNKNOWN_LOCATION)
315 gcc_assert (!current_cache);
316 current_cache = this;
318 ~lto_location_cache ()
320 apply_location_cache ();
321 gcc_assert (current_cache == this);
322 current_cache = NULL;
325 /* There can be at most one instance of location cache (combining multiple
326 would bring it out of sync with libcpp linemap); point to current
327 one. */
328 static lto_location_cache *current_cache;
330 private:
331 static int cmp_loc (const void *pa, const void *pb);
333 struct cached_location
335 const char *file;
336 location_t *loc;
337 int line, col;
338 bool sysp;
341 /* The location cache. */
343 auto_vec<cached_location> loc_cache;
345 /* Accepted entries are ones used by trees that are known to be not unified
346 by tree merging. */
348 int accepted_length;
350 /* Bookkeeping to remember state in between calls to lto_apply_location_cache
351 When streaming gimple, the location cache is not used and thus
352 lto_apply_location_cache happens per location basis. It is then
353 useful to avoid redundant calls of linemap API. */
355 const char *current_file;
356 int current_line;
357 int current_col;
358 bool current_sysp;
359 location_t current_loc;
362 /* Structure used as buffer for reading an LTO file. */
363 class lto_input_block
365 public:
366 /* Special constructor for the string table, it abuses this to
367 do random access but use the uhwi decoder. */
368 lto_input_block (const char *data_, unsigned int p_, unsigned int len_,
369 const unsigned char *mode_table_)
370 : data (data_), mode_table (mode_table_), p (p_), len (len_) {}
371 lto_input_block (const char *data_, unsigned int len_,
372 const unsigned char *mode_table_)
373 : data (data_), mode_table (mode_table_), p (0), len (len_) {}
375 const char *data;
376 const unsigned char *mode_table;
377 unsigned int p;
378 unsigned int len;
382 /* The is the first part of the record for a function or constructor
383 in the .o file. */
384 struct lto_header
386 int16_t major_version;
387 int16_t minor_version;
390 /* The is the first part of the record in an LTO file for many of the
391 IPA passes. */
392 struct lto_simple_header : lto_header
394 /* Size of main gimple body of function. */
395 int32_t main_size;
398 struct lto_simple_header_with_strings : lto_simple_header
400 /* Size of the string table. */
401 int32_t string_size;
404 /* The header for a function body. */
405 struct lto_function_header : lto_simple_header_with_strings
407 /* Size of the cfg. */
408 int32_t cfg_size;
412 /* Structure describing a symbol section. */
413 struct lto_decl_header : lto_simple_header_with_strings
415 /* Size of region for decl state. */
416 int32_t decl_state_size;
418 /* Number of nodes in globals stream. */
419 int32_t num_nodes;
423 /* Statistics gathered during LTO, WPA and LTRANS. */
424 struct lto_stats_d
426 unsigned HOST_WIDE_INT num_input_cgraph_nodes;
427 unsigned HOST_WIDE_INT num_output_symtab_nodes;
428 unsigned HOST_WIDE_INT num_input_files;
429 unsigned HOST_WIDE_INT num_output_files;
430 unsigned HOST_WIDE_INT num_cgraph_partitions;
431 unsigned HOST_WIDE_INT section_size[LTO_N_SECTION_TYPES];
432 unsigned HOST_WIDE_INT num_function_bodies;
433 unsigned HOST_WIDE_INT num_trees[NUM_TREE_CODES];
434 unsigned HOST_WIDE_INT num_output_il_bytes;
435 unsigned HOST_WIDE_INT num_compressed_il_bytes;
436 unsigned HOST_WIDE_INT num_input_il_bytes;
437 unsigned HOST_WIDE_INT num_uncompressed_il_bytes;
438 unsigned HOST_WIDE_INT num_tree_bodies_output;
439 unsigned HOST_WIDE_INT num_pickle_refs_output;
442 /* Entry of LTO symtab encoder. */
443 struct lto_encoder_entry
445 symtab_node *node;
446 /* Is the node in this partition (i.e. ltrans of this partition will
447 be responsible for outputting it)? */
448 unsigned int in_partition:1;
449 /* Do we encode body in this partition? */
450 unsigned int body:1;
451 /* Do we encode initializer in this partition?
452 For example the readonly variable initializers are encoded to aid
453 constant folding even if they are not in the partition. */
454 unsigned int initializer:1;
458 /* Encoder data structure used to stream callgraph nodes. */
459 struct lto_symtab_encoder_d
461 vec<lto_encoder_entry> nodes;
462 hash_map<symtab_node *, size_t> *map;
465 typedef struct lto_symtab_encoder_d *lto_symtab_encoder_t;
467 /* Iterator structure for cgraph node sets. */
468 struct lto_symtab_encoder_iterator
470 lto_symtab_encoder_t encoder;
471 unsigned index;
476 /* The lto_tree_ref_encoder struct is used to encode trees into indices. */
478 struct lto_tree_ref_encoder
480 hash_map<tree, unsigned> *tree_hash_table; /* Maps pointers to indices. */
481 vec<tree> trees; /* Maps indices to pointers. */
485 /* Structure to hold states of input scope. */
486 struct GTY((for_user)) lto_in_decl_state
488 /* Array of lto_in_decl_buffers to store type and decls streams. */
489 vec<tree, va_gc> *streams[LTO_N_DECL_STREAMS];
491 /* If this in-decl state is associated with a function. FN_DECL
492 point to the FUNCTION_DECL. */
493 tree fn_decl;
495 /* True if decl state is compressed. */
496 bool compressed;
499 typedef struct lto_in_decl_state *lto_in_decl_state_ptr;
501 struct decl_state_hasher : ggc_ptr_hash<lto_in_decl_state>
503 static hashval_t
504 hash (lto_in_decl_state *s)
506 return htab_hash_pointer (s->fn_decl);
509 static bool
510 equal (lto_in_decl_state *a, lto_in_decl_state *b)
512 return a->fn_decl == b->fn_decl;
516 /* The structure that holds all of the vectors of global types,
517 decls and cgraph nodes used in the serialization of this file. */
518 struct lto_out_decl_state
520 /* The buffers contain the sets of decls of various kinds and types we have
521 seen so far and the indexes assigned to them. */
522 struct lto_tree_ref_encoder streams[LTO_N_DECL_STREAMS];
524 /* Encoder for cgraph nodes. */
525 lto_symtab_encoder_t symtab_node_encoder;
527 /* If this out-decl state belongs to a function, fn_decl points to that
528 function. Otherwise, it is NULL. */
529 tree fn_decl;
531 /* True if decl state is compressed. */
532 bool compressed;
535 typedef struct lto_out_decl_state *lto_out_decl_state_ptr;
538 /* Compact representation of a index <-> resolution pair. Unpacked to an
539 vector later. */
540 struct res_pair
542 ld_plugin_symbol_resolution_t res;
543 unsigned index;
547 /* One of these is allocated for each object file that being compiled
548 by lto. This structure contains the tables that are needed by the
549 serialized functions and ipa passes to connect themselves to the
550 global types and decls as they are reconstituted. */
551 struct GTY(()) lto_file_decl_data
553 /* Decl state currently used. */
554 struct lto_in_decl_state *current_decl_state;
556 /* Decl state corresponding to regions outside of any functions
557 in the compilation unit. */
558 struct lto_in_decl_state *global_decl_state;
560 /* Table of cgraph nodes present in this file. */
561 lto_symtab_encoder_t GTY((skip)) symtab_node_encoder;
563 /* Hash table maps lto-related section names to location in file. */
564 hash_table<decl_state_hasher> *function_decl_states;
566 /* The .o file that these offsets relate to. */
567 const char *GTY((skip)) file_name;
569 /* Hash table maps lto-related section names to location in file. */
570 htab_t GTY((skip)) section_hash_table;
572 /* Hash new name of renamed global declaration to its original name. */
573 htab_t GTY((skip)) renaming_hash_table;
575 /* Linked list used temporarily in reader */
576 struct lto_file_decl_data *next;
578 /* Sub ID for merged objects. */
579 unsigned HOST_WIDE_INT id;
581 /* Symbol resolutions for this file */
582 vec<res_pair> GTY((skip)) respairs;
583 unsigned max_index;
585 struct gcov_ctr_summary GTY((skip)) profile_info;
587 /* Map assigning declarations their resolutions. */
588 hash_map<tree, ld_plugin_symbol_resolution> * GTY((skip)) resolution_map;
590 /* Mode translation table. */
591 const unsigned char *mode_table;
594 typedef struct lto_file_decl_data *lto_file_decl_data_ptr;
596 struct lto_char_ptr_base
598 char *ptr;
601 /* An incore byte stream to buffer the various parts of the function.
602 The entire structure should be zeroed when created. The record
603 consists of a set of blocks. The first sizeof (ptr) bytes are used
604 as a chain, and the rest store the bytes to be written. */
605 struct lto_output_stream
607 /* The pointer to the first block in the stream. */
608 struct lto_char_ptr_base * first_block;
610 /* The pointer to the last and current block in the stream. */
611 struct lto_char_ptr_base * current_block;
613 /* The pointer to where the next char should be written. */
614 char * current_pointer;
616 /* The number of characters left in the current block. */
617 unsigned int left_in_block;
619 /* The block size of the last block allocated. */
620 unsigned int block_size;
622 /* The total number of characters written. */
623 unsigned int total_size;
626 /* A simple output block. This can be used for simple IPA passes that
627 do not need more than one stream. */
628 struct lto_simple_output_block
630 enum lto_section_type section_type;
631 struct lto_out_decl_state *decl_state;
633 /* The stream that the main tree codes are written to. */
634 struct lto_output_stream *main_stream;
637 /* String hashing. */
639 struct string_slot
641 const char *s;
642 int len;
643 unsigned int slot_num;
646 /* Hashtable helpers. */
648 struct string_slot_hasher : nofree_ptr_hash <string_slot>
650 static inline hashval_t hash (const string_slot *);
651 static inline bool equal (const string_slot *, const string_slot *);
654 /* Returns a hash code for DS. Adapted from libiberty's htab_hash_string
655 to support strings that may not end in '\0'. */
657 inline hashval_t
658 string_slot_hasher::hash (const string_slot *ds)
660 hashval_t r = ds->len;
661 int i;
663 for (i = 0; i < ds->len; i++)
664 r = r * 67 + (unsigned)ds->s[i] - 113;
665 return r;
668 /* Returns nonzero if DS1 and DS2 are equal. */
670 inline bool
671 string_slot_hasher::equal (const string_slot *ds1, const string_slot *ds2)
673 if (ds1->len == ds2->len)
674 return memcmp (ds1->s, ds2->s, ds1->len) == 0;
676 return 0;
679 /* Data structure holding all the data and descriptors used when writing
680 an LTO file. */
681 struct output_block
683 enum lto_section_type section_type;
684 struct lto_out_decl_state *decl_state;
686 /* The stream that the main tree codes are written to. */
687 struct lto_output_stream *main_stream;
689 /* The stream that contains the string table. */
690 struct lto_output_stream *string_stream;
692 /* The stream that contains the cfg. */
693 struct lto_output_stream *cfg_stream;
695 /* The hash table that contains the set of strings we have seen so
696 far and the indexes assigned to them. */
697 hash_table<string_slot_hasher> *string_hash_table;
699 /* The current symbol that we are currently serializing. Null
700 if we are serializing something else. */
701 symtab_node *symbol;
703 /* These are the last file and line that were seen in the stream.
704 If the current node differs from these, it needs to insert
705 something into the stream and fix these up. */
706 const char *current_file;
707 int current_line;
708 int current_col;
709 bool current_sysp;
711 /* Cache of nodes written in this section. */
712 struct streamer_tree_cache_d *writer_cache;
714 /* All data persistent across whole duration of output block
715 can go here. */
716 struct obstack obstack;
720 /* Data and descriptors used when reading from an LTO file. */
721 struct data_in
723 /* The global decls and types. */
724 struct lto_file_decl_data *file_data;
726 /* The string table. */
727 const char *strings;
729 /* The length of the string table. */
730 unsigned int strings_len;
732 /* Maps each reference number to the resolution done by the linker. */
733 vec<ld_plugin_symbol_resolution_t> globals_resolution;
735 /* Cache of pickled nodes. */
736 struct streamer_tree_cache_d *reader_cache;
738 /* Cache of source code location. */
739 lto_location_cache location_cache;
743 /* In lto-section-in.c */
744 extern struct lto_input_block * lto_create_simple_input_block (
745 struct lto_file_decl_data *,
746 enum lto_section_type, const char **, size_t *);
747 extern void
748 lto_destroy_simple_input_block (struct lto_file_decl_data *,
749 enum lto_section_type,
750 struct lto_input_block *, const char *, size_t);
751 extern void lto_set_in_hooks (struct lto_file_decl_data **,
752 lto_get_section_data_f *,
753 lto_free_section_data_f *);
754 extern struct lto_file_decl_data **lto_get_file_decl_data (void);
755 extern const char *lto_get_section_data (struct lto_file_decl_data *,
756 enum lto_section_type,
757 const char *, size_t *,
758 bool decompress = false);
759 extern const char *lto_get_raw_section_data (struct lto_file_decl_data *,
760 enum lto_section_type,
761 const char *, size_t *);
762 extern void lto_free_section_data (struct lto_file_decl_data *,
763 enum lto_section_type,
764 const char *, const char *, size_t,
765 bool decompress = false);
766 extern void lto_free_raw_section_data (struct lto_file_decl_data *,
767 enum lto_section_type,
768 const char *, const char *, size_t);
769 extern htab_t lto_create_renaming_table (void);
770 extern void lto_record_renamed_decl (struct lto_file_decl_data *,
771 const char *, const char *);
772 extern const char *lto_get_decl_name_mapping (struct lto_file_decl_data *,
773 const char *);
774 extern struct lto_in_decl_state *lto_new_in_decl_state (void);
775 extern void lto_delete_in_decl_state (struct lto_in_decl_state *);
776 extern struct lto_in_decl_state *lto_get_function_in_decl_state (
777 struct lto_file_decl_data *, tree);
778 extern void lto_free_function_in_decl_state (struct lto_in_decl_state *);
779 extern void lto_free_function_in_decl_state_for_node (symtab_node *);
780 extern void lto_section_overrun (struct lto_input_block *) ATTRIBUTE_NORETURN;
781 extern void lto_value_range_error (const char *,
782 HOST_WIDE_INT, HOST_WIDE_INT,
783 HOST_WIDE_INT) ATTRIBUTE_NORETURN;
785 /* In lto-section-out.c */
786 extern void lto_begin_section (const char *, bool);
787 extern void lto_end_section (void);
788 extern void lto_write_data (const void *, unsigned int);
789 extern void lto_write_raw_data (const void *, unsigned int);
790 extern void lto_write_stream (struct lto_output_stream *);
791 extern bool lto_output_decl_index (struct lto_output_stream *,
792 struct lto_tree_ref_encoder *,
793 tree, unsigned int *);
794 extern void lto_output_field_decl_index (struct lto_out_decl_state *,
795 struct lto_output_stream *, tree);
796 extern void lto_output_fn_decl_index (struct lto_out_decl_state *,
797 struct lto_output_stream *, tree);
798 extern void lto_output_namespace_decl_index (struct lto_out_decl_state *,
799 struct lto_output_stream *, tree);
800 extern void lto_output_var_decl_index (struct lto_out_decl_state *,
801 struct lto_output_stream *, tree);
802 extern void lto_output_type_decl_index (struct lto_out_decl_state *,
803 struct lto_output_stream *, tree);
804 extern void lto_output_type_ref_index (struct lto_out_decl_state *,
805 struct lto_output_stream *, tree);
806 extern struct lto_simple_output_block *lto_create_simple_output_block (
807 enum lto_section_type);
808 extern void lto_destroy_simple_output_block (struct lto_simple_output_block *);
809 extern struct lto_out_decl_state *lto_new_out_decl_state (void);
810 extern void lto_delete_out_decl_state (struct lto_out_decl_state *);
811 extern struct lto_out_decl_state *lto_get_out_decl_state (void);
812 extern void lto_push_out_decl_state (struct lto_out_decl_state *);
813 extern struct lto_out_decl_state *lto_pop_out_decl_state (void);
814 extern void lto_record_function_out_decl_state (tree,
815 struct lto_out_decl_state *);
816 extern void lto_append_block (struct lto_output_stream *);
819 /* In lto-streamer.c. */
821 /* Set when streaming LTO for offloading compiler. */
822 extern bool lto_stream_offload_p;
824 extern const char *lto_tag_name (enum LTO_tags);
825 extern bitmap lto_bitmap_alloc (void);
826 extern void lto_bitmap_free (bitmap);
827 extern char *lto_get_section_name (int, const char *, struct lto_file_decl_data *);
828 extern void print_lto_report (const char *);
829 extern void lto_streamer_init (void);
830 extern bool gate_lto_out (void);
831 extern void lto_check_version (int, int, const char *);
832 extern void lto_streamer_hooks_init (void);
834 /* In lto-streamer-in.c */
835 extern void lto_input_cgraph (struct lto_file_decl_data *, const char *);
836 extern void lto_reader_init (void);
837 extern void lto_input_function_body (struct lto_file_decl_data *,
838 struct cgraph_node *,
839 const char *);
840 extern void lto_input_variable_constructor (struct lto_file_decl_data *,
841 struct varpool_node *,
842 const char *);
843 extern void lto_input_constructors_and_inits (struct lto_file_decl_data *,
844 const char *);
845 extern void lto_input_toplevel_asms (struct lto_file_decl_data *, int);
846 extern void lto_input_mode_table (struct lto_file_decl_data *);
847 extern struct data_in *lto_data_in_create (struct lto_file_decl_data *,
848 const char *, unsigned,
849 vec<ld_plugin_symbol_resolution_t> );
850 extern void lto_data_in_delete (struct data_in *);
851 extern void lto_input_data_block (struct lto_input_block *, void *, size_t);
852 void lto_input_location (location_t *, struct bitpack_d *, struct data_in *);
853 location_t stream_input_location_now (struct bitpack_d *bp,
854 struct data_in *data);
855 tree lto_input_tree_ref (struct lto_input_block *, struct data_in *,
856 struct function *, enum LTO_tags);
857 void lto_tag_check_set (enum LTO_tags, int, ...);
858 void lto_init_eh (void);
859 hashval_t lto_input_scc (struct lto_input_block *, struct data_in *,
860 unsigned *, unsigned *);
861 tree lto_input_tree_1 (struct lto_input_block *, struct data_in *,
862 enum LTO_tags, hashval_t hash);
863 tree lto_input_tree (struct lto_input_block *, struct data_in *);
866 /* In lto-streamer-out.c */
867 extern void lto_register_decl_definition (tree, struct lto_file_decl_data *);
868 extern struct output_block *create_output_block (enum lto_section_type);
869 extern void destroy_output_block (struct output_block *);
870 extern void lto_output_tree (struct output_block *, tree, bool, bool);
871 extern void lto_output_toplevel_asms (void);
872 extern void produce_asm (struct output_block *ob, tree fn);
873 extern void lto_output ();
874 extern void produce_asm_for_decls ();
875 void lto_output_decl_state_streams (struct output_block *,
876 struct lto_out_decl_state *);
877 void lto_output_decl_state_refs (struct output_block *,
878 struct lto_output_stream *,
879 struct lto_out_decl_state *);
880 void lto_output_location (struct output_block *, struct bitpack_d *, location_t);
881 void lto_output_init_mode_table (void);
884 /* In lto-cgraph.c */
885 extern bool asm_nodes_output;
886 lto_symtab_encoder_t lto_symtab_encoder_new (bool);
887 int lto_symtab_encoder_encode (lto_symtab_encoder_t, symtab_node *);
888 void lto_symtab_encoder_delete (lto_symtab_encoder_t);
889 bool lto_symtab_encoder_delete_node (lto_symtab_encoder_t, symtab_node *);
890 bool lto_symtab_encoder_encode_body_p (lto_symtab_encoder_t,
891 struct cgraph_node *);
892 bool lto_symtab_encoder_in_partition_p (lto_symtab_encoder_t,
893 symtab_node *);
894 void lto_set_symtab_encoder_in_partition (lto_symtab_encoder_t,
895 symtab_node *);
897 bool lto_symtab_encoder_encode_initializer_p (lto_symtab_encoder_t,
898 varpool_node *);
899 void output_symtab (void);
900 void input_symtab (void);
901 void output_offload_tables (void);
902 void input_offload_tables (bool);
903 bool referenced_from_other_partition_p (struct ipa_ref_list *,
904 lto_symtab_encoder_t);
905 bool reachable_from_other_partition_p (struct cgraph_node *,
906 lto_symtab_encoder_t);
907 bool referenced_from_this_partition_p (symtab_node *,
908 lto_symtab_encoder_t);
909 bool reachable_from_this_partition_p (struct cgraph_node *,
910 lto_symtab_encoder_t);
911 lto_symtab_encoder_t compute_ltrans_boundary (lto_symtab_encoder_t encoder);
912 void select_what_to_stream (void);
914 /* In options-save.c. */
915 void cl_target_option_stream_out (struct output_block *, struct bitpack_d *,
916 struct cl_target_option *);
918 void cl_target_option_stream_in (struct data_in *,
919 struct bitpack_d *,
920 struct cl_target_option *);
922 void cl_optimization_stream_out (struct bitpack_d *, struct cl_optimization *);
924 void cl_optimization_stream_in (struct bitpack_d *, struct cl_optimization *);
928 /* In lto-opts.c. */
929 extern void lto_write_options (void);
932 /* Statistics gathered during LTO, WPA and LTRANS. */
933 extern struct lto_stats_d lto_stats;
935 /* Section names corresponding to the values of enum lto_section_type. */
936 extern const char *lto_section_name[];
938 /* Holds all the out decl states of functions output so far in the
939 current output file. */
940 extern vec<lto_out_decl_state_ptr> lto_function_decl_states;
942 /* Return true if LTO tag TAG corresponds to a tree code. */
943 static inline bool
944 lto_tag_is_tree_code_p (enum LTO_tags tag)
946 return tag > LTO_tree_pickle_reference && (unsigned) tag <= MAX_TREE_CODES;
950 /* Return true if LTO tag TAG corresponds to a gimple code. */
951 static inline bool
952 lto_tag_is_gimple_code_p (enum LTO_tags tag)
954 return (unsigned) tag >= NUM_TREE_CODES + 2
955 && (unsigned) tag < 2 + NUM_TREE_CODES + LAST_AND_UNUSED_GIMPLE_CODE;
959 /* Return the LTO tag corresponding to gimple code CODE. See enum
960 LTO_tags for details on the conversion. */
961 static inline enum LTO_tags
962 lto_gimple_code_to_tag (enum gimple_code code)
964 return (enum LTO_tags) ((unsigned) code + NUM_TREE_CODES + 2);
968 /* Return the GIMPLE code corresponding to TAG. See enum LTO_tags for
969 details on the conversion. */
970 static inline enum gimple_code
971 lto_tag_to_gimple_code (enum LTO_tags tag)
973 gcc_assert (lto_tag_is_gimple_code_p (tag));
974 return (enum gimple_code) ((unsigned) tag - NUM_TREE_CODES - 2);
978 /* Return the LTO tag corresponding to tree code CODE. See enum
979 LTO_tags for details on the conversion. */
980 static inline enum LTO_tags
981 lto_tree_code_to_tag (enum tree_code code)
983 return (enum LTO_tags) ((unsigned) code + 2);
987 /* Return the tree code corresponding to TAG. See enum LTO_tags for
988 details on the conversion. */
989 static inline enum tree_code
990 lto_tag_to_tree_code (enum LTO_tags tag)
992 gcc_assert (lto_tag_is_tree_code_p (tag));
993 return (enum tree_code) ((unsigned) tag - 2);
996 /* Check that tag ACTUAL == EXPECTED. */
997 static inline void
998 lto_tag_check (enum LTO_tags actual, enum LTO_tags expected)
1000 if (actual != expected)
1001 internal_error ("bytecode stream: expected tag %s instead of %s",
1002 lto_tag_name (expected), lto_tag_name (actual));
1005 /* Check that tag ACTUAL is in the range [TAG1, TAG2]. */
1006 static inline void
1007 lto_tag_check_range (enum LTO_tags actual, enum LTO_tags tag1,
1008 enum LTO_tags tag2)
1010 if (actual < tag1 || actual > tag2)
1011 internal_error ("bytecode stream: tag %s is not in the expected range "
1012 "[%s, %s]",
1013 lto_tag_name (actual),
1014 lto_tag_name (tag1),
1015 lto_tag_name (tag2));
1018 /* Initialize an lto_out_decl_buffer ENCODER. */
1019 static inline void
1020 lto_init_tree_ref_encoder (struct lto_tree_ref_encoder *encoder)
1022 encoder->tree_hash_table = new hash_map<tree, unsigned> (251);
1023 encoder->trees.create (0);
1027 /* Destroy an lto_tree_ref_encoder ENCODER by freeing its contents. The
1028 memory used by ENCODER is not freed by this function. */
1029 static inline void
1030 lto_destroy_tree_ref_encoder (struct lto_tree_ref_encoder *encoder)
1032 /* Hash table may be delete already. */
1033 delete encoder->tree_hash_table;
1034 encoder->tree_hash_table = NULL;
1035 encoder->trees.release ();
1038 /* Return the number of trees encoded in ENCODER. */
1039 static inline unsigned int
1040 lto_tree_ref_encoder_size (struct lto_tree_ref_encoder *encoder)
1042 return encoder->trees.length ();
1045 /* Return the IDX-th tree in ENCODER. */
1046 static inline tree
1047 lto_tree_ref_encoder_get_tree (struct lto_tree_ref_encoder *encoder,
1048 unsigned int idx)
1050 return encoder->trees[idx];
1053 /* Return number of encoded nodes in ENCODER. */
1054 static inline int
1055 lto_symtab_encoder_size (lto_symtab_encoder_t encoder)
1057 return encoder->nodes.length ();
1060 /* Value used to represent failure of lto_symtab_encoder_lookup. */
1061 #define LCC_NOT_FOUND (-1)
1063 /* Look up NODE in encoder. Return NODE's reference if it has been encoded
1064 or LCC_NOT_FOUND if it is not there. */
1066 static inline int
1067 lto_symtab_encoder_lookup (lto_symtab_encoder_t encoder,
1068 symtab_node *node)
1070 size_t *slot = encoder->map->get (node);
1071 return (slot && *slot ? *(slot) - 1 : LCC_NOT_FOUND);
1074 /* Return true if iterator LSE points to nothing. */
1075 static inline bool
1076 lsei_end_p (lto_symtab_encoder_iterator lsei)
1078 return lsei.index >= (unsigned)lto_symtab_encoder_size (lsei.encoder);
1081 /* Advance iterator LSE. */
1082 static inline void
1083 lsei_next (lto_symtab_encoder_iterator *lsei)
1085 lsei->index++;
1088 /* Return the node pointed to by LSI. */
1089 static inline symtab_node *
1090 lsei_node (lto_symtab_encoder_iterator lsei)
1092 return lsei.encoder->nodes[lsei.index].node;
1095 /* Return the node pointed to by LSI. */
1096 static inline struct cgraph_node *
1097 lsei_cgraph_node (lto_symtab_encoder_iterator lsei)
1099 return dyn_cast<cgraph_node *> (lsei.encoder->nodes[lsei.index].node);
1102 /* Return the node pointed to by LSI. */
1103 static inline varpool_node *
1104 lsei_varpool_node (lto_symtab_encoder_iterator lsei)
1106 return dyn_cast<varpool_node *> (lsei.encoder->nodes[lsei.index].node);
1109 /* Return the cgraph node corresponding to REF using ENCODER. */
1111 static inline symtab_node *
1112 lto_symtab_encoder_deref (lto_symtab_encoder_t encoder, int ref)
1114 if (ref == LCC_NOT_FOUND)
1115 return NULL;
1117 return encoder->nodes[ref].node;
1120 /* Return an iterator to the first node in LSI. */
1121 static inline lto_symtab_encoder_iterator
1122 lsei_start (lto_symtab_encoder_t encoder)
1124 lto_symtab_encoder_iterator lsei;
1126 lsei.encoder = encoder;
1127 lsei.index = 0;
1128 return lsei;
1131 /* Advance iterator LSE. */
1132 static inline void
1133 lsei_next_in_partition (lto_symtab_encoder_iterator *lsei)
1135 lsei_next (lsei);
1136 while (!lsei_end_p (*lsei)
1137 && !lto_symtab_encoder_in_partition_p (lsei->encoder, lsei_node (*lsei)))
1138 lsei_next (lsei);
1141 /* Return an iterator to the first node in LSI. */
1142 static inline lto_symtab_encoder_iterator
1143 lsei_start_in_partition (lto_symtab_encoder_t encoder)
1145 lto_symtab_encoder_iterator lsei = lsei_start (encoder);
1147 if (lsei_end_p (lsei))
1148 return lsei;
1149 if (!lto_symtab_encoder_in_partition_p (encoder, lsei_node (lsei)))
1150 lsei_next_in_partition (&lsei);
1152 return lsei;
1155 /* Advance iterator LSE. */
1156 static inline void
1157 lsei_next_function_in_partition (lto_symtab_encoder_iterator *lsei)
1159 lsei_next (lsei);
1160 while (!lsei_end_p (*lsei)
1161 && (!is_a <cgraph_node *> (lsei_node (*lsei))
1162 || !lto_symtab_encoder_in_partition_p (lsei->encoder, lsei_node (*lsei))))
1163 lsei_next (lsei);
1166 /* Return an iterator to the first node in LSI. */
1167 static inline lto_symtab_encoder_iterator
1168 lsei_start_function_in_partition (lto_symtab_encoder_t encoder)
1170 lto_symtab_encoder_iterator lsei = lsei_start (encoder);
1172 if (lsei_end_p (lsei))
1173 return lsei;
1174 if (!is_a <cgraph_node *> (lsei_node (lsei))
1175 || !lto_symtab_encoder_in_partition_p (encoder, lsei_node (lsei)))
1176 lsei_next_function_in_partition (&lsei);
1178 return lsei;
1181 /* Advance iterator LSE. */
1182 static inline void
1183 lsei_next_variable_in_partition (lto_symtab_encoder_iterator *lsei)
1185 lsei_next (lsei);
1186 while (!lsei_end_p (*lsei)
1187 && (!is_a <varpool_node *> (lsei_node (*lsei))
1188 || !lto_symtab_encoder_in_partition_p (lsei->encoder, lsei_node (*lsei))))
1189 lsei_next (lsei);
1192 /* Return an iterator to the first node in LSI. */
1193 static inline lto_symtab_encoder_iterator
1194 lsei_start_variable_in_partition (lto_symtab_encoder_t encoder)
1196 lto_symtab_encoder_iterator lsei = lsei_start (encoder);
1198 if (lsei_end_p (lsei))
1199 return lsei;
1200 if (!is_a <varpool_node *> (lsei_node (lsei))
1201 || !lto_symtab_encoder_in_partition_p (encoder, lsei_node (lsei)))
1202 lsei_next_variable_in_partition (&lsei);
1204 return lsei;
1207 DEFINE_DECL_STREAM_FUNCS (TYPE, type)
1208 DEFINE_DECL_STREAM_FUNCS (FIELD_DECL, field_decl)
1209 DEFINE_DECL_STREAM_FUNCS (FN_DECL, fn_decl)
1210 DEFINE_DECL_STREAM_FUNCS (VAR_DECL, var_decl)
1211 DEFINE_DECL_STREAM_FUNCS (TYPE_DECL, type_decl)
1212 DEFINE_DECL_STREAM_FUNCS (NAMESPACE_DECL, namespace_decl)
1213 DEFINE_DECL_STREAM_FUNCS (LABEL_DECL, label_decl)
1215 /* Entry for the delayed registering of decl -> DIE references. */
1216 struct dref_entry {
1217 tree decl;
1218 const char *sym;
1219 unsigned HOST_WIDE_INT off;
1222 extern vec<dref_entry> dref_queue;
1225 #endif /* GCC_LTO_STREAMER_H */