ir_spec.py 26.7 KB
Newer Older
1
2
3
from spec_util import abstract, setnodedefaults

class Op(object):
4
	"""Base class for firm nodes"""
5
6
7
abstract(Op)

class Unop(Op):
8
	"""Unary nodes have exactly 1 input"""
9
	name     = "unop"
10
11
12
	ins      = [
		("op",  "operand"),
	]
13
14
15
16
17
	op_index = 0
	pinned   = "no"
abstract(Unop)

class Binop(Op):
18
	"""Binary nodes have exactly 2 inputs"""
19
	name     = "binop"
20
21
22
23
	ins      = [
		( "left",   "first operand" ),
		( "right", "second operand" ),
	]
24
25
26
27
28
	op_index = 0
	pinned   = "no"
abstract(Binop)

class Add(Binop):
29
	"""returns the sum of its operands"""
30
	flags = [ "commutative" ]
31
32

class Alloc(Op):
33
34
35
	"""allocates a block of memory.
	It can be specified whether the variable should be allocated to the stack
	or to the heap."""
36
37
38
39
	ins   = [
		("mem",   "memory dependency" ),
		("count", "number of objects to allocate" ),
	]
40
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
41
		("M",         "memory result"),
42
		("res",       "pointer to newly allocated memory"),
Matthias Braun's avatar
Matthias Braun committed
43
44
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
45
	]
46
47
	attrs = [
		dict(
48
49
50
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
51
52
		),
		dict(
53
54
55
			name    = "where",
			type    = "ir_where_alloc",
			comment = "whether to allocate the variable on the stack or heap",
56
		)
57
	]
58
	flags       = [ "fragile", "uses_memory" ]
59
	pinned      = "exception"
60
	throws_init = "false"
61
	pinned_init = "op_pin_state_pinned"
62
63
64
	attr_struct = "alloc_attr"

class Anchor(Op):
65
66
67
68
69
70
	"""utiliy node used to "hold" nodes in a graph that might possibly not be
	reachable by other means or which should be reachable immediately without
	searching through the graph.
	Each firm-graph contains exactly one anchor node whose address is always
	known. All other well-known graph-nodes like Start, End, NoMem, Bad, ...
	are found by looking at the respective Anchor operand."""
71
72
73
74
75
76
77
78
79
	mode             = "mode_ANY"
	arity            = "variable"
	flags            = [ "dump_noblock" ]
	pinned           = "yes"
	attr_struct      = "irg_attr"
	knownBlock       = True
	singleton        = True
	noconstructor    = True
	customSerializer = True
80
81

class And(Binop):
82
	"""returns the result of a bitwise and operation of its operands"""
83
84
85
	flags    = [ "commutative" ]

class ASM(Op):
86
	"""executes assembler fragments of the target machine"""
87
88
89
90
91
92
93
94
	mode             = "mode_T"
	arity            = "variable"
	flags            = [ "keep", "uses_memory" ]
	pinned           = "memory"
	pinned_init      = "op_pin_state_pinned"
	attr_struct      = "asm_attr"
	attrs_name       = "assem"
	customSerializer = True
