nsz Git - libfirm/blob - ir/tr/entity.c

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/tr/entity.c
   4  * Purpose:     Representation of all program known entities.
   5  * Author:      Martin Trapp, Christian Schaefer
   6  * Modified by: Goetz Lindenmaier, Michael Beck
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2007 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12 #ifdef HAVE_CONFIG_H
  13 # include "config.h"
  14 #endif
  15
  16 #ifdef HAVE_STRING_H
  17 # include <string.h>
  18 #endif
  19 #ifdef HAVE_STDLIB_H
  20 # include <stdlib.h>
  21 #endif
  22 #ifdef HAVE_STDDEF_H
  23 # include <stddef.h>
  24 #endif
  25 #ifdef HAVE_MALLOC_H
  26 # include <malloc.h>
  27 #endif
  28 #ifdef HAVE_ALLOCA_H
  29 # include <alloca.h>
  30 #endif
  31
  32 #include "firm_common_t.h"
  33
  34 #include "xmalloc.h"
  35 #include "entity_t.h"
  36 #include "mangle.h"
  37 #include "typegmod.h"
  38 #include "array.h"
  39 #include "irtools.h"
  40 #include "irhooks.h"
  41 #include "irprintf.h"
  42
  43 /* All this is needed to build the constant node for methods: */
  44 #include "irprog_t.h"
  45 #include "ircons.h"
  46 #include "tv_t.h"
  47 #include "irdump.h"  /* for output if errors occur. */
  48
  49 #include "callgraph.h"  /* for dumping debug output */
  50
  51 /*******************************************************************/
  52 /** general                                                       **/
  53 /*******************************************************************/
  54
  55 ir_entity *unknown_entity = NULL;
  56
  57 ir_entity *get_unknown_entity(void) { return unknown_entity; }
  58
  59 #define UNKNOWN_ENTITY_NAME "unknown_entity"
  60
  61 /*-----------------------------------------------------------------*/
  62 /* ENTITY                                                          */
  63 /*-----------------------------------------------------------------*/
  64
  65 /**
  66  * Add an entity to it's already set owner type.
  67  */
  68 static INLINE void insert_entity_in_owner(ir_entity *ent) {
  69         ir_type *owner = ent->owner;
  70         switch (get_type_tpop_code(owner)) {
  71         case tpo_class:
  72                 add_class_member(owner, ent);
  73                 break;
  74         case tpo_struct:
  75                 add_struct_member(owner, ent);
  76                 break;
  77         case tpo_union:
  78                 add_union_member(owner, ent);
  79                 break;
  80         case tpo_array:
  81                 set_array_element_entity(owner, ent);
  82                 break;
  83         default: assert(0);
  84         }
  85 }  /* insert_entity_in_owner */
  86
  87 /**
  88  * Creates a new entity. This entity is NOT inserted in the owner type.
  89  *
  90  * @param db     debug info for this entity
  91  * @param owner  the owner type of the new entity
  92  * @param name   the name of the new entity
  93  * @param type   the type of the new entity
  94  *
  95  * @return the new created entity
  96  */
  97 static INLINE ir_entity *
  98 new_rd_entity(dbg_info *db, ir_type *owner, ident *name, ir_type *type)
  99 {
 100         ir_entity *res;
 101         ir_graph *rem;
 102
 103         assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
 104
 105         res = xmalloc(sizeof(*res));
 106         memset(res, 0, sizeof(*res));
 107
 108         res->kind    = k_entity;
 109         res->name    = name;
 110         res->ld_name = NULL;
 111         res->type    = type;
 112         res->owner   = owner;
 113
 114         res->allocation           = allocation_automatic;
 115         res->visibility           = visibility_local;
 116         res->volatility           = volatility_non_volatile;
 117         res->stickyness           = stickyness_unsticky;
 118         res->peculiarity          = peculiarity_existent;
 119         res->address_taken        = ir_address_taken_unknown;
 120         res->final                = 0;
 121         res->compiler_gen         = 0;
 122         res->offset               = -1;
 123         res->offset_bit_remainder = 0;
 124         res->link                 = NULL;
 125         res->repr_class           = NULL;
 126
 127         if (is_Method_type(type)) {
 128                 symconst_symbol sym;
 129                 sym.entity_p            = res;
 130                 rem                     = current_ir_graph;
 131                 current_ir_graph        = get_const_code_irg();
 132                 res->value              = new_SymConst(sym, symconst_addr_ent);
 133                 current_ir_graph        = rem;
 134                 res->allocation         = allocation_static;
 135                 res->variability        = variability_constant;
 136                 res->attr.mtd_attr.irg_add_properties = mtp_property_inherited;
 137                 res->attr.mtd_attr.vtable_number      = VTABLE_NUM_NOT_SET;
 138                 res->attr.mtd_attr.param_access       = NULL;
 139                 res->attr.mtd_attr.param_weight       = NULL;
 140                 res->attr.mtd_attr.irg                = NULL;
 141                 res->attr.mtd_attr.section            = section_text;
 142         } else if (is_compound_type(type)) {
 143                 res->variability = variability_uninitialized;
 144                 res->value       = NULL;
 145                 res->attr.cmpd_attr.values    = NULL;
 146                 res->attr.cmpd_attr.val_paths = NULL;
 147         } else {
 148                 res->variability = variability_uninitialized;
 149                 res->value       = NULL;
 150         }
 151
 152         if (is_Class_type(owner)) {
 153                 res->overwrites    = NEW_ARR_F(ir_entity *, 0);
 154                 res->overwrittenby = NEW_ARR_F(ir_entity *, 0);
 155         } else {
 156                 res->overwrites    = NULL;
 157                 res->overwrittenby = NULL;
 158         }
 159
 160 #ifdef DEBUG_libfirm
 161         res->nr = get_irp_new_node_nr();
 162 #endif /* DEBUG_libfirm */
 163
 164         res->visit = 0;
 165         set_entity_dbg_info(res, db);
 166
 167         return res;
 168 }  /* new_rd_entity */
 169
 170 ir_entity *
 171 new_d_entity(ir_type *owner, ident *name, ir_type *type, dbg_info *db) {
 172         ir_entity *res;
 173
 174         assert(is_compound_type(owner));
 175         res = new_rd_entity(db, owner, name, type);
 176         /* Remember entity in it's owner. */
 177         insert_entity_in_owner(res);
 178
 179         hook_new_entity(res);
 180         return res;
 181 }  /* new_d_entity */
 182
 183 ir_entity *
 184 new_entity(ir_type *owner, ident *name, ir_type *type) {
 185         return new_d_entity(owner, name, type, NULL);
 186 }  /* new_entity */
 187
 188 /**
 189  * Free entity attributes.
 190  *
 191  * @param ent  the entity
 192  */
 193 static void free_entity_attrs(ir_entity *ent) {
 194         int i;
 195         if (get_type_tpop(get_entity_owner(ent)) == type_class) {
 196                 DEL_ARR_F(ent->overwrites);    ent->overwrites = NULL;
 197                 DEL_ARR_F(ent->overwrittenby); ent->overwrittenby = NULL;
 198         } else {
 199                 assert(ent->overwrites == NULL);
 200                 assert(ent->overwrittenby == NULL);
 201         }
 202         if (is_compound_entity(ent)) {
 203                 if (ent->attr.cmpd_attr.val_paths) {
 204                         for (i = 0; i < get_compound_ent_n_values(ent); i++)
 205                                 if (ent->attr.cmpd_attr.val_paths[i]) {
 206                                         /* free_compound_graph_path(ent->attr.cmpd_attr.val_paths[i]) ;  * @@@ warum nich? */
 207                                         /* Geht nich: wird mehrfach verwendet!!! ==> mehrfach frei gegeben. */
 208                                         /* DEL_ARR_F(ent->attr.cmpd_attr.val_paths); */
 209                                 }
 210                                 ent->attr.cmpd_attr.val_paths = NULL;
 211                 }
 212                 /* if (ent->attr.cmpd_attr.values) DEL_ARR_F(ent->attr.cmpd_attr.values); *//* @@@ warum nich? */
 213                 ent->attr.cmpd_attr.values = NULL;
 214         } else if (is_method_entity(ent)) {
 215                 if (ent->attr.mtd_attr.param_access) {
 216                         DEL_ARR_F(ent->attr.mtd_attr.param_access);
 217                         ent->attr.mtd_attr.param_access = NULL;
 218                 }
 219                 if (ent->attr.mtd_attr.param_weight) {
 220                         DEL_ARR_F(ent->attr.mtd_attr.param_weight);
 221                         ent->attr.mtd_attr.param_weight = NULL;
 222                 }
 223         }
 224 }  /* free_entity_attrs */
 225
 226 ir_entity *
 227 copy_entity_own(ir_entity *old, ir_type *new_owner) {
 228         ir_entity *newe;
 229         assert(is_entity(old));
 230         assert(is_compound_type(new_owner));
 231
 232         if (old->owner == new_owner) return old;
 233         newe = xmalloc(sizeof(*newe));
 234         memcpy(newe, old, sizeof(*newe));
 235         newe->owner = new_owner;
 236         if (is_Class_type(new_owner)) {
 237                 newe->overwrites    = NEW_ARR_F(ir_entity *, 0);
 238                 newe->overwrittenby = NEW_ARR_F(ir_entity *, 0);
 239         }
 240 #ifdef DEBUG_libfirm
 241         newe->nr = get_irp_new_node_nr();
 242 #endif
 243
 244         insert_entity_in_owner(newe);
 245
 246         return newe;
 247 }  /* copy_entity_own */
 248
 249 ir_entity *
 250 copy_entity_name(ir_entity *old, ident *new_name) {
 251         ir_entity *newe;
 252         assert(old && old->kind == k_entity);
 253
 254         if (old->name == new_name) return old;
 255         newe = xmalloc(sizeof(*newe));
 256         memcpy(newe, old, sizeof(*newe));
 257         newe->name = new_name;
 258         newe->ld_name = NULL;
 259         if (is_Class_type(newe->owner)) {
 260                 newe->overwrites    = DUP_ARR_F(ir_entity *, old->overwrites);
 261                 newe->overwrittenby = DUP_ARR_F(ir_entity *, old->overwrittenby);
 262         }
 263 #ifdef DEBUG_libfirm
 264         newe->nr = get_irp_new_node_nr();
 265 #endif
 266
 267         insert_entity_in_owner(newe);
 268
 269         return newe;
 270 }  /* copy_entity_name */
 271
 272
 273 void
 274 free_entity(ir_entity *ent) {
 275         assert(ent && ent->kind == k_entity);
 276         free_entity_attrs(ent);
 277         ent->kind = k_BAD;
 278         free(ent);
 279 }  /* free_entity */
 280
 281 /* Outputs a unique number for this node */
 282 long
 283 get_entity_nr(const ir_entity *ent) {
 284         assert(ent && ent->kind == k_entity);
 285 #ifdef DEBUG_libfirm
 286         return ent->nr;
 287 #else
 288         return (long)PTR_TO_INT(ent);
 289 #endif
 290 }  /* get_entity_nr */
 291
 292 const char *
 293 (get_entity_name)(const ir_entity *ent) {
 294         return _get_entity_name(ent);
 295 }  /* get_entity_name */
 296
 297 ident *
 298 (get_entity_ident)(const ir_entity *ent) {
 299         return _get_entity_ident(ent);
 300 }  /* get_entity_ident */
 301
 302 void
 303 (set_entity_ident)(ir_entity *ent, ident *id) {
 304         _set_entity_ident(ent, id);
 305 }  /* set_entity_ident */
 306
 307 ir_type *
 308 (get_entity_owner)(ir_entity *ent) {
 309         return _get_entity_owner(ent);
 310 }  /* get_entity_owner */
 311
 312 void
 313 set_entity_owner(ir_entity *ent, ir_type *owner) {
 314         assert(is_entity(ent));
 315         assert(is_compound_type(owner));
 316         ent->owner = owner;
 317 }  /* set_entity_owner */
 318
 319 ident *
 320 (get_entity_ld_ident)(ir_entity *ent) {
 321         return _get_entity_ld_ident(ent);
 322 }  /* get_entity_ld_ident */
 323
 324 void
 325 (set_entity_ld_ident)(ir_entity *ent, ident *ld_ident) {
 326         _set_entity_ld_ident(ent, ld_ident);
 327 }  /* set_entity_ld_ident */
 328
 329 const char *
 330 (get_entity_ld_name)(ir_entity *ent) {
 331         return _get_entity_ld_name(ent);
 332 }  /* get_entity_ld_name */
 333
 334 ir_type *
 335 (get_entity_type)(ir_entity *ent) {
 336         return _get_entity_type(ent);
 337 }  /* get_entity_type */
 338
 339 void
 340 (set_entity_type)(ir_entity *ent, ir_type *type) {
 341         _set_entity_type(ent, type);
 342 }  /* set_entity_type */
 343
 344 ir_allocation
 345 (get_entity_allocation)(const ir_entity *ent) {
 346         return _get_entity_allocation(ent);
 347 }  /* get_entity_allocation */
 348
 349 void
 350 (set_entity_allocation)(ir_entity *ent, ir_allocation al) {
 351         _set_entity_allocation(ent, al);
 352 }  /* set_entity_allocation */
 353
 354 /* return the name of the visibility */
 355 const char *get_allocation_name(ir_allocation all)
 356 {
 357 #define X(a)    case a: return #a
 358         switch (all) {
 359         X(allocation_automatic);
 360         X(allocation_parameter);
 361         X(allocation_dynamic);
 362         X(allocation_static);
 363     default: return "BAD VALUE";
 364         }
 365 #undef X
 366 }  /* get_allocation_name */
 367
 368 ir_visibility
 369 (get_entity_visibility)(const ir_entity *ent) {
 370         return _get_entity_visibility(ent);
 371 }  /* get_entity_visibility */
 372
 373 void
 374 set_entity_visibility(ir_entity *ent, ir_visibility vis) {
 375         assert(ent && ent->kind == k_entity);
 376         if (vis != visibility_local)
 377                 assert((ent->allocation == allocation_static) ||
 378                 (ent->allocation == allocation_automatic));
 379                 /* @@@ Test that the owner type is not local, but how??
 380         && get_class_visibility(get_entity_owner(ent)) != local));*/
 381         ent->visibility = vis;
 382 }  /* set_entity_visibility */
 383
 384 /* return the name of the visibility */
 385 const char *get_visibility_name(ir_visibility vis)
 386 {
 387 #define X(a)    case a: return #a
 388         switch (vis) {
 389         X(visibility_local);
 390         X(visibility_external_visible);
 391         X(visibility_external_allocated);
 392     default: return "BAD VALUE";
 393         }
 394 #undef X
 395 }  /* get_visibility_name */
 396
 397 ir_variability
 398 (get_entity_variability)(const ir_entity *ent) {
 399         return _get_entity_variability(ent);
 400 }  /* get_entity_variability */
 401
 402 void
 403 set_entity_variability(ir_entity *ent, ir_variability var)
 404 {
 405         assert(ent && ent->kind == k_entity);
 406         if (var == variability_part_constant)
 407                 assert(is_Class_type(ent->type) || is_Struct_type(ent->type));
 408
 409         if ((is_compound_type(ent->type)) &&
 410                 (ent->variability == variability_uninitialized) && (var != variability_uninitialized)) {
 411                 /* Allocate data structures for constant values */
 412                 ent->attr.cmpd_attr.values    = NEW_ARR_F(ir_node *, 0);
 413                 ent->attr.cmpd_attr.val_paths = NEW_ARR_F(compound_graph_path *, 0);
 414         }
 415         if ((is_atomic_type(ent->type)) &&
 416                 (ent->variability == variability_uninitialized) && (var != variability_uninitialized)) {
 417                 /* Set default constant value. */
 418                 ent->value = new_rd_Unknown(get_const_code_irg(), get_type_mode(ent->type));
 419         }
 420
 421         if ((is_compound_type(ent->type)) &&
 422                 (var == variability_uninitialized) && (ent->variability != variability_uninitialized)) {
 423                 /* Free data structures for constant values */
 424                 DEL_ARR_F(ent->attr.cmpd_attr.values);    ent->attr.cmpd_attr.values    = NULL;
 425                 DEL_ARR_F(ent->attr.cmpd_attr.val_paths); ent->attr.cmpd_attr.val_paths = NULL;
 426         }
 427         ent->variability = var;
 428 }  /* set_entity_variability */
 429
 430 /* return the name of the variability */
 431 const char *get_variability_name(ir_variability var)
 432 {
 433 #define X(a)    case a: return #a
 434         switch (var) {
 435         X(variability_uninitialized);
 436         X(variability_initialized);
 437         X(variability_part_constant);
 438         X(variability_constant);
 439     default: return "BAD VALUE";
 440         }
 441 #undef X
 442 }  /* get_variability_name */
 443
 444 ir_volatility
 445 (get_entity_volatility)(const ir_entity *ent) {
 446         return _get_entity_volatility(ent);
 447 }  /* get_entity_volatility */
 448
 449 void
 450 (set_entity_volatility)(ir_entity *ent, ir_volatility vol) {
 451         _set_entity_volatility(ent, vol);
 452 }  /* set_entity_volatility */
 453
 454 /* return the name of the volatility */
 455 const char *get_volatility_name(ir_volatility var)
 456 {
 457 #define X(a)    case a: return #a
 458         switch (var) {
 459         X(volatility_non_volatile);
 460         X(volatility_is_volatile);
 461     default: return "BAD VALUE";
 462         }
 463 #undef X
 464 }  /* get_volatility_name */
 465
 466 ir_peculiarity
 467 (get_entity_peculiarity)(const ir_entity *ent) {
 468         return _get_entity_peculiarity(ent);
 469 }  /* get_entity_peculiarity */
 470
 471 void
 472 (set_entity_peculiarity)(ir_entity *ent, ir_peculiarity pec) {
 473         _set_entity_peculiarity(ent, pec);
 474 }  /* set_entity_peculiarity */
 475
 476 /* Checks if an entity cannot be overridden anymore. */
 477 int (is_entity_final)(const ir_entity *ent) {
 478         return _is_entity_final(ent);
 479 }  /* is_entity_final */
 480
 481 /* Sets/resets the final flag of an entity. */
 482 void (set_entity_final)(ir_entity *ent, int final) {
 483         _set_entity_final(ent, final);
 484 }  /* set_entity_final */
 485
 486 /* Checks if an entity is compiler generated */
 487 int (is_entity_compiler_generated)(const ir_entity *ent) {
 488         return _is_entity_compiler_generated(ent);
 489 }  /* is_entity_compiler_generated */
 490
 491 /* Sets/resets the compiler generated flag */
 492 void (set_entity_compiler_generated)(ir_entity *ent, int flag) {
 493         _set_entity_compiler_generated(ent, flag);
 494 }  /* set_entity_compiler_generated */
 495
 496 /* Checks if the address of an entity was taken. */
 497 ir_address_taken_state (get_entity_address_taken)(const ir_entity *ent) {
 498         return _get_entity_address_taken(ent);
 499 }  /* is_entity_address_taken */
 500
 501 /* Sets/resets the address taken flag. */
 502 void (set_entity_address_taken)(ir_entity *ent, ir_address_taken_state flag) {
 503         _set_entity_address_taken(ent, flag);
 504 }  /* set_entity_address_taken */
 505
 506 /* Return the name of the address_taken state. */
 507 const char *get_address_taken_state_name(ir_address_taken_state state) {
 508 #define X(a)    case a: return #a
 509         switch (state) {
 510         X(ir_address_not_taken);
 511         X(ir_address_taken_unknown);
 512         X(ir_address_taken);
 513     default: return "BAD VALUE";
 514         }
 515 #undef X
 516 }  /* get_address_taken_state_name */
 517
 518 /* Get the entity's stickyness */
 519 ir_stickyness
 520 (get_entity_stickyness)(const ir_entity *ent) {
 521         return _get_entity_stickyness(ent);
 522 }  /* get_entity_stickyness */
 523
 524 /* Set the entity's stickyness */
 525 void
 526 (set_entity_stickyness)(ir_entity *ent, ir_stickyness stickyness) {
 527         _set_entity_stickyness(ent, stickyness);
 528 }  /* set_entity_stickyness */
 529
 530 /* Set has no effect for existent entities of type method. */
 531 ir_node *
 532 get_atomic_ent_value(ir_entity *ent)
 533 {
 534         assert(ent && is_atomic_entity(ent));
 535         assert(ent->variability != variability_uninitialized);
 536         return skip_Id(ent->value);
 537 }  /* get_atomic_ent_value */
 538
 539 void
 540 set_atomic_ent_value(ir_entity *ent, ir_node *val) {
 541         assert(is_atomic_entity(ent) && (ent->variability != variability_uninitialized));
 542         if (is_Method_type(ent->type) && (ent->peculiarity == peculiarity_existent))
 543                 return;
 544         ent->value = val;
 545 }  /* set_atomic_ent_value */
 546
 547 /* Returns true if the the node is representable as code on
 548  *  const_code_irg. */
 549 int is_irn_const_expression(ir_node *n) {
 550         ir_mode *m;
 551
 552         /* we are in danger iff an exception will arise. TODO: be more precisely,
 553          * for instance Div. will NOT rise if divisor != 0
 554          */
 555         if (is_binop(n) && !is_fragile_op(n))
 556                 return is_irn_const_expression(get_binop_left(n)) && is_irn_const_expression(get_binop_right(n));
 557
 558         m = get_irn_mode(n);
 559         switch (get_irn_opcode(n)) {
 560         case iro_Const:
 561         case iro_SymConst:
 562         case iro_Unknown:
 563                 return 1;
 564         case iro_Conv:
 565         case iro_Cast:
 566                 return is_irn_const_expression(get_irn_n(n, 0));
 567         default:
 568                 break;
 569         }
 570         return 0;
 571 }  /* is_irn_const_expression */
 572
 573 /*
 574  * Copies a firm subgraph that complies to the restrictions for
 575  * constant expressions to current_block in current_ir_graph.
 576  */
 577 ir_node *copy_const_value(dbg_info *dbg, ir_node *n) {
 578         ir_node *nn;
 579         ir_mode *m;
 580
 581         /* @@@ GL I think  we should implement this using the routines from irgopt for
 582                dead node elimination/inlineing. */
 583
 584         m = get_irn_mode(n);
 585         switch (get_irn_opcode(n)) {
 586         case iro_Const:
 587                 nn = new_d_Const_type(dbg, m, get_Const_tarval(n), get_Const_type(n));
 588                 break;
 589         case iro_SymConst:
 590                 nn = new_d_SymConst_type(dbg, get_SymConst_symbol(n), get_SymConst_kind(n),
 591                         get_SymConst_value_type(n));
 592                 break;
 593         case iro_Add:
 594                 nn = new_d_Add(dbg, copy_const_value(dbg, get_Add_left(n)),
 595                         copy_const_value(dbg, get_Add_right(n)), m); break;
 596         case iro_Sub:
 597                 nn = new_d_Sub(dbg, copy_const_value(dbg, get_Sub_left(n)),
 598                         copy_const_value(dbg, get_Sub_right(n)), m); break;
 599         case iro_Mul:
 600                 nn = new_d_Mul(dbg, copy_const_value(dbg, get_Mul_left(n)),
 601                         copy_const_value(dbg, get_Mul_right(n)), m); break;
 602         case iro_And:
 603                 nn = new_d_And(dbg, copy_const_value(dbg, get_And_left(n)),
 604                         copy_const_value(dbg, get_And_right(n)), m); break;
 605         case iro_Or:
 606                 nn = new_d_Or(dbg, copy_const_value(dbg, get_Or_left(n)),
 607                         copy_const_value(dbg, get_Or_right(n)), m); break;
 608         case iro_Eor:
 609                 nn = new_d_Eor(dbg, copy_const_value(dbg, get_Eor_left(n)),
 610                         copy_const_value(dbg, get_Eor_right(n)), m); break;
 611         case iro_Cast:
 612                 nn = new_d_Cast(dbg, copy_const_value(dbg, get_Cast_op(n)), get_Cast_type(n)); break;
 613         case iro_Conv:
 614                 nn = new_d_Conv(dbg, copy_const_value(dbg, get_Conv_op(n)), m); break;
 615         case iro_Unknown:
 616                 nn = new_d_Unknown(m); break;
 617         default:
 618                 DDMN(n);
 619                 assert(0 && "opcode invalid or not implemented");
 620                 nn = NULL;
 621                 break;
 622         }
 623         return nn;
 624 }  /* copy_const_value */
 625
 626 /* Creates a new compound graph path. */
 627 compound_graph_path *
 628 new_compound_graph_path(ir_type *tp, int length) {
 629         compound_graph_path *res;
 630
 631         assert(is_compound_type(tp));
 632         assert(length > 0);
 633
 634         res = xmalloc(sizeof(*res) + (length-1) * sizeof(res->list[0]));
 635         memset(res, 0, sizeof(*res) + (length-1) * sizeof(res->list[0]));
 636         res->kind         = k_ir_compound_graph_path;
 637         res->tp           = tp;
 638         res->len          = length;
 639
 640         return res;
 641 }  /* new_compound_graph_path */
 642
 643 /* Frees an graph path object */
 644 void free_compound_graph_path (compound_graph_path *gr) {
 645         assert(gr && is_compound_graph_path(gr));
 646         gr->kind = k_BAD;
 647         free(gr);
 648 }  /* free_compound_graph_path */
 649
 650 /* Returns non-zero if an object is a compound graph path */
 651 int is_compound_graph_path(const void *thing) {
 652         return (get_kind(thing) == k_ir_compound_graph_path);
 653 }  /* is_compound_graph_path */
 654
 655 /* Checks whether the path up to pos is correct. If the path contains a NULL,
 656  *  assumes the path is not complete and returns 'true'. */
 657 int is_proper_compound_graph_path(compound_graph_path *gr, int pos) {
 658         int i;
 659         ir_entity *node;
 660         ir_type *owner = gr->tp;
 661
 662         for (i = 0; i <= pos; i++) {
 663                 node = get_compound_graph_path_node(gr, i);
 664                 if (node == NULL)
 665                         /* Path not yet complete. */
 666                         return 1;
 667                 if (get_entity_owner(node) != owner)
 668                         return 0;
 669                 owner = get_entity_type(node);
 670         }
 671         if (pos == get_compound_graph_path_length(gr))
 672                 if (!is_atomic_type(owner))
 673                         return 0;
 674                 return 1;
 675 }  /* is_proper_compound_graph_path */
 676
 677 /* Returns the length of a graph path */
 678 int get_compound_graph_path_length(const compound_graph_path *gr) {
 679         assert(gr && is_compound_graph_path(gr));
 680         return gr->len;
 681 }  /* get_compound_graph_path_length */
 682
 683 ir_entity *
 684 get_compound_graph_path_node(const compound_graph_path *gr, int pos) {
 685         assert(gr && is_compound_graph_path(gr));
 686         assert(pos >= 0 && pos < gr->len);
 687         return gr->list[pos].node;
 688 }  /* get_compound_graph_path_node */
 689
 690 void
 691 set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node) {
 692         assert(gr && is_compound_graph_path(gr));
 693         assert(pos >= 0 && pos < gr->len);
 694         assert(is_entity(node));
 695         gr->list[pos].node = node;
 696         assert(is_proper_compound_graph_path(gr, pos));
 697 }  /* set_compound_graph_path_node */
 698
 699 int
 700 get_compound_graph_path_array_index(const compound_graph_path *gr, int pos) {
 701         assert(gr && is_compound_graph_path(gr));
 702         assert(pos >= 0 && pos < gr->len);
 703         return gr->list[pos].index;
 704 }  /* get_compound_graph_path_array_index */
 705
 706 void
 707 set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index) {
 708         assert(gr && is_compound_graph_path(gr));
 709         assert(pos >= 0 && pos < gr->len);
 710         gr->list[pos].index = index;
 711 }  /* set_compound_graph_path_array_index */
 712
 713 /* A value of a compound entity is a pair of value and the corresponding path to a member of
 714    the compound. */
 715 void
 716 add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path) {
 717         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 718         assert(is_compound_graph_path(path));
 719         ARR_APP1(ir_node *, ent->attr.cmpd_attr.values, val);
 720         ARR_APP1(compound_graph_path *, ent->attr.cmpd_attr.val_paths, path);
 721 }  /* add_compound_ent_value_w_path */
 722
 723 void
 724 set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos) {
 725         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 726         assert(is_compound_graph_path(path));
 727         assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.values));
 728         ent->attr.cmpd_attr.values[pos]    = val;
 729         ent->attr.cmpd_attr.val_paths[pos] = path;
 730 }  /* set_compound_ent_value_w_path */
 731
 732 int
 733 get_compound_ent_n_values(ir_entity *ent) {
 734         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 735         return ARR_LEN(ent->attr.cmpd_attr.values);
 736 }  /* get_compound_ent_n_values */
 737
 738 ir_node *
 739 get_compound_ent_value(ir_entity *ent, int pos) {
 740         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 741         assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.values));
 742         return ent->attr.cmpd_attr.values[pos];
 743 }  /* get_compound_ent_value */
 744
 745 compound_graph_path *
 746 get_compound_ent_value_path(ir_entity *ent, int pos) {
 747         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 748         assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.val_paths));
 749         return ent->attr.cmpd_attr.val_paths[pos];
 750 }  /* get_compound_ent_value_path */
 751
 752 /**
 753  * Returns non-zero, if two compound_graph_pathes are equal
 754  *
 755  * @param path1            the first path
 756  * @param visited_indices
 757  * @param path2            the second path
 758  */
 759 static int equal_paths(compound_graph_path *path1, int *visited_indices, compound_graph_path *path2) {
 760         int i;
 761         int len1 = get_compound_graph_path_length(path1);
 762         int len2 = get_compound_graph_path_length(path2);
 763
 764         if (len2 != len1) return 0;
 765
 766         for (i = 0; i < len1; i++) {
 767                 ir_type *tp;
 768                 ir_entity *node1 = get_compound_graph_path_node(path1, i);
 769                 ir_entity *node2 = get_compound_graph_path_node(path2, i);
 770
 771                 if (node1 != node2) return 0;
 772
 773                 /* FIXME: Strange code. What is it good for? */
 774                 tp = get_entity_owner(node1);
 775                 if (is_Array_type(tp)) {
 776                         long low;
 777
 778                         /* Compute the index of this node. */
 779                         assert(get_array_n_dimensions(tp) == 1 && "multidim not implemented");
 780
 781                         low = get_array_lower_bound_int(tp, 0);
 782                         if (low + visited_indices[i] < get_compound_graph_path_array_index(path2, i)) {
 783                                 visited_indices[i]++;
 784                                 return 0;
 785                         } else
 786                                 assert(low + visited_indices[i] == get_compound_graph_path_array_index(path2, i));
 787                 }
 788         }
 789         return 1;
 790 }  /* equal_paths */
 791
 792 /**
 793  * Returns the position of a value with the given path.
 794  * The path must contain array indices for all array element entities.
 795  *
 796  * @todo  This implementation is very low and should be replaced when the new tree oriented
 797  *        value representation is finally implemented.
 798  */
 799 static int get_compound_ent_pos_by_path(ir_entity *ent, compound_graph_path *path) {
 800         int i, n_paths = get_compound_ent_n_values(ent);
 801         int *visited_indices;
 802         int path_len = get_compound_graph_path_length(path);
 803
 804         NEW_ARR_A(int *, visited_indices, path_len);
 805         memset(visited_indices, 0, sizeof(*visited_indices) * path_len);
 806         for (i = 0; i < n_paths; i ++) {
 807                 if (equal_paths(get_compound_ent_value_path(ent, i), visited_indices, path))
 808                         return i;
 809         }
 810
 811 #if 0
 812         {
 813                 int j;
 814                 printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
 815                 printf("Entity %s : ", get_entity_name(ent));
 816                 for (j = 0; j < get_compound_graph_path_length(path); ++j) {
 817                         ir_entity *node = get_compound_graph_path_node(path, j);
 818                         printf("%s", get_entity_name(node));
 819                         if (is_Array_type(get_entity_owner(node)))
 820                                 printf("[%d]", get_compound_graph_path_array_index(path, j));
 821                 }
 822                 printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
 823         }
 824 #endif
 825
 826         assert(0 && "path not found");
 827         return -1;
 828 }  /* get_compound_ent_pos_by_path */
 829
 830 /* Returns a constant value given the access path.
 831  *  The path must contain array indices for all array element entities. */
 832 ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path) {
 833         return get_compound_ent_value(ent, get_compound_ent_pos_by_path(ent, path));
 834 }  /* get_compound_ent_value_by_path */
 835
 836
 837 void
 838 remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent) {
 839         int i;
 840         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 841         for (i = 0; i < (ARR_LEN(ent->attr.cmpd_attr.val_paths)); ++i) {
 842                 compound_graph_path *path = ent->attr.cmpd_attr.val_paths[i];
 843                 if (path->list[path->len-1].node == value_ent) {
 844                         for (; i < (ARR_LEN(ent->attr.cmpd_attr.val_paths))-1; ++i) {
 845                                 ent->attr.cmpd_attr.val_paths[i] = ent->attr.cmpd_attr.val_paths[i+1];
 846                                 ent->attr.cmpd_attr.values[i]    = ent->attr.cmpd_attr.values[i+1];
 847                         }
 848                         ARR_SETLEN(ir_entity*, ent->attr.cmpd_attr.val_paths, ARR_LEN(ent->attr.cmpd_attr.val_paths) - 1);
 849                         ARR_SETLEN(ir_node*,   ent->attr.cmpd_attr.values,    ARR_LEN(ent->attr.cmpd_attr.values)    - 1);
 850                         break;
 851                 }
 852         }
 853 }  /* remove_compound_ent_value */
 854
 855 void
 856 add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member) {
 857         compound_graph_path *path;
 858         ir_type *owner_tp = get_entity_owner(member);
 859         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 860         path = new_compound_graph_path(get_entity_type(ent), 1);
 861         path->list[0].node = member;
 862         if (is_Array_type(owner_tp)) {
 863                 int max;
 864                 int i, n;
 865
 866                 assert(get_array_n_dimensions(owner_tp) == 1 && has_array_lower_bound(owner_tp, 0));
 867                 max = get_array_lower_bound_int(owner_tp, 0) -1;
 868                 for (i = 0, n = get_compound_ent_n_values(ent); i < n; ++i) {
 869                         int index = get_compound_graph_path_array_index(get_compound_ent_value_path(ent, i), 0);
 870                         if (index > max) {
 871                                 max = index;
 872                         }
 873                 }
 874                 path->list[0].index = max + 1;
 875         }
 876         add_compound_ent_value_w_path(ent, val, path);
 877 }  /* add_compound_ent_value */
 878
 879
 880 ir_entity *
 881 get_compound_ent_value_member(ir_entity *ent, int pos) {
 882         compound_graph_path *path;
 883         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 884         path = get_compound_ent_value_path(ent, pos);
 885
 886         return get_compound_graph_path_node(path, get_compound_graph_path_length(path)-1);
 887 }  /* get_compound_ent_value_member */
 888
 889 void
 890 set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos) {
 891         compound_graph_path *path;
 892         assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
 893         path = get_compound_ent_value_path(ent, pos);
 894         set_compound_graph_path_node(path, 0, member);
 895         set_compound_ent_value_w_path(ent, val, path, pos);
 896 }  /* set_compound_ent_value */
 897
 898 void
 899 set_array_entity_values(ir_entity *ent, tarval **values, int num_vals) {
 900         int i;
 901         ir_graph *rem = current_ir_graph;
 902         ir_type *arrtp = get_entity_type(ent);
 903         ir_node *val;
 904         ir_type *elttp = get_array_element_type(arrtp);
 905
 906         assert(is_Array_type(arrtp));
 907         assert(get_array_n_dimensions(arrtp) == 1);
 908         /* One bound is sufficient, the number of constant fields makes the
 909            size. */
 910         assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
 911         assert(get_entity_variability(ent) != variability_uninitialized);
 912         current_ir_graph = get_const_code_irg();
 913
 914         for (i = 0; i < num_vals; i++) {
 915                 val = new_Const_type(values[i], elttp);
 916                 add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
 917                 set_compound_graph_path_array_index(get_compound_ent_value_path(ent, i), 0, i);
 918         }
 919         current_ir_graph = rem;
 920 }  /* set_array_entity_values */
 921
 922 /* Return the overall offset of value at position pos in bytes. */
 923 int get_compound_ent_value_offset_bytes(ir_entity *ent, int pos) {
 924         compound_graph_path *path;
 925         int path_len, i;
 926         int offset = 0;
 927         ir_type *curr_tp;
 928
 929         assert(get_type_state(get_entity_type(ent)) == layout_fixed);
 930
 931         path = get_compound_ent_value_path(ent, pos);
 932         path_len = get_compound_graph_path_length(path);
 933         curr_tp = path->tp;
 934
 935         for (i = 0; i < path_len; ++i) {
 936                 ir_entity *node = get_compound_graph_path_node(path, i);
 937                 ir_type *node_tp = get_entity_type(node);
 938
 939                 if (is_Array_type(curr_tp)) {
 940                         int size  = get_type_size_bits(node_tp);
 941                         int align = get_type_alignment_bits(node_tp);
 942                         int idx;
 943
 944                         assert(size > 0);
 945                         if(size % align > 0) {
 946                                 size += align - (size % align);
 947                         }
 948                         assert(size % 8 == 0);
 949                         size /= 8;
 950                         idx = get_compound_graph_path_array_index(path, i);
 951                         assert(idx >= 0);
 952                         offset += size * idx;
 953                 } else {
 954                         offset += get_entity_offset(node);
 955                 }
 956                 curr_tp = node_tp;
 957         }
 958
 959         return offset;
 960 }  /* get_compound_ent_value_offset_bytes */
 961
 962 /* Return the offset in bits from the last byte address. */
 963 int get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos) {
 964         compound_graph_path *path;
 965         int path_len;
 966         ir_entity *last_node;
 967
 968         assert(get_type_state(get_entity_type(ent)) == layout_fixed);
 969
 970         path = get_compound_ent_value_path(ent, pos);
 971         path_len = get_compound_graph_path_length(path);
 972         last_node = get_compound_graph_path_node(path, path_len - 1);
 973
 974         return get_entity_offset_bits_remainder(last_node);
 975 }  /* get_compound_ent_value_offset_bit_remainder */
 976
 977 int
 978 (get_entity_offset)(const ir_entity *ent) {
 979         return _get_entity_offset(ent);
 980 }  /* get_entity_offset */
 981
 982 void
 983 (set_entity_offset)(ir_entity *ent, int offset) {
 984         _set_entity_offset(ent, offset);
 985 }  /* set_entity_offset */
 986
 987 unsigned char
 988 (get_entity_offset_bits_remainder)(const ir_entity *ent) {
 989         return _get_entity_offset_bits_remainder(ent);
 990 }  /* get_entity_offset_bits_remainder */
 991
 992 void
 993 (set_entity_offset_bits_remainder)(ir_entity *ent, unsigned char offset) {
 994         _set_entity_offset_bits_remainder(ent, offset);
 995 }  /* set_entity_offset_bits_remainder */
 996
 997 void
 998 add_entity_overwrites(ir_entity *ent, ir_entity *overwritten) {
 999 #ifndef NDEBUG
1000         ir_type *owner     = get_entity_owner(ent);
1001         ir_type *ovw_ovner = get_entity_owner(overwritten);
1002         assert(is_Class_type(owner));
1003         assert(is_Class_type(ovw_ovner));
1004         assert(! is_class_final(ovw_ovner));
1005 #endif /* NDEBUG */
1006         ARR_APP1(ir_entity *, ent->overwrites, overwritten);
1007         ARR_APP1(ir_entity *, overwritten->overwrittenby, ent);
1008 }  /* add_entity_overwrites */
1009
1010 int
1011 get_entity_n_overwrites(ir_entity *ent) {
1012         assert(is_Class_type(get_entity_owner(ent)));
1013         return (ARR_LEN(ent->overwrites));
1014 }  /* get_entity_n_overwrites */
1015
1016 int
1017 get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten) {
1018         int i;
1019         assert(is_Class_type(get_entity_owner(ent)));
1020         for (i = 0; i < get_entity_n_overwrites(ent); i++)
1021                 if (get_entity_overwrites(ent, i) == overwritten)
1022                         return i;
1023         return -1;
1024 }  /* get_entity_overwrites_index */
1025
1026 ir_entity *
1027 get_entity_overwrites(ir_entity *ent, int pos) {
1028         assert(is_Class_type(get_entity_owner(ent)));
1029         assert(pos < get_entity_n_overwrites(ent));
1030         return ent->overwrites[pos];
1031 }  /* get_entity_overwrites */
1032
1033 void
1034 set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten) {
1035         assert(is_Class_type(get_entity_owner(ent)));
1036         assert(pos < get_entity_n_overwrites(ent));
1037         ent->overwrites[pos] = overwritten;
1038 }  /* set_entity_overwrites */
1039
1040 void
1041 remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten) {
1042         int i;
1043         assert(is_Class_type(get_entity_owner(ent)));
1044         for (i = 0; i < (ARR_LEN (ent->overwrites)); i++)
1045                 if (ent->overwrites[i] == overwritten) {
1046                         for(; i < (ARR_LEN (ent->overwrites))-1; i++)
1047                                 ent->overwrites[i] = ent->overwrites[i+1];
1048                         ARR_SETLEN(ir_entity*, ent->overwrites, ARR_LEN(ent->overwrites) - 1);
1049                         break;
1050                 }
1051 }  /* remove_entity_overwrites */
1052
1053 void
1054 add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites) {
1055         add_entity_overwrites(overwrites, ent);
1056 }  /* add_entity_overwrittenby */
1057
1058 int
1059 get_entity_n_overwrittenby(ir_entity *ent) {
1060         assert(is_Class_type(get_entity_owner(ent)));
1061         return (ARR_LEN (ent->overwrittenby));
1062 }  /* get_entity_n_overwrittenby */
1063
1064 int
1065 get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites) {
1066         int i;
1067         assert(is_Class_type(get_entity_owner(ent)));
1068         for (i = 0; i < get_entity_n_overwrittenby(ent); i++)
1069                 if (get_entity_overwrittenby(ent, i) == overwrites)
1070                         return i;
1071         return -1;
1072 }  /* get_entity_overwrittenby_index */
1073
1074 ir_entity *
1075 get_entity_overwrittenby(ir_entity *ent, int pos) {
1076         assert(is_Class_type(get_entity_owner(ent)));
1077         assert(pos < get_entity_n_overwrittenby(ent));
1078         return ent->overwrittenby[pos];
1079 }  /* get_entity_overwrittenby */
1080
1081 void
1082 set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites) {
1083         assert(is_Class_type(get_entity_owner(ent)));
1084         assert(pos < get_entity_n_overwrittenby(ent));
1085         ent->overwrittenby[pos] = overwrites;
1086 }  /* set_entity_overwrittenby */
1087
1088 void    remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites) {
1089         int i;
1090         assert(is_Class_type(get_entity_owner(ent)));
1091         for (i = 0; i < (ARR_LEN (ent->overwrittenby)); i++)
1092                 if (ent->overwrittenby[i] == overwrites) {
1093                         for(; i < (ARR_LEN (ent->overwrittenby))-1; i++)
1094                                 ent->overwrittenby[i] = ent->overwrittenby[i+1];
1095                         ARR_SETLEN(ir_entity*, ent->overwrittenby, ARR_LEN(ent->overwrittenby) - 1);
1096                         break;
1097                 }
1098 }  /* remove_entity_overwrittenby */
1099
1100 /* A link to store intermediate information */
1101 void *
1102 (get_entity_link)(const ir_entity *ent) {
1103         return _get_entity_link(ent);
1104 }  /* get_entity_link */
1105
1106 void
1107 (set_entity_link)(ir_entity *ent, void *l) {
1108         _set_entity_link(ent, l);
1109 }  /* set_entity_link */
1110
1111 ir_graph *
1112 (get_entity_irg)(const ir_entity *ent) {
1113         return _get_entity_irg(ent);
1114 }  /* get_entity_irg */
1115
1116 void
1117 set_entity_irg(ir_entity *ent, ir_graph *irg) {
1118         assert(is_method_entity(ent));
1119         /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
1120          * Methode selbst nicht mehr aufgerufen werden kann, die Entität
1121          * aber erhalten bleiben soll?  Wandle die Entitaet in description oder
1122          * inherited um! */
1123         /* assert(irg); */
1124         assert((irg  && ent->peculiarity == peculiarity_existent) ||
1125                 (!irg && (ent->peculiarity == peculiarity_existent)
1126                 && (ent -> visibility == visibility_external_allocated)) ||
1127                 (!irg && ent->peculiarity == peculiarity_description) ||
1128                 (!irg && ent->peculiarity == peculiarity_inherited));
1129         ent->attr.mtd_attr.irg = irg;
1130 }  /* set_entity_irg */
1131
1132 unsigned get_entity_vtable_number(const ir_entity *ent) {
1133         assert(is_method_entity((ir_entity *)ent));
1134         return ent->attr.mtd_attr.vtable_number;
1135 }  /* get_entity_vtable_number */
1136
1137 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number) {
1138         assert(is_method_entity(ent));
1139         ent->attr.mtd_attr.vtable_number = vtable_number;
1140 }  /* set_entity_vtable_number */
1141
1142 /* Returns the section of a method. */
1143 ir_img_section get_method_img_section(const ir_entity *ent) {
1144         assert(is_method_entity((ir_entity *)ent));
1145         return ent->attr.mtd_attr.section;
1146 }  /* get_method_img_section */
1147
1148 /* Sets the section of a method. */
1149 void set_method_img_section(ir_entity *ent, ir_img_section section) {
1150         assert(is_method_entity(ent));
1151         ent->attr.mtd_attr.section = section;
1152 }  /* set_method_img_section */
1153
1154 int
1155 (is_entity)(const void *thing) {
1156         return _is_entity(thing);
1157 }  /* is_entity */
1158
1159 int is_atomic_entity(ir_entity *ent) {
1160         ir_type *t      = get_entity_type(ent);
1161         const tp_op *op = get_type_tpop(t);
1162         return (op == type_primitive || op == type_pointer ||
1163                 op == type_enumeration || op == type_method);
1164 }  /* is_atomic_entity */
1165
1166 int is_compound_entity(ir_entity *ent) {
1167         ir_type     *t  = get_entity_type(ent);
1168         const tp_op *op = get_type_tpop(t);
1169         return (op == type_class || op == type_struct ||
1170                 op == type_array || op == type_union);
1171 }  /* is_compound_entity */
1172
1173 int is_method_entity(ir_entity *ent) {
1174         ir_type *t = get_entity_type(ent);
1175         return is_Method_type(t);
1176 }  /* is_method_entity */
1177
1178 /**
1179  * @todo not implemented!!! */
1180 int equal_entity(ir_entity *ent1, ir_entity *ent2) {
1181         fprintf(stderr, " calling unimplemented equal entity!!! \n");
1182         return 1;
1183 }  /* equal_entity */
1184
1185
1186 unsigned long (get_entity_visited)(ir_entity *ent) {
1187         return _get_entity_visited(ent);
1188 }  /* get_entity_visited */
1189
1190 void (set_entity_visited)(ir_entity *ent, unsigned long num) {
1191         _set_entity_visited(ent, num);
1192 }  /* set_entity_visited */
1193
1194 /* Sets visited field in ir_entity to entity_visited. */
1195 void (mark_entity_visited)(ir_entity *ent) {
1196         _mark_entity_visited(ent);
1197 }  /* mark_entity_visited */
1198
1199 int (entity_visited)(ir_entity *ent) {
1200         return _entity_visited(ent);
1201 }  /* entity_visited */
1202
1203 int (entity_not_visited)(ir_entity *ent) {
1204         return _entity_not_visited(ent);
1205 }  /* entity_not_visited */
1206
1207 /* Returns the mask of the additional entity properties. */
1208 unsigned get_entity_additional_properties(ir_entity *ent) {
1209         ir_graph *irg;
1210
1211         assert(is_method_entity(ent));
1212
1213         /* first check, if the graph has additional properties */
1214         irg = get_entity_irg(ent);
1215
1216         if (irg)
1217                 return get_irg_additional_properties(irg);
1218
1219         if (ent->attr.mtd_attr.irg_add_properties & mtp_property_inherited)
1220                 return get_method_additional_properties(get_entity_type(ent));
1221
1222         return ent->attr.mtd_attr.irg_add_properties;
1223 }  /* get_entity_additional_properties */
1224
1225 /* Sets the mask of the additional graph properties. */
1226 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask)
1227 {
1228         ir_graph *irg;
1229
1230         assert(is_method_entity(ent));
1231
1232         /* first check, if the graph exists */
1233         irg = get_entity_irg(ent);
1234         if (irg)
1235                 set_irg_additional_properties(irg, property_mask);
1236         else {
1237     /* do not allow to set the mtp_property_inherited flag or
1238                 * the automatic inheritance of flags will not work */
1239                 ent->attr.mtd_attr.irg_add_properties = property_mask & ~mtp_property_inherited;
1240         }
1241 }  /* set_entity_additional_properties */
1242
1243 /* Sets one additional graph property. */
1244 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag)
1245 {
1246         ir_graph *irg;
1247
1248         assert(is_method_entity(ent));
1249
1250         /* first check, if the graph exists */
1251         irg = get_entity_irg(ent);
1252         if (irg)
1253                 set_irg_additional_property(irg, flag);
1254         else {
1255                 unsigned mask = ent->attr.mtd_attr.irg_add_properties;
1256
1257                 if (mask & mtp_property_inherited)
1258                         mask = get_method_additional_properties(get_entity_type(ent));
1259
1260                         /* do not allow to set the mtp_property_inherited flag or
1261                 * the automatic inheritance of flags will not work */
1262                 ent->attr.mtd_attr.irg_add_properties = mask | (flag & ~mtp_property_inherited);
1263         }
1264 }  /* set_entity_additional_property */
1265
1266 /* Returns the class type that this type info entity represents or NULL
1267    if ent is no type info entity. */
1268 ir_type *(get_entity_repr_class)(const ir_entity *ent) {
1269         return _get_entity_repr_class(ent);
1270 }  /* get_entity_repr_class */
1271
1272 /* Initialize entity module. */
1273 void firm_init_entity(void)
1274 {
1275         symconst_symbol sym;
1276
1277         assert(firm_unknown_type && "Call init_type() before firm_init_entity()!");
1278         assert(!unknown_entity && "Call firm_init_entity() only once!");
1279
1280         unknown_entity = new_rd_entity(NULL, firm_unknown_type, new_id_from_str(UNKNOWN_ENTITY_NAME), firm_unknown_type);
1281         set_entity_visibility(unknown_entity, visibility_external_allocated);
1282         set_entity_ld_ident(unknown_entity, get_entity_ident(unknown_entity));
1283
1284         current_ir_graph      = get_const_code_irg();
1285         sym.entity_p          = unknown_entity;
1286         unknown_entity->value = new_SymConst(sym, symconst_addr_ent);
1287 }  /* firm_init_entity */