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
125
126
127
128
129
130
	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
131
132
133
	ins   = [
		("mem",    "memory dependency"),
	]
134
135
	attrs = [
		dict(
136
137
138
			name    = "input_constraints",
			type    = "ir_asm_constraint*",
			comment = "input constraints",
139
140
		),
		dict(
141
			name    = "n_output_constraints",
142
			type    = "size_t",
143
144
			noprop  = True,
			comment = "number of output constraints",
145
146
		),
		dict(
147
148
149
			name    = "output_constraints",
			type    = "ir_asm_constraint*",
			comment = "output constraints",
150
151
		),
		dict(
152
			name    = "n_clobbers",
153
			type    = "size_t",
154
155
			noprop  = True,
			comment = "number of clobbered registers/memory",
156
157
		),
		dict(
158
159
160
			name    = "clobbers",
			type    = "ident**",
			comment = "list of clobbered registers/memory",
161
162
		),
		dict(
163
164
165
			name    = "text",
			type    = "ident*",
			comment = "assembler text",
166
167
168
169
170
		),
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
171

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

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

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

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

	/* Create and initialize array for Phi-node construction. */
236
237
238
	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*));
239
	}
240
	'''
241

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
551
@op
552
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
553
554
555
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
556
	flags    = [ "commutative" ]
557

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

Matthias Braun's avatar
Matthias Braun committed
583
584
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
585
586
587
588
	"""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."""
589
590
591
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
592
593
594
	pinned = "no"
	flags  = []

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
687
@op
688
class Minus(Unop):
Andreas Seltenreich's avatar
Andreas Seltenreich committed
689
	"""returns the additive inverse of its operand"""
690
691
	flags = []

Matthias Braun's avatar
Matthias Braun committed
692
693
@op
class Mod:
694
695
696
	"""returns the remainder of its operands from an implied division.

	Examples:
697

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

728
class Mul(Binop):
729
	"""returns the product of its operands"""
730
731
732
	flags = [ "commutative" ]

class Mulh(Binop):
733
734
	"""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)"""
735
736
	flags = [ "commutative" ]

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

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

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

Matthias Braun's avatar
Matthias Braun committed
764
@op
765
class Or(Binop):
766
	"""returns the result of a bitwise or operation of its operands"""
767
768
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
769
770
@op
class Phi:
771
772
773
	"""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."""
774
775
776
777
	pinned        = "yes"
	arity         = "variable"
	flags         = []
	attr_struct   = "phi_attr"
778
779
780
	init          = '''
	res->attr.phi.u.backedge = new_backedge_arr(irg->obst, arity);'''
	init_after_opt = '''
Matthias Braun's avatar
Matthias Braun committed
781
782
	/* Memory Phis in endless loops must be kept alive.
	   As we can't distinguish these easily we keep all of them alive. */
783
784
	if (is_Phi(res) && mode == mode_M)
		add_End_keepalive(get_irg_end(irg), res);'''
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
841
842
	ins      = [
		("mem", "memory dependency"),
	]
843
844
845
846
847
848
	arity    = "variable"
	mode     = "mode_X"
	flags    = [ "cfopcode" ]
	pinned   = "yes"

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
895
@op
896
class Shrs(Binop):
897
898
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
899
900
901
902
	(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."""
903
904
	flags = []

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

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

Matthias Braun's avatar
Matthias Braun committed
963
@op
964
class Sub(Binop):
965
	"""returns the difference of its operands"""
966
967
	flags = []

Matthias Braun's avatar
Matthias Braun committed
968
969
@op
class SymConst:
970
971
	"""A symbolic constant.

972
973
974
975
976
977
978
979
980
981
982
983
984
	 - *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."""
985
986
987
988
	mode       = "mode_P"
	flags      = [ "constlike", "start_block" ]
	knownBlock = True
	pinned     = "no"
989
	attrs      = [
990
		dict(
991
992
993
994
			type    = "ir_entity*",
			name    = "entity",
			noprop  = True,
			comment = "entity whose address is returned",
995
		)
996
997
	]
	attr_struct = "symconst_attr"
998
	customSerializer = True
999
1000
1001
	# constructor is written manually at the moment, because of the strange
	# union argument
	noconstructor = True
1002

Matthias Braun's avatar
Matthias Braun committed
1003
1004
@op
class Sync:
1005
1006
1007
1008
1009
	"""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."""
1010
1011
1012
	mode     = "mode_M"
	flags    = []
	pinned   = "no"