mirror of
https://github.com/Mercury-Language/mercury.git
synced 2025-12-15 05:44:58 +00:00
678fa1075f
Estimated hours taken: 6
Branches: main
Add a capability for measuring statistics about the stack frame usage
of a program.
configure.in:
Find out the symbolic names of the max values for the 16 and 32 bit
integer types.
runtime/mercury_conf.h.in:
Include MR_{UINT,INT}_LEAST{16,32}_MAX among the macros whose values
are determined by autoconfiguration.
runtime/mercury_conf_param.h:
Document MR_STACK_FRAME_STATS as a macro whose definition causes the
program to collect statistics on stack frame sizes.
Fix an obsolete reference: PARALLEL was renamed MR_THREAD_SAFE a long
time ago.
Document the incompatibility between MR_THREAD_SAFE and the statistics
collection flags.
runtime/mercury_stacks.h:
If MR_STACK_FRAME_STATS is defined, then record statistics every time
we create a stack frame.
runtime/mercury_stacks.c:
Define the global variables and functions needed for stack frame
statistics.
runtime/mercury_heap_profile.h:
runtime/mercury_dword.h:
Move the macros for managing 64-bit counters from
mercury_heap_profile.h to a new header file, mercury_dword.h,
since mercury_stacks.h now needs such counters too.
Rewrite the macros to make fewer assumptions, using MR_int_least64_t
and MR_int_least32_t instead of "long long" and "int".
Add expression-like forms of some of the macros for use in
mercury_stacks.h.
Rename the type MR_dword as MR_Dword.
runtime/mercury_heap_profile.c:
#include the new header file.
runtime/mercury_prof.c:
Conform to the change from MR_dword to MR_Dword.
runtime/Mmakefile:
Add the new header file to the list of header files.
runtime/mercury_wrapper.c:
If MR_STACK_FRAME_STATS is defined, initialize the stack frame stats
before execution starts and write out the statistics when execution
ends.
tools/speedtest:
Add an option that when set, causes the script to report stack frame
stats for each variant being tested.
114 lines
3.6 KiB
C
114 lines
3.6 KiB
C
/*
|
|
** Copyright (C) 1998, 2000-2001 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.
|
|
*/
|
|
|
|
/*
|
|
** File: mercury_heap_profile.h
|
|
** Main authors: zs, fjh
|
|
**
|
|
** This module records information about the allocations of cells on the heap.
|
|
** The information recorded here is used by mercury_prof.c and
|
|
** by library/benchmarking.m.
|
|
*/
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef MERCURY_HEAP_PROFILE_H
|
|
#define MERCURY_HEAP_PROFILE_H
|
|
|
|
#include "mercury_types.h" /* for `MR_Code' */
|
|
#include "mercury_dword.h" /* for `MR_Dword' */
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
|
|
/* type declarations */
|
|
|
|
/*
|
|
** We count memory allocation in units of
|
|
** - cells (i.e. individual allocations), and
|
|
** - words
|
|
**
|
|
** We keep track of how much allocation occurs in each "period".
|
|
** A period ends (and a new period begins) at each call to
|
|
** report_stats or report_full_memory_stats in library/benchmarking.m.
|
|
** We also keep track of the total allocation over all periods.
|
|
**
|
|
** We keep track of how much memory was allocated
|
|
** - by each procedure,
|
|
** - for objects of each type,
|
|
** - and an overall total
|
|
**
|
|
** The tables of counters for each procedure is represented
|
|
** as a binary search tree. Similarly for the table of counters
|
|
** for each type.
|
|
**
|
|
** Due to garbage collection, the total amount of memory allocated can exceed
|
|
** the amount of real or even virtual memory available. Hence the total amount
|
|
** of memory allocated by a long-running Mercury program might not fit into a
|
|
** single 32-bit `unsigned long'. This is why we use MR_Dwords, which are
|
|
** at least 64 bits in size.
|
|
*/
|
|
|
|
typedef struct MR_memprof_counter
|
|
{
|
|
MR_Dword cells_at_period_start;
|
|
MR_Dword words_at_period_start;
|
|
MR_Dword cells_since_period_start;
|
|
MR_Dword words_since_period_start;
|
|
} MR_memprof_counter;
|
|
|
|
/* type representing a binary tree node */
|
|
typedef struct MR_memprof_record
|
|
{
|
|
const char *name; /* of the type or procedure */
|
|
MR_Code *addr; /* for procedures only */
|
|
MR_memprof_counter counter;
|
|
struct MR_memprof_record *left; /* left sub-tree */
|
|
struct MR_memprof_record *right; /* right sub-tree */
|
|
} MR_memprof_record;
|
|
|
|
/* type representing a binary tree */
|
|
typedef struct MR_memprof_table
|
|
{
|
|
MR_memprof_record *root;
|
|
int num_entries;
|
|
} MR_memprof_table;
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
|
|
/* global variables */
|
|
|
|
extern MR_memprof_counter MR_memprof_overall;
|
|
extern MR_memprof_table MR_memprof_procs;
|
|
extern MR_memprof_table MR_memprof_types;
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
|
|
/* function declarations */
|
|
|
|
/*
|
|
** MR_record_allocation(size, proc_addr, proc_name, type):
|
|
** Record heap profiling information for an allocation of one cell
|
|
** of `size' words by procedure `proc_name' with address `proc_addr'
|
|
** for an object of type `type'.
|
|
** The heap profiling information is recorded in the three global
|
|
** variables above.
|
|
*/
|
|
extern void MR_record_allocation(int size, MR_Code *proc_addr,
|
|
const char *proc_name, const char *type);
|
|
|
|
/*
|
|
** MR_prof_output_mem_tables():
|
|
** Write out the information recorded by MR_record_allocation()
|
|
** to a pair of files `Prof.MemoryMR_Words' and `Prof.MemoryCells'.
|
|
*/
|
|
extern void MR_prof_output_mem_tables(void);
|
|
|
|
/*---------------------------------------------------------------------------*/
|
|
|
|
#endif /* MERCURY_HEAP_PROFILE_H */
|
|
|
|
/*---------------------------------------------------------------------------*/
|