Files
mercury/compiler/livemap.m
Zoltan Somogyi f0964815a3 Support line numbers in the debugger. You now get contexts (filename:lineno
Estimated hours taken: 40

Support line numbers in the debugger. You now get contexts (filename:lineno
pairs) printed in several circumstances, and you can put breakpoints on
contexts, when they correspond to trace events or to calls. The latter are
implemented as breakpoints on the label layouts of the return sites.

This required extending the debugging RTTI, so that associated with each
module there is now a new data structure listing the source file names that
contribute labels with layout structures to the code of the module. For each
such source file, this table gives a list of all such labels arising from
that file. The table entry for a label gives the line number within the file,
and the pointer to the label layout structure.

compiler/llds.m:
	Add a context field to the call instruction.

compiler/continuation_info.m:
	Instead of the old division of continuation info about labels into
	trace ports and everything else, divide them into trace ports, resume
	points and return sites. Record contexts with trace ports, and record
	contexts and called procedure information with return sites.

compiler/code_info.m:
	Conform to the changes in continuation_info.m.

compiler/options.m:
	Add a new option that allows us to disable the generation of line
	number information for size benchmarking (it has no other use).

compiler/stack_layout.m:
	Generate the new components of the RTTI, unless the option says not to.

compiler/code_gen.m:
compiler/pragma_c_gen.m:
compiler/trace.m:
	Include contexts in the information we gather for the layouts
	associated with the events we generate.

compiler/call_gen.m:
	Include contexts in the call LLDS instructions, for association
	with the return site's label layout structure (which is done after
	code generation is finished).

compiler/handle_options.m:
	Delete the code that tests or sets the deleted options.

compiler/mercury_compile.m:
	Delete the code that tests the deleted options.

compiler/basic_block.m:
compiler/dupelim.m:
compiler/frameopt.m:
compiler/livemap.m:
compiler/llds_common.m:
compiler/llds_out.m:
compiler/middle_rec.m:
compiler/opt_debug.m:
compiler/opt_util.m:
compiler/value_number.m:
compiler/vn_*.m:
	Trivial changes to conform to the changes to llds.m.

compiler/jumpopt.m:
	Do not optimize away jumps to labels with layout structures.
	The jumps we are particularly concerned about now are the jumps
	that return from procedure calls. Previously, it was okay to redirect
	returns from several calls so that all go to the same label, since
	the live variable information associated with the labels could be
	merged. However, we now also associate line numbers with calls, and
	these cannot be usefully merged.

compiler/optimize.m:
	Pass the information required by jumpopt to it.

doc/user_guide.texi:
	Document that you can now break at line numbers.

	Document the new "context" command, and the -d or --detailed option
	of the stack command and the commands that set ancestor levels.

runtime/mercury_stack_layout.h:
	Extend the module layout structure definition with the new tables.

	Remove the conditional facility for including label numbers in label
	layout structures. It hasn't been used in a long time, and neither
	Tyson or me expect to use it to debug either gc or the debugger itself,
	so it has no uses left; the line numbers have superseded it.

runtime/mercury_stack_trace.[ch]:
	Extend the code to print stack traces to also optionally print
	contexts.

	Add some utility predicates currently used by the debugger that could
	also be use for debugging gc or for more detailed stack traces.

trace/mercury_trace_internal.c:
	Implement the "break <context>" command, the "context" command, and
	the -d or --detailed option of the stack command and the commands
	that set ancestor levels.

	Conditionally define a conditionally used variable.

trace/mercury_trace_external.c:
	Minor changes to keep up with the changes to stack traces.

	Delete an unused variable.

trace/mercury_trace_spy.[ch]:
	Check for breakpoints on contexts.

trace/mercury_trace_tables.[ch]:
	Add functions to search the RTTI data structures for labels
	corresponding to a given context.

trace/mercury_trace_vars.[ch]:
	Remember the context of the current environment.

tests/debugger/queen.{inp,exp}:
	Test the new capabilities of the debugger.

