GCC Middle and Back End API Reference
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Friends
function_summary< T * > Class Template Reference

#include <symbol-summary.h>

Inheritance diagram for function_summary< T * >:
Inheritance graph
[legend]
Collaboration diagram for function_summary< T * >:
Collaboration graph
[legend]

Public Member Functions

 function_summary (symbol_table *symtab, bool ggc=false CXX_MEM_STAT_INFO)
 
virtual ~function_summary ()
 
template<typename Arg , bool(*)(const T &, Arg) f>
void traverse (Arg a) const
 
T * get_create (cgraph_node *node)
 
T * get (cgraph_node *node) ATTRIBUTE_PURE
 
void remove (cgraph_node *node)
 
bool exists (cgraph_node *node)
 
virtual void insert (cgraph_node *, T *)
 
virtual void remove (cgraph_node *, T *)
 
virtual void duplicate (cgraph_node *, cgraph_node *, T *, T *)
 
void enable_insertion_hook ()
 
void disable_insertion_hook ()
 
void enable_duplication_hook ()
 
void disable_duplication_hook ()
 

Static Public Member Functions

static void symtab_insertion (cgraph_node *node, void *data)
 
static void symtab_removal (cgraph_node *node, void *data)
 
static void symtab_duplication (cgraph_node *node, cgraph_node *node2, void *data)
 

Protected Member Functions

T * allocate_new ()
 
void release (T *item)
 
void unregister_hooks ()
 

Protected Attributes

bool m_ggc
 
symbol_table * m_symtab
 
cgraph_node_hook m_symtab_insertion
 
cgraph_node_hook m_symtab_removal
 
cgraph_2node_hook m_symtab_duplication
 
cgraph_node_hook_list * m_symtab_insertion_hook
 
cgraph_node_hook_list * m_symtab_removal_hook
 
cgraph_2node_hook_list * m_symtab_duplication_hook
 

Private Types

typedef int_hash< int, 0, -1 > map_hash
 

Private Member Functions

bool is_ggc () final override
 

Private Attributes

hash_map< map_hash, T * > m_map
 
object_allocator< T > m_allocator
 

Friends

template<typename U >
void gt_ggc_mx (function_summary< U * > *const &)
 
template<typename U >
void gt_pch_nx (function_summary< U * > *const &)
 
template<typename U >
void gt_pch_nx (function_summary< U * > *const &, gt_pointer_operator, void *)
 

Detailed Description

template<class T>
class function_summary< T * >
Function summary is a helper class that is used to associate a data structure
related to a callgraph node.  Typical usage can be seen in IPA passes which
create a temporary pass-related structures.  The summary class registers
hooks that are triggered when a new node is inserted, duplicated and deleted.
A user of a summary class can ovewrite virtual methods than are triggered by
the summary if such hook is triggered.  Apart from a callgraph node, the user
is given a data structure tied to the node.

The function summary class can work both with a heap-allocated memory and
a memory gained by garbage collected memory.

Member Typedef Documentation

◆ map_hash

template<class T >
int_hash<int, 0, -1> function_summary< T * >::map_hash
private

Constructor & Destructor Documentation

◆ function_summary()

template<typename T >
function_summary< T * >::function_summary ( symbol_table * symtab,
bool ggc MEM_STAT_DECL = false CXX_MEM_STAT_INFO )

◆ ~function_summary()

template<typename T >
function_summary< T * >::~function_summary ( )
virtual

Member Function Documentation

◆ allocate_new()

template<class T >
T * function_summary_base< T >::allocate_new ( )
inlineprotectedinherited

References ggc_internal_alloc(), function_summary_base< T >::is_ggc(), and function_summary_base< T >::m_allocator.

◆ disable_duplication_hook()

template<class T >
void function_summary_base< T >::disable_duplication_hook ( )
inlineinherited

References function_summary_base< T >::m_symtab, function_summary_base< T >::m_symtab_duplication_hook, NULL, and symbol_table::remove_cgraph_duplication_hook().

◆ disable_insertion_hook()

template<class T >
void function_summary_base< T >::disable_insertion_hook ( )
inlineinherited

References function_summary_base< T >::m_symtab, function_summary_base< T >::m_symtab_insertion_hook, NULL, and symbol_table::remove_cgraph_insertion_hook().

◆ duplicate()

template<class T >
virtual void function_summary_base< T >::duplicate ( cgraph_node * ,
cgraph_node * ,
T * ,
T *  )
inlinevirtualinherited

References gcc_unreachable.

◆ enable_duplication_hook()

template<class T >
void function_summary_base< T >::enable_duplication_hook ( )
inlineinherited

References symbol_table::add_cgraph_duplication_hook(), function_summary_base< T >::m_symtab, function_summary_base< T >::m_symtab_duplication, function_summary_base< T >::m_symtab_duplication_hook, and NULL.

Referenced by function_summary_base< T >::function_summary_base().

◆ enable_insertion_hook()

template<class T >
void function_summary_base< T >::enable_insertion_hook ( )
inlineinherited

