tests: net: socketpair: use do not alias read and write

cfriedt · carlescufi · commit b9fe11c7f25f · 2023-02-20T11:04:07.000+01:00
* do not define `read`, `write`, as different symbols
* use `recv`, and `send` as defined by
  `CONFIG_NET_SOCKETS_POSIX_NAMES`
* do not specify `(2)` as manual-page sections are
  somewhat irrelevant

Note: we use `CONFIG_NET_SOCKETS_POSIX_NAMES` here, and
`CONFIG_POSIX_API` in `samples/` to show that the socketpair
API is available in both configurations.

Signed-off-by: Chris Friedt &lt;cfriedt@meta.com&gt;
diff --git a/tests/net/socket/socketpair/src/_main.h b/tests/net/socket/socketpair/src/_main.h
@@ -22,12 +22,6 @@
 #include <zephyr/posix/unistd.h>
 #endif
 
-#undef read
-#define read(fd, buf, len) zsock_recv(fd, buf, len, 0)
-
-#undef write
-#define write(fd, buf, len) zsock_send(fd, buf, len, 0)
-
 LOG_MODULE_DECLARE(net_test, CONFIG_NET_SOCKETS_LOG_LEVEL);
 
 extern struct k_work_q test_socketpair_work_q;
diff --git a/tests/net/socket/socketpair/src/block.c b/tests/net/socket/socketpair/src/block.c
@@ -43,13 +43,12 @@ static void work_handler(struct k_work *work)
 	LOG_DBG("%sing 1 byte %s fd %d", ctx.write ? "read" : "writ",
 		ctx.write ? "from" : "to", ctx.fd);
 	if (ctx.write) {
-		res = read(ctx.fd, &c, 1);
+		res = recv(ctx.fd, &c, 1, 0);
 	} else {
-		res = write(ctx.fd, "x", 1);
+		res = send(ctx.fd, "x", 1, 0);
 	}
 	if (-1 == res || 1 != res) {
-		LOG_DBG("%s(2) failed: %d", ctx.write ? "read" : "write",
-			errno);
+		LOG_DBG("%s() failed: %d", ctx.write ? "recv" : "send", errno);
 	} else {
 		LOG_DBG("%s 1 byte", ctx.write ? "read" : "wrote");
 	}
@@ -62,7 +61,7 @@ ZTEST(net_socketpair, write_block)
 
 	LOG_DBG("creating socketpair..");
 	res = socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