95
96
	attrs = [
		dict(
97
98
99
			name    = "input_constraints",
			type    = "ir_asm_constraint*",
			comment = "input constraints",
100
101
		),
		dict(
102
			name    = "n_output_constraints",
103
			type    = "size_t",
104
105
			noprop  = True,
			comment = "number of output constraints",
106
107
		),
		dict(
108
109
110
			name    = "output_constraints",
			type    = "ir_asm_constraint*",
			comment = "output constraints",
111
112
		),
		dict(
113
			name    = "n_clobbers",
114
			type    = "size_t",
115
116
			noprop  = True,
			comment = "number of clobbered registers/memory",
117
118
		),
		dict(
119
120
121
			name    = "clobbers",
			type    = "ident**",
			comment = "list of clobbered registers/memory",
122
123
		),
		dict(
124
125
126
			name    = "text",
			type    = "ident*",
			comment = "assembler text",
127
128
129
130
131
		),
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
132
133

class Bad(Op):
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
	"""Bad nodes indicate invalid input, which is values which should never be
	computed.

	The typical use case for the Bad node is removing unreachable code.
	Frontends should set the current_block to Bad when it is clear that
	following code must be unreachable (ie. after a goto or return statement).
	Optimisations also set block predecessors to Bad when it becomes clear,
	that a control flow edge can never be executed.

	The gigo optimisations ensures that nodes with Bad as their block, get
	replaced by Bad themselfes. Nodes with at least 1 Bad input get exchanged
	with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
	This is because removing inputs from a Block is hairy operation (requiring,
	Phis to be shortened too for example). So instead of removing block inputs
	they are set to Bad, and the actual removal is left to the control flow
	optimisation phase. Block, Phi, Tuple with only Bad inputs however are
	replaced by Bad right away."""
Matthias Braun's avatar
Matthias Braun committed
151
	flags         = [ "start_block", "dump_noblock" ]
152
153
	pinned        = "yes"
	knownBlock    = True
154
	block         = "get_irg_start_block(irg)"
155
	attr_struct   = "bad_attr"
156
	init = '''
157
	res->attr.bad.irg.irg = irg;
158
159
	'''

160
class Deleted(Op):
161
162
	"""Internal node which is temporary set to nodes which are already removed
	from the graph."""
163
164
165
166
	mode             = "mode_Bad"
	flags            = [ ]
	pinned           = "yes"
	noconstructor    = True
Matthias Braun's avatar
Matthias Braun committed
167
	customSerializer = True # this has no serializer
168

169
class Block(Op):
170
	"""A basic block"""
171
172
173
174
175
176
177
	mode             = "mode_BB"
	knownBlock       = True
	block            = "NULL"
	pinned           = "yes"
	arity            = "variable"
	flags            = [ "labeled" ]
	attr_struct      = "block_attr"
178
179
180
181
182
183
184
185
	attrs            = [
		dict(
			name    = "entity",
			type    = "ir_entity*",
			comment = "entity representing this block",
			init    = "NULL",
		),
	]
186
	customSerializer = True
Moritz Kroll's avatar
Moritz Kroll committed
187
188

	init = '''
189
	res->attr.block.irg.irg     = irg;
Moritz Kroll's avatar
Moritz Kroll committed
190
191
	res->attr.block.backedge    = new_backedge_arr(irg->obst, arity);
	set_Block_matured(res, 1);
192
193

	/* Create and initialize array for Phi-node construction. */
194
195
196
	if (get_irg_phase_state(irg) == phase_building) {
		res->attr.block.graph_arr = NEW_ARR_D(ir_node *, irg->obst, irg->n_loc);
		memset(res->attr.block.graph_arr, 0, irg->n_loc * sizeof(ir_node*));
197
	}
198
	'''
199

200
class Borrow(Binop):
201
	"""Returns the borrow bit from and implied subtractions of its 2 operands"""
202
203
	flags = []

204
class Bound(Op):
205
206
	"""Performs a bounds-check: if lower <= index < upper then return index,
	otherwise throw an exception."""
207
208
209
210
211
212
	ins    = [
		("mem",    "memory dependency"),
		("index",  "value to test"),
		("lower",  "lower bound (inclusive)"),
		("upper",  "upper bound (exclusive)"),
	]
213
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
214
		("M",         "memory result"),
215
		("res",       "the checked index"),
Matthias Braun's avatar
Matthias Braun committed
216
217
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
218
	]
219
220
221
 	flags  = [ "fragile", "highlevel" ]
	pinned = "exception"
	pinned_init = "op_pin_state_pinned"
222
	throws_init = "false"
223
224
225
	attr_struct = "bound_attr"

class Builtin(Op):
226
	"""performs a backend-specific builtin."""
227
228
229
	ins      = [
		("mem", "memory dependency"),
	]
230
	arity    = "variable"
231
	outs     = [
232
233
		("M", "memory result"),
		# results follow here
234
	]
