irnode.h 33 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
2
3
4
5
6
7
8
9
10
/*
 * Project:     libFIRM
 * File name:   ir/ir/irnode.h
 * Purpose:     Representation of an intermediate operation.
 * Author:      Martin Trapp, Christian Schaefer
 * Modified by: Goetz Lindenmaier
 * Created:
 * CVS-ID:      $Id$
 * Copyright:   (c) 1998-2003 Universität Karlsruhe
 * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
Michael Beck's avatar
Michael Beck committed
11
12
 */

Christian Schäfer's avatar
Christian Schäfer committed
13
14
15
# ifndef _IRNODE_H_
# define _IRNODE_H_

Michael Beck's avatar
Michael Beck committed
16
/** Projection numbers of compare: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
17
/* @@@ there are numbers with normalized names below! */
18
typedef enum {
19
  False = 0,		/**< false */
Michael Beck's avatar
Michael Beck committed
20
21
22
23
24
25
  Eq,			/**< equal */
  Lt,			/**< less */
  Le,			/**< less or equal */
  Gt,			/**< greater */
  Ge,			/**< greater or equal */
  Lg,			/**< less or greater */
26
  Leg = 7,		/**< less, equal or greater = ordered */
Michael Beck's avatar
Michael Beck committed
27
28
29
30
31
32
33
  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 */
34
  True = 15	        /**< true */
35
  /* not_mask = Leg*/	/* bits to flip to negate comparison * @@ hack for jni interface */
36
} pnc_number;   /* pnc: Projection Number Cmp */
37
38
39
#define not_mask Leg

# include "tv.h"
Christian Schäfer's avatar
Christian Schäfer committed
40
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
41
# include "entity.h"
42
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
43
44
45
# include "irop.h"
# include "irmode.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
46
# include "dbginfo.h"
47
//# include "exc.h"
Christian Schäfer's avatar
Christian Schäfer committed
48

Michael Beck's avatar
Michael Beck committed
49
50
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
51
 *
Michael Beck's avatar
Michael Beck committed
52
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
53
 *
Michael Beck's avatar
Michael Beck committed
54
55
56
57
58
59
60
61
 * 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
62
 *
Michael Beck's avatar
Michael Beck committed
63
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
64
 *
Michael Beck's avatar
Michael Beck committed
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 *  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
80
 */
Michael Beck's avatar
Michael Beck committed
81

Götz Lindenmaier's avatar
Götz Lindenmaier committed
82
83
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
84
85
86
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
87
/**
Michael Beck's avatar
Michael Beck committed
88
89
90
 *   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
91

Sebastian Felis's avatar
Sebastian Felis committed
92
93
94
95
96
97
98
99
100
101
102
/**
 *   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
103
/** returns the number of predecessors without the block predecessor: */
104
int                  get_irn_arity         (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
105
106

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

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

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

Michael Beck's avatar
Michael Beck committed
160
161
162
163
164
165
/**
 * 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.
 */
166
INLINE ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
167
168
new_ir_node (dbg_info *db,
	     ir_graph *irg,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
169
170
171
172
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
173
	     ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
174

Michael Beck's avatar
Michael Beck committed
175
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
176
177
178
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
179
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
180
181
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
182

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
183
184
185
/* This works for all except Block.  To express the difference to
 * access routines that work for all nodes we use infix "nodes". */
#define get_nodes_block get_nodes_Block
186
INLINE ir_node  *get_nodes_Block (ir_node *node);
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
187
#define set_nodes_block set_nodes_Block
188
INLINE void      set_nodes_Block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
189

Michael Beck's avatar
Michael Beck committed
190
/** Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
191
/* @@@ old name convention! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
192
typedef enum {
Michael Beck's avatar
Michael Beck committed
193
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
194
			   flow. */
Michael Beck's avatar
Michael Beck committed
195
196
197
  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
comment    
Götz Lindenmaier committed
198
			     containing _all_ global entities. */
199
200
201
  pns_args,             /**< Projection on all arguments */
  pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
  			     type of this method. */
202
} pns_number; /* pns: Projection Number Start */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
203
204
205
206
207
208
209
210
211
212
213
typedef enum {
  pn_Start_X_initial_exec,  /**< Projection on the initial control flow. */
  pn_Start_M,               /**< Projection on the initial memory. */
  pn_Start_P_frame_base,    /**< Projection on the frame base pointer. */
  pn_Start_P_globals,       /**< Projection on the pointer to the data segment
			       containing _all_ global entities. */
  pn_Start_T_args,          /**< Projection on all arguments. */
  pn_Start_P_value_arg_base /**< Pointer to region of compound value arguments as defined by
			       type of this method. */
} pn_Start; /* Projection numbers for Start. */

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

215
/* @@@ no more supported  */
216
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
217
int              get_Block_n_cfgpreds (ir_node *node);
218
219
220
221
222
223
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
224
/* For this current_ir_graph must be set. */
225
226
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
227

228
229
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
230
231
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
232
233
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);
234
/* @@@ not supported */
235
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
236
/* Returns the number of interproc predecessors.  0 if none. */
237
238
int       get_Block_cg_n_cfgpreds(ir_node * node);
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
239
/* frees the memory. */
240
241
242
243
244
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);
245

