mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-05-01 17:24:34 +00:00
d10af74168
Estimated hours taken: 50
This change introduces interface tracing, and makes it possible to successfully
bootstrap the compiler with tracing (either interface or full).
compiler/options.m:
Change the bool options --generate-trace into a string option --trace
with three valid values: minimal, interface and full. The last two mean
what they say; the intention is that eventually minimal will mean
no tracing in non-tracing grades and interface tracing in tracing
grades.
compiler/globals.m:
Add a new global for the trace level.
compiler/handle_options.m:
Convert the argument of --trace to a trace level.
Use only consistent 4-space indentation in the deeply nested
if-then-else.
compiler/trace.m:
Implement interface tracing.
Rename trace__generate_depth_reset_code as trace__prepare_for_call,
since it does more than reset the depth if this module is compiled
with interface tracing.
Do not check whether tracing is enabled before calling MR_trace;
let MR_trace make the check. This trades increased non-tracing
execution time for a substantial code size reduction (which may
in turn benefit execution time).
compiler/call_gen.m:
Call trace__generate_depth_reset_code by its new name.
compiler/code_info.m:
Fix a bug in the handling of non/semi commits. When entering a commit,
we used to push a clone of whatever the top failure continuation was.
However, the resume setup for this continuation could have started
with a label that assumed that the resume vars were in their original
locations (which are often registers), whereas the method of
backtracking to that point only guarantees the survival of stack slots,
not registers.
(This bug caused two lines of incorrect code to be generated among
the approx 30 million lines of code in the stage 2 compiler when
compiled with tracing.)
Fix another bug (previously untriggered as far as I know) in the
handling of multi/det commits. This one was breaking the invariant
that the resume vars set of each entry on the failure continuation
stack included the resume vars set of every other entry below it,
which meant that the values of these resume vars were not guaranteed
to be preserved.
compiler/stack_layout.m:
Make layout structures local to their module. They are not (yet)
referred to by name from other modules, and by declaring them
to be global we caused their names to be included even in stripped
executables, adding several megabytes to the size of the binary.
(The names are not stripped because a dynamically linked library
may want to refer to them.)
Change the mercury_data__stack_layout__ prefix on the names of
generated globals vars to just mercury_data__layout__. It is now
merely too long instead of far too long.
Include the label number in the label layout structure and the number
of typeinfo variables in a var_info structure only with native gc.
Their only use is in debugging native gc.
Fix some documentation rot.
compiler/llds.m:
Add a new field to the pragma_c instruction that says whether the
compiler-generated C code fragments access any stack variables.
compiler/frameopt.m:
Use the new field in pragma_c's to avoid a bug. Because frameopt was
assuming that the pragma_c instruction that filled in the stack slots
containing the call sequence number and depth did not access the stack,
it moved the pragma_c before the incr_sp that allocates the frame
(it was trying to get it out of the loop).
compiler/*.m:
Minor changes to set or ignore the extra field in pragma_c, to refer
to layout structures via the new prefix, or to handle the --trace
option.
doc/user_guide.texi:
Update the documentation for --trace.
runtime/mercury_types.h:
Add the type Unsigned.
runtime/mercury_goto.h:
Use the shorter layout prefix.
runtime/mercury_stack_layout.h:
Use the shorter layout prefix, and include the label number only with
native gc.
runtime/mercury_trace.[ch]:
runtime/mercury_trace_internal.[ch]:
runtime/mercury_trace_external.[ch]:
runtime/mercury_trace_util.[ch]:
Divide the old mercury_trace.[ch] into several components, with one
module for the internal debugger, one for the interface to the
external debugger, one for utilities needed by both. Mercury_trace.c
now has only the top-level stuff that steers between the two
debuggers.
runtime/mercury_trace.[ch]:
Add the new global variable MR_trace_from_full. Before each call,
the calling procedure assigns TRUE to this variable if the caller
is fully traced, and FALSE otherwise. Interface traced procedures
generate trace events only if this variable is TRUE when they are
called (fully traced callee procedures ignore the initial value of
the variable).
Make MR_trace return immediately without doing anything unless
tracing is enabled and a new extra argument to MR_trace is TRUE.
This extra argument is always TRUE for trace events in fully traced
procedures, while for trace events from interface traced procedures,
its value is set from the value of MR_trace_from_full at the time
that the procedure was called (i.e. the event is ignored unless the
interface traced procedure was called from a fully traced procedure).
runtime/mercury_trace.[ch]:
runtime/mercury_trace_internal.[ch]:
For global variables that are stored in stack slots, make their type
Word rather than int.
Use a new function MR_trace_event_report instead of calling
MR_trace_event with a NULL command structure pointer to indicate
that the event is to be reported but there is to be no user
interaction.
Use %ld formats in printfs and casts to long for better portability.
runtime/mercury_trace_internal.c:
Save trace-related globals across calls to Mercury library code
in the debugger, since otherwise any trace events in this code
could screw up e.g. the event number or the call number sequence.
Create separate functions for printing port names and determinisms.
runtime/mercury_wrapper.h:
Disable the tracing of the initialization and finalization code
written in Mercury.
runtime/Mmakefile:
Update for the new source and header files.
tests/debugger/{debugger_regs,interpreter,queens}_lib.{m,inp,exp}:
One new copy of each existing test case. These ones are intended
to be used when the stage 2 library is compiled with tracing, which
affects the tests by adding events for the library procedures called
from the test programs.
The .m files are the same as before; one of the .inp files is a bit
different; the .exp files reflect the correct output when the library
is compiled with full tracing.
tests/debugger/Mmakefile:
Provide separate targets for the new set of test cases.
Use --trace full instead of --generate-trace.
tests/debugger/runtests:
Try both the new set of test cases if the old set fails, and report
failure only if both sets fail. This is simpler than trying to figure
out which set should be really tested, and the probability of a false
positive is negligible.
144 lines
4.5 KiB
C
144 lines
4.5 KiB
C
/*
|
|
** Copyright (C) 1997-1998 The University of Melbourne.
|
|
** This file may only be copied under the terms of the GNU Library General
|
|
** Public License - see the file COPYING.LIB in the Mercury distribution.
|
|
*/
|
|
|
|
/*
|
|
** mercury_trace.h has two functions.
|
|
**
|
|
** (a) It defines the interface between the tracing subsystem of the runtime
|
|
** and compiled code.
|
|
**
|
|
** (b) It defines the interface by which the internal and external debuggers
|
|
** can control how the tracing subsystem treats events.
|
|
**
|
|
** The macros and functions defined in this module are intended to be called
|
|
** only from code generated by the Mercury compiler, and from hand-written
|
|
** code in the Mercury runtime or the Mercury standard library.
|
|
*/
|
|
|
|
#ifndef MERCURY_TRACE_H
|
|
#define MERCURY_TRACE_H
|
|
|
|
/* The interface between the tracing subsystem and compiled code. */
|
|
|
|
#define MR_trace_incr_seq() (++MR_trace_call_seqno)
|
|
#define MR_trace_incr_depth() (++MR_trace_call_depth)
|
|
#define MR_trace_reset_depth(d) do { MR_trace_call_depth = (d); } while (0)
|
|
|
|
extern Word MR_trace_call_seqno;
|
|
extern Word MR_trace_call_depth;
|
|
|
|
/*
|
|
** This enum should exactly match the definition of the `trace_port' type in
|
|
** library/debugger_interface.
|
|
*/
|
|
|
|
typedef enum {
|
|
MR_PORT_CALL,
|
|
MR_PORT_EXIT,
|
|
MR_PORT_FAIL,
|
|
MR_PORT_THEN,
|
|
MR_PORT_ELSE,
|
|
MR_PORT_DISJ,
|
|
MR_PORT_SWITCH,
|
|
MR_PORT_PRAGMA_FIRST,
|
|
MR_PORT_PRAGMA_LATER
|
|
} MR_trace_port;
|
|
|
|
extern void MR_trace(
|
|
const MR_Stack_Layout_Label *, /* layout info for the event */
|
|
MR_trace_port,
|
|
Word, /* call sequence number */
|
|
Word, /* call depth */
|
|
const char *, /* path to event goal within procedure */
|
|
int, /* highest numbered rN register in use */
|
|
bool); /* is this event supposed to be traced */
|
|
|
|
/*
|
|
** These functions will report the number of the last event,
|
|
** if there have been some events, and will do nothing otherwise.
|
|
*/
|
|
|
|
extern void MR_trace_report(FILE *fp);
|
|
extern void MR_trace_report_raw(int fd);
|
|
|
|
/*
|
|
** MR_trace_init() is called from mercury_runtime_init()
|
|
** when the debuggee programs begins, to perform any initialization
|
|
** that must be done before any traced Mercury code is executed.
|
|
** This includes the initialization code written in Mercury as well as main.
|
|
**
|
|
** MR_trace_start(enabled) is called from mercury_runtime_init()
|
|
** after the initialization code written in Mercury is executed,
|
|
** when we are about to start executing main. The argument says
|
|
** whether tracing is enabled for main (it is never enabled for
|
|
** initialization and finalization routines).
|
|
**
|
|
** MR_trace_end() is called from mercury_runtime_terminate() just
|
|
** after main has terminated and just before we call the finalization
|
|
** code written in Mercury.
|
|
**
|
|
** MR_trace_final() is called from mercury_runtime_terminate()
|
|
** after all Mercury code, including finalization code, has terminated.
|
|
*/
|
|
|
|
extern void MR_trace_init(void);
|
|
extern void MR_trace_start(bool enabled);
|
|
extern void MR_trace_end(void);
|
|
extern void MR_trace_final(void);
|
|
|
|
typedef enum {
|
|
MR_TRACE_INTERNAL,
|
|
MR_TRACE_EXTERNAL
|
|
} MR_trace_type;
|
|
|
|
extern MR_trace_type MR_trace_handler;
|
|
extern bool MR_trace_enabled;
|
|
|
|
extern Unsigned MR_trace_event_number;
|
|
|
|
extern Bool MR_trace_from_full;
|
|
|
|
/* The interface between the debuggers and the tracing subsystem. */
|
|
|
|
/*
|
|
** MR_trace_cmd says what mode the tracer is in, i.e. how events should be
|
|
** treated.
|
|
**
|
|
** If MR_trace_cmd == MR_CMD_GOTO, the event handler will stop at the next
|
|
** event whose event number is equal to or greater than MR_trace_stop_event.
|
|
**
|
|
** If MR_trace_cmd == MR_CMD_FINISH, the event handler will stop at the next
|
|
** event that specifies the procedure invocation whose call number is in
|
|
** MR_trace_stop_seqno and whose port is final.
|
|
**
|
|
** If MR_trace_cmd == MR_CMD_RESUME_FORWARD, the event handler will stop at
|
|
** the next event of any call whose port is *not* final.
|
|
**
|
|
** If MR_trace_cmd == MR_CMD_TO_END, the event handler will not stop
|
|
** until the end of the program.
|
|
**
|
|
** If the event handler does not stop at an event, it will print the
|
|
** summary line for the event if MR_trace_print_intermediate is true.
|
|
*/
|
|
|
|
typedef enum {
|
|
MR_CMD_GOTO, /* stop at an event with a given number */
|
|
MR_CMD_FINISH, /* stop when exiting/failing out of a proc */
|
|
MR_CMD_RESUME_FORWARD, /* stop at the next non-final port */
|
|
MR_CMD_TO_END /* do not stop until the end of execution */
|
|
} MR_trace_cmd_type;
|
|
|
|
typedef struct {
|
|
MR_trace_cmd_type MR_trace_cmd;
|
|
Unsigned MR_trace_stop_seqno;
|
|
Unsigned MR_trace_stop_event;
|
|
bool MR_trace_print_intermediate;
|
|
} MR_trace_cmd_info;
|
|
|
|
#define MR_port_is_final(port) (port == MR_PORT_EXIT || port == MR_PORT_FAIL)
|
|
|
|
#endif /* MERCURY_TRACE_H */
|