lib/fd-safer.c

   1 /* Return a safer copy of a file descriptor.
   2
   3    Copyright (C) 2005, 2006, 2009 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 /* Written by Paul Eggert.  */
  19
  20 #include <config.h>
  21
  22 #include "unistd-safer.h"
  23
  24 #include <errno.h>
  25
  26 #include <unistd.h>
  27
  28 /* Return FD, unless FD would be a copy of standard input, output, or
  29    error; in that case, return a duplicate of FD, closing FD.  On
  30    failure to duplicate, close FD, set errno, and return -1.  Preserve
  31    errno if FD is negative, so that the caller can always inspect
  32    errno when the returned value is negative.
  33
  34    This function is usefully wrapped around functions that return file
  35    descriptors, e.g., fd_safer (open ("file", O_RDONLY)).  */
  36
  37 int
  38 fd_safer (int fd)
  39 {
  40   if (STDIN_FILENO <= fd && fd <= STDERR_FILENO)
  41     {
  42       int f = dup_safer (fd);
  43       int e = errno;
  44       close (fd);
  45       errno = e;
  46       fd = f;
  47     }
  48
  49   return fd;
  50 }
  51
  52 #if GNULIB_CLOEXEC
  53
  54 /* Return FD, unless FD would be a copy of standard input, output, or
  55    error; in that case, return a duplicate of FD, closing FD.  If FLAG
  56    contains O_CLOEXEC, the returned FD will have close-on-exec
  57    semantics.  On failure to duplicate, close FD, set errno, and
  58    return -1.  Preserve errno if FD is negative, so that the caller
  59    can always inspect errno when the returned value is negative.
  60
  61    This function is usefully wrapped around functions that return file
  62    descriptors, e.g., fd_safer_flag (open ("file", O_RDONLY | flag), flag).  */
  63
  64 int
  65 fd_safer_flag (int fd, int flag)
  66 {
  67   if (STDIN_FILENO <= fd && fd <= STDERR_FILENO)
  68     {
  69       int f = dup_safer_flag (fd, flag);
  70       int e = errno;
  71       close (fd);
  72       errno = e;
  73       fd = f;
  74     }
  75
  76   return fd;
  77 }
  78
  79 #endif /* GNULIB_CLOEXEC */