246
247
248
249
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);
250
/* Some parts of the End node are allocated seperately -- their memory
251
   is not recovered by dead_node_elimination if a End node is dead.
252
   free_End frees these data structures. */
253
INLINE void free_End (ir_node *end);
254

255
256
ir_graph *get_EndReg_irg (const ir_node *end);
ir_graph *get_EndExcept_irg  (const ir_node *end);
257

258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/* 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.
275
276
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
277
278
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
279
280
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
281
282
283
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

284
285
286
287
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
288

Götz Lindenmaier's avatar
Götz Lindenmaier committed
289
290
291
292
293
typedef enum {
  pn_Cond_false,    /**< Control flow if operand is "false". */
  pn_Cond_true      /**< Control flow if operand is "true".  */
} pn_Cond;  /* Projection numbers for Cond. */

294
295
296
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);
297
INLINE int       get_Return_n_ress (ir_node *node);
298
299
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
300

301
302
303
304
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
305

Götz Lindenmaier's avatar
Götz Lindenmaier committed
306
307
308
309
310
typedef enum {
  pn_Raise_X,    /**< Execution result. */
  pn_Raise_M     /**< Memory result.    */
} pn_Raise;  /* Projection numbers for Raise. */

311
312
INLINE tarval  *get_Const_tarval (ir_node *node);
INLINE void     set_Const_tarval (ir_node *node, tarval *con);
313
314
315
316
317
/* The source language type.  Must be an atomic type.  Mode of type must
   be mode of node. For tarvals from entities type must be pointer to
   entity type. */
INLINE type    *get_Const_type   (ir_node *node);
INLINE void     set_Const_type   (ir_node *node, type *tp);
Christian Schäfer's avatar
Christian Schäfer committed
318

Michael Beck's avatar
Michael Beck committed
319
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
320
321
322
323
     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
324
  type_tag,          /**< The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
325
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
326
  size,              /**< The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
327
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
328
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
329
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
330
331
} symconst_kind;
typedef union type_or_id * type_or_id_p;
332
INLINE symconst_kind get_SymConst_kind (const ir_node *node);
333
INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
334
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
335
INLINE type    *get_SymConst_type (ir_node *node);
336
INLINE void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
337
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
338
339
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
340
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
341
   its semantics.  Does a memcpy for the memory tori points to. */
342
343
344
345
346
347
348
349
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);
350
INLINE int      get_Sel_n_indexs (ir_node *node);
351
352
353
354
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
355

356
/** Projection numbers for result of Call node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
357
/* @@@ old name convention! */
358
359
360
361
362
363
364
365
366
367
typedef enum {
  pncl_memory = 0,        /**< The memory result. */
  pncl_exc_target = 1,    /**< The control flow result branching to the exception handler */
  pncl_result_tuple = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
  pncl_exc_memory = 3,    /**< The memory result in case the called method terminated with
			      an exception */
  pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
			      passed by value (for compound result types). */
} pncl_number;   /* pncl: Projection Number CaLl */

