bepeephole: use global register indices
[libfirm] / ir / be / bepeephole.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       peephole optimisation framework
23  * @author      Matthias Braun
24  * @version     $Id$
25  */
26 #ifndef BEPEEPHOLE_H
27 #define BEPEEPHOLE_H
28
29 #include "beirg.h"
30 #include "bearch.h"
31
32 extern ir_node **register_values;
33
34 static inline ir_node *be_peephole_get_value(unsigned register_idx)
35 {
36         return register_values[register_idx];
37 }
38
39 static inline ir_node *be_peephole_get_reg_value(const arch_register_t *reg)
40 {
41         unsigned register_idx = reg->global_index;
42         return be_peephole_get_value(register_idx);
43 }
44
45 /**
46  * Datatype of the generic op handler for optimisation.
47  */
48 typedef void (*peephole_opt_func) (ir_node *node);
49
50 /**
51  * Notify the peephole phase about a newly added node, so it can update its
52  * internal state.  This is not needed for the new node, when
53  * be_peephole_exchange() is used.
54  * Note: Contrary to normal exchange you mustn't remove the node from the
55  * schedule either before exchange. Exchange will do that for you.
56  */
57 void be_peephole_new_node(ir_node *nw);
58
59 /**
60  * When doing peephole optimisation use this function instead of plain
61  * exchange(), so it can update its internal state. */
62 void be_peephole_exchange(ir_node *old, ir_node *nw);
63
64 /**
65  * Tries to optimize a beIncSp node with its previous IncSP node.
66  * Must be run from a be_peephole_opt() context.
67  *
68  * @param node  a be_IncSP node
69  *
70  * @return the new IncSP node or node itself
71  */
72 ir_node *be_peephole_IncSP_IncSP(ir_node *node);
73
74 bool be_has_only_one_user(ir_node *node);
75
76 /**
77  * Do peephole optimisations. It traverses the schedule of all blocks in
78  * backward direction. The register_values variable indicates which (live)
79  * values are stored in which register.
80  * The generic op handler is called for each node if it exists. That's where
81  * backend specific optimisations should be performed based on the
82  * register-liveness information.
83  */
84 void be_peephole_opt(ir_graph *irg);
85
86 #endif