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       if (result == 0 || errno != ENOSYS)
 107         return result;
 108     }
 109 #endif
 110 #if HAVE_FUTIMENS
 111   {
 112     int result = futimens (fd, timespec);
 113     if (result == 0 || errno != ENOSYS)
 114       return result;
 115   }
 116 #endif
 117
 118   /* The platform lacks an interface to set file timestamps with
 119      nanosecond resolution, so do the best we can, discarding any
 120      fractional part of the timestamp.  */
 121   {
 122 #if HAVE_FUTIMESAT || HAVE_WORKING_UTIMES
 123     struct timeval timeval[2];
 124     struct timeval const *t;
 125     if (timespec)
 126       {
 127         timeval[0].tv_sec = timespec[0].tv_sec;
 128         timeval[0].tv_usec = timespec[0].tv_nsec / 1000;
 129         timeval[1].tv_sec = timespec[1].tv_sec;
 130         timeval[1].tv_usec = timespec[1].tv_nsec / 1000;
 131         t = timeval;
 132       }
 133     else
 134       t = NULL;
 135
 136     if (fd < 0)
 137       {
 138 # if HAVE_FUTIMESAT
 139         return futimesat (AT_FDCWD, file, t);
 140 # endif
 141       }
 142     else
 143       {
 144         /* If futimesat or futimes fails here, don't try to speed things
 145            up by returning right away.  glibc can incorrectly fail with
 146            errno == ENOENT if /proc isn't mounted.  Also, Mandrake 10.0
 147            in high security mode doesn't allow ordinary users to read
 148            /proc/self, so glibc incorrectly fails with errno == EACCES.
 149            If errno == EIO, EPERM, or EROFS, it's probably safe to fail
 150            right away, but these cases are rare enough that they're not
 151            worth optimizing, and who knows what other messed-up systems
 152            are out there?  So play it safe and fall back on the code
 153            below.  */
 154 # if HAVE_FUTIMESAT
 155         if (futimesat (fd, NULL, t) == 0)
 156           return 0;
 157 # elif HAVE_FUTIMES
 158         if (futimes (fd, t) == 0)
 159           return 0;
 160 # endif
 161       }
 162 #endif /* HAVE_FUTIMESAT || HAVE_WORKING_UTIMES */
 163
 164     if (!file)
 165       {
 166 #if ! (HAVE_FUTIMESAT || (HAVE_WORKING_UTIMES && HAVE_FUTIMES))
 167         errno = ENOSYS;
 168 #endif
 169
 170         /* Prefer EBADF to ENOSYS if both error numbers apply.  */
 171         if (errno == ENOSYS)
 172           {
 173             int fd2 = dup (fd);
 174             int dup_errno = errno;
 175             if (0 <= fd2)
 176               close (fd2);
 177             errno = (fd2 < 0 && dup_errno == EBADF ? EBADF : ENOSYS);
 178           }
 179
 180         return -1;
 181       }
 182
 183 #if HAVE_WORKING_UTIMES
 184     return utimes (file, t);
 185 #else
 186     {
 187       struct utimbuf utimbuf;
 188       struct utimbuf const *ut;
 189       if (timespec)
 190         {
 191           utimbuf.actime = timespec[0].tv_sec;
 192           utimbuf.modtime = timespec[1].tv_sec;
 193           ut = &utimbuf;
 194         }
 195       else
 196         ut = NULL;
 197
 198       return utime (file, ut);
 199     }
 200 #endif /* !HAVE_WORKING_UTIMES */
 201   }
 202 }
 203
 204 /* Set the access and modification time stamps of FILE to be
 205    TIMESPEC[0] and TIMESPEC[1], respectively.  */
 206 int
 207 utimens (char const *file, struct timespec const timespec[2])
 208 {
 209   return gl_futimens (-1, file, timespec);
 210 }