235
	flags    = [ "uses_memory" ]
236
	attrs    = [
237
		dict(
238
239
240
			type    = "ir_builtin_kind",
			name    = "kind",
			comment = "kind of builtin",
241
		),
242
		dict(
243
244
245
			type    = "ir_type*",
			name    = "type",
			comment = "method type for the builtin call",
246
		)
247
248
249
250
	]
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
	attr_struct = "builtin_attr"
251
	init   = '''
252
253
254
	assert((get_unknown_type() == type) || is_Method_type(type));
	'''

255
class Call(Op):
256
257
258
259
	"""Calls other code. Control flow is transfered to ptr, additional
	operands are passed to the called code. Called code usually performs a
	return operation. The operands of this return operation are the result
	of the Call node."""
260
261
262
263
	ins      = [
		("mem",   "memory dependency"),
		("ptr",   "pointer to called code"),
	]
264
	arity    = "variable"
265
	outs     = [
Matthias Braun's avatar
Matthias Braun committed
266
		("M",                "memory result"),
267
		("T_result",         "tuple containing all results"),
Matthias Braun's avatar
Matthias Braun committed
268
269
		("X_regular",        "control flow when no exception occurs"),
		("X_except",         "control flow when exception occured"),
270
	]
271
	flags    = [ "fragile", "uses_memory" ]
272
	attrs    = [
273
		dict(
274
275
276
			type    = "ir_type*",
			name    = "type",
			comment = "type of the call (usually type of the called procedure)",
277
		),
278
279
280
281
	]
	attr_struct = "call_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
282
	throws_init = "false"
283
284
	init = '''
	assert((get_unknown_type() == type) || is_Method_type(type));
285
	'''
286

287
class Carry(Binop):
288
289
	"""Computes the value of the carry-bit that would result when adding the 2
	operands"""
290
291
	flags = [ "commutative" ]

Michael Beck's avatar
Michael Beck committed
292
class Cast(Unop):
293
	"""perform a high-level type cast"""
294
295
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
296
297
	attrs    = [
		dict(
298
299
300
			type    = "ir_type*",
			name    = "type",
			comment = "target type of the case",
301
		)
302
303
	]
	attr_struct = "cast_attr"
304
	init     = "assert(is_atomic_type(type));"
305
306

class Cmp(Binop):
307
	"""Compares its two operands and checks whether a specified
308
	   relation (like less or equal) is fulfilled."""
309
	flags = []
310
311
312
313
314
315
316
317
318
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
319
320

class Cond(Op):
321
	"""Conditionally change control flow."""
322
323
324
	ins      = [
		("selector",  "condition parameter"),
	]
325
326
327
328
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
329
330
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
331
332
	attrs    = [
		dict(
333
334
335
336
			name    = "jmp_pred",
			type    = "cond_jmp_predicate",
			init    = "COND_JMP_PRED_NONE",
			comment = "can indicate the most likely jump",
Matthias Braun's avatar
Matthias Braun committed
337
		),
338
	]
339
	attr_struct = "cond_attr"
340

Matthias Braun's avatar
Matthias Braun committed
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
class Switch(Op):
	"""Change control flow. The destination is choosen based on an integer input value which is looked up in a table.

	Backends can implement this efficiently using a jump table."""
	ins    = [
		("selector", "input selector"),
	]
	outs   = [
		("default", "control flow if no other case matches"),
	]
	flags  = [ "cfopcode", "forking" ]
	pinned = "yes"
	attrs  = [
		dict(
			name    = "n_outs",
			type    = "unsigned",
			comment = "number of outputs (including pn_Switch_default)",
		),
		dict(
			name    = "table",
			type    = "ir_switch_table*",
			comment = "table describing mapping from input values to Proj numbers",
		),
	]
	attr_struct = "switch_attr"
	attrs_name  = "switcha"

