ir_spec.py 27.2 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
310
class Cmp(Binop):
311
	"""Compares its two operands and checks whether a specified
312
	   relation (like less or equal) is fulfilled."""
313
	flags = []
314
315
316
317
318
319
320
321
322
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
323

Matthias Braun's avatar
Matthias Braun committed
324
325
@op
class Cond:
326
	"""Conditionally change control flow."""
327
328
329
	ins      = [
		("selector",  "condition parameter"),
	]
330
331
332
333
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
334
335
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
336
337
	attrs    = [
		dict(
338
339
340
341
			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
342
		),
343
	]
344
	attr_struct = "cond_attr"
345

Matthias Braun's avatar
Matthias Braun committed
346
347
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
	"""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
374
375
@op
class Confirm:
376
377
378
379
380
381
382
383
384
	"""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."""
385
386
387
388
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
389
390
391
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
392
393
	attrs    = [
		dict(
394
395
396
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
397
		),
398
399
400
	]
	attr_struct = "confirm_attr"

Matthias Braun's avatar
Matthias Braun committed
401
402
@op
class Const:
403
	"""Returns a constant value."""
404
	flags      = [ "constlike", "start_block" ]
405
406
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
407
408
	knownBlock = True
	pinned     = "no"
409
410
	attrs      = [
		dict(
411
412
413
			type    = "ir_tarval*",
			name    = "tarval",
			comment = "constant value (a tarval object)",
414
		)
415
416
	]
	attr_struct = "const_attr"
417
	attrs_name  = "con"
418

Matthias Braun's avatar
Matthias Braun committed
419
@op
420
class Conv(Unop):
421
	"""Converts values between modes"""
422
423
	flags = []

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

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

Matthias Braun's avatar
Matthias Braun committed
483
484
@op
class Dummy:
485
486
487
	"""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."""
488
489
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
490
491
492
493
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

Matthias Braun's avatar
Matthias Braun committed
494
495
@op
class End:
496
497
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
498
499
500
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
501
	input_name       = "keepalive"
502
503
504
505
	flags            = [ "cfopcode" ]
	knownBlock       = True
	block            = "get_irg_end_block(irg)"
	singleton        = True
506

Matthias Braun's avatar
Matthias Braun committed
507
@op
508
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
509
510
511
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
512
	flags    = [ "commutative" ]
513

Matthias Braun's avatar
Matthias Braun committed
514
515
@op
class Free:
516
	"""Frees a block of memory previously allocated by an Alloc node"""
517
518
519
	ins    = [
		("mem",   "memory dependency" ),
		("ptr",   "pointer to the object to free"),
520
		("count", "number of objects to allocate" ),
521
	]
522
523
524
	mode   = "mode_M"
	flags  = [ "uses_memory" ]
	pinned = "yes"
525
	attrs  = [
526
		dict(
527
528
529
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
530
531
		),
		dict(
532
533
534
			name    = "where",
			type    = "ir_where_alloc",
			comment = "whether allocation was on the stack or heap",
535
		)
536
537
538
	]
	attr_struct = "free_attr"

Matthias Braun's avatar
Matthias Braun committed
539
540
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
541
542
543
544
	"""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."""
545
546
547
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
548
549
550
	pinned = "no"
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
551
552
@op
class IJmp:
553
554
555
	"""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"""
556
557
	mode     = "mode_X"
	pinned   = "yes"
558
559
560
	ins      = [
	   ("target", "target address of the jump"),
	]
561
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
562

Matthias Braun's avatar
Matthias Braun committed
563
564
@op
class InstOf:
565
	"""Tests whether an object is an instance of a class-type"""
566
567
568
569
	ins   = [
	   ("store", "memory dependency"),
	   ("obj",   "pointer to object being queried")
	]
570
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
571
		("M",         "memory result"),
572
		("res",       "checked object pointer"),
Matthias Braun's avatar
Matthias Braun committed
573
574
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
575
	]
576
	flags = [ "highlevel" ]
577
578
	attrs = [
		dict(
579
580
581
			name    = "type",
			type    = "ir_type*",
			comment = "type to check ptr for",
582
		)
583
584
585
586
587
	]
	attr_struct = "io_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_floats"

Matthias Braun's avatar
Matthias Braun committed
588
589
@op
class Jmp:
590
	"""Jumps to the block connected through the out-value"""
591
592
593
594
595
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

Matthias Braun's avatar
Matthias Braun committed
596
597
@op
class Load:
598
	"""Loads a value from memory (heap or stack)."""
599
600
601
602
	ins   = [
		("mem", "memory dependency"),
		("ptr",  "address to load from"),
	]
603
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
604
		("M",         "memory result"),
605
		("res",       "result of load operation"),
Matthias Braun's avatar
Matthias Braun committed
606
607
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
608
	]
609
610
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
611
612
	attrs    = [
		dict(
613
614
615
			type      = "ir_mode*",
			name      = "mode",
			comment   = "mode of the value to be loaded",
616
		),
617
618
619
620
621
		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",
622
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : cons_none"
623
624
625
626
627
628
		),
		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",
629
			to_flags  = "%s == align_non_aligned ? cons_unaligned : cons_none"
630
		),
631
632
	]
	attr_struct = "load_attr"
633
634
	constructor_args = [
		dict(
635
636
637
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
638
		),
639
	]
640
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
641
	throws_init = "(flags & cons_throws_exception) != 0"
642

Matthias Braun's avatar
Matthias Braun committed
643
@op
644
class Minus(Unop):
Andreas Seltenreich's avatar
Andreas Seltenreich committed
645
	"""returns the additive inverse of its operand"""
646
647
	flags = []

Matthias Braun's avatar
Matthias Braun committed
648
649
@op
class Mod:
650
651
652
	"""returns the remainder of its operands from an implied division.

	Examples:
