irnode.h 24.6 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
Christian Schäfer's avatar
Christian Schäfer committed
2
3
4
5
6
7
8
** All rights reserved.
**
** Authors: Martin Trapp, Christian Schaefer
**
** declarations of an ir node
*/

Boris Boesler's avatar
Boris Boesler committed
9
10
/* $Id$ */

Christian Schäfer's avatar
Christian Schäfer committed
11
12
13
# ifndef _IRNODE_H_
# define _IRNODE_H_

Christian Schäfer's avatar
Christian Schäfer committed
14
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
15
16
17
18
19
20
# include "entity.h"
# include "common.h"
# include "irop.h"
# include "irmode.h"
# include "tv.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
21
# include "dbginfo.h"
22
# include "exc.h"
Christian Schäfer's avatar
Christian Schäfer committed
23

Christian Schäfer's avatar
Christian Schäfer committed
24
25
26
27
/* The typedefiniton of ir_node is also in irgraph.h to resolve
   recursion between irnode.h and irgraph.h */
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Götz Lindenmaier's avatar
Götz Lindenmaier committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/****s* irnode/irnode
 *
 * NAME ir_node - a datatype representing a Firm node
 *
 * NOTE Not properly documented ;-)
 *
 * ATTRIBUTES
 *  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.
 * SOURCE
 */
Christian Schäfer's avatar
Christian Schäfer committed
51
52
53
typedef struct ir_node ir_node;
#endif

Götz Lindenmaier's avatar
Götz Lindenmaier committed
54
55
56
/** Manipulate the fields of ir_node.  With these access routines
    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
57
58
59
60
61

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

/* 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.  */

inline ir_node *
Götz Lindenmaier's avatar
Götz Lindenmaier committed
113
114
new_ir_node (dbg_info *db,
	     ir_graph *irg,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
115
116
117
118
119
	     ir_node *block,
	     ir_op *op,
	     ir_mode *mode,
	     int arity,
	     ir_node **in);
Christian Schäfer's avatar
Christian Schäfer committed
120

Götz Lindenmaier's avatar
Götz Lindenmaier committed
121
122
123
124
125
126
127
128
/****s* irnode/other
 *
 * NAME access functions for node fields.
 *
 * NOTE Not properly documented ;-)
 *
 * SOURCE
 */
Christian Schäfer's avatar
Christian Schäfer committed
129
130

/* this works for all except Block */
131
132
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
133
134

/* Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
135
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
136
137
138
139
140
141
142
143
144
  pns_initial_exec,     /* Projection on an executable, the initial control
			   flow. */
  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
			   containing _all_ global entities. */
  pns_args              /* Projection on all arguments */
} pns_number;

145
146
inline ir_node **get_Block_cfgpred_arr (ir_node *node);
int              get_Block_n_cfgpreds (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
147
/* inline void    set_Block_n_cfgpreds (ir_node *node, int n_preds); */
148
149
150
151
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);
Christian Schäfer's avatar
Christian Schäfer committed
152
153
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
154
155
/* For this current_ir_graph must be set. */
inline void      mark_Block_block_visited(ir_node *node);
156
inline int       Block_not_block_visited(ir_node *node);
157
158
inline ir_node  *get_Block_graph_arr (ir_node *node, int pos);
inline void      set_Block_graph_arr (ir_node *node, int pos, ir_node *value);
Christian Schäfer's avatar
Christian Schäfer committed
159

160
161
162
void  set_Block_exc (ir_node*, exc_t);
exc_t get_Block_exc (ir_node*);

163
164
165
166
167
168
169
170
171
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
 * both views. */
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);
ir_node ** get_Block_cg_cfgpred_arr(ir_node * node);
int get_Block_cg_n_cfgpreds(ir_node * node);
void remove_Block_cg_cfgpred_arr(ir_node * node);

172

173
174
inline int  get_End_n_keepalives(ir_node *end);
inline ir_node *get_End_keepalive(ir_node *end, int pos);
175
inline void add_End_keepalive (ir_node *end, ir_node *ka);
176
inline ir_node *set_End_keepalive(ir_node *end, int pos, ir_node *ka);
177
/* Some parts of the End node are allocated seperately -- their memory
178
   is not recovered by dead_node_elimination if a End node is dead.
179
180
   free_End frees these data structures. */
