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 Support for libcore IR object output.
23 * @author Sebastian Hack
33 #include "lc_printf.h"
34 #include "firm_common.h"
39 #include "dbginfo_t.h"
42 * identify a firm object type
44 static int firm_get_arg_type(const lc_arg_occ_t *occ)
47 /* Firm objects are always pointer */
48 return lc_arg_type_ptr;
51 static int firm_get_arg_type_int(const lc_arg_occ_t *occ)
54 return lc_arg_type_int;
58 static int bitset_get_arg_type(const lc_arg_occ_t *occ)
61 return lc_arg_type_ptr;
64 static int bitset_emit(lc_appendable_t *app,
65 const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
68 bitset_t *b = (bitset_t*)arg->v_ptr;
71 const char *prefix = "";
73 lc_arg_append(app, occ, "[", 1);
74 bitset_foreach(b, p) {
77 n = snprintf(buf, sizeof(buf), "%s%d", prefix, (int) p);
78 lc_arg_append(app, occ, buf, n);
82 lc_arg_append(app, occ, "]", 1);
88 * emit an opaque Firm dbg_info object
90 static int firm_emit_dbg(lc_appendable_t *app,
91 const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
94 ir_node *irn = (ir_node*)arg->v_ptr;
95 dbg_info *dbg = get_irn_dbg_info(irn);
97 ir_dbg_info_snprint(buf, sizeof(buf), dbg);
98 return lc_arg_append(app, occ, buf, strlen(buf));
102 * Beware: do not set the entity ld_name
104 static const char *get_entity_ld_name_ex(ir_entity *ent)
107 return get_entity_ld_name(ent);
108 return get_entity_name(ent);
114 static int firm_emit(lc_appendable_t *app,
115 const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
117 #define A(s) occ->flag_hash ? s " ": ""
119 void *X = (void*)arg->v_ptr;
120 firm_kind *obj = (firm_kind*)X;
132 return lc_arg_append(app, occ, "(null)", 6);
137 snprintf(buf, sizeof(buf), "BAD");
138 snprintf(add, sizeof(add), "[%p]", X);
141 ir_entity *entity = (ir_entity*)X;
142 snprintf(buf, sizeof(buf), "%s%s", A("ent"),
143 isupper(occ->conversion) ? get_entity_ld_name_ex(entity): get_entity_name(entity));
144 snprintf(add, sizeof(add), "[%ld]", get_entity_nr(entity));
148 ir_type *type = (ir_type*)X;
150 ir_print_type(type_name, sizeof(type_name), type);
151 snprintf(buf, sizeof(buf), "%s%s:%s", A("type"),
152 get_type_tpop_name(type), type_name);
153 snprintf(add, sizeof(add), "[%ld]", get_type_nr(type));
157 ir_graph *irg = (ir_graph*)X;
158 if (irg == get_const_code_irg())
159 snprintf(buf, sizeof(buf), "%s<ConstCodeIrg>", A("irg"));
161 snprintf(buf, sizeof(buf), "%s%s", A("irg"), get_entity_name(get_irg_entity(irg)));
162 snprintf(add, sizeof(add), "[%ld]", get_irg_graph_nr(irg));
166 ir_node *node = (ir_node*)X;
167 switch (occ->conversion) {
169 block = !is_Block(node) ? get_nodes_block(node) : node;
170 snprintf(buf, sizeof(buf), "%s%s %s", A("irn"),
171 get_irn_opname(block), get_mode_name(get_irn_mode(block)));
172 snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(block));
175 snprintf(buf, sizeof(buf), "%ld", get_irn_node_nr(node));
178 if (is_Const(node)) {
179 ir_tarval *tv = get_Const_tarval(node);
181 tarval_snprintf(tv_buf, sizeof(tv_buf), tv);
183 strncpy(tv_buf, "(NULL)", sizeof(tv_buf));
184 snprintf(buf, sizeof(buf), "%s%s %s<%s>", A("irn"), get_irn_opname(node),
185 get_mode_name(get_irn_mode(node)), tv_buf);
186 } else if (is_SymConst_addr_ent(node)) {
187 snprintf(buf, sizeof(buf), "%s%s %s[%s]", A("irn"), get_irn_opname(node),
188 get_mode_name(get_irn_mode(node)), get_entity_name(get_SymConst_entity(node)));
189 } else if (is_Sel(node)) {
190 snprintf(buf, sizeof(buf), "%s%s %s[%s]", A("irn"), get_irn_opname(node),
191 get_mode_name(get_irn_mode(node)), get_entity_name(get_Sel_entity(node)));
192 } else if (is_Cmp(node)) {
193 ir_relation relation = get_Cmp_relation(node);
194 snprintf(buf, sizeof(buf), "%s%s %s", A("irn"), get_irn_opname(node), get_relation_string(relation));
196 snprintf(buf, sizeof(buf), "%s%s %s", A("irn"), get_irn_opname(node),
197 get_mode_name(get_irn_mode(node)));
199 snprintf(add, sizeof(add), "[%ld:%u]", get_irn_node_nr(node), get_irn_idx(node));
204 ir_mode *mode = (ir_mode*)X;
205 snprintf(buf, sizeof(buf), "%s%s", A("mode"), get_mode_name(mode));
209 ir_tarval *tarval = (ir_tarval*)X;
210 tarval_snprintf(tv_buf, sizeof(tv_buf), tarval);
211 snprintf(buf, sizeof(buf), "%s%s", A("tv"), tv_buf);
215 ir_loop *loop = (ir_loop*)X;
216 snprintf(buf, sizeof(buf), "loop[%ld:%u]", get_loop_loop_nr(loop), get_loop_depth(loop));
220 ir_op *op = (ir_op*)X;
221 snprintf(buf, sizeof(buf), "%s%s", A("op"), get_op_name(op));
224 case k_ir_compound_graph_path: {
225 compound_graph_path *path = (compound_graph_path*)X;
226 n = get_compound_graph_path_length(path);
228 for (i = 0; i < n; ++i) {
229 ent = get_compound_graph_path_node(path, i);
231 strncat(buf, ".", sizeof(buf)-1);
232 strncat(buf, get_entity_name(ent), sizeof(buf)-1);
233 if (is_Array_type(get_entity_owner(ent))) {
234 snprintf(add, sizeof(add), "[%ld]",
235 get_compound_graph_path_array_index(path, i));
236 strncat(buf, add, sizeof(buf)-1);
243 ir_extblk *extblk = (ir_extblk*)X;
244 snprintf(buf, sizeof(buf), "ExtBlock");
245 snprintf(add, sizeof(add), "[%ld]", get_irn_node_nr(get_extbb_leader(extblk)));
250 snprintf(buf, sizeof(buf), "UNKWN");
251 snprintf(add, sizeof(add), "[%p]", X);
255 strncat(buf, add, sizeof(buf)-1);
257 return lc_arg_append(app, occ, buf, strlen(buf));
264 static int firm_emit_ident(lc_appendable_t *app,
265 const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
267 ident *id = (ident *)arg->v_ptr;
268 const char *p = id ? get_id_str(id) : "(null)";
270 return lc_arg_append(app, occ, p, strlen(p));
276 static int firm_emit_indent(lc_appendable_t *app,
277 const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
280 int width = occ->width > 0 ? occ->width : 1;
281 int amount = arg->v_int * width;
283 for (i = 0; i < amount; ++i)
284 lc_appendable_chadd(app, (i % width) == 0 ? '|' : ' ');
292 static int firm_emit_pnc(lc_appendable_t *app,
293 const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
295 int value = arg->v_int;
296 const char *p = get_relation_string(value);
298 return lc_arg_append(app, occ, p, strlen(p));
301 lc_arg_env_t *firm_get_arg_env(void)
304 static lc_arg_env_t *env = NULL;
306 static lc_arg_handler_t firm_handler = { firm_get_arg_type, firm_emit };
307 static lc_arg_handler_t ident_handler = { firm_get_arg_type, firm_emit_ident };
308 static lc_arg_handler_t indent_handler = { firm_get_arg_type_int, firm_emit_indent };
309 static lc_arg_handler_t pnc_handler = { firm_get_arg_type_int, firm_emit_pnc };
310 static lc_arg_handler_t bitset_handler = { bitset_get_arg_type, bitset_emit };
311 static lc_arg_handler_t debug_handler = { firm_get_arg_type, firm_emit_dbg };
318 {"firm:entity", 'e'},
319 {"firm:entity_ld", 'E'},
320 {"firm:tarval", 'T'},
323 {"firm:irn_nr", 'N'},
326 {"firm:cg_path", 'P'},
332 env = lc_arg_new_env();
335 lc_arg_register(env, "firm", 'F', &firm_handler);
336 for (i = 0; i < sizeof(args)/sizeof(args[0]); ++i)
337 lc_arg_register(env, args[i].name, args[i].letter, &firm_handler);
339 lc_arg_register(env, "firm:ident", 'I', &ident_handler);
340 lc_arg_register(env, "firm:indent", 'D', &indent_handler);
341 lc_arg_register(env, "firm:dbg_info", 'G', &debug_handler);
342 lc_arg_register(env, "firm:bitset", 'B', &bitset_handler);
343 lc_arg_register(env, "firm:pnc", '=', &pnc_handler);