hipe: Refactor ra callbacks to accept context arg

This allows us to pass around the context data that
hipe_regalloc_prepass needs cleanly, without using process dictionary or
parameterised modules (like it was previous to this change).

1 files changed, 86 insertions, 50 deletions

diff --git a/lib/hipe/regalloc/hipe_optimistic_regalloc.erl b/lib/hipe/regalloc/hipe_optimistic_regalloc.erl
index 43c6424655..031c799a2c 100644
--- a/lib/hipe/regalloc/hipe_optimistic_regalloc.erl
+++ b/lib/hipe/regalloc/hipe_optimistic_regalloc.erl
@@ -29,7 +29,7 @@
 %%-----------------------------------------------------------------------
 
 -module(hipe_optimistic_regalloc).
--export([regalloc/6]).
+-export([regalloc/7]).
 
 -ifndef(DEBUG).
 %%-define(DEBUG,true).
@@ -74,20 +74,22 @@
 %%   SpillLimit  -- Temporaris with numbers higher than this have
 %%                  infinit spill cost. 
 %%                  Consider changing this to a set.
-%%   Target      -- The module containing the target-specific functions.
+%%   TgtMod      -- The module containing the target-specific functions.
+%%   TgtCtx      -- Context data for TgtMod
 %%
 %% Returns:
 %%   Coloring    -- A coloring for specified CFG
 %%   SpillIndex2 -- A new spill index
 %%-----------------------------------------------------------------------
 -ifdef(COMPARE_ITERATED_OPTIMISTIC).
-regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
-  ?debug_msg("optimistic ~w\n",[Target]),
+regalloc(CFG, Liveness, SpillIndex, SpillLimit, TgtMod, TgtCtx, _Options) ->
+  Target = {TgtMod, TgtCtx},
+  ?debug_msg("optimistic ~w\n",[TgtMod]),
   ?debug_msg("CFG: ~p\n",[CFG]),
   %% Build interference graph
   ?debug_msg("Build IG\n",[]),
-  IG_O = hipe_ig:build(CFG, Liveness, Target),
-  IG = hipe_ig:build(CFG, Liveness, Target),
+  IG_O = hipe_ig:build(CFG, Liveness, TgtMod, TgtCtx),
+  IG = hipe_ig:build(CFG, Liveness, TgtMod, TgtCtx),
   ?debug_msg("adjlist: ~p\n",[hipe_ig:adj_list(IG)]),
   ?debug_msg("IG:\n",[]),
   ?print_adjacent(IG),
@@ -98,9 +100,9 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
   SavedAdjList = hipe_ig:adj_list(IG),
 
   ?debug_msg("Init\n",[]),
-  No_temporaries = Target:number_of_temporaries(CFG),
+  No_temporaries = number_of_temporaries(CFG, Target),
   ?debug_msg("Coalescing RA: num_temps = ~p~n", [No_temporaries]),
-  Allocatable = Target:allocatable(),
+  Allocatable = allocatable(Target),
   K = length(Allocatable),
   All_colors = colset_from_list(Allocatable),
   ?debug_msg("K: ~w~nAll_colors: ~p\n",[K, All_colors]), 
@@ -113,11 +115,13 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
   ?mov_print_memberships(Move_sets),
 
   ?debug_msg("Build Worklist\n",[]),
-  Worklists_O = hipe_reg_worklists:new(IG_O, Target, CFG, Move_sets_O, K, No_temporaries),
+  Worklists_O = hipe_reg_worklists:new(IG_O, TgtMod, TgtCtx, CFG, Move_sets_O,
+				       K, No_temporaries),
   ?debug_msg("Worklists:\n ~p\n", [Worklists_O]),
   ?reg_print_memberships(Worklists_O),
 
