irio.c 57.7 KB
Newer Older
1
2
/*
 * This file is part of libFirm.
3
 * Copyright (C) 2012 University of Karlsruhe.
4
5
6
7
8
 */

/**
 * @file
 * @brief   Write textual representation of firm to file.
Matthias Braun's avatar
Matthias Braun committed
9
 * @author  Moritz Kroll, Matthias Braun
10
11
 */
#include <string.h>
12
13
14
#include <ctype.h>
#include <stdbool.h>
#include <stdarg.h>
15
16
17

#include "irio.h"

18
#include "irnode_t.h"
19
#include "irprog_t.h"
20
#include "irgraph_t.h"
Michael Beck's avatar
Michael Beck committed
21
#include "irprintf.h"
Matthias Braun's avatar
Matthias Braun committed
22
#include "ircons_t.h"
23
24
25
#include "irgmod.h"
#include "irflag_t.h"
#include "irgwalk.h"
26
#include "tv_t.h"
27
#include "array.h"
Matthias Braun's avatar
Matthias Braun committed
28
#include "panic.h"
29
#include "typerep.h"
Matthias Braun's avatar
Matthias Braun committed
30
31
32
33
#include "set.h"
#include "obst.h"
#include "pmap.h"
#include "pdeq.h"
Christoph Mallon's avatar
Christoph Mallon committed
34
#include "util.h"
35

36
#define SYMERROR ((unsigned) ~0)
37

Matthias Braun's avatar
Matthias Braun committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
static void register_generated_node_readers(void);
static void register_generated_node_writers(void);

typedef struct delayed_initializer_t {
	ir_initializer_t *initializer;
	long              node_nr;
} delayed_initializer_t;

typedef struct delayed_pred_t {
	ir_node *node;
	int      n_preds;
	long     preds[];
} delayed_pred_t;

typedef struct read_env_t {
	int            c;           /**< currently read char */
	FILE          *file;
	const char    *inputname;
	unsigned       line;

	ir_graph      *irg;
	set           *idset;       /**< id_entry set, which maps from file ids to
	                                 new Firm elements */
	ir_type      **fixedtypes;
	bool           read_errors;
63
	struct obstack obst;
Matthias Braun's avatar
Matthias Braun committed
64
65
66
67
	struct obstack preds_obst;
	delayed_initializer_t *delayed_initializers;
	const delayed_pred_t **delayed_preds;
} read_env_t;
68

Matthias Braun's avatar
Matthias Braun committed
69
70
71
typedef struct write_env_t {
	FILE *file;
	pdeq *write_queue;
72
	pdeq *entity_queue;
Matthias Braun's avatar
Matthias Braun committed
73
74
75
} write_env_t;

typedef enum typetag_t {
76
	tt_align,
Matthias Braun's avatar
Matthias Braun committed
77
	tt_builtin_kind,
78
	tt_cond_jmp_predicate,
79
	tt_initializer,
80
	tt_keyword,
Matthias Braun's avatar
Matthias Braun committed
81
	tt_linkage,
82
	tt_loop,
83
	tt_mode_arithmetic,
84
	tt_pin_state,
Matthias Braun's avatar
Matthias Braun committed
85
86
	tt_segment,
	tt_throws,
87
	tt_tpo,
88
	tt_type_state,
Matthias Braun's avatar
Matthias Braun committed
89
	tt_visibility,
90
	tt_volatility,
91
92
} typetag_t;

Matthias Braun's avatar
Matthias Braun committed
93
94
95
typedef enum keyword_t {
	kw_asm,
	kw_compound_member,
96
97
	kw_constirg,
	kw_entity,
98
	kw_float_mode,
Matthias Braun's avatar
Matthias Braun committed
99
100
	kw_int_mode,
	kw_irg,
101
	kw_alias,
Matthias Braun's avatar
Matthias Braun committed
102
	kw_gotentry,
Matthias Braun's avatar
Matthias Braun committed
103
104
	kw_label,
	kw_method,
105
	kw_modes,
Matthias Braun's avatar
Matthias Braun committed
106
107
108
109
	kw_parameter,
	kw_program,
	kw_reference_mode,
	kw_segment_type,
110
	kw_type,
111
	kw_typegraph,
112
	kw_unknown,
113
114
} keyword_t;

Matthias Braun's avatar
Matthias Braun committed
115
typedef struct symbol_t {
116
117
118
119
	const char *str;      /**< The name of this symbol. */
	typetag_t   typetag;  /**< The type tag of this symbol. */
	unsigned    code;     /**< The value of this symbol. */
} symbol_t;
120

Matthias Braun's avatar
Matthias Braun committed
121
typedef struct id_entry {
122
123
124
125
	long id;
	void *elem;
} id_entry;

126
127
/** The symbol table, a set of symbol_t elements. */
static set *symtbl;
128

129
130
131
132
/**
 * Compare two symbol table entries.
 */
static int symbol_cmp(const void *elt, const void *key, size_t size)
133
{
Matthias Braun's avatar
cleanup    
Matthias Braun committed
134
	(void)size;
135
136
	const symbol_t *entry = (const symbol_t *) elt;
	const symbol_t *keyentry = (const symbol_t *) key;
Matthias Braun's avatar
Matthias Braun committed
137
138
139
	int res = entry->typetag - keyentry->typetag;
	if (res != 0)
		return res;
140
141
142
143
144
	return strcmp(entry->str, keyentry->str);
}

static int id_cmp(const void *elt, const void *key, size_t size)
{
Matthias Braun's avatar
cleanup    
Matthias Braun committed
145
	(void)size;
146
147
148
149
150
	const id_entry *entry = (const id_entry *) elt;
	const id_entry *keyentry = (const id_entry *) key;
	return entry->id - keyentry->id;
}

