Files
mercury/tools/lmc.in
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

181 lines
6.3 KiB
Bash
Executable File

#!/bin/sh
# vim: ft=sh ts=4 sw=4 et
#---------------------------------------------------------------------------#
# Copyright (C) 2001,2003,2007 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.
#---------------------------------------------------------------------------#
#
# This shell script allows you to execute a version of the Mercury compiler
# that you have built in a workspace. By default, everything that the
# compilation process needs will come from that workspace: the libraries
# for the runtime system, the trace system, the Mercury standard library,
# the Boehm collector, etc. You specify the directory containing the workspace
# by setting the value of the WORKSPACE environment variable. This can be done
# by setting up a small shell script for each workspace you have:
#
# #!/bin/sh
# WORKSPACE=$HOME/mer/ws1
# export WORKSPACE
# exec $WORKSPACE/tools/lmc "$@"
#
# You can specify that the compiler executable itself should come from
# somewhere else than $WORKSPACE/compiler/mercury_compile by putting the
# pathname of the desired compiler into the environment variable
# MERCURY_COMPILER_OVERRIDE. For example, if the stage2 compiler is buggy,
# but you want to link test programs with stage2 libraries, you can set
# WORKSPACE to point to the stage2 directory but make MERCURY_COMPILER_OVERRIDE
# specify the stage1 compiler. This works because the stage1 and stage2
# compilers are *supposed* to behave identically.
#
# If you want to track down some C level bug, you can ask this script to
# pass -g to the C compiler and to the linker by setting the environment
# variable MMC_CDEBUG to the string "true".
#
# You can also ask the script to enable low level debugging of the generated
# code by setting the environment variable MMC_LOWLEVEL_DEBUG to the string
# "true", and you can ask it to enable low level debugging of tabling
# operations by setting the environment variable MMC_TABLE_DEBUG to the same
# string.
#
# You can get the C compiler to enable graph profiling on the generated code
# by setting the environment variable MMC_GPROF to the string "true".
# string.
#
# You can ask for additional C flags to compile with by setting the environment
# variable MMC_ADDED_CFLAGS to those flags. Setting up this environment
# variable one can be more convenient than repeatedly supplying
# "--cflag <flag>" arguments on the command line.
#
# If you want to track down some low level bug, you can ask this script to
# execute the Mercury compiler under gdb by setting the environment variable
# MMC_UNDER_GDB to the string "true".
#
# You can ask this script to run the Mercury compiler under valgrind by
# setting MMC_UNDER_VALGRIND to "true". Valgrind options can be placed in
# the environment variable MMC_VALGRIND_OPTIONS.
#
# If you want to link in the shared versions of the Mercury libraries then set
# the environment variable MMC_USE_SHARED_LIBS to the extension for shared
# libraries on your system. You also still need to pass "--mercury-linkage
# shared" to your workspace mmc script.
#
if test ! -d $WORKSPACE
then
echo "workspace $WORKSPACE does not exist"
fi
if test "$MERCURY_COMPILER_OVERRIDE" != ""
then
MERCURY_COMPILER=$MERCURY_COMPILER_OVERRIDE
else
MERCURY_COMPILER=$WORKSPACE/compiler/mercury_compile
fi
export MERCURY_COMPILER
if test "$MMC_USE_SHARED_LIBS" != ""
then
O="$MMC_USE_SHARED_LIBS"
else
O="a"
fi
if test -s $WORKSPACE/boehm_gc/libgc.$O
then
gclib="$WORKSPACE/boehm_gc/libgc.$O"
elif test -s $WORKSPACE/boehm_gc/libpar_gc.$O
then
gclib="$WORKSPACE/boehm_gc/libpar_gc.$O"
elif test -s $WORKSPACE/boehm_gc/libgc_prof.$O
then
gclib="$WORKSPACE/boehm_gc/libgc_prof.$O"
elif test -s $WORKSPACE/boehm_gc/libgc_c_debug.$O
then
gclib="$WORKSPACE/boehm_gc/libgc_c_debug.$O"
elif test -s $WORKSPACE/boehm_gc/libpar_gc_c_debug.$O
then
gclib="$WORKSPACE/boehm_gc/libpar_gc_c_debug.$O"
else
echo "$WORKSPACE/boehm_gc does not have a gc library"
fi
LIB_FLAGS="\
--link-object $WORKSPACE/trace/libmer_trace.$O \
--link-object $WORKSPACE/trace/libmer_eventspec.$O \
--link-object $WORKSPACE/ssdb/libmer_ssdb.$O \
--link-object $WORKSPACE/browser/libmer_browser.$O \
--link-object $WORKSPACE/mdbcomp/libmer_mdbcomp.$O \
--link-object $WORKSPACE/library/libmer_std.$O \
--link-object $WORKSPACE/runtime/libmer_rt.$O \
--link-object $gclib \
-lm @TRACE_BASE_LIBS_SYSTEM@ @READLINE_LIBRARIES@"
# ssdb.init is not included here because it breaks deep profiling programs
# built with lmc.
INIT_FLAGS="\
--trace-init-file $WORKSPACE/browser/mer_browser.init \
--trace-init-file $WORKSPACE/mdbcomp/mer_mdbcomp.init \
--init-file $WORKSPACE/library/mer_std.init \
--init-file $WORKSPACE/runtime/mer_rt.init"
LINK_FLAGS=""
if test "$MMC_CDEBUG" != ""
then
CDEBUG_FLAGS="--target-debug --cflags -O0"
else
CDEBUG_FLAGS=""
fi
if test "$MMC_LOWLEVEL_DEBUG" != ""
then
CDEBUG_FLAGS="$CDEBUG_FLAGS --cflags -DMR_LOWLEVEL_DEBUG"
fi
if test "$MMC_TABLE_DEBUG" != ""
then
CDEBUG_FLAGS="$CDEBUG_FLAGS --cflags -DMR_TABLE_DEBUG"
fi
if test "$MMC_GPROF" != ""
then
CDEBUG_FLAGS="$CDEBUG_FLAGS --target-debug --cflags -pg --cflags --no-omit-frame-pointer"
LINK_FLAGS="--ld-flags -pg"
fi
if test "$MMC_ADDED_CFLAGS" != ""
then
CDEBUG_FLAGS="$CDEBUG_FLAGS --cflags \"$MMC_ADDED_CFLAGS\""
fi
C_FLAGS="--c-include-directory $WORKSPACE/trace \
--c-include-directory $WORKSPACE/library \
--c-include-directory $WORKSPACE/library/Mercury/mihs \
--c-include-directory $WORKSPACE/ssdb \
--c-include-directory $WORKSPACE/ssdb/Mercury/mihs \
--c-include-directory $WORKSPACE/runtime \
--c-include-directory $WORKSPACE/boehm_gc \
--c-include-directory $WORKSPACE/boehm_gc/include"
if test "$MMC_UNDER_GDB" != ""
then
MERCURY_COMPILER="$WORKSPACE/tools/gdbrun $MERCURY_COMPILER"
export MERCURY_COMPILER
fi
if test "$MMC_UNDER_VALGRIND" != ""
then
MERCURY_COMPILER="valgrind $MMC_VALGRIND_OPTIONS $MERCURY_COMPILER"
export MERCURY_COMPILER
fi
PATH="$WORKSPACE/scripts:$WORKSPACE/util:$PATH"
export PATH
exec mmc --no-mercury-stdlib-dir \
--config-file $WORKSPACE/scripts/Mercury.config \
-I $WORKSPACE/library \
-I $WORKSPACE/mdbcomp \
-I $WORKSPACE/ssdb \
$CDEBUG_FLAGS $C_FLAGS $INIT_FLAGS $LIB_FLAGS $LINK_FLAGS "$@"