3 * File name: ir/common/firmwalk.c
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.
26 /** obstack for firm walker */
27 static struct obstack fw_obst;
29 /** This map stores all types of firm */
30 static pmap *mode_map = NULL;
31 /** This map stores all types of firm */
32 static pmap *type_map = NULL;
33 /** This map stores all entities of firm */
34 static pmap *entity_map = NULL;
36 /** Internal data structure of firm walker to collect
37 * some information of firm ir. The collected data will be stored
38 * into the link field of ir node. All graphs have a list of its
39 * blocks and all blocks have a list of their nodes. */
41 ir_node **list; /**< List of blocks or nodes */
42 void *link; /**< Public link field. The public link field of firm nodes
43 is wrapped by set_firm_walk_link and
44 get_firm_walk_link. */
48 /** Access macros to fw_data structure */
49 #define FW_GET_DATA_LIST(s) ((s)->list)
50 #define FW_SET_DATA_LIST(s, t) ((s)->list = (t))
51 #define FW_GET_DATA_LINK(s) ((s)->link)
52 #define FW_SET_DATA_LINK(s, t) ((s)->link = (t))
55 /** Returns own data struct of the firm walker.
57 * If no structure defined (firm link is NULL) allocate a new
58 * struct to the fgd obstack. Only ir graph and block nodes
59 * will allocate this structure.
60 * - ir graph collect its block
61 * - block collect its nodes
64 fw_data *fw_get_data(void *thing)
69 switch (get_kind(thing)) {
71 data = get_irg_link(thing);
72 /* init block list of graph */
75 /* allocate new firm walk structure */
76 data = obstack_alloc(&fw_obst, sizeof(fw_data));
77 memset(data, 0, sizeof(fw_data));
78 set_irg_link(thing, data);
79 /* allocate block list */
80 FW_GET_DATA_LIST(data) = NEW_ARR_F(ir_node *, 0);
84 /* init node list of block */
87 data = get_irn_link(thing);
90 /* allocate new firm walk structure */
91 data = obstack_alloc(&fw_obst, sizeof(fw_data));
92 memset(data, 0, sizeof(fw_data));
93 set_irn_link(thing, data);
94 /* allocate node list */
95 FW_GET_DATA_LIST(data) = NEW_ARR_F(ir_node *, 0);
99 default: {} // other kinds of firm nodes
105 /** Free all collected data in ir graphs and nodes.
106 * An ir graph or an ir block node has a list as a
107 * dynamic array, which will be deleted here. */
109 void fw_free_data(void *thing)
111 fw_data *data = NULL;
115 switch (get_kind(thing)) {
117 data = get_irg_link(thing);
118 /* delete block list of graph */
121 DEL_ARR_F(FW_GET_DATA_LIST(data));
122 set_irg_link(thing, NULL);
126 /* delete node list of block */
129 data = get_irn_link(thing);
132 DEL_ARR_F(FW_GET_DATA_LIST(data));
133 set_irn_link(thing, NULL);
137 default: {} // other kinds of firm nodes
141 // documentation in header file
142 void set_firm_walk_link(void *thing, void *link)
147 switch (get_kind(thing)) {
149 set_entity_link(thing, link);
152 set_type_link(thing, link);
155 data = fw_get_data(thing);
156 FW_SET_DATA_LINK(data, link);
161 data = fw_get_data(thing);
162 FW_SET_DATA_LINK(data, link);
165 set_irn_link(thing, link);
168 set_mode_link(thing, link);
170 default: {} // other kinds of firm nodes
174 // documentation in header file
175 void *get_firm_walk_link(void *thing)
179 switch (get_kind(thing)) {
181 return get_entity_link(thing);
183 return get_type_link(thing);
185 data = fw_get_data(thing);
186 return FW_GET_DATA_LINK(data);
190 data = fw_get_data(thing);
191 return FW_GET_DATA_LINK(data);
194 return get_irn_link(thing);
196 return get_mode_link(thing);
202 /** Set link field of a ir node to NULL */
204 void fw_clear_link(ir_node * node, void * env)
206 set_irn_link(node, NULL);
209 /** Fill maps of type and entity.
210 * This function will be called by the firm walk initializer
211 * to collect all types and entities of program's firm ir.
212 * All types will be colleced in the hash table type_map
213 * and all entity are stored in entity_map. The mode of an
214 * type will be collected as well.
216 * @param tore Type or entity
217 * @param env Environment pointer (currently unused)
220 void fw_collect_tore(type_or_ent *tore, void *env)
226 switch (get_kind(tore)) {
228 ent = (entity *)tore;
229 // append entity to list
230 set_entity_link(ent, NULL);
231 if (!pmap_contains(entity_map, ent))
232 pmap_insert(entity_map, ent, env);
236 mode = get_type_mode(tp);
237 // append type to list
238 set_type_link(tp, NULL);
239 if (!pmap_contains(type_map, tp))
240 pmap_insert(type_map, tp, env);
242 /* insert only modes (non atomic types, i.e. class, array or struct
243 have no mode. The link field will be cleared in the walk_do_mode()
244 callback function. */
245 if ((NULL != mode) && (!pmap_contains(mode_map, mode)))
246 pmap_insert(mode_map, mode, env);
252 /** Collect all data from nodes. Block appends itself to
253 * the corresponding ir graph and other nodes appends itself
254 * to block list. Collects also the modes of each node to get
257 * @param irn IR node pointer.
258 * @param env Environment pointer (currently unused)
261 void fw_collect_irn(ir_node *irn, void *env)
264 ir_mode* mode = get_irn_mode(irn);
266 /* The link field will be cleared in the walk_do_mode()
267 callback function. */
268 if ((NULL != mode) && (!pmap_contains(mode_map, mode)))
269 pmap_insert(mode_map, mode, env);
274 /* add this block to ir graph's block list */
275 data = fw_get_data(get_current_ir_graph());
276 ARR_APP1(ir_node *, FW_GET_DATA_LIST(data), irn);
278 /* non block nodes */
281 /* add this node to block's node list */
282 ir_node *block = get_nodes_Block(irn);
283 data = fw_get_data(block);
284 ARR_APP1(ir_node *, FW_GET_DATA_LIST(data), irn);
288 /** Irg walker function to free all collected data from nodes */
290 void fw_free_colleted_data(ir_node *irn, void *env)
292 /* Free node list from blocks */
299 /** Initialize all walking data.
301 * Collect all specific data like types, entities, ir graphs, blocks, nodes
302 * from current firm structures.
304 void firm_walk_init(firm_walk_flags flags)
309 obstack_init(&fw_obst);
311 /* Init map of modes and lists of type and entity. If map or list
312 allready exists, free it. */
315 pmap_destroy(mode_map);
317 mode_map = pmap_create();
321 pmap_destroy(type_map);
323 type_map = pmap_create();
327 pmap_destroy(entity_map);
329 entity_map = pmap_create();
331 /* insert internal modes to mode hash. The link field will be cleared
332 in the walk_do_mode() callback function.
333 Other used modes are added by collecting types */
336 ### RG: should be done by inspection the mode of all irn
338 pmap_insert(mode_map, mode_BB, NULL);
339 pmap_insert(mode_map, mode_T, NULL);
340 pmap_insert(mode_map, mode_ANY, NULL);
341 pmap_insert(mode_map, mode_BAD, NULL);
342 pmap_insert(mode_map, mode_X, NULL);
343 pmap_insert(mode_map, mode_M, NULL);
344 pmap_insert(mode_map, mode_b, NULL);
347 // Collect all types (also unused types) if flag is set
348 if (FW_WITH_ALL_TYPES & flags)
349 type_walk(fw_collect_tore, NULL, NULL);
352 for (i = 0; i < get_irp_n_irgs(); i++)
354 ir_graph *irg = get_irp_irg(i);
355 set_irg_link(irg, NULL);
357 type_walk_irg(irg, fw_collect_tore, NULL, NULL);
359 irg_walk_graph(irg, fw_clear_link, fw_collect_irn, NULL);
363 /** This function should call after using the firm walker to free
364 * all collected data and frees the used obstack */
365 void firm_walk_finalize(void)
369 /* free all used maps and lists */
370 pmap_destroy(mode_map);
372 pmap_destroy(type_map);
374 pmap_destroy(entity_map);
377 // free all collected data from ir graphs and nodes
378 for (i = 0; i < get_irp_n_irgs(); i++)
380 ir_graph *irg = get_irp_irg(i);
382 irg_walk_graph(get_irp_irg(i), NULL, fw_free_colleted_data, NULL);
386 obstack_free(&fw_obst, NULL);
389 /** Dumps the firm ir.
391 * After initializing the firm walker by calling firm_walk_init()
392 * the firm structure could be accessed by definign the firm walk interface
393 * wif. This function could be called serveral times to customize the
394 * walk order or definitions.
396 * @param wif Walk interface which contains the callback function
398 * @see firm_walk_interface */
399 void firm_walk(firm_walk_interface *wif)
401 int irg_i, block_i, block_list_len, irn_i, irn_list_len;
404 ir_node *block, **block_list, **irn_list;
405 ir_graph *saved_irg = current_ir_graph;
407 assert(wif && "firm_walk() in firmwalk.c: No walking interface defined!");
409 /* walk over all modes */
410 if (wif->do_mode_init) wif->do_mode_init(wif->env);
413 for (entry = pmap_first(mode_map); entry; entry = pmap_next(mode_map))
415 set_mode_link((ir_mode*)entry->key, NULL);
416 wif->do_mode(entry->key, wif->env);
419 if (wif->do_mode_finalize) wif->do_mode_finalize(wif->env);
421 /* walk over all types */
422 if (wif->do_type_init) wif->do_type_init(wif->env);
425 for (entry = pmap_first(type_map); entry; entry = pmap_next(type_map))
426 wif->do_type((type *)entry->key, wif->env);
428 if (wif->do_type_finalize) wif->do_type_finalize(wif->env);
430 /* walk over all entities */
431 if (wif->do_entity_init) wif->do_entity_init(wif->env);
434 for (entry = pmap_first(entity_map); entry; entry = pmap_next(entity_map))
435 wif->do_entity((entity *)entry->key, wif->env);
437 if (wif->do_entity_finalize) wif->do_entity_finalize(wif->env);
440 /* Dump graphs ================================================= */
441 if (wif->do_graph_init) wif->do_graph_init(wif->env);
443 for (irg_i = 0; irg_i < get_irp_n_irgs(); irg_i++)
445 current_ir_graph = get_irp_irg(irg_i);
447 /* walk over all ir graph */
448 if (wif->do_graph) wif->do_graph(current_ir_graph, wif->env);
450 /* walk over all irg's block nested ========================== */
451 data = fw_get_data(current_ir_graph);
452 block_list = FW_GET_DATA_LIST(data);
453 block_list_len = ARR_LEN(block_list);
454 for (block_i = 0; block_i < block_list_len; block_i++)
456 if (wif->do_block_init) wif->do_block_init(current_ir_graph, wif->env);
458 block = (ir_node *)block_list[block_i];
459 if (wif->do_block) wif->do_block(block, wif->env);
461 /* walk over all block's ir nodes nested =================== */
462 data = fw_get_data(block);
463 irn_list = FW_GET_DATA_LIST(data);
464 irn_list_len = ARR_LEN(irn_list);
466 // call block as prefix ir node
467 if ((wif->do_node) &&
468 (wif->flags & FW_DUMP_BLOCK_AS_IRN & !FW_DUMP_IRN_IN_PREFIX))
469 wif->do_node(block, wif->env);
471 // do ir nodes in prefix or postfix order?
472 if (wif->flags & FW_DUMP_IRN_IN_PREFIX)
473 irn_i = irn_list_len-1;
477 while (irn_i >= 0 && irn_i < irn_list_len)
479 if (wif->do_node) wif->do_node((ir_node *)irn_list[irn_i], wif->env);
481 // do ir nodes in prefix or postfix order?
482 if (wif->flags & FW_DUMP_IRN_IN_PREFIX)
487 // call block as postfix ir node
488 if ((wif->do_node) &&
489 (wif->flags & (FW_DUMP_BLOCK_AS_IRN | FW_DUMP_IRN_IN_PREFIX)))
490 wif->do_node(block, wif->env);
492 /* wall over all block's ir nodes nested end =============== */
494 if (wif->do_block_finalize) wif->do_block_finalize(current_ir_graph, wif->env);
497 /* walk over all irg's block nested end ====================== */
499 } // for each ir graph irg
500 if (wif->do_graph_finalize) wif->do_graph_finalize(wif->env);
502 /** ### ToDo: Dump const_code_irg ?? No! Dump const code with entities, types etc. */
504 /* restore the state of current_ir_graph */
505 current_ir_graph = saved_irg;