151
static void FIRM_PRINTF(2, 3)
Matthias Braun's avatar
Matthias Braun committed
152
parse_error(read_env_t *env, const char *fmt, ...)
153
154
155
{
	/* workaround read_c "feature" that a '\n' triggers the line++
	 * instead of the character after the '\n' */
Matthias Braun's avatar
Matthias Braun committed
156
	unsigned line = env->line;
157
158
159
160
	if (env->c == '\n') {
		line--;
	}

Matthias Braun's avatar
Matthias Braun committed
161
162
163
	fprintf(stderr, "%s:%u: error ", env->inputname, line);
	env->read_errors = true;

Matthias Braun's avatar
Matthias Braun committed
164
	va_list ap;
165
166
167
168
169
	va_start(ap, fmt);
	vfprintf(stderr, fmt, ap);
	va_end(ap);
}

170
171
/** Initializes the symbol table. May be called more than once without problems. */
static void symtbl_init(void)
172
173
{
	/* Only initialize once */
Michael Beck's avatar
Michael Beck committed
174
	if (symtbl != NULL)
175
		return;
176

177
	symtbl = new_set(symbol_cmp, 256);
178

Matthias Braun's avatar
Matthias Braun committed
179
	symbol_t key;
180
#define INSERT(tt, s, cod)                                       \
181
182
183
	key.str = (s);                                               \
	key.typetag = (tt);                                          \
	key.code = (cod);                                            \
sebastian.buchwald1's avatar
sebastian.buchwald1 committed
184
	(void)set_insert(symbol_t, symtbl, &key, sizeof(key), hash_str(s) + tt * 17)
185
186
187
188
189
190
191
192
193

#define INSERTENUM(tt, e) INSERT(tt, #e, e)
#define INSERTKEYWORD(k) INSERT(tt_keyword, #k, kw_##k)

	INSERT(tt_tpo, "array", tpo_array);
	INSERT(tt_tpo, "class", tpo_class);
	INSERT(tt_tpo, "method", tpo_method);
	INSERT(tt_tpo, "pointer", tpo_pointer);
	INSERT(tt_tpo, "primitive", tpo_primitive);
194
	INSERT(tt_tpo, "segment", tpo_segment);
195
196
197
198
199
200
201
202
	INSERT(tt_tpo, "struct", tpo_struct);
	INSERT(tt_tpo, "union", tpo_union);
	INSERT(tt_tpo, "Unknown", tpo_unknown);

	INSERT(tt_segment, "global", IR_SEGMENT_GLOBAL);
	INSERT(tt_segment, "thread_local", IR_SEGMENT_THREAD_LOCAL);
	INSERT(tt_segment, "constructors", IR_SEGMENT_CONSTRUCTORS);
	INSERT(tt_segment, "destructors", IR_SEGMENT_DESTRUCTORS);
Matthias Braun's avatar
Matthias Braun committed
203
	INSERT(tt_segment, "jcr", IR_SEGMENT_JCR);
204

Matthias Braun's avatar
Matthias Braun committed
205
206
207
208
209
210
	INSERT(tt_linkage, "constant", IR_LINKAGE_CONSTANT);
	INSERT(tt_linkage, "weak", IR_LINKAGE_WEAK);
	INSERT(tt_linkage, "garbage_collect", IR_LINKAGE_GARBAGE_COLLECT);
	INSERT(tt_linkage, "merge", IR_LINKAGE_MERGE);
	INSERT(tt_linkage, "hidden_user", IR_LINKAGE_HIDDEN_USER);

211
212
213
	INSERT(tt_loop, "loop",   true);
	INSERT(tt_loop, "noloop", false);

214
215
216
217
218
	INSERT(tt_visibility, "external",           ir_visibility_external);
	INSERT(tt_visibility, "external_private",   ir_visibility_external_private);
	INSERT(tt_visibility, "external_protected", ir_visibility_external_protected);
	INSERT(tt_visibility, "local",              ir_visibility_local);
	INSERT(tt_visibility, "private",            ir_visibility_private);
219

Matthias Braun's avatar
Matthias Braun committed
220
221
222
	INSERT(tt_throws, "throw",   true);
	INSERT(tt_throws, "nothrow", false);

223
	INSERTKEYWORD(alias);
Matthias Braun's avatar
Matthias Braun committed
224
225
	INSERTKEYWORD(asm);
	INSERTKEYWORD(compound_member);
226
227
	INSERTKEYWORD(constirg);
	INSERTKEYWORD(entity);
228
	INSERTKEYWORD(float_mode);
Matthias Braun's avatar
Matthias Braun committed
229
	INSERTKEYWORD(gotentry);
Matthias Braun's avatar
Matthias Braun committed
230
231
232
233
	INSERTKEYWORD(int_mode);
	INSERTKEYWORD(irg);
	INSERTKEYWORD(label);
	INSERTKEYWORD(method);
234
	INSERTKEYWORD(modes);
Matthias Braun's avatar
Matthias Braun committed
235
	INSERTKEYWORD(parameter);
236
	INSERTKEYWORD(program);
Matthias Braun's avatar
Matthias Braun committed
237
	INSERTKEYWORD(reference_mode);
238
	INSERTKEYWORD(segment_type);
Matthias Braun's avatar
Matthias Braun committed
239
240
	INSERTKEYWORD(type);
	INSERTKEYWORD(typegraph);
241
	INSERTKEYWORD(unknown);
242
243
244
245

	INSERTENUM(tt_align, align_non_aligned);
	INSERTENUM(tt_align, align_is_aligned);

Matthias Braun's avatar
Matthias Braun committed
246
247
248
249
250
251
252
253
254
255
256
257
258
	INSERTENUM(tt_builtin_kind, ir_bk_trap);
	INSERTENUM(tt_builtin_kind, ir_bk_debugbreak);
	INSERTENUM(tt_builtin_kind, ir_bk_return_address);
	INSERTENUM(tt_builtin_kind, ir_bk_frame_address);
	INSERTENUM(tt_builtin_kind, ir_bk_prefetch);
	INSERTENUM(tt_builtin_kind, ir_bk_ffs);
	INSERTENUM(tt_builtin_kind, ir_bk_clz);
	INSERTENUM(tt_builtin_kind, ir_bk_ctz);
	INSERTENUM(tt_builtin_kind, ir_bk_popcount);
	INSERTENUM(tt_builtin_kind, ir_bk_parity);
	INSERTENUM(tt_builtin_kind, ir_bk_bswap);
	INSERTENUM(tt_builtin_kind, ir_bk_inport);
	INSERTENUM(tt_builtin_kind, ir_bk_outport);
259
	INSERTENUM(tt_builtin_kind, ir_bk_saturating_increment);
260
	INSERTENUM(tt_builtin_kind, ir_bk_compare_swap);
261
262
263
264
265
266
267
268
269
270

	INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_NONE);
	INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_TRUE);
	INSERTENUM(tt_cond_jmp_predicate, COND_JMP_PRED_FALSE);

	INSERTENUM(tt_initializer, IR_INITIALIZER_CONST);
	INSERTENUM(tt_initializer, IR_INITIALIZER_TARVAL);
	INSERTENUM(tt_initializer, IR_INITIALIZER_NULL);
	INSERTENUM(tt_initializer, IR_INITIALIZER_COMPOUND);

