xref: /freebsd/lib/libc/stdlib/memory.3 (revision edf8578117e8844e02c0121147f45e4609b30680)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)memory.3	8.1 (Berkeley) 6/4/93
29.\"
30.Dd June 4, 1993
31.Dt MEMORY 3
32.Os
33.Sh NAME
34.Nm malloc ,
35.Nm free ,
36.Nm realloc ,
37.Nm calloc ,
38.Nm alloca ,
39.Nm mmap
40.Nd general memory allocation operations
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In stdlib.h
45.Ft void *
46.Fn malloc "size_t size"
47.Ft void
48.Fn free "void *ptr"
49.Ft void *
50.Fn realloc "void *ptr" "size_t size"
51.Ft void *
52.Fn calloc "size_t nelem" "size_t elsize"
53.Ft void *
54.Fn alloca "size_t size"
55.In sys/types.h
56.In sys/mman.h
57.Ft void *
58.Fn mmap "void * addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
59.Sh DESCRIPTION
60These functions allocate and free memory for the calling process.
61They are described in the
62individual manual pages.
63.Sh SEE ALSO
64.Xr mmap 2 ,
65.Xr alloca 3 ,
66.Xr calloc 3 ,
67.Xr free 3 ,
68.Xr malloc 3 ,
69.Xr realloc 3
70.Sh STANDARDS
71These functions, with the exception of
72.Fn alloca
73and
74.Fn mmap
75conform to
76.St -isoC .
77