1 This patch provides --flags, which preserves the st_flags field.
2 Modified from a patch that was written by Rolf Grossmann.
4 To use this patch, run these commands for a successful build:
6 patch -p1 <patches/flags.diff
11 TODO: fix --delete-delay to work with --flags option.
15 @@ -94,6 +94,8 @@ void setup_protocol(int f_out,int f_in)
16 preserve_uid = ++file_extra_cnt;
18 preserve_gid = ++file_extra_cnt;
19 + if (preserve_fileflags)
20 + preserve_fileflags = ++file_extra_cnt;
21 if (preserve_acls && !am_sender)
22 preserve_acls = ++file_extra_cnt;
26 @@ -560,7 +560,7 @@ AC_CHECK_FUNCS(waitpid wait4 getcwd strd
27 memmove lchown vsnprintf snprintf vasprintf asprintf setsid glob strpbrk \
28 strlcat strlcpy strtol mallinfo getgroups setgroups geteuid getegid \
29 setlocale setmode open64 lseek64 mkstemp64 mtrace va_copy __va_copy \
30 - strerror putenv iconv_open locale_charset nl_langinfo \
31 + chflags strerror putenv iconv_open locale_charset nl_langinfo \
32 sigaction sigprocmask)
34 AC_CHECK_FUNCS(getpgrp tcgetpgrp)
37 @@ -49,6 +49,7 @@ extern int preserve_links;
38 extern int preserve_hard_links;
39 extern int preserve_devices;
40 extern int preserve_specials;
41 +extern int preserve_fileflags;
42 extern int preserve_uid;
43 extern int preserve_gid;
44 extern int relative_paths;
45 @@ -340,6 +341,9 @@ static void send_file_entry(int f, struc
47 static time_t modtime;
50 + static uint32 fileflags;
54 static uint32 rdev_major;
55 @@ -388,6 +392,12 @@ static void send_file_entry(int f, struc
56 flags |= XMIT_SAME_MODE;
60 + if (F_FFLAGS(file) == fileflags)
61 + flags |= XMIT_SAME_FLAGS;
63 + fileflags = F_FFLAGS(file);
65 if ((preserve_devices && IS_DEVICE(mode))
66 || (preserve_specials && IS_SPECIAL(mode))) {
67 if (protocol_version < 28) {
68 @@ -505,6 +515,10 @@ static void send_file_entry(int f, struc
70 if (!(flags & XMIT_SAME_MODE))
71 write_int(f, to_wire_mode(mode));
73 + if (preserve_fileflags && !(flags & XMIT_SAME_FLAGS))
74 + write_int(f, (int)fileflags);
76 if (preserve_uid && !(flags & XMIT_SAME_UID)) {
77 if (protocol_version < 30)
79 @@ -593,6 +607,9 @@ static struct file_struct *recv_file_ent
84 + static uint32 fileflags;
88 static uint32 rdev_major;
89 @@ -725,9 +742,12 @@ static struct file_struct *recv_file_ent
91 if (!(flags & XMIT_SAME_MODE))
92 mode = from_wire_mode(read_int(f));
94 if (chmod_modes && !S_ISLNK(mode))
95 mode = tweak_mode(mode, chmod_modes);
97 + if (preserve_fileflags && !(flags & XMIT_SAME_FLAGS))
98 + fileflags = (uint32)read_int(f);
101 if (preserve_uid && !(flags & XMIT_SAME_UID)) {
102 if (protocol_version < 30)
103 @@ -846,6 +866,10 @@ static struct file_struct *recv_file_ent
104 OPT_EXTRA(file, 0)->unum = (uint32)(file_length >> 32);
107 +#ifdef SUPPORT_FLAGS
108 + if (preserve_fileflags)
109 + F_FFLAGS(file) = fileflags;
114 @@ -1159,6 +1183,10 @@ struct file_struct *make_file(const char
115 OPT_EXTRA(file, 0)->unum = (uint32)(st.st_size >> 32);
117 file->mode = st.st_mode;
118 +#ifdef SUPPORT_FLAGS
119 + if (preserve_fileflags)
120 + F_FFLAGS(file) = st.st_flags;
123 F_OWNER(file) = st.st_uid;
127 @@ -115,6 +115,14 @@ static int dir_tweaking;
128 static int need_retouch_dir_times;
129 static const char *solo_file = NULL;
131 +#ifdef SUPPORT_FLAGS
132 +#define FF_PTR(p) F_FFLAGS(p)
133 +#define FF_STAT(s) s.st_flags
136 +#define FF_STAT(s) 0
139 /* For calling delete_item() and delete_dir_contents(). */
140 #define DEL_RECURSE (1<<1) /* recurse */
141 #define DEL_DIR_IS_EMPTY (1<<2) /* internal delete_FUNCTIONS use only */
142 @@ -130,7 +138,6 @@ enum delret {
143 /* Forward declaration for delete_item(). */
144 static enum delret delete_dir_contents(char *fname, int flags);
147 static int is_backup_file(char *fn)
149 int k = strlen(fn) - backup_suffix_len;
150 @@ -143,17 +150,20 @@ static int is_backup_file(char *fn)
151 * Note that fbuf must point to a MAXPATHLEN buffer if the mode indicates it's
152 * a directory! (The buffer is used for recursion, but returned unchanged.)
154 -static enum delret delete_item(char *fbuf, int mode, char *replace, int flags)
155 +static enum delret delete_item(char *fbuf, int mode, uint32 fileflags, char *replace, int flags)
162 - rprintf(FINFO, "delete_item(%s) mode=%o flags=%d\n",
163 - fbuf, mode, flags);
164 + rprintf(FINFO, "delete_item(%s) mode=%o fileflags=%o flags=%d\n",
165 + fbuf, mode, fileflags, flags);
168 +#ifdef SUPPORT_FLAGS
169 + make_mutable(fbuf, mode, fileflags);
171 if (S_ISDIR(mode) && !(flags & DEL_DIR_IS_EMPTY)) {
172 ignore_perishable = 1;
173 /* If DEL_RECURSE is not set, this just reports emptiness. */
174 @@ -265,7 +275,7 @@ static enum delret delete_dir_contents(c
175 if (S_ISDIR(fp->mode)
176 && delete_dir_contents(fname, flags | DEL_RECURSE) != DR_SUCCESS)
178 - if (delete_item(fname, fp->mode, NULL, flags) != DR_SUCCESS)
179 + if (delete_item(fname, fp->mode, FF_PTR(fp), NULL, flags) != DR_SUCCESS)
183 @@ -321,8 +331,9 @@ static int remember_delete(struct file_s
186 len = snprintf(deldelay_buf + deldelay_cnt,
187 - deldelay_size - deldelay_cnt,
188 - "%x %s%c", (int)file->mode, fname, '\0');
189 + deldelay_size - deldelay_cnt, "%x %x %s%c",
190 + (int)file->mode, (int)FF_PTR(file),
192 if ((deldelay_cnt += len) <= deldelay_size)
194 if (deldelay_fd < 0 && !start_delete_delay_temp())
195 @@ -335,7 +346,7 @@ static int remember_delete(struct file_s
199 -static int read_delay_line(char *buf)
200 +static int read_delay_line(char *buf, int *fileflags_p)
202 static int read_pos = 0;
204 @@ -377,7 +388,7 @@ static int read_delay_line(char *buf)
206 bp = deldelay_buf + read_pos;
208 - if (sscanf(bp, "%x ", &mode) != 1) {
209 + if (sscanf(bp, "%x %x ", &mode, fileflags_p) != 2) {
211 rprintf(FERROR, "ERROR: invalid data in delete-delay file.\n");
213 @@ -400,15 +411,15 @@ static int read_delay_line(char *buf)
215 static void do_delayed_deletions(char *delbuf)
218 + int mode, fileflags;
220 if (deldelay_fd >= 0) {
221 if (deldelay_cnt && !flush_delete_delay())
223 lseek(deldelay_fd, 0, 0);
225 - while ((mode = read_delay_line(delbuf)) >= 0)
226 - delete_item(delbuf, mode, NULL, DEL_RECURSE);
227 + while ((mode = read_delay_line(delbuf, &fileflags)) >= 0)
228 + delete_item(delbuf, mode, fileflags, NULL, DEL_RECURSE);
229 if (deldelay_fd >= 0)
232 @@ -475,7 +486,7 @@ static void delete_in_dir(char *fbuf, st
233 if (!remember_delete(fp, delbuf))
236 - delete_item(delbuf, fp->mode, NULL, DEL_RECURSE);
237 + delete_item(delbuf, fp->mode, FF_PTR(fp), NULL, DEL_RECURSE);
241 @@ -1213,7 +1224,7 @@ static void recv_generator(char *fname,
242 * we need to delete it. If it doesn't exist, then
243 * (perhaps recursively) create it. */
244 if (statret == 0 && !S_ISDIR(sx.st.st_mode)) {
245 - if (delete_item(fname, sx.st.st_mode, "directory", del_opts) != 0)
246 + if (delete_item(fname, sx.st.st_mode, FF_STAT(sx.st), "directory", del_opts) != 0)
250 @@ -1326,7 +1337,7 @@ static void recv_generator(char *fname,
252 /* Not the right symlink (or not a symlink), so
254 - if (delete_item(fname, sx.st.st_mode, "symlink", del_opts) != 0)
255 + if (delete_item(fname, sx.st.st_mode, FF_STAT(sx.st), "symlink", del_opts) != 0)
257 } else if (basis_dir[0] != NULL) {
258 int j = try_dests_non(file, fname, ndx, fnamecmpbuf, &sx,
259 @@ -1403,7 +1414,7 @@ static void recv_generator(char *fname,
260 goto return_with_success;
263 - if (delete_item(fname, sx.st.st_mode, t, del_opts) != 0)
264 + if (delete_item(fname, sx.st.st_mode, FF_STAT(sx.st), t, del_opts) != 0)
266 } else if (basis_dir[0] != NULL) {
267 int j = try_dests_non(file, fname, ndx, fnamecmpbuf, &sx,
268 @@ -1492,7 +1503,7 @@ static void recv_generator(char *fname,
269 fnamecmp_type = FNAMECMP_FNAME;
271 if (statret == 0 && !S_ISREG(sx.st.st_mode)) {
272 - if (delete_item(fname, sx.st.st_mode, "regular file", del_opts) != 0)
273 + if (delete_item(fname, sx.st.st_mode, FF_STAT(sx.st), "regular file", del_opts) != 0)
279 @@ -49,6 +49,7 @@ int preserve_hard_links = 0;
280 int preserve_acls = 0;
281 int preserve_xattrs = 0;
282 int preserve_perms = 0;
283 +int preserve_fileflags = 0;
284 int preserve_executability = 0;
285 int preserve_devices = 0;
286 int preserve_specials = 0;
287 @@ -212,6 +213,7 @@ static void print_rsync_version(enum log
288 char const *links = "no ";
289 char const *iconv = "no ";
290 char const *ipv6 = "no ";
291 + char const *fileflags = "no ";
292 STRUCT_STAT *dumstat;
294 #if SUBPROTOCOL_VERSION != 0
295 @@ -241,6 +243,9 @@ static void print_rsync_version(enum log
299 +#ifdef SUPPORT_FLAGS
303 rprintf(f, "%s version %s protocol version %d%s\n",
304 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
305 @@ -254,8 +259,8 @@ static void print_rsync_version(enum log
306 (int)(sizeof (int64) * 8));
307 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
308 got_socketpair, hardlinks, links, ipv6, have_inplace);
309 - rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv\n",
310 - have_inplace, acls, xattrs, iconv);
311 + rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %sfile-flags\n",
312 + have_inplace, acls, xattrs, iconv, fileflags);
314 #ifdef MAINTAINER_MODE
315 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
316 @@ -321,6 +326,7 @@ void usage(enum logcode F)
317 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
318 rprintf(F," -H, --hard-links preserve hard links\n");
319 rprintf(F," -p, --perms preserve permissions\n");
320 + rprintf(F," --fileflags preserve file-flags\n");
321 rprintf(F," -E, --executability preserve the file's executability\n");
322 rprintf(F," --chmod=CHMOD affect file and/or directory permissions\n");
324 @@ -458,6 +464,8 @@ static struct poptOption long_options[]
325 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
326 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
327 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
328 + {"fileflags", 0, POPT_ARG_VAL, &preserve_fileflags, 1, 0, 0 },
329 + {"no-fileflags", 0, POPT_ARG_VAL, &preserve_fileflags, 0, 0, 0 },
330 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
331 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
332 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
333 @@ -1236,6 +1244,15 @@ int parse_arguments(int *argc, const cha
337 +#ifndef SUPPORT_FLAGS
338 + if (preserve_fileflags) {
339 + snprintf(err_buf, sizeof err_buf,
340 + "file flags are not supported on this %s\n",
341 + am_server ? "server" : "client");
346 if (write_batch && read_batch) {
347 snprintf(err_buf, sizeof err_buf,
348 "--write-batch and --read-batch can not be used together\n");
349 @@ -1712,6 +1729,9 @@ void server_options(char **args,int *arg
350 if (xfer_dirs && !recurse && delete_mode && am_sender)
351 args[ac++] = "--no-r";
353 + if (preserve_fileflags)
354 + args[ac++] = "--flags";
356 if (do_compression && def_compress_level != Z_DEFAULT_COMPRESSION) {
357 if (asprintf(&arg, "--compress-level=%d", def_compress_level) < 0)
361 @@ -31,6 +31,7 @@ extern int dry_run;
362 extern int preserve_acls;
363 extern int preserve_xattrs;
364 extern int preserve_perms;
365 +extern int preserve_fileflags;
366 extern int preserve_executability;
367 extern int preserve_times;
368 extern int omit_dir_times;
369 @@ -61,6 +62,16 @@ iconv_t ic_send = (iconv_t)-1, ic_recv =
373 +#ifdef SUPPORT_FLAGS
375 +#define UF_NOUNLINK 0
378 +#define SF_NOUNLINK 0
380 +#define NOCHANGE_FLAGS (UF_IMMUTABLE|UF_APPEND|UF_NOUNLINK|SF_IMMUTABLE|SF_APPEND|SF_NOUNLINK)
383 static const char *default_charset(void)
385 #if defined HAVE_LIBCHARSET_H && defined HAVE_LOCALE_CHARSET
386 @@ -265,6 +276,41 @@ mode_t dest_mode(mode_t flist_mode, mode
390 +#ifdef SUPPORT_FLAGS
391 +/* Set a file's st_flags. */
392 +static int set_fileflags(const char *fname, uint32 fileflags)
394 + if (do_chflags(fname, fileflags) != 0) {
395 + rsyserr(FERROR, errno,
396 + "failed to set file flags on %s",
397 + full_fname(fname));
404 +/* Remove immutable flags from an object, so it can be altered/removed. */
405 +void make_mutable(char *fname, mode_t mode, uint32 fileflags)
407 + if (!preserve_fileflags && S_ISLNK(mode))
410 + if (fileflags & NOCHANGE_FLAGS)
411 + set_fileflags(fname, fileflags & ~NOCHANGE_FLAGS);
414 +/* Undo a prior make_mutable() call. */
415 +void undo_make_mutable(char *fname, mode_t mode, uint32 fileflags)
417 + if (!preserve_fileflags && S_ISLNK(mode))
420 + if (fileflags & NOCHANGE_FLAGS)
421 + set_fileflags(fname, fileflags);
425 int set_file_attrs(const char *fname, struct file_struct *file, statx *sxp,
426 const char *fnamecmp, int flags)
428 @@ -395,6 +441,15 @@ int set_file_attrs(const char *fname, st
432 +#ifdef SUPPORT_FLAGS
433 + if (preserve_fileflags && !S_ISLNK(sxp->st.st_mode)
434 + && sxp->st.st_flags != F_FFLAGS(file)) {
435 + if (!set_fileflags(fname, F_FFLAGS(file)))
441 if (verbose > 1 && flags & ATTRS_REPORT) {
443 rprintf(FCLIENT, "%s\n", fname);
444 @@ -454,6 +509,9 @@ void finish_transfer(const char *fname,
445 set_file_attrs(fnametmp, file, NULL, fnamecmp,
446 ok_to_set_time ? 0 : ATTRS_SKIP_MTIME);
448 +#ifdef SUPPORT_FLAGS
449 + make_mutable(fnametmp, file->mode, F_FFLAGS(file));
451 /* move tmp file over real file */
453 rprintf(FINFO, "renaming %s to %s\n", fnametmp, fname);
454 @@ -468,6 +526,9 @@ void finish_transfer(const char *fname,
457 /* The file was moved into place (not copied), so it's done. */
458 +#ifdef SUPPORT_FLAGS
459 + undo_make_mutable(fname, file->mode, F_FFLAGS(file));
463 /* The file was copied, so tweak the perms of the copied file. If it
467 #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29 */
468 #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - NOW */
469 #define XMIT_HLINK_FIRST (1<<12) /* protocols 30 - NOW */
470 +#define XMIT_SAME_FLAGS (1<<14) /* protocols ?? - NOW */
472 /* These flags are used in the live flist data. */
474 @@ -403,6 +404,10 @@ enum msgcode {
479 +#define SUPPORT_FLAGS 1
482 /* Find a variable that is either exactly 32-bits or longer.
483 * If some code depends on 32-bit truncation, it will need to
484 * take special action in a "#if SIZEOF_INT32 > 4" section. */
485 @@ -582,6 +587,7 @@ struct file_struct {
486 extern int file_extra_cnt;
487 extern int preserve_uid;
488 extern int preserve_gid;
489 +extern int preserve_fileflags;
490 extern int preserve_acls;
491 extern int preserve_xattrs;
493 @@ -616,6 +622,7 @@ extern int preserve_xattrs;
494 /* When the associated option is on, all entries will have these present: */
495 #define F_OWNER(f) REQ_EXTRA(f, preserve_uid)->unum
496 #define F_GROUP(f) REQ_EXTRA(f, preserve_gid)->unum
497 +#define F_FFLAGS(f) REQ_EXTRA(f, preserve_fileflags)->unum
498 #define F_ACL(f) REQ_EXTRA(f, preserve_acls)->num
499 #define F_XATTR(f) REQ_EXTRA(f, preserve_xattrs)->num
500 #define F_NDX(f) REQ_EXTRA(f, ic_ndx)->num
503 @@ -321,6 +321,7 @@ to the detailed description below for a
504 -K, --keep-dirlinks treat symlinked dir on receiver as dir
505 -H, --hard-links preserve hard links
506 -p, --perms preserve permissions
507 + --flags preserve file flags
508 -E, --executability preserve executability
509 --chmod=CHMOD affect file and/or directory permissions
510 -A, --acls preserve ACLs (implies -p)
511 @@ -520,7 +521,9 @@ specified, in which case bf(-r) is not i
513 Note that bf(-a) bf(does not preserve hardlinks), because
514 finding multiply-linked files is expensive. You must separately
516 +specify bf(-H). Note also that for compatibility, bf(-a)
517 +currently bf(does not include --flags) (see there) to include preserving
518 +change file flags (if supported by the OS).
520 dit(--no-OPTION) You may turn off one or more implied options by prefixing
521 the option name with "no-". Not all options may be prefixed with a "no-":
522 @@ -845,6 +848,13 @@ extended attributes to be the same as th
523 only if the remote machine's rsync supports this option also. This is
524 a non-standard option.
526 +dit(bf(--flags)) This option causes rsync to update the change file flags
527 +to be the same as the source file, if your OS supports the bf(chflags)(2)
528 +system call. In any case, an attempt is made to remove flags that would
529 +prevent a file to be altered. Some flags can only be altered by the
530 +super-user and can only be unset below a certain secure-level (usually
533 dit(bf(--chmod)) This option tells rsync to apply one or more
534 comma-separated "chmod" strings to the permission of the files in the
535 transfer. The resulting value is treated as though it was the permissions
538 @@ -162,6 +162,15 @@ int do_chmod(const char *path, mode_t mo
542 +#ifdef SUPPORT_FLAGS
543 +int do_chflags(const char *path, u_long flags)
545 + if (dry_run) return 0;
546 + RETURN_ERROR_IF_RO_OR_LO;
547 + return chflags(path, flags);
551 int do_rename(const char *fname1, const char *fname2)
553 if (dry_run) return 0;