cloexec: add dup_cloexec
[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   if (desc < 0)
68     {
69       errno = EBADF;
70       return -1;
71     }
72   return dup2 (desc, desc) == desc ? 0 : -1;
73
74 #endif
75 }
76
77
78 /* Duplicates a file handle FD, while marking the copy to be closed
79    prior to exec or spawn.  Returns -1 and sets errno if FD could not
80    be duplicated.  */
81
82 int dup_cloexec (int fd)
83 {
84   int nfd;
85
86 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
87
88   /* Native Woe32 API.  */
89   HANDLE curr_process = GetCurrentProcess ();
90   HANDLE old_handle = (HANDLE) _get_osfhandle (fd);
91   HANDLE new_handle;
92
93   if (old_handle == INVALID_HANDLE_VALUE)
94     {
95       /* fd is closed, or is open to no handle at all.
96          We cannot duplicate fd in this case, because _open_osfhandle
97          fails for an INVALID_HANDLE_VALUE argument.  */
98       errno = EBADF;
99       return -1;
100     }
101
102   if (!DuplicateHandle (curr_process,               /* SourceProcessHandle */
103                         old_handle,                 /* SourceHandle */
104                         curr_process,               /* TargetProcessHandle */
105                         (PHANDLE) &new_handle,      /* TargetHandle */
106                         (DWORD) 0,                  /* DesiredAccess */
107                         FALSE,                      /* InheritHandle */
108                         DUPLICATE_SAME_ACCESS))     /* Options */
109     {
110       errno = EMFILE;
111       return -1;
112     }
113
114   nfd = _open_osfhandle ((long) new_handle, O_BINARY | O_NOINHERIT);
115   if (nfd < 0)
116     {
117       CloseHandle (new_handle);
118       errno = EMFILE;
119       return -1;
120     }
121
122 #  if REPLACE_FCHDIR
123   if (0 <= nfd)
124     result = _gl_register_dup (fd, nfd);
125 #  endif
126   return nfd;
127
128 #else /* !_WIN32 */
129
130   /* Unix API.  */
131
132 # ifdef F_DUPFD_CLOEXEC
133   nfd = fcntl (fd, F_DUPFD_CLOEXEC, 0);
134 #  if REPLACE_FCHDIR
135   if (0 <= nfd)
136     result = _gl_register_dup (fd, nfd);
137 #  endif
138
139 # else /* !F_DUPFD_CLOEXEC */
140   nfd = dup (fd);
141   if (0 <= nfd && set_cloexec_flag (nfd, true))
142     {
143       int saved_errno = errno;
144       close (nfd);
145       nfd = -1;
146       errno = saved_errno;
147     }
148 # endif /* !F_DUPFD_CLOEXEC */
149
150   return nfd;
151
152 #endif /* !_WIN32 */
153 }