ir_spec.py 26.6 KB
Newer Older
1
2
3
from spec_util import abstract, setnodedefaults

class Op(object):
4
	"""Base class for firm nodes"""
5
6
7
abstract(Op)

class Unop(Op):
8
	"""Unary nodes have exactly 1 input"""
9
	name     = "unop"
10
11
12
	ins      = [
		("op",  "operand"),
	]
13
14
15
16
17
	op_index = 0
	pinned   = "no"
abstract(Unop)

class Binop(Op):
18
	"""Binary nodes have exactly 2 inputs"""
19
	name     = "binop"
20
21
22
23
	ins      = [
		( "left",   "first operand" ),
		( "right", "second operand" ),
	]
24
25
26
27
28
	op_index = 0
	pinned   = "no"
abstract(Binop)

class Add(Binop):
29
	"""returns the sum of its operands"""
30
	flags = [ "commutative" ]
31
32

class Alloc(Op):
33
34
35
	"""allocates a block of memory.
	It can be specified whether the variable should be allocated to the stack
	or to the heap."""
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
50
			name    = "type",
			type    = "ir_type*",
			comment = "type of the allocated variable",
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
64
	attr_struct = "alloc_attr"

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

class And(Binop):
82
	"""returns the result of a bitwise and operation of its operands"""
83
84
85
	flags    = [ "commutative" ]

class ASM(Op):
86
	"""executes assembler fragments of the target machine"""
87
88
89
90
91
92
93
94
	mode             = "mode_T"
	arity            = "variable"
	flags            = [ "keep", "uses_memory" ]
	pinned           = "memory"
	pinned_init      = "op_pin_state_pinned"
	attr_struct      = "asm_attr"
	attrs_name       = "assem"
	customSerializer = True
95
96
	attrs = [
		dict(
97
98
99
			name    = "input_constraints",
			type    = "ir_asm_constraint*",
			comment = "input constraints",
100
101
		),
		dict(
102
103
104
105
			name    = "n_output_constraints",
			type    = "int",
			noprop  = True,
			comment = "number of output constraints",
106
107
		),
		dict(
108
109
110
			name    = "output_constraints",
			type    = "ir_asm_constraint*",
			comment = "output constraints",
111
112
		),
		dict(
113
114
115
116
			name    = "n_clobbers",
			type    = "int",
			noprop  = True,
			comment = "number of clobbered registers/memory",
117
118
		),
		dict(
119
120
121
			name    = "clobbers",
			type    = "ident**",
			comment = "list of clobbered registers/memory",
122
123
		),
		dict(
124
125
126
			name    = "text",
			type    = "ident*",
			comment = "assembler text",
127
128
129
130
131
		),
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
132
133

class Bad(Op):
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
	"""Bad nodes indicate invalid input, which is values which should never be
	computed.

	The typical use case for the Bad node is removing unreachable code.
	Frontends should set the current_block to Bad when it is clear that
	following code must be unreachable (ie. after a goto or return statement).
	Optimisations also set block predecessors to Bad when it becomes clear,
	that a control flow edge can never be executed.

	The gigo optimisations ensures that nodes with Bad as their block, get
	replaced by Bad themselfes. Nodes with at least 1 Bad input get exchanged
	with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
	This is because removing inputs from a Block is hairy operation (requiring,
	Phis to be shortened too for example). So instead of removing block inputs
	they are set to Bad, and the actual removal is left to the control flow
	optimisation phase. Block, Phi, Tuple with only Bad inputs however are
	replaced by Bad right away."""
Matthias Braun's avatar
Matthias Braun committed
151
	flags         = [ "start_block", "dump_noblock" ]
152
153
	pinned        = "yes"
	knownBlock    = True
154
	block         = "get_irg_start_block(irg)"
155
	attr_struct   = "bad_attr"
156
	init = '''
157
	res->attr.bad.irg.irg = irg;
158
159
	'''

160
class Deleted(Op):
161
162
	"""Internal node which is temporary set to nodes which are already removed
	from the graph."""
163
164
165
166
167
	mode             = "mode_Bad"
	flags            = [ ]
	pinned           = "yes"
	noconstructor    = True
	customSerializer = True
168

169
class Block(Op):
170
	"""A basic block"""
171
172
173
174
175
176
177
178
	mode             = "mode_BB"
	knownBlock       = True
	block            = "NULL"
	pinned           = "yes"
	arity            = "variable"
	flags            = [ "labeled" ]
	attr_struct      = "block_attr"
	customSerializer = True
Moritz Kroll's avatar
Moritz Kroll committed
179
180

	init = '''
181
	res->attr.block.irg.irg     = irg;
Moritz Kroll's avatar
Moritz Kroll committed
182
183
	res->attr.block.backedge    = new_backedge_arr(irg->obst, arity);
	set_Block_matured(res, 1);
184
185

	/* Create and initialize array for Phi-node construction. */
186
187
188
	if (get_irg_phase_state(irg) == phase_building) {
		res->attr.block.graph_arr = NEW_ARR_D(ir_node *, irg->obst, irg->n_loc);
		memset(res->attr.block.graph_arr, 0, irg->n_loc * sizeof(ir_node*));
189
	}
190
	'''
191

192
class Borrow(Binop):
193
	"""Returns the borrow bit from and implied subtractions of its 2 operands"""
194
195
	flags = []

196
class Bound(Op):
197
198
	"""Performs a bounds-check: if lower <= index < upper then return index,
	otherwise throw an exception."""
199
200
201
202
203
204
	ins    = [
		("mem",    "memory dependency"),
		("index",  "value to test"),
		("lower",  "lower bound (inclusive)"),
		("upper",  "upper bound (exclusive)"),
	]
205
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
206
		("M",         "memory result"),
207
		("res",       "the checked index"),
Matthias Braun's avatar
Matthias Braun committed
208
209
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
210
	]
