share/man/man3malloc/umem_debug.3malloc

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH UMEM_DEBUG 3MALLOC "Jul 26, 2002"
   7 .SH NAME
   8 umem_debug \- debugging features of the umem library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lumem\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <\fBumem.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBlibumem\fR library provides debugging features that detect memory leaks,
  20 buffer overruns, multiple frees, use of uninitialized data, use of freed data,
  21 and many other common programming errors. The activation of the run-time
  22 debugging features is controlled by environment variables.
  23 .sp
  24 .LP
  25 When the library detects an error, it writes a description of the error to an
  26 internal buffer that is readable with the \fB::umem_status\fR \fBmdb\fR(1)
  27 \fIdcmd\fR and then calls \fBabort\fR(3C).
  28 .SH ENVIRONMENT VARIABLES
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBUMEM_DEBUG\fR\fR
  33 .ad
  34 .RS 16n
  35 This variable contains a list of comma-separated options.  Unrecognized options
  36 are ignored. Possible options include:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBaudit\fR[=\fIframes\fR]\fR
  41 .ad
  42 .RS 20n
  43 This option enables the recording of auditing information, including thread ID,
  44 high-resolution time stamp, and stack trace for the last action (allocation or
  45 free) on every allocation.  If transaction logging (see \fBUMEM_LOGGING\fR) is
  46 enabled, this auditing information is also logged.
  47 .sp
  48 The \fIframes\fR parameter sets the number of stack frames recorded in the
  49 auditing structure. The upper bound for frames is implementation-defined. If a
  50 larger value is requested, the upper bound is used instead.
  51 .sp
  52 If \fIframes\fR is not specified or is not an integer, the default value of 15
  53 is used.
  54 .sp
  55 This option also enables the \fBguards\fR option.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBcontents\fR[=\fIcount\fR]\fR
  62 .ad
  63 .RS 20n
  64 If auditing and contents logging (see \fBUMEM_LOGGING\fR) are enabled, the
  65 first \fIcount\fR bytes of each buffer are logged when they are freed.  If a
  66 buffer is shorter than \fIcount\fR bytes, it is logged in its entirety.
  67 .sp
  68 If \fIcount\fR is not specified or is not an integer, the default value of 256
  69 is used.
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBdefault\fR\fR
  76 .ad
  77 .RS 20n
  78 This option is equivalent to \fBaudit\fR,\fBcontents\fR,\fBguards\fR.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBguards\fR\fR
  85 .ad
  86 .RS 20n
  87 This option enables filling allocated and freed buffers with special patterns
  88 to help detect the use of uninitialized data and previously freed buffers. It
  89 also enables an 8-byte redzone after each buffer that contains
  90 \fB0xfeedfacefeedfaceULL\fR.
  91 .sp
  92 When an object is freed, it is filled with \fB0xdeadbeef\fR.  When an object is
  93 allocated, the \fB0xdeadbeef\fR pattern is verified and replaced with
  94 \fB0xbaddcafe\fR.  The redzone is checked every time a buffer is allocated or
  95 freed.
  96 .sp
  97 For caches with either constructors or destructors, or both,
  98 \fBumem_cache_alloc\fR(3MALLOC) and \fBumem_cache_free\fR(3MALLOC) apply the
  99 cache's constructor and destructor, respectively, instead of caching
 100 constructed objects. The presence of \fBassert\fR(3C)s in the destructor
 101 verifying that the buffer is in the constructed state can be used to detect any
 102 objects returned in an improper state.  See \fBumem_cache_create\fR(3MALLOC)
 103 for details.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBverbose\fR\fR
 110 .ad
 111 .RS 20n
 112 The library writes error descriptions to standard error before aborting. These
 113 messages are not localized.
 114 .RE
 115
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBUMEM_LOGGING\fR\fR
 122 .ad
 123 .RS 16n
 124 To be enabled, this variable should be set to a comma-separated list of
 125 in-memory logs. The logs available are:
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBtransaction\fR[=\fIsize\fR]\fR
 130 .ad
 131 .RS 22n
 132 If the \fBaudit\fR debugging option is set (see \fBUMEM_DEBUG\fR), the audit
 133 structures from previous transactions are entered into this log.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBcontents\fR[=\fIsize\fR]\fR
 140 .ad
 141 .RS 22n
 142 If the \fBaudit\fR debugging option is set, the contents of objects are
 143 recorded in this log as they are freed.
 144 .sp
 145 If the "contents" debugging option was not set, 256 bytes of each freed buffer
 146 are saved.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fBfail\fR[=\fIsize\fR]\fR
 153 .ad
 154 .RS 22n
 155 Records are entered into this log for every failed allocation.
 156 .RE
 157
 158 For any of these options, if \fIsize\fR is not specified, the default value of
 159 64k is used.  The \fIsize\fR parameter must be an integer that can be qualified
 160 with K, M, G, or T to specify kilobytes, megabytes, gigabytes, or terabytes,
 161 respectively.
 162 .sp
 163 Logs that are not listed or that have either a size of 0 or an invalid size are
 164 disabled.
 165 .sp
 166 The log is disabled if during initialization the requested amount of storage
 167 cannot be allocated.
 168 .RE
 169
 170 .SH ATTRIBUTES
 171 .sp
 172 .LP
 173 See \fBattributes\fR(5) for descriptions of the following attributes:
 174 .sp
 175
 176 .sp
 177 .TS
 178 box;
 179 c | c
 180 l | l .
 181 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 182 _
 183 Interface Stability     Unstable
 184 _
 185 MT-Level        MT-Safe
 186 .TE
 187
 188 .SH SEE ALSO
 189 .sp
 190 .LP
 191 \fBmdb\fR(1), \fBabort\fR(3C), \fBsignal\fR(3C),
 192 \fBumem_cache_create\fR(3MALLOC), \fBattributes\fR(5)
 193 .sp
 194 .LP
 195 \fISolaris Modular Debugger Guide\fR
 196 .SH WARNINGS
 197 .sp
 198 .LP
 199 When \fBlibumem\fR aborts the process using \fBabort\fR(3C), any existing
 200 signal handler for \fBSIGABRT\fR is called. If the signal handler performs
 201 allocations, undefined behavior can result.
 202 .SH NOTES
 203 .sp
 204 .LP
 205 Some of the debugging features work only for allocations smaller than 16
 206 kilobytes in size. Allocations larger than 16 kilobytes could have reduced
 207 support.
 208 .sp
 209 .LP
 210 Activating any of the library's debugging features could significantly increase
 211 the library's memory footprint and decrease its performance.