]> arthur.barton.de Git - bup.git/blobdiff - lib/bup/_helpers.c
Remove dependency on linux/ext2_fs.h
[bup.git] / lib / bup / _helpers.c
index 5956f5bb54c6e3903e4ec2a6e204633b5d1210d1..ab10fc8485ac98033e27d08dc46f0be00676776f 100644 (file)
@@ -8,17 +8,35 @@
 #include <fcntl.h>
 #include <arpa/inet.h>
 #include <stdint.h>
+#include <stdlib.h>
+#include <stdio.h>
+
+#ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
+#endif
+#ifdef HAVE_SYS_STAT_H
 #include <sys/stat.h>
+#endif
+#ifdef HAVE_UNISTD_H
 #include <unistd.h>
-#include <stdlib.h>
-#include <stdio.h>
+#endif
 
-#ifdef linux
+#ifdef HAVE_LINUX_FS_H
 #include <linux/fs.h>
+#endif
+#ifdef HAVE_SYS_IOCTL_H
 #include <sys/ioctl.h>
 #endif
 
+#if defined(FS_IOC_GETFLAGS) && defined(FS_IOC_SETFLAGS)
+#define BUP_HAVE_FILE_ATTRS 1
+#endif
+
+#ifndef FS_NOCOW_FL
+// Of course, this assumes it's a bitfield value.
+#define FS_NOCOW_FL 0
+#endif
+
 static int istty2 = 0;
 
 // Probably we should use autoconf or something and set HAVE_PY_GETARGCARGV...
@@ -584,13 +602,10 @@ static PyObject *random_sha(PyObject *self, PyObject *args)
 }
 
 
-static PyObject *open_noatime(PyObject *self, PyObject *args)
+static int _open_noatime(const char *filename, int attrs)
 {
-    char *filename = NULL;
-    int attrs, attrs_noatime, fd;
-    if (!PyArg_ParseTuple(args, "s", &filename))
-       return NULL;
-    attrs = O_RDONLY;
+    int attrs_noatime, fd;
+    attrs |= O_RDONLY;
 #ifdef O_NOFOLLOW
     attrs |= O_NOFOLLOW;
 #endif
@@ -611,6 +626,17 @@ static PyObject *open_noatime(PyObject *self, PyObject *args)
        // just harmlessly ignore it, so this branch won't trigger)
        fd = open(filename, attrs);
     }
+    return fd;
+}
+
+
+static PyObject *open_noatime(PyObject *self, PyObject *args)
+{
+    char *filename = NULL;
+    int fd;
+    if (!PyArg_ParseTuple(args, "s", &filename))
+       return NULL;
+    fd = _open_noatime(filename, 0);
     if (fd < 0)
        return PyErr_SetFromErrnoWithFilename(PyExc_OSError, filename);
     return Py_BuildValue("i", fd);
@@ -630,7 +656,7 @@ static PyObject *fadvise_done(PyObject *self, PyObject *args)
 }
 
 
-#if defined(linux) && defined(FS_IOC_GETFLAGS)
+#ifdef BUP_HAVE_FILE_ATTRS
 static PyObject *bup_get_linux_file_attr(PyObject *self, PyObject *args)
 {
     int rc;
@@ -641,7 +667,7 @@ static PyObject *bup_get_linux_file_attr(PyObject *self, PyObject *args)
     if (!PyArg_ParseTuple(args, "s", &path))
         return NULL;
 
-    fd = open(path, O_RDONLY | O_NONBLOCK | O_LARGEFILE | O_NOFOLLOW);
+    fd = _open_noatime(path, O_NONBLOCK);
     if (fd == -1)
         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
 
@@ -656,12 +682,14 @@ static PyObject *bup_get_linux_file_attr(PyObject *self, PyObject *args)
     close(fd);
     return Py_BuildValue("k", attr);
 }