211
212
213
 	flags  = [ "fragile", "highlevel" ]
	pinned = "exception"
	pinned_init = "op_pin_state_pinned"
214
	throws_init = "false"
215
216
217
	attr_struct = "bound_attr"

class Builtin(Op):
218
	"""performs a backend-specific builtin."""
219
220
221
	ins      = [
		("mem", "memory dependency"),
	]
222
	arity    = "variable"
223
	outs     = [
224
225
		("M", "memory result"),
		# results follow here
226
	]
227
	flags    = [ "uses_memory" ]
228
	attrs    = [
229
		dict(
230
231
232
			type    = "ir_builtin_kind",
			name    = "kind",
			comment = "kind of builtin",
233
		),
234
		dict(
235
236
237
			type    = "ir_type*",
			name    = "type",
			comment = "method type for the builtin call",
238
		)
239
240
241
242
	]
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
	attr_struct = "builtin_attr"
243
	init   = '''
244
245
246
	assert((get_unknown_type() == type) || is_Method_type(type));
	'''

247
class Call(Op):
248
249
250
251
	"""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."""
252
253
254
255
	ins      = [
		("mem",   "memory dependency"),
		("ptr",   "pointer to called code"),
	]
256
	arity    = "variable"
257
	outs     = [
Matthias Braun's avatar
Matthias Braun committed
258
		("M",                "memory result"),
259
		("T_result",         "tuple containing all results"),
Matthias Braun's avatar
Matthias Braun committed
260
261
		("X_regular",        "control flow when no exception occurs"),
		("X_except",         "control flow when exception occured"),
262
	]
263
	flags    = [ "fragile", "uses_memory" ]
264
	attrs    = [
265
		dict(
266
267
268
			type    = "ir_type*",
			name    = "type",
			comment = "type of the call (usually type of the called procedure)",
269
270
271
272
273
		),
		dict(
			type = "unsigned",
			name = "tail_call",
			# the tail call attribute can only be set by analysis
274
			init = "0",
275
		)
276
277
278
279
	]
	attr_struct = "call_attr"
	pinned      = "memory"
	pinned_init = "op_pin_state_pinned"
280
	throws_init = "false"
281
282
	init = '''
	assert((get_unknown_type() == type) || is_Method_type(type));
283
	'''
284

285
class Carry(Binop):
286
287
	"""Computes the value of the carry-bit that would result when adding the 2
	operands"""
288
289
	flags = [ "commutative" ]

Michael Beck's avatar
Michael Beck committed
290
class Cast(Unop):
291
	"""perform a high-level type cast"""
292
293
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
294
295
	attrs    = [
		dict(
296
297
298
			type    = "ir_type*",
			name    = "type",
			comment = "target type of the case",
299
		)
300
301
	]
	attr_struct = "cast_attr"
302
	init     = "assert(is_atomic_type(type));"
303
304

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

class Cond(Op):
Matthias Braun's avatar
Matthias Braun committed
319
	"""Conditionally change control flow.
320
321
322
323
	Input:  A value of mode_b
	Output: A tuple of two control flows. The first is taken if the input is
	        false, the second if it is true.
	"""