653

654
655
656
657
658
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
659
660
661
662
663
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
664
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
665
		("M",         "memory result"),
666
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
667
668
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
669
	]
670
	flags = [ "fragile", "uses_memory" ]
671
	attrs = [
672
		dict(
673
674
675
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
676
		),
677
	]
678
	attr_struct = "mod_attr"
679
	pinned      = "exception"
680
	throws_init = "false"
681
682
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
683

684
class Mul(Binop):
685
	"""returns the product of its operands"""
686
687
688
	flags = [ "commutative" ]

class Mulh(Binop):
689
690
	"""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)"""
691
692
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
693
694
@op
class Mux:
695
696
	"""returns the false or true operand depending on the value of the sel
	operand"""
697
698
699
700
701
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
702
703
704
	flags  = []
	pinned = "no"

Matthias Braun's avatar
Matthias Braun committed
705
706
@op
class NoMem:
707
	"""Placeholder node for cases where you don't need any memory input"""
708
	mode          = "mode_M"
709
	flags         = [ "dump_noblock" ]
710
711
	pinned        = "yes"
	knownBlock    = True
712
	block         = "get_irg_start_block(irg)"
713
	singleton     = True
714

Matthias Braun's avatar
Matthias Braun committed
715
@op
716
class Not(Unop):
717
	"""returns the bitwise complement of a value. Works for boolean values, too."""
718
719
	flags = []

Matthias Braun's avatar
Matthias Braun committed
720
@op
721
class Or(Binop):
722
	"""returns the result of a bitwise or operation of its operands"""
723
724
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
725
726
@op
class Phi:
727
728
729
	"""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."""
730
731
	pinned        = "yes"
	arity         = "variable"
732
	input_name    = "pred"
733
734
	flags         = []
	attr_struct   = "phi_attr"
