irnode.h 26.5 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
Sebastian Felis's avatar
Sebastian Felis committed
2
* All rights reserved.
Christian Schäfer's avatar
Christian Schäfer committed
3
4
*/

Michael Beck's avatar
Michael Beck committed
5
6
7
8
9
10
11
12
/**
 * @file irnode.h
 *
 * Declarations of an ir node.
 *
 * author Martin Trapp, Christian Schaefer
 */

Boris Boesler's avatar
Boris Boesler committed
13
14
/* $Id$ */

Christian Schäfer's avatar
Christian Schäfer committed
15
16
17
# ifndef _IRNODE_H_
# define _IRNODE_H_

Christian Schäfer's avatar
Christian Schäfer committed
18
# include "irgraph.h"
Christian Schäfer's avatar
Christian Schäfer committed
19
# include "entity.h"
20
# include "firm_common.h"
Christian Schäfer's avatar
Christian Schäfer committed
21
22
23
24
# include "irop.h"
# include "irmode.h"
# include "tv.h"
# include "type.h"
Götz Lindenmaier's avatar
Götz Lindenmaier committed
25
# include "dbginfo.h"
26
# include "exc.h"
Christian Schäfer's avatar
Christian Schäfer committed
27

Götz Lindenmaier's avatar
Götz Lindenmaier committed
28
/* The type definiton of ir_node is also in irgraph.h to resolve
Christian Schäfer's avatar
Christian Schäfer committed
29
   recursion between irnode.h and irgraph.h */
Michael Beck's avatar
Michael Beck committed
30
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
31
32
33
 *
 * NAME ir_node - a datatype representing a Firm node
 *
Sebastian Felis's avatar
Sebastian Felis committed
34
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
35
 *
Sebastian Felis's avatar
Sebastian Felis committed
36
 *  @param The common fields are:
Götz Lindenmaier's avatar
Götz Lindenmaier committed
37
 *
Sebastian Felis's avatar
Sebastian Felis committed
38
 *  @param firm_kind    A firm_kind tag containing k_type.  This is useful
Götz Lindenmaier's avatar
Götz Lindenmaier committed
39
 *               for dynamically checking whether a node is a ir_node.
Sebastian Felis's avatar
Sebastian Felis committed
40
41
 *  @param arity        The number of predecessors in the Firm graph.
 *  @param in           A list with the predecessors in the Firm graph.  There are
Götz Lindenmaier's avatar
Götz Lindenmaier committed
42
43
 *               routines to access individual elements and to obtain the
 *               array.  The method returning the array should not be used.
Sebastian Felis's avatar
Sebastian Felis committed
44
 *  @param mode         The mode of the node.  There are routines to get the mode but
Götz Lindenmaier's avatar
Götz Lindenmaier committed
45
 *               also to access the mode's fields directly.
Sebastian Felis's avatar
Sebastian Felis committed
46
 *  @param opcode       The opcode of the node.  There are routines to get the opcode but
Götz Lindenmaier's avatar
Götz Lindenmaier committed
47
 *               also to access the opcode's fields directly.
Sebastian Felis's avatar
Sebastian Felis committed
48
 *  @param node_nr      A unique number for the node.  Available only if debugging is
Götz Lindenmaier's avatar
Götz Lindenmaier committed
49
50
 *               turned on.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
51
52
#ifndef _IR_NODE_TYPEDEF_
#define _IR_NODE_TYPEDEF_
Christian Schäfer's avatar
Christian Schäfer committed
53
54
55
typedef struct ir_node ir_node;
#endif

Sebastian Felis's avatar
Sebastian Felis committed
56
/**
Götz Lindenmaier's avatar
Götz Lindenmaier committed
57
58
    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
59

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

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

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

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

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

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

/* this works for all except Block */
138
139
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
140

Michael Beck's avatar
Michael Beck committed
141
/** Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
142
typedef enum {
Michael Beck's avatar
Michael Beck committed
143
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
144
			   flow. */
Michael Beck's avatar
Michael Beck committed
145
146
147
  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
148
			   containing _all_ global entities. */
Michael Beck's avatar
Michael Beck committed
149
  pns_args              /**< Projection on all arguments */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
150
151
} pns_number;

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

165
166
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
167
168
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
169
170
171
172
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);
173
/* Returns the number of interproc predecessors.  0 if none. */
174
175
int get_Block_cg_n_cfgpreds(ir_node * node);
ir_node * get_Block_cg_cfgpred(ir_node * node, int pos);
176
/* frees the memory. */
177
178
void remove_Block_cg_cfgpred_arr(ir_node * node);

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

