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_DEL_START (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_DEL_START (1<<0)
61 #define FLAG_HLINK_EOL (1<<1) /* generator only */
62 #define FLAG_MOUNT_POINT (1<<2) /* sender only */
64 /* update this if you make incompatible changes */
65 #define PROTOCOL_VERSION 29
67 /* We refuse to interoperate with versions that are not in this range.
68 * Note that we assume we'll work with later versions: the onus is on
69 * people writing them to make sure that they don't send us anything
70 * we won't understand.
72 * Interoperation with old but supported protocol versions
73 * should cause a warning to be printed. At a future date
74 * the old protocol will become the minimum and
75 * compatibility code removed.
77 * There are two possible explanations for the limit at
78 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
79 * do not interoperate with us, and (more likely) so that we can
80 * detect an attempt to connect rsync to a non-rsync server, which is
81 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
82 * MAX_PROTOCOL_VERSION. */
84 #define MIN_PROTOCOL_VERSION 20
85 #define OLD_PROTOCOL_VERSION 25
86 #define MAX_PROTOCOL_VERSION 40
88 #define RSYNC_PORT 873
90 #define SPARSE_WRITE_SIZE (1024)
91 #define WRITE_SIZE (32*1024)
92 #define CHUNK_SIZE (32*1024)
93 #define MAX_MAP_SIZE (256*1024)
94 #define IO_BUFFER_SIZE (4092)
95 #define MAX_BLOCK_SIZE ((int32)1 << 29)
97 #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
98 #define IOERR_VANISHED (1<<1)
100 #define MAX_ARGS 1000
102 #define MAX_BASIS_DIRS 20
107 #define SERVER_FILTERS 1
108 #define ALL_FILTERS 2
110 #define XFLG_FATAL_ERRORS (1<<0)
111 #define XFLG_DEF_INCLUDE (1<<1)
112 #define XFLG_DEF_EXCLUDE (1<<2)
113 #define XFLG_WORD_SPLIT (1<<3)
114 #define XFLG_DIRECTORY (1<<4)
115 #define XFLG_NO_PREFIXES (1<<5)
116 #define XFLG_ABS_PATH (1<<6)
118 #define PERMS_REPORT (1<<0)
119 #define PERMS_SKIP_MTIME (1<<1)
122 #define NORMAL_FLUSH 0
124 #define PDIR_CREATE 1
125 #define PDIR_DELETE 0
127 /* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
128 #define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
129 #define FNAMECMP_BASIS_DIR_HIGH 0x7F
130 #define FNAMECMP_FNAME 0x80
131 #define FNAMECMP_PARTIAL_DIR 0x81
132 #define FNAMECMP_BACKUP 0x82
134 /* For calling delete_file() */
135 #define DEL_DIR (1<<0)
136 #define DEL_NO_RECURSE (1<<1)
137 #define DEL_FORCE_RECURSE (1<<2) /* recurse even w/o --force */
138 #define DEL_TERSE (1<<3)
141 /* Log-message categories. FLOG is only used on the daemon side to
142 * output messages to the log file. */
143 enum logcode { FERROR=1, FINFO=2, FLOG=3 };
145 /* Messages types that are sent over the message channel. The logcode
146 * values must all be present here with identical numbers. */
148 MSG_DONE=5, /* current phase is done */
149 MSG_REDO=4, /* reprocess indicated flist index */
150 MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
151 MSG_DATA=0 /* raw data on the multiplexed stream */
158 /* The default RSYNC_RSH is always set in config.h. */
162 # include <sys/types.h>
165 # include <sys/stat.h>
176 # if !STDC_HEADERS && HAVE_MEMORY_H
182 # include <strings.h>
189 #include <sys/param.h>
192 #if HAVE_MALLOC_H && (HAVE_MALLINFO || !HAVE_STDLIB_H)
196 #if HAVE_SYS_SOCKET_H
197 #include <sys/socket.h>
200 #if TIME_WITH_SYS_TIME
201 #include <sys/time.h>
205 #include <sys/time.h>
215 #include <sys/fcntl.h>
220 #include <sys/ioctl.h>
224 #include <sys/filio.h>
229 #include <sys/wait.h>
243 #if HAVE_SYS_SELECT_H
244 #include <sys/select.h>
248 /* apparently AIX needs this for S_ISLNK */
250 #include <sys/mode.h>
258 /* these are needed for the uid/gid mapping code */
263 #include <netinet/in.h>
264 #include <arpa/inet.h>
267 #include <sys/file.h>
272 # define dirent direct
274 # include <sys/ndir.h>
277 # include <sys/dir.h>
285 #include <sys/mkdev.h>
286 # if !defined(makedev) && defined(mkdev)
287 # define makedev mkdev
289 #elif MAJOR_IN_SYSMACROS
290 #include <sys/sysmacros.h>
299 #include "lib/pool_alloc.h"
304 #define uchar unsigned char
308 #define schar signed char
313 /* Find a variable that is either exactly 32-bits or longer.
314 * If some code depends on 32-bit truncation, it will need to
315 * take special action in a "#if SIZEOF_INT32 > 4" section. */
319 # define SIZEOF_INT32 4
320 #elif SIZEOF_LONG == 4
322 # define SIZEOF_INT32 4
323 #elif SIZEOF_SHORT == 4
325 # define SIZEOF_INT32 4
328 # define SIZEOF_INT32 SIZEOF_INT
329 #elif SIZEOF_LONG > 4
331 # define SIZEOF_INT32 SIZEOF_LONG
333 # error Could not find a 32-bit integer variable
336 # define SIZEOF_INT32 4
340 #define uint32 unsigned int32
343 #if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !HAVE_STRUCT_STAT64
345 #define STRUCT_STAT struct stat
347 #define OFF_T off64_t
348 #define STRUCT_STAT struct stat64
349 #define USE_STAT64_FUNCS 1
352 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
353 * that's the maximum size the file system can handle and there is no
354 * 64-bit type available. The rsync source must therefore take steps
355 * to ensure that any code that really requires a 64-bit integer has
356 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
358 #if SIZEOF_OFF64_T == 8
359 # define int64 off64_t
360 # define SIZEOF_INT64 8
361 #elif SIZEOF_LONG == 8
363 # define SIZEOF_INT64 8
364 #elif SIZEOF_INT == 8
366 # define SIZEOF_INT64 8
367 #elif SIZEOF_LONG_LONG == 8
368 # define int64 long long
369 # define SIZEOF_INT64 8
370 #elif SIZEOF_OFF_T == 8
372 # define SIZEOF_INT64 8
375 # define SIZEOF_INT64 SIZEOF_INT
376 #elif SIZEOF_LONG > 8
378 # define SIZEOF_INT64 SIZEOF_LONG
379 #elif SIZEOF_LONG_LONG > 8
380 # define int64 long long
381 # define SIZEOF_INT64 SIZEOF_LONG_LONG
383 /* As long as it gets... */
385 # define SIZEOF_INT64 SIZEOF_OFF_T
388 /* Starting from protocol version 26, we always use 64-bit
389 * ino_t and dev_t internally, even if this platform does not
390 * allow files to have 64-bit inums. That's because the
391 * receiver needs to find duplicate (dev,ino) tuples to detect
392 * hardlinks, and it might have files coming from a platform
393 * that has 64-bit inums.
395 * The only exception is if we're on a platform with no 64-bit type at
398 * Because we use read_longint() to get these off the wire, if you
399 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
400 * with no 64-bit types then you will get an overflow error. Probably
401 * not many people have that combination of machines, and you can
402 * avoid it by not preserving hardlinks or not transferring device
403 * nodes. It's not clear that any other behaviour is better.
405 * Note that if you transfer devices from a 64-bit-devt machine (say,
406 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
407 * device numbers will be truncated. But it's a kind of silly thing
410 * FIXME: I don't think the code in flist.c has ever worked on a system
411 * where dev_t is a struct.
420 #define MIN(a,b) ((a)<(b)?(a):(b))
424 #define MAX(a,b) ((a)>(b)?(a):(b))
427 #ifndef MAXHOSTNAMELEN
428 #define MAXHOSTNAMELEN 256
431 /* the length of the md4 checksum */
432 #define MD4_SUM_LENGTH 16
433 #define SUM_LENGTH 16
434 #define SHORT_SUM_LENGTH 2
435 #define BLOCKSUM_BIAS 10
438 #define MAXPATHLEN 1024
446 #define INADDR_NONE 0xffffffff
449 #ifndef IN_LOOPBACKNET
450 #define IN_LOOPBACKNET 127
453 #define GID_NONE ((gid_t)-1)
455 #define HL_CHECK_MASTER 0
459 struct file_struct *next;
463 #define F_DEV link_u.idev->dev
464 #define F_INODE link_u.idev->inode
466 #define F_HLINDEX link_u.links->hlindex
467 #define F_NEXT link_u.links->next
471 dev_t rdev; /* The device number, if this is a device */
472 char *sum; /* Only a normal file can have a checksum */
473 char *link; /* Points to symlink string, if a symlink */
487 uchar flags; /* this item MUST remain last */
491 * Start the flist array at FLIST_START entries and grow it
492 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
494 #define FLIST_START (32 * 1024)
495 #define FLIST_LINEAR (FLIST_START * 512)
498 * Extent size for allocation pools A minimum size of 128KB
499 * is needed to mmap them so that freeing will release the
502 * Larger sizes reduce leftover fragments and speed free calls
503 * (when they happen) Smaller sizes increase the chance of
504 * freed allocations freeing whole extents.
506 #define FILE_EXTENT (256 * 1024)
507 #define HLINK_EXTENT (128 * 1024)
510 #define WITHOUT_HLINK 0
513 struct file_struct **files;
514 alloc_pool_t file_pool;
515 alloc_pool_t hlink_pool;
520 #define SUMFLG_SAME_OFFSET (1<<0)
523 OFF_T offset; /**< offset in file of this chunk */
524 int32 len; /**< length of chunk of file */
525 uint32 sum1; /**< simple checksum */
526 short flags; /**< flag bits */
527 char sum2[SUM_LENGTH]; /**< checksum */
531 OFF_T flength; /**< total file length */
532 struct sum_buf *sums; /**< points to info for each chunk */
533 size_t count; /**< how many chunks */
534 int32 blength; /**< block_length */
535 int32 remainder; /**< flength % block_length */
536 int s2length; /**< sum2_length */
540 OFF_T file_size; /* File size (from stat) */
541 OFF_T p_offset; /* Window start */
542 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
543 char *p; /* Window pointer */
544 int32 p_size; /* Largest window size we allocated */
545 int32 p_len; /* Latest (rounded) window size */
546 int32 def_window_size; /* Default window size */
547 int fd; /* File Descriptor */
548 int status; /* first errno from read errors */
551 #define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
552 #define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
553 #define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
554 #define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
555 #define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
556 #define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
557 #define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
558 #define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
559 #define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
560 #define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
561 #define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
562 #define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
563 #define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
564 #define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
565 struct filter_struct {
566 struct filter_struct *next;
568 unsigned int match_flags;
571 struct filter_list_struct *mergelist;
575 struct filter_list_struct {
576 struct filter_struct *head;
577 struct filter_struct *tail;
583 int64 total_transferred_size;
588 int64 flist_buildtime;
589 int64 flist_xfertime;
592 int num_transferred_files;
593 int current_file_index;
597 /* we need this function because of the silly way in which duplicate
598 entries are handled in the file lists - we can't change this
599 without breaking existing versions */
600 static inline int flist_up(struct file_list *flist, int i)
602 while (!flist->files[i]->basename) i++;
606 #include "byteorder.h"
607 #include "lib/mdfour.h"
608 #include "lib/wildmatch.h"
609 #include "lib/permstring.h"
610 #include "lib/addrinfo.h"
614 /* We have replacement versions of these if they're missing. */
616 int asprintf(char **ptr, const char *format, ...);
620 int vasprintf(char **ptr, const char *format, va_list ap);
623 #if !HAVE_VSNPRINTF || !HAVE_C99_VSNPRINTF
624 #define vsnprintf rsync_vsnprintf
625 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
628 #if !HAVE_SNPRINTF || !HAVE_C99_VSNPRINTF
629 #define snprintf rsync_snprintf
630 int snprintf(char *str,size_t count,const char *fmt,...);
635 extern char *sys_errlist[];
636 #define strerror(i) sys_errlist[i]
640 # define strchr index
641 # define strrchr rindex
648 #define SUPPORT_LINKS HAVE_READLINK
649 #define SUPPORT_HARD_LINKS HAVE_LINK
651 #define SIGNAL_CAST (RETSIGTYPE (*)())
654 #define EWOULDBLOCK EAGAIN
658 #define STDIN_FILENO 0
661 #ifndef STDOUT_FILENO
662 #define STDOUT_FILENO 1
665 #ifndef STDERR_FILENO
666 #define STDERR_FILENO 2
678 #define ACCESSPERMS 0777
685 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
688 #define _S_IFMT 0170000
692 #define _S_IFLNK 0120000
696 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
700 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
704 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
709 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
711 #define S_ISSOCK(mode) (0)
717 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
719 #define S_ISFIFO(mode) (0)
724 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
728 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
731 /* work out what fcntl flag to use for non-blocking */
733 # define NONBLOCK_FLAG O_NONBLOCK
735 # define NONBLOCK_FLAG O_NDELAY
737 # define NONBLOCK_FLAG FNDELAY
740 #ifndef INADDR_LOOPBACK
741 #define INADDR_LOOPBACK 0x7f000001
745 #define INADDR_NONE 0xffffffff
748 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
750 /* Initial mask on permissions given to temporary files. Mask off setuid
751 bits and group access because of potential race-condition security
752 holes, and mask other access because mode 707 is bizarre */
753 #define INITACCESSPERMS 0700
755 /* handler for null strings in printf format */
756 #define NS(s) ((s)?(s):"<NULL>")
758 #if !defined(__GNUC__) || defined(APPLE)
759 /* Apparently the OS X port of gcc gags on __attribute__.
761 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
762 #define __attribute__(x)
766 /* Convenient wrappers for malloc and realloc. Use them. */
767 #define new(type) ((type *)malloc(sizeof(type)))
768 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
769 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
771 /* use magic gcc attributes to catch format errors */
772 void rprintf(enum logcode , const char *, ...)
773 __attribute__((format (printf, 2, 3)))
776 /* This is just like rprintf, but it also tries to print some
777 * representation of the error code. Normally errcode = errno. */
778 void rsyserr(enum logcode, int, const char *, ...)
779 __attribute__((format (printf, 3, 4)))
782 #if REPLACE_INET_NTOA
783 #define inet_ntoa rep_inet_ntoa
786 /* Make sure that the O_BINARY flag is defined. */
792 size_t strlcpy(char *d, const char *s, size_t bufsize);
796 size_t strlcat(char *d, const char *s, size_t bufsize);
800 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
803 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
806 #define MY_UID() geteuid()
808 #define MY_UID() getuid()
812 #define MY_GID() getegid()
814 #define MY_GID() getgid()
820 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
821 #endif /* !HAVE_INET_NTOP */
824 int inet_pton(int af, const char *src, void *dst);
827 #ifdef MAINTAINER_MODE
828 const char *get_panic_action(void);
831 #define UNUSED(x) x __attribute__((__unused__))
833 extern const char *io_write_phase, *io_read_phase;