Files
mercury/compiler/pd_debug.m
Zoltan Somogyi cc9912faa8 Don't import anything in packages.
Packages are modules whose only job is to serve as a container for submodules.
Modules like top_level.m, hlds.m, parse_tree.m and ll_backend.m are packages
in this (informal) sense.

Besides the include_module declarations for their submodules, most of the
packages in the compiler used to import some modules, mostly other packages
whose component modules their submodules may need. For example, ll_backend.m
used to import parse_tree.m. This meant that modules in the ll_backend package
did not have to import parse_tree.m before importing modules in the parse_tree
package.

However, this had a price. When we add a new module to the parse_tree package,
parse_tree.int would change, and this would require the recompilation of ALL
the modules in the ll_backend package, even the ones that did NOT import ANY
of the modules in the parse_tree package.

This happened even at one remove. Pretty much all modules in every one
of the backend have to import one or more modules in the hlds package,
and they therefore have import hlds.m. Since hlds.m imported transform_hlds.m,
any addition of a new middle pass to the transform_hlds package required
the recompilation of all backend modules, even in the usual case of the two
having nothing to do with each other.

This diff removes all import_module declarations from the packages,
and replaces them with import_module declarations in the modules that need
them. This includes only a SUBSET of their child modules and of the non-child
modules that import them.
2015-11-13 15:03:20 +11:00

261 lines
9.6 KiB
Mathematica

