ir_spec.py 27.5 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 Builtin:
245
	"""performs a backend-specific builtin."""
246
	ins         = [
247
248
		("mem", "memory dependency"),
	]
249
250
251
	arity       = "variable"
	input_name  = "param"
	outs        = [
252
253
		("M", "memory result"),
		# results follow here
254
	]
255
256
	flags       = [ "uses_memory" ]
	attrs       = [
257
		dict(
258
259
260
			type    = "ir_builtin_kind",
			name    = "kind",
			comment = "kind of builtin",
261
		),
262
		dict(
263
264
265
			type    = "ir_type*",
			name    = "type",
			comment = "method type for the builtin call",
266
		)
267
268
269
270
	]
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
	attr_struct = "builtin_attr"
271
	init        = '''
272
273
274
	assert((get_unknown_type() == type) || is_Method_type(type));
	'''

Matthias Braun's avatar
Matthias Braun committed
275
276
@op
class Call:
277
278
279
280
	"""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."""
281
	ins         = [
282
283
284
		("mem",   "memory dependency"),
		("ptr",   "pointer to called code"),
	]
285
286
287
	arity       = "variable"
	input_name  = "param"
	outs        = [
Matthias Braun's avatar
Matthias Braun committed
288
		("M",                "memory result"),
289
		("T_result",         "tuple containing all results"),
Matthias Braun's avatar
Matthias Braun committed
290
291
		("X_regular",        "control flow when no exception occurs"),
		("X_except",         "control flow when exception occured"),
292
	]
293
294
	flags       = [ "fragile", "uses_memory" ]
	attrs       = [
295
		dict(
296
297
298
			type    = "ir_type*",
			name    = "type",
			comment = "type of the call (usually type of the called procedure)",
299
		),
300
301
302
303
	]
	attr_struct = "call_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
304
	throws_init = "false"
305
306
	init = '''
	assert((get_unknown_type() == type) || is_Method_type(type));
307
	'''
308

Matthias Braun's avatar
Matthias Braun committed
309
@op
Michael Beck's avatar
Michael Beck committed
310
class Cast(Unop):
311
	"""perform a high-level type cast"""
312
313
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
314
315
	attrs    = [
		dict(
316
317
318
			type    = "ir_type*",
			name    = "type",
			comment = "target type of the case",
319
		)
320
321
	]
	attr_struct = "cast_attr"
322
	init     = "assert(is_atomic_type(type));"
323

Matthias Braun's avatar
Matthias Braun committed
324
@op
325
class Cmp(Binop):
326
	"""Compares its two operands and checks whether a specified
327
	   relation (like less or equal) is fulfilled."""
328
	flags = []
329
330
331
332
333
334
335
336
337
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
338

Matthias Braun's avatar
Matthias Braun committed
339
340
@op
class Cond:
341
	"""Conditionally change control flow."""
342
343
344
	ins      = [
		("selector",  "condition parameter"),
	]
345
346
347
348
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
349
350
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
351
352
	attrs    = [
		dict(
353
354
355
356
			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
357
		),
358
	]
359
	attr_struct = "cond_attr"
360

