ir_spec.py 26.5 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
	attr_struct = "bound_attr"
216
	attrs_name  = "bound"
217
218

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

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

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

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

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

class Cond(Op):
320
321
322
323
324
325
326
327
328
329
330
331
332
	"""Conditionally change control flow. There are two versions of this node:

	Boolean Cond:
	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.

	Switch Cond:
	Input:  A value of mode_Iu
	Output: A tuple of n control flows. If the Cond's input is i, control flow
	will proceed along output i. If the input is >= n control flow proceeds
	along output def_proj.
	"""
333
334
335
	ins      = [
		("selector",  "condition parameter"),
	]
336
337
338
339
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
340
341
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
342
343
	attrs    = [
		dict(
344
345
346
347
			name    = "default_proj",
			type    = "long",
			init    = "0",
			comment = "Proj-number of default case for switch-Cond",
348
349
		),
		dict(
350
351
352
353
			name    = "jmp_pred",
			type    = "cond_jmp_predicate",
			init    = "COND_JMP_PRED_NONE",
			comment = "can indicate the most likely jump",
354
		)
355
	]
356
	attr_struct = "cond_attr"
357

358
class Confirm(Op):
359
360
361
362
363
364
365
366
367
	"""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."""
368
369
370
371
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
372
373
374
	mode     = "get_irn_mode(irn_value)"
	flags    = [ "highlevel" ]
	pinned   = "yes"
375
376
	attrs    = [
		dict(
377
378
379
			name    = "relation",
			type    = "ir_relation",
			comment = "relation of value to bound",
380
		),
381
382
	]
	attr_struct = "confirm_attr"
383
	attrs_name  = "confirm"
384
385

class Const(Op):
386
	"""Returns a constant value."""
387
	flags      = [ "constlike", "start_block" ]
388
389
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
390
391
	knownBlock = True
	pinned     = "no"
392
393
	attrs      = [
		dict(
394
395
396
			type    = "ir_tarval*",
			name    = "tarval",
			comment = "constant value (a tarval object)",
397
		)
398
399
	]
	attr_struct = "const_attr"
400
	attrs_name  = "con"
401

402
class Conv(Unop):
403
	"""Converts values between modes"""
404
	flags = []
405
406
	attrs = [
		dict(
407
408
409
410
			name    = "strict",
			type    = "int",
			init    = "0",
			comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
411
		)
412
413
	]
	attr_struct = "conv_attr"
414
	attrs_name  = "conv"
415
416

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

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

475
class Dummy(Op):
476
477
478
	"""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."""
479
480
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
481
482
483
484
485
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

class End(Op):
486
487
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
488
489
490
491
492
493
494
495
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
	flags            = [ "cfopcode" ]
	knownBlock       = True
	block            = "get_irg_end_block(irg)"
	singleton        = True
	customSerializer = True
496
497

class Eor(Binop):
498
	"""returns the result of a bitwise exclusive or operation of its operands"""
499
	flags    = [ "commutative" ]
500

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

class Id(Op):
526
	"""Returns its operand unchanged."""
527
528
529
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
530
531
532
533
	pinned = "no"
	flags  = []

class IJmp(Op):
534
535
536
	"""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"""
537
538
	mode     = "mode_X"
	pinned   = "yes"
539
540
541
	ins      = [
	   ("target", "target address of the jump"),
	]
542
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
543
544

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

class Jmp(Op):
569
	"""Jumps to the block connected through the out-value"""
570
571
572
573
574
575
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

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

class Minus(Unop):
620
	"""returns the difference between its operands"""
621
622
623
	flags = []

class Mod(Op):
624
625
626
627
628
629
630
631
	"""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
	"""
632
633
634
635
636
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
637
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
638
		("M",         "memory result"),
639
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
640
641
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
642
	]
643
	flags = [ "fragile", "uses_memory" ]
644
	attrs_name = "mod"
645
	attrs = [
646
		dict(
647
648
649
			type    = "ir_mode*",
			name    = "resmode",
			comment = "mode of the result",
650
		),
651
	]
652
	attr_struct = "mod_attr"
653
	pinned      = "exception"
654
	throws_init = "false"
655
656
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
657

658
class Mul(Binop):
659
	"""returns the product of its operands"""
660
661
662
	flags = [ "commutative" ]

class Mulh(Binop):
663
664
	"""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)"""
665
666
667
	flags = [ "commutative" ]

class Mux(Op):
668
669
	"""returns the false or true operand depending on the value of the sel
	operand"""
670
671
672
673
674
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
675
676
677
678
	flags  = []
	pinned = "no"

class NoMem(Op):
679
	"""Placeholder node for cases where you don't need any memory input"""
680
681
682
683
	mode          = "mode_M"
	flags         = [ "dump_noblock", "dump_noinput" ]
	pinned        = "yes"
	knownBlock    = True
684
	block         = "get_irg_start_block(irg)"
685
	singleton     = True
686
687

class Not(Unop):
688
689
690
	"""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."""
691
692
693
	flags = []

class Or(Binop):
694
	"""returns the result of a bitwise or operation of its operands"""
695
696
697
	flags = [ "commutative" ]

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

class Pin(Op):
714
715
716
	"""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."""
717
718
719
	ins      = [
		("op", "value which is pinned"),
	]
720
721
722
723
724
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

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

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

class Return(Op):
761
762
	"""Returns from the current function. Takes memory and return values as
	operands."""
763
764
765
	ins      = [
		("mem", "memory dependency"),
	]
766
767
768
769
770
771
	arity    = "variable"
	mode     = "mode_X"
	flags    = [ "cfopcode" ]
	pinned   = "yes"

class Rotl(Binop):
772
773
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
774
775
776
	flags    = []

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

class Shl(Binop):
797
798
	"""Returns its first operands bits shifted left by the amount of the 2nd
	operand"""
799
800
801
	flags = []

class Shr(Binop):
802
803
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. No special handling for the sign bit (zero extension)"""
804
805
806
	flags = []

class Shrs(Binop):
807
808
809
	"""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)"""
810
811
812
	flags = []

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

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

class Sub(Binop):
868
	"""returns the difference of its operands"""
869
870
871
	flags = []

class SymConst(Op):
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
	"""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."""
889
890
891
892
	mode       = "mode_P"
	flags      = [ "constlike", "start_block" ]
	knownBlock = True
	pinned     = "no"
893
	attrs      = [
894
		dict(
895
896
897
898
			type    = "ir_entity*",
			name    = "entity",
			noprop  = True,
			comment = "entity whose address is returned",
899
		)
900
901
	]
	attr_struct = "symconst_attr"
902
	customSerializer = True
903
904
905
	# constructor is written manually at the moment, because of the strange
	# union argument
	noconstructor = True
906
907

class Sync(Op):
908
909
910
911
912
	"""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."""
913
914
915
	mode     = "mode_M"
	flags    = []
	pinned   = "no"
916
	arity    = "dynamic"
917

918
class Tuple(Op):
919
920
921
922
923
924
925
	"""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
926
	just changing its opcode and giving it a new in array."""
927
928
929
930
931
932
	arity  = "variable"
	mode   = "mode_T"
	pinned = "no"
	flags  = [ "labeled" ]

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

# 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))