irnode.h 37.5 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_

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

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

Michael Beck's avatar
Michael Beck committed
51
52
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
53
 *
Michael Beck's avatar
Michael Beck committed
54
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
55
 *
Michael Beck's avatar
Michael Beck committed
56
57
58
59
60
61
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
62
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
63
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
64
 *
Michael Beck's avatar
Michael Beck committed
65
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
66
 *
Michael Beck's avatar
Michael Beck committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 *  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
82
 */
Michael Beck's avatar
Michael Beck committed
83

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

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

Sebastian Felis's avatar
Sebastian Felis committed
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
103
is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
104

Michael Beck's avatar
Michael Beck committed
105
/** returns the number of predecessors without the block predecessor: */
106
int                  get_irn_arity         (const ir_node *node);
107
108
INLINE int           get_irn_intra_arity   (const ir_node *node);
INLINE int           get_irn_inter_arity   (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
109
110

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

/** Returns the ir_graph this node belongs to. Only valid if irg
 *  is in state pinned (irg is only stored in the block. */
INLINE ir_graph     *get_irn_irg      (ir_node *node);
Michael Beck's avatar
Michael Beck committed
163

164
/** Outputs a unique number for this node if libFIRM is compiled for
165
166
   debugging, (configure with --enable-debug) else returns address
   of node cast to long. */
167
INLINE long          get_irn_node_nr  (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
168

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

Michael Beck's avatar
Michael Beck committed
170
171
172
173
/**
 * irnode constructor.
 * Create a new irnode in irg, with an op, mode, arity and
 * some incoming irnodes.
174
175
176
177
178
179
180
181
 * This constructor is used in every specified irnode constructor.
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
 * @param arity The arity of the new node, may be <0 if yet.
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
182
 */
183
INLINE ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
184
185
new_ir_node (dbg_info *db,
	     ir_graph *irg,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
186
187
188
189
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
190
	     ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
191

Michael Beck's avatar
Michael Beck committed
192
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
193
194
195
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
196
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
197
198
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
199

Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
200
201
202
/* 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
203
INLINE ir_node  *get_nodes_Block (ir_node *node);
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
204
#define set_nodes_block set_nodes_Block
205
INLINE void      set_nodes_Block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
206

207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
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. */

/**
 * Projection numbers for result of Start node: use for Proj nodes!
 * @remark This is the old name convention, don't use anymore.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
225
typedef enum {
Michael Beck's avatar
Michael Beck committed
226
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
227
			   flow. */
Michael Beck's avatar
Michael Beck committed
228
229
230
  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
231
			     containing _all_ global entities. */
232
233
234
  pns_args,             /**< Projection on all arguments */
  pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
  			     type of this method. */
235
} pns_number; /* pns: Projection Number Start */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
236

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/** Test whether arbitrary node is frame pointer.
 *
 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 * from Start.  If so returns frame type, else Null. */
type *is_frame_pointer(ir_node *n);

/** Test whether arbitrary node is globals pointer.
 *
 * Test whether arbitrary node is globals pointer, i.e. Proj(pn_Start_P_globals)
 * from Start.  If so returns global type, else Null. */
type *is_globals_pointer(ir_node *n);

/** Test whether arbitrary node is value arg base.
 *
 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
 * from Start.   If so returns 1, else 0. */
int   is_value_arg_pointer(ir_node *n);

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

256
/* @@@ no more supported  */
257
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
258
int              get_Block_n_cfgpreds (ir_node *node);
259
260
261
262
263
264
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
265
/* For this current_ir_graph must be set. */
266
267
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
268

269
270
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
271
272
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
273
274
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);
275
/* @@@ not supported */
276
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
277
/* Returns the number of interprocedural predecessors.  0 if none. */
278
279
int       get_Block_cg_n_cfgpreds(ir_node * node);
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
280
/* frees the memory. */
281
282
void      remove_Block_cg_cfgpred_arr(ir_node * node);

283
284
/* Start references the irg it is in.
 @@@ old -- use get_irn_irg instead! */
285
ir_graph *get_Start_irg(ir_node *node);
286

287
288
289
290
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);
291
/* Some parts of the End node are allocated separately -- their memory
292
   is not recovered by dead_node_elimination if a End node is dead.
293
   free_End frees these data structures. */
