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_ieee754);
252 INSERTENUM(tt_pin_state, op_pin_state_floats);
253 INSERTENUM(tt_pin_state, op_pin_state_pinned);
254 INSERTENUM(tt_pin_state, op_pin_state_exc_pinned);
255 INSERTENUM(tt_pin_state, op_pin_state_mem_pinned);
257 INSERTENUM(tt_type_state, layout_undefined);
258 INSERTENUM(tt_type_state, layout_fixed);
260 INSERTENUM(tt_volatility, volatility_non_volatile);
261 INSERTENUM(tt_volatility, volatility_is_volatile);
268 static const char *get_segment_name(ir_segment_t segment)
271 case IR_SEGMENT_GLOBAL: return "global";
272 case IR_SEGMENT_THREAD_LOCAL: return "thread_local";
273 case IR_SEGMENT_CONSTRUCTORS: return "constructors";
274 case IR_SEGMENT_DESTRUCTORS: return "destructors";
276 return "INVALID_SEGMENT";
279 static const char *get_visibility_name(ir_visibility visibility)
281 switch (visibility) {
282 case ir_visibility_local: return "local";
283 case ir_visibility_external: return "external";
284 case ir_visibility_default: return "default";
285 case ir_visibility_private: return "private";
287 return "INVALID_VISIBILITY";
290 /** Returns the according symbol value for the given string and tag, or SYMERROR if none was found. */
291 static unsigned symbol(const char *str, typetag_t typetag)
293 symbol_t key, *entry;
296 key.typetag = typetag;
298 entry = (symbol_t*)set_find(symtbl, &key, sizeof(key), firm_fnv_hash_str(str) + typetag * 17);
299 return entry ? entry->code : SYMERROR;
302 static void *get_id(io_env_t *env, long id)
304 id_entry key, *entry;
307 entry = (id_entry*)set_find(env->idset, &key, sizeof(key), (unsigned) id);
308 return entry ? entry->elem : NULL;
311 static void set_id(io_env_t *env, long id, void *elem)
316 set_insert(env->idset, &key, sizeof(key), (unsigned) id);
319 static void write_long(io_env_t *env, long value)
321 fprintf(env->file, "%ld ", value);
324 static void write_int(io_env_t *env, int value)
326 fprintf(env->file, "%d ", value);
329 static void write_unsigned(io_env_t *env, unsigned value)
331 fprintf(env->file, "%u ", value);
334 static void write_entity_ref(io_env_t *env, ir_entity *entity)
336 write_long(env, get_entity_nr(entity));
339 static void write_type_ref(io_env_t *env, ir_type *type)
341 write_long(env, get_type_nr(type));
344 static void write_string(io_env_t *env, const char *string)
347 fputc('"', env->file);
348 for (c = string; *c != '\0'; ++c) {
351 fputc('\\', env->file);
352 fputc('n', env->file);
356 fputc('\\', env->file);
359 fputc(*c, env->file);
363 fputc('"', env->file);
366 static void write_ident(io_env_t *env, ident *id)
368 write_string(env, get_id_str(id));
369 fputc(' ', env->file);
372 static void write_ident_null(io_env_t *env, ident *id)
375 fputs("NULL ", env->file);
377 write_ident(env, id);
381 static void write_mode(io_env_t *env, ir_mode *mode)
383 write_string(env, get_mode_name(mode));
384 fputc(' ', env->file);
387 static void write_tarval(io_env_t *env, ir_tarval *tv)
390 write_mode(env, get_tarval_mode(tv));
391 tarval_snprintf(buf, sizeof(buf), tv);
392 fputs(buf, env->file);
393 fputc(' ', env->file);
396 static void write_align(io_env_t *env, ir_align align)
398 fputs(get_align_name(align), env->file);
399 fputc(' ', env->file);
402 static void write_builtin_kind(io_env_t *env, ir_node *irn)
404 fputs(get_builtin_kind_name(get_Builtin_kind(irn)), env->file);
405 fputc(' ', env->file);
408 static void write_cond_jmp_predicate(io_env_t *env, ir_node *irn)
410 fputs(get_cond_jmp_predicate_name(get_Cond_jmp_pred(irn)), env->file);
411 fputc(' ', env->file);
414 static void write_list_begin(io_env_t *env)
416 fputs("[", env->file);
419 static void write_list_end(io_env_t *env)
421 fputs("] ", env->file);
424 static void write_initializer(io_env_t *env, ir_initializer_t *ini)
427 ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
429 fputs(get_initializer_kind_name(ini_kind), f);
433 case IR_INITIALIZER_CONST:
434 write_long(env, get_irn_node_nr(get_initializer_const_value(ini)));
437 case IR_INITIALIZER_TARVAL:
438 write_tarval(env, get_initializer_tarval_value(ini));
441 case IR_INITIALIZER_NULL:
444 case IR_INITIALIZER_COMPOUND: {
445 size_t i, n = get_initializer_compound_n_entries(ini);
446 ir_fprintf(f, "%zu ", n);
447 for (i = 0; i < n; ++i)
448 write_initializer(env, get_initializer_compound_value(ini, i));
453 panic("Unknown initializer kind");
457 static void write_pin_state(io_env_t *env, ir_node *irn)
459 fputs(get_op_pin_state_name(get_irn_pinned(irn)), env->file);
460 fputc(' ', env->file);
463 static void write_volatility(io_env_t *env, ir_volatility vol)
465 fputs(get_volatility_name(vol), env->file);
466 fputc(' ', env->file);
469 static void export_type_common(io_env_t *env, ir_type *tp)
471 fprintf(env->file, "\ttype %ld %s %u %u %s %u ",
473 get_type_tpop_name(tp),
474 get_type_size_bytes(tp),
475 get_type_alignment_bytes(tp),
476 get_type_state_name(get_type_state(tp)),
480 static void export_type_pre(io_env_t *env, ir_type *tp)
484 /* skip types to be handled by post walker */
485 switch (get_type_tpop_code(tp)) {
494 export_type_common(env, tp);
496 switch (get_type_tpop_code(tp)) {
497 case tpo_uninitialized:
498 panic("invalid type found");
501 write_ident_null(env, get_compound_ident(tp));
505 write_mode(env, get_type_mode(tp));
510 case tpo_enumeration:
511 write_ident_null(env, get_compound_ident(tp));
525 static void export_type_post(io_env_t *env, ir_type *tp)
530 /* skip types already handled by pre walker */
531 switch (get_type_tpop_code(tp)) {
537 case tpo_uninitialized:
544 case tpo_enumeration:
548 export_type_common(env, tp);
550 switch (get_type_tpop_code(tp)) {
552 size_t n = get_array_n_dimensions(tp);
553 ir_fprintf(f, "%zu %ld ", n, get_type_nr(get_array_element_type(tp)));
554 for (i = 0; i < n; i++) {
555 ir_node *lower = get_array_lower_bound(tp, i);
556 ir_node *upper = get_array_upper_bound(tp, i);
559 write_long(env, get_tarval_long(get_Const_tarval(lower)));
561 panic("Lower array bound is not constant");
564 write_long(env, get_tarval_long(get_Const_tarval(upper)));
565 else if (is_Unknown(upper))
566 fputs("unknown ", f);
568 panic("Upper array bound is not constant");
574 size_t nparams = get_method_n_params(tp);
575 size_t nresults = get_method_n_ress(tp);
576 ir_fprintf(f, "%u %u %zu %zu ", get_method_calling_convention(tp),
577 get_method_additional_properties(tp), nparams, nresults);
578 for (i = 0; i < nparams; i++)
579 write_long(env, get_type_nr(get_method_param_type(tp, i)));
580 for (i = 0; i < nresults; i++)
581 write_long(env, get_type_nr(get_method_res_type(tp, i)));
582 ir_fprintf(f, "%u ", get_method_variadicity(tp));
587 write_mode(env, get_type_mode(tp));
588 write_long(env, get_type_nr(get_pointer_points_to_type(tp)));
591 case tpo_enumeration:
592 fprintf(stderr, "Enumeration type not handled yet by exporter\n");
596 printf("export_type: Unknown type code \"%s\".\n",
597 get_type_tpop_name(tp));
603 static void export_entity(io_env_t *env, ir_entity *ent)
605 FILE *file = env->file;
606 ir_type *owner = get_entity_owner(ent);
607 ir_visibility visibility = get_entity_visibility(ent);
608 ir_linkage linkage = get_entity_linkage(ent);
610 /* we don't dump array_element_ent entities. They're a strange concept
611 * and lead to cycles in type_graph.
613 if (is_Array_type(owner))
616 fprintf(env->file, "\tentity ");
617 write_long(env, get_entity_nr(ent));
618 write_ident_null(env, get_entity_ident(ent));
619 if (!entity_has_ld_ident(ent)) {
620 write_ident_null(env, NULL);
622 write_ident_null(env, get_entity_ld_ident(ent));
625 /* visibility + linkage */
626 if (visibility != ir_visibility_default) {
627 fprintf(file, "%s ", get_visibility_name(visibility));
629 if (linkage & IR_LINKAGE_CONSTANT)
630 fputs("constant ", file);
631 if (linkage & IR_LINKAGE_WEAK)
632 fputs("weak ", file);
633 if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
634 fputs("garbage_collect ", file);
635 if (linkage & IR_LINKAGE_MERGE)
636 fputs("merge ", file);
637 if (linkage & IR_LINKAGE_HIDDEN_USER)
638 fputs("hidden_user ", file);
640 fprintf(file, "%ld %ld %d %u %d %s ",
641 get_type_nr(get_entity_type(ent)),
643 get_entity_offset(ent),
644 (unsigned) get_entity_offset_bits_remainder(ent),
645 is_entity_compiler_generated(ent),
646 get_volatility_name(get_entity_volatility(ent)));
648 if (ent->initializer != NULL) {
649 fputs("initializer ", env->file);
650 write_initializer(env, get_entity_initializer(ent));
651 } else if (entity_has_compound_ent_values(ent)) {
652 size_t i, n = get_compound_ent_n_values(ent);
653 fputs("compoundgraph ", env->file);
654 ir_fprintf(env->file, "%zu ", n);
655 for (i = 0; i < n; i++) {
656 ir_entity *member = get_compound_ent_value_member(ent, i);
657 ir_node *irn = get_compound_ent_value(ent, i);
658 fprintf(env->file, "%ld %ld ", get_entity_nr(member), get_irn_node_nr(irn));
661 fputs("none", env->file);
664 fputc('\n', env->file);
667 static void export_type_or_ent_pre(type_or_ent tore, void *ctx)
669 io_env_t *env = (io_env_t *) ctx;
670 if (get_kind(tore.typ) == k_type)
671 export_type_pre(env, tore.typ);
674 static void export_type_or_ent_post(type_or_ent tore, void *ctx)
676 io_env_t *env = (io_env_t *) ctx;
678 switch (get_kind(tore.ent)) {
680 export_entity(env, tore.ent);
684 export_type_post(env, tore.typ);
688 panic("export_type_or_ent_post: Unknown type or entity.");
692 static void export_ASM(io_env_t *env, ir_node *node)
694 ir_asm_constraint *input_constraints = get_ASM_input_constraints(node);
695 ir_asm_constraint *output_constraints = get_ASM_output_constraints(node);
696 ident **clobbers = get_ASM_clobbers(node);
697 int n_input_constraints = get_ASM_n_input_constraints(node);
698 int n_output_constraints = get_ASM_n_output_constraints(node);
699 int n_clobbers = get_ASM_n_clobbers(node);
702 write_ident(env, get_ASM_text(node));
703 write_list_begin(env);
704 for (i = 0; i < n_input_constraints; ++i) {
705 const ir_asm_constraint *constraint = &input_constraints[i];
706 write_unsigned(env, constraint->pos);
707 write_ident(env, constraint->constraint);
708 write_mode(env, constraint->mode);
712 write_list_begin(env);
713 for (i = 0; i < n_output_constraints; ++i) {
714 const ir_asm_constraint *constraint = &output_constraints[i];
715 write_unsigned(env, constraint->pos);
716 write_ident(env, constraint->constraint);
717 write_mode(env, constraint->mode);
721 write_list_begin(env);
722 for (i = 0; i < n_clobbers; ++i) {
723 ident *clobber = clobbers[i];
724 write_ident(env, clobber);
730 * Walker: exports every node.
732 static void export_node(ir_node *irn, void *ctx)
734 io_env_t *env = (io_env_t *) ctx;
736 unsigned opcode = get_irn_opcode(irn);
738 if (env->ignoreblocks && opcode == iro_Block)
741 fprintf(env->file, "\t%s ", get_irn_opname(irn));
742 write_long(env, get_irn_node_nr(irn));
744 write_list_begin(env);
745 n = get_irn_arity(irn);
746 if (!is_Block(irn)) {
747 ir_node *block = get_nodes_block(irn);
748 write_long(env, get_irn_node_nr(block));
751 for (i = 0; i < n; i++) {
752 ir_node *pred = get_irn_n(irn, i);
754 /* Anchor node may have NULL predecessors */
755 assert(is_Anchor(irn));
756 fputs("-1 ", env->file);
758 write_long(env, get_irn_node_nr(pred));
763 fputs("{ ", env->file);
772 /* TODO: only symconst_addr_ent implemented yet */
773 assert(get_SymConst_kind(irn) == symconst_addr_ent);
774 fprintf(env->file, "%ld ", get_entity_nr(get_SymConst_entity(irn)));
775 write_mode(env, get_irn_mode(irn));
778 write_mode(env, get_irn_mode(irn));
779 fprintf(env->file, "%ld ", get_Proj_proj(irn));
782 export_ASM(env, irn);
784 #include "gen_irio_export.inl"
786 panic("no export code for node %+F\n", irn);
788 fputs("}\n", env->file);
791 static const char *get_mode_sort_name(ir_mode_sort sort)
794 case irms_auxiliary: return "auxiliary";
795 case irms_control_flow: return "control_flow";
796 case irms_memory: return "memory";
797 case irms_internal_boolean: return "internal_boolean";
798 case irms_reference: return "reference";
799 case irms_int_number: return "int_number";
800 case irms_float_number: return "float_number";
802 panic("invalid mode sort found");
805 static void export_modes(io_env_t *env)
807 size_t i, n_modes = get_irp_n_modes();
809 fputs("modes {\n", env->file);
811 for (i = 0; i < n_modes; i++) {
812 ir_mode *mode = get_irp_mode(i);
813 switch (get_mode_sort(mode)) {
815 case irms_control_flow:
817 case irms_internal_boolean:
818 /* skip "internal" modes, which may not be user defined */
824 fprintf(env->file, "\tmode ");
825 write_string(env, get_mode_name(mode));
826 fprintf(env->file, "%s %u %d %s %u ",
827 get_mode_sort_name(get_mode_sort(mode)),
828 get_mode_size_bits(mode), get_mode_sign(mode),
829 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
830 get_mode_modulo_shift(mode));
831 if (mode_is_reference(mode)) {
832 write_mode(env, get_reference_mode_signed_eq(mode));
833 write_mode(env, get_reference_mode_unsigned_eq(mode));
834 write_int(env, (mode == mode_P ? 1 : 0));
836 fputc('\n', env->file);
839 fputs("}\n", env->file);
842 static void export_program(io_env_t *env)
847 fputs("\nprogram {\n", f);
848 if (irp_prog_name_is_set()) {
849 fprintf(f, "\tname ");
850 write_string(env, get_irp_name());
854 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
855 ir_type *segment_type = get_segment_type(s);
856 fprintf(f, "\tsegment_type %s ", get_segment_name(s));
857 if (segment_type == NULL) {
860 write_long(env, get_type_nr(segment_type));
867 void ir_export(const char *filename)
869 FILE *file = fopen(filename, "wt");
875 ir_export_file(file, filename);
879 /* Exports the whole irp to the given file in a textual form. */
880 void ir_export_file(FILE *file, const char *outputname)
883 size_t i, n_irgs = get_irp_n_irgs();
890 fputs("\ntypegraph {\n", env.file);
891 type_walk_prog(export_type_or_ent_pre, export_type_or_ent_post, &env);
892 fputs("}\n", env.file);
894 for (i = 0; i < n_irgs; i++) {
895 ir_graph *irg = get_irp_irg(i);
897 fprintf(env.file, "\nirg %ld %ld {\n",
898 get_entity_nr(get_irg_entity(irg)),
899 get_type_nr(get_irg_frame_type(irg)));
901 env.ignoreblocks = 0;
902 irg_block_walk_graph(irg, NULL, export_node, &env);
904 env.ignoreblocks = 1;
905 irg_walk_anchors(irg, NULL, export_node, &env);
907 fputs("}\n", env.file);
910 fprintf(env.file, "\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
912 walk_const_code(NULL, export_node, &env);
913 fputs("}\n", env.file);
915 export_program(&env);
918 /* Exports the given irg to the given file. */
919 void ir_export_irg(ir_graph *irg, FILE *file, const char *outputname)
928 fputs("typegraph {\n", env.file);
930 type_walk_irg(irg, export_type_or_ent_pre, export_type_or_ent_post, &env);
932 fprintf(env.file, "}\n\nirg %ld {\n", get_entity_nr(get_irg_entity(irg)));
934 env.ignoreblocks = 0;
935 irg_block_walk_graph(irg, NULL, export_node, &env);
937 env.ignoreblocks = 1;
938 irg_walk_anchors(irg, NULL, export_node, &env);
940 /* TODO: Only output needed constants */
941 fprintf(env.file, "}\n\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
942 walk_const_code(NULL, export_node, &env);
943 fputs("}\n", env.file);
946 static void read_c(io_env_t *env)
948 int c = fgetc(env->file);
954 /** Returns the first non-whitespace character or EOF. **/
955 static void skip_ws(io_env_t *env)
972 static void skip_to(io_env_t *env, char to_ch)
974 while (env->c != to_ch && env->c != EOF) {
979 static int expect_char(io_env_t *env, char ch)
983 parse_error(env, "Unexpected char '%c', expected '%c'\n",
991 #define EXPECT(c) if (expect_char(env, (c))) {} else return 0
993 static char *read_word(io_env_t *env)
997 assert(obstack_object_size(&env->obst) == 0);
1009 obstack_1grow(&env->obst, c);
1016 obstack_1grow(&env->obst, '\0');
1017 return (char*)obstack_finish(&env->obst);
1020 static char *read_string(io_env_t *env)
1023 if (env->c != '"') {
1024 parse_error(env, "Expected string, got '%c'\n", env->c);
1029 assert(obstack_object_size(&env->obst) == 0);
1030 while (env->c != '"') {
1031 if (env->c == EOF) {
1032 parse_error(env, "Unexpected EOF while parsing string\n");
1036 if (env->c == '\\') {
1040 obstack_1grow(&env->obst, '\n');
1044 obstack_1grow(&env->obst, env->c);
1047 parse_error(env, "Unknown escape sequence '\\%c'\n", env->c);
1051 obstack_1grow(&env->obst, env->c);
1056 obstack_1grow(&env->obst, 0);
1058 return (char*)obstack_finish(&env->obst);
1061 static ident *read_ident(io_env_t *env)
1063 char *str = read_string(env);
1064 ident *res = new_id_from_str(str);
1065 obstack_free(&env->obst, str);
1070 * reads a "quoted string" or alternatively the token NULL
1072 static char *read_string_null(io_env_t *env)
1075 if (env->c == 'N') {
1076 char *str = read_word(env);
1077 if (strcmp(str, "NULL") == 0) {
1078 obstack_free(&env->obst, str);
1081 } else if (env->c == '"') {
1082 return read_string(env);
1085 parse_error(env, "Expected \"string\" or NULL\n");
1089 static ident *read_ident_null(io_env_t *env)
1092 char *str = read_string_null(env);
1096 res = new_id_from_str(str);
1097 obstack_free(&env->obst, str);
1101 static long read_long(io_env_t *env)
1107 if (!isdigit(env->c) && env->c != '-') {
1108 parse_error(env, "Expected number, got '%c'\n", env->c);
1112 assert(obstack_object_size(&env->obst) == 0);
1114 obstack_1grow(&env->obst, env->c);
1116 } while (isdigit(env->c));
1117 obstack_1grow(&env->obst, 0);
1119 str = (char*)obstack_finish(&env->obst);
1121 obstack_free(&env->obst, str);
1126 static int read_int(io_env_t *env)
1128 return (int) read_long(env);
1131 static unsigned read_unsigned(io_env_t *env)
1133 return (unsigned) read_long(env);
1136 static size_t read_size_t(io_env_t *env)
1139 return (size_t) read_unsigned(env);
1142 static void expect_list_begin(io_env_t *env)
1145 if (env->c != '[') {
1146 parse_error(env, "Expected list, got '%c'\n", env->c);
1152 static bool list_has_next(io_env_t *env)
1154 if (feof(env->file)) {
1155 parse_error(env, "Unexpected EOF while reading list");
1159 if (env->c == ']') {
1167 static ir_node *get_node_or_null(io_env_t *env, long nodenr)
1169 ir_node *node = (ir_node *) get_id(env, nodenr);
1170 if (node && node->kind != k_ir_node) {
1171 panic("Irn ID %ld collides with something else in line %d\n",
1177 static ir_node *get_node_or_dummy(io_env_t *env, long nodenr)
1179 ir_node *node = get_node_or_null(env, nodenr);
1181 node = new_r_Dummy(env->irg, mode_X);
1182 set_id(env, nodenr, node);
1187 static ir_type *get_type(io_env_t *env, long typenr)
1189 ir_type *type = (ir_type *) get_id(env, typenr);
1191 panic("unknown type: %ld in line %d\n", typenr, env->line);
1192 else if (type->kind != k_type)
1193 panic("type ID %ld collides with something else in line %d\n",
1198 static ir_type *read_type(io_env_t *env)
1200 return get_type(env, read_long(env));
1203 static ir_entity *get_entity(io_env_t *env, long entnr)
1205 ir_entity *entity = (ir_entity *) get_id(env, entnr);
1206 if (entity == NULL) {
1207 parse_error(env, "unknown entity: %ld\n", entnr);
1209 } else if (entity->kind != k_entity) {
1210 panic("Entity ID %ld collides with something else in line %d\n",
1217 static ir_entity *read_entity(io_env_t *env)
1219 return get_entity(env, read_long(env));
1222 static ir_mode *read_mode(io_env_t *env)
1224 char *str = read_string(env);
1227 n = get_irp_n_modes();
1228 for (i = 0; i < n; i++) {
1229 ir_mode *mode = get_irp_mode(i);
1230 if (strcmp(str, get_mode_name(mode)) == 0) {
1231 obstack_free(&env->obst, str);
1236 parse_error(env, "unknown mode \"%s\"\n", str);
1240 static const char *get_typetag_name(typetag_t typetag)
1243 case tt_align: return "align";
1244 case tt_allocation: return "allocation";
1245 case tt_builtin: return "builtin kind";
1246 case tt_cond_jmp_predicate: return "cond_jmp_predicate";
1247 case tt_initializer: return "initializer kind";
1248 case tt_iro: return "opcode";
1249 case tt_keyword: return "keyword";
1250 case tt_linkage: return "linkage";
1251 case tt_mode_arithmetic: return "mode_arithmetic";
1252 case tt_mode_sort: return "mode_sort";
1253 case tt_pin_state: return "pin state";
1254 case tt_segment: return "segment";
1255 case tt_tpo: return "type";
1256 case tt_type_state: return "type state";
1257 case tt_volatility: return "volatility";
1258 case tt_visibility: return "visibility";
1264 * Read and decode an enum constant.
1266 static unsigned read_enum(io_env_t *env, typetag_t typetag)
1268 char *str = read_word(env);
1269 unsigned code = symbol(str, typetag);
1271 if (code != SYMERROR) {
1272 obstack_free(&env->obst, str);
1276 parse_error(env, "invalid %s: \"%s\"\n", get_typetag_name(typetag), str);
1280 #define read_align(env) ((ir_align) read_enum(env, tt_align))
1281 #define read_allocation(env) ((ir_allocation) read_enum(env, tt_allocation))
1282 #define read_builtin_kind(env) ((ir_builtin_kind) read_enum(env, tt_builtin))
1283 #define read_cond_jmp_predicate(env) ((cond_jmp_predicate) read_enum(env, tt_cond_jmp_predicate))
1284 #define read_initializer_kind(env) ((ir_initializer_kind_t) read_enum(env, tt_initializer))
1285 #define read_mode_arithmetic(env) ((ir_mode_arithmetic) read_enum(env, tt_mode_arithmetic))
1286 #define read_peculiarity(env) ((ir_peculiarity) read_enum(env, tt_peculiarity))
1287 #define read_pin_state(env) ((op_pin_state) read_enum(env, tt_pin_state))
1288 #define read_type_state(env) ((ir_type_state) read_enum(env, tt_type_state))
1289 #define read_variability(env) ((ir_variability) read_enum(env, tt_variability))
1290 #define read_volatility(env) ((ir_volatility) read_enum(env, tt_volatility))
1292 static ir_tarval *read_tv(io_env_t *env)
1294 ir_mode *tvmode = read_mode(env);
1295 char *str = read_word(env);
1296 ir_tarval *tv = new_tarval_from_str(str, strlen(str), tvmode);
1297 obstack_free(&env->obst, str);
1302 static ir_initializer_t *read_initializer(io_env_t *env)
1304 ir_initializer_kind_t ini_kind = read_initializer_kind(env);
1307 case IR_INITIALIZER_CONST: {
1308 ir_node *irn = get_node_or_dummy(env, read_long(env));
1309 return create_initializer_const(irn);
1312 case IR_INITIALIZER_TARVAL:
1313 return create_initializer_tarval(read_tv(env));
1315 case IR_INITIALIZER_NULL:
1316 return get_initializer_null();
1318 case IR_INITIALIZER_COMPOUND: {
1319 size_t i, n = read_size_t(env);
1320 ir_initializer_t *ini = create_initializer_compound(n);
1321 for (i = 0; i < n; i++) {
1322 ir_initializer_t *curini = read_initializer(env);
1323 set_initializer_compound_value(ini, i, curini);
1329 panic("Unknown initializer kind");
1334 /** Reads a type description and remembers it by its id. */
1335 static void import_type(io_env_t *env)
1339 long typenr = read_long(env);
1340 tp_opcode tpop = (tp_opcode) read_enum(env, tt_tpo);
1341 unsigned size = (unsigned) read_long(env);
1342 unsigned align = (unsigned) read_long(env);
1343 ir_type_state state = read_type_state(env);
1344 unsigned flags = (unsigned) read_long(env);
1348 int ndims = (int) read_long(env);
1349 long elemtypenr = read_long(env);
1350 ir_type *elemtype = get_type(env, elemtypenr);
1352 type = new_type_array(ndims, elemtype);
1353 for (i = 0; i < ndims; i++) {
1354 char *str = read_word(env);
1355 if (strcmp(str, "unknown") != 0) {
1356 long lowerbound = atol(str);
1357 set_array_lower_bound_int(type, i, lowerbound);
1359 obstack_free(&env->obst, str);
1361 str = read_word(env);
1362 if (strcmp(str, "unknown") != 0) {
1363 long upperbound = atol(str);
1364 set_array_upper_bound_int(type, i, upperbound);
1366 obstack_free(&env->obst, str);
1368 set_type_size_bytes(type, size);
1373 ident *id = read_ident_null(env);
1375 if (typenr == (long) IR_SEGMENT_GLOBAL)
1376 type = get_glob_type();
1378 type = new_type_class(id);
1379 set_type_size_bytes(type, size);
1384 unsigned callingconv = (unsigned) read_long(env);
1385 mtp_additional_properties addprops = (mtp_additional_properties) read_long(env);
1386 int nparams = (int) read_long(env);
1387 int nresults = (int) read_long(env);
1390 type = new_type_method(nparams, nresults);
1392 for (i = 0; i < nparams; i++) {
1393 long ptypenr = read_long(env);
1394 ir_type *paramtype = get_type(env, ptypenr);
1396 set_method_param_type(type, i, paramtype);
1398 for (i = 0; i < nresults; i++) {
1399 long ptypenr = read_long(env);
1400 ir_type *restype = get_type(env, ptypenr);
1402 set_method_res_type(type, i, restype);
1405 variadicity = (int) read_long(env);
1406 set_method_variadicity(type, variadicity);
1408 set_method_calling_convention(type, callingconv);
1409 set_method_additional_properties(type, addprops);
1414 ir_mode *mode = read_mode(env);
1415 ir_type *pointsto = get_type(env, read_long(env));
1416 type = new_type_pointer(pointsto);
1417 set_type_mode(type, mode);
1421 case tpo_primitive: {
1422 ir_mode *mode = read_mode(env);
1423 type = new_type_primitive(mode);
1428 ident *id = read_ident_null(env);
1429 type = new_type_struct(id);
1430 set_type_size_bytes(type, size);
1435 ident *id = read_ident_null(env);
1436 type = new_type_union(id);
1437 set_type_size_bytes(type, size);
1442 return; /* ignore unknown type */
1445 parse_error(env, "unknown type kind: \"%d\"\n", tpop);
1450 set_type_alignment_bytes(type, align);
1451 type->flags = flags;
1453 if (state == layout_fixed)
1454 ARR_APP1(ir_type *, env->fixedtypes, type);
1456 set_id(env, typenr, type);
1459 /** Reads an entity description and remembers it by its id. */
1460 static void import_entity(io_env_t *env)
1462 long entnr = read_long(env);
1463 ident *name = read_ident(env);
1464 ident *ld_name = read_ident_null(env);
1465 ir_visibility visibility = ir_visibility_default;
1466 ir_linkage linkage = IR_LINKAGE_DEFAULT;
1475 while (!isdigit(env->c)) {
1476 char *vstr = read_word(env);
1481 v = symbol(vstr, tt_visibility);
1482 if (v != SYMERROR) {
1483 visibility = (ir_visibility)v;
1486 v = symbol(vstr, tt_linkage);
1487 if (v != SYMERROR) {
1488 linkage |= (ir_linkage)v;
1491 printf("Parser error, expected visibility or linkage, got '%s'\n",
1496 typenr = read_long(env);
1497 ownertypenr = read_long(env);
1499 type = get_type(env, typenr);
1500 ownertype = !ownertypenr ? get_glob_type() : get_type(env, ownertypenr);
1501 entity = new_entity(ownertype, name, type);
1503 if (ld_name != NULL)
1504 set_entity_ld_ident(entity, ld_name);
1505 set_entity_offset(entity, (int) read_long(env));
1506 set_entity_offset_bits_remainder(entity, (unsigned char) read_long(env));
1507 set_entity_compiler_generated(entity, (int) read_long(env));
1508 set_entity_volatility(entity, read_volatility(env));
1509 set_entity_visibility(entity, visibility);
1510 set_entity_linkage(entity, linkage);
1512 str = read_word(env);
1513 if (strcmp(str, "initializer") == 0) {
1514 set_entity_initializer(entity, read_initializer(env));
1515 } else if (strcmp(str, "compoundgraph") == 0) {
1516 int n = (int) read_long(env);
1518 for (i = 0; i < n; i++) {
1519 ir_entity *member = get_entity(env, read_long(env));
1520 ir_node *irn = get_node_or_dummy(env, read_long(env));
1521 add_compound_ent_value(entity, irn, member);
1523 } else if (strcmp(str, "none") == 0) {
1526 parse_error(env, "expected 'initializer', 'compoundgraph' or 'none' got '%s'\n", str);
1530 set_id(env, entnr, entity);
1533 /** Parses the whole type graph. */
1534 static int parse_typegraph(io_env_t *env)
1536 ir_graph *old_irg = env->irg;
1541 env->irg = get_const_code_irg();
1543 /* parse all types first */
1546 if (env->c == '}') {
1551 kwkind = (keyword_t) read_enum(env, tt_keyword);
1562 parse_error(env, "type graph element not supported yet: %d\n", kwkind);
1571 static int read_node_header(io_env_t *env, long *nodenr, ir_node ***preds,
1572 const char **nodename)
1576 *nodename = read_word(env);
1577 *nodenr = read_long(env);
1579 ARR_RESIZE(ir_node*, *preds, 0);
1581 expect_list_begin(env);
1582 for (numpreds = 0; list_has_next(env); numpreds++) {
1583 long val = read_long(env);
1584 ir_node *pred = get_node_or_dummy(env, val);
1585 ARR_APP1(ir_node*, *preds, pred);
1591 static ir_node *read_ASM(io_env_t *env, int numpreds, ir_node **preds)
1594 ir_asm_constraint *input_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1595 ir_asm_constraint *output_constraints = NEW_ARR_F(ir_asm_constraint, 0);
1596 ident **clobbers = NEW_ARR_F(ident*, 0);
1598 ident *asm_text = read_ident(env);
1600 expect_list_begin(env);
1601 while (list_has_next(env)) {
1602 ir_asm_constraint constraint;
1603 constraint.pos = read_unsigned(env);
1604 constraint.constraint = read_ident(env);
1605 constraint.mode = read_mode(env);
1606 ARR_APP1(ir_asm_constraint, input_constraints, constraint);
1609 expect_list_begin(env);
1610 while (list_has_next(env)) {
1611 ir_asm_constraint constraint;
1612 constraint.pos = read_unsigned(env);
1613 constraint.constraint = read_ident(env);
1614 constraint.mode = read_mode(env);
1615 ARR_APP1(ir_asm_constraint, output_constraints, constraint);
1618 expect_list_begin(env);
1619 while (list_has_next(env)) {
1620 ident *clobber = read_ident(env);
1621 ARR_APP1(ident*, clobbers, clobber);
1624 assert(ARR_LEN(input_constraints) == (size_t)numpreds-1);
1626 newnode = new_r_ASM(preds[0], numpreds-1, preds+1,
1628 ARR_LEN(output_constraints),
1633 DEL_ARR_F(clobbers);
1634 DEL_ARR_F(output_constraints);
1635 DEL_ARR_F(input_constraints);
1639 /** Parses an IRG. */
1640 static int parse_graph(io_env_t *env, ir_graph *irg)
1642 ir_node **preds = NEW_ARR_F(ir_node*,0);
1643 int i, numpreds, ret = 1;
1645 const char *nodename;
1646 ir_node *node, *newnode;
1654 if (env->c == '}') {
1659 numpreds = read_node_header(env, &nodenr, &preds, &nodename);
1661 node = get_node_or_null(env, nodenr);
1666 switch (symbol(nodename, tt_iro)) {
1668 ir_node *newendblock = preds[0];
1669 newnode = get_irg_end(irg);
1670 exchange(get_nodes_block(newnode), newendblock);
1671 for (i = 1; i < numpreds; i++)
1672 add_irn_n(newnode, preds[i]);
1677 ir_node *newstartblock = preds[0];
1678 newnode = get_irg_start(irg);
1679 exchange(get_nodes_block(newnode), newstartblock);
1684 newnode = new_r_Block(irg, numpreds, preds);
1688 newnode = irg->anchor;
1689 for (i = 1; i < numpreds; i++)
1690 set_irn_n(newnode, i-1, preds[i]);
1691 set_nodes_block(newnode, preds[0]);
1694 case iro_SymConst: {
1695 long entnr = read_long(env);
1696 union symconst_symbol sym;
1697 sym.entity_p = get_entity(env, entnr);
1698 ir_mode *mode = read_mode(env);
1699 newnode = new_r_SymConst(irg, mode, sym, symconst_addr_ent);
1704 ir_mode *mode = read_mode(env);
1705 long pn = read_long(env);
1706 newnode = new_r_Proj(preds[1], mode, pn);
1707 /* explicitely set block, since preds[1] might be a dummy node
1708 * which is always in the startblock */
1709 set_nodes_block(newnode, preds[0]);
1714 newnode = read_ASM(env, numpreds, preds);
1717 #include "gen_irio_import.inl"
1727 parse_error(env, "node type not supported yet: %s\n", nodename);
1732 exchange(node, newnode);
1733 /* Always update hash entry to avoid more uses of id nodes */
1734 set_id(env, nodenr, newnode);
1742 static int parse_modes(io_env_t *env)
1750 if (env->c == '}') {
1755 kwkind = (keyword_t) read_enum(env, tt_keyword);
1758 const char *name = read_string(env);
1759 ir_mode_sort sort = (ir_mode_sort)read_enum(env, tt_mode_sort);
1760 int size = read_long(env);
1761 int sign = read_long(env);
1762 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1763 unsigned modulo_shift = read_long(env);
1764 int vector_elems = read_long(env);
1767 if (vector_elems != 1) {
1768 panic("no support for import of vector modes yes");
1771 mode = new_ir_mode(name, sort, size, sign, arith, modulo_shift);
1772 if (mode_is_reference(mode)) {
1773 set_reference_mode_signed_eq(mode, read_mode(env));
1774 set_reference_mode_unsigned_eq(mode, read_mode(env));
1775 int is_mode_P = read_int(env);
1777 set_modeP_data(mode);
1778 set_modeP_code(mode);
1792 static int parse_program(io_env_t *env)
1800 if (env->c == '}') {
1805 kwkind = (keyword_t) read_enum(env, tt_keyword);
1807 case kw_segment_type: {
1808 ir_segment_t segment = (ir_segment_t) read_enum(env, tt_segment);
1809 ir_type *type = read_type(env);
1810 set_segment_type(segment, type);
1814 parse_error(env, "unexpected keyword %d\n", kwkind);
1821 void ir_import(const char *filename)
1823 FILE *file = fopen(filename, "rt");
1829 ir_import_file(file, filename);
1834 void ir_import_file(FILE *input, const char *inputname)
1836 int oldoptimize = get_optimize();
1837 firm_verification_t oldver = get_node_verification_mode();
1839 io_env_t *env = &ioenv;
1844 memset(env, 0, sizeof(*env));
1845 obstack_init(&env->obst);
1846 env->idset = new_set(id_cmp, 128);
1847 env->fixedtypes = NEW_ARR_F(ir_type *, 0);
1848 env->inputname = inputname;
1852 /* read first character */
1856 do_node_verification(FIRM_VERIFICATION_OFF);
1865 kw = (keyword_t)read_enum(env, tt_keyword);
1868 if (!parse_modes(env)) goto end;
1872 if (!parse_typegraph(env)) goto end;
1877 ir_entity *irgent = get_entity(env, read_long(env));
1878 ir_graph *irg = new_ir_graph(irgent, 0);
1879 set_irg_frame_type(irg, get_type(env, read_long(env)));
1880 if (!parse_graph(env, irg)) goto end;
1885 ir_graph *constirg = get_const_code_irg();
1886 long bodyblockid = read_long(env);
1887 set_id(env, bodyblockid, constirg->current_block);
1888 if (!parse_graph(env, constirg)) goto end;
1897 parse_error(env, "Unexpected keyword %d at toplevel\n", kw);
1904 n = ARR_LEN(env->fixedtypes);
1905 for (i = 0; i < n; i++)
1906 set_type_state(env->fixedtypes[i], layout_fixed);
1908 DEL_ARR_F(env->fixedtypes);
1910 del_set(env->idset);
1912 irp_finalize_cons();
1914 do_node_verification(oldver);
1915 set_optimize(oldoptimize);
1917 obstack_free(&env->obst, NULL);