5 #include "firm_config.h"
17 typedef struct _arch_register_class_t arch_register_class_t;
18 typedef struct _arch_register_t arch_register_t;
19 typedef struct _arch_enum_t arch_enum_t;
20 typedef struct _arch_enum_member_t arch_enum_member_t;
21 typedef struct _arch_isa_if_t arch_isa_if_t;
22 typedef struct _arch_env_t arch_env_t;
23 typedef struct _arch_irn_ops_t arch_irn_ops_t;
24 typedef struct _arch_irn_handler_t arch_irn_handler_t;
26 struct _be_node_factory_t;
28 typedef enum _arch_register_type_t {
29 arch_register_type_none = 0,
30 arch_register_type_write_invariant,
31 arch_register_type_caller_saved, /**< The register must be saved by the caller
32 upon a function call. It thus can be overwritten
33 in the called function. */
34 arch_register_type_callee_saved, /**< The register must be saved by the called function,
35 it thus survives a function call. */
36 arch_register_type_ignore /**< Do not consider this register when allocating. */
37 } arch_register_type_t;
42 struct _arch_register_t {
43 const char *name; /**< The name of the register. */
44 const arch_register_class_t *reg_class; /**< The class the register belongs to. */
45 int index; /**< The index of the register in the class. */
46 arch_register_type_t type; /**< The type of the register. */
47 void *data; /**< Custom data. */
50 static INLINE const arch_register_class_t *
51 _arch_register_get_class(const arch_register_t *reg)
53 return reg->reg_class;
56 static INLINE int _arch_register_get_index(const arch_register_t *reg)
61 #define arch_register_get_class(reg) _arch_register_get_class(reg)
62 #define arch_register_get_index(reg) _arch_register_get_index(reg)
63 #define arch_register_get_name(reg) ((reg)->name)
66 * A class of registers.
67 * Like general purpose or floating point.
69 struct _arch_register_class_t {
70 const char *name; /**< The name of the register. */
71 int n_regs; /**< Number of registers in this class. */
72 const arch_register_t *regs; /**< The array of registers. */
75 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
78 * Put all registers in a class into a bitset.
79 * @param cls The class.
80 * @param bs The bitset. May be NULL.
81 * @return The number of registers in the class.
83 extern int arch_register_class_put(const arch_register_class_t *cls, bitset_t *bs);
85 static INLINE const arch_register_t *
86 _arch_register_for_index(const arch_register_class_t *cls, int idx)
88 assert(0 <= idx && idx < cls->n_regs);
89 return &cls->regs[idx];
92 #define arch_register_for_index(cls, idx) \
93 _arch_register_for_index(cls, idx)
96 * Get the register set for a register class.
97 * @param cls The register class.
98 * @return The set containing all registers in the class.
100 #define arch_get_register_set_for_class(cls) ((cls)->set)
105 struct _arch_immediate_t {
106 const char *name; /**< The name of the immediate. */
107 ir_mode *mode; /**< The mode of the immediate. */
111 * The member of an enum.
113 struct _arch_enum_member_t {
114 arch_enum_t *enm; /**< The enum, this member belongs to. */
118 * An enumeration operand type.
120 * Enumeration operand types can be used to describe the variants
121 * of an instruction, like giving the cases for a compare (gt, lt,
122 * eq, ...) some other special attributes of an instruction.
124 struct _arch_enum_t {
125 int n_members; /**< The number of members in this enum. */
126 arch_enum_member_t *members[1]; /**< The array of members. */
129 typedef enum _arch_operand_type_t {
130 arch_operand_type_invalid,
131 arch_operand_type_memory,
132 arch_operand_type_register,
133 arch_operand_type_immediate,
134 arch_operand_type_symconst,
135 arch_operand_type_last
136 } arch_operand_type_t;
139 * Different types of register allocation requirements.
141 typedef enum _arch_register_req_type_t {
142 arch_register_req_type_none = 0, /** No register requirement. */
144 arch_register_req_type_normal = 1, /** All registers in the class
147 arch_register_req_type_limited = 2, /** Only a real subset of
148 the class is allowed. */
150 arch_register_req_type_equal = 4, /** The register must equal
151 another one at the node. */
153 arch_register_req_type_unequal = 8, /** The register must be unequal
154 to some other at the node. */
156 arch_register_req_type_pair = 16 /** The register is part of a
158 } arch_register_req_type_t;
160 #define arch_register_req_is_constr(x) \
161 ((x)->type & (arch_register_req_type_pair + arch_register_req_type_limited - 1) != 0)
164 * Expresses requirements to register allocation for an operand.
166 typedef struct _arch_register_req_t {
167 arch_register_req_type_t type; /** The type of the constraint. */
168 const arch_register_class_t *cls; /** The register class this
169 constraint belongs to. */
171 int (*limited)(const ir_node *irn, int pos, bitset_t *bs);
172 /** In case of the 'limited'
173 constraint, this function
174 must put all allowable
175 registers in the bitset and
176 return the number of registers
179 int pos; /** In case of the equal constraint,
180 this gives the position of the
181 operand to which the register of
182 this should be equal to. Same for
185 } arch_register_req_t;
188 * Certain node classes which are relevent for the register allocator.
190 typedef enum _arch_irn_class_t {
191 arch_irn_class_normal,
192 arch_irn_class_spill,
193 arch_irn_class_reload,
196 arch_irn_class_branch
201 * Some words about positions and indices:
203 * Firm has the policy "One node per value", that's why there are
204 * Proj nodes. This view has its advantages, but in a backend
205 * setting where we talk about instructions (which can also have
206 * multiple results and not a single Tuple value) this is sometimes
209 * Each node representing an instruction must provide information
210 * about the kind of its operands (where operands mean both input
211 * and output operands). Such an operand is addressed with a position
212 * which is infact a tuple {in, out} x N. The fact that a position
213 * is an input/output operand is encoded in the sign, so input operands
214 * go from 0..n-1 and output operands from -1..-m if the
215 * instruction has n input and m output operands.
218 #define _BEARCH_TRANSFORM_INDEX(cmp, index) ((index) cmp 0 ? -((index) + 1) : (index))
221 * Make an in position from an index.
222 * @param index The index.
223 * @return The position representing the index as an in operand.
225 #define arch_pos_make_in(index) _BEARCH_TRANSFORM_INDEX(<, index)
228 * Make an out position from an index.
229 * @param index The index.
230 * @return The position representing the index as an out operand.
232 #define arch_pos_make_out(index) _BEARCH_TRANSFORM_INDEX(>=, index)
235 * Check, if a position denotes an input operand.
236 * @param pos The position.
237 * @return 1, if the position denotes an input operand 0 if not.
239 #define arch_pos_is_in(pos) ((pos) >= 0)
242 * Check, if a position denotes an output operand.
243 * @param pos The position.
244 * @return 1, if the position denotes an output operand 0 if not.
246 #define arch_pos_is_out(pos) (!arch_pos_is_in(pos))
249 * Get the index of a position.
250 * @param pos The position.
251 * @return The index of the position.
253 #define arch_pos_get_index(pos) _BEARCH_TRANSFORM_INDEX(<, pos)
255 struct _arch_irn_ops_t {
258 * Get the register requirements for a given operand.
259 * @param self The self pointer.
260 * @param irn The node.
261 * @param pos The operand's position.
262 * @return The register requirements for the selected operand.
263 * The pointer returned is never NULL.
265 const arch_register_req_t *(*get_irn_reg_req)(const arch_irn_ops_t *self,
266 arch_register_req_t *req,
267 const ir_node *irn, int pos);
270 * Get the number of operands of a node.
271 * @param irn The node.
272 * @param in_out Denotes wither input (a number >= 0) or
273 * output (a number < 0).
274 * @return The number of operands for either in, or output.
276 int (*get_n_operands)(const arch_irn_ops_t *self, const ir_node *irn, int in_out);
279 * Set the register for an output operand.
280 * @param irn The node.
281 * @param pos The position of the output operand.
282 * @param reg The register allocated to that operand.
283 * @note If the operand is not a register operand,
284 * the call is ignored.
286 void (*set_irn_reg)(const arch_irn_ops_t *self, ir_node *irn,
287 int idx, const arch_register_t *reg);
290 * Get the register allocated for an output operand.
291 * @param irn The node.
292 * @param pos The index of the output operand.
293 * @return The register allocated at that operand. NULL, if
294 * the operand was no register operand or
295 * @c arch_register_invalid, if no register has yet been
296 * allocated for this node.
298 const arch_register_t *(*get_irn_reg)(const arch_irn_ops_t *self,
299 const ir_node *irn, int idx);
303 * @param irn The node.
304 * @return A classification.
306 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, 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 pos 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 * This function is called each time, the backend starts running over
449 * @param irg The graph.
451 void (*prepare_graph)(ir_graph *irg);
454 #define ARCH_MAX_HANDLERS 8
457 * Environment for the architecture infrastructure.
458 * Keep this everywhere you're going.
461 const struct _be_node_factory_t *node_factory; /**< The node factory for be nodes. */
462 const arch_isa_if_t *isa; /**< The isa about which everything is. */
464 arch_irn_handler_t const *handlers[ARCH_MAX_HANDLERS]; /**< The handlers are organized as
467 int handlers_tos; /**< The stack pointer of the handler
472 * Get the isa of an arch environment.
473 * @param env The environment.
474 * @return The isa with which the env was initialized with.
476 #define arch_env_get_isa(env) ((env)->isa)
479 * Initialize the architecture environment struct.
480 * @param isa The isa which shall be put into the environment.
481 * @return The environment.
483 extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
486 * Add a node handler to the environment.
487 * @param env The environment.
488 * @param handler A node handler.
489 * @return The environment itself.
491 extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env,
492 const arch_irn_handler_t *handler);
494 #endif /* _FIRM_BEARCH_H */