Updated the FSF's address to an even newer one.
[rsync/rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index 50a8a20..3e5217c 100644 (file)
--- a/rsync.h
+++ b/rsync.h
@@ -1,23 +1,23 @@
 /*
-   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.
-*/
-
+ * Copyright (C) 1996, 2000 Andrew Tridgell
+ * Copyright (C) 1996 Paul Mackerras
* Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
+ *
* 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.,
+ * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
 
 #define False 0
 #define True 1
 /* These flags are used in the live flist data. */
 
 #define FLAG_TOP_DIR (1<<0)
-#define FLAG_HLINK_EOL (1<<1)  /* generator only */
-#define FLAG_MOUNT_POINT (1<<2)        /* sender only */
+#define FLAG_SENT (1<<1)       /* sender */
+#define FLAG_HLINK_EOL (1<<1)  /* receiver/generator */
+#define FLAG_MOUNT_POINT (1<<2)        /* sender/generator */
 #define FLAG_DEL_HERE (1<<3)   /* receiver/generator */
+#define FLAG_HLINK_TOL (1<<4)  /* receiver/generator */
+#define FLAG_NO_FUZZY (1<<5)   /* generator */
 
 /* update this if you make incompatible changes */
 #define PROTOCOL_VERSION 29
 
 #define IOERR_GENERAL  (1<<0) /* For backward compatibility, this must == 1 */
 #define IOERR_VANISHED (1<<1)
+#define IOERR_DEL_LIMIT (1<<2)
 
 #define MAX_ARGS 1000
-
 #define MAX_BASIS_DIRS 20
+#define MAX_SERVER_ARGS (MAX_BASIS_DIRS*2 + 100)
 
 #define MPLEX_BASE 7
 
 #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_ANCHORED2ABS      (1<<6)
+#define XFLG_OLD_PREFIXES      (1<<1)
+#define XFLG_ANCHORED2ABS      (1<<2)
+#define XFLG_ABS_IF_SLASH      (1<<3)
 
-#define PERMS_REPORT           (1<<0)
-#define PERMS_SKIP_MTIME       (1<<1)
+#define ATTRS_REPORT           (1<<0)
+#define ATTRS_SKIP_MTIME       (1<<1)
 
 #define FULL_FLUSH     1
 #define NORMAL_FLUSH   0
 #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 };
+#define FNAMECMP_FUZZY         0x83
+
+/* For use by the itemize_changes code */
+#define ITEM_REPORT_ATIME (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_REPORT_ACL (1<<7)
+#define ITEM_REPORT_XATTR (1<<8)
+#define ITEM_BASIS_TYPE_FOLLOWS (1<<11)
+#define ITEM_XNAME_FOLLOWS (1<<12)
+#define ITEM_IS_NEW (1<<13)
+#define ITEM_LOCAL_CHANGE (1<<14)
+#define ITEM_TRANSFER (1<<15)
+/* These are outside the range of the transmitted flags. */
+#define ITEM_MISSING_DATA (1<<16)         /* used by log_formatted() */
+#define ITEM_DELETED (1<<17)              /* used by log_formatted() */
+
+#define SIGNIFICANT_ITEM_FLAGS (~(\
+       ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
+
+
+/* Log-message categories.  Only FERROR and FINFO get sent over the socket.
+ * FLOG and FCLIENT are only used on the daemon side for custom logging,
+ * while FNAME is only used on the client side. */
+enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FNAME=5, FSOCKERR=6 };
 
 /* 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_SOCKERR=FSOCKERR, /* 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"
@@ -159,100 +181,100 @@ enum msgcode {
 /* The default RSYNC_RSH is always set in config.h. */
 
 #include <stdio.h>
-#if HAVE_SYS_TYPES_H
+#ifdef HAVE_SYS_TYPES_H
 # include <sys/types.h>
 #endif
-#if HAVE_SYS_STAT_H
+#ifdef HAVE_SYS_STAT_H
 # include <sys/stat.h>
 #endif
-#if STDC_HEADERS
+#ifdef STDC_HEADERS
 # include <stdlib.h>
 # include <stddef.h>
 #else
-# if HAVE_STDLIB_H
+# ifdef HAVE_STDLIB_H
 #  include <stdlib.h>
 # endif
 #endif
-#if HAVE_STRING_H
-# if !STDC_HEADERS && HAVE_MEMORY_H
+#ifdef HAVE_STRING_H
+# if !defined STDC_HEADERS && defined HAVE_MEMORY_H
 #  include <memory.h>
 # endif
 # include <string.h>
 #endif
-#if HAVE_STRINGS_H
+#ifdef HAVE_STRINGS_H
 # include <strings.h>
 #endif
-#if HAVE_UNISTD_H
+#ifdef HAVE_UNISTD_H
 # include <unistd.h>
 #endif
 
