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 Write textual representation of firm to file.
23 * @author Moritz Kroll
37 #include "irgraph_t.h"
50 #define SYMERROR ((unsigned) ~0)
52 typedef struct io_env_t
54 int c; /**< currently read char */
56 set *idset; /**< id_entry set, which maps from file ids to new Firm elements */
58 const char *inputname;
65 typedef enum typetag_t
70 tt_cond_jmp_predicate,
85 typedef enum keyword_t
98 typedef struct symbol_t
100 const char *str; /**< The name of this symbol. */
101 typetag_t typetag; /**< The type tag of this symbol. */
102 unsigned code; /**< The value of this symbol. */
105 typedef struct id_entry
111 /** The symbol table, a set of symbol_t elements. */
115 * Compare two symbol table entries.
117 static int symbol_cmp(const void *elt, const void *key, size_t size)
120 const symbol_t *entry = (const symbol_t *) elt;
121 const symbol_t *keyentry = (const symbol_t *) key;
123 res = entry->typetag - keyentry->typetag;
125 return strcmp(entry->str, keyentry->str);
128 static int id_cmp(const void *elt, const void *key, size_t size)
130 const id_entry *entry = (const id_entry *) elt;
131 const id_entry *keyentry = (const id_entry *) key;
133 return entry->id - keyentry->id;
136 static void __attribute__((format(printf, 2, 3)))
137 parse_error(io_env_t *env, const char *fmt, ...)
140 int line = env->line;
142 /* workaround read_c "feature" that a '\n' triggers the line++
143 * instead of the character after the '\n' */
144 if (env->c == '\n') {
148 fprintf(stderr, "%s:%d: error ", env->inputname, line);
151 vfprintf(stderr, fmt, ap);
155 /** Initializes the symbol table. May be called more than once without problems. */
156 static void symtbl_init(void)
160 /* Only initialize once */
164 symtbl = new_set(symbol_cmp, 256);
166 #define INSERT(tt, s, cod) \
168 key.typetag = (tt); \
170 set_insert(symtbl, &key, sizeof(key), firm_fnv_hash_str(s) + tt * 17)
172 #define INSERTENUM(tt, e) INSERT(tt, #e, e)
173 #define INSERTKEYWORD(k) INSERT(tt_keyword, #k, kw_##k)
175 INSERT(tt_tpo, "array", tpo_array);
176 INSERT(tt_tpo, "class", tpo_class);
177 INSERT(tt_tpo, "method", tpo_method);
178 INSERT(tt_tpo, "pointer", tpo_pointer);
179 INSERT(tt_tpo, "primitive", tpo_primitive);
180 INSERT(tt_tpo, "struct", tpo_struct);
181 INSERT(tt_tpo, "union", tpo_union);
182 INSERT(tt_tpo, "Unknown", tpo_unknown);
184 INSERT(tt_mode_sort, "auxiliary", irms_auxiliary);
185 INSERT(tt_mode_sort, "control_flow", irms_control_flow);
186 INSERT(tt_mode_sort, "memory", irms_memory);
187 INSERT(tt_mode_sort, "internal_boolean", irms_internal_boolean);
188 INSERT(tt_mode_sort, "reference", irms_reference);
189 INSERT(tt_mode_sort, "int_number", irms_int_number);
190 INSERT(tt_mode_sort, "float_number", irms_float_number);
192 INSERT(tt_segment, "global", IR_SEGMENT_GLOBAL);
193 INSERT(tt_segment, "thread_local", IR_SEGMENT_THREAD_LOCAL);
194 INSERT(tt_segment, "constructors", IR_SEGMENT_CONSTRUCTORS);
195 INSERT(tt_segment, "destructors", IR_SEGMENT_DESTRUCTORS);
197 INSERT(tt_linkage, "constant", IR_LINKAGE_CONSTANT);
198 INSERT(tt_linkage, "weak", IR_LINKAGE_WEAK);
199 INSERT(tt_linkage, "garbage_collect", IR_LINKAGE_GARBAGE_COLLECT);
200 INSERT(tt_linkage, "merge", IR_LINKAGE_MERGE);
201 INSERT(tt_linkage, "hidden_user", IR_LINKAGE_HIDDEN_USER);
203 INSERT(tt_visibility, "local", ir_visibility_local);
204 INSERT(tt_visibility, "external", ir_visibility_external);
205 INSERT(tt_visibility, "default", ir_visibility_default);
206 INSERT(tt_visibility, "private", ir_visibility_private);
208 INSERTKEYWORD(constirg);
209 INSERTKEYWORD(entity);
212 INSERTKEYWORD(modes);
214 INSERTKEYWORD(typegraph);
215 INSERTKEYWORD(program);
216 INSERTKEYWORD(segment_type);
218 #include "gen_irio_lex.inl"
220 INSERTENUM(tt_align, align_non_aligned);
221 INSERTENUM(tt_align, align_is_aligned);
223 INSERTENUM(tt_builtin, ir_bk_trap);
224 INSERTENUM(tt_builtin, ir_bk_debugbreak);
225 INSERTENUM(tt_builtin, ir_bk_return_address);
226 INSERTENUM(tt_builtin, ir_bk_frame_address);
227 INSERTENUM(tt_builtin, ir_bk_prefetch);
228 INSERTENUM(tt_builtin, ir_bk_ffs);
229 INSERTENUM(tt_builtin, ir_bk_clz);
230 INSERTENUM(tt_builtin, ir_bk_ctz);
231 INSERTENUM(tt_builtin, ir_bk_popcount);
232 INSERTENUM(tt_builtin, ir_bk_parity);
233 INSERTENUM(tt_builtin, ir_bk_bswap);
234 INSERTENUM(tt_builtin, ir_bk_inport);
235 INSERTENUM(tt_builtin, ir_bk_outport);
236 INSERTENUM(tt_builtin, ir_bk_inner_trampoline);
238 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_NONE);
239 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_TRUE);
240 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_FALSE);
242 INSERTENUM(tt_initializer, IR_INITIALIZER_CONST);
243 INSERTENUM(tt_initializer, IR_INITIALIZER_TARVAL);
244 INSERTENUM(tt_initializer, IR_INITIALIZER_NULL);
245 INSERTENUM(tt_initializer, IR_INITIALIZER_COMPOUND);
247 INSERTENUM(tt_mode_arithmetic, irma_uninitialized);
248 INSERTENUM(tt_mode_arithmetic, irma_none);
249 INSERTENUM(tt_mode_arithmetic, irma_twos_complement);
250 INSERTENUM(tt_mode_arithmetic, irma_ones_complement);
251 INSERTENUM(tt_mode_arithmetic, irma_int_BCD);
252 INSERTENUM(tt_mode_arithmetic, irma_ieee754);
253 INSERTENUM(tt_mode_arithmetic, irma_float_BCD);
255 INSERTENUM(tt_pin_state, op_pin_state_floats);
256 INSERTENUM(tt_pin_state, op_pin_state_pinned);
257 INSERTENUM(tt_pin_state, op_pin_state_exc_pinned);
258 INSERTENUM(tt_pin_state, op_pin_state_mem_pinned);
260 INSERTENUM(tt_type_state, layout_undefined);
261 INSERTENUM(tt_type_state, layout_fixed);
263 INSERTENUM(tt_volatility, volatility_non_volatile);
264 INSERTENUM(tt_volatility, volatility_is_volatile);
271 static const char *get_segment_name(ir_segment_t segment)
274 case IR_SEGMENT_GLOBAL: return "global";
275 case IR_SEGMENT_THREAD_LOCAL: return "thread_local";
276 case IR_SEGMENT_CONSTRUCTORS: return "constructors";
277 case IR_SEGMENT_DESTRUCTORS: return "destructors";
279 return "INVALID_SEGMENT";
282 static const char *get_visibility_name(ir_visibility visibility)
284 switch (visibility) {
285 case ir_visibility_local: return "local";
286 case ir_visibility_external: return "external";
287 case ir_visibility_default: return "default";
288 case ir_visibility_private: return "private";
290 return "INVALID_VISIBILITY";
293 /** Returns the according symbol value for the given string and tag, or SYMERROR if none was found. */
294 static unsigned symbol(const char *str, typetag_t typetag)
296 symbol_t key, *entry;
299 key.typetag = typetag;
301 entry = (symbol_t*)set_find(symtbl, &key, sizeof(key), firm_fnv_hash_str(str) + typetag * 17);
302 return entry ? entry->code : SYMERROR;
305 static void *get_id(io_env_t *env, long id)
307 id_entry key, *entry;
310 entry = (id_entry*)set_find(env->idset, &key, sizeof(key), (unsigned) id);
311 return entry ? entry->elem : NULL;
314 static void set_id(io_env_t *env, long id, void *elem)
319 set_insert(env->idset, &key, sizeof(key), (unsigned) id);
322 static void write_long(io_env_t *env, long value)
324 fprintf(env->file, "%ld ", value);
327 static void write_int(io_env_t *env, int value)
329 fprintf(env->file, "%d ", value);
332 static void write_unsigned(io_env_t *env, unsigned value)
334 fprintf(env->file, "%u ", value);
337 static void write_entity_ref(io_env_t *env, ir_entity *entity)
339 write_long(env, get_entity_nr(entity));
342 static void write_type_ref(io_env_t *env, ir_type *type)
344 write_long(env, get_type_nr(type));
347 static void write_string(io_env_t *env, const char *string)
350 fputc('"', env->file);
351 for (c = string; *c != '\0'; ++c) {
354 fputc('\\', env->file);
355 fputc('n', env->file);
359 fputc('\\', env->file);
362 fputc(*c, env->file);
366 fputc('"', env->file);
369 static void write_ident(io_env_t *env, ident *id)
371 write_string(env, get_id_str(id));
372 fputc(' ', env->file);
375 static void write_ident_null(io_env_t *env, ident *id)
378 fputs("NULL ", env->file);
380 write_ident(env, id);
384 static void write_mode(io_env_t *env, ir_mode *mode)
386 fputs(get_mode_name(mode), env->file);
387 fputc(' ', env->file);
390 static void write_tarval(io_env_t *env, ir_tarval *tv)
393 write_mode(env, get_tarval_mode(tv));
394 tarval_snprintf(buf, sizeof(buf), tv);
395 fputs(buf, env->file);
396 fputc(' ', env->file);
399 static void write_align(io_env_t *env, ir_align align)
401 fputs(get_align_name(align), env->file);
402 fputc(' ', env->file);
405 static void write_builtin_kind(io_env_t *env, ir_node *irn)
407 fputs(get_builtin_kind_name(get_Builtin_kind(irn)), env->file);
408 fputc(' ', env->file);
411 static void write_cond_jmp_predicate(io_env_t *env, ir_node *irn)
413 fputs(get_cond_jmp_predicate_name(get_Cond_jmp_pred(irn)), env->file);
414 fputc(' ', env->file);
417 static void write_list_begin(io_env_t *env)
419 fputs("[", env->file);
422 static void write_list_end(io_env_t *env)
424 fputs("] ", env->file);
427 static void write_initializer(io_env_t *env, ir_initializer_t *ini)
430 ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
432 fputs(get_initializer_kind_name(ini_kind), f);
436 case IR_INITIALIZER_CONST:
437 write_long(env, get_irn_node_nr(get_initializer_const_value(ini)));
440 case IR_INITIALIZER_TARVAL:
441 write_tarval(env, get_initializer_tarval_value(ini));
444 case IR_INITIALIZER_NULL:
447 case IR_INITIALIZER_COMPOUND: {
448 size_t i, n = get_initializer_compound_n_entries(ini);
449 ir_fprintf(f, "%zu ", n);
450 for (i = 0; i < n; ++i)
451 write_initializer(env, get_initializer_compound_value(ini, i));
456 panic("Unknown initializer kind");
460 static void write_pin_state(io_env_t *env, ir_node *irn)
462 fputs(get_op_pin_state_name(get_irn_pinned(irn)), env->file);
463 fputc(' ', env->file);
466 static void write_volatility(io_env_t *env, ir_volatility vol)
468 fputs(get_volatility_name(vol), env->file);
469 fputc(' ', env->file);
472 static void export_type_common(io_env_t *env, ir_type *tp)
474 fprintf(env->file, "\ttype %ld %s %u %u %s %u ",
476 get_type_tpop_name(tp),
477 get_type_size_bytes(tp),
478 get_type_alignment_bytes(tp),
479 get_type_state_name(get_type_state(tp)),
483 static void export_type_pre(io_env_t *env, ir_type *tp)
487 /* skip types to be handled by post walker */
488 switch (get_type_tpop_code(tp)) {
497 export_type_common(env, tp);
499 switch (get_type_tpop_code(tp)) {
500 case tpo_uninitialized:
501 panic("invalid type found");
504 write_ident_null(env, get_compound_ident(tp));
508 write_mode(env, get_type_mode(tp));
513 case tpo_enumeration:
514 write_ident_null(env, get_compound_ident(tp));
528 static void export_type_post(io_env_t *env, ir_type *tp)
533 /* skip types already handled by pre walker */
534 switch (get_type_tpop_code(tp)) {
540 case tpo_uninitialized:
547 case tpo_enumeration:
551 export_type_common(env, tp);
553 switch (get_type_tpop_code(tp)) {
555 size_t n = get_array_n_dimensions(tp);
556 ir_fprintf(f, "%zu %ld ", n, get_type_nr(get_array_element_type(tp)));
557 for (i = 0; i < n; i++) {
558 ir_node *lower = get_array_lower_bound(tp, i);
559 ir_node *upper = get_array_upper_bound(tp, i);
562 write_long(env, get_tarval_long(get_Const_tarval(lower)));
564 panic("Lower array bound is not constant");
567 write_long(env, get_tarval_long(get_Const_tarval(upper)));
568 else if (is_Unknown(upper))
569 fputs("unknown ", f);
571 panic("Upper array bound is not constant");
577 size_t nparams = get_method_n_params(tp);
578 size_t nresults = get_method_n_ress(tp);
579 ir_fprintf(f, "%u %u %zu %zu ", get_method_calling_convention(tp),
580 get_method_additional_properties(tp), nparams, nresults);
581 for (i = 0; i < nparams; i++)
582 write_long(env, get_type_nr(get_method_param_type(tp, i)));
583 for (i = 0; i < nresults; i++)
584 write_long(env, get_type_nr(get_method_res_type(tp, i)));
585 ir_fprintf(f, "%zu ", get_method_first_variadic_param_index(tp));
590 write_mode(env, get_type_mode(tp));
591 write_long(env, get_type_nr(get_pointer_points_to_type(tp)));
594 case tpo_enumeration:
595 fprintf(stderr, "Enumeration type not handled yet by exporter\n");
599 printf("export_type: Unknown type code \"%s\".\n",
600 get_type_tpop_name(tp));
606 static void export_entity(io_env_t *env, ir_entity *ent)
608 FILE *file = env->file;
609 ir_type *owner = get_entity_owner(ent);
610 ir_visibility visibility = get_entity_visibility(ent);
611 ir_linkage linkage = get_entity_linkage(ent);
613 /* we don't dump array_element_ent entities. They're a strange concept
614 * and lead to cycles in type_graph.
616 if (is_Array_type(owner))
619 fprintf(env->file, "\tentity ");
620 write_long(env, get_entity_nr(ent));
621 write_ident_null(env, get_entity_ident(ent));
622 if (!entity_has_ld_ident(ent)) {
623 write_ident_null(env, NULL);
625 write_ident_null(env, get_entity_ld_ident(ent));
628 /* visibility + linkage */
629 if (visibility != ir_visibility_default) {
630 fprintf(file, "%s ", get_visibility_name(visibility));
632 if (linkage & IR_LINKAGE_CONSTANT)
633 fputs("constant ", file);
634 if (linkage & IR_LINKAGE_WEAK)
635 fputs("weak ", file);
636 if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
637 fputs("garbage_collect ", file);
638 if (linkage & IR_LINKAGE_MERGE)
639 fputs("merge ", file);
640 if (linkage & IR_LINKAGE_HIDDEN_USER)
641 fputs("hidden_user ", file);
643 fprintf(file, "%ld %ld %d %u %d %s ",
644 get_type_nr(get_entity_type(ent)),
646 get_entity_offset(ent),
647 (unsigned) get_entity_offset_bits_remainder(ent),
648 is_entity_compiler_generated(ent),
649 get_volatility_name(get_entity_volatility(ent)));
651 if (ent->initializer != NULL) {
652 fputs("initializer ", env->file);
653 write_initializer(env, get_entity_initializer(ent));
654 } else if (entity_has_compound_ent_values(ent)) {
655 size_t i, n = get_compound_ent_n_values(ent);
656 fputs("compoundgraph ", env->file);
657 ir_fprintf(env->file, "%zu ", n);
658 for (i = 0; i < n; i++) {
659 ir_entity *member = get_compound_ent_value_member(ent, i);
660 ir_node *irn = get_compound_ent_value(ent, i);
661 fprintf(env->file, "%ld %ld ", get_entity_nr(member), get_irn_node_nr(irn));
664 fputs("none", env->file);
667 fputc('\n', env->file);
670 static void export_type_or_ent_pre(type_or_ent tore, void *ctx)
672 io_env_t *env = (io_env_t *) ctx;
673 if (get_kind(tore.typ) == k_type)
674 export_type_pre(env, tore.typ);
677 static void export_type_or_ent_post(type_or_ent tore, void *ctx)
679 io_env_t *env = (io_env_t *) ctx;
681 switch (get_kind(tore.ent)) {
683 export_entity(env, tore.ent);
687 export_type_post(env, tore.typ);
691 panic("export_type_or_ent_post: Unknown type or entity.");
696 static void export_ASM(io_env_t *env, ir_node *node)
698 ir_asm_constraint *input_constraints = get_ASM_input_constraints(node);
699 ir_asm_constraint *output_constraints = get_ASM_output_constraints(node);
700 ident **clobbers = get_ASM_clobbers(node);
701 int n_input_constraints = get_ASM_n_input_constraints(node);
702 int n_output_constraints = get_ASM_n_output_constraints(node);
703 int n_clobbers = get_ASM_n_clobbers(node);
706 write_ident(env, get_ASM_text(node));
707 write_list_begin(env);
708 for (i = 0; i < n_input_constraints; ++i) {
709 const ir_asm_constraint *constraint = &input_constraints[i];
710 write_unsigned(env, constraint->pos);
711 write_ident(env, constraint->constraint);
712 write_mode(env, constraint->mode);
716 write_list_begin(env);
717 for (i = 0; i < n_output_constraints; ++i) {
718 const ir_asm_constraint *constraint = &output_constraints[i];
719 write_unsigned(env, constraint->pos);
720 write_ident(env, constraint->constraint);
721 write_mode(env, constraint->mode);
725 write_list_begin(env);
726 for (i = 0; i < n_clobbers; ++i) {
727 ident *clobber = clobbers[i];
728 write_ident(env, clobber);
734 * Walker: exports every node.
736 static void export_node(ir_node *irn, void *ctx)
738 io_env_t *env = (io_env_t *) ctx;
740 unsigned opcode = get_irn_opcode(irn);
742 if (env->ignoreblocks && opcode == iro_Block)
745 fprintf(env->file, "\t%s ", get_irn_opname(irn));
746 write_long(env, get_irn_node_nr(irn));
748 write_list_begin(env);
749 n = get_irn_arity(irn);
750 if (!is_Block(irn)) {
751 ir_node *block = get_nodes_block(irn);
752 write_long(env, get_irn_node_nr(block));
755 for (i = 0; i < n; i++) {
756 ir_node *pred = get_irn_n(irn, i);
758 /* Anchor node may have NULL predecessors */
759 assert(is_Anchor(irn));
760 fputs("-1 ", env->file);
762 write_long(env, get_irn_node_nr(pred));
767 fputs("{ ", env->file);
776 /* TODO: only symconst_addr_ent implemented yet */
777 assert(get_SymConst_kind(irn) == symconst_addr_ent);
778 fprintf(env->file, "%ld ", get_entity_nr(get_SymConst_entity(irn)));
781 write_mode(env, get_irn_mode(irn));
782 fprintf(env->file, "%ld ", get_Proj_proj(irn));
785 export_ASM(env, irn);
787 #include "gen_irio_export.inl"
789 panic("no export code for node %+F\n", irn);
791 fputs("}\n", env->file);
794 static const char *get_mode_sort_name(ir_mode_sort sort)
797 case irms_auxiliary: return "auxiliary";
798 case irms_control_flow: return "control_flow";
799 case irms_memory: return "memory";
800 case irms_internal_boolean: return "internal_boolean";
801 case irms_reference: return "reference";
802 case irms_int_number: return "int_number";
803 case irms_float_number: return "float_number";
805 panic("invalid mode sort found");
808 static void export_modes(io_env_t *env)
810 size_t i, n_modes = get_irp_n_modes();
812 fputs("modes {\n", env->file);
814 for (i = 0; i < n_modes; i++) {
815 ir_mode *mode = get_irp_mode(i);
816 switch (get_mode_sort(mode)) {
818 case irms_control_flow:
820 case irms_internal_boolean:
821 /* skip "internal" modes, which may not be user defined */
827 fprintf(env->file, "\tmode ");
828 write_string(env, get_mode_name(mode));
829 fprintf(env->file, "%s %u %d %s %u %u ",
830 get_mode_sort_name(get_mode_sort(mode)),
831 get_mode_size_bits(mode), get_mode_sign(mode),
832 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
833 get_mode_modulo_shift(mode),
834 get_mode_n_vector_elems(mode));
835 if (mode_is_reference(mode)) {
836 write_mode(env, get_reference_mode_signed_eq(mode));
837 write_mode(env, get_reference_mode_unsigned_eq(mode));
839 fputc('\n', env->file);
842 fputs("}\n", env->file);
845 static void export_program(io_env_t *env)
850 fputs("\nprogram {\n", f);
851 if (irp_prog_name_is_set()) {
852 fprintf(f, "\tname ");
853 write_string(env, get_irp_name());
857 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
858 ir_type *segment_type = get_segment_type(s);
859 fprintf(f, "\tsegment_type %s ", get_segment_name(s));
860 if (segment_type == NULL) {
863 write_long(env, get_type_nr(segment_type));
870 void ir_export(const char *filename)
872 FILE *file = fopen(filename, "wt");
878 ir_export_file(file, filename);
882 /* Exports the whole irp to the given file in a textual form. */
883 void ir_export_file(FILE *file, const char *outputname)
886 size_t i, n_irgs = get_irp_n_irgs();
893 fputs("\ntypegraph {\n", env.file);
894 type_walk_prog(export_type_or_ent_pre, export_type_or_ent_post, &env);
895 fputs("}\n", env.file);
897 for (i = 0; i < n_irgs; i++) {
898 ir_graph *irg = get_irp_irg(i);
899 ir_type *valuetype = get_irg_value_param_type(irg);
901 fprintf(env.file, "\nirg %ld %ld %ld {\n",
902 get_entity_nr(get_irg_entity(irg)),
903 get_type_nr(get_irg_frame_type(irg)),
904 valuetype == NULL ? -1 : get_type_nr(valuetype));
906 env.ignoreblocks = 0;
907 irg_block_walk_graph(irg, NULL, export_node, &env);
909 env.ignoreblocks = 1;
910 irg_walk_anchors(irg, NULL, export_node, &env);
912 fputs("}\n", env.file);
915 fprintf(env.file, "\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
917 walk_const_code(NULL, export_node, &env);
918 fputs("}\n", env.file);
920 export_program(&env);
923 /* Exports the given irg to the given file. */
924 void ir_export_irg(ir_graph *irg, FILE *file, const char *outputname)
933 fputs("typegraph {\n", env.file);
935 type_walk_irg(irg, export_type_or_ent_pre, export_type_or_ent_post, &env);
937 fprintf(env.file, "}\n\nirg %ld {\n", get_entity_nr(get_irg_entity(irg)));
939 env.ignoreblocks = 0;
940 irg_block_walk_graph(irg, NULL, export_node, &env);
942 env.ignoreblocks = 1;
943 irg_walk_anchors(irg, NULL, export_node, &env);
945 /* TODO: Only output needed constants */
946 fprintf(env.file, "}\n\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
947 walk_const_code(NULL, export_node, &env);
948 fputs("}\n", env.file);
951 static void read_c(io_env_t *env)
953 int c = fgetc(env->file);
959 /** Returns the first non-whitespace character or EOF. **/
960 static void skip_ws(io_env_t *env)
977 static void skip_to(io_env_t *env, char to_ch)
979 while (env->c != to_ch && env->c != EOF) {
984 static int expect_char(io_env_t *env, char ch)
988 parse_error(env, "Unexpected char '%c', expected '%c'\n",
996 #define EXPECT(c) if (expect_char(env, (c))) {} else return 0
998 static char *read_word(io_env_t *env)
1002 assert(obstack_object_size(&env->obst) == 0);
1014 obstack_1grow(&env->obst, c);
1021 obstack_1grow(&env->obst, '\0');
1022 return (char*)obstack_finish(&env->obst);
1025 static char *read_string(io_env_t *env)
1028 if (env->c != '"') {
1029 parse_error(env, "Expected string, got '%c'\n", env->c);
1034 assert(obstack_object_size(&env->obst) == 0);
1035 while (env->c != '"') {
1036 if (env->c == EOF) {
1037 parse_error(env, "Unexpected EOF while parsing string\n");
1041 if (env->c == '\\') {
1045 obstack_1grow(&env->obst, '\n');
1049 obstack_1grow(&env->obst, env->c);
1052 parse_error(env, "Unknown escape sequence '\\%c'\n", env->c);
1057 obstack_1grow(&env->obst, env->c);
1062 obstack_1grow(&env->obst, 0);
1064 return (char*)obstack_finish(&env->obst);
1067 static ident *read_ident(io_env_t *env)
1069 char *str = read_string(env);
1070 ident *res = new_id_from_str(str);
1071 obstack_free(&env->obst, str);
1076 * reads a "quoted string" or alternatively the token NULL
1078 static char *read_string_null(io_env_t *env)
1081 if (env->c == 'N') {
1082 char *str = read_word(env);
1083 if (strcmp(str, "NULL") == 0) {
1084 obstack_free(&env->obst, str);
1087 } else if (env->c == '"') {
1088 return read_string(env);
1091 parse_error(env, "Expected \"string\" or NULL\n");
1095 static ident *read_ident_null(io_env_t *env)
1098 char *str = read_string_null(env);
1102 res = new_id_from_str(str);
1103 obstack_free(&env->obst, str);
1107 static long read_long(io_env_t *env)
1113 if (!isdigit(env->c) && env->c != '-') {
1114 parse_error(env, "Expected number, got '%c'\n", env->c);
1118 assert(obstack_object_size(&env->obst) == 0);
1120 obstack_1grow(&env->obst, env->c);
1122 } while (isdigit(env->c));
1123 obstack_1grow(&env->obst, 0);
1125 str = (char*)obstack_finish(&env->obst);
1127 obstack_free(&env->obst, str);
1132 static int read_int(io_env_t *env)
1134 return (int) read_long(env);
1137 static unsigned read_unsigned(io_env_t *env)
1139 return (unsigned) read_long(env);
1142 static size_t read_size_t(io_env_t *env)
1145 return (size_t) read_unsigned(env);
1148 static void expect_list_begin(io_env_t *env)
1151 if (env->c != '[') {
1152 parse_error(env, "Expected list, got '%c'\n", env->c);
1158 static bool list_has_next(io_env_t *env)
1160 if (feof(env->file)) {
1161 parse_error(env, "Unexpected EOF while reading list");
1165 if (env->c == ']') {
1173 static ir_node *get_node_or_null(io_env_t *env, long nodenr)
1175 ir_node *node = (ir_node *) get_id(env, nodenr);
1176 if (node && node->kind != k_ir_node) {
1177 panic("Irn ID %ld collides with something else in line %d\n",
1183 static ir_node *get_node_or_dummy(io_env_t *env, long nodenr)
1185 ir_node *node = get_node_or_null(env, nodenr);
1187 node = new_r_Dummy(env->irg, mode_X);
1188 set_id(env, nodenr, node);
1193 static ir_type *get_type(io_env_t *env, long typenr)
1195 ir_type *type = (ir_type *) get_id(env, typenr);
1197 panic("unknown type: %ld in line %d\n", typenr, env->line);
1198 else if (type->kind != k_type)
1199 panic("type ID %ld collides with something else in line %d\n",
1204 static ir_type *read_type(io_env_t *env)
1206 return get_type(env, read_long(env));
1209 static ir_entity *get_entity(io_env_t *env, long entnr)
1211 ir_entity *entity = (ir_entity *) get_id(env, entnr);
1212 if (entity == NULL) {
1213 parse_error(env, "unknown entity: %ld\n", entnr);
1215 } else if (entity->kind != k_entity) {
1216 panic("Entity ID %ld collides with something else in line %d\n",
1223 static ir_entity *read_entity(io_env_t *env)
1225 return get_entity(env, read_long(env));
1228 static ir_mode *read_mode(io_env_t *env)
1230 char *str = read_word(env);
1233 n = get_irp_n_modes();
1234 for (i = 0; i < n; i++) {
1235 ir_mode *mode = get_irp_mode(i);
1236 if (strcmp(str, get_mode_name(mode)) == 0) {
1237 obstack_free(&env->obst, str);
1242 parse_error(env, "unknown mode \"%s\"\n", str);
1246 static const char *get_typetag_name(typetag_t typetag)
1249 case tt_align: return "align";
1250 case tt_allocation: return "allocation";
1251 case tt_builtin: return "builtin kind";
1252 case tt_cond_jmp_predicate: return "cond_jmp_predicate";
1253 case tt_initializer: return "initializer kind";
1254 case tt_iro: return "opcode";
1255 case tt_keyword: return "keyword";
1256 case tt_linkage: return "linkage";
1257 case tt_mode_arithmetic: return "mode_arithmetic";
1258 case tt_mode_sort: return "mode_sort";
1259 case tt_pin_state: return "pin state";
1260 case tt_segment: return "segment";
1261 case tt_tpo: return "type";
1262 case tt_type_state: return "type state";
1263 case tt_volatility: return "volatility";
1264 case tt_visibility: return "visibility";
1270 * Read and decode an enum constant.
1272 static unsigned read_enum(io_env_t *env, typetag_t typetag)
1274 char *str = read_word(env);
1275 unsigned code = symbol(str, typetag);
1277 if (code != SYMERROR) {
1278 obstack_free(&env->obst, str);
1282 parse_error(env, "invalid %s: \"%s\"\n", get_typetag_name(typetag), str);
1286 #define read_align(env) ((ir_align) read_enum(env, tt_align))
1287 #define read_allocation(env) ((ir_allocation) read_enum(env, tt_allocation))
1288 #define read_builtin_kind(env) ((ir_builtin_kind) read_enum(env, tt_builtin))
1289 #define read_cond_jmp_predicate(env) ((cond_jmp_predicate) read_enum(env, tt_cond_jmp_predicate))
1290 #define read_initializer_kind(env) ((ir_initializer_kind_t) read_enum(env, tt_initializer))
1291 #define read_mode_arithmetic(env) ((ir_mode_arithmetic) read_enum(env, tt_mode_arithmetic))
1292 #define read_peculiarity(env) ((ir_peculiarity) read_enum(env, tt_peculiarity))
1293 #define read_pin_state(env) ((op_pin_state) read_enum(env, tt_pin_state))
1294 #define read_type_state(env) ((ir_type_state) read_enum(env, tt_type_state))
1295 #define read_variability(env) ((ir_variability) read_enum(env, tt_variability))
1296 #define read_volatility(env) ((ir_volatility) read_enum(env, tt_volatility))
1298 static ir_cons_flags get_cons_flags(io_env_t *env)
1300 ir_cons_flags flags = cons_none;
1302 op_pin_state pinstate = read_pin_state(env);
1304 case op_pin_state_floats: flags |= cons_floats; break;
1305 case op_pin_state_pinned: break;
1307 panic("Error in %d: Invalid pinstate: %s", env->line,
1308 get_op_pin_state_name(pinstate));
1311 if (read_volatility(env) == volatility_is_volatile)
1312 flags |= cons_volatile;
1313 if (read_align(env) == align_non_aligned)
1314 flags |= cons_unaligned;
1319 static ir_tarval *read_tv(io_env_t *env)
1321 ir_mode *tvmode = read_mode(env);
1322 char *str = read_word(env);
1323 ir_tarval *tv = new_tarval_from_str(str, strlen(str), tvmode);
1324 obstack_free(&env->obst, str);
1329 static ir_initializer_t *read_initializer(io_env_t *env)
1331 ir_initializer_kind_t ini_kind = read_initializer_kind(env);
1334 case IR_INITIALIZER_CONST: {
1335 ir_node *irn = get_node_or_dummy(env, read_long(env));
1336 return create_initializer_const(irn);
1339 case IR_INITIALIZER_TARVAL:
1340 return create_initializer_tarval(read_tv(env));
1342 case IR_INITIALIZER_NULL:
1343 return get_initializer_null();
1345 case IR_INITIALIZER_COMPOUND: {
1346 size_t i, n = read_size_t(env);
1347 ir_initializer_t *ini = create_initializer_compound(n);
1348 for (i = 0; i < n; i++) {
1349 ir_initializer_t *curini = read_initializer(env);
1350 set_initializer_compound_value(ini, i, curini);
1356 panic("Unknown initializer kind");
1361 /** Reads a type description and remembers it by its id. */
1362 static void import_type(io_env_t *env)
1366 long typenr = read_long(env);
1367 tp_opcode tpop = (tp_opcode) read_enum(env, tt_tpo);
1368 unsigned size = (unsigned) read_long(env);
1369 unsigned align = (unsigned) read_long(env);
1370 ir_type_state state = read_type_state(env);
1371 unsigned flags = (unsigned) read_long(env);
1375 int ndims = (int) read_long(env);
1376 long elemtypenr = read_long(env);
1377 ir_type *elemtype = get_type(env, elemtypenr);
1379 type = new_type_array(ndims, elemtype);
1380 for (i = 0; i < ndims; i++) {
1381 char *str = read_word(env);
1382 if (strcmp(str, "unknown") != 0) {
1383 long lowerbound = atol(str);
1384 set_array_lower_bound_int(type, i, lowerbound);
1386 obstack_free(&env->obst, str);
1388 str = read_word(env);
1389 if (strcmp(str, "unknown") != 0) {
1390 long upperbound = atol(str);
1391 set_array_upper_bound_int(type, i, upperbound);
1393 obstack_free(&env->obst, str);
1395 set_type_size_bytes(type, size);
1400 ident *id = read_ident_null(env);
1402 if (typenr == (long) IR_SEGMENT_GLOBAL)
1403 type = get_glob_type();
1405 type = new_type_class(id);
1406 set_type_size_bytes(type, size);
1411 unsigned callingconv = (unsigned) read_long(env);
1412 mtp_additional_properties addprops = (mtp_additional_properties) read_long(env);
1413 int nparams = (int) read_long(env);
1414 int nresults = (int) read_long(env);
1417 type = new_type_method(nparams, nresults);
1419 for (i = 0; i < nparams; i++) {
1420 long typenr = read_long(env);
1421 ir_type *paramtype = get_type(env, typenr);
1423 set_method_param_type(type, i, paramtype);
1425 for (i = 0; i < nresults; i++) {
1426 long typenr = read_long(env);
1427 ir_type *restype = get_type(env, typenr);
1429 set_method_res_type(type, i, restype);
1432 variaindex = (int) read_long(env);
1433 if (variaindex != -1) {
1434 set_method_variadicity(type, variadicity_variadic);
1435 if (variaindex != nparams)
1436 set_method_first_variadic_param_index(type, variaindex);
1439 set_method_calling_convention(type, callingconv);
1440 set_method_additional_properties(type, addprops);
1445 ir_mode *mode = read_mode(env);
1446 ir_type *pointsto = get_type(env, read_long(env));
1447 type = new_type_pointer(pointsto);
1448 set_type_mode(type, mode);
1452 case tpo_primitive: {
1453 ir_mode *mode = read_mode(env);
1454 type = new_type_primitive(mode);
1459 ident *id = read_ident_null(env);
1460 type = new_type_struct(id);
1461 set_type_size_bytes(type, size);
1466 ident *id = read_ident_null(env);
1467 type = new_type_union(id);
1468 set_type_size_bytes(type, size);
1473 return; /* ignore unknown type */
1476 parse_error(env, "unknown type kind: \"%d\"\n", tpop);
1481 set_type_alignment_bytes(type, align);
1482 type->flags = flags;
1484 if (state == layout_fixed)
1485 ARR_APP1(ir_type *, env->fixedtypes, type);
1487 set_id(env, typenr, type);
1490 /** Reads an entity description and remembers it by its id. */
1491 static void import_entity(io_env_t *env)
1493 long entnr = read_long(env);
1494 ident *name = read_ident(env);
1495 ident *ld_name = read_ident_null(env);
1496 ir_visibility visibility = ir_visibility_default;
1497 ir_linkage linkage = IR_LINKAGE_DEFAULT;
1506 while (!isdigit(env->c)) {
1507 char *str = read_word(env);
1512 v = symbol(str, tt_visibility);
1513 if (v != SYMERROR) {
1514 visibility = (ir_visibility)v;
1517 v = symbol(str, tt_linkage);
1518 if (v != SYMERROR) {
1519 linkage |= (ir_linkage)v;
1522 printf("Parser error, expected visibility or linkage, got '%s'\n",
1527 typenr = read_long(env);
1528 ownertypenr = read_long(env);
1530 type = get_type(env, typenr);
1531 ownertype = !ownertypenr ? get_glob_type() : get_type(env, ownertypenr);
1532 entity = new_entity(ownertype, name, type);
1534 if (ld_name != NULL)
1535 set_entity_ld_ident(entity, ld_name);
1536 set_entity_offset(entity, (int) read_long(env));
1537 set_entity_offset_bits_remainder(entity, (unsigned char) read_long(env));
1538 set_entity_compiler_generated(entity, (int) read_long(env));
1539 set_entity_volatility(entity, read_volatility(env));
1540 set_entity_visibility(entity, visibility);
1541 set_entity_linkage(entity, linkage);
1543 str = read_word(env);
1544 if (strcmp(str, "initializer") == 0) {
1545 set_entity_initializer(entity, read_initializer(env));
1546 } else if (strcmp(str, "compoundgraph") == 0) {
1547 int n = (int) read_long(env);
1549 for (i = 0; i < n; i++) {
1550 ir_entity *member = get_entity(env, read_long(env));
1551 ir_node *irn = get_node_or_dummy(env, read_long(env));
1552 add_compound_ent_value(entity, irn, member);
1554 } else if (strcmp(str, "none") == 0) {
1557 parse_error(env, "expected 'initializer', 'compoundgraph' or 'none' got '%s'\n", str);
1561 set_id(env, entnr, entity);
1564 /** Parses the whole type graph. */
1565 static int parse_typegraph(io_env_t *env)
1567 ir_graph *old_irg = env->irg;
1572 env->irg = get_const_code_irg();
1574 /* parse all types first */
1577 if (env->c == '}') {
1582 kwkind = (keyword_t) read_enum(env, tt_keyword);
1593 parse_error(env, "type graph element not supported yet: %d\n", kwkind);
1602 static int read_node_header(io_env_t *env, long *nodenr, ir_node ***preds,
1603 const char **nodename)
1607 *nodename = read_word(env);
1608 *nodenr = read_long(env);
1610 ARR_RESIZE(ir_node*, *preds, 0);
1612 expect_list_begin(env);
1613 for (numpreds = 0; list_has_next(env); numpreds++) {
1614 long val = read_long(env);
1615 ir_node *pred = get_node_or_dummy(env, val);
1616 ARR_APP1(ir_node*, *preds, pred);
1622 static ir_node *read_ASM(io_env_t *env, int numpreds, ir_node **preds)
1625 ir_asm_constraint *input_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1626 ir_asm_constraint *output_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1627 ident **clobbers = NEW_ARR_F(ident*, 0);
1629 ident *asm_text = read_ident(env);
1631 expect_list_begin(env);
1632 while (list_has_next(env)) {
1633 ir_asm_constraint constraint;
1634 constraint.pos = read_unsigned(env);
1635 constraint.constraint = read_ident(env);
1636 constraint.mode = read_mode(env);
1637 ARR_APP1(ir_asm_constraint, input_constraints, constraint);
1640 expect_list_begin(env);
1641 while (list_has_next(env)) {
1642 ir_asm_constraint constraint;
1643 constraint.pos = read_unsigned(env);
1644 constraint.constraint = read_ident(env);
1645 constraint.mode = read_mode(env);
1646 ARR_APP1(ir_asm_constraint, output_constraints, constraint);
1649 expect_list_begin(env);
1650 while (list_has_next(env)) {
1651 ident *clobber = read_ident(env);
1652 ARR_APP1(ident*, clobbers, clobber);
1655 assert(ARR_LEN(input_constraints) == (size_t)numpreds-1);
1657 newnode = new_r_ASM(preds[0], numpreds-1, preds+1,
1659 ARR_LEN(output_constraints),
1664 DEL_ARR_F(clobbers);
1665 DEL_ARR_F(output_constraints);
1666 DEL_ARR_F(input_constraints);
1670 /** Parses an IRG. */
1671 static int parse_graph(io_env_t *env, ir_graph *irg)
1673 ir_node **preds = NEW_ARR_F(ir_node*,0);
1674 int i, numpreds, ret = 1;
1676 const char *nodename;
1677 ir_node *node, *newnode;
1685 if (env->c == '}') {
1690 numpreds = read_node_header(env, &nodenr, &preds, &nodename);
1692 node = get_node_or_null(env, nodenr);
1697 switch (symbol(nodename, tt_iro)) {
1699 ir_node *newendblock = preds[0];
1700 newnode = get_irg_end(irg);
1701 exchange(get_nodes_block(newnode), newendblock);
1702 for (i = 1; i < numpreds; i++)
1703 add_irn_n(newnode, preds[i]);
1708 ir_node *newstartblock = preds[0];
1709 newnode = get_irg_start(irg);
1710 exchange(get_nodes_block(newnode), newstartblock);
1715 newnode = new_r_Block(irg, numpreds, preds);
1719 newnode = irg->anchor;
1720 for (i = 1; i < numpreds; i++)
1721 set_irn_n(newnode, i-1, preds[i]);
1722 set_nodes_block(newnode, preds[0]);
1725 case iro_SymConst: {
1726 long entnr = read_long(env);
1727 union symconst_symbol sym;
1728 sym.entity_p = get_entity(env, entnr);
1729 newnode = new_r_SymConst(irg, mode_P, sym, symconst_addr_ent);
1734 ir_mode *mode = read_mode(env);
1735 long pn = read_long(env);
1736 newnode = new_r_Proj(preds[1], mode, pn);
1737 /* explicitely set block, since preds[1] might be a dummy node
1738 * which is always in the startblock */
1739 set_nodes_block(newnode, preds[0]);
1744 newnode = read_ASM(env, numpreds, preds);
1747 #include "gen_irio_import.inl"
1757 parse_error(env, "node type not supported yet: %s\n", nodename);
1762 exchange(node, newnode);
1763 /* Always update hash entry to avoid more uses of id nodes */
1764 set_id(env, nodenr, newnode);
1772 static int parse_modes(io_env_t *env)
1780 if (env->c == '}') {
1785 kwkind = (keyword_t) read_enum(env, tt_keyword);
1788 const char *name = read_string(env);
1789 ir_mode_sort sort = (ir_mode_sort)read_enum(env, tt_mode_sort);
1790 int size = read_long(env);
1791 int sign = read_long(env);
1792 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1793 unsigned modulo_shift = read_long(env);
1794 int vector_elems = read_long(env);
1797 if (vector_elems != 1) {
1798 panic("no support for import of vector modes yes");
1801 mode = new_ir_mode(name, sort, size, sign, arith, modulo_shift);
1802 if (mode_is_reference(mode)) {
1803 set_reference_mode_signed_eq(mode, read_mode(env));
1804 set_reference_mode_unsigned_eq(mode, read_mode(env));
1817 static int parse_program(io_env_t *env)
1825 if (env->c == '}') {
1830 kwkind = (keyword_t) read_enum(env, tt_keyword);
1832 case kw_segment_type: {
1833 ir_segment_t segment = (ir_segment_t) read_enum(env, tt_segment);
1834 ir_type *type = read_type(env);
1835 set_segment_type(segment, type);
1839 parse_error(env, "unexpected keyword %d\n", kwkind);
1846 void ir_import(const char *filename)
1848 FILE *file = fopen(filename, "rt");
1854 ir_import_file(file, filename);
1859 void ir_import_file(FILE *input, const char *inputname)
1861 int oldoptimize = get_optimize();
1862 firm_verification_t oldver = get_node_verification_mode();
1864 io_env_t *env = &ioenv;
1869 memset(env, 0, sizeof(*env));
1870 obstack_init(&env->obst);
1871 env->idset = new_set(id_cmp, 128);
1872 env->fixedtypes = NEW_ARR_F(ir_type *, 0);
1873 env->inputname = inputname;
1877 /* read first character */
1881 do_node_verification(FIRM_VERIFICATION_OFF);
1890 kw = (keyword_t)read_enum(env, tt_keyword);
1893 if (!parse_modes(env)) goto end;
1897 if (!parse_typegraph(env)) goto end;
1902 ir_entity *irgent = get_entity(env, read_long(env));
1904 ir_graph *irg = new_ir_graph(irgent, 0);
1905 set_irg_frame_type(irg, get_type(env, read_long(env)));
1906 valuetypeid = read_long(env);
1907 if (valuetypeid != -1)
1908 set_method_value_param_type(get_entity_type(irgent),
1909 get_type(env, valuetypeid));
1911 if (!parse_graph(env, irg)) goto end;
1916 ir_graph *constirg = get_const_code_irg();
1917 long bodyblockid = read_long(env);
1918 set_id(env, bodyblockid, constirg->current_block);
1919 if (!parse_graph(env, constirg)) goto end;
1928 parse_error(env, "Unexpected keyword %d at toplevel\n", kw);
1935 n = ARR_LEN(env->fixedtypes);
1936 for (i = 0; i < n; i++)
1937 set_type_state(env->fixedtypes[i], layout_fixed);
1939 DEL_ARR_F(env->fixedtypes);
1941 del_set(env->idset);
1943 irp_finalize_cons();
1945 do_node_verification(oldver);
1946 set_optimize(oldoptimize);
1948 obstack_free(&env->obst, NULL);