Files
mercury/grade_lib/choose_grade.m
Zoltan Somogyi 05ef8e01fb Rename the .ll_debug grade component to .c_debug.
Rename mmc and mgnuc options that set this grade component to --c-debug-grade.
Let the options named --c-debug of both mmc and mgnuc enable C level debugging
of only the module being compiled.

runtime/mercury_grade.h:
    Rename the .ll_debug grade component to .c_debug. Also rename the C macro
    that controls the presence or absence of this grade component
    from MR_LL_DEBUG to MR_C_DEBUG_GRADE.

runtime/mercury_conf_param.h:
runtime/mercury_debug.c:
runtime/mercury_debug.h:
runtime/mercury_engine.c:
runtime/mercury_label.c:
runtime/mercury_memory_zones.c:
runtime/mercury_memory_zones.h:
runtime/mercury_overflow.c:
runtime/mercury_std.h:
runtime/mercury_wrapper.c:
    Rename the MR_LOWLEVEL_DEBUG macro to MR_DEBUG_THE_RUNTIME.
    Previously, the name of this macro wrongly implied that it had
    something to do with the old .ll_debug grade component, even though

    - the MR_LOWLEVEL_DEBUG macro was designed to debug LLDS grades,
      since only these existed when it was created, while

    - the .ll_debug grade component (now .c_debug) is useful only for
      MLDS grades targeting C.

compiler/options.m:
    Rename the old confusingly named low_level_debug option to c_debug_grade.
    Move it to the list of grade options, and fix its documentation, which
    was completely wrong:

    - code in compile_target_code.m treated it as being a synonym of
      the .ll_debug (now .c_debug) grade component, while
    - its (commented out) documentation here in options.m said it called for
      the enabling of what is now MR_DEBUG_THE_RUNTIME.

compiler/compile_target_code.m:
    Conform to the rename just above.

    Define MR_C_DEBUG_GRADE instead of MR_LL_DEBUG if c_debug_grade is enabled.

    Pass -g to the C compiler if either c_debug_grade or target_debug
    is enabled.

    Add an XXX about a missing safety check for an obsolete experimental
    feature.

compiler/compute_grade.m:
    When given a grade with a .c_debug grade component, set only the
    c_debug_grade option; don't set the target_debug option, which is NOT
    a grade option. The change to compile_target_code.m above handles the
    only situation in which this implication was formerly required.

scripts/canonical_grade.sh-subr:
scripts/init_grade_options.sh-subr:
scripts/parse_grade_options.sh-subr:
    Look for and process the .c_debug grade component instead of .ll_debug.
    Use a sh variable named c_debug_grade to record its absence/presence.

    Look for and process the --c-debug-grade grade-component option,
    setting the same sh variable, c_debug_grade. (All grade components
    can be set piecemeal using sh options to the scripts using these
    subroutines.) This replaces the old, confusingly named option
    --low-level-debug.

scripts/mgnuc.in:
scripts/mgnuc_file_opts.sh-subr:
    Consistently use the sh variable c_debug to record the presence of
    the (non-grade) --c-debug option to mgnuc, and the sh variable
    c_debug_grade to record the presence of the .c_debug grade component.

    Stop looking for and handling the --low-level-debug option, which
    mgnuc used to document, even though this duplicated the same documentation
    in init_grade_options.sh-subr, which mgnuc includes. The difference was
    that init_grade_options.sh-subr meant it to represent the old .ll_debug
    MLDS grade component, while mgnuc treated it as specifying what is now
    MR_DEBUG_THE_RUNTIME for LLDS grades. It didn't help that two sh variables
    with quite different semantics had names that differed only in an
    underscore: LLDEBUG_OPTS vs LL_DEBUG_OPTS.

scripts/Mmakefile:
    Add a missing dependency to force the rebuild of mgnuc after each update
    of its sh subroutine mgnuc_file_ops.sh-subr.

doc/user_guide.texi:
    Document the --c-debug-grade option of mmc. This option was not publicly
    documented under its original misleading name (--low-level-debug), but
    its documentation is now possible without contorted dancing around the
    name.

    Clarify the documentation of mgnuc's --c-debug option.

README.sanitizers:
configure.ac:
    Conform to the rename of the grade component.

grade_lib/grade_spec.m:
grade_lib/grade_string.m:
grade_lib/grade_structure.m:
grade_lib/try_all_grade_structs.m:
    Conform to the rename of the grade component .ll_debug to .c_debug.

    Don't allow the .c_debug grade component in LLDS grades.

    In grade_string.m, add some obvious implications of some grade components.

grade_lib/choose_grade.m:
grade_lib/grade_lib.m:
grade_lib/test_grades.m:
grade_lib/var_value_names.m:
    Fix white space.

scripts/ml.in:
tools/lmc.in:
tools/test_mercury:
    Conform to the change in compile_target_code.m to the naming of
    Boehm gc library variants.
2022-12-29 20:33:08 +11:00

161 lines
5.6 KiB
Mathematica

