3 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
4 ** All rights reserved.
6 ** Authors: Martin Trapp, Christian Schaefer
8 ** declarations of an ir node
21 /* projection numbers of compare. */
26 Le, /* less or equal */
28 Ge, /* greater or equal */
29 Lg, /* less or greater */
30 Leg, /* less, equal or greater = ordered */
32 Ue, /* unordered or equal */
33 Ul, /* unordered or less */
34 Ule, /* unordered, less or equal */
35 Ug, /* unordered or greater */
36 Uge, /* unordered, greater or equal */
37 Ne, /* unordered, less or greater = not equal */
39 not_mask = Leg /* bits to flip to negate comparison */
43 get_pnc_string(int pnc);
46 get_negated_pnc(int pnc);
49 /* projection numbers for result of Start node. */
51 pns_initial_exec, /* Projection on an executable, the initial control
53 pns_global_store, /* Projection on the global store */
54 pns_frame_base, /* Projection on the frame base */
55 pns_globals, /* Projection on the pointer to the data segment
56 containing _all_ global entities. */
57 pns_args /* Projection on all arguments */
60 /* ir node attributes */
62 unsigned long block_visit; /* for the walker that walks over all blocks. */
63 /* Attributes private to construction: */
64 bool matured; /* if set, all in-nodes of the block are fixed */
65 struct ir_node **graph_arr; /* array to store all parameters */
69 type_tag, /* The SymConst is a type tag for the given type. */
70 size, /* The SymConst is the size of the given type. */
71 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
86 static_linkage, /* entity is used internal and not visible out of this
88 external_linkage, /* */
93 entity *ent; /* entity to select */
94 linkage_type *ltyp; /* linkage type of the entity */
98 stack_alloc, /* Alloc allocates the object on the stack. */
99 heap_alloc /* lloc allocates the object on the heap. */
103 type *type; /* Type of the allocated object. */
104 where_alloc where; /* stack, heap or other managed part of memory */
107 /* Some irnodes just have one attribute, these are stored here,
108 some have more. Their name is 'irnodename_attr' */
110 block_attr block; /* For Block: Fields needed to construct it */
111 struct tarval *con; /* For Const: contains the value of the constant */
112 symconst_attr i; /* For SymConst. */
113 sel_attr s; /* For Sel. */
114 type_method *call; /* For Call: pointer to the type of the method to call */
115 long proj; /* For Proj: contains the result position to project */
116 alloc_attr a; /* For Alloc. */
117 type *f; /* For Free. */
118 int phi0_pos; /* For Phi. Used to remember the value defined by
119 this Phi node. Needed when the Phi is completed
120 to call get_r_internal_value to find the
121 predecessors. If this attribute is set, the Phi
122 node takes the role of the obsolete Phi0 node,
123 therefore the name. */
127 /* common structure of an irnode */
128 /* if the node has some attributes, they are stored in attr */
130 typedef struct ir_node {
131 firm_kind kind; /* distinguishes this node from others */
132 ir_op *op; /* Opcode of this node. */
133 ir_mode *mode; /* Mode of this node. */
134 unsigned long visit; /* visited counter for walks of the graph */
135 struct ir_node **in; /* array with predecessors / operands */
136 struct ir_node *link; /* for linking nodes somehow to a list, e.g.
137 used while construction to link Phi0 nodes and
138 during optimization to link to nodes that
139 shall replace a node. */
140 attr attr; /* attribute of this node. Depends on opcode. */
141 /* Must be last attribute of struct ir_node. */
145 #if 0 /* I didn't manage to place this here as it causes cyclic inclusion
146 of header files/a cyclic dependency between ir_graph and ir_node. */
147 /* irnode constructor */
148 /* Create a new irnode in irg, with an op, mode, arity and */
149 /* some incoming irnodes. */
150 /* If arity is negative, a node with a dynamic array is created. */
151 inline ir_node *new_ir_node (int *irg, ir_node *block, ir_op *op,
152 ir_mode *mode, int arity, ir_node **in);
155 /* Print IR-Nodes with attributes */
156 int ir_node_print (XP_PAR1, const xprintf_info *, XP_PARN);
159 /** manipulate the fields of ir_node **/
161 /* returns the number of predecessors without the block predecessor: */
162 int get_irn_arity (ir_node *node);
163 /* returns the array with the ins: */
164 inline ir_node **get_irn_in (ir_node *node);
165 /* to iterate through the predecessors without touching the array. No
166 order of predecessors guaranteed.
167 To iterate over the operands iterate from 0 to i < get_irn_arity(),
168 to iterate includind the Block predecessor iterate from i = -1 to
169 i < get_irn_arity. */
170 inline ir_node *get_irn_n (ir_node *node, int n);
171 inline void set_irn_n (ir_node *node, int n, ir_node *in);
172 inline ir_mode *get_irn_mode (ir_node *node);
173 inline modecode get_irn_modecode (ir_node *node);
174 inline ir_op *get_irn_op (ir_node *node);
175 /* should be private to the library: */
176 inline void set_irn_op (ir_node *node, ir_op *op);
177 inline opcode get_irn_opcode (ir_node *node);
178 inline void set_irn_link (ir_node *node, ir_node *link);
179 inline ir_node *get_irn_link (ir_node *node);
182 /** access attributes directly **/
183 inline tarval *get_irn_const_attr (ir_node *node);
184 inline long get_irn_proj_attr (ir_node *node);
185 inline alloc_attr get_irn_alloc_attr (ir_node *node);
186 inline type *get_irn_free_attr (ir_node *node);
187 inline symconst_attr get_irn_symconst_attr (ir_node *node);
188 type_method *get_irn_call_attr (ir_node *node);
189 sel_attr get_irn_sel_attr (ir_node *node);
190 int get_irn_phi_attr (ir_node *node);
191 block_attr get_irn_return_attr (ir_node *node);
193 /** manipulate fields of individual nodes **/
195 /* this works for all except Block */
196 inline ir_node *get_nodes_Block (ir_node *node);
197 inline void set_nodes_Block (ir_node *node, ir_node *block);
199 int get_Block_n_cfgpreds (ir_node *node);
200 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
201 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
202 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
203 inline bool get_Block_matured (ir_node *node);
204 inline void set_Block_matured (ir_node *node, bool matured);
205 inline bool get_Block_closed (ir_node *node);
206 inline void set_Block_closed (ir_node *node, bool closed);
207 inline unsigned long get_Block_block_visit (ir_node *node);
208 inline void set_Block_block_visit (ir_node *node, unsigned long visit);
209 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
210 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
212 inline ir_node *get_Cond_selector (ir_node *node);
213 inline void set_Cond_selector (ir_node *node, ir_node *selector);
215 inline ir_node *get_Return_mem (ir_node *node);
216 inline void set_Return_mem (ir_node *node, ir_node *mem);
217 inline int get_Return_n_res (ir_node *node);
218 /*inline void set_Return_n_res (ir_node *node, int results); */
219 inline ir_node *get_Return_res (ir_node *node, int pos);
220 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
222 inline ir_node *get_Raise_mem (ir_node *node);
223 inline void set_Raise_mem (ir_node *node, ir_node *mem);
224 inline ir_node *get_Raise_exoptr (ir_node *node); /* PoinTeR to EXception Object */
225 inline void set_Raise_exoptr (ir_node *node, ir_node *exoptr);
227 inline tarval *get_Const_tarval (ir_node *node);
228 inline void set_Const_tarval (ir_node *node, tarval *con);
230 inline symconst_kind get_SymConst_kind (ir_node *node);
231 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
232 inline type *get_SymConst_type (ir_node *node);
233 inline void set_SymConst_type (ir_node *node, type *type);
234 inline ident *get_SymConst_ptrinfo (ir_node *node);
235 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
237 inline ir_node *get_Sel_mem (ir_node *node);
238 inline void set_Sel_mem (ir_node *node, ir_node *mem);
239 inline ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
240 inline void set_Sel_ptr (ir_node *node, ir_node *ptr);
241 inline int get_Sel_n_index (ir_node *node);
242 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
243 inline ir_node *get_Sel_index (ir_node *node, int pos);
244 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
245 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
246 inline void set_Sel_entity (ir_node *node, entity *ent);
247 inline linkage_type *get_Sel_linkage_type (ir_node *node);
248 inline void set_Sel_linkage_type (ir_node *node, linkage_type *lt);
250 inline ir_node *get_Call_mem (ir_node *node);
251 inline void set_Call_mem (ir_node *node, ir_node *mem);
252 inline ir_node *get_Call_ptr (ir_node *node);
253 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
254 inline int get_Call_arity (ir_node *node);
255 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
256 inline ir_node *get_Call_param (ir_node *node, int pos);
257 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
258 inline type_method *get_Call_type (ir_node *node);
259 inline void set_Call_type (ir_node *node, type_method *type);
261 /* For unary and binary arithmetic operations the access to the
262 operands can be factored out. Left is the first, right the
263 second arithmetic value as listed in tech report 1999-44.
264 unops are: Minus, Abs, Not, Conv
265 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
266 Shr, Shrs, Rot, Cmp */
267 inline int is_unop (ir_node *node);
268 inline ir_node *get_unop_op (ir_node *node);
269 inline void set_unop_op (ir_node *node, ir_node *op);
270 inline int is_binop (ir_node *node);
271 inline ir_node *get_binop_left (ir_node *node);
272 inline void set_binop_left (ir_node *node, ir_node *left);
273 inline ir_node *get_binop_right (ir_node *node);
274 inline void set_binop_right (ir_node *node, ir_node *right);
276 inline ir_node *get_Add_left (ir_node *node);
277 inline void set_Add_left (ir_node *node, ir_node *left);
278 inline ir_node *get_Add_right (ir_node *node);
279 inline void set_Add_right (ir_node *node, ir_node *right);
281 inline ir_node *get_Sub_left (ir_node *node);
282 inline void set_Sub_left (ir_node *node, ir_node *left);
283 inline ir_node *get_Sub_right (ir_node *node);
284 inline void set_Sub_right (ir_node *node, ir_node *right);
286 inline ir_node *get_Minus_op (ir_node *node);
287 inline void set_Minus_op (ir_node *node, ir_node *op);
289 inline ir_node *get_Mul_left (ir_node *node);
290 inline void set_Mul_left (ir_node *node, ir_node *left);
291 inline ir_node *get_Mul_right (ir_node *node);
292 inline void set_Mul_right (ir_node *node, ir_node *right);
294 inline ir_node *get_Quot_left (ir_node *node);
295 inline void set_Quot_left (ir_node *node, ir_node *left);
296 inline ir_node *get_Quot_right (ir_node *node);
297 inline void set_Quot_right (ir_node *node, ir_node *right);
298 inline ir_node *get_Quot_mem (ir_node *node);
299 inline void set_Quot_mem (ir_node *node, ir_node *mem);
301 inline ir_node *get_DivMod_left (ir_node *node);
302 inline void set_DivMod_left (ir_node *node, ir_node *left);
303 inline ir_node *get_DivMod_right (ir_node *node);
304 inline void set_DivMod_right (ir_node *node, ir_node *right);
305 inline ir_node *get_DivMod_mem (ir_node *node);
306 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
308 inline ir_node *get_Div_left (ir_node *node);
309 inline void set_Div_left (ir_node *node, ir_node *left);
310 inline ir_node *get_Div_right (ir_node *node);
311 inline void set_Div_right (ir_node *node, ir_node *right);
312 inline ir_node *get_Div_mem (ir_node *node);
313 inline void set_Div_mem (ir_node *node, ir_node *mem);
315 inline ir_node *get_Mod_left (ir_node *node);
316 inline void set_Mod_left (ir_node *node, ir_node *left);
317 inline ir_node *get_Mod_right (ir_node *node);
318 inline void set_Mod_right (ir_node *node, ir_node *right);
319 inline ir_node *get_Mod_mem (ir_node *node);
320 inline void set_Mod_mem (ir_node *node, ir_node *mem);
322 inline ir_node *get_Abs_op (ir_node *node);
323 inline void set_Abs_op (ir_node *node, ir_node *op);
325 inline ir_node *get_And_left (ir_node *node);
326 inline void set_And_left (ir_node *node, ir_node *left);
327 inline ir_node *get_And_right (ir_node *node);
328 inline void set_And_right (ir_node *node, ir_node *right);
330 inline ir_node *get_Or_left (ir_node *node);
331 inline void set_Or_left (ir_node *node, ir_node *left);
332 inline ir_node *get_Or_right (ir_node *node);
333 inline void set_Or_right (ir_node *node, ir_node *right);
335 inline ir_node *get_Eor_left (ir_node *node);
336 inline void set_Eor_left (ir_node *node, ir_node *left);
337 inline ir_node *get_Eor_right (ir_node *node);
338 inline void set_Eor_right (ir_node *node, ir_node *right);
340 inline ir_node *get_Not_op (ir_node *node);
341 inline void set_Not_op (ir_node *node, ir_node *op);
343 inline ir_node *get_Cmp_left (ir_node *node);
344 inline void set_Cmp_left (ir_node *node, ir_node *left);
345 inline ir_node *get_Cmp_right (ir_node *node);
346 inline void set_Cmp_right (ir_node *node, ir_node *right);
348 inline ir_node *get_Shl_left (ir_node *node);
349 inline void set_Shl_left (ir_node *node, ir_node *left);
350 inline ir_node *get_Shl_right (ir_node *node);
351 inline void set_Shl_right (ir_node *node, ir_node *right);
353 inline ir_node *get_Shr_left (ir_node *node);
354 inline void set_Shr_left (ir_node *node, ir_node *left);
355 inline ir_node *get_Shr_right (ir_node *node);
356 inline void set_Shr_right (ir_node *node, ir_node *right);
358 inline ir_node *get_Shrs_left (ir_node *node);
359 inline void set_Shrs_left (ir_node *node, ir_node *left);
360 inline ir_node *get_Shrs_right (ir_node *node);
361 inline void set_Shrs_right (ir_node *node, ir_node *right);
363 inline ir_node *get_Rot_left (ir_node *node);
364 inline void set_Rot_left (ir_node *node, ir_node *left);
365 inline ir_node *get_Rot_right (ir_node *node);
366 inline void set_Rot_right (ir_node *node, ir_node *right);
368 inline ir_node *get_Conv_op (ir_node *node);
369 inline void set_Conv_op (ir_node *node, ir_node *op);
371 inline int get_Phi_n_preds (ir_node *node);
372 /* inline void set_Phi_n_preds (ir_node *node, int n_preds); */
373 inline ir_node *get_Phi_pred (ir_node *node, int pos);
374 inline void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
376 inline ir_node *get_Load_mem (ir_node *node);
377 inline void set_Load_mem (ir_node *node, ir_node *mem);
378 inline ir_node *get_Load_ptr (ir_node *node);
379 inline void set_Load_ptr (ir_node *node, ir_node *ptr);
381 inline ir_node *get_Store_mem (ir_node *node);
382 inline void set_Store_mem (ir_node *node, ir_node *mem);
383 inline ir_node *get_Store_ptr (ir_node *node);
384 inline void set_Store_ptr (ir_node *node, ir_node *ptr);
385 inline ir_node *get_Store_value (ir_node *node);
386 inline void set_Store_value (ir_node *node, ir_node *value);
388 inline ir_node *get_Alloc_mem (ir_node *node);
389 inline void set_Alloc_mem (ir_node *node, ir_node *mem);
390 inline ir_node *get_Alloc_size (ir_node *node);
391 inline void set_Alloc_size (ir_node *node, ir_node *size);
392 inline type *get_Alloc_type (ir_node *node);
393 inline void set_Alloc_type (ir_node *node, type *type);
394 inline where_alloc get_Alloc_where (ir_node *node);
395 inline void set_Alloc_where (ir_node *node, where_alloc where);
397 inline ir_node *get_Free_mem (ir_node *node);
398 inline void set_Free_mem (ir_node *node, ir_node *mem);
399 inline ir_node *get_Free_ptr (ir_node *node);
400 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
401 inline ir_node *get_Free_size (ir_node *node);
402 inline void set_Alloc_size (ir_node *node, ir_node *size);
403 inline type *get_Free_type (ir_node *node);
404 inline void set_Free_type (ir_node *node, type *type);
406 inline int get_Sync_n_preds (ir_node *node);
407 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
408 inline ir_node *get_Sync_pred (ir_node *node, int pos);
409 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
411 inline ir_node *get_Proj_pred (ir_node *node);
412 inline void set_Proj_pred (ir_node *node, ir_node *pred);
413 inline long get_Proj_proj (ir_node *node);
414 inline void set_Proj_proj (ir_node *node, long proj);
416 inline int get_Tuple_n_preds (ir_node *node);
417 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
418 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
419 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
421 inline ir_node *get_Id_pred (ir_node *node);
422 inline void set_Id_pred (ir_node *node, ir_node *pred);
426 /******************************************************************/
427 /* Auxiliary routines */
428 /******************************************************************/
430 /* returns operand of node if node is a Proj. */
431 inline ir_node *skip_Proj (ir_node *node);
432 /* returns operand of node if node is a Id */
433 inline ir_node *skip_nop (ir_node *node);
434 /* returns true if node is a Bad node. */
435 inline int is_Bad (ir_node *node);
436 /* returns true if the node is not a Block */
437 inline int is_no_Block (ir_node *node);
438 /* Returns true if the operation manipulates control flow:
439 Start, End, Jmp, Cond, Return, Raise */
440 int is_cfop(ir_node *node);
441 /* Returns true if the operation can change the control flow because
443 int is_fragile_op(ir_node *node);
445 # endif /* _IRNODE_H_ */