ir_spec.py 25.8 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
22
	op_index       = 0
	pinned         = "no"
	arity_override = "oparity_binary"
23

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

39
40
@abstract
@op
41
class TypeConst(object):
42
43
44
45
46
47
48
	"""A symbolic constant that represents an aspect of a type"""
	name       = "typeconst"
	flags      = [ "constlike", "start_block" ]
	block      = "get_irg_start_block(irg)"
	knownBlock = True
	pinned     = "no"
	attrs      = [
49
		Attribute("type", type="ir_type*", comment="type to operate on"),
50
51
52
53
	]
	attr_struct = "typeconst_attr"
	attrs_name  = "typec"

Matthias Braun's avatar
Matthias Braun committed
54
@op
55
class Add(Binop):
56
	"""returns the sum of its operands"""
57
	flags = [ "commutative" ]
58

59
60
61
@op
class Address(EntConst):
	"""Symbolic constant that represents the address of an entity (variable or method)"""
62
	mode = "get_type_pointer_mode(get_entity_type(entity))"
63

64
65
66
67
@op
class Align(TypeConst):
	"""A symbolic constant that represents the alignment of a type"""

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

Matthias Braun's avatar
Matthias Braun committed
87
88
@op
class Anchor:
89
90
91
92
93
94
	"""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."""
95
96
97
98
99
100
101
102
103
	mode             = "mode_ANY"
	arity            = "variable"
	flags            = [ "dump_noblock" ]
	pinned           = "yes"
	attr_struct      = "irg_attr"
	knownBlock       = True
	singleton        = True
	noconstructor    = True
	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
166
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
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
192
	pinned        = "yes"
	knownBlock    = True
193
	block         = "get_irg_start_block(irg)"
194
	attr_struct   = "bad_attr"
195
	init = '''
196
	res->attr.bad.irg.irg = irg;
197
198
	'''

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
293
@op
294
class Cmp(Binop):
295
	"""Compares its two operands and checks whether a specified
296
	   relation (like less or equal) is fulfilled."""
297
	flags = []
298
299
	mode  = "mode_b"
	attrs = [
300
301
		Attribute("relation", type="ir_relation",
		          comment="Comparison relation"),
302
303
	]
	attr_struct = "cmp_attr"
304

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

Matthias Braun's avatar
Matthias Braun committed
324
325
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
326
327
328
329
330
331
332
333
334
335
336
337
	"""Change control flow. The destination is choosen based on an integer input value which is looked up in a table.

	Backends can implement this efficiently using a jump table."""
	ins    = [
		("selector", "input selector"),
	]
	outs   = [
		("default", "control flow if no other case matches"),
	]
	flags  = [ "cfopcode", "forking" ]
	pinned = "yes"
	attrs  = [
338
339
340
341
		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
342
343
344
345
	]
	attr_struct = "switch_attr"
	attrs_name  = "switcha"

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

Matthias Braun's avatar
Matthias Braun committed
370
371
@op
class Const:
372
	"""Returns a constant value."""
373
	flags      = [ "constlike", "start_block" ]
374
375
	block      = "get_irg_start_block(irg)"
	mode       = "get_tarval_mode(tarval)"
376
377
	knownBlock = True
	pinned     = "no"
378
	attrs      = [
379
380
		Attribute("tarval", type="ir_tarval*",
		          comment="constant value (a tarval object)"),
381
382
	]
	attr_struct = "const_attr"
383
	attrs_name  = "con"
384

Matthias Braun's avatar
Matthias Braun committed
385
@op
386
class Conv:
387
	"""Converts values between modes"""
388
389
390
391
392
	flags  = []
	pinned = "no"
	ins    = [
		("op", "operand")
	]
393

Matthias Braun's avatar
Matthias Braun committed
394
395
@op
class CopyB:
Matthias Braun's avatar
Matthias Braun committed
396
	"""Copies a block of memory with statically known size/type."""
397
398
399
400
401
	ins   = [
		("mem",  "memory dependency"),
		("dst",  "destination address"),
		("src",  "source address"),
	]
402
403
	mode  = "mode_M"
	flags = [ "uses_memory" ]
404
	attrs = [
405
406
407
408
409
		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"),
410
411
	]
	attr_struct = "copyb_attr"
412
	constructor_args = [
413
414
		Attribute("flags", type="ir_cons_flags",
		          comment="specifies volatility"),
415
	]
416
	pinned      = "no"
417

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

Matthias Braun's avatar
Matthias Braun committed
444
445
@op
class Dummy:
446
447
448
	"""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."""