tests/debugger/*.{inp,exp}:
	Update the expected output of the debugger to account for contexts.
	In some cases, modify the input script to put contexts where they don't
	overflow lines.
1999-11-15 00:43:59 +00:00

508 lines
17 KiB
Mathematica

%-----------------------------------------------------------------------------%
% Copyright (C) 1995-1999 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.
%-----------------------------------------------------------------------------%
%
% File: livemap.m
%
% Main author: zs.
%
% This module builds up a map that gives the set of live lvals at each label.
%-----------------------------------------------------------------------------%
:- module livemap.
:- interface.
:- import_module list, set, map, std_util.
:- import_module llds.
:- type livemap == map(label, lvalset).
:- type lvalset == set(lval).
% Given a list of instructions defining a procedure, return a map
% giving the set of live non-field lvals at each label.
%
% We can compute this set only if the procedure contains no C code.
:- pred livemap__build(list(instruction), maybe(livemap)).
:- mode livemap__build(in, out) is det.
:- implementation.
:- import_module opt_util.
:- import_module require, string, bool.
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
% The method we follow is a backward scan of the instruction list,
% keeping track of the set of live lvals as we go. We update this set
% at each instruction. When we get to a label, we know that this set
% of lvals is live at that label.
%
% At instructions that can branch away, every lval that is live at
% any possible target is live before that instruction. Since some
% branches may be backward branches, we may not have seen the branch
% target when we process the branch. Therefore we have to repeat the
% scan, this time with more knowledge about more labels, until we
% get to a fixpoint.
livemap__build(Instrs, MaybeLivemap) :-
map__init(Livemap0),
list__reverse(Instrs, BackInstrs),
livemap__build_2(BackInstrs, Livemap0, MaybeLivemap).
:- pred livemap__build_2(list(instruction), livemap, maybe(livemap)).
:- mode livemap__build_2(in, in, out) is det.
livemap__build_2(Backinstrs, Livemap0, MaybeLivemap) :-
set__init(Livevals0),
livemap__build_livemap(Backinstrs, Livevals0, no, DontValueNumber1,
Livemap0, Livemap1),
( DontValueNumber1 = yes ->
MaybeLivemap = no
; livemap__equal_livemaps(Livemap0, Livemap1) ->
MaybeLivemap = yes(Livemap1)
;
livemap__build_2(Backinstrs, Livemap1, MaybeLivemap)
).
% Check whether the two livemaps agree on the set of live lvals
% at every label. They must agree on the set of labels as well.
% This is important. Livemap1 will be empty in the first call,
% so agreement only on the set of labels in Livemap1 is useless.
% The domain of Livemap2 should always be every label in the procedure.
% as should the domain of Livemap1 in every call after the first.
:- pred livemap__equal_livemaps(livemap, livemap).
:- mode livemap__equal_livemaps(in, in) is semidet.
livemap__equal_livemaps(Livemap1, Livemap2) :-
map__keys(Livemap1, Labels),
map__keys(Livemap2, Labels),
livemap__equal_livemaps_keys(Labels, Livemap1, Livemap2).
:- pred livemap__equal_livemaps_keys(list(label), livemap, livemap).
:- mode livemap__equal_livemaps_keys(in, in, in) is semidet.
livemap__equal_livemaps_keys([], _Livemap1, _Livemap2).
livemap__equal_livemaps_keys([Label | Labels], Livemap1, Livemap2) :-
map__lookup(Livemap1, Label, Liveset1),
map__lookup(Livemap2, Label, Liveset2),
set__equal(Liveset1, Liveset2),
livemap__equal_livemaps_keys(Labels, Livemap1, Livemap2).
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
% Build up a map of what lvals are live at each label.
% The input instruction sequence is reversed.
:- pred livemap__build_livemap(list(instruction), lvalset, bool, bool,
livemap, livemap).
:- mode livemap__build_livemap(in, in, in, out, in, out) is det.
livemap__build_livemap([], _, DontValueNumber, DontValueNumber,
Livemap, Livemap).
livemap__build_livemap([Instr0 | Instrs0], Livevals0,
DontValueNumber0, DontValueNumber, Livemap0, Livemap) :-
livemap__build_livemap_instr(Instr0, Instrs0, Instrs1,
Livevals0, Livevals1, DontValueNumber0, DontValueNumber1,
Livemap0, Livemap1),
livemap__build_livemap(Instrs1, Livevals1,
DontValueNumber1, DontValueNumber, Livemap1, Livemap).
:- pred livemap__build_livemap_instr(instruction, list(instruction),
list(instruction), lvalset, lvalset, bool, bool, livemap, livemap).
:- mode livemap__build_livemap_instr(in, in, out, in, out, in, out, in, out)
is det.
livemap__build_livemap_instr(Instr0, Instrs0, Instrs,
Livevals0, Livevals, DontValueNumber0, DontValueNumber,
Livemap0, Livemap) :-
Instr0 = Uinstr0 - _,
(
Uinstr0 = comment(_),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = livevals(_),
error("livevals found in backward scan in build_livemap")
;
Uinstr0 = block(_, _, _),
error("block found in backward scan in build_livemap")
;
Uinstr0 = assign(Lval, Rval),
% Make dead the variable assigned, but make any variables
% needed to access it live. Make the variables in the assigned
% expression live as well.
% The deletion has to be done first. If the assigned-to lval
% appears on the right hand side as well as the left, then we
% want make_live to put it back into the liveval set.
set__delete(Livevals0, Lval, Livevals1),
opt_util__lval_access_rvals(Lval, Rvals),
livemap__make_live_in_rvals([Rval | Rvals], Livevals1,
Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = call(_, _, _, _, _),
livemap__look_for_livevals(Instrs0, Instrs,
Livevals0, Livevals, "call", yes, _),
Livemap = Livemap0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = mkframe(_, _),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = label(Label),
map__set(Livemap0, Label, Livevals0, Livemap),
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = goto(CodeAddr),
opt_util__livevals_addr(CodeAddr, LivevalsNeeded),
livemap__look_for_livevals(Instrs0, Instrs,
Livevals0, Livevals1, "goto", LivevalsNeeded, Found),
( Found = yes ->
Livevals3 = Livevals1
; CodeAddr = label(Label) ->
set__init(Livevals2),
livemap__insert_label_livevals([Label],
Livemap0, Livevals2, Livevals3)
;
( CodeAddr = do_redo
; CodeAddr = do_fail
; CodeAddr = do_not_reached
)
->
Livevals3 = Livevals1
;
error("unknown label type in build_livemap")
),
livemap__special_code_addr(CodeAddr, MaybeSpecial),
( MaybeSpecial = yes(Special) ->
set__insert(Livevals3, Special, Livevals)
;
Livevals = Livevals3
),
Livemap = Livemap0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = computed_goto(Rval, Labels),
set__init(Livevals1),
livemap__make_live_in_rvals([Rval], Livevals1, Livevals2),
livemap__insert_label_livevals(Labels, Livemap0,
Livevals2, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = c_code(_),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = yes
;
Uinstr0 = if_val(Rval, CodeAddr),
livemap__look_for_livevals(Instrs0, Instrs,
Livevals0, Livevals1, "if_val", no, Found),
(
Found = yes,
% This if_val was put here by middle_rec.
% We must make sure that the locations mentioned
% in the livevals annotation become live,
% since they will be needed at CodeAddr.
% The locations in Livevals0 may be needed
% in the fall-through continuation.
set__union(Livevals0, Livevals1, Livevals3)
;
Found = no,
livemap__make_live_in_rvals([Rval],
Livevals1, Livevals2),
( CodeAddr = label(Label) ->
livemap__insert_label_livevals([Label],
Livemap0, Livevals2, Livevals3)
;
Livevals3 = Livevals2
)
),
livemap__special_code_addr(CodeAddr, MaybeSpecial),
( MaybeSpecial = yes(Special) ->
set__insert(Livevals3, Special, Livevals)
;
Livevals = Livevals3
),
Livemap = Livemap0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = incr_hp(Lval, _, Rval, _),
% Make dead the variable assigned, but make any variables
% needed to access it live. Make the variables in the size
% expression live as well.
% The use of the size rval occurs after the assignment
% to lval, but the two should never have any variables in
% common. This is why doing the deletion first works.
set__delete(Livevals0, Lval, Livevals1),
opt_util__lval_access_rvals(Lval, Rvals),
livemap__make_live_in_rvals([Rval | Rvals],
Livevals1, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = mark_hp(Lval),
set__delete(Livevals0, Lval, Livevals1),
opt_util__lval_access_rvals(Lval, Rvals),
livemap__make_live_in_rvals(Rvals, Livevals1, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = restore_hp(Rval),
livemap__make_live_in_rvals([Rval], Livevals0, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = store_ticket(Lval),
set__delete(Livevals0, Lval, Livevals1),
opt_util__lval_access_rvals(Lval, Rvals),
livemap__make_live_in_rvals(Rvals, Livevals1, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = reset_ticket(Rval, _Reason),
livemap__make_live_in_rval(Rval, Livevals0, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = discard_ticket,
Livevals = Livevals0,
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = mark_ticket_stack(Lval),
set__delete(Livevals0, Lval, Livevals1),
opt_util__lval_access_rvals(Lval, Rvals),
livemap__make_live_in_rvals(Rvals, Livevals1, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = discard_tickets_to(Rval),
livemap__make_live_in_rval(Rval, Livevals0, Livevals),
Livemap = Livemap0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = incr_sp(_, _),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = decr_sp(_),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
Uinstr0 = init_sync_term(_, _),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = DontValueNumber0
;
% XXX Value numbering doesn't handle fork [yet] so
% set DontValueNumber to yes.
Uinstr0 = fork(_, _, _),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = yes
;
% XXX Value numbering doesn't handle join_and_terminate [yet] so
% set DontValueNumber to yes.
Uinstr0 = join_and_terminate(_),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = yes
;
% XXX Value numbering doesn't handle join_and_continue [yet] so
% set DontValueNumber to yes.
Uinstr0 = join_and_continue(_, _),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = yes
;
% XXX we shouldn't just give up here
Uinstr0 = pragma_c(_, _, _, _, _, _),
Livemap = Livemap0,
Livevals = Livevals0,
Instrs = Instrs0,
DontValueNumber = yes
).
:- pred livemap__look_for_livevals(list(instruction), list(instruction),
lvalset, lvalset, string, bool, bool).
:- mode livemap__look_for_livevals(in, out, in, out, in, in, out) is det.
livemap__look_for_livevals(Instrs0, Instrs, Livevals0, Livevals,
Site, Compulsory, Found) :-
opt_util__skip_comments(Instrs0, Instrs1),
( Instrs1 = [livevals(Livevals1) - _ | Instrs2] ->
livemap__filter_livevals(Livevals1, Livevals),
Instrs = Instrs2,
Found = yes
; Compulsory = yes ->
string__append(Site, " not preceded by livevals", Msg),
error(Msg)
;
Instrs = Instrs1,
Livevals = Livevals0,
Found = no
).
% What lval (if any) is consulted when we branch to a code address?
:- pred livemap__special_code_addr(code_addr, maybe(lval)).
:- mode livemap__special_code_addr(in, out) is det.
livemap__special_code_addr(label(_), no).
livemap__special_code_addr(imported(_), no).
livemap__special_code_addr(succip, yes(succip)).
livemap__special_code_addr(do_succeed(_), yes(succip(lval(curfr)))).
livemap__special_code_addr(do_redo, yes(redoip(lval(maxfr)))).
livemap__special_code_addr(do_trace_redo_fail_shallow, no).
livemap__special_code_addr(do_trace_redo_fail_deep, no).
livemap__special_code_addr(do_fail, no).
livemap__special_code_addr(do_call_closure, no).
livemap__special_code_addr(do_call_class_method, no).
livemap__special_code_addr(do_det_aditi_call, no).
livemap__special_code_addr(do_semidet_aditi_call, no).
livemap__special_code_addr(do_nondet_aditi_call, no).
livemap__special_code_addr(do_aditi_insert, no).
livemap__special_code_addr(do_aditi_delete, no).
livemap__special_code_addr(do_aditi_bulk_insert, no).
livemap__special_code_addr(do_aditi_bulk_delete, no).
livemap__special_code_addr(do_aditi_modify, no).
livemap__special_code_addr(do_not_reached, no).
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
:- pred livemap__make_live_in_rvals(list(rval), lvalset, lvalset).
:- mode livemap__make_live_in_rvals(in, in, out) is det.
livemap__make_live_in_rvals([], Live, Live).
livemap__make_live_in_rvals([Rval | Rvals], Live0, Live) :-
livemap__make_live_in_rval(Rval, Live0, Live1),
livemap__make_live_in_rvals(Rvals, Live1, Live).
% Set all lvals found in this rval to live, with the exception of
% fields, since they are treated specially (the later stages consider
% them to be live even if they are not explicitly in the live set).
:- pred livemap__make_live_in_rval(rval, lvalset, lvalset).
:- mode livemap__make_live_in_rval(in, in, out) is det.
livemap__make_live_in_rval(lval(Lval), Live0, Live) :-
% XXX maybe we should treat mem_refs the same way as field refs
( Lval = field(_, _, _) ->
Live1 = Live0
;
set__insert(Live0, Lval, Live1)
),
opt_util__lval_access_rvals(Lval, AccessRvals),
livemap__make_live_in_rvals(AccessRvals, Live1, Live).
livemap__make_live_in_rval(create(_, _, _, _, _, _), Live, Live).
% All terms inside creates in the optimizer must be static.
livemap__make_live_in_rval(mkword(_, Rval), Live0, Live) :-
livemap__make_live_in_rval(Rval, Live0, Live).
livemap__make_live_in_rval(const(_), Live, Live).
livemap__make_live_in_rval(unop(_, Rval), Live0, Live) :-
livemap__make_live_in_rval(Rval, Live0, Live).
livemap__make_live_in_rval(binop(_, Rval1, Rval2), Live0, Live) :-
livemap__make_live_in_rval(Rval1, Live0, Live1),
livemap__make_live_in_rval(Rval2, Live1, Live).
livemap__make_live_in_rval(var(_), _, _) :-
error("var rval should not propagate to the optimizer").
livemap__make_live_in_rval(mem_addr(MemRef), Live0, Live) :-
livemap__make_live_in_mem_ref(MemRef, Live0, Live).
:- pred livemap__make_live_in_mem_ref(mem_ref, lvalset, lvalset).
:- mode livemap__make_live_in_mem_ref(in, in, out) is det.
livemap__make_live_in_mem_ref(stackvar_ref(_), Live, Live).
livemap__make_live_in_mem_ref(framevar_ref(_), Live, Live).
livemap__make_live_in_mem_ref(heap_ref(Rval, _, _), Live0, Live) :-
livemap__make_live_in_rval(Rval, Live0, Live).
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%
:- pred livemap__filter_livevals(lvalset, lvalset).
:- mode livemap__filter_livevals(in, out) is det.
livemap__filter_livevals(Livevals0, Livevals) :-
set__to_sorted_list(Livevals0, Livelist),
set__init(Livevals1),
livemap__insert_proper_livevals(Livelist, Livevals1, Livevals).
:- pred livemap__insert_label_livevals(list(label), livemap, lvalset, lvalset).
:- mode livemap__insert_label_livevals(in, in, in, out) is det.
livemap__insert_label_livevals([], _, Livevals, Livevals).
livemap__insert_label_livevals([Label | Labels], Livemap, Livevals0, Livevals)
:-
( map__search(Livemap, Label, LabelLivevals) ->
set__to_sorted_list(LabelLivevals, Livelist),
livemap__insert_proper_livevals(Livelist, Livevals0, Livevals1)
;
Livevals1 = Livevals0
),
livemap__insert_label_livevals(Labels, Livemap, Livevals1, Livevals).
:- pred livemap__insert_proper_livevals(list(lval), lvalset, lvalset).
:- mode livemap__insert_proper_livevals(in, in, out) is det.
livemap__insert_proper_livevals([], Livevals, Livevals).
livemap__insert_proper_livevals([Live | Livelist], Livevals0, Livevals) :-
livemap__insert_proper_liveval(Live, Livevals0, Livevals1),
livemap__insert_proper_livevals(Livelist, Livevals1, Livevals).
% Don't insert references to locations on the heap.
:- pred livemap__insert_proper_liveval(lval, lvalset, lvalset).
:- mode livemap__insert_proper_liveval(in, in, out) is det.
livemap__insert_proper_liveval(Live, Livevals0, Livevals) :-
( Live = field(_, _, _) ->
Livevals = Livevals0
;
set__insert(Livevals0, Live, Livevals)
).
%-----------------------------------------------------------------------------%
%-----------------------------------------------------------------------------%