xref: /freebsd/tests/sys/kern/sendfile_test.sh (revision d746ab215cc85d8f7ab05c5f866c338782c390ec)
1# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
2#
3# Copyright (c) 2020 Netflix, Inc.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26# $FreeBSD$
27
28#
29# These tests exercise a few basic cases for the sendfile() syscall:
30# - successful operation.
31# - sendfile() starts an async disk read but that async I/O fails.
32# - sendfile() fails to read an indirect block and thus cannot
33#   even start an async I/O.
34#
35# In all cases we request some read ahead in addition to
36# the data to be sent to the socket.
37#
38
39MD_DEVS="md.devs"
40MNT=/mnt
41FILE=$MNT/file
42HELPER="$(atf_get_srcdir)/sendfile_helper"
43BSIZE=4096
44
45atf_test_case io_success cleanup
46io_success_head()
47{
48	atf_set "descr" "sendfile where all disk I/O succeeds"
49	atf_set "require.user" "root"
50	atf_set "timeout" 15
51}
52io_success_body()
53{
54	if [ "$(atf_config_get qemu false)" = "true" ]; then
55	    atf_skip "Sendfile(4) unimplemented. https://github.com/qemu-bsd-user/qemu-bsd-user/issues/25"
56	fi
57
58	md=$(alloc_md)
59	common_body_setup $md
60
61	atf_check $HELPER $FILE 0 0x10000 0x10000
62}
63io_success_cleanup()
64{
65	common_cleanup
66}
67
68atf_test_case io_fail_sync cleanup
69io_fail_sync_head()
70{
71	atf_set "descr" "sendfile where we fail to start async I/O"
72	atf_set "require.user" "root"
73	atf_set "timeout" 15
74}
75io_fail_sync_body()
76{
77	if [ "$(atf_config_get qemu false)" = "true" ]; then
78	    atf_skip "Sendfile(4) unimplemented. https://github.com/qemu-bsd-user/qemu-bsd-user/issues/25"
79	fi
80
81	md=$(alloc_md)
82	common_body_setup $md
83
84	atf_check gnop configure -r 100 -e 5 ${md}.nop
85	atf_check -s exit:3 -e ignore $HELPER $FILE $((12 * $BSIZE)) $BSIZE 0x10000
86}
87io_fail_sync_cleanup()
88{
89	common_cleanup
90}
91
92atf_test_case io_fail_async cleanup
93io_fail_async_head()
94{
95	atf_set "descr" "sendfile where an async I/O fails"
96	atf_set "require.user" "root"
97	atf_set "timeout" 15
98}
99io_fail_async_body()
100{
101	if [ "$(atf_config_get qemu false)" = "true" ]; then
102	    atf_skip "Sendfile(4) unimplemented. https://github.com/qemu-bsd-user/qemu-bsd-user/issues/25"
103	fi
104
105	md=$(alloc_md)
106	common_body_setup $md
107
108	atf_check gnop configure -r 100 -e 5 ${md}.nop
109	atf_check -s exit:2 -e ignore $HELPER $FILE 0 $BSIZE 0x10000
110}
111io_fail_async_cleanup()
112{
113	common_cleanup
114}
115
116
117atf_init_test_cases()
118{
119	atf_add_test_case io_success
120	atf_add_test_case io_fail_sync
121	atf_add_test_case io_fail_async
122}
123
124alloc_md()
125{
126	local md
127
128	md=$(mdconfig -a -t swap -s 256M) || atf_fail "mdconfig -a failed"
129	echo ${md} >> $MD_DEVS
130	echo ${md}
131}
132
133common_body_setup()
134{
135	us=$1
136
137	atf_check -o ignore -e ignore newfs -b $BSIZE -U -j /dev/${us}
138	atf_check mount /dev/${us} $MNT
139	atf_check -e ignore dd if=/dev/zero of=$FILE bs=1m count=1
140	atf_check umount /mnt
141
142	load_gnop
143	atf_check gnop create /dev/${us}
144	atf_check mount /dev/${us}.nop $MNT
145	atf_check -o ignore ls -l $MNT/file
146}
147
148common_cleanup()
149{
150	umount -f $MNT
151	if [ -f "$MD_DEVS" ]; then
152		while read test_md; do
153			gnop destroy -f ${test_md}.nop 2>/dev/null
154			mdconfig -d -u $test_md 2>/dev/null
155		done < $MD_DEVS
156		rm $MD_DEVS
157	fi
158
159	true
160}
161
162load_gnop()
163{
164	if ! kldstat -q -m g_nop; then
165		geom nop load || atf_skip "could not load module for geom nop"
166	fi
167}
168