1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe 3 2002/02/28 13:33:52
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 /* Returns 1 of visited < get_irg_visited(current_ir_graph). */
97 inline int irn_not_visited (ir_node *node);
98 inline void set_irn_link (ir_node *node, ir_node *link);
99 inline ir_node *get_irn_link (ir_node *node);
101 /* Outputs a unique number for this node */
102 inline long get_irn_node_nr(ir_node *node);
106 /* irnode constructor */
107 /* Create a new irnode in irg, with an op, mode, arity and */
108 /* some incoming irnodes. */
109 /* If arity is negative, a node with a dynamic array is created. */
112 new_ir_node (ir_graph *irg,
121 * NAME access functions for node fields.
123 * NOTE Not properly documented ;-)
128 /* this works for all except Block */
129 inline ir_node *get_nodes_Block (ir_node *node);
130 inline void set_nodes_Block (ir_node *node, ir_node *block);
132 /* Projection numbers for result of Start node: use for Proj nodes! */
134 pns_initial_exec, /* Projection on an executable, the initial control
136 pns_global_store, /* Projection on the global store */
137 pns_frame_base, /* Projection on the frame base */
138 pns_globals, /* Projection on the pointer to the data segment
139 containing _all_ global entities. */
140 pns_args /* Projection on all arguments */
143 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
144 int get_Block_n_cfgpreds (ir_node *node);
145 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
146 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
147 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
148 inline bool get_Block_matured (ir_node *node);
149 inline void set_Block_matured (ir_node *node, bool matured);
150 inline unsigned long get_Block_block_visited (ir_node *node);
151 inline void set_Block_block_visited (ir_node *node, unsigned long visit);
152 /* For this current_ir_graph must be set. */
153 inline void mark_Block_block_visited(ir_node *node);
154 inline int Block_not_block_visited(ir_node *node);
155 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
156 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
159 inline int get_End_n_keepalives(ir_node *end);
160 inline ir_node *get_End_keepalive(ir_node *end, int pos);
161 inline void add_End_keepalive (ir_node *end, ir_node *ka);
162 /* Some parts of the End node are allocated seperately -- their memory
163 is not recovered by dead_node_elimination if a End node is dead.
164 free_End frees these data structures. */
165 inline void free_End (ir_node *end);
167 /* We distinguish three kinds of Cond nodes. These can be distinguished
168 by the mode of the selector operand and an internal flag of type cond_kind.
169 First we distinguish binary Conds and switch Conds.
170 A binary Cond has as selector a boolean value. Proj(0) projects the control
171 flow for case "False", Proj(1) the control flow for "True". A binary Cond
172 is recognized by the boolean selector.
173 The switch Cond has as selector an unsigned integer. It produces as result
174 an n+1 Tuple (cf0, ... , cfn) of control flows.
175 We differ two flavours of this Cond. The first, the dense Cond, passes
176 control along output i if the selector value is i, 0 <= i <= n. If the
177 selector value is >n it passes control along output n.
178 The second Cond flavor differes in the treatment of cases not specified in
179 the source program. It magically knows about the existence of Proj nodes.
180 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
181 exists. Else it passes control along output n (even if this Proj does not
182 exist.) This Cond we call "fragmentary". There is a special constructor
183 new_defaultProj that automatically sets the flavor.
184 The two switch flavors are distinguished by a flag of type cond_kind.
185 Default flavor is "dense"
188 dense, /* Default. Missing Proj nodes are dead control flow. */
189 fragmentary /* Special. No control flow optimizations allowed. Missing
190 Proj nodes mean default control flow, i.e., Proj(n). */
193 inline ir_node *get_Cond_selector (ir_node *node);
194 inline void set_Cond_selector (ir_node *node, ir_node *selector);
195 inline cond_kind get_Cond_kind (ir_node *node);
196 inline void set_Cond_kind (ir_node *node, cond_kind kind);
198 inline ir_node *get_Return_mem (ir_node *node);
199 inline void set_Return_mem (ir_node *node, ir_node *mem);
200 inline ir_node **get_Return_res_arr (ir_node *node);
201 inline int get_Return_n_res (ir_node *node);
202 /*inline void set_Return_n_res (ir_node *node, int results); */
203 inline ir_node *get_Return_res (ir_node *node, int pos);
204 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
206 inline ir_node *get_Raise_mem (ir_node *node);
207 inline void set_Raise_mem (ir_node *node, ir_node *mem);
208 inline ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
209 inline void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
211 inline tarval *get_Const_tarval (ir_node *node);
212 inline void set_Const_tarval (ir_node *node, tarval *con);
214 /* This enum names the three different kinds of symbolic Constants
215 represented by SymConst. The content of the attribute type_or_id
216 depends on this tag. Use the proper access routine after testing
219 type_tag, /* The SymConst is a type tag for the given type.
220 Type_or_id_p is type *. */
221 size, /* The SymConst is the size of the given type.
222 Type_or_id_p is type *. */
223 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
224 by the linker. Type_or_id_p is ident *. */
226 typedef union type_or_id * type_or_id_p;
227 inline symconst_kind get_SymConst_kind (ir_node *node);
228 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
229 /* Only to access SymConst of kind type_tag or size. Else assertion: */
230 inline type *get_SymConst_type (ir_node *node);
231 inline void set_SymConst_type (ir_node *node, type *type);
232 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
233 inline ident *get_SymConst_ptrinfo (ir_node *node);
234 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
235 /* Sets both: type and ptrinfo. Needed to treat the node independent of
236 its semantics. Does a memcpy for the memory tori points to. */
237 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
238 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
240 inline ir_node *get_Sel_mem (ir_node *node);
241 inline void set_Sel_mem (ir_node *node, ir_node *mem);
242 inline ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
243 inline void set_Sel_ptr (ir_node *node, ir_node *ptr);
244 inline ir_node **get_Sel_index_arr (ir_node *node);
245 inline int get_Sel_n_index (ir_node *node);
246 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
247 inline ir_node *get_Sel_index (ir_node *node, int pos);
248 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
249 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
250 inline void set_Sel_entity (ir_node *node, entity *ent);
252 static_linkage, /* entity is used internal and not visible out of this
254 external_linkage, /* */
257 inline linkage_type get_Sel_linkage_type (ir_node *node);
258 inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
260 inline ir_node *get_Call_mem (ir_node *node);
261 inline void set_Call_mem (ir_node *node, ir_node *mem);
262 inline ir_node *get_Call_ptr (ir_node *node);
263 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
264 inline ir_node **get_Call_param_arr (ir_node *node);
265 inline int get_Call_n_params (ir_node *node);
266 inline int get_Call_arity (ir_node *node);
267 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
268 inline ir_node *get_Call_param (ir_node *node, int pos);
269 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
270 inline type *get_Call_type (ir_node *node);
271 inline void set_Call_type (ir_node *node, type *type);
273 /* For unary and binary arithmetic operations the access to the
274 operands can be factored out. Left is the first, right the
275 second arithmetic value as listed in tech report 1999-44.
276 unops are: Minus, Abs, Not, Conv
277 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
278 Shr, Shrs, Rot, Cmp */
279 inline int is_unop (ir_node *node);
280 inline ir_node *get_unop_op (ir_node *node);
281 inline void set_unop_op (ir_node *node, ir_node *op);
282 inline int is_binop (ir_node *node);
283 inline ir_node *get_binop_left (ir_node *node);
284 inline void set_binop_left (ir_node *node, ir_node *left);
285 inline ir_node *get_binop_right (ir_node *node);
286 inline void set_binop_right (ir_node *node, ir_node *right);
288 inline ir_node *get_Add_left (ir_node *node);
289 inline void set_Add_left (ir_node *node, ir_node *left);
290 inline ir_node *get_Add_right (ir_node *node);
291 inline void set_Add_right (ir_node *node, ir_node *right);
293 inline ir_node *get_Sub_left (ir_node *node);
294 inline void set_Sub_left (ir_node *node, ir_node *left);
295 inline ir_node *get_Sub_right (ir_node *node);
296 inline void set_Sub_right (ir_node *node, ir_node *right);
298 inline ir_node *get_Minus_op (ir_node *node);
299 inline void set_Minus_op (ir_node *node, ir_node *op);
301 inline ir_node *get_Mul_left (ir_node *node);
302 inline void set_Mul_left (ir_node *node, ir_node *left);
303 inline ir_node *get_Mul_right (ir_node *node);
304 inline void set_Mul_right (ir_node *node, ir_node *right);
306 inline ir_node *get_Quot_left (ir_node *node);
307 inline void set_Quot_left (ir_node *node, ir_node *left);
308 inline ir_node *get_Quot_right (ir_node *node);
309 inline void set_Quot_right (ir_node *node, ir_node *right);
310 inline ir_node *get_Quot_mem (ir_node *node);
311 inline void set_Quot_mem (ir_node *node, ir_node *mem);
313 inline ir_node *get_DivMod_left (ir_node *node);
314 inline void set_DivMod_left (ir_node *node, ir_node *left);
315 inline ir_node *get_DivMod_right (ir_node *node);
316 inline void set_DivMod_right (ir_node *node, ir_node *right);
317 inline ir_node *get_DivMod_mem (ir_node *node);
318 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
320 inline ir_node *get_Div_left (ir_node *node);
321 inline void set_Div_left (ir_node *node, ir_node *left);
322 inline ir_node *get_Div_right (ir_node *node);
323 inline void set_Div_right (ir_node *node, ir_node *right);
324 inline ir_node *get_Div_mem (ir_node *node);
325 inline void set_Div_mem (ir_node *node, ir_node *mem);
327 inline ir_node *get_Mod_left (ir_node *node);
328 inline void set_Mod_left (ir_node *node, ir_node *left);
329 inline ir_node *get_Mod_right (ir_node *node);
330 inline void set_Mod_right (ir_node *node, ir_node *right);
331 inline ir_node *get_Mod_mem (ir_node *node);
332 inline void set_Mod_mem (ir_node *node, ir_node *mem);
334 inline ir_node *get_Abs_op (ir_node *node);
335 inline void set_Abs_op (ir_node *node, ir_node *op);
337 inline ir_node *get_And_left (ir_node *node);
338 inline void set_And_left (ir_node *node, ir_node *left);
339 inline ir_node *get_And_right (ir_node *node);
340 inline void set_And_right (ir_node *node, ir_node *right);
342 inline ir_node *get_Or_left (ir_node *node);
343 inline void set_Or_left (ir_node *node, ir_node *left);
344 inline ir_node *get_Or_right (ir_node *node);
345 inline void set_Or_right (ir_node *node, ir_node *right);
347 inline ir_node *get_Eor_left (ir_node *node);
348 inline void set_Eor_left (ir_node *node, ir_node *left);
349 inline ir_node *get_Eor_right (ir_node *node);
350 inline void set_Eor_right (ir_node *node, ir_node *right);
352 inline ir_node *get_Not_op (ir_node *node);
353 inline void set_Not_op (ir_node *node, ir_node *op);
355 /* Projection numbers of compare: use for Proj nodes! */
360 Le, /* less or equal */
362 Ge, /* greater or equal */
363 Lg, /* less or greater */
364 Leg, /* less, equal or greater = ordered */
366 Ue, /* unordered or equal */
367 Ul, /* unordered or less */
368 Ule, /* unordered, less or equal */
369 Ug, /* unordered or greater */
370 Uge, /* unordered, greater or equal */
371 Ne, /* unordered, less or greater = not equal */
373 not_mask = Leg /* bits to flip to negate comparison */
375 inline char *get_pnc_string(int pnc);
376 inline int get_negated_pnc(int pnc);
377 inline ir_node *get_Cmp_left (ir_node *node);
378 inline void set_Cmp_left (ir_node *node, ir_node *left);
379 inline ir_node *get_Cmp_right (ir_node *node);
380 inline void set_Cmp_right (ir_node *node, ir_node *right);
382 inline ir_node *get_Shl_left (ir_node *node);
383 inline void set_Shl_left (ir_node *node, ir_node *left);
384 inline ir_node *get_Shl_right (ir_node *node);
385 inline void set_Shl_right (ir_node *node, ir_node *right);
387 inline ir_node *get_Shr_left (ir_node *node);
388 inline void set_Shr_left (ir_node *node, ir_node *left);
389 inline ir_node *get_Shr_right (ir_node *node);
390 inline void set_Shr_right (ir_node *node, ir_node *right);
392 inline ir_node *get_Shrs_left (ir_node *node);
393 inline void set_Shrs_left (ir_node *node, ir_node *left);
394 inline ir_node *get_Shrs_right (ir_node *node);
395 inline void set_Shrs_right (ir_node *node, ir_node *right);
397 inline ir_node *get_Rot_left (ir_node *node);
398 inline void set_Rot_left (ir_node *node, ir_node *left);
399 inline ir_node *get_Rot_right (ir_node *node);
400 inline void set_Rot_right (ir_node *node, ir_node *right);
402 inline ir_node *get_Conv_op (ir_node *node);
403 inline void set_Conv_op (ir_node *node, ir_node *op);
405 inline ir_node **get_Phi_preds_arr (ir_node *node);
406 inline int get_Phi_n_preds (ir_node *node);
407 /* inline void set_Phi_n_preds (ir_node *node, int n_preds); */
408 inline ir_node *get_Phi_pred (ir_node *node, int pos);
409 inline void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
411 inline ir_node *get_Load_mem (ir_node *node);
412 inline void set_Load_mem (ir_node *node, ir_node *mem);
413 inline ir_node *get_Load_ptr (ir_node *node);
414 inline void set_Load_ptr (ir_node *node, ir_node *ptr);
416 inline ir_node *get_Store_mem (ir_node *node);
417 inline void set_Store_mem (ir_node *node, ir_node *mem);
418 inline ir_node *get_Store_ptr (ir_node *node);
419 inline void set_Store_ptr (ir_node *node, ir_node *ptr);
420 inline ir_node *get_Store_value (ir_node *node);
421 inline void set_Store_value (ir_node *node, ir_node *value);
423 inline ir_node *get_Alloc_mem (ir_node *node);
424 inline void set_Alloc_mem (ir_node *node, ir_node *mem);
425 inline ir_node *get_Alloc_size (ir_node *node);
426 inline void set_Alloc_size (ir_node *node, ir_node *size);
427 inline type *get_Alloc_type (ir_node *node);
428 inline void set_Alloc_type (ir_node *node, type *type);
430 stack_alloc, /* Alloc allocates the object on the stack. */
431 heap_alloc /* Alloc allocates the object on the heap. */
433 inline where_alloc get_Alloc_where (ir_node *node);
434 inline void set_Alloc_where (ir_node *node, where_alloc where);
436 inline ir_node *get_Free_mem (ir_node *node);
437 inline void set_Free_mem (ir_node *node, ir_node *mem);
438 inline ir_node *get_Free_ptr (ir_node *node);
439 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
440 inline ir_node *get_Free_size (ir_node *node);
441 inline void set_Free_size (ir_node *node, ir_node *size);
442 inline type *get_Free_type (ir_node *node);
443 inline void set_Free_type (ir_node *node, type *type);
445 inline ir_node **get_Sync_preds_arr (ir_node *node);
446 inline int get_Sync_n_preds (ir_node *node);
447 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
448 inline ir_node *get_Sync_pred (ir_node *node, int pos);
449 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
451 inline ir_node *get_Proj_pred (ir_node *node);
452 inline void set_Proj_pred (ir_node *node, ir_node *pred);
453 inline long get_Proj_proj (ir_node *node);
454 inline void set_Proj_proj (ir_node *node, long proj);
456 inline ir_node **get_Tuple_preds_arr (ir_node *node);
457 inline int get_Tuple_n_preds (ir_node *node);
458 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
459 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
460 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
462 inline ir_node *get_Id_pred (ir_node *node);
463 inline void set_Id_pred (ir_node *node, ir_node *pred);
467 /****s* irnode/other2
469 * NAME Auxiliary routines
471 * NOTE Not properly documented ;-)
476 /* returns operand of node if node is a Proj. */
477 inline ir_node *skip_Proj (ir_node *node);
478 /* returns operand of node if node is a Id */
479 inline ir_node *skip_nop (ir_node *node);
480 inline ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
481 /* returns corresponding operand of Tuple if node is a Proj from
483 inline ir_node *skip_Tuple (ir_node *node);
484 /* returns true if node is a Bad node. */
485 inline int is_Bad (ir_node *node);
486 /* returns true if the node is not a Block */
487 inline int is_no_Block (ir_node *node);
488 /* Returns true if the operation manipulates control flow:
489 Start, End, Jmp, Cond, Return, Raise, Bad */
490 int is_cfop(ir_node *node);
491 /* Returns true if the operation can change the control flow because
492 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
494 int is_fragile_op(ir_node *node);
495 /* Returns the memory operand of fragile operations. */
496 ir_node *get_fragile_op_mem(ir_node *node);
500 /* Makros for debugging the libfirm */
501 /*#ifdef DEBUG_libfirm*/
504 #define DDMSG printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
505 #define DDMSG1(X) printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, \
506 id_to_str(get_irn_opident(X)))
507 #define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__, \
508 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
510 #define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, \
511 print_firm_kind(X), (X))
512 #define DDMSG4(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, \
513 get_type_tpop_nameid(X), get_type_ident(X), (X))
514 #define DDMSG5(X) printf("%s%s: %ld", \
515 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
519 #define DDMN(X) xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FUNCTION__, __LINE__, \
520 get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), (X))
521 #define DDMNB(X) xprintf("%I%I: %ld (in block %ld)\n", \
522 get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), \
523 get_irn_node_nr(get_nodes_Block(X)))
524 #define DDMT(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, \
525 get_type_tpop_nameid(X), get_type_ident(X), (X))
526 #define DDME(X) xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__, \
527 get_entity_ident(X), (X))
531 # endif /* _IRNODE_H_ */