Allow the first line to be a comment.
[libfirm] / ir / be / arm / arm_cconv.h
1 /*
2  * Copyright (C) 1995-2010 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   support functions for calling conventions
23  * @author  Matthias Braun
24  */
25 #ifndef FIRM_BE_ARM_ARM_CCONV_H
26 #define FIRM_BE_ARM_ARM_CCONV_H
27
28 #include "firm_types.h"
29 #include "be_types.h"
30 #include "gen_arm_regalloc_if.h"
31
32 /** information about a single parameter or result */
33 typedef struct reg_or_stackslot_t
34 {
35         const arch_register_t *reg0;   /**< if != NULL, the first register used for this parameter. */
36         const arch_register_t *reg1;   /**< if != NULL, the second register used. */
37         ir_type               *type;   /**< indicates that an entity of the specific
38                                                                             type is needed */
39         unsigned               offset; /**< if transmitted via stack, the offset for this parameter. */
40         ir_entity             *entity; /**< entity in frame type */
41 } reg_or_stackslot_t;
42
43 /** The calling convention info for one call site. */
44 typedef struct calling_convention_t
45 {
46         reg_or_stackslot_t *parameters;        /**< parameter info. */
47         unsigned            param_stack_size;  /**< needed stack size for parameters */
48         unsigned            n_reg_params;
49         reg_or_stackslot_t *results;           /**< result info. */
50 } calling_convention_t;
51
52 /**
53  * determine how function parameters and return values are passed.
54  * Decides what goes to register or to stack and what stack offsets/
55  * datatypes are used.
56  */
57 calling_convention_t *arm_decide_calling_convention(const ir_graph *irg,
58                                                     ir_type *function_type);
59
60 /**
61  * free memory used by a calling_convention_t
62  */
63 void arm_free_calling_convention(calling_convention_t *cconv);
64
65 #endif