3 * File name: ir/ir/irnode.h
4 * Purpose: Representation of an intermediate operation.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 /** Projection numbers of compare: use for Proj nodes! */
18 False = 0, /**< false */
21 Le, /**< less or equal */
23 Ge, /**< greater or equal */
24 Lg, /**< less or greater */
25 Leg = 7, /**< less, equal or greater = ordered */
27 Ue, /**< unordered or equal */
28 Ul, /**< unordered or less */
29 Ule, /**< unordered, less or equal */
30 Ug, /**< unordered or greater */
31 Uge, /**< unordered, greater or equal */
32 Ne, /**< unordered, less or greater = not equal */
33 True = 15 /**< true */
34 /* not_mask = Leg*/ /* bits to flip to negate comparison * @@ hack for jni interface */
35 } pnc_number; /* pnc: Projection Number Cmp */
41 # include "firm_common.h"
51 * @author Martin Trapp, Christian Schaefer
53 * Declarations of an ir node.
57 * @defgroup ir_node Declarations of an ir node.
59 * The type definiton of ir_node is also in irgraph.h to resolve
60 * recursion between irnode.h and irgraph.h
62 * ir_node - a datatype representing a Firm node
64 * The common fields are:
66 * - firm_kind - A firm_kind tag containing k_type. This is useful
67 * for dynamically checking whether a node is a ir_node.
68 * - arity - The number of predecessors in the Firm graph.
69 * - in - A list with the predecessors in the Firm graph. There are
70 * routines to access individual elements and to obtain the
71 * array. The method returning the array should not be used.
72 * - mode - The mode of the node. There are routines to get the mode
73 * but also to access the mode's fields directly.
74 * - opcode - The opcode of the node. There are routines to get the opcode
75 * but also to access the opcode's fields directly.
76 * - node_nr - A unique number for the node. Available only if debugging
81 #ifndef _IR_NODE_TYPEDEF_
82 #define _IR_NODE_TYPEDEF_
83 typedef struct ir_node ir_node;
87 * you can work on the graph without considering the different types
88 * of nodes, it's just a big graph.
92 * Checks whether a pointer points to a ir node.
94 * @param thing an arbitrary pointer
97 * true if the thing is a ir mode, else false
100 is_ir_node (void *thing);
102 /** returns the number of predecessors without the block predecessor: */
103 int get_irn_arity (const ir_node *node);
105 /** Replaces the old in array by a new one that will contain the ins given in
106 the parameters. Conserves the block predecessor. It copies the array passed.
107 This function is necessary to ajust in arrays of blocks, calls and phis.
108 Assumes that current_ir_graph is set to the graph containing "node".
109 "in" must contain all predecessors except the block that are required for
111 INLINE void set_irn_in (ir_node *node, int arity,
113 /* to iterate through the predecessors without touching the array. No
114 order of predecessors guaranteed.
115 To iterate over the operands iterate from 0 to i < get_irn_arity(),
116 to iterate including the Block predecessor iterate from i = -1 to
117 i < get_irn_arity. */
118 /* Access predecessor n */
119 /* get_irn_n removes Id predecessors. */
120 INLINE ir_node *get_irn_n (ir_node *node, int n);
121 INLINE void set_irn_n (ir_node *node, int n, ir_node *in);
122 /** Sets the mode struct of node */
123 INLINE void set_irn_mode (ir_node *node, ir_mode *mode);
124 /** Gets the mode struct. */
125 INLINE ir_mode *get_irn_mode (const ir_node *node);
126 /** Gets the mode-enum modecode. */
127 INLINE modecode get_irn_modecode (const ir_node *node);
128 /** Gets the ident for a string representation of the mode .*/
129 INLINE ident *get_irn_modeident (const ir_node *node);
130 /** Gets the opcode struct of the node */
131 INLINE ir_op *get_irn_op (const ir_node *node);
132 /** Sets the opcode struct of the node. */
133 INLINE void set_irn_op (ir_node *node, ir_op *op);
134 /** Gets the opcode-enum of the node. */
135 INLINE opcode get_irn_opcode (const ir_node *node);
136 /** Get the string representation of the opcode. */
137 INLINE const char *get_irn_opname (const ir_node *node);
138 /** Get the ident for a string representation of the opcode. */
139 INLINE ident *get_irn_opident (const ir_node *node);
140 INLINE unsigned long get_irn_visited (const ir_node *node);
141 INLINE void set_irn_visited (ir_node *node, unsigned long visited);
142 /** Sets visited to get_irg_visited(current_ir_graph). */
143 INLINE void mark_irn_visited (ir_node *node);
144 /** Returns 1 if visited < get_irg_visited(current_ir_graph). */
145 INLINE int irn_not_visited (const ir_node *node);
146 /** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
147 INLINE int irn_visited (const ir_node *node);
148 INLINE void set_irn_link (ir_node *node, void *link);
149 INLINE void *get_irn_link (const ir_node *node);
151 /** Outputs a unique number for this node if libfirm is compiled for
152 debugging, (configure with --enable-debug) else returns 0. */
153 INLINE long get_irn_node_nr(const ir_node *node);
155 /** Returns the ir_graph this node belongs to. Only valid for
156 * CallBegin, EndReg, EndExcept and Start */
157 INLINE ir_graph *get_irn_irg(ir_node *node);
160 * irnode constructor.
161 * Create a new irnode in irg, with an op, mode, arity and
162 * some incoming irnodes.
163 * If arity is negative, a node with a dynamic array is created.
166 new_ir_node (dbg_info *db,
176 * NAME access functions for node fields.
178 * Not properly documented ;-)
182 /* this works for all except Block */
183 INLINE ir_node *get_nodes_Block (ir_node *node);
184 INLINE void set_nodes_Block (ir_node *node, ir_node *block);
186 /** Projection numbers for result of Start node: use for Proj nodes! */
188 pns_initial_exec, /**< Projection on an executable, the initial control
190 pns_global_store, /**< Projection on the global store */
191 pns_frame_base, /**< Projection on the frame base */
192 pns_globals, /**< Projection on the pointer to the data segment
193 containing _all_ global entities. */
194 pns_args, /**< Projection on all arguments */
195 pns_value_arg_base /**< Pointer to region of compound value arguments as defined by
196 type of this method. */
197 } pns_number; /* pns: Projection Number Start */
199 /* @@@ no more supported */
200 INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
201 int get_Block_n_cfgpreds (ir_node *node);
202 INLINE ir_node *get_Block_cfgpred (ir_node *node, int pos);
203 INLINE void set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
204 INLINE bool get_Block_matured (ir_node *node);
205 INLINE void set_Block_matured (ir_node *node, bool matured);
206 INLINE unsigned long get_Block_block_visited (ir_node *node);
207 INLINE void set_Block_block_visited (ir_node *node, unsigned long visit);
208 /* For this current_ir_graph must be set. */
209 INLINE void mark_Block_block_visited(ir_node *node);
210 INLINE int Block_not_block_visited(ir_node *node);
212 /* Set and remove interprocedural predecessors. If the interprocedural
213 * predecessors are removed, the node has the same predecessors in
215 * @@@ Maybe better: arity is zero if no cg preds. */
216 void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
217 void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
218 /* @@@ not supported */
219 ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
220 /* Returns the number of interproc predecessors. 0 if none. */
221 int get_Block_cg_n_cfgpreds(ir_node * node);
222 ir_node *get_Block_cg_cfgpred(ir_node * node, int pos);
223 /* frees the memory. */
224 void remove_Block_cg_cfgpred_arr(ir_node * node);
226 /* Start references the irg it is in. */
227 ir_graph *get_Start_irg(ir_node *node);
228 void set_Start_irg(ir_node *node, ir_graph *irg);
230 INLINE int get_End_n_keepalives(ir_node *end);
231 INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
232 INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
233 INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
234 /* Some parts of the End node are allocated seperately -- their memory
235 is not recovered by dead_node_elimination if a End node is dead.
236 free_End frees these data structures. */
237 INLINE void free_End (ir_node *end);
239 ir_graph *get_EndReg_irg (const ir_node *end);
240 ir_graph *get_EndExcept_irg (const ir_node *end);
242 /* We distinguish three kinds of Cond nodes. These can be distinguished
243 by the mode of the selector operand and an internal flag of type cond_kind.
244 First we distinguish binary Conds and switch Conds.
245 A binary Cond has as selector a boolean value. Proj(0) projects the control
246 flow for case "False", Proj(1) the control flow for "True". A binary Cond
247 is recognized by the boolean selector.
248 The switch Cond has as selector an unsigned integer. It produces as result
249 an n+1 Tuple (cf0, ... , cfn) of control flows.
250 We differ two flavours of this Cond. The first, the dense Cond, passes
251 control along output i if the selector value is i, 0 <= i <= n. If the
252 selector value is >n it passes control along output n.
253 The second Cond flavor differes in the treatment of cases not specified in
254 the source program. It magically knows about the existence of Proj nodes.
255 It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
256 exists. Else it passes control along output n (even if this Proj does not
257 exist.) This Cond we call "fragmentary". There is a special constructor
258 new_defaultProj that automatically sets the flavor.
259 The two switch flavors are distinguished by a flag of type cond_kind.
260 Default flavor is "dense"
263 dense, /**< Default. Missing Proj nodes are dead control flow. */
264 fragmentary /**< Special. No control flow optimizations allowed. Missing
265 Proj nodes mean default control flow, i.e., Proj(n). */
268 INLINE ir_node *get_Cond_selector (ir_node *node);
269 INLINE void set_Cond_selector (ir_node *node, ir_node *selector);
270 INLINE cond_kind get_Cond_kind (ir_node *node);
271 INLINE void set_Cond_kind (ir_node *node, cond_kind kind);
273 INLINE ir_node *get_Return_mem (ir_node *node);
274 INLINE void set_Return_mem (ir_node *node, ir_node *mem);
275 INLINE ir_node **get_Return_res_arr (ir_node *node);
276 INLINE int get_Return_n_ress (ir_node *node);
277 INLINE ir_node *get_Return_res (ir_node *node, int pos);
278 INLINE void set_Return_res (ir_node *node, int pos, ir_node *res);
280 INLINE ir_node *get_Raise_mem (ir_node *node);
281 INLINE void set_Raise_mem (ir_node *node, ir_node *mem);
282 INLINE ir_node *get_Raise_exo_ptr (ir_node *node); /* PoinTeR to EXception Object */
283 INLINE void set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
285 INLINE tarval *get_Const_tarval (ir_node *node);
286 INLINE void set_Const_tarval (ir_node *node, tarval *con);
287 /* The source language type. Must be an atomic type. Mode of type must
288 be mode of node. For tarvals from entities type must be pointer to
290 INLINE type *get_Const_type (ir_node *node);
291 INLINE void set_Const_type (ir_node *node, type *tp);
293 /** This enum names the three different kinds of symbolic Constants
294 represented by SymConst. The content of the attribute type_or_id
295 depends on this tag. Use the proper access routine after testing
298 type_tag, /**< The SymConst is a type tag for the given type.
299 Type_or_id_p is type *. */
300 size, /**< The SymConst is the size of the given type.
301 Type_or_id_p is type *. */
302 linkage_ptr_info /**< The SymConst is a symbolic pointer to be filled in
303 by the linker. Type_or_id_p is ident *. */
305 typedef union type_or_id * type_or_id_p;
306 INLINE symconst_kind get_SymConst_kind (const ir_node *node);
307 INLINE void set_SymConst_kind (ir_node *node, symconst_kind num);
308 /* Only to access SymConst of kind type_tag or size. Else assertion: */
309 INLINE type *get_SymConst_type (ir_node *node);
310 INLINE void set_SymConst_type (ir_node *node, type *tp);
311 /* Only to access SymConst of kind linkage_ptr_info. Else assertion: */
312 INLINE ident *get_SymConst_ptrinfo (ir_node *node);
313 INLINE void set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
314 /* Sets both: type and ptrinfo. Needed to treat the node independent of
315 its semantics. Does a memcpy for the memory tori points to. */
316 INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
317 INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);
319 INLINE ir_node *get_Sel_mem (ir_node *node);
320 INLINE void set_Sel_mem (ir_node *node, ir_node *mem);
321 INLINE ir_node *get_Sel_ptr (ir_node *node); /* ptr to the object to select from */
322 INLINE void set_Sel_ptr (ir_node *node, ir_node *ptr);
323 INLINE ir_node **get_Sel_index_arr (ir_node *node);
324 INLINE int get_Sel_n_indexs (ir_node *node);
325 INLINE ir_node *get_Sel_index (ir_node *node, int pos);
326 INLINE void set_Sel_index (ir_node *node, int pos, ir_node *index);
327 INLINE entity *get_Sel_entity (ir_node *node); /* entity to select */
328 INLINE void set_Sel_entity (ir_node *node, entity *ent);
330 /* @@@ ajacs specific node -- not supported */
331 type *get_InstOf_ent (ir_node *node);
332 void set_InstOf_ent (ir_node *node, type *ent);
333 ir_node *get_InstOf_obj (ir_node *node);
334 void set_InstOf_obj (ir_node *node, ir_node *obj);
335 ir_node *get_InstOf_store (ir_node *node);
336 void set_InstOf_store (ir_node *node, ir_node *obj);
338 /** Projection numbers for result of Call node: use for Proj nodes! */
340 pncl_memory = 0, /**< The memory result. */
341 pncl_exc_target = 1, /**< The control flow result branching to the exception handler */
342 pncl_result_tuple = 2, /**< The tuple containing all (0, 1, 2, ...) results */
343 pncl_exc_memory = 3, /**< The memory result in case the called method terminated with
345 pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
346 passed by value (for compound result types). */
347 } pncl_number; /* pncl: Projection Number CaLl */
349 INLINE ir_node *get_Call_mem (ir_node *node);
350 INLINE void set_Call_mem (ir_node *node, ir_node *mem);
351 INLINE ir_node *get_Call_ptr (ir_node *node);
352 INLINE void set_Call_ptr (ir_node *node, ir_node *ptr);
353 INLINE ir_node **get_Call_param_arr (ir_node *node);
354 /** Gets the number of parameters of a call. */
355 INLINE int get_Call_n_params (ir_node *node);
356 /** Gets the call parameter at position pos. */
357 INLINE ir_node *get_Call_param (ir_node *node, int pos);
358 /** Sets the call parameter at position pos. */
359 INLINE void set_Call_param (ir_node *node, int pos, ir_node *param);
360 /** Gets the type of a call. */
361 INLINE type *get_Call_type (ir_node *node);
362 /** Sets the type of a call. */
363 INLINE void set_Call_type (ir_node *node, type *tp);
364 /** Gets the arity of a call. Identical to get_Call_n_params(). */
365 INLINE int get_Call_arity (ir_node *node);
367 /* Set, get and remove the callee-analysis. */
368 int get_Call_n_callees(ir_node * node);
369 entity * get_Call_callee(ir_node * node, int pos);
370 void set_Call_callee_arr(ir_node * node, int n, entity ** arr);
371 void remove_Call_callee_arr(ir_node * node);
373 ir_node * get_CallBegin_ptr (ir_node *node);
374 void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
375 ir_graph *get_CallBegin_irg (ir_node *node);
376 ir_node *get_CallBegin_call (ir_node *node);
377 void set_CallBegin_call (ir_node *node, ir_node *call);
379 /* For unary and binary arithmetic operations the access to the
380 operands can be factored out. Left is the first, right the
381 second arithmetic value as listed in tech report 1999-44.
382 unops are: Minus, Abs, Not, Conv, Cast
383 binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
384 Shr, Shrs, Rot, Cmp */
385 INLINE int is_unop (ir_node *node);
386 INLINE ir_node *get_unop_op (ir_node *node);
387 INLINE void set_unop_op (ir_node *node, ir_node *op);
388 INLINE int is_binop (ir_node *node);
389 INLINE ir_node *get_binop_left (ir_node *node);
390 INLINE void set_binop_left (ir_node *node, ir_node *left);
391 INLINE ir_node *get_binop_right (ir_node *node);
392 INLINE void set_binop_right (ir_node *node, ir_node *right);
394 INLINE ir_node *get_Add_left (ir_node *node);
395 INLINE void set_Add_left (ir_node *node, ir_node *left);
396 INLINE ir_node *get_Add_right (ir_node *node);
397 INLINE void set_Add_right (ir_node *node, ir_node *right);
399 INLINE ir_node *get_Sub_left (ir_node *node);
400 INLINE void set_Sub_left (ir_node *node, ir_node *left);
401 INLINE ir_node *get_Sub_right (ir_node *node);
402 INLINE void set_Sub_right (ir_node *node, ir_node *right);
404 INLINE ir_node *get_Minus_op (ir_node *node);
405 INLINE void set_Minus_op (ir_node *node, ir_node *op);
407 INLINE ir_node *get_Mul_left (ir_node *node);
408 INLINE void set_Mul_left (ir_node *node, ir_node *left);
409 INLINE ir_node *get_Mul_right (ir_node *node);
410 INLINE void set_Mul_right (ir_node *node, ir_node *right);
412 INLINE ir_node *get_Quot_left (ir_node *node);
413 INLINE void set_Quot_left (ir_node *node, ir_node *left);
414 INLINE ir_node *get_Quot_right (ir_node *node);
415 INLINE void set_Quot_right (ir_node *node, ir_node *right);
416 INLINE ir_node *get_Quot_mem (ir_node *node);
417 INLINE void set_Quot_mem (ir_node *node, ir_node *mem);
419 INLINE ir_node *get_DivMod_left (ir_node *node);
420 INLINE void set_DivMod_left (ir_node *node, ir_node *left);
421 INLINE ir_node *get_DivMod_right (ir_node *node);
422 INLINE void set_DivMod_right (ir_node *node, ir_node *right);
423 INLINE ir_node *get_DivMod_mem (ir_node *node);
424 INLINE void set_DivMod_mem (ir_node *node, ir_node *mem);
426 INLINE ir_node *get_Div_left (ir_node *node);
427 INLINE void set_Div_left (ir_node *node, ir_node *left);
428 INLINE ir_node *get_Div_right (ir_node *node);
429 INLINE void set_Div_right (ir_node *node, ir_node *right);
430 INLINE ir_node *get_Div_mem (ir_node *node);
431 INLINE void set_Div_mem (ir_node *node, ir_node *mem);
433 INLINE ir_node *get_Mod_left (ir_node *node);
434 INLINE void set_Mod_left (ir_node *node, ir_node *left);
435 INLINE ir_node *get_Mod_right (ir_node *node);
436 INLINE void set_Mod_right (ir_node *node, ir_node *right);
437 INLINE ir_node *get_Mod_mem (ir_node *node);
438 INLINE void set_Mod_mem (ir_node *node, ir_node *mem);
440 INLINE ir_node *get_Abs_op (ir_node *node);
441 INLINE void set_Abs_op (ir_node *node, ir_node *op);
443 INLINE ir_node *get_And_left (ir_node *node);
444 INLINE void set_And_left (ir_node *node, ir_node *left);
445 INLINE ir_node *get_And_right (ir_node *node);
446 INLINE void set_And_right (ir_node *node, ir_node *right);
448 INLINE ir_node *get_Or_left (ir_node *node);
449 INLINE void set_Or_left (ir_node *node, ir_node *left);
450 INLINE ir_node *get_Or_right (ir_node *node);
451 INLINE void set_Or_right (ir_node *node, ir_node *right);
453 INLINE ir_node *get_Eor_left (ir_node *node);
454 INLINE void set_Eor_left (ir_node *node, ir_node *left);
455 INLINE ir_node *get_Eor_right (ir_node *node);
456 INLINE void set_Eor_right (ir_node *node, ir_node *right);
458 INLINE ir_node *get_Not_op (ir_node *node);
459 INLINE void set_Not_op (ir_node *node, ir_node *op);
461 INLINE const char *get_pnc_string(int pnc);
463 INLINE int get_negated_pnc(int pnc);
464 INLINE ir_node *get_Cmp_left (ir_node *node);
465 INLINE void set_Cmp_left (ir_node *node, ir_node *left);
466 INLINE ir_node *get_Cmp_right (ir_node *node);
467 INLINE void set_Cmp_right (ir_node *node, ir_node *right);
469 INLINE ir_node *get_Shl_left (ir_node *node);
470 INLINE void set_Shl_left (ir_node *node, ir_node *left);
471 INLINE ir_node *get_Shl_right (ir_node *node);
472 INLINE void set_Shl_right (ir_node *node, ir_node *right);
474 INLINE ir_node *get_Shr_left (ir_node *node);
475 INLINE void set_Shr_left (ir_node *node, ir_node *left);
476 INLINE ir_node *get_Shr_right (ir_node *node);
477 INLINE void set_Shr_right (ir_node *node, ir_node *right);
479 INLINE ir_node *get_Shrs_left (ir_node *node);
480 INLINE void set_Shrs_left (ir_node *node, ir_node *left);
481 INLINE ir_node *get_Shrs_right (ir_node *node);
482 INLINE void set_Shrs_right (ir_node *node, ir_node *right);
484 INLINE ir_node *get_Rot_left (ir_node *node);
485 INLINE void set_Rot_left (ir_node *node, ir_node *left);
486 INLINE ir_node *get_Rot_right (ir_node *node);
487 INLINE void set_Rot_right (ir_node *node, ir_node *right);
489 INLINE ir_node *get_Conv_op (ir_node *node);
490 INLINE void set_Conv_op (ir_node *node, ir_node *op);
492 INLINE ir_node *get_Cast_op (ir_node *node);
493 INLINE void set_Cast_op (ir_node *node, ir_node *op);
494 INLINE type *get_Cast_type (ir_node *node);
495 INLINE void set_Cast_type (ir_node *node, type *to_tp);
497 INLINE ir_node **get_Phi_preds_arr (ir_node *node);
498 INLINE int get_Phi_n_preds (ir_node *node);
499 INLINE ir_node *get_Phi_pred (ir_node *node, int pos);
500 INLINE void set_Phi_pred (ir_node *node, int pos, ir_node *pred);
502 INLINE ir_node *get_Filter_pred(ir_node *node);
503 INLINE void set_Filter_pred(ir_node *node, ir_node *pred);
504 INLINE long get_Filter_proj(ir_node *node);
505 INLINE void set_Filter_proj(ir_node *node, long proj);
506 /* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
507 * @@@ Maybe better: arity is zero if no cg preds. */
508 void set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
509 void set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
510 int get_Filter_n_cg_preds(ir_node *node);
511 ir_node * get_Filter_cg_pred(ir_node *node, int pos);
513 INLINE ir_node *get_Load_mem (ir_node *node);
514 INLINE void set_Load_mem (ir_node *node, ir_node *mem);
515 INLINE ir_node *get_Load_ptr (ir_node *node);
516 INLINE void set_Load_ptr (ir_node *node, ir_node *ptr);
518 INLINE ir_node *get_Store_mem (ir_node *node);
519 INLINE void set_Store_mem (ir_node *node, ir_node *mem);
520 INLINE ir_node *get_Store_ptr (ir_node *node);
521 INLINE void set_Store_ptr (ir_node *node, ir_node *ptr);
522 INLINE ir_node *get_Store_value (ir_node *node);
523 INLINE void set_Store_value (ir_node *node, ir_node *value);
525 INLINE ir_node *get_Alloc_mem (ir_node *node);
526 INLINE void set_Alloc_mem (ir_node *node, ir_node *mem);
527 INLINE ir_node *get_Alloc_size (ir_node *node);
528 INLINE void set_Alloc_size (ir_node *node, ir_node *size);
529 INLINE type *get_Alloc_type (ir_node *node);
530 INLINE void set_Alloc_type (ir_node *node, type *tp);
532 /** allocation place. */
534 stack_alloc, /**< Alloc allocates the object on the stack. */
535 heap_alloc /**< Alloc allocates the object on the heap. */
538 INLINE where_alloc get_Alloc_where (ir_node *node);
539 INLINE void set_Alloc_where (ir_node *node, where_alloc where);
541 INLINE ir_node *get_Free_mem (ir_node *node);
542 INLINE void set_Free_mem (ir_node *node, ir_node *mem);
543 INLINE ir_node *get_Free_ptr (ir_node *node);
544 INLINE void set_Free_ptr (ir_node *node, ir_node *ptr);
545 INLINE ir_node *get_Free_size (ir_node *node);
546 INLINE void set_Free_size (ir_node *node, ir_node *size);
547 INLINE type *get_Free_type (ir_node *node);
548 INLINE void set_Free_type (ir_node *node, type *tp);
550 INLINE ir_node **get_Sync_preds_arr (ir_node *node);
551 INLINE int get_Sync_n_preds (ir_node *node);
552 INLINE ir_node *get_Sync_pred (ir_node *node, int pos);
553 INLINE void set_Sync_pred (ir_node *node, int pos, ir_node *pred);
555 INLINE ir_node *get_Proj_pred (ir_node *node);
556 INLINE void set_Proj_pred (ir_node *node, ir_node *pred);
557 /* Why long? shouldn't int be enough, and smaller? Or even byte? */
558 INLINE long get_Proj_proj (ir_node *node);
559 INLINE void set_Proj_proj (ir_node *node, long proj);
561 INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
562 INLINE int get_Tuple_n_preds (ir_node *node);
563 INLINE ir_node *get_Tuple_pred (ir_node *node, int pos);
564 INLINE void set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
566 INLINE ir_node *get_Id_pred (ir_node *node);
567 INLINE void set_Id_pred (ir_node *node, ir_node *pred);
572 * NAME Auxiliary routines
574 * Not properly documented ;-)
578 /** returns operand of node if node is a Proj. */
579 INLINE ir_node *skip_Proj (ir_node *node);
580 /** returns operand of node if node is a Id */
581 INLINE ir_node *skip_nop (ir_node *node);
582 INLINE ir_node *skip_Id (ir_node *node); /* Same as skip_nop. */
583 /* returns corresponding operand of Tuple if node is a Proj from
585 INLINE ir_node *skip_Tuple (ir_node *node);
586 /** returns true if node is a Bad node. */
587 INLINE int is_Bad (ir_node *node);
588 /** returns true if the node is not a Block */
589 INLINE int is_no_Block (ir_node *node);
590 /** returns true if the node is a Block */
591 INLINE int is_Block (ir_node *node);
592 /** returns true if node is a Proj node or a Filter node in
593 * intraprocedural view */
594 INLINE int is_Proj (const ir_node *node);
595 /** Returns true if the operation manipulates control flow:
596 Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
597 int is_cfop(ir_node *node);
599 /** Returns true if the operation manipulates interprocedural control flow:
600 CallBegin, EndReg, EndExcept */
601 int is_ip_cfop(ir_node *node);
602 /** Returns true if the operation can change the control flow because
603 of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
605 ir_graph *get_ip_cfop_irg(ir_node *n);
607 int is_fragile_op(ir_node *node);
608 /** Returns the memory operand of fragile operations. */
609 ir_node *get_fragile_op_mem(ir_node *node);
614 /* GNU C has the __FUNCTION__ extension */
615 #define __MYFUNC__ __FUNCTION__
617 /* use Filename instead */
618 #define __MYFUNC__ __FILE__
622 Don't format with "\", firmjni gets problems */
623 /** Output location */
624 #define DDM printf("%s(l.%i).\n", __MYFUNC__, __LINE__);
625 /** Output the firm kind of the node */
626 #define DDMK(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, print_firm_kind(X), (void *)(X));
627 /** Output information about a node */
628 #define DDMN(X) printf("%s(l.%i) %s%s: %ld (%p)\n", __MYFUNC__, __LINE__, get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))
629 /** Output information about a node and its block */
630 #define DDMNB(X) printf("%s%s: %ld (in block %ld)\n", get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), get_irn_node_nr(get_nodes_Block(X)))
631 /** Output information about a type */
632 #define DDMT(X) printf("%s(l.%i) %s %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
633 /** Output information about an entity */
634 #define DDME(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
635 /** Output information about an entity and its type */
636 #define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
637 /** Output information about an entity and its owner */
638 #define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
639 /** Output information about a graph */
640 #define DDMG(X) printf("%s(l.%i) %s: %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (void *)(X))
641 /** Output information about an ident */
642 #define DDMI(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
643 /** Output information about a mode */
644 #define DDMM(X) printf("%s(l.%i) %s: %p\n", __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
645 /** Output information about a loop */
646 #define DDML(X) printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
647 /** Output information about a tarVal */
648 #define DDMV(X) printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
650 /*@}*/ /* end of ir_node group definition */
653 # endif /* _IRNODE_H_ */