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