pintos-os.org Git - pspp/blob - lib/utimens.c

   1 /* Set file access and modification times.
   2
   3    Copyright (C) 2003-2009 Free Software Foundation, Inc.
   4
   5    This program is free software: you can redistribute it and/or modify it
   6    under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; either version 3 of the License, or any
   8    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 /* derived from a function in touch.c */
  21
  22 #include <config.h>
  23
  24 #include "utimens.h"
  25
  26 #include <assert.h>
  27 #include <errno.h>
  28 #include <fcntl.h>
  29 #include <stdbool.h>
  30 #include <sys/stat.h>
  31 #include <sys/time.h>
  32 #include <unistd.h>
  33
  34 #include "stat-time.h"
  35 #include "timespec.h"
  36
  37 #if HAVE_UTIME_H
  38 # include <utime.h>
  39 #endif
  40
  41 /* Some systems (even some that do have <utime.h>) don't declare this
  42    structure anywhere.  */
  43 #ifndef HAVE_STRUCT_UTIMBUF
  44 struct utimbuf
  45 {
  46   long actime;
  47   long modtime;
  48 };
  49 #endif
  50
  51 /* Avoid recursion with rpl_futimens or rpl_utimensat.  */
  52 #undef futimens
  53 #undef utimensat
  54
  55 /* Solaris 9 mistakenly succeeds when given a non-directory with a
  56    trailing slash.  Force the use of rpl_stat for a fix.  */
  57 #ifndef REPLACE_FUNC_STAT_FILE
  58 # define REPLACE_FUNC_STAT_FILE 0
  59 #endif
  60
  61 #if HAVE_UTIMENSAT || HAVE_FUTIMENS
  62 /* Cache variables for whether the utimensat syscall works; used to
  63    avoid calling the syscall if we know it will just fail with ENOSYS,
  64    and to avoid unnecessary work in massaging timestamps if the
  65    syscall will work.  Multiple variables are needed, to distinguish
  66    between the following scenarios on Linux:
  67    utimensat doesn't exist, or is in glibc but kernel 2.6.18 fails with ENOSYS
  68    kernel 2.6.22 and earlier rejects AT_SYMLINK_NOFOLLOW
  69    kernel 2.6.25 and earlier reject UTIME_NOW/UTIME_OMIT with non-zero tv_sec
  70    kernel 2.6.32 used with xfs or ntfs-3g fail to honor UTIME_OMIT
  71    utimensat completely works
  72    For each cache variable: 0 = unknown, 1 = yes, -1 = no.  */
  73 static int utimensat_works_really;
  74 static int lutimensat_works_really;
  75 #endif /* HAVE_UTIMENSAT || HAVE_FUTIMENS */
  76
  77 /* Validate the requested timestamps.  Return 0 if the resulting
  78    timespec can be used for utimensat (after possibly modifying it to
  79    work around bugs in utimensat).  Return a positive value if the
  80    timespec needs further adjustment based on stat results: 1 if any
  81    adjustment is needed for utimes, and 2 if any adjustment is needed
  82    for Linux utimensat.  Return -1, with errno set to EINVAL, if
  83    timespec is out of range.  */
  84 static int
  85 validate_timespec (struct timespec timespec[2])
  86 {
  87   int result = 0;
  88   int utime_omit_count = 0;
  89   assert (timespec);
  90   if ((timespec[0].tv_nsec != UTIME_NOW
  91        && timespec[0].tv_nsec != UTIME_OMIT
  92        && (timespec[0].tv_nsec < 0 || 1000000000 <= timespec[0].tv_nsec))
  93       || (timespec[1].tv_nsec != UTIME_NOW
  94           && timespec[1].tv_nsec != UTIME_OMIT
  95           && (timespec[1].tv_nsec < 0 || 1000000000 <= timespec[1].tv_nsec)))
  96     {
  97       errno = EINVAL;
  98       return -1;
  99     }
 100   /* Work around Linux kernel 2.6.25 bug, where utimensat fails with
 101      EINVAL if tv_sec is not 0 when using the flag values of tv_nsec.
 102      Flag a Linux kernel 2.6.32 bug, where an mtime of UTIME_OMIT
 103      fails to bump ctime.  */
 104   if (timespec[0].tv_nsec == UTIME_NOW
 105       || timespec[0].tv_nsec == UTIME_OMIT)
 106     {
 107       timespec[0].tv_sec = 0;
 108       result = 1;
 109       if (timespec[0].tv_nsec == UTIME_OMIT)
 110         utime_omit_count++;
 111     }
 112   if (timespec[1].tv_nsec == UTIME_NOW
 113       || timespec[1].tv_nsec == UTIME_OMIT)
 114     {
 115       timespec[1].tv_sec = 0;
 116       result = 1;
 117       if (timespec[1].tv_nsec == UTIME_OMIT)
 118         utime_omit_count++;
 119     }
 120   return result + (utime_omit_count == 1);
 121 }
 122
 123 /* Normalize any UTIME_NOW or UTIME_OMIT values in *TS, using stat
 124    buffer STATBUF to obtain the current timestamps of the file.  If
 125    both times are UTIME_NOW, set *TS to NULL (as this can avoid some
 126    permissions issues).  If both times are UTIME_OMIT, return true
 127    (nothing further beyond the prior collection of STATBUF is
 128    necessary); otherwise return false.  */
 129 static bool
 130 update_timespec (struct stat const *statbuf, struct timespec *ts[2])
 131 {
 132   struct timespec *timespec = *ts;
 133   if (timespec[0].tv_nsec == UTIME_OMIT
 134       && timespec[1].tv_nsec == UTIME_OMIT)
 135     return true;
 136   if (timespec[0].tv_nsec == UTIME_NOW
 137       && timespec[1].tv_nsec == UTIME_NOW)
 138     {
 139       *ts = NULL;
 140       return false;
 141     }
 142
 143   if (timespec[0].tv_nsec == UTIME_OMIT)
 144     timespec[0] = get_stat_atime (statbuf);
 145   else if (timespec[0].tv_nsec == UTIME_NOW)
 146     gettime (&timespec[0]);
 147
 148   if (timespec[1].tv_nsec == UTIME_OMIT)
 149     timespec[1] = get_stat_mtime (statbuf);
 150   else if (timespec[1].tv_nsec == UTIME_NOW)
 151     gettime (&timespec[1]);
 152
 153   return false;
 154 }
 155
 156 /* Set the access and modification time stamps of FD (a.k.a. FILE) to be
 157    TIMESPEC[0] and TIMESPEC[1], respectively.
 158    FD must be either negative -- in which case it is ignored --
 159    or a file descriptor that is open on FILE.
 160    If FD is nonnegative, then FILE can be NULL, which means
 161    use just futimes (or equivalent) instead of utimes (or equivalent),
 162    and fail if on an old system without futimes (or equivalent).
 163    If TIMESPEC is null, set the time stamps to the current time.
 164    Return 0 on success, -1 (setting errno) on failure.  */
 165
 166 int
 167 fdutimens (char const *file, int fd, struct timespec const timespec[2])
 168 {
 169   struct timespec adjusted_timespec[2];
 170   struct timespec *ts = timespec ? adjusted_timespec : NULL;
 171   int adjustment_needed = 0;
 172   struct stat st;
 173
 174   if (ts)
 175     {
 176       adjusted_timespec[0] = timespec[0];
 177       adjusted_timespec[1] = timespec[1];
 178       adjustment_needed = validate_timespec (ts);
 179     }
 180   if (adjustment_needed < 0)
 181     return -1;
 182
 183   /* Require that at least one of FD or FILE are valid.  Works around
 184      a Linux bug where futimens (AT_FDCWD, NULL) changes "." rather
 185      than failing.  */
 186   if (!file)
 187     {
 188       if (fd < 0)
 189         {
 190           errno = EBADF;
 191           return -1;
 192         }
 193       if (dup2 (fd, fd) != fd)
 194         return -1;
 195     }
 196
 197   /* Some Linux-based NFS clients are buggy, and mishandle time stamps
 198      of files in NFS file systems in some cases.  We have no
 199      configure-time test for this, but please see
 200      <http://bugs.gentoo.org/show_bug.cgi?id=132673> for references to
 201      some of the problems with Linux 2.6.16.  If this affects you,
 202      compile with -DHAVE_BUGGY_NFS_TIME_STAMPS; this is reported to
 203      help in some cases, albeit at a cost in performance.  But you
 204      really should upgrade your kernel to a fixed version, since the
 205      problem affects many applications.  */
 206
 207 #if HAVE_BUGGY_NFS_TIME_STAMPS
 208   if (fd < 0)
 209     sync ();
 210   else
 211     fsync (fd);
 212 #endif
 213
 214   /* POSIX 2008 added two interfaces to set file timestamps with
 215      nanosecond resolution; newer Linux implements both functions via
 216      a single syscall.  We provide a fallback for ENOSYS (for example,
 217      compiling against Linux 2.6.25 kernel headers and glibc 2.7, but
 218      running on Linux 2.6.18 kernel).  */
 219 #if HAVE_UTIMENSAT || HAVE_FUTIMENS
 220   if (0 <= utimensat_works_really)
 221     {
 222       int result;
 223 # if __linux__
 224       /* As recently as Linux kernel 2.6.32 (Dec 2009), several file
 225          systems (xfs, ntfs-3g) have bugs with a single UTIME_OMIT,
 226          but work if both times are either explicitly specified or
 227          UTIME_NOW.  Work around it with a preparatory [f]stat prior
 228          to calling futimens/utimensat; fortunately, there is not much
 229          timing impact due to the extra syscall even on file systems
 230          where UTIME_OMIT would have worked.  FIXME: Simplify this in
 231          2012, when file system bugs are no longer common.  */
 232       if (adjustment_needed == 2)
 233         {
 234           if (fd < 0 ? stat (file, &st) : fstat (fd, &st))
 235             return -1;
 236           if (ts[0].tv_nsec == UTIME_OMIT)
 237             ts[0] = get_stat_atime (&st);
 238           else if (ts[1].tv_nsec == UTIME_OMIT)
 239             ts[1] = get_stat_mtime (&st);
 240           /* Note that st is good, in case utimensat gives ENOSYS.  */
 241           adjustment_needed++;
 242         }
 243 # endif /* __linux__ */
 244 # if HAVE_UTIMENSAT
 245       if (fd < 0)
 246         {
 247           result = utimensat (AT_FDCWD, file, ts, 0);
 248 #  ifdef __linux__
 249           /* Work around a kernel bug:
 250              http://bugzilla.redhat.com/442352
 251              http://bugzilla.redhat.com/449910
 252              It appears that utimensat can mistakenly return 280 rather
 253              than -1 upon ENOSYS failure.
 254              FIXME: remove in 2010 or whenever the offending kernels
 255              are no longer in common use.  */
 256           if (0 < result)
 257             errno = ENOSYS;
 258 #  endif /* __linux__ */
 259           if (result == 0 || errno != ENOSYS)
 260             {
 261               utimensat_works_really = 1;
 262               return result;
 263             }
 264         }
 265 # endif /* HAVE_UTIMENSAT */
 266 # if HAVE_FUTIMENS
 267       {
 268         result = futimens (fd, ts);
 269 #  ifdef __linux__
 270         /* Work around the same bug as above.  */
 271         if (0 < result)
 272           errno = ENOSYS;
 273 #  endif /* __linux__ */
 274         if (result == 0 || errno != ENOSYS)
 275           {
 276             utimensat_works_really = 1;
 277             return result;
 278           }
 279       }
 280 # endif /* HAVE_FUTIMENS */
 281     }
 282   utimensat_works_really = -1;
 283   lutimensat_works_really = -1;
 284 #endif /* HAVE_UTIMENSAT || HAVE_FUTIMENS */
 285
 286   /* The platform lacks an interface to set file timestamps with
 287      nanosecond resolution, so do the best we can, discarding any
 288      fractional part of the timestamp.  */
 289
 290   if (adjustment_needed || (REPLACE_FUNC_STAT_FILE && fd < 0))
 291     {
 292       if (adjustment_needed != 3
 293           && (fd < 0 ? stat (file, &st) : fstat (fd, &st)))
 294         return -1;
 295       if (ts && update_timespec (&st, &ts))
 296         return 0;
 297     }
 298
 299   {
 300 #if HAVE_FUTIMESAT || HAVE_WORKING_UTIMES
 301     struct timeval timeval[2];
 302     struct timeval const *t;
 303     if (ts)
 304       {
 305         timeval[0].tv_sec = ts[0].tv_sec;
 306         timeval[0].tv_usec = ts[0].tv_nsec / 1000;
 307         timeval[1].tv_sec = ts[1].tv_sec;
 308         timeval[1].tv_usec = ts[1].tv_nsec / 1000;
 309         t = timeval;
 310       }
 311     else
 312       t = NULL;
 313
 314     if (fd < 0)
 315       {
 316 # if HAVE_FUTIMESAT
 317         return futimesat (AT_FDCWD, file, t);
 318 # endif
 319       }
 320     else
 321       {
 322         /* If futimesat or futimes fails here, don't try to speed things
 323            up by returning right away.  glibc can incorrectly fail with
 324            errno == ENOENT if /proc isn't mounted.  Also, Mandrake 10.0
 325            in high security mode doesn't allow ordinary users to read
 326            /proc/self, so glibc incorrectly fails with errno == EACCES.
 327            If errno == EIO, EPERM, or EROFS, it's probably safe to fail
 328            right away, but these cases are rare enough that they're not
 329            worth optimizing, and who knows what other messed-up systems
 330            are out there?  So play it safe and fall back on the code
 331            below.  */
 332 # if HAVE_FUTIMESAT && !FUTIMESAT_NULL_BUG
 333         if (futimesat (fd, NULL, t) == 0)
 334           return 0;
 335 # elif HAVE_FUTIMES
 336         if (futimes (fd, t) == 0)
 337           return 0;
 338 # endif
 339       }
 340 #endif /* HAVE_FUTIMESAT || HAVE_WORKING_UTIMES */
 341
 342     if (!file)
 343       {
 344 #if ! ((HAVE_FUTIMESAT && !FUTIMESAT_NULL_BUG)          \
 345         || (HAVE_WORKING_UTIMES && HAVE_FUTIMES))
 346         errno = ENOSYS;
 347 #endif
 348         return -1;
 349       }
 350
 351 #if HAVE_WORKING_UTIMES
 352     return utimes (file, t);
 353 #else
 354     {
 355       struct utimbuf utimbuf;
 356       struct utimbuf *ut;
 357       if (ts)
 358         {
 359           utimbuf.actime = ts[0].tv_sec;
 360           utimbuf.modtime = ts[1].tv_sec;
 361           ut = &utimbuf;
 362         }
 363       else
 364         ut = NULL;
 365
 366       return utime (file, ut);
 367     }
 368 #endif /* !HAVE_WORKING_UTIMES */
 369   }
 370 }
 371
 372 /* Set the access and modification time stamps of FD (a.k.a. FILE) to be
 373    TIMESPEC[0] and TIMESPEC[1], respectively.
 374    FD must be either negative -- in which case it is ignored --
 375    or a file descriptor that is open on FILE.
 376    If FD is nonnegative, then FILE can be NULL, which means
 377    use just futimes (or equivalent) instead of utimes (or equivalent),
 378    and fail if on an old system without futimes (or equivalent).
 379    If TIMESPEC is null, set the time stamps to the current time.
 380    Return 0 on success, -1 (setting errno) on failure.  */
 381
 382 int
 383 gl_futimens (int fd, char const *file, struct timespec const timespec[2])
 384 {
 385   return fdutimens (file, fd, timespec);
 386 }
 387
 388 /* Set the access and modification time stamps of FILE to be
 389    TIMESPEC[0] and TIMESPEC[1], respectively.  */
 390 int
 391 utimens (char const *file, struct timespec const timespec[2])
 392 {
 393   return fdutimens (file, -1, timespec);
 394 }
 395
 396 /* Set the access and modification time stamps of FILE to be
 397    TIMESPEC[0] and TIMESPEC[1], respectively, without dereferencing
 398    symlinks.  Fail with ENOSYS if the platform does not support
 399    changing symlink timestamps, but FILE was a symlink.  */
 400 int
 401 lutimens (char const *file, struct timespec const timespec[2])
 402 {
 403   struct timespec adjusted_timespec[2];
 404   struct timespec *ts = timespec ? adjusted_timespec : NULL;
 405   int adjustment_needed = 0;
 406   struct stat st;
 407
 408   if (ts)
 409     {
 410       adjusted_timespec[0] = timespec[0];
 411       adjusted_timespec[1] = timespec[1];
 412       adjustment_needed = validate_timespec (ts);
 413     }
 414   if (adjustment_needed < 0)
 415     return -1;
 416
 417   /* The Linux kernel did not support symlink timestamps until
 418      utimensat, in version 2.6.22, so we don't need to mimic
 419      gl_futimens' worry about buggy NFS clients.  But we do have to
 420      worry about bogus return values.  */
 421
 422 #if HAVE_UTIMENSAT
 423   if (0 <= lutimensat_works_really)
 424     {
 425       int result;
 426 # if __linux__
 427       /* As recently as Linux kernel 2.6.32 (Dec 2009), several file
 428          systems (xfs, ntfs-3g) have bugs with a single UTIME_OMIT,
 429          but work if both times are either explicitly specified or
 430          UTIME_NOW.  Work around it with a preparatory lstat prior to
 431          calling utimensat; fortunately, there is not much timing
 432          impact due to the extra syscall even on file systems where
 433          UTIME_OMIT would have worked.  FIXME: Simplify this in 2012,
 434          when file system bugs are no longer common.  */
 435       if (adjustment_needed == 2)
 436         {
 437           if (lstat (file, &st))
 438             return -1;
 439           if (ts[0].tv_nsec == UTIME_OMIT)
 440             ts[0] = get_stat_atime (&st);
 441           else if (ts[1].tv_nsec == UTIME_OMIT)
 442             ts[1] = get_stat_mtime (&st);
 443           /* Note that st is good, in case utimensat gives ENOSYS.  */
 444           adjustment_needed++;
 445         }
 446 # endif /* __linux__ */
 447       result = utimensat (AT_FDCWD, file, ts, AT_SYMLINK_NOFOLLOW);
 448 # ifdef __linux__
 449       /* Work around a kernel bug:
 450          http://bugzilla.redhat.com/442352
 451          http://bugzilla.redhat.com/449910
 452          It appears that utimensat can mistakenly return 280 rather
 453          than -1 upon ENOSYS failure.
 454          FIXME: remove in 2010 or whenever the offending kernels
 455          are no longer in common use.  */
 456       if (0 < result)
 457         errno = ENOSYS;
 458 # endif
 459       if (result == 0 || errno != ENOSYS)
 460         {
 461           utimensat_works_really = 1;
 462           lutimensat_works_really = 1;
 463           return result;
 464         }
 465     }
 466   lutimensat_works_really = -1;
 467 #endif /* HAVE_UTIMENSAT */
 468
 469   /* The platform lacks an interface to set file timestamps with
 470      nanosecond resolution, so do the best we can, discarding any
 471      fractional part of the timestamp.  */
 472
 473   if (adjustment_needed || REPLACE_FUNC_STAT_FILE)
 474     {
 475       if (adjustment_needed != 3 && lstat (file, &st))
 476         return -1;
 477       if (ts && update_timespec (&st, &ts))
 478         return 0;
 479     }
 480
 481   /* On Linux, lutimes is a thin wrapper around utimensat, so there is
 482      no point trying lutimes if utimensat failed with ENOSYS.  */
 483 #if HAVE_LUTIMES && !HAVE_UTIMENSAT
 484   {
 485     struct timeval timeval[2];
 486     struct timeval const *t;
 487     int result;
 488     if (ts)
 489       {
 490         timeval[0].tv_sec = ts[0].tv_sec;
 491         timeval[0].tv_usec = ts[0].tv_nsec / 1000;
 492         timeval[1].tv_sec = ts[1].tv_sec;
 493         timeval[1].tv_usec = ts[1].tv_nsec / 1000;
 494         t = timeval;
 495       }
 496     else
 497       t = NULL;
 498
 499     result = lutimes (file, t);
 500     if (result == 0 || errno != ENOSYS)
 501       return result;
 502   }
 503 #endif /* HAVE_LUTIMES && !HAVE_UTIMENSAT */
 504
 505   /* Out of luck for symlinks, but we still handle regular files.  */
 506   if (!(adjustment_needed || REPLACE_FUNC_STAT_FILE) && lstat (file, &st))
 507     return -1;
 508   if (!S_ISLNK (st.st_mode))
 509     return fdutimens (file, -1, ts);
 510   errno = ENOSYS;
 511   return -1;
 512 }