cleanup/reformat irop_t.h
[libfirm] / ir / ir / irop_t.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Representation of opcode of intermediate operation -- private header.
23  * @author   Christian Schaefer, Goetz Lindenmaier, Michael Beck
24  * @version  $Id$
25  */
26 #ifndef FIRM_IR_IROP_T_H
27 #define FIRM_IR_IROP_T_H
28
29 #include "irop.h"
30
31 #include <stdbool.h>
32
33 #include "irtypes.h"
34 #include "tv.h"
35
36 /**
37  * Frees a newly created ir operation.
38  */
39 void free_ir_op(ir_op *code);
40
41 /** Initialize the irop module. */
42 void init_op(void);
43
44 /** Free memory used by irop module. */
45 void finish_op(void);
46
47 /**
48  * Copies simply all attributes stored in the old node to the new node.
49  * Assumes both have the same opcode and sufficient size.
50  *
51  * @param old_node  the old node from which the attributes are read
52  * @param new_node  the new node to which the attributes are written
53  */
54 void default_copy_attr(ir_graph *irg, const ir_node *old_node,
55                        ir_node *new_node);
56
57 /**
58  * Returns the attribute size of nodes of this opcode.
59  * @note Use not encouraged, internal feature.
60  */
61 static inline size_t get_op_attr_size (const ir_op *op)
62 {
63         return op->attr_size;
64 }
65
66 /**
67  * Returns non-zero if op is a control flow opcode,
68  * like Start, End, Jmp, Cond, Return, Raise or Bad.
69  */
70 static inline bool is_op_cfopcode(const ir_op *op)
71 {
72         return op->flags & irop_flag_cfopcode;
73 }
74
75 /** Returns non-zero if operation is commutative */
76 static inline bool is_op_commutative(const ir_op *op)
77 {
78         return op->flags & irop_flag_commutative;
79 }
80
81 /** Returns non-zero if operation is fragile */
82 static inline bool is_op_fragile(const ir_op *op)
83 {
84         return op->flags & irop_flag_fragile;
85 }
86
87 /** Returns non-zero if operation is forking control flow */
88 static inline bool is_op_forking(const ir_op *op)
89 {
90         return op->flags & irop_flag_forking;
91 }
92
93 /** Returns non-zero if operation is a high-level op */
94 static inline bool is_op_highlevel(const ir_op *op)
95 {
96         return op->flags & irop_flag_highlevel;
97 }
98
99 /** Returns non-zero if operation is a const-like op */
100 static inline bool is_op_constlike(const ir_op *op)
101 {
102         return op->flags & irop_flag_constlike;
103 }
104
105 static inline bool is_op_uses_memory(const ir_op *op)
106 {
107         return op->flags & irop_flag_uses_memory;
108 }
109
110 /** Returns non-zero if operation must always be optimized */
111 static inline bool is_op_always_opt(const ir_op *op)
112 {
113         return op->flags & irop_flag_always_opt;
114 }
115
116 /** Returns non-zero if operation is a keep-like op */
117 static inline bool is_op_keep(const ir_op *op)
118 {
119         return op->flags & irop_flag_keep;
120 }
121
122 /** Returns non-zero if operation must always be placed in the start block. */
123 static inline bool is_op_start_block_placed(const ir_op *op)
124 {
125         return op->flags & irop_flag_start_block;
126 }
127
128 /** Returns non-zero if operation is a machine operation */
129 static inline bool is_op_machine(const ir_op *op)
130 {
131         return op->flags & irop_flag_machine;
132 }
133
134 /** Returns non-zero if operation is a machine operand */
135 static inline bool is_op_machine_operand(const ir_op *op)
136 {
137         return op->flags & irop_flag_machine_op;
138 }
139
140 /** Returns non-zero if operation is CSE neutral */
141 static inline bool is_op_cse_neutral(const ir_op *op)
142 {
143         return op->flags & irop_flag_cse_neutral;
144 }
145
146 /** Returns non-zero if operation is a machine user op number n */
147 static inline bool is_op_machine_user(const ir_op *op, unsigned n)
148 {
149         return op->flags & (irop_flag_user << n);
150 }
151
152 static inline unsigned _get_op_code(const ir_op *op)
153 {
154         return op->code;
155 }
156
157 static inline ident *_get_op_ident(const ir_op *op)
158 {
159         return op->name;
160 }
161
162 static inline op_pin_state _get_op_pinned(const ir_op *op)
163 {
164         return op->pin_state;
165 }
166
167 static inline void _set_generic_function_ptr(ir_op *op, op_func func)
168 {
169         op->ops.generic = func;
170 }
171
172 static inline op_func _get_generic_function_ptr(const ir_op *op)
173 {
174         return op->ops.generic;
175 }
176
177 static inline const ir_op_ops *_get_op_ops(const ir_op *op)
178 {
179         return &op->ops;
180 }
181
182 static inline void _set_op_tag(ir_op *op, unsigned tag)
183 {
184         op->tag = tag;
185 }
186
187 static inline unsigned _get_op_tag(const ir_op *op)
188 {
189         return op->tag;
190 }
191
192 static inline void _set_op_attr(ir_op *op, void *attr)
193 {
194         op->attr = attr;
195 }
196
197 static inline void *_get_op_attr(const ir_op *op)
198 {
199         return op->attr;
200 }
201
202 #define get_op_code(op)         _get_op_code(op)
203 #define get_op_ident(op)        _get_op_ident(op)
204 #define get_op_pinned(op)       _get_op_pinned(op)
205 #define get_op_ops(op)          _get_op_ops(op)
206 #define set_op_tag(op, tag)     _set_op_tag((op), (tag))
207 #define get_op_tag(op)          _get_op_tag(op)
208 #define set_op_attr(op, attr)   _set_op_attr((op), (attr))
209 #define get_op_attr(op)         _get_op_attr(op)
210
211 #endif