xref: /linux-6.15/tools/testing/vsock/README (revision cdbcc18d)
10b025033SStefan HajnocziAF_VSOCK test suite
20b025033SStefan Hajnoczi-------------------
30b025033SStefan HajnocziThese tests exercise net/vmw_vsock/ host<->guest sockets for VMware, KVM, and
40b025033SStefan HajnocziHyper-V.
50b025033SStefan Hajnoczi
60b025033SStefan HajnocziThe following tests are available:
70b025033SStefan Hajnoczi
8*cdbcc18dSStefan Hajnoczi  * vsock_test - core AF_VSOCK socket functionality
90b025033SStefan Hajnoczi  * vsock_diag_test - vsock_diag.ko module for listing open sockets
100b025033SStefan Hajnoczi
110b025033SStefan HajnocziThe following prerequisite steps are not automated and must be performed prior
120b025033SStefan Hajnoczito running tests:
130b025033SStefan Hajnoczi
1443985468SStefan Hajnoczi1. Build the kernel, make headers_install, and build these tests.
150b025033SStefan Hajnoczi2. Install the kernel and tests on the host.
160b025033SStefan Hajnoczi3. Install the kernel and tests inside the guest.
170b025033SStefan Hajnoczi4. Boot the guest and ensure that the AF_VSOCK transport is enabled.
180b025033SStefan Hajnoczi
190b025033SStefan HajnocziInvoke test binaries in both directions as follows:
200b025033SStefan Hajnoczi
210b025033SStefan Hajnoczi  # host=server, guest=client
220b025033SStefan Hajnoczi  (host)# $TEST_BINARY --mode=server \
230b025033SStefan Hajnoczi                       --control-port=1234 \
240b025033SStefan Hajnoczi                       --peer-cid=3
250b025033SStefan Hajnoczi  (guest)# $TEST_BINARY --mode=client \
260b025033SStefan Hajnoczi                        --control-host=$HOST_IP \
270b025033SStefan Hajnoczi                        --control-port=1234 \
280b025033SStefan Hajnoczi                        --peer-cid=2
290b025033SStefan Hajnoczi
300b025033SStefan Hajnoczi  # host=client, guest=server
310b025033SStefan Hajnoczi  (guest)# $TEST_BINARY --mode=server \
320b025033SStefan Hajnoczi                        --control-port=1234 \
330b025033SStefan Hajnoczi                        --peer-cid=2
340b025033SStefan Hajnoczi  (host)# $TEST_BINARY --mode=client \
350b025033SStefan Hajnoczi                       --control-port=$GUEST_IP \
360b025033SStefan Hajnoczi                       --control-port=1234 \
370b025033SStefan Hajnoczi                       --peer-cid=3
38