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

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

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

Matthias Braun's avatar
Matthias Braun committed
331
@op
Michael Beck's avatar
Michael Beck committed
332
class Cast(Unop):
333
	"""perform a high-level type cast"""
334
335
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
336
337
	attrs    = [
		dict(
338
339
340
			type    = "ir_type*",
			name    = "type",
			comment = "target type of the case",
341
		)
342
343
	]
	attr_struct = "cast_attr"
344
	init     = "assert(is_atomic_type(type));"
345

Matthias Braun's avatar
Matthias Braun committed
346
@op
347
class Cmp(Binop):
348
	"""Compares its two operands and checks whether a specified
349
	   relation (like less or equal) is fulfilled."""
350
	flags = []
351
352
353
354
355
356
357
358
359
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
360

Matthias Braun's avatar
Matthias Braun committed
361
362
@op
class Cond:
363
	"""Conditionally change control flow."""
364
365
366
	ins      = [
		("selector",  "condition parameter"),
	]
367
368
369
370
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
371
372
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
373
374
	attrs    = [
		dict(
375
376
377
378
			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
379
		),
380
	]
381
	attr_struct = "cond_attr"
382

Matthias Braun's avatar
Matthias Braun committed
383
384
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
	"""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
411
412
@op
class Confirm:
413
414
415
416
417
418
419
420
421
	"""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."""
422
423
424
425
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
426
427
428
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
429
430
	attrs    = [
		dict(
431
432
433
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
434
		),
435
436
437
	]
	attr_struct = "confirm_attr"

Matthias Braun's avatar
Matthias Braun committed
438
439
@op
class Const:
440
	"""Returns a constant value."""
441
	flags      = [ "constlike", "start_block" ]
442
443
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
444
445
	knownBlock = True
	pinned     = "no"
446
447
	attrs      = [
		dict(
448
449
450
			type    = "ir_tarval*",
			name    = "tarval",
			comment = "constant value (a tarval object)",
451
		)
452
453
	]
	attr_struct = "const_attr"
454
	attrs_name  = "con"
455

Matthias Braun's avatar
Matthias Braun committed
456
@op
457
class Conv(Unop):
458
	"""Converts values between modes"""
459
460
	flags = []

Matthias Braun's avatar
Matthias Braun committed
461
462
@op
class CopyB:
Matthias Braun's avatar
Matthias Braun committed
463
	"""Copies a block of memory with statically known size/type."""
464
465
466
467
468
	ins   = [
		("mem",  "memory dependency"),
		("dst",  "destination address"),
		("src",  "source address"),
	]
469
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
470
471
472
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
473
	]
474
	flags = [ "fragile", "uses_memory" ]
475
476
	attrs = [
		dict(
477
478
479
			name    = "type",
			type    = "ir_type*",
			comment = "type of copied data",
480
		)
481
482
483
484
	]
	attr_struct = "copyb_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
485
	throws_init = "false"
486

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

Matthias Braun's avatar
Matthias Braun committed
520
521
@op
class Dummy:
522
523
524
	"""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."""
525
526
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
527
528
529
530
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

Matthias Braun's avatar
Matthias Braun committed
531
532
@op
class End:
533
534
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
535
536
537
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
538
	input_name       = "keepalive"
539
540
541
542
	flags            = [ "cfopcode" ]
	knownBlock       = True
	block            = "get_irg_end_block(irg)"
	singleton        = True
543

Matthias Braun's avatar
Matthias Braun committed
544
@op
545
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
546
547
548
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
549
	flags    = [ "commutative" ]
550

Matthias Braun's avatar
Matthias Braun committed
551
552
@op
class Free:
553
	"""Frees a block of memory previously allocated by an Alloc node"""
554
555
556
	ins    = [
		("mem",   "memory dependency" ),
		("ptr",   "pointer to the object to free"),
557
		("count", "number of objects to allocate" ),
558
	]
559
560
561
	mode   = "mode_M"
	flags  = [ "uses_memory" ]
	pinned = "yes"
562
	attrs  = [
563
		dict(
564
565
566
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
567
568
		),
		dict(
569
570
571
			name    = "where",
			type    = "ir_where_alloc",
			comment = "whether allocation was on the stack or heap",
572
		)
573
574
575
	]
	attr_struct = "free_attr"

Matthias Braun's avatar
Matthias Braun committed
576
577
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
578
579
580
581
	"""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."""
582
583
584
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
585
586
587
	pinned = "no"
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
588
589
@op
class IJmp:
590
591
592
	"""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"""
593
594
	mode     = "mode_X"
	pinned   = "yes"
595
596
597
	ins      = [
	   ("target", "target address of the jump"),
	]
598
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
599

Matthias Braun's avatar
Matthias Braun committed
600
601
@op
class InstOf:
602
	"""Tests whether an object is an instance of a class-type"""
603
604
605
606
	ins   = [
	   ("store", "memory dependency"),
	   ("obj",   "pointer to object being queried")
	]
607
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
608
		("M",         "memory result"),
609
		("res",       "checked object pointer"),
Matthias Braun's avatar
Matthias Braun committed
610
611
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
612
	]
613
	flags = [ "highlevel" ]
614
615
	attrs = [
		dict(
616
617
618
			name    = "type",
			type    = "ir_type*",
			comment = "type to check ptr for",
619
		)
620
621
622
623
624
	]
	attr_struct = "io_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_floats"

Matthias Braun's avatar
Matthias Braun committed
625
626
@op
class Jmp:
627
	"""Jumps to the block connected through the out-value"""
628
629
630
631
632
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

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

Matthias Braun's avatar
Matthias Braun committed
680
@op
681
class Minus(Unop):
Andreas Seltenreich's avatar
Andreas Seltenreich committed
682
	"""returns the additive inverse of its operand"""
683
684
	flags = []

Matthias Braun's avatar
Matthias Braun committed
685
686
@op
class Mod:
687
688
689
	"""returns the remainder of its operands from an implied division.

	Examples:
