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