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 the 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 inline ir_node *get_irn_n (ir_node *node, int n);
75 inline void set_irn_n (ir_node *node, int n, ir_node *in);
76 /* Get the mode struct. */
77 inline ir_mode *get_irn_mode (ir_node *node);
78 /* Get the mode-enum modecode */
79 inline modecode get_irn_modecode (ir_node *node);
80 /* Get the ident for a string representation of the mode */
81 inline ident *get_irn_modeident (ir_node *node);
82 /* Access the opcode struct of the node */
83 inline ir_op *get_irn_op (ir_node *node);
84 inline void set_irn_op (ir_node *node, ir_op *op);
85 /* Get the opcode-enum of the node */
86 inline opcode get_irn_opcode (ir_node *node);
87 /* Get the ident for a string representation of the opcode */
88 inline ident *get_irn_opident (ir_node *node);
89 /* Get the string representation of the opcode */
90 inline const char *get_irn_opname (ir_node *node);
91 inline void set_irn_visited (ir_node *node, unsigned long visited);
92 inline unsigned long get_irn_visited (ir_node *node);
93 inline void set_irn_link (ir_node *node, ir_node *link);
94 inline ir_node *get_irn_link (ir_node *node);
96 /* Outputs a unique number for this node */
97 inline long get_irn_node_nr(ir_node *node);
101 /* irnode constructor */
102 /* Create a new irnode in irg, with an op, mode, arity and */
103 /* some incoming irnodes. */
104 /* If arity is negative, a node with a dynamic array is created. */
107 new_ir_node (ir_graph *irg,
116 * NAME access functions for node fields.
118 * NOTE Not properly documented ;-)
123 /* this works for all except Block */
124 inline ir_node *get_nodes_Block (ir_node *node);
125 inline void set_nodes_Block (ir_node *node, ir_node *block);
127 /* Projection numbers for result of Start node: use for Proj nodes! */
129 pns_initial_exec, /* Projection on an executable, the initial control
131 pns_global_store, /* Projection on the global store */
132 pns_frame_base, /* Projection on the frame base */
133 pns_globals, /* Projection on the pointer to the data segment
134 containing _all_ global entities. */
135 pns_args /* Projection on all arguments */
138 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
139 int get_Block_n_cfgpreds (ir_node *node);
140 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
141 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
142 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
143 inline bool get_Block_matured (ir_node *node);
144 inline void set_Block_matured (ir_node *node, bool matured);
145 inline unsigned long get_Block_block_visited (ir_node *node);
146 inline void set_Block_block_visited (ir_node *node, unsigned long visit);
147 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
148 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
151 inline void add_End_keepalive (ir_node *end, ir_node *ka);
153 /* We distinguish three kinds of Cond nodes. These can be distinguished
154 by the mode of the selector operand and an internal flag of type cond_kind.
155 First we distinguish binary Conds and switch Conds.
156 A binary Cond has as selector a boolean value. Proj(0) projects the control
157 flow for case "False", Proj(1) the control flow for "True". A binary Cond
158 is recognized by the boolean selector.
159 The switch Cond has as selector an unsigned integer. It produces as result
160 an n+1 Tuple (cf0, ... , cfn) of control flows.
161 We differ two flavours of this Cond. The first, the dense Cond, passes
162 control along output i if the selector value is i, 0 <= i <= n. If the
163 selector value is >n it passes control along output n.
164 The second Cond flavor differes in the treatment of cases not specified in
165 the source program. It magically knows about the existence of Proj nodes.
166 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
167 exists. Else it passes control along output n (even if this Proj does not
168 exist.) This Cond we call "fragmentary". There is a special constructor
169 new_defaultProj that automatically sets the flavor.
170 The two switch flavors are distinguished by a flag of type cond_kind.
171 Default flavor is "dense"
174 dense, /* Default. Missing Proj nodes are dead control flow. */
175 fragmentary /* Special. No control flow optimizations allowed. Missing
176 Proj nodes mean default control flow, i.e., Proj(n). */
179 inline ir_node *get_Cond_selector (ir_node *node);
180 inline void set_Cond_selector (ir_node *node, ir_node *selector);
181 inline cond_kind get_Cond_kind (ir_node *node);
182 inline void set_Cond_kind (ir_node *node, cond_kind kind);
184 inline ir_node *get_Return_mem (ir_node *node);
185 inline void set_Return_mem (ir_node *node, ir_node *mem);
186 inline ir_node **get_Return_res_arr (ir_node *node);
187 inline int get_Return_n_res (ir_node *node);
188 /*inline void set_Return_n_res (ir_node *node, int results); */
189 inline ir_node *get_Return_res (ir_node *node, int pos);
190 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
192 inline ir_node *get_Raise_mem (ir_node *node);
193 inline void set_Raise_mem (ir_node *node, ir_node *mem);
194 inline ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
195 inline void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
197 inline tarval *get_Const_tarval (ir_node *node);
198 inline void set_Const_tarval (ir_node *node, tarval *con);
200 /* This enum names the three different kinds of symbolic Constants
201 represented by SymConst. The content of the attribute type_or_id
202 depends on this tag. Use the proper access routine after testing
205 type_tag, /* The SymConst is a type tag for the given type.
206 Type_or_id_p is type *. */
207 size, /* The SymConst is the size of the given type.
208 Type_or_id_p is type *. */
209 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
210 by the linker. Type_or_id_p is ident *. */
212 typedef union type_or_id * type_or_id_p;
213 inline symconst_kind get_SymConst_kind (ir_node *node);
214 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
215 /* Only to access SymConst of kind type_tag or size. Else assertion: */
216 inline type *get_SymConst_type (ir_node *node);
217 inline void set_SymConst_type (ir_node *node, type *type);
218 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
219 inline ident *get_SymConst_ptrinfo (ir_node *node);
220 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
221 /* Sets both: type and ptrinfo. Needed to treat the node independent of
222 its semantics. Does a memcpy for the memory tori points to. */
223 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
224 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
226 inline ir_node *get_Sel_mem (ir_node *node);
227 inline void set_Sel_mem (ir_node *node, ir_node *mem);
228 inline ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
229 inline void set_Sel_ptr (ir_node *node, ir_node *ptr);
230 inline ir_node **get_Sel_index_arr (ir_node *node);
231 inline int get_Sel_n_index (ir_node *node);
232 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
233 inline ir_node *get_Sel_index (ir_node *node, int pos);
234 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
235 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
236 inline void set_Sel_entity (ir_node *node, entity *ent);
238 static_linkage, /* entity is used internal and not visible out of this
240 external_linkage, /* */
243 inline linkage_type get_Sel_linkage_type (ir_node *node);
244 inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
246 inline ir_node *get_Call_mem (ir_node *node);
247 inline void set_Call_mem (ir_node *node, ir_node *mem);
248 inline ir_node *get_Call_ptr (ir_node *node);
249 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
250 inline ir_node **get_Call_param_arr (ir_node *node);
251 inline int get_Call_n_params (ir_node *node);
252 inline int get_Call_arity (ir_node *node);
253 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
254 inline ir_node *get_Call_param (ir_node *node, int pos);
255 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
256 inline type *get_Call_type (ir_node *node);
257 inline void set_Call_type (ir_node *node, type *type);
259 /* For unary and binary arithmetic operations the access to the
260 operands can be factored out. Left is the first, right the
261 second arithmetic value as listed in tech report 1999-44.
262 unops are: Minus, Abs, Not, Conv
263 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
264 Shr, Shrs, Rot, Cmp */
265 inline int is_unop (ir_node *node);
266 inline ir_node *get_unop_op (ir_node *node);
267 inline void set_unop_op (ir_node *node, ir_node *op);
268 inline int is_binop (ir_node *node);
269 inline ir_node *get_binop_left (ir_node *node);
270 inline void set_binop_left (ir_node *node, ir_node *left);
271 inline ir_node *get_binop_right (ir_node *node);
272 inline void set_binop_right (ir_node *node, ir_node *right);
274 inline ir_node *get_Add_left (ir_node *node);
275 inline void set_Add_left (ir_node *node, ir_node *left);
276 inline ir_node *get_Add_right (ir_node *node);
277 inline void set_Add_right (ir_node *node, ir_node *right);
279 inline ir_node *get_Sub_left (ir_node *node);
280 inline void set_Sub_left (ir_node *node, ir_node *left);
281 inline ir_node *get_Sub_right (ir_node *node);
282 inline void set_Sub_right (ir_node *node, ir_node *right);
284 inline ir_node *get_Minus_op (ir_node *node);
285 inline void set_Minus_op (ir_node *node, ir_node *op);
287 inline ir_node *get_Mul_left (ir_node *node);
288 inline void set_Mul_left (ir_node *node, ir_node *left);
289 inline ir_node *get_Mul_right (ir_node *node);
290 inline void set_Mul_right (ir_node *node, ir_node *right);
292 inline ir_node *get_Quot_left (ir_node *node);
293 inline void set_Quot_left (ir_node *node, ir_node *left);
294 inline ir_node *get_Quot_right (ir_node *node);
295 inline void set_Quot_right (ir_node *node, ir_node *right);
296 inline ir_node *get_Quot_mem (ir_node *node);
297 inline void set_Quot_mem (ir_node *node, ir_node *mem);
299 inline ir_node *get_DivMod_left (ir_node *node);
300 inline void set_DivMod_left (ir_node *node, ir_node *left);
301 inline ir_node *get_DivMod_right (ir_node *node);
302 inline void set_DivMod_right (ir_node *node, ir_node *right);
303 inline ir_node *get_DivMod_mem (ir_node *node);
304 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
306 inline ir_node *get_Div_left (ir_node *node);
307 inline void set_Div_left (ir_node *node, ir_node *left);
308 inline ir_node *get_Div_right (ir_node *node);
309 inline void set_Div_right (ir_node *node, ir_node *right);
310 inline ir_node *get_Div_mem (ir_node *node);
311 inline void set_Div_mem (ir_node *node, ir_node *mem);
313 inline ir_node *get_Mod_left (ir_node *node);
314 inline void set_Mod_left (ir_node *node, ir_node *left);
315 inline ir_node *get_Mod_right (ir_node *node);
316 inline void set_Mod_right (ir_node *node, ir_node *right);
317 inline ir_node *get_Mod_mem (ir_node *node);
318 inline void set_Mod_mem (ir_node *node, ir_node *mem);
320 inline ir_node *get_Abs_op (ir_node *node);
321 inline void set_Abs_op (ir_node *node, ir_node *op);
323 inline ir_node *get_And_left (ir_node *node);
324 inline void set_And_left (ir_node *node, ir_node *left);
325 inline ir_node *get_And_right (ir_node *node);
326 inline void set_And_right (ir_node *node, ir_node *right);
328 inline ir_node *get_Or_left (ir_node *node);
329 inline void set_Or_left (ir_node *node, ir_node *left);
330 inline ir_node *get_Or_right (ir_node *node);
331 inline void set_Or_right (ir_node *node, ir_node *right);
333 inline ir_node *get_Eor_left (ir_node *node);
334 inline void set_Eor_left (ir_node *node, ir_node *left);
335 inline ir_node *get_Eor_right (ir_node *node);
336 inline void set_Eor_right (ir_node *node, ir_node *right);
338 inline ir_node *get_Not_op (ir_node *node);
339 inline void set_Not_op (ir_node *node, ir_node *op);
341 /* Projection numbers of compare: use for Proj nodes! */
346 Le, /* less or equal */
348 Ge, /* greater or equal */
349 Lg, /* less or greater */
350 Leg, /* less, equal or greater = ordered */
352 Ue, /* unordered or equal */
353 Ul, /* unordered or less */
354 Ule, /* unordered, less or equal */
355 Ug, /* unordered or greater */
356 Uge, /* unordered, greater or equal */
357 Ne, /* unordered, less or greater = not equal */
359 not_mask = Leg /* bits to flip to negate comparison */
361 inline char *get_pnc_string(int pnc);
362 inline int get_negated_pnc(int pnc);
363 inline ir_node *get_Cmp_left (ir_node *node);
364 inline void set_Cmp_left (ir_node *node, ir_node *left);
365 inline ir_node *get_Cmp_right (ir_node *node);
366 inline void set_Cmp_right (ir_node *node, ir_node *right);
368 inline ir_node *get_Shl_left (ir_node *node);
369 inline void set_Shl_left (ir_node *node, ir_node *left);
370 inline ir_node *get_Shl_right (ir_node *node);
371 inline void set_Shl_right (ir_node *node, ir_node *right);
373 inline ir_node *get_Shr_left (ir_node *node);
374 inline void set_Shr_left (ir_node *node, ir_node *left);
375 inline ir_node *get_Shr_right (ir_node *node);
376 inline void set_Shr_right (ir_node *node, ir_node *right);
378 inline ir_node *get_Shrs_left (ir_node *node);
379 inline void set_Shrs_left (ir_node *node, ir_node *left);
380 inline ir_node *get_Shrs_right (ir_node *node);
381 inline void set_Shrs_right (ir_node *node, ir_node *right);
383 inline ir_node *get_Rot_left (ir_node *node);
384 inline void set_Rot_left (ir_node *node, ir_node *left);
385 inline ir_node *get_Rot_right (ir_node *node);
386 inline void set_Rot_right (ir_node *node, ir_node *right);
388 inline ir_node *get_Conv_op (ir_node *node);
389 inline void set_Conv_op (ir_node *node, ir_node *op);
391 inline ir_node **get_Phi_preds_arr (ir_node *node);
392 inline int get_Phi_n_preds (ir_node *node);
393 /* inline void set_Phi_n_preds (ir_node *node, int n_preds); */
394 inline ir_node *get_Phi_pred (ir_node *node, int pos);
395 inline void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
397 inline ir_node *get_Load_mem (ir_node *node);
398 inline void set_Load_mem (ir_node *node, ir_node *mem);
399 inline ir_node *get_Load_ptr (ir_node *node);
400 inline void set_Load_ptr (ir_node *node, ir_node *ptr);
402 inline ir_node *get_Store_mem (ir_node *node);
403 inline void set_Store_mem (ir_node *node, ir_node *mem);
404 inline ir_node *get_Store_ptr (ir_node *node);
405 inline void set_Store_ptr (ir_node *node, ir_node *ptr);
406 inline ir_node *get_Store_value (ir_node *node);
407 inline void set_Store_value (ir_node *node, ir_node *value);
409 inline ir_node *get_Alloc_mem (ir_node *node);
410 inline void set_Alloc_mem (ir_node *node, ir_node *mem);
411 inline ir_node *get_Alloc_size (ir_node *node);
412 inline void set_Alloc_size (ir_node *node, ir_node *size);
413 inline type *get_Alloc_type (ir_node *node);
414 inline void set_Alloc_type (ir_node *node, type *type);
416 stack_alloc, /* Alloc allocates the object on the stack. */
417 heap_alloc /* Alloc allocates the object on the heap. */
419 inline where_alloc get_Alloc_where (ir_node *node);
420 inline void set_Alloc_where (ir_node *node, where_alloc where);
422 inline ir_node *get_Free_mem (ir_node *node);
423 inline void set_Free_mem (ir_node *node, ir_node *mem);
424 inline ir_node *get_Free_ptr (ir_node *node);
425 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
426 inline ir_node *get_Free_size (ir_node *node);
427 inline void set_Free_size (ir_node *node, ir_node *size);
428 inline type *get_Free_type (ir_node *node);
429 inline void set_Free_type (ir_node *node, type *type);
431 inline ir_node **get_Sync_preds_arr (ir_node *node);
432 inline int get_Sync_n_preds (ir_node *node);
433 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
434 inline ir_node *get_Sync_pred (ir_node *node, int pos);
435 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
437 inline ir_node *get_Proj_pred (ir_node *node);
438 inline void set_Proj_pred (ir_node *node, ir_node *pred);
439 inline long get_Proj_proj (ir_node *node);
440 inline void set_Proj_proj (ir_node *node, long proj);
442 inline ir_node **get_Tuple_preds_arr (ir_node *node);
443 inline int get_Tuple_n_preds (ir_node *node);
444 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
445 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
446 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
448 inline ir_node *get_Id_pred (ir_node *node);
449 inline void set_Id_pred (ir_node *node, ir_node *pred);
453 /****s* irnode/other2
455 * NAME Auxiliary routines
457 * NOTE Not properly documented ;-)
462 /* returns operand of node if node is a Proj. */
463 inline ir_node *skip_Proj (ir_node *node);
464 /* returns operand of node if node is a Id */
465 inline ir_node *skip_nop (ir_node *node);
466 /* returns corresponding operand of Tuple if node is a Proj from
468 inline ir_node *skip_Tuple (ir_node *node);
469 /* returns true if node is a Bad node. */
470 inline int is_Bad (ir_node *node);
471 /* returns true if the node is not a Block */
472 inline int is_no_Block (ir_node *node);
473 /* Returns true if the operation manipulates control flow:
474 Start, End, Jmp, Cond, Return, Raise */
475 int is_cfop(ir_node *node);
476 /* Returns true if the operation can change the control flow because
478 int is_fragile_op(ir_node *node);
479 /* Returns the memory operand of fragile operations. */
480 ir_node *get_fragile_op_mem(ir_node *node);
484 /* Makros for debugging the libfirm */
488 #define DDMSG printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
489 #define DDMSG1(X) printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, \
490 id_to_str(get_irn_opident(X)))
491 #define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__, \
492 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
494 #define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, \
495 print_firm_kind(X), (X))
496 #define DDMSG4(X) printf("%s(l.%i) %s %s: %p\n", __FUNCTION__, __LINE__, \
497 get_type_tpop_name(X), get_type_name(X), (X))
501 # endif /* _IRNODE_H_ */