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