mono/mini/linear-scan.c

   1 /*
   2  * liveness.c: liveness analysis
   3  *
   4  * Author:
   5  *   Dietmar Maurer (dietmar@ximian.com)
   6  *
   7  * (C) 2002 Ximian, Inc.
   8  */
   9
  10 #include "mini.h"
  11 #include <mono/metadata/debug-helpers.h>
  12
  13 #ifndef DISABLE_JIT
  14
  15 static void mono_linear_scan2 (MonoCompile *cfg, GList *vars, GList *regs, regmask_t *used_mask);
  16
  17 GList *
  18 mono_varlist_insert_sorted (MonoCompile *cfg, GList *list, MonoMethodVar *mv, int sort_type)
  19 {
  20         GList *l;
  21
  22         if (!list)
  23                 return g_list_prepend (NULL, mv);
  24
  25         for (l = list; l; l = l->next) {
  26                 MonoMethodVar *v1 = (MonoMethodVar *)l->data;
  27
  28                 if (sort_type == 2) {
  29                         if (mv->spill_costs >= v1->spill_costs) {
  30                                 list = g_list_insert_before (list, l, mv);
  31                                 break;
  32                         }
  33                 } else if (sort_type == 1) {
  34                         if (mv->range.last_use.abs_pos <= v1->range.last_use.abs_pos) {
  35                                 list = g_list_insert_before (list, l, mv);
  36                                 break;
  37                         }
  38                 } else {
  39                         if (mv->range.first_use.abs_pos <= v1->range.first_use.abs_pos) {
  40                                 list = g_list_insert_before (list, l, mv);
  41                                 break;
  42                         }
  43                 }
  44         }
  45         if (!l)
  46                 list = g_list_append (list, mv);
  47
  48         return list;
  49 }
  50
  51 static gint
  52 compare_by_first_use_func (gconstpointer a, gconstpointer b)
  53 {
  54         MonoMethodVar *v1 = (MonoMethodVar*)a;
  55         MonoMethodVar *v2 = (MonoMethodVar*)b;
  56
  57         return v1->range.first_use.abs_pos - v2->range.first_use.abs_pos;
  58 }
  59
  60 GList *
  61 mono_varlist_sort (MonoCompile *cfg, GList *list, int sort_type)
  62 {
  63         if (sort_type == 0)
  64                 return g_list_sort (list, compare_by_first_use_func);
  65         else
  66                 g_assert_not_reached ();
  67
  68         return NULL;
  69 }
  70
  71 // #define DEBUG_LSCAN
  72
  73 void
  74 mono_linear_scan (MonoCompile *cfg, GList *vars, GList *regs, regmask_t *used_mask)
  75 {
  76         GList *l, *a, *active = NULL;
  77         MonoMethodVar *vmv, *amv;
  78         int max_regs, n_regvars;
  79         int gains [sizeof (regmask_t) * 8];
  80         regmask_t used_regs = 0;
  81         gboolean cost_driven;
  82
  83         if (!cfg->disable_reuse_registers && vars && (((MonoMethodVar*)vars->data)->interval != NULL)) {
  84                 mono_linear_scan2 (cfg, vars, regs, used_mask);
  85                 g_list_free (regs);
  86                 return;
  87         }
  88
  89         cost_driven = TRUE;
  90
  91 #ifdef DEBUG_LSCAN
  92         printf ("Linears scan for %s\n", mono_method_full_name (cfg->method, TRUE));
  93 #endif
  94
  95 #ifdef DEBUG_LSCAN
  96         for (l = vars; l; l = l->next) {
  97                 vmv = l->data;
  98                 printf ("VAR %d %08x %08x C%d\n", vmv->idx, vmv->range.first_use.abs_pos,
  99                         vmv->range.last_use.abs_pos, vmv->spill_costs);
 100         }
 101 #endif
 102         max_regs = g_list_length (regs);
 103
 104         for (l = regs; l; l = l->next) {
 105                 int regnum = GPOINTER_TO_INT (l->data);
 106                 g_assert (regnum < G_N_ELEMENTS (gains));
 107                 gains [regnum] = 0;
 108         }
 109
 110         /* linear scan */
 111         for (l = vars; l; l = l->next) {
 112                 vmv = (MonoMethodVar *)l->data;
 113
 114 #ifdef DEBUG_LSCAN
 115                 printf ("START  %2d %08x %08x\n",  vmv->idx, vmv->range.first_use.abs_pos,
 116                         vmv->range.last_use.abs_pos);
 117 #endif
 118                 /* expire old intervals in active */
 119                 if (!cfg->disable_reuse_registers) {
 120                         while (active) {
 121                                 amv = (MonoMethodVar *)active->data;
 122
 123                                 if (amv->range.last_use.abs_pos > vmv->range.first_use.abs_pos)
 124                                         break;
 125
 126 #ifdef DEBUG_LSCAN
 127                                 printf ("EXPIR  %2d %08x %08x C%d R%d\n", amv->idx, amv->range.first_use.abs_pos,
 128                                                 amv->range.last_use.abs_pos, amv->spill_costs, amv->reg);
 129 #endif
 130                                 active = g_list_delete_link (active, active);
 131                                 regs = g_list_prepend (regs, GINT_TO_POINTER (amv->reg));
 132                                 gains [amv->reg] += amv->spill_costs;
 133                         }
 134                 }
 135
 136                 if (active && g_list_length (active) == max_regs) {
 137                         /* Spill */
 138
 139                         a = g_list_nth (active, max_regs - 1);
 140                         amv = (MonoMethodVar *)a->data;
 141
 142                         if ((cost_driven && amv->spill_costs < vmv->spill_costs) ||
 143                             (!cost_driven && amv->range.last_use.abs_pos > vmv->range.last_use.abs_pos)) {
 144                                 vmv->reg = amv->reg;
 145                                 amv->reg = -1;
 146                                 active = g_list_delete_link (active, a);
 147
 148                                 if (cost_driven)
 149                                         active = mono_varlist_insert_sorted (cfg, active, vmv, 2);
 150                                 else
 151                                         active = mono_varlist_insert_sorted (cfg, active, vmv, 1);
 152
 153 #ifdef DEBUG_LSCAN
 154                                 printf ("SPILL0 %2d %08x %08x C%d\n",  amv->idx,
 155                                         amv->range.first_use.abs_pos, amv->range.last_use.abs_pos,
 156                                         amv->spill_costs);
 157 #endif
 158                         } else {
 159 #ifdef DEBUG_LSCAN
 160                                 printf ("SPILL1 %2d %08x %08x C%d\n",  vmv->idx,
 161                                         vmv->range.first_use.abs_pos, vmv->range.last_use.abs_pos,
 162                                         vmv->spill_costs);
 163 #endif
 164                                 vmv->reg = -1;
 165                         }
 166                 } else {
 167                         /* assign register */
 168
 169                         g_assert (regs);
 170
 171                         vmv->reg = GPOINTER_TO_INT (regs->data);
 172
 173                         used_regs |= 1LL << vmv->reg;
 174
 175                         regs = g_list_delete_link (regs, regs);
 176
 177 #ifdef DEBUG_LSCAN
 178                         printf ("ADD    %2d %08x %08x C%d R%d\n",  vmv->idx,
 179                                 vmv->range.first_use.abs_pos, vmv->range.last_use.abs_pos,
 180                                 vmv->spill_costs, vmv->reg);
 181 #endif
 182                         active = mono_varlist_insert_sorted (cfg, active, vmv, TRUE);
 183                 }
 184
 185
 186 #ifdef DEBUG_LSCAN
 187                 for (a = active; a; a = a->next) {
 188                         amv = (MonoMethodVar *)a->data;
 189                         printf ("ACT    %2d %08x %08x C%d R%d\n", amv->idx, amv->range.first_use.abs_pos,
 190                                 amv->range.last_use.abs_pos, amv->spill_costs, amv->reg);
 191                 }
 192                 printf ("NEXT\n");
 193 #endif
 194         }
 195
 196         for (a = active; a; a = a->next) {
 197                 amv = (MonoMethodVar *)a->data;
 198                 gains [amv->reg] += amv->spill_costs;
 199         }
 200
 201         n_regvars = 0;
 202         for (l = vars; l; l = l->next) {
 203                 vmv = (MonoMethodVar *)l->data;
 204
 205                 if (vmv->reg >= 0)  {
 206                         if ((gains [vmv->reg] > mono_arch_regalloc_cost (cfg, vmv)) && (cfg->varinfo [vmv->idx]->opcode != OP_REGVAR)) {
 207                                 if (cfg->verbose_level > 2) {
 208                                         printf ("ALLOCATED R%d(%d) TO HREG %d COST %d\n", cfg->varinfo [vmv->idx]->dreg, vmv->idx, vmv->reg, vmv->spill_costs);
 209                                 }
 210                                 cfg->varinfo [vmv->idx]->opcode = OP_REGVAR;
 211                                 cfg->varinfo [vmv->idx]->dreg = vmv->reg;
 212                                 n_regvars ++;
 213                         } else {
 214                                 if (cfg->verbose_level > 2)
 215                                         printf ("COSTLY: R%d C%d C%d %s\n", vmv->idx, vmv->spill_costs, mono_arch_regalloc_cost (cfg, vmv), mono_arch_regname (vmv->reg));
 216                                 vmv->reg = -1;
 217                         }
 218                 }
 219
 220                 if (vmv->reg == -1) {
 221                         if (cfg->verbose_level > 2)
 222                                 printf ("NOT REGVAR: %d\n", vmv->idx);
 223                 }
 224         }
 225
 226         cfg->stat_n_regvars = n_regvars;
 227
 228         /* Compute used regs */
 229         used_regs = 0;
 230         for (l = vars; l; l = l->next) {
 231                 vmv = (MonoMethodVar *)l->data;
 232
 233                 if (vmv->reg >= 0)
 234                         used_regs |= 1LL << vmv->reg;
 235         }
 236
 237         *used_mask |= used_regs;
 238
 239 #ifdef DEBUG_LSCAN
 240         if (cfg->verbose_level > 2)
 241                 printf ("EXIT: final used mask: %08x\n", *used_mask);
 242 #endif
 243
 244         g_list_free (regs);
 245         g_list_free (active);
 246         g_list_free (vars);
 247 }
 248
 249 static gint
 250 compare_by_interval_start_pos_func (gconstpointer a, gconstpointer b)
 251 {
 252         MonoMethodVar *v1 = (MonoMethodVar*)a;
 253         MonoMethodVar *v2 = (MonoMethodVar*)b;
 254
 255         if (v1 == v2)
 256                 return 0;
 257         else if (v1->interval->range && v2->interval->range)
 258                 return v1->interval->range->from - v2->interval->range->from;
 259         else if (v1->interval->range)
 260                 return -1;
 261         else
 262                 return 1;
 263 }
 264
 265 #if 0
 266 #define LSCAN_DEBUG(a) do { a; } while (0)
 267 #else
 268 #define LSCAN_DEBUG(a)
 269 #endif
 270
 271 /* FIXME: This is x86 only */
 272 static inline guint32
 273 regalloc_cost (MonoCompile *cfg, MonoMethodVar *vmv)
 274 {
 275         MonoInst *ins = cfg->varinfo [vmv->idx];
 276
 277         /* Load if it is an argument */
 278         return (ins->opcode == OP_ARG) ? 1 : 0;
 279 }
 280
 281 void
 282 mono_linear_scan2 (MonoCompile *cfg, GList *vars, GList *regs, regmask_t *used_mask)
 283 {
 284         GList *unhandled, *active, *inactive, *l;
 285         MonoMethodVar *vmv;
 286         gint32 free_pos [sizeof (regmask_t) * 8];
 287         gint32 gains [sizeof (regmask_t) * 8];
 288         regmask_t used_regs = 0;
 289         int n_regs, n_regvars, i;
 290
 291         for (l = vars; l; l = l->next) {
 292                 vmv = (MonoMethodVar *)l->data;
 293                 LSCAN_DEBUG (printf ("VAR R%d %08x %08x C%d\n", cfg->varinfo [vmv->idx]->dreg, vmv->range.first_use.abs_pos,
 294                                                          vmv->range.last_use.abs_pos, vmv->spill_costs));
 295         }
 296
 297         LSCAN_DEBUG (printf ("Linear Scan 2 for %s:\n", mono_method_full_name (cfg->method, TRUE)));
 298
 299         n_regs = g_list_length (regs);
 300         memset (gains, 0, n_regs * sizeof (gint32));
 301         unhandled = g_list_sort (g_list_copy (vars), compare_by_interval_start_pos_func);
 302         active = NULL;
 303         inactive = NULL;
 304
 305         while (unhandled) {
 306                 MonoMethodVar *current = (MonoMethodVar *)unhandled->data;
 307                 int pos, reg, max_free_pos;
 308                 gboolean changed;
 309
 310                 unhandled = g_list_delete_link (unhandled, unhandled);
 311
 312                 LSCAN_DEBUG (printf ("Processing R%d: ", cfg->varinfo [current->idx]->dreg));
 313                 LSCAN_DEBUG (mono_linterval_print (current->interval));
 314                 LSCAN_DEBUG (printf ("\n"));
 315
 316                 if (!current->interval->range)
 317                         continue;
 318
 319                 pos = current->interval->range->from;
 320
 321                 /* Check for intervals in active which expired or inactive */
 322                 changed = TRUE;
 323                 /* FIXME: Optimize this */
 324                 while (changed) {
 325                         changed = FALSE;
 326                         for (l = active; l != NULL; l = l->next) {
 327                                 MonoMethodVar *v = (MonoMethodVar*)l->data;
 328
 329                                 if (v->interval->last_range->to < pos) {
 330                                         active = g_list_delete_link (active, l);
 331                                         LSCAN_DEBUG (printf ("Interval R%d has expired\n", cfg->varinfo [v->idx]->dreg));
 332                                         changed = TRUE;
 333                                         break;
 334                                 }
 335                                 else if (!mono_linterval_covers (v->interval, pos)) {
 336                                         inactive = g_list_append (inactive, v);
 337                                         active = g_list_delete_link (active, l);
 338                                         LSCAN_DEBUG (printf ("Interval R%d became inactive\n", cfg->varinfo [v->idx]->dreg));
 339                                         changed = TRUE;
 340                                         break;
 341                                 }
 342                         }
 343                 }
 344
 345                 /* Check for intervals in inactive which expired or active */
 346                 changed = TRUE;
 347                 /* FIXME: Optimize this */
 348                 while (changed) {
 349                         changed = FALSE;
 350                         for (l = inactive; l != NULL; l = l->next) {
 351                                 MonoMethodVar *v = (MonoMethodVar*)l->data;
 352
 353                                 if (v->interval->last_range->to < pos) {
 354                                         inactive = g_list_delete_link (inactive, l);
 355                                         LSCAN_DEBUG (printf ("\tInterval R%d has expired\n", cfg->varinfo [v->idx]->dreg));
 356                                         changed = TRUE;
 357                                         break;
 358                                 }
 359                                 else if (mono_linterval_covers (v->interval, pos)) {
 360                                         active = g_list_append (active, v);
 361                                         inactive = g_list_delete_link (inactive, l);
 362                                         LSCAN_DEBUG (printf ("\tInterval R%d became active\n", cfg->varinfo [v->idx]->dreg));
 363                                         changed = TRUE;
 364                                         break;
 365                                 }
 366                         }
 367                 }
 368
 369                 /* Find a register for the current interval */
 370                 for (i = 0; i < n_regs; ++i)
 371                         free_pos [i] = ((gint32)0x7fffffff);
 372
 373                 for (l = active; l != NULL; l = l->next) {
 374                         MonoMethodVar *v = (MonoMethodVar*)l->data;
 375
 376                         if (v->reg >= 0) {
 377                                 free_pos [v->reg] = 0;
 378                                 LSCAN_DEBUG (printf ("\threg %d is busy (cost %d)\n", v->reg, v->spill_costs));
 379                         }
 380                 }
 381
 382                 for (l = inactive; l != NULL; l = l->next) {
 383                         MonoMethodVar *v = (MonoMethodVar*)l->data;
 384                         gint32 intersect_pos;
 385
 386                         if (v->reg >= 0) {
 387                                 intersect_pos = mono_linterval_get_intersect_pos (current->interval, v->interval);
 388                                 if (intersect_pos != -1) {
 389                                         free_pos [v->reg] = intersect_pos;
 390                                         LSCAN_DEBUG (printf ("\threg %d becomes free at %d\n", v->reg, intersect_pos));
 391                                 }
 392                         }
 393                 }
 394
 395                 max_free_pos = -1;
 396                 reg = -1;
 397                 for (i = 0; i < n_regs; ++i)
 398                         if (free_pos [i] > max_free_pos) {
 399                                 reg = i;
 400                                 max_free_pos = free_pos [i];
 401                         }
 402
 403                 g_assert (reg != -1);
 404
 405                 if (free_pos [reg] >= current->interval->last_range->to) {
 406                         /* Register available for whole interval */
 407                         current->reg = reg;
 408                         LSCAN_DEBUG (printf ("\tAssigned hreg %d to R%d\n", reg, cfg->varinfo [current->idx]->dreg));
 409
 410                         active = g_list_append (active, current);
 411                         gains [current->reg] += current->spill_costs;
 412                 }
 413                 else {
 414                         /*
 415                          * free_pos [reg] > 0 means there is a register available for parts
 416                          * of the interval, so splitting it is possible. This is not yet
 417                          * supported, so we spill in this case too.
 418                          */
 419
 420                         /* Spill an interval */
 421
 422                         /* FIXME: Optimize the selection of the interval */
 423
 424                         if (active) {
 425                                 GList *min_spill_pos;
 426 #if 0
 427                                 /*
 428                                  * This favors registers with big spill costs, thus larger liveness ranges,
 429                                  * thus actually leading to worse code size.
 430                                  */
 431                                 guint32 min_spill_value = G_MAXINT32;
 432
 433                                 for (l = active; l != NULL; l = l->next) {
 434                                         vmv = (MonoMethodVar*)l->data;
 435
 436                                         if (vmv->spill_costs < min_spill_value) {
 437                                                 min_spill_pos = l;
 438                                                 min_spill_value = vmv->spill_costs;
 439                                         }
 440                                 }
 441 #else
 442                                 /* Spill either the first active or the current interval */
 443                                 min_spill_pos = active;
 444 #endif
 445                                 vmv = (MonoMethodVar*)min_spill_pos->data;
 446                                 if (vmv->spill_costs < current->spill_costs) {
 447                                 //                              if (vmv->interval->last_range->to < current->interval->last_range->to) {
 448                                         gains [vmv->reg] -= vmv->spill_costs;
 449                                         vmv->reg = -1;
 450                                         LSCAN_DEBUG (printf ("\tSpilled R%d\n", cfg->varinfo [vmv->idx]->dreg));
 451                                         active = g_list_delete_link (active, min_spill_pos);
 452                                 }
 453                                 else
 454                                         LSCAN_DEBUG (printf ("\tSpilled current (cost %d)\n", current->spill_costs));
 455                         }
 456                         else
 457                                 LSCAN_DEBUG (printf ("\tSpilled current\n"));
 458                 }
 459         }
 460
 461         /* Decrease the gains by the cost of saving+restoring the register */
 462         for (i = 0; i < n_regs; ++i) {
 463                 if (gains [i]) {
 464                         /* FIXME: This is x86 only */
 465                         gains [i] -= cfg->method->save_lmf ? 1 : 2;
 466                         if (gains [i] < 0)
 467                                 gains [i] = 0;
 468                 }
 469         }
 470
 471         /* Do the actual register assignment */
 472         n_regvars = 0;
 473         for (l = vars; l; l = l->next) {
 474                 vmv = (MonoMethodVar *)l->data;
 475
 476                 if (vmv->reg >= 0) {
 477                         int reg_index = vmv->reg;
 478
 479                         /* During allocation, vmv->reg is an index into the regs list */
 480                         vmv->reg = GPOINTER_TO_INT (g_list_nth_data (regs, vmv->reg));
 481
 482                         if ((gains [reg_index] > regalloc_cost (cfg, vmv)) && (cfg->varinfo [vmv->idx]->opcode != OP_REGVAR)) {
 483                                 if (cfg->verbose_level > 2)
 484                                         printf ("REGVAR R%d G%d C%d %s\n", cfg->varinfo [vmv->idx]->dreg, gains [reg_index], regalloc_cost (cfg, vmv), mono_arch_regname (vmv->reg));
 485                                 cfg->varinfo [vmv->idx]->opcode = OP_REGVAR;
 486                                 cfg->varinfo [vmv->idx]->dreg = vmv->reg;
 487                                 n_regvars ++;
 488                         }
 489                         else {
 490                                 if (cfg->verbose_level > 2)
 491                                         printf ("COSTLY: %s R%d G%d C%d %s\n", mono_method_full_name (cfg->method, TRUE), cfg->varinfo [vmv->idx]->dreg, gains [reg_index], regalloc_cost (cfg, vmv), mono_arch_regname (vmv->reg));
 492                                 vmv->reg = -1;
 493                         }
 494                 }
 495         }
 496
 497         cfg->stat_n_regvars = n_regvars;
 498
 499         /* Compute used regs */
 500         used_regs = 0;
 501         for (l = vars; l; l = l->next) {
 502                 vmv = (MonoMethodVar *)l->data;
 503
 504                 if (vmv->reg >= 0)
 505                         used_regs |= 1LL << vmv->reg;
 506         }
 507
 508         *used_mask |= used_regs;
 509
 510         g_list_free (active);
 511         g_list_free (inactive);
 512 }
 513
 514 #endif /* #ifndef DISABLE_JIT */