X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/a039749b4c21e3439dc06fcdd5355828f1f95463..9935066b704bcf2e6e48dac85cb1b4047d8f439d:/rsync.h diff --git a/rsync.h b/rsync.h index 12dc2c89..37a5d531 100644 --- a/rsync.h +++ b/rsync.h @@ -1,6 +1,7 @@ /* Copyright (C) by Andrew Tridgell 1996, 2000 Copyright (C) Paul Mackerras 1996 + Copyright (C) 2001, 2002 by Martin Pool This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,14 +18,17 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ + #define False 0 #define True 1 #define BLOCK_SIZE 700 #define RSYNC_RSH_ENV "RSYNC_RSH" +#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO" #define RSYNC_NAME "rsync" -#define RSYNCD_CONF "/etc/rsyncd.conf" +#define RSYNCD_SYSCONF "/etc/rsyncd.conf" +#define RSYNCD_USERCONF "rsyncd.conf" #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock" #define URL_PREFIX "rsync://" @@ -35,21 +39,50 @@ incompatible with older versions :-( */ #define CHAR_OFFSET 0 +/* These flags are only used during the flist transfer. */ + +#define XMIT_TOP_DIR (1<<0) +#define XMIT_SAME_MODE (1<<1) +#define XMIT_EXTENDED_FLAGS (1<<2) +#define XMIT_SAME_RDEV_pre28 XMIT_EXTENDED_FLAGS /* Only in protocols < 28 */ +#define XMIT_SAME_UID (1<<3) +#define XMIT_SAME_GID (1<<4) +#define XMIT_SAME_NAME (1<<5) +#define XMIT_LONG_NAME (1<<6) +#define XMIT_SAME_TIME (1<<7) +#define XMIT_SAME_HIGH_RDEV (1<<8) +#define XMIT_HAS_IDEV_DATA (1<<9) +#define XMIT_SAME_DEV (1<<10) + +/* These flags are used in the live flist data. */ -#define FLAG_DELETE (1<<0) -#define SAME_MODE (1<<1) -#define SAME_RDEV (1<<2) -#define SAME_UID (1<<3) -#define SAME_GID (1<<4) -#define SAME_DIR (1<<5) -#define SAME_NAME SAME_DIR -#define LONG_NAME (1<<6) -#define SAME_TIME (1<<7) +#define FLAG_TOP_DIR (1<<0) +#define FLAG_HLINK_EOL (1<<1) /* generator only */ +#define FLAG_MOUNT_POINT (1<<2) /* sender only */ /* update this if you make incompatible changes */ -#define PROTOCOL_VERSION 24 -#define MIN_PROTOCOL_VERSION 15 -#define MAX_PROTOCOL_VERSION 30 +#define PROTOCOL_VERSION 28 + +/* We refuse to interoperate with versions that are not in this range. + * Note that we assume we'll work with later versions: the onus is on + * people writing them to make sure that they don't send us anything + * we won't understand. + * + * Interoperation with old but supported protocol versions + * should cause a warning to be printed. At a future date + * the old protocol will become the minimum and + * compatibility code removed. + * + * There are two possible explanations for the limit at + * MAX_PROTOCOL_VERSION: either to allow new major-rev versions that + * do not interoperate with us, and (more likely) so that we can + * detect an attempt to connect rsync to a non-rsync server, which is + * unlikely to begin by sending a byte between MIN_PROTOCL_VERSION and + * MAX_PROTOCOL_VERSION. */ + +#define MIN_PROTOCOL_VERSION 19 +#define OLD_PROTOCOL_VERSION 20 +#define MAX_PROTOCOL_VERSION 40 #define RSYNC_PORT 873 @@ -59,30 +92,48 @@ #define MAX_MAP_SIZE (256*1024) #define IO_BUFFER_SIZE (4092) +#define IOERR_GENERAL (1<<0) /* For backward compatibility, this must == 1 */ +#define IOERR_VANISHED (1<<1) + #define MAX_ARGS 1000 #define MPLEX_BASE 7 -enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; +#define NO_EXCLUDES 0 +#define SERVER_EXCLUDES 1 +#define ALL_EXCLUDES 2 + +#define MISSING_OK 0 +#define MISSING_FATAL 1 + +#define ADD_INCLUDE 1 +#define ADD_EXCLUDE 0 + +#define FULL_FLUSH 1 +#define NORMAL_FLUSH 0 + + +/* Log-message categories. FLOG is only used on the daemon side to + * output messages to the log file. */ +enum logcode { FERROR=1, FINFO=2, FLOG=3 }; + +/* Messages types that are sent over the message channel. The logcode + * values must all be present here with identical numbers. */ +enum msgcode { + MSG_DATA=0, /* raw data on the multiplexed stream */ + MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */ + MSG_REDO=4, /* reprocess indicated flist index */ + MSG_DONE=5, /* current phase is done */ +}; #include "errcode.h" #include "config.h" -#if HAVE_REMSH -#define RSYNC_RSH "remsh" -#else -#define RSYNC_RSH "rsh" -#endif +/* The default RSYNC_RSH is always set in config.h. */ #include -#ifdef HAVE_GETOPT_LONG -#include -#else -#include "lib/getopt.h" -#endif - #ifdef HAVE_UNISTD_H #include #endif @@ -97,6 +148,10 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; #include #endif +#if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H)) +#include +#endif + #ifdef HAVE_SYS_SOCKET_H #include #endif @@ -105,10 +160,6 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; #include #endif -#ifdef HAVE_MALLOC_H -#include -#endif - #ifdef TIME_WITH_SYS_TIME #include #include @@ -165,12 +216,6 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; #endif #endif -#ifdef HAVE_FNMATCH -#include -#else -#include "lib/fnmatch.h" -#endif - #ifdef HAVE_GLOB_H #include #endif @@ -205,6 +250,9 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; #include #endif +#include + +#include "lib/pool_alloc.h" #define BOOL int @@ -253,15 +301,55 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; #elif HAVE_LONGLONG #define int64 long long #else +/* As long as it gets... */ #define int64 off_t #define NO_INT64 #endif -#if HAVE_SHORT_INO_T -#define INO_T uint32 +#if (SIZEOF_LONG == 8) +#define uint64 unsigned long +#elif (SIZEOF_INT == 8) +#define uint64 unsigned int +#elif HAVE_LONGLONG +#define uint64 unsigned long long #else -#define INO_T ino_t -#endif +/* As long as it gets... */ +#define uint64 unsigned off_t +#endif + +/* Starting from protocol version 26, we always use 64-bit + * ino_t and dev_t internally, even if this platform does not + * allow files to have 64-bit inums. That's because the + * receiver needs to find duplicate (dev,ino) tuples to detect + * hardlinks, and it might have files coming from a platform + * that has 64-bit inums. + * + * The only exception is if we're on a platform with no 64-bit type at + * all. + * + * Because we use read_longint() to get these off the wire, if you + * transfer devices or hardlinks with dev or inum > 2**32 to a machine + * with no 64-bit types then you will get an overflow error. Probably + * not many people have that combination of machines, and you can + * avoid it by not preserving hardlinks or not transferring device + * nodes. It's not clear that any other behaviour is better. + * + * Note that if you transfer devices from a 64-bit-devt machine (say, + * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the + * device numbers will be truncated. But it's a kind of silly thing + * to do anyhow. + * + * FIXME: In future, we should probable split the device number into + * major/minor, and transfer the two parts as 32-bit ints. That gives + * you somewhat more of a chance that they'll come from a big machine + * to a little one in a useful way. + * + * FIXME: Really we need an unsigned type, and we perhaps ought to + * cope with platforms on which this is an unsigned int or even a + * struct. Later. + */ +#define INO64_T uint64 +#define DEV64_T uint64 #ifndef MIN #define MIN(a,b) ((a)<(b)?(a):(b)) @@ -278,78 +366,138 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 }; /* the length of the md4 checksum */ #define MD4_SUM_LENGTH 16 #define SUM_LENGTH 16 +#define SHORT_SUM_LENGTH 2 +#define BLOCKSUM_BIAS 10 #ifndef MAXPATHLEN #define MAXPATHLEN 1024 #endif +#ifndef NAME_MAX +#define NAME_MAX 255 +#endif + #ifndef INADDR_NONE #define INADDR_NONE 0xffffffff #endif +#ifndef IN_LOOPBACKNET +#define IN_LOOPBACKNET 127 +#endif + +#define GID_NONE (gid_t) -1 + +#define HL_CHECK_MASTER 0 +#define HL_SKIP 1 + +struct hlink { + int hlindex; + struct file_struct *next; +}; + +struct idev { + INO64_T inode; + DEV64_T dev; +}; + +#define F_DEV link_u.idev->dev +#define F_INODE link_u.idev->inode + +#define F_HLINDEX link_u.links->hlindex +#define F_NEXT link_u.links->next + struct file_struct { - unsigned flags; time_t modtime; OFF_T length; mode_t mode; - INO_T inode; - dev_t dev; - dev_t rdev; - uid_t uid; - gid_t gid; + union { + DEV64_T rdev; /* The device number, if this is a device */ + char *sum; /* Only a normal file can have a checksum */ + char *link; /* Holds symlink string, if a symlink */ + } u; + union { + struct idev *idev; + struct hlink *links; + } link_u; char *basename; char *dirname; char *basedir; - char *link; - char *sum; + uid_t uid; + gid_t gid; + uchar flags; /* this item MUST remain last */ }; - -#define ARENA_SIZE (32 * 1024) - -struct string_area { - char *base; - char *end; - char *current; - struct string_area *next; -}; +/* + * Start the flist array at FLIST_START entries and grow it + * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR + */ +#define FLIST_START (32 * 1024) +#define FLIST_LINEAR (FLIST_START * 512) +/* + * Extent size for allocation pools A minimum size of 128KB + * is needed to mmap them so that freeing will release the + * space to the OS. + * + * Larger sizes reduce leftover fragments and speed free calls + * (when they happen) Smaller sizes increase the chance of + * freed allocations freeing whole extents. + */ + +#define FILE_EXTENT (256 * 1024) +#define HLINK_EXTENT (128 * 1024) + +#define WITH_HLINK 1 +#define WITHOUT_HLINK 0 struct file_list { int count; int malloced; + alloc_pool_t file_pool; + alloc_pool_t hlink_pool; struct file_struct **files; - struct string_area *string_area; }; struct sum_buf { - OFF_T offset; /* offset in file of this chunk */ - int len; /* length of chunk of file */ - int i; /* index of this chunk */ - uint32 sum1; /* simple checksum */ - char sum2[SUM_LENGTH]; /* checksum */ + OFF_T offset; /**< offset in file of this chunk */ + unsigned int len; /**< length of chunk of file */ + int i; /**< index of this chunk */ + uint32 sum1; /**< simple checksum */ + char sum2[SUM_LENGTH]; /**< checksum */ }; struct sum_struct { - OFF_T flength; /* total file length */ - int count; /* how many chunks */ - int remainder; /* flength % block_length */ - int n; /* block_length */ - struct sum_buf *sums; /* points to info for each chunk */ + OFF_T flength; /**< total file length */ + size_t count; /**< how many chunks */ + unsigned int blength; /**< block_length */ + unsigned int remainder; /**< flength % block_length */ + int s2length; /**< sum2_length */ + struct sum_buf *sums; /**< points to info for each chunk */ }; struct map_struct { - char *p; - int fd,p_size,p_len; - OFF_T file_size, p_offset, p_fd_offset; + char *p; /* Window pointer */ + int fd; /* File Descriptor */ + int p_size; /* Window size at allocation */ + int p_len; /* Window size after fill */ + /* p_size and p_len could be + * consolodated by using a local + * variable in map_ptr() */ + int status; /* first errno from read errors */ + OFF_T file_size; /* File size (from stat) */ + OFF_T p_offset; /* Window start */ + OFF_T p_fd_offset; /* offset of cursor in fd ala lseek */ }; +#define MATCHFLG_WILD (1<<0) /* pattern has '*', '[', and/or '?' */ +#define MATCHFLG_WILD2 (1<<1) /* pattern has '**' */ +#define MATCHFLG_WILD2_PREFIX (1<<2) /* pattern starts with '**' */ +#define MATCHFLG_ABS_PATH (1<<3) /* path-match on absolute path */ struct exclude_struct { char *pattern; - int regular_exp; - int fnmatch_flags; + int match_flags; int include; int directory; - int local; + int slash_cnt; }; struct stats { @@ -362,6 +510,7 @@ struct stats { int flist_size; int num_files; int num_transferred_files; + int current_file_index; }; @@ -375,9 +524,32 @@ static inline int flist_up(struct file_list *flist, int i) } #include "byteorder.h" -#include "version.h" -#include "proto.h" #include "lib/mdfour.h" +#include "lib/wildmatch.h" +#include "lib/permstring.h" +#include "lib/addrinfo.h" + +#include "proto.h" + +/* We have replacement versions of these if they're missing. */ +#ifndef HAVE_ASPRINTF +int asprintf(char **ptr, const char *format, ...); +#endif + +#ifndef HAVE_VASPRINTF +int vasprintf(char **ptr, const char *format, va_list ap); +#endif + +#if !defined(HAVE_VSNPRINTF) || !defined(HAVE_C99_VSNPRINTF) +#define vsnprintf rsync_vsnprintf +int vsnprintf(char *str, size_t count, const char *fmt, va_list args); +#endif + +#if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF) +#define snprintf rsync_snprintf +int snprintf(char *str,size_t count,const char *fmt,...); +#endif + #if !HAVE_STRERROR extern char *sys_errlist[]; @@ -396,6 +568,9 @@ extern int errno; #define SUPPORT_LINKS HAVE_READLINK #define SUPPORT_HARD_LINKS HAVE_LINK +/* This could be bad on systems which have no lchown and where chown + * follows symbollic links. On such systems it might be better not to + * try to chown symlinks at all. */ #ifndef HAVE_LCHOWN #define lchown chown #endif @@ -422,6 +597,16 @@ extern int errno; #define S_IWUSR 0200 #endif +#ifndef ACCESSPERMS +#define ACCESSPERMS 0777 +#endif + +#ifndef S_ISVTX +#define S_ISVTX 0 +#endif + +#define CHMOD_BITS (S_ISUID | S_ISGID | S_ISVTX | ACCESSPERMS) + #ifndef _S_IFMT #define _S_IFMT 0170000 #endif @@ -475,12 +660,16 @@ extern int errno; # define NONBLOCK_FLAG FNDELAY #endif +#ifndef INADDR_LOOPBACK +#define INADDR_LOOPBACK 0x7f000001 +#endif + +#ifndef INADDR_NONE +#define INADDR_NONE 0xffffffff +#endif #define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode)) -#ifndef ACCESSPERMS -#define ACCESSPERMS 0777 -#endif /* Initial mask on permissions given to temporary files. Mask off setuid bits and group access because of potential race-condition security holes, and mask other access because mode 707 is bizarre */ @@ -489,25 +678,38 @@ extern int errno; /* handler for null strings in printf format */ #define NS(s) ((s)?(s):"") +#if !defined(__GNUC__) || defined(APPLE) +/* Apparently the OS X port of gcc gags on __attribute__. + * + * */ +#define __attribute__(x) + +#endif + +/* Convenient wrappers for malloc and realloc. Use them. */ +#define new(type) ((type *)malloc(sizeof(type))) +#define new_array(type, num) ((type *)_new_array(sizeof(type), (num))) +#define realloc_array(ptr, type, num) ((type *)_realloc_array((ptr), sizeof(type), (num))) + /* use magic gcc attributes to catch format errors */ void rprintf(enum logcode , const char *, ...) -#ifdef __GNUC__ - __attribute__ ((format (printf, 2, 3))) -#endif + __attribute__((format (printf, 2, 3))) ; /* This is just like rprintf, but it also tries to print some * representation of the error code. Normally errcode = errno. */ void rsyserr(enum logcode, int, const char *, ...) -#ifdef __GNUC__ - __attribute__ ((format (printf, 3, 4))) -#endif + __attribute__((format (printf, 3, 4))) ; #ifdef REPLACE_INET_NTOA #define inet_ntoa rep_inet_ntoa #endif +/* Make sure that the O_BINARY flag is defined. */ +#ifndef O_BINARY +#define O_BINARY 0 +#endif #ifndef HAVE_STRLCPY size_t strlcpy(char *d, const char *s, size_t bufsize); @@ -522,3 +724,34 @@ size_t strlcat(char *d, const char *s, size_t bufsize); #endif #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__) + +#ifdef HAVE_GETEUID +#define MY_UID() geteuid() +#else +#define MY_UID() getuid() +#endif + +#ifdef HAVE_GETEGID +#define MY_GID() getegid() +#else +#define MY_GID() getgid() +#endif + +extern int verbose; + +#ifndef HAVE_INET_NTOP +const char * +inet_ntop(int af, const void *src, char *dst, size_t size); +#endif /* !HAVE_INET_NTOP */ + +#ifndef HAVE_INET_PTON +int inet_pton(int af, const char *src, void *dst); +#endif + +#ifdef MAINTAINER_MODE +const char *get_panic_action(void); +#endif + +#define UNUSED(x) x __attribute__((__unused__)) + +extern const char *io_write_phase, *io_read_phase;