-  Worklists = hipe_reg_worklists:new(IG, Target, CFG, K, No_temporaries),
+  Worklists = hipe_reg_worklists:new(IG, TgtMod, TgtCtx, CFG, K,
+				     No_temporaries),
   ?debug_msg("New Worklists:\n ~p\n", [Worklists]),
   ?reg_print_memberships(Worklists),
 
@@ -175,10 +179,10 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
 
   ?debug_msg("Init node sets\n",[]),
   Node_sets = hipe_node_sets:new(),
-  %% ?debug_msg("NodeSet: ~w\n NonAlloc ~w\n",[Node_sets,Target:non_alloc(CFG)]),
+  %% ?debug_msg("NodeSet: ~w\n NonAlloc ~w\n",[Node_sets,non_alloc(CFG,Target)]),
   ?debug_msg("Default coloring\n",[]),
   {Color0,Node_sets1} = 
-    defaultColoring(Target:all_precoloured(),
+    defaultColoring(all_precoloured(Target),
 		    initColor(No_temporaries), Node_sets, Target),
   ?debug_msg("Color0\n",[]),
   ?print_colors(No_temporaries, Color0),
@@ -220,12 +224,13 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
   sanity_compare(SortedColoring_O, SortedColoring),
   {Coloring,SpillIndex2}.
 -else.
-regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
-  ?debug_msg("optimistic ~w\n",[Target]),
+regalloc(CFG, Liveness, SpillIndex, SpillLimit, TgtMod, TgtCtx, _Options) ->
+  Target = {TgtMod, TgtCtx},
+  ?debug_msg("optimistic ~w\n",[TgtMod]),
   ?debug_msg("CFG: ~p\n",[CFG]),
   %% Build interference graph
   ?debug_msg("Build IG\n",[]),
-  IG = hipe_ig:build(CFG, Liveness, Target),
+  IG = hipe_ig:build(CFG, Liveness, TgtMod, TgtCtx),
   ?debug_msg("adjlist: ~p\n",[hipe_ig:adj_list(IG)]),
   ?debug_msg("IG:\n",[]),
   ?print_adjacent(IG),
@@ -236,9 +241,9 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
   SavedAdjList = hipe_ig:adj_list(IG),
 
   ?debug_msg("Init\n",[]),
-  No_temporaries = Target:number_of_temporaries(CFG),
+  No_temporaries = number_of_temporaries(CFG, Target),
   ?debug_msg("Coalescing RA: num_temps = ~p~n", [No_temporaries]),
-  Allocatable = Target:allocatable(),
+  Allocatable = allocatable(Target),
   K = length(Allocatable),
   All_colors = colset_from_list(Allocatable),
   ?debug_msg("K: ~w~nAll_colors: ~p\n",[K, All_colors]), 
@@ -251,7 +256,8 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
 
   ?debug_msg("Build Worklist\n",[]),
 
-  Worklists = hipe_reg_worklists:new(IG, Target, CFG, K, No_temporaries),
+  Worklists = hipe_reg_worklists:new(IG, TgtMod, TgtCtx, CFG, K,
+				     No_temporaries),
   ?debug_msg("New Worklists:\n ~p\n", [Worklists]),
   ?reg_print_memberships(Worklists),
 
@@ -293,10 +299,10 @@ regalloc(CFG, Liveness, SpillIndex, SpillLimit, Target, _Options) ->
 
   ?debug_msg("Init node sets\n",[]),
   Node_sets = hipe_node_sets:new(),
-  %% ?debug_msg("NodeSet: ~w\n NonAlloc ~w\n",[Node_sets,Target:non_alloc(CFG)]),
+  %% ?debug_msg("NodeSet: ~w\n NonAlloc ~w\n",[Node_sets,non_alloc(CFG,Target)]),
   ?debug_msg("Default coloring\n",[]),
   {Color0,Node_sets1} = 
-    defaultColoring(Target:all_precoloured(),
+    defaultColoring(all_precoloured(Target),
 		    initColor(No_temporaries), Node_sets, Target),
   ?debug_msg("Color0\n",[]),
   ?print_colors(No_temporaries, Color0),
@@ -835,7 +841,8 @@ sort_stack_split(Pivot, [H|T], Smaller, Bigger) ->
 %%                       been coalesced, this mapping shows the alias for that 
 %%                       node.
 %%   AllColors       --  This is an ordset containing all the available colors
-%%   Target          --  The module containing the target-specific functions.
+%%   Target          --  The module containing the target-specific functions,
+%%                       along with its context data.
 %%
 %% Returns:
 %%   Color          --  A mapping from nodes to their respective color.
@@ -875,7 +882,7 @@ assignColors(Worklists, Stack, NodeSets, Color, No_Temporaries,
 	false -> % Color case
 	  Col = colset_smallest(OkColors),
 	  NodeSets1 = hipe_node_sets:add_colored(Node, NodeSets),
-	  Color1 = setColor(Node, Target:physical_name(Col), Color),
+	  Color1 = setColor(Node, physical_name(Col,Target), Color),
 	  ?debug_msg("Color case. Assigning color ~p to node.~n", [Col]),
 	  assignColors(Worklists, Stack1, NodeSets1, Color1, No_Temporaries, SavedAdjList, SavedSpillCosts, IG, Alias, AllColors, Target)
       end
@@ -903,7 +910,8 @@ assignColors(Worklists, Stack, NodeSets, Color, No_Temporaries,
 %%   Alias           --  This is a mapping from nodes to nodes. If a node has 
 %%                       been coalesced, this mapping shows the alias for that 
 %%                       node.
-%%   Target          --  The module containing the target-specific functions.
+%%   Target          --  The module containing the target-specific functions,
+%%                       along with its context data.
 %%
 %% Returns:
 %%   Alias           --  The restored aliases after the uncoalescing.
@@ -1007,7 +1015,7 @@ colorSplit([], _Col, NodeSets, Color, _Target) ->
 colorSplit([Node|Nodes], Col, NodeSets, Color, Target) ->
   ?debug_msg("  Coloring node ~p with color ~p.~n", [Node, Col]),
   NodeSets1 = hipe_node_sets:add_colored(Node, NodeSets),
-  Color1 = setColor(Node, Target:physical_name(Col), Color),
+  Color1 = setColor(Node, physical_name(Col,Target), Color),
   colorSplit(Nodes, Col, NodeSets1, Color1, Target).
 
 %% Place non-colorable nodes in a split at the bottom of the SelectStack.
@@ -1036,7 +1044,8 @@ enqueueSplit([Node|Nodes], IG, Stack) ->
 %%                      node.
 %%   AllColors      --  This is an ordset containing all the available colors
 %%
-%%   Target         --  The module containing the target-specific functions.
+%%   Target         --  The module containing the target-specific functions,
+%%                      along with its context data.
 %%
 %% Returns:
 %%   Color          --  A mapping from nodes to their respective color.
@@ -1066,7 +1075,7 @@ assignColors_O(Stack,NodeSets,Color,Alias,AllColors,Target) ->
 	false -> % Colour case
 	  Col = colset_smallest(OkColors),
 	  NodeSets1 = hipe_node_sets:add_colored(Node, NodeSets),
-	  Color1 = setColor(Node, Target:physical_name(Col), Color),
+	  Color1 = setColor(Node, physical_name(Col,Target), Color),
 	  assignColors_O(Stack1, NodeSets1, Color1, Alias, AllColors, Target)
       end
   end.
@@ -1080,7 +1089,8 @@ assignColors_O(Stack,NodeSets,Color,Alias,AllColors,Target) ->
 %%   Regs           -- The list of registers to be default colored
 %%   Color          -- The color mapping that shall be changed
 %%   NodeSets       -- The node sets that shall be updated
-%%   Target         -- The module containing the target-specific functions.
+%%   Target         -- The module containing the target-specific functions,
+%%                     along with its context data.
 %%
 %% Returns:
 %%   NewColor       -- The updated color mapping
@@ -1090,7 +1100,7 @@ assignColors_O(Stack,NodeSets,Color,Alias,AllColors,Target) ->
 defaultColoring([], Color, NodeSets, _Target) ->
   {Color,NodeSets};
 defaultColoring([Reg|Regs], Color, NodeSets, Target) ->
-  Color1 = setColor(Reg,Target:physical_name(Reg), Color),
+  Color1 = setColor(Reg,physical_name(Reg,Target), Color),
   NodeSets1 = hipe_node_sets:add_colored(Reg, NodeSets),
   defaultColoring(Regs, Color1, NodeSets1, Target).
 
@@ -1284,7 +1294,7 @@ coalesce(Moves, IG, Worklists, Alias, K, Target) ->
       ?debug_msg("Testing nodes ~p and ~p for coalescing~n",[Dest,Source]),
       Alias_src = getAlias(Source, Alias),
       Alias_dst = getAlias(Dest, Alias),
-      {U,V} = case Target:is_precoloured(Alias_dst) of
+      {U,V} = case is_precoloured(Alias_dst, Target) of
 		true -> {Alias_dst, Alias_src};
 		false -> {Alias_src, Alias_dst}
 	      end,
@@ -1294,13 +1304,13 @@ coalesce(Moves, IG, Worklists, Alias, K, Target) ->
 	  %% drop coalesced move Move
 	  {Moves0, IG, Alias, Worklists};
 	_ ->
-	  case (Target:is_precoloured(V) orelse
+	  case (is_precoloured(V, Target) orelse
 		hipe_ig:nodes_are_adjacent(U, V, IG)) of 
 	    true ->
 	      %% drop constrained move Move
 	      {Moves0, IG, Alias, Worklists};
 	    false ->
-	      case (case Target:is_precoloured(U) of
+	      case (case is_precoloured(U, Target) of
 		      true ->
 			AdjV = hipe_ig:node_adj_list(V, IG),
 			all_adjacent_ok(AdjV, U, Worklists, IG, K, Target);
@@ -1351,7 +1361,7 @@ coalesce_O(Moves, IG, Worklists, Alias, K, Target) ->
       ?debug_msg("Testing nodes ~p and ~p for coalescing~n",[Dest,Source]),
       Alias_src = getAlias(Source, Alias),
       Alias_dst = getAlias(Dest, Alias),
-      {U,V} = case Target:is_precoloured(Alias_dst) of
+      {U,V} = case is_precoloured(Alias_dst, Target) of
 		true -> {Alias_dst, Alias_src};
 		false -> {Alias_src, Alias_dst}
 	      end,
@@ -1362,7 +1372,7 @@ coalesce_O(Moves, IG, Worklists, Alias, K, Target) ->
 	  Worklists1 = add_worklist(Worklists, U, K, Moves1, IG, Target),
 	  {Moves1, IG, Worklists1, Alias};
 	 _ ->
-	  case (Target:is_precoloured(V) orelse
+	  case (is_precoloured(V, Target) orelse
 		hipe_ig:nodes_are_adjacent(U, V, IG)) of 
 	    true ->
 	      Moves1 = Moves0, % drop constrained move Move
@@ -1370,7 +1380,7 @@ coalesce_O(Moves, IG, Worklists, Alias, K, Target) ->
 	      Worklists2 = add_worklist(Worklists1, V, K, Moves1, IG, Target),
 	      {Moves1, IG, Worklists2, Alias};
 	    false ->
-	      case (case Target:is_precoloured(U) of
+	      case (case is_precoloured(U, Target) of
 		      true ->
 			AdjV = hipe_ig:node_adj_list(V, IG),
 			all_adjacent_ok(AdjV, U, Worklists, IG, K, Target);
@@ -1406,7 +1416,8 @@ coalesce_O(Moves, IG, Worklists, Alias, K, Target) ->
 %%   K             -- Number of registers
 %%   Moves         -- Current move information
 %%   IG            -- Interference graph
-%%   Target        -- The containing the target-specific functions
+%%   Target        -- The containing the target-specific functions, along with
+%%                    its context data.
 %%   
 %% Returns:
 %%   Worklists (updated)
@@ -1414,7 +1425,7 @@ coalesce_O(Moves, IG, Worklists, Alias, K, Target) ->
 
 -ifdef(COMPARE_ITERATED_OPTIMISTIC).
 add_worklist(Worklists, U, K, Moves, IG, Target) ->
-  case (not(Target:is_precoloured(U))
+  case (not(is_precoloured(U, Target))
 	andalso not(hipe_moves:move_related(U, Moves))
 	andalso (hipe_ig:is_trivially_colourable(U, K, IG))) of
     true ->
@@ -1525,12 +1536,12 @@ combine(U, V, IG, Alias, Worklists, K, Target) ->
 
 combine_edges([], _U, IG, _Worklists, _K, _Target) ->
   IG;
-combine_edges([T|Ts], U, IG, Worklists, K, Target) ->
+combine_edges([T|Ts], U, IG, Worklists, K, Target={TgtMod,TgtCtx}) ->
   case hipe_reg_worklists:member_stack_or_coalesced(T, Worklists) of
     true -> combine_edges(Ts, U, IG, Worklists, K, Target);
     _ ->
-      IG1 = hipe_ig:add_edge(T, U, IG, Target),
-      IG2 = case Target:is_precoloured(T) of
+      IG1 = hipe_ig:add_edge(T, U, IG, TgtMod, TgtCtx),
+      IG2 = case is_precoloured(T, Target) of
 	      true -> IG1;
 	      false -> hipe_ig:dec_node_degree(T, IG1)
 	    end,
@@ -1560,7 +1571,7 @@ combine_edges([T|Ts], U, IG, Worklists, K, Target) ->
 -ifdef(COMPARE_ITERATED_OPTIMISTIC).
 combine_edges_O([], _U, IG, Worklists, Moves, _K, _Target) ->
   {IG, Worklists, Moves};
-combine_edges_O([T|Ts], U, IG, Worklists, Moves, K, Target) ->
+combine_edges_O([T|Ts], U, IG, Worklists, Moves, K, Target={TgtMod,TgtCtx}) ->
   case hipe_reg_worklists:member_stack_or_coalesced(T, Worklists) of
     true -> combine_edges_O(Ts, U, IG, Worklists, Moves, K, Target);
     _ ->
@@ -1577,7 +1588,7 @@ combine_edges_O([T|Ts], U, IG, Worklists, Moves, K, Target) ->
       %% worklist, and that's where decrement_degree() expects to find it.
       %% This issue is not covered in the published algorithm.
       OldDegree = hipe_ig:get_node_degree(T, IG),
-      IG1 = hipe_ig:add_edge(T, U, IG, Target),
+      IG1 = hipe_ig:add_edge(T, U, IG, TgtMod, TgtCtx),
       NewDegree = hipe_ig:get_node_degree(T, IG1),
       Worklists0 =
 	if NewDegree =:= K, OldDegree =:= K-1 ->
@@ -1610,7 +1621,8 @@ combine_edges_O([T|Ts], U, IG, Worklists, Moves, K, Target) ->
 %%   Alias          -- The Alias vector before undoing
 %%   SavedAdj       -- Saved adjacency list
 %%   IG             -- Interference graph
-%%   Target         -- The module containing the target-specific functions.
+%%   Target         -- The module containing the target-specific functions,
+%%                     along with its context data.
 %%   
 %% Returns:
 %%   list of primitive nodes, that is all nodes that were previously
@@ -1677,7 +1689,8 @@ findPrimitiveNodes(Node, N, Alias, PrimitiveNodes) ->
 %%   N             -- Node that should be uncoalesced
 %%   SavedAdj      -- Saved adjacency list
 %%   IG            -- Interference graph
-%%   Target        -- The module containing the target-specific functions.
+%%   Target        -- The module containing the target-specific functions, along
+%%                    with its context data.
 %%   
 %% Returns:
 %%   updated Interferece graph
@@ -1703,16 +1716,16 @@ fixAdj(N, SavedAdj, IG, Target) ->
 
 removeAdj([], _N, _IG, _Target) ->
   true;
-removeAdj([V| New], N, IG, Target) ->
-  hipe_ig:remove_edge(V, N, IG, Target),
+removeAdj([V| New], N, IG, Target={TgtMod,TgtCtx}) ->
+  hipe_ig:remove_edge(V, N, IG, TgtMod, TgtCtx),
   removeAdj(New, N, IG, Target).
 
 %%restoreAdj([], _N, IG, _Alias, _Target) ->
 %%  %%?debug_msg("adj_lists__after_restore_o ~n~p~n", [hipe_ig:adj_list(IG)]),
 %%  IG;
-%%restoreAdj([V| AdjToN], N, IG, Alias, Target) ->
+%%restoreAdj([V| AdjToN], N, IG, Alias, Target={TgtMod,TgtCtx}) ->
 %%  AliasToV = getAlias(V, Alias),
-%%  IG1 = hipe_ig:add_edge(N, AliasToV, IG, Target),
+%%  IG1 = hipe_ig:add_edge(N, AliasToV, IG, TgtMod, TgtCtx),
 %%  restoreAdj(AdjToN, N, IG1, Alias, Target).
 
 %% XXX This is probably a clumsy way of doing it
@@ -1745,7 +1758,8 @@ findNew([A| Adj], Saved, New) ->
 %%   R             -- Other node to test
 %%   IG            -- Interference graph
 %%   K             -- Number of registers
-%%   Target        -- The module containing the target-specific functions
+%%   Target        -- The module containing the target-specific functions, along
+%%                    with its context data.
 %%   
 %% Returns:
 %%   true iff coalescing is OK
@@ -1753,7 +1767,7 @@ findNew([A| Adj], Saved, New) ->
 
 ok(T, R, IG, K, Target) ->
   ((hipe_ig:is_trivially_colourable(T, K, IG))
-   orelse Target:is_precoloured(T)
+   orelse is_precoloured(T, Target)
    orelse hipe_ig:nodes_are_adjacent(T, R, IG)).
 
 %%----------------------------------------------------------------------
@@ -1766,7 +1780,8 @@ ok(T, R, IG, K, Target) ->
 %%   U             -- Node to test for coalescing
 %%   IG            -- Interference graph
 %%   K             -- Number of registers
-%%   Target        -- The module containing the target-specific functions
+%%   Target        -- The module containing the target-specific functions, along
+%%                    with its context data.
 %%   
 %% Returns:
 %%   true iff coalescing is OK for all nodes in the list
@@ -2043,3 +2058,24 @@ freezeEm3(_U,V,_M,K,WorkLists,Moves,IG,_Alias) ->
       {WorkLists,Moves1}
   end.
 -endif.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%
+%% Interface to external functions.
+%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+all_precoloured({TgtMod,TgtCtx}) ->
+  TgtMod:all_precoloured(TgtCtx).
+
+allocatable({TgtMod,TgtCtx}) ->
+  TgtMod:allocatable(TgtCtx).
+
+is_precoloured(R, {TgtMod,TgtCtx}) ->
+  TgtMod:is_precoloured(R,TgtCtx).
+
+number_of_temporaries(CFG, {TgtMod,TgtCtx}) ->
+  TgtMod:number_of_temporaries(CFG, TgtCtx).
+
+physical_name(R, {TgtMod,TgtCtx}) ->
+  TgtMod:physical_name(R,TgtCtx).