irio.c 58.3 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
20
#include "irprog.h"
#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
28
#include "array.h"
#include "error.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_mode_arithmetic,
82
	tt_pin_state,
Matthias Braun's avatar
Matthias Braun committed
83
84
	tt_segment,
	tt_throws,
85
	tt_tpo,
86
	tt_type_state,
Matthias Braun's avatar
Matthias Braun committed
87
	tt_visibility,
88
	tt_volatility,
89
90
} typetag_t;

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

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

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

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

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

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

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

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

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

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

175
	symtbl = new_set(symbol_cmp, 256);
176

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

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

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

208
209
	INSERT(tt_visibility, "local", ir_visibility_local);
	INSERT(tt_visibility, "external", ir_visibility_external);
210
	INSERT(tt_visibility, "private", ir_visibility_private);
211

Matthias Braun's avatar
Matthias Braun committed
212
213
214
	INSERT(tt_throws, "throw",   true);
	INSERT(tt_throws, "nothrow", false);

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

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

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

	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
264
265
266
267
268
	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);

269
270
271
272
273
274
275
276
277
278
	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);

279
#undef INSERTKEYWORD
280
281
282
283
#undef INSERTENUM
#undef INSERT
}

284
285
286
287
288
289
290
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
291
	case IR_SEGMENT_JCR:          return "jcr";
292
	}
Matthias Braun's avatar
Matthias Braun committed
293
	panic("INVALID_SEGMENT");
294
295
}

296
297
298
299
300
301
302
static const char *get_visibility_name(ir_visibility visibility)
{
	switch (visibility) {
	case ir_visibility_local:    return "local";
	case ir_visibility_external: return "external";
	case ir_visibility_private:  return "private";
	}
Matthias Braun's avatar
Matthias Braun committed
303
304
305
306
307
308
309
310
311
312
313
314
315
316
	panic("INVALID_VISIBILITY");
}

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