Matthias Braun's avatar
Matthias Braun committed
361
362
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
	"""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
389
390
@op
class Confirm:
391
392
393
394
395
396
397
398
399
	"""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."""
400
401
402
403
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
404
405
406
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
407
408
	attrs    = [
		dict(
409
410
411
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
412
		),
413
414
415
	]
	attr_struct = "confirm_attr"

Matthias Braun's avatar
Matthias Braun committed
416
417
@op
class Const:
418
	"""Returns a constant value."""
419
	flags      = [ "constlike", "start_block" ]
420
421
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
422
423
	knownBlock = True
	pinned     = "no"
424
425
	attrs      = [
		dict(
426
427
428
			type    = "ir_tarval*",
			name    = "tarval",
			comment = "constant value (a tarval object)",
429
		)
430
431
	]
	attr_struct = "const_attr"
432
	attrs_name  = "con"
433

Matthias Braun's avatar
Matthias Braun committed
434
@op
435
class Conv(Unop):
436
	"""Converts values between modes"""
437
438
	flags = []

Matthias Braun's avatar
Matthias Braun committed
439
440
@op
class CopyB:
Matthias Braun's avatar
Matthias Braun committed
441
	"""Copies a block of memory with statically known size/type."""
442
443
444
445
446
	ins   = [
		("mem",  "memory dependency"),
		("dst",  "destination address"),
		("src",  "source address"),
	]
447
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
448
449
450
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
451
	]
452
	flags = [ "fragile", "uses_memory" ]
453
454
	attrs = [
		dict(
455
456
457
			name    = "type",
			type    = "ir_type*",
			comment = "type of copied data",
458
		)
459
460
461
462
	]
	attr_struct = "copyb_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
463
	throws_init = "false"
464

Matthias Braun's avatar
Matthias Braun committed
465
466
@op
class Div:
467
	"""returns the quotient of its 2 operands"""
468
469
470
471
472
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
473
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
474
		("M",         "memory result"),
475
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
476
477
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
478
	]
479
	flags = [ "fragile", "uses_memory" ]
480
481
	attrs = [
		dict(
482
483
484
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result value",
485
		),
Moritz Kroll's avatar
Moritz Kroll committed
486
487
488
489
		dict(
			name = "no_remainder",
			type = "int",
			init = "0",
490
		)
491
	]
492
	attr_struct = "div_attr"
493
	pinned      = "exception"
494
	throws_init = "false"
495
496
	op_index    = 1
	arity_override = "oparity_binary"
497

Matthias Braun's avatar
Matthias Braun committed
498
499
@op
class Dummy:
500
501
502
	"""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."""
503
504
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
505
506
507
508
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

Matthias Braun's avatar
Matthias Braun committed
509
510
@op
class End:
511
512
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
513
514
515
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
516
	input_name       = "keepalive"
517
518
519
520
	flags            = [ "cfopcode" ]
	knownBlock       = True
	block            = "get_irg_end_block(irg)"
	singleton        = True
521

Matthias Braun's avatar
Matthias Braun committed
522
@op
523
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
524
525
526
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
527
	flags    = [ "commutative" ]
528

Matthias Braun's avatar
Matthias Braun committed
529
530
@op
class Free:
531
	"""Frees a block of memory previously allocated by an Alloc node"""
532
533
534
	ins    = [
		("mem",   "memory dependency" ),
		("ptr",   "pointer to the object to free"),
535
		("count", "number of objects to allocate" ),
536
	]
537
538
539
	mode   = "mode_M"
	flags  = [ "uses_memory" ]
	pinned = "yes"
540
	attrs  = [
541
		dict(
542
543
544
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
545
546
		),
		dict(
547
548
549
			name    = "where",
			type    = "ir_where_alloc",
			comment = "whether allocation was on the stack or heap",
550
		)
551
552
553
	]
	attr_struct = "free_attr"

Matthias Braun's avatar
Matthias Braun committed
554
555
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
556
557
558
559
	"""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."""
560
561
562
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
563
564
565
	pinned = "no"
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
566
567
@op
class IJmp:
568
569
570
	"""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"""
571
572
	mode     = "mode_X"
	pinned   = "yes"
573
574
575
	ins      = [
	   ("target", "target address of the jump"),
	]
576
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
577

Matthias Braun's avatar
Matthias Braun committed
578
579
@op
class InstOf:
580
	"""Tests whether an object is an instance of a class-type"""
581
582
583
584
	ins   = [
	   ("store", "memory dependency"),
	   ("obj",   "pointer to object being queried")
	]
585
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
586
		("M",         "memory result"),
587
		("res",       "checked object pointer"),
Matthias Braun's avatar
Matthias Braun committed
588
589
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
590
	]
591
	flags = [ "highlevel" ]
592
593
	attrs = [
		dict(
594
595
596
			name    = "type",
			type    = "ir_type*",
			comment = "type to check ptr for",
597
		)
598
599
600
601
602
	]
	attr_struct = "io_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_floats"

Matthias Braun's avatar
Matthias Braun committed
603
604
@op
class Jmp:
605
	"""Jumps to the block connected through the out-value"""
606
607
608
609
610
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

Matthias Braun's avatar
Matthias Braun committed
611
612
@op
class Load:
613
	"""Loads a value from memory (heap or stack)."""
614
615
616
617
	ins   = [
		("mem", "memory dependency"),
		("ptr",  "address to load from"),
	]
618
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
619
		("M",         "memory result"),
620
		("res",       "result of load operation"),
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
625
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
626
627
	attrs    = [
		dict(
628
629
630
			type      = "ir_mode*",
			name      = "mode",
			comment   = "mode of the value to be loaded",
631
		),
632
633
634
635
636
		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",
637
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : cons_none"
638
639
640
641
642
643
		),
		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",
644
			to_flags  = "%s == align_non_aligned ? cons_unaligned : cons_none"
645
		),
646
647
	]
	attr_struct = "load_attr"
648
649
	constructor_args = [
		dict(
650
651
652
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
653
		),
654
	]
655
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
656
	throws_init = "(flags & cons_throws_exception) != 0"
657

Matthias Braun's avatar
Matthias Braun committed
658
@op
659
class Minus(Unop):
Andreas Seltenreich's avatar
Andreas Seltenreich committed
660
	"""returns the additive inverse of its operand"""
661
662
	flags = []

Matthias Braun's avatar
Matthias Braun committed
663
664
@op
class Mod:
665
666
667
	"""returns the remainder of its operands from an implied division.

	Examples:
