mpatrol.1

debug source code under unix platform.

MPATROL(1)               mpatrol library               MPATROL(1)


NNAAMMEE
       mpatrol - runs programs using the mpatrol library

SSYYNNOOPPSSIISS
       mmppaattrrooll [_o_p_t_i_o_n_s] <_c_o_m_m_a_n_d> [_a_r_g_u_m_e_n_t_s]

DDEESSCCRRIIPPTTIIOONN
       The mmppaattrrooll command is used to set various mpatrol library
       _o_p_t_i_o_n_s when running _c_o_m_m_a_n_d with its _a_r_g_u_m_e_n_t_s.  In  most
       cases,  _c_o_m_m_a_n_d  must  have  been  linked with the mpatrol
       library, unless the _-_-_d_y_n_a_m_i_c option is used in which case
       _c_o_m_m_a_n_d need only have been dynamically linked.

       All  mpatrol library diagnostics are sent to the file _m_p_a_-
       _t_r_o_l_._%_n_._l_o_g in the current directory by default (where  _%_n
       is  the  current process id) but this can be changed using
       the ----lloogg--ffiillee option.  Similarly, the  default  profiling
       output  filename is _m_p_a_t_r_o_l_._%_n_._o_u_t and the default tracing
       output filename is _m_p_a_t_r_o_l_._%_n_._t_r_a_c_e.

