Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

munmap(2) [mojave man page]

MUNMAP(2)						      BSD System Calls Manual							 MUNMAP(2)

NAME
munmap -- remove a mapping SYNOPSIS
#include <sys/mman.h> int munmap(void *addr, size_t len); DESCRIPTION
The munmap() system call deletes the mappings for the specified address range, causing further references to addresses within the range to generate invalid memory references. DIRTY PAGE HANDLING
How munmap() handles a dirty page, depends on what type of memory is being unmapped: [Anonymous] If the memory is anonymous memory and if the last reference is going away, then the contents are discarded by definition of anonymous memory. [System V Shared] If the memory mapping was created using System V shared memory, then the contents persist until the System V memory region is destroyed or the system is rebooted. [File mapping] If the mapping maps data from a file (MAP_SHARED), then the memory will eventually be written back to disk if it's dirty. This will happen automatically at some point in the future (implementation dependent). Note: to force the memory to be written back to the disk, use msync(2). If there are still other references to the memory when the munmap is done, then nothing is done to the memory itself and it may be swapped out if need be. The memory will continue to persist until the last reference goes away (except for System V shared memory in which case, see above). RETURN VALUES
Upon successful completion, munmap returns zero. Otherwise, a value of -1 is returned and errno is set to indicate the error. ERRORS
munmap() will fail if: [EINVAL] The addr parameter was not page aligned (i.e., a multiple of the page size). [EINVAL] The len parameter was negative or zero. [EINVAL] Some part of the region being unmapped is not part of the currently valid address space. LEGACY SYNOPSIS
#include <sys/types.h> #include <sys/mman.h> The include file <sys/types.h> is necessary. int munmap(caddr_t addr, size_t len); The type of addr has changed. SEE ALSO
getpagesize(3), msync(2), munmap(2), mprotect(2), madvise(2), mincore(2), compat(5) HISTORY
The munmap() function first appeared in 4.4BSD. BSD
October 16, 2008 BSD

Check Out this Related Man Page

MADVISE(2)						      BSD System Calls Manual							MADVISE(2)

NAME
madvise, posix_madvise -- give advice about use of memory SYNOPSIS
#include <sys/mman.h> int madvise(void *addr, size_t len, int advice); int posix_madvise(void *addr, size_t len, int advice); DESCRIPTION
The madvise() system call allows a process that has knowledge of its memory behavior to describe it to the system. The advice passed in may be used by the system to alter its virtual memory paging strategy. This advice may improve application and system performance. The behavior specified in advice can only be one of the following values: MADV_NORMAL Indicates that the application has no advice to give on its behavior in the specified address range. This is the system default behavior. This is used with madvise() system call. POSIX_MADV_NORMAL Same as MADV_NORMAL but used with posix_madvise() system call. MADV_SEQUENTIAL Indicates that the application expects to access this address range in a sequential manner. This is used with madvise() system call. POSIX_MADV_SEQUENTIAL Same as MADV_SEQUENTIAL but used with posix_madvise() system call. MADV_RANDOM Indicates that the application expects to access this address range in a random manner. This is used with madvise() system call. POSIX_MADV_RANDOM Same as MADV_RANDOM but used with posix_madvise() system call. MADV_WILLNEED Indicates that the application expects to access this address range soon. This is used with madvise() system call. POSIX_MADV_WILLNEED Same as MADV_WILLNEED but used with posix_madvise() system call. MADV_DONTNEED Indicates that the application is not expecting to access this address range soon. This is used with madvise() system call. POSIX_MADV_DONTNEED Same as MADV_DONTNEED but used with posix_madvise() system call. MADV_FREE Indicates that the application will not need the information contained in this address range, so the pages may be reused right away. The address range will remain valid. This is used with madvise() system call. MADV_ZERO_WIRED_PAGES Indicates that the application would like the wired pages in this address range to be zeroed out if the address range is deallocated without first unwiring the pages (i.e. a munmap(2) without a preceding munlock(2) or the application quits). This is used with madvise() system call. The posix_madvise() behaves same as madvise() except that it uses values with POSIX_ prefix for the advice system call argument. RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise, a value of -1 is returned and errno is set to indicate the error. ERRORS
madvise() fails if one or more of the following are true: [EINVAL] The value of advice is incorrect. [EINVAL] The address range includes unallocated regions. [ENOMEM] The virtual address range specified by the addr and len are outside the range allowed for the address space. LEGACY SYNOPSIS
#include <sys/types.h> #include <sys/mman.h> int madvise(caddr_t addr, size_t len, int advice); int posix_madvise(caddr_t addr, size_t len, int advice); The include file <sys/types.h> is necessary. The type of addr has changed. SEE ALSO
mincore(2), minherit(2), mprotect(2), msync(2), munmap(2), compat(5) HISTORY
The madvise function first appeared in 4.4BSD. The posix_madvise function is part of IEEE 1003.1-2001 and was first implemented in Mac OS X 10.2. BSD
June 9, 1993 BSD
Man Page