duma: Detect Unintended Memory Access (D.U.M.A.) - A Red-Zone memory allocator https://github.com/johnsonjh/duma
Jeffrey H. Johnson fdeac42d63 Merge pull request #227 from johnsonjh/renovate/actions-checkout-digest | hace 1 mes | |
---|---|---|
.devbots | hace 4 años | |
.github | hace 1 mes | |
Attic | hace 3 años | |
confdir | hace 3 años | |
debian | hace 2 años | |
doc | hace 3 años | |
dumadll | hace 11 meses | |
examples | hace 3 años | |
prj | hace 3 años | |
src | hace 11 meses | |
stacktrace | hace 3 años | |
tests | hace 6 meses | |
win32-devcpp | hace 3 años | |
win32-msvc | hace 3 años | |
win32-msvc.2005 | hace 3 años | |
win32-msvc.net | hace 3 años | |
win32-vide | hace 3 años | |
.deepsource.toml | hace 3 años | |
.gitattributes | hace 3 años | |
.gitignore | hace 3 años | |
.gitlab-ci.yml | hace 4 años | |
.mergify.yml | hace 4 años | |
.whitesource | hace 4 años | |
CHANGELOG.md | hace 3 años | |
CMakeLists.txt | hace 3 años | |
COPYING-GPL | hace 21 años | |
COPYING-LGPL | hace 4 años | |
GNUmakefile | hace 3 años | |
LICENSE | hace 4 años | |
README.md | hace 6 meses | |
SECURITY.md | hace 3 años | |
createconf.c | hace 2 años | |
createconf_new.cpp | hace 3 años | |
duma.3 | hace 6 meses | |
duma.h | hace 11 meses | |
duma.sh | hace 4 años | |
duma.sh.in | hace 3 años | |
duma_hlp.h | hace 3 años | |
duma_sem.h | hace 3 años | |
dumapp.h | hace 3 años | |
gdbinit.rc | hace 17 años | |
make_git_source_version.sh | hace 1 año | |
noduma.h | hace 11 meses | |
paging.h | hace 3 años | |
print.h | hace 4 años | |
renovate.json | hace 4 años | |
uninstall.cmake | hace 3 años |
A Red-Zone memory allocator
DUMA helps you detect two of the most common programming errors:
malloc()
memory allocation,free()
.Unlike other malloc()
debuggers, DUMA will detect read accesses as well as
writes, and it will pinpoint the exact instruction that causes an error.
Electric Fence, the predecessor of DUMA, has been in use at Pixar since 1987, and at many other sites for years.
DUMA uses the virtual memory hardware of your computer to place an
inaccessible memory page immediately after (or before, at the user's option)
each memory allocation. When software reads or writes this inaccessible page,
the hardware issues a segmentation fault, stopping the program at the offending
instruction. It is then trivial to find the erroneous statement using your
favorite debugger. In a similar manner, memory that has been released by
free()
is made inaccessible, and any code that touches it will get a
segmentation fault.
Simply linking your application with libduma.a
will allow you to detect most,
but not all, malloc()
buffer overruns and accesses of free memory. If you want
to be reasonably sure that you've found all catch-able bugs of this type, you'll
have to read and understand the rest of the documentation.
Besides catching these kind of memory bugs, DUMA also provides a means to
detect memory leaks. When using DUMA to pinpoint the source of a
memory-leak, some source modification is necessary - at the minimum, adding
#include "duma.h"
to your source.
DUMA may be installed from compiled binary packages or built from source code.
[TODO: Binary packages]
Packages available for installation via the distribution's package manager:\
The latest release version of DUMA is available to download from GitHub and other mirrors.
You can use the Git distributed version control tool to download the latest release version, the current development version, or the entire history, from any of several source code repositories.
DUMA may be built using GNU Make.
GNU Make is available for many operating systems, including SunOS / Solaris, GNU/Hurd, AIX, HP-UX, BSD, GNU/Linux, and Microsoft Windows (using Cygwin or UWIN for POSIX compatibility, or natively with the MSYS / MINGW environment.)
GNU Make is often installed as gmake
, but may be installed under
a different name, such as mingw32-make
, mingw64-gmake
, or simply make
(especially on GNU systems such as Linux).
Some non-GNU "Make" systems may work, but are untested and not recommended for building DUMA.
build
directory
mkdir build && cd build
GNUmakefile
for configuration, compilation,
and installation options
OS
and OSTYPE
options
(necessary if automated detection is unsuccessful)gmake -f ../GNUmakefile srcdir=../
(for automatic OS detection and defaults; assumes gmake is GNU Make)make -f ../GNUmakefile srcdir=../ OSTYPE=cygwin
(for Microsoft Windows with Cygwin)mingw32-make -f ../GNUmakefile srcdir=../ OSTYPE=msys
(for Microsoft Windows with MSYS / MINGW via Command Prompt (CMD))make -f ../GNUmakefile srcdir=../ OS=linux
(for most GNU/Linux systems)gmake -f ../GNUmakefile check
gmake -f ../GNUmakefile install DESTDIR=/opt/duma
DESTDIR
or prefix
gmake -f ../GNUmakefile installcheck
CMake is a portable suite of tools to automate the configuration, building, testing, packaging, and installation of software.
DUMA may be built using CMake 3.1 (December 2014) or later.
build
directory
mkdir build && cd build
ccmake ..
orccmake-gui ..
cmake ..
cmake -DCMAKE_BUILD_TYPE="Debug" ..
cmake -DCMAKE_BUILD_TYPE="Release" ..
cmake -DCMAKE_INSTALL_PREFIX="/opt/duma" ..
cmake -DCMAKE_TOOLCHAIN_FILE=/opt/gcc/toolchain_gcc-8.cmake ..
cmake -G "Visual Studio 16 2019" -A "x64" ..
cmake --build .
ctest
(add -V
or -VV
for more verbose output)cmake --build . --target "install"
CMAKE_INSTALL_PREFIX
createconf
duma_config.h
header file generated by createconf
dumalib
INCLUDE
and LIBS
variables, as required
for your environmentDUMA should work out of the box on most systems, however, specific environments may require additional configuration or warrant special consideration.
Both SPARC and Intel processors are supported.
DUMA is tested on Solaris using the GNU toolchain (GNU CC, G++, ld, binutils, etc.)
Older Solaris systems, such as Solaris 10, using the GNU tools from
the Companion CD should add /opt/sfw/bin
and /opt/sfw/lib/bin
to
the PATH
.
Newer Solaris systems, such as Solaris 11.next or OpenIndiana, require similar configuration.
The Solaris Studio toolchain has not been tested.
FreeBSD
DUMA_DISABLE_BANNER=1
before running any program linked with DUMA.NetBSD
On NetBSD 3.1 (HOSTTYPE=i386
/ OSTYPE=netbsdelf
), one (1
)
memory leak is always detected.
Installation on NetBSD is untested.
DUMA_MEMCPY_OVERLAP
variable, which allows overlapping of memcpy()
regions when the destination address is less than the source address.DUMA_ALIGNMENT
environment variable to eight (8
) bytes.On systems using RISC-V processors, the base instruction set uses only
fixed-length 32-bit instructions that must be aligned on four (4
) byte
(32-bit) boundaries.
However, the standard RISC-V encoding scheme supports compressed
and variable-length instructions. These instructions can be any
number of 16-bit "instruction parcels" in length, and are always
aligned on two (2
) byte (16-bit) boundaries.
The RISC-V processor will not fault when accessing an invalid (unaligned)
address. Instead, it will simply use the next valid address. The DUMA_ALIGNMENT
environment variable should be set to a value greater than one (1
)
on systems using RISC-V processors.
Link your program with the library libduma.a
. Make sure you are not linking
with -lmalloc
, -lmallocdebug
, or with other malloc()
debugger or
enhancer libraries. You can only use one at a time.
If your system administrator has installed DUMA for public use, you'll be
able to use the -lduma
argument to the linker, otherwise you'll have to put
the path-name for libduma.a
in the linker's command line.
If you're using a Bourne-style shell on
most UNIX systems, the statement export LD_PRELOAD=libduma.so
will cause
DUMA to be loaded to run all dynamic executables.
For Darwin-based
systems such as macOS X, use export DYLD_INSERT_LIBRARIES=libduma.dylib
and export DYLD_FORCE_FLAT_NAMESPACE=1
.
The included helper command duma <command>
will run a single command
under DUMA.
For more details, review the documentation for the dynamic linking facility provided by your operating system vendor.
Some systems will require special arguments to the linker to assure that you
are using the DUMA malloc()
and not the one from your C library.
Run your program using a debugger. It's easier to work this way than to create a core file and post-mortem debug it. DUMA can create huge core files, and some operating systems will thus take minutes simply to dump core! Some operating systems will not create usable core files from programs that are linked with DUMA.
If your program has one of the errors detected by DUMA, it will get a
segmentation fault (SIGSEGV
) at the offending instruction. Use the debugger
to locate the erroneous statement, and repair it.
DUMA has several configuration switches that can be enabled via the shell environment. These switches change what bugs DUMA will detect, so it's important that you know how to use them.
You can use the gdb
command 'set environment variable value'
to set shell
environment variables only for the program you are going to debug. This is
useful especially if you are using the shared DUMA library.
DUMA_ALIGNMENT
- This is an integer that specifies the alignment for any
memory allocations that will be returned by malloc(), calloc(), and realloc().
The value is specified in bytes, thus a value of 4 will cause memory to be
aligned to 32-bit boundaries unless your system doesn't have a 8-bit
characters. DUMA_ALIGNMENT
is set to the minimum required alignment specific
to your environment by default. The minimum required alignment is detected by
createconf
and stored in the file duma_config.h
.
If your program requires that allocations be aligned to 64-bit boundaries
you'll have to set this value to 8. This is the case when compiling with the
-mips2
flag on MIPS-based systems such as those from SGI. For some
architectures the default is defined to even more - x86‑64 uses alignment to
16 bytes by default.
DUMA internally uses a smaller value if the requested memory size is smaller than the alignment value: the next smaller power of 2 is used.
Thus allocating blocks smaller than DUMA_ALIGNMENT
may result into smaller
alignments - for example when allocating 3 bytes, they would be aligned to 2
byte boundary. This allows better detection of overrun.
For this reason, you will sometimes want to set DUMA_ALIGNMENT
to 1
(no
alignment), so that you can detect overruns of less than your CPU's word size.
Be sure to read the section 'Word-Alignment and Overrun Detection' in this
manual page before you try this.
To change this value, set DUMA_ALIGNMENT
in the shell environment to an
integer value, or call the macro function DUMA_SET_ALIGNMENT()
from your
code.
You don't need to change this setting, if you just need bigger alignment for
some special buffers. In this case you may use the function
memalign(alignment, userSize)
.
DUMA_PROTECT_BELOW
- DUMA usually places an inaccessible page
immediately after each memory allocation, so that software that runs past the
end of the allocation will be detected. Setting DUMA_PROTECT_BELOW
to 1
causes DUMA to place the inaccessible page before the allocation in the
address space, so that under-runs will be detected instead of over-runs.To change this value, set DUMA_PROTECT_BELOW
in the shell environment to an
integer value, or call the macro function DUMA_SET_PROTECT_BELOW()
from your
code.
DUMA_SKIPCOUNT_INIT
- DUMA usually does its initialization with the
first memory allocation. On some systems this may collide with initialization
of pthreads or other libraries and produce a hang. To get DUMA work even in
these situations you can control (with this environment variable) after how
many allocations the full internal initialization of DUMA is done. Default
is 0
.
DUMA_REPORT_ALL_LEAKS
- DUMA usually reports only memory leaks where the
source file-name with line number of the allocating instruction is known.
Setting this variable to 1
in shell environment reports all memory leaks.
The default is 0
to avoid reporting of irrelevant memory leaks from
system/compiler environment: there are many standard libraries leaking memory,
which by default is no real problem as the system frees up all memory on
program exit.
DUMA_FILL
- When set to a value between 0
and 255
, every byte of
allocated memory is initialized to that value. This can help detect reads of
uninitialized memory. When set to -1
, DUMA does not initialize memory on
allocation, so some memory may filled with zeroes (the operating system
default on most systems) and some memory will retain the values written to it
during its last use.
Per default, DUMA will initialize all allocated bytes to 255
(0xFF
).
To change this value, set DUMA_FILL
in the shell environment to an integer
value, or call the macro function DUMA_SET_FILL()
from your code.
DUMA_SLACKFILL
- As DUMA internally allocates memory in whole pages,
there retains an unused and unprotectable piece of memory: the slack or
no-mans-land. Per default DUMA will initialize this area to 170
(0xAA
), which is 10101010
in binary representation.To change this value, set DUMA_SLACKFILL
in the shell environment to an
integer value.
DUMA automatically checks this area, the no-mans-land, at deallocation.
You can manually induce a check with the macro function DUMA_CHECK()
for one
memory block. With the macro function DUMA_CHECKALL()
all memory blocks get
checked.
DUMA_CHECK_FREQ
- First see DUMA_SLACKFILL
above for definition of
no-mans-land. Checking the integrity of theno-mans-land costs
performance. This is why this is usually done only at deallocation of a memory
block. Set this variable to let DUMA check all memory blocks
no-mans-land every *value*th allocation or deallocation. Set this variable
to 1, to let DUMA check at each allocation and deallocation.Per default the value 0
is used, which means to check only at deallocation.
DUMA_ALLOW_MALLOC_0
- Memory allocation of size zero is ANSI conforming,
but, often this is the result of a software bug. For this reason DUMA may
trap such calls to malloc() with size zero. I leave this option disabled by
default, but you are free to trap these calls setting the
DUMA_ALLOC_MALLOC_0
in the shell environment to an integer value.
DUMA_MALLOC_0_STRATEGY
- This environment variable controls DUMA's
behavior on malloc(0)
:
0
- abort program with segfault (previously ALLOW_MALLOC_0 = 0
)1
- return NULL pointer2
- return always the same pointer to some protected page3
- return mid address of a unique protected page (default)ATTENTION: Only 1
and 3
are ANSI conforming. But value 1
will break most programs, and value 3
strategy most system libraries
use/implement. All returned pointers can be passed to free()
.
DUMA_NEW_0_STRATEGY
- This environment variable controls DUMA's
behavior on C++ operator new with size zero:
2
- return always the same pointer to some protected page3
- return mid address of a unique protected page (default)ATTENTION: Only 3
is standard conforming. Value 2
may break
some, but will work for most programs. With value 2
you may reduce the
memory consumption.
DUMA_MALLOC_FAILEXIT
- Many programs do not check for allocation failure.
This often leads to delayed errors, no more understandable. Set this variable
to a positive integer in the shell environment to exit the program immediately
when memory allocation fails. This option is set by default.
DUMA_PROTECT_FREE
- DUMA usually returns free memory to a pool from
which it may be re-allocated. If you suspect that a program may be touching
free memory, set DUMA_PROTECT_FREE
shell environment to -1
. This is the
default and will cause DUMA not to re-allocate any memory.
For programs with many allocations and de-allocations this may lead to the
consumption of the full address space and thus to the failure of malloc()
.
It is important to discriminate between address space and physical memory;
DUMA does free the physical memory; but the address space is not
freed. Thus, the address space may be exhausted despite available physical
memory. This is especially important on 32-bit systems. To avoid such
failures, you may limit the amount of protected de-allocated memory by setting
DUMA_PROTECT_FREE
to a positive value. This value in kB will be the
limit for such protected free memory.
A value of 0
will disable protection of freed memory.
DUMA_MAX_ALLOC
- This shell environment variable limits the total memory
print of a program. This is another way to indirectly limit the sum of freed
protected memory (see DUMA_PROTECT_FREE
). By default there is no limit
(-1
). A positive value is interpreted in kB, which stands for the sum of
allocated and freed protected memory.
DUMA_FREE_ACCESS
- This is a debugging enhancer to catch deallocation of a
memory block using watch expressions. DUMA does a write access to the
first byte, which may lead a debugger to stop on a watch expression. You have
to enable this by setting the shell environment variable to non zero. Default
is disabled.
DUMA_SHOW_ALLOC
- Set this shell environment variable to non-zero to let
DUMA print all allocations and de-allocations to the console. Although this
generates a lot of messages, this option can be useful to detect inefficient
code containing many (de)allocations. This is switched off by default.
DUMA_SUPPRESS_ATEXIT
- Set this shell environment variable to non-zero when
DUMA should skip the installation of its exit handler. The exit handler is
called at the end of the main program and checks for memory leaks, so the
handler's installation should usually not be suppressed. One reason for
doing so regardless are some buggy environments, where calls to the standard C
library's atexit()
-function hangs.
DUMA_DISABLE_BANNER
- Set this shell environment variable to non-zero to
suppress the usual start-up message on console. Default is 0
.
DUMA_OUTPUT_DEBUG
- Set this shell environment variable to non-zero to
output all DUMA messages to the debugging console. This option is only
available on Windows and is off by default.
DUMA_OUTPUT_STDOUT
- Set this shell environment variable to non-zero to
output all DUMA messages to STDOUT. This option is off by default.
DUMA_OUTPUT_STDERR
- Set this shell environment variable to non-zero to
output all DUMA messages to STDERR. This option is on by default.
DUMA_OUTPUT_FILE
- Set this shell environment variable to a file-name where
all DUMA messages should be written to. This option is off by default.
DUMA_OUTPUT_STACKTRACE
- Set this shell environment variable to non-zero to
output a stacktrace of the allocation that is not freed. This option is
available only on Windows and is off by default. This option also requires a
map file generated by the linker.
DUMA_OUTPUT_STACKTRACE_MAPFILE
- Set this shell environment variable to the
map file, when it isn't found. This is very useful when using detours version
of DUMA. This option is available only on Windows.
DUMA_MEMCPY_OVERLAP
- Set this shell environment variable to allow
overlapping of memcpy regions if the destination address is less than source
address. (workaround for ARM memmove
/memcpy
implementation).
There is a conflict between the alignment restrictions that malloc()
operates
under and the debugging strategy used by DUMA. When detecting overruns,
DUMA malloc()
allocates two or more virtual memory pages for each
allocation. The last page is made inaccessible in such a way that any read,
write, or execute access will cause a segmentation fault. Then, DUMA
malloc()
will return an address such that the first byte after the end of the
allocation is on the inaccessible page. Thus, any overrun of the allocation will
cause a segmentation fault.
It follows that the address returned by malloc()
is the address of the
inaccessible page minus the size of the memory allocation. Unfortunately,
malloc()
is required to return word-aligned allocations, since many CPUs can
only access a word when its address is aligned. The conflict happens when
software makes a memory allocation using a size that is not a multiple of the
word size, and expects to do word accesses to that allocation. The location of
the inaccessible page is fixed by hardware at a word-aligned address. If
DUMA malloc()
is to return an aligned address, it must increase the size
of the allocation to a multiple of the word size.
In addition, the functions memalign()
and valloc()
must honor explicit
specifications on the alignment of the memory allocation, and this, as well can
only be implemented by increasing the size of the allocation. Thus, there will
be situations in which the end of a memory allocation contains some padding
space, and accesses of that padding space will not be detected, even if they are
overruns.
DUMA provides the variable DUMA_ALIGNMENT
so that the user can control the
default alignment used by malloc()
, calloc()
, and realloc()
. To debug
overruns as small as a single byte, you can set DUMA_ALIGNMENT
to 1
. This
will result in DUMA malloc()
returning unaligned addresses for allocations
with sizes that are not a multiple of the word size. This is not a problem in
most cases, because compilers must pad the size of objects so that alignment
restrictions are honored when storing those objects in arrays. The problem
surfaces when software allocates odd-sized buffers for objects that must be
word-aligned. One case of this is software that allocates a buffer to contain
a structure and a string, and the string has an odd size (this example was in a
popular TIFF library).
If word references are made to un-aligned buffers, you will see a bus error
(SIGBUS
) instead of a segmentation fault. The only way to fix this is to
re-write the offending code to make byte references or not make odd-sized
allocations, or to set DUMA_ALIGNMENT
to the word size.
Another example of software incompatible with DUMA_ALIGNMENT
set less than
the system word-size is the strcmp()
function and other string functions
on SunOS 4, which make word-sized accesses to character strings, and may
attempt to access up to three bytes beyond the end of a string. These
result in a segmentation fault (SIGSEGV
). The only way around this is to use
versions of the string functions that perform byte references instead of
word references.
Using DUMA - and one of the following strategies - you can determine the offending line(s) of your source code responsible for causing an error.
gdb <program>
'set environment DUMA_PROTECT_BELOW 1'
'set args …'
ulimit -c unlimited
to get core filesduma.sh <your_program>
core[.<pid>]
file, which you can examine (i.e. gdb <program> -c <core file>
)libduma.a
as explained above, ensuring proper linking order.DUMA_PROTECT_BELOW = 1
in the shell environment.gdbinit.rc
as ~/.gdbinit
if you are using
the gdb
debuggerDUMA_ALIGNMENT
to 1
, and repeat step 2.
Since DUMA uses at least two virtual memory pages for each of its
allocations, it's a terrible memory hog. It may be necessary to configure a
swap file so the system will have enough virtual memory available. Also, the
way DUMA manipulates memory results in various cache and translation
buffer entries being flushed with each call to malloc()
or free()
. The end
result is that your program will execute slower and use more resources while
you are debugging it with DUMA.
/proc/sys/vm/max_map_count
. You may have to increase this value to allow
debugging with DUMA with a command such as:
sysctl -w vm.max_map_count=1000000
Don't leave libduma.a
enabled and linked in production software. Use it
only for debugging. See the section 'Compilation Notes for
Release / Production' below.
All memory allocation is protocol-ed from DUMA together with the file-name
and line number of the calling function. The atexit()
function checks if each
allocated memory block was freed. To disable leak detection add the
preprocessor definition DUMA_SO_NO_LEAKDETECTION
or
DUMA_LIB_NO_LEAKDETECTION
to DUMA_OPTIONS
in the Makefile.
void * duma_alloc_return( void * address)
, for example, using the
gdb command 'break duma_alloc_return if address==0x123'
Macros for "new
" and "delete
" are defined in dumapp.h
. These macros give
file-name and line number of the calling functions to DUMA, thus allowing
the same leak detection reports as for malloc()
and free()
. dumapp.h
needs to be
included from your source file(s).
new
, delete
, new[]
, and delete[]
operators, add
the preprocessor definition DUMA_NO_CPP_SUPPORT
to DUMA_OPTIONS
in
Makefile.Definition of own member new
/delete
operators for a class will fail
because the new
/delete
keywords are defined as macros from DUMA. You
will have to un-define DUMA's macros with following line:
#include "noduma.h"
Then you have to call DUMA's operators directly
inside your own definition.
For using DUMA's C++ operators without having the preprocessor macros defined, following syntax can be used:
// const char * file or __FILE__ macro
// int line or __LINE__ macro
// scalar new throwing bad_alloc() on error
ptr = new(file,line) type;
// scalar new returning 0 on error
ptr = new(std::nothrow,file,line) type;
// scalar delete
operator delete(ptr,file,line);
// vector new throwing bad_alloc() on error
ptr = new(file,line) type[n];
// vector new returning 0 on error
ptr = new(std::nothrow,file,line) type[n];
// vector delete
operator delete[](ptr, file,line);
Set the preprocessor definition #define DUMA_NO_DUMA
in your Makefiles to
disable DUMA usage - and don't link with DUMA library. With
DUMA_NO_DUMA
defined, all DUMA macro functions get defined, but do
nothing.
This software has NO WARRANTY.
Much effort has been expended to ensure the correctness of DUMA, however, it is (in all likelihood) not theoretically possible to make software of this nature bug-free.
DUMA may not report all bugs that exist in your code.
It may also incorrectly report bugs that do not exist.
Segmentation Fault: Examine the offending statement for violation of the boundaries of a memory allocation.
Bus Error: See the section on 'Word-Alignment and Overrun Detection' in this manual.
Explanation of alignment issues could be improved.
Some Sun systems running SunOS 4.1 were reported to signal an
access to a protected page with SIGBUS
rather than SIGSEGV
. This is
most likely an undocumented "feature" of particular Sun hardware
versions, and not an operating system anomaly.
Makefile
is modified to define PAGE_PROTECTION_VIOLATED_SIGNAL
as SIGBUS
.NOTE: All source repositories are mirrors with identical contents.
Copyright © 2020‑2022 Jeffrey H. Johnson <trnsz@pobox.com>
Copyright © 2006 Michael Eddington <meddington@gmail.com>
Copyright © 2002‑2021 Hayati Ayguen <h_ayguen@web.de>, Procitec GmbH
Copyright © 1987‑1999 Bruce Perens <bruce@perens.com>