xref: /illumos-gate/usr/src/man/man3head/mman.h.3head (revision 3299f39fdcbdab4be7a9c70daa3873f2b78a398d)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

MMAN.H 3HEAD "Feb 5, 2008"
NAME
mman.h, mman - memory management declarations
SYNOPSIS

#include <sys/mman.h>
DESCRIPTION

The <sys/mman.h> header supports the following options:

the Memory Mapped Files option

the Shared Memory Objects option

the Process Memory Locking option

the Memory Protection option

the Synchronized Input and Output option

For Memory Mapped Files and Shared Memory Objects options, the following protection options are defined: PROT_READ

Page can be read.

PROT_WRITE

Page can be written.

PROT_EXEC

Page can be executed.

PROT_NONE

Page cannot be accessed.

The following flag options are defined: MAP_SHARED

Share changes.

MAP_PRIVATE

Changes are private.

MAP_FIXED

Interpret addr exactly.

The flags immediately following are defined for msync(). See msync(3C). MS_ASYNC

Perform asynchronous writes.

MS_SYNC

Perform synchronous writes.

MS_INVALIDATE

Invalidate mappings.

The symbolic constants immediately following are defined for the mlockall() function. See mlockall(3C). MCL_CURRENT

Lock currently mapped pages.

MCL_FUTURE

Lock pages that become mapped.

The symbolic constant MAP_FAILED is defined to indicate a failure from the mmap() function. See mmap(2).

The mode_t, off_t, and size_t types are be defined as described in <sys/types.h>. See types(3HEAD).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
Standard See standards(5).
SEE ALSO

mmap(2), mprotect(2), munmap(2), madvise(3C), mlock(3C), mlockall(3C), msync(3C), shm_open(3C), shm_unlink(3C), attributes(5), standards(5)