324
325
326
	ins      = [
		("selector",  "condition parameter"),
	]
327
328
329
330
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
331
332
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
333
334
	attrs    = [
		dict(
335
336
337
338
			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
339
		),
340
	]
341
	attr_struct = "cond_attr"
342

Matthias Braun's avatar
Matthias Braun committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
class Switch(Op):
	"""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"

370
class Confirm(Op):
371
372
373
374
375
376
377
378
379
	"""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."""
380
381
382
383
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
384
385
386
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
387
388
	attrs    = [
		dict(
389
390
391
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
392
		),
393
394
395
396
	]
	attr_struct = "confirm_attr"

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

413
class Conv(Unop):
414
	"""Converts values between modes"""
415
	flags = []
416
417
	attrs = [
		dict(
418
419
420
421
			name    = "strict",
			type    = "int",
			init    = "0",
			comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
422
		)
423
424
425
426
	]
	attr_struct = "conv_attr"

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

451
class Div(Op):
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

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

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

class Eor(Binop):
506
	"""returns the result of a bitwise exclusive or operation of its operands"""
507
	flags    = [ "commutative" ]
508

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

class Id(Op):
534
	"""Returns its operand unchanged."""
535
536
537
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
538
539
540
541
	pinned = "no"
	flags  = []

class IJmp(Op):
542
543
544
	"""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"""
545
546
	mode     = "mode_X"
	pinned   = "yes"
547
548
549
	ins      = [
	   ("target", "target address of the jump"),
	]
550
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
551
552

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

class Jmp(Op):
577
	"""Jumps to the block connected through the out-value"""
578
579
580
581
582
583
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

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

class Minus(Unop):
628
	"""returns the difference between its operands"""
629
630
631
	flags = []

class Mod(Op):
632
633
634
635
636
637
638
639
	"""returns the remainder of its operands from an implied division.

	Examples:
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
640
641
642
643
644
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
645
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
646
		("M",         "memory result"),
647
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
648
649
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
650
	]
651
	flags = [ "fragile", "uses_memory" ]
652
	attrs = [
653
		dict(
654
655
656
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
657
		),
658
	]
659
	attr_struct = "mod_attr"
660
	pinned      = "exception"
661
	throws_init = "false"
662
663
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
664

665
class Mul(Binop):
666
	"""returns the product of its operands"""
667
668
669
	flags = [ "commutative" ]

class Mulh(Binop):
670
671
	"""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)"""
672
673
674
	flags = [ "commutative" ]

class Mux(Op):
675
676
	"""returns the false or true operand depending on the value of the sel
	operand"""
677
678
679
680
681
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
682
683
684
685
	flags  = []
	pinned = "no"

class NoMem(Op):
686
	"""Placeholder node for cases where you don't need any memory input"""
687
688
689
690
	mode          = "mode_M"
	flags         = [ "dump_noblock", "dump_noinput" ]
	pinned        = "yes"
	knownBlock    = True
691
	block         = "get_irg_start_block(irg)"
692
	singleton     = True
693
694

class Not(Unop):
695
696
697
	"""returns the logical complement of a value. Works for integer values too.
	If the input is false/zero then true/one is returned, otherwise false/zero
	is returned."""
698
699
700
	flags = []

class Or(Binop):
701
	"""returns the result of a bitwise or operation of its operands"""
702
703
704
	flags = [ "commutative" ]

class Phi(Op):
705
706
707
	"""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."""
708
709
710
711
	pinned        = "yes"
	arity         = "variable"
	flags         = []
	attr_struct   = "phi_attr"
712
713
714
	init          = '''
	res->attr.phi.u.backedge = new_backedge_arr(irg->obst, arity);'''
	init_after_opt = '''
Matthias Braun's avatar
Matthias Braun committed
715
716
	/* Memory Phis in endless loops must be kept alive.
	   As we can't distinguish these easily we keep all of them alive. */
717
718
	if (is_Phi(res) && mode == mode_M)
		add_End_keepalive(get_irg_end(irg), res);'''
719
720

class Pin(Op):
721
722
723
	"""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."""
724
725
726
	ins      = [
		("op", "value which is pinned"),
	]
727
728
729
730
731
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

class Proj(Op):
732
	"""returns an entry of a tuple value"""
733
734
735
	ins              = [
		("pred", "the tuple value from which a part is extracted"),
	]
736
737
738
739
740
741
742
	flags            = []
	pinned           = "no"
	knownBlock       = True
	knownGraph       = True
	block            = "get_nodes_block(irn_pred)"
	graph            = "get_irn_irg(irn_pred)"
	customSerializer = True
