becopyilp: Do not advertise the switch to dump the solution, because this is not...
[libfirm] / ir / be / besched.c
index a3c0e02..c156d73 100644 (file)
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
+/*
+ * This file is part of libFirm.
+ * Copyright (C) 2012 University of Karlsruhe.
+ */
+
+/**
+ * @file
+ * @brief       Scheduling utilities for nodes in Blocks and Blocks.
+ * @author      Sebastian Hack
+ */
+#include "config.h"
 
-#ifdef HAVE_STDLIB_H
-# include <stdlib.h>
-#endif
+#include <stdlib.h>
 
-#include "impl.h"
-#include "irprintf.h"
-#include "irgwalk.h"
-#include "irnode_t.h"
-#include "irgraph_t.h"
+#include "firm_types.h"
 #include "iredges_t.h"
+#include "ircons.h"
+#include "irgmod.h"
 #include "debug.h"
 
+#include "bemodule.h"
 #include "bearch.h"
-#include "besched_t.h"
+#include "besched.h"
 #include "beutil.h"
 #include "belistsched.h"
+#include "belive.h"
 
-FIRM_IMPL1(sched_get_time_step, int, const ir_node *)
-FIRM_IMPL1(sched_has_next, int, const ir_node *)
-FIRM_IMPL1(sched_has_prev, int, const ir_node *)
-FIRM_IMPL1(sched_next, ir_node *, const ir_node *)
-FIRM_IMPL1(sched_prev, ir_node *, const ir_node *)
-FIRM_IMPL1(sched_first, ir_node *, const ir_node *)
-FIRM_IMPL1(sched_last, ir_node *, const ir_node *)
-FIRM_IMPL2(sched_add_after, ir_node *, ir_node *, ir_node *)
-FIRM_IMPL2(sched_add_before, ir_node *, ir_node *, ir_node *)
-FIRM_IMPL2(sched_comes_after, int, const ir_node *, const ir_node *)
-FIRM_IMPL1_VOID(sched_remove, ir_node *)
+#include "lc_opts.h"
+#include "lc_opts_enum.h"
+#include "irtools.h"
 
-size_t sched_irn_data_offset = 0;
+#define SCHED_INITIAL_GRANULARITY (1 << 14)
 
