mleak.1

debug source code under unix platform.

MLEAK(1)                 mpatrol library                 MLEAK(1)


NNAAMMEE
       mleak - locates memory leaks in an mpatrol log file

SSYYNNOOPPSSIISS
       mmlleeaakk [_o_p_t_i_o_n_s] [_f_i_l_e]

DDEESSCCRRIIPPTTIIOONN
       The  mmlleeaakk  command  is used to display all unfreed memory
       allocations from  a  log  file  produced  by  the  mpatrol
       library.  This should be used if the mpatrol library could
       not finish writing the log file due  to  abnormal  program
       termination  (which  would  prevent the SSHHOOWWUUNNFFRREEEEDD option
       from working), but note that some of the  unfreed  alloca-
       tions  might have been freed if the program had terminated
       successfully.

       The mmlleeaakk command scans through an mpatrol log file  look-
       ing  for lines beginning with _A_L_L_O_C_: and _F_R_E_E_: but ignores
       lines beginning with _R_E_A_L_L_O_C_:, so only the  LLOOGGAALLLLOOCCSS  and
       LLOOGGFFRREEEESS  options  are  necessary  when  running a program
       linked with the mpatrol library.  Note that as a result of
       this, no attempt is made to account for resizing of memory
       allocations and so the total amount of memory used by  the
       resulting  unfreed  allocations  may not be entirely accu-
       rate.

       This command will also read the unfreed allocations  table
       produced  by the SSHHOOWWUUNNFFRREEEEDD option in the log file if one
       is present.  The entries in the  table  will  be  compared
       with  the currently allocated entries and will be added if
       not already present.

       The _f_i_l_e argument must be a valid mpatrol log filename but
       if  _f_i_l_e is omitted then mmlleeaakk will use _m_p_a_t_r_o_l_._l_o_g as the
       name of the log file to use.  The mmlleeaakk command makes  two
       passes  over  the  log  file so the file must be randomly-
       accessable.  If _f_i_l_e is given as _- then the standard input
       file stream will be used as the log file.

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

       ----iiggnnoorree [--ii]
              Specifies  that  the list of unfreed allocations in
              the log file should be ignored.

       ----mmaaxx--ssttaacckk _d_e_p_t_h [--nn]
              Specifies the maximum stack depth  to  display  for
              each unfreed memory allocation.  If _d_e_p_t_h is _0 then
              the call stack depth will  be  unlimited  in  size.
              The default call stack depth is _0.

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

SSEEEE AALLSSOO
       mmppaattrrooll(1),  mmpprrooff(1),  mmppttrraaccee(1),  mmppssyymm(1),  mmppeeddiitt(1),
       hheexxwwoorrddss(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