317
318
/** 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)
319
{
Matthias Braun's avatar
Matthias Braun committed
320
321
	symbol_t key;
	key.str     = str;
322
	key.typetag = typetag;
323

Matthias Braun's avatar
Matthias Braun committed
324
325
	symbol_t *entry = set_find(symbol_t, symtbl, &key, sizeof(key),
	                           hash_str(str) + typetag * 17);
326
	return entry ? entry->code : SYMERROR;
327
328
}

Matthias Braun's avatar
Matthias Braun committed
329
static void write_long(write_env_t *env, long value)
330
{
Matthias Braun's avatar
Matthias Braun committed
331
	fprintf(env->file, "%ld ", value);
332
333
}

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

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

Matthias Braun's avatar
Matthias Braun committed
344
static void write_size_t(write_env_t *env, size_t value)
345
{
Matthias Braun's avatar
Matthias Braun committed
346
	ir_fprintf(env->file, "%zu ", value);
347
348
}

Matthias Braun's avatar
Matthias Braun committed
349
static void write_symbol(write_env_t *env, const char *symbol)
350
{
Matthias Braun's avatar
Matthias Braun committed
351
352
	fputs(symbol, env->file);
	fputc(' ', env->file);
353
354
}

Matthias Braun's avatar
Matthias Braun committed
355
static void write_entity_ref(write_env_t *env, ir_entity *entity)
356
357
358
359
{
	write_long(env, get_entity_nr(entity));
}

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

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

Matthias Braun's avatar
Matthias Braun committed
397
static void write_ident(write_env_t *env, ident *id)
Matthias Braun's avatar
Matthias Braun committed
398
399
400
401
{
	write_string(env, get_id_str(id));
}

Matthias Braun's avatar
Matthias Braun committed
402
static void write_ident_null(write_env_t *env, ident *id)
Matthias Braun's avatar
Matthias Braun committed
403
404
405
406
407
408
409
410
{
	if (id == NULL) {
		fputs("NULL ", env->file);
	} else {
		write_ident(env, id);
	}
}

Matthias Braun's avatar
Matthias Braun committed
411
static void write_mode_ref(write_env_t *env, ir_mode *mode)
412
{
413
	write_string(env, get_mode_name(mode));
414
415
}

416
static void write_tarval_ref(write_env_t *env, ir_tarval *tv)
417
{
418
419
420
421
422
423
	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);
424
425
}

Matthias Braun's avatar
Matthias Braun committed
426
static void write_align(write_env_t *env, ir_align align)
427
428
429
430
431
{
	fputs(get_align_name(align), env->file);
	fputc(' ', env->file);
}

432
static void write_builtin_kind(write_env_t *env, ir_builtin_kind kind)
433
{
434
	fputs(get_builtin_kind_name(kind), env->file);
435
436
437
	fputc(' ', env->file);
}

438
static void write_cond_jmp_predicate(write_env_t *env, cond_jmp_predicate pred)
439
{
440
	fputs(get_cond_jmp_predicate_name(pred), env->file);
441
442
443
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
444
445
446
447
448
449
450
451
452
453
454
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");
}

static void write_list_begin(write_env_t *env)
455
456
457
458
{
	fputs("[", env->file);
}

Matthias Braun's avatar
Matthias Braun committed
459
static void write_list_end(write_env_t *env)
460
461
462
463
{
	fputs("] ", env->file);
}

Matthias Braun's avatar
Matthias Braun committed
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
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));
}

static void write_initializer(write_env_t *env, ir_initializer_t *ini)
480
481
482
{
	FILE *f = env->file;
	ir_initializer_kind_t ini_kind = get_initializer_kind(ini);
483

484
485
486
	fputs(get_initializer_kind_name(ini_kind), f);
	fputc(' ', f);

487
488
	switch (ini_kind) {
	case IR_INITIALIZER_CONST:
Matthias Braun's avatar
Matthias Braun committed
489
490
		write_node_ref(env, get_initializer_const_value(ini));
		return;
491

492
	case IR_INITIALIZER_TARVAL:
493
		write_tarval_ref(env, get_initializer_tarval_value(ini));
Matthias Braun's avatar
Matthias Braun committed
494
		return;
495

496
	case IR_INITIALIZER_NULL:
Matthias Braun's avatar
Matthias Braun committed
497
		return;
498

499
	case IR_INITIALIZER_COMPOUND: {
Matthias Braun's avatar
Matthias Braun committed
500
		size_t n = get_initializer_compound_n_entries(ini);
Matthias Braun's avatar
Matthias Braun committed
501
		write_size_t(env, n);
Matthias Braun's avatar
Matthias Braun committed
502
		for (size_t i = 0; i < n; ++i)
503
			write_initializer(env, get_initializer_compound_value(ini, i));
Matthias Braun's avatar
Matthias Braun committed
504
		return;
505
	}
506
	}
Matthias Braun's avatar
Matthias Braun committed
507
	panic("Unknown initializer kind");
508
509
}

Matthias Braun's avatar
Matthias Braun committed
510
static void write_pin_state(write_env_t *env, op_pin_state state)
511
{
Matthias Braun's avatar
Matthias Braun committed
512
	fputs(get_op_pin_state_name(state), env->file);
513
514
515
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
516
static void write_volatility(write_env_t *env, ir_volatility vol)
517
518
519
520
521
{
	fputs(get_volatility_name(vol), env->file);
	fputc(' ', env->file);
}

Matthias Braun's avatar
Matthias Braun committed
522
static void write_type_state(write_env_t *env, ir_type_state state)
523
{
Matthias Braun's avatar
Matthias Braun committed
524
525
526
	fputs(get_type_state_name(state), env->file);
	fputc(' ', env->file);
}
527

Matthias Braun's avatar
Matthias Braun committed
528
529
530
531
532
static void write_visibility(write_env_t *env, ir_visibility visibility)
{
	fputs(get_visibility_name(visibility), env->file);
	fputc(' ', env->file);
}
533

Matthias Braun's avatar
Matthias Braun committed
534
535
536
537
538
static void write_mode_arithmetic(write_env_t *env, ir_mode_arithmetic arithmetic)
{
	fputs(get_mode_arithmetic_name(arithmetic), env->file);
	fputc(' ', env->file);
}
539

Matthias Braun's avatar
Matthias Braun committed
540
541
542
543
544
545
546
547
548
549
550
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);
}
551

yb9976's avatar
yb9976 committed
552
553
static void write_type(write_env_t *env, ir_type *tp);

554
555
556
557
558
559
560
561
562
563
564
565
566
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
567
568
static void write_type_primitive(write_env_t *env, ir_type *tp)
{
569
570
571
572
573
	/* 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
574
	write_type_common(env, tp);
575
	write_mode_ref(env, mode);
Matthias Braun's avatar
Matthias Braun committed
576
	fputc('\n', env->file);
577
578
}

Matthias Braun's avatar
Matthias Braun committed
579
static void write_type_compound(write_env_t *env, ir_type *tp)
580
{
Matthias Braun's avatar
Matthias Braun committed
581
	if (is_Class_type(tp)) {
582
		if (get_class_n_subtypes(tp) > 0 || get_class_n_supertypes(tp) > 0) {
yb9976's avatar
yb9976 committed
583
			/* sub/superclass export not implemented yet, it's unclear whether
Matthias Braun's avatar
Matthias Braun committed
584
585
586
			 * class types will stay in libfirm anyway */
			panic("can't export class types yet");
		}
