1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
4 * Authors: Martin Trapp, Christian Schaefer
18 # include "entity_t.h"
20 # include "typegmod_t.h"
22 /* All this is needed to build the constant node for methods: */
23 # include "irprog_t.h"
27 /*******************************************************************/
29 /*******************************************************************/
36 /*******************************************************************/
38 /*******************************************************************/
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);
45 INLINE void insert_entity_in_owner (entity *ent) {
46 type *owner = ent->owner;
47 switch (get_type_tpop_code(owner)) {
49 add_class_member (owner, ent);
52 add_struct_member (owner, ent);
55 add_union_member (owner, ent);
58 set_array_element_entity(owner, ent);
65 new_entity (type *owner, ident *name, type *type)
70 assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
72 res = (entity *) xmalloc (sizeof (entity));
74 assert_legal_owner_of_ent(owner);
78 if (get_type_tpop(type) == type_method)
79 res->allocation = static_allocated;
81 res->allocation = automatic_allocated;
82 res->visibility = local;
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;
91 res->variability = uninitialized;
95 res->peculiarity = existent;
96 res->volatility = non_volatile;
98 res->overwrites = NEW_ARR_F(entity *, 1);
99 res->overwrittenby = NEW_ARR_F(entity *, 1);
104 res->nr = get_irp_new_node_nr();
109 /* Remember entity in it's owner. */
110 insert_entity_in_owner (res);
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);
119 INLINE void free_entity_attrs(entity *ent) {
121 if (get_type_tpop(get_entity_owner(ent)) == type_class) {
122 DEL_ARR_F(ent->overwrites);
123 DEL_ARR_F(ent->overwrittenby);
128 copy_entity_own (entity *old, type *new_owner) {
131 assert_legal_owner_of_ent(new_owner);
132 if (old->owner == new_owner) return old;
133 new = (entity *) xmalloc (sizeof (entity));
134 memcpy (new, old, sizeof (entity));
135 new->owner = new_owner;
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);
147 if (is_class_type(new_owner)) {
148 new->overwrites = NEW_ARR_F(entity *, 1);
149 new->overwrittenby = NEW_ARR_F(entity *, 1);
152 new->nr = get_irp_new_node_nr();
155 insert_entity_in_owner (new);
161 copy_entity_name (entity *old, ident *new_name) {
164 if (old->name == new_name) return old;
165 new = (entity *) xmalloc (sizeof (entity));
166 memcpy (new, old, sizeof (entity));
167 new->name = new_name;
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);
174 new->nr = get_irp_new_node_nr();
177 insert_entity_in_owner (new);
184 free_entity (entity *ent) {
185 free_tarval_entity(ent);
186 free_entity_attrs(ent);
190 /* Outputs a unique number for this node */
192 get_entity_nr(entity *ent) {
202 get_entity_name (entity *ent) {
204 return id_to_str(get_entity_ident(ent));
208 get_entity_ident (entity *ent) {
214 void set_entitye_ld_name (entity *, char *ld_name);
215 void set_entity_ld_ident (entity *, ident *ld_ident);
219 get_entity_owner (entity *ent) {
220 return ent->owner = skip_tid(ent->owner);
224 set_entity_owner (entity *ent, type *owner) {
225 assert_legal_owner_of_ent(owner);
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! */
239 get_entity_ld_ident (entity *ent)
241 if (ent->ld_name == NULL)
242 ent->ld_name = mangle_entity (ent);
247 set_entity_ld_ident (entity *ent, ident *ld_ident) {
248 ent->ld_name = ld_ident;
252 get_entity_ld_name (entity *ent) {
253 return id_to_str(get_entity_ld_ident(ent));
257 char *get_entity_ld_name (entity *);
258 void set_entity_ld_name (entity *, char *ld_name);
262 get_entity_type (entity *ent) {
263 return ent->type = skip_tid(ent->type);
267 set_entity_type (entity *ent, type *type) {
272 INLINE ent_allocation
273 get_entity_allocation (entity *ent) {
274 return ent->allocation;
278 set_entity_allocation (entity *ent, ent_allocation al) {
279 ent->allocation = al;
283 INLINE ent_visibility
284 get_entity_visibility (entity *ent) {
285 return ent->visibility;
289 set_entity_visibility (entity *ent, ent_visibility vis) {
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;
298 INLINE ent_variability
299 get_entity_variability (entity *ent) {
300 return ent->variability;
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);
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);
319 ent->variability = var;
322 /* return the name of the variablity */
323 const char *get_variability_name(ent_variability var)
325 #define X(a) case a: return #a
331 default: return "BAD VALUE";
336 INLINE ent_volatility
337 get_entity_volatility (entity *ent) {
339 return ent->volatility;
343 set_entity_volatility (entity *ent, ent_volatility vol) {
345 ent->volatility = vol;
348 /* return the name of the volatility */
349 const char *get_volatility_name(ent_volatility var)
351 #define X(a) case a: return #a
355 default: return "BAD VALUE";
361 get_entity_peculiarity (entity *ent) {
363 return ent->peculiarity;
367 set_entity_peculiarity (entity *ent, peculiarity pec) {
369 /* @@@ why peculiarity only for methods? */
370 assert (is_method_type(ent->type));
371 ent->peculiarity = pec;
374 /* return the name of the peculiarity */
375 const char *get_peculiarity_name(peculiarity var)
377 #define X(a) case a: return #a
382 default: return "BAD VALUE";
387 /* Set has no effect for entities of type method. */
389 get_atomic_ent_value(entity *ent) {
390 assert(ent); assert(is_atomic_entity(ent));
391 assert((ent->variability != uninitialized));
396 set_atomic_ent_value(entity *ent, ir_node *val) {
397 assert(ent && is_atomic_entity(ent) && (ent->variability != uninitialized));
398 if (is_method_type(ent->type)) return;
403 ir_node *copy_const_value(ir_node *n) {
408 switch(get_irn_opcode(n)) {
410 nn = new_Const(m, get_Const_tarval(n)); break;
412 nn = new_SymConst(get_SymConst_type_or_id(n), get_SymConst_kind(n)); break;
414 nn = new_Add(copy_const_value(get_Add_left(n)), copy_const_value(get_Add_right(n)), m); break;
416 assert(0 && "opdope invalid or not implemented");
423 /* A value of a compound entity is a pair of value and the corresponding member of
426 add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
427 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
428 ARR_APP1 (ir_node *, ent->values, val);
429 ARR_APP1 (entity *, ent->val_ents, member);
432 /* Copies the firm subgraph referenced by val to const_code_irg and adds
433 the node as constant initialization to ent.
434 The subgraph may not contain control flow operations.
436 copy_and_add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
437 ir_graph *rem = current_ir_graph;
439 assert(get_entity_variability(ent) != uninitialized);
440 current_ir_graph = get_const_code_irg();
442 val = copy_const_value(val);
443 add_compound_ent_value(ent, val, member);
444 current_ir_graph = rem;
448 get_compound_ent_n_values(entity *ent) {
449 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
450 return (ARR_LEN (ent->values))-1;
454 get_compound_ent_value(entity *ent, int pos) {
455 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
456 return ent->values[pos+1];
459 /* Copies the value i of the entity to current_block in current_ir_graph.
461 copy_compound_ent_value(entity *ent, int pos) {
462 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
463 return copy_const_value(ent->values[pos+1]);
467 get_compound_ent_value_member(entity *ent, int pos) {
468 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
469 return ent->val_ents[pos+1];
473 set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos) {
474 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
475 ent->values[pos+1] = val;
476 ent->val_ents[pos+1] = member;
480 remove_compound_ent_value(entity *ent, entity *value_ent) {
482 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
483 for (i = 1; i < (ARR_LEN (ent->val_ents)); i++) {
484 if (ent->val_ents[i] == value_ent) {
485 for(; i < (ARR_LEN (ent->val_ents))-1; i++) {
486 ent->val_ents[i] = ent->val_ents[i+1];
487 ent->values[i] = ent->values[i+1];
489 ARR_SETLEN(entity*, ent->val_ents, ARR_LEN(ent->val_ents) - 1);
490 ARR_SETLEN(ir_node*, ent->values, ARR_LEN(ent->values) - 1);
497 set_array_entity_values(entity *ent, tarval **values, int num_vals) {
499 ir_graph *rem = current_ir_graph;
500 type *arrtp = get_entity_type(ent);
503 assert(is_array_type(arrtp));
504 assert(get_array_n_dimensions(arrtp) == 1);
505 /* One bound is sufficient, the nunmber of constant fields makes the
507 assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
508 assert(get_entity_variability(ent) != uninitialized);
509 current_ir_graph = get_const_code_irg();
511 for (i = 0; i < num_vals; i++) {
512 val = new_Const(get_tarval_mode (values[i]), values[i]);
513 add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
515 current_ir_graph = rem;
519 get_entity_offset (entity *ent) {
524 set_entity_offset (entity *ent, int offset) {
525 ent->offset = offset;
529 add_entity_overwrites (entity *ent, entity *overwritten) {
531 assert(is_class_type(get_entity_owner(ent)));
532 ARR_APP1 (entity *, ent->overwrites, overwritten);
533 ARR_APP1 (entity *, overwritten->overwrittenby, ent);
537 get_entity_n_overwrites (entity *ent) {
539 assert(is_class_type(get_entity_owner(ent)));
540 return (ARR_LEN (ent->overwrites))-1;
544 get_entity_overwrites_index(entity *ent, entity *overwritten) {
546 assert(ent && is_class_type(get_entity_owner(ent)));
547 for (i = 0; i < get_entity_n_overwrites(ent); i++)
548 if (get_entity_overwrites(ent, i) == overwritten)
554 get_entity_overwrites (entity *ent, int pos) {
556 assert(is_class_type(get_entity_owner(ent)));
557 assert(pos < get_entity_n_overwrites(ent));
558 return ent->overwrites[pos+1];
562 set_entity_overwrites (entity *ent, int pos, entity *overwritten) {
564 assert(is_class_type(get_entity_owner(ent)));
565 assert(pos < get_entity_n_overwrites(ent));
566 ent->overwrites[pos+1] = overwritten;
570 remove_entity_overwrites(entity *ent, entity *overwritten) {
572 assert(ent && is_class_type(get_entity_owner(ent)));
573 for (i = 1; i < (ARR_LEN (ent->overwrites)); i++)
574 if (ent->overwrites[i] == overwritten) {
575 for(; i < (ARR_LEN (ent->overwrites))-1; i++)
576 ent->overwrites[i] = ent->overwrites[i+1];
577 ARR_SETLEN(entity*, ent->overwrites, ARR_LEN(ent->overwrites) - 1);
583 add_entity_overwrittenby (entity *ent, entity *overwrites) {
585 assert(is_class_type(get_entity_owner(ent)));
586 add_entity_overwrites(overwrites, ent);
590 get_entity_n_overwrittenby (entity *ent) {
592 assert(is_class_type(get_entity_owner(ent)));
593 return (ARR_LEN (ent->overwrittenby))-1;
597 get_entity_overwrittenby_index(entity *ent, entity *overwrites) {
599 assert(ent && is_class_type(get_entity_owner(ent)));
600 for (i = 0; i < get_entity_n_overwrittenby(ent); i++)
601 if (get_entity_overwrittenby(ent, i) == overwrites)
607 get_entity_overwrittenby (entity *ent, int pos) {
609 assert(is_class_type(get_entity_owner(ent)));
610 assert(pos < get_entity_n_overwrittenby(ent));
611 return ent->overwrittenby[pos+1];
615 set_entity_overwrittenby (entity *ent, int pos, entity *overwrites) {
617 assert(is_class_type(get_entity_owner(ent)));
618 assert(pos < get_entity_n_overwrittenby(ent));
619 ent->overwrittenby[pos+1] = overwrites;
622 void remove_entity_overwrittenby(entity *ent, entity *overwrites) {
624 assert(ent && is_class_type(get_entity_owner(ent)));
625 for (i = 1; i < (ARR_LEN (ent->overwrittenby)); i++)
626 if (ent->overwrittenby[i] == overwrites) {
627 for(; i < (ARR_LEN (ent->overwrittenby))-1; i++)
628 ent->overwrittenby[i] = ent->overwrittenby[i+1];
629 ARR_SETLEN(entity*, ent->overwrittenby, ARR_LEN(ent->overwrittenby) - 1);
634 /* A link to store intermediate information */
636 get_entity_link(entity *ent) {
642 set_entity_link(entity *ent, void *l) {
648 get_entity_irg(entity *ent) {
650 assert (is_method_type(ent->type));
655 set_entity_irg(entity *ent, ir_graph *irg) {
656 assert (ent && ent->type);
657 /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
658 * Methode selbst nicht mehr aufgerufen werden kann, die Entität
659 * aber erhalten bleiben soll. */
661 assert (is_method_type(ent->type));
662 assert (ent->peculiarity == existent);
666 int is_entity (void *thing) {
668 if (get_kind(thing) == k_entity)
674 int is_atomic_entity(entity *ent) {
675 type* t = get_entity_type(ent);
676 return (is_primitive_type(t) || is_pointer_type(t) ||
677 is_enumeration_type(t) || is_method_type(t));
680 int is_compound_entity(entity *ent) {
681 type* t = get_entity_type(ent);
682 return (is_class_type(t) || is_struct_type(t) ||
683 is_array_type(t) || is_union_type(t));
686 /* @@@ not implemnted!!! */
687 bool equal_entity(entity *ent1, entity *ent2) {
688 printf(" calling unimplemented equal entity!!! \n");
693 unsigned long get_entity_visited(entity *ent) {
697 void set_entity_visited(entity *ent, unsigned long num) {
701 /* Sets visited field in entity to entity_visited. */
702 void mark_entity_visited(entity *ent) {
704 ent->visit = type_visited;
708 INLINE bool entity_visited(entity *ent) {
709 return get_entity_visited(ent) >= type_visited;
711 INLINE bool entity_not_visited(entity *ent) {
712 return get_entity_visited(ent) < type_visited;