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