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

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 2005, 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 MALLOC 3MALLOC "May 11, 2005"
   7 .SH NAME
   8 malloc, free, memalign, realloc, valloc, calloc, mallopt, mallinfo \- memory
   9 allocator
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lmalloc\fR [ \fIlibrary\fR ... ]
  14 #include <stdlib.h>
  15
  16 \fBvoid *\fR\fBmalloc\fR(\fBsize_t\fR \fIsize\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBfree\fR(\fBvoid *\fR\fIptr\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBvoid *\fR\fBmemalign\fR(\fBsize_t\fR \fIalignment\fR, \fBsize_t\fR \fIsize\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBvoid *\fR\fBrealloc\fR(\fBvoid *\fR\fIptr\fR, \fBsize_t\fR \fIsize\fR);
  32 .fi
  33
  34 .LP
  35 .nf
  36 \fBvoid *\fR\fBvalloc\fR(\fBsize_t\fR \fIsize\fR);
  37 .fi
  38
  39 .LP
  40 .nf
  41 \fBvoid *\fR\fBcalloc\fR(\fBsize_t\fR \fInelem\fR, \fBsize_t\fR \fIelsize\fR);
  42 .fi
  43
  44 .LP
  45 .nf
  46 #include <malloc.h>
  47
  48 \fBint\fR \fBmallopt\fR(\fBint\fR \fIcmd\fR, \fBint\fR \fIvalue\fR);
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBstruct mallinfo\fR \fBmallinfo\fR(\fBvoid\fR);
  54 .fi
  55
  56 .SH DESCRIPTION
  57 .sp
  58 .LP
  59 The \fBmalloc()\fR and \fBfree()\fR functions provide a simple general-purpose
  60 memory allocation package.
  61 .sp
  62 .LP
  63 The \fBmalloc()\fR function returns a pointer to a block of at least \fIsize\fR
  64 bytes suitably aligned for any use.
  65 .sp
  66 .LP
  67 The argument to \fBfree()\fR is a pointer to a block previously allocated by
  68 \fBmalloc()\fR. After \fBfree()\fR is performed, this space is made available
  69 for further allocation, and its contents have been destroyed. See
  70 \fBmallopt()\fR below for a way to change this behavior. If \fIptr\fR is a null
  71 pointer, no action occurs.
  72 .sp
  73 .LP
  74 Undefined results occur if the space assigned by \fBmalloc()\fR is overrun or
  75 if some random number is handed to \fBfree()\fR.
  76 .sp
  77 .LP
  78 The \fBfree()\fR function does not set \fBerrno\fR.
  79 .sp
  80 .LP
  81 The \fBmemalign()\fR function allocates \fIsize\fR bytes on a specified
  82 alignment boundary and returns a pointer to the allocated block. The value of
  83 the returned address is guaranteed to be an even multiple of \fIalignment\fR.
  84 The value of \fIalignment\fR must be a power of two and must be greater than or
  85 equal to the size of a word.
  86 .sp
  87 .LP
  88 The \fBrealloc()\fR function changes the size of the block pointed to by
  89 \fIptr\fR to \fIsize\fR bytes and returns a pointer to the (possibly moved)
  90 block. The contents will be unchanged up to the lesser of the new and old
  91 sizes. If the new size of the block requires movement of the block, the space
  92 for the previous instantiation of the block is freed. If the new size is
  93 larger, the contents of the newly allocated portion of the block are
  94 unspecified. If \fIptr\fR is \fINULL\fR, \fBrealloc()\fR behaves like
  95 \fBmalloc()\fR for the specified size. If \fIsize\fR is 0 and \fIptr\fR is not
  96 a null pointer, the space pointed to is freed.
  97 .sp
  98 .LP
  99 The \fBvalloc()\fR function has the same effect as \fBmalloc()\fR, except that
 100 the allocated memory will be aligned to a multiple of the value returned by
 101 \fBsysconf\fR(\fB_SC_PAGESIZE\fR).
 102 .sp
 103 .LP
 104 The \fBcalloc()\fR function allocates space for an array of \fInelem\fR
 105 elements of size \fIelsize\fR. The space is initialized to zeros.
 106 .sp
 107 .LP
 108 The \fBmallopt()\fR function provides for control over the allocation
 109 algorithm. The available values for \fIcmd\fR are:
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBM_MXFAST\fR\fR
 114 .ad
 115 .RS 12n
 116 Set \fImaxfast\fR to  \fIvalue\fR. The algorithm allocates all blocks below the
 117 size of \fImaxfast\fR in large groups and then doles them out very quickly. The
 118 default value for \fImaxfast\fR is 24.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBM_NLBLKS\fR\fR
 125 .ad
 126 .RS 12n
 127 Set \fInumlblks\fR to \fIvalue\fR. The above mentioned ``large groups'' each
 128 contain \fInumlblks\fR blocks.   \fInumlblks\fR must be greater than 0. The
 129 default value for \fInumlblks\fR is 100.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBM_GRAIN\fR\fR
 136 .ad
 137 .RS 12n
 138 Set \fIgrain\fR to  \fIvalue\fR. The sizes of all blocks smaller than
 139 \fImaxfast\fR are considered to be rounded up to the nearest multiple of
 140 \fIgrain\fR. \fIgrain\fR must be greater than 0. The default value of
 141 \fIgrain\fR is the smallest number of bytes that will allow alignment of any
 142 data type. Value will be rounded up to a multiple of the default when
 143 \fIgrain\fR is set.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBM_KEEP\fR\fR
 150 .ad
 151 .RS 12n
 152 Preserve data in a freed block until the next \fBmalloc()\fR, \fBrealloc()\fR,
 153 or \fBcalloc()\fR. This option is provided only for compatibility with the old
 154 version of \fBmalloc()\fR, and it is not recommended.
 155 .RE
 156
 157 .sp
 158 .LP
 159 These values are defined in the \fB<malloc.h>\fR header.
 160 .sp
 161 .LP
 162 The \fBmallopt()\fR function can be called repeatedly, but cannot be called
 163 after the first small block is allocated.
 164 .sp
 165 .LP
 166 The \fBmallinfo()\fR function provides instrumentation describing space usage.
 167 It returns the \fBmallinfo\fR structure with the following members:
 168 .sp
 169 .in +2
 170 .nf
 171 unsigned long arena;      /* total space in arena */
 172 unsigned long ordblks;    /* number of ordinary blocks */
 173 unsigned long smblks;     /* number of small blocks */
 174 unsigned long hblkhd;     /* space in holding block headers */
 175 unsigned long hblks;      /* number of holding blocks */
 176 unsigned long usmblks;    /* space in small blocks in use */
 177 unsigned long fsmblks;    /* space in free small blocks */
 178 unsigned long uordblks;   /* space in ordinary blocks in use */
 179 unsigned long fordblks;   /* space in free ordinary blocks */
 180 unsigned long keepcost;   /* space penalty if keep option */
 181                           /* is used */
 182 .fi
 183 .in -2
 184
 185 .sp
 186 .LP
 187 The \fBmallinfo\fR structure is defined in the <\fBmalloc.h\fR> header.
 188 .sp
 189 .LP
 190 Each of the allocation routines returns a pointer to space suitably aligned
 191 (after possible pointer coercion) for storage of any type of object.
 192 .SH RETURN VALUES
 193 .sp
 194 .LP
 195 The \fBmalloc()\fR, \fBmemalign()\fR, \fBrealloc()\fR, \fBvalloc()\fR, and
 196 \fBcalloc()\fR functions return a null pointer if there is not enough available
 197 memory. When \fBrealloc()\fR returns \fINULL\fR, the block pointed to by
 198 \fIptr\fR is left intact. If \fIsize\fR, \fInelem\fR, or \fIelsize\fR is 0,
 199 either a null pointer or a unique pointer that can be passed to \fBfree()\fR is
 200 returned. If \fBmallopt()\fR is called after any allocation or if \fIcmd\fR or
 201 \fIvalue\fR are invalid, a non-zero value is returned. Otherwise, it returns 0.
 202 .SH ERRORS
 203 .sp
 204 .LP
 205 If \fBmalloc()\fR, \fBcalloc()\fR, or \fBrealloc()\fR returns  unsuccessfully,
 206 \fBerrno\fR is set to indicate the error:
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fBENOMEM\fR\fR
 211 .ad
 212 .RS 10n
 213 \fIsize\fR bytes of memory exceeds the physical limits of your system, and
 214 cannot be allocated.
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fB\fBEAGAIN\fR\fR
 221 .ad
 222 .RS 10n
 223 There is not enough memory available at this point in time to allocate
 224 \fIsize\fR bytes of memory; but the application could try again later.
 225 .RE
 226
 227 .SH USAGE
 228 .sp
 229 .LP
 230 Unlike \fBmalloc\fR(3C), this package does not preserve the contents of a block
 231 when it is freed, unless  the \fBM_KEEP\fR option of \fBmallopt()\fR is used.
 232 .sp
 233 .LP
 234 Undocumented features of  \fBmalloc\fR(3C) have not been duplicated.
 235 .sp
 236 .LP
 237 Function prototypes for \fBmalloc()\fR, \fBrealloc()\fR, \fBcalloc()\fR, and
 238 \fBfree()\fR are also defined in the <\fBmalloc.h\fR> header for compatibility
 239 with old applications. New applications  should include <\fBstdlib.h\fR> to
 240 access the prototypes for these functions.
 241 .sp
 242 .LP
 243 Comparative features of the various allocation libraries can be found in the
 244 \fBumem_alloc\fR(3MALLOC) manual page.
 245 .SH ATTRIBUTES
 246 .sp
 247 .LP
 248 See \fBattributes\fR(5) for descriptions of the following attributes:
 249 .sp
 250
 251 .sp
 252 .TS
 253 box;
 254 c | c
 255 l | l .
 256 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 257 _
 258 MT-Level        Safe
 259 .TE
 260
 261 .SH SEE ALSO
 262 .sp
 263 .LP
 264 \fBbrk\fR(2), \fBbsdmalloc\fR(3MALLOC), \fBlibmtmalloc\fR(3LIB),
 265 \fBmalloc\fR(3C), \fBmapmalloc\fR(3MALLOC), \fBmtmalloc\fR(3MALLOC),
 266 \fBumem_alloc\fR(3MALLOC), \fBwatchmalloc\fR(3MALLOC), \fBattributes\fR(5)