ir_spec.py 27.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
41
42
43
44
45
	outs  = [
		("M",         "memory result",                         "pn_Generic_M"),
		("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
		("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
		("res",       "pointer to newly allocated memory",     "pn_Generic_other"),
	]
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
60
61
62
	pinned      = "yes"
	attr_struct = "alloc_attr"

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

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

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

class Bad(Op):
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
	"""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."""
149
	mode          = "mode_T"
150
151
152
	flags         = [ "cfopcode", "start_block", "dump_noblock" ]
	pinned        = "yes"
	knownBlock    = True
153
	block         = "get_irg_start_block(irg)"
154
155
	singleton     = True
	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
206
207
208
209
210
	outs  = [
		("M",         "memory result",                         "pn_Generic_M"),
		("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
		("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
		("res",       "the checked index",                     "pn_Generic_other"),
	]
211
212
213
214
 	flags  = [ "fragile", "highlevel" ]
	pinned = "exception"
	pinned_init = "op_pin_state_pinned"
	attr_struct = "bound_attr"
215
	attrs_name  = "bound"
216
217

class Builtin(Op):
218
	"""performs a backend-specific builtin."""
219
220
221
	ins      = [
		("mem", "memory dependency"),
	]
222
	arity    = "variable"
223
224
225
226
	outs     = [
		("M",        "memory result", "pn_Generic_M"),
		("1_result", "first result",  "pn_Generic_other"),
	]
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
258
259
260
261
262
263
	outs     = [
		("M",                "memory result",                         "pn_Generic_M"),
		("X_regular",        "control flow when no exception occurs", "pn_Generic_X_regular"),
		("X_except",         "control flow when exception occured",   "pn_Generic_X_except"),
		("T_result",         "tuple containing all results",          "pn_Generic_other"),
		("P_value_res_base", "pointer to memory register containing copied results passed by value"),
	]
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
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):
319
320
321
322
323
324
325
326
327
328
329
330
331
	"""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.
	"""
332
333
334
	ins      = [
		("selector",  "condition parameter"),
	]
335
336
337
338
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
339
340
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
341
342
	attrs    = [
		dict(
343
344
345
346
			name    = "default_proj",
			type    = "long",
			init    = "0",
			comment = "Proj-number of default case for switch-Cond",
347
348
		),
		dict(
349
350
351
352
			name    = "jmp_pred",
			type    = "cond_jmp_predicate",
			init    = "COND_JMP_PRED_NONE",
			comment = "can indicate the most likely jump",
353
		)
354
	]
355
	attr_struct = "cond_attr"
356

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

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

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

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

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

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

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

class Eor(Binop):
495
	"""returns the result of a bitwise exclusive or operation of its operands"""
496
	flags    = [ "commutative" ]
497

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

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

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

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

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

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

class Minus(Unop):
616
	"""returns the difference between its operands"""
617
618
619
	flags = []

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

653
class Mul(Binop):
654
	"""returns the product of its operands"""
655
656
657
	flags = [ "commutative" ]

class Mulh(Binop):
658
659
	"""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)"""
660
661
662
	flags = [ "commutative" ]

class Mux(Op):
663
664
	"""returns the false or true operand depending on the value of the sel
	operand"""
665
666
667
668
669
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
670
671
672
673
	flags  = []
	pinned = "no"

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

class Not(Unop):
683
684
685
	"""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."""
686
687
688
	flags = []

class Or(Binop):
689
	"""returns the result of a bitwise or operation of its operands"""
690
691
692
	flags = [ "commutative" ]

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

class Pin(Op):
709
710
711
	"""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."""
712
713
714
	ins      = [
		("op", "value which is pinned"),
	]
715
716
717
718
719
	mode     = "get_irn_mode(irn_op)"
	flags    = [ "highlevel" ]
	pinned   = "yes"

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

class Raise(Op):
741
742
743
	"""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."""
744
745
746
747
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
748
749
750
751
	outs  = [
		("M", "memory result",                     "pn_Generic_M"),
		("X", "control flow to exception handler", "pn_Generic_X_regular"),
	]
752
753
754
755
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

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

class Rotl(Binop):
767
768
	"""Returns its first operand bits rotated left by the amount in the 2nd
	operand"""
769
770
771
	flags    = []

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

class Shl(Binop):
792
793
	"""Returns its first operands bits shifted left by the amount of the 2nd
	operand"""
794
795
796
	flags = []

class Shr(Binop):
797
798
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. No special handling for the sign bit (zero extension)"""
799
800
801
	flags = []

class Shrs(Binop):
802
803
804
	"""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)"""
805
806
807
	flags = []

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

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

class Sub(Binop):
863
	"""returns the difference of its operands"""
864
865
866
	flags = []

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

class Sync(Op):
903
904
905
906
907
	"""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."""
908
909
910
	mode     = "mode_M"
	flags    = []
	pinned   = "no"
911
	arity    = "dynamic"
912

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

class Unknown(Op):
928
929
	"""Returns an unknown (at compile- and runtime) value. It is a valid
	optimisation to replace an Unknown by any other constant value."""
930
931
932
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"
933
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949

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