Matthias Braun's avatar
Matthias Braun committed
271
272
273
274
275
	INSERT(tt_mode_arithmetic, "none",               irma_none);
	INSERT(tt_mode_arithmetic, "twos_complement",    irma_twos_complement);
	INSERT(tt_mode_arithmetic, "ieee754",            irma_ieee754);
	INSERT(tt_mode_arithmetic, "x86_extended_float", irma_x86_extended_float);

276
277
278
279
280
281
282
283
284
285
	INSERTENUM(tt_pin_state, op_pin_state_floats);
	INSERTENUM(tt_pin_state, op_pin_state_pinned);
	INSERTENUM(tt_pin_state, op_pin_state_exc_pinned);

	INSERTENUM(tt_type_state, layout_undefined);
	INSERTENUM(tt_type_state, layout_fixed);

	INSERTENUM(tt_volatility, volatility_non_volatile);
	INSERTENUM(tt_volatility, volatility_is_volatile);

286
#undef INSERTKEYWORD
287
288
289
290
#undef INSERTENUM
#undef INSERT
}

291
292
293
294
295
296
297
static const char *get_segment_name(ir_segment_t segment)
{
	switch (segment) {
	case IR_SEGMENT_GLOBAL:       return "global";
	case IR_SEGMENT_THREAD_LOCAL: return "thread_local";
	case IR_SEGMENT_CONSTRUCTORS: return "constructors";
	case IR_SEGMENT_DESTRUCTORS:  return "destructors";
Matthias Braun's avatar
Matthias Braun committed
298
	case IR_SEGMENT_JCR:          return "jcr";
299
	}
300
	panic("invalid segment");
301
302
}

303
304
305
static const char *get_visibility_name(ir_visibility visibility)
{
	switch (visibility) {
306
307
308
309
310
	case ir_visibility_external:           return "external";
	case ir_visibility_external_private:   return "external_private";
	case ir_visibility_external_protected: return "external_protected";
	case ir_visibility_local:              return "local";
	case ir_visibility_private:            return "private";
311
	}
312
	panic("invalid visibility");
Matthias Braun's avatar
Matthias Braun committed
313
314
315
316
317
318
319
320
321
322
323
324
325
}

static const char *get_mode_arithmetic_name(ir_mode_arithmetic arithmetic)
{
	switch (arithmetic) {
	case irma_none:               return "none";
	case irma_twos_complement:    return "twos_complement";
	case irma_ieee754:            return "ieee754";
	case irma_x86_extended_float: return "x86_extended_float";
	}
	panic("invalid mode_arithmetic");
}

326
327
/** Returns the according symbol value for the given string and tag, or SYMERROR if none was found. */
static unsigned symbol(const char *str, typetag_t typetag)
328
{
Matthias Braun's avatar
Matthias Braun committed
329
330
	symbol_t key;
	key.str     = str;
331
	key.typetag = typetag;
332

Matthias Braun's avatar
Matthias Braun committed
333
334
	symbol_t *entry = set_find(symbol_t, symtbl, &key, sizeof(key),
	                           hash_str(str) + typetag * 17);
335
	return entry ? entry->code : SYMERROR;
336
337
}

Matthias Braun's avatar
Matthias Braun committed
338
static void write_long(write_env_t *env, long value)
339
{
Matthias Braun's avatar
Matthias Braun committed
340
	fprintf(env->file, "%ld ", value);
341
342
}

Matthias Braun's avatar
Matthias Braun committed
343
static void write_int(write_env_t *env, int value)
344
{
Matthias Braun's avatar
Matthias Braun committed
345
	fprintf(env->file, "%d ", value);
346
347
}

Matthias Braun's avatar
Matthias Braun committed
348
static void write_unsigned(write_env_t *env, unsigned value)
349
{
Matthias Braun's avatar
Matthias Braun committed
350
	fprintf(env->file, "%u ", value);
351
352
}

Matthias Braun's avatar
Matthias Braun committed
353
static void write_size_t(write_env_t *env, size_t value)
354
{
Matthias Braun's avatar
Matthias Braun committed
355
	ir_fprintf(env->file, "%zu ", value);
356
357
}

Matthias Braun's avatar
Matthias Braun committed
358
static void write_symbol(write_env_t *env, const char *symbol)
359
{
Matthias Braun's avatar
Matthias Braun committed
360
361
	fputs(symbol, env->file);
	fputc(' ', env->file);
362
363
}

Matthias Braun's avatar
Matthias Braun committed
364
static void write_entity_ref(write_env_t *env, ir_entity *entity)
365
366
367
368
{
	write_long(env, get_entity_nr(entity));
}

Matthias Braun's avatar
Matthias Braun committed
369
static void write_type_ref(write_env_t *env, ir_type *type)
370
{
371
	switch (get_type_opcode(type)) {
372
	case tpo_unknown:
Matthias Braun's avatar
Matthias Braun committed
373
		write_symbol(env, "unknown");
374
375
		return;
	case tpo_code:
Matthias Braun's avatar
Matthias Braun committed
376
		write_symbol(env, "code");
377
378
379
		return;
	default:
		break;
Matthias Braun's avatar
Matthias Braun committed
380
	}
381
	write_long(env, get_type_nr(type));
382
383
}