668

669
670
671
672
673
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
674
675
676
677
678
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
679
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
680
		("M",         "memory result"),
681
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
682
683
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
684
	]
685
	flags = [ "fragile", "uses_memory" ]
686
	attrs = [
687
		dict(
688
689
690
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
691
		),
692
	]
693
	attr_struct = "mod_attr"
694
	pinned      = "exception"
695
	throws_init = "false"
696
697
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
698

699
class Mul(Binop):
700
	"""returns the product of its operands"""
701
702
703
	flags = [ "commutative" ]

class Mulh(Binop):
704
705
	"""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)"""
706
707
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
708
709
@op
class Mux:
710
711
	"""returns the false or true operand depending on the value of the sel
	operand"""
712
713
714
715
716
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
717
718
719
	flags  = []
	pinned = "no"

Matthias Braun's avatar
Matthias Braun committed
720
721
@op
class NoMem:
722
	"""Placeholder node for cases where you don't need any memory input"""
723
	mode          = "mode_M"
724
	flags         = [ "dump_noblock" ]
725
726
	pinned        = "yes"
	knownBlock    = True
727
	block         = "get_irg_start_block(irg)"
728
	singleton     = True
729

Matthias Braun's avatar
Matthias Braun committed
730
@op
731
class Not(Unop):
732
	"""returns the bitwise complement of a value. Works for boolean values, too."""
733
734
	flags = []

Matthias Braun's avatar
Matthias Braun committed
735
@op
736
class Or(Binop):
737
	"""returns the result of a bitwise or operation of its operands"""
738
739
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
740
741
@op
class Phi:
742
743
744
	"""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."""
745
746
	pinned        = "yes"
	arity         = "variable"
747
	input_name    = "pred"
748
749
	flags         = []
	attr_struct   = "phi_attr"
