unified header
[libfirm] / ir / opt / proc_cloning.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  * Project:     libFIRM
22  * File name:   ir/clone functions./proc_cloning.h
23  * Purpose:     procedure cloning
24  * Author:      Beyhan Veliev
25  * Created:
26  * CVS-ID:      $Id$
27  * Copyright:   (c) 1998-2005 Universität Karlsruhe
28  */
29 #ifndef PROC_CLONING_H
30 #define PROC_CLONING_H
31
32 #include "firm_types.h"
33
34 /** A default threshold. */
35 #define DEFAULT_CLONE_THRESHOLD 300
36
37 /**
38  * Do procedure cloning. Evaluate a heuristic weight for every
39  * Call(..., Const, ...). If the weight is bigger than threshold,
40  * clone the entity and fix the calls.
41  *
42  * @param threshold   the threshold for cloning
43  *
44  * The threshold is an estimation of how many instructions are saved
45  * when executing a cloned method. If threshold is 0.0, every possible
46  * call is cloned.
47  */
48 void proc_cloning(float threshold);
49
50 #endif /* PROC_CLONING_H */