690

691
692
693
694
695
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
696
697
698
699
700
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
701
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
702
		("M",         "memory result"),
703
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
704
705
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
706
	]
707
	flags = [ "fragile", "uses_memory" ]
708
	attrs = [
709
		dict(
710
711
712
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
713
		),
714
	]
715
	attr_struct = "mod_attr"
716
	pinned      = "exception"
717
	throws_init = "false"
718
719
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
720

721
class Mul(Binop):
722
	"""returns the product of its operands"""
723
724
725
	flags = [ "commutative" ]

class Mulh(Binop):
726
727
	"""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)"""
728
729
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
730
731
@op
class Mux:
732
733
	"""returns the false or true operand depending on the value of the sel
	operand"""
734
735
736
737
738
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
739
740
741
	flags  = []
	pinned = "no"

Matthias Braun's avatar
Matthias Braun committed
742
743
@op
class NoMem:
744
	"""Placeholder node for cases where you don't need any memory input"""
745
	mode          = "mode_M"
746
	flags         = [ "dump_noblock" ]
747
748
	pinned        = "yes"
	knownBlock    = True
749
	block         = "get_irg_start_block(irg)"
750
	singleton     = True
751

Matthias Braun's avatar
Matthias Braun committed
752
@op
753
class Not(Unop):
754
	"""returns the bitwise complement of a value. Works for boolean values, too."""
755
756
	flags = []

Matthias Braun's avatar
Matthias Braun committed
757
@op
758
class Or(Binop):
759
	"""returns the result of a bitwise or operation of its operands"""
760
761
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
762
763
@op
class Phi:
764
765
766
	"""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."""
767
768
	pinned        = "yes"
	arity         = "variable"
769
	input_name    = "pred"
770
771
	flags         = []
	attr_struct   = "phi_attr"
772
	init          = '''
773
	res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
Matthias Braun's avatar
Matthias Braun committed
774
	customSerializer = True
775

Matthias Braun's avatar
Matthias Braun committed
776
777
@op
class Pin:
778
779
780
	"""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."""
781
782
783
	ins      = [
		("op", "value which is pinned"),
	]
784
785
786
787
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

Matthias Braun's avatar
Matthias Braun committed
788
789
@op
class Proj:
790
	"""returns an entry of a tuple value"""
791
792
793
	ins              = [
		("pred", "the tuple value from which a part is extracted"),
	]
794
795
796
797
798
799
	flags            = []
	pinned           = "no"
	knownBlock       = True
	knownGraph       = True
	block            = "get_nodes_block(irn_pred)"
	graph            = "get_irn_irg(irn_pred)"
800
	attrs      = [
801
		dict(
802
803
804
			type    = "long",
			name    = "proj",
			comment = "number of tuple component to be extracted",
805
		),
806
	]
807
	attr_struct = "proj_attr"
808

Matthias Braun's avatar
Matthias Braun committed
809
810
@op
class Raise:
811
812
813
	"""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."""
814
815
816
817
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
818
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
819
820
		("M", "memory result"),
		("X", "control flow to exception handler"),
821
	]
822
823
824
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
825
826
@op
class Return:
827
828
	"""Returns from the current function. Takes memory and return values as
	operands."""
829
	ins        = [
830
831
		("mem", "memory dependency"),
	]
832
833
834
835
836
	arity      = "variable"
	input_name = "res"
	mode       = "mode_X"
	flags      = [ "cfopcode" ]
	pinned     = "yes"
837
838

class Rotl(Binop):
839
840
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
841
842
	flags    = []

Matthias Braun's avatar
Matthias Braun committed
843
844
@op
class Sel:
845
	"""Computes the address of a entity of a compound type given the base
846
847
848
849
	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."""
850
	ins         = [
851
852
853
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
854
855
856
857
858
859
	arity       = "variable"
	input_name  = "index"
	flags       = []
	mode        = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned      = "no"
	attrs       = [
860
		dict(
861
862
863
			type    = "ir_entity*",
			name    = "entity",
			comment = "entity which is selected",
864
		)
865
866
867
	]
	attr_struct = "sel_attr"

Matthias Braun's avatar
Matthias Braun committed
868
@op
869
class Shl(Binop):
870
	"""Returns its first operands bits shifted left by the amount of the 2nd
871
872
873
874
	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."""
875
876
	flags = []

Matthias Braun's avatar
Matthias Braun committed
877
@op
878
class Shr(Binop):
879
	"""Returns its first operands bits shifted right by the amount of the 2nd
880
881
882
883
	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."""
884
885
	flags = []

Matthias Braun's avatar
Matthias Braun committed
886
@op
887
class Shrs(Binop):
888
889
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
890
891
892
893
	(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."""
894
895
	flags = []

Matthias Braun's avatar
Matthias Braun committed
896
897
@op
class Start:
898
	"""The first node of a graph. Execution starts with this node."""
899
900
901
902
903
904
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
905
906
907
908
909
910
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	block            = "get_irg_start_block(irg)"
911

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

Matthias Braun's avatar
Matthias Braun committed
954
@op
955
class Sub(Binop):
956
	"""returns the difference of its operands"""
957
958
	flags = []

Matthias Braun's avatar
Matthias Braun committed
959
960
@op
class SymConst:
961
962
	"""A symbolic constant.

963
964 </