3 * File name: ir/ir/irop.h
4 * Purpose: Representation of opcode of intermediate operation.
5 * Author: Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * Operators of firm nodes.
18 * @author Christian Schaefer
20 * This module specifies the opcodes possible for ir nodes. Their
21 * definition is close to the operations specified in UKA Tech-Report
30 /** The allowed parities */
33 oparity_unary, /**< an unary operator -- considering 'numeric' arguments. */
34 oparity_binary, /**< an binary operator -- considering 'numeric' arguments.*/
35 oparity_trinary, /**< an trinary operator -- considering 'numeric' arguments.*/
36 oparity_zero, /**< no operators, as e.g. Const. */
37 oparity_variable, /**< arity not fixed by opcode, but statically
38 known. E.g., number of arguments to call. */
39 oparity_dynamic, /**< arity depends on state of firm representation.
40 Can change by optimizations...
41 We must allocate a dynamic in array for the node! */
42 oparity_any, /**< other arity */
48 irop_flag_none = 0x00000000, /**< nothing */
49 irop_flag_labeled = 0x00000001, /**< if set, Output edge labels on in-edges in vcg graph */
50 irop_flag_commutative = 0x00000002, /**< operation is commutative */
51 irop_flag_cfopcode = 0x00000004, /**< is a control flow operation */
52 irop_flag_ip_cfopcode = 0x00000008, /**< operation manipulates interprocedural control flow */
53 irop_flag_fragile = 0x00000010, /**< set if the operation can change the control flow because
55 irop_flag_forking = 0x00000020, /**< the operation is a forking control flow */
56 irop_flag_highlevel = 0x00000040, /**< the operation is a pure high-level one and can be
57 skipped in low-level optimizations */
60 /** The opcodes of the libFirm predefined operations. */
63 iro_Start, iro_End, iro_Jmp, iro_Cond, iro_Return, iro_Raise,
64 iro_Const, iro_SymConst,
66 iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Quot, iro_DivMod,
67 iro_Div, iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
68 iro_Cmp, iro_Shl, iro_Shr, iro_Shrs, iro_Rot, iro_Conv, iro_Cast,
70 iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
71 iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm,
72 iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept,
77 typedef struct ir_op ir_op;
79 extern ir_op *op_Block; ir_op *get_op_Block (void);
81 extern ir_op *op_Start; ir_op *get_op_Start (void);
82 extern ir_op *op_End; ir_op *get_op_End (void);
83 extern ir_op *op_Jmp; ir_op *get_op_Jmp (void);
84 extern ir_op *op_Cond; ir_op *get_op_Cond (void);
85 extern ir_op *op_Return; ir_op *get_op_Return (void);
86 extern ir_op *op_Raise; ir_op *get_op_Raise (void);
87 extern ir_op *op_Sel; ir_op *get_op_Sel (void);
88 extern ir_op *op_InstOf; ir_op *get_op_InstOf (void);
90 extern ir_op *op_Const; ir_op *get_op_Const (void);
91 extern ir_op *op_SymConst; ir_op *get_op_SymConst (void);
93 extern ir_op *op_Call; ir_op *get_op_Call (void);
94 extern ir_op *op_Add; ir_op *get_op_Add (void);
95 extern ir_op *op_Sub; ir_op *get_op_Sub (void);
96 extern ir_op *op_Minus; ir_op *get_op_Minus (void);
97 extern ir_op *op_Mul; ir_op *get_op_Mul (void);
98 extern ir_op *op_Quot; ir_op *get_op_Quot (void);
99 extern ir_op *op_DivMod; ir_op *get_op_DivMod (void);
100 extern ir_op *op_Div; ir_op *get_op_Div (void);
101 extern ir_op *op_Mod; ir_op *get_op_Mod (void);
102 extern ir_op *op_Abs; ir_op *get_op_Abs (void);
103 extern ir_op *op_And; ir_op *get_op_And (void);
104 extern ir_op *op_Or; ir_op *get_op_Or (void);
105 extern ir_op *op_Eor; ir_op *get_op_Eor (void);
106 extern ir_op *op_Not; ir_op *get_op_Not (void);
107 extern ir_op *op_Cmp; ir_op *get_op_Cmp (void);
108 extern ir_op *op_Shl; ir_op *get_op_Shl (void);
109 extern ir_op *op_Shr; ir_op *get_op_Shr (void);
110 extern ir_op *op_Shrs; ir_op *get_op_Shrs (void);
111 extern ir_op *op_Rot; ir_op *get_op_Rot (void);
112 extern ir_op *op_Conv; ir_op *get_op_Conv (void);
113 extern ir_op *op_Cast; ir_op *get_op_Cast (void);
115 extern ir_op *op_Phi; ir_op *get_op_Phi (void);
117 extern ir_op *op_Load; ir_op *get_op_Load (void);
118 extern ir_op *op_Store; ir_op *get_op_Store (void);
119 extern ir_op *op_Alloc; ir_op *get_op_Alloc (void);
120 extern ir_op *op_Free; ir_op *get_op_Free (void);
122 extern ir_op *op_Sync; ir_op *get_op_Sync (void);
124 extern ir_op *op_Tuple; ir_op *get_op_Tuple (void);
125 extern ir_op *op_Proj; ir_op *get_op_Proj (void);
126 extern ir_op *op_Id; ir_op *get_op_Id (void);
127 extern ir_op *op_Bad; ir_op *get_op_Bad (void);
128 extern ir_op *op_Confirm; ir_op *get_op_Confirm (void);
130 extern ir_op *op_Unknown; ir_op *get_op_Unknown (void);
131 extern ir_op *op_Filter; ir_op *get_op_Filter (void);
132 extern ir_op *op_Break; ir_op *get_op_Break (void);
133 extern ir_op *op_CallBegin; ir_op *get_op_CallBegin (void);
134 extern ir_op *op_EndReg; ir_op *get_op_EndReg (void);
135 extern ir_op *op_EndExcept; ir_op *get_op_EndExcept (void);
137 extern ir_op *op_NoMem; ir_op *get_op_NoMem (void);
138 extern ir_op *op_Mux; ir_op *get_op_Mux (void);
140 /** Returns the ident for the opcode name */
141 ident *get_op_ident(const ir_op *op);
143 /** Returns the string for the opcode. */
144 const char *get_op_name(const ir_op *op);
146 /** Returns the enum for the opcode */
147 opcode get_op_code(const ir_op *op);
149 /** op_pin_state_pinned states */
151 op_pin_state_floats = 0, /**< Nodes of this opcode can be placed in any basic block. */
152 op_pin_state_pinned, /**< Nodes must remain in this basic block. */
153 op_pin_state_exc_pinned, /**< Node must be remain in this basic block if it can throw an
154 exception, else can float. Used internally. */
155 op_pin_state_mem_pinned /**< Node must be remain in this basic block if it can throw an
156 exception or uses memory, else can float. Used internally. */
159 const char *get_op_pin_state_name(op_pin_state s);
161 /** gets pinned state of an opcode */
162 op_pin_state get_op_pinned(const ir_op *op);
164 /** Sets pinned in the opcode. Setting it to floating has no effect
165 for Block, Phi and control flow nodes. */
166 void set_op_pinned(ir_op *op, op_pin_state pinned);
168 /** Returns the next free IR opcode number, allows to register user ops */
169 unsigned get_next_ir_opcode(void);
172 * Creates a new ir operation.
174 * @param code the opcode, one of type \c opcode
175 * @param name the printable name of this opcode
176 * @param p whether operations of this opcode are op_pin_state_pinned or floating
177 * @param flags a bitmask of irop_flags describing the behavior of the ir operation
178 * @param opar the parity of this ir operation
179 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index
180 * of the left operand
181 * @param attr_size attribute size for this ir operation
183 * @return The generated ir operation.
185 ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
186 unsigned flags, op_arity opar, int op_index, size_t attr_size);
188 # endif /* _IROP_H_ */