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

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

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

Christian Schäfer's avatar
Christian Schäfer committed
10
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
11
# include "entity.h"
12
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
13
14
15
16
# include "irop.h"
# include "irmode.h"
# include "tv.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
17
# include "dbginfo.h"
18
# include "exc.h"
Christian Schäfer's avatar
Christian Schäfer committed
19

Michael Beck's avatar
Michael Beck committed
20
21
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
22
 *
Michael Beck's avatar
Michael Beck committed
23
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
24
 *
Michael Beck's avatar
Michael Beck committed
25
26
27
28
29
30
31
32
 * 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
33
 *
Michael Beck's avatar
Michael Beck committed
34
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
35
 *
Michael Beck's avatar
Michael Beck committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 *  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
51
 */
Michael Beck's avatar
Michael Beck committed
52

Götz Lindenmaier's avatar
Götz Lindenmaier committed
53
54
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
55
56
57
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
58
/**
Michael Beck's avatar
Michael Beck committed
59
60
61
 *   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
62

Michael Beck's avatar
Michael Beck committed
63
/** returns the number of predecessors without the block predecessor: */
Christian Schäfer's avatar
Christian Schäfer committed
64
int                  get_irn_arity         (ir_node *node);
Michael Beck's avatar
Michael Beck committed
65
66

