ir_spec.py 26 KB
Newer Older
1
2
3
# This file is part of libFirm.
# Copyright (C) 2012 Karlsruhe Institute of Technology.
#
Matthias Braun's avatar
Matthias Braun committed
4
5
6
# Firm node specifications
# The comments are in (standard python) restructured text format and are used
# to generate documentation.
7
from spec_util import abstract, op, Attribute
8

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

Matthias Braun's avatar
Matthias Braun committed
11
12
13
@abstract
@op
class Binop(object):
14
	"""Binary nodes have exactly 2 inputs"""
15
	name     = "binop"
16
	ins      = [
17
18
		("left",   "first operand"),
		("right", "second operand"),
19
	]
20
21
	op_index       = 0
	arity_override = "oparity_binary"
22

23
24
25
26
27
28
29
@abstract
@op
class EntConst(object):
	"""Symbolic constant that represents an aspect of an entity"""
	name       = "entconst"
	flags      = [ "constlike", "start_block" ]
	attrs      = [
30
		Attribute("entity", type="ir_entity*", comment="entity to operate on"),
31
32
33
34
	]
	attr_struct = "entconst_attr"
	attrs_name  = "entc"

35
36
@abstract
@op
37
class TypeConst(object):
38
39
40
41
	"""A symbolic constant that represents an aspect of a type"""
	name       = "typeconst"
	flags      = [ "constlike", "start_block" ]
	attrs      = [
42
		Attribute("type", type="ir_type*", comment="type to operate on"),
43
44
45
46
	]
	attr_struct = "typeconst_attr"
	attrs_name  = "typec"

Matthias Braun's avatar
Matthias Braun committed
47
@op
48
class Add(Binop):
49
	"""returns the sum of its operands"""
50
	flags = [ "commutative" ]
51

52
53
54
@op
class Address(EntConst):
	"""Symbolic constant that represents the address of an entity (variable or method)"""
55
	mode = "mode_P"
56

57
58
59
60
@op
class Align(TypeConst):
	"""A symbolic constant that represents the alignment of a type"""

Matthias Braun's avatar
Matthias Braun committed
61
62
@op
class Alloc:
63
64
65
66
	"""Allocates a block of memory on the stack."""
	ins = [
		("mem",  "memory dependency" ),
		("size", "size of the block in bytes" ),
67
	]
68
69
70
	outs = [
		("M",   "memory result"),
		("res", "pointer to newly allocated memory"),
71
	]
72
	attrs = [
73
74
		Attribute("alignment", type="unsigned",
		          comment="alignment of the memory block (must be a power of 2)"),
75
	]
76
	flags       = [ "uses_memory", "const_memory" ]
77
	pinned      = "yes"
78
79
	attr_struct = "alloc_attr"

Matthias Braun's avatar
Matthias Braun committed
80
81
@op
class Anchor:
82
	"""Utility node used to "hold" nodes in a graph that might possibly not be
83
84
85
	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
86
	known. All other well-known graph-nodes like Start, End, NoMem, ...
87
	are found by looking at the respective Anchor operand."""
88
89
90
91
92
93
94
95
96
97
	ins = [
		("end_block",   "block the end node belongs to" ),
		("start_block", "block the start node belongs to" ),
		("end",         "end node of this ir_graph" ),
		("start",       "start node of this ir_graph" ),
		("frame",       "frame of this ir_graph" ),
		("initial_mem", "initial memory of this ir_graph" ),
		("args",        "argument proj of the start node" ),
		("no_mem",      "the only NoMem node of this ir_graph" ),
	]
98
99
100
101
	mode             = "mode_ANY"
	flags            = [ "dump_noblock" ]
	pinned           = "yes"
	singleton        = True
102
	constructor      = False
103
	customSerializer = True
104

Matthias Braun's avatar
Matthias Braun committed
105
@op
106
class And(Binop):
107
	"""returns the result of a bitwise and operation of its operands"""