inline void free_End (ir_node *end);
181

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/* 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.
199
200
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
201
202
203
204
205
206
207
*/
typedef enum {
  dense,        /* Default. Missing Proj nodes are dead control flow. */
  fragmentary   /* Special. No control flow optimizations allowed.  Missing
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

208
209
inline ir_node  *get_Cond_selector (ir_node *node);
inline void      set_Cond_selector (ir_node *node, ir_node *selector);
210
211
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
212

213
214
215
216
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);
inline int       get_Return_n_res (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
217
/*inline void     set_Return_n_res (ir_node *node, int results); */
218
219
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
220
221
222

inline ir_node *get_Raise_mem (ir_node *node);
inline void     set_Raise_mem (ir_node *node, ir_node *mem);
223
224
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
225
226
227
228

inline tarval  *get_Const_tarval (ir_node *node);
inline void     set_Const_tarval (ir_node *node, tarval *con);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
229
230
231
232
233
234
/*   This enum names the three different kinds of symbolic Constants
     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 {
  type_tag,          /* The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
235
			Type_or_id_p is type *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
236
  size,              /* The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
237
			Type_or_id_p is type *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
238
  linkage_ptr_info   /* The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
239
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
240
241
} symconst_kind;
typedef union type_or_id * type_or_id_p;
Christian Schäfer's avatar
Christian Schäfer committed
242
243
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
244
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
Christian Schäfer's avatar
Christian Schäfer committed
245
246
inline type    *get_SymConst_type (ir_node *node);
inline void     set_SymConst_type (ir_node *node, type *type);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
247
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
Christian Schäfer's avatar
Christian Schäfer committed
248
249
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
250
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
251
   its semantics.  Does a memcpy for the memory tori points to. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
252
253
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);
Christian Schäfer's avatar
Christian Schäfer committed
254
255
256
257

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 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
258
inline void     set_Sel_ptr (ir_node *node, ir_node *ptr);
259
inline ir_node **get_Sel_index_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
260
inline int      get_Sel_n_index (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
261
262
263
264
265
/*inline void     set_Sel_n_index (ir_node *node, int n_index); */
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);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
266
267
268
269
270
271
typedef enum {
  static_linkage,       /* entity is used internal and not visible out of this
			   file/class. */
  external_linkage,     /* */
  no_linkage
} linkage_type;
Götz Lindenmaier's avatar
Götz Lindenmaier committed
272
273
inline linkage_type get_Sel_linkage_type (ir_node *node);
inline void     set_Sel_linkage_type (ir_node *node, linkage_type lt);
Christian Schäfer's avatar
Christian Schäfer committed
274
275
276
277
278

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);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
279
inline ir_node **get_Call_param_arr (ir_node *node);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
280
inline int      get_Call_n_params (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
281
282
inline int      get_Call_arity (ir_node *node);
/* inline void     set_Call_arity (ir_node *node, ir_node *arity); */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
283
284
inline ir_node *get_Call_param (ir_node *node, int pos);
inline void     set_Call_param (ir_node *node, int pos, ir_node *param);
285
286
inline type    *get_Call_type (ir_node *node);
inline void     set_Call_type (ir_node *node, type *type);
Christian Schäfer's avatar
Christian Schäfer committed
287

288
289
290
291
292
293
/* 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);

Christian Schäfer's avatar
Christian Schäfer committed
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
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
/* 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 */
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
376
/* Projection numbers of compare: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
377
typedef enum {
Götz Lindenmaier's avatar
Götz Lindenmaier committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
  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 */
  not_mask = Leg	/* bits to flip to negate comparison */
} pnc_number;
inline char *get_pnc_string(int pnc);
inline int   get_negated_pnc(int pnc);
Christian Schäfer's avatar
Christian Schäfer committed
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
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);

426
427
inline ir_node **get_Phi_preds_arr (ir_node *node);
inline int       get_Phi_n_preds (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
428
/* inline void     set_Phi_n_preds (ir_node *node, int n_preds); */
429
430
inline ir_node  *get_Phi_pred (ir_node *node, int pos);
inline void      set_Phi_pred (ir_node *node, int pos, ir_node *pred);
Christian Schäfer's avatar
Christian Schäfer committed
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449

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);
inline void     set_Alloc_type (ir_node *node, type *type);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
450
451
452
453
typedef enum {
  stack_alloc,          /* Alloc allocates the object on the stack. */
  heap_alloc            /* Alloc allocates the object on the heap. */
} where_alloc;
Christian Schäfer's avatar
Christian Schäfer committed
454
455
456
457
458
459
460
461
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);
Christian Schäfer's avatar
Christian Schäfer committed
462
inline void     set_Free_size (ir_node *node, ir_node *size);
Christian Schäfer's avatar
Christian Schäfer committed
463
464
465
inline type    *get_Free_type (ir_node *node);
inline void     set_Free_type (ir_node *node, type *type);