294
INLINE void free_End (ir_node *end);
295

296
297
298
/* @@@ old -- use get_irn_irg instead!  */
ir_graph *get_EndReg_irg (ir_node *end);
ir_graph *get_EndExcept_irg (ir_node *end);
299

300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/* 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.
317
318
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
319
320
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
321
322
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
323
324
325
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

326
327
328
329
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
330

331
332
333
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
334
335
336
337
338
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. */

339
340
341
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);
342
INLINE int       get_Return_n_ress (ir_node *node);
343
344
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
345

346
347
348
349
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
350

351
352
353
/**
 * Projection numbers for Raise.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
354
355
356
357
358
typedef enum {
  pn_Raise_X,    /**< Execution result. */
  pn_Raise_M     /**< Memory result.    */
} pn_Raise;  /* Projection numbers for Raise. */

359
360
INLINE tarval  *get_Const_tarval (ir_node *node);
INLINE void     set_Const_tarval (ir_node *node, tarval *con);
361
362
363
364
365
/* 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
366

Michael Beck's avatar
Michael Beck committed
367
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
368
369
370
371
     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
372
  type_tag,          /**< The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
373
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
374
  size,              /**< The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
375
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
376
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
377
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
378
} symconst_kind;
379

Götz Lindenmaier's avatar
Götz Lindenmaier committed
380
typedef union type_or_id * type_or_id_p;
381
INLINE symconst_kind get_SymConst_kind (const ir_node *node);
382
INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
383
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
384
INLINE type    *get_SymConst_type (ir_node *node);
385
INLINE void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
386
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
387
388
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
389
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
390
   its semantics.  Does a memcpy for the memory tori points to. */
391
392
393
394
395
396
397
398
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);
399
INLINE int      get_Sel_n_indexs (ir_node *node);
400
401
402
403
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
404

405
406
407
408
409
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 *
 * @remark old name convention!
 */
410
411
412
413
414
415
416
417
418
419
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 */

420
421
422
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
423
424
425
426
427
428
429
430
431
432
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. */

433
434
435
436
437
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
438
/** Gets the number of parameters of a call. */
439
INLINE int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
440
/** Gets the call parameter at position pos. */
441
INLINE ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
442
/** Sets the call parameter at position pos. */
443
INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
444
/** Gets the type of a call. */
445
INLINE type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
446
/** Sets the type of a call. */
447
INLINE void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
448
/** Gets the arity of a call. Identical to get_Call_n_params(). */
449
450
INLINE int      get_Call_arity (ir_node *node);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
451
/* Set, get and remove the callee-analysis.
452
   The array is only accessible if information is valid.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
453
454
455
   It contains NULL for called methods that are not within
   the compilation unit. */
int     Call_has_callees      (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
456
457
int     get_Call_n_callees    (ir_node * node);
entity *get_Call_callee       (ir_node * node, int pos);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
458
/* assumes current_ir_graph set properly! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
459
460
void    set_Call_callee_arr   (ir_node * node, int n, entity ** arr);
void    remove_Call_callee_arr(ir_node * node);
461

Götz Lindenmaier's avatar
Götz Lindenmaier committed
462
463
ir_node  *get_CallBegin_ptr  (ir_node *node);
void      set_CallBegin_ptr  (ir_node *node, ir_node *ptr);
464
/* @@@ old -- use get_irn_irg instead!  */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
465
466
467
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);
468

469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
INLINE ir_node *get_FuncCall_ptr (ir_node *node);
INLINE void     set_FuncCall_ptr (ir_node *node, ir_node *ptr);
INLINE ir_node **get_FuncCall_param_arr (ir_node *node);
/** Gets the number of parameters of a func call. */
INLINE int      get_FuncCall_n_params (ir_node *node);
/** Gets the func call parameter at position pos. */
INLINE ir_node *get_FuncCall_param (ir_node *node, int pos);
/** Sets the func call parameter at position pos. */
INLINE void     set_FuncCall_param (ir_node *node, int pos, ir_node *param);
/** Gets the type of a func call. */
INLINE type    *get_FuncCall_type (ir_node *node);
/** Sets the type of a func call. */
INLINE void     set_FuncCall_type (ir_node *node, type *tp);
/** Gets the arity of a func call. Identical to get_FuncCall_n_params(). */
INLINE int      get_FuncCall_arity (ir_node *node);