108
109
	flags    = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
110
111
@op
class ASM:
Matthias Braun's avatar
Matthias Braun committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
	"""executes assembler fragments of the target machine.

	The node contains a template for an assembler snippet. The compiler will
	replace occurences of %0 to %9 with input/output registers,
	%% with a single % char. Some backends allow additional specifiers (for
	example %w3, %l3, %h3 on x86 to get a 16bit, 8hit low, 8bit high part
	of a register).
	After the replacements the text is emitted into the final assembly.

	The clobber list contains names of registers which have an undefined value
	after the assembler instruction is executed; it may also contain 'memory'
	or 'cc' if global state/memory changes or the condition code registers
	(some backends implicitely set cc, memory clobbers on all ASM statements).

	Example (an i386 instruction)::

		ASM(text="btsl %1, %0",
			input_constraints = ["=m", "r"],
			clobbers = ["cc"])

	As there are no output, the %0 references the first input which is just an
	address which the asm operation writes to. %1 references to an input which
	is passed as a register. The condition code register has an unknown value
	after the instruction.

	(This format is inspired by the gcc extended asm syntax)
	"""
139
140
	mode             = "mode_T"
	arity            = "variable"
141
	input_name       = "input"
142
	flags            = [ "keep", "uses_memory" ]
143
	pinned           = "exception"
144
145
146
147
	pinned_init      = "op_pin_state_pinned"
	attr_struct      = "asm_attr"
	attrs_name       = "assem"
	customSerializer = True
148
149
150
	ins   = [
		("mem",    "memory dependency"),
	]
