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,
84 typedef enum keyword_t
99 typedef struct symbol_t
101 const char *str; /**< The name of this symbol. */
102 typetag_t typetag; /**< The type tag of this symbol. */
103 unsigned code; /**< The value of this symbol. */
106 typedef struct id_entry
112 /** The symbol table, a set of symbol_t elements. */
116 * Compare two symbol table entries.
118 static int symbol_cmp(const void *elt, const void *key, size_t size)
121 const symbol_t *entry = (const symbol_t *) elt;
122 const symbol_t *keyentry = (const symbol_t *) key;
124 res = entry->typetag - keyentry->typetag;
126 return strcmp(entry->str, keyentry->str);
129 static int id_cmp(const void *elt, const void *key, size_t size)
131 const id_entry *entry = (const id_entry *) elt;
132 const id_entry *keyentry = (const id_entry *) key;
134 return entry->id - keyentry->id;
137 static void __attribute__((format(printf, 2, 3)))
138 parse_error(io_env_t *env, const char *fmt, ...)
141 int line = env->line;
143 /* workaround read_c "feature" that a '\n' triggers the line++
144 * instead of the character after the '\n' */
145 if (env->c == '\n') {
149 fprintf(stderr, "%s:%d: error ", env->inputname, line);
152 vfprintf(stderr, fmt, ap);
156 /** Initializes the symbol table. May be called more than once without problems. */
157 static void symtbl_init(void)
161 /* Only initialize once */
165 symtbl = new_set(symbol_cmp, 256);
167 #define INSERT(tt, s, cod) \
169 key.typetag = (tt); \
171 set_insert(symtbl, &key, sizeof(key), firm_fnv_hash_str(s) + tt * 17)
173 #define INSERTENUM(tt, e) INSERT(tt, #e, e)
174 #define INSERTKEYWORD(k) INSERT(tt_keyword, #k, kw_##k)
176 INSERT(tt_tpo, "array", tpo_array);
177 INSERT(tt_tpo, "class", tpo_class);
178 INSERT(tt_tpo, "method", tpo_method);
179 INSERT(tt_tpo, "pointer", tpo_pointer);
180 INSERT(tt_tpo, "primitive", tpo_primitive);
181 INSERT(tt_tpo, "struct", tpo_struct);
182 INSERT(tt_tpo, "union", tpo_union);
183 INSERT(tt_tpo, "Unknown", tpo_unknown);
185 INSERT(tt_segment, "global", IR_SEGMENT_GLOBAL);
186 INSERT(tt_segment, "thread_local", IR_SEGMENT_THREAD_LOCAL);
187 INSERT(tt_segment, "constructors", IR_SEGMENT_CONSTRUCTORS);
188 INSERT(tt_segment, "destructors", IR_SEGMENT_DESTRUCTORS);
190 INSERT(tt_linkage, "constant", IR_LINKAGE_CONSTANT);
191 INSERT(tt_linkage, "weak", IR_LINKAGE_WEAK);
192 INSERT(tt_linkage, "garbage_collect", IR_LINKAGE_GARBAGE_COLLECT);
193 INSERT(tt_linkage, "merge", IR_LINKAGE_MERGE);
194 INSERT(tt_linkage, "hidden_user", IR_LINKAGE_HIDDEN_USER);
196 INSERT(tt_visibility, "local", ir_visibility_local);
197 INSERT(tt_visibility, "external", ir_visibility_external);
198 INSERT(tt_visibility, "default", ir_visibility_default);
199 INSERT(tt_visibility, "private", ir_visibility_private);
201 INSERTKEYWORD(constirg);
202 INSERTKEYWORD(entity);
204 INSERTKEYWORD(int_mode);
205 INSERTKEYWORD(float_mode);
206 INSERTKEYWORD(reference_mode);
207 INSERTKEYWORD(modes);
209 INSERTKEYWORD(typegraph);
210 INSERTKEYWORD(program);
211 INSERTKEYWORD(segment_type);
213 #include "gen_irio_lex.inl"
215 INSERTENUM(tt_align, align_non_aligned);
216 INSERTENUM(tt_align, align_is_aligned);
218 INSERTENUM(tt_builtin, ir_bk_trap);
219 INSERTENUM(tt_builtin, ir_bk_debugbreak);
220 INSERTENUM(tt_builtin, ir_bk_return_address);
221 INSERTENUM(tt_builtin, ir_bk_frame_address);
222 INSERTENUM(tt_builtin, ir_bk_prefetch);
223 INSERTENUM(tt_builtin, ir_bk_ffs);
224 INSERTENUM(tt_builtin, ir_bk_clz);
225 INSERTENUM(tt_builtin, ir_bk_ctz);
226 INSERTENUM(tt_builtin, ir_bk_popcount);
227 INSERTENUM(tt_builtin, ir_bk_parity);
228 INSERTENUM(tt_builtin, ir_bk_bswap);
229 INSERTENUM(tt_builtin, ir_bk_inport);
230 INSERTENUM(tt_builtin, ir_bk_outport);
231 INSERTENUM(tt_builtin, ir_bk_inner_trampoline);
233 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_NONE);
234 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_TRUE);
235 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_FALSE);
237 INSERTENUM(tt_initializer, IR_INITIALIZER_CONST);
238 INSERTENUM(tt_initializer, IR_INITIALIZER_TARVAL);
239 INSERTENUM(tt_initializer, IR_INITIALIZER_NULL);
240 INSERTENUM(tt_initializer, IR_INITIALIZER_COMPOUND);
242 INSERTENUM(tt_mode_arithmetic, irma_uninitialized);
243 INSERTENUM(tt_mode_arithmetic, irma_none);
244 INSERTENUM(tt_mode_arithmetic, irma_twos_complement);
245 INSERTENUM(tt_mode_arithmetic, irma_ieee754);
247 INSERTENUM(tt_pin_state, op_pin_state_floats);
248 INSERTENUM(tt_pin_state, op_pin_state_pinned);
249 INSERTENUM(tt_pin_state, op_pin_state_exc_pinned);
250 INSERTENUM(tt_pin_state, op_pin_state_mem_pinned);
252 INSERTENUM(tt_type_state, layout_undefined);
253 INSERTENUM(tt_type_state, layout_fixed);
255 INSERTENUM(tt_volatility, volatility_non_volatile);
256 INSERTENUM(tt_volatility, volatility_is_volatile);
263 static const char *get_segment_name(ir_segment_t segment)
266 case IR_SEGMENT_GLOBAL: return "global";
267 case IR_SEGMENT_THREAD_LOCAL: return "thread_local";
268 case IR_SEGMENT_CONSTRUCTORS: return "constructors";
269 case IR_SEGMENT_DESTRUCTORS: return "destructors";
271 return "INVALID_SEGMENT";
274 static const char *get_visibility_name(ir_visibility visibility)
276 switch (visibility) {
277 case ir_visibility_local: return "local";
278 case ir_visibility_external: return "external";
279 case ir_visibility_default: return "default";
280 case ir_visibility_private: return "private";
282 return "INVALID_VISIBILITY";
285 /** Returns the according symbol value for the given string and tag, or SYMERROR if none was found. */
286 static unsigned symbol(const char *str, typetag_t typetag)
288 symbol_t key, *entry;
291 key.typetag = typetag;
293 entry = (symbol_t*)set_find(symtbl, &key, sizeof(key), firm_fnv_hash_str(str) + typetag * 17);
294 return entry ? entry->code : SYMERROR;
297 static void *get_id(io_env_t *env, long id)
299 id_entry key, *entry;
302 entry = (id_entry*)set_find(env->idset, &key, sizeof(key), (unsigned) id);
303 return entry ? entry->elem : NULL;
306 static void set_id(io_env_t *env, long id, void *elem)
311 set_insert(env->idset, &key, sizeof(key), (unsigned) id);
314 static void write_long(io_env_t *env, long value)
316 fprintf(env->file, "%ld ", value);
319 static void write_int(io_env_t *env, int value)
321 fprintf(env->file, "%d ", value);
324 static void write_unsigned(io_env_t *env, unsigned value)
326 fprintf(env->file, "%u ", value);
329 static void write_entity_ref(io_env_t *env, ir_entity *entity)
331 write_long(env, get_entity_nr(entity));
334 static void write_type_ref(io_env_t *env, ir_type *type)
336 write_long(env, get_type_nr(type));
339 static void write_string(io_env_t *env, const char *string)
342 fputc('"', env->file);
343 for (c = string; *c != '\0'; ++c) {
346 fputc('\\', env->file);
347 fputc('n', env->file);
351 fputc('\\', env->file);
354 fputc(*c, env->file);
358 fputc('"', env->file);
361 static void write_ident(io_env_t *env, ident *id)
363 write_string(env, get_id_str(id));
364 fputc(' ', env->file);
367 static void write_ident_null(io_env_t *env, ident *id)
370 fputs("NULL ", env->file);
372 write_ident(env, id);
376 static void write_mode(io_env_t *env, ir_mode *mode)
378 write_string(env, get_mode_name(mode));
379 fputc(' ', env->file);
382 static void write_tarval(io_env_t *env, ir_tarval *tv)
385 write_mode(env, get_tarval_mode(tv));
386 tarval_snprintf(buf, sizeof(buf), tv);
387 fputs(buf, env->file);
388 fputc(' ', env->file);
391 static void write_align(io_env_t *env, ir_align align)
393 fputs(get_align_name(align), env->file);
394 fputc(' ', env->file);
397 static void write_builtin_kind(io_env_t *env, ir_node *irn)
399 fputs(get_builtin_kind_name(get_Builtin_kind(irn)), env->file);
400 fputc(' ', env->file);
403 static void write_cond_jmp_predicate(io_env_t *env, ir_node *irn)
405 fputs(get_cond_jmp_predicate_name(get_Cond_jmp_pred(irn)), env->file);
406 fputc(' ', env->file);
409 static void write_list_begin(io_env_t *env)
411 fputs("[", env->file);
414 static void write_list_end(io_env_t *env)
416 fputs("] ", env->file);
419 static void write_initializer(io_env_t *env, ir_initializer_t *ini)
422 ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
424 fputs(get_initializer_kind_name(ini_kind), f);
428 case IR_INITIALIZER_CONST:
429 write_long(env, get_irn_node_nr(get_initializer_const_value(ini)));
432 case IR_INITIALIZER_TARVAL:
433 write_tarval(env, get_initializer_tarval_value(ini));
436 case IR_INITIALIZER_NULL:
439 case IR_INITIALIZER_COMPOUND: {
440 size_t i, n = get_initializer_compound_n_entries(ini);
441 ir_fprintf(f, "%zu ", n);
442 for (i = 0; i < n; ++i)
443 write_initializer(env, get_initializer_compound_value(ini, i));
448 panic("Unknown initializer kind");
452 static void write_pin_state(io_env_t *env, ir_node *irn)
454 fputs(get_op_pin_state_name(get_irn_pinned(irn)), env->file);
455 fputc(' ', env->file);
458 static void write_volatility(io_env_t *env, ir_volatility vol)
460 fputs(get_volatility_name(vol), env->file);
461 fputc(' ', env->file);
464 static void export_type_common(io_env_t *env, ir_type *tp)
466 fprintf(env->file, "\ttype %ld %s %u %u %s %u ",
468 get_type_tpop_name(tp),
469 get_type_size_bytes(tp),
470 get_type_alignment_bytes(tp),
471 get_type_state_name(get_type_state(tp)),
475 static void export_type_pre(io_env_t *env, ir_type *tp)
479 /* skip types to be handled by post walker */
480 switch (get_type_tpop_code(tp)) {
489 export_type_common(env, tp);
491 switch (get_type_tpop_code(tp)) {
492 case tpo_uninitialized:
493 panic("invalid type found");
496 write_ident_null(env, get_compound_ident(tp));
500 write_mode(env, get_type_mode(tp));
505 case tpo_enumeration:
506 write_ident_null(env, get_compound_ident(tp));
520 static void export_type_post(io_env_t *env, ir_type *tp)
525 /* skip types already handled by pre walker */
526 switch (get_type_tpop_code(tp)) {
532 case tpo_uninitialized:
539 case tpo_enumeration:
543 export_type_common(env, tp);
545 switch (get_type_tpop_code(tp)) {
547 size_t n = get_array_n_dimensions(tp);
548 ir_fprintf(f, "%zu %ld ", n, get_type_nr(get_array_element_type(tp)));
549 for (i = 0; i < n; i++) {
550 ir_node *lower = get_array_lower_bound(tp, i);
551 ir_node *upper = get_array_upper_bound(tp, i);
554 write_long(env, get_tarval_long(get_Const_tarval(lower)));
556 panic("Lower array bound is not constant");
559 write_long(env, get_tarval_long(get_Const_tarval(upper)));
560 else if (is_Unknown(upper))
561 fputs("unknown ", f);
563 panic("Upper array bound is not constant");
569 size_t nparams = get_method_n_params(tp);
570 size_t nresults = get_method_n_ress(tp);
571 ir_fprintf(f, "%u %u %zu %zu ", get_method_calling_convention(tp),
572 get_method_additional_properties(tp), nparams, nresults);
573 for (i = 0; i < nparams; i++)
574 write_long(env, get_type_nr(get_method_param_type(tp, i)));
575 for (i = 0; i < nresults; i++)
576 write_long(env, get_type_nr(get_method_res_type(tp, i)));
577 ir_fprintf(f, "%u ", get_method_variadicity(tp));
582 write_mode(env, get_type_mode(tp));
583 write_long(env, get_type_nr(get_pointer_points_to_type(tp)));
586 case tpo_enumeration:
587 fprintf(stderr, "Enumeration type not handled yet by exporter\n");
591 printf("export_type: Unknown type code \"%s\".\n",
592 get_type_tpop_name(tp));
598 static void export_entity(io_env_t *env, ir_entity *ent)
600 FILE *file = env->file;
601 ir_type *owner = get_entity_owner(ent);
602 ir_visibility visibility = get_entity_visibility(ent);
603 ir_linkage linkage = get_entity_linkage(ent);
605 /* we don't dump array_element_ent entities. They're a strange concept
606 * and lead to cycles in type_graph.
608 if (is_Array_type(owner))
611 fprintf(env->file, "\tentity ");
612 write_long(env, get_entity_nr(ent));
613 write_ident_null(env, get_entity_ident(ent));
614 if (!entity_has_ld_ident(ent)) {
615 write_ident_null(env, NULL);
617 write_ident_null(env, get_entity_ld_ident(ent));
620 /* visibility + linkage */
621 if (visibility != ir_visibility_default) {
622 fprintf(file, "%s ", get_visibility_name(visibility));
624 if (linkage & IR_LINKAGE_CONSTANT)
625 fputs("constant ", file);
626 if (linkage & IR_LINKAGE_WEAK)
627 fputs("weak ", file);
628 if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
629 fputs("garbage_collect ", file);
630 if (linkage & IR_LINKAGE_MERGE)
631 fputs("merge ", file);
632 if (linkage & IR_LINKAGE_HIDDEN_USER)
633 fputs("hidden_user ", file);
635 fprintf(file, "%ld %ld %d %u %d %s ",
636 get_type_nr(get_entity_type(ent)),
638 get_entity_offset(ent),
639 (unsigned) get_entity_offset_bits_remainder(ent),
640 is_entity_compiler_generated(ent),
641 get_volatility_name(get_entity_volatility(ent)));
643 if (ent->initializer != NULL) {
644 fputs("initializer ", env->file);
645 write_initializer(env, get_entity_initializer(ent));
646 } else if (entity_has_compound_ent_values(ent)) {
647 size_t i, n = get_compound_ent_n_values(ent);
648 fputs("compoundgraph ", env->file);
649 ir_fprintf(env->file, "%zu ", n);
650 for (i = 0; i < n; i++) {
651 ir_entity *member = get_compound_ent_value_member(ent, i);
652 ir_node *irn = get_compound_ent_value(ent, i);
653 fprintf(env->file, "%ld %ld ", get_entity_nr(member), get_irn_node_nr(irn));
656 fputs("none", env->file);
659 fputc('\n', env->file);
662 static void export_type_or_ent_pre(type_or_ent tore, void *ctx)
664 io_env_t *env = (io_env_t *) ctx;
665 if (get_kind(tore.typ) == k_type)
666 export_type_pre(env, tore.typ);
669 static void export_type_or_ent_post(type_or_ent tore, void *ctx)
671 io_env_t *env = (io_env_t *) ctx;
673 switch (get_kind(tore.ent)) {
675 export_entity(env, tore.ent);
679 export_type_post(env, tore.typ);
683 panic("export_type_or_ent_post: Unknown type or entity.");
687 static void export_ASM(io_env_t *env, ir_node *node)
689 ir_asm_constraint *input_constraints = get_ASM_input_constraints(node);
690 ir_asm_constraint *output_constraints = get_ASM_output_constraints(node);
691 ident **clobbers = get_ASM_clobbers(node);
692 int n_input_constraints = get_ASM_n_input_constraints(node);
693 int n_output_constraints = get_ASM_n_output_constraints(node);
694 int n_clobbers = get_ASM_n_clobbers(node);
697 write_ident(env, get_ASM_text(node));
698 write_list_begin(env);
699 for (i = 0; i < n_input_constraints; ++i) {
700 const ir_asm_constraint *constraint = &input_constraints[i];
701 write_unsigned(env, constraint->pos);
702 write_ident(env, constraint->constraint);
703 write_mode(env, constraint->mode);
707 write_list_begin(env);
708 for (i = 0; i < n_output_constraints; ++i) {
709 const ir_asm_constraint *constraint = &output_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_clobbers; ++i) {
718 ident *clobber = clobbers[i];
719 write_ident(env, clobber);
725 * Walker: exports every node.
727 static void export_node(ir_node *irn, void *ctx)
729 io_env_t *env = (io_env_t *) ctx;
731 unsigned opcode = get_irn_opcode(irn);
733 if (env->ignoreblocks && opcode == iro_Block)
736 fprintf(env->file, "\t%s ", get_irn_opname(irn));
737 write_long(env, get_irn_node_nr(irn));
739 write_list_begin(env);
740 n = get_irn_arity(irn);
741 if (!is_Block(irn)) {
742 ir_node *block = get_nodes_block(irn);
743 write_long(env, get_irn_node_nr(block));
746 for (i = 0; i < n; i++) {
747 ir_node *pred = get_irn_n(irn, i);
749 /* Anchor node may have NULL predecessors */
750 assert(is_Anchor(irn));
751 fputs("-1 ", env->file);
753 write_long(env, get_irn_node_nr(pred));
758 fputs("{ ", env->file);
767 /* TODO: only symconst_addr_ent implemented yet */
768 assert(get_SymConst_kind(irn) == symconst_addr_ent);
769 fprintf(env->file, "%ld ", get_entity_nr(get_SymConst_entity(irn)));
770 write_mode(env, get_irn_mode(irn));
773 write_mode(env, get_irn_mode(irn));
774 fprintf(env->file, "%ld ", get_Proj_proj(irn));
777 export_ASM(env, irn);
779 #include "gen_irio_export.inl"
781 panic("no export code for node %+F\n", irn);
783 fputs("}\n", env->file);
786 static void export_modes(io_env_t *env)
788 size_t i, n_modes = get_irp_n_modes();
790 fputs("modes {\n", env->file);
792 for (i = 0; i < n_modes; i++) {
793 ir_mode *mode = get_irp_mode(i);
795 if (mode_is_int(mode)) {
796 fprintf(env->file, "\tint_mode ");
797 write_string(env, get_mode_name(mode));
798 fprintf(env->file, "%s %u %d %u ",
799 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
800 get_mode_size_bits(mode), get_mode_sign(mode),
801 get_mode_modulo_shift(mode));
802 } else if (mode_is_reference(mode)) {
803 fprintf(env->file, "\treference_mode ");
804 write_string(env, get_mode_name(mode));
805 fprintf(env->file, "%s %u %u ",
806 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
807 get_mode_size_bits(mode),
808 get_mode_modulo_shift(mode));
809 write_mode(env, get_reference_mode_signed_eq(mode));
810 write_mode(env, get_reference_mode_unsigned_eq(mode));
811 write_int(env, (mode == mode_P ? 1 : 0));
812 } else if (mode_is_float(mode)) {
813 fprintf(env->file, "\tfloat_mode ");
814 write_string(env, get_mode_name(mode));
815 fprintf(env->file, "%s %u %u ",
816 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
817 get_mode_exponent_size(mode),
818 get_mode_mantissa_size(mode));
820 /* skip "internal" modes */
822 fputc('\n', env->file);
825 fputs("}\n", env->file);
828 static void export_program(io_env_t *env)
833 fputs("\nprogram {\n", f);
834 if (irp_prog_name_is_set()) {
835 fprintf(f, "\tname ");
836 write_string(env, get_irp_name());
840 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
841 ir_type *segment_type = get_segment_type(s);
842 fprintf(f, "\tsegment_type %s ", get_segment_name(s));
843 if (segment_type == NULL) {
846 write_long(env, get_type_nr(segment_type));
853 void ir_export(const char *filename)
855 FILE *file = fopen(filename, "wt");
861 ir_export_file(file, filename);
865 /* Exports the whole irp to the given file in a textual form. */
866 void ir_export_file(FILE *file, const char *outputname)
869 size_t i, n_irgs = get_irp_n_irgs();
876 fputs("\ntypegraph {\n", env.file);
877 type_walk_prog(export_type_or_ent_pre, export_type_or_ent_post, &env);
878 fputs("}\n", env.file);
880 for (i = 0; i < n_irgs; i++) {
881 ir_graph *irg = get_irp_irg(i);
883 fprintf(env.file, "\nirg %ld %ld {\n",
884 get_entity_nr(get_irg_entity(irg)),
885 get_type_nr(get_irg_frame_type(irg)));
887 env.ignoreblocks = 0;
888 irg_block_walk_graph(irg, NULL, export_node, &env);
890 env.ignoreblocks = 1;
891 irg_walk_anchors(irg, NULL, export_node, &env);
893 fputs("}\n", env.file);
896 fprintf(env.file, "\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
898 walk_const_code(NULL, export_node, &env);
899 fputs("}\n", env.file);
901 export_program(&env);
904 /* Exports the given irg to the given file. */
905 void ir_export_irg(ir_graph *irg, FILE *file, const char *outputname)
914 fputs("typegraph {\n", env.file);
916 type_walk_irg(irg, export_type_or_ent_pre, export_type_or_ent_post, &env);
918 fprintf(env.file, "}\n\nirg %ld {\n", get_entity_nr(get_irg_entity(irg)));
920 env.ignoreblocks = 0;
921 irg_block_walk_graph(irg, NULL, export_node, &env);
923 env.ignoreblocks = 1;
924 irg_walk_anchors(irg, NULL, export_node, &env);
926 /* TODO: Only output needed constants */
927 fprintf(env.file, "}\n\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
928 walk_const_code(NULL, export_node, &env);
929 fputs("}\n", env.file);
932 static void read_c(io_env_t *env)
934 int c = fgetc(env->file);
940 /** Returns the first non-whitespace character or EOF. **/
941 static void skip_ws(io_env_t *env)
958 static void skip_to(io_env_t *env, char to_ch)
960 while (env->c != to_ch && env->c != EOF) {
965 static int expect_char(io_env_t *env, char ch)
969 parse_error(env, "Unexpected char '%c', expected '%c'\n",
977 #define EXPECT(c) if (expect_char(env, (c))) {} else return 0
979 static char *read_word(io_env_t *env)
983 assert(obstack_object_size(&env->obst) == 0);
995 obstack_1grow(&env->obst, c);
1002 obstack_1grow(&env->obst, '\0');
1003 return (char*)obstack_finish(&env->obst);
1006 static char *read_string(io_env_t *env)
1009 if (env->c != '"') {
1010 parse_error(env, "Expected string, got '%c'\n", env->c);
1015 assert(obstack_object_size(&env->obst) == 0);
1016 while (env->c != '"') {
1017 if (env->c == EOF) {
1018 parse_error(env, "Unexpected EOF while parsing string\n");
1022 if (env->c == '\\') {
1026 obstack_1grow(&env->obst, '\n');
1030 obstack_1grow(&env->obst, env->c);
1033 parse_error(env, "Unknown escape sequence '\\%c'\n", env->c);
1037 obstack_1grow(&env->obst, env->c);
1042 obstack_1grow(&env->obst, 0);
1044 return (char*)obstack_finish(&env->obst);
1047 static ident *read_ident(io_env_t *env)
1049 char *str = read_string(env);
1050 ident *res = new_id_from_str(str);
1051 obstack_free(&env->obst, str);
1056 * reads a "quoted string" or alternatively the token NULL
1058 static char *read_string_null(io_env_t *env)
1061 if (env->c == 'N') {
1062 char *str = read_word(env);
1063 if (strcmp(str, "NULL") == 0) {
1064 obstack_free(&env->obst, str);
1067 } else if (env->c == '"') {
1068 return read_string(env);
1071 parse_error(env, "Expected \"string\" or NULL\n");
1075 static ident *read_ident_null(io_env_t *env)
1078 char *str = read_string_null(env);
1082 res = new_id_from_str(str);
1083 obstack_free(&env->obst, str);
1087 static long read_long(io_env_t *env)
1093 if (!isdigit(env->c) && env->c != '-') {
1094 parse_error(env, "Expected number, got '%c'\n", env->c);
1098 assert(obstack_object_size(&env->obst) == 0);
1100 obstack_1grow(&env->obst, env->c);
1102 } while (isdigit(env->c));
1103 obstack_1grow(&env->obst, 0);
1105 str = (char*)obstack_finish(&env->obst);
1107 obstack_free(&env->obst, str);
1112 static int read_int(io_env_t *env)
1114 return (int) read_long(env);
1117 static unsigned read_unsigned(io_env_t *env)
1119 return (unsigned) read_long(env);
1122 static size_t read_size_t(io_env_t *env)
1125 return (size_t) read_unsigned(env);
1128 static void expect_list_begin(io_env_t *env)
1131 if (env->c != '[') {
1132 parse_error(env, "Expected list, got '%c'\n", env->c);
1138 static bool list_has_next(io_env_t *env)
1140 if (feof(env->file)) {
1141 parse_error(env, "Unexpected EOF while reading list");
1145 if (env->c == ']') {
1153 static ir_node *get_node_or_null(io_env_t *env, long nodenr)
1155 ir_node *node = (ir_node *) get_id(env, nodenr);
1156 if (node && node->kind != k_ir_node) {
1157 panic("Irn ID %ld collides with something else in line %d\n",
1163 static ir_node *get_node_or_dummy(io_env_t *env, long nodenr)
1165 ir_node *node = get_node_or_null(env, nodenr);
1167 node = new_r_Dummy(env->irg, mode_X);
1168 set_id(env, nodenr, node);
1173 static ir_type *get_type(io_env_t *env, long typenr)
1175 ir_type *type = (ir_type *) get_id(env, typenr);
1177 panic("unknown type: %ld in line %d\n", typenr, env->line);
1178 else if (type->kind != k_type)
1179 panic("type ID %ld collides with something else in line %d\n",
1184 static ir_type *read_type(io_env_t *env)
1186 return get_type(env, read_long(env));
1189 static ir_entity *get_entity(io_env_t *env, long entnr)
1191 ir_entity *entity = (ir_entity *) get_id(env, entnr);
1192 if (entity == NULL) {
1193 parse_error(env, "unknown entity: %ld\n", entnr);
1195 } else if (entity->kind != k_entity) {
1196 panic("Entity ID %ld collides with something else in line %d\n",
1203 static ir_entity *read_entity(io_env_t *env)
1205 return get_entity(env, read_long(env));
1208 static ir_mode *read_mode(io_env_t *env)
1210 char *str = read_string(env);
1213 n = get_irp_n_modes();
1214 for (i = 0; i < n; i++) {
1215 ir_mode *mode = get_irp_mode(i);
1216 if (strcmp(str, get_mode_name(mode)) == 0) {
1217 obstack_free(&env->obst, str);
1222 parse_error(env, "unknown mode \"%s\"\n", str);
1226 static const char *get_typetag_name(typetag_t typetag)
1229 case tt_align: return "align";
1230 case tt_allocation: return "allocation";
1231 case tt_builtin: return "builtin kind";
1232 case tt_cond_jmp_predicate: return "cond_jmp_predicate";
1233 case tt_initializer: return "initializer kind";
1234 case tt_iro: return "opcode";
1235 case tt_keyword: return "keyword";
1236 case tt_linkage: return "linkage";
1237 case tt_mode_arithmetic: return "mode_arithmetic";
1238 case tt_pin_state: return "pin state";
1239 case tt_segment: return "segment";
1240 case tt_tpo: return "type";
1241 case tt_type_state: return "type state";
1242 case tt_volatility: return "volatility";
1243 case tt_visibility: return "visibility";
1249 * Read and decode an enum constant.
1251 static unsigned read_enum(io_env_t *env, typetag_t typetag)
1253 char *str = read_word(env);
1254 unsigned code = symbol(str, typetag);
1256 if (code != SYMERROR) {
1257 obstack_free(&env->obst, str);
1261 parse_error(env, "invalid %s: \"%s\"\n", get_typetag_name(typetag), str);
1265 #define read_align(env) ((ir_align) read_enum(env, tt_align))
1266 #define read_allocation(env) ((ir_allocation) read_enum(env, tt_allocation))
1267 #define read_builtin_kind(env) ((ir_builtin_kind) read_enum(env, tt_builtin))
1268 #define read_cond_jmp_predicate(env) ((cond_jmp_predicate) read_enum(env, tt_cond_jmp_predicate))
1269 #define read_initializer_kind(env) ((ir_initializer_kind_t) read_enum(env, tt_initializer))
1270 #define read_mode_arithmetic(env) ((ir_mode_arithmetic) read_enum(env, tt_mode_arithmetic))
1271 #define read_peculiarity(env) ((ir_peculiarity) read_enum(env, tt_peculiarity))
1272 #define read_pin_state(env) ((op_pin_state) read_enum(env, tt_pin_state))
1273 #define read_type_state(env) ((ir_type_state) read_enum(env, tt_type_state))
1274 #define read_variability(env) ((ir_variability) read_enum(env, tt_variability))
1275 #define read_volatility(env) ((ir_volatility) read_enum(env, tt_volatility))
1277 static ir_tarval *read_tv(io_env_t *env)
1279 ir_mode *tvmode = read_mode(env);
1280 char *str = read_word(env);
1281 ir_tarval *tv = new_tarval_from_str(str, strlen(str), tvmode);
1282 obstack_free(&env->obst, str);
1287 static ir_initializer_t *read_initializer(io_env_t *env)
1289 ir_initializer_kind_t ini_kind = read_initializer_kind(env);
1292 case IR_INITIALIZER_CONST: {
1293 ir_node *irn = get_node_or_dummy(env, read_long(env));
1294 return create_initializer_const(irn);
1297 case IR_INITIALIZER_TARVAL:
1298 return create_initializer_tarval(read_tv(env));
1300 case IR_INITIALIZER_NULL:
1301 return get_initializer_null();
1303 case IR_INITIALIZER_COMPOUND: {
1304 size_t i, n = read_size_t(env);
1305 ir_initializer_t *ini = create_initializer_compound(n);
1306 for (i = 0; i < n; i++) {
1307 ir_initializer_t *curini = read_initializer(env);
1308 set_initializer_compound_value(ini, i, curini);
1314 panic("Unknown initializer kind");
1319 /** Reads a type description and remembers it by its id. */
1320 static void import_type(io_env_t *env)
1324 long typenr = read_long(env);
1325 tp_opcode tpop = (tp_opcode) read_enum(env, tt_tpo);
1326 unsigned size = (unsigned) read_long(env);
1327 unsigned align = (unsigned) read_long(env);
1328 ir_type_state state = read_type_state(env);
1329 unsigned flags = (unsigned) read_long(env);
1333 int ndims = (int) read_long(env);
1334 long elemtypenr = read_long(env);
1335 ir_type *elemtype = get_type(env, elemtypenr);
1337 type = new_type_array(ndims, elemtype);
1338 for (i = 0; i < ndims; i++) {
1339 char *str = read_word(env);
1340 if (strcmp(str, "unknown") != 0) {
1341 long lowerbound = atol(str);
1342 set_array_lower_bound_int(type, i, lowerbound);
1344 obstack_free(&env->obst, str);
1346 str = read_word(env);
1347 if (strcmp(str, "unknown") != 0) {
1348 long upperbound = atol(str);
1349 set_array_upper_bound_int(type, i, upperbound);
1351 obstack_free(&env->obst, str);
1353 set_type_size_bytes(type, size);
1358 ident *id = read_ident_null(env);
1360 if (typenr == (long) IR_SEGMENT_GLOBAL)
1361 type = get_glob_type();
1363 type = new_type_class(id);
1364 set_type_size_bytes(type, size);
1369 unsigned callingconv = (unsigned) read_long(env);
1370 mtp_additional_properties addprops = (mtp_additional_properties) read_long(env);
1371 int nparams = (int) read_long(env);
1372 int nresults = (int) read_long(env);
1375 type = new_type_method(nparams, nresults);
1377 for (i = 0; i < nparams; i++) {
1378 long ptypenr = read_long(env);
1379 ir_type *paramtype = get_type(env, ptypenr);
1381 set_method_param_type(type, i, paramtype);
1383 for (i = 0; i < nresults; i++) {
1384 long ptypenr = read_long(env);
1385 ir_type *restype = get_type(env, ptypenr);
1387 set_method_res_type(type, i, restype);
1390 variadicity = (int) read_long(env);
1391 set_method_variadicity(type, variadicity);
1393 set_method_calling_convention(type, callingconv);
1394 set_method_additional_properties(type, addprops);
1399 ir_mode *mode = read_mode(env);
1400 ir_type *pointsto = get_type(env, read_long(env));
1401 type = new_type_pointer(pointsto);
1402 set_type_mode(type, mode);
1406 case tpo_primitive: {
1407 ir_mode *mode = read_mode(env);
1408 type = new_type_primitive(mode);
1413 ident *id = read_ident_null(env);
1414 type = new_type_struct(id);
1415 set_type_size_bytes(type, size);
1420 ident *id = read_ident_null(env);
1421 type = new_type_union(id);
1422 set_type_size_bytes(type, size);
1427 return; /* ignore unknown type */
1430 parse_error(env, "unknown type kind: \"%d\"\n", tpop);
1435 set_type_alignment_bytes(type, align);
1436 type->flags = flags;
1438 if (state == layout_fixed)
1439 ARR_APP1(ir_type *, env->fixedtypes, type);
1441 set_id(env, typenr, type);
1444 /** Reads an entity description and remembers it by its id. */
1445 static void import_entity(io_env_t *env)
1447 long entnr = read_long(env);
1448 ident *name = read_ident(env);
1449 ident *ld_name = read_ident_null(env);
1450 ir_visibility visibility = ir_visibility_default;
1451 ir_linkage linkage = IR_LINKAGE_DEFAULT;
1460 while (!isdigit(env->c)) {
1461 char *vstr = read_word(env);
1466 v = symbol(vstr, tt_visibility);
1467 if (v != SYMERROR) {
1468 visibility = (ir_visibility)v;
1471 v = symbol(vstr, tt_linkage);
1472 if (v != SYMERROR) {
1473 linkage |= (ir_linkage)v;
1476 printf("Parser error, expected visibility or linkage, got '%s'\n",
1481 typenr = read_long(env);
1482 ownertypenr = read_long(env);
1484 type = get_type(env, typenr);
1485 ownertype = !ownertypenr ? get_glob_type() : get_type(env, ownertypenr);
1486 entity = new_entity(ownertype, name, type);
1488 if (ld_name != NULL)
1489 set_entity_ld_ident(entity, ld_name);
1490 set_entity_offset(entity, (int) read_long(env));
1491 set_entity_offset_bits_remainder(entity, (unsigned char) read_long(env));
1492 set_entity_compiler_generated(entity, (int) read_long(env));
1493 set_entity_volatility(entity, read_volatility(env));
1494 set_entity_visibility(entity, visibility);
1495 set_entity_linkage(entity, linkage);
1497 str = read_word(env);
1498 if (strcmp(str, "initializer") == 0) {
1499 set_entity_initializer(entity, read_initializer(env));
1500 } else if (strcmp(str, "compoundgraph") == 0) {
1501 int n = (int) read_long(env);
1503 for (i = 0; i < n; i++) {
1504 ir_entity *member = get_entity(env, read_long(env));
1505 ir_node *irn = get_node_or_dummy(env, read_long(env));
1506 add_compound_ent_value(entity, irn, member);
1508 } else if (strcmp(str, "none") == 0) {
1511 parse_error(env, "expected 'initializer', 'compoundgraph' or 'none' got '%s'\n", str);
1515 set_id(env, entnr, entity);
1518 /** Parses the whole type graph. */
1519 static int parse_typegraph(io_env_t *env)
1521 ir_graph *old_irg = env->irg;
1526 env->irg = get_const_code_irg();
1528 /* parse all types first */
1531 if (env->c == '}') {
1536 kwkind = (keyword_t) read_enum(env, tt_keyword);
1547 parse_error(env, "type graph element not supported yet: %d\n", kwkind);
1556 static int read_node_header(io_env_t *env, long *nodenr, ir_node ***preds,
1557 const char **nodename)
1561 *nodename = read_word(env);
1562 *nodenr = read_long(env);
1564 ARR_RESIZE(ir_node*, *preds, 0);
1566 expect_list_begin(env);
1567 for (numpreds = 0; list_has_next(env); numpreds++) {
1568 long val = read_long(env);
1569 ir_node *pred = get_node_or_dummy(env, val);
1570 ARR_APP1(ir_node*, *preds, pred);
1576 static ir_node *read_ASM(io_env_t *env, int numpreds, ir_node **preds)
1579 ir_asm_constraint *input_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1580 ir_asm_constraint *output_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1581 ident **clobbers = NEW_ARR_F(ident*, 0);
1583 ident *asm_text = read_ident(env);
1585 expect_list_begin(env);
1586 while (list_has_next(env)) {
1587 ir_asm_constraint constraint;
1588 constraint.pos = read_unsigned(env);
1589 constraint.constraint = read_ident(env);
1590 constraint.mode = read_mode(env);
1591 ARR_APP1(ir_asm_constraint, input_constraints, constraint);
1594 expect_list_begin(env);
1595 while (list_has_next(env)) {
1596 ir_asm_constraint constraint;
1597 constraint.pos = read_unsigned(env);
1598 constraint.constraint = read_ident(env);
1599 constraint.mode = read_mode(env);
1600 ARR_APP1(ir_asm_constraint, output_constraints, constraint);
1603 expect_list_begin(env);
1604 while (list_has_next(env)) {
1605 ident *clobber = read_ident(env);
1606 ARR_APP1(ident*, clobbers, clobber);
1609 assert(ARR_LEN(input_constraints) == (size_t)numpreds-1);
1611 newnode = new_r_ASM(preds[0], numpreds-1, preds+1,
1613 ARR_LEN(output_constraints),
1618 DEL_ARR_F(clobbers);
1619 DEL_ARR_F(output_constraints);
1620 DEL_ARR_F(input_constraints);
1624 /** Parses an IRG. */
1625 static int parse_graph(io_env_t *env, ir_graph *irg)
1627 ir_node **preds = NEW_ARR_F(ir_node*,0);
1628 int i, numpreds, ret = 1;
1630 const char *nodename;
1631 ir_node *node, *newnode;
1639 if (env->c == '}') {
1644 numpreds = read_node_header(env, &nodenr, &preds, &nodename);
1646 node = get_node_or_null(env, nodenr);
1651 switch (symbol(nodename, tt_iro)) {
1653 ir_node *newendblock = preds[0];
1654 newnode = get_irg_end(irg);
1655 exchange(get_nodes_block(newnode), newendblock);
1656 for (i = 1; i < numpreds; i++)
1657 add_irn_n(newnode, preds[i]);
1662 ir_node *newstartblock = preds[0];
1663 newnode = get_irg_start(irg);
1664 exchange(get_nodes_block(newnode), newstartblock);
1669 newnode = new_r_Block(irg, numpreds, preds);
1673 newnode = irg->anchor;
1674 for (i = 1; i < numpreds; i++)
1675 set_irn_n(newnode, i-1, preds[i]);
1676 set_nodes_block(newnode, preds[0]);
1679 case iro_SymConst: {
1680 long entnr = read_long(env);
1681 union symconst_symbol sym;
1682 sym.entity_p = get_entity(env, entnr);
1683 ir_mode *mode = read_mode(env);
1684 newnode = new_r_SymConst(irg, mode, sym, symconst_addr_ent);
1689 ir_mode *mode = read_mode(env);
1690 long pn = read_long(env);
1691 newnode = new_r_Proj(preds[1], mode, pn);
1692 /* explicitely set block, since preds[1] might be a dummy node
1693 * which is always in the startblock */
1694 set_nodes_block(newnode, preds[0]);
1699 newnode = read_ASM(env, numpreds, preds);
1702 #include "gen_irio_import.inl"
1712 parse_error(env, "node type not supported yet: %s\n", nodename);
1717 exchange(node, newnode);
1718 /* Always update hash entry to avoid more uses of id nodes */
1719 set_id(env, nodenr, newnode);
1727 static int parse_modes(io_env_t *env)
1735 if (env->c == '}') {
1740 kwkind = (keyword_t) read_enum(env, tt_keyword);
1743 const char *name = read_string(env);
1744 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1745 int size = read_long(env);
1746 int sign = read_long(env);
1747 unsigned modulo_shift = read_long(env);
1748 new_int_mode(name, arith, size, sign, modulo_shift);
1751 case kw_reference_mode: {
1752 const char *name = read_string(env);
1753 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1754 int size = read_long(env);
1755 unsigned modulo_shift = read_long(env);
1756 ir_mode *mode = new_reference_mode(name, arith, size, modulo_shift);
1757 set_reference_mode_signed_eq(mode, read_mode(env));
1758 set_reference_mode_unsigned_eq(mode, read_mode(env));
1759 int is_mode_P = read_int(env);
1761 set_modeP_data(mode);
1762 set_modeP_code(mode);
1766 case kw_float_mode: {
1767 const char *name = read_string(env);
1768 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1769 int exponent_size = read_long(env);
1770 int mantissa_size = read_long(env);
1771 new_float_mode(name, arith, exponent_size, mantissa_size);
1783 static int parse_program(io_env_t *env)
1791 if (env->c == '}') {
1796 kwkind = (keyword_t) read_enum(env, tt_keyword);
1798 case kw_segment_type: {
1799 ir_segment_t segment = (ir_segment_t) read_enum(env, tt_segment);
1800 ir_type *type = read_type(env);
1801 set_segment_type(segment, type);
1805 parse_error(env, "unexpected keyword %d\n", kwkind);
1812 void ir_import(const char *filename)
1814 FILE *file = fopen(filename, "rt");
1820 ir_import_file(file, filename);
1825 void ir_import_file(FILE *input, const char *inputname)
1827 int oldoptimize = get_optimize();
1828 firm_verification_t oldver = get_node_verification_mode();
1830 io_env_t *env = &ioenv;
1835 memset(env, 0, sizeof(*env));
1836 obstack_init(&env->obst);
1837 env->idset = new_set(id_cmp, 128);
1838 env->fixedtypes = NEW_ARR_F(ir_type *, 0);
1839 env->inputname = inputname;
1843 /* read first character */
1847 do_node_verification(FIRM_VERIFICATION_OFF);
1856 kw = (keyword_t)read_enum(env, tt_keyword);
1859 if (!parse_modes(env)) goto end;
1863 if (!parse_typegraph(env)) goto end;
1868 ir_entity *irgent = get_entity(env, read_long(env));
1869 ir_graph *irg = new_ir_graph(irgent, 0);
1870 set_irg_frame_type(irg, get_type(env, read_long(env)));
1871 if (!parse_graph(env, irg)) goto end;
1876 ir_graph *constirg = get_const_code_irg();
1877 long bodyblockid = read_long(env);
1878 set_id(env, bodyblockid, constirg->current_block);
1879 if (!parse_graph(env, constirg)) goto end;
1888 parse_error(env, "Unexpected keyword %d at toplevel\n", kw);
1895 n = ARR_LEN(env->fixedtypes);
1896 for (i = 0; i < n; i++)
1897 set_type_state(env->fixedtypes[i], layout_fixed);
1899 DEL_ARR_F(env->fixedtypes);
1901 del_set(env->idset);
1903 irp_finalize_cons();
1905 do_node_verification(oldver);
1906 set_optimize(oldoptimize);
1908 obstack_free(&env->obst, NULL);