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