368
class Confirm(Op):
369
370
371
372
373
374
375
376
377
	"""Specifies constraints for a value. This allows explicit representation
	of path-sensitive properties. (Example: This value is always >= 0 on 1
	if-branch then all users within that branch are rerouted to a confirm-node
	specifying this property).

	A constraint is specified for the relation between value and bound.
	value is always returned.
	Note that this node does NOT check or assert the constraint, it merely
	specifies it."""
378
379
380
381
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
382
383
384
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
385
386
	attrs    = [
		dict(
387
388
389
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
390
		),
391
392
393
394
	]
	attr_struct = "confirm_attr"

class Const(Op):
395
	"""Returns a constant value."""
396
	flags      = [ "constlike", "start_block" ]
397
398
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
399
400
	knownBlock = True
	pinned     = "no"
401
402
	attrs      = [
		dict(
403
404
405
			type    = "ir_tarval*",
			name    = "tarval",
			comment = "constant value (a tarval object)",
406
		)
407
408
	]
	attr_struct = "const_attr"
409
	attrs_name  = "con"
410

411
class Conv(Unop):
412
	"""Converts values between modes"""
413
	flags = []
414
415
	attrs = [
		dict(
416
417
418
419
			name    = "strict",
			type    = "int",
			init    = "0",
			comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
420
		)
421
422
423
424
	]
	attr_struct = "conv_attr"

class CopyB(Op):
425
	"""Copies a block of memory"""
426
427
428
429
430
	ins   = [
		("mem",  "memory dependency"),
		("dst",  "destination address"),
		("src",  "source address"),
	]
431
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
432
433
434
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
435
	]
436
	flags = [ "fragile", "uses_memory" ]
437
438
	attrs = [
		dict(
439
440
441
			name    = "type",
			type    = "ir_type*",
			comment = "type of copied data",
442
		)
443
444
445
446
	]
	attr_struct = "copyb_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
447
	throws_init = "false"
448

449
class Div(Op):
450
	"""returns the quotient of its 2 operands"""
451
452
453
454
455
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
456
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
457
		("M",         "memory result"),
458
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
459
460
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
461
	]
462
	flags = [ "fragile", "uses_memory" ]
463
464
	attrs = [
		dict(
465
466
467
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result value",
468
		),
Moritz Kroll's avatar
Moritz Kroll committed
469
470
471
472
		dict(
			name = "no_remainder",
			type = "int",
			init = "0",
473
		)
474
	]
475
	attr_struct = "div_attr"
476
	pinned      = "exception"
477
	throws_init = "false"
478
479
	op_index    = 1
	arity_override = "oparity_binary"
480

481
class Dummy(Op):
482
483
484
	"""A placeholder value. This is used when constructing cyclic graphs where
	you have cases where not all predecessors of a phi-node are known. Dummy
	nodes are used for the unknown predecessors and replaced later."""
485
486
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
487
488
489
490
491
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

class End(Op):
492
493
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
494
495
496
497
498
499
500
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
	flags            = [ "cfopcode" ]
	knownBlock       = True
	block            = "get_irg_end_block(irg)"
	singleton        = True
501
502

class Eor(Binop):
503
	"""returns the result of a bitwise exclusive or operation of its operands"""
504
	flags    = [ "commutative" ]
505

506
class Free(Op):
507
	"""Frees a block of memory previously allocated by an Alloc node"""
508
509
510
	ins    = [
		("mem",   "memory dependency" ),
		("ptr",   "pointer to the object to free"),
511
		("count", "number of objects to allocate" ),
512
	]
513
514
515
	mode   = "mode_M"
	flags  = [ "uses_memory" ]
	pinned = "yes"
516
	attrs  = [
517
		dict(
518
519
520
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
521
522
		),
		dict(
523
524
525
			name    = "where",
			type    = "ir_where_alloc",
			comment = "whether allocation was on the stack or heap",
526
		)
527
528
529
530
	]
	attr_struct = "free_attr"

class Id(Op):
531
	"""Returns its operand unchanged."""
532
533
534
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
535
536
537
538
	pinned = "no"
	flags  = []

class IJmp(Op):
539
540
541
	"""Jumps to the code in its argument. The code has to be in the same
	function and the the destination must be one of the blocks reachable
	by the tuple results"""