/* Set, get and remove the callee-analysis.
   The array is only accessible if information is valid.
   It contains NULL for called methods that are not within
   the compilation unit. */
int     FuncCall_has_callees      (ir_node *node);
int     get_FuncCall_n_callees    (ir_node * node);
entity *get_FuncCall_callee       (ir_node * node, int pos);
/* assumes current_ir_graph set properly! */
void    set_FuncCall_callee_arr   (ir_node * node, int n, entity ** arr);
void    remove_FuncCall_callee_arr(ir_node * node);

Christian Schäfer's avatar
Christian Schäfer committed
496
497
498
/* 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
499
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
500
501
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
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);

536
537
538
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
539
540
typedef enum {
  pn_Quot_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
541
  pn_Quot_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
542
543
544
  pn_Quot_res          /**< Result of computation. */
} pn_Quot;  /* Projection numbers for Quot. */

545
546
547
548
549
550
551
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);

552
553
554
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
555
556
typedef enum {
  pn_DivMod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
557
  pn_DivMod_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
558
559
560
561
  pn_DivMod_res_div,     /**< Result of computation a / b. */
  pn_DivMod_res_mod      /**< Result of computation a % b. */
} pn_DivMod;  /* Projection numbers for DivMod. */

562
563
564
565
566
567
568
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);

569
570
571
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
572
573
typedef enum {
  pn_Div_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
574
  pn_Div_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
575
576
577
  pn_Div_res          /**< Result of computation. */
} pn_Div;  /* Projection numbers for Div. */

578
579
580
581
582
583
584
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);

585
586
587
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
588
589
typedef enum {
  pn_Mod_M,           /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
590
  pn_Mod_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
591
592
593
  pn_Mod_res          /**< Result of computation. */
} pn_Mod;  /* Projection numbers for Mod. */

594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
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
614

615
616
/**
 * Projection numbers for Cmp are defined several times.
617
 * The bit patterns are used for various tests, so don't change.
618
619
620
 * The "unordered" values are possible results of comparing
 * floating point numbers.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
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
641

Götz Lindenmaier's avatar
Götz Lindenmaier committed
642
643
INLINE const char *get_pnc_string(int pnc);
INLINE int         get_negated_pnc(int pnc);
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
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
672
673
/* Does Cast need a mem operator?
 * Cast should only depend on the type, not on the state of an
674
 * entity.  But:  we initialze various fields after Alloc, that
Götz Lindenmaier's avatar
comment    
Götz Lindenmaier committed
675
676
677
 * 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
678
679
680
681
682
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
683
684
/* Returns true if n is Phi or Filter in interprocedural_view. */
INLINE int       is_Phi (ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
685
/* These routines also work for Filter nodes in interprocedural view. */
686
687
688
689
690
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);

691
692
693
694
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);
695
696
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
697
698
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);
699
700
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
701

702
703
704
/**
 * Projection numbers for Load: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
705
706
typedef enum {
  pn_Load_M,         /**< Memory result.    */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
707
  pn_Load_X_except,  /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
708
709
710
  pn_Load_res        /**< Result of load operation. */
} pn_Load;  /* Projection numbers for Load. */

711
712
713
714
715
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);

716
717
718
/**
 * Projection numbers for Store: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
719
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
720
721
  pn_Store_M,         /**< Memory result.    */
  pn_Store_X_except   /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
722
723
} pn_Store;  /* Projection numbers for Store. */

724
725
726
727
728
729
730
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);

731
732
733
/**
 * Projection numbers for Alloc: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
734
735
typedef enum {
  pn_Alloc_M,    /**< Memory result. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
736
  pn_Alloc_X_except,    /**< Execution result if exception occured. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
737
738
739
  pn_Alloc_res   /**< Result of allocation. */
} pn_Alloc;  /* Projection numbers for Alloc. */

