merge common graph copying code; move dead code elimination into an own file
[libfirm] / ir / ir / irargs.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Support for libcore IR object output.
23  * @author   Sebastian Hack
24  * @version  $Id$
25  */
26 #include "config.h"
27
28 #include "bitset.h"
29
30 #include <ctype.h>
31
32 #include "lc_printf.h"
33 #include "firm_common.h"
34 #include "irnode_t.h"
35 #include "entity_t.h"
36 #include "irloop_t.h"
37 #include "tv_t.h"
38 #include "dbginfo_t.h"
39
40 /**
41  * identify a firm object type
42  */
43 static int firm_get_arg_type(const lc_arg_occ_t *occ)
44 {
45         (void) occ;
46         /* Firm objects are always pointer */
47         return lc_arg_type_ptr;
48 }
49
50 static int firm_get_arg_type_int(const lc_arg_occ_t *occ)
51 {
52         (void) occ;
53         return lc_arg_type_int;
54 }
55
56
57 static int bitset_get_arg_type(const lc_arg_occ_t *occ)
58 {
59         (void) occ;
60         return lc_arg_type_ptr;
61 }
62
63 static int bitset_emit(lc_appendable_t *app,
64     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
65 {
66         int res = 2;
67         bitset_t *b = arg->v_ptr;
68         bitset_pos_t p;
69         char buf[32];
70         const char *prefix = "";
71
72         lc_arg_append(app, occ, "[", 1);
73         bitset_foreach(b, p) {
74                 int n;
75
76                 n = snprintf(buf, sizeof(buf), "%s%d", prefix, (int) p);
77                 lc_arg_append(app, occ, buf, n);
78                 prefix = ", ";
79                 res += n;
80         }
81         lc_arg_append(app, occ, "]", 1);
82
83         return res;
84 }
85
86 /**
87  * emit an opaque Firm dbg_info object
88  */
89 static int firm_emit_dbg(lc_appendable_t *app,
90     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
91 {
92         char buf[1024];
93         ir_node *irn = arg->v_ptr;
94         dbg_info *dbg = get_irn_dbg_info(irn);
95
96         ir_dbg_info_snprint(buf, sizeof(buf), dbg);
97         return lc_arg_append(app, occ, buf, strlen(buf));
98 }
99
100 /**
101  * Beware: do not set the entity ld_name
102  */
103 static const char *get_entity_ld_name_ex(ir_entity *ent)
104 {
105         if (ent->ld_name)
106                 return get_entity_ld_name(ent);
107         return get_entity_name(ent);
108 }
109
110 /**
111  * emit a Firm object
112  */
113 static int firm_emit(lc_appendable_t *app,
114     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
115 {
116 #define A(s)    occ->flag_hash ? s " ": ""
117
118         void *X = arg->v_ptr;
119         firm_kind *obj = X;
120         int i, n;
121         ir_node *block;
122         char add[64];
123         char buf[256];
124         char tv_buf[256];
125         ir_entity *ent;
126
127         buf[0] = '\0';
128         add[0] = '\0';
129
130         if (! X)
131                 strncpy(buf, "(null)", sizeof(buf));
132         else {
133                 switch (*obj) {
134         case k_BAD:
135                 snprintf(buf, sizeof(buf), "BAD");
136                 snprintf(add, sizeof(add), "[%p]", X);
137                 break;
138         case k_entity:
139                 snprintf(buf, sizeof(buf), "%s%s", A("ent"),
140                         isupper(occ->conversion) ? get_entity_ld_name_ex(X): get_entity_name(X));
141                 snprintf(add, sizeof(add), "[%ld]", get_entity_nr(X));
142                 break;
143         case k_type: {
144                 char type_name[256];
145                 ir_print_type(type_name, sizeof(type_name), X);
146                 snprintf(buf, sizeof(buf), "%s%s:%s", A("type"), get_type_tpop_name(X),
147                          type_name);
148                 snprintf(add, sizeof(add), "[%ld]", get_type_nr(X));
149                 break;
150         }
151         case k_ir_graph:
152                 if (X == get_const_code_irg())
153                         snprintf(buf, sizeof(buf), "%s<ConstCodeIrg>", A("irg"));
154                 else
155                         snprintf(buf, sizeof(buf), "%s%s", A("irg"), get_entity_name(get_irg_entity(X)));
156                 snprintf(add, sizeof(add), "[%ld]", get_irg_graph_nr(X));
157                 break;
158         case k_ir_node:
159                 switch (occ->conversion) {
160                 case 'B':
161                         block = is_no_Block(X) ? get_nodes_block(X) : X;
162                         snprintf(buf, sizeof(buf), "%s%s %s", A("irn"),
163                                  get_irn_opname(block), get_mode_name(get_irn_mode(block)));
164                         snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(block));
165                         break;
166                 case 'N':
167                         snprintf(buf, sizeof(buf), "%ld", get_irn_node_nr(X));
168                         break;
169                 default:
170                         if (is_Const(X)) {
171                                 tarval *tv = get_Const_tarval(X);
172                                 if (tv)
173                                         tarval_snprintf(tv_buf, sizeof(tv_buf), tv);
174                                 else
175                                         strncpy(tv_buf, "(NULL)", sizeof(tv_buf));
176                                 snprintf(buf, sizeof(buf), "%s%s %s<%s>", A("irn"), get_irn_opname(X),
177                                         get_mode_name(get_irn_mode(X)), tv_buf);
178                         } else if (is_SymConst_addr_ent(X)) {
179                                 snprintf(buf, sizeof(buf), "%s%s %s[%s]", A("irn"), get_irn_opname(X),
180                                 get_mode_name(get_irn_mode(X)), get_entity_name(get_SymConst_entity(X)));
181                         } else if (is_Sel(X)) {
182                                 snprintf(buf, sizeof(buf), "%s%s %s[%s]", A("irn"), get_irn_opname(X),
183                                 get_mode_name(get_irn_mode(X)), get_entity_name(get_Sel_entity(X)));
184                         } else {
185                                 snprintf(buf, sizeof(buf), "%s%s %s", A("irn"), get_irn_opname(X),
186                                 get_mode_name(get_irn_mode(X)));
187                         }
188                         snprintf(add, sizeof(add), "[%ld:%d]", get_irn_node_nr(X), get_irn_idx(X));
189                 }
190                 break;
191         case k_ir_mode:
192                 snprintf(buf, sizeof(buf), "%s%s", A("mode"), get_mode_name(X));
193                 break;
194         case k_tarval:
195                 tarval_snprintf(tv_buf, sizeof(tv_buf), X);
196                 snprintf(buf, sizeof(buf), "%s%s", A("tv"), tv_buf);
197                 break;
198         case k_ir_loop:
199                 snprintf(buf, sizeof(buf), "loop[%d:%d]", get_loop_loop_nr(X), get_loop_depth(X));
200                 break;
201         case k_ir_op:
202                 snprintf(buf, sizeof(buf), "%s%s", A("op"), get_op_name(X));
203                 break;
204         case k_ir_compound_graph_path:
205                 n = get_compound_graph_path_length(X);
206
207                 for (i = 0; i < n; ++i) {
208                         ent = get_compound_graph_path_node(X, i);
209
210                         strncat(buf, ".", sizeof(buf)-1);
211                         strncat(buf, get_entity_name(ent), sizeof(buf)-1);
212                         if (is_Array_type(get_entity_owner(ent))) {
213                                 snprintf(add, sizeof(add), "[%d]",
214                                         get_compound_graph_path_array_index(X, i));
215                                 strncat(buf, add, sizeof(buf)-1);
216                         }
217                 }
218                 add[0] = '\0';
219                 break;
220         case k_ir_extblk:
221                 snprintf(buf, sizeof(buf), "ExtBlock");
222                 snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(get_extbb_leader(X)));
223                 break;
224
225         default:
226                 snprintf(buf, sizeof(buf), "UNKWN");
227                 snprintf(add, sizeof(add), "[%p]", X);
228                 }
229         }
230
231         if (occ->flag_plus)
232                 strncat(buf, add, sizeof(buf)-1);
233
234         return lc_arg_append(app, occ, buf, strlen(buf));
235
236 #undef A
237 }
238
239 /**
240  * emit an ident
241  */
242 static int firm_emit_ident(lc_appendable_t *app,
243     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
244 {
245         ident *id = (ident *)arg->v_ptr;
246         const char *p = id ? get_id_str(id) : "(null)";
247
248         return lc_arg_append(app, occ, p, strlen(p));
249 }
250
251 /**
252  * Emit indent.
253  */
254 static int firm_emit_indent(lc_appendable_t *app,
255     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
256 {
257         int i;
258         int width  = occ->width > 0 ? occ->width : 1;
259         int amount = arg->v_int * width;
260
261         for (i = 0; i < amount; ++i)
262                 lc_appendable_chadd(app, (i % width) == 0 ? '|' : ' ');
263
264         return amount;
265 }
266
267 /**
268  * Emit pnc.
269  */
270 static int firm_emit_pnc(lc_appendable_t *app,
271     const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
272 {
273         int value = arg->v_int;
274         const char *p = get_pnc_string(value);
275
276         return lc_arg_append(app, occ, p, strlen(p));
277 }
278
279 lc_arg_env_t *firm_get_arg_env(void)
280 {
281
282         static lc_arg_env_t *env = NULL;
283
284         static lc_arg_handler_t firm_handler   = { firm_get_arg_type, firm_emit };
285         static lc_arg_handler_t ident_handler  = { firm_get_arg_type, firm_emit_ident };
286         static lc_arg_handler_t indent_handler = { firm_get_arg_type_int, firm_emit_indent };
287         static lc_arg_handler_t pnc_handler    = { firm_get_arg_type_int, firm_emit_pnc };
288         static lc_arg_handler_t bitset_handler = { bitset_get_arg_type, bitset_emit };
289         static lc_arg_handler_t debug_handler  = { firm_get_arg_type, firm_emit_dbg };
290
291         static struct {
292                 const char *name;
293                 char letter;
294         } args[] = {
295 #define X(name, letter) {"firm:" name, letter}
296                 X("type",      't'),
297                 X("entity",    'e'),
298                 X("entity_ld", 'E'),
299                 X("tarval",    'T'),
300                 X("irn",       'n'),
301                 X("op",        'O'),
302                 X("irn_nr",    'N'),
303                 X("mode",      'm'),
304                 X("block",     'B'),
305                 X("cg_path",   'P'),
306 #undef X
307         };
308
309         size_t i;
310
311         if (env == NULL) {
312                 env = lc_arg_new_env();
313                 lc_arg_add_std(env);
314
315                 lc_arg_register(env, "firm", 'F', &firm_handler);
316                 for (i = 0; i < sizeof(args)/sizeof(args[0]); ++i)
317                         lc_arg_register(env, args[i].name, args[i].letter, &firm_handler);
318
319                 lc_arg_register(env, "firm:ident",    'I', &ident_handler);
320                 lc_arg_register(env, "firm:indent",   'D', &indent_handler);
321                 lc_arg_register(env, "firm:dbg_info", 'G', &debug_handler);
322                 lc_arg_register(env, "firm:bitset",   'B', &bitset_handler);
323                 lc_arg_register(env, "firm:pnc",      '=', &pnc_handler);
324         }
325
326         return env;
327 }