-.\" Hey Emacs! This file is -*- nroff -*- source.
-.\"
.\" Copyright 2003 Andries E. Brouwer (aeb@cwi.nl)
.\"
+.\" %%%LICENSE_START(VERBATIM)
.\" 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.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
.\"
-.TH ALLOC_HUGEPAGES 2 2007-05-31 "Linux" "Linux Programmer's Manual"
+.TH ALLOC_HUGEPAGES 2 2017-09-15 "Linux" "Linux Programmer's Manual"
.SH NAME
alloc_hugepages, free_hugepages \- allocate or free huge pages
.SH SYNOPSIS
.BI " int " prot ", int " flag );
.\" asmlinkage unsigned long sys_alloc_hugepages(int key, unsigned long addr,
.\" unsigned long len, int prot, int flag);
-.sp
+.PP
.BI "int free_hugepages(void *" addr );
.\" asmlinkage int sys_free_hugepages(unsigned long addr);
.fi
were introduced in Linux 2.5.36 and removed again in 2.5.54.
They existed only on i386 and ia64 (when built with
.BR CONFIG_HUGETLB_PAGE ).
-In Linux 2.4.20 the syscall numbers exist,
+In Linux 2.4.20, the syscall numbers exist,
but the calls fail with the error
.BR ENOSYS .
-.LP
-On i386 the memory management hardware knows about ordinary pages (4 KiB)
-and huge pages (2 or 4 MiB).
+.PP
+On i386 the memory management hardware knows about ordinary pages (4\ KiB)
+and huge pages (2 or 4\ MiB).
Similarly ia64 knows about huge pages of
several sizes.
These system calls serve to map huge pages into the
process's memory or to free them again.
Huge pages are locked into memory, and are not swapped.
-.LP
+.PP
The
.I key
argument is an identifier.
When positive the pages are shared with other applications using the same
.IR key ,
and inherited by child processes.
-.LP
+.PP
The
.I addr
argument of
.BR alloc_hugepages ()
is a hint, that the kernel may or may not follow.
Addresses must be properly aligned.
-.LP
+.PP
The
.I len
argument is the length of the required segment.
It must be a multiple of the huge page size.
-.LP
+.PP
The
.I prot
argument specifies the memory protection of the segment.
.BR PROT_READ ,
.BR PROT_WRITE ,
.BR PROT_EXEC .
-.LP
+.PP
The
.I flag
argument is ignored, unless
.B ENOSYS
The system call is not supported on this kernel.
.SH FILES
+.TP
.I /proc/sys/vm/nr_hugepages
Number of configured hugetlb pages.
This can be read and written.
-.LP
+.TP
.I /proc/meminfo
Gives info on the number of configured hugetlb pages and on their size
in the three variables HugePages_Total, HugePages_Free, Hugepagesize.
.SH NOTES
These system calls are gone;
they existed only in Linux 2.5.36 through to 2.5.54.
-Now the hugetlbfs file system can be used instead.
+Now the hugetlbfs filesystem can be used instead.
Memory backed by huge pages (if the CPU supports them) is obtained by
using
.BR mmap (2)
-to map files in this virtual file system.
-.LP
+to map files in this virtual filesystem.
+.PP
The maximal number of huge pages can be specified using the
.B hugepages=
boot parameter.
-
+.PP
.\" requires CONFIG_HUGETLB_PAGE (under "Processor type and features")
.\" and CONFIG_HUGETLBFS (under "Filesystems").
.\" mount -t hugetlbfs hugetlbfs /huge