1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
4 ** Authors: Martin Trapp, Christian Schaefer
6 ** declarations of an ir node
22 /* The typedefiniton of ir_node is also in irgraph.h to resolve
23 recursion between irnode.h and irgraph.h */
24 #ifndef _IR_NODE_TYPEDEF_
25 #define _IR_NODE_TYPEDEF_
28 * NAME ir_node - a datatype representing a Firm node
30 * NOTE Not properly documented ;-)
33 * The common fields are:
35 * firm_kind A firm_kind tag containing k_type. This is useful
36 * for dynamically checking whether a node is a ir_node.
37 * arity The number of predecessors in the Firm graph.
38 * in A list with the predecessors in the Firm graph. There are
39 * routines to access individual elements and to obtain the
40 * array. The method returning the array should not be used.
41 * mode The mode of the node. There are routines to get the mode but
42 * also to access the mode's fields directly.
43 * opcode The opcode of the node. There are routines to get the opcode but
44 * also to access the opcode's fields directly.
45 * node_nr A unique number for the node. Available only if debugging is
49 typedef struct ir_node ir_node;
52 /** Manipulate the fields of ir_node. With these access routines
53 you can work on the graph without considering the different types
54 of nodes, it's just a big graph. **/
56 /* returns the number of predecessors without the block predecessor: */
57 int get_irn_arity (ir_node *node);
58 /* returns the array with the ins: */
59 inline ir_node **get_irn_in (ir_node *node);
60 /* Replaces the old in array by a new one that will contain the ins given in
61 the parameters. Conserves the block predecessor. It copies the array passed.
62 This function is necessary to ajust in arrays of blocks, calls and phis.
63 Assumes that current_ir_graph is set to the graph containing "node".
64 "in" must contain all predecessors except the block that are required for
66 inline void set_irn_in (ir_node *node, int arity,
68 /* to iterate through the predecessors without touching the array. No
69 order of predecessors guaranteed.
70 To iterate over the operands iterate from 0 to i < get_irn_arity(),
71 to iterate including the Block predecessor iterate from i = -1 to
73 /* Access predecessor n */
74 /* get_irn_n removes Id predecessors. */
75 inline ir_node *get_irn_n (ir_node *node, int n);
76 inline void set_irn_n (ir_node *node, int n, ir_node *in);
77 /* Get the mode struct. */
78 inline ir_mode *get_irn_mode (ir_node *node);
79 /* Get the mode-enum modecode */
80 inline modecode get_irn_modecode (ir_node *node);
81 /* Get the ident for a string representation of the mode */
82 inline ident *get_irn_modeident (ir_node *node);
83 /* Access the opcode struct of the node */
84 inline ir_op *get_irn_op (ir_node *node);
85 inline void set_irn_op (ir_node *node, ir_op *op);
86 /* Get the opcode-enum of the node */
87 inline opcode get_irn_opcode (ir_node *node);
88 /* Get the ident for a string representation of the opcode */
89 inline ident *get_irn_opident (ir_node *node);
90 /* Get the string representation of the opcode */
91 inline const char *get_irn_opname (ir_node *node);
92 inline void set_irn_visited (ir_node *node, unsigned long visited);
93 inline unsigned long get_irn_visited (ir_node *node);
94 /* Sets visited to get_irg_visited(current_ir_graph) */
95 inline void mark_irn_visited (ir_node *node);
96 inline void set_irn_link (ir_node *node, ir_node *link);
97 inline ir_node *get_irn_link (ir_node *node);
99 /* Outputs a unique number for this node */
100 inline long get_irn_node_nr(ir_node *node);
104 /* irnode constructor */
105 /* Create a new irnode in irg, with an op, mode, arity and */
106 /* some incoming irnodes. */
107 /* If arity is negative, a node with a dynamic array is created. */
110 new_ir_node (ir_graph *irg,
119 * NAME access functions for node fields.
121 * NOTE Not properly documented ;-)
126 /* this works for all except Block */
127 inline ir_node *get_nodes_Block (ir_node *node);
128 inline void set_nodes_Block (ir_node *node, ir_node *block);
130 /* Projection numbers for result of Start node: use for Proj nodes! */
132 pns_initial_exec, /* Projection on an executable, the initial control
134 pns_global_store, /* Projection on the global store */
135 pns_frame_base, /* Projection on the frame base */
136 pns_globals, /* Projection on the pointer to the data segment
137 containing _all_ global entities. */
138 pns_args /* Projection on all arguments */
141 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
142 int get_Block_n_cfgpreds (ir_node *node);
143 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
144 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
145 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
146 inline bool get_Block_matured (ir_node *node);
147 inline void set_Block_matured (ir_node *node, bool matured);
148 inline unsigned long get_Block_block_visited (ir_node *node);
149 inline void set_Block_block_visited (ir_node *node, unsigned long visit);
150 /* For this current_ir_graph must be set. */
151 inline void mark_Block_block_visited(ir_node *node);
152 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
153 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
156 inline int get_End_n_keepalives(ir_node *end);
157 inline ir_node *get_End_keepalive(ir_node *end, int pos);
158 inline void add_End_keepalive (ir_node *end, ir_node *ka);
159 /* Some parts of the End node are allocated seperately -- their memory
160 is not recovered by dead_node_elimination if a End node is dead.
161 free_End frees these data structures. */
162 inline void free_End (ir_node *end);
164 /* We distinguish three kinds of Cond nodes. These can be distinguished
165 by the mode of the selector operand and an internal flag of type cond_kind.
166 First we distinguish binary Conds and switch Conds.
167 A binary Cond has as selector a boolean value. Proj(0) projects the control
168 flow for case "False", Proj(1) the control flow for "True". A binary Cond
169 is recognized by the boolean selector.
170 The switch Cond has as selector an unsigned integer. It produces as result
171 an n+1 Tuple (cf0, ... , cfn) of control flows.
172 We differ two flavours of this Cond. The first, the dense Cond, passes
173 control along output i if the selector value is i, 0 <= i <= n. If the
174 selector value is >n it passes control along output n.
175 The second Cond flavor differes in the treatment of cases not specified in
176 the source program. It magically knows about the existence of Proj nodes.
177 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
178 exists. Else it passes control along output n (even if this Proj does not
179 exist.) This Cond we call "fragmentary". There is a special constructor
180 new_defaultProj that automatically sets the flavor.
181 The two switch flavors are distinguished by a flag of type cond_kind.
182 Default flavor is "dense"
185 dense, /* Default. Missing Proj nodes are dead control flow. */
186 fragmentary /* Special. No control flow optimizations allowed. Missing
187 Proj nodes mean default control flow, i.e., Proj(n). */
190 inline ir_node *get_Cond_selector (ir_node *node);
191 inline void set_Cond_selector (ir_node *node, ir_node *selector);
192 inline cond_kind get_Cond_kind (ir_node *node);
193 inline void set_Cond_kind (ir_node *node, cond_kind kind);
195 inline ir_node *get_Return_mem (ir_node *node);
196 inline void set_Return_mem (ir_node *node, ir_node *mem);
197 inline ir_node **get_Return_res_arr (ir_node *node);
198 inline int get_Return_n_res (ir_node *node);
199 /*inline void set_Return_n_res (ir_node *node, int results); */
200 inline ir_node *get_Return_res (ir_node *node, int pos);
201 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
203 inline ir_node *get_Raise_mem (ir_node *node);
204 inline void set_Raise_mem (ir_node *node, ir_node *mem);
205 inline ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
206 inline void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
208 inline tarval *get_Const_tarval (ir_node *node);
209 inline void set_Const_tarval (ir_node *node, tarval *con);
211 /* This enum names the three different kinds of symbolic Constants
212 represented by SymConst. The content of the attribute type_or_id
213 depends on this tag. Use the proper access routine after testing
216 type_tag, /* The SymConst is a type tag for the given type.
217 Type_or_id_p is type *. */
218 size, /* The SymConst is the size of the given type.
219 Type_or_id_p is type *. */
220 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
221 by the linker. Type_or_id_p is ident *. */
223 typedef union type_or_id * type_or_id_p;
224 inline symconst_kind get_SymConst_kind (ir_node *node);
225 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
226 /* Only to access SymConst of kind type_tag or size. Else assertion: */
227 inline type *get_SymConst_type (ir_node *node);
228 inline void set_SymConst_type (ir_node *node, type *type);
229 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
230 inline ident *get_SymConst_ptrinfo (ir_node *node);
231 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
232 /* Sets both: type and ptrinfo. Needed to treat the node independent of
233 its semantics. Does a memcpy for the memory tori points to. */
234 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
235 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
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 ir_node **get_Sel_index_arr (ir_node *node);
242 inline int get_Sel_n_index (ir_node *node);
243 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
244 inline ir_node *get_Sel_index (ir_node *node, int pos);
245 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
246 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
247 inline void set_Sel_entity (ir_node *node, entity *ent);
249 static_linkage, /* entity is used internal and not visible out of this
251 external_linkage, /* */
254 inline linkage_type get_Sel_linkage_type (ir_node *node);
255 inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
257 inline ir_node *get_Call_mem (ir_node *node);
258 inline void set_Call_mem (ir_node *node, ir_node *mem);
259 inline ir_node *get_Call_ptr (ir_node *node);
260 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
261 inline ir_node **get_Call_param_arr (ir_node *node);
262 inline int get_Call_n_params (ir_node *node);
263 inline int get_Call_arity (ir_node *node);
264 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
265 inline ir_node *get_Call_param (ir_node *node, int pos);
266 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
267 inline type *get_Call_type (ir_node *node);
268 inline void set_Call_type (ir_node *node, type *type);
270 /* For unary and binary arithmetic operations the access to the
271 operands can be factored out. Left is the first, right the
272 second arithmetic value as listed in tech report 1999-44.
273 unops are: Minus, Abs, Not, Conv
274 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
275 Shr, Shrs, Rot, Cmp */
276 inline int is_unop (ir_node *node);
277 inline ir_node *get_unop_op (ir_node *node);
278 inline void set_unop_op (ir_node *node, ir_node *op);
279 inline int is_binop (ir_node *node);
280 inline ir_node *get_binop_left (ir_node *node);
281 inline void set_binop_left (ir_node *node, ir_node *left);
282 inline ir_node *get_binop_right (ir_node *node);
283 inline void set_binop_right (ir_node *node, ir_node *right);
285 inline ir_node *get_Add_left (ir_node *node);
286 inline void set_Add_left (ir_node *node, ir_node *left);
287 inline ir_node *get_Add_right (ir_node *node);
288 inline void set_Add_right (ir_node *node, ir_node *right);
290 inline ir_node *get_Sub_left (ir_node *node);
291 inline void set_Sub_left (ir_node *node, ir_node *left);
292 inline ir_node *get_Sub_right (ir_node *node);
293 inline void set_Sub_right (ir_node *node, ir_node *right);
295 inline ir_node *get_Minus_op (ir_node *node);
296 inline void set_Minus_op (ir_node *node, ir_node *op);
298 inline ir_node *get_Mul_left (ir_node *node);
299 inline void set_Mul_left (ir_node *node, ir_node *left);
300 inline ir_node *get_Mul_right (ir_node *node);
301 inline void set_Mul_right (ir_node *node, ir_node *right);
303 inline ir_node *get_Quot_left (ir_node *node);
304 inline void set_Quot_left (ir_node *node, ir_node *left);
305 inline ir_node *get_Quot_right (ir_node *node);
306 inline void set_Quot_right (ir_node *node, ir_node *right);
307 inline ir_node *get_Quot_mem (ir_node *node);
308 inline void set_Quot_mem (ir_node *node, ir_node *mem);
310 inline ir_node *get_DivMod_left (ir_node *node);
311 inline void set_DivMod_left (ir_node *node, ir_node *left);
312 inline ir_node *get_DivMod_right (ir_node *node);
313 inline void set_DivMod_right (ir_node *node, ir_node *right);
314 inline ir_node *get_DivMod_mem (ir_node *node);
315 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
317 inline ir_node *get_Div_left (ir_node *node);
318 inline void set_Div_left (ir_node *node, ir_node *left);
319 inline ir_node *get_Div_right (ir_node *node);
320 inline void set_Div_right (ir_node *node, ir_node *right);
321 inline ir_node *get_Div_mem (ir_node *node);
322 inline void set_Div_mem (ir_node *node, ir_node *mem);
324 inline ir_node *get_Mod_left (ir_node *node);
325 inline void set_Mod_left (ir_node *node, ir_node *left);
326 inline ir_node *get_Mod_right (ir_node *node);
327 inline void set_Mod_right (ir_node *node, ir_node *right);
328 inline ir_node *get_Mod_mem (ir_node *node);
329 inline void set_Mod_mem (ir_node *node, ir_node *mem);
331 inline ir_node *get_Abs_op (ir_node *node);
332 inline void set_Abs_op (ir_node *node, ir_node *op);
334 inline ir_node *get_And_left (ir_node *node);
335 inline void set_And_left (ir_node *node, ir_node *left);
336 inline ir_node *get_And_right (ir_node *node);
337 inline void set_And_right (ir_node *node, ir_node *right);
339 inline ir_node *get_Or_left (ir_node *node);
340 inline void set_Or_left (ir_node *node, ir_node *left);
341 inline ir_node *get_Or_right (ir_node *node);
342 inline void set_Or_right (ir_node *node, ir_node *right);
344 inline ir_node *get_Eor_left (ir_node *node);
345 inline void set_Eor_left (ir_node *node, ir_node *left);
346 inline ir_node *get_Eor_right (ir_node *node);
347 inline void set_Eor_right (ir_node *node, ir_node *right);
349 inline ir_node *get_Not_op (ir_node *node);
350 inline void set_Not_op (ir_node *node, ir_node *op);
352 /* Projection numbers of compare: use for Proj nodes! */
357 Le, /* less or equal */
359 Ge, /* greater or equal */
360 Lg, /* less or greater */
361 Leg, /* less, equal or greater = ordered */
363 Ue, /* unordered or equal */
364 Ul, /* unordered or less */
365 Ule, /* unordered, less or equal */
366 Ug, /* unordered or greater */
367 Uge, /* unordered, greater or equal */
368 Ne, /* unordered, less or greater = not equal */
370 not_mask = Leg /* bits to flip to negate comparison */
372 inline char *get_pnc_string(int pnc);
373 inline int get_negated_pnc(int pnc);
374 inline ir_node *get_Cmp_left (ir_node *node);
375 inline void set_Cmp_left (ir_node *node, ir_node *left);
376 inline ir_node *get_Cmp_right (ir_node *node);
377 inline void set_Cmp_right (ir_node *node, ir_node *right);
379 inline ir_node *get_Shl_left (ir_node *node);
380 inline void set_Shl_left (ir_node *node, ir_node *left);
381 inline ir_node *get_Shl_right (ir_node *node);
382 inline void set_Shl_right (ir_node *node, ir_node *right);
384 inline ir_node *get_Shr_left (ir_node *node);
385 inline void set_Shr_left (ir_node *node, ir_node *left);
386 inline ir_node *get_Shr_right (ir_node *node);
387 inline void set_Shr_right (ir_node *node, ir_node *right);
389 inline ir_node *get_Shrs_left (ir_node *node);
390 inline void set_Shrs_left (ir_node *node, ir_node *left);
391 inline ir_node *get_Shrs_right (ir_node *node);
392 inline void set_Shrs_right (ir_node *node, ir_node *right);
394 inline ir_node *get_Rot_left (ir_node *node);
395 inline void set_Rot_left (ir_node *node, ir_node *left);
396 inline ir_node *get_Rot_right (ir_node *node);
397 inline void set_Rot_right (ir_node *node, ir_node *right);
399 inline ir_node *get_Conv_op (ir_node *node);
400 inline void set_Conv_op (ir_node *node, ir_node *op);
402 inline ir_node **get_Phi_preds_arr (ir_node *node);
403 inline int get_Phi_n_preds (ir_node *node);
404 /* inline void set_Phi_n_preds (ir_node *node, int n_preds); */
405 inline ir_node *get_Phi_pred (ir_node *node, int pos);
406 inline void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
408 inline ir_node *get_Load_mem (ir_node *node);
409 inline void set_Load_mem (ir_node *node, ir_node *mem);
410 inline ir_node *get_Load_ptr (ir_node *node);
411 inline void set_Load_ptr (ir_node *node, ir_node *ptr);
413 inline ir_node *get_Store_mem (ir_node *node);
414 inline void set_Store_mem (ir_node *node, ir_node *mem);
415 inline ir_node *get_Store_ptr (ir_node *node);
416 inline void set_Store_ptr (ir_node *node, ir_node *ptr);
417 inline ir_node *get_Store_value (ir_node *node);
418 inline void set_Store_value (ir_node *node, ir_node *value);
420 inline ir_node *get_Alloc_mem (ir_node *node);
421 inline void set_Alloc_mem (ir_node *node, ir_node *mem);
422 inline ir_node *get_Alloc_size (ir_node *node);
423 inline void set_Alloc_size (ir_node *node, ir_node *size);
424 inline type *get_Alloc_type (ir_node *node);
425 inline void set_Alloc_type (ir_node *node, type *type);
427 stack_alloc, /* Alloc allocates the object on the stack. */
428 heap_alloc /* Alloc allocates the object on the heap. */
430 inline where_alloc get_Alloc_where (ir_node *node);
431 inline void set_Alloc_where (ir_node *node, where_alloc where);
433 inline ir_node *get_Free_mem (ir_node *node);
434 inline void set_Free_mem (ir_node *node, ir_node *mem);
435 inline ir_node *get_Free_ptr (ir_node *node);
436 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
437 inline ir_node *get_Free_size (ir_node *node);
438 inline void set_Free_size (ir_node *node, ir_node *size);
439 inline type *get_Free_type (ir_node *node);
440 inline void set_Free_type (ir_node *node, type *type);
442 inline ir_node **get_Sync_preds_arr (ir_node *node);
443 inline int get_Sync_n_preds (ir_node *node);
444 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
445 inline ir_node *get_Sync_pred (ir_node *node, int pos);
446 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
448 inline ir_node *get_Proj_pred (ir_node *node);
449 inline void set_Proj_pred (ir_node *node, ir_node *pred);
450 inline long get_Proj_proj (ir_node *node);
451 inline void set_Proj_proj (ir_node *node, long proj);
453 inline ir_node **get_Tuple_preds_arr (ir_node *node);
454 inline int get_Tuple_n_preds (ir_node *node);
455 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
456 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
457 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
459 inline ir_node *get_Id_pred (ir_node *node);
460 inline void set_Id_pred (ir_node *node, ir_node *pred);
464 /****s* irnode/other2
466 * NAME Auxiliary routines
468 * NOTE Not properly documented ;-)
473 /* returns operand of node if node is a Proj. */
474 inline ir_node *skip_Proj (ir_node *node);
475 /* returns operand of node if node is a Id */
476 inline ir_node *skip_nop (ir_node *node);
477 inline ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
478 /* returns corresponding operand of Tuple if node is a Proj from
480 inline ir_node *skip_Tuple (ir_node *node);
481 /* returns true if node is a Bad node. */
482 inline int is_Bad (ir_node *node);
483 /* returns true if the node is not a Block */
484 inline int is_no_Block (ir_node *node);
485 /* Returns true if the operation manipulates control flow:
486 Start, End, Jmp, Cond, Return, Raise, Bad */
487 int is_cfop(ir_node *node);
488 /* Returns true if the operation can change the control flow because
489 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
491 int is_fragile_op(ir_node *node);
492 /* Returns the memory operand of fragile operations. */
493 ir_node *get_fragile_op_mem(ir_node *node);
497 /* Makros for debugging the libfirm */
498 /*#ifdef DEBUG_libfirm*/
501 #define DDMSG printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
502 #define DDMSG1(X) printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, \
503 id_to_str(get_irn_opident(X)))
504 #define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__, \
505 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
507 #define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, \
508 print_firm_kind(X), (X))
509 #define DDMSG4(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, \
510 get_type_tpop_nameid(X), get_type_ident(X), (X))
511 #define DDMSG5(X) printf("%s%s: %ld", \
512 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
516 #define DDMN(X) xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FUNCTION__, __LINE__, \
517 get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), (X))
518 #define DDMNB(X) xprintf("%I%I: %ld (in block %ld)\n", \
519 get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), \
520 get_irn_node_nr(get_nodes_Block(X)))
521 #define DDMT(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, \
522 get_type_tpop_nameid(X), get_type_ident(X), (X))
523 #define DDME(X) xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__, \
524 get_entity_ident(X), (X))
528 # endif /* _IRNODE_H_ */