irnode.h 26.2 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe      3 2002/02/28 13:33:52
Michael Beck's avatar
Michael Beck committed
2
 * All rights reserved.
Michael Beck's avatar
Michael Beck committed
3
4
 */

Boris Boesler's avatar
Boris Boesler committed
5
6
/* $Id$ */

Christian Schäfer's avatar
Christian Schäfer committed
7
8
9
# ifndef _IRNODE_H_
# define _IRNODE_H_

Michael Beck's avatar
Michael Beck committed
10
/** Projection numbers of compare: use for Proj nodes! */
11
typedef enum {
Michael Beck's avatar
Michael Beck committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
  False,		/**< false */
  Eq,			/**< equal */
  Lt,			/**< less */
  Le,			/**< less or equal */
  Gt,			/**< greater */
  Ge,			/**< greater or equal */
  Lg,			/**< less or greater */
  Leg,			/**< less, equal or greater = ordered */
  Uo,			/**< unordered */
  Ue,			/**< unordered or equal */
  Ul,			/**< unordered or less */
  Ule,			/**< unordered, less or equal */
  Ug,			/**< unordered or greater */
  Uge,			/**< unordered, greater or equal */
  Ne,			/**< unordered, less or greater = not equal */
  True		        /**< true */
28
29
30
31
32
  /* not_mask = Leg*/	/* bits to flip to negate comparison * @@ hack for jni interface */
} pnc_number;
#define not_mask Leg

# include "tv.h"
Christian Schäfer's avatar
Christian Schäfer committed
33
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
34
# include "entity.h"
35
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
36
37
38
# include "irop.h"
# include "irmode.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
39
# include "dbginfo.h"
40
# include "exc.h"
Christian Schäfer's avatar
Christian Schäfer committed
41

Michael Beck's avatar
Michael Beck committed
42
43
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
44
 *
Michael Beck's avatar
Michael Beck committed
45
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
46
 *
Michael Beck's avatar
Michael Beck committed
47
48
49
50
51
52
53
54
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
 * The type definiton of ir_node is also in irgraph.h to resolve
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
55
 *
Michael Beck's avatar
Michael Beck committed
56
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
57
 *
