irnode.h 27 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 {
12
  False = 0,		/**< false */
Michael Beck's avatar
Michael Beck committed
13
14
15
16
17
18
  Eq,			/**< equal */
  Lt,			/**< less */
  Le,			/**< less or equal */
  Gt,			/**< greater */
  Ge,			/**< greater or equal */
  Lg,			/**< less or greater */
19
  Leg = 7,		/**< less, equal or greater = ordered */
Michael Beck's avatar
Michael Beck committed
20
21
22
23
24
25
26
  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 */
27
  True = 15	        /**< 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

Sebastian Felis's avatar
Sebastian Felis committed
85
86
87
88
89
90
91
92
93
94
95
/**
 *   Checks whether a pointer points to a ir node.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is a ir mode, else false
 */
int
is_ir_node (void *thing);

Michael Beck's avatar
Michael Beck committed
96
/** returns the number of predecessors without the block predecessor: */
97
int                  get_irn_arity         (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
98
99

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

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

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

Michael Beck's avatar
Michael Beck committed
153
154
155
156
157
158
/**
 * 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.
 */
159
INLINE ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
160
161
new_ir_node (dbg_info *db,
	     ir_graph *irg,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
162
163
164
165
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
166
	     ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
167

Michael Beck's avatar
Michael Beck committed
168
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
169
170
171
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
172
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
173
174
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
175
176

/* this works for all except Block */
177
178
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
179

Michael Beck's avatar
Michael Beck committed
180
/** Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
181
typedef enum {
Michael Beck's avatar
Michael Beck committed
182
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
183
			   flow. */
Michael Beck's avatar
Michael Beck committed
184
185
186
  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
187
			   containing _all_ global entities. */
188
189
190
  pns_args,             /**< Projection on all arguments */
  pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
  			     type of this method. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
191
192
} pns_number;

193
/* @@@ no more supported  */
194
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
195
int              get_Block_n_cfgpreds (ir_node *node);
196
197
198
199
200
201
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
202
/* For this current_ir_graph must be set. */
203
204
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
205

206
207
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
208
209
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
210
211
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);
212
/* @@@ not supported */
213
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
214
/* Returns the number of interproc predecessors.  0 if none. */
215
216
int       get_Block_cg_n_cfgpreds(ir_node * node);
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
217
/* frees the memory. */
218
219
220
221
222
void      remove_Block_cg_cfgpred_arr(ir_node * node);

/* Start references the irg it is in. */
ir_graph *get_Start_irg(ir_node *node);
void      set_Start_irg(ir_node *node, ir_graph *irg);
223

224
225
226
227
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);
228
/* Some parts of the End node are allocated seperately -- their memory
229
   is not recovered by dead_node_elimination if a End node is dead.
230
   free_End frees these data structures. */
231
INLINE void free_End (ir_node *end);
232

233
234
ir_graph *get_EndReg_irg (const ir_node *end);
ir_graph *get_EndExcept_irg  (const ir_node *end);
235

236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/* 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.
253
254
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
255
256
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
257
258
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
259
260
261
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

262
263
264
265
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
266

267
268
269
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);
270
INLINE int       get_Return_n_ress (ir_node *node);
271
272
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
273

274
275
276
277
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
278

279
280
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
281

Michael Beck's avatar
Michael Beck committed
282
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
283
284
285
286
     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
287
  type_tag,          /**< The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
288
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
289
  size,              /**< The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
290
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
291
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
292
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
293
294
} symconst_kind;
typedef union type_or_id * type_or_id_p;
295
INLINE symconst_kind get_SymConst_kind (const ir_node *node);
296
INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
297
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
298
INLINE type    *get_SymConst_type (ir_node *node);
299
INLINE void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
300
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
301
302
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
303
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
304
   its semantics.  Does a memcpy for the memory tori points to. */
305
306
307
308
309
310
311
312
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);
313
INLINE int      get_Sel_n_indexs (ir_node *node);
314
315
316
317
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
318

