xref: /xnu-11215/tests/sendmsg_x_test.c (revision 4f1223e8)
1 /*
2  * Copyright (c) 2022 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #include <sys/errno.h>
30 #include <sys/fcntl.h>
31 #include <sys/socket.h>
32 #include <stdio.h>
33 #include <stdint.h>
34 #include <string.h>
35 #include <sysexits.h>
36 #include <unistd.h>
37 #include <darwintest.h>
38 #include <darwintest_utils.h>
39 
40 /* -*- compile-command: "xcrun --sdk macosx.internal make -C tests sendmsg_x_test" -*- */
41 
42 T_GLOBAL_META(T_META_NAMESPACE("xnu.net"));
43 
44 #define DATAGRAM_SIZE 64
45 
46 T_DECL(sendmsg_x_test, "exercise sendmsg_x() return value",
47     T_META_TAG_VM_PREFERRED)
48 {
49 	int socket_fds[2];
50 
51 	T_EXPECT_POSIX_SUCCESS(socketpair(AF_UNIX, SOCK_DGRAM, 0, socket_fds), "socketpair");
52 
53 	/*
54 	 * The receive buffer size is too small for more than one datagram.
55 	 */
56 	int send_buffer_size = DATAGRAM_SIZE;
57 	int receive_buffer_size = DATAGRAM_SIZE + (DATAGRAM_SIZE >> 1);
58 	socklen_t opt_len = sizeof(int);
59 
60 	T_EXPECT_POSIX_SUCCESS(setsockopt(socket_fds[0], SOL_SOCKET, SO_SNDBUF, &send_buffer_size, opt_len), "setsockopt() SO_SNDBUF");
61 	T_EXPECT_POSIX_SUCCESS(setsockopt(socket_fds[0], SOL_SOCKET, SO_RCVBUF, &receive_buffer_size, opt_len), "setsockopt() SO_RCVBUF");
62 	T_EXPECT_POSIX_SUCCESS(setsockopt(socket_fds[1], SOL_SOCKET, SO_SNDBUF, &send_buffer_size, opt_len), "setsockopt() SO_SNDBUF");
63 	T_EXPECT_POSIX_SUCCESS(setsockopt(socket_fds[1], SOL_SOCKET, SO_RCVBUF, &receive_buffer_size, opt_len), "setsockopt() SO_RCVBUF");
64 
65 	/*
66 	 * Send two datagram at once, only one must be sent and received
67 	 */
68 	struct msghdr_x message_headers[2] = {};
69 
70 	uint8_t buffer1[DATAGRAM_SIZE];
71 	memset(buffer1, 0x12, DATAGRAM_SIZE);
72 
73 	struct iovec iovec1 = {
74 		.iov_base = buffer1,
75 		.iov_len = DATAGRAM_SIZE,
76 	};
77 	message_headers[0].msg_iov = &iovec1;
78 	message_headers[0].msg_iovlen = 1;
79 
80 	uint8_t buffer2[DATAGRAM_SIZE];
81 	memset(buffer2, 0x34, DATAGRAM_SIZE);
82 
83 	struct iovec iovec2 = {
84 		.iov_base = buffer2,
85 		.iov_len = DATAGRAM_SIZE,
86 	};
87 
88 	message_headers[1].msg_iov = &iovec2;
89 	message_headers[1].msg_iovlen = 1;
90 
91 	ssize_t sendmsg_x_result = sendmsg_x(socket_fds[0], message_headers, 2, 0);
92 	if (sendmsg_x_result < 0) {
93 		T_FAIL("sendmsg_x() failed: %s", strerror(errno));
94 	}
95 	if (sendmsg_x_result != 1) {
96 		T_FAIL("sendmsg_x() failed: return %zd instead of 1", sendmsg_x_result);
97 	}
98 	T_PASS("sendmsg_x() result: %zd == 1\n", sendmsg_x_result);
99 
100 	/*
101 	 * Receive the datagram we expect
102 	 */
103 	uint8_t receive_buffer1[DATAGRAM_SIZE * 2];
104 	ssize_t recv_result = recv(socket_fds[1], receive_buffer1, sizeof(receive_buffer1), 0);
105 	T_EXPECT_POSIX_SUCCESS(recv_result, "first recv() recv_result %zd errno %d", recv_result, errno);
106 
107 	if (recv_result != DATAGRAM_SIZE) {
108 		T_FAIL("recv() failed: return %zd instead of DATAGRAM_SIZE", recv_result);
109 	}
110 	T_PASS("recv() result: %zd == DATAGRAM_SIZE\n", recv_result);
111 
112 	int i;
113 	for (i = 0; i < DATAGRAM_SIZE; i++) {
114 		if (receive_buffer1[i] != 0x12) {
115 			T_FAIL("receive_buffer1[%d] 0x%x == 0x12", i, receive_buffer1[i]);
116 		}
117 	}
118 	T_PASS("First datagram successfully received.\n");
119 
120 	/*
121 	 * Set the receive socket as non-blocking and verify no more data is pending
122 	 */
123 	int flags = fcntl(socket_fds[1], F_GETFL, 0);
124 	T_EXPECT_POSIX_SUCCESS(fcntl(socket_fds[1], F_SETFL, flags | O_NONBLOCK), "fcntl() O_NONBLOCK");
125 
126 	recv_result = recv(socket_fds[1], receive_buffer1, sizeof(receive_buffer1), 0);
127 	T_EXPECT_POSIX_ERROR(errno, EWOULDBLOCK, "second recv() recv_result %zd errno %d", recv_result, errno);
128 
129 	close(socket_fds[0]);
130 	close(socket_fds[1]);
131 }
132