151
	attrs = [
152
153
154
155
156
157
158
159
160
161
162
		Attribute("input_constraints", type="ir_asm_constraint*",
		          comment="input constraints"),
		Attribute("n_output_constraints", type="size_t", noprop=True,
		          comment="number of output constraints"),
		Attribute("output_constraints", type="ir_asm_constraint*",
		          comment="output constraints"),
		Attribute("n_clobbers", type="size_t", noprop=True,
		          comment="number of clobbered registers/memory"),
		Attribute("clobbers", type="ident**",
		          comment="list of clobbered registers/memory"),
		Attribute("text", type="ident*", comment="assembler text"),
163
164
165
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
166
	constructor = False
167

Matthias Braun's avatar
Matthias Braun committed
168
169
@op
class Bad:
170
171
172
173
174
175
	"""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).
176
	Optimizations also set block predecessors to Bad when it becomes clear,
177
178
	that a control flow edge can never be executed.

179
	The gigo optimizations ensures that nodes with Bad as their block, get
Christoph Mallon's avatar
Christoph Mallon committed
180
	replaced by Bad themselves. Nodes with at least 1 Bad input get exchanged
181
182
183
184
	with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
	This is because removing inputs from a Block is hairy operation (requiring,
	Phis to be shortened too for example). So instead of removing block inputs
	they are set to Bad, and the actual removal is left to the control flow
185
	optimization phase. Block, Phi, Tuple with only Bad inputs however are
186
187
188
189
	replaced by Bad right away.

	In the future we may use the Bad node to model poison values that arise
	from undefined behaviour like reading uninitialized local variables in C."""
Matthias Braun's avatar
Matthias Braun committed
190
	flags         = [ "start_block", "dump_noblock" ]
191
	pinned        = "yes"
192

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

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

	init = '''
220
	res->attr.block.backedge    = new_backedge_arr(get_irg_obstack(irg), arity);
Moritz Kroll's avatar
Moritz Kroll committed
221
	set_Block_matured(res, 1);
222
223

	/* Create and initialize array for Phi-node construction. */
224
	if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION)) {
225
		res->attr.block.graph_arr = NEW_ARR_DZ(ir_node*, get_irg_obstack(irg), irg->n_loc);
226
	}
227
	'''
228

Matthias Braun's avatar
Matthias Braun committed
229
230
@op
class Builtin:
231
	"""performs a backend-specific builtin."""
232
	ins         = [
233
234
		("mem", "memory dependency"),
	]
235
236
237
	arity       = "variable"
	input_name  = "param"
	outs        = [
238
239
		("M", "memory result"),
		# results follow here
240
	]
241
	mode        = "mode_T"
242
243
	flags       = [ "uses_memory" ]
	attrs       = [
244
245
246
		Attribute("kind", type="ir_builtin_kind", comment="kind of builtin"),
		Attribute("type", type="ir_type*",
		          comment="method type for the builtin call"),
247
	]
248
	pinned      = "exception"
249
250
	pinned_init = "op_pin_state_pinned"
	attr_struct = "builtin_attr"
251
	init        = '''
252
253
254
	assert((get_unknown_type() == type) || is_Method_type(type));
	'''

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

Matthias Braun's avatar
Matthias Braun committed
286
@op
287
class Cmp(Binop):
288
	"""Compares its two operands and checks whether a specified
289
	   relation (like less or equal) is fulfilled."""
290
	flags = []
291
292
	mode  = "mode_b"
	attrs = [
293
294
		Attribute("relation", type="ir_relation",
		          comment="Comparison relation"),
295
296
	]
	attr_struct = "cmp_attr"
297

Matthias Braun's avatar
Matthias Braun committed
298
299
@op
class Cond:
300
	"""Conditionally change control flow."""
301
302
303
	ins      = [
		("selector",  "condition parameter"),
	]
304
305
306
307
	outs     = [
		("false", "control flow if operand is \"false\""),
		("true",  "control flow if operand is \"true\""),
	]
308
309
	flags    = [ "cfopcode", "forking" ]
	pinned   = "yes"
310
	attrs    = [
311
312
313
		Attribute("jmp_pred", type="cond_jmp_predicate",
		          init="COND_JMP_PRED_NONE",
		          comment = "can indicate the most likely jump"),
314
	]
315
	attr_struct = "cond_attr"
316

Matthias Braun's avatar
Matthias Braun committed
317
318
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
319
320
321
322
323
324
325
326
327
	"""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"),
	]
328
	mode   = "mode_T"
Matthias Braun's avatar
Matthias Braun committed
329
330
331
	flags  = [ "cfopcode", "forking" ]
	pinned = "yes"
	attrs  = [
332
333
334
335
		Attribute("n_outs", type="unsigned",
		          comment="number of outputs (including pn_Switch_default)"),
		Attribute("table", type="ir_switch_table*",
		          comment="table describing mapping from input values to Proj numbers"),
Matthias Braun's avatar
Matthias Braun committed
336
337
338
339
	]
	attr_struct = "switch_attr"
	attrs_name  = "switcha"

Matthias Braun's avatar
Matthias Braun committed
340
341
@op
class Confirm:
342
343
344
345
346
347
348
349
350
	"""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."""
351
352
353
354
	ins      = [
		("value",  "value to express a constraint for"),
		("bound",  "value to compare against"),
	]
355
	mode     = "get_irn_mode(irn_value)"
Matthias Braun's avatar
Matthias Braun committed
356
	flags    = [ ]
357
	pinned   = "yes"
358
	attrs    = [
359
360
		Attribute("relation", type="ir_relation",
		          comment="relation of value to bound"),
361
362
363
	]
	attr_struct = "confirm_attr"

Matthias Braun's avatar
Matthias Braun committed
364
365
@op
class Const:
366
	"""Returns a constant value."""
367
	flags      = [ "constlike", "start_block" ]
368
	mode       = "get_tarval_mode(tarval)"
369
	attrs      = [
370
371
		Attribute("tarval", type="ir_tarval*",
		          comment="constant value (a tarval object)"),
372
373
	]
	attr_struct = "const_attr"
374
	attrs_name  = "con"
375

Matthias Braun's avatar
Matthias Braun committed
376
@op
377
class Conv:
378
	"""Converts values between modes"""
379
380
381
382
	flags  = []
	ins    = [
		("op", "operand")
	]
383

Matthias Braun's avatar
Matthias Braun committed
384
385
386
387
388
389
390
391
392
@op
class Bitcast:
	"""Converts a value between modes with different arithmetics but same
	number of bits by reinterpreting the bits in the new mode"""
	flags = []
	ins = [
		("op", "operand")
	]

Matthias Braun's avatar
Matthias Braun committed
393
394
@op
class CopyB:
Matthias Braun's avatar
Matthias Braun committed
395
	"""Copies a block of memory with statically known size/type."""
396
397
398
399
400
	ins   = [
		("mem",  "memory dependency"),
		("dst",  "destination address"),
		("src",  "source address"),
	]
401
402
	mode  = "mode_M"
	flags = [ "uses_memory" ]
403
	attrs = [
404
405
406
407
408
		Attribute("type", type="ir_type*", comment="type of copied data"),
		Attribute("volatility", type="ir_volatility",
		          init="flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
		          to_flags="%s == volatility_is_volatile ? cons_volatile : cons_none",
		          comment="volatile CopyB nodes have a visible side-effect and may not be optimized"),
409
410
	]
	attr_struct = "copyb_attr"
411
	constructor_args = [
412
413
		Attribute("flags", type="ir_cons_flags",
		          comment="specifies volatility"),
414
	]
415

Matthias Braun's avatar
Matthias Braun committed
416
417
@op
class Div:
418
	"""returns the quotient of its 2 operands"""
419
420
421
422
423
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
424
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
425
		("M",         "memory result"),
426
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
427
428
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
429
	]
430
	flags = [ "fragile", "uses_memory", "const_memory" ]
431
	attrs = [
432
433
434
		Attribute("resmode", type="ir_mode*",
		          comment="mode of the result value"),
		Attribute("no_remainder", type="int", init="0"),
435
	]
436
	attr_struct = "div_attr"
437
	pinned      = "exception"
438
	throws_init = "false"
439
440
	op_index    = 1
	arity_override = "oparity_binary"
441

Matthias Braun's avatar
Matthias Braun committed
442
443
@op
class Dummy:
444
445
446
	"""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."""
447
448
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
449
450
	pinned     = "yes"

Matthias Braun's avatar
Matthias Braun committed
451
452
@op
class End:
453
454
	"""Last node of a graph. It references nodes in endless loops (so called
	keepalive edges)"""
455
456
457
	mode             = "mode_X"
	pinned           = "yes"
	arity            = "dynamic"
458
	input_name       = "keepalive"
459
460
461
	flags            = [ "cfopcode" ]
	block            = "get_irg_end_block(irg)"
	singleton        = True
462

Matthias Braun's avatar
Matthias Braun committed
463
@op
464
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
465
466
467
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
468
	flags    = [ "commutative" ]
469

Matthias Braun's avatar
Matthias Braun committed
470
471
@op
class Free:
472
	"""Frees a block of memory previously allocated by an Alloc node"""
473
474
475
	ins = [
		("mem", "memory dependency" ),
		("ptr", "pointer to the object to free"),
476
	]
477
	mode   = "mode_M"
478
	flags  = [ "uses_memory", "const_memory" ]
479
480
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
481
482
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
483
484
485
486
	"""Returns its operand unchanged.

	This is mainly used when exchanging nodes. Usually you shouldn't see Id
	nodes since the getters/setters for node inputs skip them automatically."""
487
488
489
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
490
491
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
492
493
@op
class IJmp:
494
495
496
	"""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"""
497
498
	mode     = "mode_X"
	pinned   = "yes"
499
500
501
	ins      = [
	   ("target", "target address of the jump"),
	]
502
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
503

Matthias Braun's avatar
Matthias Braun committed
504
505
@op
class Jmp:
506
	"""Jumps to the block connected through the out-value"""
507
508
509
510
511
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

Matthias Braun's avatar
Matthias Braun committed
512
513
@op
class Load:
514
	"""Loads a value from memory (heap or stack)."""
515
516
517
518
	ins   = [
		("mem", "memory dependency"),
		("ptr",  "address to load from"),
	]
519
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
520
		("M",         "memory result"),
521
		("res",       "result of load operation"),
Matthias Braun's avatar
Matthias Braun committed
522
523
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
524
	]
525
	flags    = [ "fragile", "uses_memory", "const_memory" ]
526
	pinned   = "exception"
527
	attrs    = [
528
529
		Attribute("mode", type="ir_mode*",
		          comment="mode of the value to be loaded"),
530
531
                Attribute("type", type="ir_type*",
                          comment="The type of the object which is stored at ptr (need not match with mode)"),
532
533
534
535
536
537
538
539
		Attribute("volatility", type="ir_volatility",
		          init="flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
		          to_flags="%s == volatility_is_volatile ? cons_volatile : cons_none",
		          comment="volatile loads are a visible side-effect and may not be optimized"),
		Attribute("unaligned", type="ir_align",
		          init="flags & cons_unaligned ? align_non_aligned : align_is_aligned",
		          to_flags="%s == align_non_aligned ? cons_unaligned : cons_none",
		          comment="pointers to unaligned loads don't need to respect the load-mode/type alignments"),
540
541
	]
	attr_struct = "load_attr"
542
	constructor_args = [
543
544
		Attribute("flags", type="ir_cons_flags",
		          comment="specifies alignment, volatility and pin state"),
545
	]
546
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
547
	throws_init = "(flags & cons_throws_exception) != 0"
548

Matthias Braun's avatar
Matthias Braun committed
549
@op
550
class Minus:
Andreas Seltenreich's avatar
Andreas Seltenreich committed
551
	"""returns the additive inverse of its operand"""
552
553
554
555
	flags  = []
	ins    = [
		("op", "operand")
	]
556

Matthias Braun's avatar
Matthias Braun committed
557
558
@op
class Mod:
559
560
561
	"""returns the remainder of its operands from an implied division.

	Examples:
562

563
564
565
566
567
	* mod(5,3)   produces 2
	* mod(5,-3)  produces 2
	* mod(-5,3)  produces -2
	* mod(-5,-3) produces -2
	"""
568
569
570
571
572
	ins   = [
		("mem",   "memory dependency"),
		("left",  "first operand"),
		("right", "second operand"),
	]
573
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
574
		("M",         "memory result"),
575
		("res",       "result of computation"),
Matthias Braun's avatar
Matthias Braun committed
576
577
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
578
	]
579
	flags = [ "fragile", "uses_memory", "const_memory" ]
580
	attrs = [
581
		Attribute("resmode", type="ir_mode*", comment="mode of the result"),
582
	]
583
	attr_struct = "mod_attr"
584
	pinned      = "exception"
585
	throws_init = "false"
586
587
	op_index    = 1
	arity_override = "oparity_binary"
Matthias Braun's avatar
Matthias Braun committed
588

589
class Mul(Binop):
590
	"""returns the product of its operands"""
591
592
593
	flags = [ "commutative" ]

class Mulh(Binop):
594
595
	"""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)"""
596
597
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
598
599
@op
class Mux:
600
601
	"""returns the false or true operand depending on the value of the sel
	operand"""
602
603
604
605
606
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
607
608
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
609
610
@op
class NoMem:
611
	"""Placeholder node for cases where you don't need any memory input"""
