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