Fix a comment.
[rsync/qnx.git] / xattrs.c
blob3a7cb25bb87a299448e660cfbc2dedf3fd6ae45c
1 /*
2 * Extended Attribute support for rsync.
3 * Written by Jay Fenlason, vaguely based on the ACLs patch.
5 * Copyright (C) 2004 Red Hat, Inc.
6 * Copyright (C) 2006-2009 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
22 #include "rsync.h"
23 #include "ifuncs.h"
24 #include "inums.h"
25 #include "lib/sysxattrs.h"
27 #ifdef SUPPORT_XATTRS
29 extern int dry_run;
30 extern int am_root;
31 extern int am_sender;
32 extern int am_generator;
33 extern int read_only;
34 extern int list_only;
35 extern int preserve_xattrs;
36 extern int preserve_links;
37 extern int preserve_devices;
38 extern int preserve_specials;
39 extern int checksum_seed;
41 #define RSYNC_XAL_INITIAL 5
42 #define RSYNC_XAL_LIST_INITIAL 100
44 #define MAX_FULL_DATUM 32
46 #define HAS_PREFIX(str, prfx) (*(str) == *(prfx) \
47 && strncmp(str, prfx, sizeof (prfx) - 1) == 0)
49 #define XATTR_ABBREV(x) ((size_t)((x).name - (x).datum) < (x).datum_len)
51 #define XSTATE_ABBREV 1
52 #define XSTATE_DONE 2
53 #define XSTATE_TODO 3
55 #define USER_PREFIX "user."
56 #define UPRE_LEN ((int)sizeof USER_PREFIX - 1)
57 #define SYSTEM_PREFIX "system."
58 #define SPRE_LEN ((int)sizeof SYSTEM_PREFIX - 1)
60 #ifdef HAVE_LINUX_XATTRS
61 #define MIGHT_NEED_RPRE (am_root < 0)
62 #define RSYNC_PREFIX USER_PREFIX "rsync."
63 #else
64 #define MIGHT_NEED_RPRE am_root
65 #define RSYNC_PREFIX "rsync."
66 #endif
67 #define RPRE_LEN ((int)sizeof RSYNC_PREFIX - 1)
69 #define XSTAT_SUFFIX "stat"
70 #define XSTAT_ATTR RSYNC_PREFIX "%" XSTAT_SUFFIX
71 #define XACC_ACL_SUFFIX "aacl"
72 #define XACC_ACL_ATTR RSYNC_PREFIX "%" XACC_ACL_SUFFIX
73 #define XDEF_ACL_SUFFIX "dacl"
74 #define XDEF_ACL_ATTR RSYNC_PREFIX "%" XDEF_ACL_SUFFIX
76 typedef struct {
77 char *datum, *name;
78 size_t datum_len, name_len;
79 int num;
80 } rsync_xa;
82 static size_t namebuf_len = 0;
83 static char *namebuf = NULL;
85 static item_list empty_xattr = EMPTY_ITEM_LIST;
86 static item_list rsync_xal_l = EMPTY_ITEM_LIST;
88 static size_t prior_xattr_count = (size_t)-1;
90 /* ------------------------------------------------------------------------- */
92 static void rsync_xal_free(item_list *xalp)
94 size_t i;
95 rsync_xa *rxas = xalp->items;
97 for (i = 0; i < xalp->count; i++) {
98 free(rxas[i].datum);
99 /*free(rxas[i].name);*/
101 xalp->count = 0;
104 void free_xattr(stat_x *sxp)
106 if (!sxp->xattr)
107 return;
108 rsync_xal_free(sxp->xattr);
109 free(sxp->xattr);
110 sxp->xattr = NULL;
113 static int rsync_xal_compare_names(const void *x1, const void *x2)
115 const rsync_xa *xa1 = x1;
116 const rsync_xa *xa2 = x2;
117 return strcmp(xa1->name, xa2->name);
120 static ssize_t get_xattr_names(const char *fname)
122 ssize_t list_len;
123 int64 arg;
125 if (!namebuf) {
126 namebuf_len = 1024;
127 namebuf = new_array(char, namebuf_len);
128 if (!namebuf)
129 out_of_memory("get_xattr_names");
132 while (1) {
133 /* The length returned includes all the '\0' terminators. */
134 list_len = sys_llistxattr(fname, namebuf, namebuf_len);
135 if (list_len >= 0) {
136 if ((size_t)list_len <= namebuf_len)
137 break;
138 } else if (errno == ENOTSUP)
139 return 0;
140 else if (errno != ERANGE) {
141 arg = namebuf_len;
142 got_error:
143 rsyserr(FERROR_XFER, errno,
144 "get_xattr_names: llistxattr(\"%s\",%s) failed",
145 full_fname(fname), big_num(arg));
146 return -1;
148 list_len = sys_llistxattr(fname, NULL, 0);
149 if (list_len < 0) {
150 arg = 0;
151 goto got_error;
153 if (namebuf_len)
154 free(namebuf);
155 namebuf_len = list_len + 1024;
156 namebuf = new_array(char, namebuf_len);
157 if (!namebuf)
158 out_of_memory("get_xattr_names");
161 return list_len;
164 /* On entry, the *len_ptr parameter contains the size of the extra space we
165 * should allocate when we create a buffer for the data. On exit, it contains
166 * the length of the datum. */
167 static char *get_xattr_data(const char *fname, const char *name, size_t *len_ptr,
168 int no_missing_error)
170 size_t datum_len = sys_lgetxattr(fname, name, NULL, 0);
171 size_t extra_len = *len_ptr;
172 char *ptr;
174 *len_ptr = datum_len;
176 if (datum_len == (size_t)-1) {
177 if (errno == ENOTSUP || no_missing_error)
178 return NULL;
179 rsyserr(FERROR_XFER, errno,
180 "get_xattr_data: lgetxattr(\"%s\",\"%s\",0) failed",
181 full_fname(fname), name);
182 return NULL;
185 if (!datum_len && !extra_len)
186 extra_len = 1; /* request non-zero amount of memory */
187 if (datum_len + extra_len < datum_len)
188 overflow_exit("get_xattr_data");
189 if (!(ptr = new_array(char, datum_len + extra_len)))
190 out_of_memory("get_xattr_data");
192 if (datum_len) {
193 size_t len = sys_lgetxattr(fname, name, ptr, datum_len);
194 if (len != datum_len) {
195 if (len == (size_t)-1) {
196 rsyserr(FERROR_XFER, errno,
197 "get_xattr_data: lgetxattr(\"%s\",\"%s\",%ld)"
198 " failed", full_fname(fname), name, (long)datum_len);
199 } else {
200 rprintf(FERROR_XFER,
201 "get_xattr_data: lgetxattr(\"%s\",\"%s\",%ld)"
202 " returned %ld\n", full_fname(fname), name,
203 (long)datum_len, (long)len);
205 free(ptr);
206 return NULL;
210 return ptr;
213 static int rsync_xal_get(const char *fname, item_list *xalp)
215 ssize_t list_len, name_len;
216 size_t datum_len, name_offset;
217 char *name, *ptr;
218 #ifdef HAVE_LINUX_XATTRS
219 int user_only = am_sender ? 0 : !am_root;
220 #endif
221 rsync_xa *rxa;
222 int count;
224 /* This puts the name list into the "namebuf" buffer. */
225 if ((list_len = get_xattr_names(fname)) < 0)
226 return -1;
228 for (name = namebuf; list_len > 0; name += name_len) {
229 name_len = strlen(name) + 1;
230 list_len -= name_len;
232 #ifdef HAVE_LINUX_XATTRS
233 /* We always ignore the system namespace, and non-root
234 * ignores everything but the user namespace. */
235 if (user_only ? !HAS_PREFIX(name, USER_PREFIX)
236 : HAS_PREFIX(name, SYSTEM_PREFIX))
237 continue;
238 #endif
240 /* No rsync.%FOO attributes are copied w/o 2 -X options. */
241 if (name_len > RPRE_LEN && name[RPRE_LEN] == '%'
242 && HAS_PREFIX(name, RSYNC_PREFIX)) {
243 if ((am_sender && preserve_xattrs < 2)
244 || (am_root < 0
245 && (strcmp(name+RPRE_LEN+1, XSTAT_SUFFIX) == 0
246 || strcmp(name+RPRE_LEN+1, XACC_ACL_SUFFIX) == 0
247 || strcmp(name+RPRE_LEN+1, XDEF_ACL_SUFFIX) == 0)))
248 continue;
251 datum_len = name_len; /* Pass extra size to get_xattr_data() */
252 if (!(ptr = get_xattr_data(fname, name, &datum_len, 0)))
253 return -1;
255 if (datum_len > MAX_FULL_DATUM) {
256 /* For large datums, we store a flag and a checksum. */
257 name_offset = 1 + MAX_DIGEST_LEN;
258 sum_init(checksum_seed);
259 sum_update(ptr, datum_len);
260 free(ptr);
262 if (!(ptr = new_array(char, name_offset + name_len)))
263 out_of_memory("rsync_xal_get");
264 *ptr = XSTATE_ABBREV;
265 sum_end(ptr + 1);
266 } else
267 name_offset = datum_len;
269 rxa = EXPAND_ITEM_LIST(xalp, rsync_xa, RSYNC_XAL_INITIAL);
270 rxa->name = ptr + name_offset;
271 memcpy(rxa->name, name, name_len);
272 rxa->datum = ptr;
273 rxa->name_len = name_len;
274 rxa->datum_len = datum_len;
276 count = xalp->count;
277 rxa = xalp->items;
278 if (count > 1)
279 qsort(rxa, count, sizeof (rsync_xa), rsync_xal_compare_names);
280 for (rxa += count-1; count; count--, rxa--)
281 rxa->num = count;
282 return 0;
285 /* Read the xattr(s) for this filename. */
286 int get_xattr(const char *fname, stat_x *sxp)
288 sxp->xattr = new(item_list);
289 *sxp->xattr = empty_xattr;
291 if (S_ISREG(sxp->st.st_mode) || S_ISDIR(sxp->st.st_mode)) {
292 /* Everyone supports this. */
293 } else if (S_ISLNK(sxp->st.st_mode)) {
294 #ifndef NO_SYMLINK_XATTRS
295 if (!preserve_links)
296 #endif
297 return 0;
298 } else if (IS_SPECIAL(sxp->st.st_mode)) {
299 #ifndef NO_SPECIAL_XATTRS
300 if (!preserve_specials)
301 #endif
302 return 0;
303 } else if (IS_DEVICE(sxp->st.st_mode)) {
304 #ifndef NO_DEVICE_XATTRS
305 if (!preserve_devices)
306 #endif
307 return 0;
310 if (rsync_xal_get(fname, sxp->xattr) < 0) {
311 free_xattr(sxp);
312 return -1;
314 return 0;
317 int copy_xattrs(const char *source, const char *dest)
319 ssize_t list_len, name_len;
320 size_t datum_len;
321 char *name, *ptr;
322 #ifdef HAVE_LINUX_XATTRS
323 int user_only = am_sender ? 0 : am_root <= 0;
324 #endif
326 /* This puts the name list into the "namebuf" buffer. */
327 if ((list_len = get_xattr_names(source)) < 0)
328 return -1;
330 for (name = namebuf; list_len > 0; name += name_len) {
331 name_len = strlen(name) + 1;
332 list_len -= name_len;
334 #ifdef HAVE_LINUX_XATTRS
335 /* We always ignore the system namespace, and non-root
336 * ignores everything but the user namespace. */
337 if (user_only ? !HAS_PREFIX(name, USER_PREFIX)
338 : HAS_PREFIX(name, SYSTEM_PREFIX))
339 continue;
340 #endif
342 datum_len = 0;
343 if (!(ptr = get_xattr_data(source, name, &datum_len, 0)))
344 return -1;
345 if (sys_lsetxattr(dest, name, ptr, datum_len) < 0) {
346 int save_errno = errno ? errno : EINVAL;
347 rsyserr(FERROR_XFER, errno,
348 "copy_xattrs: lsetxattr(\"%s\",\"%s\") failed",
349 full_fname(dest), name);
350 errno = save_errno;
351 return -1;
353 free(ptr);
356 return 0;
359 static int find_matching_xattr(item_list *xalp)
361 size_t i, j;
362 item_list *lst = rsync_xal_l.items;
364 for (i = 0; i < rsync_xal_l.count; i++) {
365 rsync_xa *rxas1 = lst[i].items;
366 rsync_xa *rxas2 = xalp->items;
368 /* Wrong number of elements? */
369 if (lst[i].count != xalp->count)
370 continue;
371 /* any elements different? */
372 for (j = 0; j < xalp->count; j++) {
373 if (rxas1[j].name_len != rxas2[j].name_len
374 || rxas1[j].datum_len != rxas2[j].datum_len
375 || strcmp(rxas1[j].name, rxas2[j].name))
376 break;
377 if (rxas1[j].datum_len > MAX_FULL_DATUM) {
378 if (memcmp(rxas1[j].datum + 1,
379 rxas2[j].datum + 1,
380 MAX_DIGEST_LEN) != 0)
381 break;
382 } else {
383 if (memcmp(rxas1[j].datum, rxas2[j].datum,
384 rxas2[j].datum_len))
385 break;
388 /* no differences found. This is The One! */
389 if (j == xalp->count)
390 return i;
393 return -1;
396 /* Store *xalp on the end of rsync_xal_l */
397 static void rsync_xal_store(item_list *xalp)
399 item_list *new_lst = EXPAND_ITEM_LIST(&rsync_xal_l, item_list, RSYNC_XAL_LIST_INITIAL);
400 /* Since the following call starts a new list, we know it will hold the
401 * entire initial-count, not just enough space for one new item. */
402 *new_lst = empty_xattr;
403 (void)EXPAND_ITEM_LIST(new_lst, rsync_xa, xalp->count);
404 memcpy(new_lst->items, xalp->items, xalp->count * sizeof (rsync_xa));
405 new_lst->count = xalp->count;
406 xalp->count = 0;
409 /* Send the make_xattr()-generated xattr list for this flist entry. */
410 int send_xattr(int f, stat_x *sxp)
412 int ndx = find_matching_xattr(sxp->xattr);
414 /* Send 0 (-1 + 1) to indicate that literal xattr data follows. */
415 write_varint(f, ndx + 1);
417 if (ndx < 0) {
418 rsync_xa *rxa;
419 int count = sxp->xattr->count;
420 write_varint(f, count);
421 for (rxa = sxp->xattr->items; count--; rxa++) {
422 size_t name_len = rxa->name_len;
423 const char *name = rxa->name;
424 /* Strip the rsync prefix from disguised namespaces. */
425 if (name_len > RPRE_LEN
426 #ifdef HAVE_LINUX_XATTRS
427 && am_root < 0
428 #endif
429 && name[RPRE_LEN] != '%' && HAS_PREFIX(name, RSYNC_PREFIX)) {
430 name += RPRE_LEN;
431 name_len -= RPRE_LEN;
433 #ifndef HAVE_LINUX_XATTRS
434 else {
435 /* Put everything else in the user namespace. */
436 name_len += UPRE_LEN;
438 #endif
439 write_varint(f, name_len);
440 write_varint(f, rxa->datum_len);
441 #ifndef HAVE_LINUX_XATTRS
442 if (name_len > rxa->name_len) {
443 write_buf(f, USER_PREFIX, UPRE_LEN);
444 name_len -= UPRE_LEN;
446 #endif
447 write_buf(f, name, name_len);
448 if (rxa->datum_len > MAX_FULL_DATUM)
449 write_buf(f, rxa->datum + 1, MAX_DIGEST_LEN);
450 else
451 write_buf(f, rxa->datum, rxa->datum_len);
453 ndx = rsync_xal_l.count; /* pre-incremented count */
454 rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
457 return ndx;
460 /* Return a flag indicating if we need to change a file's xattrs. If
461 * "find_all" is specified, also mark any abbreviated xattrs that we
462 * need so that send_xattr_request() can tell the sender about them. */
463 int xattr_diff(struct file_struct *file, stat_x *sxp, int find_all)
465 item_list *lst = rsync_xal_l.items;
466 rsync_xa *snd_rxa, *rec_rxa;
467 int snd_cnt, rec_cnt;
468 int cmp, same, xattrs_equal = 1;
470 if (sxp && XATTR_READY(*sxp)) {
471 rec_rxa = sxp->xattr->items;
472 rec_cnt = sxp->xattr->count;
473 } else {
474 rec_rxa = NULL;
475 rec_cnt = 0;
478 if (F_XATTR(file) >= 0)
479 lst += F_XATTR(file);
480 else
481 lst = &empty_xattr;
483 snd_rxa = lst->items;
484 snd_cnt = lst->count;
486 /* If the count of the sender's xattrs is different from our
487 * (receiver's) xattrs, the lists are not the same. */
488 if (snd_cnt != rec_cnt) {
489 if (!find_all)
490 return 1;
491 xattrs_equal = 0;
494 while (snd_cnt) {
495 cmp = rec_cnt ? strcmp(snd_rxa->name, rec_rxa->name) : -1;
496 if (cmp > 0)
497 same = 0;
498 else if (snd_rxa->datum_len > MAX_FULL_DATUM) {
499 same = cmp == 0 && snd_rxa->datum_len == rec_rxa->datum_len
500 && memcmp(snd_rxa->datum + 1, rec_rxa->datum + 1,
501 MAX_DIGEST_LEN) == 0;
502 /* Flag unrequested items that we need. */
503 if (!same && find_all && snd_rxa->datum[0] == XSTATE_ABBREV)
504 snd_rxa->datum[0] = XSTATE_TODO;
505 } else {
506 same = cmp == 0 && snd_rxa->datum_len == rec_rxa->datum_len
507 && memcmp(snd_rxa->datum, rec_rxa->datum,
508 snd_rxa->datum_len) == 0;
510 if (!same) {
511 if (!find_all)
512 return 1;
513 xattrs_equal = 0;
516 if (cmp <= 0) {
517 snd_rxa++;
518 snd_cnt--;
520 if (cmp >= 0) {
521 rec_rxa++;
522 rec_cnt--;
526 if (rec_cnt)
527 xattrs_equal = 0;
529 return !xattrs_equal;
532 /* When called by the generator (with a NULL fname), this tells the sender
533 * all the abbreviated xattr values we need. When called by the sender
534 * (with a non-NULL fname), we send all the extra xattr data it needs.
535 * The generator may also call with f_out < 0 to just change all the
536 * XSTATE_ABBREV states into XSTATE_DONE. */
537 void send_xattr_request(const char *fname, struct file_struct *file, int f_out)
539 item_list *lst = rsync_xal_l.items;
540 int cnt, prior_req = 0;
541 rsync_xa *rxa;
543 lst += F_XATTR(file);
544 for (rxa = lst->items, cnt = lst->count; cnt--; rxa++) {
545 if (rxa->datum_len <= MAX_FULL_DATUM)
546 continue;
547 switch (rxa->datum[0]) {
548 case XSTATE_ABBREV:
549 /* Items left abbreviated matched the sender's checksum, so
550 * the receiver will cache the local data for future use. */
551 if (am_generator)
552 rxa->datum[0] = XSTATE_DONE;
553 continue;
554 case XSTATE_TODO:
555 assert(f_out >= 0);
556 break;
557 default:
558 continue;
561 /* Flag that we handled this abbreviated item. */
562 rxa->datum[0] = XSTATE_DONE;
564 write_varint(f_out, rxa->num - prior_req);
565 prior_req = rxa->num;
567 if (fname) {
568 size_t len = 0;
569 char *ptr;
571 /* Re-read the long datum. */
572 if (!(ptr = get_xattr_data(fname, rxa->name, &len, 0))) {
573 rprintf(FERROR_XFER, "failed to re-read xattr %s for %s\n", rxa->name, fname);
574 write_varint(f_out, 0);
575 continue;
578 write_varint(f_out, len); /* length might have changed! */
579 write_buf(f_out, ptr, len);
580 free(ptr);
584 if (f_out >= 0)
585 write_byte(f_out, 0); /* end the list */
588 /* When called by the sender, read the request from the generator and mark
589 * any needed xattrs with a flag that lets us know they need to be sent to
590 * the receiver. When called by the receiver, reads the sent data and
591 * stores it in place of its checksum. */
592 int recv_xattr_request(struct file_struct *file, int f_in)
594 item_list *lst = rsync_xal_l.items;
595 char *old_datum, *name;
596 rsync_xa *rxa;
597 int rel_pos, cnt, num, got_xattr_data = 0;
599 if (F_XATTR(file) < 0) {
600 rprintf(FERROR, "recv_xattr_request: internal data error!\n");
601 exit_cleanup(RERR_PROTOCOL);
603 lst += F_XATTR(file);
605 cnt = lst->count;
606 rxa = lst->items;
607 num = 0;
608 while ((rel_pos = read_varint(f_in)) != 0) {
609 num += rel_pos;
610 while (cnt && rxa->num < num) {
611 rxa++;
612 cnt--;
614 if (!cnt || rxa->num != num) {
615 rprintf(FERROR, "[%s] could not find xattr #%d for %s\n",
616 who_am_i(), num, f_name(file, NULL));
617 exit_cleanup(RERR_PROTOCOL);
619 if (!XATTR_ABBREV(*rxa) || rxa->datum[0] != XSTATE_ABBREV) {
620 rprintf(FERROR, "[%s] internal abbrev error on %s (%s, len=%ld)!\n",
621 who_am_i(), f_name(file, NULL), rxa->name, (long)rxa->datum_len);
622 exit_cleanup(RERR_PROTOCOL);
625 if (am_sender) {
626 rxa->datum[0] = XSTATE_TODO;
627 continue;
630 old_datum = rxa->datum;
631 rxa->datum_len = read_varint(f_in);
633 if (rxa->name_len + rxa->datum_len < rxa->name_len)
634 overflow_exit("recv_xattr_request");
635 rxa->datum = new_array(char, rxa->datum_len + rxa->name_len);
636 if (!rxa->datum)
637 out_of_memory("recv_xattr_request");
638 name = rxa->datum + rxa->datum_len;
639 memcpy(name, rxa->name, rxa->name_len);
640 rxa->name = name;
641 free(old_datum);
642 read_buf(f_in, rxa->datum, rxa->datum_len);
643 got_xattr_data = 1;
646 return got_xattr_data;
649 /* ------------------------------------------------------------------------- */
651 /* receive and build the rsync_xattr_lists */
652 void receive_xattr(int f, struct file_struct *file)
654 static item_list temp_xattr = EMPTY_ITEM_LIST;
655 int count, num;
656 #ifdef HAVE_LINUX_XATTRS
657 int need_sort = 0;
658 #else
659 int need_sort = 1;
660 #endif
661 int ndx = read_varint(f);
663 if (ndx < 0 || (size_t)ndx > rsync_xal_l.count) {
664 rprintf(FERROR, "receive_xattr: xa index %d out of"
665 " range for %s\n", ndx, f_name(file, NULL));
666 exit_cleanup(RERR_STREAMIO);
669 if (ndx != 0) {
670 F_XATTR(file) = ndx - 1;
671 return;
674 if ((count = read_varint(f)) != 0) {
675 (void)EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, count);
676 temp_xattr.count = 0;
679 for (num = 1; num <= count; num++) {
680 char *ptr, *name;
681 rsync_xa *rxa;
682 size_t name_len = read_varint(f);
683 size_t datum_len = read_varint(f);
684 size_t dget_len = datum_len > MAX_FULL_DATUM ? 1 + MAX_DIGEST_LEN : datum_len;
685 size_t extra_len = MIGHT_NEED_RPRE ? RPRE_LEN : 0;
686 if ((dget_len + extra_len < dget_len)
687 || (dget_len + extra_len + name_len < dget_len))
688 overflow_exit("receive_xattr");
689 ptr = new_array(char, dget_len + extra_len + name_len);
690 if (!ptr)
691 out_of_memory("receive_xattr");
692 name = ptr + dget_len + extra_len;
693 read_buf(f, name, name_len);
694 if (dget_len == datum_len)
695 read_buf(f, ptr, dget_len);
696 else {
697 *ptr = XSTATE_ABBREV;
698 read_buf(f, ptr + 1, MAX_DIGEST_LEN);
700 #ifdef HAVE_LINUX_XATTRS
701 /* Non-root can only save the user namespace. */
702 if (am_root <= 0 && !HAS_PREFIX(name, USER_PREFIX)) {
703 if (!am_root) {
704 free(ptr);
705 continue;
707 name -= RPRE_LEN;
708 name_len += RPRE_LEN;
709 memcpy(name, RSYNC_PREFIX, RPRE_LEN);
710 need_sort = 1;
712 #else
713 /* This OS only has a user namespace, so we either
714 * strip the user prefix, or we put a non-user
715 * namespace inside our rsync hierarchy. */
716 if (HAS_PREFIX(name, USER_PREFIX)) {
717 name += UPRE_LEN;
718 name_len -= UPRE_LEN;
719 } else if (am_root) {
720 name -= RPRE_LEN;
721 name_len += RPRE_LEN;
722 memcpy(name, RSYNC_PREFIX, RPRE_LEN);
723 } else {
724 free(ptr);
725 continue;
727 #endif
728 /* No rsync.%FOO attributes are copied w/o 2 -X options. */
729 if (preserve_xattrs < 2 && name_len > RPRE_LEN
730 && name[RPRE_LEN] == '%' && HAS_PREFIX(name, RSYNC_PREFIX)) {
731 free(ptr);
732 continue;
734 rxa = EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, 1);
735 rxa->name = name;
736 rxa->datum = ptr;
737 rxa->name_len = name_len;
738 rxa->datum_len = datum_len;
739 rxa->num = num;
742 if (need_sort && count > 1)
743 qsort(temp_xattr.items, count, sizeof (rsync_xa), rsync_xal_compare_names);
745 ndx = rsync_xal_l.count; /* pre-incremented count */
746 rsync_xal_store(&temp_xattr); /* adds item to rsync_xal_l */
748 F_XATTR(file) = ndx;
751 /* Turn the xattr data in stat_x into cached xattr data, setting the index
752 * values in the file struct. */
753 void cache_tmp_xattr(struct file_struct *file, stat_x *sxp)
755 int ndx;
757 if (!sxp->xattr)
758 return;
760 if (prior_xattr_count == (size_t)-1)
761 prior_xattr_count = rsync_xal_l.count;
762 ndx = find_matching_xattr(sxp->xattr);
763 if (ndx < 0)
764 rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
766 F_XATTR(file) = ndx;
769 void uncache_tmp_xattrs(void)
771 if (prior_xattr_count != (size_t)-1) {
772 item_list *xattr_item = rsync_xal_l.items;
773 item_list *xattr_start = xattr_item + prior_xattr_count;
774 xattr_item += rsync_xal_l.count;
775 rsync_xal_l.count = prior_xattr_count;
776 while (xattr_item-- > xattr_start) {
777 rsync_xal_free(xattr_item);
778 free(xattr_item->items);
780 prior_xattr_count = (size_t)-1;
784 static int rsync_xal_set(const char *fname, item_list *xalp,
785 const char *fnamecmp, stat_x *sxp)
787 rsync_xa *rxas = xalp->items;
788 ssize_t list_len;
789 size_t i, len;
790 char *name, *ptr, sum[MAX_DIGEST_LEN];
791 #ifdef HAVE_LINUX_XATTRS
792 int user_only = am_root <= 0;
793 #endif
794 size_t name_len;
795 int ret = 0;
797 /* This puts the current name list into the "namebuf" buffer. */
798 if ((list_len = get_xattr_names(fname)) < 0)
799 return -1;
801 for (i = 0; i < xalp->count; i++) {
802 name = rxas[i].name;
804 if (XATTR_ABBREV(rxas[i])) {
805 /* See if the fnamecmp version is identical. */
806 len = name_len = rxas[i].name_len;
807 if ((ptr = get_xattr_data(fnamecmp, name, &len, 1)) == NULL) {
808 still_abbrev:
809 if (am_generator)
810 continue;
811 rprintf(FERROR, "Missing abbreviated xattr value, %s, for %s\n",
812 rxas[i].name, full_fname(fname));
813 ret = -1;
814 continue;
816 if (len != rxas[i].datum_len) {
817 free(ptr);
818 goto still_abbrev;
821 sum_init(checksum_seed);
822 sum_update(ptr, len);
823 sum_end(sum);
824 if (memcmp(sum, rxas[i].datum + 1, MAX_DIGEST_LEN) != 0) {
825 free(ptr);
826 goto still_abbrev;
829 if (fname == fnamecmp)
830 ; /* Value is already set when identical */
831 else if (sys_lsetxattr(fname, name, ptr, len) < 0) {
832 rsyserr(FERROR_XFER, errno,
833 "rsync_xal_set: lsetxattr(\"%s\",\"%s\") failed",
834 full_fname(fname), name);
835 ret = -1;
836 } else /* make sure caller sets mtime */
837 sxp->st.st_mtime = (time_t)-1;
839 if (am_generator) { /* generator items stay abbreviated */
840 free(ptr);
841 continue;
844 memcpy(ptr + len, name, name_len);
845 free(rxas[i].datum);
847 rxas[i].name = name = ptr + len;
848 rxas[i].datum = ptr;
849 continue;
852 if (sys_lsetxattr(fname, name, rxas[i].datum, rxas[i].datum_len) < 0) {
853 rsyserr(FERROR_XFER, errno,
854 "rsync_xal_set: lsetxattr(\"%s\",\"%s\") failed",
855 full_fname(fname), name);
856 ret = -1;
857 } else /* make sure caller sets mtime */
858 sxp->st.st_mtime = (time_t)-1;
861 /* Remove any extraneous names. */
862 for (name = namebuf; list_len > 0; name += name_len) {
863 name_len = strlen(name) + 1;
864 list_len -= name_len;
866 #ifdef HAVE_LINUX_XATTRS
867 /* We always ignore the system namespace, and non-root
868 * ignores everything but the user namespace. */
869 if (user_only ? !HAS_PREFIX(name, USER_PREFIX)
870 : HAS_PREFIX(name, SYSTEM_PREFIX))
871 continue;
872 #endif
873 if (am_root < 0 && name_len > RPRE_LEN
874 && name[RPRE_LEN] == '%' && strcmp(name, XSTAT_ATTR) == 0)
875 continue;
877 for (i = 0; i < xalp->count; i++) {
878 if (strcmp(name, rxas[i].name) == 0)
879 break;
881 if (i == xalp->count) {
882 if (sys_lremovexattr(fname, name) < 0) {
883 rsyserr(FERROR_XFER, errno,
884 "rsync_xal_set: lremovexattr(\"%s\",\"%s\") failed",
885 full_fname(fname), name);
886 ret = -1;
887 } else /* make sure caller sets mtime */
888 sxp->st.st_mtime = (time_t)-1;
892 return ret;
895 /* Set extended attributes on indicated filename. */
896 int set_xattr(const char *fname, const struct file_struct *file,
897 const char *fnamecmp, stat_x *sxp)
899 int ndx;
900 item_list *lst = rsync_xal_l.items;
902 if (dry_run)
903 return 1; /* FIXME: --dry-run needs to compute this value */
905 if (read_only || list_only) {
906 errno = EROFS;
907 return -1;
910 #ifdef NO_SPECIAL_XATTRS
911 if (IS_SPECIAL(sxp->st.st_mode)) {
912 errno = ENOTSUP;
913 return -1;
915 #endif
916 #ifdef NO_DEVICE_XATTRS
917 if (IS_DEVICE(sxp->st.st_mode)) {
918 errno = ENOTSUP;
919 return -1;
921 #endif
922 #ifdef NO_SYMLINK_XATTRS
923 if (S_ISLNK(sxp->st.st_mode)) {
924 errno = ENOTSUP;
925 return -1;
927 #endif
929 ndx = F_XATTR(file);
930 return rsync_xal_set(fname, lst + ndx, fnamecmp, sxp);
933 #ifdef SUPPORT_ACLS
934 char *get_xattr_acl(const char *fname, int is_access_acl, size_t *len_p)
936 const char *name = is_access_acl ? XACC_ACL_ATTR : XDEF_ACL_ATTR;
937 *len_p = 0; /* no extra data alloc needed from get_xattr_data() */
938 return get_xattr_data(fname, name, len_p, 1);
941 int set_xattr_acl(const char *fname, int is_access_acl, const char *buf, size_t buf_len)
943 const char *name = is_access_acl ? XACC_ACL_ATTR : XDEF_ACL_ATTR;
944 if (sys_lsetxattr(fname, name, buf, buf_len) < 0) {
945 rsyserr(FERROR_XFER, errno,
946 "set_xattr_acl: lsetxattr(\"%s\",\"%s\") failed",
947 full_fname(fname), name);
948 return -1;
950 return 0;
953 int del_def_xattr_acl(const char *fname)
955 return sys_lremovexattr(fname, XDEF_ACL_ATTR);
957 #endif
959 int get_stat_xattr(const char *fname, int fd, STRUCT_STAT *fst, STRUCT_STAT *xst)
961 int mode, rdev_major, rdev_minor, uid, gid, len;
962 char buf[256];
964 if (am_root >= 0 || IS_DEVICE(fst->st_mode) || IS_SPECIAL(fst->st_mode))
965 return -1;
967 if (xst)
968 *xst = *fst;
969 else
970 xst = fst;
971 if (fname) {
972 fd = -1;
973 len = sys_lgetxattr(fname, XSTAT_ATTR, buf, sizeof buf - 1);
974 } else {
975 fname = "fd";
976 len = sys_fgetxattr(fd, XSTAT_ATTR, buf, sizeof buf - 1);
978 if (len >= (int)sizeof buf) {
979 len = -1;
980 errno = ERANGE;
982 if (len < 0) {
983 if (errno == ENOTSUP || errno == ENOATTR)
984 return -1;
985 if (errno == EPERM && S_ISLNK(fst->st_mode)) {
986 xst->st_uid = 0;
987 xst->st_gid = 0;
988 return 0;
990 rsyserr(FERROR_XFER, errno, "failed to read xattr %s for %s",
991 XSTAT_ATTR, full_fname(fname));
992 return -1;
994 buf[len] = '\0';
996 if (sscanf(buf, "%o %d,%d %d:%d",
997 &mode, &rdev_major, &rdev_minor, &uid, &gid) != 5) {
998 rprintf(FERROR, "Corrupt %s xattr attached to %s: \"%s\"\n",
999 XSTAT_ATTR, full_fname(fname), buf);
1000 exit_cleanup(RERR_FILEIO);
1003 xst->st_mode = from_wire_mode(mode);
1004 xst->st_rdev = MAKEDEV(rdev_major, rdev_minor);
1005 xst->st_uid = uid;
1006 xst->st_gid = gid;
1008 return 0;
1011 int set_stat_xattr(const char *fname, struct file_struct *file, mode_t new_mode)
1013 STRUCT_STAT fst, xst;
1014 dev_t rdev;
1015 mode_t mode, fmode;
1017 if (dry_run)
1018 return 0;
1020 if (read_only || list_only) {
1021 rsyserr(FERROR_XFER, EROFS, "failed to write xattr %s for %s",
1022 XSTAT_ATTR, full_fname(fname));
1023 return -1;
1026 if (x_lstat(fname, &fst, &xst) < 0) {
1027 rsyserr(FERROR_XFER, errno, "failed to re-stat %s",
1028 full_fname(fname));
1029 return -1;
1032 fst.st_mode &= (_S_IFMT | CHMOD_BITS);
1033 fmode = new_mode & (_S_IFMT | CHMOD_BITS);
1035 if (IS_DEVICE(fmode)) {
1036 uint32 *devp = F_RDEV_P(file);
1037 rdev = MAKEDEV(DEV_MAJOR(devp), DEV_MINOR(devp));
1038 } else
1039 rdev = 0;
1041 /* Dump the special permissions and enable full owner access. */
1042 mode = (fst.st_mode & _S_IFMT) | (fmode & ACCESSPERMS)
1043 | (S_ISDIR(fst.st_mode) ? 0700 : 0600);
1044 if (fst.st_mode != mode)
1045 do_chmod(fname, mode);
1046 if (!IS_DEVICE(fst.st_mode))
1047 fst.st_rdev = 0; /* just in case */
1049 if (mode == fmode && fst.st_rdev == rdev
1050 && fst.st_uid == F_OWNER(file) && fst.st_gid == F_GROUP(file)) {
1051 /* xst.st_mode will be 0 if there's no current stat xattr */
1052 if (xst.st_mode && sys_lremovexattr(fname, XSTAT_ATTR) < 0) {
1053 rsyserr(FERROR_XFER, errno,
1054 "delete of stat xattr failed for %s",
1055 full_fname(fname));
1056 return -1;
1058 return 0;
1061 if (xst.st_mode != fmode || xst.st_rdev != rdev
1062 || xst.st_uid != F_OWNER(file) || xst.st_gid != F_GROUP(file)) {
1063 char buf[256];
1064 int len = snprintf(buf, sizeof buf, "%o %u,%u %u:%u",
1065 to_wire_mode(fmode),
1066 (int)major(rdev), (int)minor(rdev),
1067 F_OWNER(file), F_GROUP(file));
1068 if (sys_lsetxattr(fname, XSTAT_ATTR, buf, len) < 0) {
1069 if (errno == EPERM && S_ISLNK(fst.st_mode))
1070 return 0;
1071 rsyserr(FERROR_XFER, errno,
1072 "failed to write xattr %s for %s",
1073 XSTAT_ATTR, full_fname(fname));
1074 return -1;
1078 return 0;
1081 int x_stat(const char *fname, STRUCT_STAT *fst, STRUCT_STAT *xst)
1083 int ret = do_stat(fname, fst);
1084 if ((ret < 0 || get_stat_xattr(fname, -1, fst, xst) < 0) && xst)
1085 xst->st_mode = 0;
1086 return ret;
1089 int x_lstat(const char *fname, STRUCT_STAT *fst, STRUCT_STAT *xst)
1091 int ret = do_lstat(fname, fst);
1092 if ((ret < 0 || get_stat_xattr(fname, -1, fst, xst) < 0) && xst)
1093 xst->st_mode = 0;
1094 return ret;
1097 int x_fstat(int fd, STRUCT_STAT *fst, STRUCT_STAT *xst)
1099 int ret = do_fstat(fd, fst);
1100 if ((ret < 0 || get_stat_xattr(NULL, fd, fst, xst) < 0) && xst)
1101 xst->st_mode = 0;
1102 return ret;
1105 #endif /* SUPPORT_XATTRS */