Michael Beck's avatar
Michael Beck committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 *  The common fields are:
 *
 *  - firm_kind - A firm_kind tag containing k_type.  This is useful
 *                for dynamically checking whether a node is a ir_node.
 *  - arity     - The number of predecessors in the Firm graph.
 *  - in        - A list with the predecessors in the Firm graph.  There are
 *                routines to access individual elements and to obtain the
 *                array.  The method returning the array should not be used.
 *  - mode      - The mode of the node.  There are routines to get the mode
 *                but also to access the mode's fields directly.
 *  - opcode    - The opcode of the node. There are routines to get the opcode
 *                but also to access the opcode's fields directly.
 *  - node_nr   - A unique number for the node.  Available only if debugging
 *                is turned on.
 * @{
Götz Lindenmaier's avatar
Götz Lindenmaier committed
73
 */
Michael Beck's avatar
Michael Beck committed
74

Götz Lindenmaier's avatar
Götz Lindenmaier committed
75
76
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
77
78
79
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
80
/**
Michael Beck's avatar
Michael Beck committed
81
82
83
 *   you can work on the graph without considering the different types
 *   of nodes, it's just a big graph.
 */
Christian Schäfer's avatar
Christian Schäfer committed
84

Michael Beck's avatar
Michael Beck committed
85
/** returns the number of predecessors without the block predecessor: */
86
int                  get_irn_arity         (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
87
88

/** Replaces the old in array by a new one that will contain the ins given in
89
   the parameters.  Conserves the block predecessor.  It copies the array passed.
90
   This function is necessary to ajust in arrays of blocks, calls and phis.
91
   Assumes that current_ir_graph is set to the graph containing "node".
92
93
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
94
INLINE void          set_irn_in            (ir_node *node, int arity,
95
					    ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
96
97
98
/* to iterate through the predecessors without touching the array. No
   order of predecessors guaranteed.
   To iterate over the operands iterate from 0 to i < get_irn_arity(),
Götz Lindenmaier's avatar
Götz Lindenmaier committed
99
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
100
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
101
/* Access predecessor n */
102
/* get_irn_n removes Id predecessors. */
103
104
INLINE ir_node      *get_irn_n             (ir_node *node, int n);
INLINE void          set_irn_n             (ir_node *node, int n, ir_node *in);
Michael Beck's avatar
Michael Beck committed
105
/** Gets the mode struct. */
106
INLINE ir_mode      *get_irn_mode          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
107
/** Gets the mode-enum modecode. */
108
INLINE modecode      get_irn_modecode      (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
109
/** Gets the ident for a string representation of the mode .*/
110
INLINE ident        *get_irn_modeident     (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
111
/** Gets the opcode struct of the node */
112
INLINE ir_op        *get_irn_op            (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
113
/** Sets the opcode struct of the node. */
114
INLINE void          set_irn_op            (ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
115
/** Gets the opcode-enum of the node. */
116
INLINE opcode        get_irn_opcode        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
117
/** Get the string representation of the opcode. */
118
INLINE const char   *get_irn_opname        (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
119
/** Get the ident for a string representation of the opcode. */
120
121
INLINE ident        *get_irn_opident       (const ir_node *node);
INLINE unsigned long get_irn_visited (const ir_node *node);
122
INLINE void          set_irn_visited (ir_node *node, unsigned long visited);
Michael Beck's avatar
Michael Beck committed
123
/** Sets visited to get_irg_visited(current_ir_graph). */
124
INLINE void          mark_irn_visited (ir_node *node);
Michael Beck's avatar
Michael Beck committed
125
/** Returns 1 if visited < get_irg_visited(current_ir_graph).  */
126
INLINE int           irn_not_visited  (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
127
/** Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
128
INLINE int           irn_visited      (const ir_node *node);
129
INLINE void          set_irn_link          (ir_node *node, void *link);
130
INLINE void         *get_irn_link          (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
131
132

/** Outputs a unique number for this node if libfirm is compiled for
133
   debugging, (configure with --enable-debug) else returns 0. */
134
INLINE long get_irn_node_nr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
135
136

/** Returns the ir_graph this node belongs to. Only valid for
137
138
 * CallBegin, EndReg and EndExcept */
INLINE ir_graph *get_irn_irg(ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
139

Michael Beck's avatar
Michael Beck committed
140
141
142
143
144
145
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
 * If arity is negative, a node with a dynamic array is created.
 */
146
INLINE ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
147
148
new_ir_node (dbg_info *db,
	     ir_graph *irg,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
149
150
151
152
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
153
	     ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
154

Michael Beck's avatar
Michael Beck committed
155
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
156
157
158
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
159
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
160
161
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
162
163

/* this works for all except Block */
164
165
INLINE ir_node  *get_nodes_Block (ir_node *node);
INLINE void      set_nodes_Block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
166

Michael Beck's avatar
Michael Beck committed
167
/** Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
168
typedef enum {
Michael Beck's avatar
Michael Beck committed
169
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
170
			   flow. */
Michael Beck's avatar
Michael Beck committed
171
172
173
  pns_global_store,     /**< Projection on the global store */
  pns_frame_base,       /**< Projection on the frame base */
  pns_globals,          /**< Projection on the pointer to the data segment
Götz Lindenmaier's avatar
Götz Lindenmaier committed
174
			   containing _all_ global entities. */
Michael Beck's avatar
Michael Beck committed
175
  pns_args              /**< Projection on all arguments */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
176
177
} pns_number;

178
/* @@@ no more supported  */
179
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
180
int              get_Block_n_cfgpreds (ir_node *node);
181
182
183
184
185
186
INLINE ir_node  *get_Block_cfgpred (ir_node *node, int pos);
INLINE void      set_Block_cfgpred (ir_node *node, int pos, ir_node *pred);
INLINE bool      get_Block_matured (ir_node *node);
INLINE void      set_Block_matured (ir_node *node, bool matured);
INLINE unsigned long get_Block_block_visited (ir_node *node);
INLINE void      set_Block_block_visited (ir_node *node, unsigned long visit);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
187
/* For this current_ir_graph must be set. */
188
189
INLINE void      mark_Block_block_visited(ir_node *node);
INLINE int       Block_not_block_visited(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
190

191
192
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
193
194
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
195
196
197
198
void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
/* @@@ not supported */
ir_node ** get_Block_cg_cfgpred_arr(ir_node * node);
199
/* Returns the number of interproc predecessors.  0 if none. */
200
201
int get_Block_cg_n_cfgpreds(ir_node * node);
ir_node * get_Block_cg_cfgpred(ir_node * node, int pos);
202
/* frees the memory. */
203
204
void remove_Block_cg_cfgpred_arr(ir_node * node);

205
206
207
208
INLINE int  get_End_n_keepalives(ir_node *end);
INLINE ir_node *get_End_keepalive(ir_node *end, int pos);
INLINE void add_End_keepalive (ir_node *end, ir_node *ka);
INLINE void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
209
/* Some parts of the End node are allocated seperately -- their memory
210
   is not recovered by dead_node_elimination if a End node is dead.
211
   free_End frees these data structures. */
212
INLINE void free_End (ir_node *end);
213

214
215
ir_graph *get_EndReg_irg (const ir_node *end);
ir_graph *get_EndExcept_irg  (const ir_node *end);
216

217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/* We distinguish three kinds of Cond nodes.  These can be distinguished
   by the mode of the selector operand and an internal flag of type cond_kind.
   First we distinguish binary Conds and switch Conds.
   A binary Cond has as selector a boolean value.  Proj(0) projects the control
   flow for case "False", Proj(1) the control flow for "True".  A binary Cond
   is recognized by the boolean selector.
   The switch Cond has as selector an unsigned integer.  It produces as result
   an n+1 Tuple (cf0, ... , cfn) of control flows.
   We differ two flavours of this Cond.  The first, the dense Cond, passes
   control along output i if the selector value is i, 0 <= i <= n.  If the
   selector value is >n it passes control along output n.
   The second Cond flavor differes in the treatment of cases not specified in
   the source program.  It magically knows about the existence of Proj nodes.
   It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
   exists.  Else it passes control along output n (even if this Proj does not
   exist.)  This Cond we call "fragmentary".  There is a special constructor
   new_defaultProj that automatically sets the flavor.
234
235
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
236
237
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
238
239
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
240
241
242
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

243
244
245
246
INLINE ir_node  *get_Cond_selector (ir_node *node);
INLINE void      set_Cond_selector (ir_node *node, ir_node *selector);
INLINE cond_kind get_Cond_kind (ir_node *node);
INLINE void      set_Cond_kind (ir_node *node, cond_kind kind);
Christian Schäfer's avatar
Christian Schäfer committed
247

248
249
250
INLINE ir_node  *get_Return_mem (ir_node *node);
INLINE void      set_Return_mem (ir_node *node, ir_node *mem);
INLINE ir_node **get_Return_res_arr (ir_node *node);
251
INLINE int       get_Return_n_ress (ir_node *node);
252
253
INLINE ir_node  *get_Return_res (ir_node *node, int pos);
INLINE void      set_Return_res (ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
254

255
256
257
258
INLINE ir_node *get_Raise_mem (ir_node *node);
INLINE void     set_Raise_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Raise_exo_ptr (ir_node *node);  /* PoinTeR to EXception Object */
INLINE void     set_Raise_exo_ptr (ir_node *node, ir_node *exoptr);
Christian Schäfer's avatar
Christian Schäfer committed
259

260
261
INLINE tarval  *get_Const_tarval (ir_node *node);
INLINE void     set_Const_tarval (ir_node *node, tarval *con);
Christian Schäfer's avatar
Christian Schäfer committed
262

Michael Beck's avatar
Michael Beck committed
263
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
264
265
266
267
     represented by SymConst.  The content of the attribute type_or_id
     depends on this tag.  Use the proper access routine after testing
     this flag. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
268
  type_tag,          /**< The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
269
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
270
  size,              /**< The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
271
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
272
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
273
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
274
275
} symconst_kind;
typedef union type_or_id * type_or_id_p;
276
INLINE symconst_kind get_SymConst_kind (const ir_node *node);
277
INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
278
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
279
INLINE type    *get_SymConst_type (ir_node *node);
280
INLINE void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
281
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
282
283
INLINE ident   *get_SymConst_ptrinfo (ir_node *node);
INLINE void     set_SymConst_ptrinfo (ir_node *node, ident *ptrinfo);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
284
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
285
   its semantics.  Does a memcpy for the memory tori points to. */
286
287
288
289
290
291
292
293
INLINE type_or_id_p get_SymConst_type_or_id (ir_node *node);
INLINE void set_SymConst_type_or_id (ir_node *node, type_or_id_p tori);

INLINE ir_node *get_Sel_mem (ir_node *node);
INLINE void     set_Sel_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Sel_ptr (ir_node *node);  /* ptr to the object to select from */
INLINE void     set_Sel_ptr (ir_node *node, ir_node *ptr);
INLINE ir_node **get_Sel_index_arr (ir_node *node);
294
INLINE int      get_Sel_n_indexs (ir_node *node);
295
296
297
298
INLINE ir_node *get_Sel_index (ir_node *node, int pos);
INLINE void     set_Sel_index (ir_node *node, int pos, ir_node *index);
INLINE entity  *get_Sel_entity (ir_node *node); /* entity to select */
INLINE void     set_Sel_entity (ir_node *node, entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
299

300
/* @@@ ajacs specific node -- not supported */
301
302
303
304
305
306
type           *get_InstOf_ent   (ir_node *node);
void            set_InstOf_ent   (ir_node *node, type *ent);
ir_node        *get_InstOf_obj   (ir_node *node);
void            set_InstOf_obj   (ir_node *node, ir_node *obj);
ir_node        *get_InstOf_store (ir_node *node);
void            set_InstOf_store (ir_node *node, ir_node *obj);
307

308
309
310
311
312
INLINE ir_node *get_Call_mem (ir_node *node);
INLINE void     set_Call_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Call_ptr (ir_node *node);
INLINE void     set_Call_ptr (ir_node *node, ir_node *ptr);
INLINE ir_node **get_Call_param_arr (ir_node *node);
Michael Beck's avatar
Michael Beck committed
313
/** Gets the number of parameters of a call. */
314
INLINE int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
315
/** Gets the call parameter at position pos. */
316
INLINE ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
317
/** Sets the call parameter at position pos. */
318
INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
319
/** Gets the type of a call. */
320
INLINE type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
321
/** Sets the type of a call. */
322
INLINE void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
323
/** Gets the arity of a call. Identical to get_Call_n_params(). */
324
325
INLINE int      get_Call_arity (ir_node *node);

326
327
328
329
330
331
/* Set, get and remove the callee-analysis. */
int get_Call_n_callees(ir_node * node);
entity * get_Call_callee(ir_node * node, int pos);
void set_Call_callee_arr(ir_node * node, int n, entity ** arr);
void remove_Call_callee_arr(ir_node * node);

332
333
334
335
336
337
ir_node * get_CallBegin_ptr (ir_node *node);
void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
ir_graph *get_CallBegin_irg (ir_node *node);
ir_node *get_CallBegin_call (ir_node *node);
void set_CallBegin_call (ir_node *node, ir_node *call);

Christian Schäfer's avatar
Christian Schäfer committed
338
339
340
341
342
343
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
   unops are: Minus, Abs, Not, Conv
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
INLINE int      is_unop (ir_node *node);
INLINE ir_node *get_unop_op (ir_node *node);
INLINE void     set_unop_op (ir_node *node, ir_node *op);
INLINE int      is_binop (ir_node *node);
INLINE ir_node *get_binop_left (ir_node *node);
INLINE void     set_binop_left (ir_node *node, ir_node *left);
INLINE ir_node *get_binop_right (ir_node *node);
INLINE void     set_binop_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Add_left (ir_node *node);
INLINE void     set_Add_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Add_right (ir_node *node);
INLINE void     set_Add_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Sub_left (ir_node *node);
INLINE void     set_Sub_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Sub_right (ir_node *node);
INLINE void     set_Sub_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Minus_op (ir_node *node);
INLINE void     set_Minus_op (ir_node *node, ir_node *op);

INLINE ir_node *get_Mul_left (ir_node *node);
INLINE void     set_Mul_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Mul_right (ir_node *node);
INLINE void     set_Mul_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Quot_left (ir_node *node);
INLINE void     set_Quot_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Quot_right (ir_node *node);
INLINE void     set_Quot_right (ir_node *node, ir_node *right);
INLINE ir_node *get_Quot_mem (ir_node *node);
INLINE void     set_Quot_mem (ir_node *node, ir_node *mem);

INLINE ir_node *get_DivMod_left (ir_node *node);
INLINE void     set_DivMod_left (ir_node *node, ir_node *left);
INLINE ir_node *get_DivMod_right (ir_node *node);
INLINE void     set_DivMod_right (ir_node *node, ir_node *right);
INLINE ir_node *get_DivMod_mem (ir_node *node);
INLINE void     set_DivMod_mem (ir_node *node, ir_node *mem);

INLINE ir_node *get_Div_left (ir_node *node);
INLINE void     set_Div_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Div_right (ir_node *node);
INLINE void     set_Div_right (ir_node *node, ir_node *right);
INLINE ir_node *get_Div_mem (ir_node *node);
INLINE void     set_Div_mem (ir_node *node, ir_node *mem);

INLINE ir_node *get_Mod_left (ir_node *node);
INLINE void     set_Mod_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Mod_right (ir_node *node);
INLINE void     set_Mod_right (ir_node *node, ir_node *right);
INLINE ir_node *get_Mod_mem (ir_node *node);
INLINE void     set_Mod_mem (ir_node *node, ir_node *mem);

INLINE ir_node *get_Abs_op (ir_node *node);
INLINE void     set_Abs_op (ir_node *node, ir_node *op);

INLINE ir_node *get_And_left (ir_node *node);
INLINE void     set_And_left (ir_node *node, ir_node *left);
INLINE ir_node *get_And_right (ir_node *node);
INLINE void     set_And_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Or_left (ir_node *node);
INLINE void     set_Or_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Or_right (ir_node *node);
INLINE void     set_Or_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Eor_left (ir_node *node);
INLINE void     set_Eor_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Eor_right (ir_node *node);
INLINE void     set_Eor_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Not_op (ir_node *node);
INLINE void     set_Not_op (ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
419

420
INLINE const char *get_pnc_string(int pnc);
421

422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
INLINE int   get_negated_pnc(int pnc);
INLINE ir_node *get_Cmp_left (ir_node *node);
INLINE void     set_Cmp_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Cmp_right (ir_node *node);
INLINE void     set_Cmp_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Shl_left (ir_node *node);
INLINE void     set_Shl_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Shl_right (ir_node *node);
INLINE void     set_Shl_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Shr_left (ir_node *node);
INLINE void     set_Shr_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Shr_right (ir_node *node);
INLINE void     set_Shr_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Shrs_left (ir_node *node);
INLINE void     set_Shrs_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Shrs_right (ir_node *node);
INLINE void     set_Shrs_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Rot_left (ir_node *node);
INLINE void     set_Rot_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Rot_right (ir_node *node);
INLINE void     set_Rot_right (ir_node *node, ir_node *right);

INLINE ir_node *get_Conv_op (ir_node *node);
INLINE void     set_Conv_op (ir_node *node, ir_node *op);

INLINE ir_node **get_Phi_preds_arr (ir_node *node);
INLINE int       get_Phi_n_preds (ir_node *node);
INLINE ir_node  *get_Phi_pred (ir_node *node, int pos);
INLINE void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);

456
457
458
459
INLINE ir_node  *get_Filter_pred(ir_node *node);
INLINE void      set_Filter_pred(ir_node *node, ir_node *pred);
INLINE long      get_Filter_proj(ir_node *node);
INLINE void      set_Filter_proj(ir_node *node, long proj);
460
461
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
462
463
void             set_Filter_cg_pred_arr(ir_node * node, int arity, ir_node ** in);
void             set_Filter_cg_pred(ir_node * node, int pos, ir_node * pred);
464
465
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
466

467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
INLINE ir_node *get_Load_mem (ir_node *node);
INLINE void     set_Load_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Load_ptr (ir_node *node);
INLINE void     set_Load_ptr (ir_node *node, ir_node *ptr);

INLINE ir_node *get_Store_mem (ir_node *node);
INLINE void     set_Store_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Store_ptr (ir_node *node);
INLINE void     set_Store_ptr (ir_node *node, ir_node *ptr);
INLINE ir_node *get_Store_value (ir_node *node);
INLINE void     set_Store_value (ir_node *node, ir_node *value);

INLINE ir_node *get_Alloc_mem (ir_node *node);
INLINE void     set_Alloc_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Alloc_size (ir_node *node);
INLINE void     set_Alloc_size (ir_node *node, ir_node *size);
INLINE type    *get_Alloc_type (ir_node *node);
484
INLINE void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
485
486

/** allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
487
typedef enum {
Michael Beck's avatar
Michael Beck committed
488
489
  stack_alloc,          /**< Alloc allocates the object on the stack. */
  heap_alloc            /**< Alloc allocates the object on the heap. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
490
} where_alloc;
Michael Beck's avatar
Michael Beck committed
491

492
493
494
495
496
497
498
499
500
501
INLINE where_alloc  get_Alloc_where (ir_node *node);
INLINE void         set_Alloc_where (ir_node *node, where_alloc where);

INLINE ir_node *get_Free_mem (ir_node *node);
INLINE void     set_Free_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Free_ptr (ir_node *node);
INLINE void     set_Free_ptr (ir_node *node, ir_node *ptr);
INLINE ir_node *get_Free_size (ir_node *node);
INLINE void     set_Free_size (ir_node *node, ir_node *size);
INLINE type    *get_Free_type (ir_node *node);
502
INLINE void     set_Free_type (ir_node *node, type *tp);
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521

INLINE ir_node **get_Sync_preds_arr (ir_node *node);
INLINE int       get_Sync_n_preds (ir_node *node);
INLINE ir_node  *get_Sync_pred (ir_node *node, int pos);
INLINE void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);

INLINE ir_node  *get_Proj_pred (ir_node *node);
INLINE void      set_Proj_pred (ir_node *node, ir_node *pred);
INLINE long      get_Proj_proj (ir_node *node);
INLINE void      set_Proj_proj (ir_node *node, long proj);

INLINE ir_node **get_Tuple_preds_arr (ir_node *node);
INLINE int       get_Tuple_n_preds (ir_node *node);
INLINE ir_node  *get_Tuple_pred (ir_node *node, int pos);
INLINE void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);

INLINE ir_node  *get_Id_pred (ir_node *node);
INLINE void      set_Id_pred (ir_node *node, ir_node *pred);

Christian Schäfer's avatar
Christian Schäfer committed
522

Michael Beck's avatar
Michael Beck committed
523
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
524
525
526
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
527
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
528
529
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
530

Michael Beck's avatar
Michael Beck committed
531
/** returns operand of node if node is a Proj. */
532
INLINE ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
533
/** returns operand of node if node is a Id */
534
535
INLINE ir_node *skip_nop  (ir_node *node);
INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
536
537
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
538
INLINE ir_node *skip_Tuple (ir_node *node);
Michael Beck's avatar
Michael Beck committed
539
/** returns true if node is a Bad node. */
540
INLINE int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
541
/** returns true if the node is not a Block */
542
INLINE int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
543
/** returns true if the node is a Block */
544
INLINE int      is_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
545
/** returns true if node is a Proj node or a Filter node in
546
 * intraprocedural view */
547
INLINE int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
548
/** Returns true if the operation manipulates control flow:
549
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
550
int is_cfop(ir_node *node);
551

Michael Beck's avatar
Michael Beck committed
552
/** Returns true if the operation manipulates interprocedural control flow:
553
554
   CallBegin, EndReg, EndExcept */
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
555
/** Returns true if the operation can change the control flow because
556
557
   of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
   Bad. */
558
559
ir_graph *get_ip_cfop_irg(ir_node *n);

Christian Schäfer's avatar
Christian Schäfer committed
560
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
561
/** Returns the memory operand of fragile operations. */
562
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
563

Götz Lindenmaier's avatar
Götz Lindenmaier committed
564
565
#include "ident.h"

566
#ifdef __GNUC__
567
/* GNU C has the __FUNCTION__ extension */
568
569
570
571
572
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
573

Götz Lindenmaier's avatar
Götz Lindenmaier committed
574
575
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
576
577
/** Output location */
#define DDM(X)   printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
578
/** Output the firm kind of the node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
579
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (X));
580
/** Output information about a node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
581
#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), (X))
582
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
583
#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)))
584
/** Output information about a type */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
585
#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), (X))
586
/** Output information about an entity */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
587
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p\n",            __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
588
/** Output information about an entity and its owner */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
589
#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), (X))
590
/** Output information about a graph */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
591
#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), (X))
592
/** Output information about an ident */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
593
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (X))
594
/** Output information about a mode */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
595
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (X))
596
/** Output information about a loop */
597
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (X))
598
599
/** Output information about a tarVal */
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (X));
600

Michael Beck's avatar
Michael Beck committed
601
/*@}*/ /* end of ir_node group definition */
602

Götz Lindenmaier's avatar
Götz Lindenmaier committed
603

Christian Schäfer's avatar
Christian Schäfer committed
604
# endif /* _IRNODE_H_ */