Moved inline functions from rsync.h into ifuncs.h.
[rsync/rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index eccbce0..16be3be 100644 (file)
--- a/rsync.h
+++ b/rsync.h
@@ -5,8 +5,9 @@
  * Copyright (C) 2003-2007 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation.
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 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
@@ -14,8 +15,7 @@
  * 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.
+ * with this program; if not, visit the http://fsf.org website.
  */
 
 #define False 0
 #define XMIT_TOP_DIR (1<<0)
 #define XMIT_SAME_MODE (1<<1)
 #define XMIT_SAME_RDEV_pre28 (1<<2)    /* protocols 20 - 27  */
-#define XMIT_EXTENDED_FLAGS (1<<2)     /* protocols 28 - NOW */
+#define XMIT_EXTENDED_FLAGS (1<<2)     /* protocols 28 - now */
 #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)    /* protocols 28 - NOW */
-#define XMIT_HLINKED (1<<9)            /* protocols 28 - NOW */
+#define XMIT_SAME_RDEV_MAJOR (1<<8)    /* protocols 28 - now (devices only) */
+#define XMIT_NON_XFER_DIR (1<<8)       /* protocols 30 - now (dirs only) */
+#define XMIT_HLINKED (1<<9)            /* protocols 28 - now */
 #define XMIT_SAME_DEV_pre30 (1<<10)    /* protocols 28 - 29  */
-#define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - NOW */
+#define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - now */
 #define XMIT_RDEV_MINOR_8_pre30 (1<<11)        /* protocols 28 - 29  */
-#define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - NOW */
-#define XMIT_HLINK_FIRST (1<<12)       /* protocols 30 - NOW */
+#define XMIT_GROUP_NAME_FOLLOWS (1<<11) /* protocols 30 - now */
+#define XMIT_HLINK_FIRST (1<<12)       /* protocols 30 - now (HLINKED files only) */
 
 /* These flags are used in the live flist data. */
 
 #define FLAG_TOP_DIR (1<<0)    /* sender/receiver/generator */
 #define FLAG_FILE_SENT (1<<1)  /* sender/receiver/generator */
-#define FLAG_DIR_CHANGED (1<<1)        /* generator */
+#define FLAG_DIR_CREATED (1<<1)        /* generator */
 #define FLAG_XFER_DIR (1<<2)   /* sender/receiver/generator */
 #define FLAG_MOUNT_DIR (1<<3)  /* sender/generator */
+#define FLAG_DUPLICATE (1<<4)  /* sender */
 #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_HLINK_DONE (1<<8) /* receiver/generator */
 #define FLAG_LENGTH64 (1<<9)   /* sender/receiver/generator */
+#define FLAG_SKIP_GROUP (1<<10)        /* receiver/generator */
 
 /* These flags are passed to functions but not stored. */
 
@@ -86,7 +89,7 @@
 /* This is used when working on a new protocol version in CVS, and should
  * be a new non-zero value for each CVS change that affects the protocol.
  * It must ALWAYS be 0 when the protocol goes final! */
-#define PROTOCOL_SUBVERSION 1
+#define SUBPROTOCOL_VERSION 8
 
 /* 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
@@ -362,6 +365,21 @@ enum msgcode {
 # include <limits.h>
 #endif
 
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
+#include <iconv.h>
+#ifndef ICONV_CONST
+#define ICONV_CONST
+#endif
+#else
+#ifdef ICONV_CONST
+#undef ICONV_CONST
+#endif
+#ifdef iconv_t
+#undef iconv_t
+#endif
+#define iconv_t int
+#endif
+
 #include <assert.h>
 
 #include "lib/pool_alloc.h"
@@ -479,37 +497,26 @@ enum msgcode {
 # define SIZEOF_INT64 SIZEOF_OFF_T
 #endif
 
-/* Starting from protocol version 26, we always use 64-bit
- * ino_t and dev_t internally, even if this platform does not
- * allow files to have 64-bit inums.  That's because the
- * receiver needs to find duplicate (dev,ino) tuples to detect
- * hardlinks, and it might have files coming from a platform
- * that has 64-bit inums.
- *
- * The only exception is if we're on a platform with no 64-bit type at
- * all.
- *
- * Because we use read_longint() to get these off the wire, if you
- * transfer devices or hardlinks with dev or inum > 2**32 to a machine
- * with no 64-bit types then you will get an overflow error.  Probably
- * not many people have that combination of machines, and you can
- * avoid it by not preserving hardlinks or not transferring device
- * nodes.  It's not clear that any other behaviour is better.
- *
- * Note that if you transfer devices from a 64-bit-devt machine (say,
- * Solaris) to a 32-bit-devt machine (say, Linux-2.2/x86) then the
- * device numbers will be truncated.  But it's a kind of silly thing
- * to do anyhow.
- *
- * FIXME: I don't think the code in flist.c has ever worked on a system
- * where dev_t is a struct.
- */
+struct hashtable {
+       void *nodes;
+       int32 size, entries;
+       uint32 node_size;
+};
 
-struct idev_node {
-       int64 key;
+struct ht_int32_node {
        void *data;
+       int32 key;
 };
 
+struct ht_int64_node {
+       void *data;
+       int64 key;
+};
+
+#define HT_NODE(tbl, bkts, i) ((void*)((char*)(bkts) + (i)*(tbl)->node_size))
+#define HT_KEY(node, k64) ((k64)? ((struct ht_int64_node*)(node))->key \
+                        : (int64)((struct ht_int32_node*)(node))->key)
+
 #ifndef MIN
 #define MIN(a,b) ((a)<(b)?(a):(b))
 #endif
@@ -554,8 +561,6 @@ struct idev_node {
 #define ACLS_NEED_MASK 1
 #endif
 
-#define GID_NONE ((gid_t)-1)
-
 union file_extras {
        int32 num;
        uint32 unum;
@@ -571,21 +576,25 @@ struct file_struct {
 };
 
 extern int file_extra_cnt;
-extern int preserve_uid;
-extern int preserve_gid;
-extern int preserve_acls;
-extern int preserve_xattrs;
+extern int inc_recurse;
+extern int uid_ndx;
+extern int gid_ndx;
+extern int acls_ndx;
+extern int xattrs_ndx;
 
 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
 #define EXTRA_LEN (sizeof (union file_extras))
 #define PTR_EXTRA_LEN ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
+#define DEV_EXTRA_CNT 2
+#define DIRNODE_EXTRA_CNT 3
 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
 
 #define REQ_EXTRA(f,ndx) ((union file_extras*)(f) - (ndx))
 #define OPT_EXTRA(f,bump) ((union file_extras*)(f) - file_extra_cnt - 1 - (bump))
 
 #define LEN64_BUMP(f) ((f)->flags & FLAG_LENGTH64 ? 1 : 0)
-#define HLINK_BUMP(f) (F_IS_HLINKED(f) ? 1 : 0)
+#define HLINK_BUMP(f) ((f)->flags & (FLAG_HLINKED|FLAG_HLINK_DONE) ? inc_recurse+1 : 0)
+#define ACL_BUMP(f) (acls_ndx ? 1 : 0)
 
 /* The length applies to all items. */
 #if SIZEOF_INT64 < 8
@@ -599,31 +608,34 @@ extern int preserve_xattrs;
 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
 
 /* The sending side always has this available: */
-#define F_ROOTDIR(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_LEN))
+#define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_LEN))
 
 /* The receiving side always has this available: */
 #define F_DEPTH(f) REQ_EXTRA(f, 1)->num
 
 /* When the associated option is on, all entries will have these present: */
-#define F_OWNER(f) REQ_EXTRA(f, preserve_uid)->unum
-#define F_GROUP(f) REQ_EXTRA(f, preserve_gid)->unum
-#define F_ACL(f) REQ_EXTRA(f, preserve_acls)->num
-#define F_XATTR(f) REQ_EXTRA(f, preserve_xattrs)->num
-
-/* These items are per-entry optional and mutally exclusive: */
-#define F_HL_GNUM(f) OPT_EXTRA(f, LEN64_BUMP(f))->num
-#define F_HL_PREV(f) OPT_EXTRA(f, LEN64_BUMP(f))->num
-#define F_DEF_ACL(f) OPT_EXTRA(f, LEN64_BUMP(f))->unum
-#define F_DIRDEV_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + 2 - 1)->unum)
-#define F_DIRNODE_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + 3 - 1)->num)
+#define F_OWNER(f) REQ_EXTRA(f, uid_ndx)->unum
+#define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
+#define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
+#define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
+#define F_NDX(f) REQ_EXTRA(f, ic_ndx)->num
+
+/* These items are per-entry optional: */
+#define F_HL_GNUM(f) OPT_EXTRA(f, LEN64_BUMP(f))->num /* non-dirs */
+#define F_HL_PREV(f) OPT_EXTRA(f, LEN64_BUMP(f)+inc_recurse)->num /* non-dirs */
+#define F_DIR_NODE_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) \
+                               + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
+#define F_DIR_DEFACL(f) OPT_EXTRA(f, LEN64_BUMP(f))->unum /* receiver dirs */
+#define F_DIR_DEV_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + ACL_BUMP(f) \
+                               + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
 
 /* This optional item might follow an F_HL_*() item.
  * (Note: a device doesn't need to check LEN64_BUMP(f).) */
 #define F_RDEV_P(f) (&OPT_EXTRA(f, HLINK_BUMP(f) + 2 - 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))
+#define F_SUM(f) ((char*)OPT_EXTRA(f, LEN64_BUMP(f) + HLINK_BUMP(f) \
+                                   + SUM_EXTRA_CNT - 1))
 
 /* Some utility defines: */
 #define F_IS_ACTIVE(f) (f)->basename[0]
@@ -632,9 +644,6 @@ extern int preserve_xattrs;
 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
 
-#define F_UID(f) ((uid_t)F_OWNER(f))
-#define F_GID(f) ((gid_t)F_GROUP(f))
-
 #define DEV_MAJOR(a) (a)[0]
 #define DEV_MINOR(a) (a)[1]
 
@@ -658,18 +667,20 @@ extern int preserve_xattrs;
  * (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 NORMAL_EXTENT  (256 * 1024)
+#define SMALL_EXTENT   (128 * 1024)
 
 #define FLIST_TEMP     (1<<1)
 
 struct file_list {
        struct file_list *next, *prev;
-       struct file_struct **files;
+       struct file_struct **files, **sorted;
        alloc_pool_t file_pool;
-       int count, malloced;
-       int low, high; /* 0-relative index values excluding empties */
-       int ndx_start; /* the start offset for inc_recurse mode */
+       void *pool_boundary;
+       int used, malloced;
+       int low, high;  /* 0-relative index values excluding empties */
+       int ndx_start;  /* the start offset for inc_recurse mode */
+       int ndx_end;    /* the end offset for inc_recurse mode */
        int parent_ndx; /* dir_flist index of parent directory */
        int in_progress, to_redo;
 };
@@ -776,6 +787,28 @@ typedef struct {
 #define EXPAND_ITEM_LIST(lp, type, incr) \
        (type*)expand_item_list(lp, sizeof (type), #type, incr)
 
+#define EMPTY_XBUF {NULL, 0, 0, 0}
+
+typedef struct {
+       char *buf;
+       size_t pos;  /* pos = read pos in the buf */
+       size_t len;  /* len = chars following pos */
+       size_t size; /* size = total space in buf */
+} xbuf;
+
+#define INIT_XBUF(xb, str, ln, sz) (xb).buf = (str), (xb).len = (ln), (xb).size = (sz), (xb).pos = 0
+#define INIT_XBUF_STRLEN(xb, str) (xb).buf = (str), (xb).len = strlen((xb).buf), (xb).size = (-1), (xb).pos = 0
+/* This one is used to make an output xbuf based on a char[] buffer: */
+#define INIT_CONST_XBUF(xb, bf) (xb).buf = (bf), (xb).size = sizeof (bf), (xb).len = (xb).pos = 0
+
+#define ICB_EXPAND_OUT (1<<0)
+#define ICB_INCLUDE_BAD (1<<1)
+#define ICB_INCLUDE_INCOMPLETE (1<<2)
+
+#define RL_EOL_NULLS (1<<0)
+#define RL_DUMP_COMMENTS (1<<1)
+#define RL_CONVERT (1<<2)
+
 #include "byteorder.h"
 #include "lib/mdigest.h"
 #include "lib/wildmatch.h"
@@ -811,6 +844,12 @@ typedef struct {
 
 #include "proto.h"
 
+#ifndef SUPPORT_XATTRS
+#define x_stat(fn,fst,xst) do_stat(fn,fst)
+#define x_lstat(fn,fst,xst) do_lstat(fn,fst)
+#define x_fstat(fd,fst,xst) do_fstat(fd,fst)
+#endif
+
 /* We have replacement versions of these if they're missing. */
 #ifndef HAVE_ASPRINTF
 int asprintf(char **ptr, const char *format, ...);
@@ -966,9 +1005,11 @@ extern int errno;
 #define NS(s) ((s)?(s):"<NULL>")
 
 /* 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)))
+#define new(type) ((type*)malloc(sizeof (type)))
+#define new0(type) ((type*)calloc(1, sizeof (type)))
+#define new_array(type, num) ((type*)_new_array((num), sizeof (type), 0))
+#define new_array0(type, num) ((type*)_new_array((num), sizeof (type), 1))
+#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 *, ...)
@@ -1028,45 +1069,3 @@ 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);
-}