740
741
742
743
744
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);
745
INLINE void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
746

747
/** The allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
748
typedef enum {
Michael Beck's avatar
Michael Beck committed
749
750
  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
751
} where_alloc;
Michael Beck's avatar
Michael Beck committed
752

753
754
755
756
757
758
759
760
761
762
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);
763
INLINE void     set_Free_type (ir_node *node, type *tp);
764
765
766
767
768
769
770
771

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);
772
/* Why long? shouldn't int be enough, and smaller? Or even byte? */
773
774
775
776
777
778
779
780
781
782
783
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
784
785
786
787
788
789
790
791
792
/** Confirm has a single result and returns 'value' unchanged.
 *  The node expresses a restriction on 'value':
 *  'value' 'cmp' 'bound' == true.                                 */
INLINE ir_node *get_Confirm_value (ir_node *node);
INLINE void     set_Confirm_value (ir_node *node, ir_node *value);
INLINE ir_node *get_Confirm_bound (ir_node *node);
INLINE void     set_Confirm_bound (ir_node *node, ir_node *bound);
INLINE pn_Cmp   get_Confirm_cmp   (ir_node *node);
INLINE void     set_Confirm_cmp   (ir_node *node, pn_Cmp cmp);
Christian Schäfer's avatar
Christian Schäfer committed
793

Michael Beck's avatar
Michael Beck committed
794
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
795
796
797
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
798
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
799
800
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
801

Michael Beck's avatar
Michael Beck committed
802
/** returns operand of node if node is a Proj. */
803
INLINE ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
804
/** returns operand of node if node is a Id */
805
806
INLINE ir_node *skip_nop  (ir_node *node);
INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
807
808
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
809
INLINE ir_node *skip_Tuple (ir_node *node);
Michael Beck's avatar
Michael Beck committed
810
/** returns true if node is a Bad node. */
811
INLINE int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
812
/** returns true if the node is not a Block */
813
INLINE int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
814
/** returns true if the node is a Block */
815
INLINE int      is_Block (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
816
817
/** returns true if node is a Unknown node. */
INLINE int      is_Unknown (ir_node *node);
Michael Beck's avatar
Michael Beck committed
818
/** returns true if node is a Proj node or a Filter node in
819
 * intraprocedural view */
820
INLINE int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
821
/** Returns true if the operation manipulates control flow:
822
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
823
int is_cfop(ir_node *node);
824

825
826
827
/* @@@ old -- use get_irn_irg instead!  */
ir_graph *get_ip_cfop_irg(ir_node *n);

Michael Beck's avatar
Michael Beck committed
828
/** Returns true if the operation manipulates interprocedural control flow:
829
    CallBegin, EndReg, EndExcept */
830
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
831
/** Returns true if the operation can change the control flow because
832
833
    of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
    Bad. */
Christian Schäfer's avatar
Christian Schäfer committed
834
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
835
/** Returns the memory operand of fragile operations. */
836
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
837

Götz Lindenmaier's avatar
Götz Lindenmaier committed
838
839
#include "ident.h"

840
#ifdef __GNUC__
841
/* GNU C has the __FUNCTION__ extension */
842
843
844
845
846
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
847

Götz Lindenmaier's avatar
Götz Lindenmaier committed
848
849
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
850
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
851
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
852
/** Output the firm kind of the node */
853
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
854
/** Output information about a node */
855
#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))
856
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
857
#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)))
858
/** Output information about a type */
859
#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))
860
/** Output information about an entity */
861
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
862
863
/** 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))
864
/** Output information about an entity and its owner */
865
#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))
866
/** Output information about a graph */
867
#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))
868
/** Output information about an ident */
869
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
870
/** Output information about a mode */
871
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
872
/** Output information about a loop */
873
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %d\n", __MYFUNC__, __LINE__, get_loop_depth(X), get_loop_loop_nr(X))
874
/** Output information about a tarVal */
875
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
876

Michael Beck's avatar
Michael Beck committed
877
/*@}*/ /* end of ir_node group definition */
878

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

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