nsz Git - libfirm/blob - ir/ir/irgraph_t.h

   1 /*
   2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   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.
  10  *
  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.
  14  *
  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
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    Entry point to the representation of procedure code -- internal header.
  23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  */
  25 #ifndef FIRM_IR_IRGRAPH_T_H
  26 #define FIRM_IR_IRGRAPH_T_H
  27
  28 #include "firm_types.h"
  29 #include "irgraph.h"
  30
  31 #include "irtypes.h"
  32 #include "irprog.h"
  33 #include "type_t.h"
  34 #include "entity_t.h"
  35 #include "iredgekinds.h"
  36
  37 #include "irloop.h"
  38
  39 #include "obst.h"
  40 #include "pset.h"
  41 #include "set.h"
  42
  43 #define is_ir_graph(thing)                    is_ir_graph_(thing)
  44 #define get_irg_start_block(irg)              get_irg_start_block_(irg)
  45 #define set_irg_start_block(irg, node)        set_irg_start_block_(irg, node)
  46 #define get_irg_start(irg)                    get_irg_start_(irg)
  47 #define set_irg_start(irg, node)              set_irg_start_(irg, node)
  48 #define get_irg_end_block(irg)                get_irg_end_block_(irg)
  49 #define set_irg_end_block(irg, node)          set_irg_end_block_(irg, node)
  50 #define get_irg_end(irg)                      get_irg_end_(irg)
  51 #define set_irg_end(irg, node)                set_irg_end_(irg, node)
  52 #define get_irg_initial_exec(irg)             get_irg_initial_exec_(irg)
  53 #define set_irg_initial_exec(irg, node)       set_irg_initial_exec_(irg, node)
  54 #define get_irg_frame(irg)                    get_irg_frame_(irg)
  55 #define set_irg_frame(irg, node)              set_irg_frame_(irg, node)
  56 #define get_irg_initial_mem(irg)              get_irg_initial_mem_(irg)
  57 #define set_irg_initial_mem(irg, node)        set_irg_initial_mem_(irg, node)
  58 #define get_irg_args(irg)                     get_irg_args_(irg)
  59 #define set_irg_args(irg, node)               set_irg_args_(irg, node)
  60 #define get_irg_no_mem(irg)                   get_irg_no_mem_(irg)
  61 #define set_irn_no_mem(irg, node)             set_irn_no_mem_(irg, node)
  62 #define get_irg_entity(irg)                   get_irg_entity_(irg)
  63 #define set_irg_entity(irg, ent)              set_irg_entity_(irg, ent)
  64 #define get_irg_frame_type(irg)               get_irg_frame_type_(irg)
  65 #define set_irg_frame_type(irg, ftp)          set_irg_frame_type_(irg, ftp)
  66 #define get_irg_pinned(irg)                   get_irg_pinned_(irg)
  67 #define get_irg_callee_info_state(irg)        get_irg_callee_info_state_(irg)
  68 #define set_irg_callee_info_state(irg, s)     set_irg_callee_info_state_(irg, s)
  69 #define get_irg_additional_properties(irg)    get_irg_additional_properties_(irg)
  70 #define set_irg_additional_properties(irg, m) set_irg_additional_properties_(irg, m)
  71 #define set_irg_additional_property(irg, f)   set_irg_additional_property_(irg, f)
  72 #define set_irg_link(irg, thing)              set_irg_link_(irg, thing)
  73 #define get_irg_link(irg)                     get_irg_link_(irg)
  74 #define get_irg_visited(irg)                  get_irg_visited_(irg)
  75 #define get_irg_block_visited(irg)            get_irg_block_visited_(irg)
  76 #define set_irg_block_visited(irg, v)         set_irg_block_visited_(irg, v)
  77 #define inc_irg_block_visited(irg)            inc_irg_block_visited_(irg)
  78 #define dec_irg_block_visited(irg)            dec_irg_block_visited_(irg)
  79 #define get_irg_fp_model(irg)                 get_irg_fp_model_(irg)
  80 #define get_idx_irn(irg, idx)                 get_idx_irn_(irg, idx)
  81 #define irg_is_constrained(irg, constraints)  irg_is_constrained_(irg, constraints)
  82 #define add_irg_properties(irg, props)        add_irg_properties_(irg, props)
  83 #define clear_irg_properties(irg, props)      clear_irg_properties_(irg, props)
  84 #define irg_has_properties(irg, props)        irg_has_properties_(irg, props)
  85
  86 /**
  87  * Initializes the graph construction module.
  88  */
  89 void firm_init_irgraph(void);
  90
  91 /**
  92  * Set the number of locals for a given graph.
  93  *
  94  * @param irg    the graph
  95  * @param n_loc  number of locals
  96  */
  97 void irg_set_nloc(ir_graph *res, int n_loc);
  98
  99 /**
 100  * Internal constructor that does not add to irp_irgs or the like.
 101  */
 102 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
 103
 104 /**
 105  * Make a rudimentary ir graph for the constant code.
 106  * Must look like a correct irg, spare everything else.
 107  */
 108 ir_graph *new_const_code_irg(void);
 109
 110 /**
 111  * Create a new graph that is a copy of a given one.
 112  * Uses the link fields of the original graphs.
 113  *
 114  * @param irg  The graph that must be copied.
 115  */
 116 ir_graph *create_irg_copy(ir_graph *irg);
 117
 118 /**
 119  * Set the op_pin_state_pinned state of a graph.
 120  *
 121  * @param irg     the IR graph
 122  * @param p       new pin state
 123  */
 124 static inline void set_irg_pinned(ir_graph *irg, op_pin_state p)
 125 {
 126         irg->irg_pinned_state = p;
 127 }
 128
 129 /** Returns the obstack associated with the graph. */
 130 static inline struct obstack *get_irg_obstack(ir_graph *const irg)
 131 {
 132         assert(obstack_object_size(&irg->obst) == 0);
 133         return &irg->obst;
 134 }
 135
 136
 137
 138 /**
 139  * Returns true if the node n is allocated on the storage of graph irg.
 140  *
 141  * @param irg   the IR graph
 142  * @param n the IR node
 143  */
 144 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n);
 145
 146 /*-------------------------------------------------------------------*/
 147 /* inline functions for graphs                                       */
 148 /*-------------------------------------------------------------------*/
 149
 150 static inline int is_ir_graph_(const void *thing)
 151 {
 152         return (get_kind(thing) == k_ir_graph);
 153 }
 154
 155 /** Returns the start block of a graph. */
 156 static inline ir_node *get_irg_start_block_(const ir_graph *irg)
 157 {
 158         return get_irn_n(irg->anchor, anchor_start_block);
 159 }
 160
 161 static inline void set_irg_start_block_(ir_graph *irg, ir_node *node)
 162 {
 163         set_irn_n(irg->anchor, anchor_start_block, node);
 164 }
 165
 166 static inline ir_node *get_irg_start_(const ir_graph *irg)
 167 {
 168         return get_irn_n(irg->anchor, anchor_start);
 169 }
 170
 171 static inline void set_irg_start_(ir_graph *irg, ir_node *node)
 172 {
 173         set_irn_n(irg->anchor, anchor_start, node);
 174 }
 175
 176 static inline ir_node *get_irg_end_block_(const ir_graph *irg)
 177 {
 178         return get_irn_n(irg->anchor, anchor_end_block);
 179 }
 180
 181 static inline void set_irg_end_block_(ir_graph *irg, ir_node *node)
 182 {
 183         set_irn_n(irg->anchor, anchor_end_block, node);
 184 }
 185
 186 static inline ir_node *get_irg_end_(const ir_graph *irg)
 187 {
 188         return get_irn_n(irg->anchor, anchor_end);
 189 }
 190
 191 static inline void set_irg_end_(ir_graph *irg, ir_node *node)
 192 {
 193         set_irn_n(irg->anchor, anchor_end, node);
 194 }
 195
 196 static inline ir_node *get_irg_initial_exec_(const ir_graph *irg)
 197 {
 198         return get_irn_n(irg->anchor, anchor_initial_exec);
 199 }
 200
 201 static inline void set_irg_initial_exec_(ir_graph *irg, ir_node *node)
 202 {
 203         set_irn_n(irg->anchor, anchor_initial_exec, node);
 204 }
 205
 206 static inline ir_node *get_irg_frame_(const ir_graph *irg)
 207 {
 208         return get_irn_n(irg->anchor, anchor_frame);
 209 }
 210
 211 static inline void set_irg_frame_(ir_graph *irg, ir_node *node)
 212 {
 213         set_irn_n(irg->anchor, anchor_frame, node);
 214 }
 215
 216 static inline ir_node *get_irg_initial_mem_(const ir_graph *irg)
 217 {
 218         return get_irn_n(irg->anchor, anchor_initial_mem);
 219 }
 220
 221 static inline void set_irg_initial_mem_(ir_graph *irg, ir_node *node)
 222 {
 223         set_irn_n(irg->anchor, anchor_initial_mem, node);
 224 }
 225
 226 static inline ir_node *get_irg_args_(const ir_graph *irg)
 227 {
 228         return get_irn_n(irg->anchor, anchor_args);
 229 }
 230
 231 static inline void set_irg_args_(ir_graph *irg, ir_node *node)
 232 {
 233         set_irn_n(irg->anchor, anchor_args, node);
 234 }
 235
 236 static inline ir_node *get_irg_no_mem_(const ir_graph *irg)
 237 {
 238         return get_irn_n(irg->anchor, anchor_no_mem);
 239 }
 240
 241 static inline void set_irg_no_mem_(ir_graph *irg, ir_node *node)
 242 {
 243         set_irn_n(irg->anchor, anchor_no_mem, node);
 244 }
 245
 246 static inline ir_entity *get_irg_entity_(const ir_graph *irg)
 247 {
 248         return irg->ent;
 249 }
 250
 251 static inline void set_irg_entity_(ir_graph *irg, ir_entity *ent)
 252 {
 253         irg->ent = ent;
 254 }
 255
 256 static inline ir_type *get_irg_frame_type_(ir_graph *irg)
 257 {
 258         assert(irg->frame_type);
 259         return irg->frame_type;
 260 }
 261
 262 static inline void set_irg_frame_type_(ir_graph *irg, ir_type *ftp)
 263 {
 264         assert(is_frame_type(ftp));
 265         irg->frame_type = ftp;
 266 }
 267
 268 static inline op_pin_state get_irg_pinned_(const ir_graph *irg)
 269 {
 270         return irg->irg_pinned_state;
 271 }
 272
 273 static inline irg_callee_info_state get_irg_callee_info_state_(const ir_graph *irg)
 274 {
 275         return irg->callee_info_state;
 276 }
 277
 278 static inline void set_irg_callee_info_state_(ir_graph *irg, irg_callee_info_state s)
 279 {
 280         irg_callee_info_state irp_state = get_irp_callee_info_state();
 281
 282         irg->callee_info_state = s;
 283
 284         /* I could compare ... but who knows? */
 285         if ((irp_state == irg_callee_info_consistent)  ||
 286             ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 287                 set_irp_callee_info_state(s);
 288 }
 289
 290 static inline void set_irg_link_(ir_graph *irg, void *thing)
 291 {
 292         irg->link = thing;
 293 }
 294
 295 static inline void *get_irg_link_(const ir_graph *irg)
 296 {
 297         return irg->link;
 298 }
 299
 300 static inline ir_visited_t get_irg_visited_(const ir_graph *irg)
 301 {
 302         return irg->visited;
 303 }
 304
 305 static inline ir_visited_t get_irg_block_visited_(const ir_graph *irg)
 306 {
 307         return irg->block_visited;
 308 }
 309
 310 static inline void set_irg_block_visited_(ir_graph *irg, ir_visited_t visited)
 311 {
 312         irg->block_visited = visited;
 313 }
 314
 315 static inline void inc_irg_block_visited_(ir_graph *irg)
 316 {
 317         ++irg->block_visited;
 318 }
 319
 320 static inline void dec_irg_block_visited_(ir_graph *irg)
 321 {
 322         --irg->block_visited;
 323 }
 324
 325 /* Return the floating point model of this graph. */
 326 static inline unsigned get_irg_fp_model_(const ir_graph *irg)
 327 {
 328         return irg->fp_model;
 329 }
 330
 331 static inline int irg_is_constrained_(const ir_graph *irg,
 332                                       ir_graph_constraints_t constraints)
 333 {
 334         return (irg->constraints & constraints) == constraints;
 335 }
 336
 337 static inline void add_irg_properties_(ir_graph *irg,
 338                                        ir_graph_properties_t props)
 339 {
 340         irg->properties |= props;
 341 }
 342
 343 static inline void clear_irg_properties_(ir_graph *irg,
 344                                     ir_graph_properties_t props)
 345 {
 346         irg->properties &= ~props;
 347 }
 348
 349 static inline int irg_has_properties_(const ir_graph *irg,
 350                                       ir_graph_properties_t props)
 351 {
 352         return (irg->properties & props) == props;
 353 }
 354
 355 /**
 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.
 360  */
 361 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn)
 362 {
 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);
 366
 367         irg->idx_irn_map[idx] = irn;
 368         return idx;
 369 }
 370
 371 /**
 372  * Kill a node from the irg. BEWARE: this kills
 373  * all later created nodes.
 374  */
 375 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
 376 {
 377         unsigned idx = get_irn_idx(n);
 378         assert(idx + 1 == irg->last_node_idx);
 379
 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);
 384 }
 385
 386 /**
 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.
 392  */
 393 static inline ir_node *get_idx_irn_(const ir_graph *irg, unsigned idx)
 394 {
 395         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
 396         return irg->idx_irn_map[idx];
 397 }
 398
 399 /**
 400  * Return the number of anchors in this graph.
 401  */
 402 static inline int get_irg_n_anchors(const ir_graph *irg)
 403 {
 404         return get_irn_arity(irg->anchor);
 405 }
 406
 407 /**
 408  * Return anchor for given index
 409  */
 410 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
 411 {
 412         return get_irn_n(irg->anchor, idx);
 413 }
 414
 415 /**
 416  * Set anchor for given index
 417  */
 418 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
 419 {
 420         set_irn_n(irg->anchor, idx, irn);
 421 }
 422
 423 #endif