ir_spec.py 27.3 KB
Newer Older
1
2
3
# This file is part of libFirm.
# Copyright (C) 2012 Karlsruhe Institute of Technology.
#
Matthias Braun's avatar
Matthias Braun committed
4
5
6
# 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
7
from spec_util import abstract, op
8

Matthias Braun's avatar
Matthias Braun committed
9
name = "ir"
10

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
97
98
@op
class ASM:
Matthias Braun's avatar
Matthias Braun committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
	"""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)
	"""
126
127
	mode             = "mode_T"
	arity            = "variable"
128
	input_name       = "input"
129
130
131
132
133
134
	flags            = [ "keep", "uses_memory" ]
	pinned           = "memory"
	pinned_init      = "op_pin_state_pinned"
	attr_struct      = "asm_attr"
	attrs_name       = "assem"
	customSerializer = True
135
136
137
	ins   = [
		("mem",    "memory dependency"),
	]
138
139
	attrs = [
		dict(
140
141
142
			name    = "input_constraints",
			type    = "ir_asm_constraint*",
			comment = "input constraints",
143
144
		),
		dict(
145
			name    = "n_output_constraints",
146
			type    = "size_t",
147
148
			noprop  = True,
			comment = "number of output constraints",
149
150
		),
		dict(
151
152
153
			name    = "output_constraints",
			type    = "ir_asm_constraint*",
			comment = "output constraints",
154
155
		),
		dict(
156
			name    = "n_clobbers",
157
			type    = "size_t",
158
159
			noprop  = True,
			comment = "number of clobbered registers/memory",
160
161
		),
		dict(
162
163
164
			name    = "clobbers",
			type    = "ident**",
			comment = "list of clobbered registers/memory",
165
166
		),
		dict(
167
168
169
			name    = "text",
			type    = "ident*",
			comment = "assembler text",
170
171
172
173
174
		),
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
175

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
312
@op
313
class Cmp(Binop):
314
	"""Compares its two operands and checks whether a specified
315
	   relation (like less or equal) is fulfilled."""
316
	flags = []
317
318
319
320
321
322
323
324
325
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
326

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

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

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

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

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

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

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

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

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

	This is also known as the Xor operation."""
515
	flags    = [ "commutative" ]
516

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

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

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

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

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

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

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

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

	Examples:
656

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

687
class Mul(Binop):
688
	"""returns the product of its operands"""
689
690
691
	flags = [ "commutative" ]

class Mulh(Binop):
692
693
	"""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)"""
694
695
	flags = [ "commutative" ]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
925
926
@op
class SymConst:
927
928
	"""A symbolic constant.

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

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

Matthias Braun's avatar
Matthias Braun committed
973
974
@op
class Tuple:
975
976
977
978
979
980
981
	"""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
982
	just changing its opcode and giving it a new in array."""
983
984
985
986
987
	arity      = "variable"
	input_name = "pred"
	mode       = "mode_T"
	pinned     = "no"
	flags      = []
988

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