xref: /freebsd/lib/libc/stdlib/memory.3 (revision 6e1fc0118033f42b7c0d3623c8f67a89ebecabb2)

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd October 18, 2023
.Dt MEMORY 3
.Os
.Sh NAME
.Nm aligned_alloc ,
.Nm alloca ,
.Nm calloc ,
.Nm free ,
.Nm malloc ,
.Nm posix_memalign ,
.Nm realloc ,
.Nm reallocf ,
.Nm valloc ,
.Nm mmap ,
.Nm munmap
.Nd memory management functions
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft void *
.Fn aligned_alloc "size_t alignment" "size_t size"
.Ft void *
.Fn alloca "size_t size"
.Ft void *
.Fn calloc "size_t nelem" "size_t elsize"
.Ft void
.Fn free "void *ptr"
.Ft void *
.Fn malloc "size_t size"
.Ft int
.Fn posix_memalign "void **ptr" "size_t alignment" "size_t size"
.Ft void *
.Fn realloc "void *ptr" "size_t size"
.Ft void *
.Fn reallocf "void *ptr" "size_t size"
.Ft void *
.Fn valloc "size_t size"
.In sys/types.h
.In sys/mman.h
.Ft void *
.Fn mmap "void * addr" "size_t len" "int prot" "int flags" "int fd" "off_t offset"
.Ft int
.Fn munmap "void *addr" "size_t len"
.Sh DESCRIPTION
These functions allocate and free memory for the calling process.
They are described in the
individual manual pages.
.Sh SEE ALSO
.Xr mmap 2 ,
.Xr aligned_alloc 3 ,
.Xr alloca 3 ,
.Xr calloc 3 ,
.Xr free 3 ,
.Xr malloc 3 ,
.Xr posix_memalign 3 ,
.Xr realloc 3 ,
.Xr reallocf 3 ,
.Xr valloc 3
.Sh STANDARDS
The
.Fn calloc ,
.Fn free ,
.Fn malloc ,
and
.Fn realloc
functions conform to
.St -isoC .
.Pp
The
.Fn mmap ,
.Fn munmap ,
and
.Fn posix_memalign
functions conform to
.St -p1003.1-2001 .