mirror of
https://github.com/Mercury-Language/mercury.git
synced 2026-04-22 04:43:53 +00:00
e6ac077bae
Estimated hours taken: 40 (+ unknown time by Zoltan)
Add support for memory profiling.
(A significant part of this change is actuallly Zoltan's work. Zoltan
did the changes to the compiler and a first go at the changes to the
runtime and library. I rewrote much of Zoltan's changes to the runtime
and library, added support for the new options/grades, added code to
interface with mprof, did the changes to the profiler, and wrote the
documentation.)
[TODO: add test cases.]
NEWS:
Mention support for memory profiling.
runtime/mercury_heap_profile.h:
runtime/mercury_heap_profile.c:
New files. These contain code to record heap profiling information.
runtime/mercury_heap.h:
Add new macros incr_hp_msg(), tag_incr_hp_msg(),
incr_hp_atomic_msg(), and tag_incr_hp_atomic_msg().
These are like the non-`msg' versions, except that if
PROFILE_MEMORY is defined, they also call MR_record_allocation()
from mercury_heap_profile.h to record heap profiling information.
Also, fix up the indentation in lots of places.
runtime/mercury_prof.h:
runtime/mercury_prof.c:
Added code to dump out memory profiling information to files
`Prof.MemoryWords' and `Prof.MemoryCells' (for use by mprof).
Change the format of the `Prof.Counts' file so that the
first line says what it is counting, the units, and a scale
factor. Prof.MemoryWords and Prof.MemoryCells can thus have
exactly the same format as Prof.Counts.
Also cleaned up the interface to mercury_prof.c a bit, and did
various other minor cleanups -- indentation changes, changes to
use MR_ prefixes, additional comments, etc.
runtime/mercury_prof_mem.h:
runtime/mercury_prof_mem.c:
Rename prof_malloc() as MR_prof_malloc().
Rename prof_make() as MR_PROF_NEW() and add MR_PROF_NEW_ARRAY().
runtime/mercury_wrapper.h:
Minor modifications to reflect the new interface to mercury_prof.c.
runtime/mercury_wrapper.c:
runtime/mercury_label.c:
Rename the old `-p' (primary cache size) option as `-C'.
Add a new `-p' option to disable profiling.
runtime/Mmakefile:
Add mercury_heap_profile.[ch].
Put the list of files in alphabetical order.
Delete some obsolete stuff for supporting `.mod' files.
Mention that libmer_dll.h and libmer_globals.h are
produced by Makefile.DLLs.
runtime/mercury_imp.h:
Mention that libmer_dll.h is produced by Makefile.DLLs.
runtime/mercury_dummy.c:
Change a comment to refer to libmer_dll.h rather than
libmer_globals.h.
compiler/llds.m:
Add a new field to `create' and `incr_hp' instructions
holding the name of the type, for heap profiling.
compiler/unify_gen.m:
Initialize the new field of `create' instructions with
the appropriate type name.
compiler/llds_out.m:
Output incr_hp_msg() / tag_incr_hp_msg() instead of
incr_hp() / tag_incr_hp().
compiler/*.m:
Minor changes to most files in the compiler back-end to
accomodate the new field in `incr_hp' and `create' instructions.
library/io.m:
Add `io__report_full_memory_stats'.
library/benchmarking.m:
Add `report_full_memory_stats'. This uses the information saved
by runtime/mercury_heap_profile.{c,h} to print out a report
of memory usage by procedures and by types.
Also modify `report_stats' to print out some of that information.
compiler/mercury_compile.m:
If `--statistics' is enabled, call io__report_full_memory_stats
at the end of main/2. This will print out full memory statistics,
if the compiler was compiled with memory profiling enabled.
compiler/options.m:
compiler/handle_options.m:
runtime/mercury_grade.h:
scripts/ml.in:
scripts/mgnuc.in:
scripts/init_grade_options.sh-subr:
scripts/parse_grade_options.sh-subr:
Add new option `--memory-profiling' and new grade `.memprof'.
Add `--time-profiling' as a new synonym for `--profiling'.
Also add `--profile-memory' for more fine-grained control:
`--memory-profiling' implies both `--profile-memory' and
`--profile-calls'.
scripts/mprof_merge_runs:
Update to handle the new format of Prof.Counts and to
also merge Prof.MemoryWords and Prof.MemoryCells.
profiler/options.m:
profiler/mercury_profile.m:
Add new options `--profile memory-words' (`-m'),
`--profile memory-cells' (`-M') and `--profile time' (`-t').
Thes options make the profiler select a different count file,
Prof.MemoryWords or Prof.MemoryCells instead of Prof.Counts.
specific to time profiling.
profiler/read.m:
profiler/process_file.m:
profiler/prof_info.m:
profiler/generate_output.m:
Update to handle the new format of the counts file.
When reading the counts file, look at the first line of
the file to determine what is being profiled.
profiler/globals.m:
Add a new global variable `what_to_profile' that records
what is being profiled.
profiler/output.m:
Change the headings to reflect what is being profiled.
doc/user_guide.texi:
Document memory profiling.
Document new options.
doc/user_guide.texi:
compiler/options.m:
Comment out the documentation for `.proftime'/`--profile-time',
since doing time and call profiling seperately doesn't work,
because the code addresses change when you recompile with a
different grade. Ditto for `.profmem'/`--profile-memory'.
Also comment out the documentation for
`.profcalls'/`--profile-calls', since it is redundant --
`.memprof' produces the same information and more.
configure.in:
Build a `.memprof' grade. (Hmm, should we do this only
if `--enable-all-grades' is specified?)
Don't ever build a `.profcalls' grade.
84 lines
2.3 KiB
C
84 lines
2.3 KiB
C
/*
|
|
** Copyright (C) 1995-1997 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_prof.h -- definitions for profiling.
|
|
** (See also mercury_heap_profiling.h.)
|
|
*/
|
|
|
|
#ifndef MERCURY_PROF_H
|
|
#define MERCURY_PROF_H
|
|
|
|
#include "mercury_types.h" /* for `Code *' */
|
|
|
|
/*
|
|
** This variable holds the address of the "current" procedure so that
|
|
** when a profiling interrupt occurs, the profiler knows where we are,
|
|
** so that it can credit the time to the appropriate procedure.
|
|
*/
|
|
|
|
extern Code * volatile MR_prof_current_proc;
|
|
|
|
/*
|
|
** The following two macros are used to ensure that the profiler can
|
|
** use `prof_current_proc' to determine what procedure is currently
|
|
** being executed when a profiling interrupt occurs.
|
|
*/
|
|
|
|
#ifdef PROFILE_TIME
|
|
#define set_prof_current_proc(target) \
|
|
(MR_prof_current_proc = (target))
|
|
#define update_prof_current_proc(target) \
|
|
(MR_prof_current_proc = (target))
|
|
#else
|
|
#define set_prof_current_proc(target) ((void)0)
|
|
#define update_prof_current_proc(target) ((void)0)
|
|
#endif
|
|
|
|
/*
|
|
** The PROFILE() macro is used (by mercury_calls.h) to record each call.
|
|
*/
|
|
|
|
#ifdef PROFILE_CALLS
|
|
#define PROFILE(callee, caller) MR_prof_call_profile((callee), (caller))
|
|
#else
|
|
#define PROFILE(callee, caller) ((void)0)
|
|
#endif
|
|
|
|
#ifdef PROFILE_CALLS
|
|
extern void MR_prof_call_profile(Code *, Code *);
|
|
#endif
|
|
|
|
|
|
/*
|
|
** The prof_output_addr_decl() function is used by insert_entry() in
|
|
** mercury_label.c to record the address of each entry label.
|
|
*/
|
|
|
|
extern void MR_prof_output_addr_decl(const char *name, const Code *address);
|
|
|
|
|
|
/*
|
|
** The following functions are used by mercury_wrapper.c to
|
|
** initiate profiling, at the start of the the program,
|
|
** and to finish up profiling (writing the profiling data to files)
|
|
** at the end of the program.
|
|
** Note that prof_init() calls atexit(prof_finish), so that it can handle
|
|
** the case where the program exits by calling exit() rather than just
|
|
** returning, so it is actually not necessary to call prof_finish()
|
|
** explicitly.
|
|
*/
|
|
|
|
extern void MR_prof_init(void);
|
|
extern void MR_prof_finish(void);
|
|
|
|
#ifdef PROFILE_TIME
|
|
extern void MR_prof_turn_on_time_profiling(void);
|
|
extern void MR_prof_turn_off_time_profiling(void);
|
|
#endif
|
|
|
|
#endif /* not MERCURY_PROF_H */
|