Teach new_tarval_from_str_int() to parse binary numbers: 0[bB][01]+.
[libfirm] / ir / ir / irnode_t.h
1 /*
2  * Copyright (C) 1995-2008 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  */
25 #ifndef FIRM_IR_IRNODE_T_H
26 #define FIRM_IR_IRNODE_T_H
27
28 #include "irtypes.h"
29 #include "irnode.h"
30 #include "irop_t.h"
31 #include "irgraph_t.h"
32 #include "irflag_t.h"
33 #include "array.h"
34 #include "iredges_t.h"
35
36 /**
37  * Returns the array with the ins.  The content of the array may not be
38  * changed.
39  * Note that this function returns the whole in array including the
40  * block predecessor. So, it is NOT symmetric with set_irn_in().
41  */
42 ir_node **get_irn_in(const ir_node *node);
43
44 /**
45  * The amount of additional space for custom data to be allocated upon creating a new node.
46  */
47 extern unsigned firm_add_node_size;
48
49 /**
50  * Sets the get_type_attr operation for an ir_op_ops.
51  *
52  * @param code   the opcode for the default operation
53  * @param ops    the operations initialized
54  *
55  * @return
56  *    The operations.
57  */
58 void firm_set_default_get_type_attr(unsigned code, ir_op_ops *ops);
59
60 /**
61  * Sets the get_entity_attr operation for an ir_op_ops.
62  *
63  * @param code   the opcode for the default operation
64  * @param ops    the operations initialized
65  *
66  * @return
67  *    The operations.
68  */
69 void firm_set_default_get_entity_attr(unsigned code, ir_op_ops *ops);
70
71 /**
72  * Returns an array with the predecessors of the Block. Depending on
73  * the implementation of the graph data structure this can be a copy of
74  * the internal representation of predecessors as well as the internal
75  * array itself. Therefore writing to this array might obstruct the IR.
76  */
77 ir_node **get_Block_cfgpred_arr(ir_node *node);
78
79 /*-------------------------------------------------------------------*/
80 /*  These function are most used in libfirm.  Give them as static    */
81 /*  functions so they can be inlined.                                */
82 /*-------------------------------------------------------------------*/
83
84 /**
85  * Checks whether a pointer points to a ir node.
86  * Intern version for libFirm.
87  */
88 static inline int is_ir_node_(const void *thing)
89 {
90         return (get_kind(thing) == k_ir_node);
91 }
92
93 /**
94  * Gets the op of a node.
95  * Intern version for libFirm.
96  */
97 static inline ir_op *get_irn_op_(const ir_node *node)
98 {
99         assert(node);
100         return node->op;
101 }
102
103 static inline void set_irn_op_(ir_node *node, ir_op *op)
104 {
105         assert(node);
106         node->op = op;
107 }
108
109 /** Copies all attributes stored in the old node  to the new node.
110     Assumes both have the same opcode and sufficient size. */
111 static inline void copy_node_attr_(ir_graph *irg, const ir_node *old_node,
112                                    ir_node *new_node)
113 {
114         ir_op *op = get_irn_op_(old_node);
115
116         /* must always exist */
117         op->ops.copy_attr(irg, old_node, new_node);
118 }
119
120 /**
121  * Gets the opcode of a node.
122  * Intern version for libFirm.
123  */
124 static inline unsigned get_irn_opcode_(const ir_node *node)
125 {
126         assert(k_ir_node == get_kind(node));
127         assert(node->op);
128         return node->op->code;
129 }
130
131 /**
132  * Returns the number of predecessors without the block predecessor.
133  * Intern version for libFirm.
134  */
135 static inline int get_irn_arity_(const ir_node *node)
136 {
137         return (int)(ARR_LEN(node->in) - 1);
138 }
139
140 /**
141  * Intern version for libFirm.
142  */
143 static inline ir_node *get_irn_n_(const ir_node *node, int n)
144 {
145         ir_node *nn;
146
147         assert(-1 <= n && n < get_irn_arity_(node));
148
149         nn = node->in[n + 1];
150         if (nn->op != op_Id) return nn;
151
152         return (node->in[n + 1] = skip_Id(nn));
153 }
154
155 /**
156  * returns a hash value for a node
157  */
158 static inline unsigned hash_irn(const ir_node *node)
159 {
160         return (unsigned) get_irn_idx(node);
161 }
162
163 static inline int get_irn_deps_(const ir_node *node)
164 {
165         return node->deps ? (int)ARR_LEN(node->deps) : 0;
166 }
167
168 static inline ir_node *get_irn_dep_(const ir_node *node, int pos)
169 {
170         assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
171         assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
172         return node->deps[pos];
173 }
174
175 /* forward declaration outside iredges_t.h to avoid circular include problems */
176 void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
177
178 static inline void set_irn_dep_(ir_node *node, int pos, ir_node *dep)
179 {
180         ir_node *old;
181
182         assert(node->deps && "dependency array node yet allocated. use add_irn_dep()");
183         assert(pos >= 0 && pos < (int)ARR_LEN(node->deps) && "dependency index out of range");
184         old = node->deps[pos];
185         node->deps[pos] = dep;
186         edges_notify_edge_kind(node, pos, dep, old, EDGE_KIND_DEP, get_irn_irg(node));
187 }
188
189
190 static inline int get_irn_ins_or_deps_(const ir_node *irn)
191 {
192         return get_irn_deps_(irn) + get_irn_arity_(irn);
193 }
194
195 static inline ir_node *get_irn_in_or_dep_(const ir_node *irn, int pos)
196 {
197         int n_in = get_irn_arity(irn);
198         return pos < n_in ? get_irn_n(irn, pos) : get_irn_dep(irn, pos - n_in);
199 }
200
201 /**
202  * Gets the mode of a node.
203  * Intern version for libFirm.
204  */
205 static inline ir_mode *get_irn_mode_(const ir_node *node)
206 {
207         assert(node);
208         return node->mode;
209 }
210
211 /**
212  * Sets the mode of a node.
213  * Intern version of libFirm.
214  */
215 static inline void set_irn_mode_(ir_node *node, ir_mode *mode)
216 {
217         assert(node);
218         node->mode = mode;
219 }
220
221 static inline int ir_has_irg_ref(const ir_node *node)
222 {
223         return is_Block(node) || is_Bad(node) || is_Anchor(node);
224 }
225
226 static inline ir_graph *get_irn_irg_(const ir_node *node)
227 {
228         if (! is_Block(node))
229                 node = get_nodes_block(node);
230         assert(ir_has_irg_ref(node));
231         return node->attr.irg.irg;
232 }
233
234 static inline ir_node *get_nodes_block_(const ir_node *node)
235 {
236         assert(!is_Block(node));
237         return get_irn_n(node, -1);
238 }
239
240 /**
241  * Gets the visited counter of a node.
242  * Intern version for libFirm.
243  */
244 static inline ir_visited_t get_irn_visited_(const ir_node *node)
245 {
246         assert(node);
247         return node->visited;
248 }
249
250 /**
251  * Sets the visited counter of a node.
252  * Intern version for libFirm.
253  */
254 static inline void set_irn_visited_(ir_node *node, ir_visited_t visited)
255 {
256         assert(node);
257         node->visited = visited;
258 }
259
260 /**
261  * Mark a node as visited in a graph.
262  * Intern version for libFirm.
263  */
264 static inline void mark_irn_visited_(ir_node *node)
265 {
266         node->visited = get_irn_irg(node)->visited;
267 }
268
269 /**
270  * Returns non-zero if a node of was visited.
271  * Intern version for libFirm.
272  */
273 static inline int irn_visited_(const ir_node *node)
274 {
275         ir_graph *irg = get_irn_irg(node);
276         return node->visited >= irg->visited;
277 }
278
279 static inline int irn_visited_else_mark_(ir_node *node)
280 {
281         if (irn_visited_(node))
282                 return 1;
283         mark_irn_visited_(node);
284         return 0;
285 }
286
287 /**
288  * Sets the link of a node.
289  * Intern version of libFirm.
290  */
291 static inline void set_irn_link_(ir_node *node, void *link)
292 {
293         assert(node);
294         node->link = link;
295 }
296
297 /**
298  * Returns the link of a node.
299  * Intern version of libFirm.
300  */
301 static inline void *get_irn_link_(const ir_node *node)
302 {
303         assert(node && is_ir_node_(node));
304         return node->link;
305 }
306
307 /**
308  * Returns whether the node _always_ must be pinned.
309  * I.e., the node is not floating after global cse.
310  *
311  * Intern version of libFirm.
312  */
313 static inline op_pin_state get_irn_pinned_(const ir_node *node)
314 {
315         op_pin_state state;
316         assert(node && is_ir_node_(node));
317         /* Check opcode */
318         state = get_op_pinned_(get_irn_op_(node));
319
320         if (state >= op_pin_state_exc_pinned)
321                 return (op_pin_state)node->attr.except.pin_state;
322
323         return state;
324 }
325
326 static inline op_pin_state is_irn_pinned_in_irg_(const ir_node *node)
327 {
328         if (get_irg_pinned(get_irn_irg(node)) == op_pin_state_floats)
329                 return get_irn_pinned(node);
330         return op_pin_state_pinned;
331 }
332
333 /* include generated code */
334 #include "gen_irnode.h"
335
336 static inline int is_unop_(const ir_node *node)
337 {
338         assert(node && is_ir_node_(node));
339         return (node->op->opar == oparity_unary);
340 }
341
342 static inline int is_binop_(const ir_node *node)
343 {
344         assert(node && is_ir_node_(node));
345         return (node->op->opar == oparity_binary);
346 }
347
348 static inline int is_strictConv_(const ir_node *node)
349 {
350         return is_Conv_(node) && get_Conv_strict(node);
351 }
352
353 static inline int is_SymConst_addr_ent_(const ir_node *node)
354 {
355         return is_SymConst(node) && get_SymConst_kind(node) == symconst_addr_ent;
356 }
357
358 static inline int get_Block_n_cfgpreds_(const ir_node *node)
359 {
360         assert(is_Block_(node));
361         return get_irn_arity_(node);
362 }
363
364 static inline ir_node *get_Block_cfgpred_(const ir_node *node, int pos)
365 {
366         assert(is_Block_(node));
367         return get_irn_n_(node, pos);
368 }
369
370 /* Get the predecessor block.
371  *
372  *  Returns the block corresponding to the predecessor pos.
373  *
374  *  There are several ambiguities we resolve with this function:
375  *  - The direct predecessor can be a Proj, which is not pinned.
376  *    We walk from the predecessor to the next pinned node
377  *    (skip_Proj) and return the block that node is in.
378  *  - If we encounter the Bad node, this function does not return
379  *    the Start block, but the Bad node.
380  */
381 static inline ir_node *get_Block_cfgpred_block_(const ir_node *node, int pos)
382 {
383         ir_node *res = get_Block_cfgpred(node, pos);
384         if (is_Bad(res)) {
385                 /* must return a Bad with mode_BB! */
386                 ir_graph *irg = get_irn_irg(node);
387                 return new_r_Bad(irg, mode_BB);
388         } else {
389                 return get_nodes_block(skip_Proj(res));
390         }
391 }
392
393 static inline ir_visited_t get_Block_block_visited_(const ir_node *node)
394 {
395         assert(is_Block(node));
396         return node->attr.block.block_visited;
397 }
398
399 static inline void set_Block_block_visited_(ir_node *node, ir_visited_t visit)
400 {
401         assert(is_Block(node));
402         node->attr.block.block_visited = visit;
403 }
404
405 static inline void mark_Block_block_visited_(ir_node *node)
406 {
407         ir_graph *irg = get_Block_irg(node);
408         node->attr.block.block_visited = get_irg_block_visited(irg);
409 }
410
411 static inline int Block_block_visited_(const ir_node *node)
412 {
413         ir_graph *irg = get_Block_irg(node);
414         return node->attr.block.block_visited >= get_irg_block_visited(irg);
415 }
416
417 static inline ir_graph *get_Block_irg_(const ir_node *block)
418 {
419         assert(is_Block(block));
420         return block->attr.irg.irg;
421 }
422
423 static inline ir_tarval *get_Const_tarval_(const ir_node *node)
424 {
425         assert(get_irn_op_(node) == op_Const);
426         return node->attr.con.tarval;
427 }
428
429 static inline int is_Const_null_(const ir_node *node)
430 {
431         return tarval_is_null(get_Const_tarval_(node));
432 }
433
434 static inline int is_Const_one_(const ir_node *node)
435 {
436         return tarval_is_one(get_Const_tarval_(node));
437 }
438
439 static inline int is_Const_all_one_(const ir_node *node)
440 {
441         return tarval_is_all_one(get_Const_tarval_(node));
442 }
443
444 static inline int is_irn_forking_(const ir_node *node)
445 {
446         return is_op_forking(get_irn_op_(node));
447 }
448
449 static inline ir_type *get_irn_type_attr_(ir_node *node)
450 {
451         return get_irn_op_(node)->ops.get_type_attr(node);
452 }
453
454 static inline ir_entity *get_irn_entity_attr_(ir_node *node)
455 {
456         return get_irn_op_(node)->ops.get_entity_attr(node);
457 }
458
459 static inline int is_irn_constlike_(const ir_node *node)
460 {
461         return is_op_constlike(get_irn_op_(node));
462 }
463
464 static inline int is_irn_always_opt_(const ir_node *node)
465 {
466         return is_op_always_opt(get_irn_op_(node));
467 }
468
469 static inline int is_irn_keep_(const ir_node *node)
470 {
471         return is_op_keep(get_irn_op_(node));
472 }
473
474 static inline int is_irn_start_block_placed_(const ir_node *node)
475 {
476         return is_op_start_block_placed(get_irn_op_(node));
477 }
478
479 static inline int is_irn_cse_neutral_(const ir_node *node)
480 {
481         return is_op_cse_neutral(get_irn_op_(node));
482 }
483
484 static inline cond_jmp_predicate get_Cond_jmp_pred_(const ir_node *node)
485 {
486         assert(get_irn_op_(node) == op_Cond);
487         return node->attr.cond.jmp_pred;
488 }
489
490 static inline void set_Cond_jmp_pred_(ir_node *node, cond_jmp_predicate pred)
491 {
492         assert(get_irn_op_(node) == op_Cond);
493         node->attr.cond.jmp_pred = pred;
494 }
495
496 static inline void *get_irn_generic_attr_(ir_node *node)
497 {
498         return &node->attr;
499 }
500
501 static inline const void *get_irn_generic_attr_const_(const ir_node *node)
502 {
503         return &node->attr;
504 }
505
506 static inline unsigned get_irn_idx_(const ir_node *node)
507 {
508         return node->node_idx;
509 }
510
511 static inline dbg_info *get_irn_dbg_info_(const ir_node *n)
512 {
513         return n->dbi;
514 }
515
516 static inline void set_irn_dbg_info_(ir_node *n, dbg_info *db)
517 {
518         n->dbi = db;
519 }
520
521 /**
522  * Sets the Phi list of a block.
523  */
524 static inline void set_Block_phis_(ir_node *block, ir_node *phi)
525 {
526         assert(is_Block_(block));
527         assert(phi == NULL || is_Phi_(phi));
528         block->attr.block.phis = phi;
529 }
530
531 /**
532  * Returns the link of a node.
533  * Intern version of libFirm.
534  */
535 static inline ir_node *get_Block_phis_(const ir_node *block)
536 {
537         assert(is_Block_(block));
538         return block->attr.block.phis;
539 }
540
541 static inline void set_Phi_next_(ir_node *phi, ir_node *next)
542 {
543         assert(is_Phi_(phi));
544         phi->attr.phi.next = next;
545 }
546
547 static inline ir_node *get_Phi_next_(const ir_node *phi)
548 {
549         assert(is_Phi_(phi));
550         return phi->attr.phi.next;
551 }
552
553 /** Add a Phi node to the list of Block Phi's. */
554 static inline void add_Block_phi_(ir_node *block, ir_node *phi)
555 {
556         assert(is_Block_(block));
557         set_Phi_next_(phi, get_Block_phis_(block));
558         set_Block_phis_(block, phi);
559 }
560
561 /** Get the Block mark (single bit). */
562 static inline unsigned get_Block_mark_(const ir_node *block)
563 {
564         assert(is_Block_(block));
565         return block->attr.block.marked;
566 }
567
568 /** Set the Block mark (single bit). */
569 static inline void set_Block_mark_(ir_node *block, unsigned mark)
570 {
571         assert(is_Block_(block));
572         block->attr.block.marked = mark;
573 }
574
575 /** Returns non-zero if a node is a routine parameter. */
576 static inline int is_arg_Proj_(const ir_node *node)
577 {
578         if (! is_Proj(node))
579                 return 0;
580         node = get_Proj_pred(node);
581         if (! is_Proj(node))
582                 return 0;
583         return pn_Start_T_args == get_Proj_proj(node) && is_Start(get_Proj_pred(node));
584 }
585
586 static inline size_t ir_switch_table_get_n_entries_(const ir_switch_table *table)
587 {
588         return table->n_entries;
589 }
590
591 static inline ir_switch_table_entry *ir_switch_table_get_entry(
592                 ir_switch_table *table, size_t entry)
593 {
594         assert(entry < table->n_entries);
595         return &table->entries[entry];
596 }
597
598 static inline const ir_switch_table_entry *ir_switch_table_get_entry_const(
599                 const ir_switch_table *table, size_t entry)
600 {
601         assert(entry < table->n_entries);
602         return &table->entries[entry];
603 }
604
605 /** initialize ir_node module */
606 void init_irnode(void);
607
608 /* this section MUST contain all inline functions */
609 #define is_ir_node(thing)                     is_ir_node_(thing)
610 #define get_irn_arity(node)                   get_irn_arity_(node)
611 #define get_irn_n(node, n)                    get_irn_n_(node, n)
612 #define get_irn_mode(node)                    get_irn_mode_(node)
613 #define set_irn_mode(node, mode)              set_irn_mode_(node, mode)
614 #define get_irn_irg(node)                     get_irn_irg_(node)
615 #define get_nodes_block(node)                 get_nodes_block_(node)
616 #define get_irn_op(node)                      get_irn_op_(node)
617 #define set_irn_op(node, op)                  set_irn_op_(node, op)
618 #define get_irn_opcode(node)                  get_irn_opcode_(node)
619 #define get_irn_visited(node)                 get_irn_visited_(node)
620 #define set_irn_visited(node, v)              set_irn_visited_(node, v)
621 #define mark_irn_visited(node)                mark_irn_visited_(node)
622 #define irn_visited(node)                     irn_visited_(node)
623 #define irn_visited_else_mark(node)           irn_visited_else_mark_(node)
624 #define set_irn_link(node, link)              set_irn_link_(node, link)
625 #define get_irn_link(node)                    get_irn_link_(node)
626 #define get_irn_pinned(node)                  get_irn_pinned_(node)
627 #define is_irn_pinned_in_irg(node)            is_irn_pinned_in_irg_(node)
628 #define is_unop(node)                         is_unop_(node)
629 #define is_binop(node)                        is_binop_(node)
630 #define is_Proj(node)                         is_Proj_(node)
631 #define is_Phi(node)                          is_Phi_(node)
632 #define is_strictConv(node)                   is_strictConv_(node)
633 #define is_SymConst_addr_ent(node)            is_SymConst_addr_ent_(node)
634 #define get_Block_n_cfgpreds(node)            get_Block_n_cfgpreds_(node)
635 #define get_Block_cfgpred(node, pos)          get_Block_cfgpred_(node, pos)
636 #define get_Block_cfgpred_block(node, pos)    get_Block_cfgpred_block_(node, pos)
637 #define get_Block_block_visited(node)         get_Block_block_visited_(node)
638 #define set_Block_block_visited(node, visit)  set_Block_block_visited_(node, visit)
639 #define mark_Block_block_visited(node)        mark_Block_block_visited_(node)
640 #define Block_block_visited(node)             Block_block_visited_(node)
641 #define get_Block_irg(block)                  get_Block_irg_(block)
642 #define get_Const_tarval(node)                get_Const_tarval_(node)
643 #define is_Const_null(node)                   is_Const_null_(node)
644 #define is_Const_one(node)                    is_Const_one_(node)
645 #define is_Const_all_one(node)                is_Const_all_one_(node)
646 #define is_irn_forking(node)                  is_irn_forking_(node)
647 #define copy_node_attr(irg,oldn,newn)         copy_node_attr_(irg,oldn,newn)
648 #define get_irn_type(node)                    get_irn_type_(node)
649 #define get_irn_type_attr(node)               get_irn_type_attr_(node)
650 #define get_irn_entity_attr(node)             get_irn_entity_attr_(node)
651 #define is_irn_constlike(node)                is_irn_constlike_(node)
652 #define is_irn_always_opt(node)               is_irn_always_opt_(node)
653 #define is_irn_keep(node)                     is_irn_keep_(node)
654 #define is_irn_start_block_placed(node)       is_irn_start_block_placed_(node)
655 #define is_irn_cse_neutral(node)              is_irn_cse_neutral_(node)
656 #define get_Cond_jmp_pred(node)               get_Cond_jmp_pred_(node)
657 #define set_Cond_jmp_pred(node, pred)         set_Cond_jmp_pred_(node, pred)
658 #define get_irn_generic_attr(node)            get_irn_generic_attr_(node)
659 #define get_irn_generic_attr_const(node)      get_irn_generic_attr_const_(node)
660 #define get_irn_idx(node)                     get_irn_idx_(node)
661
662 #define get_irn_deps(node)                    get_irn_deps_(node)
663 #define set_irn_dep(node, pos, dep)           set_irn_dep_(node, pos, dep)
664 #define get_irn_dep(node, pos)                get_irn_dep_(node, pos)
665
666 #define get_irn_ins_or_deps(node)             get_irn_ins_or_deps_(node)
667 #define get_irn_in_or_dep(node, pos)          get_irn_in_or_dep_(node, pos)
668
669 #define get_irn_dbg_info(node)                get_irn_dbg_info_(node)
670 #define set_irn_dbg_info(node, db)            set_irn_dbg_info_(node, db)
671
672 #define set_Block_phis(block, phi)            set_Block_phis_(block, phi)
673 #define get_Block_phis(block)                 get_Block_phis_(block)
674 #define add_Block_phi(block, phi)             add_Block_phi_(block, phi)
675 #define get_Block_mark(block)                 get_Block_mark_(block)
676 #define set_Block_mark(block, mark)           set_Block_mark_(block, mark)
677
678 #define set_Phi_next(node, phi)               set_Phi_next_(node, phi)
679 #define get_Phi_next(node)                    get_Phi_next_(node)
680
681 #define is_arg_Proj(node)                     is_arg_Proj_(node)
682 #define ir_switch_table_get_n_entries(table)  ir_switch_table_get_n_entries_(table)
683
684 #endif