188
189
190
ir_graph *get_EndReg_irg (ir_node *end);
ir_graph *get_EndExcept_irg  (ir_node *end);

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

217
218
219
220
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
221

222
223
224
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);
225
INLINE int       get_Return_n_ress (ir_node *node);
226
227
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
228

229
230
231
232
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
233

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

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

274
/* @@@ ajacs specific node -- not supported */
275
276
277
278
279
280
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);
281

282
283
284
285
286
287
288
289
290
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);
291
INLINE void     set_Call_type (ir_node *node, type *tp);
292
293
INLINE int      get_Call_arity (ir_node *node);

294
295
296
297
298
299
/* 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);

300
301
302
303
304
305
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
306
307
308
309
310
311
/* 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 */
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
376
377
378
379
380
381
382
383
384
385
386
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
387

Michael Beck's avatar
Michael Beck committed
388
/** Projection numbers of compare: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
389
typedef enum {
Michael Beck's avatar
Michael Beck committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
  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
406
  /* not_mask = Leg*/	/* bits to flip to negate comparison * @@ hack for jni interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
407
} pnc_number;
408
#define not_mask Leg
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
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);

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

455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
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);
472
INLINE void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
473
474

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

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

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
510

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

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

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

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

Götz Lindenmaier's avatar
Götz Lindenmaier committed
552
553
554

#include "ident.h"

Michael Beck's avatar
Michael Beck committed
555
556
/*@{*/
/** Makros for debugging the libfirm */
557
558
559
560
#ifdef __GNUC__
/*
 * GNU C has the __FUNCTION__ extension
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
561
#define DDMSG        printf("%s(l.%i)\n", __FUNCTION__, __LINE__)
562
563
564
565
566
567
568
569
570
571
572
#define DDMSG1(X)    printf("%s(l.%i) %s\n", __FUNCTION__, __LINE__, id_to_str(get_irn_opident(X)))
#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))
#define DDMSG3(X)    printf("%s(l.%i) %s: %p\n", __FUNCTION__, __LINE__, print_firm_kind(X), (X))
#define DDMSG4(X)    xprintf("%s(l.%i) %I %I: %p\n", __FUNCTION__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
#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))


#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
573
#define DDMEO(X)     xprintf("%s(l.%i) %I (own: %I): %p\n", __FUNCTION__, __LINE__, get_entity_ident(X), get_type_ident(get_entity_owner(X)), (X))
574
#define DDMG(X)      xprintf("%s(l.%i) %I: %p\n", __FUNCTION__, __LINE__, get_irg_ent(get_entity_ident(X)), (X))
575

576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
#else
/*
 * use Filename instead
 */
#define DDMSG        printf("%s(l.%i)\n", __FILE__, __LINE__)
#define DDMSG1(X)    printf("%s(l.%i) %s\n", __FILE__, __LINE__, id_to_str(get_irn_opident(X)))
#define DDMSG2(X)    printf("%s(l.%i) %s%s: %ld\n", __FILE__, __LINE__, id_to_str(get_irn_opident(X)), id_to_str(get_irn_modeident(X)), get_irn_node_nr(X))
#define DDMSG3(X)    printf("%s(l.%i) %s: %p\n", __FILE__, __LINE__, print_firm_kind(X), (X))
#define DDMSG4(X)    xprintf("%s(l.%i) %I %I: %p\n", __FILE__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
#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))


#define DDMN(X)      xprintf("%s(l.%i) %I%I: %ld (%p)\n", __FILE__, __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", __FILE__, __LINE__, get_type_tpop_nameid(X), get_type_ident(X), (X))
#define DDME(X)      xprintf("%s(l.%i) %I: %p\n", __FILE__, __LINE__, get_entity_ident(X), (X))
#define DDMG(X)      xprintf("%s(l.%i) %I: %p\n", __FILE__, __LINE__, get_irg_ent(get_entity_ident(X)), (X))
Götz Lindenmaier's avatar
Götz Lindenmaier committed
593
#define DDMI(X)      xprintf("%s(l.%i) %I: %p\n", __FILE__, __LINE__, (X), (X))
594
595

#endif /* __GNUC__ */
Michael Beck's avatar
Michael Beck committed
596
/*@}*/
597

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

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