ir_spec.py 28.3 KB
Newer Older
Matthias Braun's avatar
Matthias Braun committed
1
2
3
# Firm node specifications
# The comments are in (standard python) restructured text format and are used
# to generate documentation.
Matthias Braun's avatar
Matthias Braun committed
4
from spec_util import abstract, op
5

Matthias Braun's avatar
Matthias Braun committed
6
name = "ir"
7

Matthias Braun's avatar
Matthias Braun committed
8
9
10
@abstract
@op
class Unop(object):
11
	"""Unary nodes have exactly 1 input"""
12
	name     = "unop"
13
14
15
	ins      = [
		("op",  "operand"),
	]
16
17
18
	op_index = 0
	pinned   = "no"

Matthias Braun's avatar
Matthias Braun committed
19
20
21
@abstract
@op
class Binop(object):
22
	"""Binary nodes have exactly 2 inputs"""
23
	name     = "binop"
24
25
26
27
	ins      = [
		( "left",   "first operand" ),
		( "right", "second operand" ),
	]
28
29
30
	op_index = 0
	pinned   = "no"

Matthias Braun's avatar
Matthias Braun committed
31
@op
32
class Add(Binop):
33
	"""returns the sum of its operands"""
34
	flags = [ "commutative" ]
35

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

Matthias Braun's avatar
Matthias Braun committed
71
72
@op
class Anchor:
73
74
75
76
77
78
	"""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."""
79
80
81
82
83
84
85
86
87
	mode             = "mode_ANY"
	arity            = "variable"
	flags            = [ "dump_noblock" ]
	pinned           = "yes"
	attr_struct      = "irg_attr"
	knownBlock       = True
	singleton        = True
	noconstructor    = True
	customSerializer = True
88

Matthias Braun's avatar
Matthias Braun committed
89
@op
90
class And(Binop):
91
	"""returns the result of a bitwise and operation of its operands"""
92
93
	flags    = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
94
95
@op
class ASM:
Matthias Braun's avatar
Matthias Braun committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
	"""executes assembler fragments of the target machine.

	The node contains a template for an assembler snippet. The compiler will
	replace occurences of %0 to %9 with input/output registers,
	%% with a single % char. Some backends allow additional specifiers (for
	example %w3, %l3, %h3 on x86 to get a 16bit, 8hit low, 8bit high part
	of a register).
	After the replacements the text is emitted into the final assembly.

	The clobber list contains names of registers which have an undefined value
	after the assembler instruction is executed; it may also contain 'memory'
	or 'cc' if global state/memory changes or the condition code registers
	(some backends implicitely set cc, memory clobbers on all ASM statements).

	Example (an i386 instruction)::

		ASM(text="btsl %1, %0",
			input_constraints = ["=m", "r"],
			clobbers = ["cc"])

	As there are no output, the %0 references the first input which is just an
	address which the asm operation writes to. %1 references to an input which
	is passed as a register. The condition code register has an unknown value
	after the instruction.

	(This format is inspired by the gcc extended asm syntax)
	"""
123
124
	mode             = "mode_T"
	arity            = "variable"
125
	input_name       = "input"
126
127
128
129
130
131
	flags            = [ "keep", "uses_memory" ]
	pinned           = "memory"
	pinned_init      = "op_pin_state_pinned"
	attr_struct      = "asm_attr"
	attrs_name       = "assem"
	customSerializer = True
132
133
134
	ins   = [
		("mem",    "memory dependency"),
	]
