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>
185 # include <inttypes.h>
196 #include <sys/param.h>
199 #if HAVE_MALLOC_H && (HAVE_MALLINFO || !HAVE_STDLIB_H)
203 #if HAVE_SYS_SOCKET_H
204 #include <sys/socket.h>
207 #if TIME_WITH_SYS_TIME
208 #include <sys/time.h>
212 #include <sys/time.h>
222 #include <sys/fcntl.h>
227 #include <sys/ioctl.h>
231 #include <sys/filio.h>
236 #include <sys/wait.h>
250 #if HAVE_SYS_SELECT_H
251 #include <sys/select.h>
255 /* apparently AIX needs this for S_ISLNK */
257 #include <sys/mode.h>
265 /* these are needed for the uid/gid mapping code */
270 #include <netinet/in.h>
271 #include <arpa/inet.h>
274 #include <sys/file.h>
279 # define dirent direct
281 # include <sys/ndir.h>
284 # include <sys/dir.h>
292 #include <sys/mkdev.h>
293 # if !defined(makedev) && defined(mkdev)
294 # define makedev mkdev
296 #elif MAJOR_IN_SYSMACROS
297 #include <sys/sysmacros.h>
306 #include "lib/pool_alloc.h"
311 #define uchar unsigned char
315 #define schar signed char
320 /* Find a variable that is either exactly 32-bits or longer.
321 * If some code depends on 32-bit truncation, it will need to
322 * take special action in a "#if SIZEOF_INT32 > 4" section. */
326 # define SIZEOF_INT32 4
327 #elif SIZEOF_LONG == 4
329 # define SIZEOF_INT32 4
330 #elif SIZEOF_SHORT == 4
332 # define SIZEOF_INT32 4
335 # define SIZEOF_INT32 SIZEOF_INT
336 #elif SIZEOF_LONG > 4
338 # define SIZEOF_INT32 SIZEOF_LONG
340 # error Could not find a 32-bit integer variable
343 # define SIZEOF_INT32 4
347 #define uint32 unsigned int32
351 #define OFF_T off64_t
352 #define STRUCT_STAT struct stat64
355 #define STRUCT_STAT struct stat
358 /* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
359 * that's the maximum size the file system can handle and there is no
360 * 64-bit type available. The rsync source must therefore take steps
361 * to ensure that any code that really requires a 64-bit integer has
362 * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
364 #if SIZEOF_OFF64_T == 8
365 # define int64 off64_t
366 # define SIZEOF_INT64 8
367 #elif SIZEOF_LONG == 8
369 # define SIZEOF_INT64 8
370 #elif SIZEOF_INT == 8
372 # define SIZEOF_INT64 8
373 #elif SIZEOF_LONG_LONG == 8
374 # define int64 long long
375 # define SIZEOF_INT64 8
376 #elif SIZEOF_OFF_T == 8
378 # define SIZEOF_INT64 8
381 # define SIZEOF_INT64 SIZEOF_INT
382 #elif SIZEOF_LONG > 8
384 # define SIZEOF_INT64 SIZEOF_LONG
385 #elif SIZEOF_LONG_LONG > 8
386 # define int64 long long
387 # define SIZEOF_INT64 SIZEOF_LONG_LONG
389 /* As long as it gets... */
391 # define SIZEOF_INT64 SIZEOF_OFF_T
394 /* Starting from protocol version 26, we always use 64-bit
395 * ino_t and dev_t internally, even if this platform does not
396 * allow files to have 64-bit inums. That's because the
397 * receiver needs to find duplicate (dev,ino) tuples to detect
398 * hardlinks, and it might have files coming from a platform
399 * that has 64-bit inums.
401 * The only exception is if we're on a platform with no 64-bit type at
404 * Because we use read_longint() to get these off the wire, if you
405 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
406 * with no 64-bit types then you will get an overflow error. Probably
407 * not many people have that combination of machines, and you can
408 * avoid it by not preserving hardlinks or not transferring device
409 * nodes. It's not clear that any other behaviour is better.
411 * Note that if you transfer devices from a 64-bit-devt machine (say,
412 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
413 * device numbers will be truncated. But it's a kind of silly thing
416 * FIXME: I don't think the code in flist.c has ever worked on a system
417 * where dev_t is a struct.
426 #define MIN(a,b) ((a)<(b)?(a):(b))
430 #define MAX(a,b) ((a)>(b)?(a):(b))
433 #ifndef MAXHOSTNAMELEN
434 #define MAXHOSTNAMELEN 256
437 /* the length of the md4 checksum */
438 #define MD4_SUM_LENGTH 16
439 #define SUM_LENGTH 16
440 #define SHORT_SUM_LENGTH 2
441 #define BLOCKSUM_BIAS 10
444 #define MAXPATHLEN 1024
452 #define INADDR_NONE 0xffffffff
455 #ifndef IN_LOOPBACKNET
456 #define IN_LOOPBACKNET 127
459 #define GID_NONE ((gid_t)-1)
461 #define HL_CHECK_MASTER 0
465 struct file_struct *next;
469 #define F_DEV link_u.idev->dev
470 #define F_INODE link_u.idev->inode
472 #define F_HLINDEX link_u.links->hlindex
473 #define F_NEXT link_u.links->next
477 dev_t rdev; /* The device number, if this is a device */
478 char *sum; /* Only a normal file can have a checksum */
479 char *link; /* Points to symlink string, if a symlink */
493 uchar flags; /* this item MUST remain last */
497 * Start the flist array at FLIST_START entries and grow it
498 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
500 #define FLIST_START (32 * 1024)
501 #define FLIST_LINEAR (FLIST_START * 512)
504 * Extent size for allocation pools A minimum size of 128KB
505 * is needed to mmap them so that freeing will release the
508 * Larger sizes reduce leftover fragments and speed free calls
509 * (when they happen) Smaller sizes increase the chance of
510 * freed allocations freeing whole extents.
512 #define FILE_EXTENT (256 * 1024)
513 #define HLINK_EXTENT (128 * 1024)
516 #define WITHOUT_HLINK 0
519 struct file_struct **files;
520 alloc_pool_t file_pool;
521 alloc_pool_t hlink_pool;
526 #define SUMFLG_SAME_OFFSET (1<<0)
529 OFF_T offset; /**< offset in file of this chunk */
530 int32 len; /**< length of chunk of file */
531 uint32 sum1; /**< simple checksum */
532 short flags; /**< flag bits */
533 char sum2[SUM_LENGTH]; /**< checksum */
537 OFF_T flength; /**< total file length */
538 struct sum_buf *sums; /**< points to info for each chunk */
539 size_t count; /**< how many chunks */
540 int32 blength; /**< block_length */
541 int32 remainder; /**< flength % block_length */
542 int s2length; /**< sum2_length */
546 OFF_T file_size; /* File size (from stat) */
547 OFF_T p_offset; /* Window start */
548 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
549 char *p; /* Window pointer */
550 int32 p_size; /* Largest window size we allocated */
551 int32 p_len; /* Latest (rounded) window size */
552 int32 def_window_size; /* Default window size */
553 int fd; /* File Descriptor */
554 int status; /* first errno from read errors */
557 #define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
558 #define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
559 #define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
560 #define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
561 #define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
562 #define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
563 #define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
564 #define MATCHFLG_WORD_SPLIT (1<<7) /* split rules on whitespace */
565 #define MATCHFLG_NO_INHERIT (1<<8) /* don't inherit these rules */
566 #define MATCHFLG_NO_PREFIXES (1<<9) /* parse no prefixes from patterns */
567 #define MATCHFLG_MERGE_FILE (1<<10)/* specifies a file to merge */
568 #define MATCHFLG_PERDIR_MERGE (1<<11)/* merge-file is searched per-dir */
569 #define MATCHFLG_EXCLUDE_SELF (1<<12)/* merge-file name should be excluded */
570 #define MATCHFLG_FINISH_SETUP (1<<13)/* per-dir merge file needs setup */
571 struct filter_struct {
572 struct filter_struct *next;
574 unsigned int match_flags;
577 struct filter_list_struct *mergelist;
581 struct filter_list_struct {
582 struct filter_struct *head;
583 struct filter_struct *tail;
589 int64 total_transferred_size;
594 int64 flist_buildtime;
595 int64 flist_xfertime;
598 int num_transferred_files;
599 int current_file_index;
603 /* we need this function because of the silly way in which duplicate
604 entries are handled in the file lists - we can't change this
605 without breaking existing versions */
606 static inline int flist_up(struct file_list *flist, int i)
608 while (!flist->files[i]->basename) i++;
612 #include "byteorder.h"
613 #include "lib/mdfour.h"
614 #include "lib/wildmatch.h"
615 #include "lib/permstring.h"
616 #include "lib/addrinfo.h"
620 /* We have replacement versions of these if they're missing. */
622 int asprintf(char **ptr, const char *format, ...);
626 int vasprintf(char **ptr, const char *format, va_list ap);
629 #if !HAVE_VSNPRINTF || !HAVE_C99_VSNPRINTF
630 #define vsnprintf rsync_vsnprintf
631 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
634 #if !HAVE_SNPRINTF || !HAVE_C99_VSNPRINTF
635 #define snprintf rsync_snprintf
636 int snprintf(char *str,size_t count,const char *fmt,...);
641 extern char *sys_errlist[];
642 #define strerror(i) sys_errlist[i]
646 # define strchr index
647 # define strrchr rindex
654 #define SUPPORT_LINKS HAVE_READLINK
655 #define SUPPORT_HARD_LINKS HAVE_LINK
657 #define SIGNAL_CAST (RETSIGTYPE (*)())
660 #define EWOULDBLOCK EAGAIN
664 #define STDIN_FILENO 0
667 #ifndef STDOUT_FILENO
668 #define STDOUT_FILENO 1
671 #ifndef STDERR_FILENO
672 #define STDERR_FILENO 2
684 #define ACCESSPERMS 0777
691 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
694 #define _S_IFMT 0170000
698 #define _S_IFLNK 0120000
702 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
706 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
710 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
715 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
717 #define S_ISSOCK(mode) (0)
723 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
725 #define S_ISFIFO(mode) (0)
730 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
734 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
737 /* work out what fcntl flag to use for non-blocking */
739 # define NONBLOCK_FLAG O_NONBLOCK
741 # define NONBLOCK_FLAG O_NDELAY
743 # define NONBLOCK_FLAG FNDELAY
746 #ifndef INADDR_LOOPBACK
747 #define INADDR_LOOPBACK 0x7f000001
751 #define INADDR_NONE 0xffffffff
754 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
756 /* Initial mask on permissions given to temporary files. Mask off setuid
757 bits and group access because of potential race-condition security
758 holes, and mask other access because mode 707 is bizarre */
759 #define INITACCESSPERMS 0700
761 /* handler for null strings in printf format */
762 #define NS(s) ((s)?(s):"<NULL>")
764 #if !defined(__GNUC__) || defined(APPLE)
765 /* Apparently the OS X port of gcc gags on __attribute__.
767 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
768 #define __attribute__(x)
772 /* Convenient wrappers for malloc and realloc. Use them. */
773 #define new(type) ((type *)malloc(sizeof(type)))
774 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
775 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
777 /* use magic gcc attributes to catch format errors */
778 void rprintf(enum logcode , const char *, ...)
779 __attribute__((format (printf, 2, 3)))
782 /* This is just like rprintf, but it also tries to print some
783 * representation of the error code. Normally errcode = errno. */
784 void rsyserr(enum logcode, int, const char *, ...)
785 __attribute__((format (printf, 3, 4)))
788 #if REPLACE_INET_NTOA
789 #define inet_ntoa rep_inet_ntoa
792 /* Make sure that the O_BINARY flag is defined. */
798 size_t strlcpy(char *d, const char *s, size_t bufsize);
802 size_t strlcat(char *d, const char *s, size_t bufsize);
806 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
809 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
812 #define MY_UID() geteuid()
814 #define MY_UID() getuid()
818 #define MY_GID() getegid()
820 #define MY_GID() getgid()
826 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
827 #endif /* !HAVE_INET_NTOP */
830 int inet_pton(int af, const char *src, void *dst);
833 #ifdef MAINTAINER_MODE
834 const char *get_panic_action(void);
837 #define UNUSED(x) x __attribute__((__unused__))
839 extern const char *io_write_phase, *io_read_phase;