-#if HAVE_SYS_PARAM_H
+#ifdef HAVE_SYS_PARAM_H
 #include <sys/param.h>
 #endif
 
-#if HAVE_MALLOC_H && (HAVE_MALLINFO || !HAVE_STDLIB_H)
+#if defined HAVE_MALLOC_H && (defined HAVE_MALLINFO || !defined HAVE_STDLIB_H)
 #include <malloc.h>
 #endif
 
-#if HAVE_SYS_SOCKET_H
+#ifdef HAVE_SYS_SOCKET_H
 #include <sys/socket.h>
 #endif
 
-#if TIME_WITH_SYS_TIME
+#ifdef TIME_WITH_SYS_TIME
 #include <sys/time.h>
 #include <time.h>
 #else
-#if HAVE_SYS_TIME_H
+#ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>
 #else
 #include <time.h>
 #endif
 #endif
 
-#if HAVE_FCNTL_H
+#ifdef HAVE_FCNTL_H
 #include <fcntl.h>
 #else
-#if HAVE_SYS_FCNTL_H
+#ifdef HAVE_SYS_FCNTL_H
 #include <sys/fcntl.h>
 #endif
 #endif
 
-#if HAVE_SYS_IOCTL_H
+#ifdef HAVE_SYS_IOCTL_H
 #include <sys/ioctl.h>
 #endif
 
-#if HAVE_SYS_FILIO_H
+#ifdef HAVE_SYS_FILIO_H
 #include <sys/filio.h>
 #endif
 
 #include <signal.h>
-#if HAVE_SYS_WAIT_H
+#ifdef HAVE_SYS_WAIT_H
 #include <sys/wait.h>
 #endif
-#if HAVE_CTYPE_H
+#ifdef HAVE_CTYPE_H
 #include <ctype.h>
 #endif
-#if HAVE_GRP_H
+#ifdef HAVE_GRP_H
 #include <grp.h>
 #endif
 #include <errno.h>
 
-#if HAVE_UTIME_H
+#ifdef HAVE_UTIME_H
 #include <utime.h>
 #endif
 
-#if HAVE_SYS_SELECT_H
+#ifdef HAVE_SYS_SELECT_H
 #include <sys/select.h>
 #endif
 
-#if HAVE_SYS_MODE_H
+#ifdef HAVE_SYS_MODE_H
 /* apparently AIX needs this for S_ISLNK */
 #ifndef S_ISLNK
 #include <sys/mode.h>
 #endif
 #endif
 
-#if HAVE_GLOB_H
+#ifdef HAVE_GLOB_H
 #include <glob.h>
 #endif
 
@@ -267,34 +289,38 @@ 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
 
-#if HAVE_COMPAT_H
+#ifdef HAVE_COMPAT_H
 #include <compat.h>
 #endif
 
+#ifdef HAVE_LIMITS_H
+# include <limits.h>
+#endif
+
 #include <assert.h>
 
 #include "lib/pool_alloc.h"
