Files
mercury/scripts/canonical_grade.sh-subr
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

264 lines
7.0 KiB
Bash

#---------------------------------------------------------------------------#
# vim: ts=4 sw=4 expandtab ft=sh
#---------------------------------------------------------------------------#
# Copyright (C) 2000-2007, 2010 The University of Melbourne.
# Copyright (C) 2013-2017, 2020 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.
#---------------------------------------------------------------------------#
#
# canonical_grade.sh-subr:
#
# An `sh' subroutine for computing a canonical grade string based on
# the values of grade-related options.
# It is used by the `ml', `c2init' and `canonical_grade' scripts.
#
# The code here should be inserted after init_grade_options.sh-subr,
# parse_grade_options.sh-subr and final_grade_options.sh-subr, which
# together define a set of shell variables giving the values of the
# various grade options.
#
# Canonical_grade.sh-subr defines the variable GRADE, which will contain
# the canonical string for the grade implied by the option values.
#
# If the option values are inconsistent, this script fragment will print
# an error message and exit with failure.
#
# IMPORTANT: any changes to the handling of grades here may also require
# changes to all the files indicated by runtime/mercury_grade.h.
case ${highlevel_code},${target} in
true,*)
case ${target} in
c)
GRADE="hlc"
;;
csharp)
GRADE="csharp"
;;
java)
GRADE="java"
;;
*)
progname=`basename $0`
echo "${progname}: unknown target: ${target}"
exit 1
;;
esac
case ${non_local_gotos} in
true)
echo "${progname}: error: nonlocal gotos are not compatible" 1>&2
echo "${progname}: with \'--high-level-code'" 1>&2
exit 1
;;
esac
case ${global_regs} in
true)
echo "${progname}: error: use of global registers is not compatible" 1>&2
echo "${progname}: with \'--high-level-code'" 1>&2
exit 1
;;
esac
case ${asm_labels} in
true)
echo "${progname}: error: use of asm labels is not compatible" 1>&2
echo "${progname}: with \'--high-level-code'" 1>&2
exit 1
;;
esac
;;
false,*)
case ${target} in
c)
;;
*)
echo "${progname}: error: \`--no-high-level-code' is not compatible" 1>&2
echo "${progname}: with any target language except C" 1>&2
exit 1
esac
case ${non_local_gotos},${global_regs} in
true,true) GRADE="fast" ;;
true,false) GRADE="jump" ;;
false,true) GRADE="reg" ;;
false,false) GRADE="none" ;;
esac
case ${asm_labels} in
true) GRADE="asm_${GRADE}" ;;
false) ;;
esac
;;
*)
echo "${progname}: internal error: \`--high-level-code' is not set" 1>&2
exit 1
;;
esac
case ${thread_safe},${threadscope} in
true,false)
GRADE="${GRADE}.par"
;;
true,true)
GRADE="${GRADE}.par.threadscope"
;;
false,false)
;;
*)
echo "${progname}: error: The 'threadscope' grade component may only be" 1>&2
echo "${progname}: error: used in parallel grades"
exit 1
;;
esac
case ${gc_method} in
conservative) GRADE="${GRADE}.gc" ;; # deprecated; alias for boehm
boehm) GRADE="${GRADE}.gc" ;;
boehm_debug) GRADE="${GRADE}.gcd" ;;
hgc) GRADE="${GRADE}.hgc" ;;
accurate) GRADE="${GRADE}.agc" ;;
esac
case ${profile_time},${profile_calls},${profile_memory},${profile_deep} in
true,true,false,false)
GRADE="${GRADE}.prof"
;;
true,false,false,false)
GRADE="${GRADE}.proftime"
;;
false,true,false,false)
GRADE="${GRADE}.profcalls"
;;
true,true,true,false)
GRADE="${GRADE}.profall"
;;
false,true,true,false)
GRADE="${GRADE}.memprof"
;;
false,false,false,true)
GRADE="${GRADE}.profdeep"
;;
false,false,false,false)
;;
*)
progname=`basename $0`
echo "${progname}: error: invalid combination of profiling options." 1>&2
exit 1
;;
esac
case ${record_term_sizes_as_words},${record_term_sizes_as_cells} in
true,false)
GRADE="${GRADE}.tsw"
;;
false,true)
GRADE="${GRADE}.tsc"
;;
false,false)
;;
*)
progname=`basename $0`
echo "${progname}: error: invalid combination of term size profiling options." 1>&2
exit 1
;;
esac
case ${use_trail} in
true)
GRADE="${GRADE}.tr" ;;
*)
;;
esac
case ${use_minimal_model_stack_copy},${use_minimal_model_own_stacks},${minimal_model_debug} in
true,false,false)
GRADE="${GRADE}.mmsc"
;;
true,false,true)
GRADE="${GRADE}.dmmsc"
;;
false,true,false)
GRADE="${GRADE}.mmos"
;;
false,true,true)
GRADE="${GRADE}.dmmos"
;;
*)
;;
esac
case ${pregenerated_dist},${single_prec_float} in
true,false)
GRADE="${GRADE}.pregen"
;;
false,true)
GRADE="${GRADE}.spf"
;;
false,false)
;;
*)
progname=`basename $0`
echo "${progname}: error: pregenerated dist incompatible with single-prec float." 1>&2
exit 1
;;
esac
case ${debug},${decl_debug},${ss_debug} in
true,true,false)
GRADE="${GRADE}.decldebug"
;;
true,false,false)
GRADE="${GRADE}.debug"
;;
false,false,true)
GRADE="${GRADE}.ssdebug"
;;
false,false,false)
;;
*)
progname=`basename $0`
echo "${progname}: error: invalid combination of debugging options." 1>&2
exit 1
;;
esac
case ${c_debug} in
true)
GRADE="${GRADE}.c_debug"
;;
*)
;;
esac;
case ${extend_stacks},${stack_segments} in
true,false)
GRADE="${GRADE}.exts"
;;
false,true)
GRADE="${GRADE}.stseg"
;;
false,false)
;;
*)
progname=`basename $0`
echo "${progname}: error: invalid combination of stack extension options." 1>&2
exit 1
;;
esac
case ${use_regions} in
true)
case ${use_regions_debug},${use_regions_profiling} in
false,false) GRADE="${GRADE}.rbmm" ;;
false,true) GRADE="${GRADE}.rbmmp" ;;
true,false) GRADE="${GRADE}.rbmmd" ;;
true,true) GRADE="${GRADE}.rbmmdp" ;;
esac
;;
false)
;;
esac