%-----------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%-----------------------------------------------------------------------------%
% Copyright (C) 1998-2007, 2009-2011 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: pd_debug_m
% Main author: stayl.
%
% Debugging routines for partial deduction.
%
%-----------------------------------------------------------------------------%
:- module transform_hlds.pd_debug.
:- interface.
:- import_module hlds.
:- import_module hlds.hlds_goal.
:- import_module hlds.hlds_pred.
:- import_module parse_tree.
:- import_module parse_tree.prog_data.
:- import_module transform_hlds.pd_info.
:- import_module bool.
:- import_module io.
:- import_module list.
:- import_module string.
%-----------------------------------------------------------------------------%
:- pred pd_debug_do_io(bool::in, pred(io, io)::pred(di, uo) is det,
io::di, io::uo) is det.
:- pred pd_debug_output_goal(pd_info::in, string::in, hlds_goal::in,
io::di, io::uo) is det.
:- pred pd_debug_search_version_result(pd_info::in, maybe_version::in,
io::di, io::uo) is det.
:- pred pd_debug_register_version(pd_info::in, pred_proc_id::in,
version_info::in, io::di, io::uo) is det.
:- pred pd_debug_write_instmap(pd_info::in, io::di, io::uo) is det.
:- pred pd_debug_message(bool::in, string::in,
list(string.poly_type)::in, io::di, io::uo) is det.
:- pred pd_debug_message_context(bool::in, prog_context::in, string::in,
list(string.poly_type)::in, io::di, io::uo) is det.
:- pred pd_debug_write(bool::in, T::in, io::di, io::uo) is det.
:- pred pd_debug_write_pred_proc_id_list(pd_info::in, list(pred_proc_id)::in,
io::di, io::uo) is det.
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
:- implementation.
:- import_module hlds.goal_util.
:- import_module hlds.hlds_module.
:- import_module hlds.hlds_out.
:- import_module hlds.hlds_out.hlds_out_goal.
:- import_module hlds.hlds_out.hlds_out_mode.
:- import_module hlds.hlds_out.hlds_out_util.
:- import_module hlds.instmap.
:- import_module libs.
:- import_module libs.globals.
:- import_module libs.options.
:- import_module parse_tree.parse_tree_out_info.
:- import_module parse_tree.parse_tree_out_term.
:- import_module parse_tree.prog_out.
:- import_module set.
%-----------------------------------------------------------------------------%
pd_debug_do_io(DebugPD, Pred, !IO) :-
(
DebugPD = yes,
call(Pred, !IO),
io.flush_output(!IO)
;
DebugPD = no
).
%-----------------------------------------------------------------------------%
pd_debug_search_version_result(PDInfo, MaybeVersion, !IO) :-
pd_info_get_module_info(PDInfo, ModuleInfo),
module_info_get_globals(ModuleInfo, Globals),
globals.lookup_bool_option(Globals, debug_pd, DebugPD),
pd_debug_do_io(DebugPD,
pd_debug_search_version_result_2(ModuleInfo, MaybeVersion), !IO).
:- pred pd_debug_search_version_result_2(module_info::in, maybe_version::in,
io::di, io::uo) is det.
pd_debug_search_version_result_2(ModuleInfo, MaybeVersion, !IO) :-
(
MaybeVersion = no_version,
io.write_string("Specialised version not found.\n", !IO)
;
MaybeVersion = version(exact, _, _, _, _),
io.write_string("Exact match found.\n", !IO)
;
MaybeVersion = version(more_general, PredProcId, Version, _, _),
io.write_string("More general version.\n", !IO),
pd_debug_output_version(ModuleInfo, PredProcId, Version, no, !IO)
).
%-----------------------------------------------------------------------------%
pd_debug_register_version(PDInfo, PredProcId, Version, !IO) :-
pd_info_get_module_info(PDInfo, ModuleInfo),
module_info_get_globals(ModuleInfo, Globals),
globals.lookup_bool_option(Globals, debug_pd, DebugPD),
pd_debug_do_io(DebugPD,
pd_debug_register_version_2(ModuleInfo, PredProcId, Version), !IO).
:- pred pd_debug_register_version_2(module_info::in, pred_proc_id::in,
version_info::in, io::di, io::uo) is det.
pd_debug_register_version_2(ModuleInfo, PredProcId, Version, !IO) :-
io.write_string("Registering version:\n", !IO),
pd_debug_output_version(ModuleInfo, PredProcId, Version, no, !IO).
%-----------------------------------------------------------------------------%
:- pred pd_debug_output_version(module_info::in, pred_proc_id::in,
version_info::in, bool::in, io::di, io::uo) is det.
pd_debug_output_version(ModuleInfo, PredProcId, Version, WriteUnfoldedGoal,
!IO) :-
Version = version_info(Goal, _, Args, _, InstMap,
InitialCost, CostDelta, Parents, _),
Goal = hlds_goal(_GoalExpr, GoalInfo),
PredName = predicate_name(ModuleInfo, PredId),
io.write_string(PredName, !IO),
io.write_string(": (PredProcId :", !IO),
PredProcId = proc(PredId, ProcId),
pred_id_to_int(PredId, PredInt),
proc_id_to_int(ProcId, ProcInt),
io.write_int(PredInt, !IO),
io.write_string("-", !IO),
io.write_int(ProcInt, !IO),
io.write_string(")", !IO),
io.nl(!IO),
io.write_string(" initial cost: ", !IO),
io.write_int(InitialCost, !IO),
io.nl(!IO),
io.write_string(" cost delta: ", !IO),
io.write_int(CostDelta, !IO),
io.nl(!IO),
NonLocals = goal_info_get_nonlocals(GoalInfo),
module_info_pred_proc_info(ModuleInfo, PredId, ProcId, _, ProcInfo),
proc_info_get_varset(ProcInfo, VarSet),
instmap_restrict(NonLocals, InstMap, InstMap1),
io.write_string(" args: ", !IO),
mercury_output_vars(VarSet, print_name_and_num, Args, !IO),
io.nl(!IO),
write_instmap(VarSet, print_name_and_num, 1, InstMap1, !IO),
io.nl(!IO),
module_info_get_globals(ModuleInfo, Globals),
OutInfo = init_hlds_out_info(Globals, output_debug),
write_goal(OutInfo, ModuleInfo, VarSet, print_name_and_num, 1, "\n",
Goal, !IO),
io.nl(!IO),
io.write_string("Parents: ", !IO),
set.to_sorted_list(Parents, ParentsList),
io.write_list(ParentsList, ", ", write_pred_proc_id(ModuleInfo), !IO),
io.nl(!IO),
(
WriteUnfoldedGoal = yes,
proc_info_get_goal(ProcInfo, ProcGoal),
io.write_string("Unfolded goal\n", !IO),
write_goal(OutInfo, ModuleInfo, VarSet, print_name_and_num, 1, "\n",
ProcGoal, !IO),
io.nl(!IO)
;
WriteUnfoldedGoal = no
).
%-----------------------------------------------------------------------------%
pd_debug_write_instmap(PDInfo, !IO) :-
pd_info_get_instmap(PDInfo, InstMap),
pd_info_get_proc_info(PDInfo, ProcInfo),
proc_info_get_varset(ProcInfo, VarSet),
pd_info_get_module_info(PDInfo, ModuleInfo),
module_info_get_globals(ModuleInfo, Globals),
globals.lookup_bool_option(Globals, debug_pd, DebugPD),
pd_debug_do_io(DebugPD,
write_instmap(VarSet, print_name_and_num, 1, InstMap), !IO).
%-----------------------------------------------------------------------------%
pd_debug_write_pred_proc_id_list(PDInfo, PredProcIds, !IO) :-
pd_info_get_module_info(PDInfo, ModuleInfo),
module_info_get_globals(ModuleInfo, Globals),
globals.lookup_bool_option(Globals, debug_pd, DebugPD),
pd_debug_do_io(DebugPD,
pd_debug_write_pred_proc_id_list_2(ModuleInfo, PredProcIds),
!IO).
:- pred pd_debug_write_pred_proc_id_list_2(module_info::in,
list(pred_proc_id)::in, io::di, io::uo) is det.
pd_debug_write_pred_proc_id_list_2(ModuleInfo, PredProcIds, !IO) :-
io.write_list(PredProcIds, ", ", write_pred_proc_id(ModuleInfo), !IO).
%-----------------------------------------------------------------------------%
pd_debug_output_goal(PDInfo, Msg, Goal, !IO) :-
pd_info_get_module_info(PDInfo, ModuleInfo),
module_info_get_globals(ModuleInfo, Globals),
globals.lookup_bool_option(Globals, debug_pd, DebugPD),
pd_debug_do_io(DebugPD, pd_debug_output_goal_2(PDInfo, Msg, Goal), !IO).
:- pred pd_debug_output_goal_2(pd_info::in, string::in, hlds_goal::in,
io::di, io::uo) is det.
pd_debug_output_goal_2(PDInfo, Msg, Goal, !IO) :-
Goal = hlds_goal(GoalExpr, GoalInfo),
pd_info_get_proc_info(PDInfo, ProcInfo),
proc_info_get_varset(ProcInfo, VarSet),
pd_info_get_instmap(PDInfo, InstMap),
pd_info_get_module_info(PDInfo, ModuleInfo),
io.write_string(Msg, !IO),
goal_util.goal_vars(hlds_goal(GoalExpr, GoalInfo), Vars),
instmap_restrict(Vars, InstMap, InstMap1),
write_instmap(VarSet, print_name_and_num, 1, InstMap1, !IO),
io.nl(!IO),
module_info_get_globals(ModuleInfo, Globals),
OutInfo = init_hlds_out_info(Globals, output_debug),
write_goal(OutInfo, ModuleInfo, VarSet, print_name_and_num, 1, "\n",
Goal, !IO),
io.nl(!IO),
io.flush_output(!IO).
%-----------------------------------------------------------------------------%
pd_debug_message(DebugPD, Fmt, Args, !IO) :-
pd_debug_do_io(DebugPD, io.format(Fmt, Args), !IO).
pd_debug_message_context(DebugPD, Context, Fmt, Args, !IO) :-
pd_debug_do_io(DebugPD, prog_out.write_context(Context), !IO),
pd_debug_do_io(DebugPD, io.format(Fmt, Args), !IO).
%-----------------------------------------------------------------------------%
pd_debug_write(DebugPD, Thing, !IO) :-
pd_debug_do_io(DebugPD, io.write(Thing), !IO).
%-----------------------------------------------------------------------------%
:- end_module transform_hlds.pd_debug.
%-----------------------------------------------------------------------------%