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