References symbol_table::add_cgraph_insertion_hook(), function_summary_base< T >::m_symtab, function_summary_base< T >::m_symtab_insertion, function_summary_base< T >::m_symtab_insertion_hook, and NULL.

Referenced by function_summary_base< T >::function_summary_base().

◆ exists()

template<class T >
bool function_summary< T * >::exists ( cgraph_node * node)
inline

References cgraph_node::get_uid(), and NULL.

◆ get()

template<class T >
T * function_summary< T * >::get ( cgraph_node * node)
inline

References NULL.

◆ get_create()

template<class T >
T * function_summary< T * >::get_create ( cgraph_node * node)
inline

References cgraph_node::get_uid().

◆ insert()

template<class T >
virtual void function_summary_base< T >::insert ( cgraph_node * ,
T *  )
inlinevirtualinherited

References gcc_unreachable.

◆ is_ggc()

template<class T >
bool function_summary< T * >::is_ggc ( )
inlinefinaloverrideprivatevirtual

Implements function_summary_base< T >.

◆ release()

template<class T >
void function_summary_base< T >::release ( T * item)
inlineprotectedinherited

References ggc_delete(), function_summary_base< T >::is_ggc(), and function_summary_base< T >::m_allocator.

◆ remove() [1/2]

template<class T >
void function_summary< T * >::remove ( cgraph_node * node)
inline

References cgraph_node::get_uid().

◆ remove() [2/2]

template<class T >
virtual void function_summary_base< T >::remove ( cgraph_node * ,
T *  )
inlinevirtualinherited

◆ symtab_duplication()

template<typename T >
void function_summary< T * >::symtab_duplication ( cgraph_node * node,
cgraph_node * node2,
void * data )
static

◆ symtab_insertion()

template<typename T >
void function_summary< T * >::symtab_insertion ( cgraph_node * node,
void * data )
static

References gcc_checking_assert, and cgraph_node::get_uid().

◆ symtab_removal()

template<typename T >
void function_summary< T * >::symtab_removal ( cgraph_node * node,
void * data )
static

References gcc_checking_assert, and cgraph_node::get_uid().

◆ traverse()

template<class T >
template<typename Arg , bool(*)(const T &, Arg) f>
void function_summary< T * >::traverse ( Arg a) const
inline

References a.

◆ unregister_hooks()

template<typename T >
void function_summary_base< T >::unregister_hooks ( )
protectedinherited

Friends And Related Symbol Documentation

◆ gt_ggc_mx

template<class T >
template<typename U >
void gt_ggc_mx ( function_summary< U * > *const & )
friend

◆ gt_pch_nx [1/2]

template<class T >
template<typename U >
void gt_pch_nx ( function_summary< U * > *const & )
friend

◆ gt_pch_nx [2/2]

template<class T >
template<typename U >
void gt_pch_nx ( function_summary< U * > *const & ,
gt_pointer_operator ,
void *  )
friend

Field Documentation

◆ m_allocator

template<class T >
object_allocator<T> function_summary_base< T >::m_allocator
privateinherited

Referenced by function_summary_base< T >::allocate_new(), and function_summary_base< T >::release().

◆ m_ggc

template<class T >
bool function_summary< T * >::m_ggc
protected

◆ m_map

template<class T >
hash_map<map_hash, T *> function_summary< T * >::m_map
private

◆ m_symtab

template<class T >
symbol_table* function_summary_base< T >::m_symtab
protectedinherited

Referenced by function_summary_base< T >::disable_duplication_hook(), function_summary_base< T >::disable_insertion_hook(), function_summary_base< T >::enable_duplication_hook(), function_summary_base< T >::enable_insertion_hook(), and function_summary_base< T >::function_summary_base().

◆ m_symtab_duplication

template<class T >
cgraph_2node_hook function_summary_base< T >::m_symtab_duplication
protectedinherited

Referenced by function_summary_base< T >::enable_duplication_hook().

◆ m_symtab_duplication_hook

template<class T >
cgraph_2node_hook_list* function_summary_base< T >::m_symtab_duplication_hook
protectedinherited

Referenced by function_summary_base< T >::disable_duplication_hook(), and function_summary_base< T >::enable_duplication_hook().

◆ m_symtab_insertion

template<class T >
cgraph_node_hook function_summary_base< T >::m_symtab_insertion
protectedinherited

Referenced by function_summary_base< T >::enable_insertion_hook().

◆ m_symtab_insertion_hook

template<class T >
cgraph_node_hook_list* function_summary_base< T >::m_symtab_insertion_hook
protectedinherited

Referenced by function_summary_base< T >::disable_insertion_hook(), and function_summary_base< T >::enable_insertion_hook().

◆ m_symtab_removal

template<class T >
cgraph_node_hook function_summary_base< T >::m_symtab_removal
protectedinherited

Referenced by function_summary_base< T >::function_summary_base().

◆ m_symtab_removal_hook

template<class T >
cgraph_node_hook_list* function_summary_base< T >::m_symtab_removal_hook
protectedinherited

Referenced by function_summary_base< T >::function_summary_base().

The documentation for this class was generated from the following file: