Switched the checks for "long long" and "off64_t" to use the
[rsync/rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index 8592984..88a503f 100644 (file)
--- a/rsync.h
+++ b/rsync.h
 
 #define BLOCK_SIZE 700
 #define RSYNC_RSH_ENV "RSYNC_RSH"
+#define RSYNC_RSH_IO_ENV "RSYNC_RSH_IO"
 
 #define RSYNC_NAME "rsync"
-#define RSYNCD_SYSCONF "/etc/rsyncd.conf"
+/* RSYNCD_SYSCONF is now set in config.h */
 #define RSYNCD_USERCONF "rsyncd.conf"
 
 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
    incompatible with older versions :-( */
 #define CHAR_OFFSET 0
 
+/* These flags are only used during the flist transfer. */
 
-#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 XMIT_DEL_START (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_RDEV_MAJOR (1<<8)
+#define XMIT_HAS_IDEV_DATA (1<<9)
+#define XMIT_SAME_DEV (1<<10)
+#define XMIT_RDEV_MINOR_IS_SMALL (1<<11)
+
+/* These flags are used in the live flist data. */
+
+#define FLAG_DEL_START (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 26
+#define PROTOCOL_VERSION 29
 
 /* 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.
  *
- * There are two possible explanations for the limit at thirty: 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 15 and 30. */
-#define MIN_PROTOCOL_VERSION 15
-#define MAX_PROTOCOL_VERSION 30
+ * 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 20
+#define OLD_PROTOCOL_VERSION 25
+#define MAX_PROTOCOL_VERSION 40
 
 #define RSYNC_PORT 873
 
 #define CHUNK_SIZE (32*1024)
 #define MAX_MAP_SIZE (256*1024)
 #define IO_BUFFER_SIZE (4092)
+#define MAX_BLOCK_SIZE ((int32)1 << 29)
+
+#define IOERR_GENERAL  (1<<0) /* For backward compatibility, this must == 1 */
+#define IOERR_VANISHED (1<<1)
 
 #define MAX_ARGS 1000
 
+#define MAX_BASIS_DIRS 20
+
 #define MPLEX_BASE 7
 
-/* Log values.  I *think* what these mean is: FLOG goes to the server
- * logfile; FERROR and FINFO try to end up on the client, with
- * different levels of filtering. */
-enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
+#define NO_FILTERS     0
+#define SERVER_FILTERS 1
+#define ALL_FILTERS    2
+
+#define XFLG_FATAL_ERRORS      (1<<0)
+#define XFLG_DEF_INCLUDE       (1<<1)
+#define XFLG_DEF_EXCLUDE       (1<<2)
+#define XFLG_WORD_SPLIT        (1<<3)
+#define XFLG_DIRECTORY         (1<<4)
+#define XFLG_NO_PREFIXES       (1<<5)
+#define XFLG_ABS_PATH          (1<<6)
+
+#define PERMS_REPORT           (1<<0)
+#define PERMS_SKIP_MTIME       (1<<1)
+
+#define FULL_FLUSH     1
+#define NORMAL_FLUSH   0
+
+#define PDIR_CREATE    1
+#define PDIR_DELETE    0
+
+/* Note: 0x00 - 0x7F are used for basis_dir[] indexes! */
+#define FNAMECMP_BASIS_DIR_LOW 0x00 /* Must remain 0! */
+#define FNAMECMP_BASIS_DIR_HIGH 0x7F
+#define FNAMECMP_FNAME         0x80
+#define FNAMECMP_PARTIAL_DIR   0x81
+#define FNAMECMP_BACKUP        0x82
+
+/* For calling delete_file() */
+#define DEL_DIR                (1<<0)
+#define DEL_NO_RECURSE         (1<<1)
+#define DEL_FORCE_RECURSE      (1<<2) /* recurse even w/o --force */
+#define DEL_TERSE              (1<<3)
+
+
+/* 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_DONE=5,     /* current phase is done */
+       MSG_REDO=4,     /* reprocess indicated flist index */
+       MSG_ERROR=FERROR, MSG_INFO=FINFO, MSG_LOG=FLOG, /* remote logging */
+       MSG_DATA=0      /* raw data on the multiplexed stream */
+};
 
 #include "errcode.h"
 
 #include "config.h"
 
-/* The default RSYNC_RSH is always set in config.h, either to "remsh",
- * "rsh", or otherwise something specified by the user.  HAVE_REMSH
- * controls parameter munging for HP/UX, etc. */
+/* The default RSYNC_RSH is always set in config.h. */
 
 #include <sys/types.h>
 
@@ -106,6 +173,10 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #include <stdlib.h>
 #endif
 
+#if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
+#include <malloc.h>
+#endif
+
 #ifdef HAVE_SYS_SOCKET_H
 #include <sys/socket.h>
 #endif
@@ -114,10 +185,6 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #include <string.h>
 #endif
 
-#ifdef HAVE_MALLOC_H
-#include <malloc.h>
-#endif
-
 #ifdef TIME_WITH_SYS_TIME
 #include <sys/time.h>
 #include <time.h>
@@ -174,20 +241,10 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #endif
 #endif
 
-#ifdef HAVE_FNMATCH
-#include <fnmatch.h>
-#else
-#include "lib/fnmatch.h"
-#endif
-
 #ifdef HAVE_GLOB_H
 #include <glob.h>
 #endif
 
-#ifdef HAVE_MALLOC_H
-#  include <malloc.h>
-#endif
-
 /* these are needed for the uid/gid mapping code */
 #include <pwd.h>
 #include <grp.h>
@@ -214,12 +271,22 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 # endif
 #endif
 
+#if MAJOR_IN_MKDEV
+#include <sys/mkdev.h>
+# if !defined(makedev) && defined(mkdev)
+#  define makedev mkdev
+# endif
+#elif MAJOR_IN_SYSMACROS
+#include <sys/sysmacros.h>
+#endif
+
 #ifdef HAVE_COMPAT_H
 #include <compat.h>
 #endif
 
 #include <assert.h>
 
+#include "lib/pool_alloc.h"
 
 #define BOOL int
 
@@ -227,7 +294,7 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #define uchar unsigned char
 #endif
 
-#if HAVE_UNSIGNED_CHAR
+#if SIGNED_CHAR_OK
 #define schar signed char
 #else
 #define schar char
@@ -259,6 +326,12 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #define STRUCT_STAT struct stat
 #endif
 
+/* CAVEAT: on some systems, int64 will really be a 32-bit integer IFF
+ * that's the maximum size the file system can handle and there is no
+ * 64-bit type available.  The rsync source must therefore take steps
+ * to ensure that any code that really requires a 64-bit integer has
+ * it (e.g. the checksum code uses two 32-bit integers for its 64-bit
+ * counter). */
 #if HAVE_OFF64_T
 #define int64 off64_t
 #elif (SIZEOF_LONG == 8) 
@@ -270,7 +343,7 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #else
 /* As long as it gets... */
 #define int64 off_t
-#define NO_INT64
+#define INT64_IS_OFF_T
 #endif
 
 /* Starting from protocol version 26, we always use 64-bit
@@ -295,17 +368,14 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
  * 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.
+ * FIXME: I don't think the code in flist.c has ever worked on a system
+ * where dev_t is a struct.
  */ 
-#define INO64_T int64
-#define DEV64_T int64
+
+struct idev {
+       int64 inode;
+       int64 dev;
+};
 
 #ifndef MIN
 #define MIN(a,b) ((a)<(b)?(a):(b))
@@ -322,11 +392,17 @@ 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
@@ -335,73 +411,132 @@ enum logcode {FNONE=0, FERROR=1, FINFO=2, FLOG=3 };
 #define IN_LOOPBACKNET 127
 #endif
 
-struct file_struct {
-       unsigned flags;
-       time_t modtime;
-       OFF_T length;
-       mode_t mode;
+#define GID_NONE ((gid_t)-1)
 
-       INO64_T inode;
-       /** Device this file lives upon */
-       DEV64_T dev;
+#define HL_CHECK_MASTER        0
+#define HL_SKIP                1
 
-       /** If this is a device node, the device number. */
-       DEV64_T rdev;
-       uid_t uid;
-       gid_t gid;
+struct hlink {
+       struct file_struct *next;
+       int hlindex;
+};
+
+#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 {
+       union {
+               dev_t rdev;     /* The device number, if this is a device */
+               char *sum;      /* Only a normal file can have a checksum */
+               char *link;     /* Points to symlink string, if a symlink */
+       } u;
+       OFF_T length;
        char *basename;
        char *dirname;
        char *basedir;
-       char *link;
-       char *sum;
+       union {
+               struct idev *idev;
+               struct hlink *links;
+       } link_u;
+       time_t modtime;
+       uid_t uid;
+       gid_t gid;
+       mode_t mode;
+       uchar flags;    /* this item MUST remain last */
 };
 
+/*
+ * 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 ARENA_SIZE     (32 * 1024)
-
-struct string_area {
-       char *base;
-       char *end;
-       char *current;
-       struct string_area *next;
-};
+#define WITH_HLINK     1
+#define WITHOUT_HLINK  0
 
 struct file_list {
+       struct file_struct **files;
+       alloc_pool_t file_pool;
+       alloc_pool_t hlink_pool;
        int count;
        int malloced;
-       struct file_struct **files;
-       struct string_area *string_area;
 };
 
+#define SUMFLG_SAME_OFFSET     (1<<0)
+
 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 */
+       int32 len;              /**< length of chunk of file */
        uint32 sum1;            /**< simple checksum */
+       short flags;            /**< flag bits */
        char sum2[SUM_LENGTH];  /**< checksum  */
 };
 
 struct sum_struct {
        OFF_T flength;          /**< total file length */
-       size_t count;           /**< how many chunks */
-       size_t remainder;       /**< flength % block_length */
-       size_t n;               /**< block_length */
        struct sum_buf *sums;   /**< points to info for each chunk */
+       size_t count;           /**< how many chunks */
+       int32 blength;          /**< block_length */
+       int32 remainder;        /**< flength % block_length */
+       int s2length;           /**< sum2_length */
 };
 
 struct map_struct {
-       char *p;
-       int fd,p_size,p_len;
-       OFF_T file_size, p_offset, p_fd_offset;
+       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     */
+       char *p;                /* Window pointer                       */
+       int32 p_size;           /* Largest window size we allocated     */
+       int32 p_len;            /* Latest (rounded) window size         */
+       int32 def_window_size;  /* Default window size                  */
+       int fd;                 /* File Descriptor                      */
+       int status;             /* first errno from read errors         */
 };
 
-struct exclude_struct {
+#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 */
+#define MATCHFLG_INCLUDE       (1<<4) /* this is an include, not an exclude */
+#define MATCHFLG_DIRECTORY     (1<<5) /* this matches only directories */
+#define MATCHFLG_CLEAR_LIST    (1<<6) /* this item is the "!" token */
+#define MATCHFLG_WORD_SPLIT    (1<<7) /* split rules on whitespace */
+#define MATCHFLG_NO_INHERIT    (1<<8) /* don't inherit these rules */
+#define MATCHFLG_NO_PREFIXES   (1<<9) /* parse no prefixes from patterns */
+#define MATCHFLG_MERGE_FILE    (1<<10)/* specifies a file to merge */
+#define MATCHFLG_PERDIR_MERGE  (1<<11)/* merge-file is searched per-dir */
+#define MATCHFLG_EXCLUDE_SELF  (1<<12)/* merge-file name should be excluded */
+#define MATCHFLG_FINISH_SETUP  (1<<13)/* per-dir merge file needs setup */
+struct filter_struct {
+       struct filter_struct *next;
        char *pattern;
-       int regular_exp;
-       int fnmatch_flags;
-       int include;
-       int directory;
-       int local;
+       unsigned int match_flags;
+       union {
+               int slash_cnt;
+               struct filter_list_struct *mergelist;
+       } u;
+};
+
+struct filter_list_struct {
+       struct filter_struct *head;
+       struct filter_struct *tail;
+       char *debug_type;
 };
 
 struct stats {
@@ -411,9 +546,12 @@ struct stats {
        int64 total_read;
        int64 literal_data;
        int64 matched_data;
+       int64 flist_buildtime;
+       int64 flist_xfertime;
        int flist_size;
        int num_files;
        int num_transferred_files;
+       int current_file_index;
 };
 
 
@@ -428,6 +566,7 @@ static inline int flist_up(struct file_list *flist, int i)
 
 #include "byteorder.h"
 #include "lib/mdfour.h"
+#include "lib/wildmatch.h"
 #include "lib/permstring.h"
 #include "lib/addrinfo.h"
 
@@ -442,11 +581,13 @@ int asprintf(char **ptr, const char *format, ...);
 int vasprintf(char **ptr, const char *format, va_list ap);
 #endif
 
-#if !defined(HAVE_VSNPRINTF) && !defined(HAVE_C99_VSNPRINTF)
-int vsnprintf (char *str, size_t count, const char *fmt, va_list args);
+#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)
+#if !defined(HAVE_SNPRINTF) || !defined(HAVE_C99_VSNPRINTF)
+#define snprintf rsync_snprintf
 int snprintf(char *str,size_t count,const char *fmt,...);
 #endif
 
@@ -468,13 +609,6 @@ 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
-
 #define SIGNAL_CAST (RETSIGTYPE (*)())
 
 #ifndef EWOULDBLOCK
@@ -493,10 +627,24 @@ extern int errno;
 #define STDERR_FILENO 2
 #endif
 
+#ifndef S_IRUSR
+#define S_IRUSR 0400
+#endif
+
 #ifndef S_IWUSR
 #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
@@ -560,9 +708,6 @@ extern int errno;
 
 #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 */
@@ -579,6 +724,10 @@ extern int errno;
 
 #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 *, ...)
@@ -595,6 +744,10 @@ void rsyserr(enum logcode, int, const char *, ...)
 #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);
@@ -610,6 +763,17 @@ size_t strlcat(char *d, const char *s, size_t bufsize);
 
 #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;