2 * Copyright (C) 1995-2007 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 Reverse edges that reference types/entities.
23 * @author Goetz Lindenmaier
27 * Trouts list all uses of types and entities.
28 * Each type gets a list of all Alloc nodes allocating it.
29 * Each entity gets two lists:
30 * - one containing all accesses (Load, (Call), Store),
31 * - and one containing all uses to get a reference (Sel, SymConst).
34 * To list all uses of entities of a type, we also should list all
35 * static/automatic allocated entities in types. The Alloc nodes
36 * represent only the dynamic allocated entities.
38 #ifndef FIRM_ANA_TROUTS_H
39 #define FIRM_ANA_TROUTS_H
41 #include "firm_types.h"
44 /*-----------------------------------------------------------------*/
45 /* Accessing the trout datastructures. */
46 /* These routines only work properly if firm is in state */
47 /* trouts_consistent or trouts_inconsistent. */
48 /*-----------------------------------------------------------------*/
50 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
52 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
54 /** Number of Load/Store nodes that possibly access this entity. */
55 int get_entity_n_accesses(ir_entity *ent);
56 /** Load/Store node that possibly access this entity. */
57 ir_node *get_entity_access(ir_entity *ent, int pos);
59 /** Number of references to an entity, in form of SymConst/Sel.
60 * Including references from constant entities and the like. */
61 int get_entity_n_references(ir_entity *ent);
62 /** References to an entity, in form of SymConst/Sel
63 * Including references from constants. */
64 ir_node *get_entity_reference(ir_entity *ent, int pos);
66 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
68 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
70 /** Number of Alloc nodes that create an instance of this type. */
71 int get_type_n_allocs(ir_type *tp);
72 /** Alloc node that create an instance of this type. */
73 ir_node *get_type_alloc(ir_type *tp, int pos);
75 /** Number of Cast nodes that cast a pointer to this type. */
76 int get_type_n_casts(ir_type *tp);
77 /** Cast node that cast a pointer to this type. */
78 ir_node *get_type_cast(ir_type *tp, int pos);
79 void add_type_cast(ir_type *tp, ir_node *cast);
80 /** Return number of upcasts. O(#casts). */
81 int get_class_n_upcasts(ir_type *clss);
82 /** Return number of downcasts. O(#casts). */
83 int get_class_n_downcasts(ir_type *clss);
85 /* Access all pointer types that point to tp. */
86 int get_type_n_pointertypes_to(ir_type *tp);
87 ir_type *get_type_pointertype_to(ir_type *tp, int pos);
88 void add_type_pointertype_to(ir_type *tp, ir_type *ptp);
90 /* Access all array types that contain elements of type tp.
91 * Does not find subarrays, e.g., int[] being element of int[][]
92 * for multi dimensional arrays. */
93 int get_type_n_arraytypes_of(ir_type *tp);
94 ir_type *get_type_arraytype_of(ir_type *tp, int pos);
95 void add_type_arraytype_of(ir_type *tp, ir_type *atp);
99 /* @@@ TODO: compute all entities that use a type. */
101 /*------------------------------------------------------------------*/
102 /* Building and Removing the trout datastructure */
103 /*------------------------------------------------------------------*/
105 /** The state of the tr_out datastructure.
107 * We reuse the enum of irouts.
109 irg_outs_state get_trouts_state(void);
110 /** Set the tr out state to inconsistent if it is consistent. */
111 void set_trouts_inconsistent(void);
113 /** Compute the outs of types and entities.
115 * Collects all reference from irnodes to types or entities in the
116 * corresponding types/entities. Further reverses references between
117 * types and entities.
119 * Annotates the following nodes:
120 * Alloc --> get_Alloc_type()
121 * Cast --> get_Cast_type()
122 * Sel --> get_Sel_entity()
123 * SymConst --> get_SymConst_entity()
124 * Load(addr) --> get_addr_entity() \ ent von SymConst, oder falls Sel: ent von
125 * Store(addr) --> get_addr_entity() / outermost im compound. Ansonsten: nirgends.
126 * d.h. wir bekommen die array Elementzugriffe
127 * an die jack array Klasse annotiert.
128 * Call(Sel) --> get_Sel_entity() // ev. Tabellenzugriff --> Load.
130 * type --> pointer type refering to this type.
131 * type --> entity of this type. @@@ to be implemented.
133 * Sets trout state to outs_consistent.
135 void compute_trouts(void);
137 /** Free trout data. */
138 void free_trouts(void);