src/util/register_allocate.h

   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
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37
  38 struct ra_class;
  39 struct ra_regs;
  40
  41 /* @{
  42  * Register set setup.
  43  *
  44  * This should be done once at backend initializaion, as
  45  * ra_set_finalize is O(r^2*c^2).  The registers may be virtual
  46  * registers, such as aligned register pairs that conflict with the
  47  * two real registers from which they are composed.
  48  */
  49 struct ra_regs *ra_alloc_reg_set(void *mem_ctx, unsigned int count,
  50                                  bool need_conflict_lists);
  51 void ra_set_allocate_round_robin(struct ra_regs *regs);
  52 unsigned int ra_alloc_reg_class(struct ra_regs *regs);
  53 void ra_add_reg_conflict(struct ra_regs *regs,
  54                          unsigned int r1, unsigned int r2);
  55 void ra_add_transitive_reg_conflict(struct ra_regs *regs,
  56                                     unsigned int base_reg, unsigned int reg);
  57 void ra_make_reg_conflicts_transitive(struct ra_regs *regs, unsigned int reg);
  58 void ra_class_add_reg(struct ra_regs *regs, unsigned int c, unsigned int reg);
  59 void ra_set_num_conflicts(struct ra_regs *regs, unsigned int class_a,
  60                           unsigned int class_b, unsigned int num_conflicts);
  61 void ra_set_finalize(struct ra_regs *regs, unsigned int **conflicts);
  62 /** @} */
  63
  64 /** @{ Interference graph setup.
  65  *
  66  * Each interference graph node is a virtual variable in the IL.  It
  67  * is up to the user to ra_set_node_class() for the virtual variable,
  68  * and compute live ranges and ra_node_interfere() between conflicting
  69  * live ranges. Note that an interference *must not* be added between
  70  * two nodes if their classes haven't been assigned yet. The user
  71  * should set the class of each node before building the interference
  72  * graph.
  73  */
  74 struct ra_graph *ra_alloc_interference_graph(struct ra_regs *regs,
  75                                              unsigned int count);
  76 void ra_set_node_class(struct ra_graph *g, unsigned int n, unsigned int c);
  77 void ra_add_node_interference(struct ra_graph *g,
  78                               unsigned int n1, unsigned int n2);
  79 /** @} */
  80
  81 /** @{ Graph-coloring register allocation */
  82 bool ra_allocate(struct ra_graph *g);
  83
  84 unsigned int ra_get_node_reg(struct ra_graph *g, unsigned int n);
  85 void ra_set_node_reg(struct ra_graph * g, unsigned int n, unsigned int reg);
  86 void ra_set_node_spill_cost(struct ra_graph *g, unsigned int n, float cost);
  87 int ra_get_best_spill_node(struct ra_graph *g);
  88 /** @} */
  89
  90
  91 #ifdef __cplusplus
  92 }  // extern "C"
  93 #endif
  94
  95 #endif /* REGISTER_ALLOCATE_H */