2 Copyright (C) by Andrew Tridgell 1996, 2000
3 Copyright (C) Paul Mackerras 1996
4 Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #define BLOCK_SIZE 700
26 #define RSYNC_RSH_ENV "RSYNC_RSH"
27 #define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
29 #define RSYNC_NAME "rsync"
30 /* RSYNCD_SYSCONF is now set in config.h */
31 #define RSYNCD_USERCONF "rsyncd.conf"
33 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
34 #define URL_PREFIX "rsync://"
36 #define BACKUP_SUFFIX "~"
38 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
39 incompatible with older versions :-( */
42 /* These flags are only used during the flist transfer. */
44 #define XMIT_TOP_DIR (1<<0)
45 #define XMIT_SAME_MODE (1<<1)
46 #define XMIT_EXTENDED_FLAGS (1<<2)
47 #define XMIT_SAME_RDEV_pre28 XMIT_EXTENDED_FLAGS /* Only in protocols < 28 */
48 #define XMIT_SAME_UID (1<<3)
49 #define XMIT_SAME_GID (1<<4)
50 #define XMIT_SAME_NAME (1<<5)
51 #define XMIT_LONG_NAME (1<<6)
52 #define XMIT_SAME_TIME (1<<7)
53 #define XMIT_SAME_RDEV_MAJOR (1<<8)
54 #define XMIT_HAS_IDEV_DATA (1<<9)
55 #define XMIT_SAME_DEV (1<<10)
56 #define XMIT_RDEV_MINOR_IS_SMALL (1<<11)
58 /* These flags are used in the live flist data. */
60 #define FLAG_TOP_DIR (1<<0)
61 #define FLAG_HLINK_EOL (1<<1) /* receiver/generator */
62 #define FLAG_MOUNT_POINT (1<<2) /* sender */
63 #define FLAG_NO_FUZZY (1<<2) /* generator */
64 #define FLAG_DEL_HERE (1<<3) /* receiver/generator */
65 #define FLAG_SENT (1<<3) /* sender */
66 #define FLAG_HLINK_TOL (1<<4) /* receiver/generator */
68 /* update this if you make incompatible changes */
69 #define PROTOCOL_VERSION 29
71 /* We refuse to interoperate with versions that are not in this range.
72 * Note that we assume we'll work with later versions: the onus is on
73 * people writing them to make sure that they don't send us anything
74 * we won't understand.
76 * Interoperation with old but supported protocol versions
77 * should cause a warning to be printed. At a future date
78 * the old protocol will become the minimum and
79 * compatibility code removed.
81 * There are two possible explanations for the limit at
82 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
83 * do not interoperate with us, and (more likely) so that we can
84 * detect an attempt to connect rsync to a non-rsync server, which is
85 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
86 * MAX_PROTOCOL_VERSION. */
88 #define MIN_PROTOCOL_VERSION 20
89 #define OLD_PROTOCOL_VERSION 25
90 #define MAX_PROTOCOL_VERSION 40
92 #define RSYNC_PORT 873
94 #define SPARSE_WRITE_SIZE (1024)
95 #define WRITE_SIZE (32*1024)
96 #define CHUNK_SIZE (32*1024)
97 #define MAX_MAP_SIZE (256*1024)
98 #define IO_BUFFER_SIZE (4092)
99 #define MAX_BLOCK_SIZE ((int32)1 << 29)
101 #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
102 #define IOERR_VANISHED (1<<1)
103 #define IOERR_DEL_LIMIT (1<<2)
105 #define MAX_ARGS 1000
107 #define MAX_BASIS_DIRS 20
112 #define SERVER_FILTERS 1
113 #define ALL_FILTERS 2
115 #define XFLG_FATAL_ERRORS (1<<0)
116 #define XFLG_OLD_PREFIXES (1<<1)
117 #define XFLG_ANCHORED2ABS (1<<2)
119 #define PERMS_REPORT (1<<0)
120 #define PERMS_SKIP_MTIME (1<<1)
123 #define NORMAL_FLUSH 0
125 #define PDIR_CREATE 1
126 #define PDIR_DELETE 0
128 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
129 #define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
130 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
131 #define FNAMECMP_FNAME 0x80
132 #define FNAMECMP_PARTIAL_DIR 0x81
133 #define FNAMECMP_BACKUP 0x82
134 #define FNAMECMP_FUZZY 0x83
136 /* For calling delete_file() */
137 #define DEL_NO_RECURSE (1<<1)
138 #define DEL_FORCE_RECURSE (1<<2) /* recurse even w/o --force */
139 #define DEL_TERSE (1<<3)
141 /* For use by the itemize_changes code */
142 #define ITEM_DUMMY_BIT (1<<0)
143 #define ITEM_REPORT_CHECKSUM (1<<1)
144 #define ITEM_REPORT_SIZE (1<<2)
145 #define ITEM_REPORT_TIME (1<<3)
146 #define ITEM_REPORT_PERMS (1<<4)
147 #define ITEM_REPORT_OWNER (1<<5)
148 #define ITEM_REPORT_GROUP (1<<6)
149 #define ITEM_REPORT_XATTRS (1<<7)
150 #define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
151 #define ITEM_XNAME_FOLLOWS (1<<12)
152 #define ITEM_IS_NEW (1<<13)
153 #define ITEM_LOCAL_CHANGE (1<<14)
154 #define ITEM_TRANSFER (1<<15)
155 /* These are outside the range of the transmitted flags. */
156 #define ITEM_NO_DEST_AND_NO_UPDATE (1<<16) /* used by itemize() */
157 #define ITEM_MISSING_DATA (1<<16) /* used by log_formatted() */
158 #define ITEM_DELETED (1<<17) /* used by log_formatted() */
160 #define SIGNIFICANT_ITEM_FLAGS (~(\
161 ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
164 /* Log-message categories. FLOG and FCLIENT are only used on the daemon
165 * side for custom logging -- they don't get sent over the socket. */
166 enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4 };
168 /* Messages types that are sent over the message channel. The logcode
169 * values must all be present here with identical numbers. */
171 MSG_DATA=0, /* raw data on the multiplexed stream */
172 MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
173 MSG_LOG=FLOG, MSG_FCLIENT=FCLIENT, /* sibling logging */
174 MSG_REDO=9, /* reprocess indicated flist index */
175 MSG_SUCCESS=100,/* successfully updated indicated flist index */
176 MSG_DELETED=101,/* successfully deleted a file on receiving side */
177 MSG_DONE=86 /* current phase is done */
184 /* The default RSYNC_RSH is always set in config.h. */
187 #ifdef HAVE_SYS_TYPES_H
188 # include <sys/types.h>
190 #ifdef HAVE_SYS_STAT_H
191 # include <sys/stat.h>
197 # ifdef HAVE_STDLIB_H
202 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H
207 #ifdef HAVE_STRINGS_H
208 # include <strings.h>
214 #ifdef HAVE_SYS_PARAM_H
215 #include <sys/param.h>
218 #if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
222 #ifdef HAVE_SYS_SOCKET_H
223 #include <sys/socket.h>
226 #ifdef TIME_WITH_SYS_TIME
227 #include <sys/time.h>
230 #ifdef HAVE_SYS_TIME_H
231 #include <sys/time.h>
240 #ifdef HAVE_SYS_FCNTL_H
241 #include <sys/fcntl.h>
245 #ifdef HAVE_SYS_IOCTL_H
246 #include <sys/ioctl.h>
249 #ifdef HAVE_SYS_FILIO_H
250 #include <sys/filio.h>
254 #ifdef HAVE_SYS_WAIT_H
255 #include <sys/wait.h>
269 #ifdef HAVE_SYS_SELECT_H
270 #include <sys/select.h>
273 #ifdef HAVE_SYS_MODE_H
274 /* apparently AIX needs this for S_ISLNK */
276 #include <sys/mode.h>
284 /* these are needed for the uid/gid mapping code */
289 #include <netinet/in.h>
290 #include <arpa/inet.h>
293 #include <sys/file.h>
298 # define dirent direct
299 # ifdef HAVE_SYS_NDIR_H
300 # include <sys/ndir.h>
302 # ifdef HAVE_SYS_DIR_H
303 # include <sys/dir.h>
310 #ifdef MAJOR_IN_MKDEV
311 #include <sys/mkdev.h>
312 # if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
313 # define makedev mkdev
315 #elif defined MAJOR_IN_SYSMACROS
316 #include <sys/sysmacros.h>
325 #include "lib/pool_alloc.h"
330 #define uchar unsigned char
333 #ifdef SIGNED_CHAR_OK
334 #define schar signed char
339 /* Find a variable that is either exactly 32-bits or longer.
340 * If some code depends on 32-bit truncation, it will need to
341 * take special action in a "#if SIZEOF_INT32 > 4" section. */
345 # define SIZEOF_INT32 4
346 #elif SIZEOF_LONG == 4
348 # define SIZEOF_INT32 4
349 #elif SIZEOF_SHORT == 4
351 # define SIZEOF_INT32 4
354 # define SIZEOF_INT32 SIZEOF_INT
355 #elif SIZEOF_LONG > 4
357 # define SIZEOF_INT32 SIZEOF_LONG
359 # error Could not find a 32-bit integer variable
362 # define SIZEOF_INT32 4
366 #define uint32 unsigned int32
369 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
371 #define STRUCT_STAT struct stat
373 #define OFF_T off64_t
374 #define STRUCT_STAT struct stat64
375 #define USE_STAT64_FUNCS 1
378 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
379 * that's the maximum size the file system can handle and there is no
380 * 64-bit type available. The rsync source must therefore take steps
381 * to ensure that any code that really requires a 64-bit integer has
382 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
384 #if SIZEOF_OFF64_T == 8
385 # define int64 off64_t
386 # define SIZEOF_INT64 8
387 #elif SIZEOF_LONG == 8
389 # define SIZEOF_INT64 8
390 #elif SIZEOF_INT == 8
392 # define SIZEOF_INT64 8
393 #elif SIZEOF_LONG_LONG == 8
394 # define int64 long long
395 # define SIZEOF_INT64 8
396 #elif SIZEOF_OFF_T == 8
398 # define SIZEOF_INT64 8
401 # define SIZEOF_INT64 SIZEOF_INT
402 #elif SIZEOF_LONG > 8
404 # define SIZEOF_INT64 SIZEOF_LONG
405 #elif SIZEOF_LONG_LONG > 8
406 # define int64 long long
407 # define SIZEOF_INT64 SIZEOF_LONG_LONG
409 /* As long as it gets... */
411 # define SIZEOF_INT64 SIZEOF_OFF_T
414 /* Starting from protocol version 26, we always use 64-bit
415 * ino_t and dev_t internally, even if this platform does not
416 * allow files to have 64-bit inums. That's because the
417 * receiver needs to find duplicate (dev,ino) tuples to detect
418 * hardlinks, and it might have files coming from a platform
419 * that has 64-bit inums.
421 * The only exception is if we're on a platform with no 64-bit type at
424 * Because we use read_longint() to get these off the wire, if you
425 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
426 * with no 64-bit types then you will get an overflow error. Probably
427 * not many people have that combination of machines, and you can
428 * avoid it by not preserving hardlinks or not transferring device
429 * nodes. It's not clear that any other behaviour is better.
431 * Note that if you transfer devices from a 64-bit-devt machine (say,
432 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
433 * device numbers will be truncated. But it's a kind of silly thing
436 * FIXME: I don't think the code in flist.c has ever worked on a system
437 * where dev_t is a struct.
446 #define MIN(a,b) ((a)<(b)?(a):(b))
450 #define MAX(a,b) ((a)>(b)?(a):(b))
453 #ifndef MAXHOSTNAMELEN
454 #define MAXHOSTNAMELEN 256
457 /* the length of the md4 checksum */
458 #define MD4_SUM_LENGTH 16
459 #define SUM_LENGTH 16
460 #define SHORT_SUM_LENGTH 2
461 #define BLOCKSUM_BIAS 10
464 #define MAXPATHLEN 1024
472 #define INADDR_NONE 0xffffffff
475 #ifndef IN_LOOPBACKNET
476 #define IN_LOOPBACKNET 127
479 #define GID_NONE ((gid_t)-1)
481 #define HL_CHECK_MASTER 0
489 #define F_DEV link_u.idev->dev
490 #define F_INODE link_u.idev->inode
492 #define F_HLINDEX link_u.links->hlindex
493 #define F_NEXT link_u.links->next
497 dev_t rdev; /* The device number, if this is a device */
498 char *sum; /* Only a normal file can have a checksum */
499 char *link; /* Points to symlink string, if a symlink */
502 char *basename; /* The current item's name (AKA filename) */
503 char *dirname; /* The directory info inside the transfer */
505 char *root; /* Sender-side dir info outside transfer */
506 int depth; /* Receiver-side directory depth info */
516 uchar flags; /* this item MUST remain last */
520 * Start the flist array at FLIST_START entries and grow it
521 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
523 #define FLIST_START (32 * 1024)
524 #define FLIST_LINEAR (FLIST_START * 512)
527 * Extent size for allocation pools A minimum size of 128KB
528 * is needed to mmap them so that freeing will release the
531 * Larger sizes reduce leftover fragments and speed free calls
532 * (when they happen) Smaller sizes increase the chance of
533 * freed allocations freeing whole extents.
535 #define FILE_EXTENT (256 * 1024)
536 #define HLINK_EXTENT (128 * 1024)
539 #define WITHOUT_HLINK 0
542 struct file_struct **files;
543 alloc_pool_t file_pool;
544 alloc_pool_t hlink_pool;
550 #define SUMFLG_SAME_OFFSET (1<<0)
553 OFF_T offset; /**< offset in file of this chunk */
554 int32 len; /**< length of chunk of file */
555 uint32 sum1; /**< simple checksum */
556 short flags; /**< flag bits */
557 char sum2[SUM_LENGTH]; /**< checksum */
561 OFF_T flength; /**< total file length */
562 struct sum_buf *sums; /**< points to info for each chunk */
563 int32 count; /**< how many chunks */
564 int32 blength; /**< block_length */
565 int32 remainder; /**< flength % block_length */
566 int s2length; /**< sum2_length */
570 OFF_T file_size; /* File size (from stat) */
571 OFF_T p_offset; /* Window start */
572 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
573 char *p; /* Window pointer */
574 int32 p_size; /* Largest window size we allocated */
575 int32 p_len; /* Latest (rounded) window size */
576 int32 def_window_size; /* Default window size */
577 int fd; /* File Descriptor */
578 int status; /* first errno from read errors */
581 #define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
582 #define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
583 #define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
584 #define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
585 #define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
586 #define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
587 #define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
588 #define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
589 #define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
590 #define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
591 #define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
592 #define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
593 #define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
594 #define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
595 #define MATCHFLG_NEGATE (1<<14)/* rule matches when pattern does not */
596 #define MATCHFLG_CVS_IGNORE (1<<15)/* rule was -C or :C */
597 #define MATCHFLG_SENDER_SIDE (1<<16)/* rule applies to the sending side */
598 #define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
600 #define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
601 | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
602 | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE)
604 struct filter_struct {
605 struct filter_struct *next;
610 struct filter_list_struct *mergelist;
614 struct filter_list_struct {
615 struct filter_struct *head;
616 struct filter_struct *tail;
622 int64 total_transferred_size;
627 int64 flist_buildtime;
628 int64 flist_xfertime;
631 int num_transferred_files;
632 int current_file_index;
636 #include "byteorder.h"
637 #include "lib/mdfour.h"
638 #include "lib/wildmatch.h"
639 #include "lib/permstring.h"
640 #include "lib/addrinfo.h"
644 /* We have replacement versions of these if they're missing. */
645 #ifndef HAVE_ASPRINTF
646 int asprintf(char **ptr, const char *format, ...);
649 #ifndef HAVE_VASPRINTF
650 int vasprintf(char **ptr, const char *format, va_list ap);
653 #if !defined HAVE_VSNPRINTF || !defined HAVE_C99_VSNPRINTF
654 #define vsnprintf rsync_vsnprintf
655 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
658 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
659 #define snprintf rsync_snprintf
660 int snprintf(char *str,size_t count,const char *fmt,...);
664 #ifndef HAVE_STRERROR
665 extern char *sys_errlist[];
666 #define strerror(i) sys_errlist[i]
670 # define strchr index
671 # define strrchr rindex
674 #ifndef HAVE_ERRNO_DECL
679 #define SUPPORT_LINKS 1
682 #define SUPPORT_HARD_LINKS 1
685 #define SIGNAL_CAST (RETSIGTYPE (*)())
688 #define EWOULDBLOCK EAGAIN
692 #define STDIN_FILENO 0
695 #ifndef STDOUT_FILENO
696 #define STDOUT_FILENO 1
699 #ifndef STDERR_FILENO
700 #define STDERR_FILENO 2
712 #define ACCESSPERMS 0777
719 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
722 #define _S_IFMT 0170000
726 #define _S_IFLNK 0120000
730 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
734 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
738 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
743 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
745 #define S_ISSOCK(mode) (0)
751 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
753 #define S_ISFIFO(mode) (0)
758 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
762 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
765 /* work out what fcntl flag to use for non-blocking */
767 # define NONBLOCK_FLAG O_NONBLOCK
769 # define NONBLOCK_FLAG O_NDELAY
771 # define NONBLOCK_FLAG FNDELAY
774 #ifndef INADDR_LOOPBACK
775 #define INADDR_LOOPBACK 0x7f000001
779 #define INADDR_NONE 0xffffffff
782 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
784 /* Initial mask on permissions given to temporary files. Mask off setuid
785 bits and group access because of potential race-condition security
786 holes, and mask other access because mode 707 is bizarre */
787 #define INITACCESSPERMS 0700
789 /* handler for null strings in printf format */
790 #define NS(s) ((s)?safe_fname(s):"<NULL>")
792 #if !defined __GNUC__ || defined __APPLE__
793 /* Apparently the OS X port of gcc gags on __attribute__.
795 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
796 #define __attribute__(x)
800 /* Convenient wrappers for malloc and realloc. Use them. */
801 #define new(type) ((type *)malloc(sizeof(type)))
802 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
803 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
805 /* use magic gcc attributes to catch format errors */
806 void rprintf(enum logcode , const char *, ...)
807 __attribute__((format (printf, 2, 3)))
810 /* This is just like rprintf, but it also tries to print some
811 * representation of the error code. Normally errcode = errno. */
812 void rsyserr(enum logcode, int, const char *, ...)
813 __attribute__((format (printf, 3, 4)))
816 #ifdef REPLACE_INET_NTOA
817 #define inet_ntoa rep_inet_ntoa
820 /* Make sure that the O_BINARY flag is defined. */
826 size_t strlcpy(char *d, const char *s, size_t bufsize);
830 size_t strlcat(char *d, const char *s, size_t bufsize);
834 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
837 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
840 #define MY_UID() geteuid()
842 #define MY_UID() getuid()
846 #define MY_GID() getegid()
848 #define MY_GID() getgid()
853 #ifndef HAVE_INET_NTOP
854 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
857 #ifndef HAVE_INET_PTON
858 int inet_pton(int af, const char *src, void *dst);
861 #ifdef MAINTAINER_MODE
862 const char *get_panic_action(void);
865 #define UNUSED(x) x __attribute__((__unused__))
867 extern const char *io_write_phase, *io_read_phase;