usr/src/man/man3malloc/mtmalloc.3malloc

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2004, 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 MTMALLOC 3MALLOC "Mar 21, 2005"
   7 .SH NAME
   8 mtmalloc, mallocctl \- MT hot memory allocator
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <mtmalloc.h>
  13 cc -o a.out -lthread -lmtmalloc
  14
  15 \fBvoid *\fR\fBmalloc\fR(\fBsize_t\fR \fIsize\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBvoid\fR \fBfree\fR(\fBvoid *\fR\fIptr\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid *\fR\fBmemalign\fR(\fBsize_t\fR \fIalignment\fR, \fBsize_t\fR \fIsize\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBvoid *\fR\fBrealloc\fR(\fBvoid *\fR\fIptr\fR, \fBsize_t\fR \fIsize\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBvoid *\fR\fBvalloc\fR(\fBsize_t\fR \fIsize\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBvoid\fR \fBmallocctl\fR(\fBint\fR \fIcmd\fR, \fBlong\fR \fIvalue\fR);
  41 .fi
  42
  43 .SH DESCRIPTION
  44 .sp
  45 .LP
  46 The \fBmalloc()\fR and \fBfree()\fR functions provide a simple general-purpose
  47 memory allocation package that is suitable for use in high performance
  48 multithreaded applications. The suggested use of this library is in
  49 multithreaded applications;  it can be used for single threaded applications,
  50 but there is no  advantage in doing so. This library cannot be dynamically
  51 loaded with \fBdlopen\fR(3C) during runtime because there must be only one
  52 manager of the process heap.
  53 .sp
  54 .LP
  55 The \fBmalloc()\fR function returns a pointer to a block of at least \fIsize\fR
  56 bytes suitably aligned for any use.
  57 .sp
  58 .LP
  59 The argument to \fBfree()\fR is a pointer to a block previously allocated by
  60 \fBmalloc()\fR or \fBrealloc()\fR. After \fBfree()\fR is performed this space
  61 is available for further allocation. If  \fIptr\fR is a null pointer, no action
  62 occurs. The \fBfree()\fR function does not set \fBerrno\fR.
  63 .sp
  64 .LP
  65 Undefined results will occur if the space assigned by \fBmalloc()\fR is overrun
  66 or if a random number is handed to \fBfree()\fR. A freed pointer that is passed
  67 to \fBfree()\fR will send a  \fBSIGABRT\fR signal to the calling process. This
  68 behavior is controlled by \fBmallocctl()\fR.
  69 .sp
  70 .LP
  71 The \fBmemalign()\fR function allocates \fIsize\fR bytes on a specified
  72 alignment boundary and returns a pointer to the allocated block. The value of
  73 the returned address is guaranteed to be an even multiple of \fIalignment\fR.
  74 Note that the value of \fIalignment\fR must be a power of two, and must be
  75 greater than or equal to the size of a word.
  76 .sp
  77 .LP
  78 The \fBrealloc()\fR function changes the size of the block pointed to by
  79 \fIptr\fR to \fIsize\fR bytes and returns a pointer to the (possibly moved)
  80 block. The contents will be unchanged up to the lesser of the new and old
  81 sizes. If the new size of the block requires movement of the block, the space
  82 for the previous instantiation of the block is freed. If the new size is
  83 larger, the contents of the newly allocated portion of the block are
  84 unspecified. If \fIptr\fR is \fINULL\fR, \fBrealloc()\fR behaves like
  85 \fBmalloc()\fR for the specified size. If \fIsize\fR is 0 and \fIptr\fR is not
  86 a null pointer, the space pointed to is freed.
  87 .sp
  88 .LP
  89 The \fBvalloc()\fR function has the same effect as \fBmalloc()\fR, except that
  90 the allocated memory will be aligned to a multiple of the value returned by
  91 \fBsysconf\fR(\fB_SC_PAGESIZE\fR).
  92 .sp
  93 .LP
  94 After possible pointer coercion, each allocation routine returns  a pointer to
  95 a space that is suitably aligned  for storage of any type of object.
  96 .sp
  97 .LP
  98 The \fBmalloc()\fR, \fBrealloc()\fR, \fBmemalign()\fR, and \fBvalloc()\fR
  99 functions will fail if there is not enough available memory.
 100 .sp
 101 .LP
 102 The \fBmallocctl()\fR function controls the behavior of the \fBmalloc\fR
 103 library. The options fall into two general classes, debugging options and
 104 performance options.
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBMTDOUBLEFREE\fR\fR
 109 .ad
 110 .RS 18n
 111 Allows double  \fBfree\fR of a pointer.   Setting \fIvalue\fR to \fB1\fR means
 112 yes and \fB0\fR means no. The default behavior of double \fBfree\fR results in
 113 a core dump.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBMTDEBUGPATTERN\fR\fR
 120 .ad
 121 .RS 18n
 122 Writes misaligned data into the buffer after \fBfree()\fR. When the buffer is
 123 reallocated, the contents are verified to ensure that there was no access to
 124 the buffer after the \fBfree\fR. If the buffer has been dirtied, a
 125 \fBSIGABRT\fR signal is delivered to the process. Setting  \fIvalue\fR to
 126 \fB1\fR means yes and \fB0\fR means no. The default behavior is to  \fInot\fR
 127 write misaligned data.  The pattern used  is \fB0xdeadbeef\fR. Use of this
 128 option results in a performance penalty.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBMTINITBUFFER\fR\fR
 135 .ad
 136 .RS 18n
 137 Writes misaligned data into the newly allocated buffer. This option is useful
 138 for detecting some accesses before initialization. Setting \fIvalue\fR to
 139 \fB1\fR means yes and \fB0\fR means no. The default behavior is to \fInot\fR
 140 write misaligned data to the newly allocated buffer. The pattern used is
 141 \fB0xbaddcafe\fR. Use of this option results in a performance penalty.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBMTCHUNKSIZE\fR\fR
 148 .ad
 149 .RS 18n
 150 This option changes the size of allocated memory when a pool has exhausted all
 151 available memory in the buffer. Increasing this  value allocates more memory
 152 for the application.  A substantial  performance gain can occur because the
 153 library makes fewer calls  to the OS for more memory. Acceptable number
 154 \fIvalue\fRs are between \fB9\fR and \fB256\fR. The default value is  \fB9\fR.
 155 This value is multiplied by 8192.
 156 .RE
 157
 158 .SH RETURN VALUES
 159 .sp
 160 .LP
 161 If there is no available memory, \fBmalloc()\fR, \fBrealloc()\fR,
 162 \fBmemalign()\fR, and \fBvalloc()\fR return a null pointer. When
 163 \fBrealloc()\fR is called with \fIsize\fR > 0 and returns \fINULL\fR, the block
 164 pointed to by \fIptr\fR is left intact. If \fIsize\fR, \fInelem\fR, or
 165 \fIelsize\fR is 0, either a null pointer or a unique pointer that can be passed
 166 to \fBfree()\fR is returned.
 167 .sp
 168 .LP
 169 If \fBmalloc()\fR or \fBrealloc()\fR returns unsuccessfully, \fBerrno\fR will
 170 be set to indicate the error.
 171 .SH ERRORS
 172 .sp
 173 .LP
 174 The \fBmalloc()\fR and \fBrealloc()\fR functions will fail if:
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBENOMEM\fR\fR
 179 .ad
 180 .RS 10n
 181 The physical limits of the system are exceeded by \fIsize\fR bytes of memory
 182 which cannot be allocated.
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fBEAGAIN\fR\fR
 189 .ad
 190 .RS 10n
 191 There is not enough memory available to allocate \fIsize\fR bytes of memory;
 192 but the application could try again later.
 193 .RE
 194
 195 .SH USAGE
 196 .sp
 197 .LP
 198 Comparative features of the various allocation libraries can be found in the
 199 \fBumem_alloc\fR(3MALLOC) manual page.
 200 .SH ATTRIBUTES
 201 .sp
 202 .LP
 203 See \fBattributes\fR(5) for descriptions of the following attributes:
 204 .sp
 205
 206 .sp
 207 .TS
 208 box;
 209 c | c
 210 l | l .
 211 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 212 _
 213 MT-Level        Safe
 214 .TE
 215
 216 .SH SEE ALSO
 217 .sp
 218 .LP
 219 \fBbrk\fR(2), \fBgetrlimit\fR(2), \fBbsdmalloc\fR(3MALLOC), \fBdlopen\fR(3C),
 220 \fBmalloc\fR(3C), \fBmalloc\fR(3MALLOC), \fBmapmalloc\fR(3MALLOC),
 221 \fBsignal.h\fR(3HEAD), \fBumem_alloc\fR(3MALLOC), \fBwatchmalloc\fR(3MALLOC),
 222 \fBattributes\fR(5)
 223 .SH WARNINGS
 224 .sp
 225 .LP
 226 Undefined results will occur if the size requested for a block of memory
 227 exceeds the maximum size of a process's heap. This information may be obtained
 228 using  \fBgetrlimit()\fR.