1 /* Interprocedural semantic function equality pass
2 Copyright (C) 2014-2015 Free Software Foundation, Inc.
4 Contributed by Jan Hubicka <hubicka@ucw.cz> and Martin Liska <mliska@suse.cz>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
25 /* Congruence class encompasses a collection of either functions or
26 read-only variables. These items are considered to be equivalent
27 if not proved the oposite. */
28 class congruence_class
31 /* Congruence class constructor for a new class with _ID. */
32 congruence_class (unsigned int _id
): in_worklist (false), id(_id
)
41 /* Dump function prints all class members to a FILE with an INDENT. */
42 void dump (FILE *file
, unsigned int indent
= 0) const;
44 /* Returns true if there's a member that is used from another group. */
45 bool is_class_used (void);
47 /* Flag is used in case we want to remove a class from worklist and
48 delete operation is quite expensive for
49 the data structure (linked list). */
52 /* Vector of all group members. */
53 auto_vec
<sem_item
*> members
;
55 /* Global unique class identifier. */
59 /* Semantic item type enum. */
66 /* Class is container for address references for a symtab_node. */
68 class symbol_compare_collection
72 symbol_compare_collection (symtab_node
*node
);
75 ~symbol_compare_collection ()
77 m_references
.release ();
78 m_interposables
.release ();
81 /* Vector of address references. */
82 vec
<symtab_node
*> m_references
;
84 /* Vector of interposable references. */
85 vec
<symtab_node
*> m_interposables
;
88 /* Hash traits for symbol_compare_collection map. */
90 struct symbol_compare_hashmap_traits
: default_hashmap_traits
93 hash (const symbol_compare_collection
*v
)
96 hstate
.add_int (v
->m_references
.length ());
98 for (unsigned i
= 0; i
< v
->m_references
.length (); i
++)
99 hstate
.add_int (v
->m_references
[i
]->ultimate_alias_target ()->order
);
101 hstate
.add_int (v
->m_interposables
.length ());
103 for (unsigned i
= 0; i
< v
->m_interposables
.length (); i
++)
104 hstate
.add_int (v
->m_interposables
[i
]->ultimate_alias_target ()->order
);
106 return hstate
.end ();
110 equal_keys (const symbol_compare_collection
*a
,
111 const symbol_compare_collection
*b
)
113 if (a
->m_references
.length () != b
->m_references
.length ()
114 || a
->m_interposables
.length () != b
->m_interposables
.length ())
117 for (unsigned i
= 0; i
< a
->m_references
.length (); i
++)
118 if (a
->m_references
[i
]->equal_address_to (b
->m_references
[i
]) != 1)
121 for (unsigned i
= 0; i
< a
->m_interposables
.length (); i
++)
122 if (!a
->m_interposables
[i
]->semantically_equivalent_p
123 (b
->m_interposables
[i
]))
131 /* Semantic item usage pair. */
135 /* Constructor for key value pair, where _ITEM is key and _INDEX is a target. */
136 sem_usage_pair (sem_item
*_item
, unsigned int _index
);
138 /* Target semantic item where an item is used. */
141 /* Index of usage of such an item. */
145 /* Semantic item is a base class that encapsulates all shared functionality
146 for both semantic function and variable items. */
150 /* Semantic item constructor for a node of _TYPE, where STACK is used
151 for bitmap memory allocation. */
152 sem_item (sem_item_type _type
, bitmap_obstack
*stack
);
154 /* Semantic item constructor for a node of _TYPE, where STACK is used
155 for bitmap memory allocation. The item is based on symtab node _NODE
156 with computed _HASH. */
157 sem_item (sem_item_type _type
, symtab_node
*_node
, hashval_t _hash
,
158 bitmap_obstack
*stack
);
160 virtual ~sem_item ();
162 /* Dump function for debugging purpose. */
163 DEBUG_FUNCTION
void dump (void);
165 /* Initialize semantic item by info reachable during LTO WPA phase. */
166 virtual void init_wpa (void) = 0;
168 /* Semantic item initialization function. */
169 virtual void init (void) = 0;
171 /* Add reference to a semantic TARGET. */
172 void add_reference (sem_item
*target
);
174 /* Fast equality function based on knowledge known in WPA. */
175 virtual bool equals_wpa (sem_item
*item
,
176 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
) = 0;
178 /* Returns true if the item equals to ITEM given as arguemnt. */
179 virtual bool equals (sem_item
*item
,
180 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
) = 0;
182 /* References independent hash function. */
183 virtual hashval_t
get_hash (void) = 0;
185 /* Merges instance with an ALIAS_ITEM, where alias, thunk or redirection can
187 virtual bool merge (sem_item
*alias_item
) = 0;
189 /* Dump symbol to FILE. */
190 virtual void dump_to_file (FILE *file
) = 0;
192 /* Update hash by address sensitive references. */
193 void update_hash_by_addr_refs (hash_map
<symtab_node
*,
194 sem_item
*> &m_symtab_node_map
);
196 /* Update hash by computed local hash values taken from different
198 void update_hash_by_local_refs (hash_map
<symtab_node
*,
199 sem_item
*> &m_symtab_node_map
);
201 /* Return base tree that can be used for compatible_types_p and
202 contains_polymorphic_type_p comparison. */
203 static bool get_base_types (tree
*t1
, tree
*t2
);
205 /* Return true if target supports alias symbols. */
206 bool target_supports_symbol_aliases_p (void);
214 /* Declaration tree node. */
217 /* Semantic references used that generate congruence groups. */
218 vec
<sem_item
*> refs
;
220 /* Pointer to a congruence class the item belongs to. */
221 congruence_class
*cls
;
223 /* Index of the item in a class belonging to. */
224 unsigned int index_in_class
;
226 /* List of semantic items where the instance is used. */
227 vec
<sem_usage_pair
*> usages
;
229 /* A bitmap with indices of all classes referencing this item. */
230 bitmap usage_index_bitmap
;
232 /* List of tree references (either FUNC_DECL or VAR_DECL). */
233 vec
<tree
> tree_refs
;
235 /* A set with symbol table references. */
236 hash_set
<symtab_node
*> refs_set
;
241 /* Temporary hash used where hash values of references are added. */
242 hashval_t global_hash
;
244 /* Cached, once calculated hash for the item. */
246 /* Accumulate to HSTATE a hash of expression EXP. */
247 static void add_expr (const_tree exp
, inchash::hash
&hstate
);
248 /* Accumulate to HSTATE a hash of type T. */
249 static void add_type (const_tree t
, inchash::hash
&hstate
);
251 /* Compare properties of symbol that does not affect semantics of symbol
252 itself but affects semantics of its references.
253 If ADDRESS is true, do extra checking needed for IPA_REF_ADDR. */
254 static bool compare_referenced_symbol_properties (symtab_node
*used_by
,
259 /* Compare two attribute lists. */
260 static bool compare_attributes (const_tree list1
, const_tree list2
);
262 /* Hash properties compared by compare_referenced_symbol_properties. */
263 void hash_referenced_symbol_properties (symtab_node
*ref
,
264 inchash::hash
&hstate
,
267 /* For a given symbol table nodes N1 and N2, we check that FUNCTION_DECLs
268 point to a same function. Comparison can be skipped if IGNORED_NODES
269 contains these nodes. ADDRESS indicate if address is taken. */
270 bool compare_symbol_references (hash_map
<symtab_node
*, sem_item
*>
272 symtab_node
*n1
, symtab_node
*n2
,
276 /* Initialize internal data structures. Bitmap STACK is used for
277 bitmap memory allocation process. */
278 void setup (bitmap_obstack
*stack
);
281 class sem_function
: public sem_item
284 /* Semantic function constructor that uses STACK as bitmap memory stack. */
285 sem_function (bitmap_obstack
*stack
);
287 /* Constructor based on callgraph node _NODE with computed hash _HASH.
288 Bitmap STACK is used for memory allocation. */
289 sem_function (cgraph_node
*_node
, hashval_t _hash
, bitmap_obstack
*stack
);
293 inline virtual void init_wpa (void)
298 virtual void init (void);
299 virtual bool equals_wpa (sem_item
*item
,
300 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
);
301 virtual hashval_t
get_hash (void);
302 virtual bool equals (sem_item
*item
,
303 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
);
304 virtual bool merge (sem_item
*alias_item
);
306 /* Dump symbol to FILE. */
307 virtual void dump_to_file (FILE *file
)
310 dump_function_to_file (decl
, file
, TDF_DETAILS
);
313 /* Parses function arguments and result type. */
314 void parse_tree_args (void);
316 /* Returns cgraph_node. */
317 inline cgraph_node
*get_node (void)
319 return dyn_cast
<cgraph_node
*> (node
);
322 /* Improve accumulated hash for HSTATE based on a gimple statement STMT. */
323 void hash_stmt (gimple stmt
, inchash::hash
&inchash
);
325 /* Return true if polymorphic comparison must be processed. */
326 bool compare_polymorphic_p (void);
328 /* For a given call graph NODE, the function constructs new
329 semantic function item. */
330 static sem_function
*parse (cgraph_node
*node
, bitmap_obstack
*stack
);
332 /* Exception handling region tree. */
333 eh_region region_tree
;
335 /* Result type tree node. */
338 /* Array of argument tree types. */
339 vec
<tree
> arg_types
;
341 /* Number of function arguments. */
342 unsigned int arg_count
;
344 /* Total amount of edges in the function. */
345 unsigned int edge_count
;
347 /* Vector of sizes of all basic blocks. */
348 vec
<unsigned int> bb_sizes
;
350 /* Control flow graph checksum. */
351 hashval_t cfg_checksum
;
353 /* GIMPLE codes hash value. */
354 hashval_t gcode_hash
;
356 /* Total number of SSA names used in the function. */
357 unsigned ssa_names_size
;
359 /* Array of structures for all basic blocks. */
360 vec
<ipa_icf_gimple::sem_bb
*> bb_sorted
;
362 /* Return true if parameter I may be used. */
363 bool param_used_p (unsigned int i
);
366 /* Calculates hash value based on a BASIC_BLOCK. */
367 hashval_t
get_bb_hash (const ipa_icf_gimple::sem_bb
*basic_block
);
369 /* For given basic blocks BB1 and BB2 (from functions FUNC1 and FUNC),
370 true value is returned if phi nodes are semantically
371 equivalent in these blocks . */
372 bool compare_phi_node (basic_block bb1
, basic_block bb2
);
374 /* Basic blocks dictionary BB_DICT returns true if SOURCE index BB
375 corresponds to TARGET. */
376 bool bb_dict_test (vec
<int> *bb_dict
, int source
, int target
);
378 /* If cgraph edges E1 and E2 are indirect calls, verify that
379 ICF flags are the same. */
380 bool compare_edge_flags (cgraph_edge
*e1
, cgraph_edge
*e2
);
382 /* Processes function equality comparison. */
383 bool equals_private (sem_item
*item
,
384 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
);
386 /* Returns true if tree T can be compared as a handled component. */
387 static bool icf_handled_component_p (tree t
);
389 /* Function checker stores binding between functions. */
390 ipa_icf_gimple::func_checker
*m_checker
;
392 /* COMPARED_FUNC is a function that we compare to. */
393 sem_function
*m_compared_func
;
394 }; // class sem_function
396 class sem_variable
: public sem_item
399 /* Semantic variable constructor that uses STACK as bitmap memory stack. */
400 sem_variable (bitmap_obstack
*stack
);
402 /* Constructor based on callgraph node _NODE with computed hash _HASH.
403 Bitmap STACK is used for memory allocation. */
405 sem_variable (varpool_node
*_node
, hashval_t _hash
, bitmap_obstack
*stack
);
407 inline virtual void init_wpa (void) {}
409 /* Semantic variable initialization function. */
410 inline virtual void init (void)
412 decl
= get_node ()->decl
;
415 virtual hashval_t
get_hash (void);
416 virtual bool merge (sem_item
*alias_item
);
417 virtual void dump_to_file (FILE *file
);
418 virtual bool equals (sem_item
*item
,
419 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
);
421 /* Fast equality variable based on knowledge known in WPA. */
422 virtual bool equals_wpa (sem_item
*item
,
423 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
);
425 /* Returns varpool_node. */
426 inline varpool_node
*get_node (void)
428 return dyn_cast
<varpool_node
*> (node
);
431 /* Parser function that visits a varpool NODE. */
432 static sem_variable
*parse (varpool_node
*node
, bitmap_obstack
*stack
);
435 /* Compares trees T1 and T2 for semantic equality. */
436 static bool equals (tree t1
, tree t2
);
437 }; // class sem_variable
439 class sem_item_optimizer
;
441 struct congruence_class_group
445 vec
<congruence_class
*> classes
;
448 /* Congruence class set structure. */
449 struct congruence_class_group_hash
: typed_noop_remove
<congruence_class_group
>
451 typedef congruence_class_group
*value_type
;
452 typedef congruence_class_group
*compare_type
;
454 static inline hashval_t
hash (const congruence_class_group
*item
)
459 static inline int equal (const congruence_class_group
*item1
,
460 const congruence_class_group
*item2
)
462 return item1
->hash
== item2
->hash
&& item1
->type
== item2
->type
;
466 struct traverse_split_pair
468 sem_item_optimizer
*optimizer
;
469 class congruence_class
*cls
;
472 /* Semantic item optimizer includes all top-level logic
473 related to semantic equality comparison. */
474 class sem_item_optimizer
477 sem_item_optimizer ();
478 ~sem_item_optimizer ();
480 /* Function responsible for visiting all potential functions and
481 read-only variables that can be merged. */
482 void parse_funcs_and_vars (void);
484 /* Optimizer entry point which returns true in case it processes
485 a merge operation. True is returned if there's a merge operation
492 /* Verify congruence classes if checking is enabled. */
493 void verify_classes (void);
495 /* Write IPA ICF summary for symbols. */
496 void write_summary (void);
498 /* Read IPA IPA ICF summary for symbols. */
499 void read_summary (void);
501 /* Callgraph removal hook called for a NODE with a custom DATA. */
502 static void cgraph_removal_hook (cgraph_node
*node
, void *data
);
504 /* Varpool removal hook called for a NODE with a custom DATA. */
505 static void varpool_removal_hook (varpool_node
*node
, void *data
);
507 /* Worklist of congruence classes that can potentially
508 refine classes of congruence. */
509 std::list
<congruence_class
*> worklist
;
511 /* Remove semantic ITEM and release memory. */
512 void remove_item (sem_item
*item
);
514 /* Remove symtab NODE triggered by symtab removal hooks. */
515 void remove_symtab_node (symtab_node
*node
);
517 /* Register callgraph and varpool hooks. */
518 void register_hooks (void);
520 /* Unregister callgraph and varpool hooks. */
521 void unregister_hooks (void);
523 /* Adds a CLS to hashtable associated by hash value. */
524 void add_class (congruence_class
*cls
);
526 /* Gets a congruence class group based on given HASH value and TYPE. */
527 congruence_class_group
*get_group_by_hash (hashval_t hash
,
530 /* Because types can be arbitrarily large, avoid quadratic bottleneck. */
531 hash_map
<const_tree
, hashval_t
> m_type_hash_cache
;
534 /* For each semantic item, append hash values of references. */
535 void update_hash_by_addr_refs ();
537 /* Congruence classes are built by hash value. */
538 void build_hash_based_classes (void);
540 /* Semantic items in classes having more than one element and initialized.
541 In case of WPA, we load function body. */
542 void parse_nonsingleton_classes (void);
544 /* Equality function for semantic items is used to subdivide existing
545 classes. If IN_WPA, fast equality function is invoked. */
546 void subdivide_classes_by_equality (bool in_wpa
= false);
548 /* Subdivide classes by address and interposable references
549 that members of the class reference.
550 Example can be a pair of functions that have an address
551 taken from a function. If these addresses are different the class
553 unsigned subdivide_classes_by_sensitive_refs();
555 /* Debug function prints all informations about congruence classes. */
556 void dump_cong_classes (void);
558 /* Build references according to call graph. */
559 void build_graph (void);
561 /* Iterative congruence reduction function. */
562 void process_cong_reduction (void);
564 /* After reduction is done, we can declare all items in a group
565 to be equal. PREV_CLASS_COUNT is start number of classes
566 before reduction. True is returned if there's a merge operation
568 bool merge_classes (unsigned int prev_class_count
);
570 /* Adds a newly created congruence class CLS to worklist. */
571 void worklist_push (congruence_class
*cls
);
573 /* Pops a class from worklist. */
574 congruence_class
*worklist_pop ();
576 /* Every usage of a congruence class CLS is a candidate that can split the
577 collection of classes. Bitmap stack BMSTACK is used for bitmap
579 void do_congruence_step (congruence_class
*cls
);
581 /* Tests if a class CLS used as INDEXth splits any congruence classes.
582 Bitmap stack BMSTACK is used for bitmap allocation. */
583 void do_congruence_step_for_index (congruence_class
*cls
, unsigned int index
);
585 /* Makes pairing between a congruence class CLS and semantic ITEM. */
586 static void add_item_to_class (congruence_class
*cls
, sem_item
*item
);
588 /* Disposes split map traverse function. CLS is congruence
589 class, BSLOT is bitmap slot we want to release. DATA is mandatory,
590 but unused argument. */
591 static bool release_split_map (congruence_class
* const &cls
, bitmap
const &b
,
592 traverse_split_pair
*pair
);
594 /* Process split operation for a cognruence class CLS,
595 where bitmap B splits congruence class members. DATA is used
596 as argument of split pair. */
597 static bool traverse_congruence_split (congruence_class
* const &cls
,
599 traverse_split_pair
*pair
);
601 /* Reads a section from LTO stream file FILE_DATA. Input block for DATA
602 contains LEN bytes. */
603 void read_section (lto_file_decl_data
*file_data
, const char *data
,
606 /* Removes all callgraph and varpool nodes that are marked by symtab
608 void filter_removed_items (void);
610 /* Vector of semantic items. */
611 vec
<sem_item
*> m_items
;
613 /* A set containing all items removed by hooks. */
614 hash_set
<symtab_node
*> m_removed_items_set
;
616 /* Hashtable of congruence classes */
617 hash_table
<congruence_class_group_hash
> m_classes
;
619 /* Count of congruence classes. */
620 unsigned int m_classes_count
;
622 /* Map data structure maps symtab nodes to semantic items. */
623 hash_map
<symtab_node
*, sem_item
*> m_symtab_node_map
;
625 /* Set to true if a splitter class is removed. */
626 bool splitter_class_removed
;
628 /* Global unique class id counter. */
629 static unsigned int class_id
;
631 /* Callgraph node removal hook holder. */
632 cgraph_node_hook_list
*m_cgraph_node_hooks
;
634 /* Varpool node removal hook holder. */
635 varpool_node_hook_list
*m_varpool_node_hooks
;
638 bitmap_obstack m_bmstack
;
639 }; // class sem_item_optimizer
641 } // ipa_icf namespace