-	zassert_equal(res, 0, "socketpair(2) failed: %d", errno);
+	zassert_equal(res, 0, "socketpair() failed: %d", errno);
 
 	for (size_t i = 0; i < 2; ++i) {
 
@@ -81,9 +80,8 @@ ZTEST(net_socketpair, write_block)
 		for (ctx.m = 0; atomic_get(&ctx.m)
 			< CONFIG_NET_SOCKETPAIR_BUFFER_SIZE;) {
 
-			res = write(sv[i], "x", 1);
-			zassert_not_equal(res, -1, "write(2) failed: %d",
-				errno);
+			res = send(sv[i], "x", 1, 0);
+			zassert_not_equal(res, -1, "send() failed: %d", errno);
 			zassert_equal(res, 1, "wrote %d bytes instead of 1",
 				res);
 
@@ -93,8 +91,8 @@ ZTEST(net_socketpair, write_block)
 
 		/* try to write one more byte */
 		LOG_DBG("writing to fd %d", sv[i]);
-		res = write(sv[i], "x", 1);
-		zassert_not_equal(res, -1, "write(2) failed: %d", errno);
+		res = send(sv[i], "x", 1, 0);
+		zassert_not_equal(res, -1, "send() failed: %d", errno);
 		zassert_equal(res, 1, "wrote %d bytes instead of 1", res);
 
 		LOG_DBG("success!");
@@ -112,7 +110,7 @@ ZTEST(net_socketpair, read_block)
 
 	LOG_DBG("creating socketpair..");
 	res = socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
-	zassert_equal(res, 0, "socketpair(2) failed: %d", errno);
+	zassert_equal(res, 0, "socketpair() failed: %d", errno);
 
 	for (size_t i = 0; i < 2; ++i) {
 
@@ -130,8 +128,8 @@ ZTEST(net_socketpair, read_block)
 		/* try to read one byte */
 		LOG_DBG("reading from fd %d", sv[i]);
 		x = '\0';
-		res = read(sv[i], &x, 1);
-		zassert_not_equal(res, -1, "read(2) failed: %d", errno);
+		res = recv(sv[i], &x, 1, 0);
+		zassert_not_equal(res, -1, "recv() failed: %d", errno);
 		zassert_equal(res, 1, "read %d bytes instead of 1", res);
 
 		LOG_DBG("success!");
diff --git a/tests/net/socket/socketpair/src/closed_ends.c b/tests/net/socket/socketpair/src/closed_ends.c
@@ -12,13 +12,13 @@ ZTEST_USER(net_socketpair, close_one_end_and_write_to_the_other)
 
 	for (size_t i = 0; i < 2; ++i) {
 		res = socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
-		zassert_equal(res, 0, "socketpair(2) failed: %d", errno);
+		zassert_equal(res, 0, "socketpair() failed: %d", errno);
 
 		res = close(sv[i]);
 		zassert_equal(res, 0, "close(sv[%u]) failed: %d", i, errno);
 
-		res = write(sv[(!i) & 1], "x", 1);
-		zassert_equal(res, -1, "expected write(2) to fail");
+		res = send(sv[(!i) & 1], "x", 1, 0);
+		zassert_equal(res, -1, "expected send() to fail");
 		zassert_equal(res, -1, "errno: expected: EPIPE actual: %d",
 			errno);
 
@@ -35,29 +35,28 @@ ZTEST_USER(net_socketpair, close_one_end_and_read_from_the_other)
 
 	for (size_t i = 0; i < 2; ++i) {
 		res = socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
-		zassert_equal(res, 0, "socketpair(2) failed: %d", errno);
+		zassert_equal(res, 0, "socketpair() failed: %d", errno);
 
 		/* We want to write some bytes to the closing end of the
 		 * socket before it gets shut down, so that we can prove that
 		 * reading is possible from the other end still and that data
 		 * is not lost.
 		 */
-		res = write(sv[i], "xx", 2);
-		zassert_not_equal(res, -1, "write(2) failed: %d", errno);
-		zassert_equal(res, 2, "write(2) failed to write 2 bytes");
+		res = send(sv[i], "xx", 2, 0);
+		zassert_not_equal(res, -1, "send() failed: %d", errno);
+		zassert_equal(res, 2, "write() failed to write 2 bytes");
 
 		res = close(sv[i]);
 		zassert_equal(res, 0, "close(sv[%u]) failed: %d", i, errno);
 
 		memset(xx, 0, sizeof(xx));
-		res = read(sv[(!i) & 1], xx, sizeof(xx));
-		zassert_not_equal(res, -1, "read(2) failed: %d", errno);
+		res = recv(sv[(!i) & 1], xx, sizeof(xx), 0);
+		zassert_not_equal(res, -1, "read() failed: %d", errno);
 		zassert_equal(res, 2, "expected to read 2 bytes but read %d",
 			res);
 
-		res = read(sv[(!i) & 1], xx, sizeof(xx));
-		zassert_equal(res, 0,
-			"expected read(2) to succeed but read 0 bytes");
+		res = recv(sv[(!i) & 1], xx, sizeof(xx), 0);
+		zassert_equal(res, 0, "expected read() to succeed but read 0 bytes");
 
 		res = close(sv[(!i) & 1]);
 		zassert_equal(res, 0, "close(sv[%u]) failed: %d", i, errno);
diff --git a/tests/net/socket/socketpair/src/happy_path.c b/tests/net/socket/socketpair/src/happy_path.c
@@ -35,40 +35,12 @@ static void happy_path(
 	for (int i = 0; i < 2; ++i) {
 
 		/*
-		 * Test with write(2) / read(2)
-		 */
-
-		LOG_DBG("calling write(%d, '%s', %u)", sv[i], expected_msg,
-			expected_msg_len);
-		res = write(sv[i], expected_msg, expected_msg_len);
-
-		zassert_not_equal(res, -1, "write(2) failed: %d", errno);
-		actual_msg_len = res;
-		zassert_equal(actual_msg_len, expected_msg_len,
-				  "did not write entire message");
-
-		memset(actual_msg, 0, sizeof(actual_msg));
-
-		LOG_DBG("calling read(%d, %p, %u)", sv[i], actual_msg,
-			(unsigned int)sizeof(actual_msg));
-		res = read(sv[(!i) & 1], actual_msg, sizeof(actual_msg));
-
-		zassert_not_equal(res, -1, "read(2) failed: %d", errno);
-		actual_msg_len = res;
-		zassert_equal(actual_msg_len, expected_msg_len,
-			      "wrong return value");
-
-		zassert_true(strncmp(expected_msg, actual_msg,
-			actual_msg_len) == 0,
-			"the wrong message was passed through the socketpair");
-
-		/*
-		 * Test with send(2) / recv(2)
+		 * Test with send() / recv()
 		 */
 
 		res = send(sv[i], expected_msg, expected_msg_len, 0);
 
-		zassert_not_equal(res, -1, "send(2) failed: %d", errno);
+		zassert_not_equal(res, -1, "send() failed: %d", errno);
 		actual_msg_len = res;
 		zassert_equal(actual_msg_len, expected_msg_len,
 				  "did not send entire message");
@@ -77,7 +49,7 @@ static void happy_path(
 
 		res = recv(sv[(!i) & 1], actual_msg, sizeof(actual_msg), 0);
 
-		zassert_not_equal(res, -1, "recv(2) failed: %d", errno);
+		zassert_not_equal(res, -1, "recv() failed: %d", errno);
 		actual_msg_len = res;
 		zassert_equal(actual_msg_len, expected_msg_len,
 			      "wrong return value");
@@ -92,7 +64,7 @@ static void happy_path(
 
 		res = sendto(sv[i], expected_msg, expected_msg_len, 0, NULL, 0);
 
-		zassert_not_equal(res, -1, "sendto(2) failed: %d", errno);
+		zassert_not_equal(res, -1, "sendto() failed: %d", errno);
 		actual_msg_len = res;
 		zassert_equal(actual_msg_len, expected_msg_len,
 				  "did not sendto entire message");
@@ -102,7 +74,7 @@ static void happy_path(
 		len = 0;
 		res = recvfrom(sv[(!i) & 1], actual_msg, sizeof(actual_msg), 0,
 			NULL, &len);
-		zassert_true(res >= 0, "recvfrom(2) failed: %d", errno);
+		zassert_true(res >= 0, "recvfrom() failed: %d", errno);
 		actual_msg_len = res;
 		zassert_equal(actual_msg_len, expected_msg_len,
 			      "wrong return value");
@@ -123,14 +95,14 @@ static void happy_path(
 
 		res = sendmsg(sv[i], &msghdr, 0);
 
-		zassert_not_equal(res, -1, "sendmsg(2) failed: %d", errno);
+		zassert_not_equal(res, -1, "sendmsg() failed: %d", errno);
 		actual_msg_len = res;
 		zassert_equal(actual_msg_len, expected_msg_len,
 				  "did not sendmsg entire message");
 
-		res = read(sv[(!i) & 1], actual_msg, sizeof(actual_msg));
+		res = recv(sv[(!i) & 1], actual_msg, sizeof(actual_msg), 0);
 
-		zassert_not_equal(res, -1, "read(2) failed: %d", errno);
+		zassert_not_equal(res, -1, "recv() failed: %d", errno);
 		actual_msg_len = res;
 		zassert_equal(actual_msg_len, expected_msg_len,
 			      "wrong return value");
diff --git a/tests/net/socket/socketpair/src/nonblock.c b/tests/net/socket/socketpair/src/nonblock.c
@@ -12,14 +12,14 @@ ZTEST_USER(net_socketpair, write_nonblock)
 	int sv[2] = {-1, -1};
 
 	res = socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
-	zassert_equal(res, 0, "socketpair(2) failed: %d", errno);
+	zassert_equal(res, 0, "socketpair() failed: %d", errno);
 
 	for (size_t i = 0; i < 2; ++i) {
 		/* first, fill up the buffer */
 		for (size_t k = 0; k < CONFIG_NET_SOCKETPAIR_BUFFER_SIZE;
 			++k) {
-			res = write(sv[i], "x", 1);
-			zassert_equal(res, 1, "write(2) failed: %d", errno);
+			res = send(sv[i], "x", 1, 0);
+			zassert_equal(res, 1, "send() failed: %d", errno);
 		}
 
 		/* then set the O_NONBLOCK flag */
@@ -30,8 +30,8 @@ ZTEST_USER(net_socketpair, write_nonblock)
 		zassert_not_equal(res, -1, "fcntl() failed: %d", i, errno);
 
 		/* then, try to write one more byte */
-		res = write(sv[i], "x", 1);
-		zassert_equal(res, -1, "expected write to fail");
+		res = send(sv[i], "x", 1, 0);
+		zassert_equal(res, -1, "expected send to fail");
 		zassert_equal(errno, EAGAIN, "errno: expected: EAGAIN "
 			"actual: %d", errno);
 	}
@@ -47,7 +47,7 @@ ZTEST_USER(net_socketpair, read_nonblock)
 	char c;
 
 	res = socketpair(AF_UNIX, SOCK_STREAM, 0, sv);
-	zassert_equal(res, 0, "socketpair(2) failed: %d", errno);
+	zassert_equal(res, 0, "socketpair() failed: %d", errno);
 
 	for (size_t i = 0; i < 2; ++i) {
 		/* set the O_NONBLOCK flag */
@@ -58,8 +58,8 @@ ZTEST_USER(net_socketpair, read_nonblock)
 		zassert_not_equal(res, -1, "fcntl() failed: %d", i, errno);
 
 		/* then, try to read one byte */
-		res = read(sv[i], &c, 1);
-		zassert_equal(res, -1, "expected read to fail");
+		res = recv(sv[i], &c, 1, 0);
+		zassert_equal(res, -1, "expected recv() to fail");
 		zassert_equal(errno, EAGAIN, "errno: expected: EAGAIN "
 			"actual: %d", errno);
 	}
diff --git a/tests/net/socket/socketpair/src/poll.c b/tests/net/socket/socketpair/src/poll.c
