2 Copyright (C) 2009-2013 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17 /* Written by Eric Blake <ebb9@byu.net>, 2009. */
24 #include "signature.h"
25 SIGNATURE_CHECK (fcntl, int, (int, int, ...));
33 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
34 /* Get declarations of the native Windows API functions. */
35 # define WIN32_LEAN_AND_MEAN
37 /* Get _get_osfhandle. */
38 # include "msvc-nothrow.h"
41 #include "binary-io.h"
45 # define setmode(f,m) zero ()
46 static int zero (void) { return 0; }
49 /* Return true if FD is open. */
53 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
54 /* On native Windows, the initial state of unassigned standard file
55 descriptors is that they are open but point to an
56 INVALID_HANDLE_VALUE, and there is no fcntl. */
57 return (HANDLE) _get_osfhandle (fd) != INVALID_HANDLE_VALUE;
60 # error Please port fcntl to your platform
62 return 0 <= fcntl (fd, F_GETFL);
66 /* Return true if FD is open and inheritable across exec/spawn. */
68 is_inheritable (int fd)
70 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
71 /* On native Windows, the initial state of unassigned standard file
72 descriptors is that they are open but point to an
73 INVALID_HANDLE_VALUE, and there is no fcntl. */
74 HANDLE h = (HANDLE) _get_osfhandle (fd);
76 if (h == INVALID_HANDLE_VALUE || GetHandleInformation (h, &flags) == 0)
78 return (flags & HANDLE_FLAG_INHERIT) != 0;
81 # error Please port fcntl to your platform
83 int i = fcntl (fd, F_GETFD);
84 return 0 <= i && (i & FD_CLOEXEC) == 0;
88 /* Return non-zero if FD is open in the given MODE, which is either
89 O_TEXT or O_BINARY. */
91 is_mode (int fd, int mode)
93 int value = setmode (fd, O_BINARY);
98 /* Since native fcntl can have more supported operations than our
99 replacement is aware of, and since various operations assign
100 different types to the vararg argument, a wrapper around fcntl must
101 be able to pass a vararg of unknown type on through to the original
102 fcntl. Make sure that this works properly: func1 behaves like the
103 original fcntl interpreting the vararg as an int or a pointer to a
104 struct, and func2 behaves like rpl_fcntl that doesn't know what
118 i = va_arg (arg, int);
121 struct dummy_struct *s = va_arg (arg, struct dummy_struct *);
133 p = va_arg (arg, void *);
138 /* Ensure that all supported fcntl actions are distinct, and
139 usable in preprocessor expressions. */
149 case F_DUPFD_CLOEXEC:
212 const char *file = "test-fcntl.tmp";
214 int bad_fd = getdtablesize ();
216 /* Sanity check that rpl_fcntl is likely to work. */
217 ASSERT (func2 (1, 2) == 2);
218 ASSERT (func2 (2, -2) == -2);
219 ASSERT (func2 (3, 0x80000000) == 0x80000000);
221 struct dummy_struct s = { 0L, 4 };
222 ASSERT (func2 (4, &s) == 4);
226 /* Assume std descriptors were provided by invoker, and ignore fds
227 that might have been inherited. */
228 fd = creat (file, 0600);
229 ASSERT (STDERR_FILENO < fd);
233 /* For F_DUPFD*, the source must be valid. */
235 ASSERT (fcntl (-1, F_DUPFD, 0) == -1);
236 ASSERT (errno == EBADF);
238 ASSERT (fcntl (fd + 1, F_DUPFD, 0) == -1);
239 ASSERT (errno == EBADF);
241 ASSERT (fcntl (bad_fd, F_DUPFD, 0) == -1);
242 ASSERT (errno == EBADF);
244 ASSERT (fcntl (-1, F_DUPFD_CLOEXEC, 0) == -1);
245 ASSERT (errno == EBADF);
247 ASSERT (fcntl (fd + 1, F_DUPFD_CLOEXEC, 0) == -1);
248 ASSERT (errno == EBADF);
250 ASSERT (fcntl (bad_fd, F_DUPFD_CLOEXEC, 0) == -1);
251 ASSERT (errno == EBADF);
253 /* For F_DUPFD*, the destination must be valid. */
255 ASSERT (fcntl (fd, F_DUPFD, -1) == -1);
256 ASSERT (errno == EINVAL);
258 ASSERT (fcntl (fd, F_DUPFD, bad_fd) == -1);
259 ASSERT (errno == EINVAL);
261 ASSERT (fcntl (fd, F_DUPFD_CLOEXEC, -1) == -1);
262 ASSERT (errno == EINVAL);
264 ASSERT (fcntl (fd, F_DUPFD_CLOEXEC, bad_fd) == -1);
265 ASSERT (errno == EINVAL);
267 /* For F_DUPFD*, check for correct inheritance, as well as
268 preservation of text vs. binary. */
269 setmode (fd, O_BINARY);
270 ASSERT (is_open (fd));
271 ASSERT (!is_open (fd + 1));
272 ASSERT (!is_open (fd + 2));
273 ASSERT (is_inheritable (fd));
274 ASSERT (is_mode (fd, O_BINARY));
276 ASSERT (fcntl (fd, F_DUPFD, fd) == fd + 1);
277 ASSERT (is_open (fd));
278 ASSERT (is_open (fd + 1));
279 ASSERT (!is_open (fd + 2));
280 ASSERT (is_inheritable (fd + 1));
281 ASSERT (is_mode (fd, O_BINARY));
282 ASSERT (is_mode (fd + 1, O_BINARY));
283 ASSERT (close (fd + 1) == 0);
285 ASSERT (fcntl (fd, F_DUPFD_CLOEXEC, fd + 2) == fd + 2);
286 ASSERT (is_open (fd));
287 ASSERT (!is_open (fd + 1));
288 ASSERT (is_open (fd + 2));
289 ASSERT (is_inheritable (fd));
290 ASSERT (!is_inheritable (fd + 2));
291 ASSERT (is_mode (fd, O_BINARY));
292 ASSERT (is_mode (fd + 2, O_BINARY));
293 ASSERT (close (fd) == 0);
295 setmode (fd + 2, O_TEXT);
296 ASSERT (fcntl (fd + 2, F_DUPFD, fd + 1) == fd + 1);
297 ASSERT (!is_open (fd));
298 ASSERT (is_open (fd + 1));
299 ASSERT (is_open (fd + 2));
300 ASSERT (is_inheritable (fd + 1));
301 ASSERT (!is_inheritable (fd + 2));
302 ASSERT (is_mode (fd + 1, O_TEXT));
303 ASSERT (is_mode (fd + 2, O_TEXT));
304 ASSERT (close (fd + 1) == 0);
306 ASSERT (fcntl (fd + 2, F_DUPFD_CLOEXEC, 0) == fd);
307 ASSERT (is_open (fd));
308 ASSERT (!is_open (fd + 1));
309 ASSERT (is_open (fd + 2));
310 ASSERT (!is_inheritable (fd));
311 ASSERT (!is_inheritable (fd + 2));
312 ASSERT (is_mode (fd, O_TEXT));
313 ASSERT (is_mode (fd + 2, O_TEXT));
314 ASSERT (close (fd + 2) == 0);
316 /* Test F_GETFD on invalid file descriptors. */
318 ASSERT (fcntl (-1, F_GETFD) == -1);
319 ASSERT (errno == EBADF);
321 ASSERT (fcntl (fd + 1, F_GETFD) == -1);
322 ASSERT (errno == EBADF);
324 ASSERT (fcntl (bad_fd, F_GETFD) == -1);
325 ASSERT (errno == EBADF);
327 /* Test F_GETFD, the FD_CLOEXEC bit. */
329 int result = fcntl (fd, F_GETFD);
330 ASSERT (0 <= result);
331 ASSERT ((result & FD_CLOEXEC) == FD_CLOEXEC);
332 ASSERT (dup (fd) == fd + 1);
333 result = fcntl (fd + 1, F_GETFD);
334 ASSERT (0 <= result);
335 ASSERT ((result & FD_CLOEXEC) == 0);
336 ASSERT (close (fd + 1) == 0);
340 /* Test F_SETFD on invalid file descriptors. */
342 ASSERT (fcntl (-1, F_SETFD, 0) == -1);
343 ASSERT (errno == EBADF);
345 ASSERT (fcntl (fd + 1, F_SETFD, 0) == -1);
346 ASSERT (errno == EBADF);
348 ASSERT (fcntl (bad_fd, F_SETFD, 0) == -1);
349 ASSERT (errno == EBADF);
353 /* Test F_GETFL on invalid file descriptors. */
355 ASSERT (fcntl (-1, F_GETFL) == -1);
356 ASSERT (errno == EBADF);
358 ASSERT (fcntl (fd + 1, F_GETFL) == -1);
359 ASSERT (errno == EBADF);
361 ASSERT (fcntl (bad_fd, F_GETFL) == -1);
362 ASSERT (errno == EBADF);
366 /* Test F_SETFL on invalid file descriptors. */
368 ASSERT (fcntl (-1, F_SETFL, 0) == -1);
369 ASSERT (errno == EBADF);
371 ASSERT (fcntl (fd + 1, F_SETFL, 0) == -1);
372 ASSERT (errno == EBADF);
374 ASSERT (fcntl (bad_fd, F_SETFL, 0) == -1);
375 ASSERT (errno == EBADF);
379 /* Test F_GETOWN on invalid file descriptors. */
381 ASSERT (fcntl (-1, F_GETOWN) == -1);
382 ASSERT (errno == EBADF);
384 ASSERT (fcntl (fd + 1, F_GETOWN) == -1);
385 ASSERT (errno == EBADF);
387 ASSERT (fcntl (bad_fd, F_GETOWN) == -1);
388 ASSERT (errno == EBADF);
392 /* Test F_SETFL on invalid file descriptors. */
394 ASSERT (fcntl (-1, F_SETOWN, 0) == -1);
395 ASSERT (errno == EBADF);
397 ASSERT (fcntl (fd + 1, F_SETOWN, 0) == -1);
398 ASSERT (errno == EBADF);
400 ASSERT (fcntl (bad_fd, F_SETOWN, 0) == -1);
401 ASSERT (errno == EBADF);
405 ASSERT (close (fd) == 0);
406 ASSERT (unlink (file) == 0);