135
136
	attrs = [
		dict(
137
138
139
			name    = "input_constraints",
			type    = "ir_asm_constraint*",
			comment = "input constraints",
140
141
		),
		dict(
142
			name    = "n_output_constraints",
143
			type    = "size_t",
144
145
			noprop  = True,
			comment = "number of output constraints",
146
147
		),
		dict(
148
149
150
			name    = "output_constraints",
			type    = "ir_asm_constraint*",
			comment = "output constraints",
151
152
		),
		dict(
153
			name    = "n_clobbers",
154
			type    = "size_t",
155
156
			noprop  = True,
			comment = "number of clobbered registers/memory",
157
158
		),
		dict(
159
160
161
			name    = "clobbers",
			type    = "ident**",
			comment = "list of clobbered registers/memory",
162
163
		),
		dict(
164
165
166
			name    = "text",
			type    = "ident*",
			comment = "assembler text",
167
168
169
170
171
		),
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
172

Matthias Braun's avatar
Matthias Braun committed
173
174
@op
class Bad:
175
176
177
178
179
180
181
182
183
184
	"""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
Christoph Mallon's avatar
Christoph Mallon committed
185
	replaced by Bad themselves. Nodes with at least 1 Bad input get exchanged
186
187
188
189
190
191
	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
192
	flags         = [ "start_block", "dump_noblock" ]
193
194
	pinned        = "yes"
	knownBlock    = True
195
	block         = "get_irg_start_block(irg)"
196
	attr_struct   = "bad_attr"
197
	init = '''
198
	res->attr.bad.irg.irg = irg;
199
200
	'''

Matthias Braun's avatar
Matthias Braun committed
201
202
@op
class Deleted:
203
204
	"""Internal node which is temporary set to nodes which are already removed
	from the graph."""
205
206
207
208
	mode             = "mode_Bad"
	flags            = [ ]
	pinned           = "yes"
	noconstructor    = True
Matthias Braun's avatar
Matthias Braun committed
209
	customSerializer = True # this has no serializer
210

Matthias Braun's avatar
Matthias Braun committed
211
212
@op
class Block:
213
	"""A basic block"""
214
215
216
217
218
	mode             = "mode_BB"
	knownBlock       = True
	block            = "NULL"
	pinned           = "yes"
	arity            = "variable"
219
	input_name       = "cfgpred"
220
	flags            = []
221
	attr_struct      = "block_attr"
222
223
224
225
226
227
228
229
	attrs            = [
		dict(
			name    = "entity",
			type    = "ir_entity*",
			comment = "entity representing this block",
			init    = "NULL",
		),
	]
230
	customSerializer = True
Moritz Kroll's avatar
Moritz Kroll committed
231
232

	init = '''
233
	res->attr.block.irg.irg     = irg;
234
	res->attr.block.backedge    = new_backedge_arr(get_irg_obstack(irg), arity);
Moritz Kroll's avatar
Moritz Kroll committed
235
	set_Block_matured(res, 1);
236
237

	/* Create and initialize array for Phi-node construction. */
238
	if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION)) {
239
		res->attr.block.graph_arr = NEW_ARR_DZ(ir_node*, get_irg_obstack(irg), irg->n_loc);
240
	}
241
	'''
242

Matthias Braun's avatar
Matthias Braun committed
243
@op
244
class Borrow(Binop):
245
	"""Returns the borrow bit from and implied subtractions of its 2 operands"""
246
247
	flags = []

Matthias Braun's avatar
Matthias Braun committed
248
249
@op
class Bound:
250
251
	"""Performs a bounds-check: if lower <= index < upper then return index,
	otherwise throw an exception."""
252
253
254
255
256
257
	ins    = [
		("mem",    "memory dependency"),
		("index",  "value to test"),
		("lower",  "lower bound (inclusive)"),
		("upper",  "upper bound (exclusive)"),
	]
258
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
259
		("M",         "memory result"),
260
		("res",       "the checked index"),
Matthias Braun's avatar
Matthias Braun committed
261
262
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
263
	]
264
265
266
 	flags  = [ "fragile", "highlevel" ]
	pinned = "exception"
	pinned_init = "op_pin_state_pinned"
267
	throws_init = "false"
268
269
	attr_struct = "bound_attr"

Matthias Braun's avatar
Matthias Braun committed
270
271
@op
class Builtin:
272
	"""performs a backend-specific builtin."""
273
	ins         = [
274
275
		("mem", "memory dependency"),
	]
276
277
278
	arity       = "variable"
	input_name  = "param"
	outs        = [
279
280
		("M", "memory result"),
		# results follow here
281
	]
282
283
	flags       = [ "uses_memory" ]
	attrs       = [
284
		dict(
285
286
287
			type    = "ir_builtin_kind",
			name    = "kind",
			comment = "kind of builtin",
288
		),
289
		dict(
290
291
292
			type    = "ir_type*",
			name    = "type",
			comment = "method type for the builtin call",
293
		)
294
295
296
297
	]
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
	attr_struct = "builtin_attr"
298
	init        = '''
299
300
301
	assert((get_unknown_type() == type) || is_Method_type(type));
	'''

Matthias Braun's avatar
Matthias Braun committed
302
303
@op
class Call:
304
305
306
307
	"""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."""
308
	ins         = [
309
310
311
		("mem",   "memory dependency"),
		("ptr",   "pointer to called code"),
	]
312
313
314
	arity       = "variable"
	input_name  = "param"
	outs        = [
Matthias Braun's avatar
Matthias Braun committed
315
		("M",                "memory result"),
316
		("T_result",         "tuple containing all results"),
Matthias Braun's avatar
Matthias Braun committed
317
318
		("X_regular",        "control flow when no exception occurs"),
		("X_except",         "control flow when exception occured"),
319
	]
320
321
	flags       = [ "fragile", "uses_memory" ]
	attrs       = [
322
		dict(
323
324
325
			type    = "ir_type*",
			name    = "type",
			comment = "type of the call (usually type of the called procedure)",
326
		),
327
328
329
330
	]
	attr_struct = "call_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
331
	throws_init = "false"
332
333
	init = '''
	assert((get_unknown_type() == type) || is_Method_type(type));
334
	'''
335

Matthias Braun's avatar
Matthias Braun committed
336
@op
337
class Carry(Binop):
338
339
	"""Computes the value of the carry-bit that would result when adding the 2
	operands"""
340
341
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
342
@op
Michael Beck's avatar
Michael Beck committed
343
class Cast(Unop):
344
	"""perform a high-level type cast"""
345
346
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
347
348
	attrs    = [
		dict(
349
350
351
			type    = "ir_type*",
			name    = "type",
			comment = "target type of the case",
352
		)
353
354
	]
	attr_struct = "cast_attr"
355
	init     = "assert(is_atomic_type(type));"
356

Matthias Braun's avatar
Matthias Braun committed
357
@op
358
class Cmp(Binop):
359
	"""Compares its two operands and checks whether a specified
360
	   relation (like less or equal) is fulfilled."""
361
	flags = []
362
363
364
365
366
367
368
369
370
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
371

Matthias Braun's avatar
Matthias Braun committed
372
373
@op
class Cond:
374
	"""Conditionally change control flow."""
375
376
377
	ins      = [
		("selector",  "condition parameter"),
	]
378
379
380
381
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
382
383
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
384
385
	attrs    = [
		dict(
386
387
388
389
			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
390
		),
391
	]
392
	attr_struct = "cond_attr"
393

Matthias Braun's avatar
Matthias Braun committed
394
395
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
	"""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"

Matthias Braun's avatar
Matthias Braun committed
422
423
@op
class Confirm:
424
425
426
427
428
429
430
431
432
	"""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."""
433
434
435
436
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
437
438
439
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
440
441
	attrs    = [
		dict(
442
443
444
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
445
		),
446
447
448
	]
	attr_struct = "confirm_attr"

Matthias Braun's avatar
Matthias Braun committed
449
450
@op
class Const:
451
	"""Returns a constant value."""
452
	flags      = [ "constlike", "start_block" ]
453
454
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
455
456
	knownBlock = True
	pinned     = "no"
457
458
	attrs      = [
		dict(
459
460
461
			type    = "ir_tarval*",
			name    = "tarval",
			comment = "constant value (a tarval object)",
462
		)
463
464
	]
	attr_struct = "const_attr"
465
	attrs_name  = "con"
466

Matthias Braun's avatar
Matthias Braun committed
467
@op
468
class Conv(Unop):
469
	"""Converts values between modes"""
470
471
	flags = []

Matthias Braun's avatar
Matthias Braun committed
472
473
@op
class CopyB:
Matthias Braun's avatar
Matthias Braun committed
474
	"""Copies a block of memory with statically known size/type."""
475
476
477
478
479
	ins   = [
		("mem",  "memory dependency"),
		("dst",  "destination address"),
		("src",  "source address"),
	]
480
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
481
482
483
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
484
	]
