man-pages/man2/subpage_prot.2.html
2021-03-31 01:06:50 +01:00

197 lines
5.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SUBPAGE_PROT</TITLE>
</HEAD><BODY>
<H1>SUBPAGE_PROT</H1>
Section: Linux Programmer's Manual (2)<BR>Updated: 2019-03-06<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
subpage_prot - define a subpage protection for an address range
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>long subpage_prot(unsigned long </B><I>addr</I><B>, unsigned long </B><I>len</I><B>,</B>
<B> uint32_t *</B><I>map</I><B>);</B>
</PRE>
<P>
<I>Note</I>:
There is no glibc wrapper for this system call; see NOTES.
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The PowerPC-specific
<B>subpage_prot</B>()
system call provides the facility to control the access
permissions on individual 4&nbsp;kB subpages on systems configured with
a page size of 64&nbsp;kB.
<P>
The protection map is applied to the memory pages in the region starting at
<I>addr</I>
and continuing for
<I>len</I>
bytes.
Both of these arguments must be aligned to a 64-kB boundary.
<P>
The protection map is specified in the buffer pointed to by
<I>map</I>.
The map has 2 bits per 4&nbsp;kB subpage;
thus each 32-bit word specifies the protections of 16 4&nbsp;kB subpages
inside a 64&nbsp;kB page
(so, the number of 32-bit words pointed to by
<I>map</I>
should equate to the number of 64-kB pages specified by
<I>len</I>).
Each 2-bit field in the protection map is either 0 to allow any access,
1 to prevent writes, or 2 or 3 to prevent all accesses.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success,
<B>subpage_prot</B>()
returns 0.
Otherwise, one of the error codes specified below is returned.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="1"><B>EFAULT</B>
<DD>
The buffer referred to by
<I>map</I>
is not accessible.
<DT id="2"><B>EINVAL</B>
<DD>
The
<I>addr</I>
or
<I>len</I>
arguments are incorrect.
Both of these arguments must be aligned to a multiple of the system page size,
and they must not refer to a region outside of the
address space of the process or to a region that consists of huge pages.
<DT id="3"><B>ENOMEM</B>
<DD>
Out of memory.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
This system call is provided on the PowerPC architecture
since Linux 2.6.25.
The system call is provided only if the kernel is configured with
<B>CONFIG_PPC_64K_PAGES</B>.
No library support is provided.
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
This system call is Linux-specific.
<A NAME="lbAI">&nbsp;</A>
<H2>NOTES</H2>
Glibc does not provide a wrapper for this system call; call it using
<B><A HREF="/cgi-bin/man/man2html?2+syscall">syscall</A></B>(2).
<P>
Normal page protections (at the 64-kB page level) also apply;
the subpage protection mechanism is an additional constraint,
so putting 0 in a 2-bit field won't allow writes to a page that is otherwise
write-protected.
<A NAME="lbAJ">&nbsp;</A>
<H3>Rationale</H3>
This system call is provided to assist writing emulators that
operate using 64-kB pages on PowerPC systems.
When emulating systems such as x86, which uses a smaller page size,
the emulator can no longer use the memory-management unit (MMU)
and normal system calls for controlling page protections.
(The emulator could emulate the MMU by checking and possibly remapping
the address for each memory access in software, but that is slow.)
The idea is that the emulator supplies an array of protection masks
to apply to a specified range of virtual addresses.
These masks are applied at the level where hardware page-table entries (PTEs)
are inserted into the hardware page table based on the Linux PTEs,
so the Linux PTEs are not affected.
Implicit in this is that the regions of the address space that are
protected are switched to use 4-kB hardware pages rather than 64-kB
hardware pages (on machines with hardware 64-kB page support).
<A NAME="lbAK">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?2+mprotect">mprotect</A></B>(2),
<B><A HREF="/cgi-bin/man/man2html?2+syscall">syscall</A></B>(2)
<P>
<I>Documentation/admin-guide/mm/hugetlbpage.rst</I>
in the Linux kernel source tree
<A NAME="lbAL">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
<DT id="5"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="6"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="7"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="8"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="9"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="10"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="11"><A HREF="#lbAI">NOTES</A><DD>
<DL>
<DT id="12"><A HREF="#lbAJ">Rationale</A><DD>
</DL>
<DT id="13"><A HREF="#lbAK">SEE ALSO</A><DD>
<DT id="14"><A HREF="#lbAL">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:34 GMT, March 31, 2021
</BODY>
</HTML>