542
543
	mode     = "mode_X"
	pinned   = "yes"
544
545
546
	ins      = [
	   ("target", "target address of the jump"),
	]
547
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
548
549

class InstOf(Op):
550
	"""Tests whether an object is an instance of a class-type"""
551
552
553
554
	ins   = [
	   ("store", "memory dependency"),
	   ("obj",   "pointer to object being queried")
	]
555
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
556
		("M",         "memory result"),
557
		("res",       "checked object pointer"),
Matthias Braun's avatar
Matthias Braun committed
558
559
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
560
	]
561
	flags = [ "highlevel" ]
562
563
	attrs = [
		dict(
564
565
566
			name    = "type",
			type    = "ir_type*",
			comment = "type to check ptr for",
567
		)
568
569
570
571
572
573
	]
	attr_struct = "io_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_floats"

class Jmp(Op):
574
	"""Jumps to the block connected through the out-value"""
575
576
577
578
579
580
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

class Load(Op):
581
	"""Loads a value from memory (heap or stack)."""
582
583
584
585
	ins   = [
		("mem", "memory dependency"),
		("ptr",  "address to load from"),
	]
586
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
587
		("M",         "memory result"),
588
		("res",       "result of load operation"),
Matthias Braun's avatar
Matthias Braun committed
589
590
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
591
	]
592
593
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
594
595
	attrs    = [
		dict(
596
597
598
			type      = "ir_mode*",
			name      = "mode",
			comment   = "mode of the value to be loaded",
599
		),
600
601
602
603
604
		dict(
			type      = "ir_volatility",
			name      = "volatility",
			comment   = "volatile loads are a visible side-effect and may not be optimized",
			init      = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
Matthias Braun's avatar
Matthias Braun committed
605
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : 0"
606
607
608
609
610
611
		),
		dict(
			type      = "ir_align",
			name      = "unaligned",
			comment   = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
			init      = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
Matthias Braun's avatar
Matthias Braun committed
612
			to_flags  = "%s == align_non_aligned ? cons_unaligned : 0"
613
		),
614
615
	]
	attr_struct = "load_attr"
616
617
	constructor_args = [
		dict(
618
619
620
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
621
		),
622
	]
623
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
624
	throws_init = "(flags & cons_throws_exception) != 0"
625
626

class Minus(Unop):
627
	"""returns the difference between its operands"""
628
629
630
	flags = []

class Mod(Op):
631
632
633
	"""returns the remainder of its operands from an implied division.

	Examples:
634

635
636
637
638
639
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
640
641
642
643
644
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
645
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
646
		("M",         "memory result"),
647
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
648
649
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
650
	]
651
	flags = [ "fragile", "uses_memory" ]
652
	attrs = [
653
		dict(
654
655
656
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
657
		),
658
	]
659
	attr_struct = "mod_attr"
660
	pinned      = "exception"
661
	throws_init = "false"
662
663
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
664

665
class Mul(Binop):
666
	"""returns the product of its operands"""
667
668
669
	flags = [ "commutative" ]

class Mulh(Binop):
670
671
	"""returns the upper word of the product of its operands (the part which
	would not fit into the result mode of a normal Mul anymore)"""
672
673
674
	flags = [ "commutative" ]

class Mux(Op):
675
676
	"""returns the false or true operand depending on the value of the sel
	operand"""
677
678
679
680
681
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
682
683
684
685
	flags  = []
	pinned = "no"

class NoMem(Op):
686
	"""Placeholder node for cases where you don't need any memory input"""
687
688
689
690
	mode          = "mode_M"
	flags         = [ "dump_noblock", "dump_noinput" ]
	pinned        = "yes"
	knownBlock    = True
691
	block         = "get_irg_start_block(irg)"
692
	singleton     = True
693
694

class Not(Unop):
695
696
697
	"""returns the logical complement of a value. Works for integer values too.
	If the input is false/zero then true/one is returned, otherwise false/zero
	is returned."""
