Fixed the --compare-dest docs.
[rsync/rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index 9ca7d35..49bff0b 100644 (file)
--- a/rsync.h
+++ b/rsync.h
@@ -1,18 +1,18 @@
-/* 
+/*
    Copyright (C) by Andrew Tridgell 1996, 2000
    Copyright (C) Paul Mackerras 1996
    Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
-   
+
    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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
-   
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-   
+
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
@@ -41,7 +41,7 @@
 
 /* These flags are only used during the flist transfer. */
 
-#define XMIT_DEL_START (1<<0)
+#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 */
 
 /* These flags are used in the live flist data. */
 
-#define FLAG_DEL_START (1<<0)
+#define FLAG_TOP_DIR (1<<0)
 #define FLAG_HLINK_EOL (1<<1)  /* generator only */
 #define FLAG_MOUNT_POINT (1<<2)        /* sender only */
+#define FLAG_NO_FUZZY (1<<2)   /* generator only */
+#define FLAG_DEL_HERE (1<<3)   /* receiver/generator */
+#define FLAG_SENT (1<<3)       /* sender only */
 
 /* update this if you make incompatible changes */
 #define PROTOCOL_VERSION 29
 #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 XFLG_OLD_PREFIXES      (1<<1)
+#define XFLG_ANCHORED2ABS      (1<<2)
 
 #define PERMS_REPORT           (1<<0)
 #define PERMS_SKIP_MTIME       (1<<1)
 #define FNAMECMP_FNAME         0x80
 #define FNAMECMP_PARTIAL_DIR   0x81
 #define FNAMECMP_BACKUP        0x82
+#define FNAMECMP_FUZZY         0x83
 
 /* 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)
 
+/* For use by the itemize_changes code */
+#define ITEM_UPDATING (1<<0)
+#define ITEM_REPORT_CHECKSUM (1<<1)
+#define ITEM_REPORT_SIZE (1<<2)
+#define ITEM_REPORT_TIME (1<<3)
+#define ITEM_REPORT_PERMS (1<<4)
+#define ITEM_REPORT_OWNER (1<<5)
+#define ITEM_REPORT_GROUP (1<<6)
+#define ITEM_IS_NEW (1<<7)
+#define ITEM_USING_ALT_BASIS (1<<8)
+
+#define ITEM_MISSING_DATA (1<<16) /* these are outside the transmitted flags */
+#define ITEM_DELETED (1<<17)
 
-/* 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 };
+/* Log-message categories.  FLOG and FCLIENT are only used on the daemon
+ * side for custom logging -- they don't get sent over the socket. */
+enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4 };
 
 /* 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 */
+       MSG_DATA=0,     /* raw data on the multiplexed stream */
+       MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
+       MSG_LOG=FLOG, MSG_FCLIENT=FCLIENT, /* sibling logging */
+       MSG_REDO=9,     /* reprocess indicated flist index */
+       MSG_SUCCESS=100,/* successfully updated indicated flist index */
+       MSG_DELETED=101,/* successfully deleted a file on receiving side */
+       MSG_DONE=86     /* current phase is done */
 };
 
 #include "errcode.h"
