1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 ** All rights reserved.
4 ** Authors: Martin Trapp, Christian Schaefer
6 ** declarations of an ir node
20 /* The typedefiniton of ir_node is also in irgraph.h to resolve
21 recursion between irnode.h and irgraph.h */
22 #ifndef _IR_NODE_TYPEDEF_
23 #define _IR_NODE_TYPEDEF_
26 * NAME ir_node - a datatype representing a Firm node
28 * NOTE Not properly documented ;-)
31 * The common fields are:
33 * firm_kind A firm_kind tag containing k_type. This is useful
34 * for dynamically checking whether a node is a ir_node.
35 * arity The number of predecessors in the Firm graph.
36 * in A list with the predecessors in the Firm graph. There are
37 * routines to access individual elements and to obtain the
38 * array. The method returning the array should not be used.
39 * mode The mode of the node. There are routines to get the mode but
40 * also to access the mode's fields directly.
41 * opcode The opcode of the node. There are routines to get the opcode but
42 * also to access the opcode's fields directly.
43 * node_nr A unique number for the node. Available only if debugging is
47 typedef struct ir_node ir_node;
50 /** Manipulate the fields of ir_node. With these access routines
51 you can work on the graph without considering the different types
52 of nodes, it's just a big graph. **/
54 /* returns the number of predecessors without the block predecessor: */
55 int get_irn_arity (ir_node *node);
56 /* returns the array with the ins: */
57 inline ir_node **get_irn_in (ir_node *node);
58 /* Replaces the old in array by a new one that will contain the ins given in
59 the parameters. It copies the array passed.
60 This function is necessary to ajust in arrays of blocks, calls and phis.
61 Assumes the current_ir_graph is set to the graph containing "node".
62 "in" must contain all predecessors except the block that are required for
64 inline void set_irn_in (ir_node *node, int arity,
66 /* to iterate through the predecessors without touching the array. No
67 order of predecessors guaranteed.
68 To iterate over the operands iterate from 0 to i < get_irn_arity(),
69 to iterate including the Block predecessor iterate from i = -1 to
71 /* Access predecessor n */
72 inline ir_node *get_irn_n (ir_node *node, int n);
73 inline void set_irn_n (ir_node *node, int n, ir_node *in);
74 /* Get the mode struct. */
75 inline ir_mode *get_irn_mode (ir_node *node);
76 /* Get the mode-enum modecode */
77 inline modecode get_irn_modecode (ir_node *node);
78 /* Get the ident for a string representation of the mode */
79 inline ident *get_irn_modeident (ir_node *node);
80 /* Access the opcode struct of the node */
81 inline ir_op *get_irn_op (ir_node *node);
82 inline void set_irn_op (ir_node *node, ir_op *op);
83 /* Get the opcode-enum of the node */
84 inline opcode get_irn_opcode (ir_node *node);
85 /* Get the ident for a string representation of the opcode */
86 inline ident *get_irn_opident (ir_node *node);
87 /* Get the string representation of the opcode */
88 inline const char *get_irn_opname (ir_node *node);
89 inline void set_irn_visited (ir_node *node, unsigned long visited);
90 inline unsigned long get_irn_visited (ir_node *node);
91 inline void set_irn_link (ir_node *node, ir_node *link);
92 inline ir_node *get_irn_link (ir_node *node);
94 /* Outputs a unique number for this node */
95 inline long get_irn_node_nr(ir_node *node);
99 /* irnode constructor */
100 /* Create a new irnode in irg, with an op, mode, arity and */
101 /* some incoming irnodes. */
102 /* If arity is negative, a node with a dynamic array is created. */
105 new_ir_node (ir_graph *irg,
114 * NAME access functions for node fields.
116 * NOTE Not properly documented ;-)
121 /* this works for all except Block */
122 inline ir_node *get_nodes_Block (ir_node *node);
123 inline void set_nodes_Block (ir_node *node, ir_node *block);
125 /* Projection numbers for result of Start node: use for Proj nodes! */
127 pns_initial_exec, /* Projection on an executable, the initial control
129 pns_global_store, /* Projection on the global store */
130 pns_frame_base, /* Projection on the frame base */
131 pns_globals, /* Projection on the pointer to the data segment
132 containing _all_ global entities. */
133 pns_args /* Projection on all arguments */
136 inline ir_node **get_Block_cfgpred_arr (ir_node *node);
137 int get_Block_n_cfgpreds (ir_node *node);
138 /* inline void set_Block_n_cfgpreds (ir_node *node, int n_preds); */
139 inline ir_node *get_Block_cfgpred (ir_node *node, int pos);
140 inline void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
141 inline bool get_Block_matured (ir_node *node);
142 inline void set_Block_matured (ir_node *node, bool matured);
143 inline unsigned long get_Block_block_visited (ir_node *node);
144 inline void set_Block_block_visited (ir_node *node, unsigned long visit);
145 inline ir_node *get_Block_graph_arr (ir_node *node, int pos);
146 inline void set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
149 /* We distinguish three kinds of Cond nodes. These can be distinguished
150 by the mode of the selector operand and an internal flag of type cond_kind.
151 First we distinguish binary Conds and switch Conds.
152 A binary Cond has as selector a boolean value. Proj(0) projects the control
153 flow for case "False", Proj(1) the control flow for "True". A binary Cond
154 is recognized by the boolean selector.
155 The switch Cond has as selector an unsigned integer. It produces as result
156 an n+1 Tuple (cf0, ... , cfn) of control flows.
157 We differ two flavours of this Cond. The first, the dense Cond, passes
158 control along output i if the selector value is i, 0 <= i <= n. If the
159 selector value is >n it passes control along output n.
160 The second Cond flavor differes in the treatment of cases not specified in
161 the source program. It magically knows about the existence of Proj nodes.
162 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
163 exists. Else it passes control along output n (even if this Proj does not
164 exist.) This Cond we call "fragmentary". There is a special constructor
165 new_defaultProj that automatically sets the flavor.
166 The two switch flavors are distinguished by a flag of type cond_kind.
167 Default flavor is "dense"
170 dense, /* Default. Missing Proj nodes are dead control flow. */
171 fragmentary /* Special. No control flow optimizations allowed. Missing
172 Proj nodes mean default control flow, i.e., Proj(n). */
175 inline ir_node *get_Cond_selector (ir_node *node);
176 inline void set_Cond_selector (ir_node *node, ir_node *selector);
177 inline cond_kind get_Cond_kind (ir_node *node);
178 inline void set_Cond_kind (ir_node *node, cond_kind kind);
180 inline ir_node *get_Return_mem (ir_node *node);
181 inline void set_Return_mem (ir_node *node, ir_node *mem);
182 inline ir_node **get_Return_res_arr (ir_node *node);
183 inline int get_Return_n_res (ir_node *node);
184 /*inline void set_Return_n_res (ir_node *node, int results); */
185 inline ir_node *get_Return_res (ir_node *node, int pos);
186 inline void set_Return_res (ir_node *node, int pos, ir_node *res);
188 inline ir_node *get_Raise_mem (ir_node *node);
189 inline void set_Raise_mem (ir_node *node, ir_node *mem);
190 inline ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
191 inline void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
193 inline tarval *get_Const_tarval (ir_node *node);
194 inline void set_Const_tarval (ir_node *node, tarval *con);
196 /* This enum names the three different kinds of symbolic Constants
197 represented by SymConst. The content of the attribute type_or_id
198 depends on this tag. Use the proper access routine after testing
201 type_tag, /* The SymConst is a type tag for the given type.
202 Type_or_id_p is type *. */
203 size, /* The SymConst is the size of the given type.
204 Type_or_id_p is type *. */
205 linkage_ptr_info /* The SymConst is a symbolic pointer to be filled in
206 by the linker. Type_or_id_p is ident *. */
208 typedef union type_or_id * type_or_id_p;
209 inline symconst_kind get_SymConst_kind (ir_node *node);
210 inline void set_SymConst_kind (ir_node *node, symconst_kind num);
211 /* Only to access SymConst of kind type_tag or size. Else assertion: */
212 inline type *get_SymConst_type (ir_node *node);
213 inline void set_SymConst_type (ir_node *node, type *type);
214 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
215 inline ident *get_SymConst_ptrinfo (ir_node *node);
216 inline void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
217 /* Sets both: type and ptrinfo. Needed to treat the node independent of
218 its semantics. Does a memcpy for the memory tori points to. */
219 inline type_or_id_p get_SymConst_type_or_id (ir_node *node);
220 inline void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
222 inline ir_node *get_Sel_mem (ir_node *node);
223 inline void set_Sel_mem (ir_node *node, ir_node *mem);
224 inline ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
225 inline void set_Sel_ptr (ir_node *node, ir_node *ptr);
226 inline ir_node **get_Sel_index_arr (ir_node *node);
227 inline int get_Sel_n_index (ir_node *node);
228 /*inline void set_Sel_n_index (ir_node *node, int n_index); */
229 inline ir_node *get_Sel_index (ir_node *node, int pos);
230 inline void set_Sel_index (ir_node *node, int pos, ir_node *index);
231 inline entity *get_Sel_entity (ir_node *node); /* entity to select */
232 inline void set_Sel_entity (ir_node *node, entity *ent);
234 static_linkage, /* entity is used internal and not visible out of this
236 external_linkage, /* */
239 inline linkage_type get_Sel_linkage_type (ir_node *node);
240 inline void set_Sel_linkage_type (ir_node *node, linkage_type lt);
242 inline ir_node *get_Call_mem (ir_node *node);
243 inline void set_Call_mem (ir_node *node, ir_node *mem);
244 inline ir_node *get_Call_ptr (ir_node *node);
245 inline void set_Call_ptr (ir_node *node, ir_node *ptr);
246 inline ir_node **get_Call_param_arr (ir_node *node);
247 inline int get_Call_n_params (ir_node *node);
248 inline int get_Call_arity (ir_node *node);
249 /* inline void set_Call_arity (ir_node *node, ir_node *arity); */
250 inline ir_node *get_Call_param (ir_node *node, int pos);
251 inline void set_Call_param (ir_node *node, int pos, ir_node *param);
252 inline type *get_Call_type (ir_node *node);
253 inline void set_Call_type (ir_node *node, type *type);
255 /* For unary and binary arithmetic operations the access to the
256 operands can be factored out. Left is the first, right the
257 second arithmetic value as listed in tech report 1999-44.
258 unops are: Minus, Abs, Not, Conv
259 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
260 Shr, Shrs, Rot, Cmp */
261 inline int is_unop (ir_node *node);
262 inline ir_node *get_unop_op (ir_node *node);
263 inline void set_unop_op (ir_node *node, ir_node *op);
264 inline int is_binop (ir_node *node);
265 inline ir_node *get_binop_left (ir_node *node);
266 inline void set_binop_left (ir_node *node, ir_node *left);
267 inline ir_node *get_binop_right (ir_node *node);
268 inline void set_binop_right (ir_node *node, ir_node *right);
270 inline ir_node *get_Add_left (ir_node *node);
271 inline void set_Add_left (ir_node *node, ir_node *left);
272 inline ir_node *get_Add_right (ir_node *node);
273 inline void set_Add_right (ir_node *node, ir_node *right);
275 inline ir_node *get_Sub_left (ir_node *node);
276 inline void set_Sub_left (ir_node *node, ir_node *left);
277 inline ir_node *get_Sub_right (ir_node *node);
278 inline void set_Sub_right (ir_node *node, ir_node *right);
280 inline ir_node *get_Minus_op (ir_node *node);
281 inline void set_Minus_op (ir_node *node, ir_node *op);
283 inline ir_node *get_Mul_left (ir_node *node);
284 inline void set_Mul_left (ir_node *node, ir_node *left);
285 inline ir_node *get_Mul_right (ir_node *node);
286 inline void set_Mul_right (ir_node *node, ir_node *right);
288 inline ir_node *get_Quot_left (ir_node *node);
289 inline void set_Quot_left (ir_node *node, ir_node *left);
290 inline ir_node *get_Quot_right (ir_node *node);
291 inline void set_Quot_right (ir_node *node, ir_node *right);
292 inline ir_node *get_Quot_mem (ir_node *node);
293 inline void set_Quot_mem (ir_node *node, ir_node *mem);
295 inline ir_node *get_DivMod_left (ir_node *node);
296 inline void set_DivMod_left (ir_node *node, ir_node *left);
297 inline ir_node *get_DivMod_right (ir_node *node);
298 inline void set_DivMod_right (ir_node *node, ir_node *right);
299 inline ir_node *get_DivMod_mem (ir_node *node);
300 inline void set_DivMod_mem (ir_node *node, ir_node *mem);
302 inline ir_node *get_Div_left (ir_node *node);
303 inline void set_Div_left (ir_node *node, ir_node *left);
304 inline ir_node *get_Div_right (ir_node *node);
305 inline void set_Div_right (ir_node *node, ir_node *right);
306 inline ir_node *get_Div_mem (ir_node *node);
307 inline void set_Div_mem (ir_node *node, ir_node *mem);
309 inline ir_node *get_Mod_left (ir_node *node);
310 inline void set_Mod_left (ir_node *node, ir_node *left);
311 inline ir_node *get_Mod_right (ir_node *node);
312 inline void set_Mod_right (ir_node *node, ir_node *right);
313 inline ir_node *get_Mod_mem (ir_node *node);
314 inline void set_Mod_mem (ir_node *node, ir_node *mem);
316 inline ir_node *get_Abs_op (ir_node *node);
317 inline void set_Abs_op (ir_node *node, ir_node *op);
319 inline ir_node *get_And_left (ir_node *node);
320 inline void set_And_left (ir_node *node, ir_node *left);
321 inline ir_node *get_And_right (ir_node *node);
322 inline void set_And_right (ir_node *node, ir_node *right);
324 inline ir_node *get_Or_left (ir_node *node);
325 inline void set_Or_left (ir_node *node, ir_node *left);
326 inline ir_node *get_Or_right (ir_node *node);
327 inline void set_Or_right (ir_node *node, ir_node *right);
329 inline ir_node *get_Eor_left (ir_node *node);
330 inline void set_Eor_left (ir_node *node, ir_node *left);
331 inline ir_node *get_Eor_right (ir_node *node);
332 inline void set_Eor_right (ir_node *node, ir_node *right);
334 inline ir_node *get_Not_op (ir_node *node);
335 inline void set_Not_op (ir_node *node, ir_node *op);
337 /* Projection numbers of compare: use for Proj nodes! */
342 Le, /* less or equal */
344 Ge, /* greater or equal */
345 Lg, /* less or greater */
346 Leg, /* less, equal or greater = ordered */
348 Ue, /* unordered or equal */
349 Ul, /* unordered or less */
350 Ule, /* unordered, less or equal */
351 Ug, /* unordered or greater */
352 Uge, /* unordered, greater or equal */
353 Ne, /* unordered, less or greater = not equal */
355 not_mask = Leg /* bits to flip to negate comparison */
357 inline char *get_pnc_string(int pnc);
358 inline int get_negated_pnc(int pnc);
359 inline ir_node *get_Cmp_left (ir_node *node);
360 inline void set_Cmp_left (ir_node *node, ir_node *left);
361 inline ir_node *get_Cmp_right (ir_node *node);
362 inline void set_Cmp_right (ir_node *node, ir_node *right);
364 inline ir_node *get_Shl_left (ir_node *node);
365 inline void set_Shl_left (ir_node *node, ir_node *left);
366 inline ir_node *get_Shl_right (ir_node *node);
367 inline void set_Shl_right (ir_node *node, ir_node *right);
369 inline ir_node *get_Shr_left (ir_node *node);
370 inline void set_Shr_left (ir_node *node, ir_node *left);
371 inline ir_node *get_Shr_right (ir_node *node);
372 inline void set_Shr_right (ir_node *node, ir_node *right);
374 inline ir_node *get_Shrs_left (ir_node *node);
375 inline void set_Shrs_left (ir_node *node, ir_node *left);
376 inline ir_node *get_Shrs_right (ir_node *node);
377 inline void set_Shrs_right (ir_node *node, ir_node *right);
379 inline ir_node *get_Rot_left (ir_node *node);
380 inline void set_Rot_left (ir_node *node, ir_node *left);
381 inline ir_node *get_Rot_right (ir_node *node);
382 inline void set_Rot_right (ir_node *node, ir_node *right);
384 inline ir_node *get_Conv_op (ir_node *node);
385 inline void set_Conv_op (ir_node *node, ir_node *op);
387 inline ir_node **get_Phi_preds_arr (ir_node *node);
388 inline int get_Phi_n_preds (ir_node *node);
389 /* inline void set_Phi_n_preds (ir_node *node, int n_preds); */
390 inline ir_node *get_Phi_pred (ir_node *node, int pos);
391 inline void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
393 inline ir_node *get_Load_mem (ir_node *node);
394 inline void set_Load_mem (ir_node *node, ir_node *mem);
395 inline ir_node *get_Load_ptr (ir_node *node);
396 inline void set_Load_ptr (ir_node *node, ir_node *ptr);
398 inline ir_node *get_Store_mem (ir_node *node);
399 inline void set_Store_mem (ir_node *node, ir_node *mem);
400 inline ir_node *get_Store_ptr (ir_node *node);
401 inline void set_Store_ptr (ir_node *node, ir_node *ptr);
402 inline ir_node *get_Store_value (ir_node *node);
403 inline void set_Store_value (ir_node *node, ir_node *value);
405 inline ir_node *get_Alloc_mem (ir_node *node);
406 inline void set_Alloc_mem (ir_node *node, ir_node *mem);
407 inline ir_node *get_Alloc_size (ir_node *node);
408 inline void set_Alloc_size (ir_node *node, ir_node *size);
409 inline type *get_Alloc_type (ir_node *node);
410 inline void set_Alloc_type (ir_node *node, type *type);
412 stack_alloc, /* Alloc allocates the object on the stack. */
413 heap_alloc /* Alloc allocates the object on the heap. */
415 inline where_alloc get_Alloc_where (ir_node *node);
416 inline void set_Alloc_where (ir_node *node, where_alloc where);
418 inline ir_node *get_Free_mem (ir_node *node);
419 inline void set_Free_mem (ir_node *node, ir_node *mem);
420 inline ir_node *get_Free_ptr (ir_node *node);
421 inline void set_Free_ptr (ir_node *node, ir_node *ptr);
422 inline ir_node *get_Free_size (ir_node *node);
423 inline void set_Free_size (ir_node *node, ir_node *size);
424 inline type *get_Free_type (ir_node *node);
425 inline void set_Free_type (ir_node *node, type *type);
427 inline ir_node **get_Sync_preds_arr (ir_node *node);
428 inline int get_Sync_n_preds (ir_node *node);
429 /* inline void set_Sync_n_preds (ir_node *node, int n_preds); */
430 inline ir_node *get_Sync_pred (ir_node *node, int pos);
431 inline void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
433 inline ir_node *get_Proj_pred (ir_node *node);
434 inline void set_Proj_pred (ir_node *node, ir_node *pred);
435 inline long get_Proj_proj (ir_node *node);
436 inline void set_Proj_proj (ir_node *node, long proj);
438 inline ir_node **get_Tuple_preds_arr (ir_node *node);
439 inline int get_Tuple_n_preds (ir_node *node);
440 /* inline void set_Tuple_n_preds (ir_node *node, int n_preds); */
441 inline ir_node *get_Tuple_pred (ir_node *node, int pos);
442 inline void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
444 inline ir_node *get_Id_pred (ir_node *node);
445 inline void set_Id_pred (ir_node *node, ir_node *pred);
449 /****s* irnode/other2
451 * NAME Auxiliary routines
453 * NOTE Not properly documented ;-)
458 /* returns operand of node if node is a Proj. */
459 inline ir_node *skip_Proj (ir_node *node);
460 /* returns operand of node if node is a Id */
461 inline ir_node *skip_nop (ir_node *node);
462 /* returns corresponding operand of Tuple if node is a Proj from
464 inline ir_node *skip_Tuple (ir_node *node);
465 /* returns true if node is a Bad node. */
466 inline int is_Bad (ir_node *node);
467 /* returns true if the node is not a Block */
468 inline int is_no_Block (ir_node *node);
469 /* Returns true if the operation manipulates control flow:
470 Start, End, Jmp, Cond, Return, Raise */
471 int is_cfop(ir_node *node);
472 /* Returns true if the operation can change the control flow because
474 int is_fragile_op(ir_node *node);
475 /* Returns the memory operand of fragile operations. */
476 ir_node *get_fragile_op_mem(ir_node *node);
480 /* Makros for debugging the libfirm */
484 #define DDMSG printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
485 #define DDMSG1(X) printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, \
486 id_to_str(get_irn_opident(X)))
487 #define DDMSG2(X) printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__, \
488 id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
490 #define DDMSG3(X) printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, \
491 print_firm_kind(X), (X))
495 # endif /* _IRNODE_H_ */