gdb - Local mods (compile)
[dragonfly.git] / lib / libc / stdlib / memory.3
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 .\" $FreeBSD: src/lib/libc/stdlib/memory.3,v 1.12 2007/01/09 00:28:10 imp Exp $
30 .\" $DragonFly: src/lib/libc/stdlib/memory.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
31 .\"
32 .Dd June 4, 1993
33 .Dt MEMORY 3
34 .Os
35 .Sh NAME
36 .Nm malloc ,
37 .Nm free ,
38 .Nm realloc ,
39 .Nm calloc ,
40 .Nm alloca ,
41 .Nm mmap
42 .Nd general memory allocation operations
43 .Sh LIBRARY
44 .Lb libc
45 .Sh SYNOPSIS
46 .In stdlib.h
47 .Ft void *
48 .Fn malloc "size_t size"
49 .Ft void
50 .Fn free "void *ptr"
51 .Ft void *
52 .Fn realloc "void *ptr" "size_t size"
53 .Ft void *
54 .Fn calloc "size_t nelem" "size_t elsize"
55 .Ft void *
56 .Fn alloca "size_t size"
57 .In sys/types.h
58 .In sys/mman.h
59 .Ft void *
60 .Fn mmap "void * addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
61 .Sh DESCRIPTION
62 These functions allocate and free memory for the calling process.
63 They are described in the
64 individual manual pages.
65 .Sh SEE ALSO
66 .Xr mmap 2 ,
67 .Xr alloca 3 ,
68 .Xr calloc 3 ,
69 .Xr free 3 ,
70 .Xr malloc 3 ,
71 .Xr realloc 3
72 .Sh STANDARDS
73 These functions, with the exception of
74 .Fn alloca
75 and
76 .Fn mmap
77 conform to
78 .St -isoC .