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 Binop(object):
14
	"""Binary nodes have exactly 2 inputs"""
15
	name     = "binop"
16
	ins      = [
17
18
		("left",   "first operand"),
		("right", "second operand"),
19
	]
20
21
22
	op_index       = 0
	pinned         = "no"
	arity_override = "oparity_binary"
23

Matthias Braun's avatar
Matthias Braun committed
24
@op
25
class Add(Binop):
26
	"""returns the sum of its operands"""
27
	flags = [ "commutative" ]
28

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

Matthias Braun's avatar
Matthias Braun committed
64
65
@op
class Anchor:
66
67
68
69
70
71
	"""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."""
72
73
74
75
76
77
78
79
80
	mode             = "mode_ANY"
	arity            = "variable"
	flags            = [ "dump_noblock" ]
	pinned           = "yes"
	attr_struct      = "irg_attr"
	knownBlock       = True
	singleton        = True
	noconstructor    = True
	customSerializer = True
81

Matthias Braun's avatar
Matthias Braun committed
82
@op
83
class And(Binop):
84
	"""returns the result of a bitwise and operation of its operands"""
85
86
	flags    = [ "commutative" ]

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

Matthias Braun's avatar
Matthias Braun committed
166
167
@op
class Bad:
168
169
170
171
172
173
174
175
176
177
	"""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
178
	replaced by Bad themselves. Nodes with at least 1 Bad input get exchanged
179
180
181
182
183
184
	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
185
	flags         = [ "start_block", "dump_noblock" ]
186
187
	pinned        = "yes"
	knownBlock    = True
188
	block         = "get_irg_start_block(irg)"
189
	attr_struct   = "bad_attr"
190
	init = '''
191
	res->attr.bad.irg.irg = irg;
192
193
	'''

Matthias Braun's avatar
Matthias Braun committed
194
195
@op
class Deleted:
196
197
	"""Internal node which is temporary set to nodes which are already removed
	from the graph."""
198
199
200
201
	mode             = "mode_Bad"
	flags            = [ ]
	pinned           = "yes"
	noconstructor    = True
Matthias Braun's avatar
Matthias Braun committed
202
	customSerializer = True # this has no serializer
203

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

	init = '''
226
	res->attr.block.irg.irg     = irg;
227
	res->attr.block.backedge    = new_backedge_arr(get_irg_obstack(irg), arity);
Moritz Kroll's avatar
Moritz Kroll committed
228
	set_Block_matured(res, 1);
229
230

	/* Create and initialize array for Phi-node construction. */
231
	if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION)) {
232
		res->attr.block.graph_arr = NEW_ARR_DZ(ir_node*, get_irg_obstack(irg), irg->n_loc);
233
	}
234
	'''
235

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

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

Matthias Braun's avatar
Matthias Braun committed
302
@op
303
class Cmp(Binop):
304
	"""Compares its two operands and checks whether a specified
305
	   relation (like less or equal) is fulfilled."""
306
	flags = []
307
308
309
310
311
312
313
314
315
	mode  = "mode_b"
	attrs = [
		dict(
			type    = "ir_relation",
			name    = "relation",
			comment = "Comparison relation"
		)
	]
	attr_struct = "cmp_attr"
316

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

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

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

Matthias Braun's avatar
Matthias Braun committed
412
@op
413
class Conv:
414
	"""Converts values between modes"""
415
416
417
418
419
	flags  = []
	pinned = "no"
	ins    = [
		("op", "operand")
	]
420

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

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

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

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

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

	This is also known as the Xor operation."""
509
	flags    = [ "commutative" ]
510

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
640
@op
641
class Minus:
Andreas Seltenreich's avatar
Andreas Seltenreich committed
642
	"""returns the additive inverse of its operand"""
643
644
645
646
647
	flags  = []
	pinned = "no"
	ins    = [
		("op", "operand")
	]
648

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

	Examples:
654

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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