57043d
From ffbc7a05e1777f4a2b3096483519fe5096ecc716 Mon Sep 17 00:00:00 2001
57043d
From: Sanskriti Sharma <sansharm@redhat.com>
57043d
Date: Tue, 20 Nov 2018 10:22:06 -0500
57043d
Subject: [PATCH] memhog: add man page
57043d
57043d
Signed-off-by: Sanskriti Sharma <sansharm@redhat.com>
57043d
---
57043d
 memhog.8 | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
57043d
 1 file changed, 68 insertions(+)
57043d
 create mode 100644 memhog.8
57043d
57043d
diff --git a/memhog.8 b/memhog.8
57043d
new file mode 100644
57043d
index 0000000..e28e784
57043d
--- /dev/null
57043d
+++ b/memhog.8
57043d
@@ -0,0 +1,68 @@
57043d
+.TH MEMHOG 8 "2003,2004" "SuSE Labs" "Linux Administrator's Manual"
57043d
+.SH NAME
57043d
+memhog \- Allocates memory with policy for testing
57043d
+.SH SYNOPSIS
57043d
+.B memhog 
57043d
+[
57043d
+.B \-r<NUM>
57043d
+] [
57043d
+.B size kmg
57043d
+] [
57043d
+.B policy nodeset
57043d
+] [
57043d
+.B \-f<filename>
57043d
+]
57043d
+.SH DESCRIPTION
57043d
+.B memhog 
57043d
+mmaps a memory region for a given size and sets the numa policy (if specified). 
57043d
+It then updates the memory region for the given number of iterations using memset.
57043d
+.TS
57043d
+tab(|);
57043d
+l l.
57043d
+-r<num>|Repeat memset NUM times
57043d
+-f<file>|Open file for mmap backing
57043d
+-H|Disable transparent hugepages
57043d
+-size|Allocation size in bytes, may have case-insensitive order 
57043d
+|suffix (G=gigabyte, M=megabyte, K=kilobyte)
57043d
+.TE
57043d
+
57043d
+Supported numa-policies:
57043d
+.TP
57043d
+.B interleave 
57043d
+Memory will be allocated using round robin on nodes. When
57043d
+memory cannot be allocated on the current interleave, target fall back 
57043d
+to other nodes.  Multiple nodes may be specified.
57043d
+.TP
57043d
+.B membind 
57043d
+Only  allocate  memory  from  nodes. Allocation will fail 
57043d
+when there is not enough memory available on these nodes. Multiple 
57043d
+nodes  may be specified.
57043d
+.TP
57043d
+.B preferred 
57043d
+Preferably allocate memory on node, but if memory cannot be
57043d
+allocated  there  fall  back  to other nodes.  This option takes only a 
57043d
+single node number.
57043d
+.TP
57043d
+.B default 
57043d
+Memory will be allocated on the local node (the node the 
57043d
+thread is running on)
57043d
+
57043d
+.SH EXAMPLES
57043d
+.TP
57043d
+# Allocate a 1G region, mmap backed by memhog.mmap file, membind to node 0, repeat test 6 times
57043d
+memhog -r6 1G --membind 0 -fmemhog.mmap
57043d
+.TP
57043d
+# Allocate a 1G region, iterleave across nodes 0,1,2,3, repeat test 4 times
57043d
+memhog -r4 1G --interleave 0-3
57043d
+.TP
57043d
+# Allocate a 1G region, (implicit) default policy, repeat test 8 times
57043d
+memhog -r8 1G
57043d
+
57043d
+.SH AUTHORS
57043d
+Andi Kleen (ak@suse.de)
57043d
+
57043d
+.SH LICENSE
57043d
+GPL v2
57043d
+
57043d
+.SH SEE ALSO
57043d
+.I mmap(2), memset(3), numactl(8), numastat(8)
57043d
-- 
57043d
2.7.5
57043d