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