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"
26 /*******************************************************************/
28 /*******************************************************************/
35 /*******************************************************************/
37 /*******************************************************************/
39 /* redeclared to declare INLINE. */
40 INLINE entity *get_entity_overwrites (entity *ent, int pos);
41 INLINE entity *get_entity_overwrittenby (entity *ent, int pos);
42 INLINE type *get_entity_owner (entity *ent);
44 INLINE void insert_entity_in_owner (entity *ent) {
45 type *owner = ent->owner;
46 switch (get_type_tpop_code(owner)) {
48 add_class_member (owner, ent);
51 add_struct_member (owner, ent);
54 add_union_member (owner, ent);
57 set_array_element_entity(owner, ent);
64 new_entity (type *owner, ident *name, type *type)
69 assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
71 res = (entity *) malloc (sizeof (entity));
73 assert_legal_owner_of_ent(owner);
77 if (get_type_tpop(type) == type_method)
78 res->allocation = static_allocated;
80 res->allocation = automatic_allocated;
81 res->visibility = local;
83 if (is_method_type(type)) {
84 res->variability = constant;
85 rem = current_ir_graph;
86 current_ir_graph = get_const_code_irg();
87 res->value = new_Const(mode_P, tarval_P_from_entity(res));
88 current_ir_graph = rem;
90 res->variability = uninitialized;
92 res->peculiarity = existent;
93 res->volatility = non_volatile;
95 res->overwrites = NEW_ARR_F(entity *, 1);
96 res->overwrittenby = NEW_ARR_F(entity *, 1);
101 res->nr = get_irp_new_node_nr();
106 /* Remember entity in it's owner. */
107 insert_entity_in_owner (res);
111 new_d_entity (type *owner, ident *name, type *type, dbg_info *db) {
112 entity *res = new_entity(owner, name, type);
113 set_entity_dbg_info(res, db);
116 INLINE void free_entity_attrs(entity *ent) {
118 if (get_type_tpop(get_entity_owner(ent)) == type_class) {
119 DEL_ARR_F(ent->overwrites);
120 DEL_ARR_F(ent->overwrittenby);
125 copy_entity_own (entity *old, type *new_owner) {
128 assert_legal_owner_of_ent(new_owner);
129 if (old->owner == new_owner) return old;
130 new = (entity *) malloc (sizeof (entity));
131 memcpy (new, old, sizeof (entity));
132 new->owner = new_owner;
134 if ((get_type_tpop(get_entity_owner(old)) == type_class) &&
135 (get_type_tpop(new_owner) == type_class)) {
136 new->overwrites = DUP_ARR_F(entity *, old->overwrites);
137 new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
138 } else if ((get_type_tpop(get_entity_owner(old)) != type_class) &&
139 (get_type_tpop(new_owner) == type_class)) {
140 new->overwrites = NEW_ARR_F(entity *, 1);
141 new->overwrittenby = NEW_ARR_F(entity *, 1);
144 if (is_class_type(new_owner)) {
145 new->overwrites = NEW_ARR_F(entity *, 1);
146 new->overwrittenby = NEW_ARR_F(entity *, 1);
149 new->nr = get_irp_new_node_nr();
152 insert_entity_in_owner (new);
158 copy_entity_name (entity *old, ident *new_name) {
161 if (old->name == new_name) return old;
162 new = (entity *) malloc (sizeof (entity));
163 memcpy (new, old, sizeof (entity));
164 new->name = new_name;
166 if (is_class_type(new->owner)) {
167 new->overwrites = DUP_ARR_F(entity *, old->overwrites);
168 new->overwrittenby = DUP_ARR_F(entity *, old->overwrittenby);
171 new->nr = get_irp_new_node_nr();
174 insert_entity_in_owner (new);
180 free_entity (entity *ent) {
181 free_entity_attrs(ent);
185 /* Outputs a unique number for this node */
187 get_entity_nr(entity *ent) {
197 get_entity_name (entity *ent) {
199 return id_to_str(get_entity_ident(ent));
203 get_entity_ident (entity *ent) {
209 void set_entitye_ld_name (entity *, char *ld_name);
210 void set_entity_ld_ident (entity *, ident *ld_ident);
214 get_entity_owner (entity *ent) {
215 return ent->owner = skip_tid(ent->owner);
219 set_entity_owner (entity *ent, type *owner) {
220 assert_legal_owner_of_ent(owner);
224 INLINE void /* should this go into type.c? */
225 assert_legal_owner_of_ent(type *owner) {
226 assert (get_type_tpop_code(owner) == tpo_class ||
227 get_type_tpop_code(owner) == tpo_union ||
228 get_type_tpop_code(owner) == tpo_struct ||
229 get_type_tpop_code(owner) == tpo_array); /* Yes, array has an entity
230 -- to select fields! */
234 get_entity_ld_ident (entity *ent)
236 if (ent->ld_name == NULL)
237 ent->ld_name = mangle_entity (ent);
242 set_entity_ld_ident (entity *ent, ident *ld_ident) {
243 ent->ld_name = ld_ident;
247 get_entity_ld_name (entity *ent) {
248 return id_to_str(get_entity_ld_ident(ent));
252 char *get_entity_ld_name (entity *);
253 void set_entity_ld_name (entity *, char *ld_name);
257 get_entity_type (entity *ent) {
258 return ent->type = skip_tid(ent->type);
262 set_entity_type (entity *ent, type *type) {
267 INLINE ent_allocation
268 get_entity_allocation (entity *ent) {
269 return ent->allocation;
273 set_entity_allocation (entity *ent, ent_allocation al) {
274 ent->allocation = al;
278 INLINE ent_visibility
279 get_entity_visibility (entity *ent) {
280 return ent->visibility;
284 set_entity_visibility (entity *ent, ent_visibility vis) {
286 assert((ent->allocation == static_allocated) ||
287 (ent->allocation == automatic_allocated));
288 // @@@ Test that the owner type is not local, but how??
289 // && get_class_visibility(get_entity_owner(ent)) != local));
290 ent->visibility = vis;
293 INLINE ent_variability
294 get_entity_variability (entity *ent) {
295 return ent->variability;
299 set_entity_variability (entity *ent, ent_variability var){
300 if (var == part_constant)
301 assert(is_class_type(ent->type) || is_struct_type(ent->type));
302 if ((is_compound_type(ent->type)) &&
303 (ent->variability == uninitialized) && (var != uninitialized)) {
304 /* Allocate datastructures for constant values */
305 ent->values = NEW_ARR_F(ir_node *, 1);
306 ent->val_ents = NEW_ARR_F(entity *, 1);
308 if ((is_compound_type(ent->type)) &&
309 (var == uninitialized) && (ent->variability != uninitialized)) {
310 /* Free datastructures for constant values */
311 DEL_ARR_F(ent->values);
312 DEL_ARR_F(ent->val_ents);
314 ent->variability = var;
318 INLINE ent_volatility
319 get_entity_volatility (entity *ent) {
321 return ent->volatility;
325 set_entity_volatility (entity *ent, ent_volatility vol) {
327 ent->volatility = vol;
331 get_entity_peculiarity (entity *ent) {
333 return ent->peculiarity;
337 set_entity_peculiarity (entity *ent, peculiarity pec) {
339 /* @@@ why peculiarity only for methods? */
340 assert (is_method_type(ent->type));
341 ent->peculiarity = pec;
344 /* Set has no effect for entities of type method. */
346 get_atomic_ent_value(entity *ent) {
347 assert(ent); assert(is_atomic_entity(ent));
348 assert((ent->variability != uninitialized));
353 set_atomic_ent_value(entity *ent, ir_node *val) {
354 assert(ent && is_atomic_entity(ent) && (ent->variability != uninitialized));
355 if (is_method_type(ent->type)) return;
360 ir_node *copy_const_value(ir_node *n) {
365 switch(get_irn_opcode(n)) {
367 nn = new_Const(m, get_Const_tarval(n)); break;
369 nn = new_SymConst(get_SymConst_type_or_id(n), get_SymConst_kind(n)); break;
371 nn = new_Add(copy_const_value(get_Add_left(n)), copy_const_value(get_Add_right(n)), m); break;
373 assert(0 && "opdope invalid or not implemented"); break;
378 /* A value of a compound entity is a pair of value and the corresponding member of
381 add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
382 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
383 ARR_APP1 (ir_node *, ent->values, val);
384 ARR_APP1 (entity *, ent->val_ents, member);
387 /* Copies the firm subgraph referenced by val to const_code_irg and adds
388 the node as constant initialization to ent.
389 The subgraph may not contain control flow operations.
391 copy_and_add_compound_ent_value(entity *ent, ir_node *val, entity *member) {
392 ir_graph *rem = current_ir_graph;
394 assert(get_entity_variability(ent) != uninitialized);
395 current_ir_graph = get_const_code_irg();
397 val = copy_const_value(val);
398 add_compound_ent_value(ent, val, member);
399 current_ir_graph = rem;
403 get_compound_ent_n_values(entity *ent) {
404 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
405 return (ARR_LEN (ent->values))-1;
409 get_compound_ent_value(entity *ent, int pos) {
410 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
411 return ent->values[pos+1];
414 /* Copies the value i of the entity to current_block in current_ir_graph.
416 copy_compound_ent_value(entity *ent, int pos) {
417 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
418 return copy_const_value(ent->values[pos+1]);
422 get_compound_ent_value_member(entity *ent, int pos) {
423 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
424 return ent->val_ents[pos+1];
428 set_compound_ent_value(entity *ent, ir_node *val, entity *member, int pos) {
429 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
430 ent->values[pos+1] = val;
431 ent->val_ents[pos+1] = member;
435 remove_compound_ent_value(entity *ent, entity *value_ent) {
437 assert(ent && is_compound_entity(ent) && (ent->variability != uninitialized));
438 for (i = 1; i < (ARR_LEN (ent->val_ents)); i++) {
439 if (ent->val_ents[i] == value_ent) {
440 for(; i < (ARR_LEN (ent->val_ents))-1; i++) {
441 ent->val_ents[i] = ent->val_ents[i+1];
442 ent->values[i] = ent->values[i+1];
444 ARR_SETLEN(entity*, ent->val_ents, ARR_LEN(ent->val_ents) - 1);
445 ARR_SETLEN(ir_node*, ent->values, ARR_LEN(ent->values) - 1);
452 set_array_entity_values(entity *ent, tarval **values, int num_vals) {
454 ir_graph *rem = current_ir_graph;
455 type *arrtp = get_entity_type(ent);
458 assert(is_array_type(arrtp));
459 assert(get_array_n_dimensions(arrtp) == 1);
460 /* One bound is sufficient, the nunmber of constant fields makes the
462 assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
463 assert(get_entity_variability(ent) != uninitialized);
464 current_ir_graph = get_const_code_irg();
466 for (i = 0; i < num_vals; i++) {
467 val = new_Const(get_tv_mode (values[i]), values[i]);
468 add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
470 current_ir_graph = rem;
474 get_entity_offset (entity *ent) {
479 set_entity_offset (entity *ent, int offset) {
480 ent->offset = offset;
484 add_entity_overwrites (entity *ent, entity *overwritten) {
486 assert(is_class_type(get_entity_owner(ent)));
487 ARR_APP1 (entity *, ent->overwrites, overwritten);
488 ARR_APP1 (entity *, overwritten->overwrittenby, ent);
492 get_entity_n_overwrites (entity *ent) {
494 assert(is_class_type(get_entity_owner(ent)));
495 return (ARR_LEN (ent->overwrites))-1;
499 get_entity_overwrites_index(entity *ent, entity *overwritten) {
501 assert(ent && is_class_type(get_entity_owner(ent)));
502 for (i = 0; i < get_entity_n_overwrites(ent); i++)
503 if (get_entity_overwrites(ent, i) == overwritten)
509 get_entity_overwrites (entity *ent, int pos) {
511 assert(is_class_type(get_entity_owner(ent)));
512 assert(pos < get_entity_n_overwrites(ent));
513 return ent->overwrites[pos+1];
517 set_entity_overwrites (entity *ent, int pos, entity *overwritten) {
519 assert(is_class_type(get_entity_owner(ent)));
520 assert(pos < get_entity_n_overwrites(ent));
521 ent->overwrites[pos+1] = overwritten;
525 remove_entity_overwrites(entity *ent, entity *overwritten) {
527 assert(ent && is_class_type(get_entity_owner(ent)));
528 for (i = 1; i < (ARR_LEN (ent->overwrites)); i++)
529 if (ent->overwrites[i] == overwritten) {
530 for(; i < (ARR_LEN (ent->overwrites))-1; i++)
531 ent->overwrites[i] = ent->overwrites[i+1];
532 ARR_SETLEN(entity*, ent->overwrites, ARR_LEN(ent->overwrites) - 1);
538 add_entity_overwrittenby (entity *ent, entity *overwrites) {
540 assert(is_class_type(get_entity_owner(ent)));
541 add_entity_overwrites(overwrites, ent);
545 get_entity_n_overwrittenby (entity *ent) {
547 assert(is_class_type(get_entity_owner(ent)));
548 return (ARR_LEN (ent->overwrittenby))-1;
552 get_entity_overwrittenby_index(entity *ent, entity *overwrites) {
554 assert(ent && is_class_type(get_entity_owner(ent)));
555 for (i = 0; i < get_entity_n_overwrittenby(ent); i++)
556 if (get_entity_overwrittenby(ent, i) == overwrites)
562 get_entity_overwrittenby (entity *ent, int pos) {
564 assert(is_class_type(get_entity_owner(ent)));
565 assert(pos < get_entity_n_overwrittenby(ent));
566 return ent->overwrittenby[pos+1];
570 set_entity_overwrittenby (entity *ent, int pos, entity *overwrites) {
572 assert(is_class_type(get_entity_owner(ent)));
573 assert(pos < get_entity_n_overwrittenby(ent));
574 ent->overwrittenby[pos+1] = overwrites;
577 void remove_entity_overwrittenby(entity *ent, entity *overwrites) {
579 assert(ent && is_class_type(get_entity_owner(ent)));
580 for (i = 1; i < (ARR_LEN (ent->overwrittenby)); i++)
581 if (ent->overwrittenby[i] == overwrites) {
582 for(; i < (ARR_LEN (ent->overwrittenby))-1; i++)
583 ent->overwrittenby[i] = ent->overwrittenby[i+1];
584 ARR_SETLEN(entity*, ent->overwrittenby, ARR_LEN(ent->overwrittenby) - 1);
589 /* A link to store intermediate information */
591 get_entity_link(entity *ent) {
597 set_entity_link(entity *ent, void *l) {
603 get_entity_irg(entity *ent) {
605 assert (is_method_type(ent->type));
610 set_entity_irg(entity *ent, ir_graph *irg) {
611 assert (ent && ent->type);
612 /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
613 * Methode selbst nicht mehr aufgerufen werden kann, die Entität
614 * aber erhalten bleiben soll. */
616 assert (is_method_type(ent->type));
617 assert (ent->peculiarity == existent);
621 int is_entity (void *thing) {
623 if (get_kind(thing) == k_entity)
629 int is_atomic_entity(entity *ent) {
630 type* t = get_entity_type(ent);
631 return (is_primitive_type(t) || is_pointer_type(t) ||
632 is_enumeration_type(t) || is_method_type(t));
635 int is_compound_entity(entity *ent) {
636 type* t = get_entity_type(ent);
637 return (is_class_type(t) || is_struct_type(t) ||
638 is_array_type(t) || is_union_type(t));
641 /* @@@ not implemnted!!! */
642 bool equal_entity(entity *ent1, entity *ent2) {
643 printf(" calling unimplemented equal entity!!! \n");
648 unsigned long get_entity_visited(entity *ent) {
652 void set_entity_visited(entity *ent, unsigned long num) {
656 /* Sets visited field in entity to entity_visited. */
657 void mark_entity_visited(entity *ent) {
659 ent->visit = type_visited;
663 INLINE bool entity_visited(entity *ent) {
664 return get_entity_visited(ent) >= type_visited;
666 INLINE bool entity_not_visited(entity *ent) {
667 return get_entity_visited(ent) < type_visited;