consolidate and simplify utime

src/fs_time_futimens.icpp → src/fs_base_utime.hpp

@@ -14,13 +14,20 @@
   OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
-#include <fcntl.h>
-#include <sys/stat.h>
+#ifdef __linux__
+# include "fs_base_utime_utimensat.hpp"
+#elif __FreeBSD__ >= 11
+# include "fs_base_utime_utimensat.hpp"
+#else
+# include "fs_base_utime_generic.hpp"
+#endif
 
 namespace fs
 {
+  static
+  inline
   int
-  utimes(const int          fd,
+  utime(const std::string &path,
         const struct stat &st)
   {
     struct timespec times[2];
@@ -28,6 +35,29 @@ namespace fs
     times[0] = st.st_atim;
     times[1] = st.st_mtim;
 
-    return ::futimens(fd,times);
+    return fs::utime(AT_FDCWD,path,times,0);
+  }
+
+  static
+  inline
+  int
+  utime(const int          fd,
+        const struct stat &st)
+  {
+    struct timespec times[2];
+
+    times[0] = st.st_atim;
+    times[1] = st.st_mtim;
+
+    return fs::utime(fd,times);
+  }
+
+  static
+  inline
+  int
+  lutime(const std::string     &path,
+         const struct timespec  times[2])
+  {
+    return fs::utime(AT_FDCWD,path,times,AT_SYMLINK_NOFOLLOW);
   }
 }

src/fs_base_utime_generic.hpp

@@ -0,0 +1,298 @@
+/*
+  ISC License
+
+  Copyright (c) 2016, Antonio SJ Musumeci <trapexit@spawn.link>
+
+  Permission to use, copy, modify, and/or distribute this software for any
+  purpose with or without fee is hereby granted, provided that the above
+  copyright notice and this permission notice appear in all copies.
+
+  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+#include <string>
+
+#include <fcntl.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+
+#ifndef UTIME_NOW
+# define UTIME_NOW  ((1l << 30) - 1l)
+#endif
+
+#ifndef UTIME_OMIT
+# define UTIME_OMIT ((1l << 30) - 2l)
+#endif
+
+static
+inline
+bool
+_can_call_lutimes(const int          dirfd,
+                  const std::string &path,
+                  const int          flags)
+{
+  return ((flags == AT_SYMLINK_NOFOLLOW) &&
+          ((dirfd == AT_FDCWD) ||
+           (path[0] == '/')));
+}
+
+static
+inline
+bool
+_should_ignore(const struct timespec ts[2])
+{
+  return ((ts != NULL) &&
+          (ts[0].tv_nsec == UTIME_OMIT) &&
+          (ts[1].tv_nsec == UTIME_OMIT));
+}
+
+static
+inline
+bool
+_should_be_set_to_now(const struct timespec ts[2])
+{
+  return ((ts == NULL) ||
+          ((ts[0].tv_nsec == UTIME_NOW) &&
+           (ts[1].tv_nsec == UTIME_NOW)));
+}
+
+static
+inline
+bool
+_timespec_invalid(const struct timespec &ts)
+{
+  return (((ts.tv_nsec < 0) ||
+           (ts.tv_nsec > 999999999)) &&
+          ((ts.tv_nsec != UTIME_NOW) &&
+           (ts.tv_nsec != UTIME_OMIT)));
+}
+
+static
+inline
+bool
+_timespec_invalid(const struct timespec ts[2])
+{
+  return ((ts != NULL) &&
+          (_timespec_invalid(ts[0]) ||
+           _timespec_invalid(ts[1])));
+}
+
+static
+inline
+bool
+_flags_invalid(const int flags)
+{
+  return ((flags & ~AT_SYMLINK_NOFOLLOW) != 0);
+}
+
+static
+inline
+bool
+_any_timespec_is_utime_omit(const struct timespec ts[2])
+{
+  return ((ts[0].tv_nsec == UTIME_OMIT) ||
+          (ts[1].tv_nsec == UTIME_OMIT));
+}
+
+static
+inline
+bool
+_any_timespec_is_utime_now(const struct timespec ts[2])
+{
+  return ((ts[0].tv_nsec == UTIME_NOW) ||
+          (ts[1].tv_nsec == UTIME_NOW));
+}
+
+static
+inline
+int
+_set_utime_omit_to_current_value(const int              dirfd,
+                                 const std::string     &path,
+                                 const struct timespec  ts[2],
+                                 struct timeval         tv[2],
+                                 const int              flags)
+{
+  int rv;
+  struct stat st;
+
+  if(!_any_timespec_is_utime_omit(ts))
+    return 0;
+
+  rv = ::fstatat(dirfd,path.c_str(),&st,flags);
+  if(rv == -1)
+    return -1;
+
+  if(ts[0].tv_nsec == UTIME_OMIT)
+    TIMESPEC_TO_TIMEVAL(&tv[0],&st.st_atim);
+  if(ts[1].tv_nsec == UTIME_OMIT)
+    TIMESPEC_TO_TIMEVAL(&tv[1],&st.st_mtim);
+
+  return 0;
+}
+
+static
+inline
+int
+_set_utime_omit_to_current_value(const int             fd,
+                                 const struct timespec ts[2],
+                                 struct timeval        tv[2])
+{
+  int rv;
+  struct stat st;
+
+  if(!_any_timespec_is_utime_omit(ts))
+    return 0;
+
+  rv = ::fstat(fd,&st);
+  if(rv == -1)
+    return -1;
+
+  if(ts[0].tv_nsec == UTIME_OMIT)
+    TIMESPEC_TO_TIMEVAL(&tv[0],&st.st_atim);
+  if(ts[1].tv_nsec == UTIME_OMIT)
+    TIMESPEC_TO_TIMEVAL(&tv[1],&st.st_mtim);
+
+  return 0;
+}
+
+static
+inline
+int
+_set_utime_now_to_now(const struct timespec ts[2],
+                      struct timeval        tv[2])
+{
+  int rv;
+  struct timeval now;
+
+  if(_any_timespec_is_utime_now(ts))
+    return 0;
+
+  rv = ::gettimeofday(&now,NULL);
+  if(rv == -1)
+    return -1;
+
+  if(ts[0].tv_nsec == UTIME_NOW)
+    tv[0] = now;
+  if(ts[1].tv_nsec == UTIME_NOW)
+    tv[1] = now;
+
+  return 0;
+}
+
+static
+inline
+int
+_convert_timespec_to_timeval(const int               dirfd,
+                             const std::string      &path,
+                             const struct timespec   ts[2],
+                             struct timeval          tv[2],
+                             struct timeval        *&tvp,
+                             const int               flags)
+{
+  int rv;
+
+  if(_should_be_set_to_now(ts))
+    return (tvp=NULL,0);
+
+  TIMESPEC_TO_TIMEVAL(&tv[0],&ts[0]);
+  TIMESPEC_TO_TIMEVAL(&tv[1],&ts[1]);
+
+  rv = _set_utime_omit_to_current_value(dirfd,path,ts,tv,flags);
+  if(rv == -1)
+    return -1;
+
+  rv = _set_utime_now_to_now(ts,tv);
+  if(rv == -1)
+    return -1;
+
+  return (tvp=tv,0);
+}
+
+static
+inline
+int
+_convert_timespec_to_timeval(const int               fd,
+                             const struct timespec   ts[2],
+                             struct timeval          tv[2],
+                             struct timeval        *&tvp)
+{
+  int rv;
+
+  if(_should_be_set_to_now(ts))
+    return (tvp=NULL,0);
+
+  TIMESPEC_TO_TIMEVAL(&tv[0],&ts[0]);
+  TIMESPEC_TO_TIMEVAL(&tv[1],&ts[1]);
+
+  rv = _set_utime_omit_to_current_value(fd,ts,tv);
+  if(rv == -1)
+    return -1;
+
+  rv = _set_utime_now_to_now(ts,tv);
+  if(rv == -1)
+    return -1;
+
+  return (tvp=tv,0);
+}
+
+namespace fs
+{
+  static
+  inline
+  int
+  utime(const int              dirfd,
+        const std::string     &path,
+        const struct timespec  ts[2],
+        const int              flags)
+  {
+    int rv;
+    struct timeval  tv[2];
+    struct timeval *tvp;
+
+    if(_flags_invalid(flags))
+      return (errno=EINVAL,-1);
+    if(_timespec_invalid(ts))
+      return (errno=EINVAL,-1);
+    if(_should_ignore(ts))
+      return 0;
+
+    rv = _convert_timespec_to_timeval(dirfd,path,ts,tv,tvp,flags);
+    if(rv == -1)
+      return -1;
+
+    if((flags & AT_SYMLINK_NOFOLLOW) == 0)
+      return ::futimesat(dirfd,path.c_str(),tvp);
+    if(_can_call_lutimes(dirfd,path,flags))
+      return ::lutimes(path.c_str(),tvp);
+
+    return (errno=ENOTSUP,-1);
+  }
+
+  static
+  inline
+  int
+  utime(const int             fd,
+        const struct timespec ts[2])
+  {
+    int rv;
+    struct timeval  tv[2];
+    struct timeval *tvp;
+
+    if(_timespec_invalid(ts))
+      return (errno=EINVAL,-1);
+    if(_should_ignore(ts))
+      return 0;
+
+    rv = _convert_timespec_to_timeval(fd,ts,tv,tvp);
+    if(rv == -1)
+      return -1;
+
+    return ::futimes(fd,tvp);
+  }
+}

src/fs_base_utimensat.hpp → src/fs_base_utime_utimensat.hpp

@@ -26,7 +26,7 @@ namespace fs
   static
   inline
   int
-  utimensat(const int              dirfd,
+  utime(const int              dirfd,
         const std::string     &path,
         const struct timespec  times[2],
         const int              flags)
@@ -37,14 +37,9 @@ namespace fs
   static
   inline
   int
-  utimensat(const std::string &path,
-            const struct stat &st)
+  utime(const int             fd,
+        const struct timespec times[2])
   {
-    struct timespec times[2];
-
-    times[0] = st.st_atim;
-    times[1] = st.st_mtim;
-
-    return fs::utimensat(AT_FDCWD,path,times,0);
+    return ::futimens(fd,times);
   }
 }

src/fs_clonefile.cpp

@@ -30,23 +30,21 @@
 #include "fs_base_open.hpp"
 #include "fs_base_read.hpp"
 #include "fs_base_stat.hpp"
+#include "fs_base_utime.hpp"
 #include "fs_base_write.hpp"
 #include "fs_fadvise.hpp"
 #include "fs_fallocate.hpp"
 #include "fs_sendfile.hpp"
-#include "fs_time.hpp"
 #include "fs_xattr.hpp"
 
 using std::string;
 using std::vector;
 
-namespace fs
-{
-  int
-  writen(const int     fd,
+int
+writen(const int     fd,
        const char   *buf,
        const size_t  count)
-  {
+{
   size_t nleft;
   ssize_t nwritten;
 
@@ -66,15 +64,15 @@ namespace fs
     }
 
   return count;
-  }
+}
 
-  static
-  int
-  copyfile_rw(const int    fdin,
+static
+int
+copyfile_rw(const int    fdin,
             const int    fdout,
             const size_t count,
             const size_t blocksize)
-  {
+{
   ssize_t nr;
   ssize_t nw;
   ssize_t bufsize;
@@ -105,15 +103,15 @@ namespace fs
     }
 
   return count;
-  }
+}
 
-  static
-  int
-  copydata(const int    fdin,
+static
+int
+copydata(const int    fdin,
          const int    fdout,
          const size_t count,
          const size_t blocksize)
-  {
+{
   int rv;
 
   fs::fadvise(fdin,0,count,POSIX_FADV_WILLNEED);
@@ -123,15 +121,15 @@ namespace fs
 
   rv = fs::sendfile(fdin,fdout,count);
   if((rv == -1) && ((errno == EINVAL) || (errno == ENOSYS)))
-      return fs::copyfile_rw(fdin,fdout,count,blocksize);
+    return ::copyfile_rw(fdin,fdout,count,blocksize);
 
   return rv;
-  }
+}
 
-  static
-  bool
-  ignorable_error(const int err)
-  {
+static
+bool
+ignorable_error(const int err)
+{
   switch(err)
     {
     case ENOTTY:
@@ -143,8 +141,10 @@ namespace fs
     }
 
   return false;
-  }
+}
 
+namespace fs
+{
   int
   clonefile(const int fdin,
             const int fdout)
@@ -156,16 +156,16 @@ namespace fs
     if(rv == -1)
       return -1;
 
-    rv = copydata(fdin,fdout,stin.st_size,stin.st_blksize);
+    rv = ::copydata(fdin,fdout,stin.st_size,stin.st_blksize);
     if(rv == -1)
       return -1;
 
     rv = fs::attr::copy(fdin,fdout);
-    if(rv == -1 && !ignorable_error(errno))
+    if((rv == -1) && !ignorable_error(errno))
       return -1;
 
     rv = fs::xattr::copy(fdin,fdout);
-    if(rv == -1 && !ignorable_error(errno))
+    if((rv == -1) && !ignorable_error(errno))
       return -1;
 
     rv = fs::fchown(fdout,stin);
@@ -176,7 +176,7 @@ namespace fs
     if(rv == -1)
       return -1;
 
-    rv = fs::utimes(fdout,stin);
+    rv = fs::utime(fdout,stin);
     if(rv == -1)
       return -1;
 

src/fs_clonepath.cpp

@@ -22,18 +22,16 @@
 #include "fs_base_chown.hpp"
 #include "fs_base_mkdir.hpp"
 #include "fs_base_stat.hpp"
-#include "fs_base_utimensat.hpp"
+#include "fs_base_utime.hpp"
 #include "fs_path.hpp"
 #include "fs_xattr.hpp"
 
 using std::string;
 
-namespace fs
+static
+bool
+ignorable_error(const int err)
 {
-  static
-  bool
-  ignorable_error(const int err)
-  {
   switch(err)
     {
     case ENOTTY:
@@ -45,8 +43,10 @@ namespace fs
     }
 
   return false;
-  }
+}
 
+namespace fs
+{
   int
   clonepath(const string &fromsrc,
             const string &tosrc,
@@ -72,7 +72,7 @@ namespace fs
     if(rv == -1)
       return -1;
     else if(!S_ISDIR(st.st_mode))
-      return (errno = ENOTDIR,-1);
+      return (errno=ENOTDIR,-1);
 
     fs::path::make(&tosrc,relative,topath);
     rv = fs::mkdir(topath,st.st_mode);
@@ -88,18 +88,18 @@ namespace fs
 
     // It may not support it... it's fine...
     rv = fs::attr::copy(frompath,topath);
-    if(rv == -1 && !ignorable_error(errno))
+    if((rv == -1) && !ignorable_error(errno))
       return -1;
 
     rv = fs::xattr::copy(frompath,topath);
-    if(rv == -1 && !ignorable_error(errno))
+    if((rv == -1) && !ignorable_error(errno))
       return -1;
 
     rv = fs::chown(topath,st);
     if(rv == -1)
       return -1;
 
-    rv = fs::utimensat(topath,st);
+    rv = fs::utime(topath,st);
     if(rv == -1)
       return -1;
 

src/fs_time.cpp

@@ -1,21 +0,0 @@
-/*
-  Copyright (c) 2016, Antonio SJ Musumeci <trapexit@spawn.link>
-
-  Permission to use, copy, modify, and/or distribute this software for any
-  purpose with or without fee is hereby granted, provided that the above
-  copyright notice and this permission notice appear in all copies.
-
-  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-#ifdef __linux__
-# include "fs_time_futimens.icpp"
-#else
-# include "fs_time_futimes.icpp"
-#endif

src/fs_time.hpp

@@ -1,22 +0,0 @@
-/*
-  Copyright (c) 2016, Antonio SJ Musumeci <trapexit@spawn.link>
-
-  Permission to use, copy, modify, and/or distribute this software for any
-  purpose with or without fee is hereby granted, provided that the above
-  copyright notice and this permission notice appear in all copies.
-
-  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-namespace fs
-{
-  int
-  utimes(const int          fd,
-         const struct stat &st);
-}

src/fs_time_futimes.icpp

@@ -1,33 +0,0 @@
-/*
-  Copyright (c) 2016, Antonio SJ Musumeci <trapexit@spawn.link>
-
-  Permission to use, copy, modify, and/or distribute this software for any
-  purpose with or without fee is hereby granted, provided that the above
-  copyright notice and this permission notice appear in all copies.
-
-  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-#include <sys/stat.h>
-#include <sys/time.h>
-
-namespace fs
-{
-  int
-  utimes(const int          fd,
-         const struct stat &st)
-  {
-    struct timeval times[2];
-
-    TIMESPEC_TO_TIMEVAL(&times[0],&st.st_atim);
-    TIMESPEC_TO_TIMEVAL(&times[1],&st.st_mtim);
-
-    return ::futimes(fd,times);
-  }
-}

src/utimens.cpp

@@ -23,7 +23,7 @@
 
 #include "config.hpp"
 #include "errno.hpp"
-#include "fs_base_utimensat.hpp"
+#include "fs_base_utime.hpp"
 #include "fs_path.hpp"
 #include "rv.hpp"
 #include "rwlock.hpp"
@@ -45,7 +45,7 @@ _utimens_loop_core(const string   *basepath,
 
   fs::path::make(basepath,fusepath,fullpath);
 
-  rv = fs::utimensat(AT_FDCWD,fullpath,ts,AT_SYMLINK_NOFOLLOW);
+  rv = fs::lutime(fullpath,ts);
 
   return calc_error(rv,error,errno);
 }