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

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

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

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

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

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

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

Sebastian Felis's avatar
Sebastian Felis committed
91
92
93
94
95
96
97
98
99
100
101
/**
 *   Checks whether a pointer points to a ir node.
 *
 *   @param thing     an arbitrary pointer
 *
 *   @return
 *       true if the thing is a ir mode, else false
 */
int
is_ir_node (void *thing);

Michael Beck's avatar
Michael Beck committed
102
/** returns the number of predecessors without the block predecessor: */
103
int                  get_irn_arity         (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
104
105

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

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

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

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

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

/* this works for all except Block */
183
184
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
185

Michael Beck's avatar
Michael Beck committed
186
/** Projection numbers for result of Start node: use for Proj nodes! */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
187
typedef enum {
Michael Beck's avatar
Michael Beck committed
188
  pns_initial_exec,     /**< Projection on an executable, the initial control
Götz Lindenmaier's avatar
Götz Lindenmaier committed
189
			   flow. */
Michael Beck's avatar
Michael Beck committed
190
191
192
  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
193
			   containing _all_ global entities. */
194
195
196
  pns_args,             /**< Projection on all arguments */
  pns_value_arg_base    /**< Pointer to region of compound value arguments as defined by
  			     type of this method. */
197
} pns_number; /* pns: Projection Number Start */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
198

199
/* @@@ no more supported  */
200
INLINE ir_node **get_Block_cfgpred_arr (ir_node *node);
201
int              get_Block_n_cfgpreds (ir_node *node);
202
203
204
205
206
207
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
208
/* For this current_ir_graph must be set. */
209
210
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
211

212
213
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
214
215
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
216
217
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);
218
/* @@@ not supported */
219
ir_node **get_Block_cg_cfgpred_arr(ir_node * node);
220
/* Returns the number of interproc predecessors.  0 if none. */
221
222
int       get_Block_cg_n_cfgpreds(ir_node * node);
ir_node  *get_Block_cg_cfgpred(ir_node * node, int pos);
223
/* frees the memory. */
224
225
226
227
228
void      remove_Block_cg_cfgpred_arr(ir_node * node);

/* Start references the irg it is in. */
ir_graph *get_Start_irg(ir_node *node);
void      set_Start_irg(ir_node *node, ir_graph *irg);
229

230
231
232
233
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);
234
/* Some parts of the End node are allocated seperately -- their memory
235
   is not recovered by dead_node_elimination if a End node is dead.
236
   free_End frees these data structures. */
237
INLINE void free_End (ir_node *end);
238

239
240
ir_graph *get_EndReg_irg (const ir_node *end);
ir_graph *get_EndExcept_irg  (const ir_node *end);
241

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
/* 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.
259
260
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
261
262
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
263
264
  dense,        /**< Default. Missing Proj nodes are dead control flow. */
  fragmentary   /**< Special. No control flow optimizations allowed.  Missing
265
266
267
		   Proj nodes mean default control flow, i.e., Proj(n). */
} cond_kind;

268
269
270
271
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
272

273
274
275
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);
276
INLINE int       get_Return_n_ress (ir_node *node);
277
278
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
279

280
281
282
283
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
284

285
286
INLINE tarval  *get_Const_tarval (ir_node *node);
INLINE void     set_Const_tarval (ir_node *node, tarval *con);
287
288
289
290
291
/* The source language type.  Must be an atomic type.  Mode of type must
   be mode of node. For tarvals from entities type must be pointer to
   entity type. */
INLINE type    *get_Const_type   (ir_node *node);
INLINE void     set_Const_type   (ir_node *node, type *tp);
Christian Schäfer's avatar
Christian Schäfer committed
292

Michael Beck's avatar
Michael Beck committed
293
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
294
295
296
297
     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
298
  type_tag,          /**< The SymConst is a type tag for the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
299
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
300
  size,              /**< The SymConst is the size of the given type.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
301
			Type_or_id_p is type *. */
Michael Beck's avatar
Michael Beck committed
302
  linkage_ptr_info   /**< The SymConst is a symbolic pointer to be filled in
Götz Lindenmaier's avatar
Götz Lindenmaier committed
303
			by the linker. Type_or_id_p is ident *. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
304
305
} symconst_kind;
typedef union type_or_id * type_or_id_p;
306
INLINE symconst_kind get_SymConst_kind (const ir_node *node);
307
INLINE void          set_SymConst_kind (ir_node *node, symconst_kind num);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
308
/* Only to access SymConst of kind type_tag or size.  Else assertion: */
309
INLINE type    *get_SymConst_type (ir_node *node);
310
INLINE void     set_SymConst_type (ir_node *node, type *tp);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
311
/* Only to access SymConst of kind linkage_ptr_info.  Else assertion: */
312
313
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
314
/* Sets both: type and ptrinfo.  Needed to treat the node independent of
Götz Lindenmaier's avatar
Götz Lindenmaier committed
315
   its semantics.  Does a memcpy for the memory tori points to. */
