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) /* generator only */
62 #define FLAG_MOUNT_POINT (1<<2) /* sender only */
64 /* update this if you make incompatible changes */
65 #define PROTOCOL_VERSION 28
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)
96 #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
97 #define IOERR_VANISHED (1<<1)
103 #define NO_EXCLUDES 0
104 #define SERVER_EXCLUDES 1
105 #define ALL_EXCLUDES 2
107 #define XFLG_FATAL_ERRORS (1<<0)
108 #define XFLG_DEF_INCLUDE (1<<1)
109 #define XFLG_WORDS_ONLY (1<<2)
110 #define XFLG_WORD_SPLIT (1<<3)
111 #define XFLG_DIRECTORY (1<<4)
113 #define PERMS_REPORT (1<<0)
114 #define PERMS_SKIP_MTIME (1<<1)
117 #define NORMAL_FLUSH 0
119 #define PDIR_CREATE 1
120 #define PDIR_DELETE 0
123 /* Log-message categories. FLOG is only used on the daemon side to
124 * output messages to the log file. */
125 enum logcode { FERROR=1, FINFO=2, FLOG=3 };
127 /* Messages types that are sent over the message channel. The logcode
128 * values must all be present here with identical numbers. */
130 MSG_DONE=5, /* current phase is done */
131 MSG_REDO=4, /* reprocess indicated flist index */
132 MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
133 MSG_DATA=0 /* raw data on the multiplexed stream */
140 /* The default RSYNC_RSH is always set in config.h. */
142 #include <sys/types.h>
150 #ifdef HAVE_SYS_PARAM_H
151 #include <sys/param.h>
158 #if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
162 #ifdef HAVE_SYS_SOCKET_H
163 #include <sys/socket.h>
170 #ifdef TIME_WITH_SYS_TIME
171 #include <sys/time.h>
174 #ifdef HAVE_SYS_TIME_H
175 #include <sys/time.h>
184 #ifdef HAVE_SYS_FCNTL_H
185 #include <sys/fcntl.h>
189 #include <sys/stat.h>
191 #ifdef HAVE_SYS_IOCTL_H
192 #include <sys/ioctl.h>
195 #ifdef HAVE_SYS_FILIO_H
196 #include <sys/filio.h>
200 #ifdef HAVE_SYS_WAIT_H
201 #include <sys/wait.h>
215 #ifdef HAVE_SYS_SELECT_H
216 #include <sys/select.h>
219 #ifdef HAVE_SYS_MODE_H
220 /* apparently AIX needs this for S_ISLNK */
222 #include <sys/mode.h>
230 /* these are needed for the uid/gid mapping code */
235 #include <netinet/in.h>
236 #include <arpa/inet.h>
239 #include <sys/file.h>
244 # define dirent direct
246 # include <sys/ndir.h>
249 # include <sys/dir.h>
257 #include <sys/mkdev.h>
258 # if !defined(makedev) && defined(mkdev)
259 # define makedev mkdev
261 #elif MAJOR_IN_SYSMACROS
262 #include <sys/sysmacros.h>
271 #include "lib/pool_alloc.h"
276 #define uchar unsigned char
279 #if HAVE_UNSIGNED_CHAR
280 #define schar signed char
286 #if (SIZEOF_INT == 4)
288 #elif (SIZEOF_LONG == 4)
290 #elif (SIZEOF_SHORT == 4)
293 /* I hope this works */
300 #define uint32 unsigned int32
304 #define OFF_T off64_t
305 #define STRUCT_STAT struct stat64
308 #define STRUCT_STAT struct stat
312 #define int64 off64_t
313 #elif (SIZEOF_LONG == 8)
315 #elif (SIZEOF_INT == 8)
318 #define int64 long long
320 /* As long as it gets... */
322 #define INT64_IS_OFF_T
325 #if (SIZEOF_LONG == 8)
326 #define uint64 unsigned long
327 #elif (SIZEOF_INT == 8)
328 #define uint64 unsigned int
330 #define uint64 unsigned long long
332 /* As long as it gets... */
333 #define uint64 unsigned off_t
336 /* Starting from protocol version 26, we always use 64-bit
337 * ino_t and dev_t internally, even if this platform does not
338 * allow files to have 64-bit inums. That's because the
339 * receiver needs to find duplicate (dev,ino) tuples to detect
340 * hardlinks, and it might have files coming from a platform
341 * that has 64-bit inums.
343 * The only exception is if we're on a platform with no 64-bit type at
346 * Because we use read_longint() to get these off the wire, if you
347 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
348 * with no 64-bit types then you will get an overflow error. Probably
349 * not many people have that combination of machines, and you can
350 * avoid it by not preserving hardlinks or not transferring device
351 * nodes. It's not clear that any other behaviour is better.
353 * Note that if you transfer devices from a 64-bit-devt machine (say,
354 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
355 * device numbers will be truncated. But it's a kind of silly thing
358 * FIXME: I don't think the code in flist.c has ever worked on a system
359 * where dev_t is a struct.
368 #define MIN(a,b) ((a)<(b)?(a):(b))
372 #define MAX(a,b) ((a)>(b)?(a):(b))
375 #ifndef MAXHOSTNAMELEN
376 #define MAXHOSTNAMELEN 256
379 /* the length of the md4 checksum */
380 #define MD4_SUM_LENGTH 16
381 #define SUM_LENGTH 16
382 #define SHORT_SUM_LENGTH 2
383 #define BLOCKSUM_BIAS 10
386 #define MAXPATHLEN 1024
394 #define INADDR_NONE 0xffffffff
397 #ifndef IN_LOOPBACKNET
398 #define IN_LOOPBACKNET 127
401 #define GID_NONE ((gid_t)-1)
403 #define HL_CHECK_MASTER 0
408 struct file_struct *next;
411 #define F_DEV link_u.idev->dev
412 #define F_INODE link_u.idev->inode
414 #define F_HLINDEX link_u.links->hlindex
415 #define F_NEXT link_u.links->next
419 dev_t rdev; /* The device number, if this is a device */
420 char *sum; /* Only a normal file can have a checksum */
421 char *link; /* Points to symlink string, if a symlink */
435 uchar flags; /* this item MUST remain last */
439 * Start the flist array at FLIST_START entries and grow it
440 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
442 #define FLIST_START (32 * 1024)
443 #define FLIST_LINEAR (FLIST_START * 512)
446 * Extent size for allocation pools A minimum size of 128KB
447 * is needed to mmap them so that freeing will release the
450 * Larger sizes reduce leftover fragments and speed free calls
451 * (when they happen) Smaller sizes increase the chance of
452 * freed allocations freeing whole extents.
454 #define FILE_EXTENT (256 * 1024)
455 #define HLINK_EXTENT (128 * 1024)
458 #define WITHOUT_HLINK 0
463 alloc_pool_t file_pool;
464 alloc_pool_t hlink_pool;
465 struct file_struct **files;
468 #define SUMFLG_SAME_OFFSET (1<<0)
471 OFF_T offset; /**< offset in file of this chunk */
472 unsigned int len; /**< length of chunk of file */
473 uint32 sum1; /**< simple checksum */
474 short flags; /**< flag bits */
475 char sum2[SUM_LENGTH]; /**< checksum */
479 OFF_T flength; /**< total file length */
480 size_t count; /**< how many chunks */
481 unsigned int blength; /**< block_length */
482 unsigned int remainder; /**< flength % block_length */
483 int s2length; /**< sum2_length */
484 struct sum_buf *sums; /**< points to info for each chunk */
488 char *p; /* Window pointer */
489 int fd; /* File Descriptor */
490 int p_size; /* Largest window size we allocated */
491 int p_len; /* Latest (rounded) window size */
492 int def_window_size; /* Default window size */
493 int status; /* first errno from read errors */
494 OFF_T file_size; /* File size (from stat) */
495 OFF_T p_offset; /* Window start */
496 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
499 #define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
500 #define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
501 #define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
502 #define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
503 #define MATCHFLG_INCLUDE (1<<4) /* this is an include, not an exclude */
504 #define MATCHFLG_DIRECTORY (1<<5) /* this matches only directories */
505 #define MATCHFLG_CLEAR_LIST (1<<6) /* this item is the "!" token */
506 struct exclude_struct {
507 struct exclude_struct *next;
509 unsigned int match_flags;
513 struct exclude_list_struct {
514 struct exclude_struct *head;
515 struct exclude_struct *tail;
521 int64 total_transferred_size;
528 int num_transferred_files;
529 int current_file_index;
533 /* we need this function because of the silly way in which duplicate
534 entries are handled in the file lists - we can't change this
535 without breaking existing versions */
536 static inline int flist_up(struct file_list *flist, int i)
538 while (!flist->files[i]->basename) i++;
542 #include "byteorder.h"
543 #include "lib/mdfour.h"
544 #include "lib/wildmatch.h"
545 #include "lib/permstring.h"
546 #include "lib/addrinfo.h"
550 /* We have replacement versions of these if they're missing. */
551 #ifndef HAVE_ASPRINTF
552 int asprintf(char **ptr, const char *format, ...);
555 #ifndef HAVE_VASPRINTF
556 int vasprintf(char **ptr, const char *format, va_list ap);
559 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
560 #define vsnprintf rsync_vsnprintf
561 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
564 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
565 #define snprintf rsync_snprintf
566 int snprintf(char *str,size_t count,const char *fmt,...);
571 extern char *sys_errlist[];
572 #define strerror(i) sys_errlist[i]
576 # define strchr index
577 # define strrchr rindex
580 #ifndef HAVE_ERRNO_DECL
584 #define SUPPORT_LINKS HAVE_READLINK
585 #define SUPPORT_HARD_LINKS HAVE_LINK
587 /* This could be bad on systems which have no lchown and where chown
588 * follows symbollic links. On such systems it might be better not to
589 * try to chown symlinks at all. */
594 #define SIGNAL_CAST (RETSIGTYPE (*)())
597 #define EWOULDBLOCK EAGAIN
601 #define STDIN_FILENO 0
604 #ifndef STDOUT_FILENO
605 #define STDOUT_FILENO 1
608 #ifndef STDERR_FILENO
609 #define STDERR_FILENO 2
621 #define ACCESSPERMS 0777
628 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
631 #define _S_IFMT 0170000
635 #define _S_IFLNK 0120000
639 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
643 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
647 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
652 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
654 #define S_ISSOCK(mode) (0)
660 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
662 #define S_ISFIFO(mode) (0)
667 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
671 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
674 /* work out what fcntl flag to use for non-blocking */
676 # define NONBLOCK_FLAG O_NONBLOCK
678 # define NONBLOCK_FLAG O_NDELAY
680 # define NONBLOCK_FLAG FNDELAY
683 #ifndef INADDR_LOOPBACK
684 #define INADDR_LOOPBACK 0x7f000001
688 #define INADDR_NONE 0xffffffff
691 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
693 /* Initial mask on permissions given to temporary files. Mask off setuid
694 bits and group access because of potential race-condition security
695 holes, and mask other access because mode 707 is bizarre */
696 #define INITACCESSPERMS 0700
698 /* handler for null strings in printf format */
699 #define NS(s) ((s)?(s):"<NULL>")
701 #if !defined(__GNUC__) || defined(APPLE)
702 /* Apparently the OS X port of gcc gags on __attribute__.
704 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
705 #define __attribute__(x)
709 /* Convenient wrappers for malloc and realloc. Use them. */
710 #define new(type) ((type *)malloc(sizeof(type)))
711 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
712 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
714 /* use magic gcc attributes to catch format errors */
715 void rprintf(enum logcode , const char *, ...)
716 __attribute__((format (printf, 2, 3)))
719 /* This is just like rprintf, but it also tries to print some
720 * representation of the error code. Normally errcode = errno. */
721 void rsyserr(enum logcode, int, const char *, ...)
722 __attribute__((format (printf, 3, 4)))
725 #ifdef REPLACE_INET_NTOA
726 #define inet_ntoa rep_inet_ntoa
729 /* Make sure that the O_BINARY flag is defined. */
735 size_t strlcpy(char *d, const char *s, size_t bufsize);
739 size_t strlcat(char *d, const char *s, size_t bufsize);
743 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
746 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
749 #define MY_UID() geteuid()
751 #define MY_UID() getuid()
755 #define MY_GID() getegid()
757 #define MY_GID() getgid()
762 #ifndef HAVE_INET_NTOP
764 inet_ntop(int af, const void *src, char *dst, size_t size);
765 #endif /* !HAVE_INET_NTOP */
767 #ifndef HAVE_INET_PTON
768 int inet_pton(int af, const char *src, void *dst);
771 #ifdef MAINTAINER_MODE
772 const char *get_panic_action(void);
775 #define UNUSED(x) x __attribute__((__unused__))
777 extern const char *io_write_phase, *io_read_phase;