mmap(2) - Linux 手册页

名称

概要

#include <sys/mman.h>
void *mmap(void *addr, size_t lengthint " prot ", int " flags ,
           int fd, off_t offset);int munmap(void *addr, size_t length);

描述

如果 addr 为 NULL，则由内核选择创建映射的地址；这是创建新映射时最具可移植性的方法。如果 addr 不为 NULL，则内核将其视为关于映射放置位置的建议；在 Linux 上，映射将在附近的页面边界处创建。新映射的地址将作为调用的结果返回。

文件映射的内容（与匿名映射相对；参见下文的 MAP_ANONYMOUS）是通过文件描述符 fd 指向的文件（或其他对象）中从偏移量 offset 开始的 length 字节进行初始化的。offset 必须是 sysconf(_SC_PAGE_SIZE) 所返回的页面大小的倍数。

prot 参数描述了所需的内存映射保护属性（且不得与文件的打开模式冲突）。它可以是 PROT_NONE，也可以是以下一个或多个标志的按位或：

PROT_EXEC

页面可以执行。

PROT_READ

页面可以读取。

PROT_WRITE

页面可以写入。

PROT_NONE

页面不可访问。

flags 参数决定了映射的更新是否对映射同一区域的其他进程可见，以及更新是否会被传回到底层文件。此行为通过在 flags 中包含以下值之一来确定：

MAP_SHARED

共享此映射。对映射的更新对映射同一文件的其他进程可见，并会同步到底层文件。在调用 msync(2) 或 munmap() 之前，文件可能不会立即被更新。

MAP_PRIVATE

创建一个私有的写时复制（copy-on-write）映射。对映射的更新对映射同一文件的其他进程不可见，也不会被传回到底层文件。在 mmap() 调用之后对文件所做的更改是否在映射区域中可见，这是未定义的。

这两个标志在 POSIX.1-2001 中都有说明。

此外，可以将零个或多个以下值与 flags 进行或运算：

MAP_32BIT（自 Linux 2.4.20, 2.6 起）

将映射置于进程地址空间的前 2GB 内。此标志仅在 x86-64 架构上支持 64 位程序。添加此标志是为了允许线程栈分配在内存的前 2GB 内，从而提高某些早期 64 位处理器上的上下文切换性能。现代 x86-64 处理器已不存在此性能问题，因此在这些系统上无需使用此标志。当设置了 MAP_FIXED 时，MAP_32BIT 标志将被忽略。

MAP_ANON

MAP_ANONYMOUS 的同义词。已弃用。

MAP_ANONYMOUS

该映射不与任何文件关联；其内容初始化为零。fd 和 offset 参数被忽略；然而，某些实现要求如果指定了 MAP_ANONYMOUS（或 MAP_ANON），则 fd 必须为 -1，可移植应用程序应确保这一点。MAP_ANONYMOUS 与 MAP_SHARED 的结合使用仅在 Linux 内核 2.4 及更高版本中支持。

MAP_DENYWRITE

此标志被忽略。（很久以前，它表示对底层文件的写入尝试应失败并返回 ETXTBUSY。但这曾是拒绝服务攻击的来源。）

MAP_EXECUTABLE

此标志被忽略。

MAP_FILE

兼容性标志。已忽略。

MAP_FIXED

不要将 addr 视为建议：将映射精确放置在该地址。addr 必须是页面大小的倍数。如果由 addr 和 len 指定的内存区域与任何现有映射重叠，则现有映射的重叠部分将被丢弃。如果无法使用指定的地址，mmap() 将失败。由于要求映射的固定地址移植性较差，因此不鼓励使用此选项。

MAP_GROWSDOWN

用于栈。向内核虚拟内存系统指示该映射应在内存中向下扩展。

MAP_HUGETLB（自 Linux 2.6.32 起）

使用“大页面（huge pages）”分配映射。有关更多信息，请参阅 Linux 内核源文件 Documentation/vm/hugetlbpage.txt。

MAP_LOCKED（自 Linux 2.5.37 起）

以 mlock(2) 的方式将映射区域的页面锁定在内存中。在较旧的内核中会忽略此标志。

MAP_NONBLOCK（自 Linux 2.5.46 起）

仅在与 MAP_POPULATE 结合使用时才有意义。不执行预读：仅为 RAM 中已存在的页面创建页表条目。自 Linux 2.6.23 起，此标志使 MAP_POPULATE 不执行任何操作。将来 MAP_POPULATE 和 MAP_NONBLOCK 的组合可能会被重新实现。

MAP_NORESERVE

不为此映射预留交换空间。当预留了交换空间时，可以保证能够修改该映射。如果不预留交换空间，如果物理内存不可用，在写入时可能会收到 SIGSEGV。另请参阅 proc(5) 中关于 /proc/sys/vm/overcommit_memory 文件的讨论。在 2.6 之前的内核中，此标志仅对私有可写映射有效。

MAP_POPULATE（自 Linux 2.5.46 起）

为映射填充（预故障）页表。对于文件映射，这会引发文件的预读。稍后对映射的访问不会因缺页异常而阻塞。自 Linux 2.6.23 起，MAP_POPULATE 仅支持私有映射。

