nsz Git - libfirm/blob - ir/ir/irprog.c

   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 a whole program.
  23  * @author   Goetz Lindenmaier, Michael Beck
  24  * @date     2000
  25  * @version  $Id$
  26  */
  27 #include "config.h"
  28
  29 #include <string.h>
  30
  31 #include "irprog_t.h"
  32 #include "irgraph_t.h"
  33 #include "irpass_t.h"
  34 #include "pseudo_irg.h"
  35 #include "array.h"
  36 #include "error.h"
  37 #include "obst.h"
  38 #include "irop_t.h"
  39 #include "irmemory.h"
  40
  41 /** The initial name of the irp program. */
  42 #define INITAL_PROG_NAME "no_name_set"
  43
  44 /* A variable from where everything in the ir can be accessed. */
  45 ir_prog *irp;
  46 ir_prog *get_irp(void) { return irp; }
  47
  48 /**
  49  *  Create a new incomplete ir_prog.
  50  */
  51 static ir_prog *new_incomplete_ir_prog(void)
  52 {
  53         ir_prog *res = XMALLOCZ(ir_prog);
  54
  55         res->kind           = k_ir_prog;
  56         res->graphs         = NEW_ARR_F(ir_graph *, 0);
  57         res->pseudo_graphs  = NEW_ARR_F(ir_graph *, 0);
  58         res->types          = NEW_ARR_F(ir_type *, 0);
  59         res->modes          = NEW_ARR_F(ir_mode *, 0);
  60         res->opcodes        = NEW_ARR_F(ir_op *, 0);
  61         res->global_asms    = NEW_ARR_F(ident *, 0);
  62         res->last_region_nr = 0;
  63         res->last_label_nr  = 1;  /* 0 is reserved as non-label */
  64         res->max_irg_idx    = 0;
  65         res->max_node_nr    = 0;
  66 #ifndef NDEBUG
  67         res->reserved_resources = 0;
  68 #endif
  69
  70         return res;
  71 }
  72
  73 /**
  74  * Completes an incomplete irprog.
  75  *
  76  * @param irp          the (yet incomplete) irp
  77  * @param module_name  the (module) name for this irp
  78  */
  79 static ir_prog *complete_ir_prog(ir_prog *irp, const char *module_name) {
  80         int i;
  81
  82 #define IDENT(x)  new_id_from_chars(x, sizeof(x) - 1)
  83
  84         irp->name = new_id_from_str(module_name);
  85         irp->segment_types[IR_SEGMENT_GLOBAL] = new_type_class(IDENT("GlobalType"));
  86         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]
  87                 = new_type_struct(IDENT("ThreadLocal"));
  88         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]
  89                 = new_type_struct(IDENT("Constructors"));
  90         irp->segment_types[IR_SEGMENT_DESTRUCTORS]
  91                 = new_type_struct(IDENT("Destructors"));
  92         /* Remove these types from type list.  Must be treated differently than
  93            other types. */
  94         for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
  95                 remove_irp_type(irp->segment_types[i]);
  96         }
  97
  98         /* Set these flags for debugging. */
  99         irp->segment_types[IR_SEGMENT_GLOBAL]->flags       |= tf_global_type;
 100         irp->segment_types[IR_SEGMENT_THREAD_LOCAL]->flags |= tf_tls_type;
 101         irp->segment_types[IR_SEGMENT_CONSTRUCTORS]->flags |= tf_constructors;
 102         irp->segment_types[IR_SEGMENT_DESTRUCTORS]->flags  |= tf_destructors;
 103
 104         /* The global type is a class, but we cannot derive from it, so set
 105            the final property to assist optimizations that checks for it. */
 106         set_class_final(irp->segment_types[IR_SEGMENT_GLOBAL], 1);
 107
 108         irp->const_code_irg             = new_const_code_irg();
 109         irp->phase_state                = phase_building;
 110         irp->outs_state                 = outs_none;
 111         irp->ip_outedges                = NULL;
 112         irp->trouts_state               = outs_none;
 113         irp->class_cast_state           = ir_class_casts_transitive;
 114         irp->globals_entity_usage_state = ir_entity_usage_not_computed;
 115
 116         return irp;
 117 #undef IDENT
 118 }
 119
 120 /* initializes ir_prog. Constructs only the basic lists. */
 121 void init_irprog_1(void) {
 122         irp = new_incomplete_ir_prog();
 123 }
 124
 125 /* Completes ir_prog. */
 126 void init_irprog_2(void) {
 127         (void)complete_ir_prog(irp, INITAL_PROG_NAME);
 128 }
 129
 130 /* Create a new ir prog. Automatically called by init_firm through
 131    init_irprog. */
 132 ir_prog *new_ir_prog(const char *name) {
 133         return complete_ir_prog(new_incomplete_ir_prog(), name);
 134 }
 135
 136 /* frees all memory used by irp.  Types in type list, irgs in irg
 137    list and entities in global type must be freed by hand before. */
 138 void free_ir_prog(void) {
 139         int i;
 140         for (i = 0; i < IR_SEGMENT_COUNT; ++i) {
 141                 free_type(irp->segment_types[i]);
 142         }
 143
 144         free_ir_graph(irp->const_code_irg);
 145         DEL_ARR_F(irp->graphs);
 146         DEL_ARR_F(irp->pseudo_graphs);
 147         DEL_ARR_F(irp->types);
 148         DEL_ARR_F(irp->modes);
 149
 150         finish_op();
 151         DEL_ARR_F(irp->opcodes);
 152         DEL_ARR_F(irp->global_asms);
 153
 154         irp->name           = NULL;
 155         irp->const_code_irg = NULL;
 156         irp->kind           = k_BAD;
 157 }
 158
 159 /*- Functions to access the fields of ir_prog -*/
 160
 161
 162 /* Access the main routine of the compiled program. */
 163 ir_graph *get_irp_main_irg(void) {
 164         assert(irp);
 165         return irp->main_irg;
 166 }
 167
 168 void set_irp_main_irg(ir_graph *main_irg) {
 169         assert(irp);
 170         irp->main_irg = main_irg;
 171 }
 172
 173 ir_type *(get_segment_type)(ir_segment_t segment) {
 174         return _get_segment_type(segment);
 175 }
 176
 177 ir_type *(get_glob_type)(void) {
 178         return _get_glob_type();
 179 }
 180
 181 ir_type *(get_tls_type)(void) {
 182         return _get_tls_type();
 183 }
 184
 185 /* Adds irg to the list of ir graphs in irp. */
 186 void add_irp_irg(ir_graph *irg) {
 187         assert(irg != NULL);
 188         assert(irp && irp->graphs);
 189         ARR_APP1(ir_graph *, irp->graphs, irg);
 190 }
 191
 192 /* Removes irg from the list or irgs, shrinks the list by one. */
 193 void remove_irp_irg_from_list(ir_graph *irg){
 194         int i, l, found = 0;
 195
 196         assert(irg);
 197         l = ARR_LEN(irp->graphs);
 198         for (i = 0; i < l; i++) {
 199                 if (irp->graphs[i] == irg) {
 200                         found = 1;
 201                         for(; i < l - 1; i++) {
 202                                 irp->graphs[i] = irp->graphs[i+1];
 203                         }
 204                         ARR_SETLEN(ir_graph*, irp->graphs, l - 1);
 205                         break;
 206                 }
 207         }
 208         if (!found) {
 209                 l = ARR_LEN(irp->pseudo_graphs);
 210                 for (i = 0; i < l; i++) {
 211                         if (irp->pseudo_graphs[i] == irg) {
 212                                 for(; i < l - 1; i++) {
 213                                         irp->pseudo_graphs[i] = irp->pseudo_graphs[i+1];
 214                                 }
 215                                 ARR_SETLEN(ir_graph*, irp->pseudo_graphs, l - 1);
 216                                 break;
 217                         }
 218                 }
 219         }
 220 }
 221
 222 /* Removes irg from the list or irgs, shrinks the list by one. */
 223 void remove_irp_irg(ir_graph *irg){
 224         free_ir_graph(irg);
 225         remove_irp_irg_from_list(irg);
 226 }
 227
 228 int (get_irp_n_irgs)(void) {
 229         return _get_irp_n_irgs();
 230 }
 231
 232 ir_graph *(get_irp_irg)(int pos){
 233         return _get_irp_irg(pos);
 234 }
 235
 236 int get_irp_last_idx(void) {
 237         return irp->max_irg_idx;
 238 }
 239
 240 void set_irp_irg(int pos, ir_graph *irg) {
 241         assert(irp && irg);
 242         assert(pos < (ARR_LEN(irp->graphs)));
 243         irp->graphs[pos] = irg;
 244 }
 245
 246 /* Gets the number of graphs _and_ pseudo graphs. */
 247 int get_irp_n_allirgs(void) {
 248         /* We can not call get_irp_n_irgs, as we end up in a recursion ... */
 249         return ARR_LEN(irp->graphs) + get_irp_n_pseudo_irgs();
 250 }
 251
 252 /* Returns the ir graph at position pos of all graphs (including
 253  pseudo graphs).  Visits first graphs, then pseudo graphs. */
 254 ir_graph *get_irp_allirg(int pos) {
 255         int n_irgs = ARR_LEN(irp->graphs);
 256         assert(0 <= pos);
 257         if (pos < n_irgs) {
 258                 return irp->graphs[pos];
 259         } else {
 260                 return get_irp_pseudo_irg(pos-n_irgs);
 261         }
 262 }
 263
 264 /* Adds type to the list of types in irp. */
 265 void add_irp_type(ir_type *typ) {
 266         assert(typ != NULL);
 267         assert(irp);
 268         ARR_APP1(ir_type *, irp->types, typ);
 269 }
 270
 271 /* Remove type from the list of types in irp. */
 272 void remove_irp_type(ir_type *typ) {
 273         int i;
 274         assert(typ);
 275
 276         for (i = ARR_LEN(irp->types) - 1; i >= 0; i--) {
 277                 if (irp->types[i] == typ) {
 278                         for(; i < (ARR_LEN(irp->types)) - 1; i++) {
 279                                 irp->types[i] = irp->types[i+1];
 280                         }
 281                         ARR_SETLEN(ir_type *, irp->types, (ARR_LEN(irp->types)) - 1);
 282                         break;
 283                 }
 284         }
 285 }
 286
 287 int (get_irp_n_types) (void) {
 288         return _get_irp_n_types();
 289 }
 290
 291 ir_type *(get_irp_type) (int pos) {
 292         return _get_irp_type(pos);
 293 }
 294
 295 void set_irp_type(int pos, ir_type *typ) {
 296         assert(irp && typ);
 297         assert(pos < (ARR_LEN((irp)->types)));
 298         irp->types[pos] = typ;
 299 }
 300
 301 /* Returns the number of all modes in the irp. */
 302 int (get_irp_n_modes)(void) {
 303         return _get_irp_n_modes();
 304 }
 305
 306 /* Returns the mode at position pos in the irp. */
 307 ir_mode *(get_irp_mode)(int pos) {
 308         return _get_irp_mode(pos);
 309 }
 310
 311 /* Adds mode to the list of modes in irp. */
 312 void add_irp_mode(ir_mode *mode) {
 313         assert(mode != NULL);
 314         assert(irp);
 315         ARR_APP1(ir_mode *, irp->modes, mode);
 316 }
 317
 318 /* Adds opcode to the list of opcodes in irp. */
 319 void add_irp_opcode(ir_op *opcode) {
 320         int    len;
 321         size_t code;
 322         assert(opcode != NULL);
 323         assert(irp);
 324         len  = ARR_LEN(irp->opcodes);
 325         code = opcode->code;
 326         if ((int) code >= len) {
 327                 ARR_RESIZE(ir_op*, irp->opcodes, code+1);
 328                 memset(&irp->opcodes[len], 0, (code-len+1) * sizeof(irp->opcodes[0]));
 329         }
 330
 331         assert(irp->opcodes[code] == NULL && "opcode registered twice");
 332         irp->opcodes[code] = opcode;
 333 }
 334
 335 /* Removes opcode from the list of opcodes and shrinks the list by one. */
 336 void remove_irp_opcode(ir_op *opcode) {
 337         assert((int) opcode->code < ARR_LEN(irp->opcodes));
 338         irp->opcodes[opcode->code] = NULL;
 339 }
 340
 341 /* Returns the number of all opcodes in the irp. */
 342 int (get_irp_n_opcodes)(void) {
 343         return _get_irp_n_opcodes();
 344 }
 345
 346 /* Returns the opcode at position pos in the irp. */
 347 ir_op *(get_irp_opcode)(int pos) {
 348         return _get_irp_opcode(pos);
 349 }
 350
 351 /* Sets the generic function pointer of all opcodes to NULL */
 352 void  clear_irp_opcodes_generic_func(void) {
 353         int i;
 354
 355         for (i = get_irp_n_opcodes() - 1; i >= 0; --i) {
 356                 ir_op *op = get_irp_opcode(i);
 357                 op->ops.generic = (op_func)NULL;
 358         }
 359 }
 360
 361 /*- File name / executable name or the like -*/
 362 void   set_irp_prog_name(ident *name) {
 363         irp->name = name;
 364 }
 365 int irp_prog_name_is_set(void) {
 366         return irp->name != new_id_from_str(INITAL_PROG_NAME);
 367 }
 368 ident *get_irp_ident(void) {
 369         return irp->name;
 370 }
 371 const char  *get_irp_name(void) {
 372         return get_id_str(irp->name);
 373 }
 374
 375
 376 ir_graph *(get_const_code_irg)(void) {
 377         return _get_const_code_irg();
 378 }
 379
 380 irg_phase_state get_irp_phase_state(void) {
 381         return irp->phase_state;
 382 }
 383
 384 void set_irp_phase_state(irg_phase_state s) {
 385         irp->phase_state = s;
 386 }
 387
 388 struct pass_t {
 389         ir_prog_pass_t  pass;
 390         irg_phase_state state;
 391 };
 392
 393 /**
 394  * Wrapper for setting the state of a whole ir_prog.
 395  */
 396 static int set_irp_phase_state_wrapper(ir_prog *irp, void *context) {
 397         struct pass_t  *pass  = context;
 398         irg_phase_state state = pass->state;
 399         int             i;
 400
 401         (void)irp;
 402
 403         /* set the phase of all graphs */
 404         for (i = get_irp_n_irgs() - 1; i >= 0; --i)
 405                 set_irg_phase_state(get_irp_irg(i), state);
 406
 407         /* set the irp phase */
 408         set_irp_phase_state(state);
 409
 410         return 0;
 411 }
 412
 413 ir_prog_pass_t *set_irp_phase_state_pass(const char *name, irg_phase_state state) {
 414         struct pass_t *pass = XMALLOCZ(struct pass_t);
 415
 416         def_prog_pass_constructor(
 417                 &pass->pass, name ? name : "set_irp_phase", set_irp_phase_state_wrapper);
 418         pass->state = state;
 419
 420         /* no dump/verify */
 421         pass->pass.verify_irprog = ir_prog_no_verify;
 422         pass->pass.dump_irprog   = ir_prog_no_dump;
 423
 424         return &pass->pass;
 425 }
 426
 427 irg_outs_state get_irp_ip_outs_state(void) {
 428         return irp->outs_state;
 429 }
 430
 431 void set_irp_ip_outs_inconsistent(void) {
 432         irp->outs_state = outs_inconsistent;
 433 }
 434
 435 void set_irp_ip_outedges(ir_node ** ip_outedges) {
 436         irp->ip_outedges = ip_outedges;
 437 }
 438
 439 ir_node** get_irp_ip_outedges(void) {
 440         return irp->ip_outedges;
 441 }
 442
 443 irg_callee_info_state get_irp_callee_info_state(void) {
 444         return irp->callee_info_state;
 445 }
 446
 447 void set_irp_callee_info_state(irg_callee_info_state s) {
 448         irp->callee_info_state = s;
 449 }
 450
 451 /* Returns a new, unique exception region number. */
 452 ir_exc_region_t (get_irp_next_region_nr)(void) {
 453         return _get_irp_next_region_nr();
 454 }
 455
 456 /* Returns a new, unique label number. */
 457 ir_label_t (get_irp_next_label_nr)(void) {
 458         return _get_irp_next_label_nr();
 459 }
 460
 461 /* Add a new global asm include */
 462 void add_irp_asm(ident *asm_string) {
 463         ARR_APP1(ident *, irp->global_asms, asm_string);
 464 }
 465
 466 /* Return the number of global asm includes. */
 467 int get_irp_n_asms(void) {
 468         return ARR_LEN(irp->global_asms);
 469 }
 470
 471 /* Return the global asm include at position pos. */
 472 ident *get_irp_asm(int pos) {
 473         assert(0 <= pos && pos < get_irp_n_asms());
 474         return irp->global_asms[pos];
 475 }
 476
 477 #ifndef NDEBUG
 478 void irp_reserve_resources(ir_prog *irp, ir_resources_t resources) {
 479         assert((resources & ~IR_RESOURCE_GLOBAL_MASK) == 0);
 480         assert((irp->reserved_resources & resources) == 0);
 481         irp->reserved_resources |= resources;
 482 }
 483
 484 void irp_free_resources(ir_prog *irp, ir_resources_t resources) {
 485         assert((irp->reserved_resources & resources) == resources);
 486         irp->reserved_resources &= ~resources;
 487 }
 488
 489 ir_resources_t irp_resources_reserved(const ir_prog *irp) {
 490         return irp->reserved_resources;
 491 }
 492 #endif