316
317
318
319
320
321
322
323
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);
324
INLINE int      get_Sel_n_indexs (ir_node *node);
325
326
327
328
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
329

330
/* @@@ ajacs specific node -- not supported */
331
332
333
334
335
336
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);
337

338
339
340
341
342
343
344
345
346
347
348
/** Projection numbers for result of Call node: use for Proj nodes! */
typedef enum {
  pncl_memory = 0,        /**< The memory result. */
  pncl_exc_target = 1,    /**< The control flow result branching to the exception handler */
  pncl_result_tuple = 2,  /**< The tuple containing all (0, 1, 2, ...) results */
  pncl_exc_memory = 3,    /**< The memory result in case the called method terminated with
			      an exception */
  pncl_value_res_base = 4 /**< A pointer to the memory region containing copied results
			      passed by value (for compound result types). */
} pncl_number;   /* pncl: Projection Number CaLl */

349
350
351
352
353
INLINE ir_node *get_Call_mem (ir_node *node);
INLINE void     set_Call_mem (ir_node *node, ir_node *mem);
INLINE ir_node *get_Call_ptr (ir_node *node);
INLINE void     set_Call_ptr (ir_node *node, ir_node *ptr);
INLINE ir_node **get_Call_param_arr (ir_node *node);
Michael Beck's avatar
Michael Beck committed
354
/** Gets the number of parameters of a call. */
355
INLINE int      get_Call_n_params (ir_node *node);
Michael Beck's avatar
Michael Beck committed
356
/** Gets the call parameter at position pos. */
357
INLINE ir_node *get_Call_param (ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
358
/** Sets the call parameter at position pos. */
359
INLINE void     set_Call_param (ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
360
/** Gets the type of a call. */
361
INLINE type    *get_Call_type (ir_node *node);
Michael Beck's avatar
Michael Beck committed
362
/** Sets the type of a call. */
363
INLINE void     set_Call_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
364
/** Gets the arity of a call. Identical to get_Call_n_params(). */
365
366
INLINE int      get_Call_arity (ir_node *node);

367
368
369
370
371
372
/* 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);

373
374
375
376
377
378
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
379
380
381
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
382
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
383
384
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
   Shr, Shrs, Rot, Cmp */
385
386
387
388
389
390
391
392
393
394
395
396
397
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
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
460

461
INLINE const char *get_pnc_string(int pnc);
462

463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
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);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
492
493
494
495
496
INLINE ir_node *get_Cast_op (ir_node *node);
INLINE void     set_Cast_op (ir_node *node, ir_node *op);
INLINE type    *get_Cast_type (ir_node *node);
INLINE void     set_Cast_type (ir_node *node, type *to_tp);

497
498
499
500
501
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);

502
503
504
505
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);
506
507
/* set the interprocedural predecessors, ...d_arr uses current_ir_graph.
 * @@@ Maybe better:  arity is zero if no cg preds. */
508
509
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);
510
511
int              get_Filter_n_cg_preds(ir_node *node);
ir_node *        get_Filter_cg_pred(ir_node *node, int pos);
512

513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
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);
530
INLINE void     set_Alloc_type (ir_node *node, type *tp);
Michael Beck's avatar
Michael Beck committed
531
532

/** allocation place. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
533
typedef enum {
Michael Beck's avatar
Michael Beck committed
534
535
  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
536
} where_alloc;
Michael Beck's avatar
Michael Beck committed
537

538
539
540
541
542
543
544
545
546
547
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);
548
INLINE void     set_Free_type (ir_node *node, type *tp);
549
550
551
552
553
554
555
556

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);
557
/* Why long? shouldn't int be enough, and smaller? Or even byte? */
558
559
560
561
562
563
564
565
566
567
568
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
569

Michael Beck's avatar
Michael Beck committed
570
/*
Götz Lindenmaier's avatar
Götz Lindenmaier committed
571
572
573
 *
 * NAME Auxiliary routines
 *
Sebastian Felis's avatar
Sebastian Felis committed
574
 *  Not properly documented ;-)
Götz Lindenmaier's avatar
Götz Lindenmaier committed
575
576
 *
 */
Christian Schäfer's avatar
Christian Schäfer committed
577

Michael Beck's avatar
Michael Beck committed
578
/** returns operand of node if node is a Proj. */
579
INLINE ir_node *skip_Proj (ir_node *node);
Michael Beck's avatar
Michael Beck committed
580
/** returns operand of node if node is a Id */
581
582
INLINE ir_node *skip_nop  (ir_node *node);
INLINE ir_node *skip_Id  (ir_node *node);   /* Same as skip_nop. */
583
584
/* returns corresponding operand of Tuple if node is a Proj from
   a Tuple. */
