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

   1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
   2 * All rights reserved.
   3 *
   4 * Authors: Martin Trapp, Christian Schaefer
   5 *
   6 */
   7
   8 /* $Id$ */
   9
  10 #ifdef HAVE_CONFIG_H
  11 # include <config.h>
  12 #endif
  13
  14 # include <stdlib.h>
  15 # include <stddef.h>
  16 # include <string.h>
  17
  18 # include "entity_t.h"
  19 # include "mangle.h"
  20 # include "typegmod_t.h"
  21 # include "array.h"
  22 /* All this is needed to build the constant node for methods: */
  23 # include "irprog_t.h"
  24 # include "ircons.h"
  25 # include "tv_t.h"
  26
  27 /*******************************************************************/
  28 /** general                                                       **/
  29 /*******************************************************************/
  30
  31 void
  32 init_entity (void)
  33 {
  34 }
  35
  36 /*******************************************************************/
  37 /** ENTITY                                                        **/
  38 /*******************************************************************/
  39
  40 /* redeclared to declare INLINE. */
  41 INLINE entity *get_entity_overwrites   (entity *ent, int pos);
  42 INLINE entity *get_entity_overwrittenby   (entity *ent, int pos);
  43 INLINE type   *get_entity_owner (entity *ent);
  44
  45 INLINE void insert_entity_in_owner (entity *ent) {
  46   type *owner = ent->owner;
  47   switch (get_type_tpop_code(owner)) {
  48   case tpo_class: {
  49     add_class_member (owner, ent);
  50   } break;
  51   case tpo_struct: {
  52     add_struct_member (owner, ent);
  53   } break;
  54   case tpo_union: {
  55     add_union_member (owner, ent);
  56   } break;
  57   case tpo_array: {
  58     set_array_element_entity(owner, ent);
  59   } break;
  60   default: assert(0);
  61   }
  62 }
  63
  64 entity *
  65 new_entity (type *owner, ident *name, type *type)
  66 {
  67   entity *res;
  68   ir_graph *rem;
  69
  70   assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
  71
  72   res = (entity *) malloc (sizeof (entity));
  73   res->kind = k_entity;
  74   assert_legal_owner_of_ent(owner);
  75   res->owner = owner;
  76   res->name = name;
  77   res->type = type;
  78   if (get_type_tpop(type) == type_method)
  79     res->allocation = static_allocated;
  80   else
  81     res->allocation = automatic_allocated;
  82   res->visibility = local;
  83   res->offset = -1;
  84   if (is_method_type(type)) {
  85     res->variability = constant;
  86     rem = current_ir_graph;
  87     current_ir_graph = get_const_code_irg();
  88     res->value = new_Const(mode_P, new_tarval_from_entity(res, mode_P));
  89     current_ir_graph = rem;
  90   } else {
  91     res->variability = uninitialized;
  92     res->value = NULL;
  93     res->values = NULL;
  94   }
  95   res->peculiarity = existent;
  96   res->volatility = non_volatile;
  97   res->ld_name = NULL;
  98   res->overwrites = NEW_ARR_F(entity *, 1);
  99   res->overwrittenby = NEW_ARR_F(entity *, 1);
 100
 101   res->irg = NULL;
 102
 103 #ifdef DEBUG_libfirm
 104   res->nr = get_irp_new_node_nr();
 105 #endif
 106
 107   res->visit = 0;
 108
 109   /* Remember entity in it's owner. */
 110   insert_entity_in_owner (res);
 111   return res;
 112 }
 113 entity *
 114 new_d_entity (type *owner, ident *name, type *type, dbg_info *db) {
 115   entity *res = new_entity(owner, name, type);
 116   set_entity_dbg_info(res, db);
 117   return res;
 118 }
 119 INLINE void free_entity_attrs(entity *ent) {
 120   assert(ent);
 121   if (get_type_tpop(get_entity_owner(ent)) == type_class) {
 122     DEL_ARR_F(ent->overwrites);
 123     DEL_ARR_F(ent->overwrittenby);
 124   }
 125 }
 126
 127 entity *
 128 copy_entity_own (entity *old, type *new_owner) {
 129   entity *new;
 130
 131   assert_legal_owner_of_ent(new_owner);
 132   if (old->owner == new_owner) return old;
 133   new = (entity *) malloc (sizeof (entity));
 134   memcpy (new, old, sizeof (entity));
 135   new->owner = new_owner;
 136   /*
 137   if ((get_type_tpop(get_entity_owner(old)) == type_class) &&
 138       (get_type_tpop(new_owner) == type_class)) {
 139     new->overwrites = DUP_ARR_F(entity *, old->overwrites);
 140     new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
 141   } else if ((get_type_tpop(get_entity_owner(old)) != type_class) &&
 142              (get_type_tpop(new_owner) == type_class)) {
 143     new->overwrites = NEW_ARR_F(entity *, 1);
 144     new->overwrittenby = NEW_ARR_F(entity *, 1);
 145   }
 146   */
 147   if (is_class_type(new_owner)) {
 148     new->overwrites = NEW_ARR_F(entity *, 1);
 149     new->overwrittenby = NEW_ARR_F(entity *, 1);
 150   }
 151 #ifdef DEBUG_libfirm
 152   new->nr = get_irp_new_node_nr();
 153 #endif
 154
 155   insert_entity_in_owner (new);
 156
 157   return new;
 158 }
 159
 160 entity *
 161 copy_entity_name (entity *old, ident *new_name) {
 162   entity *new;
 163
 164   if (old->name == new_name) return old;
 165   new = (entity *) malloc (sizeof (entity));
 166   memcpy (new, old, sizeof (entity));
 167   new->name = new_name;
 168   new->ld_name = NULL;
 169   if (is_class_type(new->owner)) {
 170     new->overwrites = DUP_ARR_F(entity *, old->overwrites);
 171     new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
 172   }
 173 #ifdef DEBUG_libfirm
 174   new->nr = get_irp_new_node_nr();
 175 #endif
 176
 177   insert_entity_in_owner (new);
 178
 179   return new;
 180 }
 181
 182
 183 void
 184 free_entity (entity *ent) {
 185   free_tarval_entity(ent);
 186   free_entity_attrs(ent);
 187   free(ent);
 188 }
 189
 190 /* Outputs a unique number for this node */
 191 INLINE long
 192 get_entity_nr(entity *ent) {
 193   assert(ent);
 194 #ifdef DEBUG_libfirm
 195   return ent->nr;
 196 #else
 197   return 0;
 198 #endif
 199 }
 200
 201 INLINE const char *
 202 get_entity_name (entity *ent) {
 203   assert (ent);
 204   return id_to_str(get_entity_ident(ent));
 205 }
 206
 207 ident *
 208 get_entity_ident    (entity *ent) {
 209   assert(ent);
 210   return ent->name;
 211 }
 212
 213 /*
 214 void   set_entitye_ld_name  (entity *, char *ld_name);
 215 void   set_entity_ld_ident (entity *, ident *ld_ident);
 216 */
 217
 218 INLINE type *
 219 get_entity_owner (entity *ent) {
 220   return ent->owner = skip_tid(ent->owner);
 221 }
 222
 223 INLINE void
 224 set_entity_owner (entity *ent, type *owner) {
 225   assert_legal_owner_of_ent(owner);
 226   ent->owner = owner;
 227 }
 228
 229 INLINE void   /* should this go into type.c? */
 230 assert_legal_owner_of_ent(type *owner) {
 231   assert (get_type_tpop_code(owner) == tpo_class ||
 232           get_type_tpop_code(owner) == tpo_union ||
 233           get_type_tpop_code(owner) == tpo_struct ||
 234           get_type_tpop_code(owner) == tpo_array);   /* Yes, array has an entity
 235                                                         -- to select fields! */
 236 }
 237
 238 INLINE ident *
 239 get_entity_ld_ident (entity *ent)
 240 {
 241   if (ent->ld_name == NULL)
 242     ent->ld_name = mangle_entity (ent);
 243   return ent->ld_name;
 244 }
 245
 246 INLINE void
 247 set_entity_ld_ident (entity *ent, ident *ld_ident) {
 248   ent->ld_name = ld_ident;
 249 }
 250
 251 INLINE const char *
 252 get_entity_ld_name (entity *ent) {
 253   return id_to_str(get_entity_ld_ident(ent));
 254 }
 255
 256 /*
 257 char  *get_entity_ld_name  (entity *);
 258 void   set_entity_ld_name  (entity *, char *ld_name);
 259 */
 260
 261 INLINE type *
 262 get_entity_type (entity *ent) {
 263   return ent->type = skip_tid(ent->type);
 264 }
 265
 266 INLINE void
 267 set_entity_type (entity *ent, type *type) {
 268   ent->type = type;
 269 }
 270
 271
 272 INLINE ent_allocation
 273 get_entity_allocation (entity *ent) {
 274   return ent->allocation;
 275 }
 276
 277 INLINE void
 278 set_entity_allocation (entity *ent, ent_allocation al) {
 279   ent->allocation = al;
 280 }
 281
 282
 283 INLINE ent_visibility
 284 get_entity_visibility (entity *ent) {
 285   return ent->visibility;
 286 }
 287
 288 INLINE void
 289 set_entity_visibility (entity *ent, ent_visibility vis) {
 290   if (vis != local)
 291     assert((ent->allocation == static_allocated) ||
 292            (ent->allocation == automatic_allocated));
 293   // @@@ Test that the owner type is not local, but how??
 294   //       && get_class_visibility(get_entity_owner(ent)) != local));
 295   ent->visibility = vis;
 296 }
 297
 298 INLINE ent_variability
 299 get_entity_variability (entity *ent) {
 300   return ent->variability;
 301 }
 302
 303 INLINE void
 304 set_entity_variability (entity *ent, ent_variability var){
 305   if (var == part_constant)
 306     assert(is_class_type(ent->type) || is_struct_type(ent->type));
 307   if ((is_compound_type(ent->type)) &&
 308       (ent->variability == uninitialized) && (var != uninitialized)) {
 309     /* Allocate datastructures for constant values */
 310     ent->values = NEW_ARR_F(ir_node *, 1);
 311     ent->val_ents = NEW_ARR_F(entity *, 1);
 312   }
 313   if ((is_compound_type(ent->type)) &&
 314       (var == uninitialized) && (ent->variability != uninitialized)) {
 315     /* Free datastructures for constant values */
 316     DEL_ARR_F(ent->values);
 317     DEL_ARR_F(ent->val_ents);
 318   }
 319   ent->variability = var;
 320 }
 321
 322
 323 INLINE ent_volatility
 324 get_entity_volatility (entity *ent) {
 325   assert (ent);
 326   return ent->volatility;
 327 }
 328
 329 INLINE void
 330 set_entity_volatility (entity *ent, ent_volatility vol) {
 331   assert (ent);
 332   ent->volatility = vol;
 333 }
 334
 335 INLINE peculiarity
 336 get_entity_peculiarity (entity *ent) {
 337   assert (ent);
 338   return ent->peculiarity;
 339 }
 340
 341 INLINE void
 342 set_entity_peculiarity (entity *ent, peculiarity pec) {
 343   assert (ent);
 344   /* @@@ why peculiarity only for methods? */
 345   assert (is_method_type(ent->type));
 346   ent->peculiarity = pec;
 347 }
 348
 349 /* Set has no effect for entities of type method. */
 350 INLINE ir_node *
 351 get_atomic_ent_value(entity *ent) {
 352   assert(ent); assert(is_atomic_entity(ent));
 353   assert((ent->variability != uninitialized));
 354   return ent->value;
 355 }
 356
 357 INLINE void
 358 set_atomic_ent_value(entity *ent, ir_node *val) {
 359   assert(ent && is_atomic_entity(ent) && (ent->variability != uninitialized));
 360   if (is_method_type(ent->type)) return;
 361   ent->value = val;
 362 }
 363
 364
 365 ir_node *copy_const_value(ir_node *n) {
 366   ir_node *nn;
 367   ir_mode *m;
 368
 369   m = get_irn_mode(n);
 370   switch(get_irn_opcode(n)) {
 371   case iro_Const:
 372     nn = new_Const(m, get_Const_tarval(n)); break;
 373   case iro_SymConst:
 374     nn = new_SymConst(get_SymConst_type_or_id(n), get_SymConst_kind(n)); break;
 375   case iro_Add:
 376     nn = new_Add(copy_const_value(get_Add_left(n)), copy_const_value(get_Add_right(n)), m); break;
 377   default:
 378     assert(0 && "opdope invalid or not implemented"); break;
 379   }
 380   return nn;
 381 }
 382
 383 /* A value of a compound entity is a pair of value and the corresponding member of
 384    the compound. */
 385 INLINE void
 386 add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
 387   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 388   ARR_APP1 (ir_node *, ent->values, val);
 389   ARR_APP1 (entity *, ent->val_ents, member);
 390 }
 391
 392 /* Copies the firm subgraph referenced by val to const_code_irg and adds
 393    the node as constant initialization to ent.
 394    The subgraph may not contain control flow operations.
 395 INLINE void
 396 copy_and_add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
 397   ir_graph *rem = current_ir_graph;
 398
 399   assert(get_entity_variability(ent) != uninitialized);
 400   current_ir_graph = get_const_code_irg();
 401
 402   val = copy_const_value(val);
 403   add_compound_ent_value(ent, val, member);
 404   current_ir_graph = rem;
 405   }*/
 406
 407 INLINE int
 408 get_compound_ent_n_values(entity *ent) {
 409   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 410   return (ARR_LEN (ent->values))-1;
 411 }
 412
 413 INLINE ir_node  *
 414 get_compound_ent_value(entity *ent, int pos) {
 415   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 416   return ent->values[pos+1];
 417 }
 418
 419 /* Copies the value i of the entity to current_block in current_ir_graph.
 420 ir_node *
 421 copy_compound_ent_value(entity *ent, int pos) {
 422   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 423   return copy_const_value(ent->values[pos+1]);
 424   }*/
 425
 426 INLINE entity   *
 427 get_compound_ent_value_member(entity *ent, int pos) {
 428   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 429   return ent->val_ents[pos+1];
 430 }
 431
 432 INLINE void
 433 set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos) {
 434   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 435   ent->values[pos+1] = val;
 436   ent->val_ents[pos+1] = member;
 437 }
 438
 439 void
 440 remove_compound_ent_value(entity *ent, entity *value_ent) {
 441   int i;
 442   assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
 443   for (i = 1; i < (ARR_LEN (ent->val_ents)); i++) {
 444     if (ent->val_ents[i] == value_ent) {
 445       for(; i < (ARR_LEN (ent->val_ents))-1; i++) {
 446         ent->val_ents[i] = ent->val_ents[i+1];
 447         ent->values[i]   = ent->values[i+1];
 448       }
 449       ARR_SETLEN(entity*,  ent->val_ents, ARR_LEN(ent->val_ents) - 1);
 450       ARR_SETLEN(ir_node*, ent->values,   ARR_LEN(ent->values) - 1);
 451       break;
 452     }
 453   }
 454 }
 455
 456 void
 457 set_array_entity_values(entity *ent, tarval **values, int num_vals) {
 458   int i;
 459   ir_graph *rem = current_ir_graph;
 460   type *arrtp = get_entity_type(ent);
 461   ir_node *val;
 462
 463   assert(is_array_type(arrtp));
 464   assert(get_array_n_dimensions(arrtp) == 1);
 465   /* One bound is sufficient, the nunmber of constant fields makes the
 466      size. */
 467   assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
 468   assert(get_entity_variability(ent) != uninitialized);
 469   current_ir_graph = get_const_code_irg();
 470
 471   for (i = 0; i < num_vals; i++) {
 472     val = new_Const(get_tarval_mode (values[i]), values[i]);
 473     add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
 474   }
 475   current_ir_graph = rem;
 476 }
 477
 478 INLINE int
 479 get_entity_offset (entity *ent) {
 480   return ent->offset;
 481 }
 482
 483 INLINE void
 484 set_entity_offset (entity *ent, int offset) {
 485   ent->offset = offset;
 486 }
 487
 488 INLINE void
 489 add_entity_overwrites   (entity *ent, entity *overwritten) {
 490   assert(ent);
 491   assert(is_class_type(get_entity_owner(ent)));
 492   ARR_APP1 (entity *, ent->overwrites, overwritten);
 493   ARR_APP1 (entity *, overwritten->overwrittenby, ent);
 494 }
 495
 496 INLINE int
 497 get_entity_n_overwrites (entity *ent) {
 498   assert(ent);
 499   assert(is_class_type(get_entity_owner(ent)));
 500   return (ARR_LEN (ent->overwrites))-1;
 501 }
 502
 503 int
 504 get_entity_overwrites_index(entity *ent, entity *overwritten) {
 505   int i;
 506   assert(ent && is_class_type(get_entity_owner(ent)));
 507   for (i = 0; i < get_entity_n_overwrites(ent); i++)
 508     if (get_entity_overwrites(ent, i) == overwritten)
 509       return i;
 510   return -1;
 511 }
 512
 513 INLINE entity *
 514 get_entity_overwrites   (entity *ent, int pos) {
 515   assert(ent);
 516   assert(is_class_type(get_entity_owner(ent)));
 517   assert(pos < get_entity_n_overwrites(ent));
 518   return ent->overwrites[pos+1];
 519 }
 520
 521 INLINE void
 522 set_entity_overwrites   (entity *ent, int pos, entity *overwritten) {
 523   assert(ent);
 524   assert(is_class_type(get_entity_owner(ent)));
 525   assert(pos < get_entity_n_overwrites(ent));
 526   ent->overwrites[pos+1] = overwritten;
 527 }
 528
 529 void
 530 remove_entity_overwrites(entity *ent, entity *overwritten) {
 531   int i;
 532   assert(ent && is_class_type(get_entity_owner(ent)));
 533   for (i = 1; i < (ARR_LEN (ent->overwrites)); i++)
 534     if (ent->overwrites[i] == overwritten) {
 535       for(; i < (ARR_LEN (ent->overwrites))-1; i++)
 536         ent->overwrites[i] = ent->overwrites[i+1];
 537       ARR_SETLEN(entity*, ent->overwrites, ARR_LEN(ent->overwrites) - 1);
 538       break;
 539     }
 540 }
 541
 542 INLINE void
 543 add_entity_overwrittenby   (entity *ent, entity *overwrites) {
 544   assert(ent);
 545   assert(is_class_type(get_entity_owner(ent)));
 546   add_entity_overwrites(overwrites, ent);
 547 }
 548
 549 INLINE int
 550 get_entity_n_overwrittenby (entity *ent) {
 551   assert(ent);
 552   assert(is_class_type(get_entity_owner(ent)));
 553   return (ARR_LEN (ent->overwrittenby))-1;
 554 }
 555
 556 int
 557 get_entity_overwrittenby_index(entity *ent, entity *overwrites) {
 558   int i;
 559   assert(ent && is_class_type(get_entity_owner(ent)));
 560   for (i = 0; i < get_entity_n_overwrittenby(ent); i++)
 561     if (get_entity_overwrittenby(ent, i) == overwrites)
 562       return i;
 563   return -1;
 564 }
 565
 566 INLINE entity *
 567 get_entity_overwrittenby   (entity *ent, int pos) {
 568   assert(ent);
 569   assert(is_class_type(get_entity_owner(ent)));
 570   assert(pos < get_entity_n_overwrittenby(ent));
 571   return ent->overwrittenby[pos+1];
 572 }
 573
 574 INLINE void
 575 set_entity_overwrittenby   (entity *ent, int pos, entity *overwrites) {
 576   assert(ent);
 577   assert(is_class_type(get_entity_owner(ent)));
 578   assert(pos < get_entity_n_overwrittenby(ent));
 579   ent->overwrittenby[pos+1] = overwrites;
 580 }
 581
 582 void    remove_entity_overwrittenby(entity *ent, entity *overwrites) {
 583   int i;
 584   assert(ent && is_class_type(get_entity_owner(ent)));
 585   for (i = 1; i < (ARR_LEN (ent->overwrittenby)); i++)
 586     if (ent->overwrittenby[i] == overwrites) {
 587       for(; i < (ARR_LEN (ent->overwrittenby))-1; i++)
 588         ent->overwrittenby[i] = ent->overwrittenby[i+1];
 589       ARR_SETLEN(entity*, ent->overwrittenby, ARR_LEN(ent->overwrittenby) - 1);
 590       break;
 591     }
 592 }
 593
 594 /* A link to store intermediate information */
 595 void *
 596 get_entity_link(entity *ent) {
 597   assert(ent);
 598   return ent->link;
 599 }
 600
 601 void
 602 set_entity_link(entity *ent, void *l) {
 603   assert(ent);
 604   ent->link = l;
 605 }
 606
 607 INLINE ir_graph *
 608 get_entity_irg(entity *ent) {
 609   assert (ent);
 610   assert (is_method_type(ent->type));
 611   return ent->irg;
 612 }
 613
 614 INLINE void
 615 set_entity_irg(entity *ent, ir_graph *irg) {
 616   assert (ent && ent->type);
 617   /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
 618    * Methode selbst nicht mehr aufgerufen werden kann, die Entität
 619    * aber erhalten bleiben soll. */
 620   /* assert (irg); */
 621   assert (is_method_type(ent->type));
 622   assert (ent->peculiarity == existent);
 623   ent->irg = irg;
 624 }
 625
 626 int is_entity (void *thing) {
 627   assert(thing);
 628   if (get_kind(thing) == k_entity)
 629     return 1;
 630   else
 631     return 0;
 632 }
 633
 634 int is_atomic_entity(entity *ent) {
 635   type* t = get_entity_type(ent);
 636   return (is_primitive_type(t) || is_pointer_type(t) ||
 637           is_enumeration_type(t) || is_method_type(t));
 638 }
 639
 640 int is_compound_entity(entity *ent) {
 641   type* t = get_entity_type(ent);
 642   return (is_class_type(t) || is_struct_type(t) ||
 643           is_array_type(t) || is_union_type(t));
 644 }
 645
 646 /* @@@ not implemnted!!! */
 647 bool equal_entity(entity *ent1, entity *ent2) {
 648   printf(" calling unimplemented equal entity!!! \n");
 649   return true;
 650 }
 651
 652
 653 unsigned long get_entity_visited(entity *ent) {
 654   assert (ent);
 655   return ent->visit;
 656 }
 657 void        set_entity_visited(entity *ent, unsigned long num) {
 658   assert (ent);
 659   ent->visit = num;
 660 }
 661 /* Sets visited field in entity to entity_visited. */
 662 void        mark_entity_visited(entity *ent) {
 663   assert (ent);
 664   ent->visit = type_visited;
 665 }
 666
 667
 668 INLINE bool entity_visited(entity *ent) {
 669   return get_entity_visited(ent) >= type_visited;
 670 }
 671 INLINE bool entity_not_visited(entity *ent) {
 672   return get_entity_visited(ent) < type_visited;
 673 }