/*
- * Project: libFIRM
- * File name: ir/ana/execution_frequency.h
- * Purpose: Compute an estimate of basic block executions.
- * Author: Goetz Lindenmaier
- * Modified by:
- * Created: 5.11.2004
- * CVS-ID: $Id$
- * Copyright: (c) 2004 Universität Karlsruhe
- * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
- */
-
-#ifndef _EXECUTION_FREQUENCY_H_
-#define _EXECUTION_FREQUENCY_H_
-
-/** @file execution_frequency.h
+ * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
+ *
+ * This file is part of libFirm.
*
- * Estimate exectution freqencies of blocks.
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
*
- * @author Goetz Lindenmaier
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
*
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
+ */
+
+/**
+ * @file
+ * @brief Compute an estimate of basic block executions.
+ * @author Goetz Lindenmaier
+ * @date 5.11.2004
+ * @version $Id$
+ * @summary
* We assume the start block of a procedure is executed once. Based on this we
* compute the execution freqency of all blocks.
*
- *
+ * The computation of the frequencies depends on the count of exception control
+ * flow computed during the interval analysis. The interval analysis again
+ * depends on stuff computed here.
*/
+#ifndef FIRM_ANA_EXECUTION_FREQUENCY_H
+#define FIRM_ANA_EXECUTION_FREQUENCY_H
-#include "irnode.h"
-#include "irgraph.h"
+#include "firm_types.h"
+/* A proj from a Cond that goes to an exception handler. */
+int is_fragile_Proj(ir_node *n);
-/** Returns the nunmber of times the block/region is executed according to
- * out estimate. */
-double get_Block_exec_freq(ir_node *b);
-double get_region_exec_freq(void *reg);
+/** Returns the number of times the block/region is executed according to
+ * our estimate. Gives a number relative to the Start node of the procedure
+ * the block is in, which is weighted with 1. */
+double get_irn_exec_freq (ir_node *n);
+double get_Block_exec_freq (ir_node *b);
+double get_region_exec_freq(void *reg);
/** Compute the execution frequency for all blocks in the given
* graph.
*
- * @param irg The graph to be analyzed.
- * @param default_loop_weight The default number of executions of a loop.
+ * @param irg The graph to be analyzed.
+ * @param default_loop_weight The default number of executions of a loop.
+ * @param exception_probability The probability that a fragile operation causes an exception.
+ *
+ * Uses link field.
*/
void compute_execution_frequency(ir_graph *irg, int default_loop_weight, double exception_probability);
+
+/** Compute the execution frequency for all graphs.
+ *
+ * @param default_loop_weight The default number of executions of a loop.
+ * @param exception_probability The probability that a fragile operation causes an exception.
+ *
+ */
void compute_execution_frequencies(int default_loop_weight, double exception_probability);
-/** Free occupied memory, reset. */
+/** Free occupied memory, reset for all graphs. */
void free_execution_frequency(void);
+/** State of execution frequencies for graphs and the whole program.
+ *
+ * The exec_freq_state in irp is consistent, if the state of all graphs is consistent.
+ * It is none, if the state of all graphs is none. Else it is inconsistent. */
+typedef enum {
+ exec_freq_none, /**< Execution frequencies are not computed, no memory is
+ allocated, access fails. */
+ exec_freq_consistent, /**< Execution frequency information is computed and correct. */
+ exec_freq_inconsistent /**< Execution frequency is computed but the graph has been
+ changed since. */
+} exec_freq_state;
+
+exec_freq_state get_irg_exec_freq_state(ir_graph *irg);
+void set_irg_exec_freq_state(ir_graph *irg, exec_freq_state s);
+/* Sets irg and irp exec freq state to inconsistent if it is set to consistent. */
+void set_irg_exec_freq_state_inconsistent(ir_graph *irg);
+
+exec_freq_state get_irp_exec_freq_state(void);
+/* Sets irp and all irg exec freq states to inconsistent if it is set to consistent. */
+void set_irp_exec_freq_state_inconsistent(void);
+
-#endif /* _EXECUTION_FREQUENCY_H_ */
+#endif