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_HIGH_RDEV (1<<8)
54 #define XMIT_HAS_IDEV_DATA (1<<9)
55 #define XMIT_SAME_DEV (1<<10)
57 /* These flags are used in the live flist data. */
59 #define FLAG_TOP_DIR (1<<0)
60 #define FLAG_HLINK_EOL (1<<1) /* generator only */
61 #define FLAG_MOUNT_POINT (1<<2) /* sender only */
63 /* update this if you make incompatible changes */
64 #define PROTOCOL_VERSION 28
66 /* We refuse to interoperate with versions that are not in this range.
67 * Note that we assume we'll work with later versions: the onus is on
68 * people writing them to make sure that they don't send us anything
69 * we won't understand.
71 * Interoperation with old but supported protocol versions
72 * should cause a warning to be printed. At a future date
73 * the old protocol will become the minimum and
74 * compatibility code removed.
76 * There are two possible explanations for the limit at
77 * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that
78 * do not interoperate with us, and (more likely) so that we can
79 * detect an attempt to connect rsync to a non-rsync server, which is
80 * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and
81 * MAX_PROTOCOL_VERSION. */
83 #define MIN_PROTOCOL_VERSION 20
84 #define OLD_PROTOCOL_VERSION 25
85 #define MAX_PROTOCOL_VERSION 40
87 #define RSYNC_PORT 873
89 #define SPARSE_WRITE_SIZE (1024)
90 #define WRITE_SIZE (32*1024)
91 #define CHUNK_SIZE (32*1024)
92 #define MAX_MAP_SIZE (256*1024)
93 #define IO_BUFFER_SIZE (4092)
95 #define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */
96 #define IOERR_VANISHED (1<<1)
102 #define NO_EXCLUDES 0
103 #define SERVER_EXCLUDES 1
104 #define ALL_EXCLUDES 2
107 #define MISSING_FATAL 1
109 #define ADD_INCLUDE 1
110 #define ADD_EXCLUDE 0
113 #define NORMAL_FLUSH 0
116 /* Log-message categories. FLOG is only used on the daemon side to
117 * output messages to the log file. */
118 enum logcode { FERROR=1, FINFO=2, FLOG=3 };
120 /* Messages types that are sent over the message channel. The logcode
121 * values must all be present here with identical numbers. */
123 MSG_DATA=0, /* raw data on the multiplexed stream */
124 MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
125 MSG_REDO=4, /* reprocess indicated flist index */
126 MSG_DONE=5, /* current phase is done */
133 /* The default RSYNC_RSH is always set in config.h. */
135 #include <sys/types.h>
143 #ifdef HAVE_SYS_PARAM_H
144 #include <sys/param.h>
151 #if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
155 #ifdef HAVE_SYS_SOCKET_H
156 #include <sys/socket.h>
163 #ifdef TIME_WITH_SYS_TIME
164 #include <sys/time.h>
167 #ifdef HAVE_SYS_TIME_H
168 #include <sys/time.h>
177 #ifdef HAVE_SYS_FCNTL_H
178 #include <sys/fcntl.h>
182 #include <sys/stat.h>
184 #ifdef HAVE_SYS_IOCTL_H
185 #include <sys/ioctl.h>
188 #ifdef HAVE_SYS_FILIO_H
189 #include <sys/filio.h>
193 #ifdef HAVE_SYS_WAIT_H
194 #include <sys/wait.h>
208 #ifdef HAVE_SYS_SELECT_H
209 #include <sys/select.h>
212 #ifdef HAVE_SYS_MODE_H
213 /* apparently AIX needs this for S_ISLNK */
215 #include <sys/mode.h>
223 /* these are needed for the uid/gid mapping code */
228 #include <netinet/in.h>
229 #include <arpa/inet.h>
232 #include <sys/file.h>
237 # define dirent direct
239 # include <sys/ndir.h>
242 # include <sys/dir.h>
250 #include <sys/mkdev.h>
251 #elif MAJOR_IN_SYSMACROS
252 #include <sys/sysmacros.h>
261 #include "lib/pool_alloc.h"
266 #define uchar unsigned char
269 #if HAVE_UNSIGNED_CHAR
270 #define schar signed char
276 #if (SIZEOF_INT == 4)
278 #elif (SIZEOF_LONG == 4)
280 #elif (SIZEOF_SHORT == 4)
283 /* I hope this works */
290 #define uint32 unsigned int32
294 #define OFF_T off64_t
295 #define STRUCT_STAT struct stat64
298 #define STRUCT_STAT struct stat
302 #define int64 off64_t
303 #elif (SIZEOF_LONG == 8)
305 #elif (SIZEOF_INT == 8)
308 #define int64 long long
310 /* As long as it gets... */
315 #if (SIZEOF_LONG == 8)
316 #define uint64 unsigned long
317 #elif (SIZEOF_INT == 8)
318 #define uint64 unsigned int
320 #define uint64 unsigned long long
322 /* As long as it gets... */
323 #define uint64 unsigned off_t
326 /* Starting from protocol version 26, we always use 64-bit
327 * ino_t and dev_t internally, even if this platform does not
328 * allow files to have 64-bit inums. That's because the
329 * receiver needs to find duplicate (dev,ino) tuples to detect
330 * hardlinks, and it might have files coming from a platform
331 * that has 64-bit inums.
333 * The only exception is if we're on a platform with no 64-bit type at
336 * Because we use read_longint() to get these off the wire, if you
337 * transfer devices or hardlinks with dev or inum > 2**32 to a machine
338 * with no 64-bit types then you will get an overflow error. Probably
339 * not many people have that combination of machines, and you can
340 * avoid it by not preserving hardlinks or not transferring device
341 * nodes. It's not clear that any other behaviour is better.
343 * Note that if you transfer devices from a 64-bit-devt machine (say,
344 * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
345 * device numbers will be truncated. But it's a kind of silly thing
348 * FIXME: In future, we should probable split the device number into
349 * major/minor, and transfer the two parts as 32-bit ints. That gives
350 * you somewhat more of a chance that they'll come from a big machine
351 * to a little one in a useful way.
353 * FIXME: Really we need an unsigned type, and we perhaps ought to
354 * cope with platforms on which this is an unsigned int or even a
357 #define INO64_T uint64
358 #define DEV64_T uint64
361 #define MIN(a,b) ((a)<(b)?(a):(b))
365 #define MAX(a,b) ((a)>(b)?(a):(b))
368 #ifndef MAXHOSTNAMELEN
369 #define MAXHOSTNAMELEN 256
372 /* the length of the md4 checksum */
373 #define MD4_SUM_LENGTH 16
374 #define SUM_LENGTH 16
375 #define SHORT_SUM_LENGTH 2
376 #define BLOCKSUM_BIAS 10
379 #define MAXPATHLEN 1024
387 #define INADDR_NONE 0xffffffff
390 #ifndef IN_LOOPBACKNET
391 #define IN_LOOPBACKNET 127
394 #define GID_NONE (gid_t) -1
396 #define HL_CHECK_MASTER 0
401 struct file_struct *next;
409 #define F_DEV link_u.idev->dev
410 #define F_INODE link_u.idev->inode
412 #define F_HLINDEX link_u.links->hlindex
413 #define F_NEXT link_u.links->next
417 DEV64_T rdev; /* The device number, if this is a device */
418 char *sum; /* Only a normal file can have a checksum */
419 char *link; /* Holds symlink string, if a symlink */
433 uchar flags; /* this item MUST remain last */
437 * Start the flist array at FLIST_START entries and grow it
438 * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
440 #define FLIST_START (32 * 1024)
441 #define FLIST_LINEAR (FLIST_START * 512)
444 * Extent size for allocation pools A minimum size of 128KB
445 * is needed to mmap them so that freeing will release the
448 * Larger sizes reduce leftover fragments and speed free calls
449 * (when they happen) Smaller sizes increase the chance of
450 * freed allocations freeing whole extents.
452 #define FILE_EXTENT (256 * 1024)
453 #define HLINK_EXTENT (128 * 1024)
456 #define WITHOUT_HLINK 0
461 alloc_pool_t file_pool;
462 alloc_pool_t hlink_pool;
463 struct file_struct **files;
467 OFF_T offset; /**< offset in file of this chunk */
468 unsigned int len; /**< length of chunk of file */
469 int i; /**< index of this chunk */
470 uint32 sum1; /**< simple checksum */
471 char sum2[SUM_LENGTH]; /**< checksum */
475 OFF_T flength; /**< total file length */
476 size_t count; /**< how many chunks */
477 unsigned int blength; /**< block_length */
478 unsigned int remainder; /**< flength % block_length */
479 int s2length; /**< sum2_length */
480 struct sum_buf *sums; /**< points to info for each chunk */
484 char *p; /* Window pointer */
485 int fd; /* File Descriptor */
486 int p_size; /* Window size at allocation */
487 int p_len; /* Window size after fill */
488 /* p_size and p_len could be
489 * consolodated by using a local
490 * variable in map_ptr() */
491 int status; /* first errno from read errors */
492 OFF_T file_size; /* File size (from stat) */
493 OFF_T p_offset; /* Window start */
494 OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */
497 #define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */
498 #define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */
499 #define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */
500 #define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */
501 struct exclude_struct {
511 int64 total_transferred_size;
518 int num_transferred_files;
519 int current_file_index;
523 /* we need this function because of the silly way in which duplicate
524 entries are handled in the file lists - we can't change this
525 without breaking existing versions */
526 static inline int flist_up(struct file_list *flist, int i)
528 while (!flist->files[i]->basename) i++;
532 #include "byteorder.h"
533 #include "lib/mdfour.h"
534 #include "lib/wildmatch.h"
535 #include "lib/permstring.h"
536 #include "lib/addrinfo.h"
540 /* We have replacement versions of these if they're missing. */
541 #ifndef HAVE_ASPRINTF
542 int asprintf(char **ptr, const char *format, ...);
545 #ifndef HAVE_VASPRINTF
546 int vasprintf(char **ptr, const char *format, va_list ap);
549 #if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
550 #define vsnprintf rsync_vsnprintf
551 int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
554 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
555 #define snprintf rsync_snprintf
556 int snprintf(char *str,size_t count,const char *fmt,...);
561 extern char *sys_errlist[];
562 #define strerror(i) sys_errlist[i]
566 # define strchr index
567 # define strrchr rindex
570 #ifndef HAVE_ERRNO_DECL
574 #define SUPPORT_LINKS HAVE_READLINK
575 #define SUPPORT_HARD_LINKS HAVE_LINK
577 /* This could be bad on systems which have no lchown and where chown
578 * follows symbollic links. On such systems it might be better not to
579 * try to chown symlinks at all. */
584 #define SIGNAL_CAST (RETSIGTYPE (*)())
587 #define EWOULDBLOCK EAGAIN
591 #define STDIN_FILENO 0
594 #ifndef STDOUT_FILENO
595 #define STDOUT_FILENO 1
598 #ifndef STDERR_FILENO
599 #define STDERR_FILENO 2
611 #define ACCESSPERMS 0777
618 #define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS)
621 #define _S_IFMT 0170000
625 #define _S_IFLNK 0120000
629 #define S_ISLNK(mode) (((mode) & (_S_IFMT)) == (_S_IFLNK))
633 #define S_ISBLK(mode) (((mode) & (_S_IFMT)) == (_S_IFBLK))
637 #define S_ISCHR(mode) (((mode) & (_S_IFMT)) == (_S_IFCHR))
642 #define S_ISSOCK(mode) (((mode) & (_S_IFMT)) == (_S_IFSOCK))
644 #define S_ISSOCK(mode) (0)
650 #define S_ISFIFO(mode) (((mode) & (_S_IFMT)) == (_S_IFIFO))
652 #define S_ISFIFO(mode) (0)
657 #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR))
661 #define S_ISREG(mode) (((mode) & (_S_IFMT)) == (_S_IFREG))
664 /* work out what fcntl flag to use for non-blocking */
666 # define NONBLOCK_FLAG O_NONBLOCK
668 # define NONBLOCK_FLAG O_NDELAY
670 # define NONBLOCK_FLAG FNDELAY
673 #ifndef INADDR_LOOPBACK
674 #define INADDR_LOOPBACK 0x7f000001
678 #define INADDR_NONE 0xffffffff
681 #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
683 /* Initial mask on permissions given to temporary files. Mask off setuid
684 bits and group access because of potential race-condition security
685 holes, and mask other access because mode 707 is bizarre */
686 #define INITACCESSPERMS 0700
688 /* handler for null strings in printf format */
689 #define NS(s) ((s)?(s):"<NULL>")
691 #if !defined(__GNUC__) || defined(APPLE)
692 /* Apparently the OS X port of gcc gags on __attribute__.
694 * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
695 #define __attribute__(x)
699 /* Convenient wrappers for malloc and realloc. Use them. */
700 #define new(type) ((type *)malloc(sizeof(type)))
701 #define new_array(type, num) ((type *)_new_array(sizeof(type), (num)))
702 #define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num)))
704 /* use magic gcc attributes to catch format errors */
705 void rprintf(enum logcode , const char *, ...)
706 __attribute__((format (printf, 2, 3)))
709 /* This is just like rprintf, but it also tries to print some
710 * representation of the error code. Normally errcode = errno. */
711 void rsyserr(enum logcode, int, const char *, ...)
712 __attribute__((format (printf, 3, 4)))
715 #ifdef REPLACE_INET_NTOA
716 #define inet_ntoa rep_inet_ntoa
719 /* Make sure that the O_BINARY flag is defined. */
725 size_t strlcpy(char *d, const char *s, size_t bufsize);
729 size_t strlcat(char *d, const char *s, size_t bufsize);
733 #define WEXITSTATUS(stat) ((int)(((stat)>>8)&0xFF))
736 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
739 #define MY_UID() geteuid()
741 #define MY_UID() getuid()
745 #define MY_GID() getegid()
747 #define MY_GID() getgid()
752 #ifndef HAVE_INET_NTOP
754 inet_ntop(int af, const void *src, char *dst, size_t size);
755 #endif /* !HAVE_INET_NTOP */
757 #ifndef HAVE_INET_PTON
758 int inet_pton(int af, const char *src, void *dst);
761 #ifdef MAINTAINER_MODE
762 const char *get_panic_action(void);
765 #define UNUSED(x) x __attribute__((__unused__))
767 extern const char *io_write_phase, *io_read_phase;