xref: /linux/tools/testing/selftests/mm/run_vmtests.sh (revision b05f8d7e077952d14acb63e3ccdf5f64404b59a4)
1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0
3# Please run as root
4
5# Kselftest framework requirement - SKIP code is 4.
6ksft_skip=4
7
8count_total=0
9count_pass=0
10count_fail=0
11count_skip=0
12exitcode=0
13
14usage() {
15	cat <<EOF
16usage: ${BASH_SOURCE[0]:-$0} [ options ]
17
18  -a: run all tests, including extra ones (other than destructive ones)
19  -t: specify specific categories to tests to run
20  -h: display this message
21  -n: disable TAP output
22  -d: run destructive tests
23
24The default behavior is to run required tests only.  If -a is specified,
25will run all tests.
26
27Alternatively, specific groups tests can be run by passing a string
28to the -t argument containing one or more of the following categories
29separated by spaces:
30- mmap
31	tests for mmap(2)
32- gup_test
33	tests for gup
34- userfaultfd
35	tests for  userfaultfd(2)
36- compaction
37	a test for the patch "Allow compaction of unevictable pages"
38- mlock
39	tests for mlock(2)
40- mremap
41	tests for mremap(2)
42- hugevm
43	tests for very large virtual address space
44- vmalloc
45	vmalloc smoke tests
46- hmm
47	hmm smoke tests
48- madv_guard
49	test madvise(2) MADV_GUARD_INSTALL and MADV_GUARD_REMOVE options
50- madv_populate
51	test memadvise(2) MADV_POPULATE_{READ,WRITE} options
52- memfd_secret
53	test memfd_secret(2)
54- process_mrelease
55	test process_mrelease(2)
56- ksm
57	ksm tests that do not require >=2 NUMA nodes
58- ksm_numa
59	ksm tests that require >=2 NUMA nodes
60- pkey
61	memory protection key tests
62- soft_dirty
63	test soft dirty page bit semantics
64- pagemap
65	test pagemap_scan IOCTL
66- cow
67	test copy-on-write semantics
68- thp
69	test transparent huge pages
70- hugetlb
71	test hugetlbfs huge pages
72- migration
73	invoke move_pages(2) to exercise the migration entry code
74	paths in the kernel
75- mkdirty
76	test handling of code that might set PTE/PMD dirty in
77	read-only VMAs
78- mdwe
79	test prctl(PR_SET_MDWE, ...)
80- page_frag
81	test handling of page fragment allocation and freeing
82- vma_merge
83	test VMA merge cases behave as expected
84
85example: ./run_vmtests.sh -t "hmm mmap ksm"
86EOF
87	exit 0
88}
89
90RUN_ALL=false
91RUN_DESTRUCTIVE=false
92TAP_PREFIX="# "
93
94while getopts "aht:n" OPT; do
95	case ${OPT} in
96		"a") RUN_ALL=true ;;
97		"h") usage ;;
98		"t") VM_SELFTEST_ITEMS=${OPTARG} ;;
99		"n") TAP_PREFIX= ;;
100		"d") RUN_DESTRUCTIVE=true ;;
101	esac
102done
103shift $((OPTIND -1))
104
105# default behavior: run all tests
106VM_SELFTEST_ITEMS=${VM_SELFTEST_ITEMS:-default}
107
108test_selected() {
109	if [ "$VM_SELFTEST_ITEMS" == "default" ]; then
110		# If no VM_SELFTEST_ITEMS are specified, run all tests
111		return 0
112	fi
113	# If test selected argument is one of the test items
114	if [[ " ${VM_SELFTEST_ITEMS[*]} " =~ " ${1} " ]]; then
115	        return 0
116	else
117	        return 1
118	fi
119}
120
121run_gup_matrix() {
122    # -t: thp=on, -T: thp=off, -H: hugetlb=on
123    local hugetlb_mb=$(( needmem_KB / 1024 ))
124
125    for huge in -t -T "-H -m $hugetlb_mb"; do
126        # -u: gup-fast, -U: gup-basic, -a: pin-fast, -b: pin-basic, -L: pin-longterm
127        for test_cmd in -u -U -a -b -L; do
128            # -w: write=1, -W: write=0
129            for write in -w -W; do
130                # -S: shared
131                for share in -S " "; do
132                    # -n: How many pages to fetch together?  512 is special
133                    # because it's default thp size (or 2M on x86), 123 to
134                    # just test partial gup when hit a huge in whatever form
135                    for num in "-n 1" "-n 512" "-n 123"; do
136                        CATEGORY="gup_test" run_test ./gup_test \
137                                $huge $test_cmd $write $share $num
138                    done
139                done
140            done
141        done
142    done
143}
144
145# get huge pagesize and freepages from /proc/meminfo
146while read -r name size unit; do
147	if [ "$name" = "HugePages_Free:" ]; then
148		freepgs="$size"
149	fi
150	if [ "$name" = "Hugepagesize:" ]; then
151		hpgsize_KB="$size"
152	fi
153done < /proc/meminfo
154
155# Simple hugetlbfs tests have a hardcoded minimum requirement of
156# huge pages totaling 256MB (262144KB) in size.  The userfaultfd
157# hugetlb test requires a minimum of 2 * nr_cpus huge pages.  Take
158# both of these requirements into account and attempt to increase
159# number of huge pages available.
160nr_cpus=$(nproc)
161uffd_min_KB=$((hpgsize_KB * nr_cpus * 2))
162hugetlb_min_KB=$((256 * 1024))
163if [[ $uffd_min_KB -gt $hugetlb_min_KB ]]; then
164	needmem_KB=$uffd_min_KB
165else
166	needmem_KB=$hugetlb_min_KB
167fi
168
169# set proper nr_hugepages
170if [ -n "$freepgs" ] && [ -n "$hpgsize_KB" ]; then
171	nr_hugepgs=$(cat /proc/sys/vm/nr_hugepages)
172	needpgs=$((needmem_KB / hpgsize_KB))
173	tries=2
174	while [ "$tries" -gt 0 ] && [ "$freepgs" -lt "$needpgs" ]; do
175		lackpgs=$((needpgs - freepgs))
176		echo 3 > /proc/sys/vm/drop_caches
177		if ! echo $((lackpgs + nr_hugepgs)) > /proc/sys/vm/nr_hugepages; then
178			echo "Please run this test as root"
179			exit $ksft_skip
180		fi
181		while read -r name size unit; do
182			if [ "$name" = "HugePages_Free:" ]; then
183				freepgs=$size
184			fi
185		done < /proc/meminfo
186		tries=$((tries - 1))
187	done
188	if [ "$freepgs" -lt "$needpgs" ]; then
189		printf "Not enough huge pages available (%d < %d)\n" \
190		       "$freepgs" "$needpgs"
191	fi
192	HAVE_HUGEPAGES=1
193else
194	echo "no hugetlbfs support in kernel?"
195	HAVE_HUGEPAGES=0
196fi
197
198# filter 64bit architectures
199ARCH64STR="arm64 mips64 parisc64 ppc64 ppc64le riscv64 s390x sparc64 x86_64"
200if [ -z "$ARCH" ]; then
201	ARCH=$(uname -m 2>/dev/null | sed -e 's/aarch64.*/arm64/')
202fi
203VADDR64=0
204echo "$ARCH64STR" | grep "$ARCH" &>/dev/null && VADDR64=1
205
206tap_prefix() {
207	sed -e "s/^/${TAP_PREFIX}/"
208}
209
210tap_output() {
211	if [[ ! -z "$TAP_PREFIX" ]]; then
212		read str
213		echo $str
214	fi
215}
216
217pretty_name() {
218	echo "$*" | sed -e 's/^\(bash \)\?\.\///'
219}
220
221# Usage: run_test [test binary] [arbitrary test arguments...]
222run_test() {
223	if test_selected ${CATEGORY}; then
224		local skip=0
225
226		# On memory constrainted systems some tests can fail to allocate hugepages.
227		# perform some cleanup before the test for a higher success rate.
228		if [ ${CATEGORY} == "thp" -o ${CATEGORY} == "hugetlb" ]; then
229			if [ "${HAVE_HUGEPAGES}" = "1" ]; then
230				echo 3 > /proc/sys/vm/drop_caches
231				sleep 2
232				echo 1 > /proc/sys/vm/compact_memory
233				sleep 2
234			else
235				echo "hugepages not supported" | tap_prefix
236				skip=1
237			fi
238		fi
239
240		local test=$(pretty_name "$*")
241		local title="running $*"
242		local sep=$(echo -n "$title" | tr "[:graph:][:space:]" -)
243		printf "%s\n%s\n%s\n" "$sep" "$title" "$sep" | tap_prefix
244
245		if [ "${skip}" != "1" ]; then
246			("$@" 2>&1) | tap_prefix
247			local ret=${PIPESTATUS[0]}
248		else
249			local ret=$ksft_skip
250		fi
251		count_total=$(( count_total + 1 ))
252		if [ $ret -eq 0 ]; then
253			count_pass=$(( count_pass + 1 ))
254			echo "[PASS]" | tap_prefix
255			echo "ok ${count_total} ${test}" | tap_output
256		elif [ $ret -eq $ksft_skip ]; then
257			count_skip=$(( count_skip + 1 ))
258			echo "[SKIP]" | tap_prefix
259			echo "ok ${count_total} ${test} # SKIP" | tap_output
260			exitcode=$ksft_skip
261		else
262			count_fail=$(( count_fail + 1 ))
263			echo "[FAIL]" | tap_prefix
264			echo "not ok ${count_total} ${test} # exit=$ret" | tap_output
265			exitcode=1
266		fi
267	fi # test_selected
268}
269
270echo "TAP version 13" | tap_output
271
272CATEGORY="hugetlb" run_test ./hugepage-mmap
273
274shmmax=$(cat /proc/sys/kernel/shmmax)
275shmall=$(cat /proc/sys/kernel/shmall)
276echo 268435456 > /proc/sys/kernel/shmmax
277echo 4194304 > /proc/sys/kernel/shmall
278CATEGORY="hugetlb" run_test ./hugepage-shm
279echo "$shmmax" > /proc/sys/kernel/shmmax
280echo "$shmall" > /proc/sys/kernel/shmall
281
282CATEGORY="hugetlb" run_test ./map_hugetlb
283CATEGORY="hugetlb" run_test ./hugepage-mremap
284CATEGORY="hugetlb" run_test ./hugepage-vmemmap
285CATEGORY="hugetlb" run_test ./hugetlb-madvise
286CATEGORY="hugetlb" run_test ./hugetlb_dio
287
288if [ "${HAVE_HUGEPAGES}" = "1" ]; then
289	nr_hugepages_tmp=$(cat /proc/sys/vm/nr_hugepages)
290	# For this test, we need one and just one huge page
291	echo 1 > /proc/sys/vm/nr_hugepages
292	CATEGORY="hugetlb" run_test ./hugetlb_fault_after_madv
293	CATEGORY="hugetlb" run_test ./hugetlb_madv_vs_map
294	# Restore the previous number of huge pages, since further tests rely on it
295	echo "$nr_hugepages_tmp" > /proc/sys/vm/nr_hugepages
296fi
297
298if test_selected "hugetlb"; then
299	echo "NOTE: These hugetlb tests provide minimal coverage.  Use"	  | tap_prefix
300	echo "      https://github.com/libhugetlbfs/libhugetlbfs.git for" | tap_prefix
301	echo "      hugetlb regression testing."			  | tap_prefix
302fi
303
304CATEGORY="mmap" run_test ./map_fixed_noreplace
305
306if $RUN_ALL; then
307    run_gup_matrix
308else
309    # get_user_pages_fast() benchmark
310    CATEGORY="gup_test" run_test ./gup_test -u
311    # pin_user_pages_fast() benchmark
312    CATEGORY="gup_test" run_test ./gup_test -a
313fi
314# Dump pages 0, 19, and 4096, using pin_user_pages:
315CATEGORY="gup_test" run_test ./gup_test -ct -F 0x1 0 19 0x1000
316CATEGORY="gup_test" run_test ./gup_longterm
317
318CATEGORY="userfaultfd" run_test ./uffd-unit-tests
319uffd_stress_bin=./uffd-stress
320CATEGORY="userfaultfd" run_test ${uffd_stress_bin} anon 20 16
321# Hugetlb tests require source and destination huge pages. Pass in half
322# the size of the free pages we have, which is used for *each*.
323# uffd-stress expects a region expressed in MiB, so we adjust
324# half_ufd_size_MB accordingly.
325half_ufd_size_MB=$(((freepgs * hpgsize_KB) / 1024 / 2))
326CATEGORY="userfaultfd" run_test ${uffd_stress_bin} hugetlb "$half_ufd_size_MB" 32
327CATEGORY="userfaultfd" run_test ${uffd_stress_bin} hugetlb-private "$half_ufd_size_MB" 32
328CATEGORY="userfaultfd" run_test ${uffd_stress_bin} shmem 20 16
329CATEGORY="userfaultfd" run_test ${uffd_stress_bin} shmem-private 20 16
330# uffd-wp-mremap requires at least one page of each size.
331have_all_size_hugepgs=true
332declare -A nr_size_hugepgs
333for f in /sys/kernel/mm/hugepages/**/nr_hugepages; do
334	old=$(cat $f)
335	nr_size_hugepgs["$f"]="$old"
336	if [ "$old" == 0 ]; then
337		echo 1 > "$f"
338	fi
339	if [ $(cat "$f") == 0 ]; then
340		have_all_size_hugepgs=false
341		break
342	fi
343done
344if $have_all_size_hugepgs; then
345	CATEGORY="userfaultfd" run_test ./uffd-wp-mremap
346else
347	echo "# SKIP ./uffd-wp-mremap"
348fi
349
350#cleanup
351for f in "${!nr_size_hugepgs[@]}"; do
352	echo "${nr_size_hugepgs["$f"]}" > "$f"
353done
354echo "$nr_hugepgs" > /proc/sys/vm/nr_hugepages
355
356CATEGORY="compaction" run_test ./compaction_test
357
358if command -v sudo &> /dev/null && sudo -u nobody ls ./on-fault-limit >/dev/null;
359then
360	CATEGORY="mlock" run_test sudo -u nobody ./on-fault-limit
361else
362	echo "# SKIP ./on-fault-limit"
363fi
364
365CATEGORY="mmap" run_test ./map_populate
366
367CATEGORY="mlock" run_test ./mlock-random-test
368
369CATEGORY="mlock" run_test ./mlock2-tests
370
371CATEGORY="process_mrelease" run_test ./mrelease_test
372
373CATEGORY="mremap" run_test ./mremap_test
374
375CATEGORY="hugetlb" run_test ./thuge-gen
376CATEGORY="hugetlb" run_test ./charge_reserved_hugetlb.sh -cgroup-v2
377CATEGORY="hugetlb" run_test ./hugetlb_reparenting_test.sh -cgroup-v2
378if $RUN_DESTRUCTIVE; then
379nr_hugepages_tmp=$(cat /proc/sys/vm/nr_hugepages)
380enable_soft_offline=$(cat /proc/sys/vm/enable_soft_offline)
381echo 8 > /proc/sys/vm/nr_hugepages
382CATEGORY="hugetlb" run_test ./hugetlb-soft-offline
383echo "$nr_hugepages_tmp" > /proc/sys/vm/nr_hugepages
384echo "$enable_soft_offline" > /proc/sys/vm/enable_soft_offline
385CATEGORY="hugetlb" run_test ./hugetlb-read-hwpoison
386fi
387
388if [ $VADDR64 -ne 0 ]; then
389
390	# set overcommit_policy as OVERCOMMIT_ALWAYS so that kernel
391	# allows high virtual address allocation requests independent
392	# of platform's physical memory.
393
394	if [ -x ./virtual_address_range ]; then
395		prev_policy=$(cat /proc/sys/vm/overcommit_memory)
396		echo 1 > /proc/sys/vm/overcommit_memory
397		CATEGORY="hugevm" run_test ./virtual_address_range
398		echo $prev_policy > /proc/sys/vm/overcommit_memory
399	fi
400
401	# va high address boundary switch test
402	ARCH_ARM64="arm64"
403	prev_nr_hugepages=$(cat /proc/sys/vm/nr_hugepages)
404	if [ "$ARCH" == "$ARCH_ARM64" ]; then
405		echo 6 > /proc/sys/vm/nr_hugepages
406	fi
407	CATEGORY="hugevm" run_test bash ./va_high_addr_switch.sh
408	if [ "$ARCH" == "$ARCH_ARM64" ]; then
409		echo $prev_nr_hugepages > /proc/sys/vm/nr_hugepages
410	fi
411fi # VADDR64
412
413# vmalloc stability smoke test
414CATEGORY="vmalloc" run_test bash ./test_vmalloc.sh smoke
415
416CATEGORY="mremap" run_test ./mremap_dontunmap
417
418CATEGORY="hmm" run_test bash ./test_hmm.sh smoke
419
420# MADV_GUARD_INSTALL and MADV_GUARD_REMOVE tests
421CATEGORY="madv_guard" run_test ./guard-regions
422
423# MADV_POPULATE_READ and MADV_POPULATE_WRITE tests
424CATEGORY="madv_populate" run_test ./madv_populate
425
426CATEGORY="vma_merge" run_test ./merge
427
428if [ -x ./memfd_secret ]
429then
430(echo 0 > /proc/sys/kernel/yama/ptrace_scope 2>&1) | tap_prefix
431CATEGORY="memfd_secret" run_test ./memfd_secret
432fi
433
434# KSM KSM_MERGE_TIME_HUGE_PAGES test with size of 100
435if [ "${HAVE_HUGEPAGES}" = "1" ]; then
436	CATEGORY="ksm" run_test ./ksm_tests -H -s 100
437fi
438# KSM KSM_MERGE_TIME test with size of 100
439CATEGORY="ksm" run_test ./ksm_tests -P -s 100
440# KSM MADV_MERGEABLE test with 10 identical pages
441CATEGORY="ksm" run_test ./ksm_tests -M -p 10
442# KSM unmerge test
443CATEGORY="ksm" run_test ./ksm_tests -U
444# KSM test with 10 zero pages and use_zero_pages = 0
445CATEGORY="ksm" run_test ./ksm_tests -Z -p 10 -z 0
446# KSM test with 10 zero pages and use_zero_pages = 1
447CATEGORY="ksm" run_test ./ksm_tests -Z -p 10 -z 1
448# KSM test with 2 NUMA nodes and merge_across_nodes = 1
449CATEGORY="ksm_numa" run_test ./ksm_tests -N -m 1
450# KSM test with 2 NUMA nodes and merge_across_nodes = 0
451CATEGORY="ksm_numa" run_test ./ksm_tests -N -m 0
452
453CATEGORY="ksm" run_test ./ksm_functional_tests
454
455# protection_keys tests
456nr_hugepgs=$(cat /proc/sys/vm/nr_hugepages)
457if [ -x ./protection_keys_32 ]
458then
459	CATEGORY="pkey" run_test ./protection_keys_32
460fi
461
462if [ -x ./protection_keys_64 ]
463then
464	CATEGORY="pkey" run_test ./protection_keys_64
465fi
466echo "$nr_hugepgs" > /proc/sys/vm/nr_hugepages
467
468if [ -x ./soft-dirty ]
469then
470	CATEGORY="soft_dirty" run_test ./soft-dirty
471fi
472
473CATEGORY="pagemap" run_test ./pagemap_ioctl
474
475# COW tests
476CATEGORY="cow" run_test ./cow
477
478CATEGORY="thp" run_test ./khugepaged
479
480CATEGORY="thp" run_test ./khugepaged -s 2
481
482CATEGORY="thp" run_test ./transhuge-stress -d 20
483
484# Try to create XFS if not provided
485if [ -z "${SPLIT_HUGE_PAGE_TEST_XFS_PATH}" ]; then
486    if [ "${HAVE_HUGEPAGES}" = "1" ]; then
487	if test_selected "thp"; then
488	    if grep xfs /proc/filesystems &>/dev/null; then
489		XFS_IMG=$(mktemp /tmp/xfs_img_XXXXXX)
490		SPLIT_HUGE_PAGE_TEST_XFS_PATH=$(mktemp -d /tmp/xfs_dir_XXXXXX)
491		truncate -s 314572800 ${XFS_IMG}
492		mkfs.xfs -q ${XFS_IMG}
493		mount -o loop ${XFS_IMG} ${SPLIT_HUGE_PAGE_TEST_XFS_PATH}
494		MOUNTED_XFS=1
495	    fi
496	fi
497    fi
498fi
499
500CATEGORY="thp" run_test ./split_huge_page_test ${SPLIT_HUGE_PAGE_TEST_XFS_PATH}
501
502if [ -n "${MOUNTED_XFS}" ]; then
503    umount ${SPLIT_HUGE_PAGE_TEST_XFS_PATH}
504    rmdir ${SPLIT_HUGE_PAGE_TEST_XFS_PATH}
505    rm -f ${XFS_IMG}
506fi
507
508CATEGORY="migration" run_test ./migration
509
510CATEGORY="mkdirty" run_test ./mkdirty
511
512CATEGORY="mdwe" run_test ./mdwe_test
513
514CATEGORY="page_frag" run_test ./test_page_frag.sh smoke
515
516CATEGORY="page_frag" run_test ./test_page_frag.sh aligned
517
518CATEGORY="page_frag" run_test ./test_page_frag.sh nonaligned
519
520echo "SUMMARY: PASS=${count_pass} SKIP=${count_skip} FAIL=${count_fail}" | tap_prefix
521echo "1..${count_total}" | tap_output
522
523exit $exitcode
524