unistd-safer: add unit test
[gnulib.git] / lib / cloexec.c
1 /* closexec.c - set or clear the close-on-exec descriptor flag
2
3    Copyright (C) 1991, 2004, 2005, 2006, 2009 Free Software
4    Foundation, Inc.
5
6    This program is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19    The code is taken from glibc/manual/llio.texi  */
20
21 #include <config.h>
22
23 #include "cloexec.h"
24
25 #include <errno.h>
26 #include <fcntl.h>
27 #include <unistd.h>
28
29 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
30 /* Native Woe32 API.  */
31 # define WIN32_LEAN_AND_MEAN
32 # include <windows.h>
33 # include <io.h>
34 #endif
35
36
37 /* Set the `FD_CLOEXEC' flag of DESC if VALUE is true,
38    or clear the flag if VALUE is false.
39    Return 0 on success, or -1 on error with `errno' set.
40
41    Note that on MingW, this function does NOT protect DESC from being
42    inherited into spawned children.  Instead, either use dup_cloexec
43    followed by closing the original DESC, or use interfaces such as
44    open or pipe2 that accept flags like O_CLOEXEC to create DESC
45    non-inheritable in the first place.  */
46
47 int
48 set_cloexec_flag (int desc, bool value)
49 {
50 #if defined F_GETFD && defined F_SETFD
51
52   int flags = fcntl (desc, F_GETFD, 0);
53
54   if (0 <= flags)
55     {
56       int newflags = (value ? flags | FD_CLOEXEC : flags & ~FD_CLOEXEC);
57
58       if (flags == newflags
59           || fcntl (desc, F_SETFD, newflags) != -1)
60         return 0;
61     }
62
63   return -1;
64
65 #else
66
67   /* Use dup2 to reject invalid file descriptors; the cloexec flag
68      will be unaffected.  */
69   if (desc < 0)
70     {
71       errno = EBADF;
72       return -1;
73     }
74   return dup2 (desc, desc) == desc ? 0 : -1;
75
76 #endif
77 }
78
79
80 /* Duplicates a file handle FD, while marking the copy to be closed
81    prior to exec or spawn.  Returns -1 and sets errno if FD could not
82    be duplicated.  */
83
84 int
85 dup_cloexec (int fd)
86 {
87   int nfd;
88
89 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
90
91   /* Native Woe32 API.  */
92   HANDLE curr_process = GetCurrentProcess ();
93   HANDLE old_handle = (HANDLE) _get_osfhandle (fd);
94   HANDLE new_handle;
95   int mode;
96
97   if (old_handle == INVALID_HANDLE_VALUE
98       || (mode = setmode (fd, O_BINARY)) == -1)
99     {
100       /* fd is closed, or is open to no handle at all.
101          We cannot duplicate fd in this case, because _open_osfhandle
102          fails for an INVALID_HANDLE_VALUE argument.  */
103       errno = EBADF;
104       return -1;
105     }
106   setmode (fd, mode);
107
108   if (!DuplicateHandle (curr_process,               /* SourceProcessHandle */
109                         old_handle,                 /* SourceHandle */
110                         curr_process,               /* TargetProcessHandle */
111                         (PHANDLE) &new_handle,      /* TargetHandle */
112                         (DWORD) 0,                  /* DesiredAccess */
113                         FALSE,                      /* InheritHandle */
114                         DUPLICATE_SAME_ACCESS))     /* Options */
115     {
116       /* TODO: Translate GetLastError () into errno.  */
117       errno = EMFILE;
118       return -1;
119     }
120
121   nfd = _open_osfhandle ((long) new_handle, mode | O_NOINHERIT);
122   if (nfd < 0)
123     {
124       CloseHandle (new_handle);
125       errno = EMFILE;
126       return -1;
127     }
128
129 #  if REPLACE_FCHDIR
130   if (0 <= nfd)
131     nfd = _gl_register_dup (fd, nfd);
132 #  endif
133   return nfd;
134
135 #else /* !_WIN32 */
136
137   /* Unix API.  */
138
139 # ifdef F_DUPFD_CLOEXEC
140   nfd = fcntl (fd, F_DUPFD_CLOEXEC, 0);
141 #  if REPLACE_FCHDIR
142   if (0 <= nfd)
143     nfd = _gl_register_dup (fd, nfd);
144 #  endif
145
146 # else /* !F_DUPFD_CLOEXEC */
147   nfd = dup (fd);
148   if (0 <= nfd && set_cloexec_flag (nfd, true) < 0)
149     {
150       int saved_errno = errno;
151       close (nfd);
152       nfd = -1;
153       errno = saved_errno;
154     }
155 # endif /* !F_DUPFD_CLOEXEC */
156
157   return nfd;
158
159 #endif /* !_WIN32 */
160 }