Götz Lindenmaier's avatar
Götz Lindenmaier committed
368
369
370
371
372
373
374
375
376
377
typedef enum {
  pn_Call_M_regular = 0,  /**< The memory result. */
  pn_Call_T_result  = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
  pn_Call_P_value_res_base = 4,/**< A pointer to the memory region containing copied results
			     passed by value (for compound result types). */
  pn_Call_X_except  = 1,  /**< The control flow result branching to the exception handler */
  pn_Call_M_except  = 3   /**< The memory result in case the called method terminated with
			     an exception */
} pn_Call;   /* Projection numbers for Call. */

378
379
380
381
382
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
383
/** Gets the number of parameters of a call. */
384
INLINE int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
385
/** Gets the call parameter at position pos. */
386
INLINE ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
387
/** Sets the call parameter at position pos. */
388
INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
389
/** Gets the type of a call. */
390
INLINE type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
391
/** Sets the type of a call. */
392
INLINE void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
393
/** Gets the arity of a call. Identical to get_Call_n_params(). */
394
395
INLINE int      get_Call_arity (ir_node *node);

396
/* Set, get and remove the callee-analysis. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
397
398
399
400
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);
401

Götz Lindenmaier's avatar
Götz Lindenmaier committed
402
403
404
405
406
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);
407

Christian Schäfer's avatar
Christian Schäfer committed
408
409
410
/* 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
411
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
412
413
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
414
415
416
417
418
419
420
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
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
448
449
450
451
452
453
typedef enum {
  pn_Quot_X_except,    /**< Execution result if exception occured. */
  pn_Quot_M,           /**< Memory result.    */
  pn_Quot_res          /**< Result of computation. */
} pn_Quot;  /* Projection numbers for Quot. */

454
455
456
457
458
459
460
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
461
462
463
464
465
466
467
typedef enum {
  pn_DivMod_X_except,    /**< Execution result if exception occured. */
  pn_DivMod_M,           /**< Memory result.    */
  pn_DivMod_res_div,     /**< Result of computation a / b. */
  pn_DivMod_res_mod      /**< Result of computation a % b. */
} pn_DivMod;  /* Projection numbers for DivMod. */

468
469
470
471
472
473
474
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
475
476
477
478
479
480
typedef enum {
  pn_Div_X_except,    /**< Execution result if exception occured. */
  pn_Div_M,           /**< Memory result.    */
  pn_Div_res          /**< Result of computation. */
} pn_Div;  /* Projection numbers for Div. */

481
482
483
484
485
486
487
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
488
489
490
491
492
493
typedef enum {
  pn_Mod_X_except,    /**< Execution result if exception occured. */
  pn_Mod_M,           /**< Memory result.    */
  pn_Mod_res          /**< Result of computation. */
} pn_Mod;  /* Projection numbers for Mod. */

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
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
514

Götz Lindenmaier's avatar
Götz Lindenmaier committed
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
/* Projection numbers for Cmp are defined several times.
   The bit patterns are used for variouse tests, so don't change.
   The "unordered" values are possible results of comparing
   floating point numbers. */
typedef enum {
  pn_Cmp_False = 0,   /**< false */
  pn_Cmp_Eq,	      /**< equal */
  pn_Cmp_Lt,	      /**< less */
  pn_Cmp_Le,	      /**< less or equal */
  pn_Cmp_Gt,	      /**< greater */
  pn_Cmp_Ge,	      /**< greater or equal */
  pn_Cmp_Lg,	      /**< less or greater */
  pn_Cmp_Leg = 7,     /**< less, equal or greater = ordered */
  pn_Cmp_Uo,	      /**< unordered */
  pn_Cmp_Ue,	      /**< unordered or equal */
  pn_Cmp_Ul,	      /**< unordered or less */
  pn_Cmp_Ule,	      /**< unordered, less or equal */
  pn_Cmp_Ug,	      /**< unordered or greater */
  pn_Cmp_Uge,	      /**< unordered, greater or equal */
  pn_Cmp_Ne,	      /**< unordered, less or greater = not equal */
  pn_Cmp_True = 15    /**< true */
  /* not_mask = Leg*/	/* bits to flip to negate comparison * @@ hack for jni interface */
} pn_Cmp;   /* Projection numbers for Cmp */
//#define not_mask pn_Cmp_Leg
539

Götz Lindenmaier's avatar
Götz Lindenmaier committed
540
541
INLINE const char *get_pnc_string(int pnc);
INLINE int         get_negated_pnc(int pnc);
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
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
comment    
Götz Lindenmaier committed
570
571
572
573
574
575
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
 * entity.  But:  we initialzie various fields after Alloc, that
 * are accessed in the cast.  This required some precaution, to
 * get the right memory into the Loads generated from the cast.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
