svn merge -r215707:216846 svn+ssh://gcc.gnu.org/svn/gcc/trunk
[official-gcc.git] / gcc / lto-streamer.c
blob00171a3b9d871c9b469b02f2bc5505c2bfed08a5
1 /* Miscellaneous utilities for GIMPLE streaming. Things that are used
2 in both input and output are here.
4 Copyright (C) 2009-2014 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 #include "config.h"
24 #include "system.h"
25 #include "coretypes.h"
26 #include "tm.h"
27 #include "toplev.h"
28 #include "flags.h"
29 #include "tree.h"
30 #include "predict.h"
31 #include "vec.h"
32 #include "hashtab.h"
33 #include "hash-set.h"
34 #include "machmode.h"
35 #include "hard-reg-set.h"
36 #include "input.h"
37 #include "function.h"
38 #include "basic-block.h"
39 #include "tree-ssa-alias.h"
40 #include "internal-fn.h"
41 #include "gimple-expr.h"
42 #include "is-a.h"
43 #include "gimple.h"
44 #include "bitmap.h"
45 #include "diagnostic-core.h"
46 #include "hash-map.h"
47 #include "plugin-api.h"
48 #include "ipa-ref.h"
49 #include "cgraph.h"
50 #include "tree-streamer.h"
51 #include "lto-streamer.h"
52 #include "lto-section-names.h"
53 #include "streamer-hooks.h"
55 /* Statistics gathered during LTO, WPA and LTRANS. */
56 struct lto_stats_d lto_stats;
58 /* LTO uses bitmaps with different life-times. So use a separate
59 obstack for all LTO bitmaps. */
60 static bitmap_obstack lto_obstack;
61 static bool lto_obstack_initialized;
63 const char *section_name_prefix = LTO_SECTION_NAME_PREFIX;
65 /* Return a string representing LTO tag TAG. */
67 const char *
68 lto_tag_name (enum LTO_tags tag)
70 if (lto_tag_is_tree_code_p (tag))
72 /* For tags representing tree nodes, return the name of the
73 associated tree code. */
74 return get_tree_code_name (lto_tag_to_tree_code (tag));
77 if (lto_tag_is_gimple_code_p (tag))
79 /* For tags representing gimple statements, return the name of
80 the associated gimple code. */
81 return gimple_code_name[lto_tag_to_gimple_code (tag)];
84 switch (tag)
86 case LTO_null:
87 return "LTO_null";
88 case LTO_bb0:
89 return "LTO_bb0";
90 case LTO_bb1:
91 return "LTO_bb1";
92 case LTO_eh_region:
93 return "LTO_eh_region";
94 case LTO_function:
95 return "LTO_function";
96 case LTO_eh_table:
97 return "LTO_eh_table";
98 case LTO_ert_cleanup:
99 return "LTO_ert_cleanup";
100 case LTO_ert_try:
101 return "LTO_ert_try";
102 case LTO_ert_allowed_exceptions:
103 return "LTO_ert_allowed_exceptions";
104 case LTO_ert_must_not_throw:
105 return "LTO_ert_must_not_throw";
106 case LTO_tree_pickle_reference:
107 return "LTO_tree_pickle_reference";
108 case LTO_field_decl_ref:
109 return "LTO_field_decl_ref";
110 case LTO_function_decl_ref:
111 return "LTO_function_decl_ref";
112 case LTO_label_decl_ref:
113 return "LTO_label_decl_ref";
114 case LTO_namespace_decl_ref:
115 return "LTO_namespace_decl_ref";
116 case LTO_result_decl_ref:
117 return "LTO_result_decl_ref";
118 case LTO_ssa_name_ref:
119 return "LTO_ssa_name_ref";
120 case LTO_type_decl_ref:
121 return "LTO_type_decl_ref";
122 case LTO_type_ref:
123 return "LTO_type_ref";
124 case LTO_global_decl_ref:
125 return "LTO_global_decl_ref";
126 default:
127 return "LTO_UNKNOWN";
132 /* Allocate a bitmap from heap. Initializes the LTO obstack if necessary. */
134 bitmap
135 lto_bitmap_alloc (void)
137 if (!lto_obstack_initialized)
139 bitmap_obstack_initialize (&lto_obstack);
140 lto_obstack_initialized = true;
142 return BITMAP_ALLOC (&lto_obstack);
145 /* Free bitmap B. */
147 void
148 lto_bitmap_free (bitmap b)
150 BITMAP_FREE (b);
154 /* Get a section name for a particular type or name. The NAME field
155 is only used if SECTION_TYPE is LTO_section_function_body. For all
156 others it is ignored. The callee of this function is responsible
157 to free the returned name. */
159 char *
160 lto_get_section_name (int section_type, const char *name, struct lto_file_decl_data *f)
162 const char *add;
163 char post[32];
164 const char *sep;
166 if (section_type == LTO_section_function_body)
168 gcc_assert (name != NULL);
169 if (name[0] == '*')
170 name++;
171 add = name;
172 sep = "";
174 else if (section_type < LTO_N_SECTION_TYPES)
176 add = lto_section_name[section_type];
177 sep = ".";
179 else
180 internal_error ("bytecode stream: unexpected LTO section %s", name);
182 /* Make the section name unique so that ld -r combining sections
183 doesn't confuse the reader with merged sections.
185 For options don't add a ID, the option reader cannot deal with them
186 and merging should be ok here. */
187 if (section_type == LTO_section_opts)
188 strcpy (post, "");
189 else if (f != NULL)
190 sprintf (post, "." HOST_WIDE_INT_PRINT_HEX_PURE, f->id);
191 else
192 sprintf (post, "." HOST_WIDE_INT_PRINT_HEX_PURE, get_random_seed (false));
193 return concat (section_name_prefix, sep, add, post, NULL);
197 /* Show various memory usage statistics related to LTO. */
199 void
200 print_lto_report (const char *s)
202 unsigned i;
204 fprintf (stderr, "[%s] # of input files: "
205 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s, lto_stats.num_input_files);
207 fprintf (stderr, "[%s] # of input cgraph nodes: "
208 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
209 lto_stats.num_input_cgraph_nodes);
211 fprintf (stderr, "[%s] # of function bodies: "
212 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
213 lto_stats.num_function_bodies);
215 for (i = 0; i < NUM_TREE_CODES; i++)
216 if (lto_stats.num_trees[i])
217 fprintf (stderr, "[%s] # of '%s' objects read: "
218 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
219 get_tree_code_name ((enum tree_code) i), lto_stats.num_trees[i]);
221 if (flag_lto)
223 fprintf (stderr, "[%s] Compression: "
224 HOST_WIDE_INT_PRINT_UNSIGNED " output bytes, "
225 HOST_WIDE_INT_PRINT_UNSIGNED " compressed bytes", s,
226 lto_stats.num_output_il_bytes,
227 lto_stats.num_compressed_il_bytes);
228 if (lto_stats.num_output_il_bytes > 0)
230 const float dividend = (float) lto_stats.num_compressed_il_bytes;
231 const float divisor = (float) lto_stats.num_output_il_bytes;
232 fprintf (stderr, " (ratio: %f)", dividend / divisor);
234 fprintf (stderr, "\n");
237 if (flag_wpa)
239 fprintf (stderr, "[%s] # of output files: "
240 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
241 lto_stats.num_output_files);
243 fprintf (stderr, "[%s] # of output symtab nodes: "
244 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
245 lto_stats.num_output_symtab_nodes);
247 fprintf (stderr, "[%s] # of output tree pickle references: "
248 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
249 lto_stats.num_pickle_refs_output);
250 fprintf (stderr, "[%s] # of output tree bodies: "
251 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
252 lto_stats.num_tree_bodies_output);
254 fprintf (stderr, "[%s] # callgraph partitions: "
255 HOST_WIDE_INT_PRINT_UNSIGNED "\n", s,
256 lto_stats.num_cgraph_partitions);
258 fprintf (stderr, "[%s] Compression: "
259 HOST_WIDE_INT_PRINT_UNSIGNED " input bytes, "
260 HOST_WIDE_INT_PRINT_UNSIGNED " uncompressed bytes", s,
261 lto_stats.num_input_il_bytes,
262 lto_stats.num_uncompressed_il_bytes);
263 if (lto_stats.num_input_il_bytes > 0)
265 const float dividend = (float) lto_stats.num_uncompressed_il_bytes;
266 const float divisor = (float) lto_stats.num_input_il_bytes;
267 fprintf (stderr, " (ratio: %f)", dividend / divisor);
269 fprintf (stderr, "\n");
272 for (i = 0; i < LTO_N_SECTION_TYPES; i++)
273 fprintf (stderr, "[%s] Size of mmap'd section %s: "
274 HOST_WIDE_INT_PRINT_UNSIGNED " bytes\n", s,
275 lto_section_name[i], lto_stats.section_size[i]);
279 #ifdef LTO_STREAMER_DEBUG
280 struct tree_hash_entry
282 tree key;
283 intptr_t value;
286 struct tree_entry_hasher : typed_noop_remove <tree_hash_entry>
288 typedef tree_hash_entry value_type;
289 typedef tree_hash_entry compare_type;
290 static inline hashval_t hash (const value_type *);
291 static inline bool equal (const value_type *, const compare_type *);
294 inline hashval_t
295 tree_entry_hasher::hash (const value_type *e)
297 return htab_hash_pointer (e->key);
300 inline bool
301 tree_entry_hasher::equal (const value_type *e1, const compare_type *e2)
303 return (e1->key == e2->key);
306 static hash_table<tree_hash_entry> *tree_htab;
307 #endif
309 /* Initialization common to the LTO reader and writer. */
311 void
312 lto_streamer_init (void)
314 /* Check that all the TS_* handled by the reader and writer routines
315 match exactly the structures defined in treestruct.def. When a
316 new TS_* astructure is added, the streamer should be updated to
317 handle it. */
318 streamer_check_handled_ts_structures ();
320 #ifdef LTO_STREAMER_DEBUG
321 tree_htab = new hash_table<tree_hash_entry> (31);
322 #endif
326 /* Gate function for all LTO streaming passes. */
328 bool
329 gate_lto_out (void)
331 return ((flag_generate_lto || in_lto_p || flag_openacc || flag_openmp)
332 /* Don't bother doing anything if the program has errors. */
333 && !seen_error ());
337 #ifdef LTO_STREAMER_DEBUG
338 /* Add a mapping between T and ORIG_T, which is the numeric value of
339 the original address of T as it was seen by the LTO writer. This
340 mapping is useful when debugging streaming problems. A debugging
341 session can be started on both reader and writer using ORIG_T
342 as a breakpoint value in both sessions.
344 Note that this mapping is transient and only valid while T is
345 being reconstructed. Once T is fully built, the mapping is
346 removed. */
348 void
349 lto_orig_address_map (tree t, intptr_t orig_t)
351 struct tree_hash_entry ent;
352 struct tree_hash_entry **slot;
354 ent.key = t;
355 ent.value = orig_t;
356 slot = tree_htab->find_slot (&ent, INSERT);
357 gcc_assert (!*slot);
358 *slot = XNEW (struct tree_hash_entry);
359 **slot = ent;
363 /* Get the original address of T as it was seen by the writer. This
364 is only valid while T is being reconstructed. */
366 intptr_t
367 lto_orig_address_get (tree t)
369 struct tree_hash_entry ent;
370 struct tree_hash_entry **slot;
372 ent.key = t;
373 slot = tree_htab->find_slot (&ent, NO_INSERT);
374 return (slot ? (*slot)->value : 0);
378 /* Clear the mapping of T to its original address. */
380 void
381 lto_orig_address_remove (tree t)
383 struct tree_hash_entry ent;
384 struct tree_hash_entry **slot;
386 ent.key = t;
387 slot = tree_htab->find_slot (&ent, NO_INSERT);
388 gcc_assert (slot);
389 free (*slot);
390 tree_htab->clear_slot (slot);
392 #endif
395 /* Check that the version MAJOR.MINOR is the correct version number. */
397 void
398 lto_check_version (int major, int minor)
400 if (major != LTO_major_version || minor != LTO_minor_version)
401 fatal_error ("bytecode stream generated with LTO version %d.%d instead "
402 "of the expected %d.%d",
403 major, minor,
404 LTO_major_version, LTO_minor_version);
408 /* Initialize all the streamer hooks used for streaming GIMPLE. */
410 void
411 lto_streamer_hooks_init (void)
413 streamer_hooks_init ();
414 streamer_hooks.write_tree = lto_output_tree;
415 streamer_hooks.read_tree = lto_input_tree;
416 streamer_hooks.input_location = lto_input_location;
417 streamer_hooks.output_location = lto_output_location;