Files
mercury/compiler/pd_debug.m
Zoltan Somogyi 78c369700f Give some predicates more descriptive names.
compiler/goal_vars.m:
    Rename goal_vars to vars_in_goal, and apply similar changes to related
    predicates.

compiler/*.m:
    Conform to the changes above.
2025-05-23 01:21:15 +10:00

288 lines
11 KiB
Mathematica

%---------------------------------------------------------------------------%
% vim: ft=mercury ts=4 sw=4 et
%---------------------------------------------------------------------------%
% Copyright (C) 1998-2007, 2009-2011 The University of Melbourne.
% Copyright (C) 2014-2015, 2020-2025 The Mercury team.
% 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 io.
:- import_module list.
:- import_module string.
%---------------------------------------------------------------------------%
:- pred pd_debug_message(pd_info::in, string::in,
string::in, list(string.poly_type)::in, io::di, io::uo) is det.
:- pragma format_call(pred(pd_debug_message/6),
[format_string_values(3, 4)]).
:- pred pd_debug_message_context(pd_info::in, string::in, prog_context::in,
string::in, list(string.poly_type)::in, io::di, io::uo) is det.
:- pragma format_call(pred(pd_debug_message_context/7),
[format_string_values(4, 5)]).
%---------------------------------------------------------------------------%
:- pred pd_debug_search_version_result(pd_info::in, string::in,
maybe_version::in, io::di, io::uo) is det.
:- pred pd_debug_register_version(pd_info::in, string::in, pred_proc_id::in,
version_info::in, io::di, io::uo) is det.
:- pred pd_debug_write_instmap(pd_info::in, string::in, io::di, io::uo) is det.
:- pred pd_debug_write_pred_proc_id_list(pd_info::in, string::in,
list(pred_proc_id)::in, io::di, io::uo) is det.
:- pred pd_debug_output_goals(pd_info::in, string::in, string::in,
list(hlds_goal)::in, io::di, io::uo) is det.
:- pred pd_debug_output_goal(pd_info::in, string::in, string::in,
hlds_goal::in, io::di, io::uo) is det.
%---------------------------------------------------------------------------%
%---------------------------------------------------------------------------%
:- implementation.
:- import_module hlds.goal_vars.
:- 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 parse_tree.parse_tree_out_info.
:- import_module parse_tree.parse_tree_out_misc.
:- import_module parse_tree.parse_tree_out_term.
:- import_module parse_tree.var_db.
:- import_module parse_tree.var_table.
:- import_module bool.
:- import_module maybe.
:- import_module set.
%---------------------------------------------------------------------------%
pd_debug_message(PDInfo, IdStr, Fmt, Args, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
disable_warning [unknown_format_calls] (
io.format(DebugStream, "%s: ", [s(IdStr)], !IO),
io.format(DebugStream, Fmt, Args, !IO)
),
io.flush_output(DebugStream, !IO)
).
pd_debug_message_context(PDInfo, IdStr, Context, Fmt, Args, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
parse_tree_out_misc.write_context(DebugStream, Context, !IO),
io.format(DebugStream, "%s: ", [s(IdStr)], !IO),
io.format(DebugStream, Fmt, Args, !IO),
io.flush_output(DebugStream, !IO)
).
%---------------------------------------------------------------------------%
pd_debug_search_version_result(PDInfo, IdStr, MaybeVersion, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
io.format(DebugStream, "%s: search version result: ", [s(IdStr)], !IO),
(
MaybeVersion = no_version,
io.write_string(DebugStream, "none found\n", !IO)
;
MaybeVersion = version(exact, _, _, _, _),
io.write_string(DebugStream, "exact match\n", !IO)
;
MaybeVersion = version(more_general, PredProcId, Version, _, _),
pd_info_get_module_info(PDInfo, ModuleInfo),
io.write_string(DebugStream, "more general version:\n", !IO),
pd_debug_output_version(DebugStream, ModuleInfo, PredProcId,
Version, no, !IO)
)
).
%------------%
pd_debug_register_version(PDInfo, IdStr, PredProcId, Version, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
pd_info_get_module_info(PDInfo, ModuleInfo),
io.format(DebugStream, "%s: registering version:\n", [s(IdStr)], !IO),
pd_debug_output_version(DebugStream, ModuleInfo, PredProcId, Version,
no, !IO)
).
%---------------------------------------------------------------------------%
:- pred pd_debug_output_version(io.text_output_stream::in, module_info::in,
pred_proc_id::in, version_info::in, bool::in, io::di, io::uo) is det.
pd_debug_output_version(Stream, ModuleInfo, PredProcId, Version,
WriteUnfoldedGoal, !IO) :-
Version = version_info(Goal, _, Args, _, InstMap,
InitialCost, CostDelta, Parents, _),
Goal = hlds_goal(_GoalExpr, GoalInfo),
PredName = predicate_name(ModuleInfo, PredId),
PredProcId = proc(PredId, ProcId),
pred_id_to_int(PredId, PredInt),
proc_id_to_int(ProcId, ProcInt),
io.format(Stream, "%s: (PredProcId :%d-%d)\n",
[s(PredName), i(PredInt), i(ProcInt)], !IO),
io.format(Stream, " initial cost: %d\n", [i(InitialCost)], !IO),
io.format(Stream, " cost delta: %d\n", [i(CostDelta)], !IO),
NonLocals = goal_info_get_nonlocals(GoalInfo),
module_info_pred_proc_info(ModuleInfo, PredId, ProcId, PredInfo, ProcInfo),
proc_info_get_var_table(ProcInfo, VarTable),
instmap_restrict(NonLocals, InstMap, InstMap1),
ArgsStr = mercury_vars_to_string(VarTable, print_name_and_num, Args),
InstMap1Str = instmap_to_string(VarTable, print_name_and_num,
1u, InstMap1),
io.format(Stream, " args: %s\n%s\n", [s(ArgsStr), s(InstMap1Str)], !IO),
module_info_get_globals(ModuleInfo, Globals),
OutInfo = init_hlds_out_info(Globals, output_debug),
VarNameSrc = vns_var_table(VarTable),
pred_info_get_typevarset(PredInfo, TVarSet),
proc_info_get_inst_varset(ProcInfo, InstVarSet),
write_goal_nl(OutInfo, Stream, ModuleInfo, VarNameSrc, print_name_and_num,
TVarSet, InstVarSet, 1u, "\n", Goal, !IO),
set.to_sorted_list(Parents, ParentsList),
ParentStrs = list.map(pred_proc_id_to_dev_string(ModuleInfo), ParentsList),
ParentsStr = string.join_list(", ", ParentStrs),
io.format(Stream, "Parents: %s\n", [s(ParentsStr)], !IO),
% XXX Neither of our callers specify WriteUnfoldedGoal = yes.
(
WriteUnfoldedGoal = yes,
proc_info_get_goal(ProcInfo, ProcGoal),
io.write_string(Stream, "Unfolded goal\n", !IO),
write_goal_nl(OutInfo, Stream, ModuleInfo, VarNameSrc,
print_name_and_num, TVarSet, InstVarSet, 1u, "\n", ProcGoal, !IO)
;
WriteUnfoldedGoal = no
).
%------------%
pd_debug_write_instmap(PDInfo, IdStr, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
pd_info_get_proc_info(PDInfo, ProcInfo),
proc_info_get_var_table(ProcInfo, VarTable),
pd_info_get_instmap(PDInfo, InstMap),
InstMapStr = instmap_to_string(VarTable, print_name_and_num,
1u, InstMap),
io.format(DebugStream, "%s:\n%s", [s(IdStr), s(InstMapStr)], !IO),
io.flush_output(DebugStream, !IO)
).
%------------%
pd_debug_write_pred_proc_id_list(PDInfo, IdStr, PredProcIds, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
pd_info_get_module_info(PDInfo, ModuleInfo),
ProcStrs =
list.map(pred_proc_id_to_dev_string(ModuleInfo), PredProcIds),
ProcsStr = string.join_list(", ", ProcStrs),
io.format(DebugStream, "%s: %s\n", [s(IdStr), s(ProcsStr)], !IO),
io.flush_output(DebugStream, !IO)
).
%------------%
pd_debug_output_goals(PDInfo, IdStr, Msg, Goals, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
GoalExpr = conj(plain_conj, Goals),
goal_info_init(GoalInfo),
Goal = hlds_goal(GoalExpr, GoalInfo),
pd_debug_definitely_output_goal(PDInfo, DebugStream, IdStr, Msg,
Goal, !IO)
).
pd_debug_output_goal(PDInfo, IdStr, Msg, Goal, !IO) :-
pd_info_get_maybe_debug_stream(PDInfo, MaybeDebugStream),
(
MaybeDebugStream = no
;
MaybeDebugStream = yes(DebugStream),
pd_debug_definitely_output_goal(PDInfo, DebugStream, IdStr, Msg,
Goal, !IO)
).
:- pred pd_debug_definitely_output_goal(pd_info::in, io.text_output_stream::in,
string::in, string::in, hlds_goal::in, io::di, io::uo) is det.
pd_debug_definitely_output_goal(PDInfo, DebugStream, IdStr, Msg, Goal, !IO) :-
pd_info_get_module_info(PDInfo, ModuleInfo),
pd_info_get_pred_info(PDInfo, PredInfo),
pd_info_get_proc_info(PDInfo, ProcInfo),
io.format(DebugStream, "%s: %s\n", [s(IdStr), s(Msg)], !IO),
proc_info_get_var_table(ProcInfo, VarTable),
vars_in_goal(Goal, Vars),
pd_info_get_instmap(PDInfo, InstMap),
instmap_restrict(Vars, InstMap, VarsInstMap),
InstMapStr = instmap_to_string(VarTable, print_name_and_num,
1u, VarsInstMap),
io.format(DebugStream, "%s\n", [s(InstMapStr)], !IO),
module_info_get_globals(ModuleInfo, Globals),
OutInfo = init_hlds_out_info(Globals, output_debug),
pred_info_get_typevarset(PredInfo, TVarSet),
proc_info_get_inst_varset(ProcInfo, InstVarSet),
write_goal_nl(OutInfo, DebugStream, ModuleInfo,
vns_var_table(VarTable), print_name_and_num, TVarSet, InstVarSet,
1u, "\n", Goal, !IO),
io.flush_output(DebugStream, !IO).
%---------------------------------------------------------------------------%
:- end_module transform_hlds.pd_debug.
%---------------------------------------------------------------------------%