1/*
2 * Copyright © 2010 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 *
23 * Authors:
24 *    Eric Anholt <eric@anholt.net>
25 *
26 */
27
28#ifndef REGISTER_ALLOCATE_H
29#define REGISTER_ALLOCATE_H
30
31#include <stdbool.h>
32#include "util/bitset.h"
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38
39struct ra_class;
40struct ra_regs;
41
42/* @{
43 * Register set setup.
44 *
45 * This should be done once at backend initializaion, as
46 * ra_set_finalize is O(r^2*c^2).  The registers may be virtual
47 * registers, such as aligned register pairs that conflict with the
48 * two real registers from which they are composed.
49 */
50struct ra_regs *ra_alloc_reg_set(void *mem_ctx, unsigned int count,
51                                 bool need_conflict_lists);
52void ra_set_allocate_round_robin(struct ra_regs *regs);
53unsigned int ra_alloc_reg_class(struct ra_regs *regs);
54void ra_add_reg_conflict(struct ra_regs *regs,
55			 unsigned int r1, unsigned int r2);
56void ra_add_transitive_reg_conflict(struct ra_regs *regs,
57				    unsigned int base_reg, unsigned int reg);
58void ra_make_reg_conflicts_transitive(struct ra_regs *regs, unsigned int reg);
59void ra_class_add_reg(struct ra_regs *regs, unsigned int c, unsigned int reg);
60void ra_set_num_conflicts(struct ra_regs *regs, unsigned int class_a,
61                          unsigned int class_b, unsigned int num_conflicts);
62void ra_set_finalize(struct ra_regs *regs, unsigned int **conflicts);
63/** @} */
64
65/** @{ Interference graph setup.
66 *
67 * Each interference graph node is a virtual variable in the IL.  It
68 * is up to the user to ra_set_node_class() for the virtual variable,
69 * and compute live ranges and ra_node_interfere() between conflicting
70 * live ranges. Note that an interference *must not* be added between
71 * two nodes if their classes haven't been assigned yet. The user
72 * should set the class of each node before building the interference
73 * graph.
74 */
75struct ra_graph *ra_alloc_interference_graph(struct ra_regs *regs,
76					     unsigned int count);
77void ra_set_node_class(struct ra_graph *g, unsigned int n, unsigned int c);
78void ra_set_select_reg_callback(struct ra_graph *g,
79                                unsigned int (*callback)(struct ra_graph *g,
80                                                         BITSET_WORD *regs,
81                                                         void *data),
82                                void *data);
83void ra_add_node_interference(struct ra_graph *g,
84			      unsigned int n1, unsigned int n2);
85/** @} */
86
87/** @{ Graph-coloring register allocation */
88bool ra_allocate(struct ra_graph *g);
89
90unsigned int ra_get_node_reg(struct ra_graph *g, unsigned int n);
91void ra_set_node_reg(struct ra_graph * g, unsigned int n, unsigned int reg);
92void ra_set_node_spill_cost(struct ra_graph *g, unsigned int n, float cost);
93int ra_get_best_spill_node(struct ra_graph *g);
94/** @} */
95
96
97#ifdef __cplusplus
98}  // extern "C"
99#endif
100
101#endif /* REGISTER_ALLOCATE_H */
102