2 * Copyright © 2010 Intel Corporation
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:
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
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
24 * Eric Anholt <eric@anholt.net>
28 /** @file register_allocate.c
30 * Graph-coloring register allocator.
32 * The basic idea of graph coloring is to make a node in a graph for
33 * every thing that needs a register (color) number assigned, and make
34 * edges in the graph between nodes that interfere (can't be allocated
35 * to the same register at the same time).
37 * During the "simplify" process, any any node with fewer edges than
38 * there are registers means that that edge can get assigned a
39 * register regardless of what its neighbors choose, so that node is
40 * pushed on a stack and removed (with its edges) from the graph.
41 * That likely causes other nodes to become trivially colorable as well.
43 * Then during the "select" process, nodes are popped off of that
44 * stack, their edges restored, and assigned a color different from
45 * their neighbors. Because they were pushed on the stack only when
46 * they were trivially colorable, any color chosen won't interfere
47 * with the registers to be popped later.
49 * The downside to most graph coloring is that real hardware often has
50 * limitations, like registers that need to be allocated to a node in
51 * pairs, or aligned on some boundary. This implementation follows
52 * the paper "Retargetable Graph-Coloring Register Allocation for
53 * Irregular Architectures" by Johan Runeson and Sven-Olof Nyström.
55 * In this system, there are register classes each containing various
56 * registers, and registers may interfere with other registers. For
57 * example, one might have a class of base registers, and a class of
58 * aligned register pairs that would each interfere with their pair of
59 * the base registers. Each node has a register class it needs to be
60 * assigned to. Define p(B) to be the size of register class B, and
61 * q(B,C) to be the number of registers in B that the worst choice
62 * register in C could conflict with. Then, this system replaces the
63 * basic graph coloring test of "fewer edges from this node than there
64 * are registers" with "For this node of class B, the sum of q(B,C)
65 * for each neighbor node of class C is less than pB".
67 * A nice feature of the pq test is that q(B,C) can be computed once
68 * up front and stored in a 2-dimensional array, so that the cost of
69 * coloring a node is constant with the number of registers. We do
70 * this during ra_set_finalize().
75 #include "main/imports.h"
76 #include "main/macros.h"
77 #include "main/mtypes.h"
78 #include "register_allocate.h"
84 unsigned int *conflict_list
;
85 unsigned int conflict_list_size
;
86 unsigned int num_conflicts
;
93 struct ra_class
**classes
;
94 unsigned int class_count
;
101 * p(B) in Runeson/Nyström paper.
103 * This is "how many regs are in the set."
108 * q(B,C) (indexed by C, B is this register class) in
109 * Runeson/Nyström paper. This is "how many registers of B could
110 * the worst choice register from C conflict with".
118 * List of which nodes this node interferes with. This should be
119 * symmetric with the other node.
121 GLboolean
*adjacency
;
122 unsigned int *adjacency_list
;
123 unsigned int adjacency_count
;
128 /* Register, if assigned, or NO_REG. */
132 * Set when the node is in the trivially colorable stack. When
133 * set, the adjacency to this node is ignored, to implement the
134 * "remove the edge from the graph" in simplification without
135 * having to actually modify the adjacency_list.
139 /* For an implementation that needs register spilling, this is the
140 * approximate cost of spilling this node.
146 struct ra_regs
*regs
;
148 * the variables that need register allocation.
150 struct ra_node
*nodes
;
151 unsigned int count
; /**< count of nodes. */
154 unsigned int stack_count
;
158 * Creates a set of registers for the allocator.
160 * mem_ctx is a ralloc context for the allocator. The reg set may be freed
161 * using ralloc_free().
164 ra_alloc_reg_set(void *mem_ctx
, unsigned int count
)
167 struct ra_regs
*regs
;
169 regs
= rzalloc(mem_ctx
, struct ra_regs
);
171 regs
->regs
= rzalloc_array(regs
, struct ra_reg
, count
);
173 for (i
= 0; i
< count
; i
++) {
174 regs
->regs
[i
].conflicts
= rzalloc_array(regs
->regs
, GLboolean
, count
);
175 regs
->regs
[i
].conflicts
[i
] = GL_TRUE
;
177 regs
->regs
[i
].conflict_list
= ralloc_array(regs
->regs
, unsigned int, 4);
178 regs
->regs
[i
].conflict_list_size
= 4;
179 regs
->regs
[i
].conflict_list
[0] = i
;
180 regs
->regs
[i
].num_conflicts
= 1;
187 ra_add_conflict_list(struct ra_regs
*regs
, unsigned int r1
, unsigned int r2
)
189 struct ra_reg
*reg1
= ®s
->regs
[r1
];
191 if (reg1
->conflict_list_size
== reg1
->num_conflicts
) {
192 reg1
->conflict_list_size
*= 2;
193 reg1
->conflict_list
= reralloc(regs
->regs
, reg1
->conflict_list
,
194 unsigned int, reg1
->conflict_list_size
);
196 reg1
->conflict_list
[reg1
->num_conflicts
++] = r2
;
197 reg1
->conflicts
[r2
] = GL_TRUE
;
201 ra_add_reg_conflict(struct ra_regs
*regs
, unsigned int r1
, unsigned int r2
)
203 if (!regs
->regs
[r1
].conflicts
[r2
]) {
204 ra_add_conflict_list(regs
, r1
, r2
);
205 ra_add_conflict_list(regs
, r2
, r1
);
210 * Adds a conflict between base_reg and reg, and also between reg and
211 * anything that base_reg conflicts with.
213 * This can simplify code for setting up multiple register classes
214 * which are aggregates of some base hardware registers, compared to
215 * explicitly using ra_add_reg_conflict.
218 ra_add_transitive_reg_conflict(struct ra_regs
*regs
,
219 unsigned int base_reg
, unsigned int reg
)
223 ra_add_reg_conflict(regs
, reg
, base_reg
);
225 for (i
= 0; i
< regs
->regs
[base_reg
].num_conflicts
; i
++) {
226 ra_add_reg_conflict(regs
, reg
, regs
->regs
[base_reg
].conflict_list
[i
]);
231 ra_alloc_reg_class(struct ra_regs
*regs
)
233 struct ra_class
*class;
235 regs
->classes
= reralloc(regs
->regs
, regs
->classes
, struct ra_class
*,
236 regs
->class_count
+ 1);
238 class = rzalloc(regs
, struct ra_class
);
239 regs
->classes
[regs
->class_count
] = class;
241 class->regs
= rzalloc_array(class, GLboolean
, regs
->count
);
243 return regs
->class_count
++;
247 ra_class_add_reg(struct ra_regs
*regs
, unsigned int c
, unsigned int r
)
249 struct ra_class
*class = regs
->classes
[c
];
251 class->regs
[r
] = GL_TRUE
;
256 * Must be called after all conflicts and register classes have been
257 * set up and before the register set is used for allocation.
260 ra_set_finalize(struct ra_regs
*regs
)
264 for (b
= 0; b
< regs
->class_count
; b
++) {
265 regs
->classes
[b
]->q
= ralloc_array(regs
, unsigned int, regs
->class_count
);
268 /* Compute, for each class B and C, how many regs of B an
269 * allocation to C could conflict with.
271 for (b
= 0; b
< regs
->class_count
; b
++) {
272 for (c
= 0; c
< regs
->class_count
; c
++) {
274 int max_conflicts
= 0;
276 for (rc
= 0; rc
< regs
->count
; rc
++) {
280 if (!regs
->classes
[c
]->regs
[rc
])
283 for (i
= 0; i
< regs
->regs
[rc
].num_conflicts
; i
++) {
284 unsigned int rb
= regs
->regs
[rc
].conflict_list
[i
];
285 if (regs
->classes
[b
]->regs
[rb
])
288 max_conflicts
= MAX2(max_conflicts
, conflicts
);
290 regs
->classes
[b
]->q
[c
] = max_conflicts
;
296 ra_add_node_adjacency(struct ra_graph
*g
, unsigned int n1
, unsigned int n2
)
298 g
->nodes
[n1
].adjacency
[n2
] = GL_TRUE
;
299 g
->nodes
[n1
].adjacency_list
[g
->nodes
[n1
].adjacency_count
] = n2
;
300 g
->nodes
[n1
].adjacency_count
++;
304 ra_alloc_interference_graph(struct ra_regs
*regs
, unsigned int count
)
309 g
= rzalloc(regs
, struct ra_graph
);
311 g
->nodes
= rzalloc_array(g
, struct ra_node
, count
);
314 g
->stack
= rzalloc_array(g
, unsigned int, count
);
316 for (i
= 0; i
< count
; i
++) {
317 g
->nodes
[i
].adjacency
= rzalloc_array(g
, GLboolean
, count
);
318 g
->nodes
[i
].adjacency_list
= ralloc_array(g
, unsigned int, count
);
319 g
->nodes
[i
].adjacency_count
= 0;
320 ra_add_node_adjacency(g
, i
, i
);
321 g
->nodes
[i
].reg
= NO_REG
;
328 ra_set_node_class(struct ra_graph
*g
,
329 unsigned int n
, unsigned int class)
331 g
->nodes
[n
].class = class;
335 ra_add_node_interference(struct ra_graph
*g
,
336 unsigned int n1
, unsigned int n2
)
338 if (!g
->nodes
[n1
].adjacency
[n2
]) {
339 ra_add_node_adjacency(g
, n1
, n2
);
340 ra_add_node_adjacency(g
, n2
, n1
);
344 static GLboolean
pq_test(struct ra_graph
*g
, unsigned int n
)
348 int n_class
= g
->nodes
[n
].class;
350 for (j
= 0; j
< g
->nodes
[n
].adjacency_count
; j
++) {
351 unsigned int n2
= g
->nodes
[n
].adjacency_list
[j
];
352 unsigned int n2_class
= g
->nodes
[n2
].class;
354 if (n
!= n2
&& !g
->nodes
[n2
].in_stack
) {
355 q
+= g
->regs
->classes
[n_class
]->q
[n2_class
];
359 return q
< g
->regs
->classes
[n_class
]->p
;
363 * Simplifies the interference graph by pushing all
364 * trivially-colorable nodes into a stack of nodes to be colored,
365 * removing them from the graph, and rinsing and repeating.
367 * Returns GL_TRUE if all nodes were removed from the graph. GL_FALSE
368 * means that either spilling will be required, or optimistic coloring
372 ra_simplify(struct ra_graph
*g
)
374 GLboolean progress
= GL_TRUE
;
380 for (i
= g
->count
- 1; i
>= 0; i
--) {
381 if (g
->nodes
[i
].in_stack
|| g
->nodes
[i
].reg
!= NO_REG
)
385 g
->stack
[g
->stack_count
] = i
;
387 g
->nodes
[i
].in_stack
= GL_TRUE
;
393 for (i
= 0; i
< g
->count
; i
++) {
394 if (!g
->nodes
[i
].in_stack
)
402 * Pops nodes from the stack back into the graph, coloring them with
403 * registers as they go.
405 * If all nodes were trivially colorable, then this must succeed. If
406 * not (optimistic coloring), then it may return GL_FALSE;
409 ra_select(struct ra_graph
*g
)
413 while (g
->stack_count
!= 0) {
415 int n
= g
->stack
[g
->stack_count
- 1];
416 struct ra_class
*c
= g
->regs
->classes
[g
->nodes
[n
].class];
418 /* Find the lowest-numbered reg which is not used by a member
419 * of the graph adjacent to us.
421 for (r
= 0; r
< g
->regs
->count
; r
++) {
425 /* Check if any of our neighbors conflict with this register choice. */
426 for (i
= 0; i
< g
->nodes
[n
].adjacency_count
; i
++) {
427 unsigned int n2
= g
->nodes
[n
].adjacency_list
[i
];
429 if (!g
->nodes
[n2
].in_stack
&&
430 g
->regs
->regs
[r
].conflicts
[g
->nodes
[n2
].reg
]) {
434 if (i
== g
->nodes
[n
].adjacency_count
)
437 if (r
== g
->regs
->count
)
441 g
->nodes
[n
].in_stack
= GL_FALSE
;
449 * Optimistic register coloring: Just push the remaining nodes
450 * on the stack. They'll be colored first in ra_select(), and
451 * if they succeed then the locally-colorable nodes are still
452 * locally-colorable and the rest of the register allocation
456 ra_optimistic_color(struct ra_graph
*g
)
460 for (i
= 0; i
< g
->count
; i
++) {
461 if (g
->nodes
[i
].in_stack
|| g
->nodes
[i
].reg
!= NO_REG
)
464 g
->stack
[g
->stack_count
] = i
;
466 g
->nodes
[i
].in_stack
= GL_TRUE
;
471 ra_allocate_no_spills(struct ra_graph
*g
)
473 if (!ra_simplify(g
)) {
474 ra_optimistic_color(g
);
480 ra_get_node_reg(struct ra_graph
*g
, unsigned int n
)
482 return g
->nodes
[n
].reg
;
486 * Forces a node to a specific register. This can be used to avoid
487 * creating a register class containing one node when handling data
488 * that must live in a fixed location and is known to not conflict
489 * with other forced register assignment (as is common with shader
490 * input data). These nodes do not end up in the stack during
491 * ra_simplify(), and thus at ra_select() time it is as if they were
492 * the first popped off the stack and assigned their fixed locations.
494 * Must be called before ra_simplify().
497 ra_set_node_reg(struct ra_graph
*g
, unsigned int n
, unsigned int reg
)
499 g
->nodes
[n
].reg
= reg
;
500 g
->nodes
[n
].in_stack
= GL_FALSE
;
504 ra_get_spill_benefit(struct ra_graph
*g
, unsigned int n
)
508 int n_class
= g
->nodes
[n
].class;
510 /* Define the benefit of eliminating an interference between n, n2
511 * through spilling as q(C, B) / p(C). This is similar to the
512 * "count number of edges" approach of traditional graph coloring,
513 * but takes classes into account.
515 for (j
= 0; j
< g
->nodes
[n
].adjacency_count
; j
++) {
516 unsigned int n2
= g
->nodes
[n
].adjacency_list
[j
];
518 unsigned int n2_class
= g
->nodes
[n2
].class;
519 benefit
+= ((float)g
->regs
->classes
[n_class
]->q
[n2_class
] /
520 g
->regs
->classes
[n_class
]->p
);
528 * Returns a node number to be spilled according to the cost/benefit using
529 * the pq test, or -1 if there are no spillable nodes.
532 ra_get_best_spill_node(struct ra_graph
*g
)
534 unsigned int best_node
= -1;
535 unsigned int best_benefit
= 0.0;
538 for (n
= 0; n
< g
->count
; n
++) {
539 float cost
= g
->nodes
[n
].spill_cost
;
545 benefit
= ra_get_spill_benefit(g
, n
);
547 if (benefit
/ cost
> best_benefit
) {
548 best_benefit
= benefit
/ cost
;
557 * Only nodes with a spill cost set (cost != 0.0) will be considered
558 * for register spilling.
561 ra_set_node_spill_cost(struct ra_graph
*g
, unsigned int n
, float cost
)
563 g
->nodes
[n
].spill_cost
= cost
;