2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Representation of all program known entities.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
43 #include "irgraph_t.h"
44 #include "callgraph.h"
47 /*-----------------------------------------------------------------*/
49 /*-----------------------------------------------------------------*/
51 ir_entity *unknown_entity = NULL;
53 ir_entity *get_unknown_entity(void) { return unknown_entity; }
55 /** The name of the unknown entity. */
56 #define UNKNOWN_ENTITY_NAME "unknown_entity"
58 /*-----------------------------------------------------------------*/
60 /*-----------------------------------------------------------------*/
63 * Add an entity to it's already set owner type.
65 static inline void insert_entity_in_owner(ir_entity *ent) {
66 ir_type *owner = ent->owner;
67 switch (get_type_tpop_code(owner)) {
69 add_class_member(owner, ent);
72 add_struct_member(owner, ent);
75 add_union_member(owner, ent);
78 set_array_element_entity(owner, ent);
81 panic("Unsupported type kind");
83 } /* insert_entity_in_owner */
86 * Creates a new entity. This entity is NOT inserted in the owner type.
88 * @param db debug info for this entity
89 * @param owner the owner type of the new entity
90 * @param name the name of the new entity
91 * @param type the type of the new entity
93 * @return the new created entity
95 static inline ir_entity *
96 new_rd_entity(dbg_info *db, ir_type *owner, ident *name, ir_type *type)
101 assert(!id_contains_char(name, ' ') && "entity name should not contain spaces");
103 res = XMALLOCZ(ir_entity);
105 res->kind = k_entity;
111 res->allocation = allocation_automatic;
112 res->visibility = visibility_local;
113 res->volatility = volatility_non_volatile;
114 res->aligned = align_is_aligned;
115 res->stickyness = stickyness_unsticky;
116 res->peculiarity = peculiarity_existent;
117 res->usage = ir_usage_unknown;
119 res->compiler_gen = 0;
120 res->backend_marked = 0;
122 res->offset_bit_remainder = 0;
125 res->repr_class = NULL;
127 if (is_Method_type(type)) {
129 ir_mode *mode = is_Method_type(type) ? mode_P_code : mode_P_data;
131 rem = current_ir_graph;
132 current_ir_graph = get_const_code_irg();
133 res->value = new_SymConst(mode, sym, symconst_addr_ent);
134 current_ir_graph = rem;
135 res->allocation = allocation_static;
136 res->variability = variability_constant;
137 res->attr.mtd_attr.irg_add_properties = mtp_property_inherited;
138 res->attr.mtd_attr.vtable_number = VTABLE_NUM_NOT_SET;
139 res->attr.mtd_attr.param_access = NULL;
140 res->attr.mtd_attr.param_weight = NULL;
141 res->attr.mtd_attr.irg = NULL;
142 } else if (is_compound_type(type)) {
143 res->variability = variability_uninitialized;
145 res->attr.cmpd_attr.values = NULL;
146 res->attr.cmpd_attr.val_paths = NULL;
147 } else if (is_code_type(type)) {
148 res->attr.code_attr.label = (ir_label_t) -1;
150 res->variability = variability_uninitialized;
154 if (is_Class_type(owner)) {
155 res->overwrites = NEW_ARR_F(ir_entity *, 0);
156 res->overwrittenby = NEW_ARR_F(ir_entity *, 0);
158 res->overwrites = NULL;
159 res->overwrittenby = NULL;
163 res->nr = get_irp_new_node_nr();
164 #endif /* DEBUG_libfirm */
167 set_entity_dbg_info(res, db);
170 } /* new_rd_entity */
173 new_d_entity(ir_type *owner, ident *name, ir_type *type, dbg_info *db) {
176 assert(is_compound_type(owner));
177 res = new_rd_entity(db, owner, name, type);
178 /* Remember entity in it's owner. */
179 insert_entity_in_owner(res);
181 hook_new_entity(res);
186 new_entity(ir_type *owner, ident *name, ir_type *type) {
187 return new_d_entity(owner, name, type, NULL);
191 * Free entity attributes.
193 * @param ent the entity
195 static void free_entity_attrs(ir_entity *ent) {
197 if (get_type_tpop(get_entity_owner(ent)) == type_class) {
198 DEL_ARR_F(ent->overwrites); ent->overwrites = NULL;
199 DEL_ARR_F(ent->overwrittenby); ent->overwrittenby = NULL;
201 assert(ent->overwrites == NULL);
202 assert(ent->overwrittenby == NULL);
204 if (is_compound_entity(ent)) {
205 if (ent->has_initializer) {
206 /* TODO: free initializers */
208 if (ent->attr.cmpd_attr.val_paths) {
209 for (i = get_compound_ent_n_values(ent) - 1; i >= 0; --i)
210 if (ent->attr.cmpd_attr.val_paths[i]) {
211 /* free_compound_graph_path(ent->attr.cmpd_attr.val_paths[i]) ; * @@@ warum nich? */
212 /* Geht nich: wird mehrfach verwendet!!! ==> mehrfach frei gegeben. */
213 /* DEL_ARR_F(ent->attr.cmpd_attr.val_paths); */
215 ent->attr.cmpd_attr.val_paths = NULL;
217 if (ent->attr.cmpd_attr.values) {
218 /*DEL_ARR_F(ent->attr.cmpd_attr.values)*/;
220 ent->attr.cmpd_attr.values = NULL;
222 } else if (is_method_entity(ent)) {
223 if (ent->attr.mtd_attr.param_access) {
224 DEL_ARR_F(ent->attr.mtd_attr.param_access);
225 ent->attr.mtd_attr.param_access = NULL;
227 if (ent->attr.mtd_attr.param_weight) {
228 DEL_ARR_F(ent->attr.mtd_attr.param_weight);
229 ent->attr.mtd_attr.param_weight = NULL;
232 } /* free_entity_attrs */
235 * Creates a deep copy of an entity.
237 static ir_entity *deep_entity_copy(ir_entity *old)
239 ir_entity *newe = XMALLOC(ir_entity);
242 if (is_compound_entity(old)) {
243 if (old->has_initializer) {
244 /* FIXME: the initializers are NOT copied */
246 newe->attr.cmpd_attr.values = NULL;
247 newe->attr.cmpd_attr.val_paths = NULL;
248 if (old->attr.cmpd_attr.values)
249 newe->attr.cmpd_attr.values = DUP_ARR_F(ir_node *, old->attr.cmpd_attr.values);
251 /* FIXME: the compound graph paths are NOT copied */
252 if (old->attr.cmpd_attr.val_paths)
253 newe->attr.cmpd_attr.val_paths = DUP_ARR_F(compound_graph_path *, old->attr.cmpd_attr.val_paths);
255 } else if (is_method_entity(old)) {
256 /* do NOT copy them, reanalyze. This might be the best solution */
257 newe->attr.mtd_attr.param_access = NULL;
258 newe->attr.mtd_attr.param_weight = NULL;
262 newe->nr = get_irp_new_node_nr();
267 * Copies the entity if the new_owner is different from the
268 * owner of the old entity, else returns the old entity.
271 copy_entity_own(ir_entity *old, ir_type *new_owner) {
273 assert(is_entity(old));
274 assert(is_compound_type(new_owner));
275 assert(get_type_state(new_owner) != layout_fixed);
277 if (old->owner == new_owner)
280 /* create a deep copy so we are safe of aliasing and double-freeing. */
281 newe = deep_entity_copy(old);
282 newe->owner = new_owner;
284 if (is_Class_type(new_owner)) {
285 newe->overwrites = NEW_ARR_F(ir_entity *, 0);
286 newe->overwrittenby = NEW_ARR_F(ir_entity *, 0);
289 insert_entity_in_owner(newe);
291 } /* copy_entity_own */
294 copy_entity_name(ir_entity *old, ident *new_name) {
296 assert(old && old->kind == k_entity);
298 if (old->name == new_name) return old;
299 newe = deep_entity_copy(old);
300 newe->name = new_name;
301 newe->ld_name = NULL;
303 if (is_Class_type(newe->owner)) {
304 newe->overwrites = DUP_ARR_F(ir_entity *, old->overwrites);
305 newe->overwrittenby = DUP_ARR_F(ir_entity *, old->overwrittenby);
307 insert_entity_in_owner(newe);
310 } /* copy_entity_name */
313 free_entity(ir_entity *ent) {
314 assert(ent && ent->kind == k_entity);
315 free_entity_attrs(ent);
320 /* Outputs a unique number for this node */
322 get_entity_nr(const ir_entity *ent) {
323 assert(ent && ent->kind == k_entity);
327 return (long)PTR_TO_INT(ent);
329 } /* get_entity_nr */
332 (get_entity_name)(const ir_entity *ent) {
333 return _get_entity_name(ent);
334 } /* get_entity_name */
337 (get_entity_ident)(const ir_entity *ent) {
338 return _get_entity_ident(ent);
339 } /* get_entity_ident */
342 (set_entity_ident)(ir_entity *ent, ident *id) {
343 _set_entity_ident(ent, id);
344 } /* set_entity_ident */
347 (get_entity_owner)(ir_entity *ent) {
348 return _get_entity_owner(ent);
349 } /* get_entity_owner */
352 set_entity_owner(ir_entity *ent, ir_type *owner) {
353 assert(is_entity(ent));
354 assert(is_compound_type(owner));
356 } /* set_entity_owner */
359 (get_entity_ld_ident)(ir_entity *ent) {
360 return _get_entity_ld_ident(ent);
361 } /* get_entity_ld_ident */
364 (set_entity_ld_ident)(ir_entity *ent, ident *ld_ident) {
365 _set_entity_ld_ident(ent, ld_ident);
366 } /* set_entity_ld_ident */
369 (get_entity_ld_name)(ir_entity *ent) {
370 return _get_entity_ld_name(ent);
371 } /* get_entity_ld_name */
374 (get_entity_type)(ir_entity *ent) {
375 return _get_entity_type(ent);
376 } /* get_entity_type */
379 (set_entity_type)(ir_entity *ent, ir_type *type) {
380 _set_entity_type(ent, type);
381 } /* set_entity_type */
384 (get_entity_allocation)(const ir_entity *ent) {
385 return _get_entity_allocation(ent);
386 } /* get_entity_allocation */
389 (set_entity_allocation)(ir_entity *ent, ir_allocation al) {
390 _set_entity_allocation(ent, al);
391 } /* set_entity_allocation */
393 /* return the name of the visibility */
394 const char *get_allocation_name(ir_allocation al)
396 #define X(a) case a: return #a
398 X(allocation_automatic);
399 X(allocation_parameter);
400 X(allocation_dynamic);
401 X(allocation_static);
402 default: return "BAD VALUE";
405 } /* get_allocation_name */
408 (get_entity_visibility)(const ir_entity *ent) {
409 return _get_entity_visibility(ent);
410 } /* get_entity_visibility */
413 set_entity_visibility(ir_entity *ent, ir_visibility vis) {
414 assert(ent && ent->kind == k_entity);
415 if (vis != visibility_local)
416 assert((ent->allocation == allocation_static) ||
417 (ent->allocation == allocation_automatic));
418 /* @@@ Test that the owner type is not local, but how??
419 && get_class_visibility(get_entity_owner(ent)) != local));*/
420 ent->visibility = vis;
421 } /* set_entity_visibility */
423 /* return the name of the visibility */
424 const char *get_visibility_name(ir_visibility vis)
426 #define X(a) case a: return #a
429 X(visibility_external_visible);
430 X(visibility_external_allocated);
431 default: return "BAD VALUE";
434 } /* get_visibility_name */
437 (get_entity_variability)(const ir_entity *ent) {
438 return _get_entity_variability(ent);
439 } /* get_entity_variability */
442 set_entity_variability(ir_entity *ent, ir_variability var)
444 assert(ent && ent->kind == k_entity);
445 if (var == variability_part_constant)
446 assert(is_Class_type(ent->type) || is_Struct_type(ent->type));
448 if ((is_compound_type(ent->type)) &&
449 (ent->variability == variability_uninitialized) && (var != variability_uninitialized)) {
450 /* Allocate data structures for constant values */
451 ent->attr.cmpd_attr.values = NEW_ARR_F(ir_node *, 0);
452 ent->attr.cmpd_attr.val_paths = NEW_ARR_F(compound_graph_path *, 0);
454 if ((is_atomic_type(ent->type)) &&
455 (ent->variability == variability_uninitialized) && (var != variability_uninitialized)) {
456 /* Set default constant value. */
457 ent->value = new_r_Unknown(get_const_code_irg(), get_type_mode(ent->type));
460 if ((is_compound_type(ent->type)) &&
461 (var == variability_uninitialized) && (ent->variability != variability_uninitialized)) {
462 /* Free data structures for constant values */
463 DEL_ARR_F(ent->attr.cmpd_attr.values); ent->attr.cmpd_attr.values = NULL;
464 DEL_ARR_F(ent->attr.cmpd_attr.val_paths); ent->attr.cmpd_attr.val_paths = NULL;
466 ent->variability = var;
467 } /* set_entity_variability */
469 /* return the name of the variability */
470 const char *get_variability_name(ir_variability var)
472 #define X(a) case a: return #a
474 X(variability_uninitialized);
475 X(variability_initialized);
476 X(variability_part_constant);
477 X(variability_constant);
478 default: return "BAD VALUE";
481 } /* get_variability_name */
484 (get_entity_volatility)(const ir_entity *ent) {
485 return _get_entity_volatility(ent);
486 } /* get_entity_volatility */
489 (set_entity_volatility)(ir_entity *ent, ir_volatility vol) {
490 _set_entity_volatility(ent, vol);
491 } /* set_entity_volatility */
493 /* Return the name of the volatility. */
494 const char *get_volatility_name(ir_volatility var)
496 #define X(a) case a: return #a
498 X(volatility_non_volatile);
499 X(volatility_is_volatile);
500 default: return "BAD VALUE";
503 } /* get_volatility_name */
506 (get_entity_aligned)(const ir_entity *ent) {
507 return _get_entity_aligned(ent);
511 (set_entity_aligned)(ir_entity *ent, ir_align a) {
512 _set_entity_aligned(ent, a);
516 (get_entity_alignment)(const ir_entity *ent) {
517 return _get_entity_alignment(ent);
521 (set_entity_alignment)(ir_entity *ent, unsigned alignment) {
522 _set_entity_alignment(ent, alignment);
525 /* Return the name of the alignment. */
526 const char *get_align_name(ir_align a)
528 #define X(a) case a: return #a
530 X(align_non_aligned);
532 default: return "BAD VALUE";
535 } /* get_align_name */
538 set_entity_label(ir_entity *ent, ir_label_t label)
540 ent->attr.code_attr.label = label;
543 ir_label_t get_entity_label(const ir_entity *ent)
545 return ent->attr.code_attr.label;
549 (get_entity_peculiarity)(const ir_entity *ent) {
550 return _get_entity_peculiarity(ent);
551 } /* get_entity_peculiarity */
554 (set_entity_peculiarity)(ir_entity *ent, ir_peculiarity pec) {
555 _set_entity_peculiarity(ent, pec);
556 } /* set_entity_peculiarity */
558 /* Checks if an entity cannot be overridden anymore. */
559 int (is_entity_final)(const ir_entity *ent) {
560 return _is_entity_final(ent);
561 } /* is_entity_final */
563 /* Sets/resets the final flag of an entity. */
564 void (set_entity_final)(ir_entity *ent, int final) {
565 _set_entity_final(ent, final);
566 } /* set_entity_final */
568 /* Checks if an entity is compiler generated */
569 int (is_entity_compiler_generated)(const ir_entity *ent) {
570 return _is_entity_compiler_generated(ent);
571 } /* is_entity_compiler_generated */
573 /* Sets/resets the compiler generated flag */
574 void (set_entity_compiler_generated)(ir_entity *ent, int flag) {
575 _set_entity_compiler_generated(ent, flag);
576 } /* set_entity_compiler_generated */
578 /* Checks if an entity is marked by the backend */
579 int (is_entity_backend_marked)(const ir_entity *ent) {
580 return _is_entity_backend_marked(ent);
581 } /* is_entity_backend_marked */
583 /* Sets/resets the compiler generated flag */
584 void (set_entity_backend_marked)(ir_entity *ent, int flag) {
585 _set_entity_backend_marked(ent, flag);
586 } /* set_entity_backend_marked */
588 ir_entity_usage (get_entity_usage)(const ir_entity *ent) {
589 return _get_entity_usage(ent);
592 void (set_entity_usage)(ir_entity *ent, ir_entity_usage flags) {
593 _set_entity_usage(ent, flags);
596 /* Get the entity's stickyness */
598 (get_entity_stickyness)(const ir_entity *ent) {
599 return _get_entity_stickyness(ent);
600 } /* get_entity_stickyness */
602 /* Set the entity's stickyness */
604 (set_entity_stickyness)(ir_entity *ent, ir_stickyness stickyness) {
605 _set_entity_stickyness(ent, stickyness);
606 } /* set_entity_stickyness */
608 /* Set has no effect for existent entities of type method. */
610 get_atomic_ent_value(ir_entity *ent)
612 assert(ent && is_atomic_entity(ent));
613 assert(ent->variability != variability_uninitialized);
614 return skip_Id(ent->value);
615 } /* get_atomic_ent_value */
618 set_atomic_ent_value(ir_entity *ent, ir_node *val) {
619 assert(is_atomic_entity(ent) && (ent->variability != variability_uninitialized));
620 if (is_Method_type(ent->type) && (ent->peculiarity == peculiarity_existent))
622 assert(is_Dummy(val) || get_irn_mode(val) == get_type_mode(ent->type));
624 } /* set_atomic_ent_value */
626 /* Returns true if the the node is representable as code on
628 int is_irn_const_expression(ir_node *n) {
631 /* we are in danger iff an exception will arise. TODO: be more precisely,
632 * for instance Div. will NOT rise if divisor != 0
634 if (is_binop(n) && !is_fragile_op(n))
635 return is_irn_const_expression(get_binop_left(n)) && is_irn_const_expression(get_binop_right(n));
638 switch (get_irn_opcode(n)) {
645 return is_irn_const_expression(get_irn_n(n, 0));
650 } /* is_irn_const_expression */
653 * Copies a firm subgraph that complies to the restrictions for
654 * constant expressions to current_block in current_ir_graph.
656 ir_node *copy_const_value(dbg_info *dbg, ir_node *n) {
660 /* @@@ GL I think we should implement this using the routines from irgopt for
661 dead node elimination/inlineing. */
664 switch (get_irn_opcode(n)) {
666 nn = new_d_Const_type(dbg, get_Const_tarval(n), get_Const_type(n));
669 nn = new_d_SymConst_type(dbg, get_irn_mode(n), get_SymConst_symbol(n), get_SymConst_kind(n),
670 get_SymConst_value_type(n));
673 nn = new_d_Add(dbg, copy_const_value(dbg, get_Add_left(n)),
674 copy_const_value(dbg, get_Add_right(n)), m); break;
676 nn = new_d_Sub(dbg, copy_const_value(dbg, get_Sub_left(n)),
677 copy_const_value(dbg, get_Sub_right(n)), m); break;
679 nn = new_d_Mul(dbg, copy_const_value(dbg, get_Mul_left(n)),
680 copy_const_value(dbg, get_Mul_right(n)), m); break;
682 nn = new_d_And(dbg, copy_const_value(dbg, get_And_left(n)),
683 copy_const_value(dbg, get_And_right(n)), m); break;
685 nn = new_d_Or(dbg, copy_const_value(dbg, get_Or_left(n)),
686 copy_const_value(dbg, get_Or_right(n)), m); break;
688 nn = new_d_Eor(dbg, copy_const_value(dbg, get_Eor_left(n)),
689 copy_const_value(dbg, get_Eor_right(n)), m); break;
691 nn = new_d_Cast(dbg, copy_const_value(dbg, get_Cast_op(n)), get_Cast_type(n)); break;
693 nn = new_d_Conv(dbg, copy_const_value(dbg, get_Conv_op(n)), m); break;
695 nn = new_Unknown(m); break;
697 assert(0 && "opcode invalid or not implemented");
702 } /* copy_const_value */
704 /** Return the name of the initializer kind. */
705 const char *get_initializer_kind_name(ir_initializer_kind_t ini)
707 #define X(a) case a: return #a
709 X(IR_INITIALIZER_CONST);
710 X(IR_INITIALIZER_TARVAL);
711 X(IR_INITIALIZER_NULL);
712 X(IR_INITIALIZER_COMPOUND);
713 default: return "BAD VALUE";
718 static ir_initializer_t null_initializer = { IR_INITIALIZER_NULL };
720 ir_initializer_t *get_initializer_null(void)
722 return &null_initializer;
725 ir_initializer_t *create_initializer_const(ir_node *value)
727 struct obstack *obst = get_irg_obstack(get_const_code_irg());
729 ir_initializer_t *initializer
730 = obstack_alloc(obst, sizeof(ir_initializer_const_t));
731 initializer->kind = IR_INITIALIZER_CONST;
732 initializer->consti.value = value;
737 ir_initializer_t *create_initializer_tarval(tarval *tv)
739 struct obstack *obst = get_irg_obstack(get_const_code_irg());
741 ir_initializer_t *initializer
742 = obstack_alloc(obst, sizeof(ir_initializer_tarval_t));
743 initializer->kind = IR_INITIALIZER_TARVAL;
744 initializer->tarval.value = tv;
749 ir_initializer_t *create_initializer_compound(unsigned n_entries)
751 struct obstack *obst = get_irg_obstack(get_const_code_irg());
754 size_t size = sizeof(ir_initializer_compound_t)
755 + (n_entries-1) * sizeof(ir_initializer_t*);
757 ir_initializer_t *initializer = obstack_alloc(obst, size);
758 initializer->kind = IR_INITIALIZER_COMPOUND;
759 initializer->compound.n_initializers = n_entries;
761 for(i = 0; i < n_entries; ++i) {
762 initializer->compound.initializers[i] = get_initializer_null();
768 ir_node *get_initializer_const_value(const ir_initializer_t *initializer)
770 assert(initializer->kind == IR_INITIALIZER_CONST);
771 return skip_Id(initializer->consti.value);
774 tarval *get_initializer_tarval_value(const ir_initializer_t *initializer)
776 assert(initializer->kind == IR_INITIALIZER_TARVAL);
777 return initializer->tarval.value;
780 unsigned get_initializer_compound_n_entries(const ir_initializer_t *initializer)
782 assert(initializer->kind == IR_INITIALIZER_COMPOUND);
783 return initializer->compound.n_initializers;
786 void set_initializer_compound_value(ir_initializer_t *initializer,
787 unsigned index, ir_initializer_t *value)
789 assert(initializer->kind == IR_INITIALIZER_COMPOUND);
790 assert(index < initializer->compound.n_initializers);
792 initializer->compound.initializers[index] = value;
795 ir_initializer_t *get_initializer_compound_value(
796 const ir_initializer_t *initializer, unsigned index)
798 assert(initializer->kind == IR_INITIALIZER_COMPOUND);
799 assert(index < initializer->compound.n_initializers);
801 return initializer->compound.initializers[index];
804 ir_initializer_kind_t get_initializer_kind(const ir_initializer_t *initializer)
806 return initializer->kind;
809 static void check_entity_initializer(ir_entity *entity)
815 void set_entity_initializer(ir_entity *entity, ir_initializer_t *initializer)
817 entity->attr.initializer = initializer;
818 entity->has_initializer = 1;
819 check_entity_initializer(entity);
822 int has_entity_initializer(const ir_entity *entity)
824 return entity->has_initializer;
827 ir_initializer_t *get_entity_initializer(const ir_entity *entity)
829 assert(entity->has_initializer);
830 return entity->attr.initializer;
833 /* Creates a new compound graph path. */
834 compound_graph_path *
835 new_compound_graph_path(ir_type *tp, int length) {
836 compound_graph_path *res;
838 assert(is_compound_type(tp));
841 res = xmalloc(sizeof(*res) + (length-1) * sizeof(res->list[0]));
842 memset(res, 0, sizeof(*res) + (length-1) * sizeof(res->list[0]));
843 res->kind = k_ir_compound_graph_path;
848 } /* new_compound_graph_path */
850 /* Frees an graph path object */
851 void free_compound_graph_path (compound_graph_path *gr) {
852 assert(gr && is_compound_graph_path(gr));
855 } /* free_compound_graph_path */
857 /* Returns non-zero if an object is a compound graph path */
858 int is_compound_graph_path(const void *thing) {
859 return (get_kind(thing) == k_ir_compound_graph_path);
860 } /* is_compound_graph_path */
862 /* Checks whether the path up to pos is correct. If the path contains a NULL,
863 * assumes the path is not complete and returns 'true'. */
864 int is_proper_compound_graph_path(compound_graph_path *gr, int pos) {
867 ir_type *owner = gr->tp;
869 for (i = 0; i <= pos; i++) {
870 node = get_compound_graph_path_node(gr, i);
872 /* Path not yet complete. */
874 if (get_entity_owner(node) != owner)
876 owner = get_entity_type(node);
878 if (pos == get_compound_graph_path_length(gr))
879 if (!is_atomic_type(owner))
882 } /* is_proper_compound_graph_path */
884 /* Returns the length of a graph path */
885 int get_compound_graph_path_length(const compound_graph_path *gr) {
886 assert(gr && is_compound_graph_path(gr));
888 } /* get_compound_graph_path_length */
891 get_compound_graph_path_node(const compound_graph_path *gr, int pos) {
892 assert(gr && is_compound_graph_path(gr));
893 assert(pos >= 0 && pos < gr->len);
894 return gr->list[pos].node;
895 } /* get_compound_graph_path_node */
898 set_compound_graph_path_node(compound_graph_path *gr, int pos, ir_entity *node) {
899 assert(gr && is_compound_graph_path(gr));
900 assert(pos >= 0 && pos < gr->len);
901 assert(is_entity(node));
902 gr->list[pos].node = node;
903 assert(is_proper_compound_graph_path(gr, pos));
904 } /* set_compound_graph_path_node */
907 get_compound_graph_path_array_index(const compound_graph_path *gr, int pos) {
908 assert(gr && is_compound_graph_path(gr));
909 assert(pos >= 0 && pos < gr->len);
910 return gr->list[pos].index;
911 } /* get_compound_graph_path_array_index */
914 set_compound_graph_path_array_index(compound_graph_path *gr, int pos, int index) {
915 assert(gr && is_compound_graph_path(gr));
916 assert(pos >= 0 && pos < gr->len);
917 gr->list[pos].index = index;
918 } /* set_compound_graph_path_array_index */
921 get_compound_graph_path_type(const compound_graph_path *gr) {
922 assert(gr && is_compound_graph_path(gr));
926 /* A value of a compound entity is a pair of value and the corresponding path to a member of
929 add_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path) {
930 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
931 assert(is_compound_graph_path(path));
932 ARR_APP1(ir_node *, ent->attr.cmpd_attr.values, val);
933 ARR_APP1(compound_graph_path *, ent->attr.cmpd_attr.val_paths, path);
934 } /* add_compound_ent_value_w_path */
937 set_compound_ent_value_w_path(ir_entity *ent, ir_node *val, compound_graph_path *path, int pos) {
938 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
939 assert(is_compound_graph_path(path));
940 assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.values));
941 ent->attr.cmpd_attr.values[pos] = val;
942 ent->attr.cmpd_attr.val_paths[pos] = path;
943 } /* set_compound_ent_value_w_path */
946 get_compound_ent_n_values(ir_entity *ent) {
947 assert(!ent->has_initializer);
948 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
949 return ARR_LEN(ent->attr.cmpd_attr.values);
950 } /* get_compound_ent_n_values */
953 get_compound_ent_value(ir_entity *ent, int pos) {
954 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
955 assert(!ent->has_initializer);
956 assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.values));
957 return skip_Id(ent->attr.cmpd_attr.values[pos]);
958 } /* get_compound_ent_value */
960 compound_graph_path *
961 get_compound_ent_value_path(ir_entity *ent, int pos) {
962 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
963 assert(!ent->has_initializer);
964 assert(0 <= pos && pos < ARR_LEN(ent->attr.cmpd_attr.val_paths));
965 return ent->attr.cmpd_attr.val_paths[pos];
966 } /* get_compound_ent_value_path */
969 * Returns non-zero, if two compound_graph_pathes are equal
971 * @param path1 the first path
972 * @param path2 the second path
974 static int equal_paths(compound_graph_path *path1, compound_graph_path *path2) {
976 int len1 = get_compound_graph_path_length(path1);
977 int len2 = get_compound_graph_path_length(path2);
979 if (len2 != len1) return 0;
981 for (i = 0; i < len1; i++) {
983 ir_entity *node1 = get_compound_graph_path_node(path1, i);
984 ir_entity *node2 = get_compound_graph_path_node(path2, i);
986 if (node1 != node2) return 0;
988 tp = get_entity_owner(node1);
989 if (is_Array_type(tp)) {
990 int index1 = get_compound_graph_path_array_index(path1, i);
991 int index2 = get_compound_graph_path_array_index(path2, i);
992 if (index1 != index2)
1000 * Returns the position of a value with the given path.
1001 * The path must contain array indices for all array element entities.
1003 * @todo This implementation is very slow (O(number of initializers * |path|)
1004 * and should be replaced when the new tree oriented
1005 * value representation is finally implemented.
1007 static int get_compound_ent_pos_by_path(ir_entity *ent, compound_graph_path *path) {
1008 int i, n_paths = get_compound_ent_n_values(ent);
1010 for (i = 0; i < n_paths; i ++) {
1011 compound_graph_path *gr = get_compound_ent_value_path(ent, i);
1012 if (equal_paths(gr, path))
1016 } /* get_compound_ent_pos_by_path */
1018 /* Returns a constant value given the access path.
1019 * The path must contain array indices for all array element entities. */
1020 ir_node *get_compound_ent_value_by_path(ir_entity *ent, compound_graph_path *path) {
1021 int pos = get_compound_ent_pos_by_path(ent, path);
1023 return get_compound_ent_value(ent, pos);
1025 } /* get_compound_ent_value_by_path */
1029 remove_compound_ent_value(ir_entity *ent, ir_entity *value_ent) {
1031 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1033 n = ARR_LEN(ent->attr.cmpd_attr.val_paths);
1034 for (i = 0; i < n; ++i) {
1035 compound_graph_path *path = ent->attr.cmpd_attr.val_paths[i];
1036 if (path->list[path->len-1].node == value_ent) {
1037 for (; i < n - 1; ++i) {
1038 ent->attr.cmpd_attr.val_paths[i] = ent->attr.cmpd_attr.val_paths[i+1];
1039 ent->attr.cmpd_attr.values[i] = ent->attr.cmpd_attr.values[i+1];
1041 ARR_SETLEN(ir_entity*, ent->attr.cmpd_attr.val_paths, n - 1);
1042 ARR_SETLEN(ir_node*, ent->attr.cmpd_attr.values, n - 1);
1046 } /* remove_compound_ent_value */
1049 add_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member) {
1050 compound_graph_path *path;
1051 ir_type *owner_tp = get_entity_owner(member);
1052 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1053 path = new_compound_graph_path(get_entity_type(ent), 1);
1054 path->list[0].node = member;
1055 if (is_Array_type(owner_tp)) {
1059 assert(get_array_n_dimensions(owner_tp) == 1 && has_array_lower_bound(owner_tp, 0));
1060 max = get_array_lower_bound_int(owner_tp, 0) -1;
1061 for (i = 0, n = get_compound_ent_n_values(ent); i < n; ++i) {
1062 int index = get_compound_graph_path_array_index(get_compound_ent_value_path(ent, i), 0);
1067 path->list[0].index = max + 1;
1069 add_compound_ent_value_w_path(ent, val, path);
1070 } /* add_compound_ent_value */
1074 get_compound_ent_value_member(ir_entity *ent, int pos) {
1075 compound_graph_path *path;
1076 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1077 path = get_compound_ent_value_path(ent, pos);
1079 return get_compound_graph_path_node(path, get_compound_graph_path_length(path)-1);
1080 } /* get_compound_ent_value_member */
1083 set_compound_ent_value(ir_entity *ent, ir_node *val, ir_entity *member, int pos) {
1084 compound_graph_path *path;
1085 assert(is_compound_entity(ent) && (ent->variability != variability_uninitialized));
1086 path = get_compound_ent_value_path(ent, pos);
1087 set_compound_graph_path_node(path, 0, member);
1088 set_compound_ent_value_w_path(ent, val, path, pos);
1089 } /* set_compound_ent_value */
1092 set_array_entity_values(ir_entity *ent, tarval **values, int num_vals) {
1094 ir_graph *rem = current_ir_graph;
1095 ir_type *arrtp = get_entity_type(ent);
1097 ir_type *elttp = get_array_element_type(arrtp);
1099 assert(is_Array_type(arrtp));
1100 assert(get_array_n_dimensions(arrtp) == 1);
1101 /* One bound is sufficient, the number of constant fields makes the
1103 assert(get_array_lower_bound (arrtp, 0) || get_array_upper_bound (arrtp, 0));
1104 assert(get_entity_variability(ent) != variability_uninitialized);
1105 current_ir_graph = get_const_code_irg();
1107 for (i = 0; i < num_vals; i++) {
1108 val = new_Const_type(values[i], elttp);
1109 add_compound_ent_value(ent, val, get_array_element_entity(arrtp));
1110 set_compound_graph_path_array_index(get_compound_ent_value_path(ent, i), 0, i);
1112 current_ir_graph = rem;
1113 } /* set_array_entity_values */
1115 /* Return the overall offset of value at position pos in bytes. */
1116 unsigned get_compound_ent_value_offset_bytes(ir_entity *ent, int pos) {
1117 compound_graph_path *path;
1119 unsigned offset = 0;
1122 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
1124 path = get_compound_ent_value_path(ent, pos);
1125 path_len = get_compound_graph_path_length(path);
1128 for (i = 0; i < path_len; ++i) {
1129 if (is_Array_type(curr_tp)) {
1130 ir_type *elem_type = get_array_element_type(curr_tp);
1131 unsigned size = get_type_size_bytes(elem_type);
1132 unsigned align = get_type_alignment_bytes(elem_type);
1136 if(size % align > 0) {
1137 size += align - (size % align);
1139 idx = get_compound_graph_path_array_index(path, i);
1141 offset += size * idx;
1142 curr_tp = elem_type;
1144 ir_entity *node = get_compound_graph_path_node(path, i);
1145 offset += get_entity_offset(node);
1146 curr_tp = get_entity_type(node);
1151 } /* get_compound_ent_value_offset_bytes */
1153 /* Return the offset in bits from the last byte address. */
1154 unsigned get_compound_ent_value_offset_bit_remainder(ir_entity *ent, int pos) {
1155 compound_graph_path *path;
1157 ir_entity *last_node;
1159 assert(get_type_state(get_entity_type(ent)) == layout_fixed);
1161 path = get_compound_ent_value_path(ent, pos);
1162 path_len = get_compound_graph_path_length(path);
1163 last_node = get_compound_graph_path_node(path, path_len - 1);
1165 if(last_node == NULL)
1168 return get_entity_offset_bits_remainder(last_node);
1169 } /* get_compound_ent_value_offset_bit_remainder */
1172 (get_entity_offset)(const ir_entity *ent) {
1173 return _get_entity_offset(ent);
1174 } /* get_entity_offset */
1177 (set_entity_offset)(ir_entity *ent, int offset) {
1178 _set_entity_offset(ent, offset);
1179 } /* set_entity_offset */
1182 (get_entity_offset_bits_remainder)(const ir_entity *ent) {
1183 return _get_entity_offset_bits_remainder(ent);
1184 } /* get_entity_offset_bits_remainder */
1187 (set_entity_offset_bits_remainder)(ir_entity *ent, unsigned char offset) {
1188 _set_entity_offset_bits_remainder(ent, offset);
1189 } /* set_entity_offset_bits_remainder */
1192 add_entity_overwrites(ir_entity *ent, ir_entity *overwritten) {
1194 ir_type *owner = get_entity_owner(ent);
1195 ir_type *ovw_ovner = get_entity_owner(overwritten);
1196 assert(is_Class_type(owner));
1197 assert(is_Class_type(ovw_ovner));
1198 assert(! is_class_final(ovw_ovner));
1200 ARR_APP1(ir_entity *, ent->overwrites, overwritten);
1201 ARR_APP1(ir_entity *, overwritten->overwrittenby, ent);
1202 } /* add_entity_overwrites */
1205 get_entity_n_overwrites(ir_entity *ent) {
1206 assert(is_Class_type(get_entity_owner(ent)));
1207 return (ARR_LEN(ent->overwrites));
1208 } /* get_entity_n_overwrites */
1211 get_entity_overwrites_index(ir_entity *ent, ir_entity *overwritten) {
1213 assert(is_Class_type(get_entity_owner(ent)));
1214 n = get_entity_n_overwrites(ent);
1215 for (i = 0; i < n; ++i) {
1216 if (get_entity_overwrites(ent, i) == overwritten)
1220 } /* get_entity_overwrites_index */
1223 get_entity_overwrites(ir_entity *ent, int pos) {
1224 assert(is_Class_type(get_entity_owner(ent)));
1225 assert(pos < get_entity_n_overwrites(ent));
1226 return ent->overwrites[pos];
1227 } /* get_entity_overwrites */
1230 set_entity_overwrites(ir_entity *ent, int pos, ir_entity *overwritten) {
1231 assert(is_Class_type(get_entity_owner(ent)));
1232 assert(pos < get_entity_n_overwrites(ent));
1233 ent->overwrites[pos] = overwritten;
1234 } /* set_entity_overwrites */
1237 remove_entity_overwrites(ir_entity *ent, ir_entity *overwritten) {
1239 assert(is_Class_type(get_entity_owner(ent)));
1240 n = ARR_LEN(ent->overwrites);
1241 for (i = 0; i < n; ++i) {
1242 if (ent->overwrites[i] == overwritten) {
1243 for (; i < n - 1; i++)
1244 ent->overwrites[i] = ent->overwrites[i+1];
1245 ARR_SETLEN(ir_entity*, ent->overwrites, n - 1);
1249 } /* remove_entity_overwrites */
1252 add_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites) {
1253 add_entity_overwrites(overwrites, ent);
1254 } /* add_entity_overwrittenby */
1257 get_entity_n_overwrittenby(ir_entity *ent) {
1258 assert(is_Class_type(get_entity_owner(ent)));
1259 return ARR_LEN(ent->overwrittenby);
1260 } /* get_entity_n_overwrittenby */
1263 get_entity_overwrittenby_index(ir_entity *ent, ir_entity *overwrites) {
1265 assert(is_Class_type(get_entity_owner(ent)));
1266 n = get_entity_n_overwrittenby(ent);
1267 for (i = 0; i < n; ++i) {
1268 if (get_entity_overwrittenby(ent, i) == overwrites)
1272 } /* get_entity_overwrittenby_index */
1275 get_entity_overwrittenby(ir_entity *ent, int pos) {
1276 assert(is_Class_type(get_entity_owner(ent)));
1277 assert(pos < get_entity_n_overwrittenby(ent));
1278 return ent->overwrittenby[pos];
1279 } /* get_entity_overwrittenby */
1282 set_entity_overwrittenby(ir_entity *ent, int pos, ir_entity *overwrites) {
1283 assert(is_Class_type(get_entity_owner(ent)));
1284 assert(pos < get_entity_n_overwrittenby(ent));
1285 ent->overwrittenby[pos] = overwrites;
1286 } /* set_entity_overwrittenby */
1288 void remove_entity_overwrittenby(ir_entity *ent, ir_entity *overwrites) {
1290 assert(is_Class_type(get_entity_owner(ent)));
1292 n = ARR_LEN(ent->overwrittenby);
1293 for (i = 0; i < n; ++i) {
1294 if (ent->overwrittenby[i] == overwrites) {
1295 for(; i < n - 1; ++i)
1296 ent->overwrittenby[i] = ent->overwrittenby[i+1];
1297 ARR_SETLEN(ir_entity*, ent->overwrittenby, n - 1);
1301 } /* remove_entity_overwrittenby */
1303 /* A link to store intermediate information */
1305 (get_entity_link)(const ir_entity *ent) {
1306 return _get_entity_link(ent);
1307 } /* get_entity_link */
1310 (set_entity_link)(ir_entity *ent, void *l) {
1311 _set_entity_link(ent, l);
1312 } /* set_entity_link */
1315 (get_entity_irg)(const ir_entity *ent) {
1316 return _get_entity_irg(ent);
1317 } /* get_entity_irg */
1320 set_entity_irg(ir_entity *ent, ir_graph *irg) {
1321 assert(is_method_entity(ent));
1322 /* Wie kann man die Referenz auf einen IRG löschen, z.B. wenn die
1323 * Methode selbst nicht mehr aufgerufen werden kann, die Entität
1324 * aber erhalten bleiben soll? Wandle die Entitaet in description oder
1327 assert((irg && ent->peculiarity == peculiarity_existent) ||
1328 (!irg && (ent->peculiarity == peculiarity_existent)
1329 && (ent -> visibility == visibility_external_allocated)) ||
1330 (!irg && ent->peculiarity == peculiarity_description) ||
1331 (!irg && ent->peculiarity == peculiarity_inherited));
1332 ent->attr.mtd_attr.irg = irg;
1333 } /* set_entity_irg */
1335 unsigned get_entity_vtable_number(const ir_entity *ent) {
1336 assert(is_method_entity((ir_entity *)ent));
1337 return ent->attr.mtd_attr.vtable_number;
1338 } /* get_entity_vtable_number */
1340 void set_entity_vtable_number(ir_entity *ent, unsigned vtable_number) {
1341 assert(is_method_entity(ent));
1342 ent->attr.mtd_attr.vtable_number = vtable_number;
1343 } /* set_entity_vtable_number */
1346 (is_entity)(const void *thing) {
1347 return _is_entity(thing);
1350 int is_atomic_entity(ir_entity *ent) {
1351 ir_type *t = get_entity_type(ent);
1352 const tp_op *op = get_type_tpop(t);
1353 return (op == type_primitive || op == type_pointer ||
1354 op == type_enumeration || op == type_method);
1355 } /* is_atomic_entity */
1357 int is_compound_entity(ir_entity *ent) {
1358 ir_type *t = get_entity_type(ent);
1359 const tp_op *op = get_type_tpop(t);
1360 return (op == type_class || op == type_struct ||
1361 op == type_array || op == type_union);
1362 } /* is_compound_entity */
1364 int is_method_entity(ir_entity *ent) {
1365 ir_type *t = get_entity_type(ent);
1366 return is_Method_type(t);
1367 } /* is_method_entity */
1370 * @todo not implemented!!! */
1371 int equal_entity(ir_entity *ent1, ir_entity *ent2) {
1374 fprintf(stderr, " calling unimplemented equal entity!!! \n");
1376 } /* equal_entity */
1379 ir_visited_t (get_entity_visited)(ir_entity *ent) {
1380 return _get_entity_visited(ent);
1381 } /* get_entity_visited */
1383 void (set_entity_visited)(ir_entity *ent, ir_visited_t num) {
1384 _set_entity_visited(ent, num);
1385 } /* set_entity_visited */
1387 /* Sets visited field in ir_entity to entity_visited. */
1388 void (mark_entity_visited)(ir_entity *ent) {
1389 _mark_entity_visited(ent);
1390 } /* mark_entity_visited */
1392 int (entity_visited)(ir_entity *ent) {
1393 return _entity_visited(ent);
1394 } /* entity_visited */
1396 int (entity_not_visited)(ir_entity *ent) {
1397 return _entity_not_visited(ent);
1398 } /* entity_not_visited */
1400 /* Returns the mask of the additional entity properties. */
1401 unsigned get_entity_additional_properties(ir_entity *ent) {
1404 assert(is_method_entity(ent));
1406 /* first check, if the graph has additional properties */
1407 irg = get_entity_irg(ent);
1410 return get_irg_additional_properties(irg);
1412 if (ent->attr.mtd_attr.irg_add_properties & mtp_property_inherited)
1413 return get_method_additional_properties(get_entity_type(ent));
1415 return ent->attr.mtd_attr.irg_add_properties;
1416 } /* get_entity_additional_properties */
1418 /* Sets the mask of the additional graph properties. */
1419 void set_entity_additional_properties(ir_entity *ent, unsigned property_mask)
1423 assert(is_method_entity(ent));
1425 /* first check, if the graph exists */
1426 irg = get_entity_irg(ent);
1428 set_irg_additional_properties(irg, property_mask);
1430 /* do not allow to set the mtp_property_inherited flag or
1431 * the automatic inheritance of flags will not work */
1432 ent->attr.mtd_attr.irg_add_properties = property_mask & ~mtp_property_inherited;
1434 } /* set_entity_additional_properties */
1436 /* Sets one additional graph property. */
1437 void set_entity_additional_property(ir_entity *ent, mtp_additional_property flag)
1441 assert(is_method_entity(ent));
1443 /* first check, if the graph exists */
1444 irg = get_entity_irg(ent);
1446 set_irg_additional_property(irg, flag);
1448 unsigned mask = ent->attr.mtd_attr.irg_add_properties;
1450 if (mask & mtp_property_inherited)
1451 mask = get_method_additional_properties(get_entity_type(ent));
1453 /* do not allow to set the mtp_property_inherited flag or
1454 * the automatic inheritance of flags will not work */
1455 ent->attr.mtd_attr.irg_add_properties = mask | (flag & ~mtp_property_inherited);
1457 } /* set_entity_additional_property */
1459 /* Returns the class type that this type info entity represents or NULL
1460 if ent is no type info entity. */
1461 ir_type *(get_entity_repr_class)(const ir_entity *ent) {
1462 return _get_entity_repr_class(ent);
1463 } /* get_entity_repr_class */
1465 dbg_info *(get_entity_dbg_info)(const ir_entity *ent) {
1466 return _get_entity_dbg_info(ent);
1467 } /* get_entity_dbg_info */
1469 void (set_entity_dbg_info)(ir_entity *ent, dbg_info *db) {
1470 _set_entity_dbg_info(ent, db);
1471 } /* set_entity_dbg_info */
1473 /* Initialize entity module. */
1474 void firm_init_entity(void)
1476 symconst_symbol sym;
1478 assert(firm_unknown_type && "Call init_type() before firm_init_entity()!");
1479 assert(!unknown_entity && "Call firm_init_entity() only once!");
1481 unknown_entity = new_rd_entity(NULL, firm_unknown_type, new_id_from_str(UNKNOWN_ENTITY_NAME), firm_unknown_type);
1482 set_entity_visibility(unknown_entity, visibility_external_allocated);
1483 set_entity_ld_ident(unknown_entity, get_entity_ident(unknown_entity));
1485 current_ir_graph = get_const_code_irg();
1486 sym.entity_p = unknown_entity;
1487 /* TODO: we need two unknown_entities here, one for code and one for data */
1488 unknown_entity->value = new_SymConst(mode_P_data, sym, symconst_addr_ent);
1489 } /* firm_init_entity */