576
577
578
579
580
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);

581
582
583
584
585
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);

586
587
588
589
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);
590
591
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
592
593
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);
594
595
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
596

Götz Lindenmaier's avatar
Götz Lindenmaier committed
597
598
599
600
601
602
typedef enum {
  pn_Load_X_except,  /**< Execution result if exception occured. */
  pn_Load_M,         /**< Memory result.    */
  pn_Load_res        /**< Result of load operation. */
} pn_Load;  /* Projection numbers for Load. */

603
604
605
606
607
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
608
609
610
611
612
typedef enum {
  pn_Store_X_except,  /**< Execution result if exception occured. */
  pn_Store_M          /**< Memory result.    */
} pn_Store;  /* Projection numbers for Store. */

613
614
615
616
617
618
619
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
620
621
622
623
624
625
typedef enum {
  pn_Alloc_X,    /**< Execution result if exception occured. */
  pn_Alloc_M,    /**< Memory result. */
  pn_Alloc_res   /**< Result of allocation. */
} pn_Alloc;  /* Projection numbers for Alloc. */

626
627
628
629
630
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);
631
INLINE void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
632
633

/** allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
634
typedef enum {
Michael Beck's avatar
Michael Beck committed
635
636
  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
637
} where_alloc;
Michael Beck's avatar
Michael Beck committed
638

639
640
641
642
643
644
645
646
647
648
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);
649
INLINE void     set_Free_type (ir_node *node, type *tp);
650
651
652
653
654
655
656
657

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);
658
/* Why long? shouldn't int be enough, and smaller? Or even byte? */
659
660
661
662
663
664
665
666
667
668
669
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
670

Michael Beck's avatar
Michael Beck committed
671
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
672
673
674
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
675
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
676
677
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
678

Michael Beck's avatar
Michael Beck committed
679
/** returns operand of node if node is a Proj. */
680
INLINE ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
681
/** returns operand of node if node is a Id */
682
683
INLINE ir_node *skip_nop  (ir_node *node);
INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
684
685
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
686
INLINE ir_node *skip_Tuple (ir_node *node);
Michael Beck's avatar
Michael Beck committed
687
/** returns true if node is a Bad node. */
688
INLINE int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
689
/** returns true if the node is not a Block */
690
INLINE int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
691
/** returns true if the node is a Block */
692
INLINE int      is_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
693
/** returns true if node is a Proj node or a Filter node in
694
 * intraprocedural view */
695
INLINE int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
696
/** Returns true if the operation manipulates control flow:
697
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
698
int is_cfop(ir_node *node);
699

Michael Beck's avatar
Michael Beck committed
700
/** Returns true if the operation manipulates interprocedural control flow:
701
702
   CallBegin, EndReg, EndExcept */
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
703
/** Returns true if the operation can change the control flow because
704
705
   of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
   Bad. */
706
707
ir_graph *get_ip_cfop_irg(ir_node *n);

Christian Schäfer's avatar
Christian Schäfer committed
708
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
709
/** Returns the memory operand of fragile operations. */
710
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
711

Götz Lindenmaier's avatar
Götz Lindenmaier committed
712
713
#include "ident.h"

714
#ifdef __GNUC__
715
/* GNU C has the __FUNCTION__ extension */
716
717
718
719
720
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
721

Götz Lindenmaier's avatar
Götz Lindenmaier committed
722
723
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
724
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
725
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
726
/** Output the firm kind of the node */
727
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
728
/** Output information about a node */
729
#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))
730
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
731
#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)))
732
/** Output information about a type */
733
#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))
734
/** Output information about an entity */
735
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
736
737
/** Output information about an entity and its type */
#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))
738
/** Output information about an entity and its owner */
739
#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))
740
/** Output information about a graph */
741
#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))
742
/** Output information about an ident */
743
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
744
/** Output information about a mode */
745
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
746
/** Output information about a loop */
747
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
748
/** Output information about a tarVal */
749
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
750

Michael Beck's avatar
Michael Beck committed
751
/*@}*/ /* end of ir_node group definition */
752

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

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