1 /* Data structures and declarations used for reading and writing
2 GIMPLE to a file stream.
4 Copyright (C) 2009, 2010 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
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
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"
33 #include "alloc-pool.h"
36 /* Define when debugging the LTO streamer. This causes the writer
37 to output the numeric value for the memory address of the tree node
38 being emitted. When debugging a problem in the reader, check the
39 original address that the writer was emitting using lto_orig_address_get.
40 With this value, set a breakpoint in the writer (e.g., lto_output_tree)
41 to trace how the faulty node is being emitted. */
42 /* #define LTO_STREAMER_DEBUG 1 */
44 /* The encoding for a function consists of the following sections:
52 7) Names for the labels that have names
54 9) The control flow graph.
55 10-11)Gimple for local decls.
56 12) Gimple for the function.
60 2-6) THE GLOBAL DECLS AND TYPES.
62 The global decls and types are encoded in the same way. For each
63 entry, there is word with the offset within the section to the
68 Since most labels do not have names, this section my be of zero
69 length. It consists of an array of string table references, one
70 per label. In the lto code, the labels are given either
71 positive or negative indexes. the positive ones have names and
72 the negative ones do not. The positive index can be used to
73 find the name in this array.
77 10) Index into the local decls. Since local decls can have local
78 decls inside them, they must be read in randomly in order to
79 properly restore them.
81 11-12) GIMPLE FOR THE LOCAL DECLS AND THE FUNCTION BODY.
83 The gimple consists of a set of records.
87 At the top level of (8) is the function. It consists of five
90 LTO_function - The tag.
91 eh tree - This is all of the exception handling regions
92 put out in a post order traversial of the
93 tree. Siblings are output as lists terminated
94 by a 0. The set of fields matches the fields
97 last_basic_block - in uleb128 form.
99 basic blocks - This is the set of basic blocks.
101 zero - The termination of the basic blocks.
105 There are two forms of basic blocks depending on if they are
108 The basic block consists of:
110 LTO_bb1 or LTO_bb0 - The tag.
112 bb->index - the index in uleb128 form.
114 #succs - The number of successors un uleb128 form.
116 the successors - For each edge, a pair. The first of the
117 pair is the index of the successor in
118 uleb128 form and the second are the flags in
121 the statements - A gimple tree, as described above.
122 These are only present for LTO_BB1.
123 Following each statement is an optional
124 exception handling record LTO_eh_region
125 which contains the region number (for
128 zero - This is only present for LTO_BB1 and is used
129 to terminate the statements and exception
130 regions within this block.
134 String are represented in the table as pairs, a length in ULEB128
135 form followed by the data for the string. */
137 /* The string that is the prefix on the section names we make for lto.
138 For decls the DECL_ASSEMBLER_NAME is appended to make the section
139 name for the functions and static_initializers. For other types of
140 sections a '.' and the section type are appended. */
141 #define LTO_SECTION_NAME_PREFIX ".gnu.lto_"
143 #define LTO_major_version 2
144 #define LTO_minor_version 0
146 typedef unsigned char lto_decl_flags_t
;
149 /* Data structures used to pack values and bitflags into a vector of
150 words. Used to stream values of a fixed number of bits in a space
152 static unsigned const BITS_PER_BITPACK_WORD
= HOST_BITS_PER_WIDE_INT
;
154 typedef unsigned HOST_WIDE_INT bitpack_word_t
;
155 DEF_VEC_I(bitpack_word_t
);
156 DEF_VEC_ALLOC_I(bitpack_word_t
, heap
);
160 /* The position of the first unused or unconsumed bit in the word. */
163 /* The current word we are (un)packing. */
166 /* The lto_output_stream or the lto_input_block we are streaming to/from. */
170 /* Tags representing the various IL objects written to the bytecode file
171 (GIMPLE statements, basic blocks, EH regions, tree nodes, etc).
173 NOTE, when adding new LTO tags, also update lto_tag_name. */
178 /* Reserve enough entries to fit all the tree and gimple codes handled
179 by the streamer. This guarantees that:
181 1- Given a tree code C:
182 enum LTO_tags tag == C + 1
184 2- Given a gimple code C:
185 enum LTO_tags tag == C + NUM_TREE_CODES + 1
187 Conversely, to map between LTO tags and tree/gimple codes, the
188 reverse operation must be applied. */
189 LTO_bb0
= 1 + NUM_TREE_CODES
+ LAST_AND_UNUSED_GIMPLE_CODE
,
192 /* EH region holding the previous statement. */
195 /* An MD or NORMAL builtin. Only the code and class are streamed out. */
204 /* EH region types. These mirror enum eh_region_type. */
207 LTO_ert_allowed_exceptions
,
208 LTO_ert_must_not_throw
,
210 /* EH landing pad. */
213 /* EH try/catch node. */
216 /* Special for global streamer. Reference to previously-streamed node. */
217 LTO_tree_pickle_reference
,
219 /* References to indexable tree nodes. These objects are stored in
220 tables that are written separately from the function bodies that
221 reference them. This way they can be instantiated even when the
222 referencing functions aren't (e.g., during WPA) and it also allows
223 functions to be copied from one file to another without having
224 to unpickle the body first (the references are location
227 NOTE, do not regroup these values as the grouping is exposed
228 in the range checks done in lto_input_tree. */
229 LTO_field_decl_ref
, /* Do not change. */
230 LTO_function_decl_ref
,
232 LTO_namespace_decl_ref
,
238 LTO_imported_decl_ref
,
239 LTO_translation_unit_decl_ref
,
240 LTO_global_decl_ref
, /* Do not change. */
242 /* This tag must always be last. */
247 /* Set of section types that are in an LTO file. This list will grow
248 as the number of IPA passes grows since each IPA pass will need its
249 own section type to store its summary information.
251 When adding a new section type, you must also extend the
252 LTO_SECTION_NAME array in lto-section-in.c. */
253 enum lto_section_type
255 LTO_section_decls
= 0,
256 LTO_section_function_body
,
257 LTO_section_static_initializer
,
261 LTO_section_jump_functions
,
262 LTO_section_ipa_pure_const
,
263 LTO_section_ipa_reference
,
266 LTO_section_cgraph_opt_sum
,
267 LTO_N_SECTION_TYPES
/* Must be last. */
270 /* Indices to the various function, type and symbol streams. */
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
,
281 } lto_decl_stream_e_t
;
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
);
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) \
292 lto_file_decl_data_get_ ## name (struct lto_file_decl_data *data, \
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]; \
300 static inline unsigned int \
301 lto_file_decl_data_num_ ## name ## s (struct lto_file_decl_data *data) \
303 struct lto_in_decl_state *state = data->current_decl_state; \
304 return state->streams[LTO_DECL_STREAM_## UPPER_NAME].size; \
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
,
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
,
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.
333 This is used in two ways:
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.
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
347 /* The mapping between tree nodes and slots into the nodes array. */
350 /* Node map to store entries into. */
351 alloc_pool node_map_entries
;
353 /* Next available slot in the nodes and offsets arrays. */
356 /* The nodes pickled so far. */
357 VEC(tree
,heap
) *nodes
;
359 /* Offset into the stream where the nodes have been written. */
360 VEC(unsigned,heap
) *offsets
;
364 /* Structure used as buffer for reading an LTO file. */
365 struct lto_input_block
372 #define LTO_INIT_INPUT_BLOCK(BASE,D,P,L) \
379 #define LTO_INIT_INPUT_BLOCK_PTR(BASE,D,P,L) \
387 /* The is the first part of the record for a function or constructor
391 int16_t major_version
;
392 int16_t minor_version
;
393 enum lto_section_type section_type
;
396 /* The header for a function body. */
397 struct lto_function_header
399 /* The header for all types of sections. */
400 struct lto_header lto_header
;
402 /* Number of labels with names. */
403 int32_t num_named_labels
;
405 /* Number of labels without names. */
406 int32_t num_unnamed_labels
;
408 /* Size compressed or 0 if not compressed. */
409 int32_t compressed_size
;
411 /* Size of names for named labels. */
412 int32_t named_label_size
;
414 /* Size of the cfg. */
417 /* Size of main gimple body of function. */
420 /* Size of the string table. */
425 /* Structure describing a symbol section. */
426 struct lto_decl_header
428 /* The header for all types of sections. */
429 struct lto_header lto_header
;
431 /* Size of region for decl state. */
432 int32_t decl_state_size
;
434 /* Number of nodes in globals stream. */
437 /* Size of region for expressions, decls, types, etc. */
440 /* Size of the string table. */
445 /* Statistics gathered during LTO, WPA and LTRANS. */
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
;
462 /* Encoder data structure used to stream callgraph nodes. */
463 struct lto_cgraph_encoder_d
465 /* Map nodes to reference number. */
466 struct pointer_map_t
*map
;
468 /* Map reference number to node. */
469 VEC(cgraph_node_ptr
,heap
) *nodes
;
471 /* Map of nodes where we want to output body. */
472 struct pointer_set_t
*body
;
475 typedef struct lto_cgraph_encoder_d
*lto_cgraph_encoder_t
;
477 /* Return number of encoded nodes in ENCODER. */
480 lto_cgraph_encoder_size (lto_cgraph_encoder_t encoder
)
482 return VEC_length (cgraph_node_ptr
, encoder
->nodes
);
486 /* Encoder data structure used to stream callgraph nodes. */
487 struct lto_varpool_encoder_d
489 /* Map nodes to reference number. */
490 struct pointer_map_t
*map
;
492 /* Map reference number to node. */
493 VEC(varpool_node_ptr
,heap
) *nodes
;
495 /* Map of nodes where we want to output initializer. */
496 struct pointer_set_t
*initializer
;
498 typedef struct lto_varpool_encoder_d
*lto_varpool_encoder_t
;
500 /* Return number of encoded nodes in ENCODER. */
503 lto_varpool_encoder_size (lto_varpool_encoder_t encoder
)
505 return VEC_length (varpool_node_ptr
, encoder
->nodes
);
508 /* Mapping from indices to trees. */
509 struct GTY(()) lto_tree_ref_table
511 /* Array of referenced trees . */
512 tree
* GTY((length ("%h.size"))) trees
;
519 /* Mapping between trees and slots in an array. */
527 /* The lto_tree_ref_encoder struct is used to encode trees into indices. */
529 struct lto_tree_ref_encoder
531 htab_t tree_hash_table
; /* Maps pointers to indices. */
532 unsigned int next_index
; /* Next available index. */
533 VEC(tree
,heap
) *trees
; /* Maps indices to pointers. */
537 /* Structure to hold states of input scope. */
538 struct GTY(()) lto_in_decl_state
540 /* Array of lto_in_decl_buffers to store type and decls streams. */
541 struct lto_tree_ref_table streams
[LTO_N_DECL_STREAMS
];
543 /* If this in-decl state is associated with a function. FN_DECL
544 point to the FUNCTION_DECL. */
548 typedef struct lto_in_decl_state
*lto_in_decl_state_ptr
;
551 /* The structure that holds all of the vectors of global types,
552 decls and cgraph nodes used in the serialization of this file. */
553 struct lto_out_decl_state
555 /* The buffers contain the sets of decls of various kinds and types we have
556 seen so far and the indexes assigned to them. */
557 struct lto_tree_ref_encoder streams
[LTO_N_DECL_STREAMS
];
559 /* Encoder for cgraph nodes. */
560 lto_cgraph_encoder_t cgraph_node_encoder
;
562 /* Encoder for varpool nodes. */
563 lto_varpool_encoder_t varpool_node_encoder
;
565 /* If this out-decl state belongs to a function, fn_decl points to that
566 function. Otherwise, it is NULL. */
570 typedef struct lto_out_decl_state
*lto_out_decl_state_ptr
;
572 DEF_VEC_P(lto_out_decl_state_ptr
);
573 DEF_VEC_ALLOC_P(lto_out_decl_state_ptr
, heap
);
575 /* One of these is allocated for each object file that being compiled
576 by lto. This structure contains the tables that are needed by the
577 serialized functions and ipa passes to connect themselves to the
578 global types and decls as they are reconstituted. */
579 struct GTY(()) lto_file_decl_data
581 /* Decl state currently used. */
582 struct lto_in_decl_state
*current_decl_state
;
584 /* Decl state corresponding to regions outside of any functions
585 in the compilation unit. */
586 struct lto_in_decl_state
*global_decl_state
;
588 /* Table of cgraph nodes present in this file. */
589 lto_cgraph_encoder_t
GTY((skip
)) cgraph_node_encoder
;
591 /* Table of varpool nodes present in this file. */
592 lto_varpool_encoder_t
GTY((skip
)) varpool_node_encoder
;
594 /* Hash table maps lto-related section names to location in file. */
595 htab_t
GTY((param_is (struct lto_in_decl_state
))) function_decl_states
;
597 /* The .o file that these offsets relate to. */
598 const char *GTY((skip
)) file_name
;
600 /* Hash table maps lto-related section names to location in file. */
601 htab_t
GTY((skip
)) section_hash_table
;
603 /* Hash new name of renamed global declaration to its original name. */
604 htab_t
GTY((skip
)) renaming_hash_table
;
606 /* Linked list used temporarily in reader */
607 struct lto_file_decl_data
*next
;
609 /* Sub ID for merged objects. */
612 /* Symbol resolutions for this file */
613 VEC(ld_plugin_symbol_resolution_t
,heap
) * GTY((skip
)) resolutions
;
615 struct gcov_ctr_summary
GTY((skip
)) profile_info
;
618 typedef struct lto_file_decl_data
*lto_file_decl_data_ptr
;
620 struct lto_char_ptr_base
625 /* An incore byte stream to buffer the various parts of the function.
626 The entire structure should be zeroed when created. The record
627 consists of a set of blocks. The first sizeof (ptr) bytes are used
628 as a chain, and the rest store the bytes to be written. */
629 struct lto_output_stream
631 /* The pointer to the first block in the stream. */
632 struct lto_char_ptr_base
* first_block
;
634 /* The pointer to the last and current block in the stream. */
635 struct lto_char_ptr_base
* current_block
;
637 /* The pointer to where the next char should be written. */
638 char * current_pointer
;
640 /* The number of characters left in the current block. */
641 unsigned int left_in_block
;
643 /* The block size of the last block allocated. */
644 unsigned int block_size
;
646 /* The total number of characters written. */
647 unsigned int total_size
;
650 /* The is the first part of the record in an LTO file for many of the
652 struct lto_simple_header
654 /* The header for all types of sections. */
655 struct lto_header lto_header
;
657 /* Size of main gimple body of function. */
660 /* Size of main stream when compressed. */
661 int32_t compressed_size
;
664 /* A simple output block. This can be used for simple IPA passes that
665 do not need more than one stream. */
666 struct lto_simple_output_block
668 enum lto_section_type section_type
;
669 struct lto_out_decl_state
*decl_state
;
671 /* The stream that the main tree codes are written to. */
672 struct lto_output_stream
*main_stream
;
675 /* Data structure holding all the data and descriptors used when writing
679 enum lto_section_type section_type
;
680 struct lto_out_decl_state
*decl_state
;
682 /* The stream that the main tree codes are written to. */
683 struct lto_output_stream
*main_stream
;
685 /* The stream that contains the string table. */
686 struct lto_output_stream
*string_stream
;
688 /* The stream that contains the cfg. */
689 struct lto_output_stream
*cfg_stream
;
691 /* The hash table that contains the set of strings we have seen so
692 far and the indexes assigned to them. */
693 htab_t string_hash_table
;
695 /* The current cgraph_node that we are currently serializing. Null
696 if we are serializing something else. */
697 struct cgraph_node
*cgraph_node
;
699 /* These are the last file and line that were seen in the stream.
700 If the current node differs from these, it needs to insert
701 something into the stream and fix these up. */
702 const char *current_file
;
706 /* True if writing globals and types. */
709 /* Cache of nodes written in this section. */
710 struct lto_streamer_cache_d
*writer_cache
;
714 /* Data and descriptors used when reading from an LTO file. */
717 /* The global decls and types. */
718 struct lto_file_decl_data
*file_data
;
720 /* All of the labels. */
723 /* The string table. */
726 /* The length of the string table. */
727 unsigned int strings_len
;
729 /* Number of named labels. Used to find the index of unnamed labels
730 since they share space with the named labels. */
731 unsigned int num_named_labels
;
733 /* Number of unnamed labels. */
734 unsigned int num_unnamed_labels
;
736 const char *current_file
;
740 /* Maps each reference number to the resolution done by the linker. */
741 VEC(ld_plugin_symbol_resolution_t
,heap
) *globals_resolution
;
743 /* Cache of pickled nodes. */
744 struct lto_streamer_cache_d
*reader_cache
;
748 /* In lto-section-in.c */
749 extern struct lto_input_block
* lto_create_simple_input_block (
750 struct lto_file_decl_data
*,
751 enum lto_section_type
, const char **, size_t *);
753 lto_destroy_simple_input_block (struct lto_file_decl_data
*,
754 enum lto_section_type
,
755 struct lto_input_block
*, const char *, size_t);
756 extern void lto_set_in_hooks (struct lto_file_decl_data
**,
757 lto_get_section_data_f
*,
758 lto_free_section_data_f
*);
759 extern struct lto_file_decl_data
**lto_get_file_decl_data (void);
760 extern const char *lto_get_section_data (struct lto_file_decl_data
*,
761 enum lto_section_type
,
762 const char *, size_t *);
763 extern void lto_free_section_data (struct lto_file_decl_data
*,
764 enum lto_section_type
,
765 const char *, const char *, size_t);
766 extern unsigned char lto_input_1_unsigned (struct lto_input_block
*);
767 extern unsigned HOST_WIDE_INT
lto_input_uleb128 (struct lto_input_block
*);
768 extern unsigned HOST_WIDEST_INT
lto_input_widest_uint_uleb128 (
769 struct lto_input_block
*);
770 extern HOST_WIDE_INT
lto_input_sleb128 (struct lto_input_block
*);
771 extern htab_t
lto_create_renaming_table (void);
772 extern void lto_record_renamed_decl (struct lto_file_decl_data
*,
773 const char *, const char *);
774 extern const char *lto_get_decl_name_mapping (struct lto_file_decl_data
*,
776 extern struct lto_in_decl_state
*lto_new_in_decl_state (void);
777 extern void lto_delete_in_decl_state (struct lto_in_decl_state
*);
778 extern hashval_t
lto_hash_in_decl_state (const void *);
779 extern int lto_eq_in_decl_state (const void *, const void *);
780 extern struct lto_in_decl_state
*lto_get_function_in_decl_state (
781 struct lto_file_decl_data
*, tree
);
783 /* In lto-section-out.c */
784 extern hashval_t
lto_hash_decl_slot_node (const void *);
785 extern int lto_eq_decl_slot_node (const void *, const void *);
786 extern hashval_t
lto_hash_type_slot_node (const void *);
787 extern int lto_eq_type_slot_node (const void *, const void *);
788 extern void lto_begin_section (const char *, bool);
789 extern void lto_end_section (void);
790 extern void lto_write_stream (struct lto_output_stream
*);
791 extern void lto_output_1_stream (struct lto_output_stream
*, char);
792 extern void lto_output_data_stream (struct lto_output_stream
*, const void *,
794 extern void lto_output_uleb128_stream (struct lto_output_stream
*,
795 unsigned HOST_WIDE_INT
);
796 extern void lto_output_widest_uint_uleb128_stream (struct lto_output_stream
*,
797 unsigned HOST_WIDEST_INT
);
798 extern void lto_output_sleb128_stream (struct lto_output_stream
*,
800 extern bool lto_output_decl_index (struct lto_output_stream
*,
801 struct lto_tree_ref_encoder
*,
802 tree
, unsigned int *);
803 extern void lto_output_field_decl_index (struct lto_out_decl_state
*,
804 struct lto_output_stream
*, tree
);
805 extern void lto_output_fn_decl_index (struct lto_out_decl_state
*,
806 struct lto_output_stream
*, tree
);
807 extern void lto_output_namespace_decl_index (struct lto_out_decl_state
*,
808 struct lto_output_stream
*, tree
);
809 extern void lto_output_var_decl_index (struct lto_out_decl_state
*,
810 struct lto_output_stream
*, tree
);
811 extern void lto_output_type_decl_index (struct lto_out_decl_state
*,
812 struct lto_output_stream
*, tree
);
813 extern void lto_output_type_ref_index (struct lto_out_decl_state
*,
814 struct lto_output_stream
*, tree
);
815 extern struct lto_simple_output_block
*lto_create_simple_output_block (
816 enum lto_section_type
);
817 extern void lto_destroy_simple_output_block (struct lto_simple_output_block
*);
818 extern struct lto_out_decl_state
*lto_new_out_decl_state (void);
819 extern void lto_delete_out_decl_state (struct lto_out_decl_state
*);
820 extern struct lto_out_decl_state
*lto_get_out_decl_state (void);
821 extern void lto_push_out_decl_state (struct lto_out_decl_state
*);
822 extern struct lto_out_decl_state
*lto_pop_out_decl_state (void);
823 extern void lto_record_function_out_decl_state (tree
,
824 struct lto_out_decl_state
*);
827 /* In lto-streamer.c. */
828 extern const char *lto_tag_name (enum LTO_tags
);
829 extern bitmap
lto_bitmap_alloc (void);
830 extern void lto_bitmap_free (bitmap
);
831 extern char *lto_get_section_name (int, const char *, struct lto_file_decl_data
*);
832 extern void print_lto_report (void);
833 extern bool lto_streamer_cache_insert (struct lto_streamer_cache_d
*, tree
,
835 extern bool lto_streamer_cache_insert_at (struct lto_streamer_cache_d
*, tree
,
837 extern bool lto_streamer_cache_lookup (struct lto_streamer_cache_d
*, tree
,
839 extern tree
lto_streamer_cache_get (struct lto_streamer_cache_d
*, int);
840 extern struct lto_streamer_cache_d
*lto_streamer_cache_create (void);
841 extern void lto_streamer_cache_delete (struct lto_streamer_cache_d
*);
842 extern void lto_streamer_init (void);
843 extern bool gate_lto_out (void);
844 #ifdef LTO_STREAMER_DEBUG
845 extern void lto_orig_address_map (tree
, intptr_t);
846 extern intptr_t lto_orig_address_get (tree
);
847 extern void lto_orig_address_remove (tree
);
849 extern void lto_check_version (int, int);
852 /* In lto-streamer-in.c */
853 extern void lto_input_cgraph (struct lto_file_decl_data
*, const char *);
854 extern void lto_init_reader (void);
855 extern tree
lto_input_tree (struct lto_input_block
*, struct data_in
*);
856 extern void lto_input_function_body (struct lto_file_decl_data
*, tree
,
858 extern void lto_input_constructors_and_inits (struct lto_file_decl_data
*,
860 extern void lto_init_reader (void);
861 extern struct data_in
*lto_data_in_create (struct lto_file_decl_data
*,
862 const char *, unsigned,
863 VEC(ld_plugin_symbol_resolution_t
,heap
) *);
864 extern void lto_data_in_delete (struct data_in
*);
867 /* In lto-streamer-out.c */
868 extern void lto_register_decl_definition (tree
, struct lto_file_decl_data
*);
869 extern struct output_block
*create_output_block (enum lto_section_type
);
870 extern void destroy_output_block (struct output_block
*);
871 extern void lto_output_tree (struct output_block
*, tree
, bool);
872 extern void produce_asm (struct output_block
*ob
, tree fn
);
875 /* In lto-cgraph.c */
876 struct cgraph_node
*lto_cgraph_encoder_deref (lto_cgraph_encoder_t
, int);
877 int lto_cgraph_encoder_lookup (lto_cgraph_encoder_t
, struct cgraph_node
*);
878 lto_cgraph_encoder_t
lto_cgraph_encoder_new (void);
879 int lto_cgraph_encoder_encode (lto_cgraph_encoder_t
, struct cgraph_node
*);
880 void lto_cgraph_encoder_delete (lto_cgraph_encoder_t
);
881 bool lto_cgraph_encoder_encode_body_p (lto_cgraph_encoder_t
,
882 struct cgraph_node
*);
884 bool lto_varpool_encoder_encode_body_p (lto_varpool_encoder_t
,
885 struct varpool_node
*);
886 struct varpool_node
*lto_varpool_encoder_deref (lto_varpool_encoder_t
, int);
887 int lto_varpool_encoder_lookup (lto_varpool_encoder_t
, struct varpool_node
*);
888 lto_varpool_encoder_t
lto_varpool_encoder_new (void);
889 int lto_varpool_encoder_encode (lto_varpool_encoder_t
, struct varpool_node
*);
890 void lto_varpool_encoder_delete (lto_varpool_encoder_t
);
891 bool lto_varpool_encoder_encode_initializer_p (lto_varpool_encoder_t
,
892 struct varpool_node
*);
893 void output_cgraph (cgraph_node_set
, varpool_node_set
);
894 void input_cgraph (void);
895 bool referenced_from_other_partition_p (struct ipa_ref_list
*,
897 varpool_node_set vset
);
898 bool reachable_from_other_partition_p (struct cgraph_node
*,
900 bool referenced_from_this_partition_p (struct ipa_ref_list
*,
902 varpool_node_set vset
);
903 bool reachable_from_this_partition_p (struct cgraph_node
*,
905 void compute_ltrans_boundary (struct lto_out_decl_state
*state
,
906 cgraph_node_set
, varpool_node_set
);
909 /* In lto-symtab.c. */
910 extern void lto_symtab_register_decl (tree
, ld_plugin_symbol_resolution_t
,
911 struct lto_file_decl_data
*);
912 extern void lto_symtab_merge_decls (void);
913 extern void lto_symtab_merge_cgraph_nodes (void);
914 extern tree
lto_symtab_prevailing_decl (tree decl
);
915 extern enum ld_plugin_symbol_resolution
lto_symtab_get_resolution (tree decl
);
916 extern void lto_symtab_free (void);
917 extern GTY(()) VEC(tree
,gc
) *lto_global_var_decls
;
921 extern void lto_register_user_option (size_t, const char *, int, int);
922 extern void lto_read_file_options (struct lto_file_decl_data
*);
923 extern void lto_write_options (void);
924 extern void lto_reissue_options (void);
925 void lto_clear_user_options (void);
926 void lto_clear_file_options (void);
929 /* In lto-wpa-fixup.c */
930 void lto_mark_nothrow_fndecl (tree
);
931 void lto_fixup_nothrow_decls (void);
934 /* Statistics gathered during LTO, WPA and LTRANS. */
935 extern struct lto_stats_d lto_stats
;
937 /* Section names corresponding to the values of enum lto_section_type. */
938 extern const char *lto_section_name
[];
940 /* Holds all the out decl states of functions output so far in the
941 current output file. */
942 extern VEC(lto_out_decl_state_ptr
, heap
) *lto_function_decl_states
;
944 /* Return true if LTO tag TAG corresponds to a tree code. */
946 lto_tag_is_tree_code_p (enum LTO_tags tag
)
948 return tag
> LTO_null
&& (unsigned) tag
<= NUM_TREE_CODES
;
952 /* Return true if LTO tag TAG corresponds to a gimple code. */
954 lto_tag_is_gimple_code_p (enum LTO_tags tag
)
956 return (unsigned) tag
>= NUM_TREE_CODES
+ 1
957 && (unsigned) tag
< 1 + NUM_TREE_CODES
+ LAST_AND_UNUSED_GIMPLE_CODE
;
961 /* Return the LTO tag corresponding to gimple code CODE. See enum
962 LTO_tags for details on the conversion. */
963 static inline enum LTO_tags
964 lto_gimple_code_to_tag (enum gimple_code code
)
966 return (enum LTO_tags
) ((unsigned) code
+ NUM_TREE_CODES
+ 1);
970 /* Return the GIMPLE code corresponding to TAG. See enum LTO_tags for
971 details on the conversion. */
972 static inline enum gimple_code
973 lto_tag_to_gimple_code (enum LTO_tags tag
)
975 gcc_assert (lto_tag_is_gimple_code_p (tag
));
976 return (enum gimple_code
) ((unsigned) tag
- NUM_TREE_CODES
- 1);
980 /* Return the LTO tag corresponding to tree code CODE. See enum
981 LTO_tags for details on the conversion. */
982 static inline enum LTO_tags
983 lto_tree_code_to_tag (enum tree_code code
)
985 return (enum LTO_tags
) ((unsigned) code
+ 1);
989 /* Return the tree code corresponding to TAG. See enum LTO_tags for
990 details on the conversion. */
991 static inline enum tree_code
992 lto_tag_to_tree_code (enum LTO_tags tag
)
994 gcc_assert (lto_tag_is_tree_code_p (tag
));
995 return (enum tree_code
) ((unsigned) tag
- 1);
998 /* Initialize an lto_out_decl_buffer ENCODER. */
1000 lto_init_tree_ref_encoder (struct lto_tree_ref_encoder
*encoder
,
1001 htab_hash hash_fn
, htab_eq eq_fn
)
1003 encoder
->tree_hash_table
= htab_create (37, hash_fn
, eq_fn
, free
);
1004 encoder
->next_index
= 0;
1005 encoder
->trees
= NULL
;
1009 /* Destory an lto_tree_ref_encoder ENCODER by freeing its contents. The
1010 memory used by ENCODER is not freed by this function. */
1012 lto_destroy_tree_ref_encoder (struct lto_tree_ref_encoder
*encoder
)
1014 /* Hash table may be delete already. */
1015 if (encoder
->tree_hash_table
)
1016 htab_delete (encoder
->tree_hash_table
);
1017 VEC_free (tree
, heap
, encoder
->trees
);
1020 /* Return the number of trees encoded in ENCODER. */
1021 static inline unsigned int
1022 lto_tree_ref_encoder_size (struct lto_tree_ref_encoder
*encoder
)
1024 return VEC_length (tree
, encoder
->trees
);
1027 /* Return the IDX-th tree in ENCODER. */
1029 lto_tree_ref_encoder_get_tree (struct lto_tree_ref_encoder
*encoder
,
1032 return VEC_index (tree
, encoder
->trees
, idx
);
1036 /* Return true if LABEL should be emitted in the global context. */
1038 emit_label_in_global_context_p (tree label
)
1040 return DECL_NONLOCAL (label
) || FORCED_LABEL (label
);
1043 /* Return true if tree node EXPR should be streamed as a builtin. For
1044 these nodes, we just emit the class and function code. */
1046 lto_stream_as_builtin_p (tree expr
)
1048 return (TREE_CODE (expr
) == FUNCTION_DECL
1049 && DECL_IS_BUILTIN (expr
)
1050 && (DECL_BUILT_IN_CLASS (expr
) == BUILT_IN_NORMAL
1051 || DECL_BUILT_IN_CLASS (expr
) == BUILT_IN_MD
));
1054 /* Return true if EXPR is a tree node that can be written to disk. */
1056 lto_is_streamable (tree expr
)
1058 enum tree_code code
= TREE_CODE (expr
);
1060 /* Notice that we reject SSA_NAMEs as well. We only emit the SSA
1061 name version in lto_output_tree_ref (see output_ssa_names). */
1062 return !is_lang_specific (expr
)
1064 && code
!= CALL_EXPR
1065 && code
!= LANG_TYPE
1066 && code
!= MODIFY_EXPR
1067 && code
!= INIT_EXPR
1068 && code
!= TARGET_EXPR
1069 && code
!= BIND_EXPR
1070 && code
!= WITH_CLEANUP_EXPR
1071 && code
!= STATEMENT_LIST
1072 && (code
== CASE_LABEL_EXPR
1073 || code
== DECL_EXPR
1074 || TREE_CODE_CLASS (code
) != tcc_statement
);
1077 DEFINE_DECL_STREAM_FUNCS (TYPE
, type
)
1078 DEFINE_DECL_STREAM_FUNCS (FIELD_DECL
, field_decl
)
1079 DEFINE_DECL_STREAM_FUNCS (FN_DECL
, fn_decl
)
1080 DEFINE_DECL_STREAM_FUNCS (VAR_DECL
, var_decl
)
1081 DEFINE_DECL_STREAM_FUNCS (TYPE_DECL
, type_decl
)
1082 DEFINE_DECL_STREAM_FUNCS (NAMESPACE_DECL
, namespace_decl
)
1083 DEFINE_DECL_STREAM_FUNCS (LABEL_DECL
, label_decl
)
1085 /* Returns a new bit-packing context for bit-packing into S. */
1086 static inline struct bitpack_d
1087 bitpack_create (struct lto_output_stream
*s
)
1089 struct bitpack_d bp
;
1092 bp
.stream
= (void *)s
;
1096 /* Pack the NBITS bit sized value VAL into the bit-packing context BP. */
1098 bp_pack_value (struct bitpack_d
*bp
, bitpack_word_t val
, unsigned nbits
)
1100 bitpack_word_t word
= bp
->word
;
1102 /* If val does not fit into the current bitpack word switch to the
1104 if (pos
+ nbits
> BITS_PER_BITPACK_WORD
)
1106 lto_output_uleb128_stream ((struct lto_output_stream
*) bp
->stream
, word
);
1119 /* Finishes bit-packing of BP. */
1121 lto_output_bitpack (struct bitpack_d
*bp
)
1123 lto_output_uleb128_stream ((struct lto_output_stream
*) bp
->stream
,
1129 /* Returns a new bit-packing context for bit-unpacking from IB. */
1130 static inline struct bitpack_d
1131 lto_input_bitpack (struct lto_input_block
*ib
)
1133 struct bitpack_d bp
;
1134 bp
.word
= lto_input_uleb128 (ib
);
1136 bp
.stream
= (void *)ib
;
1140 /* Unpacks NBITS bits from the bit-packing context BP and returns them. */
1141 static inline bitpack_word_t
1142 bp_unpack_value (struct bitpack_d
*bp
, unsigned nbits
)
1144 bitpack_word_t mask
, val
;
1147 mask
= (nbits
== BITS_PER_BITPACK_WORD
1148 ? (bitpack_word_t
) -1
1149 : ((bitpack_word_t
) 1 << nbits
) - 1);
1151 /* If there are not continuous nbits in the current bitpack word
1152 switch to the next one. */
1153 if (pos
+ nbits
> BITS_PER_BITPACK_WORD
)
1155 bp
->word
= val
= lto_input_uleb128 ((struct lto_input_block
*)bp
->stream
);
1161 bp
->pos
= pos
+ nbits
;
1166 #endif /* GCC_LTO_STREAMER_H */