485
	flags = [ "fragile", "uses_memory" ]
486
487
	attrs = [
		dict(
488
489
490
			name    = "type",
			type    = "ir_type*",
			comment = "type of copied data",
491
		)
492
493
494
495
	]
	attr_struct = "copyb_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
496
	throws_init = "false"
497

Matthias Braun's avatar
Matthias Braun committed
498
499
@op
class Div:
500
	"""returns the quotient of its 2 operands"""
501
502
503
504
505
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
506
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
507
		("M",         "memory result"),
508
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
509
510
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
511
	]
512
	flags = [ "fragile", "uses_memory" ]
513
514
	attrs = [
		dict(
515
516
517
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result value",
518
		),
Moritz Kroll's avatar
Moritz Kroll committed
519
520
521
522
		dict(
			name = "no_remainder",
			type = "int",
			init = "0",
523
		)
524
	]
525
	attr_struct = "div_attr"
526
	pinned      = "exception"
527
	throws_init = "false"
528
529
	op_index    = 1
	arity_override = "oparity_binary"
530

Matthias Braun's avatar
Matthias Braun committed
531
532
@op
class Dummy:
533
534
535
	"""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."""
536
537
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
538
539
540
541
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

Matthias Braun's avatar
Matthias Braun committed
542
543
@op
class End:
544
545
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
546
547
548
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
549
	input_name       = "keepalive"
