Improved the format of the debug output for mknod().
[rsync/rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index a366f8a..9b7fd3f 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 */
+#define FLAG_HLINKED (1<<5)    /* receiver/generator */
+#define FLAG_HLINK_FIRST (1<<6)        /* receiver/generator */
+#define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
+#define FLAG_LENGTH64 (1<<8)   /* sender/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))
@@ -175,6 +177,8 @@ enum msgcode {
        MSG_DONE=86     /* current phase is done */
 };
 
+#define NDX_DONE -1
+
 #include "errcode.h"
 
 #include "config.h"
@@ -446,7 +450,7 @@ enum msgcode {
  */
 
 struct idev {
-       int64 inode;
+       int64 ino;
        int64 dev;
 };
 
@@ -497,42 +501,74 @@ 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 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 */
+               uint32 unum;         /* An unsigned number */
+       } extras[1];
+       time_t modtime;              /* When the item was last modified */
+       const char *dirname;         /* The dir info inside the transfer */
        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 */
-       union {
-               char *root;     /* Sender-side dir info outside transfer */
-               int depth;      /* Receiver-side directory depth info */
+               const char *root;    /* Sender-side dir info outside transfer */
+               int32 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 */
+       uint32 len32;                /* Lowest 32 bits of the file's length */
+       unsigned short mode;         /* The item's type and permissions */
+       unsigned short flags;        /* This item MUST remain last! */
 };
 
+extern int flist_extra_cnt;
+extern int preserve_uid;
+extern int preserve_gid;
+
+#define FILE_STRUCT_LEN (offsetof(struct file_struct, flags) \
+                       + sizeof (unsigned short))
+#define EXTRA_LEN (sizeof (union flist_extras))
+#define SUM_EXTRA_CNT ((MD4_SUM_LENGTH + EXTRA_LEN - 1) / EXTRA_LEN)
+
+#define REQ_EXTRA(f,ndx) ((f)->extras - (ndx - 1))
+#define OPT_EXTRA(f,bump) ((f)->extras - flist_extra_cnt - (bump))
+#define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
+#define HLINK_BUMP(f) (F_IS_HLINKED(f) ? 1 : 0)
+
+/* Basename (AKA filename) and length applies to all items */
+#define F_BASENAME(f) ((const char*)(f) + FILE_STRUCT_LEN)
+#define F_LENGTH(f) ((OFF_T)(f)->len32 + ((f)->flags & FLAG_LENGTH64 \
+                  ? (OFF_T)OPT_EXTRA(f, 0)->unum << 32 : 0u))
+
+/* If there is a symlink string, it is always right after the basename */
+#define F_SYMLINK(f) (F_BASENAME(f) + strlen(F_BASENAME(f)) + 1)
+
+/* When the associated option is on, all entries will have these present: */
+#define F_UID(f) REQ_EXTRA(f, preserve_uid)->uid
+#define F_GID(f) REQ_EXTRA(f, preserve_gid)->gid
+
+/* These are per-entry optional and mutally exclusive: */
+#define F_IDEV(f)  OPT_EXTRA(f, LEN64_BUMP(f))->idev
+#define F_HLIST(f) OPT_EXTRA(f, LEN64_BUMP(f))->hlist
+
+/* These are per-entry optional, but always both or neither:
+ * (Note: a device doesn't need to use LEN64_BUMP(f).) */
+#define F_DMAJOR(f) OPT_EXTRA(f, HLINK_BUMP(f))->unum
+#define F_DMINOR(f) OPT_EXTRA(f, HLINK_BUMP(f) + 1)->unum
+
+/* The sum is only present on regular files. */
+#define F_SUM(f) ((const char*)OPT_EXTRA(f, LEN64_BUMP(f) + HLINK_BUMP(f) \
+                                         + SUM_EXTRA_CNT - 1))
+
+/* A couple bool-type utility functions: */
+#define F_IS_HLINKED(f) ((f)->flags & FLAG_HLINKED)
+#define F_IS_ACTIVE(f) F_BASENAME(f)[0]
+
 /*
  * Start the flist array at FLIST_START entries and grow it
  * by doubling until FLIST_LINEAR then grow by FLIST_LINEAR
@@ -541,12 +577,12 @@ struct file_struct {
 #define FLIST_LINEAR   (FLIST_START * 512)
 
 /*
- * 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 +595,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 +650,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 +682,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,15 +696,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"
 
@@ -687,7 +726,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
 
 
@@ -888,3 +927,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);
+}