X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=ir%2Fir%2Firgwalk.h;h=5809fe26c86643b8c6f23893164521a594888d21;hb=eda9d668d0e8c8246015b4c5e743316a6a835a23;hp=bd55265bd33de45edcde80b14662c2e07f314072;hpb=b4f94bb0711b6706af39c38f0b18847323b31e83;p=libfirm diff --git a/ir/ir/irgwalk.h b/ir/ir/irgwalk.h index bd55265bd..5809fe26c 100644 --- a/ir/ir/irgwalk.h +++ b/ir/ir/irgwalk.h @@ -1,34 +1,45 @@ -/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe -* All rights reserved. -*/ - -/** - * @file irgwalk.h +/* + * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved. * - * Traverse an ir graph. + * This file is part of libFirm. * - * @author Boris Boesler + * 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. * - * Traverse an ir graph: - * - execute the pre function before recursion - * - execute the post function after recursion + * Licensees holding valid libFirm Professional Edition licenses may use + * this file in accordance with the libFirm Commercial License. + * Agreement provided with the Software. * - * Uses current_ir_graph (from irgraph.h)!!! Set it to the proper - * graph before starting the walker. + * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE + * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE. */ -/* $Id$ */ - -# ifndef _IRGWALK_H_ -# define _IRGWALK_H_ +/** + * @file + * @brief Traverse an ir graph + * @author Boris Boesler, Goetz Lindenmaier + * @version $Id$ + * @summary + * Traverse an ir graph: + * - execute the pre function before recursion + * - execute the post function after recursion + * + * Uses current_ir_graph (from irgraph.h)!!! Set it to the proper + * graph before starting the walker. + */ +#ifndef FIRM_IR_IRGWALK_H +#define FIRM_IR_IRGWALK_H -# include "irnode.h" +#include "firm_types.h" /* type of callback function for ir_graph walk */ #ifndef _IRG_WALK_FUNC_TYPEDEF_ #define _IRG_WALK_FUNC_TYPEDEF_ /** - * The type of a walk function. + * The type of a walk function. Does not use the link field. * * @param node - the node that is just visited * @param env - an environment pointer passed by the walk functions @@ -36,29 +47,61 @@ typedef void irg_walk_func(ir_node *node, void *env); #endif -/** Allocates some necessary datastructures. */ -void init_ip_walk(void); - -/** Frees some necessary datastructures. */ -void finish_ip_walk(void); - /** * Walks over the ir graph. * + * Walks over the ir graph, starting at the node given as first argument. + * Executes pre before visiting the predecessor of a node, post after. + * irg_walk uses the visited flag in irg and the nodes to determine visited + * nodes. It executes inc_irg_visited(current_ir_graph) to generate a new + * flag. Therefore current_ir_graph must be set before calling the walker. + * It marks the node as visited before executing pre. + * The void* env can be used to pass status information between the + * pre and post functions. Does not use the link fields. + * * @param node - the start node * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post + * + */ +void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env); + +/** + * Walks over all reachable nodes in the ir graph. + * + * @param irg - the irg graph + * @param pre - walker function, executed before the predecessor of a node are visited + * @param post - walker function, executed after the predecessor of a node are visited + * @param env - environment, passed to pre and post + * + * Like irg_walk(), but walks over all reachable nodes in the ir + * graph, starting at the end operation. During the walk current_ir_graph + * is set to irg. Does not use the link field. If interprocedural_view + * is set, visits all reachable irgs. + */ +void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); + +/** + * Walks over the ir graph. * * Walks over the ir graph, starting at the node given as first argument. * Executes pre before visiting the predecessor of a node, post after. * irg_walk uses the visited flag in irg and the nodes to determine visited * nodes. It executes inc_irg_visited(current_ir_graph) to generate a new - * flag. It marks the node as visited before executing pre. + * flag. Therefore current_ir_graph must be set before calling the walker. + * It marks the node as visited before executing pre. * The void* env can be used to pass status information between the - * pre and post functions. + * pre and post functions. Does not use the link fields. + * This walker also follows additional dependency egdes. + * + * @param node - the start node + * @param pre - walker function, executed before the predecessor of a node are visited + * @param post - walker function, executed after the predecessor of a node are visited + * @param env - environment, passed to pre and post + * */ -void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env); +void irg_walk_in_or_dep(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env); /** * Walks over all reachable nodes in the ir graph. @@ -66,25 +109,27 @@ void irg_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env) * @param irg - the irg graph * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post * * Like irg_walk(), but walks over all reachable nodes in the ir * graph, starting at the end operation. During the walk current_ir_graph - * is set to irg. + * is set to irg. Does not use the link field. + * This walker also follows additional dependency egdes. + * interprocedural_view is not yet supported. */ -void irg_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); +void irg_walk_in_or_dep_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); /** * Executes irg_walk(end, pre, post, env) for all irgraphs in irprog. * * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post * * This function executes irg_walk(end, pre, post, env) for all irgraphs in irprog. * Sets current_ir_graph properly for each walk. Conserves current * current_ir_graph. In interprocedural view nodes can be visited several - * times. + * times. Does not use the link field. */ void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env); @@ -93,25 +138,24 @@ void all_irg_walk(irg_walk_func *pre, irg_walk_func *post, void *env); * * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post * * This function walks all irgs in interprocedural view. - * Visits each node only once.Sets current_ir_graph properly. + * Visits each node only once. Sets current_ir_graph properly. Does not use the link field. */ void cg_walk(irg_walk_func *pre, irg_walk_func *post, void *env); -/** - * Walks only over Block nodes in the graph. +/** Walks only over Block nodes in the graph. * * @param node - the start node * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post * * This function Walks only over Block nodes in the graph. Has it's own visited * flag, so that it can be interleaved with the other walker. * If a none block is passed, starts at the block this node belongs to. - * If end is passed also visites kept alive blocks. + * If end is passed also visits kept alive blocks. Does not use the link field. */ void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void *env); @@ -121,10 +165,10 @@ void irg_block_walk(ir_node *node, irg_walk_func *pre, irg_walk_func *post, void * @param irg - the irg graph * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post * * Like irg_block_walk(), but walks over all reachable blocks in the - * ir graph, starting at the end block. + * ir graph, starting at the end block. Does not use the link field. */ void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); @@ -133,11 +177,62 @@ void irg_block_walk_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post * * @param pre - walker function, executed before the predecessor of a node are visited * @param post - walker function, executed after the predecessor of a node are visited - * @param env - environment, passend to pre and post + * @param env - environment, passed to pre and post * * This function walks over all code in const_code_irg. - * Uses visited flag in const_code_irg. + * Uses visited flag in const_code_irg. Does not use the link field. */ void walk_const_code(irg_walk_func *pre, irg_walk_func *post, void *env); -# endif /* _IRGWALK_H_ */ +/** + * Walks over reachable nodes in block-wise order, i.e. visit all nodes in a block + * before going to another block, starting at the end operation. + * Executes pre before visiting the predecessor of a node, post after. + * irg_walk_blkwise_graph() uses the visited flag in irg and the nodes to + * determine visited nodes. + * It executes inc_irg_visited(current_ir_graph) to generate a new + * flag. It marks the node as visited before executing pre. + * The void *env can be used to pass status information between the + * pre and post functions. Does not use the link fields. + * Walks only intraprocedural, even in interprocedural view. + * + * @param irg - the irg graph + * @param pre - walker function, executed before the predecessor of a node are visited + * @param post - walker function, executed after the predecessor of a node are visited + * @param env - environment, passed to pre and post + */ +void irg_walk_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); + +/** + * Walks over reachable nodes in block-wise order, i.e. visit all nodes in a block + * before going to another block, starting at the end operation. + * Executes pre before visiting the predecessor of a node, post after. + * irg_walk_blkwise_graph() uses the visited flag in irg and the nodes to + * determine visited nodes. + * It executes inc_irg_visited(current_ir_graph) to generate a new + * flag. It marks the node as visited before executing pre. + * The void *env can be used to pass status information between the + * pre and post functions. Does not use the link fields. + * Walks only intraprocedural, even in interprocedural view. + * This walker also follows dependency edges. + * + * @param irg - the irg graph + * @param pre - walker function, executed before the predecessor of a node are visited + * @param post - walker function, executed after the predecessor of a node are visited + * @param env - environment, passed to pre and post + */ +void irg_walk_in_or_dep_blkwise_graph(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); + +/** + * Additionally walk over all anchors. Do NOT increase the visit flag. + * This function visits all anchor nodes that otherwise might not been visited in a + * walk, for instance the Bad() node. + * + * @param irg - the irg graph + * @param pre - walker function, executed before the predecessor of a node are visited + * @param post - walker function, executed after the predecessor of a node are visited + * @param env - environment, passed to pre and post + */ +void irg_walk_anchors(ir_graph *irg, irg_walk_func *pre, irg_walk_func *post, void *env); + +#endif