OOPPTTIIOONNSS
       All of the following options  (except  ----ddyynnaammiicc,  ----hheellpp,
       ----rreeaadd--eennvv,  ----sshhooww--eennvv,  ----tthhrreeaaddss  and ----vveerrssiioonn) corre-
       spond to their listed mpatrol library option.  See lliibbmmppaa--
       ttrrooll(3) for more details on these options.

       ----aalllloocc--bbyyttee <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--aa]
              [AALLLLOOCCBBYYTTEE]   Specifies  an 8-bit byte pattern with
              which to prefill newly-allocated memory.

       ----aalllloocc--ssttoopp <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--AA]
              [AALLLLOOCCSSTTOOPP]  Specifies an allocation index at which
              to stop the program when it is being allocated.

       ----aallllooww--ooffllooww [--MM]
              [AALLLLOOWWOOFFLLOOWW]   Specifies that a warning rather than
              an error should be produced if any memory operation
              function overflows the boundaries of a memory allo-
              cation, and that the operation should still be per-
              formed.

       ----aauuttoo--ssaavvee <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--ss]
              [AAUUTTOOSSAAVVEE]   Specifies  the  frequency  at which to
              periodically write the profiling data to  the  pro-
              filing output file.

       ----cchheecckk <_u_n_s_i_g_n_e_d _r_a_n_g_e> [--cc]
              [CCHHEECCKK]  Specifies a range of allocation indices at
              which to check the integrity  of  free  memory  and
              overflow buffers.

       ----cchheecckk--aallll [--CC]
              [CCHHEECCKKAALLLL]    Equivalent   to  the  ----cchheecckk--aallllooccss,
              ----cchheecckk--rreeaallllooccss, ----cchheecckk--ffrreeeess and  ----cchheecckk--mmeemmoorryy
              options specified together.

       ----cchheecckk--aallllooccss
              [CCHHEECCKKAALLLLOOCCSS]   Checks  that  no attempt is made to
              allocate a block of memory of size zero.

       ----cchheecckk--ffoorrkk
              [CCHHEECCKKFFOORRKK]  Checks at every call  to  see  if  the
              process  has been forked in case new log, profiling
              and tracing output files need to be started.

       ----cchheecckk--ffrreeeess
              [CCHHEECCKKFFRREEEESS]  Checks that no  attempt  is  made  to
              deallocate a NNUULLLL pointer.

       ----cchheecckk--mmeemmoorryy
              [CCHHEECCKKMMEEMMOORRYY]   Checks  that  no attempt is made to
              perform a zero-length memory operation  on  a  NNUULLLL
              pointer.

       ----cchheecckk--rreeaallllooccss
              [CCHHEECCKKRREEAALLLLOOCCSS]   Checks that no attempt is made to
              reallocate a NNUULLLL pointer  or  resize  an  existing
              block of memory to size zero.

       ----ddeeff--aalliiggnn <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--DD]
              [DDEEFFAALLIIGGNN]   Specifies  the  default  alignment for
              general-purpose memory allocations, which must be a
              power of two.

       ----ddyynnaammiicc [--dd]
              Specifies  that programs which were not linked with
              the mpatrol library should also be traced, but only
              if  they were dynamically linked.  This option will
              only work if the  system  dynamic  linker  has  the
              ability  to  preload a set of user-specified shared
              libraries via a special environment variable.

       ----eeddiitt [--ee]
              [EEDDIITT]  Specifies that  a  text  editor  should  be
              invoked  to edit any relevant source files that are
              associated with any warnings or  errors  when  they
              occur.

       ----ffaaiill--ffrreeqq <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--qq]
              [FFAAIILLFFRREEQQ]   Specifies  the  frequency at which all
              memory allocations will randomly fail.

       ----ffaaiill--sseeeedd <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--QQ]
              [FFAAIILLSSEEEEDD]  Specifies the random number seed  which
              will  be used when determining which memory alloca-
              tions will randomly fail.

       ----ffrreeee--bbyyttee <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--ff]
              [FFRREEEEBBYYTTEE]  Specifies an 8-bit  byte  pattern  with
              which to prefill newly-freed memory.

       ----ffrreeee--ssttoopp <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--FF]
              [FFRREEEESSTTOOPP]   Specifies an allocation index at which
              to stop the program when it is being freed.

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

       ----llaarrggee--bboouunndd <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
              [LLAARRGGEEBBOOUUNNDD]  Specifies the limit in  bytes  up  to
              which  memory  allocations  should be classified as
              large allocations for profiling purposes.

       ----lleeaakk--ttaabbllee
              [LLEEAAKKTTAABBLLEE] Specifies that the leak table should be
              automatically  used and a leak table summary should
              be displayed at the end of program execution.

       ----lliimmiitt <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--uu]
              [LLIIMMIITT]  Specifies the limit in bytes at which  all
              memory  allocations  should fail if the total allo-
              cated memory should increase beyond this.

       ----lliisstt [--ii]
              [LLIISSTT]  Specifies that a context listing should  be
              shown  for any relevant source files that are asso-
              ciated with any warnings or errors when they occur.

       ----lloogg--aallll [--LL]
              [LLOOGGAALLLL]     Equivalent    to   the   ----lloogg--aallllooccss,
              ----lloogg--rreeaallllooccss,   ----lloogg--ffrreeeess   and    ----lloogg--mmeemmoorryy
              options specified together.

       ----lloogg--aallllooccss
              [LLOOGGAALLLLOOCCSS]   Specifies that all memory allocations
              are to be logged and sent to the log file.

       ----lloogg--ffiillee <_s_t_r_i_n_g> [--ll]
              [LLOOGGFFIILLEE]  Specifies an alternative file  in  which
              to  place all diagnostics from the mpatrol library.

       ----lloogg--ffrreeeess
              [LLOOGGFFRREEEESS]  Specifies that all memory deallocations
              are to be logged and sent to the log file.

       ----lloogg--mmeemmoorryy
              [LLOOGGMMEEMMOORRYY]   Specifies  that all memory operations
              are to be logged and sent to the log file.

       ----lloogg--rreeaallllooccss
              [LLOOGGRREEAALLLLOOCCSS]  Specifies that all memory  realloca-
              tions are to be logged and sent to the log file.

       ----mmeeddiiuumm--bboouunndd <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
              [MMEEDDIIUUMMBBOOUUNNDD]   Specifies  the limit in bytes up to
              which memory allocations should  be  classified  as
              medium allocations for profiling purposes.

       ----nnoo--ffrreeee <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--nn]
              [NNOOFFRREEEE]  Specifies that a number of recently-freed
              memory allocations should be prevented  from  being
              returned to the free memory pool.

       ----nnoo--pprrootteecctt [--NN]
              [NNOOPPRROOTTEECCTT]   Specifies  that the mpatrol library's
              internal data structures should not be  made  read-
              only after every memory allocation, reallocation or
              deallocation.

       ----ooffllooww--bbyyttee <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--oo]
              [OOFFLLOOWWBBYYTTEE]  Specifies an 8-bit byte  pattern  with
              which  to  fill  the overflow buffers of all memory
              allocations.

       ----ooffllooww--ssiizzee <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r> [--OO]
              [OOFFLLOOWWSSIIZZEE]  Specifies the size in bytes to use for
              all overflow buffers, which must be a power of two.

       ----ooffllooww--wwaattcchh [--ww]
              [OOFFLLOOWWWWAATTCCHH]   Specifies  that  watch  point  areas
              should  be  used  for  overflow buffers rather than
              filling with the overflow byte.