Matthias Braun's avatar
Matthias Braun committed
384
static void write_string(write_env_t *env, const char *string)
Matthias Braun's avatar
Matthias Braun committed
385
386
{
	fputc('"', env->file);
Matthias Braun's avatar
Matthias Braun committed
387
	for (const char *c = string; *c != '\0'; ++c) {
Matthias Braun's avatar
Matthias Braun committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
		switch (*c) {
		case '\n':
			fputc('\\', env->file);
			fputc('n', env->file);
			break;
		case '"':
		case '\\':
			fputc('\\', env->file);
			/* FALLTHROUGH */
		default:
			fputc(*c, env->file);
			break;
		}
	}
	fputc('"', env->file);
Matthias Braun's avatar
Matthias Braun committed
403
	fputc(' ', env->file);
Matthias Braun's avatar
Matthias Braun committed
404
405
}

Matthias Braun's avatar
Matthias Braun committed
406
static void write_ident(write_env_t *env, ident *id)
Matthias Braun's avatar
Matthias Braun committed
407
408
409
410
{
	write_string(env, get_id_str(id));
}

Matthias Braun's avatar
Matthias Braun committed
411
static void write_ident_null(write_env_t *env, ident *id)
Matthias Braun's avatar
Matthias Braun committed
412
413
414
415
416
417
418
419
{
	if (id == NULL) {
		fputs("NULL ", env->file);
	} else {
		write_ident(env, id);
	}
}

Matthias Braun's avatar
Matthias Braun committed
420
static void write_mode_ref(write_env_t *env, ir_mode *mode)
421
{
422
	write_string(env, get_mode_name(mode));
423
424
}

425
static void write_tarval_ref(write_env_t *env, ir_tarval *tv)
426
{
427
428
429
430
431
432
	ir_mode *mode = get_tarval_mode(tv);
	write_mode_ref(env, mode);
	char buf[128];
	const char *ascii = ir_tarval_to_ascii(buf, sizeof(buf), tv);
	fputs(ascii, env->file);
	fputc(' ', env->file);
433
434
}

Matthias Braun's avatar
Matthias Braun committed
435
static void write_align(write_env_t *env, ir_align align)
436
437
438
439
440
{
	fputs(get_align_name(align), env->file);
	fputc(' ', env->file);
}

441
static void write_builtin_kind(write_env_t *env, ir_builtin_kind kind)
442
{
443
	fputs(get_builtin_kind_name(kind), env->file);
444
445
446
	fputc(' ', env->file);
}