-static void block_sched_dumper(ir_node *block, void *env)
+static void sched_renumber(ir_node *const block)
 {
-       FILE *f = env;
-       const ir_node *curr;
+       sched_info_t *inf;
+       sched_timestep_t step = SCHED_INITIAL_GRANULARITY;
 
-       ir_fprintf(f, "%+F:\n", block);
-       sched_foreach(block, curr) {
-    sched_info_t *info = get_irn_sched_info(curr);
-               ir_fprintf(f, "\t%6d: %+F\n", info->time_step, curr);
+       sched_foreach(block, irn) {
+               inf = get_irn_sched_info(irn);
+               inf->time_step = step;
+               step += SCHED_INITIAL_GRANULARITY;
        }
 }
 
-void be_sched_dump(FILE *f, ir_graph *irg)
+static inline void sched_set_time_stamp(const ir_node *irn)
 {
-       irg_block_walk_graph(irg, block_sched_dumper, NULL, f);
+       sched_info_t       *info      = get_irn_sched_info(irn);
+       const sched_info_t *prev_info = get_irn_sched_info(info->prev);
+       const sched_info_t *next_info = get_irn_sched_info(info->next);
+       sched_timestep_t    before_ts = prev_info->time_step;
+       sched_timestep_t    after_ts  = next_info->time_step;
+
+       /*
+        * If we are the last, we can give us a big time step,
+        * else we have to compute our time step from our
+        * neighbours.
+        */
+       if(before_ts >= after_ts) {
+               info->time_step = before_ts + SCHED_INITIAL_GRANULARITY;
+               /* overflow? */
+               if (info->time_step <= before_ts) {
+                       sched_renumber(get_nodes_block(irn));
+               }
+       } else {
+               sched_timestep_t ts = (before_ts + after_ts) / 2;
+
+               /*
+                * If the resolution went out, we have to renumber
+                * this block.
+                */
+               if(ts == before_ts || ts == after_ts)
+                       sched_renumber(get_nodes_block(irn));
+               else
+                       info->time_step = ts;
+       }
 }
 
-/* Init the scheduling stuff. */
-void be_sched_init(void)
+void sched_add_before(ir_node *before, ir_node *irn)
 {
-       sched_irn_data_offset = register_additional_node_data(sizeof(sched_info_t));
-       firm_dbg_register("be.sched");
+       sched_info_t *info      = get_irn_sched_info(irn);
+       ir_node      *next      = before;
+       sched_info_t *next_info = get_irn_sched_info(next);
+       ir_node      *prev      = next_info->prev;
+       sched_info_t *prev_info = get_irn_sched_info(prev);
+       assert(sched_is_scheduled(before));
+       assert(!sched_is_scheduled(irn));
+       assert(!is_Proj(before));
+       assert(!is_Proj(irn));
+
+       info->prev = prev;
+       info->next = next;
+       prev_info->next = irn;
+       next_info->prev = irn;
+       sched_set_time_stamp(irn);
 }
 
-void sched_renumber(const ir_node *block)
+void sched_add_after(ir_node *after, ir_node *irn)
 {
-  ir_node *irn;
-  sched_info_t *inf;
-  sched_timestep_t step = 0;
-
-  sched_foreach(block, irn) {
-    inf = get_irn_sched_info(irn);
-    inf->time_step = step;
-    step += SCHED_INITIAL_GRANULARITY;
-  }
+       sched_info_t *info      = get_irn_sched_info(irn);
+       ir_node      *prev      = after;
+       sched_info_t *prev_info = get_irn_sched_info(prev);
+       ir_node      *next      = prev_info->next;
+       sched_info_t *next_info = get_irn_sched_info(next);
+       assert(sched_is_scheduled(after));
+       assert(!sched_is_scheduled(irn));
+       assert(!is_Proj(after));
+       assert(!is_Proj(irn));
+
+       info->prev = prev;
+       info->next = next;
+       prev_info->next = irn;
+       next_info->prev = irn;
+       sched_set_time_stamp(irn);
 }
 
-/* Verify a schedule. */
-int sched_verify(const ir_node *block)
+void sched_remove(ir_node *irn)
 {
-  firm_dbg_module_t *dbg_sched = firm_dbg_register("be.sched");
-  int res = 1;
-  const ir_node *irn;
-  int i, n;
-  int *save_time_step;
-  const ir_node **save_nodes;
-  const ir_edge_t *edge;
-  pset *scheduled_nodes = pset_new_ptr_default();
-
-  firm_dbg_set_mask(dbg_sched, -1);
-
-  /* Count the number of nodes in the schedule. */
-  n = 0;
-  sched_foreach(block, irn)
-    n++;
-
-  if(n <= 0)
-    return 1;
-
-  save_time_step = xmalloc(n * sizeof(save_time_step[0]));
-  save_nodes = xmalloc(n * sizeof(save_nodes[0]));
-
-  i = 0;
-  sched_foreach(block, irn) {
-    sched_info_t *info = get_irn_sched_info(irn);
-    save_time_step[i] = info->time_step;
-    save_nodes[i] = (ir_node *)irn;
-    info->time_step = i;
-    pset_insert_ptr(scheduled_nodes, irn);
-
-    i += 1;
-  }
-
-  /*
-   * Check if each relevant operand of a node is scheduled before
-   * the node itself.
-   */
-  sched_foreach(block, irn) {
-    int i, n;
-    int step = sched_get_time_step(irn);
-
-    for(i = 0, n = get_irn_arity(irn); i < n; i++) {
-      ir_node *op = get_irn_n(irn, i);
-
-      if(to_appear_in_schedule(op)
-          && !is_Phi(irn)
-          && get_nodes_block(op) == block
-          && sched_get_time_step(op) > step) {
-
-          DBG((dbg_sched, LEVEL_DEFAULT,
-                "%+F: %+F is operand of %+F but scheduled after\n", block, op, irn));
-          res = 0;
-      }
-    }
-  }
-
-  /* Check, if the time steps are correct */
-  for(i = 1; i < n; ++i) {
-    if(save_time_step[i] - save_time_step[i - 1] <= 0) {
-      DBG((dbg_sched, LEVEL_DEFAULT,
-            "%+F from %+F(%d) -> %+F(%d) step shrinks from %d -> %d\n",
-            block, save_nodes[i - 1], i - 1, save_nodes[i], i,
-            save_time_step[i - 1], save_time_step[i]));
-      res = 0;
-    }
-  }
-
-  /* Restore the old time steps */
-  i = 0;
-  sched_foreach(block, irn) {
-    sched_info_t *info = get_irn_sched_info(irn);
-    info->time_step = save_time_step[i++];
-  }
-
-  /* Check for all nodes in the block if they are scheduled. */
-  foreach_out_edge(block, edge) {
-    ir_node *irn = get_edge_src_irn(edge);
-    if(to_appear_in_schedule(irn) && !pset_find_ptr(scheduled_nodes, irn))
-      DBG((dbg_sched, LEVEL_DEFAULT,
-            "%+F: %+F is in block but not scheduled\n", block, irn));
-  }
-
-  del_pset(scheduled_nodes);
-  free(save_time_step);
-  free((void *) save_nodes);
-  return res;
+       sched_info_t *info      = get_irn_sched_info(irn);
+       ir_node      *prev      = info->prev;
+       ir_node      *next      = info->next;
+       sched_info_t *prev_info = get_irn_sched_info(prev);
+       sched_info_t *next_info = get_irn_sched_info(next);
+       assert(sched_is_scheduled(irn));
+
+       prev_info->next = next;
+       next_info->prev = prev;
+       info->next      = NULL;
+       info->prev      = NULL;
 }
 
-/**
- * Block-Walker: verify the current block and update the status
- */
-static void sched_verify_walker(ir_node *block, void *data)
+void sched_replace(ir_node *const old, ir_node *const irn)
 {
-  int *res = data;
-  *res &= sched_verify(block);
-}
+       assert(sched_is_scheduled(old));
+       assert(!sched_is_scheduled(irn));
 
-/* Verify the schedules in all blocks of the irg. */
-int sched_verify_irg(ir_graph *irg)
-{
-  int res = 1;
-  irg_block_walk_graph(irg, sched_verify_walker, NULL, &res);
+       sched_info_t *const old_info = get_irn_sched_info(old);
+       sched_info_t *const irn_info = get_irn_sched_info(irn);
+       *irn_info = *old_info;
 
-  return res;
-}
+       old_info->prev = NULL;
+       old_info->next = NULL;
 
-int sched_skip_cf_predicator(const ir_node *irn, void *data) {
-  arch_env_t *ae = data;
-  return arch_irn_classify(ae, irn) == arch_irn_class_branch;
+       ir_node *const prev = irn_info->prev;
+       ir_node *const next = irn_info->next;
+       get_irn_sched_info(prev)->next = irn;
+       get_irn_sched_info(next)->prev = irn;
 }
 
-int sched_skip_phi_predicator(const ir_node *irn, void *data) {
-       return is_Phi(irn);
-}
+static be_module_list_entry_t *schedulers;
+static schedule_func           scheduler;
 
-/* Skip nodes in a schedule. */
-ir_node *sched_skip(ir_node *from, int forward, sched_predicator_t *predicator, void *data)
+void be_register_scheduler(const char *name, schedule_func func)
 {
-       const ir_node *bl = get_block(from);
-       ir_node *curr;
-
-       if (is_Block(from))
-               from = forward ? sched_next(from) : sched_prev(from);
-
-       for(curr = from; curr != bl && predicator(curr, data); curr = forward ? sched_next(curr) : sched_prev(curr));
-
-       return curr;
+       if (scheduler == NULL)
+               scheduler = func;
+       be_add_module_to_list(&schedulers, name, (void*)func);
 }
 
-/** A simple forward single linked list. */
-typedef struct {
-       ir_node *start;   /**< start of the list */
-       ir_node *end;     /**< last block in the list */
-       unsigned n_blks;  /**< number of blocks in the list */
-} anchor;
-
-/**
- * Ext-Block walker: create a block schedule
- */
-static void create_block_list(ir_extblk *blk, void *env) {
-       anchor *list = env;
-       int i, n;
-
-       for (i = 0, n = get_extbb_n_blocks(blk); i < n; ++i) {
-               ir_node *block = get_extbb_block(blk, i);
-
-               set_irn_link(block, NULL);
-               if (list->start)
-                       set_irn_link(list->end, block);
-               else
-                       list->start = block;
-
-               list->end = block;
-               ++list->n_blks;
-       }
+void be_schedule_graph(ir_graph *irg)
+{
+       scheduler(irg);
 }
 
-/*
- * Calculates a block schedule. The schedule is stored as a linked
- * list starting at the start_block of the irg.
- */
-ir_node **sched_create_block_schedule(ir_graph *irg)
+BE_REGISTER_MODULE_CONSTRUCTOR(be_init_sched)
+void be_init_sched(void)
 {
-       anchor list;
-       ir_node **blk_list, *b, *n;
-       unsigned i;
-
-       /* schedule extended basic blocks */
-       compute_extbb(irg);
-
-       list.start  = NULL;
-       list.end    = NULL;
-       list.n_blks = 0;
-       irg_extblock_walk_graph(irg, NULL, create_block_list, &list);
-
-       /** create an array, so we can go forward and backward */
-       blk_list = NEW_ARR_D(ir_node *, irg->obst,list.n_blks);
-
-       for (i = 0, b = list.start; b; b = n, ++i) {
-               n = get_irn_link(b);
-               set_irn_link(b, INT_TO_PTR(i));
-
-               blk_list[i] = b;
-       }
-       return blk_list;
+       lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
+       be_add_module_list_opt(be_grp, "scheduler", "scheduling algorithm",
+                              &schedulers, (void**)&scheduler);
 }