698
699
700
	flags = []

class Or(Binop):
701
	"""returns the result of a bitwise or operation of its operands"""
702
703
704
	flags = [ "commutative" ]

class Phi(Op):
705
706
707
	"""Choose a value based on control flow. A phi node has 1 input for each
	predecessor of its block. If a block is entered from its nth predecessor
	all phi nodes produce their nth input as result."""
708
709
710
711
	pinned        = "yes"
	arity         = "variable"
	flags         = []
	attr_struct   = "phi_attr"
712
713
714
	init          = '''
	res->attr.phi.u.backedge = new_backedge_arr(irg->obst, arity);'''
	init_after_opt = '''
Matthias Braun's avatar
Matthias Braun committed
715
716
	/* Memory Phis in endless loops must be kept alive.
	   As we can't distinguish these easily we keep all of them alive. */
717
718
	if (is_Phi(res) && mode == mode_M)
		add_End_keepalive(get_irg_end(irg), res);'''
Matthias Braun's avatar
Matthias Braun committed
719
	customSerializer = True
720
721

class Pin(Op):
722
723
724
	"""Pin the value of the node node in the current block. No users of the Pin
	node can float above the Block of the Pin. The node cannot float behind
	this block. Often used to Pin the NoMem node."""
725
726
727
	ins      = [
		("op", "value which is pinned"),
	]
728
729
730
731
732
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

class Proj(Op):
733
	"""returns an entry of a tuple value"""
734
735
736
	ins              = [
		("pred", "the tuple value from which a part is extracted"),
	]
737
738
739
740
741
742
	flags            = []
	pinned           = "no"
	knownBlock       = True
	knownGraph       = True
	block            = "get_nodes_block(irn_pred)"
	graph            = "get_irn_irg(irn_pred)"
743
	attrs      = [
744
		dict(
745
746
747
			type    = "long",
			name    = "proj",
			comment = "number of tuple component to be extracted",
748
		),
749
	]
750
	attr_struct = "proj_attr"
751
752

class Raise(Op):
753
754
755
	"""Raises an exception. Unconditional change of control flow. Writes an
	explicit Except variable to memory to pass it to the exception handler.
	Must be lowered to a Call to a runtime check function."""
756
757
758
759
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
760
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
761
762
		("M", "memory result"),
		("X", "control flow to exception handler"),
763
	]
764
765
766
767
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

class Return(Op):
768
769
	"""Returns from the current function. Takes memory and return values as
	operands."""
770
771
772
	ins      = [
		("mem", "memory dependency"),
	]
773
774
775
776
777
778
	arity    = "variable"
	mode     = "mode_X"
	flags    = [ "cfopcode" ]
	pinned   = "yes"

class Rotl(Binop):
779
780
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
781
782
783
	flags    = []

class Sel(Op):
784
	"""Computes the address of a entity of a compound type given the base
785
786
787
788
	address of an instance of the compound type.

	Optimisations assume that a Sel node can only produce a NULL pointer if the
	ptr input was NULL."""
789
790
791
792
	ins    = [
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
793
794
795
796
	arity  = "variable"
	flags  = []
	mode   = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned = "no"
797
	attrs  = [
798
		dict(
799
800
801
			type    = "ir_entity*",
			name    = "entity",
			comment = "entity which is selected",
802
		)
803
804
805
806
	]
	attr_struct = "sel_attr"

class Shl(Binop):
807
808
	"""Returns its first operands bits shifted left by the amount of the 2nd
	operand"""
809
810
811
	flags = []

class Shr(Binop):
812
813
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. No special handling for the sign bit (zero extension)"""
814
815
816
	flags = []

class Shrs(Binop):
817
818
819
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
	(sign extension)"""
820
821
822
	flags = []

class Start(Op):
823
	"""The first node of a graph. Execution starts with this node."""
824
825
826
827
828
829
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
830
831
832
833
834
835
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	block            = "get_irg_start_block(irg)"
836
837

class Store(Op):
838
	"""Stores a value into memory (heap or stack)."""
839
840
841
842
843
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
844
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
845
846
847
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
848
	]