@@ -157,23 +172,39 @@ enum msgcode {
 
 /* The default RSYNC_RSH is always set in config.h. */
 
-#include <sys/types.h>
-
+#include <stdio.h>
+#ifdef HAVE_SYS_TYPES_H
+# include <sys/types.h>
+#endif
+#ifdef HAVE_SYS_STAT_H
+# include <sys/stat.h>
+#endif
+#ifdef STDC_HEADERS
+# include <stdlib.h>
+# include <stddef.h>
+#else
+# ifdef HAVE_STDLIB_H
+#  include <stdlib.h>
+# endif
+#endif
+#ifdef HAVE_STRING_H
+# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
+#  include <memory.h>
+# endif
+# include <string.h>
+#endif
+#ifdef HAVE_STRINGS_H
+# include <strings.h>
+#endif
 #ifdef HAVE_UNISTD_H
-#include <unistd.h>
+# include <unistd.h>
 #endif
-#include <stdio.h>
-#include <stddef.h>
 
 #ifdef HAVE_SYS_PARAM_H
 #include <sys/param.h>
 #endif
 
-#ifdef HAVE_STDLIB_H
-#include <stdlib.h>
-#endif
-
-#if defined(HAVE_MALLOC_H) && (defined(HAVE_MALLINFO) || !defined(HAVE_STDLIB_H))
+#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
 #include <malloc.h>
 #endif
 
@@ -181,10 +212,6 @@ enum msgcode {
 #include <sys/socket.h>
 #endif
 
-#ifdef HAVE_STRING_H
-#include <string.h>
-#endif
-
 #ifdef TIME_WITH_SYS_TIME
 #include <sys/time.h>
 #include <time.h>
@@ -204,8 +231,6 @@ enum msgcode {
 #endif
 #endif
 
-#include <sys/stat.h>
-
 #ifdef HAVE_SYS_IOCTL_H
 #include <sys/ioctl.h>
 #endif
@@ -256,27 +281,27 @@ enum msgcode {
 #include <syslog.h>
 #include <sys/file.h>
 
-#if HAVE_DIRENT_H
+#ifdef HAVE_DIRENT_H
 # include <dirent.h>
 #else
 # define dirent direct
-# if HAVE_SYS_NDIR_H
+# ifdef HAVE_SYS_NDIR_H
 #  include <sys/ndir.h>
 # endif
-# if HAVE_SYS_DIR_H
+# ifdef HAVE_SYS_DIR_H
 #  include <sys/dir.h>
 # endif
-# if HAVE_NDIR_H
+# ifdef HAVE_NDIR_H
 #  include <ndir.h>
 # endif
 #endif
 
-#if MAJOR_IN_MKDEV
+#ifdef MAJOR_IN_MKDEV
 #include <sys/mkdev.h>
-# if !defined(makedev) && defined(mkdev)
+# if !defined makedev && (defined mkdev || defined _WIN32 || defined __WIN32__)
 #  define makedev mkdev
 # endif
-#elif MAJOR_IN_SYSMACROS
+#elif defined MAJOR_IN_SYSMACROS
 #include <sys/sysmacros.h>
 #endif
 
@@ -294,50 +319,85 @@ enum msgcode {
 #define uchar unsigned char
 #endif
 
-#if HAVE_UNSIGNED_CHAR
+#ifdef SIGNED_CHAR_OK
 #define schar signed char
 #else
 #define schar char
 #endif
 
+/* Find a variable that is either exactly 32-bits or longer.
+ * If some code depends on 32-bit truncation, it will need to
+ * take special action in a "#if SIZEOF_INT32 > 4" section. */
 #ifndef int32
-#if (SIZEOF_INT == 4)
-#define int32 int
-#elif (SIZEOF_LONG == 4)
-#define int32 long
-#elif (SIZEOF_SHORT == 4)
-#define int32 short
+#if SIZEOF_INT == 4
+# define int32 int
+# define SIZEOF_INT32 4
+#elif SIZEOF_LONG == 4
+# define int32 long
+# define SIZEOF_INT32 4
+#elif SIZEOF_SHORT == 4
+# define int32 short
+# define SIZEOF_INT32 4
+#elif SIZEOF_INT > 4
+# define int32 int
+# define SIZEOF_INT32 SIZEOF_INT
+#elif SIZEOF_LONG > 4
+# define int32 long
+# define SIZEOF_INT32 SIZEOF_LONG
 #else
-/* I hope this works */
-#define int32 int
-#define LARGE_INT32
+# error Could not find a 32-bit integer variable
 #endif
+#else
+# define SIZEOF_INT32 4
 #endif
 
 #ifndef uint32
 #define uint32 unsigned int32
 #endif
 
-#if HAVE_OFF64_T
-#define OFF_T off64_t
-#define STRUCT_STAT struct stat64
-#else
+#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
 #define OFF_T off_t
 #define STRUCT_STAT struct stat
-#endif
-
-#if HAVE_OFF64_T
-#define int64 off64_t
-#elif (SIZEOF_LONG == 8) 
-#define int64 long
-#elif (SIZEOF_INT == 8) 
-#define int64 int
-#elif HAVE_LONGLONG
-#define int64 long long
+#else
+#define OFF_T off64_t
+#define STRUCT_STAT struct stat64
+#define USE_STAT64_FUNCS 1
+#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 SIZEOF_OFF64_T == 8
+# define int64 off64_t
+# define SIZEOF_INT64 8
+#elif SIZEOF_LONG == 8
+# define int64 long
+# define SIZEOF_INT64 8
+#elif SIZEOF_INT == 8
+# define int64 int
+# define SIZEOF_INT64 8
+#elif SIZEOF_LONG_LONG == 8
+# define int64 long long
+# define SIZEOF_INT64 8
+#elif SIZEOF_OFF_T == 8
+# define int64 off_t
+# define SIZEOF_INT64 8
+#elif SIZEOF_INT > 8
+# define int64 int
+# define SIZEOF_INT64 SIZEOF_INT
+#elif SIZEOF_LONG > 8
+# define int64 long
+# define SIZEOF_INT64 SIZEOF_LONG
+#elif SIZEOF_LONG_LONG > 8
+# define int64 long long
+# define SIZEOF_INT64 SIZEOF_LONG_LONG
 #else
 /* As long as it gets... */
-#define int64 off_t
-#define INT64_IS_OFF_T
+# define int64 off_t
+# define SIZEOF_INT64 SIZEOF_OFF_T
 #endif
 
 /* Starting from protocol version 26, we always use 64-bit
@@ -364,7 +424,7 @@ enum msgcode {
  *
  * FIXME: I don't think the code in flist.c has ever worked on a system
  * where dev_t is a struct.
- */ 
+ */
 
 struct idev {
        int64 inode;
@@ -428,9 +488,12 @@ struct file_struct {
                char *link;     /* Points to symlink string, if a symlink */
        } u;
        OFF_T length;
-       char *basename;
-       char *dirname;
-       char *basedir;
+       char *basename;         /* The current item's name (AKA filename) */
+       char *dirname;          /* The directory info inside the transfer */
+       union {
+               char *root;     /* Sender-side dir info outside transfer */
+               int depth;      /* Receiver-side directory depth info */
+       } dir;
        union {
                struct idev *idev;
                struct hlink *links;
@@ -470,6 +533,7 @@ struct file_list {
        alloc_pool_t hlink_pool;
        int count;
        int malloced;
+       int low, high;
 };
 
 #define SUMFLG_SAME_OFFSET     (1<<0)
@@ -485,7 +549,7 @@ struct sum_buf {
 struct sum_struct {
        OFF_T flength;          /**< total file length */
        struct sum_buf *sums;   /**< points to info for each chunk */
-       size_t count;           /**< how many chunks */
+       int32 count;            /**< how many chunks */
        int32 blength;          /**< block_length */
        int32 remainder;        /**< flength % block_length */
        int s2length;           /**< sum2_length */
@@ -517,10 +581,19 @@ struct map_struct {
 #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 */
+#define MATCHFLG_NEGATE        (1<<14)/* rule matches when pattern does not */
+#define MATCHFLG_CVS_IGNORE    (1<<15)/* rule was -C or :C */
+#define MATCHFLG_SENDER_SIDE   (1<<16)/* rule applies to the sending side */
+#define MATCHFLG_RECEIVER_SIDE (1<<17)/* rule applies to the receiving side */
+
+#define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
+                               | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
+                               | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE)
+
 struct filter_struct {
        struct filter_struct *next;
        char *pattern;
-       unsigned int match_flags;
+       uint32 match_flags;
        union {
                int slash_cnt;
                struct filter_list_struct *mergelist;
@@ -540,6 +613,8 @@ 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;
@@ -547,15 +622,6 @@ struct stats {
 };
 
 
-/* we need this function because of the silly way in which duplicate
-   entries are handled in the file lists - we can't change this
-   without breaking existing versions */
-static inline int flist_up(struct file_list *flist, int i)
-{
-       while (!flist->files[i]->basename) i++;
-       return i;
-}
-
 #include "byteorder.h"
 #include "lib/mdfour.h"
 #include "lib/wildmatch.h"
@@ -573,18 +639,18 @@ 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)
+#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
 
 
-#if !HAVE_STRERROR
+#ifndef HAVE_STRERROR
 extern char *sys_errlist[];
 #define strerror(i) sys_errlist[i]
 #endif
@@ -684,9 +750,9 @@ extern int errno;
 /* work out what fcntl flag to use for non-blocking */
 #ifdef O_NONBLOCK
 # define NONBLOCK_FLAG O_NONBLOCK
-#elif defined(SYSV)
+#elif defined SYSV
 # define NONBLOCK_FLAG O_NDELAY
-#else 
+#else
 # define NONBLOCK_FLAG FNDELAY
 #endif
 
@@ -706,13 +772,13 @@ extern int errno;
 #define INITACCESSPERMS 0700
 
 /* handler for null strings in printf format */
-#define NS(s) ((s)?(s):"<NULL>")
+#define NS(s) ((s)?safe_fname(s):"<NULL>")
 
-#if !defined(__GNUC__) || defined(APPLE)
+#if !defined __GNUC__ || defined __APPLE__
 /* Apparently the OS X port of gcc gags on __attribute__.
  *
  * <http://www.opensource.apple.com/bugs/X/gcc/2512150.html> */
-#define __attribute__(x) 
+#define __attribute__(x)
 
 #endif
 
@@ -770,9 +836,8 @@ size_t strlcat(char *d, const char *s, size_t bufsize);
 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 */
+const char *inet_ntop(int af, const void *src, char *dst, size_t size);
+#endif
 
 #ifndef HAVE_INET_PTON
 int inet_pton(int af, const char *src, void *dst);