2 * @file tr_inheritance.h
4 * Project: libFIRM <br>
5 * File name: ir/tr/tp_inheritance.h <br>
6 * Purpose: Utility routines for inheritance representation <br>
7 * Author: Goetz Lindenmaier <br>
10 * Copyright: (c) 2001-2005 Universität Karlsruhe <br>
11 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE. <br>
14 * This file supplies a set of utility routines for the inheritance
17 * Inheritance is represented in Firm by two relations: sub/supertype
18 * between class types, overwrites/ovwerwrittenby between entities.
20 * - Classify pairs of types/entities in the inheritance relations.
21 * - Resolve implicit inheritance.
22 * - Compute the transitive closure of the subclass/superclass and
23 * overwrites/overwrittenby relation.
25 * @see type.h entity.h
28 #ifndef _TR_INHERITANCE_H_
29 #define _TR_INHERITANCE_H_
31 #include "firm_types.h"
35 /* ----------------------------------------------------------------------- */
36 /* Classify pairs of types/entities in the inheritance relations. */
37 /* ----------------------------------------------------------------------- */
39 /** Returns true if low is subclass of high.
41 * Low is a subclass of high if low == high or if low is a subclass of
42 * a subclass of high. I.e, we search in all subtypes of high for low.
43 * @@@ this can be implemented more efficient if we know the set of all
44 * subclasses of high. */
45 int is_SubClass_of(type *low, type *high);
47 /** Subclass check for pointers to classes.
49 * Dereferences at both types the same amount of pointer types (as
50 * many as possible). If the remaining types are both class types
51 * and subclasses, returns true, else false. Can also be called with
53 int is_SubClass_ptr_of(type *low, type *high);
55 /** Returns true if high is superclass of low.
57 * Low is a subclass of high if low == high or if low is a subclass of
58 * a subclass of high. I.e, we search in all subtypes of high for low.
59 * @@@ this can be implemented more efficient if we know the set of all
60 * subclasses of high. */
61 #define is_SuperClass_of(high, low) is_SubClass_of(low, high)
63 /** Superclass check for pointers to classes.
65 * Dereferences at both types the same amount of pointer types (as
66 * many as possible). If the remaining types are both class types
67 * and superclasses, returns true, else false. Can also be called with
69 #define is_SuperClass_ptr_of(low, high) is_SubClass_ptr_of(high, low)
71 /** Returns true if high is (transitive) overwritten by low.
73 * Returns false if high == low. */
74 int is_overwritten_by(entity *high, entity *low);
76 /** Resolve polymorphism in the inheritance relation.
78 * Returns the dynamically referenced entity if the static entity and the
79 * dynamic type are given.
80 * Searches downwards in overwritten tree. */
81 entity *resolve_ent_polymorphy(type *dynamic_class, entity* static_ent);
83 /* ----------------------------------------------------------------------- */
84 /* Resolve implicit inheritance. */
85 /* ----------------------------------------------------------------------- */
87 /** Default name mangling for inherited entities.
89 * Returns an ident that consists of the name of type followed by an
90 * underscore and the name (not ld_name) of the entity. */
91 ident *default_mangle_inherited_name(entity *super, type *clss);
93 /** Type of argument functions for inheritance resolver.
95 * @param super The entity in the super type that will be overwritten
96 * by the newly generated entity, for which this name is
98 * @param clss The class type in which the new entity will be placed.
100 typedef ident *mangle_inherited_name_func(entity *super, type *clss);
102 /** Resolve implicit inheritance.
104 * Resolves the implicit inheritance supplied by firm. Firm defines,
105 * that each entity that is not overwritten in a subclass is
106 * inherited to this subclass without change implicitly. This
107 * function generates entities that explicitly represent this
108 * inheritance. It generates for each entity overwriting entities in
109 * all subclasses of the owner of the entity, if the entity is not
110 * overwritten in that subclass.
112 * The name of the new entity is generated with the function passed.
113 * If the function is NULL, the default_mangle_inherited_name() is
116 * This function was moved here from firmlower 3/2005.
118 void resolve_inheritance(mangle_inherited_name_func *mfunc);
121 /* ----------------------------------------------------------------------- */
122 /* The transitive closure of the subclass/superclass and */
123 /* overwrites/overwrittenby relation. */
125 /* A walk over the ir (O(#types+#entities)) computes the transitive */
126 /* closure. Adding a new type/entity or changing the basic relations in */
127 /* some other way invalidates the transitive closure, i.e., it is not */
128 /* updated by the basic functions. */
130 /* The transitive edges are held in a set, not in an array as the */
131 /* underlying relation. */
133 /* Do the sets contain the node itself? I assume NOT! */
134 /* ----------------------------------------------------------------------- */
136 /** The state of the transitive closure.
138 * @todo: we could manage the state for each relation separately. Invalidating
139 * the entity relations does not mean invalidating the class relation. */
141 inh_transitive_closure_none, /**< Closure is not computed, can not be accessed. */
142 inh_transitive_closure_valid, /**< Closure computed and valid. */
143 inh_transitive_closure_invalid, /**< Closure invalid, but can be accessed. */
144 inh_transitive_closure_max /**< Invalid value. */
145 } inh_transitive_closure_state;
147 void set_irp_inh_transitive_closure_state(inh_transitive_closure_state s);
148 void invalidate_irp_inh_transitive_closure_state(void);
149 inh_transitive_closure_state get_irp_inh_transitive_closure_state(void);
152 /** Compute transitive closure of the subclass/superclass and
153 * overwrites/overwrittenby relation.
155 * This function walks over the ir (O(#types+#entities)) to compute the
156 * transitive closure. */
157 void compute_inh_transitive_closure(void);
159 /** Free memory occupied by the transitive closure information. */
160 void free_inh_transitive_closure(void);
163 /* - subtype ------------------------------------------------------------- */
165 /** Iterate over all transitive subtypes. */
166 type *get_class_trans_subtype_first(type *tp);
167 type *get_class_trans_subtype_next (type *tp);
168 int is_class_trans_subtype (type *tp, type *subtp);
170 /* - supertype ----------------------------------------------------------- */
172 /** Iterate over all transitive supertypes. */
173 type *get_class_trans_supertype_first(type *tp);
174 type *get_class_trans_supertype_next (type *tp);
176 /* - overwrittenby ------------------------------------------------------- */
178 /** Iterate over all entities that transitive overwrite this entities. */
179 entity *get_entity_trans_overwrittenby_first(entity *ent);
180 entity *get_entity_trans_overwrittenby_next (entity *ent);
182 /* - overwrites ---------------------------------------------------------- */
184 /** Iterate over all transitive overwritten entities. */
185 entity *get_entity_trans_overwrites_first(entity *ent);
186 entity *get_entity_trans_overwrites_next (entity *ent);
189 /* ----------------------------------------------------------------------- */
190 /** The state of Cast operations that cast class types or pointers to class
193 * The state expresses, how far Cast operations conform with the class
197 * class B1 extends A {}
198 * class B2 extends A {}
199 * class C extends B1 {}
200 * normalized: Cast operations conform with the inheritance relation.
201 * I.e., the type of the operand of a Cast is either a super= or a sub-
202 * type of the type casted to. Example: (A)((B2) (new C())).
203 * transitive: Cast operations conform with the transitive inheritance
204 * relation. Example: (A)(new C()).
205 * any: Cast operations do not conform with the transitive inheritance
206 * relation. Example: (B2)(new B1())
210 /* ----------------------------------------------------------------------- */
212 /** Flags for class cast state.
214 * The state in irp is always smaller or equal to the state of any
217 * We rely on the ordering of the enum. */
219 ir_class_casts_any = 0, /**< There are class casts that do not cast in conformance with
220 the class hierarchy. @@@ So far this does not happen in Firm. */
221 ir_class_casts_transitive = 1, /**< Class casts conform to transitive inheritance edges. Default. */
222 ir_class_casts_normalized = 2, /**< Class casts conform to inheritance edges. */
223 ir_class_casts_state_max
224 } ir_class_cast_state;
225 char *get_class_cast_state_string(ir_class_cast_state s);
227 void set_irg_class_cast_state(ir_graph *irg, ir_class_cast_state s);
228 ir_class_cast_state get_irg_class_cast_state(ir_graph *irg);
229 void set_irp_class_cast_state(ir_class_cast_state s);
230 ir_class_cast_state get_irp_class_cast_state(void);
232 /** Verify the class cast state of an irg.
234 * Asserts if state is to high, outputs warning if state is to low
235 * and firm verbosity is set.
237 void verify_irg_class_cast_state(ir_graph *irg);
238 #endif /* _TR_INHERITANCE_H_ */