irio.c 57.5 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"
34

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

Matthias Braun's avatar
Matthias Braun committed
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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;
62
	struct obstack obst;
Matthias Braun's avatar
Matthias Braun committed
63
64
65
66
	struct obstack preds_obst;
	delayed_initializer_t *delayed_initializers;
	const delayed_pred_t **delayed_preds;
} read_env_t;
67

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

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

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

Matthias Braun's avatar
Matthias Braun committed
114
typedef struct symbol_t {
115
116
117
118
	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;
119

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

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

128
129
130
131
/**
 * Compare two symbol table entries.
 */
static int symbol_cmp(const void *elt, const void *key, size_t size)
132
{
Matthias Braun's avatar
cleanup    
Matthias Braun committed
133
	(void)size;
134
135
	const symbol_t *entry = (const symbol_t *) elt;
	const symbol_t *keyentry = (const symbol_t *) key;
Matthias Braun's avatar
Matthias Braun committed
136
137
138
	int res = entry->typetag - keyentry->typetag;
	if (res != 0)
		return res;
139
140
141
142
143
	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
144
	(void)size;
145
146
147
148
149
	const id_entry *entry = (const id_entry *) elt;
	const id_entry *keyentry = (const id_entry *) key;
	return entry->id - keyentry->id;
}

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

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

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

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

176
	symtbl = new_set(symbol_cmp, 256);
177

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

#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);
	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
201
	INSERT(tt_segment, "jcr", IR_SEGMENT_JCR);
202

Matthias Braun's avatar
Matthias Braun committed
203
204
205
206
207
208
	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);

209
210
211
	INSERT(tt_loop, "loop",   true);
	INSERT(tt_loop, "noloop", false);

212
213
214
215
	INSERT(tt_visibility, "external",         ir_visibility_external);
	INSERT(tt_visibility, "external_private", ir_visibility_external_private);
	INSERT(tt_visibility, "local",            ir_visibility_local);
	INSERT(tt_visibility, "private",          ir_visibility_private);
216

Matthias Braun's avatar
Matthias Braun committed
217
218
219
	INSERT(tt_throws, "throw",   true);
	INSERT(tt_throws, "nothrow", false);

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

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

Matthias Braun's avatar
Matthias Braun committed
243
244
245
246
247
248
249
250
251
252
253
254
255
	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);
256
	INSERTENUM(tt_builtin_kind, ir_bk_saturating_increment);
257
	INSERTENUM(tt_builtin_kind, ir_bk_compare_swap);
258
259
260
261
262
263
264
265
266
267

	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
268
269
270
271
272
	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);

273
274
275
276
277
278
279
280
281
282
	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);

283
#undef INSERTKEYWORD
284
285
286
287
#undef INSERTENUM
#undef INSERT
}

288
289
290
291
292
293
294
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
295
	case IR_SEGMENT_JCR:          return "jcr";
296
	}
297
	panic("invalid segment");
298
299
}

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

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");
}

