ir_spec.py 25.4 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
176
177
178
179
	"""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
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
185
186
	with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
	This is because removing inputs from a Block is hairy operation (requiring,
	Phis to be shortened too for example). So instead of removing block inputs
	they are set to Bad, and the actual removal is left to the control flow
	optimisation phase. Block, Phi, Tuple with only Bad inputs however are
	replaced by Bad right away."""
Matthias Braun's avatar
Matthias Braun committed
187
	flags         = [ "start_block", "dump_noblock" ]
188
189
	pinned        = "yes"
	knownBlock    = True
190
	block         = "get_irg_start_block(irg)"
191
	attr_struct   = "bad_attr"
192
	init = '''
193
	res->attr.bad.irg.irg = irg;
194
195
	'''

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

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
321
322
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
323
324
325
326
327
328
329
330
331
332
333
334
	"""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  = [
335
336
337
338
		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
339
340
341
342
	]
	attr_struct = "switch_attr"
	attrs_name  = "switcha"

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

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

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

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

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

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

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

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

	This is also known as the Xor operation."""
470
	flags    = [ "commutative" ]
471

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

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

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

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

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

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

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

	Examples:
564

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

817
@op
818
819
class Size(TypeConst):
	"""A symbolic constant that represents the size of a type"""
820

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

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

Matthias Braun's avatar
Matthias Braun committed
850
851
@op
class Unknown:
852
853
	"""Returns an unknown (at compile- and runtime) value. It is a valid
	optimisation to replace an Unknown by any other constant value."""
854
855
856
	knownBlock = True
	pinned     = "yes"
	block      = "get_irg_start_block(irg)"
Matthias Braun's avatar
Matthias Braun committed
857
	flags      = [ "start_block", "constlike", "dump_noblock" ]