750
	init          = '''
751
	res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
Matthias Braun's avatar
Matthias Braun committed
752
	customSerializer = True
753

Matthias Braun's avatar
Matthias Braun committed
754
755
@op
class Pin:
756
757
758
	"""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."""
759
760
761
	ins      = [
		("op", "value which is pinned"),
	]
762
763
764
765
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

Matthias Braun's avatar
Matthias Braun committed
766
767
@op
class Proj:
768
	"""returns an entry of a tuple value"""
769
770
771
	ins              = [
		("pred", "the tuple value from which a part is extracted"),
	]
772
773
774
775
776
777
	flags            = []
	pinned           = "no"
	knownBlock       = True
	knownGraph       = True
	block            = "get_nodes_block(irn_pred)"
	graph            = "get_irn_irg(irn_pred)"
778
	attrs      = [
779
		dict(
780
781
782
			type    = "long",
			name    = "proj",
			comment = "number of tuple component to be extracted",
783
		),
784
	]
785
	attr_struct = "proj_attr"
786

Matthias Braun's avatar
Matthias Braun committed
787
788
@op
class Raise:
789
790
791
	"""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."""
792
793
794
795
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
796
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
797
798
		("M", "memory result"),
		("X", "control flow to exception handler"),
799
	]
800
801
802
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
803
804
@op
class Return:
805
806
	"""Returns from the current function. Takes memory and return values as
	operands."""
807
	ins        = [
808
809
		("mem", "memory dependency"),
	]
810
811
812
813
814
	arity      = "variable"
	input_name = "res"
	mode       = "mode_X"
	flags      = [ "cfopcode" ]
	pinned     = "yes"
815
816

class Rotl(Binop):
817
818
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
819
820
	flags    = []

Matthias Braun's avatar
Matthias Braun committed
821
822
@op
class Sel:
823
	"""Computes the address of a entity of a compound type given the base
824
825
826
827
	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."""
828
	ins         = [
829
830
831
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
832
833
834
835
836
837
	arity       = "variable"
	input_name  = "index"
	flags       = []
	mode        = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned      = "no"
	attrs       = [
838
		dict(
839
840
841
			type    = "ir_entity*",
			name    = "entity",
			comment = "entity which is selected",
842
		)
843
844
845
	]
	attr_struct = "sel_attr"

Matthias Braun's avatar
Matthias Braun committed
846
@op
847
class Shl(Binop):
848
	"""Returns its first operands bits shifted left by the amount of the 2nd
849
850
851
852
	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."""
853
854
	flags = []

Matthias Braun's avatar
Matthias Braun committed
855
@op
856
class Shr(Binop):
857
	"""Returns its first operands bits shifted right by the amount of the 2nd
858
859
860
861
	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."""
862
863
	flags = []

Matthias Braun's avatar
Matthias Braun committed
864
@op
865
class Shrs(Binop):
866
867
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
868
869
870
871
	(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."""
872
873
	flags = []

Matthias Braun's avatar
Matthias Braun committed
874
875
@op
class Start:
876
	"""The first node of a graph. Execution starts with this node."""
877
878
879
880
881
882
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
883
884
885
886
887
888
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	block            = "get_irg_start_block(irg)"
889

Matthias Braun's avatar
Matthias Braun committed
890
891
@op
class Store:
892
	"""Stores a value into memory (heap or stack)."""
893
894
895
896
897
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
898
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
899
900
901
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
902
	]
903
904
905
906
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
907
	throws_init = "(flags & cons_throws_exception) != 0"
908
909
910
911
912
913
	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",
914
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : cons_none"
915
916
917
918
919
920
		),
		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",
921
			to_flags  = "%s == align_non_aligned ? cons_unaligned : cons_none"
922
923
		),
	]
924
	constructor_args = [
925
		dict(
926
927
928
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
929
		),
930
931
	]

Matthias Braun's avatar
Matthias Braun committed
932
@op
933
class Sub(Binop):
934
	"""returns the difference of its operands"""
935
936
	flags = []

Matthias Braun's avatar
Matthias Braun committed
937
938
@op
class SymConst:
939
940
	"""A symbolic constant.

941
942
943
944
945
946
947
948
949
950
951
952
953
	 - *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."""
954
955
956
957
	mode       = "mode_P"
	flags      = [ "constlike", "start_block" ]
	knownBlock = True
	pinned     = "no"
958
	attrs      = [
959
		dict(
960
961
962
963
			type    = "ir_entity*",
			name    = "entity",
			noprop  = True,
			comment = "entity whose address is returned",
964
		)
965
966
	]
	attr_struct = "symconst_attr"
967
	customSerializer = True
968
969
970
	# constructor is written manually at the moment, because of the strange
	# union argument
	noconstructor = True
971