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