GCC Middle and Back End API Reference
autofdo Namespace Reference

Data Structures

class  autofdo_source_profile
 
class  count_info
 
class  edge_info
 
class  function_instance
 
struct  string_compare
 
class  string_table
 

Typedefs

typedef std::pair< tree, unsigned > decl_lineno
 
typedef auto_vec< decl_linenoinline_stack
 
typedef auto_vec< char * > string_vector
 
typedef std::map< unsigned, gcov_typeicall_target_map
 
typedef std::set< gimple * > stmt_set
 
typedef std::set< basic_blockbb_set
 
typedef std::set< edgeedge_set
 

Functions

static char * get_original_name (const char *name)
 
static unsigned get_combined_location (location_t loc, tree decl)
 
static tree get_function_decl_from_block (tree block)
 
static void get_inline_stack (location_t locus, inline_stack *stack)
 
static unsigned get_relative_location_for_stmt (gimple *stmt)
 
static bool has_indirect_call (basic_block bb)
 
static void fake_read_autofdo_module_profile ()
 
static void read_profile (void)
 
static bool afdo_indirect_call (gimple_stmt_iterator *gsi, const icall_target_map &map, bool transform)
 
static bool afdo_vpt (gimple_stmt_iterator *gsi, const icall_target_map &map, bool transform)
 
static bool is_bb_annotated (const basic_block bb, const bb_set &annotated)
 
static void set_bb_annotated (basic_block bb, bb_set *annotated)
 
static bool afdo_set_bb_count (basic_block bb, const stmt_set &promoted)
 
static void afdo_find_equiv_class (bb_set *annotated_bb)
 
static bool afdo_propagate_edge (bool is_succ, bb_set *annotated_bb)
 
static void afdo_propagate_circuit (const bb_set &annotated_bb)
 
static void afdo_propagate (bb_set *annotated_bb)
 
static void afdo_calculate_branch_prob (bb_set *annotated_bb)
 
static bool afdo_vpt_for_early_inline (stmt_set *promoted_stmts)
 
static void afdo_annotate_cfg (const stmt_set &promoted_stmts)
 
static unsigned int early_inline ()
 
static unsigned int auto_profile (void)
 

Variables

static string_tableafdo_string_table
 
static autofdo_source_profileafdo_source_profile
 
static gcov_summaryafdo_profile_info
 

Typedef Documentation

◆ bb_set

typedef std::set<basic_block> autofdo::bb_set

◆ decl_lineno

typedef std::pair<tree, unsigned> autofdo::decl_lineno
Represent a source location: (function_decl, lineno).   

◆ edge_set

typedef std::set<edge> autofdo::edge_set

◆ icall_target_map

typedef std::map<unsigned, gcov_type> autofdo::icall_target_map
Map from function name's index in string_table to target's
execution count.   

◆ inline_stack

Represent an inline stack. vector[0] is the leaf node.   

◆ stmt_set

typedef std::set<gimple *> autofdo::stmt_set
Set of gimple stmts. Used to track if the stmt has already been promoted
to direct call.   

◆ string_vector

String array that stores function names.   

Function Documentation

◆ afdo_annotate_cfg()

◆ afdo_calculate_branch_prob()

◆ afdo_find_equiv_class()

static void autofdo::afdo_find_equiv_class ( bb_set * annotated_bb)
static
BB1 and BB2 are in an equivalent class iff:
1. BB1 dominates BB2.
2. BB2 post-dominates BB1.
3. BB1 and BB2 are in the same loop nest.
This function finds the equivalent class for each basic block, and
stores a pointer to the first BB in its equivalent class. Meanwhile,
set bb counts for the same equivalent class to be idenical. Update
ANNOTATED_BB for the first BB in its equivalent class.   

References basic_block_def::aux, CDI_DOMINATORS, CDI_POST_DOMINATORS, cfun, basic_block_def::count, dominated_by_p(), FOR_ALL_BB_FN, get_dominated_by(), is_bb_annotated(), basic_block_def::loop_father, NULL, and set_bb_annotated().

Referenced by afdo_calculate_branch_prob().

◆ afdo_indirect_call()

static bool autofdo::afdo_indirect_call ( gimple_stmt_iterator * gsi,
const icall_target_map & map,
bool transform )
static

◆ afdo_propagate()

static void autofdo::afdo_propagate ( bb_set * annotated_bb)
static
Propagate the basic block count and edge count on the control flow
graph. We do the propagation iteratively until stablize.   

References afdo_propagate_circuit(), afdo_propagate_edge(), basic_block_def::aux, cfun, changed, basic_block_def::count, count, FOR_ALL_BB_FN, i, is_bb_annotated(), and set_bb_annotated().

Referenced by afdo_calculate_branch_prob().

◆ afdo_propagate_circuit()

static void autofdo::afdo_propagate_circuit ( const bb_set & annotated_bb)
static
Special propagation for circuit expressions. Because GCC translates
control flow into data flow for circuit expressions. E.g.
BB1:
if (a && b)
  BB2
else
  BB3

will be translated into:

BB1:
  if (a)
    goto BB.t1
  else
    goto BB.t3
BB.t1:
  if (b)
    goto BB.t2
  else
    goto BB.t3
BB.t2:
  goto BB.t3
