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_mode(io_env_t *env, ir_mode *mode)
323 fputs(get_mode_name(mode), env->file);
324 fputc(' ', env->file);
327 static void write_tarval(io_env_t *env, ir_tarval *tv)
330 write_mode(env, get_tarval_mode(tv));
331 tarval_snprintf(buf, sizeof(buf), tv);
332 fputs(buf, env->file);
333 fputc(' ', env->file);
336 static void write_align(io_env_t *env, ir_node *irn)
341 align = get_Load_align(irn);
342 else if (is_Store(irn))
343 align = get_Store_align(irn);
345 panic("Invalid optype for write_align");
347 fputs(get_align_name(align), env->file);
348 fputc(' ', env->file);
351 static void write_builtin_kind(io_env_t *env, ir_node *irn)
353 fputs(get_builtin_kind_name(get_Builtin_kind(irn)), env->file);
354 fputc(' ', env->file);
357 static void write_cond_jmp_predicate(io_env_t *env, ir_node *irn)
359 fputs(get_cond_jmp_predicate_name(get_Cond_jmp_pred(irn)), env->file);
360 fputc(' ', env->file);
363 static void write_initializer(io_env_t *env, ir_initializer_t *ini)
366 ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
368 fputs(get_initializer_kind_name(ini_kind), f);
372 case IR_INITIALIZER_CONST:
373 fprintf(f, "%ld ", get_irn_node_nr(get_initializer_const_value(ini)));
376 case IR_INITIALIZER_TARVAL:
377 write_tarval(env, get_initializer_tarval_value(ini));
380 case IR_INITIALIZER_NULL:
383 case IR_INITIALIZER_COMPOUND: {
384 unsigned i, n = get_initializer_compound_n_entries(ini);
385 fprintf(f, "%u ", n);
386 for (i = 0; i < n; i++)
387 write_initializer(env, get_initializer_compound_value(ini, i));
392 panic("Unknown initializer kind");
396 static void write_pin_state(io_env_t *env, ir_node *irn)
398 fputs(get_op_pin_state_name(get_irn_pinned(irn)), env->file);
399 fputc(' ', env->file);
402 static void write_volatility(io_env_t *env, ir_node *irn)
407 vol = get_Load_volatility(irn);
408 else if (is_Store(irn))
409 vol = get_Store_volatility(irn);
411 panic("Invalid optype for write_volatility");
413 fputs(get_volatility_name(vol), env->file);
414 fputc(' ', env->file);
417 static void export_type_common(io_env_t *env, ir_type *tp)
419 fprintf(env->file, "\ttype %ld %s %u %u %s %u ",
421 get_type_tpop_name(tp),
422 get_type_size_bytes(tp),
423 get_type_alignment_bytes(tp),
424 get_type_state_name(get_type_state(tp)),
428 static void export_compound_name(FILE *f, const ir_type *tp)
430 ident *name = get_compound_ident(tp);
434 fprintf(f, "\"%s\" ", get_id_str(name));
438 static void export_type_pre(io_env_t *env, ir_type *tp)
442 /* skip types to be handled by post walker */
443 switch (get_type_tpop_code(tp)) {
452 export_type_common(env, tp);
454 switch (get_type_tpop_code(tp)) {
455 case tpo_uninitialized:
456 panic("invalid type found");
459 export_compound_name(f, tp);
463 write_mode(env, get_type_mode(tp));
468 case tpo_enumeration:
469 export_compound_name(f, tp);
483 static void export_type_post(io_env_t *env, ir_type *tp)
488 /* skip types already handled by pre walker */
489 switch (get_type_tpop_code(tp)) {
495 case tpo_uninitialized:
502 case tpo_enumeration:
506 export_type_common(env, tp);
508 switch (get_type_tpop_code(tp)) {
510 int n = get_array_n_dimensions(tp);
511 fprintf(f, "%d %ld ", n, get_type_nr(get_array_element_type(tp)));
512 for (i = 0; i < n; i++) {
513 ir_node *lower = get_array_lower_bound(tp, i);
514 ir_node *upper = get_array_upper_bound(tp, i);
517 fprintf(f, "%ld ", get_tarval_long(get_Const_tarval(lower)));
519 panic("Lower array bound is not constant");
522 fprintf(f, "%ld ", get_tarval_long(get_Const_tarval(upper)));
523 else if (is_Unknown(upper))
524 fputs("unknown ", f);
526 panic("Upper array bound is not constant");
532 int nparams = get_method_n_params(tp);
533 int nresults = get_method_n_ress(tp);
534 fprintf(f, "%u %u %d %d ", get_method_calling_convention(tp),
535 get_method_additional_properties(tp), nparams, nresults);
536 for (i = 0; i < nparams; i++)
537 fprintf(f, "%ld ", get_type_nr(get_method_param_type(tp, i)));
538 for (i = 0; i < nresults; i++)
539 fprintf(f, "%ld ", get_type_nr(get_method_res_type(tp, i)));
540 fprintf(f, "%d ", get_method_first_variadic_param_index(tp));
545 write_mode(env, get_type_mode(tp));
546 fprintf(f, "%ld ", get_type_nr(get_pointer_points_to_type(tp)));
549 case tpo_enumeration:
550 fprintf(stderr, "Enumeration type not handled yet by exporter\n");
554 printf("export_type: Unknown type code \"%s\".\n",
555 get_type_tpop_name(tp));
561 static void export_entity(io_env_t *env, ir_entity *ent)
563 FILE *file = env->file;
564 ir_type *owner = get_entity_owner(ent);
565 ir_visibility visibility = get_entity_visibility(ent);
566 ir_linkage linkage = get_entity_linkage(ent);
568 /* we don't dump array_element_ent entities. They're a strange concept
569 * and lead to cycles in type_graph.
571 if (is_Array_type(owner))
574 fprintf(env->file, "\tentity %ld \"%s\" ",
575 get_entity_nr(ent), get_entity_name(ent));
576 if (ent->ld_name != NULL) {
577 fprintf(env->file, "\"%s\" ", get_entity_ld_name(ent));
579 fprintf(env->file, "NULL ");
582 /* visibility + linkage */
583 if (visibility != ir_visibility_default) {
584 fprintf(file, "%s ", get_visibility_name(visibility));
586 if (linkage & IR_LINKAGE_CONSTANT)
587 fputs("constant ", file);
588 if (linkage & IR_LINKAGE_WEAK)
589 fputs("weak ", file);
590 if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
591 fputs("garbage_collect ", file);
592 if (linkage & IR_LINKAGE_MERGE)
593 fputs("merge ", file);
594 if (linkage & IR_LINKAGE_HIDDEN_USER)
595 fputs("hidden_user ", file);
597 fprintf(file, "%ld %ld %d %u %d %s ",
598 get_type_nr(get_entity_type(ent)),
600 get_entity_offset(ent),
601 (unsigned) get_entity_offset_bits_remainder(ent),
602 is_entity_compiler_generated(ent),
603 get_volatility_name(get_entity_volatility(ent)));
605 if (ent->initializer != NULL) {
606 fputs("initializer ", env->file);
607 write_initializer(env, get_entity_initializer(ent));
608 } else if (entity_has_compound_ent_values(ent)) {
609 int i, n = get_compound_ent_n_values(ent);
610 fputs("compoundgraph ", env->file);
611 fprintf(env->file, "%d ", n);
612 for (i = 0; i < n; i++) {
613 ir_entity *member = get_compound_ent_value_member(ent, i);
614 ir_node *irn = get_compound_ent_value(ent, i);
615 fprintf(env->file, "%ld %ld ", get_entity_nr(member), get_irn_node_nr(irn));
618 fputs("none", env->file);
621 fputc('\n', env->file);
624 static void export_type_or_ent_pre(type_or_ent tore, void *ctx)
626 io_env_t *env = (io_env_t *) ctx;
627 if (get_kind(tore.typ) == k_type)
628 export_type_pre(env, tore.typ);
631 static void export_type_or_ent_post(type_or_ent tore, void *ctx)
633 io_env_t *env = (io_env_t *) ctx;
635 switch (get_kind(tore.ent)) {
637 export_entity(env, tore.ent);
641 export_type_post(env, tore.typ);
645 panic("export_type_or_ent_post: Unknown type or entity.");
651 * Walker: exports every node.
653 static void export_node(ir_node *irn, void *ctx)
655 io_env_t *env = (io_env_t *) ctx;
657 unsigned opcode = get_irn_opcode(irn);
659 if (env->ignoreblocks && opcode == iro_Block)
662 fprintf(env->file, "\t%s %ld [ ", get_irn_opname(irn), get_irn_node_nr(irn));
664 n = get_irn_arity(irn);
665 if (!is_Block(irn)) {
666 fprintf(env->file, "%ld ", get_irn_node_nr(get_nodes_block(irn)));
669 for (i = 0; i < n; i++) {
670 ir_node *pred = get_irn_n(irn, i);
672 /* Anchor node may have NULL predecessors */
673 assert(is_Anchor(irn));
674 fputs("-1 ", env->file);
676 fprintf(env->file, "%ld ", get_irn_node_nr(pred));
680 fprintf(env->file, "] { ");
689 /* TODO: only symconst_addr_ent implemented yet */
690 assert(get_SymConst_kind(irn) == symconst_addr_ent);
691 fprintf(env->file, "%ld ", get_entity_nr(get_SymConst_entity(irn)));
694 write_mode(env, get_irn_mode(irn));
695 fprintf(env->file, "%ld ", get_Proj_proj(irn));
697 #include "gen_irio_export.inl"
699 panic("no export code for node %+F\n", irn);
701 fputs("}\n", env->file);
704 static const char *get_mode_sort_name(ir_mode_sort sort)
707 case irms_auxiliary: return "auxiliary";
708 case irms_control_flow: return "control_flow";
709 case irms_memory: return "memory";
710 case irms_internal_boolean: return "internal_boolean";
711 case irms_reference: return "reference";
712 case irms_int_number: return "int_number";
713 case irms_float_number: return "float_number";
715 panic("invalid mode sort found");
718 static void export_modes(io_env_t *env)
720 int i, n_modes = get_irp_n_modes();
722 fputs("modes {\n", env->file);
724 for (i = 0; i < n_modes; i++) {
725 ir_mode *mode = get_irp_mode(i);
726 switch (get_mode_sort(mode)) {
728 case irms_control_flow:
730 case irms_internal_boolean:
731 /* skip "internal" modes, which may not be user defined */
737 fprintf(env->file, "\tmode \"%s\" %s %u %d %s %u %u ",
738 get_mode_name(mode), get_mode_sort_name(get_mode_sort(mode)),
739 get_mode_size_bits(mode), get_mode_sign(mode),
740 get_mode_arithmetic_name(get_mode_arithmetic(mode)),
741 get_mode_modulo_shift(mode),
742 get_mode_n_vector_elems(mode));
743 if (mode_is_reference(mode)) {
744 write_mode(env, get_reference_mode_signed_eq(mode));
745 write_mode(env, get_reference_mode_unsigned_eq(mode));
747 fputc('\n', env->file);
750 fputs("}\n", env->file);
753 static void export_program(io_env_t *env)
758 fputs("\nprogram {\n", f);
759 if (irp_prog_name_is_set()) {
760 fprintf(f, "\tname \"%s\"\n", get_irp_name());
762 /* We need numbers for irgs... */
764 if (get_irp_main_irg() != NULL) {
765 fprintf(f, "\tmain_irg %d\n", get_irp_main_irg
768 for (s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
769 ir_type *segment_type = get_segment_type(s);
770 fprintf(f, "\tsegment_type %s", get_segment_name(s));
771 if (segment_type == NULL) {
774 fprintf(f, " %ld\n", get_type_nr(segment_type));
780 void ir_export(const char *filename)
782 FILE *file = fopen(filename, "wt");
788 ir_export_file(file, filename);
792 /* Exports the whole irp to the given file in a textual form. */
793 void ir_export_file(FILE *file, const char *outputname)
796 int i, n_irgs = get_irp_n_irgs();
803 fputs("\ntypegraph {\n", env.file);
804 type_walk_prog(export_type_or_ent_pre, export_type_or_ent_post, &env);
805 fputs("}\n", env.file);
807 for (i = 0; i < n_irgs; i++) {
808 ir_graph *irg = get_irp_irg(i);
809 ir_type *valuetype = get_irg_value_param_type(irg);
811 fprintf(env.file, "\nirg %ld %ld %ld {\n",
812 get_entity_nr(get_irg_entity(irg)),
813 get_type_nr(get_irg_frame_type(irg)),
814 valuetype == NULL ? -1 : get_type_nr(valuetype));
816 env.ignoreblocks = 0;
817 irg_block_walk_graph(irg, NULL, export_node, &env);
819 env.ignoreblocks = 1;
820 irg_walk_anchors(irg, NULL, export_node, &env);
822 fputs("}\n", env.file);
825 fprintf(env.file, "\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
827 walk_const_code(NULL, export_node, &env);
828 fputs("}\n", env.file);
830 export_program(&env);
833 /* Exports the given irg to the given file. */
834 void ir_export_irg(ir_graph *irg, FILE *file, const char *outputname)
843 fputs("typegraph {\n", env.file);
845 type_walk_irg(irg, export_type_or_ent_pre, export_type_or_ent_post, &env);
847 fprintf(env.file, "}\n\nirg %ld {\n", get_entity_nr(get_irg_entity(irg)));
849 env.ignoreblocks = 0;
850 irg_block_walk_graph(irg, NULL, export_node, &env);
852 env.ignoreblocks = 1;
853 irg_walk_anchors(irg, NULL, export_node, &env);
855 /* TODO: Only output needed constants */
856 fprintf(env.file, "}\n\nconstirg %ld {\n", get_irn_node_nr(get_const_code_irg()->current_block));
857 walk_const_code(NULL, export_node, &env);
858 fputs("}\n", env.file);
861 static void read_c(io_env_t *env)
863 int c = fgetc(env->file);
869 /** Returns the first non-whitespace character or EOF. **/
870 static void skip_ws(io_env_t *env)
887 static void skip_to(io_env_t *env, char to_ch)
889 while (env->c != to_ch && env->c != EOF) {
894 static int expect_char(io_env_t *env, char ch)
898 parse_error(env, "Unexpected char '%c', expected '%c'\n",
906 #define EXPECT(c) if (expect_char(env, (c))) {} else return 0
908 static char *read_word(io_env_t *env)
912 assert(obstack_object_size(&env->obst) == 0);
924 obstack_1grow(&env->obst, c);
931 obstack_1grow(&env->obst, '\0');
932 return (char*)obstack_finish(&env->obst);
935 static char *read_quoted_string(io_env_t *env)
938 if (env->c != '\"') {
939 parse_error(env, "Expected '\"', found '%c'\n", env->c);
944 assert(obstack_object_size(&env->obst) == 0);
948 parse_error(env, "Unexpected end of quoted string!\n");
955 obstack_1grow(&env->obst, ch);
958 obstack_1grow(&env->obst, '\0');
960 return (char*)obstack_finish(&env->obst);
963 static ident *read_ident(io_env_t *env)
965 char *str = read_quoted_string(env);
966 ident *res = new_id_from_str(str);
967 obstack_free(&env->obst, str);
973 * reads a "quoted string" or alternatively the token NULL
975 static char *read_quoted_string_null(io_env_t *env)
979 char *str = read_word(env);
980 if (strcmp(str, "NULL") == 0) {
981 obstack_free(&env->obst, str);
984 } else if (env->c == '"') {
985 return read_quoted_string(env);
988 parse_error(env, "Expected \"string\" or NULL\n");
992 static ident *read_ident_null(io_env_t *env)
995 char *str = read_quoted_string_null(env);
999 res = new_id_from_str(str);
1000 obstack_free(&env->obst, str);
1004 static long read_long(io_env_t *env)
1010 if (!isdigit(env->c) && env->c != '-') {
1011 parse_error(env, "Expected number, got '%c'\n", env->c);
1015 assert(obstack_object_size(&env->obst) == 0);
1017 obstack_1grow(&env->obst, env->c);
1019 } while (isdigit(env->c));
1020 obstack_1grow(&env->obst, 0);
1022 str = (char*)obstack_finish(&env->obst);
1024 obstack_free(&env->obst, str);
1029 static ir_node *get_node_or_null(io_env_t *env, long nodenr)
1031 ir_node *node = (ir_node *) get_id(env, nodenr);
1032 if (node && node->kind != k_ir_node) {
1033 panic("Irn ID %ld collides with something else in line %d\n",
1039 static ir_node *get_node_or_dummy(io_env_t *env, long nodenr)
1041 ir_node *node = get_node_or_null(env, nodenr);
1043 node = new_r_Dummy(env->irg, mode_X);
1044 set_id(env, nodenr, node);
1049 static ir_type *get_type(io_env_t *env, long typenr)
1051 ir_type *type = (ir_type *) get_id(env, typenr);
1053 panic("unknown type: %ld in line %d\n", typenr, env->line);
1054 else if (type->kind != k_type)
1055 panic("type ID %ld collides with something else in line %d\n",
1060 static ir_type *read_type(io_env_t *env)
1062 return get_type(env, read_long(env));
1065 static ir_entity *get_entity(io_env_t *env, long entnr)
1067 ir_entity *entity = (ir_entity *) get_id(env, entnr);
1068 if (entity == NULL) {
1069 parse_error(env, "unknown entity: %ld\n", entnr);
1071 } else if (entity->kind != k_entity) {
1072 panic("Entity ID %ld collides with something else in line %d\n",
1079 static ir_entity *read_entity(io_env_t *env)
1081 return get_entity(env, read_long(env));
1084 static ir_mode *read_mode(io_env_t *env)
1086 char *str = read_word(env);
1089 n = get_irp_n_modes();
1090 for (i = 0; i < n; i++) {
1091 ir_mode *mode = get_irp_mode(i);
1092 if (strcmp(str, get_mode_name(mode)) == 0) {
1093 obstack_free(&env->obst, str);
1098 parse_error(env, "unknown mode \"%s\"\n", str);
1102 static const char *get_typetag_name(typetag_t typetag)
1105 case tt_align: return "align";
1106 case tt_allocation: return "allocation";
1107 case tt_builtin: return "builtin kind";
1108 case tt_cond_jmp_predicate: return "cond_jmp_predicate";
1109 case tt_initializer: return "initializer kind";
1110 case tt_iro: return "opcode";
1111 case tt_keyword: return "keyword";
1112 case tt_linkage: return "linkage";
1113 case tt_mode_arithmetic: return "mode_arithmetic";
1114 case tt_mode_sort: return "mode_sort";
1115 case tt_pin_state: return "pin state";
1116 case tt_segment: return "segment";
1117 case tt_tpo: return "type";
1118 case tt_type_state: return "type state";
1119 case tt_volatility: return "volatility";
1120 case tt_visibility: return "visibility";
1126 * Read and decode an enum constant.
1128 static unsigned read_enum(io_env_t *env, typetag_t typetag)
1130 char *str = read_word(env);
1131 unsigned code = symbol(str, typetag);
1133 if (code != SYMERROR) {
1134 obstack_free(&env->obst, str);
1138 parse_error(env, "invalid %s: \"%s\"\n", get_typetag_name(typetag), str);
1142 #define read_align(env) ((ir_align) read_enum(env, tt_align))
1143 #define read_allocation(env) ((ir_allocation) read_enum(env, tt_allocation))
1144 #define read_builtin_kind(env) ((ir_builtin_kind) read_enum(env, tt_builtin))
1145 #define read_cond_jmp_predicate(env) ((cond_jmp_predicate) read_enum(env, tt_cond_jmp_predicate))
1146 #define read_initializer_kind(env) ((ir_initializer_kind_t) read_enum(env, tt_initializer))
1147 #define read_mode_arithmetic(env) ((ir_mode_arithmetic) read_enum(env, tt_mode_arithmetic))
1148 #define read_peculiarity(env) ((ir_peculiarity) read_enum(env, tt_peculiarity))
1149 #define read_pin_state(env) ((op_pin_state) read_enum(env, tt_pin_state))
1150 #define read_type_state(env) ((ir_type_state) read_enum(env, tt_type_state))
1151 #define read_variability(env) ((ir_variability) read_enum(env, tt_variability))
1152 #define read_volatility(env) ((ir_volatility) read_enum(env, tt_volatility))
1154 static ir_cons_flags get_cons_flags(io_env_t *env)
1156 ir_cons_flags flags = cons_none;
1158 op_pin_state pinstate = read_pin_state(env);
1160 case op_pin_state_floats: flags |= cons_floats; break;
1161 case op_pin_state_pinned: break;
1163 panic("Error in %d: Invalid pinstate: %s", env->line,
1164 get_op_pin_state_name(pinstate));
1167 if (read_volatility(env) == volatility_is_volatile)
1168 flags |= cons_volatile;
1169 if (read_align(env) == align_non_aligned)
1170 flags |= cons_unaligned;
1175 static ir_tarval *read_tv(io_env_t *env)
1177 ir_mode *tvmode = read_mode(env);
1178 char *str = read_word(env);
1179 ir_tarval *tv = new_tarval_from_str(str, strlen(str), tvmode);
1180 obstack_free(&env->obst, str);
1185 static ir_initializer_t *read_initializer(io_env_t *env)
1187 ir_initializer_kind_t ini_kind = read_initializer_kind(env);
1190 case IR_INITIALIZER_CONST: {
1191 ir_node *irn = get_node_or_dummy(env, read_long(env));
1192 return create_initializer_const(irn);
1195 case IR_INITIALIZER_TARVAL:
1196 return create_initializer_tarval(read_tv(env));
1198 case IR_INITIALIZER_NULL:
1199 return get_initializer_null();
1201 case IR_INITIALIZER_COMPOUND: {
1202 unsigned i, n = (unsigned) read_long(env);
1203 ir_initializer_t *ini = create_initializer_compound(n);
1204 for (i = 0; i < n; i++) {
1205 ir_initializer_t *curini = read_initializer(env);
1206 set_initializer_compound_value(ini, i, curini);
1212 panic("Unknown initializer kind");
1217 /** Reads a type description and remembers it by its id. */
1218 static void import_type(io_env_t *env)
1222 long typenr = read_long(env);
1223 tp_opcode tpop = (tp_opcode) read_enum(env, tt_tpo);
1224 unsigned size = (unsigned) read_long(env);
1225 unsigned align = (unsigned) read_long(env);
1226 ir_type_state state = read_type_state(env);
1227 unsigned flags = (unsigned) read_long(env);
1231 int ndims = (int) read_long(env);
1232 long elemtypenr = read_long(env);
1233 ir_type *elemtype = get_type(env, elemtypenr);
1235 type = new_type_array(ndims, elemtype);
1236 for (i = 0; i < ndims; i++) {
1237 char *str = read_word(env);
1238 if (strcmp(str, "unknown") != 0) {
1239 long lowerbound = atol(str);
1240 set_array_lower_bound_int(type, i, lowerbound);
1242 obstack_free(&env->obst, str);
1244 str = read_word(env);
1245 if (strcmp(str, "unknown") != 0) {
1246 long upperbound = atol(str);
1247 set_array_upper_bound_int(type, i, upperbound);
1249 obstack_free(&env->obst, str);
1251 set_type_size_bytes(type, size);
1256 const char *name = read_quoted_string_null(env);
1257 ident *id = name != NULL ? new_id_from_str(name) : NULL;
1259 if (typenr == (long) IR_SEGMENT_GLOBAL)
1260 type = get_glob_type();
1262 type = new_type_class(id);
1263 set_type_size_bytes(type, size);
1268 unsigned callingconv = (unsigned) read_long(env);
1269 mtp_additional_properties addprops = (mtp_additional_properties) read_long(env);
1270 int nparams = (int) read_long(env);
1271 int nresults = (int) read_long(env);
1274 type = new_type_method(nparams, nresults);
1276 for (i = 0; i < nparams; i++) {
1277 long typenr = read_long(env);
1278 ir_type *paramtype = get_type(env, typenr);
1280 set_method_param_type(type, i, paramtype);
1282 for (i = 0; i < nresults; i++) {
1283 long typenr = read_long(env);
1284 ir_type *restype = get_type(env, typenr);
1286 set_method_res_type(type, i, restype);
1289 variaindex = (int) read_long(env);
1290 if (variaindex != -1) {
1291 set_method_variadicity(type, variadicity_variadic);
1292 if (variaindex != nparams)
1293 set_method_first_variadic_param_index(type, variaindex);
1296 set_method_calling_convention(type, callingconv);
1297 set_method_additional_properties(type, addprops);
1302 ir_mode *mode = read_mode(env);
1303 ir_type *pointsto = get_type(env, read_long(env));
1304 type = new_type_pointer(pointsto);
1305 set_type_mode(type, mode);
1309 case tpo_primitive: {
1310 ir_mode *mode = read_mode(env);
1311 type = new_type_primitive(mode);
1316 const char *name = read_quoted_string_null(env);
1317 ident *id = name != NULL ? new_id_from_str(name) : NULL;
1318 type = new_type_struct(id);
1319 set_type_size_bytes(type, size);
1324 const char *name = read_quoted_string_null(env);
1325 ident *id = name != NULL ? new_id_from_str(name) : NULL;
1327 type = new_type_union(id);
1328 set_type_size_bytes(type, size);
1333 return; /* ignore unknown type */
1336 parse_error(env, "unknown type kind: \"%d\"\n", tpop);
1341 set_type_alignment_bytes(type, align);
1342 type->flags = flags;
1344 if (state == layout_fixed)
1345 ARR_APP1(ir_type *, env->fixedtypes, type);
1347 set_id(env, typenr, type);
1350 /** Reads an entity description and remembers it by its id. */
1351 static void import_entity(io_env_t *env)
1353 long entnr = read_long(env);
1354 ident *name = read_ident(env);
1355 ident *ld_name = read_ident_null(env);
1356 ir_visibility visibility = ir_visibility_default;
1357 ir_linkage linkage = IR_LINKAGE_DEFAULT;
1366 while (!isdigit(env->c)) {
1367 char *str = read_word(env);
1372 v = symbol(str, tt_visibility);
1373 if (v != SYMERROR) {
1374 visibility = (ir_visibility)v;
1377 v = symbol(str, tt_linkage);
1378 if (v != SYMERROR) {
1379 linkage |= (ir_linkage)v;
1382 printf("Parser error, expected visibility or linkage, got '%s'\n",
1387 typenr = read_long(env);
1388 ownertypenr = read_long(env);
1390 type = get_type(env, typenr);
1391 ownertype = !ownertypenr ? get_glob_type() : get_type(env, ownertypenr);
1392 entity = new_entity(ownertype, name, type);
1394 if (ld_name != NULL)
1395 set_entity_ld_ident(entity, ld_name);
1396 set_entity_offset(entity, (int) read_long(env));
1397 set_entity_offset_bits_remainder(entity, (unsigned char) read_long(env));
1398 set_entity_compiler_generated(entity, (int) read_long(env));
1399 set_entity_volatility(entity, read_volatility(env));
1400 set_entity_visibility(entity, visibility);
1401 set_entity_linkage(entity, linkage);
1403 str = read_word(env);
1404 if (strcmp(str, "initializer") == 0) {
1405 set_entity_initializer(entity, read_initializer(env));
1406 } else if (strcmp(str, "compoundgraph") == 0) {
1407 int n = (int) read_long(env);
1409 for (i = 0; i < n; i++) {
1410 ir_entity *member = get_entity(env, read_long(env));
1411 ir_node *irn = get_node_or_dummy(env, read_long(env));
1412 add_compound_ent_value(entity, irn, member);
1414 } else if (strcmp(str, "none") == 0) {
1417 parse_error(env, "expected 'initializer', 'compoundgraph' or 'none' got '%s'\n", str);
1421 set_id(env, entnr, entity);
1424 /** Parses the whole type graph. */
1425 static int parse_typegraph(io_env_t *env)
1427 ir_graph *old_irg = env->irg;
1432 env->irg = get_const_code_irg();
1434 /* parse all types first */
1437 if (env->c == '}') {
1442 kwkind = (keyword_t) read_enum(env, tt_keyword);
1453 parse_error(env, "type graph element not supported yet: %d\n", kwkind);
1462 static int read_node_header(io_env_t *env, long *nodenr, ir_node ***preds,
1463 const char **nodename)
1467 *nodename = read_word(env);
1468 *nodenr = read_long(env);
1470 ARR_RESIZE(ir_node*, *preds, 0);
1473 for (numpreds = 0; !feof(env->file); numpreds++) {
1478 if (env->c == ']') {
1482 val = read_long(env);
1483 pred = get_node_or_dummy(env, val);
1484 ARR_APP1(ir_node*, *preds, pred);
1490 /** Parses an IRG. */
1491 static int parse_graph(io_env_t *env, ir_graph *irg)
1493 ir_node **preds = NEW_ARR_F(ir_node*,0);
1494 int i, numpreds, ret = 1;
1496 const char *nodename;
1497 ir_node *node, *newnode;
1505 if (env->c == '}') {
1510 numpreds = read_node_header(env, &nodenr, &preds, &nodename);
1512 node = get_node_or_null(env, nodenr);
1517 switch (symbol(nodename, tt_iro)) {
1519 ir_node *newendblock = preds[0];
1520 newnode = get_irg_end(irg);
1521 exchange(get_nodes_block(newnode), newendblock);
1522 for (i = 1; i < numpreds; i++)
1523 add_irn_n(newnode, preds[i]);
1528 ir_node *newstartblock = preds[0];
1529 newnode = get_irg_start(irg);
1530 exchange(get_nodes_block(newnode), newstartblock);
1535 newnode = new_r_Block(irg, numpreds, preds);
1539 newnode = irg->anchor;
1540 for (i = 1; i < numpreds; i++)
1541 set_irn_n(newnode, i-1, preds[i]);
1542 set_nodes_block(newnode, preds[0]);
1545 case iro_SymConst: {
1546 long entnr = read_long(env);
1547 union symconst_symbol sym;
1548 sym.entity_p = get_entity(env, entnr);
1549 newnode = new_r_SymConst(irg, mode_P, sym, symconst_addr_ent);
1554 ir_mode *mode = read_mode(env);
1555 long pn = read_long(env);
1556 newnode = new_r_Proj(preds[1], mode, pn);
1557 /* explicitely set block, since preds[1] might be a dummy node
1558 * which is always in the startblock */
1559 set_nodes_block(newnode, preds[0]);
1563 #include "gen_irio_import.inl"
1573 parse_error(env, "node type not supported yet: %s\n", nodename);
1578 exchange(node, newnode);
1579 /* Always update hash entry to avoid more uses of id nodes */
1580 set_id(env, nodenr, newnode);
1588 static int parse_modes(io_env_t *env)
1596 if (env->c == '}') {
1601 kwkind = (keyword_t) read_enum(env, tt_keyword);
1604 const char *name = read_quoted_string(env);
1605 ir_mode_sort sort = (ir_mode_sort)read_enum(env, tt_mode_sort);
1606 int size = read_long(env);
1607 int sign = read_long(env);
1608 ir_mode_arithmetic arith = read_mode_arithmetic(env);
1609 unsigned modulo_shift = read_long(env);
1610 int vector_elems = read_long(env);
1613 if (vector_elems != 1) {
1614 panic("no support for import of vector modes yes");
1617 mode = new_ir_mode(name, sort, size, sign, arith, modulo_shift);
1618 if (mode_is_reference(mode)) {
1619 set_reference_mode_signed_eq(mode, read_mode(env));
1620 set_reference_mode_unsigned_eq(mode, read_mode(env));
1633 static int parse_program(io_env_t *env)
1641 if (env->c == '}') {
1646 kwkind = (keyword_t) read_enum(env, tt_keyword);
1648 case kw_segment_type: {
1649 ir_segment_t segment = (ir_segment_t) read_enum(env, tt_segment);
1650 ir_type *type = read_type(env);
1651 set_segment_type(segment, type);
1655 parse_error(env, "unexpected keyword %d\n", kwkind);
1662 void ir_import(const char *filename)
1664 FILE *file = fopen(filename, "rt");
1670 ir_import_file(file, filename);
1675 void ir_import_file(FILE *input, const char *inputname)
1677 int oldoptimize = get_optimize();
1678 firm_verification_t oldver = get_node_verification_mode();
1680 io_env_t *env = &ioenv;
1685 memset(env, 0, sizeof(*env));
1686 obstack_init(&env->obst);
1687 env->idset = new_set(id_cmp, 128);
1688 env->fixedtypes = NEW_ARR_F(ir_type *, 0);
1689 env->inputname = inputname;
1693 /* read first character */
1697 do_node_verification(FIRM_VERIFICATION_OFF);
1706 kw = (keyword_t)read_enum(env, tt_keyword);
1709 if (!parse_modes(env)) goto end;
1713 if (!parse_typegraph(env)) goto end;
1718 ir_entity *irgent = get_entity(env, read_long(env));
1720 ir_graph *irg = new_ir_graph(irgent, 0);
1721 set_irg_frame_type(irg, get_type(env, read_long(env)));
1722 valuetypeid = read_long(env);
1723 if (valuetypeid != -1)
1724 set_method_value_param_type(get_entity_type(irgent),
1725 get_type(env, valuetypeid));
1727 if (!parse_graph(env, irg)) goto end;
1732 ir_graph *constirg = get_const_code_irg();
1733 long bodyblockid = read_long(env);
1734 set_id(env, bodyblockid, constirg->current_block);
1735 if (!parse_graph(env, constirg)) goto end;
1744 parse_error(env, "Unexpected keyword %d at toplevel\n", kw);
1751 n = ARR_LEN(env->fixedtypes);
1752 for (i = 0; i < n; i++)
1753 set_type_state(env->fixedtypes[i], layout_fixed);
1755 DEL_ARR_F(env->fixedtypes);
1757 del_set(env->idset);
1759 irp_finalize_cons();
1761 do_node_verification(oldver);
1762 set_optimize(oldoptimize);
1764 obstack_free(&env->obst, NULL);