xref: /original-bsd/lib/libc/gmon/moncontrol.3 (revision e59fb703)
Copyright (c) 1980, 1991 Regents of the University of California.
All rights reserved.

%sccs.include.proprietary.roff%

@(#)moncontrol.3 6.3 (Berkeley) 05/22/91

MONCONTROL 3 ""
C 4
NAME
moncontrol, monstartup - prepare execution profile
SYNOPSIS
 moncontrol(mode)  int mode;  monstartup(lowpc, highpc)  int (*lowpc)(), (*highpc)(); 
DESCRIPTION

An executable program created by:

" cc -pg . . ."

automatically includes calls to collect statistics for the gprof (1) call-graph execution profiler. In typical operation, profiling begins at program startup and ends when the program calls exit. When the program exits, the profiling data are written to the file gmon.out , then gprof (1) can be used to examine the results.

Moncontrol selectively controls profiling within a program. When the program starts, profiling begins. To stop the collection of histogram ticks and call counts use moncontrol (0); to resume the collection of histogram ticks and call counts use moncontrol (1). This allows the cost of particular operations to be measured. Note that an output file will be produced on program exit regardless of the state of moncontrol.

Programs that are not loaded with

" cc -pg . . ."

may selectively collect profiling statistics by calling monstartup with the range of addresses to be profiled. Lowpc and highpc specify the address range that is to be sampled; the lowest address sampled is that of lowpc and the highest is just below highpc . Only functions in that range that have been compiled with the -p option to cc (1) will appear in the call graph part of the output; however, all functions in that address range will have their execution time measured. Profiling begins on return from monstartup .

To stop execution monitoring and write the results on the file gmon.out, use

_mcleanup();

then gprof (1) can be used to examine the results.

FILES
gmon.out
"SEE ALSO"
cc(1), gprof(1), profil(2)