322
323
/** 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)
324
{
Matthias Braun's avatar
Matthias Braun committed
325
326
	symbol_t key;
	key.str     = str;
327
	key.typetag = typetag;
328

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

Matthias Braun's avatar
Matthias Braun committed
334
static void write_long(write_env_t *env, long value)
335
{
Matthias Braun's avatar
Matthias Braun committed
336
	fprintf(env->file, "%ld ", value);
337
338
}

Matthias Braun's avatar
Matthias Braun committed
339
static void write_int(write_env_t *env, int value)
340
{
Matthias Braun's avatar
Matthias Braun committed
341
	fprintf(env->file, "%d ", value);
342
343
}

Matthias Braun's avatar
Matthias Braun committed
344
static void write_unsigned(write_env_t *env, unsigned value)
345
{
Matthias Braun's avatar
Matthias Braun committed
346
	fprintf(env->file, "%u ", value);
347
348
}

Matthias Braun's avatar
Matthias Braun committed
349
static void write_size_t(write_env_t *env, size_t value)
350
{
Matthias Braun's avatar
Matthias Braun committed
351
	ir_fprintf(env->file, "%zu ", value);
352
353
}

Matthias Braun's avatar
Matthias Braun committed
354
static void write_symbol(write_env_t *env, const char *symbol)
355
{
Matthias Braun's avatar
Matthias Braun committed
356
357
	fputs(symbol, env->file);
	fputc(' ', env->file);
358
359
}

Matthias Braun's avatar
Matthias Braun committed
360
static void write_entity_ref(write_env_t *env, ir_entity *entity)
361
362
363
364
{
	write_long(env, get_entity_nr(entity));
}

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

Matthias Braun's avatar
Matthias Braun committed
380
static void write_string(write_env_t *env, const char *string)
Matthias Braun's avatar
Matthias Braun committed
381
382
{
	fputc('"', env->file);
Matthias Braun's avatar
Matthias Braun committed
383
	for (const char *c = string; *c != '\0'; ++c) {
Matthias Braun's avatar
Matthias Braun committed
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
		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
399
	fputc(' ', env->file);
Matthias Braun's avatar
Matthias Braun committed
400
401
}

Matthias Braun's avatar
Matthias Braun committed
402
static void write_ident(write_env_t *env, ident *id)
Matthias Braun's avatar
Matthias Braun committed
403
404
405
406
{
	write_string(env, get_id_str(id));
}

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

Matthias Braun's avatar
Matthias Braun committed
416
static void write_mode_ref(write_env_t *env, ir_mode *mode)
417
{
418
	write_string(env, get_mode_name(mode));
419
420
}

421
static void write_tarval_ref(write_env_t *env, ir_tarval *tv)
422
{
423
424
425
426
427
428
	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);
429
430
}

Matthias Braun's avatar
Matthias Braun committed
431
static void write_align(write_env_t *env, ir_align align)
432
433
434
435
436
{
	fputs(get_align_name(align), env->file);
	fputc(' ', env->file);
}

437
static void write_builtin_kind(write_env_t *env, ir_builtin_kind kind)
438
{
439
	fputs(get_builtin_kind_name(kind), env->file);
440
441
442
	fputc(' ', env->file);
}

443
static void write_cond_jmp_predicate(write_env_t *env, cond_jmp_predicate pred)
444
{
445
	fputs(get_cond_jmp_predicate_name(pred), env->file);
446
447
448
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
449
450
451
452
453
454
455
456
457
458
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");
}

459
460
461
462
463
static void write_loop(write_env_t *env, bool loop)
{
	write_symbol(env, loop ? "loop" : "noloop");
}

Matthias Braun's avatar
Matthias Braun committed
464
static void write_list_begin(write_env_t *env)
465
466
467
468
{
	fputs("[", env->file);
}

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

Matthias Braun's avatar
Matthias Braun committed
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
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));
}

489
static void write_initializer(write_env_t *const env, ir_initializer_t const *const ini)
490
491
492
{
	FILE *f = env->file;
	ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
493

494
495
496
	fputs(get_initializer_kind_name(ini_kind), f);
	fputc(' ', f);

497
498
	switch (ini_kind) {
	case IR_INITIALIZER_CONST:
Matthias Braun's avatar
Matthias Braun committed
499
500
		write_node_ref(env, get_initializer_const_value(ini));
		return;
501

502
	case IR_INITIALIZER_TARVAL:
503
		write_tarval_ref(env, get_initializer_tarval_value(ini));
Matthias Braun's avatar
Matthias Braun committed
504
		return;
505

506
	case IR_INITIALIZER_NULL:
Matthias Braun's avatar
Matthias Braun committed
507
		return;
508

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

Matthias Braun's avatar
Matthias Braun committed
520
static void write_pin_state(write_env_t *env, op_pin_state state)
521
{
Matthias Braun's avatar
Matthias Braun committed
522
	fputs(get_op_pin_state_name(state), env->file);
523
524
525
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
526
static void write_volatility(write_env_t *env, ir_volatility vol)
527
528
529
530
531
{
	fputs(get_volatility_name(vol), env->file);
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
532
static void write_type_state(write_env_t *env, ir_type_state state)
533
{
Matthias Braun's avatar
Matthias Braun committed
534
535
536
	fputs(get_type_state_name(state), env->file);
	fputc(' ', env->file);
}
537

Matthias Braun's avatar
Matthias Braun committed
538
539
540
541
542
static void write_visibility(write_env_t *env, ir_visibility visibility)
{
	fputs(get_visibility_name(visibility), env->file);
	fputc(' ', env->file);
}
543

Matthias Braun's avatar
Matthias Braun committed
544
545
546
547
548
static void write_mode_arithmetic(write_env_t *env, ir_mode_arithmetic arithmetic)
{
	fputs(get_mode_arithmetic_name(arithmetic), env->file);
	fputc(' ', env->file);
}
549

Matthias Braun's avatar
Matthias Braun committed
550
551
552
553
554
555
556
557
558
559
560
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));
	write_symbol(env, get_type_tpop_name(tp));
	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);
}
561

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

564
565
566
567
568
569
570
571
572
573
574
575
576
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
577
578
static void write_type_primitive(write_env_t *env, ir_type *tp)
{
579
580
581
582
583
	/* 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
584
	write_type_common(env, tp);
585
	write_mode_ref(env, mode);
Matthias Braun's avatar
Matthias Braun committed
586
	fputc('\n', env->file);
587
588
}

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

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

Matthias Braun's avatar
Matthias Braun committed
608
609
static void write_type_array(write_env_t *env, ir_type *tp)
{
Matthias Braun's avatar
Matthias Braun committed
610
	ir_type *element_type = get_array_element_type(tp);
Matthias Braun's avatar
Matthias Braun committed
611
612
613
	write_type(env, element_type);

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

Matthias Braun's avatar
Matthias Braun committed
625
626
627
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
628
	for (size_t i = 0; i < nparams; i++)
Matthias Braun's avatar
Matthias Braun committed
629
		write_type(env, get_method_param_type(tp, i));
Matthias Braun's avatar
Matthias Braun committed
630
631
	size_t nresults = get_method_n_ress(tp);
	for (size_t i = 0; i < nresults; i++)
Matthias Braun's avatar
Matthias Braun committed
632
633
634
635
636
637
638
		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
639
	for (size_t i = 0; i < nparams; i++)
Matthias Braun's avatar
Matthias Braun committed
640
		write_type_ref(env, get_method_param_type(tp, i));
Matthias Braun's avatar
Matthias Braun committed
641
	for (size_t i = 0; i < nresults; i++)
Matthias Braun's avatar
Matthias Braun committed
642
		write_type_ref(env, get_method_res_type(tp, i));
643
	write_unsigned(env, is_method_variadic(tp));
Matthias Braun's avatar
Matthias Braun committed
644
645
	fputc('\n', env->file);
}
646

Matthias Braun's avatar
Matthias Braun committed
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
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_mode_ref(env, get_type_mode(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);

	switch ((tp_opcode)get_type_tpop_code(tp)) {
	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:
		write_type_compound(env, tp);
		return;

678
679
680
681
	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;
682
	}
683
	panic("can't write invalid type %+F", tp);
684
685
}

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

Matthias Braun's avatar
Matthias Braun committed
693
	if (entity_visited(ent))
694
		return;
Matthias Braun's avatar
Matthias Braun committed
695
	mark_entity_visited(ent);
696

Matthias Braun's avatar
Matthias Braun committed
697
698
	write_type(env, type);
	write_type(env, owner);
699
700
701
702
	if (is_alias_entity(ent)) {
		ir_entity *aliased = get_entity_alias(ent);
		write_entity(env, aliased);
	}
Matthias Braun's avatar
Matthias Braun committed
703
704
705

	fputc('\t', env->file);
	switch ((ir_entity_kind)ent->entity_kind) {
706
	case IR_ENTITY_ALIAS:           write_symbol(env, "alias");           break;
Matthias Braun's avatar
Matthias Braun committed
707
708
709
710
711
	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;
712
713
714
715
	case IR_ENTITY_UNKNOWN:
		write_symbol(env, "unknown");
		write_long(env, get_entity_nr(ent));
		return;
716
	}
Matthias Braun's avatar
Matthias Braun committed
717
	write_long(env, get_entity_nr(ent));
718

Matthias Braun's avatar
Matthias Braun committed
719
	if (ent->entity_kind != IR_ENTITY_LABEL
Matthias Braun's avatar
Matthias Braun committed
720
	 && ent->entity_kind != IR_ENTITY_PARAMETER) {
Matthias Braun's avatar
Matthias Braun committed
721
722
723
724
725
726
		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));
		}
727
	}
Matthias Braun's avatar
Matthias Braun committed
728
729
730

	write_visibility(env, visibility);
	write_list_begin(env);
731
	if (linkage & IR_LINKAGE_CONSTANT)
Matthias Braun's avatar
Matthias Braun committed
732
		write_symbol(env, "constant");
733
	if (linkage & IR_LINKAGE_WEAK)
Matthias Braun's avatar
Matthias Braun committed
734
		write_symbol(env, "weak");
735
	if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
Matthias Braun's avatar
Matthias Braun committed
736
		write_symbol(env, "garbage_collect");
737
	if (linkage & IR_LINKAGE_MERGE)
Matthias Braun's avatar
Matthias Braun committed
738
		write_symbol(env, "merge");
739
	if (linkage & IR_LINKAGE_HIDDEN_USER)
Matthias Braun's avatar
Matthias Braun committed
740
741
742
743
744
745
746
747
748
		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) {
749
750
751
	case IR_ENTITY_ALIAS:
		write_entity_ref(env, get_entity_alias(ent));
		break;
752
753
754
755

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

Matthias Braun's avatar
Matthias Braun committed
764
765
	case IR_ENTITY_COMPOUND_MEMBER:
		write_long(env, get_entity_offset(ent));
766
767
		write_unsigned(env, get_entity_bitfield_offset(ent));
		write_unsigned(env, get_entity_bitfield_size(ent));
Matthias Braun's avatar
Matthias Braun committed
768
769
770
771
772
773
774
775
		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);
		}
776
777
778
		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
779
780
		break;
	}
781
782
783
	case IR_ENTITY_METHOD:
		write_long(env, (long)get_entity_additional_properties(ent));
		break;
784
	case IR_ENTITY_UNKNOWN:
Matthias Braun's avatar
Matthias Braun committed
785
786
	case IR_ENTITY_LABEL:
		break;
787
788
789
	}

	fputc('\n', env->file);
790
791
}

792
793
static void write_switch_table_ref(write_env_t *env,
                                   const ir_switch_table *table)
794
{
Matthias Braun's avatar
Matthias Braun committed
795
796
	size_t n_entries = ir_switch_table_get_n_entries(table);
	write_size_t(env, n_entries);
Matthias Braun's avatar
Matthias Braun committed
797
	for (size_t i = 0; i < n_entries; ++i) {
Matthias Braun's avatar
Matthias Braun committed
798
799
800
801
		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);
802
803
		write_tarval_ref(env, min);
		write_tarval_ref(env, max);
Matthias Braun's avatar
Matthias Braun committed
804
	}
805
806
}

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

Matthias Braun's avatar
Matthias Braun committed
819
820
821
822
823
824
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
825
{
Matthias Braun's avatar
Matthias Braun committed
826
827
828
	write_symbol(env, "ASM");
	write_node_nr(env, node);
	write_node_nr(env, get_nodes_block(node));
829
	write_node_nr(env, get_ASM_mem(node));
Matthias Braun's avatar
Matthias Braun committed
830
831
832

	write_ident(env, get_ASM_text(node));
	write_list_begin(env);
833
834
835
	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
836
837
838
		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
839
		write_mode_ref(env, constraint->mode);
Matthias Braun's avatar
Matthias Braun committed
840
841
842
843
	}
	write_list_end(env);

	write_list_begin(env);
844
845
846
	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
847
848
849
		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
850
		write_mode_ref(env, constraint->mode);
Matthias Braun's avatar
Matthias Braun committed
851
852
853
854
	}
	write_list_end(env);

	write_list_begin(env);
855
856
857
	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
858
859
860
861
		ident *clobber = clobbers[i];
		write_ident(env, clobber);
	}
	write_list_end(env);
Matthias Braun's avatar
Matthias Braun committed
862
863

	write_pin_state(env, get_irn_pinned(node));
Matthias Braun's avatar
Matthias Braun committed
864
	write_pred_refs(env, node, n_ASM_max+1);
Matthias Braun's avatar
Matthias Braun committed
865
866
}

Matthias Braun's avatar
Matthias Braun committed
867
static void write_Phi(write_env_t *env, const ir_node *node)
868
{
Matthias Braun's avatar
Matthias Braun committed
869
870
871
872
	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));
873
	write_loop(env, get_Phi_loop(node));
Matthias Braun's avatar
Matthias Braun committed
874
875
	write_pred_refs(env, node, 0);
}
876

Matthias Braun's avatar
Matthias Braun committed
877
878
879
static void write_Block(write_env_t *env, const ir_node *node)
{
	ir_entity *entity = get_Block_entity(node);
880

Matthias Braun's avatar
Matthias Braun committed
881
882
883
884
885
886
887
	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);
888
	}
Matthias Braun's avatar
Matthias Braun committed
889
890
	write_pred_refs(env, node, 0);
}
891

Matthias Braun's avatar
Matthias Braun committed
892
893
894
895
896
897
898
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);
}

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

901
static void register_node_writer(ir_op *op, write_node_func *func)
Matthias Braun's avatar
Matthias Braun committed
902
{
903
	set_generic_function_ptr(op, func);
Matthias Braun's avatar
Matthias Braun committed
904
905
906
907
}

static void writers_init(void)
{
Matthias Braun's avatar
Matthias Braun committed
908
	ir_clear_opcodes_generic_func();
909
910
911
912
	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
913
914
915
916
917
	register_generated_node_writers();
}

static void write_node(const ir_node *node, write_env_t *env)
{
918
919
	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
920
921
922

	fputc('\t', env->file);
	if (func == NULL)
923
		panic("no write_node_func for %+F", node);
Matthias Braun's avatar
Matthias Braun committed
924
925
926
927
928
929
930
931
	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)
{
932
	foreach_irn_in(node, i, pred) {
Matthias Braun's avatar
Matthias Braun committed
933
		write_node_recursive(pred, env);
934
	}
Matthias Braun's avatar
Matthias Braun committed
935
}
936

Matthias Braun's avatar
Matthias Braun committed
937
938
939
940
941
942
943
944
945
946
947
/**
 * 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;
948

Matthias Braun's avatar
Matthias Braun committed
949
950
951
952
953
954
955
	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 {
956
		foreach_irn_in(node, i, pred) {
Matthias Braun's avatar
Matthias Braun committed
957
958
959
960
961
962
963
964
965
966
967
968
969
			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));
970
		write_int(env, mode_is_signed(mode));
Matthias Braun's avatar
Matthias Braun committed
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
		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));

		write_mode_ref(env, get_reference_mode_unsigned_eq(mode));
		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));
987
		write_unsigned(env, get_mode_float_int_overflow(mode));
Matthias Braun's avatar
Matthias Braun committed
988
	} else {
989
		panic("cannot write internal modes");
990
	}
991
992
}

Matthias Braun's avatar
Matthias Braun committed
993
static void write_modes(write_env_t *env)
994
{
Matthias Braun's avatar
Matthias Braun committed
995
996
	write_symbol(env, "modes");
	fputs("{\n", env->file);
997

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

Matthias Braun's avatar
Matthias Braun committed
1007
	fputs("}\n\n", env->file);
1008
1009
}

Matthias Braun's avatar
Matthias Braun committed
1010
static void write_program(write_env_t *env)
1011
{
Matthias Braun's avatar
Matthias Braun committed
1012
1013
	write_symbol(env, "program");
	write_scope_begin(env);
1014
	if (irp_prog_name_is_set()) {
Matthias Braun's avatar
Matthias Braun committed
1015
1016
		fputc('\t', env->file);
		write_symbol(env, "name");
Matthias Braun's avatar
Matthias Braun committed
1017
		write_string(env, get_irp_name());
Matthias Braun's avatar
Matthias Braun committed
1018
		fputc('\n', env->file);
1019
1020
	}

Matthias Braun's avatar
Matthias Braun committed
1021
	for (ir_segment_t s = IR_SEGMENT_FIRST; s <= IR_SEGMENT_LAST; ++s) {
1022
		ir_type *segment_type = get_segment_type(s);
Matthias Braun's avatar
Matthias Braun committed
1023
1024
1025
		fputc('\t', env->file);
		write_symbol(env, "segment_type");
		write_symbol(env, get_segment_name(s));
1026
		if (segment_type == NULL) {
Matthias Braun's avatar
Matthias Braun committed
1027
			write_symbol(env, "NULL");
1028
		} else {