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  * @version  $Id$
  25  */
  26 #ifndef FIRM_IR_IRGRAPH_T_H
  27 #define FIRM_IR_IRGRAPH_T_H
  28
  29 #include "firm_types.h"
  30 #include "irgraph.h"
  31
  32 #include "irtypes.h"
  33 #include "irprog.h"
  34 #include "type_t.h"
  35 #include "entity_t.h"
  36 #include "iredgekinds.h"
  37
  38 #include "irloop.h"
  39
  40 #include "obst.h"
  41 #include "pset.h"
  42 #include "set.h"
  43
  44 /** Suffix that is added to every frame type. */
  45 #define FRAME_TP_SUFFIX "frame_tp"
  46
  47 /**
  48  * Initializes the graph construction module.
  49  */
  50 void firm_init_irgraph(void);
  51
  52 /**
  53  * Set the number of locals for a given graph.
  54  *
  55  * @param irg    the graph
  56  * @param n_loc  number of locals
  57  */
  58 void irg_set_nloc(ir_graph *res, int n_loc);
  59
  60 /**
  61  * Internal constructor that does not add to irp_irgs or the like.
  62  */
  63 ir_graph *new_r_ir_graph(ir_entity *ent, int n_loc);
  64
  65 /**
  66  * Make a rudimentary ir graph for the constant code.
  67  * Must look like a correct irg, spare everything else.
  68  */
  69 ir_graph *new_const_code_irg(void);
  70
  71 /**
  72  * Create a new graph that is a copy of a given one.
  73  * Uses the link fields of the original graphs.
  74  *
  75  * @param irg  The graph that must be copied.
  76  */
  77 ir_graph *create_irg_copy(ir_graph *irg);
  78
  79 /**
  80  * Set the op_pin_state_pinned state of a graph.
  81  *
  82  * @param irg     the IR graph
  83  * @param p       new pin state
  84  */
  85 void set_irg_pinned(ir_graph *irg, op_pin_state p);
  86
  87 /** Returns the obstack associated with the graph. */
  88 struct obstack *get_irg_obstack(const ir_graph *irg);
  89
  90 /**
  91  * Returns true if the node n is allocated on the storage of graph irg.
  92  *
  93  * @param irg   the IR graph
  94  * @param n the IR node
  95  */
  96 int node_is_in_irgs_storage(const ir_graph *irg, const ir_node *n);
  97
  98 /*-------------------------------------------------------------------*/
  99 /* inline functions for graphs                                       */
 100 /*-------------------------------------------------------------------*/
 101
 102 static inline int _is_ir_graph(const void *thing)
 103 {
 104         return (get_kind(thing) == k_ir_graph);
 105 }
 106
 107 /** Returns the start block of a graph. */
 108 static inline ir_node *_get_irg_start_block(const ir_graph *irg)
 109 {
 110         return get_irn_n(irg->anchor, anchor_start_block);
 111 }
 112
 113 static inline void _set_irg_start_block(ir_graph *irg, ir_node *node)
 114 {
 115         set_irn_n(irg->anchor, anchor_start_block, node);
 116 }
 117
 118 static inline ir_node *_get_irg_start(const ir_graph *irg)
 119 {
 120         return get_irn_n(irg->anchor, anchor_start);
 121 }
 122
 123 static inline void _set_irg_start(ir_graph *irg, ir_node *node)
 124 {
 125         set_irn_n(irg->anchor, anchor_start, node);
 126 }
 127
 128 static inline ir_node *_get_irg_end_block(const ir_graph *irg)
 129 {
 130         return get_irn_n(irg->anchor, anchor_end_block);
 131 }
 132
 133 static inline void _set_irg_end_block(ir_graph *irg, ir_node *node)
 134 {
 135         set_irn_n(irg->anchor, -1, node);
 136         set_irn_n(irg->anchor, anchor_end_block, node);
 137 }
 138
 139 static inline ir_node *_get_irg_end(const ir_graph *irg)
 140 {
 141         return get_irn_n(irg->anchor, anchor_end);
 142 }
 143
 144 static inline void _set_irg_end(ir_graph *irg, ir_node *node)
 145 {
 146         set_irn_n(irg->anchor, anchor_end, node);
 147 }
 148
 149 static inline ir_node *_get_irg_initial_exec(const ir_graph *irg)
 150 {
 151         return get_irn_n(irg->anchor, anchor_initial_exec);
 152 }
 153
 154 static inline void _set_irg_initial_exec(ir_graph *irg, ir_node *node)
 155 {
 156         set_irn_n(irg->anchor, anchor_initial_exec, node);
 157 }
 158
 159 static inline ir_node *_get_irg_frame(const ir_graph *irg)
 160 {
 161         return get_irn_n(irg->anchor, anchor_frame);
 162 }
 163
 164 static inline void _set_irg_frame(ir_graph *irg, ir_node *node)
 165 {
 166         set_irn_n(irg->anchor, anchor_frame, node);
 167 }
 168
 169 static inline ir_node *_get_irg_initial_mem(const ir_graph *irg)
 170 {
 171         return get_irn_n(irg->anchor, anchor_initial_mem);
 172 }
 173
 174 static inline void _set_irg_initial_mem(ir_graph *irg, ir_node *node)
 175 {
 176         set_irn_n(irg->anchor, anchor_initial_mem, node);
 177 }
 178
 179 static inline ir_node *_get_irg_args(const ir_graph *irg)
 180 {
 181         return get_irn_n(irg->anchor, anchor_args);
 182 }
 183
 184 static inline void _set_irg_args(ir_graph *irg, ir_node *node)
 185 {
 186         set_irn_n(irg->anchor, anchor_args, node);
 187 }
 188
 189 static inline ir_node * _get_irg_no_mem(const ir_graph *irg)
 190 {
 191         return get_irn_n(irg->anchor, anchor_no_mem);
 192 }
 193
 194 static inline void _set_irg_no_mem(ir_graph *irg, ir_node *node)
 195 {
 196         set_irn_n(irg->anchor, anchor_no_mem, node);
 197 }
 198
 199 static inline ir_entity *_get_irg_entity(const ir_graph *irg)
 200 {
 201         assert(irg);
 202         return irg->ent;
 203 }
 204
 205 static inline void _set_irg_entity(ir_graph *irg, ir_entity *ent)
 206 {
 207         irg->ent = ent;
 208 }
 209
 210 static inline ir_type *_get_irg_frame_type(ir_graph *irg)
 211 {
 212         assert(irg->frame_type);
 213         return irg->frame_type;
 214 }
 215
 216 static inline void _set_irg_frame_type(ir_graph *irg, ir_type *ftp)
 217 {
 218         assert(is_frame_type(ftp));
 219         irg->frame_type = ftp;
 220 }
 221
 222 static inline struct obstack *_get_irg_obstack(const ir_graph *irg)
 223 {
 224         return irg->obst;
 225 }
 226
 227
 228 static inline irg_phase_state _get_irg_phase_state(const ir_graph *irg)
 229 {
 230         return irg->phase_state;
 231 }
 232
 233 static inline void _set_irg_phase_state(ir_graph *irg, irg_phase_state state)
 234 {
 235         irg->phase_state = state;
 236 }
 237
 238 static inline op_pin_state _get_irg_pinned(const ir_graph *irg)
 239 {
 240         return irg->irg_pinned_state;
 241 }
 242
 243 static inline void _set_irg_pinned(ir_graph *irg, op_pin_state p)
 244 {
 245         irg->irg_pinned_state = p;
 246 }
 247
 248 static inline irg_callee_info_state _get_irg_callee_info_state(const ir_graph *irg)
 249 {
 250         return irg->callee_info_state;
 251 }
 252
 253 static inline void _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s)
 254 {
 255         irg_callee_info_state irp_state = get_irp_callee_info_state();
 256
 257         irg->callee_info_state = s;
 258
 259         /* I could compare ... but who knows? */
 260         if ((irp_state == irg_callee_info_consistent)  ||
 261             ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
 262                 set_irp_callee_info_state(s);
 263 }
 264
 265 static inline irg_inline_property _get_irg_inline_property(const ir_graph *irg)
 266 {
 267         return irg->inline_property;
 268 }
 269
 270 static inline void _set_irg_inline_property(ir_graph *irg, irg_inline_property s)
 271 {
 272         irg->inline_property = s;
 273 }
 274
 275 static inline mtp_additional_properties _get_irg_additional_properties(const ir_graph *irg)
 276 {
 277         if (irg->additional_properties & mtp_property_inherited)
 278                 return get_method_additional_properties(get_entity_type(irg->ent));
 279         return irg->additional_properties;
 280 }
 281
 282 static inline void _set_irg_additional_properties(ir_graph *irg, mtp_additional_properties mask)
 283 {
 284         irg->additional_properties = mask & ~mtp_property_inherited;
 285 }
 286
 287 static inline void _add_irg_additional_properties(ir_graph *irg, mtp_additional_properties flag)
 288 {
 289         mtp_additional_properties prop = irg->additional_properties;
 290
 291         if (prop & mtp_property_inherited)
 292                 prop = get_method_additional_properties(get_entity_type(irg->ent));
 293         irg->additional_properties = prop | flag;
 294 }
 295
 296 static inline void _set_irg_link(ir_graph *irg, void *thing)
 297 {
 298         irg->link = thing;
 299 }
 300
 301 static inline void *_get_irg_link(const ir_graph *irg)
 302 {
 303         return irg->link;
 304 }
 305
 306 static inline ir_visited_t _get_irg_visited(const ir_graph *irg)
 307 {
 308         return irg->visited;
 309 }
 310
 311 static inline ir_visited_t _get_irg_block_visited(const ir_graph *irg)
 312 {
 313         return irg->block_visited;
 314 }
 315
 316 static inline void _set_irg_block_visited(ir_graph *irg, ir_visited_t visited)
 317 {
 318         irg->block_visited = visited;
 319 }
 320
 321 static inline void _inc_irg_block_visited(ir_graph *irg)
 322 {
 323         ++irg->block_visited;
 324 }
 325
 326 static inline void _dec_irg_block_visited(ir_graph *irg)
 327 {
 328         --irg->block_visited;
 329 }
 330
 331 static inline unsigned _get_irg_estimated_node_cnt(const ir_graph *irg)
 332 {
 333         return irg->estimated_node_count;
 334 }
 335
 336 /* Return the floating point model of this graph. */
 337 static inline unsigned _get_irg_fp_model(const ir_graph *irg)
 338 {
 339         return irg->fp_model;
 340 }
 341
 342 static inline void _set_irg_state(ir_graph *irg, ir_graph_state_t state)
 343 {
 344         irg->state = (ir_graph_state_t) (irg->state | state);
 345 }
 346
 347 static inline void _clear_irg_state(ir_graph *irg, ir_graph_state_t state)
 348 {
 349         irg->state = (ir_graph_state_t) (irg->state & ~state);
 350 }
 351
 352 static inline int _is_irg_state(const ir_graph *irg, ir_graph_state_t state)
 353 {
 354         return (irg->state & state) == state;
 355 }
 356
 357 /**
 358  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
 359  * @param irg The graph.
 360  * @param irn The node.
 361  * @return    The index allocated for the node.
 362  */
 363 static inline unsigned irg_register_node_idx(ir_graph *irg, ir_node *irn)
 364 {
 365         unsigned idx = irg->last_node_idx++;
 366         if (idx >= (unsigned)ARR_LEN(irg->idx_irn_map))
 367                 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
 368
 369         irg->idx_irn_map[idx] = irn;
 370         return idx;
 371 }
 372
 373 /**
 374  * Kill a node from the irg. BEWARE: this kills
 375  * all later created nodes.
 376  */
 377 static inline void irg_kill_node(ir_graph *irg, ir_node *n)
 378 {
 379         unsigned idx = get_irn_idx(n);
 380         assert(idx + 1 == irg->last_node_idx);
 381
 382         if (idx + 1 == irg->last_node_idx)
 383                 --irg->last_node_idx;
 384         irg->idx_irn_map[idx] = NULL;
 385         obstack_free(irg->obst, n);
 386 }
 387
 388 /**
 389  * Get the node for an index.
 390  * @param irg The graph.
 391  * @param idx The index you want the node for.
 392  * @return    The node with that index or NULL, if there is no node with that index.
 393  * @note      The node you got might be dead.
 394  */
 395 static inline ir_node *_get_idx_irn(const ir_graph *irg, unsigned idx)
 396 {
 397         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
 398         return irg->idx_irn_map[idx];
 399 }
 400
 401 /**
 402  * Return the number of anchors in this graph.
 403  */
 404 static inline int get_irg_n_anchors(const ir_graph *irg)
 405 {
 406         return get_irn_arity(irg->anchor);
 407 }
 408
 409 /**
 410  * Return anchor for given index
 411  */
 412 static inline ir_node *get_irg_anchor(const ir_graph *irg, int idx)
 413 {
 414         return get_irn_n(irg->anchor, idx);
 415 }
 416
 417 /**
 418  * Set anchor for given index
 419  */
 420 static inline void set_irg_anchor(ir_graph *irg, int idx, ir_node *irn)
 421 {
 422         set_irn_n(irg->anchor, idx, irn);
 423 }
 424
 425
 426
 427 /**
 428  * Register a phase on an irg.
 429  * The phase will then be managed by the irg. This means you can easily
 430  * access the phase when you only have a graph handle, the memory will be
 431  * freed when the graph is freed and some care is taken that the phase data
 432  * will be invalidated/preserved on events like dead code elemination and
 433  * code selection.
 434  */
 435 void irg_register_phase(ir_graph *irg, ir_phase_id id, ir_phase *phase);
 436
 437 /**
 438  * Frees all phase infos attached to an irg
 439  */
 440 void irg_invalidate_phases(ir_graph *irg);
 441
 442 /**
 443  * return phase with given id
 444  */
 445 static inline ir_phase *irg_get_phase(const ir_graph *irg, ir_phase_id id)
 446 {
 447         assert(id <= PHASE_LAST);
 448         return irg->phases[id];
 449 }
 450
 451
 452 #define is_ir_graph(thing)                    _is_ir_graph(thing)
 453 #define get_irg_start_block(irg)              _get_irg_start_block(irg)
 454 #define set_irg_start_block(irg, node)        _set_irg_start_block(irg, node)
 455 #define get_irg_start(irg)                    _get_irg_start(irg)
 456 #define set_irg_start(irg, node)              _set_irg_start(irg, node)
 457 #define get_irg_end_block(irg)                _get_irg_end_block(irg)
 458 #define set_irg_end_block(irg, node)          _set_irg_end_block(irg, node)
 459 #define get_irg_end(irg)                      _get_irg_end(irg)
 460 #define set_irg_end(irg, node)                _set_irg_end(irg, node)
 461 #define get_irg_initial_exec(irg)             _get_irg_initial_exec(irg)
 462 #define set_irg_initial_exec(irg, node)       _set_irg_initial_exec(irg, node)
 463 #define get_irg_frame(irg)                    _get_irg_frame(irg)
 464 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
 465 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
 466 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
 467 #define get_irg_args(irg)                     _get_irg_args(irg)
 468 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
 469 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
 470 #define set_irn_no_mem(irg, node)             _set_irn_no_mem(irg, node)
 471 #define get_irg_entity(irg)                   _get_irg_entity(irg)
 472 #define set_irg_entity(irg, ent)              _set_irg_entity(irg, ent)
 473 #define get_irg_frame_type(irg)               _get_irg_frame_type(irg)
 474 #define set_irg_frame_type(irg, ftp)          _set_irg_frame_type(irg, ftp)
 475 #define get_irg_obstack(irg)                  _get_irg_obstack(irg)
 476 #define get_irg_phase_state(irg)              _get_irg_phase_state(irg)
 477 #define set_irg_phase_state(irg, state)       _set_irg_phase_state(irg, state)
 478 #define get_irg_pinned(irg)                   _get_irg_pinned(irg)
 479 #define set_irg_pinned(irg, p)                _set_irg_pinned(irg, p)
 480 #define get_irg_callee_info_state(irg)        _get_irg_callee_info_state(irg)
 481 #define set_irg_callee_info_state(irg, s)     _set_irg_callee_info_state(irg, s)
 482 #define get_irg_inline_property(irg)          _get_irg_inline_property(irg)
 483 #define set_irg_inline_property(irg, s)       _set_irg_inline_property(irg, s)
 484 #define get_irg_additional_properties(irg)    _get_irg_additional_properties(irg)
 485 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
 486 #define set_irg_additional_property(irg, f)   _set_irg_additional_property(irg, f)
 487 #define set_irg_link(irg, thing)              _set_irg_link(irg, thing)
 488 #define get_irg_link(irg)                     _get_irg_link(irg)
 489 #define get_irg_visited(irg)                  _get_irg_visited(irg)
 490 #define get_irg_block_visited(irg)            _get_irg_block_visited(irg)
 491 #define set_irg_block_visited(irg, v)         _set_irg_block_visited(irg, v)
 492 #define inc_irg_block_visited(irg)            _inc_irg_block_visited(irg)
 493 #define dec_irg_block_visited(irg)            _dec_irg_block_visited(irg)
 494 #define get_irg_estimated_node_cnt(irg)       _get_irg_estimated_node_cnt(irg)
 495 #define get_irg_fp_model(irg)                 _get_irg_fp_model(irg)
 496 #define get_idx_irn(irg, idx)                 _get_idx_irn(irg, idx)
 497 #define set_irg_state(irg, state)             _set_irg_state(irg, state)
 498 #define clear_irg_state(irg, state)           _clear_irg_state(irg, state)
 499 #define is_irg_state(irg, state)              _is_irg_state(irg, state)
 500
 501 #endif