Files
mercury/compiler/follow_vars.m
Zoltan Somogyi 33870445b8 Convert more modules to use var_tables.
compiler/follow_vars.m:
compiler/liveness.m:
compiler/saved_vars.m:
compiler/stack_alloc.m:
compiler/store_alloc.m:
compiler/try_expand.m:
compiler/unused_imports.m:
compiler/var_locn.m:
    Convert these modules to use var_tables.

    In many predicates, fix argument order.

compiler/live_vars.m:
    Change the way that this support module keeps track of which
    variables to treat as dummy variables. Instead of an array with
    effectively a boolean slot for each variable, use a var_table,
    but with provision for a user of live_vars.m to specify that
    *no* variable is to be treated as a dummy, not even variables
    whose types are dummy types. (Some modules that import live_vars.m
    want this option.)

compiler/hlds_rtti.m:
    Provide var_table-using versions of existing predicates,
    and fix their argument order.

compiler/code_loc_dep.m:
compiler/delay_construct.m:
compiler/stack_opt.m:
compiler/tupling.m:
    Conform to the changes above.
2022-04-30 13:27:02 +10:00

504 lines
21 KiB
Mathematica

%---------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%---------------------------------------------------------------------------%
% Copyright (C) 1994-2008, 2010-2012 The University of Melbourne.
% This file may only be copied under the terms of the GNU General
% Public License - see the file COPYING in the Mercury distribution.
%---------------------------------------------------------------------------%
%
% File: follow_vars.m.
% Main authors: conway, zs.
%
% This module traverses the goal for every procedure, filling in the
% follow_vars fields of some goals. These fields constitute an advisory
% indication to the code generator as to what location each variable
% should be placed in.
%
% The desired locations of variables are computed by traversing the goal
% BACKWARDS. At the end of the procedure, we want the output variables
% to go into their corresponding registers, so we initialize the follow_vars
% accordingly. At each call or higher order call we reset the follow_vars set
% to reflect where variables should be to make the setting up of the arguments
% of the call as efficient as possible.
%
% See compiler/notes/allocation.html for a description of the framework that
% this pass operates within, and for a description of which goals have their
% follow_vars field filled in.
%
%---------------------------------------------------------------------------%
:- module ll_backend.follow_vars.
:- interface.
:- import_module hlds.
:- import_module hlds.hlds_goal.
:- import_module hlds.hlds_llds.
:- import_module hlds.hlds_module.
:- import_module hlds.hlds_pred.
:- import_module parse_tree.
:- import_module parse_tree.var_table.
%---------------------------------------------------------------------------%
:- pred find_final_follow_vars(proc_info::in, abs_follow_vars_map::out,
int::out, int::out) is det.
:- pred find_follow_vars_in_goal(module_info::in, var_table::in,
hlds_goal::in, hlds_goal::out,
abs_follow_vars_map::in, abs_follow_vars_map::out,
int::in, int::out, int::in, int::out) is det.
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
:- implementation.
:- import_module hlds.arg_info.
:- import_module hlds.code_model.
:- import_module ll_backend.call_gen.
:- import_module parse_tree.prog_data.
:- import_module assoc_list.
:- import_module bool.
:- import_module int.
:- import_module list.
:- import_module map.
:- import_module maybe.
:- import_module pair.
:- import_module require.
%---------------------------------------------------------------------------%
find_final_follow_vars(ProcInfo, FollowVarsMap, NextNonReservedR,
NextNonReservedF) :-
proc_info_arg_info(ProcInfo, ArgInfo),
proc_info_get_headvars(ProcInfo, HeadVars),
assoc_list.from_corresponding_lists(ArgInfo, HeadVars, ArgInfoHeadVars),
map.init(FollowVarsMap0),
find_final_follow_vars_2(ArgInfoHeadVars,
FollowVarsMap0, FollowVarsMap, 1, NextNonReservedR,
1, NextNonReservedF).
:- pred find_final_follow_vars_2(assoc_list(arg_info, prog_var)::in,
abs_follow_vars_map::in, abs_follow_vars_map::out, int::in, int::out,
int::in, int::out) is det.
find_final_follow_vars_2([], !FollowMap, !NextNonReservedR, !NextNonReservedF).
find_final_follow_vars_2([arg_info(ArgLoc, Mode) - Var | ArgInfoVars],
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF) :-
(
Mode = top_out,
ArgLoc = reg(RegType, RegNum),
Locn = abs_reg(RegType, RegNum),
map.det_insert(Var, Locn, !FollowVarsMap),
(
RegType = reg_r,
int.max(RegNum + 1, !NextNonReservedR)
;
RegType = reg_f,
int.max(RegNum + 1, !NextNonReservedF)
)
;
Mode = top_in
;
Mode = top_unused
),
find_final_follow_vars_2(ArgInfoVars, !FollowVarsMap, !NextNonReservedR,
!NextNonReservedF).
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
find_follow_vars_in_goal(ModuleInfo, VarTable, Goal0, Goal,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF) :-
Goal0 = hlds_goal(GoalExpr0, GoalInfo0),
find_follow_vars_in_goal_expr(ModuleInfo, VarTable,
GoalExpr0, GoalExpr, GoalInfo0, GoalInfo,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF),
Goal = hlds_goal(GoalExpr, GoalInfo).
:- pred find_follow_vars_in_goal_expr(module_info::in, var_table::in,
hlds_goal_expr::in, hlds_goal_expr::out,
hlds_goal_info::in, hlds_goal_info::out,
abs_follow_vars_map::in, abs_follow_vars_map::out,
int::in, int::out, int::in, int::out) is det.
find_follow_vars_in_goal_expr(ModuleInfo, VarTable, GoalExpr0, GoalExpr,
!GoalInfo, !FollowVarsMap, !NextNonReservedR, !NextNonReservedF) :-
(
GoalExpr0 = conj(ConjType, Goals0),
(
ConjType = plain_conj,
find_follow_vars_in_conj(ModuleInfo, VarTable, no, Goals0, Goals,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF)
;
ConjType = parallel_conj,
find_follow_vars_in_independent_goals(ModuleInfo, VarTable,
Goals0, Goals, !FollowVarsMap,
!NextNonReservedR, !NextNonReservedF)
),
GoalExpr = conj(ConjType, Goals)
;
GoalExpr0 = disj(Goals0),
% We record that at the end of each disjunct, live variables should
% be in the locations given by the initial follow_vars, which reflects
% the requirements of the code following the disjunction.
goal_info_set_store_map(!.FollowVarsMap, !GoalInfo),
find_follow_vars_in_independent_goals(ModuleInfo, VarTable,
Goals0, Goals, !FollowVarsMap,
!NextNonReservedR, !NextNonReservedF),
GoalExpr = disj(Goals)
;
GoalExpr0 = switch(Var, Det, Cases0),
% We record that at the end of each arm of the switch, live variables
% should be in the locations given by the initial follow_vars, which
% reflects the requirements of the code following the switch.
goal_info_set_store_map(!.FollowVarsMap, !GoalInfo),
find_follow_vars_in_cases(ModuleInfo, VarTable, Cases0, Cases,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF),
GoalExpr = switch(Var, Det, Cases)
;
GoalExpr0 = if_then_else(Vars, Cond0, Then0, Else0),
FollowVarsMap0 = !.FollowVarsMap,
NextNonReservedR0 = !.NextNonReservedR,
NextNonReservedF0 = !.NextNonReservedF,
% Set the follow_vars field for the condition, the then-part and the
% else-part, since in general they have requirements about where
% variables should be.
% We use the requirement of the condition as the requirement of
% the if-then-else itself, since the condition will definitely
% be entered first. Since part of the condition may fail early,
% taking into account the preferences of the else part may be
% worthwhile. The preferences of the then part are already taken
% into account, since they are an input to the computation of
% the follow_vars for the condition.
% We record that at the end of both the then-part and the else-part,
% live variables should be in the locations given by the initial
% follow_vars, which reflects the requirements of the code
% following the if-then-else.
find_follow_vars_in_goal(ModuleInfo, VarTable, Then0, Then1,
FollowVarsMap0, FollowVarsMapThen,
NextNonReservedR0, NextNonReservedThenR,
NextNonReservedF0, NextNonReservedThenF),
FollowVarsThen = abs_follow_vars(FollowVarsMapThen,
NextNonReservedThenR, NextNonReservedThenF),
goal_set_follow_vars(yes(FollowVarsThen), Then1, Then),
find_follow_vars_in_goal(ModuleInfo, VarTable, Cond0, Cond1,
FollowVarsMapThen, FollowVarsMapCond,
NextNonReservedThenR, NextNonReservedCondR,
NextNonReservedThenF, NextNonReservedCondF),
FollowVarsCond = abs_follow_vars(FollowVarsMapCond,
NextNonReservedCondR, NextNonReservedCondF),
goal_set_follow_vars(yes(FollowVarsCond), Cond1, Cond),
find_follow_vars_in_goal(ModuleInfo, VarTable, Else0, Else1,
FollowVarsMap0, FollowVarsMapElse,
NextNonReservedR0, NextNonReservedElseR,
NextNonReservedF0, NextNonReservedElseF),
FollowVarsElse = abs_follow_vars(FollowVarsMapElse,
NextNonReservedElseR, NextNonReservedElseF),
goal_set_follow_vars(yes(FollowVarsElse), Else1, Else),
goal_info_set_store_map(FollowVarsMap0, !GoalInfo),
GoalExpr = if_then_else(Vars, Cond, Then, Else),
!:FollowVarsMap = FollowVarsMapCond,
!:NextNonReservedR = NextNonReservedCondR,
!:NextNonReservedF = NextNonReservedCondF
;
GoalExpr0 = negation(SubGoal0),
find_follow_vars_in_goal(ModuleInfo, VarTable, SubGoal0, SubGoal,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF),
GoalExpr = negation(SubGoal)
;
GoalExpr0 = scope(Reason, SubGoal0),
( if
Reason = from_ground_term(_, FGT),
( FGT = from_ground_term_construct
; FGT = from_ground_term_deconstruct
)
then
SubGoal = SubGoal0
else
find_follow_vars_in_goal(ModuleInfo, VarTable, SubGoal0, SubGoal,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF)
),
GoalExpr = scope(Reason, SubGoal)
;
GoalExpr0 = unify(_, _, _, Unification, _),
GoalExpr = GoalExpr0,
( if
Unification = assign(LVar, RVar),
map.search(!.FollowVarsMap, LVar, DesiredLoc)
then
map.set(RVar, DesiredLoc, !FollowVarsMap)
else
true
)
;
GoalExpr0 = plain_call(PredId, ProcId, Args, BuiltinState, _UC, _Name),
GoalExpr = GoalExpr0,
(
BuiltinState = inline_builtin
;
BuiltinState = not_builtin,
find_follow_vars_in_call(PredId, ProcId, Args, ModuleInfo,
!:FollowVarsMap, !:NextNonReservedR, !:NextNonReservedF)
)
;
GoalExpr0 = generic_call(GenericCall, ArgVars, Modes,
MaybeArgRegs, Det),
GoalExpr = GoalExpr0,
(
GenericCall = cast(_)
% Casts are generated inline.
;
( GenericCall = higher_order(_, _, _, _)
; GenericCall = class_method(_, _, _, _)
; GenericCall = event_call(_)
),
determinism_to_code_model(Det, CodeModel),
generic_call_arg_reg_types(ModuleInfo, GenericCall,
ArgVars, MaybeArgRegs, ArgRegTypes),
lookup_var_types(VarTable, ArgVars, Types),
make_arg_infos(ModuleInfo, CodeModel, Types, Modes, ArgRegTypes,
ArgInfos),
assoc_list.from_corresponding_lists(ArgVars, ArgInfos, ArgsInfos),
% XXX use arg_info.generic_call_arg_reg_types?
arg_info.partition_args(ArgsInfos, InVarInfos, _),
list.filter(is_reg_r_arg, InVarInfos, InVarInfosR, InVarInfosF),
assoc_list.keys(InVarInfosR, InVarsR),
assoc_list.keys(InVarInfosF, InVarsF),
module_info_get_globals(ModuleInfo, Globals),
call_gen.generic_call_info(Globals, GenericCall,
length(InVarsR), length(InVarsF), _, SpecifierArgInfos,
FirstInputR, _),
FirstInputF = 1,
find_follow_vars_from_arginfo(SpecifierArgInfos,
map.init, !:FollowVarsMap, 1, _, 1, _),
find_follow_vars_from_generic_in_vars(reg_r, InVarsR,
!FollowVarsMap, FirstInputR, !:NextNonReservedR),
find_follow_vars_from_generic_in_vars(reg_f, InVarsF,
!FollowVarsMap, FirstInputF, !:NextNonReservedF)
)
;
GoalExpr0 = call_foreign_proc(_, _, _, _, _, _, _),
GoalExpr = GoalExpr0
;
GoalExpr0 = shorthand(_),
% These should have been expanded out by now.
unexpected($pred, "shorthand")
).
:- pred is_reg_r_arg(pair(prog_var, arg_info)::in) is semidet.
is_reg_r_arg(_ - arg_info(reg(reg_r, _), _)).
%---------------------------------------------------------------------------%
:- pred find_follow_vars_in_call(pred_id::in, proc_id::in, list(prog_var)::in,
module_info::in, abs_follow_vars_map::out, int::out, int::out) is det.
find_follow_vars_in_call(PredId, ProcId, ArgVars, ModuleInfo,
FollowVarsMap, NextNonReservedR, NextNonReservedF) :-
module_info_pred_proc_info(ModuleInfo, PredId, ProcId, _, ProcInfo),
proc_info_arg_info(ProcInfo, ArgInfo),
assoc_list.from_corresponding_lists(ArgVars, ArgInfo, ArgsInfos),
find_follow_vars_from_arginfo(ArgsInfos, map.init, FollowVarsMap,
1, NextNonReservedR, 1, NextNonReservedF).
:- pred find_follow_vars_from_arginfo(assoc_list(prog_var, arg_info)::in,
abs_follow_vars_map::in, abs_follow_vars_map::out,
int::in, int::out, int::in, int::out) is det.
find_follow_vars_from_arginfo([],
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF).
find_follow_vars_from_arginfo([ArgVar - arg_info(ArgLoc, Mode) | ArgsInfos],
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF) :-
(
Mode = top_in,
ArgLoc = reg(RegType, RegNum),
Locn = abs_reg(RegType, RegNum),
( if map.insert(ArgVar, Locn, !FollowVarsMap) then
true % FollowVarsMap is updated
else
% The call is not in superhomogeneous form: this
% argument has appeared before. Since the earlier
% appearance will have given the variable a smaller
% register number, we prefer that location to the one
% we would give to this appearance of the variable.
true % FollowVarsMap is not updated
),
(
RegType = reg_r,
int.max(RegNum + 1, !NextNonReservedR)
;
RegType = reg_f,
int.max(RegNum + 1, !NextNonReservedF)
)
;
( Mode = top_out
; Mode = top_unused
)
),
find_follow_vars_from_arginfo(ArgsInfos,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF).
%---------------------------------------------------------------------------%
:- pred find_follow_vars_from_generic_in_vars(reg_type::in, list(prog_var)::in,
abs_follow_vars_map::in, abs_follow_vars_map::out, int::in, int::out)
is det.
find_follow_vars_from_generic_in_vars(_RegType, [], !FollowVarsMap, !NextReg).
find_follow_vars_from_generic_in_vars(RegType, [InVar | InVars],
!FollowVarsMap, !NextReg) :-
Locn = abs_reg(RegType, !.NextReg),
( if map.insert(InVar, Locn, !FollowVarsMap) then
true % FollowVarsMap is updated
else
% The call is not in superhomogeneous form: this argument has
% appeared before. Since the earlier appearance will have given
% the variable a smaller register number, we prefer that
% location to the one we would give to this appearance of the
% variable.
true % FollowVarsMap is not updated
),
!:NextReg = !.NextReg + 1,
find_follow_vars_from_generic_in_vars(RegType, InVars, !FollowVarsMap,
!NextReg).
%---------------------------------------------------------------------------%
% We attach a follow_vars to each arm of a switch, since inside each arm
% the preferred locations for variables will in general be different.
% For the time being, we return the follow_vars computed from the first arm
% as the preferred requirements of the compound goal (disjunction or
% parallel conjunction) as a whole. This is close to right, since the first
% disjunct will definitely be the first to be entered. However, the
% follow_vars computed for the disjunction as a whole can profitably
% mention variables that are not live in the first disjunct, but may be
% needed in the second and later disjuncts. In general, we may
% wish to take into account the requirements of all disjuncts
% up to the first non-failing disjunct. (The requirements of
% later disjuncts are not relevant. For model_non disjunctions,
% they can only be entered with everything in stack slots; for
% model_det and model_semi disjunctions, they will never be
% entered at all.)
%
% This code is used both for disjunction and parallel conjunction.
%
:- pred find_follow_vars_in_independent_goals(module_info::in, var_table::in,
list(hlds_goal)::in, list(hlds_goal)::out,
abs_follow_vars_map::in, abs_follow_vars_map::out, int::in, int::out,
int::in, int::out) is det.
find_follow_vars_in_independent_goals(_, _, [], [],
FollowVarsMap, FollowVarsMap, NextNonReservedR, NextNonReservedR,
NextNonReservedF, NextNonReservedF).
find_follow_vars_in_independent_goals(ModuleInfo, VarTable,
[Goal0 | Goals0], [Goal | Goals], FollowVarsMap0, FollowVarsMap,
NextNonReservedR0, NextNonReservedR,
NextNonReservedF0, NextNonReservedF) :-
find_follow_vars_in_goal(ModuleInfo, VarTable, Goal0, Goal1,
FollowVarsMap0, FollowVarsMap,
NextNonReservedR0, NextNonReservedR,
NextNonReservedF0, NextNonReservedF),
FollowVars = abs_follow_vars(FollowVarsMap, NextNonReservedR,
NextNonReservedF),
goal_set_follow_vars(yes(FollowVars), Goal1, Goal),
find_follow_vars_in_independent_goals(ModuleInfo, VarTable, Goals0, Goals,
FollowVarsMap0, _FollowVarsMap,
NextNonReservedR0, _NextNonReservedR,
NextNonReservedF0, _NextNonReservedF).
%---------------------------------------------------------------------------%
% We attach a follow_vars to each arm of a switch, since inside
% each arm the preferred locations for variables will in general
% be different.
% For the time being, we return the follow_vars computed from
% the first arm as the preferred requirements of the switch as
% a whole. This can be improved, both to include variables that
% are not live in that branch (and therefore don't appear in
% its follow_vars) and to let different branches "vote" on
% what should be in registers.
:- pred find_follow_vars_in_cases(module_info::in, var_table::in,
list(case)::in, list(case)::out,
abs_follow_vars_map::in, abs_follow_vars_map::out,
int::in, int::out, int::in, int::out) is det.
find_follow_vars_in_cases(_, _, [], [], !FollowVarsMap,
!NextNonReservedR, !NextNonReservedF).
find_follow_vars_in_cases(ModuleInfo, VarTable,
[Case0 | Cases0], [Case | Cases], FollowVarsMap0, FollowVarsMap,
NextNonReservedR0, NextNonReservedR,
NextNonReservedF0, NextNonReservedF) :-
Case0 = case(MainConsId, OtherConsIds, Goal0),
find_follow_vars_in_goal(ModuleInfo, VarTable, Goal0, Goal1,
FollowVarsMap0, FollowVarsMap,
NextNonReservedR0, NextNonReservedR,
NextNonReservedF0, NextNonReservedF),
FollowVars = abs_follow_vars(FollowVarsMap, NextNonReservedR,
NextNonReservedF),
goal_set_follow_vars(yes(FollowVars), Goal1, Goal),
Case = case(MainConsId, OtherConsIds, Goal),
find_follow_vars_in_cases(ModuleInfo, VarTable, Cases0, Cases,
FollowVarsMap0, _FollowVarsMap,
NextNonReservedR, _NextNonReservedR,
NextNonReservedF, _NextNonReservedF).
%---------------------------------------------------------------------------%
% We attach the follow_vars to each goal that follows a goal
% that is not cachable by the code generator.
:- pred find_follow_vars_in_conj(module_info::in, var_table::in, bool::in,
list(hlds_goal)::in, list(hlds_goal)::out,
abs_follow_vars_map::in, abs_follow_vars_map::out,
int::in, int::out, int::in, int::out) is det.
find_follow_vars_in_conj(_, _, _, [], [],
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF).
find_follow_vars_in_conj(ModuleInfo, VarTable, AttachToFirst,
[Goal0 | Goals0], [Goal | Goals], !FollowVarsMap,
!NextNonReservedR, !NextNonReservedF) :-
( if
Goal0 = hlds_goal(GoalExpr0, _),
(
GoalExpr0 = plain_call(_, _, _, BuiltinState, _, _),
BuiltinState = inline_builtin
;
GoalExpr0 = unify(_, _, _, Unification, _),
Unification \= complicated_unify(_, _, _)
)
then
AttachToNext = no
else
AttachToNext = yes
),
find_follow_vars_in_conj(ModuleInfo, VarTable, AttachToNext, Goals0, Goals,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF),
find_follow_vars_in_goal(ModuleInfo, VarTable, Goal0, Goal1,
!FollowVarsMap, !NextNonReservedR, !NextNonReservedF),
(
AttachToFirst = yes,
FollowVars = abs_follow_vars(!.FollowVarsMap, !.NextNonReservedR,
!.NextNonReservedF),
goal_set_follow_vars(yes(FollowVars), Goal1, Goal)
;
AttachToFirst = no,
Goal = Goal1
).
%---------------------------------------------------------------------------%
:- end_module ll_backend.follow_vars.
%---------------------------------------------------------------------------%