SYS_MMAN.H(7) Miscellaneous Information Manual SYS_MMAN.H(7)

sys/mman.h — memory management declarations

#include <sys/mman.h>

The <sys/mman.h> header shall define the following symbolic constants for use as protection options:

Page can be executed.
Page cannot be accessed.
Page can be read.
Page can be written.

The <sys/mman.h> header shall define the following symbolic constants for use as flag options:

Interpret addr exactly.
Changes are private.
Share changes.

The <sys/mman.h> header shall define the following symbolic constants for the msync(3) function:

Perform asynchronous writes.
Invalidate mappings.
Perform synchronous writes.

The <sys/mman.h> header shall define the following symbolic constants for the mlockall(3) function:

Lock currently mapped pages.
Lock pages that become mapped.

The <sys/mman.h> header shall define the symbolic constant MAP_FAILED which shall have type and shall be used to indicate a failure from the mmap(3) function .

If the Advisory Information option is supported, the <sys/mman.h> header shall define symbolic constants for the argument to the posix_madvise(3) function as follows:

The application expects that it will not access the specified range in the near future.
The application has no advice to give on its behavior with respect to the specified range. It is the default characteristic if no advice is given for a range of memory.
The application expects to access the specified range in a random order.
The application expects to access the specified range sequentially from lower addresses to higher addresses.
The application expects to access the specified range in the near future.

[TYM] The <sys/mman.h> header shall define the following symbolic constants for use as flags for the posix_typed_mem_open(3) function:

Allocate on mmap () .
Allocate contiguously on mmap () .
Map on mmap () , without affecting allocatability.

The <sys/mman.h> header shall define the , , and types as described in <sys/types.h>.

[TYM] The <sys/mman.h> header shall define the structure, which shall include at least the following member:

size_t  posix_tmi_length  Maximum length which may be allocated
                          from a typed memory object.

The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.

[MLR]
int    mlock(const void *, size_t);

[ML]
int    mlockall(int);

void  *mmap(void *, size_t, int, int, int, off_t);
int    mprotect(void *, size_t, int);
[XSI|SIO]
int    msync(void *, size_t, int);

[MLR]
int    munlock(const void *, size_t);

[ML]
int    munlockall(void);

int    munmap(void *, size_t);
[ADV]
int    posix_madvise(void *, size_t, int);

[TYM]
int    posix_mem_offset(const void *restrict, size_t, off_t *restrict,
           size_t *restrict, int *restrict);
int    posix_typed_mem_get_info(int, struct posix_typed_mem_info *);
int    posix_typed_mem_open(const char *, int, int);

[SHM]
int    shm_open(const char *, int, mode_t);
int    shm_unlink(const char *);

None.

None.

None.

<sys/types.h>

XSH mlock(3), mlockall(3), mmap(3), mprotect(3), msync(3), munmap(3), posix_madvise(3), posix_mem_offset(3), posix_typed_mem_get_info(3), posix_typed_mem_open(3), shm_open(3), shm_unlink(3)

First released in Issue 4, Version 2.

Updated for alignment with the POSIX Realtime Extension.

The <sys/mman.h> header is marked as dependent on support for either the Memory Mapped Files, Process Memory Locking, or Shared Memory Objects options.

The following changes are made for alignment with IEEE Std 1003.1j-2000:

The keyword is added to the prototype for posix_mem_offset(3).

IEEE PASC Interpretation 1003.1 #102 is applied, adding the prototype for posix_madvise(3).

IEEE Std 1003.1-2001 (“POSIX.1”)/Cor 1-2002, item XBD/TC1/D6/16 is applied, correcting margin code and shading errors for the mlock(3) and munlock(3) functions.

IEEE Std 1003.1-2001 (“POSIX.1”)/Cor 1-2002, item XSH/TC1/D6/34 is applied, changing the margin code for the mmap(3) function from MF|SHM to MC3 (notation for MF|SHM|TYM).

IEEE Std 1003.1-2001 (“POSIX.1”)/Cor 1-2002, item XSH/TC1/D6/36 is applied, changing the margin code for the munmap(3) function from MF|SHM to MC3 (notation for MF|SHM|TYM).

SD5-XBD-ERN-5 is applied, rewriting the DESCRIPTION.

Functionality relating to the Memory Protection and Memory Mapped Files options is moved to the Base.

This reference page is clarified with respect to macros and symbolic constants.

January 31, 2018 posix.fail