2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Entry point to the representation of procedure code -- internal header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
26 #ifndef FIRM_IR_IRGRAPH_T_H
27 #define FIRM_IR_IRGRAPH_T_H
29 #include "firm_types.h"
36 #include "iredgekinds.h"
44 /** Suffix that is added to every frame type. */
45 #define FRAME_TP_SUFFIX "frame_tp"
48 * Initializes the graph construction module.
50 void firm_init_irgraph(void);
53 * Set the number of locals for a given graph.
55 * @param irg the graph
56 * @param n_loc number of locals
58 void irg_set_nloc(ir_graph *res, int n_loc);
61 * Internal constructor that does not add to irp_irgs or the like.
63 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
66 * Make a rudimentary ir graph for the constant code.
67 * Must look like a correct irg, spare everything else.
69 ir_graph *new_const_code_irg(void);
72 * Create a new graph that is a copy of a given one.
73 * Uses the link fields of the original graphs.
75 * @param irg The graph that must be copied.
77 ir_graph *create_irg_copy(ir_graph *irg);
80 * Set the op_pin_state_pinned state of a graph.
82 * @param irg the IR graph
83 * @param p new pin state
85 void set_irg_pinned(ir_graph *irg, op_pin_state p);
87 /** Returns the obstack associated with the graph. */
88 struct obstack *get_irg_obstack(const ir_graph *irg);
91 * Returns true if the node n is allocated on the storage of graph irg.
93 * @param irg the IR graph
94 * @param n the IR node
96 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n);
98 /*-------------------------------------------------------------------*/
99 /* inline functions for graphs */
100 /*-------------------------------------------------------------------*/
102 static inline int is_ir_graph_(const void *thing)
104 return (get_kind(thing) == k_ir_graph);
107 /** Returns the start block of a graph. */
108 static inline ir_node *get_irg_start_block_(const ir_graph *irg)
110 return get_irn_n(irg->anchor, anchor_start_block);
113 static inline void set_irg_start_block_(ir_graph *irg, ir_node *node)
115 set_irn_n(irg->anchor, anchor_start_block, node);
118 static inline ir_node *get_irg_start_(const ir_graph *irg)
120 return get_irn_n(irg->anchor, anchor_start);
123 static inline void set_irg_start_(ir_graph *irg, ir_node *node)
125 set_irn_n(irg->anchor, anchor_start, node);
128 static inline ir_node *get_irg_end_block_(const ir_graph *irg)
130 return get_irn_n(irg->anchor, anchor_end_block);
133 static inline void set_irg_end_block_(ir_graph *irg, ir_node *node)
135 set_irn_n(irg->anchor, anchor_end_block, node);
138 static inline ir_node *get_irg_end_(const ir_graph *irg)
140 return get_irn_n(irg->anchor, anchor_end);
143 static inline void set_irg_end_(ir_graph *irg, ir_node *node)
145 set_irn_n(irg->anchor, anchor_end, node);
148 static inline ir_node *get_irg_initial_exec_(const ir_graph *irg)
150 return get_irn_n(irg->anchor, anchor_initial_exec);
153 static inline void set_irg_initial_exec_(ir_graph *irg, ir_node *node)
155 set_irn_n(irg->anchor, anchor_initial_exec, node);
158 static inline ir_node *get_irg_frame_(const ir_graph *irg)
160 return get_irn_n(irg->anchor, anchor_frame);
163 static inline void set_irg_frame_(ir_graph *irg, ir_node *node)
165 set_irn_n(irg->anchor, anchor_frame, node);
168 static inline ir_node *get_irg_initial_mem_(const ir_graph *irg)
170 return get_irn_n(irg->anchor, anchor_initial_mem);
173 static inline void set_irg_initial_mem_(ir_graph *irg, ir_node *node)
175 set_irn_n(irg->anchor, anchor_initial_mem, node);
178 static inline ir_node *get_irg_args_(const ir_graph *irg)
180 return get_irn_n(irg->anchor, anchor_args);
183 static inline void set_irg_args_(ir_graph *irg, ir_node *node)
185 set_irn_n(irg->anchor, anchor_args, node);
188 static inline ir_node *get_irg_no_mem_(const ir_graph *irg)
190 return get_irn_n(irg->anchor, anchor_no_mem);
193 static inline void set_irg_no_mem_(ir_graph *irg, ir_node *node)
195 set_irn_n(irg->anchor, anchor_no_mem, node);
198 static inline ir_entity *get_irg_entity_(const ir_graph *irg)
203 static inline void set_irg_entity_(ir_graph *irg, ir_entity *ent)
208 static inline ir_type *get_irg_frame_type_(ir_graph *irg)
210 assert(irg->frame_type);
211 return irg->frame_type;
214 static inline void set_irg_frame_type_(ir_graph *irg, ir_type *ftp)
216 assert(is_frame_type(ftp));
217 irg->frame_type = ftp;
220 static inline struct obstack *get_irg_obstack_(const ir_graph *irg)
226 static inline irg_phase_state get_irg_phase_state_(const ir_graph *irg)
228 return irg->phase_state;
231 static inline void set_irg_phase_state_(ir_graph *irg, irg_phase_state state)
233 irg->phase_state = state;
236 static inline op_pin_state get_irg_pinned_(const ir_graph *irg)
238 return irg->irg_pinned_state;
241 static inline void set_irg_pinned_(ir_graph *irg, op_pin_state p)
243 irg->irg_pinned_state = p;
246 static inline irg_callee_info_state get_irg_callee_info_state_(const ir_graph *irg)
248 return irg->callee_info_state;
251 static inline void set_irg_callee_info_state_(ir_graph *irg, irg_callee_info_state s)
253 irg_callee_info_state irp_state = get_irp_callee_info_state();
255 irg->callee_info_state = s;
257 /* I could compare ... but who knows? */
258 if ((irp_state == irg_callee_info_consistent) ||
259 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
260 set_irp_callee_info_state(s);
263 static inline irg_inline_property get_irg_inline_property_(const ir_graph *irg)
265 return irg->inline_property;
268 static inline void set_irg_inline_property_(ir_graph *irg, irg_inline_property s)
270 irg->inline_property = s;
273 static inline mtp_additional_properties get_irg_additional_properties_(const ir_graph *irg)
275 if (irg->additional_properties & mtp_property_inherited)
276 return get_method_additional_properties(get_entity_type(irg->ent));
277 return irg->additional_properties;
280 static inline void set_irg_additional_properties_(ir_graph *irg, mtp_additional_properties mask)
282 irg->additional_properties = mask & ~mtp_property_inherited;
285 static inline void add_irg_additional_properties_(ir_graph *irg, mtp_additional_properties flag)
287 mtp_additional_properties prop = irg->additional_properties;
289 if (prop & mtp_property_inherited)
290 prop = get_method_additional_properties(get_entity_type(irg->ent));
291 irg->additional_properties = prop | flag;
294 static inline void set_irg_link_(ir_graph *irg, void *thing)
299 static inline void *get_irg_link_(const ir_graph *irg)
304 static inline ir_visited_t get_irg_visited_(const ir_graph *irg)
309 static inline ir_visited_t get_irg_block_visited_(const ir_graph *irg)
311 return irg->block_visited;
314 static inline void set_irg_block_visited_(ir_graph *irg, ir_visited_t visited)
316 irg->block_visited = visited;
319 static inline void inc_irg_block_visited_(ir_graph *irg)
321 ++irg->block_visited;
324 static inline void dec_irg_block_visited_(ir_graph *irg)
326 --irg->block_visited;
329 static inline unsigned get_irg_estimated_node_cnt_(const ir_graph *irg)
331 return irg->estimated_node_count;
334 /* Return the floating point model of this graph. */
335 static inline unsigned get_irg_fp_model_(const ir_graph *irg)
337 return irg->fp_model;
340 static inline void set_irg_state_(ir_graph *irg, ir_graph_state_t state)
342 irg->state = (ir_graph_state_t) (irg->state | state);
345 static inline void clear_irg_state_(ir_graph *irg, ir_graph_state_t state)
347 irg->state = (ir_graph_state_t) (irg->state & ~state);
350 static inline int is_irg_state_(const ir_graph *irg, ir_graph_state_t state)
352 return (irg->state & state) == state;
356 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
357 * @param irg The graph.
358 * @param irn The node.
359 * @return The index allocated for the node.
361 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn)
363 unsigned idx = irg->last_node_idx++;
364 if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
365 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
367 irg->idx_irn_map[idx] = irn;
372 * Kill a node from the irg. BEWARE: this kills
373 * all later created nodes.
375 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
377 unsigned idx = get_irn_idx(n);
378 assert(idx + 1 == irg->last_node_idx);
380 if (idx + 1 == irg->last_node_idx)
381 --irg->last_node_idx;
382 irg->idx_irn_map[idx] = NULL;
383 obstack_free(irg->obst, n);
387 * Get the node for an index.
388 * @param irg The graph.
389 * @param idx The index you want the node for.
390 * @return The node with that index or NULL, if there is no node with that index.
391 * @note The node you got might be dead.
393 static inline ir_node *get_idx_irn_(const ir_graph *irg, unsigned idx)
395 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
396 return irg->idx_irn_map[idx];
400 * Return the number of anchors in this graph.
402 static inline int get_irg_n_anchors(const ir_graph *irg)
404 return get_irn_arity(irg->anchor);
408 * Return anchor for given index
410 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
412 return get_irn_n(irg->anchor, idx);
416 * Set anchor for given index
418 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
420 set_irn_n(irg->anchor, idx, irn);
424 #define is_ir_graph(thing) is_ir_graph_(thing)
425 #define get_irg_start_block(irg) get_irg_start_block_(irg)
426 #define set_irg_start_block(irg, node) set_irg_start_block_(irg, node)
427 #define get_irg_start(irg) get_irg_start_(irg)
428 #define set_irg_start(irg, node) set_irg_start_(irg, node)
429 #define get_irg_end_block(irg) get_irg_end_block_(irg)
430 #define set_irg_end_block(irg, node) set_irg_end_block_(irg, node)
431 #define get_irg_end(irg) get_irg_end_(irg)
432 #define set_irg_end(irg, node) set_irg_end_(irg, node)
433 #define get_irg_initial_exec(irg) get_irg_initial_exec_(irg)
434 #define set_irg_initial_exec(irg, node) set_irg_initial_exec_(irg, node)
435 #define get_irg_frame(irg) get_irg_frame_(irg)
436 #define set_irg_frame(irg, node) set_irg_frame_(irg, node)
437 #define get_irg_initial_mem(irg) get_irg_initial_mem_(irg)
438 #define set_irg_initial_mem(irg, node) set_irg_initial_mem_(irg, node)
439 #define get_irg_args(irg) get_irg_args_(irg)
440 #define set_irg_args(irg, node) set_irg_args_(irg, node)
441 #define get_irg_no_mem(irg) get_irg_no_mem_(irg)
442 #define set_irn_no_mem(irg, node) set_irn_no_mem_(irg, node)
443 #define get_irg_entity(irg) get_irg_entity_(irg)
444 #define set_irg_entity(irg, ent) set_irg_entity_(irg, ent)
445 #define get_irg_frame_type(irg) get_irg_frame_type_(irg)
446 #define set_irg_frame_type(irg, ftp) set_irg_frame_type_(irg, ftp)
447 #define get_irg_obstack(irg) get_irg_obstack_(irg)
448 #define get_irg_phase_state(irg) get_irg_phase_state_(irg)
449 #define set_irg_phase_state(irg, state) set_irg_phase_state_(irg, state)
450 #define get_irg_pinned(irg) get_irg_pinned_(irg)
451 #define set_irg_pinned(irg, p) set_irg_pinned_(irg, p)
452 #define get_irg_callee_info_state(irg) get_irg_callee_info_state_(irg)
453 #define set_irg_callee_info_state(irg, s) set_irg_callee_info_state_(irg, s)
454 #define get_irg_inline_property(irg) get_irg_inline_property_(irg)
455 #define set_irg_inline_property(irg, s) set_irg_inline_property_(irg, s)
456 #define get_irg_additional_properties(irg) get_irg_additional_properties_(irg)
457 #define set_irg_additional_properties(irg, m) set_irg_additional_properties_(irg, m)
458 #define set_irg_additional_property(irg, f) set_irg_additional_property_(irg, f)
459 #define set_irg_link(irg, thing) set_irg_link_(irg, thing)
460 #define get_irg_link(irg) get_irg_link_(irg)
461 #define get_irg_visited(irg) get_irg_visited_(irg)
462 #define get_irg_block_visited(irg) get_irg_block_visited_(irg)
463 #define set_irg_block_visited(irg, v) set_irg_block_visited_(irg, v)
464 #define inc_irg_block_visited(irg) inc_irg_block_visited_(irg)
465 #define dec_irg_block_visited(irg) dec_irg_block_visited_(irg)
466 #define get_irg_estimated_node_cnt(irg) get_irg_estimated_node_cnt_(irg)
467 #define get_irg_fp_model(irg) get_irg_fp_model_(irg)
468 #define get_idx_irn(irg, idx) get_idx_irn_(irg, idx)
469 #define set_irg_state(irg, state) set_irg_state_(irg, state)
470 #define clear_irg_state(irg, state) clear_irg_state_(irg, state)
471 #define is_irg_state(irg, state) is_irg_state_(irg, state)