Commit 8c9b9703 authored by Mike Kravetz's avatar Mike Kravetz Committed by Linus Torvalds

hugetlbfs: document min_size mount option and cleanup

Add min_size mount option to the hugetlbfs documentation.  Also, add the
missing pagesize option and mention that size can be specified as bytes or
a percentage of huge page pool.
Signed-off-by: default avatarMike Kravetz <mike.kravetz@oracle.com>
Cc: Davidlohr Bueso <dave@stgolabs.net>
Cc: Aneesh Kumar <aneesh.kumar@linux.vnet.ibm.com>
Cc: Joonsoo Kim <iamjoonsoo.kim@lge.com>
Cc: Andi Kleen <andi@firstfloor.org>
Cc: David Rientjes <rientjes@google.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 7ca02d0a
...@@ -267,21 +267,34 @@ call, then it is required that system administrator mount a file system of ...@@ -267,21 +267,34 @@ call, then it is required that system administrator mount a file system of
type hugetlbfs: type hugetlbfs:
mount -t hugetlbfs \ mount -t hugetlbfs \
-o uid=<value>,gid=<value>,mode=<value>,size=<value>,nr_inodes=<value> \ -o uid=<value>,gid=<value>,mode=<value>,pagesize=<value>,size=<value>,\
none /mnt/huge min_size=<value>,nr_inodes=<value> none /mnt/huge
This command mounts a (pseudo) filesystem of type hugetlbfs on the directory This command mounts a (pseudo) filesystem of type hugetlbfs on the directory
/mnt/huge. Any files created on /mnt/huge uses huge pages. The uid and gid /mnt/huge. Any files created on /mnt/huge uses huge pages. The uid and gid
options sets the owner and group of the root of the file system. By default options sets the owner and group of the root of the file system. By default
the uid and gid of the current process are taken. The mode option sets the the uid and gid of the current process are taken. The mode option sets the
mode of root of file system to value & 01777. This value is given in octal. mode of root of file system to value & 01777. This value is given in octal.
By default the value 0755 is picked. The size option sets the maximum value of By default the value 0755 is picked. If the paltform supports multiple huge
memory (huge pages) allowed for that filesystem (/mnt/huge). The size is page sizes, the pagesize option can be used to specify the huge page size and
rounded down to HPAGE_SIZE. The option nr_inodes sets the maximum number of associated pool. pagesize is specified in bytes. If pagesize is not specified
inodes that /mnt/huge can use. If the size or nr_inodes option is not the paltform's default huge page size and associated pool will be used. The
provided on command line then no limits are set. For size and nr_inodes size option sets the maximum value of memory (huge pages) allowed for that
options, you can use [G|g]/[M|m]/[K|k] to represent giga/mega/kilo. For filesystem (/mnt/huge). The size option can be specified in bytes, or as a
example, size=2K has the same meaning as size=2048. percentage of the specified huge page pool (nr_hugepages). The size is
rounded down to HPAGE_SIZE boundary. The min_size option sets the minimum
value of memory (huge pages) allowed for the filesystem. min_size can be
specified in the same way as size, either bytes or a percentage of the
huge page pool. At mount time, the number of huge pages specified by
min_size are reserved for use by the filesystem. If there are not enough
free huge pages available, the mount will fail. As huge pages are allocated
to the filesystem and freed, the reserve count is adjusted so that the sum
of allocated and reserved huge pages is always at least min_size. The option
nr_inodes sets the maximum number of inodes that /mnt/huge can use. If the
size, min_size or nr_inodes option is not provided on command line then
no limits are set. For pagesize, size, min_size and nr_inodes options, you
can use [G|g]/[M|m]/[K|k] to represent giga/mega/kilo. For example, size=2K
has the same meaning as size=2048.
While read system calls are supported on files that reside on hugetlb While read system calls are supported on files that reside on hugetlb
file systems, write system calls are not. file systems, write system calls are not.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment