X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Firloop.h;h=969ff77c64bdb1b78ee2815796664aa811dbc37d;hb=e302589b2ee3b43584b856431b581d67bc679a68;hp=0e22bfbcad772a25ad1880f30d85fb80e339da42;hpb=427f3beeb5d575e58b41c156f352e9dea708132a;p=libfirm diff --git a/include/libfirm/irloop.h b/include/libfirm/irloop.h index 0e22bfbca..969ff77c6 100644 --- a/include/libfirm/irloop.h +++ b/include/libfirm/irloop.h @@ -1,35 +1,35 @@ /* -* Copyright (C) 1995-2007 University of Karlsruhe. All right reserved. -* -* This file is part of libFirm. -* -* 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. -* -* 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. -*/ + * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved. + * + * This file is part of libFirm. + * + * 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. + * + * 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 Loop datastructure and access functions. -* @author Goetz Lindenmaier -* @date 7.2002 -* @version $Id$ -* @summary -* Computes backedges in the control and data flow. -* -* @note -* Only Block and Phi/Filter nodes can have incoming backedges. -* Constructs loops data structure: indicates loop nesting. -*/ + * @file + * @brief Loop datastructure and access functions. + * @author Goetz Lindenmaier + * @date 7.2002 + * @version $Id$ + * @summary + * Computes backedges in the control and data flow. + * + * @note + * Only Block and Phi/Filter nodes can have incoming backedges. + * Constructs loops data structure: indicates loop nesting. + */ #ifndef FIRM_ANA_IRLOOP_H #define FIRM_ANA_IRLOOP_H @@ -37,14 +37,14 @@ /* ------------------------------------------------------------------- */ /* -* Backedge information. -* -* Predecessors of Block, Phi and interprocedural Filter nodes can -* have backedges. If loop information is computed, this -* information is computed, too. -* The backedge information can only be used if the graph is not in -* phase phase_building. -*/ + * Backedge information. + * + * Predecessors of Block, Phi and interprocedural Filter nodes can + * have backedges. If loop information is computed, this + * information is computed, too. + * The backedge information can only be used if the graph is not in + * phase phase_building. + */ /* ------------------------------------------------------------------- */ #ifdef INTERPROCEDURAL_VIEW @@ -127,70 +127,70 @@ void *get_loop_link(const ir_loop *loop); /* ------------------------------------------------------------------- */ /** Constructs backedge information and loop tree for a graph in intraprocedural view. -* -* The algorithm views the program representation as a pure graph. -* It assumes that only block and phi nodes may be loop headers. -* The resulting loop tree is a possible visiting order for dataflow -* analysis. -* -* This algorithm destoyes the link field of block nodes. -* -* @returns Maximal depth of loop tree. -* -* @remark -* One assumes, the Phi nodes in a block with a backedge have backedges -* at the same positions as the block. This is not the case, as -* the scc algorithms does not respect the program semantics in this case. -* Take a swap in a loop (t = i; i = j; j = t;) This results in two Phi -* nodes. They form a cycle. Once the scc algorithm deleted one of the -* edges, the cycle is removed. The second Phi node does not get a -* backedge! -*/ + * + * The algorithm views the program representation as a pure graph. + * It assumes that only block and phi nodes may be loop headers. + * The resulting loop tree is a possible visiting order for dataflow + * analysis. + * + * This algorithm destoyes the link field of block nodes. + * + * @returns Maximal depth of loop tree. + * + * @remark + * One assumes, the Phi nodes in a block with a backedge have backedges + * at the same positions as the block. This is not the case, as + * the scc algorithms does not respect the program semantics in this case. + * Take a swap in a loop (t = i; i = j; j = t;) This results in two Phi + * nodes. They form a cycle. Once the scc algorithm deleted one of the + * edges, the cycle is removed. The second Phi node does not get a + * backedge! + */ /* @@@ Well, maybe construct_loop_information or analyze_loops ? */ int construct_backedges(ir_graph *irg); #ifdef INTERPROCEDURAL_VIEW /** Constructs backedges for all irgs in interprocedural view. -* -* @see As construct_backedges(), but for interprocedural view. -* -* @remark -* All loops in the graph will be marked as such, not only -* realizeable loops and recursions in the program. E.g., if the -* same funcion is called twice, there is a loop between the first -* function return and the second call. -* -* @returns Maximal depth of loop tree. -*/ + * + * @see As construct_backedges(), but for interprocedural view. + * + * @remark + * All loops in the graph will be marked as such, not only + * realizeable loops and recursions in the program. E.g., if the + * same funcion is called twice, there is a loop between the first + * function return and the second call. + * + * @returns Maximal depth of loop tree. + */ int construct_ip_backedges(void); #endif /** Construct loop tree only for control flow. -* -* This constructs loop information resembling the program structure. -* It is useful for loop optimizations and analyses, as, e.g., finding -* iteration variables or loop invariant code motion. -* -* This algorithm computes only back edge information for Block nodes, not -* for Phi nodes. -* -* This algorithm destroyes the link field of block nodes. -* -* @returns Maximal depth of loop tree. -*/ + * + * This constructs loop information resembling the program structure. + * It is useful for loop optimizations and analyses, as, e.g., finding + * iteration variables or loop invariant code motion. + * + * This algorithm computes only back edge information for Block nodes, not + * for Phi nodes. + * + * This algorithm destroyes the link field of block nodes. + * + * @returns Maximal depth of loop tree. + */ int construct_cf_backedges(ir_graph *irg); #ifdef INTERPROCEDURAL_VIEW /** Construct interprocedural loop tree for control flow. -* -* @see construct_cf_backedges() and construct_ip_backedges(). -*/ + * + * @see construct_cf_backedges() and construct_ip_backedges(). + */ int construct_ip_cf_backedges (void); #endif /** Removes all loop information. -* Resets all backedges. Works for any construction algorithm. -*/ + * Resets all backedges. Works for any construction algorithm. + */ void free_loop_information(ir_graph *irg); void free_all_loop_information (void); @@ -200,12 +200,12 @@ void free_all_loop_information (void); /* ------------------------------------------------------------------- */ /** Test whether a value is loop invariant. -* -* @param n The node to be tested. -* @param block A block node. -* -* Returns non-zero, if the node n is not changed in the loop block -* belongs to or in inner loops of this block. */ + * + * @param n The node to be tested. + * @param block A block node. + * + * Returns non-zero, if the node n is not changed in the loop block + * belongs to or in inner loops of this block. */ int is_loop_invariant(ir_node *n, ir_node *block); #endif