1REMAP_FILE_PAGES(2)        Linux Programmer's Manual       REMAP_FILE_PAGES(2)
2
3
4

NAME

6       remap_file_pages - create a nonlinear file mapping
7

SYNOPSIS

9       #define _GNU_SOURCE
10       #include <sys/mman.h>
11
12       int remap_file_pages(void *addr, size_t size, int prot,
13                            ssize_t pgoff, int flags);
14

DESCRIPTION

16       The  remap_file_pages()  system call is used to create a nonlinear map‐
17       ping, that is, a mapping in which the pages of the file are mapped into
18       a   nonsequential   order   in   memory.    The   advantage   of  using
19       remap_file_pages() over using repeated calls to  mmap(2)  is  that  the
20       former  approach  does  not require the kernel to create additional VMA
21       (Virtual Memory Area) data structures.
22
23       To create a nonlinear mapping we perform the following steps:
24
25       1. Use mmap(2) to create a mapping (which is initially  linear).   This
26          mapping must be created with the MAP_SHARED flag.
27
28       2. Use  one or more calls to remap_file_pages() to rearrange the corre‐
29          spondence between the pages of the mapping  and  the  pages  of  the
30          file.   It  is possible to map the same page of a file into multiple
31          locations within the mapped region.
32
33       The pgoff and size arguments specify the region of the file that is  to
34       be relocated within the mapping: pgoff is a file offset in units of the
35       system page size; size is the length of the region in bytes.
36
37       The addr argument serves two purposes.  First, it identifies  the  map‐
38       ping  whose  pages we want to rearrange.  Thus, addr must be an address
39       that falls within a region previously mapped  by  a  call  to  mmap(2).
40       Second,  addr  specifies the address at which the file pages identified
41       by pgoff and size will be placed.
42
43       The values specified in addr and size should be multiples of the system
44       page size.  If they are not, then the kernel rounds both values down to
45       the nearest multiple of the page size.
46
47       The prot argument must be specified as 0.
48
49       The flags argument has the same meaning as for mmap(2), but  all  flags
50       other than MAP_NONBLOCK are ignored.
51

RETURN VALUE

53       On  success,  remap_file_pages()  returns 0.  On error, -1 is returned,
54       and errno is set appropriately.
55

ERRORS

57       EINVAL addr does  not  refer  to  a  valid  mapping  created  with  the
58              MAP_SHARED flag.
59
60       EINVAL addr, size, prot, or pgoff is invalid.
61

VERSIONS

63       The remap_file_pages() system call appeared in Linux 2.5.46; glibc sup‐
64       port was added in version 2.3.3.
65

CONFORMING TO

67       The remap_file_pages() system call is Linux-specific.
68

SEE ALSO

70       getpagesize(2), mmap(2), mmap2(2),  mprotect(2),  mremap(2),  msync(2),
71       feature_test_macros(7)
72

COLOPHON

74       This  page  is  part of release 3.25 of the Linux man-pages project.  A
75       description of the project, and information about reporting  bugs,  can
76       be found at http://www.kernel.org/doc/man-pages/.
77
78
79
80Linux                             2008-04-22               REMAP_FILE_PAGES(2)
Impressum