typo fixed
[libfirm] / ir / be / bespillslots.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       Spillslot coalescer.
23  * @author      Matthias Braun
24  * @date        27.07.2006
25  * @version     $Id$
26  */
27 #ifndef FIRM_BE_BESPILLSLOTS_H
28 #define FIRM_BE_BESPILLSLOTS_H
29
30 #include "beirg.h"
31
32 typedef struct _be_fec_env_t be_fec_env_t;
33
34 /**
35  * Initializes a new frame entity coalescer environment
36  */
37 be_fec_env_t *be_new_frame_entity_coalescer(be_irg_t *birg);
38
39 /**
40  * Frees a frame entity coalescer environment
41  */
42 void be_free_frame_entity_coalescer(be_fec_env_t *env);
43
44 /**
45  * Adds a node that needs a frame entity and consumes memory (Reload nodes). The
46  * memory edges are followed to find memory-phis and the entities that produce
47  * the memory values.
48  *
49  * @param env   The frame entity coalescer environment
50  * @param node  The node that uses the frame entity
51  * @param mode  The mode of the needed spillslot
52  * @param align The alignment of the needed spillslot
53  */
54 void be_node_needs_frame_entity(be_fec_env_t *env, ir_node *node,
55                                 const ir_mode *mode, int alignment);
56
57 /**
58  * Assigned frame entities to all the nodes added by be_node_needs_frame_entity.
59  * Adds memory perms where needed.
60  */
61 void be_assign_entities(be_fec_env_t *env);
62
63 //-------------------------------------------------------------------
64 // Old API
65 //-------------------------------------------------------------------
66
67 /**
68  * Assigns frame entities to all spill nodes in the irg.
69  * Coalesces spillslots and minimizes the number of memcopies induced by
70  * memory-phis.
71  */
72 void be_coalesce_spillslots(be_irg_t *birg);
73
74 #endif /* FIRM_BE_BESPILLSLOTS_H */