587
	}
Matthias Braun's avatar
Matthias Braun committed
588
589
590
	write_type_common(env, tp);
	write_ident_null(env, get_compound_ident(tp));
	fputc('\n', env->file);
591

Matthias Braun's avatar
Matthias Braun committed
592
	for (size_t i = 0, n = get_compound_n_members(tp); i < n; ++i) {
Matthias Braun's avatar
Matthias Braun committed
593
		ir_entity *member = get_compound_member(tp, i);
594
		pdeq_putr(env->entity_queue, member);
595
	}
Matthias Braun's avatar
Matthias Braun committed
596
}
597

Matthias Braun's avatar
Matthias Braun committed
598
599
static void write_type_array(write_env_t *env, ir_type *tp)
{
Matthias Braun's avatar
Matthias Braun committed
600
	ir_type *element_type = get_array_element_type(tp);
Matthias Braun's avatar
Matthias Braun committed
601
602
603
	write_type(env, element_type);

	write_type_common(env, tp);
Matthias Braun's avatar
Matthias Braun committed
604
	write_type_ref(env, element_type);
605
606
607
608
609
610
611
	ir_node *size = get_array_size(tp);
	if (is_Const(size))
		write_long(env, get_tarval_long(get_Const_tarval(size)));
	else if (is_Unknown(size))
		write_symbol(env, "unknown");
	else
		panic("Upper array bound is not constant");
Matthias Braun's avatar
Matthias Braun committed
612
613
	/* note that we just write a reference to the element entity
	 * but never the entity itself */
Matthias Braun's avatar
Matthias Braun committed
614
	ir_entity *element_entity = get_array_element_entity(tp);
Matthias Braun's avatar
Matthias Braun committed
615
616
617
	write_entity_ref(env, element_entity);
	fputc('\n', env->file);
}
618

Matthias Braun's avatar
Matthias Braun committed
619
620
621
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
622
	for (size_t i = 0; i < nparams; i++)
Matthias Braun's avatar
Matthias Braun committed
623
		write_type(env, get_method_param_type(tp, i));
Matthias Braun's avatar
Matthias Braun committed
624
625
	size_t nresults = get_method_n_ress(tp);
	for (size_t i = 0; i < nresults; i++)
Matthias Braun's avatar
Matthias Braun committed
626
627
628
629
630
631
632
		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
633
	for (size_t i = 0; i < nparams; i++)
Matthias Braun's avatar
Matthias Braun committed
634
		write_type_ref(env, get_method_param_type(tp, i));
Matthias Braun's avatar
Matthias Braun committed
635
	for (size_t i = 0; i < nresults; i++)
Matthias Braun's avatar
Matthias Braun committed
636
637
638
639
		write_type_ref(env, get_method_res_type(tp, i));
	write_unsigned(env, get_method_variadicity(tp));
	fputc('\n', env->file);
}
640

Matthias Braun's avatar
Matthias Braun committed
641
642
643
644
645
646
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
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;

672
673
674
675
	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;
676
	}
Matthias Braun's avatar
Matthias Braun committed
677
	panic("can't write invalid type %+F\n", tp);
678
679
}

