1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
4 ** Authors: Martin Trapp, Christian Schaefer
6 ** declarations of an ir node
20 /* projection numbers of compare. */
25 Le, /* less or equal */
27 Ge, /* greater or equal */
28 Lg, /* less or greater */
29 Leg, /* less, equal or greater = ordered */
31 Ue, /* unordered or equal */
32 Ul, /* unordered or less */
33 Ule, /* unordered, less or equal */
34 Ug, /* unordered or greater */
35 Uge, /* unordered, greater or equal */
36 Ne, /* unordered, less or greater = not equal */
38 not_mask = Leg /* bits to flip to negate comparison */
42 get_pnc_string(int pnc);
45 get_negated_pnc(int pnc);
48 /* projection numbers for result of Start node. */
50 pns_initial_exec, /* Projection on an executable, the initial control
52 pns_global_store, /* Projection on the global store */
53 pns_frame_base, /* Projection on the frame base */
54 pns_globals, /* Projection on the pointer to the data segment
55 containing _all_ global entities. */
56 pns_args /* Projection on all arguments */
59 /** ir node attributes **/
60 /* Block attributes */
62 unsigned long block_visited; /* 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 */
68 /* SymConst attributes */
69 /* This enum names the three different kinds of symbolic Constants
70 represented by SymConst. The content of the attribute type_or_id
71 depends on this tag. */
73 type_tag, /* The SymConst is a type tag for the given type.
75 size, /* The SymConst is the size of the given type.
77 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
78 by the linker. Type_or_id is ident */
81 /* This union contains the symbolic information represented by the node */
94 static_linkage, /* entity is used internal and not visible out of this
96 external_linkage, /* */
101 entity *ent; /* entity to select */
102 linkage_type ltyp; /* linkage type of the entity */
105 /* Alloc attributes */
107 stack_alloc, /* Alloc allocates the object on the stack. */
108 heap_alloc /* Alloc allocates the object on the heap. */
112 type *type; /* Type of the allocated object. */
113 where_alloc where; /* stack, heap or other managed part of memory */
116 /* Some irnodes just have one attribute, these are stored here,
117 some have more. Their name is 'irnodename_attr' */
119 block_attr block; /* For Block: Fields needed to construct it */
120 struct tarval *con; /* For Const: contains the value of the constant */
121 symconst_attr i; /* For SymConst. */
122 sel_attr s; /* For Sel. */
123 type_method *call; /* For Call: pointer to the type of the method to call */
124 long proj; /* For Proj: contains the result position to project */
125 alloc_attr a; /* For Alloc. */
126 type *f; /* For Free. */
127 int phi0_pos; /* For Phi. Used to remember the value defined by
128 this Phi node. Needed when the Phi is completed
129 to call get_r_internal_value to find the
130 predecessors. If this attribute is set, the Phi
131 node takes the role of the obsolete Phi0 node,
132 therefore the name. */
136 /* common structure of an irnode */
137 /* if the node has some attributes, they are stored in attr */
140 firm_kind kind; /* distinguishes this node from others */
141 ir_op *op; /* Opcode of this node. */
142 ir_mode *mode; /* Mode of this node. */
143 unsigned long visited; /* visited counter for walks of the graph */
144 struct ir_node **in; /* array with predecessors / operands */
145 struct ir_node *link; /* for linking nodes somehow to a list, e.g.
146 used while construction to link Phi0 nodes and
147 during optimization to link to nodes that
148 shall replace a node. */
149 attr attr; /* attribute of this node. Depends on opcode. */
150 /* Must be last field of struct ir_node. */
154 /* The typedefiniton of ir_node is also in irgraph.h to resolve
155 recursion between irnode.h and irgraph.h */
156 #ifndef _IR_NODE_TYPEDEF_
157 #define _IR_NODE_TYPEDEF_
158 typedef struct ir_node ir_node;
161 /* irnode constructor */
162 /* Create a new irnode in irg, with an op, mode, arity and */
163 /* some incoming irnodes. */
164 /* If arity is negative, a node with a dynamic array is created. */
167 new_ir_node (ir_graph *irg,
175 /* Print IR-Nodes with attributes */
176 /* @@@@ brauchen wir dienoch? dann fliegt ev. das xprint raus?*/
177 int ir_node_print (XP_PAR1, const xprintf_info *, XP_PARN);
180 /** manipulate the fields of ir_node **/
182 /* returns the number of predecessors without the block predecessor: */
183 int get_irn_arity (ir_node *node);
184 /* returns the array with the ins: */
185 inline ir_node **get_irn_in (ir_node *node);
186 /* to iterate through the predecessors without touching the array. No
187 order of predecessors guaranteed.
188 To iterate over the operands iterate from 0 to i < get_irn_arity(),
189 to iterate includind the Block predecessor iterate from i = -1 to
190 i < get_irn_arity. */
191 inline ir_node *get_irn_n (ir_node *node, int n);
192 inline void set_irn_n (ir_node *node, int n, ir_node *in);
193 inline ir_mode *get_irn_mode (ir_node *node);
194 inline modecode get_irn_modecode (ir_node *node);
195 inline void set_irn_op (ir_node *node, ir_op *op);
196 inline ir_op *get_irn_op (ir_node *node);
197 inline void set_irn_visited (ir_node *node, unsigned long visited);
198 inline unsigned long get_irn_visited (ir_node *node);
199 /* should be private to the library: */
200 inline opcode get_irn_opcode (ir_node *node);
201 inline void set_irn_link (ir_node *node, ir_node *link);
202 inline ir_node *get_irn_link (ir_node *node);
205 /** access attributes directly **/
206 inline tarval *get_irn_const_attr (ir_node *node);
207 inline long get_irn_proj_attr (ir_node *node);
208 inline alloc_attr get_irn_alloc_attr (ir_node *node);
209 inline type *get_irn_free_attr (ir_node *node);
210 inline symconst_attr get_irn_symconst_attr (ir_node *node);
211 type_method *get_irn_call_attr (ir_node *node);
212 sel_attr get_irn_sel_attr (ir_node *node);
213 int get_irn_phi_attr (ir_node *node);
214 block_attr get_irn_return_attr (ir_node *node);
216 /** manipulate fields of individual nodes **/
218 /* this works for all except Block */
219 inline ir_node *get_nodes_Block (ir_node *node);
220 inline void set_nodes_Block (ir_node *node, ir_node *block);
221 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
222 int get_Block_n_cfgpreds (ir_node *node);
223 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
225 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
226 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
227 inline bool get_Block_matured (ir_node *node);
228 inline void set_Block_matured (ir_node *node, bool matured);
229 inline unsigned long get_Block_block_visit (ir_node *node);
230 inline void set_Block_block_visit (ir_node *node, unsigned long visit);
231 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
232 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
234 inline ir_node *get_Cond_selector (ir_node *node);
235 inline void set_Cond_selector (ir_node *node, ir_node *selector);
237 inline ir_node *get_Return_mem (ir_node *node);
238 inline void set_Return_mem (ir_node *node, ir_node *mem);
239 inline ir_node **get_Return_res_arr (ir_node *node);
240 inline int get_Return_n_res (ir_node *node);
241 /*inline void set_Return_n_res (ir_node *node, int results); */
242 inline ir_node *get_Return_res (ir_node *node, int pos);
243 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
245 inline ir_node *get_Raise_mem (ir_node *node);
246 inline void set_Raise_mem (ir_node *node, ir_node *mem);
247 inline ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
248 inline void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
250 inline tarval *get_Const_tarval (ir_node *node);
251 inline void set_Const_tarval (ir_node *node, tarval *con);
253 inline symconst_kind get_SymConst_kind (ir_node *node);
254 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
255 inline type *get_SymConst_type (ir_node *node);
256 inline void set_SymConst_type (ir_node *node, type *type);
257 inline ident *get_SymConst_ptrinfo (ir_node *node);
258 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
260 inline ir_node *get_Sel_mem (ir_node *node);
261 inline void set_Sel_mem (ir_node *node, ir_node *mem);
262 inline ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
263 inline void set_Sel_ptr (ir_node *node, ir_node *ptr);
264 inline ir_node **get_Sel_index_arr (ir_node *node);
265 inline int get_Sel_n_index (ir_node *node);
266 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
269 inline ir_node *get_Call_mem (ir_node *node);
270 inline void set_Call_mem (ir_node *node, ir_node *mem);
271 inline ir_node *get_Call_ptr (ir_node *node);
272 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
273 inline ir_node **get_Call_param_arr (ir_node *node);
274 inline int get_Call_arity (ir_node *node);
276 inline ir_node *get_Sel_index (ir_node *node, int pos);
277 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
278 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
279 inline void set_Sel_entity (ir_node *node, entity *ent);
280 inline linkage_type get_Sel_linkage_type (ir_node *node);
281 inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
283 inline ir_node *get_Call_mem (ir_node *node);
284 inline void set_Call_mem (ir_node *node, ir_node *mem);
285 inline ir_node *get_Call_ptr (ir_node *node);
286 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
287 inline int get_Call_arity (ir_node *node);
288 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
289 inline ir_node *get_Call_param (ir_node *node, int pos);
290 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
291 inline type_method *get_Call_type (ir_node *node);
292 inline void set_Call_type (ir_node *node, type_method *type);
294 /* For unary and binary arithmetic operations the access to the
295 operands can be factored out. Left is the first, right the
296 second arithmetic value as listed in tech report 1999-44.
297 unops are: Minus, Abs, Not, Conv
298 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
299 Shr, Shrs, Rot, Cmp */
300 inline int is_unop (ir_node *node);
301 inline ir_node *get_unop_op (ir_node *node);
302 inline void set_unop_op (ir_node *node, ir_node *op);
303 inline int is_binop (ir_node *node);
304 inline ir_node *get_binop_left (ir_node *node);
305 inline void set_binop_left (ir_node *node, ir_node *left);
306 inline ir_node *get_binop_right (ir_node *node);
307 inline void set_binop_right (ir_node *node, ir_node *right);
309 inline ir_node *get_Add_left (ir_node *node);
310 inline void set_Add_left (ir_node *node, ir_node *left);
311 inline ir_node *get_Add_right (ir_node *node);
312 inline void set_Add_right (ir_node *node, ir_node *right);
314 inline ir_node *get_Sub_left (ir_node *node);
315 inline void set_Sub_left (ir_node *node, ir_node *left);
316 inline ir_node *get_Sub_right (ir_node *node);
317 inline void set_Sub_right (ir_node *node, ir_node *right);
319 inline ir_node *get_Minus_op (ir_node *node);
320 inline void set_Minus_op (ir_node *node, ir_node *op);
322 inline ir_node *get_Mul_left (ir_node *node);
323 inline void set_Mul_left (ir_node *node, ir_node *left);
324 inline ir_node *get_Mul_right (ir_node *node);
325 inline void set_Mul_right (ir_node *node, ir_node *right);
327 inline ir_node *get_Quot_left (ir_node *node);
328 inline void set_Quot_left (ir_node *node, ir_node *left);
329 inline ir_node *get_Quot_right (ir_node *node);
330 inline void set_Quot_right (ir_node *node, ir_node *right);
331 inline ir_node *get_Quot_mem (ir_node *node);
332 inline void set_Quot_mem (ir_node *node, ir_node *mem);
334 inline ir_node *get_DivMod_left (ir_node *node);
335 inline void set_DivMod_left (ir_node *node, ir_node *left);
336 inline ir_node *get_DivMod_right (ir_node *node);
337 inline void set_DivMod_right (ir_node *node, ir_node *right);
338 inline ir_node *get_DivMod_mem (ir_node *node);
339 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
341 inline ir_node *get_Div_left (ir_node *node);
342 inline void set_Div_left (ir_node *node, ir_node *left);
343 inline ir_node *get_Div_right (ir_node *node);
344 inline void set_Div_right (ir_node *node, ir_node *right);
345 inline ir_node *get_Div_mem (ir_node *node);
346 inline void set_Div_mem (ir_node *node, ir_node *mem);
348 inline ir_node *get_Mod_left (ir_node *node);
349 inline void set_Mod_left (ir_node *node, ir_node *left);
350 inline ir_node *get_Mod_right (ir_node *node);
351 inline void set_Mod_right (ir_node *node, ir_node *right);
352 inline ir_node *get_Mod_mem (ir_node *node);
353 inline void set_Mod_mem (ir_node *node, ir_node *mem);
355 inline ir_node *get_Abs_op (ir_node *node);
356 inline void set_Abs_op (ir_node *node, ir_node *op);
358 inline ir_node *get_And_left (ir_node *node);
359 inline void set_And_left (ir_node *node, ir_node *left);
360 inline ir_node *get_And_right (ir_node *node);
361 inline void set_And_right (ir_node *node, ir_node *right);
363 inline ir_node *get_Or_left (ir_node *node);
364 inline void set_Or_left (ir_node *node, ir_node *left);
365 inline ir_node *get_Or_right (ir_node *node);
366 inline void set_Or_right (ir_node *node, ir_node *right);
368 inline ir_node *get_Eor_left (ir_node *node);
369 inline void set_Eor_left (ir_node *node, ir_node *left);
370 inline ir_node *get_Eor_right (ir_node *node);
371 inline void set_Eor_right (ir_node *node, ir_node *right);
373 inline ir_node *get_Not_op (ir_node *node);
374 inline void set_Not_op (ir_node *node, ir_node *op);
376 inline ir_node *get_Cmp_left (ir_node *node);
377 inline void set_Cmp_left (ir_node *node, ir_node *left);
378 inline ir_node *get_Cmp_right (ir_node *node);
379 inline void set_Cmp_right (ir_node *node, ir_node *right);
381 inline ir_node *get_Shl_left (ir_node *node);
382 inline void set_Shl_left (ir_node *node, ir_node *left);
383 inline ir_node *get_Shl_right (ir_node *node);
384 inline void set_Shl_right (ir_node *node, ir_node *right);
386 inline ir_node *get_Shr_left (ir_node *node);
387 inline void set_Shr_left (ir_node *node, ir_node *left);
388 inline ir_node *get_Shr_right (ir_node *node);
389 inline void set_Shr_right (ir_node *node, ir_node *right);
391 inline ir_node *get_Shrs_left (ir_node *node);
392 inline void set_Shrs_left (ir_node *node, ir_node *left);
393 inline ir_node *get_Shrs_right (ir_node *node);
394 inline void set_Shrs_right (ir_node *node, ir_node *right);
396 inline ir_node *get_Rot_left (ir_node *node);
397 inline void set_Rot_left (ir_node *node, ir_node *left);
398 inline ir_node *get_Rot_right (ir_node *node);
399 inline void set_Rot_right (ir_node *node, ir_node *right);
401 inline ir_node *get_Conv_op (ir_node *node);
402 inline void set_Conv_op (ir_node *node, ir_node *op);
404 inline ir_node **get_Phi_preds_arr (ir_node *node);
405 inline int get_Phi_n_preds (ir_node *node);
406 /* inline void set_Phi_n_preds (ir_node *node, int n_preds); */
407 inline ir_node *get_Phi_pred (ir_node *node, int pos);
408 inline void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
410 inline ir_node *get_Load_mem (ir_node *node);
411 inline void set_Load_mem (ir_node *node, ir_node *mem);
412 inline ir_node *get_Load_ptr (ir_node *node);
413 inline void set_Load_ptr (ir_node *node, ir_node *ptr);
415 inline ir_node *get_Store_mem (ir_node *node);
416 inline void set_Store_mem (ir_node *node, ir_node *mem);
417 inline ir_node *get_Store_ptr (ir_node *node);
418 inline void set_Store_ptr (ir_node *node, ir_node *ptr);
419 inline ir_node *get_Store_value (ir_node *node);
420 inline void set_Store_value (ir_node *node, ir_node *value);
422 inline ir_node *get_Alloc_mem (ir_node *node);
423 inline void set_Alloc_mem (ir_node *node, ir_node *mem);
424 inline ir_node *get_Alloc_size (ir_node *node);
425 inline void set_Alloc_size (ir_node *node, ir_node *size);
426 inline type *get_Alloc_type (ir_node *node);
427 inline void set_Alloc_type (ir_node *node, type *type);
428 inline where_alloc get_Alloc_where (ir_node *node);
429 inline void set_Alloc_where (ir_node *node, where_alloc where);
431 inline ir_node *get_Free_mem (ir_node *node);
432 inline void set_Free_mem (ir_node *node, ir_node *mem);
433 inline ir_node *get_Free_ptr (ir_node *node);
434 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
435 inline ir_node *get_Free_size (ir_node *node);
436 inline void set_Free_size (ir_node *node, ir_node *size);
437 inline type *get_Free_type (ir_node *node);
438 inline void set_Free_type (ir_node *node, type *type);
440 inline ir_node **get_Sync_preds_arr (ir_node *node);
441 inline int get_Sync_n_preds (ir_node *node);
442 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
443 inline ir_node *get_Sync_pred (ir_node *node, int pos);
444 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
446 inline ir_node *get_Proj_pred (ir_node *node);
447 inline void set_Proj_pred (ir_node *node, ir_node *pred);
448 inline long get_Proj_proj (ir_node *node);
449 inline void set_Proj_proj (ir_node *node, long proj);
451 inline ir_node **get_Tuple_preds_arr (ir_node *node);
452 inline int get_Tuple_n_preds (ir_node *node);
453 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
454 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
455 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
457 inline ir_node *get_Id_pred (ir_node *node);
458 inline void set_Id_pred (ir_node *node, ir_node *pred);
462 /******************************************************************/
463 /* Auxiliary routines */
464 /******************************************************************/
466 /* returns operand of node if node is a Proj. */
467 inline ir_node *skip_Proj (ir_node *node);
468 /* returns operand of node if node is a Id */
469 inline ir_node *skip_nop (ir_node *node);
470 /* returns true if node is a Bad node. */
471 inline int is_Bad (ir_node *node);
472 /* returns true if the node is not a Block */
473 inline int is_no_Block (ir_node *node);
474 /* Returns true if the operation manipulates control flow:
475 Start, End, Jmp, Cond, Return, Raise */
476 int is_cfop(ir_node *node);
477 /* Returns true if the operation can change the control flow because
479 int is_fragile_op(ir_node *node);
481 # endif /* _IRNODE_H_ */