better state handling
[libfirm] / ir / ana / irtypeinfo.c
1 /**
2  *
3  * @file irtypeinfo.c
4  *
5  * Project:     libFIRM
6  * File name:   ir/ana/irtypeinfo.c
7  * Purpose:     Data structure to hold type information for nodes.
8  * Author:      Goetz Lindenmaier
9  * Modified by:
10  * Created:     28.8.2003
11  * CVS-ID:      $Id$
12  * Copyright:   (c) 2003 Universität Karlsruhe
13  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
14  *
15  * Data structure to hold type information for nodes.
16  *
17  * This module defines a field "type" of type "type *" for each ir node.
18  * It defines a flag for irgraphs to mark whether the type info of the
19  * graph is valid.  Further it defines an auxiliary type "initial_type".
20  *
21  * The module defines a map that contains pairs (irnode, type).  If an irnode
22  * is not in the map it is assumed to be initialized, i.e., the initialization
23  * requires no compute time.  As firm nodes can not be freed and reallocated
24  * pointers for nodes are unique (until a call of dead_node_elimination).
25  *
26  */
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "irtypeinfo.h"
33
34 #include <stddef.h>
35
36 #include "irgraph_t.h"   /* for setting the state flag. */
37 #include "irprog_t.h"
38 #include "irnode_t.h"
39 #include "pmap.h"
40
41 /* ------------ The map. ---------------------------------------------- */
42
43
44 static pmap *type_node_map = NULL;
45
46
47 /* ------------ Auxiliary type. --------------------------------------- */
48
49 /*  This auxiliary type expresses that a field is uninitialized.  The
50  *  variable is set by init_irtypeinfo.  The type is freed by
51  *  free_irtypeinfo.
52  */
53 type *initial_type = NULL;
54
55 /* ------------ Initializing this module. ----------------------------- */
56
57 /*  Initializes the type information module.
58  *  Generates a type "initial_type" and sets the type of all nodes to this type.
59  *  Calling set/get_irn_type is invalid before calling init. Requires memory
60  *  in the order of MIN(<calls to set_irn_type>, #irnodes).
61  */
62 void init_irtypeinfo(void) {
63   int i;
64
65   if (!initial_type)
66     initial_type = new_type_class(new_id_from_str("initial_type"));
67
68   /* We need a new, empty map. */
69   if (type_node_map) pmap_destroy(type_node_map);
70   type_node_map = pmap_create();
71
72   for (i = 0; i < get_irp_n_irgs(); ++i)
73     set_irg_typeinfo_state(get_irp_irg(i), ir_typeinfo_none);
74 }
75
76 void free_irtypeinfo(void) {
77   int i;
78
79   if (initial_type) {
80     free_type(initial_type);
81     initial_type = NULL;
82   } else
83     assert(0 && "call init_type_info before freeing");
84
85   if (type_node_map) {
86     pmap_destroy(type_node_map);
87     type_node_map = NULL;
88   } else
89     assert(0 && "call init_type_info before freeing");
90
91   for (i = 0; i < get_irp_n_irgs(); ++i)
92     set_irg_typeinfo_state(get_irp_irg(i), ir_typeinfo_none);
93 }
94
95
96 /* ------------ Irgraph state handling. ------------------------------- */
97
98 void set_irg_typeinfo_state(ir_graph *irg, ir_typeinfo_state s) {
99   assert(is_ir_graph(irg));
100   irg->typeinfo_state = s;
101   if ((irg->typeinfo_state == ir_typeinfo_consistent) &&
102       (irp->typeinfo_state == ir_typeinfo_consistent) &&
103       (s                   != ir_typeinfo_consistent)   )
104     irp->typeinfo_state = ir_typeinfo_inconsistent;
105 }
106
107 ir_typeinfo_state get_irg_typeinfo_state(ir_graph *irg) {
108   assert(is_ir_graph(irg));
109   return irg->typeinfo_state;
110 }
111
112
113 /* Returns accumulated type information state information.
114  *
115  * Returns ir_typeinfo_consistent if the type information of all irgs is
116  * consistent.  Returns ir_typeinfo_inconsistent if at least one irg has inconsistent
117  * or no type information.  Returns ir_typeinfo_none if no irg contains type information.
118  */
119 ir_typeinfo_state get_irp_typeinfo_state(void) {
120   return irp->typeinfo_state;
121 }
122 void set_irp_typeinfo_state(ir_typeinfo_state s) {
123   irp->typeinfo_state = s;
124 }
125 /* If typeinfo is consistent, sets it to inconsistent. */
126 void set_irp_typeinfo_inconsistent(void) {
127   if (irp->typeinfo_state == ir_typeinfo_consistent)
128     irp->typeinfo_state = ir_typeinfo_inconsistent;
129 }
130
131
132 /* ------------ Irnode type information. ------------------------------ */
133
134 /* These routines only work properly if the ir_graph is in state
135  * ir_typeinfo_consistent or ir_typeinfo_inconsistent.  They
136  * assume current_ir_graph set properly.
137  */
138 type *get_irn_typeinfo_type(ir_node *n) {
139   type *res = initial_type;
140   assert(get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent  ||
141          get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent  );
142
143   if (pmap_contains(type_node_map, (void *)n))
144     res = (type *) pmap_get(type_node_map, (void *)n);
145
146   return res;
147 }
148
149 void set_irn_typeinfo_type(ir_node *n, type *tp) {
150   assert(get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_consistent  ||
151          get_irg_typeinfo_state(current_ir_graph) == ir_typeinfo_inconsistent  );
152
153   pmap_insert(type_node_map, (void *)n, (void *)tp);
154 }