BB.t3:
  tmp = PHI (0 (BB1), 0 (BB.t1), 1 (BB.t2)
  if (tmp)
    goto BB2
  else
    goto BB3

In this case, we need to propagate through PHI to determine the edge
count of BB1->BB.t1, BB.t1->BB.t2.   

References AFDO_EINFO, cfun, dyn_cast(), FOR_ALL_BB_FN, FOR_EACH_EDGE, gimple_assign_rhs1(), gimple_assign_single_p(), gimple_cond_code(), gimple_cond_lhs(), gimple_cond_rhs(), gimple_phi_arg_def(), gimple_phi_arg_edge(), gimple_phi_num_args(), i, integer_onep(), integer_zerop(), is_bb_annotated(), last_nondebug_stmt(), SSA_NAME_DEF_STMT, basic_block_def::succs, TREE_CODE, TREE_CONSTANT, and profile_count::zero().

Referenced by afdo_propagate().

◆ afdo_propagate_edge()

static bool autofdo::afdo_propagate_edge ( bool is_succ,
bb_set * annotated_bb )
static
If a basic block's count is known, and only one of its in/out edges' count
is unknown, its count can be calculated. Meanwhile, if all of the in/out
edges' counts are known, then the basic block's unknown count can also be
calculated. Also, if a block has a single predecessor or successor, the block's
count can be propagated to that predecessor or successor.
IS_SUCC is true if out edges of a basic blocks are examined.
Update ANNOTATED_BB accordingly.
Return TRUE if any basic block/edge count is changed.   

References profile_count::afdo(), AFDO_EINFO, cfun, changed, basic_block_def::count, FOR_EACH_BB_FN, FOR_EACH_EDGE, gcc_assert, is_bb_annotated(), NULL, basic_block_def::preds, set_bb_annotated(), basic_block_def::succs, and profile_count::zero().

Referenced by afdo_propagate().

◆ afdo_set_bb_count()

◆ afdo_vpt()

static bool autofdo::afdo_vpt ( gimple_stmt_iterator * gsi,
const icall_target_map & map,
bool transform )
static
From AutoFDO profiles, find values inside STMT for that we want to measure
histograms and adds them to list VALUES.   

References afdo_indirect_call(), and map.

Referenced by afdo_set_bb_count(), and afdo_vpt_for_early_inline().

◆ afdo_vpt_for_early_inline()

◆ auto_profile()

◆ early_inline()

static unsigned int autofdo::early_inline ( )
static

◆ fake_read_autofdo_module_profile()

static void autofdo::fake_read_autofdo_module_profile ( )
static
Module profile is only used by LIPO. Here we simply ignore it.   

References gcc_assert, and gcov_read_unsigned().

Referenced by read_profile().

◆ get_combined_location()

static unsigned autofdo::get_combined_location ( location_t loc,
tree decl )
static
Return the combined location, which is a 32bit integer in which
higher 16 bits stores the line offset of LOC to the start lineno
of DECL, The lower 16 bits stores the discriminator.   

References DECL_SOURCE_LINE, get_discriminator_from_loc(), LOCATION_LINE, and warning_at().

Referenced by get_inline_stack(), and get_relative_location_for_stmt().

◆ get_function_decl_from_block()

static tree autofdo::get_function_decl_from_block ( tree block)
static
Return the function decl of a given lexical BLOCK.   

References BLOCK_ABSTRACT_ORIGIN, inlined_function_outer_scope_p(), and NULL_TREE.

Referenced by get_inline_stack(), and get_relative_location_for_stmt().

◆ get_inline_stack()

◆ get_original_name()

static char * autofdo::get_original_name ( const char * name)
static
Helper functions.   
Return the original name of NAME: strip the suffix that starts
with '.' Caller is responsible for freeing RET.   

References find(), and NULL.

Referenced by autofdo::string_table::get_index_by_decl(), and autofdo::string_table::read().

◆ get_relative_location_for_stmt()

static unsigned autofdo::get_relative_location_for_stmt ( gimple * stmt)
static
Return STMT's combined location, which is a 32bit integer in which
higher 16 bits stores the line offset of LOC to the start lineno
of DECL, The lower 16 bits stores the discriminator.   

References BLOCK_SOURCE_LOCATION, BLOCK_SUPERCONTEXT, current_function_decl, get_combined_location(), get_function_decl_from_block(), gimple_block(), gimple_location(), LOCATION_LOCUS, TREE_CODE, and UNKNOWN_LOCATION.

Referenced by autofdo::function_instance::find_icall_target_map().

◆ has_indirect_call()

static bool autofdo::has_indirect_call ( basic_block bb)
static
Return true if BB contains indirect call.   

References gimple_call_fn(), gimple_call_internal_p(), gsi_end_p(), gsi_next(), gsi_start_bb(), gsi_stmt(), NULL, and TREE_CODE.

Referenced by afdo_vpt_for_early_inline().

◆ is_bb_annotated()

static bool autofdo::is_bb_annotated ( const basic_block bb,
const bb_set & annotated )
static

◆ read_profile()

◆ set_bb_annotated()

static void autofdo::set_bb_annotated ( basic_block bb,
bb_set * annotated )
static

Variable Documentation

◆ afdo_profile_info

gcov_summary* autofdo::afdo_profile_info
static
gcov_summary structure to store the profile_info.   

Referenced by afdo_callsite_hot_enough_for_early_inline(), auto_profile(), and read_autofdo_file().

◆ afdo_source_profile

◆ afdo_string_table