MAP_STACK（自 Linux 2.6.27 起）

在适合进程或线程栈的地址处分配映射。此标志目前是一个空操作，但在 glibc 线程实现中使用，以便如果某些架构要求对栈分配进行特殊处理，则以后可以为 glibc 透明地实现支持。

MAP_UNINITIALIZED（自 Linux 2.6.33 起）

不清除匿名页面。此标志旨在提高嵌入式设备上的性能。此标志仅在内核配置了 CONFIG_MMAP_ALLOW_UNINITIALIZED 选项时才有效。由于安全隐患，该选项通常仅在嵌入式设备（即用户对其内存内容拥有完全控制权的设备）上启用。

在上述标志中，只有 MAP_FIXED 在 POSIX.1-2001 中指定。然而，大多数系统也支持 MAP_ANONYMOUS（或其同义词 MAP_ANON）。

某些系统记录了额外的标志 MAP_AUTOGROW、MAP_AUTORESRV、MAP_COPY 和 MAP_LOCAL。

由 mmap() 映射的内存会在 fork(2) 后保留，并具有相同的属性。

文件是以页面大小的倍数进行映射的。对于非页面大小倍数的文件，剩余内存会在映射时被置零，并且对该区域的写入不会写入文件。更改映射底层文件的大小对映射文件中相应区域的页面产生的影响是未定义的。

munmap()

地址 addr 必须是页面大小的倍数。包含指定范围一部分的所有页面都将被取消映射，后续对这些页面的引用将生成 SIGSEGV。如果指定范围不包含任何已映射的页面，则不是错误。

文件映射的时间戳更改

对于使用 PROT_WRITE 和 MAP_SHARED 映射的文件，其 st_ctime 和 st_mtime 字段将在写入映射区域后、以及（如果存在的话）后续调用带有 MS_SYNC 或 MS_ASYNC 标志的 msync(2) 之前进行更新。

返回值

错误

EACCES

文件描述符引用的是非普通文件。或者请求了 MAP_PRIVATE，但 fd 未以读取模式打开。或者请求了 MAP_SHARED 且设置了 PROT_WRITE，但 fd 未以读/写 (O_RDWR) 模式打开。或者设置了 PROT_WRITE，但文件为仅追加模式。

EAGAIN

文件已被锁定，或者锁定的内存过多（参见 setrlimit(2)）。

EBADF

fd 不是有效的文件描述符（且未设置 MAP_ANONYMOUS）。

EINVAL

不接受 addr、length 或 offset（例如，它们太大，或者未在页面边界对齐）。

EINVAL

（自 Linux 2.6.12 起）length 为 0。

EINVAL

flags 未包含 MAP_PRIVATE 或 MAP_SHARED，或者同时包含了这两个值。

ENFILE

已达到系统打开文件总数的限制。

ENODEV

指定文件的底层文件系统不支持内存映射。

ENOMEM

没有可用内存，或者超过了进程的最大映射数量。

EPERM

prot 参数请求 PROT_EXEC，但映射区域所属的文件系统挂载为 no-exec。

ETXTBSY

设置了 MAP_DENYWRITE，但 fd 指定的对象是以写入模式打开的。

EOVERFLOW

在 32 位架构上使用大文件扩展（即使用 64 位 off_t）：用于 length 的页面数加上用于 offset 的页面数会导致 unsigned long（32 位）溢出。

#include <sys/mman.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#define handle_error(msg) \
    do { perror(msg); exit(EXIT_FAILURE); } while (0)
int
main(int argc, char *argv[])
{
    char *addr;
    int fd;
    struct stat sb;
    off_t offset, pa_offset;
    size_t length;
    ssize_t s;
    if (argc < 3 || argc > 4) {
        fprintf(stderr, "%s file offset [length]\n", argv[0]);
        exit(EXIT_FAILURE);
    }
    fd = open(argv[1], O_RDONLY);
    if (fd == -1)
        handle_error("open");
    if (fstat(fd, &sb) == -1)           /* To obtain file size */
        handle_error("fstat");
    offset = atoi(argv[2]);
    pa_offset = offset & ~(sysconf(_SC_PAGE_SIZE) - 1);
        /* offset for mmap() must be page aligned */
    if (offset >= sb.st_size) {
        fprintf(stderr, "offset is past end of file\n");
        exit(EXIT_FAILURE);
    }
    if (argc == 4) {
        length = atoi(argv[3]);
        if (offset + length > sb.st_size)
            length = sb.st_size - offset;
                /* Canaqt display bytes past end of file */
    } else {    /* No length arg ==> display to end of file */
        length = sb.st_size - offset;
    }
    addr = mmap(NULL, length + offset - pa_offset, PROT_READ,
                MAP_PRIVATE, fd, pa_offset);
    if (addr == MAP_FAILED)
        handle_error("mmap");
    s = write(STDOUT_FILENO, addr + offset - pa_offset, length);
    if (s != length) {
        if (s == -1)
            handle_error("write");
        fprintf(stderr, "partial write");
        exit(EXIT_FAILURE);
    }
    exit(EXIT_SUCCESS);
}