share/man/man9/memguard.9

   1 .\" Copyright (c) 2005 Christian Brueffer
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 31, 2006
  28 .Dt MEMGUARD 9
  29 .Os
  30 .Sh NAME
  31 .Nm MemGuard
  32 .Nd "memory allocator for debugging purposes"
  33 .Sh SYNOPSIS
  34 .Cd "options DEBUG_MEMGUARD"
  35 .Sh DESCRIPTION
  36 .Nm
  37 is a simple and small replacement memory allocator designed
  38 to help detect tamper-after-free scenarios.
  39 These problems are more and more common and likely with
  40 multithreaded kernels where race conditions are more prevalent.
  41 .Pp
  42 Currently,
  43 .Nm
  44 can only take over
  45 .Fn malloc ,
  46 .Fn realloc
  47 and
  48 .Fn free
  49 for a particular malloc type.
  50 .Sh EXAMPLES
  51 To use memguard for memory type compiled into the kernel, one has to add the
  52 following line to the
  53 .Pa /boot/loader.conf :
  54 .Bd -literal -offset indent
  55 vm.memguard.desc=<memory_type>
  56 .Ed
  57 .Pp
  58 Where memory_type is a short description of memory type to monitor.
  59 .Pp
  60 To use memguard for memory type defined in a kernel module, one has to set
  61 .Va vm.memguard.desc
  62 .Xr sysctl 8
  63 variable before loading the module:
  64 .Bd -literal -offset indent
  65 sysctl vm.memguard.desc=<memory_type>
  66 .Ed
  67 .Pp
  68 The
  69 .Va vm.memguard.divisor
  70 boot-time tunable is used to scale how much of
  71 .Va kmem_map
  72 one wants to allocate for
  73 .Nm .
  74 The default is 10, so
  75 .Va kmem_size Ns /10
  76 bytes will be used.
  77 The
  78 .Va kmem_size
  79 value can be obtained via the
  80 .Va vm.kmem_size
  81 .Xr sysctl 8
  82 variable.
  83 .Sh SEE ALSO
  84 .Xr sysctl 8 ,
  85 .Xr vmstat 8 ,
  86 .Xr contigmalloc 9 ,
  87 .Xr malloc 9 ,
  88 .Xr redzone 9
  89 .Sh HISTORY
  90 .Nm
  91 first appeared in
  92 .Fx 6.0 .
  93 .Sh AUTHORS
  94 .An -nosplit
  95 .Nm
  96 was written by
  97 .An Bosko Milekic Aq bmilekic@FreeBSD.org .
  98 This manual page was written by
  99 .An Christian Brueffer Aq brueffer@FreeBSD.org .
 100 .Sh BUGS
 101 Currently, it is not possible to override UMA
 102 .Xr zone 9
 103 allocations.