1 /* Miscellaneous utilities for tree streaming. Things that are used
2 in both input and output are here.
4 Copyright (C) 2011-2014 Free Software Foundation, Inc.
5 Contributed by Diego Novillo <dnovillo@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/>. */
25 #include "coretypes.h"
27 #include "basic-block.h"
28 #include "tree-ssa-alias.h"
29 #include "internal-fn.h"
30 #include "gimple-expr.h"
33 #include "streamer-hooks.h"
34 #include "tree-streamer.h"
36 /* Check that all the TS_* structures handled by the streamer_write_* and
37 streamer_read_* routines are exactly ALL the structures defined in
41 streamer_check_handled_ts_structures (void)
43 bool handled_p
[LAST_TS_ENUM
];
46 memset (&handled_p
, 0, sizeof (handled_p
));
48 /* These are the TS_* structures that are either handled or
49 explicitly ignored by the streamer routines. */
50 handled_p
[TS_BASE
] = true;
51 handled_p
[TS_TYPED
] = true;
52 handled_p
[TS_COMMON
] = true;
53 handled_p
[TS_INT_CST
] = true;
54 handled_p
[TS_REAL_CST
] = true;
55 handled_p
[TS_FIXED_CST
] = true;
56 handled_p
[TS_VECTOR
] = true;
57 handled_p
[TS_STRING
] = true;
58 handled_p
[TS_COMPLEX
] = true;
59 handled_p
[TS_IDENTIFIER
] = true;
60 handled_p
[TS_DECL_MINIMAL
] = true;
61 handled_p
[TS_DECL_COMMON
] = true;
62 handled_p
[TS_DECL_WRTL
] = true;
63 handled_p
[TS_DECL_NON_COMMON
] = true;
64 handled_p
[TS_DECL_WITH_VIS
] = true;
65 handled_p
[TS_FIELD_DECL
] = true;
66 handled_p
[TS_VAR_DECL
] = true;
67 handled_p
[TS_PARM_DECL
] = true;
68 handled_p
[TS_LABEL_DECL
] = true;
69 handled_p
[TS_RESULT_DECL
] = true;
70 handled_p
[TS_CONST_DECL
] = true;
71 handled_p
[TS_TYPE_DECL
] = true;
72 handled_p
[TS_FUNCTION_DECL
] = true;
73 handled_p
[TS_TYPE_COMMON
] = true;
74 handled_p
[TS_TYPE_WITH_LANG_SPECIFIC
] = true;
75 handled_p
[TS_TYPE_NON_COMMON
] = true;
76 handled_p
[TS_LIST
] = true;
77 handled_p
[TS_VEC
] = true;
78 handled_p
[TS_EXP
] = true;
79 handled_p
[TS_SSA_NAME
] = true;
80 handled_p
[TS_BLOCK
] = true;
81 handled_p
[TS_BINFO
] = true;
82 handled_p
[TS_STATEMENT_LIST
] = true;
83 handled_p
[TS_CONSTRUCTOR
] = true;
84 handled_p
[TS_OMP_CLAUSE
] = true;
85 handled_p
[TS_OPTIMIZATION
] = true;
86 handled_p
[TS_TARGET_OPTION
] = true;
87 handled_p
[TS_TRANSLATION_UNIT_DECL
] = true;
89 /* Anything not marked above will trigger the following assertion.
90 If this assertion triggers, it means that there is a new TS_*
91 structure that should be handled by the streamer. */
92 for (i
= 0; i
< LAST_TS_ENUM
; i
++)
93 gcc_assert (handled_p
[i
]);
97 /* Helper for streamer_tree_cache_insert_1. Add T to CACHE->NODES at
101 streamer_tree_cache_add_to_node_array (struct streamer_tree_cache_d
*cache
,
102 unsigned ix
, tree t
, hashval_t hash
)
104 /* Make sure we're either replacing an old element or
105 appending consecutively. */
106 gcc_assert (ix
<= cache
->nodes
.length ());
108 if (ix
== cache
->nodes
.length ())
110 cache
->nodes
.safe_push (t
);
111 if (cache
->hashes
.exists ())
112 cache
->hashes
.safe_push (hash
);
116 cache
->nodes
[ix
] = t
;
117 if (cache
->hashes
.exists ())
118 cache
->hashes
[ix
] = hash
;
123 /* Helper for streamer_tree_cache_insert and streamer_tree_cache_insert_at.
124 CACHE, T, and IX_P are as in streamer_tree_cache_insert.
126 If INSERT_AT_NEXT_SLOT_P is true, T is inserted at the next available
127 slot in the cache. Otherwise, T is inserted at the position indicated
130 If T already existed in CACHE, return true. Otherwise,
134 streamer_tree_cache_insert_1 (struct streamer_tree_cache_d
*cache
,
135 tree t
, hashval_t hash
, unsigned *ix_p
,
136 bool insert_at_next_slot_p
)
144 slot
= cache
->node_map
->insert (t
, &existed_p
);
147 /* Determine the next slot to use in the cache. */
148 if (insert_at_next_slot_p
)
149 ix
= cache
->nodes
.length ();
154 streamer_tree_cache_add_to_node_array (cache
, ix
, t
, hash
);
160 if (!insert_at_next_slot_p
&& ix
!= *ix_p
)
162 /* If the caller wants to insert T at a specific slot
163 location, and ENTRY->TO does not match *IX_P, add T to
164 the requested location slot. */
166 streamer_tree_cache_add_to_node_array (cache
, ix
, t
, hash
);
178 /* Insert tree node T in CACHE. If T already existed in the cache
179 return true. Otherwise, return false.
181 If IX_P is non-null, update it with the index into the cache where
182 T has been stored. */
185 streamer_tree_cache_insert (struct streamer_tree_cache_d
*cache
, tree t
,
186 hashval_t hash
, unsigned *ix_p
)
188 return streamer_tree_cache_insert_1 (cache
, t
, hash
, ix_p
, true);
192 /* Replace the tree node with T in CACHE at slot IX. */
195 streamer_tree_cache_replace_tree (struct streamer_tree_cache_d
*cache
,
199 if (cache
->hashes
.exists ())
200 hash
= streamer_tree_cache_get_hash (cache
, ix
);
201 if (!cache
->node_map
)
202 streamer_tree_cache_add_to_node_array (cache
, ix
, t
, hash
);
204 streamer_tree_cache_insert_1 (cache
, t
, hash
, &ix
, false);
208 /* Appends tree node T to CACHE, even if T already existed in it. */
211 streamer_tree_cache_append (struct streamer_tree_cache_d
*cache
,
212 tree t
, hashval_t hash
)
214 unsigned ix
= cache
->nodes
.length ();
215 if (!cache
->node_map
)
216 streamer_tree_cache_add_to_node_array (cache
, ix
, t
, hash
);
218 streamer_tree_cache_insert_1 (cache
, t
, hash
, &ix
, false);
221 /* Return true if tree node T exists in CACHE, otherwise false. If IX_P is
222 not NULL, write to *IX_P the index into the cache where T is stored
223 ((unsigned)-1 if T is not found). */
226 streamer_tree_cache_lookup (struct streamer_tree_cache_d
*cache
, tree t
,
235 slot
= cache
->node_map
->contains (t
);
254 /* Record NODE in CACHE. */
257 record_common_node (struct streamer_tree_cache_d
*cache
, tree node
)
259 /* If we recursively end up at nodes we do not want to preload simply don't.
260 ??? We'd want to verify that this doesn't happen, or alternatively
261 do not recurse at all. */
262 if (node
== char_type_node
)
265 gcc_checking_assert (node
!= boolean_type_node
266 && node
!= boolean_true_node
267 && node
!= boolean_false_node
268 && node
!= double_type_node
);
270 /* We have to make sure to fill exactly the same number of
271 elements for all frontends. That can include NULL trees.
272 As our hash table can't deal with zero entries we'll simply stream
273 a random other tree. A NULL tree never will be looked up so it
274 doesn't matter which tree we replace it with, just to be sure
275 use error_mark_node. */
277 node
= error_mark_node
;
279 /* ??? FIXME, devise a better hash value. But the hash needs to be equal
280 for all frontend and lto1 invocations. So just use the position
281 in the cache as hash value. */
282 streamer_tree_cache_append (cache
, node
, cache
->nodes
.length ());
284 if (POINTER_TYPE_P (node
)
285 || TREE_CODE (node
) == COMPLEX_TYPE
286 || TREE_CODE (node
) == ARRAY_TYPE
)
287 record_common_node (cache
, TREE_TYPE (node
));
288 else if (TREE_CODE (node
) == RECORD_TYPE
)
290 /* The FIELD_DECLs of structures should be shared, so that every
291 COMPONENT_REF uses the same tree node when referencing a field.
292 Pointer equality between FIELD_DECLs is used by the alias
293 machinery to compute overlapping component references (see
294 nonoverlapping_component_refs_p and
295 nonoverlapping_component_refs_of_decl_p). */
296 for (tree f
= TYPE_FIELDS (node
); f
; f
= TREE_CHAIN (f
))
297 record_common_node (cache
, f
);
302 /* Preload common nodes into CACHE and make sure they are merged
303 properly according to the gimple type table. */
306 preload_common_nodes (struct streamer_tree_cache_d
*cache
)
310 for (i
= 0; i
< itk_none
; i
++)
311 /* Skip itk_char. char_type_node is dependent on -f[un]signed-char. */
313 record_common_node (cache
, integer_types
[i
]);
315 for (i
= 0; i
< stk_type_kind_last
; i
++)
316 record_common_node (cache
, sizetype_tab
[i
]);
318 for (i
= 0; i
< TI_MAX
; i
++)
319 /* Skip boolean type and constants. They are frontend dependent.
320 Skip double type, frontend dependent due to -fshort-double. */
321 if (i
!= TI_BOOLEAN_TYPE
322 && i
!= TI_BOOLEAN_FALSE
323 && i
!= TI_BOOLEAN_TRUE
324 && i
!= TI_DOUBLE_TYPE
325 && i
!= TI_COMPLEX_DOUBLE_TYPE
326 && i
!= TI_DOUBLE_PTR_TYPE
)
327 record_common_node (cache
, global_trees
[i
]);
331 /* Create a cache of pickled nodes. */
333 struct streamer_tree_cache_d
*
334 streamer_tree_cache_create (bool with_hashes
, bool with_map
)
336 struct streamer_tree_cache_d
*cache
;
338 cache
= XCNEW (struct streamer_tree_cache_d
);
341 cache
->node_map
= new pointer_map
<unsigned>;
342 cache
->nodes
.create (165);
344 cache
->hashes
.create (165);
346 /* Load all the well-known tree nodes that are always created by
347 the compiler on startup. This prevents writing them out
349 preload_common_nodes (cache
);
355 /* Delete the streamer cache C. */
358 streamer_tree_cache_delete (struct streamer_tree_cache_d
*c
)
366 c
->hashes
.release ();