/** Replaces the old in array by a new one that will contain the ins given in
67
   the parameters.  Conserves the block predecessor.  It copies the array passed.
68
   This function is necessary to ajust in arrays of blocks, calls and phis.
69
   Assumes that current_ir_graph is set to the graph containing "node".
70
71
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
72
INLINE void          set_irn_in            (ir_node *node, int arity,
73
					    ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
74
75
76
/* 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
77
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
78
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
79
/* Access predecessor n */
80
/* get_irn_n removes Id predecessors. */
81
82
INLINE ir_node      *get_irn_n             (ir_node *node, int n);
INLINE void          set_irn_n             (ir_node *node, int n, ir_node *in);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
83
/* Get the mode struct. */
84
INLINE ir_mode      *get_irn_mode          (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
85
/* Get the mode-enum modecode */
86
INLINE modecode      get_irn_modecode      (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
87
/* Get the ident for a string representation of the mode */
88
INLINE ident        *get_irn_modeident     (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
89
/* Access the opcode struct of the node */
90
91
INLINE ir_op        *get_irn_op            (ir_node *node);
INLINE void          set_irn_op            (ir_node *node, ir_op *op);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
92
/* Get the opcode-enum of the node */
93
INLINE opcode        get_irn_opcode        (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
94
/* Get the ident for a string representation of the opcode */
95
INLINE ident        *get_irn_opident       (ir_node *node);
96
/* Get the string representation of the opcode */
97
98
99
INLINE const char   *get_irn_opname        (ir_node *node);
INLINE void          set_irn_visited (ir_node *node, unsigned long visited);
INLINE unsigned long get_irn_visited (ir_node *node);
100
/* Sets visited to get_irg_visited(current_ir_graph) */
101
INLINE void          mark_irn_visited (ir_node *node);
102
/* Returns 1 if visited < get_irg_visited(current_ir_graph).  */
103
INLINE int           irn_not_visited  (ir_node *node);
104
105
/* Returns 1 if visited >= get_irg_visited(current_ir_graph).  */
INLINE int           irn_visited      (ir_node *node);
106
107
INLINE void          set_irn_link          (ir_node *node, void *link);
INLINE void         *get_irn_link          (ir_node *node);
Michael Beck's avatar
Michael Beck committed
108
109

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

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

Michael Beck's avatar
Michael Beck committed
117
118
119
120
121
122
/**
 * 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.
 */
123
INLINE ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
124
125
new_ir_node (dbg_info *db,
	     ir_graph *irg,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
126
127
128
129
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
130
	     ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
131

Michael Beck's avatar
Michael Beck committed
132
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
133
134
135
 *
 * NAME access functions for node fields.
 *
Sebastian Felis's avatar
Sebastian Felis committed
136
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
137
138
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
139
140

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

Michael Beck's avatar
Michael Beck committed
144
/** Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
145
typedef enum {
Michael Beck's avatar
Michael Beck committed
146
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
147
			   flow. */
Michael Beck's avatar
Michael Beck committed
148
149
150
  pns_global_store,     /**< Projection on the global store */
  pns_frame_base,       /**< Projection on the frame base */
  pns_globals,          /**< Projection on the pointer to the data segment
Götz Lindenmaier's avatar
Götz Lindenmaier committed
151
			   containing _all_ global entities. */
Michael Beck's avatar
Michael Beck committed
152
  pns_args              /**< Projection on all arguments */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
153
154
} pns_number;

155
/* @@@ no more supported  */
156
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
157
int              get_Block_n_cfgpreds (ir_node *node);
158
159
160
161
162
163
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
164
/* For this current_ir_graph must be set. */
165
166
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
167

168
169
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
170
171
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
172
173
174
175
void set_Block_cg_cfgpred_arr(ir_node * node, int arity, ir_node ** in);
void set_Block_cg_cfgpred(ir_node * node, int pos, ir_node * pred);
/* @@@ not supported */
ir_node ** get_Block_cg_cfgpred_arr(ir_node * node);
176
/* Returns the number of interproc predecessors.  0 if none. */
177
178
int get_Block_cg_n_cfgpreds(ir_node * node);
ir_node * get_Block_cg_cfgpred(ir_node * node, int pos);
179
/* frees the memory. */
180
181
void remove_Block_cg_cfgpred_arr(ir_node * node);

182
183
184
185
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);
186
/* Some parts of the End node are allocated seperately -- their memory
187
   is not recovered by dead_node_elimination if a End node is dead.
188
   free_End frees these data structures. */
189
INLINE void free_End (ir_node *end);
190

191
192
193
ir_graph *get_EndReg_irg (ir_node *end);
ir_graph *get_EndExcept_irg  (ir_node *end);

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/* 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.
211
212
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
213
214
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
215
216
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
217
218
219
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

220
221
222
223
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
224

225
226
227
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);
228
INLINE int       get_Return_n_ress (ir_node *node);
229
230
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
231

232
233
234
235
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
236

237
238
INLINE tarval  *get_Const_tarval (ir_node *node);
INLINE void     set_Const_tarval (ir_node *node, tarval *con);
Christian Schäfer's avatar
Christian Schäfer committed
239

Michael Beck's avatar
Michael Beck committed
240
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
241
242
243
244
     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
245
  type_tag,          /**< The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
246
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
247
  size,              /**< The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
248
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
249
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
250
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
251
252
} symconst_kind;
typedef union type_or_id * type_or_id_p;
253
254
INLINE symconst_kind get_SymConst_kind (ir_node *node);
INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
255
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
256
INLINE type    *get_SymConst_type (ir_node *node);
257
INLINE void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
258
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
259
260
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
261
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
262
   its semantics.  Does a memcpy for the memory tori points to. */
263
264
265
266
267
268
269
270
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);
271
INLINE int      get_Sel_n_indexs (ir_node *node);
272
273
274
275
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
276

277
/* @@@ ajacs specific node -- not supported */
278
279
280
281
282
283
type           *get_InstOf_ent   (ir_node *node);
void            set_InstOf_ent   (ir_node *node, type *ent);
ir_node        *get_InstOf_obj   (ir_node *node);
void            set_InstOf_obj   (ir_node *node, ir_node *obj);
ir_node        *get_InstOf_store (ir_node *node);
void            set_InstOf_store (ir_node *node, ir_node *obj);
284

285
286
287
288
289
290
291
292
293
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);
INLINE int      get_Call_n_params (ir_node *node);
INLINE ir_node *get_Call_param (ir_node *node, int pos);
INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
INLINE type    *get_Call_type (ir_node *node);
294
INLINE void     set_Call_type (ir_node *node, type *tp);
295
296
INLINE int      get_Call_arity (ir_node *node);

297
298
299
300
301
302
/* Set, get and remove the callee-analysis. */
int get_Call_n_callees(ir_node * node);
entity * get_Call_callee(ir_node * node, int pos);
void set_Call_callee_arr(ir_node * node, int n, entity ** arr);
void remove_Call_callee_arr(ir_node * node);

303
304
305
306
307
308
ir_node * get_CallBegin_ptr (ir_node *node);
void set_CallBegin_ptr (ir_node *node, ir_node *ptr);
ir_graph *get_CallBegin_irg (ir_node *node);
ir_node *get_CallBegin_call (ir_node *node);
void set_CallBegin_call (ir_node *node, ir_node *call);

Christian Schäfer's avatar
Christian Schäfer committed
309
310
311
312
313
314
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
   unops are: Minus, Abs, Not, Conv
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
INLINE int      is_unop (ir_node *node);
INLINE ir_node *get_unop_op (ir_node *node);
INLINE void     set_unop_op (ir_node *node, ir_node *op);
INLINE int      is_binop (ir_node *node);
INLINE ir_node *get_binop_left (ir_node *node);
INLINE void     set_binop_left (ir_node *node, ir_node *left);
INLINE ir_node *get_binop_right (ir_node *node);
INLINE void     set_binop_right (ir_node *node, ir_node *right);

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

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

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

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

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

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

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

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

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
391
/** Projection numbers of compare: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
392
typedef enum {
Michael Beck's avatar
Michael Beck committed
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
  False,		/**< false */
  Eq,			/**< equal */
  Lt,			/**< less */
  Le,			/**< less or equal */
  Gt,			/**< greater */
  Ge,			/**< greater or equal */
  Lg,			/**< less or greater */
  Leg,			/**< less, equal or greater = ordered */
  Uo,			/**< unordered */
  Ue,			/**< unordered or equal */
  Ul,			/**< unordered or less */
  Ule,			/**< unordered, less or equal */
  Ug,			/**< unordered or greater */
  Uge,			/**< unordered, greater or equal */
  Ne,			/**< unordered, less or greater = not equal */
  True		        /**< true */
Boris Boesler's avatar
Boris Boesler committed
409
  /* not_mask = Leg*/	/* bits to flip to negate comparison * @@ hack for jni interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
410
} pnc_number;
411
#define not_mask Leg
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
INLINE char *get_pnc_string(int pnc);
INLINE int   get_negated_pnc(int pnc);
INLINE ir_node *get_Cmp_left (ir_node *node);
INLINE void     set_Cmp_left (ir_node *node, ir_node *left);
INLINE ir_node *get_Cmp_right (ir_node *node);
INLINE void     set_Cmp_right (ir_node *node, ir_node *right);

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

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

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

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

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

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

447
448
449
450
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);
451
452
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
453
454
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);
455
456
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
457

458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
INLINE ir_node *get_Load_mem (ir_node *node);
INLINE void     set_Load_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Load_ptr (ir_node *node);
INLINE void     set_Load_ptr (ir_node *node, ir_node *ptr);

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

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

/** allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
478
typedef enum {
Michael Beck's avatar
Michael Beck committed
479
480
  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
481
} where_alloc;
Michael Beck's avatar
Michael Beck committed
482

483
484
485
486
487
488
489
490
491
492
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);
493
INLINE void     set_Free_type (ir_node *node, type *tp);
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512

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

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

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

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

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

Michael Beck's avatar
Michael Beck committed
514
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
515
516
517
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
518
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
519
520
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
521

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

Michael Beck's avatar
Michael Beck committed
543
/** Returns true if the operation manipulates interprocedural control flow:
544
545
   CallBegin, EndReg, EndExcept */
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
546
/** Returns true if the operation can change the control flow because
547
548
   of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
   Bad. */
549
550
ir_graph *get_ip_cfop_irg(ir_node *n);

Christian Schäfer's avatar
Christian Schäfer committed
551
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
552
/** Returns the memory operand of fragile operations. */
553
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
554

Götz Lindenmaier's avatar
Götz Lindenmaier committed
555
556
#include "ident.h"

Michael Beck's avatar
Michael Beck committed
557
558
/*@{*/
/** Makros for debugging the libfirm */
559
#ifdef __GNUC__
560
561
562
563
564
565
/* GNU C has the  extension */
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
566

Götz Lindenmaier's avatar
Götz Lindenmaier committed
567
568
569
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */

570
/** Output the firm kind of the node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
571
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (X));
572
/** Output information about a node */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
573
#define DDMN(X)  printf("%s(l.%i) %s%s: %ld (%p)\n",         __MYFUNC__, __LINE__,  get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (X))
574
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
575
#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)))
576
/** Output information about a type */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
577
#define DDMT(X)  printf("%s(l.%i) %s %s: %ld (%p)\n",        __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (X))
578
/** Output information about an entity */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
579
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p\n",            __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (X))
580
/** Output information about an entity and its owner */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
581
#define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (X))
582
/** Output information about a graph */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
583
#define DDMG(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (X))
584
/** Output information about an ident */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
585
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (X))
586
/** Output information about a mode */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
587
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (X))
588

Michael Beck's avatar
Michael Beck committed
589
590
591
/*@}*/  /* Macros for debug.. */

/*@}*/ /* end of ir_node group definition */
592

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

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