550
551
552
553
	flags            = [ "cfopcode" ]
	knownBlock       = True
	block            = "get_irg_end_block(irg)"
	singleton        = True
554

Matthias Braun's avatar
Matthias Braun committed
555
@op
556
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
557
558
559
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
560
	flags    = [ "commutative" ]
561

Matthias Braun's avatar
Matthias Braun committed
562
563
@op
class Free:
564
	"""Frees a block of memory previously allocated by an Alloc node"""
565
566
567
	ins    = [
		("mem",   "memory dependency" ),
		("ptr",   "pointer to the object to free"),
568
		("count", "number of objects to allocate" ),
569
	]
570
571
572
	mode   = "mode_M"
	flags  = [ "uses_memory" ]
	pinned = "yes"
573
	attrs  = [
574
		dict(
575
576
577
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
578
579
		),
		dict(
580
581
582
			name    = "where",
			type    = "ir_where_alloc",
			comment = "whether allocation was on the stack or heap",
583
		)
584
585
586
	]
	attr_struct = "free_attr"

Matthias Braun's avatar
Matthias Braun committed
587
588
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
589
590
591
592
	"""Returns its operand unchanged.

	This is mainly used when exchanging nodes. Usually you shouldn't see Id
	nodes since the getters/setters for node inputs skip them automatically."""
593
594
595
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
596
597
598
	pinned = "no"
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
599
600
@op
class IJmp:
601
602
603
	"""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"""
604
605
	mode     = "mode_X"
	pinned   = "yes"
606
607
608
	ins      = [
	   ("target", "target address of the jump"),
	]
609
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
610

Matthias Braun's avatar
Matthias Braun committed
611
612
@op
class InstOf:
613
	"""Tests whether an object is an instance of a class-type"""
614
615
616
617
	ins   = [
	   ("store", "memory dependency"),
	   ("obj",   "pointer to object being queried")
	]
618
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
619
		("M",         "memory result"),
620
		("res",       "checked object pointer"),
Matthias Braun's avatar
Matthias Braun committed
621
622
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
623
	]
624
	flags = [ "highlevel" ]