@@ -305,7 +331,7 @@ enum msgcode {
 #define uchar unsigned char
 #endif
 
-#if SIGNED_CHAR_OK
+#ifdef SIGNED_CHAR_OK
 #define schar signed char
 #else
 #define schar char
@@ -341,7 +367,7 @@ enum msgcode {
 #define uint32 unsigned int32
 #endif
 
-#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !HAVE_STRUCT_STAT64
+#if SIZEOF_OFF_T == 8 || !SIZEOF_OFF64_T || !defined HAVE_STRUCT_STAT64
 #define OFF_T off_t
 #define STRUCT_STAT struct stat
 #else
@@ -439,6 +465,14 @@ struct idev {
 #define MAXPATHLEN 1024
 #endif
 
+/* We want a roomy line buffer that can hold more than MAXPATHLEN,
+ * and significantly more than an overly short MAXPATHLEN. */
+#if MAXPATHLEN < 4096
+#define BIGPATHBUFLEN (4096+1024)
+#else
+#define BIGPATHBUFLEN (MAXPATHLEN+1024)
+#endif
+
 #ifndef NAME_MAX
 #define NAME_MAX 255
 #endif
@@ -457,7 +491,7 @@ struct idev {
 #define HL_SKIP                1
 
 struct hlink {
-       struct file_struct *next;
+       int next;
        int hlindex;
 };
 
@@ -528,6 +562,7 @@ struct sum_buf {
        OFF_T offset;           /**< offset in file of this chunk */
        int32 len;              /**< length of chunk of file */
        uint32 sum1;            /**< simple checksum */
+       int32 chain;            /**< next hash-table collision */
        short flags;            /**< flag bits */
        char sum2[SUM_LENGTH];  /**< checksum  */
 };
@@ -535,7 +570,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 */
@@ -555,11 +590,11 @@ struct map_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_WILD2_PREFIX  (1<<2) /* pattern starts with "**" */
+#define MATCHFLG_WILD3_SUFFIX  (1<<3) /* pattern ends with "***" */
+#define MATCHFLG_ABS_PATH      (1<<4) /* path-match on absolute path */
+#define MATCHFLG_INCLUDE       (1<<5) /* this is an include, not an exclude */
+#define MATCHFLG_DIRECTORY     (1<<6) /* this matches only directories */
 #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 */
@@ -567,12 +602,20 @@ 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_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 MATCHFLG_CLEAR_LIST    (1<<18)/* this item is the "!" token */
+
+#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;
@@ -600,6 +643,7 @@ struct stats {
        int current_file_index;
 };
 
+struct chmod_mode_struct;
 
 #include "byteorder.h"
 #include "lib/mdfour.h"
@@ -607,46 +651,64 @@ struct stats {
 #include "lib/permstring.h"
 #include "lib/addrinfo.h"
 
+#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)
+#endif
+
+#define UNUSED(x) x __attribute__((__unused__))
+
 #include "proto.h"
 
 /* We have replacement versions of these if they're missing. */
-#if !HAVE_ASPRINTF
+#ifndef HAVE_ASPRINTF
 int asprintf(char **ptr, const char *format, ...);
 #endif
 
-#if !HAVE_VASPRINTF
+#ifndef HAVE_VASPRINTF
 int vasprintf(char **ptr, const char *format, va_list ap);
 #endif
 
-#if !HAVE_VSNPRINTF || !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 !HAVE_SNPRINTF || !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
 
-#if !HAVE_STRCHR
+#ifndef HAVE_STRCHR
 # define strchr                 index
 # define strrchr                rindex
 #endif
 
-#if !HAVE_ERRNO_DECL
+#ifndef HAVE_ERRNO_DECL
 extern int errno;
 #endif
 
-#define SUPPORT_LINKS HAVE_READLINK
-#define SUPPORT_HARD_LINKS HAVE_LINK
+#ifdef HAVE_READLINK
+#define SUPPORT_LINKS 1
+#endif
+#ifdef HAVE_LINK
+#define SUPPORT_HARD_LINKS 1
+#endif
 
-#define SIGNAL_CAST (RETSIGTYPE (*)())
+#ifdef HAVE_SIGACTION
+#define SIGACTION(n,h) sigact.sa_handler=(h), sigaction((n),&sigact,NULL)
+#define signal(n,h) we_need_to_call_SIGACTION_not_signal(n,h)
+#else
+#define SIGACTION(n,h) signal(n,h)
+#endif
 
 #ifndef EWOULDBLOCK
 #define EWOULDBLOCK EAGAIN
@@ -729,7 +791,7 @@ 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
 # define NONBLOCK_FLAG FNDELAY
@@ -743,7 +805,8 @@ extern int errno;
 #define INADDR_NONE 0xffffffff
 #endif
 
-#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode) || S_ISSOCK(mode) || S_ISFIFO(mode))
+#define IS_SPECIAL(mode) (S_ISSOCK(mode) || S_ISFIFO(mode))
+#define IS_DEVICE(mode) (S_ISCHR(mode) || S_ISBLK(mode))
 
 /* Initial mask on permissions given to temporary files.  Mask off setuid
      bits and group access because of potential race-condition security
@@ -753,14 +816,6 @@ extern int errno;
 /* handler for null strings in printf format */
 #define NS(s) ((s)?(s):"<NULL>")
 
-#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)
-
-#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)))
@@ -777,20 +832,16 @@ void rsyserr(enum logcode, int, const char *, ...)
      __attribute__((format (printf, 3, 4)))
      ;
 
-#if 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
 
-#if !HAVE_STRLCPY
+#ifndef HAVE_STRLCPY
 size_t strlcpy(char *d, const char *s, size_t bufsize);
 #endif
 
-#if !HAVE_STRLCAT
+#ifndef HAVE_STRLCAT
 size_t strlcat(char *d, const char *s, size_t bufsize);
 #endif
 
@@ -800,13 +851,13 @@ size_t strlcat(char *d, const char *s, size_t bufsize);
 
 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
 
-#if HAVE_GETEUID
+#ifdef HAVE_GETEUID
 #define MY_UID() geteuid()
 #else
 #define MY_UID() getuid()
 #endif
 
-#if HAVE_GETEGID
+#ifdef HAVE_GETEGID
 #define MY_GID() getegid()
 #else
 #define MY_GID() getgid()
@@ -814,18 +865,14 @@ size_t strlcat(char *d, const char *s, size_t bufsize);
 
 extern int verbose;
 
-#if !HAVE_INET_NTOP
+#ifndef HAVE_INET_NTOP
 const char *inet_ntop(int af, const void *src, char *dst, size_t size);
-#endif /* !HAVE_INET_NTOP */
+#endif
 
-#if !HAVE_INET_PTON
+#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;