466
467
inline ir_node **get_Sync_preds_arr (ir_node *node);
inline int       get_Sync_n_preds (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
468
/* inline void     set_Sync_n_preds (ir_node *node, int n_preds); */
469
470
inline ir_node  *get_Sync_pred (ir_node *node, int pos);
inline void      set_Sync_pred (ir_node *node, int pos, ir_node *pred);
Christian Schäfer's avatar
Christian Schäfer committed
471

472
473
474
475
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);
Christian Schäfer's avatar
Christian Schäfer committed
476

477
478
inline ir_node **get_Tuple_preds_arr (ir_node *node);
inline int       get_Tuple_n_preds (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
479
/* inline void     set_Tuple_n_preds (ir_node *node, int n_preds); */
480
481
inline ir_node  *get_Tuple_pred (ir_node *node, int pos);
inline void      set_Tuple_pred (ir_node *node, int pos, ir_node *pred);
Christian Schäfer's avatar
Christian Schäfer committed
482

483
484
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
485

486
487
488
489
490
491
492
493
494
495
inline ir_node  *get_Filter_pred(ir_node *node);
inline long      get_Filter_proj(ir_node *node);
/* set the interprocedural predecessors */
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);

/* Returns the ir_graph this node belongs to. Only valid for
 * CallBegin, EndReg and EndExcept */
inline ir_graph *get_irn_irg(ir_node *node);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
496
/*****/
Christian Schäfer's avatar
Christian Schäfer committed
497

Götz Lindenmaier's avatar
Götz Lindenmaier committed
498
499
500
501
502
503
504
505
/****s* irnode/other2
 *
 * NAME Auxiliary routines
 *
 * NOTE Not properly documented ;-)
 *
 * SOURCE
 */
Christian Schäfer's avatar
Christian Schäfer committed
506
507
508
509
510

/* returns operand of node if node is a Proj. */
inline ir_node *skip_Proj (ir_node *node);
/* returns operand of node if node is a Id */
inline ir_node *skip_nop  (ir_node *node);
511
inline ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
512
513
514
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
inline ir_node *skip_Tuple (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
515
516
517
518
/* returns true if node is a Bad node. */
inline int      is_Bad    (ir_node *node);
/* returns true if the node is not a Block */
inline int      is_no_Block (ir_node *node);
519
520
521
/* returns true if node is a Proj node or a Filter node in
 * intraprocedural view */
inline int      is_Proj (ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
522
/* Returns true if the operation manipulates control flow:
523
   Start, End, Jmp, Cond, Return, Raise, Bad */
Christian Schäfer's avatar
Christian Schäfer committed
524
525
int is_cfop(ir_node *node);
/* Returns true if the operation can change the control flow because
526
527
   of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
   Bad. */
Christian Schäfer's avatar
Christian Schäfer committed
528
int is_fragile_op(ir_node *node);
529
530
/* Returns the memory operand of fragile operations. */
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
531

Götz Lindenmaier's avatar
Götz Lindenmaier committed
532
/*****/
Götz Lindenmaier's avatar
Götz Lindenmaier committed
533
534
535
536
537
538

/* Makros for debugging the libfirm */
#include "ident.h"

#define DDMSG        printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
#define DDMSG1(X)    printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__,         \
Götz Lindenmaier's avatar
Götz Lindenmaier committed
539
                            id_to_str(get_irn_opident(X)))
540
541
542
#define DDMSG2(X)    printf("%s(l.%i) %s%s: %ld\n", __FUNCTION__, __LINE__,          \
                     id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
                     get_irn_node_nr(X))
Götz Lindenmaier's avatar
Götz Lindenmaier committed
543
544
#define DDMSG3(X)    printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__,     \
                     print_firm_kind(X), (X))
545
546
#define DDMSG4(X)    xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__,     \
                     get_type_tpop_nameid(X), get_type_ident(X), (X))
547
548
549
#define DDMSG5(X)    printf("%s%s: %ld",          \
                     id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), \
                     get_irn_node_nr(X))
Götz Lindenmaier's avatar
Götz Lindenmaier committed
550

551
552
553
554
555
556
557
558
559
560
561

#define DDMN(X)      xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FUNCTION__, __LINE__,      \
                     get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X), (X))
#define DDMNB(X)     xprintf("%I%I: %ld (in block %ld)\n",                             \
		     get_irn_opident(X), get_irn_modeident(X), get_irn_node_nr(X),     \
		     get_irn_node_nr(get_nodes_Block(X)))
#define DDMT(X)      xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__,           \
                     get_type_tpop_nameid(X), get_type_ident(X), (X))
#define DDME(X)      xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__,              \
                     get_entity_ident(X), (X))

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

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