447
static void write_cond_jmp_predicate(write_env_t *env, cond_jmp_predicate pred)
448
{
449
	fputs(get_cond_jmp_predicate_name(pred), env->file);
450
451
452
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
453
454
455
456
457
458
459
460
461
462
static void write_relation(write_env_t *env, ir_relation relation)
{
	write_long(env, (long)relation);
}

static void write_throws(write_env_t *env, bool throws)
{
	write_symbol(env, throws ? "throw" : "nothrow");
}

463
464
465
466
467
static void write_loop(write_env_t *env, bool loop)
{
	write_symbol(env, loop ? "loop" : "noloop");
}

Matthias Braun's avatar
Matthias Braun committed
468
static void write_list_begin(write_env_t *env)
469
470
471
472
{
	fputs("[", env->file);
}

Matthias Braun's avatar
Matthias Braun committed
473
static void write_list_end(write_env_t *env)
474
475
476
477
{
	fputs("] ", env->file);
}

Matthias Braun's avatar
Matthias Braun committed
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
static void write_scope_begin(write_env_t *env)
{
	fputs("{\n", env->file);
}

static void write_scope_end(write_env_t *env)
{
	fputs("}\n\n", env->file);
}

static void write_node_ref(write_env_t *env, const ir_node *node)
{
	write_long(env, get_irn_node_nr(node));
}

493
static void write_initializer(write_env_t *const env, ir_initializer_t const *const ini)
494
495
496
{
	FILE *f = env->file;
	ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
497

498
499
500
	fputs(get_initializer_kind_name(ini_kind), f);
	fputc(' ', f);

501
502
	switch (ini_kind) {
	case IR_INITIALIZER_CONST:
Matthias Braun's avatar
Matthias Braun committed
503
504
		write_node_ref(env, get_initializer_const_value(ini));
		return;
505

506
	case IR_INITIALIZER_TARVAL:
507
		write_tarval_ref(env, get_initializer_tarval_value(ini));
Matthias Braun's avatar
Matthias Braun committed
508
		return;
509

510
	case IR_INITIALIZER_NULL:
Matthias Braun's avatar
Matthias Braun committed
511
		return;
512

513
	case IR_INITIALIZER_COMPOUND: {
Matthias Braun's avatar
Matthias Braun committed
514
		size_t n = get_initializer_compound_n_entries(ini);
Matthias Braun's avatar
Matthias Braun committed
515
		write_size_t(env, n);
Matthias Braun's avatar
Matthias Braun committed
516
		for (size_t i = 0; i < n; ++i)
517
			write_initializer(env, get_initializer_compound_value(ini, i));
Matthias Braun's avatar
Matthias Braun committed
518
		return;
519
	}
520
	}
521
	panic("unknown initializer kind");
522
523
}

Matthias Braun's avatar
Matthias Braun committed
524
static void write_pin_state(write_env_t *env, op_pin_state state)
525
{
Matthias Braun's avatar
Matthias Braun committed
526
	fputs(get_op_pin_state_name(state), env->file);
527
528
529
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
530
static void write_volatility(write_env_t *env, ir_volatility vol)
531
532
533
534
535
{
	fputs(get_volatility_name(vol), env->file);
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
536
static void write_type_state(write_env_t *env, ir_type_state state)
537
{
Matthias Braun's avatar
Matthias Braun committed
538
539
540
	fputs(get_type_state_name(state), env->file);
	fputc(' ', env->file);
}
541

Matthias Braun's avatar
Matthias Braun committed
542
543
544
545
546
static void write_visibility(write_env_t *env, ir_visibility visibility)
{
	fputs(get_visibility_name(visibility), env->file);
	fputc(' ', env->file);
}
547

Matthias Braun's avatar
Matthias Braun committed
548
549
550
551
552
static void write_mode_arithmetic(write_env_t *env, ir_mode_arithmetic arithmetic)
{
	fputs(get_mode_arithmetic_name(arithmetic), env->file);
	fputc(' ', env->file);
}
553

Matthias Braun's avatar
Matthias Braun committed
554
555
556
557
558
static void write_type_common(write_env_t *env, ir_type *tp)
{
	fputc('\t', env->file);
	write_symbol(env, "type");
	write_long(env, get_type_nr(tp));
559
	write_symbol(env, get_type_opcode_name(get_type_opcode(tp)));
Matthias Braun's avatar
Matthias Braun committed
560
561
562
563
564
	write_unsigned(env, get_type_size_bytes(tp));
	write_unsigned(env, get_type_alignment_bytes(tp));
	write_type_state(env, get_type_state(tp));
	write_unsigned(env, tp->flags);
}
565

sebastian.buchwald1's avatar
sebastian.buchwald1 committed
566
567
static void write_type(write_env_t *env, ir_type *tp);

568
569
570
571
572
573
574
575
576
577
578
579
580
static bool is_internal_mode(ir_mode *mode)
{
	return !mode_is_int(mode) && !mode_is_reference(mode)
	    && !mode_is_float(mode);
}

static bool is_default_mode(ir_mode *mode)
{
	/* some modes which are always available in libfirm */
	return mode == mode_b || mode == mode_X || mode == mode_BB
	    || mode == mode_T || mode == mode_ANY || mode == mode_BAD;
}

Matthias Braun's avatar
Matthias Braun committed
581
582
static void write_type_primitive(write_env_t *env, ir_type *tp)
{
583
584
585
586
587
	/* skip types for internal modes */
	ir_mode *mode = get_type_mode(tp);
	if (is_internal_mode(mode) && !is_default_mode(mode))
		return;

Matthias Braun's avatar
Matthias Braun committed
588
	write_type_common(env, tp);
589
	write_mode_ref(env, mode);
Matthias Braun's avatar
Matthias Braun committed
590
	fputc('\n', env->file);
591
592
}

Matthias Braun's avatar
Matthias Braun committed
593
static void write_type_compound(write_env_t *env, ir_type *tp)
594
{
Matthias Braun's avatar
Matthias Braun committed
595
	if (is_Class_type(tp)) {
596
		if (get_class_n_subtypes(tp) > 0 || get_class_n_supertypes(tp) > 0) {
sebastian.buchwald1's avatar
sebastian.buchwald1 committed
597
			/* sub/superclass export not implemented yet, it's unclear whether
Matthias Braun's avatar
Matthias Braun committed
598
599
600
			 * class types will stay in libfirm anyway */
			panic("can't export class types yet");
		}
601
	}
Matthias Braun's avatar
Matthias Braun committed
602
603
604
	write_type_common(env, tp);
	write_ident_null(env, get_compound_ident(tp));
	fputc('\n', env->file);
605

Matthias Braun's avatar
Matthias Braun committed
606
	for (size_t i = 0, n = get_compound_n_members(tp); i < n; ++i) {
Matthias Braun's avatar
Matthias Braun committed
607
		ir_entity *member = get_compound_member(tp, i);
608
		pdeq_putr(env->entity_queue, member);
609
	}
Matthias Braun's avatar
Matthias Braun committed
610
}
611

Matthias Braun's avatar
Matthias Braun committed
612
613
static void write_type_array(write_env_t *env, ir_type *tp)
{
Matthias Braun's avatar
Matthias Braun committed
614
	ir_type *element_type = get_array_element_type(tp);
Matthias Braun's avatar
Matthias Braun committed
615
616
617
	write_type(env, element_type);

	write_type_common(env, tp);
Matthias Braun's avatar
Matthias Braun committed
618
	write_type_ref(env, element_type);
619
620
	ir_node *size = get_array_size(tp);
	if (is_Const(size))
621
		write_long(env, get_Const_long(size));
622
623
624
	else if (is_Unknown(size))
		write_symbol(env, "unknown");
	else
625
		panic("upper array bound is not constant");
Matthias Braun's avatar
Matthias Braun committed
626
627
	fputc('\n', env->file);
}
628

Matthias Braun's avatar
Matthias Braun committed
629
630
631
static void write_type_method(write_env_t *env, ir_type *tp)
{
	size_t nparams  = get_method_n_params(tp);
Matthias Braun's avatar
Matthias Braun committed
632
	for (size_t i = 0; i < nparams; i++)
Matthias Braun's avatar
Matthias Braun committed
633
		write_type(env, get_method_param_type(tp, i));
Matthias Braun's avatar
Matthias Braun committed
634
635
	size_t nresults = get_method_n_ress(tp);
	for (size_t i = 0; i < nresults; i++)
Matthias Braun's avatar
Matthias Braun committed
636
637
638
639
640
641
642
		write_type(env, get_method_res_type(tp, i));

	write_type_common(env, tp);
	write_unsigned(env, get_method_calling_convention(tp));
	write_unsigned(env, get_method_additional_properties(tp));
	write_size_t(env, nparams);
	write_size_t(env, nresults);
Matthias Braun's avatar
Matthias Braun committed
643
	for (size_t i = 0; i < nparams; i++)
Matthias Braun's avatar
Matthias Braun committed
644
		write_type_ref(env, get_method_param_type(tp, i));
Matthias Braun's avatar
Matthias Braun committed
645
	for (size_t i = 0; i < nresults; i++)
Matthias Braun's avatar
Matthias Braun committed
646
		write_type_ref(env, get_method_res_type(tp, i));
647
	write_unsigned(env, is_method_variadic(tp));
Matthias Braun's avatar
Matthias Braun committed
648
649
	fputc('\n', env->file);
}
650

Matthias Braun's avatar
Matthias Braun committed
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
static void write_type_pointer(write_env_t *env, ir_type *tp)
{
	ir_type *points_to = get_pointer_points_to_type(tp);

	write_type(env, points_to);

	write_type_common(env, tp);
	write_type_ref(env, points_to);
	fputc('\n', env->file);
}

static void write_type(write_env_t *env, ir_type *tp)
{
	if (type_visited(tp))
		return;
	mark_type_visited(tp);

668
	switch (get_type_opcode(tp)) {
Matthias Braun's avatar
Matthias Braun committed
669
670
671
672
673
674
675
676
677
	case tpo_unknown:
	case tpo_code:
	case tpo_uninitialized:
		/* no need to write special builtin types */
		return;

	case tpo_union:
	case tpo_struct:
	case tpo_class:
678
	case tpo_segment:
Matthias Braun's avatar
Matthias Braun committed
679
680
681
		write_type_compound(env, tp);
		return;

682
683
684
685
	case tpo_primitive: write_type_primitive(env, tp); return;
	case tpo_method:    write_type_method(env, tp);    return;
	case tpo_pointer:   write_type_pointer(env, tp);   return;
	case tpo_array:     write_type_array(env, tp);     return;
686
	}
687
	panic("can't write invalid type %+F", tp);
688
689
}

Matthias Braun's avatar
Matthias Braun committed
690
static void write_entity(write_env_t *env, ir_entity *ent)
691
{
Matthias Braun's avatar
Matthias Braun committed
692
	ir_type       *type       = get_entity_type(ent);
693
694
695
	ir_type       *owner      = get_entity_owner(ent);
	ir_visibility  visibility = get_entity_visibility(ent);
	ir_linkage     linkage    = get_entity_linkage(ent);
696

Matthias Braun's avatar
Matthias Braun committed
697
	if (entity_visited(ent))
698
		return;
Matthias Braun's avatar
Matthias Braun committed
699
	mark_entity_visited(ent);
700

Matthias Braun's avatar
Matthias Braun committed
701
702
	write_type(env, type);
	write_type(env, owner);
703
704
705
706
	if (is_alias_entity(ent)) {
		ir_entity *aliased = get_entity_alias(ent);
		write_entity(env, aliased);
	}
Matthias Braun's avatar
Matthias Braun committed
707
708
709

	fputc('\t', env->file);
	switch ((ir_entity_kind)ent->entity_kind) {
710
	case IR_ENTITY_ALIAS:           write_symbol(env, "alias");           break;
Matthias Braun's avatar
Matthias Braun committed
711
712
713
714
715
	case IR_ENTITY_NORMAL:          write_symbol(env, "entity");          break;
	case IR_ENTITY_METHOD:          write_symbol(env, "method");          break;
	case IR_ENTITY_LABEL:           write_symbol(env, "label");           break;
	case IR_ENTITY_COMPOUND_MEMBER: write_symbol(env, "compound_member"); break;
	case IR_ENTITY_PARAMETER:       write_symbol(env, "parameter");       break;
716
717
718
719
	case IR_ENTITY_UNKNOWN:
		write_symbol(env, "unknown");
		write_long(env, get_entity_nr(ent));
		return;
720
	}
Matthias Braun's avatar
Matthias Braun committed
721
	write_long(env, get_entity_nr(ent));
722

Matthias Braun's avatar
Matthias Braun committed
723
	if (ent->entity_kind != IR_ENTITY_LABEL
Matthias Braun's avatar
Matthias Braun committed
724
	 && ent->entity_kind != IR_ENTITY_PARAMETER) {
Matthias Braun's avatar
Matthias Braun committed
725
726
727
728
729
730
		write_ident_null(env, get_entity_ident(ent));
		if (!entity_has_ld_ident(ent)) {
			write_ident_null(env, NULL);
		} else {
			write_ident_null(env, get_entity_ld_ident(ent));
		}
731
	}
Matthias Braun's avatar
Matthias Braun committed
732
733
734

	write_visibility(env, visibility);
	write_list_begin(env);
735
	if (linkage & IR_LINKAGE_CONSTANT)
Matthias Braun's avatar
Matthias Braun committed
736
		write_symbol(env, "constant");
737
	if (linkage & IR_LINKAGE_WEAK)
Matthias Braun's avatar
Matthias Braun committed
738
		write_symbol(env, "weak");
739
	if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
Matthias Braun's avatar
Matthias Braun committed
740
		write_symbol(env, "garbage_collect");
741
	if (linkage & IR_LINKAGE_MERGE)
Matthias Braun's avatar
Matthias Braun committed
742
		write_symbol(env, "merge");
743
	if (linkage & IR_LINKAGE_HIDDEN_USER)
Matthias Braun's avatar
Matthias Braun committed
744
745
746
747
748
749
750
751
752
		write_symbol(env, "hidden_user");
	write_list_end(env);

	write_type_ref(env, type);
	if (ent->entity_kind != IR_ENTITY_LABEL)
		write_type_ref(env, owner);
	write_volatility(env, get_entity_volatility(ent));

	switch ((ir_entity_kind)ent->entity_kind) {
753
754
755
	case IR_ENTITY_ALIAS:
		write_entity_ref(env, get_entity_alias(ent));
		break;
756
757
758
759

	case IR_ENTITY_NORMAL: {
		ir_initializer_t const *const init = get_entity_initializer(ent);
		if (init) {
Matthias Braun's avatar
Matthias Braun committed
760
			write_symbol(env, "initializer");
761
			write_initializer(env, init);
Matthias Braun's avatar
Matthias Braun committed
762
763
		} else {
			write_symbol(env, "none");
764
		}
Matthias Braun's avatar
Matthias Braun committed
765
		break;
766
767
	}

Matthias Braun's avatar
Matthias Braun committed
768
769
	case IR_ENTITY_COMPOUND_MEMBER:
		write_long(env, get_entity_offset(ent));
770
771
		write_unsigned(env, get_entity_bitfield_offset(ent));
		write_unsigned(env, get_entity_bitfield_size(ent));
Matthias Braun's avatar
Matthias Braun committed
772
773
774
775
776
777
778
779
		break;
	case IR_ENTITY_PARAMETER: {
		size_t num = get_entity_parameter_number(ent);
		if (num == IR_VA_START_PARAMETER_NUMBER) {
			write_symbol(env, "va_start");
		} else {
			write_size_t(env, num);
		}
780
781
782
		write_long(env, get_entity_offset(ent));
		write_unsigned(env, get_entity_bitfield_offset(ent));
		write_unsigned(env, get_entity_bitfield_size(ent));
Matthias Braun's avatar
Matthias Braun committed
783
784
		break;
	}
785
786
787
	case IR_ENTITY_METHOD:
		write_long(env, (long)get_entity_additional_properties(ent));
		break;
788
	case IR_ENTITY_UNKNOWN:
Matthias Braun's avatar
Matthias Braun committed
789
790
	case IR_ENTITY_LABEL:
		break;
791
792
793
	}

	fputc('\n', env->file);
794
795
}

796
797
static void write_switch_table_ref(write_env_t *env,
                                   const ir_switch_table *table)
798
{
Matthias Braun's avatar
Matthias Braun committed
799
800
	size_t n_entries = ir_switch_table_get_n_entries(table);
	write_size_t(env, n_entries);
Matthias Braun's avatar
Matthias Braun committed
801
	for (size_t i = 0; i < n_entries; ++i) {
Matthias Braun's avatar
Matthias Braun committed
802
803
804
805
		long       pn  = ir_switch_table_get_pn(table, i);
		ir_tarval *min = ir_switch_table_get_min(table, i);
		ir_tarval *max = ir_switch_table_get_max(table, i);
		write_long(env, pn);
806
807
		write_tarval_ref(env, min);
		write_tarval_ref(env, max);
Matthias Braun's avatar
Matthias Braun committed
808
	}
809
810
}

Matthias Braun's avatar
Matthias Braun committed
811
static void write_pred_refs(write_env_t *env, const ir_node *node, int from)
812
{
Matthias Braun's avatar
Matthias Braun committed
813
	write_list_begin(env);
Matthias Braun's avatar
Matthias Braun committed
814
	int arity = get_irn_arity(node);
Matthias Braun's avatar
Matthias Braun committed
815
	assert(from <= arity);
Matthias Braun's avatar
Matthias Braun committed
816
	for (int i = from; i < arity; ++i) {
Matthias Braun's avatar
Matthias Braun committed
817
818
		ir_node *pred = get_irn_n(node, i);
		write_node_ref(env, pred);
819
	}
Matthias Braun's avatar
Matthias Braun committed
820
	write_list_end(env);
821
822
}

Matthias Braun's avatar
Matthias Braun committed
823
824
825
826
827
828
static void write_node_nr(write_env_t *env, const ir_node *node)
{
	write_long(env, get_irn_node_nr(node));
}

static void write_ASM(write_env_t *env, const ir_node *node)
Matthias Braun's avatar
Matthias Braun committed
829
{
Matthias Braun's avatar
Matthias Braun committed
830
831
832
	write_symbol(env, "ASM");
	write_node_nr(env, node);
	write_node_nr(env, get_nodes_block(node));
833
	write_node_nr(env, get_ASM_mem(node));
Matthias Braun's avatar
Matthias Braun committed
834
835
836

	write_ident(env, get_ASM_text(node));
	write_list_begin(env);
837
838
839
	ir_asm_constraint *input_constraints = get_ASM_input_constraints(node);
	int                n_inputs          = get_ASM_n_inputs(node);
	for (int i = 0; i < n_inputs; ++i) {
Matthias Braun's avatar
Matthias Braun committed
840
841
842
		const ir_asm_constraint *constraint = &input_constraints[i];
		write_unsigned(env, constraint->pos);
		write_ident(env, constraint->constraint);
Matthias Braun's avatar
Matthias Braun committed
843
		write_mode_ref(env, constraint->mode);
Matthias Braun's avatar
Matthias Braun committed
844
845
846
847
	}
	write_list_end(env);

	write_list_begin(env);
848
849
850
	ir_asm_constraint *output_constraints  = get_ASM_output_constraints(node);
	size_t            n_output_constraints = get_ASM_n_output_constraints(node);
	for (size_t i = 0; i < n_output_constraints; ++i) {
Matthias Braun's avatar
Matthias Braun committed
851
852
853
		const ir_asm_constraint *constraint = &output_constraints[i];
		write_unsigned(env, constraint->pos);
		write_ident(env, constraint->constraint);
Matthias Braun's avatar
Matthias Braun committed
854
		write_mode_ref(env, constraint->mode);
Matthias Braun's avatar
Matthias Braun committed
855
856
857
858
	}
	write_list_end(env);

	write_list_begin(env);
859
860
861
	ident **clobbers   = get_ASM_clobbers(node);
	size_t  n_clobbers = get_ASM_n_clobbers(node);
	for (size_t i = 0; i < n_clobbers; ++i) {
Matthias Braun's avatar
Matthias Braun committed
862
863
864
865
		ident *clobber = clobbers[i];
		write_ident(env, clobber);
	}
	write_list_end(env);
Matthias Braun's avatar
Matthias Braun committed
866
867

	write_pin_state(env, get_irn_pinned(node));
Matthias Braun's avatar
Matthias Braun committed
868
	write_pred_refs(env, node, n_ASM_max+1);
Matthias Braun's avatar
Matthias Braun committed
869
870
}

Matthias Braun's avatar
Matthias Braun committed
871
static void write_Phi(write_env_t *env, const ir_node *node)
872
{
Matthias Braun's avatar
Matthias Braun committed
873
874
875
876
	write_symbol(env, "Phi");
	write_node_nr(env, node);
	write_node_ref(env, get_nodes_block(node));
	write_mode_ref(env, get_irn_mode(node));
877
	write_loop(env, get_Phi_loop(node));
Matthias Braun's avatar
Matthias Braun committed
878
879
	write_pred_refs(env, node, 0);
}
880

Matthias Braun's avatar
Matthias Braun committed
881
882
883
static void write_Block(write_env_t *env, const ir_node *node)
{
	ir_entity *entity = get_Block_entity(node);
884

Matthias Braun's avatar
Matthias Braun committed
885
886
887
888
889
890
891
	if (entity != NULL) {
		write_symbol(env, "BlockL");
		write_node_nr(env, node);
		write_entity_ref(env, entity);
	} else {
		write_symbol(env, "Block");
		write_node_nr(env, node);
892
	}
Matthias Braun's avatar
Matthias Braun committed
893
894
	write_pred_refs(env, node, 0);
}
895

Matthias Braun's avatar
Matthias Braun committed
896
897
898
899
900
901
902
static void write_Anchor(write_env_t *env, const ir_node *node)
{
	write_symbol(env, "Anchor");
	write_node_nr(env, node);
	write_pred_refs(env, node, 0);
}

903
typedef void write_node_func(write_env_t *env, ir_node const *node);
Matthias Braun's avatar
Matthias Braun committed
904

905
static void register_node_writer(ir_op *op, write_node_func *func)
Matthias Braun's avatar
Matthias Braun committed
906
{
907
	set_generic_function_ptr(op, func);
Matthias Braun's avatar
Matthias Braun committed
908
909
910
911
}

static void writers_init(void)
{
Matthias Braun's avatar
Matthias Braun committed
912
	ir_clear_opcodes_generic_func();
913
914
915
916
	register_node_writer(op_Anchor, write_Anchor);
	register_node_writer(op_ASM,    write_ASM);
	register_node_writer(op_Block,  write_Block);
	register_node_writer(op_Phi,    write_Phi);
Matthias Braun's avatar
Matthias Braun committed
917
918
919
920
921
	register_generated_node_writers();
}

static void write_node(const ir_node *node, write_env_t *env)
{
922
923
	ir_op           *const op   = get_irn_op(node);
	write_node_func *const func = get_generic_function_ptr(write_node_func, op);
Matthias Braun's avatar
Matthias Braun committed
924
925
926

	fputc('\t', env->file);
	if (func == NULL)
927
		panic("no write_node_func for %+F", node);
Matthias Braun's avatar
Matthias Braun committed
928
929
930
931
932
933
934
935
	func(env, node);
	fputc('\n', env->file);
}

static void write_node_recursive(ir_node *node, write_env_t *env);

static void write_preds(ir_node *node, write_env_t *env)
{
936
	foreach_irn_in(node, i, pred) {
Matthias Braun's avatar
Matthias Braun committed
937
		write_node_recursive(pred, env);
938
	}
Matthias Braun's avatar
Matthias Braun committed
939
}
940

Matthias Braun's avatar
Matthias Braun committed
941
942
943
944
945
946
947
948
949
950
951
/**
 * Recursively write nodes.
 * The reader expects nodes in a way that except for block/phi/anchor nodes
 * all predecessors are already defined when we reach them. So usually we
 * recurse to all our predecessors except for block/phi/anchor nodes where
 * we put the predecessors into a queue for later processing.
 */
static void write_node_recursive(ir_node *node, write_env_t *env)
{
	if (irn_visited_else_mark(node))
		return;
952

Matthias Braun's avatar
Matthias Braun committed
953
954
955
956
957
958
959
	if (!is_Block(node)) {
		write_node_recursive(get_nodes_block(node), env);
	}
	/* write predecessors */
	if (!is_Phi(node) && !is_Block(node) && !is_Anchor(node)) {
		write_preds(node, env);
	} else {
960
		foreach_irn_in(node, i, pred) {
Matthias Braun's avatar
Matthias Braun committed
961
962
963
964
965
966
967
968
969
970
971
972
973
			pdeq_putr(env->write_queue, pred);
		}
	}
	write_node(node, env);
}

static void write_mode(write_env_t *env, ir_mode *mode)
{
	if (mode_is_int(mode)) {
		write_symbol(env, "int_mode");
		write_string(env, get_mode_name(mode));
		write_mode_arithmetic(env, get_mode_arithmetic(mode));
		write_unsigned(env, get_mode_size_bits(mode));
974
		write_int(env, mode_is_signed(mode));
Matthias Braun's avatar
Matthias Braun committed
975
976
977
978
979
980
981
982
		write_unsigned(env, get_mode_modulo_shift(mode));
	} else if (mode_is_reference(mode)) {
		write_symbol(env, "reference_mode");
		write_string(env, get_mode_name(mode));
		write_mode_arithmetic(env, get_mode_arithmetic(mode));
		write_unsigned(env, get_mode_size_bits(mode));
		write_unsigned(env, get_mode_modulo_shift(mode));

983
		write_mode_ref(env, get_reference_offset_mode(mode));
Matthias Braun's avatar
Matthias Braun committed
984
985
986
987
988
989
990
		write_int(env, (mode == mode_P ? 1 : 0));
	} else if (mode_is_float(mode)) {
		write_symbol(env, "float_mode");
		write_string(env, get_mode_name(mode));
		write_mode_arithmetic(env, get_mode_arithmetic(mode));
		write_unsigned(env, get_mode_exponent_size(mode));
		write_unsigned(env, get_mode_mantissa_size(mode));
991
		write_unsigned(env, get_mode_float_int_overflow(mode));
Matthias Braun's avatar
Matthias Braun committed
992
	} else {
993
		panic("cannot write internal modes");
994
	}
995
996
}

Matthias Braun's avatar
Matthias Braun committed
997
static void write_modes(write_env_t *env)
998
{
Matthias Braun's avatar
Matthias Braun committed
999
1000
	write_symbol(env, "modes");
	fputs("{\n", env->file);
1001

Matthias Braun's avatar
Matthias Braun committed
1002
	for (size_t i = 0, n_modes = ir_get_n_modes(); i < n_modes; i++) {
Matthias Braun's avatar
Matthias Braun committed
1003
		ir_mode *mode = ir_get_mode(i);
1004
1005
		if (is_internal_mode(mode))
			continue;
Matthias Braun's avatar
Matthias Braun committed
1006
1007
		fputc('\t', env->file);
		write_mode(env, mode);
1008
1009
1010
		fputc('\n', env->file);
	}

Matthias Braun's avatar
Matthias Braun committed
1011
	fputs("}\n\n", env->file);
1012
1013
}

Matthias Braun's avatar
Matthias Braun committed
1014
static void write_program(write_env_t *env)
1015
{
Matthias Braun's avatar
Matthias Braun committed
1016
1017
	write_symbol(env, "program");
	write_scope_begin(env);
1018
	if (irp_prog_name_is_set()) {
Matthias Braun's avatar
Matthias Braun committed