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
36 #include "irgraph_t.h"
49 #define SYMERROR ((unsigned) ~0)
51 typedef struct io_env_t
53 int c; /**< currently read char */
55 set *idset; /**< id_entry set, which maps from file ids to new Firm elements */
57 const char *inputname;
64 typedef enum typetag_t
69 tt_cond_jmp_predicate,
83 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_segment, "global", IR_SEGMENT_GLOBAL);
185 INSERT(tt_segment, "thread_local", IR_SEGMENT_THREAD_LOCAL);
186 INSERT(tt_segment, "constructors", IR_SEGMENT_CONSTRUCTORS);
187 INSERT(tt_segment, "destructors", IR_SEGMENT_DESTRUCTORS);
189 INSERT(tt_linkage, "constant", IR_LINKAGE_CONSTANT);
190 INSERT(tt_linkage, "weak", IR_LINKAGE_WEAK);
191 INSERT(tt_linkage, "garbage_collect", IR_LINKAGE_GARBAGE_COLLECT);
192 INSERT(tt_linkage, "merge", IR_LINKAGE_MERGE);
193 INSERT(tt_linkage, "hidden_user", IR_LINKAGE_HIDDEN_USER);
195 INSERT(tt_visibility, "local", ir_visibility_local);
196 INSERT(tt_visibility, "external", ir_visibility_external);
197 INSERT(tt_visibility, "default", ir_visibility_default);
198 INSERT(tt_visibility, "private", ir_visibility_private);
200 INSERTKEYWORD(constirg);
201 INSERTKEYWORD(entity);
203 INSERTKEYWORD(int_mode);
204 INSERTKEYWORD(float_mode);
205 INSERTKEYWORD(reference_mode);
206 INSERTKEYWORD(modes);
208 INSERTKEYWORD(typegraph);
209 INSERTKEYWORD(program);
210 INSERTKEYWORD(segment_type);
212 #include "gen_irio_lex.inl"
214 INSERTENUM(tt_align, align_non_aligned);
215 INSERTENUM(tt_align, align_is_aligned);
217 INSERTENUM(tt_builtin, ir_bk_trap);
218 INSERTENUM(tt_builtin, ir_bk_debugbreak);
219 INSERTENUM(tt_builtin, ir_bk_return_address);
220 INSERTENUM(tt_builtin, ir_bk_frame_address);
221 INSERTENUM(tt_builtin, ir_bk_prefetch);
222 INSERTENUM(tt_builtin, ir_bk_ffs);
223 INSERTENUM(tt_builtin, ir_bk_clz);
224 INSERTENUM(tt_builtin, ir_bk_ctz);
225 INSERTENUM(tt_builtin, ir_bk_popcount);
226 INSERTENUM(tt_builtin, ir_bk_parity);
227 INSERTENUM(tt_builtin, ir_bk_bswap);
228 INSERTENUM(tt_builtin, ir_bk_inport);
229 INSERTENUM(tt_builtin, ir_bk_outport);
230 INSERTENUM(tt_builtin, ir_bk_inner_trampoline);
232 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_NONE);
233 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_TRUE);
234 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_FALSE);
236 INSERTENUM(tt_initializer, IR_INITIALIZER_CONST);
237 INSERTENUM(tt_initializer, IR_INITIALIZER_TARVAL);
238 INSERTENUM(tt_initializer, IR_INITIALIZER_NULL);
239 INSERTENUM(tt_initializer, IR_INITIALIZER_COMPOUND);
241 INSERTENUM(tt_mode_arithmetic, irma_uninitialized);
242 INSERTENUM(tt_mode_arithmetic, irma_none);
243 INSERTENUM(tt_mode_arithmetic, irma_twos_complement);
244 INSERTENUM(tt_mode_arithmetic, irma_ieee754);
246 INSERTENUM(tt_pin_state, op_pin_state_floats);
247 INSERTENUM(tt_pin_state, op_pin_state_pinned);
248 INSERTENUM(tt_pin_state, op_pin_state_exc_pinned);
249 INSERTENUM(tt_pin_state, op_pin_state_mem_pinned);
251 INSERTENUM(tt_type_state, layout_undefined);
252 INSERTENUM(tt_type_state, layout_fixed);
254 INSERTENUM(tt_volatility, volatility_non_volatile);
255 INSERTENUM(tt_volatility, volatility_is_volatile);
262 static const char *get_segment_name(ir_segment_t segment)
265 case IR_SEGMENT_GLOBAL: return "global";
266 case IR_SEGMENT_THREAD_LOCAL: return "thread_local";
267 case IR_SEGMENT_CONSTRUCTORS: return "constructors";
268 case IR_SEGMENT_DESTRUCTORS: return "destructors";
270 return "INVALID_SEGMENT";
273 static const char *get_visibility_name(ir_visibility visibility)
275 switch (visibility) {
276 case ir_visibility_local: return "local";
277 case ir_visibility_external: return "external";
278 case ir_visibility_default: return "default";
279 case ir_visibility_private: return "private";
281 return "INVALID_VISIBILITY";
284 /** Returns the according symbol value for the given string and tag, or SYMERROR if none was found. */
285 static unsigned symbol(const char *str, typetag_t typetag)
287 symbol_t key, *entry;
290 key.typetag = typetag;
292 entry = (symbol_t*)set_find(symtbl, &key, sizeof(key), firm_fnv_hash_str(str) + typetag * 17);
293 return entry ? entry->code : SYMERROR;
296 static void *get_id(io_env_t *env, long id)
298 id_entry key, *entry;
301 entry = (id_entry*)set_find(env->idset, &key, sizeof(key), (unsigned) id);
302 return entry ? entry->elem : NULL;
305 static void set_id(io_env_t *env, long id, void *elem)
310 set_insert(env->idset, &key, sizeof(key), (unsigned) id);
313 static void write_long(io_env_t *env, long value)
315 fprintf(env->file, "%ld ", value);
318 static void write_int(io_env_t *env, int value)
320 fprintf(env->file, "%d ", value);
323 static void write_unsigned(io_env_t *env, unsigned value)
325 fprintf(env->file, "%u ", value);
328 static void write_entity_ref(io_env_t *env, ir_entity *entity)
330 write_long(env, get_entity_nr(entity));
333 static void write_type_ref(io_env_t *env, ir_type *type)
335 write_long(env, get_type_nr(type));
338 static void write_string(io_env_t *env, const char *string)
341 fputc('"', env->file);
342 for (c = string; *c != '\0'; ++c) {
345 fputc('\\', env->file);
346 fputc('n', env->file);
350 fputc('\\', env->file);
353 fputc(*c, env->file);
357 fputc('"', env->file);
360 static void write_ident(io_env_t *env, ident *id)
362 write_string(env, get_id_str(id));
363 fputc(' ', env->file);
366 static void write_ident_null(io_env_t *env, ident *id)
369 fputs("NULL ", env->file);
371 write_ident(env, id);
375 static void write_mode(io_env_t *env, ir_mode *mode)
377 write_string(env, get_mode_name(mode));
378 fputc(' ', env->file);
381 static void write_tarval(io_env_t *env, ir_tarval *tv)
384 write_mode(env, get_tarval_mode(tv));
385 tarval_snprintf(buf, sizeof(buf), tv);
386 fputs(buf, env->file);
387 fputc(' ', env->file);
390 static void write_align(io_env_t *env, ir_align align)
392 fputs(get_align_name(align), env->file);
393 fputc(' ', env->file);
396 static void write_builtin_kind(io_env_t *env, ir_node *irn)
398 fputs(get_builtin_kind_name(get_Builtin_kind(irn)), env->file);
399 fputc(' ', env->file);
402 static void write_cond_jmp_predicate(io_env_t *env, ir_node *irn)
404 fputs(get_cond_jmp_predicate_name(get_Cond_jmp_pred(irn)), env->file);
405 fputc(' ', env->file);
408 static void write_list_begin(io_env_t *env)
410 fputs("[", env->file);
413 static void write_list_end(io_env_t *env)
415 fputs("] ", env->file);
418 static void write_initializer(io_env_t *env, ir_initializer_t *ini)
421 ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
423 fputs(get_initializer_kind_name(ini_kind), f);
427 case IR_INITIALIZER_CONST:
428 write_long(env, get_irn_node_nr(get_initializer_const_value(ini)));
431 case IR_INITIALIZER_TARVAL:
432 write_tarval(env, get_initializer_tarval_value(ini));
435 case IR_INITIALIZER_NULL:
438 case IR_INITIALIZER_COMPOUND: {
439 size_t i, n = get_initializer_compound_n_entries(ini);
440 ir_fprintf(f, "%zu ", n);
441 for (i = 0; i < n; ++i)
442 write_initializer(env, get_initializer_compound_value(ini, i));
447 panic("Unknown initializer kind");
451 static void write_pin_state(io_env_t *env, ir_node *irn)
453 fputs(get_op_pin_state_name(get_irn_pinned(irn)), env->file);
454 fputc(' ', env->file);
457 static void write_volatility(io_env_t *env, ir_volatility vol)
459 fputs(get_volatility_name(vol), env->file);
460 fputc(' ', env->file);
463 static void export_type_common(io_env_t *env, ir_type *tp)
465 fprintf(env->file, "\ttype %ld %s %u %u %s %u ",
467 get_type_tpop_name(tp),
468 get_type_size_bytes(tp),
469 get_type_alignment_bytes(tp),
470 get_type_state_name(get_type_state(tp)),
474 static void export_type_pre(io_env_t *env, ir_type *tp)
478 /* skip types to be handled by post walker */
479 switch (get_type_tpop_code(tp)) {
488 export_type_common(env, tp);
490 switch (get_type_tpop_code(tp)) {
491 case tpo_uninitialized:
492 panic("invalid type found");
495 write_ident_null(env, get_compound_ident(tp));
499 write_mode(env, get_type_mode(tp));
504 case tpo_enumeration:
505 write_ident_null(env, get_compound_ident(tp));
519 static void export_type_post(io_env_t *env, ir_type *tp)
524 /* skip types already handled by pre walker */
525 switch (get_type_tpop_code(tp)) {
531 case tpo_uninitialized:
538 case tpo_enumeration:
542 export_type_common(env, tp);
544 switch (get_type_tpop_code(tp)) {
546 size_t n = get_array_n_dimensions(tp);
547 ir_fprintf(f, "%zu %ld ", n, get_type_nr(get_array_element_type(tp)));
548 for (i = 0; i < n; i++) {
549 ir_node *lower = get_array_lower_bound(tp, i);
550 ir_node *upper = get_array_upper_bound(tp, i);
553 write_long(env, get_tarval_long(get_Const_tarval(lower)));
555 panic("Lower array bound is not constant");
558 write_long(env, get_tarval_long(get_Const_tarval(upper)));
559 else if (is_Unknown(upper))
560 fputs("unknown ", f);
562 panic("Upper array bound is not constant");
568 size_t nparams = get_method_n_params(tp);
569 size_t nresults = get_method_n_ress(tp);
570 ir_fprintf(f, "%u %u %zu %zu ", get_method_calling_convention(tp),
571 get_method_additional_properties(tp), nparams, nresults);
572 for (i = 0; i < nparams; i++)
573 write_long(env, get_type_nr(get_method_param_type(tp, i)));
574 for (i = 0; i < nresults; i++)
575 write_long(env, get_type_nr(get_method_res_type(tp, i)));
576 ir_fprintf(f, "%u ", get_method_variadicity(tp));
581 write_mode(env, get_type_mode(tp));
582 write_long(env, get_type_nr(get_pointer_points_to_type(tp)));
585 case tpo_enumeration:
586 fprintf(stderr, "Enumeration type not handled yet by exporter\n");
590 printf("export_type: Unknown type code \"%s\".\n",
591 get_type_tpop_name(tp));
597 static void export_entity(io_env_t *env, ir_entity *ent)
599 FILE *file = env->file;
600 ir_type *owner = get_entity_owner(ent);
601 ir_visibility visibility = get_entity_visibility(ent);
602 ir_linkage linkage = get_entity_linkage(ent);
604 /* we don't dump array_element_ent entities. They're a strange concept
605 * and lead to cycles in type_graph.
607 if (is_Array_type(owner))
610 fprintf(env->file, "\tentity ");
611 write_long(env, get_entity_nr(ent));
612 write_ident_null(env, get_entity_ident(ent));
613 if (!entity_has_ld_ident(ent)) {
614 write_ident_null(env, NULL);
616 write_ident_null(env, get_entity_ld_ident(ent));
619 /* visibility + linkage */
620 if (visibility != ir_visibility_default) {
621 fprintf(file, "%s ", get_visibility_name(visibility));
623 if (linkage & IR_LINKAGE_CONSTANT)
624 fputs("constant ", file);
625 if (linkage & IR_LINKAGE_WEAK)
626 fputs("weak ", file);
627 if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
628 fputs("garbage_collect ", file);
629 if (linkage & IR_LINKAGE_MERGE)
630 fputs("merge ", file);
631 if (linkage & IR_LINKAGE_HIDDEN_USER)
632 fputs("hidden_user ", file);
634 fprintf(file, "%ld %ld %d %u %d %s ",
635 get_type_nr(get_entity_type(ent)),
637 get_entity_offset(ent),
638 (unsigned) get_entity_offset_bits_remainder(ent),
639 is_entity_compiler_generated(ent),
640 get_volatility_name(get_entity_volatility(ent)));
642 if (ent->initializer != NULL) {
643 fputs("initializer ", env->file);
644 write_initializer(env, get_entity_initializer(ent));
645 } else if (entity_has_compound_ent_values(ent)) {
646 size_t i, n = get_compound_ent_n_values(ent);
647 fputs("compoundgraph ", env->file);
648 ir_fprintf(env->file, "%zu ", n);
649 for (i = 0; i < n; i++) {
650 ir_entity *member = get_compound_ent_value_member(ent, i);
651 ir_node *irn = get_compound_ent_value(ent, i);
652 fprintf(env->file, "%ld %ld ", get_entity_nr(member), get_irn_node_nr(irn));
655 fputs("none", env->file);
658 fputc('\n', env->file);
661 static void export_type_or_ent_pre(type_or_ent tore, void *ctx)
663 io_env_t *env = (io_env_t *) ctx;
664 if (get_kind(tore.typ) == k_type)
665 export_type_pre(env, tore.typ);
668 static void export_type_or_ent_post(type_or_ent tore, void *ctx)
670 io_env_t *env = (io_env_t *) ctx;
672 switch (get_kind(tore.ent)) {
674 export_entity(env, tore.ent);
678 export_type_post(env, tore.typ);
682 panic("export_type_or_ent_post: Unknown type or entity.");
686 static void export_ASM(io_env_t *env, ir_node *node)
688 ir_asm_constraint *input_constraints = get_ASM_input_constraints(node);
689 ir_asm_constraint *output_constraints = get_ASM_output_constraints(node);
690 ident **clobbers = get_ASM_clobbers(node);
691 int n_input_constraints = get_ASM_n_input_constraints(node);
692 int n_output_constraints = get_ASM_n_output_constraints(node);
693 int n_clobbers = get_ASM_n_clobbers(node);
696 write_ident(env, get_ASM_text(node));
697 write_list_begin(env);
698 for (i = 0; i < n_input_constraints; ++i) {
699 const ir_asm_constraint *constraint = &input_constraints[i];
700 write_unsigned(env, constraint->pos);
701 write_ident(env, constraint->constraint);
702 write_mode(env, constraint->mode);
706 write_list_begin(env);
707 for (i = 0; i < n_output_constraints; ++i) {
708 const ir_asm_constraint *constraint = &output_constraints[i];
709 write_unsigned(env, constraint->pos);
710 write_ident(env, constraint->constraint);
711 write_mode(env, constraint->mode);
715 write_list_begin(env);
716 for (i = 0; i < n_clobbers; ++i) {
717 ident *clobber = clobbers[i];
718 write_ident(env, clobber);
724 * Walker: exports every node.
726 static void export_node(ir_node *irn, void *ctx)
728 io_env_t *env = (io_env_t *) ctx;
730 unsigned opcode = get_irn_opcode(irn);
732 if (env->ignoreblocks && opcode == iro_Block)
735 fprintf(env->file, "\t%s ", get_irn_opname(irn));
736 write_long(env, get_irn_node_nr(irn));
738 write_list_begin(env);
739 n = get_irn_arity(irn);
740 if (!is_Block(irn)) {
741 ir_node *block = get_nodes_block(irn);
742 write_long(env, get_irn_node_nr(block));
745 for (i = 0; i < n; i++) {
746 ir_node *pred = get_irn_n(irn, i);
748 /* Anchor node may have NULL predecessors */
749 assert(is_Anchor(irn));
750 fputs("-1 ", env->file);
752 write_long(env, get_irn_node_nr(pred));
757 fputs("{ ", env->file);
766 /* TODO: only symconst_addr_ent implemented yet */
767 assert(get_SymConst_kind(irn) == symconst_addr_ent);
768 fprintf(env->file, "%ld ", get_entity_nr(get_SymConst_entity(irn)));
769 write_mode(env, get_irn_mode(irn));
772 write_mode(env, get_irn_mode(irn));
773 fprintf(env->file, "%ld ", get_Proj_proj(irn));
776 export_ASM(env, irn);
778 #include "gen_irio_export.inl"
780 panic("no export code for node %+F\n", irn);
782 fputs("}\n", env->file);
785 static void export_modes(io_env_t *env)
787 size_t i, n_modes = get_irp_n_modes();
789 fputs("modes {\n", env->file);
791 for (i = 0; i < n_modes; i++) {
792 ir_mode *mode = get_irp_mode(i);
794 if (mode_is_int(mode)) {
795 fprintf(env->file, "\tint_mode ");
796 write_string(env, get_mode_name(mode));
797 fprintf(env->file, "%s %u %d %u ",
798 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
799 get_mode_size_bits(mode), get_mode_sign(mode),
800 get_mode_modulo_shift(mode));
801 } else if (mode_is_reference(mode)) {
802 fprintf(env->file, "\treference_mode ");
803 write_string(env, get_mode_name(mode));
804 fprintf(env->file, "%s %u %u ",
805 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
806 get_mode_size_bits(mode),
807 get_mode_modulo_shift(mode));
808 write_mode(env, get_reference_mode_signed_eq(mode));
809 write_mode(env, get_reference_mode_unsigned_eq(mode));
810 write_int(env, (mode == mode_P ? 1 : 0));
811 } else if (mode_is_float(mode)) {
812 fprintf(env->file, "\tfloat_mode ");
813 write_string(env, get_mode_name(mode));
814 fprintf(env->file, "%s %u %u ",
815 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
816 get_mode_exponent_size(mode),
817 get_mode_mantissa_size(mode));
819 /* skip "internal" modes */
821 fputc('\n', env->file);
824 fputs("}\n", env->file);
827 static void export_program(io_env_t *env)
832 fputs("\nprogram {\n", f);
833 if (irp_prog_name_is_set()) {
834 fprintf(f, "\tname ");
835 write_string(env, get_irp_name());
839 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
840 ir_type *segment_type = get_segment_type(s);
841 fprintf(f, "\tsegment_type %s ", get_segment_name(s));
842 if (segment_type == NULL) {
845 write_long(env, get_type_nr(segment_type));
852 void ir_export(const char *filename)
854 FILE *file = fopen(filename, "wt");
860 ir_export_file(file, filename);
864 /* Exports the whole irp to the given file in a textual form. */
865 void ir_export_file(FILE *file, const char *outputname)
868 size_t i, n_irgs = get_irp_n_irgs();
875 fputs("\ntypegraph {\n", env.file);
876 type_walk_prog(export_type_or_ent_pre, export_type_or_ent_post, &env);
877 fputs("}\n", env.file);
879 for (i = 0; i < n_irgs; i++) {
880 ir_graph *irg = get_irp_irg(i);
882 fprintf(env.file, "\nirg %ld %ld {\n",
883 get_entity_nr(get_irg_entity(irg)),
884 get_type_nr(get_irg_frame_type(irg)));
886 env.ignoreblocks = 0;
887 irg_block_walk_graph(irg, NULL, export_node, &env);
889 env.ignoreblocks = 1;
890 irg_walk_anchors(irg, NULL, export_node, &env);
892 fputs("}\n", env.file);
895 fprintf(env.file, "\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
897 walk_const_code(NULL, export_node, &env);
898 fputs("}\n", env.file);
900 export_program(&env);
903 /* Exports the given irg to the given file. */
904 void ir_export_irg(ir_graph *irg, FILE *file, const char *outputname)
913 fputs("typegraph {\n", env.file);
915 type_walk_irg(irg, export_type_or_ent_pre, export_type_or_ent_post, &env);
917 fprintf(env.file, "}\n\nirg %ld {\n", get_entity_nr(get_irg_entity(irg)));
919 env.ignoreblocks = 0;
920 irg_block_walk_graph(irg, NULL, export_node, &env);
922 env.ignoreblocks = 1;
923 irg_walk_anchors(irg, NULL, export_node, &env);
925 /* TODO: Only output needed constants */
926 fprintf(env.file, "}\n\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
927 walk_const_code(NULL, export_node, &env);
928 fputs("}\n", env.file);
931 static void read_c(io_env_t *env)
933 int c = fgetc(env->file);
939 /** Returns the first non-whitespace character or EOF. **/
940 static void skip_ws(io_env_t *env)
957 static void skip_to(io_env_t *env, char to_ch)
959 while (env->c != to_ch && env->c != EOF) {
964 static int expect_char(io_env_t *env, char ch)
968 parse_error(env, "Unexpected char '%c', expected '%c'\n",
976 #define EXPECT(c) if (expect_char(env, (c))) {} else return 0
978 static char *read_word(io_env_t *env)
982 assert(obstack_object_size(&env->obst) == 0);
994 obstack_1grow(&env->obst, c);
1001 obstack_1grow(&env->obst, '\0');
1002 return (char*)obstack_finish(&env->obst);
1005 static char *read_string(io_env_t *env)
1008 if (env->c != '"') {
1009 parse_error(env, "Expected string, got '%c'\n", env->c);
1014 assert(obstack_object_size(&env->obst) == 0);
1015 while (env->c != '"') {
1016 if (env->c == EOF) {
1017 parse_error(env, "Unexpected EOF while parsing string\n");
1021 if (env->c == '\\') {
1025 obstack_1grow(&env->obst, '\n');
1029 obstack_1grow(&env->obst, env->c);
1032 parse_error(env, "Unknown escape sequence '\\%c'\n", env->c);
1036 obstack_1grow(&env->obst, env->c);
1041 obstack_1grow(&env->obst, 0);
1043 return (char*)obstack_finish(&env->obst);
1046 static ident *read_ident(io_env_t *env)
1048 char *str = read_string(env);
1049 ident *res = new_id_from_str(str);
1050 obstack_free(&env->obst, str);
1055 * reads a "quoted string" or alternatively the token NULL
1057 static char *read_string_null(io_env_t *env)
1060 if (env->c == 'N') {
1061 char *str = read_word(env);
1062 if (strcmp(str, "NULL") == 0) {
1063 obstack_free(&env->obst, str);
1066 } else if (env->c == '"') {
1067 return read_string(env);
1070 parse_error(env, "Expected \"string\" or NULL\n");
1074 static ident *read_ident_null(io_env_t *env)
1077 char *str = read_string_null(env);
1081 res = new_id_from_str(str);
1082 obstack_free(&env->obst, str);
1086 static long read_long(io_env_t *env)
1092 if (!isdigit(env->c) && env->c != '-') {
1093 parse_error(env, "Expected number, got '%c'\n", env->c);
1097 assert(obstack_object_size(&env->obst) == 0);
1099 obstack_1grow(&env->obst, env->c);
1101 } while (isdigit(env->c));
1102 obstack_1grow(&env->obst, 0);
1104 str = (char*)obstack_finish(&env->obst);
1106 obstack_free(&env->obst, str);
1111 static int read_int(io_env_t *env)
1113 return (int) read_long(env);
1116 static unsigned read_unsigned(io_env_t *env)
1118 return (unsigned) read_long(env);
1121 static size_t read_size_t(io_env_t *env)
1124 return (size_t) read_unsigned(env);
1127 static void expect_list_begin(io_env_t *env)
1130 if (env->c != '[') {
1131 parse_error(env, "Expected list, got '%c'\n", env->c);
1137 static bool list_has_next(io_env_t *env)
1139 if (feof(env->file)) {
1140 parse_error(env, "Unexpected EOF while reading list");
1144 if (env->c == ']') {
1152 static ir_node *get_node_or_null(io_env_t *env, long nodenr)
1154 ir_node *node = (ir_node *) get_id(env, nodenr);
1155 if (node && node->kind != k_ir_node) {
1156 panic("Irn ID %ld collides with something else in line %d\n",
1162 static ir_node *get_node_or_dummy(io_env_t *env, long nodenr)
1164 ir_node *node = get_node_or_null(env, nodenr);
1166 node = new_r_Dummy(env->irg, mode_X);
1167 set_id(env, nodenr, node);
1172 static ir_type *get_type(io_env_t *env, long typenr)
1174 ir_type *type = (ir_type *) get_id(env, typenr);
1176 panic("unknown type: %ld in line %d\n", typenr, env->line);
1177 else if (type->kind != k_type)
1178 panic("type ID %ld collides with something else in line %d\n",
1183 static ir_type *read_type(io_env_t *env)
1185 return get_type(env, read_long(env));
1188 static ir_entity *get_entity(io_env_t *env, long entnr)
1190 ir_entity *entity = (ir_entity *) get_id(env, entnr);
1191 if (entity == NULL) {
1192 parse_error(env, "unknown entity: %ld\n", entnr);
1194 } else if (entity->kind != k_entity) {
1195 panic("Entity ID %ld collides with something else in line %d\n",
1202 static ir_entity *read_entity(io_env_t *env)
1204 return get_entity(env, read_long(env));
1207 static ir_mode *read_mode(io_env_t *env)
1209 char *str = read_string(env);
1212 n = get_irp_n_modes();
1213 for (i = 0; i < n; i++) {
1214 ir_mode *mode = get_irp_mode(i);
1215 if (strcmp(str, get_mode_name(mode)) == 0) {
1216 obstack_free(&env->obst, str);
1221 parse_error(env, "unknown mode \"%s\"\n", str);
1225 static const char *get_typetag_name(typetag_t typetag)
1228 case tt_align: return "align";
1229 case tt_allocation: return "allocation";
1230 case tt_builtin: return "builtin kind";
1231 case tt_cond_jmp_predicate: return "cond_jmp_predicate";
1232 case tt_initializer: return "initializer kind";
1233 case tt_iro: return "opcode";
1234 case tt_keyword: return "keyword";
1235 case tt_linkage: return "linkage";
1236 case tt_mode_arithmetic: return "mode_arithmetic";
1237 case tt_pin_state: return "pin state";
1238 case tt_segment: return "segment";
1239 case tt_tpo: return "type";
1240 case tt_type_state: return "type state";
1241 case tt_volatility: return "volatility";
1242 case tt_visibility: return "visibility";
1248 * Read and decode an enum constant.
1250 static unsigned read_enum(io_env_t *env, typetag_t typetag)
1252 char *str = read_word(env);
1253 unsigned code = symbol(str, typetag);
1255 if (code != SYMERROR) {
1256 obstack_free(&env->obst, str);
1260 parse_error(env, "invalid %s: \"%s\"\n", get_typetag_name(typetag), str);
1264 #define read_align(env) ((ir_align) read_enum(env, tt_align))
1265 #define read_allocation(env) ((ir_allocation) read_enum(env, tt_allocation))
1266 #define read_builtin_kind(env) ((ir_builtin_kind) read_enum(env, tt_builtin))
1267 #define read_cond_jmp_predicate(env) ((cond_jmp_predicate) read_enum(env, tt_cond_jmp_predicate))
1268 #define read_initializer_kind(env) ((ir_initializer_kind_t) read_enum(env, tt_initializer))
1269 #define read_mode_arithmetic(env) ((ir_mode_arithmetic) read_enum(env, tt_mode_arithmetic))
1270 #define read_peculiarity(env) ((ir_peculiarity) read_enum(env, tt_peculiarity))
1271 #define read_pin_state(env) ((op_pin_state) read_enum(env, tt_pin_state))
1272 #define read_type_state(env) ((ir_type_state) read_enum(env, tt_type_state))
1273 #define read_variability(env) ((ir_variability) read_enum(env, tt_variability))
1274 #define read_volatility(env) ((ir_volatility) read_enum(env, tt_volatility))
1276 static ir_tarval *read_tv(io_env_t *env)
1278 ir_mode *tvmode = read_mode(env);
1279 char *str = read_word(env);
1280 ir_tarval *tv = new_tarval_from_str(str, strlen(str), tvmode);
1281 obstack_free(&env->obst, str);
1286 static ir_initializer_t *read_initializer(io_env_t *env)
1288 ir_initializer_kind_t ini_kind = read_initializer_kind(env);
1291 case IR_INITIALIZER_CONST: {
1292 ir_node *irn = get_node_or_dummy(env, read_long(env));
1293 return create_initializer_const(irn);
1296 case IR_INITIALIZER_TARVAL:
1297 return create_initializer_tarval(read_tv(env));
1299 case IR_INITIALIZER_NULL:
1300 return get_initializer_null();
1302 case IR_INITIALIZER_COMPOUND: {
1303 size_t i, n = read_size_t(env);
1304 ir_initializer_t *ini = create_initializer_compound(n);
1305 for (i = 0; i < n; i++) {
1306 ir_initializer_t *curini = read_initializer(env);
1307 set_initializer_compound_value(ini, i, curini);
1313 panic("Unknown initializer kind");
1318 /** Reads a type description and remembers it by its id. */
1319 static void import_type(io_env_t *env)
1323 long typenr = read_long(env);
1324 tp_opcode tpop = (tp_opcode) read_enum(env, tt_tpo);
1325 unsigned size = (unsigned) read_long(env);
1326 unsigned align = (unsigned) read_long(env);
1327 ir_type_state state = read_type_state(env);
1328 unsigned flags = (unsigned) read_long(env);
1332 int ndims = (int) read_long(env);
1333 long elemtypenr = read_long(env);
1334 ir_type *elemtype = get_type(env, elemtypenr);
1336 type = new_type_array(ndims, elemtype);
1337 for (i = 0; i < ndims; i++) {
1338 char *str = read_word(env);
1339 if (strcmp(str, "unknown") != 0) {
1340 long lowerbound = atol(str);
1341 set_array_lower_bound_int(type, i, lowerbound);
1343 obstack_free(&env->obst, str);
1345 str = read_word(env);
1346 if (strcmp(str, "unknown") != 0) {
1347 long upperbound = atol(str);
1348 set_array_upper_bound_int(type, i, upperbound);
1350 obstack_free(&env->obst, str);
1352 set_type_size_bytes(type, size);
1357 ident *id = read_ident_null(env);
1359 if (typenr == (long) IR_SEGMENT_GLOBAL)
1360 type = get_glob_type();
1362 type = new_type_class(id);
1363 set_type_size_bytes(type, size);
1368 unsigned callingconv = (unsigned) read_long(env);
1369 mtp_additional_properties addprops = (mtp_additional_properties) read_long(env);
1370 int nparams = (int) read_long(env);
1371 int nresults = (int) read_long(env);
1374 type = new_type_method(nparams, nresults);
1376 for (i = 0; i < nparams; i++) {
1377 long ptypenr = read_long(env);
1378 ir_type *paramtype = get_type(env, ptypenr);
1380 set_method_param_type(type, i, paramtype);
1382 for (i = 0; i < nresults; i++) {
1383 long ptypenr = read_long(env);
1384 ir_type *restype = get_type(env, ptypenr);
1386 set_method_res_type(type, i, restype);
1389 variadicity = (int) read_long(env);
1390 set_method_variadicity(type, variadicity);
1392 set_method_calling_convention(type, callingconv);
1393 set_method_additional_properties(type, addprops);
1398 ir_mode *mode = read_mode(env);
1399 ir_type *pointsto = get_type(env, read_long(env));
1400 type = new_type_pointer(pointsto);
1401 set_type_mode(type, mode);
1405 case tpo_primitive: {
1406 ir_mode *mode = read_mode(env);
1407 type = new_type_primitive(mode);
1412 ident *id = read_ident_null(env);
1413 type = new_type_struct(id);
1414 set_type_size_bytes(type, size);
1419 ident *id = read_ident_null(env);
1420 type = new_type_union(id);
1421 set_type_size_bytes(type, size);
1426 return; /* ignore unknown type */
1429 parse_error(env, "unknown type kind: \"%d\"\n", tpop);
1434 set_type_alignment_bytes(type, align);
1435 type->flags = flags;
1437 if (state == layout_fixed)
1438 ARR_APP1(ir_type *, env->fixedtypes, type);
1440 set_id(env, typenr, type);
1443 /** Reads an entity description and remembers it by its id. */
1444 static void import_entity(io_env_t *env)
1446 long entnr = read_long(env);
1447 ident *name = read_ident(env);
1448 ident *ld_name = read_ident_null(env);
1449 ir_visibility visibility = ir_visibility_default;
1450 ir_linkage linkage = IR_LINKAGE_DEFAULT;
1459 while (!isdigit(env->c)) {
1460 char *vstr = read_word(env);
1465 v = symbol(vstr, tt_visibility);
1466 if (v != SYMERROR) {
1467 visibility = (ir_visibility)v;
1470 v = symbol(vstr, tt_linkage);
1471 if (v != SYMERROR) {
1472 linkage |= (ir_linkage)v;
1475 printf("Parser error, expected visibility or linkage, got '%s'\n",
1480 typenr = read_long(env);
1481 ownertypenr = read_long(env);
1483 type = get_type(env, typenr);
1484 ownertype = !ownertypenr ? get_glob_type() : get_type(env, ownertypenr);
1485 entity = new_entity(ownertype, name, type);
1487 if (ld_name != NULL)
1488 set_entity_ld_ident(entity, ld_name);
1489 set_entity_offset(entity, (int) read_long(env));
1490 set_entity_offset_bits_remainder(entity, (unsigned char) read_long(env));
1491 set_entity_compiler_generated(entity, (int) read_long(env));
1492 set_entity_volatility(entity, read_volatility(env));
1493 set_entity_visibility(entity, visibility);
1494 set_entity_linkage(entity, linkage);
1496 str = read_word(env);
1497 if (strcmp(str, "initializer") == 0) {
1498 set_entity_initializer(entity, read_initializer(env));
1499 } else if (strcmp(str, "compoundgraph") == 0) {
1500 int n = (int) read_long(env);
1502 for (i = 0; i < n; i++) {
1503 ir_entity *member = get_entity(env, read_long(env));
1504 ir_node *irn = get_node_or_dummy(env, read_long(env));
1505 add_compound_ent_value(entity, irn, member);
1507 } else if (strcmp(str, "none") == 0) {
1510 parse_error(env, "expected 'initializer', 'compoundgraph' or 'none' got '%s'\n", str);
1514 set_id(env, entnr, entity);
1517 /** Parses the whole type graph. */
1518 static int parse_typegraph(io_env_t *env)
1520 ir_graph *old_irg = env->irg;
1525 env->irg = get_const_code_irg();
1527 /* parse all types first */
1530 if (env->c == '}') {
1535 kwkind = (keyword_t) read_enum(env, tt_keyword);
1546 parse_error(env, "type graph element not supported yet: %d\n", kwkind);
1555 static int read_node_header(io_env_t *env, long *nodenr, ir_node ***preds,
1556 const char **nodename)
1560 *nodename = read_word(env);
1561 *nodenr = read_long(env);
1563 ARR_RESIZE(ir_node*, *preds, 0);
1565 expect_list_begin(env);
1566 for (numpreds = 0; list_has_next(env); numpreds++) {
1567 long val = read_long(env);
1568 ir_node *pred = get_node_or_dummy(env, val);
1569 ARR_APP1(ir_node*, *preds, pred);
1575 static ir_node *read_ASM(io_env_t *env, int numpreds, ir_node **preds)
1578 ir_asm_constraint *input_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1579 ir_asm_constraint *output_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1580 ident **clobbers = NEW_ARR_F(ident*, 0);
1582 ident *asm_text = read_ident(env);
1584 expect_list_begin(env);
1585 while (list_has_next(env)) {
1586 ir_asm_constraint constraint;
1587 constraint.pos = read_unsigned(env);
1588 constraint.constraint = read_ident(env);
1589 constraint.mode = read_mode(env);
1590 ARR_APP1(ir_asm_constraint, input_constraints, constraint);
1593 expect_list_begin(env);
1594 while (list_has_next(env)) {
1595 ir_asm_constraint constraint;
1596 constraint.pos = read_unsigned(env);
1597 constraint.constraint = read_ident(env);
1598 constraint.mode = read_mode(env);
1599 ARR_APP1(ir_asm_constraint, output_constraints, constraint);
1602 expect_list_begin(env);
1603 while (list_has_next(env)) {
1604 ident *clobber = read_ident(env);
1605 ARR_APP1(ident*, clobbers, clobber);
1608 assert(ARR_LEN(input_constraints) == (size_t)numpreds-1);
1610 newnode = new_r_ASM(preds[0], numpreds-1, preds+1,
1612 ARR_LEN(output_constraints),
1617 DEL_ARR_F(clobbers);
1618 DEL_ARR_F(output_constraints);
1619 DEL_ARR_F(input_constraints);
1623 /** Parses an IRG. */
1624 static int parse_graph(io_env_t *env, ir_graph *irg)
1626 ir_node **preds = NEW_ARR_F(ir_node*,0);
1627 int i, numpreds, ret = 1;
1629 const char *nodename;
1630 ir_node *node, *newnode;
1638 if (env->c == '}') {
1643 numpreds = read_node_header(env, &nodenr, &preds, &nodename);
1645 node = get_node_or_null(env, nodenr);
1650 switch (symbol(nodename, tt_iro)) {
1652 ir_node *newendblock = preds[0];
1653 newnode = get_irg_end(irg);
1654 exchange(get_nodes_block(newnode), newendblock);
1655 for (i = 1; i < numpreds; i++)
1656 add_irn_n(newnode, preds[i]);
1661 ir_node *newstartblock = preds[0];
1662 newnode = get_irg_start(irg);
1663 exchange(get_nodes_block(newnode), newstartblock);
1668 newnode = new_r_Block(irg, numpreds, preds);
1672 newnode = irg->anchor;
1673 for (i = 1; i < numpreds; i++)
1674 set_irn_n(newnode, i-1, preds[i]);
1675 set_nodes_block(newnode, preds[0]);
1678 case iro_SymConst: {
1679 long entnr = read_long(env);
1680 union symconst_symbol sym;
1681 sym.entity_p = get_entity(env, entnr);
1682 ir_mode *mode = read_mode(env);
1683 newnode = new_r_SymConst(irg, mode, sym, symconst_addr_ent);
1688 ir_mode *mode = read_mode(env);
1689 long pn = read_long(env);
1690 newnode = new_r_Proj(preds[1], mode, pn);
1691 /* explicitely set block, since preds[1] might be a dummy node
1692 * which is always in the startblock */
1693 set_nodes_block(newnode, preds[0]);
1698 newnode = read_ASM(env, numpreds, preds);
1701 #include "gen_irio_import.inl"
1711 parse_error(env, "node type not supported yet: %s\n", nodename);
1716 exchange(node, newnode);
1717 /* Always update hash entry to avoid more uses of id nodes */
1718 set_id(env, nodenr, newnode);
1726 static int parse_modes(io_env_t *env)
1734 if (env->c == '}') {
1739 kwkind = (keyword_t) read_enum(env, tt_keyword);
1742 const char *name = read_string(env);
1743 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1744 int size = read_long(env);
1745 int sign = read_long(env);
1746 unsigned modulo_shift = read_long(env);
1747 new_int_mode(name, arith, size, sign, modulo_shift);
1750 case kw_reference_mode: {
1751 const char *name = read_string(env);
1752 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1753 int size = read_long(env);
1754 unsigned modulo_shift = read_long(env);
1755 ir_mode *mode = new_reference_mode(name, arith, size, modulo_shift);
1756 set_reference_mode_signed_eq(mode, read_mode(env));
1757 set_reference_mode_unsigned_eq(mode, read_mode(env));
1758 int is_mode_P = read_int(env);
1760 set_modeP_data(mode);
1761 set_modeP_code(mode);
1765 case kw_float_mode: {
1766 const char *name = read_string(env);
1767 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1768 int exponent_size = read_long(env);
1769 int mantissa_size = read_long(env);
1770 new_float_mode(name, arith, exponent_size, mantissa_size);
1782 static int parse_program(io_env_t *env)
1790 if (env->c == '}') {
1795 kwkind = (keyword_t) read_enum(env, tt_keyword);
1797 case kw_segment_type: {
1798 ir_segment_t segment = (ir_segment_t) read_enum(env, tt_segment);
1799 ir_type *type = read_type(env);
1800 set_segment_type(segment, type);
1804 parse_error(env, "unexpected keyword %d\n", kwkind);
1811 void ir_import(const char *filename)
1813 FILE *file = fopen(filename, "rt");
1819 ir_import_file(file, filename);
1824 void ir_import_file(FILE *input, const char *inputname)
1826 int oldoptimize = get_optimize();
1827 firm_verification_t oldver = get_node_verification_mode();
1829 io_env_t *env = &ioenv;
1834 memset(env, 0, sizeof(*env));
1835 obstack_init(&env->obst);
1836 env->idset = new_set(id_cmp, 128);
1837 env->fixedtypes = NEW_ARR_F(ir_type *, 0);
1838 env->inputname = inputname;
1842 /* read first character */
1846 do_node_verification(FIRM_VERIFICATION_OFF);
1855 kw = (keyword_t)read_enum(env, tt_keyword);
1858 if (!parse_modes(env)) goto end;
1862 if (!parse_typegraph(env)) goto end;
1867 ir_entity *irgent = get_entity(env, read_long(env));
1868 ir_graph *irg = new_ir_graph(irgent, 0);
1869 set_irg_frame_type(irg, get_type(env, read_long(env)));
1870 if (!parse_graph(env, irg)) goto end;
1875 ir_graph *constirg = get_const_code_irg();
1876 long bodyblockid = read_long(env);
1877 set_id(env, bodyblockid, constirg->current_block);
1878 if (!parse_graph(env, constirg)) goto end;
1887 parse_error(env, "Unexpected keyword %d at toplevel\n", kw);
1894 n = ARR_LEN(env->fixedtypes);
1895 for (i = 0; i < n; i++)
1896 set_type_state(env->fixedtypes[i], layout_fixed);
1898 DEL_ARR_F(env->fixedtypes);
1900 del_set(env->idset);
1902 irp_finalize_cons();
1904 do_node_verification(oldver);
1905 set_optimize(oldoptimize);
1907 obstack_free(&env->obst, NULL);