3 * File name: ir/common/firmwalk.h
4 * Purpose: Walker that touches all Firm data structures
5 * Author: Sebastian Felis
9 * Copyright: (c) 2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * Firm walker over intermediate representation.
18 * To initialize the walker, call firm_walk_init(). This function
19 * collects all specific data from the firm represenation. After
20 * building the walker information firm_walk() could be called
21 * serveral times with different flags (options) from specific walker
22 * or dumper. At least firm_walk_finalizer() should be called to free
25 * This walker could be used for a dumper e.g. a vcg or xml dumper.
27 * @note If a specific walker or dumper which uses the link field
28 * of any firm node, the the wrapper functions set_firm_walk_link()
29 * and get_firm_walk_link() should be used, because the firm walker
30 * make use of the link field to store its own data.
39 /** Returns the link of a firm node.
40 * Possible firm structures are: entity, type, ir_graph, ir_node and
41 * ir_mode. Otherwise this function has no effect
43 * Derived walker or dumper have to call this function to store data
44 * to a firm structure. The real link field of firm structure is used
45 * by this firm walker to collect walking data.
47 * @param thing Pointer to a firm structure
48 * @retrun Link pointer
50 * @note After calling firm_walk_finalize() the stored link
51 * information may be invalid. */
52 void *get_firm_walk_link(void *thing);
54 /** Set the link field of a firm structure.
55 * Possible firm structures are: entity, type, ir_graph, ir_node and
56 * ir_mode. Otherwise this function has no effect
58 * Derived walker or dumper have to call this function to store data
59 * to a firm structure. The real link field of firm structure is used
60 * by this firm walker to collect walking data.
62 * @param thing firm structur
63 * @param link Pointer to link field
65 * @note After calling firm_walk_finalize() the stored link
66 * information may be invalid. */
67 void set_firm_walk_link(void *thing, void *link);
69 /** Initialisation function for firm walker callbacks */
70 typedef void firm_walk_init_func(void *env);
71 /** Finalisation function for firm walker callbacks */
72 typedef void firm_walk_finalize_func(void *env);
74 /** Mode callback function definition */
75 typedef void firm_walk_mode_func(ir_mode *mode, void *env);
76 /** Type callback function definition */
77 typedef void firm_walk_type_func(type *tp, void *env);
78 /** Entity callback function definition */
79 typedef void firm_walk_entity_func(entity *ent, void *env);
80 /** Graph callback function definition */
81 typedef void firm_walk_graph_func(ir_graph *irg, void *env);
83 /** Block callback function definition */
84 typedef void firm_walk_block_init_func(ir_graph *irg, void *env);
85 typedef void firm_walk_block_func(ir_node *block, void *env);
86 typedef void firm_walk_block_finalize_func(ir_graph *irg, void *env);
88 /** Node callback function definition */
89 typedef void firm_walk_node_func (ir_node *irn, void *env);
91 /** @enum firm_walk_flags
93 * Flags for the firm walker to modify some dumping behavior
97 FW_WITH_ALL_TYPES = 1<<0, /**< Collect and dump all types, especially
99 @note This flag could be set in
100 firm_dumper_init() and is unused in
102 FW_WITH_DOMINATOR = 1<<1, /**< nyi */
103 FW_WITH_OUTEDGES = 1<<2, /**< nyi */
104 FW_WITH_LOOPS = 1<<3, /**< nyi */
105 FW_DUMP_BLOCK_AS_IRN = 1<<4, /**< Dump all block nodes as irn nodes
107 FW_DUMP_IRN_IN_PREFIX = 1<<5, /**< Dumps all ir nodes in prefix order
108 according to the internal firm graph
112 /** Interface of the firm walker */
116 /** Interface function to dump all used and internal modes.
117 Internal modes are: BB, X, M and T */
118 firm_walk_init_func *do_mode_init;
119 firm_walk_mode_func *do_mode;
120 firm_walk_finalize_func *do_mode_finalize;
124 /** Interface to dump all collected types.
126 * @node To dump all (not only used types by default) a special walk
127 * flag must be set for the walker initializer */
128 firm_walk_init_func *do_type_init;
129 firm_walk_type_func *do_type;
130 firm_walk_finalize_func *do_type_finalize;
134 /** Dumping interface for entities */
135 firm_walk_init_func *do_entity_init;
136 firm_walk_entity_func *do_entity;
137 firm_walk_finalize_func *do_entity_finalize;
140 /** Dumps all graphs and subnodes.
142 * The firm walker dump a graph with its blocks and nodes nested.
143 * Fist do_graph_init will be called (if defined). For each graph
144 * do_graph will be call in a loop. After dumped all graphs,
145 * do_graph_finalize will be called.
147 * Within do_graph each block will be dumped. First do_block_init,
148 * for each block do_block and after all dumped blocks
151 * The ir nodes are dumped nested in their blocks as well. Within
152 * do_block, for each ir node do_node is called in postfix order
153 * according to the internal firm representation. By changing the
154 * walking flag, a prefix order is also possible. */
155 firm_walk_init_func *do_graph_init;
156 firm_walk_graph_func *do_graph;
157 firm_walk_finalize_func *do_graph_finalize;
160 /** Dumping interface for blocks. If blocks should be handled like
161 * like a normal ir node, a special walker flag could be set.
163 firm_walk_block_init_func *do_block_init;
164 firm_walk_block_func *do_block;
165 firm_walk_block_finalize_func *do_block_finalize;
168 /** Dumping interface for ir nodes
170 firm_walk_node_func *do_node;
174 firm_walk_flags flags;
175 /* pointer to environment of interface */
177 } firm_walk_interface;
180 /** Initialize the dumper und collect all data from the firm intermediate
183 * @param flags flags */
184 void firm_walk_init(firm_walk_flags flags);
186 /** Walker of the firm intermediate representation.
188 * The callback functions of the interface will be called nested, e.g. for
189 * each block: init function of block, do_block, nested function of nodes,
190 * finalize function of block.
198 * - nodes. Options: dominator, outedges
200 * @param wif Stucture of walker interface. In this struct the used callback
201 * functions are defined.
203 void firm_walk(firm_walk_interface *wif);
205 /** Finalize the walker and frees all stored data for dumping */
206 void firm_walk_finalize(void);
208 #endif /* _FIRM_WALK_H_ */