X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=HOWTO;h=996da23a1ce998665d1f9af7d65faaf064eced64;hp=6ac744cd3d436124f8474ff135c7a842fb92136b;hb=5394ae5fc8dabc3a69b7c58550e21926461853ad;hpb=74b025b071b5bfbffa7ad7682b66b749e8d1f955;ds=sidebyside

diff --git a/HOWTO b/HOWTO
index 6ac744cd..996da23a 100644
--- a/HOWTO
+++ b/HOWTO
@@ -362,8 +362,27 @@ mem=str		Fio can use various types of memory as the io unit buffer.
 			mmap	Use anonymous memory maps as the buffers.
 				Allocated through mmap(2).
 
+			mmaphuge Use a memory mapped huge file as the buffer
+				backing. Append filename after mmaphuge, ala
+				mem=mmaphuge:/hugetlbfs/file
+
 		The area allocated is a function of the maximum allowed
-		bs size for the job, multiplied by the io depth given.
+		bs size for the job, multiplied by the io depth given. Note
+		that for shmhuge and mmaphuge to work, the system must have
+		free huge pages allocated. This can normally be checked
+		and set by reading/writing /proc/sys/vm/nr_hugepages on a
+		Linux system. Fio assumes a huge page is 4MiB in size. So
+		to calculate the number of huge pages you need for a given
+		job file, add up the io depth of all jobs (normally one unless
+		iodepth= is used) and multiply by the maximum bs set. Then
+		divide that number by the huge page size. You can see the
+		size of the huge pages in /proc/meminfo. If no huge pages
+		are allocated by having a non-zero number in nr_hugepages,
+		using mmaphuge or shmhuge will fail.
+
+		mmaphuge also needs to have hugetlbfs mounted and the file
+		location should point there. So if it's mounted in /huge,
+		you would use mem=mmaphuge:/huge/somefile.
 
 exitall		When one job finishes, terminate the rest. The default is
 		to wait for each job to finish, sometimes that is not the