Matthias Braun's avatar
Matthias Braun committed
680
static void write_entity(write_env_t *env, ir_entity *ent)
681
{
Matthias Braun's avatar
Matthias Braun committed
682
	ir_type       *type       = get_entity_type(ent);
683
684
685
	ir_type       *owner      = get_entity_owner(ent);
	ir_visibility  visibility = get_entity_visibility(ent);
	ir_linkage     linkage    = get_entity_linkage(ent);
686

Matthias Braun's avatar
Matthias Braun committed
687
	if (entity_visited(ent))
688
		return;
Matthias Braun's avatar
Matthias Braun committed
689
	mark_entity_visited(ent);
690

Matthias Braun's avatar
Matthias Braun committed
691
692
	write_type(env, type);
	write_type(env, owner);
693
694
695
696
	if (is_alias_entity(ent)) {
		ir_entity *aliased = get_entity_alias(ent);
		write_entity(env, aliased);
	}
Matthias Braun's avatar
Matthias Braun committed
697
698
699

	fputc('\t', env->file);
	switch ((ir_entity_kind)ent->entity_kind) {
700
	case IR_ENTITY_ALIAS:           write_symbol(env, "alias");           break;
Matthias Braun's avatar
Matthias Braun committed
701
	case IR_ENTITY_GOTENTRY:        write_symbol(env, "gotentry");        break;
Matthias Braun's avatar
Matthias Braun committed
702
703
704
705
706
	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;
707
708
709
710
	case IR_ENTITY_UNKNOWN:
		write_symbol(env, "unknown");
		write_long(env, get_entity_nr(ent));
		return;
711
	}
Matthias Braun's avatar
Matthias Braun committed
712
	write_long(env, get_entity_nr(ent));
713

Matthias Braun's avatar
Matthias Braun committed
714
	if (ent->entity_kind != IR_ENTITY_LABEL
Matthias Braun's avatar
Matthias Braun committed
715
	 && ent->entity_kind != IR_ENTITY_PARAMETER) {
Matthias Braun's avatar
Matthias Braun committed
716
717
718
719
720
721
		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));
		}
722
	}
Matthias Braun's avatar
Matthias Braun committed
723
724
725

	write_visibility(env, visibility);
	write_list_begin(env);
726
	if (linkage & IR_LINKAGE_CONSTANT)
Matthias Braun's avatar
Matthias Braun committed
727
		write_symbol(env, "constant");
728
	if (linkage & IR_LINKAGE_WEAK)
Matthias Braun's avatar
Matthias Braun committed
729
		write_symbol(env, "weak");
730
	if (linkage & IR_LINKAGE_GARBAGE_COLLECT)
Matthias Braun's avatar
Matthias Braun committed
731
		write_symbol(env, "garbage_collect");
732
	if (linkage & IR_LINKAGE_MERGE)
Matthias Braun's avatar
Matthias Braun committed
733
		write_symbol(env, "merge");
734
	if (linkage & IR_LINKAGE_HIDDEN_USER)
Matthias Braun's avatar
Matthias Braun committed
735
736
737
738
739
740
741
742
743
744
		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_long(env, is_entity_compiler_generated(ent));
	write_volatility(env, get_entity_volatility(ent));

	switch ((ir_entity_kind)ent->entity_kind) {
745
746
747
	case IR_ENTITY_ALIAS:
		write_entity_ref(env, get_entity_alias(ent));
		break;
Matthias Braun's avatar
Matthias Braun committed
748
749
750
	case IR_ENTITY_GOTENTRY:
		write_entity_ref(env, ent->attr.got.referenced);
		break;
Matthias Braun's avatar
Matthias Braun committed
751
752
753
754
755
756
	case IR_ENTITY_NORMAL:
		if (ent->initializer != NULL) {
			write_symbol(env, "initializer");
			write_initializer(env, get_entity_initializer(ent));
		} else {
			write_symbol(env, "none");
757
		}
Matthias Braun's avatar
Matthias Braun committed
758
759
760
		break;
	case IR_ENTITY_COMPOUND_MEMBER:
		write_long(env, get_entity_offset(ent));
761
762
		write_unsigned(env, get_entity_bitfield_offset(ent));
		write_unsigned(env, get_entity_bitfield_size(ent));
Matthias Braun's avatar
Matthias Braun committed
763
764
765
766
767
768
769
770
		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);
		}
771
772
773
		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
774
775
		break;
	}
