2004-11-03 13:51:07 +00:00
|
|
|
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Copyright (C) 2002, Michael Kerrisk
|
|
|
|
|
.\"
|
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
|
.\" preserved on all copies.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
|
.\" professionally.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
|
.\"
|
2004-11-03 14:43:40 +00:00
|
|
|
.\" Modified 31 Jan 2002, Michael Kerrisk <mtk-manpages@gmx.net>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Added description of mmap2
|
2004-11-25 07:50:05 +00:00
|
|
|
.\" Modified, 2004-11-25, mtk -- removed stray #endif in prototype
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
|
.TH MMAP2 2 2002-01-31 "Linux 2.3.31" "Linux Programmer's Manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
mmap2 \- map files or devices into memory
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B #include <sys/mman.h>
|
|
|
|
|
.br
|
|
|
|
|
.B #include <syscall.h>
|
2004-12-10 09:03:08 +00:00
|
|
|
.br
|
|
|
|
|
.B #include <errno.h>
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2004-12-10 09:03:08 +00:00
|
|
|
.BI "_syscall6(void *, " mmap2 ", void *, " start ", size_t, " length ,
|
|
|
|
|
.BI "int, " prot ", int, " flags ", int, " fd ", off_t, " pgoffset )
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
|
.BI "void * mmap2(void *" start ", size_t " length ", int " prot ,
|
|
|
|
|
.BI "int " flags ", int " fd ", off_t " pgoffset );
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The function
|
|
|
|
|
.B mmap2
|
|
|
|
|
operates in exactly the same way as
|
|
|
|
|
.BR mmap (2),
|
|
|
|
|
except that the final argument specifies the offset into the
|
|
|
|
|
file in units of the system page size (instead of bytes).
|
2004-11-25 07:50:05 +00:00
|
|
|
This enables applications that use a 32-bit
|
|
|
|
|
. I off_t
|
|
|
|
|
to map
|
2004-11-03 13:51:07 +00:00
|
|
|
larger files (typically up to 2^44 bytes).
|
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
|
On success,
|
|
|
|
|
.B mmap2
|
2005-06-15 14:10:23 +00:00
|
|
|
returns a pointer to the mapped area. On error \-1 is returned
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
|
|
|
|
.I errno
|
|
|
|
|
is set appropriately.
|
|
|
|
|
.SH ERRORS
|
|
|
|
|
.TP
|
|
|
|
|
.SH EFAULT
|
|
|
|
|
Problem with getting the
|
|
|
|
|
data from userspace.
|
|
|
|
|
.SH NOTES
|
|
|
|
|
The function
|
|
|
|
|
.B mmap2
|
|
|
|
|
is available since Linux 2.3.31.
|
|
|
|
|
It is Linux specific, and should be avoided in portable applications.
|
|
|
|
|
See also the
|
|
|
|
|
.I mmap64()
|
|
|
|
|
function that is part of the LFS (Large File Summit).
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR getpagesize (2),
|
|
|
|
|
.BR mmap (2),
|
|
|
|
|
.BR mremap (2),
|
|
|
|
|
.BR msync (2),
|
|
|
|
|
.BR shm_open (2)
|
