1 /*
2 * Copyright (c) 2020 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 <darwintest.h>
30 #include <fcntl.h>
31 #include <unistd.h>
32 #include <stdlib.h>
33 #include <sys/event.h>
34 #include <sys/mman.h>
35 #include <sys/socket.h>
36
37 T_GLOBAL_META(
38 T_META_NAMESPACE("xnu.syscall.pwrite"),
39 T_META_RUN_CONCURRENTLY(true)
40 );
41
42 static void
test_file_equals(int fd,const char * expected_buffer,size_t size)43 test_file_equals(int fd, const char* expected_buffer, size_t size)
44 {
45 T_ASSERT_POSIX_SUCCESS(lseek(fd, 0, SEEK_SET), "Reset file offset");
46 char* read_buffer = malloc(size);
47 T_ASSERT_TRUE(read_buffer != 0, "Allocated read_buffer");
48 T_ASSERT_EQ(read(fd, read_buffer, size), (ssize_t)size, "Read expected buffer");
49 T_ASSERT_EQ(strncmp(read_buffer, expected_buffer, size), 0, "Buffer as expected");
50 free(read_buffer);
51 }
52
53 T_DECL(pwrite_regular_file,
54 "test pwrite() on a regular file.") {
55 char scratchfile_path[] = "/tmp/scratch.XXXXXX";
56 int fd = mkstemp(scratchfile_path);
57 T_ASSERT_POSIX_SUCCESS(fd, "created temporary file");
58 T_ASSERT_POSIX_SUCCESS(unlink(scratchfile_path), "unlinked temporary file");
59
60 T_ASSERT_POSIX_SUCCESS(pwrite(fd, "a", 1, 1), "pwrite 'a' at offset 1");
61 test_file_equals(fd, "\0a", 2);
62
63 T_ASSERT_POSIX_SUCCESS(pwrite(fd, "bcd", 3, 0), "pwrite 'bcd' at offset 0");
64 test_file_equals(fd, "bcd", 3);
65 }
66
67 static void
test_pwrite_should_fail(int fd,int expected_errno)68 test_pwrite_should_fail(int fd, int expected_errno)
69 {
70 char input_buffer = 'A';
71 ssize_t pwrite_result = pwrite(fd, &input_buffer, 1, 0);
72 int err = errno;
73 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 0 size 1 returns -1");
74 T_ASSERT_EQ(err, expected_errno, "errno is as expected");
75 T_ASSERT_EQ(input_buffer, 'A', "input buffer is unchanged");
76
77 pwrite_result = pwrite(fd, &input_buffer, 1, 1);
78 err = errno;
79 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 1 size 1 returns -1");
80 T_ASSERT_EQ(err, expected_errno, "errno is as expected");
81 T_ASSERT_EQ(input_buffer, 'A', "input buffer is unchanged");
82
83 pwrite_result = pwrite(fd, &input_buffer, 0, 0);
84 err = errno;
85 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 0 size 0 returns -1");
86 T_ASSERT_EQ(err, expected_errno, "errno is as expected");
87 T_ASSERT_EQ(input_buffer, 'A', "input buffer is unchanged");
88
89 pwrite_result = pwrite(fd, &input_buffer, 0, 1);
90 err = errno;
91 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 1 size 0 returns -1");
92 T_ASSERT_EQ(err, expected_errno, "errno is as expected");
93 T_ASSERT_EQ(input_buffer, 'A', "input buffer is unchanged");
94 }
95
96 T_DECL(pwrite_socket,
97 "test pwrite() on a socket.") {
98 int sockets[2];
99 int result = socketpair(AF_UNIX, SOCK_STREAM, 0, sockets);
100 T_ASSERT_POSIX_SUCCESS(result, "Created socket pair");
101
102 test_pwrite_should_fail(sockets[0], ESPIPE);
103 test_pwrite_should_fail(sockets[1], ESPIPE);
104
105 T_ASSERT_POSIX_SUCCESS(close(sockets[0]), "Closed socket 0");
106 T_ASSERT_POSIX_SUCCESS(close(sockets[1]), "Closed socket 1");
107 }
108
109 T_DECL(pwrite_unix_shared_memory,
110 "test pwrite() on unix shared memory.") {
111 const char* memory_path = "test_pwrite_unix_shared_memory";
112 int shm_fd = shm_open(memory_path, O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
113 T_ASSERT_POSIX_SUCCESS(shm_fd, "Created shared memory");
114
115 test_pwrite_should_fail(shm_fd, ESPIPE);
116
117 T_ASSERT_POSIX_SUCCESS(close(shm_fd), "Closed shm fd");
118 T_ASSERT_POSIX_SUCCESS(shm_unlink(memory_path), "Unlinked");
119 }
120
121 T_DECL(pwrite_kqueue,
122 "test pwrite() on kqueue.") {
123 int queue = kqueue();
124 T_ASSERT_POSIX_SUCCESS(queue, "Got kqueue");
125
126 test_pwrite_should_fail(queue, ESPIPE);
127
128 T_ASSERT_POSIX_SUCCESS(close(queue), "Close queue");
129 }
130
131 T_DECL(pwrite_pipe,
132 "test pwrite() on pipe.") {
133 int pipe_fds[2];
134 T_ASSERT_POSIX_SUCCESS(pipe(pipe_fds), "Created pipe");
135
136 test_pwrite_should_fail(pipe_fds[0], EBADF);
137 test_pwrite_should_fail(pipe_fds[1], ESPIPE);
138
139 T_ASSERT_POSIX_SUCCESS(close(pipe_fds[1]), "Close write pipe");
140 T_ASSERT_POSIX_SUCCESS(close(pipe_fds[0]), "Close read pipe");
141 }
142
143 T_DECL(pwrite_write_to_dev_null,
144 "test pwrite() from null.") {
145 int fd = open("/dev/null", O_RDONLY);
146 T_ASSERT_POSIX_SUCCESS(fd, "Opened /dev/null");
147
148 char buffer = 'A';
149 errno = 0;
150 ssize_t pwrite_result = pwrite(fd, &buffer, 1, 0);
151 int err = errno;
152 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 0 size 1 returns -1");
153 T_ASSERT_EQ(err, EBADF, "pwrite on /dev/null results in EBADF");
154
155 errno = 0;
156 pwrite_result = pwrite(fd, &buffer, 1, 1);
157 err = errno;
158 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 1 size 1 returns -1");
159 T_ASSERT_EQ(buffer, 'A', "input buffer is unchanged");
160 T_ASSERT_EQ(err, EBADF, "pwrite on /dev/null results in EBADF");
161
162 errno = 0;
163 pwrite_result = pwrite(fd, &buffer, 0, 0);
164 err = errno;
165 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 0 size 0 returns -1");
166 T_ASSERT_EQ(err, EBADF, "pwrite on /dev/null results in EBADF");
167 T_ASSERT_EQ(buffer, 'A', "input buffer is unchanged");
168
169 errno = 0;
170 pwrite_result = pwrite(fd, &buffer, 0, 1);
171 err = errno;
172 T_ASSERT_EQ(pwrite_result, (ssize_t)-1, "pwrite offset 1 size 0 returns -1");
173 T_ASSERT_EQ(err, EBADF, "pwrite on /dev/null results in EBADF");
174 T_ASSERT_EQ(buffer, 'A', "input buffer is unchanged");
175
176 T_ASSERT_POSIX_SUCCESS(close(fd), "Closed /dev/null");
177 }
178