+#endif /* def BUP_HAVE_FILE_ATTRS */
 
 
+#ifdef BUP_HAVE_FILE_ATTRS
 static PyObject *bup_set_linux_file_attr(PyObject *self, PyObject *args)
 {
     int rc;
-    unsigned long attr;
+    unsigned long orig_attr, attr;
     char *path;
     int fd;
 
@@ -672,6 +700,23 @@ static PyObject *bup_set_linux_file_attr(PyObject *self, PyObject *args)
     if (fd == -1)
         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
 
+    // Restrict attr to modifiable flags acdeijstuADST -- see
+    // chattr(1) and the e2fsprogs source.  Letter to flag mapping is
+    // in pf.c flags_array[].
+    attr &= FS_APPEND_FL | FS_COMPR_FL | FS_NODUMP_FL | FS_EXTENT_FL
+    | FS_IMMUTABLE_FL | FS_JOURNAL_DATA_FL | FS_SECRM_FL | FS_NOTAIL_FL
+    | FS_UNRM_FL | FS_NOATIME_FL | FS_DIRSYNC_FL | FS_SYNC_FL
+    | FS_TOPDIR_FL | FS_NOCOW_FL;
+
+    // The extents flag can't be removed, so don't (see chattr(1) and chattr.c).
+    rc = ioctl(fd, FS_IOC_GETFLAGS, &orig_attr);
+    if (rc == -1)
+    {
+        close(fd);
+        return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
+    }
+    attr |= (orig_attr & FS_EXTENT_FL);
+
     rc = ioctl(fd, FS_IOC_SETFLAGS, &attr);
     if (rc == -1)
     {
@@ -682,100 +727,208 @@ static PyObject *bup_set_linux_file_attr(PyObject *self, PyObject *args)
     close(fd);
     return Py_BuildValue("O", Py_None);
 }
-#endif /* def linux */
+#endif /* def BUP_HAVE_FILE_ATTRS */
 
-#ifdef HAVE_UTIMENSAT
-#if defined(_ATFILE_SOURCE) \
-  || _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L
-#define HAVE_BUP_UTIMENSAT 1
 
-static PyObject *bup_utimensat(PyObject *self, PyObject *args)
-{
-    int rc, dirfd, flags;
-    char *path;
-    long access, access_ns, modification, modification_ns;
-    struct timespec ts[2];
+#if defined(HAVE_UTIMENSAT) || defined(HAVE_FUTIMES) || defined(HAVE_LUTIMES)
 
-    if (!PyArg_ParseTuple(args, "is((ll)(ll))i",
-                          &dirfd,
-                          &path,
-                          &access, &access_ns,
-                          &modification, &modification_ns,
-                          &flags))
-        return NULL;
+static int bup_parse_xutime_args(char **path,
+                                 long *access,
+                                 long *access_ns,
+                                 long *modification,
+                                 long *modification_ns,
+                                 PyObject *self, PyObject *args)
+{
+    if (!PyArg_ParseTuple(args, "s((ll)(ll))",
+                          path,
+                          access, access_ns,
+                          modification, modification_ns))
+        return 0;
 
-    if (isnan(access))
+    if (isnan(*access))
     {
         PyErr_SetString(PyExc_ValueError, "access time is NaN");
-        return NULL;
+        return 0;
     }
-    else if (isinf(access))
+    else if (isinf(*access))
     {
         PyErr_SetString(PyExc_ValueError, "access time is infinite");
-        return NULL;
+        return 0;
     }
-    else if (isnan(modification))
+    else if (isnan(*modification))
     {
         PyErr_SetString(PyExc_ValueError, "modification time is NaN");
-        return NULL;
+        return 0;
     }
-    else if (isinf(modification))
+    else if (isinf(*modification))
     {
         PyErr_SetString(PyExc_ValueError, "modification time is infinite");
-        return NULL;
+        return 0;
     }
 
-    if (isnan(access_ns))
+    if (isnan(*access_ns))
     {
         PyErr_SetString(PyExc_ValueError, "access time ns is NaN");
-        return NULL;
+        return 0;
     }
-    else if (isinf(access_ns))
+    else if (isinf(*access_ns))
     {
         PyErr_SetString(PyExc_ValueError, "access time ns is infinite");
-        return NULL;
+        return 0;
     }
-    else if (isnan(modification_ns))
+    else if (isnan(*modification_ns))
     {
         PyErr_SetString(PyExc_ValueError, "modification time ns is NaN");
-        return NULL;
+        return 0;
     }
-    else if (isinf(modification_ns))
+    else if (isinf(*modification_ns))
     {
         PyErr_SetString(PyExc_ValueError, "modification time ns is infinite");
-        return NULL;
+        return 0;
     }
 
+    return 1;
+}
+
+#endif /* defined(HAVE_UTIMENSAT) || defined(HAVE_FUTIMES)
+          || defined(HAVE_LUTIMES) */
+
+
+#ifdef HAVE_UTIMENSAT
+
+static PyObject *bup_xutime_ns(PyObject *self, PyObject *args,
+                               int follow_symlinks)
+{
+    int rc;
+    char *path;
+    long access, access_ns, modification, modification_ns;
+    struct timespec ts[2];
+
+    if (!bup_parse_xutime_args(&path, &access, &access_ns,
+                               &modification, &modification_ns,
+                               self, args))
+       return NULL;
+
     ts[0].tv_sec = access;
     ts[0].tv_nsec = access_ns;
     ts[1].tv_sec = modification;
     ts[1].tv_nsec = modification_ns;
+    rc = utimensat(AT_FDCWD, path, ts,
+                   follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
+    if (rc != 0)
+        return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
+
+    return Py_BuildValue("O", Py_None);
+}
+
+
+#define BUP_HAVE_BUP_UTIME_NS 1
+static PyObject *bup_utime_ns(PyObject *self, PyObject *args)
+{
+    return bup_xutime_ns(self, args, 1);
+}
+
+
+#define BUP_HAVE_BUP_LUTIME_NS 1
+static PyObject *bup_lutime_ns(PyObject *self, PyObject *args)
+{
+    return bup_xutime_ns(self, args, 0);
+}
+
+
+#else /* not defined(HAVE_UTIMENSAT) */
 
-    rc = utimensat(dirfd, path, ts, flags);
+
+#ifdef HAVE_UTIMES
+#define BUP_HAVE_BUP_UTIME_NS 1
+static PyObject *bup_utime_ns(PyObject *self, PyObject *args)
+{
+    int rc;
+    char *path;
+    long access, access_ns, modification, modification_ns;
+    struct timeval tv[2];
+
+    if (!bup_parse_xutime_args(&path, &access, &access_ns,
+                               &modification, &modification_ns,
+                               self, args))
+       return NULL;
+
+    tv[0].tv_sec = access;
+    tv[0].tv_usec = access_ns / 1000;
+    tv[1].tv_sec = modification;
+    tv[1].tv_usec = modification_ns / 1000;
+    rc = utimes(path, tv);
     if (rc != 0)
         return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
 
     return Py_BuildValue("O", Py_None);
 }
+#endif /* def HAVE_UTIMES */
+
+
+#ifdef HAVE_LUTIMES
+#define BUP_HAVE_BUP_LUTIME_NS 1
+static PyObject *bup_lutime_ns(PyObject *self, PyObject *args)
+{
+    int rc;
+    char *path;
+    long access, access_ns, modification, modification_ns;
+    struct timeval tv[2];
+
+    if (!bup_parse_xutime_args(&path, &access, &access_ns,
+                               &modification, &modification_ns,
+                               self, args))
+       return NULL;
+
+    tv[0].tv_sec = access;
+    tv[0].tv_usec = access_ns / 1000;
+    tv[1].tv_sec = modification;
+    tv[1].tv_usec = modification_ns / 1000;
+    rc = lutimes(path, tv);
+    if (rc != 0)
+        return PyErr_SetFromErrnoWithFilename(PyExc_OSError, path);
+
+    return Py_BuildValue("O", Py_None);
+}
+#endif /* def HAVE_LUTIMES */
+
+
+#endif /* not defined(HAVE_UTIMENSAT) */
+
+
+#ifdef HAVE_STAT_ST_ATIM
+# define BUP_STAT_ATIME_NS(st) (st)->st_atim.tv_nsec
+# define BUP_STAT_MTIME_NS(st) (st)->st_mtim.tv_nsec
+# define BUP_STAT_CTIME_NS(st) (st)->st_ctim.tv_nsec
+#elif defined HAVE_STAT_ST_ATIMENSEC
+# define BUP_STAT_ATIME_NS(st) (st)->st_atimespec.tv_nsec
+# define BUP_STAT_MTIME_NS(st) (st)->st_mtimespec.tv_nsec
+# define BUP_STAT_CTIME_NS(st) (st)->st_ctimespec.tv_nsec
+#else
+# define BUP_STAT_ATIME_NS(st) 0
+# define BUP_STAT_MTIME_NS(st) 0
+# define BUP_STAT_CTIME_NS(st) 0
+#endif
 
-#endif /* defined(_ATFILE_SOURCE)
-          || _XOPEN_SOURCE >= 700 || _POSIX_C_SOURCE >= 200809L */
-#endif /* HAVE_UTIMENSAT */
 
 static PyObject *stat_struct_to_py(const struct stat *st)
 {
+    long atime_ns = BUP_STAT_ATIME_NS(st);
+    long mtime_ns = BUP_STAT_MTIME_NS(st);
+    long ctime_ns = BUP_STAT_CTIME_NS(st);
+
     /* Enforce the current timespec nanosecond range expectations. */
-    if (st->st_atim.tv_nsec < 0 || st->st_atim.tv_nsec > 999999999)
+    if (atime_ns < 0 || atime_ns > 999999999)
     {
         PyErr_SetString(PyExc_ValueError, "invalid atime timespec nanoseconds");
         return NULL;
     }
-    if (st->st_mtim.tv_nsec < 0 || st->st_mtim.tv_nsec > 999999999)
+    if (mtime_ns < 0 || mtime_ns > 999999999)
     {
         PyErr_SetString(PyExc_ValueError, "invalid mtime timespec nanoseconds");
         return NULL;
     }
-    if (st->st_ctim.tv_nsec < 0 || st->st_ctim.tv_nsec > 999999999)
+    if (ctime_ns < 0 || ctime_ns > 999999999)
     {
         PyErr_SetString(PyExc_ValueError, "invalid ctime timespec nanoseconds");
         return NULL;
@@ -791,11 +944,11 @@ static PyObject *stat_struct_to_py(const struct stat *st)
                          (unsigned long) st->st_rdev,
                          (unsigned long) st->st_size,
                          (long long) st->st_atime,
-                         (long) st->st_atim.tv_nsec,
+                         (long) atime_ns,
                          (long long) st->st_mtime,
-                         (long) st->st_mtim.tv_nsec,
+                         (long) mtime_ns,
                          (long long) st->st_ctime,
-                         (long) st->st_ctim.tv_nsec);
+                         (long) ctime_ns);
 }
 
 
@@ -875,15 +1028,22 @@ static PyMethodDef helper_methods[] = {
        "open() the given filename for read with O_NOATIME if possible" },
     { "fadvise_done", fadvise_done, METH_VARARGS,
        "Inform the kernel that we're finished with earlier parts of a file" },
-#if defined(linux) && defined(FS_IOC_GETFLAGS)
+#ifdef BUP_HAVE_FILE_ATTRS
     { "get_linux_file_attr", bup_get_linux_file_attr, METH_VARARGS,
       "Return the Linux attributes for the given file." },
+#endif
+#ifdef BUP_HAVE_FILE_ATTRS
     { "set_linux_file_attr", bup_set_linux_file_attr, METH_VARARGS,
       "Set the Linux attributes for the given file." },
 #endif
-#ifdef HAVE_BUP_UTIMENSAT
-    { "utimensat", bup_utimensat, METH_VARARGS,
-      "Change file timestamps with nanosecond precision." },
+#ifdef BUP_HAVE_BUP_UTIME_NS
+    { "bup_utime_ns", bup_utime_ns, METH_VARARGS,
+      "Change path timestamps with up to nanosecond precision." },
+#endif
+#ifdef BUP_HAVE_BUP_LUTIME_NS
+    { "bup_lutime_ns", bup_lutime_ns, METH_VARARGS,
+      "Change path timestamps with up to nanosecond precision;"
+      " don't follow symlinks." },
 #endif
     { "stat", bup_stat, METH_VARARGS,
       "Extended version of stat." },
@@ -901,11 +1061,6 @@ PyMODINIT_FUNC init_helpers(void)
     PyObject *m = Py_InitModule("_helpers", helper_methods);
     if (m == NULL)
         return;
-#ifdef HAVE_BUP_UTIMENSAT
-    PyModule_AddObject(m, "AT_FDCWD", Py_BuildValue("i", AT_FDCWD));
-    PyModule_AddObject(m, "AT_SYMLINK_NOFOLLOW",
-                       Py_BuildValue("i", AT_SYMLINK_NOFOLLOW));
-#endif
     e = getenv("BUP_FORCE_TTY");
     istty2 = isatty(2) || (atoi(e ? e : "0") & 2);
     unpythonize_argv();