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 37is a simple and small replacement memory allocator designed 38to help detect tamper-after-free scenarios. 39These problems are more and more common and likely with 40multithreaded kernels where race conditions are more prevalent. 41.Pp 42Currently, 43.Nm 44can only take over 45.Fn malloc , 46.Fn realloc 47and 48.Fn free 49for a particular malloc type. 50.Sh EXAMPLES 51To use memguard for memory type compiled into the kernel, one has to add the 52following line to the 53.Pa /boot/loader.conf : 54.Bd -literal -offset indent 55vm.memguard.desc=<memory_type> 56.Ed 57.Pp 58Where memory_type is a short description of memory type to monitor. 59The short description of memory type is the second argument to 60.Xr MALLOC_DEFINE 9 , 61so one has to find it in the kernel source. 62.Pp 63To use memguard for memory type defined in a kernel module, one has to set 64.Va vm.memguard.desc 65.Xr sysctl 8 66variable before loading the module: 67.Bd -literal -offset indent 68sysctl vm.memguard.desc=<memory_type> 69.Ed 70.Pp 71The 72.Va vm.memguard.divisor 73boot-time tunable is used to scale how much of 74.Va kmem_map 75one wants to allocate for 76.Nm . 77The default is 10, so 78.Va kmem_size Ns /10 79bytes will be used. 80The 81.Va kmem_size 82value can be obtained via the 83.Va vm.kmem_size 84.Xr sysctl 8 85variable. 86.Sh SEE ALSO 87.Xr sysctl 8 , 88.Xr vmstat 8 , 89.Xr contigmalloc 9 , 90.Xr malloc 9 , 91.Xr redzone 9 92.Sh HISTORY 93.Nm 94first appeared in 95.Fx 6.0 . 96.Sh AUTHORS 97.An -nosplit 98.Nm 99was written by 100.An Bosko Milekic Aq bmilekic@FreeBSD.org . 101This manual page was written by 102.An Christian Brueffer Aq brueffer@FreeBSD.org . 103.Sh BUGS 104Currently, it is not possible to override UMA 105.Xr zone 9 106allocations. 107