userfaultfd: selftest: cleanup help messages
authorPeter Xu <peterx@redhat.com>
Fri, 26 Oct 2018 22:09:09 +0000 (15:09 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Fri, 26 Oct 2018 23:26:35 +0000 (16:26 -0700)
Firstly, the help in the comment region is obsolete, now we support
three parameters.  Since at it, change it and move it into the help
message of the program.

Also, the help messages dumped here and there is obsolete too.  Use a
single usage() helper.

Link: http://lkml.kernel.org/r/20180930074259.18229-2-peterx@redhat.com
Signed-off-by: Peter Xu <peterx@redhat.com>
Acked-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Cc: Shuah Khan <shuah@kernel.org>
Cc: Mike Kravetz <mike.kravetz@oracle.com>
Cc: Jerome Glisse <jglisse@redhat.com>
Cc: Zi Yan <zi.yan@cs.rutgers.edu>
Cc: "Kirill A . Shutemov" <kirill@shutemov.name>
Cc: Shaohua Li <shli@fb.com>
Cc: Andrea Arcangeli <aarcange@redhat.com>
Cc: "Dr . David Alan Gilbert" <dgilbert@redhat.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
tools/testing/selftests/vm/userfaultfd.c

index 7b8171e3128a8715a62a10e020c69ea3ca1c5321..5ff3a4f9173eabce71e548b618ece54d598505a6 100644 (file)
  * per-CPU threads 1 by triggering userfaults inside
  * pthread_mutex_lock will also verify the atomicity of the memory
  * transfer (UFFDIO_COPY).
  * per-CPU threads 1 by triggering userfaults inside
  * pthread_mutex_lock will also verify the atomicity of the memory
  * transfer (UFFDIO_COPY).
- *
- * The program takes two parameters: the amounts of physical memory in
- * megabytes (MiB) of the area and the number of bounces to execute.
- *
- * # 100MiB 99999 bounces
- * ./userfaultfd 100 99999
- *
- * # 1GiB 99 bounces
- * ./userfaultfd 1000 99
- *
- * # 10MiB-~6GiB 999 bounces, continue forever unless an error triggers
- * while ./userfaultfd $[RANDOM % 6000 + 10] 999; do true; done
  */
 
 #define _GNU_SOURCE
  */
 
 #define _GNU_SOURCE
@@ -115,6 +103,30 @@ pthread_attr_t attr;
                                 ~(unsigned long)(sizeof(unsigned long long) \
                                                  -  1)))
 
                                 ~(unsigned long)(sizeof(unsigned long long) \
                                                  -  1)))
 
+const char *examples =
+    "# Run anonymous memory test on 100MiB region with 99999 bounces:\n"
+    "./userfaultfd anon 100 99999\n\n"
+    "# Run share memory test on 1GiB region with 99 bounces:\n"
+    "./userfaultfd shmem 1000 99\n\n"
+    "# Run hugetlb memory test on 256MiB region with 50 bounces (using /dev/hugepages/hugefile):\n"
+    "./userfaultfd hugetlb 256 50 /dev/hugepages/hugefile\n\n"
+    "# Run the same hugetlb test but using shmem:\n"
+    "./userfaultfd hugetlb_shared 256 50 /dev/hugepages/hugefile\n\n"
+    "# 10MiB-~6GiB 999 bounces anonymous test, "
+    "continue forever unless an error triggers\n"
+    "while ./userfaultfd anon $[RANDOM % 6000 + 10] 999; do true; done\n\n";
+
+static void usage(void)
+{
+       fprintf(stderr, "\nUsage: ./userfaultfd <test type> <MiB> <bounces> "
+               "[hugetlbfs_file]\n\n");
+       fprintf(stderr, "Supported <test type>: anon, hugetlb, "
+               "hugetlb_shared, shmem\n\n");
+       fprintf(stderr, "Examples:\n\n");
+       fprintf(stderr, examples);
+       exit(1);
+}
+
 static int anon_release_pages(char *rel_area)
 {
        int ret = 0;
 static int anon_release_pages(char *rel_area)
 {
        int ret = 0;
@@ -1272,8 +1284,7 @@ static void sigalrm(int sig)
 int main(int argc, char **argv)
 {
        if (argc < 4)
 int main(int argc, char **argv)
 {
        if (argc < 4)
-               fprintf(stderr, "Usage: <test type> <MiB> <bounces> [hugetlbfs_file]\n"),
-                               exit(1);
+               usage();
 
        if (signal(SIGALRM, sigalrm) == SIG_ERR)
                fprintf(stderr, "failed to arm SIGALRM"), exit(1);
 
        if (signal(SIGALRM, sigalrm) == SIG_ERR)
                fprintf(stderr, "failed to arm SIGALRM"), exit(1);
@@ -1286,20 +1297,19 @@ int main(int argc, char **argv)
                nr_cpus;
        if (!nr_pages_per_cpu) {
                fprintf(stderr, "invalid MiB\n");
                nr_cpus;
        if (!nr_pages_per_cpu) {
                fprintf(stderr, "invalid MiB\n");
-               fprintf(stderr, "Usage: <MiB> <bounces>\n"), exit(1);
+               usage();
        }
 
        bounces = atoi(argv[3]);
        if (bounces <= 0) {
                fprintf(stderr, "invalid bounces\n");
        }
 
        bounces = atoi(argv[3]);
        if (bounces <= 0) {
                fprintf(stderr, "invalid bounces\n");
-               fprintf(stderr, "Usage: <MiB> <bounces>\n"), exit(1);
+               usage();
        }
        nr_pages = nr_pages_per_cpu * nr_cpus;
 
        if (test_type == TEST_HUGETLB) {
                if (argc < 5)
        }
        nr_pages = nr_pages_per_cpu * nr_cpus;
 
        if (test_type == TEST_HUGETLB) {
                if (argc < 5)
-                       fprintf(stderr, "Usage: hugetlb <MiB> <bounces> <hugetlbfs_file>\n"),
-                               exit(1);
+                       usage();
                huge_fd = open(argv[4], O_CREAT | O_RDWR, 0755);
                if (huge_fd < 0) {
                        fprintf(stderr, "Open of %s failed", argv[3]);
                huge_fd = open(argv[4], O_CREAT | O_RDWR, 0755);
                if (huge_fd < 0) {
                        fprintf(stderr, "Open of %s failed", argv[3]);