449
450
	ins        = []
	flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
451
452
453
454
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"

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

Matthias Braun's avatar
Matthias Braun committed
468
@op
469
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
470
471
472
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
473
	flags    = [ "commutative" ]
474

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

Matthias Braun's avatar
Matthias Braun committed
486
487
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
488
489
490
491
	"""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."""
492
493
494
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
495
496
497
	pinned = "no"
	flags  = []

Matthias Braun's avatar
Matthias Braun committed
498
499
@op
class IJmp:
500
501
502
	"""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"""
503
504
	mode     = "mode_X"
	pinned   = "yes"
505
506
507
	ins      = [
	   ("target", "target address of the jump"),
	]
508
	flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
509

Matthias Braun's avatar
Matthias Braun committed
510
511
@op
class Jmp:
512
	"""Jumps to the block connected through the out-value"""
513
514
515
516
517
	mode     = "mode_X"
	pinned   = "yes"
	ins      = []
	flags    = [ "cfopcode" ]

Matthias Braun's avatar
Matthias Braun committed
518
519
@op
class Load:
520
	"""Loads a value from memory (heap or stack)."""
521
522
523
524
	ins   = [
		("mem", "memory dependency"),
		("ptr",  "address to load from"),
	]
525
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
526
		("M",         "memory result"),
527
		("res",       "result of load operation"),
Matthias Braun's avatar
Matthias Braun committed
528
529
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
530
	]
531
532
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
533
	attrs    = [
534
535
536
537
538
539
540
541
542
543
		Attribute("mode", type="ir_mode*",
		          comment="mode of the value to be loaded"),
		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"),
544
545
	]
	attr_struct = "load_attr"
546
	constructor_args = [
547
548
		Attribute("flags", type="ir_cons_flags",
		          comment="specifies alignment, volatility and pin state"),
549
	]
550
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
551
	throws_init = "(flags & cons_throws_exception) != 0"
552

Matthias Braun's avatar
Matthias Braun committed
553
@op
554
class Minus:
Andreas Seltenreich's avatar
Andreas Seltenreich committed
555
	"""returns the additive inverse of its operand"""
556
557
558
559
560
	flags  = []
	pinned = "no"
	ins    = [
		("op", "operand")
	]
561

Matthias Braun's avatar
Matthias Braun committed
562
563
@op
class Mod:
564
565
566
	"""returns the remainder of its operands from an implied division.

	Examples:
567

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

594
class Mul(Binop):
595
	"""returns the product of its operands"""
596
597
598
	flags = [ "commutative" ]

class Mulh(Binop):
599
600
	"""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)"""
601
602
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
603
604
@op
class Mux:
605
606
	"""returns the false or true operand depending on the value of the sel
	operand"""
607
608
609
610
611
	ins    = [
	   ("sel",   "value making the output selection"),
	   ("false", "selected if sel input is false"),
	   ("true",  "selected if sel input is true"),
	]
612
613
614
	flags  = []
	pinned = "no"

Matthias Braun's avatar
Matthias Braun committed
615
616
@op
class NoMem:
617
	"""Placeholder node for cases where you don't need any memory input"""
618
	mode          = "mode_M"
619
	flags         = [ "dump_noblock" ]
620
621
	pinned        = "yes"
	knownBlock    = True
622
	block         = "get_irg_start_block(irg)"
623
	singleton     = True
624

Matthias Braun's avatar
Matthias Braun committed
625
@op
626
class Not:
627
	"""returns the bitwise complement of a value. Works for boolean values, too."""
628
629
630
631
632
	flags  = []
	pinned = "no"
	ins    = [
		("op", "operand")
	]
633

634
635
636
637
@op
class Offset(EntConst):
	"""Symbolic constant that represents the offset of an entity in its owner type."""

Matthias Braun's avatar
Matthias Braun committed
638
@op
639
class Or(Binop):
640
	"""returns the result of a bitwise or operation of its operands"""
641
642
	flags = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
643
644
@op
class Phi:
645
646
647
	"""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."""
648
649
	pinned        = "yes"
	arity         = "variable"
650
	input_name    = "pred"
651
652
	flags         = []
	attr_struct   = "phi_attr"