585
INLINE ir_node *skip_Tuple (ir_node *node);
Michael Beck's avatar
Michael Beck committed
586
/** returns true if node is a Bad node. */
587
INLINE int      is_Bad    (ir_node *node);
Michael Beck's avatar
Michael Beck committed
588
/** returns true if the node is not a Block */
589
INLINE int      is_no_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
590
/** returns true if the node is a Block */
591
INLINE int      is_Block (ir_node *node);
Michael Beck's avatar
Michael Beck committed
592
/** returns true if node is a Proj node or a Filter node in
593
 * intraprocedural view */
594
INLINE int      is_Proj (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
595
/** Returns true if the operation manipulates control flow:
596
   Start, End, Jmp, Cond, Return, Raise, Bad, CallBegin, EndReg, EndExcept */
Christian Schäfer's avatar
Christian Schäfer committed
597
int is_cfop(ir_node *node);
598

Michael Beck's avatar
Michael Beck committed
599
/** Returns true if the operation manipulates interprocedural control flow:
600
601
   CallBegin, EndReg, EndExcept */
int is_ip_cfop(ir_node *node);
Michael Beck's avatar
Michael Beck committed
602
/** Returns true if the operation can change the control flow because
603
604
   of an exception: Call, Quot, DivMod, Div, Mod, Load, Store, Alloc,
   Bad. */
605
606
ir_graph *get_ip_cfop_irg(ir_node *n);

Christian Schäfer's avatar
Christian Schäfer committed
607
int is_fragile_op(ir_node *node);
Michael Beck's avatar
Michael Beck committed
608
/** Returns the memory operand of fragile operations. */
609
ir_node *get_fragile_op_mem(ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
610

Götz Lindenmaier's avatar
Götz Lindenmaier committed
611
612
#include "ident.h"

613
#ifdef __GNUC__
614
/* GNU C has the __FUNCTION__ extension */
615
616
617
618
619
#define __MYFUNC__ __FUNCTION__
#else
/* use Filename instead */
#define __MYFUNC__ __FILE__
#endif
620

Götz Lindenmaier's avatar
Götz Lindenmaier committed
621
622
/* !!!!!!!!! @@@
   Don't format with "\", firmjni gets problems */
623
/** Output location */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
624
#define DDM      printf("%s(l.%i).\n",                       __MYFUNC__, __LINE__);
625
/** Output the firm kind of the node */
626
#define DDMK(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__,  print_firm_kind(X), (void *)(X));
627
/** Output information about a node */
628
#define DDMN(X)  printf("%s(l.%i) %s%s: %ld (%p)\n",         __MYFUNC__, __LINE__,  get_irn_opname(X), get_mode_name(get_irn_mode(X)), get_irn_node_nr(X), (void *)(X))
629
/** Output information about a node and its block */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
630
#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)))
631
/** Output information about a type */
632
#define DDMT(X)  printf("%s(l.%i) %s %s: %ld (%p)\n",        __MYFUNC__, __LINE__, get_type_tpop_name(X), get_type_name(X), get_type_nr(X), (void *)(X))
633
/** Output information about an entity */
634
#define DDME(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(X), get_entity_nr(X), (void *)(X))
635
636
/** Output information about an entity and its type */
#define DDMET(X) printf("%s(l.%i) %s (typ: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_type(X)), get_entity_nr(X), (void *)(X))
637
/** Output information about an entity and its owner */
638
#define DDMEO(X) printf("%s(l.%i) %s (own: %s): %ld (%p)\n", __MYFUNC__, __LINE__, get_entity_name(X), get_type_name(get_entity_owner(X)), get_entity_nr(X), (void *)(X))
639
/** Output information about a graph */
640
#define DDMG(X)  printf("%s(l.%i) %s: %ld (%p)\n",           __MYFUNC__, __LINE__, get_entity_name(get_irg_ent(X)), get_irg_graph_nr(X), (void *)(X))
641
/** Output information about an ident */
642
#define DDMI(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, id_to_str(X), (void *)(X))
643
/** Output information about a mode */
644
#define DDMM(X)  printf("%s(l.%i) %s: %p\n",                 __MYFUNC__, __LINE__, get_mode_name(X), (void *)(X))
645
/** Output information about a loop */
646
#define DDML(X)  printf("%s(l.%i) loop with depth %d: %p\n", __MYFUNC__, __LINE__, get_loop_depth(X), (void *)(X))
647
/** Output information about a tarVal */
648
#define DDMV(X)  printf("%s(l.%i) tarval: ",__MYFUNC__, __LINE__); tarval_printf(X); printf(" (%p)\n", (void *)(X));
649

Michael Beck's avatar
Michael Beck committed
650
/*@}*/ /* end of ir_node group definition */
651

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

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