776
777
778
	case IR_ENTITY_METHOD:
		write_long(env, (long)get_entity_additional_properties(ent));
		break;
779
	case IR_ENTITY_UNKNOWN:
Matthias Braun's avatar
Matthias Braun committed
780
781
	case IR_ENTITY_LABEL:
		break;
782
783
784
	}

	fputc('\n', env->file);
785
786
}

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

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

Matthias Braun's avatar
Matthias Braun committed
814
815
816
817
818
819
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
820
{
Matthias Braun's avatar
Matthias Braun committed
821
822
823
	write_symbol(env, "ASM");
	write_node_nr(env, node);
	write_node_nr(env, get_nodes_block(node));
824
	write_node_nr(env, get_ASM_mem(node));
Matthias Braun's avatar
Matthias Braun committed
825
826
827

	write_ident(env, get_ASM_text(node));
	write_list_begin(env);
828
829
830
	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
831
832
833
		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
834
		write_mode_ref(env, constraint->mode);
Matthias Braun's avatar
Matthias Braun committed
835
836
837
838
	}
	write_list_end(env);

	write_list_begin(env);
839
840
841
	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
842
843
844
		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
845
		write_mode_ref(env, constraint->mode);
Matthias Braun's avatar
Matthias Braun committed
846
847
848
849
	}
	write_list_end(env);

	write_list_begin(env);
850
851
852
	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
853
854
855
856
		ident *clobber = clobbers[i];
		write_ident(env, clobber);
	}
	write_list_end(env);
Matthias Braun's avatar
Matthias Braun committed
857
858

	write_pin_state(env, get_irn_pinned(node));
Matthias Braun's avatar
Matthias Braun committed
859
	write_pred_refs(env, node, n_ASM_max+1);
Matthias Braun's avatar
Matthias Braun committed
860
861
}

Matthias Braun's avatar
Matthias Braun committed
862
static void write_Phi(write_env_t *env, const ir_node *node)
863
{
Matthias Braun's avatar
Matthias Braun committed
864
865
866
867
868
869
	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));
	write_pred_refs(env, node, 0);
}
870

Matthias Braun's avatar
Matthias Braun committed
871
872
873
static void write_Block(write_env_t *env, const ir_node *node)
{
	ir_entity *entity = get_Block_entity(node);
874

Matthias Braun's avatar
Matthias Braun committed
875
876
877
878
879
880
881
	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);
882
	}
Matthias Braun's avatar
Matthias Braun committed
883
884
	write_pred_refs(env, node, 0);
}
885

Matthias Braun's avatar
Matthias Braun committed
886
887
888
889
890
891
892
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);
}

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

895
static void register_node_writer(ir_op *op, write_node_func *func)
Matthias Braun's avatar
Matthias Braun committed
896
{
897
	set_generic_function_ptr(op, func);
Matthias Braun's avatar
Matthias Braun committed
898
899
900
901
}

static void writers_init(void)
{
Matthias Braun's avatar
Matthias Braun committed
902
	ir_clear_opcodes_generic_func();
903
904
905
906
	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
907
908
909
910
911
	register_generated_node_writers();
}

static void write_node(const ir_node *node, write_env_t *env)
{
912
913
	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
914
915
916
917
918
919
920
921
922
923
924
925

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

Matthias Braun's avatar
Matthias Braun committed
931
932
933
934
935
936
937
938
939
940
941
/**
 * 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;
942

Matthias Braun's avatar
Matthias Braun committed
943
944
945
946
947
948
949
	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 {
950
		foreach_irn_in(node, i, pred) {
Matthias Braun's avatar
Matthias Braun committed
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
			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));
		write_int(env, get_mode_sign(mode));
		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_signed_eq(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));
982
		write_unsigned(env, get_mode_float_int_overflow(mode));
Matthias Braun's avatar
Matthias Braun committed
983
984
	} else {
		panic("Can't write internal modes");
985
	}
986
987
}

Matthias Braun's avatar
Matthias Braun committed
988
static void write_modes(write_env_t *env)
989
{
Matthias Braun's avatar
Matthias Braun committed
990
991
	write_symbol(env, "modes");
	fputs("{\n", env->file);
992

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

Matthias Braun's avatar
Matthias Braun committed
1002
	fputs("}\n\n", env->file);
1003
1004
}

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

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