653
	init          = '''
654
	res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
Matthias Braun's avatar
Matthias Braun committed
655
	customSerializer = True
656

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

Matthias Braun's avatar
Matthias Braun committed
669
670
@op
class Proj:
671
	"""returns an entry of a tuple value"""
672
	ins        = [
673
674
		("pred", "the tuple value from which a part is extracted"),
	]
675
676
677
678
679
680
	flags      = []
	pinned     = "no"
	knownBlock = True
	knownGraph = True
	block      = "get_nodes_block(irn_pred)"
	graph      = "get_irn_irg(irn_pred)"
681
	attrs      = [
682
683
		Attribute("proj", type="long",
		          comment="number of tuple component to be extracted"),
684
	]
685
	attr_struct = "proj_attr"
686

Matthias Braun's avatar
Matthias Braun committed
687
688
@op
class Raise:
689
690
691
	"""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."""
692
693
694
695
	ins    = [
		("mem",     "memory dependency"),
		("exo_ptr", "pointer to exception object to be thrown"),
	]
696
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
697
698
		("M", "memory result"),
		("X", "control flow to exception handler"),
699
	]
700
701
702
	flags  = [ "highlevel", "cfopcode" ]
	pinned = "yes"

Matthias Braun's avatar
Matthias Braun committed
703
704
@op
class Return:
705
706
	"""Returns from the current function. Takes memory and return values as
	operands."""
707
	ins        = [
708
709
		("mem", "memory dependency"),
	]
710
711
712
713
714
	arity      = "variable"
	input_name = "res"
	mode       = "mode_X"
	flags      = [ "cfopcode" ]
	pinned     = "yes"
715

Matthias Braun's avatar
Matthias Braun committed
716
717
@op
class Sel:
718
	"""Computes the address of a entity of a compound type given the base
719
720
	address of an instance of the compound type.

721
	Optimizations assume that a Sel node can only produce a NULL pointer if the
722
	ptr input was NULL."""
723
	ins         = [
724
725
726
		("mem", "memory dependency"),
		("ptr", "pointer to object to select from"),
	]
727
728
729
730
731
732
	arity       = "variable"
	input_name  = "index"
	flags       = []
	mode        = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
	pinned      = "no"
	attrs       = [
733
734
		Attribute("entity", type="ir_entity*",
		          comment="entity which is selected"),
735
736
737
	]
	attr_struct = "sel_attr"

Matthias Braun's avatar
Matthias Braun committed
738
@op
739
class Shl(Binop):
740
	"""Returns its first operands bits shifted left by the amount of the 2nd
741
742
743
744
	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."""
745
746
	flags = []

Matthias Braun's avatar
Matthias Braun committed
747
@op
748
class Shr(Binop):
749
	"""Returns its first operands bits shifted right by the amount of the 2nd
750
751
752
753
	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."""
754
755
	flags = []

Matthias Braun's avatar
Matthias Braun committed
756
@op
757
class Shrs(Binop):
758
759
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
760
761
762
763
	(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."""
764
765
	flags = []

Matthias Braun's avatar
Matthias Braun committed
766
767
@op
class Start:
768
	"""The first node of a graph. Execution starts with this node."""
769
770
771
772
773
774
	outs       = [
		("X_initial_exec", "control flow"),
		("M",              "initial memory"),
		("P_frame_base",   "frame base pointer"),
		("T_args",         "function arguments")
	]
775
776
777
778
779
780
	mode             = "mode_T"
	pinned           = "yes"
	flags            = [ "cfopcode" ]
	singleton        = True
	knownBlock       = True
	block            = "get_irg_start_block(irg)"
781

Matthias Braun's avatar
Matthias Braun committed
782
783
@op
class Store:
784
	"""Stores a value into memory (heap or stack)."""
785
786
787
788
789
	ins   = [
	   ("mem",   "memory dependency"),
	   ("ptr",   "address to store to"),
	   ("value", "value to store"),
	]
790
	outs  = [
Matthias Braun's avatar
Matthias Braun committed
791
792
793
		("M",         "memory result"),
		("X_regular", "control flow when no exception occurs"),
		("X_except",  "control flow when exception occured"),
794
	]
795
796
797
798
	flags    = [ "fragile", "uses_memory" ]
	pinned   = "exception"
	attr_struct = "store_attr"
	pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
799
	throws_init = "(flags & cons_throws_exception) != 0"
800
	attrs = [
801
802
803
804
805
806
807
808
		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"),
809
	]
810
	constructor_args = [
811
812
		Attribute("flags", type="ir_cons_flags",
		          comment="specifies alignment, volatility and pin state"),
813
814
	]

Matthias Braun's avatar
Matthias Braun committed
815
@op
816
class Sub(Binop):
817
	"""returns the difference of its operands"""
818
819
	flags = []

820
@op
821
822
class Size(TypeConst):
	"""A symbolic constant that represents the size of a type"""
823

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

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

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

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