added doxygen comments
[libfirm] / ir / be / ppc32 / bearch_ppc32_t.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  * @file
22  * @brief   declarations for arm backend -- private header
23  * @author  Moritz Kroll, Jens Mueller
24  * @version $Id$
25  */
26 #ifndef FIRM_BE_PPC32_BEARCH_PPC32_T_H
27 #define FIRM_BE_PPC32_BEARCH_PPC32_T_H
28
29 #include "debug.h"
30 #include "bearch_ppc32.h"
31 #include "ppc32_nodes_attr.h"
32 #include "../be.h"
33 #include "set.h"
34
35 typedef struct _ppc32_isa_t ppc32_isa_t;
36
37 typedef struct _ppc32_code_gen_t {
38         const arch_code_generator_if_t *impl;             /**< implementation */
39         ir_graph                       *irg;              /**< current irg */
40         const arch_env_t               *arch_env;         /**< the arch env */
41         set                            *reg_set;          /**< set to memorize registers for FIRM nodes (e.g. phi) */
42         int                             emit_decls;       /**< flag indicating if decls were already emitted */
43         ppc32_isa_t                    *isa;              /**< the isa instance */
44         const be_irg_t                 *birg;             /**< The be-irg (contains additional information about the irg) */
45         unsigned                        area_size;        /**< size of call area for the current irg */
46         ir_entity                      *area;             /**< the entity representing the call area or NULL for leaf functions */
47         ir_node                        *start_succ_block; /**< the block succeeding the start block in the cfg */
48         ir_node                        **blk_sched;       /**< an array containing the scheduled blocks */
49         DEBUG_ONLY(firm_dbg_module_t    *mod;)             /**< debugging module */
50 } ppc32_code_gen_t;
51
52
53 struct _ppc32_isa_t {
54         const arch_isa_if_t   *impl;
55         const arch_register_t *sp;            /**< The stack pointer register. */
56         const arch_register_t *bp;            /**< The base pointer register. */
57         const int              stack_dir;     /**< -1 for decreasing, 1 for increasing. */
58         int                    num_codegens;
59         FILE                   *out;          /**< output file */
60 };
61
62
63 typedef struct _ppc32_irn_ops_t {
64         const arch_irn_ops_if_t *impl;
65         ppc32_code_gen_t     *cg;
66 } ppc32_irn_ops_t;
67
68
69 /** this is a struct to minimize the number of parameters
70    for transformation walker */
71 typedef struct _ppc32_transform_env_t {
72         dbg_info          *dbg;      /**< The node debug info */
73         ir_graph          *irg;      /**< The irg, the node should be created in */
74         ir_node           *block;    /**< The block, the node should belong to */
75         ir_node           *irn;      /**< The irn, to be transformed */
76         ir_mode           *mode;     /**< The mode of the irn */
77         DEBUG_ONLY(firm_dbg_module_t *mod;) /**< The firm debugger */
78 } ppc32_transform_env_t;
79
80 #endif