GCC Middle and Back End API Reference: function_summary< T * > Class Template Reference

GCC Middle and Back End API 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

	function_summary ()

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>

typedef int_hash<int, 0, -1> function_summary< T * >::map_hash

private

Constructor & Destructor Documentation

◆ function_summary() [1/2]

template<typename T>

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

References function_summary(), function_summary_base< T >::function_summary_base(), m_ggc, m_map, MEM_STAT_DECL, PASS_MEM_STAT, symtab, symtab_duplication(), symtab_insertion(), symtab_removal(), T, and true.

Referenced by function_summary(), symtab_duplication(), symtab_insertion(), symtab_removal(), and ~function_summary().

◆ ~function_summary()

template<typename T>

function_summary< T * >::~function_summary ( )

virtual

References function_summary(), m_map, function_summary_base< T >::release(), and function_summary_base< T >::unregister_hooks().

◆ function_summary() [2/2]

function_summary< T >::function_summary ( )

private

Member Function Documentation

◆ allocate_new()

template<class T>

T * function_summary_base< T >::allocate_new ( )

inlineprotectedinherited

References ggc_internal_alloc(), is_ggc(), m_allocator, and T.

Referenced by fast_function_summary< T *, V >::get_create(), and function_summary< T * >::get_create().

◆ disable_duplication_hook()

template<class T>

void function_summary_base< T >::disable_duplication_hook ( )

inlineinherited

References m_symtab, m_symtab_duplication_hook, and NULL.

Referenced by unregister_hooks().

◆ disable_insertion_hook()

template<class T>

void function_summary_base< T >::disable_insertion_hook ( )

inlineinherited

References m_symtab, m_symtab_insertion_hook, and NULL.

Referenced by unregister_hooks().

◆ duplicate()

template<class T>

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

inlinevirtualinherited

References gcc_unreachable, and T.

Referenced by fast_function_summary< T *, V >::symtab_duplication().

◆ enable_duplication_hook()

template<class T>

void function_summary_base< T >::enable_duplication_hook ( )

inlineinherited

References m_symtab, m_symtab_duplication, m_symtab_duplication_hook, and NULL.

Referenced by function_summary_base().

◆ enable_insertion_hook()

template<class T>

void function_summary_base< T >::enable_insertion_hook ( )

inlineinherited

References m_symtab, m_symtab_insertion, m_symtab_insertion_hook, and NULL.

Referenced by function_summary_base().

◆ exists()

template<class T>

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

inline

References symtab_node::get_uid(), m_map, and NULL.

◆ get()

template<class T>

T * function_summary< T * >::get ( cgraph_node * node )

inline

References m_map, NULL, and T.

◆ get_create()

template<class T>

T * function_summary< T * >::get_create ( cgraph_node * node )

inline

References function_summary_base< T >::allocate_new(), symtab_node::get_uid(), m_map, and T.

◆ insert()

template<class T>

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

inlinevirtualinherited

References gcc_unreachable, and T.

◆ is_ggc()

template<class T>

bool function_summary< T * >::is_ggc ( )

inlinefinaloverrideprivatevirtual

Implements function_summary_base< T >.

References final(), and m_ggc.

◆ release()

template<class T>

void function_summary_base< T >::release ( T * item )

inlineprotectedinherited

References ggc_delete(), is_ggc(), m_allocator, and T.

Referenced by fast_function_summary< T *, V >::remove(), function_summary< T * >::remove(), fast_function_summary< T *, V >::~fast_function_summary(), and function_summary< T * >::~function_summary().

◆ remove() [1/2]

template<class T>

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

inline

References symtab_node::get_uid(), m_map, function_summary_base< T >::release(), and T.

◆ remove() [2/2]

template<class T>

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

inlinevirtualinherited

References T.

◆ symtab_duplication()

template<typename T>

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

static

References function_summary(), and T.

Referenced by function_summary().

◆ symtab_insertion()

template<typename T>

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

static

References function_summary(), gcc_checking_assert, and symtab_node::get_uid().

Referenced by function_summary().

◆ symtab_removal()

template<typename T>

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

static

References function_summary(), gcc_checking_assert, and symtab_node::get_uid().

Referenced by function_summary().

◆ traverse()

template<class T>

template<typename Arg, bool(*)(const T &, Arg) f>

void function_summary< T * >::traverse ( Arg a ) const

inline

References a, and m_map.

◆ unregister_hooks()

template<typename T>

void function_summary_base< T >::unregister_hooks ( )

protectedinherited

References disable_duplication_hook(), disable_insertion_hook(), m_symtab, and m_symtab_removal_hook.

Referenced by fast_function_summary< T *, V >::~fast_function_summary(), and function_summary< T * >::~function_summary().

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 allocate_new(), function_summary_base(), and release().

◆ m_ggc

template<class T>

bool function_summary< T * >::m_ggc

protected

Referenced by function_summary(), and is_ggc().

◆ m_map

template<class T>

hash_map<map_hash, T *> function_summary< T * >::m_map

private

Referenced by exists(), function_summary(), get(), get_create(), remove(), traverse(), and ~function_summary().

◆ m_symtab

template<class T>

symbol_table* function_summary_base< T >::m_symtab

protectedinherited

Referenced by disable_duplication_hook(), disable_insertion_hook(), enable_duplication_hook(), enable_insertion_hook(), function_summary_base(), fast_function_summary< T *, V >::get_create(), and unregister_hooks().

◆ m_symtab_duplication

template<class T>

cgraph_2node_hook function_summary_base< T >::m_symtab_duplication

protectedinherited

Referenced by enable_duplication_hook(), and function_summary_base().

◆ m_symtab_duplication_hook

template<class T>

cgraph_2node_hook_list* function_summary_base< T >::m_symtab_duplication_hook

protectedinherited

Referenced by disable_duplication_hook(), enable_duplication_hook(), and function_summary_base().

◆ m_symtab_insertion

template<class T>

cgraph_node_hook function_summary_base< T >::m_symtab_insertion

protectedinherited

Referenced by enable_insertion_hook(), and function_summary_base().

◆ m_symtab_insertion_hook

template<class T>

cgraph_node_hook_list* function_summary_base< T >::m_symtab_insertion_hook

protectedinherited

Referenced by disable_insertion_hook(), enable_insertion_hook(), and function_summary_base().

◆ m_symtab_removal

template<class T>

cgraph_node_hook function_summary_base< T >::m_symtab_removal

protectedinherited

Referenced by 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(), and unregister_hooks().

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

symbol-summary.h

function_summary< T * >
Generated by 1.13.2