625
626
	attrs = [
		dict(
627
628
629
			name    = "type",
			type    = "ir_type*",
			comment = "type to check ptr for",
630
		)
631
632
633
634
635
	]
	attr_struct = "io_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_floats"

Matthias Braun's avatar
Matthias Braun committed
636
637
@op
class Jmp:
638
	"""Jumps to the block connected through the out-value"""
639
640
641
642
643
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

Matthias Braun's avatar
Matthias Braun committed
644
645
@op
class Load:
646
	"""Loads a value from memory (heap or stack)."""
647
648
649
650
	ins   = [
		("mem", "memory dependency"),
		("ptr",  "address to load from"),
	]
651
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
652
		("M",         "memory result"),
653
		("res",       "result of load operation"),
Matthias Braun's avatar
Matthias Braun committed
654
655
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
656
	]
657
658
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
659
660
	attrs    = [
		dict(
661
662
663
			type      = "ir_mode*",
			name      = "mode",
			comment   = "mode of the value to be loaded",
664
		),
665
666
667
668
669
		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",
670
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : cons_none"
671
672
673
674
675
676
		),
		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",
677
			to_flags  = "%s == align_non_aligned ? cons_unaligned : cons_none"
678
		),
679
680
	]
	attr_struct = "load_attr"
681
682
	constructor_args = [
		dict(
683
684
685
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
686
		),
687
	]
688
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
689
	throws_init = "(flags & cons_throws_exception) != 0"
690

Matthias Braun's avatar
Matthias Braun committed
691
@op
692
class Minus(Unop):
Andreas Seltenreich's avatar
Andreas Seltenreich committed
693
	"""returns the additive inverse of its operand"""
694
695
	flags = []

Matthias Braun's avatar
Matthias Braun committed
696
697
@op
class Mod:
698
699
700
	"""returns the remainder of its operands from an implied division.

	Examples:
701

702
703
704
705
706
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
707
708
709
710
711
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
712
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
713
		("M",         "memory result"),
714
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
715
716
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
717
	]
718
	flags = [ "fragile", "uses_memory" ]
719
	attrs = [
720
		dict(
721
722
723
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
724
		),
725
	]
726
	attr_struct = "mod_attr"
727
	pinned      = "exception"
728
	throws_init = "false"
729
730
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
731

732
class Mul(Binop):
733
	"""returns the product of its operands"""
734
735
736
	flags = [ "commutative" ]

class Mulh(Binop):
737
738
	"""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)"""
739
740
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
741
742
@op
class Mux:
743
744
	"""returns the false or true operand depending on the value of the sel
	operand"""
745
746
747
748
749
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
750
751
752
	flags  = []
	pinned = "no"

Matthias Braun's avatar
Matthias Braun committed
753
754
@op
class NoMem:
755
	"""Placeholder node for cases where you don't need any memory input"""
756
	mode          = "mode_M"
757
	flags         = [ "dump_noblock" ]
758
759
	pinned        = "yes"
	knownBlock    = True
760
	block         = "get_irg_start_block(irg)"
761
	singleton     = True
762

Matthias Braun's avatar
Matthias Braun committed
763
@op
764
class Not(Unop):
765
	"""returns the bitwise complement of a value. Works for boolean values, too."""
766
767
	flags = []

Matthias Braun's avatar
Matthias Braun committed
768
@op
769
class Or(Binop):
770
	"""returns the result of a bitwise or operation of its operands"""
771
772
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
773
774
@op
class Phi:
775
776
777
	"""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."""
778
779
	pinned        = "yes"
	arity         = "variable"
780
	input_name    = "pred"
781
782
	flags         = []
	attr_struct   = "phi_attr"
