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
@abstract
@op
class EntConst(object):
	"""Symbolic constant that represents an aspect of an entity"""
	name       = "entconst"
	flags      = [ "constlike", "start_block" ]
	pinned     = "no"
	attrs      = [
32
		Attribute("entity", type="ir_entity*", comment="entity to operate on"),
33
34
35
36
	]
	attr_struct = "entconst_attr"
	attrs_name  = "entc"

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

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

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

60
61
62
63
@op
class Align(TypeConst):
	"""A symbolic constant that represents the alignment of a type"""

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

Matthias Braun's avatar
Matthias Braun committed
83
84
@op
class Anchor:
85
86
87
88
89
90
	"""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."""
91
92
93
94
95
96
97
	mode             = "mode_ANY"
	arity            = "variable"
	flags            = [ "dump_noblock" ]
	pinned           = "yes"
	singleton        = True
	noconstructor    = True
	customSerializer = True
98

Matthias Braun's avatar
Matthias Braun committed
99
@op
100
class And(Binop):
101
	"""returns the result of a bitwise and operation of its operands"""
102
103
	flags    = [ "commutative" ]

Matthias Braun's avatar
Matthias Braun committed
104
105
@op
class ASM:
Matthias Braun's avatar
Matthias Braun committed
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
	"""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)
	"""
133
134
	mode             = "mode_T"
	arity            = "variable"
135
	input_name       = "input"
136
	flags            = [ "keep", "uses_memory" ]
137
	pinned           = "exception"
138
139
140
141
	pinned_init      = "op_pin_state_pinned"
	attr_struct      = "asm_attr"
	attrs_name       = "assem"
	customSerializer = True
142
143
144
	ins   = [
		("mem",    "memory dependency"),
	]
145
	attrs = [
146
147
148
149
150
151
152
153
154
155
156
		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"),
157
158
159
160
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
	noconstructor = True
161

Matthias Braun's avatar
Matthias Braun committed
162
163
@op
class Bad:
164
165
166
167
168
169
	"""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).
170
	Optimizations also set block predecessors to Bad when it becomes clear,
171
172
	that a control flow edge can never be executed.

173
	The gigo optimizations ensures that nodes with Bad as their block, get
Christoph Mallon's avatar
Christoph Mallon committed
174
	replaced by Bad themselves. Nodes with at least 1 Bad input get exchanged
175
176
177
178
	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
179
	optimization phase. Block, Phi, Tuple with only Bad inputs however are
180
181
182
183
	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
184
	flags         = [ "start_block", "dump_noblock" ]
185
	pinned        = "yes"
186

Matthias Braun's avatar
Matthias Braun committed
187
188
@op
class Deleted:
189
190
	"""Internal node which is temporary set to nodes which are already removed
	from the graph."""
191
192
193
194
	mode             = "mode_Bad"
	flags            = [ ]
	pinned           = "yes"
	noconstructor    = True
Matthias Braun's avatar
Matthias Braun committed
195
	customSerializer = True # this has no serializer
196

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

	init = '''
214
	res->attr.block.backedge    = new_backedge_arr(get_irg_obstack(irg), arity);
Moritz Kroll's avatar
Moritz Kroll committed
215
	set_Block_matured(res, 1);
216
217

	/* Create and initialize array for Phi-node construction. */
218
	if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION)) {
219
		res->attr.block.graph_arr = NEW_ARR_DZ(ir_node*, get_irg_obstack(irg), irg->n_loc);
220
	}
221
	'''
222

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

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

Matthias Braun's avatar
Matthias Braun committed
279
@op
280
class Cmp(Binop):
281
	"""Compares its two operands and checks whether a specified
282
	   relation (like less or equal) is fulfilled."""
283
	flags = []
284
285
	mode  = "mode_b"
	attrs = [
286
287
		Attribute("relation", type="ir_relation",
		          comment="Comparison relation"),
288
289
	]
	attr_struct = "cmp_attr"
290

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

Matthias Braun's avatar
Matthias Braun committed
310
311
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
312
313
314
315
316
317
318
319
320
321
322
323
	"""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  = [
324
325
326
327
		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
328
329
330
331
	]
	attr_struct = "switch_attr"
	attrs_name  = "switcha"

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

Matthias Braun's avatar
Matthias Braun committed
356
357
@op
class Const:
358
	"""Returns a constant value."""
359
	flags      = [ "constlike", "start_block" ]
360
	mode       = "get_tarval_mode(tarval)"
361
	pinned     = "no"
362
	attrs      = [
363
364
		Attribute("tarval", type="ir_tarval*",
		          comment="constant value (a tarval object)"),
365
366
	]
	attr_struct = "const_attr"
367
	attrs_name  = "con"
368

Matthias Braun's avatar
Matthias Braun committed
369
@op
370
class Conv:
371
	"""Converts values between modes"""
372
373
374
375
376
	flags  = []
	pinned = "no"
	ins    = [
		("op", "operand")
	]
377

Matthias Braun's avatar
Matthias Braun committed
378
379
380
381
382
383
384
385
386
387
@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 = []
	pinned = "no"
	ins = [
		("op", "operand")
	]

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
459
@op
460
class Eor(Binop):
Matthias Braun's avatar
Matthias Braun committed
461
462
463
	"""returns the result of a bitwise exclusive or operation of its operands.

	This is also known as the Xor operation."""
464
	flags    = [ "commutative" ]
465

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

Matthias Braun's avatar
Matthias Braun committed
477
478
@op
class Id:
Matthias Braun's avatar
Matthias Braun committed
479
480
481
482
	"""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."""
483
484
485
	ins    = [
	   ("pred", "the value which is returned unchanged")
	]
486
487
488
	pinned = "no"
	flags  = []

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

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

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

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

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

	Examples:
560

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
616
@op
617
class Not:
618
	"""returns the bitwise complement of a value. Works for boolean values, too."""
619
620
621
622
623
	flags  = []
	pinned = "no"
	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
672
	flags      = []
	pinned     = "no"
	block      = "get_nodes_block(irn_pred)"
673
	usesGraph  = False
674
	attrs      = [
675
		Attribute("num", type="unsigned",
676
		          comment="number of tuple component to be extracted"),
677
	]
678
	attr_struct = "proj_attr"
679

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

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

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

714
715
716
717
718
719
	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  = []
720
	mode   = "mode_P"
721
722
723
724
725
726
727
728
729
730
731
732
733
734
	pinned = "no"
	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 = [
735
736
		("ptr", "pointer to object to select from"),
	]
737
	flags   = []
738
	mode    = "mode_P"
739
740
	pinned  = "no"
	attrs   = [
741
742
		Attribute("entity", type="ir_entity*",
		          comment="entity which is selected"),
743
	]
744
	attr_struct = "member_attr"
745

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

Matthias Braun's avatar
Matthias Braun committed
755
@op
756
class Shr(Binop):
757
	"""Returns its first operands bits shifted right by the amount of the 2nd
758
759
760
761
	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."""
762
763
	flags = []

Matthias Braun's avatar
Matthias Braun committed
764
@op
765
class Shrs(Binop):
766
767
	"""Returns its first operands bits shifted right by the amount of the 2nd
	operand. The leftmost bit (usually the sign bit) stays the same
768
769
770
771
	(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."""
772
773
	flags = []

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

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

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

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

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

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

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

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