7511ee7bb32e3c4416c344d9a9fe59b455ab2c45
[libfirm] / ir / ir / irnode_t.h
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Representation of an intermediate operation -- private header.
23  * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
24  * @version $Id$
25  */
26 #ifndef FIRM_IR_IRNODE_T_H
27 #define FIRM_IR_IRNODE_T_H
28
29 #include "firm_config.h"
30 #include "irnode.h"
31 #include "irop_t.h"
32 #include "irgraph_t.h"
33 #include "irflag_t.h"
34 #include "firm_common_t.h"
35 #include "irdom_t.h" /* For size of struct dom_info. */
36 #include "dbginfo.h"
37 #include "irloop.h"
38 #include "iredgekinds.h"
39 #include "array.h"
40
41 #include "set.h"
42 #include "list.h"
43 #include "entity_t.h"
44 #include "type_t.h"
45 #include "tv_t.h"
46 #include "irextbb_t.h"
47
48
49 /** ir node attributes **/
50
51 /** Block attributes */
52 typedef struct {
53         /* General attributes */
54         ir_graph *irg;              /**< The graph this block belongs to. */
55         unsigned long block_visited; /**< For the walker that walks over all blocks. */
56         /* Attributes private to construction: */
57         unsigned is_matured:1;      /**< If set, all in-nodes of the block are fixed. */
58         unsigned is_dead:1;         /**< If set, the block is dead (and could be replace by a Bad. */
59     unsigned is_mb_head:1;      /**< Set if this block is a macroblock head. */
60         ir_node **graph_arr;        /**< An array to store all parameters. */
61         /* Attributes holding analyses information */
62         ir_dom_info dom;            /**< Datastructure that holds information about dominators.
63                                          @@@ @todo
64                                          Eventually overlay with graph_arr as only valid
65                                          in different phases.  Eventually inline the whole
66                                          datastructure. */
67         ir_dom_info pdom;           /**< Datastructure that holds information about post-dominators. */
68         ir_node ** in_cg;           /**< array with predecessors in
69                                      * interprocedural_view, if they differ
70                                      * from intraprocedural predecessors */
71         int *backedge;              /**< Field n set to true if pred n is backedge.
72                                          @@@ @todo Ev. replace by bit field! */
73         int *cg_backedge;           /**< Field n set to true if pred n is interprocedural backedge.
74                                          @@@ @todo Ev. replace by bit field! */
75         ir_extblk *extblk;          /**< The extended basic block this block belongs to. */
76         ir_region *region;          /**< The immediate structural region this block belongs to. */
77     unsigned mb_depth;          /**< The macroblock depth: A distance from the macroblock header */
78
79         struct list_head succ_head; /**< A list head for all successor edges of a block. */
80 } block_attr;
81
82 /** Cond attributes. */
83 typedef struct {
84         cond_kind kind;           /**< flavor of Cond */
85         long default_proj;        /**< only for non-binary Conds: biggest Proj number, i.e. the one used for default. */
86         cond_jmp_predicate pred;  /**< only for binary Conds: The jump predication. */
87 } cond_attr;
88
89 /** Const attributes. */
90 typedef struct {
91         tarval  *tv;       /**< the target value */
92         ir_type *tp;       /**< the source type, for analyses. default: type_unknown. */
93 } const_attr;
94
95 /** SymConst attributes. */
96 typedef struct {
97         symconst_symbol sym;  // old tori
98         symconst_kind num;
99         ir_type *tp;       /**< the source type, for analyses. default: type_unknown. */
100 } symconst_attr;
101
102 /** Sel attributes. */
103 typedef struct {
104         ir_entity *ent;    /**< entity to select */
105 } sel_attr;
106
107 /** Exception attributes. */
108 typedef struct {
109         op_pin_state   pin_state;     /**< the pin state for operations that might generate a exception:
110                                                                          If it's know that no exception will be generated, could be set to
111                                                                          op_pin_state_floats. */
112 #if PRECISE_EXC_CONTEXT
113         struct ir_node **frag_arr;    /**< For Phi node construction in case of exception */
114 #endif
115 } except_attr;
116
117 /** Call attributes. */
118 typedef struct {
119         except_attr    exc;           /**< the exception attribute. MUST be the first one. */
120         ir_type *cld_tp;              /**< type of called procedure */
121         ir_entity ** callee_arr;      /**< result of callee analysis */
122 } call_attr;
123
124 /** Alloc attributes. */
125 typedef struct {
126         except_attr    exc;           /**< the exception attribute. MUST be the first one. */
127         ir_type *type;                /**< Type of the allocated object.  */
128         where_alloc where;            /**< stack, heap or other managed part of memory */
129 } alloc_attr;
130
131 /** Free attributes. */
132 typedef struct {
133         ir_type *type;                /**< Type of the allocated object.  */
134         where_alloc where;            /**< stack, heap or other managed part of memory */
135 } free_attr;
136
137 /** InstOf attributes. */
138 typedef struct {
139         except_attr    exc;           /**< the exception attribute. MUST be the first one. */
140         ir_type *type;                /**< the type of which the object pointer must be */
141 } io_attr;
142
143 /** Filter attributes. */
144 typedef struct {
145         long proj;                 /**< contains the result position to project (Proj) */
146         ir_node ** in_cg;          /**< array with interprocedural predecessors (Phi) */
147         int *backedge;             /**< Field n set to true if pred n is backedge.
148                                         @todo Ev. replace by bitfield! */
149 } filter_attr;
150
151 /** CallBegin attributes. */
152 typedef struct {
153         ir_node * call;               /**< Associated Call-operation. */
154 } callbegin_attr;
155
156 /** Cast attributes. */
157 typedef struct {
158         ir_type *totype;              /**< Type of the casted node. */
159 } cast_attr;
160
161 /** Load attributes. */
162 typedef struct {
163         except_attr   exc;            /**< The exception attribute. MUST be the first one. */
164         ir_mode       *load_mode;     /**< The mode of this Load operation. */
165         ir_volatility volatility;     /**< The volatility of a Load/Store operation. */
166 } load_attr;
167
168 /** Store attributes. */
169 typedef struct {
170         except_attr   exc;            /**< the exception attribute. MUST be the first one. */
171         ir_volatility volatility;     /**< the volatility of a Store operation */
172 } store_attr;
173
174 typedef struct {
175         int            pos;  /**< For Phi. Used to remember the value defined by
176                          this Phi node.  Needed when the Phi is completed
177                          to call get_r_internal_value to find the
178                          predecessors. If this attribute is set, the Phi
179                          node takes the role of the obsolete Phi0 node,
180                          therefore the name. */
181 } phi0_attr;
182
183
184 typedef pn_Cmp confirm_attr;    /**< Attribute to hold compare operation */
185
186 /** CopyB attribute. */
187 typedef struct {
188         except_attr    exc;           /**< The exception attribute. MUST be the first one. */
189         ir_type        *data_type;    /**< Type of the copied entity. */
190 } copyb_attr;
191
192 /** Bound attribute. */
193 typedef struct {
194         except_attr exc;              /**< The exception attribute. MUST be the first one. */
195 } bound_attr;
196
197 /** Conv attribute. */
198 typedef struct {
199         char           strict;        /**< If set, this is a strict Conv that cannot be removed. */
200 } conv_attr;
201
202 /** Div/Mod/DivMod/Quot attribute. */
203 typedef struct {
204         except_attr    exc;           /**< The exception attribute. MUST be the first one. */
205         ir_mode        *res_mode;     /**< Result mode for the division. */
206 } divmod_attr;
207
208 /** Inline Assembler support attribute. */
209 typedef struct {
210         ident          *asm_text;     /**< The inline assembler text. */
211 } asm_attr;
212
213 /** Some IR-nodes just have one attribute, these are stored here,
214    some have more. Their name is 'irnodename_attr' */
215 typedef union {
216         block_attr     block;         /**< For Block: Fields needed to construct it */
217         cond_attr      cond;          /**< For Cond. */
218         const_attr     con;           /**< For Const: contains the value of the constant and a type */
219         symconst_attr  symc;          /**< For SymConst. */
220         sel_attr       sel;           /**< For Sel. */
221         call_attr      call;          /**< For Call: pointer to the type of the method to call */
222         callbegin_attr callbegin;     /**< For CallBegin */
223         alloc_attr     alloc;         /**< For Alloc. */
224         free_attr      free;          /**< For Free. */
225         io_attr        instof;        /**< For InstOf */
226         cast_attr      cast;          /**< For Cast. */
227         load_attr      load;          /**< For Load. */
228         store_attr     store;         /**< For Store. */
229         phi0_attr      phi0;          /**< for Phi0 nodes. */
230         int            *phi_backedge; /**< For Phi after construction.
231                                            Field n set to true if pred n is backedge.
232                                            @todo Ev. replace by bitfield! */
233         long           proj;          /**< For Proj: contains the result position to project */
234         confirm_attr   confirm_cmp;   /**< For Confirm: compare operation */
235         filter_attr    filter;        /**< For Filter */
236         except_attr    except;        /**< For Phi node construction in case of exceptions */
237         copyb_attr     copyb;         /**< For CopyB operation */
238         bound_attr     bound;         /**< For Bound operation */
239         conv_attr      conv;          /**< For Conv operation */
240         divmod_attr    divmod;        /**< For Div/Mod/DivMod operation */
241         asm_attr       asm;           /**< For ASM operation. */
242 } attr;
243
244 /**
245  * Edge info to put into an irn.
246  */
247 typedef struct _irn_edge_kind_info_t {
248         struct list_head outs_head;  /**< The list of all outs. */
249         int out_count;               /**< Number of outs in the list. */
250 } irn_edge_info_t;
251
252 typedef irn_edge_info_t irn_edges_info_t[EDGE_KIND_LAST];
253
254 /**
255  * The common structure of an irnode.
256  * If the node has some attributes, they are stored in the attr field.
257  */
258 struct ir_node {
259         /* ------- Basics of the representation  ------- */
260         firm_kind kind;          /**< Distinguishes this node from others. */
261         ir_op *op;               /**< The Opcode of this node. */
262         ir_mode *mode;           /**< The Mode of this node. */
263         struct ir_node **in;     /**< The array of predecessors / operands. */
264         unsigned long visited;   /**< The visited counter for walks of the graph. */
265         unsigned node_idx;       /**< The node index of this node in its graph. */
266         void *link;              /**< To attach additional information to the node, e.g.
267                                       used while construction to link Phi0 nodes and
268                                       during optimization to link to nodes that
269                                       shall replace a node. */
270         /* ------- Fields for optimizations / analysis information ------- */
271         struct ir_node **out;    /**< @deprecated array of out edges. */
272         struct dbg_info *dbi;    /**< A pointer to information for debug support. */
273         /* ------- For debugging ------- */
274 #ifdef DEBUG_libfirm
275         int out_valid;
276         long node_nr;            /**< A unique node number for each node to make output
277                                       readable. */
278 #endif
279         /* ------- For analyses -------- */
280         ir_loop *loop;           /**< the loop the node is in. Access routines in irloop.h */
281 #ifdef DO_HEAPANALYSIS
282         struct abstval *av;      /**< Heapanalysis: The abstract value of this node. */
283         struct section *sec;     /**< Heapanalysis: The section of this node. */
284 #endif
285         struct ir_node **deps;   /**< Additional dependencies induced by state. */
286         irn_edges_info_t edge_info;  /**< Everlasting out edges. */
287         /* ------- Opcode depending fields -------- */
288         attr attr;               /**< The set of attributes of this node. Depends on opcode.
289                                       Must be last field of struct ir_node. */
290 };
291
292
293 /**
294  * Returns the array with the ins.  The content of the array may not be
295  * changed.
296  * Note that this function returns the whole in array including the
297  * block predecessor. So, it is NOT symmetric with set_irn_in().
298  */
299 ir_node     **get_irn_in            (const ir_node *node);
300
301 /** @{ */
302 /** access attributes directly */
303 const_attr    get_irn_const_attr    (ir_node *node);
304 long          get_irn_proj_attr     (ir_node *node);
305 alloc_attr    get_irn_alloc_attr    (ir_node *node);
306 free_attr     get_irn_free_attr     (ir_node *node);
307 symconst_attr get_irn_symconst_attr (ir_node *node);
308 ir_type      *get_irn_call_attr     (ir_node *node);
309 ir_type      *get_irn_funccall_attr (ir_node *node);
310 sel_attr      get_irn_sel_attr      (ir_node *node);
311 int           get_irn_phi0_attr     (ir_node *node);
312 block_attr    get_irn_block_attr    (ir_node *node);
313 load_attr     get_irn_load_attr     (ir_node *node);
314 store_attr    get_irn_store_attr    (ir_node *node);
315 except_attr   get_irn_except_attr   (ir_node *node);
316 /** @} */
317
318 /**
319  * The amount of additional space for custom data to be allocated upon creating a new node.
320  */
321 extern unsigned firm_add_node_size;
322
323 /**
324  * Sets the get_type operation for an ir_op_ops.
325  *
326  * @param code   the opcode for the default operation
327  * @param ops    the operations initialized
328  *
329  * @return
330  *    The operations.
331  */
332 ir_op_ops *firm_set_default_get_type(ir_opcode code, ir_op_ops *ops);
333
334 /**
335  * Sets the get_type_attr operation for an ir_op_ops.
336  *
337  * @param code   the opcode for the default operation
338  * @param ops    the operations initialized
339  *
340  * @return
341  *    The operations.
342  */
343 ir_op_ops *firm_set_default_get_type_attr(ir_opcode code, ir_op_ops *ops);
344
345 /**
346  * Sets the get_entity_attr operation for an ir_op_ops.
347  *
348  * @param code   the opcode for the default operation
349  * @param ops    the operations initialized
350  *
351  * @return
352  *    The operations.
353  */
354 ir_op_ops *firm_set_default_get_entity_attr(ir_opcode code, ir_op_ops *ops);
355
356 /*-------------------------------------------------------------------*/
357 /*  These function are most used in libfirm.  Give them as static    */
358 /*  functions so they can be inlined.                                */
359 /*-------------------------------------------------------------------*/
360
361 /**
362  * Checks whether a pointer points to a ir node.
363  * Intern version for libFirm.
364  */
365 static INLINE int
366 _is_ir_node(const void *thing) {
367         return (get_kind(thing) == k_ir_node);
368 }
369
370 /**
371  * Gets the op of a node.
372  * Intern version for libFirm.
373  */
374 static INLINE ir_op *
375 _get_irn_op(const ir_node *node) {
376         assert(node);
377         return node->op;
378 }
379
380 static INLINE void
381 _set_irn_op(ir_node *node, ir_op *op) {
382         assert(node);
383         node->op = op;
384 }
385
386 /** Copies all attributes stored in the old node  to the new node.
387     Assumes both have the same opcode and sufficient size. */
388 static INLINE void
389 copy_node_attr(const ir_node *old_node, ir_node *new_node) {
390         ir_op *op = _get_irn_op(old_node);
391
392         /* must always exist */
393         op->ops.copy_attr(old_node, new_node);
394 }
395
396 /**
397  * Gets the opcode of a node.
398  * Intern version for libFirm.
399  */
400 static INLINE ir_opcode
401 _get_irn_opcode(const ir_node *node) {
402         assert(k_ir_node == get_kind(node));
403         assert(node->op);
404         return node->op->code;
405 }
406
407 /**
408  * Returns the number of predecessors without the block predecessor.
409  * Intern version for libFirm.
410  */
411 static INLINE int
412 _get_irn_intra_arity(const ir_node *node) {
413         assert(node);
414         return ARR_LEN(node->in) - 1;
415 }
416
417 /**
418  * Returns the number of predecessors without the block predecessor.
419  * Intern version for libFirm.
420  */
421 static INLINE int
422 _get_irn_inter_arity(const ir_node *node) {
423         assert(node);
424         if (_get_irn_op(node) == op_Filter) {
425                 assert(node->attr.filter.in_cg);
426                 return ARR_LEN(node->attr.filter.in_cg) - 1;
427         } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
428                 return ARR_LEN(node->attr.block.in_cg) - 1;
429         }
430         return _get_irn_intra_arity(node);
431 }
432
433 /**
434  * Returns the number of predecessors without the block predecessor.
435  * Intern version for libFirm.
436  */
437 extern int (*_get_irn_arity)(const ir_node *node);
438
439 /**
440  * Intern version for libFirm.
441  */
442 static INLINE ir_node *
443 _get_irn_intra_n(const ir_node *node, int n) {
444         ir_node *nn;
445
446         int arn = _get_irn_intra_arity(node);
447         assert(node);
448         assert(-1 <= n && n < _get_irn_intra_arity(node));
449
450         nn = node->in[n + 1];
451         if (nn == NULL) {
452                 /* only block inputs are allowed to be NULL */
453                 assert(n == -1 && "NULL input of a node");
454                 return NULL;
455         }
456         if (nn->op != op_Id) return nn;
457
458         return (node->in[n + 1] = skip_Id(nn));
459 }
460
461 /**
462  * Intern version for libFirm.
463  */
464 static INLINE ir_node*
465 _get_irn_inter_n(const ir_node *node, int n) {
466         assert(node); assert(-1 <= n && n < _get_irn_inter_arity(node));
467
468         /* handle Filter and Block specially */
469         if (_get_irn_op(node) == op_Filter) {
470                 assert(node->attr.filter.in_cg);
471                 return (node->attr.filter.in_cg[n + 1] = skip_Id(node->attr.filter.in_cg[n + 1]));
472         } else if (_get_irn_op(node) == op_Block && node->attr.block.in_cg) {
473                 return (node->attr.block.in_cg[n + 1] = skip_Id(node->attr.block.in_cg[n + 1]));
474         }
475
476         return _get_irn_intra_n(node, n);
477 }
478
479 /**
480  * Access to the predecessors of a node.
481  * To iterate over the operands iterate from 0 to i < get_irn_arity(),
482  * to iterate including the Block predecessor iterate from i = -1 to
483  * i < get_irn_arity.
484  * If it is a block, the entry -1 is NULL.
485  * Intern version for libFirm.
486  */
487 extern ir_node *(*_get_irn_n)(const ir_node *node, int n);
488
489 static INLINE int _get_irn_deps(const ir_node *node) {
490         return node->deps ? ARR_LEN(node->deps) : 0;
491 }
492
493 static INLINE ir_node *_get_irn_dep(const ir_node *node, int pos) {
494         assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
495         assert(pos >= 0 && pos < ARR_LEN(node->deps) && "dependency index out of range");
496         return node->deps[pos];
497 }
498
499 static INLINE void
500 _set_irn_dep(ir_node *node, int pos, ir_node *dep) {
501         ir_node *old;
502
503         assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
504         assert(pos >= 0 && pos < ARR_LEN(node->deps) && "dependency index out of range");
505         old = node->deps[pos];
506         node->deps[pos] = dep;
507         edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
508 }
509
510
511 static INLINE int
512 _get_irn_ins_or_deps(const ir_node *irn) {
513         return _get_irn_deps(irn) + _get_irn_arity(irn);
514 }
515
516 static INLINE ir_node *
517 _get_irn_in_or_dep(const ir_node *irn, int pos) {
518         int n_in = get_irn_arity(irn);
519         return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
520 }
521
522 /**
523  * Gets the mode of a node.
524  * Intern version for libFirm.
525  */
526 static INLINE ir_mode *
527 _get_irn_mode(const ir_node *node) {
528         assert(node);
529         return node->mode;
530 }
531
532 /**
533  * Sets the mode of a node.
534  * Intern version of libFirm.
535  */
536 static INLINE void
537 _set_irn_mode(ir_node *node, ir_mode *mode) {
538         assert(node);
539         node->mode = mode;
540 }
541
542 /**
543  * Gets the visited counter of a node.
544  * Intern version for libFirm.
545  */
546 static INLINE unsigned long
547 _get_irn_visited(const ir_node *node) {
548         assert(node);
549         return node->visited;
550 }
551
552 /**
553  * Sets the visited counter of a node.
554  * Intern version for libFirm.
555  */
556 static INLINE void
557 _set_irn_visited(ir_node *node, unsigned long visited) {
558         assert(node);
559         node->visited = visited;
560 }
561
562 /**
563  * Mark a node as visited in a graph.
564  * Intern version for libFirm.
565  */
566 static INLINE void
567 _mark_irn_visited(ir_node *node) {
568         assert(node);
569         node->visited = current_ir_graph->visited;
570 }
571
572 /**
573  * Returns non-zero if a node of was visited.
574  * Intern version for libFirm.
575  */
576 static INLINE int
577 _irn_visited(const ir_node *node) {
578         assert(node);
579         return (node->visited >= current_ir_graph->visited);
580 }
581
582 /**
583  * Returns non-zero if a node of was NOT visited.
584  * Intern version for libFirm.
585  */
586 static INLINE int
587 _irn_not_visited(const ir_node *node) {
588         assert(node);
589         return (node->visited < current_ir_graph->visited);
590 }
591
592 /**
593  * Sets the link of a node.
594  * Intern version of libFirm.
595  */
596 static INLINE void
597 _set_irn_link(ir_node *node, void *link) {
598   assert(node);
599         /* Link field is used for Phi construction and various optimizations
600            in iropt. */
601         assert(get_irg_phase_state(get_irn_irg(node)) != phase_building);
602
603         node->link = link;
604 }
605
606 /**
607  * Returns the link of a node.
608  * Intern version of libFirm.
609  */
610 static INLINE void *
611 _get_irn_link(const ir_node *node) {
612         assert(node && _is_ir_node(node));
613         return node->link;
614 }
615
616 /**
617  * Returns whether the node _always_ must be pinned.
618  * I.e., the node is not floating after global cse.
619  *
620  * Intern version of libFirm.
621  */
622 static INLINE op_pin_state
623 _get_irn_pinned(const ir_node *node) {
624         op_pin_state state;
625         assert(node && _is_ir_node(node));
626         /* Check opcode */
627         state = _get_op_pinned(_get_irn_op(node));
628
629         if (state >= op_pin_state_exc_pinned)
630                 return get_opt_fragile_ops() ? node->attr.except.pin_state : op_pin_state_pinned;
631         return state;
632 }
633
634 static INLINE op_pin_state
635 _is_irn_pinned_in_irg(const ir_node *node) {
636         if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
637                 return get_irn_pinned(node);
638         return op_pin_state_pinned;
639 }
640
641 static INLINE int
642 _is_unop(const ir_node *node) {
643         assert(node && _is_ir_node(node));
644         return (node->op->opar == oparity_unary);
645 }
646
647 static INLINE int
648 _is_binop(const ir_node *node) {
649         assert(node && _is_ir_node(node));
650         return (node->op->opar == oparity_binary);
651 }
652
653 static INLINE int
654 _is_Bad(const ir_node *node) {
655         assert(node);
656         return (_get_irn_op(node) == op_Bad);
657 }
658
659 static INLINE int
660 _is_NoMem(const ir_node *node) {
661         assert(node);
662         return (_get_irn_op(node) == op_NoMem);
663 }
664
665 static INLINE int
666 _is_Mod(const ir_node *node) {
667         assert(node);
668         return (_get_irn_op(node) == op_Mod);
669 }
670
671 static INLINE int
672 _is_Div(const ir_node *node) {
673         assert(node);
674         return (_get_irn_op(node) == op_Div);
675 }
676
677 static INLINE int
678 _is_DivMod(const ir_node *node) {
679         assert(node);
680         return (_get_irn_op(node) == op_DivMod);
681 }
682
683 static INLINE int
684 _is_Quot(const ir_node *node) {
685         assert(node);
686         return (_get_irn_op(node) == op_Quot);
687 }
688
689 static INLINE int
690 _is_Add(const ir_node *node) {
691         assert(node);
692         return (_get_irn_op(node) == op_Add);
693 }
694
695 static INLINE int
696 _is_Sub(const ir_node *node) {
697         assert(node);
698         return (_get_irn_op(node) == op_Sub);
699 }
700
701 static INLINE int
702 _is_Start(const ir_node *node) {
703         assert(node);
704         return (_get_irn_op(node) == op_Start);
705 }
706
707 static INLINE int
708 _is_End(const ir_node *node) {
709         assert(node);
710         return (_get_irn_op(node) == op_End);
711 }
712
713 static INLINE int
714 _is_Const(const ir_node *node) {
715         assert(node);
716         return (_get_irn_op(node) == op_Const);
717 }
718
719 static INLINE int
720 _is_Conv(const ir_node *node) {
721         assert(node);
722         return (_get_irn_op(node) == op_Conv);
723 }
724
725 static INLINE int
726 _is_CopyB(const ir_node *node) {
727         assert(node);
728         return (_get_irn_op(node) == op_CopyB);
729 }
730
731 static INLINE int
732 _is_Unknown(const ir_node *node) {
733         assert(node);
734         return (_get_irn_op(node) == op_Unknown);
735 }
736
737 static INLINE int
738 _is_Return(const ir_node *node) {
739         assert(node);
740         return (_get_irn_op(node) == op_Return);
741 }
742
743 static INLINE int
744 _is_Call(const ir_node *node) {
745         assert(node);
746         return (_get_irn_op(node) == op_Call);
747 }
748
749 static INLINE int
750 _is_Sel(const ir_node *node) {
751         assert(node);
752         return (_get_irn_op(node) == op_Sel);
753 }
754
755 static INLINE int
756 _is_Mul(const ir_node *node) {
757         assert(node);
758         return (_get_irn_op(node) == op_Mul);
759 }
760
761 static INLINE int
762 _is_Mux(const ir_node *node) {
763         assert(node);
764         if (node) {
765                 ir_op *op = _get_irn_op(node);
766                 return (op == op_Mux || ((op == op_Psi) && _get_irn_arity(node) == 3));
767         }
768         return 0;
769 }
770
771 static INLINE int
772 _is_Load(const ir_node *node) {
773         assert(node);
774         return (_get_irn_op(node) == op_Load);
775 }
776
777 static INLINE int
778 _is_Store(const ir_node *node) {
779         assert(node);
780         return (_get_irn_op(node) == op_Store);
781 }
782
783 static INLINE int
784 _is_Sync(const ir_node *node) {
785         assert(node);
786         return (_get_irn_op(node) == op_Sync);
787 }
788
789 static INLINE int
790 _is_Confirm(const ir_node *node) {
791         assert(node);
792         return (_get_irn_op(node) == op_Confirm);
793 }
794
795 static INLINE int
796 _is_Pin(const ir_node *node) {
797         assert(node);
798         return (_get_irn_op(node) == op_Pin);
799 }
800
801 static INLINE int
802 _is_SymConst(const ir_node *node) {
803         assert(node);
804         return (_get_irn_op(node) == op_SymConst);
805 }
806
807 static INLINE int
808 _is_Cond(const ir_node *node) {
809         assert(node);
810         return (_get_irn_op(node) == op_Cond);
811 }
812
813 static INLINE int
814 _is_Cmp(const ir_node *node) {
815         assert(node);
816         return (_get_irn_op(node) == op_Cmp);
817 }
818
819 static INLINE int
820 _is_Alloc(const ir_node *node) {
821         assert(node);
822         return (_get_irn_op(node) == op_Alloc);
823 }
824
825 static INLINE int
826 _is_Jmp(const ir_node *node) {
827         assert(node);
828         return (_get_irn_op(node) == op_Jmp);
829 }
830
831 static INLINE int
832 _is_Raise(const ir_node *node) {
833         assert(node);
834         return (_get_irn_op(node) == op_Raise);
835 }
836
837 static INLINE int
838 _is_no_Block(const ir_node *node) {
839         assert(node && _is_ir_node(node));
840         return (_get_irn_op(node) != op_Block);
841 }
842
843 static INLINE int
844 _is_Block(const ir_node *node) {
845         assert(node && _is_ir_node(node));
846         return (_get_irn_op(node) == op_Block);
847 }
848
849 static INLINE int
850 _get_Block_n_cfgpreds(const ir_node *node) {
851         assert(_is_Block(node));
852         return _get_irn_arity(node);
853 }
854
855 static INLINE ir_node *
856 _get_Block_cfgpred(ir_node *node, int pos) {
857         assert(0 <= pos && pos < get_irn_arity(node));
858         assert(_is_Block(node));
859         return _get_irn_n(node, pos);
860 }
861
862 /* Get the predecessor block.
863  *
864  *  Returns the block corresponding to the predecessor pos.
865  *
866  *  There are several ambiguities we resolve with this function:
867  *  - The direct predecessor can be a Proj, which is not pinned.
868  *    We walk from the predecessor to the next pinned node
869  *    (skip_Proj) and return the block that node is in.
870  *  - If we encounter the Bad node, this function does not return
871  *    Start, but the Bad node.
872  */
873 static INLINE ir_node  *
874 _get_Block_cfgpred_block(ir_node *node, int pos) {
875         ir_node *res = skip_Proj(get_Block_cfgpred(node, pos));
876         if (!is_Bad(res))
877                 res = get_nodes_block(res);
878         return res;
879 }
880
881 static INLINE unsigned long
882 _get_Block_block_visited(const ir_node *node) {
883         assert(node->op == op_Block);
884         return node->attr.block.block_visited;
885 }
886
887 static INLINE void
888 _set_Block_block_visited(ir_node *node, unsigned long visit) {
889         assert(node->op == op_Block);
890         node->attr.block.block_visited = visit;
891 }
892
893 /* For this current_ir_graph must be set. */
894 static INLINE void
895 _mark_Block_block_visited(ir_node *node) {
896         assert(node->op == op_Block);
897         node->attr.block.block_visited = get_irg_block_visited(current_ir_graph);
898 }
899
900 static INLINE int
901 _Block_not_block_visited(const ir_node *node) {
902         assert(node->op == op_Block);
903         return (node->attr.block.block_visited < get_irg_block_visited(current_ir_graph));
904 }
905
906 static INLINE int
907 _Block_block_visited(const ir_node *node) {
908         assert(node->op == op_Block);
909         return (node->attr.block.block_visited >= get_irg_block_visited(current_ir_graph));
910 }
911
912 static INLINE ir_node *
913 _set_Block_dead(ir_node *block) {
914         assert(_get_irn_op(block) == op_Block);
915         block->attr.block.is_dead = 1;
916         return block;
917 }
918
919 static INLINE int
920 _is_Block_dead(const ir_node *block) {
921         ir_op *op = _get_irn_op(block);
922
923         if (op == op_Bad)
924                 return 1;
925         else {
926                 assert(op == op_Block);
927                 return block->attr.block.is_dead;
928         }
929 }
930
931 static INLINE tarval *_get_Const_tarval(const ir_node *node) {
932         assert(_get_irn_op(node) == op_Const);
933         return node->attr.con.tv;
934 }
935
936 static INLINE cnst_classify_t _classify_Const(ir_node *node) {
937         ir_op *op;
938         assert(_is_ir_node(node));
939
940         op = _get_irn_op(node);
941
942         if (op == op_Const)
943                 return classify_tarval(_get_Const_tarval(node));
944         else if(op == op_SymConst)
945                 return CNST_SYMCONST;
946
947         return CNST_NO_CONST;
948 }
949
950 static INLINE int _is_irn_forking(const ir_node *node) {
951         return is_op_forking(_get_irn_op(node));
952 }
953
954 static INLINE ir_type *_get_irn_type(ir_node *node) {
955         return _get_irn_op(node)->ops.get_type(node);
956 }
957
958 static INLINE ir_type *_get_irn_type_attr(ir_node *node) {
959         return _get_irn_op(node)->ops.get_type_attr(node);
960 }
961
962 static INLINE ir_entity *_get_irn_entity_attr(ir_node *node) {
963   return _get_irn_op(node)->ops.get_entity_attr(node);
964 }
965
966 static INLINE int _is_irn_constlike(const ir_node *node) {
967         return is_op_constlike(_get_irn_op(node));
968 }
969
970 static INLINE int _is_irn_always_opt(const ir_node *node) {
971         return is_op_always_opt(_get_irn_op(node));
972 }
973
974 static INLINE int _is_irn_keep(const ir_node *node) {
975         return is_op_keep(_get_irn_op(node));
976 }
977
978 static INLINE int _is_irn_start_block_placed(const ir_node *node) {
979         return is_op_start_block_placed(_get_irn_op(node));
980 }
981
982 static INLINE int _is_irn_machine_op(const ir_node *node) {
983         return is_op_machine(_get_irn_op(node));
984 }
985
986 static INLINE int _is_irn_machine_operand(const ir_node *node) {
987         return is_op_machine_operand(_get_irn_op(node));
988 }
989
990 static INLINE int _is_irn_machine_user(const ir_node *node, unsigned n) {
991         return is_op_machine_user(_get_irn_op(node), n);
992 }
993
994 static INLINE cond_jmp_predicate _get_Cond_jmp_pred(const ir_node *node) {
995         assert(_get_irn_op(node) == op_Cond);
996         return node->attr.cond.pred;
997 }
998
999 static INLINE void _set_Cond_jmp_pred(ir_node *node, cond_jmp_predicate pred) {
1000         assert(_get_irn_op(node) == op_Cond);
1001         node->attr.cond.pred = pred;
1002 }
1003
1004 static INLINE int _get_Psi_n_conds(ir_node *node) {
1005         assert(_get_irn_op(node) == op_Psi);
1006         return _get_irn_arity(node) >> 1;
1007 }
1008
1009 static INLINE void *_get_irn_generic_attr(ir_node *node) {
1010         return &node->attr;
1011 }
1012
1013 static INLINE const void *_get_irn_generic_attr_const(const ir_node *node) {
1014         return &node->attr;
1015 }
1016
1017 static INLINE unsigned _get_irn_idx(const ir_node *node) {
1018         return node->node_idx;
1019 }
1020
1021 /* this section MUST contain all inline functions */
1022 #define is_ir_node(thing)                     _is_ir_node(thing)
1023 #define get_irn_intra_arity(node)             _get_irn_intra_arity(node)
1024 #define get_irn_inter_arity(node)             _get_irn_inter_arity(node)
1025 #define get_irn_arity(node)                   _get_irn_arity(node)
1026 #define get_irn_intra_n(node, n)              _get_irn_intra_n(node, n)
1027 #define get_irn_inter_n(node, n)              _get_irn_inter_n(node, n)
1028 #define get_irn_n(node, n)                    _get_irn_n(node, n)
1029 #define get_irn_mode(node)                    _get_irn_mode(node)
1030 #define set_irn_mode(node, mode)              _set_irn_mode(node, mode)
1031 #define get_irn_op(node)                      _get_irn_op(node)
1032 #define set_irn_op(node, op)                  _set_irn_op(node, op)
1033 #define get_irn_opcode(node)                  _get_irn_opcode(node)
1034 #define get_irn_visited(node)                 _get_irn_visited(node)
1035 #define set_irn_visited(node, v)              _set_irn_visited(node, v)
1036 #define mark_irn_visited(node)                _mark_irn_visited(node)
1037 #define irn_visited(node)                     _irn_visited(node)
1038 #define irn_not_visited(node)                 _irn_not_visited(node)
1039 #define set_irn_link(node, link)              _set_irn_link(node, link)
1040 #define get_irn_link(node)                    _get_irn_link(node)
1041 #define get_irn_pinned(node)                  _get_irn_pinned(node)
1042 #define is_irn_pinned_in_irg(node)            _is_irn_pinned_in_irg(node)
1043 #define is_unop(node)                         _is_unop(node)
1044 #define is_binop(node)                        _is_binop(node)
1045 #define is_Const(node)                        _is_Const(node)
1046 #define is_Conv(node)                         _is_Conv(node)
1047 #define is_Unknown(node)                      _is_Unknown(node)
1048 #define is_Return(node)                       _is_Return(node)
1049 #define is_Call(node)                         _is_Call(node)
1050 #define is_Sel(node)                          _is_Sel(node)
1051 #define is_Mul(node)                          _is_Mul(node)
1052 #define is_Mux(node)                          _is_Mux(node)
1053 #define is_Load(node)                         _is_Load(node)
1054 #define is_Sync(node)                         _is_Sync(node)
1055 #define is_Confirm(node)                      _is_Confirm(node)
1056 #define is_Pin(node)                          _is_Pin(node)
1057 #define is_SymConst(node)                     _is_SymConst(node)
1058 #define is_Cond(node)                         _is_Cond(node)
1059 #define is_CopyB(node)                        _is_CopyB(node)
1060 #define is_Cmp(node)                          _is_Cmp(node)
1061 #define is_Alloc(node)                        _is_Alloc(node)
1062 #define is_Jmp(node)                          _is_Jmp(node)
1063 #define is_Raise(node)                        _is_Raise(node)
1064 #define is_Bad(node)                          _is_Bad(node)
1065 #define is_NoMem(node)                        _is_NoMem(node)
1066 #define is_Start(node)                        _is_Start(node)
1067 #define is_End(node)                          _is_End(node)
1068 #define is_Mod(node)                          _is_Mod(node)
1069 #define is_Div(node)                          _is_Div(node)
1070 #define is_DivMod(node)                       _is_DivMod(node)
1071 #define is_Quot(node)                         _is_Quot(node)
1072 #define is_Add(node)                          _is_Add(node)
1073 #define is_Sub(node)                          _is_Sub(node)
1074 #define is_no_Block(node)                     _is_no_Block(node)
1075 #define is_Block(node)                        _is_Block(node)
1076 #define get_Block_n_cfgpreds(node)            _get_Block_n_cfgpreds(node)
1077 #define get_Block_cfgpred(node, pos)          _get_Block_cfgpred(node, pos)
1078 #define get_Block_cfgpred_block(node, pos)    _get_Block_cfgpred_block(node, pos)
1079 #define get_Block_block_visited(node)         _get_Block_block_visited(node)
1080 #define set_Block_block_visited(node, visit)  _set_Block_block_visited(node, visit)
1081 #define mark_Block_block_visited(node)        _mark_Block_block_visited(node)
1082 #define Block_not_block_visited(node)         _Block_not_block_visited(node)
1083 #define Block_block_visited(node)             _Block_block_visited(node)
1084 #define set_Block_dead(block)                 _set_Block_dead(block)
1085 #define is_Block_dead(block)                  _is_Block_dead(block)
1086 #define get_Const_tarval(node)                _get_Const_tarval(node)
1087 #define classify_Const(node)                  _classify_Const(node)
1088 #define is_irn_forking(node)                  _is_irn_forking(node)
1089 #define get_irn_type(node)                    _get_irn_type(node)
1090 #define get_irn_type_attr(node)               _get_irn_type_attr(node)
1091 #define get_irn_entity_attr(node)             _get_irn_entity_attr(node)
1092 #define is_irn_constlike(node)                _is_irn_constlike(node)
1093 #define is_irn_always_opt(node)               _is_irn_always_opt(node)
1094 #define is_irn_keep(node)                     _is_irn_keep(node)
1095 #define is_irn_start_block_placed(node)       _is_irn_start_block_placed(node)
1096 #define is_irn_machine_op(node)               _is_irn_machine_op(node)
1097 #define is_irn_machine_operand(node)          _is_irn_machine_operand(node)
1098 #define is_irn_machine_user(node, n)          _is_irn_machine_user(node, n)
1099 #define get_Cond_jmp_pred(node)               _get_Cond_jmp_pred(node)
1100 #define set_Cond_jmp_pred(node, pred)         _set_Cond_jmp_pred(node, pred)
1101 #define get_Psi_n_conds(node)                 _get_Psi_n_conds(node)
1102 #define get_irn_generic_attr(node)            _get_irn_generic_attr(node)
1103 #define get_irn_generic_attr_const(node)      _get_irn_generic_attr_const(node)
1104 #define get_irn_idx(node)                     _get_irn_idx(node)
1105
1106 #define get_irn_deps(node)                    _get_irn_deps(node)
1107 #define set_irn_dep(node, pos, dep)           _set_irn_dep(node, pos, dep)
1108 #define get_irn_dep(node, pos)                _get_irn_dep(node, pos)
1109
1110 #define get_irn_ins_or_deps(node)             _get_irn_ins_or_deps(node)
1111 #define get_irn_in_or_dep(node, pos)          _get_irn_in_or_dep(node, pos)
1112
1113 #endif