lib/utimens.c

   1 /* Set file access and modification times.
   2
   3    Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Free Software
   4    Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 3 of the License, or any
   9    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 /* Written by Paul Eggert.  */
  20
  21 /* derived from a function in touch.c */
  22
  23 #include <config.h>
  24
  25 #include "utimens.h"
  26
  27 #include <errno.h>
  28 #include <fcntl.h>
  29 #include <sys/stat.h>
  30 #include <sys/time.h>
  31 #include <unistd.h>
  32
  33 #if HAVE_UTIME_H
  34 # include <utime.h>
  35 #endif
  36
  37 /* Some systems (even some that do have <utime.h>) don't declare this
  38    structure anywhere.  */
  39 #ifndef HAVE_STRUCT_UTIMBUF
  40 struct utimbuf
  41 {
  42   long actime;
  43   long modtime;
  44 };
  45 #endif
  46
  47 /* Some systems don't have ENOSYS.  */
  48 #ifndef ENOSYS
  49 # ifdef ENOTSUP
  50 #  define ENOSYS ENOTSUP
  51 # else
  52 /* Some systems don't have ENOTSUP either.  */
  53 #  define ENOSYS EINVAL
  54 # endif
  55 #endif
  56
  57 #ifndef __attribute__
  58 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
  59 #  define __attribute__(x)
  60 # endif
  61 #endif
  62
  63 #ifndef ATTRIBUTE_UNUSED
  64 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
  65 #endif
  66
  67 /* Set the access and modification time stamps of FD (a.k.a. FILE) to be
  68    TIMESPEC[0] and TIMESPEC[1], respectively.
  69    FD must be either negative -- in which case it is ignored --
  70    or a file descriptor that is open on FILE.
  71    If FD is nonnegative, then FILE can be NULL, which means
  72    use just futimes (or equivalent) instead of utimes (or equivalent),
  73    and fail if on an old system without futimes (or equivalent).
  74    If TIMESPEC is null, set the time stamps to the current time.
  75    Return 0 on success, -1 (setting errno) on failure.  */
  76
  77 int
  78 gl_futimens (int fd ATTRIBUTE_UNUSED,
  79              char const *file, struct timespec const timespec[2])
  80 {
  81   /* Some Linux-based NFS clients are buggy, and mishandle time stamps
  82      of files in NFS file systems in some cases.  We have no
  83      configure-time test for this, but please see
  84      <http://bugs.gentoo.org/show_bug.cgi?id=132673> for references to
  85      some of the problems with Linux 2.6.16.  If this affects you,
  86      compile with -DHAVE_BUGGY_NFS_TIME_STAMPS; this is reported to
  87      help in some cases, albeit at a cost in performance.  But you
  88      really should upgrade your kernel to a fixed version, since the
  89      problem affects many applications.  */
  90
  91 #if HAVE_BUGGY_NFS_TIME_STAMPS
  92   if (fd < 0)
  93     sync ();
  94   else
  95     fsync (fd);
  96 #endif
  97
  98   /* POSIX 200x added two interfaces to set file timestamps with
  99      nanosecond resolution.  We provide a fallback for ENOSYS (for
 100      example, compiling against Linux 2.6.25 kernel headers and glibc
 101      2.7, but running on Linux 2.6.18 kernel).  */
 102 #if HAVE_UTIMENSAT
 103   if (fd < 0)
 104     {
 105       int result = utimensat (AT_FDCWD, file, timespec, 0);
 106 #ifdef __linux__
 107       /* Work around what might be a kernel bug:
 108          http://bugzilla.redhat.com/442352
 109          http://bugzilla.redhat.com/449910
 110          It appears that utimensat can mistakenly return 280 rather
 111          than 0 to indicate success.
 112          FIXME: remove in 2010 or whenever the offending kernels
 113          are no longer in common use.  */
 114       if (0 < result)
 115         result = 0;
 116 #endif
 117
 118       if (result == 0 || errno != ENOSYS)
 119         return result;
 120     }
 121 #endif
 122 #if HAVE_FUTIMENS
 123   {
 124     int result = futimens (fd, timespec);
 125     if (result == 0 || errno != ENOSYS)
 126       return result;
 127   }
 128 #endif
 129
 130   /* The platform lacks an interface to set file timestamps with
 131      nanosecond resolution, so do the best we can, discarding any
 132      fractional part of the timestamp.  */
 133   {
 134 #if HAVE_FUTIMESAT || HAVE_WORKING_UTIMES
 135     struct timeval timeval[2];
 136     struct timeval const *t;
 137     if (timespec)
 138       {
 139         timeval[0].tv_sec = timespec[0].tv_sec;
 140         timeval[0].tv_usec = timespec[0].tv_nsec / 1000;
 141         timeval[1].tv_sec = timespec[1].tv_sec;
 142         timeval[1].tv_usec = timespec[1].tv_nsec / 1000;
 143         t = timeval;
 144       }
 145     else
 146       t = NULL;
 147
 148     if (fd < 0)
 149       {
 150 # if HAVE_FUTIMESAT
 151         return futimesat (AT_FDCWD, file, t);
 152 # endif
 153       }
 154     else
 155       {
 156         /* If futimesat or futimes fails here, don't try to speed things
 157            up by returning right away.  glibc can incorrectly fail with
 158            errno == ENOENT if /proc isn't mounted.  Also, Mandrake 10.0
 159            in high security mode doesn't allow ordinary users to read
 160            /proc/self, so glibc incorrectly fails with errno == EACCES.
 161            If errno == EIO, EPERM, or EROFS, it's probably safe to fail
 162            right away, but these cases are rare enough that they're not
 163            worth optimizing, and who knows what other messed-up systems
 164            are out there?  So play it safe and fall back on the code
 165            below.  */
 166 # if HAVE_FUTIMESAT
 167         if (futimesat (fd, NULL, t) == 0)
 168           return 0;
 169 # elif HAVE_FUTIMES
 170         if (futimes (fd, t) == 0)
 171           return 0;
 172 # endif
 173       }
 174 #endif /* HAVE_FUTIMESAT || HAVE_WORKING_UTIMES */
 175
 176     if (!file)
 177       {
 178 #if ! (HAVE_FUTIMESAT || (HAVE_WORKING_UTIMES && HAVE_FUTIMES))
 179         errno = ENOSYS;
 180 #endif
 181
 182         /* Prefer EBADF to ENOSYS if both error numbers apply.  */
 183         if (errno == ENOSYS)
 184           {
 185             int fd2 = dup (fd);
 186             int dup_errno = errno;
 187             if (0 <= fd2)
 188               close (fd2);
 189             errno = (fd2 < 0 && dup_errno == EBADF ? EBADF : ENOSYS);
 190           }
 191
 192         return -1;
 193       }
 194
 195 #if HAVE_WORKING_UTIMES
 196     return utimes (file, t);
 197 #else
 198     {
 199       struct utimbuf utimbuf;
 200       struct utimbuf const *ut;
 201       if (timespec)
 202         {
 203           utimbuf.actime = timespec[0].tv_sec;
 204           utimbuf.modtime = timespec[1].tv_sec;
 205           ut = &utimbuf;
 206         }
 207       else
 208         ut = NULL;
 209
 210       return utime (file, ut);
 211     }
 212 #endif /* !HAVE_WORKING_UTIMES */
 213   }
 214 }
 215
 216 /* Set the access and modification time stamps of FILE to be
 217    TIMESPEC[0] and TIMESPEC[1], respectively.  */
 218 int
 219 utimens (char const *file, struct timespec const timespec[2])
 220 {
 221   return gl_futimens (-1, file, timespec);
 222 }