added doxygen comments
[libfirm] / ir / ir / irop.h
1 /*
2 *  Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
3 *  All rights reserved.
4 *
5 *  Authors: Christian Schaefer
6 *
7 *  irop.h  operators of firm nodes
8 *
9 *  This module specifies the opcodes possible for ir nodes.  Their
10 *  definition is close to the operations specified in UKA Tech-Report
11 *  1999-14
12 *
13 */
14
15 /* $Id$ */
16
17 # ifndef _IROP_H_
18 # define _IROP_H_
19
20 # include "ident.h"
21
22 typedef enum {
23   iro_Block,
24   iro_Start, iro_End, iro_Jmp, iro_Cond, iro_Return, iro_Raise,
25   iro_Const, iro_SymConst,
26   iro_Sel,  iro_InstOf,
27   iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Quot, iro_DivMod,
28   iro_Div,  iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
29   iro_Cmp,  iro_Shl, iro_Shr, iro_Shrs, iro_Rot, iro_Conv,
30   iro_Phi,
31   iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
32   iro_Proj, iro_Tuple, iro_Id, iro_Bad,
33   iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept
34 } opcode;
35
36 typedef struct ir_op ir_op;
37
38 extern ir_op *op_Block;           ir_op *get_op_Block     ();
39
40 extern ir_op *op_Start;           ir_op *get_op_Start     ();
41 extern ir_op *op_End;             ir_op *get_op_End       ();
42 extern ir_op *op_Jmp;             ir_op *get_op_Jmp       ();
43 extern ir_op *op_Cond;            ir_op *get_op_Cond      ();
44 extern ir_op *op_Return;          ir_op *get_op_Return    ();
45 extern ir_op *op_Raise;           ir_op *get_op_Raise     ();
46 extern ir_op *op_Sel;             ir_op *get_op_Sel       ();
47 extern ir_op *op_InstOf;          ir_op *get_op_InstOf    ();
48
49 extern ir_op *op_Const;           ir_op *get_op_Const     ();
50 extern ir_op *op_SymConst;        ir_op *get_op_SymConst  ();
51
52 extern ir_op *op_Call;            ir_op *get_op_Call      ();
53 extern ir_op *op_Add;             ir_op *get_op_Add       ();
54 extern ir_op *op_Sub;             ir_op *get_op_Sub       ();
55 extern ir_op *op_Minus;           ir_op *get_op_Minus     ();
56 extern ir_op *op_Mul;             ir_op *get_op_Mul       ();
57 extern ir_op *op_Quot;            ir_op *get_op_Quot      ();
58 extern ir_op *op_DivMod;          ir_op *get_op_DivMod    ();
59 extern ir_op *op_Div;             ir_op *get_op_Div       ();
60 extern ir_op *op_Mod;             ir_op *get_op_Mod       ();
61 extern ir_op *op_Abs;             ir_op *get_op_Abs       ();
62 extern ir_op *op_And;             ir_op *get_op_And       ();
63 extern ir_op *op_Or;              ir_op *get_op_Or        ();
64 extern ir_op *op_Eor;             ir_op *get_op_Eor       ();
65 extern ir_op *op_Not;             ir_op *get_op_Not       ();
66 extern ir_op *op_Cmp;             ir_op *get_op_Cmp       ();
67 extern ir_op *op_Shl;             ir_op *get_op_Shl       ();
68 extern ir_op *op_Shr;             ir_op *get_op_Shr       ();
69 extern ir_op *op_Shrs;            ir_op *get_op_Shrs      ();
70 extern ir_op *op_Rot;             ir_op *get_op_Rot       ();
71 extern ir_op *op_Conv;            ir_op *get_op_Conv      ();
72
73 extern ir_op *op_Phi;             ir_op *get_op_Phi       ();
74
75 extern ir_op *op_Load;            ir_op *get_op_Load      ();
76 extern ir_op *op_Store;           ir_op *get_op_Store     ();
77 extern ir_op *op_Alloc;           ir_op *get_op_Alloc     ();
78 extern ir_op *op_Free;            ir_op *get_op_Free      ();
79
80 extern ir_op *op_Sync;            ir_op *get_op_Sync      ();
81
82 extern ir_op *op_Tuple;           ir_op *get_op_Tuple     ();
83 extern ir_op *op_Proj;            ir_op *get_op_Proj      ();
84 extern ir_op *op_Id;              ir_op *get_op_Id        ();
85 extern ir_op *op_Bad;             ir_op *get_op_Bad       ();
86
87 extern ir_op *op_Unknown;         ir_op *get_op_Unknown   ();
88 extern ir_op *op_Filter;          ir_op *get_op_Filter    ();
89 extern ir_op *op_Break;           ir_op *get_op_Break     ();
90 extern ir_op *op_CallBegin;       ir_op *get_op_CallBegin ();
91 extern ir_op *op_EndReg;          ir_op *get_op_EndReg    ();
92 extern ir_op *op_EndExcept;       ir_op *get_op_EndExcept ();
93
94
95 /* Returns the ident for the opcode name */
96 ident *get_op_ident     (ir_op *op);
97 /* Returns the string for the opcode. */
98 const char *get_op_name (ir_op *op);
99
100 /* Returns the enum for the opcode */
101 opcode get_op_code      (ir_op *op);
102
103 typedef enum {
104   floats = 0,    /* Nodes of this opcode can be placed in any basic block. */
105   pinned           /* Nodes must remain in this basic block. */
106 } op_pinned;
107
108 op_pinned get_op_pinned (ir_op *op);
109 /* Sets pinned in the opcode.  Setting it to floating has no effect
110    for Block, Phi and control flow nodes. */
111 void      set_op_pinned(ir_op *op, op_pinned pinned);
112
113 /* Returns true if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
114 int is_cfopcode(ir_op *op);
115
116 /* Returns true if the operation manipulates interprocedural control flow:
117    CallBegin, EndReg, EndExcept */
118 int is_ip_cfopcode(ir_op *op);
119
120 /* Returns the attribute size of nodes of this opcode.
121    @@@ Use not encouraged, internal feature. */
122 int    get_op_attr_size (ir_op *op);
123
124 # endif /* _IROP_H_ */