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