735
	init          = '''
736
	res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
Matthias Braun's avatar
Matthias Braun committed
737
	customSerializer = True
738

Matthias Braun's avatar
Matthias Braun committed
739
740
@op
class Pin:
741
742
743
	"""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."""
744
745
746
	ins      = [
		("op", "value which is pinned"),
	]
747
748
749
750
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

Matthias Braun's avatar
Matthias Braun committed
751
752
@op
class Proj:
753
	"""returns an entry of a tuple value"""
754
755
756
	ins              = [
		("pred", "the tuple value from which a part is extracted"),
	]
757
758
759
760
761
762
	flags            = []
	pinned           = "no"
	knownBlock       = True
	knownGraph       = True
	block            = "get_nodes_block(irn_pred)"
	graph            = "get_irn_irg(irn_pred)"
763
	attrs      = [
764
		dict(
765
766
767
			type    = "long",
			name    = "proj",
			comment = "number of tuple component to be extracted",
768
		),
769
	]
770
	attr_struct = "proj_attr"
771

Matthias Braun's avatar
Matthias Braun committed
772
773
@op
class Raise:
774
775
776
	"""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."""
777
778
779
780
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
781
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
782
783
		("M", "memory result"),
		("X", "control flow to exception handler"),
784
	]
785
786
787
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
788
789
@op
class Return:
790
791
	"""Returns from the current function. Takes memory and return values as
	operands."""
792
	ins        = [
793
794
		("mem", "memory dependency"),
	]
795
796
797
798
799
	arity      = "variable"
	input_name = "res"
	mode       = "mode_X"
	flags      = [ "cfopcode" ]
	pinned     = "yes"
800
801

class Rotl(Binop):
802
803
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
804
805
	flags    = []

Matthias Braun's avatar
Matthias Braun committed
806
807
@op
class Sel:
808
	"""Computes the address of a entity of a compound type given the base
809
810
811
812
	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."""
813
	ins         = [
814
815
816
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
817
818
819
820
821
822
	arity       = "variable"
	input_name  = "index"
	flags       = []
	mode        = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned      = "no"
	attrs       = [
823
		dict(
824
825
826
			type    = "ir_entity*",
			name    = "entity",
			comment = "entity which is selected",
827
		)
828
829
830
	]
	attr_struct = "sel_attr"

Matthias Braun's avatar
Matthias Braun committed
831
@op
832
class Shl(Binop):
833
	"""Returns its first operands bits shifted left by the amount of the 2nd
834
835
836
837
	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."""
838
839
	flags = []

Matthias Braun's avatar
Matthias Braun committed
840
@op
841
class Shr(Binop):
842
	"""Returns its first operands bits shifted right by the amount of the 2nd
843
844
845
846
	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."""
847
848
	flags = []

Matthias Braun's avatar
Matthias Braun committed
849
@op
850
class Shrs(Binop):
851
852
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
853
854
855
856
	(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."""
857
858
	flags = []

Matthias Braun's avatar
Matthias Braun committed
859
860
@op
class Start:
861
	"""The first node of a graph. Execution starts with this node."""
862
863
864
865
866
867
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
868
869
870
871
872
873
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	block            = "get_irg_start_block(irg)"
874

Matthias Braun's avatar
Matthias Braun committed
875
876
@op
class Store:
877
	"""Stores a value into memory (heap or stack)."""
878
879
880
881
882
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
883
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
884
885
886
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
887
	]
888
889
890
891
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
892
	throws_init = "(flags & cons_throws_exception) != 0"
893
894
895
896
897
898
	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",
899
			to_flags  = "%s == volatility_is_volatile ? cons_volatile : cons_none"
900
901
902
903
904
905
		),
		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",
906
			to_flags  = "%s == align_non_aligned ? cons_unaligned : cons_none"
907
908
		),
	]
909
	constructor_args = [
910
		dict(
911
912
913
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
914
		),
915
916
	]

Matthias Braun's avatar
Matthias Braun committed
917
@op
918
class Sub(Binop):
919
	"""returns the difference of its operands"""
920
921
	flags = []

Matthias Braun's avatar
Matthias Braun committed
922
923
@op
class SymConst:
924
925
	"""A symbolic constant.

926
927
928
929
930
931
932
933
934
935
936
937
938
	 - *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."""
939
940
941
942
	mode       = "mode_P"
	flags      = [ "constlike", "start_block" ]
	knownBlock = True
	pinned     = "no"
943
	attrs      = [
944
		dict(
945
946
947
948
			type    = "ir_entity*",
			name    = "entity",
			noprop  = True,
			comment = "entity whose address is returned",
949
		)
950
951
	]
	attr_struct = "symconst_attr"
952
	customSerializer = True
953
954
955
	# constructor is written manually at the moment, because of the strange
	# union argument
	noconstructor = True
956

Matthias Braun's avatar
Matthias Braun committed
957
958
@op
class Sync:
959
960
961
962
963
	"""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."""
964
965
966
967
968
	mode       = "mode_M"
	flags      = []
	pinned     = "no"
	arity      = "dynamic"
	input_name = "pred"
969

Matthias Braun's avatar
Matthias Braun committed
970
971
@op
class Tuple:
972
973
974
975
976
977
978
	"""Builds a Tuple from single values.

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

Matthias Braun's avatar
Matthias Braun committed
986
987
@op
class Unknown:
988
989
	"""Returns an unknown (at compile- and runtime) value. It is a valid
	optimisation to replace an Unknown by any other constant value."""
990
991
992
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"
Matthias Braun's avatar
Matthias Braun committed
993
	flags      = [ "start_block", "constlike", "dump_noblock" ]