Got rid of a comment on an #endif.
[rsync/rsync-patches.git] / xattrs.diff
index baf0d9f..25edadf 100644 (file)
@@ -1,5 +1,7 @@
 Depends-On-Patch: acls.diff
 
+This patch adds preliminary support for extended attributes.
+
 After applying this patch, run these commands for a successful build:
 
     ./prepare-source
@@ -8,7 +10,11 @@ After applying this patch, run these commands for a successful build:
 
 TODO:
 
- - This patch needs to be rewritten to more efficiently handle large xattrs.
+ - This patch needs to more efficiently handle large xattrs, especially when
+   they're unchanged.
+
+ - Extraneous xattr values need to be removed from files that are not being
+   recreated.
 
  - We need to affect the itemized output to know when xattrs are being updated.
 
@@ -35,15 +41,15 @@ TODO:
  popt_OBJS=popt/findme.o  popt/popt.o  popt/poptconfig.o \
 --- old/acls.c
 +++ new/acls.c
-@@ -29,6 +29,7 @@ extern int am_root;
- extern int dry_run;
+@@ -31,6 +31,7 @@ extern int read_only;
+ extern int list_only;
  extern int orig_umask;
  extern int preserve_acls;
 +extern int preserve_xattrs;
  extern unsigned int file_struct_len;
  
  /* === ACL structures === */
