- Typical tranfers now save 12-20 bytes per file because several vars
[rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index de9de8e70c1be03ea0594ccce33eb7c80416ae24..85e59450f568ed47047359cb492f96f24bdc8ecb 100644 (file)
--- a/rsync.h
+++ b/rsync.h
 
 /* These flags are used in the live flist data. */
 
-#define FLAG_TOP_DIR (1<<0)
-#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 */
-#define FLAG_MISSING (1<<6)    /* generator */
+#define FLAG_TOP_DIR (1<<0)    /* sender/receiver/generator */
+#define FLAG_SENT (1<<1)       /* sender/generator */
+#define FLAG_XFER_DIR (1<<2)   /* sender/receiver/generator */
+#define FLAG_MOUNT_DIR (1<<3)  /* sender/generator */
+#define FLAG_MISSING_DIR (1<<4)        /* generator (dirs only) */
+#define FLAG_HLINK_INFO (1<<5) /* receiver/generator */
+#define FLAG_HLINK_FIRST (1<<6)        /* receiver/generator */
+#define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
 
 /* update this if you make incompatible changes */
-#define PROTOCOL_VERSION 29
+#define PROTOCOL_VERSION 30
 
 /* 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
 /* 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 ITEM_MATCHED (1<<18)              /* used by itemize() */
 
 #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,
  * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
  * FLOG only goes to the log file, not the client; FCLIENT is the opposite. */
-enum logcode { FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
+enum logcode { FNONE=0, FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
 
 /* Messages types that are sent over the message channel.  The logcode
  * values must all be present here with identical numbers. */
@@ -175,6 +176,8 @@ enum msgcode {
        MSG_DONE=86     /* current phase is done */
 };
 
+#define NDX_DONE -1
+
 #include "errcode.h"
 
 #include "config.h"
@@ -446,7 +449,7 @@ enum msgcode {
  */
 
 struct idev {
-       int64 inode;
+       int64 ino;
        int64 dev;
 };
 
@@ -497,38 +500,21 @@ struct idev {
 #define HL_CHECK_MASTER        0
 #define HL_SKIP                1
 
-struct hlink {
+struct hlist {
        int32 next;
        int32 hlindex;
-       unsigned short link_dest_used;
+       unsigned short dest_used;
 };
 
-#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;         /* The current item's name (AKA filename) */
-       char *dirname;          /* The directory info inside the transfer */
+       const char *basename;   /* The current item's name (AKA filename) */
+       const char *dirname;    /* The directory info inside the transfer */
        union {
-               char *root;     /* Sender-side dir info outside transfer */
+               const char *root;/* Sender-side dir info outside transfer */
                int depth;      /* Receiver-side directory depth info */
        } dir;
-       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 */
 };
@@ -540,13 +526,40 @@ struct file_struct {
 #define FLIST_START    (32 * 1024)
 #define FLIST_LINEAR   (FLIST_START * 512)
 
+union flist_extras {
+       uid_t uid;              /* the user ID number */
+       uid_t gid;              /* the group ID number or GID_NONE */
+       struct idev *idev;      /* The hard-link info during matching */
+       struct hlist *hlist;    /* The hard-link info after matching */
+       int32 num;              /* A general-purpose number */
+};
+
+#define FLIST_EXTRA(f,j) ((union flist_extras *)(f))[-(j)]
+#define IS_HLINKED(f) ((f)->flags & FLAG_HLINK_INFO)
+
+/* When enabled, all entries have these: */
+#define F_UID(f) FLIST_EXTRA(f, preserve_uid).uid
+#define F_GID(f) FLIST_EXTRA(f, preserve_gid).gid
+
+/* These are per-entry optional and mutally exclusive: */
+#define F_IDEV(f) FLIST_EXTRA(f, flist_extra_ndx).idev
+#define F_HLIST(f) FLIST_EXTRA(f, flist_extra_ndx).hlist
+
+/* These are per-entry optional, but always both or neither: */
+#define F_DMAJOR(f) FLIST_EXTRA(f, flist_extra_ndx + (IS_HLINKED(f)? 1 : 0)).num
+#define F_DMINOR(f) FLIST_EXTRA(f, flist_extra_ndx + (IS_HLINKED(f)? 2 : 1)).num
+
+/* This is the first string past the struct (mutually exclusive). */
+#define F_SYMLINK(f) ((char*)(f) + file_struct_len)
+#define F_SUM(f) F_SYMLINK(f)
+
 /*
- * Extent size for allocation pools A minimum size of 128KB
+ * 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
+ * (when they happen). Smaller sizes increase the chance of
  * freed allocations freeing whole extents.
  */
 #define FILE_EXTENT    (256 * 1024)
@@ -559,9 +572,8 @@ struct file_list {
        struct file_struct **files;
        alloc_pool_t file_pool;
        alloc_pool_t hlink_pool;
-       int count;
-       int malloced;
-       int low, high;
+       int count, malloced;
+       int low, high; /* 0-relative index values excluding empties */
 };
 
 #define SUMFLG_SAME_OFFSET     (1<<0)
@@ -615,10 +627,12 @@ struct map_struct {
 #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 MATCHFLG_PERISHABLE    (1<<19)/* perishable if parent dir goes away */
 
 #define MATCHFLGS_FROM_CONTAINER (MATCHFLG_ABS_PATH | MATCHFLG_INCLUDE \
                                | MATCHFLG_DIRECTORY | MATCHFLG_SENDER_SIDE \
-                               | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE)
+                               | MATCHFLG_NEGATE | MATCHFLG_RECEIVER_SIDE \
+                               | MATCHFLG_PERISHABLE)
 
 struct filter_struct {
        struct filter_struct *next;
@@ -645,7 +659,7 @@ struct stats {
        int64 matched_data;
        int64 flist_buildtime;
        int64 flist_xfertime;
-       int flist_size;
+       int64 flist_size;
        int num_files;
        int num_transferred_files;
        int current_file_index;
@@ -659,14 +673,17 @@ struct chmod_mode_struct;
 #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> */
+#ifndef __GNUC__
 #define __attribute__(x)
+# if __GNUC__ <= 2
+# define NORETURN
+# endif
 #endif
 
 #define UNUSED(x) x __attribute__((__unused__))
+#ifndef NORETURN
+#define NORETURN __attribute__((__noreturn__))
+#endif
 
 #include "proto.h"
 
@@ -686,7 +703,7 @@ int vsnprintf(char *str, size_t count, const char *fmt, va_list args);
 
 #if !defined HAVE_SNPRINTF || !defined HAVE_C99_VSNPRINTF
 #define snprintf rsync_snprintf
-int snprintf(char *str,size_t count,const char *fmt,...);
+int snprintf(char *str, size_t count, const char *fmt,...);
 #endif
 
 
@@ -856,6 +873,9 @@ size_t strlcat(char *d, const char *s, size_t bufsize);
 #ifndef WEXITSTATUS
 #define        WEXITSTATUS(stat)       ((int)(((stat)>>8)&0xFF))
 #endif
+#ifndef WIFEXITED
+#define        WIFEXITED(stat)         ((int)((stat)&0xFF) == 0)
+#endif
 
 #define exit_cleanup(code) _exit_cleanup(code, __FILE__, __LINE__)
 
@@ -884,3 +904,45 @@ int inet_pton(int af, const char *src, void *dst);
 #ifdef MAINTAINER_MODE
 const char *get_panic_action(void);
 #endif
+
+static inline int
+isDigit(const char *ptr)
+{
+       return isdigit(*(unsigned char *)ptr);
+}
+
+static inline int
+isPrint(const char *ptr)
+{
+       return isprint(*(unsigned char *)ptr);
+}
+
+static inline int
+isSpace(const char *ptr)
+{
+       return isspace(*(unsigned char *)ptr);
+}
+
+static inline int
+isLower(const char *ptr)
+{
+       return islower(*(unsigned char *)ptr);
+}
+
+static inline int
+isUpper(const char *ptr)
+{
+       return isupper(*(unsigned char *)ptr);
+}
+
+static inline int
+toLower(const char *ptr)
+{
+       return tolower(*(unsigned char *)ptr);
+}
+
+static inline int
+toUpper(const char *ptr)
+{
+       return toupper(*(unsigned char *)ptr);
+}