319
/* @@@ ajacs specific node -- not supported */
320
321
322
323
324
325
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);
326

327
328
329
330
331
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
332
/** Gets the number of parameters of a call. */
333
INLINE int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
334
/** Gets the call parameter at position pos. */
335
INLINE ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
336
/** Sets the call parameter at position pos. */
337
INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
338
/** Gets the type of a call. */
339
INLINE type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
340
/** Sets the type of a call. */
341
INLINE void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
342
/** Gets the arity of a call. Identical to get_Call_n_params(). */
343
344
INLINE int      get_Call_arity (ir_node *node);

345
346
347
348
349
350
/* 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);

351
352
353
354
355
356
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
357
358
359
/* 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.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
360
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
361
362
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
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
438

439
INLINE const char *get_pnc_string(int pnc);
440

441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
470
471
472
473
474
INLINE ir_node *get_Cast_op (ir_node *node);
INLINE void     set_Cast_op (ir_node *node, ir_node *op);
INLINE type    *get_Cast_type (ir_node *node);
INLINE void     set_Cast_type (ir_node *node, type *to_tp);

475
476
477
478
479
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);

480
481
482
483
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);
484
485
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
486
487
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);
488
489
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
490

491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
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);
508
INLINE void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
509
510

/** allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
511
typedef enum {
Michael Beck's avatar
Michael Beck committed
512
513
  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
514
} where_alloc;
Michael Beck's avatar
Michael Beck committed
515

516
517
518
519
520
521
522
523
524
525
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);
526
INLINE void     set_Free_type (ir_node *node, type *tp);
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545

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
546

Michael Beck's avatar
Michael Beck committed
547
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
548
549
550
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
551
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
552
553
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
554

Michael Beck's avatar
Michael Beck committed
555
/** returns operand of node if node is a Proj. */
556
INLINE ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
557
/** returns operand of node if node is a Id */
558
559
INLINE ir_node *skip_nop  (ir_node *node);
INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
560
561
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
562
INLINE ir_node *skip_Tuple (ir_node *node);
Michael Beck's avatar
Michael Beck committed
563
/** returns true if node is a Bad node. */
564
INLINE int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
565
/** returns true if the node is not a Block */
566
INLINE int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
567
/** returns true if the node is a Block */
568
INLINE int      is_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
569
/** returns true if node is a Proj node or a Filter node in
570
 * intraprocedural view */
571
INLINE int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
572
/** Returns true if the operation manipulates control flow:
573
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
574
int is_cfop(ir_node *node);
575

Michael Beck's avatar
Michael Beck committed
576
/** Returns true if the operation manipulates interprocedural control flow:
577
578
   CallBegin, EndReg, EndExcept */
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
579
/** Returns true if the operation can change the control flow because
580
581
   of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
   Bad. */
582
583
ir_graph *get_ip_cfop_irg(ir_node *n);

Christian Schäfer's avatar
Christian Schäfer committed
584
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
585
/** Returns the memory operand of fragile operations. */
586
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
587

Götz Lindenmaier's avatar
Götz Lindenmaier committed
588
589
#include "ident.h"

590
#ifdef __GNUC__
591
/* GNU C has the __FUNCTION__ extension */
592
593
594
595
596
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
597

Götz Lindenmaier's avatar
Götz Lindenmaier committed
598
599
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
600
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
601
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
602
/** Output the firm kind of the node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
603
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (X));
604
/** Output information about a node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
605
#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))
606
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
607
#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)))
608
/** Output information about a type */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
609
#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))
610
/** Output information about an entity */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
611
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
612
/** Output information about an entity and its owner */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
613
#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))
614
/** Output information about a graph */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
615
#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))
616
/** Output information about an ident */
617
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_id_str(X), (X))
618
/** Output information about a mode */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
619
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (X))
620
/** Output information about a loop */
621
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (X))
622
623
/** Output information about a tarVal */
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (X));
624

Michael Beck's avatar
Michael Beck committed
625
/*@}*/ /* end of ir_node group definition */
626

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

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