lib/open.c

   1 /* Open a descriptor to a file.
   2    Copyright (C) 2007-2009 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>.  */
  16
  17 /* Written by Bruno Haible <bruno@clisp.org>, 2007.  */
  18
  19 #include <config.h>
  20
  21 /* Get the original definition of open.  It might be defined as a macro.  */
  22 #define __need_system_fcntl_h
  23 #include <fcntl.h>
  24 #undef __need_system_fcntl_h
  25 #include <sys/types.h>
  26
  27 static inline int
  28 orig_open (const char *filename, int flags, mode_t mode)
  29 {
  30   return open (filename, flags, mode);
  31 }
  32
  33 /* Specification.  */
  34 #include <fcntl.h>
  35
  36 #include <errno.h>
  37 #include <stdarg.h>
  38 #include <string.h>
  39 #include <sys/types.h>
  40 #include <sys/stat.h>
  41
  42 #ifndef REPLACE_OPEN_DIRECTORY
  43 # define REPLACE_OPEN_DIRECTORY 0
  44 #endif
  45
  46 int
  47 open (const char *filename, int flags, ...)
  48 {
  49   mode_t mode;
  50   int fd;
  51
  52   mode = 0;
  53   if (flags & O_CREAT)
  54     {
  55       va_list arg;
  56       va_start (arg, flags);
  57
  58       /* We have to use PROMOTED_MODE_T instead of mode_t, otherwise GCC 4
  59          creates crashing code when 'mode_t' is smaller than 'int'.  */
  60       mode = va_arg (arg, PROMOTED_MODE_T);
  61
  62       va_end (arg);
  63     }
  64
  65 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
  66   if (strcmp (filename, "/dev/null") == 0)
  67     filename = "NUL";
  68 #endif
  69
  70 #if OPEN_TRAILING_SLASH_BUG
  71   /* If the filename ends in a slash and one of O_CREAT, O_WRONLY, O_RDWR
  72      is specified, then fail.
  73      Rationale: POSIX <http://www.opengroup.org/susv3/basedefs/xbd_chap04.html>
  74      says that
  75        "A pathname that contains at least one non-slash character and that
  76         ends with one or more trailing slashes shall be resolved as if a
  77         single dot character ( '.' ) were appended to the pathname."
  78      and
  79        "The special filename dot shall refer to the directory specified by
  80         its predecessor."
  81      If the named file already exists as a directory, then
  82        - if O_CREAT is specified, open() must fail because of the semantics
  83          of O_CREAT,
  84        - if O_WRONLY or O_RDWR is specified, open() must fail because POSIX
  85          <http://www.opengroup.org/susv3/functions/open.html> says that it
  86          fails with errno = EISDIR in this case.
  87      If the named file does not exist or does not name a directory, then
  88        - if O_CREAT is specified, open() must fail since open() cannot create
  89          directories,
  90        - if O_WRONLY or O_RDWR is specified, open() must fail because the
  91          file does not contain a '.' directory.  */
  92   if (flags & (O_CREAT | O_WRONLY | O_RDWR))
  93     {
  94       size_t len = strlen (filename);
  95       if (len > 0 && filename[len - 1] == '/')
  96         {
  97           errno = EISDIR;
  98           return -1;
  99         }
 100     }
 101 #endif
 102
 103   fd = orig_open (filename, flags, mode);
 104
 105 #ifdef FCHDIR_REPLACEMENT
 106   /* Implementing fchdir and fdopendir requires the ability to open a
 107      directory file descriptor.  If open doesn't support that (as on
 108      mingw), we use a dummy file that behaves the same as directories
 109      on Linux (ie. always reports EOF on attempts to read()), and
 110      override fstat() in fchdir.c to hide the fact that we have a
 111      dummy.  */
 112   if (REPLACE_OPEN_DIRECTORY && fd < 0 && errno == EACCES
 113       && (mode & O_ACCMODE) == O_RDONLY)
 114     {
 115       struct stat statbuf;
 116       if (stat (filename, &statbuf) == 0 && S_ISDIR (statbuf.st_mode))
 117         {
 118           /* Maximum recursion depth of 1.  */
 119           fd = open ("/dev/null", flags, mode);
 120           if (0 <= fd)
 121             fd = _gl_register_fd (fd, filename);
 122         }
 123       else
 124         errno = EACCES;
 125     }
 126 #endif
 127
 128 #if OPEN_TRAILING_SLASH_BUG
 129   /* If the filename ends in a slash and fd does not refer to a directory,
 130      then fail.
 131      Rationale: POSIX <http://www.opengroup.org/susv3/basedefs/xbd_chap04.html>
 132      says that
 133        "A pathname that contains at least one non-slash character and that
 134         ends with one or more trailing slashes shall be resolved as if a
 135         single dot character ( '.' ) were appended to the pathname."
 136      and
 137        "The special filename dot shall refer to the directory specified by
 138         its predecessor."
 139      If the named file without the slash is not a directory, open() must fail
 140      with ENOTDIR.  */
 141   if (fd >= 0)
 142     {
 143       size_t len = strlen (filename);
 144       if (len > 0 && filename[len - 1] == '/')
 145         {
 146           struct stat statbuf;
 147
 148           if (fstat (fd, &statbuf) >= 0 && !S_ISDIR (statbuf.st_mode))
 149             {
 150               close (fd);
 151               errno = ENOTDIR;
 152               return -1;
 153             }
 154         }
 155     }
 156 #endif
 157
 158 #ifdef FCHDIR_REPLACEMENT
 159   if (!REPLACE_OPEN_DIRECTORY && 0 <= fd)
 160     fd = _gl_register_fd (fd, filename);
 161 #endif
 162
 163   return fd;
 164 }