2 * Copyright (C) 1995-2011 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
26 #ifndef FIRM_ANA_TROUTS_H
27 #define FIRM_ANA_TROUTS_H
29 #include "firm_types.h"
36 * @defgroup trouts Reverse Type Edges
37 * Trouts list all uses of types and entities.
38 * Each type gets a list of all Alloc nodes allocating it.
39 * Each entity gets two lists:
40 * - one containing all accesses (Load, (Call), Store),
41 * - and one containing all uses to get a reference (Sel, SymConst).
45 /** Number of Load/Store nodes that possibly access this entity. */
46 FIRM_API size_t get_entity_n_accesses(const ir_entity *ent);
47 /** Load/Store node that possibly access this entity. */
48 FIRM_API ir_node *get_entity_access(const ir_entity *ent, size_t pos);
50 /** Number of references to an entity, in form of SymConst/Sel.
51 * Including references from constant entities and the like. */
52 FIRM_API size_t get_entity_n_references(const ir_entity *ent);
53 /** References to an entity, in form of SymConst/Sel
54 * Including references from constants. */
55 FIRM_API ir_node *get_entity_reference(const ir_entity *ent, size_t pos);
57 /** Number of Alloc nodes that create an instance of this type. */
58 FIRM_API size_t get_type_n_allocs(const ir_type *tp);
59 /** Alloc node that create an instance of this type. */
60 FIRM_API ir_node *get_type_alloc(const ir_type *tp, size_t pos);
62 /** Number of Cast nodes that cast a pointer to this type. */
63 FIRM_API size_t get_type_n_casts(const ir_type *tp);
64 /** Cast node that cast a pointer to this type. */
65 FIRM_API ir_node *get_type_cast(const ir_type *tp, size_t pos);
66 FIRM_API void add_type_cast(const ir_type *tp, ir_node *cast);
67 /** Return number of upcasts. O(\#casts). */
68 FIRM_API size_t get_class_n_upcasts(const ir_type *clss);
69 /** Return number of downcasts. O(\#casts). */
70 FIRM_API size_t get_class_n_downcasts(const ir_type *clss);
72 FIRM_API size_t get_type_n_pointertypes_to(const ir_type *tp);
73 FIRM_API ir_type *get_type_pointertype_to(const ir_type *tp, size_t pos);
74 FIRM_API void add_type_pointertype_to(const ir_type *tp, ir_type *ptp);
76 FIRM_API size_t get_type_n_arraytypes_of(const ir_type *tp);
77 FIRM_API ir_type *get_type_arraytype_of(const ir_type *tp, size_t pos);
78 FIRM_API void add_type_arraytype_of(const ir_type *tp, ir_type *atp);
80 /** Compute the outs of types and entities.
82 * Collects all reference from irnodes to types or entities in the
83 * corresponding types/entities. Further reverses references between
86 * Annotates the following nodes:
87 * Alloc --> get_Alloc_type()
88 * Cast --> get_Cast_type()
89 * Sel --> get_Sel_entity()
90 * SymConst --> get_SymConst_entity()
91 * Load(addr) --> get_addr_entity() \ ent von SymConst, oder falls Sel: ent von
92 * Store(addr) --> get_addr_entity() / outermost im compound. Ansonsten: nirgends.
93 * d.h. wir bekommen die array Elementzugriffe
94 * an die jack array Klasse annotiert.
95 * Call(Sel) --> get_Sel_entity() // ev. Tabellenzugriff --> Load.
97 * type --> pointer type refering to this type.
98 * type --> entity of this type. @@@ to be implemented.
100 * Sets trout state to outs_consistent.
102 FIRM_API void compute_trouts(void);
104 /** Free trout data. */
105 FIRM_API void free_trouts(void);