612
	mode          = "mode_M"
613
	flags         = [ "dump_noblock", "start_block" ]
614
615
	pinned        = "yes"
	singleton     = True
616

Matthias Braun's avatar
Matthias Braun committed
617
@op
618
class Not:
619
	"""returns the bitwise complement of a value. Works for boolean values, too."""
620
621
622
623
	flags  = []
	ins    = [
		("op", "operand")
	]
624

625
626
627
628
@op
class Offset(EntConst):
	"""Symbolic constant that represents the offset of an entity in its owner type."""

Matthias Braun's avatar
Matthias Braun committed
629
@op
630
class Or(Binop):
631
	"""returns the result of a bitwise or operation of its operands"""
632
633
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
634
635
@op
class Phi:
636
637
638
	"""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."""
639
640
	pinned        = "yes"
	arity         = "variable"
641
	input_name    = "pred"
642
	flags         = []
643
644
645
646
	attrs         = [
		Attribute("loop", type="int", init="0",
		          comment="wether Phi represents the observable effect of a (possibly) nonterminating loop"),
	]
647
	attr_struct   = "phi_attr"
648
	init          = '''
649
	res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
Matthias Braun's avatar
Matthias Braun committed
650
	customSerializer = True
651

Matthias Braun's avatar
Matthias Braun committed
652
653
@op
class Pin:
654
655
656
	"""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."""
657
658
659
	ins      = [
		("op", "value which is pinned"),
	]
660
	mode     = "get_irn_mode(irn_op)"
Matthias Braun's avatar
Matthias Braun committed
661
	flags    = [ ]
662
663
	pinned   = "yes"

Matthias Braun's avatar
Matthias Braun committed
664
665
@op
class Proj:
666
	"""returns an entry of a tuple value"""
667
	ins        = [
668
669
		("pred", "the tuple value from which a part is extracted"),
	]
670
671
	flags      = []
	block      = "get_nodes_block(irn_pred)"
672
	usesGraph  = False
673
	attrs      = [
674
		Attribute("num", type="unsigned",
675
		          comment="number of tuple component to be extracted"),
676
	]
677
	attr_struct = "proj_attr"
678

Matthias Braun's avatar
Matthias Braun committed
679
680
@op
class Raise:
681
682
683
	"""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."""
684
685
686
687
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
688
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
689
690
		("M", "memory result"),
		("X", "control flow to exception handler"),
691
	]
Matthias Braun's avatar
Matthias Braun committed
692
	flags  = [ "cfopcode" ]
693
694
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
695
696
@op
class Return:
697
698
	"""Returns from the current function. Takes memory and return values as
	operands."""
699
	ins        = [
700
701
		("mem", "memory dependency"),
	]
702
703
704
705
706
	arity      = "variable"
	input_name = "res"
	mode       = "mode_X"
	flags      = [ "cfopcode" ]
	pinned     = "yes"
707

Matthias Braun's avatar
Matthias Braun committed
708
709
@op
class Sel:
710
711
	"""Computes the address of an array element from the array base pointer and
	an index.
712

713
714
715
716
717
718
	A Sel node must only produce a NULL pointer if the ptr input is NULL."""
	ins = [
		("ptr",   "pointer to array to select from"),
		("index", "index to select"),
	]
	flags  = []
719
	mode   = "mode_P"
720
721
722
723
724
725
726
727
728
729
730
731
732
	attrs  = [
		Attribute("type", type="ir_type*",
		          comment="array type"),
	]
	attr_struct = "sel_attr"

@op
class Member:
	"""Computes the address of a compound type member given the base address
	of an instance of the compound type.

	A Member node must only produce a NULL pointer if the ptr input is NULL."""
	ins = [
733
734
		("ptr", "pointer to object to select from"),
	]
735
	flags   = []
736
	mode    = "mode_P"
737
	attrs   = [
738
739
		Attribute("entity", type="ir_entity*",
		          comment="entity which is selected"),
740
	]
741
	attr_struct = "member_attr"
742

Matthias Braun's avatar
Matthias Braun committed
743
@op
744
class Shl(Binop):
745
	"""Returns its first operands bits shifted left by the amount of the 2nd
746
747
748
749
	operand.
	The right input (shift amount) must be an unsigned integer value.
	If the result mode has modulo_shift!=0, then the effective shift amount is
	the right input modulo this modulo_shift amount."""
750
751
	flags = []

Matthias Braun's avatar
Matthias Braun committed
752
@op
753
class Shr(Binop):
754
	"""Returns its first operands bits shifted right by the amount of the 2nd
755
756
757
758
	operand. No special handling for the sign bit is performed (zero extension).
	The right input (shift amount) must be an unsigned integer value.
	If the result mode has modulo_shift!=0, then the effective shift amount is
	the right input modulo this modulo_shift amount."""
759
760
	flags = []

Matthias Braun's avatar
Matthias Braun committed
761
@op
762
class Shrs(Binop):
763
764
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
765
766
767
768
	(sign extension).
	The right input (shift amount) must be an unsigned integer value.
	If the result mode has modulo_shift!=0, then the effective shift amount is
	the right input modulo this modulo_shift amount."""
769
770
	flags = []

Matthias Braun's avatar
Matthias Braun committed
771
772
@op
class Start:
773
	"""The first node of a graph. Execution starts with this node."""
774
	outs = [
775
776
777
778
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
779
780
781
782
	mode      = "mode_T"
	pinned    = "yes"
	flags     = [ "start_block" ]
	singleton = True
783

Matthias Braun's avatar
Matthias Braun committed
784
785
@op
class Store:
786
	"""Stores a value into memory (heap or stack)."""
787
788
789
790
791
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
792
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
793
794
795
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
796
	]
797
798
799
800
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
801
	throws_init = "(flags & cons_throws_exception) != 0"
802
	attrs = [
803
804
                Attribute("type", type="ir_type*",
                          comment="The type of the object which is stored at ptr (need not match with value's type)"),
805
806
807
808
809
810
811
812
		Attribute("volatility", type="ir_volatility",
		          init="flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
		          to_flags="%s == volatility_is_volatile ? cons_volatile : cons_none",
		          comment="volatile stores are a visible side-effect and may not be optimized"),
		Attribute("unaligned", type="ir_align",
		          init="flags & cons_unaligned ? align_non_aligned : align_is_aligned",
		          to_flags="%s == align_non_aligned ? cons_unaligned : cons_none",
		          comment="pointers to unaligned stores don't need to respect the load-mode/type alignments"),
813
	]
814
	constructor_args = [
815
816
		Attribute("flags", type="ir_cons_flags",
		          comment="specifies alignment, volatility and pin state"),
817
818
	]

Matthias Braun's avatar
Matthias Braun committed
819
@op
820
class Sub(Binop):
821
	"""returns the difference of its operands"""
822
823
	flags = []

824
@op
825
826
class Size(TypeConst):
	"""A symbolic constant that represents the size of a type"""
827

Matthias Braun's avatar
Matthias Braun committed
828
829
@op
class Sync:
830
831
832
833
834
	"""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."""
835
836
837
838
	mode       = "mode_M"
	flags      = []
	arity      = "dynamic"
	input_name = "pred"
839

Matthias Braun's avatar
Matthias Braun committed
840
841
@op
class Tuple:
842
843
844
845
846
847
848
	"""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
849
	just changing its opcode and giving it a new in array."""
850
851
852
853
	arity      = "variable"
	input_name = "pred"
	mode       = "mode_T"
	flags      = []
854

Matthias Braun's avatar
Matthias Braun committed
855
856
@op
class Unknown:
857
	"""Returns an unknown (at compile- and runtime) value. It is a valid
Matthias Braun's avatar
Matthias Braun committed
858
859
	optimization to replace an Unknown by any other constant value.

Matthias Braun's avatar
Matthias Braun committed
860
	Be careful when optimising Unknown values, you cannot simply replace
Matthias Braun's avatar
Matthias Braun committed
861
862
	Unknown+x or Unknown<x with a new Unknown node if there are multiple
	users of the original unknown node!"""
863
	pinned     = "yes"
Matthias Braun's avatar
Matthias Braun committed
864
	flags      = [ "start_block", "constlike", "dump_noblock" ]