5 #include "firm_config.h"
18 typedef struct _arch_register_class_t arch_register_class_t;
19 typedef struct _arch_register_t arch_register_t;
20 typedef struct _arch_enum_t arch_enum_t;
21 typedef struct _arch_enum_member_t arch_enum_member_t;
22 typedef struct _arch_isa_if_t arch_isa_if_t;
23 typedef struct _arch_env_t arch_env_t;
24 typedef struct _arch_irn_ops_t arch_irn_ops_t;
25 typedef struct _arch_irn_handler_t arch_irn_handler_t;
27 struct _be_node_factory_t;
29 typedef enum _arch_register_type_t {
30 arch_register_type_none = 0,
31 arch_register_type_write_invariant,
32 arch_register_type_caller_saved, /**< The register must be saved by the caller
33 upon a function call. It thus can be overwritten
34 in the called function. */
35 arch_register_type_callee_saved, /**< The register must be saved by the called function,
36 it thus survives a function call. */
37 arch_register_type_ignore /**< Do not consider this register when allocating. */
38 } arch_register_type_t;
43 struct _arch_register_t {
44 const char *name; /**< The name of the register. */
45 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
46 int index; /**< The index of the register in the class. */
47 arch_register_type_t type; /**< The type of the register. */
48 void *data; /**< Custom data. */
51 static INLINE const arch_register_class_t *
52 _arch_register_get_class(const arch_register_t *reg)
54 return reg->reg_class;
57 static INLINE int _arch_register_get_index(const arch_register_t *reg)
62 #define arch_register_get_class(reg) _arch_register_get_class(reg)
63 #define arch_register_get_index(reg) _arch_register_get_index(reg)
64 #define arch_register_get_name(reg) ((reg)->name)
67 * A class of registers.
68 * Like general purpose or floating point.
70 struct _arch_register_class_t {
71 const char *name; /**< The name of the register. */
72 int n_regs; /**< Number of registers in this class. */
73 const arch_register_t *regs; /**< The array of registers. */
76 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
79 * Put all registers in a class into a bitset.
80 * @param cls The class.
81 * @param bs The bitset. May be NULL.
82 * @return The number of registers in the class.
84 extern int arch_register_class_put(const arch_register_class_t *cls,
85 struct _bitset_t *bs);
87 static INLINE const arch_register_t *
88 _arch_register_for_index(const arch_register_class_t *cls, int idx)
90 assert(0 <= idx && idx < cls->n_regs);
91 return &cls->regs[idx];
94 #define arch_register_for_index(cls, idx) \
95 _arch_register_for_index(cls, idx)
98 * Get the register set for a register class.
99 * @param cls The register class.
100 * @return The set containing all registers in the class.
102 #define arch_get_register_set_for_class(cls) ((cls)->set)
107 struct _arch_immediate_t {
108 const char *name; /**< The name of the immediate. */
109 ir_mode *mode; /**< The mode of the immediate. */
113 * The member of an enum.
115 struct _arch_enum_member_t {
116 arch_enum_t *enm; /**< The enum, this member belongs to. */
120 * An enumeration operand type.
122 * Enumeration operand types can be used to describe the variants
123 * of an instruction, like giving the cases for a compare (gt, lt,
124 * eq, ...) some other special attributes of an instruction.
126 struct _arch_enum_t {
127 int n_members; /**< The number of members in this enum. */
128 arch_enum_member_t *members[1]; /**< The array of members. */
131 typedef enum _arch_operand_type_t {
132 arch_operand_type_invalid,
133 arch_operand_type_memory,
134 arch_operand_type_register,
135 arch_operand_type_immediate,
136 arch_operand_type_symconst,
137 arch_operand_type_last
138 } arch_operand_type_t;
141 * Different types of register allocation requirements.
143 typedef enum _arch_register_req_type_t {
144 arch_register_req_type_none = 0, /** No register requirement. */
146 arch_register_req_type_normal = 1, /** All registers in the class
149 arch_register_req_type_limited = 2, /** Only a real subset of
150 the class is allowed. */
152 arch_register_req_type_equal = 4, /** The register must equal
153 another one at the node. */
155 arch_register_req_type_unequal = 8, /** The register must be unequal
156 to some other at the node. */
158 arch_register_req_type_pair = 16 /** The register is part of a
160 } arch_register_req_type_t;
162 #define arch_register_req_is_constr(x) \
163 ((x)->type & (arch_register_req_type_pair + arch_register_req_type_limited - 1) != 0)
166 * Expresses requirements to register allocation for an operand.
168 typedef struct _arch_register_req_t {
169 arch_register_req_type_t type; /** The type of the constraint. */
170 const arch_register_class_t *cls; /** The register class this
171 constraint belongs to. */
173 int (*limited)(const ir_node *irn, int pos, struct _bitset_t *bs);
174 /** In case of the 'limited'
175 constraint, this function
176 must put all allowable
177 registers in the bitset and
178 return the number of registers
181 int pos; /** In case of the equal constraint,
182 this gives the position of the
183 operand to which the register of
184 this should be equal to. Same for
187 } arch_register_req_t;
190 * Certain node classes which are relevent for the register allocator.
192 typedef enum _arch_irn_class_t {
193 arch_irn_class_normal,
194 arch_irn_class_spill,
195 arch_irn_class_reload,
198 arch_irn_class_branch
202 * Some words about positions and indices:
204 * Firm has the policy "One node per value", that's why there are
205 * Proj nodes. This view has its advantages, but in a backend
206 * setting where we talk about instructions (which can also have
207 * multiple results and not a single Tuple value) this is sometimes
210 * Each node representing an instruction must provide information
211 * about the kind of its operands (where operands mean both input
212 * and output operands). Such an operand is addressed with a position
213 * which is infact a tuple {in, out} x N. The fact that a position
214 * is an input/output operand is encoded in the sign, so input operands
215 * go from 0..n-1 and output operands from -1..-m if the
216 * instruction has n input and m output operands.
219 #define _BEARCH_TRANSFORM_INDEX(cmp, index) ((index) cmp 0 ? -((index) + 1) : (index))
222 * Make an in position from an index.
223 * @param index The index.
224 * @return The position representing the index as an in operand.
226 #define arch_pos_make_in(index) _BEARCH_TRANSFORM_INDEX(<, index)
229 * Make an out position from an index.
230 * @param index The index.
231 * @return The position representing the index as an out operand.
233 #define arch_pos_make_out(index) _BEARCH_TRANSFORM_INDEX(>=, index)
236 * Check, if a position denotes an input operand.
237 * @param pos The position.
238 * @return 1, if the position denotes an input operand 0 if not.
240 #define arch_pos_is_in(pos) ((pos) >= 0)
243 * Check, if a position denotes an output operand.
244 * @param pos The position.
245 * @return 1, if the position denotes an output operand 0 if not.
247 #define arch_pos_is_out(pos) (!arch_pos_is_in(pos))
250 * Get the index of a position.
251 * @param pos The position.
252 * @return The index of the position.
254 #define arch_pos_get_index(pos) _BEARCH_TRANSFORM_INDEX(<, pos)
256 struct _arch_irn_ops_t {
259 * Get the register requirements for a given operand.
260 * @param self The self pointer.
261 * @param irn The node.
262 * @param pos The operand's position.
263 * @return The register requirements for the selected operand.
264 * The pointer returned is never NULL.
266 const arch_register_req_t *(*get_irn_reg_req)(const arch_irn_ops_t *self,
267 arch_register_req_t *req,
268 const ir_node *irn, int pos);
271 * Get the number of operands of a node.
272 * @param irn The node.
273 * @param in_out Denotes wither input (a number >= 0) or
274 * output (a number < 0).
275 * @return The number of operands for either in, or output.
277 int (*get_n_operands)(const arch_irn_ops_t *self, const ir_node *irn, int in_out);
280 * Set the register for an output operand.
281 * @param irn The node.
282 * @param pos The position of the output operand.
283 * @param reg The register allocated to that operand.
284 * @note If the operand is not a register operand,
285 * the call is ignored.
287 void (*set_irn_reg)(const arch_irn_ops_t *self, ir_node *irn,
288 int idx, const arch_register_t *reg);
291 * Get the register allocated for an output operand.
292 * @param irn The node.
293 * @param pos The index of the output operand.
294 * @return The register allocated at that operand. NULL, if
295 * the operand was no register operand or
296 * @c arch_register_invalid, if no register has yet been
297 * allocated for this node.
299 const arch_register_t *(*get_irn_reg)(const arch_irn_ops_t *self,
300 const ir_node *irn, int idx);
304 * @param irn The node.
305 * @return A classification.
307 arch_irn_class_t (*classify)(const arch_irn_ops_t *self, const ir_node *irn);
312 * Get the register requirements for a node.
313 * @param env The architecture environment.
314 * @param req A pointer to a requirements structure, where the data can
316 * @param irn The node.
317 * @param pos The position of the operand you're interested in.
318 * @return A pointer to the register requirements which may <b>not</b>
319 * neccessarily be equal to @p req. If NULL is returned, the
320 * operand was no register operand.
322 extern const arch_register_req_t *
323 arch_get_register_req(const arch_env_t *env, arch_register_req_t *req,
324 const ir_node *irn, int pos);
327 * Check if an operand is a register operand.
328 * @param env The environment.
329 * @param irn The node.
330 * @param pos The position of the operand.
331 * @return 1, if the operand is significant for register allocation, 0
334 extern int arch_is_register_operand(const arch_env_t *env,
335 const ir_node *irn, int pos);
338 * Get the number of allocatable registers concerning
339 * a register class for an operand of a node.
340 * @param env The environment.
341 * @param irn The node.
342 * @param pos The postition of the node's operand.
343 * @param cls The register class.
344 * @param bs The bitset all allocatable registers shall be put into.
345 * Note, that you can also pass NULL here. If you don't,
346 * make sure, the bitset is as large as the register class
348 * @return The amount of registers allocatable for that operand.
350 extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn,
351 int pos, const arch_register_class_t *cls, struct _bitset_t *bs);
354 * Check, if a register is assignable to an operand of a node.
355 * @param env The architecture environment.
356 * @param irn The node.
357 * @param pos The position of the operand.
358 * @param reg The register.
359 * @return 1, if the register might be allocated to the operand 0 if not.
361 extern int arch_reg_is_allocatable(const arch_env_t *env,
362 const ir_node *irn, int pos, const arch_register_t *reg);
365 * Get the register class of an operand of a node.
366 * @param env The architecture environment.
367 * @param irn The node.
368 * @param idx The position of the operand.
369 * @return The register class of the operand or NULL, if
370 * operand is a non-register operand.
372 extern const arch_register_class_t *
373 arch_get_irn_reg_class(const arch_env_t *env, const ir_node *irn, int pos);
376 * Get the register allocated at a certain output operand of a node.
377 * @param env The arch nvironment.
378 * @param irn The node.
379 * @param idx The index of the output operand.
380 * @return The register allocated for this operand
382 extern const arch_register_t *
383 arch_get_irn_register(const arch_env_t *env, const ir_node *irn, int idx);
386 * Set the register for a certain output operand.
387 * @param env The architecture environment.
388 * @param irn The node.
389 * @param idx The index of the output operand.
390 * @param reg The register.
392 extern void arch_set_irn_register(const arch_env_t *env,
393 ir_node *irn, int idx, const arch_register_t *reg);
397 * @param env The architecture environment.
398 * @param irn The node.
399 * @return A classification of the node.
401 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
403 #define arch_irn_has_reg_class(env, irn, pos, cls) \
404 ((cls) == arch_get_irn_reg_class(env, irn, pos))
407 * Somebody who can be asked about nodes.
409 struct _arch_irn_handler_t {
412 * Get the operations of an irn.
413 * @param self The handler from which the method is invoked.
414 * @param irn Some node.
415 * @return Operations for that irn.
417 const arch_irn_ops_t *(*get_irn_ops)(const arch_irn_handler_t *handler,
423 * Architecture interface.
425 struct _arch_isa_if_t {
428 * Initialize the isa interface.
433 * Get the the number of register classes in the isa.
434 * @return The number of register classes.
436 int (*get_n_reg_class)(void);
439 * Get the i-th register class.
440 * @param i The number of the register class.
441 * @return The register class.
443 const arch_register_class_t *(*get_reg_class)(int i);
447 #define ARCH_MAX_HANDLERS 8
450 * Environment for the architecture infrastructure.
451 * Keep this everywhere you're going.
454 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
455 const arch_isa_if_t *isa; /**< The isa about which everything is. */
457 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
460 int handlers_tos; /**< The stack pointer of the handler
465 * Get the isa of an arch environment.
466 * @param env The environment.
467 * @return The isa with which the env was initialized with.
469 #define arch_env_get_isa(env) ((env)->isa)
472 * Initialize the architecture environment struct.
473 * @param isa The isa which shall be put into the environment.
474 * @return The environment.
476 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
479 * Add a node handler to the environment.
480 * @param env The environment.
481 * @param handler A node handler.
482 * @return The environment itself.
484 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env,
485 const arch_irn_handler_t *handler);
487 #endif /* _FIRM_BEARCH_H */