added doxygen comments, credited backend to Moritz Kroll and Jens Mueller
[libfirm] / ir / be / ppc32 / ppc32_new_nodes.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   Function prototypes for the ppc32 assembler ir node constructors.
23  * @author  Moritz Kroll, Jens Mueller
24  * @version $Id$
25  */
26 #ifndef FIRM_BE_PPC32_PPC32_NEW_NODES_H
27 #define FIRM_BE_PPC32_PPC32_NEW_NODES_H
28
29 #include "ppc32_nodes_attr.h"
30
31 /***************************************************************************************************
32  *        _   _                   _       __        _                    _   _               _
33  *       | | | |                 | |     / /       | |                  | | | |             | |
34  *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
35  *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
36  * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
37  *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
38  *                                        __/ |
39  *                                       |___/
40  ***************************************************************************************************/
41
42 /**
43  * Returns the attributes of an ppc node.
44  */
45 ppc32_attr_t *get_ppc32_attr(const ir_node *node);
46
47 /**
48  * Returns the argument register requirements of an ppc node.
49  */
50 const arch_register_req_t **get_ppc32_in_req_all(const ir_node *node);
51
52 /**
53  * Returns the result register requirements of an ppc node.
54  */
55 const arch_register_req_t **get_ppc32_out_req_all(const ir_node *node);
56
57 /**
58  * Returns the argument register requirements of an ppc node.
59  */
60 const arch_register_req_t *get_ppc32_in_req(const ir_node *node, int pos);
61
62 /**
63  * Returns the result register requirements of an ppc node.
64  */
65 const arch_register_req_t *get_ppc32_out_req(const ir_node *node, int pos);
66
67 /**
68  * Sets the OUT register requirements at position pos.
69  */
70 void set_ppc32_req_out(ir_node *node, const arch_register_req_t *req, int pos);
71
72 /**
73  * Sets the IN register requirements at position pos.
74  */
75 void set_ppc32_req_in(ir_node *node, const arch_register_req_t *req, int pos);
76
77 /**
78  * Returns the register flag of an ppc node.
79  */
80 arch_irn_flags_t get_ppc32_flags(const ir_node *node);
81
82 /**
83  * Sets the register flag of an ppc node.
84  */
85 void set_ppc32_flags(const ir_node *node, arch_irn_flags_t flags);
86
87 /**
88  * Returns the result register slots of an ppc node.
89  */
90 const arch_register_t **get_ppc32_slots(const ir_node *node);
91
92 /**
93  * Returns the name of the OUT register at position pos.
94  */
95 const char *get_ppc32_out_reg_name(const ir_node *node, int pos);
96
97 /**
98  * Returns the index of the OUT register at position pos within its register class.
99  */
100 int get_ppc32_out_regnr(const ir_node *node, int pos);
101
102 /**
103  * Returns the OUT register at position pos.
104  */
105 const arch_register_t *get_ppc32_out_reg(const ir_node *node, int pos);
106
107 /**
108  * Sets the number of results.
109  */
110 void set_ppc32_n_res(ir_node *node, int n_res);
111
112 /**
113  * Returns the number of results.
114  */
115 int get_ppc32_n_res(const ir_node *node);
116
117 ppc32_attr_content_type get_ppc32_type(const ir_node *node);
118
119 void set_ppc32_constant_tarval(const ir_node *node, tarval *const_tarval);
120 tarval *get_ppc32_constant_tarval(const ir_node *node);
121
122 void set_ppc32_symconst_ident(const ir_node *node, ident *symconst_ident);
123 ident *get_ppc32_symconst_ident(const ir_node *node);
124
125 void set_ppc32_frame_entity(const ir_node *node, ir_entity *ent);
126 ir_entity *get_ppc32_frame_entity(const ir_node *node);
127
128 void set_ppc32_rlwimi_const(const ir_node *node, unsigned shift, unsigned maskA, unsigned maskB);
129 rlwimi_const_t *get_ppc32_rlwimi_const(const ir_node *node);
130
131 void set_ppc32_proj_nr(const ir_node *node, int proj_nr);
132 int get_ppc32_proj_nr(const ir_node *node);
133
134 void set_ppc32_offset(const ir_node *node, int offset);
135 int get_ppc32_offset(const ir_node *node);
136
137 void set_ppc32_offset_mode(const ir_node *node, ppc32_attr_offset_mode mode);
138 ppc32_attr_offset_mode get_ppc32_offset_mode(const ir_node *node);
139
140 void init_ppc32_attributes(ir_node *node, int flags,
141                                                  const arch_register_req_t **in_reqs, const arch_register_req_t **out_reqs,
142                                                  const be_execution_unit_t ***execution_units,
143                                                  int n_res, unsigned latency);
144
145 void ppc32_register_additional_opcodes(int opcode_num);
146
147 /* Include the generated headers */
148 #include "gen_ppc32_new_nodes.h"
149
150 #endif