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