mprof.1

debug source code under unix platform.

MPROF(1)                 mpatrol library                 MPROF(1)


NNAAMMEE
       mprof  -  displays  profiling  information produced by the
       mpatrol library

SSYYNNOOPPSSIISS
       mmpprrooff [_o_p_t_i_o_n_s] [_f_i_l_e]

DDEESSCCRRIIPPTTIIOONN
       The mmpprrooff command is a tool designed to read  a  profiling
       output  file  produced  by the mpatrol library and display
       the profiling information that was obtained.  The  profil-
       ing  information  includes  summaries of all of the memory
       allocations listed by size and the function that allocated
       them and a list of memory leaks with the call stack of the
       allocating function.  It also includes a graph of all mem-
       ory  allocations  listed  in tabular form, and an optional
       graph specification file for later processing by  the  ddoott
       graph visualisation package.

       When  the  PPRROOFF  option  is used with the mpatrol library,
       statistics for all dynamic memory allocations and  deallo-
       cations  are written to a profiling output file.  The name
       of this file can be changed with the PPRROOFFFFIILLEE  option  and
       the  frequency  at which the file is written can be speci-
       fied with the AAUUTTOOSSAAVVEE option.  The bounds for small allo-
       cations,  medium  allocations, large allocations and extra
       large allocations can be set with the SSMMAALLLLBBOOUUNNDD,  MMEEDDIIUUMM--
       BBOOUUNNDD and LLAARRGGEEBBOOUUNNDD options.

       Only allocations and deallocations are recorded, with each
       reallocation being treated as a  deallocation  immediately
       followed  by  an  allocation.   For full memory allocation
       profiling support, call stack traversal must be  supported
       in  the  mpatrol  library and all of the program's symbols
       must have been successfully read by  the  mpatrol  library
       before  the  program  was  run.   The  mmpprrooff  command will
       attempt to compensate if either of these requirements  are
       not  met,  but the displayed tables may contain less mean-
       ingful information.

       The _f_i_l_e argument must be a valid mpatrol profiling output
       filename  but  if _f_i_l_e is omitted then mmpprrooff will use _m_p_a_-
       _t_r_o_l_._o_u_t as the name of the profiling output file to  use.
       If  _f_i_l_e is given as _- then the standard input file stream
       will be used as the profiling output file.

       Much of the functionality of this tool is based upon mmpprrooff
       by  Benjamin Zorn and Paul Hilfinger, which was written as
       a  research  project  and  ran  on  MIPS,  SPARC  and  VAX
       machines.   However, the profiling output files are incom-
       patible, the tables displayed have a different format, and
       the way they are implemented is entirely different.

OOPPTTIIOONNSS
       ----aaddddrreesssseess [--aa]
              Specifies that different call sites from within the
              same function are to be differentiated and that the
              names  of  all  functions  should be displayed with
              their call site offset in bytes.  This affects  the
              direct  allocation  and memory leak tables, as well
              as the allocation call graph and the graph specifi-
              cation file.

       ----ccaallll--ggrraapphh [--vv]
              Specifies  that the allocation call graph should be
              displayed.  This is not displayed by default as  it
              can get very large for even a moderately sized pro-
              filing output file.

       ----ccoouunnttss [--cc]
              Specifies that certain tables should be  sorted  by
              the  number  of allocations or deallocations rather
              than the total number of bytes allocated or deallo-
              cated.  This affects the direct allocation and mem-
              ory leak tables, as well  as  the  allocation  call
              graph and the graph specification file.

       ----ggrraapphh--ffiillee _f_i_l_e [--gg]
              Specifies  that  the  allocation  call graph should
              also be written to a graph specification  file  for
              later  visualisation with ddoott.  If _f_i_l_e is given as
              _s_t_d_o_u_t or _s_t_d_e_r_r then the corresponding file stream
              will be used as the target for the graph specifica-
              tion file.

       ----hheellpp [--hh]
              Displays a quick-reference option summary.

       ----lleeaakkss [--ll]
              Specifies that  memory  leaks  rather  than  memory
              allocations are to be written to the graph specifi-
              cation file.  This option only affects  the  output
              from the ----ggrraapphh--ffiillee option.

       ----ssttaacckk--ddeepptthh _d_e_p_t_h [--nn]
              Specifies  the maximum stack depth to use when cal-
              culating if one call site has the same  call  stack
              as another call site.  This also specifies the max-
              imum number of  functions  to  display  in  a  call
              stack.   If  _d_e_p_t_h  is  _0 then the call stack depth
              will be unlimited in size.  The default call  stack
              depth is _1.  This affects the memory leak table.

       ----vveerrssiioonn [--VV]
              Displays the version number of the mmpprrooff command.

SSEEEE AALLSSOO
       mmppaattrrooll(1),  mmppttrraaccee(1),  mmlleeaakk(1),  mmppssyymm(1),  mmppeeddiitt(1),
       hheexxwwoorrddss(1),  pprrooff(1),  ggpprrooff(1),  ddoott(1),  lliibbmmppaattrrooll(3),
       lliibbmmppaalllloocc(3).

       The mpatrol manual and reference card.

       http://www.cbmamiga.demon.co.uk/mpatrol/

AAUUTTHHOORR
       Graeme S. Roy <[e-mail]>

CCOOPPYYRRIIGGHHTT
       Copyright  (C)  1997-2002  Graeme  S. Roy <graeme.roy@ana-
       log.com>

       This library is free software;  you  can  redistribute  it
       and/or  modify  it under the terms of the GNU Library Gen-
       eral Public License as  published  by  the  Free  Software
       Foundation;  either  version 2 of the License, or (at your
       option) any later version.

       This library is distributed in the hope that  it  will  be
       useful, but WITHOUT ANY WARRANTY; without even the implied
       warranty of MERCHANTABILITY or FITNESS  FOR  A  PARTICULAR
       PURPOSE.   See  the GNU Library General Public License for
       more details.

       You should have received a copy of the GNU Library General
       Public  License  along with this library; if not, write to
       the Free Software Foundation, Inc., 59 Temple Place, Suite
       330, Boston, MA 02111-1307, USA.



Release 1.4               8 January 2002                        1