2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Compute an estimate of basic block executions.
23 * @author Adam M. Szalkowski
26 #ifndef FIRM_ANA_EXECFREQ_H
27 #define FIRM_ANA_EXECFREQ_H
29 #include "firm_types.h"
34 * @defgroup execfreq Basic Block Execution Frequency
38 /** Creates execfreq structure (to be used with set_execfreq) */
39 FIRM_API ir_exec_freq *create_execfreq(ir_graph *irg);
42 * Sets execution frequency of a basic block
44 FIRM_API void set_execfreq(ir_exec_freq *ef, const ir_node *block, double freq);
46 /** Creates execfreq structure and initialize with estimated frequencies. */
47 FIRM_API ir_exec_freq *compute_execfreq(ir_graph *irg, double loop_weight);
49 /** Frees memory occupied by execution frequency structure @p ef. */
50 FIRM_API void free_execfreq(ir_exec_freq *ef);
52 /** Returns execution frequency of block @p block. */
53 FIRM_API double get_block_execfreq(const ir_exec_freq *ef,
54 const ir_node *block);
56 /** Returns execution frequency of block @p block, scaled into the range
57 * of an unsigned long type. */
58 FIRM_API unsigned long get_block_execfreq_ulong(const ir_exec_freq *ef,
59 const ir_node *block);