-@@ -740,6 +741,10 @@ void receive_acl(struct file_struct *fil
+@@ -742,6 +743,10 @@ void receive_acl(struct file_struct *fil
        type = SMB_ACL_TYPE_ACCESS;
        racl_list = &access_acl_list;
        ndx_ptr = (char*)file + file_struct_len;
@@ -54,7 +60,7 @@ TODO:
        do {
                char tag = read_byte(f);
                int ndx;
-@@ -799,6 +804,10 @@ void cache_acl(struct file_struct *file,
+@@ -801,6 +806,10 @@ void cache_acl(struct file_struct *file,
        racl = sxp->acc_acl;
        racl_list = &access_acl_list;
        ndx_ptr = (char*)file + file_struct_len;
@@ -65,7 +71,7 @@ TODO:
        do {
                if (!racl)
                        ndx = -1;
-@@ -914,6 +923,10 @@ int set_acl(const char *fname, const str
+@@ -921,6 +930,10 @@ int set_acl(const char *fname, const str
  
        type = SMB_ACL_TYPE_ACCESS;
        ndx_ptr = (char*)file + file_struct_len;
@@ -134,11 +140,12 @@ TODO:
        if ((am_root && preserve_devices && IS_DEVICE(file->mode))
 --- old/configure.in
 +++ new/configure.in
-@@ -856,6 +856,30 @@ samba_cv_HAVE_ACL_GET_PERM_NP=yes,samba_
+@@ -856,6 +856,35 @@ samba_cv_HAVE_ACL_GET_PERM_NP=yes,samba_
    AC_MSG_RESULT(no)
  )
  
 +AC_CHECK_HEADERS(attr/xattr.h)
++AC_CHECK_HEADERS(sys/xattr.h)
 +AC_MSG_CHECKING(whether to support extended attributes)
 +AC_ARG_ENABLE(xattr-support,
 +AC_HELP_STRING([--enable-xattr-support], [Include extended attribute support (default=no)]),
@@ -149,17 +156,21 @@ TODO:
 +            AC_MSG_RESULT(Using Linux xattrs)
 +            AC_DEFINE(HAVE_LINUX_XATTRS, 1, [True if you have Linux xattrs])
 +            ;;
++      darwin*)
++            AC_MSG_RESULT(Using OS X xattrs)
++            AC_DEFINE(HAVE_OSX_XATTRS, 1, [True if you have Mac OS X xattrs])
++            ;;
 +      *)
-+            AC_MSG_RESULT(Xattrs requested but not linux.  Good luck)
++            AC_MSG_RESULT(Xattrs requested but not Linux or OS X.  Good luck...)
 +            ;;
 +      esac
 +      ;;
 +  *)
 +      AC_MSG_RESULT(no)
-+      AC_DEFINE(HAVE_NA_XATTRS, 1, [True if you don't have extended attributes])
++      AC_DEFINE(HAVE_NO_XATTRS, 1, [True if you don't have extended attributes])
 +  esac ],
 +  AC_MSG_RESULT(no)
-+  AC_DEFINE(HAVE_NO_XATTRL, 1, [True if you don't have extended attributes])
++  AC_DEFINE(HAVE_NO_XATTRS, 1, [True if you don't have extended attributes])
 +)
 +
  AC_CONFIG_FILES([Makefile lib/dummy zlib/dummy popt/dummy shconfig])
@@ -222,6 +233,15 @@ TODO:
  
        return file;
  }
+@@ -974,7 +985,7 @@ static struct file_struct *send_file_nam
+                                         unsigned short flags)
+ {
+       struct file_struct *file;
+-#ifdef SUPPORT_ACLS
++#if defined SUPPORT_ACLS || defined SUPPORT_XATTRS
+       statx sx;
+ #endif
 @@ -994,6 +1005,13 @@ static struct file_struct *send_file_nam
                        return NULL;
        }
@@ -258,7 +278,7 @@ TODO:
  }
 --- old/lib/sysxattr.c
 +++ new/lib/sysxattr.c
-@@ -0,0 +1,44 @@
+@@ -0,0 +1,87 @@
 +/*
 + * Extended attribute support for rsync.
 + *
@@ -283,6 +303,8 @@ TODO:
 +#include "rsync.h"
 +#include "sysxattr.h"
 +
++#ifdef SUPPORT_XATTRS
++
 +#if defined HAVE_LINUX_XATTRS
 +
 +ssize_t sys_lgetxattr(const char *path, const char *name, void *value, size_t size)
@@ -290,35 +312,87 @@ TODO:
 +      return lgetxattr(path, name, value, size);
 +}
 +
++ssize_t sys_fgetxattr(int filedes, const char *name, void *value, size_t size)
++{
++      return fgetxattr(filedes, name, value, size);
++}
++
 +int sys_lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags)
 +{
 +      return lsetxattr(path, name, value, size, flags);
 +}
 +
++int sys_lremovexattr(const char *path, const char *name)
++{
++      return lremovexattr(path, name);
++}
++
 +ssize_t sys_llistxattr(const char *path, char *list, size_t size)
 +{
 +      return llistxattr(path, list, size);
 +}
 +
++#elif HAVE_OSX_XATTRS
++
++ssize_t sys_lgetxattr(const char *path, const char *name, void *value, size_t size)
++{
++      return getxattr(path, name, value, size, 0, XATTR_NOFOLLOW);
++}
++
++ssize_t sys_fgetxattr(int filedes, const char *name, void *value, size_t size)
++{
++      return fgetxattr(filedes, name, value, size, 0, 0);
++}
++
++int sys_lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags)
++{
++      return setxattr(path, name, value, size, 0, XATTR_NOFOLLOW | flags);
++}
++
++int sys_lremovexattr(const char *path, const char *name)
++{
++      return removexattr(path, name, XATTR_NOFOLLOW);
++}
++
++ssize_t sys_llistxattr(const char *path, char *list, size_t size)
++{
++      return listxattr(path, list, size, XATTR_NOFOLLOW);
++}
++
 +#else
 +
-+#endif /* No xattrs */
++#error You need to create xattr compatibility functions.
++
++#endif
++
++#endif /* SUPPORT_XATTRS */
 --- old/lib/sysxattr.h
 +++ new/lib/sysxattr.h
-@@ -0,0 +1,13 @@
-+#if defined SUPPORT_XATTRS && defined HAVE_ATTR_XATTR_H
+@@ -0,0 +1,24 @@
++#ifdef SUPPORT_XATTRS
++
++#if defined HAVE_ATTR_XATTR_H
 +#include <attr/xattr.h>
++#elif defined HAVE_SYS_XATTR_H
++#include <sys/xattr.h>
 +#endif
 +
-+#if defined HAVE_LINUX_XATTRS
++/* Linux 2.4 does not define this as a distinct errno value: */
++#ifndef ENOATTR
++#define ENOATTR ENODATA
++#endif
 +
 +ssize_t sys_lgetxattr(const char *path, const char *name, void *value, size_t size);
++ssize_t sys_fgetxattr(int filedes, const char *name, void *value, size_t size);
 +int sys_lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags);
++int sys_lremovexattr(const char *path, const char *name);
 +ssize_t sys_llistxattr(const char *path, char *list, size_t size);
 +
 +#else
 +
-+#endif /* No xattrs */
++/* No xattrs available */
++
++#endif
 --- old/options.c
 +++ new/options.c
 @@ -48,6 +48,7 @@ int copy_links = 0;
@@ -348,19 +422,18 @@ TODO:
  #ifdef SUPPORT_LINKS
        links = "";
  #endif
-@@ -234,9 +238,9 @@ static void print_rsync_version(enum log
-       rprintf(f, "Copyright (C) 1996-2006 by Andrew Tridgell, Wayne Davison, and others.\n");
-       rprintf(f, "<http://rsync.samba.org/>\n");
-       rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
--              "%shard links, %sACLs, %ssymlinks, batchfiles,\n",
-+              "%shard links, %sACLs, %sxattrs, %ssymlinks, batchfiles,\n",
-               (int) (sizeof (OFF_T) * 8),
--              got_socketpair, hardlinks, acls, links);
-+              got_socketpair, hardlinks, acls, xattrs, links);
+@@ -236,8 +240,8 @@ static void print_rsync_version(enum log
+       rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, %shard links, %ssymlinks,\n",
+               (int) (sizeof (OFF_T) * 8), got_socketpair, hardlinks, links);
+-      rprintf(f, "              batchfiles, %sinplace, %sIPv6, %sACLs,\n",
+-              have_inplace, ipv6, acls);
++      rprintf(f, "              batchfiles, %sinplace, %sIPv6, %sACLs, %sxattrs,\n",
++              have_inplace, ipv6, acls, xattrs);
  
        /* Note that this field may not have type ino_t.  It depends
         * on the complicated interaction between largefile feature
-@@ -290,7 +294,7 @@ void usage(enum logcode F)
+@@ -289,7 +293,7 @@ void usage(enum logcode F)
    rprintf(F," -q, --quiet                 suppress non-error messages\n");
    rprintf(F,"     --no-motd               suppress daemon-mode MOTD (see manpage caveat)\n");
    rprintf(F," -c, --checksum              skip based on checksum, not mod-time & size\n");
@@ -369,7 +442,7 @@ TODO:
    rprintf(F,"     --no-OPTION             turn off an implied OPTION (e.g. --no-D)\n");
    rprintf(F," -r, --recursive             recurse into directories\n");
    rprintf(F," -R, --relative              use relative path names\n");
-@@ -315,6 +319,9 @@ void usage(enum logcode F)
+@@ -314,6 +318,9 @@ void usage(enum logcode F)
  #ifdef SUPPORT_ACLS
    rprintf(F," -A, --acls                  preserve ACLs (implies --perms)\n");
  #endif
@@ -379,7 +452,7 @@ TODO:
    rprintf(F," -o, --owner                 preserve owner (super-user only)\n");
    rprintf(F," -g, --group                 preserve group\n");
    rprintf(F,"     --devices               preserve device files (super-user only)\n");
-@@ -437,6 +444,9 @@ static struct poptOption long_options[] 
+@@ -436,6 +443,9 @@ static struct poptOption long_options[] 
    {"acls",            'A', POPT_ARG_NONE,   0, 'A', 0, 0 },
    {"no-acls",          0,  POPT_ARG_VAL,    &preserve_acls, 0, 0, 0 },
    {"no-A",             0,  POPT_ARG_VAL,    &preserve_acls, 0, 0, 0 },
@@ -389,7 +462,7 @@ TODO:
    {"times",           't', POPT_ARG_VAL,    &preserve_times, 1, 0, 0 },
    {"no-times",         0,  POPT_ARG_VAL,    &preserve_times, 0, 0, 0 },
    {"no-t",             0,  POPT_ARG_VAL,    &preserve_times, 0, 0, 0 },
-@@ -1118,6 +1128,17 @@ int parse_arguments(int *argc, const cha
+@@ -1117,6 +1127,17 @@ int parse_arguments(int *argc, const cha
                        return 0;
  #endif
  
@@ -403,11 +476,11 @@ TODO:
 +                               "extended attributes are not supported on this %s\n",
 +                               am_server ? "server" : "client");
 +                      return 0;
-+#endif /* SUPPORT_XATTRS */
++#endif
  
                default:
                        /* A large opt value means that set_refuse_options()
-@@ -1564,6 +1585,10 @@ void server_options(char **args,int *arg
+@@ -1563,6 +1584,10 @@ void server_options(char **args,int *arg
        if (preserve_acls)
                argstr[x++] = 'A';
  #endif
@@ -428,31 +501,31 @@ TODO:
  extern int preserve_perms;
  extern int preserve_executability;
  extern int preserve_times;
-@@ -229,6 +230,10 @@ int set_file_attrs(char *fname, struct f
-       if (preserve_acls && set_acl(fname, file, sxp) == 0)
-               updated = 1;
- #endif
+@@ -219,6 +220,10 @@ int set_file_attrs(char *fname, struct f
+       if (daemon_chmod_modes && !S_ISLNK(new_mode))
+               new_mode = tweak_mode(new_mode, daemon_chmod_modes);
 +#ifdef SUPPORT_XATTRS
 +      if (preserve_xattrs && set_xattr(fname, file, sxp) == 0)
 +              updated = 1;
 +#endif
- #ifdef HAVE_CHMOD
-       if ((sxp->st.st_mode & CHMOD_BITS) != (new_mode & CHMOD_BITS)) {
+ #ifdef SUPPORT_ACLS
+       /* It's OK to call set_acl() now, even for a dir, as the generator
+        * will enable owner-writability using chmod, if necessary.
 --- old/rsync.h
 +++ new/rsync.h
-@@ -501,6 +501,10 @@ struct idev {
+@@ -500,6 +500,10 @@ struct idev {
  #define ACLS_NEED_MASK 1
  #endif
  
-+#ifdef HAVE_LINUX_XATTRS
++#ifndef HAVE_NO_XATTRS
 +#define SUPPORT_XATTRS 1
 +#endif
 +
  #define GID_NONE ((gid_t)-1)
  
  #define HL_CHECK_MASTER       0
-@@ -695,6 +699,9 @@ typedef struct {
+@@ -694,6 +698,9 @@ typedef struct {
      struct rsync_acl *acc_acl; /* access ACL */
      struct rsync_acl *def_acl; /* default ACL */
  #endif
@@ -495,7 +568,7 @@ TODO:
  transfer.  The resulting value is treated as though it was the permissions
 --- old/xattr.c
 +++ new/xattr.c
-@@ -0,0 +1,360 @@
+@@ -0,0 +1,375 @@
 +/*
 + * Extended Attribute support for rsync.
 + * Written by Jay Fenlason, vaguely based on the ACLs patch.
@@ -524,6 +597,8 @@ TODO:
 +#ifdef SUPPORT_XATTRS
 +
 +extern int dry_run;
++extern int read_only;
++extern int list_only;
 +extern unsigned int file_struct_len;
 +
 +#define RSYNC_XAL_INITIAL 5
@@ -539,12 +614,14 @@ TODO:
 +static size_t namebuf_len = 0;
 +static char *namebuf = NULL;
 +
-+static size_t datumbuf_len = 0;
-+static char *datumbuf = NULL;
-+
 +static item_list empty_xattr = EMPTY_ITEM_LIST;
 +static item_list rsync_xal_l = EMPTY_ITEM_LIST;
 +
++#ifdef HAVE_OSX_XATTRS
++#define UNIQUE_PREFIX "user.0S%." /* OSX */
++#define UPRE_LEN (sizeof UNIQUE_PREFIX - 1)
++#endif
++
 +/* ------------------------------------------------------------------------- */
 +
 +static void rsync_xal_free(item_list *xalp)
@@ -583,14 +660,13 @@ TODO:
 +      char *ptr;
 +
 +      if (!namebuf) {
-+              namebuf_len = 100;
++              namebuf_len = 1024;
 +              namebuf = new_array(char, namebuf_len);
-+              datumbuf_len = 100;
-+              datumbuf = new_array(char, datumbuf_len);
-+              if (!namebuf || !datumbuf)
++              if (!namebuf)
 +                      out_of_memory("rsync_xal_get");
 +      }
 +
++      /* The length returned includes all the '\0' terminators. */
 +      name_size = sys_llistxattr(fname, namebuf, namebuf_len);
 +      if (name_size > (ssize_t)namebuf_len) {
 +              name_size = -1;
@@ -606,10 +682,10 @@ TODO:
 +                                      fname);
 +                              return -1;
 +                      }
-+                      namebuf = realloc_array(namebuf, char, name_size + 1);
++                      namebuf = realloc_array(namebuf, char, name_size + 1024);
 +                      if (!namebuf)
 +                              out_of_memory("rsync_xal_get");
-+                      namebuf_len = name_size;
++                      namebuf_len = name_size + 1024;
 +                      name_size = sys_llistxattr(fname, namebuf, namebuf_len);
 +                      if (name_size < 0) {
 +                              rsyserr(FERROR, errno,
@@ -630,50 +706,40 @@ TODO:
 +              rsync_xa *rxas = EXPAND_ITEM_LIST(xalp, rsync_xa, RSYNC_XAL_INITIAL);
 +
 +              len = strlen(name) + 1;
-+              datum_size = sys_lgetxattr(fname, name, datumbuf, datumbuf_len);
-+              if (datum_size > (ssize_t)datumbuf_len) {
-+                      datum_size = -1;
-+                      errno = ERANGE;
-+              }
++              datum_size = sys_lgetxattr(fname, name, NULL, 0);
 +              if (datum_size < 0) {
 +                      if (errno == ENOTSUP)
 +                              return -1;
-+                      if (errno == ERANGE) {
-+                              datum_size = sys_lgetxattr(fname, name, NULL, 0);
-+                              if (datum_size < 0) {
-+                                      rsyserr(FERROR, errno,
-+                                          "%s: rsync_xal_get: lgetxattr %s failed",
-+                                          fname, name);
-+                                      return -1;
-+                              }
-+                              datumbuf = realloc_array(datumbuf, char, datum_size + 1);
-+                              if (!datumbuf)
-+                                      out_of_memory("rsync_xal_get");
-+                              datumbuf_len = datum_size;
-+                              datum_size = sys_lgetxattr(fname, name, datumbuf, datumbuf_len);
-+                              if (datum_size < 0) {
-+                                      rsyserr(FERROR, errno,
-+                                          "%s: rsync_xal_get: re-lgetxattr of %s failed",
-+                                          name, fname);
-+                                      return -1;
-+                              }
-+                      } else {
-+                              rsyserr(FERROR, errno,
-+                                  "%s: rsync_xal_get: lgetxattr %s failed",
-+                                  fname, name);
-+                              return -1;
-+                      }
++                      rsyserr(FERROR, errno,
++                          "%s: rsync_xal_get: lgetxattr %s failed",
++                          fname, name);
++                      return -1;
 +              }
 +              ptr = new_array(char, len + datum_size);
 +              if (!ptr)
 +                      out_of_memory("rsync_xal_get");
 +              memcpy(ptr, name, len);
-+              if (datum_size)
-+                      memcpy(ptr + len, datumbuf, datum_size);
 +              rxas->name_len = len;
 +              rxas->name = ptr;
 +              rxas->datum_len = datum_size;
 +              rxas->datum = ptr + len;
++              if (datum_size) {
++                      ssize_t size = sys_lgetxattr(fname, name, rxas->datum, datum_size);
++                      if (size != datum_size) {
++                              if (size < 0) {
++                                      rsyserr(FERROR, errno,
++                                          "rsync_xal_get: lgetxattr(%s,%s)"
++                                          " failed", fname, name);
++                              } else {
++                                      rprintf(FERROR,
++                                          "rsync_xal_get: lgetxattr(%s,%s)"
++                                          " returned %ld instead of %ld\n",
++                                          fname, name,
++                                          (long)size, (long)datum_size);
++                              }
++                              return -1;
++                      }
++              }
 +      }
 +      if (xalp->count > 1)
 +              qsort(xalp->items, xalp->count, sizeof (rsync_xa), rsync_xal_compare_names);
@@ -726,8 +792,9 @@ TODO:
 +      item_list *new_lst = EXPAND_ITEM_LIST(&rsync_xal_l, item_list, RSYNC_XAL_LIST_INITIAL);
 +      /* Since the following call starts a new list, we know it will hold the
 +       * entire initial-count, not just enough space for one new item. */
-+      (void)EXPAND_ITEM_LIST(new_lst, item_list, xalp->count);
-+      memcpy(new_lst->items, xalp->items, xalp->count * sizeof (item_list));
++      *new_lst = empty_xattr;
++      (void)EXPAND_ITEM_LIST(new_lst, rsync_xa, xalp->count);
++      memcpy(new_lst->items, xalp->items, xalp->count * sizeof (rsync_xa));
 +      new_lst->count = xalp->count;
 +      xalp->count = 0;
 +}
@@ -746,12 +813,22 @@ TODO:
 +              write_byte(f, 'X');
 +              write_int(f, count);
 +              for (rxa = sxp->xattr->items; count--; rxa++) {
-+                      write_int(f, rxa->name_len);
-+                      write_int(f, rxa->datum_len);
++#ifdef HAVE_OSX_XATTRS
++                      if (strncmp(rxa->name, "user.", 5) != 0
++                       && strncmp(rxa->name, "system.", 7) != 0) {
++                              write_int(f, rxa->name_len + UPRE_LEN);
++                              write_int(f, rxa->datum_len);
++                              write_buf(f, UNIQUE_PREFIX, UPRE_LEN);
++                      } else
++#endif
++                      {
++                              write_int(f, rxa->name_len);
++                              write_int(f, rxa->datum_len);
++                      }
 +                      write_buf(f, rxa->name, rxa->name_len);
 +                      write_buf(f, rxa->datum, rxa->datum_len);
 +              }
-+              rsync_xal_store(sxp->xattr);
++              rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
 +      }
 +      free_xattr(sxp);
 +}
@@ -785,9 +862,15 @@ TODO:
 +                      rxa->datum_len = datum_len;
 +                      rxa->name = ptr;
 +                      rxa->datum = ptr + name_len;
++#ifdef HAVE_OSX_XATTRS
++                      if (strncmp(rxa->name, UNIQUE_PREFIX, UPRE_LEN) == 0) {
++                              rxa->name_len -= UPRE_LEN;
++                              memmove(rxa->name, rxa->name + UPRE_LEN, rxa->name_len);
++                      }
++#endif
 +              }
-+              ndx = rsync_xal_l.count;
-+              rsync_xal_store(&temp_xattr);
++              ndx = rsync_xal_l.count; /* pre-incremented count */
++              rsync_xal_store(&temp_xattr); /* adds item to rsync_xal_l */
 +      } else if (tag == 'x') {
 +              ndx = read_int(f);
 +              if (ndx < 0 || (size_t)ndx >= rsync_xal_l.count) {
@@ -818,7 +901,7 @@ TODO:
 +
 +      ndx = find_matching_xattr(sxp->xattr);
 +      if (ndx == -1)
-+              rsync_xal_store(sxp->xattr);
++              rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
 +      free_xattr(sxp);
 +
 +      SIVAL(ndx_ptr, 0, ndx);
@@ -851,6 +934,11 @@ TODO:
 +      if (dry_run)
 +              return 1; /* FIXME: --dry-run needs to compute this value */
 +
++      if (read_only || list_only) {
++              errno = EROFS;
++              return -1;
++      }
++
 +      ndx = IVAL(ndx_ptr, 0);
 +      return rsync_xal_set(fname, lst + ndx); /* TODO:  This needs to return 1 if no xattrs changed! */
 +}