2 * This file is part of libFirm.
3 * Copyright (C) 2012 University of Karlsruhe.
8 * @brief Entry point to the representation of procedure code -- internal header.
9 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
11 #ifndef FIRM_IR_IRGRAPH_T_H
12 #define FIRM_IR_IRGRAPH_T_H
14 #include "firm_types.h"
21 #include "iredgekinds.h"
29 #define is_ir_graph(thing) is_ir_graph_(thing)
30 #define get_irg_start_block(irg) get_irg_start_block_(irg)
31 #define set_irg_start_block(irg, node) set_irg_start_block_(irg, node)
32 #define get_irg_start(irg) get_irg_start_(irg)
33 #define set_irg_start(irg, node) set_irg_start_(irg, node)
34 #define get_irg_end_block(irg) get_irg_end_block_(irg)
35 #define set_irg_end_block(irg, node) set_irg_end_block_(irg, node)
36 #define get_irg_end(irg) get_irg_end_(irg)
37 #define set_irg_end(irg, node) set_irg_end_(irg, node)
38 #define get_irg_initial_exec(irg) get_irg_initial_exec_(irg)
39 #define set_irg_initial_exec(irg, node) set_irg_initial_exec_(irg, node)
40 #define get_irg_frame(irg) get_irg_frame_(irg)
41 #define set_irg_frame(irg, node) set_irg_frame_(irg, node)
42 #define get_irg_initial_mem(irg) get_irg_initial_mem_(irg)
43 #define set_irg_initial_mem(irg, node) set_irg_initial_mem_(irg, node)
44 #define get_irg_args(irg) get_irg_args_(irg)
45 #define set_irg_args(irg, node) set_irg_args_(irg, node)
46 #define get_irg_no_mem(irg) get_irg_no_mem_(irg)
47 #define set_irn_no_mem(irg, node) set_irn_no_mem_(irg, node)
48 #define get_irg_entity(irg) get_irg_entity_(irg)
49 #define set_irg_entity(irg, ent) set_irg_entity_(irg, ent)
50 #define get_irg_frame_type(irg) get_irg_frame_type_(irg)
51 #define set_irg_frame_type(irg, ftp) set_irg_frame_type_(irg, ftp)
52 #define get_irg_pinned(irg) get_irg_pinned_(irg)
53 #define get_irg_callee_info_state(irg) get_irg_callee_info_state_(irg)
54 #define set_irg_callee_info_state(irg, s) set_irg_callee_info_state_(irg, s)
55 #define get_irg_additional_properties(irg) get_irg_additional_properties_(irg)
56 #define set_irg_additional_properties(irg, m) set_irg_additional_properties_(irg, m)
57 #define set_irg_additional_property(irg, f) set_irg_additional_property_(irg, f)
58 #define set_irg_link(irg, thing) set_irg_link_(irg, thing)
59 #define get_irg_link(irg) get_irg_link_(irg)
60 #define get_irg_visited(irg) get_irg_visited_(irg)
61 #define get_irg_block_visited(irg) get_irg_block_visited_(irg)
62 #define set_irg_block_visited(irg, v) set_irg_block_visited_(irg, v)
63 #define inc_irg_block_visited(irg) inc_irg_block_visited_(irg)
64 #define dec_irg_block_visited(irg) dec_irg_block_visited_(irg)
65 #define get_irg_fp_model(irg) get_irg_fp_model_(irg)
66 #define get_idx_irn(irg, idx) get_idx_irn_(irg, idx)
67 #define irg_is_constrained(irg, constraints) irg_is_constrained_(irg, constraints)
68 #define add_irg_properties(irg, props) add_irg_properties_(irg, props)
69 #define clear_irg_properties(irg, props) clear_irg_properties_(irg, props)
70 #define irg_has_properties(irg, props) irg_has_properties_(irg, props)
73 * Initializes the graph construction module.
75 void firm_init_irgraph(void);
78 * Set the number of locals for a given graph.
80 * @param irg the graph
81 * @param n_loc number of locals
83 void irg_set_nloc(ir_graph *res, int n_loc);
86 * Internal constructor that does not add to irp_irgs or the like.
88 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
91 * Make a rudimentary ir graph for the constant code.
92 * Must look like a correct irg, spare everything else.
94 ir_graph *new_const_code_irg(void);
97 * Create a new graph that is a copy of a given one.
98 * Uses the link fields of the original graphs.
100 * @param irg The graph that must be copied.
102 ir_graph *create_irg_copy(ir_graph *irg);
105 * Set the op_pin_state_pinned state of a graph.
107 * @param irg the IR graph
108 * @param p new pin state
110 static inline void set_irg_pinned(ir_graph *irg, op_pin_state p)
112 irg->irg_pinned_state = p;
115 /** Returns the obstack associated with the graph. */
116 static inline struct obstack *get_irg_obstack(ir_graph *const irg)
118 assert(obstack_object_size(&irg->obst) == 0);
125 * Returns true if the node n is allocated on the storage of graph irg.
127 * @param irg the IR graph
128 * @param n the IR node
130 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n);
132 /*-------------------------------------------------------------------*/
133 /* inline functions for graphs */
134 /*-------------------------------------------------------------------*/
136 static inline int is_ir_graph_(const void *thing)
138 return (get_kind(thing) == k_ir_graph);
141 /** Returns the start block of a graph. */
142 static inline ir_node *get_irg_start_block_(const ir_graph *irg)
144 return get_irn_n(irg->anchor, anchor_start_block);
147 static inline void set_irg_start_block_(ir_graph *irg, ir_node *node)
149 set_irn_n(irg->anchor, anchor_start_block, node);
152 static inline ir_node *get_irg_start_(const ir_graph *irg)
154 return get_irn_n(irg->anchor, anchor_start);
157 static inline void set_irg_start_(ir_graph *irg, ir_node *node)
159 set_irn_n(irg->anchor, anchor_start, node);
162 static inline ir_node *get_irg_end_block_(const ir_graph *irg)
164 return get_irn_n(irg->anchor, anchor_end_block);
167 static inline void set_irg_end_block_(ir_graph *irg, ir_node *node)
169 set_irn_n(irg->anchor, anchor_end_block, node);
172 static inline ir_node *get_irg_end_(const ir_graph *irg)
174 return get_irn_n(irg->anchor, anchor_end);
177 static inline void set_irg_end_(ir_graph *irg, ir_node *node)
179 set_irn_n(irg->anchor, anchor_end, node);
182 static inline ir_node *get_irg_initial_exec_(const ir_graph *irg)
184 return get_irn_n(irg->anchor, anchor_initial_exec);
187 static inline void set_irg_initial_exec_(ir_graph *irg, ir_node *node)
189 set_irn_n(irg->anchor, anchor_initial_exec, node);
192 static inline ir_node *get_irg_frame_(const ir_graph *irg)
194 return get_irn_n(irg->anchor, anchor_frame);
197 static inline void set_irg_frame_(ir_graph *irg, ir_node *node)
199 set_irn_n(irg->anchor, anchor_frame, node);
202 static inline ir_node *get_irg_initial_mem_(const ir_graph *irg)
204 return get_irn_n(irg->anchor, anchor_initial_mem);
207 static inline void set_irg_initial_mem_(ir_graph *irg, ir_node *node)
209 set_irn_n(irg->anchor, anchor_initial_mem, node);
212 static inline ir_node *get_irg_args_(const ir_graph *irg)
214 return get_irn_n(irg->anchor, anchor_args);
217 static inline void set_irg_args_(ir_graph *irg, ir_node *node)
219 set_irn_n(irg->anchor, anchor_args, node);
222 static inline ir_node *get_irg_no_mem_(const ir_graph *irg)
224 return get_irn_n(irg->anchor, anchor_no_mem);
227 static inline void set_irg_no_mem_(ir_graph *irg, ir_node *node)
229 set_irn_n(irg->anchor, anchor_no_mem, node);
232 static inline ir_entity *get_irg_entity_(const ir_graph *irg)
237 static inline void set_irg_entity_(ir_graph *irg, ir_entity *ent)
242 static inline ir_type *get_irg_frame_type_(ir_graph *irg)
244 assert(irg->frame_type);
245 return irg->frame_type;
248 static inline void set_irg_frame_type_(ir_graph *irg, ir_type *ftp)
250 assert(is_frame_type(ftp));
251 irg->frame_type = ftp;
254 static inline op_pin_state get_irg_pinned_(const ir_graph *irg)
256 return irg->irg_pinned_state;
259 static inline irg_callee_info_state get_irg_callee_info_state_(const ir_graph *irg)
261 return irg->callee_info_state;
264 static inline void set_irg_callee_info_state_(ir_graph *irg, irg_callee_info_state s)
266 irg_callee_info_state irp_state = get_irp_callee_info_state();
268 irg->callee_info_state = s;
270 /* I could compare ... but who knows? */
271 if ((irp_state == irg_callee_info_consistent) ||
272 ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
273 set_irp_callee_info_state(s);
276 static inline void set_irg_link_(ir_graph *irg, void *thing)
281 static inline void *get_irg_link_(const ir_graph *irg)
286 static inline ir_visited_t get_irg_visited_(const ir_graph *irg)
291 static inline ir_visited_t get_irg_block_visited_(const ir_graph *irg)
293 return irg->block_visited;
296 static inline void set_irg_block_visited_(ir_graph *irg, ir_visited_t visited)
298 irg->block_visited = visited;
301 static inline void inc_irg_block_visited_(ir_graph *irg)
303 ++irg->block_visited;
306 static inline void dec_irg_block_visited_(ir_graph *irg)
308 --irg->block_visited;
311 /* Return the floating point model of this graph. */
312 static inline unsigned get_irg_fp_model_(const ir_graph *irg)
314 return irg->fp_model;
317 static inline int irg_is_constrained_(const ir_graph *irg,
318 ir_graph_constraints_t constraints)
320 return (irg->constraints & constraints) == constraints;
323 static inline void add_irg_properties_(ir_graph *irg,
324 ir_graph_properties_t props)
326 irg->properties |= props;
329 static inline void clear_irg_properties_(ir_graph *irg,
330 ir_graph_properties_t props)
332 irg->properties &= ~props;
335 static inline int irg_has_properties_(const ir_graph *irg,
336 ir_graph_properties_t props)
338 return (irg->properties & props) == props;
342 * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
343 * @param irg The graph.
344 * @param irn The node.
345 * @return The index allocated for the node.
347 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn)
349 unsigned idx = irg->last_node_idx++;
350 if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
351 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
353 irg->idx_irn_map[idx] = irn;
358 * Kill a node from the irg. BEWARE: this kills
359 * all later created nodes.
361 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
363 unsigned idx = get_irn_idx(n);
364 assert(idx + 1 == irg->last_node_idx);
366 if (idx + 1 == irg->last_node_idx)
367 --irg->last_node_idx;
368 irg->idx_irn_map[idx] = NULL;
369 obstack_free(&irg->obst, n);
373 * Get the node for an index.
374 * @param irg The graph.
375 * @param idx The index you want the node for.
376 * @return The node with that index or NULL, if there is no node with that index.
377 * @note The node you got might be dead.
379 static inline ir_node *get_idx_irn_(const ir_graph *irg, unsigned idx)
381 assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
382 return irg->idx_irn_map[idx];
386 * Return the number of anchors in this graph.
388 static inline int get_irg_n_anchors(const ir_graph *irg)
390 return get_irn_arity(irg->anchor);
394 * Return anchor for given index
396 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
398 return get_irn_n(irg->anchor, idx);
402 * Set anchor for given index
404 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
406 set_irn_n(irg->anchor, idx, irn);