849
850
851
852
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
853
	throws_init = "(flags & cons_throws_exception) != 0"
854
855
856
857
858
859
	attrs = [
		dict(
			type      = "ir_volatility",
			name      = "volatility",
			comment   = "volatile stores are a visible side-effect and may not be optimized",
			init      = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
Matthias Braun's avatar
Matthias Braun committed
860
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : 0"
861
862
863
864
865
866
		),
		dict(
			type      = "ir_align",
			name      = "unaligned",
			comment   = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
			init      = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
Matthias Braun's avatar
Matthias Braun committed
867
			to_flags  = "%s == align_non_aligned ? cons_unaligned : 0"
868
869
		),
	]
870
	constructor_args = [
871
		dict(
872
873
874
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
875
		),
876
877
878
	]

class Sub(Binop):
879
	"""returns the difference of its operands"""
880
881
882
	flags = []

class SymConst(Op):
883
884
	"""A symbolic constant.

885
886
887
888
889
890
891
892
893
894
895
896
897
	 - *symconst_type_size* The symbolic constant represents the size of a type.
	                        The type of which the constant represents the size
	                        is given explicitly.
	 - *symconst_type_align* The symbolic constant represents the alignment of a
	                        type.  The type of which the constant represents the
	                        size is given explicitly.
	 - *symconst_addr_ent*  The symbolic constant represents the address of an
	                        entity (variable or method).  The variable is given
	                        explicitly by a firm entity.
	 - *symconst_ofs_ent*   The symbolic constant represents the offset of an
	                        entity in its owner type.
	 - *symconst_enum_const* The symbolic constant is a enumeration constant of
	                        an enumeration type."""
898
899
900
901
	mode       = "mode_P"
	flags      = [ "constlike", "start_block" ]
	knownBlock = True
	pinned     = "no"
902
	attrs      = [
903
		dict(
904
905
906
907
			type    = "ir_entity*",
			name    = "entity",
			noprop  = True,
			comment = "entity whose address is returned",
908
		)
909
910
	]
	attr_struct = "symconst_attr"
911
	customSerializer = True
912
913
914
	# constructor is written manually at the moment, because of the strange
	# union argument
	noconstructor = True
915
916

class Sync(Op):
917
918
919
920
921
	"""The Sync operation unifies several partial memory blocks. These blocks
	have to be pairwise disjunct or the values in common locations have to
	be identical.  This operation allows to specify all operations that
	eventually need several partial memory blocks as input with a single
	entrance by unifying the memories with a preceding Sync operation."""
922
923
924
	mode     = "mode_M"
	flags    = []
	pinned   = "no"
925
	arity    = "dynamic"
926

927
class Tuple(Op):
928
929
930
931
932
933
934
	"""Builds a Tuple from single values.

	This is needed to implement optimizations that remove a node that produced
	a tuple.  The node can be replaced by the Tuple operation so that the
	following Proj nodes have not to be changed. (They are hard to find due to
	the implementation with pointers in only one direction.) The Tuple node is
	smaller than any other node, so that a node can be changed into a Tuple by
935
	just changing its opcode and giving it a new in array."""
936
937
938
939
940
941
	arity  = "variable"
	mode   = "mode_T"
	pinned = "no"
	flags  = [ "labeled" ]

class Unknown(Op):
942
943
	"""Returns an unknown (at compile- and runtime) value. It is a valid
	optimisation to replace an Unknown by any other constant value."""
944
945
946
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"
Matthias Braun's avatar
Matthias Braun committed
947
	flags      = [ "start_block", "constlike", "dump_noblock" ]
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963

# Prepare node list

def getOpList(namespace):
	nodes = []
	for t in namespace.values():
		if type(t) != type:
			continue

		if issubclass(t, Op):
			setnodedefaults(t)
			nodes.append(t)
	return nodes

nodes = getOpList(globals())
nodes = sorted(nodes, lambda x,y: cmp(x.name, y.name))