more state handling
[libfirm] / ir / ir / irop.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irop.h
4  * Purpose:     Representation of opcode of intermediate operation.
5  * Author:      Christian Schaefer
6  * Modified by: Goetz Lindenmaier
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14  * @file irop.h
15  *
16  * Operators of firm nodes.
17  *
18  * @author Christian Schaefer
19  *
20  *  This module specifies the opcodes possible for ir nodes.  Their
21  *  definition is close to the operations specified in UKA Tech-Report
22  *  1999-14
23  */
24
25 # ifndef _IROP_H_
26 # define _IROP_H_
27
28 # include "ident.h"
29
30 /** The opcodes of the libFirm predefined operations. */
31 typedef enum {
32   iro_Block,
33   iro_Start, iro_End, iro_Jmp, iro_Cond, iro_Return, iro_Raise,
34   iro_Const, iro_SymConst,
35   iro_Sel,  iro_InstOf,
36   iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Quot, iro_DivMod,
37   iro_Div,  iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
38   iro_Cmp,  iro_Shl, iro_Shr, iro_Shrs, iro_Rot, iro_Conv, iro_Cast,
39   iro_Phi,
40   iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
41   iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm,
42   iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept,
43   iro_NoMem, iro_Mux,
44   iro_MaxOpcode
45 } opcode;
46
47 typedef struct ir_op ir_op;
48
49 extern ir_op *op_Block;           ir_op *get_op_Block     (void);
50
51 extern ir_op *op_Start;           ir_op *get_op_Start     (void);
52 extern ir_op *op_End;             ir_op *get_op_End       (void);
53 extern ir_op *op_Jmp;             ir_op *get_op_Jmp       (void);
54 extern ir_op *op_Cond;            ir_op *get_op_Cond      (void);
55 extern ir_op *op_Return;          ir_op *get_op_Return    (void);
56 extern ir_op *op_Raise;           ir_op *get_op_Raise     (void);
57 extern ir_op *op_Sel;             ir_op *get_op_Sel       (void);
58 extern ir_op *op_InstOf;          ir_op *get_op_InstOf    (void);
59
60 extern ir_op *op_Const;           ir_op *get_op_Const     (void);
61 extern ir_op *op_SymConst;        ir_op *get_op_SymConst  (void);
62
63 extern ir_op *op_Call;            ir_op *get_op_Call      (void);
64 extern ir_op *op_Add;             ir_op *get_op_Add       (void);
65 extern ir_op *op_Sub;             ir_op *get_op_Sub       (void);
66 extern ir_op *op_Minus;           ir_op *get_op_Minus     (void);
67 extern ir_op *op_Mul;             ir_op *get_op_Mul       (void);
68 extern ir_op *op_Quot;            ir_op *get_op_Quot      (void);
69 extern ir_op *op_DivMod;          ir_op *get_op_DivMod    (void);
70 extern ir_op *op_Div;             ir_op *get_op_Div       (void);
71 extern ir_op *op_Mod;             ir_op *get_op_Mod       (void);
72 extern ir_op *op_Abs;             ir_op *get_op_Abs       (void);
73 extern ir_op *op_And;             ir_op *get_op_And       (void);
74 extern ir_op *op_Or;              ir_op *get_op_Or        (void);
75 extern ir_op *op_Eor;             ir_op *get_op_Eor       (void);
76 extern ir_op *op_Not;             ir_op *get_op_Not       (void);
77 extern ir_op *op_Cmp;             ir_op *get_op_Cmp       (void);
78 extern ir_op *op_Shl;             ir_op *get_op_Shl       (void);
79 extern ir_op *op_Shr;             ir_op *get_op_Shr       (void);
80 extern ir_op *op_Shrs;            ir_op *get_op_Shrs      (void);
81 extern ir_op *op_Rot;             ir_op *get_op_Rot       (void);
82 extern ir_op *op_Conv;            ir_op *get_op_Conv      (void);
83 extern ir_op *op_Cast;            ir_op *get_op_Cast      (void);
84
85 extern ir_op *op_Phi;             ir_op *get_op_Phi       (void);
86
87 extern ir_op *op_Load;            ir_op *get_op_Load      (void);
88 extern ir_op *op_Store;           ir_op *get_op_Store     (void);
89 extern ir_op *op_Alloc;           ir_op *get_op_Alloc     (void);
90 extern ir_op *op_Free;            ir_op *get_op_Free      (void);
91
92 extern ir_op *op_Sync;            ir_op *get_op_Sync      (void);
93
94 extern ir_op *op_Tuple;           ir_op *get_op_Tuple     (void);
95 extern ir_op *op_Proj;            ir_op *get_op_Proj      (void);
96 extern ir_op *op_Id;              ir_op *get_op_Id        (void);
97 extern ir_op *op_Bad;             ir_op *get_op_Bad       (void);
98 extern ir_op *op_Confirm;         ir_op *get_op_Confirm   (void);
99
100 extern ir_op *op_Unknown;         ir_op *get_op_Unknown   (void);
101 extern ir_op *op_Filter;          ir_op *get_op_Filter    (void);
102 extern ir_op *op_Break;           ir_op *get_op_Break     (void);
103 extern ir_op *op_CallBegin;       ir_op *get_op_CallBegin (void);
104 extern ir_op *op_EndReg;          ir_op *get_op_EndReg    (void);
105 extern ir_op *op_EndExcept;       ir_op *get_op_EndExcept (void);
106
107 extern ir_op *op_NoMem;           ir_op *get_op_NoMem     (void);
108 extern ir_op *op_Mux;             ir_op *get_op_Mux       (void);
109
110 /** Returns the ident for the opcode name */
111 ident *get_op_ident(const ir_op *op);
112
113 /** Returns the string for the opcode. */
114 const char *get_op_name(const ir_op *op);
115
116 /** Returns the enum for the opcode */
117 opcode get_op_code(const ir_op *op);
118
119 /** op_pin_state_pinned states */
120 typedef enum {
121   op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
122   op_pin_state_pinned,        /**< Nodes must remain in this basic block. */
123   op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
124                                    exception, else can float. Used internally. */
125   op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
126                                    exception or uses memory, else can float. Used internally. */
127 } op_pin_state;
128
129 const char *get_op_pin_state_name(op_pin_state s);
130
131 /** gets pinned state of an opcode */
132 op_pin_state get_op_pinned(const ir_op *op);
133
134 /** Sets pinned in the opcode.  Setting it to floating has no effect
135    for Block, Phi and control flow nodes. */
136 void set_op_pinned(ir_op *op, op_pin_state pinned);
137
138 /** Returns the next free IR opcode number, allows to register user ops */
139 unsigned get_next_ir_opcode(void);
140
141 # endif /* _IROP_H_ */