2 * Copyright (C) 1996, 2000 Andrew Tridgell
3 * Copyright (C) 1996 Paul Mackerras
4 * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
5 * Copyright (C) 2003-2018 Wayne Davison
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, visit the http://fsf.org website.
24 #define BLOCK_SIZE 700
25 #define RSYNC_RSH_ENV "RSYNC_RSH"
26 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
28 #define RSYNC_NAME "rsync"
29 /* RSYNCD_SYSCONF is now set in config.h */
30 #define RSYNCD_USERCONF "rsyncd.conf"
32 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
33 #define URL_PREFIX "rsync://"
35 #define SYMLINK_PREFIX "/rsyncd-munged/" /* This MUST have a trailing slash! */
36 #define SYMLINK_PREFIX_LEN ((int)sizeof SYMLINK_PREFIX - 1)
38 #define BACKUP_SUFFIX "~"
40 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
41 incompatible with older versions :-( */
44 /* These flags are only used during the flist transfer. */
46 #define XMIT_TOP_DIR (1<<0)
47 #define XMIT_SAME_MODE (1<<1)
48 #define XMIT_SAME_RDEV_pre28 (1<<2) /* protocols 20 - 27 */
49 #define XMIT_EXTENDED_FLAGS (1<<2) /* protocols 28 - now */
50 #define XMIT_SAME_UID (1<<3)
51 #define XMIT_SAME_GID (1<<4)
52 #define XMIT_SAME_NAME (1<<5)
53 #define XMIT_LONG_NAME (1<<6)
54 #define XMIT_SAME_TIME (1<<7)
55 #define XMIT_SAME_RDEV_MAJOR (1<<8) /* protocols 28 - now (devices only) */
56 #define XMIT_NO_CONTENT_DIR (1<<8) /* protocols 30 - now (dirs only) */
57 #define XMIT_HLINKED (1<<9) /* protocols 28 - now */
58 #define XMIT_SAME_DEV_pre30 (1<<10) /* protocols 28 - 29 */
59 #define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - now */
60 #define XMIT_RDEV_MINOR_8_pre30 (1<<11) /* protocols 28 - 29 */
61 #define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
62 #define XMIT_HLINK_FIRST (1<<12) /* protocols 30 - now (HLINKED files only) */
63 #define XMIT_IO_ERROR_ENDLIST (1<<12) /* protocols 31*- now (w/XMIT_EXTENDED_FLAGS) (also protocol 30 w/'f' compat flag) */
64 #define XMIT_MOD_NSEC (1<<13) /* protocols 31 - now */
66 /* These flags are used in the live flist data. */
68 #define FLAG_TOP_DIR (1<<0) /* sender/receiver/generator */
69 #define FLAG_OWNED_BY_US (1<<0) /* generator: set by make_file() for aux flists only */
70 #define FLAG_FILE_SENT (1<<1) /* sender/receiver/generator */
71 #define FLAG_DIR_CREATED (1<<1) /* generator */
72 #define FLAG_CONTENT_DIR (1<<2) /* sender/receiver/generator */
73 #define FLAG_MOUNT_DIR (1<<3) /* sender/generator (dirs only) */
74 #define FLAG_SKIP_HLINK (1<<3) /* receiver/generator (w/FLAG_HLINKED) */
75 #define FLAG_DUPLICATE (1<<4) /* sender */
76 #define FLAG_MISSING_DIR (1<<4) /* generator */
77 #define FLAG_HLINKED (1<<5) /* receiver/generator (checked on all types) */
78 #define FLAG_HLINK_FIRST (1<<6) /* receiver/generator (w/FLAG_HLINKED) */
79 #define FLAG_IMPLIED_DIR (1<<6) /* sender/receiver/generator (dirs only) */
80 #define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
81 #define FLAG_HLINK_DONE (1<<8) /* receiver/generator (checked on all types) */
82 #define FLAG_LENGTH64 (1<<9) /* sender/receiver/generator */
83 #define FLAG_SKIP_GROUP (1<<10) /* receiver/generator */
84 #define FLAG_TIME_FAILED (1<<11)/* generator */
85 #define FLAG_MOD_NSEC (1<<12) /* sender/receiver/generator */
87 /* These flags are passed to functions but not stored. */
89 #define FLAG_DIVERT_DIRS (1<<16) /* sender, but must be unique */
91 /* These flags are for get_dirlist(). */
92 #define GDL_IGNORE_FILTER_RULES (1<<0)
94 /* Some helper macros for matching bits. */
95 #define BITS_SET(val,bits) (((val) & (bits)) == (bits))
96 #define BITS_SETnUNSET(val,onbits,offbits) (((val) & ((onbits)|(offbits))) == (onbits))
97 #define BITS_EQUAL(b1,b2,mask) (((unsigned)(b1) & (unsigned)(mask)) \
98 == ((unsigned)(b2) & (unsigned)(mask)))
100 /* update this if you make incompatible changes */
101 #define PROTOCOL_VERSION 31
103 /* This is used when working on a new protocol version in CVS, and should
104 * be a new non-zero value for each CVS change that affects the protocol.
105 * It must ALWAYS be 0 when the protocol goes final (and NEVER before)! */
106 #define SUBPROTOCOL_VERSION 0
108 /* We refuse to interoperate with versions that are not in this range.
109 * Note that we assume we'll work with later versions: the onus is on
110 * people writing them to make sure that they don't send us anything
111 * we won't understand.
113 * Interoperation with old but supported protocol versions
114 * should cause a warning to be printed. At a future date
115 * the old protocol will become the minimum and
116 * compatibility code removed.
118 * There are two possible explanations for the limit at
119 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
120 * do not interoperate with us, and (more likely) so that we can
121 * detect an attempt to connect rsync to a non-rsync server, which is
122 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
123 * MAX_PROTOCOL_VERSION. */
125 #define MIN_PROTOCOL_VERSION 20
126 #define OLD_PROTOCOL_VERSION 25
127 #define MAX_PROTOCOL_VERSION 40
129 #define MIN_FILECNT_LOOKAHEAD 1000
130 #define MAX_FILECNT_LOOKAHEAD 10000
132 #define RSYNC_PORT 873
134 #define SPARSE_WRITE_SIZE (1024)
135 #define WRITE_SIZE (32*1024)
136 #define CHUNK_SIZE (32*1024)
137 #define MAX_MAP_SIZE (256*1024)
138 #define IO_BUFFER_SIZE (32*1024)
139 #define MAX_BLOCK_SIZE ((int32)1 << 17)
141 /* For compatibility with older rsyncs */
142 #define OLD_MAX_BLOCK_SIZE ((int32)1 << 29)
144 #define ROUND_UP_1024(siz) ((siz) & (1024-1) ? ((siz) | (1024-1)) + 1 : (siz))
146 #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
147 #define IOERR_VANISHED (1<<1)
148 #define IOERR_DEL_LIMIT (1<<2)
150 #define MAX_ARGS 1000
151 #define MAX_BASIS_DIRS 20
152 #define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
157 #define SERVER_FILTERS 1
158 #define ALL_FILTERS 2
160 #define XFLG_FATAL_ERRORS (1<<0)
161 #define XFLG_OLD_PREFIXES (1<<1)
162 #define XFLG_ANCHORED2ABS (1<<2) /* leading slash indicates absolute */
163 #define XFLG_ABS_IF_SLASH (1<<3) /* leading or interior slash is absolute */
164 #define XFLG_DIR2WILD3 (1<<4) /* dir/ match gets trailing *** added */
166 #define ATTRS_REPORT (1<<0)
167 #define ATTRS_SKIP_MTIME (1<<1)
170 #define NORMAL_FLUSH 0
172 #define PDIR_CREATE 1
173 #define PDIR_DELETE 0
175 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
176 #define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
177 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
178 #define FNAMECMP_FNAME 0x80
179 #define FNAMECMP_PARTIAL_DIR 0x81
180 #define FNAMECMP_BACKUP 0x82
181 #define FNAMECMP_FUZZY 0x83
183 /* For use by the itemize_changes code */
184 #define ITEM_REPORT_ATIME (1<<0)
185 #define ITEM_REPORT_CHANGE (1<<1)
186 #define ITEM_REPORT_SIZE (1<<2) /* regular files only */
187 #define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
188 #define ITEM_REPORT_TIME (1<<3)
189 #define ITEM_REPORT_PERMS (1<<4)
190 #define ITEM_REPORT_OWNER (1<<5)
191 #define ITEM_REPORT_GROUP (1<<6)
192 #define ITEM_REPORT_ACL (1<<7)
193 #define ITEM_REPORT_XATTR (1<<8)
194 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
195 #define ITEM_XNAME_FOLLOWS (1<<12)
196 #define ITEM_IS_NEW (1<<13)
197 #define ITEM_LOCAL_CHANGE (1<<14)
198 #define ITEM_TRANSFER (1<<15)
199 /* These are outside the range of the transmitted flags. */
200 #define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
201 #define ITEM_DELETED (1<<17) /* used by log_formatted() */
202 #define ITEM_MATCHED (1<<18) /* used by itemize() */
204 #define SIGNIFICANT_ITEM_FLAGS (~(\
205 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
207 #define CFN_KEEP_DOT_DIRS (1<<0)
208 #define CFN_KEEP_TRAILING_SLASH (1<<1)
209 #define CFN_DROP_TRAILING_DOT_DIR (1<<2)
210 #define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
211 #define CFN_REFUSE_DOT_DOT_DIRS (1<<4)
214 #define SP_KEEP_DOT_DIRS (1<<0)
217 #define CD_SKIP_CHDIR 1
219 /* Log-message categories. FLOG only goes to the log file, not the client;
220 * FCLIENT is the opposite. */
222 FNONE=0, /* never sent */
223 FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
224 FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
225 FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
226 FERROR_UTF8=8, /* only sent via receiver -> generator pipe */
227 FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
230 /* Messages types that are sent over the message channel. The logcode
231 * values must all be present here with identical numbers. */
233 MSG_DATA=0, /* raw data on the multiplexed stream */
234 MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
235 MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
236 MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
237 MSG_ERROR_UTF8=FERROR_UTF8, /* sibling logging */
238 MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
239 MSG_REDO=9, /* reprocess indicated flist index */
240 MSG_STATS=10, /* message has stats data for generator */
241 MSG_IO_ERROR=22,/* the sending side had an I/O error */
242 MSG_IO_TIMEOUT=33,/* tell client about a daemon's timeout value */
243 MSG_NOOP=42, /* a do-nothing message (legacy protocol-30 only) */
244 MSG_ERROR_EXIT=86, /* synchronize an error exit (siblings and protocol >= 31) */
245 MSG_SUCCESS=100,/* successfully updated indicated flist index */
246 MSG_DELETED=101,/* successfully deleted a file on receiving side */
247 MSG_NO_SEND=102,/* sender failed to open a file we wanted */
251 #define NDX_FLIST_EOF -2
252 #define NDX_DEL_STATS -3
253 #define NDX_FLIST_OFFSET -101
255 /* For calling delete_item() and delete_dir_contents(). */
256 #define DEL_NO_UID_WRITE (1<<0) /* file/dir has our uid w/o write perm */
257 #define DEL_RECURSE (1<<1) /* if dir, delete all contents */
258 #define DEL_DIR_IS_EMPTY (1<<2) /* internal delete_FUNCTIONS use only */
259 #define DEL_FOR_FILE (1<<3) /* making room for a replacement file */
260 #define DEL_FOR_DIR (1<<4) /* making room for a replacement dir */
261 #define DEL_FOR_SYMLINK (1<<5) /* making room for a replacement symlink */
262 #define DEL_FOR_DEVICE (1<<6) /* making room for a replacement device */
263 #define DEL_FOR_SPECIAL (1<<7) /* making room for a replacement special */
264 #define DEL_FOR_BACKUP (1<<8) /* the delete is for a backup operation */
266 #define DEL_MAKE_ROOM (DEL_FOR_FILE|DEL_FOR_DIR|DEL_FOR_SYMLINK|DEL_FOR_DEVICE|DEL_FOR_SPECIAL)
269 DR_SUCCESS = 0, DR_FAILURE, DR_AT_LIMIT, DR_NOT_EMPTY
272 /* Defines for make_path() */
273 #define MKP_DROP_NAME (1<<0) /* drop trailing filename or trailing slash */
274 #define MKP_SKIP_SLASH (1<<1) /* skip one or more leading slashes */
276 /* Defines for maybe_send_keepalive() */
277 #define MSK_ALLOW_FLUSH (1<<0)
278 #define MSK_ACTIVE_RECEIVER (1<<1)
284 /* The default RSYNC_RSH is always set in config.h. */
287 #ifdef HAVE_SYS_TYPES_H
288 # include <sys/types.h>
290 #ifdef HAVE_SYS_STAT_H
291 # include <sys/stat.h>
297 # ifdef HAVE_STDLIB_H
302 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
307 #ifdef HAVE_STRINGS_H
308 # include <strings.h>
310 #ifdef HAVE_INTTYPES_H
311 # include <inttypes.h>
320 #ifdef HAVE_SYS_PARAM_H
321 #include <sys/param.h>
324 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
328 #ifdef HAVE_SYS_SOCKET_H
329 #include <sys/socket.h>
332 #ifdef TIME_WITH_SYS_TIME
333 #include <sys/time.h>
336 #ifdef HAVE_SYS_TIME_H
337 #include <sys/time.h>
346 #ifdef HAVE_SYS_FCNTL_H
347 #include <sys/fcntl.h>
351 #ifdef HAVE_SYS_IOCTL_H
352 #include <sys/ioctl.h>
355 #ifdef HAVE_SYS_FILIO_H
356 #include <sys/filio.h>
360 #ifdef HAVE_SYS_WAIT_H
361 #include <sys/wait.h>
375 #if defined HAVE_UTIMENSAT || defined HAVE_LUTIMES || defined HAVE_SETATTRLIST
376 #define CAN_SET_SYMLINK_TIMES 1
379 #if defined HAVE_LCHOWN || defined CHOWN_MODIFIES_SYMLINK
380 #define CAN_CHOWN_SYMLINK 1
383 #if defined HAVE_LCHMOD || defined HAVE_SETATTRLIST
384 #define CAN_CHMOD_SYMLINK 1
387 #if defined HAVE_UTIMENSAT || defined HAVE_SETATTRLIST
388 #define CAN_SET_NSEC 1
392 #ifdef HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
393 #define ST_MTIME_NSEC st_mtim.tv_nsec
394 #elif defined(HAVE_STRUCT_STAT_ST_MTIMENSEC)
395 #define ST_MTIME_NSEC st_mtimensec
396 #elif defined(HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC)
397 #define ST_MTIME_NSEC st_mtimespec.tv_nsec
401 #ifdef HAVE_SYS_SELECT_H
402 #include <sys/select.h>
405 #ifdef HAVE_SYS_MODE_H
406 /* apparently AIX needs this for S_ISLNK */
408 #include <sys/mode.h>
412 /* these are needed for the uid/gid mapping code */
417 #include <netinet/in.h>
418 #include <arpa/inet.h>
423 #include <sys/file.h>
428 # define dirent direct
429 # ifdef HAVE_SYS_NDIR_H
430 # include <sys/ndir.h>
432 # ifdef HAVE_SYS_DIR_H
433 # include <sys/dir.h>
440 #ifdef MAJOR_IN_MKDEV
441 #include <sys/mkdev.h>
442 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
443 # define makedev mkdev
445 #elif defined MAJOR_IN_SYSMACROS
446 #include <sys/sysmacros.h>
449 #ifdef MAKEDEV_TAKES_3_ARGS
450 #define MAKEDEV(devmajor,devminor) makedev(0,devmajor,devminor)
452 #define MAKEDEV(devmajor,devminor) makedev(devmajor,devminor)
463 #if defined USE_ICONV_OPEN && defined HAVE_ICONV_H
483 #include "lib/pool_alloc.h"
486 typedef unsigned int id_t;
492 typedef unsigned int mode_t;
497 #define SIZEOF_OFF_T SIZEOF_LONG
500 typedef unsigned int size_t;
506 #define uchar unsigned char
509 #ifdef SIGNED_CHAR_OK
510 #define schar signed char
516 #if SIZEOF_INT16_T == 2
517 # define int16 int16_t
524 #if SIZEOF_UINT16_T == 2
525 # define uint16 uint16_t
527 # define uint16 unsigned int16
531 /* Find a variable that is either exactly 32-bits or longer.
532 * If some code depends on 32-bit truncation, it will need to
533 * take special action in a "#if SIZEOF_INT32 > 4" section. */
535 #if SIZEOF_INT32_T == 4
536 # define int32 int32_t
537 # define SIZEOF_INT32 4
538 #elif SIZEOF_INT == 4
540 # define SIZEOF_INT32 4
541 #elif SIZEOF_LONG == 4
543 # define SIZEOF_INT32 4
544 #elif SIZEOF_SHORT == 4
546 # define SIZEOF_INT32 4
549 # define SIZEOF_INT32 SIZEOF_INT
550 #elif SIZEOF_LONG > 4
552 # define SIZEOF_INT32 SIZEOF_LONG
554 # error Could not find a 32-bit integer variable
557 # define SIZEOF_INT32 4
561 #if SIZEOF_UINT32_T == 4
562 # define uint32 uint32_t
564 # define uint32 unsigned int32
568 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
570 #define STRUCT_STAT struct stat
571 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF_T
573 #define OFF_T off64_t
574 #define STRUCT_STAT struct stat64
575 #define USE_STAT64_FUNCS 1
576 #define SIZEOF_CAPITAL_OFF_T SIZEOF_OFF64_T
579 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
580 * that's the maximum size the file system can handle and there is no
581 * 64-bit type available. The rsync source must therefore take steps
582 * to ensure that any code that really requires a 64-bit integer has
583 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
585 #if SIZEOF_INT64_T == 8
586 # define int64 int64_t
587 # define SIZEOF_INT64 8
588 #elif SIZEOF_LONG == 8
590 # define SIZEOF_INT64 8
591 #elif SIZEOF_INT == 8
593 # define SIZEOF_INT64 8
594 #elif SIZEOF_LONG_LONG == 8
595 # define int64 long long
596 # define SIZEOF_INT64 8
597 #elif SIZEOF_OFF64_T == 8
598 # define int64 off64_t
599 # define SIZEOF_INT64 8
600 #elif SIZEOF_OFF_T == 8
602 # define SIZEOF_INT64 8
605 # define SIZEOF_INT64 SIZEOF_INT
606 #elif SIZEOF_LONG > 8
608 # define SIZEOF_INT64 SIZEOF_LONG
609 #elif SIZEOF_LONG_LONG > 8
610 # define int64 long long
611 # define SIZEOF_INT64 SIZEOF_LONG_LONG
613 /* As long as it gets... */
615 # define SIZEOF_INT64 SIZEOF_OFF_T
625 struct ht_int32_node {
630 struct ht_int64_node {
635 #define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
636 #define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
637 : (int64)((struct ht_int32_node*)(node))->key)
640 #define MIN(a,b) ((a)<(b)?(a):(b))
644 #define MAX(a,b) ((a)>(b)?(a):(b))
647 #ifndef MAXHOSTNAMELEN
648 #define MAXHOSTNAMELEN 256
651 #define SUM_LENGTH 16
652 #define SHORT_SUM_LENGTH 2
653 #define BLOCKSUM_BIAS 10
656 #define MAXPATHLEN 1024
659 /* We want a roomy line buffer that can hold more than MAXPATHLEN,
660 * and significantly more than an overly short MAXPATHLEN. */
661 #if MAXPATHLEN < 4096
662 #define BIGPATHBUFLEN (4096+1024)
664 #define BIGPATHBUFLEN (MAXPATHLEN+1024)
672 #define INADDR_NONE 0xffffffff
675 #ifndef IN_LOOPBACKNET
676 #define IN_LOOPBACKNET 127
679 #if HAVE_UNIXWARE_ACLS|HAVE_SOLARIS_ACLS|HAVE_HPUX_ACLS
680 #define ACLS_NEED_MASK 1
683 #if defined HAVE_FALLOCATE || HAVE_SYS_FALLOCATE
684 #ifdef HAVE_LINUX_FALLOC_H
685 #include <linux/falloc.h>
687 #ifdef FALLOC_FL_KEEP_SIZE
688 #define SUPPORT_PREALLOCATION 1
689 #elif defined HAVE_FTRUNCATE
690 #define SUPPORT_PREALLOCATION 1
691 #define PREALLOCATE_NEEDS_TRUNCATE 1
693 #else /* !fallocate */
694 #if defined HAVE_EFFICIENT_POSIX_FALLOCATE && defined HAVE_FTRUNCATE
695 #define SUPPORT_PREALLOCATION 1
696 #define PREALLOCATE_NEEDS_TRUNCATE 1
706 const char *dirname; /* The dir info inside the transfer */
707 time_t modtime; /* When the item was last modified */
708 uint32 len32; /* Lowest 32 bits of the file's length */
709 uint16 mode; /* The item's type and permissions */
710 uint16 flags; /* The FLAG_* bits for this item */
711 const char basename[1]; /* The basename (AKA filename) follows */
714 extern int file_extra_cnt;
715 extern int inc_recurse;
719 extern int xattrs_ndx;
721 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
722 #define EXTRA_LEN (sizeof (union file_extras))
723 #define PTR_EXTRA_CNT ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
724 #define DEV_EXTRA_CNT 2
725 #define DIRNODE_EXTRA_CNT 3
726 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
728 #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
729 #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
731 #define NSEC_BUMP(f) ((f)->flags & FLAG_MOD_NSEC ? 1 : 0)
732 #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
733 #define START_BUMP(f) (NSEC_BUMP(f) + LEN64_BUMP(f))
734 #define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
735 #define ACL_BUMP(f) (acls_ndx ? 1 : 0)
737 /* The length applies to all items. */
739 #define F_LENGTH(f) ((int64)(f)->len32)
741 #define F_LENGTH(f) ((int64)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
742 ? (int64)OPT_EXTRA(f, NSEC_BUMP(f))->unum << 32 : 0))
745 #define F_MOD_NSEC(f) ((f)->flags & FLAG_MOD_NSEC ? OPT_EXTRA(f, 0)->unum : 0)
747 /* If there is a symlink string, it is always right after the basename */
748 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
750 /* The sending side always has this available: */
751 #define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_CNT))
753 /* The receiving side always has this available: */
754 #define F_DEPTH(f) REQ_EXTRA(f, 1)->num
756 /* When the associated option is on, all entries will have these present: */
757 #define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
758 #define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
759 #define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
760 #define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
761 #define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
763 /* These items are per-entry optional: */
764 #define F_HL_GNUM(f) OPT_EXTRA(f, START_BUMP(f))->num /* non-dirs */
765 #define F_HL_PREV(f) OPT_EXTRA(f, START_BUMP(f)+inc_recurse)->num /* non-dirs */
766 #define F_DIR_NODE_P(f) (&OPT_EXTRA(f, START_BUMP(f) \
767 + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
768 #define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, START_BUMP(f) + DIRNODE_EXTRA_CNT \
769 + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
770 #define F_DIR_DEFACL(f) OPT_EXTRA(f, START_BUMP(f))->unum /* receiver dirs */
771 #define F_DIR_DEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + ACL_BUMP(f) \
772 + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
774 /* This optional item might follow an F_HL_*() item. */
775 #define F_RDEV_P(f) (&OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
777 /* The sum is only present on regular files. */
778 #define F_SUM(f) ((char*)OPT_EXTRA(f, START_BUMP(f) + HLINK_BUMP(f) \
779 + SUM_EXTRA_CNT - 1))
781 /* Some utility defines: */
782 #define F_IS_ACTIVE(f) (f)->basename[0]
783 #define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
785 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
786 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
788 /* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
789 #define DEV_MAJOR(a) (a)[0]
790 #define DEV_MINOR(a) (a)[1]
792 /* These access the F_DIRS_NODE_P() values: */
793 #define DIR_PARENT(a) (a)[0]
794 #define DIR_FIRST_CHILD(a) (a)[1]
795 #define DIR_NEXT_SIBLING(a) (a)[2]
797 #define IS_MISSING_FILE(statbuf) ((statbuf).st_mode == 0)
800 * Start the flist array at FLIST_START entries and grow it
801 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
803 #define FLIST_START (32 * 1024)
804 #define FLIST_LINEAR (FLIST_START * 512)
807 * Extent size for allocation pools: A minimum size of 128KB
808 * is needed to mmap them so that freeing will release the
811 * Larger sizes reduce leftover fragments and speed free calls
812 * (when they happen). Smaller sizes increase the chance of
813 * freed allocations freeing whole extents.
815 #define NORMAL_EXTENT (256 * 1024)
816 #define SMALL_EXTENT (128 * 1024)
818 #define FLIST_TEMP (1<<1)
821 struct file_list *next, *prev;
822 struct file_struct **files, **sorted;
823 alloc_pool_t file_pool;
826 int low, high; /* 0-relative index values excluding empties */
827 int ndx_start; /* the start offset for inc_recurse mode */
828 int flist_num; /* 1-relative file_list number or 0 */
829 int parent_ndx; /* dir_flist index of parent directory */
830 int in_progress, to_redo;
833 #define SUMFLG_SAME_OFFSET (1<<0)
836 OFF_T offset; /**< offset in file of this chunk */
837 int32 len; /**< length of chunk of file */
838 uint32 sum1; /**< simple checksum */
839 int32 chain; /**< next hash-table collision */
840 short flags; /**< flag bits */
841 char sum2[SUM_LENGTH]; /**< checksum */
845 OFF_T flength; /**< total file length */
846 struct sum_buf *sums; /**< points to info for each chunk */
847 int32 count; /**< how many chunks */
848 int32 blength; /**< block_length */
849 int32 remainder; /**< flength % block_length */
850 int s2length; /**< sum2_length */
854 OFF_T file_size; /* File size (from stat) */
855 OFF_T p_offset; /* Window start */
856 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
857 char *p; /* Window pointer */
858 int32 p_size; /* Largest window size we allocated */
859 int32 p_len; /* Latest (rounded) window size */
860 int32 def_window_size; /* Default window size */
861 int fd; /* File Descriptor */
862 int status; /* first errno from read errors */
865 #define NAME_IS_FILE (0) /* filter name as a file */
866 #define NAME_IS_DIR (1<<0) /* filter name as a dir */
867 #define NAME_IS_XATTR (1<<2) /* filter name as an xattr */
869 #define FILTRULE_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
870 #define FILTRULE_WILD2 (1<<1) /* pattern has '**' */
871 #define FILTRULE_WILD2_PREFIX (1<<2) /* pattern starts with "**" */
872 #define FILTRULE_WILD3_SUFFIX (1<<3) /* pattern ends with "***" */
873 #define FILTRULE_ABS_PATH (1<<4) /* path-match on absolute path */
874 #define FILTRULE_INCLUDE (1<<5) /* this is an include, not an exclude */
875 #define FILTRULE_DIRECTORY (1<<6) /* this matches only directories */
876 #define FILTRULE_WORD_SPLIT (1<<7) /* split rules on whitespace */
877 #define FILTRULE_NO_INHERIT (1<<8) /* don't inherit these rules */
878 #define FILTRULE_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
879 #define FILTRULE_MERGE_FILE (1<<10)/* specifies a file to merge */
880 #define FILTRULE_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
881 #define FILTRULE_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
882 #define FILTRULE_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
883 #define FILTRULE_NEGATE (1<<14)/* rule matches when pattern does not */
884 #define FILTRULE_CVS_IGNORE (1<<15)/* rule was -C or :C */
885 #define FILTRULE_SENDER_SIDE (1<<16)/* rule applies to the sending side */
886 #define FILTRULE_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
887 #define FILTRULE_CLEAR_LIST (1<<18)/* this item is the "!" token */
888 #define FILTRULE_PERISHABLE (1<<19)/* perishable if parent dir goes away */
889 #define FILTRULE_XATTR (1<<20)/* rule only applies to xattr names */
891 #define FILTRULES_SIDES (FILTRULE_SENDER_SIDE | FILTRULE_RECEIVER_SIDE)
893 typedef struct filter_struct {
894 struct filter_struct *next;
899 struct filter_list_struct *mergelist;
903 typedef struct filter_list_struct {
911 int64 total_transferred_size;
916 int64 flist_buildtime;
917 int64 flist_xfertime;
919 int num_files, num_dirs, num_symlinks, num_devices, num_specials;
920 int created_files, created_dirs, created_symlinks, created_devices, created_specials;
921 int deleted_files, deleted_dirs, deleted_symlinks, deleted_devices, deleted_specials;
925 struct chmod_mode_struct;
927 struct flist_ndx_item {
928 struct flist_ndx_item *next;
933 struct flist_ndx_item *head, *tail;
936 #define EMPTY_ITEM_LIST {NULL, 0, 0}
944 #define EXPAND_ITEM_LIST(lp, type, incr) \
945 (type*)expand_item_list(lp, sizeof (type), #type, incr)
947 #define EMPTY_XBUF {NULL, 0, 0, 0}
951 size_t pos; /* pos = read pos in the buf */
952 size_t len; /* len = chars following pos */
953 size_t size; /* size = total space in buf */
956 #define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
957 #define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (size_t)-1, (xb).pos = 0
958 /* This one is used to make an output xbuf based on a char[] buffer: */
959 #define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
961 #define ICB_EXPAND_OUT (1<<0)
962 #define ICB_INCLUDE_BAD (1<<1)
963 #define ICB_INCLUDE_INCOMPLETE (1<<2)
964 #define ICB_CIRCULAR_OUT (1<<3)
965 #define ICB_INIT (1<<4)
967 #define IOBUF_KEEP_BUFS 0
968 #define IOBUF_FREE_BUFS 1
970 #define MPLX_SWITCHING IOBUF_KEEP_BUFS
971 #define MPLX_ALL_DONE IOBUF_FREE_BUFS
972 #define MPLX_TO_BUFFERED 2
974 #define RL_EOL_NULLS (1<<0)
975 #define RL_DUMP_COMMENTS (1<<1)
976 #define RL_CONVERT (1<<2)
980 char fname[1]; /* has variable size */
983 #include "byteorder.h"
984 #include "lib/mdigest.h"
985 #include "lib/wildmatch.h"
986 #include "lib/permstring.h"
987 #include "lib/addrinfo.h"
990 #define __attribute__(x)
997 #define UNUSED(x) x __attribute__((__unused__))
999 #define NORETURN __attribute__((__noreturn__))
1005 struct rsync_acl *acc_acl; /* access ACL */
1006 struct rsync_acl *def_acl; /* default ACL */
1008 #ifdef SUPPORT_XATTRS
1013 #define ACL_READY(sx) ((sx).acc_acl != NULL)
1014 #define XATTR_READY(sx) ((sx).xattr != NULL)
1018 #ifndef SUPPORT_XATTRS
1019 #define x_stat(fn,fst,xst) do_stat(fn,fst)
1020 #define x_lstat(fn,fst,xst) do_lstat(fn,fst)
1021 #define x_fstat(fd,fst,xst) do_fstat(fd,fst)
1024 /* We have replacement versions of these if they're missing. */
1025 #ifndef HAVE_ASPRINTF
1026 int asprintf(char **ptr, const char *format, ...);
1029 #ifndef HAVE_VASPRINTF
1030 int vasprintf(char **ptr, const char *format, va_list ap);
1033 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
1034 #define vsnprintf rsync_vsnprintf
1035 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
1038 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
1039 #define snprintf rsync_snprintf
1040 int snprintf(char *str, size_t count, const char *fmt,...);
1044 #ifndef HAVE_STRERROR
1045 extern char *sys_errlist[];
1046 #define strerror(i) sys_errlist[i]
1050 # define strchr index
1051 # define strrchr rindex
1054 #ifndef HAVE_ERRNO_DECL
1058 #ifdef HAVE_READLINK
1059 #define SUPPORT_LINKS 1
1060 #if !defined NO_SYMLINK_XATTRS && !defined NO_SYMLINK_USER_XATTRS
1061 #define do_readlink(path, buf, bufsiz) readlink(path, buf, bufsiz)
1065 #define SUPPORT_HARD_LINKS 1
1068 #ifdef HAVE_SIGACTION
1069 #define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
1070 #define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
1072 #define SIGACTION(n,h) signal(n,h)
1076 #define EWOULDBLOCK EAGAIN
1079 #ifndef STDIN_FILENO
1080 #define STDIN_FILENO 0
1083 #ifndef STDOUT_FILENO
1084 #define STDOUT_FILENO 1
1087 #ifndef STDERR_FILENO
1088 #define STDERR_FILENO 2
1092 #define S_IRUSR 0400
1096 #define S_IWUSR 0200
1100 #define ACCESSPERMS 0777
1107 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
1110 #define _S_IFMT 0170000
1114 #define _S_IFLNK 0120000
1118 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
1122 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
1126 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
1131 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
1133 #define S_ISSOCK(mode) (0)
1139 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
1141 #define S_ISFIFO(mode) (0)
1146 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
1150 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
1153 /* work out what fcntl flag to use for non-blocking */
1155 # define NONBLOCK_FLAG O_NONBLOCK
1157 # define NONBLOCK_FLAG O_NDELAY
1159 # define NONBLOCK_FLAG FNDELAY
1162 #ifndef INADDR_LOOPBACK
1163 #define INADDR_LOOPBACK 0x7f000001
1167 #define INADDR_NONE 0xffffffff
1170 #define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
1171 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
1173 #define PRESERVE_FILE_TIMES (1<<0)
1174 #define PRESERVE_DIR_TIMES (1<<1)
1175 #define PRESERVE_LINK_TIMES (1<<2)
1177 /* Initial mask on permissions given to temporary files. Mask off setuid
1178 bits and group access because of potential race-condition security
1179 holes, and mask other access because mode 707 is bizarre */
1180 #define INITACCESSPERMS 0700
1182 /* handler for null strings in printf format */
1183 #define NS(s) ((s)?(s):"<NULL>")
1185 /* Convenient wrappers for malloc and realloc. Use them. */
1186 #define new(type) ((type*)malloc(sizeof (type)))
1187 #define new0(type) ((type*)calloc(1, sizeof (type)))
1188 #define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
1189 #define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
1190 #define realloc_array(ptr, type, num) ((type*)_realloc_array((ptr), sizeof(type), (num)))
1192 /* use magic gcc attributes to catch format errors */
1193 void rprintf(enum logcode , const char *, ...)
1194 __attribute__((format (printf, 2, 3)))
1197 /* This is just like rprintf, but it also tries to print some
1198 * representation of the error code. Normally errcode = errno. */
1199 void rsyserr(enum logcode, int, const char *, ...)
1200 __attribute__((format (printf, 3, 4)))
1203 /* Make sure that the O_BINARY flag is defined. */
1208 #ifndef HAVE_STRLCPY
1209 size_t strlcpy(char *d, const char *s, size_t bufsize);
1212 #ifndef HAVE_STRLCAT
1213 size_t strlcat(char *d, const char *s, size_t bufsize);
1217 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
1220 #define WIFEXITED(stat) ((int)((stat)&0xFF) == 0)
1223 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
1226 #define MY_UID() geteuid()
1228 #define MY_UID() getuid()
1232 #define MY_GID() getegid()
1234 #define MY_GID() getgid()
1237 #ifdef FORCE_FD_ZERO_MEMSET
1239 #define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
1242 extern short info_levels[], debug_levels[];
1244 #define INFO_GTE(flag, lvl) (info_levels[INFO_##flag] >= (lvl))
1245 #define INFO_EQ(flag, lvl) (info_levels[INFO_##flag] == (lvl))
1246 #define DEBUG_GTE(flag, lvl) (debug_levels[DEBUG_##flag] >= (lvl))
1247 #define DEBUG_EQ(flag, lvl) (debug_levels[DEBUG_##flag] == (lvl))
1249 #define INFO_BACKUP 0
1250 #define INFO_COPY (INFO_BACKUP+1)
1251 #define INFO_DEL (INFO_COPY+1)
1252 #define INFO_FLIST (INFO_DEL+1)
1253 #define INFO_MISC (INFO_FLIST+1)
1254 #define INFO_MOUNT (INFO_MISC+1)
1255 #define INFO_NAME (INFO_MOUNT+1)
1256 #define INFO_PROGRESS (INFO_NAME+1)
1257 #define INFO_REMOVE (INFO_PROGRESS+1)
1258 #define INFO_SKIP (INFO_REMOVE+1)
1259 #define INFO_STATS (INFO_SKIP+1)
1260 #define INFO_SYMSAFE (INFO_STATS+1)
1262 #define COUNT_INFO (INFO_SYMSAFE+1)
1265 #define DEBUG_BACKUP (DEBUG_ACL+1)
1266 #define DEBUG_BIND (DEBUG_BACKUP+1)
1267 #define DEBUG_CHDIR (DEBUG_BIND+1)
1268 #define DEBUG_CONNECT (DEBUG_CHDIR+1)
1269 #define DEBUG_CMD (DEBUG_CONNECT+1)
1270 #define DEBUG_DEL (DEBUG_CMD+1)
1271 #define DEBUG_DELTASUM (DEBUG_DEL+1)
1272 #define DEBUG_DUP (DEBUG_DELTASUM+1)
1273 #define DEBUG_EXIT (DEBUG_DUP+1)
1274 #define DEBUG_FILTER (DEBUG_EXIT+1)
1275 #define DEBUG_FLIST (DEBUG_FILTER+1)
1276 #define DEBUG_FUZZY (DEBUG_FLIST+1)
1277 #define DEBUG_GENR (DEBUG_FUZZY+1)
1278 #define DEBUG_HASH (DEBUG_GENR+1)
1279 #define DEBUG_HLINK (DEBUG_HASH+1)
1280 #define DEBUG_ICONV (DEBUG_HLINK+1)
1281 #define DEBUG_IO (DEBUG_ICONV+1)
1282 #define DEBUG_OWN (DEBUG_IO+1)
1283 #define DEBUG_PROTO (DEBUG_OWN+1)
1284 #define DEBUG_RECV (DEBUG_PROTO+1)
1285 #define DEBUG_SEND (DEBUG_RECV+1)
1286 #define DEBUG_TIME (DEBUG_SEND+1)
1288 #define COUNT_DEBUG (DEBUG_TIME+1)
1290 #ifndef HAVE_INET_NTOP
1291 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
1294 #ifndef HAVE_INET_PTON
1295 int inet_pton(int af, const char *src, void *dst);
1298 #ifndef HAVE_GETPASS
1299 char *getpass(const char *prompt);
1302 #ifdef MAINTAINER_MODE
1303 const char *get_panic_action(void);