Estimated hours taken: 90
This change makes the tracer a lot more useful. The major points are:
- you can now print the values of live variables at all trace ports,
not just at entry and exit ports;
- you can now print the values of polymorphic variables;
- you can now set spy points;
- you can now say "give me back control when execution starts going
forward again";
- the implementation no longer saves and restores a thousand pseudo-registers
unnecessarily;
- the implementation no longer insists that stack layouts must be present
either for all labels or for none;
- you can now execute programs compiled with tracing without user intervention
if that is what you want.
The last change makes bootstrapping with --generate-trace possible in theory,
although this has not yet been done successfully.
The three major things remaining to be done to make the tracer an adequate
replacement for Prolog debugging are
- a real term browser;
- a redo capability
- being able to trace different modules at different levels
(full/interface/none).
Two less important things to do are making the representation of typeinfos
themselves type correct :-( and not including partially clobbered variables
in trace events (we already filter out fully clobbered variables, which are
the vast majority of all at-least-partially clobbered variables).
compiler/trace.m:
We now record information about what (non-fully-clobbered) variables
are live where in a label that we associate with each event,
a label we allocate for this purpose. Since the stack layouts can
only describe registers and stack slots, generating a trace event
may now require materializing some variables and moving some others
from fields to registers or stack slots.
We now recognize three kinds of events: external, normal internal
and nondet pragma C code internal. We have different predicates
for generating each kind of event, since the three kinds of callers
are different and have different information available.
compiler/arg_info.m:
compiler/code_info.m:
Move some code that always belonged in arg_info.m to arg_info.m
from code_info.m.
compiler/code_exprn.m:
Add a predicate to find out which registers are in use, so the tracer
can avoid saving and restoring registers that are not use.
compiler/code_gen.m:
Reorganize the handling of epilogs. Whereas epilogs used to generate
the failure handling code, this is now done in generate_category_code,
because failure handling is now complicated by having to save the
input args for the fail event, and the setup for this naturally
belongs in generate_category_code.
Rename generate_{prolog,epilog} as generate_{entry,exit}, since
this makes clear that the latter now only handles success
continuations, not failure continuations.
Spell prologue and epilogue correctly elsewhere.
Also move the responsibility for the call event to
generate_category_code.
Move Tyson's recent additions for tracing to trace.m in a generalized
form, since they are now needed for all events, not just call and exit.
Remove obsolete code for eager code generation.
compiler/code_info.m:
Add a predicate to call the new predicate in code_exprn.
Export a predicate for trace.m.
Considerably simplify the treatment of continuation_infos,
with code_info structures now storing only the stuff that can change
during code generation (due to trace events).
compiler/code_util.m:
compiler/opt_util.m:
compiler/vn_filter.m:
compiler/trace.m:
Move some code to code_util.m from opt_util.m and generalize it a bit,
since the new predicate in code_exprn.m now needs the functionality.
Make trace.m and vn_filter.m refer to the moved predicates by their
new name.
compiler/continuation_info.m:
Major reorganization and simplification of the data structures.
The data that changes during code generation is now stored in the
code generator state; data that is only available after code generation
is combined with the info from the code generator state and put into
the HLDS; data that is available only after optimization is put
directly into the HLDS.
Do not add continuation_info records for labels that are not used
either by tracing or by agc. For labels that are used by either,
always include stack layout information if any variables are live.
(The removal of an unnecessary layer of maybe's wasn't ready
for this time around; Tom will remove this layer soon.)
compiler/continuation_info.m:
compiler/stack_layout.m:
Do not associate the stack layout information at procedure entry and
exit with the per-procedure data structure. Since we now associate this
info with the labels of those events instead, they do not need special
handling. However, do include a pointer to the layout structure of
the label associated with the call event in the per-procedure data,
so that we can later implement redo in the debugger.
compiler/stack_layout.m:
Handle the possibility that the set of type variables that are needed
at a point is not numbered 1-N without any missing type var numbers.
This can happen if all variables whose types include a low-numbered
type variable die before some of those whose types include a higher-
numbered type variable.
compiler/*_switch*.m:
compiler/ite_gen.m:
compiler/disj_gen.m:
When creating trace events, associate not just a goal path but
also a pre-death set with events that represent entry to a computation
branch. Trace.m now needs the pre-death set so that it can avoid
trying to flush variables that are not supposed to be live in the
computation branch being traced.
Since putting variable values in positions that can be described
by stack layouts (which includes only registers and stack slots,
not fields etc) may require generating code, make sure that this
code is generated when code_info has the appropriate contents
(i.e. just before the generating the code the entrance to which
the event refers to).
compiler/pragma_c_gen.m:
Add two new event types to signify entry to the C code fragments
executed on first call and on later reentries.
compiler/handle_options.m:
Handle some more implications of tracing, and document them better.
One of these changes (follow_vars) ought to allow munta to pass
the debugger test cases.
compiler/llds_out.m:
When generating init_{entry,label,local} operations, append a suffix
_sl to the macro name if the label whose info is being registered
has a stack layout record. This will cause the stack layout to be
registered also. For other labels, the macro without the _sl will
register NULL instead.
compiler/live_vars.m:
compiler/liveness.m:
compiler/store_alloc.m:
If tracing is on, try to preserve the input arguments throughout
the execution of the procedure. This is not possible if any part
of an input argument is clobbered, but in the absence of a utility
predicate that can test for this, we ignore the issue for now.
compiler/mercury_compile.m:
Do not invoke continuation_info__process_instructions to add
stack layout information about call return sites unless we are doing
agc. (Tracing does not require this info, and it is big.)
Pass info on which labels have stack layout records to llds_out.m.
Fix some misleading progress messages.
compiler/{lambda,polymorphism,goal_util}.m:
Enforce the invariant that if the signature of a procedure created
for a lambda goal includes a type variable, it also includes the
typeinfo for that type variable.
(This change is from Simon.)
library/{benchmarking,std_util}.m:
Add the _sl suffix to init_* macros in hand-written code where
necessary.
library/require.m:
When error is called from a program that does tracing, make it
print the number of the last event.
runtime/mercury_{conf_param.h,trace.c}:
util/mkinit.c:
Rename MR_USE_DEBUGGER as MR_USE_EXTERNAL_DEBUGGER, since we
have an internal one as well.
runtime/mercury_goto.h:
For each of the init_{entry,label,local} macros, and the macros
they invoke, add a new variant (denoted by a _sl suffix on the
macro name) that will cause the stack layout record associated
with the label to be registered also. For labels initialized
with the variants without the _sl, initialization will register
NULL instead.
runtime/mercury_{memory,misc}.c:
In several locations, just before exiting with a fatal error in
a program that does tracing, print the number of the last event.
runtime/mercury_regorder.h:
Add two new macros, MR_NUM_SPECIAL_REG and MR_MAX_SPECIAL_REG_MR
that mercury_trace.c uses to decide how much fake_reg to save and
restore.
runtime/mercury_stack_layout.h:
Change the definition of MR_Var_Shape_Info to reflect the real type
of one of its fields more closely.
Make the type names conform to the Mercury style guide
With_Studly_Cap_Names.
Fix the name and the definition of MR_DETISM_DET_CODE_MODEL.
runtime/mercury_stack_layout.c:
Use the new forms of the type names.
runtime/mercury_trace.[ch]:
runtime/mercury_wrapper.c:
Add support for turning tracing on and off and for choosing the
external or internal debugger.
Modify the prototype of MR_trace() to reflect the new arg giving
the number of the highest numbered rN register in use at the call.
Support the new trace ports for nondet pragma C code.
runtime/mercury_trace.c:
Implement a new command set more in line with what we intend to
grow towards in the future:
[N] s/S/CR to skip N events
f/F to finish the execution of the current call
c/C to continue to the end
The upper case versions print events as they go, the lower case
ones don't.
Add several new commands:
N g/G to go to event #N
r to skip all following exit and fail ports until we come to
another port type
b module pred
to add a breakpoint (which actually functions like a spy point)
? to list all breakpoints
+ to enable a numbered breakpoint
- to disable a numbered breakpoint
Save/restore only the necessary registers, not all of them.
Do not indent trace events by the depth, since the depth can get
very large (4800 in one case I looked at).
Provide functions for other parts of the runtime and the library
to call to print the number of the last trace event.
There is a reference here back to the library, but this will
go away when the tabling change is committed.
runtime/mercury_trace.[ch]:
Add a new function, MR_trace_report. This function, which is for
invocation in the event of a fatal error, reports what the number
of the last event was (if tracing is enabled). This should allow
the programmer to go more directly to the source of the problem.
runtime/mercury_wrapper.[ch]:
Remove the long obsolete code for initializing r[123] with integers.
scripts/mdb:
A new script for turning on the tracing code in an executable.
scripts/Mmakefile:
bindist/Mmakefile:
bindist/bindist.Makefile.in:
Include mdb in the list of scripts to be installed.
doc/Mmakefile:
Include mdb in the list of scripts with autogenerated man pages.
tests/misc_tests/Mmakefile:
tests/misc_tests/debugger_regs.*:
tests/misc_tests/debugger_test.*:
Move the tests of the debugger to the new tests/debugger directory.
In the process, give debugger_test back its original name,
"interpreter", and give it an input script that tests the new
debugger commands while avoiding the printing of excessively large
terms (although they still overflow 80 columns).
tests/debugger/Mmakefile:
tests/debugger/runtests:
tests/debugger/debugger_regs.*:
tests/debugger/interpreter.*:
The moved test cases and copied Mmakefile/runtests.
tests/debugger/queens.*:
A new test case to test the printing of variables in polymorphic
procedures.
Estimated hours taken: 0.5
bindist/bindist.configure.in:
Fix a bug in the handling of the *.sh-subr files:
`$top' should be "`pwd`", not "`pwd`/..", since
when this file is executed it is the top-level
configure script, not in the bindist subdirectory.
Estimated hours taken: 0.1
bindist/Mmakefile:
Add the extras/trailed_update directory to the list of directories
which are cleaned up before creating the binary distribution.
Estimated hours taken: 0.25
.README.in:
Mmakefile:
bindist/Mmakefile:
bindist/bindist.Makefile.in:
tools/bootcheck:
Delete all references to `lp_solve'. It is not needed anymore,
now that we have written our own solver.
Estimated hours taken: 2
Changes needed to include `lp_solve' in the Mercury distribution.
Note that these changes include it in the main distribution; that is temporary.
For copyright reasons, it ought to be moved to the `extras' distribution,
lp_solve/lpkit.h:
Delete definition of `NULL' that conflicted with system header files.
lp_solve/COPYING:
New file, explaining the copying policy.
lp_solve/Mmakefile:
New file, contains rules for building and installing lp_solve.
Mmakefile:
bindist/Mmakefile:
bindist/bindist.Makefile.in:
Add rules for installing lp_solve and for including it in the
source and binary distributions.
.README.in:
Mention lp_solve.
compilation model options as mmc.
Allow the user to mix `--grade foo' options with
other options that affect the grade such as `--profiling'.
Compute the final grade to link with from the options.
Also add a few new options and grade modifiers.
compiler/options.m:
compiler/mercury_compile.m:
Add `--profile-time' and `--profile-calls' options.
Change `--profiling' to now just imply both of those.
Add `--pic-reg' option (just implies `-DPIC_REG' in cflags).
compiler/handle_options.m:
Add support for grade modifiers `.proftime' and `.profcalls'.
Make `.debug' a grade modifier, rather than having a base
grade `debug'.
scripts/init_grade_options.sh-subr:
scripts/parse_grade_options.sh-subr:
New files containing sh subroutines for parsing grade-related
options.
configure.in:
bindist/bindist.configure.in:
Use AC_SUBST_FILE to allow #inclusion of the above-mentioned
`.sh-subr' files.
scripts/ml.in:
scripts/mgnuc.in:
Use the above-mentioned sh subroutines.
scripts/ml.in:
compiler/mercury_compile.m:
compiler/handle_options.m:
Compute the final grade to link with from the various
grade-related options.
scripts/mgnuc.in:
Support the `--inline-alloc' option.
doc/user_guide.texi:
README.Linux:
Document the above changes.
Estimated hours taken: 1
bindist/bindist.Makefile.in:
bindist/Makefile.in:
Include the man pages in the binary distribution.
bindist/bindist.Makefile.in:
Fix a bug where it didn't install the NUPROLOG or SICSTUS stuff
even when configure detected that NUPROLOG / SICSTUS was present.
Fix a bug in the rule for installing NUPROLOG.
bindist/bindist.build_vars.in:
Put the definition of SHARED_LIBS in single quotes rather than
double quotes, so that if it contains a back-quoted command
(e.g. SHARED_LIBS='`gcc -print-libgcc-file-name` -lm -lc')
it is evaluated dynamically rather than at build time.
This avoids potential problems if users upgrade to a new gcc
version after installing Mercury.
Estimated hours taken: 0.5
bindist/bindist.build_vars.in:
bindist/bindist.configure.in:
Fix a few bugs: some variables (SHARED_LIBS, EXE_RPATH_OPT, etc.)
use in the scripts/*.in files were not being passed in from the
source configure.in to the binary distribution configure.in.
Estimated hours taken: 0.25
tools/bindist.README.Linux:
Add a version of the README.Linux modified for the binary release
(I just removed the stuff about how to get the source distribution
to compile with libc 6).
Estimated hours taken: 0.25
bindist/Mmakefile:
Include the `extras' and `tests' directories and the
`README.Linux' and `WORK_IN_PROGRESS' files in the binary
distribution.
Automate the building of releases, including daily "rotd"
(release-of-the-day) releases.
VERSION:
New file, defines the version number.
Also document the general scheme for assigning version numbers.
Mmake.common.in:
Add `include VERSION'.
Mmakefile:
bindist/Mmakefile:
configure.in:
Use the version number in VERSION rather than hard-coding it
in multiple places.
Mmakefile:
README:
.README.in:
INSTALL:
.INSTALL.in:
Change things so that README and INSTALL are automatically
generated from .README.in and .INSTALL.in respectively, using
the version number defined in VERSION.
BUGS:
Remove an unnecessary reference to the version number.
RELEASE_NOTES:
Change this file so that the version number is only mentioned
in one place. Bump the version number here to 0.7 in preparation
for the next release.
library/Mmakefile:
library/library.m:
library/library.m.in:
Change things so that library.m is automatically generated from
library.m.in using the version number in VERSION.
Also change it so that library__version says which architecture
it was configured for.
tools/test_mercury:
Override the version specified in the VERSION file in the CVS
repository with either `rotd-YYYY-MM-DD' or (when making a release)
with a specified $RELEASE_VERSION.
When running on murliboobo, if the version built passes all its
tests, copy it to the /pub/mercury/beta-releases directory on
ftp://turiel.cs.mu.oz.au.
compiler/notes/release_checklist.m:
Change the release checklist to say that you only need to
update the version number in VERSION rather than in 6 different
places. Also change the procedure for building the final
tar file to reflect the above changes to the `test_mercury' script.
Estimated hours taken: 2
Rename `mc' as `mmc'.
Note: we do not change the names of variables such as MCFLAGS, just the
`mc' executable.
configure.in:
Look for mmc not mc. If you can't find mmc to bootstrap, try for
mc.
bindist/Mmakefile:
bindist/bindist.configure.in:
doc/Mmakefile:
doc/user_guide.texi:
scripts/Mmake.vars.in:
scripts/Mmakefile:
scripts/msl.in:
tools/expand_params:
tools/optstages:
tools/speedtest:
tools/test_mercury:
Change references to mc into mmc.
They weren't working because Linux requires the `-rpath' option
be specified when linking the shared libraries, as well as when
linking executables. Previously we only passed `-rpath' option
when linking executables.
configure.in:
Mmake.common.in:
bindist/bindist.build_vars.in:
Add new configuration variables for handling `-rpath' or `-R' options:
EXE_RPATH_OPT, EXE_RPATH_SEP, SHLIB_RPATH_OPT, and SHLIB_RPATH_SEP.
scripts/ml.in:
Rewrite the system-specific code for handling rpaths
to instead use the new rpath configuration variables.
library/Mmakefile:
runtime/Mmakefile:
When linking shared libraries that depend on other shared libraries,
pass appropriate rpath options using the rpath configuration variables.
Estimated hours taken: 0.1
bindist/bindist.README.MS-Windows:
Update for gnu-win32 version b17.1: system() is now fixed
(so no work-around needed); "-Wl,--force-exe-suffix" is now
the default; but the handling of `.exe' has changed again,
so we need to modify the work-around for that.
Estimated hours taken: 0.5
Reduce the number of places where the version number is hard-coded.
bindist/Mmake:
Add `VERSION=0.6'.
When creating a binary distribution, use `sed' to replace
the strings `<VERSION>' and `<FULLARCH>' in the bindist.* files
with the corresponding values.
bindist/bindist.INSTALL:
bindist/bindist.README:
bindist/bindist.README.MS-Windows:
bindist/bindist.configure.in:
Replace hard-coded version numbers with <VERSION>.
Estimated hours taken: 0.5
bindist/bindist.build_vars.in:
bindist/bindist.configure.in:
Add HAVE_BOXED_FLOATS, and also fix a bug
(NUM_REAL_TEMPS was renamed NUM_REAL_R_TEMPS).
Estimated hours taken: 2
Various changes to support a binary distribution for Windows.
bindist/Mmake:
Fix a bug (`lib' should have been `lib.tar').
bindist/Makefile.in:
Fix a bug (it had `lib.tar' in a couple of places where it should
have had `info.tar').
Change the `echo "blah"' statements to `@echo "-- blah"'.
bindist/README.MS-Windows:
Add directions for creating a binary distribution for Windows.
bindist/README.MS-Windows:
Add directions for installing from the binary distribution
for Windows.
Estimated hours taken: 0.5
Fix a couple of bugs in the binary distribution makefiles,
and change them so they should work better on gnu-win32.
bindist/Mmake:
bindist/bindist.Makefile.in:
Avoid using redirection with `tar', since this breaks on
gnu-win32, because stdin and stdout default to text mode, not
binary mode. Also avoid using `zcat' -- use `gzip
--decompress' instead, because `zcat' might only understand
compressed files, not gzipped files. Also make sure
that multiple commands are separated by `&&' rather than `;',
so that we don't ignore failures.
Estimated hours taken: 0.1
bindist/Mmake:
Fix the rule which did an `mmake realclean' in samples/Diff to
to it in samples/diff and the other new subdirectories of samples.
Estimated hours taken: 0.1
Recommit previous change, since I accidentally committed it on the
0.5.1 branch rather than on the main trunk.
bindist/Mmake:
Use `test -f' rather than `test -x', since `test -x' doesn't
work on ULTRIX.
Estimated hours taken: 0.75
*/Mmake:
Make sure that the rules for `mmake clean' and `mmake realclean'
remove a few files that we'd missed.
Change the rules for making tags so that it uses the local
version of `mtags' (i.e. ../scripts/mtags) rather than the
installed one.
README, RELEASE_NOTES, bindist/bindist.README:
Remove mention of `ftp.cs.mu.oz.au' as one of our ftp sites;
`turiel.cs.mu.oz.au' is now the primary site.
Estimated hours taken: 0.25
bindist.configure.in:
Fix a bug: the call to AC_INIT should specify a file name that
will exist in the final binary distribution, not one that only exists
in the source.
Estimated hours taken: 0.5
bindist/*:
Rename most of the files to start with `bindist.'.
This avoids confusion between files used to build the
binary distribution, and files that get incorporated
into the binary distribution (and which are then used
to install it), and so makes it obvious that one should
not attempt to run `configure' or `make' in this
directory.
Estimated hours taken: 0.5
Various minor changes to the binary distribution stuff.
bindist/INSTALL:
Remove the suggestion about reading the documentation
in the `doc' directory while waiting for the install to finish.
bindist/Mmake:
Include `configure.in' in the binary distribution, not just
`configure', so that users who are debugging some configuration
problem will be able to read the source code.
bindist/README:
A variety of changes.
bindist/configure.in:
Remove an obsolete XXX comment.
