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);
100 /* Outputs a unique number for this node if libfirm is compiled for
101 debugging, else returns 0. */
102 inline long get_irn_node_nr(ir_node *node);
105 /* irnode constructor */
106 /* Create a new irnode in irg, with an op, mode, arity and */
107 /* some incoming irnodes. */
108 /* If arity is negative, a node with a dynamic array is created. */
111 new_ir_node (ir_graph *irg,
120 * NAME access functions for node fields.
122 * NOTE Not properly documented ;-)
127 /* this works for all except Block */
128 inline ir_node *get_nodes_Block (ir_node *node);
129 inline void set_nodes_Block (ir_node *node, ir_node *block);
131 /* Projection numbers for result of Start node: use for Proj nodes! */
133 pns_initial_exec, /* Projection on an executable, the initial control
135 pns_global_store, /* Projection on the global store */
136 pns_frame_base, /* Projection on the frame base */
137 pns_globals, /* Projection on the pointer to the data segment
138 containing _all_ global entities. */
139 pns_args /* Projection on all arguments */
142 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
143 int get_Block_n_cfgpreds (ir_node *node);
144 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
145 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
146 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
147 inline bool get_Block_matured (ir_node *node);
148 inline void set_Block_matured (ir_node *node, bool matured);
149 inline unsigned long get_Block_block_visited (ir_node *node);
150 inline void set_Block_block_visited (ir_node *node, unsigned long visit);
151 /* For this current_ir_graph must be set. */
152 inline void mark_Block_block_visited(ir_node *node);
153 inline int Block_not_block_visited(ir_node *node);
154 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
155 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
158 inline int get_End_n_keepalives(ir_node *end);
159 inline ir_node *get_End_keepalive(ir_node *end, int pos);
160 inline void add_End_keepalive (ir_node *end, ir_node *ka);
161 /* Some parts of the End node are allocated seperately -- their memory
162 is not recovered by dead_node_elimination if a End node is dead.
163 free_End frees these data structures. */
164 inline void free_End (ir_node *end);
166 /* We distinguish three kinds of Cond nodes. These can be distinguished
167 by the mode of the selector operand and an internal flag of type cond_kind.
168 First we distinguish binary Conds and switch Conds.
169 A binary Cond has as selector a boolean value. Proj(0) projects the control
170 flow for case "False", Proj(1) the control flow for "True". A binary Cond
171 is recognized by the boolean selector.
172 The switch Cond has as selector an unsigned integer. It produces as result
173 an n+1 Tuple (cf0, ... , cfn) of control flows.
174 We differ two flavours of this Cond. The first, the dense Cond, passes
175 control along output i if the selector value is i, 0 <= i <= n. If the
176 selector value is >n it passes control along output n.
177 The second Cond flavor differes in the treatment of cases not specified in
178 the source program. It magically knows about the existence of Proj nodes.
179 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
180 exists. Else it passes control along output n (even if this Proj does not
181 exist.) This Cond we call "fragmentary". There is a special constructor
182 new_defaultProj that automatically sets the flavor.
183 The two switch flavors are distinguished by a flag of type cond_kind.
184 Default flavor is "dense"
187 dense, /* Default. Missing Proj nodes are dead control flow. */
188 fragmentary /* Special. No control flow optimizations allowed. Missing
189 Proj nodes mean default control flow, i.e., Proj(n). */
192 inline ir_node *get_Cond_selector (ir_node *node);
193 inline void set_Cond_selector (ir_node *node, ir_node *selector);
194 inline cond_kind get_Cond_kind (ir_node *node);
195 inline void set_Cond_kind (ir_node *node, cond_kind kind);
197 inline ir_node *get_Return_mem (ir_node *node);
198 inline void set_Return_mem (ir_node *node, ir_node *mem);
199 inline ir_node **get_Return_res_arr (ir_node *node);
200 inline int get_Return_n_res (ir_node *node);
201 /*inline void set_Return_n_res (ir_node *node, int results); */
202 inline ir_node *get_Return_res (ir_node *node, int pos);
203 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
205 inline ir_node *get_Raise_mem (ir_node *node);
206 inline void set_Raise_mem (ir_node *node, ir_node *mem);
207 inline ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
208 inline void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
210 inline tarval *get_Const_tarval (ir_node *node);
211 inline void set_Const_tarval (ir_node *node, tarval *con);
213 /* This enum names the three different kinds of symbolic Constants
214 represented by SymConst. The content of the attribute type_or_id
215 depends on this tag. Use the proper access routine after testing
218 type_tag, /* The SymConst is a type tag for the given type.
219 Type_or_id_p is type *. */
220 size, /* The SymConst is the size of the given type.
221 Type_or_id_p is type *. */
222 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
223 by the linker. Type_or_id_p is ident *. */
225 typedef union type_or_id * type_or_id_p;
226 inline symconst_kind get_SymConst_kind (ir_node *node);
227 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
228 /* Only to access SymConst of kind type_tag or size. Else assertion: */
229 inline type *get_SymConst_type (ir_node *node);
230 inline void set_SymConst_type (ir_node *node, type *type);
231 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
232 inline ident *get_SymConst_ptrinfo (ir_node *node);
233 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
234 /* Sets both: type and ptrinfo. Needed to treat the node independent of
235 its semantics. Does a memcpy for the memory tori points to. */
236 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
237 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
239 inline ir_node *get_Sel_mem (ir_node *node);
240 inline void set_Sel_mem (ir_node *node, ir_node *mem);
241 inline ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
242 inline void set_Sel_ptr (ir_node *node, ir_node *ptr);
243 inline ir_node **get_Sel_index_arr (ir_node *node);
244 inline int get_Sel_n_index (ir_node *node);
245 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
246 inline ir_node *get_Sel_index (ir_node *node, int pos);
247 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
248 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
249 inline void set_Sel_entity (ir_node *node, entity *ent);
251 static_linkage, /* entity is used internal and not visible out of this
253 external_linkage, /* */
256 inline linkage_type get_Sel_linkage_type (ir_node *node);
257 inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
259 inline ir_node *get_Call_mem (ir_node *node);
260 inline void set_Call_mem (ir_node *node, ir_node *mem);
261 inline ir_node *get_Call_ptr (ir_node *node);
262 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
263 inline ir_node **get_Call_param_arr (ir_node *node);
264 inline int get_Call_n_params (ir_node *node);
265 inline int get_Call_arity (ir_node *node);
266 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
267 inline ir_node *get_Call_param (ir_node *node, int pos);
268 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
269 inline type *get_Call_type (ir_node *node);
270 inline void set_Call_type (ir_node *node, type *type);
272 /* For unary and binary arithmetic operations the access to the
273 operands can be factored out. Left is the first, right the
274 second arithmetic value as listed in tech report 1999-44.
275 unops are: Minus, Abs, Not, Conv
276 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
277 Shr, Shrs, Rot, Cmp */
278 inline int is_unop (ir_node *node);
279 inline ir_node *get_unop_op (ir_node *node);
280 inline void set_unop_op (ir_node *node, ir_node *op);
281 inline int is_binop (ir_node *node);
282 inline ir_node *get_binop_left (ir_node *node);
283 inline void set_binop_left (ir_node *node, ir_node *left);
284 inline ir_node *get_binop_right (ir_node *node);
285 inline void set_binop_right (ir_node *node, ir_node *right);
287 inline ir_node *get_Add_left (ir_node *node);
288 inline void set_Add_left (ir_node *node, ir_node *left);
289 inline ir_node *get_Add_right (ir_node *node);
290 inline void set_Add_right (ir_node *node, ir_node *right);
292 inline ir_node *get_Sub_left (ir_node *node);
293 inline void set_Sub_left (ir_node *node, ir_node *left);
294 inline ir_node *get_Sub_right (ir_node *node);
295 inline void set_Sub_right (ir_node *node, ir_node *right);
297 inline ir_node *get_Minus_op (ir_node *node);
298 inline void set_Minus_op (ir_node *node, ir_node *op);
300 inline ir_node *get_Mul_left (ir_node *node);
301 inline void set_Mul_left (ir_node *node, ir_node *left);
302 inline ir_node *get_Mul_right (ir_node *node);
303 inline void set_Mul_right (ir_node *node, ir_node *right);
305 inline ir_node *get_Quot_left (ir_node *node);
306 inline void set_Quot_left (ir_node *node, ir_node *left);
307 inline ir_node *get_Quot_right (ir_node *node);
308 inline void set_Quot_right (ir_node *node, ir_node *right);
309 inline ir_node *get_Quot_mem (ir_node *node);
310 inline void set_Quot_mem (ir_node *node, ir_node *mem);
312 inline ir_node *get_DivMod_left (ir_node *node);
313 inline void set_DivMod_left (ir_node *node, ir_node *left);
314 inline ir_node *get_DivMod_right (ir_node *node);
315 inline void set_DivMod_right (ir_node *node, ir_node *right);
316 inline ir_node *get_DivMod_mem (ir_node *node);
317 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
319 inline ir_node *get_Div_left (ir_node *node);
320 inline void set_Div_left (ir_node *node, ir_node *left);
321 inline ir_node *get_Div_right (ir_node *node);
322 inline void set_Div_right (ir_node *node, ir_node *right);
323 inline ir_node *get_Div_mem (ir_node *node);
324 inline void set_Div_mem (ir_node *node, ir_node *mem);
326 inline ir_node *get_Mod_left (ir_node *node);
327 inline void set_Mod_left (ir_node *node, ir_node *left);
328 inline ir_node *get_Mod_right (ir_node *node);
329 inline void set_Mod_right (ir_node *node, ir_node *right);
330 inline ir_node *get_Mod_mem (ir_node *node);
331 inline void set_Mod_mem (ir_node *node, ir_node *mem);
333 inline ir_node *get_Abs_op (ir_node *node);
334 inline void set_Abs_op (ir_node *node, ir_node *op);
336 inline ir_node *get_And_left (ir_node *node);
337 inline void set_And_left (ir_node *node, ir_node *left);
338 inline ir_node *get_And_right (ir_node *node);
339 inline void set_And_right (ir_node *node, ir_node *right);
341 inline ir_node *get_Or_left (ir_node *node);
342 inline void set_Or_left (ir_node *node, ir_node *left);
343 inline ir_node *get_Or_right (ir_node *node);
344 inline void set_Or_right (ir_node *node, ir_node *right);
346 inline ir_node *get_Eor_left (ir_node *node);
347 inline void set_Eor_left (ir_node *node, ir_node *left);
348 inline ir_node *get_Eor_right (ir_node *node);
349 inline void set_Eor_right (ir_node *node, ir_node *right);
351 inline ir_node *get_Not_op (ir_node *node);
352 inline void set_Not_op (ir_node *node, ir_node *op);
354 /* Projection numbers of compare: use for Proj nodes! */
359 Le, /* less or equal */
361 Ge, /* greater or equal */
362 Lg, /* less or greater */
363 Leg, /* less, equal or greater = ordered */
365 Ue, /* unordered or equal */
366 Ul, /* unordered or less */
367 Ule, /* unordered, less or equal */
368 Ug, /* unordered or greater */
369 Uge, /* unordered, greater or equal */
370 Ne, /* unordered, less or greater = not equal */
372 not_mask = Leg /* bits to flip to negate comparison */
374 inline char *get_pnc_string(int pnc);
375 inline int get_negated_pnc(int pnc);
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);
429 stack_alloc, /* Alloc allocates the object on the stack. */
430 heap_alloc /* Alloc allocates the object on the heap. */
432 inline where_alloc get_Alloc_where (ir_node *node);
433 inline void set_Alloc_where (ir_node *node, where_alloc where);
435 inline ir_node *get_Free_mem (ir_node *node);
436 inline void set_Free_mem (ir_node *node, ir_node *mem);
437 inline ir_node *get_Free_ptr (ir_node *node);
438 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
439 inline ir_node *get_Free_size (ir_node *node);
440 inline void set_Free_size (ir_node *node, ir_node *size);
441 inline type *get_Free_type (ir_node *node);
442 inline void set_Free_type (ir_node *node, type *type);
444 inline ir_node **get_Sync_preds_arr (ir_node *node);
445 inline int get_Sync_n_preds (ir_node *node);
446 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
447 inline ir_node *get_Sync_pred (ir_node *node, int pos);
448 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
450 inline ir_node *get_Proj_pred (ir_node *node);
451 inline void set_Proj_pred (ir_node *node, ir_node *pred);
452 inline long get_Proj_proj (ir_node *node);
453 inline void set_Proj_proj (ir_node *node, long proj);
455 inline ir_node **get_Tuple_preds_arr (ir_node *node);
456 inline int get_Tuple_n_preds (ir_node *node);
457 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
458 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
459 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
461 inline ir_node *get_Id_pred (ir_node *node);
462 inline void set_Id_pred (ir_node *node, ir_node *pred);
466 /****s* irnode/other2
468 * NAME Auxiliary routines
470 * NOTE Not properly documented ;-)
475 /* returns operand of node if node is a Proj. */
476 inline ir_node *skip_Proj (ir_node *node);
477 /* returns operand of node if node is a Id */
478 inline ir_node *skip_nop (ir_node *node);
479 inline ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
480 /* returns corresponding operand of Tuple if node is a Proj from
482 inline ir_node *skip_Tuple (ir_node *node);
483 /* returns true if node is a Bad node. */
484 inline int is_Bad (ir_node *node);
485 /* returns true if the node is not a Block */
486 inline int is_no_Block (ir_node *node);
487 /* Returns true if the operation manipulates control flow:
488 Start, End, Jmp, Cond, Return, Raise, Bad */
489 int is_cfop(ir_node *node);
490 /* Returns true if the operation can change the control flow because
491 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
493 int is_fragile_op(ir_node *node);
494 /* Returns the memory operand of fragile operations. */
495 ir_node *get_fragile_op_mem(ir_node *node);
499 /* Makros for debugging the libfirm */
502 #define DDMSG printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
503 #define DDMSG1(X) printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, \
504 id_to_str(get_irn_opident(X)))
505 #define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__, \
506 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
508 #define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, \
509 print_firm_kind(X), (X))
510 #define DDMSG4(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, \
511 get_type_tpop_nameid(X), get_type_ident(X), (X))
512 #define DDMSG5(X) printf("%s%s: %ld", \
513 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
517 #define DDMN(X) xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FUNCTION__, __LINE__, \
518 get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), (X))
519 #define DDMNB(X) xprintf("%I%I: %ld (in block %ld)\n", \
520 get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), \
521 get_irn_node_nr(get_nodes_Block(X)))
522 #define DDMT(X) xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, \
523 get_type_tpop_nameid(X), get_type_ident(X), (X))
524 #define DDME(X) xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__, \
525 get_entity_ident(X), (X))
528 # endif /* _IRNODE_H_ */