%---------------------------------------------------------------------------%
% vim: ts=4 sw=4 et ft=mercury
%---------------------------------------------------------------------------%
% Copyright (C) 2016-2018 The Mercury team.
% This file is distributed under the terms specified in COPYING.LIB.
%---------------------------------------------------------------------------%
%
% This is a program for testing the grade library. It is intended to be used
% with command lines like this:
%
% $ ./choose_grade target=csharp stack_len!=stseg
%
% Each argument is either an equation (with the form var=value) or
% a disequation (with the form var!=value). The variable and value names
% are those in var_value_names.m.
%
% The arguments set up a grade problem to be solved, and this program attempts
% to solve them. If it succeeds, it prints the settings of all the solver
% variables (most of which are typically set by the solver, not by the user),
% and the grade string. If it does not succeed, it prints the reason for the
% failure.
%
:- module choose_grade.
:- interface.
:- import_module io.
:- pred main(io::di, io::uo) is det.
%---------------------------------------------------------------------------%
:- implementation.
:- import_module grade_lib.
:- import_module grade_lib.grade_setup.
:- import_module grade_lib.grade_solver.
:- import_module grade_lib.grade_spec.
:- import_module grade_lib.grade_state.
:- import_module grade_lib.grade_string.
:- import_module grade_lib.grade_structure.
:- import_module grade_lib.grade_vars.
:- import_module var_value_names.
:- import_module cord.
:- import_module list.
:- import_module maybe.
:- import_module string.
main(!IO) :-
SpecsVersion = specs_version_1,
AutoconfResults = autoconf_results(autoconf_gcc_regs_avail_yes,
autoconf_gcc_gotos_avail_yes, autoconf_gcc_labels_avail_yes,
autoconf_low_tag_bits_avail_3, autoconf_size_of_double_eq_ptr,
autoconf_merc_file_no),
setup_solver_info(SpecsVersion, AutoconfResults, SolverInfo0),
io.command_line_arguments(Args, !IO),
process_arguments(Args, cord.init, BadArgLinesCord,
SolverInfo0, SolverInfo1),
BadArgLines = cord.list(BadArgLinesCord),
(
BadArgLines = [_ | _],
io.write_string("unrecognized arguments:\n", !IO),
list.foldl(io.write_string, BadArgLines, !IO)
;
BadArgLines = [],
trace [compile_time(flag("debug_choose_grade")), io(!TIO)] (
io.write_string("AFTER SETUP\n", !TIO),
SolverVarMap1 = SolverInfo1 ^ si_solver_var_map,
io.write_string(solver_var_map_to_str(" ", SolverVarMap1), !TIO)
),
solve_absolute(SolverInfo1, _SolveCounts, Soln),
io.write_string(soln_to_str("", Soln), !IO),
(
Soln = soln_failure(_)
;
Soln = soln_success(SuccMap),
GradeVars = success_map_to_grade_vars(SuccMap),
GradeStructure = grade_vars_to_grade_structure(GradeVars),
GradeStr = grade_structure_to_grade_string(
grade_string_link_check, GradeStructure),
io.format("GRADE %s\n", [s(GradeStr)], !IO)
)
).
%---------------------------------------------------------------------------%
:- pred process_arguments(list(string)::in,
cord(string)::in, cord(string)::out,
solver_info::in, solver_info::out) is det.
process_arguments([], !BadArgLines, !SolverInfo).
process_arguments([Arg | Args], !BadArgLines, !SolverInfo) :-
( if string.remove_prefix("CONFIG", Arg, ArgSuffixPrime) then
WhyNot = npw_config,
ArgSuffix = ArgSuffixPrime
else
WhyNot = npw_user,
ArgSuffix = Arg
),
( if
( if
NeqComponents = string.split_at_string("!=", ArgSuffix),
NeqComponents = [VarNamePrime, ValueNamePrime]
then
SetTo = set_to_false,
VarName = VarNamePrime,
ValueName = ValueNamePrime
else if
EqComponents = string.split_at_string("=", ArgSuffix),
EqComponents = [VarNamePrime, ValueNamePrime]
then
SetTo = set_to_true,
VarName = VarNamePrime,
ValueName = ValueNamePrime
else
fail
)
then
( if solver_var_name(VarName, VarId0) then
MaybeVarId = yes(VarId0),
VarErrorMsg = ""
else
MaybeVarId = no,
string.format("there is no solver variable named %s\n",
[s(VarName)], VarErrorMsg)
),
( if solver_var_value_name(ValueName, ValueId0) then
MaybeValueId = yes(ValueId0),
ValueErrorMsg = ""
else
MaybeValueId = no,
string.format("there is no solver var value named %s\n",
[s(ValueName)], ValueErrorMsg)
),
( if
MaybeVarId = yes(VarId),
MaybeValueId = yes(ValueId)
then
set_solver_var(VarName, ValueName, VarId, ValueId, SetTo, WhyNot,
MaybeError, !SolverInfo)
else
MaybeError = error(VarErrorMsg ++ ValueErrorMsg)
)
else
string.format("`%s' is neither an equation nor a disequation\n",
[s(Arg)], ArgMsg),
MaybeError = error(ArgMsg)
),
(
MaybeError = ok
;
MaybeError = error(Msg),
!:BadArgLines = cord.snoc(!.BadArgLines, Msg)
),
process_arguments(Args, !BadArgLines, !SolverInfo).
%---------------------------------------------------------------------------%
:- end_module choose_grade.
%---------------------------------------------------------------------------%