743
	attrs      = [
744
		dict(
745
746
747
			type    = "long",
			name    = "proj",
			comment = "number of tuple component to be extracted",
748
		),
749
	]
750
	attr_struct = "proj_attr"
751
752

class Raise(Op):
753
754
755
	"""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."""
756
757
758
759
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
760
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
761
762
		("M", "memory result"),
		("X", "control flow to exception handler"),
763
	]
764
765
766
767
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

class Return(Op):
768
769
	"""Returns from the current function. Takes memory and return values as
	operands."""
770
771
772
	ins      = [
		("mem", "memory dependency"),
	]
773
774
775
776
777
778
	arity    = "variable"
	mode     = "mode_X"
	flags    = [ "cfopcode" ]
	pinned   = "yes"

class Rotl(Binop):
779
780
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
781
782
783
	flags    = []

class Sel(Op):
784
785
	"""Computes the address of a entity of a compound type given the base
	address of an instance of the compound type."""
786
787
788
789
	ins    = [
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
790
791
792
793
	arity  = "variable"
	flags  = []
	mode   = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned = "no"
794
	attrs  = [
795
		dict(
796
797
798
			type    = "ir_entity*",
			name    = "entity",
			comment = "entity which is selected",
799
		)
800
801
802
803
	]
	attr_struct = "sel_attr"

class Shl(Binop):
804
805
	"""Returns its first operands bits shifted left by the amount of the 2nd
	operand"""
806
807
808
	flags = []

class Shr(Binop):
809
810
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. No special handling for the sign bit (zero extension)"""
811
812
813
	flags = []

class Shrs(Binop):
814
815
816
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
	(sign extension)"""
817
818
819
	flags = []

class Start(Op):
820
	"""The first node of a graph. Execution starts with this node."""
821
822
823
824
825
826
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
827
828
829
830
831
832
833
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	customSerializer = True
	block            = "get_irg_start_block(irg)"
834
835

class Store(Op):
836
	"""Stores a value into memory (heap or stack)."""
837
838
839
840
841
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
842
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
843
844
845
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
846
	]
847
848
849
850
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
851
	throws_init = "(flags & cons_throws_exception) != 0"
852
853
854
855
856
857
858
859
860
861
862
863
864
865
	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",
		),
		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",
		),
	]
866
	constructor_args = [
867
		dict(
868
869
870
			type    = "ir_cons_flags",
			name    = "flags",
			comment = "specifies alignment, volatility and pin state",
871
		),
872
873
874
	]

class Sub(Binop):
875
	"""returns the difference of its operands"""
876
877
878
	flags = []

class SymConst(Op):
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
	"""A symbolic constant.

	 - symconst_type_tag   The symbolic constant represents a type tag.  The
	                       type the tag stands for is given explicitly.
	 - 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."""
896
897
898
899
	mode       = "mode_P"
	flags      = [ "constlike", "start_block" ]
	knownBlock = True
	pinned     = "no"
900
	attrs      = [
901
		dict(
902
903
904
905
			type    = "ir_entity*",
			name    = "entity",
			noprop  = True,
			comment = "entity whose address is returned",
906
		)
907
908
	]
	attr_struct = "symconst_attr"
909
	customSerializer = True
910
911
912
	# constructor is written manually at the moment, because of the strange
	# union argument
	noconstructor = True
913
914

class Sync(Op):
915
916
917
918
919
	"""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."""
920
921
922
	mode     = "mode_M"
	flags    = []
	pinned   = "no"
923
	arity    = "dynamic"
924

925
class Tuple(Op):
926
927
928
929
930
931
932
	"""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
933
	just changing its opcode and giving it a new in array."""
934
935
936
937
938
939
	arity  = "variable"
	mode   = "mode_T"
	pinned = "no"
	flags  = [ "labeled" ]

class Unknown(Op):
940
941
	"""Returns an unknown (at compile- and runtime) value. It is a valid
	optimisation to replace an Unknown by any other constant value."""
942
943
944
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"
Matthias Braun's avatar
Matthias Braun committed
945
	flags      = [ "start_block", "constlike", "dump_noblock" ]
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961

# Prepare node list

def getOpList(namespace):
	nodes = []
	for t in namespace.values():
		if type(t) != type:
			continue

		if issubclass(t, Op):
			setnodedefaults(t)
			nodes.append(t)
	return nodes

nodes = getOpList(globals())
nodes = sorted(nodes, lambda x,y: cmp(x.name, y.name))