2 * Copyright (C) 1995-2009 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"
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,
84 typedef enum keyword_t
97 typedef struct symbol_t
99 const char *str; /**< The name of this symbol. */
100 typetag_t typetag; /**< The type tag of this symbol. */
101 unsigned code; /**< The value of this symbol. */
104 typedef struct id_entry
110 /** The symbol table, a set of symbol_t elements. */
114 * Compare two symbol table entries.
116 static int symbol_cmp(const void *elt, const void *key, size_t size)
119 const symbol_t *entry = (const symbol_t *) elt;
120 const symbol_t *keyentry = (const symbol_t *) key;
122 res = entry->typetag - keyentry->typetag;
124 return strcmp(entry->str, keyentry->str);
127 static int id_cmp(const void *elt, const void *key, size_t size)
129 const id_entry *entry = (const id_entry *) elt;
130 const id_entry *keyentry = (const id_entry *) key;
132 return entry->id - keyentry->id;
135 static void __attribute__((format(printf, 2, 3)))
136 parse_error(io_env_t *env, const char *fmt, ...)
139 int line = env->line;
141 /* workaround read_c "feature" that a '\n' triggers the line++
142 * instead of the character after the '\n' */
143 if (env->c == '\n') {
147 fprintf(stderr, "%s:%d: error ", env->inputname, line);
150 vfprintf(stderr, fmt, ap);
154 /** Initializes the symbol table. May be called more than once without problems. */
155 static void symtbl_init(void)
159 /* Only initialize once */
163 symtbl = new_set(symbol_cmp, 256);
165 #define INSERT(tt, s, cod) \
167 key.typetag = (tt); \
169 set_insert(symtbl, &key, sizeof(key), firm_fnv_hash_str(s) + tt * 17)
171 #define INSERTENUM(tt, e) INSERT(tt, #e, e)
172 #define INSERTKEYWORD(k) INSERT(tt_keyword, #k, kw_##k)
174 INSERT(tt_tpo, "array", tpo_array);
175 INSERT(tt_tpo, "class", tpo_class);
176 INSERT(tt_tpo, "method", tpo_method);
177 INSERT(tt_tpo, "pointer", tpo_pointer);
178 INSERT(tt_tpo, "primitive", tpo_primitive);
179 INSERT(tt_tpo, "struct", tpo_struct);
180 INSERT(tt_tpo, "union", tpo_union);
181 INSERT(tt_tpo, "Unknown", tpo_unknown);
183 INSERT(tt_mode_sort, "auxiliary", irms_auxiliary);
184 INSERT(tt_mode_sort, "control_flow", irms_control_flow);
185 INSERT(tt_mode_sort, "memory", irms_memory);
186 INSERT(tt_mode_sort, "internal_boolean", irms_internal_boolean);
187 INSERT(tt_mode_sort, "reference", irms_reference);
188 INSERT(tt_mode_sort, "int_number", irms_int_number);
189 INSERT(tt_mode_sort, "float_number", irms_float_number);
191 INSERT(tt_segment, "global", IR_SEGMENT_GLOBAL);
192 INSERT(tt_segment, "thread_local", IR_SEGMENT_THREAD_LOCAL);
193 INSERT(tt_segment, "constructors", IR_SEGMENT_CONSTRUCTORS);
194 INSERT(tt_segment, "destructors", IR_SEGMENT_DESTRUCTORS);
196 INSERT(tt_linkage, "constant", IR_LINKAGE_CONSTANT);
197 INSERT(tt_linkage, "weak", IR_LINKAGE_WEAK);
198 INSERT(tt_linkage, "garbage_collect", IR_LINKAGE_GARBAGE_COLLECT);
199 INSERT(tt_linkage, "merge", IR_LINKAGE_MERGE);
200 INSERT(tt_linkage, "hidden_user", IR_LINKAGE_HIDDEN_USER);
202 INSERT(tt_visibility, "local", ir_visibility_local);
203 INSERT(tt_visibility, "external", ir_visibility_external);
204 INSERT(tt_visibility, "default", ir_visibility_default);
205 INSERT(tt_visibility, "private", ir_visibility_private);
207 INSERTKEYWORD(constirg);
208 INSERTKEYWORD(entity);
211 INSERTKEYWORD(modes);
213 INSERTKEYWORD(typegraph);
214 INSERTKEYWORD(program);
215 INSERTKEYWORD(segment_type);
217 #include "gen_irio_lex.inl"
219 INSERTENUM(tt_align, align_non_aligned);
220 INSERTENUM(tt_align, align_is_aligned);
222 INSERTENUM(tt_builtin, ir_bk_trap);
223 INSERTENUM(tt_builtin, ir_bk_debugbreak);
224 INSERTENUM(tt_builtin, ir_bk_return_address);
225 INSERTENUM(tt_builtin, ir_bk_frame_address);
226 INSERTENUM(tt_builtin, ir_bk_prefetch);
227 INSERTENUM(tt_builtin, ir_bk_ffs);
228 INSERTENUM(tt_builtin, ir_bk_clz);
229 INSERTENUM(tt_builtin, ir_bk_ctz);
230 INSERTENUM(tt_builtin, ir_bk_popcount);
231 INSERTENUM(tt_builtin, ir_bk_parity);
232 INSERTENUM(tt_builtin, ir_bk_bswap);
233 INSERTENUM(tt_builtin, ir_bk_inport);
234 INSERTENUM(tt_builtin, ir_bk_outport);
235 INSERTENUM(tt_builtin, ir_bk_inner_trampoline);
237 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_NONE);
238 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_TRUE);
239 INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_FALSE);
241 INSERTENUM(tt_initializer, IR_INITIALIZER_CONST);
242 INSERTENUM(tt_initializer, IR_INITIALIZER_TARVAL);
243 INSERTENUM(tt_initializer, IR_INITIALIZER_NULL);
244 INSERTENUM(tt_initializer, IR_INITIALIZER_COMPOUND);
246 INSERTENUM(tt_mode_arithmetic, irma_uninitialized);
247 INSERTENUM(tt_mode_arithmetic, irma_none);
248 INSERTENUM(tt_mode_arithmetic, irma_twos_complement);
249 INSERTENUM(tt_mode_arithmetic, irma_ones_complement);
250 INSERTENUM(tt_mode_arithmetic, irma_int_BCD);
251 INSERTENUM(tt_mode_arithmetic, irma_ieee754);
252 INSERTENUM(tt_mode_arithmetic, irma_float_BCD);
254 INSERTENUM(tt_pin_state, op_pin_state_floats);
255 INSERTENUM(tt_pin_state, op_pin_state_pinned);
256 INSERTENUM(tt_pin_state, op_pin_state_exc_pinned);
257 INSERTENUM(tt_pin_state, op_pin_state_mem_pinned);
259 INSERTENUM(tt_type_state, layout_undefined);
260 INSERTENUM(tt_type_state, layout_fixed);
262 INSERTENUM(tt_volatility, volatility_non_volatile);
263 INSERTENUM(tt_volatility, volatility_is_volatile);
270 static const char *get_segment_name(ir_segment_t segment)
273 case IR_SEGMENT_GLOBAL: return "global";
274 case IR_SEGMENT_THREAD_LOCAL: return "thread_local";
275 case IR_SEGMENT_CONSTRUCTORS: return "constructors";
276 case IR_SEGMENT_DESTRUCTORS: return "destructors";
278 return "INVALID_SEGMENT";
281 static const char *get_visibility_name(ir_visibility visibility)
283 switch (visibility) {
284 case ir_visibility_local: return "local";
285 case ir_visibility_external: return "external";
286 case ir_visibility_default: return "default";
287 case ir_visibility_private: return "private";
289 return "INVALID_VISIBILITY";
292 /** Returns the according symbol value for the given string and tag, or SYMERROR if none was found. */
293 static unsigned symbol(const char *str, typetag_t typetag)
295 symbol_t key, *entry;
298 key.typetag = typetag;
300 entry = (symbol_t*)set_find(symtbl, &key, sizeof(key), firm_fnv_hash_str(str) + typetag * 17);
301 return entry ? entry->code : SYMERROR;
304 static void *get_id(io_env_t *env, long id)
306 id_entry key, *entry;
309 entry = (id_entry*)set_find(env->idset, &key, sizeof(key), (unsigned) id);
310 return entry ? entry->elem : NULL;
313 static void set_id(io_env_t *env, long id, void *elem)
318 set_insert(env->idset, &key, sizeof(key), (unsigned) id);
321 static void write_long(io_env_t *env, long value)
323 fprintf(env->file, "%ld ", value);
326 static void write_int(io_env_t *env, int value)
328 fprintf(env->file, "%d ", value);
331 static void write_unsigned(io_env_t *env, unsigned value)
333 fprintf(env->file, "%u ", value);
336 static void write_entity_ref(io_env_t *env, ir_entity *entity)
338 write_long(env, get_entity_nr(entity));
341 static void write_type_ref(io_env_t *env, ir_type *type)
343 write_long(env, get_type_nr(type));
346 static void write_string(io_env_t *env, const char *string)
349 fputc('"', env->file);
350 for (c = string; *c != '\0'; ++c) {
353 fputc('\\', env->file);
354 fputc('n', env->file);
358 fputc('\\', env->file);
361 fputc(*c, env->file);
365 fputc('"', env->file);
368 static void write_ident(io_env_t *env, ident *id)
370 write_string(env, get_id_str(id));
371 fputc(' ', env->file);
374 static void write_ident_null(io_env_t *env, ident *id)
377 fputs("NULL ", env->file);
379 write_ident(env, id);
383 static void write_mode(io_env_t *env, ir_mode *mode)
385 fputs(get_mode_name(mode), env->file);
386 fputc(' ', env->file);
389 static void write_tarval(io_env_t *env, ir_tarval *tv)
392 write_mode(env, get_tarval_mode(tv));
393 tarval_snprintf(buf, sizeof(buf), tv);
394 fputs(buf, env->file);
395 fputc(' ', env->file);
398 static void write_align(io_env_t *env, ir_node *irn)
403 align = get_Load_align(irn);
404 else if (is_Store(irn))
405 align = get_Store_align(irn);
407 panic("Invalid optype for write_align");
409 fputs(get_align_name(align), env->file);
410 fputc(' ', env->file);
413 static void write_builtin_kind(io_env_t *env, ir_node *irn)
415 fputs(get_builtin_kind_name(get_Builtin_kind(irn)), env->file);
416 fputc(' ', env->file);
419 static void write_cond_jmp_predicate(io_env_t *env, ir_node *irn)
421 fputs(get_cond_jmp_predicate_name(get_Cond_jmp_pred(irn)), env->file);
422 fputc(' ', env->file);
425 static void write_list_begin(io_env_t *env)
427 fputs("[", env->file);
430 static void write_list_end(io_env_t *env)
432 fputs("] ", env->file);
435 static void write_initializer(io_env_t *env, ir_initializer_t *ini)
438 ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
440 fputs(get_initializer_kind_name(ini_kind), f);
444 case IR_INITIALIZER_CONST:
445 write_long(env, get_irn_node_nr(get_initializer_const_value(ini)));
448 case IR_INITIALIZER_TARVAL:
449 write_tarval(env, get_initializer_tarval_value(ini));
452 case IR_INITIALIZER_NULL:
455 case IR_INITIALIZER_COMPOUND: {
456 unsigned i, n = get_initializer_compound_n_entries(ini);
457 fprintf(f, "%u ", n);
458 for (i = 0; i < n; i++)
459 write_initializer(env, get_initializer_compound_value(ini, i));
464 panic("Unknown initializer kind");
468 static void write_pin_state(io_env_t *env, ir_node *irn)
470 fputs(get_op_pin_state_name(get_irn_pinned(irn)), env->file);
471 fputc(' ', env->file);
474 static void write_volatility(io_env_t *env, ir_node *irn)
479 vol = get_Load_volatility(irn);
480 else if (is_Store(irn))
481 vol = get_Store_volatility(irn);
483 panic("Invalid optype for write_volatility");
485 fputs(get_volatility_name(vol), env->file);
486 fputc(' ', env->file);
489 static void export_type_common(io_env_t *env, ir_type *tp)
491 fprintf(env->file, "\ttype %ld %s %u %u %s %u ",
493 get_type_tpop_name(tp),
494 get_type_size_bytes(tp),
495 get_type_alignment_bytes(tp),
496 get_type_state_name(get_type_state(tp)),
500 static void export_type_pre(io_env_t *env, ir_type *tp)
504 /* skip types to be handled by post walker */
505 switch (get_type_tpop_code(tp)) {
514 export_type_common(env, tp);
516 switch (get_type_tpop_code(tp)) {
517 case tpo_uninitialized:
518 panic("invalid type found");
521 write_ident_null(env, get_compound_ident(tp));
525 write_mode(env, get_type_mode(tp));
530 case tpo_enumeration:
531 write_ident_null(env, get_compound_ident(tp));
545 static void export_type_post(io_env_t *env, ir_type *tp)
550 /* skip types already handled by pre walker */
551 switch (get_type_tpop_code(tp)) {
557 case tpo_uninitialized:
564 case tpo_enumeration:
568 export_type_common(env, tp);
570 switch (get_type_tpop_code(tp)) {
572 int n = get_array_n_dimensions(tp);
573 fprintf(f, "%d %ld ", n, get_type_nr(get_array_element_type(tp)));
574 for (i = 0; i < n; i++) {
575 ir_node *lower = get_array_lower_bound(tp, i);
576 ir_node *upper = get_array_upper_bound(tp, i);
579 write_long(env, get_tarval_long(get_Const_tarval(lower)));
581 panic("Lower array bound is not constant");
584 write_long(env, get_tarval_long(get_Const_tarval(upper)));
585 else if (is_Unknown(upper))
586 fputs("unknown ", f);
588 panic("Upper array bound is not constant");
594 int nparams = get_method_n_params(tp);
595 int nresults = get_method_n_ress(tp);
596 fprintf(f, "%u %u %d %d ", get_method_calling_convention(tp),
597 get_method_additional_properties(tp), nparams, nresults);
598 for (i = 0; i < nparams; i++)
599 write_long(env, get_type_nr(get_method_param_type(tp, i)));
600 for (i = 0; i < nresults; i++)
601 write_long(env, get_type_nr(get_method_res_type(tp, i)));
602 fprintf(f, "%d ", get_method_first_variadic_param_index(tp));
607 write_mode(env, get_type_mode(tp));
608 write_long(env, get_type_nr(get_pointer_points_to_type(tp)));
611 case tpo_enumeration:
612 fprintf(stderr, "Enumeration type not handled yet by exporter\n");
616 printf("export_type: Unknown type code \"%s\".\n",
617 get_type_tpop_name(tp));
623 static void export_entity(io_env_t *env, ir_entity *ent)
625 FILE *file = env->file;
626 ir_type *owner = get_entity_owner(ent);
627 ir_visibility visibility = get_entity_visibility(ent);
628 ir_linkage linkage = get_entity_linkage(ent);
630 /* we don't dump array_element_ent entities. They're a strange concept
631 * and lead to cycles in type_graph.
633 if (is_Array_type(owner))
636 fprintf(env->file, "\tentity ");
637 write_long(env, get_entity_nr(ent));
638 write_ident_null(env, get_entity_ident(ent));
639 if (!entity_has_ld_ident(ent)) {
640 write_ident_null(env, NULL);
642 write_ident_null(env, get_entity_ld_ident(ent));
645 /* visibility + linkage */
646 if (visibility != ir_visibility_default) {
647 fprintf(file, "%s ", get_visibility_name(visibility));
649 if (linkage & IR_LINKAGE_CONSTANT)
650 fputs("constant ", file);
651 if (linkage & IR_LINKAGE_WEAK)
652 fputs("weak ", file);
653 if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
654 fputs("garbage_collect ", file);
655 if (linkage & IR_LINKAGE_MERGE)
656 fputs("merge ", file);
657 if (linkage & IR_LINKAGE_HIDDEN_USER)
658 fputs("hidden_user ", file);
660 fprintf(file, "%ld %ld %d %u %d %s ",
661 get_type_nr(get_entity_type(ent)),
663 get_entity_offset(ent),
664 (unsigned) get_entity_offset_bits_remainder(ent),
665 is_entity_compiler_generated(ent),
666 get_volatility_name(get_entity_volatility(ent)));
668 if (ent->initializer != NULL) {
669 fputs("initializer ", env->file);
670 write_initializer(env, get_entity_initializer(ent));
671 } else if (entity_has_compound_ent_values(ent)) {
672 int i, n = get_compound_ent_n_values(ent);
673 fputs("compoundgraph ", env->file);
674 fprintf(env->file, "%d ", n);
675 for (i = 0; i < n; i++) {
676 ir_entity *member = get_compound_ent_value_member(ent, i);
677 ir_node *irn = get_compound_ent_value(ent, i);
678 fprintf(env->file, "%ld %ld ", get_entity_nr(member), get_irn_node_nr(irn));
681 fputs("none", env->file);
684 fputc('\n', env->file);
687 static void export_type_or_ent_pre(type_or_ent tore, void *ctx)
689 io_env_t *env = (io_env_t *) ctx;
690 if (get_kind(tore.typ) == k_type)
691 export_type_pre(env, tore.typ);
694 static void export_type_or_ent_post(type_or_ent tore, void *ctx)
696 io_env_t *env = (io_env_t *) ctx;
698 switch (get_kind(tore.ent)) {
700 export_entity(env, tore.ent);
704 export_type_post(env, tore.typ);
708 panic("export_type_or_ent_post: Unknown type or entity.");
714 * Walker: exports every node.
716 static void export_node(ir_node *irn, void *ctx)
718 io_env_t *env = (io_env_t *) ctx;
720 unsigned opcode = get_irn_opcode(irn);
722 if (env->ignoreblocks && opcode == iro_Block)
725 fprintf(env->file, "\t%s ", get_irn_opname(irn));
726 write_long(env, get_irn_node_nr(irn));
728 write_list_begin(env);
729 n = get_irn_arity(irn);
730 if (!is_Block(irn)) {
731 ir_node *block = get_nodes_block(irn);
732 write_long(env, get_irn_node_nr(block));
735 for (i = 0; i < n; i++) {
736 ir_node *pred = get_irn_n(irn, i);
738 /* Anchor node may have NULL predecessors */
739 assert(is_Anchor(irn));
740 fputs("-1 ", env->file);
742 write_long(env, get_irn_node_nr(pred));
747 fputs("{ ", env->file);
756 /* TODO: only symconst_addr_ent implemented yet */
757 assert(get_SymConst_kind(irn) == symconst_addr_ent);
758 fprintf(env->file, "%ld ", get_entity_nr(get_SymConst_entity(irn)));
761 write_mode(env, get_irn_mode(irn));
762 fprintf(env->file, "%ld ", get_Proj_proj(irn));
764 #include "gen_irio_export.inl"
766 panic("no export code for node %+F\n", irn);
768 fputs("}\n", env->file);
771 static const char *get_mode_sort_name(ir_mode_sort sort)
774 case irms_auxiliary: return "auxiliary";
775 case irms_control_flow: return "control_flow";
776 case irms_memory: return "memory";
777 case irms_internal_boolean: return "internal_boolean";
778 case irms_reference: return "reference";
779 case irms_int_number: return "int_number";
780 case irms_float_number: return "float_number";
782 panic("invalid mode sort found");
785 static void export_modes(io_env_t *env)
787 int 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);
793 switch (get_mode_sort(mode)) {
795 case irms_control_flow:
797 case irms_internal_boolean:
798 /* skip "internal" modes, which may not be user defined */
804 fprintf(env->file, "\tmode ");
805 write_string(env, get_mode_name(mode));
806 fprintf(env->file, "%s %u %d %s %u %u ",
807 get_mode_sort_name(get_mode_sort(mode)),
808 get_mode_size_bits(mode), get_mode_sign(mode),
809 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
810 get_mode_modulo_shift(mode),
811 get_mode_n_vector_elems(mode));
812 if (mode_is_reference(mode)) {
813 write_mode(env, get_reference_mode_signed_eq(mode));
814 write_mode(env, get_reference_mode_unsigned_eq(mode));
816 fputc('\n', env->file);
819 fputs("}\n", env->file);
822 static void export_program(io_env_t *env)
827 fputs("\nprogram {\n", f);
828 if (irp_prog_name_is_set()) {
829 fprintf(f, "\tname ");
830 write_string(env, get_irp_name());
834 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
835 ir_type *segment_type = get_segment_type(s);
836 fprintf(f, "\tsegment_type %s ", get_segment_name(s));
837 if (segment_type == NULL) {
840 write_long(env, get_type_nr(segment_type));
847 void ir_export(const char *filename)
849 FILE *file = fopen(filename, "wt");
855 ir_export_file(file, filename);
859 /* Exports the whole irp to the given file in a textual form. */
860 void ir_export_file(FILE *file, const char *outputname)
863 int i, n_irgs = get_irp_n_irgs();
870 fputs("\ntypegraph {\n", env.file);
871 type_walk_prog(export_type_or_ent_pre, export_type_or_ent_post, &env);
872 fputs("}\n", env.file);
874 for (i = 0; i < n_irgs; i++) {
875 ir_graph *irg = get_irp_irg(i);
876 ir_type *valuetype = get_irg_value_param_type(irg);
878 fprintf(env.file, "\nirg %ld %ld %ld {\n",
879 get_entity_nr(get_irg_entity(irg)),
880 get_type_nr(get_irg_frame_type(irg)),
881 valuetype == NULL ? -1 : get_type_nr(valuetype));
883 env.ignoreblocks = 0;
884 irg_block_walk_graph(irg, NULL, export_node, &env);
886 env.ignoreblocks = 1;
887 irg_walk_anchors(irg, NULL, export_node, &env);
889 fputs("}\n", env.file);
892 fprintf(env.file, "\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
894 walk_const_code(NULL, export_node, &env);
895 fputs("}\n", env.file);
897 export_program(&env);
900 /* Exports the given irg to the given file. */
901 void ir_export_irg(ir_graph *irg, FILE *file, const char *outputname)
910 fputs("typegraph {\n", env.file);
912 type_walk_irg(irg, export_type_or_ent_pre, export_type_or_ent_post, &env);
914 fprintf(env.file, "}\n\nirg %ld {\n", get_entity_nr(get_irg_entity(irg)));
916 env.ignoreblocks = 0;
917 irg_block_walk_graph(irg, NULL, export_node, &env);
919 env.ignoreblocks = 1;
920 irg_walk_anchors(irg, NULL, export_node, &env);
922 /* TODO: Only output needed constants */
923 fprintf(env.file, "}\n\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
924 walk_const_code(NULL, export_node, &env);
925 fputs("}\n", env.file);
928 static void read_c(io_env_t *env)
930 int c = fgetc(env->file);
936 /** Returns the first non-whitespace character or EOF. **/
937 static void skip_ws(io_env_t *env)
954 static void skip_to(io_env_t *env, char to_ch)
956 while (env->c != to_ch && env->c != EOF) {
961 static int expect_char(io_env_t *env, char ch)
965 parse_error(env, "Unexpected char '%c', expected '%c'\n",
973 #define EXPECT(c) if (expect_char(env, (c))) {} else return 0
975 static char *read_word(io_env_t *env)
979 assert(obstack_object_size(&env->obst) == 0);
991 obstack_1grow(&env->obst, c);
998 obstack_1grow(&env->obst, '\0');
999 return (char*)obstack_finish(&env->obst);
1002 static char *read_string(io_env_t *env)
1005 if (env->c != '"') {
1006 parse_error(env, "Expected string, got '%c'\n", env->c);
1011 assert(obstack_object_size(&env->obst) == 0);
1012 while (env->c != '"') {
1013 if (env->c == EOF) {
1014 parse_error(env, "Unexpected EOF while parsing string\n");
1018 if (env->c == '\\') {
1022 obstack_1grow(&env->obst, '\n');
1026 obstack_1grow(&env->obst, env->c);
1029 parse_error(env, "Unknown escape sequence '\\%c'\n", env->c);
1034 obstack_1grow(&env->obst, env->c);
1039 obstack_1grow(&env->obst, 0);
1041 return (char*)obstack_finish(&env->obst);
1044 static ident *read_ident(io_env_t *env)
1046 char *str = read_string(env);
1047 ident *res = new_id_from_str(str);
1048 obstack_free(&env->obst, str);
1053 * reads a "quoted string" or alternatively the token NULL
1055 static char *read_string_null(io_env_t *env)
1058 if (env->c == 'N') {
1059 char *str = read_word(env);
1060 if (strcmp(str, "NULL") == 0) {
1061 obstack_free(&env->obst, str);
1064 } else if (env->c == '"') {
1065 return read_string(env);
1068 parse_error(env, "Expected \"string\" or NULL\n");
1072 static ident *read_ident_null(io_env_t *env)
1075 char *str = read_string_null(env);
1079 res = new_id_from_str(str);
1080 obstack_free(&env->obst, str);
1084 static long read_long(io_env_t *env)
1090 if (!isdigit(env->c) && env->c != '-') {
1091 parse_error(env, "Expected number, got '%c'\n", env->c);
1095 assert(obstack_object_size(&env->obst) == 0);
1097 obstack_1grow(&env->obst, env->c);
1099 } while (isdigit(env->c));
1100 obstack_1grow(&env->obst, 0);
1102 str = (char*)obstack_finish(&env->obst);
1104 obstack_free(&env->obst, str);
1109 static int read_int(io_env_t *env)
1111 return (int) read_long(env);
1114 static unsigned read_unsigned(io_env_t *env)
1116 return (unsigned) read_long(env);
1119 static void expect_list_begin(io_env_t *env)
1122 if (env->c != '[') {
1123 parse_error(env, "Expected list, got '%c'\n", env->c);
1129 static bool list_has_next(io_env_t *env)
1131 if (feof(env->file)) {
1132 parse_error(env, "Unexpected EOF while reading list");
1136 if (env->c == ']') {
1144 static ir_node *get_node_or_null(io_env_t *env, long nodenr)
1146 ir_node *node = (ir_node *) get_id(env, nodenr);
1147 if (node && node->kind != k_ir_node) {
1148 panic("Irn ID %ld collides with something else in line %d\n",
1154 static ir_node *get_node_or_dummy(io_env_t *env, long nodenr)
1156 ir_node *node = get_node_or_null(env, nodenr);
1158 node = new_r_Dummy(env->irg, mode_X);
1159 set_id(env, nodenr, node);
1164 static ir_type *get_type(io_env_t *env, long typenr)
1166 ir_type *type = (ir_type *) get_id(env, typenr);
1168 panic("unknown type: %ld in line %d\n", typenr, env->line);
1169 else if (type->kind != k_type)
1170 panic("type ID %ld collides with something else in line %d\n",
1175 static ir_type *read_type(io_env_t *env)
1177 return get_type(env, read_long(env));
1180 static ir_entity *get_entity(io_env_t *env, long entnr)
1182 ir_entity *entity = (ir_entity *) get_id(env, entnr);
1183 if (entity == NULL) {
1184 parse_error(env, "unknown entity: %ld\n", entnr);
1186 } else if (entity->kind != k_entity) {
1187 panic("Entity ID %ld collides with something else in line %d\n",
1194 static ir_entity *read_entity(io_env_t *env)
1196 return get_entity(env, read_long(env));
1199 static ir_mode *read_mode(io_env_t *env)
1201 char *str = read_word(env);
1204 n = get_irp_n_modes();
1205 for (i = 0; i < n; i++) {
1206 ir_mode *mode = get_irp_mode(i);
1207 if (strcmp(str, get_mode_name(mode)) == 0) {
1208 obstack_free(&env->obst, str);
1213 parse_error(env, "unknown mode \"%s\"\n", str);
1217 static const char *get_typetag_name(typetag_t typetag)
1220 case tt_align: return "align";
1221 case tt_allocation: return "allocation";
1222 case tt_builtin: return "builtin kind";
1223 case tt_cond_jmp_predicate: return "cond_jmp_predicate";
1224 case tt_initializer: return "initializer kind";
1225 case tt_iro: return "opcode";
1226 case tt_keyword: return "keyword";
1227 case tt_linkage: return "linkage";
1228 case tt_mode_arithmetic: return "mode_arithmetic";
1229 case tt_mode_sort: return "mode_sort";
1230 case tt_pin_state: return "pin state";
1231 case tt_segment: return "segment";
1232 case tt_tpo: return "type";
1233 case tt_type_state: return "type state";
1234 case tt_volatility: return "volatility";
1235 case tt_visibility: return "visibility";
1241 * Read and decode an enum constant.
1243 static unsigned read_enum(io_env_t *env, typetag_t typetag)
1245 char *str = read_word(env);
1246 unsigned code = symbol(str, typetag);
1248 if (code != SYMERROR) {
1249 obstack_free(&env->obst, str);
1253 parse_error(env, "invalid %s: \"%s\"\n", get_typetag_name(typetag), str);
1257 #define read_align(env) ((ir_align) read_enum(env, tt_align))
1258 #define read_allocation(env) ((ir_allocation) read_enum(env, tt_allocation))
1259 #define read_builtin_kind(env) ((ir_builtin_kind) read_enum(env, tt_builtin))
1260 #define read_cond_jmp_predicate(env) ((cond_jmp_predicate) read_enum(env, tt_cond_jmp_predicate))
1261 #define read_initializer_kind(env) ((ir_initializer_kind_t) read_enum(env, tt_initializer))
1262 #define read_mode_arithmetic(env) ((ir_mode_arithmetic) read_enum(env, tt_mode_arithmetic))
1263 #define read_peculiarity(env) ((ir_peculiarity) read_enum(env, tt_peculiarity))
1264 #define read_pin_state(env) ((op_pin_state) read_enum(env, tt_pin_state))
1265 #define read_type_state(env) ((ir_type_state) read_enum(env, tt_type_state))
1266 #define read_variability(env) ((ir_variability) read_enum(env, tt_variability))
1267 #define read_volatility(env) ((ir_volatility) read_enum(env, tt_volatility))
1269 static ir_cons_flags get_cons_flags(io_env_t *env)
1271 ir_cons_flags flags = cons_none;
1273 op_pin_state pinstate = read_pin_state(env);
1275 case op_pin_state_floats: flags |= cons_floats; break;
1276 case op_pin_state_pinned: break;
1278 panic("Error in %d: Invalid pinstate: %s", env->line,
1279 get_op_pin_state_name(pinstate));
1282 if (read_volatility(env) == volatility_is_volatile)
1283 flags |= cons_volatile;
1284 if (read_align(env) == align_non_aligned)
1285 flags |= cons_unaligned;
1290 static ir_tarval *read_tv(io_env_t *env)
1292 ir_mode *tvmode = read_mode(env);
1293 char *str = read_word(env);
1294 ir_tarval *tv = new_tarval_from_str(str, strlen(str), tvmode);
1295 obstack_free(&env->obst, str);
1300 static ir_initializer_t *read_initializer(io_env_t *env)
1302 ir_initializer_kind_t ini_kind = read_initializer_kind(env);
1305 case IR_INITIALIZER_CONST: {
1306 ir_node *irn = get_node_or_dummy(env, read_long(env));
1307 return create_initializer_const(irn);
1310 case IR_INITIALIZER_TARVAL:
1311 return create_initializer_tarval(read_tv(env));
1313 case IR_INITIALIZER_NULL:
1314 return get_initializer_null();
1316 case IR_INITIALIZER_COMPOUND: {
1317 unsigned i, n = (unsigned) read_long(env);
1318 ir_initializer_t *ini = create_initializer_compound(n);
1319 for (i = 0; i < n; i++) {
1320 ir_initializer_t *curini = read_initializer(env);
1321 set_initializer_compound_value(ini, i, curini);
1327 panic("Unknown initializer kind");
1332 /** Reads a type description and remembers it by its id. */
1333 static void import_type(io_env_t *env)
1337 long typenr = read_long(env);
1338 tp_opcode tpop = (tp_opcode) read_enum(env, tt_tpo);
1339 unsigned size = (unsigned) read_long(env);
1340 unsigned align = (unsigned) read_long(env);
1341 ir_type_state state = read_type_state(env);
1342 unsigned flags = (unsigned) read_long(env);
1346 int ndims = (int) read_long(env);
1347 long elemtypenr = read_long(env);
1348 ir_type *elemtype = get_type(env, elemtypenr);
1350 type = new_type_array(ndims, elemtype);
1351 for (i = 0; i < ndims; i++) {
1352 char *str = read_word(env);
1353 if (strcmp(str, "unknown") != 0) {
1354 long lowerbound = atol(str);
1355 set_array_lower_bound_int(type, i, lowerbound);
1357 obstack_free(&env->obst, str);
1359 str = read_word(env);
1360 if (strcmp(str, "unknown") != 0) {
1361 long upperbound = atol(str);
1362 set_array_upper_bound_int(type, i, upperbound);
1364 obstack_free(&env->obst, str);
1366 set_type_size_bytes(type, size);
1371 ident *id = read_ident_null(env);
1373 if (typenr == (long) IR_SEGMENT_GLOBAL)
1374 type = get_glob_type();
1376 type = new_type_class(id);
1377 set_type_size_bytes(type, size);
1382 unsigned callingconv = (unsigned) read_long(env);
1383 mtp_additional_properties addprops = (mtp_additional_properties) read_long(env);
1384 int nparams = (int) read_long(env);
1385 int nresults = (int) read_long(env);
1388 type = new_type_method(nparams, nresults);
1390 for (i = 0; i < nparams; i++) {
1391 long typenr = read_long(env);
1392 ir_type *paramtype = get_type(env, typenr);
1394 set_method_param_type(type, i, paramtype);
1396 for (i = 0; i < nresults; i++) {
1397 long typenr = read_long(env);
1398 ir_type *restype = get_type(env, typenr);
1400 set_method_res_type(type, i, restype);
1403 variaindex = (int) read_long(env);
1404 if (variaindex != -1) {
1405 set_method_variadicity(type, variadicity_variadic);
1406 if (variaindex != nparams)
1407 set_method_first_variadic_param_index(type, variaindex);
1410 set_method_calling_convention(type, callingconv);
1411 set_method_additional_properties(type, addprops);
1416 ir_mode *mode = read_mode(env);
1417 ir_type *pointsto = get_type(env, read_long(env));
1418 type = new_type_pointer(pointsto);
1419 set_type_mode(type, mode);
1423 case tpo_primitive: {
1424 ir_mode *mode = read_mode(env);
1425 type = new_type_primitive(mode);
1430 ident *id = read_ident_null(env);
1431 type = new_type_struct(id);
1432 set_type_size_bytes(type, size);
1437 ident *id = read_ident_null(env);
1438 type = new_type_union(id);
1439 set_type_size_bytes(type, size);
1444 return; /* ignore unknown type */
1447 parse_error(env, "unknown type kind: \"%d\"\n", tpop);
1452 set_type_alignment_bytes(type, align);
1453 type->flags = flags;
1455 if (state == layout_fixed)
1456 ARR_APP1(ir_type *, env->fixedtypes, type);
1458 set_id(env, typenr, type);
1461 /** Reads an entity description and remembers it by its id. */
1462 static void import_entity(io_env_t *env)
1464 long entnr = read_long(env);
1465 ident *name = read_ident(env);
1466 ident *ld_name = read_ident_null(env);
1467 ir_visibility visibility = ir_visibility_default;
1468 ir_linkage linkage = IR_LINKAGE_DEFAULT;
1477 while (!isdigit(env->c)) {
1478 char *str = read_word(env);
1483 v = symbol(str, tt_visibility);
1484 if (v != SYMERROR) {
1485 visibility = (ir_visibility)v;
1488 v = symbol(str, tt_linkage);
1489 if (v != SYMERROR) {
1490 linkage |= (ir_linkage)v;
1493 printf("Parser error, expected visibility or linkage, got '%s'\n",
1498 typenr = read_long(env);
1499 ownertypenr = read_long(env);
1501 type = get_type(env, typenr);
1502 ownertype = !ownertypenr ? get_glob_type() : get_type(env, ownertypenr);
1503 entity = new_entity(ownertype, name, type);
1505 if (ld_name != NULL)
1506 set_entity_ld_ident(entity, ld_name);
1507 set_entity_offset(entity, (int) read_long(env));
1508 set_entity_offset_bits_remainder(entity, (unsigned char) read_long(env));
1509 set_entity_compiler_generated(entity, (int) read_long(env));
1510 set_entity_volatility(entity, read_volatility(env));
1511 set_entity_visibility(entity, visibility);
1512 set_entity_linkage(entity, linkage);
1514 str = read_word(env);
1515 if (strcmp(str, "initializer") == 0) {
1516 set_entity_initializer(entity, read_initializer(env));
1517 } else if (strcmp(str, "compoundgraph") == 0) {
1518 int n = (int) read_long(env);
1520 for (i = 0; i < n; i++) {
1521 ir_entity *member = get_entity(env, read_long(env));
1522 ir_node *irn = get_node_or_dummy(env, read_long(env));
1523 add_compound_ent_value(entity, irn, member);
1525 } else if (strcmp(str, "none") == 0) {
1528 parse_error(env, "expected 'initializer', 'compoundgraph' or 'none' got '%s'\n", str);
1532 set_id(env, entnr, entity);
1535 /** Parses the whole type graph. */
1536 static int parse_typegraph(io_env_t *env)
1538 ir_graph *old_irg = env->irg;
1543 env->irg = get_const_code_irg();
1545 /* parse all types first */
1548 if (env->c == '}') {
1553 kwkind = (keyword_t) read_enum(env, tt_keyword);
1564 parse_error(env, "type graph element not supported yet: %d\n", kwkind);
1573 static int read_node_header(io_env_t *env, long *nodenr, ir_node ***preds,
1574 const char **nodename)
1578 *nodename = read_word(env);
1579 *nodenr = read_long(env);
1581 ARR_RESIZE(ir_node*, *preds, 0);
1583 expect_list_begin(env);
1584 for (numpreds = 0; list_has_next(env); numpreds++) {
1585 long val = read_long(env);
1586 ir_node *pred = get_node_or_dummy(env, val);
1587 ARR_APP1(ir_node*, *preds, pred);
1593 /** Parses an IRG. */
1594 static int parse_graph(io_env_t *env, ir_graph *irg)
1596 ir_node **preds = NEW_ARR_F(ir_node*,0);
1597 int i, numpreds, ret = 1;
1599 const char *nodename;
1600 ir_node *node, *newnode;
1608 if (env->c == '}') {
1613 numpreds = read_node_header(env, &nodenr, &preds, &nodename);
1615 node = get_node_or_null(env, nodenr);
1620 switch (symbol(nodename, tt_iro)) {
1622 ir_node *newendblock = preds[0];
1623 newnode = get_irg_end(irg);
1624 exchange(get_nodes_block(newnode), newendblock);
1625 for (i = 1; i < numpreds; i++)
1626 add_irn_n(newnode, preds[i]);
1631 ir_node *newstartblock = preds[0];
1632 newnode = get_irg_start(irg);
1633 exchange(get_nodes_block(newnode), newstartblock);
1638 newnode = new_r_Block(irg, numpreds, preds);
1642 newnode = irg->anchor;
1643 for (i = 1; i < numpreds; i++)
1644 set_irn_n(newnode, i-1, preds[i]);
1645 set_nodes_block(newnode, preds[0]);
1648 case iro_SymConst: {
1649 long entnr = read_long(env);
1650 union symconst_symbol sym;
1651 sym.entity_p = get_entity(env, entnr);
1652 newnode = new_r_SymConst(irg, mode_P, sym, symconst_addr_ent);
1657 ir_mode *mode = read_mode(env);
1658 long pn = read_long(env);
1659 newnode = new_r_Proj(preds[1], mode, pn);
1660 /* explicitely set block, since preds[1] might be a dummy node
1661 * which is always in the startblock */
1662 set_nodes_block(newnode, preds[0]);
1666 #include "gen_irio_import.inl"
1676 parse_error(env, "node type not supported yet: %s\n", nodename);
1681 exchange(node, newnode);
1682 /* Always update hash entry to avoid more uses of id nodes */
1683 set_id(env, nodenr, newnode);
1691 static int parse_modes(io_env_t *env)
1699 if (env->c == '}') {
1704 kwkind = (keyword_t) read_enum(env, tt_keyword);
1707 const char *name = read_string(env);
1708 ir_mode_sort sort = (ir_mode_sort)read_enum(env, tt_mode_sort);
1709 int size = read_long(env);
1710 int sign = read_long(env);
1711 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1712 unsigned modulo_shift = read_long(env);
1713 int vector_elems = read_long(env);
1716 if (vector_elems != 1) {
1717 panic("no support for import of vector modes yes");
1720 mode = new_ir_mode(name, sort, size, sign, arith, modulo_shift);
1721 if (mode_is_reference(mode)) {
1722 set_reference_mode_signed_eq(mode, read_mode(env));
1723 set_reference_mode_unsigned_eq(mode, read_mode(env));
1736 static int parse_program(io_env_t *env)
1744 if (env->c == '}') {
1749 kwkind = (keyword_t) read_enum(env, tt_keyword);
1751 case kw_segment_type: {
1752 ir_segment_t segment = (ir_segment_t) read_enum(env, tt_segment);
1753 ir_type *type = read_type(env);
1754 set_segment_type(segment, type);
1758 parse_error(env, "unexpected keyword %d\n", kwkind);
1765 void ir_import(const char *filename)
1767 FILE *file = fopen(filename, "rt");
1773 ir_import_file(file, filename);
1778 void ir_import_file(FILE *input, const char *inputname)
1780 int oldoptimize = get_optimize();
1781 firm_verification_t oldver = get_node_verification_mode();
1783 io_env_t *env = &ioenv;
1788 memset(env, 0, sizeof(*env));
1789 obstack_init(&env->obst);
1790 env->idset = new_set(id_cmp, 128);
1791 env->fixedtypes = NEW_ARR_F(ir_type *, 0);
1792 env->inputname = inputname;
1796 /* read first character */
1800 do_node_verification(FIRM_VERIFICATION_OFF);
1809 kw = (keyword_t)read_enum(env, tt_keyword);
1812 if (!parse_modes(env)) goto end;
1816 if (!parse_typegraph(env)) goto end;
1821 ir_entity *irgent = get_entity(env, read_long(env));
1823 ir_graph *irg = new_ir_graph(irgent, 0);
1824 set_irg_frame_type(irg, get_type(env, read_long(env)));
1825 valuetypeid = read_long(env);
1826 if (valuetypeid != -1)
1827 set_method_value_param_type(get_entity_type(irgent),
1828 get_type(env, valuetypeid));
1830 if (!parse_graph(env, irg)) goto end;
1835 ir_graph *constirg = get_const_code_irg();
1836 long bodyblockid = read_long(env);
1837 set_id(env, bodyblockid, constirg->current_block);
1838 if (!parse_graph(env, constirg)) goto end;
1847 parse_error(env, "Unexpected keyword %d at toplevel\n", kw);
1854 n = ARR_LEN(env->fixedtypes);
1855 for (i = 0; i < n; i++)
1856 set_type_state(env->fixedtypes[i], layout_fixed);
1858 DEL_ARR_F(env->fixedtypes);
1860 del_set(env->idset);
1862 irp_finalize_cons();
1864 do_node_verification(oldver);
1865 set_optimize(oldoptimize);
1867 obstack_free(&env->obst, NULL);