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(const ir_graph *irg)
 131 {
 132         return irg->obst;
 133 }
 134
 135
 136
 137 /**
 138  * Returns true if the node n is allocated on the storage of graph irg.
 139  *
 140  * @param irg   the IR graph
 141  * @param n the IR node
 142  */
 143 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n);
 144
 145 /*-------------------------------------------------------------------*/
 146 /* inline functions for graphs                                       */
 147 /*-------------------------------------------------------------------*/
 148
 149 static inline int is_ir_graph_(const void *thing)
 150 {
 151         return (get_kind(thing) == k_ir_graph);
 152 }
 153
 154 /** Returns the start block of a graph. */
 155 static inline ir_node *get_irg_start_block_(const ir_graph *irg)
 156 {
 157         return get_irn_n(irg->anchor, anchor_start_block);
 158 }
 159
 160 static inline void set_irg_start_block_(ir_graph *irg, ir_node *node)
 161 {
 162         set_irn_n(irg->anchor, anchor_start_block, node);
 163 }
 164
 165 static inline ir_node *get_irg_start_(const ir_graph *irg)
 166 {
 167         return get_irn_n(irg->anchor, anchor_start);
 168 }
 169
 170 static inline void set_irg_start_(ir_graph *irg, ir_node *node)
 171 {
 172         set_irn_n(irg->anchor, anchor_start, node);
 173 }
 174
 175 static inline ir_node *get_irg_end_block_(const ir_graph *irg)
 176 {
 177         return get_irn_n(irg->anchor, anchor_end_block);
 178 }
 179
 180 static inline void set_irg_end_block_(ir_graph *irg, ir_node *node)
 181 {
 182         set_irn_n(irg->anchor, anchor_end_block, node);
 183 }
 184
 185 static inline ir_node *get_irg_end_(const ir_graph *irg)
 186 {
 187         return get_irn_n(irg->anchor, anchor_end);
 188 }
 189
 190 static inline void set_irg_end_(ir_graph *irg, ir_node *node)
 191 {
 192         set_irn_n(irg->anchor, anchor_end, node);
 193 }
 194
 195 static inline ir_node *get_irg_initial_exec_(const ir_graph *irg)
 196 {
 197         return get_irn_n(irg->anchor, anchor_initial_exec);
 198 }
 199
 200 static inline void set_irg_initial_exec_(ir_graph *irg, ir_node *node)
 201 {
 202         set_irn_n(irg->anchor, anchor_initial_exec, node);
 203 }
 204
 205 static inline ir_node *get_irg_frame_(const ir_graph *irg)
 206 {
 207         return get_irn_n(irg->anchor, anchor_frame);
 208 }
 209
 210 static inline void set_irg_frame_(ir_graph *irg, ir_node *node)
 211 {
 212         set_irn_n(irg->anchor, anchor_frame, node);
 213 }
 214
 215 static inline ir_node *get_irg_initial_mem_(const ir_graph *irg)
 216 {
 217         return get_irn_n(irg->anchor, anchor_initial_mem);
 218 }
 219
 220 static inline void set_irg_initial_mem_(ir_graph *irg, ir_node *node)
 221 {
 222         set_irn_n(irg->anchor, anchor_initial_mem, node);
 223 }
 224
 225 static inline ir_node *get_irg_args_(const ir_graph *irg)
 226 {
 227         return get_irn_n(irg->anchor, anchor_args);
 228 }
 229
 230 static inline void set_irg_args_(ir_graph *irg, ir_node *node)
 231 {
 232         set_irn_n(irg->anchor, anchor_args, node);
 233 }
 234
 235 static inline ir_node *get_irg_no_mem_(const ir_graph *irg)
 236 {
 237         return get_irn_n(irg->anchor, anchor_no_mem);
 238 }
 239
 240 static inline void set_irg_no_mem_(ir_graph *irg, ir_node *node)
 241 {
 242         set_irn_n(irg->anchor, anchor_no_mem, node);
 243 }
 244
 245 static inline ir_entity *get_irg_entity_(const ir_graph *irg)
 246 {
 247         return irg->ent;
 248 }
 249
 250 static inline void set_irg_entity_(ir_graph *irg, ir_entity *ent)
 251 {
 252         irg->ent = ent;
 253 }
 254
 255 static inline ir_type *get_irg_frame_type_(ir_graph *irg)
 256 {
 257         assert(irg->frame_type);
 258         return irg->frame_type;
 259 }
 260
 261 static inline void set_irg_frame_type_(ir_graph *irg, ir_type *ftp)
 262 {
 263         assert(is_frame_type(ftp));
 264         irg->frame_type = ftp;
 265 }
 266
 267 static inline op_pin_state get_irg_pinned_(const ir_graph *irg)
 268 {
 269         return irg->irg_pinned_state;
 270 }
 271
 272 static inline irg_callee_info_state get_irg_callee_info_state_(const ir_graph *irg)
 273 {
 274         return irg->callee_info_state;
 275 }
 276
 277 static inline void set_irg_callee_info_state_(ir_graph *irg, irg_callee_info_state s)
 278 {
 279         irg_callee_info_state irp_state = get_irp_callee_info_state();
 280
 281         irg->callee_info_state = s;
 282
 283         /* I could compare ... but who knows? */
 284         if ((irp_state == irg_callee_info_consistent)  ||
 285             ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 286                 set_irp_callee_info_state(s);
 287 }
 288
 289 static inline void set_irg_link_(ir_graph *irg, void *thing)
 290 {
 291         irg->link = thing;
 292 }
 293
 294 static inline void *get_irg_link_(const ir_graph *irg)
 295 {
 296         return irg->link;
 297 }
 298
 299 static inline ir_visited_t get_irg_visited_(const ir_graph *irg)
 300 {
 301         return irg->visited;
 302 }
 303
 304 static inline ir_visited_t get_irg_block_visited_(const ir_graph *irg)
 305 {
 306         return irg->block_visited;
 307 }
 308
 309 static inline void set_irg_block_visited_(ir_graph *irg, ir_visited_t visited)
 310 {
 311         irg->block_visited = visited;
 312 }
 313
 314 static inline void inc_irg_block_visited_(ir_graph *irg)
 315 {
 316         ++irg->block_visited;
 317 }
 318
 319 static inline void dec_irg_block_visited_(ir_graph *irg)
 320 {
 321         --irg->block_visited;
 322 }
 323
 324 /* Return the floating point model of this graph. */
 325 static inline unsigned get_irg_fp_model_(const ir_graph *irg)
 326 {
 327         return irg->fp_model;
 328 }
 329
 330 static inline int irg_is_constrained_(const ir_graph *irg,
 331                                       ir_graph_constraints_t constraints)
 332 {
 333         return (irg->constraints & constraints) == constraints;
 334 }
 335
 336 static inline void add_irg_properties_(ir_graph *irg,
 337                                        ir_graph_properties_t props)
 338 {
 339         irg->properties |= props;
 340 }
 341
 342 static inline void clear_irg_properties_(ir_graph *irg,
 343                                     ir_graph_properties_t props)
 344 {
 345         irg->properties &= ~props;
 346 }
 347
 348 static inline int irg_has_properties_(const ir_graph *irg,
 349                                       ir_graph_properties_t props)
 350 {
 351         return (irg->properties & props) == props;
 352 }
 353
 354 /**
 355  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
 356  * @param irg The graph.
 357  * @param irn The node.
 358  * @return    The index allocated for the node.
 359  */
 360 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn)
 361 {
 362         unsigned idx = irg->last_node_idx++;
 363         if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
 364                 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
 365
 366         irg->idx_irn_map[idx] = irn;
 367         return idx;
 368 }
 369
 370 /**
 371  * Kill a node from the irg. BEWARE: this kills
 372  * all later created nodes.
 373  */
 374 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
 375 {
 376         unsigned idx = get_irn_idx(n);
 377         assert(idx + 1 == irg->last_node_idx);
 378
 379         if (idx + 1 == irg->last_node_idx)
 380                 --irg->last_node_idx;
 381         irg->idx_irn_map[idx] = NULL;
 382         obstack_free(irg->obst, n);
 383 }
 384
 385 /**
 386  * Get the node for an index.
 387  * @param irg The graph.
 388  * @param idx The index you want the node for.
 389  * @return    The node with that index or NULL, if there is no node with that index.
 390  * @note      The node you got might be dead.
 391  */
 392 static inline ir_node *get_idx_irn_(const ir_graph *irg, unsigned idx)
 393 {
 394         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
 395         return irg->idx_irn_map[idx];
 396 }
 397
 398 /**
 399  * Return the number of anchors in this graph.
 400  */
 401 static inline int get_irg_n_anchors(const ir_graph *irg)
 402 {
 403         return get_irn_arity(irg->anchor);
 404 }
 405
 406 /**
 407  * Return anchor for given index
 408  */
 409 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
 410 {
 411         return get_irn_n(irg->anchor, idx);
 412 }
 413
 414 /**
 415  * Set anchor for given index
 416  */
 417 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
 418 {
 419         set_irn_n(irg->anchor, idx, irn);
 420 }
 421
 422 #endif