usr/src/man/man3malloc/mapmalloc.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 MAPMALLOC 3MALLOC "Feb 20, 2004"
   7 .SH NAME
   8 mapmalloc \- memory allocator
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lmapmalloc\fR [ \fIlibrary\fR ... ]
  13 #include <stdlib.h>
  14
  15 \fBvoid *\fR\fBmalloc\fR(\fBsize_t\fR \fIsize\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBvoid *\fR\fBcalloc\fR(\fBsize_t\fR \fInelem\fR, \fBsize_t\fR \fIelsize\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBfree\fR(\fBvoid *\fR \fIptr\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 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The collection of \fBmalloc\fR functions in this library use  \fBmmap\fR(2)
  37 instead of \fBsbrk\fR(2) for acquiring new heap space.  The functions in this
  38 library are  intended to be used only if necessary, when applications must call
  39 \fBsbrk()\fR, but need to call other library routines that might call
  40 \fBmalloc\fR. The algorithms used by these functions are not sophisticated.
  41 There is no reclaiming of memory.
  42 .sp
  43 .LP
  44 The \fBmalloc()\fR and \fBfree()\fR functions provide a simple general-purpose
  45 memory allocation package.
  46 .sp
  47 .LP
  48 The \fBmalloc()\fR function returns a pointer to a block of at least \fIsize\fR
  49 bytes suitably aligned for any use.
  50 .sp
  51 .LP
  52 The argument to \fBfree()\fR is a pointer to a block previously allocated by
  53 \fBmalloc()\fR, \fBcalloc()\fR or \fBrealloc()\fR. If  \fIptr\fR is a
  54 \fINULL\fR pointer, no action occurs.
  55 .sp
  56 .LP
  57 Undefined results will occur if the space assigned by \fBmalloc()\fR is overrun
  58 or if some random number is handed to \fBfree()\fR.
  59 .sp
  60 .LP
  61 The \fBcalloc()\fR function allocates space for an array of \fInelem\fR
  62 elements of size \fIelsize\fR. The space is initialized to zeros.
  63 .sp
  64 .LP
  65 The \fBrealloc()\fR function changes the size of the block pointed to by
  66 \fIptr\fR to \fIsize\fR bytes and returns a pointer to the (possibly moved)
  67 block. The contents will be unchanged up to the lesser of the new and old
  68 sizes. If the new size of the block requires movement of the block, the space
  69 for the previous instantiation of the block is freed. If the new size is
  70 larger, the contents of the newly allocated portion of the block are
  71 unspecified. If \fIptr\fR is \fINULL\fR, \fBrealloc()\fR behaves like
  72 \fBmalloc()\fR for the specified size. If \fIsize\fR is 0 and \fIptr\fR is not
  73 a null pointer, the space pointed to is freed.
  74 .sp
  75 .LP
  76 Each of the allocation functions returns a pointer to space suitably aligned
  77 (after possible pointer coercion) for storage of any type of object.
  78 .sp
  79 .LP
  80 The \fBmalloc()\fR and \fBrealloc()\fR functions will fail if there is not
  81 enough available memory.
  82 .sp
  83 .LP
  84 Entry points for \fBmalloc_debug()\fR, \fBmallocmap()\fR, \fBmallopt()\fR,
  85 \fBmallinfo()\fR, \fBmemalign()\fR, and \fBvalloc()\fR are empty routines, and
  86 are provided only to protect the user from mixing \fBmalloc()\fR functions from
  87 different implementations.
  88 .SH RETURN VALUES
  89 .sp
  90 .LP
  91 If there is no available memory, \fBmalloc()\fR, \fBrealloc()\fR, and
  92 \fBcalloc()\fR return a null pointer. When \fBrealloc()\fR returns \fINULL\fR,
  93 the block pointed to by \fIptr\fR is left intact. If \fIsize\fR, \fInelem\fR,
  94 or \fIelsize\fR is 0, a unique pointer to the arena is returned.
  95 .SH ATTRIBUTES
  96 .sp
  97 .LP
  98 See \fBattributes\fR(5) for descriptions of the following attributes:
  99 .sp
 100
 101 .sp
 102 .TS
 103 box;
 104 c | c
 105 l | l .
 106 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 107 _
 108 MT-Level        Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBbrk\fR(2), \fBgetrlimit\fR(2), \fBmmap\fR(2), \fBrealloc\fR(3C),
 115 \fBmalloc\fR(3MALLOC), \fBattributes\fR(5)