783
	init          = '''
784
	res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
Matthias Braun's avatar
Matthias Braun committed
785
	customSerializer = True
786

Matthias Braun's avatar
Matthias Braun committed
787
788
@op
class Pin:
789
790
791
	"""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."""
792
793
794
	ins      = [
		("op", "value which is pinned"),
	]
795
796
797
798
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

Matthias Braun's avatar
Matthias Braun committed
799
800
@op
class Proj:
801
	"""returns an entry of a tuple value"""
802
803
804
	ins              = [
		("pred", "the tuple value from which a part is extracted"),
	]
805
806
807
808
809
810
	flags            = []
	pinned           = "no"
	knownBlock       = True
	knownGraph       = True
	block            = "get_nodes_block(irn_pred)"
	graph            = "get_irn_irg(irn_pred)"
811
	attrs      = [
812
		dict(
813
814
815
			type    = "long",
			name    = "proj",
			comment = "number of tuple component to be extracted",
816
		),
817
	]
818
	attr_struct = "proj_attr"
819

Matthias Braun's avatar
Matthias Braun committed
820
821
@op
class Raise:
822
823
824
	"""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."""
825
826
827
828
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
829
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
830
831
		("M", "memory result"),
		("X", "control flow to exception handler"),
832
	]
833
834
835
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
836
837
@op
class Return:
838
839
	"""Returns from the current function. Takes memory and return values as
	operands."""
840
	ins        = [
841
842
		("mem", "memory dependency"),
	]
843
844
845
846
847
	arity      = "variable"
	input_name = "res"
	mode       = "mode_X"
	flags      = [ "cfopcode" ]
	pinned     = "yes"
848
849

class Rotl(Binop):
850
851
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
852
853
	flags    = []

Matthias Braun's avatar
Matthias Braun committed
854
855
@op
class Sel:
856
	"""Computes the address of a entity of a compound type given the base
857
858
859
860
	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."""
861
	ins         = [
862
863
864
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
865
866
867
868
869
870
	arity       = "variable"
	input_name  = "index"
	flags       = []
	mode        = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned      = "no"
	attrs       = [
871
		dict(
872
873
874
			type    = "ir_entity*",
			name    = "entity",
			comment = "entity which is selected",
875
		)
876
877
878
	]
	attr_struct = "sel_attr"

Matthias Braun's avatar
Matthias Braun committed
879
@op
880
class Shl(Binop):
881
	"""Returns its first operands bits shifted left by the amount of the 2nd
882
883
884
885
	operand.
	The right input (shift amount) must be an unsigned integer value.
	If the result mode has modulo_shift!=0, then the effective shift amount is
	the right input modulo this modulo_shift amount."""
886
887
	flags = []

Matthias Braun's avatar
Matthias Braun committed
888
@op
889
class Shr(Binop):
890
	"""Returns its first operands bits shifted right by the amount of the 2nd
891
892
893
894
	operand. No special handling for the sign bit is performed (zero extension).
	The right input (shift amount) must be an unsigned integer value.
	If the result mode has modulo_shift!=0, then the effective shift amount is
	the right input modulo this modulo_shift amount."""
895
896
	flags = []

Matthias Braun's avatar
Matthias Braun committed
897
@op
898
class Shrs(Binop):
899
900
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
901
902
903
904
	(sign extension).
	The right input (shift amount) must be an unsigned integer value.
	If the result mode has modulo_shift!=0, then the effective shift amount is
	the right input modulo this modulo_shift amount."""
905
906
	flags = []

Matthias Braun's avatar
Matthias Braun committed
907
908
@op
class Start:
909
	"""The first node of a graph. Execution starts with this node."""
910
911
912
913
914
915
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
916
917
918
919
920
921
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	block            = "get_irg_start_block(irg)"
922

Matthias Braun's avatar
Matthias Braun committed
923
924
@op
class Store:
925
	"""Stores a value into memory (heap or stack)."""
926
927
928
929
930
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
931
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
932
933
934
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
935
	]
936
937
938
939
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
940
	throws_init = "(flags & cons_throws_exception) != 0"
941
942
943
944
945
946
	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",
947
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : cons_none"
948
949
950
951
952
953
		),
		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",
954
			to_flags  = "%s == align_non_aligned ? cons_unaligned : cons_none"
955
956
		),
	]
957
	constructor_args = [
958
		dict(
959
960
961
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
962