1 /* Interprocedural semantic function equality pass
2 Copyright (C) 2014-2023 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 opposite. */
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
),
33 referenced_by_count (0)
42 /* Dump function prints all class members to a FILE with an INDENT. */
43 void dump (FILE *file
, unsigned int indent
= 0) const;
45 /* Returns true if there's a member that is used from another group. */
46 bool is_class_used (void);
48 /* Flag is used in case we want to remove a class from worklist and
49 delete operation is quite expensive for
50 the data structure (linked list). */
53 /* Vector of all group members. */
54 auto_vec
<sem_item
*> members
;
56 /* Global unique class identifier. */
59 /* Total number of references to items of this class. */
60 unsigned referenced_by_count
;
63 /* Semantic item type enum. */
70 /* Class is container for address references for a symtab_node. */
72 class symbol_compare_collection
76 symbol_compare_collection (symtab_node
*node
);
79 ~symbol_compare_collection ()
81 m_references
.release ();
82 m_interposables
.release ();
85 /* Vector of address references. */
86 vec
<symtab_node
*> m_references
;
88 /* Vector of interposable references. */
89 vec
<symtab_node
*> m_interposables
;
92 /* Hash traits for symbol_compare_collection map. */
94 struct symbol_compare_hash
: nofree_ptr_hash
<symbol_compare_collection
>
100 hstate
.add_int (v
->m_references
.length ());
102 for (unsigned i
= 0; i
< v
->m_references
.length (); i
++)
103 hstate
.add_int (v
->m_references
[i
]->ultimate_alias_target ()->order
);
105 hstate
.add_int (v
->m_interposables
.length ());
107 for (unsigned i
= 0; i
< v
->m_interposables
.length (); i
++)
108 hstate
.add_int (v
->m_interposables
[i
]->ultimate_alias_target ()->order
);
110 return hstate
.end ();
114 equal (value_type a
, value_type b
)
116 if (a
->m_references
.length () != b
->m_references
.length ()
117 || a
->m_interposables
.length () != b
->m_interposables
.length ())
120 for (unsigned i
= 0; i
< a
->m_references
.length (); i
++)
121 if (a
->m_references
[i
]->equal_address_to (b
->m_references
[i
]) != 1)
124 for (unsigned i
= 0; i
< a
->m_interposables
.length (); i
++)
125 if (!a
->m_interposables
[i
]->semantically_equivalent_p
126 (b
->m_interposables
[i
]))
133 /* Semantic item usage pair. */
137 /* Constructor for key value pair, where _ITEM is key and _INDEX is a target. */
138 sem_usage_pair (sem_item
*_item
, unsigned int _index
);
140 /* Target semantic item where an item is used. */
143 /* Index of usage of such an item. */
147 struct sem_usage_pair_hash
: pointer_hash
<sem_usage_pair
>
149 static inline hashval_t
hash (sem_usage_pair
*);
150 static inline bool equal (sem_usage_pair
*, sem_usage_pair
*);
154 sem_usage_pair_hash::hash (sem_usage_pair
*pair
)
156 inchash::hash hstate
;
158 hstate
.add_ptr (pair
->item
);
159 hstate
.add_int (pair
->index
);
161 return hstate
.end ();
165 sem_usage_pair_hash::equal (sem_usage_pair
*p1
, sem_usage_pair
*p2
)
167 return p1
->item
== p2
->item
&& p1
->index
== p2
->index
;
170 struct sem_usage_hash
: sem_usage_pair_hash
, typed_delete_remove
<sem_usage_pair
> {};
171 typedef hash_map
<sem_usage_hash
, auto_vec
<sem_item
*> > ref_map
;
173 typedef std::pair
<symtab_node
*, symtab_node
*> symtab_pair
;
175 /* Semantic item is a base class that encapsulates all shared functionality
176 for both semantic function and variable items. */
180 /* Semantic item constructor for a node of _TYPE, where STACK is used
181 for bitmap memory allocation. */
182 sem_item (sem_item_type _type
, bitmap_obstack
*stack
);
184 /* Semantic item constructor for a node of _TYPE, where STACK is used
185 for bitmap memory allocation. The item is based on symtab node _NODE. */
186 sem_item (sem_item_type _type
, symtab_node
*_node
, bitmap_obstack
*stack
);
188 virtual ~sem_item ();
190 /* Dump function for debugging purpose. */
191 DEBUG_FUNCTION
void dump (void);
193 /* Semantic item initialization function. */
194 virtual void init (ipa_icf_gimple::func_checker
*) = 0;
196 /* Add reference to a semantic TARGET. */
197 void add_reference (ref_map
*map
, sem_item
*target
);
199 /* Fast equality function based on knowledge known in WPA. */
200 virtual bool equals_wpa (sem_item
*item
,
201 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
) = 0;
203 /* Returns true if the item equals to ITEM given as argument. */
204 virtual bool equals (sem_item
*item
,
205 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
) = 0;
207 /* References independent hash function. */
208 virtual hashval_t
get_hash (void) = 0;
210 /* Set new hash value of the item. */
211 void set_hash (hashval_t hash
);
213 /* Merges instance with an ALIAS_ITEM, where alias, thunk or redirection can
215 virtual bool merge (sem_item
*alias_item
) = 0;
217 /* Dump symbol to FILE. */
218 virtual void dump_to_file (FILE *file
) = 0;
220 /* Update hash by address sensitive references. */
221 void update_hash_by_addr_refs (hash_map
<symtab_node
*,
222 sem_item
*> &m_symtab_node_map
);
224 /* Update hash by computed local hash values taken from different
226 void update_hash_by_local_refs (hash_map
<symtab_node
*,
227 sem_item
*> &m_symtab_node_map
);
229 /* Return base tree that can be used for compatible_types_p and
230 contains_polymorphic_type_p comparison. */
231 static bool get_base_types (tree
*t1
, tree
*t2
);
233 /* Return true if target supports alias symbols. */
234 bool target_supports_symbol_aliases_p (void);
242 /* Declaration tree node. */
245 /* Number of references to a semantic symbols (function calls,
246 variable references). */
247 unsigned reference_count
;
249 /* Pointer to a congruence class the item belongs to. */
250 congruence_class
*cls
;
252 /* Index of the item in a class belonging to. */
253 unsigned int index_in_class
;
255 /* A bitmap with indices of all classes referencing this item. */
256 bitmap usage_index_bitmap
;
258 /* List of tree references (either FUNC_DECL or VAR_DECL). */
259 vec
<tree
> tree_refs
;
261 /* A set with symbol table references. */
262 hash_set
<symtab_node
*> refs_set
;
264 /* Temporary hash used where hash values of references are added. */
265 hashval_t global_hash
;
267 /* Number of references to this symbol. */
268 unsigned referenced_by_count
;
270 /* Cached, once calculated hash for the item. */
272 /* Compare properties of symbol that does not affect semantics of symbol
273 itself but affects semantics of its references.
274 If ADDRESS is true, do extra checking needed for IPA_REF_ADDR. */
275 static bool compare_referenced_symbol_properties (symtab_node
*used_by
,
280 /* Hash properties compared by compare_referenced_symbol_properties. */
281 void hash_referenced_symbol_properties (symtab_node
*ref
,
282 inchash::hash
&hstate
,
285 /* For a given symbol table nodes N1 and N2, we check that FUNCTION_DECLs
286 point to a same function. Comparison can be skipped if IGNORED_NODES
287 contains these nodes. ADDRESS indicate if address is taken. */
288 bool compare_symbol_references (hash_map
<symtab_node
*, sem_item
*>
290 symtab_node
*n1
, symtab_node
*n2
,
296 /* Indicated whether a hash value has been set or not. */
300 /* Initialize internal data structures. Bitmap STACK is used for
301 bitmap memory allocation process. */
302 void setup (bitmap_obstack
*stack
);
304 /* Because types can be arbitrarily large, avoid quadratic bottleneck. */
305 static hash_map
<const_tree
, hashval_t
> m_type_hash_cache
;
308 class sem_function
: public sem_item
311 /* Semantic function constructor that uses STACK as bitmap memory stack. */
312 sem_function (bitmap_obstack
*stack
);
314 /* Constructor based on callgraph node _NODE.
315 Bitmap STACK is used for memory allocation. */
316 sem_function (cgraph_node
*_node
, bitmap_obstack
*stack
);
320 void init (ipa_icf_gimple::func_checker
*) final override
;
321 bool equals_wpa (sem_item
*item
,
322 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
)
324 hashval_t
get_hash (void) final override
;
325 bool equals (sem_item
*item
,
326 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
)
328 bool merge (sem_item
*alias_item
) final override
;
330 /* Dump symbol to FILE. */
331 void dump_to_file (FILE *file
) final override
334 dump_function_to_file (decl
, file
, TDF_DETAILS
);
337 /* Returns cgraph_node. */
338 inline cgraph_node
*get_node (void)
340 return dyn_cast
<cgraph_node
*> (node
);
343 /* Improve accumulated hash for HSTATE based on a gimple statement STMT. */
344 void hash_stmt (gimple
*stmt
, inchash::hash
&inchash
);
346 /* Return true if polymorphic comparison must be processed. */
347 bool compare_polymorphic_p (void);
349 /* For a given call graph NODE, the function constructs new
350 semantic function item. */
351 static sem_function
*parse (cgraph_node
*node
, bitmap_obstack
*stack
,
352 ipa_icf_gimple::func_checker
*checker
);
354 /* Perform additional checks needed to match types of used function
356 bool compatible_parm_types_p (tree
, tree
);
358 /* Exception handling region tree. */
359 eh_region region_tree
;
361 /* Number of function arguments. */
362 unsigned int arg_count
;
364 /* Total amount of edges in the function. */
365 unsigned int edge_count
;
367 /* Vector of sizes of all basic blocks. */
368 vec
<unsigned int> bb_sizes
;
370 /* Control flow graph checksum. */
371 hashval_t cfg_checksum
;
373 /* GIMPLE codes hash value. */
374 hashval_t gcode_hash
;
376 /* Vector of subpart of memory access types. */
377 auto_vec
<tree
> memory_access_types
;
379 /* Total number of SSA names used in the function. */
380 unsigned ssa_names_size
;
382 /* Array of structures for all basic blocks. */
383 vec
<ipa_icf_gimple::sem_bb
*> bb_sorted
;
385 /* Hash of canonical types used for memory references in the
387 hashval_t m_alias_sets_hash
;
389 /* Return true if parameter I may be used. */
390 bool param_used_p (unsigned int i
);
393 /* Calculates hash value based on a BASIC_BLOCK. */
394 hashval_t
get_bb_hash (const ipa_icf_gimple::sem_bb
*basic_block
);
396 /* For given basic blocks BB1 and BB2 (from functions FUNC1 and FUNC),
397 true value is returned if phi nodes are semantically
398 equivalent in these blocks . */
399 bool compare_phi_node (basic_block bb1
, basic_block bb2
);
401 /* Basic blocks dictionary BB_DICT returns true if SOURCE index BB
402 corresponds to TARGET. */
403 bool bb_dict_test (vec
<int> *bb_dict
, int source
, int target
);
405 /* If cgraph edges E1 and E2 are indirect calls, verify that
406 ICF flags are the same. */
407 bool compare_edge_flags (cgraph_edge
*e1
, cgraph_edge
*e2
);
409 /* Processes function equality comparison. */
410 bool equals_private (sem_item
*item
);
412 /* Function checker stores binding between functions. */
413 ipa_icf_gimple::func_checker
*m_checker
;
415 /* COMPARED_FUNC is a function that we compare to. */
416 sem_function
*m_compared_func
;
417 }; // class sem_function
419 class sem_variable
: public sem_item
422 /* Semantic variable constructor that uses STACK as bitmap memory stack. */
423 sem_variable (bitmap_obstack
*stack
);
425 /* Constructor based on callgraph node _NODE.
426 Bitmap STACK is used for memory allocation. */
428 sem_variable (varpool_node
*_node
, bitmap_obstack
*stack
);
430 /* Semantic variable initialization function. */
431 void init (ipa_icf_gimple::func_checker
*) final override
;
433 hashval_t
get_hash (void) final override
;
434 bool merge (sem_item
*alias_item
) final override
;
435 void dump_to_file (FILE *file
) final override
;
436 bool equals (sem_item
*item
,
437 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
)
440 /* Fast equality variable based on knowledge known in WPA. */
441 bool equals_wpa (sem_item
*item
,
442 hash_map
<symtab_node
*, sem_item
*> &ignored_nodes
)
445 /* Returns varpool_node. */
446 inline varpool_node
*get_node (void)
448 return dyn_cast
<varpool_node
*> (node
);
451 /* Parser function that visits a varpool NODE. */
452 static sem_variable
*parse (varpool_node
*node
, bitmap_obstack
*stack
,
453 ipa_icf_gimple::func_checker
*checker
);
456 /* Compares trees T1 and T2 for semantic equality. */
457 static bool equals (tree t1
, tree t2
);
458 }; // class sem_variable
460 class sem_item_optimizer
;
462 struct congruence_class_group
466 vec
<congruence_class
*> classes
;
469 /* Congruence class set structure. */
470 struct congruence_class_hash
: nofree_ptr_hash
<congruence_class_group
>
472 static inline hashval_t
hash (const congruence_class_group
*item
)
477 static inline int equal (const congruence_class_group
*item1
,
478 const congruence_class_group
*item2
)
480 return item1
->hash
== item2
->hash
&& item1
->type
== item2
->type
;
484 struct traverse_split_pair
486 sem_item_optimizer
*optimizer
;
487 class congruence_class
*cls
;
490 /* Semantic item optimizer includes all top-level logic
491 related to semantic equality comparison. */
492 class sem_item_optimizer
495 sem_item_optimizer ();
496 ~sem_item_optimizer ();
498 /* Function responsible for visiting all potential functions and
499 read-only variables that can be merged. */
500 void parse_funcs_and_vars (void);
502 /* Optimizer entry point which returns true in case it processes
503 a merge operation. True is returned if there's a merge operation
510 /* Verify congruence classes if checking is enabled. */
511 void checking_verify_classes (void);
513 /* Verify congruence classes. */
514 void verify_classes (void);
516 /* Write IPA ICF summary for symbols. */
517 void write_summary (void);
519 /* Read IPA ICF summary for symbols. */
520 void read_summary (void);
522 /* Callgraph removal hook called for a NODE with a custom DATA. */
523 static void cgraph_removal_hook (cgraph_node
*node
, void *data
);
525 /* Varpool removal hook called for a NODE with a custom DATA. */
526 static void varpool_removal_hook (varpool_node
*node
, void *data
);
528 /* Worklist of congruence classes that can potentially
529 refine classes of congruence. */
530 fibonacci_heap
<unsigned, congruence_class
> worklist
;
532 /* Remove semantic ITEM and release memory. */
533 void remove_item (sem_item
*item
);
535 /* Remove symtab NODE triggered by symtab removal hooks. */
536 void remove_symtab_node (symtab_node
*node
);
538 /* Register callgraph and varpool hooks. */
539 void register_hooks (void);
541 /* Unregister callgraph and varpool hooks. */
542 void unregister_hooks (void);
544 /* Adds a CLS to hashtable associated by hash value. */
545 void add_class (congruence_class
*cls
);
547 /* Gets a congruence class group based on given HASH value and TYPE. */
548 congruence_class_group
*get_group_by_hash (hashval_t hash
,
552 /* For each semantic item, append hash values of references. */
553 void update_hash_by_addr_refs ();
555 /* Update hash by canonical types of memory accesses. */
556 void update_hash_by_memory_access_type ();
558 /* Congruence classes are built by hash value. */
559 void build_hash_based_classes (void);
561 /* Semantic items in classes having more than one element and initialized.
562 In case of WPA, we load function body. */
563 unsigned int parse_nonsingleton_classes (void);
565 /* Equality function for semantic items is used to subdivide existing
566 classes. If IN_WPA, fast equality function is invoked. */
567 void subdivide_classes_by_equality (bool in_wpa
= false);
569 /* Subdivide classes by address and interposable references
570 that members of the class reference.
571 Example can be a pair of functions that have an address
572 taken from a function. If these addresses are different the class
574 unsigned subdivide_classes_by_sensitive_refs();
576 /* Debug function prints all informations about congruence classes. */
577 void dump_cong_classes (void);
579 /* Build references according to call graph. */
580 void build_graph (void);
582 /* Iterative congruence reduction function. */
583 void process_cong_reduction (void);
585 /* After reduction is done, we can declare all items in a group
586 to be equal. PREV_CLASS_COUNT is start number of classes
587 before reduction. True is returned if there's a merge operation
588 processed. LOADED_SYMBOLS is number of symbols that were loaded
590 bool merge_classes (unsigned int prev_class_count
,
591 unsigned int loaded_symbols
);
593 /* Fixup points to analysis info. */
594 void fixup_points_to_sets (void);
596 /* Fixup points to set PT. */
597 void fixup_pt_set (struct pt_solution
*pt
);
599 /* Adds a newly created congruence class CLS to worklist. */
600 void worklist_push (congruence_class
*cls
);
602 /* Pops a class from worklist. */
603 congruence_class
*worklist_pop ();
605 /* Every usage of a congruence class CLS is a candidate that can split the
606 collection of classes. Bitmap stack BMSTACK is used for bitmap
608 void do_congruence_step (congruence_class
*cls
);
610 /* Tests if a class CLS used as INDEXth splits any congruence classes.
611 Bitmap stack BMSTACK is used for bitmap allocation. */
612 bool do_congruence_step_for_index (congruence_class
*cls
, unsigned int index
);
614 /* Makes pairing between a congruence class CLS and semantic ITEM. */
615 static void add_item_to_class (congruence_class
*cls
, sem_item
*item
);
617 /* Disposes split map traverse function. CLS is congruence
618 class, BSLOT is bitmap slot we want to release. DATA is mandatory,
619 but unused argument. */
620 static bool release_split_map (congruence_class
* const &cls
, bitmap
const &b
,
621 traverse_split_pair
*pair
);
623 /* Process split operation for a congruence class CLS,
624 where bitmap B splits congruence class members. DATA is used
625 as argument of split pair. */
626 static bool traverse_congruence_split (congruence_class
* const &cls
,
628 traverse_split_pair
*pair
);
630 /* Compare function for sorting pairs in do_congruence_step_f. */
631 static int sort_congruence_split (const void *, const void *);
633 /* Reads a section from LTO stream file FILE_DATA. Input block for DATA
634 contains LEN bytes. */
635 void read_section (lto_file_decl_data
*file_data
, const char *data
,
638 /* Removes all callgraph and varpool nodes that are marked by symtab
640 void filter_removed_items (void);
642 /* Vector of semantic items. */
643 vec
<sem_item
*> m_items
;
645 /* A set containing all items removed by hooks. */
646 hash_set
<symtab_node
*> m_removed_items_set
;
648 /* Hashtable of congruence classes. */
649 hash_table
<congruence_class_hash
> m_classes
;
651 /* Count of congruence classes. */
652 unsigned int m_classes_count
;
654 /* Map data structure maps symtab nodes to semantic items. */
655 hash_map
<symtab_node
*, sem_item
*> m_symtab_node_map
;
657 /* Set to true if a splitter class is removed. */
658 bool splitter_class_removed
;
660 /* Global unique class id counter. */
661 static unsigned int class_id
;
663 /* Callgraph node removal hook holder. */
664 cgraph_node_hook_list
*m_cgraph_node_hooks
;
666 /* Varpool node removal hook holder. */
667 varpool_node_hook_list
*m_varpool_node_hooks
;
670 bitmap_obstack m_bmstack
;
672 /* Vector of merged variables. Needed for fixup of points-to-analysis
674 vec
<symtab_pair
> m_merged_variables
;
676 /* Hash map will all references. */
677 ref_map m_references
;
678 }; // class sem_item_optimizer
680 } // ipa_icf namespace