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
	op_index       = 0
	arity_override = "oparity_binary"
22

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
80
81
@op
class Anchor:
82
	"""Utility node used to "hold" nodes in a graph that might possibly not be
83
84
85
	reachable by other means or which should be reachable immediately without
	searching through the graph.
	Each firm-graph contains exactly one anchor node whose address is always
86
	known. All other well-known graph-nodes like Start, End, NoMem, ...
87
	are found by looking at the respective Anchor operand."""
88
89
90
91
92
93
94
95
96
97
	ins = [
		("end_block",   "block the end node belongs to" ),
		("start_block", "block the start node belongs to" ),
		("end",         "end node of this ir_graph" ),
		("start",       "start node of this ir_graph" ),
		("frame",       "frame of this ir_graph" ),
		("initial_mem", "initial memory of this ir_graph" ),
		("args",        "argument proj of the start node" ),
		("no_mem",      "the only NoMem node of this ir_graph" ),
	]
98
99
100
101
102
	mode        = "mode_ANY"
	flags       = [ "dump_noblock" ]
	pinned      = "yes"
	singleton   = True
	constructor = False
103

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

Matthias Braun's avatar
Matthias Braun committed
109
110
@op
class ASM:
Matthias Braun's avatar
Matthias Braun committed
111
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
	"""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)
	"""
138
139
140
141
142
143
144
145
146
	mode        = "mode_T"
	arity       = "variable"
	input_name  = "input"
	flags       = [ "keep", "uses_memory" ]
	pinned      = "exception"
	pinned_init = "op_pin_state_pinned"
	attr_struct = "asm_attr"
	attrs_name  = "assem"
	ins         = [
147
148
		("mem",    "memory dependency"),
	]
149
	attrs       = [
150
151
152
153
154
155
156
157
158
159
160
		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"),
161
162
163
	]
	# constructor is written manually at the moment, because of the clobbers+
	# constraints arrays needing special handling (2 arguments for 1 attribute)
164
	constructor = False
165

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

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

Matthias Braun's avatar
Matthias Braun committed
191
192
@op
class Deleted:
193
194
	"""Internal node which is temporary set to nodes which are already removed
	from the graph."""
195
196
197
198
	mode        = "mode_Bad"
	flags       = [ ]
	pinned      = "yes"
	constructor = False
199

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

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

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

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

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

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

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

Matthias Braun's avatar
Matthias Braun committed
314
315
@op
class Switch:
Matthias Braun's avatar
Matthias Braun committed
316
317
318
319
320
321
322
323
324
	"""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"),
	]
325
	mode   = "mode_T"
Matthias Braun's avatar
Matthias Braun committed
326
327
328
	flags  = [ "cfopcode", "forking" ]
	pinned = "yes"
	attrs  = [
329
330
331
332
		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
333
334
335
336
	]
	attr_struct = "switch_attr"
	attrs_name  = "switcha"

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

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

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

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

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

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

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

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

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

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

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

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

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

	Examples:
559

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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